[v3] mfd: tqmx86: new hardware and GPIO/I2C IRQ improvements/additions

[PATCH v3 3/5] mfd: tqmx86: refactor GPIO IRQ setup

Posted by Matthias Schiffer 2 months, 2 weeks ago

Move IRQ setup into a helper function. The string "GPIO" for error
messages is replaced with a label argument to prepare for reusing the
function for the I2C IRQ.

No functional change intended.

Co-developed-by: Gregor Herburger <gregor.herburger@tq-group.com>
Signed-off-by: Gregor Herburger <gregor.herburger@tq-group.com>
Signed-off-by: Matthias Schiffer <matthias.schiffer@ew.tq-group.com>
---

v2: no changes (was patch 2/4)
v3: no changes

 drivers/mfd/tqmx86.c | 72 +++++++++++++++++++++++++++-----------------
 1 file changed, 45 insertions(+), 27 deletions(-)

diff --git a/drivers/mfd/tqmx86.c b/drivers/mfd/tqmx86.c
index 7b2f9490a9af5..5aa51ead00a28 100644
--- a/drivers/mfd/tqmx86.c
+++ b/drivers/mfd/tqmx86.c
@@ -186,32 +186,54 @@ static int tqmx86_board_id_to_clk_rate(struct device *dev, u8 board_id)
 	}
 }
 
-static int tqmx86_probe(struct platform_device *pdev)
+static int tqmx86_irq_to_irq_cfg(struct device *dev, const char *label, u8 irq)
 {
-	u8 board_id, sauc, rev, i2c_det, io_ext_int_val;
-	struct device *dev = &pdev->dev;
-	u8 gpio_irq_cfg, readback;
-	const char *board_name;
-	void __iomem *io_base;
-	int err;
-
-	switch (gpio_irq) {
+	switch (irq) {
 	case 0:
-		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_NONE;
-		break;
+		return TQMX86_REG_IO_EXT_INT_NONE;
 	case 7:
-		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_7;
-		break;
+		return TQMX86_REG_IO_EXT_INT_7;
 	case 9:
-		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_9;
-		break;
+		return TQMX86_REG_IO_EXT_INT_9;
 	case 12:
-		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_12;
-		break;
+		return TQMX86_REG_IO_EXT_INT_12;
 	default:
-		pr_err("tqmx86: Invalid GPIO IRQ (%d)\n", gpio_irq);
+		dev_err(dev, "invalid %s IRQ (%d)\n", label, irq);
 		return -EINVAL;
 	}
+}
+
+static int tqmx86_setup_irq(struct device *dev, const char *label, u8 irq,
+			    void __iomem *io_base, u8 reg_shift)
+{
+	u8 val, readback;
+	int irq_cfg;
+
+	irq_cfg = tqmx86_irq_to_irq_cfg(dev, label, irq);
+	if (irq_cfg < 0)
+		return irq_cfg;
+
+	val = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
+	val &= ~(TQMX86_REG_IO_EXT_INT_MASK << reg_shift);
+	val |= (irq_cfg & TQMX86_REG_IO_EXT_INT_MASK) << reg_shift;
+
+	iowrite8(val, io_base + TQMX86_REG_IO_EXT_INT);
+	readback = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
+	if (readback != val) {
+		dev_warn(dev, "%s interrupts not supported\n", label);
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+static int tqmx86_probe(struct platform_device *pdev)
+{
+	u8 board_id, sauc, rev, i2c_det;
+	struct device *dev = &pdev->dev;
+	const char *board_name;
+	void __iomem *io_base;
+	int err;
 
 	io_base = devm_ioport_map(dev, TQMX86_IOBASE, TQMX86_IOSIZE);
 	if (!io_base)
@@ -233,15 +255,11 @@ static int tqmx86_probe(struct platform_device *pdev)
 	 */
 	i2c_det = inb(TQMX86_REG_I2C_DETECT);
 
-	if (gpio_irq_cfg) {
-		io_ext_int_val =
-			gpio_irq_cfg << TQMX86_REG_IO_EXT_INT_GPIO_SHIFT;
-		iowrite8(io_ext_int_val, io_base + TQMX86_REG_IO_EXT_INT);
-		readback = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
-		if (readback != io_ext_int_val) {
-			dev_warn(dev, "GPIO interrupts not supported.\n");
-			return -EINVAL;
-		}
+	if (gpio_irq) {
+		err = tqmx86_setup_irq(dev, "GPIO", gpio_irq, io_base,
+				       TQMX86_REG_IO_EXT_INT_GPIO_SHIFT);
+		if (err)
+			return err;
 
 		/* Assumes the IRQ resource is first. */
 		tqmx_gpio_resources[0].start = gpio_irq;
-- 
TQ-Systems GmbH | Mühlstraße 2, Gut Delling | 82229 Seefeld, Germany
Amtsgericht München, HRB 105018
Geschäftsführer: Detlef Schneider, Rüdiger Stahl, Stefan Schneider
https://www.tq-group.com/

Re: [PATCH v3 3/5] mfd: tqmx86: refactor GPIO IRQ setup

Posted by Lee Jones 1 month, 3 weeks ago

On Thu, 12 Sep 2024, Matthias Schiffer wrote:

> Move IRQ setup into a helper function. The string "GPIO" for error
> messages is replaced with a label argument to prepare for reusing the
> function for the I2C IRQ.
> 
> No functional change intended.
> 
> Co-developed-by: Gregor Herburger <gregor.herburger@tq-group.com>
> Signed-off-by: Gregor Herburger <gregor.herburger@tq-group.com>
> Signed-off-by: Matthias Schiffer <matthias.schiffer@ew.tq-group.com>
> ---
> 
> v2: no changes (was patch 2/4)
> v3: no changes
> 
>  drivers/mfd/tqmx86.c | 72 +++++++++++++++++++++++++++-----------------
>  1 file changed, 45 insertions(+), 27 deletions(-)
> 
> diff --git a/drivers/mfd/tqmx86.c b/drivers/mfd/tqmx86.c
> index 7b2f9490a9af5..5aa51ead00a28 100644
> --- a/drivers/mfd/tqmx86.c
> +++ b/drivers/mfd/tqmx86.c
> @@ -186,32 +186,54 @@ static int tqmx86_board_id_to_clk_rate(struct device *dev, u8 board_id)
>  	}
>  }
>  
> -static int tqmx86_probe(struct platform_device *pdev)
> +static int tqmx86_irq_to_irq_cfg(struct device *dev, const char *label, u8 irq)

Not sure single case statement that only gets called once warrants its
own function (with a weird name).  I'd put it in tqmx86_setup_irq() and
have done.

>  {
> -	u8 board_id, sauc, rev, i2c_det, io_ext_int_val;
> -	struct device *dev = &pdev->dev;
> -	u8 gpio_irq_cfg, readback;
> -	const char *board_name;
> -	void __iomem *io_base;
> -	int err;
> -
> -	switch (gpio_irq) {
> +	switch (irq) {
>  	case 0:
> -		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_NONE;
> -		break;
> +		return TQMX86_REG_IO_EXT_INT_NONE;
>  	case 7:
> -		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_7;
> -		break;
> +		return TQMX86_REG_IO_EXT_INT_7;
>  	case 9:
> -		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_9;
> -		break;
> +		return TQMX86_REG_IO_EXT_INT_9;
>  	case 12:
> -		gpio_irq_cfg = TQMX86_REG_IO_EXT_INT_12;
> -		break;
> +		return TQMX86_REG_IO_EXT_INT_12;
>  	default:
> -		pr_err("tqmx86: Invalid GPIO IRQ (%d)\n", gpio_irq);
> +		dev_err(dev, "invalid %s IRQ (%d)\n", label, irq);
>  		return -EINVAL;
>  	}
> +}
> +
> +static int tqmx86_setup_irq(struct device *dev, const char *label, u8 irq,
> +			    void __iomem *io_base, u8 reg_shift)
> +{
> +	u8 val, readback;
> +	int irq_cfg;
> +
> +	irq_cfg = tqmx86_irq_to_irq_cfg(dev, label, irq);
> +	if (irq_cfg < 0)
> +		return irq_cfg;
> +
> +	val = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
> +	val &= ~(TQMX86_REG_IO_EXT_INT_MASK << reg_shift);
> +	val |= (irq_cfg & TQMX86_REG_IO_EXT_INT_MASK) << reg_shift;
> +
> +	iowrite8(val, io_base + TQMX86_REG_IO_EXT_INT);
> +	readback = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
> +	if (readback != val) {
> +		dev_warn(dev, "%s interrupts not supported\n", label);
> +		return -EINVAL;
> +	}
> +
> +	return 0;
> +}
> +
> +static int tqmx86_probe(struct platform_device *pdev)
> +{
> +	u8 board_id, sauc, rev, i2c_det;
> +	struct device *dev = &pdev->dev;
> +	const char *board_name;
> +	void __iomem *io_base;
> +	int err;
>  
>  	io_base = devm_ioport_map(dev, TQMX86_IOBASE, TQMX86_IOSIZE);
>  	if (!io_base)
> @@ -233,15 +255,11 @@ static int tqmx86_probe(struct platform_device *pdev)
>  	 */
>  	i2c_det = inb(TQMX86_REG_I2C_DETECT);
>  
> -	if (gpio_irq_cfg) {
> -		io_ext_int_val =
> -			gpio_irq_cfg << TQMX86_REG_IO_EXT_INT_GPIO_SHIFT;
> -		iowrite8(io_ext_int_val, io_base + TQMX86_REG_IO_EXT_INT);
> -		readback = ioread8(io_base + TQMX86_REG_IO_EXT_INT);
> -		if (readback != io_ext_int_val) {
> -			dev_warn(dev, "GPIO interrupts not supported.\n");
> -			return -EINVAL;
> -		}
> +	if (gpio_irq) {
> +		err = tqmx86_setup_irq(dev, "GPIO", gpio_irq, io_base,
> +				       TQMX86_REG_IO_EXT_INT_GPIO_SHIFT);
> +		if (err)
> +			return err;
>  
>  		/* Assumes the IRQ resource is first. */
>  		tqmx_gpio_resources[0].start = gpio_irq;
> -- 
> TQ-Systems GmbH | Mühlstraße 2, Gut Delling | 82229 Seefeld, Germany
> Amtsgericht München, HRB 105018
> Geschäftsführer: Detlef Schneider, Rüdiger Stahl, Stefan Schneider
> https://www.tq-group.com/

-- 
Lee Jones [李琼斯]

[PATCH v3 1/5] mfd: tqmx86: add board definitions for TQMx120UC, TQMx130UC and TQMxE41S
[PATCH v3 2/5] mfd: tqmx86: improve gpio_irq module parameter description
[PATCH v3 3/5] mfd: tqmx86: refactor GPIO IRQ setup
[PATCH v3 4/5] mfd: tqmx86: make IRQ setup errors non-fatal
[PATCH v3 5/5] mfd: tqmx86: add I2C IRQ support