include/linux/device.h

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