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