2 Include file that supportes UEFI.
4 This include file must only contain things defined in the UEFI 2.0 specification.
5 If a code construct is defined in the UEFI 2.0 specification it must be included
8 Copyright (c) 2006 - 2007, 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.
17 Module Name: UefiSpec.h
21 #ifndef __UEFI_SPEC_H__
22 #define __UEFI_SPEC_H__
24 #include <Uefi/UefiMultiPhase.h>
26 #include <Protocol/DevicePath.h>
27 #include <Protocol/SimpleTextIn.h>
28 #include <Protocol/SimpleTextOut.h>
31 // Networking Definitions
53 // Enumeration of memory allocation.
64 // possible caching types for the memory range
66 #define EFI_MEMORY_UC 0x0000000000000001ULL
67 #define EFI_MEMORY_WC 0x0000000000000002ULL
68 #define EFI_MEMORY_WT 0x0000000000000004ULL
69 #define EFI_MEMORY_WB 0x0000000000000008ULL
70 #define EFI_MEMORY_UCE 0x0000000000000010ULL
73 // physical memory protection on range
75 #define EFI_MEMORY_WP 0x0000000000001000ULL
76 #define EFI_MEMORY_RP 0x0000000000002000ULL
77 #define EFI_MEMORY_XP 0x0000000000004000ULL
80 // range requires a runtime mapping
82 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
84 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
87 EFI_PHYSICAL_ADDRESS PhysicalStart
;
88 EFI_VIRTUAL_ADDRESS VirtualStart
;
91 } EFI_MEMORY_DESCRIPTOR
;
94 // Build macros to find next EFI_MEMORY_DESCRIPTOR.
96 #define NextMemoryDescriptor(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))
97 #define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) NextMemoryDescriptor (_Ptr, _Size)
100 // Declare forward referenced data structures
102 typedef struct _EFI_SYSTEM_TABLE EFI_SYSTEM_TABLE
;
105 Allocates memory pages from the system.
107 @param Type The type of allocation to perform.
108 @param MemoryType The type of memory to allocate.
109 @param Pages The number of contiguous 4 KB pages to allocate.
110 @param Memory Pointer to a physical address. On input, the way in which the address is
111 used depends on the value of Type.
113 @retval EFI_SUCCESS The requested pages were allocated.
114 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
115 AllocateMaxAddress or AllocateAddress.
116 2) MemoryType is in the range
117 EfiMaxMemoryType..0x7FFFFFFF.
118 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
119 @retval EFI_NOT_FOUND The requested pages could not be found.
124 (EFIAPI
*EFI_ALLOCATE_PAGES
) (
125 IN EFI_ALLOCATE_TYPE Type
,
126 IN EFI_MEMORY_TYPE MemoryType
,
128 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
134 @param Memory The base physical address of the pages to be freed.
135 @param Pages The number of contiguous 4 KB pages to free.
137 @retval EFI_SUCCESS The requested pages were freed.
138 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
139 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
145 (EFIAPI
*EFI_FREE_PAGES
) (
146 IN EFI_PHYSICAL_ADDRESS Memory
,
151 Returns the current memory map.
153 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
154 @param MemoryMap A pointer to the buffer in which firmware places the current memory
156 @param MapKey A pointer to the location in which firmware returns the key for the
158 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
159 an individual EFI_MEMORY_DESCRIPTOR.
160 @param DescriptorVersion A pointer to the location in which firmware returns the version number
161 associated with the EFI_MEMORY_DESCRIPTOR.
163 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
164 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
165 needed to hold the memory map is returned in MemoryMapSize.
166 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
167 2) The MemoryMap buffer is not too small and MemoryMap is
173 (EFIAPI
*EFI_GET_MEMORY_MAP
) (
174 IN OUT UINTN
*MemoryMapSize
,
175 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
177 OUT UINTN
*DescriptorSize
,
178 OUT UINT32
*DescriptorVersion
182 Allocates pool memory.
184 @param PoolType The type of pool to allocate.
185 @param Size The number of bytes to allocate from the pool.
186 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
189 @retval EFI_SUCCESS The requested number of bytes was allocated.
190 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
191 @retval EFI_INVALID_PARAMETER PoolType was invalid.
196 (EFIAPI
*EFI_ALLOCATE_POOL
) (
197 IN EFI_MEMORY_TYPE PoolType
,
203 Returns pool memory to the system.
205 @param Buffer Pointer to the buffer to free.
207 @retval EFI_SUCCESS The memory was returned to the system.
208 @retval EFI_INVALID_PARAMETER Buffer was invalid.
213 (EFIAPI
*EFI_FREE_POOL
) (
218 Changes the runtime addressing mode of EFI firmware from physical to virtual.
220 @param MemoryMapSize The size in bytes of VirtualMap.
221 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
222 @param DescriptorVersion The version of the structure entries in VirtualMap.
223 @param VirtualMap An array of memory descriptors which contain new virtual
224 address mapping information for all runtime ranges.
226 @retval EFI_SUCCESS The virtual address map has been applied.
227 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
228 virtual address mapped mode.
229 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
230 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
231 map that requires a mapping.
232 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
238 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
) (
239 IN UINTN MemoryMapSize
,
240 IN UINTN DescriptorSize
,
241 IN UINT32 DescriptorVersion
,
242 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
246 Connects one or more drivers to a controller.
248 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
249 @param DriverImageHandle A pointer to an ordered list handles that support the
250 EFI_DRIVER_BINDING_PROTOCOL.
251 @param RemainingDevicePath A pointer to the device path that specifies a child of the
252 controller specified by ControllerHandle.
253 @param Recursive If TRUE, then ConnectController() is called recursively
254 until the entire tree of controllers below the controller specified
255 by ControllerHandle have been created. If FALSE, then
256 the tree of controllers is only expanded one level.
258 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
259 2) No drivers were connected to ControllerHandle, but
260 RemainingDevicePath is not NULL, and it is an End Device
262 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
263 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
264 present in the system.
265 2) No drivers were connected to ControllerHandle.
270 (EFIAPI
*EFI_CONNECT_CONTROLLER
) (
271 IN EFI_HANDLE ControllerHandle
,
272 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
273 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
278 Disconnects one or more drivers from a controller.
280 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
281 @param DriverImageHandle The driver to disconnect from ControllerHandle.
282 @param ChildHandle The handle of the child to destroy.
284 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
285 2) On entry, no drivers are managing ControllerHandle.
286 3) DriverImageHandle is not NULL, and on entry
287 DriverImageHandle is not managing ControllerHandle.
289 @retval EFI_INVALID_PARAMETER One ore more parameters are invalid.
290 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
292 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
297 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
) (
298 IN EFI_HANDLE ControllerHandle
,
299 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
300 IN EFI_HANDLE ChildHandle OPTIONAL
306 // ConvertPointer DebugDisposition type.
308 #define EFI_OPTIONAL_PTR 0x00000001
309 #define EFI_OPTIONAL_POINTER EFI_OPTIONAL_PTR
312 Determines the new virtual address that is to be used on subsequent memory accesses.
314 @param DebugDisposition Supplies type information for the pointer being converted.
315 @param Address A pointer to a pointer that is to be fixed to be the value needed
316 for the new virtual address mappings being applied.
318 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
319 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
320 2) *Address is NULL and DebugDisposition does
321 not have the EFI_OPTIONAL_PTR bit set.
322 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
323 of the current memory map. This is normally fatal.
328 (EFIAPI
*EFI_CONVERT_POINTER
) (
329 IN UINTN DebugDisposition
,
330 IN OUT VOID
**Address
335 // These types can be ¡°ORed¡± together as needed ¨C for example,
336 // EVT_TIMER might be ¡°Ored¡± with EVT_NOTIFY_WAIT or
337 // EVT_NOTIFY_SIGNAL.
339 #define EVT_TIMER 0x80000000
340 #define EVT_RUNTIME 0x40000000
342 #define EVT_NOTIFY_WAIT 0x00000100
343 #define EVT_NOTIFY_SIGNAL 0x00000200
344 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
345 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
349 // The event¡¯s NotifyContext pointer points to a runtime memory
351 // The event is deprecated in UEFI2.0 and later specifications.
353 #define EVT_RUNTIME_CONTEXT 0x20000000
357 Invoke a notification event
359 @param Event Event whose notification function is being invoked.
360 @param Context Pointer to the notification function's context,
361 which is implementation-dependent.
366 (EFIAPI
*EFI_EVENT_NOTIFY
) (
374 @param Type The type of event to create and its mode and attributes.
375 @param NotifyTpl Pointer to the notification function's context.
376 @param NotifyFunction Pointer to the event's notification function, if any.
377 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
378 Context in the notification function.
379 @param Event Pointer to the newly created event if the call succeeds; undefined
382 @retval EFI_SUCCESS The event structure was created.
383 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
384 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
389 (EFIAPI
*EFI_CREATE_EVENT
) (
391 IN EFI_TPL NotifyTpl
,
392 IN EFI_EVENT_NOTIFY NotifyFunction
,
393 IN VOID
*NotifyContext
,
398 Creates an event in a group.
400 @param Type The type of event to create and its mode and attributes.
401 @param NotifyTpl Pointer to the notification function's context.
402 @param NotifyFunction Pointer to the event's notification function, if any.
403 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
404 Context in the notification function.
405 @param EventGroup Pointer to the unique identifier of the group to which this event belongs.
406 @param Event Pointer to the newly created event if the call succeeds; undefined
409 @retval EFI_SUCCESS The event structure was created.
410 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
411 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
416 (EFIAPI
*EFI_CREATE_EVENT_EX
) (
418 IN EFI_TPL NotifyTpl OPTIONAL
,
419 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
420 IN CONST VOID
*NotifyContext OPTIONAL
,
421 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
432 Sets the type of timer and the trigger time for a timer event.
434 @param Event The timer event that is to be signaled at the specified time.
435 @param Type The type of time that is specified in TriggerTime.
436 @param TriggerTime The number of 100ns units until the timer expires.
438 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
439 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
444 (EFIAPI
*EFI_SET_TIMER
) (
446 IN EFI_TIMER_DELAY Type
,
447 IN UINT64 TriggerTime
453 @param Event The event to signal.
455 @retval EFI_SUCCESS The event has been signaled.
460 (EFIAPI
*EFI_SIGNAL_EVENT
) (
465 Stops execution until an event is signaled.
467 @param NumberOfEvents The number of events in the Event array.
468 @param Event An array of EFI_EVENT.
469 @param Index Pointer to the index of the event which satisfied the wait condition.
471 @retval EFI_SUCCESS The event indicated by Index was signaled.
472 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
473 2) The event indicated by Index is of type
475 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
480 (EFIAPI
*EFI_WAIT_FOR_EVENT
) (
481 IN UINTN NumberOfEvents
,
489 @param Event The event to close.
491 @retval EFI_SUCCESS The event has been closed.
496 (EFIAPI
*EFI_CLOSE_EVENT
) (
501 Checks whether an event is in the signaled state.
503 @param Event The event to check.
505 @retval EFI_SUCCESS The event is in the signaled state.
506 @retval EFI_NOT_READY The event is not in the signaled state.
507 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
512 (EFIAPI
*EFI_CHECK_EVENT
) (
518 // Task priority level (name defined in spec).
520 #define TPL_APPLICATION 4
521 #define TPL_CALLBACK 8
522 #define TPL_NOTIFY 16
523 #define TPL_HIGH_LEVEL 31
527 Raises a task's priority level and returns its previous level.
529 @param NewTpl The new task priority level.
531 @retval Previous task priority level
536 (EFIAPI
*EFI_RAISE_TPL
) (
541 Restores a task's priority level to its previous value.
543 @param OldTpl The previous task priority level to restore
548 (EFIAPI
*EFI_RESTORE_TPL
) (
553 Returns the value of a variable.
555 @param VariableName A Null-terminated Unicode string that is the name of the
557 @param VendorGuid A unique identifier for the vendor.
558 @param Attributes If not NULL, a pointer to the memory location to return the
559 attributes bitmask for the variable.
560 @param DataSize On input, the size in bytes of the return Data buffer.
561 On output the size of data returned in Data.
562 @param Data The buffer to return the contents of the variable.
564 @retval EFI_SUCCESS The function completed successfully.
565 @retval EFI_NOT_FOUND The variable was not found.
566 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
567 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
568 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
573 (EFIAPI
*EFI_GET_VARIABLE
) (
574 IN CHAR16
*VariableName
,
575 IN EFI_GUID
*VendorGuid
,
576 OUT UINT32
*Attributes
, OPTIONAL
577 IN OUT UINTN
*DataSize
,
582 Enumerates the current variable names.
584 @param VariableNameSize The size of the VariableName buffer.
585 @param VariableName On input, supplies the last VariableName that was returned
586 by GetNextVariableName(). On output, returns the Nullterminated
587 Unicode string of the current variable.
588 @param VendorGuid On input, supplies the last VendorGuid that was returned by
589 GetNextVariableName(). On output, returns the
590 VendorGuid of the current variable.
592 @retval EFI_SUCCESS The function completed successfully.
593 @retval EFI_NOT_FOUND The next variable was not found.
594 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
595 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
596 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
601 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
) (
602 IN OUT UINTN
*VariableNameSize
,
603 IN OUT CHAR16
*VariableName
,
604 IN OUT EFI_GUID
*VendorGuid
608 Sets the value of a variable.
610 @param VariableName A Null-terminated Unicode string that is the name of the
612 @param VendorGuid A unique identifier for the vendor.
613 @param Attributes Attributes bitmask to set for the variable.
614 @param DataSize The size in bytes of the Data buffer.
615 @param Data The contents for the variable.
617 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
618 defined by the Attributes.
619 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
620 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
621 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
622 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
627 (EFIAPI
*EFI_SET_VARIABLE
) (
628 IN CHAR16
*VariableName
,
629 IN EFI_GUID
*VendorGuid
,
630 IN UINT32 Attributes
,
637 // This provides the capabilities of the
638 // real time clock device as exposed through the EFI interfaces.
644 } EFI_TIME_CAPABILITIES
;
647 Returns the current time and date information, and the time-keeping capabilities
648 of the hardware platform.
650 @param Time A pointer to storage to receive a snapshot of the current time.
651 @param Capabilities An optional pointer to a buffer to receive the real time clock
652 device's capabilities.
654 @retval EFI_SUCCESS The operation completed successfully.
655 @retval EFI_INVALID_PARAMETER Time is NULL.
656 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
661 (EFIAPI
*EFI_GET_TIME
) (
663 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
667 Sets the current local time and date information.
669 @param Time A pointer to the current time.
671 @retval EFI_SUCCESS The operation completed successfully.
672 @retval EFI_INVALID_PARAMETER A time field is out of range.
673 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
678 (EFIAPI
*EFI_SET_TIME
) (
683 Returns the current wakeup alarm clock setting.
685 @param Enabled Indicates if the alarm is currently enabled or disabled.
686 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
687 @param Time The current alarm setting.
689 @retval EFI_SUCCESS The alarm settings were returned.
690 @retval EFI_INVALID_PARAMETER Any parameter is NULL.
691 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
696 (EFIAPI
*EFI_GET_WAKEUP_TIME
) (
697 OUT BOOLEAN
*Enabled
,
698 OUT BOOLEAN
*Pending
,
703 Sets the system wakeup alarm clock time.
705 @param Enabled Enable or disable the wakeup alarm.
706 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
708 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
709 Enable is FALSE, then the wakeup alarm was disabled.
710 @retval EFI_INVALID_PARAMETER A time field is out of range.
711 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
712 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
717 (EFIAPI
*EFI_SET_WAKEUP_TIME
) (
719 IN EFI_TIME
*Time OPTIONAL
723 This is the declaration of an EFI image entry point. This can be the entry point to an application
724 written to this specification, an EFI boot service driver, or an EFI runtime driver.
726 @param ImageHandle Handle that identifies the loaded image.
727 @param SystemTable System Table for this image.
729 @retval EFI_SUCCESS The operation completed successfully.
734 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
) (
735 IN EFI_HANDLE ImageHandle
,
736 IN EFI_SYSTEM_TABLE
*SystemTable
740 Loads an EFI image into memory.
742 @param BootPolicy If TRUE, indicates that the request originates from the boot
743 manager, and that the boot manager is attempting to load
744 FilePath as a boot selection. Ignored if SourceBuffer is
746 @param ParentImageHandle The caller's image handle.
747 @param FilePath The DeviceHandle specific file path from which the image is
749 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
750 of the image to be loaded.
751 @param SourceSize The size in bytes of SourceBuffer.
752 @param ImageHandle Pointer to the returned image handle that is created when the
753 image is successfully loaded.
755 @retval EFI_SUCCESS Image was loaded into memory correctly.
756 @retval EFI_NOT_FOUND Both SourceBuffer and FilePath are NULL.
757 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
758 @retval EFI_UNSUPPORTED The image type is not supported.
759 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
760 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
762 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
767 (EFIAPI
*EFI_IMAGE_LOAD
) (
768 IN BOOLEAN BootPolicy
,
769 IN EFI_HANDLE ParentImageHandle
,
770 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
771 IN VOID
*SourceBuffer OPTIONAL
,
773 OUT EFI_HANDLE
*ImageHandle
777 Transfers control to a loaded image's entry point.
779 @param ImageHandle Handle of image to be started.
780 @param ExitDataSize Pointer to the size, in bytes, of ExitData.
781 @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
782 Unicode string, optionally followed by additional binary data.
784 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
785 has already been initialized with StartImage
786 @retval Exit code from image Exit code from image
791 (EFIAPI
*EFI_IMAGE_START
) (
792 IN EFI_HANDLE ImageHandle
,
793 OUT UINTN
*ExitDataSize
,
794 OUT CHAR16
**ExitData OPTIONAL
798 Terminates a loaded EFI image and returns control to boot services.
800 @param ImageHandle Handle that identifies the image.
801 @param ExitStatus The image's exit code.
802 @param ExitDataSize The size, in bytes, of ExitData.
803 @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
804 optionally followed by additional binary data.
806 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
807 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
808 started with LoadImage() and StartImage(), but the
809 image is not the currently executing image.
815 IN EFI_HANDLE ImageHandle
,
816 IN EFI_STATUS ExitStatus
,
817 IN UINTN ExitDataSize
,
818 IN CHAR16
*ExitData OPTIONAL
824 @param ImageHandle Handle that identifies the image to be unloaded.
826 @retval EFI_SUCCESS The image has been unloaded.
827 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
828 @retval EFI_UNSUPPORTED The image has been started, and does not support unload.
829 @retval Exit code from the image's unload handler
834 (EFIAPI
*EFI_IMAGE_UNLOAD
) (
835 IN EFI_HANDLE ImageHandle
839 Terminates all boot services.
841 @param ImageHandle Handle that identifies the exiting image.
842 @param MapKey Key to the latest memory map.
844 @retval EFI_SUCCESS Boot services have been terminated.
845 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
850 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
) (
851 IN EFI_HANDLE ImageHandle
,
856 Induces a fine-grained stall.
858 @param Microseconds The number of microseconds to stall execution.
860 @retval EFI_SUCCESS Execution was stalled at least the requested number of
866 (EFIAPI
*EFI_STALL
) (
867 IN UINTN Microseconds
871 Sets the system's watchdog timer.
873 @param Timeout The number of seconds to set the watchdog timer to.
874 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
875 @param DataSize The size, in bytes, of WatchdogData.
876 @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
877 followed by additional binary data.
879 @retval EFI_SUCCESS The timeout has been set.
880 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
881 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
882 @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
888 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
) (
890 IN UINT64 WatchdogCode
,
892 IN CHAR16
*WatchdogData OPTIONAL
896 // Enumeration of reset types.
905 Resets the entire platform.
907 @param ResetType The type of reset to perform.
908 @param ResetStatus The status code for the reset.
909 @param DataSize The size, in bytes, of WatchdogData.
910 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
911 EfiResetShutdown the data buffer starts with a Null-terminated
912 Unicode string, optionally followed by additional binary data.
917 (EFIAPI
*EFI_RESET_SYSTEM
) (
918 IN EFI_RESET_TYPE ResetType
,
919 IN EFI_STATUS ResetStatus
,
921 IN CHAR16
*ResetData OPTIONAL
925 Returns a monotonically increasing count for the platform.
927 @param Count Pointer to returned value.
929 @retval EFI_SUCCESS The next monotonic count was returned.
930 @retval EFI_INVALID_PARAMETER Count is NULL.
931 @retval EFI_DEVICE_ERROR The device is not functioning properly.
936 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
) (
941 Returns the next high 32 bits of the platform's monotonic counter.
943 @param HighCount Pointer to returned value.
945 @retval EFI_SUCCESS The next high monotonic count was returned.
946 @retval EFI_INVALID_PARAMETER HighCount is NULL.
947 @retval EFI_DEVICE_ERROR The device is not functioning properly.
952 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
) (
953 OUT UINT32
*HighCount
957 Computes and returns a 32-bit CRC for a data buffer.
959 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
960 @param DataSize The number of bytes in the buffer Data.
961 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
964 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
966 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
971 (EFIAPI
*EFI_CALCULATE_CRC32
) (
978 Copies the contents of one buffer to another buffer.
980 @param Destination Pointer to the destination buffer of the memory copy.
981 @param Source Pointer to the source buffer of the memory copy.
982 @param Length Number of bytes to copy from Source to Destination.
987 (EFIAPI
*EFI_COPY_MEM
) (
988 IN VOID
*Destination
,
994 The SetMem() function fills a buffer with a specified value.
996 @param Buffer Pointer to the buffer to fill.
997 @param Size Number of bytes in Buffer to fill.
998 @param Value Value to fill Buffer with.
1003 (EFIAPI
*EFI_SET_MEM
) (
1011 // Protocol handler functions
1014 EFI_NATIVE_INTERFACE
1015 } EFI_INTERFACE_TYPE
;
1018 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1019 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1020 more error checking than InstallProtocolInterface(), so it is recommended that
1021 InstallMultipleProtocolInterfaces() be used in place of
1022 InstallProtocolInterface()
1024 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1025 @param Protocol The numeric ID of the protocol interface.
1026 @param InterfaceType Indicates whether Interface is supplied in native form.
1027 @param Interface A pointer to the protocol interface.
1029 @retval EFI_SUCCESS The protocol interface was installed.
1030 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1031 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1036 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
) (
1037 IN OUT EFI_HANDLE
*Handle
,
1038 IN EFI_GUID
*Protocol
,
1039 IN EFI_INTERFACE_TYPE InterfaceType
,
1044 Installs one or more protocol interfaces into the boot services environment.
1046 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1047 handle is to be allocated.
1048 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1051 @retval EFI_SUCCESS All the protocol interface was installed.
1052 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1053 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1054 the handle database.
1059 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
) (
1060 IN OUT EFI_HANDLE
*Handle
,
1065 Reinstalls a protocol interface on a device handle.
1067 @param Handle Handle on which the interface is to be reinstalled.
1068 @param Protocol The numeric ID of the interface.
1069 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1070 associated with Protocol.
1071 @param NewInterface A pointer to the new interface.
1073 @retval EFI_SUCCESS The protocol interface was reinstalled.
1074 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1075 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1076 because OldInterface is still being used by a
1077 driver that will not release it.
1078 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1083 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
) (
1084 IN EFI_HANDLE Handle
,
1085 IN EFI_GUID
*Protocol
,
1086 IN VOID
*OldInterface
,
1087 IN VOID
*NewInterface
1091 Removes a protocol interface from a device handle. It is recommended that
1092 UninstallMultipleProtocolInterfaces() be used in place of
1093 UninstallProtocolInterface().
1095 @param Handle The handle on which the interface was installed.
1096 @param Protocol The numeric ID of the interface.
1097 @param Interface A pointer to the interface.
1099 @retval EFI_SUCCESS The interface was removed.
1100 @retval EFI_NOT_FOUND The interface was not found.
1101 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1102 is still being used by a driver.
1103 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1108 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
) (
1109 IN EFI_HANDLE Handle
,
1110 IN EFI_GUID
*Protocol
,
1115 Removes one or more protocol interfaces into the boot services environment.
1117 @param Handle The handle to remove the protocol interfaces from.
1118 @param ... A variable argument list containing pairs of protocol GUIDs and
1119 protocol interfaces.
1121 @retval EFI_SUCCESS All the protocol interfaces were removed.
1122 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1127 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
) (
1128 IN EFI_HANDLE Handle
,
1133 Queries a handle to determine if it supports a specified protocol.
1135 @param Handle The handle being queried.
1136 @param Protocol The published unique identifier of the protocol.
1137 @param Interface Supplies the address where a pointer to the corresponding Protocol
1138 Interface is returned.
1139 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1140 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1141 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1146 (EFIAPI
*EFI_HANDLE_PROTOCOL
) (
1147 IN EFI_HANDLE Handle
,
1148 IN EFI_GUID
*Protocol
,
1149 OUT VOID
**Interface
1152 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1153 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1154 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1155 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1156 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1157 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1160 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1161 handle, it opens the protocol on behalf of the calling agent.
1163 @param Handle The handle for the protocol interface that is being opened.
1164 @param Protocol The published unique identifier of the protocol.
1165 @param Interface Supplies the address where a pointer to the corresponding Protocol
1166 Interface is returned.
1167 @param AgentHandle The handle of the agent that is opening the protocol interface
1168 specified by Protocol and Interface.
1169 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1170 UEFI Driver Model, then this parameter is the controller handle
1171 that requires the protocol interface. If the agent does not follow
1172 the UEFI Driver Model, then this parameter is optional and may
1174 @param Attributes The open mode of the protocol interface specified by Handle
1177 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1178 protocol interface was returned in Interface.
1179 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1180 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1181 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1182 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1183 handle is the same as AgentHandle.
1188 (EFIAPI
*EFI_OPEN_PROTOCOL
) (
1189 IN EFI_HANDLE Handle
,
1190 IN EFI_GUID
*Protocol
,
1191 OUT VOID
**Interface
,
1192 IN EFI_HANDLE AgentHandle
,
1193 IN EFI_HANDLE ControllerHandle
, OPTIONAL
1194 IN UINT32 Attributes
1199 Closes a protocol on a handle that was opened using OpenProtocol().
1201 @param Handle The handle for the protocol interface that was previously opened
1202 with OpenProtocol(), and is now being closed.
1203 @param Protocol The published unique identifier of the protocol.
1204 @param Interface Supplies the address where a pointer to the corresponding Protocol
1205 Interface is returned.
1206 @param AgentHandle The handle of the agent that is closing the protocol interface.
1207 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1208 UEFI Driver Model, then this parameter is the controller handle
1209 that required the protocol interface.
1211 @retval EFI_SUCCESS The protocol instance was closed.
1212 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1213 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1214 2) The protocol interface specified by Handle and Protocol is not
1215 currently open by AgentHandle and ControllerHandle.
1220 (EFIAPI
*EFI_CLOSE_PROTOCOL
) (
1221 IN EFI_HANDLE Handle
,
1222 IN EFI_GUID
*Protocol
,
1223 IN EFI_HANDLE AgentHandle
,
1224 IN EFI_HANDLE ControllerHandle
1229 EFI_HANDLE AgentHandle
;
1230 EFI_HANDLE ControllerHandle
;
1233 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1236 Retrieves the list of agents that currently have a protocol interface opened.
1238 @param Handle The handle for the protocol interface that is being queried.
1239 @param Protocol The published unique identifier of the protocol.
1240 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1241 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1242 @param EntryCount A pointer to the number of entries in EntryBuffer.
1244 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1245 number of entries was returned EntryCount.
1246 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1247 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1252 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
) (
1253 IN EFI_HANDLE Handle
,
1254 IN EFI_GUID
*Protocol
,
1255 IN EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1256 OUT UINTN
*EntryCount
1260 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1263 @param Handle The handle from which to retrieve the list of protocol interface
1265 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1266 installed on Handle.
1267 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1270 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1271 ProtocolBuffer. The number of protocol interface GUIDs was
1272 returned in ProtocolBufferCount.
1273 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1274 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1279 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
) (
1280 IN EFI_HANDLE Handle
,
1281 OUT EFI_GUID
***ProtocolBuffer
,
1282 OUT UINTN
*ProtocolBufferCount
1286 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1288 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1289 @param Event Event that is to be signaled whenever a protocol interface is registered
1291 @param Registration A pointer to a memory location to receive the registration value.
1293 @retval EFI_SUCCESS The notification event has been registered.
1294 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1295 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1300 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
) (
1301 IN EFI_GUID
*Protocol
,
1303 OUT VOID
**Registration
1311 } EFI_LOCATE_SEARCH_TYPE
;
1314 Returns an array of handles that support a specified protocol.
1316 @param SearchType Specifies which handle(s) are to be returned.
1317 @param Protocol Specifies the protocol to search by.
1318 @param SearchKey Specifies the search key.
1319 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1320 the array returned in Buffer (if the buffer was large enough) or the
1321 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1323 @param Buffer The buffer in which the array is returned.
1325 @retval EFI_SUCCESS The array of handles was returned.
1326 @retval EFI_NOT_FOUND No handles match the search.
1327 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1328 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1333 (EFIAPI
*EFI_LOCATE_HANDLE
) (
1334 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1335 IN EFI_GUID
*Protocol
, OPTIONAL
1336 IN VOID
*SearchKey
, OPTIONAL
1337 IN OUT UINTN
*BufferSize
,
1338 OUT EFI_HANDLE
*Buffer
1342 Locates the handle to a device on the device path that supports the specified protocol.
1344 @param Protocol Specifies the protocol to search for.
1345 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1346 path pointer is modified to point to the remaining part of the device
1348 @param Device A pointer to the returned device handle.
1350 @retval EFI_SUCCESS The resulting handle was returned.
1351 @retval EFI_NOT_FOUND No handles match the search.
1352 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1357 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
) (
1358 IN EFI_GUID
*Protocol
,
1359 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1360 OUT EFI_HANDLE
*Device
1364 Adds, updates, or removes a configuration table entry from the EFI System Table.
1366 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1367 @param Table A pointer to the configuration table for the entry to add, update, or
1368 remove. May be NULL.
1370 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1371 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1372 @retval EFI_INVALID_PARAMETER Guid is not valid.
1373 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1378 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
) (
1385 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1387 @param SearchType Specifies which handle(s) are to be returned.
1388 @param Protocol Specifies the protocol to search by.
1389 @param SearchKey Supplies the search key depending on the SearchType.
1390 @param NoHandles The number of handles returned in Buffer.
1391 @param Buffer A pointer to the buffer to return the requested array of handles that
1394 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1395 handles in Buffer was returned in NoHandles.
1396 @retval EFI_NOT_FOUND No handles match the search.
1397 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1398 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1403 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
) (
1404 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1405 IN EFI_GUID
*Protocol
, OPTIONAL
1406 IN VOID
*SearchKey
, OPTIONAL
1407 IN OUT UINTN
*NoHandles
,
1408 OUT EFI_HANDLE
**Buffer
1412 Returns the first protocol instance that matches the given protocol.
1414 @param Protocol Provides the protocol to search for.
1415 @param Registration Optional registration key returned from
1416 RegisterProtocolNotify().
1417 @param Interface On return, a pointer to the first interface that matches Protocol and
1420 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1422 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1424 @retval EFI_INVALID_PARAMETER Interface is NULL.
1429 (EFIAPI
*EFI_LOCATE_PROTOCOL
) (
1430 IN EFI_GUID
*Protocol
,
1431 IN VOID
*Registration
, OPTIONAL
1432 OUT VOID
**Interface
1438 EFI_PHYSICAL_ADDRESS DataBlock
;
1439 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1441 } UEFI_CAPSULE_BLOCK_DESCRIPTOR
;
1444 EFI_GUID CapsuleGuid
;
1447 UINT32 CapsuleImageSize
;
1448 } UEFI_CAPSULE_HEADER
;
1450 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1451 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1454 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1455 consumption, the firmware may process the capsule immediately. If the payload should persist
1456 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1457 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1458 part of the reset process.
1460 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1461 being passed into update capsule.
1462 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1464 @param ScatterGatherList Physical pointer to a set of
1465 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1466 location in physical memory of a set of capsules.
1468 @retval EFI_SUCCESS Valid capsule was passed. If
1469 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1470 capsule has been successfully processed by the firmware.
1471 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1472 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL.
1477 (EFIAPI
*EFI_UPDATE_CAPSULE
) (
1478 IN UEFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1479 IN UINTN CapsuleCount
,
1480 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1484 Returns if the capsule can be supported via UpdateCapsule().
1486 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1487 being passed into update capsule.
1488 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1490 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1491 support as an argument to UpdateCapsule() via
1492 CapsuleHeaderArray and ScatterGatherList.
1493 @param ResetType Returns the type of reset required for the capsule update.
1495 @retval EFI_SUCCESS Valid answer returned.
1496 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1497 MaximumCapsuleSize and ResetType are undefined.
1498 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1503 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
) (
1504 IN UEFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1505 IN UINTN CapsuleCount
,
1506 OUT UINT64
*MaximumCapsuleSize
,
1507 OUT EFI_RESET_TYPE
*ResetType
1511 Returns information about the EFI variables.
1513 @param Attributes Attributes bitmask to specify the type of variables on
1514 which to return information.
1515 @param MaximumVariableStorageSize On output the maximum size of the storage space
1516 available for the EFI variables associated with the
1517 attributes specified.
1518 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1519 available for the EFI variables associated with the
1520 attributes specified.
1521 @param MaximumVariableSize Returns the maximum size of the individual EFI
1522 variables associated with the attributes specified.
1524 @retval EFI_SUCCESS Valid answer returned.
1525 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1526 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1527 MaximumVariableStorageSize,
1528 RemainingVariableStorageSize, MaximumVariableSize
1534 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
) (
1535 IN UINT32 Attributes
,
1536 OUT UINT64
*MaximumVariableStorageSize
,
1537 OUT UINT64
*RemainingVariableStorageSize
,
1538 OUT UINT64
*MaximumVariableSize
1543 // EFI Runtime Services Table
1545 #define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249
1546 #define EFI_SYSTEM_TABLE_REVISION ((2<<16) | (10))
1547 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2<<16) | (10))
1548 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2<<16) | (00))
1549 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1<<16) | (10))
1550 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1<<16) | (02))
1552 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552
1553 #define EFI_RUNTIME_SERVICES_REVISION EFI_2_00_SYSTEM_TABLE_REVISION
1556 EFI_TABLE_HEADER Hdr
;
1561 EFI_GET_TIME GetTime
;
1562 EFI_SET_TIME SetTime
;
1563 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1564 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1567 // Virtual Memory Services
1569 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1570 EFI_CONVERT_POINTER ConvertPointer
;
1573 // Variable Services
1575 EFI_GET_VARIABLE GetVariable
;
1576 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1577 EFI_SET_VARIABLE SetVariable
;
1580 // Miscellaneous Services
1582 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1583 EFI_RESET_SYSTEM ResetSystem
;
1586 // UEFI 2.0 Capsule Services
1588 EFI_UPDATE_CAPSULE UpdateCapsule
;
1589 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1592 // Miscellaneous UEFI 2.0 Service
1594 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1595 } EFI_RUNTIME_SERVICES
;
1598 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
1599 #define EFI_BOOT_SERVICES_REVISION ((2<<16) | (00))
1602 EFI_TABLE_HEADER Hdr
;
1605 // Task Priority Services
1607 EFI_RAISE_TPL RaiseTPL
;
1608 EFI_RESTORE_TPL RestoreTPL
;
1613 EFI_ALLOCATE_PAGES AllocatePages
;
1614 EFI_FREE_PAGES FreePages
;
1615 EFI_GET_MEMORY_MAP GetMemoryMap
;
1616 EFI_ALLOCATE_POOL AllocatePool
;
1617 EFI_FREE_POOL FreePool
;
1620 // Event & Timer Services
1622 EFI_CREATE_EVENT CreateEvent
;
1623 EFI_SET_TIMER SetTimer
;
1624 EFI_WAIT_FOR_EVENT WaitForEvent
;
1625 EFI_SIGNAL_EVENT SignalEvent
;
1626 EFI_CLOSE_EVENT CloseEvent
;
1627 EFI_CHECK_EVENT CheckEvent
;
1630 // Protocol Handler Services
1632 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1633 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1634 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1635 EFI_HANDLE_PROTOCOL HandleProtocol
;
1637 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1638 EFI_LOCATE_HANDLE LocateHandle
;
1639 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1640 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1645 EFI_IMAGE_LOAD LoadImage
;
1646 EFI_IMAGE_START StartImage
;
1648 EFI_IMAGE_UNLOAD UnloadImage
;
1649 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1652 // Miscellaneous Services
1654 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1656 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1659 // DriverSupport Services
1661 EFI_CONNECT_CONTROLLER ConnectController
;
1662 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1665 // Open and Close Protocol Services
1667 EFI_OPEN_PROTOCOL OpenProtocol
;
1668 EFI_CLOSE_PROTOCOL CloseProtocol
;
1669 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1674 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1675 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1676 EFI_LOCATE_PROTOCOL LocateProtocol
;
1677 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1678 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1681 // 32-bit CRC Services
1683 EFI_CALCULATE_CRC32 CalculateCrc32
;
1686 // Miscellaneous Services
1688 EFI_COPY_MEM CopyMem
;
1691 EFI_CREATE_EVENT_EX CreateEventEx
;
1692 } EFI_BOOT_SERVICES
;
1695 // Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1696 // EFI System Table.
1699 EFI_GUID VendorGuid
;
1701 } EFI_CONFIGURATION_TABLE
;
1703 struct _EFI_SYSTEM_TABLE
{
1704 EFI_TABLE_HEADER Hdr
;
1705 CHAR16
*FirmwareVendor
;
1706 UINT32 FirmwareRevision
;
1707 EFI_HANDLE ConsoleInHandle
;
1708 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1709 EFI_HANDLE ConsoleOutHandle
;
1710 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1711 EFI_HANDLE StandardErrorHandle
;
1712 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
1713 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1714 EFI_BOOT_SERVICES
*BootServices
;
1715 UINTN NumberOfTableEntries
;
1716 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
1720 // EFI File location to boot from on removable media devices
1722 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
1723 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
1724 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
1725 #define EFI_REMOVABLE_MEDIA_FILE_NAME_EBC L"\\EFI\\BOOT\\BOOTEBC.EFI"
1727 #if defined (MDE_CPU_IA32)
1728 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
1729 #elif defined (MDE_CPU_IPF)
1730 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
1731 #elif defined (MDE_CPU_X64)
1732 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
1733 #elif defined (MDE_CPU_EBC)
1734 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_EBC
1736 #error Unknown Processor Type
1739 #include <Uefi/UefiDevicePath.h>
1740 #include <Uefi/UefiPxe.h>
1741 #include <Uefi/UefiGpt.h>
1742 #include <Uefi/UefiInternalFormRepresentation.h>