[00/13] drivers: Introduce generic device lookup helpers

Message

Suzuki K Poulose June 5, 2019, 3:13 p.m. UTC

We have device iterators to find a particular device matching a criteria
for a given bus/class/driver. i.e, {bus,class,driver}_find_device() APIs.
The matching criteria is a function pointer for the APIs. Often the lookup
is based on a generic property of a device (e.g, name, fwnode, of node pointer
or device type) rather than a driver specific information. However, each driver
writes up its own "match" function, spilling the similar match functions all
over the driver subsystems.

Additionally the prototype for the "match" functions accepted by the above APIs
have a minute difference which prevents us otherwise sharing the match functions.
i.e,
	int (*match)(struct device *dev, void *data) for {bus/driver}_find_device()
	  vs
	int (*match)(struct device *dev, const void *) for class_find_device()

If we promote the former to accept a "const void*" parameter, we could share one
single match function for all the helpers. This series achieves the following:

 1) Unify the prototype for "match" functions accepted by the device lookup APIs.
 2) Introduce generic match functions to match devices by the generic attributes
    of a device (e.g, name, fwnode, of_node and devt).

Also, in order to prevent creation of such match functions in the future,
we introduce wrapper functions for the look up APIs, which automatically
uses the appropriate match functions.

i.e,
	{bus/class/driver}_find_device_by_name
	{bus/class/driver}_find_device_by_of_node
	{bus/class/driver}_find_device_by_fwnode
	{bus/class/driver}_find_device_by_devt

Additionally, this series also adds wrapper for finding a device by matching
a device driver for platform bus devices - platform_find_device_by_driver() to
avoid a few drivers hard coding the platform bus specific details.

This is part 1 of revised version of the series posted here [0], to allow for better
management of the merging. Part 2 of the series, where these new helpers are consumed
by the individual driver subsystems will be posted once this is series is merged.
The entire tree with both the parts in is available at [1]

[0] https://marc.info/?i=[e-mail]
[1] git://linux-arm.org/linux-skp.git driver-cleanup/v1

Cc: Alan Tull <[e-mail]>
Cc: Alessandro Zummo <[e-mail]>
Cc: Alexander Aring <[e-mail]>
Cc: Alexander Shishkin <[e-mail]>
Cc: Alexandre Belloni <[e-mail]>
Cc: Andreas Noever <[e-mail]>
Cc: Andrew Lunn <[e-mail]>
Cc: Arnd Bergmann <[e-mail]>
Cc: Bjorn Helgaas <[e-mail]>
Cc: Corey Minyard <[e-mail]>
Cc: Daniel Vetter <[e-mail]>
Cc: Dan Murphy <[e-mail]>
Cc: David Airlie <[e-mail]>
Cc: David Kershner <[e-mail]>
Cc: "David S. Miller" <[e-mail]>
Cc: Doug Ledford <[e-mail]>
Cc: [e-mail]
Cc: Elie Morisse <[e-mail]>
Cc: Eric Anholt <[e-mail]>
Cc: Felipe Balbi <[e-mail]>
Cc: Florian Fainelli <[e-mail]>
Cc: Frank Rowand <[e-mail]>
Cc: Grant Likely <[e-mail]>
Cc: Greg Kroah-Hartman <[e-mail]>
Cc: Grygorii Strashko <[e-mail]>
Cc: Harald Freudenberger <[e-mail]>
Cc: Hartmut Knaack <[e-mail]>
Cc: Heikki Krogerus <[e-mail]>
Cc: Heiko Carstens <[e-mail]>
Cc: "Heiko Stübner" <[e-mail]>
Cc: Heiko Stuebner <[e-mail]>
Cc: Heiner Kallweit <[e-mail]>
Cc: Inki Dae <[e-mail]>
Cc: Jacek Anaszewski <[e-mail]>
Cc: "James E.J. Bottomley" <[e-mail]>
Cc: Jason Gunthorpe <[e-mail]>
Cc: Jiri Slaby <[e-mail]>
Cc: Joe Perches <[e-mail]>
Cc: Joerg Roedel <[e-mail]>
Cc: Jonathan Cameron <[e-mail]>
Cc: Jonathan Hunter <[e-mail]>
Cc: Lee Jones <[e-mail]>
Cc: Len Brown <[e-mail]
Cc: Liam Girdwood <[e-mail]>
Cc: Maarten Lankhorst <[e-mail]>
Cc: Mark Brown <[e-mail]>
Cc: "Martin K. Petersen" <[e-mail]>
Cc: Mathieu Poirier <[e-mail]>
Cc: Maxime Coquelin <[e-mail]>
Cc: Maxime Ripard <[e-mail]>
Cc: Michael Jamet <[e-mail]>
Cc: Mika Westerberg <[e-mail]>
Cc: Moritz Fischer <[e-mail]>
Cc: Nehal Shah <[e-mail]>
Cc: Oliver Neukum <[e-mail]>
Cc: Pavel Machek <[e-mail]>
Cc: Peter Oberparleiter <[e-mail]>
Cc: Peter Rosin <[e-mail]>
Cc: "Rafael J. Wysocki" <[e-mail]>
Cc: "Rafael J. Wysocki" <[e-mail]>
Cc: Rafael J. Wysocki" <[e-mail]>
Cc: Rob Herring <[e-mail]>
Cc: Robin Murphy <[e-mail]>
Cc: Russell King <[e-mail]>
Cc: Sandy Huang <[e-mail]>
Cc: Sebastian Andrzej Siewior <[e-mail]>
Cc: Sebastian Ott <[e-mail]>
Cc: Seung-Woo Kim <[e-mail]>
Cc: Shyam Sundar S K <[e-mail]>
Cc: Srinivas Kandagatla <[e-mail]>
Cc: Stefan Schmidt <[e-mail]>
Cc: Takashi Iwai <[e-mail]>
Cc: Thierry Reding <[e-mail]>
Cc: Thor Thayer <[e-mail]>
Cc: Tomas Winkler <[e-mail]>
Cc: Ulf Hansson <[e-mail]>
Cc: Will Deacon <[e-mail]>
Cc: Wolfram Sang <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]

Suzuki K Poulose (13):
  acpi: utils: Cleanup acpi_dev_match_cb
  bus_find_device: Unify the match callback with class_find_device
  driver_find_device: Unify the match function with class_find_device()
  drivers: Add generic helper to match by of_node
  drivers: Add generic helper to match by fwnode
  drivers: Add generic helper to match by devt
  drivers: Add generic match helper by ACPI_COMPANION device
  drivers: Add generic helper to match by name
  drivers: Add generic helper to match any device
  drivers: Introduce variants of class_find_device()
  drivers: Introduce variants for bus_find_device()
  drivers: Introduce variants of driver_find_device()
  platform: Add platform_find_device_by_driver() helper

 arch/powerpc/platforms/pseries/ibmebus.c           |   4 +-
 drivers/acpi/acpi_lpss.c                           |   4 +-
 drivers/acpi/sleep.c                               |   2 +-
 drivers/acpi/utils.c                               |  11 +-
 drivers/amba/tegra-ahb.c                           |   4 +-
 drivers/base/bus.c                                 |  28 +--
 drivers/base/core.c                                |  36 ++++
 drivers/base/devcon.c                              |   2 +-
 drivers/base/driver.c                              |   4 +-
 drivers/base/platform.c                            |  14 ++
 drivers/char/ipmi/ipmi_msghandler.c                |   8 +-
 drivers/char/ipmi/ipmi_si_platform.c               |   2 +-
 drivers/firmware/efi/dev-path-parser.c             |   4 +-
 drivers/gpu/drm/drm_mipi_dsi.c                     |   2 +-
 drivers/gpu/drm/tegra/dc.c                         |   4 +-
 drivers/hwtracing/coresight/coresight.c            |   6 +-
 drivers/hwtracing/coresight/of_coresight.c         |   2 +-
 drivers/hwtracing/intel_th/core.c                  |   5 +-
 drivers/i2c/busses/i2c-amd-mp2-pci.c               |   2 +-
 drivers/i2c/i2c-core-acpi.c                        |   4 +-
 drivers/i2c/i2c-core-of.c                          |   4 +-
 drivers/iio/inkern.c                               |   2 +-
 drivers/infiniband/hw/hns/hns_roce_hw_v1.c         |   2 +-
 drivers/iommu/arm-smmu-v3.c                        |   2 +-
 drivers/iommu/arm-smmu.c                           |   2 +-
 drivers/mfd/altera-sysmgr.c                        |   4 +-
 drivers/mfd/syscon.c                               |   2 +-
 drivers/net/ethernet/hisilicon/hns/hns_dsaf_misc.c |   2 +-
 drivers/net/ethernet/ti/cpsw-phy-sel.c             |   4 +-
 drivers/net/ethernet/ti/davinci_emac.c             |   2 +-
 drivers/net/ethernet/toshiba/tc35815.c             |   4 +-
 drivers/nvmem/core.c                               |   2 +-
 drivers/of/of_mdio.c                               |   2 +-
 drivers/of/platform.c                              |   2 +-
 drivers/pci/probe.c                                |   2 +-
 drivers/pci/search.c                               |   4 +-
 drivers/s390/cio/ccwgroup.c                        |   2 +-
 drivers/s390/cio/chsc_sch.c                        |   2 +-
 drivers/s390/cio/css.c                             |   4 +-
 drivers/s390/cio/device.c                          |   6 +-
 drivers/s390/cio/scm.c                             |   4 +-
 drivers/s390/crypto/ap_bus.c                       |   8 +-
 drivers/scsi/scsi_proc.c                           |   2 +-
 drivers/spi/spi.c                                  |   4 +-
 drivers/staging/most/core.c                        |   4 +-
 drivers/thunderbolt/switch.c                       |   4 +-
 drivers/usb/core/devio.c                           |   4 +-
 drivers/usb/core/usb.c                             |   4 +-
 drivers/usb/phy/phy-am335x-control.c               |   4 +-
 drivers/usb/phy/phy-isp1301.c                      |   4 +-
 drivers/visorbus/visorbus_main.c                   |   4 +-
 include/linux/device.h                             | 188 ++++++++++++++++++++-
 include/linux/platform_device.h                    |   3 +
 sound/soc/rockchip/rk3399_gru_sound.c              |   2 +-
 54 files changed, 320 insertions(+), 123 deletions(-)