2 Include file that supports UEFI.
4 This include file must contain things defined in the UEFI 2.7 specification.
5 If a code construct is defined in the UEFI 2.7 specification it must be included
8 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
9 SPDX-License-Identifier: BSD-2-Clause-Patent
13 #ifndef __UEFI_SPEC_H__
14 #define __UEFI_SPEC_H__
16 #include <Uefi/UefiMultiPhase.h>
18 #include <Protocol/DevicePath.h>
19 #include <Protocol/SimpleTextIn.h>
20 #include <Protocol/SimpleTextInEx.h>
21 #include <Protocol/SimpleTextOut.h>
24 /// Enumeration of EFI memory allocation types.
28 /// Allocate any available range of pages that satisfies the request.
32 /// Allocate any available range of pages whose uppermost address is less than
33 /// or equal to a specified maximum address.
37 /// Allocate pages at a specified address.
41 /// Maximum enumeration value that may be used for bounds checking.
47 // Bit definitions for EFI_TIME.Daylight
49 #define EFI_TIME_ADJUST_DAYLIGHT 0x01
50 #define EFI_TIME_IN_DAYLIGHT 0x02
53 /// Value definition for EFI_TIME.TimeZone.
55 #define EFI_UNSPECIFIED_TIMEZONE 0x07FF
58 // Memory cacheability attributes
60 #define EFI_MEMORY_UC 0x0000000000000001ULL
61 #define EFI_MEMORY_WC 0x0000000000000002ULL
62 #define EFI_MEMORY_WT 0x0000000000000004ULL
63 #define EFI_MEMORY_WB 0x0000000000000008ULL
64 #define EFI_MEMORY_UCE 0x0000000000000010ULL
66 // Physical memory protection attributes
68 // Note: UEFI spec 2.5 and following: use EFI_MEMORY_RO as write-protected physical memory
69 // protection attribute. Also, EFI_MEMORY_WP means cacheability attribute.
71 #define EFI_MEMORY_WP 0x0000000000001000ULL
72 #define EFI_MEMORY_RP 0x0000000000002000ULL
73 #define EFI_MEMORY_XP 0x0000000000004000ULL
74 #define EFI_MEMORY_RO 0x0000000000020000ULL
76 // Physical memory persistence attribute.
77 // The memory region supports byte-addressable non-volatility.
79 #define EFI_MEMORY_NV 0x0000000000008000ULL
81 // The memory region provides higher reliability relative to other memory in the system.
82 // If all memory has the same reliability, then this bit is not used.
84 #define EFI_MEMORY_MORE_RELIABLE 0x0000000000010000ULL
87 // Note: UEFI spec 2.8 and following:
89 // Specific-purpose memory (SPM). The memory is earmarked for
90 // specific purposes such as for specific device drivers or applications.
91 // The SPM attribute serves as a hint to the OS to avoid allocating this
92 // memory for core OS data or code that can not be relocated.
94 #define EFI_MEMORY_SP 0x0000000000040000ULL
96 // If this flag is set, the memory region is capable of being
97 // protected with the CPU?s memory cryptographic
98 // capabilities. If this flag is clear, the memory region is not
99 // capable of being protected with the CPU?s memory
100 // cryptographic capabilities or the CPU does not support CPU
101 // memory cryptographic capabilities.
103 #define EFI_MEMORY_CPU_CRYPTO 0x0000000000080000ULL
106 // Runtime memory attribute
108 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
111 /// Memory descriptor version number.
113 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
116 /// Definition of an EFI memory descriptor.
120 /// Type of the memory region.
121 /// Type EFI_MEMORY_TYPE is defined in the
122 /// AllocatePages() function description.
126 /// Physical address of the first byte in the memory region. PhysicalStart must be
127 /// aligned on a 4 KiB boundary, and must not be above 0xfffffffffffff000. Type
128 /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function description
130 EFI_PHYSICAL_ADDRESS PhysicalStart
;
132 /// Virtual address of the first byte in the memory region.
133 /// VirtualStart must be aligned on a 4 KiB boundary,
134 /// and must not be above 0xfffffffffffff000.
136 EFI_VIRTUAL_ADDRESS VirtualStart
;
138 /// NumberOfPagesNumber of 4 KiB pages in the memory region.
139 /// NumberOfPages must not be 0, and must not be any value
140 /// that would represent a memory page with a start address,
141 /// either physical or virtual, above 0xfffffffffffff000.
143 UINT64 NumberOfPages
;
145 /// Attributes of the memory region that describe the bit mask of capabilities
146 /// for that memory region, and not necessarily the current settings for that
150 } EFI_MEMORY_DESCRIPTOR
;
153 Allocates memory pages from the system.
155 @param[in] Type The type of allocation to perform.
156 @param[in] MemoryType The type of memory to allocate.
157 MemoryType values in the range 0x70000000..0x7FFFFFFF
158 are reserved for OEM use. MemoryType values in the range
159 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders
160 that are provided by operating system vendors.
161 @param[in] Pages The number of contiguous 4 KB pages to allocate.
162 @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is
163 used depends on the value of Type.
165 @retval EFI_SUCCESS The requested pages were allocated.
166 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
167 AllocateMaxAddress or AllocateAddress.
168 2) MemoryType is in the range
169 EfiMaxMemoryType..0x6FFFFFFF.
171 4) MemoryType is EfiPersistentMemory.
172 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
173 @retval EFI_NOT_FOUND The requested pages could not be found.
178 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
179 IN EFI_ALLOCATE_TYPE Type
,
180 IN EFI_MEMORY_TYPE MemoryType
,
182 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
188 @param[in] Memory The base physical address of the pages to be freed.
189 @param[in] Pages The number of contiguous 4 KB pages to free.
191 @retval EFI_SUCCESS The requested pages were freed.
192 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
193 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
199 (EFIAPI
*EFI_FREE_PAGES
)(
200 IN EFI_PHYSICAL_ADDRESS Memory
,
205 Returns the current memory map.
207 @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
208 On input, this is the size of the buffer allocated by the caller.
209 On output, it is the size of the buffer returned by the firmware if
210 the buffer was large enough, or the size of the buffer needed to contain
211 the map if the buffer was too small.
212 @param[in, out] MemoryMap A pointer to the buffer in which firmware places the current memory
214 @param[out] MapKey A pointer to the location in which firmware returns the key for the
216 @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
217 an individual EFI_MEMORY_DESCRIPTOR.
218 @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number
219 associated with the EFI_MEMORY_DESCRIPTOR.
221 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
222 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
223 needed to hold the memory map is returned in MemoryMapSize.
224 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
225 2) The MemoryMap buffer is not too small and MemoryMap is
231 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
232 IN OUT UINTN
*MemoryMapSize
,
233 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
235 OUT UINTN
*DescriptorSize
,
236 OUT UINT32
*DescriptorVersion
240 Allocates pool memory.
242 @param[in] PoolType The type of pool to allocate.
243 MemoryType values in the range 0x70000000..0x7FFFFFFF
244 are reserved for OEM use. MemoryType values in the range
245 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders
246 that are provided by operating system vendors.
247 @param[in] Size The number of bytes to allocate from the pool.
248 @param[out] Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
251 @retval EFI_SUCCESS The requested number of bytes was allocated.
252 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
253 @retval EFI_INVALID_PARAMETER Buffer is NULL.
254 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.
255 PoolType is EfiPersistentMemory.
260 (EFIAPI
*EFI_ALLOCATE_POOL
)(
261 IN EFI_MEMORY_TYPE PoolType
,
267 Returns pool memory to the system.
269 @param[in] Buffer The pointer to the buffer to free.
271 @retval EFI_SUCCESS The memory was returned to the system.
272 @retval EFI_INVALID_PARAMETER Buffer was invalid.
277 (EFIAPI
*EFI_FREE_POOL
)(
282 Changes the runtime addressing mode of EFI firmware from physical to virtual.
284 @param[in] MemoryMapSize The size in bytes of VirtualMap.
285 @param[in] DescriptorSize The size in bytes of an entry in the VirtualMap.
286 @param[in] DescriptorVersion The version of the structure entries in VirtualMap.
287 @param[in] VirtualMap An array of memory descriptors which contain new virtual
288 address mapping information for all runtime ranges.
290 @retval EFI_SUCCESS The virtual address map has been applied.
291 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
292 virtual address mapped mode.
293 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
294 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
295 map that requires a mapping.
296 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
302 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
303 IN UINTN MemoryMapSize
,
304 IN UINTN DescriptorSize
,
305 IN UINT32 DescriptorVersion
,
306 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
310 Connects one or more drivers to a controller.
312 @param[in] ControllerHandle The handle of the controller to which driver(s) are to be connected.
313 @param[in] DriverImageHandle A pointer to an ordered list handles that support the
314 EFI_DRIVER_BINDING_PROTOCOL.
315 @param[in] RemainingDevicePath A pointer to the device path that specifies a child of the
316 controller specified by ControllerHandle.
317 @param[in] Recursive If TRUE, then ConnectController() is called recursively
318 until the entire tree of controllers below the controller specified
319 by ControllerHandle have been created. If FALSE, then
320 the tree of controllers is only expanded one level.
322 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
323 2) No drivers were connected to ControllerHandle, but
324 RemainingDevicePath is not NULL, and it is an End Device
326 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
327 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
328 present in the system.
329 2) No drivers were connected to ControllerHandle.
330 @retval EFI_SECURITY_VIOLATION
331 The user has no permission to start UEFI device drivers on the device path
332 associated with the ControllerHandle or specified by the RemainingDevicePath.
336 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
337 IN EFI_HANDLE ControllerHandle
,
338 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
339 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
344 Disconnects one or more drivers from a controller.
346 @param[in] ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
347 @param[in] DriverImageHandle The driver to disconnect from ControllerHandle.
348 If DriverImageHandle is NULL, then all the drivers currently managing
349 ControllerHandle are disconnected from ControllerHandle.
350 @param[in] ChildHandle The handle of the child to destroy.
351 If ChildHandle is NULL, then all the children of ControllerHandle are
352 destroyed before the drivers are disconnected from ControllerHandle.
354 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
355 2) On entry, no drivers are managing ControllerHandle.
356 3) DriverImageHandle is not NULL, and on entry
357 DriverImageHandle is not managing ControllerHandle.
358 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
359 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
360 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
361 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
362 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
364 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
369 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
370 IN EFI_HANDLE ControllerHandle
,
371 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
372 IN EFI_HANDLE ChildHandle OPTIONAL
378 // ConvertPointer DebugDisposition type.
380 #define EFI_OPTIONAL_PTR 0x00000001
383 Determines the new virtual address that is to be used on subsequent memory accesses.
385 @param[in] DebugDisposition Supplies type information for the pointer being converted.
386 @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed
387 for the new virtual address mappings being applied.
389 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
390 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
391 2) *Address is NULL and DebugDisposition does
392 not have the EFI_OPTIONAL_PTR bit set.
393 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
394 of the current memory map. This is normally fatal.
399 (EFIAPI
*EFI_CONVERT_POINTER
)(
400 IN UINTN DebugDisposition
,
401 IN OUT VOID
**Address
406 // These types can be ORed together as needed - for example,
407 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
408 // EVT_NOTIFY_SIGNAL.
410 #define EVT_TIMER 0x80000000
411 #define EVT_RUNTIME 0x40000000
412 #define EVT_NOTIFY_WAIT 0x00000100
413 #define EVT_NOTIFY_SIGNAL 0x00000200
415 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
416 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
419 // The event's NotifyContext pointer points to a runtime memory
421 // The event is deprecated in UEFI2.0 and later specifications.
423 #define EVT_RUNTIME_CONTEXT 0x20000000
427 Invoke a notification event
429 @param[in] Event Event whose notification function is being invoked.
430 @param[in] Context The pointer to the notification function's context,
431 which is implementation-dependent.
436 (EFIAPI
*EFI_EVENT_NOTIFY
)(
444 @param[in] Type The type of event to create and its mode and attributes.
445 @param[in] NotifyTpl The task priority level of event notifications, if needed.
446 @param[in] NotifyFunction The pointer to the event's notification function, if any.
447 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
448 Context in the notification function.
449 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
452 @retval EFI_SUCCESS The event structure was created.
453 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
454 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
459 (EFIAPI
*EFI_CREATE_EVENT
)(
461 IN EFI_TPL NotifyTpl
,
462 IN EFI_EVENT_NOTIFY NotifyFunction
,
463 IN VOID
*NotifyContext
,
468 Creates an event in a group.
470 @param[in] Type The type of event to create and its mode and attributes.
471 @param[in] NotifyTpl The task priority level of event notifications,if needed.
472 @param[in] NotifyFunction The pointer to the event's notification function, if any.
473 @param[in] NotifyContext The pointer to the notification function's context; corresponds to parameter
474 Context in the notification function.
475 @param[in] EventGroup The pointer to the unique identifier of the group to which this event belongs.
476 If this is NULL, then the function behaves as if the parameters were passed
478 @param[out] Event The pointer to the newly created event if the call succeeds; undefined
481 @retval EFI_SUCCESS The event structure was created.
482 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
483 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
488 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
490 IN EFI_TPL NotifyTpl
,
491 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
492 IN CONST VOID
*NotifyContext OPTIONAL
,
493 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
498 /// Timer delay types
502 /// An event's timer settings is to be cancelled and not trigger time is to be set/
506 /// An event is to be signaled periodically at a specified interval from the current time.
510 /// An event is to be signaled once at a specified interval from the current time.
516 Sets the type of timer and the trigger time for a timer event.
518 @param[in] Event The timer event that is to be signaled at the specified time.
519 @param[in] Type The type of time that is specified in TriggerTime.
520 @param[in] TriggerTime The number of 100ns units until the timer expires.
521 A TriggerTime of 0 is legal.
522 If Type is TimerRelative and TriggerTime is 0, then the timer
523 event will be signaled on the next timer tick.
524 If Type is TimerPeriodic and TriggerTime is 0, then the timer
525 event will be signaled on every timer tick.
527 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
528 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
533 (EFIAPI
*EFI_SET_TIMER
)(
535 IN EFI_TIMER_DELAY Type
,
536 IN UINT64 TriggerTime
542 @param[in] Event The event to signal.
544 @retval EFI_SUCCESS The event has been signaled.
549 (EFIAPI
*EFI_SIGNAL_EVENT
)(
554 Stops execution until an event is signaled.
556 @param[in] NumberOfEvents The number of events in the Event array.
557 @param[in] Event An array of EFI_EVENT.
558 @param[out] Index The pointer to the index of the event which satisfied the wait condition.
560 @retval EFI_SUCCESS The event indicated by Index was signaled.
561 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
562 2) The event indicated by Index is of type
564 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
569 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
570 IN UINTN NumberOfEvents
,
578 @param[in] Event The event to close.
580 @retval EFI_SUCCESS The event has been closed.
585 (EFIAPI
*EFI_CLOSE_EVENT
)(
590 Checks whether an event is in the signaled state.
592 @param[in] Event The event to check.
594 @retval EFI_SUCCESS The event is in the signaled state.
595 @retval EFI_NOT_READY The event is not in the signaled state.
596 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
601 (EFIAPI
*EFI_CHECK_EVENT
)(
607 // Task priority level
609 #define TPL_APPLICATION 4
610 #define TPL_CALLBACK 8
611 #define TPL_NOTIFY 16
612 #define TPL_HIGH_LEVEL 31
616 Raises a task's priority level and returns its previous level.
618 @param[in] NewTpl The new task priority level.
620 @return Previous task priority level
625 (EFIAPI
*EFI_RAISE_TPL
)(
630 Restores a task's priority level to its previous value.
632 @param[in] OldTpl The previous task priority level to restore.
637 (EFIAPI
*EFI_RESTORE_TPL
)(
642 Returns the value of a variable.
644 @param[in] VariableName A Null-terminated string that is the name of the vendor's
646 @param[in] VendorGuid A unique identifier for the vendor.
647 @param[out] Attributes If not NULL, a pointer to the memory location to return the
648 attributes bitmask for the variable.
649 @param[in, out] DataSize On input, the size in bytes of the return Data buffer.
650 On output the size of data returned in Data.
651 @param[out] Data The buffer to return the contents of the variable. May be NULL
652 with a zero DataSize in order to determine the size buffer needed.
654 @retval EFI_SUCCESS The function completed successfully.
655 @retval EFI_NOT_FOUND The variable was not found.
656 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
657 @retval EFI_INVALID_PARAMETER VariableName is NULL.
658 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
659 @retval EFI_INVALID_PARAMETER DataSize is NULL.
660 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
661 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
662 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
667 (EFIAPI
*EFI_GET_VARIABLE
)(
668 IN CHAR16
*VariableName
,
669 IN EFI_GUID
*VendorGuid
,
670 OUT UINT32
*Attributes
, OPTIONAL
671 IN OUT UINTN
*DataSize
,
672 OUT VOID
*Data OPTIONAL
676 Enumerates the current variable names.
678 @param[in, out] VariableNameSize The size of the VariableName buffer. The size must be large
679 enough to fit input string supplied in VariableName buffer.
680 @param[in, out] VariableName On input, supplies the last VariableName that was returned
681 by GetNextVariableName(). On output, returns the Nullterminated
682 string of the current variable.
683 @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by
684 GetNextVariableName(). On output, returns the
685 VendorGuid of the current variable.
687 @retval EFI_SUCCESS The function completed successfully.
688 @retval EFI_NOT_FOUND The next variable was not found.
689 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
690 VariableNameSize has been updated with the size needed to complete the request.
691 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
692 @retval EFI_INVALID_PARAMETER VariableName is NULL.
693 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
694 @retval EFI_INVALID_PARAMETER The input values of VariableName and VendorGuid are not a name and
695 GUID of an existing variable.
696 @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of
697 the input VariableName buffer.
698 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
703 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
704 IN OUT UINTN
*VariableNameSize
,
705 IN OUT CHAR16
*VariableName
,
706 IN OUT EFI_GUID
*VendorGuid
710 Sets the value of a variable.
712 @param[in] VariableName A Null-terminated string that is the name of the vendor's variable.
713 Each VariableName is unique for each VendorGuid. VariableName must
714 contain 1 or more characters. If VariableName is an empty string,
715 then EFI_INVALID_PARAMETER is returned.
716 @param[in] VendorGuid A unique identifier for the vendor.
717 @param[in] Attributes Attributes bitmask to set for the variable.
718 @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE or
719 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
720 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
721 set, then a SetVariable() call with a DataSize of zero will not cause any change to
722 the variable value (the timestamp associated with the variable may be updated however
723 even if no new data value is provided,see the description of the
724 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
725 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
726 @param[in] Data The contents for the variable.
728 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
729 defined by the Attributes.
730 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
731 DataSize exceeds the maximum allowed.
732 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
733 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
734 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
735 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
736 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
737 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set,
738 but the AuthInfo does NOT pass the validation check carried out by the firmware.
740 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
745 (EFIAPI
*EFI_SET_VARIABLE
)(
746 IN CHAR16
*VariableName
,
747 IN EFI_GUID
*VendorGuid
,
748 IN UINT32 Attributes
,
755 /// This provides the capabilities of the
756 /// real time clock device as exposed through the EFI interfaces.
760 /// Provides the reporting resolution of the real-time clock device in
761 /// counts per second. For a normal PC-AT CMOS RTC device, this
762 /// value would be 1 Hz, or 1, to indicate that the device only reports
763 /// the time to the resolution of 1 second.
767 /// Provides the timekeeping accuracy of the real-time clock in an
768 /// error rate of 1E-6 parts per million. For a clock with an accuracy
769 /// of 50 parts per million, the value in this field would be
774 /// A TRUE indicates that a time set operation clears the device's
775 /// time below the Resolution reporting level. A FALSE
776 /// indicates that the state below the Resolution level of the
777 /// device is not cleared when the time is set. Normal PC-AT CMOS
778 /// RTC devices set this value to FALSE.
781 } EFI_TIME_CAPABILITIES
;
784 Returns the current time and date information, and the time-keeping capabilities
785 of the hardware platform.
787 @param[out] Time A pointer to storage to receive a snapshot of the current time.
788 @param[out] Capabilities An optional pointer to a buffer to receive the real time clock
789 device's capabilities.
791 @retval EFI_SUCCESS The operation completed successfully.
792 @retval EFI_INVALID_PARAMETER Time is NULL.
793 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
798 (EFIAPI
*EFI_GET_TIME
)(
800 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
804 Sets the current local time and date information.
806 @param[in] Time A pointer to the current time.
808 @retval EFI_SUCCESS The operation completed successfully.
809 @retval EFI_INVALID_PARAMETER A time field is out of range.
810 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
815 (EFIAPI
*EFI_SET_TIME
)(
820 Returns the current wakeup alarm clock setting.
822 @param[out] Enabled Indicates if the alarm is currently enabled or disabled.
823 @param[out] Pending Indicates if the alarm signal is pending and requires acknowledgement.
824 @param[out] Time The current alarm setting.
826 @retval EFI_SUCCESS The alarm settings were returned.
827 @retval EFI_INVALID_PARAMETER Enabled is NULL.
828 @retval EFI_INVALID_PARAMETER Pending is NULL.
829 @retval EFI_INVALID_PARAMETER Time is NULL.
830 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
831 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
836 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
837 OUT BOOLEAN
*Enabled
,
838 OUT BOOLEAN
*Pending
,
843 Sets the system wakeup alarm clock time.
845 @param[in] Enable Enable or disable the wakeup alarm.
846 @param[in] Time If Enable is TRUE, the time to set the wakeup alarm for.
847 If Enable is FALSE, then this parameter is optional, and may be NULL.
849 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
850 Enable is FALSE, then the wakeup alarm was disabled.
851 @retval EFI_INVALID_PARAMETER A time field is out of range.
852 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
853 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
858 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
860 IN EFI_TIME
*Time OPTIONAL
864 Loads an EFI image into memory.
866 @param[in] BootPolicy If TRUE, indicates that the request originates from the boot
867 manager, and that the boot manager is attempting to load
868 FilePath as a boot selection. Ignored if SourceBuffer is
870 @param[in] ParentImageHandle The caller's image handle.
871 @param[in] DevicePath The DeviceHandle specific file path from which the image is
873 @param[in] SourceBuffer If not NULL, a pointer to the memory location containing a copy
874 of the image to be loaded.
875 @param[in] SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
876 @param[out] ImageHandle The pointer to the returned image handle that is created when the
877 image is successfully loaded.
879 @retval EFI_SUCCESS Image was loaded into memory correctly.
880 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
881 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
882 @retval EFI_UNSUPPORTED The image type is not supported.
883 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
884 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
886 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
887 @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
888 image from being loaded. NULL is returned in *ImageHandle.
889 @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
890 valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
891 platform policy specifies that the image should not be started.
895 (EFIAPI
*EFI_IMAGE_LOAD
)(
896 IN BOOLEAN BootPolicy
,
897 IN EFI_HANDLE ParentImageHandle
,
898 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
899 IN VOID
*SourceBuffer OPTIONAL
,
901 OUT EFI_HANDLE
*ImageHandle
905 Transfers control to a loaded image's entry point.
907 @param[in] ImageHandle Handle of image to be started.
908 @param[out] ExitDataSize The pointer to the size, in bytes, of ExitData.
909 @param[out] ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
910 string, optionally followed by additional binary data.
912 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
913 has already been initialized with StartImage.
914 @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.
915 @return Exit code from image
920 (EFIAPI
*EFI_IMAGE_START
)(
921 IN EFI_HANDLE ImageHandle
,
922 OUT UINTN
*ExitDataSize
,
923 OUT CHAR16
**ExitData OPTIONAL
927 Terminates a loaded EFI image and returns control to boot services.
929 @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the
931 @param[in] ExitStatus The image's exit code.
932 @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
933 @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string,
934 optionally followed by additional binary data. The string is a
935 description that the caller may use to further indicate the reason
936 for the image's exit. ExitData is only valid if ExitStatus
937 is something other than EFI_SUCCESS. The ExitData buffer
938 must be allocated by calling AllocatePool().
940 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
941 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
942 started with LoadImage() and StartImage(), but the
943 image is not the currently executing image.
949 IN EFI_HANDLE ImageHandle
,
950 IN EFI_STATUS ExitStatus
,
951 IN UINTN ExitDataSize
,
952 IN CHAR16
*ExitData OPTIONAL
958 @param[in] ImageHandle Handle that identifies the image to be unloaded.
960 @retval EFI_SUCCESS The image has been unloaded.
961 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
966 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
967 IN EFI_HANDLE ImageHandle
971 Terminates all boot services.
973 @param[in] ImageHandle Handle that identifies the exiting image.
974 @param[in] MapKey Key to the latest memory map.
976 @retval EFI_SUCCESS Boot services have been terminated.
977 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
982 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
983 IN EFI_HANDLE ImageHandle
,
988 Induces a fine-grained stall.
990 @param[in] Microseconds The number of microseconds to stall execution.
992 @retval EFI_SUCCESS Execution was stalled at least the requested number of
999 IN UINTN Microseconds
1003 Sets the system's watchdog timer.
1005 @param[in] Timeout The number of seconds to set the watchdog timer to.
1006 @param[in] WatchdogCode The numeric code to log on a watchdog timer timeout event.
1007 @param[in] DataSize The size, in bytes, of WatchdogData.
1008 @param[in] WatchdogData A data buffer that includes a Null-terminated string, optionally
1009 followed by additional binary data.
1011 @retval EFI_SUCCESS The timeout has been set.
1012 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
1013 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
1014 @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
1020 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
1022 IN UINT64 WatchdogCode
,
1024 IN CHAR16
*WatchdogData OPTIONAL
1028 Resets the entire platform.
1030 @param[in] ResetType The type of reset to perform.
1031 @param[in] ResetStatus The status code for the reset.
1032 @param[in] DataSize The size, in bytes, of ResetData.
1033 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
1034 EfiResetShutdown the data buffer starts with a Null-terminated
1035 string, optionally followed by additional binary data.
1036 The string is a description that the caller may use to further
1037 indicate the reason for the system reset.
1038 For a ResetType of EfiResetPlatformSpecific the data buffer
1039 also starts with a Null-terminated string that is followed
1040 by an EFI_GUID that describes the specific type of reset to perform.
1044 (EFIAPI
*EFI_RESET_SYSTEM
)(
1045 IN EFI_RESET_TYPE ResetType
,
1046 IN EFI_STATUS ResetStatus
,
1048 IN VOID
*ResetData OPTIONAL
1052 Returns a monotonically increasing count for the platform.
1054 @param[out] Count The pointer to returned value.
1056 @retval EFI_SUCCESS The next monotonic count was returned.
1057 @retval EFI_INVALID_PARAMETER Count is NULL.
1058 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1063 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1068 Returns the next high 32 bits of the platform's monotonic counter.
1070 @param[out] HighCount The pointer to returned value.
1072 @retval EFI_SUCCESS The next high monotonic count was returned.
1073 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1074 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1079 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1080 OUT UINT32
*HighCount
1084 Computes and returns a 32-bit CRC for a data buffer.
1086 @param[in] Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1087 @param[in] DataSize The number of bytes in the buffer Data.
1088 @param[out] Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1091 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1093 @retval EFI_INVALID_PARAMETER Data is NULL.
1094 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1095 @retval EFI_INVALID_PARAMETER DataSize is 0.
1100 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1107 Copies the contents of one buffer to another buffer.
1109 @param[in] Destination The pointer to the destination buffer of the memory copy.
1110 @param[in] Source The pointer to the source buffer of the memory copy.
1111 @param[in] Length Number of bytes to copy from Source to Destination.
1116 (EFIAPI
*EFI_COPY_MEM
)(
1117 IN VOID
*Destination
,
1123 The SetMem() function fills a buffer with a specified value.
1125 @param[in] Buffer The pointer to the buffer to fill.
1126 @param[in] Size Number of bytes in Buffer to fill.
1127 @param[in] Value Value to fill Buffer with.
1132 (EFIAPI
*EFI_SET_MEM
)(
1139 /// Enumeration of EFI Interface Types
1143 /// Indicates that the supplied protocol interface is supplied in native form.
1145 EFI_NATIVE_INTERFACE
1146 } EFI_INTERFACE_TYPE
;
1149 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1150 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1151 more error checking than InstallProtocolInterface(), so it is recommended that
1152 InstallMultipleProtocolInterfaces() be used in place of
1153 InstallProtocolInterface()
1155 @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1156 @param[in] Protocol The numeric ID of the protocol interface.
1157 @param[in] InterfaceType Indicates whether Interface is supplied in native form.
1158 @param[in] Interface A pointer to the protocol interface.
1160 @retval EFI_SUCCESS The protocol interface was installed.
1161 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1162 @retval EFI_INVALID_PARAMETER Handle is NULL.
1163 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1164 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1165 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1170 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1171 IN OUT EFI_HANDLE
*Handle
,
1172 IN EFI_GUID
*Protocol
,
1173 IN EFI_INTERFACE_TYPE InterfaceType
,
1178 Installs one or more protocol interfaces into the boot services environment.
1180 @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on,
1181 or a pointer to NULL if a new handle is to be allocated.
1182 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1185 @retval EFI_SUCCESS All the protocol interface was installed.
1186 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1187 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1188 the handle database.
1189 @retval EFI_INVALID_PARAMETER Handle is NULL.
1190 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1195 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1196 IN OUT EFI_HANDLE
*Handle
,
1201 Reinstalls a protocol interface on a device handle.
1203 @param[in] Handle Handle on which the interface is to be reinstalled.
1204 @param[in] Protocol The numeric ID of the interface.
1205 @param[in] OldInterface A pointer to the old interface. NULL can be used if a structure is not
1206 associated with Protocol.
1207 @param[in] NewInterface A pointer to the new interface.
1209 @retval EFI_SUCCESS The protocol interface was reinstalled.
1210 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1211 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1212 because OldInterface is still being used by a
1213 driver that will not release it.
1214 @retval EFI_INVALID_PARAMETER Handle is NULL.
1215 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1220 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1221 IN EFI_HANDLE Handle
,
1222 IN EFI_GUID
*Protocol
,
1223 IN VOID
*OldInterface
,
1224 IN VOID
*NewInterface
1228 Removes a protocol interface from a device handle. It is recommended that
1229 UninstallMultipleProtocolInterfaces() be used in place of
1230 UninstallProtocolInterface().
1232 @param[in] Handle The handle on which the interface was installed.
1233 @param[in] Protocol The numeric ID of the interface.
1234 @param[in] Interface A pointer to the interface.
1236 @retval EFI_SUCCESS The interface was removed.
1237 @retval EFI_NOT_FOUND The interface was not found.
1238 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1239 is still being used by a driver.
1240 @retval EFI_INVALID_PARAMETER Handle is NULL.
1241 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1246 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1247 IN EFI_HANDLE Handle
,
1248 IN EFI_GUID
*Protocol
,
1253 Removes one or more protocol interfaces into the boot services environment.
1255 @param[in] Handle The handle to remove the protocol interfaces from.
1256 @param ... A variable argument list containing pairs of protocol GUIDs and
1257 protocol interfaces.
1259 @retval EFI_SUCCESS All the protocol interfaces were removed.
1260 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1265 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1266 IN EFI_HANDLE Handle
,
1271 Queries a handle to determine if it supports a specified protocol.
1273 @param[in] Handle The handle being queried.
1274 @param[in] Protocol The published unique identifier of the protocol.
1275 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1276 Interface is returned.
1278 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1279 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1280 @retval EFI_INVALID_PARAMETER Handle is NULL.
1281 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1282 @retval EFI_INVALID_PARAMETER Interface is NULL.
1287 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1288 IN EFI_HANDLE Handle
,
1289 IN EFI_GUID
*Protocol
,
1290 OUT VOID
**Interface
1293 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1294 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1295 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1296 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1297 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1298 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1301 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1302 handle, it opens the protocol on behalf of the calling agent.
1304 @param[in] Handle The handle for the protocol interface that is being opened.
1305 @param[in] Protocol The published unique identifier of the protocol.
1306 @param[out] Interface Supplies the address where a pointer to the corresponding Protocol
1307 Interface is returned.
1308 @param[in] AgentHandle The handle of the agent that is opening the protocol interface
1309 specified by Protocol and Interface.
1310 @param[in] ControllerHandle If the agent that is opening a protocol is a driver that follows the
1311 UEFI Driver Model, then this parameter is the controller handle
1312 that requires the protocol interface. If the agent does not follow
1313 the UEFI Driver Model, then this parameter is optional and may
1315 @param[in] Attributes The open mode of the protocol interface specified by Handle
1318 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1319 protocol interface was returned in Interface.
1320 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1321 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1322 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1323 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1324 handle is the same as AgentHandle.
1329 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1330 IN EFI_HANDLE Handle
,
1331 IN EFI_GUID
*Protocol
,
1332 OUT VOID
**Interface
, OPTIONAL
1333 IN EFI_HANDLE AgentHandle
,
1334 IN EFI_HANDLE ControllerHandle
,
1335 IN UINT32 Attributes
1340 Closes a protocol on a handle that was opened using OpenProtocol().
1342 @param[in] Handle The handle for the protocol interface that was previously opened
1343 with OpenProtocol(), and is now being closed.
1344 @param[in] Protocol The published unique identifier of the protocol.
1345 @param[in] AgentHandle The handle of the agent that is closing the protocol interface.
1346 @param[in] ControllerHandle If the agent that opened a protocol is a driver that follows the
1347 UEFI Driver Model, then this parameter is the controller handle
1348 that required the protocol interface.
1350 @retval EFI_SUCCESS The protocol instance was closed.
1351 @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
1352 2) AgentHandle is NULL.
1353 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1354 4) Protocol is NULL.
1355 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1356 2) The protocol interface specified by Handle and Protocol is not
1357 currently open by AgentHandle and ControllerHandle.
1362 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1363 IN EFI_HANDLE Handle
,
1364 IN EFI_GUID
*Protocol
,
1365 IN EFI_HANDLE AgentHandle
,
1366 IN EFI_HANDLE ControllerHandle
1370 /// EFI Oprn Protocol Information Entry
1373 EFI_HANDLE AgentHandle
;
1374 EFI_HANDLE ControllerHandle
;
1377 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1380 Retrieves the list of agents that currently have a protocol interface opened.
1382 @param[in] Handle The handle for the protocol interface that is being queried.
1383 @param[in] Protocol The published unique identifier of the protocol.
1384 @param[out] EntryBuffer A pointer to a buffer of open protocol information in the form of
1385 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1386 @param[out] EntryCount A pointer to the number of entries in EntryBuffer.
1388 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1389 number of entries was returned EntryCount.
1390 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1391 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1396 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1397 IN EFI_HANDLE Handle
,
1398 IN EFI_GUID
*Protocol
,
1399 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1400 OUT UINTN
*EntryCount
1404 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1407 @param[in] Handle The handle from which to retrieve the list of protocol interface
1409 @param[out] ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1410 installed on Handle.
1411 @param[out] ProtocolBufferCount A pointer to the number of GUID pointers present in
1414 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1415 ProtocolBuffer. The number of protocol interface GUIDs was
1416 returned in ProtocolBufferCount.
1417 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1418 @retval EFI_INVALID_PARAMETER Handle is NULL.
1419 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1420 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1421 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1426 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1427 IN EFI_HANDLE Handle
,
1428 OUT EFI_GUID
***ProtocolBuffer
,
1429 OUT UINTN
*ProtocolBufferCount
1433 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1435 @param[in] Protocol The numeric ID of the protocol for which the event is to be registered.
1436 @param[in] Event Event that is to be signaled whenever a protocol interface is registered
1438 @param[out] Registration A pointer to a memory location to receive the registration value.
1440 @retval EFI_SUCCESS The notification event has been registered.
1441 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1442 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1443 @retval EFI_INVALID_PARAMETER Event is NULL.
1444 @retval EFI_INVALID_PARAMETER Registration is NULL.
1449 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1450 IN EFI_GUID
*Protocol
,
1452 OUT VOID
**Registration
1456 /// Enumeration of EFI Locate Search Types
1460 /// Retrieve all the handles in the handle database.
1464 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1468 /// Retrieve the set of handles from the handle database that support a
1469 /// specified protocol.
1472 } EFI_LOCATE_SEARCH_TYPE
;
1475 Returns an array of handles that support a specified protocol.
1477 @param[in] SearchType Specifies which handle(s) are to be returned.
1478 @param[in] Protocol Specifies the protocol to search by.
1479 @param[in] SearchKey Specifies the search key.
1480 @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1481 the array returned in Buffer (if the buffer was large enough) or the
1482 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1484 @param[out] Buffer The buffer in which the array is returned.
1486 @retval EFI_SUCCESS The array of handles was returned.
1487 @retval EFI_NOT_FOUND No handles match the search.
1488 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1489 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1490 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1491 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1492 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1493 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1498 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1499 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1500 IN EFI_GUID
*Protocol
, OPTIONAL
1501 IN VOID
*SearchKey
, OPTIONAL
1502 IN OUT UINTN
*BufferSize
,
1503 OUT EFI_HANDLE
*Buffer
1507 Locates the handle to a device on the device path that supports the specified protocol.
1509 @param[in] Protocol Specifies the protocol to search for.
1510 @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device
1511 path pointer is modified to point to the remaining part of the device
1513 @param[out] Device A pointer to the returned device handle.
1515 @retval EFI_SUCCESS The resulting handle was returned.
1516 @retval EFI_NOT_FOUND No handles match the search.
1517 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1518 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1519 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1524 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1525 IN EFI_GUID
*Protocol
,
1526 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1527 OUT EFI_HANDLE
*Device
1531 Adds, updates, or removes a configuration table entry from the EFI System Table.
1533 @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.
1534 @param[in] Table A pointer to the configuration table for the entry to add, update, or
1535 remove. May be NULL.
1537 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1538 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1539 @retval EFI_INVALID_PARAMETER Guid is NULL.
1540 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1545 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1551 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1553 @param[in] SearchType Specifies which handle(s) are to be returned.
1554 @param[in] Protocol Provides the protocol to search by.
1555 This parameter is only valid for a SearchType of ByProtocol.
1556 @param[in] SearchKey Supplies the search key depending on the SearchType.
1557 @param[in, out] NoHandles The number of handles returned in Buffer.
1558 @param[out] Buffer A pointer to the buffer to return the requested array of handles that
1561 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1562 handles in Buffer was returned in NoHandles.
1563 @retval EFI_NOT_FOUND No handles match the search.
1564 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1565 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1566 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1571 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1572 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1573 IN EFI_GUID
*Protocol
, OPTIONAL
1574 IN VOID
*SearchKey
, OPTIONAL
1575 IN OUT UINTN
*NoHandles
,
1576 OUT EFI_HANDLE
**Buffer
1580 Returns the first protocol instance that matches the given protocol.
1582 @param[in] Protocol Provides the protocol to search for.
1583 @param[in] Registration Optional registration key returned from
1584 RegisterProtocolNotify().
1585 @param[out] Interface On return, a pointer to the first interface that matches Protocol and
1588 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1590 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1592 @retval EFI_INVALID_PARAMETER Interface is NULL.
1598 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1599 IN EFI_GUID
*Protocol
,
1600 IN VOID
*Registration
, OPTIONAL
1601 OUT VOID
**Interface
1605 /// EFI Capsule Block Descriptor
1609 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1614 /// Physical address of the data block. This member of the union is
1615 /// used if Length is not equal to zero.
1617 EFI_PHYSICAL_ADDRESS DataBlock
;
1619 /// Physical address of another block of
1620 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1621 /// member of the union is used if Length is equal to zero. If
1622 /// ContinuationPointer is zero this entry represents the end of the list.
1624 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1626 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1629 /// EFI Capsule Header.
1633 /// A GUID that defines the contents of a capsule.
1635 EFI_GUID CapsuleGuid
;
1637 /// The size of the capsule header. This may be larger than the size of
1638 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1639 /// extended header entries
1643 /// Bit-mapped list describing the capsule attributes. The Flag values
1644 /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
1645 /// of 0x10000 - 0xFFFFFFFF are defined by this specification
1649 /// Size in bytes of the capsule.
1651 UINT32 CapsuleImageSize
;
1652 } EFI_CAPSULE_HEADER
;
1655 /// The EFI System Table entry must point to an array of capsules
1656 /// that contain the same CapsuleGuid value. The array must be
1657 /// prefixed by a UINT32 that represents the size of the array of capsules.
1661 /// the size of the array of capsules.
1663 UINT32 CapsuleArrayNumber
;
1665 /// Point to an array of capsules that contain the same CapsuleGuid value.
1667 VOID
* CapsulePtr
[1];
1668 } EFI_CAPSULE_TABLE
;
1670 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1671 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1672 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
1675 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1676 consumption, the firmware may process the capsule immediately. If the payload should persist
1677 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1678 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1679 part of the reset process.
1681 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1682 being passed into update capsule.
1683 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1685 @param[in] ScatterGatherList Physical pointer to a set of
1686 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1687 location in physical memory of a set of capsules.
1689 @retval EFI_SUCCESS Valid capsule was passed. If
1690 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1691 capsule has been successfully processed by the firmware.
1692 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
1693 set in the capsule header.
1694 @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
1695 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1696 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1697 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1698 is compatible with this platform but is not capable of being submitted or processed
1699 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1700 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1701 the capsule is compatible with this platform but there are insufficient resources to process.
1706 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1707 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1708 IN UINTN CapsuleCount
,
1709 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1713 Returns if the capsule can be supported via UpdateCapsule().
1715 @param[in] CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1716 being passed into update capsule.
1717 @param[in] CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1719 @param[out] MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1720 support as an argument to UpdateCapsule() via
1721 CapsuleHeaderArray and ScatterGatherList.
1722 @param[out] ResetType Returns the type of reset required for the capsule update.
1724 @retval EFI_SUCCESS Valid answer returned.
1725 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1726 MaximumCapsuleSize and ResetType are undefined.
1727 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1728 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule
1729 is compatible with this platform but is not capable of being submitted or processed
1730 in runtime. The caller may resubmit the capsule prior to ExitBootServices().
1731 @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates
1732 the capsule is compatible with this platform but there are insufficient resources to process.
1737 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1738 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1739 IN UINTN CapsuleCount
,
1740 OUT UINT64
*MaximumCapsuleSize
,
1741 OUT EFI_RESET_TYPE
*ResetType
1745 Returns information about the EFI variables.
1747 @param[in] Attributes Attributes bitmask to specify the type of variables on
1748 which to return information.
1749 @param[out] MaximumVariableStorageSize On output the maximum size of the storage space
1750 available for the EFI variables associated with the
1751 attributes specified.
1752 @param[out] RemainingVariableStorageSize Returns the remaining size of the storage space
1753 available for the EFI variables associated with the
1754 attributes specified.
1755 @param[out] MaximumVariableSize Returns the maximum size of the individual EFI
1756 variables associated with the attributes specified.
1758 @retval EFI_SUCCESS Valid answer returned.
1759 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1760 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1761 MaximumVariableStorageSize,
1762 RemainingVariableStorageSize, MaximumVariableSize
1768 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1769 IN UINT32 Attributes
,
1770 OUT UINT64
*MaximumVariableStorageSize
,
1771 OUT UINT64
*RemainingVariableStorageSize
,
1772 OUT UINT64
*MaximumVariableSize
1776 // Firmware should stop at a firmware user interface on next boot
1778 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
1779 #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
1780 #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
1781 #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
1782 #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
1783 #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
1786 // EFI Runtime Services Table
1788 #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1789 #define EFI_2_70_SYSTEM_TABLE_REVISION ((2 << 16) | (70))
1790 #define EFI_2_60_SYSTEM_TABLE_REVISION ((2 << 16) | (60))
1791 #define EFI_2_50_SYSTEM_TABLE_REVISION ((2 << 16) | (50))
1792 #define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40))
1793 #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))
1794 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
1795 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
1796 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1797 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1798 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1799 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1800 #define EFI_SYSTEM_TABLE_REVISION EFI_2_70_SYSTEM_TABLE_REVISION
1801 #define EFI_SPECIFICATION_VERSION EFI_SYSTEM_TABLE_REVISION
1803 #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1804 #define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1807 /// EFI Runtime Services Table.
1811 /// The table header for the EFI Runtime Services Table.
1813 EFI_TABLE_HEADER Hdr
;
1818 EFI_GET_TIME GetTime
;
1819 EFI_SET_TIME SetTime
;
1820 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1821 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1824 // Virtual Memory Services
1826 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1827 EFI_CONVERT_POINTER ConvertPointer
;
1830 // Variable Services
1832 EFI_GET_VARIABLE GetVariable
;
1833 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1834 EFI_SET_VARIABLE SetVariable
;
1837 // Miscellaneous Services
1839 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1840 EFI_RESET_SYSTEM ResetSystem
;
1843 // UEFI 2.0 Capsule Services
1845 EFI_UPDATE_CAPSULE UpdateCapsule
;
1846 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1849 // Miscellaneous UEFI 2.0 Service
1851 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1852 } EFI_RUNTIME_SERVICES
;
1855 #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1856 #define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION
1859 /// EFI Boot Services Table.
1863 /// The table header for the EFI Boot Services Table.
1865 EFI_TABLE_HEADER Hdr
;
1868 // Task Priority Services
1870 EFI_RAISE_TPL RaiseTPL
;
1871 EFI_RESTORE_TPL RestoreTPL
;
1876 EFI_ALLOCATE_PAGES AllocatePages
;
1877 EFI_FREE_PAGES FreePages
;
1878 EFI_GET_MEMORY_MAP GetMemoryMap
;
1879 EFI_ALLOCATE_POOL AllocatePool
;
1880 EFI_FREE_POOL FreePool
;
1883 // Event & Timer Services
1885 EFI_CREATE_EVENT CreateEvent
;
1886 EFI_SET_TIMER SetTimer
;
1887 EFI_WAIT_FOR_EVENT WaitForEvent
;
1888 EFI_SIGNAL_EVENT SignalEvent
;
1889 EFI_CLOSE_EVENT CloseEvent
;
1890 EFI_CHECK_EVENT CheckEvent
;
1893 // Protocol Handler Services
1895 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1896 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1897 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1898 EFI_HANDLE_PROTOCOL HandleProtocol
;
1900 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1901 EFI_LOCATE_HANDLE LocateHandle
;
1902 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1903 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1908 EFI_IMAGE_LOAD LoadImage
;
1909 EFI_IMAGE_START StartImage
;
1911 EFI_IMAGE_UNLOAD UnloadImage
;
1912 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1915 // Miscellaneous Services
1917 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1919 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1922 // DriverSupport Services
1924 EFI_CONNECT_CONTROLLER ConnectController
;
1925 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1928 // Open and Close Protocol Services
1930 EFI_OPEN_PROTOCOL OpenProtocol
;
1931 EFI_CLOSE_PROTOCOL CloseProtocol
;
1932 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1937 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1938 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1939 EFI_LOCATE_PROTOCOL LocateProtocol
;
1940 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1941 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1944 // 32-bit CRC Services
1946 EFI_CALCULATE_CRC32 CalculateCrc32
;
1949 // Miscellaneous Services
1951 EFI_COPY_MEM CopyMem
;
1953 EFI_CREATE_EVENT_EX CreateEventEx
;
1954 } EFI_BOOT_SERVICES
;
1957 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1958 /// EFI System Table.
1962 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1964 EFI_GUID VendorGuid
;
1966 /// A pointer to the table associated with VendorGuid.
1969 } EFI_CONFIGURATION_TABLE
;
1972 /// EFI System Table
1976 /// The table header for the EFI System Table.
1978 EFI_TABLE_HEADER Hdr
;
1980 /// A pointer to a null terminated string that identifies the vendor
1981 /// that produces the system firmware for the platform.
1983 CHAR16
*FirmwareVendor
;
1985 /// A firmware vendor specific value that identifies the revision
1986 /// of the system firmware for the platform.
1988 UINT32 FirmwareRevision
;
1990 /// The handle for the active console input device. This handle must support
1991 /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
1993 EFI_HANDLE ConsoleInHandle
;
1995 /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
1996 /// associated with ConsoleInHandle.
1998 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
2000 /// The handle for the active console output device.
2002 EFI_HANDLE ConsoleOutHandle
;
2004 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
2005 /// that is associated with ConsoleOutHandle.
2007 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
2009 /// The handle for the active standard error console device.
2010 /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
2012 EFI_HANDLE StandardErrorHandle
;
2014 /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
2015 /// that is associated with StandardErrorHandle.
2017 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
2019 /// A pointer to the EFI Runtime Services Table.
2021 EFI_RUNTIME_SERVICES
*RuntimeServices
;
2023 /// A pointer to the EFI Boot Services Table.
2025 EFI_BOOT_SERVICES
*BootServices
;
2027 /// The number of system configuration tables in the buffer ConfigurationTable.
2029 UINTN NumberOfTableEntries
;
2031 /// A pointer to the system configuration tables.
2032 /// The number of entries in the table is NumberOfTableEntries.
2034 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
2038 This is the declaration of an EFI image entry point. This entry point is
2039 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
2040 both device drivers and bus drivers.
2042 @param[in] ImageHandle The firmware allocated handle for the UEFI image.
2043 @param[in] SystemTable A pointer to the EFI System Table.
2045 @retval EFI_SUCCESS The operation completed successfully.
2046 @retval Others An unexpected error occurred.
2050 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
2051 IN EFI_HANDLE ImageHandle
,
2052 IN EFI_SYSTEM_TABLE
*SystemTable
2056 // EFI Load Option. This data structure describes format of UEFI boot option variables.
2058 // NOTE: EFI Load Option is a byte packed buffer of variable length fields.
2059 // The first two fields have fixed length. They are declared as members of the
2060 // EFI_LOAD_OPTION structure. All the other fields are variable length fields.
2061 // They are listed in the comment block below for reference purposes.
2064 typedef struct _EFI_LOAD_OPTION
{
2066 /// The attributes for this load option entry. All unused bits must be zero
2067 /// and are reserved by the UEFI specification for future growth.
2071 /// Length in bytes of the FilePathList. OptionalData starts at offset
2072 /// sizeof(UINT32) + sizeof(UINT16) + StrSize(Description) + FilePathListLength
2073 /// of the EFI_LOAD_OPTION descriptor.
2075 UINT16 FilePathListLength
;
2077 /// The user readable description for the load option.
2078 /// This field ends with a Null character.
2080 // CHAR16 Description[];
2082 /// A packed array of UEFI device paths. The first element of the array is a
2083 /// device path that describes the device and location of the Image for this
2084 /// load option. The FilePathList[0] is specific to the device type. Other
2085 /// device paths may optionally exist in the FilePathList, but their usage is
2086 /// OSV specific. Each element in the array is variable length, and ends at
2087 /// the device path end structure. Because the size of Description is
2088 /// arbitrary, this data structure is not guaranteed to be aligned on a
2089 /// natural boundary. This data structure may have to be copied to an aligned
2090 /// natural boundary before it is used.
2092 // EFI_DEVICE_PATH_PROTOCOL FilePathList[];
2094 /// The remaining bytes in the load option descriptor are a binary data buffer
2095 /// that is passed to the loaded image. If the field is zero bytes long, a
2096 /// NULL pointer is passed to the loaded image. The number of bytes in
2097 /// OptionalData can be computed by subtracting the starting offset of
2098 /// OptionalData from total size in bytes of the EFI_LOAD_OPTION.
2100 // UINT8 OptionalData[];
2105 // EFI Load Options Attributes
2107 #define LOAD_OPTION_ACTIVE 0x00000001
2108 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
2109 #define LOAD_OPTION_HIDDEN 0x00000008
2110 #define LOAD_OPTION_CATEGORY 0x00001F00
2112 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
2113 #define LOAD_OPTION_CATEGORY_APP 0x00000100
2115 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
2116 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
2117 #define EFI_BOOT_OPTION_SUPPORT_SYSPREP 0x00000010
2118 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
2121 /// EFI Boot Key Data
2126 /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
2128 UINT32 Revision
: 8;
2130 /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
2132 UINT32 ShiftPressed
: 1;
2134 /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
2136 UINT32 ControlPressed
: 1;
2138 /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
2140 UINT32 AltPressed
: 1;
2142 /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
2144 UINT32 LogoPressed
: 1;
2146 /// The Menu key must be pressed (1) or must not be pressed (0).
2148 UINT32 MenuPressed
: 1;
2150 /// The SysReq key must be pressed (1) or must not be pressed (0).
2152 UINT32 SysReqPressed
: 1;
2153 UINT32 Reserved
: 16;
2155 /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
2156 /// zero, then only the shift state is considered. If more than one, then the boot option will
2157 /// only be launched if all of the specified keys are pressed with the same shift state.
2159 UINT32 InputKeyCount
: 2;
2162 } EFI_BOOT_KEY_DATA
;
2170 /// Specifies options about how the key will be processed.
2172 EFI_BOOT_KEY_DATA KeyData
;
2174 /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
2175 /// which BootOption refers. If the CRC-32s do not match this value, then this key
2176 /// option is ignored.
2178 UINT32 BootOptionCrc
;
2180 /// The Boot#### option which will be invoked if this key is pressed and the boot option
2181 /// is active (LOAD_OPTION_ACTIVE is set).
2185 /// The key codes to compare against those returned by the
2186 /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
2187 /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
2189 //EFI_INPUT_KEY Keys[];
2194 // EFI File location to boot from on removable media devices
2196 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2197 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2198 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2199 #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"
2200 #define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.EFI"
2202 #if defined (MDE_CPU_IA32)
2203 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2204 #elif defined (MDE_CPU_X64)
2205 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2206 #elif defined (MDE_CPU_EBC)
2207 #elif defined (MDE_CPU_ARM)
2208 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM
2209 #elif defined (MDE_CPU_AARCH64)
2210 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64
2212 #error Unknown Processor Type
2216 // The directory within the active EFI System Partition defined for delivery of capsule to firmware
2218 #define EFI_CAPSULE_FILE_DIRECTORY L"\\EFI\\UpdateCapsule\\"
2220 #include <Uefi/UefiPxe.h>
2221 #include <Uefi/UefiGpt.h>
2222 #include <Uefi/UefiInternalFormRepresentation.h>