drivers/input/joystick/spaceball.c

   1 /*
   2  * $Id: spaceball.c,v 1.17 2002/01/22 20:29:03 vojtech Exp $
   3  *
   4  *  Copyright (c) 1999-2001 Vojtech Pavlik
   5  *
   6  *  Based on the work of:
   7  *      David Thompson
   8  *      Joseph Krahn
   9  */
  10
  11 /*
  12  * SpaceTec SpaceBall 2003/3003/4000 FLX driver for Linux
  13  */
  14
  15 /*
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  29  *
  30  *  Should you need to contact me, the author, you can do so either by
  31  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  32  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  33  */
  34
  35 #include <linux/kernel.h>
  36 #include <linux/slab.h>
  37 #include <linux/module.h>
  38 #include <linux/init.h>
  39 #include <linux/input.h>
  40 #include <linux/serio.h>
  41
  42 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  43 MODULE_DESCRIPTION("SpaceTec SpaceBall 2003/3003/4000 FLX driver");
  44 MODULE_LICENSE("GPL");
  45
  46 /*
  47  * Constants.
  48  */
  49
  50 #define SPACEBALL_MAX_LENGTH    128
  51 #define SPACEBALL_MAX_ID        8
  52
  53 #define SPACEBALL_1003      1
  54 #define SPACEBALL_2003B     3
  55 #define SPACEBALL_2003C     4
  56 #define SPACEBALL_3003C     7
  57 #define SPACEBALL_4000FLX   8
  58 #define SPACEBALL_4000FLX_L 9
  59
  60 static int spaceball_axes[] = { ABS_X, ABS_Z, ABS_Y, ABS_RX, ABS_RZ, ABS_RY };
  61 static char *spaceball_names[] = {
  62         "?", "SpaceTec SpaceBall 1003", "SpaceTec SpaceBall 2003", "SpaceTec SpaceBall 2003B",
  63         "SpaceTec SpaceBall 2003C", "SpaceTec SpaceBall 3003", "SpaceTec SpaceBall SpaceController",
  64         "SpaceTec SpaceBall 3003C", "SpaceTec SpaceBall 4000FLX", "SpaceTec SpaceBall 4000FLX Lefty" };
  65
  66 /*
  67  * Per-Ball data.
  68  */
  69
  70 struct spaceball {
  71         struct input_dev dev;
  72         struct serio *serio;
  73         int idx;
  74         int escape;
  75         unsigned char data[SPACEBALL_MAX_LENGTH];
  76         char phys[32];
  77 };
  78
  79 /*
  80  * spaceball_process_packet() decodes packets the driver receives from the
  81  * SpaceBall.
  82  */
  83
  84 static void spaceball_process_packet(struct spaceball* spaceball, struct pt_regs *regs)
  85 {
  86         struct input_dev *dev = &spaceball->dev;
  87         unsigned char *data = spaceball->data;
  88         int i;
  89
  90         if (spaceball->idx < 2) return;
  91
  92         input_regs(dev, regs);
  93
  94         switch (spaceball->data[0]) {
  95
  96                 case 'D':                                       /* Ball data */
  97                         if (spaceball->idx != 15) return;
  98                         for (i = 0; i < 6; i++)
  99                                 input_report_abs(dev, spaceball_axes[i],
 100                                         (__s16)((data[2 * i + 3] << 8) | data[2 * i + 2]));
 101                         break;
 102
 103                 case 'K':                                       /* Button data */
 104                         if (spaceball->idx != 3) return;
 105                         input_report_key(dev, BTN_1, (data[2] & 0x01) || (data[2] & 0x20));
 106                         input_report_key(dev, BTN_2, data[2] & 0x02);
 107                         input_report_key(dev, BTN_3, data[2] & 0x04);
 108                         input_report_key(dev, BTN_4, data[2] & 0x08);
 109                         input_report_key(dev, BTN_5, data[1] & 0x01);
 110                         input_report_key(dev, BTN_6, data[1] & 0x02);
 111                         input_report_key(dev, BTN_7, data[1] & 0x04);
 112                         input_report_key(dev, BTN_8, data[1] & 0x10);
 113                         break;
 114
 115                 case '.':                                       /* Advanced button data */
 116                         if (spaceball->idx != 3) return;
 117                         input_report_key(dev, BTN_1, data[2] & 0x01);
 118                         input_report_key(dev, BTN_2, data[2] & 0x02);
 119                         input_report_key(dev, BTN_3, data[2] & 0x04);
 120                         input_report_key(dev, BTN_4, data[2] & 0x08);
 121                         input_report_key(dev, BTN_5, data[2] & 0x10);
 122                         input_report_key(dev, BTN_6, data[2] & 0x20);
 123                         input_report_key(dev, BTN_7, data[2] & 0x80);
 124                         input_report_key(dev, BTN_8, data[1] & 0x01);
 125                         input_report_key(dev, BTN_9, data[1] & 0x02);
 126                         input_report_key(dev, BTN_A, data[1] & 0x04);
 127                         input_report_key(dev, BTN_B, data[1] & 0x08);
 128                         input_report_key(dev, BTN_C, data[1] & 0x10);
 129                         input_report_key(dev, BTN_MODE, data[1] & 0x20);
 130                         break;
 131
 132                 case 'E':                                       /* Device error */
 133                         spaceball->data[spaceball->idx - 1] = 0;
 134                         printk(KERN_ERR "spaceball: Device error. [%s]\n", spaceball->data + 1);
 135                         break;
 136
 137                 case '?':                                       /* Bad command packet */
 138                         spaceball->data[spaceball->idx - 1] = 0;
 139                         printk(KERN_ERR "spaceball: Bad command. [%s]\n", spaceball->data + 1);
 140                         break;
 141         }
 142
 143         input_sync(dev);
 144 }
 145
 146 /*
 147  * Spaceball 4000 FLX packets all start with a one letter packet-type decriptor,
 148  * and end in 0x0d. It uses '^' as an escape for CR, XOFF and XON characters which
 149  * can occur in the axis values.
 150  */
 151
 152 static irqreturn_t spaceball_interrupt(struct serio *serio,
 153                 unsigned char data, unsigned int flags, struct pt_regs *regs)
 154 {
 155         struct spaceball *spaceball = serio->private;
 156
 157         switch (data) {
 158                 case 0xd:
 159                         spaceball_process_packet(spaceball, regs);
 160                         spaceball->idx = 0;
 161                         spaceball->escape = 0;
 162                         break;
 163                 case '^':
 164                         if (!spaceball->escape) {
 165                                 spaceball->escape = 1;
 166                                 break;
 167                         }
 168                         spaceball->escape = 0;
 169                 case 'M':
 170                 case 'Q':
 171                 case 'S':
 172                         if (spaceball->escape) {
 173                                 spaceball->escape = 0;
 174                                 data &= 0x1f;
 175                         }
 176                 default:
 177                         if (spaceball->escape)
 178                                 spaceball->escape = 0;
 179                         if (spaceball->idx < SPACEBALL_MAX_LENGTH)
 180                                 spaceball->data[spaceball->idx++] = data;
 181                         break;
 182         }
 183         return IRQ_HANDLED;
 184 }
 185
 186 /*
 187  * spaceball_disconnect() is the opposite of spaceball_connect()
 188  */
 189
 190 static void spaceball_disconnect(struct serio *serio)
 191 {
 192         struct spaceball* spaceball = serio->private;
 193         input_unregister_device(&spaceball->dev);
 194         serio_close(serio);
 195         kfree(spaceball);
 196 }
 197
 198 /*
 199  * spaceball_connect() is the routine that is called when someone adds a
 200  * new serio device. It looks for the Magellan, and if found, registers
 201  * it as an input device.
 202  */
 203
 204 static void spaceball_connect(struct serio *serio, struct serio_dev *dev)
 205 {
 206         struct spaceball *spaceball;
 207         int i, t, id;
 208
 209         if ((serio->type & ~SERIO_ID) != (SERIO_RS232 | SERIO_SPACEBALL))
 210                 return;
 211
 212         if ((id = (serio->type & SERIO_ID) >> 8) > SPACEBALL_MAX_ID)
 213                 return;
 214
 215         if (!(spaceball = kmalloc(sizeof(struct spaceball), GFP_KERNEL)))
 216                 return;
 217         memset(spaceball, 0, sizeof(struct spaceball));
 218
 219         spaceball->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 220
 221         switch (id) {
 222                 case SPACEBALL_4000FLX:
 223                 case SPACEBALL_4000FLX_L:
 224                         spaceball->dev.keybit[LONG(BTN_0)] |= BIT(BTN_9);
 225                         spaceball->dev.keybit[LONG(BTN_A)] |= BIT(BTN_A) | BIT(BTN_B) | BIT(BTN_C) | BIT(BTN_MODE);
 226                 default:
 227                         spaceball->dev.keybit[LONG(BTN_0)] |= BIT(BTN_2) | BIT(BTN_3) | BIT(BTN_4)
 228                                 | BIT(BTN_5) | BIT(BTN_6) | BIT(BTN_7) | BIT(BTN_8);
 229                 case SPACEBALL_3003C:
 230                         spaceball->dev.keybit[LONG(BTN_0)] |= BIT(BTN_1) | BIT(BTN_8);
 231         }
 232
 233         for (i = 0; i < 6; i++) {
 234                 t = spaceball_axes[i];
 235                 set_bit(t, spaceball->dev.absbit);
 236                 spaceball->dev.absmin[t] = i < 3 ? -8000 : -1600;
 237                 spaceball->dev.absmax[t] = i < 3 ?  8000 :  1600;
 238                 spaceball->dev.absflat[t] = i < 3 ? 40 : 8;
 239                 spaceball->dev.absfuzz[t] = i < 3 ? 8 : 2;
 240         }
 241
 242         spaceball->serio = serio;
 243         spaceball->dev.private = spaceball;
 244
 245         sprintf(spaceball->phys, "%s/input0", serio->phys);
 246
 247         init_input_dev(&spaceball->dev);
 248         spaceball->dev.name = spaceball_names[id];
 249         spaceball->dev.phys = spaceball->phys;
 250         spaceball->dev.id.bustype = BUS_RS232;
 251         spaceball->dev.id.vendor = SERIO_SPACEBALL;
 252         spaceball->dev.id.product = id;
 253         spaceball->dev.id.version = 0x0100;
 254
 255         serio->private = spaceball;
 256
 257         if (serio_open(serio, dev)) {
 258                 kfree(spaceball);
 259                 return;
 260         }
 261
 262         input_register_device(&spaceball->dev);
 263
 264         printk(KERN_INFO "input: %s on serio%s\n",
 265                 spaceball_names[id], serio->phys);
 266 }
 267
 268 /*
 269  * The serio device structure.
 270  */
 271
 272 static struct serio_dev spaceball_dev = {
 273         .interrupt =    spaceball_interrupt,
 274         .connect =      spaceball_connect,
 275         .disconnect =   spaceball_disconnect,
 276 };
 277
 278 /*
 279  * The functions for inserting/removing us as a module.
 280  */
 281
 282 int __init spaceball_init(void)
 283 {
 284         serio_register_device(&spaceball_dev);
 285         return 0;
 286 }
 287
 288 void __exit spaceball_exit(void)
 289 {
 290         serio_unregister_device(&spaceball_dev);
 291 }
 292
 293 module_init(spaceball_init);
 294 module_exit(spaceball_exit);