summaryrefslogtreecommitdiffstats
path: root/src/usr/isteps/pm/pm_common.H
blob: 567152dce45c3ed4227079aba6dfc6042025553f (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/isteps/pm/pm_common.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                                                     */
#ifndef PM_COMMON_H
#define PM_COMMON_H

#include <limits.h>
#include <errl/errlentry.H>
#include <util/utillidmgr.H>
#include <diag/prdf/prdfWriteHomerFirData.H>

namespace HBPM
{
    /*
     * @brief Host config data consumed by OCC
     */
    struct occHostConfigDataArea_t
    {
        uint32_t version;

        //For computation of timebase frequency
        uint32_t nestFrequency;

        // For determining the interrupt type to Host
        //  0x00000000 = Use FSI2HOST Mailbox
        //  0x00000001 = Use OCC interrupt line through PSIHB complex
        uint32_t interruptType;

        // For informing OCC if it is the FIR master:
        //  0x00000000 = Default
        //  0x00000001 = FIR Master
        uint32_t firMaster;

        // FIR collection configuration data needed by FIR Master
        //  OCC in the event of a checkstop
        uint8_t firdataConfig[3072];
    };

    enum
    {
        OccHostDataVersion = 0x00000090,

        OCC_IBSCOM_RANGE_IN_MB = MEGABYTE,

        // Interrupt Types
        USE_FSI2HOST_MAILBOX = 0x00000000,
        USE_PSIHB_COMPLEX    = 0x00000001,

        // FIR Master
        NOT_FIR_MASTER = 0x00000000,
        IS_FIR_MASTER  = 0x00000001,

        // Mask off bit zero
        PHYSICAL_ADDR_MASK = 0x7FFFFFFFFFFFFFFF,
        VER_EYECATCH       = 0x56455253494F4E00, //'VERSION\0'
    };

    /**
     * @brief Build new Pstate Parameter Block for PGPE and CME
     *
     * @param[in] i_target:       Target processor
     * @param[in] i_homer:        Virtual address of current proc's HOMER
     *
     * @return errlHndl_t  Error log Pstate Parameter Block build failed
     */
    errlHndl_t pstateParameterBuild( TARGETING::Target* i_target,
                                     void* i_homer);

    /**
     * @brief Sets up OCC Host data in Homer
     *
     * @param[in] i_proc:         target processor to load
     * @param[in] i_occHostDataVirtAddr Virtual
     *                       address of current
     *                       proc's Host data area.
     *
     * @return errlHndl_t  Error log Host data setup failed
     */
    errlHndl_t loadHostDataToHomer(TARGETING::Target* i_proc,
                                   void* i_occHostDataVirtAddr);

    /**
     * @brief Sets up Hcode in Homer
     *
     * @param[in] i_target:         Target processor
     * @param[in] i_pImageOut:      Pointer to HOMER image buffer
     * @param[in] i_mode            Selects initial load vs concurrent reloads
     * @return errlHndl_t  Error log if loadHcode failed
     */
    errlHndl_t loadHcode( TARGETING::Target* i_target,
                          void* i_pImageOut,
                          uint32_t i_mode );

    /**
     * @brief Execute procedures and steps required to setup for loading
     *        the OCC image in a specified processor
     *
     * @param[in] i_target:         Target processor
     * @param[in] i_occImgPaddr:    Physical address of current
     *                                 proc's OCC image in the homer
     * @param[in] i_occImgVaddr:  Virtual address of current
     *                                 proc's OCC image in the homer
     * @param[in] i_commonPhysAddr: Physical address of common
     *                              OCC region
     * @return errlHndl_t  Error log if loadOCCSetup failed
     */
    errlHndl_t loadOCCSetup(TARGETING::Target* i_target,
                            uint64_t i_occImgPaddr,
                            uint64_t i_occImgVaddr,
                            uint64_t i_commonPhysAddr);

    /**
     * @brief Execute procedures and steps required to load
     *        OCC image in a specified processor
     *
     * @param[in] i_target:         Target processor
     * @param[in] i_occImgPaddr:    Physical address of current
     *                                 proc's OCC image in the homer
     * @param[in] i_occImgVaddr:    Virtual address of current
     *                                 proc's OCC image in the homer
     * @param[in] i_mode            Selects initial load vs concurrent reloads
     * @return errlHndl_t  Error log if loadOCCImageToHomer failed
     */
    errlHndl_t loadOCCImageToHomer(TARGETING::Target* i_target,
                                   uint64_t i_occImgPaddr,
                                   uint64_t i_occImgVaddr,
                                   uint32_t i_mode);

    /**
     * @brief Start PM Complex.
     *
     * @param[in] i_target:    target of processor
     *
     * @return errlHndl_t  Error log of startPMComplex failed
     */
    errlHndl_t startPMComplex (TARGETING::Target* i_target);

    /**
     * @brief Reset PM Complex.
     *
     * @param[in] i_target:    target of processor
     *
     * @return errlHndl_t  Error log of resetPMComplex failed
     */
    errlHndl_t resetPMComplex(TARGETING::Target * i_target);

} //namespace HBPM ends

#endif
OpenPOWER on IntegriCloud