/** @file\r
Include file that supports UEFI.\r
\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
+ This include file must contain things defined in the UEFI 2.4 specification.\r
+ If a code construct is defined in the UEFI 2.4 specification it must be included\r
by this include file.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+Copyright (c) 2006 - 2013, 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
\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleTextIn.h>\r
+#include <Protocol/SimpleTextInEx.h>\r
#include <Protocol/SimpleTextOut.h>\r
\r
///\r
@retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or\r
AllocateMaxAddress or AllocateAddress.\r
2) MemoryType is in the range\r
+ 3) Memory is NULL.\r
EfiMaxMemoryType..0x7FFFFFFF.\r
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
@retval EFI_NOT_FOUND The requested pages could not be found.\r
\r
@retval EFI_SUCCESS The requested number of bytes was allocated.\r
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r
- @retval EFI_INVALID_PARAMETER PoolType was invalid.\r
+ @retval EFI_INVALID_PARAMETER PoolType was invalid or Buffer is NULL.\r
\r
**/\r
typedef\r
2) No drivers were connected to ControllerHandle, but\r
RemainingDevicePath is not NULL, and it is an End Device\r
Path Node.\r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
@retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances\r
present in the system.\r
2) No drivers were connected to ControllerHandle.\r
-\r
+ @retval EFI_SECURITY_VIOLATION \r
+ The user has no permission to start UEFI device drivers on the device path \r
+ associated with the ControllerHandle or specified by the RemainingDevicePath.\r
**/\r
typedef\r
EFI_STATUS\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
- @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.\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
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 DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, \r
+ EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or \r
+ EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero \r
+ causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is \r
+ set, then a SetVariable() call with a DataSize of zero will not cause any change to \r
+ the variable value (the timestamp associated with the variable may be updated however \r
+ even if no new data value is provided,see the description of the \r
+ EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not \r
+ be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). \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
+ @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r
DataSize exceeds the maximum allowed.\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 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_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS \r
+ or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo \r
+ does NOT pass the validation check carried out by the firmware.\r
+ \r
@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r
\r
**/\r
@retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not\r
understood.\r
@retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.\r
-\r
+ @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the \r
+ image from being loaded. NULL is returned in *ImageHandle.\r
+ @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a \r
+ valid EFI_LOADED_IMAGE_PROTOCOL. However, the current \r
+ platform policy specifies that the image should not be started.\r
**/\r
typedef\r
EFI_STATUS\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
+ @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r
+ has already been initialized with StartImage.\r
+ @retval EFI_SECURITY_VIOLATION The current platform policy specifies that the image should not be started.\r
@return Exit code from image\r
\r
**/\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
- EfiResetShutdown\r
+ EfiResetShutdown,\r
+ ///\r
+ /// Used to induce a system-wide reset. The exact type of the reset is defined by\r
+ /// the EFI_GUID that follows the Null-terminated Unicode string passed into\r
+ /// ResetData. If the platform does not recognize the EFI_GUID in ResetData the \r
+ /// platform must pick a supported reset type to perform. The platform may\r
+ /// optionally log the parameters from any non-normal reset that occurs.\r
+ ///\r
+ EfiResetPlatformSpecific\r
} EFI_RESET_TYPE;\r
\r
/**\r
/**\r
Installs one or more protocol interfaces into the boot services environment.\r
\r
- @param Handle The handle to install the new protocol interfaces on, or NULL if a new\r
- handle is to be allocated.\r
+ @param Handle The pointer to a handle to install the new protocol interfaces on,\r
+ or a pointer to NULL if a new handle is to be allocated.\r
@param ... A variable argument list containing pairs of protocol GUIDs and protocol\r
interfaces.\r
\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
@retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in\r
the handle database.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r
\r
**/\r
typedef\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 Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
@retval EFI_INVALID_PARAMETER Protocol is NULL.\r
\r
**/\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 Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
@retval EFI_INVALID_PARAMETER Protocol is NULL.\r
\r
**/\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 Handle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER Handle is NULL.\r
@retval EFI_INVALID_PARAMETER Protocol is NULL.\r
@retval EFI_INVALID_PARAMETER Interface is NULL.\r
\r
that required the protocol interface.\r
\r
@retval EFI_SUCCESS The protocol instance was closed.\r
- @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.\r
- 2) AgentHandle is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER 1) Handle is NULL.\r
+ 2) AgentHandle is NULL.\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
\r
@retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r
@retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.\r
- @retval EFI_INVALID_PARAMETER Guid is not valid.\r
+ @retval EFI_INVALID_PARAMETER Guid is NULL.\r
@retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r
\r
**/\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
- @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r
+ @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule \r
+ is compatible with this platform but is not capable of being submitted or processed \r
+ in runtime. The caller may resubmit the capsule prior to ExitBootServices().\r
+ @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates \r
+ the capsule is compatible with this platform but there are insufficient resources to process.\r
\r
**/\r
typedef\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
+ @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule \r
+ is compatible with this platform but is not capable of being submitted or processed \r
+ in runtime. The caller may resubmit the capsule prior to ExitBootServices().\r
+ @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates \r
+ the capsule is compatible with this platform but there are insufficient resources to process.\r
\r
**/\r
typedef\r
OUT UINT64 *MaximumVariableSize\r
);\r
\r
+//\r
+// Firmware should stop at a firmware user interface on next boot\r
+//\r
+#define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001\r
+#define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002\r
+#define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004\r
+#define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008\r
+#define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010\r
\r
//\r
// EFI Runtime Services Table\r
//\r
#define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r
+#define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40))\r
+#define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))\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
+#define EFI_SYSTEM_TABLE_REVISION EFI_2_40_SYSTEM_TABLE_REVISION\r
+#define EFI_SPECIFICATION_VERSION EFI_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_30_SYSTEM_TABLE_REVISION\r
+#define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION\r
\r
///\r
/// EFI Runtime Services Table.\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_30_SYSTEM_TABLE_REVISION\r
+#define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION\r
\r
///\r
/// EFI Boot Services Table.\r
///\r
/// EFI Key Option.\r
///\r
+#pragma pack(1)\r
typedef struct {\r
///\r
/// Specifies options about how the key will be processed.\r
///\r
//EFI_INPUT_KEY Keys[];\r
} EFI_KEY_OPTION;\r
+#pragma pack()\r
\r
//\r
// EFI File location to boot from on removable media devices\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
+#define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.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_EBC)\r
#elif defined (MDE_CPU_ARM)\r
#define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM\r
+#elif defined (MDE_CPU_AARCH64)\r
+ #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64\r
#else\r
#error Unknown Processor Type\r
#endif\r
projects / mirror_edk2.git / blobdiff