]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/device.h
driver core: Introduce device_create_groups
[mirror_ubuntu-artful-kernel.git] / include / linux / device.h
CommitLineData
1da177e4
LT
1/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
b4028437
GKH
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
1da177e4
LT
7 *
8 * This file is released under the GPLv2
9 *
10 * See Documentation/driver-model/ for more information.
11 */
12
13#ifndef _DEVICE_H_
14#define _DEVICE_H_
15
1da177e4
LT
16#include <linux/ioport.h>
17#include <linux/kobject.h>
465c7a3a 18#include <linux/klist.h>
1da177e4 19#include <linux/list.h>
d2a3b914 20#include <linux/lockdep.h>
4a7fb636 21#include <linux/compiler.h>
1da177e4 22#include <linux/types.h>
de477254 23#include <linux/mutex.h>
ab78029e 24#include <linux/pinctrl/devinfo.h>
1da177e4 25#include <linux/pm.h>
60063497 26#include <linux/atomic.h>
6ca04593 27#include <linux/ratelimit.h>
3c2670e6 28#include <linux/uidgid.h>
c6dbaef2 29#include <asm/device.h>
1da177e4 30
1da177e4 31struct device;
fb069a5d 32struct device_private;
1da177e4 33struct device_driver;
e5dd1278 34struct driver_private;
de477254 35struct module;
1da177e4 36struct class;
6b6e39a6 37struct subsys_private;
b8c5cec2 38struct bus_type;
d706c1b0 39struct device_node;
ff21776d 40struct iommu_ops;
74416e1e 41struct iommu_group;
b8c5cec2
KS
42
43struct bus_attribute {
44 struct attribute attr;
d462943a
GKH
45 ssize_t (*show)(struct bus_type *bus, char *buf);
46 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
b8c5cec2
KS
47};
48
d462943a 49#define BUS_ATTR(_name, _mode, _show, _store) \
ced321bf
GKH
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)
b8c5cec2
KS
55
56extern int __must_check bus_create_file(struct bus_type *,
57 struct bus_attribute *);
58extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
1da177e4 59
880ffb5c
WG
60/**
61 * struct bus_type - The bus type of the device
62 *
63 * @name: The name of the bus.
ca22e56d
KS
64 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
65 * @dev_root: Default device to use as the parent.
880ffb5c
WG
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.
4f3549d7
RW
78 *
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.
81 *
880ffb5c
WG
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.
7b08fae8 86 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
ff21776d
JR
87 * driver implementations to a bus and allow the driver to do
88 * bus-specific setup
880ffb5c
WG
89 * @p: The private data of the driver core, only the driver core can
90 * touch this.
bfd63cd2 91 * @lock_key: Lock class key for use by the lock validator
880ffb5c
WG
92 *
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
100 * private data.
101 */
1da177e4 102struct bus_type {
d462943a 103 const char *name;
ca22e56d
KS
104 const char *dev_name;
105 struct device *dev_root;
d462943a
GKH
106 struct bus_attribute *bus_attrs;
107 struct device_attribute *dev_attrs;
108 struct driver_attribute *drv_attrs;
109
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);
115
4f3549d7
RW
116 int (*online)(struct device *dev);
117 int (*offline)(struct device *dev);
118
d462943a 119 int (*suspend)(struct device *dev, pm_message_t state);
d462943a 120 int (*resume)(struct device *dev);
b8c5cec2 121
8150f32b 122 const struct dev_pm_ops *pm;
1eede070 123
ff21776d
JR
124 struct iommu_ops *iommu_ops;
125
6b6e39a6 126 struct subsys_private *p;
be871b7e 127 struct lock_class_key lock_key;
1da177e4
LT
128};
129
be871b7e
MH
130extern int __must_check bus_register(struct bus_type *bus);
131
d462943a 132extern void bus_unregister(struct bus_type *bus);
1da177e4 133
d462943a 134extern int __must_check bus_rescan_devices(struct bus_type *bus);
1da177e4 135
1da177e4 136/* iterator helpers for buses */
ca22e56d
KS
137struct subsys_dev_iter {
138 struct klist_iter ki;
139 const struct device_type *type;
140};
7cd9c9bb 141void subsys_dev_iter_init(struct subsys_dev_iter *iter,
ca22e56d
KS
142 struct bus_type *subsys,
143 struct device *start,
144 const struct device_type *type);
145struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
146void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
1da177e4 147
d462943a
GKH
148int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
149 int (*fn)(struct device *dev, void *data));
150struct device *bus_find_device(struct bus_type *bus, struct device *start,
151 void *data,
152 int (*match)(struct device *dev, void *data));
1f9ffc04
GKH
153struct device *bus_find_device_by_name(struct bus_type *bus,
154 struct device *start,
155 const char *name);
ca22e56d
KS
156struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
157 struct device *hint);
cc7447a5
JD
158int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
159 void *data, int (*fn)(struct device_driver *, void *));
99178b03
GKH
160void bus_sort_breadthfirst(struct bus_type *bus,
161 int (*compare)(const struct device *a,
162 const struct device *b));
116af378
BH
163/*
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
167 * notify hooks.
168 */
169struct notifier_block;
170
171extern int bus_register_notifier(struct bus_type *bus,
172 struct notifier_block *nb);
173extern int bus_unregister_notifier(struct bus_type *bus,
174 struct notifier_block *nb);
175
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
8e9394ce 178 * with the device lock held in the core, so be careful.
116af378
BH
179 */
180#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
181#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
45daef0f
MD
182#define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
183 bound */
184#define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
185#define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
116af378 186 unbound */
45daef0f 187#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
309b7d60 188 from the device */
116af378 189
0fed80f7 190extern struct kset *bus_get_kset(struct bus_type *bus);
b249072e 191extern struct klist *bus_get_device_klist(struct bus_type *bus);
0fed80f7 192
880ffb5c
WG
193/**
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.
06f64c8f 201 * @acpi_match_table: The ACPI match table.
880ffb5c
WG
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
209 * low power state.
210 * @resume: Called to bring a device from sleep mode.
211 * @groups: Default attributes that get created by the driver core
212 * automatically.
213 * @pm: Power management operations of the device which matched
214 * this driver.
215 * @p: Driver core's private data, no one other than the driver
216 * core can touch this.
217 *
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.
224 */
1da177e4 225struct device_driver {
e5dd1278
GKH
226 const char *name;
227 struct bus_type *bus;
1da177e4 228
e5dd1278 229 struct module *owner;
1a6f2a75
DT
230 const char *mod_name; /* used for built-in modules */
231
232 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
1da177e4 233
597b9d1e 234 const struct of_device_id *of_match_table;
06f64c8f 235 const struct acpi_device_id *acpi_match_table;
597b9d1e 236
d462943a
GKH
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);
a4dbd674 242 const struct attribute_group **groups;
e5dd1278 243
8150f32b 244 const struct dev_pm_ops *pm;
1eede070 245
e5dd1278 246 struct driver_private *p;
1da177e4
LT
247};
248
249
d462943a
GKH
250extern int __must_check driver_register(struct device_driver *drv);
251extern void driver_unregister(struct device_driver *drv);
1da177e4 252
d462943a
GKH
253extern struct device_driver *driver_find(const char *name,
254 struct bus_type *bus);
d779249e 255extern int driver_probe_done(void);
b23530eb 256extern void wait_for_device_probe(void);
216773a7 257
1da177e4 258
405ae7d3 259/* sysfs interface for exporting driver attributes */
1da177e4
LT
260
261struct driver_attribute {
d462943a
GKH
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,
265 size_t count);
1da177e4
LT
266};
267
ced321bf
GKH
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)
1da177e4 274
d462943a 275extern int __must_check driver_create_file(struct device_driver *driver,
099c2f21 276 const struct driver_attribute *attr);
d462943a 277extern void driver_remove_file(struct device_driver *driver,
099c2f21 278 const struct driver_attribute *attr);
1da177e4 279
d462943a
GKH
280extern int __must_check driver_for_each_device(struct device_driver *drv,
281 struct device *start,
282 void *data,
283 int (*fn)(struct device *dev,
284 void *));
285struct device *driver_find_device(struct device_driver *drv,
286 struct device *start, void *data,
287 int (*match)(struct device *dev, void *data));
fae3cd00 288
ca22e56d
KS
289/**
290 * struct subsys_interface - interfaces to device functions
2eda013f
RD
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
ca22e56d
KS
296 *
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.
301 */
302struct subsys_interface {
303 const char *name;
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);
308};
309
310int subsys_interface_register(struct subsys_interface *sif);
311void subsys_interface_unregister(struct subsys_interface *sif);
312
313int subsys_system_register(struct bus_type *subsys,
314 const struct attribute_group **groups);
d73ce004
TH
315int subsys_virtual_register(struct bus_type *subsys,
316 const struct attribute_group **groups);
ca22e56d 317
880ffb5c
WG
318/**
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
328 * variables.
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
333 * state.
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.
340 *
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.
1da177e4
LT
346 */
347struct class {
d462943a
GKH
348 const char *name;
349 struct module *owner;
1da177e4 350
d462943a 351 struct class_attribute *class_attrs;
d462943a 352 struct device_attribute *dev_attrs;
c97415a7 353 struct bin_attribute *dev_bin_attrs;
e105b8bf 354 struct kobject *dev_kobj;
1da177e4 355
d462943a 356 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
2c9ede55 357 char *(*devnode)(struct device *dev, umode_t *mode);
1da177e4 358
d462943a
GKH
359 void (*class_release)(struct class *class);
360 void (*dev_release)(struct device *dev);
7c8265f5 361
d462943a
GKH
362 int (*suspend)(struct device *dev, pm_message_t state);
363 int (*resume)(struct device *dev);
1eede070 364
bc451f20
EB
365 const struct kobj_ns_type_operations *ns_type;
366 const void *(*namespace)(struct device *dev);
367
8150f32b
DT
368 const struct dev_pm_ops *pm;
369
6b6e39a6 370 struct subsys_private *p;
1da177e4
LT
371};
372
5a3ceb86
TH
373struct class_dev_iter {
374 struct klist_iter ki;
375 const struct device_type *type;
376};
377
e105b8bf
DW
378extern struct kobject *sysfs_dev_block_kobj;
379extern struct kobject *sysfs_dev_char_kobj;
d2a3b914
MW
380extern int __must_check __class_register(struct class *class,
381 struct lock_class_key *key);
d462943a 382extern void class_unregister(struct class *class);
d2a3b914
MW
383
384/* This is a #define to keep the compiler from merging different
385 * instances of the __key variable */
386#define class_register(class) \
387({ \
388 static struct lock_class_key __key; \
389 __class_register(class, &__key); \
390})
391
46227094
JD
392struct class_compat;
393struct class_compat *class_compat_register(const char *name);
394void class_compat_unregister(struct class_compat *cls);
395int class_compat_create_link(struct class_compat *cls, struct device *dev,
396 struct device *device_link);
397void class_compat_remove_link(struct class_compat *cls, struct device *dev,
398 struct device *device_link);
399
7cd9c9bb
GKH
400extern void class_dev_iter_init(struct class_dev_iter *iter,
401 struct class *class,
402 struct device *start,
403 const struct device_type *type);
5a3ceb86
TH
404extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
405extern void class_dev_iter_exit(struct class_dev_iter *iter);
406
93562b53
GKH
407extern int class_for_each_device(struct class *class, struct device *start,
408 void *data,
fd04897b 409 int (*fn)(struct device *dev, void *data));
695794ae 410extern struct device *class_find_device(struct class *class,
9f3b795a
MM
411 struct device *start, const void *data,
412 int (*match)(struct device *, const void *));
1da177e4
LT
413
414struct class_attribute {
d462943a 415 struct attribute attr;
28812fe1
AK
416 ssize_t (*show)(struct class *class, struct class_attribute *attr,
417 char *buf);
418 ssize_t (*store)(struct class *class, struct class_attribute *attr,
419 const char *buf, size_t count);
672d82c1
EB
420 const void *(*namespace)(struct class *class,
421 const struct class_attribute *attr);
1da177e4
LT
422};
423
ced321bf
GKH
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)
1da177e4 430
d462943a
GKH
431extern int __must_check class_create_file(struct class *class,
432 const struct class_attribute *attr);
433extern void class_remove_file(struct class *class,
434 const struct class_attribute *attr);
1da177e4 435
869dfc87 436/* Simple class attribute that is just a static string */
869dfc87
AK
437struct class_attribute_string {
438 struct class_attribute attr;
439 char *str;
440};
441
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)
448
449extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
450 char *buf);
451
1da177e4
LT
452struct class_interface {
453 struct list_head node;
454 struct class *class;
455
c47ed219
GKH
456 int (*add_dev) (struct device *, struct class_interface *);
457 void (*remove_dev) (struct device *, struct class_interface *);
1da177e4
LT
458};
459
4a7fb636 460extern int __must_check class_interface_register(struct class_interface *);
1da177e4
LT
461extern void class_interface_unregister(struct class_interface *);
462
d2a3b914
MW
463extern struct class * __must_check __class_create(struct module *owner,
464 const char *name,
465 struct lock_class_key *key);
e9ba6365 466extern void class_destroy(struct class *cls);
e9ba6365 467
d2a3b914
MW
468/* This is a #define to keep the compiler from merging different
469 * instances of the __key variable */
470#define class_create(owner, name) \
471({ \
472 static struct lock_class_key __key; \
473 __class_create(owner, name, &__key); \
474})
475
414264f9
KS
476/*
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.
484 */
f9f852df 485struct device_type {
414264f9 486 const char *name;
a4dbd674 487 const struct attribute_group **groups;
7eff2e7a 488 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
3c2670e6 489 char *(*devnode)(struct device *dev, umode_t *mode,
4e4098a3 490 kuid_t *uid, kgid_t *gid);
f9f852df 491 void (*release)(struct device *dev);
1eede070 492
8150f32b 493 const struct dev_pm_ops *pm;
f9f852df
KS
494};
495
a7fd6706
KS
496/* interface for exporting device attributes */
497struct device_attribute {
498 struct attribute attr;
499 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
500 char *buf);
501 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
502 const char *buf, size_t count);
503};
504
ca22e56d
KS
505struct dev_ext_attribute {
506 struct device_attribute attr;
507 void *var;
508};
509
510ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
511 char *buf);
512ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
513 const char *buf, size_t count);
514ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
515 char *buf);
516ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
517 const char *buf, size_t count);
91872392
BP
518ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
519 char *buf);
520ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
521 const char *buf, size_t count);
a7fd6706 522
d462943a 523#define DEVICE_ATTR(_name, _mode, _show, _store) \
ca22e56d 524 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
ced321bf
GKH
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)
ca22e56d
KS
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 = \
94758185 534 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
91872392
BP
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) }
356c05d5
AS
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)
a7fd6706 541
b9d4e714
GKH
542extern int device_create_file(struct device *device,
543 const struct device_attribute *entry);
d462943a 544extern void device_remove_file(struct device *dev,
26579ab7 545 const struct device_attribute *attr);
2589f188 546extern int __must_check device_create_bin_file(struct device *dev,
66ecb92b 547 const struct bin_attribute *attr);
2589f188 548extern void device_remove_bin_file(struct device *dev,
66ecb92b 549 const struct bin_attribute *attr);
523ded71 550extern int device_schedule_callback_owner(struct device *dev,
d462943a 551 void (*func)(struct device *dev), struct module *owner);
523ded71
AS
552
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)
9ac7849e
TH
556
557/* device resource management */
558typedef void (*dr_release_t)(struct device *dev, void *res);
559typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
560
561#ifdef CONFIG_DEBUG_DEVRES
d462943a 562extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
9ac7849e
TH
563 const char *name);
564#define devres_alloc(release, size, gfp) \
565 __devres_alloc(release, size, gfp, #release)
566#else
d462943a 567extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
9ac7849e 568#endif
bddb1b90
ML
569extern 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 *),
572 void *data);
9ac7849e
TH
573extern void devres_free(void *res);
574extern void devres_add(struct device *dev, void *res);
d462943a 575extern void *devres_find(struct device *dev, dr_release_t release,
9ac7849e 576 dr_match_t match, void *match_data);
d462943a
GKH
577extern void *devres_get(struct device *dev, void *new_res,
578 dr_match_t match, void *match_data);
579extern void *devres_remove(struct device *dev, dr_release_t release,
580 dr_match_t match, void *match_data);
9ac7849e
TH
581extern int devres_destroy(struct device *dev, dr_release_t release,
582 dr_match_t match, void *match_data);
d926d0e4
MB
583extern int devres_release(struct device *dev, dr_release_t release,
584 dr_match_t match, void *match_data);
9ac7849e
TH
585
586/* devres group */
587extern void * __must_check devres_open_group(struct device *dev, void *id,
588 gfp_t gfp);
589extern void devres_close_group(struct device *dev, void *id);
590extern void devres_remove_group(struct device *dev, void *id);
591extern int devres_release_group(struct device *dev, void *id);
592
593/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
594extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
595extern void devm_kfree(struct device *dev, void *p);
596
75096579 597void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
72f8c0bf
WS
598void __iomem *devm_request_and_ioremap(struct device *dev,
599 struct resource *res);
600
d6b0c580
DT
601/* allows to add/remove a custom action to devres stack */
602int devm_add_action(struct device *dev, void (*action)(void *), void *data);
603void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
604
6b7b6510
FT
605struct device_dma_parameters {
606 /*
607 * a low level driver may set these to teach IOMMU code about
608 * sg limitations.
609 */
610 unsigned int max_segment_size;
611 unsigned long segment_boundary_mask;
612};
613
95f8a082
RW
614struct acpi_dev_node {
615#ifdef CONFIG_ACPI
616 void *handle;
617#endif
618};
619
880ffb5c
WG
620/**
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
632 * information.
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.
564b905a 646 * @pm_domain: Provide callbacks that are executed during system suspend,
880ffb5c
WG
647 * hibernation, system resume and during runtime PM transitions
648 * along with subsystem-level and driver-level callbacks.
ab78029e
LW
649 * @pins: For device pin management.
650 * See Documentation/pinctrl.txt for details.
880ffb5c
WG
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
655 * such descriptors.
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.
bfd63cd2 660 * @cma_area: Contiguous memory area for dma allocations
880ffb5c
WG
661 * @archdata: For arch-specific additions.
662 * @of_node: Associated device tree node.
95f8a082 663 * @acpi_node: Associated ACPI device node.
880ffb5c 664 * @devt: For creating the sysfs "dev".
2eda013f 665 * @id: device instance
880ffb5c
WG
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).
bfd63cd2 674 * @iommu_group: IOMMU group the device belongs to.
880ffb5c 675 *
4f3549d7
RW
676 * @offline_disabled: If set, the device is permanently online.
677 * @offline: Set after successful invocation of bus type's .offline().
880ffb5c
WG
678 *
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.
686 */
1da177e4 687struct device {
49a4ec18 688 struct device *parent;
1da177e4 689
fb069a5d
GKH
690 struct device_private *p;
691
1da177e4 692 struct kobject kobj;
c906a48a 693 const char *init_name; /* initial name of the device */
aed65af1 694 const struct device_type *type;
1da177e4 695
3142788b 696 struct mutex mutex; /* mutex to synchronize calls to
af70316a
PM
697 * its driver.
698 */
699
d462943a 700 struct bus_type *bus; /* type of bus device is on */
1da177e4
LT
701 struct device_driver *driver; /* which driver has allocated this
702 device */
e67c8562
GKH
703 void *platform_data; /* Platform specific data, device
704 core doesn't touch it */
1da177e4 705 struct dev_pm_info power;
564b905a 706 struct dev_pm_domain *pm_domain;
1da177e4 707
ab78029e
LW
708#ifdef CONFIG_PINCTRL
709 struct dev_pin_info *pins;
710#endif
711
87348136
CH
712#ifdef CONFIG_NUMA
713 int numa_node; /* NUMA node this device is close to */
714#endif
1da177e4
LT
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. */
721
6b7b6510
FT
722 struct device_dma_parameters *dma_parms;
723
1da177e4
LT
724 struct list_head dma_pools; /* dma pools (if dma'ble) */
725
726 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
727 override */
c64be2bb
MS
728#ifdef CONFIG_CMA
729 struct cma *cma_area; /* contiguous memory area for dma
730 allocations */
731#endif
c6dbaef2
BH
732 /* arch specific additions */
733 struct dev_archdata archdata;
c9e358df
GL
734
735 struct device_node *of_node; /* associated device tree node */
95f8a082 736 struct acpi_dev_node acpi_node; /* associated ACPI device node */
1da177e4 737
929d2fa5 738 dev_t devt; /* dev_t, creates the sysfs "dev" */
ca22e56d 739 u32 id; /* device instance */
929d2fa5 740
9ac7849e
TH
741 spinlock_t devres_lock;
742 struct list_head devres_head;
743
5a3ceb86 744 struct klist_node knode_class;
b7a3e813 745 struct class *class;
a4dbd674 746 const struct attribute_group **groups; /* optional groups */
23681e47 747
d462943a 748 void (*release)(struct device *dev);
74416e1e 749 struct iommu_group *iommu_group;
4f3549d7
RW
750
751 bool offline_disabled:1;
752 bool offline:1;
1da177e4
LT
753};
754
a4232963
LPC
755static inline struct device *kobj_to_dev(struct kobject *kobj)
756{
757 return container_of(kobj, struct device, kobj);
758}
759
95f8a082
RW
760#ifdef CONFIG_ACPI
761#define ACPI_HANDLE(dev) ((dev)->acpi_node.handle)
762#define ACPI_HANDLE_SET(dev, _handle_) (dev)->acpi_node.handle = (_handle_)
763#else
764#define ACPI_HANDLE(dev) (NULL)
765#define ACPI_HANDLE_SET(dev, _handle_) do { } while (0)
766#endif
767
9a3df1f7
AS
768/* Get the wakeup routines, which depend on struct device */
769#include <linux/pm_wakeup.h>
770
bf9ca69f 771static inline const char *dev_name(const struct device *dev)
06916639 772{
a636ee7f
PM
773 /* Use the init name until the kobject becomes available */
774 if (dev->init_name)
775 return dev->init_name;
776
1fa5ae85 777 return kobject_name(&dev->kobj);
06916639
KS
778}
779
b9075fa9
JP
780extern __printf(2, 3)
781int dev_set_name(struct device *dev, const char *name, ...);
413c239f 782
87348136
CH
783#ifdef CONFIG_NUMA
784static inline int dev_to_node(struct device *dev)
785{
786 return dev->numa_node;
787}
788static inline void set_dev_node(struct device *dev, int node)
789{
790 dev->numa_node = node;
791}
792#else
793static inline int dev_to_node(struct device *dev)
794{
795 return -1;
796}
797static inline void set_dev_node(struct device *dev, int node)
798{
799}
800#endif
801
5c095a0e
RW
802static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
803{
804 return dev ? dev->power.subsys_data : NULL;
805}
806
f67f129e
ML
807static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
808{
809 return dev->kobj.uevent_suppress;
810}
811
812static inline void dev_set_uevent_suppress(struct device *dev, int val)
813{
814 dev->kobj.uevent_suppress = val;
815}
816
d305ef5d
DR
817static inline int device_is_registered(struct device *dev)
818{
3f62e570 819 return dev->kobj.state_in_sysfs;
d305ef5d
DR
820}
821
5af84b82
RW
822static inline void device_enable_async_suspend(struct device *dev)
823{
f76b168b 824 if (!dev->power.is_prepared)
5af84b82
RW
825 dev->power.async_suspend = true;
826}
827
5a2eb858
RW
828static inline void device_disable_async_suspend(struct device *dev)
829{
f76b168b 830 if (!dev->power.is_prepared)
5a2eb858
RW
831 dev->power.async_suspend = false;
832}
833
834static inline bool device_async_suspend_enabled(struct device *dev)
835{
836 return !!dev->power.async_suspend;
837}
838
8b258cc8
RW
839static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
840{
841 dev->power.ignore_children = enable;
842}
843
feb70af0
RW
844static inline void dev_pm_syscore_device(struct device *dev, bool val)
845{
846#ifdef CONFIG_PM_SLEEP
847 dev->power.syscore = val;
848#endif
849}
850
8e9394ce
GKH
851static inline void device_lock(struct device *dev)
852{
3142788b 853 mutex_lock(&dev->mutex);
8e9394ce
GKH
854}
855
856static inline int device_trylock(struct device *dev)
857{
3142788b 858 return mutex_trylock(&dev->mutex);
8e9394ce
GKH
859}
860
861static inline void device_unlock(struct device *dev)
862{
3142788b 863 mutex_unlock(&dev->mutex);
8e9394ce
GKH
864}
865
1f21782e
AB
866void driver_init(void);
867
1da177e4
LT
868/*
869 * High level routines for use by the bus drivers
870 */
d462943a
GKH
871extern int __must_check device_register(struct device *dev);
872extern void device_unregister(struct device *dev);
873extern void device_initialize(struct device *dev);
874extern int __must_check device_add(struct device *dev);
875extern void device_del(struct device *dev);
876extern int device_for_each_child(struct device *dev, void *data,
877 int (*fn)(struct device *dev, void *data));
878extern struct device *device_find_child(struct device *dev, void *data,
879 int (*match)(struct device *dev, void *data));
6937e8f8 880extern int device_rename(struct device *dev, const char *new_name);
ffa6a705
CH
881extern int device_move(struct device *dev, struct device *new_parent,
882 enum dpm_order dpm_order);
e454cea2 883extern const char *device_get_devnode(struct device *dev,
4e4098a3 884 umode_t *mode, kuid_t *uid, kgid_t *gid,
3c2670e6 885 const char **tmp);
b4028437 886extern void *dev_get_drvdata(const struct device *dev);
c8705082 887extern int dev_set_drvdata(struct device *dev, void *data);
1da177e4 888
4f3549d7
RW
889static inline bool device_supports_offline(struct device *dev)
890{
891 return dev->bus && dev->bus->offline && dev->bus->online;
892}
893
894extern void lock_device_hotplug(void);
895extern void unlock_device_hotplug(void);
896extern int device_offline(struct device *dev);
897extern int device_online(struct device *dev);
0aa0dc41
MM
898/*
899 * Root device objects for grouping under /sys/devices
900 */
901extern struct device *__root_device_register(const char *name,
902 struct module *owner);
eb5589a8
PG
903
904/*
905 * This is a macro to avoid include problems with THIS_MODULE,
906 * just as per what is done for device_schedule_callback() above.
907 */
908#define root_device_register(name) \
909 __root_device_register(name, THIS_MODULE)
910
0aa0dc41
MM
911extern void root_device_unregister(struct device *root);
912
a5b8b1ad
MB
913static inline void *dev_get_platdata(const struct device *dev)
914{
915 return dev->platform_data;
916}
917
1da177e4
LT
918/*
919 * Manual binding of a device to driver. See drivers/base/bus.c
920 * for information on use.
921 */
f86db396 922extern int __must_check device_bind_driver(struct device *dev);
d462943a
GKH
923extern void device_release_driver(struct device *dev);
924extern int __must_check device_attach(struct device *dev);
f86db396
AM
925extern int __must_check driver_attach(struct device_driver *drv);
926extern int __must_check device_reprobe(struct device *dev);
1da177e4 927
23681e47
GKH
928/*
929 * Easy functions for dynamically creating devices on the fly
930 */
8882b394
GKH
931extern struct device *device_create_vargs(struct class *cls,
932 struct device *parent,
933 dev_t devt,
934 void *drvdata,
935 const char *fmt,
936 va_list vargs);
b9075fa9
JP
937extern __printf(5, 6)
938struct device *device_create(struct class *cls, struct device *parent,
939 dev_t devt, void *drvdata,
940 const char *fmt, ...);
39ef3112
GR
941extern __printf(6, 7)
942struct 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, ...);
23681e47 946extern void device_destroy(struct class *cls, dev_t devt);
1da177e4 947
1da177e4
LT
948/*
949 * Platform "fixup" functions - allow the platform to have their say
950 * about devices and actions that the general device layer doesn't
951 * know about.
952 */
953/* Notify platform of device discovery */
d462943a 954extern int (*platform_notify)(struct device *dev);
1da177e4 955
d462943a 956extern int (*platform_notify_remove)(struct device *dev);
1da177e4
LT
957
958
880ffb5c 959/*
1da177e4
LT
960 * get_device - atomically increment the reference count for the device.
961 *
962 */
d462943a
GKH
963extern struct device *get_device(struct device *dev);
964extern void put_device(struct device *dev);
1da177e4 965
2b2af54a
KS
966#ifdef CONFIG_DEVTMPFS
967extern int devtmpfs_create_node(struct device *dev);
968extern int devtmpfs_delete_node(struct device *dev);
073120cc 969extern int devtmpfs_mount(const char *mntdir);
2b2af54a
KS
970#else
971static inline int devtmpfs_create_node(struct device *dev) { return 0; }
972static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
973static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
974#endif
975
116f232b 976/* drivers/base/power/shutdown.c */
1da177e4
LT
977extern void device_shutdown(void);
978
1da177e4 979/* debugging and troubleshooting/diagnostic helpers. */
bf9ca69f 980extern const char *dev_driver_string(const struct device *dev);
99bcf217
JP
981
982
983#ifdef CONFIG_PRINTK
984
0a18b050
JP
985extern __printf(3, 0)
986int dev_vprintk_emit(int level, const struct device *dev,
987 const char *fmt, va_list args);
05e4e5b8
JP
988extern __printf(3, 4)
989int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
798efc60 990
b9075fa9
JP
991extern __printf(3, 4)
992int dev_printk(const char *level, const struct device *dev,
798efc60 993 const char *fmt, ...);
b9075fa9
JP
994extern __printf(2, 3)
995int dev_emerg(const struct device *dev, const char *fmt, ...);
996extern __printf(2, 3)
997int dev_alert(const struct device *dev, const char *fmt, ...);
998extern __printf(2, 3)
999int dev_crit(const struct device *dev, const char *fmt, ...);
1000extern __printf(2, 3)
1001int dev_err(const struct device *dev, const char *fmt, ...);
1002extern __printf(2, 3)
1003int dev_warn(const struct device *dev, const char *fmt, ...);
1004extern __printf(2, 3)
1005int dev_notice(const struct device *dev, const char *fmt, ...);
1006extern __printf(2, 3)
1007int _dev_info(const struct device *dev, const char *fmt, ...);
99bcf217
JP
1008
1009#else
1010
0a18b050
JP
1011static inline __printf(3, 0)
1012int dev_vprintk_emit(int level, const struct device *dev,
1013 const char *fmt, va_list args)
05e4e5b8
JP
1014{ return 0; }
1015static inline __printf(3, 4)
1016int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1017{ return 0; }
1018
cbc46635
JP
1019static inline int __dev_printk(const char *level, const struct device *dev,
1020 struct va_format *vaf)
b9075fa9
JP
1021{ return 0; }
1022static inline __printf(3, 4)
1023int dev_printk(const char *level, const struct device *dev,
1024 const char *fmt, ...)
1025{ return 0; }
1026
1027static inline __printf(2, 3)
1028int dev_emerg(const struct device *dev, const char *fmt, ...)
1029{ return 0; }
1030static inline __printf(2, 3)
1031int dev_crit(const struct device *dev, const char *fmt, ...)
1032{ return 0; }
1033static inline __printf(2, 3)
1034int dev_alert(const struct device *dev, const char *fmt, ...)
1035{ return 0; }
1036static inline __printf(2, 3)
1037int dev_err(const struct device *dev, const char *fmt, ...)
1038{ return 0; }
1039static inline __printf(2, 3)
1040int dev_warn(const struct device *dev, const char *fmt, ...)
1041{ return 0; }
1042static inline __printf(2, 3)
1043int dev_notice(const struct device *dev, const char *fmt, ...)
1044{ return 0; }
1045static inline __printf(2, 3)
1046int _dev_info(const struct device *dev, const char *fmt, ...)
1047{ return 0; }
99bcf217
JP
1048
1049#endif
1050
6f586e66
HD
1051/*
1052 * Stupid hackaround for existing uses of non-printk uses dev_info
1053 *
1054 * Note that the definition of dev_info below is actually _dev_info
1055 * and a macro is used to avoid redefining dev_info
1056 */
1057
1058#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1059
1060#if defined(CONFIG_DYNAMIC_DEBUG)
1061#define dev_dbg(dev, format, ...) \
1062do { \
1063 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1064} while (0)
1065#elif defined(DEBUG)
1066#define dev_dbg(dev, format, arg...) \
1067 dev_printk(KERN_DEBUG, dev, format, ##arg)
1068#else
1069#define dev_dbg(dev, format, arg...) \
1070({ \
1071 if (0) \
1072 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1073 0; \
1074})
1075#endif
1076
6ca04593
HD
1077#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1078do { \
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__); \
1084} while (0)
1085
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__)
6f586e66 1100#if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
6ca04593 1101#define dev_dbg_ratelimited(dev, fmt, ...) \
6f586e66
HD
1102do { \
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), \
1110 ##__VA_ARGS__); \
99bcf217 1111} while (0)
1da177e4 1112#else
6f586e66
HD
1113#define dev_dbg_ratelimited(dev, fmt, ...) \
1114 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1da177e4
LT
1115#endif
1116
aebdc3b4
DB
1117#ifdef VERBOSE_DEBUG
1118#define dev_vdbg dev_dbg
1119#else
99bcf217
JP
1120#define dev_vdbg(dev, format, arg...) \
1121({ \
1122 if (0) \
1123 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1124 0; \
1125})
aebdc3b4
DB
1126#endif
1127
e6139662 1128/*
bcdd323b 1129 * dev_WARN*() acts like dev_printk(), but with the key difference
e6139662
AV
1130 * of using a WARN/WARN_ON to get the message out, including the
1131 * file/line information and a backtrace.
1132 */
1133#define dev_WARN(dev, format, arg...) \
1134 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1135
bcdd323b
FB
1136#define dev_WARN_ONCE(dev, condition, format, arg...) \
1137 WARN_ONCE(condition, "Device %s\n" format, \
1138 dev_driver_string(dev), ## arg)
1139
1da177e4
LT
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) "-*")
e52eec13
AK
1145
1146#ifdef CONFIG_SYSFS_DEPRECATED
1147extern long sysfs_deprecated;
1148#else
1149#define sysfs_deprecated 0
1150#endif
1151
907d0ed1
LPC
1152/**
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().
1157 *
2eda013f
RD
1158 * @__driver: driver name
1159 * @__register: register function for this driver type
1160 * @__unregister: unregister function for this driver type
cd494618 1161 * @...: Additional arguments to be passed to __register and __unregister.
2eda013f 1162 *
907d0ed1
LPC
1163 * Use this macro to construct bus specific macros for registering
1164 * drivers, and do not use it on its own.
1165 */
cd494618 1166#define module_driver(__driver, __register, __unregister, ...) \
907d0ed1
LPC
1167static int __init __driver##_init(void) \
1168{ \
cd494618 1169 return __register(&(__driver) , ##__VA_ARGS__); \
907d0ed1
LPC
1170} \
1171module_init(__driver##_init); \
1172static void __exit __driver##_exit(void) \
1173{ \
cd494618 1174 __unregister(&(__driver) , ##__VA_ARGS__); \
907d0ed1
LPC
1175} \
1176module_exit(__driver##_exit);
1177
1da177e4 1178#endif /* _DEVICE_H_ */