]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/device.h
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)
51 #define BUS_ATTR_RW(_name) \
52 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
53 #define BUS_ATTR_RO(_name) \
54 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
56 extern int __must_check
bus_create_file(struct bus_type
*,
57 struct bus_attribute
*);
58 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
61 * struct bus_type - The bus type of the device
63 * @name: The name of the bus.
64 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
65 * @dev_root: Default device to use as the parent.
66 * @bus_attrs: Default attributes of the bus.
67 * @dev_attrs: Default attributes of the devices on the bus.
68 * @drv_attrs: Default attributes of the device drivers on the bus.
69 * @match: Called, perhaps multiple times, whenever a new device or driver
70 * is added for this bus. It should return a nonzero value if the
71 * given device can be handled by the given driver.
72 * @uevent: Called when a device is added, removed, or a few other things
73 * that generate uevents to add the environment variables.
74 * @probe: Called when a new device or driver add to this bus, and callback
75 * the specific driver's probe to initial the matched device.
76 * @remove: Called when a device removed from this bus.
77 * @shutdown: Called at shut-down time to quiesce the device.
79 * @online: Called to put the device back online (after offlining it).
80 * @offline: Called to put the device offline for hot-removal. May fail.
82 * @suspend: Called when a device on this bus wants to go to sleep mode.
83 * @resume: Called to bring a device on this bus out of sleep mode.
84 * @pm: Power management operations of this bus, callback the specific
85 * device driver's pm-ops.
86 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
87 * driver implementations to a bus and allow the driver to do
89 * @p: The private data of the driver core, only the driver core can
91 * @lock_key: Lock class key for use by the lock validator
93 * A bus is a channel between the processor and one or more devices. For the
94 * purposes of the device model, all devices are connected via a bus, even if
95 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
96 * A USB controller is usually a PCI device, for example. The device model
97 * represents the actual connections between buses and the devices they control.
98 * A bus is represented by the bus_type structure. It contains the name, the
99 * default attributes, the bus' methods, PM operations, and the driver core's
104 const char *dev_name
;
105 struct device
*dev_root
;
106 struct bus_attribute
*bus_attrs
;
107 struct device_attribute
*dev_attrs
;
108 struct driver_attribute
*drv_attrs
;
110 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
111 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
112 int (*probe
)(struct device
*dev
);
113 int (*remove
)(struct device
*dev
);
114 void (*shutdown
)(struct device
*dev
);
116 int (*online
)(struct device
*dev
);
117 int (*offline
)(struct device
*dev
);
119 int (*suspend
)(struct device
*dev
, pm_message_t state
);
120 int (*resume
)(struct device
*dev
);
122 const struct dev_pm_ops
*pm
;
124 struct iommu_ops
*iommu_ops
;
126 struct subsys_private
*p
;
127 struct lock_class_key lock_key
;
130 extern int __must_check
bus_register(struct bus_type
*bus
);
132 extern void bus_unregister(struct bus_type
*bus
);
134 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
136 /* iterator helpers for buses */
137 struct subsys_dev_iter
{
138 struct klist_iter ki
;
139 const struct device_type
*type
;
141 void subsys_dev_iter_init(struct subsys_dev_iter
*iter
,
142 struct bus_type
*subsys
,
143 struct device
*start
,
144 const struct device_type
*type
);
145 struct device
*subsys_dev_iter_next(struct subsys_dev_iter
*iter
);
146 void subsys_dev_iter_exit(struct subsys_dev_iter
*iter
);
148 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
149 int (*fn
)(struct device
*dev
, void *data
));
150 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
152 int (*match
)(struct device
*dev
, void *data
));
153 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
154 struct device
*start
,
156 struct device
*subsys_find_device_by_id(struct bus_type
*bus
, unsigned int id
,
157 struct device
*hint
);
158 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
159 void *data
, int (*fn
)(struct device_driver
*, void *));
160 void bus_sort_breadthfirst(struct bus_type
*bus
,
161 int (*compare
)(const struct device
*a
,
162 const struct device
*b
));
164 * Bus notifiers: Get notified of addition/removal of devices
165 * and binding/unbinding of drivers to devices.
166 * In the long run, it should be a replacement for the platform
169 struct notifier_block
;
171 extern int bus_register_notifier(struct bus_type
*bus
,
172 struct notifier_block
*nb
);
173 extern int bus_unregister_notifier(struct bus_type
*bus
,
174 struct notifier_block
*nb
);
176 /* All 4 notifers below get called with the target struct device *
177 * as an argument. Note that those functions are likely to be called
178 * with the device lock held in the core, so be careful.
180 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
181 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
182 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
184 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
185 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
187 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
190 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
191 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
194 * struct device_driver - The basic device driver structure
195 * @name: Name of the device driver.
196 * @bus: The bus which the device of this driver belongs to.
197 * @owner: The module owner.
198 * @mod_name: Used for built-in modules.
199 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
200 * @of_match_table: The open firmware table.
201 * @acpi_match_table: The ACPI match table.
202 * @probe: Called to query the existence of a specific device,
203 * whether this driver can work with it, and bind the driver
204 * to a specific device.
205 * @remove: Called when the device is removed from the system to
206 * unbind a device from this driver.
207 * @shutdown: Called at shut-down time to quiesce the device.
208 * @suspend: Called to put the device to sleep mode. Usually to a
210 * @resume: Called to bring a device from sleep mode.
211 * @groups: Default attributes that get created by the driver core
213 * @pm: Power management operations of the device which matched
215 * @p: Driver core's private data, no one other than the driver
216 * core can touch this.
218 * The device driver-model tracks all of the drivers known to the system.
219 * The main reason for this tracking is to enable the driver core to match
220 * up drivers with new devices. Once drivers are known objects within the
221 * system, however, a number of other things become possible. Device drivers
222 * can export information and configuration variables that are independent
223 * of any specific device.
225 struct device_driver
{
227 struct bus_type
*bus
;
229 struct module
*owner
;
230 const char *mod_name
; /* used for built-in modules */
232 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
234 const struct of_device_id
*of_match_table
;
235 const struct acpi_device_id
*acpi_match_table
;
237 int (*probe
) (struct device
*dev
);
238 int (*remove
) (struct device
*dev
);
239 void (*shutdown
) (struct device
*dev
);
240 int (*suspend
) (struct device
*dev
, pm_message_t state
);
241 int (*resume
) (struct device
*dev
);
242 const struct attribute_group
**groups
;
244 const struct dev_pm_ops
*pm
;
246 struct driver_private
*p
;
250 extern int __must_check
driver_register(struct device_driver
*drv
);
251 extern void driver_unregister(struct device_driver
*drv
);
253 extern struct device_driver
*driver_find(const char *name
,
254 struct bus_type
*bus
);
255 extern int driver_probe_done(void);
256 extern void wait_for_device_probe(void);
259 /* sysfs interface for exporting driver attributes */
261 struct driver_attribute
{
262 struct attribute attr
;
263 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
264 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
268 #define DRIVER_ATTR(_name, _mode, _show, _store) \
269 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
270 #define DRIVER_ATTR_RW(_name) \
271 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
272 #define DRIVER_ATTR_RO(_name) \
273 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
275 extern int __must_check
driver_create_file(struct device_driver
*driver
,
276 const struct driver_attribute
*attr
);
277 extern void driver_remove_file(struct device_driver
*driver
,
278 const struct driver_attribute
*attr
);
280 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
281 struct device
*start
,
283 int (*fn
)(struct device
*dev
,
285 struct device
*driver_find_device(struct device_driver
*drv
,
286 struct device
*start
, void *data
,
287 int (*match
)(struct device
*dev
, void *data
));
290 * struct subsys_interface - interfaces to device functions
291 * @name: name of the device function
292 * @subsys: subsytem of the devices to attach to
293 * @node: the list of functions registered at the subsystem
294 * @add_dev: device hookup to device function handler
295 * @remove_dev: device hookup to device function handler
297 * Simple interfaces attached to a subsystem. Multiple interfaces can
298 * attach to a subsystem and its devices. Unlike drivers, they do not
299 * exclusively claim or control devices. Interfaces usually represent
300 * a specific functionality of a subsystem/class of devices.
302 struct subsys_interface
{
304 struct bus_type
*subsys
;
305 struct list_head node
;
306 int (*add_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
307 int (*remove_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
310 int subsys_interface_register(struct subsys_interface
*sif
);
311 void subsys_interface_unregister(struct subsys_interface
*sif
);
313 int subsys_system_register(struct bus_type
*subsys
,
314 const struct attribute_group
**groups
);
315 int subsys_virtual_register(struct bus_type
*subsys
,
316 const struct attribute_group
**groups
);
319 * struct class - device classes
320 * @name: Name of the class.
321 * @owner: The module owner.
322 * @class_attrs: Default attributes of this class.
323 * @dev_attrs: Default attributes of the devices belong to the class.
324 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
325 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
326 * @dev_uevent: Called when a device is added, removed from this class, or a
327 * few other things that generate uevents to add the environment
329 * @devnode: Callback to provide the devtmpfs.
330 * @class_release: Called to release this class.
331 * @dev_release: Called to release the device.
332 * @suspend: Used to put the device to sleep mode, usually to a low power
334 * @resume: Used to bring the device from the sleep mode.
335 * @ns_type: Callbacks so sysfs can detemine namespaces.
336 * @namespace: Namespace of the device belongs to this class.
337 * @pm: The default device power management operations of this class.
338 * @p: The private data of the driver core, no one other than the
339 * driver core can touch this.
341 * A class is a higher-level view of a device that abstracts out low-level
342 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
343 * at the class level, they are all simply disks. Classes allow user space
344 * to work with devices based on what they do, rather than how they are
345 * connected or how they work.
349 struct module
*owner
;
351 struct class_attribute
*class_attrs
;
352 struct device_attribute
*dev_attrs
;
353 struct bin_attribute
*dev_bin_attrs
;
354 struct kobject
*dev_kobj
;
356 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
357 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
359 void (*class_release
)(struct class *class);
360 void (*dev_release
)(struct device
*dev
);
362 int (*suspend
)(struct device
*dev
, pm_message_t state
);
363 int (*resume
)(struct device
*dev
);
365 const struct kobj_ns_type_operations
*ns_type
;
366 const void *(*namespace)(struct device
*dev
);
368 const struct dev_pm_ops
*pm
;
370 struct subsys_private
*p
;
373 struct class_dev_iter
{
374 struct klist_iter ki
;
375 const struct device_type
*type
;
378 extern struct kobject
*sysfs_dev_block_kobj
;
379 extern struct kobject
*sysfs_dev_char_kobj
;
380 extern int __must_check
__class_register(struct class *class,
381 struct lock_class_key
*key
);
382 extern void class_unregister(struct class *class);
384 /* This is a #define to keep the compiler from merging different
385 * instances of the __key variable */
386 #define class_register(class) \
388 static struct lock_class_key __key; \
389 __class_register(class, &__key); \
393 struct class_compat
*class_compat_register(const char *name
);
394 void class_compat_unregister(struct class_compat
*cls
);
395 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
396 struct device
*device_link
);
397 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
398 struct device
*device_link
);
400 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
402 struct device
*start
,
403 const struct device_type
*type
);
404 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
405 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
407 extern int class_for_each_device(struct class *class, struct device
*start
,
409 int (*fn
)(struct device
*dev
, void *data
));
410 extern struct device
*class_find_device(struct class *class,
411 struct device
*start
, const void *data
,
412 int (*match
)(struct device
*, const void *));
414 struct class_attribute
{
415 struct attribute attr
;
416 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
418 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
419 const char *buf
, size_t count
);
420 const void *(*namespace)(struct class *class,
421 const struct class_attribute
*attr
);
424 #define CLASS_ATTR(_name, _mode, _show, _store) \
425 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
426 #define CLASS_ATTR_RW(_name) \
427 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
428 #define CLASS_ATTR_RO(_name) \
429 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
431 extern int __must_check
class_create_file(struct class *class,
432 const struct class_attribute
*attr
);
433 extern void class_remove_file(struct class *class,
434 const struct class_attribute
*attr
);
436 /* Simple class attribute that is just a static string */
437 struct class_attribute_string
{
438 struct class_attribute attr
;
442 /* Currently read-only only */
443 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
444 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
445 #define CLASS_ATTR_STRING(_name, _mode, _str) \
446 struct class_attribute_string class_attr_##_name = \
447 _CLASS_ATTR_STRING(_name, _mode, _str)
449 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
452 struct class_interface
{
453 struct list_head node
;
456 int (*add_dev
) (struct device
*, struct class_interface
*);
457 void (*remove_dev
) (struct device
*, struct class_interface
*);
460 extern int __must_check
class_interface_register(struct class_interface
*);
461 extern void class_interface_unregister(struct class_interface
*);
463 extern struct class * __must_check
__class_create(struct module
*owner
,
465 struct lock_class_key
*key
);
466 extern void class_destroy(struct class *cls
);
468 /* This is a #define to keep the compiler from merging different
469 * instances of the __key variable */
470 #define class_create(owner, name) \
472 static struct lock_class_key __key; \
473 __class_create(owner, name, &__key); \
477 * The type of device, "struct device" is embedded in. A class
478 * or bus can contain devices of different types
479 * like "partitions" and "disks", "mouse" and "event".
480 * This identifies the device type and carries type-specific
481 * information, equivalent to the kobj_type of a kobject.
482 * If "name" is specified, the uevent will contain it in
483 * the DEVTYPE variable.
487 const struct attribute_group
**groups
;
488 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
489 char *(*devnode
)(struct device
*dev
, umode_t
*mode
,
490 kuid_t
*uid
, kgid_t
*gid
);
491 void (*release
)(struct device
*dev
);
493 const struct dev_pm_ops
*pm
;
496 /* interface for exporting device attributes */
497 struct device_attribute
{
498 struct attribute attr
;
499 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
501 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
502 const char *buf
, size_t count
);
505 struct dev_ext_attribute
{
506 struct device_attribute attr
;
510 ssize_t
device_show_ulong(struct device
*dev
, struct device_attribute
*attr
,
512 ssize_t
device_store_ulong(struct device
*dev
, struct device_attribute
*attr
,
513 const char *buf
, size_t count
);
514 ssize_t
device_show_int(struct device
*dev
, struct device_attribute
*attr
,
516 ssize_t
device_store_int(struct device
*dev
, struct device_attribute
*attr
,
517 const char *buf
, size_t count
);
518 ssize_t
device_show_bool(struct device
*dev
, struct device_attribute
*attr
,
520 ssize_t
device_store_bool(struct device
*dev
, struct device_attribute
*attr
,
521 const char *buf
, size_t count
);
523 #define DEVICE_ATTR(_name, _mode, _show, _store) \
524 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
525 #define DEVICE_ATTR_RW(_name) \
526 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
527 #define DEVICE_ATTR_RO(_name) \
528 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
529 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
530 struct dev_ext_attribute dev_attr_##_name = \
531 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
532 #define DEVICE_INT_ATTR(_name, _mode, _var) \
533 struct dev_ext_attribute dev_attr_##_name = \
534 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
535 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
536 struct dev_ext_attribute dev_attr_##_name = \
537 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
538 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
539 struct device_attribute dev_attr_##_name = \
540 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
542 extern int device_create_file(struct device
*device
,
543 const struct device_attribute
*entry
);
544 extern void device_remove_file(struct device
*dev
,
545 const struct device_attribute
*attr
);
546 extern int __must_check
device_create_bin_file(struct device
*dev
,
547 const struct bin_attribute
*attr
);
548 extern void device_remove_bin_file(struct device
*dev
,
549 const struct bin_attribute
*attr
);
550 extern int device_schedule_callback_owner(struct device
*dev
,
551 void (*func
)(struct device
*dev
), struct module
*owner
);
553 /* This is a macro to avoid include problems with THIS_MODULE */
554 #define device_schedule_callback(dev, func) \
555 device_schedule_callback_owner(dev, func, THIS_MODULE)
557 /* device resource management */
558 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
559 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
561 #ifdef CONFIG_DEBUG_DEVRES
562 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
564 #define devres_alloc(release, size, gfp) \
565 __devres_alloc(release, size, gfp, #release)
567 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
569 extern void devres_for_each_res(struct device
*dev
, dr_release_t release
,
570 dr_match_t match
, void *match_data
,
571 void (*fn
)(struct device
*, void *, void *),
573 extern void devres_free(void *res
);
574 extern void devres_add(struct device
*dev
, void *res
);
575 extern void *devres_find(struct device
*dev
, dr_release_t release
,
576 dr_match_t match
, void *match_data
);
577 extern void *devres_get(struct device
*dev
, void *new_res
,
578 dr_match_t match
, void *match_data
);
579 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
580 dr_match_t match
, void *match_data
);
581 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
582 dr_match_t match
, void *match_data
);
583 extern int devres_release(struct device
*dev
, dr_release_t release
,
584 dr_match_t match
, void *match_data
);
587 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
589 extern void devres_close_group(struct device
*dev
, void *id
);
590 extern void devres_remove_group(struct device
*dev
, void *id
);
591 extern int devres_release_group(struct device
*dev
, void *id
);
593 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
594 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
595 extern void devm_kfree(struct device
*dev
, void *p
);
597 void __iomem
*devm_ioremap_resource(struct device
*dev
, struct resource
*res
);
598 void __iomem
*devm_request_and_ioremap(struct device
*dev
,
599 struct resource
*res
);
601 /* allows to add/remove a custom action to devres stack */
602 int devm_add_action(struct device
*dev
, void (*action
)(void *), void *data
);
603 void devm_remove_action(struct device
*dev
, void (*action
)(void *), void *data
);
605 struct device_dma_parameters
{
607 * a low level driver may set these to teach IOMMU code about
610 unsigned int max_segment_size
;
611 unsigned long segment_boundary_mask
;
614 struct acpi_dev_node
{
621 * struct device - The basic device structure
622 * @parent: The device's "parent" device, the device to which it is attached.
623 * In most cases, a parent device is some sort of bus or host
624 * controller. If parent is NULL, the device, is a top-level device,
625 * which is not usually what you want.
626 * @p: Holds the private data of the driver core portions of the device.
627 * See the comment of the struct device_private for detail.
628 * @kobj: A top-level, abstract class from which other classes are derived.
629 * @init_name: Initial name of the device.
630 * @type: The type of device.
631 * This identifies the device type and carries type-specific
633 * @mutex: Mutex to synchronize calls to its driver.
634 * @bus: Type of bus device is on.
635 * @driver: Which driver has allocated this
636 * @platform_data: Platform data specific to the device.
637 * Example: For devices on custom boards, as typical of embedded
638 * and SOC based hardware, Linux often uses platform_data to point
639 * to board-specific structures describing devices and how they
640 * are wired. That can include what ports are available, chip
641 * variants, which GPIO pins act in what additional roles, and so
642 * on. This shrinks the "Board Support Packages" (BSPs) and
643 * minimizes board-specific #ifdefs in drivers.
644 * @power: For device power management.
645 * See Documentation/power/devices.txt for details.
646 * @pm_domain: Provide callbacks that are executed during system suspend,
647 * hibernation, system resume and during runtime PM transitions
648 * along with subsystem-level and driver-level callbacks.
649 * @pins: For device pin management.
650 * See Documentation/pinctrl.txt for details.
651 * @numa_node: NUMA node this device is close to.
652 * @dma_mask: Dma mask (if dma'ble device).
653 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
654 * hardware supports 64-bit addresses for consistent allocations
656 * @dma_parms: A low level driver may set these to teach IOMMU code about
657 * segment limitations.
658 * @dma_pools: Dma pools (if dma'ble device).
659 * @dma_mem: Internal for coherent mem override.
660 * @cma_area: Contiguous memory area for dma allocations
661 * @archdata: For arch-specific additions.
662 * @of_node: Associated device tree node.
663 * @acpi_node: Associated ACPI device node.
664 * @devt: For creating the sysfs "dev".
665 * @id: device instance
666 * @devres_lock: Spinlock to protect the resource of the device.
667 * @devres_head: The resources list of the device.
668 * @knode_class: The node used to add the device to the class list.
669 * @class: The class of the device.
670 * @groups: Optional attribute groups.
671 * @release: Callback to free the device after all references have
672 * gone away. This should be set by the allocator of the
673 * device (i.e. the bus driver that discovered the device).
674 * @iommu_group: IOMMU group the device belongs to.
676 * @offline_disabled: If set, the device is permanently online.
677 * @offline: Set after successful invocation of bus type's .offline().
679 * At the lowest level, every device in a Linux system is represented by an
680 * instance of struct device. The device structure contains the information
681 * that the device model core needs to model the system. Most subsystems,
682 * however, track additional information about the devices they host. As a
683 * result, it is rare for devices to be represented by bare device structures;
684 * instead, that structure, like kobject structures, is usually embedded within
685 * a higher-level representation of the device.
688 struct device
*parent
;
690 struct device_private
*p
;
693 const char *init_name
; /* initial name of the device */
694 const struct device_type
*type
;
696 struct mutex mutex
; /* mutex to synchronize calls to
700 struct bus_type
*bus
; /* type of bus device is on */
701 struct device_driver
*driver
; /* which driver has allocated this
703 void *platform_data
; /* Platform specific data, device
704 core doesn't touch it */
705 struct dev_pm_info power
;
706 struct dev_pm_domain
*pm_domain
;
708 #ifdef CONFIG_PINCTRL
709 struct dev_pin_info
*pins
;
713 int numa_node
; /* NUMA node this device is close to */
715 u64
*dma_mask
; /* dma mask (if dma'able device) */
716 u64 coherent_dma_mask
;/* Like dma_mask, but for
717 alloc_coherent mappings as
718 not all hardware supports
719 64 bit addresses for consistent
720 allocations such descriptors. */
722 struct device_dma_parameters
*dma_parms
;
724 struct list_head dma_pools
; /* dma pools (if dma'ble) */
726 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
729 struct cma
*cma_area
; /* contiguous memory area for dma
732 /* arch specific additions */
733 struct dev_archdata archdata
;
735 struct device_node
*of_node
; /* associated device tree node */
736 struct acpi_dev_node acpi_node
; /* associated ACPI device node */
738 dev_t devt
; /* dev_t, creates the sysfs "dev" */
739 u32 id
; /* device instance */
741 spinlock_t devres_lock
;
742 struct list_head devres_head
;
744 struct klist_node knode_class
;
746 const struct attribute_group
**groups
; /* optional groups */
748 void (*release
)(struct device
*dev
);
749 struct iommu_group
*iommu_group
;
751 bool offline_disabled
:1;
755 static inline struct device
*kobj_to_dev(struct kobject
*kobj
)
757 return container_of(kobj
, struct device
, kobj
);
761 #define ACPI_HANDLE(dev) ((dev)->acpi_node.handle)
762 #define ACPI_HANDLE_SET(dev, _handle_) (dev)->acpi_node.handle = (_handle_)
764 #define ACPI_HANDLE(dev) (NULL)
765 #define ACPI_HANDLE_SET(dev, _handle_) do { } while (0)
768 /* Get the wakeup routines, which depend on struct device */
769 #include <linux/pm_wakeup.h>
771 static inline const char *dev_name(const struct device
*dev
)
773 /* Use the init name until the kobject becomes available */
775 return dev
->init_name
;
777 return kobject_name(&dev
->kobj
);
780 extern __printf(2, 3)
781 int dev_set_name(struct device
*dev
, const char *name
, ...);
784 static inline int dev_to_node(struct device
*dev
)
786 return dev
->numa_node
;
788 static inline void set_dev_node(struct device
*dev
, int node
)
790 dev
->numa_node
= node
;
793 static inline int dev_to_node(struct device
*dev
)
797 static inline void set_dev_node(struct device
*dev
, int node
)
802 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
804 return dev
? dev
->power
.subsys_data
: NULL
;
807 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
809 return dev
->kobj
.uevent_suppress
;
812 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
814 dev
->kobj
.uevent_suppress
= val
;
817 static inline int device_is_registered(struct device
*dev
)
819 return dev
->kobj
.state_in_sysfs
;
822 static inline void device_enable_async_suspend(struct device
*dev
)
824 if (!dev
->power
.is_prepared
)
825 dev
->power
.async_suspend
= true;
828 static inline void device_disable_async_suspend(struct device
*dev
)
830 if (!dev
->power
.is_prepared
)
831 dev
->power
.async_suspend
= false;
834 static inline bool device_async_suspend_enabled(struct device
*dev
)
836 return !!dev
->power
.async_suspend
;
839 static inline void pm_suspend_ignore_children(struct device
*dev
, bool enable
)
841 dev
->power
.ignore_children
= enable
;
844 static inline void dev_pm_syscore_device(struct device
*dev
, bool val
)
846 #ifdef CONFIG_PM_SLEEP
847 dev
->power
.syscore
= val
;
851 static inline void device_lock(struct device
*dev
)
853 mutex_lock(&dev
->mutex
);
856 static inline int device_trylock(struct device
*dev
)
858 return mutex_trylock(&dev
->mutex
);
861 static inline void device_unlock(struct device
*dev
)
863 mutex_unlock(&dev
->mutex
);
866 void driver_init(void);
869 * High level routines for use by the bus drivers
871 extern int __must_check
device_register(struct device
*dev
);
872 extern void device_unregister(struct device
*dev
);
873 extern void device_initialize(struct device
*dev
);
874 extern int __must_check
device_add(struct device
*dev
);
875 extern void device_del(struct device
*dev
);
876 extern int device_for_each_child(struct device
*dev
, void *data
,
877 int (*fn
)(struct device
*dev
, void *data
));
878 extern struct device
*device_find_child(struct device
*dev
, void *data
,
879 int (*match
)(struct device
*dev
, void *data
));
880 extern int device_rename(struct device
*dev
, const char *new_name
);
881 extern int device_move(struct device
*dev
, struct device
*new_parent
,
882 enum dpm_order dpm_order
);
883 extern const char *device_get_devnode(struct device
*dev
,
884 umode_t
*mode
, kuid_t
*uid
, kgid_t
*gid
,
886 extern void *dev_get_drvdata(const struct device
*dev
);
887 extern int dev_set_drvdata(struct device
*dev
, void *data
);
889 static inline bool device_supports_offline(struct device
*dev
)
891 return dev
->bus
&& dev
->bus
->offline
&& dev
->bus
->online
;
894 extern void lock_device_hotplug(void);
895 extern void unlock_device_hotplug(void);
896 extern int device_offline(struct device
*dev
);
897 extern int device_online(struct device
*dev
);
899 * Root device objects for grouping under /sys/devices
901 extern struct device
*__root_device_register(const char *name
,
902 struct module
*owner
);
905 * This is a macro to avoid include problems with THIS_MODULE,
906 * just as per what is done for device_schedule_callback() above.
908 #define root_device_register(name) \
909 __root_device_register(name, THIS_MODULE)
911 extern void root_device_unregister(struct device
*root
);
913 static inline void *dev_get_platdata(const struct device
*dev
)
915 return dev
->platform_data
;
919 * Manual binding of a device to driver. See drivers/base/bus.c
920 * for information on use.
922 extern int __must_check
device_bind_driver(struct device
*dev
);
923 extern void device_release_driver(struct device
*dev
);
924 extern int __must_check
device_attach(struct device
*dev
);
925 extern int __must_check
driver_attach(struct device_driver
*drv
);
926 extern int __must_check
device_reprobe(struct device
*dev
);
929 * Easy functions for dynamically creating devices on the fly
931 extern struct device
*device_create_vargs(struct class *cls
,
932 struct device
*parent
,
937 extern __printf(5, 6)
938 struct device
*device_create(struct class *cls
, struct device
*parent
,
939 dev_t devt
, void *drvdata
,
940 const char *fmt
, ...);
941 extern __printf(6, 7)
942 struct device
*device_create_with_groups(struct class *cls
,
943 struct device
*parent
, dev_t devt
, void *drvdata
,
944 const struct attribute_group
**groups
,
945 const char *fmt
, ...);
946 extern void device_destroy(struct class *cls
, dev_t devt
);
949 * Platform "fixup" functions - allow the platform to have their say
950 * about devices and actions that the general device layer doesn't
953 /* Notify platform of device discovery */
954 extern int (*platform_notify
)(struct device
*dev
);
956 extern int (*platform_notify_remove
)(struct device
*dev
);
960 * get_device - atomically increment the reference count for the device.
963 extern struct device
*get_device(struct device
*dev
);
964 extern void put_device(struct device
*dev
);
966 #ifdef CONFIG_DEVTMPFS
967 extern int devtmpfs_create_node(struct device
*dev
);
968 extern int devtmpfs_delete_node(struct device
*dev
);
969 extern int devtmpfs_mount(const char *mntdir
);
971 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
972 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
973 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
976 /* drivers/base/power/shutdown.c */
977 extern void device_shutdown(void);
979 /* debugging and troubleshooting/diagnostic helpers. */
980 extern const char *dev_driver_string(const struct device
*dev
);
985 extern __printf(3, 0)
986 int dev_vprintk_emit(int level
, const struct device
*dev
,
987 const char *fmt
, va_list args
);
988 extern __printf(3, 4)
989 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...);
991 extern __printf(3, 4)
992 int dev_printk(const char *level
, const struct device
*dev
,
993 const char *fmt
, ...);
994 extern __printf(2, 3)
995 int dev_emerg(const struct device
*dev
, const char *fmt
, ...);
996 extern __printf(2, 3)
997 int dev_alert(const struct device
*dev
, const char *fmt
, ...);
998 extern __printf(2, 3)
999 int dev_crit(const struct device
*dev
, const char *fmt
, ...);
1000 extern __printf(2, 3)
1001 int dev_err(const struct device
*dev
, const char *fmt
, ...);
1002 extern __printf(2, 3)
1003 int dev_warn(const struct device
*dev
, const char *fmt
, ...);
1004 extern __printf(2, 3)
1005 int dev_notice(const struct device
*dev
, const char *fmt
, ...);
1006 extern __printf(2, 3)
1007 int _dev_info(const struct device
*dev
, const char *fmt
, ...);
1011 static inline __printf(3, 0)
1012 int dev_vprintk_emit(int level
, const struct device
*dev
,
1013 const char *fmt
, va_list args
)
1015 static inline __printf(3, 4)
1016 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...)
1019 static inline int __dev_printk(const char *level
, const struct device
*dev
,
1020 struct va_format
*vaf
)
1022 static inline __printf(3, 4)
1023 int dev_printk(const char *level
, const struct device
*dev
,
1024 const char *fmt
, ...)
1027 static inline __printf(2, 3)
1028 int dev_emerg(const struct device
*dev
, const char *fmt
, ...)
1030 static inline __printf(2, 3)
1031 int dev_crit(const struct device
*dev
, const char *fmt
, ...)
1033 static inline __printf(2, 3)
1034 int dev_alert(const struct device
*dev
, const char *fmt
, ...)
1036 static inline __printf(2, 3)
1037 int dev_err(const struct device
*dev
, const char *fmt
, ...)
1039 static inline __printf(2, 3)
1040 int dev_warn(const struct device
*dev
, const char *fmt
, ...)
1042 static inline __printf(2, 3)
1043 int dev_notice(const struct device
*dev
, const char *fmt
, ...)
1045 static inline __printf(2, 3)
1046 int _dev_info(const struct device
*dev
, const char *fmt
, ...)
1052 * Stupid hackaround for existing uses of non-printk uses dev_info
1054 * Note that the definition of dev_info below is actually _dev_info
1055 * and a macro is used to avoid redefining dev_info
1058 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1060 #if defined(CONFIG_DYNAMIC_DEBUG)
1061 #define dev_dbg(dev, format, ...) \
1063 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1065 #elif defined(DEBUG)
1066 #define dev_dbg(dev, format, arg...) \
1067 dev_printk(KERN_DEBUG, dev, format, ##arg)
1069 #define dev_dbg(dev, format, arg...) \
1072 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1077 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1079 static DEFINE_RATELIMIT_STATE(_rs, \
1080 DEFAULT_RATELIMIT_INTERVAL, \
1081 DEFAULT_RATELIMIT_BURST); \
1082 if (__ratelimit(&_rs)) \
1083 dev_level(dev, fmt, ##__VA_ARGS__); \
1086 #define dev_emerg_ratelimited(dev, fmt, ...) \
1087 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1088 #define dev_alert_ratelimited(dev, fmt, ...) \
1089 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1090 #define dev_crit_ratelimited(dev, fmt, ...) \
1091 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1092 #define dev_err_ratelimited(dev, fmt, ...) \
1093 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1094 #define dev_warn_ratelimited(dev, fmt, ...) \
1095 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1096 #define dev_notice_ratelimited(dev, fmt, ...) \
1097 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1098 #define dev_info_ratelimited(dev, fmt, ...) \
1099 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1100 #if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
1101 #define dev_dbg_ratelimited(dev, fmt, ...) \
1103 static DEFINE_RATELIMIT_STATE(_rs, \
1104 DEFAULT_RATELIMIT_INTERVAL, \
1105 DEFAULT_RATELIMIT_BURST); \
1106 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1107 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1108 __ratelimit(&_rs)) \
1109 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
1113 #define dev_dbg_ratelimited(dev, fmt, ...) \
1114 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1117 #ifdef VERBOSE_DEBUG
1118 #define dev_vdbg dev_dbg
1120 #define dev_vdbg(dev, format, arg...) \
1123 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1129 * dev_WARN*() acts like dev_printk(), but with the key difference
1130 * of using a WARN/WARN_ON to get the message out, including the
1131 * file/line information and a backtrace.
1133 #define dev_WARN(dev, format, arg...) \
1134 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1136 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1137 WARN_ONCE(condition, "Device %s\n" format, \
1138 dev_driver_string(dev), ## arg)
1140 /* Create alias, so I can be autoloaded. */
1141 #define MODULE_ALIAS_CHARDEV(major,minor) \
1142 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1143 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1144 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1146 #ifdef CONFIG_SYSFS_DEPRECATED
1147 extern long sysfs_deprecated
;
1149 #define sysfs_deprecated 0
1153 * module_driver() - Helper macro for drivers that don't do anything
1154 * special in module init/exit. This eliminates a lot of boilerplate.
1155 * Each module may only use this macro once, and calling it replaces
1156 * module_init() and module_exit().
1158 * @__driver: driver name
1159 * @__register: register function for this driver type
1160 * @__unregister: unregister function for this driver type
1161 * @...: Additional arguments to be passed to __register and __unregister.
1163 * Use this macro to construct bus specific macros for registering
1164 * drivers, and do not use it on its own.
1166 #define module_driver(__driver, __register, __unregister, ...) \
1167 static int __init __driver##_init(void) \
1169 return __register(&(__driver) , ##__VA_ARGS__); \
1171 module_init(__driver##_init); \
1172 static void __exit __driver##_exit(void) \
1174 __unregister(&(__driver) , ##__VA_ARGS__); \
1176 module_exit(__driver##_exit);
1178 #endif /* _DEVICE_H_ */