2 Include file that supports UEFI.
4 This include file must only contain things defined in the UEFI 2.1 specification.
5 If a code construct is defined in the UEFI 2.1 specification it must be included
8 Copyright (c) 2006 - 2008, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. 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/SimpleTextOut.h>
29 /// Enumeration of EFI memory allocation types.
33 /// Allocate any available range of pages that satisfies the request
37 /// Allocate any available range of pages whose uppermost address is less than
38 /// or equal to a specified maximum address
42 /// Allocate pages at a specified address
46 /// Maximum enumeration value that may be used for bounds checking
52 // Bit definitions for EFI_TIME.Daylight
54 #define EFI_TIME_ADJUST_DAYLIGHT 0x01
55 #define EFI_TIME_IN_DAYLIGHT 0x02
58 /// Value definition for EFI_TIME.TimeZone
60 #define EFI_UNSPECIFIED_TIMEZONE 0x07FF
63 // Memory cacheability attributes
65 #define EFI_MEMORY_UC 0x0000000000000001ULL
66 #define EFI_MEMORY_WC 0x0000000000000002ULL
67 #define EFI_MEMORY_WT 0x0000000000000004ULL
68 #define EFI_MEMORY_WB 0x0000000000000008ULL
69 #define EFI_MEMORY_UCE 0x0000000000000010ULL
71 // Physical memory protection attributes
73 #define EFI_MEMORY_WP 0x0000000000001000ULL
74 #define EFI_MEMORY_RP 0x0000000000002000ULL
75 #define EFI_MEMORY_XP 0x0000000000004000ULL
77 // Runtime memory attribute
79 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
82 /// Memory descriptor version number
84 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
87 /// Definition of an EFI memory descriptor
91 /// Type of the memory region. See EFI_MEMORY_TYPE
95 /// Physical address of the first byte of the memory region. Must aligned
96 /// on a 4 KB boundary.
98 EFI_PHYSICAL_ADDRESS PhysicalStart
;
100 /// Virtual address of the first byte of the memory region. Must aligned
101 /// on a 4 KB boundary.
103 EFI_VIRTUAL_ADDRESS VirtualStart
;
105 /// Number of 4KB pages in the memory region.
107 UINT64 NumberOfPages
;
109 /// Attributes of the memory region that describe the bit mask of capabilities
110 /// for that memory region, and not necessarily the current settings for that
114 } EFI_MEMORY_DESCRIPTOR
;
117 Allocates memory pages from the system.
119 @param Type The type of allocation to perform.
120 @param MemoryType The type of memory to allocate.
121 @param Pages The number of contiguous 4 KB pages to allocate.
122 @param Memory Pointer to a physical address. On input, the way in which the address is
123 used depends on the value of Type.
125 @retval EFI_SUCCESS The requested pages were allocated.
126 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
127 AllocateMaxAddress or AllocateAddress.
128 2) MemoryType is in the range
129 EfiMaxMemoryType..0x7FFFFFFF.
130 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
131 @retval EFI_NOT_FOUND The requested pages could not be found.
136 (EFIAPI
*EFI_ALLOCATE_PAGES
)(
137 IN EFI_ALLOCATE_TYPE Type
,
138 IN EFI_MEMORY_TYPE MemoryType
,
140 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
146 @param Memory The base physical address of the pages to be freed.
147 @param Pages The number of contiguous 4 KB pages to free.
149 @retval EFI_SUCCESS The requested pages were freed.
150 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
151 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
157 (EFIAPI
*EFI_FREE_PAGES
)(
158 IN EFI_PHYSICAL_ADDRESS Memory
,
163 Returns the current memory map.
165 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
166 On input, this is the size of the buffer allocated by the caller.
167 On output, it is the size of the buffer returned by the firmware if
168 the buffer was large enough, or the size of the buffer needed to contain
169 the map if the buffer was too small.
170 @param MemoryMap A pointer to the buffer in which firmware places the current memory
172 @param MapKey A pointer to the location in which firmware returns the key for the
174 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
175 an individual EFI_MEMORY_DESCRIPTOR.
176 @param DescriptorVersion A pointer to the location in which firmware returns the version number
177 associated with the EFI_MEMORY_DESCRIPTOR.
179 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
180 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
181 needed to hold the memory map is returned in MemoryMapSize.
182 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
183 2) The MemoryMap buffer is not too small and MemoryMap is
189 (EFIAPI
*EFI_GET_MEMORY_MAP
)(
190 IN OUT UINTN
*MemoryMapSize
,
191 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
193 OUT UINTN
*DescriptorSize
,
194 OUT UINT32
*DescriptorVersion
198 Allocates pool memory.
200 @param PoolType The type of pool to allocate.
201 @param Size The number of bytes to allocate from the pool.
202 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
205 @retval EFI_SUCCESS The requested number of bytes was allocated.
206 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
207 @retval EFI_INVALID_PARAMETER PoolType was invalid.
212 (EFIAPI
*EFI_ALLOCATE_POOL
)(
213 IN EFI_MEMORY_TYPE PoolType
,
219 Returns pool memory to the system.
221 @param Buffer Pointer to the buffer to free.
223 @retval EFI_SUCCESS The memory was returned to the system.
224 @retval EFI_INVALID_PARAMETER Buffer was invalid.
229 (EFIAPI
*EFI_FREE_POOL
)(
234 Changes the runtime addressing mode of EFI firmware from physical to virtual.
236 @param MemoryMapSize The size in bytes of VirtualMap.
237 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
238 @param DescriptorVersion The version of the structure entries in VirtualMap.
239 @param VirtualMap An array of memory descriptors which contain new virtual
240 address mapping information for all runtime ranges.
242 @retval EFI_SUCCESS The virtual address map has been applied.
243 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
244 virtual address mapped mode.
245 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
246 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
247 map that requires a mapping.
248 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
254 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
)(
255 IN UINTN MemoryMapSize
,
256 IN UINTN DescriptorSize
,
257 IN UINT32 DescriptorVersion
,
258 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
262 Connects one or more drivers to a controller.
264 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
265 @param DriverImageHandle A pointer to an ordered list handles that support the
266 EFI_DRIVER_BINDING_PROTOCOL.
267 @param RemainingDevicePath A pointer to the device path that specifies a child of the
268 controller specified by ControllerHandle.
269 @param Recursive If TRUE, then ConnectController() is called recursively
270 until the entire tree of controllers below the controller specified
271 by ControllerHandle have been created. If FALSE, then
272 the tree of controllers is only expanded one level.
274 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
275 2) No drivers were connected to ControllerHandle, but
276 RemainingDevicePath is not NULL, and it is an End Device
278 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
279 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
280 present in the system.
281 2) No drivers were connected to ControllerHandle.
286 (EFIAPI
*EFI_CONNECT_CONTROLLER
)(
287 IN EFI_HANDLE ControllerHandle
,
288 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
289 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
294 Disconnects one or more drivers from a controller.
296 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
297 @param DriverImageHandle The driver to disconnect from ControllerHandle.
298 If DriverImageHandle is NULL, then all the drivers currently managing
299 ControllerHandle are disconnected from ControllerHandle.
300 @param ChildHandle The handle of the child to destroy.
301 If ChildHandle is NULL, then all the children of ControllerHandle are
302 destroyed before the drivers are disconnected from ControllerHandle.
304 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
305 2) On entry, no drivers are managing ControllerHandle.
306 3) DriverImageHandle is not NULL, and on entry
307 DriverImageHandle is not managing ControllerHandle.
308 @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.
309 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
310 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
311 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
312 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
314 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
319 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
)(
320 IN EFI_HANDLE ControllerHandle
,
321 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
322 IN EFI_HANDLE ChildHandle OPTIONAL
328 // ConvertPointer DebugDisposition type.
330 #define EFI_OPTIONAL_PTR 0x00000001
331 #define EFI_OPTIONAL_POINTER EFI_OPTIONAL_PTR
334 Determines the new virtual address that is to be used on subsequent memory accesses.
336 @param DebugDisposition Supplies type information for the pointer being converted.
337 @param Address A pointer to a pointer that is to be fixed to be the value needed
338 for the new virtual address mappings being applied.
340 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
341 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
342 2) *Address is NULL and DebugDisposition does
343 not have the EFI_OPTIONAL_PTR bit set.
344 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
345 of the current memory map. This is normally fatal.
350 (EFIAPI
*EFI_CONVERT_POINTER
)(
351 IN UINTN DebugDisposition
,
352 IN OUT VOID
**Address
357 // These types can be ORed together as needed - for example,
358 // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
359 // EVT_NOTIFY_SIGNAL.
361 #define EVT_TIMER 0x80000000
362 #define EVT_RUNTIME 0x40000000
363 #define EVT_NOTIFY_WAIT 0x00000100
364 #define EVT_NOTIFY_SIGNAL 0x00000200
366 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
367 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
370 // The event's NotifyContext pointer points to a runtime memory
372 // The event is deprecated in UEFI2.0 and later specifications.
374 #define EVT_RUNTIME_CONTEXT 0x20000000
378 Invoke a notification event
380 @param Event Event whose notification function is being invoked.
381 @param Context Pointer to the notification function's context,
382 which is implementation-dependent.
387 (EFIAPI
*EFI_EVENT_NOTIFY
)(
395 @param Type The type of event to create and its mode and attributes.
396 @param NotifyTpl The task priority level of event notifications, if needed.
397 @param NotifyFunction Pointer to the event's notification function, if any.
398 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
399 Context in the notification function.
400 @param Event Pointer to the newly created event if the call succeeds; undefined
403 @retval EFI_SUCCESS The event structure was created.
404 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
405 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
410 (EFIAPI
*EFI_CREATE_EVENT
)(
412 IN EFI_TPL NotifyTpl
,
413 IN EFI_EVENT_NOTIFY NotifyFunction
,
414 IN VOID
*NotifyContext
,
419 Creates an event in a group.
421 @param Type The type of event to create and its mode and attributes.
422 @param NotifyTpl The task priority level of event notifications,if needed.
423 @param NotifyFunction Pointer to the event's notification function, if any.
424 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
425 Context in the notification function.
426 @param EventGroup Pointer to the unique identifier of the group to which this event belongs.
427 If this is NULL, then the function behaves as if the parameters were passed
429 @param Event Pointer to the newly created event if the call succeeds; undefined
432 @retval EFI_SUCCESS The event structure was created.
433 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
434 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
439 (EFIAPI
*EFI_CREATE_EVENT_EX
)(
441 IN EFI_TPL NotifyTpl
,
442 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
443 IN CONST VOID
*NotifyContext OPTIONAL
,
444 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
449 /// Timer delay types
453 /// An event's timer settings is to be cancelled and not trigger time is to be set
457 /// An event is to be signalled periodically at a specified interval from the current time.
461 /// An event is to be signalled once at a specified interval from the current time.
467 Sets the type of timer and the trigger time for a timer event.
469 @param Event The timer event that is to be signaled at the specified time.
470 @param Type The type of time that is specified in TriggerTime.
471 @param TriggerTime The number of 100ns units until the timer expires.
472 A TriggerTime of 0 is legal.
473 If Type is TimerRelative and TriggerTime is 0, then the timer
474 event will be signaled on the next timer tick.
475 If Type is TimerPeriodic and TriggerTime is 0, then the timer
476 event will be signaled on every timer tick.
478 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
479 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
484 (EFIAPI
*EFI_SET_TIMER
)(
486 IN EFI_TIMER_DELAY Type
,
487 IN UINT64 TriggerTime
493 @param Event The event to signal.
495 @retval EFI_SUCCESS The event has been signaled.
500 (EFIAPI
*EFI_SIGNAL_EVENT
)(
505 Stops execution until an event is signaled.
507 @param NumberOfEvents The number of events in the Event array.
508 @param Event An array of EFI_EVENT.
509 @param Index Pointer to the index of the event which satisfied the wait condition.
511 @retval EFI_SUCCESS The event indicated by Index was signaled.
512 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
513 2) The event indicated by Index is of type
515 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
520 (EFIAPI
*EFI_WAIT_FOR_EVENT
)(
521 IN UINTN NumberOfEvents
,
529 @param Event The event to close.
531 @retval EFI_SUCCESS The event has been closed.
536 (EFIAPI
*EFI_CLOSE_EVENT
)(
541 Checks whether an event is in the signaled state.
543 @param Event The event to check.
545 @retval EFI_SUCCESS The event is in the signaled state.
546 @retval EFI_NOT_READY The event is not in the signaled state.
547 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
552 (EFIAPI
*EFI_CHECK_EVENT
)(
558 // Task priority level
560 #define TPL_APPLICATION 4
561 #define TPL_CALLBACK 8
562 #define TPL_NOTIFY 16
563 #define TPL_HIGH_LEVEL 31
567 Raises a task's priority level and returns its previous level.
569 @param NewTpl The new task priority level.
571 @return Previous task priority level
576 (EFIAPI
*EFI_RAISE_TPL
)(
581 Restores a task's priority level to its previous value.
583 @param OldTpl The previous task priority level to restore.
588 (EFIAPI
*EFI_RESTORE_TPL
)(
593 Returns the value of a variable.
595 @param VariableName A Null-terminated Unicode string that is the name of the
597 @param VendorGuid A unique identifier for the vendor.
598 @param Attributes If not NULL, a pointer to the memory location to return the
599 attributes bitmask for the variable.
600 @param DataSize On input, the size in bytes of the return Data buffer.
601 On output the size of data returned in Data.
602 @param Data The buffer to return the contents of the variable.
604 @retval EFI_SUCCESS The function completed successfully.
605 @retval EFI_NOT_FOUND The variable was not found.
606 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
607 @retval EFI_INVALID_PARAMETER VariableName is NULL.
608 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
609 @retval EFI_INVALID_PARAMETER DataSize is NULL.
610 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
611 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
612 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
617 (EFIAPI
*EFI_GET_VARIABLE
)(
618 IN CHAR16
*VariableName
,
619 IN EFI_GUID
*VendorGuid
,
620 OUT UINT32
*Attributes
, OPTIONAL
621 IN OUT UINTN
*DataSize
,
626 Enumerates the current variable names.
628 @param VariableNameSize The size of the VariableName buffer.
629 @param VariableName On input, supplies the last VariableName that was returned
630 by GetNextVariableName(). On output, returns the Nullterminated
631 Unicode string of the current variable.
632 @param VendorGuid On input, supplies the last VendorGuid that was returned by
633 GetNextVariableName(). On output, returns the
634 VendorGuid of the current variable.
636 @retval EFI_SUCCESS The function completed successfully.
637 @retval EFI_NOT_FOUND The next variable was not found.
638 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
639 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
640 @retval EFI_INVALID_PARAMETER VariableName is NULL.
641 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
642 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
647 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
)(
648 IN OUT UINTN
*VariableNameSize
,
649 IN OUT CHAR16
*VariableName
,
650 IN OUT EFI_GUID
*VendorGuid
654 Sets the value of a variable.
656 @param VariableName A Null-terminated Unicode string that is the name of the
658 @param VendorGuid A unique identifier for the vendor.
659 @param Attributes Attributes bitmask to set for the variable.
660 @param DataSize The size in bytes of the Data buffer.
661 @param Data The contents for the variable.
663 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
664 defined by the Attributes.
665 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
666 DataSize exceeds the maximum allowed.
667 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
668 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
669 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
670 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
671 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
672 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
673 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
678 (EFIAPI
*EFI_SET_VARIABLE
)(
679 IN CHAR16
*VariableName
,
680 IN EFI_GUID
*VendorGuid
,
681 IN UINT32 Attributes
,
688 /// This provides the capabilities of the
689 /// real time clock device as exposed through the EFI interfaces.
693 /// Provides the reporting resolution of the real-time clock device in
694 /// counts per second. For a normal PC-AT CMOS RTC device, this
695 /// value would be 1 Hz, or 1, to indicate that the device only reports
696 /// the time to the resolution of 1 second.
700 /// Provides the timekeeping accuracy of the real-time clock in an
701 /// error rate of 1E-6 parts per million. For a clock with an accuracy
702 /// of 50 parts per million, the value in this field would be
707 /// A TRUE indicates that a time set operation clears the device's
708 /// time below the Resolution reporting level. A FALSE
709 /// indicates that the state below the Resolution level of the
710 /// device is not cleared when the time is set. Normal PC-AT CMOS
711 /// RTC devices set this value to FALSE.
714 } EFI_TIME_CAPABILITIES
;
717 Returns the current time and date information, and the time-keeping capabilities
718 of the hardware platform.
720 @param Time A pointer to storage to receive a snapshot of the current time.
721 @param Capabilities An optional pointer to a buffer to receive the real time clock
722 device's capabilities.
724 @retval EFI_SUCCESS The operation completed successfully.
725 @retval EFI_INVALID_PARAMETER Time is NULL.
726 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
731 (EFIAPI
*EFI_GET_TIME
)(
733 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
737 Sets the current local time and date information.
739 @param Time A pointer to the current time.
741 @retval EFI_SUCCESS The operation completed successfully.
742 @retval EFI_INVALID_PARAMETER A time field is out of range.
743 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
748 (EFIAPI
*EFI_SET_TIME
)(
753 Returns the current wakeup alarm clock setting.
755 @param Enabled Indicates if the alarm is currently enabled or disabled.
756 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
757 @param Time The current alarm setting.
759 @retval EFI_SUCCESS The alarm settings were returned.
760 @retval EFI_INVALID_PARAMETER Enabled is NULL.
761 @retval EFI_INVALID_PARAMETER Pending is NULL.
762 @retval EFI_INVALID_PARAMETER Time is NULL.
763 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
764 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
769 (EFIAPI
*EFI_GET_WAKEUP_TIME
)(
770 OUT BOOLEAN
*Enabled
,
771 OUT BOOLEAN
*Pending
,
776 Sets the system wakeup alarm clock time.
778 @param Enabled Enable or disable the wakeup alarm.
779 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
780 If Enable is FALSE, then this parameter is optional, and may be NULL.
782 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
783 Enable is FALSE, then the wakeup alarm was disabled.
784 @retval EFI_INVALID_PARAMETER A time field is out of range.
785 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
786 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
791 (EFIAPI
*EFI_SET_WAKEUP_TIME
)(
793 IN EFI_TIME
*Time OPTIONAL
797 Loads an EFI image into memory.
799 @param BootPolicy If TRUE, indicates that the request originates from the boot
800 manager, and that the boot manager is attempting to load
801 FilePath as a boot selection. Ignored if SourceBuffer is
803 @param ParentImageHandle The caller's image handle.
804 @param DevicePath The DeviceHandle specific file path from which the image is
806 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
807 of the image to be loaded.
808 @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
809 @param ImageHandle Pointer to the returned image handle that is created when the
810 image is successfully loaded.
812 @retval EFI_SUCCESS Image was loaded into memory correctly.
813 @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
814 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
815 @retval EFI_UNSUPPORTED The image type is not supported.
816 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
817 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
819 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
824 (EFIAPI
*EFI_IMAGE_LOAD
)(
825 IN BOOLEAN BootPolicy
,
826 IN EFI_HANDLE ParentImageHandle
,
827 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
828 IN VOID
*SourceBuffer OPTIONAL
,
830 OUT EFI_HANDLE
*ImageHandle
834 Transfers control to a loaded image's entry point.
836 @param ImageHandle Handle of image to be started.
837 @param ExitDataSize Pointer to the size, in bytes, of ExitData.
838 @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
839 Unicode string, optionally followed by additional binary data.
841 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
842 has already been initialized with StartImage
843 @return Exit code from image
848 (EFIAPI
*EFI_IMAGE_START
)(
849 IN EFI_HANDLE ImageHandle
,
850 OUT UINTN
*ExitDataSize
,
851 OUT CHAR16
**ExitData OPTIONAL
855 Terminates a loaded EFI image and returns control to boot services.
857 @param ImageHandle Handle that identifies the image.
858 @param ExitStatus The image's exit code.
859 @param ExitDataSize The size, in bytes, of ExitData.
860 @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
861 optionally followed by additional binary data.
863 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
864 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
865 started with LoadImage() and StartImage(), but the
866 image is not the currently executing image.
872 IN EFI_HANDLE ImageHandle
,
873 IN EFI_STATUS ExitStatus
,
874 IN UINTN ExitDataSize
,
875 IN CHAR16
*ExitData OPTIONAL
881 @param ImageHandle Handle that identifies the image to be unloaded.
883 @retval EFI_SUCCESS The image has been unloaded.
884 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
889 (EFIAPI
*EFI_IMAGE_UNLOAD
)(
890 IN EFI_HANDLE ImageHandle
894 Terminates all boot services.
896 @param ImageHandle Handle that identifies the exiting image.
897 @param MapKey Key to the latest memory map.
899 @retval EFI_SUCCESS Boot services have been terminated.
900 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
905 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
)(
906 IN EFI_HANDLE ImageHandle
,
911 Induces a fine-grained stall.
913 @param Microseconds The number of microseconds to stall execution.
915 @retval EFI_SUCCESS Execution was stalled at least the requested number of
922 IN UINTN Microseconds
926 Sets the system's watchdog timer.
928 @param Timeout The number of seconds to set the watchdog timer to.
929 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
930 @param DataSize The size, in bytes, of WatchdogData.
931 @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
932 followed by additional binary data.
934 @retval EFI_SUCCESS The timeout has been set.
935 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
936 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
937 @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
943 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
)(
945 IN UINT64 WatchdogCode
,
947 IN CHAR16
*WatchdogData OPTIONAL
951 /// Enumeration of reset types.
955 /// Used to induce a system-wide reset. This sets all circuitry within the
956 /// system to its initial state. This type of reset is asynchronous to system
957 /// operation and operates withgout regard to cycle boundaries. EfiColdReset
958 /// is tantamount to a system power cycle.
962 /// Used to induce a system-wide initialization. The processors are set to their
963 /// initial state, and pending cycles are not corrupted. If the system does
964 /// not support this reset type, then an EfiResetCold must be performed.
968 /// Used to induce en entry into power state equivalent to the ACPI G2/S5 or G3
969 /// state. If the system does not support this reset type, then when the system
970 /// is rebooted, it should exhibit the EfiResetCold attributes.
976 Resets the entire platform.
978 @param ResetType The type of reset to perform.
979 @param ResetStatus The status code for the reset.
980 @param DataSize The size, in bytes, of WatchdogData.
981 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
982 EfiResetShutdown the data buffer starts with a Null-terminated
983 Unicode string, optionally followed by additional binary data.
988 (EFIAPI
*EFI_RESET_SYSTEM
)(
989 IN EFI_RESET_TYPE ResetType
,
990 IN EFI_STATUS ResetStatus
,
992 IN VOID
*ResetData OPTIONAL
996 Returns a monotonically increasing count for the platform.
998 @param Count Pointer to returned value.
1000 @retval EFI_SUCCESS The next monotonic count was returned.
1001 @retval EFI_INVALID_PARAMETER Count is NULL.
1002 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1007 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
)(
1012 Returns the next high 32 bits of the platform's monotonic counter.
1014 @param HighCount Pointer to returned value.
1016 @retval EFI_SUCCESS The next high monotonic count was returned.
1017 @retval EFI_INVALID_PARAMETER HighCount is NULL.
1018 @retval EFI_DEVICE_ERROR The device is not functioning properly.
1023 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
)(
1024 OUT UINT32
*HighCount
1028 Computes and returns a 32-bit CRC for a data buffer.
1030 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
1031 @param DataSize The number of bytes in the buffer Data.
1032 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1035 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1037 @retval EFI_INVALID_PARAMETER Data is NULL.
1038 @retval EFI_INVALID_PARAMETER Crc32 is NULL.
1039 @retval EFI_INVALID_PARAMETER DataSize is 0.
1044 (EFIAPI
*EFI_CALCULATE_CRC32
)(
1051 Copies the contents of one buffer to another buffer.
1053 @param Destination Pointer to the destination buffer of the memory copy.
1054 @param Source Pointer to the source buffer of the memory copy.
1055 @param Length Number of bytes to copy from Source to Destination.
1060 (EFIAPI
*EFI_COPY_MEM
)(
1061 IN VOID
*Destination
,
1067 The SetMem() function fills a buffer with a specified value.
1069 @param Buffer Pointer to the buffer to fill.
1070 @param Size Number of bytes in Buffer to fill.
1071 @param Value Value to fill Buffer with.
1076 (EFIAPI
*EFI_SET_MEM
)(
1083 /// Enumeration of EFI Interface Types
1087 /// Indicates that the supplied protocol interface is supplied in native form.
1089 EFI_NATIVE_INTERFACE
1090 } EFI_INTERFACE_TYPE
;
1093 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1094 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1095 more error checking than InstallProtocolInterface(), so it is recommended that
1096 InstallMultipleProtocolInterfaces() be used in place of
1097 InstallProtocolInterface()
1099 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1100 @param Protocol The numeric ID of the protocol interface.
1101 @param InterfaceType Indicates whether Interface is supplied in native form.
1102 @param Interface A pointer to the protocol interface.
1104 @retval EFI_SUCCESS The protocol interface was installed.
1105 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1106 @retval EFI_INVALID_PARAMETER Handle is NULL.
1107 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1108 @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
1109 @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
1114 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
)(
1115 IN OUT EFI_HANDLE
*Handle
,
1116 IN EFI_GUID
*Protocol
,
1117 IN EFI_INTERFACE_TYPE InterfaceType
,
1122 Installs one or more protocol interfaces into the boot services environment.
1124 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1125 handle is to be allocated.
1126 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1129 @retval EFI_SUCCESS All the protocol interface was installed.
1130 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1131 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1132 the handle database.
1137 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1138 IN OUT EFI_HANDLE
*Handle
,
1143 Reinstalls a protocol interface on a device handle.
1145 @param Handle Handle on which the interface is to be reinstalled.
1146 @param Protocol The numeric ID of the interface.
1147 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1148 associated with Protocol.
1149 @param NewInterface A pointer to the new interface.
1151 @retval EFI_SUCCESS The protocol interface was reinstalled.
1152 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1153 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1154 because OldInterface is still being used by a
1155 driver that will not release it.
1156 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1157 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1162 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
)(
1163 IN EFI_HANDLE Handle
,
1164 IN EFI_GUID
*Protocol
,
1165 IN VOID
*OldInterface
,
1166 IN VOID
*NewInterface
1170 Removes a protocol interface from a device handle. It is recommended that
1171 UninstallMultipleProtocolInterfaces() be used in place of
1172 UninstallProtocolInterface().
1174 @param Handle The handle on which the interface was installed.
1175 @param Protocol The numeric ID of the interface.
1176 @param Interface A pointer to the interface.
1178 @retval EFI_SUCCESS The interface was removed.
1179 @retval EFI_NOT_FOUND The interface was not found.
1180 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1181 is still being used by a driver.
1182 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1183 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1188 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
)(
1189 IN EFI_HANDLE Handle
,
1190 IN EFI_GUID
*Protocol
,
1195 Removes one or more protocol interfaces into the boot services environment.
1197 @param Handle The handle to remove the protocol interfaces from.
1198 @param ... A variable argument list containing pairs of protocol GUIDs and
1199 protocol interfaces.
1201 @retval EFI_SUCCESS All the protocol interfaces were removed.
1202 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1207 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
)(
1208 IN EFI_HANDLE Handle
,
1213 Queries a handle to determine if it supports a specified protocol.
1215 @param Handle The handle being queried.
1216 @param Protocol The published unique identifier of the protocol.
1217 @param Interface Supplies the address where a pointer to the corresponding Protocol
1218 Interface is returned.
1220 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1221 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1222 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1223 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1224 @retval EFI_INVALID_PARAMETER Interface is NULL.
1229 (EFIAPI
*EFI_HANDLE_PROTOCOL
)(
1230 IN EFI_HANDLE Handle
,
1231 IN EFI_GUID
*Protocol
,
1232 OUT VOID
**Interface
1235 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1236 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1237 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1238 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1239 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1240 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1243 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1244 handle, it opens the protocol on behalf of the calling agent.
1246 @param Handle The handle for the protocol interface that is being opened.
1247 @param Protocol The published unique identifier of the protocol.
1248 @param Interface Supplies the address where a pointer to the corresponding Protocol
1249 Interface is returned.
1250 @param AgentHandle The handle of the agent that is opening the protocol interface
1251 specified by Protocol and Interface.
1252 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1253 UEFI Driver Model, then this parameter is the controller handle
1254 that requires the protocol interface. If the agent does not follow
1255 the UEFI Driver Model, then this parameter is optional and may
1257 @param Attributes The open mode of the protocol interface specified by Handle
1260 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1261 protocol interface was returned in Interface.
1262 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1263 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1264 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1265 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1266 handle is the same as AgentHandle.
1271 (EFIAPI
*EFI_OPEN_PROTOCOL
)(
1272 IN EFI_HANDLE Handle
,
1273 IN EFI_GUID
*Protocol
,
1274 OUT VOID
**Interface
, OPTIONAL
1275 IN EFI_HANDLE AgentHandle
,
1276 IN EFI_HANDLE ControllerHandle
,
1277 IN UINT32 Attributes
1282 Closes a protocol on a handle that was opened using OpenProtocol().
1284 @param Handle The handle for the protocol interface that was previously opened
1285 with OpenProtocol(), and is now being closed.
1286 @param Protocol The published unique identifier of the protocol.
1287 @param AgentHandle The handle of the agent that is closing the protocol interface.
1288 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1289 UEFI Driver Model, then this parameter is the controller handle
1290 that required the protocol interface.
1292 @retval EFI_SUCCESS The protocol instance was closed.
1293 @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.
1294 2) AgentHandle is not a valid EFI_HANDLE.
1295 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
1296 4) Protocol is NULL.
1297 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1298 2) The protocol interface specified by Handle and Protocol is not
1299 currently open by AgentHandle and ControllerHandle.
1304 (EFIAPI
*EFI_CLOSE_PROTOCOL
)(
1305 IN EFI_HANDLE Handle
,
1306 IN EFI_GUID
*Protocol
,
1307 IN EFI_HANDLE AgentHandle
,
1308 IN EFI_HANDLE ControllerHandle
1312 /// EFI Oprn Protocol Information Entry
1315 EFI_HANDLE AgentHandle
;
1316 EFI_HANDLE ControllerHandle
;
1319 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1322 Retrieves the list of agents that currently have a protocol interface opened.
1324 @param Handle The handle for the protocol interface that is being queried.
1325 @param Protocol The published unique identifier of the protocol.
1326 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1327 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1328 @param EntryCount A pointer to the number of entries in EntryBuffer.
1330 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1331 number of entries was returned EntryCount.
1332 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1333 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1338 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
)(
1339 IN EFI_HANDLE Handle
,
1340 IN EFI_GUID
*Protocol
,
1341 OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1342 OUT UINTN
*EntryCount
1346 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1349 @param Handle The handle from which to retrieve the list of protocol interface
1351 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1352 installed on Handle.
1353 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1356 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1357 ProtocolBuffer. The number of protocol interface GUIDs was
1358 returned in ProtocolBufferCount.
1359 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1360 @retval EFI_INVALID_PARAMETER Handle is NULL.
1361 @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
1362 @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
1363 @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
1368 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
)(
1369 IN EFI_HANDLE Handle
,
1370 OUT EFI_GUID
***ProtocolBuffer
,
1371 OUT UINTN
*ProtocolBufferCount
1375 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1377 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1378 @param Event Event that is to be signaled whenever a protocol interface is registered
1380 @param Registration A pointer to a memory location to receive the registration value.
1382 @retval EFI_SUCCESS The notification event has been registered.
1383 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1384 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1385 @retval EFI_INVALID_PARAMETER Event is NULL.
1386 @retval EFI_INVALID_PARAMETER Registration is NULL.
1391 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
)(
1392 IN EFI_GUID
*Protocol
,
1394 OUT VOID
**Registration
1398 /// Enumeration of EFI Locate Search Types
1402 /// Retrieve all the handles in the handle database.
1406 /// Retrieve the next handle fron a RegisterProtocolNotify() event.
1410 /// Retrieve the set of handles from the handle database that support a
1411 /// specified protocol.
1414 } EFI_LOCATE_SEARCH_TYPE
;
1417 Returns an array of handles that support a specified protocol.
1419 @param SearchType Specifies which handle(s) are to be returned.
1420 @param Protocol Specifies the protocol to search by.
1421 @param SearchKey Specifies the search key.
1422 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1423 the array returned in Buffer (if the buffer was large enough) or the
1424 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1426 @param Buffer The buffer in which the array is returned.
1428 @retval EFI_SUCCESS The array of handles was returned.
1429 @retval EFI_NOT_FOUND No handles match the search.
1430 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1431 @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
1432 @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
1433 @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
1434 @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
1435 @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
1440 (EFIAPI
*EFI_LOCATE_HANDLE
)(
1441 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1442 IN EFI_GUID
*Protocol
, OPTIONAL
1443 IN VOID
*SearchKey
, OPTIONAL
1444 IN OUT UINTN
*BufferSize
,
1445 OUT EFI_HANDLE
*Buffer
1449 Locates the handle to a device on the device path that supports the specified protocol.
1451 @param Protocol Specifies the protocol to search for.
1452 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1453 path pointer is modified to point to the remaining part of the device
1455 @param Device A pointer to the returned device handle.
1457 @retval EFI_SUCCESS The resulting handle was returned.
1458 @retval EFI_NOT_FOUND No handles match the search.
1459 @retval EFI_INVALID_PARAMETER Protocol is NULL.
1460 @retval EFI_INVALID_PARAMETER DevicePath is NULL.
1461 @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
1466 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
)(
1467 IN EFI_GUID
*Protocol
,
1468 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1469 OUT EFI_HANDLE
*Device
1473 Adds, updates, or removes a configuration table entry from the EFI System Table.
1475 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1476 @param Table A pointer to the configuration table for the entry to add, update, or
1477 remove. May be NULL.
1479 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1480 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1481 @retval EFI_INVALID_PARAMETER Guid is not valid.
1482 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1487 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
)(
1493 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1495 @param SearchType Specifies which handle(s) are to be returned.
1496 @param Protocol Provides the protocol to search by.
1497 This parameter is only valid for a SearchType of ByProtocol.
1498 @param SearchKey Supplies the search key depending on the SearchType.
1499 @param NoHandles The number of handles returned in Buffer.
1500 @param Buffer A pointer to the buffer to return the requested array of handles that
1503 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1504 handles in Buffer was returned in NoHandles.
1505 @retval EFI_NOT_FOUND No handles match the search.
1506 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1507 @retval EFI_INVALID_PARAMETER NoHandles is NULL.
1508 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1513 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
)(
1514 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1515 IN EFI_GUID
*Protocol
, OPTIONAL
1516 IN VOID
*SearchKey
, OPTIONAL
1517 IN OUT UINTN
*NoHandles
,
1518 OUT EFI_HANDLE
**Buffer
1522 Returns the first protocol instance that matches the given protocol.
1524 @param Protocol Provides the protocol to search for.
1525 @param Registration Optional registration key returned from
1526 RegisterProtocolNotify().
1527 @param Interface On return, a pointer to the first interface that matches Protocol and
1530 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1532 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1534 @retval EFI_INVALID_PARAMETER Interface is NULL.
1539 (EFIAPI
*EFI_LOCATE_PROTOCOL
)(
1540 IN EFI_GUID
*Protocol
,
1541 IN VOID
*Registration
, OPTIONAL
1542 OUT VOID
**Interface
1546 /// EFI Capsule Block Descriptor
1550 /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
1555 /// Physical address of the data block. This member of the union is
1556 /// used if Length is not equal to zero.
1558 EFI_PHYSICAL_ADDRESS DataBlock
;
1560 /// Physical address of another block of
1561 /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
1562 /// member of the union is used if Length is equal to zero. If
1563 /// ContinuationPointer is zero this entry represents the end of the list.
1565 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1567 } EFI_CAPSULE_BLOCK_DESCRIPTOR
;
1570 /// EFI Capsule Header
1574 /// A GUID that defines the contents of a capsule.
1576 EFI_GUID CapsuleGuid
;
1578 /// The size of the capsule header. This may be larger than the size of
1579 /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
1580 /// extended header entries
1584 /// Bit-mapped list describing the capsule attributes. The Flag values
1585 /// of 0x0000 ¨C 0xFFFF are defined by CapsuleGuid. Flag values
1586 /// of 0x10000 ¨C 0xFFFF0000 are defined by this specification
1590 /// Size in bytes of the capsule.
1592 UINT32 CapsuleImageSize
;
1593 } EFI_CAPSULE_HEADER
;
1596 /// The EFI System Table entry must point to an array of capsules
1597 /// that contain the same CapsuleGuid value. The array must be
1598 /// prefixed by a UINT32 that represents the size of the array of capsules.
1602 /// the size of the array of capsules.
1604 UINT32 CapsuleArrayNumber
;
1606 /// Point to an array of capsules that contain the same CapsuleGuid value.
1608 VOID
* CapsulePtr
[1];
1609 } EFI_CAPSULE_TABLE
;
1611 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1612 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1615 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1616 consumption, the firmware may process the capsule immediately. If the payload should persist
1617 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1618 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1619 part of the reset process.
1621 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1622 being passed into update capsule.
1623 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1625 @param ScatterGatherList Physical pointer to a set of
1626 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1627 location in physical memory of a set of capsules.
1629 @retval EFI_SUCCESS Valid capsule was passed. If
1630 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1631 capsule has been successfully processed by the firmware.
1632 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1633 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL.
1634 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
1635 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
1640 (EFIAPI
*EFI_UPDATE_CAPSULE
)(
1641 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1642 IN UINTN CapsuleCount
,
1643 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1647 Returns if the capsule can be supported via UpdateCapsule().
1649 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1650 being passed into update capsule.
1651 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1653 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1654 support as an argument to UpdateCapsule() via
1655 CapsuleHeaderArray and ScatterGatherList.
1656 @param ResetType Returns the type of reset required for the capsule update.
1658 @retval EFI_SUCCESS Valid answer returned.
1659 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1660 MaximumCapsuleSize and ResetType are undefined.
1661 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1662 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
1667 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
)(
1668 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1669 IN UINTN CapsuleCount
,
1670 OUT UINT64
*MaximumCapsuleSize
,
1671 OUT EFI_RESET_TYPE
*ResetType
1675 Returns information about the EFI variables.
1677 @param Attributes Attributes bitmask to specify the type of variables on
1678 which to return information.
1679 @param MaximumVariableStorageSize On output the maximum size of the storage space
1680 available for the EFI variables associated with the
1681 attributes specified.
1682 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1683 available for the EFI variables associated with the
1684 attributes specified.
1685 @param MaximumVariableSize Returns the maximum size of the individual EFI
1686 variables associated with the attributes specified.
1688 @retval EFI_SUCCESS Valid answer returned.
1689 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1690 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1691 MaximumVariableStorageSize,
1692 RemainingVariableStorageSize, MaximumVariableSize
1698 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
)(
1699 IN UINT32 Attributes
,
1700 OUT UINT64
*MaximumVariableStorageSize
,
1701 OUT UINT64
*RemainingVariableStorageSize
,
1702 OUT UINT64
*MaximumVariableSize
1707 // EFI Runtime Services Table
1709 #define EFI_SYSTEM_TABLE_SIGNATURE EFI_SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
1710 #define EFI_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1711 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
1712 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
1713 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
1714 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
1716 #define EFI_RUNTIME_SERVICES_SIGNATURE EFI_SIGNATURE_64 ('R','U','N','T','S','E','R','V')
1717 #define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION
1720 /// EFI Runtime Services Table
1724 /// The table header for the EFI Runtime Services Table.
1726 EFI_TABLE_HEADER Hdr
;
1731 EFI_GET_TIME GetTime
;
1732 EFI_SET_TIME SetTime
;
1733 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1734 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1737 // Virtual Memory Services
1739 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1740 EFI_CONVERT_POINTER ConvertPointer
;
1743 // Variable Services
1745 EFI_GET_VARIABLE GetVariable
;
1746 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1747 EFI_SET_VARIABLE SetVariable
;
1750 // Miscellaneous Services
1752 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1753 EFI_RESET_SYSTEM ResetSystem
;
1756 // UEFI 2.0 Capsule Services
1758 EFI_UPDATE_CAPSULE UpdateCapsule
;
1759 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1762 // Miscellaneous UEFI 2.0 Service
1764 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1765 } EFI_RUNTIME_SERVICES
;
1768 #define EFI_BOOT_SERVICES_SIGNATURE EFI_SIGNATURE_64 ('B','O','O','T','S','E','R','V')
1769 #define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION
1772 /// EFI Boot Services Table
1776 /// The table header for the EFI Boot Services Table.
1778 EFI_TABLE_HEADER Hdr
;
1781 // Task Priority Services
1783 EFI_RAISE_TPL RaiseTPL
;
1784 EFI_RESTORE_TPL RestoreTPL
;
1789 EFI_ALLOCATE_PAGES AllocatePages
;
1790 EFI_FREE_PAGES FreePages
;
1791 EFI_GET_MEMORY_MAP GetMemoryMap
;
1792 EFI_ALLOCATE_POOL AllocatePool
;
1793 EFI_FREE_POOL FreePool
;
1796 // Event & Timer Services
1798 EFI_CREATE_EVENT CreateEvent
;
1799 EFI_SET_TIMER SetTimer
;
1800 EFI_WAIT_FOR_EVENT WaitForEvent
;
1801 EFI_SIGNAL_EVENT SignalEvent
;
1802 EFI_CLOSE_EVENT CloseEvent
;
1803 EFI_CHECK_EVENT CheckEvent
;
1806 // Protocol Handler Services
1808 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1809 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1810 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1811 EFI_HANDLE_PROTOCOL HandleProtocol
;
1813 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1814 EFI_LOCATE_HANDLE LocateHandle
;
1815 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1816 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1821 EFI_IMAGE_LOAD LoadImage
;
1822 EFI_IMAGE_START StartImage
;
1824 EFI_IMAGE_UNLOAD UnloadImage
;
1825 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1828 // Miscellaneous Services
1830 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1832 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1835 // DriverSupport Services
1837 EFI_CONNECT_CONTROLLER ConnectController
;
1838 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1841 // Open and Close Protocol Services
1843 EFI_OPEN_PROTOCOL OpenProtocol
;
1844 EFI_CLOSE_PROTOCOL CloseProtocol
;
1845 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1850 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1851 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1852 EFI_LOCATE_PROTOCOL LocateProtocol
;
1853 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1854 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1857 // 32-bit CRC Services
1859 EFI_CALCULATE_CRC32 CalculateCrc32
;
1862 // Miscellaneous Services
1864 EFI_COPY_MEM CopyMem
;
1866 EFI_CREATE_EVENT_EX CreateEventEx
;
1867 } EFI_BOOT_SERVICES
;
1870 /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
1871 /// EFI System Table.
1875 /// The 128-bit GUID value that uniquely identifies the system configuration table.
1877 EFI_GUID VendorGuid
;
1879 /// A pointer to the table associated with VendorGuid.
1882 } EFI_CONFIGURATION_TABLE
;
1885 /// EFI System Table
1889 /// The table header for the EFI System Table.
1891 EFI_TABLE_HEADER Hdr
;
1893 /// A pointer to a null terminated Unicode string that identifies
1894 /// the vendor that produces the system firmware for the platform.
1896 CHAR16
*FirmwareVendor
;
1898 /// A firmware vendor specific value that identifies the revision
1899 /// of the system firmware for the platform.
1901 UINT32 FirmwareRevision
;
1903 /// The handle for the active console input device.
1905 EFI_HANDLE ConsoleInHandle
;
1907 /// A pointer to the SIMPLE_INPUT_PROTOCOL interface that is
1908 /// associated with ConsoleInHandle.
1910 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*ConIn
;
1912 /// The handle for the active console output device.
1914 EFI_HANDLE ConsoleOutHandle
;
1916 /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1917 /// that is associated with ConsoleOutHandle.
1919 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
;
1921 /// The handle for the active standard error console device.
1923 EFI_HANDLE StandardErrorHandle
;
1925 /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface
1926 /// that is associated with StandardErrorHandle.
1928 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*StdErr
;
1930 /// A pointer to the EFI Runtime Services Table.
1932 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1934 /// A pointer to the EFI Boot Services Table.
1936 EFI_BOOT_SERVICES
*BootServices
;
1938 /// The number of system configuration tables in the buffer ConfigurationTable.
1940 UINTN NumberOfTableEntries
;
1942 /// A pointer to the system configuration tables.
1943 /// The number of entries in the table is NumberOfTableEntries.
1945 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
1949 This is the declaration of an EFI image entry point. This entry point is
1950 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
1951 both device drivers and bus drivers.
1953 @param ImageHandle The firmware allocated handle for the UEFI image.
1954 @param SystemTable A pointer to the EFI System Table.
1956 @retval EFI_SUCCESS The operation completed successfully.
1957 @retval Others Some unexpected error happened.
1961 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
)(
1962 IN EFI_HANDLE ImageHandle
,
1963 IN EFI_SYSTEM_TABLE
*SystemTable
1967 // EFI Load Options Attributes
1969 #define LOAD_OPTION_ACTIVE 0x00000001
1970 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
1971 #define LOAD_OPTION_HIDDEN 0x00000008
1972 #define LOAD_OPTION_CATEGORY 0x00001F00
1974 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
1975 #define LOAD_OPTION_CATEGORY_APP 0x00000100
1977 #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001
1978 #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002
1979 #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300
1982 /// EFI Boot Key Data
1987 /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
1989 UINT32 Revision
: 8;
1991 /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
1993 UINT32 ShiftPressed
: 1;
1995 /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
1997 UINT32 ControlPressed
: 1;
1999 /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
2001 UINT32 AltPressed
: 1;
2003 /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
2005 UINT32 LogoPressed
: 1;
2007 /// The Menu key must be pressed (1) or must not be pressed (0).
2009 UINT32 MenuPressed
: 1;
2011 /// The SysReq key must be pressed (1) or must not be pressed (0).
2013 UINT32 SysReqPessed
: 1;
2014 UINT32 Reserved
: 16;
2016 /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
2017 /// zero, then only the shift state is considered. If more than one, then the boot option will
2018 /// only be launched if all of the specified keys are pressed with the same shift state.
2020 UINT32 InputKeyCount
: 2;
2023 } EFI_BOOT_KEY_DATA
;
2030 /// Specifies options about how the key will be processed.
2032 EFI_BOOT_KEY_DATA KeyData
;
2034 /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
2035 /// which BootOption refers. If the CRC-32s do not match this value, then this key
2036 /// option is ignored.
2038 UINT32 BootOptionCrc
;
2040 /// The Boot#### option which will be invoked if this key is pressed and the boot option
2041 /// is active (LOAD_OPTION_ACTIVE is set).
2045 /// The key codes to compare against those returned by the
2046 /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
2047 /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
2049 //EFI_INPUT_KEY Keys[];
2052 #define EFI_KEY_OPTION_SHIFT 0x00000001
2053 #define EFI_KEY_OPTION_CONTROL 0x00000002
2054 #define EFI_KEY_OPTION_ALT 0x00000004
2055 #define EFI_KEY_OPTION_LOGO 0x00000008
2056 #define EFI_KEY_OPTION_MENU 0x00000010
2057 #define EFI_KEY_OPTION_SYSREQ 0x00000020
2058 #define EFI_KEY_CODE_COUNT 0x00000300
2061 // EFI File location to boot from on removable media devices
2063 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2064 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2065 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2067 #if defined (MDE_CPU_IA32)
2068 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2069 #elif defined (MDE_CPU_IPF)
2070 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2071 #elif defined (MDE_CPU_X64)
2072 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2073 #elif defined (MDE_CPU_EBC)
2075 #error Unknown Processor Type
2078 #include <Uefi/UefiPxe.h>
2079 #include <Uefi/UefiGpt.h>
2080 #include <Uefi/UefiInternalFormRepresentation.h>