2021-12-13 18:00:44

by Andy Shevchenko

[permalink] [raw]
Subject: [PATCH v2 1/6] i2c: designware-pci: Use temporary variable for struct device

Use temporary variable for struct device to make code neater.

Signed-off-by: Andy Shevchenko <[email protected]>
---
v2: dropped dev --> i_dev renaming (Jarkko)
drivers/i2c/busses/i2c-designware-pcidrv.c | 52 +++++++++++-----------
1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/drivers/i2c/busses/i2c-designware-pcidrv.c b/drivers/i2c/busses/i2c-designware-pcidrv.c
index 0f409a4c2da0..5f76010f7dfd 100644
--- a/drivers/i2c/busses/i2c-designware-pcidrv.c
+++ b/drivers/i2c/busses/i2c-designware-pcidrv.c
@@ -207,23 +207,23 @@ static struct dw_pci_controller dw_pci_controllers[] = {
};

#ifdef CONFIG_PM
-static int i2c_dw_pci_suspend(struct device *dev)
+static int i2c_dw_pci_suspend(struct device *d)
{
- struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
+ struct dw_i2c_dev *dev = dev_get_drvdata(d);

- i_dev->suspended = true;
- i_dev->disable(i_dev);
+ dev->suspended = true;
+ dev->disable(dev);

return 0;
}

-static int i2c_dw_pci_resume(struct device *dev)
+static int i2c_dw_pci_resume(struct device *d)
{
- struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
+ struct dw_i2c_dev *dev = dev_get_drvdata(d);
int ret;

- ret = i_dev->init(i_dev);
- i_dev->suspended = false;
+ ret = dev->init(dev);
+ dev->suspended = false;

return ret;
}
@@ -235,6 +235,7 @@ static UNIVERSAL_DEV_PM_OPS(i2c_dw_pm_ops, i2c_dw_pci_suspend,
static int i2c_dw_pci_probe(struct pci_dev *pdev,
const struct pci_device_id *id)
{
+ struct device *d = &pdev->dev;
struct dw_i2c_dev *dev;
struct i2c_adapter *adap;
int r;
@@ -242,8 +243,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
struct dw_scl_sda_cfg *cfg;

if (id->driver_data >= ARRAY_SIZE(dw_pci_controllers)) {
- dev_err(&pdev->dev, "%s: invalid driver data %ld\n", __func__,
- id->driver_data);
+ dev_err(d, "%s: invalid driver data %ld\n", __func__, id->driver_data);
return -EINVAL;
}

@@ -251,8 +251,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,

r = pcim_enable_device(pdev);
if (r) {
- dev_err(&pdev->dev, "Failed to enable I2C PCI device (%d)\n",
- r);
+ dev_err(d, "Failed to enable I2C PCI device (%d)\n", r);
return r;
}

@@ -260,11 +259,11 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,

r = pcim_iomap_regions(pdev, 1 << 0, pci_name(pdev));
if (r) {
- dev_err(&pdev->dev, "I/O memory remapping failed\n");
+ dev_err(d, "I/O memory remapping failed\n");
return r;
}

- dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
+ dev = devm_kzalloc(d, sizeof(*dev), GFP_KERNEL);
if (!dev)
return -ENOMEM;

@@ -275,7 +274,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
dev->get_clk_rate_khz = controller->get_clk_rate_khz;
dev->timings.bus_freq_hz = I2C_MAX_FAST_MODE_FREQ;
dev->base = pcim_iomap_table(pdev)[0];
- dev->dev = &pdev->dev;
+ dev->dev = d;
dev->irq = pci_irq_vector(pdev, 0);
dev->flags |= controller->flags;

@@ -291,8 +290,8 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,

i2c_dw_adjust_bus_speed(dev);

- if (has_acpi_companion(&pdev->dev))
- i2c_dw_acpi_configure(&pdev->dev);
+ if (has_acpi_companion(d))
+ i2c_dw_acpi_configure(d);

r = i2c_dw_validate_speed(dev);
if (r) {
@@ -314,7 +313,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
adap = &dev->adapter;
adap->owner = THIS_MODULE;
adap->class = 0;
- ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
+ ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(d));
adap->nr = controller->bus_num;

r = i2c_dw_probe(dev);
@@ -326,15 +325,15 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
if ((dev->flags & MODEL_MASK) == MODEL_AMD_NAVI_GPU) {
r = navi_amd_register_client(dev);
if (r) {
- dev_err(dev->dev, "register client failed with %d\n", r);
+ dev_err(d, "register client failed with %d\n", r);
return r;
}
}

- pm_runtime_set_autosuspend_delay(&pdev->dev, 1000);
- pm_runtime_use_autosuspend(&pdev->dev);
- pm_runtime_put_autosuspend(&pdev->dev);
- pm_runtime_allow(&pdev->dev);
+ pm_runtime_set_autosuspend_delay(d, 1000);
+ pm_runtime_use_autosuspend(d);
+ pm_runtime_put_autosuspend(d);
+ pm_runtime_allow(d);

return 0;
}
@@ -342,13 +341,14 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
static void i2c_dw_pci_remove(struct pci_dev *pdev)
{
struct dw_i2c_dev *dev = pci_get_drvdata(pdev);
+ struct device *d = &pdev->dev;

dev->disable(dev);
- pm_runtime_forbid(&pdev->dev);
- pm_runtime_get_noresume(&pdev->dev);
+ pm_runtime_forbid(d);
+ pm_runtime_get_noresume(d);

i2c_del_adapter(&dev->adapter);
- devm_free_irq(&pdev->dev, dev->irq, dev);
+ devm_free_irq(d, dev->irq, dev);
pci_free_irq_vectors(pdev);
}

--
2.33.0



2021-12-13 18:00:45

by Andy Shevchenko

[permalink] [raw]
Subject: [PATCH v2 6/6] i2c: designware-pci: Add a note about struct dw_scl_sda_cfg usage

Add a note about struct dw_scl_sda_cfg usage to discourage people
of using this structure on new platforms. Instead they should try
hard to put the needed information into firmware descriptions.

Signed-off-by: Andy Shevchenko <[email protected]>
Acked-by: Jarkko Nikula <[email protected]>
---
v2: added tag (Jarkko)

drivers/i2c/busses/i2c-designware-pcidrv.c | 7 +++++++
1 file changed, 7 insertions(+)

diff --git a/drivers/i2c/busses/i2c-designware-pcidrv.c b/drivers/i2c/busses/i2c-designware-pcidrv.c
index bc19d7f59d31..0ae3bbe8ed4e 100644
--- a/drivers/i2c/busses/i2c-designware-pcidrv.c
+++ b/drivers/i2c/busses/i2c-designware-pcidrv.c
@@ -38,6 +38,13 @@ enum dw_pci_ctl_id_t {
navi_amd,
};

+/*
+ * This is a legacy structure to describe the hardware counters
+ * to configure signal timings on the bus. For Device Tree platforms
+ * one should use the respective properties and for ACPI there is
+ * a set of ACPI methods that provide these counters. No new
+ * platform should use this structure.
+ */
struct dw_scl_sda_cfg {
u16 ss_hcnt;
u16 fs_hcnt;
--
2.33.0


2021-12-13 18:00:52

by Andy Shevchenko

[permalink] [raw]
Subject: [PATCH v2 5/6] i2c: designware-pci: Group MODULE_*() macros

For better maintenance group MODULE_*() macros together.

Signed-off-by: Andy Shevchenko <[email protected]>
Acked-by: Jarkko Nikula <[email protected]>
---
v2: added tag (Jarkko)

drivers/i2c/busses/i2c-designware-pcidrv.c | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/i2c/busses/i2c-designware-pcidrv.c b/drivers/i2c/busses/i2c-designware-pcidrv.c
index 499970d70755..bc19d7f59d31 100644
--- a/drivers/i2c/busses/i2c-designware-pcidrv.c
+++ b/drivers/i2c/busses/i2c-designware-pcidrv.c
@@ -344,9 +344,6 @@ static void i2c_dw_pci_remove(struct pci_dev *pdev)
pci_free_irq_vectors(pdev);
}

-/* work with hotplug and coldplug */
-MODULE_ALIAS("i2c_designware-pci");
-
static const struct pci_device_id i2_designware_pci_ids[] = {
/* Medfield */
{ PCI_VDEVICE(INTEL, 0x0817), medfield },
@@ -403,9 +400,11 @@ static struct pci_driver dw_i2c_driver = {
.pm = &i2c_dw_pm_ops,
},
};
-
module_pci_driver(dw_i2c_driver);

+/* Work with hotplug and coldplug */
+MODULE_ALIAS("i2c_designware-pci");
+
MODULE_AUTHOR("Baruch Siach <[email protected]>");
MODULE_DESCRIPTION("Synopsys DesignWare PCI I2C bus adapter");
MODULE_LICENSE("GPL");
--
2.33.0


2021-12-15 07:51:15

by Jarkko Nikula

[permalink] [raw]
Subject: Re: [PATCH v2 1/6] i2c: designware-pci: Use temporary variable for struct device

On 12/13/21 20:00, Andy Shevchenko wrote:
> Use temporary variable for struct device to make code neater.
>
> Signed-off-by: Andy Shevchenko <[email protected]>
> ---
> v2: dropped dev --> i_dev renaming (Jarkko)
> drivers/i2c/busses/i2c-designware-pcidrv.c | 52 +++++++++++-----------
> 1 file changed, 26 insertions(+), 26 deletions(-)
>
> diff --git a/drivers/i2c/busses/i2c-designware-pcidrv.c b/drivers/i2c/busses/i2c-designware-pcidrv.c
> index 0f409a4c2da0..5f76010f7dfd 100644
> --- a/drivers/i2c/busses/i2c-designware-pcidrv.c
> +++ b/drivers/i2c/busses/i2c-designware-pcidrv.c
> @@ -207,23 +207,23 @@ static struct dw_pci_controller dw_pci_controllers[] = {
> };
>
> #ifdef CONFIG_PM
> -static int i2c_dw_pci_suspend(struct device *dev)
> +static int i2c_dw_pci_suspend(struct device *d)
> {
> - struct dw_i2c_dev *i_dev = dev_get_drvdata(dev);
> + struct dw_i2c_dev *dev = dev_get_drvdata(d);
> >
> - dev = devm_kzalloc(&pdev->dev, sizeof(struct dw_i2c_dev), GFP_KERNEL);
> + dev = devm_kzalloc(d, sizeof(*dev), GFP_KERNEL);
Ditto.

> - i_dev->suspended = true;
> - i_dev->disable(i_dev);
> + dev->suspended = true;
> + dev->disable(dev);
>
In my opinion this brings more mess than removes. If I see
dev->something I'll immediatelly think "struct device" and get confused.
x_dev->something or dev_y->something not so much. And this change adds
in my opinion more confusion than removes.

> if (id->driver_data >= ARRAY_SIZE(dw_pci_controllers)) {
> - dev_err(&pdev->dev, "%s: invalid driver data %ld\n", __func__,
> - id->driver_data);
> + dev_err(d, "%s: invalid driver data %ld\n", __func__, id->driver_data);
> return -EINVAL;

Honestly, what's is the value of this change? Yet another differently
named "device" pointer more to the mess (Inconsistent naming use of
struct dw_i2c_dev *dev, struct dw_i2c_dev *i_dev and struct device *dev
in the i2c-designware-*).

Jarkko

2021-12-15 13:49:53

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH v2 1/6] i2c: designware-pci: Use temporary variable for struct device

On Wed, Dec 15, 2021 at 09:51:10AM +0200, Jarkko Nikula wrote:
> On 12/13/21 20:00, Andy Shevchenko wrote:
> > Use temporary variable for struct device to make code neater.

...

> > + dev->suspended = true;
> > + dev->disable(dev);
> In my opinion this brings more mess than removes. If I see dev->something
> I'll immediatelly think "struct device" and get confused. x_dev->something
> or dev_y->something not so much. And this change adds in my opinion more
> confusion than removes.

Either way it will be inconsistent. If you wish to fix, I can build something
on top of your fix, but currently I drop this patch.

> > if (id->driver_data >= ARRAY_SIZE(dw_pci_controllers)) {
> > - dev_err(&pdev->dev, "%s: invalid driver data %ld\n", __func__,
> > - id->driver_data);
> > + dev_err(d, "%s: invalid driver data %ld\n", __func__, id->driver_data);
> > return -EINVAL;
>
> Honestly, what's is the value of this change?

What is the value of the changes in general? :-)

> Yet another differently named
> "device" pointer more to the mess (Inconsistent naming use of struct
> dw_i2c_dev *dev, struct dw_i2c_dev *i_dev and struct device *dev in the
> i2c-designware-*).

As I said, please fix this inconsistency yourself how you find it better
and I will use that in the future contributions.

--
With Best Regards,
Andy Shevchenko



2021-12-15 13:59:53

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH v2 1/6] i2c: designware-pci: Use temporary variable for struct device

On Mon, Dec 13, 2021 at 08:00:29PM +0200, Andy Shevchenko wrote:
> Use temporary variable for struct device to make code neater.

Jarkko, thanks for review, but I have to postpone this and UCSI series
due to lack of time. It seems it requires more work than I expected.
Feel free to incorporate individual patches to your own submissions
regarding to this driver.

--
With Best Regards,
Andy Shevchenko



2021-12-15 14:15:52

by Jarkko Nikula

[permalink] [raw]
Subject: Re: [PATCH v2 1/6] i2c: designware-pci: Use temporary variable for struct device

On 12/15/21 15:48, Andy Shevchenko wrote:
>> Yet another differently named
>> "device" pointer more to the mess (Inconsistent naming use of struct
>> dw_i2c_dev *dev, struct dw_i2c_dev *i_dev and struct device *dev in the
>> i2c-designware-*).
>
> As I said, please fix this inconsistency yourself how you find it better
> and I will use that in the future contributions.
>
I've been saving it for some new comer who is looking for first kernel
contribution tasks :-)

Jarkko