diff options
Diffstat (limited to 'src/sbefw/core/sbeFFDC.H')
| -rw-r--r-- | src/sbefw/core/sbeFFDC.H | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/src/sbefw/core/sbeFFDC.H b/src/sbefw/core/sbeFFDC.H new file mode 100644 index 00000000..2487a1f5 --- /dev/null +++ b/src/sbefw/core/sbeFFDC.H @@ -0,0 +1,148 @@ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/sbefw/core/sbeFFDC.H $ */ +/* */ +/* OpenPOWER sbe Project */ +/* */ +/* Contributors Listed Below - COPYRIGHT 2016,2017 */ +/* */ +/* */ +/* 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" +#include "sbeHostUtils.H" +#include "sbeMemAccessInterface.H" + +//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 +const 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 NUM_USER_DATA_ELE (sizeof(sbeFFDCUserDataArray)/sizeof(sbeFFDCUserData_t)) + +//SBE internal FFDC package 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; + + /* + * @bried updateUserDataHeader - method to update user data fields + * based on input config + * + * @param[in] i_fieldsConfig - input fields configuration + */ + void updateUserDataHeader(uint32_t i_fieldsConfig); + +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.fapiRc = fapi2::FAPI2_RC_PLAT_ERR_SEE_DATA; + + iv_sbeFFDCDataHeader.primaryStatus = SBE_PRI_OPERATION_SUCCESSFUL; + iv_sbeFFDCDataHeader.secondaryStatus = SBE_SEC_OPERATION_SUCCESSFUL; + + //length and dumpFields will be filled up depending on the fields + //to be sent in send APIs + iv_sbeFFDCDataHeader.dumpFields = {0}; + } + + /* + * @brief collectAsyncHwpFfdc - method to check and force collect + * HWP FFDC to SBE global FFDC region, + * asynchronous to the HWP execution + * @return - SBE secondary RC + */ + uint32_t collectAsyncHwpFfdc (void); + + /* + * @brief sendOverFIFO - method to pack and send SBE internal FFDC + * only if isSendInternalFFDCSet() is true + * over FIFO interface + * @param[in] i_hdr - Fifo response header + * @param[in] i_fieldsConfig - bitmap indicating the field + * to be sent in FFDC + * @param[out] o_bytesSent - number of bytes sent + * @param[in] i_skipffdcBitCheck - Boolean to indicate whether + * ffdc bit should be checked or not. + * By default it is false. + * + * @return - SBE secondary RC + */ + uint32_t sendOverFIFO(const sbeRespGenHdr_t &i_hdr, + const uint32_t i_fieldsConfig, + uint32_t &o_bytesSent, + const bool i_skipffdcBitCheck = false); + + /* @brief sendOverHostIntf - method to pack and send SBE internal FFDC + * only if isSendInternalFFDCSet() is true + * over HOST interface + * + * @param[in] i_hdr - Host response header + * @param[in] i_fieldsConfig - bitmap indicating the field + * to be sent in FFDC + * @param[in] i_pMemInterface - pointer to memory interface object + * @param[in] i_allocatedSize - size allocated for FFDC + * @param[in] i_skipffdcBitCheck - Boolean to indicate whether + * ffdc bit should be checked or not. + * By default it is false. + * + * @return - SBE secondary RC + */ + uint32_t sendOverHostIntf(const sbeSbe2PsuRespHdr_t &i_hdr, + const uint32_t i_fieldsConfig, + sbeMemAccessInterface *i_pMemInterface, + uint32_t i_allocatedSize, + const bool i_skipffdcBitCheck = false); +}; + +#endif //__SBE_FFDC_H |
