summaryrefslogtreecommitdiffstats
path: root/src/import/chips/p9/procedures/hwp/nest/p9_fbc_smp_utils.H
blob: b524f4983efb281e224c1dd8c6676555b94a5568 (plain)
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
330
331
332
333
334
335
336
337
338
339
340
341
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/nest/p9_fbc_smp_utils.H $  */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016                             */
/* [+] 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 p9_fbc_smp_utils.H
/// @brief Fabric SMP library functions/constants (FAPI2)
///
/// @author Joe McGill <jmcgill@us.ibm.com>
///

//
// *HWP HWP Owner: Joe McGill <jmcgill@us.ibm.com>
// *HWP FW Owner: Thi Tran <thi@us.ibm.com>
// *HWP Team: Nest
// *HWP Level: 2
// *HWP Consumed by: HB,FSP
//

#ifndef _P9_FBC_SMP_UTILS_H_
#define _P9_FBC_SMP_UTILS_H_

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <fapi2.H>
#include <p9_perv_scom_addresses.H>
#include <p9_perv_scom_addresses_fld.H>
#include <p9_misc_scom_addresses.H>
#include <p9_misc_scom_addresses_fld.H>
#include <p9_xbus_scom_addresses.H>
#include <p9_xbus_scom_addresses_fld.H>
#include <p9_obus_scom_addresses.H>


//------------------------------------------------------------------------------
// Constant definitions
//------------------------------------------------------------------------------

// link types
enum p9_fbc_link_t
{
    ELECTRICAL = fapi2::TARGET_TYPE_XBUS,
    OPTICAL = fapi2::TARGET_TYPE_OBUS
};

// XBUS/ABUS link control structure
struct p9_fbc_link_ctl_t
{
    // associated endpoint target type & unit target number
    p9_fbc_link_t endp_type;
    uint8_t       endp_unit_id;
    // iovalid SCOM addresses/control field
    uint64_t      iovalid_or_addr;
    uint64_t      iovalid_clear_addr;
    uint8_t       iovalid_field_start_bit;
    // EXTFIR/RAS control field
    uint8_t       ras_fir_field_bit;
    // DL layer SCOM addresses
    uint64_t      dl_fir_addr;
    uint64_t      dl_control_addr;
    // TL layer SCOM addresses
    uint64_t      tl_fir_addr;
    uint8_t       tl_fir_trained_field_start_bit;
    uint64_t      tl_link_delay_addr;
    uint32_t      tl_link_delay_hi_start_bit;
    uint32_t      tl_link_delay_lo_start_bit;
};

// link constants
const uint32_t P9_FBC_UTILS_MAX_X_LINKS = 7;
const uint32_t P9_FBC_UTILS_MAX_A_LINKS = 4;

const p9_fbc_link_ctl_t P9_FBC_XBUS_LINK_CTL_ARR[P9_FBC_UTILS_MAX_X_LINKS] =
{
    {
        ELECTRICAL,
        0,
        PERV_XB_CPLT_CONF1_OR,
        PERV_XB_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X0_FIR_ERR,
        XBUS_LL0_LL0_LL0_IOEL_FIR_REG,
        XBUS_0_LL0_IOEL_CONTROL,
        PU_PB_IOE_FIR_REG,
        PU_PB_IOE_FIR_REG_FMR00_TRAINED,
        PU_PB_ELINK_DLY_0123_REG,
        4,
        20
    },
    {
        ELECTRICAL,
        1,
        PERV_XB_CPLT_CONF1_OR,
        PERV_XB_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_6D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X1_FIR_ERR,
        XBUS_1_LL1_LL1_LL1_IOEL_FIR_REG,
        XBUS_1_LL1_IOEL_CONTROL,
        PU_PB_IOE_FIR_REG,
        PU_PB_IOE_FIR_REG_FMR02_TRAINED,
        PU_PB_ELINK_DLY_0123_REG,
        36,
        52
    },
    {
        ELECTRICAL,
        2,
        PERV_XB_CPLT_CONF1_OR,
        PERV_XB_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_8D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X2_FIR_ERR,
        XBUS_2_LL2_LL2_LL2_IOEL_FIR_REG,
        XBUS_2_LL2_IOEL_CONTROL,
        PU_PB_IOE_FIR_REG,
        PU_PB_IOE_FIR_REG_FMR04_TRAINED,
        PU_PB_ELINK_DLY_45_REG,
        4,
        20
    },
    {
        OPTICAL,
        0,
        PERV_OB0_CPLT_CONF1_OR,
        PERV_OB0_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X3_FIR_ERR,
        OBUS_LL0_LL0_LL0_PB_IOOL_FIR_REG,
        OBUS_0_LL0_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR00_TRAINED,
        PU_IOE_PB_OLINK_DLY_0123_REG,
        4,
        20
    },
    {
        OPTICAL,
        1,
        PERV_OB1_CPLT_CONF1_OR,
        PERV_OB1_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X4_FIR_ERR,
        OBUS_1_LL1_LL1_LL1_PB_IOOL_FIR_REG,
        OBUS_1_LL1_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR02_TRAINED,
        PU_IOE_PB_OLINK_DLY_0123_REG,
        36,
        52
    },
    {
        OPTICAL,
        2,
        PERV_OB2_CPLT_CONF1_OR,
        PERV_OB2_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X5_FIR_ERR,
        OBUS_2_LL2_LL2_LL2_PB_IOOL_FIR_REG,
        OBUS_2_LL2_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR04_TRAINED,
        PU_IOE_PB_OLINK_DLY_4567_REG,
        4,
        20
    },
    {
        OPTICAL,
        3,
        PERV_OB3_CPLT_CONF1_OR,
        PERV_OB3_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X6_FIR_ERR,
        OBUS_3_LL3_LL3_LL3_PB_IOOL_FIR_REG,
        OBUS_3_LL3_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR06_TRAINED,
        PU_IOE_PB_OLINK_DLY_4567_REG,
        36,
        52
    }
};

const p9_fbc_link_ctl_t P9_FBC_ABUS_LINK_CTL_ARR[P9_FBC_UTILS_MAX_A_LINKS] =
{
    {
        OPTICAL,
        0,
        PERV_OB0_CPLT_CONF1_OR,
        PERV_OB0_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X3_FIR_ERR,
        OBUS_LL0_LL0_LL0_PB_IOOL_FIR_REG,
        OBUS_0_LL0_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR00_TRAINED,
        PU_IOE_PB_OLINK_DLY_0123_REG,
        4,
        20
    },
    {
        OPTICAL,
        1,
        PERV_OB1_CPLT_CONF1_OR,
        PERV_OB1_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X4_FIR_ERR,
        OBUS_1_LL1_LL1_LL1_PB_IOOL_FIR_REG,
        OBUS_1_LL1_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR02_TRAINED,
        PU_IOE_PB_OLINK_DLY_0123_REG,
        36,
        52
    },
    {
        OPTICAL,
        2,
        PERV_OB2_CPLT_CONF1_OR,
        PERV_OB2_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X5_FIR_ERR,
        OBUS_2_LL2_LL2_LL2_PB_IOOL_FIR_REG,
        OBUS_2_LL2_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR04_TRAINED,
        PU_IOE_PB_OLINK_DLY_4567_REG,
        4,
        20
    },
    {
        OPTICAL,
        3,
        PERV_OB3_CPLT_CONF1_OR,
        PERV_OB3_CPLT_CONF1_CLEAR,
        PERV_1_CPLT_CONF1_IOVALID_4D,
        PU_PB_CENT_SM1_EXTFIR_MASK_REG_PB_X6_FIR_ERR,
        OBUS_3_LL3_LL3_LL3_PB_IOOL_FIR_REG,
        OBUS_3_LL3_IOOL_CONTROL,
        PU_IOE_PB_IOO_FIR_REG,
        PU_IOE_PB_IOO_FIR_REG_FMR06_TRAINED,
        PU_IOE_PB_OLINK_DLY_4567_REG,
        36,
        52
    }
};

// range of fabric node/chip ID fields
const uint8_t P9_FBC_UTILS_NUM_CHIP_IDS = 8;
const uint8_t P9_FBC_UTILS_NUM_GROUP_IDS = 8;


//------------------------------------------------------------------------------
// Function prototypes
//------------------------------------------------------------------------------

///
/// @brief Utility function to read & return fabric group ID attribute
///
/// @tparam T template parameter, passed in target.
/// @param[in]   i_target          Reference to  chip/chiplet target
/// @param[out]  o_group_id        Group ID value
///
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
template<fapi2::TargetType T>
fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<T>& i_target,
    uint8_t& o_group_id);

// Specialization for proc chip target
template<>
fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
    uint8_t& o_group_id);

// Specialization for XBUS chiplet target
template<>
fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_XBUS>& i_target,
    uint8_t& o_group_id);

// Specialization for OBUS chiplet target
template<>
fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target,
    uint8_t& o_group_id);

///
/// @brief Utility function to read & return fabric chip ID attribute
///
/// @tparam T template parameter, passed in target.
/// @param[in]   i_target           Reference to chip/chiplet target
/// @param[out]  o_chip_id          chip ID value
///
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
template<fapi2::TargetType T>
fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<T>& i_target,
    uint8_t& o_chip_id);

// Specialization for proc chip target
template<>
fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
    uint8_t& o_chip_id);

// Specialization for XBUS chiplet target
template<>
fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_XBUS>& i_target,
    uint8_t& o_chip_id);

// Specialization for OBUS chiplet target
template<>
fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target,
    uint8_t& o_chip_id);


#endif // _P9_FBC_SMP_UTILS_H_
OpenPOWER on IntegriCloud