Add VPD support to HBRT

RTC: 79419
Change-Id: I6d00e52026084a68925691b96d7a491faaffb4ef
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/7004
Tested-by: Jenkins Server
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

3 files changed, 395 insertions, 0 deletions

diff --git a/src/usr/vpd/runtime/makefile b/src/usr/vpd/runtime/makefile
new file mode 100644
index 000000000..bb8d04ffe
--- /dev/null
+++ b/src/usr/vpd/runtime/makefile
@@ -0,0 +1,39 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/usr/vpd/runtime/makefile $
+#
+# IBM CONFIDENTIAL
+#
+# COPYRIGHT International Business Machines Corp. 2013
+#
+# p1
+#
+# Object Code Only (OCO) source materials
+# Licensed Internal Code Source Materials
+# IBM HostBoot Licensed Internal Code
+#
+# The source code for this program is not published or otherwise
+# divested of its trade secrets, irrespective of what has been
+# deposited with the U.S. Copyright Office.
+#
+# Origin: 30
+#
+# IBM_PROLOG_END_TAG
+# common objects with runtime
+HOSTBOOT_RUNTIME = 1
+ROOTPATH = ../../../..
+MODULE = vpd_rt
+
+#include common objects between hostboot and runtime hostboot
+include ../vpd.mk
+
+#add unique object modules
+OBJS += rt_vpd.o 
+
+SUBDIRS = test.d
+
+VPATH += ..
+
+include $(ROOTPATH)/config.mk
+
diff --git a/src/usr/vpd/runtime/rt_vpd.C b/src/usr/vpd/runtime/rt_vpd.C
new file mode 100644
index 000000000..a80ad0ed8
--- /dev/null
+++ b/src/usr/vpd/runtime/rt_vpd.C
@@ -0,0 +1,327 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/vpd/runtime/rt_vpd.C $                                */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* COPYRIGHT International Business Machines Corp. 2013                   */
+/*                                                                        */
+/* p1                                                                     */
+/*                                                                        */
+/* Object Code Only (OCO) source materials                                */
+/* Licensed Internal Code Source Materials                                */
+/* IBM HostBoot Licensed Internal Code                                    */
+/*                                                                        */
+/* The source code for this program is not published or otherwise         */
+/* divested of its trade secrets, irrespective of what has been           */
+/* deposited with the U.S. Copyright Office.                              */
+/*                                                                        */
+/* Origin: 30                                                             */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+#include <trace/interface.H>
+#include <errl/errlentry.H>
+#include <errl/errlmanager.H>
+#include <errl/errludtarget.H>
+#include <vpd/vpdreasoncodes.H>
+#include <initservice/initserviceif.H>
+#include "../vpd.H"
+#include <runtime/interface.h>
+#include <targeting/common/util.H>
+
+// ----------------------------------------------
+// Trace definitions
+// ----------------------------------------------
+trace_desc_t* g_trac_vpd = NULL;
+TRAC_INIT( & g_trac_vpd, "VPD", KILOBYTE );
+
+// ------------------------
+// Macros for unit testing
+//#define TRACUCOMP(args...)  TRACFCOMP(args)
+#define TRACUCOMP(args...)
+//#define TRACSSCOMP(args...)  TRACFCOMP(args)
+#define TRACSSCOMP(args...)
+
+namespace VPD
+{
+
+// ------------------------------------------------------------------
+// getVpdLocation
+// ------------------------------------------------------------------
+errlHndl_t getVpdLocation ( int64_t & o_vpdLocation,
+                            TARGETING::Target * i_target )
+{
+    errlHndl_t err = NULL;
+
+    TRACSSCOMP( g_trac_vpd,
+                ENTER_MRK"getVpdLocation()" );
+
+    o_vpdLocation = i_target->getAttr<TARGETING::ATTR_VPD_REC_NUM>();
+    TRACUCOMP( g_trac_vpd,
+               INFO_MRK"Using VPD location: %d",
+               o_vpdLocation );
+
+    TRACSSCOMP( g_trac_vpd,
+                EXIT_MRK"getVpdLocation()" );
+
+    return err;
+}
+
+// ------------------------------------------------------------------
+// Fake getPnorAddr - VPD image is in memory
+// ------------------------------------------------------------------
+errlHndl_t getPnorAddr( pnorInformation & i_pnorInfo,
+                        uint64_t &io_cachedAddr,
+                        mutex_t * i_mutex )
+{
+    errlHndl_t err = NULL;
+    uint64_t vpd_addr = 0;
+
+    if(
+       g_hostInterfaces != NULL &&
+       g_hostInterfaces->get_vpd_image_addr)
+    {
+        vpd_addr = g_hostInterfaces->get_vpd_image_addr();
+        if(vpd_addr == 0)
+        {
+            TRACFCOMP(g_trac_vpd,ERR_MRK"rt_vpd: Failed to get VPD addr. "
+                      "vpd_type: %d",
+                      i_pnorInfo.pnorSection);
+            /*@
+             * @errortype
+             * @moduleid     VPD::VPD_RT_GET_ADDR
+             * @reasoncode   VPD::VPD_RT_NULL_VPD_PTR
+             * @userdata1    VPD type
+             * @userdata2    0
+             * @devdesc      Hypervisor returned NULL address for VPD
+             */
+            err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_INFORMATIONAL,
+                                          VPD::VPD_RT_GET_ADDR,
+                                          VPD::VPD_RT_NULL_VPD_PTR,
+                                          i_pnorInfo.pnorSection,
+                                          0);
+
+            err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
+                                     HWAS::SRCI_PRIORITY_HIGH);
+
+        }
+    }
+    else // interface not set
+    {
+        TRACFCOMP(g_trac_vpd,ERR_MRK"Hypervisor vpd interface not linked");
+        /*@
+         * @errortype
+         * @moduleid     VPD::VPD_RT_GET_ADDR
+         * @reasoncode   VPD::VPD_RT_NOT_INITIALIZED
+         * @userdata1    VPD type
+         * @userdata2    0
+         * @devdesc      Runtime VPD interface not linked.
+         */
+        err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_INFORMATIONAL,
+                                      VPD::VPD_RT_GET_ADDR,
+                                      VPD::VPD_RT_NOT_INITIALIZED,
+                                      i_pnorInfo.pnorSection,
+                                      0);
+
+        err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
+                                 HWAS::SRCI_PRIORITY_HIGH);
+    }
+
+    if(!err)
+    {
+
+        switch(i_pnorInfo.pnorSection)
+        {
+            case PNOR::DIMM_JEDEC_VPD:
+                break;
+
+            case PNOR::MODULE_VPD:
+                vpd_addr += VMM_DIMM_JEDEC_VPD_SIZE;
+                break;
+
+            case PNOR::CENTAUR_VPD:
+                vpd_addr += (VMM_DIMM_JEDEC_VPD_SIZE + VMM_MODULE_VPD_SIZE);
+                break;
+
+            default: // Huh?
+                TRACFCOMP(g_trac_vpd, ERR_MRK
+                          "RT getPnorAddr: Invalid VPD type: 0x%x",
+                          i_pnorInfo.pnorSection);
+
+                /*@
+                 * @errortype
+                 * @reasoncode       VPD::VPD_RT_INVALID_TYPE
+                 * @severity         ERRORLOG::ERRL_SEV_UNRECOVERABLE
+                 * @moduleid         VPD::VPD_RT_GET_ADDR
+                 * @userdata1        Requested VPD TYPE
+                 * @userdata2        0
+                 * @devdesc          Requested VPD type is invalid or not
+                 *                   supported at runtime
+                 */
+                err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                               VPD::VPD_RT_GET_ADDR,
+                                               VPD::VPD_RT_INVALID_TYPE,
+                                               i_pnorInfo.pnorSection,
+                                               0 );
+
+                err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
+                                         HWAS::SRCI_PRIORITY_HIGH);
+
+                break;
+        }
+    }
+
+    if(!err)
+    {
+        io_cachedAddr = vpd_addr;
+    }
+
+    return err;
+}
+
+// ------------------------------------------------------------------
+// Fake readPNOR - image is in memory
+// ------------------------------------------------------------------
+errlHndl_t readPNOR ( uint64_t i_byteAddr,
+                      size_t i_numBytes,
+                      void * o_data,
+                      TARGETING::Target * i_target,
+                      pnorInformation & i_pnorInfo,
+                      uint64_t &io_cachedAddr,
+                      mutex_t * i_mutex )
+{
+    errlHndl_t err = NULL;
+    int64_t vpdLocation = 0;
+    uint64_t addr = 0x0;
+    const char * readAddr = NULL;
+
+    TRACSSCOMP( g_trac_vpd,
+                ENTER_MRK"RT fake readPNOR()" );
+
+    do
+    {
+        // fake getPnorAddr gets memory address of VPD
+        err = getPnorAddr(i_pnorInfo,
+                          io_cachedAddr,
+                          i_mutex );
+        if(err)
+        {
+            break;
+        }
+
+        addr = io_cachedAddr;
+
+        err = getVpdLocation( vpdLocation,
+                              i_target);
+
+        if(err)
+        {
+            break;
+        }
+
+        // Add Offset for target vpd location
+        addr += (vpdLocation * i_pnorInfo.segmentSize);
+
+        // Add keyword offset
+        addr += i_byteAddr;
+
+        TRACUCOMP( g_trac_vpd,
+                   INFO_MRK"Address to read: 0x%08x",
+                   addr );
+
+        readAddr = reinterpret_cast<const char *>( addr );
+        memcpy( o_data,
+                readAddr,
+                i_numBytes );
+    } while(0);
+
+    TRACSSCOMP( g_trac_vpd,
+                EXIT_MRK"RT fake readPNOR()" );
+
+    return err;
+}
+
+// ------------------------------------------------------------------
+// Fake writePNOR - image is in memory
+// ------------------------------------------------------------------
+errlHndl_t writePNOR ( uint64_t i_byteAddr,
+                       size_t i_numBytes,
+                       void * i_data,
+                       TARGETING::Target * i_target,
+                       pnorInformation & i_pnorInfo,
+                       uint64_t &io_cachedAddr,
+                       mutex_t * i_mutex )
+{
+    errlHndl_t err = NULL;
+    // Does VPD write ever need to be supported at runtime?
+    TRACFCOMP(g_trac_vpd, ERR_MRK
+              "RT writePNOR: VPD write not supported at runtime.");
+
+    /*@
+     * @errortype
+     * @reasoncode       VPD::VPD_RT_WRITE_NOT_SUPPORTED
+     * @severity         ERRORLOG::ERRL_SEV_UNRECOVERABLE
+     * @moduleid         VPD::VPD_RT_WRITE_PNOR
+     * @userdata1        target huid
+     * @userdata2        VPD type
+     * @devdesc          VPD write not suported at runtime
+     */
+    err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                   VPD::VPD_RT_WRITE_PNOR,
+                                   VPD::VPD_RT_WRITE_NOT_SUPPORTED,
+                                   get_huid(i_target),
+                                   i_pnorInfo.pnorSection);
+
+    err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
+                             HWAS::SRCI_PRIORITY_HIGH);
+
+    return err;
+}
+
+// ------------------------------------------------------------------
+// sendMboxWriteMsg - not supported at runtime
+// Treat the same way HB does if mbox is not available
+// ------------------------------------------------------------------
+errlHndl_t sendMboxWriteMsg ( size_t i_numBytes,
+                              void * i_data,
+                              TARGETING::Target * i_target,
+                              VPD_MSG_TYPE i_type,
+                              VpdWriteMsg_t& i_record )
+{
+    errlHndl_t err = NULL;
+    TRACFCOMP( g_trac_vpd, INFO_MRK
+               "sendMboxWriteMsg: Send msg to FSP to write VPD type %.8X, "
+               "record %d, offset 0x%X",
+               i_type,
+               i_record.rec_num,
+               i_record.offset );
+
+    // mimic the behavior of hostboot when mbox is not available.
+    TRACFCOMP( g_trac_vpd, ERR_MRK
+               "No SP Base Services available at runtime.");
+
+    /*@
+     * @errortype
+     * @reasoncode       VPD::VPD_MBOX_NOT_SUPPORTED_RT
+     * @severity         ERRORLOG::ERRL_SEV_UNRECOVERABLE
+     * @moduleid         VPD::VPD_SEND_MBOX_WRITE_MESSAGE
+     * @userdata1        VPD message type
+     * @userdata2        0
+     * @devdesc          MBOX send not supported in HBRT
+     */
+    err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                  VPD::VPD_SEND_MBOX_WRITE_MESSAGE,
+                                  VPD::VPD_MBOX_NOT_SUPPORTED_RT,
+                                  i_type,
+                                  0);
+
+    err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
+                             HWAS::SRCI_PRIORITY_HIGH);
+
+
+
+    return err;
+}
+
+}; // end namepsace VPD
diff --git a/src/usr/vpd/runtime/test/makefile b/src/usr/vpd/runtime/test/makefile
new file mode 100644
index 000000000..8cfee9d53
--- /dev/null
+++ b/src/usr/vpd/runtime/test/makefile
@@ -0,0 +1,29 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/usr/vpd/runtime/test/makefile $
+#
+# IBM CONFIDENTIAL
+#
+# COPYRIGHT International Business Machines Corp. 2013
+#
+# p1
+#
+# Object Code Only (OCO) source materials
+# Licensed Internal Code Source Materials
+# IBM HostBoot Licensed Internal Code
+#
+# The source code for this program is not published or otherwise
+# divested of its trade secrets, irrespective of what has been
+# deposited with the U.S. Copyright Office.
+#
+# Origin: 30
+#
+# IBM_PROLOG_END_TAG
+HOSTBOOT_RUNTIME = 1
+ROOTPATH = ../../../../..
+
+MODULE = testvpd_rt
+TESTS = ../../test/*.H
+
+include ${ROOTPATH}/config.mk