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