summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/usr/fapi2/test/fapi2Test.H2
-rw-r--r--src/usr/fapi2/test/fapi2TestUtils.H12
2 files changed, 11 insertions, 3 deletions
diff --git a/src/usr/fapi2/test/fapi2Test.H b/src/usr/fapi2/test/fapi2Test.H
index 76a86a183..f992bb47c 100644
--- a/src/usr/fapi2/test/fapi2Test.H
+++ b/src/usr/fapi2/test/fapi2Test.H
@@ -28,7 +28,7 @@
/**
* @file fapi2Test.H
*
- * @brief Test case for SCOM code
+ * @brief Test case for FAPI2 code
*/
#include <cxxtest/TestSuite.H>
diff --git a/src/usr/fapi2/test/fapi2TestUtils.H b/src/usr/fapi2/test/fapi2TestUtils.H
index 15ddb0b6a..f4e9f5dc8 100644
--- a/src/usr/fapi2/test/fapi2TestUtils.H
+++ b/src/usr/fapi2/test/fapi2TestUtils.H
@@ -37,7 +37,9 @@
namespace fapi2
{
-// Setup some targets to use
+
+//Used by generateTargets to get a list of all platform target
+// types that directly relate to fapi2 target types
enum{
MY_EQ,
MY_EX,
@@ -57,7 +59,13 @@ enum{
NUM_TARGETS
};
-
+///
+/// @brief Generates a list of platform targets of all differnt types.
+/// This comes in handy when testing out fapi2 target interfaces
+/// @param[in] i_pMasterProcChip Pointer to master proc chip
+/// @param[out] o_targetList List of platform targets that gets generated
+/// by this function
+///
void generateTargets(TARGETING::Target* i_pMasterProcChip,
TARGETING::Target* o_targetList[]);
OpenPOWER on IntegriCloud