SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.h

   1 /** @file
   2   The header file for Tcg2 SMM driver.
   3
   4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
   5 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 __TCG2_SMM_H__
  16 #define __TCG2_SMM_H__
  17
  18 #include <PiDxe.h>
  19 #include <IndustryStandard/Acpi.h>
  20 #include <IndustryStandard/Tpm2Acpi.h>
  21
  22 #include <Guid/MemoryOverwriteControl.h>
  23 #include <Guid/TpmInstance.h>
  24
  25 #include <Protocol/SmmSwDispatch2.h>
  26 #include <Protocol/AcpiTable.h>
  27 #include <Protocol/SmmVariable.h>
  28 #include <Protocol/Tcg2Protocol.h>
  29
  30 #include <Library/BaseLib.h>
  31 #include <Library/BaseMemoryLib.h>
  32 #include <Library/DebugLib.h>
  33 #include <Library/SmmServicesTableLib.h>
  34 #include <Library/UefiDriverEntryPoint.h>
  35 #include <Library/UefiBootServicesTableLib.h>
  36 #include <Library/DxeServicesLib.h>
  37 #include <Library/TpmMeasurementLib.h>
  38 #include <Library/Tpm2CommandLib.h>
  39 #include <Library/Tcg2PhysicalPresenceLib.h>
  40 #include <Library/IoLib.h>
  41 #include <Library/PrintLib.h>
  42 #include <Library/PcdLib.h>
  43 #include <Library/Tpm2DeviceLib.h>
  44
  45 #include <IndustryStandard/TpmPtp.h>
  46
  47 #pragma pack(1)
  48 typedef struct {
  49   UINT8                  SoftwareSmi;
  50   UINT32                 Parameter;
  51   UINT32                 Response;
  52   UINT32                 Request;
  53   UINT32                 RequestParameter;
  54   UINT32                 LastRequest;
  55   UINT32                 ReturnCode;
  56 } PHYSICAL_PRESENCE_NVS;
  57
  58 typedef struct {
  59   UINT8                  SoftwareSmi;
  60   UINT32                 Parameter;
  61   UINT32                 Request;
  62   UINT32                 ReturnCode;
  63 } MEMORY_CLEAR_NVS;
  64
  65 typedef struct {
  66   PHYSICAL_PRESENCE_NVS  PhysicalPresence;
  67   MEMORY_CLEAR_NVS       MemoryClear;
  68   UINT32                 PPRequestUserConfirm;
  69   UINT32                 TpmIrqNum;
  70   BOOLEAN                IsShortFormPkgLength;
  71 } TCG_NVS;
  72
  73 typedef struct {
  74   UINT8                  OpRegionOp;
  75   UINT32                 NameString;
  76   UINT8                  RegionSpace;
  77   UINT8                  DWordPrefix;
  78   UINT32                 RegionOffset;
  79   UINT8                  BytePrefix;
  80   UINT8                  RegionLen;
  81 } AML_OP_REGION_32_8;
  82 #pragma pack()
  83
  84 //
  85 // The definition for TCG MOR
  86 //
  87 #define ACPI_FUNCTION_DSM_MEMORY_CLEAR_INTERFACE                   1
  88 #define ACPI_FUNCTION_PTS_CLEAR_MOR_BIT                            2
  89
  90 //
  91 // The return code for Memory Clear Interface Functions
  92 //
  93 #define MOR_REQUEST_SUCCESS                                        0
  94 #define MOR_REQUEST_GENERAL_FAILURE                                1
  95
  96 //
  97 // Physical Presence Interface Version supported by Platform
  98 //
  99 #define PHYSICAL_PRESENCE_VERSION_TAG                              "$PV"
 100 #define PHYSICAL_PRESENCE_VERSION_SIZE                             4
 101
 102 //
 103 // PNP _HID for TPM2 device
 104 //
 105 #define TPM_HID_TAG                                                "NNNN0000"
 106 #define TPM_HID_PNP_SIZE                                           8
 107 #define TPM_HID_ACPI_SIZE                                          9
 108
 109 #define TPM_PRS_RESL                                               "RESL"
 110 #define TPM_PRS_RESS                                               "RESS"
 111 #define TPM_PRS_RES_NAME_SIZE                                      4
 112 //
 113 // Minimum PRS resource template size
 114 //  1 byte    for  BufferOp
 115 //  1 byte    for  PkgLength
 116 //  2 bytes   for  BufferSize
 117 //  12 bytes  for  Memory32Fixed descriptor
 118 //  5 bytes   for  Interrupt descriptor
 119 //  2 bytes   for  END Tag
 120 //
 121 #define TPM_POS_RES_TEMPLATE_MIN_SIZE                              (1 + 1 + 2 + 12 + 5 + 2)
 122
 123 //
 124 // Max Interrupt buffer size for PRS interrupt resource
 125 // Now support 15 interrupts in maxmum
 126 //
 127 #define MAX_PRS_INT_BUF_SIZE                                       (15*4)
 128 #endif  // __TCG_SMM_H__