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