gpio: ml-ioh: Convert to use managed functions pcim* and devm_*
Subsystems (2)
PATCH v3 1/1 gpio: ml-ioh: Convert to use managed functions pcim* and devm_*
When removing the module, we will get the following flaw:
[ 14.204955] remove_proc_entry: removing non-empty directory 'irq/21', leaking at least 'gpio_ml_ioh' [ 14.205827] WARNING: CPU: 0 PID: 305 at fs/proc/generic.c:717 remove_proc_entry+0x389/0x3f0 ... [ 14.220613] ioh_gpio_remove+0xc5/0xe0 [gpio_ml_ioh] [ 14.221075] pci_device_remove+0x92/0x240
Fix this by using managed functions, this makes the error handling more simpler.
--- drivers/gpio/gpio-ml-ioh.c | 76 ++++++++------------------------------ 1 file changed, 16 insertions(+), 60 deletions(-)
drivers/gpio/gpio-ml-ioh.c +16 -60
@@ -409,29 +409,27 @@ static int ioh_gpio_probe(struct pci_dev *pdev,void *chip_save;int irq_base; - ret =pci_enable_device (pdev); + ret =pcim_enable_device (pdev);if (ret) { -dev_err (dev,"%s : pci_enable_device failed" , __func__); - goto err_pci_enable; +dev_err (dev,"%s : pcim_enable_device failed" , __func__); +return ret; } - ret =pci_request_regions (pdev,KBUILD_MODNAME ); + ret =pcim_iomap_regions (pdev,BIT (1 ),KBUILD_MODNAME );if (ret) { -dev_err (dev,"pci_request_regions failed-%d" , ret); - goto err_request_regions; +dev_err (dev,"pcim_iomap_regions failed-%d" , ret); +return ret; } - base =pci_iomap (pdev,1 ,0 ); + base =pcim_iomap_table (pdev)[1 ];if (!base) { -dev_err (dev,"%s : pci_iomap failed" , __func__); - ret = -ENOMEM ; - goto err_iomap; +dev_err (dev,"%s : pcim_iomap_table failed" , __func__); +return -ENOMEM ; } - chip_save =kcalloc (8 ,sizeof (*chip),GFP_KERNEL ); + chip_save =devm_kcalloc (dev,8 ,sizeof (*chip),GFP_KERNEL );if (chip_save ==NULL ) { - ret = -ENOMEM ; - goto err_kzalloc; +return -ENOMEM ; } chip = chip_save;
@@ -442,10 +440,10 @@ static int ioh_gpio_probe(struct pci_dev *pdev, chip->ch = i;spin_lock_init (&chip->spinlock);ioh_gpio_setup (chip, num_ports[i]); - ret =gpiochip_add_data (&chip->gpio, chip); + ret =devm_gpiochip_add_data (dev, &chip->gpio, chip);if (ret) {dev_err (dev,"IOH gpio: Failed to register GPIO\n" ); - goto err_gpiochip_add; +return ret; } }
@@ -456,15 +454,14 @@ static int ioh_gpio_probe(struct pci_dev *pdev,if (irq_base <0 ) {dev_warn (dev,"ml_ioh_gpio: Failed to get IRQ base num\n" ); - ret = irq_base; - goto err_gpiochip_add; +return irq_base; } chip->irq_base = irq_base; ret =ioh_gpio_alloc_generic_chip (chip, irq_base, num_ports[j]);if (ret) - goto err_gpiochip_add; +return ret; } chip = chip_save;
@@ -472,52 +469,12 @@ static int ioh_gpio_probe(struct pci_dev *pdev, IRQF_SHARED, KBUILD_MODNAME, chip);if (ret !=0 ) {dev_err (dev,"%s request_irq failed\n" , __func__); - goto err_gpiochip_add; +return ret; }pci_set_drvdata (pdev, chip);return 0 ; - -err_gpiochip_add: - chip = chip_save; -while (--i >=0 ) { -gpiochip_remove (&chip->gpio); - chip++; - } -kfree (chip_save); - -err_kzalloc: -pci_iounmap (pdev, base); - -err_iomap: -pci_release_regions (pdev); - -err_request_regions: -pci_disable_device (pdev); - -err_pci_enable: - -dev_err (dev,"%s Failed returns %d\n" , __func__, ret); -return ret; -} - -static void ioh_gpio_remove (struct pci_dev *pdev) -{ -int i; -struct ioh_gpio *chip =pci_get_drvdata (pdev); -void *chip_save; - - chip_save = chip; - -for (i =0 ; i <8 ; i++, chip++) -gpiochip_remove (&chip->gpio); - - chip = chip_save; -pci_iounmap (pdev, chip->base); -pci_release_regions (pdev); -pci_disable_device (pdev); -kfree (chip); }static int __maybe_unused ioh_gpio_suspend (struct device *dev)
@@ -558,7 +515,6 @@ static struct pci_driver ioh_gpio_driver = { .name = "ml_ioh_gpio", .id_table = ioh_gpio_pcidev_id, .probe = ioh_gpio_probe, - .remove = ioh_gpio_remove, .driver = { .pm = &ioh_gpio_pm_ops, },
Signature · 1 line
2.36.1
Quoted 157 lines · Zheyu Ma
When removing the module, we will get the following flaw:
[ 14.204955] remove_proc_entry: removing non-empty directory 'irq/21', leaking at least 'gpio_ml_ioh' [ 14.205827] WARNING: CPU: 0 PID: 305 at fs/proc/generic.c:717 remove_proc_entry+0x389/0x3f0 ... [ 14.220613] ioh_gpio_remove+0xc5/0xe0 [gpio_ml_ioh] [ 14.221075] pci_device_remove+0x92/0x240Fix this by using managed functions, this makes the error handling more simpler.
Fixes e971ac9a564a ("gpio: ml-ioh: use resource management for irqs")Signed-off-by Zheyu Ma <[email protected]>--- drivers/gpio/gpio-ml-ioh.c | 76 ++++++++------------------------------ 1 file changed, 16 insertions(+), 60 deletions(-)drivers/gpio/gpio-ml-ioh.c +16
-61@@ -409,29 +409,27 @@ static int ioh_gpio_probe(struct pci_dev *pdev,void *chip_save;int irq_base; - ret =pci_enable_device (pdev); + ret =pcim_enable_device (pdev);if (ret) { -dev_err (dev,"%s : pci_enable_device failed" , __func__); - goto err_pci_enable; +dev_err (dev,"%s : pcim_enable_device failed" , __func__); +return ret; } - ret =pci_request_regions (pdev,KBUILD_MODNAME ); + ret =pcim_iomap_regions (pdev,BIT (1 ),KBUILD_MODNAME );if (ret) { -dev_err (dev,"pci_request_regions failed-%d" , ret); - goto err_request_regions; +dev_err (dev,"pcim_iomap_regions failed-%d" , ret); +return ret; } - base =pci_iomap (pdev,1 ,0 ); + base =pcim_iomap_table (pdev)[1 ];if (!base) { -dev_err (dev,"%s : pci_iomap failed" , __func__); - ret = -ENOMEM ; - goto err_iomap; +dev_err (dev,"%s : pcim_iomap_table failed" , __func__); +return -ENOMEM ; } - chip_save =kcalloc (8 ,sizeof (*chip),GFP_KERNEL ); + chip_save =devm_kcalloc (dev,8 ,sizeof (*chip),GFP_KERNEL );if (chip_save ==NULL ) { - ret = -ENOMEM ; - goto err_kzalloc; +return -ENOMEM ; } chip = chip_save;@@ -442,10 +440,10 @@ static int ioh_gpio_probe(struct pci_dev *pdev, chip->ch = i;spin_lock_init (&chip->spinlock);ioh_gpio_setup (chip, num_ports[i]); - ret =gpiochip_add_data (&chip->gpio, chip); + ret =devm_gpiochip_add_data (dev, &chip->gpio, chip);if (ret) {dev_err (dev,"IOH gpio: Failed to register GPIO\n" ); - goto err_gpiochip_add; +return ret; } }@@ -456,15 +454,14 @@ static int ioh_gpio_probe(struct pci_dev *pdev,if (irq_base <0 ) {dev_warn (dev,"ml_ioh_gpio: Failed to get IRQ base num\n" ); - ret = irq_base; - goto err_gpiochip_add; +return irq_base; } chip->irq_base = irq_base; ret =ioh_gpio_alloc_generic_chip (chip, irq_base, num_ports[j]);if (ret) - goto err_gpiochip_add; +return ret; } chip = chip_save;@@ -472,52 +469,12 @@ static int ioh_gpio_probe(struct pci_dev *pdev, IRQF_SHARED, KBUILD_MODNAME, chip);if (ret !=0 ) {dev_err (dev,"%s request_irq failed\n" , __func__); - goto err_gpiochip_add; +return ret; }pci_set_drvdata (pdev, chip);return 0 ; - -err_gpiochip_add: - chip = chip_save; -while (--i >=0 ) { -gpiochip_remove (&chip->gpio); - chip++; - } -kfree (chip_save); - -err_kzalloc: -pci_iounmap (pdev, base); - -err_iomap: -pci_release_regions (pdev); - -err_request_regions: -pci_disable_device (pdev); - -err_pci_enable: - -dev_err (dev,"%s Failed returns %d\n" , __func__, ret); -return ret; -} - -static void ioh_gpio_remove (struct pci_dev *pdev) -{ -int i; -struct ioh_gpio *chip =pci_get_drvdata (pdev); -void *chip_save; - - chip_save = chip; - -for (i =0 ; i <8 ; i++, chip++) -gpiochip_remove (&chip->gpio); - - chip = chip_save; -pci_iounmap (pdev, chip->base); -pci_release_regions (pdev); -pci_disable_device (pdev); -kfree (chip); }static int __maybe_unused ioh_gpio_suspend (struct device *dev)@@ -558,7 +515,6 @@ static struct pci_driver ioh_gpio_driver = { .name = "ml_ioh_gpio", .id_table = ioh_gpio_pcidev_id, .probe = ioh_gpio_probe, - .remove = ioh_gpio_remove, .driver = { .pm = &ioh_gpio_pm_ops, }, --
Quoted 2 lines
2.36.1
Looks so much better now, gotta love devres. :)
If Andy takes it through his tree:
Otherwise let me know, I can pick it up myself too.
Bart
Quoted 17 lines · Bartosz Golaszewski
Quoted 9 lines · Zheyu Ma
When removing the module, we will get the following flaw:
[ 14.204955] remove_proc_entry: removing non-empty directory 'irq/21', leaking at least 'gpio_ml_ioh' [ 14.205827] WARNING: CPU: 0 PID: 305 at fs/proc/generic.c:717 remove_proc_entry+0x389/0x3f0 ... [ 14.220613] ioh_gpio_remove+0xc5/0xe0 [gpio_ml_ioh] [ 14.221075] pci_device_remove+0x92/0x240Quoted 4 lines
Fix this by using managed functions, this makes the error handling more simpler.
Fixes e971ac9a564a ("gpio: ml-ioh: use resource management for irqs")
Quoted 7 lines
Looks so much better now, gotta love devres. :)
If Andy takes it through his tree:
Reviewed-by Bartosz Golaszewski <[email protected]>Otherwise let me know, I can pick it up myself too.
It's too late in the cycle, I don't believe I have time to pick this up. Go ahead to proceed it!
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 11 lines · Zheyu Ma
When removing the module, we will get the following flaw:
[ 14.204955] remove_proc_entry: removing non-empty directory 'irq/21', leaking at least 'gpio_ml_ioh' [ 14.205827] WARNING: CPU: 0 PID: 305 at fs/proc/generic.c:717 remove_proc_entry+0x389/0x3f0 ... [ 14.220613] ioh_gpio_remove+0xc5/0xe0 [gpio_ml_ioh] [ 14.221075] pci_device_remove+0x92/0x240Fix this by using managed functions, this makes the error handling more simpler.
Thanks!
I have a few comments, but they are not critical, so either a followup or new version depends on Bart's preferences.
...
drivers/gpio/gpio-ml-ioh.c static int ioh_gpio_probe(struct pci_dev *pdev, · line 415
Quoted 7 lines
drivers/gpio/gpio-ml-ioh.c +3
-3- ret =pci_enable_device (pdev); + ret =pcim_enable_device (pdev);if (ret) { -dev_err (dev,"%s : pci_enable_device failed" , __func__); - goto err_pci_enable; +dev_err (dev,"%s : pcim_enable_device failed" , __func__); +return ret;
Since you touch them both, we may convert to return dev_err_probe(...); pattern here and elsewhere. But it might be better to have in the followup as logically different change.
Quoted 1 line
}
...
drivers/gpio/gpio-ml-ioh.c static int ioh_gpio_probe(struct pci_dev *pdev, · line 428
Quoted 10 lines
drivers/gpio/gpio-ml-ioh.c +3
-4- base =pci_iomap (pdev,1 ,0 ); + base =pcim_iomap_table (pdev)[1 ];if (!base) { -dev_err (dev,"%s : pci_iomap failed" , __func__); - ret = -ENOMEM ; - goto err_iomap; +dev_err (dev,"%s : pcim_iomap_table failed" , __func__); +return -ENOMEM ; }
These lines are dead code since you already checked pcim_ioremap_regions(). If it doesn't fail, this one never fails.
...
drivers/gpio/gpio-ml-ioh.c static int ioh_gpio_probe(struct pci_dev *pdev, · line 433
Quoted 8 lines
drivers/gpio/gpio-ml-ioh.c +2
-3- chip_save =kcalloc (8 ,sizeof (*chip),GFP_KERNEL ); + chip_save =devm_kcalloc (dev,8 ,sizeof (*chip),GFP_KERNEL );if (chip_save ==NULL ) { - ret = -ENOMEM ; - goto err_kzalloc; +return -ENOMEM ; }
The {} are redundant now and the ' == NULL' part can be replaced by '!'.
...
Quoted 4 lines
if (irq_base < 0) {
dev_warn(dev,
"ml_ioh_gpio: Failed to get IRQ base num\n");This should be dev_err(), but you may convert it altogether to return dev_err_probe(...); in the respective patch.
Quoted 12 lines
drivers/gpio/gpio-ml-ioh.c +2
-3- ret = irq_base; - goto err_gpiochip_add; +return irq_base; } chip->irq_base = irq_base; ret =ioh_gpio_alloc_generic_chip (chip, irq_base, num_ports[j]);if (ret) - goto err_gpiochip_add; +return ret; }
...
Quoted 1 line
if (ret != 0) {Also in a separate patch you may replace all this kind of lines;
if (chip == NULL) ==> if (!chip)
if (ret != 0) ==> if (ret)
Review
Quoted 3 lines
dev_err(dev, "%s request_irq failed\n", __func__);(quoted diff) +1
-1- goto err_gpiochip_add; + return ret;
return dev_err_probe(...);
But here it's definitely in a separate patch.
Quoted 1 line
}
Signature · 2 lines
With Best Regards, Andy Shevchenko
Bartosz Golaszewski
AppliedQuoted 9 lines · Zheyu Ma
When removing the module, we will get the following flaw:
[ 14.204955] remove_proc_entry: removing non-empty directory 'irq/21', leaking at least 'gpio_ml_ioh' [ 14.205827] WARNING: CPU: 0 PID: 305 at fs/proc/generic.c:717 remove_proc_entry+0x389/0x3f0 ... [ 14.220613] ioh_gpio_remove+0xc5/0xe0 [gpio_ml_ioh] [ 14.221075] pci_device_remove+0x92/0x240
Quoted 6 lines
Fix this by using managed functions, this makes the error handling more simpler.
Fixes e971ac9a564a ("gpio: ml-ioh: use resource management for irqs")Signed-off-by Zheyu Ma <[email protected]>---
Applied, thanks!
Bart