summaryrefslogtreecommitdiffstats
path: root/src/import/chips/p9/procedures/hwp/perv/p9_sbe_hreset.C
blob: fa51f80f90ec8a72cff66887dfa63211fea672ac (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/perv/p9_sbe_hreset.C $     */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2017,2019                        */
/* [+] 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_sbe_hreset.C
///
/// @brief Restart SBE Runtime
//------------------------------------------------------------------------------
// *HWP HW Owner        : Abhishek Agarwal <abagarw8@in.ibm.com>
// *HWP HW Backup Owner : Srinivas V Naga <srinivan@in.ibm.com>
// *HWP FW Owner        : Thi Tran <thi@us.ibm.com>
// *HWP Team            : Perv
// *HWP Level           : 3
// *HWP Consumed by     : SE:HB
//------------------------------------------------------------------------------
#include "p9_sbe_hreset.H"
#include <p9_perv_scom_addresses.H>
#include <p9_perv_scom_addresses_fld.H>
#include <p9_misc_scom_addresses.H>
#include <p9_frequency_buckets.H>

// ----------------
// Constants
// ----------------

// Bit definitions for MBOX SCRATCH 3 reg (CFAM 283A, SCOM 0x5003A)
#define SCRATCH_3_REG_IPL_MODE_BIT       0
#define SCRATCH_3_REG_RUNTIME_MODE_BIT   1


fapi2::ReturnCode p9_sbe_i2c_bit_rate_divisor_setting(
    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target_chip,
    bool i_masterProc)
{
    uint8_t l_attr_nest_pll_bucket = 0;
    const fapi2::Target<fapi2::TARGET_TYPE_SYSTEM> FAPI_SYSTEM;
    fapi2::ATTR_CHIP_EC_FEATURE_I2CM_INTERNAL_CLK_DIV2_Type l_i2cm_internal_clk_div2 = 0;
    fapi2::buffer<uint16_t> l_mb_bit_rate_divisor;
    fapi2::buffer<uint64_t> l_data64;
    fapi2::buffer<uint32_t> l_data32;

    FAPI_INF("Entering p9_sbe_i2c_bit_rate_divisor_setting...");
    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_NEST_PLL_BUCKET, FAPI_SYSTEM,
                           l_attr_nest_pll_bucket));
    FAPI_INF("ATTR_NEST_PLL_BUCKET value: %d", l_attr_nest_pll_bucket);

    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_CHIP_EC_FEATURE_I2CM_INTERNAL_CLK_DIV2, i_target_chip, l_i2cm_internal_clk_div2));

    l_mb_bit_rate_divisor = NEST_PLL_FREQ_I2CDIV_LIST[l_attr_nest_pll_bucket - 1] *
                            ((l_i2cm_internal_clk_div2) ? (2) : (1));

    FAPI_INF("Bit_rate_divisor value: %d", l_mb_bit_rate_divisor);

    FAPI_DBG("Adjust I2C bit rate divisor setting in I2CM B Mode Reg");
    FAPI_TRY(fapi2::getScom(i_target_chip, PU_MODE_REGISTER_B, l_data64));
    l_data64.insertFromRight< 0, 16 >(l_mb_bit_rate_divisor);
    FAPI_TRY(fapi2::putScom(i_target_chip, PU_MODE_REGISTER_B, l_data64));

    FAPI_INF("Writing I2C bit rate divisor into mailbox_reg_2 AND writing i2c valid bit into mailbox_reg_8");
#ifndef __HOSTBOOT_RUNTIME

    if (i_masterProc)
#endif
    {
        FAPI_TRY(fapi2::getScom(i_target_chip, PERV_SCRATCH_REGISTER_2_SCOM, l_data64));
        l_data64.insertFromRight< 0, 16 >(l_mb_bit_rate_divisor);
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Master proc Scratch2 0x%.16llX", l_data64);
        FAPI_TRY(fapi2::putScom(i_target_chip, PERV_SCRATCH_REGISTER_2_SCOM, l_data64));

        FAPI_TRY(fapi2::getScom(i_target_chip, PERV_SCRATCH_REGISTER_8_SCOM, l_data64));
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Master proc Scratch8 0x%.16llX (before insert)", l_data64);
        l_data64.insertFromRight< 1, 1 >(1);
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Master proc Scratch8 0x%.16llX", l_data64);
        FAPI_TRY(fapi2::putScom(i_target_chip, PERV_SCRATCH_REGISTER_8_SCOM, l_data64));
    }

#ifndef __HOSTBOOT_RUNTIME
    else
    {
        FAPI_TRY(fapi2::getCfamRegister(i_target_chip, PERV_SCRATCH_REGISTER_2_FSI, l_data32));
        l_data32.insertFromRight< 0, 16 >(l_mb_bit_rate_divisor);
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Slave proc Scratch2 0x%.8X", l_data32);
        FAPI_TRY(fapi2::putCfamRegister(i_target_chip, PERV_SCRATCH_REGISTER_2_FSI, l_data32));

        FAPI_TRY(fapi2::getScom(i_target_chip, PERV_SCRATCH_REGISTER_8_SCOM, l_data64));
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Slave proc Scratch8 0x%.16llX (before insert)", l_data64);
        l_data64.insertFromRight< 1, 1 >(1);
        FAPI_INF("p9_sbe_i2c_bit_rate_divisor_setting - Slave proc Scratch8 0x%.16llX", l_data64);
        FAPI_TRY(fapi2::putScom(i_target_chip, PERV_SCRATCH_REGISTER_8_SCOM, l_data64));
    }

#endif

fapi_try_exit:
    FAPI_INF("Exiting p9_sbe_i2c_bit_rate_divisor_setting...");
    return fapi2::current_err;
}

// See doxygen in header file
fapi2::ReturnCode p9_sbe_hreset(
    const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
    const bool i_restart_ipl)
{
    FAPI_DBG("p9_sbe_hreset: Entering...");
    fapi2::buffer<uint32_t> l_data32;
    fapi2::buffer<uint64_t> l_data64;
    uint8_t l_scratch3_bitToClear = 0;
    uint8_t l_scratch3_bitToSet = 0;
    uint8_t l_startVectorBit = 0;
    uint8_t l_masterProc = 0;

    FAPI_INF("SBE HRESET to %s", i_restart_ipl ? "IPL" : "RUNTIME");

    // Determine if target is a master
    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_PROC_SBE_MASTER_CHIP, i_target,
                           l_masterProc),
             "Error from FAPI_ATTR_GET (ATTR_PROC_SBE_MASTER_CHIP)");

    // Set I2C bit rate in scratch2 register
    FAPI_TRY(p9_sbe_i2c_bit_rate_divisor_setting(i_target, l_masterProc),
             "Error from p9_sbe_i2c_bit_rate_divisor_setting()");

    // Setup correct bit positions depending on SBE restart mode
    if (i_restart_ipl == true)
    {
        // SBE restart IPL code execution
        l_startVectorBit = PERV_SB_CS_START_RESTART_VECTOR0;
        l_scratch3_bitToClear = SCRATCH_3_REG_RUNTIME_MODE_BIT;
        l_scratch3_bitToSet   = SCRATCH_3_REG_IPL_MODE_BIT;
    }
    else
    {
        // SBE restart RUNTIME code execution
        l_startVectorBit = PERV_SB_CS_START_RESTART_VECTOR1;
        l_scratch3_bitToClear = SCRATCH_3_REG_IPL_MODE_BIT;
        l_scratch3_bitToSet   = SCRATCH_3_REG_RUNTIME_MODE_BIT;
    }

    // Must do SCOM access for master; CFAM access for slaves
#ifndef __HOSTBOOT_RUNTIME

    if (l_masterProc)
#endif
    {
        // Clear Self Boot message reg
        l_data64.flush<0>();
        FAPI_TRY(fapi2::putScom(i_target, PERV_SB_MSG_SCOM, l_data64),
                 "Error from putScom to PERV_SB_MSG_SCOM");

        // Set MBOX scratch_3 register to indicate IPL/Runtime
        FAPI_TRY(fapi2::getScom(i_target, PERV_SCRATCH_REGISTER_3_SCOM, l_data64),
                 "Error from getScom to PERV_SCRATCH_REGISTER_3_SCOM");
        FAPI_TRY(l_data64.clearBit(l_scratch3_bitToClear));
        FAPI_TRY(l_data64.setBit(l_scratch3_bitToSet));
        FAPI_TRY(fapi2::putScom(i_target, PERV_SCRATCH_REGISTER_3_SCOM, l_data64),
                 "Error from putScom to PERV_SCRATCH_REGISTER_3_SCOM");

        // HRESET
        FAPI_TRY(fapi2::getScom(i_target, PERV_SB_CS_SCOM, l_data64),
                 "Error from getScom to PERV_SB_CS_SCOM");

        // Disable HW i2c seeprom reset sequncer
        FAPI_TRY(l_data64.setBit(PERV_SB_CS_BYPASSING_RESET_SEQUENCE_PIB_I2CM));
        FAPI_TRY(l_data64.clearBit(PERV_SB_CS_START_RESTART_VECTOR0));
        FAPI_TRY(l_data64.clearBit(PERV_SB_CS_START_RESTART_VECTOR1));
        FAPI_TRY(fapi2::putScom(i_target, PERV_SB_CS_SCOM, l_data64),
                 "Error from putScom to PERV_SB_CS_SCOM (1)");

        FAPI_TRY(l_data64.setBit(l_startVectorBit));
        FAPI_TRY(fapi2::putScom(i_target, PERV_SB_CS_SCOM, l_data64),
                 "Error from putScom to PERV_SB_CS_SCOM (2)");
    }

#ifndef __HOSTBOOT_RUNTIME
    else
    {
        // Clear Self Boot message reg
        l_data32.flush<0>();
        FAPI_TRY(fapi2::putCfamRegister(i_target, PERV_SB_MSG_FSI, l_data32));

        // Set MBOX scratch_3 register to indicate IPL/Runtime
        FAPI_TRY(fapi2::getCfamRegister(i_target, PERV_SCRATCH_REGISTER_3_FSI,
                                        l_data32));
        FAPI_TRY(l_data32.clearBit(l_scratch3_bitToClear));
        FAPI_TRY(l_data32.setBit(l_scratch3_bitToSet));
        FAPI_TRY(fapi2::putCfamRegister(i_target, PERV_SCRATCH_REGISTER_3_FSI,
                                        l_data32));

        // HRESET
        FAPI_TRY(fapi2::getCfamRegister(i_target, PERV_SB_CS_FSI, l_data32),
                 "Error from getCfamRegister to PERV_SB_CS_FSI");
        // Disable HW i2c seeprom reset sequncer
        FAPI_TRY(l_data32.setBit(PERV_SB_CS_BYPASSING_RESET_SEQUENCE_PIB_I2CM));
        FAPI_TRY(l_data32.clearBit(PERV_SB_CS_START_RESTART_VECTOR0));
        FAPI_TRY(l_data32.clearBit(PERV_SB_CS_START_RESTART_VECTOR1));
        FAPI_TRY(fapi2::putCfamRegister(i_target, PERV_SB_CS_FSI, l_data32),
                 "Error from putCfamRegister to PERV_SB_CS_FSI (1)");

        FAPI_TRY(l_data32.setBit(l_startVectorBit));
        FAPI_TRY(fapi2::putCfamRegister(i_target, PERV_SB_CS_FSI, l_data32),
                 "Error from putCfamRegister to PERV_SB_CS_FSI (2)");

    }

#endif

fapi_try_exit:
    FAPI_INF("p9_sbe_hreset: Exiting ...");
    return fapi2::current_err;
}
OpenPOWER on IntegriCloud