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