2 * $Id: analog.c,v 1.68 2002/01/22 20:18:32 vojtech Exp $
4 * Copyright (c) 1996-2001 Vojtech Pavlik
8 * Analog joystick and gamepad driver for Linux
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.
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.
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
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
31 #include <linux/config.h>
32 #include <linux/delay.h>
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/slab.h>
37 #include <linux/bitops.h>
38 #include <linux/init.h>
39 #include <linux/input.h>
40 #include <linux/gameport.h>
41 #include <linux/jiffies.h>
42 #include <asm/timex.h>
44 #define DRIVER_DESC "Analog joystick and gamepad driver"
46 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
47 MODULE_DESCRIPTION(DRIVER_DESC);
48 MODULE_LICENSE("GPL");
54 #define ANALOG_PORTS 16
56 static char *js[ANALOG_PORTS];
58 static int analog_options[ANALOG_PORTS];
59 module_param_array_named(map, js, charp, &js_nargs, 0);
60 MODULE_PARM_DESC(map, "Describes analog joysticks type/capabilities");
62 __obsolete_setup("js=");
65 * Times, feature definitions.
68 #define ANALOG_RUDDER 0x00004
69 #define ANALOG_THROTTLE 0x00008
70 #define ANALOG_AXES_STD 0x0000f
71 #define ANALOG_BTNS_STD 0x000f0
73 #define ANALOG_BTNS_CHF 0x00100
74 #define ANALOG_HAT1_CHF 0x00200
75 #define ANALOG_HAT2_CHF 0x00400
76 #define ANALOG_HAT_FCS 0x00800
77 #define ANALOG_HATS_ALL 0x00e00
78 #define ANALOG_BTN_TL 0x01000
79 #define ANALOG_BTN_TR 0x02000
80 #define ANALOG_BTN_TL2 0x04000
81 #define ANALOG_BTN_TR2 0x08000
82 #define ANALOG_BTNS_TLR 0x03000
83 #define ANALOG_BTNS_TLR2 0x0c000
84 #define ANALOG_BTNS_GAMEPAD 0x0f000
86 #define ANALOG_HBTN_CHF 0x10000
87 #define ANALOG_ANY_CHF 0x10700
88 #define ANALOG_SAITEK 0x20000
89 #define ANALOG_EXTENSIONS 0x7ff00
90 #define ANALOG_GAMEPAD 0x80000
92 #define ANALOG_MAX_TIME 3 /* 3 ms */
93 #define ANALOG_LOOP_TIME 2000 /* 2 * loop */
94 #define ANALOG_SAITEK_DELAY 200 /* 200 us */
95 #define ANALOG_SAITEK_TIME 2000 /* 2000 us */
96 #define ANALOG_AXIS_TIME 2 /* 2 * refresh */
97 #define ANALOG_INIT_RETRIES 8 /* 8 times */
98 #define ANALOG_FUZZ_BITS 2 /* 2 bit more */
99 #define ANALOG_FUZZ_MAGIC 36 /* 36 u*ms/loop */
101 #define ANALOG_MAX_NAME_LENGTH 128
102 #define ANALOG_MAX_PHYS_LENGTH 32
104 static short analog_axes[] = { ABS_X, ABS_Y, ABS_RUDDER, ABS_THROTTLE };
105 static short analog_hats[] = { ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
106 static short analog_pads[] = { BTN_Y, BTN_Z, BTN_TL, BTN_TR };
107 static short analog_exts[] = { ANALOG_HAT1_CHF, ANALOG_HAT2_CHF, ANALOG_HAT_FCS };
108 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 };
109 static short analog_joy_btn[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2,
110 BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_BASE6 };
112 static unsigned char analog_chf[] = { 0xf, 0x0, 0x1, 0x9, 0x2, 0x4, 0xc, 0x8, 0x3, 0x5, 0xb, 0x7, 0xd, 0xe, 0xa, 0x6 };
115 struct input_dev *dev;
118 char name[ANALOG_MAX_NAME_LENGTH];
119 char phys[ANALOG_MAX_PHYS_LENGTH];
123 struct gameport *gameport;
124 struct analog analog[2];
145 #include <asm/i8253.h>
147 #define GET_TIME(x) do { if (cpu_has_tsc) rdtscl(x); else x = get_time_pit(); } while (0)
148 #define DELTA(x,y) (cpu_has_tsc ? ((y) - (x)) : ((x) - (y) + ((x) < (y) ? CLOCK_TICK_RATE / HZ : 0)))
149 #define TIME_NAME (cpu_has_tsc?"TSC":"PIT")
150 static unsigned int get_time_pit(void)
155 spin_lock_irqsave(&i8253_lock, flags);
158 count |= inb_p(0x40) << 8;
159 spin_unlock_irqrestore(&i8253_lock, flags);
163 #elif defined(__x86_64__)
164 #define GET_TIME(x) rdtscl(x)
165 #define DELTA(x,y) ((y)-(x))
166 #define TIME_NAME "TSC"
167 #elif defined(__alpha__)
168 #define GET_TIME(x) do { x = get_cycles(); } while (0)
169 #define DELTA(x,y) ((y)-(x))
170 #define TIME_NAME "PCC"
173 static unsigned long analog_faketime = 0;
174 #define GET_TIME(x) do { x = analog_faketime++; } while(0)
175 #define DELTA(x,y) ((y)-(x))
176 #define TIME_NAME "Unreliable"
177 #warning Precise timer not defined for this architecture.
181 * analog_decode() decodes analog joystick data and reports input events.
184 static void analog_decode(struct analog *analog, int *axes, int *initial, int buttons)
186 struct input_dev *dev = analog->dev;
189 if (analog->mask & ANALOG_HAT_FCS)
190 for (i = 0; i < 4; i++)
191 if (axes[3] < ((initial[3] * ((i << 1) + 1)) >> 3)) {
192 buttons |= 1 << (i + 14);
196 for (i = j = 0; i < 6; i++)
197 if (analog->mask & (0x10 << i))
198 input_report_key(dev, analog->buttons[j++], (buttons >> i) & 1);
200 if (analog->mask & ANALOG_HBTN_CHF)
201 for (i = 0; i < 4; i++)
202 input_report_key(dev, analog->buttons[j++], (buttons >> (i + 10)) & 1);
204 if (analog->mask & ANALOG_BTN_TL)
205 input_report_key(dev, analog_pads[0], axes[2] < (initial[2] >> 1));
206 if (analog->mask & ANALOG_BTN_TR)
207 input_report_key(dev, analog_pads[1], axes[3] < (initial[3] >> 1));
208 if (analog->mask & ANALOG_BTN_TL2)
209 input_report_key(dev, analog_pads[2], axes[2] > (initial[2] + (initial[2] >> 1)));
210 if (analog->mask & ANALOG_BTN_TR2)
211 input_report_key(dev, analog_pads[3], axes[3] > (initial[3] + (initial[3] >> 1)));
213 for (i = j = 0; i < 4; i++)
214 if (analog->mask & (1 << i))
215 input_report_abs(dev, analog_axes[j++], axes[i]);
217 for (i = j = 0; i < 3; i++)
218 if (analog->mask & analog_exts[i]) {
219 input_report_abs(dev, analog_hats[j++],
220 ((buttons >> ((i << 2) + 7)) & 1) - ((buttons >> ((i << 2) + 9)) & 1));
221 input_report_abs(dev, analog_hats[j++],
222 ((buttons >> ((i << 2) + 8)) & 1) - ((buttons >> ((i << 2) + 6)) & 1));
229 * analog_cooked_read() reads analog joystick data.
232 static int analog_cooked_read(struct analog_port *port)
234 struct gameport *gameport = port->gameport;
235 unsigned int time[4], start, loop, now, loopout, timeout;
236 unsigned char data[4], this, last;
240 loopout = (ANALOG_LOOP_TIME * port->loop) / 1000;
241 timeout = ANALOG_MAX_TIME * port->speed;
243 local_irq_save(flags);
244 gameport_trigger(gameport);
246 local_irq_restore(flags);
257 this = gameport_read(gameport) & port->mask;
259 local_irq_restore(flags);
261 if ((last ^ this) && (DELTA(loop, now) < loopout)) {
262 data[i] = last ^ this;
267 } while (this && (i < 4) && (DELTA(start, now) < timeout));
271 for (--i; i >= 0; i--) {
273 for (j = 0; j < 4; j++)
274 if (data[i] & (1 << j))
275 port->axes[j] = (DELTA(start, time[i]) << ANALOG_FUZZ_BITS) / port->loop;
278 return -(this != port->mask);
281 static int analog_button_read(struct analog_port *port, char saitek, char chf)
285 int strobe = gameport_time(port->gameport, ANALOG_SAITEK_TIME);
287 u = gameport_read(port->gameport);
290 port->buttons = (~u >> 4) & 0xf;
296 while ((~u & 0xf0) && (i < 16) && t) {
297 port->buttons |= 1 << analog_chf[(~u >> 4) & 0xf];
298 if (!saitek) return 0;
299 udelay(ANALOG_SAITEK_DELAY);
301 gameport_trigger(port->gameport);
302 while (((u = gameport_read(port->gameport)) & port->mask) && t) t--;
306 return -(!t || (i == 16));
310 * analog_poll() repeatedly polls the Analog joysticks.
313 static void analog_poll(struct gameport *gameport)
315 struct analog_port *port = gameport_get_drvdata(gameport);
318 char saitek = !!(port->analog[0].mask & ANALOG_SAITEK);
319 char chf = !!(port->analog[0].mask & ANALOG_ANY_CHF);
322 port->bads -= gameport_cooked_read(port->gameport, port->axes, &port->buttons);
324 port->buttons = port->buttons ? (1 << analog_chf[port->buttons]) : 0;
327 if (!port->axtime--) {
328 port->bads -= analog_cooked_read(port);
329 port->bads -= analog_button_read(port, saitek, chf);
331 port->axtime = ANALOG_AXIS_TIME - 1;
334 analog_button_read(port, saitek, chf);
338 for (i = 0; i < 2; i++)
339 if (port->analog[i].mask)
340 analog_decode(port->analog + i, port->axes, port->initial, port->buttons);
344 * analog_open() is a callback from the input open routine.
347 static int analog_open(struct input_dev *dev)
349 struct analog_port *port = dev->private;
351 gameport_start_polling(port->gameport);
356 * analog_close() is a callback from the input close routine.
359 static void analog_close(struct input_dev *dev)
361 struct analog_port *port = dev->private;
363 gameport_stop_polling(port->gameport);
367 * analog_calibrate_timer() calibrates the timer and computes loop
368 * and timeout values for a joystick port.
371 static void analog_calibrate_timer(struct analog_port *port)
373 struct gameport *gameport = port->gameport;
374 unsigned int i, t, tx, t1, t2, t3;
377 local_irq_save(flags);
380 analog_faketime += 830;
385 local_irq_restore(flags);
387 port->speed = DELTA(t1, t2) - DELTA(t2, t3);
391 for (i = 0; i < 50; i++) {
392 local_irq_save(flags);
394 for (t = 0; t < 50; t++) { gameport_read(gameport); GET_TIME(t2); }
396 local_irq_restore(flags);
398 t = DELTA(t1, t2) - DELTA(t2, t3);
402 port->loop = tx / 50;
406 * analog_name() constructs a name for an analog joystick.
409 static void analog_name(struct analog *analog)
411 sprintf(analog->name, "Analog %d-axis %d-button",
412 hweight8(analog->mask & ANALOG_AXES_STD),
413 hweight8(analog->mask & ANALOG_BTNS_STD) + !!(analog->mask & ANALOG_BTNS_CHF) * 2 +
414 hweight16(analog->mask & ANALOG_BTNS_GAMEPAD) + !!(analog->mask & ANALOG_HBTN_CHF) * 4);
416 if (analog->mask & ANALOG_HATS_ALL)
417 sprintf(analog->name, "%s %d-hat",
418 analog->name, hweight16(analog->mask & ANALOG_HATS_ALL));
420 if (analog->mask & ANALOG_HAT_FCS)
421 strcat(analog->name, " FCS");
422 if (analog->mask & ANALOG_ANY_CHF)
423 strcat(analog->name, (analog->mask & ANALOG_SAITEK) ? " Saitek" : " CHF");
425 strcat(analog->name, (analog->mask & ANALOG_GAMEPAD) ? " gamepad": " joystick");
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;
438 sprintf(analog->phys, "%s/input%d", port->gameport->phys, index);
439 analog->buttons = (analog->mask & ANALOG_GAMEPAD) ? analog_pad_btn : analog_joy_btn;
441 analog->dev = input_dev = input_allocate_device();
445 input_dev->name = analog->name;
446 input_dev->phys = analog->phys;
447 input_dev->id.bustype = BUS_GAMEPORT;
448 input_dev->id.vendor = GAMEPORT_ID_VENDOR_ANALOG;
449 input_dev->id.product = analog->mask >> 4;
450 input_dev->id.version = 0x0100;
452 input_dev->open = analog_open;
453 input_dev->close = analog_close;
454 input_dev->private = port;
455 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
457 for (i = j = 0; i < 4; i++)
458 if (analog->mask & (1 << i)) {
462 y = (port->axes[0] + port->axes[1]) >> 1;
463 z = y - port->axes[i];
468 if ((i == 2 || i == 3) && (j == 2 || j == 3) && (z > (y >> 3)))
471 if (analog->mask & ANALOG_SAITEK) {
472 if (i == 2) x = port->axes[i];
477 input_set_abs_params(input_dev, t, v, (x << 1) - v, port->fuzz, w);
481 for (i = j = 0; i < 3; i++)
482 if (analog->mask & analog_exts[i])
483 for (x = 0; x < 2; x++) {
484 t = analog_hats[j++];
485 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
488 for (i = j = 0; i < 4; i++)
489 if (analog->mask & (0x10 << i))
490 set_bit(analog->buttons[j++], input_dev->keybit);
492 if (analog->mask & ANALOG_BTNS_CHF)
493 for (i = 0; i < 2; i++)
494 set_bit(analog->buttons[j++], input_dev->keybit);
496 if (analog->mask & ANALOG_HBTN_CHF)
497 for (i = 0; i < 4; i++)
498 set_bit(analog->buttons[j++], input_dev->keybit);
500 for (i = 0; i < 4; i++)
501 if (analog->mask & (ANALOG_BTN_TL << i))
502 set_bit(analog_pads[i], input_dev->keybit);
504 analog_decode(analog, port->axes, port->initial, port->buttons);
506 input_register_device(analog->dev);
512 * analog_init_devices() sets up device-specific values and registers the input devices.
515 static int analog_init_masks(struct analog_port *port)
518 struct analog *analog = port->analog;
524 if ((port->mask & 3) != 3 && port->mask != 0xc) {
525 printk(KERN_WARNING "analog.c: Unknown joystick device found "
526 "(data=%#x, %s), probably not analog joystick.\n",
527 port->mask, port->gameport->phys);
532 i = analog_options[0]; /* FIXME !!! - need to specify options for different ports */
534 analog[0].mask = i & 0xfffff;
536 analog[0].mask &= ~(ANALOG_AXES_STD | ANALOG_HAT_FCS | ANALOG_BTNS_GAMEPAD)
537 | port->mask | ((port->mask << 8) & ANALOG_HAT_FCS)
538 | ((port->mask << 10) & ANALOG_BTNS_TLR) | ((port->mask << 12) & ANALOG_BTNS_TLR2);
540 analog[0].mask &= ~(ANALOG_HAT2_CHF)
541 | ((analog[0].mask & ANALOG_HBTN_CHF) ? 0 : ANALOG_HAT2_CHF);
543 analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_BTN_TR | ANALOG_BTN_TR2)
544 | ((~analog[0].mask & ANALOG_HAT_FCS) >> 8)
545 | ((~analog[0].mask & ANALOG_HAT_FCS) << 2)
546 | ((~analog[0].mask & ANALOG_HAT_FCS) << 4);
548 analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_RUDDER)
549 | (((~analog[0].mask & ANALOG_BTNS_TLR ) >> 10)
550 & ((~analog[0].mask & ANALOG_BTNS_TLR2) >> 12));
552 analog[1].mask = ((i >> 20) & 0xff) | ((i >> 12) & 0xf0000);
554 analog[1].mask &= (analog[0].mask & ANALOG_EXTENSIONS) ? ANALOG_GAMEPAD
555 : (((ANALOG_BTNS_STD | port->mask) & ~analog[0].mask) | ANALOG_GAMEPAD);
559 for (i = 0; i < 4; i++) max[i] = port->axes[i] << 1;
561 if ((analog[0].mask & 0x7) == 0x7) max[2] = (max[0] + max[1]) >> 1;
562 if ((analog[0].mask & 0xb) == 0xb) max[3] = (max[0] + max[1]) >> 1;
563 if ((analog[0].mask & ANALOG_BTN_TL) && !(analog[0].mask & ANALOG_BTN_TL2)) max[2] >>= 1;
564 if ((analog[0].mask & ANALOG_BTN_TR) && !(analog[0].mask & ANALOG_BTN_TR2)) max[3] >>= 1;
565 if ((analog[0].mask & ANALOG_HAT_FCS)) max[3] >>= 1;
567 gameport_calibrate(port->gameport, port->axes, max);
570 for (i = 0; i < 4; i++)
571 port->initial[i] = port->axes[i];
573 return -!(analog[0].mask || analog[1].mask);
576 static int analog_init_port(struct gameport *gameport, struct gameport_driver *drv, struct analog_port *port)
580 port->gameport = gameport;
582 gameport_set_drvdata(gameport, port);
584 if (!gameport_open(gameport, drv, GAMEPORT_MODE_RAW)) {
586 analog_calibrate_timer(port);
588 gameport_trigger(gameport);
589 t = gameport_read(gameport);
590 msleep(ANALOG_MAX_TIME);
591 port->mask = (gameport_read(gameport) ^ t) & t & 0xf;
592 port->fuzz = (port->speed * ANALOG_FUZZ_MAGIC) / port->loop / 1000 + ANALOG_FUZZ_BITS;
594 for (i = 0; i < ANALOG_INIT_RETRIES; i++) {
595 if (!analog_cooked_read(port))
597 msleep(ANALOG_MAX_TIME);
602 msleep(ANALOG_MAX_TIME);
603 t = gameport_time(gameport, ANALOG_MAX_TIME * 1000);
604 gameport_trigger(gameport);
605 while ((gameport_read(port->gameport) & port->mask) && (u < t))
607 udelay(ANALOG_SAITEK_DELAY);
608 t = gameport_time(gameport, ANALOG_SAITEK_TIME);
609 gameport_trigger(gameport);
610 while ((gameport_read(port->gameport) & port->mask) && (v < t))
613 if (v < (u >> 1)) { /* FIXME - more than one port */
614 analog_options[0] |= /* FIXME - more than one port */
615 ANALOG_SAITEK | ANALOG_BTNS_CHF | ANALOG_HBTN_CHF | ANALOG_HAT1_CHF;
619 gameport_close(gameport);
622 if (!gameport_open(gameport, drv, GAMEPORT_MODE_COOKED)) {
624 for (i = 0; i < ANALOG_INIT_RETRIES; i++)
625 if (!gameport_cooked_read(gameport, port->axes, &port->buttons))
627 for (i = 0; i < 4; i++)
628 if (port->axes[i] != -1)
629 port->mask |= 1 << i;
631 port->fuzz = gameport->fuzz;
636 return gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
639 static int analog_connect(struct gameport *gameport, struct gameport_driver *drv)
641 struct analog_port *port;
645 if (!(port = kzalloc(sizeof(struct analog_port), GFP_KERNEL)))
648 err = analog_init_port(gameport, drv, port);
652 err = analog_init_masks(port);
656 gameport_set_poll_handler(gameport, analog_poll);
657 gameport_set_poll_interval(gameport, 10);
659 for (i = 0; i < 2; i++)
660 if (port->analog[i].mask) {
661 err = analog_init_device(port, port->analog + i, i);
668 fail3: while (--i >= 0)
669 input_unregister_device(port->analog[i].dev);
670 fail2: gameport_close(gameport);
671 fail1: gameport_set_drvdata(gameport, NULL);
676 static void analog_disconnect(struct gameport *gameport)
678 struct analog_port *port = gameport_get_drvdata(gameport);
681 for (i = 0; i < 2; i++)
682 if (port->analog[i].mask)
683 input_unregister_device(port->analog[i].dev);
684 gameport_close(gameport);
685 gameport_set_drvdata(gameport, NULL);
686 printk(KERN_INFO "analog.c: %d out of %d reads (%d%%) on %s failed\n",
687 port->bads, port->reads, port->reads ? (port->bads * 100 / port->reads) : 0,
688 port->gameport->phys);
692 struct analog_types {
697 static struct analog_types analog_types[] = {
698 { "none", 0x00000000 },
699 { "auto", 0x000000ff },
700 { "2btn", 0x0000003f },
701 { "y-joy", 0x0cc00033 },
702 { "y-pad", 0x8cc80033 },
703 { "fcs", 0x000008f7 },
704 { "chf", 0x000002ff },
705 { "fullchf", 0x000007ff },
706 { "gamepad", 0x000830f3 },
707 { "gamepad8", 0x0008f0f3 },
711 static void analog_parse_options(void)
716 for (i = 0; i < js_nargs; i++) {
718 for (j = 0; analog_types[j].name; j++)
719 if (!strcmp(analog_types[j].name, js[i])) {
720 analog_options[i] = analog_types[j].value;
723 if (analog_types[j].name) continue;
725 analog_options[i] = simple_strtoul(js[i], &end, 0);
726 if (end != js[i]) continue;
728 analog_options[i] = 0xff;
729 if (!strlen(js[i])) continue;
731 printk(KERN_WARNING "analog.c: Bad config for port %d - \"%s\"\n", i, js[i]);
734 for (; i < ANALOG_PORTS; i++)
735 analog_options[i] = 0xff;
739 * The gameport device structure.
742 static struct gameport_driver analog_drv = {
746 .description = DRIVER_DESC,
747 .connect = analog_connect,
748 .disconnect = analog_disconnect,
751 static int __init analog_init(void)
753 analog_parse_options();
754 gameport_register_driver(&analog_drv);
759 static void __exit analog_exit(void)
761 gameport_unregister_driver(&analog_drv);
764 module_init(analog_init);
765 module_exit(analog_exit);