]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Uefi/UefiSpec.h
Fix file headers and a few comments
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiSpec.h
index e51c964a1eda75075735ce2c68dbaef47e319c25..bc5f5c2a8dc600f3f95650915cf983ebb3a8c8a4 100644 (file)
@@ -5,7 +5,8 @@
   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
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+  Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\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
@@ -652,23 +653,28 @@ EFI_STATUS
 /**\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
@@ -964,7 +970,7 @@ typedef enum {
   ///\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
@@ -1582,7 +1588,7 @@ typedef struct {
   ///\r
   /// Bit-mapped list describing the capsule attributes. The Flag values\r
   /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values\r
-  /// of 0x10000 - 0xFFFF0000 are defined by this specification\r
+  /// of 0x10000 - 0xFFFFFFFF are defined by this specification\r
   ///\r
   UINT32            Flags;\r
   ///\r
@@ -1628,8 +1634,9 @@ typedef struct {
   @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 CapsuleCount is 0.\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
@@ -1903,7 +1910,7 @@ typedef struct {
   ///\r
   EFI_HANDLE                        ConsoleInHandle;\r
   ///\r
-  /// A pointer to the SIMPLE_INPUT_PROTOCOL interface that is\r
+  /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is\r
   /// associated with ConsoleInHandle.\r
   ///\r
   EFI_SIMPLE_TEXT_INPUT_PROTOCOL    *ConIn;\r
@@ -1912,7 +1919,7 @@ typedef struct {
   ///\r
   EFI_HANDLE                        ConsoleOutHandle;\r
   ///\r
-  /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
+  /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
   /// that is associated with ConsoleOutHandle.\r
   ///\r
   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *ConOut;\r
@@ -1921,7 +1928,7 @@ typedef struct {
   ///\r
   EFI_HANDLE                        StandardErrorHandle;\r
   ///\r
-  /// A pointer to the SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
+  /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r
   /// that is associated with StandardErrorHandle.\r
   ///\r
   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *StdErr;\r
@@ -2009,7 +2016,7 @@ typedef union {
     ///\r
     /// The SysReq key must be pressed (1) or must not be pressed (0).\r
     ///\r
-    UINT32  SysReqPessed    : 1;\r
+    UINT32  SysReqPressed    : 1;\r
     UINT32  Reserved        : 16;\r
     ///\r
     /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If\r
@@ -2048,20 +2055,13 @@ typedef struct {
   //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
 // 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_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
@@ -2070,6 +2070,8 @@ typedef struct {
 #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