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
|
/** @file
Processes ASF messages
@copyright
Copyright (c) 2010 - 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 _ALERT_STANDARD_FORMAT_PEI_H
#define _ALERT_STANDARD_FORMAT_PEI_H
#include "AmtLibPei.h"
#include "MkhiMsgs.h"
#include "AlertStandardFormatCommon.h"
//
// Driver Consumed Protocol Prototypes
//
#include EFI_PPI_CONSUMER (HECI)
#include EFI_PPI_PRODUCER (AmtStatusCode)
#include EFI_GUID_DEFINITION (MeBiosExtensionSetup)
#include EFI_GUID_DEFINITION (AmtForcePushPetPolicy)
///
/// ASF Over HECI
///
#pragma pack(1)
typedef struct {
UINT8 SubCommand;
UINT8 Version;
UINT8 EventSensorType;
UINT8 EventType;
UINT8 EventOffset;
UINT8 EventSourceType;
UINT8 EventSeverity;
UINT8 SensorDevice;
UINT8 SensorNumber;
UINT8 Entity;
UINT8 EntityInstance;
UINT8 Data0;
UINT8 Data1;
} EFI_ASF_MESSAGE;
#pragma pack()
typedef struct _HECI_ASF_PUSH_PROGRESS_CODE {
UINT8 Command;
UINT8 ByteCount;
EFI_ASF_MESSAGE AsfMessage;
UINT8 EventData[3];
UINT8 Reserved[2];
} HECI_ASF_PUSH_PROGRESS_CODE;
#define HECI_ASF_PUSH_PROGRESS_CODE_LENGTH 0x12
typedef enum _HASFM_COMMAND_CODE
{
ASF_MESSAGING_CMD = 0x04,
ASF_PUSH_PROGESS_CODE_SUBCMD = 0x12,
ASF_MENAGEMENT_CONTROL = 0x02,
ASF_WDT_START_SUBCMD = 0x13,
ASF_WDT_STOP_SUBCMD = 0x14,
ASF_CONFIGURATION_CMD = 0x03,
ASF_CLEAR_BOOT_OPTION_SUBCMD = 0x15,
ASF_RETURN_BOOT_OPTION_SUBCMD = 0x16,
ASF_NO_BOOT_OPTION_SUBCMD = 0x17
} HASFM_COMMAND_CODE;
typedef struct {
EFI_FRAMEWORK_MESSAGE_TYPE MessageType;
EFI_ASF_MESSAGE Message;
} EFI_ASF_FRAMEWORK_MESSAGE;
typedef struct {
EFI_FRAMEWORK_MESSAGE_TYPE MessageType;
EFI_STATUS_CODE_VALUE StatusCodeValue;
} EFI_ASF_DATA_HUB_MAP;
//
// Prototypes
//
/**
Send ASF Message.
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] AsfMessage Pointer to ASF message
@retval EFI_SUCCESS Boot options copied
@retval EFI_INVALID_PARAMETER Invalid pointer
@retval EFI_NOT_READY No controller
@retval EFI_DEVICE_ERROR The function should not be completed due to a device error
**/
EFI_STATUS
SendAsfMessage (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_ASF_MESSAGE *AsfMessage
)
;
/**
Provides an interface that a software module can call to report an ASF PEI status code.
@param[in] PeiServices PeiServices pointer.
@param[in] This This interface.
@param[in] Type 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.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
**/
EFI_STATUS
EFIAPI
PeiAmtReportStatusCode (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_AMT_STATUS_CODE_PPI * This,
IN EFI_STATUS_CODE_TYPE Type,
IN EFI_STATUS_CODE_VALUE Value,
IN UINT32 Instance,
IN EFI_GUID * CallerId OPTIONAL,
IN EFI_STATUS_CODE_DATA * Data OPTIONAL
)
;
/**
Sends a POST packet across ASF
@param[in] PeiServices General purpose services available to every PEIM.
@param[in] MessageType POST Status Code
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
SendPostPacket (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_FRAMEWORK_MESSAGE_TYPE MessageType
)
;
/**
This routine saves current ForcePush ErrorEvent to Hob, which will be sent again.
@param[in] PeiServices PeiServices pointer.
@param[in] MessageType ASF PET message type.
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
SaveForcePushErrorEvent (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_FRAMEWORK_MESSAGE_TYPE MessageType
)
;
/**
This routine puts PET message to MessageQueue, which will be sent later.
@param[in] PeiServices PeiServices pointer.
@param[in] Type StatusCode message type.
@param[in] Value StatusCode message value.
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
QueuePetMessage (
IN EFI_PEI_SERVICES **PeiServices,
IN EFI_STATUS_CODE_TYPE Type,
IN EFI_STATUS_CODE_VALUE Value
)
;
/**
This routine sends PET message in MessageQueue.
@param[in] PeiServices PeiServices pointer.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_NOT_READY No controller
**/
EFI_STATUS
SendPETMessageInQueue (
IN EFI_PEI_SERVICES **PeiServices
)
;
#endif
|
