LXR linux/include/linux/sysdev.h

   1/**
   2 * System devices follow a slightly different driver model. 
   3 * They don't need to do dynammic driver binding, can't be probed, 
   4 * and don't reside on any type of peripheral bus. 
   5 * So, we represent and treat them a little differently.
   6 * 
   7 * We still have a notion of a driver for a system device, because we still
   8 * want to perform basic operations on these devices. 
   9 *
  10 * We also support auxillary drivers binding to devices of a certain class.
  11 * 
  12 * This allows configurable drivers to register themselves for devices of
  13 * a certain type. And, it allows class definitions to reside in generic
  14 * code while arch-specific code can register specific drivers.
  15 *
  16 * Auxillary drivers registered with a NULL cls are registered as drivers
  17 * for all system devices, and get notification calls for each device. 
  18 */
  19
  20
  21#ifndef _SYSDEV_H_
  22#define _SYSDEV_H_
  23
  24#include <linux/kobject.h>
  25#include <linux/module.h>
  26#include <linux/pm.h>
  27
  28
  29struct sys_device;
  30
  31struct sysdev_class {
  32        struct list_head        drivers;
  33
  34        /* Default operations for these types of devices */
  35        int     (*shutdown)(struct sys_device *);
  36        int     (*suspend)(struct sys_device *, pm_message_t state);
  37        int     (*resume)(struct sys_device *);
  38        struct kset             kset;
  39};
  40
  41struct sysdev_class_attribute {
  42        struct attribute attr;
  43        ssize_t (*show)(struct sysdev_class *, char *);
  44        ssize_t (*store)(struct sysdev_class *, const char *, size_t);
  45};
  46
  47#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store)             \
  48struct sysdev_class_attribute attr_##_name = {                  \
  49        .attr = {.name = __stringify(_name), .mode = _mode },   \
  50        .show   = _show,                                        \
  51        .store  = _store,                                       \
  52};
  53
  54
  55extern int sysdev_class_register(struct sysdev_class *);
  56extern void sysdev_class_unregister(struct sysdev_class *);
  57
  58extern int sysdev_class_create_file(struct sysdev_class *,
  59        struct sysdev_class_attribute *);
  60extern void sysdev_class_remove_file(struct sysdev_class *,
  61        struct sysdev_class_attribute *);
  62/**
  63 * Auxillary system device drivers.
  64 */
  65
  66struct sysdev_driver {
  67        struct list_head        entry;
  68        int     (*add)(struct sys_device *);
  69        int     (*remove)(struct sys_device *);
  70        int     (*shutdown)(struct sys_device *);
  71        int     (*suspend)(struct sys_device *, pm_message_t state);
  72        int     (*resume)(struct sys_device *);
  73};
  74
  75
  76extern int sysdev_driver_register(struct sysdev_class *, struct sysdev_driver *);
  77extern void sysdev_driver_unregister(struct sysdev_class *, struct sysdev_driver *);
  78
  79
  80/**
  81 * sys_devices can be simplified a lot from regular devices, because they're
  82 * simply not as versatile. 
  83 */
  84
  85struct sys_device {
  86        u32             id;
  87        struct sysdev_class     * cls;
  88        struct kobject          kobj;
  89};
  90
  91extern int sysdev_register(struct sys_device *);
  92extern void sysdev_unregister(struct sys_device *);
  93
  94
  95struct sysdev_attribute { 
  96        struct attribute        attr;
  97        ssize_t (*show)(struct sys_device *, char *);
  98        ssize_t (*store)(struct sys_device *, const char *, size_t);
  99};
 100
 101
 102#define _SYSDEV_ATTR(_name,_mode,_show,_store)                  \
 103{                                                               \
 104        .attr = { .name = __stringify(_name), .mode = _mode,    \
 105                 .owner = THIS_MODULE },                        \
 106        .show   = _show,                                        \
 107        .store  = _store,                                       \
 108}
 109
 110#define SYSDEV_ATTR(_name,_mode,_show,_store)           \
 111struct sysdev_attribute attr_##_name = _SYSDEV_ATTR(_name,_mode,_show,_store);
 112
 113extern int sysdev_create_file(struct sys_device *, struct sysdev_attribute *);
 114extern void sysdev_remove_file(struct sys_device *, struct sysdev_attribute *);
 115
 116#endif /* _SYSDEV_H_ */
 117