]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/device.h
Merge tag 'perf-urgent-for-mingo' of git://git.kernel.org/pub/scm/linux/kernel/git...
[mirror_ubuntu-jammy-kernel.git] / include / linux / device.h
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
45 struct bus_attribute {
46 struct attribute attr;
47 ssize_t (*show)(struct bus_type *bus, char *buf);
48 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
49 };
50
51 #define BUS_ATTR(_name, _mode, _show, _store) \
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)
57
58 extern int __must_check bus_create_file(struct bus_type *,
59 struct bus_attribute *);
60 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
61
62 /**
63 * struct bus_type - The bus type of the device
64 *
65 * @name: The name of the bus.
66 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
67 * @dev_root: Default device to use as the parent.
68 * @dev_attrs: Default attributes of the devices on the bus.
69 * @bus_groups: Default attributes of the bus.
70 * @dev_groups: Default attributes of the devices on the bus.
71 * @drv_groups: Default attributes of the device drivers on the bus.
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.
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 *
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.
89 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
90 * driver implementations to a bus and allow the driver to do
91 * bus-specific setup
92 * @p: The private data of the driver core, only the driver core can
93 * touch this.
94 * @lock_key: Lock class key for use by the lock validator
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 */
105 struct bus_type {
106 const char *name;
107 const char *dev_name;
108 struct device *dev_root;
109 struct device_attribute *dev_attrs; /* use dev_groups instead */
110 const struct attribute_group **bus_groups;
111 const struct attribute_group **dev_groups;
112 const struct attribute_group **drv_groups;
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
120 int (*online)(struct device *dev);
121 int (*offline)(struct device *dev);
122
123 int (*suspend)(struct device *dev, pm_message_t state);
124 int (*resume)(struct device *dev);
125
126 const struct dev_pm_ops *pm;
127
128 const struct iommu_ops *iommu_ops;
129
130 struct subsys_private *p;
131 struct lock_class_key lock_key;
132 };
133
134 extern int __must_check bus_register(struct bus_type *bus);
135
136 extern void bus_unregister(struct bus_type *bus);
137
138 extern int __must_check bus_rescan_devices(struct bus_type *bus);
139
140 /* iterator helpers for buses */
141 struct subsys_dev_iter {
142 struct klist_iter ki;
143 const struct device_type *type;
144 };
145 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
146 struct bus_type *subsys,
147 struct device *start,
148 const struct device_type *type);
149 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
150 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
151
152 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
153 int (*fn)(struct device *dev, void *data));
154 struct device *bus_find_device(struct bus_type *bus, struct device *start,
155 void *data,
156 int (*match)(struct device *dev, void *data));
157 struct device *bus_find_device_by_name(struct bus_type *bus,
158 struct device *start,
159 const char *name);
160 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
161 struct device *hint);
162 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
163 void *data, int (*fn)(struct device_driver *, void *));
164 void bus_sort_breadthfirst(struct bus_type *bus,
165 int (*compare)(const struct device *a,
166 const struct device *b));
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 */
173 struct notifier_block;
174
175 extern int bus_register_notifier(struct bus_type *bus,
176 struct notifier_block *nb);
177 extern 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
182 * with the device lock held in the core, so be careful.
183 */
184 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
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
188 bound */
189 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
190 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
191 unbound */
192 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
193 from the device */
194
195 extern struct kset *bus_get_kset(struct bus_type *bus);
196 extern struct klist *bus_get_device_klist(struct bus_type *bus);
197
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 *
204 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
205 * whether probed synchronously or asynchronously.
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.
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).
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 */
220 enum probe_type {
221 PROBE_DEFAULT_STRATEGY,
222 PROBE_PREFER_ASYNCHRONOUS,
223 PROBE_FORCE_SYNCHRONOUS,
224 };
225
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.
233 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
234 * @of_match_table: The open firmware table.
235 * @acpi_match_table: The ACPI match table.
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 */
259 struct device_driver {
260 const char *name;
261 struct bus_type *bus;
262
263 struct module *owner;
264 const char *mod_name; /* used for built-in modules */
265
266 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
267 enum probe_type probe_type;
268
269 const struct of_device_id *of_match_table;
270 const struct acpi_device_id *acpi_match_table;
271
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);
277 const struct attribute_group **groups;
278
279 const struct dev_pm_ops *pm;
280
281 struct driver_private *p;
282 };
283
284
285 extern int __must_check driver_register(struct device_driver *drv);
286 extern void driver_unregister(struct device_driver *drv);
287
288 extern struct device_driver *driver_find(const char *name,
289 struct bus_type *bus);
290 extern int driver_probe_done(void);
291 extern void wait_for_device_probe(void);
292
293
294 /* sysfs interface for exporting driver attributes */
295
296 struct driver_attribute {
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);
301 };
302
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)
309 #define DRIVER_ATTR_WO(_name) \
310 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
311
312 extern int __must_check driver_create_file(struct device_driver *driver,
313 const struct driver_attribute *attr);
314 extern void driver_remove_file(struct device_driver *driver,
315 const struct driver_attribute *attr);
316
317 extern 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 *));
322 struct device *driver_find_device(struct device_driver *drv,
323 struct device *start, void *data,
324 int (*match)(struct device *dev, void *data));
325
326 /**
327 * struct subsys_interface - interfaces to device functions
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
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 */
339 struct 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);
344 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
345 };
346
347 int subsys_interface_register(struct subsys_interface *sif);
348 void subsys_interface_unregister(struct subsys_interface *sif);
349
350 int subsys_system_register(struct bus_type *subsys,
351 const struct attribute_group **groups);
352 int subsys_virtual_register(struct bus_type *subsys,
353 const struct attribute_group **groups);
354
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.
360 * @dev_groups: Default attributes of the devices that belong to the class.
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.
382 */
383 struct class {
384 const char *name;
385 struct module *owner;
386
387 struct class_attribute *class_attrs;
388 const struct attribute_group **dev_groups;
389 struct kobject *dev_kobj;
390
391 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
392 char *(*devnode)(struct device *dev, umode_t *mode);
393
394 void (*class_release)(struct class *class);
395 void (*dev_release)(struct device *dev);
396
397 int (*suspend)(struct device *dev, pm_message_t state);
398 int (*resume)(struct device *dev);
399
400 const struct kobj_ns_type_operations *ns_type;
401 const void *(*namespace)(struct device *dev);
402
403 const struct dev_pm_ops *pm;
404
405 struct subsys_private *p;
406 };
407
408 struct class_dev_iter {
409 struct klist_iter ki;
410 const struct device_type *type;
411 };
412
413 extern struct kobject *sysfs_dev_block_kobj;
414 extern struct kobject *sysfs_dev_char_kobj;
415 extern int __must_check __class_register(struct class *class,
416 struct lock_class_key *key);
417 extern void class_unregister(struct class *class);
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
427 struct class_compat;
428 struct class_compat *class_compat_register(const char *name);
429 void class_compat_unregister(struct class_compat *cls);
430 int class_compat_create_link(struct class_compat *cls, struct device *dev,
431 struct device *device_link);
432 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
433 struct device *device_link);
434
435 extern void class_dev_iter_init(struct class_dev_iter *iter,
436 struct class *class,
437 struct device *start,
438 const struct device_type *type);
439 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
440 extern void class_dev_iter_exit(struct class_dev_iter *iter);
441
442 extern int class_for_each_device(struct class *class, struct device *start,
443 void *data,
444 int (*fn)(struct device *dev, void *data));
445 extern struct device *class_find_device(struct class *class,
446 struct device *start, const void *data,
447 int (*match)(struct device *, const void *));
448
449 struct class_attribute {
450 struct attribute attr;
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);
455 };
456
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)
463
464 extern int __must_check class_create_file_ns(struct class *class,
465 const struct class_attribute *attr,
466 const void *ns);
467 extern void class_remove_file_ns(struct class *class,
468 const struct class_attribute *attr,
469 const void *ns);
470
471 static 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
477 static 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 }
482
483 /* Simple class attribute that is just a static string */
484 struct 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
496 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
497 char *buf);
498
499 struct class_interface {
500 struct list_head node;
501 struct class *class;
502
503 int (*add_dev) (struct device *, struct class_interface *);
504 void (*remove_dev) (struct device *, struct class_interface *);
505 };
506
507 extern int __must_check class_interface_register(struct class_interface *);
508 extern void class_interface_unregister(struct class_interface *);
509
510 extern struct class * __must_check __class_create(struct module *owner,
511 const char *name,
512 struct lock_class_key *key);
513 extern void class_destroy(struct class *cls);
514
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
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 */
532 struct device_type {
533 const char *name;
534 const struct attribute_group **groups;
535 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
536 char *(*devnode)(struct device *dev, umode_t *mode,
537 kuid_t *uid, kgid_t *gid);
538 void (*release)(struct device *dev);
539
540 const struct dev_pm_ops *pm;
541 };
542
543 /* interface for exporting device attributes */
544 struct 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
552 struct dev_ext_attribute {
553 struct device_attribute attr;
554 void *var;
555 };
556
557 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
558 char *buf);
559 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
560 const char *buf, size_t count);
561 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
562 char *buf);
563 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
564 const char *buf, size_t count);
565 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
566 char *buf);
567 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
568 const char *buf, size_t count);
569
570 #define DEVICE_ATTR(_name, _mode, _show, _store) \
571 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
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)
576 #define DEVICE_ATTR_WO(_name) \
577 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
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 = \
583 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
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) }
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)
590
591 extern int device_create_file(struct device *device,
592 const struct device_attribute *entry);
593 extern void device_remove_file(struct device *dev,
594 const struct device_attribute *attr);
595 extern bool device_remove_file_self(struct device *dev,
596 const struct device_attribute *attr);
597 extern int __must_check device_create_bin_file(struct device *dev,
598 const struct bin_attribute *attr);
599 extern void device_remove_bin_file(struct device *dev,
600 const struct bin_attribute *attr);
601
602 /* device resource management */
603 typedef void (*dr_release_t)(struct device *dev, void *res);
604 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
605
606 #ifdef CONFIG_DEBUG_DEVRES
607 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
608 const char *name);
609 #define devres_alloc(release, size, gfp) \
610 __devres_alloc(release, size, gfp, #release)
611 #else
612 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
613 #endif
614 extern void devres_for_each_res(struct device *dev, dr_release_t release,
615 dr_match_t match, void *match_data,
616 void (*fn)(struct device *, void *, void *),
617 void *data);
618 extern void devres_free(void *res);
619 extern void devres_add(struct device *dev, void *res);
620 extern void *devres_find(struct device *dev, dr_release_t release,
621 dr_match_t match, void *match_data);
622 extern void *devres_get(struct device *dev, void *new_res,
623 dr_match_t match, void *match_data);
624 extern void *devres_remove(struct device *dev, dr_release_t release,
625 dr_match_t match, void *match_data);
626 extern int devres_destroy(struct device *dev, dr_release_t release,
627 dr_match_t match, void *match_data);
628 extern int devres_release(struct device *dev, dr_release_t release,
629 dr_match_t match, void *match_data);
630
631 /* devres group */
632 extern void * __must_check devres_open_group(struct device *dev, void *id,
633 gfp_t gfp);
634 extern void devres_close_group(struct device *dev, void *id);
635 extern void devres_remove_group(struct device *dev, void *id);
636 extern int devres_release_group(struct device *dev, void *id);
637
638 /* managed devm_k.alloc/kfree for device drivers */
639 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
640 extern __printf(3, 0)
641 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
642 va_list ap);
643 extern __printf(3, 4)
644 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
645 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
646 {
647 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
648 }
649 static inline void *devm_kmalloc_array(struct device *dev,
650 size_t n, size_t size, gfp_t flags)
651 {
652 if (size != 0 && n > SIZE_MAX / size)
653 return NULL;
654 return devm_kmalloc(dev, n * size, flags);
655 }
656 static inline void *devm_kcalloc(struct device *dev,
657 size_t n, size_t size, gfp_t flags)
658 {
659 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
660 }
661 extern void devm_kfree(struct device *dev, void *p);
662 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
663 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
664 gfp_t gfp);
665
666 extern unsigned long devm_get_free_pages(struct device *dev,
667 gfp_t gfp_mask, unsigned int order);
668 extern void devm_free_pages(struct device *dev, unsigned long addr);
669
670 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
671
672 /* allows to add/remove a custom action to devres stack */
673 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
674 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
675
676 struct device_dma_parameters {
677 /*
678 * a low level driver may set these to teach IOMMU code about
679 * sg limitations.
680 */
681 unsigned int max_segment_size;
682 unsigned long segment_boundary_mask;
683 };
684
685 /**
686 * struct device - The basic device structure
687 * @parent: The device's "parent" device, the device to which it is attached.
688 * In most cases, a parent device is some sort of bus or host
689 * controller. If parent is NULL, the device, is a top-level device,
690 * which is not usually what you want.
691 * @p: Holds the private data of the driver core portions of the device.
692 * See the comment of the struct device_private for detail.
693 * @kobj: A top-level, abstract class from which other classes are derived.
694 * @init_name: Initial name of the device.
695 * @type: The type of device.
696 * This identifies the device type and carries type-specific
697 * information.
698 * @mutex: Mutex to synchronize calls to its driver.
699 * @bus: Type of bus device is on.
700 * @driver: Which driver has allocated this
701 * @platform_data: Platform data specific to the device.
702 * Example: For devices on custom boards, as typical of embedded
703 * and SOC based hardware, Linux often uses platform_data to point
704 * to board-specific structures describing devices and how they
705 * are wired. That can include what ports are available, chip
706 * variants, which GPIO pins act in what additional roles, and so
707 * on. This shrinks the "Board Support Packages" (BSPs) and
708 * minimizes board-specific #ifdefs in drivers.
709 * @driver_data: Private pointer for driver specific info.
710 * @power: For device power management.
711 * See Documentation/power/devices.txt for details.
712 * @pm_domain: Provide callbacks that are executed during system suspend,
713 * hibernation, system resume and during runtime PM transitions
714 * along with subsystem-level and driver-level callbacks.
715 * @pins: For device pin management.
716 * See Documentation/pinctrl.txt for details.
717 * @msi_list: Hosts MSI descriptors
718 * @msi_domain: The generic MSI domain this device is using.
719 * @numa_node: NUMA node this device is close to.
720 * @dma_mask: Dma mask (if dma'ble device).
721 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
722 * hardware supports 64-bit addresses for consistent allocations
723 * such descriptors.
724 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
725 * @dma_parms: A low level driver may set these to teach IOMMU code about
726 * segment limitations.
727 * @dma_pools: Dma pools (if dma'ble device).
728 * @dma_mem: Internal for coherent mem override.
729 * @cma_area: Contiguous memory area for dma allocations
730 * @archdata: For arch-specific additions.
731 * @of_node: Associated device tree node.
732 * @fwnode: Associated device node supplied by platform firmware.
733 * @devt: For creating the sysfs "dev".
734 * @id: device instance
735 * @devres_lock: Spinlock to protect the resource of the device.
736 * @devres_head: The resources list of the device.
737 * @knode_class: The node used to add the device to the class list.
738 * @class: The class of the device.
739 * @groups: Optional attribute groups.
740 * @release: Callback to free the device after all references have
741 * gone away. This should be set by the allocator of the
742 * device (i.e. the bus driver that discovered the device).
743 * @iommu_group: IOMMU group the device belongs to.
744 *
745 * @offline_disabled: If set, the device is permanently online.
746 * @offline: Set after successful invocation of bus type's .offline().
747 *
748 * At the lowest level, every device in a Linux system is represented by an
749 * instance of struct device. The device structure contains the information
750 * that the device model core needs to model the system. Most subsystems,
751 * however, track additional information about the devices they host. As a
752 * result, it is rare for devices to be represented by bare device structures;
753 * instead, that structure, like kobject structures, is usually embedded within
754 * a higher-level representation of the device.
755 */
756 struct device {
757 struct device *parent;
758
759 struct device_private *p;
760
761 struct kobject kobj;
762 const char *init_name; /* initial name of the device */
763 const struct device_type *type;
764
765 struct mutex mutex; /* mutex to synchronize calls to
766 * its driver.
767 */
768
769 struct bus_type *bus; /* type of bus device is on */
770 struct device_driver *driver; /* which driver has allocated this
771 device */
772 void *platform_data; /* Platform specific data, device
773 core doesn't touch it */
774 void *driver_data; /* Driver data, set and get with
775 dev_set/get_drvdata */
776 struct dev_pm_info power;
777 struct dev_pm_domain *pm_domain;
778
779 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
780 struct irq_domain *msi_domain;
781 #endif
782 #ifdef CONFIG_PINCTRL
783 struct dev_pin_info *pins;
784 #endif
785 #ifdef CONFIG_GENERIC_MSI_IRQ
786 struct list_head msi_list;
787 #endif
788
789 #ifdef CONFIG_NUMA
790 int numa_node; /* NUMA node this device is close to */
791 #endif
792 u64 *dma_mask; /* dma mask (if dma'able device) */
793 u64 coherent_dma_mask;/* Like dma_mask, but for
794 alloc_coherent mappings as
795 not all hardware supports
796 64 bit addresses for consistent
797 allocations such descriptors. */
798 unsigned long dma_pfn_offset;
799
800 struct device_dma_parameters *dma_parms;
801
802 struct list_head dma_pools; /* dma pools (if dma'ble) */
803
804 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
805 override */
806 #ifdef CONFIG_DMA_CMA
807 struct cma *cma_area; /* contiguous memory area for dma
808 allocations */
809 #endif
810 /* arch specific additions */
811 struct dev_archdata archdata;
812
813 struct device_node *of_node; /* associated device tree node */
814 struct fwnode_handle *fwnode; /* firmware device node */
815
816 dev_t devt; /* dev_t, creates the sysfs "dev" */
817 u32 id; /* device instance */
818
819 spinlock_t devres_lock;
820 struct list_head devres_head;
821
822 struct klist_node knode_class;
823 struct class *class;
824 const struct attribute_group **groups; /* optional groups */
825
826 void (*release)(struct device *dev);
827 struct iommu_group *iommu_group;
828
829 bool offline_disabled:1;
830 bool offline:1;
831 };
832
833 static inline struct device *kobj_to_dev(struct kobject *kobj)
834 {
835 return container_of(kobj, struct device, kobj);
836 }
837
838 /* Get the wakeup routines, which depend on struct device */
839 #include <linux/pm_wakeup.h>
840
841 static inline const char *dev_name(const struct device *dev)
842 {
843 /* Use the init name until the kobject becomes available */
844 if (dev->init_name)
845 return dev->init_name;
846
847 return kobject_name(&dev->kobj);
848 }
849
850 extern __printf(2, 3)
851 int dev_set_name(struct device *dev, const char *name, ...);
852
853 #ifdef CONFIG_NUMA
854 static inline int dev_to_node(struct device *dev)
855 {
856 return dev->numa_node;
857 }
858 static inline void set_dev_node(struct device *dev, int node)
859 {
860 dev->numa_node = node;
861 }
862 #else
863 static inline int dev_to_node(struct device *dev)
864 {
865 return -1;
866 }
867 static inline void set_dev_node(struct device *dev, int node)
868 {
869 }
870 #endif
871
872 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
873 {
874 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
875 return dev->msi_domain;
876 #else
877 return NULL;
878 #endif
879 }
880
881 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
882 {
883 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
884 dev->msi_domain = d;
885 #endif
886 }
887
888 static inline void *dev_get_drvdata(const struct device *dev)
889 {
890 return dev->driver_data;
891 }
892
893 static inline void dev_set_drvdata(struct device *dev, void *data)
894 {
895 dev->driver_data = data;
896 }
897
898 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
899 {
900 return dev ? dev->power.subsys_data : NULL;
901 }
902
903 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
904 {
905 return dev->kobj.uevent_suppress;
906 }
907
908 static inline void dev_set_uevent_suppress(struct device *dev, int val)
909 {
910 dev->kobj.uevent_suppress = val;
911 }
912
913 static inline int device_is_registered(struct device *dev)
914 {
915 return dev->kobj.state_in_sysfs;
916 }
917
918 static inline void device_enable_async_suspend(struct device *dev)
919 {
920 if (!dev->power.is_prepared)
921 dev->power.async_suspend = true;
922 }
923
924 static inline void device_disable_async_suspend(struct device *dev)
925 {
926 if (!dev->power.is_prepared)
927 dev->power.async_suspend = false;
928 }
929
930 static inline bool device_async_suspend_enabled(struct device *dev)
931 {
932 return !!dev->power.async_suspend;
933 }
934
935 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
936 {
937 dev->power.ignore_children = enable;
938 }
939
940 static inline void dev_pm_syscore_device(struct device *dev, bool val)
941 {
942 #ifdef CONFIG_PM_SLEEP
943 dev->power.syscore = val;
944 #endif
945 }
946
947 static inline void device_lock(struct device *dev)
948 {
949 mutex_lock(&dev->mutex);
950 }
951
952 static inline int device_trylock(struct device *dev)
953 {
954 return mutex_trylock(&dev->mutex);
955 }
956
957 static inline void device_unlock(struct device *dev)
958 {
959 mutex_unlock(&dev->mutex);
960 }
961
962 static inline void device_lock_assert(struct device *dev)
963 {
964 lockdep_assert_held(&dev->mutex);
965 }
966
967 static inline struct device_node *dev_of_node(struct device *dev)
968 {
969 if (!IS_ENABLED(CONFIG_OF))
970 return NULL;
971 return dev->of_node;
972 }
973
974 void driver_init(void);
975
976 /*
977 * High level routines for use by the bus drivers
978 */
979 extern int __must_check device_register(struct device *dev);
980 extern void device_unregister(struct device *dev);
981 extern void device_initialize(struct device *dev);
982 extern int __must_check device_add(struct device *dev);
983 extern void device_del(struct device *dev);
984 extern int device_for_each_child(struct device *dev, void *data,
985 int (*fn)(struct device *dev, void *data));
986 extern int device_for_each_child_reverse(struct device *dev, void *data,
987 int (*fn)(struct device *dev, void *data));
988 extern struct device *device_find_child(struct device *dev, void *data,
989 int (*match)(struct device *dev, void *data));
990 extern int device_rename(struct device *dev, const char *new_name);
991 extern int device_move(struct device *dev, struct device *new_parent,
992 enum dpm_order dpm_order);
993 extern const char *device_get_devnode(struct device *dev,
994 umode_t *mode, kuid_t *uid, kgid_t *gid,
995 const char **tmp);
996
997 static inline bool device_supports_offline(struct device *dev)
998 {
999 return dev->bus && dev->bus->offline && dev->bus->online;
1000 }
1001
1002 extern void lock_device_hotplug(void);
1003 extern void unlock_device_hotplug(void);
1004 extern int lock_device_hotplug_sysfs(void);
1005 extern int device_offline(struct device *dev);
1006 extern int device_online(struct device *dev);
1007 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1008 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1009
1010 /*
1011 * Root device objects for grouping under /sys/devices
1012 */
1013 extern struct device *__root_device_register(const char *name,
1014 struct module *owner);
1015
1016 /* This is a macro to avoid include problems with THIS_MODULE */
1017 #define root_device_register(name) \
1018 __root_device_register(name, THIS_MODULE)
1019
1020 extern void root_device_unregister(struct device *root);
1021
1022 static inline void *dev_get_platdata(const struct device *dev)
1023 {
1024 return dev->platform_data;
1025 }
1026
1027 /*
1028 * Manual binding of a device to driver. See drivers/base/bus.c
1029 * for information on use.
1030 */
1031 extern int __must_check device_bind_driver(struct device *dev);
1032 extern void device_release_driver(struct device *dev);
1033 extern int __must_check device_attach(struct device *dev);
1034 extern int __must_check driver_attach(struct device_driver *drv);
1035 extern void device_initial_probe(struct device *dev);
1036 extern int __must_check device_reprobe(struct device *dev);
1037
1038 /*
1039 * Easy functions for dynamically creating devices on the fly
1040 */
1041 extern __printf(5, 0)
1042 struct device *device_create_vargs(struct class *cls, struct device *parent,
1043 dev_t devt, void *drvdata,
1044 const char *fmt, va_list vargs);
1045 extern __printf(5, 6)
1046 struct device *device_create(struct class *cls, struct device *parent,
1047 dev_t devt, void *drvdata,
1048 const char *fmt, ...);
1049 extern __printf(6, 7)
1050 struct device *device_create_with_groups(struct class *cls,
1051 struct device *parent, dev_t devt, void *drvdata,
1052 const struct attribute_group **groups,
1053 const char *fmt, ...);
1054 extern void device_destroy(struct class *cls, dev_t devt);
1055
1056 /*
1057 * Platform "fixup" functions - allow the platform to have their say
1058 * about devices and actions that the general device layer doesn't
1059 * know about.
1060 */
1061 /* Notify platform of device discovery */
1062 extern int (*platform_notify)(struct device *dev);
1063
1064 extern int (*platform_notify_remove)(struct device *dev);
1065
1066
1067 /*
1068 * get_device - atomically increment the reference count for the device.
1069 *
1070 */
1071 extern struct device *get_device(struct device *dev);
1072 extern void put_device(struct device *dev);
1073
1074 #ifdef CONFIG_DEVTMPFS
1075 extern int devtmpfs_create_node(struct device *dev);
1076 extern int devtmpfs_delete_node(struct device *dev);
1077 extern int devtmpfs_mount(const char *mntdir);
1078 #else
1079 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1080 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1081 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1082 #endif
1083
1084 /* drivers/base/power/shutdown.c */
1085 extern void device_shutdown(void);
1086
1087 /* debugging and troubleshooting/diagnostic helpers. */
1088 extern const char *dev_driver_string(const struct device *dev);
1089
1090
1091 #ifdef CONFIG_PRINTK
1092
1093 extern __printf(3, 0)
1094 int dev_vprintk_emit(int level, const struct device *dev,
1095 const char *fmt, va_list args);
1096 extern __printf(3, 4)
1097 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1098
1099 extern __printf(3, 4)
1100 void dev_printk(const char *level, const struct device *dev,
1101 const char *fmt, ...);
1102 extern __printf(2, 3)
1103 void dev_emerg(const struct device *dev, const char *fmt, ...);
1104 extern __printf(2, 3)
1105 void dev_alert(const struct device *dev, const char *fmt, ...);
1106 extern __printf(2, 3)
1107 void dev_crit(const struct device *dev, const char *fmt, ...);
1108 extern __printf(2, 3)
1109 void dev_err(const struct device *dev, const char *fmt, ...);
1110 extern __printf(2, 3)
1111 void dev_warn(const struct device *dev, const char *fmt, ...);
1112 extern __printf(2, 3)
1113 void dev_notice(const struct device *dev, const char *fmt, ...);
1114 extern __printf(2, 3)
1115 void _dev_info(const struct device *dev, const char *fmt, ...);
1116
1117 #else
1118
1119 static inline __printf(3, 0)
1120 int dev_vprintk_emit(int level, const struct device *dev,
1121 const char *fmt, va_list args)
1122 { return 0; }
1123 static inline __printf(3, 4)
1124 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1125 { return 0; }
1126
1127 static inline void __dev_printk(const char *level, const struct device *dev,
1128 struct va_format *vaf)
1129 {}
1130 static inline __printf(3, 4)
1131 void dev_printk(const char *level, const struct device *dev,
1132 const char *fmt, ...)
1133 {}
1134
1135 static inline __printf(2, 3)
1136 void dev_emerg(const struct device *dev, const char *fmt, ...)
1137 {}
1138 static inline __printf(2, 3)
1139 void dev_crit(const struct device *dev, const char *fmt, ...)
1140 {}
1141 static inline __printf(2, 3)
1142 void dev_alert(const struct device *dev, const char *fmt, ...)
1143 {}
1144 static inline __printf(2, 3)
1145 void dev_err(const struct device *dev, const char *fmt, ...)
1146 {}
1147 static inline __printf(2, 3)
1148 void dev_warn(const struct device *dev, const char *fmt, ...)
1149 {}
1150 static inline __printf(2, 3)
1151 void dev_notice(const struct device *dev, const char *fmt, ...)
1152 {}
1153 static inline __printf(2, 3)
1154 void _dev_info(const struct device *dev, const char *fmt, ...)
1155 {}
1156
1157 #endif
1158
1159 /*
1160 * Stupid hackaround for existing uses of non-printk uses dev_info
1161 *
1162 * Note that the definition of dev_info below is actually _dev_info
1163 * and a macro is used to avoid redefining dev_info
1164 */
1165
1166 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1167
1168 #if defined(CONFIG_DYNAMIC_DEBUG)
1169 #define dev_dbg(dev, format, ...) \
1170 do { \
1171 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1172 } while (0)
1173 #elif defined(DEBUG)
1174 #define dev_dbg(dev, format, arg...) \
1175 dev_printk(KERN_DEBUG, dev, format, ##arg)
1176 #else
1177 #define dev_dbg(dev, format, arg...) \
1178 ({ \
1179 if (0) \
1180 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1181 })
1182 #endif
1183
1184 #ifdef CONFIG_PRINTK
1185 #define dev_level_once(dev_level, dev, fmt, ...) \
1186 do { \
1187 static bool __print_once __read_mostly; \
1188 \
1189 if (!__print_once) { \
1190 __print_once = true; \
1191 dev_level(dev, fmt, ##__VA_ARGS__); \
1192 } \
1193 } while (0)
1194 #else
1195 #define dev_level_once(dev_level, dev, fmt, ...) \
1196 do { \
1197 if (0) \
1198 dev_level(dev, fmt, ##__VA_ARGS__); \
1199 } while (0)
1200 #endif
1201
1202 #define dev_emerg_once(dev, fmt, ...) \
1203 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1204 #define dev_alert_once(dev, fmt, ...) \
1205 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1206 #define dev_crit_once(dev, fmt, ...) \
1207 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1208 #define dev_err_once(dev, fmt, ...) \
1209 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1210 #define dev_warn_once(dev, fmt, ...) \
1211 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1212 #define dev_notice_once(dev, fmt, ...) \
1213 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1214 #define dev_info_once(dev, fmt, ...) \
1215 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1216 #define dev_dbg_once(dev, fmt, ...) \
1217 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1218
1219 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1220 do { \
1221 static DEFINE_RATELIMIT_STATE(_rs, \
1222 DEFAULT_RATELIMIT_INTERVAL, \
1223 DEFAULT_RATELIMIT_BURST); \
1224 if (__ratelimit(&_rs)) \
1225 dev_level(dev, fmt, ##__VA_ARGS__); \
1226 } while (0)
1227
1228 #define dev_emerg_ratelimited(dev, fmt, ...) \
1229 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1230 #define dev_alert_ratelimited(dev, fmt, ...) \
1231 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1232 #define dev_crit_ratelimited(dev, fmt, ...) \
1233 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1234 #define dev_err_ratelimited(dev, fmt, ...) \
1235 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1236 #define dev_warn_ratelimited(dev, fmt, ...) \
1237 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1238 #define dev_notice_ratelimited(dev, fmt, ...) \
1239 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1240 #define dev_info_ratelimited(dev, fmt, ...) \
1241 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1242 #if defined(CONFIG_DYNAMIC_DEBUG)
1243 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1244 #define dev_dbg_ratelimited(dev, fmt, ...) \
1245 do { \
1246 static DEFINE_RATELIMIT_STATE(_rs, \
1247 DEFAULT_RATELIMIT_INTERVAL, \
1248 DEFAULT_RATELIMIT_BURST); \
1249 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1250 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1251 __ratelimit(&_rs)) \
1252 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1253 ##__VA_ARGS__); \
1254 } while (0)
1255 #elif defined(DEBUG)
1256 #define dev_dbg_ratelimited(dev, fmt, ...) \
1257 do { \
1258 static DEFINE_RATELIMIT_STATE(_rs, \
1259 DEFAULT_RATELIMIT_INTERVAL, \
1260 DEFAULT_RATELIMIT_BURST); \
1261 if (__ratelimit(&_rs)) \
1262 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1263 } while (0)
1264 #else
1265 #define dev_dbg_ratelimited(dev, fmt, ...) \
1266 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1267 #endif
1268
1269 #ifdef VERBOSE_DEBUG
1270 #define dev_vdbg dev_dbg
1271 #else
1272 #define dev_vdbg(dev, format, arg...) \
1273 ({ \
1274 if (0) \
1275 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1276 })
1277 #endif
1278
1279 /*
1280 * dev_WARN*() acts like dev_printk(), but with the key difference of
1281 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1282 */
1283 #define dev_WARN(dev, format, arg...) \
1284 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1285
1286 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1287 WARN_ONCE(condition, "%s %s: " format, \
1288 dev_driver_string(dev), dev_name(dev), ## arg)
1289
1290 /* Create alias, so I can be autoloaded. */
1291 #define MODULE_ALIAS_CHARDEV(major,minor) \
1292 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1293 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1294 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1295
1296 #ifdef CONFIG_SYSFS_DEPRECATED
1297 extern long sysfs_deprecated;
1298 #else
1299 #define sysfs_deprecated 0
1300 #endif
1301
1302 /**
1303 * module_driver() - Helper macro for drivers that don't do anything
1304 * special in module init/exit. This eliminates a lot of boilerplate.
1305 * Each module may only use this macro once, and calling it replaces
1306 * module_init() and module_exit().
1307 *
1308 * @__driver: driver name
1309 * @__register: register function for this driver type
1310 * @__unregister: unregister function for this driver type
1311 * @...: Additional arguments to be passed to __register and __unregister.
1312 *
1313 * Use this macro to construct bus specific macros for registering
1314 * drivers, and do not use it on its own.
1315 */
1316 #define module_driver(__driver, __register, __unregister, ...) \
1317 static int __init __driver##_init(void) \
1318 { \
1319 return __register(&(__driver) , ##__VA_ARGS__); \
1320 } \
1321 module_init(__driver##_init); \
1322 static void __exit __driver##_exit(void) \
1323 { \
1324 __unregister(&(__driver) , ##__VA_ARGS__); \
1325 } \
1326 module_exit(__driver##_exit);
1327
1328 /**
1329 * builtin_driver() - Helper macro for drivers that don't do anything
1330 * special in init and have no exit. This eliminates some boilerplate.
1331 * Each driver may only use this macro once, and calling it replaces
1332 * device_initcall (or in some cases, the legacy __initcall). This is
1333 * meant to be a direct parallel of module_driver() above but without
1334 * the __exit stuff that is not used for builtin cases.
1335 *
1336 * @__driver: driver name
1337 * @__register: register function for this driver type
1338 * @...: Additional arguments to be passed to __register
1339 *
1340 * Use this macro to construct bus specific macros for registering
1341 * drivers, and do not use it on its own.
1342 */
1343 #define builtin_driver(__driver, __register, ...) \
1344 static int __init __driver##_init(void) \
1345 { \
1346 return __register(&(__driver) , ##__VA_ARGS__); \
1347 } \
1348 device_initcall(__driver##_init);
1349
1350 #endif /* _DEVICE_H_ */