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
|
/*
* @file sbe_sp_intf.H
*
* @brief This file contains the SP - SBE interface protocol common details
*/
#ifndef __SBEFW_SBE_SP_INTF_H
#define __SBEFW_SBE_SP_INTF_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* $Version: Conforms to SP-SBE Interface Spec v0.8e
*/
/*
* Constants for SBE FW major and minor number
*/
static const uint16_t SBE_FW_MAJOR_VERSION = 1;
static const uint16_t SBE_FW_MINOR_VERSION = 1;
/**
* @brief enums for SBE command classes
*
*/
enum sbeCommandClass
{
SBE_CMD_CLASS_UNKNOWN = 0,
SBE_CMD_CLASS_IPL_CONTROL = 0xA1,
SBE_CMD_CLASS_SCOM_ACCESS = 0xA2,
SBE_CMD_CLASS_RING_ACCESS = 0xA3,
SBE_CMD_CLASS_MEMORY_ACCESS = 0xA4,
SBE_CMD_CLASS_REGISTER_ACCESS = 0xA5,
SBE_CMD_CLASS_ARRAY_ACCESS = 0xA6,
SBE_CMD_CLASS_INSTRUCTION_CONTROL = 0xA7,
SBE_CMD_CLASS_GENERIC_MESSAGE = 0xA8,
SBE_CMD_CLASS_MPIPL_COMMANDS = 0xA9,
};
/**
* @brief enums for SBE Istep Control command class
*
*/
enum sbeIplControlCommands
{
SBE_CMD_EXECUTE_ISTEP = 0x01, /* Execute istep */
SBE_CMD_IS_SBE_IPL_DONE = 0x02, /* Check if SBE IPL Done */
};
/**
* @brief enums for SCOM Access Messages
*
*/
enum sbeScomAccessCommands
{
SBE_CMD_GETSCOM = 0x01, /* Get SCOM */
SBE_CMD_PUTSCOM = 0x02, /* Put SCOM */
SBE_CMD_MODIFYSCOM = 0x03, /* Modify SCOM */
SBE_CMD_PUTSCOM_MASK = 0x04, /* Put SCOM under mask */
SBE_CMD_MULTISCOM = 0x05, /* Execute Multi SCOM */
};
/**
* @brief enum for modify mode
*
*/
enum sbeChipOpModifyMode
{
SBE_MODIFY_MODE_OR = 0x01,
SBE_MODIFY_MODE_AND = 0x02,
SBE_MODIFY_MODE_XOR = 0x03,
};
/**
* @brief enums for Ring Access Messages
*
*/
enum sbeRingAccessCommands
{
SBE_CMD_GETRING = 0x01, /* Get Ring */
SBE_CMD_PUTRING = 0x02, /* Put Ring */
};
/**
* @brief enums for Memory Access Messages
*
*/
enum sbeMemoryAccesCommands
{
SBE_CMD_GETMEM = 0x01, /* Get Memory (Proc/PBA) */
SBE_CMD_PUTMEM = 0x02, /* Put Memory (Proc/PBA) */
SBE_CMD_GETSRAM = 0x03, /* Get Memory (SRAM) */
SBE_CMD_PUTSRAM = 0x04, /* Put Memory (SRAM) */
};
/**
* @brief enums for GPR/SPR/FPR Access Messages
*
*/
enum sbeRegisterAccessCommands
{
SBE_CMD_GETREG = 0x01, /* Get Register (GPR,SPR,FPR) */
SBE_CMD_PUTREG = 0x02, /* Put Register (GPR,SPR,FPR) */
};
/**
* @brief enums for Trace Array Access Messages
*
*/
enum sbeArrayAccessCommands
{
SBE_CMD_GET_FAST_ARRAY = 0x01, /* Get Fast Array */
SBE_CMD_GET_TRACE_ARRAY = 0x02, /* Get Trace Array */
SBE_CMD_CONTROL_TRACE_ARRAY = 0x03, /* Control Trace Array */
};
/**
* @brief enums for Instruction Control Messages
*
*/
enum sbeInstructionControlCommands
{
SBE_CMD_CONTROL_INSTRUCTIONS = 0x01, /* Control Instructions */
};
/**
* @brief enums for Generic Messages
*
*/
enum sbeGenericMessageCommands
{
SBE_CMD_GET_SBE_FFDC = 0x01, /* Get FFDC */
SBE_CMD_GET_SBE_CAPABILITIES = 0x02, /* GET SBE capabilities */
SBE_CMD_GET_FREQ_SUPPORTED = 0x03, /* Get Supported frequencies */
SBE_CMD_GET_SBE_STATE = 0x04, /* Get SBE State */
};
enum sbeMpIplCommands
{
SBE_CMD_MPIPL_INVALID = 0x00,
};
/**
* @brief enums for primary SBE response
*
*/
enum sbePrimResponse
{
SBE_PRI_OPERATION_SUCCESSFUL = 0x00,
SBE_PRI_INVALID_COMMAND = 0x01,
SBE_PRI_INVALID_DATA = 0x02,
SBE_PRI_SEQUENCE_ERROR = 0x03,
SBE_PRI_INTERNAL_ERROR = 0x04,
SBE_PRI_GENERIC_EXECUTION_FAILURE = 0xFE,
};
/**
* @brief enums for secondary SBE response
* @TODO via RTC: 129763
* Discuss on SBE_SEC_INVALID_TARGET_ID_PASSED
*
*/
enum sbeSecondaryResponse
{
SBE_SEC_OPERATION_SUCCESSFUL = 0x00,
SBE_SEC_COMMAND_CLASS_NOT_SUPPORTED = 0x01,
SBE_SEC_COMMAND_NOT_SUPPORTED = 0x02,
SBE_SEC_INVALID_ADDRESS_PASSED = 0x03,
SBE_SEC_INVALID_TARGET_TYPE_PASSED = 0x04,
SBE_SEC_INVALID_TARGET_ID_PASSED = 0x05,
SBE_SEC_SPECIFIED_TARGET_NOT_PRESENT = 0x06,
SBE_SEC_SPECIFIED_TARGET_NOT_FUNCTIONAL = 0x07,
SBE_SEC_COMMAND_NOT_ALLOWED_IN_THIS_STATE = 0x08,
SBE_SEC_FUNCTIONALITY_NOT_SUPPORTED = 0x09,
SBE_SEC_GENERIC_FAILURE_IN_EXECUTION = 0x0A,
SBE_SEC_SECURITY_VALIDATION_FAILED = 0x0B,
SBE_SEC_OS_FAILURE = 0x0C,
SBE_SEC_FIFO_ACCESS_FAILURE = 0x0D,
SBE_SEC_UNEXPECTED_EOT_INSUFFICIENT_DATA = 0x0E,
SBE_SEC_UNEXPECTED_EOT_EXCESS_DATA = 0x0F,
};
/**
* @brief enums for SBE command timeout values
*
*/
enum sbeCmdRespTimeout
{
SBE_CMD_TIMEOUT_SHORT_IN_MSEC = 100,
SBE_CMD_TIMEOUT_LONG_IN_MSEC = 30000,
};
/**
* @brief enums for PCB-PIB Generic Error codes
*
*/
enum sbePCBPIBErrorRC
{
SBE_PCB_PIB_ERROR_NONE = 0x00,
SBE_PCB_PIB_ERROR_RESOURCE_OCCUPIED = 0x01,
SBE_PCB_PIB_ERROR_CHIPLET_OFFLINE = 0x02,
SBE_PCB_PIB_ERROR_PARTIAL_GOOD = 0x03,
SBE_PCB_PIB_ERROR_ADDRESS_ERROR = 0x04,
SBE_PCB_PIB_ERROR_CLOCK_ERROR = 0x05,
SBE_PCB_PIB_ERROR_PACKET_ERROR = 0x06,
SBE_PCB_PIB_ERROR_TIMEOUT = 0x07,
};
/**
* @brief capabilities index values.
* Get Capability response will return 18 capabilities. This
* enum tells the index for each capability. Currently each generic
* functionality( scom, IPL ) etc span across two capabilities.
*/
enum
{
GENERIC_CAPABILTITY_START_IDX = 0,
IPL_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 2,
SCOM_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 4,
RING_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 6,
MEMORY_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 8,
REGISTER_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 10,
ARRAY_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 12,
INSTRUCTION_CTRL_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 14,
GENERIC_CHIPOP_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 16,
};
/**
* @brief capabilities enum values.
*
*/
enum
{
HWP_FFDC_COLLECTION_SUPPPORTED = 0x00000001,
SBE_FFDC_COLLECTION_SUPPPORTED = 0x00000002,
ADDRESS_BLACKLISTING_SUPPPORTED = 0x00000004,
FIFO_RESET_SUPPPORTED = 0x00000008,
EXECUTE_ISTEP_SUPPPORTED = 0xA1000001,
IS_SBE_DONE_SUPPPORTED = 0xA1000002,
GET_SCOM_SUPPPORTED = 0xA2000001,
PUT_SCOM_SUPPPORTED = 0xA2000002,
MODIFY_SCOM_SUPPPORTED = 0xA2000004,
PUT_SCOM_UNDER_MASK_SUPPPORTED = 0xA2000008,
MULTI_SCOM_SUPPPORTED = 0xA2000010,
GET_RING_SUPPPORTED = 0xA3000001,
PUT_RING_SUPPPORTED = 0xA3000002,
GET_MEMORY_SUPPPORTED = 0xA4000001,
PUT_MEMORY_SUPPPORTED = 0xA4000002,
GET_SRAM_SUPPPORTED = 0xA4000004,
PUT_SRAM_SUPPPORTED = 0xA4000008,
GET_REGISTER_SUPPPORTED = 0xA5000001,
PUT_REGISTER_SUPPPORTED = 0xA5000002,
READ_FAST_ARRAY_SUPPPORTED = 0xA6000001,
READ_TRACE_ARRAY_SUPPPORTED = 0xA6000002,
COLLECT_TRACE_ARRAY_SUPPPORTED = 0xA6000004,
CONTROL_INSTRUCTIONS_SUPPPORTED = 0xA7000001,
GET_SBE_FFDC_SUPPPORTED = 0xA8000001,
GET_SBE_CAPABILITIES_SUPPPORTED = 0xA8000002,
GET_SBE_FREQUENCIES_SUPPPORTED = 0xA8000004,
GET_SBE_STATE_SUPPPORTED = 0xA8000008,
};
/**
* * @brief enums for SBE Memory Access command flags
*
*/
enum sbeMemoryAccessFlags
{
SBE_MEM_ACCESS_FLAGS_TARGET_PROC = 0x00000001,
SBE_MEM_ACCESS_FLAGS_TARGET_PBA = 0x00000002,
SBE_MEM_ACCESS_FLAGS_AUTO_INCR_ON = 0x00000004,
SBE_MEM_ACCESS_FLAGS_ECC_OVERRIDE = 0x00000008,
SBE_MEM_ACCESS_FLAGS_TAG = 0x00000010,
SBE_MEM_ACCESS_FLAGS_FAST_MODE_ON = 0x00000020,
};
#ifdef __cplusplus
}
#endif
#endif /* __SBEFW_SBE_SP_INTF_H */
|
