driver core: set up ownership of class devices in sysfs
[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  * @get_ownership: Allows class to specify uid/gid of the sysfs directories
388  *              for the devices belonging to the class. Usually tied to
389  *              device's namespace.
390  * @pm:         The default device power management operations of this class.
391  * @p:          The private data of the driver core, no one other than the
392  *              driver core can touch this.
393  *
394  * A class is a higher-level view of a device that abstracts out low-level
395  * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
396  * at the class level, they are all simply disks. Classes allow user space
397  * to work with devices based on what they do, rather than how they are
398  * connected or how they work.
399  */
400 struct class {
401         const char              *name;
402         struct module           *owner;
403
404         const struct attribute_group    **class_groups;
405         const struct attribute_group    **dev_groups;
406         struct kobject                  *dev_kobj;
407
408         int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
409         char *(*devnode)(struct device *dev, umode_t *mode);
410
411         void (*class_release)(struct class *class);
412         void (*dev_release)(struct device *dev);
413
414         int (*shutdown_pre)(struct device *dev);
415
416         const struct kobj_ns_type_operations *ns_type;
417         const void *(*namespace)(struct device *dev);
418
419         void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid);
420
421         const struct dev_pm_ops *pm;
422
423         struct subsys_private *p;
424 };
425
426 struct class_dev_iter {
427         struct klist_iter               ki;
428         const struct device_type        *type;
429 };
430
431 extern struct kobject *sysfs_dev_block_kobj;
432 extern struct kobject *sysfs_dev_char_kobj;
433 extern int __must_check __class_register(struct class *class,
434                                          struct lock_class_key *key);
435 extern void class_unregister(struct class *class);
436
437 /* This is a #define to keep the compiler from merging different
438  * instances of the __key variable */
439 #define class_register(class)                   \
440 ({                                              \
441         static struct lock_class_key __key;     \
442         __class_register(class, &__key);        \
443 })
444
445 struct class_compat;
446 struct class_compat *class_compat_register(const char *name);
447 void class_compat_unregister(struct class_compat *cls);
448 int class_compat_create_link(struct class_compat *cls, struct device *dev,
449                              struct device *device_link);
450 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
451                               struct device *device_link);
452
453 extern void class_dev_iter_init(struct class_dev_iter *iter,
454                                 struct class *class,
455                                 struct device *start,
456                                 const struct device_type *type);
457 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
458 extern void class_dev_iter_exit(struct class_dev_iter *iter);
459
460 extern int class_for_each_device(struct class *class, struct device *start,
461                                  void *data,
462                                  int (*fn)(struct device *dev, void *data));
463 extern struct device *class_find_device(struct class *class,
464                                         struct device *start, const void *data,
465                                         int (*match)(struct device *, const void *));
466
467 struct class_attribute {
468         struct attribute attr;
469         ssize_t (*show)(struct class *class, struct class_attribute *attr,
470                         char *buf);
471         ssize_t (*store)(struct class *class, struct class_attribute *attr,
472                         const char *buf, size_t count);
473 };
474
475 #define CLASS_ATTR_RW(_name) \
476         struct class_attribute class_attr_##_name = __ATTR_RW(_name)
477 #define CLASS_ATTR_RO(_name) \
478         struct class_attribute class_attr_##_name = __ATTR_RO(_name)
479 #define CLASS_ATTR_WO(_name) \
480         struct class_attribute class_attr_##_name = __ATTR_WO(_name)
481
482 extern int __must_check class_create_file_ns(struct class *class,
483                                              const struct class_attribute *attr,
484                                              const void *ns);
485 extern void class_remove_file_ns(struct class *class,
486                                  const struct class_attribute *attr,
487                                  const void *ns);
488
489 static inline int __must_check class_create_file(struct class *class,
490                                         const struct class_attribute *attr)
491 {
492         return class_create_file_ns(class, attr, NULL);
493 }
494
495 static inline void class_remove_file(struct class *class,
496                                      const struct class_attribute *attr)
497 {
498         return class_remove_file_ns(class, attr, NULL);
499 }
500
501 /* Simple class attribute that is just a static string */
502 struct class_attribute_string {
503         struct class_attribute attr;
504         char *str;
505 };
506
507 /* Currently read-only only */
508 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
509         { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
510 #define CLASS_ATTR_STRING(_name, _mode, _str) \
511         struct class_attribute_string class_attr_##_name = \
512                 _CLASS_ATTR_STRING(_name, _mode, _str)
513
514 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
515                         char *buf);
516
517 struct class_interface {
518         struct list_head        node;
519         struct class            *class;
520
521         int (*add_dev)          (struct device *, struct class_interface *);
522         void (*remove_dev)      (struct device *, struct class_interface *);
523 };
524
525 extern int __must_check class_interface_register(struct class_interface *);
526 extern void class_interface_unregister(struct class_interface *);
527
528 extern struct class * __must_check __class_create(struct module *owner,
529                                                   const char *name,
530                                                   struct lock_class_key *key);
531 extern void class_destroy(struct class *cls);
532
533 /* This is a #define to keep the compiler from merging different
534  * instances of the __key variable */
535 #define class_create(owner, name)               \
536 ({                                              \
537         static struct lock_class_key __key;     \
538         __class_create(owner, name, &__key);    \
539 })
540
541 /*
542  * The type of device, "struct device" is embedded in. A class
543  * or bus can contain devices of different types
544  * like "partitions" and "disks", "mouse" and "event".
545  * This identifies the device type and carries type-specific
546  * information, equivalent to the kobj_type of a kobject.
547  * If "name" is specified, the uevent will contain it in
548  * the DEVTYPE variable.
549  */
550 struct device_type {
551         const char *name;
552         const struct attribute_group **groups;
553         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
554         char *(*devnode)(struct device *dev, umode_t *mode,
555                          kuid_t *uid, kgid_t *gid);
556         void (*release)(struct device *dev);
557
558         const struct dev_pm_ops *pm;
559 };
560
561 /* interface for exporting device attributes */
562 struct device_attribute {
563         struct attribute        attr;
564         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
565                         char *buf);
566         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
567                          const char *buf, size_t count);
568 };
569
570 struct dev_ext_attribute {
571         struct device_attribute attr;
572         void *var;
573 };
574
575 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
576                           char *buf);
577 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
578                            const char *buf, size_t count);
579 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
580                         char *buf);
581 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
582                          const char *buf, size_t count);
583 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
584                         char *buf);
585 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
586                          const char *buf, size_t count);
587
588 #define DEVICE_ATTR(_name, _mode, _show, _store) \
589         struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
590 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
591         struct device_attribute dev_attr_##_name = \
592                 __ATTR_PREALLOC(_name, _mode, _show, _store)
593 #define DEVICE_ATTR_RW(_name) \
594         struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
595 #define DEVICE_ATTR_RO(_name) \
596         struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
597 #define DEVICE_ATTR_WO(_name) \
598         struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
599 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
600         struct dev_ext_attribute dev_attr_##_name = \
601                 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
602 #define DEVICE_INT_ATTR(_name, _mode, _var) \
603         struct dev_ext_attribute dev_attr_##_name = \
604                 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
605 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
606         struct dev_ext_attribute dev_attr_##_name = \
607                 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
608 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
609         struct device_attribute dev_attr_##_name =              \
610                 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
611
612 extern int device_create_file(struct device *device,
613                               const struct device_attribute *entry);
614 extern void device_remove_file(struct device *dev,
615                                const struct device_attribute *attr);
616 extern bool device_remove_file_self(struct device *dev,
617                                     const struct device_attribute *attr);
618 extern int __must_check device_create_bin_file(struct device *dev,
619                                         const struct bin_attribute *attr);
620 extern void device_remove_bin_file(struct device *dev,
621                                    const struct bin_attribute *attr);
622
623 /* device resource management */
624 typedef void (*dr_release_t)(struct device *dev, void *res);
625 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
626
627 #ifdef CONFIG_DEBUG_DEVRES
628 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
629                                  int nid, const char *name) __malloc;
630 #define devres_alloc(release, size, gfp) \
631         __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
632 #define devres_alloc_node(release, size, gfp, nid) \
633         __devres_alloc_node(release, size, gfp, nid, #release)
634 #else
635 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
636                                int nid) __malloc;
637 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
638 {
639         return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
640 }
641 #endif
642
643 extern void devres_for_each_res(struct device *dev, dr_release_t release,
644                                 dr_match_t match, void *match_data,
645                                 void (*fn)(struct device *, void *, void *),
646                                 void *data);
647 extern void devres_free(void *res);
648 extern void devres_add(struct device *dev, void *res);
649 extern void *devres_find(struct device *dev, dr_release_t release,
650                          dr_match_t match, void *match_data);
651 extern void *devres_get(struct device *dev, void *new_res,
652                         dr_match_t match, void *match_data);
653 extern void *devres_remove(struct device *dev, dr_release_t release,
654                            dr_match_t match, void *match_data);
655 extern int devres_destroy(struct device *dev, dr_release_t release,
656                           dr_match_t match, void *match_data);
657 extern int devres_release(struct device *dev, dr_release_t release,
658                           dr_match_t match, void *match_data);
659
660 /* devres group */
661 extern void * __must_check devres_open_group(struct device *dev, void *id,
662                                              gfp_t gfp);
663 extern void devres_close_group(struct device *dev, void *id);
664 extern void devres_remove_group(struct device *dev, void *id);
665 extern int devres_release_group(struct device *dev, void *id);
666
667 /* managed devm_k.alloc/kfree for device drivers */
668 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
669 extern __printf(3, 0)
670 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
671                       va_list ap) __malloc;
672 extern __printf(3, 4)
673 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
674 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
675 {
676         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
677 }
678 static inline void *devm_kmalloc_array(struct device *dev,
679                                        size_t n, size_t size, gfp_t flags)
680 {
681         size_t bytes;
682
683         if (unlikely(check_mul_overflow(n, size, &bytes)))
684                 return NULL;
685
686         return devm_kmalloc(dev, bytes, flags);
687 }
688 static inline void *devm_kcalloc(struct device *dev,
689                                  size_t n, size_t size, gfp_t flags)
690 {
691         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
692 }
693 extern void devm_kfree(struct device *dev, void *p);
694 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
695 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
696                           gfp_t gfp);
697
698 extern unsigned long devm_get_free_pages(struct device *dev,
699                                          gfp_t gfp_mask, unsigned int order);
700 extern void devm_free_pages(struct device *dev, unsigned long addr);
701
702 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
703
704 /* allows to add/remove a custom action to devres stack */
705 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
706 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
707
708 static inline int devm_add_action_or_reset(struct device *dev,
709                                            void (*action)(void *), void *data)
710 {
711         int ret;
712
713         ret = devm_add_action(dev, action, data);
714         if (ret)
715                 action(data);
716
717         return ret;
718 }
719
720 /**
721  * devm_alloc_percpu - Resource-managed alloc_percpu
722  * @dev: Device to allocate per-cpu memory for
723  * @type: Type to allocate per-cpu memory for
724  *
725  * Managed alloc_percpu. Per-cpu memory allocated with this function is
726  * automatically freed on driver detach.
727  *
728  * RETURNS:
729  * Pointer to allocated memory on success, NULL on failure.
730  */
731 #define devm_alloc_percpu(dev, type)      \
732         ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
733                                                       __alignof__(type)))
734
735 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
736                                    size_t align);
737 void devm_free_percpu(struct device *dev, void __percpu *pdata);
738
739 struct device_dma_parameters {
740         /*
741          * a low level driver may set these to teach IOMMU code about
742          * sg limitations.
743          */
744         unsigned int max_segment_size;
745         unsigned long segment_boundary_mask;
746 };
747
748 /**
749  * struct device_connection - Device Connection Descriptor
750  * @endpoint: The names of the two devices connected together
751  * @id: Unique identifier for the connection
752  * @list: List head, private, for internal use only
753  */
754 struct device_connection {
755         const char              *endpoint[2];
756         const char              *id;
757         struct list_head        list;
758 };
759
760 void *device_connection_find_match(struct device *dev, const char *con_id,
761                                 void *data,
762                                 void *(*match)(struct device_connection *con,
763                                                int ep, void *data));
764
765 struct device *device_connection_find(struct device *dev, const char *con_id);
766
767 void device_connection_add(struct device_connection *con);
768 void device_connection_remove(struct device_connection *con);
769
770 /**
771  * enum device_link_state - Device link states.
772  * @DL_STATE_NONE: The presence of the drivers is not being tracked.
773  * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
774  * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
775  * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
776  * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
777  * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
778  */
779 enum device_link_state {
780         DL_STATE_NONE = -1,
781         DL_STATE_DORMANT = 0,
782         DL_STATE_AVAILABLE,
783         DL_STATE_CONSUMER_PROBE,
784         DL_STATE_ACTIVE,
785         DL_STATE_SUPPLIER_UNBIND,
786 };
787
788 /*
789  * Device link flags.
790  *
791  * STATELESS: The core won't track the presence of supplier/consumer drivers.
792  * AUTOREMOVE: Remove this link automatically on consumer driver unbind.
793  * PM_RUNTIME: If set, the runtime PM framework will use this link.
794  * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
795  */
796 #define DL_FLAG_STATELESS       BIT(0)
797 #define DL_FLAG_AUTOREMOVE      BIT(1)
798 #define DL_FLAG_PM_RUNTIME      BIT(2)
799 #define DL_FLAG_RPM_ACTIVE      BIT(3)
800
801 /**
802  * struct device_link - Device link representation.
803  * @supplier: The device on the supplier end of the link.
804  * @s_node: Hook to the supplier device's list of links to consumers.
805  * @consumer: The device on the consumer end of the link.
806  * @c_node: Hook to the consumer device's list of links to suppliers.
807  * @status: The state of the link (with respect to the presence of drivers).
808  * @flags: Link flags.
809  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
810  * @kref: Count repeated addition of the same link.
811  * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
812  */
813 struct device_link {
814         struct device *supplier;
815         struct list_head s_node;
816         struct device *consumer;
817         struct list_head c_node;
818         enum device_link_state status;
819         u32 flags;
820         bool rpm_active;
821         struct kref kref;
822 #ifdef CONFIG_SRCU
823         struct rcu_head rcu_head;
824 #endif
825 };
826
827 /**
828  * enum dl_dev_state - Device driver presence tracking information.
829  * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
830  * @DL_DEV_PROBING: A driver is probing.
831  * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
832  * @DL_DEV_UNBINDING: The driver is unbinding from the device.
833  */
834 enum dl_dev_state {
835         DL_DEV_NO_DRIVER = 0,
836         DL_DEV_PROBING,
837         DL_DEV_DRIVER_BOUND,
838         DL_DEV_UNBINDING,
839 };
840
841 /**
842  * struct dev_links_info - Device data related to device links.
843  * @suppliers: List of links to supplier devices.
844  * @consumers: List of links to consumer devices.
845  * @status: Driver status information.
846  */
847 struct dev_links_info {
848         struct list_head suppliers;
849         struct list_head consumers;
850         enum dl_dev_state status;
851 };
852
853 /**
854  * struct device - The basic device structure
855  * @parent:     The device's "parent" device, the device to which it is attached.
856  *              In most cases, a parent device is some sort of bus or host
857  *              controller. If parent is NULL, the device, is a top-level device,
858  *              which is not usually what you want.
859  * @p:          Holds the private data of the driver core portions of the device.
860  *              See the comment of the struct device_private for detail.
861  * @kobj:       A top-level, abstract class from which other classes are derived.
862  * @init_name:  Initial name of the device.
863  * @type:       The type of device.
864  *              This identifies the device type and carries type-specific
865  *              information.
866  * @mutex:      Mutex to synchronize calls to its driver.
867  * @bus:        Type of bus device is on.
868  * @driver:     Which driver has allocated this
869  * @platform_data: Platform data specific to the device.
870  *              Example: For devices on custom boards, as typical of embedded
871  *              and SOC based hardware, Linux often uses platform_data to point
872  *              to board-specific structures describing devices and how they
873  *              are wired.  That can include what ports are available, chip
874  *              variants, which GPIO pins act in what additional roles, and so
875  *              on.  This shrinks the "Board Support Packages" (BSPs) and
876  *              minimizes board-specific #ifdefs in drivers.
877  * @driver_data: Private pointer for driver specific info.
878  * @links:      Links to suppliers and consumers of this device.
879  * @power:      For device power management.
880  *              See Documentation/driver-api/pm/devices.rst for details.
881  * @pm_domain:  Provide callbacks that are executed during system suspend,
882  *              hibernation, system resume and during runtime PM transitions
883  *              along with subsystem-level and driver-level callbacks.
884  * @pins:       For device pin management.
885  *              See Documentation/driver-api/pinctl.rst for details.
886  * @msi_list:   Hosts MSI descriptors
887  * @msi_domain: The generic MSI domain this device is using.
888  * @numa_node:  NUMA node this device is close to.
889  * @dma_ops:    DMA mapping operations for this device.
890  * @dma_mask:   Dma mask (if dma'ble device).
891  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
892  *              hardware supports 64-bit addresses for consistent allocations
893  *              such descriptors.
894  * @dma_pfn_offset: offset of DMA memory range relatively of RAM
895  * @dma_parms:  A low level driver may set these to teach IOMMU code about
896  *              segment limitations.
897  * @dma_pools:  Dma pools (if dma'ble device).
898  * @dma_mem:    Internal for coherent mem override.
899  * @cma_area:   Contiguous memory area for dma allocations
900  * @archdata:   For arch-specific additions.
901  * @of_node:    Associated device tree node.
902  * @fwnode:     Associated device node supplied by platform firmware.
903  * @devt:       For creating the sysfs "dev".
904  * @id:         device instance
905  * @devres_lock: Spinlock to protect the resource of the device.
906  * @devres_head: The resources list of the device.
907  * @knode_class: The node used to add the device to the class list.
908  * @class:      The class of the device.
909  * @groups:     Optional attribute groups.
910  * @release:    Callback to free the device after all references have
911  *              gone away. This should be set by the allocator of the
912  *              device (i.e. the bus driver that discovered the device).
913  * @iommu_group: IOMMU group the device belongs to.
914  * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
915  *
916  * @offline_disabled: If set, the device is permanently online.
917  * @offline:    Set after successful invocation of bus type's .offline().
918  * @of_node_reused: Set if the device-tree node is shared with an ancestor
919  *              device.
920  * @dma_32bit_limit: bridge limited to 32bit DMA even if the device itself
921  *              indicates support for a higher limit in the dma_mask field.
922  *
923  * At the lowest level, every device in a Linux system is represented by an
924  * instance of struct device. The device structure contains the information
925  * that the device model core needs to model the system. Most subsystems,
926  * however, track additional information about the devices they host. As a
927  * result, it is rare for devices to be represented by bare device structures;
928  * instead, that structure, like kobject structures, is usually embedded within
929  * a higher-level representation of the device.
930  */
931 struct device {
932         struct device           *parent;
933
934         struct device_private   *p;
935
936         struct kobject kobj;
937         const char              *init_name; /* initial name of the device */
938         const struct device_type *type;
939
940         struct mutex            mutex;  /* mutex to synchronize calls to
941                                          * its driver.
942                                          */
943
944         struct bus_type *bus;           /* type of bus device is on */
945         struct device_driver *driver;   /* which driver has allocated this
946                                            device */
947         void            *platform_data; /* Platform specific data, device
948                                            core doesn't touch it */
949         void            *driver_data;   /* Driver data, set and get with
950                                            dev_set/get_drvdata */
951         struct dev_links_info   links;
952         struct dev_pm_info      power;
953         struct dev_pm_domain    *pm_domain;
954
955 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
956         struct irq_domain       *msi_domain;
957 #endif
958 #ifdef CONFIG_PINCTRL
959         struct dev_pin_info     *pins;
960 #endif
961 #ifdef CONFIG_GENERIC_MSI_IRQ
962         struct list_head        msi_list;
963 #endif
964
965 #ifdef CONFIG_NUMA
966         int             numa_node;      /* NUMA node this device is close to */
967 #endif
968         const struct dma_map_ops *dma_ops;
969         u64             *dma_mask;      /* dma mask (if dma'able device) */
970         u64             coherent_dma_mask;/* Like dma_mask, but for
971                                              alloc_coherent mappings as
972                                              not all hardware supports
973                                              64 bit addresses for consistent
974                                              allocations such descriptors. */
975         unsigned long   dma_pfn_offset;
976
977         struct device_dma_parameters *dma_parms;
978
979         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
980
981         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
982                                              override */
983 #ifdef CONFIG_DMA_CMA
984         struct cma *cma_area;           /* contiguous memory area for dma
985                                            allocations */
986 #endif
987         /* arch specific additions */
988         struct dev_archdata     archdata;
989
990         struct device_node      *of_node; /* associated device tree node */
991         struct fwnode_handle    *fwnode; /* firmware device node */
992
993         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
994         u32                     id;     /* device instance */
995
996         spinlock_t              devres_lock;
997         struct list_head        devres_head;
998
999         struct klist_node       knode_class;
1000         struct class            *class;
1001         const struct attribute_group **groups;  /* optional groups */
1002
1003         void    (*release)(struct device *dev);
1004         struct iommu_group      *iommu_group;
1005         struct iommu_fwspec     *iommu_fwspec;
1006
1007         bool                    offline_disabled:1;
1008         bool                    offline:1;
1009         bool                    of_node_reused:1;
1010         bool                    dma_32bit_limit:1;
1011 };
1012
1013 static inline struct device *kobj_to_dev(struct kobject *kobj)
1014 {
1015         return container_of(kobj, struct device, kobj);
1016 }
1017
1018 /* Get the wakeup routines, which depend on struct device */
1019 #include <linux/pm_wakeup.h>
1020
1021 static inline const char *dev_name(const struct device *dev)
1022 {
1023         /* Use the init name until the kobject becomes available */
1024         if (dev->init_name)
1025                 return dev->init_name;
1026
1027         return kobject_name(&dev->kobj);
1028 }
1029
1030 extern __printf(2, 3)
1031 int dev_set_name(struct device *dev, const char *name, ...);
1032
1033 #ifdef CONFIG_NUMA
1034 static inline int dev_to_node(struct device *dev)
1035 {
1036         return dev->numa_node;
1037 }
1038 static inline void set_dev_node(struct device *dev, int node)
1039 {
1040         dev->numa_node = node;
1041 }
1042 #else
1043 static inline int dev_to_node(struct device *dev)
1044 {
1045         return -1;
1046 }
1047 static inline void set_dev_node(struct device *dev, int node)
1048 {
1049 }
1050 #endif
1051
1052 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1053 {
1054 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1055         return dev->msi_domain;
1056 #else
1057         return NULL;
1058 #endif
1059 }
1060
1061 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1062 {
1063 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1064         dev->msi_domain = d;
1065 #endif
1066 }
1067
1068 static inline void *dev_get_drvdata(const struct device *dev)
1069 {
1070         return dev->driver_data;
1071 }
1072
1073 static inline void dev_set_drvdata(struct device *dev, void *data)
1074 {
1075         dev->driver_data = data;
1076 }
1077
1078 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1079 {
1080         return dev ? dev->power.subsys_data : NULL;
1081 }
1082
1083 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1084 {
1085         return dev->kobj.uevent_suppress;
1086 }
1087
1088 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1089 {
1090         dev->kobj.uevent_suppress = val;
1091 }
1092
1093 static inline int device_is_registered(struct device *dev)
1094 {
1095         return dev->kobj.state_in_sysfs;
1096 }
1097
1098 static inline void device_enable_async_suspend(struct device *dev)
1099 {
1100         if (!dev->power.is_prepared)
1101                 dev->power.async_suspend = true;
1102 }
1103
1104 static inline void device_disable_async_suspend(struct device *dev)
1105 {
1106         if (!dev->power.is_prepared)
1107                 dev->power.async_suspend = false;
1108 }
1109
1110 static inline bool device_async_suspend_enabled(struct device *dev)
1111 {
1112         return !!dev->power.async_suspend;
1113 }
1114
1115 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1116 {
1117 #ifdef CONFIG_PM_SLEEP
1118         dev->power.syscore = val;
1119 #endif
1120 }
1121
1122 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
1123 {
1124         dev->power.driver_flags = flags;
1125 }
1126
1127 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
1128 {
1129         return !!(dev->power.driver_flags & flags);
1130 }
1131
1132 static inline void device_lock(struct device *dev)
1133 {
1134         mutex_lock(&dev->mutex);
1135 }
1136
1137 static inline int device_lock_interruptible(struct device *dev)
1138 {
1139         return mutex_lock_interruptible(&dev->mutex);
1140 }
1141
1142 static inline int device_trylock(struct device *dev)
1143 {
1144         return mutex_trylock(&dev->mutex);
1145 }
1146
1147 static inline void device_unlock(struct device *dev)
1148 {
1149         mutex_unlock(&dev->mutex);
1150 }
1151
1152 static inline void device_lock_assert(struct device *dev)
1153 {
1154         lockdep_assert_held(&dev->mutex);
1155 }
1156
1157 static inline struct device_node *dev_of_node(struct device *dev)
1158 {
1159         if (!IS_ENABLED(CONFIG_OF))
1160                 return NULL;
1161         return dev->of_node;
1162 }
1163
1164 void driver_init(void);
1165
1166 /*
1167  * High level routines for use by the bus drivers
1168  */
1169 extern int __must_check device_register(struct device *dev);
1170 extern void device_unregister(struct device *dev);
1171 extern void device_initialize(struct device *dev);
1172 extern int __must_check device_add(struct device *dev);
1173 extern void device_del(struct device *dev);
1174 extern int device_for_each_child(struct device *dev, void *data,
1175                      int (*fn)(struct device *dev, void *data));
1176 extern int device_for_each_child_reverse(struct device *dev, void *data,
1177                      int (*fn)(struct device *dev, void *data));
1178 extern struct device *device_find_child(struct device *dev, void *data,
1179                                 int (*match)(struct device *dev, void *data));
1180 extern int device_rename(struct device *dev, const char *new_name);
1181 extern int device_move(struct device *dev, struct device *new_parent,
1182                        enum dpm_order dpm_order);
1183 extern const char *device_get_devnode(struct device *dev,
1184                                       umode_t *mode, kuid_t *uid, kgid_t *gid,
1185                                       const char **tmp);
1186
1187 static inline bool device_supports_offline(struct device *dev)
1188 {
1189         return dev->bus && dev->bus->offline && dev->bus->online;
1190 }
1191
1192 extern void lock_device_hotplug(void);
1193 extern void unlock_device_hotplug(void);
1194 extern int lock_device_hotplug_sysfs(void);
1195 extern int device_offline(struct device *dev);
1196 extern int device_online(struct device *dev);
1197 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1198 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1199 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1200
1201 static inline int dev_num_vf(struct device *dev)
1202 {
1203         if (dev->bus && dev->bus->num_vf)
1204                 return dev->bus->num_vf(dev);
1205         return 0;
1206 }
1207
1208 /*
1209  * Root device objects for grouping under /sys/devices
1210  */
1211 extern struct device *__root_device_register(const char *name,
1212                                              struct module *owner);
1213
1214 /* This is a macro to avoid include problems with THIS_MODULE */
1215 #define root_device_register(name) \
1216         __root_device_register(name, THIS_MODULE)
1217
1218 extern void root_device_unregister(struct device *root);
1219
1220 static inline void *dev_get_platdata(const struct device *dev)
1221 {
1222         return dev->platform_data;
1223 }
1224
1225 /*
1226  * Manual binding of a device to driver. See drivers/base/bus.c
1227  * for information on use.
1228  */
1229 extern int __must_check device_bind_driver(struct device *dev);
1230 extern void device_release_driver(struct device *dev);
1231 extern int  __must_check device_attach(struct device *dev);
1232 extern int __must_check driver_attach(struct device_driver *drv);
1233 extern void device_initial_probe(struct device *dev);
1234 extern int __must_check device_reprobe(struct device *dev);
1235
1236 extern bool device_is_bound(struct device *dev);
1237
1238 /*
1239  * Easy functions for dynamically creating devices on the fly
1240  */
1241 extern __printf(5, 0)
1242 struct device *device_create_vargs(struct class *cls, struct device *parent,
1243                                    dev_t devt, void *drvdata,
1244                                    const char *fmt, va_list vargs);
1245 extern __printf(5, 6)
1246 struct device *device_create(struct class *cls, struct device *parent,
1247                              dev_t devt, void *drvdata,
1248                              const char *fmt, ...);
1249 extern __printf(6, 7)
1250 struct device *device_create_with_groups(struct class *cls,
1251                              struct device *parent, dev_t devt, void *drvdata,
1252                              const struct attribute_group **groups,
1253                              const char *fmt, ...);
1254 extern void device_destroy(struct class *cls, dev_t devt);
1255
1256 extern int __must_check device_add_groups(struct device *dev,
1257                                         const struct attribute_group **groups);
1258 extern void device_remove_groups(struct device *dev,
1259                                  const struct attribute_group **groups);
1260
1261 static inline int __must_check device_add_group(struct device *dev,
1262                                         const struct attribute_group *grp)
1263 {
1264         const struct attribute_group *groups[] = { grp, NULL };
1265
1266         return device_add_groups(dev, groups);
1267 }
1268
1269 static inline void device_remove_group(struct device *dev,
1270                                        const struct attribute_group *grp)
1271 {
1272         const struct attribute_group *groups[] = { grp, NULL };
1273
1274         return device_remove_groups(dev, groups);
1275 }
1276
1277 extern int __must_check devm_device_add_groups(struct device *dev,
1278                                         const struct attribute_group **groups);
1279 extern void devm_device_remove_groups(struct device *dev,
1280                                       const struct attribute_group **groups);
1281 extern int __must_check devm_device_add_group(struct device *dev,
1282                                         const struct attribute_group *grp);
1283 extern void devm_device_remove_group(struct device *dev,
1284                                      const struct attribute_group *grp);
1285
1286 /*
1287  * Platform "fixup" functions - allow the platform to have their say
1288  * about devices and actions that the general device layer doesn't
1289  * know about.
1290  */
1291 /* Notify platform of device discovery */
1292 extern int (*platform_notify)(struct device *dev);
1293
1294 extern int (*platform_notify_remove)(struct device *dev);
1295
1296
1297 /*
1298  * get_device - atomically increment the reference count for the device.
1299  *
1300  */
1301 extern struct device *get_device(struct device *dev);
1302 extern void put_device(struct device *dev);
1303
1304 #ifdef CONFIG_DEVTMPFS
1305 extern int devtmpfs_create_node(struct device *dev);
1306 extern int devtmpfs_delete_node(struct device *dev);
1307 extern int devtmpfs_mount(const char *mntdir);
1308 #else
1309 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1310 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1311 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1312 #endif
1313
1314 /* drivers/base/power/shutdown.c */
1315 extern void device_shutdown(void);
1316
1317 /* debugging and troubleshooting/diagnostic helpers. */
1318 extern const char *dev_driver_string(const struct device *dev);
1319
1320 /* Device links interface. */
1321 struct device_link *device_link_add(struct device *consumer,
1322                                     struct device *supplier, u32 flags);
1323 void device_link_del(struct device_link *link);
1324
1325 #ifdef CONFIG_PRINTK
1326
1327 extern __printf(3, 0)
1328 int dev_vprintk_emit(int level, const struct device *dev,
1329                      const char *fmt, va_list args);
1330 extern __printf(3, 4)
1331 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1332
1333 extern __printf(3, 4)
1334 void dev_printk(const char *level, const struct device *dev,
1335                 const char *fmt, ...);
1336 extern __printf(2, 3)
1337 void dev_emerg(const struct device *dev, const char *fmt, ...);
1338 extern __printf(2, 3)
1339 void dev_alert(const struct device *dev, const char *fmt, ...);
1340 extern __printf(2, 3)
1341 void dev_crit(const struct device *dev, const char *fmt, ...);
1342 extern __printf(2, 3)
1343 void dev_err(const struct device *dev, const char *fmt, ...);
1344 extern __printf(2, 3)
1345 void dev_warn(const struct device *dev, const char *fmt, ...);
1346 extern __printf(2, 3)
1347 void dev_notice(const struct device *dev, const char *fmt, ...);
1348 extern __printf(2, 3)
1349 void _dev_info(const struct device *dev, const char *fmt, ...);
1350
1351 #else
1352
1353 static inline __printf(3, 0)
1354 int dev_vprintk_emit(int level, const struct device *dev,
1355                      const char *fmt, va_list args)
1356 { return 0; }
1357 static inline __printf(3, 4)
1358 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1359 { return 0; }
1360
1361 static inline void __dev_printk(const char *level, const struct device *dev,
1362                                 struct va_format *vaf)
1363 {}
1364 static inline __printf(3, 4)
1365 void dev_printk(const char *level, const struct device *dev,
1366                 const char *fmt, ...)
1367 {}
1368
1369 static inline __printf(2, 3)
1370 void dev_emerg(const struct device *dev, const char *fmt, ...)
1371 {}
1372 static inline __printf(2, 3)
1373 void dev_crit(const struct device *dev, const char *fmt, ...)
1374 {}
1375 static inline __printf(2, 3)
1376 void dev_alert(const struct device *dev, const char *fmt, ...)
1377 {}
1378 static inline __printf(2, 3)
1379 void dev_err(const struct device *dev, const char *fmt, ...)
1380 {}
1381 static inline __printf(2, 3)
1382 void dev_warn(const struct device *dev, const char *fmt, ...)
1383 {}
1384 static inline __printf(2, 3)
1385 void dev_notice(const struct device *dev, const char *fmt, ...)
1386 {}
1387 static inline __printf(2, 3)
1388 void _dev_info(const struct device *dev, const char *fmt, ...)
1389 {}
1390
1391 #endif
1392
1393 /*
1394  * Stupid hackaround for existing uses of non-printk uses dev_info
1395  *
1396  * Note that the definition of dev_info below is actually _dev_info
1397  * and a macro is used to avoid redefining dev_info
1398  */
1399
1400 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1401
1402 #if defined(CONFIG_DYNAMIC_DEBUG)
1403 #define dev_dbg(dev, format, ...)                    \
1404 do {                                                 \
1405         dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1406 } while (0)
1407 #elif defined(DEBUG)
1408 #define dev_dbg(dev, format, arg...)            \
1409         dev_printk(KERN_DEBUG, dev, format, ##arg)
1410 #else
1411 #define dev_dbg(dev, format, arg...)                            \
1412 ({                                                              \
1413         if (0)                                                  \
1414                 dev_printk(KERN_DEBUG, dev, format, ##arg);     \
1415 })
1416 #endif
1417
1418 #ifdef CONFIG_PRINTK
1419 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1420 do {                                                                    \
1421         static bool __print_once __read_mostly;                         \
1422                                                                         \
1423         if (!__print_once) {                                            \
1424                 __print_once = true;                                    \
1425                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1426         }                                                               \
1427 } while (0)
1428 #else
1429 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1430 do {                                                                    \
1431         if (0)                                                          \
1432                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1433 } while (0)
1434 #endif
1435
1436 #define dev_emerg_once(dev, fmt, ...)                                   \
1437         dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1438 #define dev_alert_once(dev, fmt, ...)                                   \
1439         dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1440 #define dev_crit_once(dev, fmt, ...)                                    \
1441         dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1442 #define dev_err_once(dev, fmt, ...)                                     \
1443         dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1444 #define dev_warn_once(dev, fmt, ...)                                    \
1445         dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1446 #define dev_notice_once(dev, fmt, ...)                                  \
1447         dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1448 #define dev_info_once(dev, fmt, ...)                                    \
1449         dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1450 #define dev_dbg_once(dev, fmt, ...)                                     \
1451         dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1452
1453 #define dev_level_ratelimited(dev_level, dev, fmt, ...)                 \
1454 do {                                                                    \
1455         static DEFINE_RATELIMIT_STATE(_rs,                              \
1456                                       DEFAULT_RATELIMIT_INTERVAL,       \
1457                                       DEFAULT_RATELIMIT_BURST);         \
1458         if (__ratelimit(&_rs))                                          \
1459                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1460 } while (0)
1461
1462 #define dev_emerg_ratelimited(dev, fmt, ...)                            \
1463         dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1464 #define dev_alert_ratelimited(dev, fmt, ...)                            \
1465         dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1466 #define dev_crit_ratelimited(dev, fmt, ...)                             \
1467         dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1468 #define dev_err_ratelimited(dev, fmt, ...)                              \
1469         dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1470 #define dev_warn_ratelimited(dev, fmt, ...)                             \
1471         dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1472 #define dev_notice_ratelimited(dev, fmt, ...)                           \
1473         dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1474 #define dev_info_ratelimited(dev, fmt, ...)                             \
1475         dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1476 #if defined(CONFIG_DYNAMIC_DEBUG)
1477 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1478 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1479 do {                                                                    \
1480         static DEFINE_RATELIMIT_STATE(_rs,                              \
1481                                       DEFAULT_RATELIMIT_INTERVAL,       \
1482                                       DEFAULT_RATELIMIT_BURST);         \
1483         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
1484         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
1485             __ratelimit(&_rs))                                          \
1486                 __dynamic_dev_dbg(&descriptor, dev, fmt,                \
1487                                   ##__VA_ARGS__);                       \
1488 } while (0)
1489 #elif defined(DEBUG)
1490 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1491 do {                                                                    \
1492         static DEFINE_RATELIMIT_STATE(_rs,                              \
1493                                       DEFAULT_RATELIMIT_INTERVAL,       \
1494                                       DEFAULT_RATELIMIT_BURST);         \
1495         if (__ratelimit(&_rs))                                          \
1496                 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__);        \
1497 } while (0)
1498 #else
1499 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1500 do {                                                                    \
1501         if (0)                                                          \
1502                 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__);        \
1503 } while (0)
1504 #endif
1505
1506 #ifdef VERBOSE_DEBUG
1507 #define dev_vdbg        dev_dbg
1508 #else
1509 #define dev_vdbg(dev, format, arg...)                           \
1510 ({                                                              \
1511         if (0)                                                  \
1512                 dev_printk(KERN_DEBUG, dev, format, ##arg);     \
1513 })
1514 #endif
1515
1516 /*
1517  * dev_WARN*() acts like dev_printk(), but with the key difference of
1518  * using WARN/WARN_ONCE to include file/line information and a backtrace.
1519  */
1520 #define dev_WARN(dev, format, arg...) \
1521         WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1522
1523 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1524         WARN_ONCE(condition, "%s %s: " format, \
1525                         dev_driver_string(dev), dev_name(dev), ## arg)
1526
1527 /* Create alias, so I can be autoloaded. */
1528 #define MODULE_ALIAS_CHARDEV(major,minor) \
1529         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1530 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1531         MODULE_ALIAS("char-major-" __stringify(major) "-*")
1532
1533 #ifdef CONFIG_SYSFS_DEPRECATED
1534 extern long sysfs_deprecated;
1535 #else
1536 #define sysfs_deprecated 0
1537 #endif
1538
1539 /**
1540  * module_driver() - Helper macro for drivers that don't do anything
1541  * special in module init/exit. This eliminates a lot of boilerplate.
1542  * Each module may only use this macro once, and calling it replaces
1543  * module_init() and module_exit().
1544  *
1545  * @__driver: driver name
1546  * @__register: register function for this driver type
1547  * @__unregister: unregister function for this driver type
1548  * @...: Additional arguments to be passed to __register and __unregister.
1549  *
1550  * Use this macro to construct bus specific macros for registering
1551  * drivers, and do not use it on its own.
1552  */
1553 #define module_driver(__driver, __register, __unregister, ...) \
1554 static int __init __driver##_init(void) \
1555 { \
1556         return __register(&(__driver) , ##__VA_ARGS__); \
1557 } \
1558 module_init(__driver##_init); \
1559 static void __exit __driver##_exit(void) \
1560 { \
1561         __unregister(&(__driver) , ##__VA_ARGS__); \
1562 } \
1563 module_exit(__driver##_exit);
1564
1565 /**
1566  * builtin_driver() - Helper macro for drivers that don't do anything
1567  * special in init and have no exit. This eliminates some boilerplate.
1568  * Each driver may only use this macro once, and calling it replaces
1569  * device_initcall (or in some cases, the legacy __initcall).  This is
1570  * meant to be a direct parallel of module_driver() above but without
1571  * the __exit stuff that is not used for builtin cases.
1572  *
1573  * @__driver: driver name
1574  * @__register: register function for this driver type
1575  * @...: Additional arguments to be passed to __register
1576  *
1577  * Use this macro to construct bus specific macros for registering
1578  * drivers, and do not use it on its own.
1579  */
1580 #define builtin_driver(__driver, __register, ...) \
1581 static int __init __driver##_init(void) \
1582 { \
1583         return __register(&(__driver) , ##__VA_ARGS__); \
1584 } \
1585 device_initcall(__driver##_init);
1586
1587 #endif /* _DEVICE_H_ */