Debian Codegraph @

gnu-efi/inc/efiapi.h

raw
1 #ifndef _EFI_API_H
2 #define _EFI_API_H
3
4 /*++
5
6 Copyright (c) 1998 Intel Corporation
7
8 Module Name:
9
10 efiapi.h
11
12 Abstract:
13
14 Global EFI runtime & boot service interfaces
15
16
17
18
19 Revision History
20
21 --*/
22
23 //
24 // EFI Specification Revision
25 //
26
27 #define EFI_SPECIFICATION_MAJOR_REVISION 1
28 #define EFI_SPECIFICATION_MINOR_REVISION 02
29
30 //
31 // Declare forward referenced data structures
32 //
33
34 INTERFACE_DECL(_EFI_SYSTEM_TABLE);
35
36 //
37 // EFI Memory
38 //
39
40 typedef
41 EFI_STATUS
42 (EFIAPI *EFI_ALLOCATE_PAGES) (
43 IN EFI_ALLOCATE_TYPE Type,
44 IN EFI_MEMORY_TYPE MemoryType,
45 IN UINTN NoPages,
46 OUT EFI_PHYSICAL_ADDRESS *Memory
47 );
48
49 typedef
50 EFI_STATUS
51 (EFIAPI *EFI_FREE_PAGES) (
52 IN EFI_PHYSICAL_ADDRESS Memory,
53 IN UINTN NoPages
54 );
55
56 typedef
57 EFI_STATUS
58 (EFIAPI *EFI_GET_MEMORY_MAP) (
59 IN OUT UINTN *MemoryMapSize,
60 IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
61 OUT UINTN *MapKey,
62 OUT UINTN *DescriptorSize,
63 OUT UINT32 *DescriptorVersion
64 );
65
66 #define NextMemoryDescriptor(Ptr,Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) Ptr) + Size))
67
68
69 typedef
70 EFI_STATUS
71 (EFIAPI *EFI_ALLOCATE_POOL) (
72 IN EFI_MEMORY_TYPE PoolType,
73 IN UINTN Size,
74 OUT VOID **Buffer
75 );
76
77 typedef
78 EFI_STATUS
79 (EFIAPI *EFI_FREE_POOL) (
80 IN VOID *Buffer
81 );
82
83 typedef
84 EFI_STATUS
85 (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP) (
86 IN UINTN MemoryMapSize,
87 IN UINTN DescriptorSize,
88 IN UINT32 DescriptorVersion,
89 IN EFI_MEMORY_DESCRIPTOR *VirtualMap
90 );
91
92
93 #define EFI_OPTIONAL_PTR 0x00000001
94 #define EFI_INTERNAL_FNC 0x00000002 // Pointer to internal runtime fnc
95 #define EFI_INTERNAL_PTR 0x00000004 // Pointer to internal runtime data
96
97
98 typedef
99 EFI_STATUS
100 (EFIAPI *EFI_CONVERT_POINTER) (
101 IN UINTN DebugDisposition,
102 IN OUT VOID **Address
103 );
104
105
106 //
107 // EFI Events
108 //
109
110 #define EVT_TIMER 0x80000000
111 #define EVT_RUNTIME 0x40000000
112 #define EVT_RUNTIME_CONTEXT 0x20000000
113
114 #define EVT_NOTIFY_WAIT 0x00000100
115 #define EVT_NOTIFY_SIGNAL 0x00000200
116
117 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
118 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
119
120 #define EVT_EFI_SIGNAL_MASK 0x000000FF
121 #define EVT_EFI_SIGNAL_MAX 4
122
123 #define EFI_EVENT_TIMER EVT_TIMER
124 #define EFI_EVENT_RUNTIME EVT_RUNTIME
125 #define EFI_EVENT_RUNTIME_CONTEXT EVT_RUNTIME_CONTEXT
126 #define EFI_EVENT_NOTIFY_WAIT EVT_NOTIFY_WAIT
127 #define EFI_EVENT_NOTIFY_SIGNAL EVT_NOTIFY_SIGNAL
128 #define EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES EVT_SIGNAL_EXIT_BOOT_SERVICES
129 #define EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
130 #define EFI_EVENT_EFI_SIGNAL_MASK EVT_EFI_SIGNAL_MASK
131 #define EFI_EVENT_EFI_SIGNAL_MAX EVT_EFI_SIGNAL_MAX
132
133
134 typedef
135 VOID
136 (EFIAPI *EFI_EVENT_NOTIFY) (
137 IN EFI_EVENT Event,
138 IN VOID *Context
139 );
140
141 typedef
142 EFI_STATUS
143 (EFIAPI *EFI_CREATE_EVENT) (
144 IN UINT32 Type,
145 IN EFI_TPL NotifyTpl,
146 IN EFI_EVENT_NOTIFY NotifyFunction,
147 IN VOID *NotifyContext,
148 OUT EFI_EVENT *Event
149 );
150
151 typedef enum {
152 TimerCancel,
153 TimerPeriodic,
154 TimerRelative,
155 TimerTypeMax
156 } EFI_TIMER_DELAY;
157
158 typedef
159 EFI_STATUS
160 (EFIAPI *EFI_SET_TIMER) (
161 IN EFI_EVENT Event,
162 IN EFI_TIMER_DELAY Type,
163 IN UINT64 TriggerTime
164 );
165
166 typedef
167 EFI_STATUS
168 (EFIAPI *EFI_SIGNAL_EVENT) (
169 IN EFI_EVENT Event
170 );
171
172 typedef
173 EFI_STATUS
174 (EFIAPI *EFI_WAIT_FOR_EVENT) (
175 IN UINTN NumberOfEvents,
176 IN EFI_EVENT *Event,
177 OUT UINTN *Index
178 );
179
180 typedef
181 EFI_STATUS
182 (EFIAPI *EFI_CLOSE_EVENT) (
183 IN EFI_EVENT Event
184 );
185
186 typedef
187 EFI_STATUS
188 (EFIAPI *EFI_CHECK_EVENT) (
189 IN EFI_EVENT Event
190 );
191
192 //
193 // Task priority level
194 //
195
196 #define TPL_APPLICATION 4
197 #define TPL_CALLBACK 8
198 #define TPL_NOTIFY 16
199 #define TPL_HIGH_LEVEL 31
200 #define EFI_TPL_APPLICATION TPL_APPLICATION
201 #define EFI_TPL_CALLBACK TPL_CALLBACK
202 #define EFI_TPL_NOTIFY TPL_NOTIFY
203 #define EFI_TPL_HIGH_LEVEL TPL_HIGH_LEVEL
204 typedef
205 EFI_TPL
206 (EFIAPI *EFI_RAISE_TPL) (
207 IN EFI_TPL NewTpl
208 );
209
210 typedef
211 VOID
212 (EFIAPI *EFI_RESTORE_TPL) (
213 IN EFI_TPL OldTpl
214 );
215
216
217 //
218 // EFI platform varibles
219 //
220
221 #define EFI_GLOBAL_VARIABLE \
222 { 0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C} }
223
224 // Variable attributes
225 #define EFI_VARIABLE_NON_VOLATILE 0x00000001
226 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
227 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
228 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
229 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
230 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020
231 #define EFI_VARIABLE_APPEND_WRITE 0x00000040
232 #define EFI_VARIABLE_ENHANCED_AUTHENTICATED_ACCESS 0x00000080
233
234 // Variable size limitation
235 #define EFI_MAXIMUM_VARIABLE_SIZE 1024
236
237 typedef
238 EFI_STATUS
239 (EFIAPI *EFI_GET_VARIABLE) (
240 IN CHAR16 *VariableName,
241 IN EFI_GUID *VendorGuid,
242 OUT UINT32 *Attributes OPTIONAL,
243 IN OUT UINTN *DataSize,
244 OUT VOID *Data
245 );
246
247 typedef
248 EFI_STATUS
249 (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME) (
250 IN OUT UINTN *VariableNameSize,
251 IN OUT CHAR16 *VariableName,
252 IN OUT EFI_GUID *VendorGuid
253 );
254
255
256 typedef
257 EFI_STATUS
258 (EFIAPI *EFI_SET_VARIABLE) (
259 IN CHAR16 *VariableName,
260 IN EFI_GUID *VendorGuid,
261 IN UINT32 Attributes,
262 IN UINTN DataSize,
263 IN VOID *Data
264 );
265
266
267 //
268 // EFI Time
269 //
270
271 typedef struct {
272 UINT32 Resolution; // 1e-6 parts per million
273 UINT32 Accuracy; // hertz
274 BOOLEAN SetsToZero; // Set clears sub-second time
275 } EFI_TIME_CAPABILITIES;
276
277
278 typedef
279 EFI_STATUS
280 (EFIAPI *EFI_GET_TIME) (
281 OUT EFI_TIME *Time,
282 OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL
283 );
284
285 typedef
286 EFI_STATUS
287 (EFIAPI *EFI_SET_TIME) (
288 IN EFI_TIME *Time
289 );
290
291 typedef
292 EFI_STATUS
293 (EFIAPI *EFI_GET_WAKEUP_TIME) (
294 OUT BOOLEAN *Enabled,
295 OUT BOOLEAN *Pending,
296 OUT EFI_TIME *Time
297 );
298
299 typedef
300 EFI_STATUS
301 (EFIAPI *EFI_SET_WAKEUP_TIME) (
302 IN BOOLEAN Enable,
303 IN EFI_TIME *Time OPTIONAL
304 );
305
306
307 //
308 // Image functions
309 //
310
311
312 // PE32+ Subsystem type for EFI images
313
314 #if !defined(IMAGE_SUBSYSTEM_EFI_APPLICATION)
315 #define IMAGE_SUBSYSTEM_EFI_APPLICATION 10
316 #define IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
317 #define IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
318 #endif
319
320 // PE32+ Machine type for EFI images
321
322 #if !defined(EFI_IMAGE_MACHINE_IA32)
323 #define EFI_IMAGE_MACHINE_IA32 0x014c
324 #endif
325
326 #if !defined(EFI_IMAGE_MACHINE_IA64)
327 #define EFI_IMAGE_MACHINE_IA64 0x0200
328 #endif
329
330 #if !defined(EFI_IMAGE_MACHINE_EBC)
331 #define EFI_IMAGE_MACHINE_EBC 0x0EBC
332 #endif
333
334 #if !defined(EFI_IMAGE_MACHINE_X64)
335 #define EFI_IMAGE_MACHINE_X64 0x8664
336 #endif
337
338 #if !defined(EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
339 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
340 #endif
341
342 #if !defined(EFI_IMAGE_MACHINE_AARCH64)
343 #define EFI_IMAGE_MACHINE_AARCH64 0xAA64
344 #endif
345
346 // Image Entry prototype
347
348 typedef
349 EFI_STATUS
350 (EFIAPI *EFI_IMAGE_ENTRY_POINT) (
351 IN EFI_HANDLE ImageHandle,
352 IN struct _EFI_SYSTEM_TABLE *SystemTable
353 );
354
355 typedef
356 EFI_STATUS
357 (EFIAPI *EFI_IMAGE_LOAD) (
358 IN BOOLEAN BootPolicy,
359 IN EFI_HANDLE ParentImageHandle,
360 IN EFI_DEVICE_PATH *FilePath,
361 IN VOID *SourceBuffer OPTIONAL,
362 IN UINTN SourceSize,
363 OUT EFI_HANDLE *ImageHandle
364 );
365
366 typedef
367 EFI_STATUS
368 (EFIAPI *EFI_IMAGE_START) (
369 IN EFI_HANDLE ImageHandle,
370 OUT UINTN *ExitDataSize,
371 OUT CHAR16 **ExitData OPTIONAL
372 );
373
374 typedef
375 EFI_STATUS
376 (EFIAPI *EFI_EXIT) (
377 IN EFI_HANDLE ImageHandle,
378 IN EFI_STATUS ExitStatus,
379 IN UINTN ExitDataSize,
380 IN CHAR16 *ExitData OPTIONAL
381 );
382
383
384 // Image handle
385 /*#define LOADED_IMAGE_PROTOCOL \
386 { 0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B} }
387
388 #define EFI_IMAGE_INFORMATION_REVISION 0x1000
389 typedef struct {
390 UINT32 Revision;
391 EFI_HANDLE ParentHandle;
392 struct _EFI_SYSTEM_TABLE *SystemTable;
393
394 // Source location of image
395 EFI_HANDLE DeviceHandle;
396 EFI_DEVICE_PATH *FilePath;
397 VOID *Reserved;
398
399 // Images load options
400 UINT32 LoadOptionsSize;
401 VOID *LoadOptions;
402
403 // Location of where image was loaded
404 VOID *ImageBase;
405 UINT64 ImageSize;
406 EFI_MEMORY_TYPE ImageCodeType;
407 EFI_MEMORY_TYPE ImageDataType;
408
409 // If the driver image supports a dynamic unload request
410 EFI_IMAGE_UNLOAD Unload;
411
412 } EFI_LOADED_IMAGE;*/
413
414
415 typedef
416 EFI_STATUS
417 (EFIAPI *EFI_EXIT_BOOT_SERVICES) (
418 IN EFI_HANDLE ImageHandle,
419 IN UINTN MapKey
420 );
421
422 //
423 // Misc
424 //
425
426
427 typedef
428 EFI_STATUS
429 (EFIAPI *EFI_STALL) (
430 IN UINTN Microseconds
431 );
432
433 typedef
434 EFI_STATUS
435 (EFIAPI *EFI_SET_WATCHDOG_TIMER) (
436 IN UINTN Timeout,
437 IN UINT64 WatchdogCode,
438 IN UINTN DataSize,
439 IN CHAR16 *WatchdogData OPTIONAL
440 );
441
442 typedef
443 EFI_STATUS
444 (EFIAPI *EFI_CONNECT_CONTROLLER) (
445 IN EFI_HANDLE ControllerHandle,
446 IN EFI_HANDLE *DriverImageHandle OPTIONAL,
447 IN EFI_DEVICE_PATH *RemainingDevicePath OPTIONAL,
448 IN BOOLEAN Recursive
449 );
450
451 typedef
452 EFI_STATUS
453 (EFIAPI *EFI_DISCONNECT_CONTROLLER) (
454 IN EFI_HANDLE ControllerHandle,
455 IN EFI_HANDLE DriverImageHandle OPTIONAL,
456 IN EFI_HANDLE ChildHandle OPTIONAL
457 );
458
459 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
460 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
461 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
462 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
463 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
464 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
465
466 typedef
467 EFI_STATUS
468 (EFIAPI *EFI_OPEN_PROTOCOL) (
469 IN EFI_HANDLE Handle,
470 IN EFI_GUID *Protocol,
471 OUT VOID **Interface OPTIONAL,
472 IN EFI_HANDLE AgentHandle,
473 IN EFI_HANDLE ControllerHandle,
474 IN UINT32 Attributes
475 );
476
477 typedef
478 EFI_STATUS
479 (EFIAPI *EFI_CLOSE_PROTOCOL) (
480 IN EFI_HANDLE Handle,
481 IN EFI_GUID *Protocol,
482 IN EFI_HANDLE AgentHandle,
483 IN EFI_HANDLE ControllerHandle
484 );
485
486 typedef struct {
487 EFI_HANDLE AgentHandle;
488 EFI_HANDLE ControllerHandle;
489 UINT32 Attributes;
490 UINT32 OpenCount;
491 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;
492
493 typedef
494 EFI_STATUS
495 (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION) (
496 IN EFI_HANDLE Handle,
497 IN EFI_GUID *Protocol,
498 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,
499 OUT UINTN *EntryCount
500 );
501
502 typedef
503 EFI_STATUS
504 (EFIAPI *EFI_PROTOCOLS_PER_HANDLE) (
505 IN EFI_HANDLE Handle,
506 OUT EFI_GUID ***ProtocolBuffer,
507 OUT UINTN *ProtocolBufferCount
508 );
509
510 typedef enum {
511 AllHandles,
512 ByRegisterNotify,
513 ByProtocol
514 } EFI_LOCATE_SEARCH_TYPE;
515
516 typedef
517 EFI_STATUS
518 (EFIAPI *EFI_LOCATE_HANDLE_BUFFER) (
519 IN EFI_LOCATE_SEARCH_TYPE SearchType,
520 IN EFI_GUID *Protocol OPTIONAL,
521 IN VOID *SearchKey OPTIONAL,
522 IN OUT UINTN *NoHandles,
523 OUT EFI_HANDLE **Buffer
524 );
525
526 typedef
527 EFI_STATUS
528 (EFIAPI *EFI_LOCATE_PROTOCOL) (
529 IN EFI_GUID *Protocol,
530 IN VOID *Registration OPTIONAL,
531 OUT VOID **Interface
532 );
533
534 typedef
535 EFI_STATUS
536 (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
537 IN OUT EFI_HANDLE *Handle,
538 ...
539 );
540
541 typedef
542 EFI_STATUS
543 (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
544 IN OUT EFI_HANDLE Handle,
545 ...
546 );
547
548 typedef
549 EFI_STATUS
550 (EFIAPI *EFI_CALCULATE_CRC32) (
551 IN VOID *Data,
552 IN UINTN DataSize,
553 OUT UINT32 *Crc32
554 );
555
556 typedef
557 VOID
558 (EFIAPI *EFI_COPY_MEM) (
559 IN VOID *Destination,
560 IN VOID *Source,
561 IN UINTN Length
562 );
563
564 typedef
565 VOID
566 (EFIAPI *EFI_SET_MEM) (
567 IN VOID *Buffer,
568 IN UINTN Size,
569 IN UINT8 Value
570 );
571
572
573 typedef
574 EFI_STATUS
575 (EFIAPI *EFI_CREATE_EVENT_EX) (
576 IN UINT32 Type,
577 IN EFI_TPL NotifyTpl,
578 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,
579 IN const VOID *NotifyContext OPTIONAL,
580 IN const EFI_GUID *EventGroup OPTIONAL,
581 OUT EFI_EVENT *Event
582 );
583
584 typedef enum {
585 EfiResetCold,
586 EfiResetWarm,
587 EfiResetShutdown
588 } EFI_RESET_TYPE;
589
590 typedef
591 EFI_STATUS
592 (EFIAPI *EFI_RESET_SYSTEM) (
593 IN EFI_RESET_TYPE ResetType,
594 IN EFI_STATUS ResetStatus,
595 IN UINTN DataSize,
596 IN CHAR16 *ResetData OPTIONAL
597 );
598
599 typedef
600 EFI_STATUS
601 (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT) (
602 OUT UINT64 *Count
603 );
604
605 typedef
606 EFI_STATUS
607 (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT) (
608 OUT UINT32 *HighCount
609 );
610
611 typedef struct {
612 UINT64 Length;
613 union {
614 EFI_PHYSICAL_ADDRESS DataBlock;
615 EFI_PHYSICAL_ADDRESS ContinuationPointer;
616 } Union;
617 } EFI_CAPSULE_BLOCK_DESCRIPTOR;
618
619 typedef struct {
620 EFI_GUID CapsuleGuid;
621 UINT32 HeaderSize;
622 UINT32 Flags;
623 UINT32 CapsuleImageSize;
624 } EFI_CAPSULE_HEADER;
625
626 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
627 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
628 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
629
630 typedef
631 EFI_STATUS
632 (EFIAPI *EFI_UPDATE_CAPSULE) (
633 IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
634 IN UINTN CapsuleCount,
635 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
636 );
637
638 typedef
639 EFI_STATUS
640 (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES) (
641 IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
642 IN UINTN CapsuleCount,
643 OUT UINT64 *MaximumCapsuleSize,
644 OUT EFI_RESET_TYPE *ResetType
645 );
646
647 typedef
648 EFI_STATUS
649 (EFIAPI *EFI_QUERY_VARIABLE_INFO) (
650 IN UINT32 Attributes,
651 OUT UINT64 *MaximumVariableStorageSize,
652 OUT UINT64 *RemainingVariableStorageSize,
653 OUT UINT64 *MaximumVariableSize
654 );
655
656 //
657 // Protocol handler functions
658 //
659
660 typedef enum {
661 EFI_NATIVE_INTERFACE,
662 EFI_PCODE_INTERFACE
663 } EFI_INTERFACE_TYPE;
664
665 typedef
666 EFI_STATUS
667 (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE) (
668 IN OUT EFI_HANDLE *Handle,
669 IN EFI_GUID *Protocol,
670 IN EFI_INTERFACE_TYPE InterfaceType,
671 IN VOID *Interface
672 );
673
674 typedef
675 EFI_STATUS
676 (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE) (
677 IN EFI_HANDLE Handle,
678 IN EFI_GUID *Protocol,
679 IN VOID *OldInterface,
680 IN VOID *NewInterface
681 );
682
683 typedef
684 EFI_STATUS
685 (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE) (
686 IN EFI_HANDLE Handle,
687 IN EFI_GUID *Protocol,
688 IN VOID *Interface
689 );
690
691 typedef
692 EFI_STATUS
693 (EFIAPI *EFI_HANDLE_PROTOCOL) (
694 IN EFI_HANDLE Handle,
695 IN EFI_GUID *Protocol,
696 OUT VOID **Interface
697 );
698
699 typedef
700 EFI_STATUS
701 (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY) (
702 IN EFI_GUID *Protocol,
703 IN EFI_EVENT Event,
704 OUT VOID **Registration
705 );
706
707 typedef
708 EFI_STATUS
709 (EFIAPI *EFI_LOCATE_HANDLE) (
710 IN EFI_LOCATE_SEARCH_TYPE SearchType,
711 IN EFI_GUID *Protocol OPTIONAL,
712 IN VOID *SearchKey OPTIONAL,
713 IN OUT UINTN *BufferSize,
714 OUT EFI_HANDLE *Buffer
715 );
716
717 typedef
718 EFI_STATUS
719 (EFIAPI *EFI_LOCATE_DEVICE_PATH) (
720 IN EFI_GUID *Protocol,
721 IN OUT EFI_DEVICE_PATH **DevicePath,
722 OUT EFI_HANDLE *Device
723 );
724
725 typedef
726 EFI_STATUS
727 (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE) (
728 IN EFI_GUID *Guid,
729 IN VOID *Table
730 );
731
732 typedef
733 EFI_STATUS
734 (EFIAPI *EFI_RESERVED_SERVICE) (
735 );
736
737 //
738 // Standard EFI table header
739 //
740
741 typedef struct _EFI_TABLE_HEADER {
742 UINT64 Signature;
743 UINT32 Revision;
744 UINT32 HeaderSize;
745 UINT32 CRC32;
746 UINT32 Reserved;
747 } EFI_TABLE_HEADER;
748
749
750 //
751 // EFI Runtime Serivces Table
752 //
753
754 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552
755 #define EFI_1_10_RUNTIME_SERVICES_REVISION ((1<<16) | (10))
756 #define EFI_2_00_RUNTIME_SERVICES_REVISION ((2<<16) | (0))
757 #define EFI_RUNTIME_SERVICES_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
758
759 typedef struct {
760 EFI_TABLE_HEADER Hdr;
761
762 //
763 // Time services
764 //
765
766 EFI_GET_TIME GetTime;
767 EFI_SET_TIME SetTime;
768 EFI_GET_WAKEUP_TIME GetWakeupTime;
769 EFI_SET_WAKEUP_TIME SetWakeupTime;
770
771 //
772 // Virtual memory services
773 //
774
775 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;
776 EFI_CONVERT_POINTER ConvertPointer;
777
778 //
779 // Variable serviers
780 //
781
782 EFI_GET_VARIABLE GetVariable;
783 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;
784 EFI_SET_VARIABLE SetVariable;
785
786 //
787 // Misc
788 //
789
790 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;
791 EFI_RESET_SYSTEM ResetSystem;
792
793 EFI_UPDATE_CAPSULE UpdateCapsule;
794 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;
795 EFI_QUERY_VARIABLE_INFO QueryVariableInfo;
796 } EFI_RUNTIME_SERVICES;
797
798
799 //
800 // EFI Boot Services Table
801 //
802
803 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
804 #define EFI_1_10_BOOT_SERVICES_REVISION ((1<<16) | (10))
805 #define EFI_2_00_BOOT_SERVICES_REVISION ((2<<16) | (0))
806 #define EFI_BOOT_SERVICES_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
807
808 typedef struct _EFI_BOOT_SERVICES {
809
810 EFI_TABLE_HEADER Hdr;
811
812 //
813 // Task priority functions
814 //
815
816 EFI_RAISE_TPL RaiseTPL;
817 EFI_RESTORE_TPL RestoreTPL;
818
819 //
820 // Memory functions
821 //
822
823 EFI_ALLOCATE_PAGES AllocatePages;
824 EFI_FREE_PAGES FreePages;
825 EFI_GET_MEMORY_MAP GetMemoryMap;
826 EFI_ALLOCATE_POOL AllocatePool;
827 EFI_FREE_POOL FreePool;
828
829 //
830 // Event & timer functions
831 //
832
833 EFI_CREATE_EVENT CreateEvent;
834 EFI_SET_TIMER SetTimer;
835 EFI_WAIT_FOR_EVENT WaitForEvent;
836 EFI_SIGNAL_EVENT SignalEvent;
837 EFI_CLOSE_EVENT CloseEvent;
838 EFI_CHECK_EVENT CheckEvent;
839
840 //
841 // Protocol handler functions
842 //
843
844 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;
845 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;
846 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;
847 EFI_HANDLE_PROTOCOL HandleProtocol;
848 EFI_HANDLE_PROTOCOL PCHandleProtocol;
849 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;
850 EFI_LOCATE_HANDLE LocateHandle;
851 EFI_LOCATE_DEVICE_PATH LocateDevicePath;
852 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;
853
854 //
855 // Image functions
856 //
857
858 EFI_IMAGE_LOAD LoadImage;
859 EFI_IMAGE_START StartImage;
860 EFI_EXIT Exit;
861 EFI_IMAGE_UNLOAD UnloadImage;
862 EFI_EXIT_BOOT_SERVICES ExitBootServices;
863
864 //
865 // Misc functions
866 //
867
868 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;
869 EFI_STALL Stall;
870 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;
871
872 //
873 // DriverSupport Services
874 //
875
876 EFI_CONNECT_CONTROLLER ConnectController;
877 EFI_DISCONNECT_CONTROLLER DisconnectController;
878
879 //
880 // Open and Close Protocol Services
881 //
882 EFI_OPEN_PROTOCOL OpenProtocol;
883 EFI_CLOSE_PROTOCOL CloseProtocol;
884 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;
885
886 //
887 // Library Services
888 //
889 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;
890 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;
891 EFI_LOCATE_PROTOCOL LocateProtocol;
892 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;
893 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;
894
895 //
896 // 32-bit CRC Services
897 //
898 EFI_CALCULATE_CRC32 CalculateCrc32;
899
900 //
901 // Misc Services
902 //
903 EFI_COPY_MEM CopyMem;
904 EFI_SET_MEM SetMem;
905 EFI_CREATE_EVENT_EX CreateEventEx;
906 } EFI_BOOT_SERVICES;
907
908
909 //
910 // EFI Configuration Table and GUID definitions
911 //
912
913 #define MPS_TABLE_GUID \
914 { 0xeb9d2d2f, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
915
916 #define ACPI_TABLE_GUID \
917 { 0xeb9d2d30, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
918
919 #define ACPI_20_TABLE_GUID \
920 { 0x8868e871, 0xe4f1, 0x11d3, {0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81} }
921
922 #define SMBIOS_TABLE_GUID \
923 { 0xeb9d2d31, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
924
925 #define SMBIOS3_TABLE_GUID \
926 { 0xf2fd1544, 0x9794, 0x4a2c, {0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94} }
927
928 #define SAL_SYSTEM_TABLE_GUID \
929 { 0xeb9d2d32, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
930
931
932 typedef struct _EFI_CONFIGURATION_TABLE {
933 EFI_GUID VendorGuid;
934 VOID *VendorTable;
935 } EFI_CONFIGURATION_TABLE;
936
937
938 //
939 // EFI System Table
940 //
941
942
943
944
945 #define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249
946 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1<<16) | (02))
947 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1<<16) | (10))
948 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2<<16) | (0))
949 #define EFI_SYSTEM_TABLE_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
950
951 typedef struct _EFI_SYSTEM_TABLE {
952 EFI_TABLE_HEADER Hdr;
953
954 CHAR16 *FirmwareVendor;
955 UINT32 FirmwareRevision;
956
957 EFI_HANDLE ConsoleInHandle;
958 SIMPLE_INPUT_INTERFACE *ConIn;
959
960 EFI_HANDLE ConsoleOutHandle;
961 SIMPLE_TEXT_OUTPUT_INTERFACE *ConOut;
962
963 EFI_HANDLE StandardErrorHandle;
964 SIMPLE_TEXT_OUTPUT_INTERFACE *StdErr;
965
966 EFI_RUNTIME_SERVICES *RuntimeServices;
967 EFI_BOOT_SERVICES *BootServices;
968
969 UINTN NumberOfTableEntries;
970 EFI_CONFIGURATION_TABLE *ConfigurationTable;
971
972 } EFI_SYSTEM_TABLE;
973
974
975 //
976 // Not technically EFI, but oh well.
977 //
978
979 #define EFI_DXE_SERVICES_TABLE_SIGNATURE 0x565245535f455844ULL
980
981 typedef enum {
982 EFI_GCD_MEMORY_TYPE_NON_EXISTENT,
983 EFI_GCD_MEMORY_TYPE_RESERVED,
984 EFI_GCD_MEMORY_TYPE_SYSTEM_MEMORY,
985 EFI_GCD_MEMORY_TYPE_MEMORY_MAPPED_IO,
986 EFI_GCD_MEMORY_TYPE_PERSISTENT,
987 EFI_GCD_MEMORY_TYPE_MORE_RELIABLE,
988 EFI_GCD_MEMORY_TYPE_MAXIMUM
989 } EFI_GCD_MEMORY_TYPE_T;
990
991 #define DXE_SERVICES_TABLE_GUID \
992 { \
993 0x5ad34ba, 0x6f02, 0x4214, {0x95, 0x2e, 0x4d, 0xa0, 0x39, 0x8e, 0x2b, 0xb9 } \
994 }
995
996 struct _EFI_GCD_MEMORY_SPACE_DESCRIPTOR {
997 EFI_PHYSICAL_ADDRESS BaseAddress;
998 UINT64 Length;
999 UINT64 Capabilities;
1000 UINT64 Attributes;
1001 EFI_GCD_MEMORY_TYPE_T GcdMemoryType;
1002 EFI_HANDLE ImageHandle;
1003 EFI_HANDLE DeviceHandle;
1004 } __attribute__((__packed__));
1005
1006 typedef struct _EFI_GCD_MEMORY_SPACE_DESCRIPTOR EFI_GCD_MEMORY_SPACE_DESCRIPTOR;
1007
1008 typedef
1009 EFI_STATUS
1010 (EFIAPI *GET_MEMORY_SPACE_DESCRIPTOR) (
1011 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1012 OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Desc
1013 );
1014
1015 typedef
1016 EFI_STATUS
1017 (EFIAPI *SET_MEMORY_SPACE_ATTRIBUTES) (
1018 IN EFI_PHYSICAL_ADDRESS BaseAddress,
1019 IN UINT64 Length,
1020 IN UINT64 Attributes
1021 );
1022
1023 typedef struct _EFI_DXE_SERVICES_TABLE {
1024 EFI_TABLE_HEADER Hdr;
1025 VOID *AddMemorySpace;
1026 VOID *AllocateMemorySpace;
1027 VOID *FreeMemorySpace;
1028 VOID *RemoveMemorySpace;
1029 GET_MEMORY_SPACE_DESCRIPTOR GetMemorySpaceDescriptor;
1030 SET_MEMORY_SPACE_ATTRIBUTES SetMemorySpaceAttributes;
1031 VOID *GetMemorySpaceMap;
1032 VOID *AddIoSpace;
1033 VOID *AllocateIoSpace;
1034 VOID *FreeIoSpace;
1035 VOID *RemoveIoSpace;
1036 VOID *GetIoSpaceDescriptor;
1037 VOID *GetIoSpaceMap;
1038 VOID *Dispatch;
1039 VOID *Schedule;
1040 VOID *Trust;
1041 VOID *ProcessFirmwareVolume;
1042 VOID *SetMemorySpaceCapabilities;
1043 } EFI_DXE_SERVICES_TABLE;
1044
1045 #endif