summaryrefslogtreecommitdiffstats
path: root/sbe/sbefw/sbeFFDC.H
blob: 885337dd0160ae2d9f5838d711409340fc859db0 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: sbe/sbefw/sbeFFDC.H $                                         */
/*                                                                        */
/* OpenPOWER sbe 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 __SBE_FFDC_H
#define __SBE_FFDC_H

#include "fapi2.H"
#include "plat_attributes.H"
#include "pk_trace.h"
#include "sbeFFDCType.H"
#include "sbeSpMsg.H"


//Since maximum error log supported in HB is 4KB
#define SBE_FFDC_MAX_LENGTH     0x1000

//PIBMEM attribute dump
extern G_sbe_attrs_t G_sbe_attrs;

//Configuration of user data blobs present in SBE FFDC
//Data is sent in the order defined here
//Definition - Identifier
//             length of the blob
//             pointer to the data
constexpr sbeFFDCUserData_t sbeFFDCUserDataArray[] =
                                              {{{SBE_FFDC_TRACE_DUMP,
                                                sizeof(PkTraceBuffer)},
                                                (const void *)&g_pk_trace_buf,
                                                },
                                               {{SBE_FFDC_ATTR_DUMP,
                                                sizeof(G_sbe_attrs_t)},
                                                (const void *)&G_sbe_attrs,
                                                },
                                              };
#define SBE_FFDC_NUM_USER_DATA (sizeof(sbeFFDCUserDataArray)/\
                                sizeof(sbeFFDCUserData_t))

//Compile time usage - to derive the sum of all user data
//as defined in sbeFFDCUserDataArray
constexpr uint16_t getMaxFFDCUserDataLength(int8_t index)
{
    return index<0 ? 0 : sbeFFDCUserDataArray[index].userDataId.fieldLen +\
                                            getMaxFFDCUserDataLength(index-1);
}


//SBE internal FFDC package singleton class
class SbeFFDCPackage
{
private:
    //Disable copy constructor
    SbeFFDCPackage(SbeFFDCPackage const &) = delete;
    //Disable assignment operator
    SbeFFDCPackage& operator=(SbeFFDCPackage const &) = delete;

    sbeResponseFfdc_t iv_sbeFFDCHeader;
    //FFDC user data header
    sbeFFDCDataHeader_t iv_sbeFFDCDataHeader;

public:
    /*ctor
     *
     */
    SbeFFDCPackage()
    {
        //Making sure data is indeed aligned
        static_assert((sizeof(G_sbe_attrs_t) % 4) == 0,
                        "G_sbe_attrs not 4byte aligned");
        static_assert((sizeof(PkTraceBuffer) % 4) == 0,
                        "g_pk_trace_buf not 4byte aligned");

        iv_sbeFFDCHeader.magicBytes = 0xFFDC;
        iv_sbeFFDCHeader.fapiRc = fapi2::FAPI2_RC_PLAT_ERR_SEE_DATA;

        iv_sbeFFDCDataHeader.primaryStatus = SBE_PRI_OPERATION_SUCCESSFUL;
        iv_sbeFFDCDataHeader.secondaryStatus = SBE_SEC_OPERATION_SUCCESSFUL;

        //Making sure that the maximum length of FFDC package
        //can be accomodated
        static_assert((sizeof(sbeResponseFfdc_t) + sizeof(sbeFFDCDataHeader_t) +
                       getMaxFFDCUserDataLength(SBE_FFDC_NUM_USER_DATA-1)) \
                       <= SBE_FFDC_MAX_LENGTH,
                        "length of FFDC package must never exceed"
                        "SBE_FFDC_MAX_LENGTH ");
        //length and dumpFields will be filled up depending on the fields
        //to be sent in send APIs
        iv_sbeFFDCDataHeader.dumpFields = {0};
    }
    /*
     * @brief sendOverFIFO - method to pack and send SBE internal FFDC
     *                       only if isSendInternalFFDCSet() is true
     *                       over FIFO interface
     * @param[in] i_primStatus   - Primary status of Chip op
     * @param[in] i_secStatus    - Secondary status of Chip op
     * @param[in] i_fieldsConfig - bitmap indicating the field
     *                             to be sent in FFDC
     *
     * @param[out] o_bytesSent -number of bytes sent
     *
     * @return - SBE secondary RC
     */
    uint32_t sendOverFIFO(uint32_t i_primStatus,
                          uint32_t i_secStatus,
                          uint32_t i_fieldsConfig,
                          uint32_t &o_bytesSent);

    /*
     * @brief sendOverHOST - method to pack and send SBE internal FFDC
     *                       only if isSendInternalFFDCSet() is true
     *                       over HOST interface
     *
     * @param[in] i_primStatus   - Primary status of Chip op
     * @param[in] i_secStatus    - Secondary status of Chip op
     * @param[in] i_fieldsConfig - bitmap indicating the field
     *                             to be sent in FFDC
     *
     * @param[out] o_bytesSent - number of bytes sent
     *
     * @return - SBE secondary RC
     */
    //uint32_t sendOverHOST(uint32_t i_primStatus,
    //                      uint32_t i_secStatus,
    //                      uint32_t i_fieldsConfig,
    //                      uint32_t &o_bytesSent) {};
};

#endif //__SBE_FFDC_H
OpenPOWER on IntegriCloud