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