RTC3034 - Initial Presence Setting

- initial commit
- cleanup
- fix review comments

Change-Id: Ie8ad14a798d5e1dfcc3dc46fc1552cf44ededefe
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/508
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>
Reviewed-by: Nicholas E. Bofferding <bofferdn@us.ibm.com>
Reviewed-by: Mark W. Wenning <wenning@us.ibm.com>

1 files changed, 9 insertions, 4 deletions

diff --git a/src/include/usr/hwas/hwas.H b/src/include/usr/hwas/hwas.H
index 883de2dd0..e8e0a6a16 100644
--- a/src/include/usr/hwas/hwas.H
+++ b/src/include/usr/hwas/hwas.H
@@ -47,10 +47,15 @@ namespace   HWAS
      * @brief   init_target_states
      *
      *  Currently the state of every target is held in one bitmapped attribute
-     *  called HWAS_STATE.  HWAS_STATES is a read-only attribute - defaults are
-     *  stored in flash, so they are already initialized.
-     *  See src/user/errl/targeting/xmltohb/hb.xml for the settings.
-     *  This is left as a placeholder when/if we add more attributes.
+     *  called HWAS_STATE.
+     *
+     *  This routine will walk through all the targets and initialize HWAS STATE
+     *  to a known default value.  This is useful if the developer wishes to
+     *  clean everything up to an known state - as such it is the very first
+     *  istep to run.
+     *
+     *  Currently everything is initialized to to powered off, etc. - init_fsi
+     *  and apply_fsi_info (the next isteps) will change this almost immediately.
      *
      *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
      *                              or NULL.