summaryrefslogtreecommitdiffstats
path: root/src/usr/hwas/common/hwasCallout.C
blob: 588833572f6bae1d50f453cb8e3ca38e7a040cdf (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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwas/common/hwasCallout.C $                           */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2012,2018                        */
/* [+] Google Inc.                                                        */
/* [+] 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 hwasCallout.C
 *
 *  HardWare Availability Service Callout functions.
 *
 */


/******************************************************************************/
// Includes
/******************************************************************************/
#include <stdint.h>

#include <hwas/common/hwasError.H>
#include <hwas/common/hwasCommon.H>
#include <hwas/common/deconfigGard.H>
#include <hwas/common/hwasCallout.H>
#include <hwas/common/hwas_reasoncodes.H>
#include <targeting/common/attributes.H>

namespace HWAS
{

#ifdef __HOSTBOOT_RUNTIME // defined in hwas.C
HWAS_TD_t g_trac_imp_hwas   = NULL; // important - slow
TRAC_INIT(&g_trac_imp_hwas, "HWAS_I",   KILOBYTE );
HWAS_TD_t g_trac_dbg_hwas   = NULL; // fast debug
TRAC_INIT(&g_trac_dbg_hwas, "HWAS",   KILOBYTE );
#endif

using namespace HWAS::COMMON;

bool retrieveTarget(uint8_t * & io_uData,
                    TARGETING::Target * & o_pTarget, errlHndl_t i_errl)
{
    bool l_err = false;

    // data is either a token indicating it's the
    // MASTER_PROCESSOR_CHIP_TARGET_SENTINEL
    // or it's the EntityPath - getAttr<TARGETING::ATTR_PHYS_PATH>()
    if (*io_uData != TARGET_IS_SENTINEL)
    {
        // convert the EntityPath to a Target pointer
        TARGETING::EntityPath ep, *ep_ptr;
        ep_ptr = (TARGETING::EntityPath *)io_uData;
        // size is total EntityPath size minus unused path elements
        uint32_t size = sizeof(*ep_ptr) -
                (TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep_ptr->size()) *
                    sizeof(TARGETING::EntityPath::PathElement);
        memcpy(&ep, io_uData, size);
        o_pTarget = TARGETING::targetService().toTarget(ep);
        io_uData += size;

        if (unlikely(o_pTarget == NULL))
        {   // only happen if we have a corrupt errlog or targeting.
            HWAS_ERR("HW callout; o_pTarget was NULL!!!");
#ifndef __HOSTBOOT_RUNTIME
            /*@
             * @errortype
             * @moduleid     HWAS::MOD_PROCESS_CALLOUT
             * @reasoncode   HWAS::RC_INVALID_TARGET
             * @devdesc      Invalid target encountered in
             *               processing of HW callout
             * @userdata1    callout errlog PLID
             */
            errlHndl_t errl = hwasError(
                        ERRL_SEV_INFORMATIONAL,
                        HWAS::MOD_PROCESS_CALLOUT,
                        HWAS::RC_INVALID_TARGET,
                        i_errl->plid());
            errlCommit(errl, HWAS_COMP_ID);
#endif
            l_err = true;
        }
    }
    else
    {   // convert this to the real master processor
        TARGETING::targetService().masterProcChipTargetHandle(o_pTarget);
        io_uData += sizeof(HWAS::TARGET_IS_SENTINEL);
    }
    return l_err;
}

#ifndef __HOSTBOOT_RUNTIME
void processCallout(errlHndl_t &io_errl,
        uint8_t *i_pData,
        uint64_t i_Size,
        bool i_DeferredOnly)
{
    callout_ud_t *pCalloutUD = (callout_ud_t *)i_pData;
    HWAS_DBG("processCallout entry. data %p size %lld type 0x%x",
            i_pData, i_Size, pCalloutUD->type);

    if (i_DeferredOnly)
    {
        if ((pCalloutUD->type == HW_CALLOUT) &&
            (pCalloutUD->deconfigState == DELAYED_DECONFIG))
        {
            TARGETING::Target *pTarget = NULL;
            uint8_t * l_uData = (uint8_t *)(pCalloutUD + 1);
            bool l_err = retrieveTarget(l_uData, pTarget, io_errl);

            if (!l_err)
            {
                HWAS::theDeconfigGard().registerDeferredDeconfigure(
                            *pTarget, io_errl->eid());
            }
        }
        // else, no deferred deconfigures - all good.
    }
    else
    switch (pCalloutUD->type)
    {
        case (HW_CALLOUT):
        {
            TARGETING::Target *pTarget = NULL;
            uint8_t * l_uData = (uint8_t *)(pCalloutUD + 1);
            bool l_err = retrieveTarget(l_uData, pTarget, io_errl);

            if (!l_err)
            {
                errlHndl_t errl = platHandleHWCallout(
                                        pTarget,
                                        pCalloutUD->priority,
                                        pCalloutUD->deconfigState,
                                        io_errl,
                                        pCalloutUD->gardErrorType);
                if (errl)
                {
                    HWAS_ERR("processCallout: error from platHandlHWCallout");
                    errlCommit(errl, HWAS_COMP_ID);
                }
            }
            break;
        } // HW_CALLOUT
        case (PROCEDURE_CALLOUT):
        {
            HWAS_INF("Procedure callout; proc 0x%x priority 0x%x",
                pCalloutUD->procedure, pCalloutUD->priority);

            errlHndl_t errl = platHandleProcedureCallout(io_errl,
                            pCalloutUD->procedure, pCalloutUD->priority);
            if (errl)
            {
                HWAS_ERR("processCallout: error from platHandlProcedureCallout");
                errlCommit(errl, HWAS_COMP_ID);
            }
            break;
        } // PROCEDURE_CALLOUT
        case (BUS_CALLOUT):
        {
            TARGETING::Target *pTarget1 = NULL;
            TARGETING::Target *pTarget2 = NULL;

            uint8_t * l_targetData = (uint8_t *)(pCalloutUD + 1);
            bool l_err1 = retrieveTarget(l_targetData, pTarget1, io_errl);
            bool l_err2 = retrieveTarget(l_targetData, pTarget2, io_errl);

            if (!l_err1 && !l_err2)
            {
                errlHndl_t errl = platHandleBusCallout(
                                        pTarget1, pTarget2,
                                        pCalloutUD->busType,
                                        pCalloutUD->priority,
                                        io_errl);
                if (errl)
                {
                    HWAS_ERR("processCallout: error from platHandlBusCallout");
                    errlCommit(errl, HWAS_COMP_ID);
                }
            }
            break;
        } // BUS_CALLOUT
        case (CLOCK_CALLOUT):
        {
            TARGETING::Target *pTarget = NULL;
            uint8_t * l_uData = (uint8_t *)(pCalloutUD + 1);
            bool l_err = retrieveTarget(l_uData, pTarget, io_errl);

            if (!l_err)
            {
                errlHndl_t errl = platHandleClockCallout(
                                        pTarget,
                                        pCalloutUD->clockType,
                                        pCalloutUD->priority,
                                        io_errl,
                                        pCalloutUD->clkDeconfigState,
                                        pCalloutUD->clkGardErrorType);
                if (errl)
                {
                    HWAS_ERR("processCallout: error from platHandleClockCallout");
                    errlCommit(errl, HWAS_COMP_ID);
                }
            }
            break;
        } // CLOCK_CALLOUT
        case (PART_CALLOUT):
        {
            TARGETING::Target *pTarget = NULL;
            uint8_t * l_uData = (uint8_t *)(pCalloutUD + 1);
            bool l_err = retrieveTarget(l_uData, pTarget, io_errl);

            if (!l_err)
            {
                errlHndl_t errl = platHandlePartCallout(
                                        pTarget,
                                        pCalloutUD->partType,
                                        pCalloutUD->priority,
                                        io_errl,
                                        pCalloutUD->deconfigState,
                                        pCalloutUD->gardErrorType);
                if (errl)
                {
                    HWAS_ERR("processCallout: error platHandlePartCallout");
                    errlCommit(errl, HWAS_COMP_ID);
                }
            }
            break;
        } // PART_CALLOUT

        default:
        {
            HWAS_ERR("bad data in Callout UD %x", pCalloutUD->type);
            break;
        }
    } // switch

    HWAS_DBG("processCallout exit");
} // processCallout

#endif

}; // end namespace
OpenPOWER on IntegriCloud