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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/fapi/fapiHwAccess.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2012 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file fapiHwAccess.H
*
* @brief Defines the hardware access functions that platform code must
* implement. It is a HWP requirement that these be "C" functions
* because it simplifies language bindings for non-C languages,
* such as perl
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 04/13/2011 Created. Copied from Hlava's code.
* mjjones 06/02/2011 Scom addresses should be uint64_t
* use ecmdDataBufferBase
* mjjones 06/30/2011 Updated comment
* mjjones 09/14/2011 Prepended fapi to functions
* mjjones 11/10/2011 Use ecmdDataBufferBase
* 836579 thi May 22,2012 Spy/Ring supports
* mjjones 07/12/2012 Add mode options to Ring funcs
* rjknight 09/20/2012 Update fapiSpy interfaces to
* allow string inputs for cronus
*/
#ifndef FAPIHWACCESS_H_
#define FAPIHWACCESS_H_
#include <stdint.h>
#include <ecmdDataBufferBase.H>
#include <fapiReturnCode.H>
#include <fapiTarget.H>
namespace fapi
{
/**
* @brief Enumeration of modify modes used in modify operations
*/
enum ChipOpModifyMode
{
CHIP_OP_MODIFY_MODE_OR = 1,
CHIP_OP_MODIFY_MODE_AND = 2,
CHIP_OP_MODIFY_MODE_XOR = 3,
};
/**
* @brief Enumeration of Ring operation modes
*
* This is a bitmap to allow the user to specify multiple modes
*/
enum RingMode
{
RING_MODE_SET_PULSE = 0x00000001,
RING_MODE_NO_HEADER_CHECK = 0x00000002,
// FUTURE_MODE = 0x00000004,
// FUTURE_MODE = 0x00000008,
};
}
extern "C"
{
//------------------------------------------------------------------------------
// HW Communication Functions
//------------------------------------------------------------------------------
/**
* @brief Reads a SCOM register from a Chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to read from
* @param[out] o_data ecmdDataBufferBase object that holds data read from
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiGetScom(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & o_data);
/**
* @brief Writes a SCOM register on a Chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to write to
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiPutScom(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & i_data);
/**
* @brief Writes a SCOM register under mask to a chip
* @param[in] i_target Target to operate on
* @param[in] i_address Scom address to write to
* @param[in] i_data ecmdDataBufferBase object that holds the data
* @param[in] i_mask ecmdDataBufferBase object that holds the mask (i_data to
* write)
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiPutScomUnderMask(const fapi::Target& i_target,
const uint64_t i_address,
ecmdDataBufferBase & i_data,
ecmdDataBufferBase & i_mask);
/**
* @brief Reads a CFAM register from a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to read from
* @param[out] o_data ecmdDataBufferBase object that holds data read from
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiGetCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & o_data);
/**
* @brief Writes a CFAM register to a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to write to
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiPutCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data);
/**
* @brief Read-modify-write a CFAM register on a chip
* @param[in] i_target Target to operate on
* @param[in] i_address CFAM address to write to
* @param[in] i_data ecmdDataBufferBase object that holds the modifying data
* @param[in] i_modifyMode The modify mode (or/and/xor)
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiModifyCfamRegister(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data,
const fapi::ChipOpModifyMode i_modifyMode);
/**
* @brief Reads a ring from a target
* @param[in] i_target Target to operate on
* @param[in] i_address Ring address to read from
* @param[out] o_data ecmdDataBufferBase object that holds data read from
* address
* @param[in] i_ringMode Any number of mode options from fapi::RingMode ORed
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiGetRing(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & o_data,
const uint32_t i_ringMode = 0);
/**
* @brief Writes a ring register on a target
* @param[in] i_target Target to operate on
* @param[in] i_address Ring address to write to
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @param[in] i_ringMode Any number of mode options from fapi::RingMode ORed
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiPutRing(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data,
const uint32_t i_ringMode = 0);
/**
* @brief Modifies a ring register on a target
* @param[in] i_target Target to operate on
* @param[in] i_address Ring address to modify
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
* @param[in] i_ringMode Any number of mode options from fapi::RingMode ORed
* @return ReturnCode. Zero on success, else platform specified error
*/
fapi::ReturnCode fapiModifyRing(const fapi::Target& i_target,
const uint32_t i_address,
ecmdDataBufferBase & i_data,
const fapi::ChipOpModifyMode i_modifyMode,
const uint32_t i_ringMode = 0);
// --------------------------------------------------------------------------
// NOTE:
// These spy access interfaces are only used in FSP and cronus
// HB does not allow spy access
/**
* @brief Reads a Spy from a target
* @param[in] i_target Target to read spy from
* @param[in] i_spyId The spy's id
* @param[out] o_data Storage for output data
*
* @return ReturnCode. Zero on success, else platform specified error
*
* @note: The string version is only supported for cronus.
*
* The fapi design to support both FSP and cronus use of get and
* put spy funcions is dependant on the SPY names being expanded
* to resemble a valid C identifier. This design places some
* restrictions on the SPY names which can be used.
*
* 1. if the spy name contains a # procedure writers should replade it
* with an __P__ for example -
*
* ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS
* becomes
* ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS
*
* 2. if the spy name has a number following a "." it must have an
* uinderscore prepended to the number.
*
* EH.TPCHIP.2KX100_ARY_CLK_EDGES_DLY
* becomes
* EH.TPCHIP._2KX100_ARY_CLK_EDGES_DLY
*
* Example SPY name:
* The hardware procedure should call the function like:
*
* ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS
*
* fapi::ReturnCode rc = fapiGetSpy( targ,
* ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS, data );
*
* NOTE: the ID is not in quotes the fapi code will handle adding the
* quotes for the cronus environment
*
*/
#ifdef FAPI_SUPPORT_SPY_AS_ENUM
#define fapiGetSpy(TARGET, ID, DATA) _fapiGetSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA )
fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
const uint32_t i_spyId,
ecmdDataBufferBase & o_data);
#endif
#ifdef FAPI_SUPPORT_SPY_AS_STRING
#define fapiGetSpy(TARGET, ID, DATA) _fapiGetSpy(TARGET, #ID, DATA)
fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
const char * const i_spyId,
ecmdDataBufferBase & o_data);
#endif
#ifdef FAPI_SUPPORT_SPY_AS_ENUM
/**
* @brief Writes a spy on a target
* @param[in] i_target Target to operate on
* @param[in] i_spyId The spy's id
* @param[in] i_data ecmdDataBufferBase object that holds data to write into
* address
*
* @return ReturnCode. Zero on success, else platform specified error
*
* @note: The string version is only supported for cronus.
*
* The fapi design to support both FSP and cronus use of get and
* put spy funcions is dependant on the SPY names being expanded
* to resemble a valid C identifier. This design places some
* restrictions on the SPY names which can be used.
*
* 1. if the spy name contains a # procedure writers should replade it
* with an __P__ for example -
*
* ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS
* becomes
* ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS
*
* 2. if the spy name has a number following a "." it must have an
* uinderscore prepended to the number.
*
* EH.TPCHIP.2KX100_ARY_CLK_EDGES_DLY
* becomes
* EH.TPCHIP._2KX100_ARY_CLK_EDGES_DLY
*
* Example SPY name:
* The hardware procedure should call the function like:
*
* ABUS.RX0.RXPACKS#0.RXPACK.RD.LC.LC.ACT_DIS
*
* fapi::ReturnCode rc = fapiPutSpy( targ,
* ABUS.RX0.RXPACKS__P__0.RXPACK.RD.LC.LC.ACT_DIS, data );
*
* NOTE: the ID is not in quotes the fapi code will handle adding the
* quotes for the cronus environment
*
*/
#define fapiPutSpy(TARGET, ID, DATA) _fapiPutSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA)
fapi::ReturnCode _fapiPutSpy(const fapi::Target& i_target,
const uint32_t i_spyId,
ecmdDataBufferBase & i_data);
#endif
#ifdef FAPI_SUPPORT_SPY_AS_STRING
#define fapiPutSpy(TARGET, ID, DATA) _fapiPutSpy(TARGET, #ID, DATA)
fapi::ReturnCode _fapiPutSpy(const fapi::Target& i_target,
const char* const i_spyId,
ecmdDataBufferBase & i_data);
#endif
} // extern "C"
#endif // FAPIHWACCESS_H_
|
