Change in coreboot[master]: soc/amd/common/gpio: Update the macros for interrupt and pad filtering

[Furquan Shaikh (Code Review)]

Furquan Shaikh has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/42870 )

Change subject: soc/amd/common/gpio: Update the macros for interrupt and pad filtering
......................................................................

soc/amd/common/gpio: Update the macros for interrupt and pad filtering

This change renames GPIO macros as follows:
1. Pad filtering macros are renamed to GPIO_TRIGGER_ and
GPIO_ACTIVE_. This determines the filtering applied on the input
signal at the pad.
2. Interrupt enabling macros are renamed to GPIO_INT_ENABLE_.

_INT_ is dropped from pad filtering macros because the filtering
applies to the input signal irrespective of how it is routed. It is
applied at the pad not only for GPIO interrupts but also for other
routes i.e. SCI, SMI, etc.

BUG=b:159944426

Change-Id: Id0ad770be77409aaaae4cc135945e2815ce97030
Signed-off-by: Furquan Shaikh 
---
M src/soc/amd/common/block/include/amdblocks/gpio_banks.h
1 file changed, 26 insertions(+), 17 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/70/42870/1

diff --git a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
index 2664ba5..91ace4d 100644
--- a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
+++ b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
@@ -26,18 +26,37 @@
 #define GPIO_PIN_IN		(1 << 0)	/* for byte access */
 #define GPIO_PIN_OUT		(1 << 6)	/* for byte access */

-#define GPIO_EDGE_TRIG		(0 << 8)
-#define GPIO_LEVEL_TRIG		(1 << 8)
+/* Pad trigger type - Level or Edge */
+#define GPIO_TRIGGER_EDGE	(0 << 8)
+#define GPIO_TRIGGER_LEVEL	(1 << 8)
 #define GPIO_TRIGGER_MASK	(1 << 8)

+/*
+ * Pad polarity:
+ * Level trigger - High or Low
+ * Edge trigger - High (Rising), Low (Falling), Both
+ */
 #define GPIO_ACTIVE_HIGH	(0 << 9)
 #define GPIO_ACTIVE_LOW		(1 << 9)
 #define GPIO_ACTIVE_BOTH	(2 << 9)
 #define GPIO_ACTIVE_MASK	(3 << 9)

-#define GPIO_INT_STATUS_EN	(1 << 11)
-#define GPIO_INT_DELIVERY_EN	(1 << 12)
-#define GPIO_INTERRUPT_MASK	(3 << 11)
+/*
+ * Pad trigger and polarity configuration.
+ * This determines the filtering applied on the input signal at the pad.
+ */
+#define GPIO_TRIGGER_EDGE_HIGH		(GPIO_ACTIVE_HIGH | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_EDGE_LOW		(GPIO_ACTIVE_LOW | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_BOTH_EDGES		(GPIO_ACTIVE_BOTH | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_LEVEL_HIGH		(GPIO_ACTIVE_HIGH | GPIO_TRIGGER_LEVEL)
+#define GPIO_TRIGGER_LEVEL_LOW		(GPIO_ACTIVE_LOW | GPIO_TRIGGER_LEVEL)
+
+#define GPIO_INT_ENABLE_STATUS		(1 << 11)
+#define GPIO_INT_ENABLE_DELIVERY	(1 << 12)
+#define GPIO_INT_ENABLE_STATUS_DELIVERY	\
+				(GPIO_INT_ENABLE_STATUS | GPIO_INT_ENABLE_STATUS_DELIVERY)
+#define GPIO_INT_ENABLE_MASK		(3 << 11)
+
 #define GPIO_S0I3_WAKE_EN	(1 << 13)
 #define GPIO_S3_WAKE_EN		(1 << 14)
 #define GPIO_S4_S5_WAKE_EN	(1 << 15)
@@ -100,12 +119,6 @@
 #define AMD_GPIO_CONTROL_MASK			0x00f4ff00
 #define AMD_GPIO_MUX_MASK			0x03

-/* Definitions for PAD_INT. */
-#define GPIO_INT_EDGE_HIGH		(GPIO_ACTIVE_HIGH | GPIO_EDGE_TRIG)
-#define GPIO_INT_EDGE_LOW		(GPIO_ACTIVE_LOW | GPIO_EDGE_TRIG)
-#define GPIO_INT_BOTH_EDGES		(GPIO_ACTIVE_BOTH | GPIO_EDGE_TRIG)
-#define GPIO_INT_LEVEL_HIGH		(GPIO_ACTIVE_HIGH | GPIO_LEVEL_TRIG)
-#define GPIO_INT_LEVEL_LOW		(GPIO_ACTIVE_LOW | GPIO_LEVEL_TRIG)

/*
  * Flags used for GPIO configuration. These provide additional information that does not go
@@ -185,10 +198,6 @@
 #define GPIO_IN_200mS			(13 | GPIO_TIMEBASE_15560uS)
 #define GPIO_IN_500mS			(8 | GPIO_TIMEBASE_62440uS)

-#define GPIO_EVENT_INT_STATUS		GPIO_INT_STATUS_EN
-#define GPIO_EVENT_INT_DELIVER		GPIO_INT_DELIVERY_EN
-#define GPIO_EVENT_INT_STATUS_DELIVER	(GPIO_INT_STATUS_EN | \
-					GPIO_INT_DELIVERY_EN)
 #define GPIO_WAKE_S0i3			(1 << 13)
 #define GPIO_WAKE_S3			(1 << 14)
 #define GPIO_WAKE_S4_S5			(1 << 15)
@@ -256,13 +265,13 @@
    	.flags = 0 }
 /* Auxiliary macro for legacy interrupt and wake */
 #define PAD_AUX1(pull, trigger) (GPIO_PULL ## _ ## pull | \
-				 GPIO_INT ## _ ## trigger)
+				 GPIO_TRIGGER ## _ ## trigger)
 /* Legacy interrupt pad configuration */
 #define PAD_INT(pin, pull, trigger, action) \
    { .gpio = (pin), \
    	.function = pin ## _IOMUX_ ## GPIOxx, \
    	.control = (PAD_AUX1(pull, trigger) | \
-			    GPIO_EVENT_INT ## _ ## action), \
+			    GPIO_INT_ENABLE ## _ ## action), \
    	.flags = GPIO_FLAG_INT }
 /* Auxiliary macro for SCI and SMI */
 #define PAD_AUX2(trigger, flag) (GPIO_FLAG_EVENT_TRIGGER ## _ ## trigger | flag)

[Kyösti Mälkki (Code Review)]

Kyösti Mälkki has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/42870 )

Change subject: soc/amd/common/gpio: Update the macros for interrupt and pad filtering
......................................................................

Patch Set 1: Code-Review+1

[Raul Rangel (Code Review)]

Raul Rangel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/42870 )

Change subject: soc/amd/common/gpio: Update the macros for interrupt and pad filtering
......................................................................

Patch Set 2: Code-Review+2

[Aaron Durbin (Code Review)]

Aaron Durbin has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/42870 )

Change subject: soc/amd/common/gpio: Update the macros for interrupt and pad filtering
......................................................................

Patch Set 3: Code-Review+2

[Furquan Shaikh (Code Review)]

Furquan Shaikh has submitted this change. ( https://review.coreboot.org/c/coreboot/+/42870 )

Change subject: soc/amd/common/gpio: Update the macros for interrupt and pad filtering
......................................................................

soc/amd/common/gpio: Update the macros for interrupt and pad filtering

This change renames GPIO macros as follows:
1. Pad filtering macros are renamed to GPIO_TRIGGER_ and
GPIO_ACTIVE_. This determines the filtering applied on the input
signal at the pad.
2. Interrupt enabling macros are renamed to GPIO_INT_ENABLE_.

_INT_ is dropped from pad filtering macros because the filtering
applies to the input signal irrespective of how it is routed. It is
applied at the pad not only for GPIO interrupts but also for other
routes i.e. SCI, SMI, etc.

BUG=b:159944426

Change-Id: Id0ad770be77409aaaae4cc135945e2815ce97030
Signed-off-by: Furquan Shaikh 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/42870
Reviewed-by: Aaron Durbin 
Reviewed-by: Raul Rangel 
Reviewed-by: Kyösti Mälkki 
Tested-by: build bot (Jenkins) 
---
M src/soc/amd/common/block/include/amdblocks/gpio_banks.h
1 file changed, 26 insertions(+), 17 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Kyösti Mälkki: Looks good to me, but someone else must approve
  Aaron Durbin: Looks good to me, approved
  Raul Rangel: Looks good to me, approved

diff --git a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
index 0521e4c..a78578d 100644
--- a/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
+++ b/src/soc/amd/common/block/include/amdblocks/gpio_banks.h
@@ -26,18 +26,37 @@
 #define GPIO_PIN_IN		(1 << 0)	/* for byte access */
 #define GPIO_PIN_OUT		(1 << 6)	/* for byte access */

-#define GPIO_EDGE_TRIG		(0 << 8)
-#define GPIO_LEVEL_TRIG		(1 << 8)
+/* Pad trigger type - Level or Edge */
+#define GPIO_TRIGGER_EDGE	(0 << 8)
+#define GPIO_TRIGGER_LEVEL	(1 << 8)
 #define GPIO_TRIGGER_MASK	(1 << 8)

+/*
+ * Pad polarity:
+ * Level trigger - High or Low
+ * Edge trigger - High (Rising), Low (Falling), Both
+ */
 #define GPIO_ACTIVE_HIGH	(0 << 9)
 #define GPIO_ACTIVE_LOW		(1 << 9)
 #define GPIO_ACTIVE_BOTH	(2 << 9)
 #define GPIO_ACTIVE_MASK	(3 << 9)

-#define GPIO_INT_STATUS_EN	(1 << 11)
-#define GPIO_INT_DELIVERY_EN	(1 << 12)
-#define GPIO_INTERRUPT_MASK	(3 << 11)
+/*
+ * Pad trigger and polarity configuration.
+ * This determines the filtering applied on the input signal at the pad.
+ */
+#define GPIO_TRIGGER_EDGE_HIGH		(GPIO_ACTIVE_HIGH | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_EDGE_LOW		(GPIO_ACTIVE_LOW | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_BOTH_EDGES		(GPIO_ACTIVE_BOTH | GPIO_TRIGGER_EDGE)
+#define GPIO_TRIGGER_LEVEL_HIGH		(GPIO_ACTIVE_HIGH | GPIO_TRIGGER_LEVEL)
+#define GPIO_TRIGGER_LEVEL_LOW		(GPIO_ACTIVE_LOW | GPIO_TRIGGER_LEVEL)
+
+#define GPIO_INT_ENABLE_STATUS		(1 << 11)
+#define GPIO_INT_ENABLE_DELIVERY	(1 << 12)
+#define GPIO_INT_ENABLE_STATUS_DELIVERY	\
+				(GPIO_INT_ENABLE_STATUS | GPIO_INT_ENABLE_STATUS_DELIVERY)
+#define GPIO_INT_ENABLE_MASK		(3 << 11)
+
 #define GPIO_S0I3_WAKE_EN	(1 << 13)
 #define GPIO_S3_WAKE_EN		(1 << 14)
 #define GPIO_S4_S5_WAKE_EN	(1 << 15)
@@ -100,12 +119,6 @@
 #define AMD_GPIO_CONTROL_MASK			0x00f4ff00
 #define AMD_GPIO_MUX_MASK			0x03

-/* Definitions for PAD_INT. */
-#define GPIO_INT_EDGE_HIGH		(GPIO_ACTIVE_HIGH | GPIO_EDGE_TRIG)
-#define GPIO_INT_EDGE_LOW		(GPIO_ACTIVE_LOW | GPIO_EDGE_TRIG)
-#define GPIO_INT_BOTH_EDGES		(GPIO_ACTIVE_BOTH | GPIO_EDGE_TRIG)
-#define GPIO_INT_LEVEL_HIGH		(GPIO_ACTIVE_HIGH | GPIO_LEVEL_TRIG)
-#define GPIO_INT_LEVEL_LOW		(GPIO_ACTIVE_LOW | GPIO_LEVEL_TRIG)

/*
  * Flags used for GPIO configuration. These provide additional information that does not go
@@ -185,10 +198,6 @@
 #define GPIO_IN_200mS			(13 | GPIO_TIMEBASE_15560uS)
 #define GPIO_IN_500mS			(8 | GPIO_TIMEBASE_62440uS)

-#define GPIO_EVENT_INT_STATUS		GPIO_INT_STATUS_EN
-#define GPIO_EVENT_INT_DELIVER		GPIO_INT_DELIVERY_EN
-#define GPIO_EVENT_INT_STATUS_DELIVER	(GPIO_INT_STATUS_EN | \
-					GPIO_INT_DELIVERY_EN)
 #define GPIO_WAKE_S0i3			(1 << 13)
 #define GPIO_WAKE_S3			(1 << 14)
 #define GPIO_WAKE_S4_S5			(1 << 15)
@@ -256,13 +265,13 @@
    	.flags = 0 }
 /* Auxiliary macro for legacy interrupt and wake */
 #define PAD_AUX1(pull, trigger) (GPIO_PULL ## _ ## pull | \
-				 GPIO_INT ## _ ## trigger)
+				 GPIO_TRIGGER ## _ ## trigger)
 /* Legacy interrupt pad configuration */
 #define PAD_INT(pin, pull, trigger, action) \
    { .gpio = (pin), \
    	.function = pin ## _IOMUX_ ## GPIOxx, \
    	.control = (PAD_AUX1(pull, trigger) | \
-			    GPIO_EVENT_INT ## _ ## action), \
+			    GPIO_INT_ENABLE ## _ ## action), \
    	.flags = GPIO_FLAG_INT }
 /* Auxiliary macro for SCI and SMI */
 #define PAD_AUX2(trigger, flag) (GPIO_FLAG_EVENT_TRIGGER ## _ ## trigger | flag)