1 /** @file
2   The header file for Tcg2 SMM driver.
3 
4 Copyright (c) 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 __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/Tpm2DeviceLib.h>
39 #include <Library/Tcg2PhysicalPresenceLib.h>
40 
41 #pragma pack(1)
42 typedef struct {
43   UINT8                  SoftwareSmi;
44   UINT32                 Parameter;
45   UINT32                 Response;
46   UINT32                 Request;
47   UINT32                 RequestParameter;
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 MOR
77 //
78 #define ACPI_FUNCTION_DSM_MEMORY_CLEAR_INTERFACE                   1
79 #define ACPI_FUNCTION_PTS_CLEAR_MOR_BIT                            2
80 
81 //
82 // The return code for Memory Clear Interface Functions
83 //
84 #define MOR_REQUEST_SUCCESS                                        0
85 #define MOR_REQUEST_GENERAL_FAILURE                                1
86 
87 #endif  // __TCG_SMM_H__
88