include/linux/device.h

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