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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/memory/lib/phy/apb.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2016,2017 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* 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 */
///
/// @file apb.H
/// @brief Subroutines for the PHY APB registers
///
// *HWP HWP Owner: Stephen Glancy <sglancy@us.ibm.com>
// *HWP HWP Backup: Andre Marin <aamarin@us.ibm.com>
// *HWP Team: Memory
// *HWP Level: 3
// *HWP Consumed by: FSP:HB
#ifndef _MSS_APB_H_
#define _MSS_APB_H_
#include <fapi2.H>
#include <p9_mc_scom_addresses.H>
#include <p9_mc_scom_addresses_fld.H>
#include <generic/memory/lib/utils/scom.H>
namespace mss
{
// I have a dream that the PHY code can be shared among controllers. So, I drive the
// engine from a set of traits. This might be folly. Allow me to dream. BRS
///
/// @class apbTraits
/// @brief a collection of traits associated with the PHY APB interface
/// @tparam T fapi2::TargetType representing the PHY
///
template< fapi2::TargetType T >
class apbTraits;
///
/// @class apbTraits
/// @brief a collection of traits associated with the Centaur PHY APB interface
///
template<>
class apbTraits<fapi2::TARGET_TYPE_MBA>
{
};
///
/// @class apbTraits
/// @brief a collection of traits associated with the Nimbus PHY APB
///
template<>
class apbTraits<fapi2::TARGET_TYPE_MCA>
{
public:
// MCA APB control registers - must be 64 bits.
static const uint64_t APB_CONFIG0_REG = MCA_DDRPHY_APB_CONFIG0_P0;
static const uint64_t APB_ERROR_STATUS0_REG = MCA_DDRPHY_APB_ERROR_STATUS0_P0;
static const uint64_t APB_FIR_ERR0_REG = MCA_DDRPHY_APB_FIR_ERR0_P0;
static const uint64_t APB_FIR_ERR1_REG = MCA_DDRPHY_APB_FIR_ERR1_P0;
static const uint64_t APB_FIR_ERR2_REG = MCA_DDRPHY_APB_FIR_ERR2_P0;
static const uint64_t APB_FIR_ERR3_REG = MCA_DDRPHY_APB_FIR_ERR3_P0;
// Fields, can be any size.
enum
{
RESET_ERR_RPT = MCA_DDRPHY_APB_CONFIG0_P0_RESET_ERR_RPT,
INVALID_ADDRESS = MCA_DDRPHY_APB_ERROR_STATUS0_P0_INVALID_ADDRESS,
WRITE_PARITY_ERR = MCA_DDRPHY_APB_ERROR_STATUS0_P0_WR_PAR_ERR,
FATAL_FSM = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET0,
FATAL_PARITY = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET1,
FSM = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET2,
PARITY = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET3,
FATAL_ADR52_MASTER = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET4,
FATAL_ADR52_SLAVE = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_SET5,
FSM_DP16 = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_FSM_DP16,
FSM_DP16_LEN = MCA_DDRPHY_APB_FIR_ERR0_P0_ERR_FSM_DP16_LEN,
};
};
namespace apb
{
///
/// @brief Read APB_CONFIG0
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_config0( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_CONFIG0_REG, o_data) );
FAPI_DBG("apb_config0: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Write APB_CONFIG0
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode write_config0( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
{
FAPI_DBG("apb_config0: 0x%016lx", i_data);
FAPI_TRY( mss::putScom(i_target, TT::APB_CONFIG0_REG, i_data) );
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read APB_ERROR_STATUS0
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_error_status0( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_ERROR_STATUS0_REG, o_data) );
FAPI_DBG("apb_error_status0: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Write APB_ERROR_STATUS0
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode write_error_status0( const fapi2::Target<T>& i_target,
const fapi2::buffer<uint64_t>& i_data )
{
FAPI_DBG("apb_error_status0: 0x%016lx", i_data);
FAPI_TRY( mss::putScom(i_target, TT::APB_ERROR_STATUS0_REG, i_data) );
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read APB_FIR_ERR0_REG
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_fir_err0( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_FIR_ERR0_REG, o_data) );
FAPI_DBG("apb_fir_err0: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read APB_FIR_ERR1_REG
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_fir_err1( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_FIR_ERR1_REG, o_data) );
FAPI_DBG("apb_fir_err1: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read APB_FIR_ERR2_REG
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_fir_err2( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_FIR_ERR2_REG, o_data) );
FAPI_DBG("apb_fir_err2: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Read APB_FIR_ERR3_REG
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode read_fir_err3( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
{
FAPI_TRY( mss::getScom(i_target, TT::APB_FIR_ERR3_REG, o_data) );
FAPI_DBG("apb_fir_err3: 0x%016lx", o_data);
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief Reset the error state of the APB block
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target the fapi2 target of the port
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode reset_err( const fapi2::Target<T>& i_target )
{
// DDRPHY_APB_CONFIG0_P0_RESET_ERR_RPT
// Write this bit to '1'b then write this bit to '0'b (toggle) to reset the
// APB error registers.
// Does this cover all of them? BRS
fapi2::buffer<uint64_t> l_data;
FAPI_TRY( read_config0(i_target, l_data) );
l_data.setBit<TT::RESET_ERR_RPT>();
FAPI_TRY( write_config0(i_target, l_data) );
l_data.clearBit<TT::RESET_ERR_RPT>();
FAPI_TRY( write_config0(i_target, l_data) );
// Now we need to reset the ERROR_STATUS0 register
l_data = 0;
FAPI_TRY( write_error_status0(i_target, l_data), "%s failed to clear APB error register via write",
mss::c_str(i_target) );
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief reset apb_config0
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode reset_config0( const fapi2::Target<T>& i_target )
{
FAPI_TRY( reset_err(i_target) );
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief reset apb
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
inline fapi2::ReturnCode reset( const fapi2::Target<T>& i_target )
{
FAPI_TRY( reset_config0(i_target) );
fapi_try_exit:
return fapi2::current_err;
}
///
/// @brief APB block FIR check
/// @tparam T fapi2 Target Type - derived
/// @tparam TT traits type defaults to apbTraits<T>
/// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode FAPI2_RC_SUCCESS if no FIR
///
template< fapi2::TargetType T = fapi2::TARGET_TYPE_MCA, typename TT = apbTraits<T> >
fapi2::ReturnCode fir_check( const fapi2::Target<T>& i_target );
} // close namespace apb
} // close namespace mss
#endif
|
