2 Include file that supports UEFI.
4 This include file must contain things defined in the UEFI 2.6 specification.
5 If a code construct is defined in the UEFI 2.6 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.
140 @param[in] Pages The number of contiguous 4 KB pages to allocate.
141 @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is
142 used depends on the value of Type.
144 @retval EFI_SUCCESS The requested pages were allocated.
145 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
146 AllocateMaxAddress or AllocateAddress.
147 2) MemoryType is in the range
148 EfiMaxMemoryType..0x6FFFFFFF.
150 4) MemoryType is EfiPersistentMemory.
151 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
152 @retval EFI_NOT_FOUND The requested pages could not be found.
157 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
158 IN EFI_ALLOCATE_TYPE Type
,
159 IN EFI_MEMORY_TYPE MemoryType
,
161 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
167 @param[in] Memory The base physical address of the pages to be freed.
168 @param[in] Pages The number of contiguous 4 KB pages to free.
170 @retval EFI_SUCCESS The requested pages were freed.
171 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
172 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
178 (EFIAPI
*EFI_FREE_PAGES
)(
179 IN EFI_PHYSICAL_ADDRESS Memory
,
184 Returns the current memory map.
186 @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
187 On input, this is the size of the buffer allocated by the caller.
188 On output, it is the size of the buffer returned by the firmware if
189 the buffer was large enough, or the size of the buffer needed to contain
190 the map if the buffer was too small.
191 @param[in, out] MemoryMap A pointer to the buffer in which firmware places the current memory
193 @param[out] MapKey A pointer to the location in which firmware returns the key for the
195 @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
196 an individual EFI_MEMORY_DESCRIPTOR.
197 @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number
198 associated with the EFI_MEMORY_DESCRIPTOR.
200 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
201 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
202 needed to hold the memory map is returned in MemoryMapSize.
203 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
204 2) The MemoryMap buffer is not too small and MemoryMap is
210 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
211 IN OUT UINTN
*MemoryMapSize
,
212 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
214 OUT UINTN
*DescriptorSize
,
215 OUT UINT32
*DescriptorVersion
219 Allocates pool memory.
221 @param[in] PoolType The type of pool to allocate.
222 MemoryType values in the range 0x70000000..0x7FFFFFFF
223 are reserved for OEM use. MemoryType values in the range
224 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders
225 that are provided by operating system vendors.
226 @param[in] Size The number of bytes to allocate from the pool.
227 @param[out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
230 @retval EFI_SUCCESS The requested number of bytes was allocated.
231 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
232 @retval EFI_INVALID_PARAMETER Buffer is NULL.
233 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.
234 PoolType is EfiPersistentMemory.
239 (EFIAPI
*EFI_ALLOCATE_POOL
)(
240 IN EFI_MEMORY_TYPE PoolType
,
246 Returns pool memory to the system.
248 @param[in] Buffer The pointer to the buffer to free.
250 @retval EFI_SUCCESS The memory was returned to the system.
251 @retval EFI_INVALID_PARAMETER Buffer was invalid.
256 (EFIAPI
*EFI_FREE_POOL
)(
261 Changes the runtime addressing mode of EFI firmware from physical to virtual.
263 @param[in] MemoryMapSize The size in bytes of VirtualMap.
264 @param[in] DescriptorSize The size in bytes of an entry in the VirtualMap.
265 @param[in] DescriptorVersion The version of the structure entries in VirtualMap.
266 @param[in] VirtualMap An array of memory descriptors which contain new virtual
267 address mapping information for all runtime ranges.
269 @retval EFI_SUCCESS The virtual address map has been applied.
270 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
271 virtual address mapped mode.
272 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
273 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
274 map that requires a mapping.
275 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
281 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
282 IN UINTN MemoryMapSize
,
283 IN UINTN DescriptorSize
,
284 IN UINT32 DescriptorVersion
,
285 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
289 Connects one or more drivers to a controller.
291 @param[in] ControllerHandle The handle of the controller to which driver(s) are to be connected.
292 @param[in] DriverImageHandle A pointer to an ordered list handles that support the
293 EFI_DRIVER_BINDING_PROTOCOL.
294 @param[in] RemainingDevicePath A pointer to the device path that specifies a child of the
295 controller specified by ControllerHandle.
296 @param[in] Recursive If TRUE, then ConnectController() is called recursively
297 until the entire tree of controllers below the controller specified
298 by ControllerHandle have been created. If FALSE, then
299 the tree of controllers is only expanded one level.
301 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
302 2) No drivers were connected to ControllerHandle, but
303 RemainingDevicePath is not NULL, and it is an End Device
305 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
306 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
307 present in the system.
308 2) No drivers were connected to ControllerHandle.
309 @retval EFI_SECURITY_VIOLATION
310 The user has no permission to start UEFI device drivers on the device path
311 associated with the ControllerHandle or specified by the RemainingDevicePath.
315 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
316 IN EFI_HANDLE ControllerHandle
,
317 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
318 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
323 Disconnects one or more drivers from a controller.
325 @param[in] ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
326 @param[in] DriverImageHandle The driver to disconnect from ControllerHandle.
327 If DriverImageHandle is NULL, then all the drivers currently managing
328 ControllerHandle are disconnected from ControllerHandle.
329 @param[in] ChildHandle The handle of the child to destroy.
330 If ChildHandle is NULL, then all the children of ControllerHandle are
331 destroyed before the drivers are disconnected from ControllerHandle.
333 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
334 2) On entry, no drivers are managing ControllerHandle.
335 3) DriverImageHandle is not NULL, and on entry
336 DriverImageHandle is not managing ControllerHandle.
337 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
338 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
339 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
340 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
341 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
343 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
348 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
349 IN EFI_HANDLE ControllerHandle
,
350 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
351 IN EFI_HANDLE ChildHandle OPTIONAL
357 // ConvertPointer DebugDisposition type.
359 #define EFI_OPTIONAL_PTR 0x00000001
362 Determines the new virtual address that is to be used on subsequent memory accesses.
364 @param[in] DebugDisposition Supplies type information for the pointer being converted.
365 @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed
366 for the new virtual address mappings being applied.
368 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
369 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
370 2) *Address is NULL and DebugDisposition does
371 not have the EFI_OPTIONAL_PTR bit set.
372 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
373 of the current memory map. This is normally fatal.
378 (EFIAPI
*EFI_CONVERT_POINTER
)(
379 IN UINTN DebugDisposition
,
380 IN OUT VOID
**Address
385 // These types can be ORed together as needed - for example,
386 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
387 // EVT_NOTIFY_SIGNAL.
389 #define EVT_TIMER 0x80000000
390 #define EVT_RUNTIME 0x40000000
391 #define EVT_NOTIFY_WAIT 0x00000100
392 #define EVT_NOTIFY_SIGNAL 0x00000200
394 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
395 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
398 // The event's NotifyContext pointer points to a runtime memory
400 // The event is deprecated in UEFI2.0 and later specifications.
402 #define EVT_RUNTIME_CONTEXT 0x20000000
406 Invoke a notification event
408 @param[in] Event Event whose notification function is being invoked.
409 @param[in] Context The pointer to the notification function's context,
410 which is implementation-dependent.
415 (EFIAPI
*EFI_EVENT_NOTIFY
)(
423 @param[in] Type The type of event to create and its mode and attributes.
424 @param[in] NotifyTpl The task priority level of event notifications, if needed.
425 @param[in] NotifyFunction The pointer to the event's notification function, if any.
426 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
427 Context in the notification function.
428 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
431 @retval EFI_SUCCESS The event structure was created.
432 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
433 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
438 (EFIAPI
*EFI_CREATE_EVENT
)(
440 IN EFI_TPL NotifyTpl
,
441 IN EFI_EVENT_NOTIFY NotifyFunction
,
442 IN VOID
*NotifyContext
,
447 Creates an event in a group.
449 @param[in] Type The type of event to create and its mode and attributes.
450 @param[in] NotifyTpl The task priority level of event notifications,if needed.
451 @param[in] NotifyFunction The pointer to the event's notification function, if any.
452 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
453 Context in the notification function.
454 @param[in] EventGroup The pointer to the unique identifier of the group to which this event belongs.
455 If this is NULL, then the function behaves as if the parameters were passed
457 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
460 @retval EFI_SUCCESS The event structure was created.
461 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
462 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
467 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
469 IN EFI_TPL NotifyTpl
,
470 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
471 IN CONST VOID
*NotifyContext OPTIONAL
,
472 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
477 /// Timer delay types
481 /// An event's timer settings is to be cancelled and not trigger time is to be set/
485 /// An event is to be signaled periodically at a specified interval from the current time.
489 /// An event is to be signaled once at a specified interval from the current time.
495 Sets the type of timer and the trigger time for a timer event.
497 @param[in] Event The timer event that is to be signaled at the specified time.
498 @param[in] Type The type of time that is specified in TriggerTime.
499 @param[in] TriggerTime The number of 100ns units until the timer expires.
500 A TriggerTime of 0 is legal.
501 If Type is TimerRelative and TriggerTime is 0, then the timer
502 event will be signaled on the next timer tick.
503 If Type is TimerPeriodic and TriggerTime is 0, then the timer
504 event will be signaled on every timer tick.
506 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
507 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
512 (EFIAPI
*EFI_SET_TIMER
)(
514 IN EFI_TIMER_DELAY Type
,
515 IN UINT64 TriggerTime
521 @param[in] Event The event to signal.
523 @retval EFI_SUCCESS The event has been signaled.
528 (EFIAPI
*EFI_SIGNAL_EVENT
)(
533 Stops execution until an event is signaled.
535 @param[in] NumberOfEvents The number of events in the Event array.
536 @param[in] Event An array of EFI_EVENT.
537 @param[out] Index The pointer to the index of the event which satisfied the wait condition.
539 @retval EFI_SUCCESS The event indicated by Index was signaled.
540 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
541 2) The event indicated by Index is of type
543 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
548 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
549 IN UINTN NumberOfEvents
,
557 @param[in] Event The event to close.
559 @retval EFI_SUCCESS The event has been closed.
564 (EFIAPI
*EFI_CLOSE_EVENT
)(
569 Checks whether an event is in the signaled state.
571 @param[in] Event The event to check.
573 @retval EFI_SUCCESS The event is in the signaled state.
574 @retval EFI_NOT_READY The event is not in the signaled state.
575 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
580 (EFIAPI
*EFI_CHECK_EVENT
)(
586 // Task priority level
588 #define TPL_APPLICATION 4
589 #define TPL_CALLBACK 8
590 #define TPL_NOTIFY 16
591 #define TPL_HIGH_LEVEL 31
595 Raises a task's priority level and returns its previous level.
597 @param[in] NewTpl The new task priority level.
599 @return Previous task priority level
604 (EFIAPI
*EFI_RAISE_TPL
)(
609 Restores a task's priority level to its previous value.
611 @param[in] OldTpl The previous task priority level to restore.
616 (EFIAPI
*EFI_RESTORE_TPL
)(
621 Returns the value of a variable.
623 @param[in] VariableName A Null-terminated string that is the name of the vendor's
625 @param[in] VendorGuid A unique identifier for the vendor.
626 @param[out] Attributes If not NULL, a pointer to the memory location to return the
627 attributes bitmask for the variable.
628 @param[in, out] DataSize On input, the size in bytes of the return Data buffer.
629 On output the size of data returned in Data.
630 @param[out] Data The buffer to return the contents of the variable. May be NULL
631 with a zero DataSize in order to determine the size buffer needed.
633 @retval EFI_SUCCESS The function completed successfully.
634 @retval EFI_NOT_FOUND The variable was not found.
635 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
636 @retval EFI_INVALID_PARAMETER VariableName is NULL.
637 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
638 @retval EFI_INVALID_PARAMETER DataSize is NULL.
639 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
640 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
641 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
646 (EFIAPI
*EFI_GET_VARIABLE
)(
647 IN CHAR16
*VariableName
,
648 IN EFI_GUID
*VendorGuid
,
649 OUT UINT32
*Attributes
, OPTIONAL
650 IN OUT UINTN
*DataSize
,
651 OUT VOID
*Data OPTIONAL
655 Enumerates the current variable names.
657 @param[in, out] VariableNameSize The size of the VariableName buffer.
658 @param[in, out] VariableName On input, supplies the last VariableName that was returned
659 by GetNextVariableName(). On output, returns the Nullterminated
660 string of the current variable.
661 @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by
662 GetNextVariableName(). On output, returns the
663 VendorGuid of the current variable.
665 @retval EFI_SUCCESS The function completed successfully.
666 @retval EFI_NOT_FOUND The next variable was not found.
667 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
668 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
669 @retval EFI_INVALID_PARAMETER VariableName is NULL.
670 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
671 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
676 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
677 IN OUT UINTN
*VariableNameSize
,
678 IN OUT CHAR16
*VariableName
,
679 IN OUT EFI_GUID
*VendorGuid
683 Sets the value of a variable.
685 @param[in] VariableName A Null-terminated string that is the name of the vendor's variable.
686 Each VariableName is unique for each VendorGuid. VariableName must
687 contain 1 or more characters. If VariableName is an empty string,
688 then EFI_INVALID_PARAMETER is returned.
689 @param[in] VendorGuid A unique identifier for the vendor.
690 @param[in] Attributes Attributes bitmask to set for the variable.
691 @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
692 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
693 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
694 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
695 set, then a SetVariable() call with a DataSize of zero will not cause any change to
696 the variable value (the timestamp associated with the variable may be updated however
697 even if no new data value is provided,see the description of the
698 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
699 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
700 @param[in] Data The contents for the variable.
702 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
703 defined by the Attributes.
704 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
705 DataSize exceeds the maximum allowed.
706 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
707 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
708 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
709 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
710 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
711 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
712 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
713 does NOT pass the validation check carried out by the firmware.
715 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
720 (EFIAPI
*EFI_SET_VARIABLE
)(
721 IN CHAR16
*VariableName
,
722 IN EFI_GUID
*VendorGuid
,
723 IN UINT32 Attributes
,
730 /// This provides the capabilities of the
731 /// real time clock device as exposed through the EFI interfaces.
735 /// Provides the reporting resolution of the real-time clock device in
736 /// counts per second. For a normal PC-AT CMOS RTC device, this
737 /// value would be 1 Hz, or 1, to indicate that the device only reports
738 /// the time to the resolution of 1 second.
742 /// Provides the timekeeping accuracy of the real-time clock in an
743 /// error rate of 1E-6 parts per million. For a clock with an accuracy
744 /// of 50 parts per million, the value in this field would be
749 /// A TRUE indicates that a time set operation clears the device's
750 /// time below the Resolution reporting level. A FALSE
751 /// indicates that the state below the Resolution level of the
752 /// device is not cleared when the time is set. Normal PC-AT CMOS
753 /// RTC devices set this value to FALSE.
756 } EFI_TIME_CAPABILITIES
;
759 Returns the current time and date information, and the time-keeping capabilities
760 of the hardware platform.
762 @param[out] Time A pointer to storage to receive a snapshot of the current time.
763 @param[out] Capabilities An optional pointer to a buffer to receive the real time clock
764 device's capabilities.
766 @retval EFI_SUCCESS The operation completed successfully.
767 @retval EFI_INVALID_PARAMETER Time is NULL.
768 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
773 (EFIAPI
*EFI_GET_TIME
)(
775 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
779 Sets the current local time and date information.
781 @param[in] Time A pointer to the current time.
783 @retval EFI_SUCCESS The operation completed successfully.
784 @retval EFI_INVALID_PARAMETER A time field is out of range.
785 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
790 (EFIAPI
*EFI_SET_TIME
)(
795 Returns the current wakeup alarm clock setting.
797 @param[out] Enabled Indicates if the alarm is currently enabled or disabled.
798 @param[out] Pending Indicates if the alarm signal is pending and requires acknowledgement.
799 @param[out] Time The current alarm setting.
801 @retval EFI_SUCCESS The alarm settings were returned.
802 @retval EFI_INVALID_PARAMETER Enabled is NULL.
803 @retval EFI_INVALID_PARAMETER Pending is NULL.
804 @retval EFI_INVALID_PARAMETER Time is NULL.
805 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
806 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
811 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
812 OUT BOOLEAN
*Enabled
,
813 OUT BOOLEAN
*Pending
,
818 Sets the system wakeup alarm clock time.
820 @param[in] Enable Enable or disable the wakeup alarm.
821 @param[in] Time If Enable is TRUE, the time to set the wakeup alarm for.
822 If Enable is FALSE, then this parameter is optional, and may be NULL.
824 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
825 Enable is FALSE, then the wakeup alarm was disabled.
826 @retval EFI_INVALID_PARAMETER A time field is out of range.
827 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
828 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
833 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
835 IN EFI_TIME
*Time OPTIONAL
839 Loads an EFI image into memory.
841 @param[in] BootPolicy If TRUE, indicates that the request originates from the boot
842 manager, and that the boot manager is attempting to load
843 FilePath as a boot selection. Ignored if SourceBuffer is
845 @param[in] ParentImageHandle The caller's image handle.
846 @param[in] DevicePath The DeviceHandle specific file path from which the image is
848 @param[in] SourceBuffer If not NULL, a pointer to the memory location containing a copy
849 of the image to be loaded.
850 @param[in] SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
851 @param[out] ImageHandle The pointer to the returned image handle that is created when the
852 image is successfully loaded.
854 @retval EFI_SUCCESS Image was loaded into memory correctly.
855 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
856 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
857 @retval EFI_UNSUPPORTED The image type is not supported.
858 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
859 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
861 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
862 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
863 image from being loaded. NULL is returned in *ImageHandle.
864 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
865 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
866 platform policy specifies that the image should not be started.
870 (EFIAPI
*EFI_IMAGE_LOAD
)(
871 IN BOOLEAN BootPolicy
,
872 IN EFI_HANDLE ParentImageHandle
,
873 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
874 IN VOID
*SourceBuffer OPTIONAL
,
876 OUT EFI_HANDLE
*ImageHandle
880 Transfers control to a loaded image's entry point.
882 @param[in] ImageHandle Handle of image to be started.
883 @param[out] ExitDataSize The pointer to the size, in bytes, of ExitData.
884 @param[out] ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
885 string, optionally followed by additional binary data.
887 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
888 has already been initialized with StartImage.
889 @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.
890 @return Exit code from image
895 (EFIAPI
*EFI_IMAGE_START
)(
896 IN EFI_HANDLE ImageHandle
,
897 OUT UINTN
*ExitDataSize
,
898 OUT CHAR16
**ExitData OPTIONAL
902 Terminates a loaded EFI image and returns control to boot services.
904 @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the
906 @param[in] ExitStatus The image's exit code.
907 @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
908 @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string,
909 optionally followed by additional binary data. The string is a
910 description that the caller may use to further indicate the reason
911 for the image's exit. ExitData is only valid if ExitStatus
912 is something other than EFI_SUCCESS. The ExitData buffer
913 must be allocated by calling AllocatePool().
915 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
916 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
917 started with LoadImage() and StartImage(), but the
918 image is not the currently executing image.
924 IN EFI_HANDLE ImageHandle
,
925 IN EFI_STATUS ExitStatus
,
926 IN UINTN ExitDataSize
,
927 IN CHAR16
*ExitData OPTIONAL
933 @param[in] ImageHandle Handle that identifies the image to be unloaded.
935 @retval EFI_SUCCESS The image has been unloaded.
936 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
941 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
942 IN EFI_HANDLE ImageHandle
946 Terminates all boot services.
948 @param[in] ImageHandle Handle that identifies the exiting image.
949 @param[in] MapKey Key to the latest memory map.
951 @retval EFI_SUCCESS Boot services have been terminated.
952 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
957 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
958 IN EFI_HANDLE ImageHandle
,
963 Induces a fine-grained stall.
965 @param[in] Microseconds The number of microseconds to stall execution.
967 @retval EFI_SUCCESS Execution was stalled at least the requested number of
974 IN UINTN Microseconds
978 Sets the system's watchdog timer.
980 @param[in] Timeout The number of seconds to set the watchdog timer to.
981 @param[in] WatchdogCode The numeric code to log on a watchdog timer timeout event.
982 @param[in] DataSize The size, in bytes, of WatchdogData.
983 @param[in] WatchdogData A data buffer that includes a Null-terminated string, optionally
984 followed by additional binary data.
986 @retval EFI_SUCCESS The timeout has been set.
987 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
988 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
989 @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
995 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
997 IN UINT64 WatchdogCode
,
999 IN CHAR16
*WatchdogData OPTIONAL
1003 Resets the entire platform.
1005 @param[in] ResetType The type of reset to perform.
1006 @param[in] ResetStatus The status code for the reset.
1007 @param[in] DataSize The size, in bytes, of WatchdogData.
1008 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
1009 EfiResetShutdown the data buffer starts with a Null-terminated
1010 string, optionally followed by additional binary data.
1015 (EFIAPI
*EFI_RESET_SYSTEM
)(
1016 IN EFI_RESET_TYPE ResetType
,
1017 IN EFI_STATUS ResetStatus
,
1019 IN VOID
*ResetData OPTIONAL
1023 Returns a monotonically increasing count for the platform.
1025 @param[out] Count The pointer to returned value.
1027 @retval EFI_SUCCESS The next monotonic count was returned.
1028 @retval EFI_INVALID_PARAMETER Count is NULL.
1029 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1034 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1039 Returns the next high 32 bits of the platform's monotonic counter.
1041 @param[out] HighCount The pointer to returned value.
1043 @retval EFI_SUCCESS The next high monotonic count was returned.
1044 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1045 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1050 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1051 OUT UINT32
*HighCount
1055 Computes and returns a 32-bit CRC for a data buffer.
1057 @param[in] Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1058 @param[in] DataSize The number of bytes in the buffer Data.
1059 @param[out] Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1062 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1064 @retval EFI_INVALID_PARAMETER Data is NULL.
1065 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1066 @retval EFI_INVALID_PARAMETER DataSize is 0.
1071 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1078 Copies the contents of one buffer to another buffer.
1080 @param[in] Destination The pointer to the destination buffer of the memory copy.
1081 @param[in] Source The pointer to the source buffer of the memory copy.
1082 @param[in] Length Number of bytes to copy from Source to Destination.
1087 (EFIAPI
*EFI_COPY_MEM
)(
1088 IN VOID
*Destination
,
1094 The SetMem() function fills a buffer with a specified value.
1096 @param[in] Buffer The pointer to the buffer to fill.
1097 @param[in] Size Number of bytes in Buffer to fill.
1098 @param[in] Value Value to fill Buffer with.
1103 (EFIAPI
*EFI_SET_MEM
)(
1110 /// Enumeration of EFI Interface Types
1114 /// Indicates that the supplied protocol interface is supplied in native form.
1116 EFI_NATIVE_INTERFACE
1117 } EFI_INTERFACE_TYPE
;
1120 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1121 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1122 more error checking than InstallProtocolInterface(), so it is recommended that
1123 InstallMultipleProtocolInterfaces() be used in place of
1124 InstallProtocolInterface()
1126 @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1127 @param[in] Protocol The numeric ID of the protocol interface.
1128 @param[in] InterfaceType Indicates whether Interface is supplied in native form.
1129 @param[in] Interface A pointer to the protocol interface.
1131 @retval EFI_SUCCESS The protocol interface was installed.
1132 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1133 @retval EFI_INVALID_PARAMETER Handle is NULL.
1134 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1135 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1136 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1141 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1142 IN OUT EFI_HANDLE
*Handle
,
1143 IN EFI_GUID
*Protocol
,
1144 IN EFI_INTERFACE_TYPE InterfaceType
,
1149 Installs one or more protocol interfaces into the boot services environment.
1151 @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on,
1152 or a pointer to NULL if a new handle is to be allocated.
1153 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1156 @retval EFI_SUCCESS All the protocol interface was installed.
1157 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1158 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1159 the handle database.
1160 @retval EFI_INVALID_PARAMETER Handle is NULL.
1161 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1166 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1167 IN OUT EFI_HANDLE
*Handle
,
1172 Reinstalls a protocol interface on a device handle.
1174 @param[in] Handle Handle on which the interface is to be reinstalled.
1175 @param[in] Protocol The numeric ID of the interface.
1176 @param[in] OldInterface A pointer to the old interface. NULL can be used if a structure is not
1177 associated with Protocol.
1178 @param[in] NewInterface A pointer to the new interface.
1180 @retval EFI_SUCCESS The protocol interface was reinstalled.
1181 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1182 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1183 because OldInterface is still being used by a
1184 driver that will not release it.
1185 @retval EFI_INVALID_PARAMETER Handle is NULL.
1186 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1191 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1192 IN EFI_HANDLE Handle
,
1193 IN EFI_GUID
*Protocol
,
1194 IN VOID
*OldInterface
,
1195 IN VOID
*NewInterface
1199 Removes a protocol interface from a device handle. It is recommended that
1200 UninstallMultipleProtocolInterfaces() be used in place of
1201 UninstallProtocolInterface().
1203 @param[in] Handle The handle on which the interface was installed.
1204 @param[in] Protocol The numeric ID of the interface.
1205 @param[in] Interface A pointer to the interface.
1207 @retval EFI_SUCCESS The interface was removed.
1208 @retval EFI_NOT_FOUND The interface was not found.
1209 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1210 is still being used by a driver.
1211 @retval EFI_INVALID_PARAMETER Handle is NULL.
1212 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1217 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1218 IN EFI_HANDLE Handle
,
1219 IN EFI_GUID
*Protocol
,
1224 Removes one or more protocol interfaces into the boot services environment.
1226 @param[in] Handle The handle to remove the protocol interfaces from.
1227 @param ... A variable argument list containing pairs of protocol GUIDs and
1228 protocol interfaces.
1230 @retval EFI_SUCCESS All the protocol interfaces were removed.
1231 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1236 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1237 IN EFI_HANDLE Handle
,
1242 Queries a handle to determine if it supports a specified protocol.
1244 @param[in] Handle The handle being queried.
1245 @param[in] Protocol The published unique identifier of the protocol.
1246 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1247 Interface is returned.
1249 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1250 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1251 @retval EFI_INVALID_PARAMETER Handle is NULL.
1252 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1253 @retval EFI_INVALID_PARAMETER Interface is NULL.
1258 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1259 IN EFI_HANDLE Handle
,
1260 IN EFI_GUID
*Protocol
,
1261 OUT VOID
**Interface
1264 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1265 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1266 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1267 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1268 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1269 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1272 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1273 handle, it opens the protocol on behalf of the calling agent.
1275 @param[in] Handle The handle for the protocol interface that is being opened.
1276 @param[in] Protocol The published unique identifier of the protocol.
1277 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1278 Interface is returned.
1279 @param[in] AgentHandle The handle of the agent that is opening the protocol interface
1280 specified by Protocol and Interface.
1281 @param[in] ControllerHandle If the agent that is opening a protocol is a driver that follows the
1282 UEFI Driver Model, then this parameter is the controller handle
1283 that requires the protocol interface. If the agent does not follow
1284 the UEFI Driver Model, then this parameter is optional and may
1286 @param[in] Attributes The open mode of the protocol interface specified by Handle
1289 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1290 protocol interface was returned in Interface.
1291 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1292 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1293 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1294 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1295 handle is the same as AgentHandle.
1300 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1301 IN EFI_HANDLE Handle
,
1302 IN EFI_GUID
*Protocol
,
1303 OUT VOID
**Interface
, OPTIONAL
1304 IN EFI_HANDLE AgentHandle
,
1305 IN EFI_HANDLE ControllerHandle
,
1306 IN UINT32 Attributes
1311 Closes a protocol on a handle that was opened using OpenProtocol().
1313 @param[in] Handle The handle for the protocol interface that was previously opened
1314 with OpenProtocol(), and is now being closed.
1315 @param[in] Protocol The published unique identifier of the protocol.
1316 @param[in] AgentHandle The handle of the agent that is closing the protocol interface.
1317 @param[in] ControllerHandle If the agent that opened a protocol is a driver that follows the
1318 UEFI Driver Model, then this parameter is the controller handle
1319 that required the protocol interface.
1321 @retval EFI_SUCCESS The protocol instance was closed.
1322 @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
1323 2) AgentHandle is NULL.
1324 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1325 4) Protocol is NULL.
1326 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1327 2) The protocol interface specified by Handle and Protocol is not
1328 currently open by AgentHandle and ControllerHandle.
1333 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1334 IN EFI_HANDLE Handle
,
1335 IN EFI_GUID
*Protocol
,
1336 IN EFI_HANDLE AgentHandle
,
1337 IN EFI_HANDLE ControllerHandle
1341 /// EFI Oprn Protocol Information Entry
1344 EFI_HANDLE AgentHandle
;
1345 EFI_HANDLE ControllerHandle
;
1348 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1351 Retrieves the list of agents that currently have a protocol interface opened.
1353 @param[in] Handle The handle for the protocol interface that is being queried.
1354 @param[in] Protocol The published unique identifier of the protocol.
1355 @param[out] EntryBuffer A pointer to a buffer of open protocol information in the form of
1356 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1357 @param[out] EntryCount A pointer to the number of entries in EntryBuffer.
1359 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1360 number of entries was returned EntryCount.
1361 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1362 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1367 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1368 IN EFI_HANDLE Handle
,
1369 IN EFI_GUID
*Protocol
,
1370 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1371 OUT UINTN
*EntryCount
1375 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1378 @param[in] Handle The handle from which to retrieve the list of protocol interface
1380 @param[out] ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1381 installed on Handle.
1382 @param[out] ProtocolBufferCount A pointer to the number of GUID pointers present in
1385 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1386 ProtocolBuffer. The number of protocol interface GUIDs was
1387 returned in ProtocolBufferCount.
1388 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1389 @retval EFI_INVALID_PARAMETER Handle is NULL.
1390 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1391 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1392 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1397 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1398 IN EFI_HANDLE Handle
,
1399 OUT EFI_GUID
***ProtocolBuffer
,
1400 OUT UINTN
*ProtocolBufferCount
1404 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1406 @param[in] Protocol The numeric ID of the protocol for which the event is to be registered.
1407 @param[in] Event Event that is to be signaled whenever a protocol interface is registered
1409 @param[out] Registration A pointer to a memory location to receive the registration value.
1411 @retval EFI_SUCCESS The notification event has been registered.
1412 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1413 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1414 @retval EFI_INVALID_PARAMETER Event is NULL.
1415 @retval EFI_INVALID_PARAMETER Registration is NULL.
1420 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1421 IN EFI_GUID
*Protocol
,
1423 OUT VOID
**Registration
1427 /// Enumeration of EFI Locate Search Types
1431 /// Retrieve all the handles in the handle database.
1435 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1439 /// Retrieve the set of handles from the handle database that support a
1440 /// specified protocol.
1443 } EFI_LOCATE_SEARCH_TYPE
;
1446 Returns an array of handles that support a specified protocol.
1448 @param[in] SearchType Specifies which handle(s) are to be returned.
1449 @param[in] Protocol Specifies the protocol to search by.
1450 @param[in] SearchKey Specifies the search key.
1451 @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1452 the array returned in Buffer (if the buffer was large enough) or the
1453 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1455 @param[out] Buffer The buffer in which the array is returned.
1457 @retval EFI_SUCCESS The array of handles was returned.
1458 @retval EFI_NOT_FOUND No handles match the search.
1459 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1460 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1461 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1462 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1463 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1464 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1469 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1470 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1471 IN EFI_GUID
*Protocol
, OPTIONAL
1472 IN VOID
*SearchKey
, OPTIONAL
1473 IN OUT UINTN
*BufferSize
,
1474 OUT EFI_HANDLE
*Buffer
1478 Locates the handle to a device on the device path that supports the specified protocol.
1480 @param[in] Protocol Specifies the protocol to search for.
1481 @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device
1482 path pointer is modified to point to the remaining part of the device
1484 @param[out] Device A pointer to the returned device handle.
1486 @retval EFI_SUCCESS The resulting handle was returned.
1487 @retval EFI_NOT_FOUND No handles match the search.
1488 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1489 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1490 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1495 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1496 IN EFI_GUID
*Protocol
,
1497 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1498 OUT EFI_HANDLE
*Device
1502 Adds, updates, or removes a configuration table entry from the EFI System Table.
1504 @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.
1505 @param[in] Table A pointer to the configuration table for the entry to add, update, or
1506 remove. May be NULL.
1508 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1509 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1510 @retval EFI_INVALID_PARAMETER Guid is NULL.
1511 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1516 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1522 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1524 @param[in] SearchType Specifies which handle(s) are to be returned.
1525 @param[in] Protocol Provides the protocol to search by.
1526 This parameter is only valid for a SearchType of ByProtocol.
1527 @param[in] SearchKey Supplies the search key depending on the SearchType.
1528 @param[in, out] NoHandles The number of handles returned in Buffer.
1529 @param[out] Buffer A pointer to the buffer to return the requested array of handles that
1532 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1533 handles in Buffer was returned in NoHandles.
1534 @retval EFI_NOT_FOUND No handles match the search.
1535 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1536 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1537 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1542 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1543 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1544 IN EFI_GUID
*Protocol
, OPTIONAL
1545 IN VOID
*SearchKey
, OPTIONAL
1546 IN OUT UINTN
*NoHandles
,
1547 OUT EFI_HANDLE
**Buffer
1551 Returns the first protocol instance that matches the given protocol.
1553 @param[in] Protocol Provides the protocol to search for.
1554 @param[in] Registration Optional registration key returned from
1555 RegisterProtocolNotify().
1556 @param[out] Interface On return, a pointer to the first interface that matches Protocol and
1559 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1561 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1563 @retval EFI_INVALID_PARAMETER Interface is NULL.
1568 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1569 IN EFI_GUID
*Protocol
,
1570 IN VOID
*Registration
, OPTIONAL
1571 OUT VOID
**Interface
1575 /// EFI Capsule Block Descriptor
1579 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1584 /// Physical address of the data block. This member of the union is
1585 /// used if Length is not equal to zero.
1587 EFI_PHYSICAL_ADDRESS DataBlock
;
1589 /// Physical address of another block of
1590 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1591 /// member of the union is used if Length is equal to zero. If
1592 /// ContinuationPointer is zero this entry represents the end of the list.
1594 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1596 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1599 /// EFI Capsule Header.
1603 /// A GUID that defines the contents of a capsule.
1605 EFI_GUID CapsuleGuid
;
1607 /// The size of the capsule header. This may be larger than the size of
1608 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1609 /// extended header entries
1613 /// Bit-mapped list describing the capsule attributes. The Flag values
1614 /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
1615 /// of 0x10000 - 0xFFFFFFFF are defined by this specification
1619 /// Size in bytes of the capsule.
1621 UINT32 CapsuleImageSize
;
1622 } EFI_CAPSULE_HEADER
;
1625 /// The EFI System Table entry must point to an array of capsules
1626 /// that contain the same CapsuleGuid value. The array must be
1627 /// prefixed by a UINT32 that represents the size of the array of capsules.
1631 /// the size of the array of capsules.
1633 UINT32 CapsuleArrayNumber
;
1635 /// Point to an array of capsules that contain the same CapsuleGuid value.
1637 VOID
* CapsulePtr
[1];
1638 } EFI_CAPSULE_TABLE
;
1640 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1641 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1642 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
1645 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1646 consumption, the firmware may process the capsule immediately. If the payload should persist
1647 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1648 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1649 part of the reset process.
1651 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1652 being passed into update capsule.
1653 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1655 @param[in] ScatterGatherList Physical pointer to a set of
1656 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1657 location in physical memory of a set of capsules.
1659 @retval EFI_SUCCESS Valid capsule was passed. If
1660 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1661 capsule has been successfully processed by the firmware.
1662 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
1663 set in the capsule header.
1664 @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
1665 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1666 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1667 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1668 is compatible with this platform but is not capable of being submitted or processed
1669 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1670 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1671 the capsule is compatible with this platform but there are insufficient resources to process.
1676 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1677 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1678 IN UINTN CapsuleCount
,
1679 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1683 Returns if the capsule can be supported via UpdateCapsule().
1685 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1686 being passed into update capsule.
1687 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1689 @param[out] MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1690 support as an argument to UpdateCapsule() via
1691 CapsuleHeaderArray and ScatterGatherList.
1692 @param[out] ResetType Returns the type of reset required for the capsule update.
1694 @retval EFI_SUCCESS Valid answer returned.
1695 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1696 MaximumCapsuleSize and ResetType are undefined.
1697 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1698 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1699 is compatible with this platform but is not capable of being submitted or processed
1700 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1701 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1702 the capsule is compatible with this platform but there are insufficient resources to process.
1707 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1708 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1709 IN UINTN CapsuleCount
,
1710 OUT UINT64
*MaximumCapsuleSize
,
1711 OUT EFI_RESET_TYPE
*ResetType
1715 Returns information about the EFI variables.
1717 @param[in] Attributes Attributes bitmask to specify the type of variables on
1718 which to return information.
1719 @param[out] MaximumVariableStorageSize On output the maximum size of the storage space
1720 available for the EFI variables associated with the
1721 attributes specified.
1722 @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space
1723 available for the EFI variables associated with the
1724 attributes specified.
1725 @param[out] MaximumVariableSize Returns the maximum size of the individual EFI
1726 variables associated with the attributes specified.
1728 @retval EFI_SUCCESS Valid answer returned.
1729 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1730 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1731 MaximumVariableStorageSize,
1732 RemainingVariableStorageSize, MaximumVariableSize
1738 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1739 IN UINT32 Attributes
,
1740 OUT UINT64
*MaximumVariableStorageSize
,
1741 OUT UINT64
*RemainingVariableStorageSize
,
1742 OUT UINT64
*MaximumVariableSize
1746 // Firmware should stop at a firmware user interface on next boot
1748 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
1749 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
1750 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
1751 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
1752 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
1753 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
1756 // EFI Runtime Services Table
1758 #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1759 #define EFI_2_60_SYSTEM_TABLE_REVISION ((2 << 16) | (60))
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_60_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>