include/linux/device.h

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