SecurityPkg/Tcg/TcgSmm/TcgSmm.h

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