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