Add presence detection for i2c mux targets

This commit removes the ddimm.C file that had the deviceFramework
routing for OCMB presence detection and replaces it with a new file
in src/usr/i2c/i2cTargetPres.C that is more generic for any target
that has the FAPI_I2C_CONTROLLER_INFO attribute. The i2c_mux target
also now uses this same code for its presence detection.
As a result of this change the src/usr/i2c/mux_i2c.* files have
also been removed. When getting rid of the ddimm.C file I had to put
the IDEC device routing somewhere else so I moved it to the hwasPlat
code where the other IDEC device routes are registered.

RTC: 196805
Change-Id: I27e5e3e8d0fe107c3d44a450e20efa6f50fa0c5f
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/69944
Reviewed-by: Matt Derksen <mderkse1@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Roland Veloz <rveloz@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

5 files changed, 339 insertions, 159 deletions

diff --git a/src/usr/i2c/i2c.mk b/src/usr/i2c/i2c.mk
index ac31ba45f..822f1d948 100644
--- a/src/usr/i2c/i2c.mk
+++ b/src/usr/i2c/i2c.mk
@@ -25,5 +25,4 @@
 # common objects with runtime
 OBJS += eepromdd.o
 OBJS += errlud_i2c.o
-OBJS += mux_i2c.o
 OBJS += $(if $(CONFIG_NVDIMM),nvdimmdd.o,)
diff --git a/src/usr/i2c/i2cTargetPres.C b/src/usr/i2c/i2cTargetPres.C
new file mode 100644
index 000000000..2b28ba76c
--- /dev/null
+++ b/src/usr/i2c/i2cTargetPres.C
@@ -0,0 +1,337 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/i2c/i2cTargetPres.C $                                 */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 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                                                     */
+
+#include <devicefw/driverif.H>
+#include <fsi/fsiif.H>
+#include <vpd/vpd_if.H>
+#include <i2c/i2cif.H>
+#include <i2c/i2creasoncodes.H>
+#include <initservice/initserviceif.H>
+#include <errl/errlmanager.H>
+
+extern trace_desc_t* g_trac_i2c;
+
+//#define TRACSSCOMP(args...)  TRACFCOMP(args)
+#define TRACSSCOMP(args...)
+
+namespace I2C
+{
+
+/**
+ * @brief Performs a presence detect operation on a Target that has the
+ *        ATTR_FAPI_I2C_CONTROL_INFO and can be detected via that device
+ *
+ *        Currently used to detect I2C_MUTEX and OCMB_CHIP targets
+ *
+ * @param[in]   i_target     Presence detect target
+ * @param[in]   i_buflen     lengh of operation requested
+ * @param[in]   o_present    Present = 1, NOT Present = 0
+ * @
+ * @return  errlHndl_t
+ */
+errlHndl_t genericI2CTargetPresenceDetect(TARGETING::Target* i_target,
+                                          size_t i_buflen,
+                                          bool & o_present)
+{
+    errlHndl_t l_errl = nullptr;
+    bool l_target_present = false;
+    bool l_i2cMaster_exists = false;
+    TARGETING::Target * l_i2cMasterTarget = nullptr;
+    TARGETING::Target* l_masterProcTarget = nullptr;
+    TARGETING::ATTR_FAPI_I2C_CONTROL_INFO_type l_i2cInfo;
+
+    TRACSSCOMP( g_trac_i2c, ENTER_MRK"genericI2CTargetPresenceDetect() "
+                "Target HUID 0x%.08X ENTER", TARGETING::get_huid(i_target));
+
+    do{
+        if (unlikely(i_buflen != sizeof(bool)))
+        {
+            TRACFCOMP(g_trac_i2c,
+                      ERR_MRK "I2C::ddimmPresenceDetect> Invalid data length: %d",
+                      i_buflen);
+            /*@
+            * @errortype
+            * @moduleid     I2C::I2C_GENERIC_PRES_DETECT
+            * @reasoncode   I2C::I2C_INVALID_LENGTH
+            * @userdata1    Data Length
+            * @userdata2    HUID of target being detected
+            * @devdesc      ddimmPresenceDetect> Invalid data length (!= 1 bytes)
+            * @custdesc     Firmware error during boot
+            */
+            l_errl =
+                    new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                            I2C::I2C_GENERIC_PRES_DETECT,
+                                            I2C::I2C_INVALID_LENGTH,
+                                            TO_UINT64(i_buflen),
+                                            TARGETING::get_huid(i_target),
+                                            ERRORLOG::ErrlEntry::ADD_SW_CALLOUT);
+            break;
+        }
+
+        // Get a ptr to the target service which we will use later on
+        TARGETING::TargetService& l_targetService = TARGETING::targetService();
+
+        // Read Attributes needed to complete the operation
+        l_i2cInfo = i_target->getAttr<TARGETING::ATTR_FAPI_I2C_CONTROL_INFO>();
+
+        // Check if the target set as the i2cMasterPath actually exists
+        l_targetService.exists(l_i2cInfo.i2cMasterPath, l_i2cMaster_exists);
+
+        // if the i2c master listed doesn't exist then bail out -- this target is not present
+        if(!l_i2cMaster_exists)
+        {
+            TRACFCOMP(g_trac_i2c,
+                      ERR_MRK"I2C::genericI2CTargetPresenceDetect> I2C Master in FAPI_I2C_CONTROL_INFO for Target 0x.08%X does not exist, target not present",
+                      TARGETING::get_huid(i_target));
+
+            /*@
+            * @errortype
+            * @moduleid     I2C::I2C_GENERIC_PRES_DETECT
+            * @reasoncode   VPD::VPD_INVALID_MASTER_I2C_PATH
+            * @userdata1    HUID of target being detected
+            * @userdata2    Unused
+            * @devdesc      ocmbPresenceDetect> Invalid master i2c path
+            * @custdesc     Firmware error during boot
+            */
+            l_errl =
+                    new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                            I2C::I2C_GENERIC_PRES_DETECT,
+                                            I2C::INVALID_MASTER_TARGET,
+                                            TARGETING::get_huid(i_target),
+                                            0,
+                                            ERRORLOG::ErrlEntry::ADD_SW_CALLOUT);
+
+            break;
+        }
+
+        // if we think it exists then lookup the master path with the target service
+        l_i2cMasterTarget = l_targetService.toTarget(l_i2cInfo.i2cMasterPath);
+
+        // if target service returns a null ptr for the path something is wrong and we should
+        // mark the target not present
+        if(l_i2cMasterTarget == nullptr)
+        {
+            TRACFCOMP(g_trac_i2c,
+                      ERR_MRK"I2C::genericI2CTargetPresenceDetect> I2C Master in FAPI_I2C_CONTROL_INFO for Target 0x.08%X returned a nullptr, target not present",
+                      TARGETING::get_huid(i_target));
+
+            /*@
+            * @errortype
+            * @moduleid     I2C::I2C_GENERIC_PRES_DETECT
+            * @reasoncode   I2C::I2C_NULL_MASTER_TARGET
+            * @userdata1    HUID of target being detected
+            * @userdata2    Unused
+            * @devdesc      ocmbPresenceDetect> Master i2c path returned nullptr
+            * @custdesc     Firmware error during boot
+            */
+            l_errl =
+                    new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                                            I2C::I2C_GENERIC_PRES_DETECT,
+                                            I2C::I2C_NULL_MASTER_TARGET,
+                                            TARGETING::get_huid(i_target),
+                                            0,
+                                            ERRORLOG::ErrlEntry::ADD_SW_CALLOUT);
+
+            break;
+        }
+
+        TRACSSCOMP( g_trac_i2c, "I2C::genericI2CTargetPresenceDetect> i2c master for target 0x%.08X is HUID 0x%.08X",
+                    TARGETING::get_huid(i_target),  TARGETING::get_huid(l_i2cMasterTarget));
+
+        // Master proc is taken as always present. Validate other targets.
+        TARGETING::targetService().masterProcChipTargetHandle(l_masterProcTarget );
+
+        if (l_i2cMasterTarget != l_masterProcTarget)
+        {
+            // Use the FSI slave presence detection to see if master i2c can be found
+            if( ! FSI::isSlavePresent(l_i2cMasterTarget) )
+            {
+                TRACFCOMP( g_trac_i2c,
+                           ERR_MRK"genericI2CTargetPresenceDetect> isSlavePresent returned false for I2C Master Target %.08X",
+                           TARGETING::get_huid(l_i2cMasterTarget));
+                break;
+            }
+        }
+
+        //***********************************************************************************
+        //* If we make it through all of the checks then we have verified master is present *
+        //***********************************************************************************
+
+        //Check for the target at the I2C level
+        l_target_present = I2C::i2cPresence(l_i2cMasterTarget,
+                                            l_i2cInfo.port,
+                                            l_i2cInfo.engine,
+                                            l_i2cInfo.devAddr );
+    }while(0);
+
+    o_present = l_target_present;
+
+    TRACSSCOMP( g_trac_i2c, EXIT_MRK"genericI2CTargetPresenceDetect() "
+            "Target HUID 0x%.08X found to be %s present EXIT", TARGETING::get_huid(i_target), o_present ? "" : "NOT" );
+
+    return l_errl;
+}
+
+/**
+ * @brief Performs a presence detect operation on a OCMB Target
+ *
+ * @param[in]   i_opType        Operation type, see DeviceFW::OperationType
+ *                              in driverif.H
+ * @param[in]   i_target        Presence detect target
+ * @param[in/out] io_buffer     Read: Pointer to output data storage
+ *                              Write: Pointer to input data storage
+ * @param[in/out] io_buflen     Input: size of io_buffer (in bytes, always 1)
+ *                              Output: Success = 1, Failure = 0
+ * @param[in]   i_accessType    DeviceFW::AccessType enum (userif.H)
+ * @param[in]   i_args          This is an argument list for DD framework.
+ *                              In this function, there are no arguments.
+ * @return  errlHndl_t
+ */
+errlHndl_t ocmbI2CPresencePerformOp(DeviceFW::OperationType i_opType,
+                                    TARGETING::Target* i_target,
+                                    void* io_buffer,
+                                    size_t& io_buflen,
+                                    int64_t i_accessType,
+                                    va_list i_args)
+{
+    bool l_ocmbPresent = 0;
+    // Error log which will eventually be returned
+    errlHndl_t l_returnedError = nullptr;
+    // Useful if two errors occur, but we still want to return first one
+    // from this function
+    errlHndl_t l_invalidateErrl = nullptr;
+
+    l_returnedError = genericI2CTargetPresenceDetect(i_target,
+                                                     io_buflen,
+                                                     l_ocmbPresent);
+
+    if (l_returnedError)
+    {
+        TRACFCOMP( g_trac_i2c, ERR_MRK"ocmbI2CTargetPresenceDetect() "
+                    "Error detecting OCMB target 0x%.08X, io_buffer will not be set.",
+                    " Invalidating SPD cache for target in pnor. ",
+                    TARGETING::get_huid(i_target));
+    }
+    else
+    {
+        // Copy variable describing if target is present or not to i/o buffer param
+        memcpy(io_buffer, &l_ocmbPresent, sizeof(l_ocmbPresent));
+        io_buflen = sizeof(l_ocmbPresent);
+    }
+
+    // If OCMB was found to not be present, or an error occurred
+    // while checking presence, invalidate the pnor cache of this
+    // SPD data
+    if(!l_ocmbPresent || l_returnedError)
+    {
+        // Invalidate the SPD in PNOR
+        l_invalidateErrl = VPD::invalidatePnorCache(i_target);
+
+        if (l_invalidateErrl)
+        {
+            TRACFCOMP( g_trac_i2c, ERR_MRK"ocmbI2CTargetPresenceDetect() "
+                       "Error invalidating SPD in PNOR for target 0x%.08X",
+                       TARGETING::get_huid(i_target));
+            // If there was an error found while running genericI2CTargetPresenceDetect
+            // then we want return that error and just link the error we found from
+            // invalidatePnorCache and commit it right away. If this is the first error
+            // we encounter then we will just return the error from invalidatePnorCache
+            if(l_returnedError)
+            {
+                l_invalidateErrl->plid(l_returnedError->plid());
+                errlCommit(l_invalidateErrl, I2C_COMP_ID);
+            }
+            else
+            {
+                l_returnedError = l_invalidateErrl;
+                l_invalidateErrl = nullptr;
+            }
+        }
+    }
+
+    return l_returnedError;
+}
+
+/**
+ * @brief Performs a presence detect operation on a Target that has the
+ *        ATTR_FAPI_I2C_CONTROL_INFO and can be detected via that device
+ *
+ *        Currently used to detect I2C_MUTEX targets
+ *
+ * @param[in]   i_opType        Operation type, see DeviceFW::OperationType
+ *                              in driverif.H
+ * @param[in]   i_target        Presence detect target
+ * @param[in/out] io_buffer     Read: Pointer to output data storage
+ *                              Write: Pointer to input data storage
+ * @param[in/out] io_buflen     Input: size of io_buffer (in bytes, always 1)
+ *                              Output: Success = 1, Failure = 0
+ * @param[in]   i_accessType    DeviceFW::AccessType enum (userif.H)
+ * @param[in]   i_args          This is an argument list for DD framework.
+ *                              In this function, there are no arguments.
+ * @return  errlHndl_t
+ */
+errlHndl_t basicI2CPresencePerformOp(DeviceFW::OperationType i_opType,
+                                     TARGETING::Target* i_target,
+                                     void* io_buffer,
+                                     size_t& io_buflen,
+                                     int64_t i_accessType,
+                                     va_list i_args)
+{
+    bool l_muxPresent = 0;
+    errlHndl_t l_returnedError = nullptr;
+
+    l_returnedError = genericI2CTargetPresenceDetect(i_target,
+                                                     io_buflen,
+                                                     l_muxPresent);
+
+    if (l_returnedError)
+    {
+        TRACFCOMP( g_trac_i2c, ERR_MRK"basicI2CTargetPresenceDetect() "
+                    "Error detecting target 0x%.08X, io_buffer will not be set",
+                    TARGETING::get_huid(i_target));
+    }
+    else
+    {
+        // Copy variable describing if target is present or not to i/o buffer param
+        memcpy(io_buffer, &l_muxPresent, sizeof(l_muxPresent));
+        io_buflen = sizeof(l_muxPresent);
+    }
+
+    return l_returnedError;
+}
+
+// Register the ocmb presence detect function with the device framework
+DEVICE_REGISTER_ROUTE(DeviceFW::READ,
+                      DeviceFW::PRESENT,
+                      TARGETING::TYPE_OCMB_CHIP,
+                      ocmbI2CPresencePerformOp);
+
+// Register the i2c mux presence detect function with the device framework
+DEVICE_REGISTER_ROUTE( DeviceFW::READ,
+                       DeviceFW::PRESENT,
+                       TARGETING::TYPE_I2C_MUX,
+                       basicI2CPresencePerformOp );
+
+}
diff --git a/src/usr/i2c/makefile b/src/usr/i2c/makefile
index baefb1bed..535484752 100644
--- a/src/usr/i2c/makefile
+++ b/src/usr/i2c/makefile
@@ -5,7 +5,7 @@
 #
 # OpenPOWER HostBoot Project
 #
-# Contributors Listed Below - COPYRIGHT 2011,2018
+# Contributors Listed Below - COPYRIGHT 2011,2019
 # [+] International Business Machines Corp.
 #
 #
@@ -32,6 +32,7 @@ include i2c.mk
 OBJS += i2c.o
 OBJS += $(if $(CONFIG_TPMDD),tpmdd.o,)
 OBJS += fapi_i2c_dd.o
+OBJS += i2cTargetPres.o
 
 SUBDIRS += test.d
 SUBDIRS += runtime.d
diff --git a/src/usr/i2c/mux_i2c.C b/src/usr/i2c/mux_i2c.C
deleted file mode 100644
index 39447a14c..000000000
--- a/src/usr/i2c/mux_i2c.C
+++ /dev/null
@@ -1,78 +0,0 @@
-/* IBM_PROLOG_BEGIN_TAG                                                   */
-/* This is an automatically generated prolog.                             */
-/*                                                                        */
-/* $Source: src/usr/i2c/mux_i2c.C $                                       */
-/*                                                                        */
-/* OpenPOWER HostBoot Project                                             */
-/*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2011,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 mux_i2c.C
- *
- * @brief I2C MUX utility functions
- *
- */
-
-// -----------------------------------------------------------------------------
-// Includes
-// -----------------------------------------------------------------------------
-#include "mux_i2c.H"
-
-// -----------------------------------------------------------------------------
-// Trace definitions
-// -----------------------------------------------------------------------------
-extern trace_desc_t* g_trac_i2c;
-
-namespace MUX_I2C
-{
-
-using namespace TARGETING;
-
-// Register the presence detect for the I2C MUX
-DEVICE_REGISTER_ROUTE( DeviceFW::READ,
-                       DeviceFW::PRESENT,
-                       TARGETING::TYPE_I2C_MUX,
-                       i2cMuxPresenceDetect );
-
-
-// ------------------------------------------------------------------
-// i2cMuxPresenceDetect
-// ------------------------------------------------------------------
-errlHndl_t i2cMuxPresenceDetect(DeviceFW::OperationType i_opType,
-                                TargetHandle_t          i_target,
-                                void*   io_isPresentBuffer,
-                                size_t& io_isPresentBufferSize,
-                                int64_t i_accessType,
-                                va_list i_args)
-{
-    TRACDCOMP(g_trac_i2c, ENTER_MRK"i2cMuxPresenceDetect()");
-
-    // Always return true
-    bool l_present = true;
-    memcpy(io_isPresentBuffer, &l_present, sizeof(l_present));
-    io_isPresentBufferSize = sizeof(l_present);
-
-    TRACDCOMP(g_trac_i2c, EXIT_MRK"i2cMuxPresenceDetect()");
-
-    return nullptr;
-}
-
-
-}  // namespace MUX_I2C
diff --git a/src/usr/i2c/mux_i2c.H b/src/usr/i2c/mux_i2c.H
deleted file mode 100644
index ed39e000a..000000000
--- a/src/usr/i2c/mux_i2c.H
+++ /dev/null
@@ -1,79 +0,0 @@
-/* IBM_PROLOG_BEGIN_TAG                                                   */
-/* This is an automatically generated prolog.                             */
-/*                                                                        */
-/* $Source: src/usr/i2c/mux_i2c.H $                                       */
-/*                                                                        */
-/* OpenPOWER HostBoot Project                                             */
-/*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 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 __MUX_I2C_H
-#define __MUX_I2C_H
-
-/**
- * @file mux_i2c.H
- *
- * @brief I2C MUX utility functions API
- *
- */
-
-// -----------------------------------------------------------------------------
-// Includes
-// -----------------------------------------------------------------------------
-//  Integral support
-#include <stdint.h>                   // uint64_t
-
-//  Error handling support
-#include <errl/errlentry.H>           // errlHndl_t
-
-//  Targeting support
-#include <targeting/common/target.H>  // TARGETING::TargetHandle_t
-
-//  Driver support
-#include <devicefw/driverif.H>        // DeviceFW::OperationType
-
-namespace MUX_I2C
-{
-
-/**
- * @brief Performs a presence detect operation on an I2C MUX.
- *  This is used during the target discovery (hwas.C::discoverTargets) phase
- *
- * @note  As of current needs/requirements this always returns true (present).
- *
- * @param[in]  i_opType        Operation type, see DeviceFW::OperationType
- *                             in driverif.H
- * @param[in]  i_target        I2C MUX target
- * @param[out] o_isPresentBuffer     Pointer to output data storage
- *                                   Output: is present = 1, is not present = 0
- * @param[out] o_isPresentBufferSize Size of o_isPresentBuffer
- *                                   (in bytes, always 1)
- * @param[in]  i_accessType    DeviceFW::AccessType enum (userif.H)
- * @param[in]  i_args          In this function, there are no arguments.
- * @return     errlHndl_t      Returns a pointer to an ErrlEntry if error,
- *                             else nullptr if no error
- */
- errlHndl_t i2cMuxPresenceDetect(DeviceFW::OperationType        i_opType,
-                                 TARGETING::TargetHandle_t      i_target,
-                                 void*   o_isPresentBuffer,
-                                 size_t& o_isPresentBufferSize,
-                                 int64_t i_accessType,
-                                 va_list i_args);
-}  // namespace MUX_I2C
-
-#endif