summaryrefslogtreecommitdiffstats
path: root/src/include/usr/fapi2/dimmBadDqBitmapFuncs.H
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/usr/fapi2/dimmBadDqBitmapFuncs.H')
-rw-r--r--src/include/usr/fapi2/dimmBadDqBitmapFuncs.H85
1 files changed, 85 insertions, 0 deletions
diff --git a/src/include/usr/fapi2/dimmBadDqBitmapFuncs.H b/src/include/usr/fapi2/dimmBadDqBitmapFuncs.H
new file mode 100644
index 000000000..0cc564b68
--- /dev/null
+++ b/src/include/usr/fapi2/dimmBadDqBitmapFuncs.H
@@ -0,0 +1,85 @@
+/* IBM_PROLOG_BEGIN_TAG */
+/* This is an automatically generated prolog. */
+/* */
+/* $Source: src/include/usr/fapi2/dimmBadDqBitmapFuncs.H $ */
+/* */
+/* OpenPOWER HostBoot Project */
+/* */
+/* Contributors Listed Below - COPYRIGHT 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 */
+#ifndef DIMMBADDQBITMAPFUNCS_H_
+#define DIMMBADDQBITMAPFUNCS_H_
+
+#include <fapi2.H>
+#include <../memory/lib/shared/mss_const.H>
+
+extern "C"
+{
+
+/**
+ * @brief FW Team Utility function that gets the Bad DQ Bitmap.
+ *
+ * This utility functon should be called by a HWP needing to get the Bad DQ
+ * bitmap for a particular mca/mba, port, dimm and rank.
+ *
+ * This function finds the corresponding DIMM Target, calls
+ * dimmBadDqBitmapAccessHwp to get the DQ bitmap and returns the data
+ * for the specified rank.
+ *
+ * @param[in] i_fapiTrgt Reference to MCA/MBA Target
+ * @param[in] i_dimm MCA/MBA port DIMM number
+ * @param[in] i_rank DIMM rank number
+ * @param[out] o_data Reference to data where Bad DQ bitmap is copied to
+ * @param[in] i_port Optional port for MBA targets. Default is port 0.
+ *
+ * @return ReturnCode
+ */
+fapi2::ReturnCode dimmGetBadDqBitmap( const fapi2::Target
+ <fapi2::TARGET_TYPE_MCA|fapi2::TARGET_TYPE_MBA> & i_fapiTrgt,
+ const uint8_t i_dimm,
+ const uint8_t i_rank,
+ uint8_t (&o_data)[mss::BAD_DQ_BYTE_COUNT],
+ const uint8_t i_port = 0 );
+
+/**
+ * @brief FW Team Utility function that sets the Bad DQ Bitmap.
+ *
+ * This utility functon should be called by a HWP needing to set the Bad DQ
+ * bitmap for a particular mca/mba, port, dimm and rank.
+ *
+ * This utility function finds the corresponding DIMM Target, calls
+ * dimmBadDqBitmapAccessHwp to get the DQ bitmap, fills in the data for the
+ * specified rank and calls dimmBadDqBitmapAccessHwp to set the DQ bitmap
+ *
+ * @param[in] i_fapiTrgt Reference to MCA/MBA Chiplet
+ * @param[in] i_dimm MCA/MBA port DIMM number
+ * @param[in] i_rank DIMM rank number
+ * @param[in] i_data Reference to data where Bad DQ bitmap is copied from
+ * @param[in] i_port Optional port for MBA targets. Default is port 0.
+ *
+ * @return ReturnCode
+ */
+fapi2::ReturnCode dimmSetBadDqBitmap( const fapi2::Target
+ <fapi2::TARGET_TYPE_MCA|fapi2::TARGET_TYPE_MBA> & i_fapiTrgt,
+ const uint8_t i_dimm,
+ const uint8_t i_rank,
+ const uint8_t (&i_data)[mss::BAD_DQ_BYTE_COUNT],
+ const uint8_t i_port = 0 );
+}
+
+#endif
OpenPOWER on IntegriCloud