include/linux/device.h

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