summaryrefslogtreecommitdiffstats
path: root/sbe/sbefw/sbeFFDC.H
diff options
context:
space:
mode:
Diffstat (limited to 'sbe/sbefw/sbeFFDC.H')
-rw-r--r--sbe/sbefw/sbeFFDC.H148
1 files changed, 148 insertions, 0 deletions
diff --git a/sbe/sbefw/sbeFFDC.H b/sbe/sbefw/sbeFFDC.H
new file mode 100644
index 00000000..885337dd
--- /dev/null
+++ b/sbe/sbefw/sbeFFDC.H
@@ -0,0 +1,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