43dcda937ddf82fcb8661372a68899953209e3f2
[~shefty/rdma-dev.git] / include / linux / device.h
1 /*
2  * device.h - generic, centralized driver model
3  *
4  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6  * Copyright (c) 2008-2009 Novell Inc.
7  *
8  * This file is released under the GPLv2
9  *
10  * See Documentation/driver-model/ for more information.
11  */
12
13 #ifndef _DEVICE_H_
14 #define _DEVICE_H_
15
16 #include <linux/ioport.h>
17 #include <linux/kobject.h>
18 #include <linux/klist.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/compiler.h>
22 #include <linux/types.h>
23 #include <linux/mutex.h>
24 #include <linux/pm.h>
25 #include <linux/atomic.h>
26 #include <linux/ratelimit.h>
27 #include <asm/device.h>
28
29 struct device;
30 struct device_private;
31 struct device_driver;
32 struct driver_private;
33 struct module;
34 struct class;
35 struct subsys_private;
36 struct bus_type;
37 struct device_node;
38 struct iommu_ops;
39 struct iommu_group;
40
41 struct bus_attribute {
42         struct attribute        attr;
43         ssize_t (*show)(struct bus_type *bus, char *buf);
44         ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
45 };
46
47 #define BUS_ATTR(_name, _mode, _show, _store)   \
48 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
49
50 extern int __must_check bus_create_file(struct bus_type *,
51                                         struct bus_attribute *);
52 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
53
54 /**
55  * struct bus_type - The bus type of the device
56  *
57  * @name:       The name of the bus.
58  * @dev_name:   Used for subsystems to enumerate devices like ("foo%u", dev->id).
59  * @dev_root:   Default device to use as the parent.
60  * @bus_attrs:  Default attributes of the bus.
61  * @dev_attrs:  Default attributes of the devices on the bus.
62  * @drv_attrs:  Default attributes of the device drivers on the bus.
63  * @match:      Called, perhaps multiple times, whenever a new device or driver
64  *              is added for this bus. It should return a nonzero value if the
65  *              given device can be handled by the given driver.
66  * @uevent:     Called when a device is added, removed, or a few other things
67  *              that generate uevents to add the environment variables.
68  * @probe:      Called when a new device or driver add to this bus, and callback
69  *              the specific driver's probe to initial the matched device.
70  * @remove:     Called when a device removed from this bus.
71  * @shutdown:   Called at shut-down time to quiesce the device.
72  * @suspend:    Called when a device on this bus wants to go to sleep mode.
73  * @resume:     Called to bring a device on this bus out of sleep mode.
74  * @pm:         Power management operations of this bus, callback the specific
75  *              device driver's pm-ops.
76  * @iommu_ops:  IOMMU specific operations for this bus, used to attach IOMMU
77  *              driver implementations to a bus and allow the driver to do
78  *              bus-specific setup
79  * @p:          The private data of the driver core, only the driver core can
80  *              touch this.
81  *
82  * A bus is a channel between the processor and one or more devices. For the
83  * purposes of the device model, all devices are connected via a bus, even if
84  * it is an internal, virtual, "platform" bus. Buses can plug into each other.
85  * A USB controller is usually a PCI device, for example. The device model
86  * represents the actual connections between buses and the devices they control.
87  * A bus is represented by the bus_type structure. It contains the name, the
88  * default attributes, the bus' methods, PM operations, and the driver core's
89  * private data.
90  */
91 struct bus_type {
92         const char              *name;
93         const char              *dev_name;
94         struct device           *dev_root;
95         struct bus_attribute    *bus_attrs;
96         struct device_attribute *dev_attrs;
97         struct driver_attribute *drv_attrs;
98
99         int (*match)(struct device *dev, struct device_driver *drv);
100         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
101         int (*probe)(struct device *dev);
102         int (*remove)(struct device *dev);
103         void (*shutdown)(struct device *dev);
104
105         int (*suspend)(struct device *dev, pm_message_t state);
106         int (*resume)(struct device *dev);
107
108         const struct dev_pm_ops *pm;
109
110         struct iommu_ops *iommu_ops;
111
112         struct subsys_private *p;
113 };
114
115 /* This is a #define to keep the compiler from merging different
116  * instances of the __key variable */
117 #define bus_register(subsys)                    \
118 ({                                              \
119         static struct lock_class_key __key;     \
120         __bus_register(subsys, &__key); \
121 })
122 extern int __must_check __bus_register(struct bus_type *bus,
123                                        struct lock_class_key *key);
124 extern void bus_unregister(struct bus_type *bus);
125
126 extern int __must_check bus_rescan_devices(struct bus_type *bus);
127
128 /* iterator helpers for buses */
129 struct subsys_dev_iter {
130         struct klist_iter               ki;
131         const struct device_type        *type;
132 };
133 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
134                          struct bus_type *subsys,
135                          struct device *start,
136                          const struct device_type *type);
137 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
138 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
139
140 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
141                      int (*fn)(struct device *dev, void *data));
142 struct device *bus_find_device(struct bus_type *bus, struct device *start,
143                                void *data,
144                                int (*match)(struct device *dev, void *data));
145 struct device *bus_find_device_by_name(struct bus_type *bus,
146                                        struct device *start,
147                                        const char *name);
148 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
149                                         struct device *hint);
150 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
151                      void *data, int (*fn)(struct device_driver *, void *));
152 void bus_sort_breadthfirst(struct bus_type *bus,
153                            int (*compare)(const struct device *a,
154                                           const struct device *b));
155 /*
156  * Bus notifiers: Get notified of addition/removal of devices
157  * and binding/unbinding of drivers to devices.
158  * In the long run, it should be a replacement for the platform
159  * notify hooks.
160  */
161 struct notifier_block;
162
163 extern int bus_register_notifier(struct bus_type *bus,
164                                  struct notifier_block *nb);
165 extern int bus_unregister_notifier(struct bus_type *bus,
166                                    struct notifier_block *nb);
167
168 /* All 4 notifers below get called with the target struct device *
169  * as an argument. Note that those functions are likely to be called
170  * with the device lock held in the core, so be careful.
171  */
172 #define BUS_NOTIFY_ADD_DEVICE           0x00000001 /* device added */
173 #define BUS_NOTIFY_DEL_DEVICE           0x00000002 /* device removed */
174 #define BUS_NOTIFY_BIND_DRIVER          0x00000003 /* driver about to be
175                                                       bound */
176 #define BUS_NOTIFY_BOUND_DRIVER         0x00000004 /* driver bound to device */
177 #define BUS_NOTIFY_UNBIND_DRIVER        0x00000005 /* driver about to be
178                                                       unbound */
179 #define BUS_NOTIFY_UNBOUND_DRIVER       0x00000006 /* driver is unbound
180                                                       from the device */
181
182 extern struct kset *bus_get_kset(struct bus_type *bus);
183 extern struct klist *bus_get_device_klist(struct bus_type *bus);
184
185 /**
186  * struct device_driver - The basic device driver structure
187  * @name:       Name of the device driver.
188  * @bus:        The bus which the device of this driver belongs to.
189  * @owner:      The module owner.
190  * @mod_name:   Used for built-in modules.
191  * @suppress_bind_attrs: Disables bind/unbind via sysfs.
192  * @of_match_table: The open firmware table.
193  * @acpi_match_table: The ACPI match table.
194  * @probe:      Called to query the existence of a specific device,
195  *              whether this driver can work with it, and bind the driver
196  *              to a specific device.
197  * @remove:     Called when the device is removed from the system to
198  *              unbind a device from this driver.
199  * @shutdown:   Called at shut-down time to quiesce the device.
200  * @suspend:    Called to put the device to sleep mode. Usually to a
201  *              low power state.
202  * @resume:     Called to bring a device from sleep mode.
203  * @groups:     Default attributes that get created by the driver core
204  *              automatically.
205  * @pm:         Power management operations of the device which matched
206  *              this driver.
207  * @p:          Driver core's private data, no one other than the driver
208  *              core can touch this.
209  *
210  * The device driver-model tracks all of the drivers known to the system.
211  * The main reason for this tracking is to enable the driver core to match
212  * up drivers with new devices. Once drivers are known objects within the
213  * system, however, a number of other things become possible. Device drivers
214  * can export information and configuration variables that are independent
215  * of any specific device.
216  */
217 struct device_driver {
218         const char              *name;
219         struct bus_type         *bus;
220
221         struct module           *owner;
222         const char              *mod_name;      /* used for built-in modules */
223
224         bool suppress_bind_attrs;       /* disables bind/unbind via sysfs */
225
226         const struct of_device_id       *of_match_table;
227         const struct acpi_device_id     *acpi_match_table;
228
229         int (*probe) (struct device *dev);
230         int (*remove) (struct device *dev);
231         void (*shutdown) (struct device *dev);
232         int (*suspend) (struct device *dev, pm_message_t state);
233         int (*resume) (struct device *dev);
234         const struct attribute_group **groups;
235
236         const struct dev_pm_ops *pm;
237
238         struct driver_private *p;
239 };
240
241
242 extern int __must_check driver_register(struct device_driver *drv);
243 extern void driver_unregister(struct device_driver *drv);
244
245 extern struct device_driver *driver_find(const char *name,
246                                          struct bus_type *bus);
247 extern int driver_probe_done(void);
248 extern void wait_for_device_probe(void);
249
250
251 /* sysfs interface for exporting driver attributes */
252
253 struct driver_attribute {
254         struct attribute attr;
255         ssize_t (*show)(struct device_driver *driver, char *buf);
256         ssize_t (*store)(struct device_driver *driver, const char *buf,
257                          size_t count);
258 };
259
260 #define DRIVER_ATTR(_name, _mode, _show, _store)        \
261 struct driver_attribute driver_attr_##_name =           \
262         __ATTR(_name, _mode, _show, _store)
263
264 extern int __must_check driver_create_file(struct device_driver *driver,
265                                         const struct driver_attribute *attr);
266 extern void driver_remove_file(struct device_driver *driver,
267                                const struct driver_attribute *attr);
268
269 extern int __must_check driver_for_each_device(struct device_driver *drv,
270                                                struct device *start,
271                                                void *data,
272                                                int (*fn)(struct device *dev,
273                                                          void *));
274 struct device *driver_find_device(struct device_driver *drv,
275                                   struct device *start, void *data,
276                                   int (*match)(struct device *dev, void *data));
277
278 /**
279  * struct subsys_interface - interfaces to device functions
280  * @name:       name of the device function
281  * @subsys:     subsytem of the devices to attach to
282  * @node:       the list of functions registered at the subsystem
283  * @add_dev:    device hookup to device function handler
284  * @remove_dev: device hookup to device function handler
285  *
286  * Simple interfaces attached to a subsystem. Multiple interfaces can
287  * attach to a subsystem and its devices. Unlike drivers, they do not
288  * exclusively claim or control devices. Interfaces usually represent
289  * a specific functionality of a subsystem/class of devices.
290  */
291 struct subsys_interface {
292         const char *name;
293         struct bus_type *subsys;
294         struct list_head node;
295         int (*add_dev)(struct device *dev, struct subsys_interface *sif);
296         int (*remove_dev)(struct device *dev, struct subsys_interface *sif);
297 };
298
299 int subsys_interface_register(struct subsys_interface *sif);
300 void subsys_interface_unregister(struct subsys_interface *sif);
301
302 int subsys_system_register(struct bus_type *subsys,
303                            const struct attribute_group **groups);
304
305 /**
306  * struct class - device classes
307  * @name:       Name of the class.
308  * @owner:      The module owner.
309  * @class_attrs: Default attributes of this class.
310  * @dev_attrs:  Default attributes of the devices belong to the class.
311  * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
312  * @dev_kobj:   The kobject that represents this class and links it into the hierarchy.
313  * @dev_uevent: Called when a device is added, removed from this class, or a
314  *              few other things that generate uevents to add the environment
315  *              variables.
316  * @devnode:    Callback to provide the devtmpfs.
317  * @class_release: Called to release this class.
318  * @dev_release: Called to release the device.
319  * @suspend:    Used to put the device to sleep mode, usually to a low power
320  *              state.
321  * @resume:     Used to bring the device from the sleep mode.
322  * @ns_type:    Callbacks so sysfs can detemine namespaces.
323  * @namespace:  Namespace of the device belongs to this class.
324  * @pm:         The default device power management operations of this class.
325  * @p:          The private data of the driver core, no one other than the
326  *              driver core can touch this.
327  *
328  * A class is a higher-level view of a device that abstracts out low-level
329  * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
330  * at the class level, they are all simply disks. Classes allow user space
331  * to work with devices based on what they do, rather than how they are
332  * connected or how they work.
333  */
334 struct class {
335         const char              *name;
336         struct module           *owner;
337
338         struct class_attribute          *class_attrs;
339         struct device_attribute         *dev_attrs;
340         struct bin_attribute            *dev_bin_attrs;
341         struct kobject                  *dev_kobj;
342
343         int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
344         char *(*devnode)(struct device *dev, umode_t *mode);
345
346         void (*class_release)(struct class *class);
347         void (*dev_release)(struct device *dev);
348
349         int (*suspend)(struct device *dev, pm_message_t state);
350         int (*resume)(struct device *dev);
351
352         const struct kobj_ns_type_operations *ns_type;
353         const void *(*namespace)(struct device *dev);
354
355         const struct dev_pm_ops *pm;
356
357         struct subsys_private *p;
358 };
359
360 struct class_dev_iter {
361         struct klist_iter               ki;
362         const struct device_type        *type;
363 };
364
365 extern struct kobject *sysfs_dev_block_kobj;
366 extern struct kobject *sysfs_dev_char_kobj;
367 extern int __must_check __class_register(struct class *class,
368                                          struct lock_class_key *key);
369 extern void class_unregister(struct class *class);
370
371 /* This is a #define to keep the compiler from merging different
372  * instances of the __key variable */
373 #define class_register(class)                   \
374 ({                                              \
375         static struct lock_class_key __key;     \
376         __class_register(class, &__key);        \
377 })
378
379 struct class_compat;
380 struct class_compat *class_compat_register(const char *name);
381 void class_compat_unregister(struct class_compat *cls);
382 int class_compat_create_link(struct class_compat *cls, struct device *dev,
383                              struct device *device_link);
384 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
385                               struct device *device_link);
386
387 extern void class_dev_iter_init(struct class_dev_iter *iter,
388                                 struct class *class,
389                                 struct device *start,
390                                 const struct device_type *type);
391 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
392 extern void class_dev_iter_exit(struct class_dev_iter *iter);
393
394 extern int class_for_each_device(struct class *class, struct device *start,
395                                  void *data,
396                                  int (*fn)(struct device *dev, void *data));
397 extern struct device *class_find_device(struct class *class,
398                                         struct device *start, void *data,
399                                         int (*match)(struct device *, void *));
400
401 struct class_attribute {
402         struct attribute attr;
403         ssize_t (*show)(struct class *class, struct class_attribute *attr,
404                         char *buf);
405         ssize_t (*store)(struct class *class, struct class_attribute *attr,
406                         const char *buf, size_t count);
407         const void *(*namespace)(struct class *class,
408                                  const struct class_attribute *attr);
409 };
410
411 #define CLASS_ATTR(_name, _mode, _show, _store)                 \
412 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
413
414 extern int __must_check class_create_file(struct class *class,
415                                           const struct class_attribute *attr);
416 extern void class_remove_file(struct class *class,
417                               const struct class_attribute *attr);
418
419 /* Simple class attribute that is just a static string */
420
421 struct class_attribute_string {
422         struct class_attribute attr;
423         char *str;
424 };
425
426 /* Currently read-only only */
427 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
428         { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
429 #define CLASS_ATTR_STRING(_name, _mode, _str) \
430         struct class_attribute_string class_attr_##_name = \
431                 _CLASS_ATTR_STRING(_name, _mode, _str)
432
433 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
434                         char *buf);
435
436 struct class_interface {
437         struct list_head        node;
438         struct class            *class;
439
440         int (*add_dev)          (struct device *, struct class_interface *);
441         void (*remove_dev)      (struct device *, struct class_interface *);
442 };
443
444 extern int __must_check class_interface_register(struct class_interface *);
445 extern void class_interface_unregister(struct class_interface *);
446
447 extern struct class * __must_check __class_create(struct module *owner,
448                                                   const char *name,
449                                                   struct lock_class_key *key);
450 extern void class_destroy(struct class *cls);
451
452 /* This is a #define to keep the compiler from merging different
453  * instances of the __key variable */
454 #define class_create(owner, name)               \
455 ({                                              \
456         static struct lock_class_key __key;     \
457         __class_create(owner, name, &__key);    \
458 })
459
460 /*
461  * The type of device, "struct device" is embedded in. A class
462  * or bus can contain devices of different types
463  * like "partitions" and "disks", "mouse" and "event".
464  * This identifies the device type and carries type-specific
465  * information, equivalent to the kobj_type of a kobject.
466  * If "name" is specified, the uevent will contain it in
467  * the DEVTYPE variable.
468  */
469 struct device_type {
470         const char *name;
471         const struct attribute_group **groups;
472         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
473         char *(*devnode)(struct device *dev, umode_t *mode);
474         void (*release)(struct device *dev);
475
476         const struct dev_pm_ops *pm;
477 };
478
479 /* interface for exporting device attributes */
480 struct device_attribute {
481         struct attribute        attr;
482         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
483                         char *buf);
484         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
485                          const char *buf, size_t count);
486 };
487
488 struct dev_ext_attribute {
489         struct device_attribute attr;
490         void *var;
491 };
492
493 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
494                           char *buf);
495 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
496                            const char *buf, size_t count);
497 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
498                         char *buf);
499 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
500                          const char *buf, size_t count);
501 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
502                         char *buf);
503 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
504                          const char *buf, size_t count);
505
506 #define DEVICE_ATTR(_name, _mode, _show, _store) \
507         struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
508 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
509         struct dev_ext_attribute dev_attr_##_name = \
510                 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
511 #define DEVICE_INT_ATTR(_name, _mode, _var) \
512         struct dev_ext_attribute dev_attr_##_name = \
513                 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
514 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
515         struct dev_ext_attribute dev_attr_##_name = \
516                 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
517 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
518         struct device_attribute dev_attr_##_name =              \
519                 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
520
521 extern int device_create_file(struct device *device,
522                               const struct device_attribute *entry);
523 extern void device_remove_file(struct device *dev,
524                                const struct device_attribute *attr);
525 extern int __must_check device_create_bin_file(struct device *dev,
526                                         const struct bin_attribute *attr);
527 extern void device_remove_bin_file(struct device *dev,
528                                    const struct bin_attribute *attr);
529 extern int device_schedule_callback_owner(struct device *dev,
530                 void (*func)(struct device *dev), struct module *owner);
531
532 /* This is a macro to avoid include problems with THIS_MODULE */
533 #define device_schedule_callback(dev, func)                     \
534         device_schedule_callback_owner(dev, func, THIS_MODULE)
535
536 /* device resource management */
537 typedef void (*dr_release_t)(struct device *dev, void *res);
538 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
539
540 #ifdef CONFIG_DEBUG_DEVRES
541 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
542                              const char *name);
543 #define devres_alloc(release, size, gfp) \
544         __devres_alloc(release, size, gfp, #release)
545 #else
546 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
547 #endif
548 extern void devres_for_each_res(struct device *dev, dr_release_t release,
549                                 dr_match_t match, void *match_data,
550                                 void (*fn)(struct device *, void *, void *),
551                                 void *data);
552 extern void devres_free(void *res);
553 extern void devres_add(struct device *dev, void *res);
554 extern void *devres_find(struct device *dev, dr_release_t release,
555                          dr_match_t match, void *match_data);
556 extern void *devres_get(struct device *dev, void *new_res,
557                         dr_match_t match, void *match_data);
558 extern void *devres_remove(struct device *dev, dr_release_t release,
559                            dr_match_t match, void *match_data);
560 extern int devres_destroy(struct device *dev, dr_release_t release,
561                           dr_match_t match, void *match_data);
562 extern int devres_release(struct device *dev, dr_release_t release,
563                           dr_match_t match, void *match_data);
564
565 /* devres group */
566 extern void * __must_check devres_open_group(struct device *dev, void *id,
567                                              gfp_t gfp);
568 extern void devres_close_group(struct device *dev, void *id);
569 extern void devres_remove_group(struct device *dev, void *id);
570 extern int devres_release_group(struct device *dev, void *id);
571
572 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
573 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
574 extern void devm_kfree(struct device *dev, void *p);
575
576 void __iomem *devm_request_and_ioremap(struct device *dev,
577                         struct resource *res);
578
579 struct device_dma_parameters {
580         /*
581          * a low level driver may set these to teach IOMMU code about
582          * sg limitations.
583          */
584         unsigned int max_segment_size;
585         unsigned long segment_boundary_mask;
586 };
587
588 struct acpi_dev_node {
589 #ifdef CONFIG_ACPI
590         void    *handle;
591 #endif
592 };
593
594 /**
595  * struct device - The basic device structure
596  * @parent:     The device's "parent" device, the device to which it is attached.
597  *              In most cases, a parent device is some sort of bus or host
598  *              controller. If parent is NULL, the device, is a top-level device,
599  *              which is not usually what you want.
600  * @p:          Holds the private data of the driver core portions of the device.
601  *              See the comment of the struct device_private for detail.
602  * @kobj:       A top-level, abstract class from which other classes are derived.
603  * @init_name:  Initial name of the device.
604  * @type:       The type of device.
605  *              This identifies the device type and carries type-specific
606  *              information.
607  * @mutex:      Mutex to synchronize calls to its driver.
608  * @bus:        Type of bus device is on.
609  * @driver:     Which driver has allocated this
610  * @platform_data: Platform data specific to the device.
611  *              Example: For devices on custom boards, as typical of embedded
612  *              and SOC based hardware, Linux often uses platform_data to point
613  *              to board-specific structures describing devices and how they
614  *              are wired.  That can include what ports are available, chip
615  *              variants, which GPIO pins act in what additional roles, and so
616  *              on.  This shrinks the "Board Support Packages" (BSPs) and
617  *              minimizes board-specific #ifdefs in drivers.
618  * @power:      For device power management.
619  *              See Documentation/power/devices.txt for details.
620  * @pm_domain:  Provide callbacks that are executed during system suspend,
621  *              hibernation, system resume and during runtime PM transitions
622  *              along with subsystem-level and driver-level callbacks.
623  * @numa_node:  NUMA node this device is close to.
624  * @dma_mask:   Dma mask (if dma'ble device).
625  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
626  *              hardware supports 64-bit addresses for consistent allocations
627  *              such descriptors.
628  * @dma_parms:  A low level driver may set these to teach IOMMU code about
629  *              segment limitations.
630  * @dma_pools:  Dma pools (if dma'ble device).
631  * @dma_mem:    Internal for coherent mem override.
632  * @archdata:   For arch-specific additions.
633  * @of_node:    Associated device tree node.
634  * @acpi_node:  Associated ACPI device node.
635  * @devt:       For creating the sysfs "dev".
636  * @id:         device instance
637  * @devres_lock: Spinlock to protect the resource of the device.
638  * @devres_head: The resources list of the device.
639  * @knode_class: The node used to add the device to the class list.
640  * @class:      The class of the device.
641  * @groups:     Optional attribute groups.
642  * @release:    Callback to free the device after all references have
643  *              gone away. This should be set by the allocator of the
644  *              device (i.e. the bus driver that discovered the device).
645  *
646  * At the lowest level, every device in a Linux system is represented by an
647  * instance of struct device. The device structure contains the information
648  * that the device model core needs to model the system. Most subsystems,
649  * however, track additional information about the devices they host. As a
650  * result, it is rare for devices to be represented by bare device structures;
651  * instead, that structure, like kobject structures, is usually embedded within
652  * a higher-level representation of the device.
653  */
654 struct device {
655         struct device           *parent;
656
657         struct device_private   *p;
658
659         struct kobject kobj;
660         const char              *init_name; /* initial name of the device */
661         const struct device_type *type;
662
663         struct mutex            mutex;  /* mutex to synchronize calls to
664                                          * its driver.
665                                          */
666
667         struct bus_type *bus;           /* type of bus device is on */
668         struct device_driver *driver;   /* which driver has allocated this
669                                            device */
670         void            *platform_data; /* Platform specific data, device
671                                            core doesn't touch it */
672         struct dev_pm_info      power;
673         struct dev_pm_domain    *pm_domain;
674
675 #ifdef CONFIG_NUMA
676         int             numa_node;      /* NUMA node this device is close to */
677 #endif
678         u64             *dma_mask;      /* dma mask (if dma'able device) */
679         u64             coherent_dma_mask;/* Like dma_mask, but for
680                                              alloc_coherent mappings as
681                                              not all hardware supports
682                                              64 bit addresses for consistent
683                                              allocations such descriptors. */
684
685         struct device_dma_parameters *dma_parms;
686
687         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
688
689         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
690                                              override */
691 #ifdef CONFIG_CMA
692         struct cma *cma_area;           /* contiguous memory area for dma
693                                            allocations */
694 #endif
695         /* arch specific additions */
696         struct dev_archdata     archdata;
697
698         struct device_node      *of_node; /* associated device tree node */
699         struct acpi_dev_node    acpi_node; /* associated ACPI device node */
700
701         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
702         u32                     id;     /* device instance */
703
704         spinlock_t              devres_lock;
705         struct list_head        devres_head;
706
707         struct klist_node       knode_class;
708         struct class            *class;
709         const struct attribute_group **groups;  /* optional groups */
710
711         void    (*release)(struct device *dev);
712         struct iommu_group      *iommu_group;
713 };
714
715 static inline struct device *kobj_to_dev(struct kobject *kobj)
716 {
717         return container_of(kobj, struct device, kobj);
718 }
719
720 #ifdef CONFIG_ACPI
721 #define ACPI_HANDLE(dev)        ((dev)->acpi_node.handle)
722 #define ACPI_HANDLE_SET(dev, _handle_)  (dev)->acpi_node.handle = (_handle_)
723 #else
724 #define ACPI_HANDLE(dev)        (NULL)
725 #define ACPI_HANDLE_SET(dev, _handle_)  do { } while (0)
726 #endif
727
728 /* Get the wakeup routines, which depend on struct device */
729 #include <linux/pm_wakeup.h>
730
731 static inline const char *dev_name(const struct device *dev)
732 {
733         /* Use the init name until the kobject becomes available */
734         if (dev->init_name)
735                 return dev->init_name;
736
737         return kobject_name(&dev->kobj);
738 }
739
740 extern __printf(2, 3)
741 int dev_set_name(struct device *dev, const char *name, ...);
742
743 #ifdef CONFIG_NUMA
744 static inline int dev_to_node(struct device *dev)
745 {
746         return dev->numa_node;
747 }
748 static inline void set_dev_node(struct device *dev, int node)
749 {
750         dev->numa_node = node;
751 }
752 #else
753 static inline int dev_to_node(struct device *dev)
754 {
755         return -1;
756 }
757 static inline void set_dev_node(struct device *dev, int node)
758 {
759 }
760 #endif
761
762 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
763 {
764         return dev ? dev->power.subsys_data : NULL;
765 }
766
767 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
768 {
769         return dev->kobj.uevent_suppress;
770 }
771
772 static inline void dev_set_uevent_suppress(struct device *dev, int val)
773 {
774         dev->kobj.uevent_suppress = val;
775 }
776
777 static inline int device_is_registered(struct device *dev)
778 {
779         return dev->kobj.state_in_sysfs;
780 }
781
782 static inline void device_enable_async_suspend(struct device *dev)
783 {
784         if (!dev->power.is_prepared)
785                 dev->power.async_suspend = true;
786 }
787
788 static inline void device_disable_async_suspend(struct device *dev)
789 {
790         if (!dev->power.is_prepared)
791                 dev->power.async_suspend = false;
792 }
793
794 static inline bool device_async_suspend_enabled(struct device *dev)
795 {
796         return !!dev->power.async_suspend;
797 }
798
799 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
800 {
801         dev->power.ignore_children = enable;
802 }
803
804 static inline void dev_pm_syscore_device(struct device *dev, bool val)
805 {
806 #ifdef CONFIG_PM_SLEEP
807         dev->power.syscore = val;
808 #endif
809 }
810
811 static inline void device_lock(struct device *dev)
812 {
813         mutex_lock(&dev->mutex);
814 }
815
816 static inline int device_trylock(struct device *dev)
817 {
818         return mutex_trylock(&dev->mutex);
819 }
820
821 static inline void device_unlock(struct device *dev)
822 {
823         mutex_unlock(&dev->mutex);
824 }
825
826 void driver_init(void);
827
828 /*
829  * High level routines for use by the bus drivers
830  */
831 extern int __must_check device_register(struct device *dev);
832 extern void device_unregister(struct device *dev);
833 extern void device_initialize(struct device *dev);
834 extern int __must_check device_add(struct device *dev);
835 extern void device_del(struct device *dev);
836 extern int device_for_each_child(struct device *dev, void *data,
837                      int (*fn)(struct device *dev, void *data));
838 extern struct device *device_find_child(struct device *dev, void *data,
839                                 int (*match)(struct device *dev, void *data));
840 extern int device_rename(struct device *dev, const char *new_name);
841 extern int device_move(struct device *dev, struct device *new_parent,
842                        enum dpm_order dpm_order);
843 extern const char *device_get_devnode(struct device *dev,
844                                       umode_t *mode, const char **tmp);
845 extern void *dev_get_drvdata(const struct device *dev);
846 extern int dev_set_drvdata(struct device *dev, void *data);
847
848 /*
849  * Root device objects for grouping under /sys/devices
850  */
851 extern struct device *__root_device_register(const char *name,
852                                              struct module *owner);
853
854 /*
855  * This is a macro to avoid include problems with THIS_MODULE,
856  * just as per what is done for device_schedule_callback() above.
857  */
858 #define root_device_register(name) \
859         __root_device_register(name, THIS_MODULE)
860
861 extern void root_device_unregister(struct device *root);
862
863 static inline void *dev_get_platdata(const struct device *dev)
864 {
865         return dev->platform_data;
866 }
867
868 /*
869  * Manual binding of a device to driver. See drivers/base/bus.c
870  * for information on use.
871  */
872 extern int __must_check device_bind_driver(struct device *dev);
873 extern void device_release_driver(struct device *dev);
874 extern int  __must_check device_attach(struct device *dev);
875 extern int __must_check driver_attach(struct device_driver *drv);
876 extern int __must_check device_reprobe(struct device *dev);
877
878 /*
879  * Easy functions for dynamically creating devices on the fly
880  */
881 extern struct device *device_create_vargs(struct class *cls,
882                                           struct device *parent,
883                                           dev_t devt,
884                                           void *drvdata,
885                                           const char *fmt,
886                                           va_list vargs);
887 extern __printf(5, 6)
888 struct device *device_create(struct class *cls, struct device *parent,
889                              dev_t devt, void *drvdata,
890                              const char *fmt, ...);
891 extern void device_destroy(struct class *cls, dev_t devt);
892
893 /*
894  * Platform "fixup" functions - allow the platform to have their say
895  * about devices and actions that the general device layer doesn't
896  * know about.
897  */
898 /* Notify platform of device discovery */
899 extern int (*platform_notify)(struct device *dev);
900
901 extern int (*platform_notify_remove)(struct device *dev);
902
903
904 /*
905  * get_device - atomically increment the reference count for the device.
906  *
907  */
908 extern struct device *get_device(struct device *dev);
909 extern void put_device(struct device *dev);
910
911 #ifdef CONFIG_DEVTMPFS
912 extern int devtmpfs_create_node(struct device *dev);
913 extern int devtmpfs_delete_node(struct device *dev);
914 extern int devtmpfs_mount(const char *mntdir);
915 #else
916 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
917 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
918 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
919 #endif
920
921 /* drivers/base/power/shutdown.c */
922 extern void device_shutdown(void);
923
924 /* debugging and troubleshooting/diagnostic helpers. */
925 extern const char *dev_driver_string(const struct device *dev);
926
927
928 #ifdef CONFIG_PRINTK
929
930 extern __printf(3, 0)
931 int dev_vprintk_emit(int level, const struct device *dev,
932                      const char *fmt, va_list args);
933 extern __printf(3, 4)
934 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
935
936 extern __printf(3, 4)
937 int dev_printk(const char *level, const struct device *dev,
938                const char *fmt, ...);
939 extern __printf(2, 3)
940 int dev_emerg(const struct device *dev, const char *fmt, ...);
941 extern __printf(2, 3)
942 int dev_alert(const struct device *dev, const char *fmt, ...);
943 extern __printf(2, 3)
944 int dev_crit(const struct device *dev, const char *fmt, ...);
945 extern __printf(2, 3)
946 int dev_err(const struct device *dev, const char *fmt, ...);
947 extern __printf(2, 3)
948 int dev_warn(const struct device *dev, const char *fmt, ...);
949 extern __printf(2, 3)
950 int dev_notice(const struct device *dev, const char *fmt, ...);
951 extern __printf(2, 3)
952 int _dev_info(const struct device *dev, const char *fmt, ...);
953
954 #else
955
956 static inline __printf(3, 0)
957 int dev_vprintk_emit(int level, const struct device *dev,
958                      const char *fmt, va_list args)
959 { return 0; }
960 static inline __printf(3, 4)
961 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
962 { return 0; }
963
964 static inline int __dev_printk(const char *level, const struct device *dev,
965                                struct va_format *vaf)
966 { return 0; }
967 static inline __printf(3, 4)
968 int dev_printk(const char *level, const struct device *dev,
969                const char *fmt, ...)
970 { return 0; }
971
972 static inline __printf(2, 3)
973 int dev_emerg(const struct device *dev, const char *fmt, ...)
974 { return 0; }
975 static inline __printf(2, 3)
976 int dev_crit(const struct device *dev, const char *fmt, ...)
977 { return 0; }
978 static inline __printf(2, 3)
979 int dev_alert(const struct device *dev, const char *fmt, ...)
980 { return 0; }
981 static inline __printf(2, 3)
982 int dev_err(const struct device *dev, const char *fmt, ...)
983 { return 0; }
984 static inline __printf(2, 3)
985 int dev_warn(const struct device *dev, const char *fmt, ...)
986 { return 0; }
987 static inline __printf(2, 3)
988 int dev_notice(const struct device *dev, const char *fmt, ...)
989 { return 0; }
990 static inline __printf(2, 3)
991 int _dev_info(const struct device *dev, const char *fmt, ...)
992 { return 0; }
993
994 #endif
995
996 /*
997  * Stupid hackaround for existing uses of non-printk uses dev_info
998  *
999  * Note that the definition of dev_info below is actually _dev_info
1000  * and a macro is used to avoid redefining dev_info
1001  */
1002
1003 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1004
1005 #if defined(CONFIG_DYNAMIC_DEBUG)
1006 #define dev_dbg(dev, format, ...)                    \
1007 do {                                                 \
1008         dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1009 } while (0)
1010 #elif defined(DEBUG)
1011 #define dev_dbg(dev, format, arg...)            \
1012         dev_printk(KERN_DEBUG, dev, format, ##arg)
1013 #else
1014 #define dev_dbg(dev, format, arg...)                            \
1015 ({                                                              \
1016         if (0)                                                  \
1017                 dev_printk(KERN_DEBUG, dev, format, ##arg);     \
1018         0;                                                      \
1019 })
1020 #endif
1021
1022 #define dev_level_ratelimited(dev_level, dev, fmt, ...)                 \
1023 do {                                                                    \
1024         static DEFINE_RATELIMIT_STATE(_rs,                              \
1025                                       DEFAULT_RATELIMIT_INTERVAL,       \
1026                                       DEFAULT_RATELIMIT_BURST);         \
1027         if (__ratelimit(&_rs))                                          \
1028                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1029 } while (0)
1030
1031 #define dev_emerg_ratelimited(dev, fmt, ...)                            \
1032         dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1033 #define dev_alert_ratelimited(dev, fmt, ...)                            \
1034         dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1035 #define dev_crit_ratelimited(dev, fmt, ...)                             \
1036         dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1037 #define dev_err_ratelimited(dev, fmt, ...)                              \
1038         dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1039 #define dev_warn_ratelimited(dev, fmt, ...)                             \
1040         dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1041 #define dev_notice_ratelimited(dev, fmt, ...)                           \
1042         dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1043 #define dev_info_ratelimited(dev, fmt, ...)                             \
1044         dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1045 #if defined(CONFIG_DYNAMIC_DEBUG) || defined(DEBUG)
1046 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1047 do {                                                                    \
1048         static DEFINE_RATELIMIT_STATE(_rs,                              \
1049                                       DEFAULT_RATELIMIT_INTERVAL,       \
1050                                       DEFAULT_RATELIMIT_BURST);         \
1051         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
1052         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
1053             __ratelimit(&_rs))                                          \
1054                 __dynamic_pr_debug(&descriptor, pr_fmt(fmt),            \
1055                                    ##__VA_ARGS__);                      \
1056 } while (0)
1057 #else
1058 #define dev_dbg_ratelimited(dev, fmt, ...)                      \
1059         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
1060 #endif
1061
1062 #ifdef VERBOSE_DEBUG
1063 #define dev_vdbg        dev_dbg
1064 #else
1065 #define dev_vdbg(dev, format, arg...)                           \
1066 ({                                                              \
1067         if (0)                                                  \
1068                 dev_printk(KERN_DEBUG, dev, format, ##arg);     \
1069         0;                                                      \
1070 })
1071 #endif
1072
1073 /*
1074  * dev_WARN*() acts like dev_printk(), but with the key difference
1075  * of using a WARN/WARN_ON to get the message out, including the
1076  * file/line information and a backtrace.
1077  */
1078 #define dev_WARN(dev, format, arg...) \
1079         WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1080
1081 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1082         WARN_ONCE(condition, "Device %s\n" format, \
1083                         dev_driver_string(dev), ## arg)
1084
1085 /* Create alias, so I can be autoloaded. */
1086 #define MODULE_ALIAS_CHARDEV(major,minor) \
1087         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1088 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1089         MODULE_ALIAS("char-major-" __stringify(major) "-*")
1090
1091 #ifdef CONFIG_SYSFS_DEPRECATED
1092 extern long sysfs_deprecated;
1093 #else
1094 #define sysfs_deprecated 0
1095 #endif
1096
1097 /**
1098  * module_driver() - Helper macro for drivers that don't do anything
1099  * special in module init/exit. This eliminates a lot of boilerplate.
1100  * Each module may only use this macro once, and calling it replaces
1101  * module_init() and module_exit().
1102  *
1103  * @__driver: driver name
1104  * @__register: register function for this driver type
1105  * @__unregister: unregister function for this driver type
1106  * @...: Additional arguments to be passed to __register and __unregister.
1107  *
1108  * Use this macro to construct bus specific macros for registering
1109  * drivers, and do not use it on its own.
1110  */
1111 #define module_driver(__driver, __register, __unregister, ...) \
1112 static int __init __driver##_init(void) \
1113 { \
1114         return __register(&(__driver) , ##__VA_ARGS__); \
1115 } \
1116 module_init(__driver##_init); \
1117 static void __exit __driver##_exit(void) \
1118 { \
1119         __unregister(&(__driver) , ##__VA_ARGS__); \
1120 } \
1121 module_exit(__driver##_exit);
1122
1123 #endif /* _DEVICE_H_ */