drivers/input/joystick/grip.c

   1 /*
   2  * $Id: grip.c,v 1.21 2002/01/22 20:27:57 vojtech Exp $
   3  *
   4  *  Copyright (c) 1998-2001 Vojtech Pavlik
   5  */
   6
   7 /*
   8  * Gravis/Kensington GrIP protocol joystick and gamepad 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/init.h>
  34 #include <linux/slab.h>
  35 #include <linux/gameport.h>
  36 #include <linux/input.h>
  37
  38 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  39 MODULE_DESCRIPTION("Gravis GrIP protocol joystick driver");
  40 MODULE_LICENSE("GPL");
  41
  42 #define GRIP_MODE_GPP           1
  43 #define GRIP_MODE_BD            2
  44 #define GRIP_MODE_XT            3
  45 #define GRIP_MODE_DC            4
  46
  47 #define GRIP_LENGTH_GPP         24
  48 #define GRIP_STROBE_GPP         200     /* 200 us */
  49 #define GRIP_LENGTH_XT          4
  50 #define GRIP_STROBE_XT          64      /* 64 us */
  51 #define GRIP_MAX_CHUNKS_XT      10
  52 #define GRIP_MAX_BITS_XT        30
  53
  54 #define GRIP_REFRESH_TIME       HZ/50   /* 20 ms */
  55
  56 struct grip {
  57         struct gameport *gameport;
  58         struct timer_list timer;
  59         struct input_dev dev[2];
  60         unsigned char mode[2];
  61         int used;
  62         int reads;
  63         int bads;
  64         char phys[2][32];
  65 };
  66
  67 static int grip_btn_gpp[] = { BTN_START, BTN_SELECT, BTN_TR2, BTN_Y, 0, BTN_TL2, BTN_A, BTN_B, BTN_X, 0, BTN_TL, BTN_TR, -1 };
  68 static int grip_btn_bd[] = { BTN_THUMB, BTN_THUMB2, BTN_TRIGGER, BTN_TOP, BTN_BASE, -1 };
  69 static int grip_btn_xt[] = { BTN_TRIGGER, BTN_THUMB, BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_SELECT, BTN_START, BTN_MODE, -1 };
  70 static int grip_btn_dc[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, -1 };
  71
  72 static int grip_abs_gpp[] = { ABS_X, ABS_Y, -1 };
  73 static int grip_abs_bd[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
  74 static int grip_abs_xt[] = { ABS_X, ABS_Y, ABS_BRAKE, ABS_GAS, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, -1 };
  75 static int grip_abs_dc[] = { ABS_X, ABS_Y, ABS_RX, ABS_RY, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
  76
  77 static char *grip_name[] = { NULL, "Gravis GamePad Pro", "Gravis Blackhawk Digital",
  78                                 "Gravis Xterminator Digital", "Gravis Xterminator DualControl" };
  79 static int *grip_abs[] = { 0, grip_abs_gpp, grip_abs_bd, grip_abs_xt, grip_abs_dc };
  80 static int *grip_btn[] = { 0, grip_btn_gpp, grip_btn_bd, grip_btn_xt, grip_btn_dc };
  81 static char grip_anx[] = { 0, 0, 3, 5, 5 };
  82 static char grip_cen[] = { 0, 0, 2, 2, 4 };
  83
  84 /*
  85  * grip_gpp_read_packet() reads a Gravis GamePad Pro packet.
  86  */
  87
  88 static int grip_gpp_read_packet(struct gameport *gameport, int shift, unsigned int *data)
  89 {
  90         unsigned long flags;
  91         unsigned char u, v;
  92         unsigned int t;
  93         int i;
  94
  95         int strobe = gameport_time(gameport, GRIP_STROBE_GPP);
  96
  97         data[0] = 0;
  98         t = strobe;
  99         i = 0;
 100
 101         local_irq_save(flags);
 102
 103         v = gameport_read(gameport) >> shift;
 104
 105         do {
 106                 t--;
 107                 u = v; v = (gameport_read(gameport) >> shift) & 3;
 108                 if (~v & u & 1) {
 109                         data[0] |= (v >> 1) << i++;
 110                         t = strobe;
 111                 }
 112         } while (i < GRIP_LENGTH_GPP && t > 0);
 113
 114         local_irq_restore(flags);
 115
 116         if (i < GRIP_LENGTH_GPP) return -1;
 117
 118         for (i = 0; i < GRIP_LENGTH_GPP && (data[0] & 0xfe4210) ^ 0x7c0000; i++)
 119                 data[0] = data[0] >> 1 | (data[0] & 1) << (GRIP_LENGTH_GPP - 1);
 120
 121         return -(i == GRIP_LENGTH_GPP);
 122 }
 123
 124 /*
 125  * grip_xt_read_packet() reads a Gravis Xterminator packet.
 126  */
 127
 128 static int grip_xt_read_packet(struct gameport *gameport, int shift, unsigned int *data)
 129 {
 130         unsigned int i, j, buf, crc;
 131         unsigned char u, v, w;
 132         unsigned long flags;
 133         unsigned int t;
 134         char status;
 135
 136         int strobe = gameport_time(gameport, GRIP_STROBE_XT);
 137
 138         data[0] = data[1] = data[2] = data[3] = 0;
 139         status = buf = i = j = 0;
 140         t = strobe;
 141
 142         local_irq_save(flags);
 143
 144         v = w = (gameport_read(gameport) >> shift) & 3;
 145
 146         do {
 147                 t--;
 148                 u = (gameport_read(gameport) >> shift) & 3;
 149
 150                 if (u ^ v) {
 151
 152                         if ((u ^ v) & 1) {
 153                                 buf = (buf << 1) | (u >> 1);
 154                                 t = strobe;
 155                                 i++;
 156                         } else
 157
 158                         if ((((u ^ v) & (v ^ w)) >> 1) & ~(u | v | w) & 1) {
 159                                 if (i == 20) {
 160                                         crc = buf ^ (buf >> 7) ^ (buf >> 14);
 161                                         if (!((crc ^ (0x25cb9e70 >> ((crc >> 2) & 0x1c))) & 0xf)) {
 162                                                 data[buf >> 18] = buf >> 4;
 163                                                 status |= 1 << (buf >> 18);
 164                                         }
 165                                         j++;
 166                                 }
 167                                 t = strobe;
 168                                 buf = 0;
 169                                 i = 0;
 170                         }
 171                         w = v;
 172                         v = u;
 173                 }
 174
 175         } while (status != 0xf && i < GRIP_MAX_BITS_XT && j < GRIP_MAX_CHUNKS_XT && t > 0);
 176
 177         local_irq_restore(flags);
 178
 179         return -(status != 0xf);
 180 }
 181
 182 /*
 183  * grip_timer() repeatedly polls the joysticks and generates events.
 184  */
 185
 186 static void grip_timer(unsigned long private)
 187 {
 188         struct grip *grip = (void*) private;
 189         unsigned int data[GRIP_LENGTH_XT];
 190         struct input_dev *dev;
 191         int i, j;
 192
 193         for (i = 0; i < 2; i++) {
 194
 195                 dev = grip->dev + i;
 196                 grip->reads++;
 197
 198                 switch (grip->mode[i]) {
 199
 200                         case GRIP_MODE_GPP:
 201
 202                                 if (grip_gpp_read_packet(grip->gameport, (i << 1) + 4, data)) {
 203                                         grip->bads++;
 204                                         break;
 205                                 }
 206
 207                                 input_report_abs(dev, ABS_X, ((*data >> 15) & 1) - ((*data >> 16) & 1));
 208                                 input_report_abs(dev, ABS_Y, ((*data >> 13) & 1) - ((*data >> 12) & 1));
 209
 210                                 for (j = 0; j < 12; j++)
 211                                         if (grip_btn_gpp[j])
 212                                                 input_report_key(dev, grip_btn_gpp[j], (*data >> j) & 1);
 213
 214                                 break;
 215
 216                         case GRIP_MODE_BD:
 217
 218                                 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
 219                                         grip->bads++;
 220                                         break;
 221                                 }
 222
 223                                 input_report_abs(dev, ABS_X,        (data[0] >> 2) & 0x3f);
 224                                 input_report_abs(dev, ABS_Y,  63 - ((data[0] >> 8) & 0x3f));
 225                                 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
 226
 227                                 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2]       & 1));
 228                                 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
 229
 230                                 for (j = 0; j < 5; j++)
 231                                         input_report_key(dev, grip_btn_bd[j], (data[3] >> (j + 4)) & 1);
 232
 233                                 break;
 234
 235                         case GRIP_MODE_XT:
 236
 237                                 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
 238                                         grip->bads++;
 239                                         break;
 240                                 }
 241
 242                                 input_report_abs(dev, ABS_X,        (data[0] >> 2) & 0x3f);
 243                                 input_report_abs(dev, ABS_Y,  63 - ((data[0] >> 8) & 0x3f));
 244                                 input_report_abs(dev, ABS_BRAKE,    (data[1] >> 2) & 0x3f);
 245                                 input_report_abs(dev, ABS_GAS,      (data[1] >> 8) & 0x3f);
 246                                 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
 247
 248                                 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2]       & 1));
 249                                 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
 250                                 input_report_abs(dev, ABS_HAT1X, ((data[2] >> 5) & 1) - ((data[2] >> 4) & 1));
 251                                 input_report_abs(dev, ABS_HAT1Y, ((data[2] >> 6) & 1) - ((data[2] >> 7) & 1));
 252
 253                                 for (j = 0; j < 11; j++)
 254                                         input_report_key(dev, grip_btn_xt[j], (data[3] >> (j + 3)) & 1);
 255                                 break;
 256
 257                         case GRIP_MODE_DC:
 258
 259                                 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
 260                                         grip->bads++;
 261                                         break;
 262                                 }
 263
 264                                 input_report_abs(dev, ABS_X,        (data[0] >> 2) & 0x3f);
 265                                 input_report_abs(dev, ABS_Y,        (data[0] >> 8) & 0x3f);
 266                                 input_report_abs(dev, ABS_RX,       (data[1] >> 2) & 0x3f);
 267                                 input_report_abs(dev, ABS_RY,       (data[1] >> 8) & 0x3f);
 268                                 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
 269
 270                                 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2]       & 1));
 271                                 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
 272
 273                                 for (j = 0; j < 9; j++)
 274                                         input_report_key(dev, grip_btn_dc[j], (data[3] >> (j + 3)) & 1);
 275                                 break;
 276
 277
 278                 }
 279
 280                 input_sync(dev);
 281         }
 282
 283         mod_timer(&grip->timer, jiffies + GRIP_REFRESH_TIME);
 284 }
 285
 286 static int grip_open(struct input_dev *dev)
 287 {
 288         struct grip *grip = dev->private;
 289         if (!grip->used++)
 290                 mod_timer(&grip->timer, jiffies + GRIP_REFRESH_TIME);
 291         return 0;
 292 }
 293
 294 static void grip_close(struct input_dev *dev)
 295 {
 296         struct grip *grip = dev->private;
 297         if (!--grip->used)
 298                 del_timer(&grip->timer);
 299 }
 300
 301 static void grip_connect(struct gameport *gameport, struct gameport_dev *dev)
 302 {
 303         struct grip *grip;
 304         unsigned int data[GRIP_LENGTH_XT];
 305         int i, j, t;
 306
 307         if (!(grip = kmalloc(sizeof(struct grip), GFP_KERNEL)))
 308                 return;
 309         memset(grip, 0, sizeof(struct grip));
 310
 311         gameport->private = grip;
 312
 313         grip->gameport = gameport;
 314         init_timer(&grip->timer);
 315         grip->timer.data = (long) grip;
 316         grip->timer.function = grip_timer;
 317
 318          if (gameport_open(gameport, dev, GAMEPORT_MODE_RAW))
 319                 goto fail1;
 320
 321         for (i = 0; i < 2; i++) {
 322                 if (!grip_gpp_read_packet(gameport, (i << 1) + 4, data)) {
 323                         grip->mode[i] = GRIP_MODE_GPP;
 324                         continue;
 325                 }
 326                 if (!grip_xt_read_packet(gameport, (i << 1) + 4, data)) {
 327                         if (!(data[3] & 7)) {
 328                                 grip->mode[i] = GRIP_MODE_BD;
 329                                 continue;
 330                         }
 331                         if (!(data[2] & 0xf0)) {
 332                                 grip->mode[i] = GRIP_MODE_XT;
 333                                 continue;
 334                         }
 335                         grip->mode[i] = GRIP_MODE_DC;
 336                         continue;
 337                 }
 338         }
 339
 340         if (!grip->mode[0] && !grip->mode[1])
 341                 goto fail2;
 342
 343         for (i = 0; i < 2; i++)
 344                 if (grip->mode[i]) {
 345
 346                         sprintf(grip->phys[i], "%s/input%d", gameport->phys, i);
 347
 348                         grip->dev[i].private = grip;
 349
 350                         grip->dev[i].open = grip_open;
 351                         grip->dev[i].close = grip_close;
 352
 353                         grip->dev[i].name = grip_name[grip->mode[i]];
 354                         grip->dev[i].phys = grip->phys[i];
 355                         grip->dev[i].id.bustype = BUS_GAMEPORT;
 356                         grip->dev[i].id.vendor = GAMEPORT_ID_VENDOR_GRAVIS;
 357                         grip->dev[i].id.product = grip->mode[i];
 358                         grip->dev[i].id.version = 0x0100;
 359
 360                         grip->dev[i].evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 361
 362                         for (j = 0; (t = grip_abs[grip->mode[i]][j]) >= 0; j++) {
 363
 364                                 set_bit(t, grip->dev[i].absbit);
 365
 366                                 if (j < grip_cen[grip->mode[i]]) {
 367                                         grip->dev[i].absmin[t] = 14;
 368                                         grip->dev[i].absmax[t] = 52;
 369                                         grip->dev[i].absfuzz[t] = 1;
 370                                         grip->dev[i].absflat[t] = 2;
 371                                         continue;
 372                                 }
 373
 374                                 if (j < grip_anx[grip->mode[i]]) {
 375                                         grip->dev[i].absmin[t] = 3;
 376                                         grip->dev[i].absmax[t] = 57;
 377                                         grip->dev[i].absfuzz[t] = 1;
 378                                         continue;
 379                                 }
 380
 381                                 grip->dev[i].absmin[t] = -1;
 382                                 grip->dev[i].absmax[t] = 1;
 383                         }
 384
 385                         for (j = 0; (t = grip_btn[grip->mode[i]][j]) >= 0; j++)
 386                                 if (t > 0)
 387                                         set_bit(t, grip->dev[i].keybit);
 388
 389                         input_register_device(grip->dev + i);
 390
 391                         printk(KERN_INFO "input: %s on %s\n",
 392                                 grip_name[grip->mode[i]], gameport->phys);
 393                 }
 394
 395         return;
 396 fail2:  gameport_close(gameport);
 397 fail1:  kfree(grip);
 398 }
 399
 400 static void grip_disconnect(struct gameport *gameport)
 401 {
 402         int i;
 403
 404         struct grip *grip = gameport->private;
 405         for (i = 0; i < 2; i++)
 406                 if (grip->mode[i])
 407                         input_unregister_device(grip->dev + i);
 408         gameport_close(gameport);
 409         kfree(grip);
 410 }
 411
 412 static struct gameport_dev grip_dev = {
 413         .connect =      grip_connect,
 414         .disconnect =   grip_disconnect,
 415 };
 416
 417 int __init grip_init(void)
 418 {
 419         gameport_register_device(&grip_dev);
 420         return 0;
 421 }
 422
 423 void __exit grip_exit(void)
 424 {
 425         gameport_unregister_device(&grip_dev);
 426 }
 427
 428 module_init(grip_init);
 429 module_exit(grip_exit);