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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwas/common/hwasCallout.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,2014 */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __HWAS_HWASCALLOUT_H
#define __HWAS_HWASCALLOUT_H
/**
* @file hwasCallout.H
*
* HardWare Availability Service Callout prototypes.
*/
/******************************************************************************/
// Includes
/******************************************************************************/
#ifndef PARSER
#include <targeting/common/target.H>
#endif // not PARSER
namespace HWAS
{
// from hwsv/server/hwsvTypes.H:
// Legacy HOM deconfig enum
enum DeconfigEnum
{
NO_DECONFIG,
DECONFIG,
DELAYED_DECONFIG,
};
typedef enum {
GARD_NULL = 0x00,
GARD_User_Manual = 0xD2, //Manual Guard.
GARD_Unrecoverable = 0xE2, //TODO:RTC-76814
GARD_Fatal = 0xE3, //IPL Failures, and others.
GARD_Predictive = 0xE6, //Policy flag to disable.
GARD_Power = 0xE9, //Needed since EID is NOT passed in.
GARD_PHYP = 0xEA, //Needed since EID is NOT passed in.
GARD_Void = 0xFF
} GARD_ErrorType;
// from src/epub/fsp/epub_service_codes.H v1.24.24.4
// - Any additions should be added to FipS code first
/** @enum epubProcedureID
* This enumeration contains all the Procedures to be used with a callout
* in an SRC.
*/
enum epubProcedureID
{
EPUB_PRC_NONE = 0x00,
EPUB_PRC_FIND_DECONFIGURED_PART = 0x01,
EPUB_PRC_SP_CODE = 0x04,
EPUB_PRC_PHYP_CODE = 0x05,
EPUB_PRC_ALL_PROCS = 0x08,
EPUB_PRC_ALL_MEMCRDS = 0x09,
EPUB_PRC_INVALID_PART = 0x0A,
EPUB_PRC_LVL_SUPP = 0x10,
EPUB_PRC_PROCPATH = 0x16,
EPUB_PRC_NO_VPD_FOR_FRU = 0x1C,
EPUB_PRC_MEMORY_PLUGGING_ERROR = 0x22,
EPUB_PRC_FSI_PATH = 0x2D,
EPUB_PRC_PROC_AB_BUS = 0x30,
EPUB_PRC_PROC_XYZ_BUS = 0x31,
EPUB_PRC_MEMBUS_ERROR = 0x34,
EPUB_PRC_EIBUS_ERROR = 0x37,
EPUB_PRC_POWER_ERROR = 0x3F,
EPUB_PRC_PERFORMANCE_DEGRADED = 0x4D,
EPUB_PRC_HB_CODE = 0x55
};
// from srci/fsp/srci.H
enum callOutPriority
{
SRCI_PRIORITY_LOW = 1,
SRCI_PRIORITY_MEDC = 2,
SRCI_PRIORITY_MEDB = 3,
SRCI_PRIORITY_MEDA = 4,
SRCI_PRIORITY_MED = 5,
SRCI_PRIORITY_HIGH = 6
};
enum busTypeEnum
{
FSI_BUS_TYPE = 1,
DMI_BUS_TYPE = 2,
A_BUS_TYPE = 3,
X_BUS_TYPE = 4,
I2C_BUS_TYPE = 5,
PSI_BUS_TYPE = 6
};
enum clockTypeEnum
{
TODCLK_TYPE = 1,
MEMCLK_TYPE = 2,
OSCREFCLK_TYPE = 3,
OSCPCICLK_TYPE = 4,
};
//
const uint8_t HW_CALLOUT = 0x01;
const uint8_t PROCEDURE_CALLOUT = 0x02;
const uint8_t BUS_CALLOUT = 0x03;
const uint8_t CLOCK_CALLOUT = 0x04;
const uint8_t TARGET_IS_SENTINEL = 0xF0;
typedef struct callout_ud
{
uint8_t type;
uint8_t pad[3];
callOutPriority priority; // uint32_t
union {
struct { // type == HW_CALLOUT
DeconfigEnum deconfigState; // uint32_t
GARD_ErrorType gardErrorType; // uint32_t
uint32_t cpuid;
// one Target will follow
};
struct { // type == PROCEDURE_CALLOUT
epubProcedureID procedure; // uint32_t
};
struct { // type == BUS_CALLOUT
busTypeEnum busType; // uint32_t
// two Targets will follow
};
struct { // type == CLOCK_CALLOUT
clockTypeEnum clockType; // uint32_t
DeconfigEnum clkDeconfigState; // uint32_t
GARD_ErrorType clkGardErrorType; // uint32_t
// one Target will follow
};
};
} callout_ud_t;
#ifndef PARSER
/**
* @brief processCallout process the userdetail for a callout, calling
* the deconfigure and/or GARD funcationality as appropriate
*
* @param[in] io_errl Error log handle reference
* @param[in] i_pData Pointer to the callout bundle
* @param[in] i_Size size of the data in the callout bundle
* @param[in] i_DeferredOnly bool - true if ONLY check for defered deconfig
*
*/
void processCallout(errlHndl_t &io_errl,
uint8_t *i_pData,
uint64_t i_Size,
bool i_DeferredOnly = false);
// typedef for function pointer that the errlog class will use.
typedef bool (*processCalloutFn)(errlHndl_t &, uint8_t *, uint64_t, bool);
/**
* @brief platform specific code to handle a procedure callout that has been
* found in an errlog
*
* @param[in] io_errl reference to errlHndl for this errlog.
* @param[in] i_procedure Enum indicating which procedure to add to the
* error log
* @param[in] i_priority Enum indicating the priority of the callout
*
* @return errlHndl_t valid errlHndl_t handle if there was an error,
* NULL if no errors;
*/
errlHndl_t platHandleProcedureCallout(errlHndl_t &io_errl,
epubProcedureID i_procedure,
callOutPriority i_priority);
/**
* @brief platform specific code to handle a hardware callout that has been
* found in an errlog
*
* @param[in] i_pTarget target
* @param[in] i_priority Enum indicating the priority of the callout
* @param[in] i_deconfigState Enum indicating whether to deconfig or not
* @param[in] io_errl reference to errlHnld for this errlog
* @param[in] i_gardErrType Enum indicating the type of failure
*
* @return errlHndl_t valid errlHndl_t handle if there was an error,
* NULL if no errors;
*/
errlHndl_t platHandleHWCallout(
TARGETING::Target *i_pTarget,
callOutPriority i_priority,
DeconfigEnum i_deconfigState,
errlHndl_t &io_errl,
GARD_ErrorType i_gardErrorType);
/**
* @brief platform specific code to handle a bus callout that has been
* found in an errlog
*
* @param[in] i_pTarget1 target endpoint1
* @param[in] i_pTarget2 target endpoint2
* @param[in] i_busType bus type Enum
* @param[in] i_priority Enum indicating the priority of the callout
* @param[in] io_errl reference to errlHnld for this errlog
*
* @return errlHndl_t valid errlHndl_t handle if there was an error,
* NULL if no errors;
*/
errlHndl_t platHandleBusCallout(
TARGETING::Target *i_pTarget1,
TARGETING::Target *i_pTarget2,
busTypeEnum i_busType,
callOutPriority i_priority,
errlHndl_t &io_errl);
/**
* @brief platform specific code to handle a clock callout that has been
* found in an errlog
*
* @param[in] i_pTarget target
* @param[in] i_clockType Enum indicating which type of clock
* @param[in] i_priority Enum indicating the priority of the callout
* @param[in] io_errl reference to errlHnld for this errlog
* @param[in] i_deconfigState Enum indicating whether to deconfig or not
* @param[in] i_gardErrType Enum indicating the type of failure
*
* @return errlHndl_t valid errlHndl_t handle if there was an error,
* NULL if no errors;
*/
errlHndl_t platHandleClockCallout(
TARGETING::Target *i_pTarget,
clockTypeEnum i_clockType,
callOutPriority i_priority,
errlHndl_t &io_errl,
DeconfigEnum i_deconfigState = DECONFIG,
GARD_ErrorType i_gardErrorType = GARD_Fatal);
#endif // not PARSER
}; // end namespace
#endif
|
