2 Include file that supports UEFI.
4 This include file must only contain things defined in the UEFI 2.1 specification.
5 If a code construct is defined in the UEFI 2.1 specification it must be included
8 Copyright (c) 2006 - 2008, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #ifndef __UEFI_SPEC_H__
20 #define __UEFI_SPEC_H__
22 #include <Uefi/UefiMultiPhase.h>
24 #include <Protocol/DevicePath.h>
25 #include <Protocol/SimpleTextIn.h>
26 #include <Protocol/SimpleTextOut.h>
29 /// Enumeration of EFI memory allocation types.
33 /// Allocate any available range of pages that satisfies the request
37 /// Allocate any available range of pages whose uppermost address is less than
38 /// or equal to a specified maximum address
42 /// Allocate pages at a specified address
46 /// Maximum enumeration value that may be used for bounds checking
52 // Bit definitions for EFI_TIME.Daylight
54 #define EFI_TIME_ADJUST_DAYLIGHT 0x01
55 #define EFI_TIME_IN_DAYLIGHT 0x02
58 /// Value definition for EFI_TIME.TimeZone
60 #define EFI_UNSPECIFIED_TIMEZONE 0x07FF
63 // Memory cacheability attributes
65 #define EFI_MEMORY_UC 0x0000000000000001ULL
66 #define EFI_MEMORY_WC 0x0000000000000002ULL
67 #define EFI_MEMORY_WT 0x0000000000000004ULL
68 #define EFI_MEMORY_WB 0x0000000000000008ULL
69 #define EFI_MEMORY_UCE 0x0000000000000010ULL
71 // Physical memory protection attributes
73 #define EFI_MEMORY_WP 0x0000000000001000ULL
74 #define EFI_MEMORY_RP 0x0000000000002000ULL
75 #define EFI_MEMORY_XP 0x0000000000004000ULL
77 // Runtime memory attribute
79 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
82 /// Memory descriptor version number
84 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
87 /// Definition of an EFI memory descriptor
91 /// Type of the memory region. See EFI_MEMORY_TYPE
95 /// Physical address of the first byte of the memory region. Must aligned
96 /// on a 4 KB boundary.
98 EFI_PHYSICAL_ADDRESS PhysicalStart
;
100 /// Virtual address of the first byte of the memory region. Must aligned
101 /// on a 4 KB boundary.
103 EFI_VIRTUAL_ADDRESS VirtualStart
;
105 /// Number of 4KB pages in the memory region.
107 UINT64 NumberOfPages
;
109 /// Attributes of the memory region that describe the bit mask of capabilities
110 /// for that memory region, and not necessarily the current settings for that
114 } EFI_MEMORY_DESCRIPTOR
;
117 Allocates memory pages from the system.
119 @param Type The type of allocation to perform.
120 @param MemoryType The type of memory to allocate.
121 @param Pages The number of contiguous 4 KB pages to allocate.
122 @param Memory Pointer to a physical address. On input, the way in which the address is
123 used depends on the value of Type.
125 @retval EFI_SUCCESS The requested pages were allocated.
126 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
127 AllocateMaxAddress or AllocateAddress.
128 2) MemoryType is in the range
129 EfiMaxMemoryType..0x7FFFFFFF.
130 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
131 @retval EFI_NOT_FOUND The requested pages could not be found.
136 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
137 IN EFI_ALLOCATE_TYPE Type
,
138 IN EFI_MEMORY_TYPE MemoryType
,
140 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
146 @param Memory The base physical address of the pages to be freed.
147 @param Pages The number of contiguous 4 KB pages to free.
149 @retval EFI_SUCCESS The requested pages were freed.
150 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
151 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
157 (EFIAPI
*EFI_FREE_PAGES
)(
158 IN EFI_PHYSICAL_ADDRESS Memory
,
163 Returns the current memory map.
165 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
166 On input, this is the size of the buffer allocated by the caller.
167 On output, it is the size of the buffer returned by the firmware if
168 the buffer was large enough, or the size of the buffer needed to contain
169 the map if the buffer was too small.
170 @param MemoryMap A pointer to the buffer in which firmware places the current memory
172 @param MapKey A pointer to the location in which firmware returns the key for the
174 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
175 an individual EFI_MEMORY_DESCRIPTOR.
176 @param DescriptorVersion A pointer to the location in which firmware returns the version number
177 associated with the EFI_MEMORY_DESCRIPTOR.
179 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
180 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
181 needed to hold the memory map is returned in MemoryMapSize.
182 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
183 2) The MemoryMap buffer is not too small and MemoryMap is
189 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
190 IN OUT UINTN
*MemoryMapSize
,
191 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
193 OUT UINTN
*DescriptorSize
,
194 OUT UINT32
*DescriptorVersion
198 Allocates pool memory.
200 @param PoolType The type of pool to allocate.
201 @param Size The number of bytes to allocate from the pool.
202 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
205 @retval EFI_SUCCESS The requested number of bytes was allocated.
206 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
207 @retval EFI_INVALID_PARAMETER PoolType was invalid.
212 (EFIAPI
*EFI_ALLOCATE_POOL
)(
213 IN EFI_MEMORY_TYPE PoolType
,
219 Returns pool memory to the system.
221 @param Buffer Pointer to the buffer to free.
223 @retval EFI_SUCCESS The memory was returned to the system.
224 @retval EFI_INVALID_PARAMETER Buffer was invalid.
229 (EFIAPI
*EFI_FREE_POOL
)(
234 Changes the runtime addressing mode of EFI firmware from physical to virtual.
236 @param MemoryMapSize The size in bytes of VirtualMap.
237 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
238 @param DescriptorVersion The version of the structure entries in VirtualMap.
239 @param VirtualMap An array of memory descriptors which contain new virtual
240 address mapping information for all runtime ranges.
242 @retval EFI_SUCCESS The virtual address map has been applied.
243 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
244 virtual address mapped mode.
245 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
246 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
247 map that requires a mapping.
248 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
254 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
255 IN UINTN MemoryMapSize
,
256 IN UINTN DescriptorSize
,
257 IN UINT32 DescriptorVersion
,
258 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
262 Connects one or more drivers to a controller.
264 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
265 @param DriverImageHandle A pointer to an ordered list handles that support the
266 EFI_DRIVER_BINDING_PROTOCOL.
267 @param RemainingDevicePath A pointer to the device path that specifies a child of the
268 controller specified by ControllerHandle.
269 @param Recursive If TRUE, then ConnectController() is called recursively
270 until the entire tree of controllers below the controller specified
271 by ControllerHandle have been created. If FALSE, then
272 the tree of controllers is only expanded one level.
274 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
275 2) No drivers were connected to ControllerHandle, but
276 RemainingDevicePath is not NULL, and it is an End Device
278 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
279 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
280 present in the system.
281 2) No drivers were connected to ControllerHandle.
286 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
287 IN EFI_HANDLE ControllerHandle
,
288 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
289 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
294 Disconnects one or more drivers from a controller.
296 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
297 @param DriverImageHandle The driver to disconnect from ControllerHandle.
298 If DriverImageHandle is NULL, then all the drivers currently managing
299 ControllerHandle are disconnected from ControllerHandle.
300 @param ChildHandle The handle of the child to destroy.
301 If ChildHandle is NULL, then all the children of ControllerHandle are
302 destroyed before the drivers are disconnected from ControllerHandle.
304 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
305 2) On entry, no drivers are managing ControllerHandle.
306 3) DriverImageHandle is not NULL, and on entry
307 DriverImageHandle is not managing ControllerHandle.
308 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.
309 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
310 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
311 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
312 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
314 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
319 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
320 IN EFI_HANDLE ControllerHandle
,
321 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
322 IN EFI_HANDLE ChildHandle OPTIONAL
328 // ConvertPointer DebugDisposition type.
330 #define EFI_OPTIONAL_PTR 0x00000001
331 #define EFI_OPTIONAL_POINTER EFI_OPTIONAL_PTR
334 Determines the new virtual address that is to be used on subsequent memory accesses.
336 @param DebugDisposition Supplies type information for the pointer being converted.
337 @param Address A pointer to a pointer that is to be fixed to be the value needed
338 for the new virtual address mappings being applied.
340 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
341 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
342 2) *Address is NULL and DebugDisposition does
343 not have the EFI_OPTIONAL_PTR bit set.
344 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
345 of the current memory map. This is normally fatal.
350 (EFIAPI
*EFI_CONVERT_POINTER
)(
351 IN UINTN DebugDisposition
,
352 IN OUT VOID
**Address
357 // These types can be ORed together as needed - for example,
358 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
359 // EVT_NOTIFY_SIGNAL.
361 #define EVT_TIMER 0x80000000
362 #define EVT_RUNTIME 0x40000000
363 #define EVT_NOTIFY_WAIT 0x00000100
364 #define EVT_NOTIFY_SIGNAL 0x00000200
366 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
367 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
370 // The event's NotifyContext pointer points to a runtime memory
372 // The event is deprecated in UEFI2.0 and later specifications.
374 #define EVT_RUNTIME_CONTEXT 0x20000000
378 Invoke a notification event
380 @param Event Event whose notification function is being invoked.
381 @param Context Pointer to the notification function's context,
382 which is implementation-dependent.
387 (EFIAPI
*EFI_EVENT_NOTIFY
)(
395 @param Type The type of event to create and its mode and attributes.
396 @param NotifyTpl The task priority level of event notifications, if needed.
397 @param NotifyFunction Pointer to the event's notification function, if any.
398 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
399 Context in the notification function.
400 @param Event Pointer to the newly created event if the call succeeds; undefined
403 @retval EFI_SUCCESS The event structure was created.
404 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
405 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
410 (EFIAPI
*EFI_CREATE_EVENT
)(
412 IN EFI_TPL NotifyTpl
,
413 IN EFI_EVENT_NOTIFY NotifyFunction
,
414 IN VOID
*NotifyContext
,
419 Creates an event in a group.
421 @param Type The type of event to create and its mode and attributes.
422 @param NotifyTpl The task priority level of event notifications,if needed.
423 @param NotifyFunction Pointer to the event's notification function, if any.
424 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
425 Context in the notification function.
426 @param EventGroup Pointer to the unique identifier of the group to which this event belongs.
427 If this is NULL, then the function behaves as if the parameters were passed
429 @param Event Pointer to the newly created event if the call succeeds; undefined
432 @retval EFI_SUCCESS The event structure was created.
433 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
434 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
439 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
441 IN EFI_TPL NotifyTpl
,
442 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
443 IN CONST VOID
*NotifyContext OPTIONAL
,
444 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
449 /// Timer delay types
453 /// An event's timer settings is to be cancelled and not trigger time is to be set
457 /// An event is to be signalled periodically at a specified interval from the current time.
461 /// An event is to be signalled once at a specified interval from the current time.
467 Sets the type of timer and the trigger time for a timer event.
469 @param Event The timer event that is to be signaled at the specified time.
470 @param Type The type of time that is specified in TriggerTime.
471 @param TriggerTime The number of 100ns units until the timer expires.
472 A TriggerTime of 0 is legal.
473 If Type is TimerRelative and TriggerTime is 0, then the timer
474 event will be signaled on the next timer tick.
475 If Type is TimerPeriodic and TriggerTime is 0, then the timer
476 event will be signaled on every timer tick.
478 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
479 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
484 (EFIAPI
*EFI_SET_TIMER
)(
486 IN EFI_TIMER_DELAY Type
,
487 IN UINT64 TriggerTime
493 @param Event The event to signal.
495 @retval EFI_SUCCESS The event has been signaled.
500 (EFIAPI
*EFI_SIGNAL_EVENT
)(
505 Stops execution until an event is signaled.
507 @param NumberOfEvents The number of events in the Event array.
508 @param Event An array of EFI_EVENT.
509 @param Index Pointer to the index of the event which satisfied the wait condition.
511 @retval EFI_SUCCESS The event indicated by Index was signaled.
512 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
513 2) The event indicated by Index is of type
515 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
520 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
521 IN UINTN NumberOfEvents
,
529 @param Event The event to close.
531 @retval EFI_SUCCESS The event has been closed.
536 (EFIAPI
*EFI_CLOSE_EVENT
)(
541 Checks whether an event is in the signaled state.
543 @param Event The event to check.
545 @retval EFI_SUCCESS The event is in the signaled state.
546 @retval EFI_NOT_READY The event is not in the signaled state.
547 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
552 (EFIAPI
*EFI_CHECK_EVENT
)(
558 // Task priority level
560 #define TPL_APPLICATION 4
561 #define TPL_CALLBACK 8
562 #define TPL_NOTIFY 16
563 #define TPL_HIGH_LEVEL 31
567 Raises a task's priority level and returns its previous level.
569 @param NewTpl The new task priority level.
571 @return Previous task priority level
576 (EFIAPI
*EFI_RAISE_TPL
)(
581 Restores a task's priority level to its previous value.
583 @param OldTpl The previous task priority level to restore.
588 (EFIAPI
*EFI_RESTORE_TPL
)(
593 Returns the value of a variable.
595 @param VariableName A Null-terminated Unicode string that is the name of the
597 @param VendorGuid A unique identifier for the vendor.
598 @param Attributes If not NULL, a pointer to the memory location to return the
599 attributes bitmask for the variable.
600 @param DataSize On input, the size in bytes of the return Data buffer.
601 On output the size of data returned in Data.
602 @param Data The buffer to return the contents of the variable.
604 @retval EFI_SUCCESS The function completed successfully.
605 @retval EFI_NOT_FOUND The variable was not found.
606 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
607 @retval EFI_INVALID_PARAMETER VariableName is NULL.
608 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
609 @retval EFI_INVALID_PARAMETER DataSize is NULL.
610 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
611 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
612 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
617 (EFIAPI
*EFI_GET_VARIABLE
)(
618 IN CHAR16
*VariableName
,
619 IN EFI_GUID
*VendorGuid
,
620 OUT UINT32
*Attributes
, OPTIONAL
621 IN OUT UINTN
*DataSize
,
626 Enumerates the current variable names.
628 @param VariableNameSize The size of the VariableName buffer.
629 @param VariableName On input, supplies the last VariableName that was returned
630 by GetNextVariableName(). On output, returns the Nullterminated
631 Unicode string of the current variable.
632 @param VendorGuid On input, supplies the last VendorGuid that was returned by
633 GetNextVariableName(). On output, returns the
634 VendorGuid of the current variable.
636 @retval EFI_SUCCESS The function completed successfully.
637 @retval EFI_NOT_FOUND The next variable was not found.
638 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
639 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
640 @retval EFI_INVALID_PARAMETER VariableName is NULL.
641 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
642 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
647 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
648 IN OUT UINTN
*VariableNameSize
,
649 IN OUT CHAR16
*VariableName
,
650 IN OUT EFI_GUID
*VendorGuid
654 Sets the value of a variable.
656 @param VariableName A Null-terminated Unicode string that is the name of the
658 @param VendorGuid A unique identifier for the vendor.
659 @param Attributes Attributes bitmask to set for the variable.
660 @param DataSize The size in bytes of the Data buffer.
661 @param Data The contents for the variable.
663 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
664 defined by the Attributes.
665 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
666 DataSize exceeds the maximum allowed.
667 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
668 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
669 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
670 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
671 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
672 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
673 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
678 (EFIAPI
*EFI_SET_VARIABLE
)(
679 IN CHAR16
*VariableName
,
680 IN EFI_GUID
*VendorGuid
,
681 IN UINT32 Attributes
,
688 /// This provides the capabilities of the
689 /// real time clock device as exposed through the EFI interfaces.
695 } EFI_TIME_CAPABILITIES
;
698 Returns the current time and date information, and the time-keeping capabilities
699 of the hardware platform.
701 @param Time A pointer to storage to receive a snapshot of the current time.
702 @param Capabilities An optional pointer to a buffer to receive the real time clock
703 device's capabilities.
705 @retval EFI_SUCCESS The operation completed successfully.
706 @retval EFI_INVALID_PARAMETER Time is NULL.
707 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
712 (EFIAPI
*EFI_GET_TIME
)(
714 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
718 Sets the current local time and date information.
720 @param Time A pointer to the current time.
722 @retval EFI_SUCCESS The operation completed successfully.
723 @retval EFI_INVALID_PARAMETER A time field is out of range.
724 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
729 (EFIAPI
*EFI_SET_TIME
)(
734 Returns the current wakeup alarm clock setting.
736 @param Enabled Indicates if the alarm is currently enabled or disabled.
737 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
738 @param Time The current alarm setting.
740 @retval EFI_SUCCESS The alarm settings were returned.
741 @retval EFI_INVALID_PARAMETER Enabled is NULL.
742 @retval EFI_INVALID_PARAMETER Pending is NULL.
743 @retval EFI_INVALID_PARAMETER Time is NULL.
744 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
745 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
750 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
751 OUT BOOLEAN
*Enabled
,
752 OUT BOOLEAN
*Pending
,
757 Sets the system wakeup alarm clock time.
759 @param Enabled Enable or disable the wakeup alarm.
760 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
761 If Enable is FALSE, then this parameter is optional, and may be NULL.
763 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
764 Enable is FALSE, then the wakeup alarm was disabled.
765 @retval EFI_INVALID_PARAMETER A time field is out of range.
766 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
767 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
772 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
774 IN EFI_TIME
*Time OPTIONAL
778 Loads an EFI image into memory.
780 @param BootPolicy If TRUE, indicates that the request originates from the boot
781 manager, and that the boot manager is attempting to load
782 FilePath as a boot selection. Ignored if SourceBuffer is
784 @param ParentImageHandle The caller's image handle.
785 @param DevicePath The DeviceHandle specific file path from which the image is
787 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
788 of the image to be loaded.
789 @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
790 @param ImageHandle Pointer to the returned image handle that is created when the
791 image is successfully loaded.
793 @retval EFI_SUCCESS Image was loaded into memory correctly.
794 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
795 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
796 @retval EFI_UNSUPPORTED The image type is not supported.
797 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
798 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
800 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
805 (EFIAPI
*EFI_IMAGE_LOAD
)(
806 IN BOOLEAN BootPolicy
,
807 IN EFI_HANDLE ParentImageHandle
,
808 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
809 IN VOID
*SourceBuffer OPTIONAL
,
811 OUT EFI_HANDLE
*ImageHandle
815 Transfers control to a loaded image's entry point.
817 @param ImageHandle Handle of image to be started.
818 @param ExitDataSize Pointer to the size, in bytes, of ExitData.
819 @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
820 Unicode string, optionally followed by additional binary data.
822 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
823 has already been initialized with StartImage
824 @return Exit code from image
829 (EFIAPI
*EFI_IMAGE_START
)(
830 IN EFI_HANDLE ImageHandle
,
831 OUT UINTN
*ExitDataSize
,
832 OUT CHAR16
**ExitData OPTIONAL
836 Terminates a loaded EFI image and returns control to boot services.
838 @param ImageHandle Handle that identifies the image.
839 @param ExitStatus The image's exit code.
840 @param ExitDataSize The size, in bytes, of ExitData.
841 @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
842 optionally followed by additional binary data.
844 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
845 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
846 started with LoadImage() and StartImage(), but the
847 image is not the currently executing image.
853 IN EFI_HANDLE ImageHandle
,
854 IN EFI_STATUS ExitStatus
,
855 IN UINTN ExitDataSize
,
856 IN CHAR16
*ExitData OPTIONAL
862 @param ImageHandle Handle that identifies the image to be unloaded.
864 @retval EFI_SUCCESS The image has been unloaded.
865 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
870 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
871 IN EFI_HANDLE ImageHandle
875 Terminates all boot services.
877 @param ImageHandle Handle that identifies the exiting image.
878 @param MapKey Key to the latest memory map.
880 @retval EFI_SUCCESS Boot services have been terminated.
881 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
886 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
887 IN EFI_HANDLE ImageHandle
,
892 Induces a fine-grained stall.
894 @param Microseconds The number of microseconds to stall execution.
896 @retval EFI_SUCCESS Execution was stalled at least the requested number of
903 IN UINTN Microseconds
907 Sets the system's watchdog timer.
909 @param Timeout The number of seconds to set the watchdog timer to.
910 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
911 @param DataSize The size, in bytes, of WatchdogData.
912 @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
913 followed by additional binary data.
915 @retval EFI_SUCCESS The timeout has been set.
916 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
917 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
918 @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
924 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
926 IN UINT64 WatchdogCode
,
928 IN CHAR16
*WatchdogData OPTIONAL
932 /// Enumeration of reset types.
936 /// Used to induce a system-wide reset. This sets all circuitry within the
937 /// system to its initial state. This type of reset is asynchronous to system
938 /// operation and operates withgout regard to cycle boundaries. EfiColdReset
939 /// is tantamount to a system power cycle.
943 /// Used to induce a system-wide initialization. The processors are set to their
944 /// initial state, and pending cycles are not corrupted. If the system does
945 /// not support this reset type, then an EfiResetCold must be performed.
949 /// Used to induce en entry into power state equivalent to the ACPI G2/S5 or G3
950 /// state. If the system does not support this reset type, then when the system
951 /// is rebooted, it should exhibit the EfiResetCold attributes.
957 Resets the entire platform.
959 @param ResetType The type of reset to perform.
960 @param ResetStatus The status code for the reset.
961 @param DataSize The size, in bytes, of WatchdogData.
962 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
963 EfiResetShutdown the data buffer starts with a Null-terminated
964 Unicode string, optionally followed by additional binary data.
969 (EFIAPI
*EFI_RESET_SYSTEM
)(
970 IN EFI_RESET_TYPE ResetType
,
971 IN EFI_STATUS ResetStatus
,
973 IN VOID
*ResetData OPTIONAL
977 Returns a monotonically increasing count for the platform.
979 @param Count Pointer to returned value.
981 @retval EFI_SUCCESS The next monotonic count was returned.
982 @retval EFI_INVALID_PARAMETER Count is NULL.
983 @retval EFI_DEVICE_ERROR The device is not functioning properly.
988 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
993 Returns the next high 32 bits of the platform's monotonic counter.
995 @param HighCount Pointer to returned value.
997 @retval EFI_SUCCESS The next high monotonic count was returned.
998 @retval EFI_INVALID_PARAMETER HighCount is NULL.
999 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1004 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1005 OUT UINT32
*HighCount
1009 Computes and returns a 32-bit CRC for a data buffer.
1011 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1012 @param DataSize The number of bytes in the buffer Data.
1013 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1016 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1018 @retval EFI_INVALID_PARAMETER Data is NULL.
1019 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1020 @retval EFI_INVALID_PARAMETER DataSize is 0.
1025 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1032 Copies the contents of one buffer to another buffer.
1034 @param Destination Pointer to the destination buffer of the memory copy.
1035 @param Source Pointer to the source buffer of the memory copy.
1036 @param Length Number of bytes to copy from Source to Destination.
1041 (EFIAPI
*EFI_COPY_MEM
)(
1042 IN VOID
*Destination
,
1048 The SetMem() function fills a buffer with a specified value.
1050 @param Buffer Pointer to the buffer to fill.
1051 @param Size Number of bytes in Buffer to fill.
1052 @param Value Value to fill Buffer with.
1057 (EFIAPI
*EFI_SET_MEM
)(
1064 /// Enumeration of EFI Interface Types
1068 /// Indicates that the supplied protocol interface is supplied in native form.
1070 EFI_NATIVE_INTERFACE
1071 } EFI_INTERFACE_TYPE
;
1074 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1075 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1076 more error checking than InstallProtocolInterface(), so it is recommended that
1077 InstallMultipleProtocolInterfaces() be used in place of
1078 InstallProtocolInterface()
1080 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1081 @param Protocol The numeric ID of the protocol interface.
1082 @param InterfaceType Indicates whether Interface is supplied in native form.
1083 @param Interface A pointer to the protocol interface.
1085 @retval EFI_SUCCESS The protocol interface was installed.
1086 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1087 @retval EFI_INVALID_PARAMETER Handle is NULL.
1088 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1089 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1090 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1095 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1096 IN OUT EFI_HANDLE
*Handle
,
1097 IN EFI_GUID
*Protocol
,
1098 IN EFI_INTERFACE_TYPE InterfaceType
,
1103 Installs one or more protocol interfaces into the boot services environment.
1105 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1106 handle is to be allocated.
1107 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1110 @retval EFI_SUCCESS All the protocol interface was installed.
1111 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1112 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1113 the handle database.
1118 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1119 IN OUT EFI_HANDLE
*Handle
,
1124 Reinstalls a protocol interface on a device handle.
1126 @param Handle Handle on which the interface is to be reinstalled.
1127 @param Protocol The numeric ID of the interface.
1128 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1129 associated with Protocol.
1130 @param NewInterface A pointer to the new interface.
1132 @retval EFI_SUCCESS The protocol interface was reinstalled.
1133 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1134 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1135 because OldInterface is still being used by a
1136 driver that will not release it.
1137 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1138 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1143 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1144 IN EFI_HANDLE Handle
,
1145 IN EFI_GUID
*Protocol
,
1146 IN VOID
*OldInterface
,
1147 IN VOID
*NewInterface
1151 Removes a protocol interface from a device handle. It is recommended that
1152 UninstallMultipleProtocolInterfaces() be used in place of
1153 UninstallProtocolInterface().
1155 @param Handle The handle on which the interface was installed.
1156 @param Protocol The numeric ID of the interface.
1157 @param Interface A pointer to the interface.
1159 @retval EFI_SUCCESS The interface was removed.
1160 @retval EFI_NOT_FOUND The interface was not found.
1161 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1162 is still being used by a driver.
1163 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1164 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1169 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1170 IN EFI_HANDLE Handle
,
1171 IN EFI_GUID
*Protocol
,
1176 Removes one or more protocol interfaces into the boot services environment.
1178 @param Handle The handle to remove the protocol interfaces from.
1179 @param ... A variable argument list containing pairs of protocol GUIDs and
1180 protocol interfaces.
1182 @retval EFI_SUCCESS All the protocol interfaces were removed.
1183 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1188 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1189 IN EFI_HANDLE Handle
,
1194 Queries a handle to determine if it supports a specified protocol.
1196 @param Handle The handle being queried.
1197 @param Protocol The published unique identifier of the protocol.
1198 @param Interface Supplies the address where a pointer to the corresponding Protocol
1199 Interface is returned.
1201 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1202 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1203 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1204 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1205 @retval EFI_INVALID_PARAMETER Interface is NULL.
1210 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1211 IN EFI_HANDLE Handle
,
1212 IN EFI_GUID
*Protocol
,
1213 OUT VOID
**Interface
1216 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1217 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1218 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1219 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1220 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1221 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1224 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1225 handle, it opens the protocol on behalf of the calling agent.
1227 @param Handle The handle for the protocol interface that is being opened.
1228 @param Protocol The published unique identifier of the protocol.
1229 @param Interface Supplies the address where a pointer to the corresponding Protocol
1230 Interface is returned.
1231 @param AgentHandle The handle of the agent that is opening the protocol interface
1232 specified by Protocol and Interface.
1233 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1234 UEFI Driver Model, then this parameter is the controller handle
1235 that requires the protocol interface. If the agent does not follow
1236 the UEFI Driver Model, then this parameter is optional and may
1238 @param Attributes The open mode of the protocol interface specified by Handle
1241 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1242 protocol interface was returned in Interface.
1243 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1244 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1245 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1246 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1247 handle is the same as AgentHandle.
1252 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1253 IN EFI_HANDLE Handle
,
1254 IN EFI_GUID
*Protocol
,
1255 OUT VOID
**Interface
, OPTIONAL
1256 IN EFI_HANDLE AgentHandle
,
1257 IN EFI_HANDLE ControllerHandle
,
1258 IN UINT32 Attributes
1263 Closes a protocol on a handle that was opened using OpenProtocol().
1265 @param Handle The handle for the protocol interface that was previously opened
1266 with OpenProtocol(), and is now being closed.
1267 @param Protocol The published unique identifier of the protocol.
1268 @param AgentHandle The handle of the agent that is closing the protocol interface.
1269 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1270 UEFI Driver Model, then this parameter is the controller handle
1271 that required the protocol interface.
1273 @retval EFI_SUCCESS The protocol instance was closed.
1274 @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.
1275 2) AgentHandle is not a valid EFI_HANDLE.
1276 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1277 4) Protocol is NULL.
1278 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1279 2) The protocol interface specified by Handle and Protocol is not
1280 currently open by AgentHandle and ControllerHandle.
1285 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1286 IN EFI_HANDLE Handle
,
1287 IN EFI_GUID
*Protocol
,
1288 IN EFI_HANDLE AgentHandle
,
1289 IN EFI_HANDLE ControllerHandle
1293 /// EFI Oprn Protocol Information Entry
1296 EFI_HANDLE AgentHandle
;
1297 EFI_HANDLE ControllerHandle
;
1300 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1303 Retrieves the list of agents that currently have a protocol interface opened.
1305 @param Handle The handle for the protocol interface that is being queried.
1306 @param Protocol The published unique identifier of the protocol.
1307 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1308 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1309 @param EntryCount A pointer to the number of entries in EntryBuffer.
1311 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1312 number of entries was returned EntryCount.
1313 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1314 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1319 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1320 IN EFI_HANDLE Handle
,
1321 IN EFI_GUID
*Protocol
,
1322 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1323 OUT UINTN
*EntryCount
1327 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1330 @param Handle The handle from which to retrieve the list of protocol interface
1332 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1333 installed on Handle.
1334 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1337 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1338 ProtocolBuffer. The number of protocol interface GUIDs was
1339 returned in ProtocolBufferCount.
1340 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1341 @retval EFI_INVALID_PARAMETER Handle is NULL.
1342 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1343 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1344 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1349 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1350 IN EFI_HANDLE Handle
,
1351 OUT EFI_GUID
***ProtocolBuffer
,
1352 OUT UINTN
*ProtocolBufferCount
1356 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1358 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1359 @param Event Event that is to be signaled whenever a protocol interface is registered
1361 @param Registration A pointer to a memory location to receive the registration value.
1363 @retval EFI_SUCCESS The notification event has been registered.
1364 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1365 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1366 @retval EFI_INVALID_PARAMETER Event is NULL.
1367 @retval EFI_INVALID_PARAMETER Registration is NULL.
1372 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1373 IN EFI_GUID
*Protocol
,
1375 OUT VOID
**Registration
1379 /// Enumeration of EFI Locate Search Types
1383 /// Retrieve all the handles in the handle database.
1387 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1391 /// Retrieve the set of handles from the handle database that support a
1392 /// specified protocol.
1395 } EFI_LOCATE_SEARCH_TYPE
;
1398 Returns an array of handles that support a specified protocol.
1400 @param SearchType Specifies which handle(s) are to be returned.
1401 @param Protocol Specifies the protocol to search by.
1402 @param SearchKey Specifies the search key.
1403 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1404 the array returned in Buffer (if the buffer was large enough) or the
1405 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1407 @param Buffer The buffer in which the array is returned.
1409 @retval EFI_SUCCESS The array of handles was returned.
1410 @retval EFI_NOT_FOUND No handles match the search.
1411 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1412 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1413 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1414 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1415 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1416 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1421 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1422 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1423 IN EFI_GUID
*Protocol
, OPTIONAL
1424 IN VOID
*SearchKey
, OPTIONAL
1425 IN OUT UINTN
*BufferSize
,
1426 OUT EFI_HANDLE
*Buffer
1430 Locates the handle to a device on the device path that supports the specified protocol.
1432 @param Protocol Specifies the protocol to search for.
1433 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1434 path pointer is modified to point to the remaining part of the device
1436 @param Device A pointer to the returned device handle.
1438 @retval EFI_SUCCESS The resulting handle was returned.
1439 @retval EFI_NOT_FOUND No handles match the search.
1440 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1441 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1442 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1447 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1448 IN EFI_GUID
*Protocol
,
1449 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1450 OUT EFI_HANDLE
*Device
1454 Adds, updates, or removes a configuration table entry from the EFI System Table.
1456 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1457 @param Table A pointer to the configuration table for the entry to add, update, or
1458 remove. May be NULL.
1460 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1461 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1462 @retval EFI_INVALID_PARAMETER Guid is not valid.
1463 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1468 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1474 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1476 @param SearchType Specifies which handle(s) are to be returned.
1477 @param Protocol Provides the protocol to search by.
1478 This parameter is only valid for a SearchType of ByProtocol.
1479 @param SearchKey Supplies the search key depending on the SearchType.
1480 @param NoHandles The number of handles returned in Buffer.
1481 @param Buffer A pointer to the buffer to return the requested array of handles that
1484 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1485 handles in Buffer was returned in NoHandles.
1486 @retval EFI_NOT_FOUND No handles match the search.
1487 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1488 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1489 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1494 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1495 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1496 IN EFI_GUID
*Protocol
, OPTIONAL
1497 IN VOID
*SearchKey
, OPTIONAL
1498 IN OUT UINTN
*NoHandles
,
1499 OUT EFI_HANDLE
**Buffer
1503 Returns the first protocol instance that matches the given protocol.
1505 @param Protocol Provides the protocol to search for.
1506 @param Registration Optional registration key returned from
1507 RegisterProtocolNotify().
1508 @param Interface On return, a pointer to the first interface that matches Protocol and
1511 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1513 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1515 @retval EFI_INVALID_PARAMETER Interface is NULL.
1520 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1521 IN EFI_GUID
*Protocol
,
1522 IN VOID
*Registration
, OPTIONAL
1523 OUT VOID
**Interface
1527 /// EFI Capsule Block Descriptor
1532 EFI_PHYSICAL_ADDRESS DataBlock
;
1533 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1535 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1538 /// EFI Capsule Header
1541 EFI_GUID CapsuleGuid
;
1544 UINT32 CapsuleImageSize
;
1545 } EFI_CAPSULE_HEADER
;
1548 // The EFI System Table entry must point to an array of capsules
1549 // that contain the same CapsuleGuid value. The array must be
1550 // prefixed by a UINT32 that represents the size of the array of capsules.
1553 UINT32 CapsuleArrayNumber
;
1554 VOID
* CapsulePtr
[1];
1555 } EFI_CAPSULE_TABLE
;
1557 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1558 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1561 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1562 consumption, the firmware may process the capsule immediately. If the payload should persist
1563 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1564 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1565 part of the reset process.
1567 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1568 being passed into update capsule.
1569 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1571 @param ScatterGatherList Physical pointer to a set of
1572 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1573 location in physical memory of a set of capsules.
1575 @retval EFI_SUCCESS Valid capsule was passed. If
1576 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1577 capsule has been successfully processed by the firmware.
1578 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1579 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL.
1580 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1581 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
1586 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1587 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1588 IN UINTN CapsuleCount
,
1589 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1593 Returns if the capsule can be supported via UpdateCapsule().
1595 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1596 being passed into update capsule.
1597 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1599 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1600 support as an argument to UpdateCapsule() via
1601 CapsuleHeaderArray and ScatterGatherList.
1602 @param ResetType Returns the type of reset required for the capsule update.
1604 @retval EFI_SUCCESS Valid answer returned.
1605 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1606 MaximumCapsuleSize and ResetType are undefined.
1607 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1608 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
1613 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1614 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1615 IN UINTN CapsuleCount
,
1616 OUT UINT64
*MaximumCapsuleSize
,
1617 OUT EFI_RESET_TYPE
*ResetType
1621 Returns information about the EFI variables.
1623 @param Attributes Attributes bitmask to specify the type of variables on
1624 which to return information.
1625 @param MaximumVariableStorageSize On output the maximum size of the storage space
1626 available for the EFI variables associated with the
1627 attributes specified.
1628 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1629 available for the EFI variables associated with the
1630 attributes specified.
1631 @param MaximumVariableSize Returns the maximum size of the individual EFI
1632 variables associated with the attributes specified.
1634 @retval EFI_SUCCESS Valid answer returned.
1635 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1636 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1637 MaximumVariableStorageSize,
1638 RemainingVariableStorageSize, MaximumVariableSize
1644 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1645 IN UINT32 Attributes
,
1646 OUT UINT64
*MaximumVariableStorageSize
,
1647 OUT UINT64
*RemainingVariableStorageSize
,
1648 OUT UINT64
*MaximumVariableSize
1653 // EFI Runtime Services Table
1655 #define EFI_SYSTEM_TABLE_SIGNATURE EFI_SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1656 #define EFI_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1657 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1658 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1659 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1660 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1662 #define EFI_RUNTIME_SERVICES_SIGNATURE EFI_SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1663 #define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION
1666 /// EFI Runtime Services Table
1670 /// The table header for the EFI Runtime Services Table.
1672 EFI_TABLE_HEADER Hdr
;
1677 EFI_GET_TIME GetTime
;
1678 EFI_SET_TIME SetTime
;
1679 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1680 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1683 // Virtual Memory Services
1685 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1686 EFI_CONVERT_POINTER ConvertPointer
;
1689 // Variable Services
1691 EFI_GET_VARIABLE GetVariable
;
1692 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1693 EFI_SET_VARIABLE SetVariable
;
1696 // Miscellaneous Services
1698 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1699 EFI_RESET_SYSTEM ResetSystem
;
1702 // UEFI 2.0 Capsule Services
1704 EFI_UPDATE_CAPSULE UpdateCapsule
;
1705 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1708 // Miscellaneous UEFI 2.0 Service
1710 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1711 } EFI_RUNTIME_SERVICES
;
1714 #define EFI_BOOT_SERVICES_SIGNATURE EFI_SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1715 #define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION
1718 /// EFI Boot Services Table
1722 /// The table header for the EFI Boot Services Table.
1724 EFI_TABLE_HEADER Hdr
;
1727 // Task Priority Services
1729 EFI_RAISE_TPL RaiseTPL
;
1730 EFI_RESTORE_TPL RestoreTPL
;
1735 EFI_ALLOCATE_PAGES AllocatePages
;
1736 EFI_FREE_PAGES FreePages
;
1737 EFI_GET_MEMORY_MAP GetMemoryMap
;
1738 EFI_ALLOCATE_POOL AllocatePool
;
1739 EFI_FREE_POOL FreePool
;
1742 // Event & Timer Services
1744 EFI_CREATE_EVENT CreateEvent
;
1745 EFI_SET_TIMER SetTimer
;
1746 EFI_WAIT_FOR_EVENT WaitForEvent
;
1747 EFI_SIGNAL_EVENT SignalEvent
;
1748 EFI_CLOSE_EVENT CloseEvent
;
1749 EFI_CHECK_EVENT CheckEvent
;
1752 // Protocol Handler Services
1754 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1755 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1756 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1757 EFI_HANDLE_PROTOCOL HandleProtocol
;
1759 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1760 EFI_LOCATE_HANDLE LocateHandle
;
1761 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1762 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1767 EFI_IMAGE_LOAD LoadImage
;
1768 EFI_IMAGE_START StartImage
;
1770 EFI_IMAGE_UNLOAD UnloadImage
;
1771 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1774 // Miscellaneous Services
1776 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1778 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1781 // DriverSupport Services
1783 EFI_CONNECT_CONTROLLER ConnectController
;
1784 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1787 // Open and Close Protocol Services
1789 EFI_OPEN_PROTOCOL OpenProtocol
;
1790 EFI_CLOSE_PROTOCOL CloseProtocol
;
1791 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1796 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1797 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1798 EFI_LOCATE_PROTOCOL LocateProtocol
;
1799 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1800 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1803 // 32-bit CRC Services
1805 EFI_CALCULATE_CRC32 CalculateCrc32
;
1808 // Miscellaneous Services
1810 EFI_COPY_MEM CopyMem
;
1812 EFI_CREATE_EVENT_EX CreateEventEx
;
1813 } EFI_BOOT_SERVICES
;
1816 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1817 /// EFI System Table.
1821 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1823 EFI_GUID VendorGuid
;
1825 /// A pointer to the table associated with VendorGuid.
1828 } EFI_CONFIGURATION_TABLE
;
1831 /// EFI System Table
1835 /// The table header for the EFI System Table.
1837 EFI_TABLE_HEADER Hdr
;
1839 /// A pointer to a null terminated Unicode string that identifies
1840 /// the vendor that produces the system firmware for the platform.
1842 CHAR16
*FirmwareVendor
;
1844 /// A firmware vendor specific value that identifies the revision
1845 /// of the system firmware for the platform.
1847 UINT32 FirmwareRevision
;
1849 /// The handle for the active console input device.
1851 EFI_HANDLE ConsoleInHandle
;
1853 /// A pointer to the SIMPLE_INPUT_PROTOCOL interface that is
1854 /// associated with ConsoleInHandle.
1856 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1858 /// The handle for the active console output device.
1860 EFI_HANDLE ConsoleOutHandle
;
1862 /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1863 /// that is associated with ConsoleOutHandle.
1865 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1867 /// The handle for the active standard error console device.
1869 EFI_HANDLE StandardErrorHandle
;
1871 /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1872 /// that is associated with StandardErrorHandle.
1874 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
1876 /// A pointer to the EFI Runtime Services Table.
1878 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1880 /// A pointer to the EFI Boot Services Table.
1882 EFI_BOOT_SERVICES
*BootServices
;
1884 /// The number of system configuration tables in the buffer ConfigurationTable.
1886 UINTN NumberOfTableEntries
;
1888 /// A pointer to the system configuration tables.
1889 /// The number of entries in the table is NumberOfTableEntries.
1891 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
1895 This is the declaration of an EFI image entry point. This entry point is
1896 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
1897 both device drivers and bus drivers.
1899 @param ImageHandle The firmware allocated handle for the UEFI image.
1900 @param SystemTable A pointer to the EFI System Table.
1902 @retval EFI_SUCCESS The operation completed successfully.
1903 @retval Others Some unexpected error happened.
1907 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
1908 IN EFI_HANDLE ImageHandle
,
1909 IN EFI_SYSTEM_TABLE
*SystemTable
1913 // EFI Load Options Attributes
1915 #define LOAD_OPTION_ACTIVE 0x00000001
1916 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1917 #define LOAD_OPTION_HIDDEN 0x00000008
1918 #define LOAD_OPTION_CATEGORY 0x00001F00
1920 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1921 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1923 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
1924 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
1925 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
1928 /// EFI Boot Key Data
1932 UINT32 Revision
: 8;
1933 UINT32 ShiftPressed
: 1;
1934 UINT32 ControlPressed
: 1;
1935 UINT32 AltPressed
: 1;
1936 UINT32 LogoPressed
: 1;
1937 UINT32 MenuPressed
: 1;
1938 UINT32 SysReqPessed
: 1;
1939 UINT32 Reserved
: 16;
1940 UINT32 InputKeyCount
: 2;
1943 } EFI_BOOT_KEY_DATA
;
1949 EFI_BOOT_KEY_DATA KeyOptions
;
1950 UINT32 BootOptionCrc
;
1952 //EFI_INPUT_KEY Keys[];
1955 #define EFI_KEY_OPTION_SHIFT 0x00000001
1956 #define EFI_KEY_OPTION_CONTROL 0x00000002
1957 #define EFI_KEY_OPTION_ALT 0x00000004
1958 #define EFI_KEY_OPTION_LOGO 0x00000008
1959 #define EFI_KEY_OPTION_MENU 0x00000010
1960 #define EFI_KEY_OPTION_SYSREQ 0x00000020
1961 #define EFI_KEY_CODE_COUNT 0x00000300
1964 // EFI File location to boot from on removable media devices
1966 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
1967 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
1968 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
1970 #if defined (MDE_CPU_IA32)
1971 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
1972 #elif defined (MDE_CPU_IPF)
1973 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
1974 #elif defined (MDE_CPU_X64)
1975 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
1976 #elif defined (MDE_CPU_EBC)
1978 #error Unknown Processor Type
1981 #include <Uefi/UefiPxe.h>
1982 #include <Uefi/UefiGpt.h>
1983 #include <Uefi/UefiInternalFormRepresentation.h>