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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: chips/p9/procedures/hwp/io/p9_io_scom.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* EKB Project */
/* */
/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* 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. */
/* */
/* IBM_PROLOG_END_TAG */
///
/// @file p9_io_scom.H
/// @brief Register Access.
///----------------------------------------------------------------------------
/// *HWP HWP Owner : Chris Steffen <cwsteffen@us.ibm.com>
/// *HWP HWP Backup Owner : Gary Peterson <garyp@us.ibm.com>
/// *HWP FW Owner : Jamie Knight <rjknight@us.ibm.com>
/// *HWP Team : IO
/// *HWP Level : 2
/// *HWP Consumed by : FSP:HB
///----------------------------------------------------------------------------
///
/// @verbatim
/// Register Access via scom.
///
/// @endverbatim
///----------------------------------------------------------------------------
#ifndef P9_IO_SCOM_H_
#define P9_IO_SCOM_H_
//* *****************************
//* Defines
//* *****************************
// @brief IO Base Addresses
#define P9_PSI_PHY_BASE_0x00000000 0x00000000
#define P9_XBUS_PHY_BASE_0x06010C00 0x06010C00
#define P9_ABUS0_PHY_BASE_0x09011000 0x09011000
#define P9_ABUS3_PHY_BASE_0x0C011000 0x0C011000
#define P9_NVBUS0_PHY_BASE_0x09011000 0x09011000
#define P9_NVBUS3_PHY_BASE_0x0C011000 0x0C011000
#define P9_NVBUS1_PHY_BASE_0x08010C40 0x08010C40
#define P9_DMI0_PHY_BASE_0x02011A00 0x02011A00
#define P9_DMI1_PHY_BASE_0x02011E00 0x02011E00
#define CEN_PHY_BASE_0x02010400 0x02010400
//-----------------------------------------------------------------------------
// FAPI Includes
//-----------------------------------------------------------------------------
#include <fapi2.H>
/**
* @namespace io
* This class provides a generic class for a register to read/write SCOMs.
*/
namespace io
{
/**
* @brief Parses the register data by the i_start and i_width of a field and returns
* a right aligned value.
* @param[in] i_scom_addr Not used
* @param[in] i_start Represents the start bit of the field within the reg
* @param[in] i_width Represents the width of the field within the reg
* @param[in] i_register_data Scom Data from previous io::read()
* @return Field Data
*/
inline uint64_t get(
const uint64_t& i_scom_addr,
const uint8_t& i_start,
const uint8_t& i_width,
const uint64_t& i_register_data )
{
const uint8_t REGISTER_WIDTH = 64;
const uint8_t SHIFT = REGISTER_WIDTH - i_start - i_width;
const uint64_t MASK = ( ( (uint64_t)0x1 << i_width ) - 1 ) << SHIFT;
return ( ( i_register_data & MASK ) >> SHIFT );
}
/**
* @brief Sets the field specified by the i_start and i_width of the register data to the right
* alighted i_data.
* @param[in] i_scom_addr Is not used in this function.
* @param[in] i_start Represents the start bit of the field within the reg
* @param[in] i_width Represents the width of the field within the reg
* @param[in] i_data Data to be set
* @param[in,out] io_register_data Scom Data
* @return void
*/
inline void set(
const uint64_t& i_scom_addr,
const uint8_t& i_start,
const uint8_t& i_width,
const uint64_t& i_data,
uint64_t& io_register_data )
{
const uint8_t REGISTER_WIDTH = 64;
const uint8_t SHIFT = REGISTER_WIDTH - i_start - i_width;
const uint64_t MASK = ( ( (uint64_t)0x1 << i_width ) - 1 ) << SHIFT;
io_register_data = ( ( io_register_data & ~MASK ) | ( ( i_data << SHIFT ) & MASK ) );
return;
}
/**
* @brief Builds the base scom address
* @tparam[in] K fapi2::TargetType
* @param[in] i_target FAPI2 Target
* @return 32bit encoded base scom address
*/
template < fapi2::TargetType K >
inline uint32_t get_base_address( const fapi2::Target < K >& i_target )
{
switch( i_target.getType() )
{
case fapi2::TargetType::TARGET_TYPE_XBUS:
return P9_XBUS_PHY_BASE_0x06010C00;
case fapi2::TargetType::TARGET_TYPE_ABUS:
return P9_ABUS0_PHY_BASE_0x09011000;
case fapi2::TargetType::TARGET_TYPE_MCS:
return P9_DMI0_PHY_BASE_0x02011A00;
case fapi2::TargetType::TARGET_TYPE_MEMBUF_CHIP:
return CEN_PHY_BASE_0x02010400;
default:
fapi2::IO_GCR_TARGET_TYPE_NOT_FOUND().set_TARGET( i_target ).execute();
FAPI_ERR("TargetType not found(0x%X)", i_target.getType());
}
return 0x0;
}
/**
* @brief Builds the base scom address, group, and lane into the full
* scom address
* @tparam[in] K fapi2::TargetType
* @param[in] i_target FAPI2 Target
* @param[in] i_scom_addr Register scom address information
* @param[in] i_group Group encoded into the scom address
* @param[in] i_lane Lane encoded into the scom address
* @return Full 64bit encoded scom address
*/
template < fapi2::TargetType K >
inline uint64_t build_address(
const fapi2::Target < K >& i_target,
const uint64_t& i_scom_addr,
const uint8_t& i_group,
const uint8_t& i_lane )
{
const uint8_t ADDRESS_SIZE = 64;
const uint8_t GROUP_START = 22;
const uint8_t GROUP_WIDTH = 5;
const uint8_t LANE_START = 27;
const uint8_t LANE_WIDTH = 5;
const uint8_t GROUP_SHIFT = ADDRESS_SIZE - GROUP_START - GROUP_WIDTH;
const uint8_t LANE_SHIFT = ADDRESS_SIZE - LANE_START - LANE_WIDTH;
return ( i_scom_addr | get_base_address( i_target )
| ( (uint64_t) i_group << GROUP_SHIFT )
| ( (uint64_t) i_lane << LANE_SHIFT ) );
}
/**
* @brief SCOM read function
* @tparam[in] K fapi2::TargetType
* @param[in] i_scom_addr Register Scom Information
* @param[in] i_start Represents the start bit of the field within the reg
* @param[in] i_width Represents the width of the field within the reg
* @param[in] i_target Target to operate on
* @param[in] i_group Group to operate on
* @param[in] i_lane Lane to operate on
* @param[out] o_data Scom Data
* @return return code. Zero on success, else platform specified error
*/
template < fapi2::TargetType K >
inline fapi2::ReturnCode read(
const uint64_t& i_scom_addr,
const uint8_t& i_start,
const uint8_t& i_width,
const fapi2::Target < K >& i_target,
const uint8_t& i_group,
const uint8_t& i_lane,
uint64_t& o_data )
{
fapi2::buffer<uint64_t> l_register_data;
// Stitch together the base scom address, register info, group, lane
uint64_t address = build_address( i_target, i_scom_addr, i_group, i_lane );
// Execute fapi2 getscom
FAPI_TRY( fapi2::getScom( i_target, address, l_register_data ),
"getScom Failed(0x%X): Addr(0x%016llX) Data(0x%016llX)",
(uint64_t) fapi2::current_err, address, (uint64_t)l_register_data );
o_data = l_register_data;
fapi_try_exit:
return fapi2::current_err;
}
/**
* @brief SCOM write function
* @tparam[in] K fapi2::TargetType
* @param[in] i_scom_addr Register Scom Information
* @param[in] i_start Represents the start bit of the field within the reg
* @param[in] i_width Represents the width of the field within the reg
* @param[in] i_target Target to operate on
* @param[in] i_group Group to operate on
* @param[in] i_lane Lane to operate on
* @param[in] i_data Scom Data
* @return return code. Zero on success, else platform specified error
*/
template < fapi2::TargetType K >
inline fapi2::ReturnCode write(
const uint64_t& i_scom_addr,
const uint8_t& i_start,
const uint8_t& i_width,
const fapi2::Target < K >& i_target,
const uint8_t& i_group,
const uint8_t& i_lane,
const uint64_t& i_data )
{
fapi2::buffer<uint64_t> l_register_data( i_data );
// Stitch together the base scom address, register info, group, lane
uint64_t address = build_address( i_target, i_scom_addr, i_group, i_lane );
// Execute fapi2 putscom
FAPI_TRY( fapi2::putScom( i_target, address, l_register_data ),
"putScom Failed(0x%X): Addr(0x%016llX) Data(0x%016llX)",
(uint64_t) fapi2::current_err, address, i_data );
fapi_try_exit:
return fapi2::current_err;
}
/**
* @brief SCOM read modify write function
* @tparam[in] K fapi2::TargetType
* @param[in] i_scom_addr Register Scom Information
* @param[in] i_start Represents the start bit of the field within the reg
* @param[in] i_width Represents the width of the field within the reg
* @param[in] i_target Target to operate on
* @param[in] i_group Group to operate on
* @param[in] i_lane Lane to operate on
* @param[in] i_data Field Data
* @return return code. Zero on success, else platform specified error
*/
template < fapi2::TargetType K >
inline fapi2::ReturnCode rmw(
const uint64_t& i_scom_addr,
const uint8_t& i_start,
const uint8_t& i_width,
const fapi2::Target < K >& i_target,
const uint8_t& i_group,
const uint8_t& i_lane,
const uint64_t& i_data )
{
uint64_t l_register_data = 0;
FAPI_TRY( read(
i_scom_addr,
i_start,
i_width,
i_target,
i_group,
i_lane,
l_register_data ) );
set(i_scom_addr, i_start, i_width, i_data, l_register_data );
FAPI_TRY( write(
i_scom_addr,
i_start,
i_width,
i_target,
i_group,
i_lane,
l_register_data ) );
fapi_try_exit:
return fapi2::current_err;
}
};
#endif /* P9_IO_SCOM_H_ */
|
