Add support for linux command to set OCC state.

Change-Id: I1ac4d810e0f4509dc89c645bef183f5cb2179b1c
RTC: 115213
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/15154
Tested-by: Jenkins Server
Reviewed-by: Douglas R. Gilbert <dgilbert@us.ibm.com>
Reviewed-by: Matt Spinler <spinler@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 25 insertions, 1 deletions

diff --git a/src/include/usr/htmgt/htmgt.H b/src/include/usr/htmgt/htmgt.H
index 9ae8d78e4..28ead6252 100755
--- a/src/include/usr/htmgt/htmgt.H
+++ b/src/include/usr/htmgt/htmgt.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2014                             */
+/* Contributors Listed Below - COPYRIGHT 2014,2015                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -83,6 +83,30 @@ namespace HTMGT
      */
     void processOccReset(TARGETING::Target * i_failedOccTarget);
 
+
+
+    /**
+     * @brief Change the OCC state
+     *
+     * @details  This is a blocking call that will change the OCC state.
+     *           The OCCs will only actuate (update processor frequency/
+     *           voltages) when in Active state.  The OCC will only be
+     *           monitoring/observing when in Observation state.
+     *
+     * @note     When the OCCs are initially started, the state will default
+     *           to Active.  If the state is changed to Observation, that
+     *           state will be retained until the next IPL. (If the OCC would
+     *           get reset, it would return to the last requested state)
+     *
+     *
+     * @param[in]  i_occActivation  set to TRUE to move OCC to Active state
+     *                              or FALSE to move OCC to Observation state
+     *
+     * @returns  NULL on success, or an error handle if the state did not
+     *           change.
+     */
+    errlHndl_t enableOccActuation(bool i_occActivation);
+
 }
 
 #endif // HTMGT_H