/** @file\r
- Include file that supportes UEFI.\r
+ Include file that supports UEFI.\r
\r
- This include file must only contain things defined in the UEFI 2.0 specification.\r
- If a code construct is defined in the UEFI 2.0 specification it must be included\r
+ This include file must only contain things defined in the UEFI 2.1 specification.\r
+ If a code construct is defined in the UEFI 2.1 specification it must be included\r
by this include file.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- Module Name: UefiSpec.h\r
-\r
**/\r
\r
#ifndef __UEFI_SPEC_H__\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextOut.h>\r
\r
-//\r
-// Enumeration of memory allocation.\r
-// \r
+///\r
+/// Enumeration of memory allocation.\r
+///\r
typedef enum {\r
AllocateAnyPages,\r
AllocateMaxAddress,\r
MaxAllocateType\r
} EFI_ALLOCATE_TYPE;\r
\r
+//\r
+// Bit definitions for EFI_TIME.Daylight\r
+//\r
+#define EFI_TIME_ADJUST_DAYLIGHT 0x01\r
+#define EFI_TIME_IN_DAYLIGHT 0x02\r
+\r
+///\r
+/// Value definition for EFI_TIME.TimeZone\r
+///\r
+#define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r
\r
//\r
-// possible caching types for the memory range\r
+// Memory cacheability attributes\r
//\r
#define EFI_MEMORY_UC 0x0000000000000001ULL\r
#define EFI_MEMORY_WC 0x0000000000000002ULL\r
#define EFI_MEMORY_WT 0x0000000000000004ULL\r
#define EFI_MEMORY_WB 0x0000000000000008ULL\r
#define EFI_MEMORY_UCE 0x0000000000000010ULL\r
-\r
//\r
-// physical memory protection on range\r
+// Physical memory protection attributes\r
//\r
#define EFI_MEMORY_WP 0x0000000000001000ULL\r
#define EFI_MEMORY_RP 0x0000000000002000ULL\r
#define EFI_MEMORY_XP 0x0000000000004000ULL\r
-\r
//\r
-// range requires a runtime mapping\r
+// Runtime memory attribute\r
//\r
#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r
\r
+///\r
+/// Memory descriptor version number\r
+///\r
#define EFI_MEMORY_DESCRIPTOR_VERSION 1\r
+\r
+///\r
+/// Definition of memory descriptor\r
+///\r
typedef struct {\r
UINT32 Type;\r
EFI_PHYSICAL_ADDRESS PhysicalStart;\r
UINT64 Attribute;\r
} EFI_MEMORY_DESCRIPTOR;\r
\r
-//\r
-// Build macros to find next EFI_MEMORY_DESCRIPTOR.\r
-// \r
-#define NextMemoryDescriptor(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))\r
-#define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) NextMemoryDescriptor (_Ptr, _Size)\r
+///\r
+/// Build macros to find next EFI_MEMORY_DESCRIPTOR.\r
+///\r
+#define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))\r
\r
-//\r
-// Declare forward referenced data structures\r
-//\r
+///\r
+/// Declare forward referenced data structures\r
+///\r
typedef struct _EFI_SYSTEM_TABLE EFI_SYSTEM_TABLE;\r
\r
/**\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ALLOCATE_PAGES) (\r
+(EFIAPI *EFI_ALLOCATE_PAGES)(\r
IN EFI_ALLOCATE_TYPE Type,\r
IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN Pages,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FREE_PAGES) (\r
+(EFIAPI *EFI_FREE_PAGES)(\r
IN EFI_PHYSICAL_ADDRESS Memory,\r
IN UINTN Pages\r
);\r
Returns the current memory map.\r
\r
@param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.\r
+ On input, this is the size of the buffer allocated by the caller.\r
+ On output, it is the size of the buffer returned by the firmware if\r
+ the buffer was large enough, or the size of the buffer needed to contain\r
+ the map if the buffer was too small.\r
@param MemoryMap A pointer to the buffer in which firmware places the current memory\r
map.\r
@param MapKey A pointer to the location in which firmware returns the key for the\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_MEMORY_MAP) (\r
+(EFIAPI *EFI_GET_MEMORY_MAP)(\r
IN OUT UINTN *MemoryMapSize,\r
IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,\r
OUT UINTN *MapKey,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ALLOCATE_POOL) (\r
+(EFIAPI *EFI_ALLOCATE_POOL)(\r
IN EFI_MEMORY_TYPE PoolType,\r
IN UINTN Size,\r
OUT VOID **Buffer\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FREE_POOL) (\r
+(EFIAPI *EFI_FREE_POOL)(\r
IN VOID *Buffer\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP) (\r
+(EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP)(\r
IN UINTN MemoryMapSize,\r
IN UINTN DescriptorSize,\r
IN UINT32 DescriptorVersion,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CONNECT_CONTROLLER) (\r
+(EFIAPI *EFI_CONNECT_CONTROLLER)(\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE *DriverImageHandle, OPTIONAL\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL\r
\r
@param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.\r
@param DriverImageHandle The driver to disconnect from ControllerHandle.\r
+ If DriverImageHandle is NULL, then all the drivers currently managing\r
+ ControllerHandle are disconnected from ControllerHandle.\r
@param ChildHandle The handle of the child to destroy.\r
+ If ChildHandle is NULL, then all the children of ControllerHandle are\r
+ destroyed before the drivers are disconnected from ControllerHandle.\r
\r
@retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.\r
2) On entry, no drivers are managing ControllerHandle.\r
3) DriverImageHandle is not NULL, and on entry\r
DriverImageHandle is not managing ControllerHandle.\r
-\r
- @retval EFI_INVALID_PARAMETER One ore more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.\r
+ 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.\r
+ 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.\r
+ 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from\r
ControllerHandle.\r
@retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISCONNECT_CONTROLLER) (\r
+(EFIAPI *EFI_DISCONNECT_CONTROLLER)(\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE DriverImageHandle, OPTIONAL\r
IN EFI_HANDLE ChildHandle OPTIONAL\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CONVERT_POINTER) (\r
+(EFIAPI *EFI_CONVERT_POINTER)(\r
IN UINTN DebugDisposition,\r
IN OUT VOID **Address\r
);\r
\r
\r
//\r
-// These types can be ¡°ORed¡± together as needed ¨C for example,\r
-// EVT_TIMER might be ¡°Ored¡± with EVT_NOTIFY_WAIT or\r
+// These types can be ORed together as needed - for example,\r
+// EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or\r
// EVT_NOTIFY_SIGNAL.\r
//\r
#define EVT_TIMER 0x80000000\r
#define EVT_RUNTIME 0x40000000\r
-\r
#define EVT_NOTIFY_WAIT 0x00000100\r
#define EVT_NOTIFY_SIGNAL 0x00000200\r
+\r
#define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201\r
#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202\r
\r
-\r
//\r
-// The event¡¯s NotifyContext pointer points to a runtime memory\r
-// address. \r
+// The event's NotifyContext pointer points to a runtime memory\r
+// address.\r
// The event is deprecated in UEFI2.0 and later specifications.\r
-// \r
+//\r
#define EVT_RUNTIME_CONTEXT 0x20000000\r
\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_EVENT_NOTIFY) (\r
+(EFIAPI *EFI_EVENT_NOTIFY)(\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
);\r
Creates an event.\r
\r
@param Type The type of event to create and its mode and attributes.\r
- @param NotifyTpl Pointer to the notification function's context.\r
+ @param NotifyTpl The task priority level of event notifications, if needed.\r
@param NotifyFunction Pointer to the event's notification function, if any.\r
@param NotifyContext Pointer to the notification function's context; corresponds to parameter\r
Context in the notification function.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CREATE_EVENT) (\r
+(EFIAPI *EFI_CREATE_EVENT)(\r
IN UINT32 Type,\r
IN EFI_TPL NotifyTpl,\r
IN EFI_EVENT_NOTIFY NotifyFunction,\r
Creates an event in a group.\r
\r
@param Type The type of event to create and its mode and attributes.\r
- @param NotifyTpl Pointer to the notification function's context.\r
+ @param NotifyTpl The task priority level of event notifications,if needed.\r
@param NotifyFunction Pointer to the event's notification function, if any.\r
@param NotifyContext Pointer to the notification function's context; corresponds to parameter\r
Context in the notification function.\r
@param EventGroup Pointer to the unique identifier of the group to which this event belongs.\r
+ If this is NULL, then the function behaves as if the parameters were passed\r
+ to CreateEvent.\r
@param Event Pointer to the newly created event if the call succeeds; undefined\r
otherwise.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CREATE_EVENT_EX) (\r
+(EFIAPI *EFI_CREATE_EVENT_EX)(\r
IN UINT32 Type,\r
- IN EFI_TPL NotifyTpl OPTIONAL,\r
+ IN EFI_TPL NotifyTpl,\r
IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r
IN CONST VOID *NotifyContext OPTIONAL,\r
IN CONST EFI_GUID *EventGroup OPTIONAL,\r
OUT EFI_EVENT *Event\r
);\r
\r
+///\r
+/// Timer delay types\r
+///\r
typedef enum {\r
TimerCancel,\r
TimerPeriodic,\r
@param Event The timer event that is to be signaled at the specified time.\r
@param Type The type of time that is specified in TriggerTime.\r
@param TriggerTime The number of 100ns units until the timer expires.\r
+ A TriggerTime of 0 is legal.\r
+ If Type is TimerRelative and TriggerTime is 0, then the timer\r
+ event will be signaled on the next timer tick.\r
+ If Type is TimerPeriodic and TriggerTime is 0, then the timer\r
+ event will be signaled on every timer tick.\r
\r
@retval EFI_SUCCESS The event has been set to be signaled at the requested time.\r
@retval EFI_INVALID_PARAMETER Event or Type is not valid.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_TIMER) (\r
+(EFIAPI *EFI_SET_TIMER)(\r
IN EFI_EVENT Event,\r
IN EFI_TIMER_DELAY Type,\r
IN UINT64 TriggerTime\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SIGNAL_EVENT) (\r
+(EFIAPI *EFI_SIGNAL_EVENT)(\r
IN EFI_EVENT Event\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_WAIT_FOR_EVENT) (\r
+(EFIAPI *EFI_WAIT_FOR_EVENT)(\r
IN UINTN NumberOfEvents,\r
IN EFI_EVENT *Event,\r
OUT UINTN *Index\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CLOSE_EVENT) (\r
+(EFIAPI *EFI_CLOSE_EVENT)(\r
IN EFI_EVENT Event\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CHECK_EVENT) (\r
+(EFIAPI *EFI_CHECK_EVENT)(\r
IN EFI_EVENT Event\r
);\r
\r
\r
//\r
-// Task priority level (name defined in spec).\r
+// Task priority level\r
//\r
#define TPL_APPLICATION 4\r
#define TPL_CALLBACK 8\r
\r
@param NewTpl The new task priority level.\r
\r
- @retval Previous task priority level\r
+ @return Previous task priority level\r
\r
**/\r
typedef\r
EFI_TPL\r
-(EFIAPI *EFI_RAISE_TPL) (\r
+(EFIAPI *EFI_RAISE_TPL)(\r
IN EFI_TPL NewTpl\r
);\r
\r
/**\r
Restores a task's priority level to its previous value.\r
\r
- @param OldTpl The previous task priority level to restore\r
+ @param OldTpl The previous task priority level to restore.\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_RESTORE_TPL) (\r
+(EFIAPI *EFI_RESTORE_TPL)(\r
IN EFI_TPL OldTpl\r
);\r
\r
On output the size of data returned in Data.\r
@param Data The buffer to return the contents of the variable.\r
\r
- @retval EFI_SUCCESS The function completed successfully.\r
- @retval EFI_NOT_FOUND The variable was not found.\r
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_NOT_FOUND The variable was not found.\r
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r
+ @retval EFI_INVALID_PARAMETER VariableName is NULL.\r
+ @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r
+ @retval EFI_INVALID_PARAMETER DataSize is NULL.\r
+ @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r
+ @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+ @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_VARIABLE) (\r
+(EFIAPI *EFI_GET_VARIABLE)(\r
IN CHAR16 *VariableName,\r
IN EFI_GUID *VendorGuid,\r
OUT UINT32 *Attributes, OPTIONAL\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The next variable was not found.\r
@retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r
+ @retval EFI_INVALID_PARAMETER VariableName is NULL.\r
+ @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r
@retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_NEXT_VARIABLE_NAME) (\r
+(EFIAPI *EFI_GET_NEXT_VARIABLE_NAME)(\r
IN OUT UINTN *VariableNameSize,\r
IN OUT CHAR16 *VariableName,\r
IN OUT EFI_GUID *VendorGuid\r
@param DataSize The size in bytes of the Data buffer.\r
@param Data The contents for the variable.\r
\r
- @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
- defined by the Attributes.\r
- @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
- @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
+ defined by the Attributes.\r
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r
+ DataSize exceeds the maximum allowed.\r
+ @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
+ @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+ @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
+ @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r
+ @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r
+ @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_VARIABLE) (\r
+(EFIAPI *EFI_SET_VARIABLE)(\r
IN CHAR16 *VariableName,\r
IN EFI_GUID *VendorGuid,\r
IN UINT32 Attributes,\r
);\r
\r
\r
-// \r
-// This provides the capabilities of the\r
-// real time clock device as exposed through the EFI interfaces.\r
-// \r
+///\r
+/// This provides the capabilities of the\r
+/// real time clock device as exposed through the EFI interfaces.\r
+///\r
typedef struct {\r
UINT32 Resolution;\r
UINT32 Accuracy;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_TIME) (\r
+(EFIAPI *EFI_GET_TIME)(\r
OUT EFI_TIME *Time,\r
OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_TIME) (\r
+(EFIAPI *EFI_SET_TIME)(\r
IN EFI_TIME *Time\r
);\r
\r
@param Time The current alarm setting.\r
\r
@retval EFI_SUCCESS The alarm settings were returned.\r
- @retval EFI_INVALID_PARAMETER Any parameter is NULL.\r
+ @retval EFI_INVALID_PARAMETER Enabled is NULL.\r
+ @retval EFI_INVALID_PARAMETER Pending is NULL.\r
+ @retval EFI_INVALID_PARAMETER Time is NULL.\r
@retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r
+ @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_WAKEUP_TIME) (\r
+(EFIAPI *EFI_GET_WAKEUP_TIME)(\r
OUT BOOLEAN *Enabled,\r
OUT BOOLEAN *Pending,\r
OUT EFI_TIME *Time\r
\r
@param Enabled Enable or disable the wakeup alarm.\r
@param Time If Enable is TRUE, the time to set the wakeup alarm for.\r
+ If Enable is FALSE, then this parameter is optional, and may be NULL.\r
\r
@retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If\r
Enable is FALSE, then the wakeup alarm was disabled.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_WAKEUP_TIME) (\r
+(EFIAPI *EFI_SET_WAKEUP_TIME)(\r
IN BOOLEAN Enable,\r
IN EFI_TIME *Time OPTIONAL\r
);\r
\r
/**\r
- This is the declaration of an EFI image entry point. This can be the entry point to an application\r
- written to this specification, an EFI boot service driver, or an EFI runtime driver.\r
+ This is the declaration of an EFI image entry point. This entry point is\r
+ the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
+ both device drivers and bus drivers.\r
\r
- @param ImageHandle Handle that identifies the loaded image.\r
- @param SystemTable System Table for this image.\r
+ @param ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
-\r
+ @retval Others Some unexpected error happened.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IMAGE_ENTRY_POINT) (\r
+(EFIAPI *EFI_IMAGE_ENTRY_POINT)(\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
);\r
FilePath as a boot selection. Ignored if SourceBuffer is\r
not NULL.\r
@param ParentImageHandle The caller's image handle.\r
- @param FilePath The DeviceHandle specific file path from which the image is\r
+ @param DevicePath The DeviceHandle specific file path from which the image is\r
loaded.\r
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy\r
of the image to be loaded.\r
- @param SourceSize The size in bytes of SourceBuffer.\r
+ @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.\r
@param ImageHandle Pointer to the returned image handle that is created when the\r
image is successfully loaded.\r
\r
@retval EFI_SUCCESS Image was loaded into memory correctly.\r
- @retval EFI_NOT_FOUND Both SourceBuffer and FilePath are NULL.\r
+ @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.\r
@retval EFI_INVALID_PARAMETER One or more parametes are invalid.\r
@retval EFI_UNSUPPORTED The image type is not supported.\r
@retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IMAGE_LOAD) (\r
+(EFIAPI *EFI_IMAGE_LOAD)(\r
IN BOOLEAN BootPolicy,\r
IN EFI_HANDLE ParentImageHandle,\r
- IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
IN VOID *SourceBuffer OPTIONAL,\r
IN UINTN SourceSize,\r
OUT EFI_HANDLE *ImageHandle\r
\r
@retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r
has already been initialized with StartImage\r
- @retval Exit code from image Exit code from image\r
+ @return Exit code from image\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IMAGE_START) (\r
+(EFIAPI *EFI_IMAGE_START)(\r
IN EFI_HANDLE ImageHandle,\r
OUT UINTN *ExitDataSize,\r
OUT CHAR16 **ExitData OPTIONAL\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_EXIT) (\r
+(EFIAPI *EFI_EXIT)(\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_STATUS ExitStatus,\r
IN UINTN ExitDataSize,\r
\r
@retval EFI_SUCCESS The image has been unloaded.\r
@retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.\r
- @retval EFI_UNSUPPORTED The image has been started, and does not support unload.\r
- @retval Exit code from the image's unload handler\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_IMAGE_UNLOAD) (\r
+(EFIAPI *EFI_IMAGE_UNLOAD)(\r
IN EFI_HANDLE ImageHandle\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_EXIT_BOOT_SERVICES) (\r
+(EFIAPI *EFI_EXIT_BOOT_SERVICES)(\r
IN EFI_HANDLE ImageHandle,\r
IN UINTN MapKey\r
);\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_STALL) (\r
+(EFIAPI *EFI_STALL)(\r
IN UINTN Microseconds\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_WATCHDOG_TIMER) (\r
+(EFIAPI *EFI_SET_WATCHDOG_TIMER)(\r
IN UINTN Timeout,\r
IN UINT64 WatchdogCode,\r
IN UINTN DataSize,\r
IN CHAR16 *WatchdogData OPTIONAL\r
);\r
\r
-//\r
-// Enumeration of reset types.\r
-// \r
+///\r
+/// Enumeration of reset types.\r
+///\r
typedef enum {\r
EfiResetCold,\r
EfiResetWarm,\r
EfiResetShutdown,\r
+ EfiResetUpdate\r
} EFI_RESET_TYPE;\r
\r
/**\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_RESET_SYSTEM) (\r
+(EFIAPI *EFI_RESET_SYSTEM)(\r
IN EFI_RESET_TYPE ResetType,\r
IN EFI_STATUS ResetStatus,\r
IN UINTN DataSize,\r
- IN CHAR16 *ResetData OPTIONAL\r
+ IN VOID *ResetData OPTIONAL\r
);\r
\r
/**\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT) (\r
+(EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT)(\r
OUT UINT64 *Count\r
);\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT) (\r
+(EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT)(\r
OUT UINT32 *HighCount\r
);\r
\r
\r
@retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in\r
Crc32.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Data is NULL.\r
+ @retval EFI_INVALID_PARAMETER Crc32 is NULL.\r
+ @retval EFI_INVALID_PARAMETER DataSize is 0.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CALCULATE_CRC32) (\r
+(EFIAPI *EFI_CALCULATE_CRC32)(\r
IN VOID *Data,\r
IN UINTN DataSize,\r
OUT UINT32 *Crc32\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_COPY_MEM) (\r
+(EFIAPI *EFI_COPY_MEM)(\r
IN VOID *Destination,\r
IN VOID *Source,\r
IN UINTN Length\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SET_MEM) (\r
+(EFIAPI *EFI_SET_MEM)(\r
IN VOID *Buffer,\r
IN UINTN Size,\r
IN UINT8 Value\r
\r
@retval EFI_SUCCESS The protocol interface was installed.\r
@retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
+ @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.\r
+ @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE) (\r
+(EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE)(\r
IN OUT EFI_HANDLE *Handle,\r
IN EFI_GUID *Protocol,\r
IN EFI_INTERFACE_TYPE InterfaceType,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (\r
+(EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r
IN OUT EFI_HANDLE *Handle,\r
...\r
);\r
@retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,\r
because OldInterface is still being used by a\r
driver that will not release it.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE) (\r
+(EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
IN VOID *OldInterface,\r
@retval EFI_NOT_FOUND The interface was not found.\r
@retval EFI_ACCESS_DENIED The interface was not removed because the interface\r
is still being used by a driver.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE) (\r
+(EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
IN VOID *Interface\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (\r
+(EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r
IN EFI_HANDLE Handle,\r
...\r
);\r
@param Protocol The published unique identifier of the protocol.\r
@param Interface Supplies the address where a pointer to the corresponding Protocol\r
Interface is returned.\r
+\r
@retval EFI_SUCCESS The interface information for the specified protocol was returned.\r
@retval EFI_UNSUPPORTED The device does not support the specified protocol.\r
- @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
+ @retval EFI_INVALID_PARAMETER Interface is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_HANDLE_PROTOCOL) (\r
+(EFIAPI *EFI_HANDLE_PROTOCOL)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
OUT VOID **Interface\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_OPEN_PROTOCOL) (\r
+(EFIAPI *EFI_OPEN_PROTOCOL)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
- OUT VOID **Interface,\r
+ OUT VOID **Interface, OPTIONAL\r
IN EFI_HANDLE AgentHandle,\r
- IN EFI_HANDLE ControllerHandle, OPTIONAL\r
+ IN EFI_HANDLE ControllerHandle,\r
IN UINT32 Attributes\r
);\r
\r
@param Handle The handle for the protocol interface that was previously opened\r
with OpenProtocol(), and is now being closed.\r
@param Protocol The published unique identifier of the protocol.\r
- @param Interface Supplies the address where a pointer to the corresponding Protocol\r
- Interface is returned.\r
@param AgentHandle The handle of the agent that is closing the protocol interface.\r
@param ControllerHandle If the agent that opened a protocol is a driver that follows the\r
UEFI Driver Model, then this parameter is the controller handle\r
that required the protocol interface.\r
\r
@retval EFI_SUCCESS The protocol instance was closed.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.\r
+ 2) AgentHandle is not a valid EFI_HANDLE.\r
+ 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.\r
+ 4) Protocol is NULL.\r
@retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.\r
2) The protocol interface specified by Handle and Protocol is not\r
currently open by AgentHandle and ControllerHandle.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_CLOSE_PROTOCOL) (\r
+(EFIAPI *EFI_CLOSE_PROTOCOL)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
IN EFI_HANDLE AgentHandle,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION) (\r
+(EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION)(\r
IN EFI_HANDLE Handle,\r
IN EFI_GUID *Protocol,\r
- IN EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,\r
+ OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,\r
OUT UINTN *EntryCount\r
);\r
\r
ProtocolBuffer. The number of protocol interface GUIDs was\r
returned in ProtocolBufferCount.\r
@retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r
+ @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PROTOCOLS_PER_HANDLE) (\r
+(EFIAPI *EFI_PROTOCOLS_PER_HANDLE)(\r
IN EFI_HANDLE Handle,\r
OUT EFI_GUID ***ProtocolBuffer,\r
OUT UINTN *ProtocolBufferCount\r
\r
@retval EFI_SUCCESS The notification event has been registered.\r
@retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
+ @retval EFI_INVALID_PARAMETER Event is NULL.\r
+ @retval EFI_INVALID_PARAMETER Registration is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY) (\r
+(EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY)(\r
IN EFI_GUID *Protocol,\r
IN EFI_EVENT Event,\r
OUT VOID **Registration\r
@retval EFI_SUCCESS The array of handles was returned.\r
@retval EFI_NOT_FOUND No handles match the search.\r
@retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.\r
+ @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.\r
+ @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.\r
+ @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.\r
+ @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LOCATE_HANDLE) (\r
+(EFIAPI *EFI_LOCATE_HANDLE)(\r
IN EFI_LOCATE_SEARCH_TYPE SearchType,\r
IN EFI_GUID *Protocol, OPTIONAL\r
IN VOID *SearchKey, OPTIONAL\r
\r
@retval EFI_SUCCESS The resulting handle was returned.\r
@retval EFI_NOT_FOUND No handles match the search.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
+ @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r
+ @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LOCATE_DEVICE_PATH) (\r
+(EFIAPI *EFI_LOCATE_DEVICE_PATH)(\r
IN EFI_GUID *Protocol,\r
IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r
OUT EFI_HANDLE *Device\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE) (\r
+(EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE)(\r
IN EFI_GUID *Guid,\r
IN VOID *Table\r
);\r
Returns an array of handles that support the requested protocol in a buffer allocated from pool.\r
\r
@param SearchType Specifies which handle(s) are to be returned.\r
- @param Protocol Specifies the protocol to search by.\r
+ @param Protocol Provides the protocol to search by.\r
+ This parameter is only valid for a SearchType of ByProtocol.\r
@param SearchKey Supplies the search key depending on the SearchType.\r
@param NoHandles The number of handles returned in Buffer.\r
@param Buffer A pointer to the buffer to return the requested array of handles that\r
handles in Buffer was returned in NoHandles.\r
@retval EFI_NOT_FOUND No handles match the search.\r
@retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_INVALID_PARAMETER NoHandles is NULL.\r
+ @retval EFI_INVALID_PARAMETER Buffer is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LOCATE_HANDLE_BUFFER) (\r
+(EFIAPI *EFI_LOCATE_HANDLE_BUFFER)(\r
IN EFI_LOCATE_SEARCH_TYPE SearchType,\r
IN EFI_GUID *Protocol, OPTIONAL\r
IN VOID *SearchKey, OPTIONAL\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_LOCATE_PROTOCOL) (\r
+(EFIAPI *EFI_LOCATE_PROTOCOL)(\r
IN EFI_GUID *Protocol,\r
IN VOID *Registration, OPTIONAL\r
OUT VOID **Interface\r
EFI_PHYSICAL_ADDRESS DataBlock;\r
EFI_PHYSICAL_ADDRESS ContinuationPointer;\r
} Union;\r
-} UEFI_CAPSULE_BLOCK_DESCRIPTOR;\r
+} EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
\r
typedef struct {\r
EFI_GUID CapsuleGuid;\r
UINT32 HeaderSize;\r
UINT32 Flags;\r
UINT32 CapsuleImageSize;\r
-} UEFI_CAPSULE_HEADER;\r
+} EFI_CAPSULE_HEADER;\r
+\r
+//\r
+// The EFI System Table entry must point to an array of capsules\r
+// that contain the same CapsuleGuid value. The array must be\r
+// prefixed by a UINT32 that represents the size of the array of capsules.\r
+//\r
+typedef struct {\r
+ UINT32 CapsuleArrayNumber;\r
+ VOID* CapsulePtr[1];\r
+} EFI_CAPSULE_TABLE;\r
\r
#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000\r
#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000\r
capsule has been successfully processed by the firmware.\r
@retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r
@retval EFI_INVALID_PARAMETER CapsuleSize is NULL.\r
+ @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r
+ @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_UPDATE_CAPSULE) (\r
- IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+(EFIAPI *EFI_UPDATE_CAPSULE)(\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
IN UINTN CapsuleCount,\r
IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r
);\r
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r
MaximumCapsuleSize and ResetType are undefined.\r
@retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES) (\r
- IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+(EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES)(\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
IN UINTN CapsuleCount,\r
OUT UINT64 *MaximumCapsuleSize,\r
OUT EFI_RESET_TYPE *ResetType\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_QUERY_VARIABLE_INFO) (\r
+(EFIAPI *EFI_QUERY_VARIABLE_INFO)(\r
IN UINT32 Attributes,\r
OUT UINT64 *MaximumVariableStorageSize,\r
OUT UINT64 *RemainingVariableStorageSize,\r
//\r
// EFI Runtime Services Table\r
//\r
-#define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249\r
+#define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249ULL\r
#define EFI_SYSTEM_TABLE_REVISION ((2<<16) | (10))\r
#define EFI_2_10_SYSTEM_TABLE_REVISION ((2<<16) | (10))\r
#define EFI_2_00_SYSTEM_TABLE_REVISION ((2<<16) | (00))\r
#define EFI_1_10_SYSTEM_TABLE_REVISION ((1<<16) | (10))\r
#define EFI_1_02_SYSTEM_TABLE_REVISION ((1<<16) | (02))\r
\r
-#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552\r
+#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL\r
#define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r
\r
+///\r
+/// EFI Runtime Services Table\r
+///\r
typedef struct {\r
- EFI_TABLE_HEADER Hdr;\r
+ ///\r
+ /// The table header for the EFI Runtime Services Table.\r
+ ///\r
+ EFI_TABLE_HEADER Hdr;\r
\r
//\r
// Time Services\r
} EFI_RUNTIME_SERVICES;\r
\r
\r
-#define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42\r
+#define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42ULL\r
#define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r
\r
+///\r
+/// EFI Boot Services Table\r
+///\r
typedef struct {\r
- EFI_TABLE_HEADER Hdr;\r
- \r
+ ///\r
+ /// The table header for the EFI Boot Services Table.\r
+ ///\r
+ EFI_TABLE_HEADER Hdr;\r
+\r
//\r
// Task Priority Services\r
//\r
//\r
EFI_COPY_MEM CopyMem;\r
EFI_SET_MEM SetMem;\r
-\r
EFI_CREATE_EVENT_EX CreateEventEx;\r
} EFI_BOOT_SERVICES;\r
\r
-//\r
-// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the \r
-// EFI System Table.\r
-// \r
+///\r
+/// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the\r
+/// EFI System Table.\r
+///\r
typedef struct{\r
+ ///\r
+ /// The 128-bit GUID value that uniquely identifies the system configuration table.\r
+ ///\r
EFI_GUID VendorGuid;\r
+ ///\r
+ /// A pointer to the table associated with VendorGuid.\r
+ ///\r
VOID *VendorTable;\r
} EFI_CONFIGURATION_TABLE;\r
\r
+///\r
+/// EFI System Table\r
+///\r
struct _EFI_SYSTEM_TABLE {\r
- EFI_TABLE_HEADER Hdr;\r
+ ///\r
+ /// The table header for the EFI System Table.\r
+ ///\r
+ EFI_TABLE_HEADER Hdr;\r
+ ///\r
+ /// A pointer to a null terminated Unicode string that identifies\r
+ /// the vendor that produces the system firmware for the platform.\r
+ ///\r
CHAR16 *FirmwareVendor;\r
+ ///\r
+ /// A firmware vendor specific value that identifies the revision\r
+ /// of the system firmware for the platform.\r
+ ///\r
UINT32 FirmwareRevision;\r
+ ///\r
+ /// The handle for the active console input device.\r
+ ///\r
EFI_HANDLE ConsoleInHandle;\r
+ ///\r
+ /// A pointer to the SIMPLE_INPUT_PROTOCOL interface that is\r
+ /// associated with ConsoleInHandle.\r
+ ///\r
EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r
+ ///\r
+ /// The handle for the active console output device.\r
+ ///\r
EFI_HANDLE ConsoleOutHandle;\r
+ ///\r
+ /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
+ /// that is associated with ConsoleOutHandle.\r
+ ///\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut;\r
+ ///\r
+ /// The handle for the active standard error console device.\r
+ ///\r
EFI_HANDLE StandardErrorHandle;\r
+ ///\r
+ /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
+ /// that is associated with StandardErrorHandle.\r
+ ///\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *StdErr;\r
+ ///\r
+ /// A pointer to the EFI Runtime Services Table.\r
+ ///\r
EFI_RUNTIME_SERVICES *RuntimeServices;\r
+ ///\r
+ /// A pointer to the EFI Boot Services Table.\r
+ ///\r
EFI_BOOT_SERVICES *BootServices;\r
+ ///\r
+ /// The number of system configuration tables in the buffer ConfigurationTable.\r
+ ///\r
UINTN NumberOfTableEntries;\r
+ ///\r
+ /// A pointer to the system configuration tables.\r
+ /// The number of entries in the table is NumberOfTableEntries.\r
+ ///\r
EFI_CONFIGURATION_TABLE *ConfigurationTable;\r
};\r
\r
+//\r
+// EFI Load Options Attributes\r
+//\r
+#define LOAD_OPTION_ACTIVE 0x00000001\r
+#define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r
+#define LOAD_OPTION_HIDDEN 0x00000008\r
+#define LOAD_OPTION_CATEGORY 0x00001F00\r
+\r
+#define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r
+#define LOAD_OPTION_CATEGORY_APP 0x00000100\r
+\r
+#define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r
+#define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r
+#define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300\r
+\r
+typedef union {\r
+ struct {\r
+ UINT32 Revision : 8;\r
+ UINT32 ShiftPressed : 1;\r
+ UINT32 ControlPressed : 1;\r
+ UINT32 AltPressed : 1;\r
+ UINT32 LogoPressed : 1;\r
+ UINT32 MenuPressed : 1;\r
+ UINT32 SysReqPessed : 1;\r
+ UINT32 Reserved : 16;\r
+ UINT32 InputKeyCount : 2;\r
+ } Options;\r
+ UINT32 PackedValue;\r
+} HOT_KEY_EFI_KEY_DATA;\r
+\r
+typedef struct {\r
+ HOT_KEY_EFI_KEY_DATA KeyOptions;\r
+ UINT32 BootOptionCrc;\r
+ UINT16 BootOption;\r
+//EFI_INPUT_KEY Keys[];\r
+} EFI_KEY_OPTION;\r
+\r
+#define EFI_KEY_OPTION_SHIFT 0x00000001\r
+#define EFI_KEY_OPTION_CONTROL 0x00000002\r
+#define EFI_KEY_OPTION_ALT 0x00000004\r
+#define EFI_KEY_OPTION_LOGO 0x00000008\r
+#define EFI_KEY_OPTION_MENU 0x00000010\r
+#define EFI_KEY_OPTION_SYSREQ 0x00000020\r
+#define EFI_KEY_CODE_COUNT 0x00000300\r
+\r
+\r
//\r
// EFI File location to boot from on removable media devices\r
//\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"\r
-#define EFI_REMOVABLE_MEDIA_FILE_NAME_EBC L"\\EFI\\BOOT\\BOOTEBC.EFI"\r
\r
#if defined (MDE_CPU_IA32)\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32\r
#elif defined (MDE_CPU_X64)\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64\r
#elif defined (MDE_CPU_EBC)\r
- #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_EBC\r
#else\r
#error Unknown Processor Type\r
#endif\r
projects / mirror_edk2.git / blobdiff