Add Deconfig State / GARD Error parameters to addClockCallout(...)

Change-Id: Ia8bd707604651f8779897a177657eaa5e639a37d
RTC:91649
CMVC-Coreq:910647
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/7863
Tested-by: Jenkins Server
Reviewed-by: Brian H. Horton <brianh@linux.ibm.com>
Reviewed-by: Christopher T. Phan <cphan@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

3 files changed, 39 insertions, 15 deletions

diff --git a/src/include/usr/errl/errlentry.H b/src/include/usr/errl/errlentry.H
index 89369797e..2050deda8 100644
--- a/src/include/usr/errl/errlentry.H
+++ b/src/include/usr/errl/errlentry.H
@@ -452,12 +452,19 @@ public:
      *  @param[in]  i_target        The hardware target fed by the clock
      *  @param[in]  i_clockType     The hardware clock type
      *  @param[in]  i_priority      Priority of the callout
+     *  @param[in]  i_deconfigState Enum indicating whether the failing part
+     *                              should be deconfigured.
+     *  @param[in]  i_gardErrorType To indicate what type of failure occured
      *
      *  @return void
      */
     void addClockCallout(const TARGETING::Target *i_target,
                        const HWAS::clockTypeEnum i_clockType,
-                       const HWAS::callOutPriority i_priority);
+                       const HWAS::callOutPriority i_priority,
+                       const HWAS::DeconfigEnum
+                                   i_deconfigState = HWAS::NO_DECONFIG,
+                       const HWAS::GARD_ErrorType
+                                   i_gardErrorType = HWAS::GARD_NULL);
 
     /**
      *  @brief Add a bus callout
diff --git a/src/include/usr/errl/errludcallout.H b/src/include/usr/errl/errludcallout.H
index cd093b2e4..1844d4fed 100644
--- a/src/include/usr/errl/errludcallout.H
+++ b/src/include/usr/errl/errludcallout.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* IBM CONFIDENTIAL                                                       */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2012,2013              */
+/* COPYRIGHT International Business Machines Corp. 2012,2014              */
 /*                                                                        */
 /* p1                                                                     */
 /*                                                                        */
@@ -42,6 +42,9 @@ namespace TARGETING
 namespace ERRORLOG
 {
 
+// Forward class declaration
+class ErrlEntry;
+
 /**
  * @class ErrlUserDetailsCallout
  *
@@ -49,7 +52,15 @@ namespace ERRORLOG
  */
 class ErrlUserDetailsCallout : public ErrlUserDetails
 {
-public:
+
+    friend class ErrlEntry;
+
+private:
+
+    /**
+     *  @brief Destructor
+     */
+    virtual ~ErrlUserDetailsCallout() { };
 
     /**
      *  @brief Construct a clock callout user detail
@@ -58,15 +69,19 @@ public:
      *  @param[in]  i_targetDataLength    length of i_pTargetData
      *  @param[in]  i_clockType     clock type Enum
      *  @param[in]  i_priority      Priority of the callout
+     *  @param[in]  i_deconfigState Enum indicating whether the failing part
+     *                              should be deconfigured.
+     *  @param[in]  i_gardErrorType To indicate what type of failure occured
      *
      *  @return void
      */
     ErrlUserDetailsCallout(
-                        const void *i_pTargetData,
-                        uint32_t i_targetDataLength,
-                        const HWAS::clockTypeEnum i_clockType,
-                        const HWAS::callOutPriority i_priority);
-
+                       const void *i_pTargetData,
+                       uint32_t i_targetDataLength,
+                       const HWAS::clockTypeEnum i_clockType,
+                       const HWAS::callOutPriority i_priority,
+                       const HWAS::DeconfigEnum i_deconfigState,
+                       const HWAS::GARD_ErrorType i_gardErrorType);
     /**
      *  @brief Construct a bus callout user detail
      *
@@ -118,12 +133,8 @@ public:
      */
     ErrlUserDetailsCallout(const HWAS::epubProcedureID i_procedure,
                         const HWAS::callOutPriority i_priority);
-    /**
-     *  @brief Destructor
-     */
-    virtual ~ErrlUserDetailsCallout() { };
 
-private:
+
     // Disabled
     ErrlUserDetailsCallout(const ErrlUserDetailsCallout &);
     ErrlUserDetailsCallout & operator=(const ErrlUserDetailsCallout &);
diff --git a/src/include/usr/hwas/common/hwasCallout.H b/src/include/usr/hwas/common/hwasCallout.H
index c22713329..09e776dc8 100644
--- a/src/include/usr/hwas/common/hwasCallout.H
+++ b/src/include/usr/hwas/common/hwasCallout.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* IBM CONFIDENTIAL                                                       */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2012,2013              */
+/* COPYRIGHT International Business Machines Corp. 2012,2014              */
 /*                                                                        */
 /* p1                                                                     */
 /*                                                                        */
@@ -146,6 +146,8 @@ typedef struct callout_ud
         };
         struct {    // type == CLOCK_CALLOUT
             clockTypeEnum   clockType;      // uint32_t
+            DeconfigEnum    clkDeconfigState;  // uint32_t
+            GARD_ErrorType  clkGardErrorType;  // uint32_t
             // one Target will follow
         };
     };
@@ -235,6 +237,8 @@ errlHndl_t platHandleBusCallout(
  * @param[in]  i_clockType      Enum indicating which type of clock
  * @param[in]  i_priority       Enum indicating the priority of the callout
  * @param[in]  io_errl          reference to errlHnld for this errlog
+ * @param[in]  i_deconfigState  Enum indicating whether to deconfig or not
+ * @param[in]  i_gardErrType    Enum indicating the type of failure
  *
  * @return errlHndl_t       valid errlHndl_t handle if there was an error,
  *                          NULL if no errors;
@@ -243,7 +247,9 @@ errlHndl_t platHandleClockCallout(
         TARGETING::Target *i_pTarget,
         clockTypeEnum i_clockType,
         callOutPriority i_priority,
-        errlHndl_t &io_errl);
+        errlHndl_t &io_errl,
+        DeconfigEnum    i_deconfigState = DECONFIG,
+        GARD_ErrorType  i_gardErrorType = GARD_Fatal);
 
 #endif // not PARSER