Removed tabs and fixed some minor coding style issues. Also fixed typo in EFI_PEI_ENT...

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiMultiPhase.h

diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h
index 9f9c71949460e7d7a49ebc65fe3df5c7cf8bc87c..ae46db9ac178b57ea52361c65ead0eacc137db53 100644 (file)
--- a/MdePkg/Include/Uefi/UefiMultiPhase.h
+++ b/MdePkg/Include/Uefi/UefiMultiPhase.h
@@ -1,16 +1,16 @@
 /** @file\r
 /** @file\r

-       This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.\r
+  This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.\r

 \r
 \r

-       Copyright (c) 2006, 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
+  Copyright (c) 2006, 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
 \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
+  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

-       Module Name:  UefiMultiPhase.h\r
+  Module Name:  UefiMultiPhase.h\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -21,21 +21,21 @@
 // Enumeration of memory types introduced in UEFI.\r
 // \r
 typedef enum {\r
 // Enumeration of memory types introduced in UEFI.\r
 // \r
 typedef enum {\r

-       EfiReservedMemoryType,\r
-       EfiLoaderCode,\r
-       EfiLoaderData,\r
-       EfiBootServicesCode,\r
-       EfiBootServicesData,\r
-       EfiRuntimeServicesCode,\r
-       EfiRuntimeServicesData,\r
-       EfiConventionalMemory,\r
-       EfiUnusableMemory,\r
-       EfiACPIReclaimMemory,\r
-       EfiACPIMemoryNVS,\r
-       EfiMemoryMappedIO,\r
-       EfiMemoryMappedIOPortSpace,\r
-       EfiPalCode,\r
-       EfiMaxMemoryType\r
+  EfiReservedMemoryType,\r
+  EfiLoaderCode,\r
+  EfiLoaderData,\r
+  EfiBootServicesCode,\r
+  EfiBootServicesData,\r
+  EfiRuntimeServicesCode,\r
+  EfiRuntimeServicesData,\r
+  EfiConventionalMemory,\r
+  EfiUnusableMemory,\r
+  EfiACPIReclaimMemory,\r
+  EfiACPIMemoryNVS,\r
+  EfiMemoryMappedIO,\r
+  EfiMemoryMappedIOPortSpace,\r
+  EfiPalCode,\r
+  EfiMaxMemoryType\r

 } EFI_MEMORY_TYPE;\r
 \r
 \r
 } EFI_MEMORY_TYPE;\r
 \r
 \r


@@ -43,56 +43,56 @@ typedef enum {
 // Data structure that precedes all of the standard EFI table types.\r
 // \r
 typedef struct {\r
 // Data structure that precedes all of the standard EFI table types.\r
 // \r
 typedef struct {\r

-       UINT64  Signature;\r
-       UINT32  Revision;\r
-       UINT32  HeaderSize;\r
-       UINT32  CRC32;\r
-       UINT32  Reserved;\r
+  UINT64  Signature;\r
+  UINT32  Revision;\r
+  UINT32  HeaderSize;\r
+  UINT32  CRC32;\r
+  UINT32  Reserved;\r

 } EFI_TABLE_HEADER;\r
 \r
 //\r
 // Attributes of variable.\r
 // \r
 } EFI_TABLE_HEADER;\r
 \r
 //\r
 // Attributes of variable.\r
 // \r

-#define EFI_VARIABLE_NON_VOLATILE                                                              0x00000001\r
-#define EFI_VARIABLE_BOOTSERVICE_ACCESS                                        0x00000002\r
-#define EFI_VARIABLE_RUNTIME_ACCESS                                                    0x00000004\r
-#define EFI_VARIABLE_HARDWARE_ERROR_RECORD                             0x00000008\r
+#define EFI_VARIABLE_NON_VOLATILE                 0x00000001\r
+#define EFI_VARIABLE_BOOTSERVICE_ACCESS           0x00000002\r
+#define EFI_VARIABLE_RUNTIME_ACCESS               0x00000004\r
+#define EFI_VARIABLE_HARDWARE_ERROR_RECORD        0x00000008\r

 \r
 //\r
 // This attribute is identified by the mnemonic 'HR' \r
 // elsewhere in this specification.\r
 // \r
 \r
 //\r
 // This attribute is identified by the mnemonic 'HR' \r
 // elsewhere in this specification.\r
 // \r

-#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS                0x00000010\r
+#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010\r

 \r
 \r
 \r
 //\r
 // _WIN_CERTIFICATE.wCertificateType\r
 // \r
 \r
 \r
 \r
 //\r
 // _WIN_CERTIFICATE.wCertificateType\r
 // \r

-#define WIN_CERT_TYPE_EFI_PKCS115      0x0EF0\r
-#define WIN_CERT_TYPE_EFI_GUID                         0x0EF1\r
+#define WIN_CERT_TYPE_EFI_PKCS115   0x0EF0\r
+#define WIN_CERT_TYPE_EFI_GUID      0x0EF1\r

 \r
 /**\r
    \r
 \r
 /**\r
    \r

-       The WIN_CERTIFICATE structure is part of the PE/COFF\r
+  The WIN_CERTIFICATE structure is part of the PE/COFF\r

   specification and has the following definition:\r
 \r
   @param dwLength   The length of the entire certificate,\r
                     including the length of the header, in\r
                     bytes.\r
 \r
   specification and has the following definition:\r
 \r
   @param dwLength   The length of the entire certificate,\r
                     including the length of the header, in\r
                     bytes.\r
 \r

-  @param wRevision     The revision level of the WIN_CERTIFICATE\r
+  @param wRevision  The revision level of the WIN_CERTIFICATE\r

                     structure. The current revision level is\r
                     0x0200.\r
 \r
                     structure. The current revision level is\r
                     0x0200.\r
 \r

-  @param wCertificateType      The certificate type. See\r
+  @param wCertificateType   The certificate type. See\r

                             WIN_CERT_TYPE_xxx for the UEFI\r
                             certificate types. The UEFI\r
                             specification reserves the range of\r
                             certificate type values from 0x0EF0\r
                             to 0x0EFF.\r
 \r
                             WIN_CERT_TYPE_xxx for the UEFI\r
                             certificate types. The UEFI\r
                             specification reserves the range of\r
                             certificate type values from 0x0EF0\r
                             to 0x0EFF.\r
 \r

-  @param bCertificate  The actual certificate. The format of\r
+  @param bCertificate   The actual certificate. The format of\r

                         the certificate depends on\r
                         wCertificateType. The format of the UEFI\r
                         certificates is defined below.\r
                         the certificate depends on\r
                         wCertificateType. The format of the UEFI\r
                         certificates is defined below.\r


@@ -100,31 +100,31 @@ typedef struct {
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE {\r
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE {\r

-       UINT32  dwLength;\r
-       UINT16  wRevision;\r
-       UINT16  wCertificateType;\r
-       //UINT8 bCertificate[ANYSIZE_ARRAY];\r
+  UINT32  dwLength;\r
+  UINT16  wRevision;\r
+  UINT16  wCertificateType;\r
+  //UINT8 bCertificate[ANYSIZE_ARRAY];\r

 } WIN_CERTIFICATE;\r
 \r
 //\r
 // WIN_CERTIFICATE_UEFI_GUID.CertType\r
 // \r
 #define EFI_CERT_TYPE_RSA2048_SHA256_GUID \\r
 } WIN_CERTIFICATE;\r
 \r
 //\r
 // WIN_CERTIFICATE_UEFI_GUID.CertType\r
 // \r
 #define EFI_CERT_TYPE_RSA2048_SHA256_GUID \\r

-       {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf } }\r
+  {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf } }\r

 \r
 //\r
 // WIN_CERTIFICATE_UEFI_GUID.CertData\r
 // \r
 typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {\r
 \r
 //\r
 // WIN_CERTIFICATE_UEFI_GUID.CertData\r
 // \r
 typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {\r

-       UINT32  HashType;\r
-       UINT8   PublicKey[256];\r
-       UINT8   Signature[256];\r
+  UINT32  HashType;\r
+  UINT8   PublicKey[256];\r
+  UINT8   Signature[256];\r

 } EFI_CERT_BLOCK_RSA_2048_SHA256;\r
 \r
 \r
 /**\r
    \r
 } EFI_CERT_BLOCK_RSA_2048_SHA256;\r
 \r
 \r
 /**\r
    \r

-  @param Hdr   This is the standard WIN_CERTIFICATE header, where\r
+  @param Hdr  This is the standard WIN_CERTIFICATE header, where\r

               wCertificateType is set to\r
               WIN_CERT_TYPE_UEFI_GUID.\r
 \r
               wCertificateType is set to\r
               WIN_CERT_TYPE_UEFI_GUID.\r
 \r


@@ -132,12 +132,12 @@ typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
                     format of the CertData. In this case, the\r
                     value is EFI_CERT_TYPE_RSA2048_SHA256_GUID.\r
 \r
                     format of the CertData. In this case, the\r
                     value is EFI_CERT_TYPE_RSA2048_SHA256_GUID.\r
 \r

-  @param CertData      This is the certificate data. The format of\r
+  @param CertData   This is the certificate data. The format of\r

                     the data is determined by the CertType. In\r
                     this case the value is\r
                     EFI_CERT_BLOCK_RSA_2048_SHA256.\r
 \r
                     the data is determined by the CertType. In\r
                     this case the value is\r
                     EFI_CERT_BLOCK_RSA_2048_SHA256.\r
 \r

-  @param Information   The WIN_CERTIFICATE_UEFI_GUID certificate\r
+  @param Information  The WIN_CERTIFICATE_UEFI_GUID certificate\r

                       type allows new types of certificates to\r
                       be developed for driver authentication\r
                       without requiring a new certificate type.\r
                       type allows new types of certificates to\r
                       be developed for driver authentication\r
                       without requiring a new certificate type.\r


@@ -149,9 +149,9 @@ typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r

-       WIN_CERTIFICATE         Hdr;\r
-       EFI_GUID                                        CertType;\r
-       // UINT8                                                CertData[ANYSIZE_ARRAY];\r
+  WIN_CERTIFICATE   Hdr;\r
+  EFI_GUID          CertType;\r
+  // UINT8            CertData[ANYSIZE_ARRAY];\r

 } WIN_CERTIFICATE_UEFI_GUID;\r
 \r
 \r
 } WIN_CERTIFICATE_UEFI_GUID;\r
 \r
 \r


@@ -165,9 +165,9 @@ typedef struct _WIN_CERTIFICATE_UEFI_GUID {
   signature.\r
   \r
   The WIN_CERTIFICATE_UEFI_PKCS1_15 structure is derived from\r
   signature.\r
   \r
   The WIN_CERTIFICATE_UEFI_PKCS1_15 structure is derived from\r

-       WIN_CERTIFICATE and encapsulate the information needed to  \r
-       implement the RSASSA-PKCS1-v1_5 digital signature algorithm as  \r
-       specified in RFC2437.  \r
+  WIN_CERTIFICATE and encapsulate the information needed to  \r
+  implement the RSASSA-PKCS1-v1_5 digital signature algorithm as  \r
+  specified in RFC2437.  \r

   \r
   @param Hdr  This is the standard WIN_CERTIFICATE header, where\r
               wCertificateType is set to\r
   \r
   @param Hdr  This is the standard WIN_CERTIFICATE header, where\r
               wCertificateType is set to\r


@@ -180,7 +180,7 @@ typedef struct _WIN_CERTIFICATE_UEFI_GUID {
                         in Section 26.4.1. See\r
                         EFI_HASH_ALGORITHM_x.\r
   \r
                         in Section 26.4.1. See\r
                         EFI_HASH_ALGORITHM_x.\r
   \r

-  @param Signature     This is the actual digital signature. The\r
+  @param Signature  This is the actual digital signature. The\r

                     size of the signature is the same size as\r
                     the key (1024-bit key is 128 bytes) and can\r
                     be determined by subtracting the length of\r
                     size of the signature is the same size as\r
                     the key (1024-bit key is 128 bytes) and can\r
                     be determined by subtracting the length of\r


@@ -190,34 +190,34 @@ typedef struct _WIN_CERTIFICATE_UEFI_GUID {
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE_EFI_PKCS1_15 {\r
 \r
 **/\r
 typedef struct _WIN_CERTIFICATE_EFI_PKCS1_15 {\r

-       WIN_CERTIFICATE Hdr;\r
-       EFI_GUID                                HashAlgorithm;\r
-       // UINT8 Signature[ANYSIZE_ARRAY];\r
+  WIN_CERTIFICATE Hdr;\r
+  EFI_GUID        HashAlgorithm;\r
+  // UINT8 Signature[ANYSIZE_ARRAY];\r

 } WIN_CERTIFICATE_EFI_PKCS1_15;\r
 \r
 \r
 /**\r
    \r
 } WIN_CERTIFICATE_EFI_PKCS1_15;\r
 \r
 \r
 /**\r
    \r

-       AuthInfo is a WIN_CERTIFICATE using the wCertificateType\r
-       WIN_CERTIFICATE_UEFI_GUID and the CertType\r
-       EFI_CERT_TYPE_RSA2048_SHA256. If the attribute specifies\r
-       authenticated access, then the Data buffer should begin with an\r
-       authentication descriptor prior to the data payload and DataSize\r
-       should reflect the the data.and descriptor size. The caller\r
-       shall digest the Monotonic Count value and the associated data\r
-       for the variable update using the SHA-256 1-way hash algorithm.\r
-       The ensuing the 32-byte digest will be signed using the private\r
-       key associated w/ the public/private 2048-bit RSA key-pair. The\r
-       WIN_CERTIFICATE shall be used to describe the signature of the\r
-       Variable data *Data. In addition, the signature will also\r
+  AuthInfo is a WIN_CERTIFICATE using the wCertificateType\r
+  WIN_CERTIFICATE_UEFI_GUID and the CertType\r
+  EFI_CERT_TYPE_RSA2048_SHA256. If the attribute specifies\r
+  authenticated access, then the Data buffer should begin with an\r
+  authentication descriptor prior to the data payload and DataSize\r
+  should reflect the the data.and descriptor size. The caller\r
+  shall digest the Monotonic Count value and the associated data\r
+  for the variable update using the SHA-256 1-way hash algorithm.\r
+  The ensuing the 32-byte digest will be signed using the private\r
+  key associated w/ the public/private 2048-bit RSA key-pair. The\r
+  WIN_CERTIFICATE shall be used to describe the signature of the\r
+  Variable data *Data. In addition, the signature will also\r

   include the MonotonicCount value to guard against replay attacks\r
   \r
   include the MonotonicCount value to guard against replay attacks\r
   \r

-  @param       MonotonicCount  Included in the signature of\r
+  @param  MonotonicCount  Included in the signature of\r

                           AuthInfo.Used to ensure freshness/no\r
                           replay. Incremented during each\r
                           "Write" access.\r
   \r
                           AuthInfo.Used to ensure freshness/no\r
                           replay. Incremented during each\r
                           "Write" access.\r
   \r

-  @param AuthInfo      Provides the authorization for the variable\r
+  @param AuthInfo   Provides the authorization for the variable\r

                     access. It is a signature across the\r
                     variable data and the  Monotonic Count\r
                     value. Caller uses Private key that is\r
                     access. It is a signature across the\r
                     variable data and the  Monotonic Count\r
                     value. Caller uses Private key that is\r


@@ -226,8 +226,8 @@ typedef struct _WIN_CERTIFICATE_EFI_PKCS1_15 {
 \r
 **/\r
 typedef struct {\r
 \r
 **/\r
 typedef struct {\r

-       UINT64                                                                                  MonotonicCount;\r
-       WIN_CERTIFICATE_UEFI_GUID       AuthInfo;\r
+  UINT64                      MonotonicCount;\r
+  WIN_CERTIFICATE_UEFI_GUID   AuthInfo;\r

 } EFI_VARIABLE_AUTHENTICATION;\r
 \r
 #endif\r
 } EFI_VARIABLE_AUTHENTICATION;\r
 \r
 #endif\r