Commit b45ed06f authored by Zijun Hu's avatar Zijun Hu Committed by Greg Kroah-Hartman

drivers/base: Introduce device_match_t for device finding APIs

There are several drivers/base APIs for finding a specific device, and
they currently use the following good type for the @match parameter:
int (*match)(struct device *dev, const void *data)

Since these operations do not modify the caller-provided @*data, this
type is worthy of a dedicated typedef:
typedef int (*device_match_t)(struct device *dev, const void *data)

Advantages of using device_match_t:
 - Shorter API declarations and definitions
 - Prevent further APIs from using a bad type for @match

So introduce device_match_t and apply it to the existing
(bus|class|driver|auxiliary)_find_device() APIs.
Signed-off-by: default avatarZijun Hu <quic_zijuhu@quicinc.com>
Link: https://lore.kernel.org/r/20240813-dev_match_api-v3-1-6c6878a99b9f@quicinc.comSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent f0e5311a
...@@ -352,7 +352,7 @@ EXPORT_SYMBOL_GPL(__auxiliary_device_add); ...@@ -352,7 +352,7 @@ EXPORT_SYMBOL_GPL(__auxiliary_device_add);
*/ */
struct auxiliary_device *auxiliary_find_device(struct device *start, struct auxiliary_device *auxiliary_find_device(struct device *start,
const void *data, const void *data,
int (*match)(struct device *dev, const void *data)) device_match_t match)
{ {
struct device *dev; struct device *dev;
......
...@@ -391,7 +391,7 @@ EXPORT_SYMBOL_GPL(bus_for_each_dev); ...@@ -391,7 +391,7 @@ EXPORT_SYMBOL_GPL(bus_for_each_dev);
*/ */
struct device *bus_find_device(const struct bus_type *bus, struct device *bus_find_device(const struct bus_type *bus,
struct device *start, const void *data, struct device *start, const void *data,
int (*match)(struct device *dev, const void *data)) device_match_t match)
{ {
struct subsys_private *sp = bus_to_subsys(bus); struct subsys_private *sp = bus_to_subsys(bus);
struct klist_iter i; struct klist_iter i;
......
...@@ -433,8 +433,7 @@ EXPORT_SYMBOL_GPL(class_for_each_device); ...@@ -433,8 +433,7 @@ EXPORT_SYMBOL_GPL(class_for_each_device);
* code. There's no locking restriction. * code. There's no locking restriction.
*/ */
struct device *class_find_device(const struct class *class, const struct device *start, struct device *class_find_device(const struct class *class, const struct device *start,
const void *data, const void *data, device_match_t match)
int (*match)(struct device *, const void *))
{ {
struct subsys_private *sp = class_to_subsys(class); struct subsys_private *sp = class_to_subsys(class);
struct class_dev_iter iter; struct class_dev_iter iter;
......
...@@ -150,7 +150,7 @@ EXPORT_SYMBOL_GPL(driver_for_each_device); ...@@ -150,7 +150,7 @@ EXPORT_SYMBOL_GPL(driver_for_each_device);
*/ */
struct device *driver_find_device(const struct device_driver *drv, struct device *driver_find_device(const struct device_driver *drv,
struct device *start, const void *data, struct device *start, const void *data,
int (*match)(struct device *dev, const void *data)) device_match_t match)
{ {
struct klist_iter i; struct klist_iter i;
struct device *dev; struct device *dev;
......
...@@ -271,6 +271,6 @@ void auxiliary_driver_unregister(struct auxiliary_driver *auxdrv); ...@@ -271,6 +271,6 @@ void auxiliary_driver_unregister(struct auxiliary_driver *auxdrv);
struct auxiliary_device *auxiliary_find_device(struct device *start, struct auxiliary_device *auxiliary_find_device(struct device *start,
const void *data, const void *data,
int (*match)(struct device *dev, const void *data)); device_match_t match);
#endif /* _AUXILIARY_BUS_H_ */ #endif /* _AUXILIARY_BUS_H_ */
...@@ -126,6 +126,9 @@ struct bus_attribute { ...@@ -126,6 +126,9 @@ struct bus_attribute {
int __must_check bus_create_file(const struct bus_type *bus, struct bus_attribute *attr); int __must_check bus_create_file(const struct bus_type *bus, struct bus_attribute *attr);
void bus_remove_file(const struct bus_type *bus, struct bus_attribute *attr); void bus_remove_file(const struct bus_type *bus, struct bus_attribute *attr);
/* Matching function type for drivers/base APIs to find a specific device */
typedef int (*device_match_t)(struct device *dev, const void *data);
/* Generic device matching functions that all busses can use to match with */ /* Generic device matching functions that all busses can use to match with */
int device_match_name(struct device *dev, const void *name); int device_match_name(struct device *dev, const void *name);
int device_match_of_node(struct device *dev, const void *np); int device_match_of_node(struct device *dev, const void *np);
...@@ -139,8 +142,7 @@ int device_match_any(struct device *dev, const void *unused); ...@@ -139,8 +142,7 @@ int device_match_any(struct device *dev, const void *unused);
int bus_for_each_dev(const struct bus_type *bus, struct device *start, void *data, int bus_for_each_dev(const struct bus_type *bus, struct device *start, void *data,
int (*fn)(struct device *dev, void *data)); int (*fn)(struct device *dev, void *data));
struct device *bus_find_device(const struct bus_type *bus, struct device *start, struct device *bus_find_device(const struct bus_type *bus, struct device *start,
const void *data, const void *data, device_match_t match);
int (*match)(struct device *dev, const void *data));
/** /**
* bus_find_device_by_name - device iterator for locating a particular device * bus_find_device_by_name - device iterator for locating a particular device
* of a specific name. * of a specific name.
......
...@@ -95,7 +95,7 @@ void class_dev_iter_exit(struct class_dev_iter *iter); ...@@ -95,7 +95,7 @@ void class_dev_iter_exit(struct class_dev_iter *iter);
int class_for_each_device(const struct class *class, const struct device *start, void *data, int class_for_each_device(const struct class *class, const struct device *start, void *data,
int (*fn)(struct device *dev, void *data)); int (*fn)(struct device *dev, void *data));
struct device *class_find_device(const struct class *class, const struct device *start, struct device *class_find_device(const struct class *class, const struct device *start,
const void *data, int (*match)(struct device *, const void *)); const void *data, device_match_t match);
/** /**
* class_find_device_by_name - device iterator for locating a particular device * class_find_device_by_name - device iterator for locating a particular device
......
...@@ -157,7 +157,7 @@ int __must_check driver_for_each_device(struct device_driver *drv, struct device ...@@ -157,7 +157,7 @@ int __must_check driver_for_each_device(struct device_driver *drv, struct device
void *data, int (*fn)(struct device *dev, void *)); void *data, int (*fn)(struct device *dev, void *));
struct device *driver_find_device(const struct device_driver *drv, struct device *driver_find_device(const struct device_driver *drv,
struct device *start, const void *data, struct device *start, const void *data,
int (*match)(struct device *dev, const void *data)); device_match_t match);
/** /**
* driver_find_device_by_name - device iterator for locating a particular device * driver_find_device_by_name - device iterator for locating a particular device
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment