2 * device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
8 * This file is released under the GPLv2
10 * See Documentation/driver-model/ for more information.
16 #include <linux/ioport.h>
17 #include <linux/kobject.h>
18 #include <linux/klist.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/compiler.h>
22 #include <linux/types.h>
23 #include <linux/mutex.h>
24 #include <linux/pinctrl/devinfo.h>
26 #include <linux/atomic.h>
27 #include <linux/ratelimit.h>
28 #include <linux/uidgid.h>
29 #include <asm/device.h>
32 struct device_private
;
34 struct driver_private
;
37 struct subsys_private
;
43 struct bus_attribute
{
44 struct attribute attr
;
45 ssize_t (*show
)(struct bus_type
*bus
, char *buf
);
46 ssize_t (*store
)(struct bus_type
*bus
, const char *buf
, size_t count
);
49 #define BUS_ATTR(_name, _mode, _show, _store) \
50 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
52 extern int __must_check
bus_create_file(struct bus_type
*,
53 struct bus_attribute
*);
54 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
57 * struct bus_type - The bus type of the device
59 * @name: The name of the bus.
60 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
61 * @dev_root: Default device to use as the parent.
62 * @bus_attrs: Default attributes of the bus.
63 * @dev_attrs: Default attributes of the devices on the bus.
64 * @drv_attrs: Default attributes of the device drivers on the bus.
65 * @match: Called, perhaps multiple times, whenever a new device or driver
66 * is added for this bus. It should return a nonzero value if the
67 * given device can be handled by the given driver.
68 * @uevent: Called when a device is added, removed, or a few other things
69 * that generate uevents to add the environment variables.
70 * @probe: Called when a new device or driver add to this bus, and callback
71 * the specific driver's probe to initial the matched device.
72 * @remove: Called when a device removed from this bus.
73 * @shutdown: Called at shut-down time to quiesce the device.
74 * @suspend: Called when a device on this bus wants to go to sleep mode.
75 * @resume: Called to bring a device on this bus out of sleep mode.
76 * @pm: Power management operations of this bus, callback the specific
77 * device driver's pm-ops.
78 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
79 * driver implementations to a bus and allow the driver to do
81 * @p: The private data of the driver core, only the driver core can
84 * A bus is a channel between the processor and one or more devices. For the
85 * purposes of the device model, all devices are connected via a bus, even if
86 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
87 * A USB controller is usually a PCI device, for example. The device model
88 * represents the actual connections between buses and the devices they control.
89 * A bus is represented by the bus_type structure. It contains the name, the
90 * default attributes, the bus' methods, PM operations, and the driver core's
96 struct device
*dev_root
;
97 struct bus_attribute
*bus_attrs
;
98 struct device_attribute
*dev_attrs
;
99 struct driver_attribute
*drv_attrs
;
101 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
102 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
103 int (*probe
)(struct device
*dev
);
104 int (*remove
)(struct device
*dev
);
105 void (*shutdown
)(struct device
*dev
);
107 int (*suspend
)(struct device
*dev
, pm_message_t state
);
108 int (*resume
)(struct device
*dev
);
110 const struct dev_pm_ops
*pm
;
112 struct iommu_ops
*iommu_ops
;
114 struct subsys_private
*p
;
115 struct lock_class_key lock_key
;
118 extern int __must_check
bus_register(struct bus_type
*bus
);
120 extern void bus_unregister(struct bus_type
*bus
);
122 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
124 /* iterator helpers for buses */
125 struct subsys_dev_iter
{
126 struct klist_iter ki
;
127 const struct device_type
*type
;
129 void subsys_dev_iter_init(struct subsys_dev_iter
*iter
,
130 struct bus_type
*subsys
,
131 struct device
*start
,
132 const struct device_type
*type
);
133 struct device
*subsys_dev_iter_next(struct subsys_dev_iter
*iter
);
134 void subsys_dev_iter_exit(struct subsys_dev_iter
*iter
);
136 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
137 int (*fn
)(struct device
*dev
, void *data
));
138 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
140 int (*match
)(struct device
*dev
, void *data
));
141 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
142 struct device
*start
,
144 struct device
*subsys_find_device_by_id(struct bus_type
*bus
, unsigned int id
,
145 struct device
*hint
);
146 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
147 void *data
, int (*fn
)(struct device_driver
*, void *));
148 void bus_sort_breadthfirst(struct bus_type
*bus
,
149 int (*compare
)(const struct device
*a
,
150 const struct device
*b
));
152 * Bus notifiers: Get notified of addition/removal of devices
153 * and binding/unbinding of drivers to devices.
154 * In the long run, it should be a replacement for the platform
157 struct notifier_block
;
159 extern int bus_register_notifier(struct bus_type
*bus
,
160 struct notifier_block
*nb
);
161 extern int bus_unregister_notifier(struct bus_type
*bus
,
162 struct notifier_block
*nb
);
164 /* All 4 notifers below get called with the target struct device *
165 * as an argument. Note that those functions are likely to be called
166 * with the device lock held in the core, so be careful.
168 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
169 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
170 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
172 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
173 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
175 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
178 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
179 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
182 * struct device_driver - The basic device driver structure
183 * @name: Name of the device driver.
184 * @bus: The bus which the device of this driver belongs to.
185 * @owner: The module owner.
186 * @mod_name: Used for built-in modules.
187 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
188 * @of_match_table: The open firmware table.
189 * @acpi_match_table: The ACPI match table.
190 * @probe: Called to query the existence of a specific device,
191 * whether this driver can work with it, and bind the driver
192 * to a specific device.
193 * @remove: Called when the device is removed from the system to
194 * unbind a device from this driver.
195 * @shutdown: Called at shut-down time to quiesce the device.
196 * @suspend: Called to put the device to sleep mode. Usually to a
198 * @resume: Called to bring a device from sleep mode.
199 * @groups: Default attributes that get created by the driver core
201 * @pm: Power management operations of the device which matched
203 * @p: Driver core's private data, no one other than the driver
204 * core can touch this.
206 * The device driver-model tracks all of the drivers known to the system.
207 * The main reason for this tracking is to enable the driver core to match
208 * up drivers with new devices. Once drivers are known objects within the
209 * system, however, a number of other things become possible. Device drivers
210 * can export information and configuration variables that are independent
211 * of any specific device.
213 struct device_driver
{
215 struct bus_type
*bus
;
217 struct module
*owner
;
218 const char *mod_name
; /* used for built-in modules */
220 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
222 const struct of_device_id
*of_match_table
;
223 const struct acpi_device_id
*acpi_match_table
;
225 int (*probe
) (struct device
*dev
);
226 int (*remove
) (struct device
*dev
);
227 void (*shutdown
) (struct device
*dev
);
228 int (*suspend
) (struct device
*dev
, pm_message_t state
);
229 int (*resume
) (struct device
*dev
);
230 const struct attribute_group
**groups
;
232 const struct dev_pm_ops
*pm
;
234 struct driver_private
*p
;
238 extern int __must_check
driver_register(struct device_driver
*drv
);
239 extern void driver_unregister(struct device_driver
*drv
);
241 extern struct device_driver
*driver_find(const char *name
,
242 struct bus_type
*bus
);
243 extern int driver_probe_done(void);
244 extern void wait_for_device_probe(void);
247 /* sysfs interface for exporting driver attributes */
249 struct driver_attribute
{
250 struct attribute attr
;
251 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
252 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
256 #define DRIVER_ATTR(_name, _mode, _show, _store) \
257 struct driver_attribute driver_attr_##_name = \
258 __ATTR(_name, _mode, _show, _store)
260 extern int __must_check
driver_create_file(struct device_driver
*driver
,
261 const struct driver_attribute
*attr
);
262 extern void driver_remove_file(struct device_driver
*driver
,
263 const struct driver_attribute
*attr
);
265 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
266 struct device
*start
,
268 int (*fn
)(struct device
*dev
,
270 struct device
*driver_find_device(struct device_driver
*drv
,
271 struct device
*start
, void *data
,
272 int (*match
)(struct device
*dev
, void *data
));
275 * struct subsys_interface - interfaces to device functions
276 * @name: name of the device function
277 * @subsys: subsytem of the devices to attach to
278 * @node: the list of functions registered at the subsystem
279 * @add_dev: device hookup to device function handler
280 * @remove_dev: device hookup to device function handler
282 * Simple interfaces attached to a subsystem. Multiple interfaces can
283 * attach to a subsystem and its devices. Unlike drivers, they do not
284 * exclusively claim or control devices. Interfaces usually represent
285 * a specific functionality of a subsystem/class of devices.
287 struct subsys_interface
{
289 struct bus_type
*subsys
;
290 struct list_head node
;
291 int (*add_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
292 int (*remove_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
295 int subsys_interface_register(struct subsys_interface
*sif
);
296 void subsys_interface_unregister(struct subsys_interface
*sif
);
298 int subsys_system_register(struct bus_type
*subsys
,
299 const struct attribute_group
**groups
);
302 * struct class - device classes
303 * @name: Name of the class.
304 * @owner: The module owner.
305 * @class_attrs: Default attributes of this class.
306 * @dev_attrs: Default attributes of the devices belong to the class.
307 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
308 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
309 * @dev_uevent: Called when a device is added, removed from this class, or a
310 * few other things that generate uevents to add the environment
312 * @devnode: Callback to provide the devtmpfs.
313 * @class_release: Called to release this class.
314 * @dev_release: Called to release the device.
315 * @suspend: Used to put the device to sleep mode, usually to a low power
317 * @resume: Used to bring the device from the sleep mode.
318 * @ns_type: Callbacks so sysfs can detemine namespaces.
319 * @namespace: Namespace of the device belongs to this class.
320 * @pm: The default device power management operations of this class.
321 * @p: The private data of the driver core, no one other than the
322 * driver core can touch this.
324 * A class is a higher-level view of a device that abstracts out low-level
325 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
326 * at the class level, they are all simply disks. Classes allow user space
327 * to work with devices based on what they do, rather than how they are
328 * connected or how they work.
332 struct module
*owner
;
334 struct class_attribute
*class_attrs
;
335 struct device_attribute
*dev_attrs
;
336 struct bin_attribute
*dev_bin_attrs
;
337 struct kobject
*dev_kobj
;
339 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
340 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
342 void (*class_release
)(struct class *class);
343 void (*dev_release
)(struct device
*dev
);
345 int (*suspend
)(struct device
*dev
, pm_message_t state
);
346 int (*resume
)(struct device
*dev
);
348 const struct kobj_ns_type_operations
*ns_type
;
349 const void *(*namespace)(struct device
*dev
);
351 const struct dev_pm_ops
*pm
;
353 struct subsys_private
*p
;
356 struct class_dev_iter
{
357 struct klist_iter ki
;
358 const struct device_type
*type
;
361 extern struct kobject
*sysfs_dev_block_kobj
;
362 extern struct kobject
*sysfs_dev_char_kobj
;
363 extern int __must_check
__class_register(struct class *class,
364 struct lock_class_key
*key
);
365 extern void class_unregister(struct class *class);
367 /* This is a #define to keep the compiler from merging different
368 * instances of the __key variable */
369 #define class_register(class) \
371 static struct lock_class_key __key; \
372 __class_register(class, &__key); \
376 struct class_compat
*class_compat_register(const char *name
);
377 void class_compat_unregister(struct class_compat
*cls
);
378 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
379 struct device
*device_link
);
380 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
381 struct device
*device_link
);
383 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
385 struct device
*start
,
386 const struct device_type
*type
);
387 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
388 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
390 extern int class_for_each_device(struct class *class, struct device
*start
,
392 int (*fn
)(struct device
*dev
, void *data
));
393 extern struct device
*class_find_device(struct class *class,
394 struct device
*start
, const void *data
,
395 int (*match
)(struct device
*, const void *));
397 struct class_attribute
{
398 struct attribute attr
;
399 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
401 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
402 const char *buf
, size_t count
);
403 const void *(*namespace)(struct class *class,
404 const struct class_attribute
*attr
);
407 #define CLASS_ATTR(_name, _mode, _show, _store) \
408 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
410 extern int __must_check
class_create_file(struct class *class,
411 const struct class_attribute
*attr
);
412 extern void class_remove_file(struct class *class,
413 const struct class_attribute
*attr
);
415 /* Simple class attribute that is just a static string */
417 struct class_attribute_string
{
418 struct class_attribute attr
;
422 /* Currently read-only only */
423 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
424 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
425 #define CLASS_ATTR_STRING(_name, _mode, _str) \
426 struct class_attribute_string class_attr_##_name = \
427 _CLASS_ATTR_STRING(_name, _mode, _str)
429 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
432 struct class_interface
{
433 struct list_head node
;
436 int (*add_dev
) (struct device
*, struct class_interface
*);
437 void (*remove_dev
) (struct device
*, struct class_interface
*);
440 extern int __must_check
class_interface_register(struct class_interface
*);
441 extern void class_interface_unregister(struct class_interface
*);
443 extern struct class * __must_check
__class_create(struct module
*owner
,
445 struct lock_class_key
*key
);
446 extern void class_destroy(struct class *cls
);
448 /* This is a #define to keep the compiler from merging different
449 * instances of the __key variable */
450 #define class_create(owner, name) \
452 static struct lock_class_key __key; \
453 __class_create(owner, name, &__key); \
457 * The type of device, "struct device" is embedded in. A class
458 * or bus can contain devices of different types
459 * like "partitions" and "disks", "mouse" and "event".
460 * This identifies the device type and carries type-specific
461 * information, equivalent to the kobj_type of a kobject.
462 * If "name" is specified, the uevent will contain it in
463 * the DEVTYPE variable.
467 const struct attribute_group
**groups
;
468 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
469 char *(*devnode
)(struct device
*dev
, umode_t
*mode
,
470 uid_t
*uid
, gid_t
*gid
);
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
);
498 ssize_t
device_show_bool(struct device
*dev
, struct device_attribute
*attr
,
500 ssize_t
device_store_bool(struct device
*dev
, struct device_attribute
*attr
,
501 const char *buf
, size_t count
);
503 #define DEVICE_ATTR(_name, _mode, _show, _store) \
504 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
505 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
506 struct dev_ext_attribute dev_attr_##_name = \
507 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
508 #define DEVICE_INT_ATTR(_name, _mode, _var) \
509 struct dev_ext_attribute dev_attr_##_name = \
510 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
511 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
512 struct dev_ext_attribute dev_attr_##_name = \
513 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
514 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
515 struct device_attribute dev_attr_##_name = \
516 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
518 extern int device_create_file(struct device
*device
,
519 const struct device_attribute
*entry
);
520 extern void device_remove_file(struct device
*dev
,
521 const struct device_attribute
*attr
);
522 extern int __must_check
device_create_bin_file(struct device
*dev
,
523 const struct bin_attribute
*attr
);
524 extern void device_remove_bin_file(struct device
*dev
,
525 const struct bin_attribute
*attr
);
526 extern int device_schedule_callback_owner(struct device
*dev
,
527 void (*func
)(struct device
*dev
), struct module
*owner
);
529 /* This is a macro to avoid include problems with THIS_MODULE */
530 #define device_schedule_callback(dev, func) \
531 device_schedule_callback_owner(dev, func, THIS_MODULE)
533 /* device resource management */
534 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
535 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
537 #ifdef CONFIG_DEBUG_DEVRES
538 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
540 #define devres_alloc(release, size, gfp) \
541 __devres_alloc(release, size, gfp, #release)
543 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
545 extern void devres_for_each_res(struct device
*dev
, dr_release_t release
,
546 dr_match_t match
, void *match_data
,
547 void (*fn
)(struct device
*, void *, void *),
549 extern void devres_free(void *res
);
550 extern void devres_add(struct device
*dev
, void *res
);
551 extern void *devres_find(struct device
*dev
, dr_release_t release
,
552 dr_match_t match
, void *match_data
);
553 extern void *devres_get(struct device
*dev
, void *new_res
,
554 dr_match_t match
, void *match_data
);
555 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
556 dr_match_t match
, void *match_data
);
557 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
558 dr_match_t match
, void *match_data
);
559 extern int devres_release(struct device
*dev
, dr_release_t release
,
560 dr_match_t match
, void *match_data
);
563 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
565 extern void devres_close_group(struct device
*dev
, void *id
);
566 extern void devres_remove_group(struct device
*dev
, void *id
);
567 extern int devres_release_group(struct device
*dev
, void *id
);
569 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
570 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
571 extern void devm_kfree(struct device
*dev
, void *p
);
573 void __iomem
*devm_ioremap_resource(struct device
*dev
, struct resource
*res
);
574 void __iomem
*devm_request_and_ioremap(struct device
*dev
,
575 struct resource
*res
);
577 struct device_dma_parameters
{
579 * a low level driver may set these to teach IOMMU code about
582 unsigned int max_segment_size
;
583 unsigned long segment_boundary_mask
;
586 struct acpi_dev_node
{
593 * struct device - The basic device structure
594 * @parent: The device's "parent" device, the device to which it is attached.
595 * In most cases, a parent device is some sort of bus or host
596 * controller. If parent is NULL, the device, is a top-level device,
597 * which is not usually what you want.
598 * @p: Holds the private data of the driver core portions of the device.
599 * See the comment of the struct device_private for detail.
600 * @kobj: A top-level, abstract class from which other classes are derived.
601 * @init_name: Initial name of the device.
602 * @type: The type of device.
603 * This identifies the device type and carries type-specific
605 * @mutex: Mutex to synchronize calls to its driver.
606 * @bus: Type of bus device is on.
607 * @driver: Which driver has allocated this
608 * @platform_data: Platform data specific to the device.
609 * Example: For devices on custom boards, as typical of embedded
610 * and SOC based hardware, Linux often uses platform_data to point
611 * to board-specific structures describing devices and how they
612 * are wired. That can include what ports are available, chip
613 * variants, which GPIO pins act in what additional roles, and so
614 * on. This shrinks the "Board Support Packages" (BSPs) and
615 * minimizes board-specific #ifdefs in drivers.
616 * @power: For device power management.
617 * See Documentation/power/devices.txt for details.
618 * @pm_domain: Provide callbacks that are executed during system suspend,
619 * hibernation, system resume and during runtime PM transitions
620 * along with subsystem-level and driver-level callbacks.
621 * @pins: For device pin management.
622 * See Documentation/pinctrl.txt for details.
623 * @numa_node: NUMA node this device is close to.
624 * @dma_mask: Dma mask (if dma'ble device).
625 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
626 * hardware supports 64-bit addresses for consistent allocations
628 * @dma_parms: A low level driver may set these to teach IOMMU code about
629 * segment limitations.
630 * @dma_pools: Dma pools (if dma'ble device).
631 * @dma_mem: Internal for coherent mem override.
632 * @archdata: For arch-specific additions.
633 * @of_node: Associated device tree node.
634 * @acpi_node: Associated ACPI device node.
635 * @devt: For creating the sysfs "dev".
636 * @id: device instance
637 * @devres_lock: Spinlock to protect the resource of the device.
638 * @devres_head: The resources list of the device.
639 * @knode_class: The node used to add the device to the class list.
640 * @class: The class of the device.
641 * @groups: Optional attribute groups.
642 * @release: Callback to free the device after all references have
643 * gone away. This should be set by the allocator of the
644 * device (i.e. the bus driver that discovered the device).
646 * At the lowest level, every device in a Linux system is represented by an
647 * instance of struct device. The device structure contains the information
648 * that the device model core needs to model the system. Most subsystems,
649 * however, track additional information about the devices they host. As a
650 * result, it is rare for devices to be represented by bare device structures;
651 * instead, that structure, like kobject structures, is usually embedded within
652 * a higher-level representation of the device.
655 struct device
*parent
;
657 struct device_private
*p
;
660 const char *init_name
; /* initial name of the device */
661 const struct device_type
*type
;
663 struct mutex mutex
; /* mutex to synchronize calls to
667 struct bus_type
*bus
; /* type of bus device is on */
668 struct device_driver
*driver
; /* which driver has allocated this
670 void *platform_data
; /* Platform specific data, device
671 core doesn't touch it */
672 struct dev_pm_info power
;
673 struct dev_pm_domain
*pm_domain
;
675 #ifdef CONFIG_PINCTRL
676 struct dev_pin_info
*pins
;
680 int numa_node
; /* NUMA node this device is close to */
682 u64
*dma_mask
; /* dma mask (if dma'able device) */
683 u64 coherent_dma_mask
;/* Like dma_mask, but for
684 alloc_coherent mappings as
685 not all hardware supports
686 64 bit addresses for consistent
687 allocations such descriptors. */
689 struct device_dma_parameters
*dma_parms
;
691 struct list_head dma_pools
; /* dma pools (if dma'ble) */
693 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
696 struct cma
*cma_area
; /* contiguous memory area for dma
699 /* arch specific additions */
700 struct dev_archdata archdata
;
702 struct device_node
*of_node
; /* associated device tree node */
703 struct acpi_dev_node acpi_node
; /* associated ACPI device node */
705 dev_t devt
; /* dev_t, creates the sysfs "dev" */
706 u32 id
; /* device instance */
708 spinlock_t devres_lock
;
709 struct list_head devres_head
;
711 struct klist_node knode_class
;
713 const struct attribute_group
**groups
; /* optional groups */
715 void (*release
)(struct device
*dev
);
716 struct iommu_group
*iommu_group
;
719 static inline struct device
*kobj_to_dev(struct kobject
*kobj
)
721 return container_of(kobj
, struct device
, kobj
);
725 #define ACPI_HANDLE(dev) ((dev)->acpi_node.handle)
726 #define ACPI_HANDLE_SET(dev, _handle_) (dev)->acpi_node.handle = (_handle_)
728 #define ACPI_HANDLE(dev) (NULL)
729 #define ACPI_HANDLE_SET(dev, _handle_) do { } while (0)
732 /* Get the wakeup routines, which depend on struct device */
733 #include <linux/pm_wakeup.h>
735 static inline const char *dev_name(const struct device
*dev
)
737 /* Use the init name until the kobject becomes available */
739 return dev
->init_name
;
741 return kobject_name(&dev
->kobj
);
744 extern __printf(2, 3)
745 int dev_set_name(struct device
*dev
, const char *name
, ...);
748 static inline int dev_to_node(struct device
*dev
)
750 return dev
->numa_node
;
752 static inline void set_dev_node(struct device
*dev
, int node
)
754 dev
->numa_node
= node
;
757 static inline int dev_to_node(struct device
*dev
)
761 static inline void set_dev_node(struct device
*dev
, int node
)
766 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
768 return dev
? dev
->power
.subsys_data
: NULL
;
771 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
773 return dev
->kobj
.uevent_suppress
;
776 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
778 dev
->kobj
.uevent_suppress
= val
;
781 static inline int device_is_registered(struct device
*dev
)
783 return dev
->kobj
.state_in_sysfs
;
786 static inline void device_enable_async_suspend(struct device
*dev
)
788 if (!dev
->power
.is_prepared
)
789 dev
->power
.async_suspend
= true;
792 static inline void device_disable_async_suspend(struct device
*dev
)
794 if (!dev
->power
.is_prepared
)
795 dev
->power
.async_suspend
= false;
798 static inline bool device_async_suspend_enabled(struct device
*dev
)
800 return !!dev
->power
.async_suspend
;
803 static inline void pm_suspend_ignore_children(struct device
*dev
, bool enable
)
805 dev
->power
.ignore_children
= enable
;
808 static inline void dev_pm_syscore_device(struct device
*dev
, bool val
)
810 #ifdef CONFIG_PM_SLEEP
811 dev
->power
.syscore
= val
;
815 static inline void device_lock(struct device
*dev
)
817 mutex_lock(&dev
->mutex
);
820 static inline int device_trylock(struct device
*dev
)
822 return mutex_trylock(&dev
->mutex
);
825 static inline void device_unlock(struct device
*dev
)
827 mutex_unlock(&dev
->mutex
);
830 void driver_init(void);
833 * High level routines for use by the bus drivers
835 extern int __must_check
device_register(struct device
*dev
);
836 extern void device_unregister(struct device
*dev
);
837 extern void device_initialize(struct device
*dev
);
838 extern int __must_check
device_add(struct device
*dev
);
839 extern void device_del(struct device
*dev
);
840 extern int device_for_each_child(struct device
*dev
, void *data
,
841 int (*fn
)(struct device
*dev
, void *data
));
842 extern struct device
*device_find_child(struct device
*dev
, void *data
,
843 int (*match
)(struct device
*dev
, void *data
));
844 extern int device_rename(struct device
*dev
, const char *new_name
);
845 extern int device_move(struct device
*dev
, struct device
*new_parent
,
846 enum dpm_order dpm_order
);
847 extern const char *device_get_devnode(struct device
*dev
,
848 umode_t
*mode
, uid_t
*uid
, gid_t
*gid
,
850 extern void *dev_get_drvdata(const struct device
*dev
);
851 extern int dev_set_drvdata(struct device
*dev
, void *data
);
854 * Root device objects for grouping under /sys/devices
856 extern struct device
*__root_device_register(const char *name
,
857 struct module
*owner
);
860 * This is a macro to avoid include problems with THIS_MODULE,
861 * just as per what is done for device_schedule_callback() above.
863 #define root_device_register(name) \
864 __root_device_register(name, THIS_MODULE)
866 extern void root_device_unregister(struct device
*root
);
868 static inline void *dev_get_platdata(const struct device
*dev
)
870 return dev
->platform_data
;
874 * Manual binding of a device to driver. See drivers/base/bus.c
875 * for information on use.
877 extern int __must_check
device_bind_driver(struct device
*dev
);
878 extern void device_release_driver(struct device
*dev
);
879 extern int __must_check
device_attach(struct device
*dev
);
880 extern int __must_check
driver_attach(struct device_driver
*drv
);
881 extern int __must_check
device_reprobe(struct device
*dev
);
884 * Easy functions for dynamically creating devices on the fly
886 extern struct device
*device_create_vargs(struct class *cls
,
887 struct device
*parent
,
892 extern __printf(5, 6)
893 struct device
*device_create(struct class *cls
, struct device
*parent
,
894 dev_t devt
, void *drvdata
,
895 const char *fmt
, ...);
896 extern void device_destroy(struct class *cls
, dev_t devt
);
899 * Platform "fixup" functions - allow the platform to have their say
900 * about devices and actions that the general device layer doesn't
903 /* Notify platform of device discovery */
904 extern int (*platform_notify
)(struct device
*dev
);
906 extern int (*platform_notify_remove
)(struct device
*dev
);
910 * get_device - atomically increment the reference count for the device.
913 extern struct device
*get_device(struct device
*dev
);
914 extern void put_device(struct device
*dev
);
916 #ifdef CONFIG_DEVTMPFS
917 extern int devtmpfs_create_node(struct device
*dev
);
918 extern int devtmpfs_delete_node(struct device
*dev
);
919 extern int devtmpfs_mount(const char *mntdir
);
921 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
922 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
923 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
926 /* drivers/base/power/shutdown.c */
927 extern void device_shutdown(void);
929 /* debugging and troubleshooting/diagnostic helpers. */
930 extern const char *dev_driver_string(const struct device
*dev
);
935 extern __printf(3, 0)
936 int dev_vprintk_emit(int level
, const struct device
*dev
,
937 const char *fmt
, va_list args
);
938 extern __printf(3, 4)
939 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...);
941 extern __printf(3, 4)
942 int dev_printk(const char *level
, const struct device
*dev
,
943 const char *fmt
, ...);
944 extern __printf(2, 3)
945 int dev_emerg(const struct device
*dev
, const char *fmt
, ...);
946 extern __printf(2, 3)
947 int dev_alert(const struct device
*dev
, const char *fmt
, ...);
948 extern __printf(2, 3)
949 int dev_crit(const struct device
*dev
, const char *fmt
, ...);
950 extern __printf(2, 3)
951 int dev_err(const struct device
*dev
, const char *fmt
, ...);
952 extern __printf(2, 3)
953 int dev_warn(const struct device
*dev
, const char *fmt
, ...);
954 extern __printf(2, 3)
955 int dev_notice(const struct device
*dev
, const char *fmt
, ...);
956 extern __printf(2, 3)
957 int _dev_info(const struct device
*dev
, const char *fmt
, ...);
961 static inline __printf(3, 0)
962 int dev_vprintk_emit(int level
, const struct device
*dev
,
963 const char *fmt
, va_list args
)
965 static inline __printf(3, 4)
966 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...)
969 static inline int __dev_printk(const char *level
, const struct device
*dev
,
970 struct va_format
*vaf
)
972 static inline __printf(3, 4)
973 int dev_printk(const char *level
, const struct device
*dev
,
974 const char *fmt
, ...)
977 static inline __printf(2, 3)
978 int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
980 static inline __printf(2, 3)
981 int dev_crit(const struct device
*dev
, const char *fmt
, ...)
983 static inline __printf(2, 3)
984 int dev_alert(const struct device
*dev
, const char *fmt
, ...)
986 static inline __printf(2, 3)
987 int dev_err(const struct device
*dev
, const char *fmt
, ...)
989 static inline __printf(2, 3)
990 int dev_warn(const struct device
*dev
, const char *fmt
, ...)
992 static inline __printf(2, 3)
993 int dev_notice(const struct device
*dev
, const char *fmt
, ...)
995 static inline __printf(2, 3)
996 int _dev_info(const struct device
*dev
, const char *fmt
, ...)
1002 * Stupid hackaround for existing uses of non-printk uses dev_info
1004 * Note that the definition of dev_info below is actually _dev_info
1005 * and a macro is used to avoid redefining dev_info
1008 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1010 #if defined(CONFIG_DYNAMIC_DEBUG)
1011 #define dev_dbg(dev, format, ...) \
1013 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1015 #elif defined(DEBUG)
1016 #define dev_dbg(dev, format, arg...) \
1017 dev_printk(KERN_DEBUG, dev, format, ##arg)
1019 #define dev_dbg(dev, format, arg...) \
1022 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1027 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1029 static DEFINE_RATELIMIT_STATE(_rs, \
1030 DEFAULT_RATELIMIT_INTERVAL, \
1031 DEFAULT_RATELIMIT_BURST); \
1032 if (__ratelimit(&_rs)) \
1033 dev_level(dev, fmt, ##__VA_ARGS__); \
1036 #define dev_emerg_ratelimited(dev, fmt, ...) \
1037 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1038 #define dev_alert_ratelimited(dev, fmt, ...) \
1039 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1040 #define dev_crit_ratelimited(dev, fmt, ...) \
1041 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1042 #define dev_err_ratelimited(dev, fmt, ...) \
1043 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1044 #define dev_warn_ratelimited(dev, fmt, ...) \
1045 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1046 #define dev_notice_ratelimited(dev, fmt, ...) \
1047 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1048 #define dev_info_ratelimited(dev, fmt, ...) \
1049 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1050 #if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
1051 #define dev_dbg_ratelimited(dev, fmt, ...) \
1053 static DEFINE_RATELIMIT_STATE(_rs, \
1054 DEFAULT_RATELIMIT_INTERVAL, \
1055 DEFAULT_RATELIMIT_BURST); \
1056 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1057 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1058 __ratelimit(&_rs)) \
1059 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
1063 #define dev_dbg_ratelimited(dev, fmt, ...) \
1064 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1067 #ifdef VERBOSE_DEBUG
1068 #define dev_vdbg dev_dbg
1070 #define dev_vdbg(dev, format, arg...) \
1073 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1079 * dev_WARN*() acts like dev_printk(), but with the key difference
1080 * of using a WARN/WARN_ON to get the message out, including the
1081 * file/line information and a backtrace.
1083 #define dev_WARN(dev, format, arg...) \
1084 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1086 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1087 WARN_ONCE(condition, "Device %s\n" format, \
1088 dev_driver_string(dev), ## arg)
1090 /* Create alias, so I can be autoloaded. */
1091 #define MODULE_ALIAS_CHARDEV(major,minor) \
1092 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1093 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1094 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1096 #ifdef CONFIG_SYSFS_DEPRECATED
1097 extern long sysfs_deprecated
;
1099 #define sysfs_deprecated 0
1103 * module_driver() - Helper macro for drivers that don't do anything
1104 * special in module init/exit. This eliminates a lot of boilerplate.
1105 * Each module may only use this macro once, and calling it replaces
1106 * module_init() and module_exit().
1108 * @__driver: driver name
1109 * @__register: register function for this driver type
1110 * @__unregister: unregister function for this driver type
1111 * @...: Additional arguments to be passed to __register and __unregister.
1113 * Use this macro to construct bus specific macros for registering
1114 * drivers, and do not use it on its own.
1116 #define module_driver(__driver, __register, __unregister, ...) \
1117 static int __init __driver##_init(void) \
1119 return __register(&(__driver) , ##__VA_ARGS__); \
1121 module_init(__driver##_init); \
1122 static void __exit __driver##_exit(void) \
1124 __unregister(&(__driver) , ##__VA_ARGS__); \
1126 module_exit(__driver##_exit);
1128 #endif /* _DEVICE_H_ */
This page took 0.073149 seconds and 5 git commands to generate.