Moving the payload load into istep 20.1

In our FSP machines, the FSP loads the payload in step 20.1,
but in our openpower machines we added that functionality in
step 21.3.  This is moving that functionality from 21.3 to 20.1
(This is a forwardport from the already-reviewed master-p8 change)

Change-Id: Ide679bcda981771aad7806876a1b0c42f6f60d8f
RTC:147281
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/22976
Tested-by: Jenkins Server
Tested-by: FSP CI Jenkins
Reviewed-by: Prachi Gupta <pragupta@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>

2 files changed, 249 insertions, 165 deletions

diff --git a/src/usr/isteps/istep20/call_host_load_payload.C b/src/usr/isteps/istep20/call_host_load_payload.C
index 5f38ef673..acea38385 100644
--- a/src/usr/isteps/istep20/call_host_load_payload.C
+++ b/src/usr/isteps/istep20/call_host_load_payload.C
@@ -28,6 +28,16 @@
 #include <initservice/isteps_trace.H>
 #include <isteps/hwpisteperror.H>
 #include <isteps/istep_reasoncodes.H>
+#include <isteps/hwpf_reasoncodes.H>
+#include <targeting/common/commontargeting.H>
+#include <initservice/istepdispatcherif.H>
+#include <initservice/initserviceif.H>
+#include <pnor/pnorif.H>
+#include <util/misc.H>
+#include <sys/mm.h>
+#include <arch/ppc.H>
+#include <kernel/console.H>
+#include <xz/xz.h>
 
 using namespace ERRORLOG;
 using namespace ISTEP;
@@ -37,14 +47,247 @@ using namespace TARGETING;
 namespace ISTEP_20
 {
 
+/**
+ * @brief This function loads the pnor section in sapphire mode and
+ *        and also decompresseses the section if it was compressed
+ *
+ * @param[in] i_section  - Which section are we loading
+ * @param[in] i_physAddr - The physical address of the section
+ *
+ * @return errlHndl_t - NULL if successful, otherwise a pointer
+ *                      to the error log.
+ */
+static errlHndl_t load_pnor_section(PNOR::SectionId i_section,
+                                    uint64_t i_physAddr);
+
 void* call_host_load_payload (void *io_pArgs)
 {
-    errlHndl_t  l_errl  =   NULL;
+    errlHndl_t  l_err  =   NULL;
 
     TRACDCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
-            "call_host_start_payload entry" );
+               ENTER_MRK"call_host_start_payload entry" );
+
+    do
+    {
+        // Get Target Service, and the system target.
+        TargetService& tS = targetService();
+        TARGETING::Target* sys = NULL;
+        (void) tS.getTopLevelTarget( sys );
+        if( NULL == sys )
+        {
+            // Error getting system target to get payload related values.  We
+            // will create an error to be passed back.  This will cause the
+            // istep to fail.
+            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
+                       ERR_MRK"call_load_payload: System Target was NULL!" );
+
+            /*@
+             * @errortype
+             * @reasoncode       RC_TARGET_NULL
+             * @severity         ERRORLOG::ERRL_SEV_CRITICAL_SYS_TERM
+             * @moduleid         MOD_LOAD_PAYLOAD
+             * @userdata1        <UNUSED>
+             * @userdata2        <UNUSED>
+             * @devdesc          System target was NULL!
+             * @custdesc         A problem occurred during the IPL
+             *                   of the system.
+             */
+            l_err = new ERRORLOG::ErrlEntry(
+                            ERRORLOG::ERRL_SEV_CRITICAL_SYS_TERM,
+                            MOD_LOAD_PAYLOAD,
+                            RC_TARGET_NULL,
+                            0x0,
+                            0x0 );
+
+            break;
+        }
+
+        if(INITSERVICE::spBaseServicesEnabled())
+        {
+            //this function is a NOOP on FSP system
+            break;
+        }
+
+        // Get Payload base/entry from attributes
+        uint64_t payloadBase = sys->getAttr<TARGETING::ATTR_PAYLOAD_BASE>();
+        TRACDCOMP( ISTEPS_TRACE::g_trac_isteps_trace,INFO_MRK
+                   "call_load_payload: Payload Base: 0x%08x, Base:0x%08x",
+                   payloadBase, (payloadBase * MEGABYTE) );
+
+        // Load payload data in PHYP mode or in Sapphire mode
+        if(is_sapphire_load() || is_phyp_load())
+        {
+            l_err = load_pnor_section( PNOR::PAYLOAD, payloadBase );
+            if ( l_err )
+            {
+                TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                          "call_load_payload: error loading pnor section");
+                break;
+            }
+        }
+
+    }while(0);
+
+    return l_err;
+}
+
+static void simics_load_payload(uint64_t addr) __attribute__((noinline));
+static void simics_load_payload(uint64_t addr)
+{
+    MAGIC_INSTRUCTION(MAGIC_LOAD_PAYLOAD);
+}
+
+static errlHndl_t load_pnor_section(PNOR::SectionId i_section,
+        uint64_t i_physAddr)
+{
+    // Get the section info from PNOR.
+    PNOR::SectionInfo_t pnorSectionInfo;
+    errlHndl_t err = PNOR::getSectionInfo( i_section,
+                    pnorSectionInfo );
+    if( err != NULL )
+    {
+        TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                 "load_pnor_section: Could not get section info from %x",
+                  i_section);
+        return err;
+    }
+
+    uint32_t uncompressedPayloadSize = pnorSectionInfo.xzCompressed ?
+            pnorSectionInfo.xzSize : pnorSectionInfo.size;
+
+    const uint32_t originalPayloadSize = pnorSectionInfo.size;
+
+    printk( "Loading PNOR section %d (%s) %d bytes @0x%lx\n",
+            i_section,
+            pnorSectionInfo.name,
+            originalPayloadSize,
+            i_physAddr );
+
+    uint64_t loadAddr = NULL;
+    // Use simics optimization if we are running under simics which has very
+    // slow PNOR access.
+    if ( Util::isSimicsRunning()  )
+    {
+        //TODO RTC 143500
+        if(pnorSectionInfo.xzCompressed)
+        {
+            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
+                  "If you are running simics, and have xz compressed ",
+                  "payload image, you are going to fail. RTC 143500");
+        }
+        simics_load_payload( i_physAddr );
+    }
+    else
+    {
+        // Map in the physical memory we are loading into.
+        // If we are not xz compressed, the uncompressedSize
+        // is equal to the original size.
+        loadAddr = reinterpret_cast<uint64_t>(
+                     mm_block_map( reinterpret_cast<void*>( i_physAddr ),
+                                   uncompressedPayloadSize ) );
+
+        // Print out inital progress bar.
+#ifdef CONFIG_CONSOLE
+        const int progressSteps = 80;
+        int progress = 0;
+        for ( int i = 0; i < progressSteps; ++i )
+        {
+            printk( "." );
+        }
+        printk( "\r" );
+#endif
+
+        if(!pnorSectionInfo.xzCompressed)
+        {
+            // Load the data block by block and update the progress bar.
+            const uint32_t BLOCK_SIZE = 4096;
+            for ( uint32_t i = 0; i < originalPayloadSize; i += BLOCK_SIZE )
+            {
+                memcpy( reinterpret_cast<void*>( loadAddr + i ),
+                        reinterpret_cast<void*>( pnorSectionInfo.vaddr + i ),
+                        std::min( originalPayloadSize - i, BLOCK_SIZE ) );
+#ifdef CONFIG_CONSOLE
+                for ( int new_progress = (i * progressSteps) /
+                                         originalPayloadSize;
+                      progress <= new_progress; progress++ )
+                {
+                    printk( "=" );
+                }
+#endif
+            }
+#ifdef CONFIG_CONSOLE
+            printk( "\n" );
+#endif
+        }
+    }
+
+    if(pnorSectionInfo.xzCompressed)
+    {
+        struct xz_buf b;
+        struct xz_dec *s;
+        enum xz_ret ret;
+
+        xz_crc32_init();
+        s = xz_dec_init(XZ_SINGLE, 0);
+        if(s == NULL)
+        {
+            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,ERR_MRK
+                     "load_pnor_section: XZ Embedded Initialization failed");
+            return err;
+        }
+
+        static const uint64_t compressed_SIZE = originalPayloadSize;
+        static const uint64_t decompressed_SIZE = uncompressedPayloadSize;
+
+        b.in = reinterpret_cast<uint8_t *>( pnorSectionInfo.vaddr);
+        b.in_pos = 0;
+        b.in_size = compressed_SIZE;
+        b.out = reinterpret_cast<uint8_t *>(loadAddr);
+        b.out_pos = 0;
+        b.out_size = decompressed_SIZE;
+
+        ret = xz_dec_run(s, &b);
+
+        if(ret == XZ_STREAM_END)
+        {
+            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
+                     "load_pnor_section: The %s section was decompressed.",
+                      pnorSectionInfo.name);
+        }else
+        {
+            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,ERR_MRK
+                     "load_pnor_section: xz-embedded returned an error, ",
+                     "the ret is %d",ret);
+
+            /*@
+             * @errortype
+             * @reasoncode       fapi::RC_INVALID_RETURN_XZ_CODE
+             * @severity         ERRORLOG::ERRL_SEV_UNRECOVERABLE
+             * @moduleid         fapi::MOD_START_XZ_PAYLOAD
+             * @devdesc          xz-embedded has returned an error.
+             *                   the return code can be found in xz.h
+             * @custdesc         Error uncompressing payload image from
+             *                   boot flash
+             * @userdata1        Return code from xz-embedded
+             * @userdata2[0:31]  Original Payload Size
+             * @userdata2[32:63] Uncompressed Payload Size
+             */
+            err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                            fapi::MOD_START_XZ_PAYLOAD,
+                            fapi::RC_INVALID_RETURN_XZ_CODE,
+                            ret,TWO_UINT32_TO_UINT64(
+                                    originalPayloadSize,
+                                    uncompressedPayloadSize));
+            err->addProcedureCallout(HWAS::EPUB_PRC_PHYP_CODE,
+                            HWAS::SRCI_PRIORITY_HIGH);
+
+        }
+        //Clean up memory
+        xz_dec_end(s);
+
+    }
 
-    return l_errl;
+    return err;
 }
 
 };
diff --git a/src/usr/isteps/istep21/call_host_start_payload.C b/src/usr/isteps/istep21/call_host_start_payload.C
index 2ac6d4fda..004e95976 100644
--- a/src/usr/isteps/istep21/call_host_start_payload.C
+++ b/src/usr/isteps/istep21/call_host_start_payload.C
@@ -44,8 +44,7 @@
 #include <mbox/ipc_msg_types.H>
 #include <devicefw/userif.H>
 #include <arch/pirformat.H>
-#include <xz/xz.h>
-#include    <isteps/hwpf_reasoncodes.H>
+#include <isteps/hwpf_reasoncodes.H>
 
 #include <errl/errludtarget.H>
 
@@ -109,162 +108,6 @@ errlHndl_t notifyFsp ( bool i_istepModeFlag,
                        TARGETING::SpFunctions i_spFuncs );
 
 
-static void simics_load_payload(uint64_t addr) __attribute__((noinline));
-static void simics_load_payload(uint64_t addr)
-{
-    MAGIC_INSTRUCTION(MAGIC_LOAD_PAYLOAD);
-}
-
-
-static errlHndl_t load_pnor_section(PNOR::SectionId i_section,
-        uint64_t i_physAddr)
-{
-    // Get the section info from PNOR.
-    PNOR::SectionInfo_t pnorSectionInfo;
-    errlHndl_t err = PNOR::getSectionInfo( i_section,
-                                           pnorSectionInfo );
-    if( err != NULL )
-    {
-        return err;
-    }
-    uint32_t uncompressedPayloadSize = pnorSectionInfo.xzCompressed ?
-            pnorSectionInfo.xzSize : pnorSectionInfo.size;
-
-    const uint32_t originalPayloadSize = pnorSectionInfo.size;
-
-    printk( "Loading PNOR section %d (%s) %d bytes @0x%lx\n",
-            i_section,
-            pnorSectionInfo.name,
-            originalPayloadSize,
-            i_physAddr );
-
-    uint64_t loadAddr = NULL;
-    // Use simics optimization if we are running under simics which has very
-    // slow PNOR access.
-    if ( Util::isSimicsRunning()  )
-    {
-        //TODO RTC:143500
-        TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
-                  "If you are running simics, and have a xz compressed ",
-                  "payload image, you are going to fail. RTC 143500");
-        simics_load_payload( i_physAddr );
-    }
-    else
-    {
-        // Map in the physical memory we are loading into.
-        // If we are not xz compressed, the uncompressedSize is
-        // equal to the original size.
-        uint64_t loadAddr = reinterpret_cast<uint64_t>(
-            mm_block_map( reinterpret_cast<void*>( i_physAddr ),
-                          uncompressedPayloadSize ) );
-
-        // Print out inital progress bar.
-#ifdef CONFIG_CONSOLE
-        const int progressSteps = 80;
-        int progress = 0;
-        for ( int i = 0; i < progressSteps; ++i )
-        {
-            printk( "." );
-        }
-        printk( "\r" );
-#endif
-
-        if(!pnorSectionInfo.xzCompressed)
-        {
-            // Load the data block by block and update the progress bar.
-            const uint32_t BLOCK_SIZE = 4096;
-            for ( uint32_t i = 0; i < originalPayloadSize; i += BLOCK_SIZE )
-            {
-                memcpy( reinterpret_cast<void*>( loadAddr + i ),
-                        reinterpret_cast<void*>( pnorSectionInfo.vaddr + i ),
-                        std::min( originalPayloadSize - i, BLOCK_SIZE ) );
-#ifdef CONFIG_CONSOLE
-                for ( int new_progress = (i * progressSteps) /
-                                         originalPayloadSize;
-                    progress <= new_progress; progress++ )
-                {
-                    printk( "=" );
-                }
-#endif
-            }
-#ifdef CONFIG_CONSOLE
-            printk( "\n" );
-#endif
-        }
-    }
-
-    if(pnorSectionInfo.xzCompressed)
-    {
-        struct xz_buf b;
-        struct xz_dec *s;
-        enum xz_ret ret;
-
-        xz_crc32_init();
-
-        s = xz_dec_init(XZ_SINGLE, 0);
-        if(s == NULL)
-        {
-            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,ERR_MRK
-                     "load_pnor_section: XZ Embedded Initialization failed");
-            return err;
-        }
-
-        static const uint64_t compressed_SIZE = originalPayloadSize;
-        static const uint64_t decompressed_SIZE = uncompressedPayloadSize;
-
-        b.in = reinterpret_cast<uint8_t *>( pnorSectionInfo.vaddr);
-        b.in_pos = 0;
-        b.in_size = compressed_SIZE;
-        b.out = reinterpret_cast<uint8_t *>(loadAddr);
-        b.out_pos = 0;
-        b.out_size = decompressed_SIZE;
-
-        ret = xz_dec_run(s, &b);
-
-        if(ret == XZ_STREAM_END)
-        {
-            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
-                     "load_pnor_section: The %s section was decompressed.",
-                     pnorSectionInfo.name);
-        }else
-        {
-            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,ERR_MRK
-                     "load_pnor_section: xz-embedded returned an error, ",
-                     "the ret is %d",ret);
-
-            //Clean up memory
-            xz_dec_end(s);
-
-            /*@
-             * @errortype
-             * @reasoncode       fapi::RC_INVALID_RETURN_XZ_CODE
-             * @severity         ERRORLOG::ERRL_SEV_UNRECOVERABLE
-             * @moduleid         fapi::MOD_START_XZ_PAYLOAD
-             * @devdesc          xz-embedded has returned an error.
-             *                   the return code can be found in xz.h
-             * @custdesc         Error uncompressing payload image from
-             *                   boot flash
-             * @userdata1        Return code from xz-embedded
-             * @userdata2[0:31]  Original Payload Size
-             * @userdata2[32:63] Uncompressed Payload Size
-             */
-             err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
-                                           fapi::MOD_START_XZ_PAYLOAD,
-                                           fapi::RC_INVALID_RETURN_XZ_CODE,
-                                           ret,TWO_UINT32_TO_UINT64(
-                                                   originalPayloadSize,
-                                                   uncompressedPayloadSize));
-             err->addProcedureCallout(HWAS::EPUB_PRC_PHYP_CODE,
-                             HWAS::SRCI_PRIORITY_HIGH);
-             return err;
-         }
-         xz_dec_end(s);
-    }
-
-    return NULL;
-}
-
-
 void* call_host_start_payload (void *io_pArgs)
 {
     errlHndl_t  l_errl  =   NULL;
@@ -501,12 +344,10 @@ errlHndl_t callShutdown ( uint64_t i_masterInstance,
                 break;
             }
 
-            // Load payload data in Sapphire mode when
-            // SP Base Services not enabled
+            // In Sapphire mode when SP Base Services is not enabled
+            // grab the address of the previously loaded payload (step 20.1)
             if( is_sapphire_load() && (!INITSERVICE::spBaseServicesEnabled()))
             {
-                err = load_pnor_section( PNOR::PAYLOAD, payloadBase );
-                if ( err ) { break; }
                 payloadData = DEVTREE::get_flatdevtree_phys_addr();
             }
         }