MdePkg/Include/Uefi/UefiMultiPhase.h

   1 /** @file
   2   This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.
   3
   4 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials are licensed and made available under
   6 the terms and conditions of the BSD License that accompanies this distribution.
   7 The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php.
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __UEFI_MULTIPHASE_H__
  16 #define __UEFI_MULTIPHASE_H__
  17
  18 #include <Guid/WinCertificate.h>
  19 ///
  20 /// Enumeration of memory types introduced in UEFI.
  21 ///
  22 typedef enum {
  23   ///
  24   /// Not used.
  25   ///
  26   EfiReservedMemoryType,
  27   ///
  28   /// The code portions of a loaded application.
  29   /// (Note that UEFI OS loaders are UEFI applications.)
  30   ///
  31   EfiLoaderCode,
  32   ///
  33   /// The data portions of a loaded application and the default data allocation
  34   /// type used by an application to allocate pool memory.
  35   ///
  36   EfiLoaderData,
  37   ///
  38   /// The code portions of a loaded Boot Services Driver.
  39   ///
  40   EfiBootServicesCode,
  41   ///
  42   /// The data portions of a loaded Boot Serves Driver, and the default data
  43   /// allocation type used by a Boot Services Driver to allocate pool memory.
  44   ///
  45   EfiBootServicesData,
  46   ///
  47   /// The code portions of a loaded Runtime Services Driver.
  48   ///
  49   EfiRuntimeServicesCode,
  50   ///
  51   /// The data portions of a loaded Runtime Services Driver and the default
  52   /// data allocation type used by a Runtime Services Driver to allocate pool memory.
  53   ///
  54   EfiRuntimeServicesData,
  55   ///
  56   /// Free (unallocated) memory.
  57   ///
  58   EfiConventionalMemory,
  59   ///
  60   /// Memory in which errors have been detected.
  61   ///
  62   EfiUnusableMemory,
  63   ///
  64   /// Memory that holds the ACPI tables.
  65   ///
  66   EfiACPIReclaimMemory,
  67   ///
  68   /// Address space reserved for use by the firmware.
  69   ///
  70   EfiACPIMemoryNVS,
  71   ///
  72   /// Used by system firmware to request that a memory-mapped IO region
  73   /// be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.
  74   ///
  75   EfiMemoryMappedIO,
  76   ///
  77   /// System memory-mapped IO region that is used to translate memory
  78   /// cycles to IO cycles by the processor.
  79   ///
  80   EfiMemoryMappedIOPortSpace,
  81   ///
  82   /// Address space reserved by the firmware for code that is part of the processor.
  83   ///
  84   EfiPalCode,
  85   ///
  86   /// A memory region that operates as EfiConventionalMemory,
  87   /// however it happens to also support byte-addressable non-volatility.
  88   ///
  89   EfiPersistentMemory,
  90   EfiMaxMemoryType
  91 } EFI_MEMORY_TYPE;
  92
  93 ///
  94 /// Data structure that precedes all of the standard EFI table types.
  95 ///
  96 typedef struct {
  97   ///
  98   /// A 64-bit signature that identifies the type of table that follows.
  99   /// Unique signatures have been generated for the EFI System Table,
 100   /// the EFI Boot Services Table, and the EFI Runtime Services Table.
 101   ///
 102   UINT64  Signature;
 103   ///
 104   /// The revision of the EFI Specification to which this table
 105   /// conforms. The upper 16 bits of this field contain the major
 106   /// revision value, and the lower 16 bits contain the minor revision
 107   /// value. The minor revision values are limited to the range of 00..99.
 108   ///
 109   UINT32  Revision;
 110   ///
 111   /// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.
 112   ///
 113   UINT32  HeaderSize;
 114   ///
 115   /// The 32-bit CRC for the entire table. This value is computed by
 116   /// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.
 117   ///
 118   UINT32  CRC32;
 119   ///
 120   /// Reserved field that must be set to 0.
 121   ///
 122   UINT32  Reserved;
 123 } EFI_TABLE_HEADER;
 124
 125 ///
 126 /// Attributes of variable.
 127 ///
 128 #define EFI_VARIABLE_NON_VOLATILE                            0x00000001
 129 #define EFI_VARIABLE_BOOTSERVICE_ACCESS                      0x00000002
 130 #define EFI_VARIABLE_RUNTIME_ACCESS                          0x00000004
 131 ///
 132 /// This attribute is identified by the mnemonic 'HR'
 133 /// elsewhere in this specification.
 134 ///
 135 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD                   0x00000008
 136 ///
 137 /// Attributes of Authenticated Variable
 138 ///
 139 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS              0x00000010
 140 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020
 141 #define EFI_VARIABLE_APPEND_WRITE                            0x00000040
 142
 143
 144 ///
 145 /// AuthInfo is a WIN_CERTIFICATE using the wCertificateType
 146 /// WIN_CERTIFICATE_UEFI_GUID and the CertType
 147 /// EFI_CERT_TYPE_RSA2048_SHA256_GUID. If the attribute specifies
 148 /// authenticated access, then the Data buffer should begin with an
 149 /// authentication descriptor prior to the data payload and DataSize
 150 /// should reflect the the data.and descriptor size. The caller
 151 /// shall digest the Monotonic Count value and the associated data
 152 /// for the variable update using the SHA-256 1-way hash algorithm.
 153 /// The ensuing the 32-byte digest will be signed using the private
 154 /// key associated w/ the public/private 2048-bit RSA key-pair. The
 155 /// WIN_CERTIFICATE shall be used to describe the signature of the
 156 /// Variable data *Data. In addition, the signature will also
 157 /// include the MonotonicCount value to guard against replay attacks.
 158 ///
 159 typedef struct {
 160   ///
 161   /// Included in the signature of
 162   /// AuthInfo.Used to ensure freshness/no
 163   /// replay. Incremented during each
 164   /// "Write" access.
 165   ///
 166   UINT64                      MonotonicCount;
 167   ///
 168   /// Provides the authorization for the variable
 169   /// access. It is a signature across the
 170   /// variable data and the  Monotonic Count
 171   /// value. Caller uses Private key that is
 172   /// associated with a public key that has been
 173   /// provisioned via the key exchange.
 174   ///
 175   WIN_CERTIFICATE_UEFI_GUID   AuthInfo;
 176 } EFI_VARIABLE_AUTHENTICATION;
 177
 178 ///
 179 /// When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is
 180 /// set, then the Data buffer shall begin with an instance of a complete (and serialized)
 181 /// EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new
 182 /// variable value and DataSize shall reflect the combined size of the descriptor and the new
 183 /// variable value. The authentication descriptor is not part of the variable data and is not
 184 /// returned by subsequent calls to GetVariable().
 185 ///
 186 typedef struct {
 187   ///
 188   /// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and
 189   /// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.
 190   ///
 191   EFI_TIME                    TimeStamp;
 192   ///
 193   /// Only a CertType of  EFI_CERT_TYPE_PKCS7_GUID is accepted.
 194   ///
 195   WIN_CERTIFICATE_UEFI_GUID   AuthInfo;
 196  } EFI_VARIABLE_AUTHENTICATION_2;
 197
 198 #endif