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 subsystem        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 completion       unloaded;
 129         struct kobject          kobj;
 130         struct klist            klist_devices;
 131         struct klist_node       knode_bus;
 132
 133         struct module           * owner;
 134         const char              * mod_name;     /* used for built-in modules */
 135         struct module_kobject   * mkobj;
 136
 137         int     (*probe)        (struct device * dev);
 138         int     (*remove)       (struct device * dev);
 139         void    (*shutdown)     (struct device * dev);
 140         int     (*suspend)      (struct device * dev, pm_message_t state);
 141         int     (*resume)       (struct device * dev);
 142
 143         unsigned int multithread_probe:1;
 144 };
 145
 146
 147 extern int __must_check driver_register(struct device_driver * drv);
 148 extern void driver_unregister(struct device_driver * drv);
 149
 150 extern struct device_driver * get_driver(struct device_driver * drv);
 151 extern void put_driver(struct device_driver * drv);
 152 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
 153 extern int driver_probe_done(void);
 154
 155 /* sysfs interface for exporting driver attributes */
 156
 157 struct driver_attribute {
 158         struct attribute        attr;
 159         ssize_t (*show)(struct device_driver *, char * buf);
 160         ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
 161 };
 162
 163 #define DRIVER_ATTR(_name,_mode,_show,_store)   \
 164 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
 165
 166 extern int __must_check driver_create_file(struct device_driver *,
 167                                         struct driver_attribute *);
 168 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
 169
 170 extern int __must_check driver_for_each_device(struct device_driver * drv,
 171                 struct device *start, void *data,
 172                 int (*fn)(struct device *, void *));
 173 struct device * driver_find_device(struct device_driver *drv,
 174                                    struct device *start, void *data,
 175                                    int (*match)(struct device *, void *));
 176
 177 /*
 178  * device classes
 179  */
 180 struct class {
 181         const char              * name;
 182         struct module           * owner;
 183
 184         struct subsystem        subsys;
 185         struct list_head        children;
 186         struct list_head        devices;
 187         struct list_head        interfaces;
 188         struct kset             class_dirs;
 189         struct semaphore        sem;    /* locks both the children and interfaces lists */
 190
 191         struct class_attribute          * class_attrs;
 192         struct class_device_attribute   * class_dev_attrs;
 193         struct device_attribute         * dev_attrs;
 194
 195         int     (*uevent)(struct class_device *dev, char **envp,
 196                            int num_envp, char *buffer, int buffer_size);
 197         int     (*dev_uevent)(struct device *dev, char **envp, int num_envp,
 198                                 char *buffer, int buffer_size);
 199
 200         void    (*release)(struct class_device *dev);
 201         void    (*class_release)(struct class *class);
 202         void    (*dev_release)(struct device *dev);
 203
 204         int     (*suspend)(struct device *, pm_message_t state);
 205         int     (*resume)(struct device *);
 206 };
 207
 208 extern int __must_check class_register(struct class *);
 209 extern void class_unregister(struct class *);
 210
 211
 212 struct class_attribute {
 213         struct attribute        attr;
 214         ssize_t (*show)(struct class *, char * buf);
 215         ssize_t (*store)(struct class *, const char * buf, size_t count);
 216 };
 217
 218 #define CLASS_ATTR(_name,_mode,_show,_store)                    \
 219 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
 220
 221 extern int __must_check class_create_file(struct class *,
 222                                         const struct class_attribute *);
 223 extern void class_remove_file(struct class *, const struct class_attribute *);
 224
 225 struct class_device_attribute {
 226         struct attribute        attr;
 227         ssize_t (*show)(struct class_device *, char * buf);
 228         ssize_t (*store)(struct class_device *, const char * buf, size_t count);
 229 };
 230
 231 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store)             \
 232 struct class_device_attribute class_device_attr_##_name =       \
 233         __ATTR(_name,_mode,_show,_store)
 234
 235 extern int __must_check class_device_create_file(struct class_device *,
 236                                     const struct class_device_attribute *);
 237
 238 /**
 239  * struct class_device - class devices
 240  * @class: pointer to the parent class for this class device.  This is required.
 241  * @devt: for internal use by the driver core only.
 242  * @node: for internal use by the driver core only.
 243  * @kobj: for internal use by the driver core only.
 244  * @devt_attr: for internal use by the driver core only.
 245  * @groups: optional additional groups to be created
 246  * @dev: if set, a symlink to the struct device is created in the sysfs
 247  * directory for this struct class device.
 248  * @class_data: pointer to whatever you want to store here for this struct
 249  * class_device.  Use class_get_devdata() and class_set_devdata() to get and
 250  * set this pointer.
 251  * @parent: pointer to a struct class_device that is the parent of this struct
 252  * class_device.  If NULL, this class_device will show up at the root of the
 253  * struct class in sysfs (which is probably what you want to have happen.)
 254  * @release: pointer to a release function for this struct class_device.  If
 255  * set, this will be called instead of the class specific release function.
 256  * Only use this if you want to override the default release function, like
 257  * when you are nesting class_device structures.
 258  * @uevent: pointer to a uevent function for this struct class_device.  If
 259  * set, this will be called instead of the class specific uevent function.
 260  * Only use this if you want to override the default uevent function, like
 261  * when you are nesting class_device structures.
 262  */
 263 struct class_device {
 264         struct list_head        node;
 265
 266         struct kobject          kobj;
 267         struct class            * class;        /* required */
 268         dev_t                   devt;           /* dev_t, creates the sysfs "dev" */
 269         struct class_device_attribute *devt_attr;
 270         struct class_device_attribute uevent_attr;
 271         struct device           * dev;          /* not necessary, but nice to have */
 272         void                    * class_data;   /* class-specific data */
 273         struct class_device     *parent;        /* parent of this child device, if there is one */
 274         struct attribute_group  ** groups;      /* optional groups */
 275
 276         void    (*release)(struct class_device *dev);
 277         int     (*uevent)(struct class_device *dev, char **envp,
 278                            int num_envp, char *buffer, int buffer_size);
 279         char    class_id[BUS_ID_SIZE];  /* unique to this class */
 280 };
 281
 282 static inline void *
 283 class_get_devdata (struct class_device *dev)
 284 {
 285         return dev->class_data;
 286 }
 287
 288 static inline void
 289 class_set_devdata (struct class_device *dev, void *data)
 290 {
 291         dev->class_data = data;
 292 }
 293
 294
 295 extern int __must_check class_device_register(struct class_device *);
 296 extern void class_device_unregister(struct class_device *);
 297 extern void class_device_initialize(struct class_device *);
 298 extern int __must_check class_device_add(struct class_device *);
 299 extern void class_device_del(struct class_device *);
 300
 301 extern struct class_device * class_device_get(struct class_device *);
 302 extern void class_device_put(struct class_device *);
 303
 304 extern void class_device_remove_file(struct class_device *,
 305                                      const struct class_device_attribute *);
 306 extern int __must_check class_device_create_bin_file(struct class_device *,
 307                                         struct bin_attribute *);
 308 extern void class_device_remove_bin_file(struct class_device *,
 309                                          struct bin_attribute *);
 310
 311 struct class_interface {
 312         struct list_head        node;
 313         struct class            *class;
 314
 315         int (*add)      (struct class_device *, struct class_interface *);
 316         void (*remove)  (struct class_device *, struct class_interface *);
 317         int (*add_dev)          (struct device *, struct class_interface *);
 318         void (*remove_dev)      (struct device *, struct class_interface *);
 319 };
 320
 321 extern int __must_check class_interface_register(struct class_interface *);
 322 extern void class_interface_unregister(struct class_interface *);
 323
 324 extern struct class *class_create(struct module *owner, const char *name);
 325 extern void class_destroy(struct class *cls);
 326 extern struct class_device *class_device_create(struct class *cls,
 327                                                 struct class_device *parent,
 328                                                 dev_t devt,
 329                                                 struct device *device,
 330                                                 const char *fmt, ...)
 331                                         __attribute__((format(printf,5,6)));
 332 extern void class_device_destroy(struct class *cls, dev_t devt);
 333
 334 /*
 335  * The type of device, "struct device" is embedded in. A class
 336  * or bus can contain devices of different types
 337  * like "partitions" and "disks", "mouse" and "event".
 338  * This identifies the device type and carries type-specific
 339  * information, equivalent to the kobj_type of a kobject.
 340  * If "name" is specified, the uevent will contain it in
 341  * the DEVTYPE variable.
 342  */
 343 struct device_type {
 344         const char *name;
 345         struct attribute_group **groups;
 346         int (*uevent)(struct device *dev, char **envp, int num_envp,
 347                       char *buffer, int buffer_size);
 348         void (*release)(struct device *dev);
 349 };
 350
 351 /* interface for exporting device attributes */
 352 struct device_attribute {
 353         struct attribute        attr;
 354         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
 355                         char *buf);
 356         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
 357                          const char *buf, size_t count);
 358 };
 359
 360 #define DEVICE_ATTR(_name,_mode,_show,_store) \
 361 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
 362
 363 extern int __must_check device_create_file(struct device *device,
 364                                         struct device_attribute * entry);
 365 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
 366 extern int __must_check device_create_bin_file(struct device *dev,
 367                                                struct bin_attribute *attr);
 368 extern void device_remove_bin_file(struct device *dev,
 369                                    struct bin_attribute *attr);
 370 extern int device_schedule_callback(struct device *dev,
 371                 void (*func)(struct device *));
 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         struct device_attribute uevent_attr;
 419         struct device_attribute *devt_attr;
 420
 421         struct semaphore        sem;    /* semaphore to synchronize calls to
 422                                          * its driver.
 423                                          */
 424
 425         struct bus_type * bus;          /* type of bus device is on */
 426         struct device_driver *driver;   /* which driver has allocated this
 427                                            device */
 428         void            *driver_data;   /* data private to the driver */
 429         void            *platform_data; /* Platform specific data, device
 430                                            core doesn't touch it */
 431         struct dev_pm_info      power;
 432
 433 #ifdef CONFIG_NUMA
 434         int             numa_node;      /* NUMA node this device is close to */
 435 #endif
 436         u64             *dma_mask;      /* dma mask (if dma'able device) */
 437         u64             coherent_dma_mask;/* Like dma_mask, but for
 438                                              alloc_coherent mappings as
 439                                              not all hardware supports
 440                                              64 bit addresses for consistent
 441                                              allocations such descriptors. */
 442
 443         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
 444
 445         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
 446                                              override */
 447         /* arch specific additions */
 448         struct dev_archdata     archdata;
 449
 450         spinlock_t              devres_lock;
 451         struct list_head        devres_head;
 452
 453         /* class_device migration path */
 454         struct list_head        node;
 455         struct class            *class;
 456         dev_t                   devt;           /* dev_t, creates the sysfs "dev" */
 457         struct attribute_group  **groups;       /* optional groups */
 458         int                     uevent_suppress;
 459
 460         void    (*release)(struct device * dev);
 461 };
 462
 463 #ifdef CONFIG_NUMA
 464 static inline int dev_to_node(struct device *dev)
 465 {
 466         return dev->numa_node;
 467 }
 468 static inline void set_dev_node(struct device *dev, int node)
 469 {
 470         dev->numa_node = node;
 471 }
 472 #else
 473 static inline int dev_to_node(struct device *dev)
 474 {
 475         return -1;
 476 }
 477 static inline void set_dev_node(struct device *dev, int node)
 478 {
 479 }
 480 #endif
 481
 482 static inline void *
 483 dev_get_drvdata (struct device *dev)
 484 {
 485         return dev->driver_data;
 486 }
 487
 488 static inline void
 489 dev_set_drvdata (struct device *dev, void *data)
 490 {
 491         dev->driver_data = data;
 492 }
 493
 494 static inline int device_is_registered(struct device *dev)
 495 {
 496         return dev->is_registered;
 497 }
 498
 499 void driver_init(void);
 500
 501 /*
 502  * High level routines for use by the bus drivers
 503  */
 504 extern int __must_check device_register(struct device * dev);
 505 extern void device_unregister(struct device * dev);
 506 extern void device_initialize(struct device * dev);
 507 extern int __must_check device_add(struct device * dev);
 508 extern void device_del(struct device * dev);
 509 extern int device_for_each_child(struct device *, void *,
 510                      int (*fn)(struct device *, void *));
 511 extern struct device *device_find_child(struct device *, void *data,
 512                                         int (*match)(struct device *, void *));
 513 extern int device_rename(struct device *dev, char *new_name);
 514 extern int device_move(struct device *dev, struct device *new_parent);
 515
 516 /*
 517  * Manual binding of a device to driver. See drivers/base/bus.c
 518  * for information on use.
 519  */
 520 extern int __must_check device_bind_driver(struct device *dev);
 521 extern void device_release_driver(struct device * dev);
 522 extern int  __must_check device_attach(struct device * dev);
 523 extern int __must_check driver_attach(struct device_driver *drv);
 524 extern int __must_check device_reprobe(struct device *dev);
 525
 526 /*
 527  * Easy functions for dynamically creating devices on the fly
 528  */
 529 extern struct device *device_create(struct class *cls, struct device *parent,
 530                                     dev_t devt, const char *fmt, ...)
 531                                     __attribute__((format(printf,4,5)));
 532 extern void device_destroy(struct class *cls, dev_t devt);
 533
 534 /*
 535  * Platform "fixup" functions - allow the platform to have their say
 536  * about devices and actions that the general device layer doesn't
 537  * know about.
 538  */
 539 /* Notify platform of device discovery */
 540 extern int (*platform_notify)(struct device * dev);
 541
 542 extern int (*platform_notify_remove)(struct device * dev);
 543
 544
 545 /**
 546  * get_device - atomically increment the reference count for the device.
 547  *
 548  */
 549 extern struct device * get_device(struct device * dev);
 550 extern void put_device(struct device * dev);
 551
 552
 553 /* drivers/base/power/shutdown.c */
 554 extern void device_shutdown(void);
 555
 556
 557 /* drivers/base/firmware.c */
 558 extern int __must_check firmware_register(struct subsystem *);
 559 extern void firmware_unregister(struct subsystem *);
 560
 561 /* debugging and troubleshooting/diagnostic helpers. */
 562 extern const char *dev_driver_string(struct device *dev);
 563 #define dev_printk(level, dev, format, arg...)  \
 564         printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
 565
 566 #ifdef DEBUG
 567 #define dev_dbg(dev, format, arg...)            \
 568         dev_printk(KERN_DEBUG , dev , format , ## arg)
 569 #else
 570 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
 571 #endif
 572
 573 #define dev_err(dev, format, arg...)            \
 574         dev_printk(KERN_ERR , dev , format , ## arg)
 575 #define dev_info(dev, format, arg...)           \
 576         dev_printk(KERN_INFO , dev , format , ## arg)
 577 #define dev_warn(dev, format, arg...)           \
 578         dev_printk(KERN_WARNING , dev , format , ## arg)
 579 #define dev_notice(dev, format, arg...)         \
 580         dev_printk(KERN_NOTICE , dev , format , ## arg)
 581
 582 /* Create alias, so I can be autoloaded. */
 583 #define MODULE_ALIAS_CHARDEV(major,minor) \
 584         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
 585 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
 586         MODULE_ALIAS("char-major-" __stringify(major) "-*")
 587 #endif /* _DEVICE_H_ */