Add pos API to be shared among controllers, move generic files to utils

Change-Id: I7daedddf83c6a34f28417c97a28e78d88ec5c9af
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/37562
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Brian R. Silver <bsilver@us.ibm.com>
Reviewed-by: STEPHEN GLANCY <sglancy@us.ibm.com>
Reviewed-by: LUCAS W. MULKEY <lwmulkey@us.ibm.com>
Reviewed-by: Louis Stermole <stermole@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/37630
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>

2 files changed, 260 insertions, 1 deletions

diff --git a/src/import/generic/memory/c_str.H b/src/import/generic/memory/lib/utils/c_str.H
index 02b36832b..3795de2c5 100644
--- a/src/import/generic/memory/c_str.H
+++ b/src/import/generic/memory/lib/utils/c_str.H
@@ -1,7 +1,7 @@
 /* IBM_PROLOG_BEGIN_TAG                                                   */
 /* This is an automatically generated prolog.                             */
 /*                                                                        */
-/* $Source: src/import/generic/memory/c_str.H $                           */
+/* $Source: src/import/generic/memory/lib/utils/c_str.H $                 */
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
diff --git a/src/import/generic/memory/lib/utils/pos.H b/src/import/generic/memory/lib/utils/pos.H
new file mode 100644
index 000000000..469d0c1a2
--- /dev/null
+++ b/src/import/generic/memory/lib/utils/pos.H
@@ -0,0 +1,259 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/generic/memory/lib/utils/pos.H $                   */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
+/* [+] 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 pos.H
+/// @brief Tools to return target's position from a fapi2 target
+///
+// *HWP HWP Owner: Brian Silver <bsilver@us.ibm.com>
+// *HWP HWP Backup: Andre Marin <aamarin@us.ibm.com>
+// *HWP Team: Memory
+// *HWP Level: 2
+// *HWP Consumed by: HB:FSP
+
+#ifndef _MSS_POS_H_
+#define _MSS_POS_H_
+
+#include <fapi2.H>
+
+///
+/// @brief Trait classes for the mss::pos functions
+///
+template<fapi2::TargetType T>
+class posTraits
+{
+    public:
+        // Needed as some targets have chip_unit_pos attributes,
+        // uint8_t and some attr_pos, uint32_t. We don't really care
+        // but the type checking in the macros sure does ...
+        typedef uint8_t pos_type;
+
+        enum
+        {
+            MC_PER_MODULE = 2,
+            MCS_PER_MC = 2,
+            PORTS_PER_MCBIST = 4,
+            PORTS_PER_MCS = 2,
+            DIMMS_PER_PORT = 2,
+            DIMMS_PER_MCS = PORTS_PER_MCS * DIMMS_PER_PORT,
+            MCS_PER_PROC = MC_PER_MODULE * MCS_PER_MC,
+        };
+};
+
+///
+/// @brief DIMM Trait class for the mss::pos functions
+///
+template<>
+class posTraits<fapi2::TARGET_TYPE_DIMM>
+{
+    public:
+        typedef uint32_t pos_type;
+
+        enum
+        {
+            MC_PER_MODULE = 2,
+            MCS_PER_MC = 2,
+            PORTS_PER_MCBIST = 4,
+            PORTS_PER_MCS = 2,
+            DIMMS_PER_PORT = 2,
+            DIMMS_PER_MCS = PORTS_PER_MCS * DIMMS_PER_PORT,
+            MCS_PER_PROC = MC_PER_MODULE * MCS_PER_MC,
+        };
+};
+
+///
+/// @brief Processor Trait class for the mss::pos functions
+///
+template<>
+class posTraits<fapi2::TARGET_TYPE_PROC_CHIP>
+{
+    public:
+        typedef uint32_t pos_type;
+
+        enum
+        {
+            MC_PER_MODULE = 2,
+            MCS_PER_MC = 2,
+            MCS_PER_PROC = MC_PER_MODULE * MCS_PER_MC,
+        };
+};
+
+namespace mss
+{
+
+///
+/// @brief Return a target's position from a fapi2 target
+/// @tparam T the fapi2::TargetType
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to the chip
+///
+template< fapi2::TargetType T, typename TT = posTraits<T> >
+typename TT::pos_type pos(const fapi2::Target<T>& i_target)
+{
+    typename TT::pos_type l_pos = 0;
+
+    // Don't use FAPI_TRY as you'll mess up fapi2::current_err which
+    // lmits where this can be used.
+    if (FAPI_ATTR_GET(fapi2::ATTR_CHIP_UNIT_POS, i_target, l_pos) != fapi2::FAPI2_RC_SUCCESS)
+    {
+        goto fapi_try_exit;
+    }
+
+    return l_pos;
+
+fapi_try_exit:
+    // If we can't get our unit position, we're in other trouble
+    FAPI_ERR("can't get our chip unit position");
+    fapi2::Assert(false);
+    return 0;
+}
+
+///
+/// @brief Return a processor's position from a fapi2 target
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to the chip
+///
+template<>
+inline posTraits<fapi2::TARGET_TYPE_PROC_CHIP>::pos_type
+pos(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
+{
+    posTraits<fapi2::TARGET_TYPE_PROC_CHIP>::pos_type l_pos = 0;
+
+    if (FAPI_ATTR_GET(fapi2::ATTR_POS, i_target, l_pos) != fapi2::FAPI2_RC_SUCCESS)
+    {
+        goto fapi_try_exit;
+    }
+
+    return l_pos;
+
+fapi_try_exit:
+    // If we can't get our position, we're in other trouble
+    FAPI_ERR("can't get our position");
+    fapi2::Assert(false);
+    return 0;
+
+}
+
+///
+/// @brief Return a DIMM's position from a fapi2 target
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to the chip
+///
+template<>
+posTraits<fapi2::TARGET_TYPE_DIMM>::pos_type
+pos(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target);
+
+///
+/// @brief Return a target's relative position from a fapi2 target
+/// @tparam T the fapi2::TargetType
+/// @tparam R the fapi2::TargetType we want the position relative to
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to chiplet R
+///
+template< fapi2::TargetType R, fapi2::TargetType T, typename TT = posTraits<T> >
+inline typename TT::pos_type relative_pos(const fapi2::Target<T>& i_target);
+
+///
+/// @brief Return a MCA's relative position from an MCBIST
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to chiplet R
+///
+template<>
+inline posTraits<fapi2::TARGET_TYPE_MCA>::pos_type
+relative_pos<fapi2::TARGET_TYPE_MCBIST>(const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target)
+{
+    typedef posTraits<fapi2::TARGET_TYPE_MCA> TT;
+    return pos(i_target) % TT::PORTS_PER_MCBIST;
+}
+
+///
+/// @brief Return a DIMM's relative position from an MCS
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to chiplet R
+///
+template<>
+inline posTraits<fapi2::TARGET_TYPE_DIMM>::pos_type
+relative_pos<fapi2::TARGET_TYPE_MCS>(const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target)
+{
+    typedef posTraits<fapi2::TARGET_TYPE_DIMM> TT;
+    return pos(i_target) % TT::DIMMS_PER_MCS;
+}
+
+///
+/// @brief Return an MCS's relative position from a processor
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to chiplet R
+///
+template<>
+inline posTraits<fapi2::TARGET_TYPE_MCS>::pos_type
+relative_pos<fapi2::TARGET_TYPE_PROC_CHIP>(const fapi2::Target<fapi2::TARGET_TYPE_MCS>& i_target)
+{
+    typedef posTraits<fapi2::TARGET_TYPE_MCS> TT;
+    return pos(i_target) % TT::MCS_PER_PROC;
+}
+
+///
+/// @brief Return an MCA's relative position from an MCS
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to chiplet R
+///
+template<>
+inline posTraits<fapi2::TARGET_TYPE_MCA>::pos_type
+relative_pos<fapi2::TARGET_TYPE_MCS>(const fapi2::Target<fapi2::TARGET_TYPE_MCA>& i_target)
+{
+    typedef posTraits<fapi2::TARGET_TYPE_MCA> TT;
+    return pos(i_target) % TT::PORTS_PER_MCS;
+}
+
+///
+/// @brief Return a target's fapi position from a fapi2 target
+/// @tparam T the fapi2::TargetType
+/// @param[in] i_target a target representing the target in question
+/// @return The position relative to the system
+///
+template< fapi2::TargetType T, typename TT = posTraits<T> >
+inline uint32_t fapi_pos(const fapi2::Target<T>& i_target)
+{
+    uint32_t l_pos = 0;
+
+    // Don't use FAPI_TRY as you'll mess up fapi2::current_err which
+    // lmits where this can be used.
+    if (FAPI_ATTR_GET(fapi2::ATTR_FAPI_POS, i_target, l_pos) != fapi2::FAPI2_RC_SUCCESS)
+    {
+        goto fapi_try_exit;
+    }
+
+    return l_pos;
+
+fapi_try_exit:
+    // If we can't get our fapi position, we're in other trouble
+    FAPI_ERR("can't get our fapi position");
+    fapi2::Assert(false);
+    return 0;
+}
+
+
+}
+#endif