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/module.h>
25 #include <linux/atomic.h>
26 #include <asm/device.h>
29 struct device_private
;
31 struct driver_private
;
33 struct subsys_private
;
37 struct bus_attribute
{
38 struct attribute attr
;
39 ssize_t (*show
)(struct bus_type
*bus
, char *buf
);
40 ssize_t (*store
)(struct bus_type
*bus
, const char *buf
, size_t count
);
43 #define BUS_ATTR(_name, _mode, _show, _store) \
44 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
46 extern int __must_check
bus_create_file(struct bus_type
*,
47 struct bus_attribute
*);
48 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
51 * struct bus_type - The bus type of the device
53 * @name: The name of the bus.
54 * @bus_attrs: Default attributes of the bus.
55 * @dev_attrs: Default attributes of the devices on the bus.
56 * @drv_attrs: Default attributes of the device drivers on the bus.
57 * @match: Called, perhaps multiple times, whenever a new device or driver
58 * is added for this bus. It should return a nonzero value if the
59 * given device can be handled by the given driver.
60 * @uevent: Called when a device is added, removed, or a few other things
61 * that generate uevents to add the environment variables.
62 * @probe: Called when a new device or driver add to this bus, and callback
63 * the specific driver's probe to initial the matched device.
64 * @remove: Called when a device removed from this bus.
65 * @shutdown: Called at shut-down time to quiesce the device.
66 * @suspend: Called when a device on this bus wants to go to sleep mode.
67 * @resume: Called to bring a device on this bus out of sleep mode.
68 * @pm: Power management operations of this bus, callback the specific
69 * device driver's pm-ops.
70 * @p: The private data of the driver core, only the driver core can
73 * A bus is a channel between the processor and one or more devices. For the
74 * purposes of the device model, all devices are connected via a bus, even if
75 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
76 * A USB controller is usually a PCI device, for example. The device model
77 * represents the actual connections between buses and the devices they control.
78 * A bus is represented by the bus_type structure. It contains the name, the
79 * default attributes, the bus' methods, PM operations, and the driver core's
84 struct bus_attribute
*bus_attrs
;
85 struct device_attribute
*dev_attrs
;
86 struct driver_attribute
*drv_attrs
;
88 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
89 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
90 int (*probe
)(struct device
*dev
);
91 int (*remove
)(struct device
*dev
);
92 void (*shutdown
)(struct device
*dev
);
94 int (*suspend
)(struct device
*dev
, pm_message_t state
);
95 int (*resume
)(struct device
*dev
);
97 const struct dev_pm_ops
*pm
;
99 struct subsys_private
*p
;
102 extern int __must_check
bus_register(struct bus_type
*bus
);
103 extern void bus_unregister(struct bus_type
*bus
);
105 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
107 /* iterator helpers for buses */
109 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
110 int (*fn
)(struct device
*dev
, void *data
));
111 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
113 int (*match
)(struct device
*dev
, void *data
));
114 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
115 struct device
*start
,
118 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
119 void *data
, int (*fn
)(struct device_driver
*, void *));
121 void bus_sort_breadthfirst(struct bus_type
*bus
,
122 int (*compare
)(const struct device
*a
,
123 const struct device
*b
));
125 * Bus notifiers: Get notified of addition/removal of devices
126 * and binding/unbinding of drivers to devices.
127 * In the long run, it should be a replacement for the platform
130 struct notifier_block
;
132 extern int bus_register_notifier(struct bus_type
*bus
,
133 struct notifier_block
*nb
);
134 extern int bus_unregister_notifier(struct bus_type
*bus
,
135 struct notifier_block
*nb
);
137 /* All 4 notifers below get called with the target struct device *
138 * as an argument. Note that those functions are likely to be called
139 * with the device lock held in the core, so be careful.
141 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
142 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
143 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
145 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
146 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
148 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
151 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
152 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
155 * struct device_driver - The basic device driver structure
156 * @name: Name of the device driver.
157 * @bus: The bus which the device of this driver belongs to.
158 * @owner: The module owner.
159 * @mod_name: Used for built-in modules.
160 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
161 * @of_match_table: The open firmware table.
162 * @probe: Called to query the existence of a specific device,
163 * whether this driver can work with it, and bind the driver
164 * to a specific device.
165 * @remove: Called when the device is removed from the system to
166 * unbind a device from this driver.
167 * @shutdown: Called at shut-down time to quiesce the device.
168 * @suspend: Called to put the device to sleep mode. Usually to a
170 * @resume: Called to bring a device from sleep mode.
171 * @groups: Default attributes that get created by the driver core
173 * @pm: Power management operations of the device which matched
175 * @p: Driver core's private data, no one other than the driver
176 * core can touch this.
178 * The device driver-model tracks all of the drivers known to the system.
179 * The main reason for this tracking is to enable the driver core to match
180 * up drivers with new devices. Once drivers are known objects within the
181 * system, however, a number of other things become possible. Device drivers
182 * can export information and configuration variables that are independent
183 * of any specific device.
185 struct device_driver
{
187 struct bus_type
*bus
;
189 struct module
*owner
;
190 const char *mod_name
; /* used for built-in modules */
192 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
194 const struct of_device_id
*of_match_table
;
196 int (*probe
) (struct device
*dev
);
197 int (*remove
) (struct device
*dev
);
198 void (*shutdown
) (struct device
*dev
);
199 int (*suspend
) (struct device
*dev
, pm_message_t state
);
200 int (*resume
) (struct device
*dev
);
201 const struct attribute_group
**groups
;
203 const struct dev_pm_ops
*pm
;
205 struct driver_private
*p
;
209 extern int __must_check
driver_register(struct device_driver
*drv
);
210 extern void driver_unregister(struct device_driver
*drv
);
212 extern struct device_driver
*get_driver(struct device_driver
*drv
);
213 extern void put_driver(struct device_driver
*drv
);
214 extern struct device_driver
*driver_find(const char *name
,
215 struct bus_type
*bus
);
216 extern int driver_probe_done(void);
217 extern void wait_for_device_probe(void);
220 /* sysfs interface for exporting driver attributes */
222 struct driver_attribute
{
223 struct attribute attr
;
224 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
225 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
229 #define DRIVER_ATTR(_name, _mode, _show, _store) \
230 struct driver_attribute driver_attr_##_name = \
231 __ATTR(_name, _mode, _show, _store)
233 extern int __must_check
driver_create_file(struct device_driver
*driver
,
234 const struct driver_attribute
*attr
);
235 extern void driver_remove_file(struct device_driver
*driver
,
236 const struct driver_attribute
*attr
);
238 extern int __must_check
driver_add_kobj(struct device_driver
*drv
,
239 struct kobject
*kobj
,
240 const char *fmt
, ...);
242 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
243 struct device
*start
,
245 int (*fn
)(struct device
*dev
,
247 struct device
*driver_find_device(struct device_driver
*drv
,
248 struct device
*start
, void *data
,
249 int (*match
)(struct device
*dev
, void *data
));
252 * struct class - device classes
253 * @name: Name of the class.
254 * @owner: The module owner.
255 * @class_attrs: Default attributes of this class.
256 * @dev_attrs: Default attributes of the devices belong to the class.
257 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
258 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
259 * @dev_uevent: Called when a device is added, removed from this class, or a
260 * few other things that generate uevents to add the environment
262 * @devnode: Callback to provide the devtmpfs.
263 * @class_release: Called to release this class.
264 * @dev_release: Called to release the device.
265 * @suspend: Used to put the device to sleep mode, usually to a low power
267 * @resume: Used to bring the device from the sleep mode.
268 * @ns_type: Callbacks so sysfs can detemine namespaces.
269 * @namespace: Namespace of the device belongs to this class.
270 * @pm: The default device power management operations of this class.
271 * @p: The private data of the driver core, no one other than the
272 * driver core can touch this.
274 * A class is a higher-level view of a device that abstracts out low-level
275 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
276 * at the class level, they are all simply disks. Classes allow user space
277 * to work with devices based on what they do, rather than how they are
278 * connected or how they work.
282 struct module
*owner
;
284 struct class_attribute
*class_attrs
;
285 struct device_attribute
*dev_attrs
;
286 struct bin_attribute
*dev_bin_attrs
;
287 struct kobject
*dev_kobj
;
289 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
290 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
292 void (*class_release
)(struct class *class);
293 void (*dev_release
)(struct device
*dev
);
295 int (*suspend
)(struct device
*dev
, pm_message_t state
);
296 int (*resume
)(struct device
*dev
);
298 const struct kobj_ns_type_operations
*ns_type
;
299 const void *(*namespace)(struct device
*dev
);
301 const struct dev_pm_ops
*pm
;
303 struct subsys_private
*p
;
306 struct class_dev_iter
{
307 struct klist_iter ki
;
308 const struct device_type
*type
;
311 extern struct kobject
*sysfs_dev_block_kobj
;
312 extern struct kobject
*sysfs_dev_char_kobj
;
313 extern int __must_check
__class_register(struct class *class,
314 struct lock_class_key
*key
);
315 extern void class_unregister(struct class *class);
317 /* This is a #define to keep the compiler from merging different
318 * instances of the __key variable */
319 #define class_register(class) \
321 static struct lock_class_key __key; \
322 __class_register(class, &__key); \
326 struct class_compat
*class_compat_register(const char *name
);
327 void class_compat_unregister(struct class_compat
*cls
);
328 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
329 struct device
*device_link
);
330 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
331 struct device
*device_link
);
333 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
335 struct device
*start
,
336 const struct device_type
*type
);
337 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
338 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
340 extern int class_for_each_device(struct class *class, struct device
*start
,
342 int (*fn
)(struct device
*dev
, void *data
));
343 extern struct device
*class_find_device(struct class *class,
344 struct device
*start
, void *data
,
345 int (*match
)(struct device
*, void *));
347 struct class_attribute
{
348 struct attribute attr
;
349 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
351 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
352 const char *buf
, size_t count
);
353 const void *(*namespace)(struct class *class,
354 const struct class_attribute
*attr
);
357 #define CLASS_ATTR(_name, _mode, _show, _store) \
358 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
360 extern int __must_check
class_create_file(struct class *class,
361 const struct class_attribute
*attr
);
362 extern void class_remove_file(struct class *class,
363 const struct class_attribute
*attr
);
365 /* Simple class attribute that is just a static string */
367 struct class_attribute_string
{
368 struct class_attribute attr
;
372 /* Currently read-only only */
373 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
374 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
375 #define CLASS_ATTR_STRING(_name, _mode, _str) \
376 struct class_attribute_string class_attr_##_name = \
377 _CLASS_ATTR_STRING(_name, _mode, _str)
379 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
382 struct class_interface
{
383 struct list_head node
;
386 int (*add_dev
) (struct device
*, struct class_interface
*);
387 void (*remove_dev
) (struct device
*, struct class_interface
*);
390 extern int __must_check
class_interface_register(struct class_interface
*);
391 extern void class_interface_unregister(struct class_interface
*);
393 extern struct class * __must_check
__class_create(struct module
*owner
,
395 struct lock_class_key
*key
);
396 extern void class_destroy(struct class *cls
);
398 /* This is a #define to keep the compiler from merging different
399 * instances of the __key variable */
400 #define class_create(owner, name) \
402 static struct lock_class_key __key; \
403 __class_create(owner, name, &__key); \
407 * The type of device, "struct device" is embedded in. A class
408 * or bus can contain devices of different types
409 * like "partitions" and "disks", "mouse" and "event".
410 * This identifies the device type and carries type-specific
411 * information, equivalent to the kobj_type of a kobject.
412 * If "name" is specified, the uevent will contain it in
413 * the DEVTYPE variable.
417 const struct attribute_group
**groups
;
418 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
419 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
420 void (*release
)(struct device
*dev
);
422 const struct dev_pm_ops
*pm
;
425 /* interface for exporting device attributes */
426 struct device_attribute
{
427 struct attribute attr
;
428 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
430 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
431 const char *buf
, size_t count
);
434 #define DEVICE_ATTR(_name, _mode, _show, _store) \
435 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
437 extern int __must_check
device_create_file(struct device
*device
,
438 const struct device_attribute
*entry
);
439 extern void device_remove_file(struct device
*dev
,
440 const struct device_attribute
*attr
);
441 extern int __must_check
device_create_bin_file(struct device
*dev
,
442 const struct bin_attribute
*attr
);
443 extern void device_remove_bin_file(struct device
*dev
,
444 const struct bin_attribute
*attr
);
445 extern int device_schedule_callback_owner(struct device
*dev
,
446 void (*func
)(struct device
*dev
), struct module
*owner
);
448 /* This is a macro to avoid include problems with THIS_MODULE */
449 #define device_schedule_callback(dev, func) \
450 device_schedule_callback_owner(dev, func, THIS_MODULE)
452 /* device resource management */
453 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
454 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
456 #ifdef CONFIG_DEBUG_DEVRES
457 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
459 #define devres_alloc(release, size, gfp) \
460 __devres_alloc(release, size, gfp, #release)
462 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
464 extern void devres_free(void *res
);
465 extern void devres_add(struct device
*dev
, void *res
);
466 extern void *devres_find(struct device
*dev
, dr_release_t release
,
467 dr_match_t match
, void *match_data
);
468 extern void *devres_get(struct device
*dev
, void *new_res
,
469 dr_match_t match
, void *match_data
);
470 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
471 dr_match_t match
, void *match_data
);
472 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
473 dr_match_t match
, void *match_data
);
476 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
478 extern void devres_close_group(struct device
*dev
, void *id
);
479 extern void devres_remove_group(struct device
*dev
, void *id
);
480 extern int devres_release_group(struct device
*dev
, void *id
);
482 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
483 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
484 extern void devm_kfree(struct device
*dev
, void *p
);
486 struct device_dma_parameters
{
488 * a low level driver may set these to teach IOMMU code about
491 unsigned int max_segment_size
;
492 unsigned long segment_boundary_mask
;
496 * struct device - The basic device structure
497 * @parent: The device's "parent" device, the device to which it is attached.
498 * In most cases, a parent device is some sort of bus or host
499 * controller. If parent is NULL, the device, is a top-level device,
500 * which is not usually what you want.
501 * @p: Holds the private data of the driver core portions of the device.
502 * See the comment of the struct device_private for detail.
503 * @kobj: A top-level, abstract class from which other classes are derived.
504 * @init_name: Initial name of the device.
505 * @type: The type of device.
506 * This identifies the device type and carries type-specific
508 * @mutex: Mutex to synchronize calls to its driver.
509 * @bus: Type of bus device is on.
510 * @driver: Which driver has allocated this
511 * @platform_data: Platform data specific to the device.
512 * Example: For devices on custom boards, as typical of embedded
513 * and SOC based hardware, Linux often uses platform_data to point
514 * to board-specific structures describing devices and how they
515 * are wired. That can include what ports are available, chip
516 * variants, which GPIO pins act in what additional roles, and so
517 * on. This shrinks the "Board Support Packages" (BSPs) and
518 * minimizes board-specific #ifdefs in drivers.
519 * @power: For device power management.
520 * See Documentation/power/devices.txt for details.
521 * @pm_domain: Provide callbacks that are executed during system suspend,
522 * hibernation, system resume and during runtime PM transitions
523 * along with subsystem-level and driver-level callbacks.
524 * @numa_node: NUMA node this device is close to.
525 * @dma_mask: Dma mask (if dma'ble device).
526 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
527 * hardware supports 64-bit addresses for consistent allocations
529 * @dma_parms: A low level driver may set these to teach IOMMU code about
530 * segment limitations.
531 * @dma_pools: Dma pools (if dma'ble device).
532 * @dma_mem: Internal for coherent mem override.
533 * @archdata: For arch-specific additions.
534 * @of_node: Associated device tree node.
535 * @devt: For creating the sysfs "dev".
536 * @devres_lock: Spinlock to protect the resource of the device.
537 * @devres_head: The resources list of the device.
538 * @knode_class: The node used to add the device to the class list.
539 * @class: The class of the device.
540 * @groups: Optional attribute groups.
541 * @release: Callback to free the device after all references have
542 * gone away. This should be set by the allocator of the
543 * device (i.e. the bus driver that discovered the device).
545 * At the lowest level, every device in a Linux system is represented by an
546 * instance of struct device. The device structure contains the information
547 * that the device model core needs to model the system. Most subsystems,
548 * however, track additional information about the devices they host. As a
549 * result, it is rare for devices to be represented by bare device structures;
550 * instead, that structure, like kobject structures, is usually embedded within
551 * a higher-level representation of the device.
554 struct device
*parent
;
556 struct device_private
*p
;
559 const char *init_name
; /* initial name of the device */
560 const struct device_type
*type
;
562 struct mutex mutex
; /* mutex to synchronize calls to
566 struct bus_type
*bus
; /* type of bus device is on */
567 struct device_driver
*driver
; /* which driver has allocated this
569 void *platform_data
; /* Platform specific data, device
570 core doesn't touch it */
571 struct dev_pm_info power
;
572 struct dev_pm_domain
*pm_domain
;
575 int numa_node
; /* NUMA node this device is close to */
577 u64
*dma_mask
; /* dma mask (if dma'able device) */
578 u64 coherent_dma_mask
;/* Like dma_mask, but for
579 alloc_coherent mappings as
580 not all hardware supports
581 64 bit addresses for consistent
582 allocations such descriptors. */
584 struct device_dma_parameters
*dma_parms
;
586 struct list_head dma_pools
; /* dma pools (if dma'ble) */
588 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
590 /* arch specific additions */
591 struct dev_archdata archdata
;
593 struct device_node
*of_node
; /* associated device tree node */
595 dev_t devt
; /* dev_t, creates the sysfs "dev" */
597 spinlock_t devres_lock
;
598 struct list_head devres_head
;
600 struct klist_node knode_class
;
602 const struct attribute_group
**groups
; /* optional groups */
604 void (*release
)(struct device
*dev
);
607 /* Get the wakeup routines, which depend on struct device */
608 #include <linux/pm_wakeup.h>
610 static inline const char *dev_name(const struct device
*dev
)
612 /* Use the init name until the kobject becomes available */
614 return dev
->init_name
;
616 return kobject_name(&dev
->kobj
);
619 extern int dev_set_name(struct device
*dev
, const char *name
, ...)
620 __attribute__((format(printf
, 2, 3)));
623 static inline int dev_to_node(struct device
*dev
)
625 return dev
->numa_node
;
627 static inline void set_dev_node(struct device
*dev
, int node
)
629 dev
->numa_node
= node
;
632 static inline int dev_to_node(struct device
*dev
)
636 static inline void set_dev_node(struct device
*dev
, int node
)
641 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
643 return dev
->kobj
.uevent_suppress
;
646 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
648 dev
->kobj
.uevent_suppress
= val
;
651 static inline int device_is_registered(struct device
*dev
)
653 return dev
->kobj
.state_in_sysfs
;
656 static inline void device_enable_async_suspend(struct device
*dev
)
658 if (!dev
->power
.is_prepared
)
659 dev
->power
.async_suspend
= true;
662 static inline void device_disable_async_suspend(struct device
*dev
)
664 if (!dev
->power
.is_prepared
)
665 dev
->power
.async_suspend
= false;
668 static inline bool device_async_suspend_enabled(struct device
*dev
)
670 return !!dev
->power
.async_suspend
;
673 static inline void device_lock(struct device
*dev
)
675 mutex_lock(&dev
->mutex
);
678 static inline int device_trylock(struct device
*dev
)
680 return mutex_trylock(&dev
->mutex
);
683 static inline void device_unlock(struct device
*dev
)
685 mutex_unlock(&dev
->mutex
);
688 void driver_init(void);
691 * High level routines for use by the bus drivers
693 extern int __must_check
device_register(struct device
*dev
);
694 extern void device_unregister(struct device
*dev
);
695 extern void device_initialize(struct device
*dev
);
696 extern int __must_check
device_add(struct device
*dev
);
697 extern void device_del(struct device
*dev
);
698 extern int device_for_each_child(struct device
*dev
, void *data
,
699 int (*fn
)(struct device
*dev
, void *data
));
700 extern struct device
*device_find_child(struct device
*dev
, void *data
,
701 int (*match
)(struct device
*dev
, void *data
));
702 extern int device_rename(struct device
*dev
, const char *new_name
);
703 extern int device_move(struct device
*dev
, struct device
*new_parent
,
704 enum dpm_order dpm_order
);
705 extern const char *device_get_devnode(struct device
*dev
,
706 mode_t
*mode
, const char **tmp
);
707 extern void *dev_get_drvdata(const struct device
*dev
);
708 extern int dev_set_drvdata(struct device
*dev
, void *data
);
711 * Root device objects for grouping under /sys/devices
713 extern struct device
*__root_device_register(const char *name
,
714 struct module
*owner
);
715 static inline struct device
*root_device_register(const char *name
)
717 return __root_device_register(name
, THIS_MODULE
);
719 extern void root_device_unregister(struct device
*root
);
721 static inline void *dev_get_platdata(const struct device
*dev
)
723 return dev
->platform_data
;
727 * Manual binding of a device to driver. See drivers/base/bus.c
728 * for information on use.
730 extern int __must_check
device_bind_driver(struct device
*dev
);
731 extern void device_release_driver(struct device
*dev
);
732 extern int __must_check
device_attach(struct device
*dev
);
733 extern int __must_check
driver_attach(struct device_driver
*drv
);
734 extern int __must_check
device_reprobe(struct device
*dev
);
737 * Easy functions for dynamically creating devices on the fly
739 extern struct device
*device_create_vargs(struct class *cls
,
740 struct device
*parent
,
745 extern struct device
*device_create(struct class *cls
, struct device
*parent
,
746 dev_t devt
, void *drvdata
,
747 const char *fmt
, ...)
748 __attribute__((format(printf
, 5, 6)));
749 extern void device_destroy(struct class *cls
, dev_t devt
);
752 * Platform "fixup" functions - allow the platform to have their say
753 * about devices and actions that the general device layer doesn't
756 /* Notify platform of device discovery */
757 extern int (*platform_notify
)(struct device
*dev
);
759 extern int (*platform_notify_remove
)(struct device
*dev
);
763 * get_device - atomically increment the reference count for the device.
766 extern struct device
*get_device(struct device
*dev
);
767 extern void put_device(struct device
*dev
);
769 extern void wait_for_device_probe(void);
771 #ifdef CONFIG_DEVTMPFS
772 extern int devtmpfs_create_node(struct device
*dev
);
773 extern int devtmpfs_delete_node(struct device
*dev
);
774 extern int devtmpfs_mount(const char *mntdir
);
776 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
777 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
778 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
781 /* drivers/base/power/shutdown.c */
782 extern void device_shutdown(void);
784 /* debugging and troubleshooting/diagnostic helpers. */
785 extern const char *dev_driver_string(const struct device
*dev
);
790 extern int __dev_printk(const char *level
, const struct device
*dev
,
791 struct va_format
*vaf
);
792 extern int dev_printk(const char *level
, const struct device
*dev
,
793 const char *fmt
, ...)
794 __attribute__ ((format (printf
, 3, 4)));
795 extern int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
796 __attribute__ ((format (printf
, 2, 3)));
797 extern int dev_alert(const struct device
*dev
, const char *fmt
, ...)
798 __attribute__ ((format (printf
, 2, 3)));
799 extern int dev_crit(const struct device
*dev
, const char *fmt
, ...)
800 __attribute__ ((format (printf
, 2, 3)));
801 extern int dev_err(const struct device
*dev
, const char *fmt
, ...)
802 __attribute__ ((format (printf
, 2, 3)));
803 extern int dev_warn(const struct device
*dev
, const char *fmt
, ...)
804 __attribute__ ((format (printf
, 2, 3)));
805 extern int dev_notice(const struct device
*dev
, const char *fmt
, ...)
806 __attribute__ ((format (printf
, 2, 3)));
807 extern int _dev_info(const struct device
*dev
, const char *fmt
, ...)
808 __attribute__ ((format (printf
, 2, 3)));
812 static inline int __dev_printk(const char *level
, const struct device
*dev
,
813 struct va_format
*vaf
)
815 static inline int dev_printk(const char *level
, const struct device
*dev
,
816 const char *fmt
, ...)
817 __attribute__ ((format (printf
, 3, 4)));
818 static inline int dev_printk(const char *level
, const struct device
*dev
,
819 const char *fmt
, ...)
822 static inline int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
823 __attribute__ ((format (printf
, 2, 3)));
824 static inline int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
826 static inline int dev_crit(const struct device
*dev
, const char *fmt
, ...)
827 __attribute__ ((format (printf
, 2, 3)));
828 static inline int dev_crit(const struct device
*dev
, const char *fmt
, ...)
830 static inline int dev_alert(const struct device
*dev
, const char *fmt
, ...)
831 __attribute__ ((format (printf
, 2, 3)));
832 static inline int dev_alert(const struct device
*dev
, const char *fmt
, ...)
834 static inline int dev_err(const struct device
*dev
, const char *fmt
, ...)
835 __attribute__ ((format (printf
, 2, 3)));
836 static inline int dev_err(const struct device
*dev
, const char *fmt
, ...)
838 static inline int dev_warn(const struct device
*dev
, const char *fmt
, ...)
839 __attribute__ ((format (printf
, 2, 3)));
840 static inline int dev_warn(const struct device
*dev
, const char *fmt
, ...)
842 static inline int dev_notice(const struct device
*dev
, const char *fmt
, ...)
843 __attribute__ ((format (printf
, 2, 3)));
844 static inline int dev_notice(const struct device
*dev
, const char *fmt
, ...)
846 static inline int _dev_info(const struct device
*dev
, const char *fmt
, ...)
847 __attribute__ ((format (printf
, 2, 3)));
848 static inline int _dev_info(const struct device
*dev
, const char *fmt
, ...)
854 * Stupid hackaround for existing uses of non-printk uses dev_info
856 * Note that the definition of dev_info below is actually _dev_info
857 * and a macro is used to avoid redefining dev_info
860 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
863 #define dev_dbg(dev, format, arg...) \
864 dev_printk(KERN_DEBUG, dev, format, ##arg)
865 #elif defined(CONFIG_DYNAMIC_DEBUG)
866 #define dev_dbg(dev, format, ...) \
868 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
871 #define dev_dbg(dev, format, arg...) \
874 dev_printk(KERN_DEBUG, dev, format, ##arg); \
880 #define dev_vdbg dev_dbg
882 #define dev_vdbg(dev, format, arg...) \
885 dev_printk(KERN_DEBUG, dev, format, ##arg); \
891 * dev_WARN*() acts like dev_printk(), but with the key difference
892 * of using a WARN/WARN_ON to get the message out, including the
893 * file/line information and a backtrace.
895 #define dev_WARN(dev, format, arg...) \
896 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
898 #define dev_WARN_ONCE(dev, condition, format, arg...) \
899 WARN_ONCE(condition, "Device %s\n" format, \
900 dev_driver_string(dev), ## arg)
902 /* Create alias, so I can be autoloaded. */
903 #define MODULE_ALIAS_CHARDEV(major,minor) \
904 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
905 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
906 MODULE_ALIAS("char-major-" __stringify(major) "-*")
908 #ifdef CONFIG_SYSFS_DEPRECATED
909 extern long sysfs_deprecated
;
911 #define sysfs_deprecated 0
914 #endif /* _DEVICE_H_ */