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