Clean up typos/small things with expscom directory

A few comment typos were lingering in the new expscom module directory. This commit addresses those typos and also removes and Change-Id: If9c9692336591a7e0e57751676d76fd947add1cd Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/68915 Tested-by: Jenkins Server <[email protected]> Tested-by: Jenkins OP Build CI <[email protected]> Tested-by: Jenkins OP HW <[email protected]> Tested-by: FSP CI Jenkins <[email protected]> Reviewed-by: Matt Derksen <[email protected]> Reviewed-by: Daniel M. Crowell <[email protected]>
open-power · Nov 27, 2018 · f63977b · f63977b
1 parent 14dbbd6
commit f63977b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/usr/expscom/README.md b/src/usr/expscom/README.md
@@ -150,12 +150,12 @@ targets will be processed (lets say for now this is IBM scom address):
 
     fapi2::getScom(myOcmbTarget, scomAddr, io_buffer);
 
-* Platform Specifc FAPI2 getScom API
+* Platform Specific FAPI2 getScom API
 
 
     fapi2::platGetScom(myOcmbTarget, scomAddr, io_buffer);
 
-* Platform Specifc FAPI2 getScom API resolves to calling into our device framework to whatever
+* Platform Specific FAPI2 getScom API resolves to calling into our device framework to whatever
 function is registered to read OCMB target for DeviceFW::SCOM operations
 
 
@@ -241,7 +241,8 @@ for OCMB target scoms so we will end up calling doScomOp
                   DeviceFW::MMIO,
                   address, readLimit);
 
-* mmioPerformOp resolves to doing a memcpy on the address requested
+* mmioPerformOp will execute the actual load/store operation input memory-mapped i/o
+space and handle errors in that operation
 
 
     if (i_opType == DeviceFW::READ)

diff --git a/src/usr/expscom/expscom_utils.C b/src/usr/expscom/expscom_utils.C
@@ -35,17 +35,17 @@
 #include <errl/errlmanager.H>        // errlCommit
 #include <errl/errludtarget.H>       // ErrlUserDetailsTarget
 #include <devicefw/driverif.H>       // OperationType
-#include <expscom/expscom_reasoncodes.H>
-#include "expscom_trace.H"
-#include "expscom_utils.H"
+#include <expscom/expscom_reasoncodes.H> // ReasonCodes/ModuleIds
+#include "expscom_trace.H" //g_trac_expscom
+#include "expscom_utils.H" //validateInputs
 
 namespace EXPSCOM
 {
 
 constexpr uint64_t FIRST_4_BYTES = 0xFFFFFFFF00000000;
 
 ///////////////////////////////////////////////////////////////////////////////
-// See above for doxygen documentation
+// See header file for doxygen documentation
 ///////////////////////////////////////////////////////////////////////////////
 errlHndl_t validateInputs(DeviceFW::OperationType i_opType,
                           const TARGETING::Target* i_target,

diff --git a/src/usr/expscom/i2cscomdd.C b/src/usr/expscom/i2cscomdd.C
@@ -35,8 +35,7 @@
 #include <lib/i2c/exp_i2c_scom.H>  // i2c_get_scom
 #include <errl/errludtarget.H>     // ErrlUserDetailsTarget
 #include <hwpf/fapi2/include/fapi2_hwp_executor.H> // FAPI_EXEC_HWP
-#include <expscom/expscom_reasoncodes.H> //  EXPSCOM::MOD_I2CSCOM_PERFORM_OP
-#include "i2cscomdd.H" //i2cScomPerformOp
+#include "i2cscomdd.H"     //i2cScomPerformOp
 #include "expscom_trace.H" //g_trac_expscom
 #include "expscom_utils.H" //validateInputs