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