summaryrefslogtreecommitdiffstats
path: root/src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_dpll_setup.C
blob: 923a4b3d2be1ce147bb8c8a693650ee8be8dbcc4 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/cache/p9_hcd_cache_dpll_setup.C $ */
/*                                                                        */
/* OpenPOWER sbe Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,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_hcd_cache_dpll_setup.C
/// @brief Quad DPLL Setup
///
/// Procedure Summary:
///   Note:
///     Initfiles in procedure defined on VBU ENGD wiki (TODO add link)
///     DPLL tune bits are not dependent on frequency
///     Frequency is controlled by the Quad PPM
///       Actual frequency value for boot is stored into the Quad PPM by
///         p9_hcd_setup_evid.C in istep 2
///       In real cache STOP exit, the frequency value is persistent
///
///   Pre-Scan:
///
///   Scan:
///     (TODO) Set clock controller scan ratio to 1:1 as this is done at refclk
///     (TODO) scan0 (region = DPLL and ANEP, scan_type = GPTR)
///     (TODO) scan0 (region = DPLL and ANEP, scan_type = FUNC)
///     (TODO) Set clock controller scan ratio to 8:1 for future scans
///
///   Setup:
///     (TODO) set DPLL FREQ CTRL regitster
///     (TODO) set DPLL CTRL register
///     (Done) Drop DPLL test mode;
///     (Done) Drop DPLL into Reset;
///     (Done) Start DPLL clock via quad clock controller
///     (Done) Check for DPLL lock, Timeout: 200us
///     (Done) Remove DPLL bypass
///     (Done) Switch cache glitchless mux to use the DPLL
///     (Done) Drop ff_bypass to enable slewing
///
/// 1) reset, dpll_func_clksel, and all SL_HLD inputs are asserted
/// 2) If grid clock connected to dpll clkout,
///    bypass also has to be asserted to allow refclk on grid

// *HWP HWP Owner          : David Du       <daviddu@us.ibm.com>
// *HWP Backup HWP Owner   : Greg Still     <stillgs@us.ibm.com>
// *HWP FW Owner           : Sangeetha T S  <sangeet2@in.ibm.com>
// *HWP Team               : PM
// *HWP Consumed by        : SBE:SGPE
// *HWP Level              : 2

//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------

#include <p9_quad_scom_addresses.H>
#include <p9_perv_sbe_cmn.H>
#include <p9_hcd_common.H>
#include "p9_hcd_cache_dpll_setup.H"

//-----------------------------------------------------------------------------
// Constant Definitions
//-----------------------------------------------------------------------------

enum P9_HCD_CACHE_DPLL_SETUP_CONSTANTS
{
    CACHE_DPLL_LOCK_TIMEOUT_IN_MS      = 1,
    CACHE_DPLL_CLK_START_TIMEOUT_IN_MS = 1,
    CACHE_ANEP_CLK_START_TIMEOUT_IN_MS = 1
};

//-----------------------------------------------------------------------------
// Procedure: Quad DPLL Setup
//-----------------------------------------------------------------------------

fapi2::ReturnCode
p9_hcd_cache_dpll_setup(
    const fapi2::Target<fapi2::TARGET_TYPE_EQ>& i_target)
{
    FAPI_INF(">>p9_hcd_cache_dpll_setup");
    fapi2::buffer<uint64_t>                  l_data64;
    uint8_t                                  l_dpll_bypass;
    uint32_t                                 l_timeout;
    auto l_parent_chip = i_target.getParent<fapi2::TARGET_TYPE_PROC_CHIP>();

#ifndef __PPE__
    uint8_t                                  l_attr_is_simulation;

    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_IS_SIMULATION,
                           fapi2::Target<fapi2::TARGET_TYPE_SYSTEM>(),
                           l_attr_is_simulation));
#endif

    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_DPLL_BYPASS, l_parent_chip, l_dpll_bypass),
             "Error from FAPI_ATTR_GET (ATTR_DPLL_BYPASS)");

    //----------------------------
    // Prepare to start DPLL clock
    //----------------------------

    FAPI_DBG("Assert DPLL in mode 1,set slew rate via QPPM_DPLL_CTRL[2,6-15]");
    l_data64.flush<0>().setBit<2>().insertFromRight<6, 10>(0x40);
    FAPI_TRY(putScom(i_target, EQ_QPPM_DPLL_CTRL_OR, l_data64));

    FAPI_DBG("Drop flushmode_inhibit via CPLT_CTRL0[2]");
    FAPI_TRY(putScom(i_target, EQ_CPLT_CTRL0_CLEAR, MASK_SET(2)));

    if (l_dpll_bypass == 0)
    {
        FAPI_DBG("Drop DPLL test mode and reset via NET_CTRL0[3,4]");
        FAPI_TRY(putScom(i_target, EQ_NET_CTRL0_WAND, MASK_AND(3, 2, 0)));
    }

    FAPI_DBG("Drop ANEP+DPLL clock region fences via NET_CTRL1[10, 14]");
    FAPI_TRY(putScom(i_target, EQ_CPLT_CTRL1_CLEAR, MASK_CLR(10, 5, 0x11)));

    // ----------------
    // Start DPLL clock
    // ----------------

    FAPI_DBG("Clear all bits prior start DPLL clock via SCAN_REGION_TYPE");
    FAPI_TRY(putScom(i_target, EQ_SCAN_REGION_TYPE, MASK_ZERO));

    FAPI_DBG("Start DPLL clock via CLK_REGION");
    l_data64 = (p9hcd::CLK_START_CMD   |
                p9hcd::CLK_REGION_DPLL |
                p9hcd::CLK_THOLD_ALL);
    FAPI_TRY(putScom(i_target, EQ_CLK_REGION, l_data64));

    FAPI_DBG("Poll for DPLL clock running via CPLT_STAT0[8]");
    l_timeout = (p9hcd::CYCLES_PER_MS / p9hcd::INSTS_PER_POLL_LOOP) *
                CACHE_DPLL_CLK_START_TIMEOUT_IN_MS;

    do
    {
        FAPI_TRY(getScom(i_target, EQ_CPLT_STAT0, l_data64));
    }
    while((l_data64.getBit<8>() != 1) && ((--l_timeout) != 0));

    FAPI_ASSERT((l_timeout != 0),
                fapi2::PMPROC_DPLLCLKSTART_TIMEOUT().set_EQCPLTSTAT(l_data64),
                "DPLL Clock Start Timeout");

    FAPI_DBG("Check DPLL clock running via CLOCK_STAT_SL[14]");
    FAPI_TRY(getScom(i_target, EQ_CLOCK_STAT_SL, l_data64));

    FAPI_ASSERT((l_data64.getBit<14>() == 0),
                fapi2::PMPROC_DPLLCLKSTART_FAILED().set_EQCLKSTAT(l_data64),
                "DPLL Clock Start Failed");
    FAPI_DBG("DPLL clock running now");

    // This is necessary to ensure that the DPLL is in Mode 1(ff_bypass = 1)
    // If not, the lock times will go from ~30us to 3-5ms
    if (l_dpll_bypass == 0)
    {
        FAPI_DBG("Poll for DPLL to lock via QPPM_DPLL_STAT");
        l_timeout = (p9hcd::CYCLES_PER_MS / p9hcd::INSTS_PER_POLL_LOOP) *
                    CACHE_DPLL_LOCK_TIMEOUT_IN_MS;

        do
        {
            FAPI_TRY(getScom(i_target, EQ_QPPM_DPLL_STAT, l_data64));

#ifndef __PPE__

            if (l_attr_is_simulation)
            {
                FAPI_DBG("Skipping DPLL lock check in Sim");
                break;
            }

#else
#ifdef SIM_DPLL_LOCK_CHK
            FAPI_DBG("Skipping DPLL lock check in Sim");
            break;
#endif
#endif

        }
        while ((l_data64.getBit<63>() != 1 ) && (--l_timeout != 0));

        FAPI_ASSERT((l_timeout != 0),
                    fapi2::PMPROC_DPLL_LOCK_TIMEOUT()
                    .set_EQQPPMDPLLSTAT(l_data64),
                    "DPLL Lock Timeout");
        FAPI_DBG("DPLL is locked now");

        FAPI_DBG("Drop DPLL bypass via NET_CTRL0[5]");
        FAPI_TRY(putScom(i_target, EQ_NET_CTRL0_WAND, MASK_UNSET(5)));

        FAPI_DBG("Drop DPLL ff_bypass via QPPM_DPLL_CTRL[2]");
        FAPI_TRY(putScom(i_target, EQ_QPPM_DPLL_CTRL_CLEAR, MASK_SET(2)));
    }

    //--------------------------
    // Cleaning up
    //--------------------------

    FAPI_DBG("Assert flushmode_inhibit via CPLT_CTRL0[2]");
    FAPI_TRY(putScom(i_target, EQ_CPLT_CTRL0_OR, MASK_SET(2)));

    if (l_dpll_bypass == 0)
    {
        FAPI_DBG("Set scan ratio to 4:1 in non-bypass mode via OPCG_ALIGN[47-51]");
        FAPI_TRY(getScom(i_target, EQ_OPCG_ALIGN, l_data64));
        l_data64.insertFromRight<47, 5>(0x3);
        FAPI_TRY(putScom(i_target, EQ_OPCG_ALIGN, l_data64));
    }

    FAPI_DBG("Drop skew/duty cycle adjust func_clksel via NET_CTRL0[22]");
    FAPI_TRY(putScom(i_target, EQ_NET_CTRL0_WAND, MASK_UNSET(22)));

fapi_try_exit:

    FAPI_INF("<<p9_hcd_cache_dpll_setup");
    return fapi2::current_err;
}



OpenPOWER on IntegriCloud