Introduce exp_getidec HWP

This hardware procedure is used to read out the chipId and the EC
level of a given explorer ocmb. The chipId is an IBM standard that
provides information about what kind of chip it is and where it was
made. The EC is the write level of the chip. The initial plan was to
read all of this info from the CHIP_INFO register but we found that the
2nd nibble of the EC level , which represents the "minor" ec level, was
not populated correctly so we must instead read that value from the
EFUSE_OUT3 regsiter.

Change-Id: Id3dca4449c010ad42f7f3d55428b4efb3f6dfbf0
RTC: 214627
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/82712
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Louis Stermole <stermole@us.ibm.com>
Reviewed-by: Mark Pizzutillo <mark.pizzutillo@ibm.com>
Reviewed-by: Jennifer A Stofer <stofer@us.ibm.com>
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/82784
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R Geddes <crgeddes@us.ibm.com>

3 files changed, 176 insertions, 0 deletions

diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.C b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.C
new file mode 100644
index 000000000..5e0e5425a
--- /dev/null
+++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.C
@@ -0,0 +1,100 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.C $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2019                             */
+/* [+] 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 exp_getidec.C
+/// @brief Contains function to lookup Chip ID and EC values of Explorer Chip
+///
+/// *HWP HWP Owner: Christian Geddes <crgeddes@us.ibm.com>
+/// *HWP HWP Backup: <none>
+/// *HWP Team: Hostboot
+/// *HWP Level: 2
+/// *HWP Consumed by: Hostboot / Cronus
+
+#include <fapi2.H>
+#include <exp_getidec.H>
+#include <lib/shared/exp_consts.H>
+#include <chips/ocmb/explorer/common/include/explorer_scom_addresses.H>
+#include <chips/ocmb/explorer/common/include/explorer_scom_addresses_fld.H>
+#include <chips/ocmb/explorer/common/include/explorer_scom_addresses_fld_fixes.H>
+#include <generic/memory/mss_git_data_helper.H>
+
+extern "C"
+{
+
+    ///
+    /// @brief Lookup the Chip ID and EC level values for this explorer chip
+    /// @param[in]   i_target Explorer OCMB chip
+    /// @param[out]  o_chipId Explorer Chip ID
+    /// @param[out]  o_chipEc Explorer Chip EC
+    /// @return fapi2:ReturnCode FAPI2_RC_SUCCESS if success, else error code.
+    ///
+    fapi2::ReturnCode exp_getidec(const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target,
+                                  uint16_t& o_chipId,
+                                  uint8_t& o_chipEc)
+    {
+        mss::display_git_commit_info("exp_getidec");
+        uint8_t l_majorEc  = 0;
+        uint8_t l_minorEc  = 0;
+        uint8_t l_location = 0;
+        uint8_t l_chipBaseId = 0;
+        fapi2::buffer<uint64_t> l_reg_buffer;
+
+        FAPI_TRY(fapi2::getScom( i_target,
+                                 static_cast<uint64_t>(mss::exp::idec_consts::EXPLR_CHIP_INFO_REG),
+                                 l_reg_buffer ),
+                 "exp_getidec: could not read explorer chip_info register register 0x%08x",
+                 mss::exp::idec_consts::EXPLR_CHIP_INFO_REG);
+
+        l_reg_buffer.extractToRight<mss::exp::idec_consts::MAJOR_EC_BIT_START,
+                                    mss::exp::idec_consts::MAJOR_EC_BIT_LENGTH>(l_majorEc);
+        l_reg_buffer.extractToRight<mss::exp::idec_consts::LOCATION_BIT_START,
+                                    mss::exp::idec_consts::LOCATION_BIT_LENGTH>(l_location);
+        l_reg_buffer.extractToRight<mss::exp::idec_consts::CHIPID_BIT_START,
+                                    mss::exp::idec_consts::CHIPID_BIT_LENGTH>(l_chipBaseId);
+
+        // Due to design errors we must read the minor ec (2nd nibble) from a different register
+        FAPI_TRY(fapi2::getScom( i_target, static_cast<uint64_t>(EXPLR_EFUSE_IMAGE_OUT_3), l_reg_buffer ),
+                 "exp_getidec: could not read explorer efuse_out3 register 0x%08x", EXPLR_EFUSE_IMAGE_OUT_3);
+
+        l_reg_buffer.extractToRight<EXPLR_EFUSE_IMAGE_OUT_3_ENTERPRISE_MODE_EC_MINOR,
+                                    EXPLR_EFUSE_IMAGE_OUT_3_ENTERPRISE_MODE_EC_MINOR_LEN>(l_minorEc);
+
+        // Major EC 0:3
+        // Minor EC 4:7
+        o_chipEc = (l_majorEc << 4) | l_minorEc;
+
+        // Location  0:3
+        // Empty     4:7
+        // ChipId    8:15
+        o_chipId = (l_location << 12) | l_chipBaseId;
+
+        FAPI_DBG("EC found 0x%.02x   chipId found 0x%.04x", o_chipEc, o_chipId);
+
+    fapi_try_exit:
+        return fapi2::current_err;
+    }
+
+} // extern "C"
diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.H b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.H
new file mode 100644
index 000000000..e319981a7
--- /dev/null
+++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.H
@@ -0,0 +1,60 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/ocmb/explorer/procedures/hwp/memory/exp_getidec.H $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2019                             */
+/* [+] 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 exp_getidec.H
+/// @brief Contains function to lookup Chip ID and EC values of Explorer Chip
+///
+/// *HWP HWP Owner: Christian Geddes <crgeddes@us.ibm.com>
+/// *HWP HWP Backup: <none>
+/// *HWP Team: Hostboot
+/// *HWP Level: 2
+/// *HWP Consumed by: Hostboot / Cronus
+
+#ifndef __EXP_GETIDEC_H_
+#define __EXP_GETIDEC_H_
+
+#include <fapi2.H>
+
+typedef fapi2::ReturnCode (*exp_getidec_FP_t) (const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>&,
+        uint16_t&, uint8_t&);
+
+extern "C"
+{
+
+///
+/// @brief Lookup the Chip ID and EC level values for this explorer chip
+/// @param[in]   i_target Explorer OCMB chip
+/// @param[out]  o_chipId Explorer Chip ID
+/// @param[out]  o_chipEc Explorer Chip EC
+/// @return fapi2:ReturnCode FAPI2_RC_SUCCESS if success, else error code.
+///
+    fapi2::ReturnCode exp_getidec(const fapi2::Target<fapi2::TARGET_TYPE_OCMB_CHIP>& i_target,
+                                  uint16_t& o_chipId,
+                                  uint8_t& o_chipEc);
+
+} // extern "C"
+
+#endif
diff --git a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H
index dab2bbf2a..e788d8bcd 100644
--- a/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H
+++ b/src/import/chips/ocmb/explorer/procedures/hwp/memory/lib/shared/exp_consts.H
@@ -172,6 +172,22 @@ enum ecid_consts
 };
 
 ///
+/// @brief constants for getidec procedure
+///
+enum idec_consts
+{
+    EXPLR_CHIP_INFO_REG = 0x2134,
+    MAJOR_EC_BIT_START = 32,
+    MAJOR_EC_BIT_LENGTH = 4,
+    LOCATION_BIT_START = 44,
+    LOCATION_BIT_LENGTH = 4,
+    CHIPID_BIT_START = 56,
+    CHIPID_BIT_LENGTH = 8,
+};
+
+
+
+///
 /// @brief generic explorer constants
 ///
 enum generic_consts