~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/device.h

Version: ~ [ linux-5.2-rc5 ] ~ [ linux-5.1.12 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.53 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.128 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.182 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.182 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.68 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp