Added support for 'Put Ring from Image' command on HB for SBE

Change-Id: I4930633f87bdb61acb19e01f17a8006277f7868d
RTC:132654
CMVC-Prereq: 1004971
CMVC-Prereq: 1005024
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/28887
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Vitaly Marin <mvitaly@us.ibm.com>
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

3 files changed, 20 insertions, 422 deletions

diff --git a/src/usr/sbeio/sbe_coreStateControl.C b/src/usr/sbeio/sbe_coreStateControl.C
index 7d18d2c1a..54f86d0a6 100644
--- a/src/usr/sbeio/sbe_coreStateControl.C
+++ b/src/usr/sbeio/sbe_coreStateControl.C
@@ -31,13 +31,16 @@
 #include <trace/interface.H>
 #include <errl/errlmanager.H>
 #include <sbeio/sbeioif.H>
-#include "sbe_psudd.H"
+#include <sbeio/sbe_psudd.H>
 
 extern trace_desc_t* g_trac_sbeio;
 
 #define SBE_TRACD(printf_string,args...) \
     TRACDCOMP(g_trac_sbeio,"coreStateControl: " printf_string,##args)
 
+#define SBE_TRACF(printf_string,args...) \
+    TRACFCOMP(g_trac_sbeio,"coreStateControl: " printf_string,##args)
+
 namespace SBEIO
 {
 
@@ -59,11 +62,11 @@ errlHndl_t startDeadmanLoop(const uint64_t i_waitTime )
     psuCommand   l_psuCommand(
          SBE_DMCONTROL_START | SBE_DMCONTROL_RESPONSE_REQUIRED, //control flags
          SBE_PSU_CLASS_CORE_STATE,                              //command class
-         SBE_CMD_CONTROL_DEADMAN_LOOP);                         //comand
+         SBE_CMD_CONTROL_DEADMAN_LOOP);                         //command
     psuResponse  l_psuResponse;
 
     // set up PSU command message
-    l_psuCommand.cdl_waitTime = i_waitTime;
+    l_psuCommand.cd1_ControlDeadmanLoop_WaitTime = i_waitTime;
 
     errl = performPsuChipOp(&l_psuCommand,
                             &l_psuResponse,
diff --git a/src/usr/sbeio/sbe_psudd.C b/src/usr/sbeio/sbe_psudd.C
index 4f8e2015c..f206896a2 100644
--- a/src/usr/sbeio/sbe_psudd.C
+++ b/src/usr/sbeio/sbe_psudd.C
@@ -37,8 +37,8 @@
 #include <targeting/common/target.H>
 #include <targeting/common/targetservice.H>
 #include <sbeio/sbeioreasoncodes.H>
-#include "sbe_psudd.H"
 #include <initservice/initserviceif.H> //@todo-RTC:149454-Remove
+#include <sbeio/sbe_psudd.H>
 
 trace_desc_t* g_trac_sbeio;
 TRAC_INIT(&g_trac_sbeio, SBEIO_COMP_NAME, 6*KILOBYTE, TRACE::BUFFER_SLOW);
@@ -90,7 +90,12 @@ errlHndl_t performPsuChipOp(psuCommand     * i_pPsuRequest,
         errl = writeRequest(l_target,
                             i_pPsuRequest,
                             i_reqMsgs);
-        if (errl) break;  // return with error
+        if (errl)//error has been generated
+        {
+            SBE_TRACF(ERR_MRK"performPsuChipOp::"
+                    " writeRequest returned an error");
+            break;
+        }
 
         // read PSU response and check results
         errl = readResponse(l_target,
@@ -98,8 +103,11 @@ errlHndl_t performPsuChipOp(psuCommand     * i_pPsuRequest,
                              o_pPsuResponse,
                              i_timeout,
                              i_rspMsgs);
-        if (errl) break;  // return with error
-
+        if (errl){
+            SBE_TRACF(ERR_MRK"performPsuChipOp::"
+                    " readResponse returned an error");
+            break;  // return with error
+        }
     }
     while (0);
 
@@ -274,7 +282,8 @@ errlHndl_t readResponse(TARGETING::Target  * i_target,
             (SBE_SEC_OPERATION_SUCCESSFUL != o_pPsuResponse->secondaryStatus) ||
             (i_pPsuRequest->seqID != o_pPsuResponse->seqID) )
         {
-            SBE_TRACF(ERR_MRK "readResponse: failing response status "
+
+            SBE_TRACF(ERR_MRK "sbe_psudd.C :: readResponse: failing response status "
                       " cmd=0x%08x prim=0x%08x secondary=0x%08x",
                       " expected seqID=%d actual seqID=%d",
                       i_pPsuRequest[1],
diff --git a/src/usr/sbeio/sbe_psudd.H b/src/usr/sbeio/sbe_psudd.H
deleted file mode 100644
index 9b6228d89..000000000
--- a/src/usr/sbeio/sbe_psudd.H
+++ /dev/null
@@ -1,414 +0,0 @@
-/* IBM_PROLOG_BEGIN_TAG                                                   */
-/* This is an automatically generated prolog.                             */
-/*                                                                        */
-/* $Source: src/usr/sbeio/sbe_psudd.H $                                   */
-/*                                                                        */
-/* 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                                                     */
-
-#ifndef __SBE_PSUDD_H
-#define __SBE_PSUDD_H
-
-/**
- * @file sbe_psudd.H
- * @brief SBE psu device driver specifics
- */
-
-#include <stdint.h>
-#include <builtins.h>
-#include <sys/time.h>
-
-#include <errl/errlentry.H>
-
-namespace SBEIO
-{
-
-//-----------------------------------------------------------------------------
-//  Interfaces to the SBE PSU device driver to be used by clients
-//  within this component.
-//-----------------------------------------------------------------------------
-
-    /**
-     * @brief enums for SBE command class
-     */
-    enum psuCommandClass
-    {
-        SBE_PSU_CLASS_UNKNOWN      = 0,
-        SBE_PSU_CLASS_CORE_STATE   = 0xD1,
-    };
-
-    /**
-     * @brief enums for SBE core state control commands
-     */
-    enum psuCoreStateControlCommands
-    {
-        SBE_CMD_CONTROL_DEADMAN_LOOP   = 0x01,
-    };
-
-    /**
-     * @brief enums for SBE core state control commands
-     */
-    enum psuDeadManControlFlags
-    {
-        SBE_DMCONTROL_START              = 0x01,
-        SBE_DMCONTROL_STOP               = 0x02,
-        SBE_DMCONTROL_RESPONSE_REQUIRED  = 0x0100,
-        SBE_DMCONTROL_ACK_REQUIRED       = 0x0200,
-    };
-
-    /**
-     * @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 psuCoreStateControlNonReservedMsgs
-    {
-        SBE_DMCONTROL_START_REQ_USED_REGS     = 0x03,
-        SBE_DMCONTROL_START_RSP_USED_REGS     = 0x01,
-        SBE_DMCONTROL_STOP_REQ_USED_REGS      = 0x01,
-        SBE_DMCONTROL_STOP_RSP_USED_REGS      = 0x01,
-    };
-
-    /**
-     * @brief Struct for PSU command message format
-     *
-     */
-    union psuCommand
-    {
-        struct //raw
-        {
-            uint64_t mbxReg0;
-            uint64_t mbxReg1;
-            uint64_t mbxReg2;
-            uint64_t mbxReg3;
-        } PACKED;
-        struct //common and direct fields
-        {
-            // mbxReg 0
-            uint16_t reserved;
-            uint16_t controlFlags;
-            uint16_t seqID;
-            uint8_t  commandClass;
-            uint8_t  command;
-            // mbxReg 1
-            uint32_t dataWord2;
-            uint32_t dataWord3;
-            // mbxReg 2
-            uint32_t dataWord4;
-            uint32_t dataWord5;
-            // mbxReg 3
-            uint32_t dataWord6;
-            uint32_t dataWord7;
-        } PACKED;
-        struct //indirect
-        {
-            // mbxReg 0
-            uint16_t indirect_reserved;
-            uint16_t indirect_controlFlags;
-            uint16_t indirect_seqID;
-            uint8_t  indirect_commandClass;
-            uint8_t  indirect_command;
-            // mbxReg 1
-            uint32_t indirect_dataWord2;
-            uint32_t indirect_dataWord3;
-            // mbxReg 2
-            uint32_t indirect_dataWord4;
-            uint32_t indirect_dataWord5;
-            // mbxReg 3
-            uint64_t indirect_address;  // Data address (Mainstore/PBA)
-        } PACKED;
-        struct //controlDeadmanLoop
-        {
-            uint16_t cdl_reserved;
-            uint16_t cdl_controlFlags;
-            uint16_t cdl_seqID;
-            uint8_t  cdl_commandClass;
-            uint8_t  cdl_command;
-            uint64_t cdl_waitTime ;
-            uint64_t cdl_mbxReg2reserved;
-            uint64_t cdl_mbxReg3reserved;
-        } PACKED;
-        psuCommand(uint16_t i_controlFlags,
-                   uint8_t  i_commandClass,
-                   uint8_t  i_command) :
-                   reserved (0),
-                   controlFlags(i_controlFlags),
-                   seqID(0),
-                   commandClass(i_commandClass),
-                   command(i_command),
-                   dataWord2(0),
-                   dataWord3(0),
-                   dataWord4(0),
-                   dataWord5(0),
-                   dataWord6(0),
-                   dataWord7(0)
-        {
-        }
-    };
-
-    /**
-     * @brief Struct for PSU response message format
-     *
-     */
-    union psuResponse
-    {
-        struct //raw
-        {
-            uint64_t mbxReg4;
-            uint64_t mbxReg5;
-            uint64_t mbxReg6;
-            uint64_t mbxReg7;
-        } PACKED;
-        struct //common and direct fields
-        {
-            // mbxReg 4
-            uint16_t primaryStatus;
-            uint16_t secondaryStatus;
-            uint16_t seqID;
-            uint8_t  commandClass;
-            uint8_t  command;
-            // mbxReg 5
-            uint32_t respWord0;
-            uint32_t respWord1;
-            // mbxReg 6
-            uint32_t respWord2;
-            uint32_t respWord3;
-            // mbxReg 7
-            uint32_t respWord4;
-            uint32_t respWord5;
-        } PACKED;
-        struct // indirect fields
-        {
-            // mbxReg 4
-            uint16_t indirect_primaryStatus;
-            uint16_t indirect_secondaryStatus;
-            uint16_t indirect_seqID;
-            uint8_t  indirect_commandClass;
-            uint8_t  indirect_command;
-            // mbxReg 5
-            uint32_t indirect_respWord0;
-            uint32_t indirect_respWord1;
-            // mbxReg 6
-            uint32_t indirect_respWord2;
-            uint32_t indirect_respWord3;
-            // mbxReg 7
-            uint32_t indirect_reserved;
-            uint32_t indirect_size;  //Size in dbl words for Indirect data
-        } PACKED;
-        psuResponse() :
-            primaryStatus (0xffff),   //invalid status
-            secondaryStatus (0xffff), //invalid status
-            seqID (0xffff),           //unlikely seq ID
-            commandClass (0xff),      //invalid command class
-            command (0xff),           //invalid command
-            respWord0 (0),
-            respWord1 (0),
-            respWord2 (0),
-            respWord3 (0),
-            respWord4 (0),
-            respWord5 (0)
-        {
-        }
-    };
-
-    /**
-     * @brief timeout values
-     *
-     */
-    const uint64_t MAX_PSU_SHORT_TIMEOUT_NS = 100*NS_PER_MSEC;    //=100ms
-    const uint64_t MAX_PSU_LONG_TIMEOUT_NS  = 30000*NS_PER_MSEC; //=30 seconds
-
-    /**
-     * @brief enums for primary SBE response
-     *
-    */
-    enum sbePrimResponse
-    {
-        SBE_PRI_OPERATION_SUCCESSFUL        = 0x00,
-        SBE_PRI_INVALID_COMMAND             = 0x01,
-        SBE_PRI_INVALID_DATA                = 0x02,
-        SBE_PRI_SEQUENCE_ERROR              = 0x03,
-        SBE_PRI_INTERNAL_ERROR              = 0x04,
-        SBE_PRI_GENERIC_EXECUTION_FAILURE   = 0xFE,
-    };
-
-    /**
-     * @brief enums for secondary SBE response
-     *         Discuss on SBE_SEC_INVALID_TARGET_ID_PASSED
-     *
-    */
-    enum sbeSecondaryResponse
-    {
-        SBE_SEC_OPERATION_SUCCESSFUL              = 0x00,
-        SBE_SEC_COMMAND_CLASS_NOT_SUPPORTED       = 0x01,
-        SBE_SEC_COMMAND_NOT_SUPPORTED             = 0x02,
-        SBE_SEC_INVALID_ADDRESS_PASSED            = 0x03,
-        SBE_SEC_INVALID_TARGET_TYPE_PASSED        = 0x04,
-        SBE_SEC_INVALID_TARGET_ID_PASSED          = 0x05,
-        SBE_SEC_SPECIFIED_TARGET_NOT_PRESENT      = 0x06,
-        SBE_SEC_SPECIFIED_TARGET_NOT_FUNCTIONAL   = 0x07,
-        SBE_SEC_COMMAND_NOT_ALLOWED_IN_THIS_STATE = 0x08,
-        SBE_SEC_FUNCTIONALITY_NOT_SUPPORTED       = 0x09,
-        SBE_SEC_GENERIC_FAILURE_IN_EXECUTION      = 0x0A,
-        SBE_SEC_BACKLISTED_ACCESS                 = 0x0B,
-        SBE_SEC_OS_FAILURE                        = 0x0C,
-        SBE_SEC_HOST_MBX_REG_ACCESS_FAILURE       = 0x0D,
-        SBE_SEC_INSUFFICIENT_DATA_PASSED          = 0x0E,
-        SBE_SEC_EXCESS_DATA_PASSED                = 0x0F,
-        SBE_SEC_SBE_BUSY_TO_HANDLE_COMMAND        = 0x10,
-    };
-
-    /**
-     * @Brief perform SBE PSU chip-op
-     *
-     * @param[in]  i_pPsuRequest  Pointer to PSU request commands
-     * @param[out] o_pPsuResponse Pointer to PSU response
-     * @param[in]  i_timeout      Time out for response
-     * @param[in]  i_reqMsgs      4 bit mask telling which regs to write
-     * @param[in]  i_rspMsgs      4 bit mask telling which regs to read
-     */
-    errlHndl_t performPsuChipOp(psuCommand     * i_pPsuCommand,
-                                psuResponse    * o_pPsuResponse,
-                                const uint64_t   i_timeout,
-                                uint8_t          i_reqMsgs,
-                                uint8_t          i_rspMsgs);
-
-//-----------------------------------------------------------------------------
-// Local definitions for the device driver
-//-----------------------------------------------------------------------------
-
-    /**
-     * @brief Write request to PSU
-     *
-     * @param[in]  i_target       Master proc to use for scoms
-     * @param[in]  i_pPsuRequest  Pointer to PSU request commands
-     * @param[in]  i_reqMsgs      4 bit mask telling which regs to write
-     *
-     * @return errlHndl_t Error log handle on failure.
-     */
-    errlHndl_t writeRequest(TARGETING::Target  * i_target,
-                            psuCommand         * i_pPsuRequest,
-                            uint8_t              i_reqMsgs);
-    /**
-     * @brief Read response from PSU
-     *
-     * @param[in]  i_target       Master proc to use for scoms
-     * @param[in]  i_pPsuRequest  Pointer to PSU request commands
-     * @param[out] o_pPsuResponse Pointer to PSU response
-     * @param[in]  i_timeout      Time out for response
-     * @param[in]  i_rspMsgs      4 bit mask telling which regs to read
-     *
-     * @return errlHndl_t Error log handle on failure.
-     */
-    errlHndl_t readResponse(TARGETING::Target  * i_target,
-                            psuCommand         * i_pPsuRequest,
-                            psuResponse        * o_pPsuResponse,
-                            const uint64_t       i_timeout,
-                            uint8_t              i_rspMsgs);
-    /**
-     * @brief Poll for response ready to be read
-     *
-     * @param[in]  i_target       Master proc to use for scoms
-     * @param[in]  i_timeout      Time out for response
-     *
-     * @return errlHndl_t Error log handle on failure.
-     */
-    errlHndl_t pollForPsuComplete(TARGETING::Target * i_target,
-                                  const uint64_t i_timeout);
-    /**
-     * @brief Read Scom wrapper
-     *
-     * @param[in]  i_target       Master proc to use for scoms
-     * @param[in]  i_addr         Scom address
-     * @param[out] o_pData        Pointer to returned data
-     * @param[in]  i_trace        Trace control to avoid overruning trace buffer
-     *                            when polling for response ready to be read
-     *
-     * @return errlHndl_t Error log handle on failure.
-     */
-    errlHndl_t readScom(TARGETING::Target * i_target,
-                         uint64_t   i_addr,
-                         uint64_t * o_pData,
-                         bool       i_trace=true);
-
-    /**
-     * @brief Write Scom wrapper
-     *
-     * @param[in]  i_target       Master proc to use for scoms
-     * @param[in]  i_addr         Scom address
-     * @param[in]  i_pData        Pointer to data to write
-     *
-     * @return errlHndl_t Error log handle on failure.
-     */
-     errlHndl_t writeScom(TARGETING::Target * i_target,
-                          uint64_t   i_addr,
-                          uint64_t * i_pData);
-
-    /**
-     * @brief SBE PSU register addresses
-     */
-    enum psuRegs
-    {
-        PSU_HOST_SBE_MBOX0_REG    = 0x000D0050,
-        PSU_HOST_SBE_MBOX1_REG    = 0x000D0051,
-        PSU_HOST_SBE_MBOX2_REG    = 0x000D0052,
-        PSU_HOST_SBE_MBOX3_REG    = 0x000D0053,
-        PSU_HOST_SBE_MBOX4_REG    = 0x000D0054,
-        PSU_HOST_SBE_MBOX5_REG    = 0x000D0055,
-        PSU_HOST_SBE_MBOX6_REG    = 0x000D0056,
-        PSU_HOST_SBE_MBOX7_REG    = 0x000D0057,
-        PSU_SBE_DOORBELL_REG_RW   = 0x000D0060,
-        PSU_SBE_DOORBELL_REG_AND  = 0x000D0061,
-        PSU_SBE_DOORBELL_REG_OR   = 0x000D0062,
-        PSU_HOST_DOORBELL_REG_RW  = 0x000D0063,
-        PSU_HOST_DOORBELL_REG_AND = 0x000D0064,
-        PSU_HOST_DOORBELL_REG_OR  = 0x000D0065,
-    };
-
-    /**
-     * @brief SBE PSU door bell register
-     */
-    enum sbeDoorbellReg
-    {
-        // Doorbell Register to trigger SBE interrupt
-        // psu_sbe_interrupt_msg_available. Set by host firmware to inform
-        // the SBE about a waiting message in the Host/SBE Mailbox Registers
-        SBE_DOORBELL      =0x8000000000000000,
-    };
-    enum hostDoorbellReg
-    {
-        // Doorbell Register for Host Bridge interrupt. Set by the SBE to
-        // inform host firmware about a response message in the Host/SBE
-        // Mailbox Registers
-        HOST_RESPONSE_WAITING       = 0x8000000000000000,
-        HOST_CLEAR_RESPONSE_WAITING = 0x7FFFFFFFFFFFFFFF,
-    };
-
-}
-
-#endif