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
|
/** @file
MCA/PMI/INIT Protocol as defined in PI Specification VOLUME 4.
This protocol provides services to handle Machine Checks (MCA),
Initialization (INIT) events, and Platform Management Interrupt (PMI) events
on an Intel Itanium Processor Family based system.
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __MCA_INIT_PMI_PROTOCOL_H__
#define __MCA_INIT_PMI_PROTOCOL_H__
///
/// Global ID for the MCA/PMI/INIT Protocol.
///
#define EFI_SAL_MCA_INIT_PMI_PROTOCOL_GUID \
{ 0xb60dc6e8, 0x3b6f, 0x11d5, {0xaf, 0x9, 0x0, 0xa0, 0xc9, 0x44, 0xa0, 0x5b} }
///
/// Declare forward reference for the Timer Architectural Protocol
///
typedef struct _EFI_SAL_MCA_INIT_PMI_PROTOCOL EFI_SAL_MCA_INIT_PMI_PROTOCOL;
#pragma pack(1)
///
/// MCA Records Structure
///
typedef struct {
UINT64 First : 1;
UINT64 Last : 1;
UINT64 EntryCount : 16;
UINT64 DispatchedCount : 16;
UINT64 Reserved : 30;
} SAL_MCA_COUNT_STRUCTURE;
#pragma pack()
/**
Prototype of MCA handler.
@param ModuleGlobal The context of MCA Handler
@param ProcessorStateParameters The processor state parameters (PSP)
@param MinstateBase Base address of the min-state
@param RendezvouseStateInformation Rendezvous state information to be passed to
the OS on OS MCA entry
@param CpuIndex Index of the logical processor
@param McaCountStructure Pointer to the MCA records structure
@param CorrectedMachineCheck This flag is set to TRUE is the MCA has been
corrected by the handler or by a previous handler
@retval EFI_SUCCESS Handler successfully returned
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_MCA_HANDLER)(
IN VOID *ModuleGlobal,
IN UINT64 ProcessorStateParameters,
IN EFI_PHYSICAL_ADDRESS MinstateBase,
IN UINT64 RendezvouseStateInformation,
IN UINT64 CpuIndex,
IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure,
OUT BOOLEAN *CorrectedMachineCheck
);
/**
Prototype of INIT handler.
@param ModuleGlobal The context of INIT Handler
@param ProcessorStateParameters The processor state parameters (PSP)
@param MinstateBase Base address of the min-state
@param McaInProgress This flag indicates if an MCA is in progress
@param CpuIndex Index of the logical processor
@param McaCountStructure Pointer to the MCA records structure
@param DumpSwitchPressed This flag indicates the crash dump switch has been pressed
@retval EFI_SUCCESS Handler successfully returned
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_INIT_HANDLER)(
IN VOID *ModuleGlobal,
IN UINT64 ProcessorStateParameters,
IN EFI_PHYSICAL_ADDRESS MinstateBase,
IN BOOLEAN McaInProgress,
IN UINT64 CpuIndex,
IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure,
OUT BOOLEAN *DumpSwitchPressed
);
/**
Prototype of PMI handler
@param ModuleGlobal The context of PMI Handler
@param CpuIndex Index of the logical processor
@param PmiVector The PMI vector number as received from the PALE_PMI exit state (GR24)
@retval EFI_SUCCESS Handler successfully returned
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_PMI_HANDLER)(
IN VOID *ModuleGlobal,
IN UINT64 CpuIndex,
IN UINT64 PmiVector
);
/**
Register a MCA handler with the MCA dispatcher.
@param This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
@param McaHandler The MCA handler to register
@param ModuleGlobal The context of MCA Handler
@param MakeFirst This flag specifies the handler should be made first in the list
@param MakeLast This flag specifies the handler should be made last in the list
@retval EFI_SUCCESS MCA Handle was registered
@retval EFI_OUT_OF_RESOURCES No more resources to register an MCA handler
@retval EFI_INVALID_PARAMETER Invalid parameters were passed
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_REGISTER_MCA_HANDLER)(
IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This,
IN EFI_SAL_MCA_HANDLER McaHandler,
IN VOID *ModuleGlobal,
IN BOOLEAN MakeFirst,
IN BOOLEAN MakeLast
);
/**
Register an INIT handler with the INIT dispatcher.
@param This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
@param InitHandler The INIT handler to register
@param ModuleGlobal The context of INIT Handler
@param MakeFirst This flag specifies the handler should be made first in the list
@param MakeLast This flag specifies the handler should be made last in the list
@retval EFI_SUCCESS INIT Handle was registered
@retval EFI_OUT_OF_RESOURCES No more resources to register an INIT handler
@retval EFI_INVALID_PARAMETER Invalid parameters were passed
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_REGISTER_INIT_HANDLER)(
IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This,
IN EFI_SAL_INIT_HANDLER InitHandler,
IN VOID *ModuleGlobal,
IN BOOLEAN MakeFirst,
IN BOOLEAN MakeLast
);
/**
Register a PMI handler with the PMI dispatcher.
@param This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
@param PmiHandler The PMI handler to register
@param ModuleGlobal The context of PMI Handler
@param MakeFirst This flag specifies the handler should be made first in the list
@param MakeLast This flag specifies the handler should be made last in the list
@retval EFI_SUCCESS PMI Handle was registered
@retval EFI_OUT_OF_RESOURCES No more resources to register an PMI handler
@retval EFI_INVALID_PARAMETER Invalid parameters were passed
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SAL_REGISTER_PMI_HANDLER)(
IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This,
IN EFI_SAL_PMI_HANDLER PmiHandler,
IN VOID *ModuleGlobal,
IN BOOLEAN MakeFirst,
IN BOOLEAN MakeLast
);
///
/// This protocol is used to register MCA, INIT and PMI handlers with their respective dispatcher
///
struct _EFI_SAL_MCA_INIT_PMI_PROTOCOL {
EFI_SAL_REGISTER_MCA_HANDLER RegisterMcaHandler;
EFI_SAL_REGISTER_INIT_HANDLER RegisterInitHandler;
EFI_SAL_REGISTER_PMI_HANDLER RegisterPmiHandler;
BOOLEAN McaInProgress; ///< Whether MCA handler is in progress
BOOLEAN InitInProgress; ///< Whether Init handler is in progress
BOOLEAN PmiInProgress; ///< Whether Pmi handler is in progress
};
extern EFI_GUID gEfiSalMcaInitPmiProtocolGuid;
#endif
|
