drivers/input/joystick/a3d.c

   1 /*
   2  * $Id: a3d.c,v 1.21 2002/01/22 20:11:50 vojtech Exp $
   3  *
   4  *  Copyright (c) 1998-2001 Vojtech Pavlik
   5  */
   6
   7 /*
   8  * FP-Gaming Assasin 3D joystick driver for Linux
   9  */
  10
  11 /*
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  25  *
  26  * Should you need to contact me, the author, you can do so either by
  27  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  28  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  29  */
  30
  31 #include <linux/kernel.h>
  32 #include <linux/module.h>
  33 #include <linux/slab.h>
  34 #include <linux/init.h>
  35 #include <linux/gameport.h>
  36 #include <linux/input.h>
  37
  38 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  39 MODULE_DESCRIPTION("FP-Gaming Assasin 3D joystick driver");
  40 MODULE_LICENSE("GPL");
  41
  42 #define A3D_MAX_START           400     /* 400 us */
  43 #define A3D_MAX_STROBE          60      /* 40 us */
  44 #define A3D_DELAY_READ          3       /* 3 ms */
  45 #define A3D_MAX_LENGTH          40      /* 40*3 bits */
  46 #define A3D_REFRESH_TIME        HZ/50   /* 20 ms */
  47
  48 #define A3D_MODE_A3D            1       /* Assassin 3D */
  49 #define A3D_MODE_PAN            2       /* Panther */
  50 #define A3D_MODE_OEM            3       /* Panther OEM version */
  51 #define A3D_MODE_PXL            4       /* Panther XL */
  52
  53 char *a3d_names[] = { NULL, "FP-Gaming Assassin 3D", "MadCatz Panther", "OEM Panther",
  54                         "MadCatz Panther XL", "MadCatz Panther XL w/ rudder" };
  55
  56 struct a3d {
  57         struct gameport *gameport;
  58         struct gameport adc;
  59         struct input_dev dev;
  60         struct timer_list timer;
  61         int axes[4];
  62         int buttons;
  63         int mode;
  64         int length;
  65         int used;
  66         int reads;
  67         int bads;
  68         char phys[32];
  69         char adcphys[32];
  70 };
  71
  72 /*
  73  * a3d_read_packet() reads an Assassin 3D packet.
  74  */
  75
  76 static int a3d_read_packet(struct gameport *gameport, int length, char *data)
  77 {
  78         unsigned long flags;
  79         unsigned char u, v;
  80         unsigned int t, s;
  81         int i;
  82
  83         i = 0;
  84         t = gameport_time(gameport, A3D_MAX_START);
  85         s = gameport_time(gameport, A3D_MAX_STROBE);
  86
  87         local_irq_save(flags);
  88         gameport_trigger(gameport);
  89         v = gameport_read(gameport);
  90
  91         while (t > 0 && i < length) {
  92                 t--;
  93                 u = v; v = gameport_read(gameport);
  94                 if (~v & u & 0x10) {
  95                         data[i++] = v >> 5;
  96                         t = s;
  97                 }
  98         }
  99
 100         local_irq_restore(flags);
 101
 102         return i;
 103 }
 104
 105 /*
 106  * a3d_csum() computes checksum of triplet packet
 107  */
 108
 109 static int a3d_csum(char *data, int count)
 110 {
 111         int i, csum = 0;
 112         for (i = 0; i < count - 2; i++) csum += data[i];
 113         return (csum & 0x3f) != ((data[count - 2] << 3) | data[count - 1]);
 114 }
 115
 116 static void a3d_read(struct a3d *a3d, unsigned char *data)
 117 {
 118         struct input_dev *dev = &a3d->dev;
 119
 120         switch (a3d->mode) {
 121
 122                 case A3D_MODE_A3D:
 123                 case A3D_MODE_OEM:
 124                 case A3D_MODE_PAN:
 125
 126                         input_report_rel(dev, REL_X, ((data[5] << 6) | (data[6] << 3) | data[ 7]) - ((data[5] & 4) << 7));
 127                         input_report_rel(dev, REL_Y, ((data[8] << 6) | (data[9] << 3) | data[10]) - ((data[8] & 4) << 7));
 128
 129                         input_report_key(dev, BTN_RIGHT,  data[2] & 1);
 130                         input_report_key(dev, BTN_LEFT,   data[3] & 2);
 131                         input_report_key(dev, BTN_MIDDLE, data[3] & 4);
 132
 133                         input_sync(dev);
 134
 135                         a3d->axes[0] = ((signed char)((data[11] << 6) | (data[12] << 3) | (data[13]))) + 128;
 136                         a3d->axes[1] = ((signed char)((data[14] << 6) | (data[15] << 3) | (data[16]))) + 128;
 137                         a3d->axes[2] = ((signed char)((data[17] << 6) | (data[18] << 3) | (data[19]))) + 128;
 138                         a3d->axes[3] = ((signed char)((data[20] << 6) | (data[21] << 3) | (data[22]))) + 128;
 139
 140                         a3d->buttons = ((data[3] << 3) | data[4]) & 0xf;
 141
 142                         return;
 143
 144                 case A3D_MODE_PXL:
 145
 146                         input_report_rel(dev, REL_X, ((data[ 9] << 6) | (data[10] << 3) | data[11]) - ((data[ 9] & 4) << 7));
 147                         input_report_rel(dev, REL_Y, ((data[12] << 6) | (data[13] << 3) | data[14]) - ((data[12] & 4) << 7));
 148
 149                         input_report_key(dev, BTN_RIGHT,  data[2] & 1);
 150                         input_report_key(dev, BTN_LEFT,   data[3] & 2);
 151                         input_report_key(dev, BTN_MIDDLE, data[3] & 4);
 152                         input_report_key(dev, BTN_SIDE,   data[7] & 2);
 153                         input_report_key(dev, BTN_EXTRA,  data[7] & 4);
 154
 155                         input_report_abs(dev, ABS_X,        ((signed char)((data[15] << 6) | (data[16] << 3) | (data[17]))) + 128);
 156                         input_report_abs(dev, ABS_Y,        ((signed char)((data[18] << 6) | (data[19] << 3) | (data[20]))) + 128);
 157                         input_report_abs(dev, ABS_RUDDER,   ((signed char)((data[21] << 6) | (data[22] << 3) | (data[23]))) + 128);
 158                         input_report_abs(dev, ABS_THROTTLE, ((signed char)((data[24] << 6) | (data[25] << 3) | (data[26]))) + 128);
 159
 160                         input_report_abs(dev, ABS_HAT0X, ( data[5]       & 1) - ((data[5] >> 2) & 1));
 161                         input_report_abs(dev, ABS_HAT0Y, ((data[5] >> 1) & 1) - ((data[6] >> 2) & 1));
 162                         input_report_abs(dev, ABS_HAT1X, ((data[4] >> 1) & 1) - ( data[3]       & 1));
 163                         input_report_abs(dev, ABS_HAT1Y, ((data[4] >> 2) & 1) - ( data[4]       & 1));
 164
 165                         input_report_key(dev, BTN_TRIGGER, data[8] & 1);
 166                         input_report_key(dev, BTN_THUMB,   data[8] & 2);
 167                         input_report_key(dev, BTN_TOP,     data[8] & 4);
 168                         input_report_key(dev, BTN_PINKIE,  data[7] & 1);
 169
 170                         input_sync(dev);
 171
 172                         return;
 173         }
 174 }
 175
 176
 177 /*
 178  * a3d_timer() reads and analyzes A3D joystick data.
 179  */
 180
 181 static void a3d_timer(unsigned long private)
 182 {
 183         struct a3d *a3d = (void *) private;
 184         unsigned char data[A3D_MAX_LENGTH];
 185         a3d->reads++;
 186         if (a3d_read_packet(a3d->gameport, a3d->length, data) != a3d->length
 187                 || data[0] != a3d->mode || a3d_csum(data, a3d->length))
 188                 a3d->bads++; else a3d_read(a3d, data);
 189         mod_timer(&a3d->timer, jiffies + A3D_REFRESH_TIME);
 190 }
 191
 192 /*
 193  * a3d_adc_cooked_read() copies the acis and button data to the
 194  * callers arrays. It could do the read itself, but the caller could
 195  * call this more than 50 times a second, which would use too much CPU.
 196  */
 197
 198 int a3d_adc_cooked_read(struct gameport *gameport, int *axes, int *buttons)
 199 {
 200         struct a3d *a3d = gameport->driver;
 201         int i;
 202         for (i = 0; i < 4; i++)
 203                 axes[i] = (a3d->axes[i] < 254) ? a3d->axes[i] : -1;
 204         *buttons = a3d->buttons;
 205         return 0;
 206 }
 207
 208 /*
 209  * a3d_adc_open() is the gameport open routine. It refuses to serve
 210  * any but cooked data.
 211  */
 212
 213 int a3d_adc_open(struct gameport *gameport, int mode)
 214 {
 215         struct a3d *a3d = gameport->driver;
 216         if (mode != GAMEPORT_MODE_COOKED)
 217                 return -1;
 218         if (!a3d->used++)
 219                 mod_timer(&a3d->timer, jiffies + A3D_REFRESH_TIME);
 220         return 0;
 221 }
 222
 223 /*
 224  * a3d_adc_close() is a callback from the input close routine.
 225  */
 226
 227 static void a3d_adc_close(struct gameport *gameport)
 228 {
 229         struct a3d *a3d = gameport->driver;
 230         if (!--a3d->used)
 231                 del_timer(&a3d->timer);
 232 }
 233
 234 /*
 235  * a3d_open() is a callback from the input open routine.
 236  */
 237
 238 static int a3d_open(struct input_dev *dev)
 239 {
 240         struct a3d *a3d = dev->private;
 241         if (!a3d->used++)
 242                 mod_timer(&a3d->timer, jiffies + A3D_REFRESH_TIME);
 243         return 0;
 244 }
 245
 246 /*
 247  * a3d_close() is a callback from the input close routine.
 248  */
 249
 250 static void a3d_close(struct input_dev *dev)
 251 {
 252         struct a3d *a3d = dev->private;
 253         if (!--a3d->used)
 254                 del_timer(&a3d->timer);
 255 }
 256
 257 /*
 258  * a3d_connect() probes for A3D joysticks.
 259  */
 260
 261 static void a3d_connect(struct gameport *gameport, struct gameport_dev *dev)
 262 {
 263         struct a3d *a3d;
 264         unsigned char data[A3D_MAX_LENGTH];
 265         int i;
 266
 267         if (!(a3d = kmalloc(sizeof(struct a3d), GFP_KERNEL)))
 268                 return;
 269         memset(a3d, 0, sizeof(struct a3d));
 270
 271         gameport->private = a3d;
 272
 273         a3d->gameport = gameport;
 274         init_timer(&a3d->timer);
 275         a3d->timer.data = (long) a3d;
 276         a3d->timer.function = a3d_timer;
 277
 278         if (gameport_open(gameport, dev, GAMEPORT_MODE_RAW))
 279                 goto fail1;
 280
 281         i = a3d_read_packet(gameport, A3D_MAX_LENGTH, data);
 282
 283         if (!i || a3d_csum(data, i))
 284                 goto fail2;
 285
 286         a3d->mode = data[0];
 287
 288         if (!a3d->mode || a3d->mode > 5) {
 289                 printk(KERN_WARNING "a3d.c: Unknown A3D device detected "
 290                         "(%s, id=%d), contact <vojtech@ucw.cz>\n", gameport->phys, a3d->mode);
 291                 goto fail2;
 292         }
 293
 294         sprintf(a3d->phys, "%s/input0", gameport->phys);
 295         sprintf(a3d->adcphys, "%s/gameport0", gameport->phys);
 296
 297         if (a3d->mode == A3D_MODE_PXL) {
 298
 299                 int axes[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER };
 300
 301                 a3d->length = 33;
 302
 303                 init_input_dev(&a3d->dev);
 304
 305                 a3d->dev.evbit[0] |= BIT(EV_ABS) | BIT(EV_KEY) | BIT(EV_REL);
 306                 a3d->dev.relbit[0] |= BIT(REL_X) | BIT(REL_Y);
 307                 a3d->dev.absbit[0] |= BIT(ABS_X) | BIT(ABS_Y) | BIT(ABS_THROTTLE) | BIT(ABS_RUDDER)
 308                                    | BIT(ABS_HAT0X) | BIT(ABS_HAT0Y) | BIT(ABS_HAT1X) | BIT(ABS_HAT1Y);
 309
 310                 a3d->dev.keybit[LONG(BTN_MOUSE)] |= BIT(BTN_RIGHT) | BIT(BTN_LEFT) | BIT(BTN_MIDDLE)
 311                                                  | BIT(BTN_SIDE) | BIT(BTN_EXTRA);
 312
 313                 a3d->dev.keybit[LONG(BTN_JOYSTICK)] |= BIT(BTN_TRIGGER) | BIT(BTN_THUMB) | BIT(BTN_TOP) | BIT(BTN_PINKIE);
 314
 315                 a3d_read(a3d, data);
 316
 317                 for (i = 0; i < 4; i++) {
 318                         if (i < 2) {
 319                                 a3d->dev.absmin[axes[i]] = 48;
 320                                 a3d->dev.absmax[axes[i]] = a3d->dev.abs[axes[i]] * 2 - 48;
 321                                 a3d->dev.absflat[axes[i]] = 8;
 322                         } else {
 323                                 a3d->dev.absmin[axes[i]] = 2;
 324                                 a3d->dev.absmax[axes[i]] = 253;
 325                         }
 326                         a3d->dev.absmin[ABS_HAT0X + i] = -1;
 327                         a3d->dev.absmax[ABS_HAT0X + i] = 1;
 328                 }
 329
 330         } else {
 331                 a3d->length = 29;
 332
 333                 init_input_dev(&a3d->dev);
 334
 335                 a3d->dev.evbit[0] |= BIT(EV_KEY) | BIT(EV_REL);
 336                 a3d->dev.relbit[0] |= BIT(REL_X) | BIT(REL_Y);
 337                 a3d->dev.keybit[LONG(BTN_MOUSE)] |= BIT(BTN_RIGHT) | BIT(BTN_LEFT) | BIT(BTN_MIDDLE);
 338
 339                 a3d->adc.driver = a3d;
 340                 a3d->adc.open = a3d_adc_open;
 341                 a3d->adc.close = a3d_adc_close;
 342                 a3d->adc.cooked_read = a3d_adc_cooked_read;
 343                 a3d->adc.fuzz = 1;
 344
 345                 a3d->adc.name = a3d_names[a3d->mode];
 346                 a3d->adc.phys = a3d->adcphys;
 347                 a3d->adc.id.bustype = BUS_GAMEPORT;
 348                 a3d->adc.id.vendor = GAMEPORT_ID_VENDOR_MADCATZ;
 349                 a3d->adc.id.product = a3d->mode;
 350                 a3d->adc.id.version = 0x0100;
 351
 352                 a3d_read(a3d, data);
 353
 354                 gameport_register_port(&a3d->adc);
 355                 printk(KERN_INFO "gameport: %s on %s\n", a3d_names[a3d->mode], gameport->phys);
 356         }
 357
 358         a3d->dev.private = a3d;
 359         a3d->dev.open = a3d_open;
 360         a3d->dev.close = a3d_close;
 361
 362         a3d->dev.name = a3d_names[a3d->mode];
 363         a3d->dev.phys = a3d->phys;
 364         a3d->dev.id.bustype = BUS_GAMEPORT;
 365         a3d->dev.id.vendor = GAMEPORT_ID_VENDOR_MADCATZ;
 366         a3d->dev.id.product = a3d->mode;
 367         a3d->dev.id.version = 0x0100;
 368
 369         input_register_device(&a3d->dev);
 370         printk(KERN_INFO "input: %s on %s\n", a3d_names[a3d->mode], a3d->phys);
 371
 372         return;
 373 fail2:  gameport_close(gameport);
 374 fail1:  kfree(a3d);
 375 }
 376
 377 static void a3d_disconnect(struct gameport *gameport)
 378 {
 379
 380         struct a3d *a3d = gameport->private;
 381         input_unregister_device(&a3d->dev);
 382         if (a3d->mode < A3D_MODE_PXL)
 383                 gameport_unregister_port(&a3d->adc);
 384         gameport_close(gameport);
 385         kfree(a3d);
 386 }
 387
 388 static struct gameport_dev a3d_dev = {
 389         .connect =      a3d_connect,
 390         .disconnect =   a3d_disconnect,
 391 };
 392
 393 int __init a3d_init(void)
 394 {
 395         gameport_register_device(&a3d_dev);
 396         return 0;
 397 }
 398
 399 void __exit a3d_exit(void)
 400 {
 401         gameport_unregister_device(&a3d_dev);
 402 }
 403
 404 module_init(a3d_init);
 405 module_exit(a3d_exit);