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