LXR linux/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-2007 Greg Kroah-Hartman <gregkh@suse.de>
   6 *
   7 * This file is released under the GPLv2
   8 *
   9 * See Documentation/driver-model/ for more information.
  10 */
  11
  12#ifndef _DEVICE_H_
  13#define _DEVICE_H_
  14
  15#include <linux/ioport.h>
  16#include <linux/kobject.h>
  17#include <linux/klist.h>
  18#include <linux/list.h>
  19#include <linux/lockdep.h>
  20#include <linux/compiler.h>
  21#include <linux/types.h>
  22#include <linux/module.h>
  23#include <linux/pm.h>
  24#include <linux/semaphore.h>
  25#include <asm/atomic.h>
  26#include <asm/device.h>
  27
  28#define BUS_ID_SIZE             20
  29
  30struct device;
  31struct device_driver;
  32struct driver_private;
  33struct class;
  34struct class_private;
  35struct bus_type;
  36struct bus_type_private;
  37
  38struct bus_attribute {
  39        struct attribute        attr;
  40        ssize_t (*show)(struct bus_type *bus, char *buf);
  41        ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
  42};
  43
  44#define BUS_ATTR(_name, _mode, _show, _store)   \
  45struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
  46
  47extern int __must_check bus_create_file(struct bus_type *,
  48                                        struct bus_attribute *);
  49extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
  50
  51struct bus_type {
  52        const char              *name;
  53        struct bus_attribute    *bus_attrs;
  54        struct device_attribute *dev_attrs;
  55        struct driver_attribute *drv_attrs;
  56
  57        int (*match)(struct device *dev, struct device_driver *drv);
  58        int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
  59        int (*probe)(struct device *dev);
  60        int (*remove)(struct device *dev);
  61        void (*shutdown)(struct device *dev);
  62
  63        int (*suspend)(struct device *dev, pm_message_t state);
  64        int (*suspend_late)(struct device *dev, pm_message_t state);
  65        int (*resume_early)(struct device *dev);
  66        int (*resume)(struct device *dev);
  67
  68        struct dev_pm_ops *pm;
  69
  70        struct bus_type_private *p;
  71};
  72
  73extern int __must_check bus_register(struct bus_type *bus);
  74extern void bus_unregister(struct bus_type *bus);
  75
  76extern int __must_check bus_rescan_devices(struct bus_type *bus);
  77
  78/* iterator helpers for buses */
  79
  80int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
  81                     int (*fn)(struct device *dev, void *data));
  82struct device *bus_find_device(struct bus_type *bus, struct device *start,
  83                               void *data,
  84                               int (*match)(struct device *dev, void *data));
  85struct device *bus_find_device_by_name(struct bus_type *bus,
  86                                       struct device *start,
  87                                       const char *name);
  88
  89int __must_check bus_for_each_drv(struct bus_type *bus,
  90                                  struct device_driver *start, void *data,
  91                                  int (*fn)(struct device_driver *, void *));
  92
  93void bus_sort_breadthfirst(struct bus_type *bus,
  94                           int (*compare)(const struct device *a,
  95                                          const struct device *b));
  96/*
  97 * Bus notifiers: Get notified of addition/removal of devices
  98 * and binding/unbinding of drivers to devices.
  99 * In the long run, it should be a replacement for the platform
 100 * notify hooks.
 101 */
 102struct notifier_block;
 103
 104extern int bus_register_notifier(struct bus_type *bus,
 105                                 struct notifier_block *nb);
 106extern int bus_unregister_notifier(struct bus_type *bus,
 107                                   struct notifier_block *nb);
 108
 109/* All 4 notifers below get called with the target struct device *
 110 * as an argument. Note that those functions are likely to be called
 111 * with the device semaphore held in the core, so be careful.
 112 */
 113#define BUS_NOTIFY_ADD_DEVICE           0x00000001 /* device added */
 114#define BUS_NOTIFY_DEL_DEVICE           0x00000002 /* device removed */
 115#define BUS_NOTIFY_BOUND_DRIVER         0x00000003 /* driver bound to device */
 116#define BUS_NOTIFY_UNBIND_DRIVER        0x00000004 /* driver about to be
 117                                                      unbound */
 118
 119extern struct kset *bus_get_kset(struct bus_type *bus);
 120extern struct klist *bus_get_device_klist(struct bus_type *bus);
 121
 122struct device_driver {
 123        const char              *name;
 124        struct bus_type         *bus;
 125
 126        struct module           *owner;
 127        const char              *mod_name;      /* used for built-in modules */
 128
 129        int (*probe) (struct device *dev);
 130        int (*remove) (struct device *dev);
 131        void (*shutdown) (struct device *dev);
 132        int (*suspend) (struct device *dev, pm_message_t state);
 133        int (*resume) (struct device *dev);
 134        struct attribute_group **groups;
 135
 136        struct dev_pm_ops *pm;
 137
 138        struct driver_private *p;
 139};
 140
 141
 142extern int __must_check driver_register(struct device_driver *drv);
 143extern void driver_unregister(struct device_driver *drv);
 144
 145extern struct device_driver *get_driver(struct device_driver *drv);
 146extern void put_driver(struct device_driver *drv);
 147extern struct device_driver *driver_find(const char *name,
 148                                         struct bus_type *bus);
 149extern int driver_probe_done(void);
 150extern int wait_for_device_probe(void);
 151
 152
 153/* sysfs interface for exporting driver attributes */
 154
 155struct driver_attribute {
 156        struct attribute attr;
 157        ssize_t (*show)(struct device_driver *driver, char *buf);
 158        ssize_t (*store)(struct device_driver *driver, const char *buf,
 159                         size_t count);
 160};
 161
 162#define DRIVER_ATTR(_name, _mode, _show, _store)        \
 163struct driver_attribute driver_attr_##_name =           \
 164        __ATTR(_name, _mode, _show, _store)
 165
 166extern int __must_check driver_create_file(struct device_driver *driver,
 167                                           struct driver_attribute *attr);
 168extern void driver_remove_file(struct device_driver *driver,
 169                               struct driver_attribute *attr);
 170
 171extern int __must_check driver_add_kobj(struct device_driver *drv,
 172                                        struct kobject *kobj,
 173                                        const char *fmt, ...);
 174
 175extern int __must_check driver_for_each_device(struct device_driver *drv,
 176                                               struct device *start,
 177                                               void *data,
 178                                               int (*fn)(struct device *dev,
 179                                                         void *));
 180struct device *driver_find_device(struct device_driver *drv,
 181                                  struct device *start, void *data,
 182                                  int (*match)(struct device *dev, void *data));
 183
 184/*
 185 * device classes
 186 */
 187struct class {
 188        const char              *name;
 189        struct module           *owner;
 190
 191        struct class_attribute          *class_attrs;
 192        struct device_attribute         *dev_attrs;
 193        struct kobject                  *dev_kobj;
 194
 195        int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
 196
 197        void (*class_release)(struct class *class);
 198        void (*dev_release)(struct device *dev);
 199
 200        int (*suspend)(struct device *dev, pm_message_t state);
 201        int (*resume)(struct device *dev);
 202
 203        struct dev_pm_ops *pm;
 204        struct class_private *p;
 205};
 206
 207struct class_dev_iter {
 208        struct klist_iter               ki;
 209        const struct device_type        *type;
 210};
 211
 212extern struct kobject *sysfs_dev_block_kobj;
 213extern struct kobject *sysfs_dev_char_kobj;
 214extern int __must_check __class_register(struct class *class,
 215                                         struct lock_class_key *key);
 216extern void class_unregister(struct class *class);
 217
 218/* This is a #define to keep the compiler from merging different
 219 * instances of the __key variable */
 220#define class_register(class)                   \
 221({                                              \
 222        static struct lock_class_key __key;     \
 223        __class_register(class, &__key);        \
 224})
 225
 226extern void class_dev_iter_init(struct class_dev_iter *iter,
 227                                struct class *class,
 228                                struct device *start,
 229                                const struct device_type *type);
 230extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
 231extern void class_dev_iter_exit(struct class_dev_iter *iter);
 232
 233extern int class_for_each_device(struct class *class, struct device *start,
 234                                 void *data,
 235                                 int (*fn)(struct device *dev, void *data));
 236extern struct device *class_find_device(struct class *class,
 237                                        struct device *start, void *data,
 238                                        int (*match)(struct device *, void *));
 239
 240struct class_attribute {
 241        struct attribute attr;
 242        ssize_t (*show)(struct class *class, char *buf);
 243        ssize_t (*store)(struct class *class, const char *buf, size_t count);
 244};
 245
 246#define CLASS_ATTR(_name, _mode, _show, _store)                 \
 247struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
 248
 249extern int __must_check class_create_file(struct class *class,
 250                                          const struct class_attribute *attr);
 251extern void class_remove_file(struct class *class,
 252                              const struct class_attribute *attr);
 253
 254struct class_interface {
 255        struct list_head        node;
 256        struct class            *class;
 257
 258        int (*add_dev)          (struct device *, struct class_interface *);
 259        void (*remove_dev)      (struct device *, struct class_interface *);
 260};
 261
 262extern int __must_check class_interface_register(struct class_interface *);
 263extern void class_interface_unregister(struct class_interface *);
 264
 265extern struct class * __must_check __class_create(struct module *owner,
 266                                                  const char *name,
 267                                                  struct lock_class_key *key);
 268extern void class_destroy(struct class *cls);
 269
 270/* This is a #define to keep the compiler from merging different
 271 * instances of the __key variable */
 272#define class_create(owner, name)               \
 273({                                              \
 274        static struct lock_class_key __key;     \
 275        __class_create(owner, name, &__key);    \
 276})
 277
 278/*
 279 * The type of device, "struct device" is embedded in. A class
 280 * or bus can contain devices of different types
 281 * like "partitions" and "disks", "mouse" and "event".
 282 * This identifies the device type and carries type-specific
 283 * information, equivalent to the kobj_type of a kobject.
 284 * If "name" is specified, the uevent will contain it in
 285 * the DEVTYPE variable.
 286 */
 287struct device_type {
 288        const char *name;
 289        struct attribute_group **groups;
 290        int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
 291        void (*release)(struct device *dev);
 292
 293        int (*suspend)(struct device *dev, pm_message_t state);
 294        int (*resume)(struct device *dev);
 295
 296        struct dev_pm_ops *pm;
 297};
 298
 299/* interface for exporting device attributes */
 300struct device_attribute {
 301        struct attribute        attr;
 302        ssize_t (*show)(struct device *dev, struct device_attribute *attr,
 303                        char *buf);
 304        ssize_t (*store)(struct device *dev, struct device_attribute *attr,
 305                         const char *buf, size_t count);
 306};
 307
 308#define DEVICE_ATTR(_name, _mode, _show, _store) \
 309struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
 310
 311extern int __must_check device_create_file(struct device *device,
 312                                           struct device_attribute *entry);
 313extern void device_remove_file(struct device *dev,
 314                               struct device_attribute *attr);
 315extern int __must_check device_create_bin_file(struct device *dev,
 316                                               struct bin_attribute *attr);
 317extern void device_remove_bin_file(struct device *dev,
 318                                   struct bin_attribute *attr);
 319extern int device_schedule_callback_owner(struct device *dev,
 320                void (*func)(struct device *dev), struct module *owner);
 321
 322/* This is a macro to avoid include problems with THIS_MODULE */
 323#define device_schedule_callback(dev, func)                     \
 324        device_schedule_callback_owner(dev, func, THIS_MODULE)
 325
 326/* device resource management */
 327typedef void (*dr_release_t)(struct device *dev, void *res);
 328typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
 329
 330#ifdef CONFIG_DEBUG_DEVRES
 331extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
 332                             const char *name);
 333#define devres_alloc(release, size, gfp) \
 334        __devres_alloc(release, size, gfp, #release)
 335#else
 336extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
 337#endif
 338extern void devres_free(void *res);
 339extern void devres_add(struct device *dev, void *res);
 340extern void *devres_find(struct device *dev, dr_release_t release,
 341                         dr_match_t match, void *match_data);
 342extern void *devres_get(struct device *dev, void *new_res,
 343                        dr_match_t match, void *match_data);
 344extern void *devres_remove(struct device *dev, dr_release_t release,
 345                           dr_match_t match, void *match_data);
 346extern int devres_destroy(struct device *dev, dr_release_t release,
 347                          dr_match_t match, void *match_data);
 348
 349/* devres group */
 350extern void * __must_check devres_open_group(struct device *dev, void *id,
 351                                             gfp_t gfp);
 352extern void devres_close_group(struct device *dev, void *id);
 353extern void devres_remove_group(struct device *dev, void *id);
 354extern int devres_release_group(struct device *dev, void *id);
 355
 356/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
 357extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
 358extern void devm_kfree(struct device *dev, void *p);
 359
 360struct device_dma_parameters {
 361        /*
 362         * a low level driver may set these to teach IOMMU code about
 363         * sg limitations.
 364         */
 365        unsigned int max_segment_size;
 366        unsigned long segment_boundary_mask;
 367};
 368
 369struct device {
 370        struct klist            klist_children;
 371        struct klist_node       knode_parent;   /* node in sibling list */
 372        struct klist_node       knode_driver;
 373        struct klist_node       knode_bus;
 374        struct device           *parent;
 375
 376        struct kobject kobj;
 377        char    bus_id[BUS_ID_SIZE];    /* position on parent bus */
 378        unsigned                uevent_suppress:1;
 379        const char              *init_name; /* initial name of the device */
 380        struct device_type      *type;
 381
 382        struct semaphore        sem;    /* semaphore to synchronize calls to
 383                                         * its driver.
 384                                         */
 385
 386        struct bus_type *bus;           /* type of bus device is on */
 387        struct device_driver *driver;   /* which driver has allocated this
 388                                           device */
 389        void            *driver_data;   /* data private to the driver */
 390        void            *platform_data; /* Platform specific data, device
 391                                           core doesn't touch it */
 392        struct dev_pm_info      power;
 393
 394#ifdef CONFIG_NUMA
 395        int             numa_node;      /* NUMA node this device is close to */
 396#endif
 397        u64             *dma_mask;      /* dma mask (if dma'able device) */
 398        u64             coherent_dma_mask;/* Like dma_mask, but for
 399                                             alloc_coherent mappings as
 400                                             not all hardware supports
 401                                             64 bit addresses for consistent
 402                                             allocations such descriptors. */
 403
 404        struct device_dma_parameters *dma_parms;
 405
 406        struct list_head        dma_pools;      /* dma pools (if dma'ble) */
 407
 408        struct dma_coherent_mem *dma_mem; /* internal for coherent mem
 409                                             override */
 410        /* arch specific additions */
 411        struct dev_archdata     archdata;
 412
 413        dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
 414
 415        spinlock_t              devres_lock;
 416        struct list_head        devres_head;
 417
 418        struct klist_node       knode_class;
 419        struct class            *class;
 420        struct attribute_group  **groups;       /* optional groups */
 421
 422        void    (*release)(struct device *dev);
 423};
 424
 425/* Get the wakeup routines, which depend on struct device */
 426#include <linux/pm_wakeup.h>
 427
 428static inline const char *dev_name(const struct device *dev)
 429{
 430        /* will be changed into kobject_name(&dev->kobj) in the near future */
 431        return dev->bus_id;
 432}
 433
 434extern int dev_set_name(struct device *dev, const char *name, ...)
 435                        __attribute__((format(printf, 2, 3)));
 436
 437#ifdef CONFIG_NUMA
 438static inline int dev_to_node(struct device *dev)
 439{
 440        return dev->numa_node;
 441}
 442static inline void set_dev_node(struct device *dev, int node)
 443{
 444        dev->numa_node = node;
 445}
 446#else
 447static inline int dev_to_node(struct device *dev)
 448{
 449        return -1;
 450}
 451static inline void set_dev_node(struct device *dev, int node)
 452{
 453}
 454#endif
 455
 456static inline void *dev_get_drvdata(const struct device *dev)
 457{
 458        return dev->driver_data;
 459}
 460
 461static inline void dev_set_drvdata(struct device *dev, void *data)
 462{
 463        dev->driver_data = data;
 464}
 465
 466static inline int device_is_registered(struct device *dev)
 467{
 468        return dev->kobj.state_in_sysfs;
 469}
 470
 471void driver_init(void);
 472
 473/*
 474 * High level routines for use by the bus drivers
 475 */
 476extern int __must_check device_register(struct device *dev);
 477extern void device_unregister(struct device *dev);
 478extern void device_initialize(struct device *dev);
 479extern int __must_check device_add(struct device *dev);
 480extern void device_del(struct device *dev);
 481extern int device_for_each_child(struct device *dev, void *data,
 482                     int (*fn)(struct device *dev, void *data));
 483extern struct device *device_find_child(struct device *dev, void *data,
 484                                int (*match)(struct device *dev, void *data));
 485extern int device_rename(struct device *dev, char *new_name);
 486extern int device_move(struct device *dev, struct device *new_parent);
 487
 488/*
 489 * Root device objects for grouping under /sys/devices
 490 */
 491extern struct device *__root_device_register(const char *name,
 492                                             struct module *owner);
 493static inline struct device *root_device_register(const char *name)
 494{
 495        return __root_device_register(name, THIS_MODULE);
 496}
 497extern void root_device_unregister(struct device *root);
 498
 499/*
 500 * Manual binding of a device to driver. See drivers/base/bus.c
 501 * for information on use.
 502 */
 503extern int __must_check device_bind_driver(struct device *dev);
 504extern void device_release_driver(struct device *dev);
 505extern int  __must_check device_attach(struct device *dev);
 506extern int __must_check driver_attach(struct device_driver *drv);
 507extern int __must_check device_reprobe(struct device *dev);
 508
 509/*
 510 * Easy functions for dynamically creating devices on the fly
 511 */
 512extern struct device *device_create_vargs(struct class *cls,
 513                                          struct device *parent,
 514                                          dev_t devt,
 515                                          void *drvdata,
 516                                          const char *fmt,
 517                                          va_list vargs);
 518extern struct device *device_create(struct class *cls, struct device *parent,
 519                                    dev_t devt, void *drvdata,
 520                                    const char *fmt, ...)
 521                                    __attribute__((format(printf, 5, 6)));
 522extern void device_destroy(struct class *cls, dev_t devt);
 523
 524/*
 525 * Platform "fixup" functions - allow the platform to have their say
 526 * about devices and actions that the general device layer doesn't
 527 * know about.
 528 */
 529/* Notify platform of device discovery */
 530extern int (*platform_notify)(struct device *dev);
 531
 532extern int (*platform_notify_remove)(struct device *dev);
 533
 534
 535/**
 536 * get_device - atomically increment the reference count for the device.
 537 *
 538 */
 539extern struct device *get_device(struct device *dev);
 540extern void put_device(struct device *dev);
 541
 542
 543/* drivers/base/power/shutdown.c */
 544extern void device_shutdown(void);
 545
 546/* drivers/base/sys.c */
 547extern void sysdev_shutdown(void);
 548
 549/* debugging and troubleshooting/diagnostic helpers. */
 550extern const char *dev_driver_string(const struct device *dev);
 551#define dev_printk(level, dev, format, arg...)  \
 552        printk(level "%s %s: " format , dev_driver_string(dev) , \
 553               dev_name(dev) , ## arg)
 554
 555#define dev_emerg(dev, format, arg...)          \
 556        dev_printk(KERN_EMERG , dev , format , ## arg)
 557#define dev_alert(dev, format, arg...)          \
 558        dev_printk(KERN_ALERT , dev , format , ## arg)
 559#define dev_crit(dev, format, arg...)           \
 560        dev_printk(KERN_CRIT , dev , format , ## arg)
 561#define dev_err(dev, format, arg...)            \
 562        dev_printk(KERN_ERR , dev , format , ## arg)
 563#define dev_warn(dev, format, arg...)           \
 564        dev_printk(KERN_WARNING , dev , format , ## arg)
 565#define dev_notice(dev, format, arg...)         \
 566        dev_printk(KERN_NOTICE , dev , format , ## arg)
 567#define dev_info(dev, format, arg...)           \
 568        dev_printk(KERN_INFO , dev , format , ## arg)
 569
 570#if defined(DEBUG)
 571#define dev_dbg(dev, format, arg...)            \
 572        dev_printk(KERN_DEBUG , dev , format , ## arg)
 573#elif defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
 574#define dev_dbg(dev, format, ...) do { \
 575        dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
 576        } while (0)
 577#else
 578#define dev_dbg(dev, format, arg...)            \
 579        ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
 580#endif
 581
 582#ifdef VERBOSE_DEBUG
 583#define dev_vdbg        dev_dbg
 584#else
 585
 586#define dev_vdbg(dev, format, arg...)           \
 587        ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
 588#endif
 589
 590/*
 591 * dev_WARN() acts like dev_printk(), but with the key difference
 592 * of using a WARN/WARN_ON to get the message out, including the
 593 * file/line information and a backtrace.
 594 */
 595#define dev_WARN(dev, format, arg...) \
 596        WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
 597
 598/* Create alias, so I can be autoloaded. */
 599#define MODULE_ALIAS_CHARDEV(major,minor) \
 600        MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
 601#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
 602        MODULE_ALIAS("char-major-" __stringify(major) "-*")
 603#endif /* _DEVICE_H_ */
 604