MdePkg/Include/Uefi/UefiTcgPlatform.h

   1 /** @file
   2   TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  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_TCG_PLATFORM_H__
  16 #define __UEFI_TCG_PLATFOMR_H__
  17
  18 #include <IndustryStandard/Tpm12.h>
  19
  20 #include <Uefi.h>
  21
  22 //
  23 // Standard event types
  24 //
  25 #define EV_POST_CODE                ((TCG_EVENTTYPE) 0x00000001)
  26 #define EV_SEPARATOR                ((TCG_EVENTTYPE) 0x00000004)
  27 #define EV_S_CRTM_CONTENTS          ((TCG_EVENTTYPE) 0x00000007)
  28 #define EV_S_CRTM_VERSION           ((TCG_EVENTTYPE) 0x00000008)
  29
  30 //
  31 // EFI specific event types
  32 //
  33 #define EV_EFI_EVENT_BASE                   ((TCG_EVENTTYPE) 0x80000000)
  34 #define EV_EFI_VARIABLE_DRIVER_CONFIG       (EV_EFI_EVENT_BASE + 1)
  35 #define EV_EFI_VARIABLE_BOOT                (EV_EFI_EVENT_BASE + 2)
  36 #define EV_EFI_BOOT_SERVICES_APPLICATION    (EV_EFI_EVENT_BASE + 3)
  37 #define EV_EFI_BOOT_SERVICES_DRIVER         (EV_EFI_EVENT_BASE + 4)
  38 #define EV_EFI_RUNTIME_SERVICES_DRIVER      (EV_EFI_EVENT_BASE + 5)
  39 #define EV_EFI_GPT_EVENT                    (EV_EFI_EVENT_BASE + 6)
  40 #define EV_EFI_ACTION                       (EV_EFI_EVENT_BASE + 7)
  41 #define EV_EFI_PLATFORM_FIRMWARE_BLOB       (EV_EFI_EVENT_BASE + 8)
  42 #define EV_EFI_HANDOFF_TABLES               (EV_EFI_EVENT_BASE + 9)
  43
  44 #define EFI_CALLING_EFI_APPLICATION         \
  45   "Calling EFI Application from Boot Option"
  46 #define EFI_RETURNING_FROM_EFI_APPLICATOIN  \
  47   "Returning from EFI Application from Boot Option"
  48 #define EFI_EXIT_BOOT_SERVICES_INVOCATION   \
  49   "Exit Boot Services Invocation"
  50 #define EFI_EXIT_BOOT_SERVICES_FAILED       \
  51   "Exit Boot Services Returned with Failure"
  52 #define EFI_EXIT_BOOT_SERVICES_SUCCEEDED    \
  53   "Exit Boot Services Returned with Success"
  54
  55 //
  56 // Set structure alignment to 1-byte
  57 //
  58 #pragma pack (1)
  59
  60 typedef UINT32                     TCG_EVENTTYPE;
  61
  62 #define TCG_DIGEST                 TPM_DIGEST
  63 #define TCG_PCRINDEX               TPM_PCRINDEX
  64
  65 ///
  66 /// Event Log Entry Structure Definition
  67 ///
  68 typedef struct tdTCG_PCR_EVENT {
  69   TCG_PCRINDEX                      PCRIndex;  ///< PCRIndex event extended to
  70   TCG_EVENTTYPE                     EventType; ///< TCG EFI event type
  71   TCG_DIGEST                        Digest;    ///< Value extended into PCRIndex
  72   UINT32                            EventSize; ///< Size of the event data
  73   UINT8                             Event[1];  ///< The event data
  74 } TCG_PCR_EVENT;
  75
  76 #define TSS_EVENT_DATA_MAX_SIZE   256
  77
  78 ///
  79 /// TCG_PCR_EVENT_HDR
  80 ///
  81 typedef struct tdTCG_PCR_EVENT_HDR {
  82   TCG_PCRINDEX                      PCRIndex;
  83   TCG_EVENTTYPE                     EventType;
  84   TCG_DIGEST                        Digest;
  85   UINT32                            EventSize;
  86 } TCG_PCR_EVENT_HDR;
  87
  88 ///
  89 /// EFI_PLATFORM_FIRMWARE_BLOB
  90 ///
  91 /// BlobLength should be of type UINTN but we use UINT64 here
  92 /// because PEI is 32-bit while DXE is 64-bit on x64 platforms
  93 ///
  94 typedef struct tdEFI_PLATFORM_FIRMWARE_BLOB {
  95   EFI_PHYSICAL_ADDRESS              BlobBase;
  96   UINT64                            BlobLength;
  97 } EFI_PLATFORM_FIRMWARE_BLOB;
  98
  99 ///
 100 /// EFI_IMAGE_LOAD_EVENT
 101 ///
 102 /// This structure is used in EV_EFI_BOOT_SERVICES_APPLICATION,
 103 /// EV_EFI_BOOT_SERVICES_DRIVER and EV_EFI_RUNTIME_SERVICES_DRIVER
 104 ///
 105 typedef struct tdEFI_IMAGE_LOAD_EVENT {
 106   EFI_PHYSICAL_ADDRESS              ImageLocationInMemory;
 107   UINTN                             ImageLengthInMemory;
 108   UINTN                             ImageLinkTimeAddress;
 109   UINTN                             LengthOfDevicePath;
 110   EFI_DEVICE_PATH_PROTOCOL          DevicePath[1];
 111 } EFI_IMAGE_LOAD_EVENT;
 112
 113 ///
 114 /// EFI_HANDOFF_TABLE_POINTERS
 115 ///
 116 /// This structure is used in EV_EFI_HANDOFF_TABLES event to facilitate
 117 /// the measurement of given configuration tables.
 118 ///
 119 typedef struct tdEFI_HANDOFF_TABLE_POINTERS {
 120   UINTN                             NumberOfTables;
 121   EFI_CONFIGURATION_TABLE           TableEntry[1];
 122 } EFI_HANDOFF_TABLE_POINTERS;
 123
 124 ///
 125 /// EFI_VARIABLE_DATA
 126 ///
 127 /// This structure serves as the header for measuring variables. The name of the
 128 /// variable (in Unicode format) should immediately follow, then the variable
 129 /// data.
 130 ///
 131 typedef struct tdEFI_VARIABLE_DATA {
 132   EFI_GUID                          VariableName;
 133   UINTN                             UnicodeNameLength;
 134   UINTN                             VariableDataLength;
 135   CHAR16                            UnicodeName[1];
 136   INT8                              VariableData[1];  ///< Driver or platform-specific data
 137 } EFI_VARIABLE_DATA;
 138
 139 typedef struct tdEFI_GPT_DATA {
 140   EFI_PARTITION_TABLE_HEADER  EfiPartitionHeader;
 141   UINTN                       NumberOfPartitions;
 142   EFI_PARTITION_ENTRY         Partitions[1];
 143 } EFI_GPT_DATA;
 144
 145 //
 146 // Restore original structure alignment
 147 //
 148 #pragma pack ()
 149
 150 #endif
 151
 152