[PATCH 6/6] i2c: davinci: use devm_ functions

[PATCH 6/6] i2c: davinci: use devm_ functions

[Julia Lawall]

From: Julia Lawall <Julia.Lawall@lip6.fr>

The various devm_ functions allocate memory that is released when a driver
detaches.  This patch uses these functions for data that is allocated in
the probe function of a platform device and is only freed in the remove
function.

The call to platform_get_resource is moved down to the call to
devm_request_and_ioremap that uses it.

Signed-off-by: Julia Lawall <Julia.Lawall@lip6.fr>

---
Not compiled.
I was not sure what to do with the comment on the first line, so I just
left it where it is.
I was also concerned about the calls to get_device and put_device, and
whether they would cause &pdev->dev to be freed before the devm-allocated
objects were freed.  Most other platform drivers don't seem to have these
calls.

 drivers/i2c/busses/i2c-davinci.c |   51 +++++++++------------------------------
 1 file changed, 12 insertions(+), 39 deletions(-)

diff --git a/drivers/i2c/busses/i2c-davinci.c b/drivers/i2c/busses/i2c-davinci.c
index b6185dc..c8e9c87 100644
--- a/drivers/i2c/busses/i2c-davinci.c
+++ b/drivers/i2c/busses/i2c-davinci.c
@@ -647,30 +647,16 @@ static int davinci_i2c_probe(struct platform_device *pdev)
 	int r;
 
 	/* NOTE: driver uses the static register mapping */
-	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-	if (!mem) {
-		dev_err(&pdev->dev, "no mem resource?\n");
-		return -ENODEV;
-	}
-
 	irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 	if (!irq) {
 		dev_err(&pdev->dev, "no irq resource?\n");
 		return -ENODEV;
 	}
 
-	ioarea = request_mem_region(mem->start, resource_size(mem),
-				    pdev->name);
-	if (!ioarea) {
-		dev_err(&pdev->dev, "I2C region already claimed\n");
-		return -EBUSY;
-	}
-
-	dev = kzalloc(sizeof(struct davinci_i2c_dev), GFP_KERNEL);
-	if (!dev) {
-		r = -ENOMEM;
-		goto err_release_region;
-	}
+	dev = devm_kzalloc(&pdev->dev, sizeof(struct davinci_i2c_dev),
+			   GFP_KERNEL);
+	if (!dev)
+		return -ENOMEM;
 
 	init_completion(&dev->cmd_complete);
 #ifdef CONFIG_CPU_FREQ
@@ -699,14 +685,15 @@ static int davinci_i2c_probe(struct platform_device *pdev)
 		dev->pdata = &davinci_i2c_platform_data_default;
 	}
 
-	dev->clk = clk_get(&pdev->dev, NULL);
+	dev->clk = devm_clk_get(&pdev->dev, NULL);
 	if (IS_ERR(dev->clk)) {
 		r = -ENODEV;
 		goto err_free_mem;
 	}
 	clk_enable(dev->clk);
 
-	dev->base = ioremap(mem->start, resource_size(mem));
+	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	dev->base = devm_request_and_ioremap(&pdev->dev, mem);
 	if (!dev->base) {
 		r = -EBUSY;
 		goto err_mem_ioremap;
@@ -714,16 +701,17 @@ static int davinci_i2c_probe(struct platform_device *pdev)
 
 	i2c_davinci_init(dev);
 
-	r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
+	r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
+			     pdev->name, dev);
 	if (r) {
 		dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
-		goto err_unuse_clocks;
+		goto err_mem_ioremap;
 	}
 
 	r = i2c_davinci_cpufreq_register(dev);
 	if (r) {
 		dev_err(&pdev->dev, "failed to register cpufreq\n");
-		goto err_free_irq;
+		goto err_mem_ioremap;
 	}
 
 	adap = &dev->adapter;
@@ -740,26 +728,18 @@ static int davinci_i2c_probe(struct platform_device *pdev)
 	r = i2c_add_numbered_adapter(adap);
 	if (r) {
 		dev_err(&pdev->dev, "failure adding adapter\n");
-		goto err_free_irq;
+		goto err_mem_ioremap;
 	}
 	of_i2c_register_devices(adap);
 
 	return 0;
 
-err_free_irq:
-	free_irq(dev->irq, dev);
-err_unuse_clocks:
-	iounmap(dev->base);
 err_mem_ioremap:
 	clk_disable(dev->clk);
-	clk_put(dev->clk);
 	dev->clk = NULL;
 err_free_mem:
 	platform_set_drvdata(pdev, NULL);
 	put_device(&pdev->dev);
-	kfree(dev);
-err_release_region:
-	release_mem_region(mem->start, resource_size(mem));
 
 	return r;
 }
@@ -767,7 +747,6 @@ err_release_region:
 static int davinci_i2c_remove(struct platform_device *pdev)
 {
 	struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
-	struct resource *mem;
 
 	i2c_davinci_cpufreq_deregister(dev);
 
@@ -776,16 +755,10 @@ static int davinci_i2c_remove(struct platform_device *pdev)
 	put_device(&pdev->dev);
 
 	clk_disable(dev->clk);
-	clk_put(dev->clk);
 	dev->clk = NULL;
 
 	davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
-	free_irq(dev->irq, dev);
-	iounmap(dev->base);
-	kfree(dev);
 
-	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-	release_mem_region(mem->start, resource_size(mem));
 	return 0;
 }
 

Re: [PATCH 6/6] i2c: davinci: use devm_ functions

[Sergei Shtylyov]

Hello.

On 08/25/2012 09:41 PM, Julia Lawall wrote:

> From: Julia Lawall <Julia.Lawall@lip6.fr>

> The various devm_ functions allocate memory that is released when a driver
> detaches.  This patch uses these functions for data that is allocated in
> the probe function of a platform device and is only freed in the remove
> function.

> The call to platform_get_resource is moved down to the call to
> devm_request_and_ioremap that uses it.

> Signed-off-by: Julia Lawall <Julia.Lawall@lip6.fr>

> ---
> Not compiled.

   I see. :-)

> I was not sure what to do with the comment on the first line, so I just
> left it where it is.
> I was also concerned about the calls to get_device and put_device, and
> whether they would cause &pdev->dev to be freed before the devm-allocated
> objects were freed.  Most other platform drivers don't seem to have these
> calls.

>  drivers/i2c/busses/i2c-davinci.c |   51 +++++++++------------------------------
>  1 file changed, 12 insertions(+), 39 deletions(-)

> diff --git a/drivers/i2c/busses/i2c-davinci.c b/drivers/i2c/busses/i2c-davinci.c
> index b6185dc..c8e9c87 100644
> --- a/drivers/i2c/busses/i2c-davinci.c
> +++ b/drivers/i2c/busses/i2c-davinci.c
> @@ -647,30 +647,16 @@ static int davinci_i2c_probe(struct platform_device *pdev)
>  	int r;
>  
>  	/* NOTE: driver uses the static register mapping */
> -	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> -	if (!mem) {
> -		dev_err(&pdev->dev, "no mem resource?\n");
> -		return -ENODEV;
> -	}
> -
>  	irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
>  	if (!irq) {
>  		dev_err(&pdev->dev, "no irq resource?\n");
>  		return -ENODEV;
>  	}
>  
> -	ioarea = request_mem_region(mem->start, resource_size(mem),
> -				    pdev->name);
> -	if (!ioarea) {
> -		dev_err(&pdev->dev, "I2C region already claimed\n");
> -		return -EBUSY;
> -	}

   Shouldn't you have dropped the 'ioarea' variable? It should be unused now...

> @@ -699,14 +685,15 @@ static int davinci_i2c_probe(struct platform_device *pdev)
[...]
> -	dev->base = ioremap(mem->start, resource_size(mem));
> +	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);

   Why you dropped check form 'mem' being NULL?

> +	dev->base = devm_request_and_ioremap(&pdev->dev, mem);
>  	if (!dev->base) {
>  		r = -EBUSY;
>  		goto err_mem_ioremap;
> @@ -714,16 +701,17 @@ static int davinci_i2c_probe(struct platform_device *pdev)
>  
>  	i2c_davinci_init(dev);
>  
> -	r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
> +	r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
> +			     pdev->name, dev);
>  	if (r) {
>  		dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
> -		goto err_unuse_clocks;
> +		goto err_mem_ioremap;

   The label no longer corresponds the failure happening. Perhaps it's better to
leave 'err_unuse_clocks'...

>  	}
>  
>  	r = i2c_davinci_cpufreq_register(dev);
>  	if (r) {
>  		dev_err(&pdev->dev, "failed to register cpufreq\n");
> -		goto err_free_irq;
> +		goto err_mem_ioremap;

   Ditto...

> @@ -740,26 +728,18 @@ static int davinci_i2c_probe(struct platform_device *pdev)
>  	r = i2c_add_numbered_adapter(adap);
>  	if (r) {
>  		dev_err(&pdev->dev, "failure adding adapter\n");
> -		goto err_free_irq;
> +		goto err_mem_ioremap;

   Ditto...

WBR, Sergei

Re: [PATCH 6/6] i2c: davinci: use devm_ functions

[Julia Lawall]

> > -	ioarea = request_mem_region(mem->start, resource_size(mem),
> > -				    pdev->name);
> > -	if (!ioarea) {
> > -		dev_err(&pdev->dev, "I2C region already claimed\n");
> > -		return -EBUSY;
> > -	}
>
>    Shouldn't you have dropped the 'ioarea' variable? It should be unused now...

Indeed, this is probably the case.  I will check.

> > @@ -699,14 +685,15 @@ static int davinci_i2c_probe(struct platform_device *pdev)
> [...]
> > -	dev->base = ioremap(mem->start, resource_size(mem));
> > +	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
>
>    Why you dropped check form 'mem' being NULL?

devm_request_and_ioremap does the check.  There have been some discussions
about this before.  Since the code is overall complicated and error-prone,
it seems better to minimize it when possible.

> > +	dev->base = devm_request_and_ioremap(&pdev->dev, mem);
> >  	if (!dev->base) {
> >  		r = -EBUSY;
> >  		goto err_mem_ioremap;
> > @@ -714,16 +701,17 @@ static int davinci_i2c_probe(struct platform_device *pdev)
> >
> >  	i2c_davinci_init(dev);
> >
> > -	r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
> > +	r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
> > +			     pdev->name, dev);
> >  	if (r) {
> >  		dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
> > -		goto err_unuse_clocks;
> > +		goto err_mem_ioremap;
>
>    The label no longer corresponds the failure happening. Perhaps it's better to
> leave 'err_unuse_clocks'...

OK.  It seemed nicer not to have a stack of empty labels...

I'll send another patch shortly.

julia

> >  	}
> >
> >  	r = i2c_davinci_cpufreq_register(dev);
> >  	if (r) {
> >  		dev_err(&pdev->dev, "failed to register cpufreq\n");
> > -		goto err_free_irq;
> > +		goto err_mem_ioremap;
>
>    Ditto...
>
> > @@ -740,26 +728,18 @@ static int davinci_i2c_probe(struct platform_device *pdev)
> >  	r = i2c_add_numbered_adapter(adap);
> >  	if (r) {
> >  		dev_err(&pdev->dev, "failure adding adapter\n");
> > -		goto err_free_irq;
> > +		goto err_mem_ioremap;
>
>    Ditto...
>
> WBR, Sergei
>
> --
> To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>

Re: [PATCH 6/6] i2c: davinci: use devm_ functions

[Julia Lawall]

From: Julia Lawall <Julia.Lawall@lip6.fr>

The various devm_ functions allocate memory that is released when a driver
detaches.  This patch uses these functions for data that is allocated in
the probe function of a platform device and is only freed in the remove
function.

The call to platform_get_resource is moved down to the call to
devm_request_and_ioremap that uses it.

Signed-off-by: Julia Lawall <Julia.Lawall@lip6.fr>

---
Not compiled.
I was not sure what to do with the comment on the first line, so I just
left it where it is.
I was also concerned about the calls to get_device and put_device, and
whether they would cause &pdev->dev to be freed before the devm-allocated
objects were freed.  Most other platform drivers don't seem to have these
calls.

v2: deleted the now unused ioarea variable and changed some label names to
be more meaningful.

  drivers/i2c/busses/i2c-davinci.c |   53 +++++++++------------------------------
  1 file changed, 13 insertions(+), 40 deletions(-)


diff --git a/drivers/i2c/busses/i2c-davinci.c b/drivers/i2c/busses/i2c-davinci.c
index b6185dc..30afa7c 100644
--- a/drivers/i2c/busses/i2c-davinci.c
+++ b/drivers/i2c/busses/i2c-davinci.c
@@ -643,34 +643,20 @@ static int davinci_i2c_probe(struct platform_device *pdev)
  {
  	struct davinci_i2c_dev *dev;
  	struct i2c_adapter *adap;
-	struct resource *mem, *irq, *ioarea;
+	struct resource *mem, *irq;
  	int r;

  	/* NOTE: driver uses the static register mapping */
-	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-	if (!mem) {
-		dev_err(&pdev->dev, "no mem resource?\n");
-		return -ENODEV;
-	}
-
  	irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
  	if (!irq) {
  		dev_err(&pdev->dev, "no irq resource?\n");
  		return -ENODEV;
  	}

-	ioarea = request_mem_region(mem->start, resource_size(mem),
-				    pdev->name);
-	if (!ioarea) {
-		dev_err(&pdev->dev, "I2C region already claimed\n");
-		return -EBUSY;
-	}
-
-	dev = kzalloc(sizeof(struct davinci_i2c_dev), GFP_KERNEL);
-	if (!dev) {
-		r = -ENOMEM;
-		goto err_release_region;
-	}
+	dev = devm_kzalloc(&pdev->dev, sizeof(struct davinci_i2c_dev),
+			   GFP_KERNEL);
+	if (!dev)
+		return -ENOMEM;

  	init_completion(&dev->cmd_complete);
  #ifdef CONFIG_CPU_FREQ
@@ -699,22 +685,24 @@ static int davinci_i2c_probe(struct platform_device *pdev)
  		dev->pdata = &davinci_i2c_platform_data_default;
  	}

-	dev->clk = clk_get(&pdev->dev, NULL);
+	dev->clk = devm_clk_get(&pdev->dev, NULL);
  	if (IS_ERR(dev->clk)) {
  		r = -ENODEV;
  		goto err_free_mem;
  	}
  	clk_enable(dev->clk);

-	dev->base = ioremap(mem->start, resource_size(mem));
+	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	dev->base = devm_request_and_ioremap(&pdev->dev, mem);
  	if (!dev->base) {
  		r = -EBUSY;
-		goto err_mem_ioremap;
+		goto err_unuse_clocks;
  	}

  	i2c_davinci_init(dev);

-	r = request_irq(dev->irq, i2c_davinci_isr, 0, pdev->name, dev);
+	r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
+			     pdev->name, dev);
  	if (r) {
  		dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
  		goto err_unuse_clocks;
@@ -723,7 +711,7 @@ static int davinci_i2c_probe(struct platform_device *pdev)
  	r = i2c_davinci_cpufreq_register(dev);
  	if (r) {
  		dev_err(&pdev->dev, "failed to register cpufreq\n");
-		goto err_free_irq;
+		goto err_unuse_clocks;
  	}

  	adap = &dev->adapter;
@@ -740,26 +728,18 @@ static int davinci_i2c_probe(struct platform_device *pdev)
  	r = i2c_add_numbered_adapter(adap);
  	if (r) {
  		dev_err(&pdev->dev, "failure adding adapter\n");
-		goto err_free_irq;
+		goto err_unuse_clocks;
  	}
  	of_i2c_register_devices(adap);

  	return 0;

-err_free_irq:
-	free_irq(dev->irq, dev);
  err_unuse_clocks:
-	iounmap(dev->base);
-err_mem_ioremap:
  	clk_disable(dev->clk);
-	clk_put(dev->clk);
  	dev->clk = NULL;
  err_free_mem:
  	platform_set_drvdata(pdev, NULL);
  	put_device(&pdev->dev);
-	kfree(dev);
-err_release_region:
-	release_mem_region(mem->start, resource_size(mem));

  	return r;
  }
@@ -767,7 +747,6 @@ err_release_region:
  static int davinci_i2c_remove(struct platform_device *pdev)
  {
  	struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
-	struct resource *mem;

  	i2c_davinci_cpufreq_deregister(dev);

@@ -776,16 +755,10 @@ static int davinci_i2c_remove(struct platform_device *pdev)
  	put_device(&pdev->dev);

  	clk_disable(dev->clk);
-	clk_put(dev->clk);
  	dev->clk = NULL;

  	davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
-	free_irq(dev->irq, dev);
-	iounmap(dev->base);
-	kfree(dev);

-	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-	release_mem_region(mem->start, resource_size(mem));
  	return 0;
  }