Helper functions for p9 translate_addr

Change-Id: I223d39dc24a1453c27ca2704f7c2d72e07062429
RTC:173636
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/41416
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: William G. Hoffa <wghoffa@us.ibm.com>
Reviewed-by: Zane C. Shelley <zshelle@us.ibm.com>
Reviewed-by: Martha Broyles <mbroyles@us.ibm.com>
Reviewed-by: William A. Bryan <wilbryan@us.ibm.com>

5 files changed, 166 insertions, 1 deletions

diff --git a/src/occ_405/firdata/scom_addr_util.c b/src/occ_405/firdata/scom_addr_util.c
new file mode 100644
index 0000000..a59a5a7
--- /dev/null
+++ b/src/occ_405/firdata/scom_addr_util.c
@@ -0,0 +1,82 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/occ_405/firdata/scom_addr_util.c $                        */
+/*                                                                        */
+/* OpenPOWER OnChipController 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                                                     */
+#include "scom_addr_util.h"
+
+
+void set_sat_id(const uint8_t i_sat_id, uint64_t * o_addr)
+{
+    *o_addr &= 0xFFFFFFFFFFFFFC3FULL;
+    *o_addr |= ((i_sat_id & 0xF) << 6);
+}
+
+void set_chiplet_id(const uint8_t i_chiplet_id, uint64_t * o_addr)
+{
+    *o_addr &= 0xFFFFFFFFC0FFFFFFULL;
+    *o_addr |= ((i_chiplet_id & 0x3F) << 24);
+}
+
+void set_ring(const uint8_t i_ring, uint64_t * o_addr)
+{
+    *o_addr &= 0xFFFFFFFFFFFF03FFULL;
+    *o_addr |= ((i_ring & 0x3F) << 10);
+}
+
+void set_sat_offset(const uint8_t i_sat_offset, uint64_t * o_addr)
+{
+    *o_addr &= 0xFFFFFFFFFFFFFFC0ULL;
+    *o_addr |= (i_sat_offset & 0x3F);
+}
+
+void set_rxtx_group_id(const uint8_t i_grp_id, uint64_t * o_addr)
+{
+    *o_addr &= 0xFFFFF81FFFFFFFFFULL;
+    *o_addr |= (i_grp_id & 0x3FULL) << 37;
+}
+
+uint8_t get_sat_id(const uint64_t i_addr)
+{
+    return ((i_addr >> 6) & 0xF);
+}
+
+uint8_t get_chiplet_id(const uint64_t i_addr)
+{
+    return ((i_addr >> 24) & 0x3F);
+}
+
+uint8_t get_ring(const uint64_t i_addr)
+{
+    return ((i_addr >> 10) & 0x3F);
+}
+
+uint8_t get_sat_offset(const uint64_t i_addr)
+{
+    return (i_addr & 0x3F);
+}
+
+uint8_t get_rxtx_group_id(const uint64_t i_addr)
+{
+    return (i_addr >> 37) & 0x3F;
+}
+
diff --git a/src/occ_405/firdata/scom_addr_util.h b/src/occ_405/firdata/scom_addr_util.h
new file mode 100644
index 0000000..51988b4
--- /dev/null
+++ b/src/occ_405/firdata/scom_addr_util.h
@@ -0,0 +1,81 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/occ_405/firdata/scom_addr_util.h $                        */
+/*                                                                        */
+/* OpenPOWER OnChipController 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 __scom_addr_util_h
+#define __scom_addr_util_h
+
+#include <stdint.h>
+
+//This file is a result of de-classing the p9_scom_addr that currently
+//lives in EKB: chips/p9/common/scominfo/p9_scom_addr.H
+
+// @brief Modify SCOM address, update satellite ID field
+// @param[in] i_sat_id Satellite ID value to write
+// @retval none
+//
+void set_sat_id(const uint8_t i_sat_id, uint64_t * o_addr);
+
+// @brief Modify SCOM address, update pervasive chiplet ID
+// @param[in] i_chiplet_id Chiplet ID value to write
+// @retval none
+//
+void set_chiplet_id(const uint8_t i_chiplet_id, uint64_t * o_addr);
+
+// @brief Modify SCOM address, update ring field value
+// @param[in] i_ring Ring field value to write
+// @retval none
+void set_ring(const uint8_t i_ring, uint64_t * o_addr);
+
+// @brief Modify SCOM address, update satellite offset field
+// @param[in] i_sat_offset Satellite offset value to write
+// @retval none
+void set_sat_offset(const uint8_t i_sat_offset, uint64_t * o_addr);
+
+// @brief Modify SCOM address, update the RX or TX Group ID
+// @param[in] i_grp_id Group id to set
+// @retval none
+void set_rxtx_group_id(const uint8_t i_grp_id, uint64_t * o_addr);
+
+// @brief Extract satellite ID field from SCOM address
+// @retval uint8_t Satellite ID field value
+uint8_t get_sat_id(const uint64_t i_addr);
+
+// @brief Extract pervasive chiplet ID from SCOM address
+// @retval uint8_t Pervasive chiplet ID value
+uint8_t get_chiplet_id(const uint64_t i_addr);
+
+// @brief Extract ring field from SCOM address
+// @retval uint8_t Ring field value
+uint8_t get_ring(const uint64_t i_addr);
+
+// @brief Extract satellite register offset field from SCOM address
+// @retval uint8_t Satellite register offset field value
+uint8_t get_sat_offset(const uint64_t i_addr);
+
+// @brief Extract the RX or TX Group ID of an indirect scom address
+// @retval uint8_t Satellite register offset field value
+uint8_t get_rxtx_group_id(const uint64_t i_addr);
+
+
+#endif
diff --git a/src/occ_405/firdata/scom_util.c b/src/occ_405/firdata/scom_util.c
index b36ff58..2a32b3f 100644
--- a/src/occ_405/firdata/scom_util.c
+++ b/src/occ_405/firdata/scom_util.c
@@ -30,6 +30,7 @@
 #include "occ_common.h"
 #include "gpe_export.h"
 #include <scom_util.h>
+#include "scom_addr_util.h"
 
 bool G_request_created = FALSE;
 GPE_BUFFER(ipc_scom_op_t G_scom_op);
diff --git a/src/occ_405/occLinkInputFile b/src/occ_405/occLinkInputFile
index 34d93ce..82f7b9f 100644
--- a/src/occ_405/occLinkInputFile
+++ b/src/occ_405/occLinkInputFile
@@ -104,4 +104,4 @@ INPUT ( amec_amester.o
         native.o
         scom_trgt.o
         scom_util.o
-)
+        scom_addr_util.o)
diff --git a/src/occ_405/topfiles.mk b/src/occ_405/topfiles.mk
index ecc773d..18304d6 100644
--- a/src/occ_405/topfiles.mk
+++ b/src/occ_405/topfiles.mk
@@ -70,6 +70,7 @@ TOP-C-SOURCES = amec/amec_analytics.c \
                 firdata/fsi.c \
                 firdata/native.c \
                 firdata/pnor_mboxdd.c \
+                firdata/scom_addr_util.c \
                 firdata/scom_trgt.c \
                 firdata/scom_util.c \
                 homer.c \