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/dimm/rank.C | |
| 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/dimm/rank.C')
| -rw-r--r-- | src/import/chips/p9/procedures/hwp/memory/lib/dimm/rank.C | 32 |
1 files changed, 16 insertions, 16 deletions
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<> |
