SecurityPkg/Tcg/TcgSmm/TcgSmm.h

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