2 Include file that supports UEFI.
4 This include file must contain things defined in the UEFI 2.3 specification.
5 If a code construct is defined in the UEFI 2.3 specification it must be included
8 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials are licensed and made available under
10 the terms and conditions of the BSD License that accompanies this distribution.
11 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/SimpleTextInEx.h>
27 #include <Protocol/SimpleTextOut.h>
30 /// Enumeration of EFI memory allocation types.
34 /// Allocate any available range of pages that satisfies the request.
38 /// Allocate any available range of pages whose uppermost address is less than
39 /// or equal to a specified maximum address.
43 /// Allocate pages at a specified address.
47 /// Maximum enumeration value that may be used for bounds checking.
53 // Bit definitions for EFI_TIME.Daylight
55 #define EFI_TIME_ADJUST_DAYLIGHT 0x01
56 #define EFI_TIME_IN_DAYLIGHT 0x02
59 /// Value definition for EFI_TIME.TimeZone.
61 #define EFI_UNSPECIFIED_TIMEZONE 0x07FF
64 // Memory cacheability attributes
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
72 // Physical memory protection attributes
74 #define EFI_MEMORY_WP 0x0000000000001000ULL
75 #define EFI_MEMORY_RP 0x0000000000002000ULL
76 #define EFI_MEMORY_XP 0x0000000000004000ULL
78 // Runtime memory attribute
80 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
83 /// Memory descriptor version number.
85 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
88 /// Definition of an EFI memory descriptor.
92 /// Type of the memory region. See EFI_MEMORY_TYPE.
96 /// Physical address of the first byte of the memory region. Must aligned
97 /// on a 4 KB boundary.
99 EFI_PHYSICAL_ADDRESS PhysicalStart
;
101 /// Virtual address of the first byte of the memory region. Must aligned
102 /// on a 4 KB boundary.
104 EFI_VIRTUAL_ADDRESS VirtualStart
;
106 /// Number of 4KB pages in the memory region.
108 UINT64 NumberOfPages
;
110 /// Attributes of the memory region that describe the bit mask of capabilities
111 /// for that memory region, and not necessarily the current settings for that
115 } EFI_MEMORY_DESCRIPTOR
;
118 Allocates memory pages from the system.
120 @param Type The type of allocation to perform.
121 @param MemoryType The type of memory to allocate.
122 @param Pages The number of contiguous 4 KB pages to allocate.
123 @param Memory The pointer to a physical address. On input, the way in which the address is
124 used depends on the value of Type.
126 @retval EFI_SUCCESS The requested pages were allocated.
127 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
128 AllocateMaxAddress or AllocateAddress.
129 2) MemoryType is in the range
130 EfiMaxMemoryType..0x7FFFFFFF.
131 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
132 @retval EFI_NOT_FOUND The requested pages could not be found.
137 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
138 IN EFI_ALLOCATE_TYPE Type
,
139 IN EFI_MEMORY_TYPE MemoryType
,
141 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
147 @param Memory The base physical address of the pages to be freed.
148 @param Pages The number of contiguous 4 KB pages to free.
150 @retval EFI_SUCCESS The requested pages were freed.
151 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
152 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
158 (EFIAPI
*EFI_FREE_PAGES
)(
159 IN EFI_PHYSICAL_ADDRESS Memory
,
164 Returns the current memory map.
166 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
167 On input, this is the size of the buffer allocated by the caller.
168 On output, it is the size of the buffer returned by the firmware if
169 the buffer was large enough, or the size of the buffer needed to contain
170 the map if the buffer was too small.
171 @param MemoryMap A pointer to the buffer in which firmware places the current memory
173 @param MapKey A pointer to the location in which firmware returns the key for the
175 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
176 an individual EFI_MEMORY_DESCRIPTOR.
177 @param DescriptorVersion A pointer to the location in which firmware returns the version number
178 associated with the EFI_MEMORY_DESCRIPTOR.
180 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
181 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
182 needed to hold the memory map is returned in MemoryMapSize.
183 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
184 2) The MemoryMap buffer is not too small and MemoryMap is
190 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
191 IN OUT UINTN
*MemoryMapSize
,
192 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
194 OUT UINTN
*DescriptorSize
,
195 OUT UINT32
*DescriptorVersion
199 Allocates pool memory.
201 @param PoolType The type of pool to allocate.
202 @param Size The number of bytes to allocate from the pool.
203 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
206 @retval EFI_SUCCESS The requested number of bytes was allocated.
207 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
208 @retval EFI_INVALID_PARAMETER PoolType was invalid.
213 (EFIAPI
*EFI_ALLOCATE_POOL
)(
214 IN EFI_MEMORY_TYPE PoolType
,
220 Returns pool memory to the system.
222 @param Buffer The pointer to the buffer to free.
224 @retval EFI_SUCCESS The memory was returned to the system.
225 @retval EFI_INVALID_PARAMETER Buffer was invalid.
230 (EFIAPI
*EFI_FREE_POOL
)(
235 Changes the runtime addressing mode of EFI firmware from physical to virtual.
237 @param MemoryMapSize The size in bytes of VirtualMap.
238 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
239 @param DescriptorVersion The version of the structure entries in VirtualMap.
240 @param VirtualMap An array of memory descriptors which contain new virtual
241 address mapping information for all runtime ranges.
243 @retval EFI_SUCCESS The virtual address map has been applied.
244 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
245 virtual address mapped mode.
246 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
247 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
248 map that requires a mapping.
249 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
255 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
256 IN UINTN MemoryMapSize
,
257 IN UINTN DescriptorSize
,
258 IN UINT32 DescriptorVersion
,
259 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
263 Connects one or more drivers to a controller.
265 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
266 @param DriverImageHandle A pointer to an ordered list handles that support the
267 EFI_DRIVER_BINDING_PROTOCOL.
268 @param RemainingDevicePath A pointer to the device path that specifies a child of the
269 controller specified by ControllerHandle.
270 @param Recursive If TRUE, then ConnectController() is called recursively
271 until the entire tree of controllers below the controller specified
272 by ControllerHandle have been created. If FALSE, then
273 the tree of controllers is only expanded one level.
275 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
276 2) No drivers were connected to ControllerHandle, but
277 RemainingDevicePath is not NULL, and it is an End Device
279 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
280 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
281 present in the system.
282 2) No drivers were connected to ControllerHandle.
287 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
288 IN EFI_HANDLE ControllerHandle
,
289 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
290 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
295 Disconnects one or more drivers from a controller.
297 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
298 @param DriverImageHandle The driver to disconnect from ControllerHandle.
299 If DriverImageHandle is NULL, then all the drivers currently managing
300 ControllerHandle are disconnected from ControllerHandle.
301 @param ChildHandle The handle of the child to destroy.
302 If ChildHandle is NULL, then all the children of ControllerHandle are
303 destroyed before the drivers are disconnected from ControllerHandle.
305 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
306 2) On entry, no drivers are managing ControllerHandle.
307 3) DriverImageHandle is not NULL, and on entry
308 DriverImageHandle is not managing ControllerHandle.
309 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.
310 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
311 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
312 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
313 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
315 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
320 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
321 IN EFI_HANDLE ControllerHandle
,
322 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
323 IN EFI_HANDLE ChildHandle OPTIONAL
329 // ConvertPointer DebugDisposition type.
331 #define EFI_OPTIONAL_PTR 0x00000001
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 The 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 The pointer to the event's notification function, if any.
398 @param NotifyContext The pointer to the notification function's context; corresponds to parameter
399 Context in the notification function.
400 @param Event The 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 The pointer to the event's notification function, if any.
424 @param NotifyContext The pointer to the notification function's context; corresponds to parameter
425 Context in the notification function.
426 @param EventGroup The 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 The 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 The 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 string that is the name of the vendor's
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 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 string that is the name of the vendor's variable.
657 Each VariableName is unique for each VendorGuid. VariableName must
658 contain 1 or more characters. If VariableName is an empty string,
659 then EFI_INVALID_PARAMETER is returned.
660 @param VendorGuid A unique identifier for the vendor.
661 @param Attributes Attributes bitmask to set for the variable.
662 @param DataSize The size in bytes of the Data buffer. A size of zero causes the
663 variable to be deleted.
664 @param Data The contents for the variable.
666 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
667 defined by the Attributes.
668 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
669 DataSize exceeds the maximum allowed.
670 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
671 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
672 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
673 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
674 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
675 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
676 set but the AuthInfo does NOT pass the validation check carried out
678 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
683 (EFIAPI
*EFI_SET_VARIABLE
)(
684 IN CHAR16
*VariableName
,
685 IN EFI_GUID
*VendorGuid
,
686 IN UINT32 Attributes
,
693 /// This provides the capabilities of the
694 /// real time clock device as exposed through the EFI interfaces.
698 /// Provides the reporting resolution of the real-time clock device in
699 /// counts per second. For a normal PC-AT CMOS RTC device, this
700 /// value would be 1 Hz, or 1, to indicate that the device only reports
701 /// the time to the resolution of 1 second.
705 /// Provides the timekeeping accuracy of the real-time clock in an
706 /// error rate of 1E-6 parts per million. For a clock with an accuracy
707 /// of 50 parts per million, the value in this field would be
712 /// A TRUE indicates that a time set operation clears the device's
713 /// time below the Resolution reporting level. A FALSE
714 /// indicates that the state below the Resolution level of the
715 /// device is not cleared when the time is set. Normal PC-AT CMOS
716 /// RTC devices set this value to FALSE.
719 } EFI_TIME_CAPABILITIES
;
722 Returns the current time and date information, and the time-keeping capabilities
723 of the hardware platform.
725 @param Time A pointer to storage to receive a snapshot of the current time.
726 @param Capabilities An optional pointer to a buffer to receive the real time clock
727 device's capabilities.
729 @retval EFI_SUCCESS The operation completed successfully.
730 @retval EFI_INVALID_PARAMETER Time is NULL.
731 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
736 (EFIAPI
*EFI_GET_TIME
)(
738 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
742 Sets the current local time and date information.
744 @param Time A pointer to the current time.
746 @retval EFI_SUCCESS The operation completed successfully.
747 @retval EFI_INVALID_PARAMETER A time field is out of range.
748 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
753 (EFIAPI
*EFI_SET_TIME
)(
758 Returns the current wakeup alarm clock setting.
760 @param Enabled Indicates if the alarm is currently enabled or disabled.
761 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
762 @param Time The current alarm setting.
764 @retval EFI_SUCCESS The alarm settings were returned.
765 @retval EFI_INVALID_PARAMETER Enabled is NULL.
766 @retval EFI_INVALID_PARAMETER Pending is NULL.
767 @retval EFI_INVALID_PARAMETER Time is NULL.
768 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
769 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
774 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
775 OUT BOOLEAN
*Enabled
,
776 OUT BOOLEAN
*Pending
,
781 Sets the system wakeup alarm clock time.
783 @param Enabled Enable or disable the wakeup alarm.
784 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
785 If Enable is FALSE, then this parameter is optional, and may be NULL.
787 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
788 Enable is FALSE, then the wakeup alarm was disabled.
789 @retval EFI_INVALID_PARAMETER A time field is out of range.
790 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
791 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
796 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
798 IN EFI_TIME
*Time OPTIONAL
802 Loads an EFI image into memory.
804 @param BootPolicy If TRUE, indicates that the request originates from the boot
805 manager, and that the boot manager is attempting to load
806 FilePath as a boot selection. Ignored if SourceBuffer is
808 @param ParentImageHandle The caller's image handle.
809 @param DevicePath The DeviceHandle specific file path from which the image is
811 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
812 of the image to be loaded.
813 @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
814 @param ImageHandle The pointer to the returned image handle that is created when the
815 image is successfully loaded.
817 @retval EFI_SUCCESS Image was loaded into memory correctly.
818 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
819 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
820 @retval EFI_UNSUPPORTED The image type is not supported.
821 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
822 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
824 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
825 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
826 image from being loaded. NULL is returned in *ImageHandle.
827 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
828 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
829 platform policy specifies that the image should not be started.
833 (EFIAPI
*EFI_IMAGE_LOAD
)(
834 IN BOOLEAN BootPolicy
,
835 IN EFI_HANDLE ParentImageHandle
,
836 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
837 IN VOID
*SourceBuffer OPTIONAL
,
839 OUT EFI_HANDLE
*ImageHandle
843 Transfers control to a loaded image's entry point.
845 @param ImageHandle Handle of image to be started.
846 @param ExitDataSize The pointer to the size, in bytes, of ExitData.
847 @param ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
848 string, optionally followed by additional binary data.
850 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
851 has already been initialized with StartImage.
852 @return Exit code from image
857 (EFIAPI
*EFI_IMAGE_START
)(
858 IN EFI_HANDLE ImageHandle
,
859 OUT UINTN
*ExitDataSize
,
860 OUT CHAR16
**ExitData OPTIONAL
864 Terminates a loaded EFI image and returns control to boot services.
866 @param ImageHandle Handle that identifies the image. This parameter is passed to the
868 @param ExitStatus The image's exit code.
869 @param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
870 @param ExitData The pointer to a data buffer that includes a Null-terminated string,
871 optionally followed by additional binary data. The string is a
872 description that the caller may use to further indicate the reason
873 for the image's exit. ExitData is only valid if ExitStatus
874 is something other than EFI_SUCCESS. The ExitData buffer
875 must be allocated by calling AllocatePool().
877 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
878 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
879 started with LoadImage() and StartImage(), but the
880 image is not the currently executing image.
886 IN EFI_HANDLE ImageHandle
,
887 IN EFI_STATUS ExitStatus
,
888 IN UINTN ExitDataSize
,
889 IN CHAR16
*ExitData OPTIONAL
895 @param ImageHandle Handle that identifies the image to be unloaded.
897 @retval EFI_SUCCESS The image has been unloaded.
898 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
903 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
904 IN EFI_HANDLE ImageHandle
908 Terminates all boot services.
910 @param ImageHandle Handle that identifies the exiting image.
911 @param MapKey Key to the latest memory map.
913 @retval EFI_SUCCESS Boot services have been terminated.
914 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
919 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
920 IN EFI_HANDLE ImageHandle
,
925 Induces a fine-grained stall.
927 @param Microseconds The number of microseconds to stall execution.
929 @retval EFI_SUCCESS Execution was stalled at least the requested number of
936 IN UINTN Microseconds
940 Sets the system's watchdog timer.
942 @param Timeout The number of seconds to set the watchdog timer to.
943 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
944 @param DataSize The size, in bytes, of WatchdogData.
945 @param WatchdogData A data buffer that includes a Null-terminated string, optionally
946 followed by additional binary data.
948 @retval EFI_SUCCESS The timeout has been set.
949 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
950 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
951 @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
957 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
959 IN UINT64 WatchdogCode
,
961 IN CHAR16
*WatchdogData OPTIONAL
965 /// Enumeration of reset types.
969 /// Used to induce a system-wide reset. This sets all circuitry within the
970 /// system to its initial state. This type of reset is asynchronous to system
971 /// operation and operates withgout regard to cycle boundaries. EfiColdReset
972 /// is tantamount to a system power cycle.
976 /// Used to induce a system-wide initialization. The processors are set to their
977 /// initial state, and pending cycles are not corrupted. If the system does
978 /// not support this reset type, then an EfiResetCold must be performed.
982 /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3
983 /// state. If the system does not support this reset type, then when the system
984 /// is rebooted, it should exhibit the EfiResetCold attributes.
990 Resets the entire platform.
992 @param ResetType The type of reset to perform.
993 @param ResetStatus The status code for the reset.
994 @param DataSize The size, in bytes, of WatchdogData.
995 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
996 EfiResetShutdown the data buffer starts with a Null-terminated
997 string, optionally followed by additional binary data.
1002 (EFIAPI
*EFI_RESET_SYSTEM
)(
1003 IN EFI_RESET_TYPE ResetType
,
1004 IN EFI_STATUS ResetStatus
,
1006 IN VOID
*ResetData OPTIONAL
1010 Returns a monotonically increasing count for the platform.
1012 @param Count The pointer to returned value.
1014 @retval EFI_SUCCESS The next monotonic count was returned.
1015 @retval EFI_INVALID_PARAMETER Count is NULL.
1016 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1021 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1026 Returns the next high 32 bits of the platform's monotonic counter.
1028 @param HighCount The pointer to returned value.
1030 @retval EFI_SUCCESS The next high monotonic count was returned.
1031 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1032 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1037 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1038 OUT UINT32
*HighCount
1042 Computes and returns a 32-bit CRC for a data buffer.
1044 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1045 @param DataSize The number of bytes in the buffer Data.
1046 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1049 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1051 @retval EFI_INVALID_PARAMETER Data is NULL.
1052 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1053 @retval EFI_INVALID_PARAMETER DataSize is 0.
1058 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1065 Copies the contents of one buffer to another buffer.
1067 @param Destination The pointer to the destination buffer of the memory copy.
1068 @param Source The pointer to the source buffer of the memory copy.
1069 @param Length Number of bytes to copy from Source to Destination.
1074 (EFIAPI
*EFI_COPY_MEM
)(
1075 IN VOID
*Destination
,
1081 The SetMem() function fills a buffer with a specified value.
1083 @param Buffer The pointer to the buffer to fill.
1084 @param Size Number of bytes in Buffer to fill.
1085 @param Value Value to fill Buffer with.
1090 (EFIAPI
*EFI_SET_MEM
)(
1097 /// Enumeration of EFI Interface Types
1101 /// Indicates that the supplied protocol interface is supplied in native form.
1103 EFI_NATIVE_INTERFACE
1104 } EFI_INTERFACE_TYPE
;
1107 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1108 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1109 more error checking than InstallProtocolInterface(), so it is recommended that
1110 InstallMultipleProtocolInterfaces() be used in place of
1111 InstallProtocolInterface()
1113 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1114 @param Protocol The numeric ID of the protocol interface.
1115 @param InterfaceType Indicates whether Interface is supplied in native form.
1116 @param Interface A pointer to the protocol interface.
1118 @retval EFI_SUCCESS The protocol interface was installed.
1119 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1120 @retval EFI_INVALID_PARAMETER Handle is NULL.
1121 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1122 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1123 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1128 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1129 IN OUT EFI_HANDLE
*Handle
,
1130 IN EFI_GUID
*Protocol
,
1131 IN EFI_INTERFACE_TYPE InterfaceType
,
1136 Installs one or more protocol interfaces into the boot services environment.
1138 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1139 handle is to be allocated.
1140 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1143 @retval EFI_SUCCESS All the protocol interface was installed.
1144 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1145 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1146 the handle database.
1151 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1152 IN OUT EFI_HANDLE
*Handle
,
1157 Reinstalls a protocol interface on a device handle.
1159 @param Handle Handle on which the interface is to be reinstalled.
1160 @param Protocol The numeric ID of the interface.
1161 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1162 associated with Protocol.
1163 @param NewInterface A pointer to the new interface.
1165 @retval EFI_SUCCESS The protocol interface was reinstalled.
1166 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1167 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1168 because OldInterface is still being used by a
1169 driver that will not release it.
1170 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1171 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1176 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1177 IN EFI_HANDLE Handle
,
1178 IN EFI_GUID
*Protocol
,
1179 IN VOID
*OldInterface
,
1180 IN VOID
*NewInterface
1184 Removes a protocol interface from a device handle. It is recommended that
1185 UninstallMultipleProtocolInterfaces() be used in place of
1186 UninstallProtocolInterface().
1188 @param Handle The handle on which the interface was installed.
1189 @param Protocol The numeric ID of the interface.
1190 @param Interface A pointer to the interface.
1192 @retval EFI_SUCCESS The interface was removed.
1193 @retval EFI_NOT_FOUND The interface was not found.
1194 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1195 is still being used by a driver.
1196 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1197 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1202 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1203 IN EFI_HANDLE Handle
,
1204 IN EFI_GUID
*Protocol
,
1209 Removes one or more protocol interfaces into the boot services environment.
1211 @param Handle The handle to remove the protocol interfaces from.
1212 @param ... A variable argument list containing pairs of protocol GUIDs and
1213 protocol interfaces.
1215 @retval EFI_SUCCESS All the protocol interfaces were removed.
1216 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1221 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1222 IN EFI_HANDLE Handle
,
1227 Queries a handle to determine if it supports a specified protocol.
1229 @param Handle The handle being queried.
1230 @param Protocol The published unique identifier of the protocol.
1231 @param Interface Supplies the address where a pointer to the corresponding Protocol
1232 Interface is returned.
1234 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1235 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1236 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1237 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1238 @retval EFI_INVALID_PARAMETER Interface is NULL.
1243 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1244 IN EFI_HANDLE Handle
,
1245 IN EFI_GUID
*Protocol
,
1246 OUT VOID
**Interface
1249 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1250 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1251 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1252 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1253 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1254 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1257 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1258 handle, it opens the protocol on behalf of the calling agent.
1260 @param Handle The handle for the protocol interface that is being opened.
1261 @param Protocol The published unique identifier of the protocol.
1262 @param Interface Supplies the address where a pointer to the corresponding Protocol
1263 Interface is returned.
1264 @param AgentHandle The handle of the agent that is opening the protocol interface
1265 specified by Protocol and Interface.
1266 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1267 UEFI Driver Model, then this parameter is the controller handle
1268 that requires the protocol interface. If the agent does not follow
1269 the UEFI Driver Model, then this parameter is optional and may
1271 @param Attributes The open mode of the protocol interface specified by Handle
1274 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1275 protocol interface was returned in Interface.
1276 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1277 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1278 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1279 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1280 handle is the same as AgentHandle.
1285 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1286 IN EFI_HANDLE Handle
,
1287 IN EFI_GUID
*Protocol
,
1288 OUT VOID
**Interface
, OPTIONAL
1289 IN EFI_HANDLE AgentHandle
,
1290 IN EFI_HANDLE ControllerHandle
,
1291 IN UINT32 Attributes
1296 Closes a protocol on a handle that was opened using OpenProtocol().
1298 @param Handle The handle for the protocol interface that was previously opened
1299 with OpenProtocol(), and is now being closed.
1300 @param Protocol The published unique identifier of the protocol.
1301 @param AgentHandle The handle of the agent that is closing the protocol interface.
1302 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1303 UEFI Driver Model, then this parameter is the controller handle
1304 that required the protocol interface.
1306 @retval EFI_SUCCESS The protocol instance was closed.
1307 @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.
1308 2) AgentHandle is not a valid EFI_HANDLE.
1309 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1310 4) Protocol is NULL.
1311 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1312 2) The protocol interface specified by Handle and Protocol is not
1313 currently open by AgentHandle and ControllerHandle.
1318 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1319 IN EFI_HANDLE Handle
,
1320 IN EFI_GUID
*Protocol
,
1321 IN EFI_HANDLE AgentHandle
,
1322 IN EFI_HANDLE ControllerHandle
1326 /// EFI Oprn Protocol Information Entry
1329 EFI_HANDLE AgentHandle
;
1330 EFI_HANDLE ControllerHandle
;
1333 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1336 Retrieves the list of agents that currently have a protocol interface opened.
1338 @param Handle The handle for the protocol interface that is being queried.
1339 @param Protocol The published unique identifier of the protocol.
1340 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1341 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1342 @param EntryCount A pointer to the number of entries in EntryBuffer.
1344 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1345 number of entries was returned EntryCount.
1346 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1347 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1352 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1353 IN EFI_HANDLE Handle
,
1354 IN EFI_GUID
*Protocol
,
1355 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1356 OUT UINTN
*EntryCount
1360 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1363 @param Handle The handle from which to retrieve the list of protocol interface
1365 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1366 installed on Handle.
1367 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1370 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1371 ProtocolBuffer. The number of protocol interface GUIDs was
1372 returned in ProtocolBufferCount.
1373 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1374 @retval EFI_INVALID_PARAMETER Handle is NULL.
1375 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1376 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1377 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1382 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1383 IN EFI_HANDLE Handle
,
1384 OUT EFI_GUID
***ProtocolBuffer
,
1385 OUT UINTN
*ProtocolBufferCount
1389 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1391 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1392 @param Event Event that is to be signaled whenever a protocol interface is registered
1394 @param Registration A pointer to a memory location to receive the registration value.
1396 @retval EFI_SUCCESS The notification event has been registered.
1397 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1398 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1399 @retval EFI_INVALID_PARAMETER Event is NULL.
1400 @retval EFI_INVALID_PARAMETER Registration is NULL.
1405 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1406 IN EFI_GUID
*Protocol
,
1408 OUT VOID
**Registration
1412 /// Enumeration of EFI Locate Search Types
1416 /// Retrieve all the handles in the handle database.
1420 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1424 /// Retrieve the set of handles from the handle database that support a
1425 /// specified protocol.
1428 } EFI_LOCATE_SEARCH_TYPE
;
1431 Returns an array of handles that support a specified protocol.
1433 @param SearchType Specifies which handle(s) are to be returned.
1434 @param Protocol Specifies the protocol to search by.
1435 @param SearchKey Specifies the search key.
1436 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1437 the array returned in Buffer (if the buffer was large enough) or the
1438 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1440 @param Buffer The buffer in which the array is returned.
1442 @retval EFI_SUCCESS The array of handles was returned.
1443 @retval EFI_NOT_FOUND No handles match the search.
1444 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1445 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1446 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1447 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1448 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1449 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1454 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1455 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1456 IN EFI_GUID
*Protocol
, OPTIONAL
1457 IN VOID
*SearchKey
, OPTIONAL
1458 IN OUT UINTN
*BufferSize
,
1459 OUT EFI_HANDLE
*Buffer
1463 Locates the handle to a device on the device path that supports the specified protocol.
1465 @param Protocol Specifies the protocol to search for.
1466 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1467 path pointer is modified to point to the remaining part of the device
1469 @param Device A pointer to the returned device handle.
1471 @retval EFI_SUCCESS The resulting handle was returned.
1472 @retval EFI_NOT_FOUND No handles match the search.
1473 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1474 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1475 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1480 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1481 IN EFI_GUID
*Protocol
,
1482 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1483 OUT EFI_HANDLE
*Device
1487 Adds, updates, or removes a configuration table entry from the EFI System Table.
1489 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1490 @param Table A pointer to the configuration table for the entry to add, update, or
1491 remove. May be NULL.
1493 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1494 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1495 @retval EFI_INVALID_PARAMETER Guid is NULL.
1496 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1501 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1507 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1509 @param SearchType Specifies which handle(s) are to be returned.
1510 @param Protocol Provides the protocol to search by.
1511 This parameter is only valid for a SearchType of ByProtocol.
1512 @param SearchKey Supplies the search key depending on the SearchType.
1513 @param NoHandles The number of handles returned in Buffer.
1514 @param Buffer A pointer to the buffer to return the requested array of handles that
1517 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1518 handles in Buffer was returned in NoHandles.
1519 @retval EFI_NOT_FOUND No handles match the search.
1520 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1521 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1522 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1527 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1528 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1529 IN EFI_GUID
*Protocol
, OPTIONAL
1530 IN VOID
*SearchKey
, OPTIONAL
1531 IN OUT UINTN
*NoHandles
,
1532 OUT EFI_HANDLE
**Buffer
1536 Returns the first protocol instance that matches the given protocol.
1538 @param Protocol Provides the protocol to search for.
1539 @param Registration Optional registration key returned from
1540 RegisterProtocolNotify().
1541 @param Interface On return, a pointer to the first interface that matches Protocol and
1544 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1546 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1548 @retval EFI_INVALID_PARAMETER Interface is NULL.
1553 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1554 IN EFI_GUID
*Protocol
,
1555 IN VOID
*Registration
, OPTIONAL
1556 OUT VOID
**Interface
1560 /// EFI Capsule Block Descriptor
1564 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1569 /// Physical address of the data block. This member of the union is
1570 /// used if Length is not equal to zero.
1572 EFI_PHYSICAL_ADDRESS DataBlock
;
1574 /// Physical address of another block of
1575 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1576 /// member of the union is used if Length is equal to zero. If
1577 /// ContinuationPointer is zero this entry represents the end of the list.
1579 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1581 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1584 /// EFI Capsule Header.
1588 /// A GUID that defines the contents of a capsule.
1590 EFI_GUID CapsuleGuid
;
1592 /// The size of the capsule header. This may be larger than the size of
1593 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1594 /// extended header entries
1598 /// Bit-mapped list describing the capsule attributes. The Flag values
1599 /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
1600 /// of 0x10000 - 0xFFFFFFFF are defined by this specification
1604 /// Size in bytes of the capsule.
1606 UINT32 CapsuleImageSize
;
1607 } EFI_CAPSULE_HEADER
;
1610 /// The EFI System Table entry must point to an array of capsules
1611 /// that contain the same CapsuleGuid value. The array must be
1612 /// prefixed by a UINT32 that represents the size of the array of capsules.
1616 /// the size of the array of capsules.
1618 UINT32 CapsuleArrayNumber
;
1620 /// Point to an array of capsules that contain the same CapsuleGuid value.
1622 VOID
* CapsulePtr
[1];
1623 } EFI_CAPSULE_TABLE
;
1625 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1626 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1627 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
1630 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1631 consumption, the firmware may process the capsule immediately. If the payload should persist
1632 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1633 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1634 part of the reset process.
1636 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1637 being passed into update capsule.
1638 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1640 @param ScatterGatherList Physical pointer to a set of
1641 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1642 location in physical memory of a set of capsules.
1644 @retval EFI_SUCCESS Valid capsule was passed. If
1645 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1646 capsule has been successfully processed by the firmware.
1647 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
1648 set in the capsule header.
1649 @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
1650 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1651 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1652 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
1657 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1658 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1659 IN UINTN CapsuleCount
,
1660 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1664 Returns if the capsule can be supported via UpdateCapsule().
1666 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1667 being passed into update capsule.
1668 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1670 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1671 support as an argument to UpdateCapsule() via
1672 CapsuleHeaderArray and ScatterGatherList.
1673 @param ResetType Returns the type of reset required for the capsule update.
1675 @retval EFI_SUCCESS Valid answer returned.
1676 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1677 MaximumCapsuleSize and ResetType are undefined.
1678 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1679 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
1684 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1685 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1686 IN UINTN CapsuleCount
,
1687 OUT UINT64
*MaximumCapsuleSize
,
1688 OUT EFI_RESET_TYPE
*ResetType
1692 Returns information about the EFI variables.
1694 @param Attributes Attributes bitmask to specify the type of variables on
1695 which to return information.
1696 @param MaximumVariableStorageSize On output the maximum size of the storage space
1697 available for the EFI variables associated with the
1698 attributes specified.
1699 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1700 available for the EFI variables associated with the
1701 attributes specified.
1702 @param MaximumVariableSize Returns the maximum size of the individual EFI
1703 variables associated with the attributes specified.
1705 @retval EFI_SUCCESS Valid answer returned.
1706 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1707 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1708 MaximumVariableStorageSize,
1709 RemainingVariableStorageSize, MaximumVariableSize
1715 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1716 IN UINT32 Attributes
,
1717 OUT UINT64
*MaximumVariableStorageSize
,
1718 OUT UINT64
*RemainingVariableStorageSize
,
1719 OUT UINT64
*MaximumVariableSize
1724 // EFI Runtime Services Table
1726 #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1727 #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))
1728 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
1729 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
1730 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1731 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1732 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1733 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1734 #define EFI_SYSTEM_TABLE_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
1736 #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1737 #define EFI_RUNTIME_SERVICES_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
1740 /// EFI Runtime Services Table.
1744 /// The table header for the EFI Runtime Services Table.
1746 EFI_TABLE_HEADER Hdr
;
1751 EFI_GET_TIME GetTime
;
1752 EFI_SET_TIME SetTime
;
1753 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1754 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1757 // Virtual Memory Services
1759 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1760 EFI_CONVERT_POINTER ConvertPointer
;
1763 // Variable Services
1765 EFI_GET_VARIABLE GetVariable
;
1766 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1767 EFI_SET_VARIABLE SetVariable
;
1770 // Miscellaneous Services
1772 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1773 EFI_RESET_SYSTEM ResetSystem
;
1776 // UEFI 2.0 Capsule Services
1778 EFI_UPDATE_CAPSULE UpdateCapsule
;
1779 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1782 // Miscellaneous UEFI 2.0 Service
1784 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1785 } EFI_RUNTIME_SERVICES
;
1788 #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1789 #define EFI_BOOT_SERVICES_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
1792 /// EFI Boot Services Table.
1796 /// The table header for the EFI Boot Services Table.
1798 EFI_TABLE_HEADER Hdr
;
1801 // Task Priority Services
1803 EFI_RAISE_TPL RaiseTPL
;
1804 EFI_RESTORE_TPL RestoreTPL
;
1809 EFI_ALLOCATE_PAGES AllocatePages
;
1810 EFI_FREE_PAGES FreePages
;
1811 EFI_GET_MEMORY_MAP GetMemoryMap
;
1812 EFI_ALLOCATE_POOL AllocatePool
;
1813 EFI_FREE_POOL FreePool
;
1816 // Event & Timer Services
1818 EFI_CREATE_EVENT CreateEvent
;
1819 EFI_SET_TIMER SetTimer
;
1820 EFI_WAIT_FOR_EVENT WaitForEvent
;
1821 EFI_SIGNAL_EVENT SignalEvent
;
1822 EFI_CLOSE_EVENT CloseEvent
;
1823 EFI_CHECK_EVENT CheckEvent
;
1826 // Protocol Handler Services
1828 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1829 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1830 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1831 EFI_HANDLE_PROTOCOL HandleProtocol
;
1833 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1834 EFI_LOCATE_HANDLE LocateHandle
;
1835 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1836 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1841 EFI_IMAGE_LOAD LoadImage
;
1842 EFI_IMAGE_START StartImage
;
1844 EFI_IMAGE_UNLOAD UnloadImage
;
1845 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1848 // Miscellaneous Services
1850 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1852 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1855 // DriverSupport Services
1857 EFI_CONNECT_CONTROLLER ConnectController
;
1858 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1861 // Open and Close Protocol Services
1863 EFI_OPEN_PROTOCOL OpenProtocol
;
1864 EFI_CLOSE_PROTOCOL CloseProtocol
;
1865 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1870 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1871 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1872 EFI_LOCATE_PROTOCOL LocateProtocol
;
1873 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1874 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1877 // 32-bit CRC Services
1879 EFI_CALCULATE_CRC32 CalculateCrc32
;
1882 // Miscellaneous Services
1884 EFI_COPY_MEM CopyMem
;
1886 EFI_CREATE_EVENT_EX CreateEventEx
;
1887 } EFI_BOOT_SERVICES
;
1890 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1891 /// EFI System Table.
1895 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1897 EFI_GUID VendorGuid
;
1899 /// A pointer to the table associated with VendorGuid.
1902 } EFI_CONFIGURATION_TABLE
;
1905 /// EFI System Table
1909 /// The table header for the EFI System Table.
1911 EFI_TABLE_HEADER Hdr
;
1913 /// A pointer to a null terminated string that identifies the vendor
1914 /// that produces the system firmware for the platform.
1916 CHAR16
*FirmwareVendor
;
1918 /// A firmware vendor specific value that identifies the revision
1919 /// of the system firmware for the platform.
1921 UINT32 FirmwareRevision
;
1923 /// The handle for the active console input device. This handle must support
1924 /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
1926 EFI_HANDLE ConsoleInHandle
;
1928 /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
1929 /// associated with ConsoleInHandle.
1931 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1933 /// The handle for the active console output device.
1935 EFI_HANDLE ConsoleOutHandle
;
1937 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1938 /// that is associated with ConsoleOutHandle.
1940 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1942 /// The handle for the active standard error console device.
1943 /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
1945 EFI_HANDLE StandardErrorHandle
;
1947 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1948 /// that is associated with StandardErrorHandle.
1950 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
1952 /// A pointer to the EFI Runtime Services Table.
1954 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1956 /// A pointer to the EFI Boot Services Table.
1958 EFI_BOOT_SERVICES
*BootServices
;
1960 /// The number of system configuration tables in the buffer ConfigurationTable.
1962 UINTN NumberOfTableEntries
;
1964 /// A pointer to the system configuration tables.
1965 /// The number of entries in the table is NumberOfTableEntries.
1967 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
1971 This is the declaration of an EFI image entry point. This entry point is
1972 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
1973 both device drivers and bus drivers.
1975 @param ImageHandle The firmware allocated handle for the UEFI image.
1976 @param SystemTable A pointer to the EFI System Table.
1978 @retval EFI_SUCCESS The operation completed successfully.
1979 @retval Others An unexpected error occurred.
1983 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
1984 IN EFI_HANDLE ImageHandle
,
1985 IN EFI_SYSTEM_TABLE
*SystemTable
1989 // EFI Load Options Attributes
1991 #define LOAD_OPTION_ACTIVE 0x00000001
1992 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1993 #define LOAD_OPTION_HIDDEN 0x00000008
1994 #define LOAD_OPTION_CATEGORY 0x00001F00
1996 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1997 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1999 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
2000 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
2001 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
2004 /// EFI Boot Key Data
2009 /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
2011 UINT32 Revision
: 8;
2013 /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
2015 UINT32 ShiftPressed
: 1;
2017 /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
2019 UINT32 ControlPressed
: 1;
2021 /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
2023 UINT32 AltPressed
: 1;
2025 /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
2027 UINT32 LogoPressed
: 1;
2029 /// The Menu key must be pressed (1) or must not be pressed (0).
2031 UINT32 MenuPressed
: 1;
2033 /// The SysReq key must be pressed (1) or must not be pressed (0).
2035 UINT32 SysReqPressed
: 1;
2036 UINT32 Reserved
: 16;
2038 /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
2039 /// zero, then only the shift state is considered. If more than one, then the boot option will
2040 /// only be launched if all of the specified keys are pressed with the same shift state.
2042 UINT32 InputKeyCount
: 2;
2045 } EFI_BOOT_KEY_DATA
;
2052 /// Specifies options about how the key will be processed.
2054 EFI_BOOT_KEY_DATA KeyData
;
2056 /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
2057 /// which BootOption refers. If the CRC-32s do not match this value, then this key
2058 /// option is ignored.
2060 UINT32 BootOptionCrc
;
2062 /// The Boot#### option which will be invoked if this key is pressed and the boot option
2063 /// is active (LOAD_OPTION_ACTIVE is set).
2067 /// The key codes to compare against those returned by the
2068 /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
2069 /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
2071 //EFI_INPUT_KEY Keys[];
2075 // EFI File location to boot from on removable media devices
2077 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2078 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2079 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2080 #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"
2082 #if defined (MDE_CPU_IA32)
2083 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2084 #elif defined (MDE_CPU_IPF)
2085 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2086 #elif defined (MDE_CPU_X64)
2087 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2088 #elif defined (MDE_CPU_EBC)
2089 #elif defined (MDE_CPU_ARM)
2090 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM
2092 #error Unknown Processor Type
2095 #include <Uefi/UefiPxe.h>
2096 #include <Uefi/UefiGpt.h>
2097 #include <Uefi/UefiInternalFormRepresentation.h>