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
|
/** @file
Platform Trust Technology (FTPM) HCI Device Library
@copyright
Copyright (c) 2012 -2013 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 _TPM2_PTT_HCI_DEVICE_LIB_H_
#define _TPM2_PTT_HCI_DEVICE_LIB_H_
#include <Efi.h>
///
/// Default Timeout values
///
#define PTT_HCI_TIMEOUT_A 500 ///< 500 microseconds
// AMI-Core Override for PTT +
//#define PTT_HCI_TIMEOUT_B 10 * 1000 ///< 10ms (max command processing time in PK-TPM ca. 3ms)
#define PTT_HCI_TIMEOUT_B 500 * 1000 ///< 10ms (max command processing time in PK-TPM ca. 3ms)
// AMI-Core Override for PTT -
#define PTT_HCI_TIMEOUT_C 1000 * 1000 ///< 1s
#define PTT_HCI_TIMEOUT_D 500 * 1000 ///< 500 ms
#define PTT_HCI_POLLING_PERIOD 140 ///< Poll register every 140 microsecondss
/// TPM2_RESPONSE_HEADER size (10B) aligned to dword
#define PTT_HCI_RESPONSE_HEADER_SIZE 12 ///< 12B
/**
Checks whether FTPM is enabled (FTPM_STS::FTPM_EN).
@retval TRUE FTPM is enabled.
@retval FALSE FTPM is disabled. All LT writes will be dropped.
All LT reads will be returned with read data value of all 0’s.
The bit can only be written once per ME power cycle.
**/
BOOLEAN
EFIAPI
PttHciPresenceCheck (
VOID
);
/**
Checks whether TPM2_Startup command has been executed (FTPM_STS::STARTUP_EXEC).
If command was executed, it should not be redundantly issued again.
@retval TRUE Startup command executed already.
@retval FALSE Startup command not executed yet.
**/
BOOLEAN
EFIAPI
PttHciStartupExecuted (
VOID
);
/**
Sets FTPM_CMD and CA_START register to a defined value to indicate that a command is
available for processing.
Any host write to this register shall result in an interrupt to the ME firmware.
@retval EFI_SUCCESS Register successfully written.
@retval TBD
**/
EFI_STATUS
EFIAPI
PttHciRequestCommandExec (
VOID
);
/**
Checks whether the value of a FTPM register satisfies the input BIT setting.
@param[in] Register Address port of register to be checked.
@param[in] BitSet Check these data bits are set.
@param[in] BitClear Check these data bits are clear.
@param[in] TimeOut The max wait time (unit MicroSecond) when checking register.
@retval EFI_SUCCESS The register satisfies the check bit.
@retval EFI_TIMEOUT The register can't run into the expected status in time.
**/
EFI_STATUS
EFIAPI
PttHciWaitRegisterBits(
IN EFI_PHYSICAL_ADDRESS RegAddress,
IN UINT32 BitSet,
IN UINT32 BitClear,
IN UINT32 TimeOut
);
/**
Sends command to FTPM for execution.
@param[in] FtpmBuffer Buffer for TPM command data.
@param[in] DataLength TPM command data length.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_TIMEOUT The register can't run into the expected status in time.
**/
EFI_STATUS
EFIAPI
PttHciSend(
IN UINT8 *FtpmBuffer,
IN UINT32 DataLength
);
/**
Receives response data of last command from FTPM.
@param[out] FtpmBuffer Buffer for response data.
@param[out] RespSize Response data length.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_TIMEOUT The register can't run into the expected status in time.
@retval EFI_DEVICE_ERROR Unexpected device status.
@retval EFI_BUFFER_TOO_SMALL Response data is too long.
**/
EFI_STATUS
EFIAPI
PttHciReceive(
OUT UINT8 *FtpmBuffer,
OUT UINT32 *RespSize
);
/**
Sends formatted command to FTPM for execution and returns formatted response data.
@param[in] InputBuffer Buffer for the input data.
@param[in] InputBufferSize Size of the input buffer.
@param[out] ReturnBuffer Buffer for the output data.
@param[out] ReturnBufferSize Size of the output buffer.
@retval EFI_SUCCESS Operation completed successfully.
@retval EFI_TIMEOUT The register can't run into the expected status in time.
**/
EFI_STATUS
EFIAPI
PttHciSubmitCommand(
IN UINT8 *InputBuffer,
IN UINT32 InputBufferSize,
OUT UINT8 *ReturnBuffer,
OUT UINT32 *ReturnBufferSize
);
/**
Checks whether PTT is Ready
@retval TRUE PTT is ready.
@retval FALSE PTT is not ready
**/
BOOLEAN
EFIAPI
PttHciReadyCheck (
VOID
);
#endif
|
