Merge remote-tracking branches 'regulator/topic/lp8788', 'regulator/topic/mt6311...
[deliverable/linux.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>
64c862a8 29#include <linux/gfp.h>
c6dbaef2 30#include <asm/device.h>
1da177e4 31
1da177e4 32struct device;
fb069a5d 33struct device_private;
1da177e4 34struct device_driver;
e5dd1278 35struct driver_private;
de477254 36struct module;
1da177e4 37struct class;
6b6e39a6 38struct subsys_private;
b8c5cec2 39struct bus_type;
d706c1b0 40struct device_node;
ce793486 41struct fwnode_handle;
ff21776d 42struct iommu_ops;
74416e1e 43struct iommu_group;
b8c5cec2
KS
44
45struct bus_attribute {
46 struct attribute attr;
d462943a
GKH
47 ssize_t (*show)(struct bus_type *bus, char *buf);
48 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
b8c5cec2
KS
49};
50
d462943a 51#define BUS_ATTR(_name, _mode, _show, _store) \
ced321bf
GKH
52 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
53#define BUS_ATTR_RW(_name) \
54 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
55#define BUS_ATTR_RO(_name) \
56 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
b8c5cec2
KS
57
58extern int __must_check bus_create_file(struct bus_type *,
59 struct bus_attribute *);
60extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
1da177e4 61
880ffb5c
WG
62/**
63 * struct bus_type - The bus type of the device
64 *
65 * @name: The name of the bus.
ca22e56d
KS
66 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
67 * @dev_root: Default device to use as the parent.
880ffb5c 68 * @dev_attrs: Default attributes of the devices on the bus.
12478ba0 69 * @bus_groups: Default attributes of the bus.
fa6fdb33 70 * @dev_groups: Default attributes of the devices on the bus.
ed0617b5 71 * @drv_groups: Default attributes of the device drivers on the bus.
880ffb5c
WG
72 * @match: Called, perhaps multiple times, whenever a new device or driver
73 * is added for this bus. It should return a nonzero value if the
74 * given device can be handled by the given driver.
75 * @uevent: Called when a device is added, removed, or a few other things
76 * that generate uevents to add the environment variables.
77 * @probe: Called when a new device or driver add to this bus, and callback
78 * the specific driver's probe to initial the matched device.
79 * @remove: Called when a device removed from this bus.
80 * @shutdown: Called at shut-down time to quiesce the device.
4f3549d7
RW
81 *
82 * @online: Called to put the device back online (after offlining it).
83 * @offline: Called to put the device offline for hot-removal. May fail.
84 *
880ffb5c
WG
85 * @suspend: Called when a device on this bus wants to go to sleep mode.
86 * @resume: Called to bring a device on this bus out of sleep mode.
87 * @pm: Power management operations of this bus, callback the specific
88 * device driver's pm-ops.
7b08fae8 89 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
ff21776d
JR
90 * driver implementations to a bus and allow the driver to do
91 * bus-specific setup
880ffb5c
WG
92 * @p: The private data of the driver core, only the driver core can
93 * touch this.
bfd63cd2 94 * @lock_key: Lock class key for use by the lock validator
880ffb5c
WG
95 *
96 * A bus is a channel between the processor and one or more devices. For the
97 * purposes of the device model, all devices are connected via a bus, even if
98 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
99 * A USB controller is usually a PCI device, for example. The device model
100 * represents the actual connections between buses and the devices they control.
101 * A bus is represented by the bus_type structure. It contains the name, the
102 * default attributes, the bus' methods, PM operations, and the driver core's
103 * private data.
104 */
1da177e4 105struct bus_type {
d462943a 106 const char *name;
ca22e56d
KS
107 const char *dev_name;
108 struct device *dev_root;
fa6fdb33 109 struct device_attribute *dev_attrs; /* use dev_groups instead */
12478ba0 110 const struct attribute_group **bus_groups;
fa6fdb33 111 const struct attribute_group **dev_groups;
ed0617b5 112 const struct attribute_group **drv_groups;
d462943a
GKH
113
114 int (*match)(struct device *dev, struct device_driver *drv);
115 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
116 int (*probe)(struct device *dev);
117 int (*remove)(struct device *dev);
118 void (*shutdown)(struct device *dev);
119
4f3549d7
RW
120 int (*online)(struct device *dev);
121 int (*offline)(struct device *dev);
122
d462943a 123 int (*suspend)(struct device *dev, pm_message_t state);
d462943a 124 int (*resume)(struct device *dev);
b8c5cec2 125
8150f32b 126 const struct dev_pm_ops *pm;
1eede070 127
b22f6434 128 const struct iommu_ops *iommu_ops;
ff21776d 129
6b6e39a6 130 struct subsys_private *p;
be871b7e 131 struct lock_class_key lock_key;
1da177e4
LT
132};
133
be871b7e
MH
134extern int __must_check bus_register(struct bus_type *bus);
135
d462943a 136extern void bus_unregister(struct bus_type *bus);
1da177e4 137
d462943a 138extern int __must_check bus_rescan_devices(struct bus_type *bus);
1da177e4 139
1da177e4 140/* iterator helpers for buses */
ca22e56d
KS
141struct subsys_dev_iter {
142 struct klist_iter ki;
143 const struct device_type *type;
144};
7cd9c9bb 145void subsys_dev_iter_init(struct subsys_dev_iter *iter,
ca22e56d
KS
146 struct bus_type *subsys,
147 struct device *start,
148 const struct device_type *type);
149struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
150void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
1da177e4 151
d462943a
GKH
152int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
153 int (*fn)(struct device *dev, void *data));
154struct device *bus_find_device(struct bus_type *bus, struct device *start,
155 void *data,
156 int (*match)(struct device *dev, void *data));
1f9ffc04
GKH
157struct device *bus_find_device_by_name(struct bus_type *bus,
158 struct device *start,
159 const char *name);
ca22e56d
KS
160struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
161 struct device *hint);
cc7447a5
JD
162int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
163 void *data, int (*fn)(struct device_driver *, void *));
99178b03
GKH
164void bus_sort_breadthfirst(struct bus_type *bus,
165 int (*compare)(const struct device *a,
166 const struct device *b));
116af378
BH
167/*
168 * Bus notifiers: Get notified of addition/removal of devices
169 * and binding/unbinding of drivers to devices.
170 * In the long run, it should be a replacement for the platform
171 * notify hooks.
172 */
173struct notifier_block;
174
175extern int bus_register_notifier(struct bus_type *bus,
176 struct notifier_block *nb);
177extern int bus_unregister_notifier(struct bus_type *bus,
178 struct notifier_block *nb);
179
180/* All 4 notifers below get called with the target struct device *
181 * as an argument. Note that those functions are likely to be called
8e9394ce 182 * with the device lock held in the core, so be careful.
116af378
BH
183 */
184#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
599bad38
JR
185#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
186#define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
187#define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
45daef0f 188 bound */
599bad38
JR
189#define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
190#define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
116af378 191 unbound */
599bad38 192#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
309b7d60 193 from the device */
116af378 194
0fed80f7 195extern struct kset *bus_get_kset(struct bus_type *bus);
b249072e 196extern struct klist *bus_get_device_klist(struct bus_type *bus);
0fed80f7 197
765230b5
DT
198/**
199 * enum probe_type - device driver probe type to try
200 * Device drivers may opt in for special handling of their
201 * respective probe routines. This tells the core what to
202 * expect and prefer.
203 *
d173a137
LR
204 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
205 * whether probed synchronously or asynchronously.
765230b5
DT
206 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
207 * probing order is not essential for booting the system may
208 * opt into executing their probes asynchronously.
d173a137
LR
209 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
210 * their probe routines to run synchronously with driver and
211 * device registration (with the exception of -EPROBE_DEFER
212 * handling - re-probing always ends up being done asynchronously).
765230b5
DT
213 *
214 * Note that the end goal is to switch the kernel to use asynchronous
215 * probing by default, so annotating drivers with
216 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
217 * to speed up boot process while we are validating the rest of the
218 * drivers.
219 */
220enum probe_type {
f2411da7 221 PROBE_DEFAULT_STRATEGY,
765230b5 222 PROBE_PREFER_ASYNCHRONOUS,
d173a137 223 PROBE_FORCE_SYNCHRONOUS,
765230b5
DT
224};
225
880ffb5c
WG
226/**
227 * struct device_driver - The basic device driver structure
228 * @name: Name of the device driver.
229 * @bus: The bus which the device of this driver belongs to.
230 * @owner: The module owner.
231 * @mod_name: Used for built-in modules.
232 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
765230b5 233 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
880ffb5c 234 * @of_match_table: The open firmware table.
06f64c8f 235 * @acpi_match_table: The ACPI match table.
880ffb5c
WG
236 * @probe: Called to query the existence of a specific device,
237 * whether this driver can work with it, and bind the driver
238 * to a specific device.
239 * @remove: Called when the device is removed from the system to
240 * unbind a device from this driver.
241 * @shutdown: Called at shut-down time to quiesce the device.
242 * @suspend: Called to put the device to sleep mode. Usually to a
243 * low power state.
244 * @resume: Called to bring a device from sleep mode.
245 * @groups: Default attributes that get created by the driver core
246 * automatically.
247 * @pm: Power management operations of the device which matched
248 * this driver.
249 * @p: Driver core's private data, no one other than the driver
250 * core can touch this.
251 *
252 * The device driver-model tracks all of the drivers known to the system.
253 * The main reason for this tracking is to enable the driver core to match
254 * up drivers with new devices. Once drivers are known objects within the
255 * system, however, a number of other things become possible. Device drivers
256 * can export information and configuration variables that are independent
257 * of any specific device.
258 */
1da177e4 259struct device_driver {
e5dd1278
GKH
260 const char *name;
261 struct bus_type *bus;
1da177e4 262
e5dd1278 263 struct module *owner;
1a6f2a75
DT
264 const char *mod_name; /* used for built-in modules */
265
266 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
765230b5 267 enum probe_type probe_type;
1da177e4 268
597b9d1e 269 const struct of_device_id *of_match_table;
06f64c8f 270 const struct acpi_device_id *acpi_match_table;
597b9d1e 271
d462943a
GKH
272 int (*probe) (struct device *dev);
273 int (*remove) (struct device *dev);
274 void (*shutdown) (struct device *dev);
275 int (*suspend) (struct device *dev, pm_message_t state);
276 int (*resume) (struct device *dev);
a4dbd674 277 const struct attribute_group **groups;
e5dd1278 278
8150f32b 279 const struct dev_pm_ops *pm;
1eede070 280
e5dd1278 281 struct driver_private *p;
1da177e4
LT
282};
283
284
d462943a
GKH
285extern int __must_check driver_register(struct device_driver *drv);
286extern void driver_unregister(struct device_driver *drv);
1da177e4 287
d462943a
GKH
288extern struct device_driver *driver_find(const char *name,
289 struct bus_type *bus);
d779249e 290extern int driver_probe_done(void);
b23530eb 291extern void wait_for_device_probe(void);
216773a7 292
1da177e4 293
405ae7d3 294/* sysfs interface for exporting driver attributes */
1da177e4
LT
295
296struct driver_attribute {
d462943a
GKH
297 struct attribute attr;
298 ssize_t (*show)(struct device_driver *driver, char *buf);
299 ssize_t (*store)(struct device_driver *driver, const char *buf,
300 size_t count);
1da177e4
LT
301};
302
ced321bf
GKH
303#define DRIVER_ATTR(_name, _mode, _show, _store) \
304 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
305#define DRIVER_ATTR_RW(_name) \
306 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
307#define DRIVER_ATTR_RO(_name) \
308 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
1130c55c
GKH
309#define DRIVER_ATTR_WO(_name) \
310 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
1da177e4 311
d462943a 312extern int __must_check driver_create_file(struct device_driver *driver,
099c2f21 313 const struct driver_attribute *attr);
d462943a 314extern void driver_remove_file(struct device_driver *driver,
099c2f21 315 const struct driver_attribute *attr);
1da177e4 316
d462943a
GKH
317extern int __must_check driver_for_each_device(struct device_driver *drv,
318 struct device *start,
319 void *data,
320 int (*fn)(struct device *dev,
321 void *));
322struct device *driver_find_device(struct device_driver *drv,
323 struct device *start, void *data,
324 int (*match)(struct device *dev, void *data));
fae3cd00 325
ca22e56d
KS
326/**
327 * struct subsys_interface - interfaces to device functions
2eda013f
RD
328 * @name: name of the device function
329 * @subsys: subsytem of the devices to attach to
330 * @node: the list of functions registered at the subsystem
331 * @add_dev: device hookup to device function handler
332 * @remove_dev: device hookup to device function handler
ca22e56d
KS
333 *
334 * Simple interfaces attached to a subsystem. Multiple interfaces can
335 * attach to a subsystem and its devices. Unlike drivers, they do not
336 * exclusively claim or control devices. Interfaces usually represent
337 * a specific functionality of a subsystem/class of devices.
338 */
339struct subsys_interface {
340 const char *name;
341 struct bus_type *subsys;
342 struct list_head node;
343 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
71db87ba 344 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
ca22e56d
KS
345};
346
347int subsys_interface_register(struct subsys_interface *sif);
348void subsys_interface_unregister(struct subsys_interface *sif);
349
350int subsys_system_register(struct bus_type *subsys,
351 const struct attribute_group **groups);
d73ce004
TH
352int subsys_virtual_register(struct bus_type *subsys,
353 const struct attribute_group **groups);
ca22e56d 354
880ffb5c
WG
355/**
356 * struct class - device classes
357 * @name: Name of the class.
358 * @owner: The module owner.
359 * @class_attrs: Default attributes of this class.
d05a6f96 360 * @dev_groups: Default attributes of the devices that belong to the class.
880ffb5c
WG
361 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
362 * @dev_uevent: Called when a device is added, removed from this class, or a
363 * few other things that generate uevents to add the environment
364 * variables.
365 * @devnode: Callback to provide the devtmpfs.
366 * @class_release: Called to release this class.
367 * @dev_release: Called to release the device.
368 * @suspend: Used to put the device to sleep mode, usually to a low power
369 * state.
370 * @resume: Used to bring the device from the sleep mode.
371 * @ns_type: Callbacks so sysfs can detemine namespaces.
372 * @namespace: Namespace of the device belongs to this class.
373 * @pm: The default device power management operations of this class.
374 * @p: The private data of the driver core, no one other than the
375 * driver core can touch this.
376 *
377 * A class is a higher-level view of a device that abstracts out low-level
378 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
379 * at the class level, they are all simply disks. Classes allow user space
380 * to work with devices based on what they do, rather than how they are
381 * connected or how they work.
1da177e4
LT
382 */
383struct class {
d462943a
GKH
384 const char *name;
385 struct module *owner;
1da177e4 386
d462943a 387 struct class_attribute *class_attrs;
d05a6f96 388 const struct attribute_group **dev_groups;
e105b8bf 389 struct kobject *dev_kobj;
1da177e4 390
d462943a 391 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
2c9ede55 392 char *(*devnode)(struct device *dev, umode_t *mode);
1da177e4 393
d462943a
GKH
394 void (*class_release)(struct class *class);
395 void (*dev_release)(struct device *dev);
7c8265f5 396
d462943a
GKH
397 int (*suspend)(struct device *dev, pm_message_t state);
398 int (*resume)(struct device *dev);
1eede070 399
bc451f20
EB
400 const struct kobj_ns_type_operations *ns_type;
401 const void *(*namespace)(struct device *dev);
402
8150f32b
DT
403 const struct dev_pm_ops *pm;
404
6b6e39a6 405 struct subsys_private *p;
1da177e4
LT
406};
407
5a3ceb86
TH
408struct class_dev_iter {
409 struct klist_iter ki;
410 const struct device_type *type;
411};
412
e105b8bf
DW
413extern struct kobject *sysfs_dev_block_kobj;
414extern struct kobject *sysfs_dev_char_kobj;
d2a3b914
MW
415extern int __must_check __class_register(struct class *class,
416 struct lock_class_key *key);
d462943a 417extern void class_unregister(struct class *class);
d2a3b914
MW
418
419/* This is a #define to keep the compiler from merging different
420 * instances of the __key variable */
421#define class_register(class) \
422({ \
423 static struct lock_class_key __key; \
424 __class_register(class, &__key); \
425})
426
46227094
JD
427struct class_compat;
428struct class_compat *class_compat_register(const char *name);
429void class_compat_unregister(struct class_compat *cls);
430int class_compat_create_link(struct class_compat *cls, struct device *dev,
431 struct device *device_link);
432void class_compat_remove_link(struct class_compat *cls, struct device *dev,
433 struct device *device_link);
434
7cd9c9bb
GKH
435extern void class_dev_iter_init(struct class_dev_iter *iter,
436 struct class *class,
437 struct device *start,
438 const struct device_type *type);
5a3ceb86
TH
439extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
440extern void class_dev_iter_exit(struct class_dev_iter *iter);
441
93562b53
GKH
442extern int class_for_each_device(struct class *class, struct device *start,
443 void *data,
fd04897b 444 int (*fn)(struct device *dev, void *data));
695794ae 445extern struct device *class_find_device(struct class *class,
9f3b795a
MM
446 struct device *start, const void *data,
447 int (*match)(struct device *, const void *));
1da177e4
LT
448
449struct class_attribute {
d462943a 450 struct attribute attr;
28812fe1
AK
451 ssize_t (*show)(struct class *class, struct class_attribute *attr,
452 char *buf);
453 ssize_t (*store)(struct class *class, struct class_attribute *attr,
454 const char *buf, size_t count);
1da177e4
LT
455};
456
ced321bf
GKH
457#define CLASS_ATTR(_name, _mode, _show, _store) \
458 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
459#define CLASS_ATTR_RW(_name) \
460 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
461#define CLASS_ATTR_RO(_name) \
462 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
1da177e4 463
58292cbe
TH
464extern int __must_check class_create_file_ns(struct class *class,
465 const struct class_attribute *attr,
466 const void *ns);
467extern void class_remove_file_ns(struct class *class,
468 const struct class_attribute *attr,
469 const void *ns);
470
471static inline int __must_check class_create_file(struct class *class,
472 const struct class_attribute *attr)
473{
474 return class_create_file_ns(class, attr, NULL);
475}
476
477static inline void class_remove_file(struct class *class,
478 const struct class_attribute *attr)
479{
480 return class_remove_file_ns(class, attr, NULL);
481}
1da177e4 482
869dfc87 483/* Simple class attribute that is just a static string */
869dfc87
AK
484struct class_attribute_string {
485 struct class_attribute attr;
486 char *str;
487};
488
489/* Currently read-only only */
490#define _CLASS_ATTR_STRING(_name, _mode, _str) \
491 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
492#define CLASS_ATTR_STRING(_name, _mode, _str) \
493 struct class_attribute_string class_attr_##_name = \
494 _CLASS_ATTR_STRING(_name, _mode, _str)
495
496extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
497 char *buf);
498
1da177e4
LT
499struct class_interface {
500 struct list_head node;
501 struct class *class;
502
c47ed219
GKH
503 int (*add_dev) (struct device *, struct class_interface *);
504 void (*remove_dev) (struct device *, struct class_interface *);
1da177e4
LT
505};
506
4a7fb636 507extern int __must_check class_interface_register(struct class_interface *);
1da177e4
LT
508extern void class_interface_unregister(struct class_interface *);
509
d2a3b914
MW
510extern struct class * __must_check __class_create(struct module *owner,
511 const char *name,
512 struct lock_class_key *key);
e9ba6365 513extern void class_destroy(struct class *cls);
e9ba6365 514
d2a3b914
MW
515/* This is a #define to keep the compiler from merging different
516 * instances of the __key variable */
517#define class_create(owner, name) \
518({ \
519 static struct lock_class_key __key; \
520 __class_create(owner, name, &__key); \
521})
522
414264f9
KS
523/*
524 * The type of device, "struct device" is embedded in. A class
525 * or bus can contain devices of different types
526 * like "partitions" and "disks", "mouse" and "event".
527 * This identifies the device type and carries type-specific
528 * information, equivalent to the kobj_type of a kobject.
529 * If "name" is specified, the uevent will contain it in
530 * the DEVTYPE variable.
531 */
f9f852df 532struct device_type {
414264f9 533 const char *name;
a4dbd674 534 const struct attribute_group **groups;
7eff2e7a 535 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
3c2670e6 536 char *(*devnode)(struct device *dev, umode_t *mode,
4e4098a3 537 kuid_t *uid, kgid_t *gid);
f9f852df 538 void (*release)(struct device *dev);
1eede070 539
8150f32b 540 const struct dev_pm_ops *pm;
f9f852df
KS
541};
542
a7fd6706
KS
543/* interface for exporting device attributes */
544struct device_attribute {
545 struct attribute attr;
546 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
547 char *buf);
548 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
549 const char *buf, size_t count);
550};
551
ca22e56d
KS
552struct dev_ext_attribute {
553 struct device_attribute attr;
554 void *var;
555};
556
557ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
558 char *buf);
559ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
560 const char *buf, size_t count);
561ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
562 char *buf);
563ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
564 const char *buf, size_t count);
91872392
BP
565ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
566 char *buf);
567ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
568 const char *buf, size_t count);
a7fd6706 569
d462943a 570#define DEVICE_ATTR(_name, _mode, _show, _store) \
ca22e56d 571 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
ced321bf
GKH
572#define DEVICE_ATTR_RW(_name) \
573 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
574#define DEVICE_ATTR_RO(_name) \
575 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
1130c55c
GKH
576#define DEVICE_ATTR_WO(_name) \
577 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
ca22e56d
KS
578#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
579 struct dev_ext_attribute dev_attr_##_name = \
580 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
581#define DEVICE_INT_ATTR(_name, _mode, _var) \
582 struct dev_ext_attribute dev_attr_##_name = \
94758185 583 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
91872392
BP
584#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
585 struct dev_ext_attribute dev_attr_##_name = \
586 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
356c05d5
AS
587#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
588 struct device_attribute dev_attr_##_name = \
589 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
a7fd6706 590
b9d4e714
GKH
591extern int device_create_file(struct device *device,
592 const struct device_attribute *entry);
d462943a 593extern void device_remove_file(struct device *dev,
26579ab7 594 const struct device_attribute *attr);
6b0afc2a
TH
595extern bool device_remove_file_self(struct device *dev,
596 const struct device_attribute *attr);
2589f188 597extern int __must_check device_create_bin_file(struct device *dev,
66ecb92b 598 const struct bin_attribute *attr);
2589f188 599extern void device_remove_bin_file(struct device *dev,
66ecb92b 600 const struct bin_attribute *attr);
9ac7849e
TH
601
602/* device resource management */
603typedef void (*dr_release_t)(struct device *dev, void *res);
604typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
605
606#ifdef CONFIG_DEBUG_DEVRES
7c683941
DW
607extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
608 int nid, const char *name);
9ac7849e 609#define devres_alloc(release, size, gfp) \
7c683941
DW
610 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
611#define devres_alloc_node(release, size, gfp, nid) \
612 __devres_alloc_node(release, size, gfp, nid, #release)
9ac7849e 613#else
7c683941
DW
614extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
615 int nid);
616static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
617{
618 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
619}
9ac7849e 620#endif
7c683941 621
bddb1b90
ML
622extern void devres_for_each_res(struct device *dev, dr_release_t release,
623 dr_match_t match, void *match_data,
624 void (*fn)(struct device *, void *, void *),
625 void *data);
9ac7849e
TH
626extern void devres_free(void *res);
627extern void devres_add(struct device *dev, void *res);
d462943a 628extern void *devres_find(struct device *dev, dr_release_t release,
9ac7849e 629 dr_match_t match, void *match_data);
d462943a
GKH
630extern void *devres_get(struct device *dev, void *new_res,
631 dr_match_t match, void *match_data);
632extern void *devres_remove(struct device *dev, dr_release_t release,
633 dr_match_t match, void *match_data);
9ac7849e
TH
634extern int devres_destroy(struct device *dev, dr_release_t release,
635 dr_match_t match, void *match_data);
d926d0e4
MB
636extern int devres_release(struct device *dev, dr_release_t release,
637 dr_match_t match, void *match_data);
9ac7849e
TH
638
639/* devres group */
640extern void * __must_check devres_open_group(struct device *dev, void *id,
641 gfp_t gfp);
642extern void devres_close_group(struct device *dev, void *id);
643extern void devres_remove_group(struct device *dev, void *id);
644extern int devres_release_group(struct device *dev, void *id);
645
64c862a8
JP
646/* managed devm_k.alloc/kfree for device drivers */
647extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
8db14860
NI
648extern __printf(3, 0)
649char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
650 va_list ap);
bef59c50
GU
651extern __printf(3, 4)
652char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
64c862a8
JP
653static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
654{
655 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
656}
657static inline void *devm_kmalloc_array(struct device *dev,
658 size_t n, size_t size, gfp_t flags)
659{
660 if (size != 0 && n > SIZE_MAX / size)
661 return NULL;
662 return devm_kmalloc(dev, n * size, flags);
663}
664static inline void *devm_kcalloc(struct device *dev,
665 size_t n, size_t size, gfp_t flags)
666{
667 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
668}
9ac7849e 669extern void devm_kfree(struct device *dev, void *p);
e31108ca 670extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
3046365b
SP
671extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
672 gfp_t gfp);
9ac7849e 673
43339bed
EB
674extern unsigned long devm_get_free_pages(struct device *dev,
675 gfp_t gfp_mask, unsigned int order);
676extern void devm_free_pages(struct device *dev, unsigned long addr);
9ac7849e 677
75096579 678void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
72f8c0bf 679
d6b0c580
DT
680/* allows to add/remove a custom action to devres stack */
681int devm_add_action(struct device *dev, void (*action)(void *), void *data);
682void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
683
6b7b6510
FT
684struct device_dma_parameters {
685 /*
686 * a low level driver may set these to teach IOMMU code about
687 * sg limitations.
688 */
689 unsigned int max_segment_size;
690 unsigned long segment_boundary_mask;
691};
692
880ffb5c
WG
693/**
694 * struct device - The basic device structure
695 * @parent: The device's "parent" device, the device to which it is attached.
696 * In most cases, a parent device is some sort of bus or host
697 * controller. If parent is NULL, the device, is a top-level device,
698 * which is not usually what you want.
699 * @p: Holds the private data of the driver core portions of the device.
700 * See the comment of the struct device_private for detail.
701 * @kobj: A top-level, abstract class from which other classes are derived.
702 * @init_name: Initial name of the device.
703 * @type: The type of device.
704 * This identifies the device type and carries type-specific
705 * information.
706 * @mutex: Mutex to synchronize calls to its driver.
707 * @bus: Type of bus device is on.
708 * @driver: Which driver has allocated this
709 * @platform_data: Platform data specific to the device.
710 * Example: For devices on custom boards, as typical of embedded
711 * and SOC based hardware, Linux often uses platform_data to point
712 * to board-specific structures describing devices and how they
713 * are wired. That can include what ports are available, chip
714 * variants, which GPIO pins act in what additional roles, and so
715 * on. This shrinks the "Board Support Packages" (BSPs) and
716 * minimizes board-specific #ifdefs in drivers.
1bb6c08a 717 * @driver_data: Private pointer for driver specific info.
880ffb5c
WG
718 * @power: For device power management.
719 * See Documentation/power/devices.txt for details.
564b905a 720 * @pm_domain: Provide callbacks that are executed during system suspend,
880ffb5c
WG
721 * hibernation, system resume and during runtime PM transitions
722 * along with subsystem-level and driver-level callbacks.
ab78029e
LW
723 * @pins: For device pin management.
724 * See Documentation/pinctrl.txt for details.
4a7cc831 725 * @msi_list: Hosts MSI descriptors
f1421db8 726 * @msi_domain: The generic MSI domain this device is using.
880ffb5c
WG
727 * @numa_node: NUMA node this device is close to.
728 * @dma_mask: Dma mask (if dma'ble device).
729 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
730 * hardware supports 64-bit addresses for consistent allocations
731 * such descriptors.
8febcaa2 732 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
880ffb5c
WG
733 * @dma_parms: A low level driver may set these to teach IOMMU code about
734 * segment limitations.
735 * @dma_pools: Dma pools (if dma'ble device).
736 * @dma_mem: Internal for coherent mem override.
bfd63cd2 737 * @cma_area: Contiguous memory area for dma allocations
880ffb5c
WG
738 * @archdata: For arch-specific additions.
739 * @of_node: Associated device tree node.
ce793486 740 * @fwnode: Associated device node supplied by platform firmware.
880ffb5c 741 * @devt: For creating the sysfs "dev".
2eda013f 742 * @id: device instance
880ffb5c
WG
743 * @devres_lock: Spinlock to protect the resource of the device.
744 * @devres_head: The resources list of the device.
745 * @knode_class: The node used to add the device to the class list.
746 * @class: The class of the device.
747 * @groups: Optional attribute groups.
748 * @release: Callback to free the device after all references have
749 * gone away. This should be set by the allocator of the
750 * device (i.e. the bus driver that discovered the device).
bfd63cd2 751 * @iommu_group: IOMMU group the device belongs to.
880ffb5c 752 *
4f3549d7
RW
753 * @offline_disabled: If set, the device is permanently online.
754 * @offline: Set after successful invocation of bus type's .offline().
880ffb5c
WG
755 *
756 * At the lowest level, every device in a Linux system is represented by an
757 * instance of struct device. The device structure contains the information
758 * that the device model core needs to model the system. Most subsystems,
759 * however, track additional information about the devices they host. As a
760 * result, it is rare for devices to be represented by bare device structures;
761 * instead, that structure, like kobject structures, is usually embedded within
762 * a higher-level representation of the device.
763 */
1da177e4 764struct device {
49a4ec18 765 struct device *parent;
1da177e4 766
fb069a5d
GKH
767 struct device_private *p;
768
1da177e4 769 struct kobject kobj;
c906a48a 770 const char *init_name; /* initial name of the device */
aed65af1 771 const struct device_type *type;
1da177e4 772
3142788b 773 struct mutex mutex; /* mutex to synchronize calls to
af70316a 774 * its driver.
775 */
776
d462943a 777 struct bus_type *bus; /* type of bus device is on */
1da177e4
LT
778 struct device_driver *driver; /* which driver has allocated this
779 device */
e67c8562
GKH
780 void *platform_data; /* Platform specific data, device
781 core doesn't touch it */
1bb6c08a
JD
782 void *driver_data; /* Driver data, set and get with
783 dev_set/get_drvdata */
1da177e4 784 struct dev_pm_info power;
564b905a 785 struct dev_pm_domain *pm_domain;
1da177e4 786
f1421db8
MZ
787#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
788 struct irq_domain *msi_domain;
789#endif
ab78029e
LW
790#ifdef CONFIG_PINCTRL
791 struct dev_pin_info *pins;
792#endif
4a7cc831
JL
793#ifdef CONFIG_GENERIC_MSI_IRQ
794 struct list_head msi_list;
795#endif
ab78029e 796
87348136
CH
797#ifdef CONFIG_NUMA
798 int numa_node; /* NUMA node this device is close to */
799#endif
1da177e4
LT
800 u64 *dma_mask; /* dma mask (if dma'able device) */
801 u64 coherent_dma_mask;/* Like dma_mask, but for
802 alloc_coherent mappings as
803 not all hardware supports
804 64 bit addresses for consistent
805 allocations such descriptors. */
8febcaa2 806 unsigned long dma_pfn_offset;
1da177e4 807
6b7b6510
FT
808 struct device_dma_parameters *dma_parms;
809
1da177e4
LT
810 struct list_head dma_pools; /* dma pools (if dma'ble) */
811
812 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
813 override */
a2547380 814#ifdef CONFIG_DMA_CMA
c64be2bb
MS
815 struct cma *cma_area; /* contiguous memory area for dma
816 allocations */
817#endif
c6dbaef2
BH
818 /* arch specific additions */
819 struct dev_archdata archdata;
c9e358df
GL
820
821 struct device_node *of_node; /* associated device tree node */
ce793486 822 struct fwnode_handle *fwnode; /* firmware device node */
1da177e4 823
929d2fa5 824 dev_t devt; /* dev_t, creates the sysfs "dev" */
ca22e56d 825 u32 id; /* device instance */
929d2fa5 826
9ac7849e
TH
827 spinlock_t devres_lock;
828 struct list_head devres_head;
829
5a3ceb86 830 struct klist_node knode_class;
b7a3e813 831 struct class *class;
a4dbd674 832 const struct attribute_group **groups; /* optional groups */
23681e47 833
d462943a 834 void (*release)(struct device *dev);
74416e1e 835 struct iommu_group *iommu_group;
4f3549d7
RW
836
837 bool offline_disabled:1;
838 bool offline:1;
1da177e4
LT
839};
840
a4232963
LPC
841static inline struct device *kobj_to_dev(struct kobject *kobj)
842{
843 return container_of(kobj, struct device, kobj);
844}
845
9a3df1f7
AS
846/* Get the wakeup routines, which depend on struct device */
847#include <linux/pm_wakeup.h>
848
bf9ca69f 849static inline const char *dev_name(const struct device *dev)
06916639 850{
a636ee7f
PM
851 /* Use the init name until the kobject becomes available */
852 if (dev->init_name)
853 return dev->init_name;
854
1fa5ae85 855 return kobject_name(&dev->kobj);
06916639
KS
856}
857
b9075fa9
JP
858extern __printf(2, 3)
859int dev_set_name(struct device *dev, const char *name, ...);
413c239f 860
87348136
CH
861#ifdef CONFIG_NUMA
862static inline int dev_to_node(struct device *dev)
863{
864 return dev->numa_node;
865}
866static inline void set_dev_node(struct device *dev, int node)
867{
868 dev->numa_node = node;
869}
870#else
871static inline int dev_to_node(struct device *dev)
872{
873 return -1;
874}
875static inline void set_dev_node(struct device *dev, int node)
876{
877}
878#endif
879
f1421db8
MZ
880static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
881{
882#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
883 return dev->msi_domain;
884#else
885 return NULL;
886#endif
887}
888
889static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
890{
891#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
892 dev->msi_domain = d;
893#endif
894}
895
a996d010
JD
896static inline void *dev_get_drvdata(const struct device *dev)
897{
898 return dev->driver_data;
899}
900
901static inline void dev_set_drvdata(struct device *dev, void *data)
902{
903 dev->driver_data = data;
904}
905
5c095a0e
RW
906static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
907{
908 return dev ? dev->power.subsys_data : NULL;
909}
910
f67f129e
ML
911static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
912{
913 return dev->kobj.uevent_suppress;
914}
915
916static inline void dev_set_uevent_suppress(struct device *dev, int val)
917{
918 dev->kobj.uevent_suppress = val;
919}
920
d305ef5d
DR
921static inline int device_is_registered(struct device *dev)
922{
3f62e570 923 return dev->kobj.state_in_sysfs;
d305ef5d
DR
924}
925
5af84b82
RW
926static inline void device_enable_async_suspend(struct device *dev)
927{
f76b168b 928 if (!dev->power.is_prepared)
5af84b82
RW
929 dev->power.async_suspend = true;
930}
931
5a2eb858
RW
932static inline void device_disable_async_suspend(struct device *dev)
933{
f76b168b 934 if (!dev->power.is_prepared)
5a2eb858
RW
935 dev->power.async_suspend = false;
936}
937
938static inline bool device_async_suspend_enabled(struct device *dev)
939{
940 return !!dev->power.async_suspend;
941}
942
8b258cc8
RW
943static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
944{
945 dev->power.ignore_children = enable;
946}
947
feb70af0
RW
948static inline void dev_pm_syscore_device(struct device *dev, bool val)
949{
950#ifdef CONFIG_PM_SLEEP
951 dev->power.syscore = val;
952#endif
953}
954
8e9394ce
GKH
955static inline void device_lock(struct device *dev)
956{
3142788b 957 mutex_lock(&dev->mutex);
8e9394ce
GKH
958}
959
960static inline int device_trylock(struct device *dev)
961{
3142788b 962 return mutex_trylock(&dev->mutex);
8e9394ce
GKH
963}
964
965static inline void device_unlock(struct device *dev)
966{
3142788b 967 mutex_unlock(&dev->mutex);
8e9394ce
GKH
968}
969
ac801022
KRW
970static inline void device_lock_assert(struct device *dev)
971{
972 lockdep_assert_held(&dev->mutex);
973}
974
e8a51e1b
BH
975static inline struct device_node *dev_of_node(struct device *dev)
976{
977 if (!IS_ENABLED(CONFIG_OF))
978 return NULL;
979 return dev->of_node;
980}
981
1f21782e
AB
982void driver_init(void);
983
1da177e4
LT
984/*
985 * High level routines for use by the bus drivers
986 */
d462943a
GKH
987extern int __must_check device_register(struct device *dev);
988extern void device_unregister(struct device *dev);
989extern void device_initialize(struct device *dev);
990extern int __must_check device_add(struct device *dev);
991extern void device_del(struct device *dev);
992extern int device_for_each_child(struct device *dev, void *data,
993 int (*fn)(struct device *dev, void *data));
3d060aeb
AS
994extern int device_for_each_child_reverse(struct device *dev, void *data,
995 int (*fn)(struct device *dev, void *data));
d462943a
GKH
996extern struct device *device_find_child(struct device *dev, void *data,
997 int (*match)(struct device *dev, void *data));
6937e8f8 998extern int device_rename(struct device *dev, const char *new_name);
ffa6a705
CH
999extern int device_move(struct device *dev, struct device *new_parent,
1000 enum dpm_order dpm_order);
e454cea2 1001extern const char *device_get_devnode(struct device *dev,
4e4098a3 1002 umode_t *mode, kuid_t *uid, kgid_t *gid,
3c2670e6 1003 const char **tmp);
1da177e4 1004
4f3549d7
RW
1005static inline bool device_supports_offline(struct device *dev)
1006{
1007 return dev->bus && dev->bus->offline && dev->bus->online;
1008}
1009
1010extern void lock_device_hotplug(void);
1011extern void unlock_device_hotplug(void);
5e33bc41 1012extern int lock_device_hotplug_sysfs(void);
4f3549d7
RW
1013extern int device_offline(struct device *dev);
1014extern int device_online(struct device *dev);
97badf87
RW
1015extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1016extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1017
0aa0dc41
MM
1018/*
1019 * Root device objects for grouping under /sys/devices
1020 */
1021extern struct device *__root_device_register(const char *name,
1022 struct module *owner);
eb5589a8 1023
33ac1257 1024/* This is a macro to avoid include problems with THIS_MODULE */
eb5589a8
PG
1025#define root_device_register(name) \
1026 __root_device_register(name, THIS_MODULE)
1027
0aa0dc41
MM
1028extern void root_device_unregister(struct device *root);
1029
a5b8b1ad
MB
1030static inline void *dev_get_platdata(const struct device *dev)
1031{
1032 return dev->platform_data;
1033}
1034
1da177e4
LT
1035/*
1036 * Manual binding of a device to driver. See drivers/base/bus.c
1037 * for information on use.
1038 */
f86db396 1039extern int __must_check device_bind_driver(struct device *dev);
d462943a
GKH
1040extern void device_release_driver(struct device *dev);
1041extern int __must_check device_attach(struct device *dev);
f86db396 1042extern int __must_check driver_attach(struct device_driver *drv);
765230b5 1043extern void device_initial_probe(struct device *dev);
f86db396 1044extern int __must_check device_reprobe(struct device *dev);
1da177e4 1045
23681e47
GKH
1046/*
1047 * Easy functions for dynamically creating devices on the fly
1048 */
8db14860
NI
1049extern __printf(5, 0)
1050struct device *device_create_vargs(struct class *cls, struct device *parent,
1051 dev_t devt, void *drvdata,
1052 const char *fmt, va_list vargs);
b9075fa9
JP
1053extern __printf(5, 6)
1054struct device *device_create(struct class *cls, struct device *parent,
1055 dev_t devt, void *drvdata,
1056 const char *fmt, ...);
39ef3112
GR
1057extern __printf(6, 7)
1058struct device *device_create_with_groups(struct class *cls,
1059 struct device *parent, dev_t devt, void *drvdata,
1060 const struct attribute_group **groups,
1061 const char *fmt, ...);
23681e47 1062extern void device_destroy(struct class *cls, dev_t devt);
1da177e4 1063
1da177e4
LT
1064/*
1065 * Platform "fixup" functions - allow the platform to have their say
1066 * about devices and actions that the general device layer doesn't
1067 * know about.
1068 */
1069/* Notify platform of device discovery */
d462943a 1070extern int (*platform_notify)(struct device *dev);
1da177e4 1071
d462943a 1072extern int (*platform_notify_remove)(struct device *dev);
1da177e4
LT
1073
1074
880ffb5c 1075/*
1da177e4
LT
1076 * get_device - atomically increment the reference count for the device.
1077 *
1078 */
d462943a
GKH
1079extern struct device *get_device(struct device *dev);
1080extern void put_device(struct device *dev);
1da177e4 1081
2b2af54a
KS
1082#ifdef CONFIG_DEVTMPFS
1083extern int devtmpfs_create_node(struct device *dev);
1084extern int devtmpfs_delete_node(struct device *dev);
073120cc 1085extern int devtmpfs_mount(const char *mntdir);
2b2af54a
KS
1086#else
1087static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1088static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1089static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1090#endif
1091
116f232b 1092/* drivers/base/power/shutdown.c */
1da177e4
LT
1093extern void device_shutdown(void);
1094
1da177e4 1095/* debugging and troubleshooting/diagnostic helpers. */
bf9ca69f 1096extern const char *dev_driver_string(const struct device *dev);
99bcf217
JP
1097
1098
1099#ifdef CONFIG_PRINTK
1100
0a18b050
JP
1101extern __printf(3, 0)
1102int dev_vprintk_emit(int level, const struct device *dev,
1103 const char *fmt, va_list args);
05e4e5b8
JP
1104extern __printf(3, 4)
1105int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
798efc60 1106
b9075fa9 1107extern __printf(3, 4)
d1f1052c
JP
1108void dev_printk(const char *level, const struct device *dev,
1109 const char *fmt, ...);
b9075fa9 1110extern __printf(2, 3)
d1f1052c 1111void dev_emerg(const struct device *dev, const char *fmt, ...);
b9075fa9 1112extern __printf(2, 3)
d1f1052c 1113void dev_alert(const struct device *dev, const char *fmt, ...);
b9075fa9 1114extern __printf(2, 3)
d1f1052c 1115void dev_crit(const struct device *dev, const char *fmt, ...);
b9075fa9 1116extern __printf(2, 3)
d1f1052c 1117void dev_err(const struct device *dev, const char *fmt, ...);
b9075fa9 1118extern __printf(2, 3)
d1f1052c 1119void dev_warn(const struct device *dev, const char *fmt, ...);
b9075fa9 1120extern __printf(2, 3)
d1f1052c 1121void dev_notice(const struct device *dev, const char *fmt, ...);
b9075fa9 1122extern __printf(2, 3)
d1f1052c 1123void _dev_info(const struct device *dev, const char *fmt, ...);
99bcf217
JP
1124
1125#else
1126
0a18b050
JP
1127static inline __printf(3, 0)
1128int dev_vprintk_emit(int level, const struct device *dev,
1129 const char *fmt, va_list args)
05e4e5b8
JP
1130{ return 0; }
1131static inline __printf(3, 4)
1132int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1133{ return 0; }
1134
d1f1052c
JP
1135static inline void __dev_printk(const char *level, const struct device *dev,
1136 struct va_format *vaf)
1137{}
b9075fa9 1138static inline __printf(3, 4)
d1f1052c
JP
1139void dev_printk(const char *level, const struct device *dev,
1140 const char *fmt, ...)
1141{}
b9075fa9
JP
1142
1143static inline __printf(2, 3)
d1f1052c
JP
1144void dev_emerg(const struct device *dev, const char *fmt, ...)
1145{}
b9075fa9 1146static inline __printf(2, 3)
d1f1052c
JP
1147void dev_crit(const struct device *dev, const char *fmt, ...)
1148{}
b9075fa9 1149static inline __printf(2, 3)
d1f1052c
JP
1150void dev_alert(const struct device *dev, const char *fmt, ...)
1151{}
b9075fa9 1152static inline __printf(2, 3)
d1f1052c
JP
1153void dev_err(const struct device *dev, const char *fmt, ...)
1154{}
b9075fa9 1155static inline __printf(2, 3)
d1f1052c
JP
1156void dev_warn(const struct device *dev, const char *fmt, ...)
1157{}
b9075fa9 1158static inline __printf(2, 3)
d1f1052c
JP
1159void dev_notice(const struct device *dev, const char *fmt, ...)
1160{}
b9075fa9 1161static inline __printf(2, 3)
d1f1052c
JP
1162void _dev_info(const struct device *dev, const char *fmt, ...)
1163{}
99bcf217
JP
1164
1165#endif
1166
6f586e66
HD
1167/*
1168 * Stupid hackaround for existing uses of non-printk uses dev_info
1169 *
1170 * Note that the definition of dev_info below is actually _dev_info
1171 * and a macro is used to avoid redefining dev_info
1172 */
1173
1174#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1175
1176#if defined(CONFIG_DYNAMIC_DEBUG)
1177#define dev_dbg(dev, format, ...) \
1178do { \
1179 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1180} while (0)
1181#elif defined(DEBUG)
1182#define dev_dbg(dev, format, arg...) \
1183 dev_printk(KERN_DEBUG, dev, format, ##arg)
1184#else
1185#define dev_dbg(dev, format, arg...) \
1186({ \
1187 if (0) \
1188 dev_printk(KERN_DEBUG, dev, format, ##arg); \
6f586e66
HD
1189})
1190#endif
1191
e135303b
JP
1192#ifdef CONFIG_PRINTK
1193#define dev_level_once(dev_level, dev, fmt, ...) \
1194do { \
1195 static bool __print_once __read_mostly; \
1196 \
1197 if (!__print_once) { \
1198 __print_once = true; \
1199 dev_level(dev, fmt, ##__VA_ARGS__); \
1200 } \
1201} while (0)
1202#else
1203#define dev_level_once(dev_level, dev, fmt, ...) \
1204do { \
1205 if (0) \
1206 dev_level(dev, fmt, ##__VA_ARGS__); \
1207} while (0)
1208#endif
1209
1210#define dev_emerg_once(dev, fmt, ...) \
1211 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1212#define dev_alert_once(dev, fmt, ...) \
1213 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1214#define dev_crit_once(dev, fmt, ...) \
1215 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1216#define dev_err_once(dev, fmt, ...) \
1217 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1218#define dev_warn_once(dev, fmt, ...) \
1219 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1220#define dev_notice_once(dev, fmt, ...) \
1221 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1222#define dev_info_once(dev, fmt, ...) \
1223 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1224#define dev_dbg_once(dev, fmt, ...) \
a2a15d54 1225 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
e135303b 1226
6ca04593
HD
1227#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1228do { \
1229 static DEFINE_RATELIMIT_STATE(_rs, \
1230 DEFAULT_RATELIMIT_INTERVAL, \
1231 DEFAULT_RATELIMIT_BURST); \
1232 if (__ratelimit(&_rs)) \
1233 dev_level(dev, fmt, ##__VA_ARGS__); \
1234} while (0)
1235
1236#define dev_emerg_ratelimited(dev, fmt, ...) \
1237 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1238#define dev_alert_ratelimited(dev, fmt, ...) \
1239 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1240#define dev_crit_ratelimited(dev, fmt, ...) \
1241 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1242#define dev_err_ratelimited(dev, fmt, ...) \
1243 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1244#define dev_warn_ratelimited(dev, fmt, ...) \
1245 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1246#define dev_notice_ratelimited(dev, fmt, ...) \
1247 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1248#define dev_info_ratelimited(dev, fmt, ...) \
1249 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
8ef2d651
DK
1250#if defined(CONFIG_DYNAMIC_DEBUG)
1251/* descriptor check is first to prevent flooding with "callbacks suppressed" */
6ca04593 1252#define dev_dbg_ratelimited(dev, fmt, ...) \
6f586e66
HD
1253do { \
1254 static DEFINE_RATELIMIT_STATE(_rs, \
1255 DEFAULT_RATELIMIT_INTERVAL, \
1256 DEFAULT_RATELIMIT_BURST); \
1257 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1258 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1259 __ratelimit(&_rs)) \
8ef2d651
DK
1260 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1261 ##__VA_ARGS__); \
1262} while (0)
1263#elif defined(DEBUG)
1264#define dev_dbg_ratelimited(dev, fmt, ...) \
1265do { \
1266 static DEFINE_RATELIMIT_STATE(_rs, \
1267 DEFAULT_RATELIMIT_INTERVAL, \
1268 DEFAULT_RATELIMIT_BURST); \
1269 if (__ratelimit(&_rs)) \
1270 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
99bcf217 1271} while (0)
1da177e4 1272#else
6f586e66
HD
1273#define dev_dbg_ratelimited(dev, fmt, ...) \
1274 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1da177e4
LT
1275#endif
1276
aebdc3b4
DB
1277#ifdef VERBOSE_DEBUG
1278#define dev_vdbg dev_dbg
1279#else
99bcf217
JP
1280#define dev_vdbg(dev, format, arg...) \
1281({ \
1282 if (0) \
1283 dev_printk(KERN_DEBUG, dev, format, ##arg); \
99bcf217 1284})
aebdc3b4
DB
1285#endif
1286
e6139662 1287/*
3eae1367
BH
1288 * dev_WARN*() acts like dev_printk(), but with the key difference of
1289 * using WARN/WARN_ONCE to include file/line information and a backtrace.
e6139662
AV
1290 */
1291#define dev_WARN(dev, format, arg...) \
3eae1367 1292 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
e6139662 1293
bcdd323b 1294#define dev_WARN_ONCE(dev, condition, format, arg...) \
3eae1367
BH
1295 WARN_ONCE(condition, "%s %s: " format, \
1296 dev_driver_string(dev), dev_name(dev), ## arg)
bcdd323b 1297
1da177e4
LT
1298/* Create alias, so I can be autoloaded. */
1299#define MODULE_ALIAS_CHARDEV(major,minor) \
1300 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1301#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1302 MODULE_ALIAS("char-major-" __stringify(major) "-*")
e52eec13
AK
1303
1304#ifdef CONFIG_SYSFS_DEPRECATED
1305extern long sysfs_deprecated;
1306#else
1307#define sysfs_deprecated 0
1308#endif
1309
907d0ed1
LPC
1310/**
1311 * module_driver() - Helper macro for drivers that don't do anything
1312 * special in module init/exit. This eliminates a lot of boilerplate.
1313 * Each module may only use this macro once, and calling it replaces
1314 * module_init() and module_exit().
1315 *
2eda013f
RD
1316 * @__driver: driver name
1317 * @__register: register function for this driver type
1318 * @__unregister: unregister function for this driver type
cd494618 1319 * @...: Additional arguments to be passed to __register and __unregister.
2eda013f 1320 *
907d0ed1
LPC
1321 * Use this macro to construct bus specific macros for registering
1322 * drivers, and do not use it on its own.
1323 */
cd494618 1324#define module_driver(__driver, __register, __unregister, ...) \
907d0ed1
LPC
1325static int __init __driver##_init(void) \
1326{ \
cd494618 1327 return __register(&(__driver) , ##__VA_ARGS__); \
907d0ed1
LPC
1328} \
1329module_init(__driver##_init); \
1330static void __exit __driver##_exit(void) \
1331{ \
cd494618 1332 __unregister(&(__driver) , ##__VA_ARGS__); \
907d0ed1
LPC
1333} \
1334module_exit(__driver##_exit);
1335
f309d444
PG
1336/**
1337 * builtin_driver() - Helper macro for drivers that don't do anything
1338 * special in init and have no exit. This eliminates some boilerplate.
1339 * Each driver may only use this macro once, and calling it replaces
1340 * device_initcall (or in some cases, the legacy __initcall). This is
1341 * meant to be a direct parallel of module_driver() above but without
1342 * the __exit stuff that is not used for builtin cases.
1343 *
1344 * @__driver: driver name
1345 * @__register: register function for this driver type
1346 * @...: Additional arguments to be passed to __register
1347 *
1348 * Use this macro to construct bus specific macros for registering
1349 * drivers, and do not use it on its own.
1350 */
1351#define builtin_driver(__driver, __register, ...) \
1352static int __init __driver##_init(void) \
1353{ \
1354 return __register(&(__driver) , ##__VA_ARGS__); \
1355} \
1356device_initcall(__driver##_init);
1357
1da177e4 1358#endif /* _DEVICE_H_ */
This page took 1.103427 seconds and 5 git commands to generate.