summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Harvey <jlharvey@us.ibm.com>2016-02-05 15:24:59 -0600
committerDaniel M. Crowell <dcrowell@us.ibm.com>2016-04-01 21:23:21 -0400
commitdba9ee6be396b29a072d9c5fc87ff346542c396e (patch)
treed3edf1b1207aad6dd8d7b9b93473067be1dd6e48
parenta08c13b301d1ee48a40474261711c6dc8174b108 (diff)
downloadtalos-hostboot-dba9ee6be396b29a072d9c5fc87ff346542c396e.tar.gz
talos-hostboot-dba9ee6be396b29a072d9c5fc87ff346542c396e.zip
Fixed doxygen errors and typos
Change-Id: I86313e4af81003744f0ab6c507d019a39c4a4992 Original-Change-Id: I94120c654c32b5c3513740ce8aae4b4cc632fc41 Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/24281 Tested-by: Jenkins Server Reviewed-by: Andre A. Marin <aamarin@us.ibm.com> Reviewed-by: Brian Silver <bsilver@us.ibm.com> Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/22767 Tested-by: FSP CI Jenkins Reviewed-by: JACOB L. HARVEY <jlharvey@us.ibm.com> Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.C19
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.H145
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load.C20
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.C78
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.H20
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C32
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H22
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.C2
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.H16
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/mcbist/mcbist.H72
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/mss_utils.H4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/cal_timers.H36
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.C74
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.H102
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.C19
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.H50
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/phy/read_cntrl.H70
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/port/port.H28
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.C22
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.H20
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/bit_count.H8
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H35
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/conversions.H44
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/dump_regs.H2
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.C6
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.H39
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/find.H22
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/index.H8
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/poll.H8
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/pos.H6
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/lib/utils/swizzle.H26
31 files changed, 526 insertions, 529 deletions
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.C b/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.C
index 4ae2aa684..625a5050e 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.C
@@ -68,7 +68,8 @@ fapi_try_exit:
///
/// @brief Determine the CCS failure type
/// @tparam T the fapi2 target type of the target for this error
-/// @param[in] the failure type
+/// @param[in] i_target
+/// @param[in] i_type the failure type
/// @return ReturnCode associated with the fail.
/// @note FFDC is handled here, caller doesn't need to do it
///
@@ -97,7 +98,7 @@ fapi_try_exit:
///
/// @brief Execute the contents of the CCS array
/// @param[in] i_target The MCBIST containing the array
-/// @param[in] the MCBIST ccs program - to get the polling parameters
+/// @param[in] i_program the MCBIST ccs program - to get the polling parameters
/// @return FAPI2_RC_SUCCESS iff success
///
template<>
@@ -136,9 +137,9 @@ fapi_try_exit:
///
/// @brief Execute a set of CCS instructions
-/// @param[in] the target to effect
-/// @param[in] the vector of instructions
-/// @param[in] the vector of ports
+/// @param[in] i_target the target to effect
+/// @param[in] i_program the vector of instructions
+/// @param[in] i_ports the vector of ports
/// @return FAPI2_RC_SUCCSS iff ok
/// @note assumes the CCS engine has been configured.
///
@@ -234,11 +235,11 @@ fapi_try_exit:
///
/// @brief Nimbus specialization for modeq_copy_cke_to_spare_cke
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] fapi2::Target<TARGET_TYPE_MCBIST>& the target to effect
/// @param[in] the buffer representing the mode register
-/// @param[in] bool, true iff Copy CKE signals to CKE Spare on both ports
+/// @param[in] bool true iff Copy CKE signals to CKE Spare on both ports
/// @return void
/// @note no-op for p9n
///
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.H b/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.H
index 5eb16856d..97bfd8f25 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/ccs/ccs.H
@@ -184,10 +184,10 @@ class instruction_t
///
/// @brief intstruction_t ctor
- /// @param[in] the DIMM this instruction is headed for
- /// @param[in] the rank this instruction is headed for
- /// @param[in] the initial value for arr0, defaults to 0
- /// @param[in] the initial value for arr1, defaults to 0
+ /// @param[in] i_target the DIMM this instruction is headed for
+ /// @param[in] i_rank the rank this instruction is headed for
+ /// @param[in] i_arr0 the initial value for arr0, defaults to 0
+ /// @param[in] i_arr1 the initial value for arr1, defaults to 0
///
instruction_t( const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target = fapi2::Target<fapi2::TARGET_TYPE_DIMM>(),
uint64_t i_rank = 0xFF,
@@ -276,8 +276,8 @@ class instruction_t
///
/// @brief A class representing a series of CCS instructions, and the
/// CCS engine parameters associated with running the instructions
-/// @tparam fapi2::TargetType T representing the fapi2 target which
-/// @tparam fapi2::TargetType P representing the port
+/// @tparam T fapi2::TargetType representing the fapi2 target which
+/// @tparam P fapi2::TargetType representing the port
/// contains the CCS engine (e.g., fapi2::TARGET_TYPE_MCBIST)
template< fapi2::TargetType T, fapi2::TargetType P = fapi2::TARGET_TYPE_MCA >
class program
@@ -298,7 +298,7 @@ class program
///
/// @brief Common setup for all MRS/RCD instructions
-/// @param[in,out] fapi2::buffer<uint64_t> representing the ARR0 of the instruction
+/// @param[in,out] i_arr0 fapi2::buffer<uint64_t> representing the ARR0 of the instruction
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -321,8 +321,8 @@ static void mrs_rcd_helper( fapi2::buffer<uint64_t>& i_arr0 )
///
/// @brief Create, initialize an RCD (RCW - JEDEC) CCS command
-/// @tparam T, the fapi2 type of the unit which contains the CCS engine
-/// @param[in] the DIMM this instruction is headed for
+/// @tparam T the fapi2 type of the unit which contains the CCS engine
+/// @param[in] i_target the DIMM this instruction is headed for
/// @return the RCD CCS instruction
/// @note THIS IS DDR4 ONLY RIGHT NOW. We can (and possibly should) specialize this
/// for the controller (Nimbus v Centaur) and then correct for DRAM generation (not included
@@ -353,10 +353,10 @@ inline instruction_t<T> rcd_command( const fapi2::Target<fapi2::TARGET_TYPE_DIMM
///
/// @brief Create, initialize an MRS CCS command
-/// @tparam T, the fapi2 type of the unit which contains the CCS engine
-/// @param[in] the DIMM this instruction is headed for
-/// @param[in] the rank on this dimm
-/// @param[in] the specific MRS
+/// @tparam T the fapi2 type of the unit which contains the CCS engine
+/// @param[in] i_target the DIMM this instruction is headed for
+/// @param[in] i_rank the rank on this dimm
+/// @param[in] i_mrs the specific MRS
/// @return the MRS CCS instruction
/// @note THIS IS DDR4 ONLY RIGHT NOW. We can (and possibly should) specialize this
/// for the controller (Nimbus v Centaur) and then correct for DRAM generation (not included
@@ -387,7 +387,7 @@ inline instruction_t<T> mrs_command( const fapi2::Target<fapi2::TARGET_TYPE_DIMM
///
/// @brief Create, initialize a JEDEC Device Deselect CCS command
-/// @tparam T, the fapi2 type of the unit containing the CCS engine
+/// @tparam T the fapi2 type of the unit containing the CCS engine
/// @return the Device Deselect CCS instruction
/// @note THIS IS DDR4 ONLY RIGHT NOW. We can (and possibly should) specialize this
/// for the controller (Nimbus v Centaur) and then correct for DRAM generation (not included
@@ -415,7 +415,7 @@ inline instruction_t<T> des_command()
///
/// @brief Create, initialize an instruction which indicates an initial cal
-/// @param[in] the rank-pair (rank) to cal
+/// @param[in] i_rp the rank-pair (rank) to cal
/// @return the initial cal instruction
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -450,10 +450,10 @@ inline instruction_t<T> initial_cal_command(const uint64_t i_rp)
///
/// @brief Select the port(s) to be used by the CCS
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the buffer representing the ports
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_ports the buffer representing the ports
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -476,11 +476,11 @@ fapi_try_exit:
///
/// @brief User sets to a '1'b to tell the Hdw to stop CCS whenever failure occurs. When a
/// '0'b, Hdw will continue CCS even if a failure occurs.
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @param[in] i_value, true iff stop whenever failure occurs.
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] the target to effect
+/// @param[in] i_buffer the buffer representing the mode register
+/// @param[in] i_value true iff stop whenever failure occurs.
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -491,10 +491,10 @@ inline void stop_on_err( const fapi2::Target<T>&, fapi2::buffer<uint64_t>& i_buf
///
/// @brief Disable ECC checking on the CCS arrays
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
+/// @param[in] i_buffer the buffer representing the mode register
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -507,11 +507,11 @@ inline void disable_ecc( const fapi2::Target<T>&, fapi2::buffer<uint64_t>& i_buf
///
/// @brief User sets to a '1'b to force the Hdw to ignore any array ue or sue errors
/// during CCS command fetching.
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @param[in] i_value, true iff ignore any array ue or sue errors.
+/// @param[in] i_buffer the buffer representing the mode register
+/// @param[in] i_value true iff ignore any array ue or sue errors.
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -522,12 +522,12 @@ inline void ue_disable( const fapi2::Target<T>&, fapi2::buffer<uint64_t>& i_buff
///
/// @brief DDr calibration counter
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @param[in] i_count, the count to wait for DDR cal to complete.
-/// @param[in] i_mult, the DDR calibration time multiplaction factor
+/// @param[in] i_buffer the buffer representing the mode register
+/// @param[in] i_count the count to wait for DDR cal to complete.
+/// @param[in] i_mult the DDR calibration time multiplaction factor
/// @return void
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -544,11 +544,11 @@ inline void cal_count( const fapi2::Target<T>&, fapi2::buffer<uint64_t>& i_buffe
/// CKE(4:5) 1 - Port A CKE(0:1) copied to Port A CKE(2:3), Port A CKE(4:5) copied
/// to Port A CKE(6:7), Port B CKE(0:1) copied to Port B CKE(2:3) and Port B CKE(4:5)
/// copied to Port B CKE(6:7)
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @param[in] bool, true iff Copy CKE signals to CKE Spare on both ports
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_buffer the buffer representing the mode register
+/// @param[in] i_value bool true iff Copy CKE signals to CKE Spare on both ports
/// @note no-op for p9n
/// @return void
///
@@ -557,11 +557,11 @@ void copy_cke_to_spare_cke( const fapi2::Target<T>&, fapi2::buffer<uint64_t>& i_
///
/// @brief Read the modeq register appropriate for this target
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @erturn FAPI2_RC_SUCCSS iff ok
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_buffer the buffer representing the mode register
+/// @return FAPI2_RC_SUCCSS iff ok
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
inline fapi2::ReturnCode read_mode( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& i_buffer)
@@ -572,11 +572,11 @@ inline fapi2::ReturnCode read_mode( const fapi2::Target<T>& i_target, fapi2::buf
///
/// @brief Write the modeq register appropriate for this target
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the buffer representing the mode register
-/// @erturn FAPI2_RC_SUCCSS iff ok
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_buffer the buffer representing the mode register
+/// @return FAPI2_RC_SUCCSS iff ok
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
inline fapi2::ReturnCode write_mode( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_buffer)
@@ -586,13 +586,13 @@ inline fapi2::ReturnCode write_mode( const fapi2::Target<T>& i_target, const fap
///
/// @brief Execute a set of CCS instructions - multiple ports
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam P, the fapi2::TargetType of the ports - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the vector of instructions
-/// @param[in] the vector of ports
-/// @erturn FAPI2_RC_SUCCSS iff ok
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam P the fapi2::TargetType of the ports - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_program the vector of instructions
+/// @param[in] i_ports the vector of ports
+/// @return FAPI2_RC_SUCCSS iff ok
///
template< fapi2::TargetType T, fapi2::TargetType P, typename TT = ccsTraits<T> >
fapi2::ReturnCode execute( const fapi2::Target<T>& i_target,
@@ -601,13 +601,13 @@ fapi2::ReturnCode execute( const fapi2::Target<T>& i_target,
///
/// @brief Execute a set of CCS instructions - single port
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam P, the fapi2::TargetType of the ports - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the vector of instructions
-/// @param[in] the port
-/// @erturn FAPI2_RC_SUCCSS iff ok
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam P the fapi2::TargetType of the ports - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_program the vector of instructions
+/// @param[in] i_port the port
+/// @return FAPI2_RC_SUCCSS iff ok
///
template< fapi2::TargetType T, fapi2::TargetType P, typename TT = ccsTraits<T> >
fapi2::ReturnCode execute( const fapi2::Target<T>& i_target,
@@ -621,19 +621,18 @@ fapi2::ReturnCode execute( const fapi2::Target<T>& i_target,
///
/// @brief Execute a CCS array already loaded in to the engine
-/// @tparam T, the fapi2::TargetType - derived
-/// @tparam TT, the ccsTraits associated with T - derived
-/// @param[in] the target to effect
-/// @param[in] the MCBIST ccs program - to get the polling parameters
-/// @erturn FAPI2_RC_SUCCSS iff ok
+/// @tparam T the fapi2::TargetType - derived
+/// @tparam TT the ccsTraits associated with T - derived
+/// @param[in] i_target the target to effect
+/// @param[in] i_program the MCBIST ccs program - to get the polling parameters
+/// @return FAPI2_RC_SUCCSS iff ok
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
fapi2::ReturnCode execute_inst_array(const fapi2::Target<T>& i_target, ccs::program<T>& i_program);
///
/// @brief Start or stop the CCS engine
/// @param[in] i_target The MCBIST containing the CCS engine
-/// @param[in] i_start_stop bool MSS_CCS_START for starting,
-/// MSS_CCS_STOP otherwise
+/// @param[in] i_start_stop bool MSS_CCS_START for starting MSS_CCS_STOP otherwise
/// @return FAPI2_RC_SUCCESS iff success
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
@@ -642,7 +641,7 @@ fapi2::ReturnCode start_stop( const fapi2::Target<T>& i_target, bool i_start_sto
///
/// @brief Query the status of the CCS engine
/// @param[in] i_target The MCBIST containing the CCS engine
-/// @param[out] The query result, first being the result, second the type
+/// @param[out] io_status The query result first being the result, second the type
/// @return FAPI2_RC_SUCCESS iff success
///
template< fapi2::TargetType T, typename TT = ccsTraits<T> >
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load.C b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load.C
index 7b93ab7ac..c3d8d9f92 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -45,7 +45,7 @@ namespace mss
{
///
/// @brief Perform the mrs_load operations - TARGET_TYPE_MCBIST specialization
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_MCBIST>
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_MCBIST>
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -77,8 +77,8 @@ fapi_try_exit:
///
/// @brief Perform the mrs_load operations - unknown DIMM case
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to (unused)
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to (unused)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -107,8 +107,8 @@ fapi_try_exit:
///
/// @brief Perform the mrs_load operations - RDIMM DDR4
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -124,8 +124,8 @@ fapi_try_exit:
///
/// @brief Perform the mrs_load operations - LRDIMM DDR4
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -142,8 +142,8 @@ fapi_try_exit:
///
/// @brief Perform the mrs_load operations - start the dispatcher
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.C b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.C
index 94d14cb96..fe3d1d769 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -47,9 +47,9 @@ namespace mss
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs00
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs00(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -127,8 +127,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS0,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs00_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -171,9 +171,9 @@ static fapi2::ReturnCode ddr4_mrs00_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs01
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs01(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -243,8 +243,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS1,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs01_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -274,7 +274,7 @@ static fapi2::ReturnCode ddr4_mrs01_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Given a uint32_t, which contains address bits with an encoded MRS1,
/// decode and trace the contents
-/// @param[in] i_value, ADR 17:0
+/// @param[in] i_value ADR 17:0
/// @return void
///
fapi2::ReturnCode ddr4_mrs01_decode(const uint32_t i_value)
@@ -306,9 +306,9 @@ fapi2::ReturnCode ddr4_mrs01_decode(const uint32_t i_value)
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs02
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs02(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -384,8 +384,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS2,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs02_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -408,9 +408,9 @@ static fapi2::ReturnCode ddr4_mrs02_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs03
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs03(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -465,8 +465,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS3,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs03_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -498,9 +498,9 @@ static fapi2::ReturnCode ddr4_mrs03_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs04
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs04(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -562,8 +562,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS4,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs04_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -595,9 +595,9 @@ static fapi2::ReturnCode ddr4_mrs04_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs05
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs05(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -673,8 +673,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS5,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs05_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -706,9 +706,9 @@ static fapi2::ReturnCode ddr4_mrs05_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Configure the ARR0 of the CCS isntruction for mrs06
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in,out] the instruction to fixup
-/// @param[in] ths rank in question
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in,out] io_inst the instruction to fixup
+/// @param[in] i_rank ths rank in question
/// @return FAPI2_RC_SUCCESS iff OK
///
static fapi2::ReturnCode ddr4_mrs06(const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
@@ -751,8 +751,8 @@ fapi_try_exit:
///
/// @brief Given a CCS instruction which contains address bits with an encoded MRS6,
/// decode and trace the contents
-/// @param[in] i_inst, the CCS instruction
-/// @param[in] ths rank in question
+/// @param[in] i_inst the CCS instruction
+/// @param[in] i_rank ths rank in question
/// @return void
///
static fapi2::ReturnCode ddr4_mrs06_decode(const ccs::instruction_t<TARGET_TYPE_MCBIST>& i_inst,
@@ -775,8 +775,8 @@ static fapi2::ReturnCode ddr4_mrs06_decode(const ccs::instruction_t<TARGET_TYPE_
///
/// @brief Perform the mrs_load_ddr4 operations - TARGET_TYPE_DIMM specialization
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to
/// @return FAPI2_RC_SUCCESS if and only if ok
///
fapi2::ReturnCode mrs_load_ddr4( const fapi2::Target<TARGET_TYPE_DIMM>& i_target,
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.H b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.H
index ea11517f6..2ddf07110 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/mrs_load_ddr4.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -68,8 +68,8 @@ enum address_bits
///
/// @brief Perform the mrs_load_ddr4 operations - TARGET_TYPE_DIMM specialization
-/// @param[in] i_target, a fapi2::Target<TARGET_TYPE_DIMM>
-/// @param[in] a vector of CCS instructions we should add to
+/// @param[in] i_target a fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_inst a vector of CCS instructions we should add to
/// @return FAPI2_RC_SUCCESS if and only if ok
///
fapi2::ReturnCode mrs_load_ddr4( const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target,
@@ -77,8 +77,8 @@ fapi2::ReturnCode mrs_load_ddr4( const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i
///
/// @brief Mirror (front to back) the ADR bits of a CCS instruction - implementation
-/// @tparam T, typename of the ccs::instruction_t
-/// @param[in, out] io_inst, reference to a CCS instruction to be mirrored
+/// @tparam T typename of the ccs::instruction_t
+/// @param[in, out] io_inst reference to a CCS instruction to be mirrored
/// @return FAPI2_RC_SUCESS iff ok
/// @note written this way so this is easier to test
///
@@ -96,10 +96,10 @@ void address_mirror_impl(ccs::instruction_t<T>& io_inst)
///
/// @brief Mirror (front to back) the ADR bits of a CCS instruction
-/// @tparam T, typename of the ccs::instruction_t
-/// @param[in] i_target, target to use to get mirroring attribute
-/// @param[in] i_rank, the rank in question
-/// @param[in, out] io_inst, reference to a CCS instruction to be mirrored
+/// @tparam T typename of the ccs::instruction_t
+/// @param[in] i_target target to use to get mirroring attribute
+/// @param[in] i_rank the rank in question
+/// @param[in, out] io_inst reference to a CCS instruction to be mirrored
/// @return FAPI2_RC_SUCESS iff ok
/// @note assumes the input is from an even number rank
///
@@ -123,7 +123,7 @@ fapi_try_exit:
///
/// @brief Invert (side to side) the ADR bits of a CCS instruction
-/// @param[in] i_inst, const reference to a CCS instruction.
+/// @param[in] i_inst const reference to a CCS instruction.
/// @return[out] ccs instruction with the ADR bits inverted (side-to-side)
///
template<fapi2::TargetType T>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C
index c764f98fd..b2a705eea 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -81,7 +81,7 @@ static const std::vector< std::vector< std::vector< uint64_t > > > single_dimm_r
///
/// @brief Return true iff this rank is on thie DIMM
/// @param[in] i_target representing the DIMM
-/// @param[in] i_rank, the rank number.
+/// @param[in] i_rank the rank number.
/// @return true iff i_rank is a rank on i_target
///
bool is_rank_on_dimm(const fapi2::Target<TARGET_TYPE_DIMM>& i_target, const uint64_t i_rank)
@@ -111,7 +111,7 @@ bool is_rank_on_dimm(const fapi2::Target<TARGET_TYPE_DIMM>& i_target, const uint
///
/// @brief Return the *port relative position* of the DIMM which posesses this rank
-/// @param[in] i_rank, the rank number.
+/// @param[in] i_rank the rank number.
/// @return the relative position of the DIMM which contains this rank.
///
size_t get_dimm_from_rank(const uint64_t i_rank)
@@ -131,9 +131,9 @@ size_t get_dimm_from_rank(const uint64_t i_rank)
///
/// @brief Return a vector of rank numbers which represent the primary rank pairs for this dimm
-/// @tparam T, the target type
-/// @param[in] TARGET_TYPE_MCA
-/// @param[out] a vector of rank_pairs
+/// @tparam T the target type
+/// @param[in] i_target TARGET_TYPE_MCA
+/// @param[out] o_rps a vector of rank_pairs
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template<>
@@ -157,9 +157,9 @@ fapi_try_exit:
///
/// @brief Return a vector of rank numbers which represent the primary rank pairs for this dimm
-/// @tparam T, the target type
-/// @param[in] TARGET_TYPE_DIMM
-/// @param[out] a vector of rank_pairs
+/// @tparam T the target type
+/// @param[in] i_target TARGET_TYPE_DIMM
+/// @param[out] o_rps a vector of rank_pairs
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template<>
@@ -186,8 +186,8 @@ fapi_try_exit:
///
/// @brief Return a vector of rank numbers which represent the ranks for this dimm
-/// @param[in] i_target, TARGET_TYPE_DIMM
-/// @param[out] o_ranks, a vector of ranks (numbers)
+/// @param[in] i_target TARGET_TYPE_DIMM
+/// @param[out] o_ranks a vector of ranks (numbers)
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template<>
@@ -204,8 +204,8 @@ fapi_try_exit:
///
/// @brief Return a vector of rank numbers which represent the ranks for this dimm
-/// @param[in] i_target, TARGET_TYPE_MCA
-/// @param[out] o_ranks, a vector of ranks (numbers)
+/// @param[in] i_target TARGET_TYPE_MCA
+/// @param[out] o_ranks a vector of ranks (numbers)
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template<>
@@ -232,7 +232,7 @@ fapi_try_exit:
///
/// @brief Setup the rank information in the port
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -292,8 +292,8 @@ fapi_try_exit:
/// @brief Get a vector of configured rank pairs.
/// Returns a vector of ordinal values of the configured rank pairs. e.g., for a 2R DIMM, {0, 1}
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
-/// @param[out] std::vector of rank pairs configured
+/// @param[in]i_target the target (MCA or MBA?)
+/// @param[out] o_pairs std::vector of rank pairs configured
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H
index 66bcd6b5f..1868ce38e 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -38,9 +38,9 @@ namespace mss
///
/// @brief Return a vector of rank numbers which represent the ranks for this dimm
-/// @tparam T, the target type you'd like the associated ranks for
+/// @tparam T the target type you'd like the associated ranks for
/// @param[in] i_target
-/// @param[out] o_ranks, a vector of ranks (numbers)
+/// @param[out] o_ranks a vector of ranks (numbers)
/// @return FAPI2_RC_SUCCESS iff all is ok
///
template< fapi2::TargetType T >
@@ -48,9 +48,9 @@ fapi2::ReturnCode ranks( const fapi2::Target<T>& i_target, std::vector< uint64_t
///
/// @brief Return a vector of rank numbers which represent the primary rank pairs for this port or dimm
-/// @tparam T, the target type
-/// @param[in] TARGET_TYPE_MCA or TARGET_TYPEDIMM
-/// @param[out] a vector of rank_pairs
+/// @tparam T the target type
+/// @param[in] i_target TARGET_TYPE_MCA or TARGET_TYPEDIMM
+/// @param[out] o_rps a vector of rank_pairs
/// @return FAPI@_RC_SUCCESS iff all is ok
///
template< fapi2::TargetType T >
@@ -59,14 +59,14 @@ fapi2::ReturnCode primary_ranks( const fapi2::Target<T>& i_target, std::vector<
///
/// @brief Return true iff this rank is on thie DIMM
/// @param[in] i_target representing the DIMM
-/// @param[in] i_rank, the rank number.
+/// @param[in] i_rank the rank number.
/// @return true iff i_rank is a rank on i_target
///
bool is_rank_on_dimm(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target, const uint64_t i_rank);
///
/// @brief Return the *port relative position* of the DIMM which posesses this rank
-/// @param[in] i_rank, the rank number.
+/// @param[in] i_rank the rank number.
/// @return the relative position of the DIMM which contains this rank.
///
size_t get_dimm_from_rank(const uint64_t i_rank);
@@ -74,7 +74,7 @@ size_t get_dimm_from_rank(const uint64_t i_rank);
///
/// @brief Setup the rank information in the port
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
@@ -83,8 +83,8 @@ fapi2::ReturnCode set_rank_pairs(const fapi2::Target<T>& i_target);
///
/// @brief get the rank information related to the port
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
-/// @param[out] std::vector of rank pairs configured
+/// @param[in] i_target the target (MCA or MBA?)
+/// @param[out] o_pairs std::vector of rank pairs configured
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.C b/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.C
index 6293007e8..4b76445f9 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.C
@@ -42,7 +42,7 @@ namespace mss
///
/// @brief Dump the registers of the MC (MCA_MBA, MCS)
-/// @param[in] i_target, the MCS target
+/// @param[in] i_target the MCS target
/// @return fapi2::FAPI2_RC_SUCCESS if ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.H b/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.H
index ef0108fb3..f239dd0c7 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/mc/mc.H
@@ -52,7 +52,7 @@ template< fapi2::TargetType T >
class mcTraits;
///
-/// @class rcTraits<fapi2::TARGET_TYPE_MEMBUF_CHIP>
+/// @class mcTraits
/// @brief a collection of traits associated with the Centaur controller
///
template<>
@@ -61,7 +61,7 @@ class mcTraits<fapi2::TARGET_TYPE_MEMBUF_CHIP>
};
///
-/// @class rcTraits<fapi2::TARGET_TYPE_MCS>
+/// @class mcTraits
/// @brief a collection of traits associated with the Nimbus controller
///
template<>
@@ -151,7 +151,7 @@ enum
///
/// @class mss::mc
/// @brief The memory controller class
-/// @tparam T, the fapi2::TargetType of the controller
+/// @tparam T the fapi2::TargetType of the controller
///
template< fapi2::TargetType T >
class mc
@@ -160,17 +160,17 @@ class mc
public:
///
/// @brief Perform initializations for the MC
- /// @tparam T, the fapi2::TargetType
- /// @param[in] i_target, the target which has the MCs to initialize
+ /// @tparam T the fapi2::TargetType
+ /// @param[in] i_target the target which has the MCs to initialize
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode scominit(const fapi2::Target<T>& i_target);
///
/// @brief Perform initializations of the MC translation
- /// @tparm P, the fapi2::TargetType of the port
- /// @tparm TT, the typename of the traits
- /// @param[in] i_target, the target which has the MCA to map
+ /// @tparam P the fapi2::TargetType of the port
+ /// @tparam TT the typename of the traits
+ /// @param[in] i_target the target which has the MCA to map
/// @return FAPI2_RC_SUCCESS iff ok
///
template< fapi2::TargetType P, typename TT = mcTraits<T> >
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/mcbist/mcbist.H b/src/import/chips/p9/procedures/hwp/memory/lib/mcbist/mcbist.H
index 1a6660c3c..464f7278c 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/mcbist/mcbist.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/mcbist/mcbist.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -54,7 +54,7 @@ template< fapi2::TargetType T >
class mcbistTraits;
///
-/// @class mcbistTraits<fapi2::TARGET_TYPE_MEMBUF_CHIP>
+/// @class mcbistTraits
/// @brief a collection of traits associated with the Centaur MCBIST engine or hardware
///
template<>
@@ -63,7 +63,7 @@ class mcbistTraits<fapi2::TARGET_TYPE_MEMBUF_CHIP>
};
///
-/// @class mcbistTraits<fapi2::TARGET_TYPE_MCBIST>
+/// @class mcbistTraits
/// @brief a collection of traits associated with the Nimbus MCBIST engine or hardware
///
template<>
@@ -109,7 +109,7 @@ class subtest_t
///
/// @brief A class representing a series of MCBIST subtests, and the
/// MCBIST engine parameters associated with running the subtests
-/// @tparam fapi2::TargetType T representing the fapi2 target which
+/// @tparam T fapi2::TargetType representing the fapi2 target which
/// contains the MCBIST engine (e.g., fapi2::TARGET_TYPE_MCBIST)
///
template< fapi2::TargetType T >
@@ -128,10 +128,10 @@ class program
///
/// @brief Complement the data for the first subcommand
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -143,10 +143,10 @@ void change_compliment_1st_cmd( subtest_t<T>& io_subtest, const mss::states i_st
///
/// @brief Complement the data for the second subcommand
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -158,10 +158,10 @@ void change_compliment_2nd_cmd( subtest_t<T>& io_subtest, const mss::states i_st
///
/// @brief Complement the data for the third subcommand
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -173,10 +173,10 @@ void change_compliment_3rd_cmd( subtest_t<T>& io_subtest, const mss::states i_st
///
/// @brief Generate addresses in reverse order
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -188,10 +188,10 @@ void change_addr_rev_mode( subtest_t<T>& io_subtest, const mss::states i_state )
///
/// @brief Generate addresses in random order
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -203,10 +203,10 @@ void change_addr_rand_mode( subtest_t<T>& io_subtest, const mss::states i_state
///
/// @brief Generate and check data with ECC
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_state, the desired state of the function
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_state the desired state of the function
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -218,10 +218,10 @@ void change_ecc_mode( subtest_t<T>& io_subtest, const mss::states i_state )
///
/// @brief Set the data mode for this subtest
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_mode, the desired mcbist::data_mode
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_mode the desired mcbist::data_mode
/// @return void
///
template< fapi2::TargetType T, typename TT = mcbistTraits<T> >
@@ -233,10 +233,10 @@ void change_data_mode( subtest_t<T>& io_subtest, const data_mode i_mode )
///
/// @brief Configure which address registers to use for this subtest
-/// @tparam T, fapi2::TargetType of the MCBIST engine
-/// @tparam TT, the mssTraits associtated with T
-/// @param[in,out] io_subtest, a subtest
-/// @param[in] i_index, 0 = MCBSA0Q, 1 = MCBSA1Q, ...
+/// @tparam T fapi2::TargetType of the MCBIST engine
+/// @tparam TT the mssTraits associtated with T
+/// @param[in,out] io_subtest a subtest
+/// @param[in] i_index 0 = MCBSA0Q, 1 = MCBSA1Q, ...
/// @note wraps to 0-3 no matter what value you pass in.
/// @return void
///
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/mss_utils.H b/src/import/chips/p9/procedures/hwp/memory/lib/mss_utils.H
index a20562e15..83ec3512b 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/mss_utils.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/mss_utils.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -18,7 +18,7 @@
/* IBM_PROLOG_END_TAG */
///
-/// @file mss_utils.h.H
+/// @file mss_utils.H
/// @brief Main include file for the Memory Subsystem
///
// *HWP HWP Owner: Craig Hamilton <cchamilt@us.ibm.com>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/cal_timers.H b/src/import/chips/p9/procedures/hwp/memory/lib/phy/cal_timers.H
index 919e987bb..56a188d36 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/cal_timers.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/cal_timers.H
@@ -40,8 +40,8 @@ namespace mss
///
/// @brief Return the cycles taken for write leveling on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for write leveling on a single rank
///
template<fapi2::TargetType T>
@@ -63,8 +63,8 @@ uint64_t wr_lvl_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for DQS align on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for DQS align on a single rank
///
template<fapi2::TargetType T>
@@ -79,8 +79,8 @@ uint64_t dqs_align_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for RD clock align on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for RD clock align on a single rank
///
template<fapi2::TargetType T>
@@ -96,8 +96,8 @@ uint64_t rdclk_align_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for read centering on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for read centering on a single rank
///
template<fapi2::TargetType T>
@@ -114,8 +114,8 @@ uint64_t read_ctr_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for write centering on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for write centering on a single rank
///
template<fapi2::TargetType T>
@@ -137,8 +137,8 @@ uint64_t write_ctr_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for coarse write on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for coarse write on a single rank
///
template<fapi2::TargetType T>
@@ -153,8 +153,8 @@ uint64_t coarse_wr_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Return the cycles taken for coarse read on a single rank
-/// @tparam T, the target type used to get attributes
-/// @param[in] i_target, used to get attributes
+/// @tparam T the target type used to get attributes
+/// @param[in] i_target used to get attributes
/// @return uint64_t, the cycles taken for coarse rd on a single rank
///
template<fapi2::TargetType T>
@@ -169,10 +169,10 @@ uint64_t coarse_rd_cycles(const fapi2::Target<T>& i_target )
///
/// @brief Configure the polling intervals with the proper timeings based on the cal steps enabled
-/// @tparam T, the fapi2::TargetType of the port
-/// @param[in] i_target, the port target
-/// @param[in] the poll_parameters to update
-/// @param[in] a fapi2::buffer<uint8_t> representing the cal steps enabled
+/// @tparam T the fapi2::TargetType of the port
+/// @param[in] i_target the port target
+/// @param[in] i_poll the poll_parameters to update
+/// @param[in] i_cal_steps_enabled a fapi2::buffer<uint8_t> representing the cal steps enabled
/// @return FAPI2_RC_SUCCESS iff everything is OK
///
template<fapi2::TargetType T>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.C b/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.C
index 853e7adf3..e00d6c43f 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.C
@@ -53,9 +53,9 @@ namespace mss
///
/// @brief Blast one peice of data across a vector of addresses
-/// @param[in] i_target, the target for the scom
-/// @param[in] const std::vector<uint64_t>&, addresses
-/// @param[in] const fapi2::buffer<uint64_t>&, the data to blast
+/// @param[in] i_target the target for the scom
+/// @param[in] i_addrs const std::vector<uint64_t>& addresses
+/// @param[in] i_data const fapi2::buffer<uint64_t>& the data to blast
/// @return FAPI2_RC_SUCCESS iff ok
/// @note Author is originally from Boston (Pahk mah cah in Havahd Yahd)
@@ -83,9 +83,9 @@ fapi_try_exit:
///
/// @brief Blast one peice of data across a vector of targets
-/// @param[in] the vector of targets for the scom
-/// @param[in] the address
-/// @param[in] const fapi2::buffer<uint64_t>&, the data to blast
+/// @param[in]i_targets the vector of targets for the scom
+/// @param[in] i_addr the address
+/// @param[in] i_data const fapi2::buffer<uint64_t>& the data to blast
/// @return FAPI2_RC_SUCCESS iff ok
///
template< fapi2::TargetType T >
@@ -109,9 +109,9 @@ fapi_try_exit:
///
/// @brief Blast one peice of data across a vector of targets
-/// @param[in] the vector of targets for the scom
-/// @param[in] the vector of addresses
-/// @param[in] const fapi2::buffer<uint64_t>&, the data to blast
+/// @param[in]i_targets the vector of targets for the scom
+/// @param[in] i_addrs the vector of addresses
+/// @param[in] i_data const fapi2::buffer<uint64_t>& the data to blast
/// @return FAPI2_RC_SUCCESS iff ok
///
template< fapi2::TargetType T >
@@ -136,8 +136,8 @@ fapi_try_exit:
///
/// @brief change resetn to the given state
-/// @param[in] i_target, the mcbist
-/// @param[in] the desired state
+/// @param[in] i_target the mcbist
+/// @param[in] i_state the desired state
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode change_resetn( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target, states i_state )
@@ -159,7 +159,7 @@ fapi_try_exit:
///
/// @brief perform the zctl toggle process
-/// @param[in] i_target, the mcbist for the reset recover
+/// @param[in] i_target the mcbist for the reset recover
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode toggle_zctl( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
@@ -198,8 +198,8 @@ fapi_try_exit:
}
/// @brief Change mclk low
-/// @param[in] mcbist target
-/// @param[in] mss::HIGH or mss::LOW - desired state.
+/// @param[in] i_target mcbist target
+/// @param[in] i_state mss::HIGH or mss::LOW - desired state.
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode change_force_mclk_low (const fapi2::Target<TARGET_TYPE_MCBIST>& i_target,
@@ -249,7 +249,7 @@ fapi_try_exit:
///
/// @brief Unset the PLL and check to see that the PLL's have started
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode deassert_pll_reset( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
@@ -348,8 +348,8 @@ fapi_try_exit:
///
/// @brief Setup the phase rotator control registers
-/// @param[in] the mcbist target
-/// @param[in] the value for the registers
+/// @param[in] i_target the mcbist target
+/// @param[in] i_data the value for the registers
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode setup_phase_rotator_control_registers( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target,
@@ -373,7 +373,7 @@ fapi_try_exit:
///
/// @brief Deassetr the sys clk reset
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode deassert_sysclk_reset( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
@@ -387,7 +387,7 @@ fapi_try_exit:
///
/// @brief Flush the DDR PHY
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode ddr_phy_flush( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
@@ -424,9 +424,9 @@ fapi_try_exit:
///
/// @brief Send a scom to all instances of a block on the phy.
-/// @param[in] the MCA target
-/// @param[in] the address
-/// @param[in] the value
+/// @param[in] i_target the MCA target
+/// @param[in] l_addr the address
+/// @param[in] i_data the value
/// @note this iterates creating addresses - needs to change to use the
/// braodcast bits in the phy when we can scom it directly.
///
@@ -452,7 +452,7 @@ fapi_try_exit:
///
/// @brief Lock dphy_gckn and sysclk
-/// @param[in] a port target
+/// @param[in] i_target a port target
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode bang_bang_lock( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
@@ -521,9 +521,9 @@ fapi_try_exit:
///
/// @brief Return the DIMM target for the primary rank in the specificed rank pair
-/// @param[in] the MCA target
-/// @param[in] the rank pair
-/// @param[out] fapi2::Target<TARGET_TYPE_DIMM>
+/// @param[in] i_target the MCA target
+/// @param[in] i_rp the rank pair
+/// @param[out] o_dimm fapi2::Target<TARGET_TYPE_DIMM>
/// @return FAPI2_RC_SUCCESS iff ok
///
template<>
@@ -590,7 +590,7 @@ fapi_try_exit:
///
/// @brief check and process initial cal errors
-/// @param[in] the port in question
+/// @param[in] i_target the port in question
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS iff no error
///
template<>
@@ -761,7 +761,7 @@ fapi_try_exit:
///
/// @brief Setup the PC CONFIG0 register
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -787,7 +787,7 @@ fapi_try_exit:
///
/// @brief Setup the PC CONFIG1 register
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target <the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
@@ -849,7 +849,7 @@ fapi_try_exit:
///
/// @brief Perform initializations for the PHY
-/// @param[in] i_target, the MCBIST which has the PHYs to initialize
+/// @param[in] i_target the MCBIST which has the PHYs to initialize
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode phy_scominit(const fapi2::Target<TARGET_TYPE_MCBIST>& i_target)
@@ -898,9 +898,9 @@ fapi_try_exit:
///
/// @brief Setup all the cal config register
-/// @param[in] the MCA target associated with this cal setup
-/// @param[in] the vector of currently configured rank pairs
-/// @param[in] fapi2::buffer<uint8_t> representing the cal steps to enable
+/// @param[in] i_target the MCA target associated with this cal setup
+/// @param[in] i_rank_pairs the vector of currently configured rank pairs
+/// @param[in] i_cal_steps_enabled fapi2::buffer<uint8_t> representing the cal steps to enable
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -1009,9 +1009,9 @@ fapi_try_exit:
///
/// @brief Setup all the cal config register
-/// @param[in] the target associated with this cal setup
-/// @param[in] i_rank, one currently configured rank pairs
-/// @param[in] fapi2::buffer<uint16_t> representing the cal steps to enable
+/// @param[in] i_target the target associated with this cal setup
+/// @param[in] i_rank one currently configured rank pairs
+/// @param[in] i_cal_steps_enabled fapi2::buffer<uint16_t> representing the cal steps to enable
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
fapi2::ReturnCode setup_cal_config( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
@@ -1025,7 +1025,7 @@ fapi2::ReturnCode setup_cal_config( const fapi2::Target<fapi2::TARGET_TYPE_MCA>&
///
/// @brief Dump the registers of the PHY (MCA)
-/// @param[in] i_target, the MCA target
+/// @param[in] i_target the MCA target
/// @return fapi2::FAPI2_RC_SUCCESS if ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.H b/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.H
index c971e8646..b874bea50 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/ddr_phy.H
@@ -57,44 +57,44 @@ namespace mss
///
/// @brief Perform initializations for the PHY
-/// @param[in] i_target, the MCBIST which has the PHYs to initialize
+/// @param[in] i_target the MCBIST which has the PHYs to initialize
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode phy_scominit(const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target);
///
/// @brief change resetn to the given state
-/// @param[in] i_target, the mcbist
-/// @param[in] the desired state
+/// @param[in] i_target the mcbist
+/// @param[in] i_state the desired state
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode change_resetn( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target, states i_state );
///
/// @brief perform the zctl toggle process
-/// @param[in] i_target, the mcbist for the reset recover
+/// @param[in] i_target the mcbist for the reset recover
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode toggle_zctl( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
/// @brief Change mclk low
-/// @param[in] mcbist target
-/// @param[in] mss::HIGH or mss::LOW - desired state.
+/// @param[in] i_target mcbist target
+/// @param[in] i_state mss::HIGH or mss::LOW - desired state.
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode change_force_mclk_low (const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target,
const mss::states i_state);
///
/// @brief Unset the PLL and check to see that the PLL's have started
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode deassert_pll_reset( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief Setup the phase rotator control registers
-/// @param[in] the mcbist target
-/// @param[in] the value for the registers
+/// @param[in] i_target the mcbist target
+/// @param[in] i_data the value for the registers
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode setup_phase_rotator_control_registers( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target,
@@ -102,43 +102,43 @@ fapi2::ReturnCode setup_phase_rotator_control_registers( const fapi2::Target<fap
///
/// @brief Deassetr the sys clk reset
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode deassert_sysclk_reset( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief Flush the DDR PHY
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode ddr_phy_flush( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief Reset the training delay configureation
-/// @param[in] the mcbist target
+/// @param[in] i_target the mcbist target
/// @return FAPI2_RC_SUCCES iff ok
///
fapi2::ReturnCode reset_delay_values( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief Lock dphy_gckn and sysclk
-/// @param[in] a MCBIST target
+/// @param[in] i_target a MCBIST target
/// @return FAPI2_RC_SUCCESs iff ok
///
fapi2::ReturnCode bang_bang_lock( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief Configure the DP16 sysclk
-/// @param[in] a MCBIST target
+/// @param[in] i_target a MCBIST target
/// @return FAPI2_RC_SUCCESs iff ok
///
fapi2::ReturnCode setup_dp16_sysclk( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
///
/// @brief check and process initial cal errors
-/// @tparam T, the type of the target in question
-/// @param[in] the port in question
+/// @tparam T the type of the target in question
+/// @param[in] i_target the port in question
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS iff no error
///
template< fapi2::TargetType T >
@@ -147,9 +147,9 @@ fapi2::ReturnCode process_initial_cal_errors( const fapi2::Target<T>& i_target )
///
/// @brief Setup all the cal config register
/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
-/// @param[in] the vector of currently configured rank pairs
-/// @param[in] fapi2::buffer<uint16_t> representing the cal steps to enable
+/// @param[in] i_target the target associated with this cal setup
+/// @param[in] i_rank_pairs the vector of currently configured rank pairs
+/// @param[in] i_cal_steps_enabled fapi2::buffer<uint16_t> representing the cal steps to enable
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -159,9 +159,9 @@ fapi2::ReturnCode setup_cal_config( const fapi2::Target<T>& i_target,
///
/// @brief Setup all the cal config register
-/// @param[in] the target associated with this cal setup
-/// @param[in] i_rank, one currently configured rank pairs
-/// @param[in] fapi2::buffer<uint16_t> representing the cal steps to enable
+/// @param[in] i_target the target associated with this cal setup
+/// @param[in] i_rank one currently configured rank pairs
+/// @param[in] i_cal_steps_enabled fapi2::buffer<uint16_t> representing the cal steps to enable
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
fapi2::ReturnCode setup_cal_config( const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
@@ -170,8 +170,8 @@ fapi2::ReturnCode setup_cal_config( const fapi2::Target<fapi2::TARGET_TYPE_MCA>&
///
/// @brief Setup wc_config0
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -179,7 +179,7 @@ inline fapi2::ReturnCode reset_wc_config0( const fapi2::Target<T>& i_target );
///
/// @brief Setup wc_config0
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -221,8 +221,8 @@ fapi_try_exit:
///
/// @brief Setup wc_config1
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -230,7 +230,7 @@ inline fapi2::ReturnCode reset_wc_config1( const fapi2::Target<T>& i_target );
///
/// @brief Setup wc_config1
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -253,8 +253,8 @@ fapi_try_exit:
///
/// @brief Setup wc_config2
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -262,7 +262,7 @@ inline fapi2::ReturnCode reset_wc_config2( const fapi2::Target<T>& i_target );
///
/// @brief Setup wc_config2
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -286,8 +286,8 @@ fapi_try_exit:
///
/// @brief Setup wc_config3
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -295,7 +295,7 @@ inline fapi2::ReturnCode reset_wc_config3( const fapi2::Target<T>& i_target );
///
/// @brief Setup wc_config3
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -324,8 +324,8 @@ fapi_try_exit:
///
/// @brief Setup WC RTT Write Swap Enable Register
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -333,7 +333,7 @@ inline fapi2::ReturnCode reset_wc_rtt_wr_swap_enable( const fapi2::Target<T>& i_
///
/// @brief Setup WC RTT Write Swap Enable Register
-/// @param[in] the MCA target
+/// @param[in] i_target the MCA target
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -361,8 +361,8 @@ fapi_try_exit:
///
/// @brief Setup seq_config0
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -370,7 +370,7 @@ inline fapi2::ReturnCode reset_seq_config0( const fapi2::Target<T>& i_target );
///
/// @brief Setup seq_config0
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -392,8 +392,8 @@ fapi_try_exit:
///
/// @brief Setup odt_wr/rd_config
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -401,7 +401,7 @@ inline fapi2::ReturnCode reset_odt_config( const fapi2::Target<T>& i_target );
///
/// @brief Setup odt_wr/rd_config
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -544,8 +544,8 @@ fapi_try_exit:
///
/// @brief Setup seq_rd_wr_data
-/// @tparam T, the target type of the MCA/MBA
-/// @param[in] the target associated with this cal setup
+/// @tparam T the target type of the MCA/MBA
+/// @param[in] i_target the target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template< fapi2::TargetType T >
@@ -553,7 +553,7 @@ inline fapi2::ReturnCode reset_seq_rd_wr_data( const fapi2::Target<T>& i_target
///
/// @brief Setup seq_rd_wr_data
-/// @param[in] the MCA target associated with this cal setup
+/// @param[in] i_target the MCA target associated with this cal setup
/// @return FAPI2_RC_SUCCESS iff setup was successful
///
template<>
@@ -582,7 +582,7 @@ fapi_try_exit:
///
/// @brief Setup the PC CONFIG0 register
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
@@ -591,7 +591,7 @@ fapi2::ReturnCode set_pc_config0(const fapi2::Target<T>& i_target);
///
/// @brief Setup the PC CONFIG1 register
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
@@ -599,9 +599,9 @@ fapi2::ReturnCode set_pc_config1(const fapi2::Target<T>& i_target);
///
/// @brief Return the DIMM target for the primary rank in the specificed rank pair
-/// @tparam T, fapi2::TargetType of the port target
-/// @param[in] the arget
-/// @param[in] the rank pair
+/// @tparam T fapi2::TargetType of the port target
+/// @param[in] i_target the target
+/// @param[in] i_rp the rank pair
/// @param[out] fapi2::Target<fapi2::TARGET_TYPE_DIMM>
/// @return FAPI2_RC_SUCCESS iff ok
///
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.C b/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.C
index 8f171e7ff..b728ece88 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -142,8 +142,7 @@ static std::vector< register_data_vector > rdclk_enable_spare_x4 =
///
/// @brief Write the data bit enable registers
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target a port target
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -173,8 +172,8 @@ fapi_try_exit:
///
/// @brief Write the clock enable registers
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target
+/// @param[in] l_rank_pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -207,8 +206,8 @@ fapi_try_exit:
///
/// @brief Write the read clock enable registers
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target
+/// @param[in] l_rank_pairs
/// @return FAPI2_RC_SUCCESs iff ok
///
template<>
@@ -241,8 +240,8 @@ fapi_try_exit:
///
/// @brief Reset the training delay configureation
-/// @param[in] the port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target the port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -285,7 +284,7 @@ fapi_try_exit:
///
/// @brief Configure the DP16 sysclk
-/// @param[in] a MCBIST target
+/// @param[in] i_target a MCBIST target
/// @return FAPI2_RC_SUCCESs iff ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.H b/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.H
index f5f962516..998b6ed46 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/dp16.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -40,8 +40,8 @@ namespace dp16
///
/// @brief Configure the DP16 sysclk
-/// @tparam T, the fapi2 target type
-/// @param[in] a target
+/// @tparam T the fapi2 target type
+/// @param[in] i_target a target
/// @return FAPI2_RC_SUCCESs iff ok
///
template< fapi2::TargetType T >
@@ -49,7 +49,7 @@ fapi2::ReturnCode setup_sysclk( const fapi2::Target<T>& i_target );
///
/// @brief Configure the DP16 sysclk
-/// @param[in] a MCBIST target
+/// @param[in] i_target a MCBIST target
/// @return FAPI2_RC_SUCCESs iff ok
///
template<>
@@ -57,9 +57,9 @@ fapi2::ReturnCode setup_sysclk( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>&
///
/// @brief Reset the training delay configureation
-/// @tparam T, the type of the port
-/// @param[in] the port target
-/// @param[in] vector of rank pairs
+/// @tparam T the type of the port
+/// @param[in] i_target the port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template< fapi2::TargetType T>
@@ -68,8 +68,8 @@ fapi2::ReturnCode reset_delay_values( const fapi2::Target<T>& i_target,
///
/// @brief Reset the training delay configureation
-/// @param[in] the port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target the port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -78,9 +78,9 @@ fapi2::ReturnCode reset_delay_values( const fapi2::Target<fapi2::TARGET_TYPE_MCA
///
/// @brief Write the read clock enable registers
-/// @tparam T, the type of the port
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @tparam T the type of the port
+/// @param[in] i_target a port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template< fapi2::TargetType T>
@@ -89,8 +89,8 @@ fapi2::ReturnCode read_clock_enable( const fapi2::Target<T>& i_target,
///
/// @brief Write the clock enable registers
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target a port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -99,9 +99,9 @@ fapi2::ReturnCode read_clock_enable( const fapi2::Target<fapi2::TARGET_TYPE_MCA>
///
/// @brief Write the clock enable registers
-/// @tparam T, the type of the port
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @tparam T the type of the port
+/// @param[in] i_target a port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template< fapi2::TargetType T>
@@ -110,8 +110,8 @@ fapi2::ReturnCode write_clock_enable( const fapi2::Target<T>& i_target,
///
/// @brief Write the clock enable registers
-/// @param[in] a port target
-/// @param[in] vector of rank pairs
+/// @param[in] i_target a port target
+/// @param[in] l_rank_pairs vector of rank pairs
/// @return FAPI2_RC_SUCCES iff ok
///
template<>
@@ -120,9 +120,8 @@ fapi2::ReturnCode write_clock_enable( const fapi2::Target<fapi2::TARGET_TYPE_MCA
///
/// @brief Write the data bit enable registers
-/// @tparam T, the type of the port
-/// @param[in] a port target
-/// @param[in] vector of port pairs
+/// @tparam T the type of the port
+/// @param[in] i_target a port target
/// @return FAPI2_RC_SUCCESs iff ok
///
template< fapi2::TargetType T>
@@ -130,8 +129,7 @@ fapi2::ReturnCode write_data_bit_enable( const fapi2::Target<T>& i_target );
///
/// @brief Write the data bit enable registers
-/// @param[in] a port target
-/// @param[in] vector of port pairs
+/// @param[in] i_target a port target
/// @return FAPI2_RC_SUCCESs iff ok
///
template<>
@@ -140,7 +138,7 @@ fapi2::ReturnCode write_data_bit_enable( const fapi2::Target<fapi2::TARGET_TYPE_
///
/// @brief Setup the bad-bits masks for a port
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T>
@@ -149,7 +147,7 @@ inline fapi2::ReturnCode set_bad_bits(const fapi2::Target<T>& i_target);
///
/// @brief Setup the bad-bits masks for a port
/// @tparam T the fapi2::TargetType
-/// @param[in] the target (MCA or MBA?)
+/// @param[in] i_target the target (MCA or MBA?)
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/phy/read_cntrl.H b/src/import/chips/p9/procedures/hwp/memory/lib/phy/read_cntrl.H
index 96ffa509a..243d3cbe4 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/phy/read_cntrl.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/phy/read_cntrl.H
@@ -18,7 +18,7 @@
/* IBM_PROLOG_END_TAG */
///
-/// @file read_cntrl
+/// @file read_cntrl.H
/// @brief Subroutines for the PHY read control registers
///
// *HWP HWP Owner: Brian Silver <bsilver@us.ibm.com>
@@ -48,7 +48,7 @@ template< fapi2::TargetType T >
class rcTraits;
///
-/// @class rcTraits<fapi2::TARGET_TYPE_MBA>
+/// @class rcTraits
/// @brief a collection of traits associated with the Centaur PHY
///
template<>
@@ -57,7 +57,7 @@ class rcTraits<fapi2::TARGET_TYPE_MBA>
};
///
-/// @class rcTraits<fapi2::TARGET_TYPE_MCA>
+/// @class rcTraits
/// @brief a collection of traits associated with the Nimbus PHY read control
///
template<>
@@ -123,8 +123,8 @@ class rcTraits<fapi2::TARGET_TYPE_MCA>
///
/// @class mss::rc
/// @brief Read Control reset config 0
-/// @tparam T, fapi2 Target Type - derived
-/// @tparam TT, traits type defaults to rcTraits<T>
+/// @tparam T fapi2 Target Type - derived
+/// @tparam TT traits type defaults to rcTraits<T>
///
template< fapi2::TargetType T, typename TT = rcTraits<T> >
class rc
@@ -133,8 +133,8 @@ class rc
///
/// @brief Read RC_VREF_CONFIG0
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_vref_config0( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -146,8 +146,8 @@ class rc
///
/// @brief Write RC_VREF_CONFIG0
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_vref_config0( const fapi2::Target<T>& i_target,
@@ -161,8 +161,8 @@ class rc
///
/// @brief Read RC_VREF_CONFIG1
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_vref_config1( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -174,8 +174,8 @@ class rc
///
/// @brief Write RC_VREF_CONFIG1
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_vref_config1( const fapi2::Target<T>& i_target,
@@ -190,8 +190,8 @@ class rc
///
/// @brief Read RC_CONFIG0
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_config0( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -203,8 +203,8 @@ class rc
///
/// @brief Write RC_CONFIG0
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_config0( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
@@ -218,8 +218,8 @@ class rc
///
/// @brief Read RC_CONFIG1
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_config1( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -231,8 +231,8 @@ class rc
///
/// @brief Write RC_CONFIG1
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_config1( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
@@ -245,8 +245,8 @@ class rc
///
/// @brief Read RC_CONFIG2
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_config2( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -258,8 +258,8 @@ class rc
///
/// @brief Write RC_CONFIG2
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_config2( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
@@ -272,8 +272,8 @@ class rc
///
/// @brief Read RC_CONFIG3
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[out] o_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[out] o_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode read_config3( const fapi2::Target<T>& i_target, fapi2::buffer<uint64_t>& o_data )
@@ -285,8 +285,8 @@ class rc
///
/// @brief Write RC_CONFIG3
- /// @param[in] i_target, the fapi2 target of the port
- /// @param[in] i_data, the value of the register
+ /// @param[in] i_target the fapi2 target of the port
+ /// @param[in] i_data the value of the register
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode write_config3( const fapi2::Target<T>& i_target, const fapi2::buffer<uint64_t>& i_data )
@@ -299,7 +299,7 @@ class rc
///
/// @brief reset rc_config0
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_config0( const fapi2::Target<T>& i_target )
@@ -322,7 +322,7 @@ class rc
///
/// @brief reset rc_config1
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_config1( const fapi2::Target<T>& i_target )
@@ -338,7 +338,7 @@ class rc
///
/// @brief reset rc_config2
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_config2( const fapi2::Target<T>& i_target )
@@ -374,7 +374,7 @@ class rc
///
/// @brief reset rc_config3
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_config3( const fapi2::Target<T>& i_target )
@@ -395,7 +395,7 @@ class rc
///
/// @brief reset rc_vref_config0
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_vref_config0( const fapi2::Target<T>& i_target )
@@ -431,7 +431,7 @@ class rc
///
/// @brief reset rc_vref_config1
- /// @param[in] i_target, fapi2 target of the port
+ /// @param[in] i_target fapi2 target of the port
/// @return fapi2::ReturnCode, FAPI2_RC_SUCCESS if ok
///
static inline fapi2::ReturnCode reset_vref_config1( const fapi2::Target<T>& i_target )
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/port/port.H b/src/import/chips/p9/procedures/hwp/memory/lib/port/port.H
index 968c4d847..c6ed42575 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/port/port.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/port/port.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -78,7 +78,7 @@ namespace mss
{
///
/// @brief Given a DIMM, return it's port number.
-/// @param[in] the DIMM in question
+/// @param[in] i_target the DIMM in question
/// @return the port number it's attached to
///
// Note: Make this a template and dispatch at runtime to determine if the parent of
@@ -92,8 +92,8 @@ inline uint64_t port( const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target )
///
/// @brief Change the state of the addr_mux_sel bit
-/// @param[in] the target
-/// @param[in] the state
+/// @param[in] i_target the target
+/// @param[in] i_state the state
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T, typename TT = portTraits<T> >
@@ -112,8 +112,8 @@ fapi_try_exit:
///
/// @brief Change the state of the MC Refresh enable bit
-/// @param[in] the target
-/// @param[in] the state
+/// @param[in] i_target the target
+/// @param[in] i_state the state
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T, typename TT = portTraits<T> >
@@ -132,7 +132,7 @@ fapi_try_exit:
///
/// @brief Enable the MC Periodic calibration functionality
-/// @param[in] the target
+/// @param[in] i_target the target
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T, typename TT = portTraits<T> >
@@ -144,7 +144,7 @@ fapi2::ReturnCode enable_periodic_cal( const fapi2::Target<T>& i_target )
///
/// @brief Enable Read ECC checking
-/// @param[in] the target
+/// @param[in] i_target the target
/// @return FAPI2_RC_SUCCESS if and only if ok
///
template< fapi2::TargetType T, typename TT = portTraits<T> >
@@ -182,7 +182,7 @@ fapi_try_exit:
//
///
/// @brief Secure the entry criteria for draminit
-/// @param[in] A target representing a port
+/// @param[in] i_target A target representing a port
/// @return FAPI2_RC_SUCCESS if and only if ok
// This is in this header as it's hoped to be able to be shared. Seems to make more
// Might make more sense in p9_mss_draminit.C ... BRS
@@ -208,9 +208,9 @@ fapi_try_exit:
///
/// @brief Drive memory clocks
-/// @param[in] A target representing a port
-/// @param[in] phy p clock - right most 2 bits
-/// @param[in] phy n clock - right most 2 bits
+/// @param[in] i_target A target representing a port
+/// @param[in] i_pclk phy p clock - right most 2 bits
+/// @param[in] i_nclk phy n clock - right most 2 bits
/// @return FAPI2_RC_SUCCESS if and only if ok
/// @note this might need a port id added for Centaur/MBA controllers
///
@@ -236,8 +236,8 @@ fapi_try_exit:
///
/// @brief Set DDR resetn
-/// @param[in] A target representing a port
-/// @param[in] high or low
+/// @param[in] i_target A target representing a port
+/// @param[in] i_state high or low
/// @return FAPI2_RC_SUCCESS if and only if ok
/// @note this might need a port id added for Centaur/MBA controllers
///
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.C b/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.C
index 492184d52..a873abf2f 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -74,10 +74,10 @@ namespace mss
///
/// @brief perform the slew calibration, store the result.
-/// @tparam T, the type of the slew table
-/// @param[in] MCA (port) target
-/// @param[in] a vector of the steps which came before me
-/// @param[in] the slew table to be operated on
+/// @tparam T the type of the slew table
+/// @param[in] i_target MCA (port) target
+/// @param[in] l_table a vector of the steps which came before me
+/// @param[in] o_cal_slew the slew table to be operated on
/// @param[out] the array holding the results
/// @return FAPI2_RC_SUCCESS, iff ok
///
@@ -102,8 +102,8 @@ fapi_try_exit:
///
/// @brief perform the slew calibration, store the result.
-/// @param[in] MCA (port) target
-/// @param[in] a vector of the steps which came before me
+/// @param[in] i_target MCA (port) target
+/// @param[in] i_where_am_i a vector of the steps which came before me
/// @param[in] a slew_table_t
/// @param[out] the array holding the results
/// @bote Prunes recursion based on frequency.
@@ -145,9 +145,9 @@ fapi_try_exit:
///
/// @brief perform the slew calibration, store the result.
-/// @param[in] MCA (port) target
-/// @param[in] a vector of the steps which came before me
-/// @param[in] the slew rate to be calculated
+/// @param[in] i_target MCA (port) target
+/// @param[in] i_where_am_i a vector of the steps which came before me
+/// @param[in] l_slew_rate the slew rate to be calculated
/// @param[out] the array holding the results
/// @return FAPI2_RC_SUCCESS, iff ok
///
@@ -238,7 +238,7 @@ fapi_try_exit:
///
/// @brief Run the slew calibration engine
-/// @param[in] i_target, the MCBIST
+/// @param[in] i_target the MCBIST
/// @return FAPI2_RC_SUCCESS iff OK
///
fapi2::ReturnCode slew_cal(const fapi2::Target<TARGET_TYPE_MCBIST>& i_target)
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.H b/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.H
index e74bb9ad3..3cde67289 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/termination/slew_cal.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -73,9 +73,9 @@ enum tags_t
///
/// @brief find the attribute array index of a tag
-/// @parm[in] i_type, whether this is an adr or dq lookup
-/// @parm[in] tags_t, the tag to find the index of
-/// @return size_t, the attribute array index
+/// @param[in] i_type whether this is an adr or dq lookup
+/// @param[in] i_tag tags_t the tag to find the index of
+/// @return size_t the attribute array index
///
inline size_t index(const tags_t& i_type, const tags_t& i_tag)
{
@@ -121,18 +121,18 @@ typedef std::vector< std::pair<tags_t, slew_per_imp_t> > slew_table_t;
///
/// @brief Run the sle calibration engine
-/// @param[in] i_target, the MCBIST
+/// @param[in] i_target the MCBIST
/// @return FAPI2_RC_SUCCESS iff OK
///
fapi2::ReturnCode slew_cal(const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target);
///
/// @brief Process FFDC for slew calibration
-/// @param[in] MCA (port) target
-/// @param[in] a vector of the steps which came before me
-/// @param[in] the slew table to be operated on
-/// @param[in] the calibration status
-/// @param[in] the register value
+/// @param[in] i_target MCA (port) target
+/// @param[in] -_where_am_i a vector of the steps which came before me
+/// @param[in] l_slew_rate the slew table to be operated on
+/// @param[in] i_status the calibration status
+/// @param[in] i_reg the register value
/// @return A fapi2::ReturnCode, appropriate for the calibration status
///
fapi2::ReturnCode slew_cal_status(const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target,
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/bit_count.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/bit_count.H
index 6292100d0..adae75ffb 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/bit_count.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/bit_count.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -37,8 +37,8 @@ namespace mss
///
/// @brief Count the bits in a T which are set (1)
-/// @tparam T, an integral type. e.g., uint64_t, uint8_t
-/// @param[in] the value to check, count
+/// @tparam T an integral type. e.g., uint64_t, uint8_t
+/// @param[in] i_value the value to check, count
/// @return uint64_t the number of bits set in the input
///
template< typename T, typename std::enable_if<std::is_integral<T>::value, int>::type = 0>
@@ -57,7 +57,7 @@ inline uint64_t bit_count(const T& i_value)
///
/// @brief Return the bit position of the first bit set, from the left
/// @tparam T, an integral type. e.g., uint64_t, uint8_t
-/// @param[in] the value to check
+/// @param[in] i_value the value to check
/// @return uint64_t the bit position of the first set bit
/// @bote assumes you checked to make sure there were bits set because it will return 0
///
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H
index 07fa67d08..a91715876 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H
@@ -40,7 +40,7 @@ namespace check
{
///
/// @brief Checks homogenous DDR4 dimm configuration (e.g. DDR4)
-/// @param[in] const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target_mcs
+/// @param[in] i_target_mcs const fapi2::Target<fapi2::TARGET_TYPE_MCS>&
/// @return FAPI2_RC_SUCCESS iff ok
///
inline fapi2::ReturnCode dram_type(const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target_mcs)
@@ -83,8 +83,8 @@ fapi_try_exit:
///
/// @brief Check if there is DIMM mixing (and deconfigures unsupported mixing <shrug> ?? - AAM)
-/// @param[in] const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target_mcs
-/// @param[out] uint64_t& o_module_type (returns something ?? - AAM )
+/// @param[in] i_target_mcs const fapi2::Target<fapi2::TARGET_TYPE_MCS>&
+/// @param[out] o_module_type uint64_t (returns something ?? - AAM )
/// @return FAPI2_RC_SUCCESS iff ok
/// @note Functionality currently unknown
///
@@ -138,9 +138,6 @@ inline fapi2::ReturnCode dimm_mixing(const fapi2::Target<fapi2::TARGET_TYPE_MCS>
///
/// @brief Checks what type of system is configured (i.e., single drop, dual drop)
-/// @param[in] Unknown
-/// @param[out] Unknown
-/// @return FAPI2_RC_SUCCESS iff ok
/// @note Functionality currently unknown
///
inline fapi2::ReturnCode system_drop_type(void)
@@ -193,8 +190,8 @@ fapi_try_exit:
///
/// @brief Checks nominal voltage is correct for all DIMMs
-/// @param[in] const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target_mcs,
-/// fapi2::TargetState dimm_state
+/// @param[in] i_target_mcsi const fapi2::Target<fapi2::TARGET_TYPE_MCS>&,
+/// dimm_state i fapi2::TargetState
/// @return ReturnCode
///
inline fapi2::ReturnCode module_nominal_voltage(const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target_mcs,
@@ -236,11 +233,12 @@ namespace spd
{
///
/// @brief Checks conditional passes and implements traces & exits if it fails
-/// @tparam T spd_data, of any size
-/// @param[in] const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target,
-/// bool conditional
-/// size_t spd_byte_index
-/// const char* err_str
+/// @tparam T spd_data of any size
+/// @param[in] i_target const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& ,
+/// conditional bool,
+/// spd_byte_index size_t,
+// spd_data T,
+/// err_str const char*
/// @return ReturnCode
///
template< typename T >
@@ -268,11 +266,12 @@ fapi_try_exit:
///
/// @brief Checks conditional passes and implements traces if it fails
-/// @tparam T spd_data, of any size
-/// @param[in] const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target,
-/// bool conditional
-/// size_t spd_byte_index
-/// const char* err_str
+/// @tparam T spd_data of any size
+/// @param[in] i_targeti const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& ,
+/// conditional bool,
+/// spd_byte_index size_t,
+// spd_data T,
+/// err_str const char*
/// @return void
///
template< typename T >
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/conversions.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/conversions.H
index d637daf17..7fd1079d1 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/conversions.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/conversions.H
@@ -44,7 +44,7 @@ namespace mss
///
/// @brief Return the number of picoseconds taken by a certain mhz
-/// @param[in] i_mhz - the mhz of interest
+/// @param[in] i_mhz the mhz of interest
/// @return the picoseconds
///
inline uint64_t mhz_to_ps(const uint64_t i_mhz)
@@ -76,7 +76,7 @@ inline uint64_t mhz_to_ps(const uint64_t i_mhz)
///
/// @brief Translate from cycles to sim cycles
-/// @param[in] i_cycles, the cycles to translate
+/// @param[in] i_cycles the cycles to translate
/// @return uint64_t, the number of sim cycles.
///
inline uint64_t cycles_to_simcycles( const uint64_t i_cycles )
@@ -87,8 +87,8 @@ inline uint64_t cycles_to_simcycles( const uint64_t i_cycles )
///
/// @brief Return the number of cycles contained in a count of picoseconds
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_ps, the number of picoseconds to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_ps the number of picoseconds to convert
/// @return uint64_t, the number of cycles
///
template< fapi2::TargetType T >
@@ -124,8 +124,8 @@ fapi_try_exit:
///
/// @brief Return the number of ps contained in a count of cycles
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_ps, the number of cycles to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_cycles the number of cycles to convert
/// @return uint64_t, the number of picoseconds
///
template< fapi2::TargetType T >
@@ -151,8 +151,8 @@ fapi_try_exit:
///
/// @brief Return the number of cycles contained in a count of microseconds
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_ps, the number of microseconds to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_us the number of microseconds to convert
/// @return uint64_t, the number of cycles
///
template< fapi2::TargetType T >
@@ -163,8 +163,8 @@ inline uint64_t us_to_cycles(const fapi2::Target<T>& i_target, const uint64_t i_
///
/// @brief Return the number of cycles contained in a count of nanoseconds
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_ps, the number of nanoseconds to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_ps the number of nanoseconds to convert
/// @return uint64_t, the number of cycles
///
template< fapi2::TargetType T >
@@ -175,10 +175,10 @@ inline uint64_t ns_to_cycles(const fapi2::Target<T>& i_target, const uint64_t i_
///
/// @brief Return the number of microseconds contained in a count of cycles
-/// @tparam T, the target type
-/// @tparam D, the time conversion (NS_IN_PS, etc)
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_ps, the number of cycles to convert
+/// @tparam T the target type
+/// @tparam D the time conversion (NS_IN_PS, etc)
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_cycles the number of cycles to convert
/// @return uint64_t, the number of microseconds
///
template< fapi2::TargetType T, uint64_t D >
@@ -195,8 +195,8 @@ inline uint64_t cycles_to_time(const fapi2::Target<T>& i_target, const uint64_t
///
/// @brief Return the number of nanoseconds contained in a count of cycles
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_cycles, the number of cycles to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_cycles the number of cycles to convert
/// @return uint64_t, the number of nanoseconds
///
template< fapi2::TargetType T >
@@ -210,8 +210,8 @@ inline uint64_t cycles_to_ns(const fapi2::Target<T>& i_target, const uint64_t i_
///
/// @brief Return the number of microseconds contained in a count of cycles
-/// @param[in] i_target, target for the frequency attribute
-/// @param[in] i_cycles, the number of cycles to convert
+/// @param[in] i_target target for the frequency attribute
+/// @param[in] i_cycles the number of cycles to convert
/// @return uint64_t, the number of microseconds
///
template< fapi2::TargetType T >
@@ -225,8 +225,8 @@ inline uint64_t cycles_to_us(const fapi2::Target<T>& i_target, const uint64_t i_
///
/// @brief Calculate TWLO_TWLOE - this needs to go in to eff_config and be an attribute
-/// @tparam fapi2::TargetType T of the target used to calculate cycles from ns
-/// @param[in] i_target, the target used to get DIMM clocks
+/// @tparam T fapi2::TargetType of the target used to calculate cycles from ns
+/// @param[in] i_target the target used to get DIMM clocks
/// @return uint64_t, TWLO_TWLOE in cycles
///
template< fapi2::TargetType T >
@@ -237,7 +237,7 @@ inline uint64_t twlo_twloe(const fapi2::Target<T>& i_target)
///
/// @brief Convert nanoseconds to picoseconds
-/// @param[in] int64_t i_time_in_ns, time in nanoseconds
+/// @param[in] i_time_in_ns int64_t time in nanoseconds
/// @return int64_t, time in picoseconds
///
inline int64_t ns_to_ps(const int64_t& i_time_in_ns)
@@ -247,7 +247,7 @@ inline int64_t ns_to_ps(const int64_t& i_time_in_ns)
///
/// @brief Convert nanoseconds to picoseconds
-/// @param[in] int64_t i_time_in_ps, time in picoseconds
+/// @param[in] i_time_in_ps int64_t time in picoseconds
/// @return int64_t, time in nanoseconds
///
inline int64_t ps_to_ns(const int64_t& i_time_in_ps)
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/dump_regs.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/dump_regs.H
index f04d735bb..5209fa7e9 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/dump_regs.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/dump_regs.H
@@ -38,7 +38,7 @@ namespace mss
///
/// @brief Dump the registers of a target
/// @tparam T, the fapi2::TargetType
-/// @param[in] i_target, the target in question
+/// @param[in] i_target the target in question
/// @return fapi2::FAPI2_RC_SUCCESS if ok
///
template< fapi2::TargetType T >
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.C b/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.C
index 1fd1d1401..ed6c8a3ea 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.C
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -28,7 +28,7 @@
// *HWP Consumed by: HB:FSP
#include "fake_spd.H"
-
+#ifndef DOXYGEN
/// DIMM data was taken from /afs/awd.austin.ibm.com/projects/eclipz/lab/p8/gsiexe/
/// 78P0AAM_DDR4_8G1RX8_mu/MICRON_SPD_8G_1Rx8_DDR4_2400_RDIMM.hex on 7/31/2015.
@@ -92,4 +92,4 @@ fapi2::ReturnCode getSPD(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target,
return fapi2::FAPI2_RC_SUCCESS;
}
-
+#endif
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.H
index 30161339e..57709e175 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/fake_spd.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -26,26 +26,27 @@
// *HWP Team: Memory
// *HWP Level: 2
// *HWP Consumed by: HB:FSP
-
+#ifndef DOXYGEN
#ifndef _MSS_FAKE_SPD_H_
-#define _MSS_FAKE_SPD_H_
+ #define _MSS_FAKE_SPD_H_
-#include <fapi2.H>
+ #include <fapi2.H>
-///
-/// @brief Return a blob of SPD data from a DIMM
-/// @param[in] i_target, a DIMM target representing the DIMM in question
-/// @param[out] o_blob, the blob of data from the DIMM - raw
-/// @param[out] o_size, o_size, the size of the blob
-/// @return FAPI2_RC_SUCCESS if there's no problem
-/// @note passing nullptr for o_blob will return the size of the blob
-/// size_t s;
-/// FAPI_TRY( getSPD(d->target(), nullptr, s) );
-/// {
-/// uint8_t blob[s];
-/// FAPI_TRY( getSPD(d->target(), blob, s) );
-/// }
-///
-fapi2::ReturnCode getSPD(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target, uint8_t* o_blob, size_t& s);
+ ///
+ /// @brief Return a blob of SPD data from a DIMM
+ /// @param[in] i_target, a DIMM target representing the DIMM in question
+ /// @param[out] o_blob, the blob of data from the DIMM - raw
+ /// @param[out] o_size, o_size, the size of the blob
+ /// @return FAPI2_RC_SUCCESS if there's no problem
+ /// @note passing nullptr for o_blob will return the size of the blob
+ /// size_t s;
+ /// FAPI_TRY( getSPD(d->target(), nullptr, s) );
+ /// {
+ /// uint8_t blob[s];
+ /// FAPI_TRY( getSPD(d->target(), blob, s) );
+ /// }
+ ///
+ fapi2::ReturnCode getSPD(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target, uint8_t* o_blob, size_t& s);
#endif
+#endif
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/find.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/find.H
index 15c559d38..a13c1cd62 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/find.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/find.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -39,7 +39,7 @@ namespace mss
/// @brief find a set of elements based on a fapi2 target
/// @tparam M the target type to be returned
/// @tparam T the fapi2 target type of the argument
-/// @param[in] the fapi2 target, T
+/// @param[in] i_target the fapi2 target T
/// @return a vector of M targets.
///
template< fapi2::TargetType M, fapi2::TargetType T >
@@ -49,7 +49,7 @@ inline std::vector< fapi2::Target<M> > find_targets( const fapi2::Target<T>& );
/// @brief find an element based on a fapi2 target
/// @tparam M the target type to be returned
/// @tparam T the fapi2 target type of the argument
-/// @param[in] the fapi2 target, T
+/// @param[in] the fapi2 target T
/// @return an M target.
///
template< fapi2::TargetType M, fapi2::TargetType T >
@@ -57,7 +57,7 @@ inline fapi2::Target<M> find_target( const fapi2::Target<T>& );
///
/// @brief find the McBIST given a McBIST
-/// @param[in] the fapi2 target, mcBIST
+/// @param[in] i_self the fapi2 target mcBIST
/// @return a McBIST target.
///
template<>
@@ -68,7 +68,7 @@ inline fapi2::Target<fapi2::TARGET_TYPE_MCBIST> find_target( const fapi2::Target
///
/// @brief find the McBIST given a DIMM
-/// @param[in] the fapi2 target, DIMM
+/// @param[in] i_target the fapi2 target DIMM
/// @return a McBIST target.
///
template<>
@@ -79,7 +79,7 @@ inline fapi2::Target<fapi2::TARGET_TYPE_MCBIST> find_target( const fapi2::Target
///
/// @brief find the McBIST given a MCA
-/// @param[in] the fapi2 target, MCA
+/// @param[in] i_target the fapi2 target MCA
/// @return a McBIST target.
///
template<>
@@ -91,7 +91,7 @@ inline fapi2::Target<fapi2::TARGET_TYPE_MCBIST> find_target( const fapi2::Target
///
/// @brief find all the dimm connected to an MCS
-/// @param[in] a fapi2::Target MCS
+/// @param[in] i_target a fapi2::Target MCS
/// @return a vector of fapi2::TARGET_TYPE_DIMM
///
template<>
@@ -112,7 +112,7 @@ inline std::vector< fapi2::Target<fapi2::TARGET_TYPE_DIMM> > find_targets( const
///
/// @brief find all the dimm connected to an MCBIST
-/// @param[in] a fapi2::Target MCBIST
+/// @param[in] i_target a fapi2::Target MCBIST
/// @return a vector of fapi2::TARGET_TYPE_DIMM
///
template<>
@@ -132,7 +132,7 @@ inline std::vector< fapi2::Target<fapi2::TARGET_TYPE_DIMM> > find_targets( const
///
/// @brief find all the MCS connected to an MCBIST
-/// @param[in] a fapi2::Target MCBIST
+/// @param[in] i_target a fapi2::Target MCBIST
/// @return a vector of fapi2::TARGET_TYPE_MCS
/// @note Cronus should support MCS children of an MCBIST - so this might be temporary
///
@@ -162,7 +162,7 @@ inline std::vector< fapi2::Target<fapi2::TARGET_TYPE_MCS> > find_targets( const
///
/// @brief find the MCS given a DIMM
-/// @param[in] the fapi2 target, DIMM
+/// @param[in] i_target the fapi2 target DIMM
/// @return a MCS target.
///
template<>
@@ -173,7 +173,7 @@ inline fapi2::Target<fapi2::TARGET_TYPE_MCS> find_target( const fapi2::Target<fa
///
/// @brief find the MCA given a DIMM
-/// @param[in] the fapi2 target, DIMM
+/// @param[in] i_target the fapi2 target DIMM
/// @return a MCA target.
///
template<>
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/index.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/index.H
index aa9474895..b5024172c 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/index.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/index.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -38,8 +38,8 @@ namespace mss
{
///
/// @brief Return an attribute array index from a fapi2 target
-/// @tparam T, the fapi2::TargetType
-/// @param[in] i_target, a DIMM target representing the DIMM in question
+/// @tparam T the fapi2::TargetType
+/// @param[in] i_target a DIMM target representing the DIMM in question
/// @return size_t, the attribute array index.
///
template< fapi2::TargetType T >
@@ -59,7 +59,7 @@ inline size_t index(const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target)
///
/// @brief Return an attribute array index from a rank number
-/// @param[in] uint64_t, a rank number DIMM0 {0, 1, 2, 3} DIMM1 {0, 1, 2, 3}
+/// @param[in] i_rank uint64_t a rank number DIMM0 {0, 1, 2, 3} DIMM1 {0, 1, 2, 3}
/// @return size_t, the attribute array index.
///
inline size_t index(const uint64_t i_rank)
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/poll.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/poll.H
index a1c03a692..785094f4f 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/poll.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/poll.H
@@ -48,9 +48,9 @@ struct poll_probe
{
///
/// @brief poll-probe constructor
- /// @param[in] i_target, the target for the scom operation
- /// @param[in] i_tag, some useful text to output with the register data
- /// @param[in] i_register, the register for the scom operation
+ /// @param[in] i_target the target for the scom operation
+ /// @param[in] i_tag some useful text to output with the register data
+ /// @param[in] i_register the register for the scom operation
///
poll_probe( const fapi2::Target<T>& i_target, const char* i_tag, const uint64_t i_register ):
iv_target(i_target),
@@ -121,7 +121,7 @@ struct poll_parameters
/// {
/// return true;
/// }
-/// @param[in] i_probes, a vector of poll_probes to be used in the polling loop (optional)
+/// @param[in] i_probes a vector of poll_probes to be used in the polling loop (optional)
/// @return bool, true iff poll criteria was met before the number of iterations
/// ran out.
/// @warning If you want to handle a failure as an error, you need to wrap
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/pos.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/pos.H
index 18dadf701..e121ea870 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/pos.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/pos.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -64,8 +64,8 @@ class posTraits<fapi2::TARGET_TYPE_PROC_CHIP>
///
/// @brief Return a target's position from a fapi2 target
-/// @tparam T, the fapi2::TargetType
-/// @param[in] i_target, a DIMM target representing the DIMM in question
+/// @tparam T the fapi2::TargetType
+/// @param[in] i_target a DIMM target representing the DIMM in question
/// @return The position
///
template< fapi2::TargetType T, typename TT = posTraits<T> >
diff --git a/src/import/chips/p9/procedures/hwp/memory/lib/utils/swizzle.H b/src/import/chips/p9/procedures/hwp/memory/lib/utils/swizzle.H
index 57814b265..f30fc3d2b 100644
--- a/src/import/chips/p9/procedures/hwp/memory/lib/utils/swizzle.H
+++ b/src/import/chips/p9/procedures/hwp/memory/lib/utils/swizzle.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -37,10 +37,10 @@ namespace mss
///
/// @brief Swap two bits in a buffer
-/// @tparam TB, the bit in the buffer to move to SB
-/// @tparam SB, the bit in the buffer to move to TB
-/// @tparam T, integral type of the buffer
-/// @param[in,out] io_data, reference to the buffer
+/// @tparam TB the bit in the buffer to move to SB
+/// @tparam SB the bit in the buffer to move to TB
+/// @tparam T integral type of the buffer
+/// @param[in,out] i_data reference to the buffer
/// @return reference to the input buffer (for chaining)
///
template< uint64_t TB, uint64_t SB, typename T >
@@ -55,9 +55,9 @@ inline fapi2::buffer<T>& swap( fapi2::buffer<T>& i_data )
///
/// @brief Invert (negate) one bit in a buffer
-/// @tparam TB, the bit in the buffer to negate
-/// @tparam T, integral type of the buffer
-/// @param[in,out] io_data, reference to the buffer
+/// @tparam TB the bit in the buffer to negate
+/// @tparam T integral type of the buffer
+/// @param[in,out] io_data reference to the buffer
/// @return reference to the input buffer (for chaining)
///
template< uint64_t TB, typename T >
@@ -97,11 +97,11 @@ static inline void reverse( T& io_buffer )
///
/// @brief Swizzle bits between two fapi2 buffers, and insert from source to destination
-/// @tparam DS, the start bit in the destination buffer - swizzle will count up from here
-/// @tparam L, how many bits to swizzle
-/// @tparam SS, the start bit in the source buffer - swizzle will count down from here
-/// @param[in] source buffer - these bits will be decremented
-/// @param[in] destination buffer - these bits will be incremented
+/// @tparam DS the start bit in the destination buffer - swizzle will count up from here
+/// @tparam L how many bits to swizzle
+/// @tparam SS the start bit in the source buffer - swizzle will count down from here
+/// @param[in] i_source source buffer - these bits will be decremented
+/// @param[in] o_destination destination buffer - these bits will be incremented
/// @return reference to the destination
///
template<uint64_t DS, uint64_t L, uint64_t SS, typename SB, typename DB>
OpenPOWER on IntegriCloud