]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Guid/VariableFormat.h
MdeModulePkg: Move authenticated variable definition from SecurityPkg
[mirror_edk2.git] / MdeModulePkg / Include / Guid / VariableFormat.h
index 0db3a22f34ff4b409d9cd9be5ad09237d87a15c7..c52eaf3f12ec39c0cab8ee4e2079341211aae0b8 100644 (file)
@@ -2,7 +2,7 @@
   The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
   VariableFormat.h defines variable data headers and variable storage region headers.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, 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
@@ -19,7 +19,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EFI_VARIABLE_GUID \\r
   { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }\r
 \r
+#define EFI_AUTHENTICATED_VARIABLE_GUID \\r
+  { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }\r
+\r
 extern EFI_GUID gEfiVariableGuid;\r
+extern EFI_GUID gEfiAuthenticatedVariableGuid;\r
 \r
 ///\r
 /// Alignment of variable name and data, according to the architecture:\r
@@ -60,6 +64,7 @@ typedef enum {
 #pragma pack(1)\r
 \r
 #define VARIABLE_STORE_SIGNATURE  EFI_VARIABLE_GUID\r
+#define AUTHENTICATED_VARIABLE_STORE_SIGNATURE  EFI_AUTHENTICATED_VARIABLE_GUID\r
 \r
 ///\r
 /// Variable Store Header Format and State.\r
@@ -136,6 +141,49 @@ typedef struct {
   EFI_GUID    VendorGuid;\r
 } VARIABLE_HEADER;\r
 \r
+///\r
+/// Single Authenticated Variable Data Header Structure.\r
+///\r
+typedef struct {\r
+  ///\r
+  /// Variable Data Start Flag.\r
+  ///\r
+  UINT16      StartId;\r
+  ///\r
+  /// Variable State defined above.\r
+  ///\r
+  UINT8       State;\r
+  UINT8       Reserved;\r
+  ///\r
+  /// Attributes of variable defined in UEFI specification.\r
+  ///\r
+  UINT32      Attributes;\r
+  ///\r
+  /// Associated monotonic count value against replay attack.\r
+  ///\r
+  UINT64      MonotonicCount;\r
+  ///\r
+  /// Associated TimeStamp value against replay attack.\r
+  ///\r
+  EFI_TIME    TimeStamp;\r
+  ///\r
+  /// Index of associated public key in database.\r
+  ///\r
+  UINT32      PubKeyIndex;\r
+  ///\r
+  /// Size of variable null-terminated Unicode string name.\r
+  ///\r
+  UINT32      NameSize;\r
+  ///\r
+  /// Size of the variable data without this header.\r
+  ///\r
+  UINT32      DataSize;\r
+  ///\r
+  /// A unique identifier for the vendor that produces and consumes this varaible.\r
+  ///\r
+  EFI_GUID    VendorGuid;\r
+} AUTHENTICATED_VARIABLE_HEADER;\r
+\r
 #pragma pack()\r
 \r
 typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;\r
@@ -157,90 +205,4 @@ struct _VARIABLE_INFO_ENTRY {
   BOOLEAN             Volatile;    ///< TRUE if volatile, FALSE if non-volatile.\r
 };\r
 \r
-//\r
-// This structure is used for SMM variable. the collected statistics data is saved in SMRAM. It can be got from \r
-// SMI handler. The communication buffer should be: \r
-// EFI_SMM_COMMUNICATE_HEADER + SMM_VARIABLE_COMMUNICATE_HEADER + payload.\r
-//\r
-typedef struct {\r
-  UINTN       Function;\r
-  EFI_STATUS  ReturnStatus;\r
-  UINT8       Data[1];\r
-} SMM_VARIABLE_COMMUNICATE_HEADER;\r
-\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
-//\r
-#define SMM_VARIABLE_FUNCTION_GET_VARIABLE            1\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_GET_NEXT_VARIABLE_NAME  2\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_SET_VARIABLE            3\r
-//\r
-// The payload for this function is SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO     4\r
-//\r
-// It is a notify event, no extra payload for this function.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_READY_TO_BOOT           5\r
-//\r
-// It is a notify event, no extra payload for this function.\r
-// \r
-#define SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE       6\r
-//\r
-// The payload for this function is VARIABLE_INFO_ENTRY. The GUID in EFI_SMM_COMMUNICATE_HEADER \r
-// is gEfiSmmVariableProtocolGuid.\r
-//\r
-#define SMM_VARIABLE_FUNCTION_GET_STATISTICS          7\r
-\r
-///\r
-/// Size of SMM communicate header, without including the payload.\r
-///\r
-#define SMM_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))\r
-\r
-///\r
-/// Size of SMM variable communicate header, without including the payload.\r
-///\r
-#define SMM_VARIABLE_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (SMM_VARIABLE_COMMUNICATE_HEADER, Data))\r
-\r
-///\r
-/// This structure is used to communicate with SMI handler by SetVariable and GetVariable.\r
-///\r
-typedef struct {\r
-  EFI_GUID    Guid;\r
-  UINTN       DataSize;\r
-  UINTN       NameSize;\r
-  UINT32      Attributes;  \r
-  CHAR16      Name[1];\r
-} SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE;\r
-\r
-///\r
-/// This structure is used to communicate with SMI handler by GetNextVariableName.\r
-///\r
-typedef struct {\r
-  EFI_GUID    Guid;\r
-  UINTN       NameSize;\r
-  CHAR16      Name[1];\r
-} SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME;\r
-\r
-///\r
-/// This structure is used to communicate with SMI handler by QueryVariableInfo.\r
-///\r
-typedef struct {\r
-  UINT64          MaximumVariableStorageSize;\r
-  UINT64          RemainingVariableStorageSize;\r
-  UINT64          MaximumVariableSize;\r
-  UINT32          Attributes; \r
-} SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO;\r
-\r
-///\r
-/// This structure is used to communicate with SMI handler to get variable statistics information.\r
-///\r
-typedef VARIABLE_INFO_ENTRY  SMM_VARIABLE_COMMUNICATE_VARIABLE_INFO_ENTRY;\r
-\r
 #endif // _EFI_VARIABLE_H_\r