Greg Kroah-Hartman | 989d42e | 2017-11-07 17:30:07 +0100 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | /* |
| 3 | * device.h - generic, centralized driver model |
| 4 | * |
| 5 | * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> |
Greg Kroah-Hartman | b402843 | 2009-05-11 14:16:57 -0700 | [diff] [blame] | 6 | * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> |
| 7 | * Copyright (c) 2008-2009 Novell Inc. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 | * See Documentation/driver-model/ for more information. |
| 10 | */ |
| 11 | |
| 12 | #ifndef _DEVICE_H_ |
| 13 | #define _DEVICE_H_ |
| 14 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | #include <linux/ioport.h> |
| 16 | #include <linux/kobject.h> |
mochel@digitalimplant.org | 465c7a3 | 2005-03-21 11:49:14 -0800 | [diff] [blame] | 17 | #include <linux/klist.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/list.h> |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 19 | #include <linux/lockdep.h> |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 20 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | #include <linux/types.h> |
Paul Gortmaker | de47725 | 2011-05-26 13:46:22 -0400 | [diff] [blame] | 22 | #include <linux/mutex.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | #include <linux/pm.h> |
Arun Sharma | 60063497 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 24 | #include <linux/atomic.h> |
Hiroshi DOYU | 6ca0459 | 2012-05-14 10:47:57 +0300 | [diff] [blame] | 25 | #include <linux/ratelimit.h> |
Kay Sievers | 3c2670e | 2013-04-06 09:56:00 -0700 | [diff] [blame] | 26 | #include <linux/uidgid.h> |
Joe Perches | 64c862a8 | 2013-10-11 13:11:38 -0700 | [diff] [blame] | 27 | #include <linux/gfp.h> |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 28 | #include <asm/device.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | struct device; |
Greg Kroah-Hartman | fb069a5 | 2008-12-16 12:23:36 -0800 | [diff] [blame] | 31 | struct device_private; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | struct device_driver; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 33 | struct driver_private; |
Paul Gortmaker | de47725 | 2011-05-26 13:46:22 -0400 | [diff] [blame] | 34 | struct module; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | struct class; |
Kay Sievers | 6b6e39a | 2010-11-15 23:13:18 +0100 | [diff] [blame] | 36 | struct subsys_private; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 37 | struct bus_type; |
Grant Likely | d706c1b | 2010-04-13 16:12:28 -0700 | [diff] [blame] | 38 | struct device_node; |
Rafael J. Wysocki | ce79348 | 2015-03-16 23:49:03 +0100 | [diff] [blame] | 39 | struct fwnode_handle; |
Joerg Roedel | ff21776 | 2011-08-26 16:48:26 +0200 | [diff] [blame] | 40 | struct iommu_ops; |
Alex Williamson | 74416e1 | 2012-05-30 14:18:41 -0600 | [diff] [blame] | 41 | struct iommu_group; |
Robin Murphy | 57f98d2 | 2016-09-13 10:54:14 +0100 | [diff] [blame] | 42 | struct iommu_fwspec; |
Linus Torvalds | 23c35f4 | 2018-02-02 16:44:14 -0800 | [diff] [blame] | 43 | struct dev_pin_info; |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 44 | |
| 45 | struct bus_attribute { |
| 46 | struct attribute attr; |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 47 | ssize_t (*show)(struct bus_type *bus, char *buf); |
| 48 | ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count); |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 49 | }; |
| 50 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 51 | #define BUS_ATTR(_name, _mode, _show, _store) \ |
Greg Kroah-Hartman | ced321b | 2013-07-14 16:05:54 -0700 | [diff] [blame] | 52 | struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store) |
| 53 | #define BUS_ATTR_RW(_name) \ |
| 54 | struct bus_attribute bus_attr_##_name = __ATTR_RW(_name) |
| 55 | #define BUS_ATTR_RO(_name) \ |
| 56 | struct bus_attribute bus_attr_##_name = __ATTR_RO(_name) |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 57 | |
| 58 | extern int __must_check bus_create_file(struct bus_type *, |
| 59 | struct bus_attribute *); |
| 60 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 62 | /** |
| 63 | * struct bus_type - The bus type of the device |
| 64 | * |
| 65 | * @name: The name of the bus. |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 66 | * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id). |
| 67 | * @dev_root: Default device to use as the parent. |
Greg Kroah-Hartman | 12478ba | 2013-08-08 15:22:57 -0700 | [diff] [blame] | 68 | * @bus_groups: Default attributes of the bus. |
Greg Kroah-Hartman | fa6fdb3 | 2013-08-08 15:22:55 -0700 | [diff] [blame] | 69 | * @dev_groups: Default attributes of the devices on the bus. |
Greg Kroah-Hartman | ed0617b | 2013-08-08 15:22:56 -0700 | [diff] [blame] | 70 | * @drv_groups: Default attributes of the device drivers on the bus. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 71 | * @match: Called, perhaps multiple times, whenever a new device or driver |
Tomeu Vizoso | 656b803 | 2016-02-15 09:25:06 +0100 | [diff] [blame] | 72 | * is added for this bus. It should return a positive value if the |
| 73 | * given device can be handled by the given driver and zero |
| 74 | * otherwise. It may also return error code if determining that |
| 75 | * the driver supports the device is not possible. In case of |
| 76 | * -EPROBE_DEFER it will queue the device for deferred probing. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 77 | * @uevent: Called when a device is added, removed, or a few other things |
| 78 | * that generate uevents to add the environment variables. |
| 79 | * @probe: Called when a new device or driver add to this bus, and callback |
| 80 | * the specific driver's probe to initial the matched device. |
| 81 | * @remove: Called when a device removed from this bus. |
| 82 | * @shutdown: Called at shut-down time to quiesce the device. |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 83 | * |
| 84 | * @online: Called to put the device back online (after offlining it). |
| 85 | * @offline: Called to put the device offline for hot-removal. May fail. |
| 86 | * |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 87 | * @suspend: Called when a device on this bus wants to go to sleep mode. |
| 88 | * @resume: Called to bring a device on this bus out of sleep mode. |
Phil Sutter | 582a686 | 2017-01-18 14:04:37 +0100 | [diff] [blame] | 89 | * @num_vf: Called to find out how many virtual functions a device on this |
| 90 | * bus supports. |
Nipun Gupta | 07397df | 2018-04-28 08:21:58 +0530 | [diff] [blame^] | 91 | * @dma_configure: Called to setup DMA configuration on a device on |
| 92 | this bus. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 93 | * @pm: Power management operations of this bus, callback the specific |
| 94 | * device driver's pm-ops. |
Marcos Paulo de Souza | 7b08fae8 | 2011-11-01 11:15:40 -0700 | [diff] [blame] | 95 | * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU |
Joerg Roedel | ff21776 | 2011-08-26 16:48:26 +0200 | [diff] [blame] | 96 | * driver implementations to a bus and allow the driver to do |
| 97 | * bus-specific setup |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 98 | * @p: The private data of the driver core, only the driver core can |
| 99 | * touch this. |
Michael Opdenacker | bfd63cd | 2013-06-26 05:57:06 +0200 | [diff] [blame] | 100 | * @lock_key: Lock class key for use by the lock validator |
Robin Murphy | d89e237 | 2017-10-12 16:56:14 +0100 | [diff] [blame] | 101 | * @force_dma: Assume devices on this bus should be set up by dma_configure() |
| 102 | * even if DMA capability is not explicitly described by firmware. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 103 | * |
| 104 | * A bus is a channel between the processor and one or more devices. For the |
| 105 | * purposes of the device model, all devices are connected via a bus, even if |
| 106 | * it is an internal, virtual, "platform" bus. Buses can plug into each other. |
| 107 | * A USB controller is usually a PCI device, for example. The device model |
| 108 | * represents the actual connections between buses and the devices they control. |
| 109 | * A bus is represented by the bus_type structure. It contains the name, the |
| 110 | * default attributes, the bus' methods, PM operations, and the driver core's |
| 111 | * private data. |
| 112 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | struct bus_type { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 114 | const char *name; |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 115 | const char *dev_name; |
| 116 | struct device *dev_root; |
Greg Kroah-Hartman | 12478ba | 2013-08-08 15:22:57 -0700 | [diff] [blame] | 117 | const struct attribute_group **bus_groups; |
Greg Kroah-Hartman | fa6fdb3 | 2013-08-08 15:22:55 -0700 | [diff] [blame] | 118 | const struct attribute_group **dev_groups; |
Greg Kroah-Hartman | ed0617b | 2013-08-08 15:22:56 -0700 | [diff] [blame] | 119 | const struct attribute_group **drv_groups; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 121 | int (*match)(struct device *dev, struct device_driver *drv); |
| 122 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
| 123 | int (*probe)(struct device *dev); |
| 124 | int (*remove)(struct device *dev); |
| 125 | void (*shutdown)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 126 | |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 127 | int (*online)(struct device *dev); |
| 128 | int (*offline)(struct device *dev); |
| 129 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 130 | int (*suspend)(struct device *dev, pm_message_t state); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 131 | int (*resume)(struct device *dev); |
Kay Sievers | b8c5cec | 2007-02-16 17:33:36 +0100 | [diff] [blame] | 132 | |
Phil Sutter | 582a686 | 2017-01-18 14:04:37 +0100 | [diff] [blame] | 133 | int (*num_vf)(struct device *dev); |
| 134 | |
Nipun Gupta | 07397df | 2018-04-28 08:21:58 +0530 | [diff] [blame^] | 135 | int (*dma_configure)(struct device *dev); |
| 136 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 137 | const struct dev_pm_ops *pm; |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 138 | |
Thierry Reding | b22f643 | 2014-06-27 09:03:12 +0200 | [diff] [blame] | 139 | const struct iommu_ops *iommu_ops; |
Joerg Roedel | ff21776 | 2011-08-26 16:48:26 +0200 | [diff] [blame] | 140 | |
Kay Sievers | 6b6e39a | 2010-11-15 23:13:18 +0100 | [diff] [blame] | 141 | struct subsys_private *p; |
Michal Hocko | be871b7 | 2013-03-12 17:21:19 +0100 | [diff] [blame] | 142 | struct lock_class_key lock_key; |
Robin Murphy | d89e237 | 2017-10-12 16:56:14 +0100 | [diff] [blame] | 143 | |
| 144 | bool force_dma; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | }; |
| 146 | |
Michal Hocko | be871b7 | 2013-03-12 17:21:19 +0100 | [diff] [blame] | 147 | extern int __must_check bus_register(struct bus_type *bus); |
| 148 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 149 | extern void bus_unregister(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 151 | extern int __must_check bus_rescan_devices(struct bus_type *bus); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | /* iterator helpers for buses */ |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 154 | struct subsys_dev_iter { |
| 155 | struct klist_iter ki; |
| 156 | const struct device_type *type; |
| 157 | }; |
Greg Kroah-Hartman | 7cd9c9b | 2012-04-19 19:17:30 -0700 | [diff] [blame] | 158 | void subsys_dev_iter_init(struct subsys_dev_iter *iter, |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 159 | struct bus_type *subsys, |
| 160 | struct device *start, |
| 161 | const struct device_type *type); |
| 162 | struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter); |
| 163 | void subsys_dev_iter_exit(struct subsys_dev_iter *iter); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 165 | int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, |
| 166 | int (*fn)(struct device *dev, void *data)); |
| 167 | struct device *bus_find_device(struct bus_type *bus, struct device *start, |
| 168 | void *data, |
| 169 | int (*match)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 1f9ffc0 | 2008-01-27 10:29:20 -0800 | [diff] [blame] | 170 | struct device *bus_find_device_by_name(struct bus_type *bus, |
| 171 | struct device *start, |
| 172 | const char *name); |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 173 | struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id, |
| 174 | struct device *hint); |
Jean Delvare | cc7447a | 2010-06-16 11:44:18 +0200 | [diff] [blame] | 175 | int bus_for_each_drv(struct bus_type *bus, struct device_driver *start, |
| 176 | void *data, int (*fn)(struct device_driver *, void *)); |
Greg Kroah-Hartman | 99178b0 | 2008-08-26 11:00:57 -0500 | [diff] [blame] | 177 | void bus_sort_breadthfirst(struct bus_type *bus, |
| 178 | int (*compare)(const struct device *a, |
| 179 | const struct device *b)); |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 180 | /* |
| 181 | * Bus notifiers: Get notified of addition/removal of devices |
| 182 | * and binding/unbinding of drivers to devices. |
| 183 | * In the long run, it should be a replacement for the platform |
| 184 | * notify hooks. |
| 185 | */ |
| 186 | struct notifier_block; |
| 187 | |
| 188 | extern int bus_register_notifier(struct bus_type *bus, |
| 189 | struct notifier_block *nb); |
| 190 | extern int bus_unregister_notifier(struct bus_type *bus, |
| 191 | struct notifier_block *nb); |
| 192 | |
| 193 | /* All 4 notifers below get called with the target struct device * |
| 194 | * as an argument. Note that those functions are likely to be called |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 195 | * with the device lock held in the core, so be careful. |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 196 | */ |
| 197 | #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ |
Joerg Roedel | 599bad3 | 2014-09-30 13:02:02 +0200 | [diff] [blame] | 198 | #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */ |
| 199 | #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */ |
| 200 | #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be |
Magnus Damm | 45daef0 | 2010-07-23 19:56:18 +0900 | [diff] [blame] | 201 | bound */ |
Joerg Roedel | 599bad3 | 2014-09-30 13:02:02 +0200 | [diff] [blame] | 202 | #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */ |
| 203 | #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 204 | unbound */ |
Joerg Roedel | 599bad3 | 2014-09-30 13:02:02 +0200 | [diff] [blame] | 205 | #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound |
Joerg Roedel | 309b7d6 | 2009-04-24 14:57:00 +0200 | [diff] [blame] | 206 | from the device */ |
Andy Shevchenko | 14b6257 | 2015-12-04 23:49:17 +0200 | [diff] [blame] | 207 | #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */ |
Benjamin Herrenschmidt | 116af37 | 2006-10-25 13:44:59 +1000 | [diff] [blame] | 208 | |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 209 | extern struct kset *bus_get_kset(struct bus_type *bus); |
Greg Kroah-Hartman | b249072 | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 210 | extern struct klist *bus_get_device_klist(struct bus_type *bus); |
Greg Kroah-Hartman | 0fed80f | 2007-11-01 19:41:16 -0700 | [diff] [blame] | 211 | |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 212 | /** |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 213 | * enum probe_type - device driver probe type to try |
| 214 | * Device drivers may opt in for special handling of their |
| 215 | * respective probe routines. This tells the core what to |
| 216 | * expect and prefer. |
| 217 | * |
Luis R. Rodriguez | d173a13 | 2015-03-30 16:20:06 -0700 | [diff] [blame] | 218 | * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well |
| 219 | * whether probed synchronously or asynchronously. |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 220 | * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which |
| 221 | * probing order is not essential for booting the system may |
| 222 | * opt into executing their probes asynchronously. |
Luis R. Rodriguez | d173a13 | 2015-03-30 16:20:06 -0700 | [diff] [blame] | 223 | * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need |
| 224 | * their probe routines to run synchronously with driver and |
| 225 | * device registration (with the exception of -EPROBE_DEFER |
| 226 | * handling - re-probing always ends up being done asynchronously). |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 227 | * |
| 228 | * Note that the end goal is to switch the kernel to use asynchronous |
| 229 | * probing by default, so annotating drivers with |
| 230 | * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us |
| 231 | * to speed up boot process while we are validating the rest of the |
| 232 | * drivers. |
| 233 | */ |
| 234 | enum probe_type { |
Luis R. Rodriguez | f2411da | 2015-03-30 16:20:05 -0700 | [diff] [blame] | 235 | PROBE_DEFAULT_STRATEGY, |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 236 | PROBE_PREFER_ASYNCHRONOUS, |
Luis R. Rodriguez | d173a13 | 2015-03-30 16:20:06 -0700 | [diff] [blame] | 237 | PROBE_FORCE_SYNCHRONOUS, |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 238 | }; |
| 239 | |
| 240 | /** |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 241 | * struct device_driver - The basic device driver structure |
| 242 | * @name: Name of the device driver. |
| 243 | * @bus: The bus which the device of this driver belongs to. |
| 244 | * @owner: The module owner. |
| 245 | * @mod_name: Used for built-in modules. |
| 246 | * @suppress_bind_attrs: Disables bind/unbind via sysfs. |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 247 | * @probe_type: Type of the probe (synchronous or asynchronous) to use. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 248 | * @of_match_table: The open firmware table. |
Mika Westerberg | 06f64c8 | 2012-10-31 22:44:33 +0100 | [diff] [blame] | 249 | * @acpi_match_table: The ACPI match table. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 250 | * @probe: Called to query the existence of a specific device, |
| 251 | * whether this driver can work with it, and bind the driver |
| 252 | * to a specific device. |
| 253 | * @remove: Called when the device is removed from the system to |
| 254 | * unbind a device from this driver. |
| 255 | * @shutdown: Called at shut-down time to quiesce the device. |
| 256 | * @suspend: Called to put the device to sleep mode. Usually to a |
| 257 | * low power state. |
| 258 | * @resume: Called to bring a device from sleep mode. |
| 259 | * @groups: Default attributes that get created by the driver core |
| 260 | * automatically. |
| 261 | * @pm: Power management operations of the device which matched |
| 262 | * this driver. |
Arend van Spriel | ed4564b | 2018-04-08 23:57:07 +0200 | [diff] [blame] | 263 | * @coredump: Called when sysfs entry is written to. The device driver |
| 264 | * is expected to call the dev_coredump API resulting in a |
| 265 | * uevent. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 266 | * @p: Driver core's private data, no one other than the driver |
| 267 | * core can touch this. |
| 268 | * |
| 269 | * The device driver-model tracks all of the drivers known to the system. |
| 270 | * The main reason for this tracking is to enable the driver core to match |
| 271 | * up drivers with new devices. Once drivers are known objects within the |
| 272 | * system, however, a number of other things become possible. Device drivers |
| 273 | * can export information and configuration variables that are independent |
| 274 | * of any specific device. |
| 275 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 276 | struct device_driver { |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 277 | const char *name; |
| 278 | struct bus_type *bus; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 280 | struct module *owner; |
Dmitry Torokhov | 1a6f2a7 | 2009-10-12 20:17:41 -0700 | [diff] [blame] | 281 | const char *mod_name; /* used for built-in modules */ |
| 282 | |
| 283 | bool suppress_bind_attrs; /* disables bind/unbind via sysfs */ |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 284 | enum probe_type probe_type; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 285 | |
Grant Likely | 597b9d1 | 2010-04-13 16:13:01 -0700 | [diff] [blame] | 286 | const struct of_device_id *of_match_table; |
Mika Westerberg | 06f64c8 | 2012-10-31 22:44:33 +0100 | [diff] [blame] | 287 | const struct acpi_device_id *acpi_match_table; |
Grant Likely | 597b9d1 | 2010-04-13 16:13:01 -0700 | [diff] [blame] | 288 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 289 | int (*probe) (struct device *dev); |
| 290 | int (*remove) (struct device *dev); |
| 291 | void (*shutdown) (struct device *dev); |
| 292 | int (*suspend) (struct device *dev, pm_message_t state); |
| 293 | int (*resume) (struct device *dev); |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 294 | const struct attribute_group **groups; |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 295 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 296 | const struct dev_pm_ops *pm; |
Arend van Spriel | ed4564b | 2018-04-08 23:57:07 +0200 | [diff] [blame] | 297 | void (*coredump) (struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 298 | |
Greg Kroah-Hartman | e5dd127 | 2007-11-28 15:59:15 -0800 | [diff] [blame] | 299 | struct driver_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 300 | }; |
| 301 | |
| 302 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 303 | extern int __must_check driver_register(struct device_driver *drv); |
| 304 | extern void driver_unregister(struct device_driver *drv); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 305 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 306 | extern struct device_driver *driver_find(const char *name, |
| 307 | struct bus_type *bus); |
Greg Kroah-Hartman | d779249 | 2006-07-18 10:59:59 -0700 | [diff] [blame] | 308 | extern int driver_probe_done(void); |
Ming Lei | b23530e | 2009-02-21 16:45:07 +0800 | [diff] [blame] | 309 | extern void wait_for_device_probe(void); |
Arjan van de Ven | 216773a | 2009-02-14 01:59:06 +0100 | [diff] [blame] | 310 | |
Robert P. J. Day | 405ae7d | 2007-02-17 19:13:42 +0100 | [diff] [blame] | 311 | /* sysfs interface for exporting driver attributes */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 312 | |
| 313 | struct driver_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 314 | struct attribute attr; |
| 315 | ssize_t (*show)(struct device_driver *driver, char *buf); |
| 316 | ssize_t (*store)(struct device_driver *driver, const char *buf, |
| 317 | size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 318 | }; |
| 319 | |
Greg Kroah-Hartman | ced321b | 2013-07-14 16:05:54 -0700 | [diff] [blame] | 320 | #define DRIVER_ATTR_RW(_name) \ |
| 321 | struct driver_attribute driver_attr_##_name = __ATTR_RW(_name) |
| 322 | #define DRIVER_ATTR_RO(_name) \ |
| 323 | struct driver_attribute driver_attr_##_name = __ATTR_RO(_name) |
Greg Kroah-Hartman | 1130c55 | 2013-08-23 15:02:56 -0700 | [diff] [blame] | 324 | #define DRIVER_ATTR_WO(_name) \ |
| 325 | struct driver_attribute driver_attr_##_name = __ATTR_WO(_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 326 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 327 | extern int __must_check driver_create_file(struct device_driver *driver, |
Phil Carmody | 099c2f2 | 2009-12-18 15:34:21 +0200 | [diff] [blame] | 328 | const struct driver_attribute *attr); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 329 | extern void driver_remove_file(struct device_driver *driver, |
Phil Carmody | 099c2f2 | 2009-12-18 15:34:21 +0200 | [diff] [blame] | 330 | const struct driver_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 331 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 332 | extern int __must_check driver_for_each_device(struct device_driver *drv, |
| 333 | struct device *start, |
| 334 | void *data, |
| 335 | int (*fn)(struct device *dev, |
| 336 | void *)); |
| 337 | struct device *driver_find_device(struct device_driver *drv, |
| 338 | struct device *start, void *data, |
| 339 | int (*match)(struct device *dev, void *data)); |
mochel@digitalimplant.org | fae3cd0 | 2005-03-21 10:59:56 -0800 | [diff] [blame] | 340 | |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 341 | /** |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 342 | * struct subsys_interface - interfaces to device functions |
Randy Dunlap | 2eda013 | 2012-01-21 11:02:51 -0800 | [diff] [blame] | 343 | * @name: name of the device function |
| 344 | * @subsys: subsytem of the devices to attach to |
| 345 | * @node: the list of functions registered at the subsystem |
| 346 | * @add_dev: device hookup to device function handler |
| 347 | * @remove_dev: device hookup to device function handler |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 348 | * |
| 349 | * Simple interfaces attached to a subsystem. Multiple interfaces can |
| 350 | * attach to a subsystem and its devices. Unlike drivers, they do not |
| 351 | * exclusively claim or control devices. Interfaces usually represent |
| 352 | * a specific functionality of a subsystem/class of devices. |
| 353 | */ |
| 354 | struct subsys_interface { |
| 355 | const char *name; |
| 356 | struct bus_type *subsys; |
| 357 | struct list_head node; |
| 358 | int (*add_dev)(struct device *dev, struct subsys_interface *sif); |
Viresh Kumar | 71db87b | 2015-07-30 15:04:01 +0530 | [diff] [blame] | 359 | void (*remove_dev)(struct device *dev, struct subsys_interface *sif); |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 360 | }; |
| 361 | |
| 362 | int subsys_interface_register(struct subsys_interface *sif); |
| 363 | void subsys_interface_unregister(struct subsys_interface *sif); |
| 364 | |
| 365 | int subsys_system_register(struct bus_type *subsys, |
| 366 | const struct attribute_group **groups); |
Tejun Heo | d73ce00 | 2013-03-12 11:30:05 -0700 | [diff] [blame] | 367 | int subsys_virtual_register(struct bus_type *subsys, |
| 368 | const struct attribute_group **groups); |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 369 | |
| 370 | /** |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 371 | * struct class - device classes |
| 372 | * @name: Name of the class. |
| 373 | * @owner: The module owner. |
Greg Kroah-Hartman | ced6473 | 2016-11-28 16:41:41 +0100 | [diff] [blame] | 374 | * @class_groups: Default attributes of this class. |
Greg Kroah-Hartman | d05a6f9 | 2013-07-14 16:05:58 -0700 | [diff] [blame] | 375 | * @dev_groups: Default attributes of the devices that belong to the class. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 376 | * @dev_kobj: The kobject that represents this class and links it into the hierarchy. |
| 377 | * @dev_uevent: Called when a device is added, removed from this class, or a |
| 378 | * few other things that generate uevents to add the environment |
| 379 | * variables. |
| 380 | * @devnode: Callback to provide the devtmpfs. |
| 381 | * @class_release: Called to release this class. |
| 382 | * @dev_release: Called to release the device. |
Michal Suchanek | 7521621 | 2017-08-11 15:44:43 +0200 | [diff] [blame] | 383 | * @shutdown_pre: Called at shut-down time before driver shutdown. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 384 | * @ns_type: Callbacks so sysfs can detemine namespaces. |
| 385 | * @namespace: Namespace of the device belongs to this class. |
| 386 | * @pm: The default device power management operations of this class. |
| 387 | * @p: The private data of the driver core, no one other than the |
| 388 | * driver core can touch this. |
| 389 | * |
| 390 | * A class is a higher-level view of a device that abstracts out low-level |
| 391 | * implementation details. Drivers may see a SCSI disk or an ATA disk, but, |
| 392 | * at the class level, they are all simply disks. Classes allow user space |
| 393 | * to work with devices based on what they do, rather than how they are |
| 394 | * connected or how they work. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 395 | */ |
| 396 | struct class { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 397 | const char *name; |
| 398 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 399 | |
Greg Kroah-Hartman | ced6473 | 2016-11-28 16:41:41 +0100 | [diff] [blame] | 400 | const struct attribute_group **class_groups; |
Greg Kroah-Hartman | d05a6f9 | 2013-07-14 16:05:58 -0700 | [diff] [blame] | 401 | const struct attribute_group **dev_groups; |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 402 | struct kobject *dev_kobj; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 403 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 404 | int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); |
Al Viro | 2c9ede5 | 2011-07-23 20:24:48 -0400 | [diff] [blame] | 405 | char *(*devnode)(struct device *dev, umode_t *mode); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 406 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 407 | void (*class_release)(struct class *class); |
| 408 | void (*dev_release)(struct device *dev); |
Linus Torvalds | 7c8265f | 2006-06-24 14:50:29 -0700 | [diff] [blame] | 409 | |
Michal Suchanek | 7521621 | 2017-08-11 15:44:43 +0200 | [diff] [blame] | 410 | int (*shutdown_pre)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 411 | |
Eric W. Biederman | bc451f2 | 2010-03-30 11:31:25 -0700 | [diff] [blame] | 412 | const struct kobj_ns_type_operations *ns_type; |
| 413 | const void *(*namespace)(struct device *dev); |
| 414 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 415 | const struct dev_pm_ops *pm; |
| 416 | |
Kay Sievers | 6b6e39a | 2010-11-15 23:13:18 +0100 | [diff] [blame] | 417 | struct subsys_private *p; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 418 | }; |
| 419 | |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 420 | struct class_dev_iter { |
| 421 | struct klist_iter ki; |
| 422 | const struct device_type *type; |
| 423 | }; |
| 424 | |
Dan Williams | e105b8b | 2008-04-21 10:51:07 -0700 | [diff] [blame] | 425 | extern struct kobject *sysfs_dev_block_kobj; |
| 426 | extern struct kobject *sysfs_dev_char_kobj; |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 427 | extern int __must_check __class_register(struct class *class, |
| 428 | struct lock_class_key *key); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 429 | extern void class_unregister(struct class *class); |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 430 | |
| 431 | /* This is a #define to keep the compiler from merging different |
| 432 | * instances of the __key variable */ |
| 433 | #define class_register(class) \ |
| 434 | ({ \ |
| 435 | static struct lock_class_key __key; \ |
| 436 | __class_register(class, &__key); \ |
| 437 | }) |
| 438 | |
Jean Delvare | 4622709 | 2009-08-04 12:55:34 +0200 | [diff] [blame] | 439 | struct class_compat; |
| 440 | struct class_compat *class_compat_register(const char *name); |
| 441 | void class_compat_unregister(struct class_compat *cls); |
| 442 | int class_compat_create_link(struct class_compat *cls, struct device *dev, |
| 443 | struct device *device_link); |
| 444 | void class_compat_remove_link(struct class_compat *cls, struct device *dev, |
| 445 | struct device *device_link); |
| 446 | |
Greg Kroah-Hartman | 7cd9c9b | 2012-04-19 19:17:30 -0700 | [diff] [blame] | 447 | extern void class_dev_iter_init(struct class_dev_iter *iter, |
| 448 | struct class *class, |
| 449 | struct device *start, |
| 450 | const struct device_type *type); |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 451 | extern struct device *class_dev_iter_next(struct class_dev_iter *iter); |
| 452 | extern void class_dev_iter_exit(struct class_dev_iter *iter); |
| 453 | |
Greg Kroah-Hartman | 93562b5 | 2008-05-22 17:21:08 -0400 | [diff] [blame] | 454 | extern int class_for_each_device(struct class *class, struct device *start, |
| 455 | void *data, |
Dave Young | fd04897 | 2008-01-22 15:27:08 +0800 | [diff] [blame] | 456 | int (*fn)(struct device *dev, void *data)); |
Greg Kroah-Hartman | 695794a | 2008-05-22 17:21:08 -0400 | [diff] [blame] | 457 | extern struct device *class_find_device(struct class *class, |
Michał Mirosław | 9f3b795 | 2013-02-01 20:40:17 +0100 | [diff] [blame] | 458 | struct device *start, const void *data, |
| 459 | int (*match)(struct device *, const void *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 460 | |
| 461 | struct class_attribute { |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 462 | struct attribute attr; |
Andi Kleen | 28812fe | 2010-01-05 12:48:07 +0100 | [diff] [blame] | 463 | ssize_t (*show)(struct class *class, struct class_attribute *attr, |
| 464 | char *buf); |
| 465 | ssize_t (*store)(struct class *class, struct class_attribute *attr, |
| 466 | const char *buf, size_t count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 467 | }; |
| 468 | |
Greg Kroah-Hartman | ced321b | 2013-07-14 16:05:54 -0700 | [diff] [blame] | 469 | #define CLASS_ATTR_RW(_name) \ |
| 470 | struct class_attribute class_attr_##_name = __ATTR_RW(_name) |
| 471 | #define CLASS_ATTR_RO(_name) \ |
| 472 | struct class_attribute class_attr_##_name = __ATTR_RO(_name) |
Greg Kroah-Hartman | 2027cbc | 2016-11-22 18:31:49 +0100 | [diff] [blame] | 473 | #define CLASS_ATTR_WO(_name) \ |
| 474 | struct class_attribute class_attr_##_name = __ATTR_WO(_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 475 | |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 476 | extern int __must_check class_create_file_ns(struct class *class, |
| 477 | const struct class_attribute *attr, |
| 478 | const void *ns); |
| 479 | extern void class_remove_file_ns(struct class *class, |
| 480 | const struct class_attribute *attr, |
| 481 | const void *ns); |
| 482 | |
| 483 | static inline int __must_check class_create_file(struct class *class, |
| 484 | const struct class_attribute *attr) |
| 485 | { |
| 486 | return class_create_file_ns(class, attr, NULL); |
| 487 | } |
| 488 | |
| 489 | static inline void class_remove_file(struct class *class, |
| 490 | const struct class_attribute *attr) |
| 491 | { |
| 492 | return class_remove_file_ns(class, attr, NULL); |
| 493 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 494 | |
Andi Kleen | 869dfc8 | 2010-01-05 12:48:08 +0100 | [diff] [blame] | 495 | /* Simple class attribute that is just a static string */ |
Andi Kleen | 869dfc8 | 2010-01-05 12:48:08 +0100 | [diff] [blame] | 496 | struct class_attribute_string { |
| 497 | struct class_attribute attr; |
| 498 | char *str; |
| 499 | }; |
| 500 | |
| 501 | /* Currently read-only only */ |
| 502 | #define _CLASS_ATTR_STRING(_name, _mode, _str) \ |
| 503 | { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } |
| 504 | #define CLASS_ATTR_STRING(_name, _mode, _str) \ |
| 505 | struct class_attribute_string class_attr_##_name = \ |
| 506 | _CLASS_ATTR_STRING(_name, _mode, _str) |
| 507 | |
| 508 | extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr, |
| 509 | char *buf); |
| 510 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 511 | struct class_interface { |
| 512 | struct list_head node; |
| 513 | struct class *class; |
| 514 | |
Greg Kroah-Hartman | c47ed21 | 2006-09-13 15:34:05 +0200 | [diff] [blame] | 515 | int (*add_dev) (struct device *, struct class_interface *); |
| 516 | void (*remove_dev) (struct device *, struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 517 | }; |
| 518 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 519 | extern int __must_check class_interface_register(struct class_interface *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 520 | extern void class_interface_unregister(struct class_interface *); |
| 521 | |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 522 | extern struct class * __must_check __class_create(struct module *owner, |
| 523 | const char *name, |
| 524 | struct lock_class_key *key); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 525 | extern void class_destroy(struct class *cls); |
gregkh@suse.de | e9ba636 | 2005-03-15 11:54:21 -0800 | [diff] [blame] | 526 | |
Matthew Wilcox | d2a3b91 | 2008-05-28 09:28:39 -0700 | [diff] [blame] | 527 | /* This is a #define to keep the compiler from merging different |
| 528 | * instances of the __key variable */ |
| 529 | #define class_create(owner, name) \ |
| 530 | ({ \ |
| 531 | static struct lock_class_key __key; \ |
| 532 | __class_create(owner, name, &__key); \ |
| 533 | }) |
| 534 | |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 535 | /* |
| 536 | * The type of device, "struct device" is embedded in. A class |
| 537 | * or bus can contain devices of different types |
| 538 | * like "partitions" and "disks", "mouse" and "event". |
| 539 | * This identifies the device type and carries type-specific |
| 540 | * information, equivalent to the kobj_type of a kobject. |
| 541 | * If "name" is specified, the uevent will contain it in |
| 542 | * the DEVTYPE variable. |
| 543 | */ |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 544 | struct device_type { |
Kay Sievers | 414264f | 2007-03-12 21:08:57 +0100 | [diff] [blame] | 545 | const char *name; |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 546 | const struct attribute_group **groups; |
Kay Sievers | 7eff2e7 | 2007-08-14 15:15:12 +0200 | [diff] [blame] | 547 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
Kay Sievers | 3c2670e | 2013-04-06 09:56:00 -0700 | [diff] [blame] | 548 | char *(*devnode)(struct device *dev, umode_t *mode, |
Greg Kroah-Hartman | 4e4098a | 2013-04-11 11:43:29 -0700 | [diff] [blame] | 549 | kuid_t *uid, kgid_t *gid); |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 550 | void (*release)(struct device *dev); |
Rafael J. Wysocki | 1eede07 | 2008-05-20 23:00:01 +0200 | [diff] [blame] | 551 | |
Dmitry Torokhov | 8150f32 | 2009-07-24 22:11:32 -0700 | [diff] [blame] | 552 | const struct dev_pm_ops *pm; |
Kay Sievers | f9f852d | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 553 | }; |
| 554 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 555 | /* interface for exporting device attributes */ |
| 556 | struct device_attribute { |
| 557 | struct attribute attr; |
| 558 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, |
| 559 | char *buf); |
| 560 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, |
| 561 | const char *buf, size_t count); |
| 562 | }; |
| 563 | |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 564 | struct dev_ext_attribute { |
| 565 | struct device_attribute attr; |
| 566 | void *var; |
| 567 | }; |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 568 | |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 569 | ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr, |
| 570 | char *buf); |
| 571 | ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr, |
| 572 | const char *buf, size_t count); |
| 573 | ssize_t device_show_int(struct device *dev, struct device_attribute *attr, |
| 574 | char *buf); |
| 575 | ssize_t device_store_int(struct device *dev, struct device_attribute *attr, |
| 576 | const char *buf, size_t count); |
Borislav Petkov | 9187239 | 2012-10-09 19:52:05 +0200 | [diff] [blame] | 577 | ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, |
| 578 | char *buf); |
| 579 | ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, |
| 580 | const char *buf, size_t count); |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 581 | |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 582 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 583 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) |
Christophe Leroy | 7fda910 | 2017-12-18 11:08:29 +0100 | [diff] [blame] | 584 | #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \ |
| 585 | struct device_attribute dev_attr_##_name = \ |
| 586 | __ATTR_PREALLOC(_name, _mode, _show, _store) |
Greg Kroah-Hartman | ced321b | 2013-07-14 16:05:54 -0700 | [diff] [blame] | 587 | #define DEVICE_ATTR_RW(_name) \ |
| 588 | struct device_attribute dev_attr_##_name = __ATTR_RW(_name) |
| 589 | #define DEVICE_ATTR_RO(_name) \ |
| 590 | struct device_attribute dev_attr_##_name = __ATTR_RO(_name) |
Greg Kroah-Hartman | 1130c55 | 2013-08-23 15:02:56 -0700 | [diff] [blame] | 591 | #define DEVICE_ATTR_WO(_name) \ |
| 592 | struct device_attribute dev_attr_##_name = __ATTR_WO(_name) |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 593 | #define DEVICE_ULONG_ATTR(_name, _mode, _var) \ |
| 594 | struct dev_ext_attribute dev_attr_##_name = \ |
| 595 | { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) } |
| 596 | #define DEVICE_INT_ATTR(_name, _mode, _var) \ |
| 597 | struct dev_ext_attribute dev_attr_##_name = \ |
Michael Davidson | 9475818 | 2012-05-03 16:19:02 -0700 | [diff] [blame] | 598 | { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) } |
Borislav Petkov | 9187239 | 2012-10-09 19:52:05 +0200 | [diff] [blame] | 599 | #define DEVICE_BOOL_ATTR(_name, _mode, _var) \ |
| 600 | struct dev_ext_attribute dev_attr_##_name = \ |
| 601 | { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) } |
Alan Stern | 356c05d | 2012-05-14 13:30:03 -0400 | [diff] [blame] | 602 | #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ |
| 603 | struct device_attribute dev_attr_##_name = \ |
| 604 | __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) |
Kay Sievers | a7fd670 | 2005-10-01 14:49:43 +0200 | [diff] [blame] | 605 | |
Greg Kroah-Hartman | b9d4e71 | 2012-01-04 15:05:10 -0800 | [diff] [blame] | 606 | extern int device_create_file(struct device *device, |
| 607 | const struct device_attribute *entry); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 608 | extern void device_remove_file(struct device *dev, |
Phil Carmody | 26579ab | 2009-12-18 15:34:19 +0200 | [diff] [blame] | 609 | const struct device_attribute *attr); |
Tejun Heo | 6b0afc2 | 2014-02-03 14:03:01 -0500 | [diff] [blame] | 610 | extern bool device_remove_file_self(struct device *dev, |
| 611 | const struct device_attribute *attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 612 | extern int __must_check device_create_bin_file(struct device *dev, |
Phil Carmody | 66ecb92 | 2009-12-18 15:34:20 +0200 | [diff] [blame] | 613 | const struct bin_attribute *attr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 614 | extern void device_remove_bin_file(struct device *dev, |
Phil Carmody | 66ecb92 | 2009-12-18 15:34:20 +0200 | [diff] [blame] | 615 | const struct bin_attribute *attr); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 616 | |
| 617 | /* device resource management */ |
| 618 | typedef void (*dr_release_t)(struct device *dev, void *res); |
| 619 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); |
| 620 | |
| 621 | #ifdef CONFIG_DEBUG_DEVRES |
Dan Williams | 7c68394 | 2015-10-05 20:35:55 -0400 | [diff] [blame] | 622 | extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 623 | int nid, const char *name) __malloc; |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 624 | #define devres_alloc(release, size, gfp) \ |
Dan Williams | 7c68394 | 2015-10-05 20:35:55 -0400 | [diff] [blame] | 625 | __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release) |
| 626 | #define devres_alloc_node(release, size, gfp, nid) \ |
| 627 | __devres_alloc_node(release, size, gfp, nid, #release) |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 628 | #else |
Dan Williams | 7c68394 | 2015-10-05 20:35:55 -0400 | [diff] [blame] | 629 | extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 630 | int nid) __malloc; |
Dan Williams | 7c68394 | 2015-10-05 20:35:55 -0400 | [diff] [blame] | 631 | static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp) |
| 632 | { |
| 633 | return devres_alloc_node(release, size, gfp, NUMA_NO_NODE); |
| 634 | } |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 635 | #endif |
Dan Williams | 7c68394 | 2015-10-05 20:35:55 -0400 | [diff] [blame] | 636 | |
Ming Lei | bddb1b9 | 2012-08-04 12:01:26 +0800 | [diff] [blame] | 637 | extern void devres_for_each_res(struct device *dev, dr_release_t release, |
| 638 | dr_match_t match, void *match_data, |
| 639 | void (*fn)(struct device *, void *, void *), |
| 640 | void *data); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 641 | extern void devres_free(void *res); |
| 642 | extern void devres_add(struct device *dev, void *res); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 643 | extern void *devres_find(struct device *dev, dr_release_t release, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 644 | dr_match_t match, void *match_data); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 645 | extern void *devres_get(struct device *dev, void *new_res, |
| 646 | dr_match_t match, void *match_data); |
| 647 | extern void *devres_remove(struct device *dev, dr_release_t release, |
| 648 | dr_match_t match, void *match_data); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 649 | extern int devres_destroy(struct device *dev, dr_release_t release, |
| 650 | dr_match_t match, void *match_data); |
Mark Brown | d926d0e | 2012-05-03 18:15:13 +0100 | [diff] [blame] | 651 | extern int devres_release(struct device *dev, dr_release_t release, |
| 652 | dr_match_t match, void *match_data); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 653 | |
| 654 | /* devres group */ |
| 655 | extern void * __must_check devres_open_group(struct device *dev, void *id, |
| 656 | gfp_t gfp); |
| 657 | extern void devres_close_group(struct device *dev, void *id); |
| 658 | extern void devres_remove_group(struct device *dev, void *id); |
| 659 | extern int devres_release_group(struct device *dev, void *id); |
| 660 | |
Joe Perches | 64c862a8 | 2013-10-11 13:11:38 -0700 | [diff] [blame] | 661 | /* managed devm_k.alloc/kfree for device drivers */ |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 662 | extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc; |
Nicolas Iooss | 8db1486 | 2015-07-17 16:23:42 -0700 | [diff] [blame] | 663 | extern __printf(3, 0) |
| 664 | char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt, |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 665 | va_list ap) __malloc; |
Geert Uytterhoeven | bef59c5 | 2014-08-20 15:26:35 +0200 | [diff] [blame] | 666 | extern __printf(3, 4) |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 667 | char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc; |
Joe Perches | 64c862a8 | 2013-10-11 13:11:38 -0700 | [diff] [blame] | 668 | static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp) |
| 669 | { |
| 670 | return devm_kmalloc(dev, size, gfp | __GFP_ZERO); |
| 671 | } |
| 672 | static inline void *devm_kmalloc_array(struct device *dev, |
| 673 | size_t n, size_t size, gfp_t flags) |
| 674 | { |
| 675 | if (size != 0 && n > SIZE_MAX / size) |
| 676 | return NULL; |
| 677 | return devm_kmalloc(dev, n * size, flags); |
| 678 | } |
| 679 | static inline void *devm_kcalloc(struct device *dev, |
| 680 | size_t n, size_t size, gfp_t flags) |
| 681 | { |
| 682 | return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO); |
| 683 | } |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 684 | extern void devm_kfree(struct device *dev, void *p); |
Rasmus Villemoes | 48a2705 | 2016-05-19 17:10:55 -0700 | [diff] [blame] | 685 | extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc; |
Srinivas Pandruvada | 3046365 | 2014-04-29 00:51:00 +0100 | [diff] [blame] | 686 | extern void *devm_kmemdup(struct device *dev, const void *src, size_t len, |
| 687 | gfp_t gfp); |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 688 | |
Eli Billauer | 43339be | 2014-05-16 11:26:35 +0300 | [diff] [blame] | 689 | extern unsigned long devm_get_free_pages(struct device *dev, |
| 690 | gfp_t gfp_mask, unsigned int order); |
| 691 | extern void devm_free_pages(struct device *dev, unsigned long addr); |
Greg Kroah-Hartman | 2589f188 | 2006-09-19 09:39:19 -0700 | [diff] [blame] | 692 | |
Thierry Reding | 7509657 | 2013-01-21 11:08:54 +0100 | [diff] [blame] | 693 | void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res); |
Wolfram Sang | 72f8c0b | 2011-10-25 15:16:47 +0200 | [diff] [blame] | 694 | |
Dmitry Torokhov | d6b0c58 | 2013-02-23 13:11:14 -0800 | [diff] [blame] | 695 | /* allows to add/remove a custom action to devres stack */ |
| 696 | int devm_add_action(struct device *dev, void (*action)(void *), void *data); |
| 697 | void devm_remove_action(struct device *dev, void (*action)(void *), void *data); |
| 698 | |
Sudip Mukherjee | a3499e9 | 2015-12-23 17:57:19 +0530 | [diff] [blame] | 699 | static inline int devm_add_action_or_reset(struct device *dev, |
| 700 | void (*action)(void *), void *data) |
| 701 | { |
| 702 | int ret; |
| 703 | |
| 704 | ret = devm_add_action(dev, action, data); |
| 705 | if (ret) |
| 706 | action(data); |
| 707 | |
| 708 | return ret; |
| 709 | } |
| 710 | |
Madalin Bucur | ff86aae | 2016-11-15 10:41:01 +0200 | [diff] [blame] | 711 | /** |
| 712 | * devm_alloc_percpu - Resource-managed alloc_percpu |
| 713 | * @dev: Device to allocate per-cpu memory for |
| 714 | * @type: Type to allocate per-cpu memory for |
| 715 | * |
| 716 | * Managed alloc_percpu. Per-cpu memory allocated with this function is |
| 717 | * automatically freed on driver detach. |
| 718 | * |
| 719 | * RETURNS: |
| 720 | * Pointer to allocated memory on success, NULL on failure. |
| 721 | */ |
| 722 | #define devm_alloc_percpu(dev, type) \ |
| 723 | ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \ |
| 724 | __alignof__(type))) |
| 725 | |
| 726 | void __percpu *__devm_alloc_percpu(struct device *dev, size_t size, |
| 727 | size_t align); |
| 728 | void devm_free_percpu(struct device *dev, void __percpu *pdata); |
| 729 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 730 | struct device_dma_parameters { |
| 731 | /* |
| 732 | * a low level driver may set these to teach IOMMU code about |
| 733 | * sg limitations. |
| 734 | */ |
| 735 | unsigned int max_segment_size; |
| 736 | unsigned long segment_boundary_mask; |
| 737 | }; |
| 738 | |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 739 | /** |
Heikki Krogerus | f2d9b66 | 2018-03-20 15:57:02 +0300 | [diff] [blame] | 740 | * struct device_connection - Device Connection Descriptor |
| 741 | * @endpoint: The names of the two devices connected together |
| 742 | * @id: Unique identifier for the connection |
| 743 | * @list: List head, private, for internal use only |
| 744 | */ |
| 745 | struct device_connection { |
| 746 | const char *endpoint[2]; |
| 747 | const char *id; |
| 748 | struct list_head list; |
| 749 | }; |
| 750 | |
| 751 | void *device_connection_find_match(struct device *dev, const char *con_id, |
| 752 | void *data, |
| 753 | void *(*match)(struct device_connection *con, |
| 754 | int ep, void *data)); |
| 755 | |
| 756 | struct device *device_connection_find(struct device *dev, const char *con_id); |
| 757 | |
| 758 | void device_connection_add(struct device_connection *con); |
| 759 | void device_connection_remove(struct device_connection *con); |
| 760 | |
| 761 | /** |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 762 | * enum device_link_state - Device link states. |
| 763 | * @DL_STATE_NONE: The presence of the drivers is not being tracked. |
| 764 | * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. |
| 765 | * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. |
| 766 | * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). |
| 767 | * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. |
| 768 | * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. |
| 769 | */ |
| 770 | enum device_link_state { |
| 771 | DL_STATE_NONE = -1, |
| 772 | DL_STATE_DORMANT = 0, |
| 773 | DL_STATE_AVAILABLE, |
| 774 | DL_STATE_CONSUMER_PROBE, |
| 775 | DL_STATE_ACTIVE, |
| 776 | DL_STATE_SUPPLIER_UNBIND, |
| 777 | }; |
| 778 | |
| 779 | /* |
| 780 | * Device link flags. |
| 781 | * |
| 782 | * STATELESS: The core won't track the presence of supplier/consumer drivers. |
| 783 | * AUTOREMOVE: Remove this link automatically on consumer driver unbind. |
Rafael J. Wysocki | 21d5c57 | 2016-10-30 17:32:31 +0100 | [diff] [blame] | 784 | * PM_RUNTIME: If set, the runtime PM framework will use this link. |
| 785 | * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 786 | */ |
| 787 | #define DL_FLAG_STATELESS BIT(0) |
| 788 | #define DL_FLAG_AUTOREMOVE BIT(1) |
Rafael J. Wysocki | 21d5c57 | 2016-10-30 17:32:31 +0100 | [diff] [blame] | 789 | #define DL_FLAG_PM_RUNTIME BIT(2) |
| 790 | #define DL_FLAG_RPM_ACTIVE BIT(3) |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 791 | |
| 792 | /** |
| 793 | * struct device_link - Device link representation. |
| 794 | * @supplier: The device on the supplier end of the link. |
| 795 | * @s_node: Hook to the supplier device's list of links to consumers. |
| 796 | * @consumer: The device on the consumer end of the link. |
| 797 | * @c_node: Hook to the consumer device's list of links to suppliers. |
| 798 | * @status: The state of the link (with respect to the presence of drivers). |
| 799 | * @flags: Link flags. |
Rafael J. Wysocki | 21d5c57 | 2016-10-30 17:32:31 +0100 | [diff] [blame] | 800 | * @rpm_active: Whether or not the consumer device is runtime-PM-active. |
Lukas Wunner | ead18c2 | 2018-02-10 19:27:12 +0100 | [diff] [blame] | 801 | * @kref: Count repeated addition of the same link. |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 802 | * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks. |
| 803 | */ |
| 804 | struct device_link { |
| 805 | struct device *supplier; |
| 806 | struct list_head s_node; |
| 807 | struct device *consumer; |
| 808 | struct list_head c_node; |
| 809 | enum device_link_state status; |
| 810 | u32 flags; |
Rafael J. Wysocki | 21d5c57 | 2016-10-30 17:32:31 +0100 | [diff] [blame] | 811 | bool rpm_active; |
Lukas Wunner | ead18c2 | 2018-02-10 19:27:12 +0100 | [diff] [blame] | 812 | struct kref kref; |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 813 | #ifdef CONFIG_SRCU |
| 814 | struct rcu_head rcu_head; |
| 815 | #endif |
| 816 | }; |
| 817 | |
| 818 | /** |
| 819 | * enum dl_dev_state - Device driver presence tracking information. |
| 820 | * @DL_DEV_NO_DRIVER: There is no driver attached to the device. |
| 821 | * @DL_DEV_PROBING: A driver is probing. |
| 822 | * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. |
| 823 | * @DL_DEV_UNBINDING: The driver is unbinding from the device. |
| 824 | */ |
| 825 | enum dl_dev_state { |
| 826 | DL_DEV_NO_DRIVER = 0, |
| 827 | DL_DEV_PROBING, |
| 828 | DL_DEV_DRIVER_BOUND, |
| 829 | DL_DEV_UNBINDING, |
| 830 | }; |
| 831 | |
| 832 | /** |
| 833 | * struct dev_links_info - Device data related to device links. |
| 834 | * @suppliers: List of links to supplier devices. |
| 835 | * @consumers: List of links to consumer devices. |
| 836 | * @status: Driver status information. |
| 837 | */ |
| 838 | struct dev_links_info { |
| 839 | struct list_head suppliers; |
| 840 | struct list_head consumers; |
| 841 | enum dl_dev_state status; |
| 842 | }; |
| 843 | |
| 844 | /** |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 845 | * struct device - The basic device structure |
| 846 | * @parent: The device's "parent" device, the device to which it is attached. |
| 847 | * In most cases, a parent device is some sort of bus or host |
| 848 | * controller. If parent is NULL, the device, is a top-level device, |
| 849 | * which is not usually what you want. |
| 850 | * @p: Holds the private data of the driver core portions of the device. |
| 851 | * See the comment of the struct device_private for detail. |
| 852 | * @kobj: A top-level, abstract class from which other classes are derived. |
| 853 | * @init_name: Initial name of the device. |
| 854 | * @type: The type of device. |
| 855 | * This identifies the device type and carries type-specific |
| 856 | * information. |
| 857 | * @mutex: Mutex to synchronize calls to its driver. |
| 858 | * @bus: Type of bus device is on. |
| 859 | * @driver: Which driver has allocated this |
| 860 | * @platform_data: Platform data specific to the device. |
| 861 | * Example: For devices on custom boards, as typical of embedded |
| 862 | * and SOC based hardware, Linux often uses platform_data to point |
| 863 | * to board-specific structures describing devices and how they |
| 864 | * are wired. That can include what ports are available, chip |
| 865 | * variants, which GPIO pins act in what additional roles, and so |
| 866 | * on. This shrinks the "Board Support Packages" (BSPs) and |
| 867 | * minimizes board-specific #ifdefs in drivers. |
Jean Delvare | 1bb6c08 | 2014-04-14 12:54:47 +0200 | [diff] [blame] | 868 | * @driver_data: Private pointer for driver specific info. |
Lukas Wunner | 64df114 | 2016-12-04 13:10:04 +0100 | [diff] [blame] | 869 | * @links: Links to suppliers and consumers of this device. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 870 | * @power: For device power management. |
Geert Uytterhoeven | 74378c5 | 2017-09-05 20:16:27 +0200 | [diff] [blame] | 871 | * See Documentation/driver-api/pm/devices.rst for details. |
Rafael J. Wysocki | 564b905 | 2011-06-23 01:52:55 +0200 | [diff] [blame] | 872 | * @pm_domain: Provide callbacks that are executed during system suspend, |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 873 | * hibernation, system resume and during runtime PM transitions |
| 874 | * along with subsystem-level and driver-level callbacks. |
Linus Walleij | ab78029 | 2013-01-22 10:56:14 -0700 | [diff] [blame] | 875 | * @pins: For device pin management. |
Ludovic Desroches | 0cca6c8 | 2017-08-06 16:00:05 +0200 | [diff] [blame] | 876 | * See Documentation/driver-api/pinctl.rst for details. |
Jiang Liu | 4a7cc83 | 2015-07-09 16:00:44 +0800 | [diff] [blame] | 877 | * @msi_list: Hosts MSI descriptors |
Marc Zyngier | f1421db | 2015-07-28 14:46:10 +0100 | [diff] [blame] | 878 | * @msi_domain: The generic MSI domain this device is using. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 879 | * @numa_node: NUMA node this device is close to. |
Jonathan Corbet | 6a7a817 | 2017-08-24 16:09:10 -0600 | [diff] [blame] | 880 | * @dma_ops: DMA mapping operations for this device. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 881 | * @dma_mask: Dma mask (if dma'ble device). |
| 882 | * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all |
| 883 | * hardware supports 64-bit addresses for consistent allocations |
| 884 | * such descriptors. |
Santosh Shilimkar | 8febcaa | 2014-04-24 11:30:01 -0400 | [diff] [blame] | 885 | * @dma_pfn_offset: offset of DMA memory range relatively of RAM |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 886 | * @dma_parms: A low level driver may set these to teach IOMMU code about |
| 887 | * segment limitations. |
| 888 | * @dma_pools: Dma pools (if dma'ble device). |
| 889 | * @dma_mem: Internal for coherent mem override. |
Michael Opdenacker | bfd63cd | 2013-06-26 05:57:06 +0200 | [diff] [blame] | 890 | * @cma_area: Contiguous memory area for dma allocations |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 891 | * @archdata: For arch-specific additions. |
| 892 | * @of_node: Associated device tree node. |
Rafael J. Wysocki | ce79348 | 2015-03-16 23:49:03 +0100 | [diff] [blame] | 893 | * @fwnode: Associated device node supplied by platform firmware. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 894 | * @devt: For creating the sysfs "dev". |
Randy Dunlap | 2eda013 | 2012-01-21 11:02:51 -0800 | [diff] [blame] | 895 | * @id: device instance |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 896 | * @devres_lock: Spinlock to protect the resource of the device. |
| 897 | * @devres_head: The resources list of the device. |
| 898 | * @knode_class: The node used to add the device to the class list. |
| 899 | * @class: The class of the device. |
| 900 | * @groups: Optional attribute groups. |
| 901 | * @release: Callback to free the device after all references have |
| 902 | * gone away. This should be set by the allocator of the |
| 903 | * device (i.e. the bus driver that discovered the device). |
Michael Opdenacker | bfd63cd | 2013-06-26 05:57:06 +0200 | [diff] [blame] | 904 | * @iommu_group: IOMMU group the device belongs to. |
Robin Murphy | 57f98d2 | 2016-09-13 10:54:14 +0100 | [diff] [blame] | 905 | * @iommu_fwspec: IOMMU-specific properties supplied by firmware. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 906 | * |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 907 | * @offline_disabled: If set, the device is permanently online. |
| 908 | * @offline: Set after successful invocation of bus type's .offline(). |
Johan Hovold | 4e75e1d | 2017-06-06 17:59:00 +0200 | [diff] [blame] | 909 | * @of_node_reused: Set if the device-tree node is shared with an ancestor |
| 910 | * device. |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 911 | * |
| 912 | * At the lowest level, every device in a Linux system is represented by an |
| 913 | * instance of struct device. The device structure contains the information |
| 914 | * that the device model core needs to model the system. Most subsystems, |
| 915 | * however, track additional information about the devices they host. As a |
| 916 | * result, it is rare for devices to be represented by bare device structures; |
| 917 | * instead, that structure, like kobject structures, is usually embedded within |
| 918 | * a higher-level representation of the device. |
| 919 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 920 | struct device { |
David Brownell | 49a4ec1 | 2007-05-08 00:29:39 -0700 | [diff] [blame] | 921 | struct device *parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 922 | |
Greg Kroah-Hartman | fb069a5 | 2008-12-16 12:23:36 -0800 | [diff] [blame] | 923 | struct device_private *p; |
| 924 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 925 | struct kobject kobj; |
Greg Kroah-Hartman | c906a48 | 2008-05-30 10:45:12 -0700 | [diff] [blame] | 926 | const char *init_name; /* initial name of the device */ |
Stephen Hemminger | aed65af | 2011-03-28 09:12:52 -0700 | [diff] [blame] | 927 | const struct device_type *type; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 928 | |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 929 | struct mutex mutex; /* mutex to synchronize calls to |
mochel@digitalimplant.org | af70316 | 2005-03-21 10:41:04 -0800 | [diff] [blame] | 930 | * its driver. |
| 931 | */ |
| 932 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 933 | struct bus_type *bus; /* type of bus device is on */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 934 | struct device_driver *driver; /* which driver has allocated this |
| 935 | device */ |
Greg Kroah-Hartman | e67c856 | 2009-03-08 23:13:32 +0800 | [diff] [blame] | 936 | void *platform_data; /* Platform specific data, device |
| 937 | core doesn't touch it */ |
Jean Delvare | 1bb6c08 | 2014-04-14 12:54:47 +0200 | [diff] [blame] | 938 | void *driver_data; /* Driver data, set and get with |
| 939 | dev_set/get_drvdata */ |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 940 | struct dev_links_info links; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 941 | struct dev_pm_info power; |
Rafael J. Wysocki | 564b905 | 2011-06-23 01:52:55 +0200 | [diff] [blame] | 942 | struct dev_pm_domain *pm_domain; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 943 | |
Marc Zyngier | f1421db | 2015-07-28 14:46:10 +0100 | [diff] [blame] | 944 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN |
| 945 | struct irq_domain *msi_domain; |
| 946 | #endif |
Linus Walleij | ab78029 | 2013-01-22 10:56:14 -0700 | [diff] [blame] | 947 | #ifdef CONFIG_PINCTRL |
| 948 | struct dev_pin_info *pins; |
| 949 | #endif |
Jiang Liu | 4a7cc83 | 2015-07-09 16:00:44 +0800 | [diff] [blame] | 950 | #ifdef CONFIG_GENERIC_MSI_IRQ |
| 951 | struct list_head msi_list; |
| 952 | #endif |
Linus Walleij | ab78029 | 2013-01-22 10:56:14 -0700 | [diff] [blame] | 953 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 954 | #ifdef CONFIG_NUMA |
| 955 | int numa_node; /* NUMA node this device is close to */ |
| 956 | #endif |
Bart Van Assche | 5657933 | 2017-01-20 13:04:02 -0800 | [diff] [blame] | 957 | const struct dma_map_ops *dma_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 958 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
| 959 | u64 coherent_dma_mask;/* Like dma_mask, but for |
| 960 | alloc_coherent mappings as |
| 961 | not all hardware supports |
| 962 | 64 bit addresses for consistent |
| 963 | allocations such descriptors. */ |
Santosh Shilimkar | 8febcaa | 2014-04-24 11:30:01 -0400 | [diff] [blame] | 964 | unsigned long dma_pfn_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 965 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 966 | struct device_dma_parameters *dma_parms; |
| 967 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 968 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
| 969 | |
| 970 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
| 971 | override */ |
Marek Szyprowski | a254738 | 2013-07-29 14:31:45 +0200 | [diff] [blame] | 972 | #ifdef CONFIG_DMA_CMA |
Marek Szyprowski | c64be2b | 2011-12-29 13:09:51 +0100 | [diff] [blame] | 973 | struct cma *cma_area; /* contiguous memory area for dma |
| 974 | allocations */ |
| 975 | #endif |
Benjamin Herrenschmidt | c6dbaef | 2006-11-11 17:18:39 +1100 | [diff] [blame] | 976 | /* arch specific additions */ |
| 977 | struct dev_archdata archdata; |
Grant Likely | c9e358d | 2011-01-21 09:24:48 -0700 | [diff] [blame] | 978 | |
| 979 | struct device_node *of_node; /* associated device tree node */ |
Rafael J. Wysocki | ce79348 | 2015-03-16 23:49:03 +0100 | [diff] [blame] | 980 | struct fwnode_handle *fwnode; /* firmware device node */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 981 | |
Matthew Wilcox | 929d2fa | 2008-10-16 15:51:35 -0600 | [diff] [blame] | 982 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
Kay Sievers | ca22e56 | 2011-12-14 14:29:38 -0800 | [diff] [blame] | 983 | u32 id; /* device instance */ |
Matthew Wilcox | 929d2fa | 2008-10-16 15:51:35 -0600 | [diff] [blame] | 984 | |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 985 | spinlock_t devres_lock; |
| 986 | struct list_head devres_head; |
| 987 | |
Tejun Heo | 5a3ceb8 | 2008-08-25 19:50:19 +0200 | [diff] [blame] | 988 | struct klist_node knode_class; |
Kay Sievers | b7a3e81 | 2006-10-07 21:54:55 +0200 | [diff] [blame] | 989 | struct class *class; |
David Brownell | a4dbd67 | 2009-06-24 10:06:31 -0700 | [diff] [blame] | 990 | const struct attribute_group **groups; /* optional groups */ |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 991 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 992 | void (*release)(struct device *dev); |
Alex Williamson | 74416e1 | 2012-05-30 14:18:41 -0600 | [diff] [blame] | 993 | struct iommu_group *iommu_group; |
Robin Murphy | 57f98d2 | 2016-09-13 10:54:14 +0100 | [diff] [blame] | 994 | struct iommu_fwspec *iommu_fwspec; |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 995 | |
| 996 | bool offline_disabled:1; |
| 997 | bool offline:1; |
Johan Hovold | 4e75e1d | 2017-06-06 17:59:00 +0200 | [diff] [blame] | 998 | bool of_node_reused:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 999 | }; |
| 1000 | |
Lars-Peter Clausen | a423296 | 2012-07-03 18:49:35 +0200 | [diff] [blame] | 1001 | static inline struct device *kobj_to_dev(struct kobject *kobj) |
| 1002 | { |
| 1003 | return container_of(kobj, struct device, kobj); |
| 1004 | } |
| 1005 | |
Alan Stern | 9a3df1f | 2008-03-19 22:39:13 +0100 | [diff] [blame] | 1006 | /* Get the wakeup routines, which depend on struct device */ |
| 1007 | #include <linux/pm_wakeup.h> |
| 1008 | |
Jean Delvare | bf9ca69 | 2008-07-30 12:29:21 -0700 | [diff] [blame] | 1009 | static inline const char *dev_name(const struct device *dev) |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 1010 | { |
Paul Mundt | a636ee7 | 2010-03-09 06:57:53 +0000 | [diff] [blame] | 1011 | /* Use the init name until the kobject becomes available */ |
| 1012 | if (dev->init_name) |
| 1013 | return dev->init_name; |
| 1014 | |
Kay Sievers | 1fa5ae8 | 2009-01-25 15:17:37 +0100 | [diff] [blame] | 1015 | return kobject_name(&dev->kobj); |
Kay Sievers | 0691663 | 2008-05-02 06:02:41 +0200 | [diff] [blame] | 1016 | } |
| 1017 | |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1018 | extern __printf(2, 3) |
| 1019 | int dev_set_name(struct device *dev, const char *name, ...); |
Stephen Rothwell | 413c239 | 2008-05-30 10:16:40 +1000 | [diff] [blame] | 1020 | |
Christoph Hellwig | 8734813 | 2006-12-06 20:32:33 -0800 | [diff] [blame] | 1021 | #ifdef CONFIG_NUMA |
| 1022 | static inline int dev_to_node(struct device *dev) |
| 1023 | { |
| 1024 | return dev->numa_node; |
| 1025 | } |
| 1026 | static inline void set_dev_node(struct device *dev, int node) |
| 1027 | { |
| 1028 | dev->numa_node = node; |
| 1029 | } |
| 1030 | #else |
| 1031 | static inline int dev_to_node(struct device *dev) |
| 1032 | { |
| 1033 | return -1; |
| 1034 | } |
| 1035 | static inline void set_dev_node(struct device *dev, int node) |
| 1036 | { |
| 1037 | } |
| 1038 | #endif |
| 1039 | |
Marc Zyngier | f1421db | 2015-07-28 14:46:10 +0100 | [diff] [blame] | 1040 | static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) |
| 1041 | { |
| 1042 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN |
| 1043 | return dev->msi_domain; |
| 1044 | #else |
| 1045 | return NULL; |
| 1046 | #endif |
| 1047 | } |
| 1048 | |
| 1049 | static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) |
| 1050 | { |
| 1051 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN |
| 1052 | dev->msi_domain = d; |
| 1053 | #endif |
| 1054 | } |
| 1055 | |
Jean Delvare | a996d01 | 2014-04-14 12:58:53 +0200 | [diff] [blame] | 1056 | static inline void *dev_get_drvdata(const struct device *dev) |
| 1057 | { |
| 1058 | return dev->driver_data; |
| 1059 | } |
| 1060 | |
| 1061 | static inline void dev_set_drvdata(struct device *dev, void *data) |
| 1062 | { |
| 1063 | dev->driver_data = data; |
| 1064 | } |
| 1065 | |
Rafael J. Wysocki | 5c095a0 | 2011-08-25 15:33:50 +0200 | [diff] [blame] | 1066 | static inline struct pm_subsys_data *dev_to_psd(struct device *dev) |
| 1067 | { |
| 1068 | return dev ? dev->power.subsys_data : NULL; |
| 1069 | } |
| 1070 | |
Ming Lei | f67f129 | 2009-03-01 21:10:49 +0800 | [diff] [blame] | 1071 | static inline unsigned int dev_get_uevent_suppress(const struct device *dev) |
| 1072 | { |
| 1073 | return dev->kobj.uevent_suppress; |
| 1074 | } |
| 1075 | |
| 1076 | static inline void dev_set_uevent_suppress(struct device *dev, int val) |
| 1077 | { |
| 1078 | dev->kobj.uevent_suppress = val; |
| 1079 | } |
| 1080 | |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 1081 | static inline int device_is_registered(struct device *dev) |
| 1082 | { |
Greg Kroah-Hartman | 3f62e57 | 2008-03-13 17:07:03 -0400 | [diff] [blame] | 1083 | return dev->kobj.state_in_sysfs; |
Daniel Ritz | d305ef5 | 2005-09-22 00:47:24 -0700 | [diff] [blame] | 1084 | } |
| 1085 | |
Rafael J. Wysocki | 5af84b8 | 2010-01-23 22:23:32 +0100 | [diff] [blame] | 1086 | static inline void device_enable_async_suspend(struct device *dev) |
| 1087 | { |
Alan Stern | f76b168b | 2011-06-18 20:22:23 +0200 | [diff] [blame] | 1088 | if (!dev->power.is_prepared) |
Rafael J. Wysocki | 5af84b8 | 2010-01-23 22:23:32 +0100 | [diff] [blame] | 1089 | dev->power.async_suspend = true; |
| 1090 | } |
| 1091 | |
Rafael J. Wysocki | 5a2eb85 | 2010-01-23 22:25:23 +0100 | [diff] [blame] | 1092 | static inline void device_disable_async_suspend(struct device *dev) |
| 1093 | { |
Alan Stern | f76b168b | 2011-06-18 20:22:23 +0200 | [diff] [blame] | 1094 | if (!dev->power.is_prepared) |
Rafael J. Wysocki | 5a2eb85 | 2010-01-23 22:25:23 +0100 | [diff] [blame] | 1095 | dev->power.async_suspend = false; |
| 1096 | } |
| 1097 | |
| 1098 | static inline bool device_async_suspend_enabled(struct device *dev) |
| 1099 | { |
| 1100 | return !!dev->power.async_suspend; |
| 1101 | } |
| 1102 | |
Rafael J. Wysocki | feb70af | 2012-08-13 14:00:25 +0200 | [diff] [blame] | 1103 | static inline void dev_pm_syscore_device(struct device *dev, bool val) |
| 1104 | { |
| 1105 | #ifdef CONFIG_PM_SLEEP |
| 1106 | dev->power.syscore = val; |
| 1107 | #endif |
| 1108 | } |
| 1109 | |
Rafael J. Wysocki | 08810a4 | 2017-10-25 14:12:29 +0200 | [diff] [blame] | 1110 | static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) |
| 1111 | { |
| 1112 | dev->power.driver_flags = flags; |
| 1113 | } |
| 1114 | |
| 1115 | static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) |
| 1116 | { |
| 1117 | return !!(dev->power.driver_flags & flags); |
| 1118 | } |
| 1119 | |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 1120 | static inline void device_lock(struct device *dev) |
| 1121 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 1122 | mutex_lock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 1123 | } |
| 1124 | |
Oliver Neukum | 7dd9cba | 2016-01-21 15:18:47 +0100 | [diff] [blame] | 1125 | static inline int device_lock_interruptible(struct device *dev) |
| 1126 | { |
| 1127 | return mutex_lock_interruptible(&dev->mutex); |
| 1128 | } |
| 1129 | |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 1130 | static inline int device_trylock(struct device *dev) |
| 1131 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 1132 | return mutex_trylock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 1133 | } |
| 1134 | |
| 1135 | static inline void device_unlock(struct device *dev) |
| 1136 | { |
Thomas Gleixner | 3142788 | 2010-01-29 20:39:02 +0000 | [diff] [blame] | 1137 | mutex_unlock(&dev->mutex); |
Greg Kroah-Hartman | 8e9394c | 2010-02-17 10:57:05 -0800 | [diff] [blame] | 1138 | } |
| 1139 | |
Konrad Rzeszutek Wilk | ac80102 | 2014-12-03 16:40:27 -0500 | [diff] [blame] | 1140 | static inline void device_lock_assert(struct device *dev) |
| 1141 | { |
| 1142 | lockdep_assert_held(&dev->mutex); |
| 1143 | } |
| 1144 | |
Benjamin Herrenschmidt | e8a51e1 | 2015-02-17 19:03:41 -0600 | [diff] [blame] | 1145 | static inline struct device_node *dev_of_node(struct device *dev) |
| 1146 | { |
| 1147 | if (!IS_ENABLED(CONFIG_OF)) |
| 1148 | return NULL; |
| 1149 | return dev->of_node; |
| 1150 | } |
| 1151 | |
Adrian Bunk | 1f21782 | 2006-12-19 13:01:28 -0800 | [diff] [blame] | 1152 | void driver_init(void); |
| 1153 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1154 | /* |
| 1155 | * High level routines for use by the bus drivers |
| 1156 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1157 | extern int __must_check device_register(struct device *dev); |
| 1158 | extern void device_unregister(struct device *dev); |
| 1159 | extern void device_initialize(struct device *dev); |
| 1160 | extern int __must_check device_add(struct device *dev); |
| 1161 | extern void device_del(struct device *dev); |
| 1162 | extern int device_for_each_child(struct device *dev, void *data, |
| 1163 | int (*fn)(struct device *dev, void *data)); |
Andy Shevchenko | 3d060ae | 2015-07-27 18:04:00 +0300 | [diff] [blame] | 1164 | extern int device_for_each_child_reverse(struct device *dev, void *data, |
| 1165 | int (*fn)(struct device *dev, void *data)); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1166 | extern struct device *device_find_child(struct device *dev, void *data, |
| 1167 | int (*match)(struct device *dev, void *data)); |
Johannes Berg | 6937e8f | 2010-08-05 17:38:18 +0200 | [diff] [blame] | 1168 | extern int device_rename(struct device *dev, const char *new_name); |
Cornelia Huck | ffa6a70 | 2009-03-04 12:44:00 +0100 | [diff] [blame] | 1169 | extern int device_move(struct device *dev, struct device *new_parent, |
| 1170 | enum dpm_order dpm_order); |
Kay Sievers | e454cea | 2009-09-18 23:01:12 +0200 | [diff] [blame] | 1171 | extern const char *device_get_devnode(struct device *dev, |
Greg Kroah-Hartman | 4e4098a | 2013-04-11 11:43:29 -0700 | [diff] [blame] | 1172 | umode_t *mode, kuid_t *uid, kgid_t *gid, |
Kay Sievers | 3c2670e | 2013-04-06 09:56:00 -0700 | [diff] [blame] | 1173 | const char **tmp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1174 | |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 1175 | static inline bool device_supports_offline(struct device *dev) |
| 1176 | { |
| 1177 | return dev->bus && dev->bus->offline && dev->bus->online; |
| 1178 | } |
| 1179 | |
| 1180 | extern void lock_device_hotplug(void); |
| 1181 | extern void unlock_device_hotplug(void); |
Rafael J. Wysocki | 5e33bc4 | 2013-08-28 21:41:01 +0200 | [diff] [blame] | 1182 | extern int lock_device_hotplug_sysfs(void); |
Rafael J. Wysocki | 4f3549d | 2013-05-02 22:15:29 +0200 | [diff] [blame] | 1183 | extern int device_offline(struct device *dev); |
| 1184 | extern int device_online(struct device *dev); |
Rafael J. Wysocki | 97badf8 | 2015-04-03 23:23:37 +0200 | [diff] [blame] | 1185 | extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); |
| 1186 | extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); |
Johan Hovold | 4e75e1d | 2017-06-06 17:59:00 +0200 | [diff] [blame] | 1187 | void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); |
Rafael J. Wysocki | 97badf8 | 2015-04-03 23:23:37 +0200 | [diff] [blame] | 1188 | |
Phil Sutter | 9af15c3 | 2017-01-18 14:04:39 +0100 | [diff] [blame] | 1189 | static inline int dev_num_vf(struct device *dev) |
| 1190 | { |
| 1191 | if (dev->bus && dev->bus->num_vf) |
| 1192 | return dev->bus->num_vf(dev); |
| 1193 | return 0; |
| 1194 | } |
| 1195 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1196 | /* |
Mark McLoughlin | 0aa0dc4 | 2008-12-15 12:58:26 +0000 | [diff] [blame] | 1197 | * Root device objects for grouping under /sys/devices |
| 1198 | */ |
| 1199 | extern struct device *__root_device_register(const char *name, |
| 1200 | struct module *owner); |
Paul Gortmaker | eb5589a | 2011-05-27 09:02:11 -0400 | [diff] [blame] | 1201 | |
Tejun Heo | 33ac125 | 2014-01-10 08:57:31 -0500 | [diff] [blame] | 1202 | /* This is a macro to avoid include problems with THIS_MODULE */ |
Paul Gortmaker | eb5589a | 2011-05-27 09:02:11 -0400 | [diff] [blame] | 1203 | #define root_device_register(name) \ |
| 1204 | __root_device_register(name, THIS_MODULE) |
| 1205 | |
Mark McLoughlin | 0aa0dc4 | 2008-12-15 12:58:26 +0000 | [diff] [blame] | 1206 | extern void root_device_unregister(struct device *root); |
| 1207 | |
Mark Brown | a5b8b1a | 2009-07-17 15:06:08 +0100 | [diff] [blame] | 1208 | static inline void *dev_get_platdata(const struct device *dev) |
| 1209 | { |
| 1210 | return dev->platform_data; |
| 1211 | } |
| 1212 | |
Mark McLoughlin | 0aa0dc4 | 2008-12-15 12:58:26 +0000 | [diff] [blame] | 1213 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1214 | * Manual binding of a device to driver. See drivers/base/bus.c |
| 1215 | * for information on use. |
| 1216 | */ |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 1217 | extern int __must_check device_bind_driver(struct device *dev); |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1218 | extern void device_release_driver(struct device *dev); |
| 1219 | extern int __must_check device_attach(struct device *dev); |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 1220 | extern int __must_check driver_attach(struct device_driver *drv); |
Dmitry Torokhov | 765230b | 2015-03-30 16:20:04 -0700 | [diff] [blame] | 1221 | extern void device_initial_probe(struct device *dev); |
Andrew Morton | f86db39 | 2006-08-14 22:43:20 -0700 | [diff] [blame] | 1222 | extern int __must_check device_reprobe(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1223 | |
Tomeu Vizoso | 6b9cb42 | 2016-01-07 16:46:12 +0100 | [diff] [blame] | 1224 | extern bool device_is_bound(struct device *dev); |
| 1225 | |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 1226 | /* |
| 1227 | * Easy functions for dynamically creating devices on the fly |
| 1228 | */ |
Nicolas Iooss | 8db1486 | 2015-07-17 16:23:42 -0700 | [diff] [blame] | 1229 | extern __printf(5, 0) |
| 1230 | struct device *device_create_vargs(struct class *cls, struct device *parent, |
| 1231 | dev_t devt, void *drvdata, |
| 1232 | const char *fmt, va_list vargs); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1233 | extern __printf(5, 6) |
| 1234 | struct device *device_create(struct class *cls, struct device *parent, |
| 1235 | dev_t devt, void *drvdata, |
| 1236 | const char *fmt, ...); |
Guenter Roeck | 39ef311 | 2013-07-14 16:05:57 -0700 | [diff] [blame] | 1237 | extern __printf(6, 7) |
| 1238 | struct device *device_create_with_groups(struct class *cls, |
| 1239 | struct device *parent, dev_t devt, void *drvdata, |
| 1240 | const struct attribute_group **groups, |
| 1241 | const char *fmt, ...); |
Greg Kroah-Hartman | 23681e4 | 2006-06-14 12:14:34 -0700 | [diff] [blame] | 1242 | extern void device_destroy(struct class *cls, dev_t devt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1243 | |
Dmitry Torokhov | a7670d4 | 2017-07-19 17:24:31 -0700 | [diff] [blame] | 1244 | extern int __must_check device_add_groups(struct device *dev, |
| 1245 | const struct attribute_group **groups); |
| 1246 | extern void device_remove_groups(struct device *dev, |
| 1247 | const struct attribute_group **groups); |
| 1248 | |
Dmitry Torokhov | e323b2d | 2017-07-19 17:24:32 -0700 | [diff] [blame] | 1249 | static inline int __must_check device_add_group(struct device *dev, |
| 1250 | const struct attribute_group *grp) |
| 1251 | { |
| 1252 | const struct attribute_group *groups[] = { grp, NULL }; |
| 1253 | |
| 1254 | return device_add_groups(dev, groups); |
| 1255 | } |
| 1256 | |
| 1257 | static inline void device_remove_group(struct device *dev, |
| 1258 | const struct attribute_group *grp) |
| 1259 | { |
| 1260 | const struct attribute_group *groups[] = { grp, NULL }; |
| 1261 | |
| 1262 | return device_remove_groups(dev, groups); |
| 1263 | } |
| 1264 | |
Dmitry Torokhov | 57b8ff0 | 2017-07-19 17:24:33 -0700 | [diff] [blame] | 1265 | extern int __must_check devm_device_add_groups(struct device *dev, |
| 1266 | const struct attribute_group **groups); |
| 1267 | extern void devm_device_remove_groups(struct device *dev, |
| 1268 | const struct attribute_group **groups); |
| 1269 | extern int __must_check devm_device_add_group(struct device *dev, |
| 1270 | const struct attribute_group *grp); |
| 1271 | extern void devm_device_remove_group(struct device *dev, |
| 1272 | const struct attribute_group *grp); |
| 1273 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1274 | /* |
| 1275 | * Platform "fixup" functions - allow the platform to have their say |
| 1276 | * about devices and actions that the general device layer doesn't |
| 1277 | * know about. |
| 1278 | */ |
| 1279 | /* Notify platform of device discovery */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1280 | extern int (*platform_notify)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1281 | |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1282 | extern int (*platform_notify_remove)(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1283 | |
| 1284 | |
Wanlong Gao | 880ffb5 | 2011-05-05 07:55:36 +0800 | [diff] [blame] | 1285 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1286 | * get_device - atomically increment the reference count for the device. |
| 1287 | * |
| 1288 | */ |
Greg Kroah-Hartman | d462943 | 2008-01-24 21:04:46 -0800 | [diff] [blame] | 1289 | extern struct device *get_device(struct device *dev); |
| 1290 | extern void put_device(struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1291 | |
Kay Sievers | 2b2af54 | 2009-04-30 15:23:42 +0200 | [diff] [blame] | 1292 | #ifdef CONFIG_DEVTMPFS |
| 1293 | extern int devtmpfs_create_node(struct device *dev); |
| 1294 | extern int devtmpfs_delete_node(struct device *dev); |
Kay Sievers | 073120c | 2009-10-28 19:51:17 +0100 | [diff] [blame] | 1295 | extern int devtmpfs_mount(const char *mntdir); |
Kay Sievers | 2b2af54 | 2009-04-30 15:23:42 +0200 | [diff] [blame] | 1296 | #else |
| 1297 | static inline int devtmpfs_create_node(struct device *dev) { return 0; } |
| 1298 | static inline int devtmpfs_delete_node(struct device *dev) { return 0; } |
| 1299 | static inline int devtmpfs_mount(const char *mountpoint) { return 0; } |
| 1300 | #endif |
| 1301 | |
Rytchkov Alexey | 116f232b | 2006-03-22 00:58:53 +0100 | [diff] [blame] | 1302 | /* drivers/base/power/shutdown.c */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1303 | extern void device_shutdown(void); |
| 1304 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1305 | /* debugging and troubleshooting/diagnostic helpers. */ |
Jean Delvare | bf9ca69 | 2008-07-30 12:29:21 -0700 | [diff] [blame] | 1306 | extern const char *dev_driver_string(const struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1307 | |
Rafael J. Wysocki | 9ed9895 | 2016-10-30 17:32:16 +0100 | [diff] [blame] | 1308 | /* Device links interface. */ |
| 1309 | struct device_link *device_link_add(struct device *consumer, |
| 1310 | struct device *supplier, u32 flags); |
| 1311 | void device_link_del(struct device_link *link); |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1312 | |
| 1313 | #ifdef CONFIG_PRINTK |
| 1314 | |
Joe Perches | 0a18b05 | 2012-09-25 18:19:57 -0700 | [diff] [blame] | 1315 | extern __printf(3, 0) |
| 1316 | int dev_vprintk_emit(int level, const struct device *dev, |
| 1317 | const char *fmt, va_list args); |
Joe Perches | 05e4e5b | 2012-09-12 20:13:37 -0700 | [diff] [blame] | 1318 | extern __printf(3, 4) |
| 1319 | int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...); |
Joe Perches | 798efc6 | 2012-09-12 20:11:29 -0700 | [diff] [blame] | 1320 | |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1321 | extern __printf(3, 4) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1322 | void dev_printk(const char *level, const struct device *dev, |
| 1323 | const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1324 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1325 | void dev_emerg(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1326 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1327 | void dev_alert(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1328 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1329 | void dev_crit(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1330 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1331 | void dev_err(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1332 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1333 | void dev_warn(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1334 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1335 | void dev_notice(const struct device *dev, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1336 | extern __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1337 | void _dev_info(const struct device *dev, const char *fmt, ...); |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1338 | |
| 1339 | #else |
| 1340 | |
Joe Perches | 0a18b05 | 2012-09-25 18:19:57 -0700 | [diff] [blame] | 1341 | static inline __printf(3, 0) |
| 1342 | int dev_vprintk_emit(int level, const struct device *dev, |
| 1343 | const char *fmt, va_list args) |
Joe Perches | 05e4e5b | 2012-09-12 20:13:37 -0700 | [diff] [blame] | 1344 | { return 0; } |
| 1345 | static inline __printf(3, 4) |
| 1346 | int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...) |
| 1347 | { return 0; } |
| 1348 | |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1349 | static inline void __dev_printk(const char *level, const struct device *dev, |
| 1350 | struct va_format *vaf) |
| 1351 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1352 | static inline __printf(3, 4) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1353 | void dev_printk(const char *level, const struct device *dev, |
| 1354 | const char *fmt, ...) |
| 1355 | {} |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1356 | |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1357 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1358 | void dev_emerg(const struct device *dev, const char *fmt, ...) |
| 1359 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1360 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1361 | void dev_crit(const struct device *dev, const char *fmt, ...) |
| 1362 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1363 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1364 | void dev_alert(const struct device *dev, const char *fmt, ...) |
| 1365 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1366 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1367 | void dev_err(const struct device *dev, const char *fmt, ...) |
| 1368 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1369 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1370 | void dev_warn(const struct device *dev, const char *fmt, ...) |
| 1371 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1372 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1373 | void dev_notice(const struct device *dev, const char *fmt, ...) |
| 1374 | {} |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 1375 | static inline __printf(2, 3) |
Joe Perches | d1f1052 | 2014-12-25 15:07:04 -0800 | [diff] [blame] | 1376 | void _dev_info(const struct device *dev, const char *fmt, ...) |
| 1377 | {} |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1378 | |
| 1379 | #endif |
| 1380 | |
| 1381 | /* |
| 1382 | * Stupid hackaround for existing uses of non-printk uses dev_info |
| 1383 | * |
| 1384 | * Note that the definition of dev_info below is actually _dev_info |
| 1385 | * and a macro is used to avoid redefining dev_info |
| 1386 | */ |
| 1387 | |
| 1388 | #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg) |
Emil Medve | 7b8712e | 2007-10-30 14:37:14 -0500 | [diff] [blame] | 1389 | |
Jim Cromie | b558c96 | 2011-12-19 17:11:18 -0500 | [diff] [blame] | 1390 | #if defined(CONFIG_DYNAMIC_DEBUG) |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1391 | #define dev_dbg(dev, format, ...) \ |
| 1392 | do { \ |
Jason Baron | 346e15b | 2008-08-12 16:46:19 -0400 | [diff] [blame] | 1393 | dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \ |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1394 | } while (0) |
Jim Cromie | b558c96 | 2011-12-19 17:11:18 -0500 | [diff] [blame] | 1395 | #elif defined(DEBUG) |
| 1396 | #define dev_dbg(dev, format, arg...) \ |
| 1397 | dev_printk(KERN_DEBUG, dev, format, ##arg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1398 | #else |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1399 | #define dev_dbg(dev, format, arg...) \ |
| 1400 | ({ \ |
| 1401 | if (0) \ |
| 1402 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1403 | }) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1404 | #endif |
| 1405 | |
Joe Perches | e135303 | 2014-11-17 18:18:22 -0800 | [diff] [blame] | 1406 | #ifdef CONFIG_PRINTK |
| 1407 | #define dev_level_once(dev_level, dev, fmt, ...) \ |
| 1408 | do { \ |
| 1409 | static bool __print_once __read_mostly; \ |
| 1410 | \ |
| 1411 | if (!__print_once) { \ |
| 1412 | __print_once = true; \ |
| 1413 | dev_level(dev, fmt, ##__VA_ARGS__); \ |
| 1414 | } \ |
| 1415 | } while (0) |
| 1416 | #else |
| 1417 | #define dev_level_once(dev_level, dev, fmt, ...) \ |
| 1418 | do { \ |
| 1419 | if (0) \ |
| 1420 | dev_level(dev, fmt, ##__VA_ARGS__); \ |
| 1421 | } while (0) |
| 1422 | #endif |
| 1423 | |
| 1424 | #define dev_emerg_once(dev, fmt, ...) \ |
| 1425 | dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__) |
| 1426 | #define dev_alert_once(dev, fmt, ...) \ |
| 1427 | dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__) |
| 1428 | #define dev_crit_once(dev, fmt, ...) \ |
| 1429 | dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__) |
| 1430 | #define dev_err_once(dev, fmt, ...) \ |
| 1431 | dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__) |
| 1432 | #define dev_warn_once(dev, fmt, ...) \ |
| 1433 | dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__) |
| 1434 | #define dev_notice_once(dev, fmt, ...) \ |
| 1435 | dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__) |
| 1436 | #define dev_info_once(dev, fmt, ...) \ |
| 1437 | dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__) |
| 1438 | #define dev_dbg_once(dev, fmt, ...) \ |
Joe Perches | a2a15d5 | 2015-01-03 09:51:33 -0800 | [diff] [blame] | 1439 | dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__) |
Joe Perches | e135303 | 2014-11-17 18:18:22 -0800 | [diff] [blame] | 1440 | |
Hiroshi Doyu | 6f586e6 | 2012-09-04 06:40:40 +0200 | [diff] [blame] | 1441 | #define dev_level_ratelimited(dev_level, dev, fmt, ...) \ |
| 1442 | do { \ |
| 1443 | static DEFINE_RATELIMIT_STATE(_rs, \ |
| 1444 | DEFAULT_RATELIMIT_INTERVAL, \ |
| 1445 | DEFAULT_RATELIMIT_BURST); \ |
| 1446 | if (__ratelimit(&_rs)) \ |
| 1447 | dev_level(dev, fmt, ##__VA_ARGS__); \ |
| 1448 | } while (0) |
| 1449 | |
| 1450 | #define dev_emerg_ratelimited(dev, fmt, ...) \ |
| 1451 | dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__) |
| 1452 | #define dev_alert_ratelimited(dev, fmt, ...) \ |
| 1453 | dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__) |
| 1454 | #define dev_crit_ratelimited(dev, fmt, ...) \ |
| 1455 | dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__) |
| 1456 | #define dev_err_ratelimited(dev, fmt, ...) \ |
| 1457 | dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__) |
| 1458 | #define dev_warn_ratelimited(dev, fmt, ...) \ |
| 1459 | dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__) |
| 1460 | #define dev_notice_ratelimited(dev, fmt, ...) \ |
| 1461 | dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__) |
| 1462 | #define dev_info_ratelimited(dev, fmt, ...) \ |
| 1463 | dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__) |
Dmitry Kasatkin | 8ef2d65 | 2013-08-27 17:47:34 +0300 | [diff] [blame] | 1464 | #if defined(CONFIG_DYNAMIC_DEBUG) |
| 1465 | /* descriptor check is first to prevent flooding with "callbacks suppressed" */ |
Hiroshi Doyu | 6f586e6 | 2012-09-04 06:40:40 +0200 | [diff] [blame] | 1466 | #define dev_dbg_ratelimited(dev, fmt, ...) \ |
| 1467 | do { \ |
| 1468 | static DEFINE_RATELIMIT_STATE(_rs, \ |
| 1469 | DEFAULT_RATELIMIT_INTERVAL, \ |
| 1470 | DEFAULT_RATELIMIT_BURST); \ |
| 1471 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ |
| 1472 | if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \ |
| 1473 | __ratelimit(&_rs)) \ |
Dmitry Kasatkin | 8ef2d65 | 2013-08-27 17:47:34 +0300 | [diff] [blame] | 1474 | __dynamic_dev_dbg(&descriptor, dev, fmt, \ |
| 1475 | ##__VA_ARGS__); \ |
| 1476 | } while (0) |
| 1477 | #elif defined(DEBUG) |
| 1478 | #define dev_dbg_ratelimited(dev, fmt, ...) \ |
| 1479 | do { \ |
| 1480 | static DEFINE_RATELIMIT_STATE(_rs, \ |
| 1481 | DEFAULT_RATELIMIT_INTERVAL, \ |
| 1482 | DEFAULT_RATELIMIT_BURST); \ |
| 1483 | if (__ratelimit(&_rs)) \ |
| 1484 | dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \ |
Hiroshi Doyu | 6f586e6 | 2012-09-04 06:40:40 +0200 | [diff] [blame] | 1485 | } while (0) |
| 1486 | #else |
Arnd Bergmann | 1f62ff3 | 2016-03-24 22:19:40 +0100 | [diff] [blame] | 1487 | #define dev_dbg_ratelimited(dev, fmt, ...) \ |
| 1488 | do { \ |
| 1489 | if (0) \ |
| 1490 | dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \ |
| 1491 | } while (0) |
Hiroshi Doyu | 6f586e6 | 2012-09-04 06:40:40 +0200 | [diff] [blame] | 1492 | #endif |
| 1493 | |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 1494 | #ifdef VERBOSE_DEBUG |
| 1495 | #define dev_vdbg dev_dbg |
| 1496 | #else |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1497 | #define dev_vdbg(dev, format, arg...) \ |
| 1498 | ({ \ |
| 1499 | if (0) \ |
| 1500 | dev_printk(KERN_DEBUG, dev, format, ##arg); \ |
Joe Perches | 99bcf21 | 2010-06-27 01:02:34 +0000 | [diff] [blame] | 1501 | }) |
David Brownell | aebdc3b | 2007-07-12 22:08:22 -0700 | [diff] [blame] | 1502 | #endif |
| 1503 | |
Arjan van de Ven | e613966 | 2008-09-20 19:08:39 -0700 | [diff] [blame] | 1504 | /* |
Bjorn Helgaas | 3eae136 | 2013-10-24 15:42:33 -0600 | [diff] [blame] | 1505 | * dev_WARN*() acts like dev_printk(), but with the key difference of |
| 1506 | * using WARN/WARN_ONCE to include file/line information and a backtrace. |
Arjan van de Ven | e613966 | 2008-09-20 19:08:39 -0700 | [diff] [blame] | 1507 | */ |
| 1508 | #define dev_WARN(dev, format, arg...) \ |
Bjorn Helgaas | 3eae136 | 2013-10-24 15:42:33 -0600 | [diff] [blame] | 1509 | WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg); |
Arjan van de Ven | e613966 | 2008-09-20 19:08:39 -0700 | [diff] [blame] | 1510 | |
Felipe Balbi | bcdd323 | 2011-03-16 15:59:35 +0200 | [diff] [blame] | 1511 | #define dev_WARN_ONCE(dev, condition, format, arg...) \ |
Bjorn Helgaas | 3eae136 | 2013-10-24 15:42:33 -0600 | [diff] [blame] | 1512 | WARN_ONCE(condition, "%s %s: " format, \ |
| 1513 | dev_driver_string(dev), dev_name(dev), ## arg) |
Felipe Balbi | bcdd323 | 2011-03-16 15:59:35 +0200 | [diff] [blame] | 1514 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1515 | /* Create alias, so I can be autoloaded. */ |
| 1516 | #define MODULE_ALIAS_CHARDEV(major,minor) \ |
| 1517 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) |
| 1518 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ |
| 1519 | MODULE_ALIAS("char-major-" __stringify(major) "-*") |
Andi Kleen | e52eec1 | 2010-09-08 16:54:17 +0200 | [diff] [blame] | 1520 | |
| 1521 | #ifdef CONFIG_SYSFS_DEPRECATED |
| 1522 | extern long sysfs_deprecated; |
| 1523 | #else |
| 1524 | #define sysfs_deprecated 0 |
| 1525 | #endif |
| 1526 | |
Lars-Peter Clausen | 907d0ed | 2011-11-16 10:13:35 +0100 | [diff] [blame] | 1527 | /** |
| 1528 | * module_driver() - Helper macro for drivers that don't do anything |
| 1529 | * special in module init/exit. This eliminates a lot of boilerplate. |
| 1530 | * Each module may only use this macro once, and calling it replaces |
| 1531 | * module_init() and module_exit(). |
| 1532 | * |
Randy Dunlap | 2eda013 | 2012-01-21 11:02:51 -0800 | [diff] [blame] | 1533 | * @__driver: driver name |
| 1534 | * @__register: register function for this driver type |
| 1535 | * @__unregister: unregister function for this driver type |
Lars-Peter Clausen | cd49461 | 2012-02-25 11:25:58 +0100 | [diff] [blame] | 1536 | * @...: Additional arguments to be passed to __register and __unregister. |
Randy Dunlap | 2eda013 | 2012-01-21 11:02:51 -0800 | [diff] [blame] | 1537 | * |
Lars-Peter Clausen | 907d0ed | 2011-11-16 10:13:35 +0100 | [diff] [blame] | 1538 | * Use this macro to construct bus specific macros for registering |
| 1539 | * drivers, and do not use it on its own. |
| 1540 | */ |
Lars-Peter Clausen | cd49461 | 2012-02-25 11:25:58 +0100 | [diff] [blame] | 1541 | #define module_driver(__driver, __register, __unregister, ...) \ |
Lars-Peter Clausen | 907d0ed | 2011-11-16 10:13:35 +0100 | [diff] [blame] | 1542 | static int __init __driver##_init(void) \ |
| 1543 | { \ |
Lars-Peter Clausen | cd49461 | 2012-02-25 11:25:58 +0100 | [diff] [blame] | 1544 | return __register(&(__driver) , ##__VA_ARGS__); \ |
Lars-Peter Clausen | 907d0ed | 2011-11-16 10:13:35 +0100 | [diff] [blame] | 1545 | } \ |
| 1546 | module_init(__driver##_init); \ |
| 1547 | static void __exit __driver##_exit(void) \ |
| 1548 | { \ |
Lars-Peter Clausen | cd49461 | 2012-02-25 11:25:58 +0100 | [diff] [blame] | 1549 | __unregister(&(__driver) , ##__VA_ARGS__); \ |
Lars-Peter Clausen | 907d0ed | 2011-11-16 10:13:35 +0100 | [diff] [blame] | 1550 | } \ |
| 1551 | module_exit(__driver##_exit); |
| 1552 | |
Paul Gortmaker | f309d44 | 2015-05-01 20:10:57 -0400 | [diff] [blame] | 1553 | /** |
| 1554 | * builtin_driver() - Helper macro for drivers that don't do anything |
| 1555 | * special in init and have no exit. This eliminates some boilerplate. |
| 1556 | * Each driver may only use this macro once, and calling it replaces |
| 1557 | * device_initcall (or in some cases, the legacy __initcall). This is |
| 1558 | * meant to be a direct parallel of module_driver() above but without |
| 1559 | * the __exit stuff that is not used for builtin cases. |
| 1560 | * |
| 1561 | * @__driver: driver name |
| 1562 | * @__register: register function for this driver type |
| 1563 | * @...: Additional arguments to be passed to __register |
| 1564 | * |
| 1565 | * Use this macro to construct bus specific macros for registering |
| 1566 | * drivers, and do not use it on its own. |
| 1567 | */ |
| 1568 | #define builtin_driver(__driver, __register, ...) \ |
| 1569 | static int __init __driver##_init(void) \ |
| 1570 | { \ |
| 1571 | return __register(&(__driver) , ##__VA_ARGS__); \ |
| 1572 | } \ |
| 1573 | device_initcall(__driver##_init); |
| 1574 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1575 | #endif /* _DEVICE_H_ */ |