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 <asm/device.h>
29 struct device_private
;
31 struct driver_private
;
34 struct subsys_private
;
39 struct bus_attribute
{
40 struct attribute attr
;
41 ssize_t (*show
)(struct bus_type
*bus
, char *buf
);
42 ssize_t (*store
)(struct bus_type
*bus
, const char *buf
, size_t count
);
45 #define BUS_ATTR(_name, _mode, _show, _store) \
46 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
48 extern int __must_check
bus_create_file(struct bus_type
*,
49 struct bus_attribute
*);
50 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
53 * struct bus_type - The bus type of the device
55 * @name: The name of the bus.
56 * @bus_attrs: Default attributes of the bus.
57 * @dev_attrs: Default attributes of the devices on the bus.
58 * @drv_attrs: Default attributes of the device drivers on the bus.
59 * @match: Called, perhaps multiple times, whenever a new device or driver
60 * is added for this bus. It should return a nonzero value if the
61 * given device can be handled by the given driver.
62 * @uevent: Called when a device is added, removed, or a few other things
63 * that generate uevents to add the environment variables.
64 * @probe: Called when a new device or driver add to this bus, and callback
65 * the specific driver's probe to initial the matched device.
66 * @remove: Called when a device removed from this bus.
67 * @shutdown: Called at shut-down time to quiesce the device.
68 * @suspend: Called when a device on this bus wants to go to sleep mode.
69 * @resume: Called to bring a device on this bus out of sleep mode.
70 * @pm: Power management operations of this bus, callback the specific
71 * device driver's pm-ops.
72 * @iommu_ops IOMMU specific operations for this bus, used to attach IOMMU
73 * driver implementations to a bus and allow the driver to do
75 * @p: The private data of the driver core, only the driver core can
78 * A bus is a channel between the processor and one or more devices. For the
79 * purposes of the device model, all devices are connected via a bus, even if
80 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
81 * A USB controller is usually a PCI device, for example. The device model
82 * represents the actual connections between buses and the devices they control.
83 * A bus is represented by the bus_type structure. It contains the name, the
84 * default attributes, the bus' methods, PM operations, and the driver core's
89 struct bus_attribute
*bus_attrs
;
90 struct device_attribute
*dev_attrs
;
91 struct driver_attribute
*drv_attrs
;
93 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
94 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
95 int (*probe
)(struct device
*dev
);
96 int (*remove
)(struct device
*dev
);
97 void (*shutdown
)(struct device
*dev
);
99 int (*suspend
)(struct device
*dev
, pm_message_t state
);
100 int (*resume
)(struct device
*dev
);
102 const struct dev_pm_ops
*pm
;
104 struct iommu_ops
*iommu_ops
;
106 struct subsys_private
*p
;
109 extern int __must_check
bus_register(struct bus_type
*bus
);
110 extern void bus_unregister(struct bus_type
*bus
);
112 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
114 /* iterator helpers for buses */
116 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
117 int (*fn
)(struct device
*dev
, void *data
));
118 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
120 int (*match
)(struct device
*dev
, void *data
));
121 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
122 struct device
*start
,
125 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
126 void *data
, int (*fn
)(struct device_driver
*, void *));
128 void bus_sort_breadthfirst(struct bus_type
*bus
,
129 int (*compare
)(const struct device
*a
,
130 const struct device
*b
));
132 * Bus notifiers: Get notified of addition/removal of devices
133 * and binding/unbinding of drivers to devices.
134 * In the long run, it should be a replacement for the platform
137 struct notifier_block
;
139 extern int bus_register_notifier(struct bus_type
*bus
,
140 struct notifier_block
*nb
);
141 extern int bus_unregister_notifier(struct bus_type
*bus
,
142 struct notifier_block
*nb
);
144 /* All 4 notifers below get called with the target struct device *
145 * as an argument. Note that those functions are likely to be called
146 * with the device lock held in the core, so be careful.
148 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
149 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
150 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
152 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
153 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
155 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
158 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
159 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
162 * struct device_driver - The basic device driver structure
163 * @name: Name of the device driver.
164 * @bus: The bus which the device of this driver belongs to.
165 * @owner: The module owner.
166 * @mod_name: Used for built-in modules.
167 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
168 * @of_match_table: The open firmware table.
169 * @probe: Called to query the existence of a specific device,
170 * whether this driver can work with it, and bind the driver
171 * to a specific device.
172 * @remove: Called when the device is removed from the system to
173 * unbind a device from this driver.
174 * @shutdown: Called at shut-down time to quiesce the device.
175 * @suspend: Called to put the device to sleep mode. Usually to a
177 * @resume: Called to bring a device from sleep mode.
178 * @groups: Default attributes that get created by the driver core
180 * @pm: Power management operations of the device which matched
182 * @p: Driver core's private data, no one other than the driver
183 * core can touch this.
185 * The device driver-model tracks all of the drivers known to the system.
186 * The main reason for this tracking is to enable the driver core to match
187 * up drivers with new devices. Once drivers are known objects within the
188 * system, however, a number of other things become possible. Device drivers
189 * can export information and configuration variables that are independent
190 * of any specific device.
192 struct device_driver
{
194 struct bus_type
*bus
;
196 struct module
*owner
;
197 const char *mod_name
; /* used for built-in modules */
199 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
201 const struct of_device_id
*of_match_table
;
203 int (*probe
) (struct device
*dev
);
204 int (*remove
) (struct device
*dev
);
205 void (*shutdown
) (struct device
*dev
);
206 int (*suspend
) (struct device
*dev
, pm_message_t state
);
207 int (*resume
) (struct device
*dev
);
208 const struct attribute_group
**groups
;
210 const struct dev_pm_ops
*pm
;
212 struct driver_private
*p
;
216 extern int __must_check
driver_register(struct device_driver
*drv
);
217 extern void driver_unregister(struct device_driver
*drv
);
219 extern struct device_driver
*get_driver(struct device_driver
*drv
);
220 extern void put_driver(struct device_driver
*drv
);
221 extern struct device_driver
*driver_find(const char *name
,
222 struct bus_type
*bus
);
223 extern int driver_probe_done(void);
224 extern void wait_for_device_probe(void);
227 /* sysfs interface for exporting driver attributes */
229 struct driver_attribute
{
230 struct attribute attr
;
231 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
232 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
236 #define DRIVER_ATTR(_name, _mode, _show, _store) \
237 struct driver_attribute driver_attr_##_name = \
238 __ATTR(_name, _mode, _show, _store)
240 extern int __must_check
driver_create_file(struct device_driver
*driver
,
241 const struct driver_attribute
*attr
);
242 extern void driver_remove_file(struct device_driver
*driver
,
243 const struct driver_attribute
*attr
);
245 extern int __must_check
driver_add_kobj(struct device_driver
*drv
,
246 struct kobject
*kobj
,
247 const char *fmt
, ...);
249 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
250 struct device
*start
,
252 int (*fn
)(struct device
*dev
,
254 struct device
*driver_find_device(struct device_driver
*drv
,
255 struct device
*start
, void *data
,
256 int (*match
)(struct device
*dev
, void *data
));
259 * struct class - device classes
260 * @name: Name of the class.
261 * @owner: The module owner.
262 * @class_attrs: Default attributes of this class.
263 * @dev_attrs: Default attributes of the devices belong to the class.
264 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
265 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
266 * @dev_uevent: Called when a device is added, removed from this class, or a
267 * few other things that generate uevents to add the environment
269 * @devnode: Callback to provide the devtmpfs.
270 * @class_release: Called to release this class.
271 * @dev_release: Called to release the device.
272 * @suspend: Used to put the device to sleep mode, usually to a low power
274 * @resume: Used to bring the device from the sleep mode.
275 * @ns_type: Callbacks so sysfs can detemine namespaces.
276 * @namespace: Namespace of the device belongs to this class.
277 * @pm: The default device power management operations of this class.
278 * @p: The private data of the driver core, no one other than the
279 * driver core can touch this.
281 * A class is a higher-level view of a device that abstracts out low-level
282 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
283 * at the class level, they are all simply disks. Classes allow user space
284 * to work with devices based on what they do, rather than how they are
285 * connected or how they work.
289 struct module
*owner
;
291 struct class_attribute
*class_attrs
;
292 struct device_attribute
*dev_attrs
;
293 struct bin_attribute
*dev_bin_attrs
;
294 struct kobject
*dev_kobj
;
296 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
297 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
299 void (*class_release
)(struct class *class);
300 void (*dev_release
)(struct device
*dev
);
302 int (*suspend
)(struct device
*dev
, pm_message_t state
);
303 int (*resume
)(struct device
*dev
);
305 const struct kobj_ns_type_operations
*ns_type
;
306 const void *(*namespace)(struct device
*dev
);
308 const struct dev_pm_ops
*pm
;
310 struct subsys_private
*p
;
313 struct class_dev_iter
{
314 struct klist_iter ki
;
315 const struct device_type
*type
;
318 extern struct kobject
*sysfs_dev_block_kobj
;
319 extern struct kobject
*sysfs_dev_char_kobj
;
320 extern int __must_check
__class_register(struct class *class,
321 struct lock_class_key
*key
);
322 extern void class_unregister(struct class *class);
324 /* This is a #define to keep the compiler from merging different
325 * instances of the __key variable */
326 #define class_register(class) \
328 static struct lock_class_key __key; \
329 __class_register(class, &__key); \
333 struct class_compat
*class_compat_register(const char *name
);
334 void class_compat_unregister(struct class_compat
*cls
);
335 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
336 struct device
*device_link
);
337 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
338 struct device
*device_link
);
340 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
342 struct device
*start
,
343 const struct device_type
*type
);
344 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
345 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
347 extern int class_for_each_device(struct class *class, struct device
*start
,
349 int (*fn
)(struct device
*dev
, void *data
));
350 extern struct device
*class_find_device(struct class *class,
351 struct device
*start
, void *data
,
352 int (*match
)(struct device
*, void *));
354 struct class_attribute
{
355 struct attribute attr
;
356 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
358 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
359 const char *buf
, size_t count
);
360 const void *(*namespace)(struct class *class,
361 const struct class_attribute
*attr
);
364 #define CLASS_ATTR(_name, _mode, _show, _store) \
365 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
367 extern int __must_check
class_create_file(struct class *class,
368 const struct class_attribute
*attr
);
369 extern void class_remove_file(struct class *class,
370 const struct class_attribute
*attr
);
372 /* Simple class attribute that is just a static string */
374 struct class_attribute_string
{
375 struct class_attribute attr
;
379 /* Currently read-only only */
380 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
381 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
382 #define CLASS_ATTR_STRING(_name, _mode, _str) \
383 struct class_attribute_string class_attr_##_name = \
384 _CLASS_ATTR_STRING(_name, _mode, _str)
386 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
389 struct class_interface
{
390 struct list_head node
;
393 int (*add_dev
) (struct device
*, struct class_interface
*);
394 void (*remove_dev
) (struct device
*, struct class_interface
*);
397 extern int __must_check
class_interface_register(struct class_interface
*);
398 extern void class_interface_unregister(struct class_interface
*);
400 extern struct class * __must_check
__class_create(struct module
*owner
,
402 struct lock_class_key
*key
);
403 extern void class_destroy(struct class *cls
);
405 /* This is a #define to keep the compiler from merging different
406 * instances of the __key variable */
407 #define class_create(owner, name) \
409 static struct lock_class_key __key; \
410 __class_create(owner, name, &__key); \
414 * The type of device, "struct device" is embedded in. A class
415 * or bus can contain devices of different types
416 * like "partitions" and "disks", "mouse" and "event".
417 * This identifies the device type and carries type-specific
418 * information, equivalent to the kobj_type of a kobject.
419 * If "name" is specified, the uevent will contain it in
420 * the DEVTYPE variable.
424 const struct attribute_group
**groups
;
425 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
426 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
427 void (*release
)(struct device
*dev
);
429 const struct dev_pm_ops
*pm
;
432 /* interface for exporting device attributes */
433 struct device_attribute
{
434 struct attribute attr
;
435 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
437 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
438 const char *buf
, size_t count
);
441 #define DEVICE_ATTR(_name, _mode, _show, _store) \
442 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
444 extern int __must_check
device_create_file(struct device
*device
,
445 const struct device_attribute
*entry
);
446 extern void device_remove_file(struct device
*dev
,
447 const struct device_attribute
*attr
);
448 extern int __must_check
device_create_bin_file(struct device
*dev
,
449 const struct bin_attribute
*attr
);
450 extern void device_remove_bin_file(struct device
*dev
,
451 const struct bin_attribute
*attr
);
452 extern int device_schedule_callback_owner(struct device
*dev
,
453 void (*func
)(struct device
*dev
), struct module
*owner
);
455 /* This is a macro to avoid include problems with THIS_MODULE */
456 #define device_schedule_callback(dev, func) \
457 device_schedule_callback_owner(dev, func, THIS_MODULE)
459 /* device resource management */
460 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
461 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
463 #ifdef CONFIG_DEBUG_DEVRES
464 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
466 #define devres_alloc(release, size, gfp) \
467 __devres_alloc(release, size, gfp, #release)
469 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
471 extern void devres_free(void *res
);
472 extern void devres_add(struct device
*dev
, void *res
);
473 extern void *devres_find(struct device
*dev
, dr_release_t release
,
474 dr_match_t match
, void *match_data
);
475 extern void *devres_get(struct device
*dev
, void *new_res
,
476 dr_match_t match
, void *match_data
);
477 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
478 dr_match_t match
, void *match_data
);
479 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
480 dr_match_t match
, void *match_data
);
483 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
485 extern void devres_close_group(struct device
*dev
, void *id
);
486 extern void devres_remove_group(struct device
*dev
, void *id
);
487 extern int devres_release_group(struct device
*dev
, void *id
);
489 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
490 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
491 extern void devm_kfree(struct device
*dev
, void *p
);
493 struct device_dma_parameters
{
495 * a low level driver may set these to teach IOMMU code about
498 unsigned int max_segment_size
;
499 unsigned long segment_boundary_mask
;
503 * struct device - The basic device structure
504 * @parent: The device's "parent" device, the device to which it is attached.
505 * In most cases, a parent device is some sort of bus or host
506 * controller. If parent is NULL, the device, is a top-level device,
507 * which is not usually what you want.
508 * @p: Holds the private data of the driver core portions of the device.
509 * See the comment of the struct device_private for detail.
510 * @kobj: A top-level, abstract class from which other classes are derived.
511 * @init_name: Initial name of the device.
512 * @type: The type of device.
513 * This identifies the device type and carries type-specific
515 * @mutex: Mutex to synchronize calls to its driver.
516 * @bus: Type of bus device is on.
517 * @driver: Which driver has allocated this
518 * @platform_data: Platform data specific to the device.
519 * Example: For devices on custom boards, as typical of embedded
520 * and SOC based hardware, Linux often uses platform_data to point
521 * to board-specific structures describing devices and how they
522 * are wired. That can include what ports are available, chip
523 * variants, which GPIO pins act in what additional roles, and so
524 * on. This shrinks the "Board Support Packages" (BSPs) and
525 * minimizes board-specific #ifdefs in drivers.
526 * @power: For device power management.
527 * See Documentation/power/devices.txt for details.
528 * @pm_domain: Provide callbacks that are executed during system suspend,
529 * hibernation, system resume and during runtime PM transitions
530 * along with subsystem-level and driver-level callbacks.
531 * @numa_node: NUMA node this device is close to.
532 * @dma_mask: Dma mask (if dma'ble device).
533 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
534 * hardware supports 64-bit addresses for consistent allocations
536 * @dma_parms: A low level driver may set these to teach IOMMU code about
537 * segment limitations.
538 * @dma_pools: Dma pools (if dma'ble device).
539 * @dma_mem: Internal for coherent mem override.
540 * @archdata: For arch-specific additions.
541 * @of_node: Associated device tree node.
542 * @devt: For creating the sysfs "dev".
543 * @devres_lock: Spinlock to protect the resource of the device.
544 * @devres_head: The resources list of the device.
545 * @knode_class: The node used to add the device to the class list.
546 * @class: The class of the device.
547 * @groups: Optional attribute groups.
548 * @release: Callback to free the device after all references have
549 * gone away. This should be set by the allocator of the
550 * device (i.e. the bus driver that discovered the device).
552 * At the lowest level, every device in a Linux system is represented by an
553 * instance of struct device. The device structure contains the information
554 * that the device model core needs to model the system. Most subsystems,
555 * however, track additional information about the devices they host. As a
556 * result, it is rare for devices to be represented by bare device structures;
557 * instead, that structure, like kobject structures, is usually embedded within
558 * a higher-level representation of the device.
561 struct device
*parent
;
563 struct device_private
*p
;
566 const char *init_name
; /* initial name of the device */
567 const struct device_type
*type
;
569 struct mutex mutex
; /* mutex to synchronize calls to
573 struct bus_type
*bus
; /* type of bus device is on */
574 struct device_driver
*driver
; /* which driver has allocated this
576 void *platform_data
; /* Platform specific data, device
577 core doesn't touch it */
578 struct dev_pm_info power
;
579 struct dev_pm_domain
*pm_domain
;
582 int numa_node
; /* NUMA node this device is close to */
584 u64
*dma_mask
; /* dma mask (if dma'able device) */
585 u64 coherent_dma_mask
;/* Like dma_mask, but for
586 alloc_coherent mappings as
587 not all hardware supports
588 64 bit addresses for consistent
589 allocations such descriptors. */
591 struct device_dma_parameters
*dma_parms
;
593 struct list_head dma_pools
; /* dma pools (if dma'ble) */
595 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
597 /* arch specific additions */
598 struct dev_archdata archdata
;
600 struct device_node
*of_node
; /* associated device tree node */
602 dev_t devt
; /* dev_t, creates the sysfs "dev" */
604 spinlock_t devres_lock
;
605 struct list_head devres_head
;
607 struct klist_node knode_class
;
609 const struct attribute_group
**groups
; /* optional groups */
611 void (*release
)(struct device
*dev
);
614 /* Get the wakeup routines, which depend on struct device */
615 #include <linux/pm_wakeup.h>
617 static inline const char *dev_name(const struct device
*dev
)
619 /* Use the init name until the kobject becomes available */
621 return dev
->init_name
;
623 return kobject_name(&dev
->kobj
);
626 extern __printf(2, 3)
627 int dev_set_name(struct device
*dev
, const char *name
, ...);
630 static inline int dev_to_node(struct device
*dev
)
632 return dev
->numa_node
;
634 static inline void set_dev_node(struct device
*dev
, int node
)
636 dev
->numa_node
= node
;
639 static inline int dev_to_node(struct device
*dev
)
643 static inline void set_dev_node(struct device
*dev
, int node
)
648 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
650 return dev
? dev
->power
.subsys_data
: NULL
;
653 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
655 return dev
->kobj
.uevent_suppress
;
658 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
660 dev
->kobj
.uevent_suppress
= val
;
663 static inline int device_is_registered(struct device
*dev
)
665 return dev
->kobj
.state_in_sysfs
;
668 static inline void device_enable_async_suspend(struct device
*dev
)
670 if (!dev
->power
.is_prepared
)
671 dev
->power
.async_suspend
= true;
674 static inline void device_disable_async_suspend(struct device
*dev
)
676 if (!dev
->power
.is_prepared
)
677 dev
->power
.async_suspend
= false;
680 static inline bool device_async_suspend_enabled(struct device
*dev
)
682 return !!dev
->power
.async_suspend
;
685 static inline void device_lock(struct device
*dev
)
687 mutex_lock(&dev
->mutex
);
690 static inline int device_trylock(struct device
*dev
)
692 return mutex_trylock(&dev
->mutex
);
695 static inline void device_unlock(struct device
*dev
)
697 mutex_unlock(&dev
->mutex
);
700 void driver_init(void);
703 * High level routines for use by the bus drivers
705 extern int __must_check
device_register(struct device
*dev
);
706 extern void device_unregister(struct device
*dev
);
707 extern void device_initialize(struct device
*dev
);
708 extern int __must_check
device_add(struct device
*dev
);
709 extern void device_del(struct device
*dev
);
710 extern int device_for_each_child(struct device
*dev
, void *data
,
711 int (*fn
)(struct device
*dev
, void *data
));
712 extern struct device
*device_find_child(struct device
*dev
, void *data
,
713 int (*match
)(struct device
*dev
, void *data
));
714 extern int device_rename(struct device
*dev
, const char *new_name
);
715 extern int device_move(struct device
*dev
, struct device
*new_parent
,
716 enum dpm_order dpm_order
);
717 extern const char *device_get_devnode(struct device
*dev
,
718 mode_t
*mode
, const char **tmp
);
719 extern void *dev_get_drvdata(const struct device
*dev
);
720 extern int dev_set_drvdata(struct device
*dev
, void *data
);
723 * Root device objects for grouping under /sys/devices
725 extern struct device
*__root_device_register(const char *name
,
726 struct module
*owner
);
729 * This is a macro to avoid include problems with THIS_MODULE,
730 * just as per what is done for device_schedule_callback() above.
732 #define root_device_register(name) \
733 __root_device_register(name, THIS_MODULE)
735 extern void root_device_unregister(struct device
*root
);
737 static inline void *dev_get_platdata(const struct device
*dev
)
739 return dev
->platform_data
;
743 * Manual binding of a device to driver. See drivers/base/bus.c
744 * for information on use.
746 extern int __must_check
device_bind_driver(struct device
*dev
);
747 extern void device_release_driver(struct device
*dev
);
748 extern int __must_check
device_attach(struct device
*dev
);
749 extern int __must_check
driver_attach(struct device_driver
*drv
);
750 extern int __must_check
device_reprobe(struct device
*dev
);
753 * Easy functions for dynamically creating devices on the fly
755 extern struct device
*device_create_vargs(struct class *cls
,
756 struct device
*parent
,
761 extern __printf(5, 6)
762 struct device
*device_create(struct class *cls
, struct device
*parent
,
763 dev_t devt
, void *drvdata
,
764 const char *fmt
, ...);
765 extern void device_destroy(struct class *cls
, dev_t devt
);
768 * Platform "fixup" functions - allow the platform to have their say
769 * about devices and actions that the general device layer doesn't
772 /* Notify platform of device discovery */
773 extern int (*platform_notify
)(struct device
*dev
);
775 extern int (*platform_notify_remove
)(struct device
*dev
);
779 * get_device - atomically increment the reference count for the device.
782 extern struct device
*get_device(struct device
*dev
);
783 extern void put_device(struct device
*dev
);
785 extern void wait_for_device_probe(void);
787 #ifdef CONFIG_DEVTMPFS
788 extern int devtmpfs_create_node(struct device
*dev
);
789 extern int devtmpfs_delete_node(struct device
*dev
);
790 extern int devtmpfs_mount(const char *mntdir
);
792 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
793 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
794 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
797 /* drivers/base/power/shutdown.c */
798 extern void device_shutdown(void);
800 /* debugging and troubleshooting/diagnostic helpers. */
801 extern const char *dev_driver_string(const struct device
*dev
);
806 extern int __dev_printk(const char *level
, const struct device
*dev
,
807 struct va_format
*vaf
);
808 extern __printf(3, 4)
809 int dev_printk(const char *level
, const struct device
*dev
,
810 const char *fmt
, ...)
812 extern __printf(2, 3)
813 int dev_emerg(const struct device
*dev
, const char *fmt
, ...);
814 extern __printf(2, 3)
815 int dev_alert(const struct device
*dev
, const char *fmt
, ...);
816 extern __printf(2, 3)
817 int dev_crit(const struct device
*dev
, const char *fmt
, ...);
818 extern __printf(2, 3)
819 int dev_err(const struct device
*dev
, const char *fmt
, ...);
820 extern __printf(2, 3)
821 int dev_warn(const struct device
*dev
, const char *fmt
, ...);
822 extern __printf(2, 3)
823 int dev_notice(const struct device
*dev
, const char *fmt
, ...);
824 extern __printf(2, 3)
825 int _dev_info(const struct device
*dev
, const char *fmt
, ...);
829 static inline int __dev_printk(const char *level
, const struct device
*dev
,
830 struct va_format
*vaf
)
832 static inline __printf(3, 4)
833 int dev_printk(const char *level
, const struct device
*dev
,
834 const char *fmt
, ...)
837 static inline __printf(2, 3)
838 int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
840 static inline __printf(2, 3)
841 int dev_crit(const struct device
*dev
, const char *fmt
, ...)
843 static inline __printf(2, 3)
844 int dev_alert(const struct device
*dev
, const char *fmt
, ...)
846 static inline __printf(2, 3)
847 int dev_err(const struct device
*dev
, const char *fmt
, ...)
849 static inline __printf(2, 3)
850 int dev_warn(const struct device
*dev
, const char *fmt
, ...)
852 static inline __printf(2, 3)
853 int dev_notice(const struct device
*dev
, const char *fmt
, ...)
855 static inline __printf(2, 3)
856 int _dev_info(const struct device
*dev
, const char *fmt
, ...)
862 * Stupid hackaround for existing uses of non-printk uses dev_info
864 * Note that the definition of dev_info below is actually _dev_info
865 * and a macro is used to avoid redefining dev_info
868 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
871 #define dev_dbg(dev, format, arg...) \
872 dev_printk(KERN_DEBUG, dev, format, ##arg)
873 #elif defined(CONFIG_DYNAMIC_DEBUG)
874 #define dev_dbg(dev, format, ...) \
876 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
879 #define dev_dbg(dev, format, arg...) \
882 dev_printk(KERN_DEBUG, dev, format, ##arg); \
888 #define dev_vdbg dev_dbg
890 #define dev_vdbg(dev, format, arg...) \
893 dev_printk(KERN_DEBUG, dev, format, ##arg); \
899 * dev_WARN*() acts like dev_printk(), but with the key difference
900 * of using a WARN/WARN_ON to get the message out, including the
901 * file/line information and a backtrace.
903 #define dev_WARN(dev, format, arg...) \
904 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
906 #define dev_WARN_ONCE(dev, condition, format, arg...) \
907 WARN_ONCE(condition, "Device %s\n" format, \
908 dev_driver_string(dev), ## arg)
910 /* Create alias, so I can be autoloaded. */
911 #define MODULE_ALIAS_CHARDEV(major,minor) \
912 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
913 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
914 MODULE_ALIAS("char-major-" __stringify(major) "-*")
916 #ifdef CONFIG_SYSFS_DEPRECATED
917 extern long sysfs_deprecated
;
919 #define sysfs_deprecated 0
922 #endif /* _DEVICE_H_ */