Sync FAPI files from eKB to Hostboot

Change-Id: Ib01d8ed7daff06040e109f9847122bf0bc20495d
RTC: 105534
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/10670
Tested-by: Jenkins Server
Reviewed-by: William H. Schwartz <whs@us.ibm.com>
Reviewed-by: MATTHEW A. PLOETZ <maploetz@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

3 files changed, 40 insertions, 10 deletions

diff --git a/src/include/usr/hwpf/fapi/fapiHwAccess.H b/src/include/usr/hwpf/fapi/fapiHwAccess.H
index 2691b86c3..a843b57ee 100644
--- a/src/include/usr/hwpf/fapi/fapiHwAccess.H
+++ b/src/include/usr/hwpf/fapi/fapiHwAccess.H
@@ -20,7 +20,7 @@
 /* Origin: 30                                                             */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-// $Id: fapiHwAccess.H,v 1.12 2014/01/20 20:57:09 mjjones Exp $
+// $Id: fapiHwAccess.H,v 1.13 2014/01/20 22:37:49 mklight Exp $
 // $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiHwAccess.H,v $
 
 /**
@@ -215,6 +215,7 @@ fapi::ReturnCode fapiPutRing(const fapi::Target& i_target,
  * @param[in] i_address Ring address to modify
  * @param[in] i_data    ecmdDataBufferBase object that holds data to write into
  *                      address
+ * @param[in] i_modifyMode The modify mode (or/and/xor)
  * @param[in] i_ringMode Any number of mode options from fapi::RingMode ORed
  * @return ReturnCode. Zero on success, else platform specified error
  */
@@ -229,6 +230,7 @@ fapi::ReturnCode fapiModifyRing(const fapi::Target& i_target,
 // These spy access interfaces are only used in FSP and cronus
 // HB does not allow spy access
 
+#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(FAPI_SUPPORT_SPY_AS_STRING)
 /**
  * @brief Reads a Spy from a target
  * @param[in] i_target              Target to read spy from
@@ -270,9 +272,13 @@ fapi::ReturnCode fapiModifyRing(const fapi::Target& i_target,
  *         quotes for the cronus environment
  *
 */
+#endif
+
 #ifdef FAPI_SUPPORT_SPY_AS_ENUM
 
+#ifndef DOCUMENTATION
 #define fapiGetSpy(TARGET, ID, DATA) _fapiGetSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA )
+#endif
 fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
                             const spyId_t i_spyId,
                             ecmdDataBufferBase & o_data);
@@ -280,13 +286,15 @@ fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
 
 #ifdef FAPI_SUPPORT_SPY_AS_STRING
 
+#ifndef DOCUMENTATION
 #define fapiGetSpy(TARGET, ID, DATA) _fapiGetSpy(TARGET, #ID, DATA)
+#endif
 fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
                              const char * const i_spyId,
                              ecmdDataBufferBase & o_data);
 #endif
 
-#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(FAPI_SUPPORT_SPY_AS_STRING)
 /**
  * @brief Writes a spy on a target
  * @param[in] i_target  Target to operate on
@@ -329,21 +337,28 @@ fapi::ReturnCode _fapiGetSpy(const fapi::Target& i_target,
  *         quotes for the cronus environment
  *
 */
+#endif
+
+#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#ifndef DOCUMENTATION
 #define fapiPutSpy(TARGET, ID, DATA) _fapiPutSpy(TARGET, FAPI_SPY_NAMES::ID.value, DATA)
+#endif
 fapi::ReturnCode _fapiPutSpy(const fapi::Target& i_target,
                             const spyId_t i_spyId,
                             ecmdDataBufferBase & i_data);
 #endif
 
 #ifdef FAPI_SUPPORT_SPY_AS_STRING
+#ifndef DOCUMENTATION
 #define fapiPutSpy(TARGET, ID, DATA) _fapiPutSpy(TARGET, #ID, DATA)
+#endif
 fapi::ReturnCode _fapiPutSpy(const fapi::Target& i_target,
                             const char* const i_spyId,
                             ecmdDataBufferBase & i_data);
 
 #endif
 
-#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(FAPI_SUPPORT_SPY_AS_STRING)
 /**
  * @brief Writes data into a ring image
  * @param[in]   i_target      Target to operate on
@@ -363,9 +378,14 @@ fapi::ReturnCode _fapiPutSpy(const fapi::Target& i_target,
  *
  *         See fapiPutSpy for details on spy id specifics.
  */
+#endif
+
+#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#ifndef DOCUMENTATION
 #define fapiPutSpyImage(TARGET, ID, DATA1, DATA2) _fapiPutSpyImage(TARGET, \
                                                     FAPI_SPY_NAMES::ID.value, \
                                                     DATA1, DATA2)
+#endif
 fapi::ReturnCode _fapiPutSpyImage(const fapi::Target& i_target,
                                   const spyId_t i_spyId,
                                   const ecmdDataBufferBase & i_data,
@@ -374,15 +394,18 @@ fapi::ReturnCode _fapiPutSpyImage(const fapi::Target& i_target,
 
 #ifdef FAPI_SUPPORT_SPY_AS_STRING
 // fapiPutSpyImage function Cronus version
+#ifndef DOCUMENTATION
 #define fapiPutSpyImage(TARGET, ID, DATA1, DATA2) _fapiPutSpyImage(TARGET, #ID,\
                                                              DATA1,DATA2)
+#endif
+
 fapi::ReturnCode _fapiPutSpyImage(const fapi::Target& i_target,
                                   const char* const i_spyId,
                                   const ecmdDataBufferBase & i_data,
                                   ecmdDataBufferBase & o_imageData);
 #endif
 
-#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#if defined(FAPI_SUPPORT_SPY_AS_ENUM) || defined(FAPI_SUPPORT_SPY_AS_STRING)
 /**
  * @brief Reads data from a ring image
  * @param[in]   i_target      Target to operate on
@@ -402,9 +425,14 @@ fapi::ReturnCode _fapiPutSpyImage(const fapi::Target& i_target,
  *
  *         See fapiPutSpy for details on spy id specifics.
  */
+#endif
+
+#ifdef FAPI_SUPPORT_SPY_AS_ENUM
+#ifndef DOCUMENTATION
 #define fapiGetSpyImage(TARGET, ID, DATA1, DATA2) _fapiGetSpyImage(TARGET, \
                                             FAPI_SPY_NAMES::ID.value, \
                                             DATA1, DATA2)
+#endif
 fapi::ReturnCode _fapiGetSpyImage(const fapi::Target& i_target,
                                   const spyId_t i_spyId,
                                   ecmdDataBufferBase & o_data,
@@ -413,8 +441,10 @@ fapi::ReturnCode _fapiGetSpyImage(const fapi::Target& i_target,
 
 #ifdef FAPI_SUPPORT_SPY_AS_STRING
 // fapiGetSpyImage function Cronus version
+#ifndef DOCUMENTATION
 #define fapiGetSpyImage(TARGET, ID, DATA1, DATA2) _fapiGetSpyImage(TARGET,\
                                                     #ID, DATA1,DATA2)
+#endif
 
 fapi::ReturnCode _fapiGetSpyImage(const fapi::Target& i_target,
                                   const char* const i_spyId,
@@ -432,7 +462,7 @@ fapi::ReturnCode _fapiGetSpyImage(const fapi::Target& i_target,
  *    for details of how to populate the MultiScom object with SCOM operations
  *
  *  @param[in]      i_target        Chip/Chiplet target to do MultiScom on
- *  @param[in/out]  io_MultiScomObj Reference to a MultiScom object,
+ *  @param[in,out]  io_multiScomObj Reference to a MultiScom object,
  *                                  pre-populated with SingleScomInfo entries
  *                                  to perform multiple SCOMs on input target
  *  @return ReturnCode              Zero on success, else platform specified
diff --git a/src/include/usr/hwpf/fapi/fapiMvpdAccess.H b/src/include/usr/hwpf/fapi/fapiMvpdAccess.H
index a6251efb9..efc0fea74 100644
--- a/src/include/usr/hwpf/fapi/fapiMvpdAccess.H
+++ b/src/include/usr/hwpf/fapi/fapiMvpdAccess.H
@@ -20,7 +20,7 @@
 /* Origin: 30                                                             */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-// $Id: fapiMvpdAccess.H,v 1.7 2013/10/15 13:13:34 dcrowell Exp $
+// $Id: fapiMvpdAccess.H,v 1.8 2014/01/20 22:37:51 mklight Exp $
 // $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiMvpdAccess.H,v $
 
 /**
@@ -144,7 +144,7 @@ extern "C"
  *  @param[in] i_pBuffer    Pointer to buffer where record will be stored. If
  *                          NULL then the size of record will be stored in
  *                          io_fieldSize
- *  @param[io] io_fieldSize Size of i_pBuffer in bytes
+ *  @param[in,out] io_fieldSize Size of i_pBuffer in bytes
  *
  *  @return fapi::ReturnCode. FAPI_RC_SUCCESS, or failure value.
  */
@@ -163,7 +163,7 @@ fapi::ReturnCode fapiGetMvpdField(const fapi::MvpdRecord i_record,
  *  @param[in] i_keyword    Keyword enumerator
  *  @param[in] i_procTarget Reference to processor chip target for the record
  *  @param[in] i_pBuffer    Pointer to buffer where data to set is stored
- *  @param[io] i_fieldSize  Size of i_pBuffer in bytes
+ *  @param[in] i_fieldSize  Size of i_pBuffer in bytes
  *
  *  @return fapi::ReturnCode. FAPI_RC_SUCCESS, or failure value.
  */
diff --git a/src/include/usr/hwpf/fapi/fapiUtil.H b/src/include/usr/hwpf/fapi/fapiUtil.H
index 054e0aa0b..43c60393c 100644
--- a/src/include/usr/hwpf/fapi/fapiUtil.H
+++ b/src/include/usr/hwpf/fapi/fapiUtil.H
@@ -20,7 +20,7 @@
 /* Origin: 30                                                             */
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
-// $Id: fapiUtil.H,v 1.19 2013/11/11 19:33:49 mjjones Exp $
+// $Id: fapiUtil.H,v 1.20 2014/01/20 22:37:52 mklight Exp $
 // $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiUtil.H,v $
 
 /**
@@ -254,7 +254,7 @@ void fapiBreakPoint(uint32_t i_info);
  *                cores (EX chiplets) of the specified chip
  *              TARGET_TYPE_EX_CHIPLET: Enables/Disables Special Wakeup on the
  *                specified core (EX chiplet)
- * @param[in] i_enable. true = enable. false = disable.
+ * @param[in] i_enable true = enable. false = disable.
  *
  * @return ReturnCode. Zero on success, else platform specified error.
  */