include/linux/serio.h

   1 #ifndef _SERIO_H
   2 #define _SERIO_H
   3
   4 /*
   5  * Copyright (C) 1999-2002 Vojtech Pavlik
   6 *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License version 2 as published by
   9  * the Free Software Foundation.
  10  */
  11
  12 #include <linux/ioctl.h>
  13
  14 #define SPIOCSTYPE      _IOW('q', 0x01, unsigned long)
  15
  16 #ifdef __KERNEL__
  17
  18 #include <linux/interrupt.h>
  19 #include <linux/list.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/mutex.h>
  22 #include <linux/device.h>
  23 #include <linux/mod_devicetable.h>
  24
  25 struct serio {
  26         void *port_data;
  27
  28         char name[32];
  29         char phys[32];
  30
  31         unsigned int manual_bind;
  32
  33         struct serio_device_id id;
  34
  35         spinlock_t lock;                /* protects critical sections from port's interrupt handler */
  36
  37         int (*write)(struct serio *, unsigned char);
  38         int (*open)(struct serio *);
  39         void (*close)(struct serio *);
  40         int (*start)(struct serio *);
  41         void (*stop)(struct serio *);
  42
  43         struct serio *parent, *child;
  44         unsigned int depth;             /* level of nesting in serio hierarchy */
  45
  46         struct serio_driver *drv;       /* accessed from interrupt, must be protected by serio->lock and serio->sem */
  47         struct mutex drv_mutex;         /* protects serio->drv so attributes can pin driver */
  48
  49         struct device dev;
  50         unsigned int registered;        /* port has been fully registered with driver core */
  51
  52         struct list_head node;
  53 };
  54 #define to_serio_port(d)        container_of(d, struct serio, dev)
  55
  56 struct serio_driver {
  57         void *private;
  58         char *description;
  59
  60         struct serio_device_id *id_table;
  61         unsigned int manual_bind;
  62
  63         void (*write_wakeup)(struct serio *);
  64         irqreturn_t (*interrupt)(struct serio *, unsigned char, unsigned int);
  65         int  (*connect)(struct serio *, struct serio_driver *drv);
  66         int  (*reconnect)(struct serio *);
  67         void (*disconnect)(struct serio *);
  68         void (*cleanup)(struct serio *);
  69
  70         struct device_driver driver;
  71 };
  72 #define to_serio_driver(d)      container_of(d, struct serio_driver, driver)
  73
  74 int serio_open(struct serio *serio, struct serio_driver *drv);
  75 void serio_close(struct serio *serio);
  76 void serio_rescan(struct serio *serio);
  77 void serio_reconnect(struct serio *serio);
  78 irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
  79
  80 void __serio_register_port(struct serio *serio, struct module *owner);
  81 static inline void serio_register_port(struct serio *serio)
  82 {
  83         __serio_register_port(serio, THIS_MODULE);
  84 }
  85
  86 void serio_unregister_port(struct serio *serio);
  87 void serio_unregister_child_port(struct serio *serio);
  88
  89 int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name);
  90 static inline int serio_register_driver(struct serio_driver *drv)
  91 {
  92         return __serio_register_driver(drv, THIS_MODULE, KBUILD_MODNAME);
  93 }
  94 int serio_register_driver(struct serio_driver *drv);
  95 void serio_unregister_driver(struct serio_driver *drv);
  96
  97 static inline int serio_write(struct serio *serio, unsigned char data)
  98 {
  99         if (serio->write)
 100                 return serio->write(serio, data);
 101         else
 102                 return -1;
 103 }
 104
 105 static inline void serio_drv_write_wakeup(struct serio *serio)
 106 {
 107         if (serio->drv && serio->drv->write_wakeup)
 108                 serio->drv->write_wakeup(serio);
 109 }
 110
 111 static inline void serio_cleanup(struct serio *serio)
 112 {
 113         if (serio->drv && serio->drv->cleanup)
 114                 serio->drv->cleanup(serio);
 115 }
 116
 117 /*
 118  * Use the following functions to manipulate serio's per-port
 119  * driver-specific data.
 120  */
 121 static inline void *serio_get_drvdata(struct serio *serio)
 122 {
 123         return dev_get_drvdata(&serio->dev);
 124 }
 125
 126 static inline void serio_set_drvdata(struct serio *serio, void *data)
 127 {
 128         dev_set_drvdata(&serio->dev, data);
 129 }
 130
 131 /*
 132  * Use the following functions to protect critical sections in
 133  * driver code from port's interrupt handler
 134  */
 135 static inline void serio_pause_rx(struct serio *serio)
 136 {
 137         spin_lock_irq(&serio->lock);
 138 }
 139
 140 static inline void serio_continue_rx(struct serio *serio)
 141 {
 142         spin_unlock_irq(&serio->lock);
 143 }
 144
 145 /*
 146  * Use the following functions to pin serio's driver in process context
 147  */
 148 static inline int serio_pin_driver(struct serio *serio)
 149 {
 150         return mutex_lock_interruptible(&serio->drv_mutex);
 151 }
 152
 153 static inline void serio_pin_driver_uninterruptible(struct serio *serio)
 154 {
 155         mutex_lock(&serio->drv_mutex);
 156 }
 157
 158 static inline void serio_unpin_driver(struct serio *serio)
 159 {
 160         mutex_unlock(&serio->drv_mutex);
 161 }
 162
 163
 164 #endif
 165
 166 /*
 167  * bit masks for use in "interrupt" flags (3rd argument)
 168  */
 169 #define SERIO_TIMEOUT   1
 170 #define SERIO_PARITY    2
 171 #define SERIO_FRAME     4
 172
 173 /*
 174  * Serio types
 175  */
 176 #define SERIO_XT        0x00
 177 #define SERIO_8042      0x01
 178 #define SERIO_RS232     0x02
 179 #define SERIO_HIL_MLC   0x03
 180 #define SERIO_PS_PSTHRU 0x05
 181 #define SERIO_8042_XL   0x06
 182
 183 /*
 184  * Serio types
 185  */
 186 #define SERIO_UNKNOWN   0x00
 187 #define SERIO_MSC       0x01
 188 #define SERIO_SUN       0x02
 189 #define SERIO_MS        0x03
 190 #define SERIO_MP        0x04
 191 #define SERIO_MZ        0x05
 192 #define SERIO_MZP       0x06
 193 #define SERIO_MZPP      0x07
 194 #define SERIO_VSXXXAA   0x08
 195 #define SERIO_SUNKBD    0x10
 196 #define SERIO_WARRIOR   0x18
 197 #define SERIO_SPACEORB  0x19
 198 #define SERIO_MAGELLAN  0x1a
 199 #define SERIO_SPACEBALL 0x1b
 200 #define SERIO_GUNZE     0x1c
 201 #define SERIO_IFORCE    0x1d
 202 #define SERIO_STINGER   0x1e
 203 #define SERIO_NEWTON    0x1f
 204 #define SERIO_STOWAWAY  0x20
 205 #define SERIO_H3600     0x21
 206 #define SERIO_PS2SER    0x22
 207 #define SERIO_TWIDKBD   0x23
 208 #define SERIO_TWIDJOY   0x24
 209 #define SERIO_HIL       0x25
 210 #define SERIO_SNES232   0x26
 211 #define SERIO_SEMTECH   0x27
 212 #define SERIO_LKKBD     0x28
 213 #define SERIO_ELO       0x29
 214 #define SERIO_MICROTOUCH        0x30
 215 #define SERIO_PENMOUNT  0x31
 216 #define SERIO_TOUCHRIGHT        0x32
 217 #define SERIO_TOUCHWIN  0x33
 218
 219 #endif