2 * Copyright (c) 1996-2001 Vojtech Pavlik
6 * Analog joystick and gamepad driver for Linux
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Should you need to contact me, the author, you can do so either by
25 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
26 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
29 #include <linux/delay.h>
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/bitops.h>
34 #include <linux/init.h>
35 #include <linux/input.h>
36 #include <linux/gameport.h>
37 #include <linux/jiffies.h>
38 #include <asm/timex.h>
40 #define DRIVER_DESC "Analog joystick and gamepad driver"
42 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
43 MODULE_DESCRIPTION(DRIVER_DESC);
44 MODULE_LICENSE("GPL");
50 #define ANALOG_PORTS 16
52 static char *js[ANALOG_PORTS];
53 static unsigned int js_nargs;
54 static int analog_options[ANALOG_PORTS];
55 module_param_array_named(map, js, charp, &js_nargs, 0);
56 MODULE_PARM_DESC(map, "Describes analog joysticks type/capabilities");
59 * Times, feature definitions.
62 #define ANALOG_RUDDER 0x00004
63 #define ANALOG_THROTTLE 0x00008
64 #define ANALOG_AXES_STD 0x0000f
65 #define ANALOG_BTNS_STD 0x000f0
67 #define ANALOG_BTNS_CHF 0x00100
68 #define ANALOG_HAT1_CHF 0x00200
69 #define ANALOG_HAT2_CHF 0x00400
70 #define ANALOG_HAT_FCS 0x00800
71 #define ANALOG_HATS_ALL 0x00e00
72 #define ANALOG_BTN_TL 0x01000
73 #define ANALOG_BTN_TR 0x02000
74 #define ANALOG_BTN_TL2 0x04000
75 #define ANALOG_BTN_TR2 0x08000
76 #define ANALOG_BTNS_TLR 0x03000
77 #define ANALOG_BTNS_TLR2 0x0c000
78 #define ANALOG_BTNS_GAMEPAD 0x0f000
80 #define ANALOG_HBTN_CHF 0x10000
81 #define ANALOG_ANY_CHF 0x10700
82 #define ANALOG_SAITEK 0x20000
83 #define ANALOG_EXTENSIONS 0x7ff00
84 #define ANALOG_GAMEPAD 0x80000
86 #define ANALOG_MAX_TIME 3 /* 3 ms */
87 #define ANALOG_LOOP_TIME 2000 /* 2 * loop */
88 #define ANALOG_SAITEK_DELAY 200 /* 200 us */
89 #define ANALOG_SAITEK_TIME 2000 /* 2000 us */
90 #define ANALOG_AXIS_TIME 2 /* 2 * refresh */
91 #define ANALOG_INIT_RETRIES 8 /* 8 times */
92 #define ANALOG_FUZZ_BITS 2 /* 2 bit more */
93 #define ANALOG_FUZZ_MAGIC 36 /* 36 u*ms/loop */
95 #define ANALOG_MAX_NAME_LENGTH 128
96 #define ANALOG_MAX_PHYS_LENGTH 32
98 static short analog_axes[] = { ABS_X, ABS_Y, ABS_RUDDER, ABS_THROTTLE };
99 static short analog_hats[] = { ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
100 static short analog_pads[] = { BTN_Y, BTN_Z, BTN_TL, BTN_TR };
101 static short analog_exts[] = { ANALOG_HAT1_CHF, ANALOG_HAT2_CHF, ANALOG_HAT_FCS };
102 static short analog_pad_btn[] = { BTN_A, BTN_B, BTN_C, BTN_X, BTN_TL2, BTN_TR2, BTN_SELECT, BTN_START, BTN_MODE, BTN_BASE };
103 static short analog_joy_btn[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2,
104 BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_BASE6 };
106 static unsigned char analog_chf[] = { 0xf, 0x0, 0x1, 0x9, 0x2, 0x4, 0xc, 0x8, 0x3, 0x5, 0xb, 0x7, 0xd, 0xe, 0xa, 0x6 };
109 struct input_dev *dev;
112 char name[ANALOG_MAX_NAME_LENGTH];
113 char phys[ANALOG_MAX_PHYS_LENGTH];
117 struct gameport *gameport;
118 struct analog analog[2];
139 #include <asm/i8253.h>
141 #define GET_TIME(x) do { if (cpu_has_tsc) rdtscl(x); else x = get_time_pit(); } while (0)
142 #define DELTA(x,y) (cpu_has_tsc ? ((y) - (x)) : ((x) - (y) + ((x) < (y) ? CLOCK_TICK_RATE / HZ : 0)))
143 #define TIME_NAME (cpu_has_tsc?"TSC":"PIT")
144 static unsigned int get_time_pit(void)
149 spin_lock_irqsave(&i8253_lock, flags);
152 count |= inb_p(0x40) << 8;
153 spin_unlock_irqrestore(&i8253_lock, flags);
157 #elif defined(__x86_64__)
158 #define GET_TIME(x) rdtscl(x)
159 #define DELTA(x,y) ((y)-(x))
160 #define TIME_NAME "TSC"
161 #elif defined(__alpha__)
162 #define GET_TIME(x) do { x = get_cycles(); } while (0)
163 #define DELTA(x,y) ((y)-(x))
164 #define TIME_NAME "PCC"
165 #elif defined(CONFIG_MN10300)
166 #define GET_TIME(x) do { x = get_cycles(); } while (0)
167 #define DELTA(x, y) ((x) - (y))
168 #define TIME_NAME "TSC"
171 static unsigned long analog_faketime = 0;
172 #define GET_TIME(x) do { x = analog_faketime++; } while(0)
173 #define DELTA(x,y) ((y)-(x))
174 #define TIME_NAME "Unreliable"
175 #warning Precise timer not defined for this architecture.
179 * analog_decode() decodes analog joystick data and reports input events.
182 static void analog_decode(struct analog *analog, int *axes, int *initial, int buttons)
184 struct input_dev *dev = analog->dev;
187 if (analog->mask & ANALOG_HAT_FCS)
188 for (i = 0; i < 4; i++)
189 if (axes[3] < ((initial[3] * ((i << 1) + 1)) >> 3)) {
190 buttons |= 1 << (i + 14);
194 for (i = j = 0; i < 6; i++)
195 if (analog->mask & (0x10 << i))
196 input_report_key(dev, analog->buttons[j++], (buttons >> i) & 1);
198 if (analog->mask & ANALOG_HBTN_CHF)
199 for (i = 0; i < 4; i++)
200 input_report_key(dev, analog->buttons[j++], (buttons >> (i + 10)) & 1);
202 if (analog->mask & ANALOG_BTN_TL)
203 input_report_key(dev, analog_pads[0], axes[2] < (initial[2] >> 1));
204 if (analog->mask & ANALOG_BTN_TR)
205 input_report_key(dev, analog_pads[1], axes[3] < (initial[3] >> 1));
206 if (analog->mask & ANALOG_BTN_TL2)
207 input_report_key(dev, analog_pads[2], axes[2] > (initial[2] + (initial[2] >> 1)));
208 if (analog->mask & ANALOG_BTN_TR2)
209 input_report_key(dev, analog_pads[3], axes[3] > (initial[3] + (initial[3] >> 1)));
211 for (i = j = 0; i < 4; i++)
212 if (analog->mask & (1 << i))
213 input_report_abs(dev, analog_axes[j++], axes[i]);
215 for (i = j = 0; i < 3; i++)
216 if (analog->mask & analog_exts[i]) {
217 input_report_abs(dev, analog_hats[j++],
218 ((buttons >> ((i << 2) + 7)) & 1) - ((buttons >> ((i << 2) + 9)) & 1));
219 input_report_abs(dev, analog_hats[j++],
220 ((buttons >> ((i << 2) + 8)) & 1) - ((buttons >> ((i << 2) + 6)) & 1));
227 * analog_cooked_read() reads analog joystick data.
230 static int analog_cooked_read(struct analog_port *port)
232 struct gameport *gameport = port->gameport;
233 unsigned int time[4], start, loop, now, loopout, timeout;
234 unsigned char data[4], this, last;
238 loopout = (ANALOG_LOOP_TIME * port->loop) / 1000;
239 timeout = ANALOG_MAX_TIME * port->speed;
241 local_irq_save(flags);
242 gameport_trigger(gameport);
244 local_irq_restore(flags);
255 this = gameport_read(gameport) & port->mask;
257 local_irq_restore(flags);
259 if ((last ^ this) && (DELTA(loop, now) < loopout)) {
260 data[i] = last ^ this;
265 } while (this && (i < 4) && (DELTA(start, now) < timeout));
269 for (--i; i >= 0; i--) {
271 for (j = 0; j < 4; j++)
272 if (data[i] & (1 << j))
273 port->axes[j] = (DELTA(start, time[i]) << ANALOG_FUZZ_BITS) / port->loop;
276 return -(this != port->mask);
279 static int analog_button_read(struct analog_port *port, char saitek, char chf)
283 int strobe = gameport_time(port->gameport, ANALOG_SAITEK_TIME);
285 u = gameport_read(port->gameport);
288 port->buttons = (~u >> 4) & 0xf;
294 while ((~u & 0xf0) && (i < 16) && t) {
295 port->buttons |= 1 << analog_chf[(~u >> 4) & 0xf];
296 if (!saitek) return 0;
297 udelay(ANALOG_SAITEK_DELAY);
299 gameport_trigger(port->gameport);
300 while (((u = gameport_read(port->gameport)) & port->mask) && t) t--;
304 return -(!t || (i == 16));
308 * analog_poll() repeatedly polls the Analog joysticks.
311 static void analog_poll(struct gameport *gameport)
313 struct analog_port *port = gameport_get_drvdata(gameport);
316 char saitek = !!(port->analog[0].mask & ANALOG_SAITEK);
317 char chf = !!(port->analog[0].mask & ANALOG_ANY_CHF);
320 port->bads -= gameport_cooked_read(port->gameport, port->axes, &port->buttons);
322 port->buttons = port->buttons ? (1 << analog_chf[port->buttons]) : 0;
325 if (!port->axtime--) {
326 port->bads -= analog_cooked_read(port);
327 port->bads -= analog_button_read(port, saitek, chf);
329 port->axtime = ANALOG_AXIS_TIME - 1;
332 analog_button_read(port, saitek, chf);
336 for (i = 0; i < 2; i++)
337 if (port->analog[i].mask)
338 analog_decode(port->analog + i, port->axes, port->initial, port->buttons);
342 * analog_open() is a callback from the input open routine.
345 static int analog_open(struct input_dev *dev)
347 struct analog_port *port = input_get_drvdata(dev);
349 gameport_start_polling(port->gameport);
354 * analog_close() is a callback from the input close routine.
357 static void analog_close(struct input_dev *dev)
359 struct analog_port *port = input_get_drvdata(dev);
361 gameport_stop_polling(port->gameport);
365 * analog_calibrate_timer() calibrates the timer and computes loop
366 * and timeout values for a joystick port.
369 static void analog_calibrate_timer(struct analog_port *port)
371 struct gameport *gameport = port->gameport;
372 unsigned int i, t, tx, t1, t2, t3;
375 local_irq_save(flags);
378 analog_faketime += 830;
383 local_irq_restore(flags);
385 port->speed = DELTA(t1, t2) - DELTA(t2, t3);
389 for (i = 0; i < 50; i++) {
390 local_irq_save(flags);
392 for (t = 0; t < 50; t++) { gameport_read(gameport); GET_TIME(t2); }
394 local_irq_restore(flags);
396 t = DELTA(t1, t2) - DELTA(t2, t3);
400 port->loop = tx / 50;
404 * analog_name() constructs a name for an analog joystick.
407 static void analog_name(struct analog *analog)
409 snprintf(analog->name, sizeof(analog->name), "Analog %d-axis %d-button",
410 hweight8(analog->mask & ANALOG_AXES_STD),
411 hweight8(analog->mask & ANALOG_BTNS_STD) + !!(analog->mask & ANALOG_BTNS_CHF) * 2 +
412 hweight16(analog->mask & ANALOG_BTNS_GAMEPAD) + !!(analog->mask & ANALOG_HBTN_CHF) * 4);
414 if (analog->mask & ANALOG_HATS_ALL)
415 snprintf(analog->name, sizeof(analog->name), "%s %d-hat",
416 analog->name, hweight16(analog->mask & ANALOG_HATS_ALL));
418 if (analog->mask & ANALOG_HAT_FCS)
419 strlcat(analog->name, " FCS", sizeof(analog->name));
420 if (analog->mask & ANALOG_ANY_CHF)
421 strlcat(analog->name, (analog->mask & ANALOG_SAITEK) ? " Saitek" : " CHF",
422 sizeof(analog->name));
424 strlcat(analog->name, (analog->mask & ANALOG_GAMEPAD) ? " gamepad": " joystick",
425 sizeof(analog->name));
429 * analog_init_device()
432 static int analog_init_device(struct analog_port *port, struct analog *analog, int index)
434 struct input_dev *input_dev;
435 int i, j, t, v, w, x, y, z;
439 snprintf(analog->phys, sizeof(analog->phys),
440 "%s/input%d", port->gameport->phys, index);
441 analog->buttons = (analog->mask & ANALOG_GAMEPAD) ? analog_pad_btn : analog_joy_btn;
443 analog->dev = input_dev = input_allocate_device();
447 input_dev->name = analog->name;
448 input_dev->phys = analog->phys;
449 input_dev->id.bustype = BUS_GAMEPORT;
450 input_dev->id.vendor = GAMEPORT_ID_VENDOR_ANALOG;
451 input_dev->id.product = analog->mask >> 4;
452 input_dev->id.version = 0x0100;
453 input_dev->dev.parent = &port->gameport->dev;
455 input_set_drvdata(input_dev, port);
457 input_dev->open = analog_open;
458 input_dev->close = analog_close;
460 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
462 for (i = j = 0; i < 4; i++)
463 if (analog->mask & (1 << i)) {
467 y = (port->axes[0] + port->axes[1]) >> 1;
468 z = y - port->axes[i];
473 if ((i == 2 || i == 3) && (j == 2 || j == 3) && (z > (y >> 3)))
476 if (analog->mask & ANALOG_SAITEK) {
477 if (i == 2) x = port->axes[i];
482 input_set_abs_params(input_dev, t, v, (x << 1) - v, port->fuzz, w);
486 for (i = j = 0; i < 3; i++)
487 if (analog->mask & analog_exts[i])
488 for (x = 0; x < 2; x++) {
489 t = analog_hats[j++];
490 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
493 for (i = j = 0; i < 4; i++)
494 if (analog->mask & (0x10 << i))
495 set_bit(analog->buttons[j++], input_dev->keybit);
497 if (analog->mask & ANALOG_BTNS_CHF)
498 for (i = 0; i < 2; i++)
499 set_bit(analog->buttons[j++], input_dev->keybit);
501 if (analog->mask & ANALOG_HBTN_CHF)
502 for (i = 0; i < 4; i++)
503 set_bit(analog->buttons[j++], input_dev->keybit);
505 for (i = 0; i < 4; i++)
506 if (analog->mask & (ANALOG_BTN_TL << i))
507 set_bit(analog_pads[i], input_dev->keybit);
509 analog_decode(analog, port->axes, port->initial, port->buttons);
511 error = input_register_device(analog->dev);
513 input_free_device(analog->dev);
521 * analog_init_devices() sets up device-specific values and registers the input devices.
524 static int analog_init_masks(struct analog_port *port)
527 struct analog *analog = port->analog;
533 if ((port->mask & 3) != 3 && port->mask != 0xc) {
534 printk(KERN_WARNING "analog.c: Unknown joystick device found "
535 "(data=%#x, %s), probably not analog joystick.\n",
536 port->mask, port->gameport->phys);
541 i = analog_options[0]; /* FIXME !!! - need to specify options for different ports */
543 analog[0].mask = i & 0xfffff;
545 analog[0].mask &= ~(ANALOG_AXES_STD | ANALOG_HAT_FCS | ANALOG_BTNS_GAMEPAD)
546 | port->mask | ((port->mask << 8) & ANALOG_HAT_FCS)
547 | ((port->mask << 10) & ANALOG_BTNS_TLR) | ((port->mask << 12) & ANALOG_BTNS_TLR2);
549 analog[0].mask &= ~(ANALOG_HAT2_CHF)
550 | ((analog[0].mask & ANALOG_HBTN_CHF) ? 0 : ANALOG_HAT2_CHF);
552 analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_BTN_TR | ANALOG_BTN_TR2)
553 | ((~analog[0].mask & ANALOG_HAT_FCS) >> 8)
554 | ((~analog[0].mask & ANALOG_HAT_FCS) << 2)
555 | ((~analog[0].mask & ANALOG_HAT_FCS) << 4);
557 analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_RUDDER)
558 | (((~analog[0].mask & ANALOG_BTNS_TLR ) >> 10)
559 & ((~analog[0].mask & ANALOG_BTNS_TLR2) >> 12));
561 analog[1].mask = ((i >> 20) & 0xff) | ((i >> 12) & 0xf0000);
563 analog[1].mask &= (analog[0].mask & ANALOG_EXTENSIONS) ? ANALOG_GAMEPAD
564 : (((ANALOG_BTNS_STD | port->mask) & ~analog[0].mask) | ANALOG_GAMEPAD);
568 for (i = 0; i < 4; i++) max[i] = port->axes[i] << 1;
570 if ((analog[0].mask & 0x7) == 0x7) max[2] = (max[0] + max[1]) >> 1;
571 if ((analog[0].mask & 0xb) == 0xb) max[3] = (max[0] + max[1]) >> 1;
572 if ((analog[0].mask & ANALOG_BTN_TL) && !(analog[0].mask & ANALOG_BTN_TL2)) max[2] >>= 1;
573 if ((analog[0].mask & ANALOG_BTN_TR) && !(analog[0].mask & ANALOG_BTN_TR2)) max[3] >>= 1;
574 if ((analog[0].mask & ANALOG_HAT_FCS)) max[3] >>= 1;
576 gameport_calibrate(port->gameport, port->axes, max);
579 for (i = 0; i < 4; i++)
580 port->initial[i] = port->axes[i];
582 return -!(analog[0].mask || analog[1].mask);
585 static int analog_init_port(struct gameport *gameport, struct gameport_driver *drv, struct analog_port *port)
589 port->gameport = gameport;
591 gameport_set_drvdata(gameport, port);
593 if (!gameport_open(gameport, drv, GAMEPORT_MODE_RAW)) {
595 analog_calibrate_timer(port);
597 gameport_trigger(gameport);
598 t = gameport_read(gameport);
599 msleep(ANALOG_MAX_TIME);
600 port->mask = (gameport_read(gameport) ^ t) & t & 0xf;
601 port->fuzz = (port->speed * ANALOG_FUZZ_MAGIC) / port->loop / 1000 + ANALOG_FUZZ_BITS;
603 for (i = 0; i < ANALOG_INIT_RETRIES; i++) {
604 if (!analog_cooked_read(port))
606 msleep(ANALOG_MAX_TIME);
611 msleep(ANALOG_MAX_TIME);
612 t = gameport_time(gameport, ANALOG_MAX_TIME * 1000);
613 gameport_trigger(gameport);
614 while ((gameport_read(port->gameport) & port->mask) && (u < t))
616 udelay(ANALOG_SAITEK_DELAY);
617 t = gameport_time(gameport, ANALOG_SAITEK_TIME);
618 gameport_trigger(gameport);
619 while ((gameport_read(port->gameport) & port->mask) && (v < t))
622 if (v < (u >> 1)) { /* FIXME - more than one port */
623 analog_options[0] |= /* FIXME - more than one port */
624 ANALOG_SAITEK | ANALOG_BTNS_CHF | ANALOG_HBTN_CHF | ANALOG_HAT1_CHF;
628 gameport_close(gameport);
631 if (!gameport_open(gameport, drv, GAMEPORT_MODE_COOKED)) {
633 for (i = 0; i < ANALOG_INIT_RETRIES; i++)
634 if (!gameport_cooked_read(gameport, port->axes, &port->buttons))
636 for (i = 0; i < 4; i++)
637 if (port->axes[i] != -1)
638 port->mask |= 1 << i;
640 port->fuzz = gameport->fuzz;
645 return gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
648 static int analog_connect(struct gameport *gameport, struct gameport_driver *drv)
650 struct analog_port *port;
654 if (!(port = kzalloc(sizeof(struct analog_port), GFP_KERNEL)))
657 err = analog_init_port(gameport, drv, port);
661 err = analog_init_masks(port);
665 gameport_set_poll_handler(gameport, analog_poll);
666 gameport_set_poll_interval(gameport, 10);
668 for (i = 0; i < 2; i++)
669 if (port->analog[i].mask) {
670 err = analog_init_device(port, port->analog + i, i);
677 fail3: while (--i >= 0)
678 if (port->analog[i].mask)
679 input_unregister_device(port->analog[i].dev);
680 fail2: gameport_close(gameport);
681 fail1: gameport_set_drvdata(gameport, NULL);
686 static void analog_disconnect(struct gameport *gameport)
688 struct analog_port *port = gameport_get_drvdata(gameport);
691 for (i = 0; i < 2; i++)
692 if (port->analog[i].mask)
693 input_unregister_device(port->analog[i].dev);
694 gameport_close(gameport);
695 gameport_set_drvdata(gameport, NULL);
696 printk(KERN_INFO "analog.c: %d out of %d reads (%d%%) on %s failed\n",
697 port->bads, port->reads, port->reads ? (port->bads * 100 / port->reads) : 0,
698 port->gameport->phys);
702 struct analog_types {
707 static struct analog_types analog_types[] = {
708 { "none", 0x00000000 },
709 { "auto", 0x000000ff },
710 { "2btn", 0x0000003f },
711 { "y-joy", 0x0cc00033 },
712 { "y-pad", 0x8cc80033 },
713 { "fcs", 0x000008f7 },
714 { "chf", 0x000002ff },
715 { "fullchf", 0x000007ff },
716 { "gamepad", 0x000830f3 },
717 { "gamepad8", 0x0008f0f3 },
721 static void analog_parse_options(void)
726 for (i = 0; i < js_nargs; i++) {
728 for (j = 0; analog_types[j].name; j++)
729 if (!strcmp(analog_types[j].name, js[i])) {
730 analog_options[i] = analog_types[j].value;
733 if (analog_types[j].name) continue;
735 analog_options[i] = simple_strtoul(js[i], &end, 0);
736 if (end != js[i]) continue;
738 analog_options[i] = 0xff;
739 if (!strlen(js[i])) continue;
741 printk(KERN_WARNING "analog.c: Bad config for port %d - \"%s\"\n", i, js[i]);
744 for (; i < ANALOG_PORTS; i++)
745 analog_options[i] = 0xff;
749 * The gameport device structure.
752 static struct gameport_driver analog_drv = {
756 .description = DRIVER_DESC,
757 .connect = analog_connect,
758 .disconnect = analog_disconnect,
761 static int __init analog_init(void)
763 analog_parse_options();
764 gameport_register_driver(&analog_drv);
769 static void __exit analog_exit(void)
771 gameport_unregister_driver(&analog_drv);
774 module_init(analog_init);
775 module_exit(analog_exit);