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