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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
/** @file
Framework PEIM to provide Heci.
@copyright
Copyright (c) 2008 - 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_INIT_H_
#define _HECI_INIT_H_
#include "EdkIIGluePeim.h"
#include "MeAccess.h"
#include "HeciRegs.h"
#include "MeState.h"
#include "CoreBiosMsg.h"
#include "Pci22.h"
//
// Driver Consumed PPI Prototypes
//
#include EFI_PPI_DEPENDENCY (CpuIo)
#include EFI_PPI_DEPENDENCY (PciCfg)
#include EFI_PPI_DEPENDENCY (Heci)
#include EFI_PPI_DEPENDENCY (MemoryDiscovered)
//
// Prototypes
//
/**
Enable Hpet function.
@param[in] PeiServices General purpose services available to every PEIM.
@retval UINT32 Return the High Precision Event Timer base address
**/
VOLATILE
UINT32 *
EnableHpet (
IN EFI_PEI_SERVICES **PeiServices
)
;
/**
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] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI
@param[in][out] HeciMemBar HECI Memory BAR
@retval None
**/
VOID
CheckAndFixHeciForAccess (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN OUT UINT32 *HeciMemBar
)
;
/**
Determines if the HECI device is present and, if present, initializes it for
use by the BIOS.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI
@param[in][out] HeciMemBar HECI Memory BAR
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_DEVICE_ERROR No HECI device
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@exception EFI_UNSUPPORTED HECI MSG is unsupported
**/
EFI_STATUS
EFIAPI
InitializeHeci (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN OUT UINT32 *HeciMemBar
)
;
/**
Waits for the ME to report that it is ready for communication over the HECI
interface.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI.
@param[in] HeciMemBar HECI Memory BAR.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_TIMEOUT If 5 second timeout has expired, return fail.
**/
EFI_STATUS
WaitForMEReady (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN UINT32 HeciMemBar
)
;
/**
Read the HECI Message from Intel ME with size in Length into
buffer Message. Set Blocking to BLOCKING and code will wait
until one message packet is received. When set to
NON_BLOCKING, if the circular buffer is empty at the time, the
code not wait for the message packet read.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI.
@param[in] HeciMemBar HECI Memory BAR.
@param[in] Blocking Used to determine if the read is BLOCKING or NON_BLOCKING.
@param[in] 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)
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS One message packet read
@retval EFI_TIMEOUT HECI is not ready for communication
@retval EFI_DEVICE_ERROR Zero-length message packet read
@retval EFI_BUFFER_TOO_SMALL The caller's buffer was not large enough
**/
EFI_STATUS
EFIAPI
HeciReadMsg (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN UINT32 Blocking,
IN UINT32 HeciMemBar,
IN UINT32 *MessageBody,
IN OUT UINT32 *Length
)
;
/**
Function to pull one messsage packet off the HECI circular buffer.
Corresponds to HECI HPS (part of) section 4.2.4
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] HeciMemBar HECI Memory BAR.
@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[out] 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 EFI_PEI_SERVICES **PeiServices,
IN UINT32 Blocking,
IN UINT32 HeciMemBar,
OUT HECI_MESSAGE_HEADER *MessageHeader,
OUT UINT32 *MessageData,
IN OUT UINT32 *Length
)
;
/**
Function sends one messsage (of any length) through the HECI circular buffer.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI.
@param[in] HeciMemBar HECI Memory BAR.
@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 HEC
**/
EFI_STATUS
HeciSendMsg (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN UINT32 *Message,
IN UINT32 HeciMemBar,
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] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI.
@param[in] HeciMemBar HECI Memory BAR.
@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 EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN UINT32 HeciMemBar,
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] PeiServices General purpose services available to every PEIM.
@param[in] This The address of HECI PPI.
@param[in][out] Message Pointer to the message buffer.
@param[in] HeciMemBar HECI Memory BAR.
@param[in][out] Length Length of the message 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
HeciSendwAck (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_HECI_PPI *This,
IN OUT UINT32 *Message,
IN UINT32 HeciMemBar,
IN OUT UINT32 *Length,
IN UINT8 HostAddress,
IN UINT8 MeAddress
)
;
/**
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
)
;
/**
Used for calculating timeouts
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] Start Snapshot of the HPET timer
@param[in] End Calculated time when timeout period will be done
@param[in] Time Timeout period in microseconds
@retval None
**/
VOLATILE
UINT32 *
StartTimer (
IN EFI_PEI_SERVICES **PeiServices,
OUT UINT32 *Start,
OUT UINT32 *End,
IN UINT32 Time
)
;
/**
Used to determine if a timeout has occured.
@param[in] Start Snapshot of the HPET timer when the timeout period started.
@param[in] End Calculated time when timeout period will be done.
@param[in] HpetTimer The value of High Precision Event Timer
@retval EFI_TIMEOUT Timeout occured.
@retval EFI_SUCCESS Not yet timed out
**/
EFI_STATUS
Timeout (
IN UINT32 Start,
IN UINT32 End,
IN VOLATILE UINT32 *HpetTimer
)
;
/**
Get an abstract Intel ME Status from Firmware Status Register.
This is used to control BIOS flow for different Intel ME
functions.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] 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 (
IN EFI_PEI_SERVICES **PeiServices,
IN UINT32 *MeStatus
)
;
/**
Get an abstract ME operation mode from firmware status
register. This is used to control BIOS flow for different
Intel ME functions.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] MeMode Pointer for ME Mode report,
see MeState.h - Abstract ME Mode definitions.
@retval EFI_SUCCESS MeMode copied
@retval EFI_INVALID_PARAMETER Pointer of MeMode is invalid
**/
EFI_STATUS
EFIAPI
HeciGetMeMode (
IN EFI_PEI_SERVICES **PeiServices,
IN UINT32 *MeMode
)
;
/**
Initialize ME after reset
@param[in] FfsHeader Not used.
@param[in] PeiServices General purpose services available to every PEIM.
@retval EFI_SUCCESS Heci initialization completed successfully.
@retval All other error conditions encountered result in an ASSERT.
**/
EFI_STATUS
PeimHeciInit (
IN EFI_FFS_FILE_HEADER *FfsHeader,
IN EFI_PEI_SERVICES **PeiServices
)
;
/**
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 UINT8 Number of filled slots.
**/
UINT8
FilledSlots (
IN UINT32 ReadPointer,
IN UINT32 WritePointer
)
;
#endif // _HECI_INIT_H_
|
