HWPF: Allow automatic collection of register FFDC data when HWP error created

If HWP Error XML contains an element called <collectRegisterFfdc> which
identifies the registers to collect as FFDC then when the error is
created, those registers are automatically collected and stored in the
error log. Also create Hostboot parsers to parse the data.

Change-Id: I521527b97e0db0c808db81773ba0fe9aa00477ad
RTC: 46029
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/1866
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 68 insertions, 0 deletions

diff --git a/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H b/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H
new file mode 100644
index 000000000..a3c1c46ef
--- /dev/null
+++ b/src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H
@@ -0,0 +1,68 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/include/usr/hwpf/fapi/fapiCollectRegFfdc.H $              */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* COPYRIGHT International Business Machines Corp. 2012                   */
+/*                                                                        */
+/* p1                                                                     */
+/*                                                                        */
+/* Object Code Only (OCO) source materials                                */
+/* Licensed Internal Code Source Materials                                */
+/* IBM HostBoot Licensed Internal Code                                    */
+/*                                                                        */
+/* The source code for this program is not published or otherwise         */
+/* divested of its trade secrets, irrespective of what has been           */
+/* deposited with the U.S. Copyright Office.                              */
+/*                                                                        */
+/* Origin: 30                                                             */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+/**
+ *  @file fapiCollectRegFfdc.H
+ *
+ *  @brief Defines the fapiCollectRegFfdc function that collects chip register
+ *         FFDC data. This is called automatically by FAPI_SET_HWP_ERROR (when
+ *         a HWP creates an error) and FAPI_ADD_INFO_TO_HWP_ERROR (when an FFDC
+ *         HWP adds error information to an existing error) if the error XML
+ *         contains a <collectRegisterFfdc> element. This function should not
+ *         be called directly by any user code. The function implementation is
+ *         automatically generated from FAPI Error XML files.
+ */
+
+/*
+ * Change Log ******************************************************************
+ * Flag     Defect/Feature  User        Date        Description
+ * ------   --------------  ----------  ----------- ----------------------------
+ *                          mjjones     09/19/2012  Created.
+ */
+
+#ifndef FAPICOLLECTREGFFDC_H_
+#define FAPICOLLECTREGFFDC_H_
+
+#include <fapiHwpErrorInfo.H>
+
+namespace fapi
+{
+
+class Target;
+class ReturnCode;
+
+/**
+ * @brief Collects Register FFDC from a chip
+ *
+ * This should only be called by FAPI during FAPI_SET_HWP_ERROR or
+ * FAPI_ADD_INFO_TO_HWP_ERROR
+ *
+ * @param[in]  i_target Reference to Target to collect FFDC from
+ * @param[in]  i_ffdcId FFDC Identifier
+ * @param[out] o_rc     Reference to ReturnCode that FFDC is added to
+ */
+void fapiCollectRegFfdc(const fapi::Target & i_target,
+                        const fapi::HwpFfdcId i_ffdcId,
+                        fapi::ReturnCode & o_rc);
+}
+
+#endif