SecurityPkg/Tcg/TrEESmm/TrEESmm.h

   1 /** @file
   2   The header file for TrEE SMM driver.
   3
   4 Copyright (c) 2013 - 2015, 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 __TREE_SMM_H__
  16 #define __TREE_SMM_H__
  17
  18 #include <PiDxe.h>
  19 #include <IndustryStandard/Acpi.h>
  20 #include <IndustryStandard/Tpm2Acpi.h>
  21
  22 #include <Guid/TrEEPhysicalPresenceData.h>
  23 #include <Guid/MemoryOverwriteControl.h>
  24 #include <Guid/TpmInstance.h>
  25
  26 #include <Protocol/SmmSwDispatch2.h>
  27 #include <Protocol/AcpiTable.h>
  28 #include <Protocol/SmmVariable.h>
  29 #include <Protocol/TrEEProtocol.h>
  30
  31 #include <Library/BaseLib.h>
  32 #include <Library/BaseMemoryLib.h>
  33 #include <Library/DebugLib.h>
  34 #include <Library/SmmServicesTableLib.h>
  35 #include <Library/UefiDriverEntryPoint.h>
  36 #include <Library/UefiBootServicesTableLib.h>
  37 #include <Library/DxeServicesLib.h>
  38 #include <Library/TpmMeasurementLib.h>
  39 #include <Library/Tpm2DeviceLib.h>
  40 #include <Library/TrEEPpVendorLib.h>
  41
  42 #pragma pack(1)
  43 typedef struct {
  44   UINT8                  SoftwareSmi;
  45   UINT32                 Parameter;
  46   UINT32                 Response;
  47   UINT32                 Request;
  48   UINT32                 LastRequest;
  49   UINT32                 ReturnCode;
  50 } PHYSICAL_PRESENCE_NVS;
  51
  52 typedef struct {
  53   UINT8                  SoftwareSmi;
  54   UINT32                 Parameter;
  55   UINT32                 Request;
  56   UINT32                 ReturnCode;
  57 } MEMORY_CLEAR_NVS;
  58
  59 typedef struct {
  60   PHYSICAL_PRESENCE_NVS  PhysicalPresence;
  61   MEMORY_CLEAR_NVS       MemoryClear;
  62 } TCG_NVS;
  63
  64 typedef struct {
  65   UINT8                  OpRegionOp;
  66   UINT32                 NameString;
  67   UINT8                  RegionSpace;
  68   UINT8                  DWordPrefix;
  69   UINT32                 RegionOffset;
  70   UINT8                  BytePrefix;
  71   UINT8                  RegionLen;
  72 } AML_OP_REGION_32_8;
  73 #pragma pack()
  74
  75 //
  76 // The definition for TCG physical presence ACPI function
  77 //
  78 #define ACPI_FUNCTION_GET_PHYSICAL_PRESENCE_INTERFACE_VERSION      1
  79 #define ACPI_FUNCTION_SUBMIT_REQUEST_TO_BIOS                       2
  80 #define ACPI_FUNCTION_GET_PENDING_REQUEST_BY_OS                    3
  81 #define ACPI_FUNCTION_GET_PLATFORM_ACTION_TO_TRANSITION_TO_BIOS    4
  82 #define ACPI_FUNCTION_RETURN_REQUEST_RESPONSE_TO_OS                5
  83 #define ACPI_FUNCTION_SUBMIT_PREFERRED_USER_LANGUAGE               6
  84 #define ACPI_FUNCTION_SUBMIT_REQUEST_TO_BIOS_2                     7
  85 #define ACPI_FUNCTION_GET_USER_CONFIRMATION_STATUS_FOR_REQUEST     8
  86
  87 //
  88 // The return code for Return TPM Operation Response to OS Environment
  89 //
  90 #define PP_RETURN_TPM_OPERATION_RESPONSE_SUCCESS                   0
  91 #define PP_RETURN_TPM_OPERATION_RESPONSE_FAILURE                   1
  92
  93 //
  94 // The definition for TCG MOR
  95 //
  96 #define ACPI_FUNCTION_DSM_MEMORY_CLEAR_INTERFACE                   1
  97 #define ACPI_FUNCTION_PTS_CLEAR_MOR_BIT                            2
  98
  99 //
 100 // The return code for Memory Clear Interface Functions
 101 //
 102 #define MOR_REQUEST_SUCCESS                                        0
 103 #define MOR_REQUEST_GENERAL_FAILURE                                1
 104
 105 #endif  // __TCG_SMM_H__