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