helpers: Add GENMASK macro

The GENMASK is defined in multiple files (with various names such as
MASKBIT), which sets certain consecutive bits to 1 and leaves the others
to 0. To avoid duplicate macros, add GENMASK macro to helpers.h.

GENMASK(high, low) sets bits from `high` to `low` (inclusive) to 1. For
example, GENMASK(39, 21) gives us the 64-bit vector 0x000000ffffe00000.

Remove duplicate macro definitions. Also utilize GENMASK for _BF_MASK in
mmio.h.

BUG=none
TEST=make tests/commonlib/bsd/helpers-test
TEST=emerge-cherry coreboot
BRANCH=none

Change-Id: If2e7c4827d8a7d27688534593b556a72f16f0c2b
Signed-off-by: Yu-Ping Wu <yupingso@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/56543
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Julius Werner <jwerner@chromium.org>

7 files changed, 33 insertions, 19 deletions

diff --git a/src/commonlib/bsd/include/commonlib/bsd/helpers.h b/src/commonlib/bsd/include/commonlib/bsd/helpers.h
index 376ebaef11..733b05a8f1 100644
--- a/src/commonlib/bsd/include/commonlib/bsd/helpers.h
+++ b/src/commonlib/bsd/include/commonlib/bsd/helpers.h
@@ -54,6 +54,9 @@
 
 #define POWER_OF_2(x)		(1ULL << (x))
 
+/* Set bits from `high` to `low` (inclusive). */
+#define GENMASK(high, low) (((~0ULL) << (low)) & (~0ULL >> (63 - (high))))
+
 #define DIV_ROUND_UP(x, y) ({ \
 	__typeof__(x) _div_local_x = (x); \
 	__typeof__(y) _div_local_y = (y); \
diff --git a/src/include/device/mmio.h b/src/include/device/mmio.h
index 9b79d79bb5..ca3dfa956e 100644
--- a/src/include/device/mmio.h
+++ b/src/include/device/mmio.h
@@ -4,6 +4,7 @@
 #define __DEVICE_MMIO_H__
 
 #include <arch/mmio.h>
+#include <commonlib/helpers.h>
 #include <endian.h>
 #include <types.h>
 
@@ -130,7 +131,8 @@ static inline void buffer_to_fifo32(void *buffer, size_t size, void *fifo,
 #define DEFINE_BIT(name, bit) DEFINE_BITFIELD(name, bit, bit)
 
 #define _BF_MASK(name, value) \
-	((u32)((1ULL << name##_BITFIELD_SIZE) - 1) << name##_BITFIELD_SHIFT)
+	((u32)GENMASK(name##_BITFIELD_SHIFT + name##_BITFIELD_SIZE - 1, \
+		      name##_BITFIELD_SHIFT))
 
 #define _BF_VALUE(name, value) \
 	(((u32)(value) << name##_BITFIELD_SHIFT) & _BF_MASK(name, 0))
diff --git a/src/soc/mediatek/common/pll.c b/src/soc/mediatek/common/pll.c
index 539d82cafe..ca6226a91a 100644
--- a/src/soc/mediatek/common/pll.c
+++ b/src/soc/mediatek/common/pll.c
@@ -5,8 +5,6 @@
 #include <soc/pll.h>
 #include <types.h>
 
-#define GENMASK(h, l) (BIT(h + 1) - BIT(l))
-
 void mux_set_sel(const struct mux *mux, u32 sel)
 {
 	u32 mask = GENMASK(mux->mux_width - 1, 0);
diff --git a/src/soc/mediatek/mt8195/dptx_hal.c b/src/soc/mediatek/mt8195/dptx_hal.c
index 6c6143a92f..cc96cc85c3 100644
--- a/src/soc/mediatek/mt8195/dptx_hal.c
+++ b/src/soc/mediatek/mt8195/dptx_hal.c
@@ -9,6 +9,7 @@
 #include <soc/dptx_reg.h>
 #include <string.h>
 #include <timer.h>
+#include <types.h>
 
 #define REG_OFFSET_LIMIT 0x8000
 
@@ -173,21 +174,21 @@ void dptx_hal_set_color_format(struct mtk_dp *mtk_dp, u8 out_format)
 {
 	/* MISC0 */
 	mtk_dp_write_byte(mtk_dp, REG_3034_DP_ENCODER0_P0,
-			  out_format << 0x1, MASKBIT(2, 1));
+			  out_format << 0x1, GENMASK(2, 1));
 
 	switch (out_format) {
 	case DP_COLOR_FORMAT_RGB_444:
 	case DP_COLOR_FORMAT_YUV_444:
 		mtk_dp_write_byte(mtk_dp, REG_303C_DP_ENCODER0_P0 + 1,
-				  0, MASKBIT(6, 4));
+				  0, GENMASK(6, 4));
 		break;
 	case DP_COLOR_FORMAT_YUV_422:
 		mtk_dp_write_byte(mtk_dp, REG_303C_DP_ENCODER0_P0 + 1,
-				  BIT(4), MASKBIT(6, 4));
+				  BIT(4), GENMASK(6, 4));
 		break;
 	case DP_COLOR_FORMAT_YUV_420:
 		mtk_dp_write_byte(mtk_dp, REG_303C_DP_ENCODER0_P0 + 1, BIT(5),
-				  MASKBIT(6, 4));
+				  GENMASK(6, 4));
 		break;
 	default:
 		break;
@@ -592,15 +593,15 @@ void dptx_hal_hpd_int_en(struct mtk_dp *mtk_dp, bool enable)
 {
 	/* [7]:int, [6]:Con, [5]DisCon, [4]No-Use: UnMASK HPD Port */
 	mtk_dp_write_byte(mtk_dp, REG_3418_DP_TRANS_P0,
-			  enable ? 0 : MASKBIT(7, 5), MASKBIT(7, 5));
+			  enable ? 0 : GENMASK(7, 5), GENMASK(7, 5));
 }
 
 void dptx_hal_hpd_detect_setting(struct mtk_dp *mtk_dp)
 {
 	mtk_dp_write_byte(mtk_dp, REG_3410_DP_TRANS_P0,
-			  0x8, MASKBIT(3, 0));
+			  0x8, GENMASK(3, 0));
 	mtk_dp_write_byte(mtk_dp, REG_3410_DP_TRANS_P0,
-			  0xa << 4, MASKBIT(7, 4));
+			  0xa << 4, GENMASK(7, 4));
 
 	DP_WRITE1BYTE(mtk_dp, REG_3410_DP_TRANS_P0 + 1, 0x55);
 	DP_WRITE1BYTE(mtk_dp, REG_3430_DP_TRANS_P0, 0x2);
@@ -643,14 +644,14 @@ void dptx_hal_phy_setting(struct mtk_dp *mtk_dp)
 
 void dptx_hal_ssc_en(struct mtk_dp *mtk_dp, bool enable)
 {
-	mtk_dp_mask(mtk_dp, 0x2000, BIT(0), MASKBIT(1, 0));
+	mtk_dp_mask(mtk_dp, 0x2000, BIT(0), GENMASK(1, 0));
 
 	if (enable)
 		mtk_dp_mask(mtk_dp, 0x1014, BIT(3), BIT(3));
 	else
 		mtk_dp_mask(mtk_dp, 0x1014, 0x0, BIT(3));
 
-	mtk_dp_mask(mtk_dp, 0x2000, MASKBIT(1, 0), MASKBIT(1, 0));
+	mtk_dp_mask(mtk_dp, 0x2000, GENMASK(1, 0), GENMASK(1, 0));
 
 	mdelay(1);
 }
@@ -666,7 +667,7 @@ void dptx_hal_aux_setting(struct mtk_dp *mtk_dp)
 	DP_WRITE1BYTE(mtk_dp, REG_3634_AUX_TX_P0 + 1, 0x19);
 	/* 0xd for 26M */
 	mtk_dp_write_byte(mtk_dp, REG_3614_AUX_TX_P0,
-			  0xd, MASKBIT(6, 0));
+			  0xd, GENMASK(6, 0));
 	mtk_dp_mask(mtk_dp, REG_37C8_AUX_TX_P0,
 		    0x01 << MTK_ATOP_EN_AUX_TX_P0_FLDMASK_POS,
 		    MTK_ATOP_EN_AUX_TX_P0_FLDMASK);
@@ -681,7 +682,7 @@ void dptx_hal_digital_setting(struct mtk_dp *mtk_dp)
 
 	dptx_hal_set_color_depth(mtk_dp, DP_COLOR_DEPTH_8BIT);
 	mtk_dp_write_byte(mtk_dp, REG_3368_DP_ENCODER1_P0 + 1,
-			  BIT(4), MASKBIT(5, 4));
+			  BIT(4), GENMASK(5, 4));
 	/* DPtx encoder reset all sw. */
 	mtk_dp_write_byte(mtk_dp, REG_3004_DP_ENCODER0_P0 + 1, BIT(1), BIT(1));
 
@@ -758,7 +759,7 @@ void dptx_hal_set_txtrainingpattern(struct mtk_dp *mtk_dp, int value)
 		dptx_hal_phy_setidlepattern(mtk_dp, false);
 
 	mtk_dp_write_byte(mtk_dp, REG_3400_DP_TRANS_P0 + 1,
-			  value, MASKBIT(7, 4));
+			  value, GENMASK(7, 4));
 }
 
 void dptx_hal_phy_setidlepattern(struct mtk_dp *mtk_dp, bool enable)
diff --git a/src/soc/mediatek/mt8195/include/soc/dptx_hal.h b/src/soc/mediatek/mt8195/include/soc/dptx_hal.h
index b943c27cfa..dcb171705b 100644
--- a/src/soc/mediatek/mt8195/include/soc/dptx_hal.h
+++ b/src/soc/mediatek/mt8195/include/soc/dptx_hal.h
@@ -15,8 +15,6 @@
 #define DP_AUX_NATIVE_WRITE		0x8
 #define DP_AUX_NATIVE_READ		0x9
 
-#define MASKBIT(a, b) ((a > b) ? (BIT(a + 1) - BIT(b)) : (BIT(b + 1) - BIT(a)))
-
 #define DP_WRITE1BYTE(mtk_dp, reg, u8_val) \
 	mtk_dp_write_byte(mtk_dp, reg, u8_val, 0xff)
 #define DP_WRITE2BYTE(mtk_dp, reg, u16_val) \
diff --git a/src/soc/qualcomm/sc7180/include/soc/qcom_qup_se.h b/src/soc/qualcomm/sc7180/include/soc/qcom_qup_se.h
index d2f171fa71..b85b9ed488 100644
--- a/src/soc/qualcomm/sc7180/include/soc/qcom_qup_se.h
+++ b/src/soc/qualcomm/sc7180/include/soc/qcom_qup_se.h
@@ -9,8 +9,6 @@
 #include <timer.h>
 #include <types.h>
 
-#define GENMASK(h, l)	(BIT(h + 1) - BIT(l))
-
 /* GENI_OUTPUT_CTRL fields */
 #define DEFAULT_IO_OUTPUT_CTRL_MSK	GENMASK(6, 0)
 
diff --git a/tests/commonlib/bsd/helpers-test.c b/tests/commonlib/bsd/helpers-test.c
index ec3f98bed1..324c901b12 100644
--- a/tests/commonlib/bsd/helpers-test.c
+++ b/tests/commonlib/bsd/helpers-test.c
@@ -8,6 +8,19 @@ static void func(void)
 	function_called();
 }
 
+static void test_genmask(void **state)
+{
+	assert_int_equal(GENMASK(4, 4), 0x10);
+	assert_int_equal(GENMASK(4, 3), 0x18);
+	assert_int_equal(GENMASK(4, 0), 0x1f);
+	/* Edge cases */
+	assert_int_equal(GENMASK(0, 0), 1);
+	assert_int_equal(GENMASK(31, 31), 0x80000000);
+	assert_int_equal(GENMASK(31, 0), 0xffffffff);
+	assert_int_equal(GENMASK(63, 63), 0x8000000000000000);
+	assert_int_equal(GENMASK(63, 0), 0xffffffffffffffff);
+}
+
 static void test_retry(void **state)
 {
 	int count;
@@ -34,6 +47,7 @@ static void test_retry(void **state)
 int main(void)
 {
 	const struct CMUnitTest tests[] = {
+		cmocka_unit_test(test_genmask),
 		cmocka_unit_test(test_retry),
 	};