Add intrastructure for sending psuQuiesce cmd to SBE

The SBE provides an interfaces for the HOST to issue a psu cmd
that will quiesce the SBE. This commit adds the ability for
HB code to call one function and notify the SBE to quiesce

Change-Id: Icb153875b797f107891b05fd26dccbc413fd8f93
RTC:158899
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/33610
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Martin Gloff <mgloff@us.ibm.com>
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

5 files changed, 123 insertions, 2 deletions

diff --git a/src/include/usr/sbeio/sbe_psudd.H b/src/include/usr/sbeio/sbe_psudd.H
index eb0869396..f6e73cf3a 100644
--- a/src/include/usr/sbeio/sbe_psudd.H
+++ b/src/include/usr/sbeio/sbe_psudd.H
@@ -99,6 +99,7 @@ class SbePsu
         //BYTE 7 options
         enum psuGenericMessageCommands
         {
+            SBE_PSU_GENERIC_MSG_QUIESCE      = 0x05,
             SBE_CMD_CONTROL_SYSTEM_CONFIG    = 0x06
         };
 
@@ -165,6 +166,25 @@ class SbePsu
         };
 
         /**
+        * @brief non reserved word enums
+        *
+        * Shows which of the request and response msg registers are
+        * not reserved. Reserved registers do not need to be written
+        * or read.
+        *
+        * This is a 4 bit field:
+        * 0x1 - Reg 0 is non-reserved (read or write this reg)
+        * 0x2 - Reg 1 is non-reserved (read or write this reg)
+        * 0x4 - Reg 2 is non-reserved (read or write this reg)
+        * 0x8 - Reg 3 is non-reserved (read or write this reg)
+        */
+        enum psuQuiesceNonReservedMsgs
+        {
+            SBE_QUIESCE_REQ_USED_REGS     = 0x01,
+            SBE_QUIESCE_RSP_USED_REGS     = 0x01,
+        };
+
+        /**
          * @brief Struct for PSU command message format
          *
          */
@@ -252,6 +272,19 @@ class SbePsu
                 uint64_t cd3_PutRing_ReservedMbxReg3; //Mbx Reg 3
             } PACKED;
 
+            struct //psuQuiesce
+            {
+                uint16_t cd4_PsuQuiesce_Reserved;
+                uint16_t cd4_PsuQuiesce_ControlFlags;
+                uint16_t cd4_PsuQuiesce_SeqID;
+                uint8_t  cd4_PsuQuiesce_CommandClass;
+                uint8_t  cd4_PsuQuiesce_Command;
+                uint64_t cd4_PsuQuiesce_MbxReg1reserved;
+                uint64_t cd4_PsuQuiesce_MbxReg2reserved;
+                uint64_t cd4_PsuQuiesce_MbxReg3reserved;
+            } PACKED;
+
+
             psuCommand(uint16_t i_controlFlags, //Mbx Reg 0 input
                        uint8_t  i_commandClass, //Mbx Reg 0 input
                        uint8_t  i_command) :    //Mbx Reg 0 input
diff --git a/src/include/usr/sbeio/sbeioif.H b/src/include/usr/sbeio/sbeioif.H
index d55e28885..9f3bf9c3d 100644
--- a/src/include/usr/sbeio/sbeioif.H
+++ b/src/include/usr/sbeio/sbeioif.H
@@ -62,6 +62,14 @@ namespace SBEIO
     errlHndl_t sendSystemConfig(const uint64_t i_systemConfig );
 
     /**
+    * @brief Sends a PSU chipOp to quiesce the SBE
+    *
+    * @return errlHndl_t Error log handle on failure.
+    *
+    */
+    errlHndl_t sendPsuQueisceSbeCmd ();
+
+    /**
      * @brief Get SCOM via SBE FIFO
      *
      * @param[in]  i_target  Target to access
diff --git a/src/usr/sbeio/makefile b/src/usr/sbeio/makefile
index 3fc386a3c..e92dbd89b 100644
--- a/src/usr/sbeio/makefile
+++ b/src/usr/sbeio/makefile
@@ -28,6 +28,7 @@ MODULE = sbeio
 
 OBJS += sbe_psudd.o
 OBJS += sbe_coreStateControl.o
+OBJS += sbe_psuQuiesce.o
 OBJS += sbe_systemConfig.o
 OBJS += sbe_fifodd.o
 OBJS += sbe_scomAccess.o
diff --git a/src/usr/sbeio/sbe_psuQuiesce.C b/src/usr/sbeio/sbe_psuQuiesce.C
new file mode 100644
index 000000000..60ae012bb
--- /dev/null
+++ b/src/usr/sbeio/sbe_psuQuiesce.C
@@ -0,0 +1,79 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/sbeio/sbe_psuQuiesce.C $                              */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2012,2016                        */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
+/*                                                                        */
+/* Licensed under the Apache License, Version 2.0 (the "License");        */
+/* you may not use this file except in compliance with the License.       */
+/* You may obtain a copy of the License at                                */
+/*                                                                        */
+/*     http://www.apache.org/licenses/LICENSE-2.0                         */
+/*                                                                        */
+/* Unless required by applicable law or agreed to in writing, software    */
+/* distributed under the License is distributed on an "AS IS" BASIS,      */
+/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
+/* implied. See the License for the specific language governing           */
+/* permissions and limitations under the License.                         */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+/**
+* @file sbe_psuQuiesce.C
+* @brief Send command to quiesce the SBE
+*/
+
+#include <config.h>
+#include <trace/interface.H>
+#include <errl/errlmanager.H>
+#include <sbeio/sbeioif.H>
+#include <sbeio/sbe_psudd.H>
+
+extern trace_desc_t* g_trac_sbeio;
+
+#define SBE_TRACD(printf_string,args...) \
+TRACDCOMP(g_trac_sbeio,"psuQuiesce: " printf_string,##args)
+
+#define SBE_TRACF(printf_string,args...) \
+TRACFCOMP(g_trac_sbeio,"psuQuiesce: " printf_string,##args)
+
+namespace SBEIO
+{
+
+    /**
+    * @brief Sends a PSU chipOp to quiesce the SBE
+    *
+    * @return errlHndl_t Error log handle on failure.
+    *
+    */
+    errlHndl_t psuQuiesce( )
+    {
+        errlHndl_t errl = NULL;
+
+        SBE_TRACD(ENTER_MRK "sending psu quiesce command from HB -> SBE");
+
+        // set up PSU command message
+        SbePsu::psuCommand   l_psuCommand(
+                                  SbePsu::SBE_REQUIRE_RESPONSE,  //control flags
+                                  SbePsu::SBE_PSU_GENERIC_MESSAGE, //command class
+                                  SbePsu::SBE_PSU_GENERIC_MSG_QUIESCE); //command
+        SbePsu::psuResponse  l_psuResponse;
+
+
+        errl =  SBEIO::SbePsu::getTheInstance().performPsuChipOp(&l_psuCommand,
+                                &l_psuResponse,
+                                SbePsu::MAX_PSU_SHORT_TIMEOUT_NS,
+                                SbePsu::SBE_QUIESCE_REQ_USED_REGS,
+                                SbePsu::SBE_QUIESCE_RSP_USED_REGS);
+
+        SBE_TRACD(EXIT_MRK "psuQuiesce");
+
+        return errl;
+    };
+
+} //end namespace SBEIO
+
diff --git a/src/usr/sbeio/sbe_systemConfig.C b/src/usr/sbeio/sbe_systemConfig.C
index 1e9a00a26..16d11624a 100644
--- a/src/usr/sbeio/sbe_systemConfig.C
+++ b/src/usr/sbeio/sbe_systemConfig.C
@@ -37,10 +37,10 @@
 extern trace_desc_t* g_trac_sbeio;
 
 #define SBE_TRACD(printf_string,args...) \
-TRACDCOMP(g_trac_sbeio,"coreStateControl: " printf_string,##args)
+TRACDCOMP(g_trac_sbeio,"sendSystemConfig: " printf_string,##args)
 
 #define SBE_TRACF(printf_string,args...) \
-TRACFCOMP(g_trac_sbeio,"coreStateControl: " printf_string,##args)
+TRACFCOMP(g_trac_sbeio,"sendSystemConfig: " printf_string,##args)
 
 namespace SBEIO
 {