2 Include file that supports UEFI.
4 This include file must contain things defined in the UEFI 2.5 specification.
5 If a code construct is defined in the UEFI 2.5 specification it must be included
8 Copyright (c) 2006 - 2016, 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 // Note: UEFI spec 2.5 and following: use EFI_MEMORY_RO as write-protected physical memory
75 // protection attribute. Also, EFI_MEMORY_WP means cacheability attribute.
77 #define EFI_MEMORY_WP 0x0000000000001000ULL
78 #define EFI_MEMORY_RP 0x0000000000002000ULL
79 #define EFI_MEMORY_XP 0x0000000000004000ULL
80 #define EFI_MEMORY_RO 0x0000000000020000ULL
82 // Physical memory persistence attribute.
83 // The memory region supports byte-addressable non-volatility.
85 #define EFI_MEMORY_NV 0x0000000000008000ULL
87 // The memory region provides higher reliability relative to other memory in the system.
88 // If all memory has the same reliability, then this bit is not used.
90 #define EFI_MEMORY_MORE_RELIABLE 0x0000000000010000ULL
92 // Runtime memory attribute
94 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
97 /// Memory descriptor version number.
99 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
102 /// Definition of an EFI memory descriptor.
106 /// Type of the memory region. See EFI_MEMORY_TYPE.
110 /// Physical address of the first byte of the memory region. Must aligned
111 /// on a 4 KB boundary.
113 EFI_PHYSICAL_ADDRESS PhysicalStart
;
115 /// Virtual address of the first byte of the memory region. Must aligned
116 /// on a 4 KB boundary.
118 EFI_VIRTUAL_ADDRESS VirtualStart
;
120 /// Number of 4KB pages in the memory region.
122 UINT64 NumberOfPages
;
124 /// Attributes of the memory region that describe the bit mask of capabilities
125 /// for that memory region, and not necessarily the current settings for that
129 } EFI_MEMORY_DESCRIPTOR
;
132 Allocates memory pages from the system.
134 @param[in] Type The type of allocation to perform.
135 @param[in] MemoryType The type of memory to allocate.
136 MemoryType values in the range 0x70000000..0x7FFFFFFF
137 are reserved for OEM use. MemoryType values in the range
138 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders
139 that are provided by operating system vendors. The only illegal
140 memory type values are those in the range EfiMaxMemoryType..0x6FFFFFFF.
141 @param[in] Pages The number of contiguous 4 KB pages to allocate.
142 @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is
143 used depends on the value of Type.
145 @retval EFI_SUCCESS The requested pages were allocated.
146 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
147 AllocateMaxAddress or AllocateAddress.
148 2) MemoryType is in the range
149 EfiMaxMemoryType..0x6FFFFFFF.
151 4) MemoryType was EfiPersistentMemory.
152 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
153 @retval EFI_NOT_FOUND The requested pages could not be found.
158 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
159 IN EFI_ALLOCATE_TYPE Type
,
160 IN EFI_MEMORY_TYPE MemoryType
,
162 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
168 @param[in] Memory The base physical address of the pages to be freed.
169 @param[in] Pages The number of contiguous 4 KB pages to free.
171 @retval EFI_SUCCESS The requested pages were freed.
172 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
173 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
179 (EFIAPI
*EFI_FREE_PAGES
)(
180 IN EFI_PHYSICAL_ADDRESS Memory
,
185 Returns the current memory map.
187 @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
188 On input, this is the size of the buffer allocated by the caller.
189 On output, it is the size of the buffer returned by the firmware if
190 the buffer was large enough, or the size of the buffer needed to contain
191 the map if the buffer was too small.
192 @param[in, out] MemoryMap A pointer to the buffer in which firmware places the current memory
194 @param[out] MapKey A pointer to the location in which firmware returns the key for the
196 @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
197 an individual EFI_MEMORY_DESCRIPTOR.
198 @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number
199 associated with the EFI_MEMORY_DESCRIPTOR.
201 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
202 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
203 needed to hold the memory map is returned in MemoryMapSize.
204 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
205 2) The MemoryMap buffer is not too small and MemoryMap is
211 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
212 IN OUT UINTN
*MemoryMapSize
,
213 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
215 OUT UINTN
*DescriptorSize
,
216 OUT UINT32
*DescriptorVersion
220 Allocates pool memory.
222 @param[in] PoolType The type of pool to allocate.
223 MemoryType values in the range 0x70000000..0x7FFFFFFF
224 are reserved for OEM use. MemoryType values in the range
225 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders
226 that are provided by operating system vendors. The only illegal
227 memory type values are those in the range EfiMaxMemoryType..0x6FFFFFFF.
228 @param[in] Size The number of bytes to allocate from the pool.
229 @param[out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
232 @retval EFI_SUCCESS The requested number of bytes was allocated.
233 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
234 @retval EFI_INVALID_PARAMETER PoolType was invalid or Buffer is NULL.
235 PoolType was EfiPersistentMemory.
240 (EFIAPI
*EFI_ALLOCATE_POOL
)(
241 IN EFI_MEMORY_TYPE PoolType
,
247 Returns pool memory to the system.
249 @param[in] Buffer The pointer to the buffer to free.
251 @retval EFI_SUCCESS The memory was returned to the system.
252 @retval EFI_INVALID_PARAMETER Buffer was invalid.
257 (EFIAPI
*EFI_FREE_POOL
)(
262 Changes the runtime addressing mode of EFI firmware from physical to virtual.
264 @param[in] MemoryMapSize The size in bytes of VirtualMap.
265 @param[in] DescriptorSize The size in bytes of an entry in the VirtualMap.
266 @param[in] DescriptorVersion The version of the structure entries in VirtualMap.
267 @param[in] VirtualMap An array of memory descriptors which contain new virtual
268 address mapping information for all runtime ranges.
270 @retval EFI_SUCCESS The virtual address map has been applied.
271 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
272 virtual address mapped mode.
273 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
274 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
275 map that requires a mapping.
276 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
282 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
283 IN UINTN MemoryMapSize
,
284 IN UINTN DescriptorSize
,
285 IN UINT32 DescriptorVersion
,
286 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
290 Connects one or more drivers to a controller.
292 @param[in] ControllerHandle The handle of the controller to which driver(s) are to be connected.
293 @param[in] DriverImageHandle A pointer to an ordered list handles that support the
294 EFI_DRIVER_BINDING_PROTOCOL.
295 @param[in] RemainingDevicePath A pointer to the device path that specifies a child of the
296 controller specified by ControllerHandle.
297 @param[in] Recursive If TRUE, then ConnectController() is called recursively
298 until the entire tree of controllers below the controller specified
299 by ControllerHandle have been created. If FALSE, then
300 the tree of controllers is only expanded one level.
302 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
303 2) No drivers were connected to ControllerHandle, but
304 RemainingDevicePath is not NULL, and it is an End Device
306 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
307 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
308 present in the system.
309 2) No drivers were connected to ControllerHandle.
310 @retval EFI_SECURITY_VIOLATION
311 The user has no permission to start UEFI device drivers on the device path
312 associated with the ControllerHandle or specified by the RemainingDevicePath.
316 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
317 IN EFI_HANDLE ControllerHandle
,
318 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
319 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
324 Disconnects one or more drivers from a controller.
326 @param[in] ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
327 @param[in] DriverImageHandle The driver to disconnect from ControllerHandle.
328 If DriverImageHandle is NULL, then all the drivers currently managing
329 ControllerHandle are disconnected from ControllerHandle.
330 @param[in] ChildHandle The handle of the child to destroy.
331 If ChildHandle is NULL, then all the children of ControllerHandle are
332 destroyed before the drivers are disconnected from ControllerHandle.
334 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
335 2) On entry, no drivers are managing ControllerHandle.
336 3) DriverImageHandle is not NULL, and on entry
337 DriverImageHandle is not managing ControllerHandle.
338 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
339 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
340 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
341 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
342 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
344 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
349 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
350 IN EFI_HANDLE ControllerHandle
,
351 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
352 IN EFI_HANDLE ChildHandle OPTIONAL
358 // ConvertPointer DebugDisposition type.
360 #define EFI_OPTIONAL_PTR 0x00000001
363 Determines the new virtual address that is to be used on subsequent memory accesses.
365 @param[in] DebugDisposition Supplies type information for the pointer being converted.
366 @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed
367 for the new virtual address mappings being applied.
369 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
370 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
371 2) *Address is NULL and DebugDisposition does
372 not have the EFI_OPTIONAL_PTR bit set.
373 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
374 of the current memory map. This is normally fatal.
379 (EFIAPI
*EFI_CONVERT_POINTER
)(
380 IN UINTN DebugDisposition
,
381 IN OUT VOID
**Address
386 // These types can be ORed together as needed - for example,
387 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
388 // EVT_NOTIFY_SIGNAL.
390 #define EVT_TIMER 0x80000000
391 #define EVT_RUNTIME 0x40000000
392 #define EVT_NOTIFY_WAIT 0x00000100
393 #define EVT_NOTIFY_SIGNAL 0x00000200
395 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
396 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
399 // The event's NotifyContext pointer points to a runtime memory
401 // The event is deprecated in UEFI2.0 and later specifications.
403 #define EVT_RUNTIME_CONTEXT 0x20000000
407 Invoke a notification event
409 @param[in] Event Event whose notification function is being invoked.
410 @param[in] Context The pointer to the notification function's context,
411 which is implementation-dependent.
416 (EFIAPI
*EFI_EVENT_NOTIFY
)(
424 @param[in] Type The type of event to create and its mode and attributes.
425 @param[in] NotifyTpl The task priority level of event notifications, if needed.
426 @param[in] NotifyFunction The pointer to the event's notification function, if any.
427 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
428 Context in the notification function.
429 @param[out] 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
)(
441 IN EFI_TPL NotifyTpl
,
442 IN EFI_EVENT_NOTIFY NotifyFunction
,
443 IN VOID
*NotifyContext
,
448 Creates an event in a group.
450 @param[in] Type The type of event to create and its mode and attributes.
451 @param[in] NotifyTpl The task priority level of event notifications,if needed.
452 @param[in] NotifyFunction The pointer to the event's notification function, if any.
453 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
454 Context in the notification function.
455 @param[in] EventGroup The pointer to the unique identifier of the group to which this event belongs.
456 If this is NULL, then the function behaves as if the parameters were passed
458 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
461 @retval EFI_SUCCESS The event structure was created.
462 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
463 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
468 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
470 IN EFI_TPL NotifyTpl
,
471 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
472 IN CONST VOID
*NotifyContext OPTIONAL
,
473 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
478 /// Timer delay types
482 /// An event's timer settings is to be cancelled and not trigger time is to be set/
486 /// An event is to be signaled periodically at a specified interval from the current time.
490 /// An event is to be signaled once at a specified interval from the current time.
496 Sets the type of timer and the trigger time for a timer event.
498 @param[in] Event The timer event that is to be signaled at the specified time.
499 @param[in] Type The type of time that is specified in TriggerTime.
500 @param[in] TriggerTime The number of 100ns units until the timer expires.
501 A TriggerTime of 0 is legal.
502 If Type is TimerRelative and TriggerTime is 0, then the timer
503 event will be signaled on the next timer tick.
504 If Type is TimerPeriodic and TriggerTime is 0, then the timer
505 event will be signaled on every timer tick.
507 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
508 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
513 (EFIAPI
*EFI_SET_TIMER
)(
515 IN EFI_TIMER_DELAY Type
,
516 IN UINT64 TriggerTime
522 @param[in] Event The event to signal.
524 @retval EFI_SUCCESS The event has been signaled.
529 (EFIAPI
*EFI_SIGNAL_EVENT
)(
534 Stops execution until an event is signaled.
536 @param[in] NumberOfEvents The number of events in the Event array.
537 @param[in] Event An array of EFI_EVENT.
538 @param[out] Index The pointer to the index of the event which satisfied the wait condition.
540 @retval EFI_SUCCESS The event indicated by Index was signaled.
541 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
542 2) The event indicated by Index is of type
544 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
549 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
550 IN UINTN NumberOfEvents
,
558 @param[in] Event The event to close.
560 @retval EFI_SUCCESS The event has been closed.
565 (EFIAPI
*EFI_CLOSE_EVENT
)(
570 Checks whether an event is in the signaled state.
572 @param[in] Event The event to check.
574 @retval EFI_SUCCESS The event is in the signaled state.
575 @retval EFI_NOT_READY The event is not in the signaled state.
576 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
581 (EFIAPI
*EFI_CHECK_EVENT
)(
587 // Task priority level
589 #define TPL_APPLICATION 4
590 #define TPL_CALLBACK 8
591 #define TPL_NOTIFY 16
592 #define TPL_HIGH_LEVEL 31
596 Raises a task's priority level and returns its previous level.
598 @param[in] NewTpl The new task priority level.
600 @return Previous task priority level
605 (EFIAPI
*EFI_RAISE_TPL
)(
610 Restores a task's priority level to its previous value.
612 @param[in] OldTpl The previous task priority level to restore.
617 (EFIAPI
*EFI_RESTORE_TPL
)(
622 Returns the value of a variable.
624 @param[in] VariableName A Null-terminated string that is the name of the vendor's
626 @param[in] VendorGuid A unique identifier for the vendor.
627 @param[out] Attributes If not NULL, a pointer to the memory location to return the
628 attributes bitmask for the variable.
629 @param[in, out] DataSize On input, the size in bytes of the return Data buffer.
630 On output the size of data returned in Data.
631 @param[out] Data The buffer to return the contents of the variable. May be NULL
632 with a zero DataSize in order to determine the size buffer needed.
634 @retval EFI_SUCCESS The function completed successfully.
635 @retval EFI_NOT_FOUND The variable was not found.
636 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
637 @retval EFI_INVALID_PARAMETER VariableName is NULL.
638 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
639 @retval EFI_INVALID_PARAMETER DataSize is NULL.
640 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
641 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
642 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
647 (EFIAPI
*EFI_GET_VARIABLE
)(
648 IN CHAR16
*VariableName
,
649 IN EFI_GUID
*VendorGuid
,
650 OUT UINT32
*Attributes
, OPTIONAL
651 IN OUT UINTN
*DataSize
,
652 OUT VOID
*Data OPTIONAL
656 Enumerates the current variable names.
658 @param[in, out] VariableNameSize The size of the VariableName buffer.
659 @param[in, out] VariableName On input, supplies the last VariableName that was returned
660 by GetNextVariableName(). On output, returns the Nullterminated
661 string of the current variable.
662 @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by
663 GetNextVariableName(). On output, returns the
664 VendorGuid of the current variable.
666 @retval EFI_SUCCESS The function completed successfully.
667 @retval EFI_NOT_FOUND The next variable was not found.
668 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
669 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
670 @retval EFI_INVALID_PARAMETER VariableName is NULL.
671 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
672 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
677 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
678 IN OUT UINTN
*VariableNameSize
,
679 IN OUT CHAR16
*VariableName
,
680 IN OUT EFI_GUID
*VendorGuid
684 Sets the value of a variable.
686 @param[in] VariableName A Null-terminated string that is the name of the vendor's variable.
687 Each VariableName is unique for each VendorGuid. VariableName must
688 contain 1 or more characters. If VariableName is an empty string,
689 then EFI_INVALID_PARAMETER is returned.
690 @param[in] VendorGuid A unique identifier for the vendor.
691 @param[in] Attributes Attributes bitmask to set for the variable.
692 @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
693 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
694 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
695 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
696 set, then a SetVariable() call with a DataSize of zero will not cause any change to
697 the variable value (the timestamp associated with the variable may be updated however
698 even if no new data value is provided,see the description of the
699 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
700 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
701 @param[in] Data The contents for the variable.
703 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
704 defined by the Attributes.
705 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
706 DataSize exceeds the maximum allowed.
707 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
708 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
709 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
710 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
711 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
712 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
713 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
714 does NOT pass the validation check carried out by the firmware.
716 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
721 (EFIAPI
*EFI_SET_VARIABLE
)(
722 IN CHAR16
*VariableName
,
723 IN EFI_GUID
*VendorGuid
,
724 IN UINT32 Attributes
,
731 /// This provides the capabilities of the
732 /// real time clock device as exposed through the EFI interfaces.
736 /// Provides the reporting resolution of the real-time clock device in
737 /// counts per second. For a normal PC-AT CMOS RTC device, this
738 /// value would be 1 Hz, or 1, to indicate that the device only reports
739 /// the time to the resolution of 1 second.
743 /// Provides the timekeeping accuracy of the real-time clock in an
744 /// error rate of 1E-6 parts per million. For a clock with an accuracy
745 /// of 50 parts per million, the value in this field would be
750 /// A TRUE indicates that a time set operation clears the device's
751 /// time below the Resolution reporting level. A FALSE
752 /// indicates that the state below the Resolution level of the
753 /// device is not cleared when the time is set. Normal PC-AT CMOS
754 /// RTC devices set this value to FALSE.
757 } EFI_TIME_CAPABILITIES
;
760 Returns the current time and date information, and the time-keeping capabilities
761 of the hardware platform.
763 @param[out] Time A pointer to storage to receive a snapshot of the current time.
764 @param[out] Capabilities An optional pointer to a buffer to receive the real time clock
765 device's capabilities.
767 @retval EFI_SUCCESS The operation completed successfully.
768 @retval EFI_INVALID_PARAMETER Time is NULL.
769 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
774 (EFIAPI
*EFI_GET_TIME
)(
776 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
780 Sets the current local time and date information.
782 @param[in] Time A pointer to the current time.
784 @retval EFI_SUCCESS The operation completed successfully.
785 @retval EFI_INVALID_PARAMETER A time field is out of range.
786 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
791 (EFIAPI
*EFI_SET_TIME
)(
796 Returns the current wakeup alarm clock setting.
798 @param[out] Enabled Indicates if the alarm is currently enabled or disabled.
799 @param[out] Pending Indicates if the alarm signal is pending and requires acknowledgement.
800 @param[out] Time The current alarm setting.
802 @retval EFI_SUCCESS The alarm settings were returned.
803 @retval EFI_INVALID_PARAMETER Enabled is NULL.
804 @retval EFI_INVALID_PARAMETER Pending is NULL.
805 @retval EFI_INVALID_PARAMETER Time is NULL.
806 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
807 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
812 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
813 OUT BOOLEAN
*Enabled
,
814 OUT BOOLEAN
*Pending
,
819 Sets the system wakeup alarm clock time.
821 @param[in] Enable Enable or disable the wakeup alarm.
822 @param[in] Time If Enable is TRUE, the time to set the wakeup alarm for.
823 If Enable is FALSE, then this parameter is optional, and may be NULL.
825 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
826 Enable is FALSE, then the wakeup alarm was disabled.
827 @retval EFI_INVALID_PARAMETER A time field is out of range.
828 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
829 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
834 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
836 IN EFI_TIME
*Time OPTIONAL
840 Loads an EFI image into memory.
842 @param[in] BootPolicy If TRUE, indicates that the request originates from the boot
843 manager, and that the boot manager is attempting to load
844 FilePath as a boot selection. Ignored if SourceBuffer is
846 @param[in] ParentImageHandle The caller's image handle.
847 @param[in] DevicePath The DeviceHandle specific file path from which the image is
849 @param[in] SourceBuffer If not NULL, a pointer to the memory location containing a copy
850 of the image to be loaded.
851 @param[in] SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
852 @param[out] ImageHandle The pointer to the returned image handle that is created when the
853 image is successfully loaded.
855 @retval EFI_SUCCESS Image was loaded into memory correctly.
856 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
857 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
858 @retval EFI_UNSUPPORTED The image type is not supported.
859 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
860 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
862 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
863 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
864 image from being loaded. NULL is returned in *ImageHandle.
865 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
866 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
867 platform policy specifies that the image should not be started.
871 (EFIAPI
*EFI_IMAGE_LOAD
)(
872 IN BOOLEAN BootPolicy
,
873 IN EFI_HANDLE ParentImageHandle
,
874 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
875 IN VOID
*SourceBuffer OPTIONAL
,
877 OUT EFI_HANDLE
*ImageHandle
881 Transfers control to a loaded image's entry point.
883 @param[in] ImageHandle Handle of image to be started.
884 @param[out] ExitDataSize The pointer to the size, in bytes, of ExitData.
885 @param[out] ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
886 string, optionally followed by additional binary data.
888 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
889 has already been initialized with StartImage.
890 @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.
891 @return Exit code from image
896 (EFIAPI
*EFI_IMAGE_START
)(
897 IN EFI_HANDLE ImageHandle
,
898 OUT UINTN
*ExitDataSize
,
899 OUT CHAR16
**ExitData OPTIONAL
903 Terminates a loaded EFI image and returns control to boot services.
905 @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the
907 @param[in] ExitStatus The image's exit code.
908 @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
909 @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string,
910 optionally followed by additional binary data. The string is a
911 description that the caller may use to further indicate the reason
912 for the image's exit. ExitData is only valid if ExitStatus
913 is something other than EFI_SUCCESS. The ExitData buffer
914 must be allocated by calling AllocatePool().
916 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
917 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
918 started with LoadImage() and StartImage(), but the
919 image is not the currently executing image.
925 IN EFI_HANDLE ImageHandle
,
926 IN EFI_STATUS ExitStatus
,
927 IN UINTN ExitDataSize
,
928 IN CHAR16
*ExitData OPTIONAL
934 @param[in] ImageHandle Handle that identifies the image to be unloaded.
936 @retval EFI_SUCCESS The image has been unloaded.
937 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
942 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
943 IN EFI_HANDLE ImageHandle
947 Terminates all boot services.
949 @param[in] ImageHandle Handle that identifies the exiting image.
950 @param[in] MapKey Key to the latest memory map.
952 @retval EFI_SUCCESS Boot services have been terminated.
953 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
958 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
959 IN EFI_HANDLE ImageHandle
,
964 Induces a fine-grained stall.
966 @param[in] Microseconds The number of microseconds to stall execution.
968 @retval EFI_SUCCESS Execution was stalled at least the requested number of
975 IN UINTN Microseconds
979 Sets the system's watchdog timer.
981 @param[in] Timeout The number of seconds to set the watchdog timer to.
982 @param[in] WatchdogCode The numeric code to log on a watchdog timer timeout event.
983 @param[in] DataSize The size, in bytes, of WatchdogData.
984 @param[in] WatchdogData A data buffer that includes a Null-terminated string, optionally
985 followed by additional binary data.
987 @retval EFI_SUCCESS The timeout has been set.
988 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
989 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
990 @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
996 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
998 IN UINT64 WatchdogCode
,
1000 IN CHAR16
*WatchdogData OPTIONAL
1004 Resets the entire platform.
1006 @param[in] ResetType The type of reset to perform.
1007 @param[in] ResetStatus The status code for the reset.
1008 @param[in] DataSize The size, in bytes, of WatchdogData.
1009 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
1010 EfiResetShutdown the data buffer starts with a Null-terminated
1011 string, optionally followed by additional binary data.
1016 (EFIAPI
*EFI_RESET_SYSTEM
)(
1017 IN EFI_RESET_TYPE ResetType
,
1018 IN EFI_STATUS ResetStatus
,
1020 IN VOID
*ResetData OPTIONAL
1024 Returns a monotonically increasing count for the platform.
1026 @param[out] Count The pointer to returned value.
1028 @retval EFI_SUCCESS The next monotonic count was returned.
1029 @retval EFI_INVALID_PARAMETER Count is NULL.
1030 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1035 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1040 Returns the next high 32 bits of the platform's monotonic counter.
1042 @param[out] HighCount The pointer to returned value.
1044 @retval EFI_SUCCESS The next high monotonic count was returned.
1045 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1046 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1051 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1052 OUT UINT32
*HighCount
1056 Computes and returns a 32-bit CRC for a data buffer.
1058 @param[in] Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1059 @param[in] DataSize The number of bytes in the buffer Data.
1060 @param[out] Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1063 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1065 @retval EFI_INVALID_PARAMETER Data is NULL.
1066 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1067 @retval EFI_INVALID_PARAMETER DataSize is 0.
1072 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1079 Copies the contents of one buffer to another buffer.
1081 @param[in] Destination The pointer to the destination buffer of the memory copy.
1082 @param[in] Source The pointer to the source buffer of the memory copy.
1083 @param[in] Length Number of bytes to copy from Source to Destination.
1088 (EFIAPI
*EFI_COPY_MEM
)(
1089 IN VOID
*Destination
,
1095 The SetMem() function fills a buffer with a specified value.
1097 @param[in] Buffer The pointer to the buffer to fill.
1098 @param[in] Size Number of bytes in Buffer to fill.
1099 @param[in] Value Value to fill Buffer with.
1104 (EFIAPI
*EFI_SET_MEM
)(
1111 /// Enumeration of EFI Interface Types
1115 /// Indicates that the supplied protocol interface is supplied in native form.
1117 EFI_NATIVE_INTERFACE
1118 } EFI_INTERFACE_TYPE
;
1121 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1122 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1123 more error checking than InstallProtocolInterface(), so it is recommended that
1124 InstallMultipleProtocolInterfaces() be used in place of
1125 InstallProtocolInterface()
1127 @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1128 @param[in] Protocol The numeric ID of the protocol interface.
1129 @param[in] InterfaceType Indicates whether Interface is supplied in native form.
1130 @param[in] Interface A pointer to the protocol interface.
1132 @retval EFI_SUCCESS The protocol interface was installed.
1133 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1134 @retval EFI_INVALID_PARAMETER Handle is NULL.
1135 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1136 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1137 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1142 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1143 IN OUT EFI_HANDLE
*Handle
,
1144 IN EFI_GUID
*Protocol
,
1145 IN EFI_INTERFACE_TYPE InterfaceType
,
1150 Installs one or more protocol interfaces into the boot services environment.
1152 @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on,
1153 or a pointer to NULL if a new handle is to be allocated.
1154 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1157 @retval EFI_SUCCESS All the protocol interface was installed.
1158 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1159 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1160 the handle database.
1161 @retval EFI_INVALID_PARAMETER Handle is NULL.
1162 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1167 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1168 IN OUT EFI_HANDLE
*Handle
,
1173 Reinstalls a protocol interface on a device handle.
1175 @param[in] Handle Handle on which the interface is to be reinstalled.
1176 @param[in] Protocol The numeric ID of the interface.
1177 @param[in] OldInterface A pointer to the old interface. NULL can be used if a structure is not
1178 associated with Protocol.
1179 @param[in] NewInterface A pointer to the new interface.
1181 @retval EFI_SUCCESS The protocol interface was reinstalled.
1182 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1183 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1184 because OldInterface is still being used by a
1185 driver that will not release it.
1186 @retval EFI_INVALID_PARAMETER Handle is NULL.
1187 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1192 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1193 IN EFI_HANDLE Handle
,
1194 IN EFI_GUID
*Protocol
,
1195 IN VOID
*OldInterface
,
1196 IN VOID
*NewInterface
1200 Removes a protocol interface from a device handle. It is recommended that
1201 UninstallMultipleProtocolInterfaces() be used in place of
1202 UninstallProtocolInterface().
1204 @param[in] Handle The handle on which the interface was installed.
1205 @param[in] Protocol The numeric ID of the interface.
1206 @param[in] Interface A pointer to the interface.
1208 @retval EFI_SUCCESS The interface was removed.
1209 @retval EFI_NOT_FOUND The interface was not found.
1210 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1211 is still being used by a driver.
1212 @retval EFI_INVALID_PARAMETER Handle is NULL.
1213 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1218 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1219 IN EFI_HANDLE Handle
,
1220 IN EFI_GUID
*Protocol
,
1225 Removes one or more protocol interfaces into the boot services environment.
1227 @param[in] Handle The handle to remove the protocol interfaces from.
1228 @param ... A variable argument list containing pairs of protocol GUIDs and
1229 protocol interfaces.
1231 @retval EFI_SUCCESS All the protocol interfaces were removed.
1232 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1237 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1238 IN EFI_HANDLE Handle
,
1243 Queries a handle to determine if it supports a specified protocol.
1245 @param[in] Handle The handle being queried.
1246 @param[in] Protocol The published unique identifier of the protocol.
1247 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1248 Interface is returned.
1250 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1251 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1252 @retval EFI_INVALID_PARAMETER Handle is NULL.
1253 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1254 @retval EFI_INVALID_PARAMETER Interface is NULL.
1259 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1260 IN EFI_HANDLE Handle
,
1261 IN EFI_GUID
*Protocol
,
1262 OUT VOID
**Interface
1265 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1266 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1267 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1268 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1269 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1270 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1273 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1274 handle, it opens the protocol on behalf of the calling agent.
1276 @param[in] Handle The handle for the protocol interface that is being opened.
1277 @param[in] Protocol The published unique identifier of the protocol.
1278 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1279 Interface is returned.
1280 @param[in] AgentHandle The handle of the agent that is opening the protocol interface
1281 specified by Protocol and Interface.
1282 @param[in] ControllerHandle If the agent that is opening a protocol is a driver that follows the
1283 UEFI Driver Model, then this parameter is the controller handle
1284 that requires the protocol interface. If the agent does not follow
1285 the UEFI Driver Model, then this parameter is optional and may
1287 @param[in] Attributes The open mode of the protocol interface specified by Handle
1290 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1291 protocol interface was returned in Interface.
1292 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1293 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1294 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1295 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1296 handle is the same as AgentHandle.
1301 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1302 IN EFI_HANDLE Handle
,
1303 IN EFI_GUID
*Protocol
,
1304 OUT VOID
**Interface
, OPTIONAL
1305 IN EFI_HANDLE AgentHandle
,
1306 IN EFI_HANDLE ControllerHandle
,
1307 IN UINT32 Attributes
1312 Closes a protocol on a handle that was opened using OpenProtocol().
1314 @param[in] Handle The handle for the protocol interface that was previously opened
1315 with OpenProtocol(), and is now being closed.
1316 @param[in] Protocol The published unique identifier of the protocol.
1317 @param[in] AgentHandle The handle of the agent that is closing the protocol interface.
1318 @param[in] ControllerHandle If the agent that opened a protocol is a driver that follows the
1319 UEFI Driver Model, then this parameter is the controller handle
1320 that required the protocol interface.
1322 @retval EFI_SUCCESS The protocol instance was closed.
1323 @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
1324 2) AgentHandle is NULL.
1325 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1326 4) Protocol is NULL.
1327 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1328 2) The protocol interface specified by Handle and Protocol is not
1329 currently open by AgentHandle and ControllerHandle.
1334 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1335 IN EFI_HANDLE Handle
,
1336 IN EFI_GUID
*Protocol
,
1337 IN EFI_HANDLE AgentHandle
,
1338 IN EFI_HANDLE ControllerHandle
1342 /// EFI Oprn Protocol Information Entry
1345 EFI_HANDLE AgentHandle
;
1346 EFI_HANDLE ControllerHandle
;
1349 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1352 Retrieves the list of agents that currently have a protocol interface opened.
1354 @param[in] Handle The handle for the protocol interface that is being queried.
1355 @param[in] Protocol The published unique identifier of the protocol.
1356 @param[out] EntryBuffer A pointer to a buffer of open protocol information in the form of
1357 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1358 @param[out] EntryCount A pointer to the number of entries in EntryBuffer.
1360 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1361 number of entries was returned EntryCount.
1362 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1363 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1368 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1369 IN EFI_HANDLE Handle
,
1370 IN EFI_GUID
*Protocol
,
1371 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1372 OUT UINTN
*EntryCount
1376 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1379 @param[in] Handle The handle from which to retrieve the list of protocol interface
1381 @param[out] ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1382 installed on Handle.
1383 @param[out] ProtocolBufferCount A pointer to the number of GUID pointers present in
1386 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1387 ProtocolBuffer. The number of protocol interface GUIDs was
1388 returned in ProtocolBufferCount.
1389 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1390 @retval EFI_INVALID_PARAMETER Handle is NULL.
1391 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1392 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1393 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1398 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1399 IN EFI_HANDLE Handle
,
1400 OUT EFI_GUID
***ProtocolBuffer
,
1401 OUT UINTN
*ProtocolBufferCount
1405 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1407 @param[in] Protocol The numeric ID of the protocol for which the event is to be registered.
1408 @param[in] Event Event that is to be signaled whenever a protocol interface is registered
1410 @param[out] Registration A pointer to a memory location to receive the registration value.
1412 @retval EFI_SUCCESS The notification event has been registered.
1413 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1414 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1415 @retval EFI_INVALID_PARAMETER Event is NULL.
1416 @retval EFI_INVALID_PARAMETER Registration is NULL.
1421 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1422 IN EFI_GUID
*Protocol
,
1424 OUT VOID
**Registration
1428 /// Enumeration of EFI Locate Search Types
1432 /// Retrieve all the handles in the handle database.
1436 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1440 /// Retrieve the set of handles from the handle database that support a
1441 /// specified protocol.
1444 } EFI_LOCATE_SEARCH_TYPE
;
1447 Returns an array of handles that support a specified protocol.
1449 @param[in] SearchType Specifies which handle(s) are to be returned.
1450 @param[in] Protocol Specifies the protocol to search by.
1451 @param[in] SearchKey Specifies the search key.
1452 @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1453 the array returned in Buffer (if the buffer was large enough) or the
1454 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1456 @param[out] Buffer The buffer in which the array is returned.
1458 @retval EFI_SUCCESS The array of handles was returned.
1459 @retval EFI_NOT_FOUND No handles match the search.
1460 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1461 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1462 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1463 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1464 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1465 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1470 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1471 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1472 IN EFI_GUID
*Protocol
, OPTIONAL
1473 IN VOID
*SearchKey
, OPTIONAL
1474 IN OUT UINTN
*BufferSize
,
1475 OUT EFI_HANDLE
*Buffer
1479 Locates the handle to a device on the device path that supports the specified protocol.
1481 @param[in] Protocol Specifies the protocol to search for.
1482 @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device
1483 path pointer is modified to point to the remaining part of the device
1485 @param[out] Device A pointer to the returned device handle.
1487 @retval EFI_SUCCESS The resulting handle was returned.
1488 @retval EFI_NOT_FOUND No handles match the search.
1489 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1490 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1491 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1496 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1497 IN EFI_GUID
*Protocol
,
1498 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1499 OUT EFI_HANDLE
*Device
1503 Adds, updates, or removes a configuration table entry from the EFI System Table.
1505 @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.
1506 @param[in] Table A pointer to the configuration table for the entry to add, update, or
1507 remove. May be NULL.
1509 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1510 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1511 @retval EFI_INVALID_PARAMETER Guid is NULL.
1512 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1517 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1523 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1525 @param[in] SearchType Specifies which handle(s) are to be returned.
1526 @param[in] Protocol Provides the protocol to search by.
1527 This parameter is only valid for a SearchType of ByProtocol.
1528 @param[in] SearchKey Supplies the search key depending on the SearchType.
1529 @param[in, out] NoHandles The number of handles returned in Buffer.
1530 @param[out] Buffer A pointer to the buffer to return the requested array of handles that
1533 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1534 handles in Buffer was returned in NoHandles.
1535 @retval EFI_NOT_FOUND No handles match the search.
1536 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1537 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1538 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1543 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1544 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1545 IN EFI_GUID
*Protocol
, OPTIONAL
1546 IN VOID
*SearchKey
, OPTIONAL
1547 IN OUT UINTN
*NoHandles
,
1548 OUT EFI_HANDLE
**Buffer
1552 Returns the first protocol instance that matches the given protocol.
1554 @param[in] Protocol Provides the protocol to search for.
1555 @param[in] Registration Optional registration key returned from
1556 RegisterProtocolNotify().
1557 @param[out] Interface On return, a pointer to the first interface that matches Protocol and
1560 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1562 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1564 @retval EFI_INVALID_PARAMETER Interface is NULL.
1569 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1570 IN EFI_GUID
*Protocol
,
1571 IN VOID
*Registration
, OPTIONAL
1572 OUT VOID
**Interface
1576 /// EFI Capsule Block Descriptor
1580 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1585 /// Physical address of the data block. This member of the union is
1586 /// used if Length is not equal to zero.
1588 EFI_PHYSICAL_ADDRESS DataBlock
;
1590 /// Physical address of another block of
1591 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1592 /// member of the union is used if Length is equal to zero. If
1593 /// ContinuationPointer is zero this entry represents the end of the list.
1595 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1597 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1600 /// EFI Capsule Header.
1604 /// A GUID that defines the contents of a capsule.
1606 EFI_GUID CapsuleGuid
;
1608 /// The size of the capsule header. This may be larger than the size of
1609 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1610 /// extended header entries
1614 /// Bit-mapped list describing the capsule attributes. The Flag values
1615 /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
1616 /// of 0x10000 - 0xFFFFFFFF are defined by this specification
1620 /// Size in bytes of the capsule.
1622 UINT32 CapsuleImageSize
;
1623 } EFI_CAPSULE_HEADER
;
1626 /// The EFI System Table entry must point to an array of capsules
1627 /// that contain the same CapsuleGuid value. The array must be
1628 /// prefixed by a UINT32 that represents the size of the array of capsules.
1632 /// the size of the array of capsules.
1634 UINT32 CapsuleArrayNumber
;
1636 /// Point to an array of capsules that contain the same CapsuleGuid value.
1638 VOID
* CapsulePtr
[1];
1639 } EFI_CAPSULE_TABLE
;
1641 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1642 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1643 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
1646 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1647 consumption, the firmware may process the capsule immediately. If the payload should persist
1648 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1649 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1650 part of the reset process.
1652 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1653 being passed into update capsule.
1654 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1656 @param[in] ScatterGatherList Physical pointer to a set of
1657 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1658 location in physical memory of a set of capsules.
1660 @retval EFI_SUCCESS Valid capsule was passed. If
1661 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1662 capsule has been successfully processed by the firmware.
1663 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
1664 set in the capsule header.
1665 @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
1666 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1667 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1668 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1669 is compatible with this platform but is not capable of being submitted or processed
1670 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1671 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1672 the capsule is compatible with this platform but there are insufficient resources to process.
1677 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1678 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1679 IN UINTN CapsuleCount
,
1680 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1684 Returns if the capsule can be supported via UpdateCapsule().
1686 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1687 being passed into update capsule.
1688 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1690 @param[out] MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1691 support as an argument to UpdateCapsule() via
1692 CapsuleHeaderArray and ScatterGatherList.
1693 @param[out] ResetType Returns the type of reset required for the capsule update.
1695 @retval EFI_SUCCESS Valid answer returned.
1696 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1697 MaximumCapsuleSize and ResetType are undefined.
1698 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1699 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1700 is compatible with this platform but is not capable of being submitted or processed
1701 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1702 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1703 the capsule is compatible with this platform but there are insufficient resources to process.
1708 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1709 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1710 IN UINTN CapsuleCount
,
1711 OUT UINT64
*MaximumCapsuleSize
,
1712 OUT EFI_RESET_TYPE
*ResetType
1716 Returns information about the EFI variables.
1718 @param[in] Attributes Attributes bitmask to specify the type of variables on
1719 which to return information.
1720 @param[out] MaximumVariableStorageSize On output the maximum size of the storage space
1721 available for the EFI variables associated with the
1722 attributes specified.
1723 @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space
1724 available for the EFI variables associated with the
1725 attributes specified.
1726 @param[out] MaximumVariableSize Returns the maximum size of the individual EFI
1727 variables associated with the attributes specified.
1729 @retval EFI_SUCCESS Valid answer returned.
1730 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1731 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1732 MaximumVariableStorageSize,
1733 RemainingVariableStorageSize, MaximumVariableSize
1739 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1740 IN UINT32 Attributes
,
1741 OUT UINT64
*MaximumVariableStorageSize
,
1742 OUT UINT64
*RemainingVariableStorageSize
,
1743 OUT UINT64
*MaximumVariableSize
1747 // Firmware should stop at a firmware user interface on next boot
1749 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
1750 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
1751 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
1752 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
1753 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
1754 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
1757 // EFI Runtime Services Table
1759 #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1760 #define EFI_2_50_SYSTEM_TABLE_REVISION ((2 << 16) | (50))
1761 #define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40))
1762 #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))
1763 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
1764 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
1765 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1766 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1767 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1768 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1769 #define EFI_SYSTEM_TABLE_REVISION EFI_2_50_SYSTEM_TABLE_REVISION
1770 #define EFI_SPECIFICATION_VERSION EFI_SYSTEM_TABLE_REVISION
1772 #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1773 #define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1776 /// EFI Runtime Services Table.
1780 /// The table header for the EFI Runtime Services Table.
1782 EFI_TABLE_HEADER Hdr
;
1787 EFI_GET_TIME GetTime
;
1788 EFI_SET_TIME SetTime
;
1789 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1790 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1793 // Virtual Memory Services
1795 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1796 EFI_CONVERT_POINTER ConvertPointer
;
1799 // Variable Services
1801 EFI_GET_VARIABLE GetVariable
;
1802 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1803 EFI_SET_VARIABLE SetVariable
;
1806 // Miscellaneous Services
1808 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1809 EFI_RESET_SYSTEM ResetSystem
;
1812 // UEFI 2.0 Capsule Services
1814 EFI_UPDATE_CAPSULE UpdateCapsule
;
1815 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1818 // Miscellaneous UEFI 2.0 Service
1820 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1821 } EFI_RUNTIME_SERVICES
;
1824 #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1825 #define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1828 /// EFI Boot Services Table.
1832 /// The table header for the EFI Boot Services Table.
1834 EFI_TABLE_HEADER Hdr
;
1837 // Task Priority Services
1839 EFI_RAISE_TPL RaiseTPL
;
1840 EFI_RESTORE_TPL RestoreTPL
;
1845 EFI_ALLOCATE_PAGES AllocatePages
;
1846 EFI_FREE_PAGES FreePages
;
1847 EFI_GET_MEMORY_MAP GetMemoryMap
;
1848 EFI_ALLOCATE_POOL AllocatePool
;
1849 EFI_FREE_POOL FreePool
;
1852 // Event & Timer Services
1854 EFI_CREATE_EVENT CreateEvent
;
1855 EFI_SET_TIMER SetTimer
;
1856 EFI_WAIT_FOR_EVENT WaitForEvent
;
1857 EFI_SIGNAL_EVENT SignalEvent
;
1858 EFI_CLOSE_EVENT CloseEvent
;
1859 EFI_CHECK_EVENT CheckEvent
;
1862 // Protocol Handler Services
1864 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1865 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1866 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1867 EFI_HANDLE_PROTOCOL HandleProtocol
;
1869 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1870 EFI_LOCATE_HANDLE LocateHandle
;
1871 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1872 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1877 EFI_IMAGE_LOAD LoadImage
;
1878 EFI_IMAGE_START StartImage
;
1880 EFI_IMAGE_UNLOAD UnloadImage
;
1881 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1884 // Miscellaneous Services
1886 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1888 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1891 // DriverSupport Services
1893 EFI_CONNECT_CONTROLLER ConnectController
;
1894 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1897 // Open and Close Protocol Services
1899 EFI_OPEN_PROTOCOL OpenProtocol
;
1900 EFI_CLOSE_PROTOCOL CloseProtocol
;
1901 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1906 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1907 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1908 EFI_LOCATE_PROTOCOL LocateProtocol
;
1909 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1910 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1913 // 32-bit CRC Services
1915 EFI_CALCULATE_CRC32 CalculateCrc32
;
1918 // Miscellaneous Services
1920 EFI_COPY_MEM CopyMem
;
1922 EFI_CREATE_EVENT_EX CreateEventEx
;
1923 } EFI_BOOT_SERVICES
;
1926 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1927 /// EFI System Table.
1931 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1933 EFI_GUID VendorGuid
;
1935 /// A pointer to the table associated with VendorGuid.
1938 } EFI_CONFIGURATION_TABLE
;
1941 /// EFI System Table
1945 /// The table header for the EFI System Table.
1947 EFI_TABLE_HEADER Hdr
;
1949 /// A pointer to a null terminated string that identifies the vendor
1950 /// that produces the system firmware for the platform.
1952 CHAR16
*FirmwareVendor
;
1954 /// A firmware vendor specific value that identifies the revision
1955 /// of the system firmware for the platform.
1957 UINT32 FirmwareRevision
;
1959 /// The handle for the active console input device. This handle must support
1960 /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
1962 EFI_HANDLE ConsoleInHandle
;
1964 /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
1965 /// associated with ConsoleInHandle.
1967 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1969 /// The handle for the active console output device.
1971 EFI_HANDLE ConsoleOutHandle
;
1973 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1974 /// that is associated with ConsoleOutHandle.
1976 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1978 /// The handle for the active standard error console device.
1979 /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
1981 EFI_HANDLE StandardErrorHandle
;
1983 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1984 /// that is associated with StandardErrorHandle.
1986 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
1988 /// A pointer to the EFI Runtime Services Table.
1990 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1992 /// A pointer to the EFI Boot Services Table.
1994 EFI_BOOT_SERVICES
*BootServices
;
1996 /// The number of system configuration tables in the buffer ConfigurationTable.
1998 UINTN NumberOfTableEntries
;
2000 /// A pointer to the system configuration tables.
2001 /// The number of entries in the table is NumberOfTableEntries.
2003 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
2007 This is the declaration of an EFI image entry point. This entry point is
2008 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
2009 both device drivers and bus drivers.
2011 @param[in] ImageHandle The firmware allocated handle for the UEFI image.
2012 @param[in] SystemTable A pointer to the EFI System Table.
2014 @retval EFI_SUCCESS The operation completed successfully.
2015 @retval Others An unexpected error occurred.
2019 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
2020 IN EFI_HANDLE ImageHandle
,
2021 IN EFI_SYSTEM_TABLE
*SystemTable
2025 // EFI Load Option. This data structure describes format of UEFI boot option variables.
2027 // NOTE: EFI Load Option is a byte packed buffer of variable length fields.
2028 // The first two fields have fixed length. They are declared as members of the
2029 // EFI_LOAD_OPTION structure. All the other fields are variable length fields.
2030 // They are listed in the comment block below for reference purposes.
2033 typedef struct _EFI_LOAD_OPTION
{
2035 /// The attributes for this load option entry. All unused bits must be zero
2036 /// and are reserved by the UEFI specification for future growth.
2040 /// Length in bytes of the FilePathList. OptionalData starts at offset
2041 /// sizeof(UINT32) + sizeof(UINT16) + StrSize(Description) + FilePathListLength
2042 /// of the EFI_LOAD_OPTION descriptor.
2044 UINT16 FilePathListLength
;
2046 /// The user readable description for the load option.
2047 /// This field ends with a Null character.
2049 // CHAR16 Description[];
2051 /// A packed array of UEFI device paths. The first element of the array is a
2052 /// device path that describes the device and location of the Image for this
2053 /// load option. The FilePathList[0] is specific to the device type. Other
2054 /// device paths may optionally exist in the FilePathList, but their usage is
2055 /// OSV specific. Each element in the array is variable length, and ends at
2056 /// the device path end structure. Because the size of Description is
2057 /// arbitrary, this data structure is not guaranteed to be aligned on a
2058 /// natural boundary. This data structure may have to be copied to an aligned
2059 /// natural boundary before it is used.
2061 // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
2063 /// The remaining bytes in the load option descriptor are a binary data buffer
2064 /// that is passed to the loaded image. If the field is zero bytes long, a
2065 /// NULL pointer is passed to the loaded image. The number of bytes in
2066 /// OptionalData can be computed by subtracting the starting offset of
2067 /// OptionalData from total size in bytes of the EFI_LOAD_OPTION.
2069 // UINT8 OptionalData[];
2074 // EFI Load Options Attributes
2076 #define LOAD_OPTION_ACTIVE 0x00000001
2077 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
2078 #define LOAD_OPTION_HIDDEN 0x00000008
2079 #define LOAD_OPTION_CATEGORY 0x00001F00
2081 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
2082 #define LOAD_OPTION_CATEGORY_APP 0x00000100
2084 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
2085 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
2086 #define EFI_BOOT_OPTION_SUPPORT_SYSPREP 0x00000010
2087 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
2090 /// EFI Boot Key Data
2095 /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
2097 UINT32 Revision
: 8;
2099 /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
2101 UINT32 ShiftPressed
: 1;
2103 /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
2105 UINT32 ControlPressed
: 1;
2107 /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
2109 UINT32 AltPressed
: 1;
2111 /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
2113 UINT32 LogoPressed
: 1;
2115 /// The Menu key must be pressed (1) or must not be pressed (0).
2117 UINT32 MenuPressed
: 1;
2119 /// The SysReq key must be pressed (1) or must not be pressed (0).
2121 UINT32 SysReqPressed
: 1;
2122 UINT32 Reserved
: 16;
2124 /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
2125 /// zero, then only the shift state is considered. If more than one, then the boot option will
2126 /// only be launched if all of the specified keys are pressed with the same shift state.
2128 UINT32 InputKeyCount
: 2;
2131 } EFI_BOOT_KEY_DATA
;
2139 /// Specifies options about how the key will be processed.
2141 EFI_BOOT_KEY_DATA KeyData
;
2143 /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
2144 /// which BootOption refers. If the CRC-32s do not match this value, then this key
2145 /// option is ignored.
2147 UINT32 BootOptionCrc
;
2149 /// The Boot#### option which will be invoked if this key is pressed and the boot option
2150 /// is active (LOAD_OPTION_ACTIVE is set).
2154 /// The key codes to compare against those returned by the
2155 /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
2156 /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
2158 //EFI_INPUT_KEY Keys[];
2163 // EFI File location to boot from on removable media devices
2165 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2166 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2167 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2168 #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"
2169 #define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.EFI"
2171 #if defined (MDE_CPU_IA32)
2172 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2173 #elif defined (MDE_CPU_IPF)
2174 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2175 #elif defined (MDE_CPU_X64)
2176 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2177 #elif defined (MDE_CPU_EBC)
2178 #elif defined (MDE_CPU_ARM)
2179 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM
2180 #elif defined (MDE_CPU_AARCH64)
2181 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64
2183 #error Unknown Processor Type
2186 #include <Uefi/UefiPxe.h>
2187 #include <Uefi/UefiGpt.h>
2188 #include <Uefi/UefiInternalFormRepresentation.h>