include/linux/device.h

   1 /*
   2  * device.h - generic, centralized driver model
   3  *
   4  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
   5  *
   6  * This file is released under the GPLv2
   7  *
   8  * See Documentation/driver-model/ for more information.
   9  */
  10
  11 #ifndef _DEVICE_H_
  12 #define _DEVICE_H_
  13
  14 #include <linux/config.h>
  15 #include <linux/ioport.h>
  16 #include <linux/kobject.h>
  17 #include <linux/list.h>
  18 #include <linux/spinlock.h>
  19 #include <linux/types.h>
  20 #include <linux/module.h>
  21 #include <linux/pm.h>
  22 #include <asm/semaphore.h>
  23 #include <asm/atomic.h>
  24
  25 #define DEVICE_NAME_SIZE        50
  26 #define DEVICE_NAME_HALF        __stringify(20) /* Less than half to accommodate slop */
  27 #define DEVICE_ID_SIZE          32
  28 #define BUS_ID_SIZE             KOBJ_NAME_LEN
  29
  30
  31 enum {
  32         SUSPEND_NOTIFY,
  33         SUSPEND_SAVE_STATE,
  34         SUSPEND_DISABLE,
  35         SUSPEND_POWER_DOWN,
  36 };
  37
  38 enum {
  39         RESUME_POWER_ON,
  40         RESUME_RESTORE_STATE,
  41         RESUME_ENABLE,
  42 };
  43
  44 struct device;
  45 struct device_driver;
  46 struct class;
  47 struct class_device;
  48 struct class_simple;
  49
  50 struct bus_type {
  51         char                    * name;
  52
  53         struct subsystem        subsys;
  54         struct kset             drivers;
  55         struct kset             devices;
  56
  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             (*hotplug) (struct device *dev, char **envp,
  63                                     int num_envp, char *buffer, int buffer_size);
  64         int             (*suspend)(struct device * dev, u32 state);
  65         int             (*resume)(struct device * dev);
  66 };
  67
  68 extern int bus_register(struct bus_type * bus);
  69 extern void bus_unregister(struct bus_type * bus);
  70
  71 extern int bus_rescan_devices(struct bus_type * bus);
  72
  73 extern struct bus_type * get_bus(struct bus_type * bus);
  74 extern void put_bus(struct bus_type * bus);
  75
  76 extern struct bus_type * find_bus(char * name);
  77
  78 /* iterator helpers for buses */
  79
  80 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
  81                      int (*fn)(struct device *, void *));
  82
  83 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
  84                      void * data, int (*fn)(struct device_driver *, void *));
  85
  86
  87 /* driverfs interface for exporting bus attributes */
  88
  89 struct bus_attribute {
  90         struct attribute        attr;
  91         ssize_t (*show)(struct bus_type *, char * buf);
  92         ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
  93 };
  94
  95 #define BUS_ATTR(_name,_mode,_show,_store)      \
  96 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
  97
  98 extern int bus_create_file(struct bus_type *, struct bus_attribute *);
  99 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
 100
 101 struct device_driver {
 102         char                    * name;
 103         struct bus_type         * bus;
 104
 105         struct semaphore        unload_sem;
 106         struct kobject          kobj;
 107         struct list_head        devices;
 108
 109         struct module           * owner;
 110
 111         int     (*probe)        (struct device * dev);
 112         int     (*remove)       (struct device * dev);
 113         void    (*shutdown)     (struct device * dev);
 114         int     (*suspend)      (struct device * dev, u32 state, u32 level);
 115         int     (*resume)       (struct device * dev, u32 level);
 116 };
 117
 118
 119 extern int driver_register(struct device_driver * drv);
 120 extern void driver_unregister(struct device_driver * drv);
 121
 122 extern struct device_driver * get_driver(struct device_driver * drv);
 123 extern void put_driver(struct device_driver * drv);
 124 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
 125
 126
 127 /* driverfs interface for exporting driver attributes */
 128
 129 struct driver_attribute {
 130         struct attribute        attr;
 131         ssize_t (*show)(struct device_driver *, char * buf);
 132         ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
 133 };
 134
 135 #define DRIVER_ATTR(_name,_mode,_show,_store)   \
 136 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
 137
 138 extern int driver_create_file(struct device_driver *, struct driver_attribute *);
 139 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
 140
 141
 142 /*
 143  * device classes
 144  */
 145 struct class {
 146         char                    * name;
 147
 148         struct subsystem        subsys;
 149         struct list_head        children;
 150         struct list_head        interfaces;
 151
 152         struct class_attribute          * class_attrs;
 153         struct class_device_attribute   * class_dev_attrs;
 154
 155         int     (*hotplug)(struct class_device *dev, char **envp,
 156                            int num_envp, char *buffer, int buffer_size);
 157
 158         void    (*release)(struct class_device *dev);
 159         void    (*class_release)(struct class *class);
 160 };
 161
 162 extern int class_register(struct class *);
 163 extern void class_unregister(struct class *);
 164
 165 extern struct class * class_get(struct class *);
 166 extern void class_put(struct class *);
 167
 168
 169 struct class_attribute {
 170         struct attribute        attr;
 171         ssize_t (*show)(struct class *, char * buf);
 172         ssize_t (*store)(struct class *, const char * buf, size_t count);
 173 };
 174
 175 #define CLASS_ATTR(_name,_mode,_show,_store)                    \
 176 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
 177
 178 extern int class_create_file(struct class *, const struct class_attribute *);
 179 extern void class_remove_file(struct class *, const struct class_attribute *);
 180
 181
 182 struct class_device {
 183         struct list_head        node;
 184
 185         struct kobject          kobj;
 186         struct class            * class;        /* required */
 187         struct device           * dev;          /* not necessary, but nice to have */
 188         void                    * class_data;   /* class-specific data */
 189
 190         char    class_id[BUS_ID_SIZE];  /* unique to this class */
 191 };
 192
 193 static inline void *
 194 class_get_devdata (struct class_device *dev)
 195 {
 196         return dev->class_data;
 197 }
 198
 199 static inline void
 200 class_set_devdata (struct class_device *dev, void *data)
 201 {
 202         dev->class_data = data;
 203 }
 204
 205
 206 extern int class_device_register(struct class_device *);
 207 extern void class_device_unregister(struct class_device *);
 208 extern void class_device_initialize(struct class_device *);
 209 extern int class_device_add(struct class_device *);
 210 extern void class_device_del(struct class_device *);
 211
 212 extern int class_device_rename(struct class_device *, char *);
 213
 214 extern struct class_device * class_device_get(struct class_device *);
 215 extern void class_device_put(struct class_device *);
 216
 217 struct class_device_attribute {
 218         struct attribute        attr;
 219         ssize_t (*show)(struct class_device *, char * buf);
 220         ssize_t (*store)(struct class_device *, const char * buf, size_t count);
 221 };
 222
 223 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store)             \
 224 struct class_device_attribute class_device_attr_##_name =       \
 225         __ATTR(_name,_mode,_show,_store)
 226
 227 extern int class_device_create_file(struct class_device *,
 228                                     const struct class_device_attribute *);
 229 extern void class_device_remove_file(struct class_device *,
 230                                      const struct class_device_attribute *);
 231
 232
 233 struct class_interface {
 234         struct list_head        node;
 235         struct class            *class;
 236
 237         int (*add)      (struct class_device *);
 238         void (*remove)  (struct class_device *);
 239 };
 240
 241 extern int class_interface_register(struct class_interface *);
 242 extern void class_interface_unregister(struct class_interface *);
 243
 244 /* interface for class simple stuff */
 245 extern struct class_simple *class_simple_create(struct module *owner, char *name);
 246 extern void class_simple_destroy(struct class_simple *cs);
 247 extern struct class_device *class_simple_device_add(struct class_simple *cs, dev_t dev, struct device *device, const char *fmt, ...)
 248         __attribute__((format(printf,4,5)));
 249 extern int class_simple_set_hotplug(struct class_simple *,
 250         int (*hotplug)(struct class_device *dev, char **envp, int num_envp, char *buffer, int buffer_size));
 251 extern void class_simple_device_remove(dev_t dev);
 252
 253
 254 struct device {
 255         struct list_head node;          /* node in sibling list */
 256         struct list_head bus_list;      /* node in bus's list */
 257         struct list_head driver_list;
 258         struct list_head children;
 259         struct device   * parent;
 260
 261         struct kobject kobj;
 262         char    bus_id[BUS_ID_SIZE];    /* position on parent bus */
 263
 264         struct bus_type * bus;          /* type of bus device is on */
 265         struct device_driver *driver;   /* which driver has allocated this
 266                                            device */
 267         void            *driver_data;   /* data private to the driver */
 268         void            *platform_data; /* Platform specific data (e.g. ACPI,
 269                                            BIOS data relevant to device) */
 270         struct dev_pm_info      power;
 271
 272         u32             detach_state;   /* State to enter when device is
 273                                            detached from its driver. */
 274
 275         u64             *dma_mask;      /* dma mask (if dma'able device) */
 276         u64             coherent_dma_mask;/* Like dma_mask, but for
 277                                              alloc_coherent mappings as
 278                                              not all hardware supports
 279                                              64 bit addresses for consistent
 280                                              allocations such descriptors. */
 281
 282         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
 283
 284         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
 285                                              override */
 286
 287         void    (*release)(struct device * dev);
 288 };
 289
 290 static inline struct device *
 291 list_to_dev(struct list_head *node)
 292 {
 293         return list_entry(node, struct device, node);
 294 }
 295
 296 static inline void *
 297 dev_get_drvdata (struct device *dev)
 298 {
 299         return dev->driver_data;
 300 }
 301
 302 static inline void
 303 dev_set_drvdata (struct device *dev, void *data)
 304 {
 305         dev->driver_data = data;
 306 }
 307
 308 /*
 309  * High level routines for use by the bus drivers
 310  */
 311 extern int device_register(struct device * dev);
 312 extern void device_unregister(struct device * dev);
 313 extern void device_initialize(struct device * dev);
 314 extern int device_add(struct device * dev);
 315 extern void device_del(struct device * dev);
 316 extern int device_for_each_child(struct device *, void *,
 317                      int (*fn)(struct device *, void *));
 318
 319 /*
 320  * Manual binding of a device to driver. See drivers/base/bus.c
 321  * for information on use.
 322  */
 323 extern int  driver_probe_device(struct device_driver * drv, struct device * dev);
 324 extern void device_bind_driver(struct device * dev);
 325 extern void device_release_driver(struct device * dev);
 326 extern int  device_attach(struct device * dev);
 327 extern void driver_attach(struct device_driver * drv);
 328
 329
 330 /* driverfs interface for exporting device attributes */
 331
 332 struct device_attribute {
 333         struct attribute        attr;
 334         ssize_t (*show)(struct device * dev, char * buf);
 335         ssize_t (*store)(struct device * dev, const char * buf, size_t count);
 336 };
 337
 338 #define DEVICE_ATTR(_name,_mode,_show,_store) \
 339 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
 340
 341
 342 extern int device_create_file(struct device *device, struct device_attribute * entry);
 343 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
 344
 345 /*
 346  * Platform "fixup" functions - allow the platform to have their say
 347  * about devices and actions that the general device layer doesn't
 348  * know about.
 349  */
 350 /* Notify platform of device discovery */
 351 extern int (*platform_notify)(struct device * dev);
 352
 353 extern int (*platform_notify_remove)(struct device * dev);
 354
 355
 356 /**
 357  * get_device - atomically increment the reference count for the device.
 358  *
 359  */
 360 extern struct device * get_device(struct device * dev);
 361 extern void put_device(struct device * dev);
 362 extern struct device *device_find(const char *name, struct bus_type *bus);
 363
 364
 365 /* drivers/base/platform.c */
 366
 367 struct platform_device {
 368         char            * name;
 369         u32             id;
 370         struct device   dev;
 371         u32             num_resources;
 372         struct resource * resource;
 373 };
 374
 375 #define to_platform_device(x) container_of((x), struct platform_device, dev)
 376
 377 extern int platform_device_register(struct platform_device *);
 378 extern void platform_device_unregister(struct platform_device *);
 379
 380 extern struct bus_type platform_bus_type;
 381 extern struct device platform_bus;
 382
 383 extern struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
 384 extern int platform_get_irq(struct platform_device *, unsigned int);
 385 extern int platform_add_devices(struct platform_device **, int);
 386
 387 extern struct platform_device *platform_device_register_simple(char *, unsigned int, struct resource *, unsigned int);
 388
 389 /* drivers/base/power.c */
 390 extern void device_shutdown(void);
 391
 392
 393 /* drivers/base/firmware.c */
 394 extern int firmware_register(struct subsystem *);
 395 extern void firmware_unregister(struct subsystem *);
 396
 397 /* debugging and troubleshooting/diagnostic helpers. */
 398 #define dev_printk(level, dev, format, arg...)  \
 399         printk(level "%s %s: " format , (dev)->driver ? (dev)->driver->name : "" , (dev)->bus_id , ## arg)
 400
 401 #ifdef DEBUG
 402 #define dev_dbg(dev, format, arg...)            \
 403         dev_printk(KERN_DEBUG , dev , format , ## arg)
 404 #else
 405 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
 406 #endif
 407
 408 #define dev_err(dev, format, arg...)            \
 409         dev_printk(KERN_ERR , dev , format , ## arg)
 410 #define dev_info(dev, format, arg...)           \
 411         dev_printk(KERN_INFO , dev , format , ## arg)
 412 #define dev_warn(dev, format, arg...)           \
 413         dev_printk(KERN_WARNING , dev , format , ## arg)
 414
 415 /* Create alias, so I can be autoloaded. */
 416 #define MODULE_ALIAS_CHARDEV(major,minor) \
 417         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
 418 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
 419         MODULE_ALIAS("char-major-" __stringify(major) "-*")
 420 #endif /* _DEVICE_H_ */