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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
/** @file
Definitions for HECI driver
@copyright
Copyright (c) 2006 - 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 _HECI_CORE_H
#define _HECI_CORE_H
#include "CoreBiosMsg.h"
//
// HECI bus function version
//
#define HBM_MINOR_VERSION 0
#define HBM_MAJOR_VERSION 1
//
// Prototypes
//
/**
Determines if the HECI device is present and, if present, initializes it for
use by the BIOS.
@param[in] None.
@retval EFI_SUCCESS HECI device is present and initialized.
@retval EFI_DEVICE_ERROR No HECI controller.
@exception EFI_UNSUPPORTED HECI MSG is unsupported because ME MODE is in ME ALT Disabled &
SECOVR JMPR
@retval EFI_TIMEOUT ME is not ready
**/
EFI_STATUS
InitializeHeciPrivate (
VOID
)
;
/**
Waits for the ME to report that it is ready for communication over the HECI
interface.
@param[in] None.
@retval EFI_SUCCESS ME is ready
@retval EFI_TIMEOUT ME is not ready
**/
EFI_STATUS
WaitForMEReady (
VOID
)
;
/**
Determines if the HECI device is present and, if present, initializes it for
use by the BIOS.
@param[in] None.
@retval EFI_SUCCESS HECI device is present and initialized
@retval EFI_TIMEOUT ME is not ready
**/
EFI_STATUS
EFIAPI
HeciInitialize (
VOID
)
;
/**
Heci Re-initializes it for Host
@param[in] None.
@retval EFI_TIMEOUT ME is not ready
@retval EFI_STATUS Status code returned by ResetHeciInterface
**/
EFI_STATUS
EFIAPI
HeciReInitialize (
VOID
)
;
/**
Heci Re-initializes it for Me
@param[in] None.
@retval EFI_TIMEOUT ME is not ready
@retval EFI_SUCCESS Re-initialization done
**/
EFI_STATUS
EFIAPI
HeciReInitialize2 (
VOID
)
;
/**
Function to pull one messsage packet off the HECI circular buffer.
Corresponds to HECI HPS (part of) section 4.2.4
@param[in] Blocking Used to determine if the read is BLOCKING or NON_BLOCKING.
@param[out] MessageHeader Pointer to a buffer for the message header.
@param[in] MessageData Pointer to a buffer to recieve the message in.
@param[in][out] Length On input is the size of the callers buffer in bytes. On
output this is the size of the packet in bytes.
@retval EFI_SUCCESS One message packet read.
@retval EFI_DEVICE_ERROR The circular buffer is overflowed.
@retval EFI_NO_RESPONSE The circular buffer is empty
@retval EFI_TIMEOUT Failed to receive a full message
@retval EFI_BUFFER_TOO_SMALL Message packet is larger than caller's buffer
**/
EFI_STATUS
HECIPacketRead (
IN UINT32 Blocking,
OUT HECI_MESSAGE_HEADER *MessageHeader,
OUT UINT32 *MessageData,
IN OUT UINT32 *Length
)
;
/**
Reads a message from the ME across HECI.
@param[in] Blocking Used to determine if the read is BLOCKING or NON_BLOCKING.
@param[in][out] MessageBody Pointer to a buffer used to receive a message.
@param[in][out] Length Pointer to the length of the buffer on input and the length
of the message on return. (in bytes)
@retval EFI_SUCCESS One message packet read.
@retval EFI_DEVICE_ERROR Failed to initialize HECI or zero-length message packet read
@retval EFI_TIMEOUT HECI is not ready for communication
@retval EFI_BUFFER_TOO_SMALL The caller's buffer was not large enough
**/
EFI_STATUS
EFIAPI
HeciReceive (
IN UINT32 Blocking,
IN OUT UINT32 *MessageBody,
IN OUT UINT32 *Length
)
;
/**
Function sends one messsage (of any length) through the HECI circular buffer.
@param[in] Message Pointer to the message data to be sent.
@param[in] Length Length of the message in bytes.
@param[in] HostAddress The address of the host processor.
@param[in] MeAddress Address of the ME subsystem the message is being sent to.
@retval EFI_SUCCESS One message packet sent.
@retval EFI_DEVICE_ERROR Failed to initialize HECI
@retval EFI_TIMEOUT HECI is not ready for communication
@exception EFI_UNSUPPORTED Current ME mode doesn't support send message through HECI
**/
EFI_STATUS
EFIAPI
HeciSend (
IN UINT32 *Message,
IN UINT32 Length,
IN UINT8 HostAddress,
IN UINT8 MeAddress
)
;
/**
Function sends one messsage packet through the HECI circular buffer
Corresponds to HECI HPS (part of) section 4.2.3
@param[in] MessageHeader Pointer to the message header.
@param[in] MessageData Pointer to the actual message data.
@retval EFI_SUCCESS One message packet sent
@retval EFI_DEVICE_ERROR ME is not ready
@retval EFI_TIMEOUT HECI is not ready for communication
**/
EFI_STATUS
HeciPacketWrite (
IN HECI_MESSAGE_HEADER *MessageHeader,
IN UINT32 *MessageData
)
;
/**
Function sends one messsage through the HECI circular buffer and waits
for the corresponding ACK message.
@param[in][out] Message Pointer to the message buffer.
@param[in] Length Length of the message in bytes.
@param[in][out] RecLength Length of the message response in bytes.
@param[in] HostAddress Address of the sending entity.
@param[in] MeAddress Address of the ME entity that should receive the message.
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the bufferbefore timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too small for the Acknowledge
@exception EFI_UNSUPPORTED Current ME mode doesn't support send message through HECI
**/
EFI_STATUS
EFIAPI
HeciSendwACK (
IN OUT UINT32 *Message,
IN UINT32 Length,
IN OUT UINT32 *RecLength,
IN UINT8 HostAddress,
IN UINT8 MeAddress
)
;
/**
Me reset and waiting for ready
@param[in] Delay The biggest waiting time
@retval EFI_TIMEOUT ME is not ready
@retval EFI_SUCCESS Me is ready
**/
EFI_STATUS
EFIAPI
MeResetWait (
IN UINT32 Delay
)
;
/**
Function forces a reinit of the heci interface by following the reset heci interface via host algorithm
in HPS 0.90 doc 4-17-06 njy
@param[in] none
@retval EFI_TIMEOUT ME is not ready
@retval EFI_SUCCESS Interface reset
**/
EFI_STATUS
EFIAPI
ResetHeciInterface (
VOID
)
;
/**
Calculate if the circular buffer has overflowed.
Corresponds to HECI HPS (part of) section 4.2.1
@param[in] ReadPointer Location of the read pointer.
@param[in] WritePointer Location of the write pointer.
@retval Number of filled slots.
**/
UINT8
FilledSlots (
IN UINT32 ReadPointer,
IN UINT32 WritePointer
)
;
/**
Calculate if the circular buffer has overflowed
Corresponds to HECI HPS (part of) section 4.2.1
@param[in] ReadPointer Value read from host/me read pointer
@param[in] WritePointer Value read from host/me write pointer
@param[in] BufferDepth Value read from buffer depth register
@retval EFI_DEVICE_ERROR The circular buffer has overflowed
@retval EFI_SUCCESS The circular buffer does not overflowed
**/
EFI_STATUS
OverflowCB (
IN UINT32 ReadPointer,
IN UINT32 WritePointer,
IN UINT32 BufferDepth
)
;
/**
Get an abstract Intel ME State from Firmware Status Register.
This is used to control BIOS flow for different Intel ME
functions
@param[out] MeStatus Pointer for status report
see MeState.h - Abstract ME status definitions.
@retval EFI_SUCCESS MeStatus copied
@retval EFI_INVALID_PARAMETER Pointer of MeStatus is invalid
**/
EFI_STATUS
EFIAPI
HeciGetMeStatus (
OUT UINT32 *MeStatus
)
;
/**
Return ME Mode
@param[out] MeMode Pointer for ME Mode report
@retval EFI_SUCCESS MeMode copied
@retval EFI_INVALID_PARAMETER Pointer of MeMode is invalid
**/
EFI_STATUS
EFIAPI
HeciGetMeMode (
OUT UINT32 *MeMode
)
;
/**
This function provides a standard way to verify the HECI cmd and MBAR regs
in its PCI cfg space are setup properly and that the local mHeciContext
variable matches this info.
@param[in] None.
@retval UINT64 HeciMar address
**/
UINT64
CheckAndFixHeciForAccess (
VOID
)
;
#endif // _HECI_CORE_H
|
