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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
|
/** @file
Header file for Heci Message functionality
@copyright
Copyright (c) 2006 - 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 _HECI_MESSAGE_LIB_H_
#define _HECI_MESSAGE_LIB_H_
#include "CoreBiosMsg.h"
#include EFI_PROTOCOL_DEFINITION (HECI)
#include EFI_PROTOCOL_DEFINITION (PlatformMeHook)
#include EFI_PROTOCOL_DEFINITION (MePlatformPolicy)
//
// Reset Request Origin Codes.
//
#define PEI_HECI_REQ_ORIGIN_BIOS_MEMORY_INIT 0x01
#define PEI_HECI_REQ_ORIGIN_BIOS_POST 0x02
#define PEI_HECI_REQ_ORIGIN_AMTBX_LAN_DISABLE 0x03
//
// End of Post Codes
//
#define HECI_EOP_STATUS_SUCCESS 0x0
#define HECI_EOP_PERFORM_GLOBAL_RESET 0x1
#define MAX_EOP_SEND_RETRIES 0x2
//
// IFR Update states
//
#define IFR_UPDATE_ENABLE 1
#define IFR_UPDATE_DISABLE 0
#define EFI_ME_FW_SKU_VARIABLE_GUID \
{ \
0xe1a21d94, 0x4a20, 0x4e0e, 0xae, 0x9, 0xa9, 0xa2, 0x1f, 0x24, 0xbb, 0x9e \
}
//
// Heci Bus Disable defines
//
#define HECI_BUS_DISABLE_OPCODE 0x0C
#define HECI_BUS_DISABLE_ACK_OPCODE 0x8C
#define ME_HECI_FIXED_ADDRESS 0x0
//
// Defines the HECI request buffer format for the ICC_MPHY_WRITE_SETTINGS_CMD.
//
typedef struct _ICC_MPHY_WRITE_SETTINGS_REQ
{
ICC_HEADER Header; // Standard ICC HECI Header
UINT32 Reserved : 4; // Reserved for future use
UINT32 PostedWrite : 1; // 0-Response returned, 1-No Response returned
UINT32 Reserved2 : 23; // Reserved for future use
}MPHY_WRITE_SETTINGS_REQ;
typedef union _HBM_COMMAND {
UINT8 Data;
struct {
UINT8 Command : 7;
UINT8 IsResponse : 1;
} Fields;
} HBM_COMMAND;
typedef struct _HECI_BUS_DISABLE_CMD {
HBM_COMMAND Command;
UINT8 Reserved[3];
} HECI_BUS_DISABLE_CMD;
typedef struct _HECI_BUS_DISABLE_CMD_ACK {
HBM_COMMAND Command;
UINT8 Status;
UINT8 Reserved[2];
} HECI_BUS_DISABLE_CMD_ACK;
typedef struct {
UINT32 MeEnabled : 1; ///< [0] ME enabled/Disabled
UINT32 Reserved : 2; ///< [2:1] Reserved, must set to 0
UINT32 IntelAmtFw : 1; ///< [3] Intel AMT FW support
UINT32 IntelAmtFwStandard : 1; ///< [4] Intel AMT Standard FW support
UINT32 IntelSmallBusiness : 1; ///< [5] Intel Small Business Technology support
UINT32 Reserved1 : 7; ///< [12:6] Reserved
UINT32 AtSupported : 1; ///< [13] AT Support
UINT32 IntelKVM : 1; ///< [14] Intel KVM supported
UINT32 LocalWakeupTimer : 1; ///< [15] Local Wakeup Timer support
UINT32 Reserved2 : 16; ///< [31:16] Reserved, must set to 0
UINT32 MeMinorVer : 16; ///< [47:32] ME FW Minor Version.
UINT32 MeMajorVer : 16; ///< [63:48] ME FW Major Version.
UINT32 MeBuildNo : 16; ///< [79:64] ME FW Build Number.
UINT32 MeHotFixNo : 16; ///< [95:80] ME FW Hotfix Number
} ME_CAP;
#define MAX_ASSET_TABLE_ALLOCATED_SIZE 0x3000
#define HECI_HWA_CLIENT_ID 11
#define HWA_TABLE_PUSH_CMD 0
#pragma pack(1)
typedef enum _HWAI_TABLE_TYPE_INDEX
{
HWAI_TABLE_TYPE_INDEX_FRU_DEVICE = 0,
HWAI_TABLE_TYPE_INDEX_MEDIA_DEVICE,
HWAI_TABLE_TYPE_INDEX_SMBIOS,
HWAI_TABLE_TYPE_INDEX_ASF,
HWAI_TABLE_TYPE_INDEX_MAX = 4,
} HWAI_TABLE_TYPE_INDEX;
typedef struct _SINGLE_TABLE_POSITION {
UINT16 Offset;
UINT16 Length;
} SINGLE_TABLE_POSITION;
typedef struct _TABLE_PUSH_DATA {
SINGLE_TABLE_POSITION Tables[HWAI_TABLE_TYPE_INDEX_MAX];
UINT8 TableData[1];
} TABLE_PUSH_DATA;
typedef union {
UINT32 Data;
struct {
UINT32 MessageLength : 16;
UINT32 Command : 4; ///< only supported command would be HWA_TABLE_PUSH=0;
UINT32 FRUTablePresent : 1;
UINT32 MediaTablePresent : 1;
UINT32 SMBIOSTablePresent : 1;
UINT32 ASFTablePresent : 1;
UINT32 Reserved : 8;
} Fields;
} AU_MESSAGE_HEADER;
typedef struct _AU_TABLE_PUSH_MSG {
AU_MESSAGE_HEADER Header;
TABLE_PUSH_DATA Data;
} AU_TABLE_PUSH_MSG;
typedef enum {
SEV_NO_ERROR = 0,
SEV_LOW_ERROR,
SEV_HIGH_ERROR,
SEV_CRITICAL_ERROR
} MDES_SEVERITY_LEVEL;
typedef enum {
EFI_STATUS_CODE = 1,
RAW_BUFFER,
ASCII_DATA,
} MDES_BIOS_PAYLOAD_TYPE;
#pragma pack()
/**
Send the required system ChipsetInit Table to ME FW.
@param[in] ChipsetInitTable The required system ChipsetInit Table.
@param[in] ChipsetInitTableLen Length of the table in bytes
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciChipsetInitSyncMsg (
IN UINT8 *ChipsetInitTable,
IN UINT32 ChipsetInitTableLen
)
;
/**
Send Core BIOS Reset Request Message through HECI to reset the system.
@param[in] ResetOrigin Reset source
@param[in] ResetType Global or Host reset
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciSendCbmResetRequest (
IN UINT8 ResetOrigin,
IN UINT8 ResetType
)
;
/**
Send Hardware Asset Tables to Firmware
@param[in] Handle A handle for this module
@param[in] AssetTableData Hardware Asset Table Data
@param[in] TableDataSize Size of Asset table
@retval EFI_SUCCESS Table sent
@retval EFI_ABORTED Could not allocate Memory
**/
EFI_STATUS
HeciAssetUpdateFwMsg (
IN EFI_HANDLE Handle,
IN TABLE_PUSH_DATA *AssetTableData,
IN UINT16 TableDataSize
)
;
/**
Send End of Post Request Message through HECI.
@param[in] Handle A handle for this module
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciSendEndOfPostMessage (
IN EFI_HANDLE Handle
)
;
/**
Send Get Firmware SKU Request to ME
@param[in] MsgGenGetFwCapsSku Return message for Get Firmware Capability SKU
@param[in] MsgGenGetFwCapsSkuAck Return message for Get Firmware Capability SKU ACK
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetFwCapsSkuMsg (
IN OUT GEN_GET_FW_CAPSKU *MsgGenGetFwCapsSku,
IN OUT GEN_GET_FW_CAPS_SKU_ACK *MsgGenGetFwCapsSkuAck
)
;
/**
Send Get Firmware Version Request to ME
@param[in][out] MsgGenGetFwVersionAck Return themessage of FW version
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetFwVersionMsg (
IN OUT GEN_GET_FW_VER_ACK *MsgGenGetFwVersionAck
)
;
/**
Sends a message to ME to unlock a specified SPI Flash region for writing and receiving a response message.
It is recommended that HMRFPO_ENABLE MEI message needs to be sent after all OROMs finish their initialization.
@param[in] Nonce Nonce received in previous HMRFPO_ENABLE Response Message
@param[in] Result HMRFPO_ENABLE response
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciHmrfpoEnable (
IN UINT64 Nonce,
OUT UINT8 *Result
)
;
/**
Sends a message to ME to lock a specified SPI Flash region for writing and receiving a response message.
@param[out] Nonce Random number generated by Ignition ME FW. When BIOS
want to unlock region it should use this value
in HMRFPO_ENABLE Request Message
@param[out] FactoryDefaultBase The base of the factory default calculated from the start of the ME region.
BIOS sets a Protected Range (PR) register "Protected Range Base" field with this value
+ the base address of the region.
@param[out] FactoryDefaultLimit The length of the factory image.
BIOS sets a Protected Range (PR) register "Protected Range Limit" field with this value
@param[out] Result Status report
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciHmrfpoLock (
OUT UINT64 *Nonce,
OUT UINT32 *FactoryDefaultBase,
OUT UINT32 *FactoryDefaultLimit,
OUT UINT8 *Result
)
;
/**
System BIOS sends this message to get status for HMRFPO_LOCK message.
@param[out] Result HMRFPO_GET_STATUS response
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
**/
EFI_STATUS
HeciHmrfpoGetStatus (
OUT UINT8 *Result
)
;
/**
This is used to send KVM request message to Intel ME. When
Bootoptions indicate that a KVM session is requested then BIOS
will send this message before any graphical display output to
ensure that FW is ready for KVM session.
@param[in] QueryType 0 - Query Request
1 - Cancel Request
@param[out] ResponseCode 1h - Continue, KVM session established.
2h - Continue, KVM session cancelled.
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciQueryKvmRequest (
IN UINT32 QueryType,
OUT UINT32 *ResponseCode
)
;
/**
This message is sent by the BIOS or IntelR MEBX prior to the End of Post (EOP) on the boot
where host wants to query the local firmware update interface status.
@param[out] RuleData 1 - local firmware update interface enable
0 - local firmware update interface disable
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetLocalFwUpdate (
OUT UINT8 *RuleData
)
;
/**
This message is sent by the BIOS or IntelR MEBX prior to the End of Post (EOP) on the boot
where host wants to enable or disable the local firmware update interface.
The firmware allows a single update once it receives the enable command
@param[in] RuleData 1 - local firmware update interface enable
0 - local firmware update interface disable
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciSetLocalFwUpdate (
IN UINT8 RuleData
)
;
/**
This message is sent by the BIOS or IntelR MEBX prior to the End of Post (EOP)
on the boot where host wants to enable the ME State. The firmware allows a single
update once it receives the enable command. Once firmware receives this message,
the firmware will be in normal mode after a global reset.
@param[in] None
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS ME enabled message sent
**/
EFI_STATUS
HeciSetMeEnableMsg (
VOID
)
;
/**
This message is sent by the BIOS or IntelR MEBX prior to the End of Post (EOP)
on the boot where host wants to disable the ME State. The firmware allows a single
update once it receives the disable command Once firmware receives this message,
the firmware will work in "Soft Temporary Disable" mode (HFS[19:16] = 3) after a
global reset. Note, this message is not allowed when AT firmware is enrolled/configured.
@param[in] None
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS ME is disabled
**/
EFI_STATUS
HeciSetMeDisableMsg (
VOID
)
;
/**
This message is sent by the BIOS or IntelR MEBX prior to the End of Post (EOP)
on the boot where host wants to get Ibex Peak platform type.
One of usages is to utilize this command to determine if the platform runs in
1.5M or 5M size firmware.
@param[in] RuleData PlatformBrand,
IntelMeFwImageType,
SuperSku,
PlatformTargetMarketType,
PlatformTargetUsageType
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetPlatformTypeMsg (
OUT PLATFORM_TYPE_RULE_DATA *RuleData
)
;
/**
This message is sent by the BIOS on the boot where the host wants to get the firmware provisioning state.
The firmware will respond to AMT BIOS SYNCH INFO message even after the End of Post.
@param[out] RuleData Bit [2:0] Reserved
Bit [4:3] Provisioning State
00 - Pre -provisioning
01 - In -provisioning
02 - Post !Vprovisioning
Bit [31:5] Reserved
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Firmware provisioning state returned
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciAmtBiosSynchInfo (
OUT UINT32 *RuleData
)
;
/**
The firmware will respond to GET OEM TAG message even after the End of Post (EOP).
@param[in] RuleData Default is zero. Tool can create the OEM specific OEM TAG data.
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetOemTagMsg (
OUT UINT32 *RuleData
)
;
/**
Enables/disables clocks. Used to turn off clocks in unused pci/pcie slots.
BIOS use this command when it enumerates PCI slots. When PCI slot is found unpopulated, the
BIOS can disable its clock through this MEI message. It is the BIOS requirement to know which
slot is controlled by which control bit.
@param[in] Enables each bit means corresponding clock should be turned on (1) or off (0)
@param[in] EnablesMask each bit means corresponding enable bit is valid (1) or should be ignored (0)
@param[in] ResponseMode 0 wait for response, 1 - skip
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_DEVICE_ERROR Wrong response
@retval EFI_NOT_READY ME is not ready
@retval EFI_INVALID_PARAMETER ResponseMode is invalid value
@retval EFI_SUCCESS The function completed successfully.
**/
EFI_STATUS
EFIAPI
HeciSetIccClockEnables (
IN UINT32 Enables,
IN UINT32 EnablesMask,
IN UINT8 ResponseMode
)
;
/**
Sets or reads Lock mask on ICC registers.
@param[in] AccessMode 0 - set, 1 - get
@param[in] ResponseMode 0 - firmware will answer, 1 - firmware will not answer
@param[in][out] LockRegInfo bundle count info and mask of registers to become (for 'set' mode) or are
(for 'get' mode) locked. Each bit represents a register. 0=lock, 1=don't lock
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_INVALID_PARAMETER ResponseMode or pointer of Mask is invalid value
@retval EFI_DEVICE_ERROR Wrong response
@retval EFI_NOT_READY Heci device hasn't ready yet
**/
EFI_STATUS
HeciLockIccRegisters (
IN UINT8 AccessMode,
IN UINT8 ResponseMode,
IN OUT ICC_LOCK_REGS_INFO *LockRegInfo
)
;
/**
retrieves the number of currently used ICC clock profile
@param[out] Profile number of current ICC clock profile
@exception EFI_UNSUPPORTED ICC clock profile doesn't support
@retval EFI_NOT_READY Heci device hasn't ready yet
**/
EFI_STATUS
HeciGetIccProfile (
OUT UINT8 *Profile
)
;
/**
Sets ICC clock profile to be used on next and following boots
@param[in] Profile number of profile to be used
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_DEVICE_ERROR Wrong response
@retval EFI_NOT_READY Heci device hasn't ready yet
**/
EFI_STATUS
HeciSetIccProfile (
IN UINT8 Profile
)
;
/**
Writes 1 dword of data to the icc register offset specified by RegOffset in the ICC Aux space
@param[in] RegOffset Register Offset in ICC Aux Space to write
@param[in] RegData Dword ICC register data to write
@param[in] ResponseMode 0 Wait for response, 1 - skip
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_DEVICE_ERROR Wrong response
@retval EFI_NOT_READY ME is not ready
@retval EFI_INVALID_PARAMETER ResponseMode is invalid value
@retval EFI_SUCCESS The function completed successfully.
**/
EFI_STATUS
EFIAPI
HeciWriteIccRegDword (
IN UINT16 RegOffset,
IN UINT32 RegData,
IN UINT8 ResponseMode
)
;
/**
This message is used to turn on the Intel ME firmware MDES
capability, Intel SVT for PCH capability or both when the
system is in a post-manufactured state. Once firmware receives
this message, the firmware will enable selected platform debug
capabilities . The firmware will automatically disable all
platform debug capabilities if this message is not received
before receiving End Of Post.
@param[in] Data capabilities to be enabled
@param[out] Result 0x00 : Enable Success
Others : Enable Failure
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciPlatformDebugCapabilityMsg (
IN PLATFORM_DEBUG_CAP Data,
OUT UINT8 *Result
)
;
/**
It creates and sends Heci messages.
Remark:
Functionality is available only in release mode.
Using MDES in debug mode causes recursive calling of this function
because debug messages are sending from Heci->SendMsg function.
@param[in] CodeType Indicates the type of status code being reported.
@param[in] Value Describes the current status of a hardware or software entity.
This included information about the class and subclass that is
used to classify the entity as well as an operation.
@param[in] Instance The enumeration of a hardware or software entity within
the system. Valid instance numbers start with 1.
@param[in] CallerId This optional parameter may be used to identify the caller.
This parameter allows the status code driver to apply different
rules to different callers.
@param[in] Data This optional parameter may be used to pass additional data.
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Opcode evaluation success.
@retval Other Opcode evaluation failed.
**/
EFI_STATUS
HeciSendMdesStatusCode (
IN EFI_STATUS_CODE_TYPE CodeType,
IN EFI_STATUS_CODE_VALUE Value,
IN UINT32 Instance,
IN EFI_GUID * CallerId OPTIONAL,
IN EFI_STATUS_CODE_DATA * Data OPTIONAL
)
;
/**
Provides an interface to call function to send HECI message.
@param[in] Flags Indicates the status of the BIOS MDES.
@param[in] BiosEventFilters Indicates the status of the BIOS event filter group.
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS HECI sent with success.
**/
EFI_STATUS
HeciGetMdesConfig (
OUT MDES_BIOS_FLAGS *Flags,
OUT UINT32 *BiosEventFilters
)
;
/**
Sends the MKHI Enable/Disable manageability message.
The message will only work if bit 2 in the bitmasks is toggled.
To enable manageability:
EnableState = 0x00000004, and
DisableState = 0x00000000.
To disable manageability:
EnableState = 0x00000000, and
DisableState = 0x00000004
@param[in] EnableState Enable Bit Mask
@param[in] DisableState Disable Bit Mask
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciFwFeatureStateOverride (
IN UINT32 EnableState,
IN UINT32 DisableState
)
;
/**
The Get FW Feature Status message is based on MKHI interface.
This command is used by BIOS/IntelR MEBX to get firmware runtime status.
The GET FW RUNTIME STATUS message doesn't need to check the HFS.
FWInitComplete value before sending the command.
It means this message can be sent regardless of HFS.FWInitComplete.
@param[out] RuleData MEFWCAPS_SKU message
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
**/
EFI_STATUS
HeciGetFwFeatureStateMsg (
OUT MEFWCAPS_SKU *RuleData
)
;
/**
This message is sent by the BIOS when it wants to query
the independent firmware recovery (IFR).
@param[in] RuleData 1 - local firmware update interface enable
0 - local firmware update interface disable
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciGetIfrUpdate (
OUT UINT8 *RuleData
)
;
/**
This message is sent by the BIOS when it wants to set
the independent firmware recovery (IFR) state.
@param[in] RuleData 1 - local firmware update interface enable
0 - local firmware update interface disable
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS Command succeeded
@retval EFI_DEVICE_ERROR HECI Device error, command aborts abnormally
@retval EFI_TIMEOUT HECI does not return the buffer before timeout
@retval EFI_BUFFER_TOO_SMALL Message Buffer is too smallfor the Acknowledge
**/
EFI_STATUS
HeciSetIfrUpdate (
IN UINT8 RuleData
)
;
/**
This message is sent by the BIOS if EOP-ACK not received to force ME to disable
HECI interfaces.
@param[in] None
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS HECI interfaces disabled by ME
**/
EFI_STATUS
HeciDisableHeciBusMsg (
VOID
)
;
/**
This message is sent by the BIOS to inform ME FW whether or not to take the
TPM 1.2 Deactivate flow
@param[in] UINT8 TpmDeactivate 0 - ME FW should not take the
deactivate flow.
1 - ME FW should take the deactivate
flow.
@exception EFI_UNSUPPORTED Current ME mode doesn't support this function
@retval EFI_SUCCESS HECI interfaces disabled by ME
**/
EFI_STATUS
HeciSendTpmData (
IN UINT8 TpmDeactivate
)
;
#endif
|