2 Include file that supports UEFI.
4 This include file must contain things defined in the UEFI 2.4 specification.
5 If a code construct is defined in the UEFI 2.4 specification it must be included
8 Copyright (c) 2006 - 2015, 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 // Physical memory persistence attribute.
79 // The memory region supports byte-addressable non-volatility.
81 #define EFI_MEMORY_NV 0x0000000000008000ULL
83 // Runtime memory attribute
85 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
88 /// Memory descriptor version number.
90 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
93 /// Definition of an EFI memory descriptor.
97 /// Type of the memory region. See EFI_MEMORY_TYPE.
101 /// Physical address of the first byte of the memory region. Must aligned
102 /// on a 4 KB boundary.
104 EFI_PHYSICAL_ADDRESS PhysicalStart
;
106 /// Virtual address of the first byte of the memory region. Must aligned
107 /// on a 4 KB boundary.
109 EFI_VIRTUAL_ADDRESS VirtualStart
;
111 /// Number of 4KB pages in the memory region.
113 UINT64 NumberOfPages
;
115 /// Attributes of the memory region that describe the bit mask of capabilities
116 /// for that memory region, and not necessarily the current settings for that
120 } EFI_MEMORY_DESCRIPTOR
;
123 Allocates memory pages from the system.
125 @param[in] Type The type of allocation to perform.
126 @param[in] MemoryType The type of memory to allocate.
127 @param[in] Pages The number of contiguous 4 KB pages to allocate.
128 @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is
129 used depends on the value of Type.
131 @retval EFI_SUCCESS The requested pages were allocated.
132 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
133 AllocateMaxAddress or AllocateAddress.
134 2) MemoryType is in the range
136 4) MemoryType was EfiPersistentMemory.
137 EfiMaxMemoryType..0x7FFFFFFF.
138 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
139 @retval EFI_NOT_FOUND The requested pages could not be found.
144 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
145 IN EFI_ALLOCATE_TYPE Type
,
146 IN EFI_MEMORY_TYPE MemoryType
,
148 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
154 @param[in] Memory The base physical address of the pages to be freed.
155 @param[in] Pages The number of contiguous 4 KB pages to free.
157 @retval EFI_SUCCESS The requested pages were freed.
158 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
159 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
165 (EFIAPI
*EFI_FREE_PAGES
)(
166 IN EFI_PHYSICAL_ADDRESS Memory
,
171 Returns the current memory map.
173 @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
174 On input, this is the size of the buffer allocated by the caller.
175 On output, it is the size of the buffer returned by the firmware if
176 the buffer was large enough, or the size of the buffer needed to contain
177 the map if the buffer was too small.
178 @param[in, out] MemoryMap A pointer to the buffer in which firmware places the current memory
180 @param[out] MapKey A pointer to the location in which firmware returns the key for the
182 @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
183 an individual EFI_MEMORY_DESCRIPTOR.
184 @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number
185 associated with the EFI_MEMORY_DESCRIPTOR.
187 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
188 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
189 needed to hold the memory map is returned in MemoryMapSize.
190 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
191 2) The MemoryMap buffer is not too small and MemoryMap is
197 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
198 IN OUT UINTN
*MemoryMapSize
,
199 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
201 OUT UINTN
*DescriptorSize
,
202 OUT UINT32
*DescriptorVersion
206 Allocates pool memory.
208 @param[in] PoolType The type of pool to allocate.
209 @param[in] Size The number of bytes to allocate from the pool.
210 @param[out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
213 @retval EFI_SUCCESS The requested number of bytes was allocated.
214 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
215 @retval EFI_INVALID_PARAMETER PoolType was invalid or Buffer is NULL.
216 PoolType was EfiPersistentMemory.
221 (EFIAPI
*EFI_ALLOCATE_POOL
)(
222 IN EFI_MEMORY_TYPE PoolType
,
228 Returns pool memory to the system.
230 @param[in] Buffer The pointer to the buffer to free.
232 @retval EFI_SUCCESS The memory was returned to the system.
233 @retval EFI_INVALID_PARAMETER Buffer was invalid.
238 (EFIAPI
*EFI_FREE_POOL
)(
243 Changes the runtime addressing mode of EFI firmware from physical to virtual.
245 @param[in] MemoryMapSize The size in bytes of VirtualMap.
246 @param[in] DescriptorSize The size in bytes of an entry in the VirtualMap.
247 @param[in] DescriptorVersion The version of the structure entries in VirtualMap.
248 @param[in] VirtualMap An array of memory descriptors which contain new virtual
249 address mapping information for all runtime ranges.
251 @retval EFI_SUCCESS The virtual address map has been applied.
252 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
253 virtual address mapped mode.
254 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
255 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
256 map that requires a mapping.
257 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
263 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
264 IN UINTN MemoryMapSize
,
265 IN UINTN DescriptorSize
,
266 IN UINT32 DescriptorVersion
,
267 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
271 Connects one or more drivers to a controller.
273 @param[in] ControllerHandle The handle of the controller to which driver(s) are to be connected.
274 @param[in] DriverImageHandle A pointer to an ordered list handles that support the
275 EFI_DRIVER_BINDING_PROTOCOL.
276 @param[in] RemainingDevicePath A pointer to the device path that specifies a child of the
277 controller specified by ControllerHandle.
278 @param[in] Recursive If TRUE, then ConnectController() is called recursively
279 until the entire tree of controllers below the controller specified
280 by ControllerHandle have been created. If FALSE, then
281 the tree of controllers is only expanded one level.
283 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
284 2) No drivers were connected to ControllerHandle, but
285 RemainingDevicePath is not NULL, and it is an End Device
287 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
288 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
289 present in the system.
290 2) No drivers were connected to ControllerHandle.
291 @retval EFI_SECURITY_VIOLATION
292 The user has no permission to start UEFI device drivers on the device path
293 associated with the ControllerHandle or specified by the RemainingDevicePath.
297 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
298 IN EFI_HANDLE ControllerHandle
,
299 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
300 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
305 Disconnects one or more drivers from a controller.
307 @param[in] ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
308 @param[in] DriverImageHandle The driver to disconnect from ControllerHandle.
309 If DriverImageHandle is NULL, then all the drivers currently managing
310 ControllerHandle are disconnected from ControllerHandle.
311 @param[in] ChildHandle The handle of the child to destroy.
312 If ChildHandle is NULL, then all the children of ControllerHandle are
313 destroyed before the drivers are disconnected from ControllerHandle.
315 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
316 2) On entry, no drivers are managing ControllerHandle.
317 3) DriverImageHandle is not NULL, and on entry
318 DriverImageHandle is not managing ControllerHandle.
319 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
320 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
321 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
322 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
323 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
325 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
330 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
331 IN EFI_HANDLE ControllerHandle
,
332 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
333 IN EFI_HANDLE ChildHandle OPTIONAL
339 // ConvertPointer DebugDisposition type.
341 #define EFI_OPTIONAL_PTR 0x00000001
344 Determines the new virtual address that is to be used on subsequent memory accesses.
346 @param[in] DebugDisposition Supplies type information for the pointer being converted.
347 @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed
348 for the new virtual address mappings being applied.
350 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
351 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
352 2) *Address is NULL and DebugDisposition does
353 not have the EFI_OPTIONAL_PTR bit set.
354 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
355 of the current memory map. This is normally fatal.
360 (EFIAPI
*EFI_CONVERT_POINTER
)(
361 IN UINTN DebugDisposition
,
362 IN OUT VOID
**Address
367 // These types can be ORed together as needed - for example,
368 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
369 // EVT_NOTIFY_SIGNAL.
371 #define EVT_TIMER 0x80000000
372 #define EVT_RUNTIME 0x40000000
373 #define EVT_NOTIFY_WAIT 0x00000100
374 #define EVT_NOTIFY_SIGNAL 0x00000200
376 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
377 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
380 // The event's NotifyContext pointer points to a runtime memory
382 // The event is deprecated in UEFI2.0 and later specifications.
384 #define EVT_RUNTIME_CONTEXT 0x20000000
388 Invoke a notification event
390 @param[in] Event Event whose notification function is being invoked.
391 @param[in] Context The pointer to the notification function's context,
392 which is implementation-dependent.
397 (EFIAPI
*EFI_EVENT_NOTIFY
)(
405 @param[in] Type The type of event to create and its mode and attributes.
406 @param[in] NotifyTpl The task priority level of event notifications, if needed.
407 @param[in] NotifyFunction The pointer to the event's notification function, if any.
408 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
409 Context in the notification function.
410 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
413 @retval EFI_SUCCESS The event structure was created.
414 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
415 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
420 (EFIAPI
*EFI_CREATE_EVENT
)(
422 IN EFI_TPL NotifyTpl
,
423 IN EFI_EVENT_NOTIFY NotifyFunction
,
424 IN VOID
*NotifyContext
,
429 Creates an event in a group.
431 @param[in] Type The type of event to create and its mode and attributes.
432 @param[in] NotifyTpl The task priority level of event notifications,if needed.
433 @param[in] NotifyFunction The pointer to the event's notification function, if any.
434 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
435 Context in the notification function.
436 @param[in] EventGroup The pointer to the unique identifier of the group to which this event belongs.
437 If this is NULL, then the function behaves as if the parameters were passed
439 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
442 @retval EFI_SUCCESS The event structure was created.
443 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
444 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
449 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
451 IN EFI_TPL NotifyTpl
,
452 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
453 IN CONST VOID
*NotifyContext OPTIONAL
,
454 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
459 /// Timer delay types
463 /// An event's timer settings is to be cancelled and not trigger time is to be set/
467 /// An event is to be signaled periodically at a specified interval from the current time.
471 /// An event is to be signaled once at a specified interval from the current time.
477 Sets the type of timer and the trigger time for a timer event.
479 @param[in] Event The timer event that is to be signaled at the specified time.
480 @param[in] Type The type of time that is specified in TriggerTime.
481 @param[in] TriggerTime The number of 100ns units until the timer expires.
482 A TriggerTime of 0 is legal.
483 If Type is TimerRelative and TriggerTime is 0, then the timer
484 event will be signaled on the next timer tick.
485 If Type is TimerPeriodic and TriggerTime is 0, then the timer
486 event will be signaled on every timer tick.
488 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
489 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
494 (EFIAPI
*EFI_SET_TIMER
)(
496 IN EFI_TIMER_DELAY Type
,
497 IN UINT64 TriggerTime
503 @param[in] Event The event to signal.
505 @retval EFI_SUCCESS The event has been signaled.
510 (EFIAPI
*EFI_SIGNAL_EVENT
)(
515 Stops execution until an event is signaled.
517 @param[in] NumberOfEvents The number of events in the Event array.
518 @param[in] Event An array of EFI_EVENT.
519 @param[out] Index The pointer to the index of the event which satisfied the wait condition.
521 @retval EFI_SUCCESS The event indicated by Index was signaled.
522 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
523 2) The event indicated by Index is of type
525 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
530 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
531 IN UINTN NumberOfEvents
,
539 @param[in] Event The event to close.
541 @retval EFI_SUCCESS The event has been closed.
546 (EFIAPI
*EFI_CLOSE_EVENT
)(
551 Checks whether an event is in the signaled state.
553 @param[in] Event The event to check.
555 @retval EFI_SUCCESS The event is in the signaled state.
556 @retval EFI_NOT_READY The event is not in the signaled state.
557 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
562 (EFIAPI
*EFI_CHECK_EVENT
)(
568 // Task priority level
570 #define TPL_APPLICATION 4
571 #define TPL_CALLBACK 8
572 #define TPL_NOTIFY 16
573 #define TPL_HIGH_LEVEL 31
577 Raises a task's priority level and returns its previous level.
579 @param[in] NewTpl The new task priority level.
581 @return Previous task priority level
586 (EFIAPI
*EFI_RAISE_TPL
)(
591 Restores a task's priority level to its previous value.
593 @param[in] OldTpl The previous task priority level to restore.
598 (EFIAPI
*EFI_RESTORE_TPL
)(
603 Returns the value of a variable.
605 @param[in] VariableName A Null-terminated string that is the name of the vendor's
607 @param[in] VendorGuid A unique identifier for the vendor.
608 @param[out] Attributes If not NULL, a pointer to the memory location to return the
609 attributes bitmask for the variable.
610 @param[in, out] DataSize On input, the size in bytes of the return Data buffer.
611 On output the size of data returned in Data.
612 @param[out] Data The buffer to return the contents of the variable.
614 @retval EFI_SUCCESS The function completed successfully.
615 @retval EFI_NOT_FOUND The variable was not found.
616 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
617 @retval EFI_INVALID_PARAMETER VariableName is NULL.
618 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
619 @retval EFI_INVALID_PARAMETER DataSize is NULL.
620 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
621 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
622 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
627 (EFIAPI
*EFI_GET_VARIABLE
)(
628 IN CHAR16
*VariableName
,
629 IN EFI_GUID
*VendorGuid
,
630 OUT UINT32
*Attributes
, OPTIONAL
631 IN OUT UINTN
*DataSize
,
636 Enumerates the current variable names.
638 @param[in, out] VariableNameSize The size of the VariableName buffer.
639 @param[in, out] VariableName On input, supplies the last VariableName that was returned
640 by GetNextVariableName(). On output, returns the Nullterminated
641 string of the current variable.
642 @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by
643 GetNextVariableName(). On output, returns the
644 VendorGuid of the current variable.
646 @retval EFI_SUCCESS The function completed successfully.
647 @retval EFI_NOT_FOUND The next variable was not found.
648 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
649 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
650 @retval EFI_INVALID_PARAMETER VariableName is NULL.
651 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
652 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
657 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
658 IN OUT UINTN
*VariableNameSize
,
659 IN OUT CHAR16
*VariableName
,
660 IN OUT EFI_GUID
*VendorGuid
664 Sets the value of a variable.
666 @param[in] VariableName A Null-terminated string that is the name of the vendor's variable.
667 Each VariableName is unique for each VendorGuid. VariableName must
668 contain 1 or more characters. If VariableName is an empty string,
669 then EFI_INVALID_PARAMETER is returned.
670 @param[in] VendorGuid A unique identifier for the vendor.
671 @param[in] Attributes Attributes bitmask to set for the variable.
672 @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
673 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
674 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
675 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
676 set, then a SetVariable() call with a DataSize of zero will not cause any change to
677 the variable value (the timestamp associated with the variable may be updated however
678 even if no new data value is provided,see the description of the
679 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
680 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
681 @param[in] Data The contents for the variable.
683 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
684 defined by the Attributes.
685 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
686 DataSize exceeds the maximum allowed.
687 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
688 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
689 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
690 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
691 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
692 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
693 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
694 does NOT pass the validation check carried out by the firmware.
696 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
701 (EFIAPI
*EFI_SET_VARIABLE
)(
702 IN CHAR16
*VariableName
,
703 IN EFI_GUID
*VendorGuid
,
704 IN UINT32 Attributes
,
711 /// This provides the capabilities of the
712 /// real time clock device as exposed through the EFI interfaces.
716 /// Provides the reporting resolution of the real-time clock device in
717 /// counts per second. For a normal PC-AT CMOS RTC device, this
718 /// value would be 1 Hz, or 1, to indicate that the device only reports
719 /// the time to the resolution of 1 second.
723 /// Provides the timekeeping accuracy of the real-time clock in an
724 /// error rate of 1E-6 parts per million. For a clock with an accuracy
725 /// of 50 parts per million, the value in this field would be
730 /// A TRUE indicates that a time set operation clears the device's
731 /// time below the Resolution reporting level. A FALSE
732 /// indicates that the state below the Resolution level of the
733 /// device is not cleared when the time is set. Normal PC-AT CMOS
734 /// RTC devices set this value to FALSE.
737 } EFI_TIME_CAPABILITIES
;
740 Returns the current time and date information, and the time-keeping capabilities
741 of the hardware platform.
743 @param[out] Time A pointer to storage to receive a snapshot of the current time.
744 @param[out] Capabilities An optional pointer to a buffer to receive the real time clock
745 device's capabilities.
747 @retval EFI_SUCCESS The operation completed successfully.
748 @retval EFI_INVALID_PARAMETER Time is NULL.
749 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
754 (EFIAPI
*EFI_GET_TIME
)(
756 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
760 Sets the current local time and date information.
762 @param[in] Time A pointer to the current time.
764 @retval EFI_SUCCESS The operation completed successfully.
765 @retval EFI_INVALID_PARAMETER A time field is out of range.
766 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
771 (EFIAPI
*EFI_SET_TIME
)(
776 Returns the current wakeup alarm clock setting.
778 @param[out] Enabled Indicates if the alarm is currently enabled or disabled.
779 @param[out] Pending Indicates if the alarm signal is pending and requires acknowledgement.
780 @param[out] Time The current alarm setting.
782 @retval EFI_SUCCESS The alarm settings were returned.
783 @retval EFI_INVALID_PARAMETER Enabled is NULL.
784 @retval EFI_INVALID_PARAMETER Pending is NULL.
785 @retval EFI_INVALID_PARAMETER Time is NULL.
786 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
787 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
792 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
793 OUT BOOLEAN
*Enabled
,
794 OUT BOOLEAN
*Pending
,
799 Sets the system wakeup alarm clock time.
801 @param[in] Enable Enable or disable the wakeup alarm.
802 @param[in] Time If Enable is TRUE, the time to set the wakeup alarm for.
803 If Enable is FALSE, then this parameter is optional, and may be NULL.
805 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
806 Enable is FALSE, then the wakeup alarm was disabled.
807 @retval EFI_INVALID_PARAMETER A time field is out of range.
808 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
809 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
814 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
816 IN EFI_TIME
*Time OPTIONAL
820 Loads an EFI image into memory.
822 @param[in] BootPolicy If TRUE, indicates that the request originates from the boot
823 manager, and that the boot manager is attempting to load
824 FilePath as a boot selection. Ignored if SourceBuffer is
826 @param[in] ParentImageHandle The caller's image handle.
827 @param[in] DevicePath The DeviceHandle specific file path from which the image is
829 @param[in] SourceBuffer If not NULL, a pointer to the memory location containing a copy
830 of the image to be loaded.
831 @param[in] SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
832 @param[out] ImageHandle The pointer to the returned image handle that is created when the
833 image is successfully loaded.
835 @retval EFI_SUCCESS Image was loaded into memory correctly.
836 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
837 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
838 @retval EFI_UNSUPPORTED The image type is not supported.
839 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
840 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
842 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
843 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
844 image from being loaded. NULL is returned in *ImageHandle.
845 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
846 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
847 platform policy specifies that the image should not be started.
851 (EFIAPI
*EFI_IMAGE_LOAD
)(
852 IN BOOLEAN BootPolicy
,
853 IN EFI_HANDLE ParentImageHandle
,
854 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
855 IN VOID
*SourceBuffer OPTIONAL
,
857 OUT EFI_HANDLE
*ImageHandle
861 Transfers control to a loaded image's entry point.
863 @param[in] ImageHandle Handle of image to be started.
864 @param[out] ExitDataSize The pointer to the size, in bytes, of ExitData.
865 @param[out] ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
866 string, optionally followed by additional binary data.
868 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
869 has already been initialized with StartImage.
870 @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.
871 @return Exit code from image
876 (EFIAPI
*EFI_IMAGE_START
)(
877 IN EFI_HANDLE ImageHandle
,
878 OUT UINTN
*ExitDataSize
,
879 OUT CHAR16
**ExitData OPTIONAL
883 Terminates a loaded EFI image and returns control to boot services.
885 @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the
887 @param[in] ExitStatus The image's exit code.
888 @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
889 @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string,
890 optionally followed by additional binary data. The string is a
891 description that the caller may use to further indicate the reason
892 for the image's exit. ExitData is only valid if ExitStatus
893 is something other than EFI_SUCCESS. The ExitData buffer
894 must be allocated by calling AllocatePool().
896 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
897 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
898 started with LoadImage() and StartImage(), but the
899 image is not the currently executing image.
905 IN EFI_HANDLE ImageHandle
,
906 IN EFI_STATUS ExitStatus
,
907 IN UINTN ExitDataSize
,
908 IN CHAR16
*ExitData OPTIONAL
914 @param[in] ImageHandle Handle that identifies the image to be unloaded.
916 @retval EFI_SUCCESS The image has been unloaded.
917 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
922 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
923 IN EFI_HANDLE ImageHandle
927 Terminates all boot services.
929 @param[in] ImageHandle Handle that identifies the exiting image.
930 @param[in] MapKey Key to the latest memory map.
932 @retval EFI_SUCCESS Boot services have been terminated.
933 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
938 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
939 IN EFI_HANDLE ImageHandle
,
944 Induces a fine-grained stall.
946 @param[in] Microseconds The number of microseconds to stall execution.
948 @retval EFI_SUCCESS Execution was stalled at least the requested number of
955 IN UINTN Microseconds
959 Sets the system's watchdog timer.
961 @param[in] Timeout The number of seconds to set the watchdog timer to.
962 @param[in] WatchdogCode The numeric code to log on a watchdog timer timeout event.
963 @param[in] DataSize The size, in bytes, of WatchdogData.
964 @param[in] WatchdogData A data buffer that includes a Null-terminated string, optionally
965 followed by additional binary data.
967 @retval EFI_SUCCESS The timeout has been set.
968 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
969 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
970 @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
976 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
978 IN UINT64 WatchdogCode
,
980 IN CHAR16
*WatchdogData OPTIONAL
984 /// Enumeration of reset types.
988 /// Used to induce a system-wide reset. This sets all circuitry within the
989 /// system to its initial state. This type of reset is asynchronous to system
990 /// operation and operates withgout regard to cycle boundaries. EfiColdReset
991 /// is tantamount to a system power cycle.
995 /// Used to induce a system-wide initialization. The processors are set to their
996 /// initial state, and pending cycles are not corrupted. If the system does
997 /// not support this reset type, then an EfiResetCold must be performed.
1001 /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3
1002 /// state. If the system does not support this reset type, then when the system
1003 /// is rebooted, it should exhibit the EfiResetCold attributes.
1007 /// Used to induce a system-wide reset. The exact type of the reset is defined by
1008 /// the EFI_GUID that follows the Null-terminated Unicode string passed into
1009 /// ResetData. If the platform does not recognize the EFI_GUID in ResetData the
1010 /// platform must pick a supported reset type to perform. The platform may
1011 /// optionally log the parameters from any non-normal reset that occurs.
1013 EfiResetPlatformSpecific
1017 Resets the entire platform.
1019 @param[in] ResetType The type of reset to perform.
1020 @param[in] ResetStatus The status code for the reset.
1021 @param[in] DataSize The size, in bytes, of WatchdogData.
1022 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
1023 EfiResetShutdown the data buffer starts with a Null-terminated
1024 string, optionally followed by additional binary data.
1029 (EFIAPI
*EFI_RESET_SYSTEM
)(
1030 IN EFI_RESET_TYPE ResetType
,
1031 IN EFI_STATUS ResetStatus
,
1033 IN VOID
*ResetData OPTIONAL
1037 Returns a monotonically increasing count for the platform.
1039 @param[out] Count The pointer to returned value.
1041 @retval EFI_SUCCESS The next monotonic count was returned.
1042 @retval EFI_INVALID_PARAMETER Count is NULL.
1043 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1048 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1053 Returns the next high 32 bits of the platform's monotonic counter.
1055 @param[out] HighCount The pointer to returned value.
1057 @retval EFI_SUCCESS The next high monotonic count was returned.
1058 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1059 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1064 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1065 OUT UINT32
*HighCount
1069 Computes and returns a 32-bit CRC for a data buffer.
1071 @param[in] Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1072 @param[in] DataSize The number of bytes in the buffer Data.
1073 @param[out] Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1076 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1078 @retval EFI_INVALID_PARAMETER Data is NULL.
1079 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1080 @retval EFI_INVALID_PARAMETER DataSize is 0.
1085 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1092 Copies the contents of one buffer to another buffer.
1094 @param[in] Destination The pointer to the destination buffer of the memory copy.
1095 @param[in] Source The pointer to the source buffer of the memory copy.
1096 @param[in] Length Number of bytes to copy from Source to Destination.
1101 (EFIAPI
*EFI_COPY_MEM
)(
1102 IN VOID
*Destination
,
1108 The SetMem() function fills a buffer with a specified value.
1110 @param[in] Buffer The pointer to the buffer to fill.
1111 @param[in] Size Number of bytes in Buffer to fill.
1112 @param[in] Value Value to fill Buffer with.
1117 (EFIAPI
*EFI_SET_MEM
)(
1124 /// Enumeration of EFI Interface Types
1128 /// Indicates that the supplied protocol interface is supplied in native form.
1130 EFI_NATIVE_INTERFACE
1131 } EFI_INTERFACE_TYPE
;
1134 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1135 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1136 more error checking than InstallProtocolInterface(), so it is recommended that
1137 InstallMultipleProtocolInterfaces() be used in place of
1138 InstallProtocolInterface()
1140 @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1141 @param[in] Protocol The numeric ID of the protocol interface.
1142 @param[in] InterfaceType Indicates whether Interface is supplied in native form.
1143 @param[in] Interface A pointer to the protocol interface.
1145 @retval EFI_SUCCESS The protocol interface was installed.
1146 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1147 @retval EFI_INVALID_PARAMETER Handle is NULL.
1148 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1149 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1150 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1155 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1156 IN OUT EFI_HANDLE
*Handle
,
1157 IN EFI_GUID
*Protocol
,
1158 IN EFI_INTERFACE_TYPE InterfaceType
,
1163 Installs one or more protocol interfaces into the boot services environment.
1165 @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on,
1166 or a pointer to NULL if a new handle is to be allocated.
1167 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1170 @retval EFI_SUCCESS All the protocol interface was installed.
1171 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1172 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1173 the handle database.
1174 @retval EFI_INVALID_PARAMETER Handle is NULL.
1175 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1180 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1181 IN OUT EFI_HANDLE
*Handle
,
1186 Reinstalls a protocol interface on a device handle.
1188 @param[in] Handle Handle on which the interface is to be reinstalled.
1189 @param[in] Protocol The numeric ID of the interface.
1190 @param[in] OldInterface A pointer to the old interface. NULL can be used if a structure is not
1191 associated with Protocol.
1192 @param[in] NewInterface A pointer to the new interface.
1194 @retval EFI_SUCCESS The protocol interface was reinstalled.
1195 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1196 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1197 because OldInterface is still being used by a
1198 driver that will not release it.
1199 @retval EFI_INVALID_PARAMETER Handle is NULL.
1200 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1205 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1206 IN EFI_HANDLE Handle
,
1207 IN EFI_GUID
*Protocol
,
1208 IN VOID
*OldInterface
,
1209 IN VOID
*NewInterface
1213 Removes a protocol interface from a device handle. It is recommended that
1214 UninstallMultipleProtocolInterfaces() be used in place of
1215 UninstallProtocolInterface().
1217 @param[in] Handle The handle on which the interface was installed.
1218 @param[in] Protocol The numeric ID of the interface.
1219 @param[in] Interface A pointer to the interface.
1221 @retval EFI_SUCCESS The interface was removed.
1222 @retval EFI_NOT_FOUND The interface was not found.
1223 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1224 is still being used by a driver.
1225 @retval EFI_INVALID_PARAMETER Handle is NULL.
1226 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1231 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1232 IN EFI_HANDLE Handle
,
1233 IN EFI_GUID
*Protocol
,
1238 Removes one or more protocol interfaces into the boot services environment.
1240 @param[in] Handle The handle to remove the protocol interfaces from.
1241 @param ... A variable argument list containing pairs of protocol GUIDs and
1242 protocol interfaces.
1244 @retval EFI_SUCCESS All the protocol interfaces were removed.
1245 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1250 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1251 IN EFI_HANDLE Handle
,
1256 Queries a handle to determine if it supports a specified protocol.
1258 @param[in] Handle The handle being queried.
1259 @param[in] Protocol The published unique identifier of the protocol.
1260 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1261 Interface is returned.
1263 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1264 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1265 @retval EFI_INVALID_PARAMETER Handle is NULL.
1266 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1267 @retval EFI_INVALID_PARAMETER Interface is NULL.
1272 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1273 IN EFI_HANDLE Handle
,
1274 IN EFI_GUID
*Protocol
,
1275 OUT VOID
**Interface
1278 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1279 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1280 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1281 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1282 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1283 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1286 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1287 handle, it opens the protocol on behalf of the calling agent.
1289 @param[in] Handle The handle for the protocol interface that is being opened.
1290 @param[in] Protocol The published unique identifier of the protocol.
1291 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1292 Interface is returned.
1293 @param[in] AgentHandle The handle of the agent that is opening the protocol interface
1294 specified by Protocol and Interface.
1295 @param[in] ControllerHandle If the agent that is opening a protocol is a driver that follows the
1296 UEFI Driver Model, then this parameter is the controller handle
1297 that requires the protocol interface. If the agent does not follow
1298 the UEFI Driver Model, then this parameter is optional and may
1300 @param[in] Attributes The open mode of the protocol interface specified by Handle
1303 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1304 protocol interface was returned in Interface.
1305 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1306 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1307 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1308 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1309 handle is the same as AgentHandle.
1314 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1315 IN EFI_HANDLE Handle
,
1316 IN EFI_GUID
*Protocol
,
1317 OUT VOID
**Interface
, OPTIONAL
1318 IN EFI_HANDLE AgentHandle
,
1319 IN EFI_HANDLE ControllerHandle
,
1320 IN UINT32 Attributes
1325 Closes a protocol on a handle that was opened using OpenProtocol().
1327 @param[in] Handle The handle for the protocol interface that was previously opened
1328 with OpenProtocol(), and is now being closed.
1329 @param[in] Protocol The published unique identifier of the protocol.
1330 @param[in] AgentHandle The handle of the agent that is closing the protocol interface.
1331 @param[in] ControllerHandle If the agent that opened a protocol is a driver that follows the
1332 UEFI Driver Model, then this parameter is the controller handle
1333 that required the protocol interface.
1335 @retval EFI_SUCCESS The protocol instance was closed.
1336 @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
1337 2) AgentHandle is NULL.
1338 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1339 4) Protocol is NULL.
1340 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1341 2) The protocol interface specified by Handle and Protocol is not
1342 currently open by AgentHandle and ControllerHandle.
1347 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1348 IN EFI_HANDLE Handle
,
1349 IN EFI_GUID
*Protocol
,
1350 IN EFI_HANDLE AgentHandle
,
1351 IN EFI_HANDLE ControllerHandle
1355 /// EFI Oprn Protocol Information Entry
1358 EFI_HANDLE AgentHandle
;
1359 EFI_HANDLE ControllerHandle
;
1362 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1365 Retrieves the list of agents that currently have a protocol interface opened.
1367 @param[in] Handle The handle for the protocol interface that is being queried.
1368 @param[in] Protocol The published unique identifier of the protocol.
1369 @param[out] EntryBuffer A pointer to a buffer of open protocol information in the form of
1370 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1371 @param[out] EntryCount A pointer to the number of entries in EntryBuffer.
1373 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1374 number of entries was returned EntryCount.
1375 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1376 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1381 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1382 IN EFI_HANDLE Handle
,
1383 IN EFI_GUID
*Protocol
,
1384 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1385 OUT UINTN
*EntryCount
1389 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1392 @param[in] Handle The handle from which to retrieve the list of protocol interface
1394 @param[out] ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1395 installed on Handle.
1396 @param[out] ProtocolBufferCount A pointer to the number of GUID pointers present in
1399 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1400 ProtocolBuffer. The number of protocol interface GUIDs was
1401 returned in ProtocolBufferCount.
1402 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1403 @retval EFI_INVALID_PARAMETER Handle is NULL.
1404 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1405 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1406 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1411 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1412 IN EFI_HANDLE Handle
,
1413 OUT EFI_GUID
***ProtocolBuffer
,
1414 OUT UINTN
*ProtocolBufferCount
1418 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1420 @param[in] Protocol The numeric ID of the protocol for which the event is to be registered.
1421 @param[in] Event Event that is to be signaled whenever a protocol interface is registered
1423 @param[out] Registration A pointer to a memory location to receive the registration value.
1425 @retval EFI_SUCCESS The notification event has been registered.
1426 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1427 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1428 @retval EFI_INVALID_PARAMETER Event is NULL.
1429 @retval EFI_INVALID_PARAMETER Registration is NULL.
1434 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1435 IN EFI_GUID
*Protocol
,
1437 OUT VOID
**Registration
1441 /// Enumeration of EFI Locate Search Types
1445 /// Retrieve all the handles in the handle database.
1449 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1453 /// Retrieve the set of handles from the handle database that support a
1454 /// specified protocol.
1457 } EFI_LOCATE_SEARCH_TYPE
;
1460 Returns an array of handles that support a specified protocol.
1462 @param[in] SearchType Specifies which handle(s) are to be returned.
1463 @param[in] Protocol Specifies the protocol to search by.
1464 @param[in] SearchKey Specifies the search key.
1465 @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1466 the array returned in Buffer (if the buffer was large enough) or the
1467 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1469 @param[out] Buffer The buffer in which the array is returned.
1471 @retval EFI_SUCCESS The array of handles was returned.
1472 @retval EFI_NOT_FOUND No handles match the search.
1473 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1474 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1475 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1476 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1477 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1478 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1483 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1484 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1485 IN EFI_GUID
*Protocol
, OPTIONAL
1486 IN VOID
*SearchKey
, OPTIONAL
1487 IN OUT UINTN
*BufferSize
,
1488 OUT EFI_HANDLE
*Buffer
1492 Locates the handle to a device on the device path that supports the specified protocol.
1494 @param[in] Protocol Specifies the protocol to search for.
1495 @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device
1496 path pointer is modified to point to the remaining part of the device
1498 @param[out] Device A pointer to the returned device handle.
1500 @retval EFI_SUCCESS The resulting handle was returned.
1501 @retval EFI_NOT_FOUND No handles match the search.
1502 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1503 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1504 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1509 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1510 IN EFI_GUID
*Protocol
,
1511 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1512 OUT EFI_HANDLE
*Device
1516 Adds, updates, or removes a configuration table entry from the EFI System Table.
1518 @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.
1519 @param[in] Table A pointer to the configuration table for the entry to add, update, or
1520 remove. May be NULL.
1522 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1523 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1524 @retval EFI_INVALID_PARAMETER Guid is NULL.
1525 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1530 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1536 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1538 @param[in] SearchType Specifies which handle(s) are to be returned.
1539 @param[in] Protocol Provides the protocol to search by.
1540 This parameter is only valid for a SearchType of ByProtocol.
1541 @param[in] SearchKey Supplies the search key depending on the SearchType.
1542 @param[in, out] NoHandles The number of handles returned in Buffer.
1543 @param[out] Buffer A pointer to the buffer to return the requested array of handles that
1546 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1547 handles in Buffer was returned in NoHandles.
1548 @retval EFI_NOT_FOUND No handles match the search.
1549 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1550 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1551 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1556 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1557 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1558 IN EFI_GUID
*Protocol
, OPTIONAL
1559 IN VOID
*SearchKey
, OPTIONAL
1560 IN OUT UINTN
*NoHandles
,
1561 OUT EFI_HANDLE
**Buffer
1565 Returns the first protocol instance that matches the given protocol.
1567 @param[in] Protocol Provides the protocol to search for.
1568 @param[in] Registration Optional registration key returned from
1569 RegisterProtocolNotify().
1570 @param[out] Interface On return, a pointer to the first interface that matches Protocol and
1573 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1575 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1577 @retval EFI_INVALID_PARAMETER Interface is NULL.
1582 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1583 IN EFI_GUID
*Protocol
,
1584 IN VOID
*Registration
, OPTIONAL
1585 OUT VOID
**Interface
1589 /// EFI Capsule Block Descriptor
1593 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1598 /// Physical address of the data block. This member of the union is
1599 /// used if Length is not equal to zero.
1601 EFI_PHYSICAL_ADDRESS DataBlock
;
1603 /// Physical address of another block of
1604 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1605 /// member of the union is used if Length is equal to zero. If
1606 /// ContinuationPointer is zero this entry represents the end of the list.
1608 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1610 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1613 /// EFI Capsule Header.
1617 /// A GUID that defines the contents of a capsule.
1619 EFI_GUID CapsuleGuid
;
1621 /// The size of the capsule header. This may be larger than the size of
1622 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1623 /// extended header entries
1627 /// Bit-mapped list describing the capsule attributes. The Flag values
1628 /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
1629 /// of 0x10000 - 0xFFFFFFFF are defined by this specification
1633 /// Size in bytes of the capsule.
1635 UINT32 CapsuleImageSize
;
1636 } EFI_CAPSULE_HEADER
;
1639 /// The EFI System Table entry must point to an array of capsules
1640 /// that contain the same CapsuleGuid value. The array must be
1641 /// prefixed by a UINT32 that represents the size of the array of capsules.
1645 /// the size of the array of capsules.
1647 UINT32 CapsuleArrayNumber
;
1649 /// Point to an array of capsules that contain the same CapsuleGuid value.
1651 VOID
* CapsulePtr
[1];
1652 } EFI_CAPSULE_TABLE
;
1654 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1655 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1656 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
1659 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1660 consumption, the firmware may process the capsule immediately. If the payload should persist
1661 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1662 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1663 part of the reset process.
1665 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1666 being passed into update capsule.
1667 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1669 @param[in] ScatterGatherList Physical pointer to a set of
1670 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1671 location in physical memory of a set of capsules.
1673 @retval EFI_SUCCESS Valid capsule was passed. If
1674 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1675 capsule has been successfully processed by the firmware.
1676 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
1677 set in the capsule header.
1678 @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
1679 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1680 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1681 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1682 is compatible with this platform but is not capable of being submitted or processed
1683 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1684 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1685 the capsule is compatible with this platform but there are insufficient resources to process.
1690 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1691 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1692 IN UINTN CapsuleCount
,
1693 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1697 Returns if the capsule can be supported via UpdateCapsule().
1699 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1700 being passed into update capsule.
1701 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1703 @param[out] MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1704 support as an argument to UpdateCapsule() via
1705 CapsuleHeaderArray and ScatterGatherList.
1706 @param[out] ResetType Returns the type of reset required for the capsule update.
1708 @retval EFI_SUCCESS Valid answer returned.
1709 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1710 MaximumCapsuleSize and ResetType are undefined.
1711 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1712 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1713 is compatible with this platform but is not capable of being submitted or processed
1714 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1715 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1716 the capsule is compatible with this platform but there are insufficient resources to process.
1721 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1722 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1723 IN UINTN CapsuleCount
,
1724 OUT UINT64
*MaximumCapsuleSize
,
1725 OUT EFI_RESET_TYPE
*ResetType
1729 Returns information about the EFI variables.
1731 @param[in] Attributes Attributes bitmask to specify the type of variables on
1732 which to return information.
1733 @param[out] MaximumVariableStorageSize On output the maximum size of the storage space
1734 available for the EFI variables associated with the
1735 attributes specified.
1736 @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space
1737 available for the EFI variables associated with the
1738 attributes specified.
1739 @param[out] MaximumVariableSize Returns the maximum size of the individual EFI
1740 variables associated with the attributes specified.
1742 @retval EFI_SUCCESS Valid answer returned.
1743 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1744 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1745 MaximumVariableStorageSize,
1746 RemainingVariableStorageSize, MaximumVariableSize
1752 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1753 IN UINT32 Attributes
,
1754 OUT UINT64
*MaximumVariableStorageSize
,
1755 OUT UINT64
*RemainingVariableStorageSize
,
1756 OUT UINT64
*MaximumVariableSize
1760 // Firmware should stop at a firmware user interface on next boot
1762 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
1763 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
1764 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
1765 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
1766 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
1769 // EFI Runtime Services Table
1771 #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1772 #define EFI_2_50_SYSTEM_TABLE_REVISION ((2 << 16) | (50))
1773 #define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40))
1774 #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))
1775 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
1776 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
1777 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1778 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1779 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1780 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1781 #define EFI_SYSTEM_TABLE_REVISION EFI_2_50_SYSTEM_TABLE_REVISION
1782 #define EFI_SPECIFICATION_VERSION EFI_SYSTEM_TABLE_REVISION
1784 #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1785 #define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1788 /// EFI Runtime Services Table.
1792 /// The table header for the EFI Runtime Services Table.
1794 EFI_TABLE_HEADER Hdr
;
1799 EFI_GET_TIME GetTime
;
1800 EFI_SET_TIME SetTime
;
1801 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1802 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1805 // Virtual Memory Services
1807 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1808 EFI_CONVERT_POINTER ConvertPointer
;
1811 // Variable Services
1813 EFI_GET_VARIABLE GetVariable
;
1814 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1815 EFI_SET_VARIABLE SetVariable
;
1818 // Miscellaneous Services
1820 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1821 EFI_RESET_SYSTEM ResetSystem
;
1824 // UEFI 2.0 Capsule Services
1826 EFI_UPDATE_CAPSULE UpdateCapsule
;
1827 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1830 // Miscellaneous UEFI 2.0 Service
1832 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1833 } EFI_RUNTIME_SERVICES
;
1836 #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1837 #define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1840 /// EFI Boot Services Table.
1844 /// The table header for the EFI Boot Services Table.
1846 EFI_TABLE_HEADER Hdr
;
1849 // Task Priority Services
1851 EFI_RAISE_TPL RaiseTPL
;
1852 EFI_RESTORE_TPL RestoreTPL
;
1857 EFI_ALLOCATE_PAGES AllocatePages
;
1858 EFI_FREE_PAGES FreePages
;
1859 EFI_GET_MEMORY_MAP GetMemoryMap
;
1860 EFI_ALLOCATE_POOL AllocatePool
;
1861 EFI_FREE_POOL FreePool
;
1864 // Event & Timer Services
1866 EFI_CREATE_EVENT CreateEvent
;
1867 EFI_SET_TIMER SetTimer
;
1868 EFI_WAIT_FOR_EVENT WaitForEvent
;
1869 EFI_SIGNAL_EVENT SignalEvent
;
1870 EFI_CLOSE_EVENT CloseEvent
;
1871 EFI_CHECK_EVENT CheckEvent
;
1874 // Protocol Handler Services
1876 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1877 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1878 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1879 EFI_HANDLE_PROTOCOL HandleProtocol
;
1881 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1882 EFI_LOCATE_HANDLE LocateHandle
;
1883 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1884 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1889 EFI_IMAGE_LOAD LoadImage
;
1890 EFI_IMAGE_START StartImage
;
1892 EFI_IMAGE_UNLOAD UnloadImage
;
1893 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1896 // Miscellaneous Services
1898 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1900 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1903 // DriverSupport Services
1905 EFI_CONNECT_CONTROLLER ConnectController
;
1906 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1909 // Open and Close Protocol Services
1911 EFI_OPEN_PROTOCOL OpenProtocol
;
1912 EFI_CLOSE_PROTOCOL CloseProtocol
;
1913 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1918 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1919 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1920 EFI_LOCATE_PROTOCOL LocateProtocol
;
1921 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1922 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1925 // 32-bit CRC Services
1927 EFI_CALCULATE_CRC32 CalculateCrc32
;
1930 // Miscellaneous Services
1932 EFI_COPY_MEM CopyMem
;
1934 EFI_CREATE_EVENT_EX CreateEventEx
;
1935 } EFI_BOOT_SERVICES
;
1938 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1939 /// EFI System Table.
1943 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1945 EFI_GUID VendorGuid
;
1947 /// A pointer to the table associated with VendorGuid.
1950 } EFI_CONFIGURATION_TABLE
;
1953 /// EFI System Table
1957 /// The table header for the EFI System Table.
1959 EFI_TABLE_HEADER Hdr
;
1961 /// A pointer to a null terminated string that identifies the vendor
1962 /// that produces the system firmware for the platform.
1964 CHAR16
*FirmwareVendor
;
1966 /// A firmware vendor specific value that identifies the revision
1967 /// of the system firmware for the platform.
1969 UINT32 FirmwareRevision
;
1971 /// The handle for the active console input device. This handle must support
1972 /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
1974 EFI_HANDLE ConsoleInHandle
;
1976 /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
1977 /// associated with ConsoleInHandle.
1979 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1981 /// The handle for the active console output device.
1983 EFI_HANDLE ConsoleOutHandle
;
1985 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1986 /// that is associated with ConsoleOutHandle.
1988 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1990 /// The handle for the active standard error console device.
1991 /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
1993 EFI_HANDLE StandardErrorHandle
;
1995 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1996 /// that is associated with StandardErrorHandle.
1998 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
2000 /// A pointer to the EFI Runtime Services Table.
2002 EFI_RUNTIME_SERVICES
*RuntimeServices
;
2004 /// A pointer to the EFI Boot Services Table.
2006 EFI_BOOT_SERVICES
*BootServices
;
2008 /// The number of system configuration tables in the buffer ConfigurationTable.
2010 UINTN NumberOfTableEntries
;
2012 /// A pointer to the system configuration tables.
2013 /// The number of entries in the table is NumberOfTableEntries.
2015 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
2019 This is the declaration of an EFI image entry point. This entry point is
2020 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
2021 both device drivers and bus drivers.
2023 @param[in] ImageHandle The firmware allocated handle for the UEFI image.
2024 @param[in] SystemTable A pointer to the EFI System Table.
2026 @retval EFI_SUCCESS The operation completed successfully.
2027 @retval Others An unexpected error occurred.
2031 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
2032 IN EFI_HANDLE ImageHandle
,
2033 IN EFI_SYSTEM_TABLE
*SystemTable
2037 // EFI Load Options Attributes
2039 #define LOAD_OPTION_ACTIVE 0x00000001
2040 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
2041 #define LOAD_OPTION_HIDDEN 0x00000008
2042 #define LOAD_OPTION_CATEGORY 0x00001F00
2044 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
2045 #define LOAD_OPTION_CATEGORY_APP 0x00000100
2047 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
2048 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
2049 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
2052 /// EFI Boot Key Data
2057 /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
2059 UINT32 Revision
: 8;
2061 /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
2063 UINT32 ShiftPressed
: 1;
2065 /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
2067 UINT32 ControlPressed
: 1;
2069 /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
2071 UINT32 AltPressed
: 1;
2073 /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
2075 UINT32 LogoPressed
: 1;
2077 /// The Menu key must be pressed (1) or must not be pressed (0).
2079 UINT32 MenuPressed
: 1;
2081 /// The SysReq key must be pressed (1) or must not be pressed (0).
2083 UINT32 SysReqPressed
: 1;
2084 UINT32 Reserved
: 16;
2086 /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
2087 /// zero, then only the shift state is considered. If more than one, then the boot option will
2088 /// only be launched if all of the specified keys are pressed with the same shift state.
2090 UINT32 InputKeyCount
: 2;
2093 } EFI_BOOT_KEY_DATA
;
2101 /// Specifies options about how the key will be processed.
2103 EFI_BOOT_KEY_DATA KeyData
;
2105 /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
2106 /// which BootOption refers. If the CRC-32s do not match this value, then this key
2107 /// option is ignored.
2109 UINT32 BootOptionCrc
;
2111 /// The Boot#### option which will be invoked if this key is pressed and the boot option
2112 /// is active (LOAD_OPTION_ACTIVE is set).
2116 /// The key codes to compare against those returned by the
2117 /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
2118 /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
2120 //EFI_INPUT_KEY Keys[];
2125 // EFI File location to boot from on removable media devices
2127 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2128 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2129 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2130 #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"
2131 #define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.EFI"
2133 #if defined (MDE_CPU_IA32)
2134 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2135 #elif defined (MDE_CPU_IPF)
2136 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2137 #elif defined (MDE_CPU_X64)
2138 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2139 #elif defined (MDE_CPU_EBC)
2140 #elif defined (MDE_CPU_ARM)
2141 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM
2142 #elif defined (MDE_CPU_AARCH64)
2143 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64
2145 #error Unknown Processor Type
2148 #include <Uefi/UefiPxe.h>
2149 #include <Uefi/UefiGpt.h>
2150 #include <Uefi/UefiInternalFormRepresentation.h>