Commit | Line | Data |
---|---|---|
989d42e8 | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 LT |
2 | /* |
3 | * device.h - generic, centralized driver model | |
4 | * | |
5 | * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> | |
b4028437 GKH |
6 | * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> |
7 | * Copyright (c) 2008-2009 Novell Inc. | |
1da177e4 | 8 | * |
fe34c89d | 9 | * See Documentation/driver-api/driver-model/ for more information. |
1da177e4 LT |
10 | */ |
11 | ||
12 | #ifndef _DEVICE_H_ | |
13 | #define _DEVICE_H_ | |
14 | ||
1da177e4 LT |
15 | #include <linux/ioport.h> |
16 | #include <linux/kobject.h> | |
465c7a3a | 17 | #include <linux/klist.h> |
1da177e4 | 18 | #include <linux/list.h> |
d2a3b914 | 19 | #include <linux/lockdep.h> |
4a7fb636 | 20 | #include <linux/compiler.h> |
1da177e4 | 21 | #include <linux/types.h> |
de477254 | 22 | #include <linux/mutex.h> |
1da177e4 | 23 | #include <linux/pm.h> |
60063497 | 24 | #include <linux/atomic.h> |
6ca04593 | 25 | #include <linux/ratelimit.h> |
3c2670e6 | 26 | #include <linux/uidgid.h> |
64c862a8 | 27 | #include <linux/gfp.h> |
2509b561 | 28 | #include <linux/overflow.h> |
c6dbaef2 | 29 | #include <asm/device.h> |
1da177e4 | 30 | |
1da177e4 | 31 | struct device; |
fb069a5d | 32 | struct device_private; |
1da177e4 | 33 | struct device_driver; |
e5dd1278 | 34 | struct driver_private; |
de477254 | 35 | struct module; |
1da177e4 | 36 | struct class; |
6b6e39a6 | 37 | struct subsys_private; |
b8c5cec2 | 38 | struct bus_type; |
d706c1b0 | 39 | struct device_node; |
ce793486 | 40 | struct fwnode_handle; |
ff21776d | 41 | struct iommu_ops; |
74416e1e | 42 | struct iommu_group; |
57f98d2f | 43 | struct iommu_fwspec; |
23c35f48 | 44 | struct dev_pin_info; |
ec6bc2e9 | 45 | struct iommu_param; |
b8c5cec2 KS |
46 | |
47 | struct bus_attribute { | |
48 | struct attribute attr; | |
d462943a GKH |
49 | ssize_t (*show)(struct bus_type *bus, char *buf); |
50 | ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count); | |
b8c5cec2 KS |
51 | }; |
52 | ||
ced321bf GKH |
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) | |
8514c470 GKH |
57 | #define BUS_ATTR_WO(_name) \ |
58 | struct bus_attribute bus_attr_##_name = __ATTR_WO(_name) | |
b8c5cec2 KS |
59 | |
60 | extern int __must_check bus_create_file(struct bus_type *, | |
61 | struct bus_attribute *); | |
62 | extern void bus_remove_file(struct bus_type *, struct bus_attribute *); | |
1da177e4 | 63 | |
880ffb5c WG |
64 | /** |
65 | * struct bus_type - The bus type of the device | |
66 | * | |
67 | * @name: The name of the bus. | |
ca22e56d KS |
68 | * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id). |
69 | * @dev_root: Default device to use as the parent. | |
12478ba0 | 70 | * @bus_groups: Default attributes of the bus. |
fa6fdb33 | 71 | * @dev_groups: Default attributes of the devices on the bus. |
ed0617b5 | 72 | * @drv_groups: Default attributes of the device drivers on the bus. |
880ffb5c | 73 | * @match: Called, perhaps multiple times, whenever a new device or driver |
656b8035 TV |
74 | * is added for this bus. It should return a positive value if the |
75 | * given device can be handled by the given driver and zero | |
76 | * otherwise. It may also return error code if determining that | |
77 | * the driver supports the device is not possible. In case of | |
78 | * -EPROBE_DEFER it will queue the device for deferred probing. | |
880ffb5c WG |
79 | * @uevent: Called when a device is added, removed, or a few other things |
80 | * that generate uevents to add the environment variables. | |
81 | * @probe: Called when a new device or driver add to this bus, and callback | |
82 | * the specific driver's probe to initial the matched device. | |
83 | * @remove: Called when a device removed from this bus. | |
84 | * @shutdown: Called at shut-down time to quiesce the device. | |
4f3549d7 RW |
85 | * |
86 | * @online: Called to put the device back online (after offlining it). | |
87 | * @offline: Called to put the device offline for hot-removal. May fail. | |
88 | * | |
880ffb5c WG |
89 | * @suspend: Called when a device on this bus wants to go to sleep mode. |
90 | * @resume: Called to bring a device on this bus out of sleep mode. | |
582a686f PS |
91 | * @num_vf: Called to find out how many virtual functions a device on this |
92 | * bus supports. | |
07397df2 | 93 | * @dma_configure: Called to setup DMA configuration on a device on |
e88728f4 | 94 | * this bus. |
880ffb5c WG |
95 | * @pm: Power management operations of this bus, callback the specific |
96 | * device driver's pm-ops. | |
7b08fae8 | 97 | * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU |
ff21776d JR |
98 | * driver implementations to a bus and allow the driver to do |
99 | * bus-specific setup | |
880ffb5c WG |
100 | * @p: The private data of the driver core, only the driver core can |
101 | * touch this. | |
bfd63cd2 | 102 | * @lock_key: Lock class key for use by the lock validator |
8c97a46a ML |
103 | * @need_parent_lock: When probing or removing a device on this bus, the |
104 | * device core should lock the device's parent. | |
880ffb5c WG |
105 | * |
106 | * A bus is a channel between the processor and one or more devices. For the | |
107 | * purposes of the device model, all devices are connected via a bus, even if | |
108 | * it is an internal, virtual, "platform" bus. Buses can plug into each other. | |
109 | * A USB controller is usually a PCI device, for example. The device model | |
110 | * represents the actual connections between buses and the devices they control. | |
111 | * A bus is represented by the bus_type structure. It contains the name, the | |
112 | * default attributes, the bus' methods, PM operations, and the driver core's | |
113 | * private data. | |
114 | */ | |
1da177e4 | 115 | struct bus_type { |
d462943a | 116 | const char *name; |
ca22e56d KS |
117 | const char *dev_name; |
118 | struct device *dev_root; | |
12478ba0 | 119 | const struct attribute_group **bus_groups; |
fa6fdb33 | 120 | const struct attribute_group **dev_groups; |
ed0617b5 | 121 | const struct attribute_group **drv_groups; |
d462943a GKH |
122 | |
123 | int (*match)(struct device *dev, struct device_driver *drv); | |
124 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); | |
125 | int (*probe)(struct device *dev); | |
126 | int (*remove)(struct device *dev); | |
127 | void (*shutdown)(struct device *dev); | |
128 | ||
4f3549d7 RW |
129 | int (*online)(struct device *dev); |
130 | int (*offline)(struct device *dev); | |
131 | ||
d462943a | 132 | int (*suspend)(struct device *dev, pm_message_t state); |
d462943a | 133 | int (*resume)(struct device *dev); |
b8c5cec2 | 134 | |
582a686f PS |
135 | int (*num_vf)(struct device *dev); |
136 | ||
07397df2 NG |
137 | int (*dma_configure)(struct device *dev); |
138 | ||
8150f32b | 139 | const struct dev_pm_ops *pm; |
1eede070 | 140 | |
b22f6434 | 141 | const struct iommu_ops *iommu_ops; |
ff21776d | 142 | |
6b6e39a6 | 143 | struct subsys_private *p; |
be871b7e | 144 | struct lock_class_key lock_key; |
d89e2378 | 145 | |
8c97a46a | 146 | bool need_parent_lock; |
1da177e4 LT |
147 | }; |
148 | ||
be871b7e MH |
149 | extern int __must_check bus_register(struct bus_type *bus); |
150 | ||
d462943a | 151 | extern void bus_unregister(struct bus_type *bus); |
1da177e4 | 152 | |
d462943a | 153 | extern int __must_check bus_rescan_devices(struct bus_type *bus); |
1da177e4 | 154 | |
1da177e4 | 155 | /* iterator helpers for buses */ |
ca22e56d KS |
156 | struct subsys_dev_iter { |
157 | struct klist_iter ki; | |
158 | const struct device_type *type; | |
159 | }; | |
7cd9c9bb | 160 | void subsys_dev_iter_init(struct subsys_dev_iter *iter, |
ca22e56d KS |
161 | struct bus_type *subsys, |
162 | struct device *start, | |
163 | const struct device_type *type); | |
164 | struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter); | |
165 | void subsys_dev_iter_exit(struct subsys_dev_iter *iter); | |
1da177e4 | 166 | |
65b66682 SP |
167 | int device_match_of_node(struct device *dev, const void *np); |
168 | ||
d462943a GKH |
169 | int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data, |
170 | int (*fn)(struct device *dev, void *data)); | |
171 | struct device *bus_find_device(struct bus_type *bus, struct device *start, | |
418e3ea1 SP |
172 | const void *data, |
173 | int (*match)(struct device *dev, const void *data)); | |
1f9ffc04 GKH |
174 | struct device *bus_find_device_by_name(struct bus_type *bus, |
175 | struct device *start, | |
176 | const char *name); | |
ca22e56d KS |
177 | struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id, |
178 | struct device *hint); | |
cc7447a5 JD |
179 | int bus_for_each_drv(struct bus_type *bus, struct device_driver *start, |
180 | void *data, int (*fn)(struct device_driver *, void *)); | |
99178b03 GKH |
181 | void bus_sort_breadthfirst(struct bus_type *bus, |
182 | int (*compare)(const struct device *a, | |
183 | const struct device *b)); | |
116af378 BH |
184 | /* |
185 | * Bus notifiers: Get notified of addition/removal of devices | |
186 | * and binding/unbinding of drivers to devices. | |
187 | * In the long run, it should be a replacement for the platform | |
188 | * notify hooks. | |
189 | */ | |
190 | struct notifier_block; | |
191 | ||
192 | extern int bus_register_notifier(struct bus_type *bus, | |
193 | struct notifier_block *nb); | |
194 | extern int bus_unregister_notifier(struct bus_type *bus, | |
195 | struct notifier_block *nb); | |
196 | ||
197 | /* All 4 notifers below get called with the target struct device * | |
198 | * as an argument. Note that those functions are likely to be called | |
8e9394ce | 199 | * with the device lock held in the core, so be careful. |
116af378 BH |
200 | */ |
201 | #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */ | |
599bad38 JR |
202 | #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */ |
203 | #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */ | |
204 | #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be | |
45daef0f | 205 | bound */ |
599bad38 JR |
206 | #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */ |
207 | #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be | |
116af378 | 208 | unbound */ |
599bad38 | 209 | #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound |
309b7d60 | 210 | from the device */ |
14b6257a | 211 | #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */ |
116af378 | 212 | |
0fed80f7 | 213 | extern struct kset *bus_get_kset(struct bus_type *bus); |
b249072e | 214 | extern struct klist *bus_get_device_klist(struct bus_type *bus); |
0fed80f7 | 215 | |
765230b5 DT |
216 | /** |
217 | * enum probe_type - device driver probe type to try | |
218 | * Device drivers may opt in for special handling of their | |
219 | * respective probe routines. This tells the core what to | |
220 | * expect and prefer. | |
221 | * | |
d173a137 LR |
222 | * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well |
223 | * whether probed synchronously or asynchronously. | |
765230b5 DT |
224 | * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which |
225 | * probing order is not essential for booting the system may | |
226 | * opt into executing their probes asynchronously. | |
d173a137 LR |
227 | * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need |
228 | * their probe routines to run synchronously with driver and | |
229 | * device registration (with the exception of -EPROBE_DEFER | |
230 | * handling - re-probing always ends up being done asynchronously). | |
765230b5 DT |
231 | * |
232 | * Note that the end goal is to switch the kernel to use asynchronous | |
233 | * probing by default, so annotating drivers with | |
234 | * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us | |
235 | * to speed up boot process while we are validating the rest of the | |
236 | * drivers. | |
237 | */ | |
238 | enum probe_type { | |
f2411da7 | 239 | PROBE_DEFAULT_STRATEGY, |
765230b5 | 240 | PROBE_PREFER_ASYNCHRONOUS, |
d173a137 | 241 | PROBE_FORCE_SYNCHRONOUS, |
765230b5 DT |
242 | }; |
243 | ||
880ffb5c WG |
244 | /** |
245 | * struct device_driver - The basic device driver structure | |
246 | * @name: Name of the device driver. | |
247 | * @bus: The bus which the device of this driver belongs to. | |
248 | * @owner: The module owner. | |
249 | * @mod_name: Used for built-in modules. | |
250 | * @suppress_bind_attrs: Disables bind/unbind via sysfs. | |
765230b5 | 251 | * @probe_type: Type of the probe (synchronous or asynchronous) to use. |
880ffb5c | 252 | * @of_match_table: The open firmware table. |
06f64c8f | 253 | * @acpi_match_table: The ACPI match table. |
880ffb5c WG |
254 | * @probe: Called to query the existence of a specific device, |
255 | * whether this driver can work with it, and bind the driver | |
256 | * to a specific device. | |
257 | * @remove: Called when the device is removed from the system to | |
258 | * unbind a device from this driver. | |
259 | * @shutdown: Called at shut-down time to quiesce the device. | |
260 | * @suspend: Called to put the device to sleep mode. Usually to a | |
261 | * low power state. | |
262 | * @resume: Called to bring a device from sleep mode. | |
263 | * @groups: Default attributes that get created by the driver core | |
264 | * automatically. | |
265 | * @pm: Power management operations of the device which matched | |
266 | * this driver. | |
ed4564ba AS |
267 | * @coredump: Called when sysfs entry is written to. The device driver |
268 | * is expected to call the dev_coredump API resulting in a | |
269 | * uevent. | |
880ffb5c WG |
270 | * @p: Driver core's private data, no one other than the driver |
271 | * core can touch this. | |
272 | * | |
273 | * The device driver-model tracks all of the drivers known to the system. | |
274 | * The main reason for this tracking is to enable the driver core to match | |
275 | * up drivers with new devices. Once drivers are known objects within the | |
276 | * system, however, a number of other things become possible. Device drivers | |
277 | * can export information and configuration variables that are independent | |
278 | * of any specific device. | |
279 | */ | |
1da177e4 | 280 | struct device_driver { |
e5dd1278 GKH |
281 | const char *name; |
282 | struct bus_type *bus; | |
1da177e4 | 283 | |
e5dd1278 | 284 | struct module *owner; |
1a6f2a75 DT |
285 | const char *mod_name; /* used for built-in modules */ |
286 | ||
287 | bool suppress_bind_attrs; /* disables bind/unbind via sysfs */ | |
765230b5 | 288 | enum probe_type probe_type; |
1da177e4 | 289 | |
597b9d1e | 290 | const struct of_device_id *of_match_table; |
06f64c8f | 291 | const struct acpi_device_id *acpi_match_table; |
597b9d1e | 292 | |
d462943a GKH |
293 | int (*probe) (struct device *dev); |
294 | int (*remove) (struct device *dev); | |
295 | void (*shutdown) (struct device *dev); | |
296 | int (*suspend) (struct device *dev, pm_message_t state); | |
297 | int (*resume) (struct device *dev); | |
a4dbd674 | 298 | const struct attribute_group **groups; |
e5dd1278 | 299 | |
8150f32b | 300 | const struct dev_pm_ops *pm; |
ed4564ba | 301 | void (*coredump) (struct device *dev); |
1eede070 | 302 | |
e5dd1278 | 303 | struct driver_private *p; |
1da177e4 LT |
304 | }; |
305 | ||
306 | ||
d462943a GKH |
307 | extern int __must_check driver_register(struct device_driver *drv); |
308 | extern void driver_unregister(struct device_driver *drv); | |
1da177e4 | 309 | |
d462943a GKH |
310 | extern struct device_driver *driver_find(const char *name, |
311 | struct bus_type *bus); | |
d779249e | 312 | extern int driver_probe_done(void); |
b23530eb | 313 | extern void wait_for_device_probe(void); |
216773a7 | 314 | |
405ae7d3 | 315 | /* sysfs interface for exporting driver attributes */ |
1da177e4 LT |
316 | |
317 | struct driver_attribute { | |
d462943a GKH |
318 | struct attribute attr; |
319 | ssize_t (*show)(struct device_driver *driver, char *buf); | |
320 | ssize_t (*store)(struct device_driver *driver, const char *buf, | |
321 | size_t count); | |
1da177e4 LT |
322 | }; |
323 | ||
ced321bf GKH |
324 | #define DRIVER_ATTR_RW(_name) \ |
325 | struct driver_attribute driver_attr_##_name = __ATTR_RW(_name) | |
326 | #define DRIVER_ATTR_RO(_name) \ | |
327 | struct driver_attribute driver_attr_##_name = __ATTR_RO(_name) | |
1130c55c GKH |
328 | #define DRIVER_ATTR_WO(_name) \ |
329 | struct driver_attribute driver_attr_##_name = __ATTR_WO(_name) | |
1da177e4 | 330 | |
d462943a | 331 | extern int __must_check driver_create_file(struct device_driver *driver, |
099c2f21 | 332 | const struct driver_attribute *attr); |
d462943a | 333 | extern void driver_remove_file(struct device_driver *driver, |
099c2f21 | 334 | const struct driver_attribute *attr); |
1da177e4 | 335 | |
d462943a GKH |
336 | extern int __must_check driver_for_each_device(struct device_driver *drv, |
337 | struct device *start, | |
338 | void *data, | |
339 | int (*fn)(struct device *dev, | |
340 | void *)); | |
341 | struct device *driver_find_device(struct device_driver *drv, | |
92ce7e83 SP |
342 | struct device *start, const void *data, |
343 | int (*match)(struct device *dev, const void *data)); | |
fae3cd00 | 344 | |
e7dd4010 | 345 | void driver_deferred_probe_add(struct device *dev); |
25b4e70d | 346 | int driver_deferred_probe_check_state(struct device *dev); |
62a6bc3a | 347 | int driver_deferred_probe_check_state_continue(struct device *dev); |
25b4e70d | 348 | |
ca22e56d KS |
349 | /** |
350 | * struct subsys_interface - interfaces to device functions | |
2eda013f RD |
351 | * @name: name of the device function |
352 | * @subsys: subsytem of the devices to attach to | |
353 | * @node: the list of functions registered at the subsystem | |
354 | * @add_dev: device hookup to device function handler | |
355 | * @remove_dev: device hookup to device function handler | |
ca22e56d KS |
356 | * |
357 | * Simple interfaces attached to a subsystem. Multiple interfaces can | |
358 | * attach to a subsystem and its devices. Unlike drivers, they do not | |
359 | * exclusively claim or control devices. Interfaces usually represent | |
360 | * a specific functionality of a subsystem/class of devices. | |
361 | */ | |
362 | struct subsys_interface { | |
363 | const char *name; | |
364 | struct bus_type *subsys; | |
365 | struct list_head node; | |
366 | int (*add_dev)(struct device *dev, struct subsys_interface *sif); | |
71db87ba | 367 | void (*remove_dev)(struct device *dev, struct subsys_interface *sif); |
ca22e56d KS |
368 | }; |
369 | ||
370 | int subsys_interface_register(struct subsys_interface *sif); | |
371 | void subsys_interface_unregister(struct subsys_interface *sif); | |
372 | ||
373 | int subsys_system_register(struct bus_type *subsys, | |
374 | const struct attribute_group **groups); | |
d73ce004 TH |
375 | int subsys_virtual_register(struct bus_type *subsys, |
376 | const struct attribute_group **groups); | |
ca22e56d | 377 | |
880ffb5c WG |
378 | /** |
379 | * struct class - device classes | |
380 | * @name: Name of the class. | |
381 | * @owner: The module owner. | |
ced6473e | 382 | * @class_groups: Default attributes of this class. |
d05a6f96 | 383 | * @dev_groups: Default attributes of the devices that belong to the class. |
880ffb5c WG |
384 | * @dev_kobj: The kobject that represents this class and links it into the hierarchy. |
385 | * @dev_uevent: Called when a device is added, removed from this class, or a | |
386 | * few other things that generate uevents to add the environment | |
387 | * variables. | |
388 | * @devnode: Callback to provide the devtmpfs. | |
389 | * @class_release: Called to release this class. | |
390 | * @dev_release: Called to release the device. | |
7521621e | 391 | * @shutdown_pre: Called at shut-down time before driver shutdown. |
880ffb5c WG |
392 | * @ns_type: Callbacks so sysfs can detemine namespaces. |
393 | * @namespace: Namespace of the device belongs to this class. | |
9944e894 DT |
394 | * @get_ownership: Allows class to specify uid/gid of the sysfs directories |
395 | * for the devices belonging to the class. Usually tied to | |
396 | * device's namespace. | |
880ffb5c WG |
397 | * @pm: The default device power management operations of this class. |
398 | * @p: The private data of the driver core, no one other than the | |
399 | * driver core can touch this. | |
400 | * | |
401 | * A class is a higher-level view of a device that abstracts out low-level | |
402 | * implementation details. Drivers may see a SCSI disk or an ATA disk, but, | |
403 | * at the class level, they are all simply disks. Classes allow user space | |
404 | * to work with devices based on what they do, rather than how they are | |
405 | * connected or how they work. | |
1da177e4 LT |
406 | */ |
407 | struct class { | |
d462943a GKH |
408 | const char *name; |
409 | struct module *owner; | |
1da177e4 | 410 | |
ced6473e | 411 | const struct attribute_group **class_groups; |
d05a6f96 | 412 | const struct attribute_group **dev_groups; |
e105b8bf | 413 | struct kobject *dev_kobj; |
1da177e4 | 414 | |
d462943a | 415 | int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env); |
2c9ede55 | 416 | char *(*devnode)(struct device *dev, umode_t *mode); |
1da177e4 | 417 | |
d462943a GKH |
418 | void (*class_release)(struct class *class); |
419 | void (*dev_release)(struct device *dev); | |
7c8265f5 | 420 | |
7521621e | 421 | int (*shutdown_pre)(struct device *dev); |
1eede070 | 422 | |
bc451f20 EB |
423 | const struct kobj_ns_type_operations *ns_type; |
424 | const void *(*namespace)(struct device *dev); | |
425 | ||
9944e894 DT |
426 | void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid); |
427 | ||
8150f32b DT |
428 | const struct dev_pm_ops *pm; |
429 | ||
6b6e39a6 | 430 | struct subsys_private *p; |
1da177e4 LT |
431 | }; |
432 | ||
5a3ceb86 TH |
433 | struct class_dev_iter { |
434 | struct klist_iter ki; | |
435 | const struct device_type *type; | |
436 | }; | |
437 | ||
e105b8bf DW |
438 | extern struct kobject *sysfs_dev_block_kobj; |
439 | extern struct kobject *sysfs_dev_char_kobj; | |
d2a3b914 MW |
440 | extern int __must_check __class_register(struct class *class, |
441 | struct lock_class_key *key); | |
d462943a | 442 | extern void class_unregister(struct class *class); |
d2a3b914 MW |
443 | |
444 | /* This is a #define to keep the compiler from merging different | |
445 | * instances of the __key variable */ | |
446 | #define class_register(class) \ | |
447 | ({ \ | |
448 | static struct lock_class_key __key; \ | |
449 | __class_register(class, &__key); \ | |
450 | }) | |
451 | ||
46227094 JD |
452 | struct class_compat; |
453 | struct class_compat *class_compat_register(const char *name); | |
454 | void class_compat_unregister(struct class_compat *cls); | |
455 | int class_compat_create_link(struct class_compat *cls, struct device *dev, | |
456 | struct device *device_link); | |
457 | void class_compat_remove_link(struct class_compat *cls, struct device *dev, | |
458 | struct device *device_link); | |
459 | ||
7cd9c9bb GKH |
460 | extern void class_dev_iter_init(struct class_dev_iter *iter, |
461 | struct class *class, | |
462 | struct device *start, | |
463 | const struct device_type *type); | |
5a3ceb86 TH |
464 | extern struct device *class_dev_iter_next(struct class_dev_iter *iter); |
465 | extern void class_dev_iter_exit(struct class_dev_iter *iter); | |
466 | ||
93562b53 GKH |
467 | extern int class_for_each_device(struct class *class, struct device *start, |
468 | void *data, | |
fd04897b | 469 | int (*fn)(struct device *dev, void *data)); |
695794ae | 470 | extern struct device *class_find_device(struct class *class, |
9f3b795a MM |
471 | struct device *start, const void *data, |
472 | int (*match)(struct device *, const void *)); | |
1da177e4 LT |
473 | |
474 | struct class_attribute { | |
d462943a | 475 | struct attribute attr; |
28812fe1 AK |
476 | ssize_t (*show)(struct class *class, struct class_attribute *attr, |
477 | char *buf); | |
478 | ssize_t (*store)(struct class *class, struct class_attribute *attr, | |
479 | const char *buf, size_t count); | |
1da177e4 LT |
480 | }; |
481 | ||
ced321bf GKH |
482 | #define CLASS_ATTR_RW(_name) \ |
483 | struct class_attribute class_attr_##_name = __ATTR_RW(_name) | |
484 | #define CLASS_ATTR_RO(_name) \ | |
485 | struct class_attribute class_attr_##_name = __ATTR_RO(_name) | |
2027cbcf GKH |
486 | #define CLASS_ATTR_WO(_name) \ |
487 | struct class_attribute class_attr_##_name = __ATTR_WO(_name) | |
1da177e4 | 488 | |
58292cbe TH |
489 | extern int __must_check class_create_file_ns(struct class *class, |
490 | const struct class_attribute *attr, | |
491 | const void *ns); | |
492 | extern void class_remove_file_ns(struct class *class, | |
493 | const struct class_attribute *attr, | |
494 | const void *ns); | |
495 | ||
496 | static inline int __must_check class_create_file(struct class *class, | |
497 | const struct class_attribute *attr) | |
498 | { | |
499 | return class_create_file_ns(class, attr, NULL); | |
500 | } | |
501 | ||
502 | static inline void class_remove_file(struct class *class, | |
503 | const struct class_attribute *attr) | |
504 | { | |
505 | return class_remove_file_ns(class, attr, NULL); | |
506 | } | |
1da177e4 | 507 | |
869dfc87 | 508 | /* Simple class attribute that is just a static string */ |
869dfc87 AK |
509 | struct class_attribute_string { |
510 | struct class_attribute attr; | |
511 | char *str; | |
512 | }; | |
513 | ||
514 | /* Currently read-only only */ | |
515 | #define _CLASS_ATTR_STRING(_name, _mode, _str) \ | |
516 | { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } | |
517 | #define CLASS_ATTR_STRING(_name, _mode, _str) \ | |
518 | struct class_attribute_string class_attr_##_name = \ | |
519 | _CLASS_ATTR_STRING(_name, _mode, _str) | |
520 | ||
521 | extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr, | |
522 | char *buf); | |
523 | ||
1da177e4 LT |
524 | struct class_interface { |
525 | struct list_head node; | |
526 | struct class *class; | |
527 | ||
c47ed219 GKH |
528 | int (*add_dev) (struct device *, struct class_interface *); |
529 | void (*remove_dev) (struct device *, struct class_interface *); | |
1da177e4 LT |
530 | }; |
531 | ||
4a7fb636 | 532 | extern int __must_check class_interface_register(struct class_interface *); |
1da177e4 LT |
533 | extern void class_interface_unregister(struct class_interface *); |
534 | ||
d2a3b914 MW |
535 | extern struct class * __must_check __class_create(struct module *owner, |
536 | const char *name, | |
537 | struct lock_class_key *key); | |
e9ba6365 | 538 | extern void class_destroy(struct class *cls); |
e9ba6365 | 539 | |
d2a3b914 MW |
540 | /* This is a #define to keep the compiler from merging different |
541 | * instances of the __key variable */ | |
542 | #define class_create(owner, name) \ | |
543 | ({ \ | |
544 | static struct lock_class_key __key; \ | |
545 | __class_create(owner, name, &__key); \ | |
546 | }) | |
547 | ||
414264f9 KS |
548 | /* |
549 | * The type of device, "struct device" is embedded in. A class | |
550 | * or bus can contain devices of different types | |
551 | * like "partitions" and "disks", "mouse" and "event". | |
552 | * This identifies the device type and carries type-specific | |
553 | * information, equivalent to the kobj_type of a kobject. | |
554 | * If "name" is specified, the uevent will contain it in | |
555 | * the DEVTYPE variable. | |
556 | */ | |
f9f852df | 557 | struct device_type { |
414264f9 | 558 | const char *name; |
a4dbd674 | 559 | const struct attribute_group **groups; |
7eff2e7a | 560 | int (*uevent)(struct device *dev, struct kobj_uevent_env *env); |
3c2670e6 | 561 | char *(*devnode)(struct device *dev, umode_t *mode, |
4e4098a3 | 562 | kuid_t *uid, kgid_t *gid); |
f9f852df | 563 | void (*release)(struct device *dev); |
1eede070 | 564 | |
8150f32b | 565 | const struct dev_pm_ops *pm; |
f9f852df KS |
566 | }; |
567 | ||
a7fd6706 KS |
568 | /* interface for exporting device attributes */ |
569 | struct device_attribute { | |
570 | struct attribute attr; | |
571 | ssize_t (*show)(struct device *dev, struct device_attribute *attr, | |
572 | char *buf); | |
573 | ssize_t (*store)(struct device *dev, struct device_attribute *attr, | |
574 | const char *buf, size_t count); | |
575 | }; | |
576 | ||
ca22e56d KS |
577 | struct dev_ext_attribute { |
578 | struct device_attribute attr; | |
579 | void *var; | |
580 | }; | |
581 | ||
582 | ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr, | |
583 | char *buf); | |
584 | ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr, | |
585 | const char *buf, size_t count); | |
586 | ssize_t device_show_int(struct device *dev, struct device_attribute *attr, | |
587 | char *buf); | |
588 | ssize_t device_store_int(struct device *dev, struct device_attribute *attr, | |
589 | const char *buf, size_t count); | |
91872392 BP |
590 | ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, |
591 | char *buf); | |
592 | ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, | |
593 | const char *buf, size_t count); | |
a7fd6706 | 594 | |
d462943a | 595 | #define DEVICE_ATTR(_name, _mode, _show, _store) \ |
ca22e56d | 596 | struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store) |
7fda9100 CL |
597 | #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \ |
598 | struct device_attribute dev_attr_##_name = \ | |
599 | __ATTR_PREALLOC(_name, _mode, _show, _store) | |
ced321bf GKH |
600 | #define DEVICE_ATTR_RW(_name) \ |
601 | struct device_attribute dev_attr_##_name = __ATTR_RW(_name) | |
602 | #define DEVICE_ATTR_RO(_name) \ | |
603 | struct device_attribute dev_attr_##_name = __ATTR_RO(_name) | |
1130c55c GKH |
604 | #define DEVICE_ATTR_WO(_name) \ |
605 | struct device_attribute dev_attr_##_name = __ATTR_WO(_name) | |
ca22e56d KS |
606 | #define DEVICE_ULONG_ATTR(_name, _mode, _var) \ |
607 | struct dev_ext_attribute dev_attr_##_name = \ | |
608 | { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) } | |
609 | #define DEVICE_INT_ATTR(_name, _mode, _var) \ | |
610 | struct dev_ext_attribute dev_attr_##_name = \ | |
94758185 | 611 | { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) } |
91872392 BP |
612 | #define DEVICE_BOOL_ATTR(_name, _mode, _var) \ |
613 | struct dev_ext_attribute dev_attr_##_name = \ | |
614 | { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) } | |
356c05d5 AS |
615 | #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ |
616 | struct device_attribute dev_attr_##_name = \ | |
617 | __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) | |
a7fd6706 | 618 | |
b9d4e714 GKH |
619 | extern int device_create_file(struct device *device, |
620 | const struct device_attribute *entry); | |
d462943a | 621 | extern void device_remove_file(struct device *dev, |
26579ab7 | 622 | const struct device_attribute *attr); |
6b0afc2a TH |
623 | extern bool device_remove_file_self(struct device *dev, |
624 | const struct device_attribute *attr); | |
2589f188 | 625 | extern int __must_check device_create_bin_file(struct device *dev, |
66ecb92b | 626 | const struct bin_attribute *attr); |
2589f188 | 627 | extern void device_remove_bin_file(struct device *dev, |
66ecb92b | 628 | const struct bin_attribute *attr); |
9ac7849e TH |
629 | |
630 | /* device resource management */ | |
631 | typedef void (*dr_release_t)(struct device *dev, void *res); | |
632 | typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data); | |
633 | ||
634 | #ifdef CONFIG_DEBUG_DEVRES | |
7c683941 | 635 | extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, |
48a27055 | 636 | int nid, const char *name) __malloc; |
9ac7849e | 637 | #define devres_alloc(release, size, gfp) \ |
7c683941 DW |
638 | __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release) |
639 | #define devres_alloc_node(release, size, gfp, nid) \ | |
640 | __devres_alloc_node(release, size, gfp, nid, #release) | |
9ac7849e | 641 | #else |
7c683941 | 642 | extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, |
48a27055 | 643 | int nid) __malloc; |
7c683941 DW |
644 | static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp) |
645 | { | |
646 | return devres_alloc_node(release, size, gfp, NUMA_NO_NODE); | |
647 | } | |
9ac7849e | 648 | #endif |
7c683941 | 649 | |
bddb1b90 ML |
650 | extern void devres_for_each_res(struct device *dev, dr_release_t release, |
651 | dr_match_t match, void *match_data, | |
652 | void (*fn)(struct device *, void *, void *), | |
653 | void *data); | |
9ac7849e TH |
654 | extern void devres_free(void *res); |
655 | extern void devres_add(struct device *dev, void *res); | |
d462943a | 656 | extern void *devres_find(struct device *dev, dr_release_t release, |
9ac7849e | 657 | dr_match_t match, void *match_data); |
d462943a GKH |
658 | extern void *devres_get(struct device *dev, void *new_res, |
659 | dr_match_t match, void *match_data); | |
660 | extern void *devres_remove(struct device *dev, dr_release_t release, | |
661 | dr_match_t match, void *match_data); | |
9ac7849e TH |
662 | extern int devres_destroy(struct device *dev, dr_release_t release, |
663 | dr_match_t match, void *match_data); | |
d926d0e4 MB |
664 | extern int devres_release(struct device *dev, dr_release_t release, |
665 | dr_match_t match, void *match_data); | |
9ac7849e TH |
666 | |
667 | /* devres group */ | |
668 | extern void * __must_check devres_open_group(struct device *dev, void *id, | |
669 | gfp_t gfp); | |
670 | extern void devres_close_group(struct device *dev, void *id); | |
671 | extern void devres_remove_group(struct device *dev, void *id); | |
672 | extern int devres_release_group(struct device *dev, void *id); | |
673 | ||
64c862a8 | 674 | /* managed devm_k.alloc/kfree for device drivers */ |
48a27055 | 675 | extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc; |
8db14860 NI |
676 | extern __printf(3, 0) |
677 | char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt, | |
48a27055 | 678 | va_list ap) __malloc; |
bef59c50 | 679 | extern __printf(3, 4) |
48a27055 | 680 | char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc; |
64c862a8 JP |
681 | static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp) |
682 | { | |
683 | return devm_kmalloc(dev, size, gfp | __GFP_ZERO); | |
684 | } | |
685 | static inline void *devm_kmalloc_array(struct device *dev, | |
686 | size_t n, size_t size, gfp_t flags) | |
687 | { | |
2509b561 KC |
688 | size_t bytes; |
689 | ||
690 | if (unlikely(check_mul_overflow(n, size, &bytes))) | |
64c862a8 | 691 | return NULL; |
2509b561 KC |
692 | |
693 | return devm_kmalloc(dev, bytes, flags); | |
64c862a8 JP |
694 | } |
695 | static inline void *devm_kcalloc(struct device *dev, | |
696 | size_t n, size_t size, gfp_t flags) | |
697 | { | |
698 | return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO); | |
699 | } | |
0571967d | 700 | extern void devm_kfree(struct device *dev, const void *p); |
48a27055 | 701 | extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc; |
09d1ea1c BG |
702 | extern const char *devm_kstrdup_const(struct device *dev, |
703 | const char *s, gfp_t gfp); | |
3046365b SP |
704 | extern void *devm_kmemdup(struct device *dev, const void *src, size_t len, |
705 | gfp_t gfp); | |
9ac7849e | 706 | |
43339bed EB |
707 | extern unsigned long devm_get_free_pages(struct device *dev, |
708 | gfp_t gfp_mask, unsigned int order); | |
709 | extern void devm_free_pages(struct device *dev, unsigned long addr); | |
9ac7849e | 710 | |
eef778c9 AB |
711 | void __iomem *devm_ioremap_resource(struct device *dev, |
712 | const struct resource *res); | |
72f8c0bf | 713 | |
d5e83827 BH |
714 | void __iomem *devm_of_iomap(struct device *dev, |
715 | struct device_node *node, int index, | |
716 | resource_size_t *size); | |
717 | ||
d6b0c580 DT |
718 | /* allows to add/remove a custom action to devres stack */ |
719 | int devm_add_action(struct device *dev, void (*action)(void *), void *data); | |
720 | void devm_remove_action(struct device *dev, void (*action)(void *), void *data); | |
2374b682 | 721 | void devm_release_action(struct device *dev, void (*action)(void *), void *data); |
d6b0c580 | 722 | |
a3499e9b SM |
723 | static inline int devm_add_action_or_reset(struct device *dev, |
724 | void (*action)(void *), void *data) | |
725 | { | |
726 | int ret; | |
727 | ||
728 | ret = devm_add_action(dev, action, data); | |
729 | if (ret) | |
730 | action(data); | |
731 | ||
732 | return ret; | |
733 | } | |
734 | ||
ff86aae3 MB |
735 | /** |
736 | * devm_alloc_percpu - Resource-managed alloc_percpu | |
737 | * @dev: Device to allocate per-cpu memory for | |
738 | * @type: Type to allocate per-cpu memory for | |
739 | * | |
740 | * Managed alloc_percpu. Per-cpu memory allocated with this function is | |
741 | * automatically freed on driver detach. | |
742 | * | |
743 | * RETURNS: | |
744 | * Pointer to allocated memory on success, NULL on failure. | |
745 | */ | |
746 | #define devm_alloc_percpu(dev, type) \ | |
747 | ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \ | |
748 | __alignof__(type))) | |
749 | ||
750 | void __percpu *__devm_alloc_percpu(struct device *dev, size_t size, | |
751 | size_t align); | |
752 | void devm_free_percpu(struct device *dev, void __percpu *pdata); | |
753 | ||
6b7b6510 FT |
754 | struct device_dma_parameters { |
755 | /* | |
756 | * a low level driver may set these to teach IOMMU code about | |
757 | * sg limitations. | |
758 | */ | |
759 | unsigned int max_segment_size; | |
760 | unsigned long segment_boundary_mask; | |
761 | }; | |
762 | ||
f2d9b66d HK |
763 | /** |
764 | * struct device_connection - Device Connection Descriptor | |
09aa11cf | 765 | * @fwnode: The device node of the connected device |
f2d9b66d HK |
766 | * @endpoint: The names of the two devices connected together |
767 | * @id: Unique identifier for the connection | |
768 | * @list: List head, private, for internal use only | |
09aa11cf HK |
769 | * |
770 | * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when | |
771 | * platform firmware defines the connection. When the connection is registered | |
772 | * with device_connection_add() @endpoint is used instead. | |
f2d9b66d HK |
773 | */ |
774 | struct device_connection { | |
09aa11cf | 775 | struct fwnode_handle *fwnode; |
f2d9b66d HK |
776 | const char *endpoint[2]; |
777 | const char *id; | |
778 | struct list_head list; | |
779 | }; | |
780 | ||
781 | void *device_connection_find_match(struct device *dev, const char *con_id, | |
782 | void *data, | |
783 | void *(*match)(struct device_connection *con, | |
784 | int ep, void *data)); | |
785 | ||
786 | struct device *device_connection_find(struct device *dev, const char *con_id); | |
787 | ||
788 | void device_connection_add(struct device_connection *con); | |
789 | void device_connection_remove(struct device_connection *con); | |
790 | ||
cd7753d3 HK |
791 | /** |
792 | * device_connections_add - Add multiple device connections at once | |
793 | * @cons: Zero terminated array of device connection descriptors | |
794 | */ | |
795 | static inline void device_connections_add(struct device_connection *cons) | |
796 | { | |
797 | struct device_connection *c; | |
798 | ||
799 | for (c = cons; c->endpoint[0]; c++) | |
800 | device_connection_add(c); | |
801 | } | |
802 | ||
803 | /** | |
804 | * device_connections_remove - Remove multiple device connections at once | |
805 | * @cons: Zero terminated array of device connection descriptors | |
806 | */ | |
807 | static inline void device_connections_remove(struct device_connection *cons) | |
808 | { | |
809 | struct device_connection *c; | |
810 | ||
811 | for (c = cons; c->endpoint[0]; c++) | |
812 | device_connection_remove(c); | |
813 | } | |
814 | ||
9ed98953 RW |
815 | /** |
816 | * enum device_link_state - Device link states. | |
817 | * @DL_STATE_NONE: The presence of the drivers is not being tracked. | |
818 | * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. | |
819 | * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. | |
820 | * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). | |
821 | * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. | |
822 | * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. | |
823 | */ | |
824 | enum device_link_state { | |
825 | DL_STATE_NONE = -1, | |
826 | DL_STATE_DORMANT = 0, | |
827 | DL_STATE_AVAILABLE, | |
828 | DL_STATE_CONSUMER_PROBE, | |
829 | DL_STATE_ACTIVE, | |
830 | DL_STATE_SUPPLIER_UNBIND, | |
831 | }; | |
832 | ||
833 | /* | |
834 | * Device link flags. | |
835 | * | |
836 | * STATELESS: The core won't track the presence of supplier/consumer drivers. | |
e88728f4 | 837 | * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind. |
21d5c57b RW |
838 | * PM_RUNTIME: If set, the runtime PM framework will use this link. |
839 | * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. | |
1689cac5 | 840 | * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind. |
e7dd4010 | 841 | * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds. |
9ed98953 | 842 | */ |
e88728f4 VG |
843 | #define DL_FLAG_STATELESS BIT(0) |
844 | #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1) | |
845 | #define DL_FLAG_PM_RUNTIME BIT(2) | |
846 | #define DL_FLAG_RPM_ACTIVE BIT(3) | |
1689cac5 | 847 | #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4) |
e7dd4010 | 848 | #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5) |
9ed98953 RW |
849 | |
850 | /** | |
851 | * struct device_link - Device link representation. | |
852 | * @supplier: The device on the supplier end of the link. | |
853 | * @s_node: Hook to the supplier device's list of links to consumers. | |
854 | * @consumer: The device on the consumer end of the link. | |
855 | * @c_node: Hook to the consumer device's list of links to suppliers. | |
856 | * @status: The state of the link (with respect to the presence of drivers). | |
857 | * @flags: Link flags. | |
21d5c57b | 858 | * @rpm_active: Whether or not the consumer device is runtime-PM-active. |
ead18c23 | 859 | * @kref: Count repeated addition of the same link. |
9ed98953 | 860 | * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks. |
a7013ba5 | 861 | * @supplier_preactivated: Supplier has been made active before consumer probe. |
9ed98953 RW |
862 | */ |
863 | struct device_link { | |
864 | struct device *supplier; | |
865 | struct list_head s_node; | |
866 | struct device *consumer; | |
867 | struct list_head c_node; | |
868 | enum device_link_state status; | |
869 | u32 flags; | |
e2f3cd83 | 870 | refcount_t rpm_active; |
ead18c23 | 871 | struct kref kref; |
9ed98953 RW |
872 | #ifdef CONFIG_SRCU |
873 | struct rcu_head rcu_head; | |
874 | #endif | |
36003d4c | 875 | bool supplier_preactivated; /* Owned by consumer probe. */ |
9ed98953 RW |
876 | }; |
877 | ||
878 | /** | |
879 | * enum dl_dev_state - Device driver presence tracking information. | |
880 | * @DL_DEV_NO_DRIVER: There is no driver attached to the device. | |
881 | * @DL_DEV_PROBING: A driver is probing. | |
882 | * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. | |
883 | * @DL_DEV_UNBINDING: The driver is unbinding from the device. | |
884 | */ | |
885 | enum dl_dev_state { | |
886 | DL_DEV_NO_DRIVER = 0, | |
887 | DL_DEV_PROBING, | |
888 | DL_DEV_DRIVER_BOUND, | |
889 | DL_DEV_UNBINDING, | |
890 | }; | |
891 | ||
892 | /** | |
893 | * struct dev_links_info - Device data related to device links. | |
894 | * @suppliers: List of links to supplier devices. | |
895 | * @consumers: List of links to consumer devices. | |
896 | * @status: Driver status information. | |
897 | */ | |
898 | struct dev_links_info { | |
899 | struct list_head suppliers; | |
900 | struct list_head consumers; | |
901 | enum dl_dev_state status; | |
902 | }; | |
903 | ||
880ffb5c WG |
904 | /** |
905 | * struct device - The basic device structure | |
906 | * @parent: The device's "parent" device, the device to which it is attached. | |
907 | * In most cases, a parent device is some sort of bus or host | |
908 | * controller. If parent is NULL, the device, is a top-level device, | |
909 | * which is not usually what you want. | |
910 | * @p: Holds the private data of the driver core portions of the device. | |
911 | * See the comment of the struct device_private for detail. | |
912 | * @kobj: A top-level, abstract class from which other classes are derived. | |
913 | * @init_name: Initial name of the device. | |
914 | * @type: The type of device. | |
915 | * This identifies the device type and carries type-specific | |
916 | * information. | |
917 | * @mutex: Mutex to synchronize calls to its driver. | |
918 | * @bus: Type of bus device is on. | |
919 | * @driver: Which driver has allocated this | |
920 | * @platform_data: Platform data specific to the device. | |
921 | * Example: For devices on custom boards, as typical of embedded | |
922 | * and SOC based hardware, Linux often uses platform_data to point | |
923 | * to board-specific structures describing devices and how they | |
924 | * are wired. That can include what ports are available, chip | |
925 | * variants, which GPIO pins act in what additional roles, and so | |
926 | * on. This shrinks the "Board Support Packages" (BSPs) and | |
927 | * minimizes board-specific #ifdefs in drivers. | |
1bb6c08a | 928 | * @driver_data: Private pointer for driver specific info. |
64df1148 | 929 | * @links: Links to suppliers and consumers of this device. |
880ffb5c | 930 | * @power: For device power management. |
74378c5c | 931 | * See Documentation/driver-api/pm/devices.rst for details. |
564b905a | 932 | * @pm_domain: Provide callbacks that are executed during system suspend, |
880ffb5c WG |
933 | * hibernation, system resume and during runtime PM transitions |
934 | * along with subsystem-level and driver-level callbacks. | |
ab78029e | 935 | * @pins: For device pin management. |
0cca6c89 | 936 | * See Documentation/driver-api/pinctl.rst for details. |
4a7cc831 | 937 | * @msi_list: Hosts MSI descriptors |
f1421db8 | 938 | * @msi_domain: The generic MSI domain this device is using. |
880ffb5c | 939 | * @numa_node: NUMA node this device is close to. |
6a7a8176 | 940 | * @dma_ops: DMA mapping operations for this device. |
880ffb5c WG |
941 | * @dma_mask: Dma mask (if dma'ble device). |
942 | * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all | |
943 | * hardware supports 64-bit addresses for consistent allocations | |
944 | * such descriptors. | |
f07d141f RM |
945 | * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA |
946 | * limit than the device itself supports. | |
8febcaa2 | 947 | * @dma_pfn_offset: offset of DMA memory range relatively of RAM |
880ffb5c WG |
948 | * @dma_parms: A low level driver may set these to teach IOMMU code about |
949 | * segment limitations. | |
950 | * @dma_pools: Dma pools (if dma'ble device). | |
951 | * @dma_mem: Internal for coherent mem override. | |
bfd63cd2 | 952 | * @cma_area: Contiguous memory area for dma allocations |
880ffb5c WG |
953 | * @archdata: For arch-specific additions. |
954 | * @of_node: Associated device tree node. | |
ce793486 | 955 | * @fwnode: Associated device node supplied by platform firmware. |
880ffb5c | 956 | * @devt: For creating the sysfs "dev". |
2eda013f | 957 | * @id: device instance |
880ffb5c WG |
958 | * @devres_lock: Spinlock to protect the resource of the device. |
959 | * @devres_head: The resources list of the device. | |
960 | * @knode_class: The node used to add the device to the class list. | |
961 | * @class: The class of the device. | |
962 | * @groups: Optional attribute groups. | |
963 | * @release: Callback to free the device after all references have | |
964 | * gone away. This should be set by the allocator of the | |
965 | * device (i.e. the bus driver that discovered the device). | |
bfd63cd2 | 966 | * @iommu_group: IOMMU group the device belongs to. |
57f98d2f | 967 | * @iommu_fwspec: IOMMU-specific properties supplied by firmware. |
ec6bc2e9 | 968 | * @iommu_param: Per device generic IOMMU runtime data |
880ffb5c | 969 | * |
4f3549d7 RW |
970 | * @offline_disabled: If set, the device is permanently online. |
971 | * @offline: Set after successful invocation of bus type's .offline(). | |
4e75e1d7 JH |
972 | * @of_node_reused: Set if the device-tree node is shared with an ancestor |
973 | * device. | |
f3ecc0ff CH |
974 | * @dma_coherent: this particular device is dma coherent, even if the |
975 | * architecture supports non-coherent devices. | |
880ffb5c WG |
976 | * |
977 | * At the lowest level, every device in a Linux system is represented by an | |
978 | * instance of struct device. The device structure contains the information | |
979 | * that the device model core needs to model the system. Most subsystems, | |
980 | * however, track additional information about the devices they host. As a | |
981 | * result, it is rare for devices to be represented by bare device structures; | |
982 | * instead, that structure, like kobject structures, is usually embedded within | |
983 | * a higher-level representation of the device. | |
984 | */ | |
1da177e4 | 985 | struct device { |
159ef31e | 986 | struct kobject kobj; |
49a4ec18 | 987 | struct device *parent; |
1da177e4 | 988 | |
fb069a5d GKH |
989 | struct device_private *p; |
990 | ||
c906a48a | 991 | const char *init_name; /* initial name of the device */ |
aed65af1 | 992 | const struct device_type *type; |
1da177e4 | 993 | |
d462943a | 994 | struct bus_type *bus; /* type of bus device is on */ |
1da177e4 LT |
995 | struct device_driver *driver; /* which driver has allocated this |
996 | device */ | |
e67c8562 GKH |
997 | void *platform_data; /* Platform specific data, device |
998 | core doesn't touch it */ | |
1bb6c08a | 999 | void *driver_data; /* Driver data, set and get with |
2c6f4fc8 | 1000 | dev_set_drvdata/dev_get_drvdata */ |
159ef31e GKH |
1001 | struct mutex mutex; /* mutex to synchronize calls to |
1002 | * its driver. | |
1003 | */ | |
1004 | ||
9ed98953 | 1005 | struct dev_links_info links; |
1da177e4 | 1006 | struct dev_pm_info power; |
564b905a | 1007 | struct dev_pm_domain *pm_domain; |
1da177e4 | 1008 | |
f1421db8 MZ |
1009 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN |
1010 | struct irq_domain *msi_domain; | |
1011 | #endif | |
ab78029e LW |
1012 | #ifdef CONFIG_PINCTRL |
1013 | struct dev_pin_info *pins; | |
1014 | #endif | |
4a7cc831 JL |
1015 | #ifdef CONFIG_GENERIC_MSI_IRQ |
1016 | struct list_head msi_list; | |
1017 | #endif | |
ab78029e | 1018 | |
5657933d | 1019 | const struct dma_map_ops *dma_ops; |
1da177e4 LT |
1020 | u64 *dma_mask; /* dma mask (if dma'able device) */ |
1021 | u64 coherent_dma_mask;/* Like dma_mask, but for | |
1022 | alloc_coherent mappings as | |
1023 | not all hardware supports | |
1024 | 64 bit addresses for consistent | |
1025 | allocations such descriptors. */ | |
f07d141f | 1026 | u64 bus_dma_mask; /* upstream dma_mask constraint */ |
8febcaa2 | 1027 | unsigned long dma_pfn_offset; |
1da177e4 | 1028 | |
6b7b6510 FT |
1029 | struct device_dma_parameters *dma_parms; |
1030 | ||
1da177e4 LT |
1031 | struct list_head dma_pools; /* dma pools (if dma'ble) */ |
1032 | ||
ff4c25f2 | 1033 | #ifdef CONFIG_DMA_DECLARE_COHERENT |
1da177e4 LT |
1034 | struct dma_coherent_mem *dma_mem; /* internal for coherent mem |
1035 | override */ | |
2b281296 | 1036 | #endif |
a2547380 | 1037 | #ifdef CONFIG_DMA_CMA |
c64be2bb MS |
1038 | struct cma *cma_area; /* contiguous memory area for dma |
1039 | allocations */ | |
1040 | #endif | |
c6dbaef2 BH |
1041 | /* arch specific additions */ |
1042 | struct dev_archdata archdata; | |
c9e358df GL |
1043 | |
1044 | struct device_node *of_node; /* associated device tree node */ | |
ce793486 | 1045 | struct fwnode_handle *fwnode; /* firmware device node */ |
1da177e4 | 1046 | |
159ef31e GKH |
1047 | #ifdef CONFIG_NUMA |
1048 | int numa_node; /* NUMA node this device is close to */ | |
1049 | #endif | |
929d2fa5 | 1050 | dev_t devt; /* dev_t, creates the sysfs "dev" */ |
ca22e56d | 1051 | u32 id; /* device instance */ |
929d2fa5 | 1052 | |
9ac7849e TH |
1053 | spinlock_t devres_lock; |
1054 | struct list_head devres_head; | |
1055 | ||
b7a3e813 | 1056 | struct class *class; |
a4dbd674 | 1057 | const struct attribute_group **groups; /* optional groups */ |
23681e47 | 1058 | |
d462943a | 1059 | void (*release)(struct device *dev); |
74416e1e | 1060 | struct iommu_group *iommu_group; |
57f98d2f | 1061 | struct iommu_fwspec *iommu_fwspec; |
ec6bc2e9 | 1062 | struct iommu_param *iommu_param; |
4f3549d7 RW |
1063 | |
1064 | bool offline_disabled:1; | |
1065 | bool offline:1; | |
4e75e1d7 | 1066 | bool of_node_reused:1; |
f3ecc0ff CH |
1067 | #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ |
1068 | defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ | |
1069 | defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) | |
1070 | bool dma_coherent:1; | |
1071 | #endif | |
1da177e4 LT |
1072 | }; |
1073 | ||
a4232963 LPC |
1074 | static inline struct device *kobj_to_dev(struct kobject *kobj) |
1075 | { | |
1076 | return container_of(kobj, struct device, kobj); | |
1077 | } | |
1078 | ||
dbba197e JR |
1079 | /** |
1080 | * device_iommu_mapped - Returns true when the device DMA is translated | |
1081 | * by an IOMMU | |
1082 | * @dev: Device to perform the check on | |
1083 | */ | |
1084 | static inline bool device_iommu_mapped(struct device *dev) | |
1085 | { | |
1086 | return (dev->iommu_group != NULL); | |
1087 | } | |
1088 | ||
9a3df1f7 AS |
1089 | /* Get the wakeup routines, which depend on struct device */ |
1090 | #include <linux/pm_wakeup.h> | |
1091 | ||
bf9ca69f | 1092 | static inline const char *dev_name(const struct device *dev) |
06916639 | 1093 | { |
a636ee7f PM |
1094 | /* Use the init name until the kobject becomes available */ |
1095 | if (dev->init_name) | |
1096 | return dev->init_name; | |
1097 | ||
1fa5ae85 | 1098 | return kobject_name(&dev->kobj); |
06916639 KS |
1099 | } |
1100 | ||
b9075fa9 JP |
1101 | extern __printf(2, 3) |
1102 | int dev_set_name(struct device *dev, const char *name, ...); | |
413c239f | 1103 | |
87348136 CH |
1104 | #ifdef CONFIG_NUMA |
1105 | static inline int dev_to_node(struct device *dev) | |
1106 | { | |
1107 | return dev->numa_node; | |
1108 | } | |
1109 | static inline void set_dev_node(struct device *dev, int node) | |
1110 | { | |
1111 | dev->numa_node = node; | |
1112 | } | |
1113 | #else | |
1114 | static inline int dev_to_node(struct device *dev) | |
1115 | { | |
98fa15f3 | 1116 | return NUMA_NO_NODE; |
87348136 CH |
1117 | } |
1118 | static inline void set_dev_node(struct device *dev, int node) | |
1119 | { | |
1120 | } | |
1121 | #endif | |
1122 | ||
f1421db8 MZ |
1123 | static inline struct irq_domain *dev_get_msi_domain(const struct device *dev) |
1124 | { | |
1125 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN | |
1126 | return dev->msi_domain; | |
1127 | #else | |
1128 | return NULL; | |
1129 | #endif | |
1130 | } | |
1131 | ||
1132 | static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d) | |
1133 | { | |
1134 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN | |
1135 | dev->msi_domain = d; | |
1136 | #endif | |
1137 | } | |
1138 | ||
a996d010 JD |
1139 | static inline void *dev_get_drvdata(const struct device *dev) |
1140 | { | |
1141 | return dev->driver_data; | |
1142 | } | |
1143 | ||
1144 | static inline void dev_set_drvdata(struct device *dev, void *data) | |
1145 | { | |
1146 | dev->driver_data = data; | |
1147 | } | |
1148 | ||
5c095a0e RW |
1149 | static inline struct pm_subsys_data *dev_to_psd(struct device *dev) |
1150 | { | |
1151 | return dev ? dev->power.subsys_data : NULL; | |
1152 | } | |
1153 | ||
f67f129e ML |
1154 | static inline unsigned int dev_get_uevent_suppress(const struct device *dev) |
1155 | { | |
1156 | return dev->kobj.uevent_suppress; | |
1157 | } | |
1158 | ||
1159 | static inline void dev_set_uevent_suppress(struct device *dev, int val) | |
1160 | { | |
1161 | dev->kobj.uevent_suppress = val; | |
1162 | } | |
1163 | ||
d305ef5d DR |
1164 | static inline int device_is_registered(struct device *dev) |
1165 | { | |
3f62e570 | 1166 | return dev->kobj.state_in_sysfs; |
d305ef5d DR |
1167 | } |
1168 | ||
5af84b82 RW |
1169 | static inline void device_enable_async_suspend(struct device *dev) |
1170 | { | |
f76b168b | 1171 | if (!dev->power.is_prepared) |
5af84b82 RW |
1172 | dev->power.async_suspend = true; |
1173 | } | |
1174 | ||
5a2eb858 RW |
1175 | static inline void device_disable_async_suspend(struct device *dev) |
1176 | { | |
f76b168b | 1177 | if (!dev->power.is_prepared) |
5a2eb858 RW |
1178 | dev->power.async_suspend = false; |
1179 | } | |
1180 | ||
1181 | static inline bool device_async_suspend_enabled(struct device *dev) | |
1182 | { | |
1183 | return !!dev->power.async_suspend; | |
1184 | } | |
1185 | ||
85945c28 SH |
1186 | static inline bool device_pm_not_required(struct device *dev) |
1187 | { | |
1188 | return dev->power.no_pm; | |
1189 | } | |
1190 | ||
1191 | static inline void device_set_pm_not_required(struct device *dev) | |
1192 | { | |
1193 | dev->power.no_pm = true; | |
1194 | } | |
1195 | ||
feb70af0 RW |
1196 | static inline void dev_pm_syscore_device(struct device *dev, bool val) |
1197 | { | |
1198 | #ifdef CONFIG_PM_SLEEP | |
1199 | dev->power.syscore = val; | |
1200 | #endif | |
1201 | } | |
1202 | ||
08810a41 RW |
1203 | static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags) |
1204 | { | |
1205 | dev->power.driver_flags = flags; | |
1206 | } | |
1207 | ||
1208 | static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags) | |
1209 | { | |
1210 | return !!(dev->power.driver_flags & flags); | |
1211 | } | |
1212 | ||
8e9394ce GKH |
1213 | static inline void device_lock(struct device *dev) |
1214 | { | |
3142788b | 1215 | mutex_lock(&dev->mutex); |
8e9394ce GKH |
1216 | } |
1217 | ||
7dd9cba5 ON |
1218 | static inline int device_lock_interruptible(struct device *dev) |
1219 | { | |
1220 | return mutex_lock_interruptible(&dev->mutex); | |
1221 | } | |
1222 | ||
8e9394ce GKH |
1223 | static inline int device_trylock(struct device *dev) |
1224 | { | |
3142788b | 1225 | return mutex_trylock(&dev->mutex); |
8e9394ce GKH |
1226 | } |
1227 | ||
1228 | static inline void device_unlock(struct device *dev) | |
1229 | { | |
3142788b | 1230 | mutex_unlock(&dev->mutex); |
8e9394ce GKH |
1231 | } |
1232 | ||
ac801022 KRW |
1233 | static inline void device_lock_assert(struct device *dev) |
1234 | { | |
1235 | lockdep_assert_held(&dev->mutex); | |
1236 | } | |
1237 | ||
e8a51e1b BH |
1238 | static inline struct device_node *dev_of_node(struct device *dev) |
1239 | { | |
1b833924 | 1240 | if (!IS_ENABLED(CONFIG_OF) || !dev) |
e8a51e1b BH |
1241 | return NULL; |
1242 | return dev->of_node; | |
1243 | } | |
1244 | ||
1f21782e AB |
1245 | void driver_init(void); |
1246 | ||
1da177e4 LT |
1247 | /* |
1248 | * High level routines for use by the bus drivers | |
1249 | */ | |
d462943a GKH |
1250 | extern int __must_check device_register(struct device *dev); |
1251 | extern void device_unregister(struct device *dev); | |
1252 | extern void device_initialize(struct device *dev); | |
1253 | extern int __must_check device_add(struct device *dev); | |
1254 | extern void device_del(struct device *dev); | |
1255 | extern int device_for_each_child(struct device *dev, void *data, | |
1256 | int (*fn)(struct device *dev, void *data)); | |
3d060aeb AS |
1257 | extern int device_for_each_child_reverse(struct device *dev, void *data, |
1258 | int (*fn)(struct device *dev, void *data)); | |
d462943a GKH |
1259 | extern struct device *device_find_child(struct device *dev, void *data, |
1260 | int (*match)(struct device *dev, void *data)); | |
dad9bb01 HK |
1261 | extern struct device *device_find_child_by_name(struct device *parent, |
1262 | const char *name); | |
6937e8f8 | 1263 | extern int device_rename(struct device *dev, const char *new_name); |
ffa6a705 CH |
1264 | extern int device_move(struct device *dev, struct device *new_parent, |
1265 | enum dpm_order dpm_order); | |
e454cea2 | 1266 | extern const char *device_get_devnode(struct device *dev, |
4e4098a3 | 1267 | umode_t *mode, kuid_t *uid, kgid_t *gid, |
3c2670e6 | 1268 | const char **tmp); |
1da177e4 | 1269 | |
4f3549d7 RW |
1270 | static inline bool device_supports_offline(struct device *dev) |
1271 | { | |
1272 | return dev->bus && dev->bus->offline && dev->bus->online; | |
1273 | } | |
1274 | ||
1275 | extern void lock_device_hotplug(void); | |
1276 | extern void unlock_device_hotplug(void); | |
5e33bc41 | 1277 | extern int lock_device_hotplug_sysfs(void); |
4f3549d7 RW |
1278 | extern int device_offline(struct device *dev); |
1279 | extern int device_online(struct device *dev); | |
97badf87 RW |
1280 | extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode); |
1281 | extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode); | |
4e75e1d7 | 1282 | void device_set_of_node_from_dev(struct device *dev, const struct device *dev2); |
97badf87 | 1283 | |
9af15c38 PS |
1284 | static inline int dev_num_vf(struct device *dev) |
1285 | { | |
1286 | if (dev->bus && dev->bus->num_vf) | |
1287 | return dev->bus->num_vf(dev); | |
1288 | return 0; | |
1289 | } | |
1290 | ||
0aa0dc41 MM |
1291 | /* |
1292 | * Root device objects for grouping under /sys/devices | |
1293 | */ | |
1294 | extern struct device *__root_device_register(const char *name, | |
1295 | struct module *owner); | |
eb5589a8 | 1296 | |
33ac1257 | 1297 | /* This is a macro to avoid include problems with THIS_MODULE */ |
eb5589a8 PG |
1298 | #define root_device_register(name) \ |
1299 | __root_device_register(name, THIS_MODULE) | |
1300 | ||
0aa0dc41 MM |
1301 | extern void root_device_unregister(struct device *root); |
1302 | ||
a5b8b1ad MB |
1303 | static inline void *dev_get_platdata(const struct device *dev) |
1304 | { | |
1305 | return dev->platform_data; | |
1306 | } | |
1307 | ||
1da177e4 LT |
1308 | /* |
1309 | * Manual binding of a device to driver. See drivers/base/bus.c | |
1310 | * for information on use. | |
1311 | */ | |
f86db396 | 1312 | extern int __must_check device_bind_driver(struct device *dev); |
d462943a GKH |
1313 | extern void device_release_driver(struct device *dev); |
1314 | extern int __must_check device_attach(struct device *dev); | |
f86db396 | 1315 | extern int __must_check driver_attach(struct device_driver *drv); |
765230b5 | 1316 | extern void device_initial_probe(struct device *dev); |
f86db396 | 1317 | extern int __must_check device_reprobe(struct device *dev); |
1da177e4 | 1318 | |
6b9cb427 TV |
1319 | extern bool device_is_bound(struct device *dev); |
1320 | ||
23681e47 GKH |
1321 | /* |
1322 | * Easy functions for dynamically creating devices on the fly | |
1323 | */ | |
8db14860 NI |
1324 | extern __printf(5, 0) |
1325 | struct device *device_create_vargs(struct class *cls, struct device *parent, | |
1326 | dev_t devt, void *drvdata, | |
1327 | const char *fmt, va_list vargs); | |
b9075fa9 JP |
1328 | extern __printf(5, 6) |
1329 | struct device *device_create(struct class *cls, struct device *parent, | |
1330 | dev_t devt, void *drvdata, | |
1331 | const char *fmt, ...); | |
39ef3112 GR |
1332 | extern __printf(6, 7) |
1333 | struct device *device_create_with_groups(struct class *cls, | |
1334 | struct device *parent, dev_t devt, void *drvdata, | |
1335 | const struct attribute_group **groups, | |
1336 | const char *fmt, ...); | |
23681e47 | 1337 | extern void device_destroy(struct class *cls, dev_t devt); |
1da177e4 | 1338 | |
a7670d42 DT |
1339 | extern int __must_check device_add_groups(struct device *dev, |
1340 | const struct attribute_group **groups); | |
1341 | extern void device_remove_groups(struct device *dev, | |
1342 | const struct attribute_group **groups); | |
1343 | ||
e323b2dd DT |
1344 | static inline int __must_check device_add_group(struct device *dev, |
1345 | const struct attribute_group *grp) | |
1346 | { | |
1347 | const struct attribute_group *groups[] = { grp, NULL }; | |
1348 | ||
1349 | return device_add_groups(dev, groups); | |
1350 | } | |
1351 | ||
1352 | static inline void device_remove_group(struct device *dev, | |
1353 | const struct attribute_group *grp) | |
1354 | { | |
1355 | const struct attribute_group *groups[] = { grp, NULL }; | |
1356 | ||
1357 | return device_remove_groups(dev, groups); | |
1358 | } | |
1359 | ||
57b8ff07 DT |
1360 | extern int __must_check devm_device_add_groups(struct device *dev, |
1361 | const struct attribute_group **groups); | |
1362 | extern void devm_device_remove_groups(struct device *dev, | |
1363 | const struct attribute_group **groups); | |
1364 | extern int __must_check devm_device_add_group(struct device *dev, | |
1365 | const struct attribute_group *grp); | |
1366 | extern void devm_device_remove_group(struct device *dev, | |
1367 | const struct attribute_group *grp); | |
1368 | ||
1da177e4 LT |
1369 | /* |
1370 | * Platform "fixup" functions - allow the platform to have their say | |
1371 | * about devices and actions that the general device layer doesn't | |
1372 | * know about. | |
1373 | */ | |
1374 | /* Notify platform of device discovery */ | |
d462943a | 1375 | extern int (*platform_notify)(struct device *dev); |
1da177e4 | 1376 | |
d462943a | 1377 | extern int (*platform_notify_remove)(struct device *dev); |
1da177e4 LT |
1378 | |
1379 | ||
880ffb5c | 1380 | /* |
1da177e4 LT |
1381 | * get_device - atomically increment the reference count for the device. |
1382 | * | |
1383 | */ | |
d462943a GKH |
1384 | extern struct device *get_device(struct device *dev); |
1385 | extern void put_device(struct device *dev); | |
1da177e4 | 1386 | |
2b2af54a KS |
1387 | #ifdef CONFIG_DEVTMPFS |
1388 | extern int devtmpfs_create_node(struct device *dev); | |
1389 | extern int devtmpfs_delete_node(struct device *dev); | |
073120cc | 1390 | extern int devtmpfs_mount(const char *mntdir); |
2b2af54a KS |
1391 | #else |
1392 | static inline int devtmpfs_create_node(struct device *dev) { return 0; } | |
1393 | static inline int devtmpfs_delete_node(struct device *dev) { return 0; } | |
1394 | static inline int devtmpfs_mount(const char *mountpoint) { return 0; } | |
1395 | #endif | |
1396 | ||
116f232b | 1397 | /* drivers/base/power/shutdown.c */ |
1da177e4 LT |
1398 | extern void device_shutdown(void); |
1399 | ||
1da177e4 | 1400 | /* debugging and troubleshooting/diagnostic helpers. */ |
bf9ca69f | 1401 | extern const char *dev_driver_string(const struct device *dev); |
99bcf217 | 1402 | |
9ed98953 RW |
1403 | /* Device links interface. */ |
1404 | struct device_link *device_link_add(struct device *consumer, | |
1405 | struct device *supplier, u32 flags); | |
1406 | void device_link_del(struct device_link *link); | |
d8842211 | 1407 | void device_link_remove(void *consumer, struct device *supplier); |
99bcf217 | 1408 | |
663336ee JP |
1409 | #ifndef dev_fmt |
1410 | #define dev_fmt(fmt) fmt | |
1411 | #endif | |
1412 | ||
99bcf217 JP |
1413 | #ifdef CONFIG_PRINTK |
1414 | ||
79a4e91d | 1415 | __printf(3, 0) __cold |
0a18b050 JP |
1416 | int dev_vprintk_emit(int level, const struct device *dev, |
1417 | const char *fmt, va_list args); | |
79a4e91d | 1418 | __printf(3, 4) __cold |
05e4e5b8 | 1419 | int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...); |
798efc60 | 1420 | |
79a4e91d | 1421 | __printf(3, 4) __cold |
d1f1052c JP |
1422 | void dev_printk(const char *level, const struct device *dev, |
1423 | const char *fmt, ...); | |
79a4e91d | 1424 | __printf(2, 3) __cold |
663336ee | 1425 | void _dev_emerg(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1426 | __printf(2, 3) __cold |
663336ee | 1427 | void _dev_alert(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1428 | __printf(2, 3) __cold |
663336ee | 1429 | void _dev_crit(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1430 | __printf(2, 3) __cold |
663336ee | 1431 | void _dev_err(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1432 | __printf(2, 3) __cold |
663336ee | 1433 | void _dev_warn(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1434 | __printf(2, 3) __cold |
663336ee | 1435 | void _dev_notice(const struct device *dev, const char *fmt, ...); |
79a4e91d | 1436 | __printf(2, 3) __cold |
d1f1052c | 1437 | void _dev_info(const struct device *dev, const char *fmt, ...); |
99bcf217 JP |
1438 | |
1439 | #else | |
1440 | ||
0a18b050 JP |
1441 | static inline __printf(3, 0) |
1442 | int dev_vprintk_emit(int level, const struct device *dev, | |
1443 | const char *fmt, va_list args) | |
05e4e5b8 JP |
1444 | { return 0; } |
1445 | static inline __printf(3, 4) | |
1446 | int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...) | |
1447 | { return 0; } | |
1448 | ||
d1f1052c JP |
1449 | static inline void __dev_printk(const char *level, const struct device *dev, |
1450 | struct va_format *vaf) | |
1451 | {} | |
b9075fa9 | 1452 | static inline __printf(3, 4) |
d1f1052c | 1453 | void dev_printk(const char *level, const struct device *dev, |
663336ee | 1454 | const char *fmt, ...) |
d1f1052c | 1455 | {} |
b9075fa9 JP |
1456 | |
1457 | static inline __printf(2, 3) | |
663336ee | 1458 | void _dev_emerg(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1459 | {} |
b9075fa9 | 1460 | static inline __printf(2, 3) |
663336ee | 1461 | void _dev_crit(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1462 | {} |
b9075fa9 | 1463 | static inline __printf(2, 3) |
663336ee | 1464 | void _dev_alert(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1465 | {} |
b9075fa9 | 1466 | static inline __printf(2, 3) |
663336ee | 1467 | void _dev_err(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1468 | {} |
b9075fa9 | 1469 | static inline __printf(2, 3) |
663336ee | 1470 | void _dev_warn(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1471 | {} |
b9075fa9 | 1472 | static inline __printf(2, 3) |
663336ee | 1473 | void _dev_notice(const struct device *dev, const char *fmt, ...) |
d1f1052c | 1474 | {} |
b9075fa9 | 1475 | static inline __printf(2, 3) |
d1f1052c JP |
1476 | void _dev_info(const struct device *dev, const char *fmt, ...) |
1477 | {} | |
99bcf217 JP |
1478 | |
1479 | #endif | |
1480 | ||
6f586e66 | 1481 | /* |
663336ee JP |
1482 | * #defines for all the dev_<level> macros to prefix with whatever |
1483 | * possible use of #define dev_fmt(fmt) ... | |
6f586e66 HD |
1484 | */ |
1485 | ||
663336ee JP |
1486 | #define dev_emerg(dev, fmt, ...) \ |
1487 | _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1488 | #define dev_crit(dev, fmt, ...) \ | |
1489 | _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1490 | #define dev_alert(dev, fmt, ...) \ | |
1491 | _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1492 | #define dev_err(dev, fmt, ...) \ | |
1493 | _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1494 | #define dev_warn(dev, fmt, ...) \ | |
1495 | _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1496 | #define dev_notice(dev, fmt, ...) \ | |
1497 | _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
1498 | #define dev_info(dev, fmt, ...) \ | |
1499 | _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
6f586e66 HD |
1500 | |
1501 | #if defined(CONFIG_DYNAMIC_DEBUG) | |
663336ee JP |
1502 | #define dev_dbg(dev, fmt, ...) \ |
1503 | dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__) | |
6f586e66 | 1504 | #elif defined(DEBUG) |
663336ee JP |
1505 | #define dev_dbg(dev, fmt, ...) \ |
1506 | dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__) | |
6f586e66 | 1507 | #else |
663336ee JP |
1508 | #define dev_dbg(dev, fmt, ...) \ |
1509 | ({ \ | |
1510 | if (0) \ | |
1511 | dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ | |
6f586e66 HD |
1512 | }) |
1513 | #endif | |
1514 | ||
e135303b JP |
1515 | #ifdef CONFIG_PRINTK |
1516 | #define dev_level_once(dev_level, dev, fmt, ...) \ | |
1517 | do { \ | |
1518 | static bool __print_once __read_mostly; \ | |
1519 | \ | |
1520 | if (!__print_once) { \ | |
1521 | __print_once = true; \ | |
1522 | dev_level(dev, fmt, ##__VA_ARGS__); \ | |
1523 | } \ | |
1524 | } while (0) | |
1525 | #else | |
1526 | #define dev_level_once(dev_level, dev, fmt, ...) \ | |
1527 | do { \ | |
1528 | if (0) \ | |
1529 | dev_level(dev, fmt, ##__VA_ARGS__); \ | |
1530 | } while (0) | |
1531 | #endif | |
1532 | ||
1533 | #define dev_emerg_once(dev, fmt, ...) \ | |
1534 | dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__) | |
1535 | #define dev_alert_once(dev, fmt, ...) \ | |
1536 | dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__) | |
1537 | #define dev_crit_once(dev, fmt, ...) \ | |
1538 | dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__) | |
1539 | #define dev_err_once(dev, fmt, ...) \ | |
1540 | dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__) | |
1541 | #define dev_warn_once(dev, fmt, ...) \ | |
1542 | dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__) | |
1543 | #define dev_notice_once(dev, fmt, ...) \ | |
1544 | dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__) | |
1545 | #define dev_info_once(dev, fmt, ...) \ | |
1546 | dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__) | |
1547 | #define dev_dbg_once(dev, fmt, ...) \ | |
a2a15d54 | 1548 | dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__) |
e135303b | 1549 | |
6ca04593 HD |
1550 | #define dev_level_ratelimited(dev_level, dev, fmt, ...) \ |
1551 | do { \ | |
1552 | static DEFINE_RATELIMIT_STATE(_rs, \ | |
1553 | DEFAULT_RATELIMIT_INTERVAL, \ | |
1554 | DEFAULT_RATELIMIT_BURST); \ | |
1555 | if (__ratelimit(&_rs)) \ | |
1556 | dev_level(dev, fmt, ##__VA_ARGS__); \ | |
1557 | } while (0) | |
1558 | ||
1559 | #define dev_emerg_ratelimited(dev, fmt, ...) \ | |
1560 | dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__) | |
1561 | #define dev_alert_ratelimited(dev, fmt, ...) \ | |
1562 | dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__) | |
1563 | #define dev_crit_ratelimited(dev, fmt, ...) \ | |
1564 | dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__) | |
1565 | #define dev_err_ratelimited(dev, fmt, ...) \ | |
1566 | dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__) | |
1567 | #define dev_warn_ratelimited(dev, fmt, ...) \ | |
1568 | dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__) | |
1569 | #define dev_notice_ratelimited(dev, fmt, ...) \ | |
1570 | dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__) | |
1571 | #define dev_info_ratelimited(dev, fmt, ...) \ | |
1572 | dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__) | |
8ef2d651 DK |
1573 | #if defined(CONFIG_DYNAMIC_DEBUG) |
1574 | /* descriptor check is first to prevent flooding with "callbacks suppressed" */ | |
6ca04593 | 1575 | #define dev_dbg_ratelimited(dev, fmt, ...) \ |
6f586e66 HD |
1576 | do { \ |
1577 | static DEFINE_RATELIMIT_STATE(_rs, \ | |
1578 | DEFAULT_RATELIMIT_INTERVAL, \ | |
1579 | DEFAULT_RATELIMIT_BURST); \ | |
1580 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ | |
e0b73d7b | 1581 | if (DYNAMIC_DEBUG_BRANCH(descriptor) && \ |
6f586e66 | 1582 | __ratelimit(&_rs)) \ |
663336ee | 1583 | __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt), \ |
8ef2d651 DK |
1584 | ##__VA_ARGS__); \ |
1585 | } while (0) | |
1586 | #elif defined(DEBUG) | |
1587 | #define dev_dbg_ratelimited(dev, fmt, ...) \ | |
1588 | do { \ | |
1589 | static DEFINE_RATELIMIT_STATE(_rs, \ | |
1590 | DEFAULT_RATELIMIT_INTERVAL, \ | |
1591 | DEFAULT_RATELIMIT_BURST); \ | |
1592 | if (__ratelimit(&_rs)) \ | |
663336ee | 1593 | dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ |
99bcf217 | 1594 | } while (0) |
1da177e4 | 1595 | #else |
1f62ff34 AB |
1596 | #define dev_dbg_ratelimited(dev, fmt, ...) \ |
1597 | do { \ | |
1598 | if (0) \ | |
663336ee | 1599 | dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ |
1f62ff34 | 1600 | } while (0) |
1da177e4 LT |
1601 | #endif |
1602 | ||
aebdc3b4 DB |
1603 | #ifdef VERBOSE_DEBUG |
1604 | #define dev_vdbg dev_dbg | |
1605 | #else | |
663336ee JP |
1606 | #define dev_vdbg(dev, fmt, ...) \ |
1607 | ({ \ | |
1608 | if (0) \ | |
1609 | dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \ | |
99bcf217 | 1610 | }) |
aebdc3b4 DB |
1611 | #endif |
1612 | ||
e6139662 | 1613 | /* |
3eae1367 BH |
1614 | * dev_WARN*() acts like dev_printk(), but with the key difference of |
1615 | * using WARN/WARN_ONCE to include file/line information and a backtrace. | |
e6139662 AV |
1616 | */ |
1617 | #define dev_WARN(dev, format, arg...) \ | |
3eae1367 | 1618 | WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg); |
e6139662 | 1619 | |
bcdd323b | 1620 | #define dev_WARN_ONCE(dev, condition, format, arg...) \ |
3eae1367 BH |
1621 | WARN_ONCE(condition, "%s %s: " format, \ |
1622 | dev_driver_string(dev), dev_name(dev), ## arg) | |
bcdd323b | 1623 | |
1da177e4 LT |
1624 | /* Create alias, so I can be autoloaded. */ |
1625 | #define MODULE_ALIAS_CHARDEV(major,minor) \ | |
1626 | MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor)) | |
1627 | #define MODULE_ALIAS_CHARDEV_MAJOR(major) \ | |
1628 | MODULE_ALIAS("char-major-" __stringify(major) "-*") | |
e52eec13 AK |
1629 | |
1630 | #ifdef CONFIG_SYSFS_DEPRECATED | |
1631 | extern long sysfs_deprecated; | |
1632 | #else | |
1633 | #define sysfs_deprecated 0 | |
1634 | #endif | |
1635 | ||
907d0ed1 LPC |
1636 | /** |
1637 | * module_driver() - Helper macro for drivers that don't do anything | |
1638 | * special in module init/exit. This eliminates a lot of boilerplate. | |
1639 | * Each module may only use this macro once, and calling it replaces | |
1640 | * module_init() and module_exit(). | |
1641 | * | |
2eda013f RD |
1642 | * @__driver: driver name |
1643 | * @__register: register function for this driver type | |
1644 | * @__unregister: unregister function for this driver type | |
cd494618 | 1645 | * @...: Additional arguments to be passed to __register and __unregister. |
2eda013f | 1646 | * |
907d0ed1 LPC |
1647 | * Use this macro to construct bus specific macros for registering |
1648 | * drivers, and do not use it on its own. | |
1649 | */ | |
cd494618 | 1650 | #define module_driver(__driver, __register, __unregister, ...) \ |
907d0ed1 LPC |
1651 | static int __init __driver##_init(void) \ |
1652 | { \ | |
cd494618 | 1653 | return __register(&(__driver) , ##__VA_ARGS__); \ |
907d0ed1 LPC |
1654 | } \ |
1655 | module_init(__driver##_init); \ | |
1656 | static void __exit __driver##_exit(void) \ | |
1657 | { \ | |
cd494618 | 1658 | __unregister(&(__driver) , ##__VA_ARGS__); \ |
907d0ed1 LPC |
1659 | } \ |
1660 | module_exit(__driver##_exit); | |
1661 | ||
f309d444 PG |
1662 | /** |
1663 | * builtin_driver() - Helper macro for drivers that don't do anything | |
1664 | * special in init and have no exit. This eliminates some boilerplate. | |
1665 | * Each driver may only use this macro once, and calling it replaces | |
1666 | * device_initcall (or in some cases, the legacy __initcall). This is | |
1667 | * meant to be a direct parallel of module_driver() above but without | |
1668 | * the __exit stuff that is not used for builtin cases. | |
1669 | * | |
1670 | * @__driver: driver name | |
1671 | * @__register: register function for this driver type | |
1672 | * @...: Additional arguments to be passed to __register | |
1673 | * | |
1674 | * Use this macro to construct bus specific macros for registering | |
1675 | * drivers, and do not use it on its own. | |
1676 | */ | |
1677 | #define builtin_driver(__driver, __register, ...) \ | |
1678 | static int __init __driver##_init(void) \ | |
1679 | { \ | |
1680 | return __register(&(__driver) , ##__VA_ARGS__); \ | |
1681 | } \ | |
1682 | device_initcall(__driver##_init); | |
1683 | ||
1da177e4 | 1684 | #endif /* _DEVICE_H_ */ |