drivers/input/joystick/adi.c

   1 /*
   2  * $Id: adi.c,v 1.23 2002/01/22 20:26:17 vojtech Exp $
   3  *
   4  *  Copyright (c) 1998-2001 Vojtech Pavlik
   5  */
   6
   7 /*
   8  * Logitech ADI joystick family 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/delay.h>
  32 #include <linux/kernel.h>
  33 #include <linux/module.h>
  34 #include <linux/string.h>
  35 #include <linux/slab.h>
  36 #include <linux/input.h>
  37 #include <linux/gameport.h>
  38 #include <linux/init.h>
  39
  40 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  41 MODULE_DESCRIPTION("Logitech ADI joystick family driver");
  42 MODULE_LICENSE("GPL");
  43
  44 /*
  45  * Times, array sizes, flags, ids.
  46  */
  47
  48 #define ADI_MAX_START           200     /* Trigger to packet timeout [200us] */
  49 #define ADI_MAX_STROBE          40      /* Single bit timeout [40us] */
  50 #define ADI_REFRESH_TIME        HZ/50   /* How often to poll the joystick [20 ms] */
  51 #define ADI_INIT_DELAY          10      /* Delay after init packet [10ms] */
  52 #define ADI_DATA_DELAY          4       /* Delay after data packet [4ms] */
  53
  54 #define ADI_MAX_LENGTH          256
  55 #define ADI_MIN_LENGTH          8
  56 #define ADI_MIN_LEN_LENGTH      10
  57 #define ADI_MIN_ID_LENGTH       66
  58 #define ADI_MAX_NAME_LENGTH     48
  59 #define ADI_MAX_CNAME_LENGTH    16
  60 #define ADI_MAX_PHYS_LENGTH     32
  61
  62 #define ADI_FLAG_HAT            0x04
  63 #define ADI_FLAG_10BIT          0x08
  64
  65 #define ADI_ID_TPD              0x01
  66 #define ADI_ID_WGP              0x06
  67 #define ADI_ID_WGPE             0x08
  68 #define ADI_ID_MAX              0x0a
  69
  70 /*
  71  * Names, buttons, axes ...
  72  */
  73
  74 static char *adi_names[] = {    "WingMan Extreme Digital", "ThunderPad Digital", "SideCar", "CyberMan 2",
  75                                 "WingMan Interceptor", "WingMan Formula", "WingMan GamePad",
  76                                 "WingMan Extreme Digital 3D", "WingMan GamePad Extreme",
  77                                 "WingMan GamePad USB", "Unknown Device %#x" };
  78
  79 static char adi_wmgpe_abs[] =   { ABS_X, ABS_Y, ABS_HAT0X, ABS_HAT0Y };
  80 static char adi_wmi_abs[] =     { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
  81 static char adi_wmed3d_abs[] =  { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RZ, ABS_HAT0X, ABS_HAT0Y };
  82 static char adi_cm2_abs[] =     { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
  83 static char adi_wmf_abs[] =     { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
  84
  85 static short adi_wmgpe_key[] =  { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z,  BTN_TL, BTN_TR, BTN_START, BTN_MODE, BTN_SELECT };
  86 static short adi_wmi_key[] =    { BTN_TRIGGER,  BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_EXTRA };
  87 static short adi_wmed3d_key[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2 };
  88 static short adi_cm2_key[] =    { BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 };
  89
  90 static char* adi_abs[] = { adi_wmi_abs, adi_wmgpe_abs, adi_wmf_abs, adi_cm2_abs, adi_wmi_abs, adi_wmf_abs,
  91                            adi_wmgpe_abs, adi_wmed3d_abs, adi_wmgpe_abs, adi_wmgpe_abs, adi_wmi_abs };
  92
  93 static short* adi_key[] = { adi_wmi_key, adi_wmgpe_key, adi_cm2_key, adi_cm2_key, adi_wmi_key, adi_cm2_key,
  94                             adi_wmgpe_key, adi_wmed3d_key, adi_wmgpe_key, adi_wmgpe_key, adi_wmi_key };
  95
  96 /*
  97  * Hat to axis conversion arrays.
  98  */
  99
 100 static struct {
 101         int x;
 102         int y;
 103 } adi_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
 104
 105 /*
 106  * Per-port information.
 107  */
 108
 109 struct adi {
 110         struct input_dev dev;
 111         int length;
 112         int ret;
 113         int idx;
 114         unsigned char id;
 115         char buttons;
 116         char axes10;
 117         char axes8;
 118         signed char pad;
 119         char hats;
 120         char *abs;
 121         short *key;
 122         char name[ADI_MAX_NAME_LENGTH];
 123         char cname[ADI_MAX_CNAME_LENGTH];
 124         char phys[ADI_MAX_PHYS_LENGTH];
 125         unsigned char data[ADI_MAX_LENGTH];
 126 };
 127
 128 struct adi_port {
 129         struct gameport *gameport;
 130         struct timer_list timer;
 131         struct adi adi[2];
 132         int bad;
 133         int reads;
 134         int used;
 135 };
 136
 137 /*
 138  * adi_read_packet() reads a Logitech ADI packet.
 139  */
 140
 141 static void adi_read_packet(struct adi_port *port)
 142 {
 143         struct adi *adi = port->adi;
 144         struct gameport *gameport = port->gameport;
 145         unsigned char u, v, w, x, z;
 146         int t[2], s[2], i;
 147         unsigned long flags;
 148
 149         for (i = 0; i < 2; i++) {
 150                 adi[i].ret = -1;
 151                 t[i] = gameport_time(gameport, ADI_MAX_START);
 152                 s[i] = 0;
 153         }
 154
 155         local_irq_save(flags);
 156
 157         gameport_trigger(gameport);
 158         v = z = gameport_read(gameport);
 159
 160         do {
 161                 u = v;
 162                 w = u ^ (v = x = gameport_read(gameport));
 163                 for (i = 0; i < 2; i++, w >>= 2, x >>= 2) {
 164                         t[i]--;
 165                         if ((w & 0x30) && s[i]) {
 166                                 if ((w & 0x30) < 0x30 && adi[i].ret < ADI_MAX_LENGTH && t[i] > 0) {
 167                                         adi[i].data[++adi[i].ret] = w;
 168                                         t[i] = gameport_time(gameport, ADI_MAX_STROBE);
 169                                 } else t[i] = 0;
 170                         } else if (!(x & 0x30)) s[i] = 1;
 171                 }
 172         } while (t[0] > 0 || t[1] > 0);
 173
 174         local_irq_restore(flags);
 175
 176         return;
 177 }
 178
 179 /*
 180  * adi_move_bits() detects a possible 2-stream mode, and moves
 181  * the bits accordingly.
 182  */
 183
 184 static void adi_move_bits(struct adi_port *port, int length)
 185 {
 186         int i;
 187         struct adi *adi = port->adi;
 188
 189         adi[0].idx = adi[1].idx = 0;
 190
 191         if (adi[0].ret <= 0 || adi[1].ret <= 0) return;
 192         if (adi[0].data[0] & 0x20 || ~adi[1].data[0] & 0x20) return;
 193
 194         for (i = 1; i <= adi[1].ret; i++)
 195                 adi[0].data[((length - 1) >> 1) + i + 1] = adi[1].data[i];
 196
 197         adi[0].ret += adi[1].ret;
 198         adi[1].ret = -1;
 199 }
 200
 201 /*
 202  * adi_get_bits() gathers bits from the data packet.
 203  */
 204
 205 static inline int adi_get_bits(struct adi *adi, int count)
 206 {
 207         int bits = 0;
 208         int i;
 209         if ((adi->idx += count) > adi->ret) return 0;
 210         for (i = 0; i < count; i++)
 211                 bits |= ((adi->data[adi->idx - i] >> 5) & 1) << i;
 212         return bits;
 213 }
 214
 215 /*
 216  * adi_decode() decodes Logitech joystick data into input events.
 217  */
 218
 219 static int adi_decode(struct adi *adi)
 220 {
 221         struct input_dev *dev = &adi->dev;
 222         char *abs = adi->abs;
 223         short *key = adi->key;
 224         int i, t;
 225
 226         if (adi->ret < adi->length || adi->id != (adi_get_bits(adi, 4) | (adi_get_bits(adi, 4) << 4)))
 227                 return -1;
 228
 229         for (i = 0; i < adi->axes10; i++)
 230                 input_report_abs(dev, *abs++, adi_get_bits(adi, 10));
 231
 232         for (i = 0; i < adi->axes8; i++)
 233                 input_report_abs(dev, *abs++, adi_get_bits(adi, 8));
 234
 235         for (i = 0; i < adi->buttons && i < 63; i++) {
 236                 if (i == adi->pad) {
 237                         t = adi_get_bits(adi, 4);
 238                         input_report_abs(dev, *abs++, ((t >> 2) & 1) - ( t       & 1));
 239                         input_report_abs(dev, *abs++, ((t >> 1) & 1) - ((t >> 3) & 1));
 240                 }
 241                 input_report_key(dev, *key++, adi_get_bits(adi, 1));
 242         }
 243
 244         for (i = 0; i < adi->hats; i++) {
 245                 if ((t = adi_get_bits(adi, 4)) > 8) t = 0;
 246                 input_report_abs(dev, *abs++, adi_hat_to_axis[t].x);
 247                 input_report_abs(dev, *abs++, adi_hat_to_axis[t].y);
 248         }
 249
 250         for (i = 63; i < adi->buttons; i++)
 251                 input_report_key(dev, *key++, adi_get_bits(adi, 1));
 252
 253         input_sync(dev);
 254
 255         return 0;
 256 }
 257
 258 /*
 259  * adi_read() reads the data packet and decodes it.
 260  */
 261
 262 static int adi_read(struct adi_port *port)
 263 {
 264         int i;
 265         int result = 0;
 266
 267         adi_read_packet(port);
 268         adi_move_bits(port, port->adi[0].length);
 269
 270         for (i = 0; i < 2; i++)
 271                 if (port->adi[i].length)
 272                          result |= adi_decode(port->adi + i);
 273
 274         return result;
 275 }
 276
 277 /*
 278  * adi_timer() repeatedly polls the Logitech joysticks.
 279  */
 280
 281 static void adi_timer(unsigned long data)
 282 {
 283         struct adi_port *port = (void *) data;
 284         port->bad -= adi_read(port);
 285         port->reads++;
 286         mod_timer(&port->timer, jiffies + ADI_REFRESH_TIME);
 287 }
 288
 289 /*
 290  * adi_open() is a callback from the input open routine.
 291  */
 292
 293 static int adi_open(struct input_dev *dev)
 294 {
 295         struct adi_port *port = dev->private;
 296         if (!port->used++)
 297                 mod_timer(&port->timer, jiffies + ADI_REFRESH_TIME);
 298         return 0;
 299 }
 300
 301 /*
 302  * adi_close() is a callback from the input close routine.
 303  */
 304
 305 static void adi_close(struct input_dev *dev)
 306 {
 307         struct adi_port *port = dev->private;
 308         if (!--port->used)
 309                 del_timer(&port->timer);
 310 }
 311
 312 /*
 313  * adi_init_digital() sends a trigger & delay sequence
 314  * to reset and initialize a Logitech joystick into digital mode.
 315  */
 316
 317 static void adi_init_digital(struct gameport *gameport)
 318 {
 319         int seq[] = { 3, -2, -3, 10, -6, -11, -7, -9, 11, 0 };
 320         int i;
 321
 322         for (i = 0; seq[i]; i++) {
 323                 gameport_trigger(gameport);
 324                 if (seq[i] > 0) msleep(seq[i]);
 325                 if (seq[i] < 0) mdelay(-seq[i]);
 326         }
 327 }
 328
 329 static void adi_id_decode(struct adi *adi, struct adi_port *port)
 330 {
 331         int i, t;
 332
 333         if (adi->ret < ADI_MIN_ID_LENGTH) /* Minimum ID packet length */
 334                 return;
 335
 336         if (adi->ret < (t = adi_get_bits(adi, 10))) {
 337                 printk(KERN_WARNING "adi: Short ID packet: reported: %d != read: %d\n", t, adi->ret);
 338                 return;
 339         }
 340
 341         adi->id = adi_get_bits(adi, 4) | (adi_get_bits(adi, 4) << 4);
 342
 343         if ((t = adi_get_bits(adi, 4)) & ADI_FLAG_HAT) adi->hats++;
 344
 345         adi->length = adi_get_bits(adi, 10);
 346
 347         if (adi->length >= ADI_MAX_LENGTH || adi->length < ADI_MIN_LENGTH) {
 348                 printk(KERN_WARNING "adi: Bad data packet length (%d).\n", adi->length);
 349                 adi->length = 0;
 350                 return;
 351         }
 352
 353         adi->axes8 = adi_get_bits(adi, 4);
 354         adi->buttons = adi_get_bits(adi, 6);
 355
 356         if (adi_get_bits(adi, 6) != 8 && adi->hats) {
 357                 printk(KERN_WARNING "adi: Other than 8-dir POVs not supported yet.\n");
 358                 adi->length = 0;
 359                 return;
 360         }
 361
 362         adi->buttons += adi_get_bits(adi, 6);
 363         adi->hats += adi_get_bits(adi, 4);
 364
 365         i = adi_get_bits(adi, 4);
 366
 367         if (t & ADI_FLAG_10BIT) {
 368                 adi->axes10 = adi->axes8 - i;
 369                 adi->axes8 = i;
 370         }
 371
 372         t = adi_get_bits(adi, 4);
 373
 374         for (i = 0; i < t; i++)
 375                 adi->cname[i] = adi_get_bits(adi, 8);
 376         adi->cname[i] = 0;
 377
 378         t = 8 + adi->buttons + adi->axes10 * 10 + adi->axes8 * 8 + adi->hats * 4;
 379         if (adi->length != t && adi->length != t + (t & 1)) {
 380                 printk(KERN_WARNING "adi: Expected length %d != data length %d\n", t, adi->length);
 381                 adi->length = 0;
 382                 return;
 383         }
 384
 385         switch (adi->id) {
 386                 case ADI_ID_TPD:
 387                         adi->pad = 4;
 388                         adi->buttons -= 4;
 389                         break;
 390                 case ADI_ID_WGP:
 391                         adi->pad = 0;
 392                         adi->buttons -= 4;
 393                         break;
 394                 default:
 395                         adi->pad = -1;
 396                         break;
 397         }
 398 }
 399
 400 static void adi_init_input(struct adi *adi, struct adi_port *port, int half)
 401 {
 402         int i, t;
 403         char buf[ADI_MAX_NAME_LENGTH];
 404
 405         if (!adi->length) return;
 406
 407         init_input_dev(&adi->dev);
 408
 409         t = adi->id < ADI_ID_MAX ? adi->id : ADI_ID_MAX;
 410
 411         sprintf(buf, adi_names[t], adi->id);
 412         sprintf(adi->name, "Logitech %s", buf);
 413         sprintf(adi->phys, "%s/input%d", port->gameport->phys, half);
 414
 415         adi->abs = adi_abs[t];
 416         adi->key = adi_key[t];
 417
 418         adi->dev.open = adi_open;
 419         adi->dev.close = adi_close;
 420
 421         adi->dev.name = adi->name;
 422         adi->dev.phys = adi->phys;
 423         adi->dev.id.bustype = BUS_GAMEPORT;
 424         adi->dev.id.vendor = GAMEPORT_ID_VENDOR_LOGITECH;
 425         adi->dev.id.product = adi->id;
 426         adi->dev.id.version = 0x0100;
 427
 428         adi->dev.private = port;
 429         adi->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 430
 431         for (i = 0; i < adi->axes10 + adi->axes8 + (adi->hats + (adi->pad != -1)) * 2; i++)
 432                 set_bit(adi->abs[i], adi->dev.absbit);
 433
 434         for (i = 0; i < adi->buttons; i++)
 435                 set_bit(adi->key[i], adi->dev.keybit);
 436 }
 437
 438 static void adi_init_center(struct adi *adi)
 439 {
 440         int i, t, x;
 441
 442         if (!adi->length) return;
 443
 444         for (i = 0; i < adi->axes10 + adi->axes8 + (adi->hats + (adi->pad != -1)) * 2; i++) {
 445
 446                 t = adi->abs[i];
 447                 x = adi->dev.abs[t];
 448
 449                 if (t == ABS_THROTTLE || t == ABS_RUDDER || adi->id == ADI_ID_WGPE) {
 450                         if (i < adi->axes10) x = 512; else x = 128;
 451                 }
 452
 453                 if (i < adi->axes10) {
 454                         adi->dev.absmax[t] = x * 2 - 64;
 455                         adi->dev.absmin[t] = 64;
 456                         adi->dev.absfuzz[t] = 2;
 457                         adi->dev.absflat[t] = 16;
 458                         continue;
 459                 }
 460
 461                 if (i < adi->axes10 + adi->axes8) {
 462                         adi->dev.absmax[t] = x * 2 - 48;
 463                         adi->dev.absmin[t] = 48;
 464                         adi->dev.absfuzz[t] = 1;
 465                         adi->dev.absflat[t] = 16;
 466                         continue;
 467                 }
 468
 469                 adi->dev.absmax[t] = 1;
 470                 adi->dev.absmin[t] = -1;
 471         }
 472 }
 473
 474 /*
 475  * adi_connect() probes for Logitech ADI joysticks.
 476  */
 477
 478 static void adi_connect(struct gameport *gameport, struct gameport_dev *dev)
 479 {
 480         struct adi_port *port;
 481         int i;
 482
 483         if (!(port = kmalloc(sizeof(struct adi_port), GFP_KERNEL)))
 484                 return;
 485         memset(port, 0, sizeof(struct adi_port));
 486
 487         gameport->private = port;
 488
 489         port->gameport = gameport;
 490         init_timer(&port->timer);
 491         port->timer.data = (long) port;
 492         port->timer.function = adi_timer;
 493
 494         if (gameport_open(gameport, dev, GAMEPORT_MODE_RAW)) {
 495                 kfree(port);
 496                 return;
 497         }
 498
 499         adi_init_digital(gameport);
 500         adi_read_packet(port);
 501
 502         if (port->adi[0].ret >= ADI_MIN_LEN_LENGTH)
 503                 adi_move_bits(port, adi_get_bits(port->adi, 10));
 504
 505         for (i = 0; i < 2; i++) {
 506                 adi_id_decode(port->adi + i, port);
 507                 adi_init_input(port->adi + i, port, i);
 508         }
 509
 510         if (!port->adi[0].length && !port->adi[1].length) {
 511                 gameport_close(gameport);
 512                 kfree(port);
 513                 return;
 514         }
 515
 516         msleep(ADI_INIT_DELAY);
 517         if (adi_read(port)) {
 518                 msleep(ADI_DATA_DELAY);
 519                 adi_read(port);
 520         }
 521
 522         for (i = 0; i < 2; i++)
 523                 if (port->adi[i].length > 0) {
 524                         adi_init_center(port->adi + i);
 525                         input_register_device(&port->adi[i].dev);
 526                         printk(KERN_INFO "input: %s [%s] on %s\n",
 527                                 port->adi[i].name, port->adi[i].cname, gameport->phys);
 528                 }
 529 }
 530
 531 static void adi_disconnect(struct gameport *gameport)
 532 {
 533         int i;
 534
 535         struct adi_port *port = gameport->private;
 536         for (i = 0; i < 2; i++)
 537                 if (port->adi[i].length > 0)
 538                         input_unregister_device(&port->adi[i].dev);
 539         gameport_close(gameport);
 540         kfree(port);
 541 }
 542
 543 /*
 544  * The gameport device structure.
 545  */
 546
 547 static struct gameport_dev adi_dev = {
 548         .connect =      adi_connect,
 549         .disconnect =   adi_disconnect,
 550 };
 551
 552 int __init adi_init(void)
 553 {
 554         gameport_register_device(&adi_dev);
 555         return 0;
 556 }
 557
 558 void __exit adi_exit(void)
 559 {
 560         gameport_unregister_device(&adi_dev);
 561 }
 562
 563 module_init(adi_init);
 564 module_exit(adi_exit);