summaryrefslogtreecommitdiffstats
path: root/src/import/hwpf/fapi2/include/fapi2_hw_access.H
diff options
context:
space:
mode:
authorKahn Evans <kahnevan@us.ibm.com>2015-10-06 13:21:47 -0500
committerPatrick Williams <iawillia@us.ibm.com>2015-12-11 13:40:20 -0600
commitb824f4ec0e58ae02541a18f119fddc32d2dab7ad (patch)
tree93d55b883b7f7991150112b0524dad74831efd6a /src/import/hwpf/fapi2/include/fapi2_hw_access.H
parent03cae2144f336c79e1ee13ee2b2de51afc3c03da (diff)
downloadtalos-hostboot-b824f4ec0e58ae02541a18f119fddc32d2dab7ad.tar.gz
talos-hostboot-b824f4ec0e58ae02541a18f119fddc32d2dab7ad.zip
fapi2 doxygen warning/error cleanup from ecmd repository
Change-Id: I502a6f79f461632588b46e51d5892e2d6b74942d Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/20985 Tested-by: Jenkins Server Reviewed-by: Matt K. Light <mklight@us.ibm.com> Reviewed-by: Brian Silver <bsilver@us.ibm.com> Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Diffstat (limited to 'src/import/hwpf/fapi2/include/fapi2_hw_access.H')
-rw-r--r--src/import/hwpf/fapi2/include/fapi2_hw_access.H30
1 files changed, 15 insertions, 15 deletions
diff --git a/src/import/hwpf/fapi2/include/fapi2_hw_access.H b/src/import/hwpf/fapi2/include/fapi2_hw_access.H
index fe310df7d..5b0f95351 100644
--- a/src/import/hwpf/fapi2/include/fapi2_hw_access.H
+++ b/src/import/hwpf/fapi2/include/fapi2_hw_access.H
@@ -250,9 +250,9 @@ fapi2::ReturnCode multiScom (const Target<K>& i_target,
#ifndef __PPE__
/// @brief Reads a spy from a chip.
/// @tparam K template parameter, passed in target.
-/// @param[in] i_target Target to operate on.
-/// @param[in] i_spyId Id of the spy whose data to be read.
-/// @param[out] o_data Buffer that holds data read from HW target.
+/// @param[in] TARGET Target to operate on.
+/// @param[in] ID Id of the spy whose data to be read.
+/// @param[out] DATA Buffer that holds data read from HW target.
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
/// @note: The string version is only supported for cronus.
@@ -308,9 +308,9 @@ inline ReturnCode getSpy(const Target<K>& i_target,
/// @brief Writes a spy on a chip.
/// @tparam K template parameter, passed in target.
-/// @param[in] i_target Target to operate on.
-/// @param[in] i_spyId Id of the spy to write data to.
-/// @param[out] i_data Buffer that holds data to write into spy.
+/// @param[in] TARGET Target to operate on.
+/// @param[in] ID Id of the spy to write data to.
+/// @param[out] DATA Buffer that holds data to write into spy.
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
/// @note: The string version is only supported for cronus.
@@ -374,11 +374,11 @@ inline ReturnCode putSpy(const Target<K>& i_target,
/// This API is used by L2/L3 repair to put column repair data
/// into a ring buffer image.
/// @tparam K template parameter, passed in target.
-/// @param[in] i_target Target to operate on.
-/// @param[in] i_spyId Id of the spy.
-/// @param[in] i_data Buffer that holds spy data to write into ring
+/// @param[in] TARGET Target to operate on.
+/// @param[in] ID Id of the spy.
+/// @param[in] DATA1 Buffer that holds spy data to write into ring
/// image.
-/// @param[out] o_data Buffer that holds updated ring image.
+/// @param[out] DATA2 Buffer that holds updated ring image.
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
/// @note: The string version is only supported for cronus.
@@ -416,11 +416,11 @@ inline ReturnCode putSpyImage(const Target<K>& i_target,
#endif
/// @brief Reads spy data from a ring image buffer
-/// @param[in] i_target Target to operate on
-/// @param[in] i_spyId The spy's id
-/// @param[out] o_data Buffer that holds data read from ring image.
-/// @param[in] i_imageData Buffer that holds ring image to read data
-/// from.
+/// @param[in] TARGET Target to operate on
+/// @param[in] ID The spy's id
+/// @param[out] DATA1 Buffer that holds data read from ring image.
+/// @param[in] DATA2 Buffer that holds ring image to read data
+/// from.
/// @return fapi2::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
///
/// @note: The string version is only supported for cronus.
OpenPOWER on IntegriCloud