summaryrefslogtreecommitdiffstats
path: root/src/sbefw/core/sbeutil.H
blob: 08e6fe0b77ba06fa9e7836041e78dd3ea4f0a2e2 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/sbefw/core/sbeutil.H $                                    */
/*                                                                        */
/* OpenPOWER sbe Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
/* [+] 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                                                     */
#ifndef SBE_UTIL_H
#define SBE_UTIL_H
#ifdef __cplusplus
extern "C" {
#endif

#include "pk.h"
#include "pk_api.h"

#ifdef __cplusplus
}
#endif

#define MASK_ZERO_L32B_UINT64(x)    ((x) & 0xFFFFFFFF00000000ull)
#define MASK_ZERO_H32B_UINT64(x)    ((x) & 0x00000000FFFFFFFFull)
#define SHIFT_RIGHT(x, bits)        ((x) >> bits)

// Macros Defined for Internal RC Check, Break if Error
#define CHECK_SBE_RC_AND_BREAK_IF_NOT_SUCCESS(l_rc) \
if ((l_rc) != SBE_SEC_OPERATION_SUCCESSFUL) \
{ \
    break; \
}

#define CHECK_SBE_SECURITY_RC_AND_BREAK_IF_NOT_SUCCESS(addr, op, resp, mask) \
if (!SBE_SECURITY::isAllowed(addr,mask,op)) \
{ \
    /* TODO via RTC 180983:Enable this once the BL/WL registers are settled */ \
    if(SbeRegAccess::theSbeRegAccess().disableScomFiltering()) \
    { \
        /* security override possible && scom filtering disabled */ \
        resp->setStatus(SBE_PRI_UNSECURE_ACCESS_DENIED, \
                        SBE_SEC_BLACKLISTED_REG_ACCESS); \
    } \
    else \
    { \
        resp->setStatus(SBE_PRI_UNSECURE_ACCESS_DENIED, \
                        SBE_SEC_BLACKLISTED_REG_ACCESS_BLOCKED); \
        break; \
    } \
}

#define mfdec()                               \
    ({volatile uint32_t l_dec;                          \
        asm volatile ("mfdec %0" : "=r" (l_dec)); \
        l_dec;})

// To handle unused variables compilation error
static inline void UNUSED(int dummy, ...) {}

// Magic instruction

/** @brief  This is a special assembler instruction that is a nop on
 *  regular hardware, but has special meaning to Simics.  Code that
 *  executes this instruction in Simics will cause a "hap," a
 *  Simics term.  If there is no hap handler registered, and magic
 *  breakpoints have not been enabled with
 *      simics> enable-magic-breakpoint
 *  then this instruction is also a nop in Simics.
 *
 *  If magic breakpoints are enabled, and there is no hap handler, then
 *  when SBE code executes this instruction in Simics, Simics will
 *  stop the simulation. (Prompt changes from running> to simics> )
 *
 *  If a hap is registered, then Simics will call the hap handler.  Hap
 *  handlers are written in Python, and the best place for them is
 *
 *     src/tools/debug//simics-debug-framework.py
 *
 *  Sample code to register the hap handler:
 *        # arg contains the integer parameter n passed to MAGIC_INSTRUCTION(n)
 *        def magic_instruction_callback(user_arg, cpu, arg):
 *            # print to console works...
 *            print "Hit magic instruction ", arg
 *            # Or else stop the simulation...
 *            SIM_break_simulation( "Stopped at magic instruction" )
 *
 *        # Register the magic instruction callback.
 *        SIM_hap_add_callback( "Core_Magic_Instruction",
 *                              magic_instruction_callback, None )
 *
 *        # Better to register the SBE range 8000-8190
 *        # so that PHYP and others won't be affected.
 *        SIM_hap_add_callback_range( "Core_Magic_Instruction",
 *                      magic_instruction_callback, None, 8000, 8190 )
 *
 *  The argument n is an integer from 0..8191 which Simics passes to the hap
 *  handler in parameter 3, or "arg" in the sample code above.
 */
__attribute__((always_inline))
inline void SBE_MAGIC_INSTRUCTION(int _n)
{
    register int n = _n;
    asm volatile("rlwimi %0,%0,0,%1,%2"       \
        :: "i" (((n) >> 8) & 0x1f),           \
        "i" (((n) >> 4) & 0xf),               \
        "i" ((((n) >> 0) & 0xf) | 16));
}

// Macro to execute HWP
#ifdef SEEPROM_IMAGE
#define SBE_EXEC_HWP_NOARG(...) SBE_EXEC_HWP(__VA_ARGS__)
#define SBE_EXEC_HWP(fapiRc, hwp, ...) \
{ \
    fapiRc = hwp(__VA_ARGS__); \
}
#else
#define SBE_EXEC_HWP_NOARG(fapiRc, hwp) \
{ \
    SBE_INFO("Procedure not present in the image:No-Op"); \
    fapiRc = FAPI2_RC_SUCCESS; \
}
#define SBE_EXEC_HWP(fapiRc, hwp, ...) \
{ \
    /* handling unused variables */ \
    UNUSED(0, __VA_ARGS__); \
    SBE_INFO("Procedure not present in the image:No-Op"); \
    fapiRc = FAPI2_RC_SUCCESS; \
}
#endif

void sbeHandleFifoResponse (const uint32_t i_rc);

void sbeHandlePsuResponse (const uint32_t i_rc);

namespace SBE
{

    // enum for magic instructions
    enum
    {
        MAGIC_SIMICS_CHECK = 8000, // check if code is running on simics
    };
    // Nest to SBE frequency ratio
    static const uint8_t  SBE_TO_NEST_FREQ_FACTOR = 4;

    // Currently PK does not define start range for app
    // specifc panic code as enum. It is implicit understanding
    // through code comments. Expectation is 0x1cxx range is for
    // non-pk code.
    static const uint32_t PK_APP_OFFSET_SBE_START = 0x1c00;
    enum
    {
        // For defining new panic codes refer to pk/ppe42/pk_panic_codes.h
        PANIC_ASSERT = PK_APP_OFFSET_SBE_START
    };

    /*@brief - Get higher 32bit number from uint64
     *
     * @param[in] - i_lWord - 64bit long word
     *
     * @return - uint32_t word
     */
    inline uint32_t higher32BWord(uint64_t i_lWord)
    {
        return (uint32_t)(SHIFT_RIGHT(MASK_ZERO_L32B_UINT64(i_lWord), 32));
    }

    /*@brief - Get lower 32bit number from uint64
     *
     * @param[in] - i_lWord - 64bit long word
     *
     * @return - uint32_t word
     */
    inline uint32_t lower32BWord(uint64_t i_lWord)
    {
        return (uint32_t)(MASK_ZERO_H32B_UINT64(i_lWord));
    }

    /*@brief - checks if sbe is running on simics
     *
     * @return - True if sbe is running on simics , false otherwise
     */
    bool isSimicsRunning();

    /*@brief - Update the pk frequcy as per NEST PLL bucket
     *
     * @return - void
     */
    void updatePkFreq();

    /* @brief - Check if the boot is on HRESET of SBE
     *
     * @return - True if HRESET, false otherwise
     */
    bool isHreset(void);

    /* @brief - Clear HRESET BIT
     *
     * @return - void
     */
    void clearHresetBit(void);

} // namespace SBE
#endif //SBE_UTIL_H
OpenPOWER on IntegriCloud