summaryrefslogtreecommitdiffstats
path: root/src/import/chips/p9/procedures/hwp/nest/p9_fbc_smp_utils.C
blob: cc1f2451b38675680c68d6453fd62074966ac694 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/nest/p9_fbc_smp_utils.C $  */
/*                                                                        */
/* 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.C
/// @brief Fabric SMP library functions/constants (FAPI2)
///
/// The functions in this file provide:
/// - Determination of a chip's group/chip ID
///
/// @author Joe McGill <jmcgill@us.ibm.com>
/// @author Christy Graves <clgraves@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
//

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <p9_fbc_smp_utils.H>
#include <p9_misc_scom_addresses.H>


//------------------------------------------------------------------------------
// Function definitions
//------------------------------------------------------------------------------

// Specialization for proc chip target. See doxygen in header file.
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)
{
    FAPI_DBG("(PROC): Start");
    fapi2::ReturnCode l_rc;

    // Retrieve chip ID attribute
    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_PROC_FABRIC_CHIP_ID, i_target,
                           o_chip_id),
             "(PROC): Error getting ATTR_PROC_FABRIC_CHIP_ID, l_rc 0x%.8X",
             (uint64_t)fapi2::current_err);

    // Display attribute value
    FAPI_DBG("(PROC): ATTR_PROC_FABRIC_CHIP_ID = 0x%.8X", o_chip_id);

    FAPI_ASSERT(o_chip_id < P9_FBC_UTILS_NUM_CHIP_IDS,
                fapi2::P9_FBC_UTILS_FABRIC_CHIP_ID_ATTR_ERR()
                .set_ATTR_DATA(o_chip_id),
                "(PROC): Invalid fabric chip ID attribute value 0x%02X", o_chip_id);

fapi_try_exit:
    FAPI_DBG("(PROC): End");
    return fapi2::current_err;
}


// Specialization for chiplet targets. See doxygen in header file.
template<>
fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_XBUS>& i_target,
    uint8_t& o_chip_id)
{
    FAPI_DBG("(XBUS): Start");

    fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP> l_procChip;
    l_procChip = i_target.getParent<fapi2::TARGET_TYPE_PROC_CHIP>();

    return (p9_fbc_utils_get_chip_id_attr(l_procChip, o_chip_id));
}

fapi2::ReturnCode p9_fbc_utils_get_chip_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target,
    uint8_t& o_chip_id)
{
    FAPI_DBG("(OBUS): Start");

    fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP> l_procChip;
    l_procChip = i_target.getParent<fapi2::TARGET_TYPE_PROC_CHIP>();

    return (p9_fbc_utils_get_chip_id_attr(l_procChip, o_chip_id));
}


// Specialization for proc chip target.  See doxygen in header file.
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)
{
    FAPI_INF("(PROC): Start");
    fapi2::ReturnCode l_rc;

    // Retrieve group ID attribute
    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_PROC_FABRIC_GROUP_ID, i_target,
                           o_group_id),
             "(PROC): Error getting ATTR_FABRIC_GROUP_ID, l_rc 0x%.8X",
             (uint64_t)fapi2::current_err);
    // Print attribute value
    FAPI_DBG("(PROC): ATTR_PROC_FABRIC_GROUP_ID = 0x%X", o_group_id);

    FAPI_ASSERT(o_group_id < P9_FBC_UTILS_NUM_GROUP_IDS,
                fapi2::P9_FBC_UTILS_FABRIC_GROUP_ID_ATTR_ERR()
                .set_ATTR_DATA(o_group_id),
                "(PROC): Invalid fabric group ID attribute value 0x%02X", o_group_id);
fapi_try_exit:

    FAPI_DBG("(PROC): End");
    return fapi2::current_err;
}


// Specialization for chiplet targets.  See doxygen in header file.
template<>
fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_XBUS>& i_target,
    uint8_t& o_group_id)
{
    FAPI_DBG("(XBUS): Start");

    fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP> l_procChip;
    l_procChip = i_target.getParent<fapi2::TARGET_TYPE_PROC_CHIP>();

    return (p9_fbc_utils_get_group_id_attr(l_procChip, o_group_id));
}

fapi2::ReturnCode p9_fbc_utils_get_group_id_attr(
    const fapi2::Target<fapi2::TARGET_TYPE_OBUS>& i_target,
    uint8_t& o_group_id)
{
    FAPI_DBG("(OBUS): Start");

    fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP> l_procChip;
    l_procChip = i_target.getParent<fapi2::TARGET_TYPE_PROC_CHIP>();

    return (p9_fbc_utils_get_group_id_attr(l_procChip, o_group_id));
}
OpenPOWER on IntegriCloud