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 - 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
- http://opensource.org/licenses/bsd-license.php\r
-\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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \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
**/\r
\r
///\r
typedef enum {\r
///\r
- /// Allocate any available range of pages that satisfies the request\r
+ /// Allocate any available range of pages that satisfies the request.\r
///\r
AllocateAnyPages,\r
///\r
/// Allocate any available range of pages whose uppermost address is less than \r
- /// or equal to a specified maximum address\r
+ /// or equal to a specified maximum address.\r
///\r
AllocateMaxAddress,\r
///\r
- /// Allocate pages at a specified address\r
+ /// Allocate pages at a specified address.\r
///\r
AllocateAddress,\r
///\r
- /// Maximum enumeration value that may be used for bounds checking\r
+ /// Maximum enumeration value that may be used for bounds checking.\r
///\r
MaxAllocateType\r
} EFI_ALLOCATE_TYPE;\r
#define EFI_TIME_IN_DAYLIGHT 0x02\r
\r
///\r
-/// Value definition for EFI_TIME.TimeZone\r
+/// Value definition for EFI_TIME.TimeZone.\r
///\r
#define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r
\r
#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r
\r
///\r
-/// Memory descriptor version number\r
+/// Memory descriptor version number.\r
///\r
#define EFI_MEMORY_DESCRIPTOR_VERSION 1\r
\r
///\r
-/// Definition of an EFI memory descriptor\r
+/// Definition of an EFI memory descriptor.\r
///\r
typedef struct {\r
///\r
- /// Type of the memory region. See EFI_MEMORY_TYPE\r
+ /// Type of the memory region. See EFI_MEMORY_TYPE.\r
///\r
UINT32 Type;\r
///\r
@param Type The type of allocation to perform.\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of contiguous 4 KB pages to allocate.\r
- @param Memory Pointer to a physical address. On input, the way in which the address is\r
+ @param Memory The pointer to a physical address. On input, the way in which the address is\r
used depends on the value of Type.\r
\r
@retval EFI_SUCCESS The requested pages were allocated.\r
/**\r
Returns pool memory to the system.\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ @param Buffer The pointer to the buffer to free.\r
\r
@retval EFI_SUCCESS The memory was returned to the system.\r
@retval EFI_INVALID_PARAMETER Buffer was invalid.\r
Invoke a notification event\r
\r
@param Event Event whose notification function is being invoked.\r
- @param Context Pointer to the notification function's context,\r
+ @param Context The pointer to the notification function's context,\r
which is implementation-dependent.\r
\r
**/\r
\r
@param Type The type of event to create and its mode and attributes.\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
+ @param NotifyFunction The pointer to the event's notification function, if any.\r
+ @param NotifyContext The pointer to the notification function's context; corresponds to parameter\r
Context in the notification function.\r
- @param Event Pointer to the newly created event if the call succeeds; undefined\r
+ @param Event The pointer to the newly created event if the call succeeds; undefined\r
otherwise.\r
\r
@retval EFI_SUCCESS The event structure was created.\r
\r
@param Type The type of event to create and its mode and attributes.\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
+ @param NotifyFunction The pointer to the event's notification function, if any.\r
+ @param NotifyContext The 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
+ @param EventGroup The 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
+ @param Event The pointer to the newly created event if the call succeeds; undefined\r
otherwise.\r
\r
@retval EFI_SUCCESS The event structure was created.\r
///\r
typedef enum {\r
///\r
- /// An event's timer settings is to be cancelled and not trigger time is to be set\r
+ /// An event's timer settings is to be cancelled and not trigger time is to be set/\r
///\r
TimerCancel,\r
///\r
\r
@param NumberOfEvents The number of events in the Event array.\r
@param Event An array of EFI_EVENT.\r
- @param Index Pointer to the index of the event which satisfied the wait condition.\r
+ @param Index The pointer to the index of the event which satisfied the wait condition.\r
\r
@retval EFI_SUCCESS The event indicated by Index was signaled.\r
@retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.\r
/**\r
Returns the value of a variable.\r
\r
- @param VariableName A Null-terminated Unicode string that is the name of the\r
- vendor's variable.\r
+ @param VariableName A Null-terminated string that is the name of the vendor's\r
+ variable.\r
@param VendorGuid A unique identifier for the vendor.\r
@param Attributes If not NULL, a pointer to the memory location to return the\r
attributes bitmask for the variable.\r
@param VariableNameSize The size of the VariableName buffer.\r
@param VariableName On input, supplies the last VariableName that was returned\r
by GetNextVariableName(). On output, returns the Nullterminated\r
- Unicode string of the current variable.\r
+ string of the current variable.\r
@param VendorGuid On input, supplies the last VendorGuid that was returned by\r
GetNextVariableName(). On output, returns the\r
VendorGuid of the current variable.\r
/**\r
Sets the value of a variable.\r
\r
- @param VariableName A Null-terminated Unicode string that is the name of the\r
- vendor's variable.\r
- @param VendorGuid A unique identifier for the vendor.\r
- @param Attributes Attributes bitmask to set for the variable.\r
- @param DataSize The size in bytes of the Data buffer.\r
- @param Data The contents for the variable.\r
+ @param VariableName A Null-terminated string that is the name of the vendor's variable.\r
+ Each VariableName is unique for each VendorGuid. VariableName must\r
+ contain 1 or more characters. If VariableName is an empty string,\r
+ then EFI_INVALID_PARAMETER is returned.\r
+ @param VendorGuid A unique identifier for the vendor.\r
+ @param Attributes Attributes bitmask to set for the variable.\r
+ @param DataSize The size in bytes of the Data buffer. A size of zero causes the\r
+ variable to be deleted.\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_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_INVALID_PARAMETER VariableName is an empty 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_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
+ set but the AuthInfo does NOT pass the validation check carried out\r
+ by the firmware.\r
@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r
\r
**/\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. Ignored if SourceBuffer is NULL.\r
- @param ImageHandle Pointer to the returned image handle that is created when the\r
+ @param ImageHandle The 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
Transfers control to a loaded image's entry point.\r
\r
@param ImageHandle Handle of image to be started.\r
- @param ExitDataSize Pointer to the size, in bytes, of ExitData.\r
- @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated\r
- Unicode string, optionally followed by additional binary data.\r
+ @param ExitDataSize The pointer to the size, in bytes, of ExitData.\r
+ @param ExitData The pointer to a pointer to a data buffer that includes a Null-terminated\r
+ string, optionally followed by additional binary data.\r
\r
@retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r
- has already been initialized with StartImage\r
+ has already been initialized with StartImage.\r
@return Exit code from image\r
\r
**/\r
/**\r
Terminates a loaded EFI image and returns control to boot services.\r
\r
- @param ImageHandle Handle that identifies the image.\r
+ @param ImageHandle Handle that identifies the image. This parameter is passed to the \r
+ image on entry.\r
@param ExitStatus The image's exit code.\r
- @param ExitDataSize The size, in bytes, of ExitData.\r
- @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,\r
- optionally followed by additional binary data.\r
+ @param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.\r
+ @param ExitData The pointer to a data buffer that includes a Null-terminated string,\r
+ optionally followed by additional binary data. The string is a \r
+ description that the caller may use to further indicate the reason \r
+ for the image's exit. ExitData is only valid if ExitStatus \r
+ is something other than EFI_SUCCESS. The ExitData buffer \r
+ must be allocated by calling AllocatePool().\r
\r
@retval EFI_SUCCESS The image specified by ImageHandle was unloaded.\r
@retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and\r
@param Timeout The number of seconds to set the watchdog timer to.\r
@param WatchdogCode The numeric code to log on a watchdog timer timeout event.\r
@param DataSize The size, in bytes, of WatchdogData.\r
- @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally\r
+ @param WatchdogData A data buffer that includes a Null-terminated string, optionally\r
followed by additional binary data.\r
\r
@retval EFI_SUCCESS The timeout has been set.\r
@retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.\r
@retval EFI_UNSUPPORTED The system does not have a watchdog timer.\r
- @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware\r
+ @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware\r
error.\r
\r
**/\r
///\r
EfiResetWarm,\r
///\r
- /// Used to induce en entry into power state equivalent to the ACPI G2/S5 or G3\r
+ /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3\r
/// state. If the system does not support this reset type, then when the system\r
/// is rebooted, it should exhibit the EfiResetCold attributes.\r
///\r
@param DataSize The size, in bytes, of WatchdogData.\r
@param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or\r
EfiResetShutdown the data buffer starts with a Null-terminated\r
- Unicode string, optionally followed by additional binary data.\r
+ string, optionally followed by additional binary data.\r
\r
**/\r
typedef\r
/**\r
Returns a monotonically increasing count for the platform.\r
\r
- @param Count Pointer to returned value.\r
+ @param Count The pointer to returned value.\r
\r
@retval EFI_SUCCESS The next monotonic count was returned.\r
@retval EFI_INVALID_PARAMETER Count is NULL.\r
/**\r
Returns the next high 32 bits of the platform's monotonic counter.\r
\r
- @param HighCount Pointer to returned value.\r
+ @param HighCount The pointer to returned value.\r
\r
@retval EFI_SUCCESS The next high monotonic count was returned.\r
@retval EFI_INVALID_PARAMETER HighCount is NULL.\r
/**\r
Copies the contents of one buffer to another buffer.\r
\r
- @param Destination Pointer to the destination buffer of the memory copy.\r
- @param Source Pointer to the source buffer of the memory copy.\r
+ @param Destination The pointer to the destination buffer of the memory copy.\r
+ @param Source The pointer to the source buffer of the memory copy.\r
@param Length Number of bytes to copy from Source to Destination.\r
\r
**/\r
/**\r
The SetMem() function fills a buffer with a specified value.\r
\r
- @param Buffer Pointer to the buffer to fill.\r
+ @param Buffer The pointer to the buffer to fill.\r
@param Size Number of bytes in Buffer to fill.\r
@param Value Value to fill Buffer with.\r
\r
} EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
\r
///\r
-/// EFI Capsule Header\r
+/// EFI Capsule Header.\r
///\r
typedef struct {\r
///\r
\r
#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000\r
#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000\r
+#define CAPSULE_FLAGS_INITIATE_RESET 0x00040000\r
\r
/**\r
Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r
@retval EFI_SUCCESS Valid capsule was passed. If\r
CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r
capsule has been successfully processed by the firmware.\r
- @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r
+ @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r
+ set in the capsule header.\r
@retval EFI_INVALID_PARAMETER CapsuleCount is 0.\r
@retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r
// EFI Runtime Services Table\r
//\r
#define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r
-#define EFI_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r
+#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))\r
+#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))\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
+#define EFI_SYSTEM_TABLE_REVISION EFI_2_30_SYSTEM_TABLE_REVISION\r
\r
#define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')\r
-#define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r
+#define EFI_RUNTIME_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION\r
\r
///\r
-/// EFI Runtime Services Table\r
+/// EFI Runtime Services Table.\r
///\r
typedef struct {\r
///\r
\r
\r
#define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')\r
-#define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r
+#define EFI_BOOT_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION\r
\r
///\r
-/// EFI Boot Services Table\r
+/// EFI Boot Services Table.\r
///\r
typedef struct {\r
///\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
+ /// A pointer to a null terminated string that identifies the vendor\r
+ /// that produces the system firmware for the platform.\r
///\r
CHAR16 *FirmwareVendor;\r
///\r
///\r
UINT32 FirmwareRevision;\r
///\r
- /// The handle for the active console input device.\r
+ /// The handle for the active console input device. This handle must support\r
+ /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r
///\r
EFI_HANDLE ConsoleInHandle;\r
///\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut;\r
///\r
/// The handle for the active standard error console device.\r
+ /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
///\r
EFI_HANDLE StandardErrorHandle;\r
///\r
@param SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
- @retval Others Some unexpected error happened.\r
+ @retval Others An unexpected error occurred.\r
**/\r
typedef\r
EFI_STATUS\r
} EFI_BOOT_KEY_DATA;\r
\r
///\r
-/// EFI Key Option\r
+/// EFI Key Option.\r
///\r
typedef struct {\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_ARM L"\\EFI\\BOOT\\BOOTARM.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
+#elif defined (MDE_CPU_ARM)\r
+ #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM\r
#else\r
#error Unknown Processor Type\r
#endif\r
projects / mirror_edk2.git / blobdiff