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>
25 #include <linux/atomic.h>
26 #include <linux/ratelimit.h>
27 #include <asm/device.h>
30 struct device_private
;
32 struct driver_private
;
35 struct subsys_private
;
40 struct bus_attribute
{
41 struct attribute attr
;
42 ssize_t (*show
)(struct bus_type
*bus
, char *buf
);
43 ssize_t (*store
)(struct bus_type
*bus
, const char *buf
, size_t count
);
46 #define BUS_ATTR(_name, _mode, _show, _store) \
47 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
49 extern int __must_check
bus_create_file(struct bus_type
*,
50 struct bus_attribute
*);
51 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
54 * struct bus_type - The bus type of the device
56 * @name: The name of the bus.
57 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
58 * @dev_root: Default device to use as the parent.
59 * @bus_attrs: Default attributes of the bus.
60 * @dev_attrs: Default attributes of the devices on the bus.
61 * @drv_attrs: Default attributes of the device drivers on the bus.
62 * @match: Called, perhaps multiple times, whenever a new device or driver
63 * is added for this bus. It should return a nonzero value if the
64 * given device can be handled by the given driver.
65 * @uevent: Called when a device is added, removed, or a few other things
66 * that generate uevents to add the environment variables.
67 * @probe: Called when a new device or driver add to this bus, and callback
68 * the specific driver's probe to initial the matched device.
69 * @remove: Called when a device removed from this bus.
70 * @shutdown: Called at shut-down time to quiesce the device.
71 * @suspend: Called when a device on this bus wants to go to sleep mode.
72 * @resume: Called to bring a device on this bus out of sleep mode.
73 * @pm: Power management operations of this bus, callback the specific
74 * device driver's pm-ops.
75 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
76 * driver implementations to a bus and allow the driver to do
78 * @p: The private data of the driver core, only the driver core can
81 * A bus is a channel between the processor and one or more devices. For the
82 * purposes of the device model, all devices are connected via a bus, even if
83 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
84 * A USB controller is usually a PCI device, for example. The device model
85 * represents the actual connections between buses and the devices they control.
86 * A bus is represented by the bus_type structure. It contains the name, the
87 * default attributes, the bus' methods, PM operations, and the driver core's
93 struct device
*dev_root
;
94 struct bus_attribute
*bus_attrs
;
95 struct device_attribute
*dev_attrs
;
96 struct driver_attribute
*drv_attrs
;
98 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
99 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
100 int (*probe
)(struct device
*dev
);
101 int (*remove
)(struct device
*dev
);
102 void (*shutdown
)(struct device
*dev
);
104 int (*suspend
)(struct device
*dev
, pm_message_t state
);
105 int (*resume
)(struct device
*dev
);
107 const struct dev_pm_ops
*pm
;
109 struct iommu_ops
*iommu_ops
;
111 struct subsys_private
*p
;
114 /* This is a #define to keep the compiler from merging different
115 * instances of the __key variable */
116 #define bus_register(subsys) \
118 static struct lock_class_key __key; \
119 __bus_register(subsys, &__key); \
121 extern int __must_check
__bus_register(struct bus_type
*bus
,
122 struct lock_class_key
*key
);
123 extern void bus_unregister(struct bus_type
*bus
);
125 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
127 /* iterator helpers for buses */
128 struct subsys_dev_iter
{
129 struct klist_iter ki
;
130 const struct device_type
*type
;
132 void subsys_dev_iter_init(struct subsys_dev_iter
*iter
,
133 struct bus_type
*subsys
,
134 struct device
*start
,
135 const struct device_type
*type
);
136 struct device
*subsys_dev_iter_next(struct subsys_dev_iter
*iter
);
137 void subsys_dev_iter_exit(struct subsys_dev_iter
*iter
);
139 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
140 int (*fn
)(struct device
*dev
, void *data
));
141 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
143 int (*match
)(struct device
*dev
, void *data
));
144 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
145 struct device
*start
,
147 struct device
*subsys_find_device_by_id(struct bus_type
*bus
, unsigned int id
,
148 struct device
*hint
);
149 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
150 void *data
, int (*fn
)(struct device_driver
*, void *));
151 void bus_sort_breadthfirst(struct bus_type
*bus
,
152 int (*compare
)(const struct device
*a
,
153 const struct device
*b
));
155 * Bus notifiers: Get notified of addition/removal of devices
156 * and binding/unbinding of drivers to devices.
157 * In the long run, it should be a replacement for the platform
160 struct notifier_block
;
162 extern int bus_register_notifier(struct bus_type
*bus
,
163 struct notifier_block
*nb
);
164 extern int bus_unregister_notifier(struct bus_type
*bus
,
165 struct notifier_block
*nb
);
167 /* All 4 notifers below get called with the target struct device *
168 * as an argument. Note that those functions are likely to be called
169 * with the device lock held in the core, so be careful.
171 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
172 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
173 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
175 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
176 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
178 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
181 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
182 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
185 * struct device_driver - The basic device driver structure
186 * @name: Name of the device driver.
187 * @bus: The bus which the device of this driver belongs to.
188 * @owner: The module owner.
189 * @mod_name: Used for built-in modules.
190 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
191 * @of_match_table: The open firmware table.
192 * @probe: Called to query the existence of a specific device,
193 * whether this driver can work with it, and bind the driver
194 * to a specific device.
195 * @remove: Called when the device is removed from the system to
196 * unbind a device from this driver.
197 * @shutdown: Called at shut-down time to quiesce the device.
198 * @suspend: Called to put the device to sleep mode. Usually to a
200 * @resume: Called to bring a device from sleep mode.
201 * @groups: Default attributes that get created by the driver core
203 * @pm: Power management operations of the device which matched
205 * @p: Driver core's private data, no one other than the driver
206 * core can touch this.
208 * The device driver-model tracks all of the drivers known to the system.
209 * The main reason for this tracking is to enable the driver core to match
210 * up drivers with new devices. Once drivers are known objects within the
211 * system, however, a number of other things become possible. Device drivers
212 * can export information and configuration variables that are independent
213 * of any specific device.
215 struct device_driver
{
217 struct bus_type
*bus
;
219 struct module
*owner
;
220 const char *mod_name
; /* used for built-in modules */
222 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
224 const struct of_device_id
*of_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
);
303 * struct class - device classes
304 * @name: Name of the class.
305 * @owner: The module owner.
306 * @class_attrs: Default attributes of this class.
307 * @dev_attrs: Default attributes of the devices belong to the class.
308 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
309 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
310 * @dev_uevent: Called when a device is added, removed from this class, or a
311 * few other things that generate uevents to add the environment
313 * @devnode: Callback to provide the devtmpfs.
314 * @class_release: Called to release this class.
315 * @dev_release: Called to release the device.
316 * @suspend: Used to put the device to sleep mode, usually to a low power
318 * @resume: Used to bring the device from the sleep mode.
319 * @ns_type: Callbacks so sysfs can detemine namespaces.
320 * @namespace: Namespace of the device belongs to this class.
321 * @pm: The default device power management operations of this class.
322 * @p: The private data of the driver core, no one other than the
323 * driver core can touch this.
325 * A class is a higher-level view of a device that abstracts out low-level
326 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
327 * at the class level, they are all simply disks. Classes allow user space
328 * to work with devices based on what they do, rather than how they are
329 * connected or how they work.
333 struct module
*owner
;
335 struct class_attribute
*class_attrs
;
336 struct device_attribute
*dev_attrs
;
337 struct bin_attribute
*dev_bin_attrs
;
338 struct kobject
*dev_kobj
;
340 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
341 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
343 void (*class_release
)(struct class *class);
344 void (*dev_release
)(struct device
*dev
);
346 int (*suspend
)(struct device
*dev
, pm_message_t state
);
347 int (*resume
)(struct device
*dev
);
349 const struct kobj_ns_type_operations
*ns_type
;
350 const void *(*namespace)(struct device
*dev
);
352 const struct dev_pm_ops
*pm
;
354 struct subsys_private
*p
;
357 struct class_dev_iter
{
358 struct klist_iter ki
;
359 const struct device_type
*type
;
362 extern struct kobject
*sysfs_dev_block_kobj
;
363 extern struct kobject
*sysfs_dev_char_kobj
;
364 extern int __must_check
__class_register(struct class *class,
365 struct lock_class_key
*key
);
366 extern void class_unregister(struct class *class);
368 /* This is a #define to keep the compiler from merging different
369 * instances of the __key variable */
370 #define class_register(class) \
372 static struct lock_class_key __key; \
373 __class_register(class, &__key); \
377 struct class_compat
*class_compat_register(const char *name
);
378 void class_compat_unregister(struct class_compat
*cls
);
379 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
380 struct device
*device_link
);
381 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
382 struct device
*device_link
);
384 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
386 struct device
*start
,
387 const struct device_type
*type
);
388 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
389 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
391 extern int class_for_each_device(struct class *class, struct device
*start
,
393 int (*fn
)(struct device
*dev
, void *data
));
394 extern struct device
*class_find_device(struct class *class,
395 struct device
*start
, void *data
,
396 int (*match
)(struct device
*, void *));
398 struct class_attribute
{
399 struct attribute attr
;
400 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
402 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
403 const char *buf
, size_t count
);
404 const void *(*namespace)(struct class *class,
405 const struct class_attribute
*attr
);
408 #define CLASS_ATTR(_name, _mode, _show, _store) \
409 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
411 extern int __must_check
class_create_file(struct class *class,
412 const struct class_attribute
*attr
);
413 extern void class_remove_file(struct class *class,
414 const struct class_attribute
*attr
);
416 /* Simple class attribute that is just a static string */
418 struct class_attribute_string
{
419 struct class_attribute attr
;
423 /* Currently read-only only */
424 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
425 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
426 #define CLASS_ATTR_STRING(_name, _mode, _str) \
427 struct class_attribute_string class_attr_##_name = \
428 _CLASS_ATTR_STRING(_name, _mode, _str)
430 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
433 struct class_interface
{
434 struct list_head node
;
437 int (*add_dev
) (struct device
*, struct class_interface
*);
438 void (*remove_dev
) (struct device
*, struct class_interface
*);
441 extern int __must_check
class_interface_register(struct class_interface
*);
442 extern void class_interface_unregister(struct class_interface
*);
444 extern struct class * __must_check
__class_create(struct module
*owner
,
446 struct lock_class_key
*key
);
447 extern void class_destroy(struct class *cls
);
449 /* This is a #define to keep the compiler from merging different
450 * instances of the __key variable */
451 #define class_create(owner, name) \
453 static struct lock_class_key __key; \
454 __class_create(owner, name, &__key); \
458 * The type of device, "struct device" is embedded in. A class
459 * or bus can contain devices of different types
460 * like "partitions" and "disks", "mouse" and "event".
461 * This identifies the device type and carries type-specific
462 * information, equivalent to the kobj_type of a kobject.
463 * If "name" is specified, the uevent will contain it in
464 * the DEVTYPE variable.
468 const struct attribute_group
**groups
;
469 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
470 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
471 void (*release
)(struct device
*dev
);
473 const struct dev_pm_ops
*pm
;
476 /* interface for exporting device attributes */
477 struct device_attribute
{
478 struct attribute attr
;
479 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
481 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
482 const char *buf
, size_t count
);
485 struct dev_ext_attribute
{
486 struct device_attribute attr
;
490 ssize_t
device_show_ulong(struct device
*dev
, struct device_attribute
*attr
,
492 ssize_t
device_store_ulong(struct device
*dev
, struct device_attribute
*attr
,
493 const char *buf
, size_t count
);
494 ssize_t
device_show_int(struct device
*dev
, struct device_attribute
*attr
,
496 ssize_t
device_store_int(struct device
*dev
, struct device_attribute
*attr
,
497 const char *buf
, size_t count
);
499 #define DEVICE_ATTR(_name, _mode, _show, _store) \
500 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
501 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
502 struct dev_ext_attribute dev_attr_##_name = \
503 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
504 #define DEVICE_INT_ATTR(_name, _mode, _var) \
505 struct dev_ext_attribute dev_attr_##_name = \
506 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
508 extern int device_create_file(struct device
*device
,
509 const struct device_attribute
*entry
);
510 extern void device_remove_file(struct device
*dev
,
511 const struct device_attribute
*attr
);
512 extern int __must_check
device_create_bin_file(struct device
*dev
,
513 const struct bin_attribute
*attr
);
514 extern void device_remove_bin_file(struct device
*dev
,
515 const struct bin_attribute
*attr
);
516 extern int device_schedule_callback_owner(struct device
*dev
,
517 void (*func
)(struct device
*dev
), struct module
*owner
);
519 /* This is a macro to avoid include problems with THIS_MODULE */
520 #define device_schedule_callback(dev, func) \
521 device_schedule_callback_owner(dev, func, THIS_MODULE)
523 /* device resource management */
524 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
525 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
527 #ifdef CONFIG_DEBUG_DEVRES
528 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
530 #define devres_alloc(release, size, gfp) \
531 __devres_alloc(release, size, gfp, #release)
533 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
535 extern void devres_free(void *res
);
536 extern void devres_add(struct device
*dev
, void *res
);
537 extern void *devres_find(struct device
*dev
, dr_release_t release
,
538 dr_match_t match
, void *match_data
);
539 extern void *devres_get(struct device
*dev
, void *new_res
,
540 dr_match_t match
, void *match_data
);
541 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
542 dr_match_t match
, void *match_data
);
543 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
544 dr_match_t match
, void *match_data
);
545 extern int devres_release(struct device
*dev
, dr_release_t release
,
546 dr_match_t match
, void *match_data
);
549 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
551 extern void devres_close_group(struct device
*dev
, void *id
);
552 extern void devres_remove_group(struct device
*dev
, void *id
);
553 extern int devres_release_group(struct device
*dev
, void *id
);
555 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
556 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
557 extern void devm_kfree(struct device
*dev
, void *p
);
559 void __iomem
*devm_request_and_ioremap(struct device
*dev
,
560 struct resource
*res
);
562 struct device_dma_parameters
{
564 * a low level driver may set these to teach IOMMU code about
567 unsigned int max_segment_size
;
568 unsigned long segment_boundary_mask
;
572 * struct device - The basic device structure
573 * @parent: The device's "parent" device, the device to which it is attached.
574 * In most cases, a parent device is some sort of bus or host
575 * controller. If parent is NULL, the device, is a top-level device,
576 * which is not usually what you want.
577 * @p: Holds the private data of the driver core portions of the device.
578 * See the comment of the struct device_private for detail.
579 * @kobj: A top-level, abstract class from which other classes are derived.
580 * @init_name: Initial name of the device.
581 * @type: The type of device.
582 * This identifies the device type and carries type-specific
584 * @mutex: Mutex to synchronize calls to its driver.
585 * @bus: Type of bus device is on.
586 * @driver: Which driver has allocated this
587 * @platform_data: Platform data specific to the device.
588 * Example: For devices on custom boards, as typical of embedded
589 * and SOC based hardware, Linux often uses platform_data to point
590 * to board-specific structures describing devices and how they
591 * are wired. That can include what ports are available, chip
592 * variants, which GPIO pins act in what additional roles, and so
593 * on. This shrinks the "Board Support Packages" (BSPs) and
594 * minimizes board-specific #ifdefs in drivers.
595 * @power: For device power management.
596 * See Documentation/power/devices.txt for details.
597 * @pm_domain: Provide callbacks that are executed during system suspend,
598 * hibernation, system resume and during runtime PM transitions
599 * along with subsystem-level and driver-level callbacks.
600 * @numa_node: NUMA node this device is close to.
601 * @dma_mask: Dma mask (if dma'ble device).
602 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
603 * hardware supports 64-bit addresses for consistent allocations
605 * @dma_parms: A low level driver may set these to teach IOMMU code about
606 * segment limitations.
607 * @dma_pools: Dma pools (if dma'ble device).
608 * @dma_mem: Internal for coherent mem override.
609 * @archdata: For arch-specific additions.
610 * @of_node: Associated device tree node.
611 * @devt: For creating the sysfs "dev".
612 * @id: device instance
613 * @devres_lock: Spinlock to protect the resource of the device.
614 * @devres_head: The resources list of the device.
615 * @knode_class: The node used to add the device to the class list.
616 * @class: The class of the device.
617 * @groups: Optional attribute groups.
618 * @release: Callback to free the device after all references have
619 * gone away. This should be set by the allocator of the
620 * device (i.e. the bus driver that discovered the device).
622 * At the lowest level, every device in a Linux system is represented by an
623 * instance of struct device. The device structure contains the information
624 * that the device model core needs to model the system. Most subsystems,
625 * however, track additional information about the devices they host. As a
626 * result, it is rare for devices to be represented by bare device structures;
627 * instead, that structure, like kobject structures, is usually embedded within
628 * a higher-level representation of the device.
631 struct device
*parent
;
633 struct device_private
*p
;
636 const char *init_name
; /* initial name of the device */
637 const struct device_type
*type
;
639 struct mutex mutex
; /* mutex to synchronize calls to
643 struct bus_type
*bus
; /* type of bus device is on */
644 struct device_driver
*driver
; /* which driver has allocated this
646 void *platform_data
; /* Platform specific data, device
647 core doesn't touch it */
648 struct dev_pm_info power
;
649 struct dev_pm_domain
*pm_domain
;
652 int numa_node
; /* NUMA node this device is close to */
654 u64
*dma_mask
; /* dma mask (if dma'able device) */
655 u64 coherent_dma_mask
;/* Like dma_mask, but for
656 alloc_coherent mappings as
657 not all hardware supports
658 64 bit addresses for consistent
659 allocations such descriptors. */
661 struct device_dma_parameters
*dma_parms
;
663 struct list_head dma_pools
; /* dma pools (if dma'ble) */
665 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
667 /* arch specific additions */
668 struct dev_archdata archdata
;
670 struct device_node
*of_node
; /* associated device tree node */
672 dev_t devt
; /* dev_t, creates the sysfs "dev" */
673 u32 id
; /* device instance */
675 spinlock_t devres_lock
;
676 struct list_head devres_head
;
678 struct klist_node knode_class
;
680 const struct attribute_group
**groups
; /* optional groups */
682 void (*release
)(struct device
*dev
);
685 /* Get the wakeup routines, which depend on struct device */
686 #include <linux/pm_wakeup.h>
688 static inline const char *dev_name(const struct device
*dev
)
690 /* Use the init name until the kobject becomes available */
692 return dev
->init_name
;
694 return kobject_name(&dev
->kobj
);
697 extern __printf(2, 3)
698 int dev_set_name(struct device
*dev
, const char *name
, ...);
701 static inline int dev_to_node(struct device
*dev
)
703 return dev
->numa_node
;
705 static inline void set_dev_node(struct device
*dev
, int node
)
707 dev
->numa_node
= node
;
710 static inline int dev_to_node(struct device
*dev
)
714 static inline void set_dev_node(struct device
*dev
, int node
)
719 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
721 return dev
? dev
->power
.subsys_data
: NULL
;
724 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
726 return dev
->kobj
.uevent_suppress
;
729 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
731 dev
->kobj
.uevent_suppress
= val
;
734 static inline int device_is_registered(struct device
*dev
)
736 return dev
->kobj
.state_in_sysfs
;
739 static inline void device_enable_async_suspend(struct device
*dev
)
741 if (!dev
->power
.is_prepared
)
742 dev
->power
.async_suspend
= true;
745 static inline void device_disable_async_suspend(struct device
*dev
)
747 if (!dev
->power
.is_prepared
)
748 dev
->power
.async_suspend
= false;
751 static inline bool device_async_suspend_enabled(struct device
*dev
)
753 return !!dev
->power
.async_suspend
;
756 static inline void pm_suspend_ignore_children(struct device
*dev
, bool enable
)
758 dev
->power
.ignore_children
= enable
;
761 static inline void device_lock(struct device
*dev
)
763 mutex_lock(&dev
->mutex
);
766 static inline int device_trylock(struct device
*dev
)
768 return mutex_trylock(&dev
->mutex
);
771 static inline void device_unlock(struct device
*dev
)
773 mutex_unlock(&dev
->mutex
);
776 void driver_init(void);
779 * High level routines for use by the bus drivers
781 extern int __must_check
device_register(struct device
*dev
);
782 extern void device_unregister(struct device
*dev
);
783 extern void device_initialize(struct device
*dev
);
784 extern int __must_check
device_add(struct device
*dev
);
785 extern void device_del(struct device
*dev
);
786 extern int device_for_each_child(struct device
*dev
, void *data
,
787 int (*fn
)(struct device
*dev
, void *data
));
788 extern struct device
*device_find_child(struct device
*dev
, void *data
,
789 int (*match
)(struct device
*dev
, void *data
));
790 extern int device_rename(struct device
*dev
, const char *new_name
);
791 extern int device_move(struct device
*dev
, struct device
*new_parent
,
792 enum dpm_order dpm_order
);
793 extern const char *device_get_devnode(struct device
*dev
,
794 umode_t
*mode
, const char **tmp
);
795 extern void *dev_get_drvdata(const struct device
*dev
);
796 extern int dev_set_drvdata(struct device
*dev
, void *data
);
799 * Root device objects for grouping under /sys/devices
801 extern struct device
*__root_device_register(const char *name
,
802 struct module
*owner
);
805 * This is a macro to avoid include problems with THIS_MODULE,
806 * just as per what is done for device_schedule_callback() above.
808 #define root_device_register(name) \
809 __root_device_register(name, THIS_MODULE)
811 extern void root_device_unregister(struct device
*root
);
813 static inline void *dev_get_platdata(const struct device
*dev
)
815 return dev
->platform_data
;
819 * Manual binding of a device to driver. See drivers/base/bus.c
820 * for information on use.
822 extern int __must_check
device_bind_driver(struct device
*dev
);
823 extern void device_release_driver(struct device
*dev
);
824 extern int __must_check
device_attach(struct device
*dev
);
825 extern int __must_check
driver_attach(struct device_driver
*drv
);
826 extern int __must_check
device_reprobe(struct device
*dev
);
829 * Easy functions for dynamically creating devices on the fly
831 extern struct device
*device_create_vargs(struct class *cls
,
832 struct device
*parent
,
837 extern __printf(5, 6)
838 struct device
*device_create(struct class *cls
, struct device
*parent
,
839 dev_t devt
, void *drvdata
,
840 const char *fmt
, ...);
841 extern void device_destroy(struct class *cls
, dev_t devt
);
844 * Platform "fixup" functions - allow the platform to have their say
845 * about devices and actions that the general device layer doesn't
848 /* Notify platform of device discovery */
849 extern int (*platform_notify
)(struct device
*dev
);
851 extern int (*platform_notify_remove
)(struct device
*dev
);
855 * get_device - atomically increment the reference count for the device.
858 extern struct device
*get_device(struct device
*dev
);
859 extern void put_device(struct device
*dev
);
861 extern void wait_for_device_probe(void);
863 #ifdef CONFIG_DEVTMPFS
864 extern int devtmpfs_create_node(struct device
*dev
);
865 extern int devtmpfs_delete_node(struct device
*dev
);
866 extern int devtmpfs_mount(const char *mntdir
);
868 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
869 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
870 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
873 /* drivers/base/power/shutdown.c */
874 extern void device_shutdown(void);
876 /* debugging and troubleshooting/diagnostic helpers. */
877 extern const char *dev_driver_string(const struct device
*dev
);
882 extern int __dev_printk(const char *level
, const struct device
*dev
,
883 struct va_format
*vaf
);
884 extern __printf(3, 4)
885 int dev_printk(const char *level
, const struct device
*dev
,
886 const char *fmt
, ...)
888 extern __printf(2, 3)
889 int dev_emerg(const struct device
*dev
, const char *fmt
, ...);
890 extern __printf(2, 3)
891 int dev_alert(const struct device
*dev
, const char *fmt
, ...);
892 extern __printf(2, 3)
893 int dev_crit(const struct device
*dev
, const char *fmt
, ...);
894 extern __printf(2, 3)
895 int dev_err(const struct device
*dev
, const char *fmt
, ...);
896 extern __printf(2, 3)
897 int dev_warn(const struct device
*dev
, const char *fmt
, ...);
898 extern __printf(2, 3)
899 int dev_notice(const struct device
*dev
, const char *fmt
, ...);
900 extern __printf(2, 3)
901 int _dev_info(const struct device
*dev
, const char *fmt
, ...);
905 static inline int __dev_printk(const char *level
, const struct device
*dev
,
906 struct va_format
*vaf
)
908 static inline __printf(3, 4)
909 int dev_printk(const char *level
, const struct device
*dev
,
910 const char *fmt
, ...)
913 static inline __printf(2, 3)
914 int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
916 static inline __printf(2, 3)
917 int dev_crit(const struct device
*dev
, const char *fmt
, ...)
919 static inline __printf(2, 3)
920 int dev_alert(const struct device
*dev
, const char *fmt
, ...)
922 static inline __printf(2, 3)
923 int dev_err(const struct device
*dev
, const char *fmt
, ...)
925 static inline __printf(2, 3)
926 int dev_warn(const struct device
*dev
, const char *fmt
, ...)
928 static inline __printf(2, 3)
929 int dev_notice(const struct device
*dev
, const char *fmt
, ...)
931 static inline __printf(2, 3)
932 int _dev_info(const struct device
*dev
, const char *fmt
, ...)
937 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
939 static DEFINE_RATELIMIT_STATE(_rs, \
940 DEFAULT_RATELIMIT_INTERVAL, \
941 DEFAULT_RATELIMIT_BURST); \
942 if (__ratelimit(&_rs)) \
943 dev_level(dev, fmt, ##__VA_ARGS__); \
946 #define dev_emerg_ratelimited(dev, fmt, ...) \
947 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
948 #define dev_alert_ratelimited(dev, fmt, ...) \
949 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
950 #define dev_crit_ratelimited(dev, fmt, ...) \
951 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
952 #define dev_err_ratelimited(dev, fmt, ...) \
953 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
954 #define dev_warn_ratelimited(dev, fmt, ...) \
955 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
956 #define dev_notice_ratelimited(dev, fmt, ...) \
957 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
958 #define dev_info_ratelimited(dev, fmt, ...) \
959 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
960 #define dev_dbg_ratelimited(dev, fmt, ...) \
961 dev_level_ratelimited(dev_dbg, dev, fmt, ##__VA_ARGS__)
964 * Stupid hackaround for existing uses of non-printk uses dev_info
966 * Note that the definition of dev_info below is actually _dev_info
967 * and a macro is used to avoid redefining dev_info
970 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
972 #if defined(CONFIG_DYNAMIC_DEBUG)
973 #define dev_dbg(dev, format, ...) \
975 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
978 #define dev_dbg(dev, format, arg...) \
979 dev_printk(KERN_DEBUG, dev, format, ##arg)
981 #define dev_dbg(dev, format, arg...) \
984 dev_printk(KERN_DEBUG, dev, format, ##arg); \
990 #define dev_vdbg dev_dbg
992 #define dev_vdbg(dev, format, arg...) \
995 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1001 * dev_WARN*() acts like dev_printk(), but with the key difference
1002 * of using a WARN/WARN_ON to get the message out, including the
1003 * file/line information and a backtrace.
1005 #define dev_WARN(dev, format, arg...) \
1006 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1008 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1009 WARN_ONCE(condition, "Device %s\n" format, \
1010 dev_driver_string(dev), ## arg)
1012 /* Create alias, so I can be autoloaded. */
1013 #define MODULE_ALIAS_CHARDEV(major,minor) \
1014 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1015 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1016 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1018 #ifdef CONFIG_SYSFS_DEPRECATED
1019 extern long sysfs_deprecated
;
1021 #define sysfs_deprecated 0
1025 * module_driver() - Helper macro for drivers that don't do anything
1026 * special in module init/exit. This eliminates a lot of boilerplate.
1027 * Each module may only use this macro once, and calling it replaces
1028 * module_init() and module_exit().
1030 * @__driver: driver name
1031 * @__register: register function for this driver type
1032 * @__unregister: unregister function for this driver type
1033 * @...: Additional arguments to be passed to __register and __unregister.
1035 * Use this macro to construct bus specific macros for registering
1036 * drivers, and do not use it on its own.
1038 #define module_driver(__driver, __register, __unregister, ...) \
1039 static int __init __driver##_init(void) \
1041 return __register(&(__driver) , ##__VA_ARGS__); \
1043 module_init(__driver##_init); \
1044 static void __exit __driver##_exit(void) \
1046 __unregister(&(__driver) , ##__VA_ARGS__); \
1048 module_exit(__driver##_exit);
1050 #endif /* _DEVICE_H_ */