blob: d60f7701e245f9db9148a07a48fbace6756147bc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07005 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This file is released under the GPLv2
9 *
10 * See Documentation/driver-model/ for more information.
11 */
12
13#ifndef _DEVICE_H_
14#define _DEVICE_H_
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/ioport.h>
17#include <linux/kobject.h>
mochel@digitalimplant.org465c7a32005-03-21 11:49:14 -080018#include <linux/klist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/list.h>
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -070020#include <linux/lockdep.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070021#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/types.h>
Paul Gortmakerde477252011-05-26 13:46:22 -040023#include <linux/mutex.h>
Linus Walleijab780292013-01-22 10:56:14 -070024#include <linux/pinctrl/devinfo.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/pm.h>
Arun Sharma600634972011-07-26 16:09:06 -070026#include <linux/atomic.h>
Hiroshi DOYU6ca04592012-05-14 10:47:57 +030027#include <linux/ratelimit.h>
Kay Sievers3c2670e2013-04-06 09:56:00 -070028#include <linux/uidgid.h>
Joe Perches64c862a82013-10-11 13:11:38 -070029#include <linux/gfp.h>
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +110030#include <asm/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct device;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080033struct device_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034struct device_driver;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080035struct driver_private;
Paul Gortmakerde477252011-05-26 13:46:22 -040036struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037struct class;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010038struct subsys_private;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010039struct bus_type;
Grant Likelyd706c1b2010-04-13 16:12:28 -070040struct device_node;
Rafael J. Wysockice793482015-03-16 23:49:03 +010041struct fwnode_handle;
Joerg Roedelff217762011-08-26 16:48:26 +020042struct iommu_ops;
Alex Williamson74416e12012-05-30 14:18:41 -060043struct iommu_group;
Robin Murphy57f98d22016-09-13 10:54:14 +010044struct iommu_fwspec;
Kay Sieversb8c5cec2007-02-16 17:33:36 +010045
46struct bus_attribute {
47 struct attribute attr;
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080048 ssize_t (*show)(struct bus_type *bus, char *buf);
49 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
Kay Sieversb8c5cec2007-02-16 17:33:36 +010050};
51
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -080052#define BUS_ATTR(_name, _mode, _show, _store) \
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -070053 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
54#define BUS_ATTR_RW(_name) \
55 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
56#define BUS_ATTR_RO(_name) \
57 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
Kay Sieversb8c5cec2007-02-16 17:33:36 +010058
59extern int __must_check bus_create_file(struct bus_type *,
60 struct bus_attribute *);
61extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Wanlong Gao880ffb52011-05-05 07:55:36 +080063/**
64 * struct bus_type - The bus type of the device
65 *
66 * @name: The name of the bus.
Kay Sieversca22e562011-12-14 14:29:38 -080067 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
68 * @dev_root: Default device to use as the parent.
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -070069 * @bus_groups: Default attributes of the bus.
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -070070 * @dev_groups: Default attributes of the devices on the bus.
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -070071 * @drv_groups: Default attributes of the device drivers on the bus.
Wanlong Gao880ffb52011-05-05 07:55:36 +080072 * @match: Called, perhaps multiple times, whenever a new device or driver
Tomeu Vizoso656b8032016-02-15 09:25:06 +010073 * is added for this bus. It should return a positive value if the
74 * given device can be handled by the given driver and zero
75 * otherwise. It may also return error code if determining that
76 * the driver supports the device is not possible. In case of
77 * -EPROBE_DEFER it will queue the device for deferred probing.
Wanlong Gao880ffb52011-05-05 07:55:36 +080078 * @uevent: Called when a device is added, removed, or a few other things
79 * that generate uevents to add the environment variables.
80 * @probe: Called when a new device or driver add to this bus, and callback
81 * the specific driver's probe to initial the matched device.
82 * @remove: Called when a device removed from this bus.
83 * @shutdown: Called at shut-down time to quiesce the device.
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +020084 *
85 * @online: Called to put the device back online (after offlining it).
86 * @offline: Called to put the device offline for hot-removal. May fail.
87 *
Wanlong Gao880ffb52011-05-05 07:55:36 +080088 * @suspend: Called when a device on this bus wants to go to sleep mode.
89 * @resume: Called to bring a device on this bus out of sleep mode.
Phil Sutter582a6862017-01-18 14:04:37 +010090 * @num_vf: Called to find out how many virtual functions a device on this
91 * bus supports.
Wanlong Gao880ffb52011-05-05 07:55:36 +080092 * @pm: Power management operations of this bus, callback the specific
93 * device driver's pm-ops.
Marcos Paulo de Souza7b08fae82011-11-01 11:15:40 -070094 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
Joerg Roedelff217762011-08-26 16:48:26 +020095 * driver implementations to a bus and allow the driver to do
96 * bus-specific setup
Wanlong Gao880ffb52011-05-05 07:55:36 +080097 * @p: The private data of the driver core, only the driver core can
98 * touch this.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +020099 * @lock_key: Lock class key for use by the lock validator
Robin Murphyd89e2372017-10-12 16:56:14 +0100100 * @force_dma: Assume devices on this bus should be set up by dma_configure()
101 * even if DMA capability is not explicitly described by firmware.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800102 *
103 * A bus is a channel between the processor and one or more devices. For the
104 * purposes of the device model, all devices are connected via a bus, even if
105 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
106 * A USB controller is usually a PCI device, for example. The device model
107 * represents the actual connections between buses and the devices they control.
108 * A bus is represented by the bus_type structure. It contains the name, the
109 * default attributes, the bus' methods, PM operations, and the driver core's
110 * private data.
111 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112struct bus_type {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800113 const char *name;
Kay Sieversca22e562011-12-14 14:29:38 -0800114 const char *dev_name;
115 struct device *dev_root;
Greg Kroah-Hartman12478ba2013-08-08 15:22:57 -0700116 const struct attribute_group **bus_groups;
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -0700117 const struct attribute_group **dev_groups;
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -0700118 const struct attribute_group **drv_groups;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800120 int (*match)(struct device *dev, struct device_driver *drv);
121 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
122 int (*probe)(struct device *dev);
123 int (*remove)(struct device *dev);
124 void (*shutdown)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700125
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200126 int (*online)(struct device *dev);
127 int (*offline)(struct device *dev);
128
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800129 int (*suspend)(struct device *dev, pm_message_t state);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800130 int (*resume)(struct device *dev);
Kay Sieversb8c5cec2007-02-16 17:33:36 +0100131
Phil Sutter582a6862017-01-18 14:04:37 +0100132 int (*num_vf)(struct device *dev);
133
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700134 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200135
Thierry Redingb22f6432014-06-27 09:03:12 +0200136 const struct iommu_ops *iommu_ops;
Joerg Roedelff217762011-08-26 16:48:26 +0200137
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100138 struct subsys_private *p;
Michal Hockobe871b72013-03-12 17:21:19 +0100139 struct lock_class_key lock_key;
Robin Murphyd89e2372017-10-12 16:56:14 +0100140
141 bool force_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142};
143
Michal Hockobe871b72013-03-12 17:21:19 +0100144extern int __must_check bus_register(struct bus_type *bus);
145
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800146extern void bus_unregister(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800148extern int __must_check bus_rescan_devices(struct bus_type *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150/* iterator helpers for buses */
Kay Sieversca22e562011-12-14 14:29:38 -0800151struct subsys_dev_iter {
152 struct klist_iter ki;
153 const struct device_type *type;
154};
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700155void subsys_dev_iter_init(struct subsys_dev_iter *iter,
Kay Sieversca22e562011-12-14 14:29:38 -0800156 struct bus_type *subsys,
157 struct device *start,
158 const struct device_type *type);
159struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
160void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800162int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
163 int (*fn)(struct device *dev, void *data));
164struct device *bus_find_device(struct bus_type *bus, struct device *start,
165 void *data,
166 int (*match)(struct device *dev, void *data));
Greg Kroah-Hartman1f9ffc02008-01-27 10:29:20 -0800167struct device *bus_find_device_by_name(struct bus_type *bus,
168 struct device *start,
169 const char *name);
Kay Sieversca22e562011-12-14 14:29:38 -0800170struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
171 struct device *hint);
Jean Delvarecc7447a2010-06-16 11:44:18 +0200172int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
173 void *data, int (*fn)(struct device_driver *, void *));
Greg Kroah-Hartman99178b02008-08-26 11:00:57 -0500174void bus_sort_breadthfirst(struct bus_type *bus,
175 int (*compare)(const struct device *a,
176 const struct device *b));
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000177/*
178 * Bus notifiers: Get notified of addition/removal of devices
179 * and binding/unbinding of drivers to devices.
180 * In the long run, it should be a replacement for the platform
181 * notify hooks.
182 */
183struct notifier_block;
184
185extern int bus_register_notifier(struct bus_type *bus,
186 struct notifier_block *nb);
187extern int bus_unregister_notifier(struct bus_type *bus,
188 struct notifier_block *nb);
189
190/* All 4 notifers below get called with the target struct device *
191 * as an argument. Note that those functions are likely to be called
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800192 * with the device lock held in the core, so be careful.
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000193 */
194#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
Joerg Roedel599bad32014-09-30 13:02:02 +0200195#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
196#define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
197#define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
Magnus Damm45daef02010-07-23 19:56:18 +0900198 bound */
Joerg Roedel599bad32014-09-30 13:02:02 +0200199#define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
200#define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000201 unbound */
Joerg Roedel599bad32014-09-30 13:02:02 +0200202#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
Joerg Roedel309b7d62009-04-24 14:57:00 +0200203 from the device */
Andy Shevchenko14b62572015-12-04 23:49:17 +0200204#define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +1000205
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700206extern struct kset *bus_get_kset(struct bus_type *bus);
Greg Kroah-Hartmanb2490722007-11-01 19:41:16 -0700207extern struct klist *bus_get_device_klist(struct bus_type *bus);
Greg Kroah-Hartman0fed80f2007-11-01 19:41:16 -0700208
Wanlong Gao880ffb52011-05-05 07:55:36 +0800209/**
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700210 * enum probe_type - device driver probe type to try
211 * Device drivers may opt in for special handling of their
212 * respective probe routines. This tells the core what to
213 * expect and prefer.
214 *
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700215 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
216 * whether probed synchronously or asynchronously.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700217 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
218 * probing order is not essential for booting the system may
219 * opt into executing their probes asynchronously.
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700220 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
221 * their probe routines to run synchronously with driver and
222 * device registration (with the exception of -EPROBE_DEFER
223 * handling - re-probing always ends up being done asynchronously).
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700224 *
225 * Note that the end goal is to switch the kernel to use asynchronous
226 * probing by default, so annotating drivers with
227 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
228 * to speed up boot process while we are validating the rest of the
229 * drivers.
230 */
231enum probe_type {
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700232 PROBE_DEFAULT_STRATEGY,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700233 PROBE_PREFER_ASYNCHRONOUS,
Luis R. Rodriguezd173a132015-03-30 16:20:06 -0700234 PROBE_FORCE_SYNCHRONOUS,
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700235};
236
237/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800238 * struct device_driver - The basic device driver structure
239 * @name: Name of the device driver.
240 * @bus: The bus which the device of this driver belongs to.
241 * @owner: The module owner.
242 * @mod_name: Used for built-in modules.
243 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700244 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800245 * @of_match_table: The open firmware table.
Mika Westerberg06f64c82012-10-31 22:44:33 +0100246 * @acpi_match_table: The ACPI match table.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800247 * @probe: Called to query the existence of a specific device,
248 * whether this driver can work with it, and bind the driver
249 * to a specific device.
250 * @remove: Called when the device is removed from the system to
251 * unbind a device from this driver.
252 * @shutdown: Called at shut-down time to quiesce the device.
253 * @suspend: Called to put the device to sleep mode. Usually to a
254 * low power state.
255 * @resume: Called to bring a device from sleep mode.
256 * @groups: Default attributes that get created by the driver core
257 * automatically.
258 * @pm: Power management operations of the device which matched
259 * this driver.
260 * @p: Driver core's private data, no one other than the driver
261 * core can touch this.
262 *
263 * The device driver-model tracks all of the drivers known to the system.
264 * The main reason for this tracking is to enable the driver core to match
265 * up drivers with new devices. Once drivers are known objects within the
266 * system, however, a number of other things become possible. Device drivers
267 * can export information and configuration variables that are independent
268 * of any specific device.
269 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270struct device_driver {
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800271 const char *name;
272 struct bus_type *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800274 struct module *owner;
Dmitry Torokhov1a6f2a72009-10-12 20:17:41 -0700275 const char *mod_name; /* used for built-in modules */
276
277 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700278 enum probe_type probe_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Grant Likely597b9d12010-04-13 16:13:01 -0700280 const struct of_device_id *of_match_table;
Mika Westerberg06f64c82012-10-31 22:44:33 +0100281 const struct acpi_device_id *acpi_match_table;
Grant Likely597b9d12010-04-13 16:13:01 -0700282
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800283 int (*probe) (struct device *dev);
284 int (*remove) (struct device *dev);
285 void (*shutdown) (struct device *dev);
286 int (*suspend) (struct device *dev, pm_message_t state);
287 int (*resume) (struct device *dev);
David Brownella4dbd672009-06-24 10:06:31 -0700288 const struct attribute_group **groups;
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800289
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700290 const struct dev_pm_ops *pm;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200291
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -0800292 struct driver_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
294
295
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800296extern int __must_check driver_register(struct device_driver *drv);
297extern void driver_unregister(struct device_driver *drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800299extern struct device_driver *driver_find(const char *name,
300 struct bus_type *bus);
Greg Kroah-Hartmand7792492006-07-18 10:59:59 -0700301extern int driver_probe_done(void);
Ming Leib23530e2009-02-21 16:45:07 +0800302extern void wait_for_device_probe(void);
Arjan van de Ven216773a2009-02-14 01:59:06 +0100303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100305/* sysfs interface for exporting driver attributes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307struct driver_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800308 struct attribute attr;
309 ssize_t (*show)(struct device_driver *driver, char *buf);
310 ssize_t (*store)(struct device_driver *driver, const char *buf,
311 size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312};
313
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700314#define DRIVER_ATTR_RW(_name) \
315 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
316#define DRIVER_ATTR_RO(_name) \
317 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700318#define DRIVER_ATTR_WO(_name) \
319 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800321extern int __must_check driver_create_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200322 const struct driver_attribute *attr);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800323extern void driver_remove_file(struct device_driver *driver,
Phil Carmody099c2f22009-12-18 15:34:21 +0200324 const struct driver_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800326extern int __must_check driver_for_each_device(struct device_driver *drv,
327 struct device *start,
328 void *data,
329 int (*fn)(struct device *dev,
330 void *));
331struct device *driver_find_device(struct device_driver *drv,
332 struct device *start, void *data,
333 int (*match)(struct device *dev, void *data));
mochel@digitalimplant.orgfae3cd02005-03-21 10:59:56 -0800334
Wanlong Gao880ffb52011-05-05 07:55:36 +0800335/**
Kay Sieversca22e562011-12-14 14:29:38 -0800336 * struct subsys_interface - interfaces to device functions
Randy Dunlap2eda0132012-01-21 11:02:51 -0800337 * @name: name of the device function
338 * @subsys: subsytem of the devices to attach to
339 * @node: the list of functions registered at the subsystem
340 * @add_dev: device hookup to device function handler
341 * @remove_dev: device hookup to device function handler
Kay Sieversca22e562011-12-14 14:29:38 -0800342 *
343 * Simple interfaces attached to a subsystem. Multiple interfaces can
344 * attach to a subsystem and its devices. Unlike drivers, they do not
345 * exclusively claim or control devices. Interfaces usually represent
346 * a specific functionality of a subsystem/class of devices.
347 */
348struct subsys_interface {
349 const char *name;
350 struct bus_type *subsys;
351 struct list_head node;
352 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
Viresh Kumar71db87b2015-07-30 15:04:01 +0530353 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
Kay Sieversca22e562011-12-14 14:29:38 -0800354};
355
356int subsys_interface_register(struct subsys_interface *sif);
357void subsys_interface_unregister(struct subsys_interface *sif);
358
359int subsys_system_register(struct bus_type *subsys,
360 const struct attribute_group **groups);
Tejun Heod73ce002013-03-12 11:30:05 -0700361int subsys_virtual_register(struct bus_type *subsys,
362 const struct attribute_group **groups);
Kay Sieversca22e562011-12-14 14:29:38 -0800363
364/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800365 * struct class - device classes
366 * @name: Name of the class.
367 * @owner: The module owner.
Greg Kroah-Hartmanced64732016-11-28 16:41:41 +0100368 * @class_groups: Default attributes of this class.
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700369 * @dev_groups: Default attributes of the devices that belong to the class.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800370 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
371 * @dev_uevent: Called when a device is added, removed from this class, or a
372 * few other things that generate uevents to add the environment
373 * variables.
374 * @devnode: Callback to provide the devtmpfs.
375 * @class_release: Called to release this class.
376 * @dev_release: Called to release the device.
377 * @suspend: Used to put the device to sleep mode, usually to a low power
378 * state.
379 * @resume: Used to bring the device from the sleep mode.
Michal Suchanek75216212017-08-11 15:44:43 +0200380 * @shutdown_pre: Called at shut-down time before driver shutdown.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800381 * @ns_type: Callbacks so sysfs can detemine namespaces.
382 * @namespace: Namespace of the device belongs to this class.
383 * @pm: The default device power management operations of this class.
384 * @p: The private data of the driver core, no one other than the
385 * driver core can touch this.
386 *
387 * A class is a higher-level view of a device that abstracts out low-level
388 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
389 * at the class level, they are all simply disks. Classes allow user space
390 * to work with devices based on what they do, rather than how they are
391 * connected or how they work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 */
393struct class {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800394 const char *name;
395 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Greg Kroah-Hartmanced64732016-11-28 16:41:41 +0100397 const struct attribute_group **class_groups;
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -0700398 const struct attribute_group **dev_groups;
Dan Williamse105b8b2008-04-21 10:51:07 -0700399 struct kobject *dev_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800401 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
Al Viro2c9ede52011-07-23 20:24:48 -0400402 char *(*devnode)(struct device *dev, umode_t *mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800404 void (*class_release)(struct class *class);
405 void (*dev_release)(struct device *dev);
Linus Torvalds7c8265f2006-06-24 14:50:29 -0700406
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800407 int (*suspend)(struct device *dev, pm_message_t state);
408 int (*resume)(struct device *dev);
Michal Suchanek75216212017-08-11 15:44:43 +0200409 int (*shutdown_pre)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200410
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700411 const struct kobj_ns_type_operations *ns_type;
412 const void *(*namespace)(struct device *dev);
413
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700414 const struct dev_pm_ops *pm;
415
Kay Sievers6b6e39a2010-11-15 23:13:18 +0100416 struct subsys_private *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417};
418
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200419struct class_dev_iter {
420 struct klist_iter ki;
421 const struct device_type *type;
422};
423
Dan Williamse105b8b2008-04-21 10:51:07 -0700424extern struct kobject *sysfs_dev_block_kobj;
425extern struct kobject *sysfs_dev_char_kobj;
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700426extern int __must_check __class_register(struct class *class,
427 struct lock_class_key *key);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800428extern void class_unregister(struct class *class);
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700429
430/* This is a #define to keep the compiler from merging different
431 * instances of the __key variable */
432#define class_register(class) \
433({ \
434 static struct lock_class_key __key; \
435 __class_register(class, &__key); \
436})
437
Jean Delvare46227092009-08-04 12:55:34 +0200438struct class_compat;
439struct class_compat *class_compat_register(const char *name);
440void class_compat_unregister(struct class_compat *cls);
441int class_compat_create_link(struct class_compat *cls, struct device *dev,
442 struct device *device_link);
443void class_compat_remove_link(struct class_compat *cls, struct device *dev,
444 struct device *device_link);
445
Greg Kroah-Hartman7cd9c9b2012-04-19 19:17:30 -0700446extern void class_dev_iter_init(struct class_dev_iter *iter,
447 struct class *class,
448 struct device *start,
449 const struct device_type *type);
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200450extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
451extern void class_dev_iter_exit(struct class_dev_iter *iter);
452
Greg Kroah-Hartman93562b52008-05-22 17:21:08 -0400453extern int class_for_each_device(struct class *class, struct device *start,
454 void *data,
Dave Youngfd048972008-01-22 15:27:08 +0800455 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400456extern struct device *class_find_device(struct class *class,
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100457 struct device *start, const void *data,
458 int (*match)(struct device *, const void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460struct class_attribute {
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800461 struct attribute attr;
Andi Kleen28812fe2010-01-05 12:48:07 +0100462 ssize_t (*show)(struct class *class, struct class_attribute *attr,
463 char *buf);
464 ssize_t (*store)(struct class *class, struct class_attribute *attr,
465 const char *buf, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466};
467
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700468#define CLASS_ATTR_RW(_name) \
469 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
470#define CLASS_ATTR_RO(_name) \
471 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman2027cbc2016-11-22 18:31:49 +0100472#define CLASS_ATTR_WO(_name) \
473 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Tejun Heo58292cbe2013-09-11 22:29:04 -0400475extern int __must_check class_create_file_ns(struct class *class,
476 const struct class_attribute *attr,
477 const void *ns);
478extern void class_remove_file_ns(struct class *class,
479 const struct class_attribute *attr,
480 const void *ns);
481
482static inline int __must_check class_create_file(struct class *class,
483 const struct class_attribute *attr)
484{
485 return class_create_file_ns(class, attr, NULL);
486}
487
488static inline void class_remove_file(struct class *class,
489 const struct class_attribute *attr)
490{
491 return class_remove_file_ns(class, attr, NULL);
492}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Andi Kleen869dfc82010-01-05 12:48:08 +0100494/* Simple class attribute that is just a static string */
Andi Kleen869dfc82010-01-05 12:48:08 +0100495struct class_attribute_string {
496 struct class_attribute attr;
497 char *str;
498};
499
500/* Currently read-only only */
501#define _CLASS_ATTR_STRING(_name, _mode, _str) \
502 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
503#define CLASS_ATTR_STRING(_name, _mode, _str) \
504 struct class_attribute_string class_attr_##_name = \
505 _CLASS_ATTR_STRING(_name, _mode, _str)
506
507extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
508 char *buf);
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510struct class_interface {
511 struct list_head node;
512 struct class *class;
513
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200514 int (*add_dev) (struct device *, struct class_interface *);
515 void (*remove_dev) (struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516};
517
Andrew Morton4a7fb632006-08-14 22:43:17 -0700518extern int __must_check class_interface_register(struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519extern void class_interface_unregister(struct class_interface *);
520
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700521extern struct class * __must_check __class_create(struct module *owner,
522 const char *name,
523 struct lock_class_key *key);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800524extern void class_destroy(struct class *cls);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800525
Matthew Wilcoxd2a3b912008-05-28 09:28:39 -0700526/* This is a #define to keep the compiler from merging different
527 * instances of the __key variable */
528#define class_create(owner, name) \
529({ \
530 static struct lock_class_key __key; \
531 __class_create(owner, name, &__key); \
532})
533
Kay Sievers414264f2007-03-12 21:08:57 +0100534/*
535 * The type of device, "struct device" is embedded in. A class
536 * or bus can contain devices of different types
537 * like "partitions" and "disks", "mouse" and "event".
538 * This identifies the device type and carries type-specific
539 * information, equivalent to the kobj_type of a kobject.
540 * If "name" is specified, the uevent will contain it in
541 * the DEVTYPE variable.
542 */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200543struct device_type {
Kay Sievers414264f2007-03-12 21:08:57 +0100544 const char *name;
David Brownella4dbd672009-06-24 10:06:31 -0700545 const struct attribute_group **groups;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200546 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
Kay Sievers3c2670e2013-04-06 09:56:00 -0700547 char *(*devnode)(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700548 kuid_t *uid, kgid_t *gid);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200549 void (*release)(struct device *dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200550
Dmitry Torokhov8150f322009-07-24 22:11:32 -0700551 const struct dev_pm_ops *pm;
Kay Sieversf9f852d2006-10-07 21:54:55 +0200552};
553
Kay Sieversa7fd6702005-10-01 14:49:43 +0200554/* interface for exporting device attributes */
555struct device_attribute {
556 struct attribute attr;
557 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
558 char *buf);
559 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
560 const char *buf, size_t count);
561};
562
Kay Sieversca22e562011-12-14 14:29:38 -0800563struct dev_ext_attribute {
564 struct device_attribute attr;
565 void *var;
566};
Kay Sieversa7fd6702005-10-01 14:49:43 +0200567
Kay Sieversca22e562011-12-14 14:29:38 -0800568ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
569 char *buf);
570ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
571 const char *buf, size_t count);
572ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
573 char *buf);
574ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
575 const char *buf, size_t count);
Borislav Petkov91872392012-10-09 19:52:05 +0200576ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
577 char *buf);
578ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
579 const char *buf, size_t count);
Kay Sieversca22e562011-12-14 14:29:38 -0800580
Kay Sieversa7fd6702005-10-01 14:49:43 +0200581#define DEVICE_ATTR(_name, _mode, _show, _store) \
Kay Sieversca22e562011-12-14 14:29:38 -0800582 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
Greg Kroah-Hartmanced321b2013-07-14 16:05:54 -0700583#define DEVICE_ATTR_RW(_name) \
584 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
585#define DEVICE_ATTR_RO(_name) \
586 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
Greg Kroah-Hartman1130c552013-08-23 15:02:56 -0700587#define DEVICE_ATTR_WO(_name) \
588 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
Kay Sieversca22e562011-12-14 14:29:38 -0800589#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
590 struct dev_ext_attribute dev_attr_##_name = \
591 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
592#define DEVICE_INT_ATTR(_name, _mode, _var) \
593 struct dev_ext_attribute dev_attr_##_name = \
Michael Davidson94758182012-05-03 16:19:02 -0700594 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
Borislav Petkov91872392012-10-09 19:52:05 +0200595#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
596 struct dev_ext_attribute dev_attr_##_name = \
597 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
Alan Stern356c05d2012-05-14 13:30:03 -0400598#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
599 struct device_attribute dev_attr_##_name = \
600 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
Kay Sieversa7fd6702005-10-01 14:49:43 +0200601
Greg Kroah-Hartmanb9d4e712012-01-04 15:05:10 -0800602extern int device_create_file(struct device *device,
603 const struct device_attribute *entry);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800604extern void device_remove_file(struct device *dev,
Phil Carmody26579ab2009-12-18 15:34:19 +0200605 const struct device_attribute *attr);
Tejun Heo6b0afc22014-02-03 14:03:01 -0500606extern bool device_remove_file_self(struct device *dev,
607 const struct device_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700608extern int __must_check device_create_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200609 const struct bin_attribute *attr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700610extern void device_remove_bin_file(struct device *dev,
Phil Carmody66ecb922009-12-18 15:34:20 +0200611 const struct bin_attribute *attr);
Tejun Heo9ac78492007-01-20 16:00:26 +0900612
613/* device resource management */
614typedef void (*dr_release_t)(struct device *dev, void *res);
615typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
616
617#ifdef CONFIG_DEBUG_DEVRES
Dan Williams7c683942015-10-05 20:35:55 -0400618extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700619 int nid, const char *name) __malloc;
Tejun Heo9ac78492007-01-20 16:00:26 +0900620#define devres_alloc(release, size, gfp) \
Dan Williams7c683942015-10-05 20:35:55 -0400621 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
622#define devres_alloc_node(release, size, gfp, nid) \
623 __devres_alloc_node(release, size, gfp, nid, #release)
Tejun Heo9ac78492007-01-20 16:00:26 +0900624#else
Dan Williams7c683942015-10-05 20:35:55 -0400625extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700626 int nid) __malloc;
Dan Williams7c683942015-10-05 20:35:55 -0400627static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
628{
629 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
630}
Tejun Heo9ac78492007-01-20 16:00:26 +0900631#endif
Dan Williams7c683942015-10-05 20:35:55 -0400632
Ming Leibddb1b92012-08-04 12:01:26 +0800633extern void devres_for_each_res(struct device *dev, dr_release_t release,
634 dr_match_t match, void *match_data,
635 void (*fn)(struct device *, void *, void *),
636 void *data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900637extern void devres_free(void *res);
638extern void devres_add(struct device *dev, void *res);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800639extern void *devres_find(struct device *dev, dr_release_t release,
Tejun Heo9ac78492007-01-20 16:00:26 +0900640 dr_match_t match, void *match_data);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800641extern void *devres_get(struct device *dev, void *new_res,
642 dr_match_t match, void *match_data);
643extern void *devres_remove(struct device *dev, dr_release_t release,
644 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900645extern int devres_destroy(struct device *dev, dr_release_t release,
646 dr_match_t match, void *match_data);
Mark Brownd926d0e2012-05-03 18:15:13 +0100647extern int devres_release(struct device *dev, dr_release_t release,
648 dr_match_t match, void *match_data);
Tejun Heo9ac78492007-01-20 16:00:26 +0900649
650/* devres group */
651extern void * __must_check devres_open_group(struct device *dev, void *id,
652 gfp_t gfp);
653extern void devres_close_group(struct device *dev, void *id);
654extern void devres_remove_group(struct device *dev, void *id);
655extern int devres_release_group(struct device *dev, void *id);
656
Joe Perches64c862a82013-10-11 13:11:38 -0700657/* managed devm_k.alloc/kfree for device drivers */
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700658extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
Nicolas Iooss8db14862015-07-17 16:23:42 -0700659extern __printf(3, 0)
660char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700661 va_list ap) __malloc;
Geert Uytterhoevenbef59c52014-08-20 15:26:35 +0200662extern __printf(3, 4)
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700663char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
Joe Perches64c862a82013-10-11 13:11:38 -0700664static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
665{
666 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
667}
668static inline void *devm_kmalloc_array(struct device *dev,
669 size_t n, size_t size, gfp_t flags)
670{
671 if (size != 0 && n > SIZE_MAX / size)
672 return NULL;
673 return devm_kmalloc(dev, n * size, flags);
674}
675static inline void *devm_kcalloc(struct device *dev,
676 size_t n, size_t size, gfp_t flags)
677{
678 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
679}
Tejun Heo9ac78492007-01-20 16:00:26 +0900680extern void devm_kfree(struct device *dev, void *p);
Rasmus Villemoes48a27052016-05-19 17:10:55 -0700681extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
Srinivas Pandruvada30463652014-04-29 00:51:00 +0100682extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
683 gfp_t gfp);
Tejun Heo9ac78492007-01-20 16:00:26 +0900684
Eli Billauer43339be2014-05-16 11:26:35 +0300685extern unsigned long devm_get_free_pages(struct device *dev,
686 gfp_t gfp_mask, unsigned int order);
687extern void devm_free_pages(struct device *dev, unsigned long addr);
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -0700688
Thierry Reding75096572013-01-21 11:08:54 +0100689void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
Wolfram Sang72f8c0b2011-10-25 15:16:47 +0200690
Dmitry Torokhovd6b0c582013-02-23 13:11:14 -0800691/* allows to add/remove a custom action to devres stack */
692int devm_add_action(struct device *dev, void (*action)(void *), void *data);
693void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
694
Sudip Mukherjeea3499e92015-12-23 17:57:19 +0530695static inline int devm_add_action_or_reset(struct device *dev,
696 void (*action)(void *), void *data)
697{
698 int ret;
699
700 ret = devm_add_action(dev, action, data);
701 if (ret)
702 action(data);
703
704 return ret;
705}
706
Madalin Bucurff86aae2016-11-15 10:41:01 +0200707/**
708 * devm_alloc_percpu - Resource-managed alloc_percpu
709 * @dev: Device to allocate per-cpu memory for
710 * @type: Type to allocate per-cpu memory for
711 *
712 * Managed alloc_percpu. Per-cpu memory allocated with this function is
713 * automatically freed on driver detach.
714 *
715 * RETURNS:
716 * Pointer to allocated memory on success, NULL on failure.
717 */
718#define devm_alloc_percpu(dev, type) \
719 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
720 __alignof__(type)))
721
722void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
723 size_t align);
724void devm_free_percpu(struct device *dev, void __percpu *pdata);
725
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800726struct device_dma_parameters {
727 /*
728 * a low level driver may set these to teach IOMMU code about
729 * sg limitations.
730 */
731 unsigned int max_segment_size;
732 unsigned long segment_boundary_mask;
733};
734
Wanlong Gao880ffb52011-05-05 07:55:36 +0800735/**
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100736 * enum device_link_state - Device link states.
737 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
738 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
739 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
740 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
741 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
742 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
743 */
744enum device_link_state {
745 DL_STATE_NONE = -1,
746 DL_STATE_DORMANT = 0,
747 DL_STATE_AVAILABLE,
748 DL_STATE_CONSUMER_PROBE,
749 DL_STATE_ACTIVE,
750 DL_STATE_SUPPLIER_UNBIND,
751};
752
753/*
754 * Device link flags.
755 *
756 * STATELESS: The core won't track the presence of supplier/consumer drivers.
757 * AUTOREMOVE: Remove this link automatically on consumer driver unbind.
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100758 * PM_RUNTIME: If set, the runtime PM framework will use this link.
759 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100760 */
761#define DL_FLAG_STATELESS BIT(0)
762#define DL_FLAG_AUTOREMOVE BIT(1)
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100763#define DL_FLAG_PM_RUNTIME BIT(2)
764#define DL_FLAG_RPM_ACTIVE BIT(3)
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100765
766/**
767 * struct device_link - Device link representation.
768 * @supplier: The device on the supplier end of the link.
769 * @s_node: Hook to the supplier device's list of links to consumers.
770 * @consumer: The device on the consumer end of the link.
771 * @c_node: Hook to the consumer device's list of links to suppliers.
772 * @status: The state of the link (with respect to the presence of drivers).
773 * @flags: Link flags.
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100774 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100775 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
776 */
777struct device_link {
778 struct device *supplier;
779 struct list_head s_node;
780 struct device *consumer;
781 struct list_head c_node;
782 enum device_link_state status;
783 u32 flags;
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100784 bool rpm_active;
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100785#ifdef CONFIG_SRCU
786 struct rcu_head rcu_head;
787#endif
788};
789
790/**
791 * enum dl_dev_state - Device driver presence tracking information.
792 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
793 * @DL_DEV_PROBING: A driver is probing.
794 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
795 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
796 */
797enum dl_dev_state {
798 DL_DEV_NO_DRIVER = 0,
799 DL_DEV_PROBING,
800 DL_DEV_DRIVER_BOUND,
801 DL_DEV_UNBINDING,
802};
803
804/**
805 * struct dev_links_info - Device data related to device links.
806 * @suppliers: List of links to supplier devices.
807 * @consumers: List of links to consumer devices.
808 * @status: Driver status information.
809 */
810struct dev_links_info {
811 struct list_head suppliers;
812 struct list_head consumers;
813 enum dl_dev_state status;
814};
815
816/**
Wanlong Gao880ffb52011-05-05 07:55:36 +0800817 * struct device - The basic device structure
818 * @parent: The device's "parent" device, the device to which it is attached.
819 * In most cases, a parent device is some sort of bus or host
820 * controller. If parent is NULL, the device, is a top-level device,
821 * which is not usually what you want.
822 * @p: Holds the private data of the driver core portions of the device.
823 * See the comment of the struct device_private for detail.
824 * @kobj: A top-level, abstract class from which other classes are derived.
825 * @init_name: Initial name of the device.
826 * @type: The type of device.
827 * This identifies the device type and carries type-specific
828 * information.
829 * @mutex: Mutex to synchronize calls to its driver.
830 * @bus: Type of bus device is on.
831 * @driver: Which driver has allocated this
832 * @platform_data: Platform data specific to the device.
833 * Example: For devices on custom boards, as typical of embedded
834 * and SOC based hardware, Linux often uses platform_data to point
835 * to board-specific structures describing devices and how they
836 * are wired. That can include what ports are available, chip
837 * variants, which GPIO pins act in what additional roles, and so
838 * on. This shrinks the "Board Support Packages" (BSPs) and
839 * minimizes board-specific #ifdefs in drivers.
Jean Delvare1bb6c082014-04-14 12:54:47 +0200840 * @driver_data: Private pointer for driver specific info.
Lukas Wunner64df1142016-12-04 13:10:04 +0100841 * @links: Links to suppliers and consumers of this device.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800842 * @power: For device power management.
Geert Uytterhoeven74378c52017-09-05 20:16:27 +0200843 * See Documentation/driver-api/pm/devices.rst for details.
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200844 * @pm_domain: Provide callbacks that are executed during system suspend,
Wanlong Gao880ffb52011-05-05 07:55:36 +0800845 * hibernation, system resume and during runtime PM transitions
846 * along with subsystem-level and driver-level callbacks.
Linus Walleijab780292013-01-22 10:56:14 -0700847 * @pins: For device pin management.
Ludovic Desroches0cca6c82017-08-06 16:00:05 +0200848 * See Documentation/driver-api/pinctl.rst for details.
Jiang Liu4a7cc832015-07-09 16:00:44 +0800849 * @msi_list: Hosts MSI descriptors
Marc Zyngierf1421db2015-07-28 14:46:10 +0100850 * @msi_domain: The generic MSI domain this device is using.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800851 * @numa_node: NUMA node this device is close to.
Jonathan Corbet6a7a8172017-08-24 16:09:10 -0600852 * @dma_ops: DMA mapping operations for this device.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800853 * @dma_mask: Dma mask (if dma'ble device).
854 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
855 * hardware supports 64-bit addresses for consistent allocations
856 * such descriptors.
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400857 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
Wanlong Gao880ffb52011-05-05 07:55:36 +0800858 * @dma_parms: A low level driver may set these to teach IOMMU code about
859 * segment limitations.
860 * @dma_pools: Dma pools (if dma'ble device).
861 * @dma_mem: Internal for coherent mem override.
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200862 * @cma_area: Contiguous memory area for dma allocations
Wanlong Gao880ffb52011-05-05 07:55:36 +0800863 * @archdata: For arch-specific additions.
864 * @of_node: Associated device tree node.
Rafael J. Wysockice793482015-03-16 23:49:03 +0100865 * @fwnode: Associated device node supplied by platform firmware.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800866 * @devt: For creating the sysfs "dev".
Randy Dunlap2eda0132012-01-21 11:02:51 -0800867 * @id: device instance
Wanlong Gao880ffb52011-05-05 07:55:36 +0800868 * @devres_lock: Spinlock to protect the resource of the device.
869 * @devres_head: The resources list of the device.
870 * @knode_class: The node used to add the device to the class list.
871 * @class: The class of the device.
872 * @groups: Optional attribute groups.
873 * @release: Callback to free the device after all references have
874 * gone away. This should be set by the allocator of the
875 * device (i.e. the bus driver that discovered the device).
Michael Opdenackerbfd63cd2013-06-26 05:57:06 +0200876 * @iommu_group: IOMMU group the device belongs to.
Robin Murphy57f98d22016-09-13 10:54:14 +0100877 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800878 *
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200879 * @offline_disabled: If set, the device is permanently online.
880 * @offline: Set after successful invocation of bus type's .offline().
Johan Hovold4e75e1d2017-06-06 17:59:00 +0200881 * @of_node_reused: Set if the device-tree node is shared with an ancestor
882 * device.
Wanlong Gao880ffb52011-05-05 07:55:36 +0800883 *
884 * At the lowest level, every device in a Linux system is represented by an
885 * instance of struct device. The device structure contains the information
886 * that the device model core needs to model the system. Most subsystems,
887 * however, track additional information about the devices they host. As a
888 * result, it is rare for devices to be represented by bare device structures;
889 * instead, that structure, like kobject structures, is usually embedded within
890 * a higher-level representation of the device.
891 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892struct device {
David Brownell49a4ec12007-05-08 00:29:39 -0700893 struct device *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800895 struct device_private *p;
896
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 struct kobject kobj;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -0700898 const char *init_name; /* initial name of the device */
Stephen Hemmingeraed65af2011-03-28 09:12:52 -0700899 const struct device_type *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Thomas Gleixner31427882010-01-29 20:39:02 +0000901 struct mutex mutex; /* mutex to synchronize calls to
mochel@digitalimplant.orgaf703162005-03-21 10:41:04 -0800902 * its driver.
903 */
904
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800905 struct bus_type *bus; /* type of bus device is on */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 struct device_driver *driver; /* which driver has allocated this
907 device */
Greg Kroah-Hartmane67c8562009-03-08 23:13:32 +0800908 void *platform_data; /* Platform specific data, device
909 core doesn't touch it */
Jean Delvare1bb6c082014-04-14 12:54:47 +0200910 void *driver_data; /* Driver data, set and get with
911 dev_set/get_drvdata */
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100912 struct dev_links_info links;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 struct dev_pm_info power;
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200914 struct dev_pm_domain *pm_domain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Marc Zyngierf1421db2015-07-28 14:46:10 +0100916#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
917 struct irq_domain *msi_domain;
918#endif
Linus Walleijab780292013-01-22 10:56:14 -0700919#ifdef CONFIG_PINCTRL
920 struct dev_pin_info *pins;
921#endif
Jiang Liu4a7cc832015-07-09 16:00:44 +0800922#ifdef CONFIG_GENERIC_MSI_IRQ
923 struct list_head msi_list;
924#endif
Linus Walleijab780292013-01-22 10:56:14 -0700925
Christoph Hellwig87348132006-12-06 20:32:33 -0800926#ifdef CONFIG_NUMA
927 int numa_node; /* NUMA node this device is close to */
928#endif
Bart Van Assche56579332017-01-20 13:04:02 -0800929 const struct dma_map_ops *dma_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 u64 *dma_mask; /* dma mask (if dma'able device) */
931 u64 coherent_dma_mask;/* Like dma_mask, but for
932 alloc_coherent mappings as
933 not all hardware supports
934 64 bit addresses for consistent
935 allocations such descriptors. */
Santosh Shilimkar8febcaa2014-04-24 11:30:01 -0400936 unsigned long dma_pfn_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800938 struct device_dma_parameters *dma_parms;
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 struct list_head dma_pools; /* dma pools (if dma'ble) */
941
942 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
943 override */
Marek Szyprowskia2547382013-07-29 14:31:45 +0200944#ifdef CONFIG_DMA_CMA
Marek Szyprowskic64be2b2011-12-29 13:09:51 +0100945 struct cma *cma_area; /* contiguous memory area for dma
946 allocations */
947#endif
Benjamin Herrenschmidtc6dbaef2006-11-11 17:18:39 +1100948 /* arch specific additions */
949 struct dev_archdata archdata;
Grant Likelyc9e358d2011-01-21 09:24:48 -0700950
951 struct device_node *of_node; /* associated device tree node */
Rafael J. Wysockice793482015-03-16 23:49:03 +0100952 struct fwnode_handle *fwnode; /* firmware device node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600954 dev_t devt; /* dev_t, creates the sysfs "dev" */
Kay Sieversca22e562011-12-14 14:29:38 -0800955 u32 id; /* device instance */
Matthew Wilcox929d2fa2008-10-16 15:51:35 -0600956
Tejun Heo9ac78492007-01-20 16:00:26 +0900957 spinlock_t devres_lock;
958 struct list_head devres_head;
959
Tejun Heo5a3ceb82008-08-25 19:50:19 +0200960 struct klist_node knode_class;
Kay Sieversb7a3e812006-10-07 21:54:55 +0200961 struct class *class;
David Brownella4dbd672009-06-24 10:06:31 -0700962 const struct attribute_group **groups; /* optional groups */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700963
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -0800964 void (*release)(struct device *dev);
Alex Williamson74416e12012-05-30 14:18:41 -0600965 struct iommu_group *iommu_group;
Robin Murphy57f98d22016-09-13 10:54:14 +0100966 struct iommu_fwspec *iommu_fwspec;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200967
968 bool offline_disabled:1;
969 bool offline:1;
Johan Hovold4e75e1d2017-06-06 17:59:00 +0200970 bool of_node_reused:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971};
972
Lars-Peter Clausena4232962012-07-03 18:49:35 +0200973static inline struct device *kobj_to_dev(struct kobject *kobj)
974{
975 return container_of(kobj, struct device, kobj);
976}
977
Alan Stern9a3df1f2008-03-19 22:39:13 +0100978/* Get the wakeup routines, which depend on struct device */
979#include <linux/pm_wakeup.h>
980
Jean Delvarebf9ca692008-07-30 12:29:21 -0700981static inline const char *dev_name(const struct device *dev)
Kay Sievers06916632008-05-02 06:02:41 +0200982{
Paul Mundta636ee72010-03-09 06:57:53 +0000983 /* Use the init name until the kobject becomes available */
984 if (dev->init_name)
985 return dev->init_name;
986
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100987 return kobject_name(&dev->kobj);
Kay Sievers06916632008-05-02 06:02:41 +0200988}
989
Joe Perchesb9075fa2011-10-31 17:11:33 -0700990extern __printf(2, 3)
991int dev_set_name(struct device *dev, const char *name, ...);
Stephen Rothwell413c2392008-05-30 10:16:40 +1000992
Christoph Hellwig87348132006-12-06 20:32:33 -0800993#ifdef CONFIG_NUMA
994static inline int dev_to_node(struct device *dev)
995{
996 return dev->numa_node;
997}
998static inline void set_dev_node(struct device *dev, int node)
999{
1000 dev->numa_node = node;
1001}
1002#else
1003static inline int dev_to_node(struct device *dev)
1004{
1005 return -1;
1006}
1007static inline void set_dev_node(struct device *dev, int node)
1008{
1009}
1010#endif
1011
Marc Zyngierf1421db2015-07-28 14:46:10 +01001012static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1013{
1014#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1015 return dev->msi_domain;
1016#else
1017 return NULL;
1018#endif
1019}
1020
1021static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1022{
1023#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1024 dev->msi_domain = d;
1025#endif
1026}
1027
Jean Delvarea996d012014-04-14 12:58:53 +02001028static inline void *dev_get_drvdata(const struct device *dev)
1029{
1030 return dev->driver_data;
1031}
1032
1033static inline void dev_set_drvdata(struct device *dev, void *data)
1034{
1035 dev->driver_data = data;
1036}
1037
Rafael J. Wysocki5c095a02011-08-25 15:33:50 +02001038static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1039{
1040 return dev ? dev->power.subsys_data : NULL;
1041}
1042
Ming Leif67f1292009-03-01 21:10:49 +08001043static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1044{
1045 return dev->kobj.uevent_suppress;
1046}
1047
1048static inline void dev_set_uevent_suppress(struct device *dev, int val)
1049{
1050 dev->kobj.uevent_suppress = val;
1051}
1052
Daniel Ritzd305ef52005-09-22 00:47:24 -07001053static inline int device_is_registered(struct device *dev)
1054{
Greg Kroah-Hartman3f62e572008-03-13 17:07:03 -04001055 return dev->kobj.state_in_sysfs;
Daniel Ritzd305ef52005-09-22 00:47:24 -07001056}
1057
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +01001058static inline void device_enable_async_suspend(struct device *dev)
1059{
Alan Sternf76b168b2011-06-18 20:22:23 +02001060 if (!dev->power.is_prepared)
Rafael J. Wysocki5af84b82010-01-23 22:23:32 +01001061 dev->power.async_suspend = true;
1062}
1063
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +01001064static inline void device_disable_async_suspend(struct device *dev)
1065{
Alan Sternf76b168b2011-06-18 20:22:23 +02001066 if (!dev->power.is_prepared)
Rafael J. Wysocki5a2eb852010-01-23 22:25:23 +01001067 dev->power.async_suspend = false;
1068}
1069
1070static inline bool device_async_suspend_enabled(struct device *dev)
1071{
1072 return !!dev->power.async_suspend;
1073}
1074
Rafael J. Wysockifeb70af2012-08-13 14:00:25 +02001075static inline void dev_pm_syscore_device(struct device *dev, bool val)
1076{
1077#ifdef CONFIG_PM_SLEEP
1078 dev->power.syscore = val;
1079#endif
1080}
1081
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -08001082static inline void device_lock(struct device *dev)
1083{
Thomas Gleixner31427882010-01-29 20:39:02 +00001084 mutex_lock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -08001085}
1086
Oliver Neukum7dd9cba2016-01-21 15:18:47 +01001087static inline int device_lock_interruptible(struct device *dev)
1088{
1089 return mutex_lock_interruptible(&dev->mutex);
1090}
1091
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -08001092static inline int device_trylock(struct device *dev)
1093{
Thomas Gleixner31427882010-01-29 20:39:02 +00001094 return mutex_trylock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -08001095}
1096
1097static inline void device_unlock(struct device *dev)
1098{
Thomas Gleixner31427882010-01-29 20:39:02 +00001099 mutex_unlock(&dev->mutex);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -08001100}
1101
Konrad Rzeszutek Wilkac801022014-12-03 16:40:27 -05001102static inline void device_lock_assert(struct device *dev)
1103{
1104 lockdep_assert_held(&dev->mutex);
1105}
1106
Benjamin Herrenschmidte8a51e12015-02-17 19:03:41 -06001107static inline struct device_node *dev_of_node(struct device *dev)
1108{
1109 if (!IS_ENABLED(CONFIG_OF))
1110 return NULL;
1111 return dev->of_node;
1112}
1113
Adrian Bunk1f217822006-12-19 13:01:28 -08001114void driver_init(void);
1115
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116/*
1117 * High level routines for use by the bus drivers
1118 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001119extern int __must_check device_register(struct device *dev);
1120extern void device_unregister(struct device *dev);
1121extern void device_initialize(struct device *dev);
1122extern int __must_check device_add(struct device *dev);
1123extern void device_del(struct device *dev);
1124extern int device_for_each_child(struct device *dev, void *data,
1125 int (*fn)(struct device *dev, void *data));
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001126extern int device_for_each_child_reverse(struct device *dev, void *data,
1127 int (*fn)(struct device *dev, void *data));
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001128extern struct device *device_find_child(struct device *dev, void *data,
1129 int (*match)(struct device *dev, void *data));
Johannes Berg6937e8f2010-08-05 17:38:18 +02001130extern int device_rename(struct device *dev, const char *new_name);
Cornelia Huckffa6a702009-03-04 12:44:00 +01001131extern int device_move(struct device *dev, struct device *new_parent,
1132 enum dpm_order dpm_order);
Kay Sieverse454cea2009-09-18 23:01:12 +02001133extern const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001134 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001135 const char **tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001137static inline bool device_supports_offline(struct device *dev)
1138{
1139 return dev->bus && dev->bus->offline && dev->bus->online;
1140}
1141
1142extern void lock_device_hotplug(void);
1143extern void unlock_device_hotplug(void);
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001144extern int lock_device_hotplug_sysfs(void);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001145extern int device_offline(struct device *dev);
1146extern int device_online(struct device *dev);
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02001147extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1148extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
Johan Hovold4e75e1d2017-06-06 17:59:00 +02001149void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02001150
Phil Sutter9af15c32017-01-18 14:04:39 +01001151static inline int dev_num_vf(struct device *dev)
1152{
1153 if (dev->bus && dev->bus->num_vf)
1154 return dev->bus->num_vf(dev);
1155 return 0;
1156}
1157
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158/*
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001159 * Root device objects for grouping under /sys/devices
1160 */
1161extern struct device *__root_device_register(const char *name,
1162 struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001163
Tejun Heo33ac1252014-01-10 08:57:31 -05001164/* This is a macro to avoid include problems with THIS_MODULE */
Paul Gortmakereb5589a2011-05-27 09:02:11 -04001165#define root_device_register(name) \
1166 __root_device_register(name, THIS_MODULE)
1167
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001168extern void root_device_unregister(struct device *root);
1169
Mark Browna5b8b1a2009-07-17 15:06:08 +01001170static inline void *dev_get_platdata(const struct device *dev)
1171{
1172 return dev->platform_data;
1173}
1174
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00001175/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 * Manual binding of a device to driver. See drivers/base/bus.c
1177 * for information on use.
1178 */
Andrew Mortonf86db392006-08-14 22:43:20 -07001179extern int __must_check device_bind_driver(struct device *dev);
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001180extern void device_release_driver(struct device *dev);
1181extern int __must_check device_attach(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001182extern int __must_check driver_attach(struct device_driver *drv);
Dmitry Torokhov765230b2015-03-30 16:20:04 -07001183extern void device_initial_probe(struct device *dev);
Andrew Mortonf86db392006-08-14 22:43:20 -07001184extern int __must_check device_reprobe(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
Tomeu Vizoso6b9cb422016-01-07 16:46:12 +01001186extern bool device_is_bound(struct device *dev);
1187
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001188/*
1189 * Easy functions for dynamically creating devices on the fly
1190 */
Nicolas Iooss8db14862015-07-17 16:23:42 -07001191extern __printf(5, 0)
1192struct device *device_create_vargs(struct class *cls, struct device *parent,
1193 dev_t devt, void *drvdata,
1194 const char *fmt, va_list vargs);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001195extern __printf(5, 6)
1196struct device *device_create(struct class *cls, struct device *parent,
1197 dev_t devt, void *drvdata,
1198 const char *fmt, ...);
Guenter Roeck39ef3112013-07-14 16:05:57 -07001199extern __printf(6, 7)
1200struct device *device_create_with_groups(struct class *cls,
1201 struct device *parent, dev_t devt, void *drvdata,
1202 const struct attribute_group **groups,
1203 const char *fmt, ...);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001204extern void device_destroy(struct class *cls, dev_t devt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205
Dmitry Torokhova7670d42017-07-19 17:24:31 -07001206extern int __must_check device_add_groups(struct device *dev,
1207 const struct attribute_group **groups);
1208extern void device_remove_groups(struct device *dev,
1209 const struct attribute_group **groups);
1210
Dmitry Torokhove323b2d2017-07-19 17:24:32 -07001211static inline int __must_check device_add_group(struct device *dev,
1212 const struct attribute_group *grp)
1213{
1214 const struct attribute_group *groups[] = { grp, NULL };
1215
1216 return device_add_groups(dev, groups);
1217}
1218
1219static inline void device_remove_group(struct device *dev,
1220 const struct attribute_group *grp)
1221{
1222 const struct attribute_group *groups[] = { grp, NULL };
1223
1224 return device_remove_groups(dev, groups);
1225}
1226
Dmitry Torokhov57b8ff02017-07-19 17:24:33 -07001227extern int __must_check devm_device_add_groups(struct device *dev,
1228 const struct attribute_group **groups);
1229extern void devm_device_remove_groups(struct device *dev,
1230 const struct attribute_group **groups);
1231extern int __must_check devm_device_add_group(struct device *dev,
1232 const struct attribute_group *grp);
1233extern void devm_device_remove_group(struct device *dev,
1234 const struct attribute_group *grp);
1235
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236/*
1237 * Platform "fixup" functions - allow the platform to have their say
1238 * about devices and actions that the general device layer doesn't
1239 * know about.
1240 */
1241/* Notify platform of device discovery */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001242extern int (*platform_notify)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001244extern int (*platform_notify_remove)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246
Wanlong Gao880ffb52011-05-05 07:55:36 +08001247/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 * get_device - atomically increment the reference count for the device.
1249 *
1250 */
Greg Kroah-Hartmand4629432008-01-24 21:04:46 -08001251extern struct device *get_device(struct device *dev);
1252extern void put_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Kay Sievers2b2af542009-04-30 15:23:42 +02001254#ifdef CONFIG_DEVTMPFS
1255extern int devtmpfs_create_node(struct device *dev);
1256extern int devtmpfs_delete_node(struct device *dev);
Kay Sievers073120c2009-10-28 19:51:17 +01001257extern int devtmpfs_mount(const char *mntdir);
Kay Sievers2b2af542009-04-30 15:23:42 +02001258#else
1259static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1260static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1261static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1262#endif
1263
Rytchkov Alexey116f232b2006-03-22 00:58:53 +01001264/* drivers/base/power/shutdown.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265extern void device_shutdown(void);
1266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267/* debugging and troubleshooting/diagnostic helpers. */
Jean Delvarebf9ca692008-07-30 12:29:21 -07001268extern const char *dev_driver_string(const struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +01001270/* Device links interface. */
1271struct device_link *device_link_add(struct device *consumer,
1272 struct device *supplier, u32 flags);
1273void device_link_del(struct device_link *link);
Joe Perches99bcf212010-06-27 01:02:34 +00001274
1275#ifdef CONFIG_PRINTK
1276
Joe Perches0a18b052012-09-25 18:19:57 -07001277extern __printf(3, 0)
1278int dev_vprintk_emit(int level, const struct device *dev,
1279 const char *fmt, va_list args);
Joe Perches05e4e5b2012-09-12 20:13:37 -07001280extern __printf(3, 4)
1281int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
Joe Perches798efc62012-09-12 20:11:29 -07001282
Joe Perchesb9075fa2011-10-31 17:11:33 -07001283extern __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001284void dev_printk(const char *level, const struct device *dev,
1285 const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001286extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001287void dev_emerg(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001288extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001289void dev_alert(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001290extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001291void dev_crit(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001292extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001293void dev_err(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001294extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001295void dev_warn(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001296extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001297void dev_notice(const struct device *dev, const char *fmt, ...);
Joe Perchesb9075fa2011-10-31 17:11:33 -07001298extern __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001299void _dev_info(const struct device *dev, const char *fmt, ...);
Joe Perches99bcf212010-06-27 01:02:34 +00001300
1301#else
1302
Joe Perches0a18b052012-09-25 18:19:57 -07001303static inline __printf(3, 0)
1304int dev_vprintk_emit(int level, const struct device *dev,
1305 const char *fmt, va_list args)
Joe Perches05e4e5b2012-09-12 20:13:37 -07001306{ return 0; }
1307static inline __printf(3, 4)
1308int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1309{ return 0; }
1310
Joe Perchesd1f10522014-12-25 15:07:04 -08001311static inline void __dev_printk(const char *level, const struct device *dev,
1312 struct va_format *vaf)
1313{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001314static inline __printf(3, 4)
Joe Perchesd1f10522014-12-25 15:07:04 -08001315void dev_printk(const char *level, const struct device *dev,
1316 const char *fmt, ...)
1317{}
Joe Perches99bcf212010-06-27 01:02:34 +00001318
Joe Perchesb9075fa2011-10-31 17:11:33 -07001319static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001320void dev_emerg(const struct device *dev, const char *fmt, ...)
1321{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001322static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001323void dev_crit(const struct device *dev, const char *fmt, ...)
1324{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001325static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001326void dev_alert(const struct device *dev, const char *fmt, ...)
1327{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001328static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001329void dev_err(const struct device *dev, const char *fmt, ...)
1330{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001331static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001332void dev_warn(const struct device *dev, const char *fmt, ...)
1333{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001334static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001335void dev_notice(const struct device *dev, const char *fmt, ...)
1336{}
Joe Perchesb9075fa2011-10-31 17:11:33 -07001337static inline __printf(2, 3)
Joe Perchesd1f10522014-12-25 15:07:04 -08001338void _dev_info(const struct device *dev, const char *fmt, ...)
1339{}
Joe Perches99bcf212010-06-27 01:02:34 +00001340
1341#endif
1342
1343/*
1344 * Stupid hackaround for existing uses of non-printk uses dev_info
1345 *
1346 * Note that the definition of dev_info below is actually _dev_info
1347 * and a macro is used to avoid redefining dev_info
1348 */
1349
1350#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
Emil Medve7b8712e2007-10-30 14:37:14 -05001351
Jim Cromieb558c962011-12-19 17:11:18 -05001352#if defined(CONFIG_DYNAMIC_DEBUG)
Joe Perches99bcf212010-06-27 01:02:34 +00001353#define dev_dbg(dev, format, ...) \
1354do { \
Jason Baron346e15b2008-08-12 16:46:19 -04001355 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
Joe Perches99bcf212010-06-27 01:02:34 +00001356} while (0)
Jim Cromieb558c962011-12-19 17:11:18 -05001357#elif defined(DEBUG)
1358#define dev_dbg(dev, format, arg...) \
1359 dev_printk(KERN_DEBUG, dev, format, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360#else
Joe Perches99bcf212010-06-27 01:02:34 +00001361#define dev_dbg(dev, format, arg...) \
1362({ \
1363 if (0) \
1364 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001365})
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366#endif
1367
Joe Perchese1353032014-11-17 18:18:22 -08001368#ifdef CONFIG_PRINTK
1369#define dev_level_once(dev_level, dev, fmt, ...) \
1370do { \
1371 static bool __print_once __read_mostly; \
1372 \
1373 if (!__print_once) { \
1374 __print_once = true; \
1375 dev_level(dev, fmt, ##__VA_ARGS__); \
1376 } \
1377} while (0)
1378#else
1379#define dev_level_once(dev_level, dev, fmt, ...) \
1380do { \
1381 if (0) \
1382 dev_level(dev, fmt, ##__VA_ARGS__); \
1383} while (0)
1384#endif
1385
1386#define dev_emerg_once(dev, fmt, ...) \
1387 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1388#define dev_alert_once(dev, fmt, ...) \
1389 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1390#define dev_crit_once(dev, fmt, ...) \
1391 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1392#define dev_err_once(dev, fmt, ...) \
1393 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1394#define dev_warn_once(dev, fmt, ...) \
1395 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1396#define dev_notice_once(dev, fmt, ...) \
1397 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1398#define dev_info_once(dev, fmt, ...) \
1399 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1400#define dev_dbg_once(dev, fmt, ...) \
Joe Perchesa2a15d52015-01-03 09:51:33 -08001401 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
Joe Perchese1353032014-11-17 18:18:22 -08001402
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001403#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1404do { \
1405 static DEFINE_RATELIMIT_STATE(_rs, \
1406 DEFAULT_RATELIMIT_INTERVAL, \
1407 DEFAULT_RATELIMIT_BURST); \
1408 if (__ratelimit(&_rs)) \
1409 dev_level(dev, fmt, ##__VA_ARGS__); \
1410} while (0)
1411
1412#define dev_emerg_ratelimited(dev, fmt, ...) \
1413 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1414#define dev_alert_ratelimited(dev, fmt, ...) \
1415 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1416#define dev_crit_ratelimited(dev, fmt, ...) \
1417 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1418#define dev_err_ratelimited(dev, fmt, ...) \
1419 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1420#define dev_warn_ratelimited(dev, fmt, ...) \
1421 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1422#define dev_notice_ratelimited(dev, fmt, ...) \
1423 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1424#define dev_info_ratelimited(dev, fmt, ...) \
1425 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001426#if defined(CONFIG_DYNAMIC_DEBUG)
1427/* descriptor check is first to prevent flooding with "callbacks suppressed" */
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001428#define dev_dbg_ratelimited(dev, fmt, ...) \
1429do { \
1430 static DEFINE_RATELIMIT_STATE(_rs, \
1431 DEFAULT_RATELIMIT_INTERVAL, \
1432 DEFAULT_RATELIMIT_BURST); \
1433 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1434 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1435 __ratelimit(&_rs)) \
Dmitry Kasatkin8ef2d652013-08-27 17:47:34 +03001436 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1437 ##__VA_ARGS__); \
1438} while (0)
1439#elif defined(DEBUG)
1440#define dev_dbg_ratelimited(dev, fmt, ...) \
1441do { \
1442 static DEFINE_RATELIMIT_STATE(_rs, \
1443 DEFAULT_RATELIMIT_INTERVAL, \
1444 DEFAULT_RATELIMIT_BURST); \
1445 if (__ratelimit(&_rs)) \
1446 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001447} while (0)
1448#else
Arnd Bergmann1f62ff32016-03-24 22:19:40 +01001449#define dev_dbg_ratelimited(dev, fmt, ...) \
1450do { \
1451 if (0) \
1452 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1453} while (0)
Hiroshi Doyu6f586e62012-09-04 06:40:40 +02001454#endif
1455
David Brownellaebdc3b2007-07-12 22:08:22 -07001456#ifdef VERBOSE_DEBUG
1457#define dev_vdbg dev_dbg
1458#else
Joe Perches99bcf212010-06-27 01:02:34 +00001459#define dev_vdbg(dev, format, arg...) \
1460({ \
1461 if (0) \
1462 dev_printk(KERN_DEBUG, dev, format, ##arg); \
Joe Perches99bcf212010-06-27 01:02:34 +00001463})
David Brownellaebdc3b2007-07-12 22:08:22 -07001464#endif
1465
Arjan van de Vene6139662008-09-20 19:08:39 -07001466/*
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001467 * dev_WARN*() acts like dev_printk(), but with the key difference of
1468 * using WARN/WARN_ONCE to include file/line information and a backtrace.
Arjan van de Vene6139662008-09-20 19:08:39 -07001469 */
1470#define dev_WARN(dev, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001471 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
Arjan van de Vene6139662008-09-20 19:08:39 -07001472
Felipe Balbibcdd3232011-03-16 15:59:35 +02001473#define dev_WARN_ONCE(dev, condition, format, arg...) \
Bjorn Helgaas3eae1362013-10-24 15:42:33 -06001474 WARN_ONCE(condition, "%s %s: " format, \
1475 dev_driver_string(dev), dev_name(dev), ## arg)
Felipe Balbibcdd3232011-03-16 15:59:35 +02001476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477/* Create alias, so I can be autoloaded. */
1478#define MODULE_ALIAS_CHARDEV(major,minor) \
1479 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1480#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1481 MODULE_ALIAS("char-major-" __stringify(major) "-*")
Andi Kleene52eec12010-09-08 16:54:17 +02001482
1483#ifdef CONFIG_SYSFS_DEPRECATED
1484extern long sysfs_deprecated;
1485#else
1486#define sysfs_deprecated 0
1487#endif
1488
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001489/**
1490 * module_driver() - Helper macro for drivers that don't do anything
1491 * special in module init/exit. This eliminates a lot of boilerplate.
1492 * Each module may only use this macro once, and calling it replaces
1493 * module_init() and module_exit().
1494 *
Randy Dunlap2eda0132012-01-21 11:02:51 -08001495 * @__driver: driver name
1496 * @__register: register function for this driver type
1497 * @__unregister: unregister function for this driver type
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001498 * @...: Additional arguments to be passed to __register and __unregister.
Randy Dunlap2eda0132012-01-21 11:02:51 -08001499 *
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001500 * Use this macro to construct bus specific macros for registering
1501 * drivers, and do not use it on its own.
1502 */
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001503#define module_driver(__driver, __register, __unregister, ...) \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001504static int __init __driver##_init(void) \
1505{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001506 return __register(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001507} \
1508module_init(__driver##_init); \
1509static void __exit __driver##_exit(void) \
1510{ \
Lars-Peter Clausencd494612012-02-25 11:25:58 +01001511 __unregister(&(__driver) , ##__VA_ARGS__); \
Lars-Peter Clausen907d0ed2011-11-16 10:13:35 +01001512} \
1513module_exit(__driver##_exit);
1514
Paul Gortmakerf309d442015-05-01 20:10:57 -04001515/**
1516 * builtin_driver() - Helper macro for drivers that don't do anything
1517 * special in init and have no exit. This eliminates some boilerplate.
1518 * Each driver may only use this macro once, and calling it replaces
1519 * device_initcall (or in some cases, the legacy __initcall). This is
1520 * meant to be a direct parallel of module_driver() above but without
1521 * the __exit stuff that is not used for builtin cases.
1522 *
1523 * @__driver: driver name
1524 * @__register: register function for this driver type
1525 * @...: Additional arguments to be passed to __register
1526 *
1527 * Use this macro to construct bus specific macros for registering
1528 * drivers, and do not use it on its own.
1529 */
1530#define builtin_driver(__driver, __register, ...) \
1531static int __init __driver##_init(void) \
1532{ \
1533 return __register(&(__driver) , ##__VA_ARGS__); \
1534} \
1535device_initcall(__driver##_init);
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537#endif /* _DEVICE_H_ */