2 Include file that supportes UEFI.
4 This include file must only contain things defined in the UEFI 2.0 specification.
5 If a code construct is defined in the UEFI 2.0 specification it must be included
8 Copyright (c) 2006 - 2007, 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.
17 Module Name: UefiSpec.h
21 #ifndef __UEFI_SPEC_H__
22 #define __UEFI_SPEC_H__
24 #include <Common/MultiPhase.h>
27 // EFI Data Types derived from other EFI data types.
29 #define NULL_HANDLE ((VOID *) 0)
31 typedef VOID
*EFI_EVENT
;
32 typedef UINTN EFI_TPL
;
65 // possible caching types for the memory range
67 #define EFI_MEMORY_UC 0x0000000000000001ULL
68 #define EFI_MEMORY_WC 0x0000000000000002ULL
69 #define EFI_MEMORY_WT 0x0000000000000004ULL
70 #define EFI_MEMORY_WB 0x0000000000000008ULL
71 #define EFI_MEMORY_UCE 0x0000000000000010ULL
74 // physical memory protection on range
76 #define EFI_MEMORY_WP 0x0000000000001000ULL
77 #define EFI_MEMORY_RP 0x0000000000002000ULL
78 #define EFI_MEMORY_XP 0x0000000000004000ULL
81 // range requires a runtime mapping
83 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
85 typedef UINT64 EFI_VIRTUAL_ADDRESS
;
87 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
91 EFI_PHYSICAL_ADDRESS PhysicalStart
;
92 EFI_VIRTUAL_ADDRESS VirtualStart
;
95 } EFI_MEMORY_DESCRIPTOR
;
98 // EFI_FIELD_OFFSET - returns the byte offset to a field within a structure
100 #define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
102 #include <Protocol/DevicePath.h>
103 #include <Protocol/SimpleTextIn.h>
104 #include <Protocol/SimpleTextOut.h>
107 // Declare forward referenced data structures
109 typedef struct _EFI_SYSTEM_TABLE EFI_SYSTEM_TABLE
;
112 Allocates memory pages from the system.
114 @param Type The type of allocation to perform.
115 @param MemoryType The type of memory to allocate.
116 @param Pages The number of contiguous 4 KB pages to allocate.
117 @param Memory Pointer to a physical address. On input, the way in which the address is
118 used depends on the value of Type.
120 @retval EFI_SUCCESS The requested pages were allocated.
121 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
122 AllocateMaxAddress or AllocateAddress.
123 2) MemoryType is in the range
124 EfiMaxMemoryType..0x7FFFFFFF.
125 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
126 @retval EFI_NOT_FOUND The requested pages could not be found.
131 (EFIAPI
*EFI_ALLOCATE_PAGES
) (
132 IN EFI_ALLOCATE_TYPE Type
,
133 IN EFI_MEMORY_TYPE MemoryType
,
135 IN OUT EFI_PHYSICAL_ADDRESS
*Memory
141 @param Memory The base physical address of the pages to be freed.
142 @param Pages The number of contiguous 4 KB pages to free.
144 @retval EFI_SUCCESS The requested pages were freed.
145 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
146 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
152 (EFIAPI
*EFI_FREE_PAGES
) (
153 IN EFI_PHYSICAL_ADDRESS Memory
,
158 Returns the current memory map.
160 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
161 @param MemoryMap A pointer to the buffer in which firmware places the current memory
163 @param MapKey A pointer to the location in which firmware returns the key for the
165 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
166 an individual EFI_MEMORY_DESCRIPTOR.
167 @param DescriptorVersion A pointer to the location in which firmware returns the version number
168 associated with the EFI_MEMORY_DESCRIPTOR.
170 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
171 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
172 needed to hold the memory map is returned in MemoryMapSize.
173 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
174 2) The MemoryMap buffer is not too small and MemoryMap is
180 (EFIAPI
*EFI_GET_MEMORY_MAP
) (
181 IN OUT UINTN
*MemoryMapSize
,
182 IN OUT EFI_MEMORY_DESCRIPTOR
*MemoryMap
,
184 OUT UINTN
*DescriptorSize
,
185 OUT UINT32
*DescriptorVersion
188 #define NextMemoryDescriptor(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))
189 #define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) NextMemoryDescriptor (_Ptr, _Size)
192 Allocates pool memory.
194 @param PoolType The type of pool to allocate.
195 @param Size The number of bytes to allocate from the pool.
196 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
199 @retval EFI_SUCCESS The requested number of bytes was allocated.
200 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
201 @retval EFI_INVALID_PARAMETER PoolType was invalid.
206 (EFIAPI
*EFI_ALLOCATE_POOL
) (
207 IN EFI_MEMORY_TYPE PoolType
,
213 Returns pool memory to the system.
215 @param Buffer Pointer to the buffer to free.
217 @retval EFI_SUCCESS The memory was returned to the system.
218 @retval EFI_INVALID_PARAMETER Buffer was invalid.
223 (EFIAPI
*EFI_FREE_POOL
) (
228 Changes the runtime addressing mode of EFI firmware from physical to virtual.
230 @param MemoryMapSize The size in bytes of VirtualMap.
231 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
232 @param DescriptorVersion The version of the structure entries in VirtualMap.
233 @param VirtualMap An array of memory descriptors which contain new virtual
234 address mapping information for all runtime ranges.
236 @retval EFI_SUCCESS The virtual address map has been applied.
237 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
238 virtual address mapped mode.
239 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
240 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
241 map that requires a mapping.
242 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
248 (EFIAPI
*EFI_SET_VIRTUAL_ADDRESS_MAP
) (
249 IN UINTN MemoryMapSize
,
250 IN UINTN DescriptorSize
,
251 IN UINT32 DescriptorVersion
,
252 IN EFI_MEMORY_DESCRIPTOR
*VirtualMap
256 Connects one or more drivers to a controller.
258 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
259 @param DriverImageHandle A pointer to an ordered list handles that support the
260 EFI_DRIVER_BINDING_PROTOCOL.
261 @param RemainingDevicePath A pointer to the device path that specifies a child of the
262 controller specified by ControllerHandle.
263 @param Recursive If TRUE, then ConnectController() is called recursively
264 until the entire tree of controllers below the controller specified
265 by ControllerHandle have been created. If FALSE, then
266 the tree of controllers is only expanded one level.
268 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
269 2) No drivers were connected to ControllerHandle, but
270 RemainingDevicePath is not NULL, and it is an End Device
272 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
273 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
274 present in the system.
275 2) No drivers were connected to ControllerHandle.
280 (EFIAPI
*EFI_CONNECT_CONTROLLER
) (
281 IN EFI_HANDLE ControllerHandle
,
282 IN EFI_HANDLE
*DriverImageHandle
, OPTIONAL
283 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
, OPTIONAL
288 Disconnects one or more drivers from a controller.
290 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
291 @param DriverImageHandle The driver to disconnect from ControllerHandle.
292 @param ChildHandle The handle of the child to destroy.
294 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
295 2) On entry, no drivers are managing ControllerHandle.
296 3) DriverImageHandle is not NULL, and on entry
297 DriverImageHandle is not managing ControllerHandle.
299 @retval EFI_INVALID_PARAMETER One ore more parameters are invalid.
300 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
302 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
307 (EFIAPI
*EFI_DISCONNECT_CONTROLLER
) (
308 IN EFI_HANDLE ControllerHandle
,
309 IN EFI_HANDLE DriverImageHandle
, OPTIONAL
310 IN EFI_HANDLE ChildHandle OPTIONAL
314 // ConvertPointer DebugDisposition type.
316 #define EFI_OPTIONAL_PTR 0x00000001
317 #define EFI_OPTIONAL_POINTER EFI_OPTIONAL_PTR
320 Determines the new virtual address that is to be used on subsequent memory accesses.
322 @param DebugDisposition Supplies type information for the pointer being converted.
323 @param Address A pointer to a pointer that is to be fixed to be the value needed
324 for the new virtual address mappings being applied.
326 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
327 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
328 2) *Address is NULL and DebugDisposition does
329 not have the EFI_OPTIONAL_PTR bit set.
330 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
331 of the current memory map. This is normally fatal.
336 (EFIAPI
*EFI_CONVERT_POINTER
) (
337 IN UINTN DebugDisposition
,
338 IN OUT VOID
**Address
342 // EFI Event Types (name defined in spec)
344 #define EVENT_TIMER 0x80000000
345 #define EVENT_RUNTIME 0x40000000
346 #define EVENT_RUNTIME_CONTEXT 0x20000000
348 #define EVENT_NOTIFY_WAIT 0x00000100
349 #define EVENT_NOTIFY_SIGNAL 0x00000200
351 #define EVENT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
352 #define EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
355 // Prior to UEFI 2.0 Tiano extended these enums. This was replaced by
356 // CreateEventEx() Event Groups in UEFI 2.0
358 #define EFI_EVENT_NOTIFY_SIGNAL_ALL 0x00000400
360 #define EFI_EVENT_SIGNAL_READY_TO_BOOT 0x00000203
361 #define EFI_EVENT_SIGNAL_LEGACY_BOOT 0x00000204
365 // EFI Event Types (name following coding style)
367 #define EFI_EVENT_TIMER EVENT_TIMER
368 #define EFI_EVENT_RUNTIME EVENT_RUNTIME
369 #define EFI_EVENT_RUNTIME_CONTEXT EVENT_RUNTIME_CONTEXT
371 #define EFI_EVENT_NOTIFY_WAIT EVENT_NOTIFY_WAIT
372 #define EFI_EVENT_NOTIFY_SIGNAL EVENT_NOTIFY_SIGNAL
374 #define EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES EVENT_SIGNAL_EXIT_BOOT_SERVICES
375 #define EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
379 Invoke a notification event
381 @param Event Event whose notification function is being invoked.
382 @param Context Pointer to the notification function's context,
383 which is implementation-dependent.
388 (EFIAPI
*EFI_EVENT_NOTIFY
) (
396 @param Type The type of event to create and its mode and attributes.
397 @param NotifyTpl Pointer to the notification function's context.
398 @param NotifyFunction Pointer to the event's notification function, if any.
399 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
400 Context in the notification function.
401 @param Event Pointer to the newly created event if the call succeeds; undefined
404 @retval EFI_SUCCESS The event structure was created.
405 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
406 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
411 (EFIAPI
*EFI_CREATE_EVENT
) (
413 IN EFI_TPL NotifyTpl
,
414 IN EFI_EVENT_NOTIFY NotifyFunction
,
415 IN VOID
*NotifyContext
,
420 Creates an event in a group.
422 @param Type The type of event to create and its mode and attributes.
423 @param NotifyTpl Pointer to the notification function's context.
424 @param NotifyFunction Pointer to the event's notification function, if any.
425 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
426 Context in the notification function.
427 @param EventGroup Pointer to the unique identifier of the group to which this event belongs.
428 @param Event Pointer to the newly created event if the call succeeds; undefined
431 @retval EFI_SUCCESS The event structure was created.
432 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
433 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
438 (EFIAPI
*EFI_CREATE_EVENT_EX
) (
440 IN EFI_TPL NotifyTpl OPTIONAL
,
441 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL
,
442 IN CONST VOID
*NotifyContext OPTIONAL
,
443 IN CONST EFI_GUID
*EventGroup OPTIONAL
,
454 Sets the type of timer and the trigger time for a timer event.
456 @param Event The timer event that is to be signaled at the specified time.
457 @param Type The type of time that is specified in TriggerTime.
458 @param TriggerTime The number of 100ns units until the timer expires.
460 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
461 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
466 (EFIAPI
*EFI_SET_TIMER
) (
468 IN EFI_TIMER_DELAY Type
,
469 IN UINT64 TriggerTime
475 @param Event The event to signal.
477 @retval EFI_SUCCESS The event has been signaled.
482 (EFIAPI
*EFI_SIGNAL_EVENT
) (
487 Stops execution until an event is signaled.
489 @param NumberOfEvents The number of events in the Event array.
490 @param Event An array of EFI_EVENT.
491 @param Index Pointer to the index of the event which satisfied the wait condition.
493 @retval EFI_SUCCESS The event indicated by Index was signaled.
494 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
495 2) The event indicated by Index is of type
497 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
502 (EFIAPI
*EFI_WAIT_FOR_EVENT
) (
503 IN UINTN NumberOfEvents
,
511 @param Event The event to close.
513 @retval EFI_SUCCESS The event has been closed.
518 (EFIAPI
*EFI_CLOSE_EVENT
) (
523 Checks whether an event is in the signaled state.
525 @param Event The event to check.
527 @retval EFI_SUCCESS The event is in the signaled state.
528 @retval EFI_NOT_READY The event is not in the signaled state.
529 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
534 (EFIAPI
*EFI_CHECK_EVENT
) (
539 // Task priority level (name defined in spec).
541 #define TPL_APPLICATION 4
542 #define TPL_CALLBACK 8
543 #define TPL_NOTIFY 16
544 #define TPL_HIGH_LEVEL 31
547 // Task priority level (name following coding style).
549 #define EFI_TPL_APPLICATION TPL_APPLICATION
550 #define EFI_TPL_CALLBACK TPL_CALLBACK
551 #define EFI_TPL_NOTIFY TPL_NOTIFY
552 #define EFI_TPL_HIGH_LEVEL TPL_HIGH_LEVEL
555 Raises a task's priority level and returns its previous level.
557 @param NewTpl The new task priority level.
559 @retval Previous task priority level
564 (EFIAPI
*EFI_RAISE_TPL
) (
569 Restores a task's priority level to its previous value.
571 @param OldTpl The previous task priority level to restore
576 (EFIAPI
*EFI_RESTORE_TPL
) (
581 // Variable attributes
583 #define EFI_VARIABLE_NON_VOLATILE 0x00000001
584 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
585 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
588 Returns the value of a variable.
590 @param VariableName A Null-terminated Unicode string that is the name of the
592 @param VendorGuid A unique identifier for the vendor.
593 @param Attributes If not NULL, a pointer to the memory location to return the
594 attributes bitmask for the variable.
595 @param DataSize On input, the size in bytes of the return Data buffer.
596 On output the size of data returned in Data.
597 @param Data The buffer to return the contents of the variable.
599 @retval EFI_SUCCESS The function completed successfully.
600 @retval EFI_NOT_FOUND The variable was not found.
601 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
602 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
603 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
608 (EFIAPI
*EFI_GET_VARIABLE
) (
609 IN CHAR16
*VariableName
,
610 IN EFI_GUID
*VendorGuid
,
611 OUT UINT32
*Attributes
, OPTIONAL
612 IN OUT UINTN
*DataSize
,
617 Enumerates the current variable names.
619 @param VariableNameSize The size of the VariableName buffer.
620 @param VariableName On input, supplies the last VariableName that was returned
621 by GetNextVariableName(). On output, returns the Nullterminated
622 Unicode string of the current variable.
623 @param VendorGuid On input, supplies the last VendorGuid that was returned by
624 GetNextVariableName(). On output, returns the
625 VendorGuid of the current variable.
627 @retval EFI_SUCCESS The function completed successfully.
628 @retval EFI_NOT_FOUND The next variable was not found.
629 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
630 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
631 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
636 (EFIAPI
*EFI_GET_NEXT_VARIABLE_NAME
) (
637 IN OUT UINTN
*VariableNameSize
,
638 IN OUT CHAR16
*VariableName
,
639 IN OUT EFI_GUID
*VendorGuid
643 Sets the value of a variable.
645 @param VariableName A Null-terminated Unicode string that is the name of the
647 @param VendorGuid A unique identifier for the vendor.
648 @param Attributes Attributes bitmask to set for the variable.
649 @param DataSize The size in bytes of the Data buffer.
650 @param Data The contents for the variable.
652 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
653 defined by the Attributes.
654 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
655 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
656 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
657 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
662 (EFIAPI
*EFI_SET_VARIABLE
) (
663 IN CHAR16
*VariableName
,
664 IN EFI_GUID
*VendorGuid
,
665 IN UINT32 Attributes
,
677 } EFI_TIME_CAPABILITIES
;
680 Returns the current time and date information, and the time-keeping capabilities
681 of the hardware platform.
683 @param Time A pointer to storage to receive a snapshot of the current time.
684 @param Capabilities An optional pointer to a buffer to receive the real time clock
685 device's capabilities.
687 @retval EFI_SUCCESS The operation completed successfully.
688 @retval EFI_INVALID_PARAMETER Time is NULL.
689 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
694 (EFIAPI
*EFI_GET_TIME
) (
696 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
700 Sets the current local time and date information.
702 @param Time A pointer to the current time.
704 @retval EFI_SUCCESS The operation completed successfully.
705 @retval EFI_INVALID_PARAMETER A time field is out of range.
706 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
711 (EFIAPI
*EFI_SET_TIME
) (
716 Returns the current wakeup alarm clock setting.
718 @param Enabled Indicates if the alarm is currently enabled or disabled.
719 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
720 @param Time The current alarm setting.
722 @retval EFI_SUCCESS The alarm settings were returned.
723 @retval EFI_INVALID_PARAMETER Any parameter is NULL.
724 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
729 (EFIAPI
*EFI_GET_WAKEUP_TIME
) (
730 OUT BOOLEAN
*Enabled
,
731 OUT BOOLEAN
*Pending
,
736 Sets the system wakeup alarm clock time.
738 @param Enabled Enable or disable the wakeup alarm.
739 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
741 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
742 Enable is FALSE, then the wakeup alarm was disabled.
743 @retval EFI_INVALID_PARAMETER A time field is out of range.
744 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
745 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
750 (EFIAPI
*EFI_SET_WAKEUP_TIME
) (
752 IN EFI_TIME
*Time OPTIONAL
756 This is the declaration of an EFI image entry point. This can be the entry point to an application
757 written to this specification, an EFI boot service driver, or an EFI runtime driver.
759 @param ImageHandle Handle that identifies the loaded image.
760 @param SystemTable System Table for this image.
762 @retval EFI_SUCCESS The operation completed successfully.
767 (EFIAPI
*EFI_IMAGE_ENTRY_POINT
) (
768 IN EFI_HANDLE ImageHandle
,
769 IN EFI_SYSTEM_TABLE
*SystemTable
773 Loads an EFI image into memory.
775 @param BootPolicy If TRUE, indicates that the request originates from the boot
776 manager, and that the boot manager is attempting to load
777 FilePath as a boot selection. Ignored if SourceBuffer is
779 @param ParentImageHandle The caller's image handle.
780 @param FilePath The DeviceHandle specific file path from which the image is
782 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
783 of the image to be loaded.
784 @param SourceSize The size in bytes of SourceBuffer.
785 @param ImageHandle Pointer to the returned image handle that is created when the
786 image is successfully loaded.
788 @retval EFI_SUCCESS Image was loaded into memory correctly.
789 @retval EFI_NOT_FOUND Both SourceBuffer and FilePath are NULL.
790 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
791 @retval EFI_UNSUPPORTED The image type is not supported.
792 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
793 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
795 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
800 (EFIAPI
*EFI_IMAGE_LOAD
) (
801 IN BOOLEAN BootPolicy
,
802 IN EFI_HANDLE ParentImageHandle
,
803 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
804 IN VOID
*SourceBuffer OPTIONAL
,
806 OUT EFI_HANDLE
*ImageHandle
810 Transfers control to a loaded image's entry point.
812 @param ImageHandle Handle of image to be started.
813 @param ExitDataSize Pointer to the size, in bytes, of ExitData.
814 @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
815 Unicode string, optionally followed by additional binary data.
817 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
818 has already been initialized with StartImage
819 @retval Exit code from image Exit code from image
824 (EFIAPI
*EFI_IMAGE_START
) (
825 IN EFI_HANDLE ImageHandle
,
826 OUT UINTN
*ExitDataSize
,
827 OUT CHAR16
**ExitData OPTIONAL
831 Terminates a loaded EFI image and returns control to boot services.
833 @param ImageHandle Handle that identifies the image.
834 @param ExitStatus The image's exit code.
835 @param ExitDataSize The size, in bytes, of ExitData.
836 @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
837 optionally followed by additional binary data.
839 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
840 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
841 started with LoadImage() and StartImage(), but the
842 image is not the currently executing image.
848 IN EFI_HANDLE ImageHandle
,
849 IN EFI_STATUS ExitStatus
,
850 IN UINTN ExitDataSize
,
851 IN CHAR16
*ExitData OPTIONAL
857 @param ImageHandle Handle that identifies the image to be unloaded.
859 @retval EFI_SUCCESS The image has been unloaded.
860 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
861 @retval EFI_UNSUPPORTED The image has been started, and does not support unload.
862 @retval Exit code from the image's unload handler
867 (EFIAPI
*EFI_IMAGE_UNLOAD
) (
868 IN EFI_HANDLE ImageHandle
872 Terminates all boot services.
874 @param ImageHandle Handle that identifies the exiting image.
875 @param MapKey Key to the latest memory map.
877 @retval EFI_SUCCESS Boot services have been terminated.
878 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
883 (EFIAPI
*EFI_EXIT_BOOT_SERVICES
) (
884 IN EFI_HANDLE ImageHandle
,
889 Induces a fine-grained stall.
891 @param Microseconds The number of microseconds to stall execution.
893 @retval EFI_SUCCESS Execution was stalled at least the requested number of
899 (EFIAPI
*EFI_STALL
) (
900 IN UINTN Microseconds
904 Sets the system's watchdog timer.
906 @param Timeout The number of seconds to set the watchdog timer to.
907 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
908 @param DataSize The size, in bytes, of WatchdogData.
909 @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
910 followed by additional binary data.
912 @retval EFI_SUCCESS The timeout has been set.
913 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
914 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
915 @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
921 (EFIAPI
*EFI_SET_WATCHDOG_TIMER
) (
923 IN UINT64 WatchdogCode
,
925 IN CHAR16
*WatchdogData OPTIONAL
932 #if ((EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000))
934 // Tiano extension for capsules that was removed after UEFI 2.0 came out
941 Resets the entire platform.
943 @param ResetType The type of reset to perform.
944 @param ResetStatus The status code for the reset.
945 @param DataSize The size, in bytes, of WatchdogData.
946 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
947 EfiResetShutdown the data buffer starts with a Null-terminated
948 Unicode string, optionally followed by additional binary data.
953 (EFIAPI
*EFI_RESET_SYSTEM
) (
954 IN EFI_RESET_TYPE ResetType
,
955 IN EFI_STATUS ResetStatus
,
957 IN CHAR16
*ResetData OPTIONAL
961 Returns a monotonically increasing count for the platform.
963 @param Count Pointer to returned value.
965 @retval EFI_SUCCESS The next monotonic count was returned.
966 @retval EFI_INVALID_PARAMETER Count is NULL.
967 @retval EFI_DEVICE_ERROR The device is not functioning properly.
972 (EFIAPI
*EFI_GET_NEXT_MONOTONIC_COUNT
) (
977 Returns the next high 32 bits of the platform's monotonic counter.
979 @param HighCount Pointer to returned value.
981 @retval EFI_SUCCESS The next high monotonic count was returned.
982 @retval EFI_INVALID_PARAMETER HighCount is NULL.
983 @retval EFI_DEVICE_ERROR The device is not functioning properly.
988 (EFIAPI
*EFI_GET_NEXT_HIGH_MONO_COUNT
) (
989 OUT UINT32
*HighCount
993 Computes and returns a 32-bit CRC for a data buffer.
995 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
996 @param DataSize The number of bytes in the buffer Data.
997 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1000 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1002 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1007 (EFIAPI
*EFI_CALCULATE_CRC32
) (
1014 Copies the contents of one buffer to another buffer.
1016 @param Destination Pointer to the destination buffer of the memory copy.
1017 @param Source Pointer to the source buffer of the memory copy.
1018 @param Length Number of bytes to copy from Source to Destination.
1023 (EFIAPI
*EFI_COPY_MEM
) (
1024 IN VOID
*Destination
,
1030 The SetMem() function fills a buffer with a specified value.
1032 @param Buffer Pointer to the buffer to fill.
1033 @param Size Number of bytes in Buffer to fill.
1034 @param Value Value to fill Buffer with.
1039 (EFIAPI
*EFI_SET_MEM
) (
1046 // Protocol handler functions
1049 EFI_NATIVE_INTERFACE
1050 } EFI_INTERFACE_TYPE
;
1053 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1054 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1055 more error checking than InstallProtocolInterface(), so it is recommended that
1056 InstallMultipleProtocolInterfaces() be used in place of
1057 InstallProtocolInterface()
1059 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1060 @param Protocol The numeric ID of the protocol interface.
1061 @param InterfaceType Indicates whether Interface is supplied in native form.
1062 @param Interface A pointer to the protocol interface.
1064 @retval EFI_SUCCESS The protocol interface was installed.
1065 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1066 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1071 (EFIAPI
*EFI_INSTALL_PROTOCOL_INTERFACE
) (
1072 IN OUT EFI_HANDLE
*Handle
,
1073 IN EFI_GUID
*Protocol
,
1074 IN EFI_INTERFACE_TYPE InterfaceType
,
1079 Installs one or more protocol interfaces into the boot services environment.
1081 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1082 handle is to be allocated.
1083 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1086 @retval EFI_SUCCESS All the protocol interface was installed.
1087 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1088 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1089 the handle database.
1094 (EFIAPI
*EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES
) (
1095 IN OUT EFI_HANDLE
*Handle
,
1100 Reinstalls a protocol interface on a device handle.
1102 @param Handle Handle on which the interface is to be reinstalled.
1103 @param Protocol The numeric ID of the interface.
1104 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1105 associated with Protocol.
1106 @param NewInterface A pointer to the new interface.
1108 @retval EFI_SUCCESS The protocol interface was reinstalled.
1109 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1110 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1111 because OldInterface is still being used by a
1112 driver that will not release it.
1113 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1118 (EFIAPI
*EFI_REINSTALL_PROTOCOL_INTERFACE
) (
1119 IN EFI_HANDLE Handle
,
1120 IN EFI_GUID
*Protocol
,
1121 IN VOID
*OldInterface
,
1122 IN VOID
*NewInterface
1126 Removes a protocol interface from a device handle. It is recommended that
1127 UninstallMultipleProtocolInterfaces() be used in place of
1128 UninstallProtocolInterface().
1130 @param Handle The handle on which the interface was installed.
1131 @param Protocol The numeric ID of the interface.
1132 @param Interface A pointer to the interface.
1134 @retval EFI_SUCCESS The interface was removed.
1135 @retval EFI_NOT_FOUND The interface was not found.
1136 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1137 is still being used by a driver.
1138 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1143 (EFIAPI
*EFI_UNINSTALL_PROTOCOL_INTERFACE
) (
1144 IN EFI_HANDLE Handle
,
1145 IN EFI_GUID
*Protocol
,
1150 Removes one or more protocol interfaces into the boot services environment.
1152 @param Handle The handle to remove the protocol interfaces from.
1153 @param ... A variable argument list containing pairs of protocol GUIDs and
1154 protocol interfaces.
1156 @retval EFI_SUCCESS All the protocol interfaces were removed.
1157 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1162 (EFIAPI
*EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES
) (
1163 IN EFI_HANDLE Handle
,
1168 Queries a handle to determine if it supports a specified protocol.
1170 @param Handle The handle being queried.
1171 @param Protocol The published unique identifier of the protocol.
1172 @param Interface Supplies the address where a pointer to the corresponding Protocol
1173 Interface is returned.
1174 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1175 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1176 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1181 (EFIAPI
*EFI_HANDLE_PROTOCOL
) (
1182 IN EFI_HANDLE Handle
,
1183 IN EFI_GUID
*Protocol
,
1184 OUT VOID
**Interface
1187 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1188 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1189 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1190 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1191 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1192 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1195 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1196 handle, it opens the protocol on behalf of the calling agent.
1198 @param Handle The handle for the protocol interface that is being opened.
1199 @param Protocol The published unique identifier of the protocol.
1200 @param Interface Supplies the address where a pointer to the corresponding Protocol
1201 Interface is returned.
1202 @param AgentHandle The handle of the agent that is opening the protocol interface
1203 specified by Protocol and Interface.
1204 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1205 UEFI Driver Model, then this parameter is the controller handle
1206 that requires the protocol interface. If the agent does not follow
1207 the UEFI Driver Model, then this parameter is optional and may
1209 @param Attributes The open mode of the protocol interface specified by Handle
1212 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1213 protocol interface was returned in Interface.
1214 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1215 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1216 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1217 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1218 handle is the same as AgentHandle.
1223 (EFIAPI
*EFI_OPEN_PROTOCOL
) (
1224 IN EFI_HANDLE Handle
,
1225 IN EFI_GUID
*Protocol
,
1226 OUT VOID
**Interface
,
1227 IN EFI_HANDLE AgentHandle
,
1228 IN EFI_HANDLE ControllerHandle
, OPTIONAL
1229 IN UINT32 Attributes
1234 Closes a protocol on a handle that was opened using OpenProtocol().
1236 @param Handle The handle for the protocol interface that was previously opened
1237 with OpenProtocol(), and is now being closed.
1238 @param Protocol The published unique identifier of the protocol.
1239 @param Interface Supplies the address where a pointer to the corresponding Protocol
1240 Interface is returned.
1241 @param AgentHandle The handle of the agent that is closing the protocol interface.
1242 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1243 UEFI Driver Model, then this parameter is the controller handle
1244 that required the protocol interface.
1246 @retval EFI_SUCCESS The protocol instance was closed.
1247 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1248 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1249 2) The protocol interface specified by Handle and Protocol is not
1250 currently open by AgentHandle and ControllerHandle.
1255 (EFIAPI
*EFI_CLOSE_PROTOCOL
) (
1256 IN EFI_HANDLE Handle
,
1257 IN EFI_GUID
*Protocol
,
1258 IN EFI_HANDLE AgentHandle
,
1259 IN EFI_HANDLE ControllerHandle
1263 EFI_HANDLE AgentHandle
;
1264 EFI_HANDLE ControllerHandle
;
1267 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
;
1270 Retrieves the list of agents that currently have a protocol interface opened.
1272 @param Handle The handle for the protocol interface that is being queried.
1273 @param Protocol The published unique identifier of the protocol.
1274 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1275 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1276 @param EntryCount A pointer to the number of entries in EntryBuffer.
1278 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1279 number of entries was returned EntryCount.
1280 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1281 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1286 (EFIAPI
*EFI_OPEN_PROTOCOL_INFORMATION
) (
1287 IN EFI_HANDLE Handle
,
1288 IN EFI_GUID
*Protocol
,
1289 IN EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
**EntryBuffer
,
1290 OUT UINTN
*EntryCount
1294 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1297 @param Handle The handle from which to retrieve the list of protocol interface
1299 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1300 installed on Handle.
1301 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1304 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1305 ProtocolBuffer. The number of protocol interface GUIDs was
1306 returned in ProtocolBufferCount.
1307 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1308 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1313 (EFIAPI
*EFI_PROTOCOLS_PER_HANDLE
) (
1314 IN EFI_HANDLE Handle
,
1315 OUT EFI_GUID
***ProtocolBuffer
,
1316 OUT UINTN
*ProtocolBufferCount
1320 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1322 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1323 @param Event Event that is to be signaled whenever a protocol interface is registered
1325 @param Registration A pointer to a memory location to receive the registration value.
1327 @retval EFI_SUCCESS The notification event has been registered.
1328 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1329 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1334 (EFIAPI
*EFI_REGISTER_PROTOCOL_NOTIFY
) (
1335 IN EFI_GUID
*Protocol
,
1337 OUT VOID
**Registration
1344 } EFI_LOCATE_SEARCH_TYPE
;
1347 Returns an array of handles that support a specified protocol.
1349 @param SearchType Specifies which handle(s) are to be returned.
1350 @param Protocol Specifies the protocol to search by.
1351 @param SearchKey Specifies the search key.
1352 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1353 the array returned in Buffer (if the buffer was large enough) or the
1354 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1356 @param Buffer The buffer in which the array is returned.
1358 @retval EFI_SUCCESS The array of handles was returned.
1359 @retval EFI_NOT_FOUND No handles match the search.
1360 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1361 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1366 (EFIAPI
*EFI_LOCATE_HANDLE
) (
1367 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1368 IN EFI_GUID
*Protocol
, OPTIONAL
1369 IN VOID
*SearchKey
, OPTIONAL
1370 IN OUT UINTN
*BufferSize
,
1371 OUT EFI_HANDLE
*Buffer
1375 Locates the handle to a device on the device path that supports the specified protocol.
1377 @param Protocol Specifies the protocol to search for.
1378 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1379 path pointer is modified to point to the remaining part of the device
1381 @param Device A pointer to the returned device handle.
1383 @retval EFI_SUCCESS The resulting handle was returned.
1384 @retval EFI_NOT_FOUND No handles match the search.
1385 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1390 (EFIAPI
*EFI_LOCATE_DEVICE_PATH
) (
1391 IN EFI_GUID
*Protocol
,
1392 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
1393 OUT EFI_HANDLE
*Device
1397 Adds, updates, or removes a configuration table entry from the EFI System Table.
1399 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1400 @param Table A pointer to the configuration table for the entry to add, update, or
1401 remove. May be NULL.
1403 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1404 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1405 @retval EFI_INVALID_PARAMETER Guid is not valid.
1406 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1411 (EFIAPI
*EFI_INSTALL_CONFIGURATION_TABLE
) (
1419 @retval EFI_SUCCESS The operation has been completed successfully.
1424 (EFIAPI
*EFI_RESERVED_SERVICE
) (
1429 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1431 @param SearchType Specifies which handle(s) are to be returned.
1432 @param Protocol Specifies the protocol to search by.
1433 @param SearchKey Supplies the search key depending on the SearchType.
1434 @param NoHandles The number of handles returned in Buffer.
1435 @param Buffer A pointer to the buffer to return the requested array of handles that
1438 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1439 handles in Buffer was returned in NoHandles.
1440 @retval EFI_NOT_FOUND No handles match the search.
1441 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1442 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1447 (EFIAPI
*EFI_LOCATE_HANDLE_BUFFER
) (
1448 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
1449 IN EFI_GUID
*Protocol
, OPTIONAL
1450 IN VOID
*SearchKey
, OPTIONAL
1451 IN OUT UINTN
*NoHandles
,
1452 OUT EFI_HANDLE
**Buffer
1456 Returns the first protocol instance that matches the given protocol.
1458 @param Protocol Provides the protocol to search for.
1459 @param Registration Optional registration key returned from
1460 RegisterProtocolNotify().
1461 @param Interface On return, a pointer to the first interface that matches Protocol and
1464 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1466 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1468 @retval EFI_INVALID_PARAMETER Interface is NULL.
1473 (EFIAPI
*EFI_LOCATE_PROTOCOL
) (
1474 IN EFI_GUID
*Protocol
,
1475 IN VOID
*Registration
, OPTIONAL
1476 OUT VOID
**Interface
1482 EFI_PHYSICAL_ADDRESS DataBlock
;
1483 EFI_PHYSICAL_ADDRESS ContinuationPointer
;
1485 } UEFI_CAPSULE_BLOCK_DESCRIPTOR
;
1488 EFI_GUID CapsuleGuid
;
1491 UINT32 CapsuleImageSize
;
1492 } UEFI_CAPSULE_HEADER
;
1494 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1495 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1498 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1499 consumption, the firmware may process the capsule immediately. If the payload should persist
1500 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1501 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1502 part of the reset process.
1504 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1505 being passed into update capsule.
1506 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1508 @param ScatterGatherList Physical pointer to a set of
1509 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1510 location in physical memory of a set of capsules.
1512 @retval EFI_SUCCESS Valid capsule was passed. If
1513 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1514 capsule has been successfully processed by the firmware.
1515 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1516 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL.
1521 (EFIAPI
*EFI_UPDATE_CAPSULE
) (
1522 IN UEFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1523 IN UINTN CapsuleCount
,
1524 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1528 Returns if the capsule can be supported via UpdateCapsule().
1530 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1531 being passed into update capsule.
1532 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1534 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1535 support as an argument to UpdateCapsule() via
1536 CapsuleHeaderArray and ScatterGatherList.
1537 @param ResetType Returns the type of reset required for the capsule update.
1539 @retval EFI_SUCCESS Valid answer returned.
1540 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1541 MaximumCapsuleSize and ResetType are undefined.
1542 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1547 (EFIAPI
*EFI_QUERY_CAPSULE_CAPABILITIES
) (
1548 IN UEFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
1549 IN UINTN CapsuleCount
,
1550 OUT UINT64
*MaximumCapsuleSize
,
1551 OUT EFI_RESET_TYPE
*ResetType
1555 Returns information about the EFI variables.
1557 @param Attributes Attributes bitmask to specify the type of variables on
1558 which to return information.
1559 @param MaximumVariableStorageSize On output the maximum size of the storage space
1560 available for the EFI variables associated with the
1561 attributes specified.
1562 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1563 available for the EFI variables associated with the
1564 attributes specified.
1565 @param MaximumVariableSize Returns the maximum size of the individual EFI
1566 variables associated with the attributes specified.
1568 @retval EFI_SUCCESS Valid answer returned.
1569 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1570 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1571 MaximumVariableStorageSize,
1572 RemainingVariableStorageSize, MaximumVariableSize
1578 (EFIAPI
*EFI_QUERY_VARIABLE_INFO
) (
1579 IN UINT32 Attributes
,
1580 OUT UINT64
*MaximumVariableStorageSize
,
1581 OUT UINT64
*RemainingVariableStorageSize
,
1582 OUT UINT64
*MaximumVariableSize
1587 // EFI Runtime Services Table
1589 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | 02)
1590 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | 10)
1591 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | 0)
1593 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
1594 #define EFI_RUNTIME_SERVICES_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1596 #if (EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000)
1598 // Include the definition for TIANO_REPORT_STATUS_CODE if this is the version
1599 // of Tiano that extended the EFI specification. If Tiano mode is diabled
1600 // don't include it.
1602 #include <Dxe/ArchProtocol/StatusCode.h>
1607 EFI_TABLE_HEADER Hdr
;
1612 EFI_GET_TIME GetTime
;
1613 EFI_SET_TIME SetTime
;
1614 EFI_GET_WAKEUP_TIME GetWakeupTime
;
1615 EFI_SET_WAKEUP_TIME SetWakeupTime
;
1618 // Virtual memory services
1620 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap
;
1621 EFI_CONVERT_POINTER ConvertPointer
;
1624 // Variable services
1626 EFI_GET_VARIABLE GetVariable
;
1627 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName
;
1628 EFI_SET_VARIABLE SetVariable
;
1633 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount
;
1634 EFI_RESET_SYSTEM ResetSystem
;
1636 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1638 // New Boot Services added by UEFI 2.0
1640 EFI_UPDATE_CAPSULE UpdateCapsule
;
1641 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities
;
1642 EFI_QUERY_VARIABLE_INFO QueryVariableInfo
;
1643 #elif (EDK_RELEASE_VERSION != 0)
1645 // Tiano extension to EFI 1.10 runtime table
1646 // It was moved to a protocol to not conflict with UEFI 2.0
1647 // If Tiano is disabled this item is not enabled for EFI 1.10
1649 EFI_REPORT_STATUS_CODE ReportStatusCode
;
1651 } EFI_RUNTIME_SERVICES
;
1654 // EFI Boot Services Table
1656 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42ULL
1657 #define EFI_BOOT_SERVICES_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1660 EFI_TABLE_HEADER Hdr
;
1663 // Task priority functions
1665 EFI_RAISE_TPL RaiseTPL
;
1666 EFI_RESTORE_TPL RestoreTPL
;
1671 EFI_ALLOCATE_PAGES AllocatePages
;
1672 EFI_FREE_PAGES FreePages
;
1673 EFI_GET_MEMORY_MAP GetMemoryMap
;
1674 EFI_ALLOCATE_POOL AllocatePool
;
1675 EFI_FREE_POOL FreePool
;
1678 // Event & timer functions
1680 EFI_CREATE_EVENT CreateEvent
;
1681 EFI_SET_TIMER SetTimer
;
1682 EFI_WAIT_FOR_EVENT WaitForEvent
;
1683 EFI_SIGNAL_EVENT SignalEvent
;
1684 EFI_CLOSE_EVENT CloseEvent
;
1685 EFI_CHECK_EVENT CheckEvent
;
1688 // Protocol handler functions
1690 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface
;
1691 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface
;
1692 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface
;
1693 EFI_HANDLE_PROTOCOL HandleProtocol
;
1695 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify
;
1696 EFI_LOCATE_HANDLE LocateHandle
;
1697 EFI_LOCATE_DEVICE_PATH LocateDevicePath
;
1698 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable
;
1703 EFI_IMAGE_LOAD LoadImage
;
1704 EFI_IMAGE_START StartImage
;
1706 EFI_IMAGE_UNLOAD UnloadImage
;
1707 EFI_EXIT_BOOT_SERVICES ExitBootServices
;
1712 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount
;
1714 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer
;
1717 // ////////////////////////////////////////////////////
1719 //////////////////////////////////////////////////////
1721 // DriverSupport Services
1723 EFI_CONNECT_CONTROLLER ConnectController
;
1724 EFI_DISCONNECT_CONTROLLER DisconnectController
;
1727 // Added Open and Close protocol for the new driver model
1729 EFI_OPEN_PROTOCOL OpenProtocol
;
1730 EFI_CLOSE_PROTOCOL CloseProtocol
;
1731 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation
;
1734 // Added new services to EFI 1.1 as Lib to reduce code size.
1736 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle
;
1737 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer
;
1738 EFI_LOCATE_PROTOCOL LocateProtocol
;
1740 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
;
1741 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
;
1746 EFI_CALCULATE_CRC32 CalculateCrc32
;
1749 // Memory Utility Services
1751 EFI_COPY_MEM CopyMem
;
1754 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1756 // UEFI 2.0 Extension to the table
1758 EFI_CREATE_EVENT_EX CreateEventEx
;
1760 } EFI_BOOT_SERVICES
;
1763 // EFI Configuration Table
1766 EFI_GUID VendorGuid
;
1768 } EFI_CONFIGURATION_TABLE
;
1773 #define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249ULL
1774 #define EFI_SYSTEM_TABLE_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1776 struct _EFI_SYSTEM_TABLE
{
1777 EFI_TABLE_HEADER Hdr
;
1779 CHAR16
*FirmwareVendor
;
1780 UINT32 FirmwareRevision
;
1782 EFI_HANDLE ConsoleInHandle
;
1783 EFI_SIMPLE_TEXT_IN_PROTOCOL
*ConIn
;
1785 EFI_HANDLE ConsoleOutHandle
;
1786 EFI_SIMPLE_TEXT_OUT_PROTOCOL
*ConOut
;
1788 EFI_HANDLE StandardErrorHandle
;
1789 EFI_SIMPLE_TEXT_OUT_PROTOCOL
*StdErr
;
1791 EFI_RUNTIME_SERVICES
*RuntimeServices
;
1792 EFI_BOOT_SERVICES
*BootServices
;
1794 UINTN NumberOfTableEntries
;
1795 EFI_CONFIGURATION_TABLE
*ConfigurationTable
;
1800 // Device Path information
1806 // Hardware Device Paths
1808 #define HARDWARE_DEVICE_PATH 0x01
1810 #define HW_PCI_DP 0x01
1812 EFI_DEVICE_PATH_PROTOCOL Header
;
1817 #define HW_PCCARD_DP 0x02
1819 EFI_DEVICE_PATH_PROTOCOL Header
;
1820 UINT8 FunctionNumber
;
1821 } PCCARD_DEVICE_PATH
;
1823 #define HW_MEMMAP_DP 0x03
1825 EFI_DEVICE_PATH_PROTOCOL Header
;
1827 EFI_PHYSICAL_ADDRESS StartingAddress
;
1828 EFI_PHYSICAL_ADDRESS EndingAddress
;
1829 } MEMMAP_DEVICE_PATH
;
1831 #define HW_VENDOR_DP 0x04
1833 EFI_DEVICE_PATH_PROTOCOL Header
;
1835 } VENDOR_DEVICE_PATH
;
1837 #define HW_CONTROLLER_DP 0x05
1839 EFI_DEVICE_PATH_PROTOCOL Header
;
1840 UINT32 ControllerNumber
;
1841 } CONTROLLER_DEVICE_PATH
;
1844 // ACPI Device Paths
1846 #define ACPI_DEVICE_PATH 0x02
1848 #define ACPI_DP 0x01
1850 EFI_DEVICE_PATH_PROTOCOL Header
;
1853 } ACPI_HID_DEVICE_PATH
;
1855 #define ACPI_EXTENDED_DP 0x02
1857 EFI_DEVICE_PATH_PROTOCOL Header
;
1862 // Optional variable length _HIDSTR
1863 // Optional variable length _UIDSTR
1865 } ACPI_EXTENDED_HID_DEVICE_PATH
;
1869 // EISA ID Definition 32-bits
1870 // bits[15:0] - three character compressed ASCII EISA ID.
1871 // bits[31:16] - binary number
1872 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
1874 #define PNP_EISA_ID_CONST 0x41d0
1875 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
1876 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
1877 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
1879 #define PNP_EISA_ID_MASK 0xffff
1880 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
1883 #define ACPI_ADR_DP 0x03
1885 EFI_DEVICE_PATH_PROTOCOL Header
;
1887 } ACPI_ADR_DEVICE_PATH
;
1891 // Messaging Device Paths
1893 #define MESSAGING_DEVICE_PATH 0x03
1895 #define MSG_ATAPI_DP 0x01
1897 EFI_DEVICE_PATH_PROTOCOL Header
;
1898 UINT8 PrimarySecondary
;
1901 } ATAPI_DEVICE_PATH
;
1903 #define MSG_SCSI_DP 0x02
1905 EFI_DEVICE_PATH_PROTOCOL Header
;
1910 #define MSG_FIBRECHANNEL_DP 0x03
1912 EFI_DEVICE_PATH_PROTOCOL Header
;
1916 } FIBRECHANNEL_DEVICE_PATH
;
1918 #define MSG_1394_DP 0x04
1920 EFI_DEVICE_PATH_PROTOCOL Header
;
1923 } F1394_DEVICE_PATH
;
1925 #define MSG_USB_DP 0x05
1927 EFI_DEVICE_PATH_PROTOCOL Header
;
1928 UINT8 ParentPortNumber
;
1929 UINT8 InterfaceNumber
;
1932 #define MSG_USB_CLASS_DP 0x0f
1934 EFI_DEVICE_PATH_PROTOCOL Header
;
1938 UINT8 DeviceSubClass
;
1939 UINT8 DeviceProtocol
;
1940 } USB_CLASS_DEVICE_PATH
;
1942 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1943 #define MSG_USB_WWID_DP 0x10
1945 EFI_DEVICE_PATH_PROTOCOL Header
;
1946 UINT16 InterfaceNumber
;
1949 // CHAR16 SerialNumber[];
1950 } USB_WWID_DEVICE_PATH
;
1952 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
1954 EFI_DEVICE_PATH_PROTOCOL Header
;
1956 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
1959 #define MSG_I2O_DP 0x06
1961 EFI_DEVICE_PATH_PROTOCOL Header
;
1965 #define MSG_MAC_ADDR_DP 0x0b
1967 EFI_DEVICE_PATH_PROTOCOL Header
;
1968 EFI_MAC_ADDRESS MacAddress
;
1970 } MAC_ADDR_DEVICE_PATH
;
1972 #define MSG_IPv4_DP 0x0c
1974 EFI_DEVICE_PATH_PROTOCOL Header
;
1975 EFI_IPv4_ADDRESS LocalIpAddress
;
1976 EFI_IPv4_ADDRESS RemoteIpAddress
;
1980 BOOLEAN StaticIpAddress
;
1983 #define MSG_IPv6_DP 0x0d
1985 EFI_DEVICE_PATH_PROTOCOL Header
;
1986 EFI_IPv6_ADDRESS LocalIpAddress
;
1987 EFI_IPv6_ADDRESS RemoteIpAddress
;
1991 BOOLEAN StaticIpAddress
;
1994 #define MSG_INFINIBAND_DP 0x09
1996 EFI_DEVICE_PATH_PROTOCOL Header
;
1997 UINT32 ResourceFlags
;
2000 UINT64 TargetPortId
;
2002 } INFINIBAND_DEVICE_PATH
;
2004 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
2005 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
2006 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
2007 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
2008 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
2010 #define MSG_UART_DP 0x0e
2012 EFI_DEVICE_PATH_PROTOCOL Header
;
2021 // Use VENDOR_DEVICE_PATH struct
2023 #define MSG_VENDOR_DP 0x0a
2025 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
2026 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
2027 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
2028 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
2030 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
2033 EFI_DEVICE_PATH_PROTOCOL Header
;
2035 UINT32 FlowControlMap
;
2036 } UART_FLOW_CONTROL_DEVICE_PATH
;
2038 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
2040 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
2043 EFI_DEVICE_PATH_PROTOCOL Header
;
2048 UINT16 DeviceTopology
;
2049 UINT16 RelativeTargetPort
;
2052 #define MSG_ISCSI_DP 0x13
2054 EFI_DEVICE_PATH_PROTOCOL Header
;
2055 UINT16 NetworkProtocol
;
2058 UINT16 TargetPortalGroupTag
;
2060 // CHAR8 iSCSI Target Name
2061 } ISCSI_DEVICE_PATH
;
2063 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
2064 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
2065 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
2066 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
2067 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
2068 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
2069 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
2070 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
2075 // Media Device Path
2077 #define MEDIA_DEVICE_PATH 0x04
2079 #define MEDIA_HARDDRIVE_DP 0x01
2081 EFI_DEVICE_PATH_PROTOCOL Header
;
2082 UINT32 PartitionNumber
;
2083 UINT64 PartitionStart
;
2084 UINT64 PartitionSize
;
2085 UINT8 Signature
[16];
2087 UINT8 SignatureType
;
2088 } HARDDRIVE_DEVICE_PATH
;
2090 #define MBR_TYPE_PCAT 0x01
2091 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
2093 #define SIGNATURE_TYPE_MBR 0x01
2094 #define SIGNATURE_TYPE_GUID 0x02
2096 #define MEDIA_CDROM_DP 0x02
2098 EFI_DEVICE_PATH_PROTOCOL Header
;
2100 UINT64 PartitionStart
;
2101 UINT64 PartitionSize
;
2102 } CDROM_DEVICE_PATH
;
2105 // Use VENDOR_DEVICE_PATH struct
2107 #define MEDIA_VENDOR_DP 0x03
2109 #define MEDIA_FILEPATH_DP 0x04
2111 EFI_DEVICE_PATH_PROTOCOL Header
;
2113 } FILEPATH_DEVICE_PATH
;
2115 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
2117 #define MEDIA_PROTOCOL_DP 0x05
2119 EFI_DEVICE_PATH_PROTOCOL Header
;
2121 } MEDIA_PROTOCOL_DEVICE_PATH
;
2125 EFI_DEVICE_PATH_PROTOCOL Header
;
2126 EFI_GUID TianoSpecificDevicePath
;
2128 } TIANO_DEVICE_PATH
;
2130 #define TIANO_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE 0x01
2132 TIANO_DEVICE_PATH Tiano
;
2134 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
2137 // Place holder for a future extension
2139 #define TIANO_MEDIAFW_VOL_DEVICE_PATH_TYPE 0x02
2141 TIANO_DEVICE_PATH Tiano
;
2142 EFI_GUID VolumeGuid
;
2143 } MEDIA_FW_VOL_DEVICE_PATH
;
2149 #define BBS_DEVICE_PATH 0x05
2150 #define BBS_BBS_DP 0x01
2152 EFI_DEVICE_PATH_PROTOCOL Header
;
2156 } BBS_BBS_DEVICE_PATH
;
2159 // DeviceType definitions - from BBS specification
2161 #define BBS_TYPE_FLOPPY 0x01
2162 #define BBS_TYPE_HARDDRIVE 0x02
2163 #define BBS_TYPE_CDROM 0x03
2164 #define BBS_TYPE_PCMCIA 0x04
2165 #define BBS_TYPE_USB 0x05
2166 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
2167 #define BBS_TYPE_BEV 0x80
2168 #define BBS_TYPE_UNKNOWN 0xFF
2172 // Union of all possible Device Paths and pointers to Device Paths
2176 EFI_DEVICE_PATH_PROTOCOL DevPath
;
2177 PCI_DEVICE_PATH Pci
;
2178 PCCARD_DEVICE_PATH PcCard
;
2179 MEMMAP_DEVICE_PATH MemMap
;
2180 VENDOR_DEVICE_PATH Vendor
;
2182 CONTROLLER_DEVICE_PATH Controller
;
2183 ACPI_HID_DEVICE_PATH Acpi
;
2185 ATAPI_DEVICE_PATH Atapi
;
2186 SCSI_DEVICE_PATH Scsi
;
2187 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
2189 F1394_DEVICE_PATH F1394
;
2190 USB_DEVICE_PATH Usb
;
2191 USB_CLASS_DEVICE_PATH UsbClass
;
2192 I2O_DEVICE_PATH I2O
;
2193 MAC_ADDR_DEVICE_PATH MacAddr
;
2194 IPv4_DEVICE_PATH Ipv4
;
2195 IPv6_DEVICE_PATH Ipv6
;
2196 INFINIBAND_DEVICE_PATH InfiniBand
;
2197 UART_DEVICE_PATH Uart
;
2199 HARDDRIVE_DEVICE_PATH HardDrive
;
2200 CDROM_DEVICE_PATH CD
;
2202 FILEPATH_DEVICE_PATH FilePath
;
2203 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
2205 BBS_BBS_DEVICE_PATH Bbs
;
2211 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
2212 PCI_DEVICE_PATH
*Pci
;
2213 PCCARD_DEVICE_PATH
*PcCard
;
2214 MEMMAP_DEVICE_PATH
*MemMap
;
2215 VENDOR_DEVICE_PATH
*Vendor
;
2217 CONTROLLER_DEVICE_PATH
*Controller
;
2218 ACPI_HID_DEVICE_PATH
*Acpi
;
2219 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
2221 ATAPI_DEVICE_PATH
*Atapi
;
2222 SCSI_DEVICE_PATH
*Scsi
;
2223 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
2225 F1394_DEVICE_PATH
*F1394
;
2226 USB_DEVICE_PATH
*Usb
;
2227 USB_CLASS_DEVICE_PATH
*UsbClass
;
2228 I2O_DEVICE_PATH
*I2O
;
2229 MAC_ADDR_DEVICE_PATH
*MacAddr
;
2230 IPv4_DEVICE_PATH
*Ipv4
;
2231 IPv6_DEVICE_PATH
*Ipv6
;
2232 INFINIBAND_DEVICE_PATH
*InfiniBand
;
2233 UART_DEVICE_PATH
*Uart
;
2235 HARDDRIVE_DEVICE_PATH
*HardDrive
;
2236 CDROM_DEVICE_PATH
*CD
;
2238 FILEPATH_DEVICE_PATH
*FilePath
;
2239 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
2241 BBS_BBS_DEVICE_PATH
*Bbs
;
2253 // Packet definitions
2258 UINT8 BootpHwAddrLen
;
2259 UINT8 BootpGateHops
;
2261 UINT16 BootpSeconds
;
2263 UINT8 BootpCiAddr
[4];
2264 UINT8 BootpYiAddr
[4];
2265 UINT8 BootpSiAddr
[4];
2266 UINT8 BootpGiAddr
[4];
2267 UINT8 BootpHwAddr
[16];
2268 UINT8 BootpSrvName
[64];
2269 UINT8 BootpBootFile
[128];
2271 UINT8 DhcpOptions
[56];
2272 } EFI_PXE_BASE_CODE_DHCPV4_PACKET
;
2276 EFI_PXE_BASE_CODE_DHCPV4_PACKET Dhcpv4
;
2279 // EFI_PXE_BASE_CODE_DHCPV6_PACKET Dhcpv6;
2281 } EFI_PXE_BASE_CODE_PACKET
;
2283 #include <Uefi/EfiPxe.h>
2286 // EFI Revision information
2288 #define EFI_FIRMWARE_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
2290 #include <Common/EfiImage.h>
2291 #include <IndustryStandard/Usb.h>
2294 #define EFI_USB_HC_RESET_GLOBAL 0x0001
2295 #define EFI_USB_HC_RESET_HOST_CONTROLLER 0x0002
2296 #define EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG 0x0004
2297 #define EFI_USB_HC_RESET_HOST_WITH_DEBUG 0x0008
2300 // USB Host Controller state
2304 EfiUsbHcStateOperational
,
2305 EfiUsbHcStateSuspend
,
2306 EfiUsbHcStateMaximum
2311 // EFI File location to boot from on removable media devices
2313 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2314 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2315 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2316 #define EFI_REMOVABLE_MEDIA_FILE_NAME_EBC L"\\EFI\\BOOT\\BOOTEBC.EFI"
2318 #if defined (MDE_CPU_IA32)
2319 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2320 #elif defined (MDE_CPU_IPF)
2321 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2322 #elif defined (MDE_CPU_X64)
2323 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2324 #elif defined (MDE_CPU_EBC)
2325 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_EBC
2327 #error Unknown Processor Type
2332 // Protocols from EFI 1.10 that got thier names fixed in UEFI 2.0
2334 #include <Protocol/LoadedImage.h>
2335 #include <Protocol/SimpleTextIn.h>
2336 #include <Protocol/SimpleTextOut.h>
2337 #include <Protocol/SerialIo.h>
2338 #include <Protocol/LoadFile.h>
2339 #include <Protocol/SimpleFileSystem.h>
2340 #include <Protocol/DiskIo.h>
2341 #include <Protocol/BlockIo.h>
2342 #include <Protocol/UnicodeCollation.h>
2343 #include <Protocol/SimpleNetwork.h>
2344 #include <Protocol/EfiNetworkInterfaceIdentifier.h>
2345 #include <Protocol/PxeBaseCode.h>
2346 #include <Protocol/PxeBaseCodeCallBack.h>
2349 // EFI 1.10 Protocols
2351 #include <Protocol/Bis.h>
2352 #include <Protocol/BusSpecificDriverOverride.h>
2353 #include <Protocol/ComponentName.h>
2354 #include <Protocol/DebugPort.h>
2355 #include <Protocol/DebugSupport.h>
2356 #include <Protocol/Decompress.h>
2357 #include <Protocol/DriverBinding.h>
2358 #include <Protocol/DriverConfiguration.h>
2359 #include <Protocol/DriverDiagnostics.h>
2360 #include <Protocol/Ebc.h>
2361 #include <Protocol/EfiNetworkInterfaceIdentifier.h>
2362 #include <Protocol/PciIo.h>
2363 #include <Protocol/PciRootBridgeIo.h>
2364 #include <Protocol/PlatformDriverOverride.h>
2365 #include <Protocol/SimplePointer.h>
2366 #include <Protocol/ScsiPassThru.h>
2367 #include <Protocol/UsbIo.h>
2368 #include <Protocol/UsbHostController.h>
2369 #include <Protocol/UgaDraw.h>
2374 #include <Guid/Acpi.h>
2375 #include <Guid/DebugImageInfoTable.h>
2376 #include <Guid/GlobalVariable.h>
2377 #include <Guid/Gpt.h>
2378 #include <Guid/PcAnsi.h>
2379 #include <Guid/SmBios.h>
2380 #include <Guid/SalSystemTable.h>
2381 #include <Guid/FileInfo.h>
2382 #include <Guid/FileSystemInfo.h>
2383 #include <Guid/FileSystemVolumeLabelInfo.h>
2385 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
2387 // Turn on UEFI 2.0 Protocols and GUIDs
2389 #include <Protocol/AuthenticationInfo.h>
2390 #include <Protocol/DevicePathUtilities.h>
2391 #include <Protocol/DevicePathToText.h>
2392 #include <Protocol/DevicePathFromText.h>
2393 #include <Protocol/GraphicsOutput.h>
2394 #include <Protocol/EdidDiscovered.h>
2395 #include <Protocol/EdidActive.h>
2396 #include <Protocol/EdidOverride.h>
2397 #include <Protocol/ScsiIoExt.h>
2398 #include <Protocol/ScsiPassThruExt.h>
2399 #include <Protocol/IScsiInitatorName.h>
2400 #include <Protocol/Usb2HostController.h>
2401 #include <Protocol/TapeIo.h>
2402 #include <Protocol/ManagedNetwork.h>
2403 #include <Protocol/Arp.h>
2404 #include <Protocol/Dhcp4.h>
2405 #include <Protocol/IP4.h>
2406 #include <Protocol/IP4Config.h>
2407 #include <Protocol/Tcp4.h>
2408 #include <Protocol/Udp4.h>
2409 #include <Protocol/Mtftp4.h>
2410 #include <Protocol/ServiceBinding.h>
2411 #include <Protocol/Hash.h>
2413 #include <Guid/EventGroup.h>