PRD: Created common MemRank class for MCBIST and MBA

Change-Id: I1a8cb75be604b9d5381f8f0dfe3d55f2e251c9f4
RTC: 157428
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/26750
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Caleb N. Palmer <cnpalmer@us.ibm.com>
Reviewed-by: Benjamin J. Weisenbeck <bweisenb@us.ibm.com>
Reviewed-by: Zane C. Shelley <zshelle@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/27109
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

4 files changed, 156 insertions, 0 deletions

diff --git a/src/usr/diag/prdf/common/plat/mem/prdfMemRank.H b/src/usr/diag/prdf/common/plat/mem/prdfMemRank.H
new file mode 100755
index 000000000..57f560a1e
--- /dev/null
+++ b/src/usr/diag/prdf/common/plat/mem/prdfMemRank.H
@@ -0,0 +1,111 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/diag/prdf/common/plat/mem/prdfMemRank.H $             */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2016                             */
+/* [+] 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  prdfMemRank.H
+ *  @brief Memory rank container class for Centaur MBA and P9 MCBIST.
+ */
+
+#ifndef __prdfMemRank_H
+#define __prdfMemRank_H
+
+#include <prdfAssert.h>
+
+namespace PRDF
+{
+
+//------------------------------------------------------------------------------
+//  Class MemRank
+//------------------------------------------------------------------------------
+
+/** @brief Container for a memory rank. */
+class MemRank
+{
+  public: // enums, constants
+
+    enum
+    {
+        MAX_DSLCT_PER_PORT  = 2, ///< DIMM select per port
+        MAX_RSLCT_PER_DSLCT = 4, ///< rank select per DIMM select
+
+        MAX_MRNK_PER_PORT = MAX_DSLCT_PER_PORT * MAX_RSLCT_PER_DSLCT,
+        MAX_SRNK_PER_MRNK = 8,
+    };
+
+  public: // functions
+
+    /** @brief Default constructor */
+    MemRank() :
+        iv_mrnk(0), iv_srnk(0)
+    {}
+
+    /**
+     * @brief Constructor from components.
+     * @param i_mrank The 3-bit master rank (combined DIMM slct and rank slct).
+     * @param i_srank The 3-bit slave rank.
+     */
+    explicit MemRank( uint8_t i_mrnk, uint8_t i_srnk = 0 ) :
+        iv_mrnk(i_mrnk), iv_srnk(i_srnk)
+    {
+        PRDF_ASSERT( iv_mrnk < MAX_MRNK_PER_PORT  );
+        PRDF_ASSERT( iv_srnk < MAX_SRNK_PER_MRNK );
+    }
+
+    /** @return The master rank (combined DIMM slct and rank slct). */
+    uint8_t getMaster() const { return iv_mrnk; }
+
+    /** @return The slave rank. */
+    uint8_t getSlave() const { return iv_srnk; }
+
+    /** @return The master DIMM select. */
+    uint8_t getDimmSlct() const { return iv_mrnk >> 2; }
+
+    /** @return The master rank select. */
+    uint8_t getRankSlct() const { return iv_mrnk & 0x3; }
+
+    /** @brief '==' operator */
+    bool operator==( const MemRank & i_rank ) const
+    {
+        return ( (this->getMaster() == i_rank.getMaster()) &&
+                 (this->getSlave()  == i_rank.getSlave() )    );
+    }
+
+    /** @brief '<' operator */
+    bool operator<( const MemRank & i_rank ) const
+    {
+        return ( ( (this->getMaster() <  i_rank.getMaster())    ) ||
+                 ( (this->getMaster() == i_rank.getMaster()) &&
+                   (this->getSlave()  <  i_rank.getSlave() )    )    );
+    }
+
+  private: // data
+
+    uint8_t iv_mrnk; ///< Master rank (combined DIMM slct and rank slct)
+    uint8_t iv_srnk; ///< Slave rank
+};
+
+} // end namespace PRDF
+
+#endif // __prdfMemRank_H
+
diff --git a/src/usr/diag/prdf/common/plat/mem/prdf_plat_mem.mk b/src/usr/diag/prdf/common/plat/mem/prdf_plat_mem.mk
new file mode 100644
index 000000000..9b95cb8f5
--- /dev/null
+++ b/src/usr/diag/prdf/common/plat/mem/prdf_plat_mem.mk
@@ -0,0 +1,43 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: src/usr/diag/prdf/common/plat/mem/prdf_plat_mem.mk $
+#
+# OpenPOWER HostBoot Project
+#
+# Contributors Listed Below - COPYRIGHT 2016
+# [+] 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
+
+# NOTE: PRD_SRC_PATH must be defined before including this file.
+
+################################################################################
+# Paths common to both FSP and Hostboot
+################################################################################
+
+prd_vpath += ${PRD_SRC_PATH}/common/plat/mem
+
+prd_incpath += ${PRD_SRC_PATH}/common/plat/mem
+
+################################################################################
+# Object files common to both FSP and Hostboot
+################################################################################
+
+# non-rule plugin related
+
+# rule plugin related
+
diff --git a/src/usr/diag/prdf/makefile b/src/usr/diag/prdf/makefile
index 52545693c..b371b66d5 100755
--- a/src/usr/diag/prdf/makefile
+++ b/src/usr/diag/prdf/makefile
@@ -40,6 +40,7 @@ include common/prdf_common_fsp_and_hb.mk
 include common/framework/prdf_framework.mk
 include common/plat/p9/prdf_plat_p9.mk
 include common/plat/cen/prdf_plat_cen.mk
+include common/plat/mem/prdf_plat_mem.mk
 include plat/p9/prdf_plat_p9_hb_only.mk
 
 VPATH += ${prd_vpath}
diff --git a/src/usr/diag/prdf/runtime/makefile b/src/usr/diag/prdf/runtime/makefile
index 9d321627f..16e3f6de1 100644
--- a/src/usr/diag/prdf/runtime/makefile
+++ b/src/usr/diag/prdf/runtime/makefile
@@ -39,6 +39,7 @@ include ../common/prdf_common_fsp_and_hb.mk
 include ../common/framework/prdf_framework.mk
 include ../common/plat/p9/prdf_plat_p9.mk
 include ../common/plat/cen/prdf_plat_cen.mk
+include ../common/plat/mem/prdf_plat_mem.mk
 
 VPATH += ${prd_vpath}