include/linux/device.h

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