Use new scratch reg for hb_done and set early in IPL

This is to support using the scratch register for the power off
message.  I moved to a new scratch register since we were sharing
with a SBE scratch reg that was needed early in HB IPL.
NOTE! This will have a co-req with an FSP track so we'll need to
coordinate.

CMVC-Coreq: 917527
Change-Id: I5f81f15126d6ad8d2c9459c5afe730554256c037
RTC: 95818
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/9220
Tested-by: Jenkins Server
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: MIKE J. JONES <mjjones@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 15 insertions, 0 deletions

diff --git a/src/include/kernel/misc.H b/src/include/kernel/misc.H
index a7e40356d..19427c399 100644
--- a/src/include/kernel/misc.H
+++ b/src/include/kernel/misc.H
@@ -50,6 +50,21 @@ namespace KernelMisc
     /** @brief master host boot instance number (node) */
     extern uint64_t g_masterHBInstance;
 
+    /** @brief Indicate whether HB is running or not */
+    enum HbRunning
+    {
+        HB_RUNNING = 0,
+        HB_SHUTDOWN = 1,
+    };
+
+    /** @fn setHbScratchStatus
+     *  @brief Set scratch register indicating HB running status
+     *
+     *  @param i_status Indicates whether to say HB is running or shutdown
+     *  @return void
+     */
+    void setHbScratchStatus(enum HbRunning i_status);
+
     /** @fn in_kernel_mode
      *  @brief Determine if the code is currently in kernel mode or not.
      *