diff options
author | Jacob Harvey <jlharvey@us.ibm.com> | 2016-02-05 15:24:59 -0600 |
---|---|---|
committer | Daniel M. Crowell <dcrowell@us.ibm.com> | 2016-04-01 21:23:21 -0400 |
commit | dba9ee6be396b29a072d9c5fc87ff346542c396e (patch) | |
tree | d3edf1b1207aad6dd8d7b9b93473067be1dd6e48 /src/import/chips/p9/procedures/hwp/memory/lib/utils | |
parent | a08c13b301d1ee48a40474261711c6dc8174b108 (diff) | |
download | talos-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>
Diffstat (limited to 'src/import/chips/p9/procedures/hwp/memory/lib/utils')
11 files changed, 102 insertions, 102 deletions
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> |