1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/** @file
This file contains function definitions that can determine
the TXT capabilities of a platform during DXE and perform
certain specific platform tasks that are required for TXT
during DXE.
@copyright
Copyright (c) 1999 - 2012 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains an 'Intel Peripheral Driver' and uniquely
identified as "Intel Reference Module" and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef _TXT_DXE_LIB_H_
#define _TXT_DXE_LIB_H_
#include EFI_PROTOCOL_DEFINITION (MpService)
#include "CpuAccess.h"
#include EFI_PROTOCOL_DEFINITION (BootScriptSave)
#include EFI_PROTOCOL_DEFINITION (CpuIo)
#include EFI_GUID_DEFINITION (TxtInfoHob)
#include EFI_PROTOCOL_DEFINITION (CpuPlatformPolicy)
///
/// The following switch is used in EfiScriptLib.h file. If enabled -
/// forces linking to EfiScriptLib library
///
#define BASE_ADDR_MASK 0xFFFFF000
#define TEST_PATTERN 0x5A5A5A5A5A5A5A5A
#define MP_TIMEOUT_FOR_STARTUP_ALL_APS 0 ///< Set 0 for BSP always wait for APs
///
/// Chispet register
///
#define TXT_OPT_IN_VMX_AND_SMX_MSR_VALUE 0xFF03
#define IA32_MTRR_PHYSBASE0 0x200
#define IA32_MTRR_PHYSMASK9 0x213
#define LOCAL_APIC_THERMAL_DEF 0x330
#define B_INTERRUPT_MASK (1 << 16)
#define B_DELIVERY_MODE (0x07 << 8)
#define V_MODE_SMI (0x02 << 8)
#define B_VECTOR (0xFF << 0)
#pragma pack(push, 1)
typedef struct _TXT_DXE_LIB_CONTEXT_ {
EFI_HANDLE ImageHandle;
EFI_SYSTEM_TABLE *SystemTable;
EFI_CPU_IO_PROTOCOL *CpuIo;
EFI_MP_SERVICES_PROTOCOL *MpService;
UINTN CpuCount;
TXT_INFO_DATA *TxtInfoData;
DXE_CPU_PLATFORM_POLICY_PROTOCOL *CpuPlatformPolicy;
} TXT_DXE_LIB_CONTEXT;
#pragma pack(pop)
/**
This routine initializes and collects all Protocols and data required
by the routines in this file.
@param[in] ImageHandle - A pointer to the Image Handle for this file.
@param[in] SystemTable - A pointer to the EFI System Table
@param[in] TxtDxeCtx - A pointer to a caller allocated data structure that contains
all of the Protocols and data required by the routines
in this file.
@retval EFI_SUCCESS - Return EFI_SUCCESS if no error happen
@retval EFI_UNLOAD_IMAGE - If TxtInfoHob is not found
**/
EFI_STATUS
InitializeTxtDxeLib (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable,
IN OUT TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Determines whether or not the current processor is TXT Capable.
@retval TRUE - If the current processor supports TXT
@retval FALSE - If the current processor does not support TXT
**/
BOOLEAN
IsTxtProcessor (
VOID
);
/**
Determines whether or not the platform has executed an TXT launch by
examining the TPM Establishment bit.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval TRUE - If the TPM establishment bit is asserted.
@retval FALSE - If the TPM establishment bit is unasserted.
**/
BOOLEAN
IsTxtEstablished (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Determines whether or not the platform has executed an TXT launch by
examining the TPM Establishment bit.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval TRUE - If the TPM establishment bit is asserted.
@retval FALSE - If the TPM establishment bit is unasserted.
**/
BOOLEAN
IsTxtResetSet (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Determines whether or not the platform requires initialization for TXT use.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval TRUE - If the the platoform should be configured for TXT.
@retval FALSE - If TXT is not to be used.
**/
BOOLEAN
IsTxtEnabled (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Adds and allocates architecturally defined TXT Configuration Space memory
region to GCD.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - Always.
**/
EFI_STATUS
ReserveTxtConfigSpace (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Allocates 1 MB of 1MB-aligned memory for use as TXT Device Memory. Records
the location of TXT Device Memory in TXT Chipset registers and then adds
programming instructions for these registers into BootScript.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - TXT Device memory has been successfully initialized.
@retval EFI_ERROR - TXT Device memory not awailable.
**/
EFI_STATUS
SetupTxtDeviceMemory (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Invokes TxtDxeLibLaunchBiosAcm to execute the SCHECK function.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - Always.
**/
EFI_STATUS
DoScheck (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Invokes TxtDxeLibLaunchBiosAcm to reset the TPM's establishment bit.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - Always.
**/
EFI_STATUS
ResetTpmEstBit (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
/**
Sets up the system and then launches the TXT BIOS ACM to run the function
requested by AcmFunction.
@param[in] AcmBase - Base address of BIOS ACM location
@param[in] Funct - Function number of BIOS ACM to be executed
@retval EFI_SUCCESS - Always.
**/
VOID
LaunchBiosAcm (
IN UINT64 AcmBase,
IN UINT64 Funct
);
/**
Sets up the system and then launches the TXT BIOS ACM to run the function
requested by AcmFunction.
@param[in] AcmFunction - Constant that represents the function from the BIOS ACM
that should be executed.
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - Always.
**/
EFI_STATUS
TxtDxeLibLaunchBiosAcm (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx,
IN UINT64 AcmFunction
);
/**
AP initial routine executed through MP service for TXT SCHECK
**/
VOID
DoApInit (
VOID
);
/**
Save AP configuration routine executed through MP service for TXT SCHECK
**/
VOID
ApSaveConfig (
VOID
);
/**
Restore AP configuration routine executed through MP service for TXT SCHECK
**/
VOID
ApRestoreConfig (
VOID
);
/**
Disable or restore possible SMI sources before or after POST SCHECK
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@param[in] Operation - Boolean value telling what operation is requested:
TRUE - to save and then disable possible SMI sources
FALSE - to restore original SMI settings
@retval EFI_SUCCESS - always return EFI_SUCCESS
**/
EFI_STATUS
DisableSmiSources (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx,
IN BOOLEAN Operation
);
/**
This function gets called before/after run the SCHECK function, intend to avoid platform specific SMIs to interfere in BIOS POST
if BIOS SMM MP services or synchonization code is not well considered that some of APs are not waken up from Wait-for-SIPI state.
Function should preserve original SMI enabling setting in augument is TRUE, and then restore it in augurment is FALSE.
The caller is DisableSmiSources() in TxtDxeLib.c
@param[in] Operation = TRUE - Calling before SCHECK to saved and disable platform specific SMIs setting
= FALSE - Calling after SCHECK to restore platform specific SMIs setting
@retval EFI_SUCCESS - Always.
**/
extern
EFI_STATUS
EFIAPI
TxtDxeOemDisableSmi (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx,
IN BOOLEAN Operation
);
/**
Read policy protocol to reset AUX content
@param[in] TxtDxeCtx - A pointer to an initialized TXT DXE Context data structure
@retval EFI_SUCCESS - No error happend
@retval EFI_NOT_FOUND - TxtPolicyProtocol is not found
**/
EFI_STATUS
ResetTpmAux (
IN TXT_DXE_LIB_CONTEXT *TxtDxeCtx
);
#endif
|
