ipmi: Split into ipmibase and ipmiext modules

Split the IPMI module into base and ext portions, with the BT interface,
device driver and resource provider in the base portion, and all
remaining IPMI functionality in the ext portion. The split is in
preparation for moving the base functionality in the hostboot base
image.

Change-Id: Iec864f96240d79f4fadd5519d2ef46437d07c1fd
Signed-off-by: Andrew Jeffery <andrewrj@au1.ibm.com>
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/66792
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Reviewed-by: Corey V. Swenson <cswenson@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

4 files changed, 359 insertions, 0 deletions

diff --git a/src/usr/ipmiext/runtime/makefile b/src/usr/ipmiext/runtime/makefile
new file mode 100644
index 000000000..e044f35de
--- /dev/null
+++ b/src/usr/ipmiext/runtime/makefile
@@ -0,0 +1,38 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/usr/ipmiext/runtime/makefile $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2015,2018
+# [+] 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
+HOSTBOOT_RUNTIME = 1
+ROOTPATH = ../../../..
+MODULE = ipmi_rt
+
+#include common ojects between hostboot and runtime hostboot
+include ../ipmi.mk
+
+OBJS += rt_ipmirp.o
+
+SUBDIRS += test.d
+
+VPATH += ..
+include $(ROOTPATH)/config.mk
+
diff --git a/src/usr/ipmiext/runtime/rt_ipmirp.C b/src/usr/ipmiext/runtime/rt_ipmirp.C
new file mode 100644
index 000000000..496b3f782
--- /dev/null
+++ b/src/usr/ipmiext/runtime/rt_ipmirp.C
@@ -0,0 +1,188 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/ipmiext/runtime/rt_ipmirp.C $                         */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 rt_ipmirp.C
+ * @brief IPMI resource provider definition for runtime
+ */
+
+#include <ipmi/ipmi_reasoncodes.H>
+#include <ipmi/ipmiif.H>
+
+#include <config.h>
+#include <sys/task.h>
+#include <initservice/taskargs.H>
+#include <initservice/initserviceif.H>
+#include <sys/vfs.h>
+
+#include <targeting/common/commontargeting.H>
+#include <kernel/ipc.H>
+#include <arch/ppc.H>
+#include <errl/errlmanager.H>
+#include <sys/time.h>
+#include <sys/misc.h>
+#include <errno.h>
+#include <runtime/interface.h>
+
+trace_desc_t * g_trac_ipmi;
+TRAC_INIT(&g_trac_ipmi, IPMI_COMP_NAME, 6*KILOBYTE, TRACE::BUFFER_SLOW);
+
+#define IPMI_TRAC(printf_string,args...) \
+    TRACFCOMP(g_trac_ipmi,"rt: " printf_string,##args)
+
+namespace IPMI
+{
+    static size_t g_max_buffer = 0;
+    size_t max_buffer(void)
+    {
+        if (g_max_buffer == 0)
+        {
+            TARGETING::Target * sys = NULL;
+            TARGETING::targetService().getTopLevelTarget( sys );
+            if (sys)
+            {
+                g_max_buffer = sys->getAttr
+                                <TARGETING::ATTR_IPMI_MAX_BUFFER_SIZE>();
+                IPMI_TRAC( INFO_MRK"getAttr(IPMI_MAX_BUFFER_SIZE) = %d",
+                        g_max_buffer);
+            }
+            else
+            {
+                IPMI_TRAC( ERR_MRK"IPMI_MAX_BUFFER_SIZE not available" );
+            }
+        }
+        return g_max_buffer;
+    }
+
+    ///
+    /// @brief  Synchronus message send
+    ///
+    errlHndl_t sendrecv(const IPMI::command_t& i_cmd,
+                        IPMI::completion_code& o_completion_code,
+                        size_t& io_len, uint8_t*& io_data)
+    {
+        errlHndl_t err = NULL;
+        int rc = 0;
+
+        // if the buffer is too large this is a programming error.
+        assert(io_len <= max_buffer());
+
+        uint8_t netfn = i_cmd.first >> 2; //remove embedded LUN
+        IPMI_TRAC("calling sync %x:%x  len=%d",
+            netfn, i_cmd.second, io_len);
+
+        if(g_hostInterfaces && g_hostInterfaces->ipmi_msg)
+        {
+            size_t l_len = max_buffer(); // max size the BMC can return
+            uint8_t *l_data = new uint8_t[l_len];
+
+            rc = g_hostInterfaces->ipmi_msg(
+                        netfn, i_cmd.second,
+                        io_data, io_len,
+                        l_data, &l_len);
+
+            if(rc)
+            {
+                IPMI_TRAC(ERR_MRK
+                          "Failed sending ipmi msg (%x:%x) to bmc rc: %d. ",
+                          i_cmd.first, i_cmd.second, rc);
+
+                /*@
+                 * @errortype           ERRL_SEV_UNRECOVERABLE
+                 * @moduleid            IPMI::MOD_IPMIRT
+                 * @reasoncode          IPMI::RC_INVALID_SENDRECV
+                 * @userdata1[0:31]     rc from ipmi_msg()
+                 * @userdata1[32:46]    netfn of failing msg
+                 * @userdata1[47:63]    cmd of failing msg
+                 * @userdata2           length of failing msg
+                 * @devdesc             ipmi_msg() failed
+                 * @custdesc            Firmware error
+                 */
+                err = new ERRORLOG::ErrlEntry(
+                            ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                            IPMI::MOD_IPMIRT,
+                            IPMI::RC_INVALID_SENDRECV,
+                            TWO_UINT32_TO_UINT64(rc,
+                                TWO_UINT16_TO_UINT32(netfn, i_cmd.second)),
+                            io_len,
+                            true);
+                err->collectTrace(IPMI_COMP_NAME);
+                delete[] io_data;
+                io_data = NULL;
+                io_len = 0;
+            }
+            else
+            {
+                // clean up the memory for the caller
+                o_completion_code =
+                  static_cast<IPMI::completion_code>(l_data[0]);
+
+                // now need to create the buffer to return
+                io_len = l_len - 1; // get rid of the completion_code
+                delete[] io_data;
+                io_data = new uint8_t[io_len];
+                memcpy(io_data, &l_data[1], io_len); // data after CC
+            }
+            delete[] l_data;
+        }
+        else
+        {
+            IPMI_TRAC(ERR_MRK
+                      "Host interfaces not initialized; ipmi msg not sent. ");
+        }
+
+        return err;
+    } // sendrecv
+
+    /*
+     * @brief       Asynchronus message send
+     *
+     * @param[in]   i_cmd,  the command we're sending
+     * @param[in]   i_len,  the length of the data
+     * @param[in]   i_data, the data we're sending
+     * @param[in]   i_type, the type of message we're sending
+     *
+     */
+    errlHndl_t send(const IPMI::command_t& i_cmd,
+                    size_t i_len, uint8_t* i_data,
+                    IPMI::message_type i_type)
+    {
+        IPMI::completion_code l_cc = IPMI::CC_UNKBAD;
+
+        // We are calling a synchronous send in an asynchronous function
+        // This is needed to enable asynchronous message sending before
+        // runtime. A message should be synchronous during runtime, but
+        // by ignoring the cc returned and clearing the data, we're making
+        // a synchronous function "asynchronous".
+        errlHndl_t l_err = sendrecv(i_cmd,l_cc,i_len,i_data);
+
+        if(i_data != NULL)
+        {
+            delete i_data;
+        }
+
+        return l_err;
+    }
+
+};
diff --git a/src/usr/ipmiext/runtime/test/makefile b/src/usr/ipmiext/runtime/test/makefile
new file mode 100644
index 000000000..6967a77c6
--- /dev/null
+++ b/src/usr/ipmiext/runtime/test/makefile
@@ -0,0 +1,31 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/usr/ipmiext/runtime/test/makefile $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2015,2018
+# [+] 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
+HOSTBOOT_RUNTIME = 1
+ROOTPATH = ../../../../..
+
+MODULE = testipmi_rt
+TESTS = *.H
+
+include ${ROOTPATH}/config.mk
diff --git a/src/usr/ipmiext/runtime/test/rt_ipmitest.H b/src/usr/ipmiext/runtime/test/rt_ipmitest.H
new file mode 100644
index 000000000..5ee93eca5
--- /dev/null
+++ b/src/usr/ipmiext/runtime/test/rt_ipmitest.H
@@ -0,0 +1,102 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/ipmiext/runtime/test/rt_ipmitest.H $                  */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
+/* [+] 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 __RT_IPMITEST_H
+#define __RT_IPMITEST_H
+
+/**
+ *  @file ipmitest.H
+ *
+ *  @brief Test case for IPMI messages
+*/
+
+#include <cxxtest/TestSuite.H>
+
+#include "../../../trace/entry.H"
+
+#include <ipmi/ipmiif.H>
+#include <ipmi/ipmisensor.H>
+
+
+class RT_IpmiTest: public CxxTest::TestSuite
+{
+public:
+
+
+    /**
+     * @brief call sendrecv directly
+     */
+    void testIpmi1(void)
+    {
+        do
+        {
+            IPMI::completion_code cc = IPMI::CC_UNKBAD;
+            size_t len = 0;
+            uint8_t* data = NULL;
+            errlHndl_t err = IPMI::sendrecv(IPMI::get_capabilities(), cc, len, data);
+
+            TS_WARN("testIpmi1: cc x%x, len %d", cc, len);
+
+            if ( err != NULL )
+            {
+                TS_FAIL("testIpmi1: get_capabilities() failed");
+                break;
+            }
+            if (cc != IPMI::CC_OK)
+            {
+                TS_FAIL("testIpmi1: get_capabilities() failed with cc 0x%x", cc);
+                break;
+            }
+            if (len != 5)
+            {
+                TS_FAIL("testIpmi1: get_capabilities() returned len %d instead of 5",
+                        len);
+                break;
+            }
+
+            TS_WARN("testIpmi1: get_capabilities x%x, x%x x%x x%x x%x",
+                    data[0], data[1], data[2], data[3], data[4]);
+
+        }
+        while(0);
+    }
+
+    /**
+     * @brief  call IPMI::sensor function
+     */
+    void testIpmi2(void)
+    {
+        do
+        {
+            uint8_t l_sensorNumber = SENSOR::getFaultSensorNumber(
+                    TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL);
+
+            TS_WARN("testIpmi2: getFaultSensorNumber x%x",
+                    l_sensorNumber);
+        }
+        while(0);
+    }
+};
+
+#endif