SW292120: FAPI Files required for RTC 117913

Change-Id: I383d24be201e3a42188278bb667dc074d71e7612
CQ:SW292120
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/15232
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Reviewed-by: PRACHI GUPTA <pragupta@us.ibm.com>
Reviewed-by: Sangeetha T S <sangeet2@in.ibm.com>
Tested-by: Sangeetha T S <sangeet2@in.ibm.com>
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/15248
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

2 files changed, 26 insertions, 5 deletions

diff --git a/src/include/usr/hwpf/fapi/fapiErrorInfo.H b/src/include/usr/hwpf/fapi/fapiErrorInfo.H
index 7b2b8c800..c92484372 100755
--- a/src/include/usr/hwpf/fapi/fapiErrorInfo.H
+++ b/src/include/usr/hwpf/fapi/fapiErrorInfo.H
@@ -22,7 +22,7 @@
 /* permissions and limitations under the License.                         */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-// $Id: fapiErrorInfo.H,v 1.17 2015-02-02 18:31:53 dcrowell Exp $
+// $Id: fapiErrorInfo.H,v 1.18 2015/03/19 15:46:14 pragupta Exp $
 // $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiErrorInfo.H,v $
 
 /**
@@ -51,6 +51,7 @@
  *                                                  /gard of DIMM(s) related
  *                                                  to MBA
  *                          whs         03/11/2014  Add FW traces to error logs
+ *                          sangeet2    01/16/2015  Modify ErrorInfoHwCallout
  */
 
 #ifndef FAPIERRORINFO_H_
@@ -63,6 +64,12 @@
 namespace fapi
 {
 
+// The type that will hold the position of clock
+typedef int8_t targetPos_t;
+
+// Used  incase a valid clock position is not specified
+const targetPos_t INVALID_CLOCK_POS = (-1);
+
 /**
  * @enum HwCallout
  *
@@ -239,11 +246,14 @@ struct ErrorInfoHwCallout
      * @param[in] i_hw              Hardware to callout
      * @param[in] i_calloutPriority Priority of callout
      * @param[in] i_refTarget       Reference to reference target
+     * @param[in] i_position        Incase of a clock callout;
+     *                              the position of the clock to be called out
      */
     ErrorInfoHwCallout(
         const HwCallouts::HwCallout i_hw,
         const CalloutPriorities::CalloutPriority i_calloutPriority,
-        const Target & i_refTarget);
+        const Target & i_refTarget,
+        const targetPos_t i_position = INVALID_CLOCK_POS);
 
 #ifdef FAPI_CUSTOM_MALLOC
     /**
@@ -272,6 +282,9 @@ struct ErrorInfoHwCallout
     // The reference target (needed for some HW callouts to identify what to
     // callout). The target handle is NULL if there is no reference target.
     Target iv_refTarget;
+
+    // Incase of a clock callout; the position of the clock to be called out
+    targetPos_t iv_position;
 };
 
 /**
diff --git a/src/include/usr/hwpf/fapi/fapiReturnCode.H b/src/include/usr/hwpf/fapi/fapiReturnCode.H
index d8a8251b1..83c3b045d 100644
--- a/src/include/usr/hwpf/fapi/fapiReturnCode.H
+++ b/src/include/usr/hwpf/fapi/fapiReturnCode.H
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2011,2014              */
+/* Contributors Listed Below - COPYRIGHT 2011,2015                        */
+/* [+] 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.       */
@@ -20,7 +22,7 @@
 /* permissions and limitations under the License.                         */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-// $Id: fapiReturnCode.H,v 1.20 2014/03/12 00:48:25 whs Exp $
+// $Id: fapiReturnCode.H,v 1.21 2015/01/16 11:30:02 sangeet2 Exp $
 // $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiReturnCode.H,v $
 
 /**
@@ -58,6 +60,7 @@
  *                                                  MBA port and dimm number
  *                          mjjones     11/08/2013  Do not define struct in union
  *                          whs         03/11/2014  Add FW traces to error logs
+ *                          sangeet2    01/16/2015  Modify ErrorInfoEntryHwCallout
  */
 
 #ifndef FAPIRETURNCODE_H_
@@ -302,6 +305,8 @@ public:
         uint8_t iv_hw;
         uint8_t iv_calloutPriority;
         uint8_t iv_refObjIndex;
+        //For a HW callout (clock) the position of the clock
+        uint8_t iv_objPosIndex;
     };
 
     struct ErrorInfoEntryProcCallout
@@ -442,11 +447,14 @@ private:
      * @param[in] i_hw        The hardware to callout
      * @param[in] i_priority  The priority of the callout
      * @param[in] i_refTarget Reference to reference Target
+     * @param[in] i_position  Incase of a clock callout;
+     *                        position of the clock target
      */
      void addEIHwCallout(
          const HwCallouts::HwCallout i_hw,
          const CalloutPriorities::CalloutPriority i_priority,
-         const Target & i_refTarget);
+         const Target & i_refTarget,
+         const targetPos_t i_position = INVALID_CLOCK_POS);
 
     /**
      * @brief Add a procedure callout to the ErrorInfo