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/checker.H | |
| 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/checker.H')
| -rw-r--r-- | src/import/chips/p9/procedures/hwp/memory/lib/utils/checker.H | 35 |
1 files changed, 17 insertions, 18 deletions
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 > |
