[PATCH v2] sc16is7xx: Prevent dereferencing invalid data when gpio_hog used

[PATCH v2] sc16is7xx: Prevent dereferencing invalid data when gpio_hog used

[Radim Pavlik]

gpio_hog is trying to use gpio functions during probe call.
At that time we dont have initialized port data which are dereferenced
via assigned gpio.direction_input/output functions.
This results in unable to handle kernel NULL pointer dereference
followed by Kernel panic.
This patch prevents that.

Due to changed order of initialization 'port' before 'gpio controller'
was also changed error path which resulted in removed label.

No fixes tag because patch spans across multiple patches.

Signed-off-by: Radim Pavlik <radim.pavlik@tbs-biometrics.com>
---
 drivers/tty/serial/sc16is7xx.c | 49 +++++++++++++++++-----------------
 1 file changed, 24 insertions(+), 25 deletions(-)

diff --git a/drivers/tty/serial/sc16is7xx.c b/drivers/tty/serial/sc16is7xx.c
index 64e7e6c8145f..416fa71dcde1 100644
--- a/drivers/tty/serial/sc16is7xx.c
+++ b/drivers/tty/serial/sc16is7xx.c
@@ -1242,25 +1242,6 @@ static int sc16is7xx_probe(struct device *dev,
 	}
 	sched_set_fifo(s->kworker_task);

-#ifdef CONFIG_GPIOLIB
-	if (devtype->nr_gpio) {
-		/* Setup GPIO cotroller */
-		s->gpio.owner		 = THIS_MODULE;
-		s->gpio.parent		 = dev;
-		s->gpio.label		 = dev_name(dev);
-		s->gpio.direction_input	 = sc16is7xx_gpio_direction_input;
-		s->gpio.get		 = sc16is7xx_gpio_get;
-		s->gpio.direction_output = sc16is7xx_gpio_direction_output;
-		s->gpio.set		 = sc16is7xx_gpio_set;
-		s->gpio.base		 = -1;
-		s->gpio.ngpio		 = devtype->nr_gpio;
-		s->gpio.can_sleep	 = 1;
-		ret = gpiochip_add_data(&s->gpio, s);
-		if (ret)
-			goto out_thread;
-	}
-#endif
-
 	/* reset device, purging any pending irq / data */
 	regmap_write(s->regmap, SC16IS7XX_IOCONTROL_REG << SC16IS7XX_REG_SHIFT,
 			SC16IS7XX_IOCONTROL_SRESET_BIT);
@@ -1315,6 +1296,25 @@ static int sc16is7xx_probe(struct device *dev,
 		sc16is7xx_power(&s->p[i].port, 0);
 	}

+#ifdef CONFIG_GPIOLIB
+	if (devtype->nr_gpio) {
+		/* Setup GPIO cotroller */
+		s->gpio.owner		 = THIS_MODULE;
+		s->gpio.parent		 = dev;
+		s->gpio.label		 = dev_name(dev);
+		s->gpio.direction_input	 = sc16is7xx_gpio_direction_input;
+		s->gpio.get		 = sc16is7xx_gpio_get;
+		s->gpio.direction_output = sc16is7xx_gpio_direction_output;
+		s->gpio.set		 = sc16is7xx_gpio_set;
+		s->gpio.base		 = -1;
+		s->gpio.ngpio		 = devtype->nr_gpio;
+		s->gpio.can_sleep	 = 1;
+		ret = gpiochip_add_data(&s->gpio, s);
+		if (ret)
+			goto out_ports;
+	}
+#endif
+
 	if (dev->of_node) {
 		struct property *prop;
 		const __be32 *p;
@@ -1345,18 +1345,17 @@ static int sc16is7xx_probe(struct device *dev,
 	if (!ret)
 		return 0;

+#ifdef CONFIG_GPIOLIB
+	if (devtype->nr_gpio)
+		gpiochip_remove(&s->gpio);
+#endif
+
 out_ports:
 	for (i--; i >= 0; i--) {
 		uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
 		clear_bit(s->p[i].port.line, &sc16is7xx_lines);
 	}

-#ifdef CONFIG_GPIOLIB
-	if (devtype->nr_gpio)
-		gpiochip_remove(&s->gpio);
-
-out_thread:
-#endif
 	kthread_stop(s->kworker_task);

 out_clk:
--
2.32.0

Re: [PATCH v2] sc16is7xx: Prevent dereferencing invalid data when gpio_hog used

[Greg Kroah-Hartman]

On Mon, Dec 20, 2021 at 12:36:03PM +0100, Radim Pavlik wrote:
> gpio_hog is trying to use gpio functions during probe call.
> At that time we dont have initialized port data which are dereferenced
> via assigned gpio.direction_input/output functions.
> This results in unable to handle kernel NULL pointer dereference
> followed by Kernel panic.
> This patch prevents that.
> 
> Due to changed order of initialization 'port' before 'gpio controller'
> was also changed error path which resulted in removed label.
> 
> No fixes tag because patch spans across multiple patches.

Then list the individual patches please.  Or at least give us a chance
to know how far back to backport this to stable kernels.

thanks,

greg k-h

Re: [PATCH v2] sc16is7xx: Prevent dereferencing invalid data when gpio_hog used

[Greg Kroah-Hartman]

On Mon, Dec 20, 2021 at 12:36:03PM +0100, Radim Pavlik wrote:
> gpio_hog is trying to use gpio functions during probe call.
> At that time we dont have initialized port data which are dereferenced
> via assigned gpio.direction_input/output functions.
> This results in unable to handle kernel NULL pointer dereference
> followed by Kernel panic.
> This patch prevents that.
> 
> Due to changed order of initialization 'port' before 'gpio controller'
> was also changed error path which resulted in removed label.
> 
> No fixes tag because patch spans across multiple patches.
> 
> Signed-off-by: Radim Pavlik <radim.pavlik@tbs-biometrics.com>
> ---
>  drivers/tty/serial/sc16is7xx.c | 49 +++++++++++++++++-----------------
>  1 file changed, 24 insertions(+), 25 deletions(-)
> 
> diff --git a/drivers/tty/serial/sc16is7xx.c b/drivers/tty/serial/sc16is7xx.c
> index 64e7e6c8145f..416fa71dcde1 100644
> --- a/drivers/tty/serial/sc16is7xx.c
> +++ b/drivers/tty/serial/sc16is7xx.c
> @@ -1242,25 +1242,6 @@ static int sc16is7xx_probe(struct device *dev,
>  	}
>  	sched_set_fifo(s->kworker_task);
> 
> -#ifdef CONFIG_GPIOLIB
> -	if (devtype->nr_gpio) {
> -		/* Setup GPIO cotroller */
> -		s->gpio.owner		 = THIS_MODULE;
> -		s->gpio.parent		 = dev;
> -		s->gpio.label		 = dev_name(dev);
> -		s->gpio.direction_input	 = sc16is7xx_gpio_direction_input;
> -		s->gpio.get		 = sc16is7xx_gpio_get;
> -		s->gpio.direction_output = sc16is7xx_gpio_direction_output;
> -		s->gpio.set		 = sc16is7xx_gpio_set;
> -		s->gpio.base		 = -1;
> -		s->gpio.ngpio		 = devtype->nr_gpio;
> -		s->gpio.can_sleep	 = 1;
> -		ret = gpiochip_add_data(&s->gpio, s);
> -		if (ret)
> -			goto out_thread;
> -	}
> -#endif
> -
>  	/* reset device, purging any pending irq / data */
>  	regmap_write(s->regmap, SC16IS7XX_IOCONTROL_REG << SC16IS7XX_REG_SHIFT,
>  			SC16IS7XX_IOCONTROL_SRESET_BIT);
> @@ -1315,6 +1296,25 @@ static int sc16is7xx_probe(struct device *dev,
>  		sc16is7xx_power(&s->p[i].port, 0);
>  	}
> 
> +#ifdef CONFIG_GPIOLIB
> +	if (devtype->nr_gpio) {
> +		/* Setup GPIO cotroller */
> +		s->gpio.owner		 = THIS_MODULE;
> +		s->gpio.parent		 = dev;
> +		s->gpio.label		 = dev_name(dev);
> +		s->gpio.direction_input	 = sc16is7xx_gpio_direction_input;
> +		s->gpio.get		 = sc16is7xx_gpio_get;
> +		s->gpio.direction_output = sc16is7xx_gpio_direction_output;
> +		s->gpio.set		 = sc16is7xx_gpio_set;
> +		s->gpio.base		 = -1;
> +		s->gpio.ngpio		 = devtype->nr_gpio;
> +		s->gpio.can_sleep	 = 1;
> +		ret = gpiochip_add_data(&s->gpio, s);
> +		if (ret)
> +			goto out_ports;
> +	}
> +#endif
> +
>  	if (dev->of_node) {
>  		struct property *prop;
>  		const __be32 *p;
> @@ -1345,18 +1345,17 @@ static int sc16is7xx_probe(struct device *dev,
>  	if (!ret)
>  		return 0;
> 
> +#ifdef CONFIG_GPIOLIB
> +	if (devtype->nr_gpio)
> +		gpiochip_remove(&s->gpio);
> +#endif
> +
>  out_ports:
>  	for (i--; i >= 0; i--) {
>  		uart_remove_one_port(&sc16is7xx_uart, &s->p[i].port);
>  		clear_bit(s->p[i].port.line, &sc16is7xx_lines);
>  	}
> 
> -#ifdef CONFIG_GPIOLIB
> -	if (devtype->nr_gpio)
> -		gpiochip_remove(&s->gpio);
> -
> -out_thread:
> -#endif
>  	kthread_stop(s->kworker_task);
> 
>  out_clk:
> --
> 2.32.0
> 

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman.  You have sent him
a patch that has triggered this response.  He used to manually respond
to these common problems, but in order to save his sanity (he kept
writing the same thing over and over, yet to different people), I was
created.  Hopefully you will not take offence and will fix the problem
in your patch and resubmit it so that it can be accepted into the Linux
kernel tree.

You are receiving this message because of the following common error(s)
as indicated below:

- This looks like a new version of a previously submitted patch, but you
  did not list below the --- line any changes from the previous version.
  Please read the section entitled "The canonical patch format" in the
  kernel file, Documentation/SubmittingPatches for what needs to be done
  here to properly describe this.

If you wish to discuss this problem further, or you have questions about
how to resolve this issue, please feel free to respond to this email and
Greg will reply once he has dug out from the pending patches received
from other developers.

thanks,

greg k-h's patch email bot