2021-12-21 23:58:57

by David E. Box

[permalink] [raw]
Subject: [PATCH 0/4] driver_core: Auxiliary drvdata helper cleanup

Depends on "driver core: auxiliary bus: Add driver data helpers" patch [1].
Applies the helpers to all auxiliary device drivers using
dev_(get/set)_drvdata. Drivers were found using the following search:

grep -lr "struct auxiliary_device" $(grep -lr "drvdata" .)

Changes were build tested using the following configs:

vdpa/mlx5: CONFIG_MLX5_VDPA_NET
net/mlx53: CONFIG_MLX5_CORE_EN
soundwire/intel: CONFIG_SOUNDWIRE_INTEL
RDAM/irdma: CONFIG_INFINIBAND_IRDMA
CONFIG_MLX5_INFINIBAND

[1] https://www.spinics.net/lists/platform-driver-x86/msg29940.html

David E. Box (4):
RDMA/irdma: Use auxiliary_device driver data helpers
soundwire: intel: Use auxiliary_device driver data helpers
net/mlx5e: Use auxiliary_device driver data helpers
vdpa/mlx5: Use auxiliary_device driver data helpers

drivers/infiniband/hw/irdma/main.c | 4 ++--
drivers/infiniband/hw/mlx5/main.c | 8 ++++----
drivers/net/ethernet/mellanox/mlx5/core/en_main.c | 8 ++++----
drivers/soundwire/intel.c | 8 ++++----
drivers/soundwire/intel_init.c | 2 +-
drivers/vdpa/mlx5/net/mlx5_vnet.c | 4 ++--
6 files changed, 17 insertions(+), 17 deletions(-)

--
2.25.1



2021-12-21 23:58:58

by David E. Box

[permalink] [raw]
Subject: [PATCH 2/4] soundwire: intel: Use auxiliary_device driver data helpers

Use auxiliary_get_drvdata and auxiliary_set_drvdata helpers.

Signed-off-by: David E. Box <[email protected]>
---
drivers/soundwire/intel.c | 8 ++++----
drivers/soundwire/intel_init.c | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/soundwire/intel.c b/drivers/soundwire/intel.c
index 78037ffdb09b..d082d18e41a9 100644
--- a/drivers/soundwire/intel.c
+++ b/drivers/soundwire/intel.c
@@ -1293,7 +1293,7 @@ static int intel_link_probe(struct auxiliary_device *auxdev,
bus->ops = &sdw_intel_ops;

/* set driver data, accessed by snd_soc_dai_get_drvdata() */
- dev_set_drvdata(dev, cdns);
+ auxiliary_set_drvdata(auxdev, cdns);

/* use generic bandwidth allocation algorithm */
sdw->cdns.bus.compute_params = sdw_compute_params;
@@ -1321,7 +1321,7 @@ int intel_link_startup(struct auxiliary_device *auxdev)
{
struct sdw_cdns_stream_config config;
struct device *dev = &auxdev->dev;
- struct sdw_cdns *cdns = dev_get_drvdata(dev);
+ struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
struct sdw_intel *sdw = cdns_to_intel(cdns);
struct sdw_bus *bus = &cdns->bus;
int link_flags;
@@ -1463,7 +1463,7 @@ int intel_link_startup(struct auxiliary_device *auxdev)
static void intel_link_remove(struct auxiliary_device *auxdev)
{
struct device *dev = &auxdev->dev;
- struct sdw_cdns *cdns = dev_get_drvdata(dev);
+ struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
struct sdw_intel *sdw = cdns_to_intel(cdns);
struct sdw_bus *bus = &cdns->bus;

@@ -1488,7 +1488,7 @@ int intel_link_process_wakeen_event(struct auxiliary_device *auxdev)
void __iomem *shim;
u16 wake_sts;

- sdw = dev_get_drvdata(dev);
+ sdw = auxiliary_get_drvdata(auxdev);
bus = &sdw->cdns.bus;

if (bus->prop.hw_disabled || !sdw->startup_done) {
diff --git a/drivers/soundwire/intel_init.c b/drivers/soundwire/intel_init.c
index e329022e1669..d99807765dfe 100644
--- a/drivers/soundwire/intel_init.c
+++ b/drivers/soundwire/intel_init.c
@@ -244,7 +244,7 @@ static struct sdw_intel_ctx
goto err;

link = &ldev->link_res;
- link->cdns = dev_get_drvdata(&ldev->auxdev.dev);
+ link->cdns = auxiliary_get_drvdata(&ldev->auxdev);

if (!link->cdns) {
dev_err(&adev->dev, "failed to get link->cdns\n");
--
2.25.1


2021-12-21 23:59:01

by David E. Box

[permalink] [raw]
Subject: [PATCH 4/4] vdpa/mlx5: Use auxiliary_device driver data helpers

Use auxiliary_get_drvdata and auxiliary_set_drvdata helpers.

Signed-off-by: David E. Box <[email protected]>
---
drivers/vdpa/mlx5/net/mlx5_vnet.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/vdpa/mlx5/net/mlx5_vnet.c b/drivers/vdpa/mlx5/net/mlx5_vnet.c
index 63813fbb5f62..cf59f7e17c6d 100644
--- a/drivers/vdpa/mlx5/net/mlx5_vnet.c
+++ b/drivers/vdpa/mlx5/net/mlx5_vnet.c
@@ -2683,7 +2683,7 @@ static int mlx5v_probe(struct auxiliary_device *adev,
if (err)
goto reg_err;

- dev_set_drvdata(&adev->dev, mgtdev);
+ auxiliary_set_drvdata(adev, mgtdev);

return 0;

@@ -2696,7 +2696,7 @@ static void mlx5v_remove(struct auxiliary_device *adev)
{
struct mlx5_vdpa_mgmtdev *mgtdev;

- mgtdev = dev_get_drvdata(&adev->dev);
+ mgtdev = auxiliary_get_drvdata(adev);
vdpa_mgmtdev_unregister(&mgtdev->mgtdev);
kfree(mgtdev);
}
--
2.25.1


2021-12-21 23:59:02

by David E. Box

[permalink] [raw]
Subject: [PATCH 3/4] net/mlx5e: Use auxiliary_device driver data helpers

Use auxiliary_get_drvdata and auxiliary_set_drvdata helpers.

Signed-off-by: David E. Box <[email protected]>
---
drivers/net/ethernet/mellanox/mlx5/core/en_main.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/net/ethernet/mellanox/mlx5/core/en_main.c b/drivers/net/ethernet/mellanox/mlx5/core/en_main.c
index 65571593ec5c..244ce8f4e286 100644
--- a/drivers/net/ethernet/mellanox/mlx5/core/en_main.c
+++ b/drivers/net/ethernet/mellanox/mlx5/core/en_main.c
@@ -5389,7 +5389,7 @@ void mlx5e_destroy_netdev(struct mlx5e_priv *priv)
static int mlx5e_resume(struct auxiliary_device *adev)
{
struct mlx5_adev *edev = container_of(adev, struct mlx5_adev, adev);
- struct mlx5e_priv *priv = dev_get_drvdata(&adev->dev);
+ struct mlx5e_priv *priv = auxiliary_get_drvdata(adev);
struct net_device *netdev = priv->netdev;
struct mlx5_core_dev *mdev = edev->mdev;
int err;
@@ -5412,7 +5412,7 @@ static int mlx5e_resume(struct auxiliary_device *adev)

static int mlx5e_suspend(struct auxiliary_device *adev, pm_message_t state)
{
- struct mlx5e_priv *priv = dev_get_drvdata(&adev->dev);
+ struct mlx5e_priv *priv = auxiliary_get_drvdata(adev);
struct net_device *netdev = priv->netdev;
struct mlx5_core_dev *mdev = priv->mdev;

@@ -5456,7 +5456,7 @@ static int mlx5e_probe(struct auxiliary_device *adev,
mlx5e_build_nic_netdev(netdev);

priv = netdev_priv(netdev);
- dev_set_drvdata(&adev->dev, priv);
+ auxiliary_set_drvdata(adev, priv);

priv->profile = profile;
priv->ppriv = NULL;
@@ -5504,7 +5504,7 @@ static int mlx5e_probe(struct auxiliary_device *adev,

static void mlx5e_remove(struct auxiliary_device *adev)
{
- struct mlx5e_priv *priv = dev_get_drvdata(&adev->dev);
+ struct mlx5e_priv *priv = auxiliary_get_drvdata(adev);
pm_message_t state = {};

mlx5e_dcbnl_delete_app(priv);
--
2.25.1


2021-12-22 00:09:10

by Jason Gunthorpe

[permalink] [raw]
Subject: Re: [PATCH 0/4] driver_core: Auxiliary drvdata helper cleanup

On Tue, Dec 21, 2021 at 03:58:48PM -0800, David E. Box wrote:
> Depends on "driver core: auxiliary bus: Add driver data helpers" patch [1].
> Applies the helpers to all auxiliary device drivers using
> dev_(get/set)_drvdata. Drivers were found using the following search:
>
> grep -lr "struct auxiliary_device" $(grep -lr "drvdata" .)
>
> Changes were build tested using the following configs:
>
> vdpa/mlx5: CONFIG_MLX5_VDPA_NET
> net/mlx53: CONFIG_MLX5_CORE_EN
> soundwire/intel: CONFIG_SOUNDWIRE_INTEL
> RDAM/irdma: CONFIG_INFINIBAND_IRDMA
> CONFIG_MLX5_INFINIBAND
>
> [1] https://www.spinics.net/lists/platform-driver-x86/msg29940.html

I have to say I don't really find this to be a big readability
improvement.

Also, what use is 'to_auxiliary_dev()' ? I didn't see any users added..

Jason

2021-12-22 00:48:22

by David E. Box

[permalink] [raw]
Subject: Re: [PATCH 0/4] driver_core: Auxiliary drvdata helper cleanup

On Tue, 2021-12-21 at 20:09 -0400, Jason Gunthorpe wrote:
> On Tue, Dec 21, 2021 at 03:58:48PM -0800, David E. Box wrote:
> > Depends on "driver core: auxiliary bus: Add driver data helpers" patch [1].
> > Applies the helpers to all auxiliary device drivers using
> > dev_(get/set)_drvdata. Drivers were found using the following search:
> >
> > grep -lr "struct auxiliary_device" $(grep -lr "drvdata" .)
> >
> > Changes were build tested using the following configs:
> >
> > vdpa/mlx5: CONFIG_MLX5_VDPA_NET
> > net/mlx53: CONFIG_MLX5_CORE_EN
> > soundwire/intel: CONFIG_SOUNDWIRE_INTEL
> > RDAM/irdma: CONFIG_INFINIBAND_IRDMA
> > CONFIG_MLX5_INFINIBAND
> >
> > [1] https://www.spinics.net/lists/platform-driver-x86/msg29940.html
>
> I have to say I don't really find this to be a big readability
> improvement.

I should have referenced the thread [1] discussing the benefit of this change
since the question was asked and answered already. The idea is that drivers
shouldn't have to touch the device API directly if they are already using a
higher level core API (auxiliary bus) that can do that on its behalf.

One benefit of this scheme is that it limits the number of places where changes
need to be made if the device core were to change.

[1] https://lore.kernel.org/all/[email protected]/

>
> Also, what use is 'to_auxiliary_dev()' ? I didn't see any users added..

This was not added by that patch.

Thanks

David
>
> Jason


2021-12-22 11:20:58

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH 2/4] soundwire: intel: Use auxiliary_device driver data helpers

On Tue, Dec 21, 2021 at 03:58:50PM -0800, David E. Box wrote:
> Use auxiliary_get_drvdata and auxiliary_set_drvdata helpers.

Reviewed-by: Andy Shevchenko <[email protected]>

> Signed-off-by: David E. Box <[email protected]>
> ---
> drivers/soundwire/intel.c | 8 ++++----
> drivers/soundwire/intel_init.c | 2 +-
> 2 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/soundwire/intel.c b/drivers/soundwire/intel.c
> index 78037ffdb09b..d082d18e41a9 100644
> --- a/drivers/soundwire/intel.c
> +++ b/drivers/soundwire/intel.c
> @@ -1293,7 +1293,7 @@ static int intel_link_probe(struct auxiliary_device *auxdev,
> bus->ops = &sdw_intel_ops;
>
> /* set driver data, accessed by snd_soc_dai_get_drvdata() */
> - dev_set_drvdata(dev, cdns);
> + auxiliary_set_drvdata(auxdev, cdns);
>
> /* use generic bandwidth allocation algorithm */
> sdw->cdns.bus.compute_params = sdw_compute_params;
> @@ -1321,7 +1321,7 @@ int intel_link_startup(struct auxiliary_device *auxdev)
> {
> struct sdw_cdns_stream_config config;
> struct device *dev = &auxdev->dev;
> - struct sdw_cdns *cdns = dev_get_drvdata(dev);
> + struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
> struct sdw_intel *sdw = cdns_to_intel(cdns);
> struct sdw_bus *bus = &cdns->bus;
> int link_flags;
> @@ -1463,7 +1463,7 @@ int intel_link_startup(struct auxiliary_device *auxdev)
> static void intel_link_remove(struct auxiliary_device *auxdev)
> {
> struct device *dev = &auxdev->dev;
> - struct sdw_cdns *cdns = dev_get_drvdata(dev);
> + struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
> struct sdw_intel *sdw = cdns_to_intel(cdns);
> struct sdw_bus *bus = &cdns->bus;
>
> @@ -1488,7 +1488,7 @@ int intel_link_process_wakeen_event(struct auxiliary_device *auxdev)
> void __iomem *shim;
> u16 wake_sts;
>
> - sdw = dev_get_drvdata(dev);
> + sdw = auxiliary_get_drvdata(auxdev);
> bus = &sdw->cdns.bus;
>
> if (bus->prop.hw_disabled || !sdw->startup_done) {
> diff --git a/drivers/soundwire/intel_init.c b/drivers/soundwire/intel_init.c
> index e329022e1669..d99807765dfe 100644
> --- a/drivers/soundwire/intel_init.c
> +++ b/drivers/soundwire/intel_init.c
> @@ -244,7 +244,7 @@ static struct sdw_intel_ctx
> goto err;
>
> link = &ldev->link_res;
> - link->cdns = dev_get_drvdata(&ldev->auxdev.dev);
> + link->cdns = auxiliary_get_drvdata(&ldev->auxdev);
>
> if (!link->cdns) {
> dev_err(&adev->dev, "failed to get link->cdns\n");
> --
> 2.25.1
>

--
With Best Regards,
Andy Shevchenko



2021-12-22 12:34:51

by Cezary Rojewski

[permalink] [raw]
Subject: Re: [PATCH 0/4] driver_core: Auxiliary drvdata helper cleanup

On 2021-12-22 12:58 AM, David E. Box wrote:
> Depends on "driver core: auxiliary bus: Add driver data helpers" patch [1].
> Applies the helpers to all auxiliary device drivers using
> dev_(get/set)_drvdata. Drivers were found using the following search:
>
> grep -lr "struct auxiliary_device" $(grep -lr "drvdata" .)
>
> Changes were build tested using the following configs:
>
> vdpa/mlx5: CONFIG_MLX5_VDPA_NET
> net/mlx53: CONFIG_MLX5_CORE_EN
> soundwire/intel: CONFIG_SOUNDWIRE_INTEL
> RDAM/irdma: CONFIG_INFINIBAND_IRDMA
> CONFIG_MLX5_INFINIBAND
>
> [1] https://www.spinics.net/lists/platform-driver-x86/msg29940.html
>
> David E. Box (4):
> RDMA/irdma: Use auxiliary_device driver data helpers
> soundwire: intel: Use auxiliary_device driver data helpers
> net/mlx5e: Use auxiliary_device driver data helpers
> vdpa/mlx5: Use auxiliary_device driver data helpers
>
> drivers/infiniband/hw/irdma/main.c | 4 ++--
> drivers/infiniband/hw/mlx5/main.c | 8 ++++----
> drivers/net/ethernet/mellanox/mlx5/core/en_main.c | 8 ++++----
> drivers/soundwire/intel.c | 8 ++++----
> drivers/soundwire/intel_init.c | 2 +-
> drivers/vdpa/mlx5/net/mlx5_vnet.c | 4 ++--
> 6 files changed, 17 insertions(+), 17 deletions(-)

Changes look good, I did post one question regarding possible occurrence
of dev_get_drvdata() not being accounted for in patch:
[PATCH 1/4] RDMA/irdma: Use auxiliary_device driver data helpers

However, it does look like a blocker so:

Reviewed-by: Cezary Rojewski <[email protected]>


For the record, I did scan the following files (users of struct
auxiliary_device) from drivers/ directory for the missing occurrences
and found only a single one (as mentioned earlier):

drivers/net/ethernet/mellanox/mlx5/core/dev.c
drivers/net/ethernet/mellanox/mlx5/core/sf/dev/dev.c
drivers/net/ethernet/mellanox/mlx5/core/sf/dev/driver.c
drivers/net/ethernet/mellanox/mlx5/core/sf/dev/dev.h
drivers/net/ethernet/mellanox/mlx5/core/en_rep.c
drivers/net/ethernet/mellanox/mlx5/core/en_main.c
drivers/net/ethernet/intel/i40e/i40e_client.c
drivers/net/ethernet/intel/ice/ice.h
drivers/net/ethernet/intel/ice/ice_idc.c
drivers/infiniband/hw/irdma/main.c
drivers/infiniband/hw/irdma/i40iw_if.c
drivers/infiniband/hw/mlx5/main.c
drivers/infiniband/hw/mlx5/ib_rep.c
drivers/vdpa/mlx5/net/mlx5_vnet.c
drivers/gpu/drm/bridge/ti-sn65dsi86.c
drivers/soundwire/intel_init.c
drivers/soundwire/intel.c


Regards,
Czarek

2021-12-22 17:18:57

by Jason Gunthorpe

[permalink] [raw]
Subject: Re: [PATCH 0/4] driver_core: Auxiliary drvdata helper cleanup

On Tue, Dec 21, 2021 at 04:48:17PM -0800, David E. Box wrote:
> On Tue, 2021-12-21 at 20:09 -0400, Jason Gunthorpe wrote:
> > On Tue, Dec 21, 2021 at 03:58:48PM -0800, David E. Box wrote:
> > > Depends on "driver core: auxiliary bus: Add driver data helpers" patch [1].
> > > Applies the helpers to all auxiliary device drivers using
> > > dev_(get/set)_drvdata. Drivers were found using the following search:
> > >
> > > grep -lr "struct auxiliary_device" $(grep -lr "drvdata" .)
> > >
> > > Changes were build tested using the following configs:
> > >
> > > vdpa/mlx5: CONFIG_MLX5_VDPA_NET
> > > net/mlx53: CONFIG_MLX5_CORE_EN
> > > soundwire/intel: CONFIG_SOUNDWIRE_INTEL
> > > RDAM/irdma: CONFIG_INFINIBAND_IRDMA
> > > CONFIG_MLX5_INFINIBAND
> > >
> > > [1] https://www.spinics.net/lists/platform-driver-x86/msg29940.html
> >
> > I have to say I don't really find this to be a big readability
> > improvement.
>
> I should have referenced the thread [1] discussing the benefit of this change
> since the question was asked and answered already. The idea is that drivers
> shouldn't have to touch the device API directly if they are already using a
> higher level core API (auxiliary bus) that can do that on its behalf.

Driver writers should rarely use the auxilary device type directly, the
should always immediately container_of it to their proper derived
type.

> > Also, what use is 'to_auxiliary_dev()' ? I didn't see any users added..
>
> This was not added by that patch.

It was added by the referenced patch, and seems totally pointless cut
and paste, again because nothing should be using the auxiliary_device
type for anything more than container_of'ing to their own type.

We've been ripping out bus specific APIs in favour of generic ones
(see the work on the DMA API for instance) so this whole concept seems
regressive, particularly when applied to auxiliary bus which does not
have an API of its own.

Jason