summaryrefslogtreecommitdiffstats
path: root/src/import
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-02-22 10:47:11 -0600
commit529bc00680ae453c54e0790f501015abafabcb0e (patch)
tree197ac967ecafe80bbfc6795e7fc4b75d57a9356a /src/import
parent3da7cf34b72d97494dc5a2ed414a4e2d6db5f261 (diff)
downloadtalos-hostboot-529bc00680ae453c54e0790f501015abafabcb0e.tar.gz
talos-hostboot-529bc00680ae453c54e0790f501015abafabcb0e.zip
Fixed doxygen errors and typos
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://gfw160.aus.stglabs.ibm.com:8080/gerrit/24538 Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Diffstat (limited to 'src/import')
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_draminit_training.H4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_eff_config_thermal.H4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.C4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.H12
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.C4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.H4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.C4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.H6
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_scominit.H4
-rw-r--r--src/import/chips/p9/procedures/hwp/memory/p9_mss_scrub.C4
10 files changed, 25 insertions, 25 deletions
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_draminit_training.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_draminit_training.H
index 4a4860d4f..26071c44f 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_draminit_training.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_draminit_training.H
@@ -39,8 +39,8 @@ extern "C"
///
/// @brief Train dram, assumes effective config has run
- /// @param[in] i_target, the McBIST of the ports of the dram you're training
- /// @param[in] i_special_training, optional CAL_STEP_ENABLE override. Used in sim, debug
+ /// @param[in] i_target the McBIST of the ports of the dram you're training
+ /// @param[in] i_special_training optional CAL_STEP_ENABLE override. Used in sim, debug
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_draminit_training( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target,
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_eff_config_thermal.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_eff_config_thermal.H
index e6736f466..6cf26d99e 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_eff_config_thermal.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_eff_config_thermal.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -39,7 +39,7 @@ extern "C"
///
/// @brief Perform thermal calculations as part of the effective configuration
-/// @param[in] i_target, the controller (e.g., MCS)
+/// @param[in] i_target the controller (e.g., MCS)
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_eff_config_thermal( const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target );
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.C b/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.C
index 9cadeb6b0..524e2fe5b 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.C
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -36,7 +36,7 @@ using fapi2::FAPI2_RC_SUCCESS;
///
/// @brief Calculate and save off DIMM frequencies
-/// @param[in] i_target, the controller (e.g., MCS)
+/// @param[in] i_target the controller (e.g., MCS)
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_freq( const fapi2::Target<TARGET_TYPE_MCS>& i_target )
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.H
index f18b29341..4f00b7c0f 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_freq.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -60,7 +60,7 @@ enum frequencies : std::uint64_t
///
/// @brief Calculate frequency
/// @tparam T input
-/// @param[in] T i_clock
+/// @param[in] i_clock T
/// @return T (frequency)
///
template<typename T>
@@ -77,7 +77,7 @@ inline T calc_freq(T i_clock)
///
/// @brief Calculate timing value (e.g.tCK, tAA, etc.)
/// @tparam T input
-/// @param[in] T i_freq
+/// @param[in] i_freq T
/// @return T (timing)
///
template<typename T>
@@ -92,8 +92,8 @@ inline T calc_clock (T i_freq)
///
/// @brief Calculate CAS latency
-/// @tparam[in] T tAA_max,
-/// T tCKmax
+/// @tparam[in] T
+/// @param[in] tAA_max T,tCKmax T
/// @return T cas_latency
///
template<typename T>
@@ -116,7 +116,7 @@ extern "C"
///
/// @brief Calculate and save off DIMM frequencies
- /// @param[in] i_target, the controller (e.g., MCS)
+ /// @param[in] i_target the controller (e.g., MCS)
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_freq( const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target );
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.C b/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.C
index e7bb3b974..e36522c67 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.C
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -36,7 +36,7 @@ extern "C"
{
///
/// @brief Pattern test the DRAM
-/// @param[in] i_target, the McBIST of the ports of the dram you're training
+/// @param[in] i_target the McBIST of the ports of the dram you're training
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_memdiag( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.H
index df17ba84c..6ffef09ba 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_memdiag.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -37,7 +37,7 @@ extern "C"
{
///
/// @brief Pattern test the DRAM
-/// @param[in] i_target, the McBIST of the ports of the dram you're training
+/// @param[in] i_target the McBIST of the ports of the dram you're training
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_memdiag( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.C b/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.C
index 286a0632a..c29c5e4cd 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.C
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -36,7 +36,7 @@ extern "C"
{
///
/// @brief Perform any necessary power cleanup
-/// @param[in] i_target, the McBIST of the ports of the dram you're training
+/// @param[in] i_target the McBIST of the ports of the dram you're training
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_power_cleanup( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.H
index 33141d8fa..b9741cb20 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_power_cleanup.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -17,7 +17,7 @@
/* */
/* IBM_PROLOG_END_TAG */
-/// @file p9_mss_powercleanup.H
+/// @file p9_mss_power_cleanup.H
/// @brief Perform any necessary power cleanup
///
// *HWP HWP Owner: Brian Silver <bsilver@us.ibm.com>
@@ -37,7 +37,7 @@ extern "C"
{
///
/// @brief Perform any necessary power cleanup
-/// @param[in] i_target, the McBIST of the ports of the dram you're training
+/// @param[in] i_target the McBIST of the ports of the dram you're training
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_power_cleanup( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_scominit.H b/src/import/chips/p9/procedures/hwp/memory/p9_mss_scominit.H
index c0ee61a64..ef1e6ab90 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_scominit.H
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_scominit.H
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -39,7 +39,7 @@ extern "C"
///
/// @brief SCOM inits for PHY, MC
-/// @param[in] i_target, the MCBIST
+/// @param[in] i_target the MCBIST
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_scominit( const fapi2::Target<fapi2::TARGET_TYPE_MCBIST>& i_target );
diff --git a/src/import/chips/p9/procedures/hwp/memory/p9_mss_scrub.C b/src/import/chips/p9/procedures/hwp/memory/p9_mss_scrub.C
index a79a22d69..84b85cea0 100644
--- a/src/import/chips/p9/procedures/hwp/memory/p9_mss_scrub.C
+++ b/src/import/chips/p9/procedures/hwp/memory/p9_mss_scrub.C
@@ -7,7 +7,7 @@
/* */
/* EKB Project */
/* */
-/* COPYRIGHT 2015 */
+/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
@@ -35,7 +35,7 @@ using fapi2::FAPI2_RC_SUCCESS;
///
/// @brief Begin background scrub
-/// @param[in] i_target, MCBIST
+/// @param[in] i_target MCBIST
/// @return FAPI2_RC_SUCCESS iff ok
///
fapi2::ReturnCode p9_mss_scrub( const fapi2::Target<TARGET_TYPE_MCBIST>& i_target )
OpenPOWER on IntegriCloud