2 * device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
8 * This file is released under the GPLv2
10 * See Documentation/driver-model/ for more information.
16 #include <linux/ioport.h>
17 #include <linux/kobject.h>
18 #include <linux/klist.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/compiler.h>
22 #include <linux/types.h>
23 #include <linux/mutex.h>
24 #include <linux/pinctrl/devinfo.h>
26 #include <linux/atomic.h>
27 #include <linux/ratelimit.h>
28 #include <linux/uidgid.h>
29 #include <linux/gfp.h>
30 #include <asm/device.h>
33 struct device_private;
35 struct driver_private;
38 struct subsys_private;
44 struct bus_attribute {
45 struct attribute attr;
46 ssize_t (*show)(struct bus_type *bus, char *buf);
47 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
50 #define BUS_ATTR(_name, _mode, _show, _store) \
51 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
53 extern int __must_check bus_create_file(struct bus_type *,
54 struct bus_attribute *);
55 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
58 * struct bus_type - The bus type of the device
60 * @name: The name of the bus.
61 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
62 * @dev_root: Default device to use as the parent.
63 * @bus_attrs: Default attributes of the bus.
64 * @dev_attrs: Default attributes of the devices on the bus.
65 * @drv_attrs: Default attributes of the device drivers on the bus.
66 * @match: Called, perhaps multiple times, whenever a new device or driver
67 * is added for this bus. It should return a nonzero value if the
68 * given device can be handled by the given driver.
69 * @uevent: Called when a device is added, removed, or a few other things
70 * that generate uevents to add the environment variables.
71 * @probe: Called when a new device or driver add to this bus, and callback
72 * the specific driver's probe to initial the matched device.
73 * @remove: Called when a device removed from this bus.
74 * @shutdown: Called at shut-down time to quiesce the device.
75 * @suspend: Called when a device on this bus wants to go to sleep mode.
76 * @resume: Called to bring a device on this bus out of sleep mode.
77 * @pm: Power management operations of this bus, callback the specific
78 * device driver's pm-ops.
79 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
80 * driver implementations to a bus and allow the driver to do
82 * @p: The private data of the driver core, only the driver core can
85 * A bus is a channel between the processor and one or more devices. For the
86 * purposes of the device model, all devices are connected via a bus, even if
87 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
88 * A USB controller is usually a PCI device, for example. The device model
89 * represents the actual connections between buses and the devices they control.
90 * A bus is represented by the bus_type structure. It contains the name, the
91 * default attributes, the bus' methods, PM operations, and the driver core's
97 struct device *dev_root;
98 struct bus_attribute *bus_attrs;
99 struct device_attribute *dev_attrs;
100 struct driver_attribute *drv_attrs;
102 int (*match)(struct device *dev, struct device_driver *drv);
103 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
104 int (*probe)(struct device *dev);
105 int (*remove)(struct device *dev);
106 void (*shutdown)(struct device *dev);
108 int (*suspend)(struct device *dev, pm_message_t state);
109 int (*resume)(struct device *dev);
111 const struct dev_pm_ops *pm;
113 struct iommu_ops *iommu_ops;
115 struct subsys_private *p;
116 struct lock_class_key lock_key;
119 extern int __must_check bus_register(struct bus_type *bus);
121 extern void bus_unregister(struct bus_type *bus);
123 extern int __must_check bus_rescan_devices(struct bus_type *bus);
125 /* iterator helpers for buses */
126 struct subsys_dev_iter {
127 struct klist_iter ki;
128 const struct device_type *type;
130 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
131 struct bus_type *subsys,
132 struct device *start,
133 const struct device_type *type);
134 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
135 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
137 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
138 int (*fn)(struct device *dev, void *data));
139 struct device *bus_find_device(struct bus_type *bus, struct device *start,
141 int (*match)(struct device *dev, void *data));
142 struct device *bus_find_device_by_name(struct bus_type *bus,
143 struct device *start,
145 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
146 struct device *hint);
147 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
148 void *data, int (*fn)(struct device_driver *, void *));
149 void bus_sort_breadthfirst(struct bus_type *bus,
150 int (*compare)(const struct device *a,
151 const struct device *b));
153 * Bus notifiers: Get notified of addition/removal of devices
154 * and binding/unbinding of drivers to devices.
155 * In the long run, it should be a replacement for the platform
158 struct notifier_block;
160 extern int bus_register_notifier(struct bus_type *bus,
161 struct notifier_block *nb);
162 extern int bus_unregister_notifier(struct bus_type *bus,
163 struct notifier_block *nb);
165 /* All 4 notifers below get called with the target struct device *
166 * as an argument. Note that those functions are likely to be called
167 * with the device lock held in the core, so be careful.
169 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
170 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
171 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
173 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
174 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
176 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
179 extern struct kset *bus_get_kset(struct bus_type *bus);
180 extern struct klist *bus_get_device_klist(struct bus_type *bus);
183 * struct device_driver - The basic device driver structure
184 * @name: Name of the device driver.
185 * @bus: The bus which the device of this driver belongs to.
186 * @owner: The module owner.
187 * @mod_name: Used for built-in modules.
188 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
189 * @of_match_table: The open firmware table.
190 * @acpi_match_table: The ACPI match table.
191 * @probe: Called to query the existence of a specific device,
192 * whether this driver can work with it, and bind the driver
193 * to a specific device.
194 * @remove: Called when the device is removed from the system to
195 * unbind a device from this driver.
196 * @shutdown: Called at shut-down time to quiesce the device.
197 * @suspend: Called to put the device to sleep mode. Usually to a
199 * @resume: Called to bring a device from sleep mode.
200 * @groups: Default attributes that get created by the driver core
202 * @pm: Power management operations of the device which matched
204 * @p: Driver core's private data, no one other than the driver
205 * core can touch this.
207 * The device driver-model tracks all of the drivers known to the system.
208 * The main reason for this tracking is to enable the driver core to match
209 * up drivers with new devices. Once drivers are known objects within the
210 * system, however, a number of other things become possible. Device drivers
211 * can export information and configuration variables that are independent
212 * of any specific device.
214 struct device_driver {
216 struct bus_type *bus;
218 struct module *owner;
219 const char *mod_name; /* used for built-in modules */
221 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
223 const struct of_device_id *of_match_table;
224 const struct acpi_device_id *acpi_match_table;
226 int (*probe) (struct device *dev);
227 int (*remove) (struct device *dev);
228 void (*shutdown) (struct device *dev);
229 int (*suspend) (struct device *dev, pm_message_t state);
230 int (*resume) (struct device *dev);
231 const struct attribute_group **groups;
233 const struct dev_pm_ops *pm;
235 struct driver_private *p;
239 extern int __must_check driver_register(struct device_driver *drv);
240 extern void driver_unregister(struct device_driver *drv);
242 extern struct device_driver *driver_find(const char *name,
243 struct bus_type *bus);
244 extern int driver_probe_done(void);
245 extern void wait_for_device_probe(void);
248 /* sysfs interface for exporting driver attributes */
250 struct driver_attribute {
251 struct attribute attr;
252 ssize_t (*show)(struct device_driver *driver, char *buf);
253 ssize_t (*store)(struct device_driver *driver, const char *buf,
257 #define DRIVER_ATTR(_name, _mode, _show, _store) \
258 struct driver_attribute driver_attr_##_name = \
259 __ATTR(_name, _mode, _show, _store)
261 extern int __must_check driver_create_file(struct device_driver *driver,
262 const struct driver_attribute *attr);
263 extern void driver_remove_file(struct device_driver *driver,
264 const struct driver_attribute *attr);
266 extern int __must_check driver_for_each_device(struct device_driver *drv,
267 struct device *start,
269 int (*fn)(struct device *dev,
271 struct device *driver_find_device(struct device_driver *drv,
272 struct device *start, void *data,
273 int (*match)(struct device *dev, void *data));
276 * struct subsys_interface - interfaces to device functions
277 * @name: name of the device function
278 * @subsys: subsytem of the devices to attach to
279 * @node: the list of functions registered at the subsystem
280 * @add_dev: device hookup to device function handler
281 * @remove_dev: device hookup to device function handler
283 * Simple interfaces attached to a subsystem. Multiple interfaces can
284 * attach to a subsystem and its devices. Unlike drivers, they do not
285 * exclusively claim or control devices. Interfaces usually represent
286 * a specific functionality of a subsystem/class of devices.
288 struct subsys_interface {
290 struct bus_type *subsys;
291 struct list_head node;
292 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
293 int (*remove_dev)(struct device *dev, struct subsys_interface *sif);
296 int subsys_interface_register(struct subsys_interface *sif);
297 void subsys_interface_unregister(struct subsys_interface *sif);
299 int subsys_system_register(struct bus_type *subsys,
300 const struct attribute_group **groups);
301 int subsys_virtual_register(struct bus_type *subsys,
302 const struct attribute_group **groups);
305 * struct class - device classes
306 * @name: Name of the class.
307 * @owner: The module owner.
308 * @class_attrs: Default attributes of this class.
309 * @dev_attrs: Default attributes of the devices belong to the class.
310 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
311 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
312 * @dev_uevent: Called when a device is added, removed from this class, or a
313 * few other things that generate uevents to add the environment
315 * @devnode: Callback to provide the devtmpfs.
316 * @class_release: Called to release this class.
317 * @dev_release: Called to release the device.
318 * @suspend: Used to put the device to sleep mode, usually to a low power
320 * @resume: Used to bring the device from the sleep mode.
321 * @ns_type: Callbacks so sysfs can detemine namespaces.
322 * @namespace: Namespace of the device belongs to this class.
323 * @pm: The default device power management operations of this class.
324 * @p: The private data of the driver core, no one other than the
325 * driver core can touch this.
327 * A class is a higher-level view of a device that abstracts out low-level
328 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
329 * at the class level, they are all simply disks. Classes allow user space
330 * to work with devices based on what they do, rather than how they are
331 * connected or how they work.
335 struct module *owner;
337 struct class_attribute *class_attrs;
338 struct device_attribute *dev_attrs;
339 struct bin_attribute *dev_bin_attrs;
340 struct kobject *dev_kobj;
342 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
343 char *(*devnode)(struct device *dev, umode_t *mode);
345 void (*class_release)(struct class *class);
346 void (*dev_release)(struct device *dev);
348 int (*suspend)(struct device *dev, pm_message_t state);
349 int (*resume)(struct device *dev);
351 const struct kobj_ns_type_operations *ns_type;
352 const void *(*namespace)(struct device *dev);
354 const struct dev_pm_ops *pm;
356 struct subsys_private *p;
359 struct class_dev_iter {
360 struct klist_iter ki;
361 const struct device_type *type;
364 extern struct kobject *sysfs_dev_block_kobj;
365 extern struct kobject *sysfs_dev_char_kobj;
366 extern int __must_check __class_register(struct class *class,
367 struct lock_class_key *key);
368 extern void class_unregister(struct class *class);
370 /* This is a #define to keep the compiler from merging different
371 * instances of the __key variable */
372 #define class_register(class) \
374 static struct lock_class_key __key; \
375 __class_register(class, &__key); \
379 struct class_compat *class_compat_register(const char *name);
380 void class_compat_unregister(struct class_compat *cls);
381 int class_compat_create_link(struct class_compat *cls, struct device *dev,
382 struct device *device_link);
383 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
384 struct device *device_link);
386 extern void class_dev_iter_init(struct class_dev_iter *iter,
388 struct device *start,
389 const struct device_type *type);
390 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
391 extern void class_dev_iter_exit(struct class_dev_iter *iter);
393 extern int class_for_each_device(struct class *class, struct device *start,
395 int (*fn)(struct device *dev, void *data));
396 extern struct device *class_find_device(struct class *class,
397 struct device *start, const void *data,
398 int (*match)(struct device *, const void *));
400 struct class_attribute {
401 struct attribute attr;
402 ssize_t (*show)(struct class *class, struct class_attribute *attr,
404 ssize_t (*store)(struct class *class, struct class_attribute *attr,
405 const char *buf, size_t count);
406 const void *(*namespace)(struct class *class,
407 const struct class_attribute *attr);
410 #define CLASS_ATTR(_name, _mode, _show, _store) \
411 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
413 extern int __must_check class_create_file(struct class *class,
414 const struct class_attribute *attr);
415 extern void class_remove_file(struct class *class,
416 const struct class_attribute *attr);
418 /* Simple class attribute that is just a static string */
420 struct class_attribute_string {
421 struct class_attribute attr;
425 /* Currently read-only only */
426 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
427 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
428 #define CLASS_ATTR_STRING(_name, _mode, _str) \
429 struct class_attribute_string class_attr_##_name = \
430 _CLASS_ATTR_STRING(_name, _mode, _str)
432 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
435 struct class_interface {
436 struct list_head node;
439 int (*add_dev) (struct device *, struct class_interface *);
440 void (*remove_dev) (struct device *, struct class_interface *);
443 extern int __must_check class_interface_register(struct class_interface *);
444 extern void class_interface_unregister(struct class_interface *);
446 extern struct class * __must_check __class_create(struct module *owner,
448 struct lock_class_key *key);
449 extern void class_destroy(struct class *cls);
451 /* This is a #define to keep the compiler from merging different
452 * instances of the __key variable */
453 #define class_create(owner, name) \
455 static struct lock_class_key __key; \
456 __class_create(owner, name, &__key); \
460 * The type of device, "struct device" is embedded in. A class
461 * or bus can contain devices of different types
462 * like "partitions" and "disks", "mouse" and "event".
463 * This identifies the device type and carries type-specific
464 * information, equivalent to the kobj_type of a kobject.
465 * If "name" is specified, the uevent will contain it in
466 * the DEVTYPE variable.
470 const struct attribute_group **groups;
471 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
472 char *(*devnode)(struct device *dev, umode_t *mode,
473 kuid_t *uid, kgid_t *gid);
474 void (*release)(struct device *dev);
476 const struct dev_pm_ops *pm;
479 /* interface for exporting device attributes */
480 struct device_attribute {
481 struct attribute attr;
482 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
484 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
485 const char *buf, size_t count);
488 struct dev_ext_attribute {
489 struct device_attribute attr;
493 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
495 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
496 const char *buf, size_t count);
497 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
499 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
500 const char *buf, size_t count);
501 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
503 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
504 const char *buf, size_t count);
506 #define DEVICE_ATTR(_name, _mode, _show, _store) \
507 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
508 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
509 struct dev_ext_attribute dev_attr_##_name = \
510 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
511 #define DEVICE_INT_ATTR(_name, _mode, _var) \
512 struct dev_ext_attribute dev_attr_##_name = \
513 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
514 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
515 struct dev_ext_attribute dev_attr_##_name = \
516 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
517 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
518 struct device_attribute dev_attr_##_name = \
519 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
521 extern int device_create_file(struct device *device,
522 const struct device_attribute *entry);
523 extern void device_remove_file(struct device *dev,
524 const struct device_attribute *attr);
525 extern int __must_check device_create_bin_file(struct device *dev,
526 const struct bin_attribute *attr);
527 extern void device_remove_bin_file(struct device *dev,
528 const struct bin_attribute *attr);
529 extern int device_schedule_callback_owner(struct device *dev,
530 void (*func)(struct device *dev), struct module *owner);
532 /* This is a macro to avoid include problems with THIS_MODULE */
533 #define device_schedule_callback(dev, func) \
534 device_schedule_callback_owner(dev, func, THIS_MODULE)
536 /* device resource management */
537 typedef void (*dr_release_t)(struct device *dev, void *res);
538 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
540 #ifdef CONFIG_DEBUG_DEVRES
541 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
543 #define devres_alloc(release, size, gfp) \
544 __devres_alloc(release, size, gfp, #release)
546 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
548 extern void devres_for_each_res(struct device *dev, dr_release_t release,
549 dr_match_t match, void *match_data,
550 void (*fn)(struct device *, void *, void *),
552 extern void devres_free(void *res);
553 extern void devres_add(struct device *dev, void *res);
554 extern void *devres_find(struct device *dev, dr_release_t release,
555 dr_match_t match, void *match_data);
556 extern void *devres_get(struct device *dev, void *new_res,
557 dr_match_t match, void *match_data);
558 extern void *devres_remove(struct device *dev, dr_release_t release,
559 dr_match_t match, void *match_data);
560 extern int devres_destroy(struct device *dev, dr_release_t release,
561 dr_match_t match, void *match_data);
562 extern int devres_release(struct device *dev, dr_release_t release,
563 dr_match_t match, void *match_data);
566 extern void * __must_check devres_open_group(struct device *dev, void *id,
568 extern void devres_close_group(struct device *dev, void *id);
569 extern void devres_remove_group(struct device *dev, void *id);
570 extern int devres_release_group(struct device *dev, void *id);
572 /* managed devm_k.alloc/kfree for device drivers */
573 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
574 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
576 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
578 static inline void *devm_kmalloc_array(struct device *dev,
579 size_t n, size_t size, gfp_t flags)
581 if (size != 0 && n > SIZE_MAX / size)
583 return devm_kmalloc(dev, n * size, flags);
585 static inline void *devm_kcalloc(struct device *dev,
586 size_t n, size_t size, gfp_t flags)
588 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
590 extern void devm_kfree(struct device *dev, void *p);
592 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
593 void __iomem *devm_request_and_ioremap(struct device *dev,
594 struct resource *res);
596 /* allows to add/remove a custom action to devres stack */
597 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
598 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
600 struct device_dma_parameters {
602 * a low level driver may set these to teach IOMMU code about
605 unsigned int max_segment_size;
606 unsigned long segment_boundary_mask;
609 struct acpi_dev_node {
616 * struct device - The basic device structure
617 * @parent: The device's "parent" device, the device to which it is attached.
618 * In most cases, a parent device is some sort of bus or host
619 * controller. If parent is NULL, the device, is a top-level device,
620 * which is not usually what you want.
621 * @p: Holds the private data of the driver core portions of the device.
622 * See the comment of the struct device_private for detail.
623 * @kobj: A top-level, abstract class from which other classes are derived.
624 * @init_name: Initial name of the device.
625 * @type: The type of device.
626 * This identifies the device type and carries type-specific
628 * @mutex: Mutex to synchronize calls to its driver.
629 * @bus: Type of bus device is on.
630 * @driver: Which driver has allocated this
631 * @platform_data: Platform data specific to the device.
632 * Example: For devices on custom boards, as typical of embedded
633 * and SOC based hardware, Linux often uses platform_data to point
634 * to board-specific structures describing devices and how they
635 * are wired. That can include what ports are available, chip
636 * variants, which GPIO pins act in what additional roles, and so
637 * on. This shrinks the "Board Support Packages" (BSPs) and
638 * minimizes board-specific #ifdefs in drivers.
639 * @power: For device power management.
640 * See Documentation/power/devices.txt for details.
641 * @pm_domain: Provide callbacks that are executed during system suspend,
642 * hibernation, system resume and during runtime PM transitions
643 * along with subsystem-level and driver-level callbacks.
644 * @pins: For device pin management.
645 * See Documentation/pinctrl.txt for details.
646 * @numa_node: NUMA node this device is close to.
647 * @dma_mask: Dma mask (if dma'ble device).
648 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
649 * hardware supports 64-bit addresses for consistent allocations
651 * @dma_parms: A low level driver may set these to teach IOMMU code about
652 * segment limitations.
653 * @dma_pools: Dma pools (if dma'ble device).
654 * @dma_mem: Internal for coherent mem override.
655 * @archdata: For arch-specific additions.
656 * @of_node: Associated device tree node.
657 * @acpi_node: Associated ACPI device node.
658 * @devt: For creating the sysfs "dev".
659 * @id: device instance
660 * @devres_lock: Spinlock to protect the resource of the device.
661 * @devres_head: The resources list of the device.
662 * @knode_class: The node used to add the device to the class list.
663 * @class: The class of the device.
664 * @groups: Optional attribute groups.
665 * @release: Callback to free the device after all references have
666 * gone away. This should be set by the allocator of the
667 * device (i.e. the bus driver that discovered the device).
669 * At the lowest level, every device in a Linux system is represented by an
670 * instance of struct device. The device structure contains the information
671 * that the device model core needs to model the system. Most subsystems,
672 * however, track additional information about the devices they host. As a
673 * result, it is rare for devices to be represented by bare device structures;
674 * instead, that structure, like kobject structures, is usually embedded within
675 * a higher-level representation of the device.
678 struct device *parent;
680 struct device_private *p;
683 const char *init_name; /* initial name of the device */
684 const struct device_type *type;
686 struct mutex mutex; /* mutex to synchronize calls to
690 struct bus_type *bus; /* type of bus device is on */
691 struct device_driver *driver; /* which driver has allocated this
693 void *platform_data; /* Platform specific data, device
694 core doesn't touch it */
695 struct dev_pm_info power;
696 struct dev_pm_domain *pm_domain;
698 #ifdef CONFIG_PINCTRL
699 struct dev_pin_info *pins;
703 int numa_node; /* NUMA node this device is close to */
705 u64 *dma_mask; /* dma mask (if dma'able device) */
706 u64 coherent_dma_mask;/* Like dma_mask, but for
707 alloc_coherent mappings as
708 not all hardware supports
709 64 bit addresses for consistent
710 allocations such descriptors. */
712 struct device_dma_parameters *dma_parms;
714 struct list_head dma_pools; /* dma pools (if dma'ble) */
716 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
718 #ifdef CONFIG_DMA_CMA
719 struct cma *cma_area; /* contiguous memory area for dma
722 /* arch specific additions */
723 struct dev_archdata archdata;
725 struct device_node *of_node; /* associated device tree node */
726 struct acpi_dev_node acpi_node; /* associated ACPI device node */
728 dev_t devt; /* dev_t, creates the sysfs "dev" */
729 u32 id; /* device instance */
731 spinlock_t devres_lock;
732 struct list_head devres_head;
734 struct klist_node knode_class;
736 const struct attribute_group **groups; /* optional groups */
738 void (*release)(struct device *dev);
739 struct iommu_group *iommu_group;
742 static inline struct device *kobj_to_dev(struct kobject *kobj)
744 return container_of(kobj, struct device, kobj);
748 #define ACPI_HANDLE(dev) ((dev)->acpi_node.handle)
749 #define ACPI_HANDLE_SET(dev, _handle_) (dev)->acpi_node.handle = (_handle_)
751 #define ACPI_HANDLE(dev) (NULL)
752 #define ACPI_HANDLE_SET(dev, _handle_) do { } while (0)
755 /* Get the wakeup routines, which depend on struct device */
756 #include <linux/pm_wakeup.h>
758 static inline const char *dev_name(const struct device *dev)
760 /* Use the init name until the kobject becomes available */
762 return dev->init_name;
764 return kobject_name(&dev->kobj);
767 extern __printf(2, 3)
768 int dev_set_name(struct device *dev, const char *name, ...);
771 static inline int dev_to_node(struct device *dev)
773 return dev->numa_node;
775 static inline void set_dev_node(struct device *dev, int node)
777 dev->numa_node = node;
780 static inline int dev_to_node(struct device *dev)
784 static inline void set_dev_node(struct device *dev, int node)
789 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
791 return dev ? dev->power.subsys_data : NULL;
794 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
796 return dev->kobj.uevent_suppress;
799 static inline void dev_set_uevent_suppress(struct device *dev, int val)
801 dev->kobj.uevent_suppress = val;
804 static inline int device_is_registered(struct device *dev)
806 return dev->kobj.state_in_sysfs;
809 static inline void device_enable_async_suspend(struct device *dev)
811 if (!dev->power.is_prepared)
812 dev->power.async_suspend = true;
815 static inline void device_disable_async_suspend(struct device *dev)
817 if (!dev->power.is_prepared)
818 dev->power.async_suspend = false;
821 static inline bool device_async_suspend_enabled(struct device *dev)
823 return !!dev->power.async_suspend;
826 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
828 dev->power.ignore_children = enable;
831 static inline void dev_pm_syscore_device(struct device *dev, bool val)
833 #ifdef CONFIG_PM_SLEEP
834 dev->power.syscore = val;
838 static inline void device_lock(struct device *dev)
840 mutex_lock(&dev->mutex);
843 static inline int device_trylock(struct device *dev)
845 return mutex_trylock(&dev->mutex);
848 static inline void device_unlock(struct device *dev)
850 mutex_unlock(&dev->mutex);
853 void driver_init(void);
856 * High level routines for use by the bus drivers
858 extern int __must_check device_register(struct device *dev);
859 extern void device_unregister(struct device *dev);
860 extern void device_initialize(struct device *dev);
861 extern int __must_check device_add(struct device *dev);
862 extern void device_del(struct device *dev);
863 extern int device_for_each_child(struct device *dev, void *data,
864 int (*fn)(struct device *dev, void *data));
865 extern struct device *device_find_child(struct device *dev, void *data,
866 int (*match)(struct device *dev, void *data));
867 extern int device_rename(struct device *dev, const char *new_name);
868 extern int device_move(struct device *dev, struct device *new_parent,
869 enum dpm_order dpm_order);
870 extern const char *device_get_devnode(struct device *dev,
871 umode_t *mode, kuid_t *uid, kgid_t *gid,
873 extern void *dev_get_drvdata(const struct device *dev);
874 extern int dev_set_drvdata(struct device *dev, void *data);
877 * Root device objects for grouping under /sys/devices
879 extern struct device *__root_device_register(const char *name,
880 struct module *owner);
883 * This is a macro to avoid include problems with THIS_MODULE,
884 * just as per what is done for device_schedule_callback() above.
886 #define root_device_register(name) \
887 __root_device_register(name, THIS_MODULE)
889 extern void root_device_unregister(struct device *root);
891 static inline void *dev_get_platdata(const struct device *dev)
893 return dev->platform_data;
897 * Manual binding of a device to driver. See drivers/base/bus.c
898 * for information on use.
900 extern int __must_check device_bind_driver(struct device *dev);
901 extern void device_release_driver(struct device *dev);
902 extern int __must_check device_attach(struct device *dev);
903 extern int __must_check driver_attach(struct device_driver *drv);
904 extern int __must_check device_reprobe(struct device *dev);
907 * Easy functions for dynamically creating devices on the fly
909 extern struct device *device_create_vargs(struct class *cls,
910 struct device *parent,
915 extern __printf(5, 6)
916 struct device *device_create(struct class *cls, struct device *parent,
917 dev_t devt, void *drvdata,
918 const char *fmt, ...);
919 extern void device_destroy(struct class *cls, dev_t devt);
922 * Platform "fixup" functions - allow the platform to have their say
923 * about devices and actions that the general device layer doesn't
926 /* Notify platform of device discovery */
927 extern int (*platform_notify)(struct device *dev);
929 extern int (*platform_notify_remove)(struct device *dev);
933 * get_device - atomically increment the reference count for the device.
936 extern struct device *get_device(struct device *dev);
937 extern void put_device(struct device *dev);
939 #ifdef CONFIG_DEVTMPFS
940 extern int devtmpfs_create_node(struct device *dev);
941 extern int devtmpfs_delete_node(struct device *dev);
942 extern int devtmpfs_mount(const char *mntdir);
944 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
945 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
946 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
949 /* drivers/base/power/shutdown.c */
950 extern void device_shutdown(void);
952 /* debugging and troubleshooting/diagnostic helpers. */
953 extern const char *dev_driver_string(const struct device *dev);
958 extern __printf(3, 0)
959 int dev_vprintk_emit(int level, const struct device *dev,
960 const char *fmt, va_list args);
961 extern __printf(3, 4)
962 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
964 extern __printf(3, 4)
965 int dev_printk(const char *level, const struct device *dev,
966 const char *fmt, ...);
967 extern __printf(2, 3)
968 int dev_emerg(const struct device *dev, const char *fmt, ...);
969 extern __printf(2, 3)
970 int dev_alert(const struct device *dev, const char *fmt, ...);
971 extern __printf(2, 3)
972 int dev_crit(const struct device *dev, const char *fmt, ...);
973 extern __printf(2, 3)
974 int dev_err(const struct device *dev, const char *fmt, ...);
975 extern __printf(2, 3)
976 int dev_warn(const struct device *dev, const char *fmt, ...);
977 extern __printf(2, 3)
978 int dev_notice(const struct device *dev, const char *fmt, ...);
979 extern __printf(2, 3)
980 int _dev_info(const struct device *dev, const char *fmt, ...);
984 static inline __printf(3, 0)
985 int dev_vprintk_emit(int level, const struct device *dev,
986 const char *fmt, va_list args)
988 static inline __printf(3, 4)
989 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
992 static inline int __dev_printk(const char *level, const struct device *dev,
993 struct va_format *vaf)
995 static inline __printf(3, 4)
996 int dev_printk(const char *level, const struct device *dev,
997 const char *fmt, ...)
1000 static inline __printf(2, 3)
1001 int dev_emerg(const struct device *dev, const char *fmt, ...)
1003 static inline __printf(2, 3)
1004 int dev_crit(const struct device *dev, const char *fmt, ...)
1006 static inline __printf(2, 3)
1007 int dev_alert(const struct device *dev, const char *fmt, ...)
1009 static inline __printf(2, 3)
1010 int dev_err(const struct device *dev, const char *fmt, ...)
1012 static inline __printf(2, 3)
1013 int dev_warn(const struct device *dev, const char *fmt, ...)
1015 static inline __printf(2, 3)
1016 int dev_notice(const struct device *dev, const char *fmt, ...)
1018 static inline __printf(2, 3)
1019 int _dev_info(const struct device *dev, const char *fmt, ...)
1025 * Stupid hackaround for existing uses of non-printk uses dev_info
1027 * Note that the definition of dev_info below is actually _dev_info
1028 * and a macro is used to avoid redefining dev_info
1031 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1033 #if defined(CONFIG_DYNAMIC_DEBUG)
1034 #define dev_dbg(dev, format, ...) \
1036 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1038 #elif defined(DEBUG)
1039 #define dev_dbg(dev, format, arg...) \
1040 dev_printk(KERN_DEBUG, dev, format, ##arg)
1042 #define dev_dbg(dev, format, arg...) \
1045 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1050 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1052 static DEFINE_RATELIMIT_STATE(_rs, \
1053 DEFAULT_RATELIMIT_INTERVAL, \
1054 DEFAULT_RATELIMIT_BURST); \
1055 if (__ratelimit(&_rs)) \
1056 dev_level(dev, fmt, ##__VA_ARGS__); \
1059 #define dev_emerg_ratelimited(dev, fmt, ...) \
1060 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1061 #define dev_alert_ratelimited(dev, fmt, ...) \
1062 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1063 #define dev_crit_ratelimited(dev, fmt, ...) \
1064 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1065 #define dev_err_ratelimited(dev, fmt, ...) \
1066 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1067 #define dev_warn_ratelimited(dev, fmt, ...) \
1068 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1069 #define dev_notice_ratelimited(dev, fmt, ...) \
1070 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1071 #define dev_info_ratelimited(dev, fmt, ...) \
1072 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1073 #if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
1074 #define dev_dbg_ratelimited(dev, fmt, ...) \
1076 static DEFINE_RATELIMIT_STATE(_rs, \
1077 DEFAULT_RATELIMIT_INTERVAL, \
1078 DEFAULT_RATELIMIT_BURST); \
1079 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1080 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1081 __ratelimit(&_rs)) \
1082 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
1086 #define dev_dbg_ratelimited(dev, fmt, ...) \
1087 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1090 #ifdef VERBOSE_DEBUG
1091 #define dev_vdbg dev_dbg
1093 #define dev_vdbg(dev, format, arg...) \
1096 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1102 * dev_WARN*() acts like dev_printk(), but with the key difference
1103 * of using a WARN/WARN_ON to get the message out, including the
1104 * file/line information and a backtrace.
1106 #define dev_WARN(dev, format, arg...) \
1107 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1109 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1110 WARN_ONCE(condition, "Device %s\n" format, \
1111 dev_driver_string(dev), ## arg)
1113 /* Create alias, so I can be autoloaded. */
1114 #define MODULE_ALIAS_CHARDEV(major,minor) \
1115 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1116 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1117 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1119 #ifdef CONFIG_SYSFS_DEPRECATED
1120 extern long sysfs_deprecated;
1122 #define sysfs_deprecated 0
1126 * module_driver() - Helper macro for drivers that don't do anything
1127 * special in module init/exit. This eliminates a lot of boilerplate.
1128 * Each module may only use this macro once, and calling it replaces
1129 * module_init() and module_exit().
1131 * @__driver: driver name
1132 * @__register: register function for this driver type
1133 * @__unregister: unregister function for this driver type
1134 * @...: Additional arguments to be passed to __register and __unregister.
1136 * Use this macro to construct bus specific macros for registering
1137 * drivers, and do not use it on its own.
1139 #define module_driver(__driver, __register, __unregister, ...) \
1140 static int __init __driver##_init(void) \
1142 return __register(&(__driver) , ##__VA_ARGS__); \
1144 module_init(__driver##_init); \
1145 static void __exit __driver##_exit(void) \
1147 __unregister(&(__driver) , ##__VA_ARGS__); \
1149 module_exit(__driver##_exit);
1151 #endif /* _DEVICE_H_ */