2 * Copyright (c) 1998-2005 Vojtech Pavlik
6 * Microsoft SideWinder joystick family 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
25 #include <linux/delay.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/slab.h>
29 #include <linux/input.h>
30 #include <linux/gameport.h>
31 #include <linux/jiffies.h>
33 #define DRIVER_DESC "Microsoft SideWinder joystick family driver"
35 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
36 MODULE_DESCRIPTION(DRIVER_DESC);
37 MODULE_LICENSE("GPL");
40 * These are really magic values. Changing them can make a problem go away,
41 * as well as break everything.
47 #define SW_START 600 /* The time we wait for the first bit [600 us] */
48 #define SW_STROBE 60 /* Max time per bit [60 us] */
49 #define SW_TIMEOUT 6 /* Wait for everything to settle [6 ms] */
50 #define SW_KICK 45 /* Wait after A0 fall till kick [45 us] */
51 #define SW_END 8 /* Number of bits before end of packet to kick */
52 #define SW_FAIL 16 /* Number of packet read errors to fail and reinitialize */
53 #define SW_BAD 2 /* Number of packet read errors to switch off 3d Pro optimization */
54 #define SW_OK 64 /* Number of packet read successes to switch optimization back on */
55 #define SW_LENGTH 512 /* Max number of bits in a packet */
58 #define dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" , ## arg)
60 #define dbg(format, arg...) do {} while (0)
64 * SideWinder joystick types ...
75 * Names, buttons, axes ...
78 static char *sw_name[] = { "3D Pro", "GamePad", "Precision Pro", "Force Feedback Pro", "FreeStyle Pro",
79 "Force Feedback Wheel" };
81 static char sw_abs[][7] = {
82 { ABS_X, ABS_Y, ABS_RZ, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y },
84 { ABS_X, ABS_Y, ABS_RZ, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y },
85 { ABS_X, ABS_Y, ABS_RZ, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y },
86 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y },
87 { ABS_RX, ABS_RUDDER, ABS_THROTTLE }};
89 static char sw_bit[][7] = {
90 { 10, 10, 9, 10, 1, 1 },
92 { 10, 10, 6, 7, 1, 1 },
93 { 10, 10, 6, 7, 1, 1 },
97 static short sw_btn[][12] = {
98 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_THUMB2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_MODE },
99 { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_START, BTN_MODE },
100 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_SELECT },
101 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_SELECT },
102 { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_START, BTN_MODE, BTN_SELECT },
103 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_THUMB2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4 }};
108 } sw_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
111 struct gameport *gameport;
112 struct input_dev *dev[4];
126 * sw_read_packet() is a function which reads either a data packet, or an
127 * identification packet from a SideWinder joystick. The protocol is very,
128 * very, very braindamaged. Microsoft patented it in US patent #5628686.
131 static int sw_read_packet(struct gameport *gameport, unsigned char *buf, int length, int id)
134 int timeout, bitout, sched, i, kick, start, strobe;
135 unsigned char pending, u, v;
137 i = -id; /* Don't care about data, only want ID */
138 timeout = id ? gameport_time(gameport, SW_TIMEOUT * 1000) : 0; /* Set up global timeout for ID packet */
139 kick = id ? gameport_time(gameport, SW_KICK) : 0; /* Set up kick timeout for ID packet */
140 start = gameport_time(gameport, SW_START);
141 strobe = gameport_time(gameport, SW_STROBE);
146 local_irq_save(flags); /* Quiet, please */
148 gameport_trigger(gameport); /* Trigger */
149 v = gameport_read(gameport);
154 v = gameport_read(gameport);
155 } while (!(~v & u & 0x10) && (bitout > 0)); /* Wait for first falling edge on clock */
158 bitout = strobe; /* Extend time if not timed out */
160 while ((timeout > 0 || bitout > 0) && (i < length)) {
163 bitout--; /* Decrement timers */
167 v = gameport_read(gameport);
169 if ((~u & v & 0x10) && (bitout > 0)) { /* Rising edge on clock - data bit */
170 if (i >= 0) /* Want this data */
171 buf[i] = v >> 5; /* Store it */
172 i++; /* Advance index */
173 bitout = strobe; /* Extend timeout for next bit */
176 if (kick && (~v & u & 0x01)) { /* Falling edge on axis 0 */
177 sched = kick; /* Schedule second trigger */
178 kick = 0; /* Don't schedule next time on falling edge */
179 pending = 1; /* Mark schedule */
182 if (pending && sched < 0 && (i > -SW_END)) { /* Second trigger time */
183 gameport_trigger(gameport); /* Trigger */
184 bitout = start; /* Long bit timeout */
185 pending = 0; /* Unmark schedule */
186 timeout = 0; /* Switch from global to bit timeouts */
190 local_irq_restore(flags); /* Done - relax */
195 printk(KERN_DEBUG "sidewinder.c: Read %d triplets. [", i);
196 for (j = 0; j < i; j++) printk("%d", buf[j]);
205 * sw_get_bits() and GB() compose bits from the triplet buffer into a __u64.
206 * Parameter 'pos' is bit number inside packet where to start at, 'num' is number
207 * of bits to be read, 'shift' is offset in the resulting __u64 to start at, bits
208 * is number of bits per triplet.
211 #define GB(pos,num) sw_get_bits(buf, pos, num, sw->bits)
213 static __u64 sw_get_bits(unsigned char *buf, int pos, int num, char bits)
216 int tri = pos % bits; /* Start position */
221 data |= (__u64)((buf[i] >> tri++) & 1) << bit++; /* Transfer bit */
223 i++; /* Next triplet */
232 * sw_init_digital() initializes a SideWinder 3D Pro joystick
236 static void sw_init_digital(struct gameport *gameport)
238 int seq[] = { 140, 140+725, 140+300, 0 };
242 local_irq_save(flags);
246 gameport_trigger(gameport); /* Trigger */
247 t = gameport_time(gameport, SW_TIMEOUT * 1000);
248 while ((gameport_read(gameport) & 1) && t) t--; /* Wait for axis to fall back to 0 */
249 udelay(seq[i]); /* Delay magic time */
252 gameport_trigger(gameport); /* Last trigger */
254 local_irq_restore(flags);
258 * sw_parity() computes parity of __u64
261 static int sw_parity(__u64 t)
263 int x = t ^ (t >> 32);
274 * sw_ccheck() checks synchronization bits and computes checksum of nibbles.
277 static int sw_check(__u64 t)
279 unsigned char sum = 0;
281 if ((t & 0x8080808080808080ULL) ^ 0x80) /* Sync */
284 while (t) { /* Sum */
293 * sw_parse() analyzes SideWinder joystick data, and writes the results into
294 * the axes and buttons arrays.
297 static int sw_parse(unsigned char *buf, struct sw *sw)
300 struct input_dev *dev;
306 if (sw_check(GB(0,64)) || (hat = (GB(6,1) << 3) | GB(60,3)) > 8)
311 input_report_abs(dev, ABS_X, (GB( 3,3) << 7) | GB(16,7));
312 input_report_abs(dev, ABS_Y, (GB( 0,3) << 7) | GB(24,7));
313 input_report_abs(dev, ABS_RZ, (GB(35,2) << 7) | GB(40,7));
314 input_report_abs(dev, ABS_THROTTLE, (GB(32,3) << 7) | GB(48,7));
316 input_report_abs(dev, ABS_HAT0X, sw_hat_to_axis[hat].x);
317 input_report_abs(dev, ABS_HAT0Y, sw_hat_to_axis[hat].y);
319 for (j = 0; j < 7; j++)
320 input_report_key(dev, sw_btn[SW_ID_3DP][j], !GB(j+8,1));
322 input_report_key(dev, BTN_BASE4, !GB(38,1));
323 input_report_key(dev, BTN_BASE5, !GB(37,1));
331 for (i = 0; i < sw->number; i ++) {
333 if (sw_parity(GB(i*15,15)))
336 input_report_abs(sw->dev[i], ABS_X, GB(i*15+3,1) - GB(i*15+2,1));
337 input_report_abs(sw->dev[i], ABS_Y, GB(i*15+0,1) - GB(i*15+1,1));
339 for (j = 0; j < 10; j++)
340 input_report_key(sw->dev[i], sw_btn[SW_ID_GP][j], !GB(i*15+j+4,1));
342 input_sync(sw->dev[i]);
350 if (!sw_parity(GB(0,48)) || (hat = GB(42,4)) > 8)
354 input_report_abs(dev, ABS_X, GB( 9,10));
355 input_report_abs(dev, ABS_Y, GB(19,10));
356 input_report_abs(dev, ABS_RZ, GB(36, 6));
357 input_report_abs(dev, ABS_THROTTLE, GB(29, 7));
359 input_report_abs(dev, ABS_HAT0X, sw_hat_to_axis[hat].x);
360 input_report_abs(dev, ABS_HAT0Y, sw_hat_to_axis[hat].y);
362 for (j = 0; j < 9; j++)
363 input_report_key(dev, sw_btn[SW_ID_PP][j], !GB(j,1));
371 if (!sw_parity(GB(0,43)) || (hat = GB(28,4)) > 8)
375 input_report_abs(dev, ABS_X, GB( 0,10));
376 input_report_abs(dev, ABS_Y, GB(16,10));
377 input_report_abs(dev, ABS_THROTTLE, GB(32, 6));
379 input_report_abs(dev, ABS_HAT0X, sw_hat_to_axis[hat].x);
380 input_report_abs(dev, ABS_HAT0Y, sw_hat_to_axis[hat].y);
382 for (j = 0; j < 6; j++)
383 input_report_key(dev, sw_btn[SW_ID_FSP][j], !GB(j+10,1));
385 input_report_key(dev, BTN_TR, !GB(26,1));
386 input_report_key(dev, BTN_START, !GB(27,1));
387 input_report_key(dev, BTN_MODE, !GB(38,1));
388 input_report_key(dev, BTN_SELECT, !GB(39,1));
396 if (!sw_parity(GB(0,33)))
400 input_report_abs(dev, ABS_RX, GB( 0,10));
401 input_report_abs(dev, ABS_RUDDER, GB(10, 6));
402 input_report_abs(dev, ABS_THROTTLE, GB(16, 6));
404 for (j = 0; j < 8; j++)
405 input_report_key(dev, sw_btn[SW_ID_FFW][j], !GB(j+22,1));
416 * sw_read() reads SideWinder joystick data, and reinitializes
417 * the joystick in case of persistent problems. This is the function that is
418 * called from the generic code to poll the joystick.
421 static int sw_read(struct sw *sw)
423 unsigned char buf[SW_LENGTH];
426 i = sw_read_packet(sw->gameport, buf, sw->length, 0);
428 if (sw->type == SW_ID_3DP && sw->length == 66 && i != 66) { /* Broken packet, try to fix */
430 if (i == 64 && !sw_check(sw_get_bits(buf,0,64,1))) { /* Last init failed, 1 bit mode */
431 printk(KERN_WARNING "sidewinder.c: Joystick in wrong mode on %s"
432 " - going to reinitialize.\n", sw->gameport->phys);
433 sw->fail = SW_FAIL; /* Reinitialize */
434 i = 128; /* Bogus value */
437 if (i < 66 && GB(0,64) == GB(i*3-66,64)) /* 1 == 3 */
438 i = 66; /* Everything is fine */
440 if (i < 66 && GB(0,64) == GB(66,64)) /* 1 == 2 */
441 i = 66; /* Everything is fine */
443 if (i < 66 && GB(i*3-132,64) == GB(i*3-66,64)) { /* 2 == 3 */
444 memmove(buf, buf + i - 22, 22); /* Move data */
445 i = 66; /* Carry on */
449 if (i == sw->length && !sw_parse(buf, sw)) { /* Parse data */
454 if (sw->type == SW_ID_3DP && sw->length == 66 /* Many packets OK */
457 printk(KERN_INFO "sidewinder.c: No more trouble on %s"
458 " - enabling optimization again.\n", sw->gameport->phys);
468 if (sw->type == SW_ID_3DP && sw->length == 22 && sw->fail > SW_BAD) { /* Consecutive bad packets */
470 printk(KERN_INFO "sidewinder.c: Many bit errors on %s"
471 " - disabling optimization.\n", sw->gameport->phys);
475 if (sw->fail < SW_FAIL)
476 return -1; /* Not enough, don't reinitialize yet */
478 printk(KERN_WARNING "sidewinder.c: Too many bit errors on %s"
479 " - reinitializing joystick.\n", sw->gameport->phys);
481 if (!i && sw->type == SW_ID_3DP) { /* 3D Pro can be in analog mode */
482 mdelay(3 * SW_TIMEOUT);
483 sw_init_digital(sw->gameport);
487 i = sw_read_packet(sw->gameport, buf, SW_LENGTH, 0); /* Read normal data packet */
489 sw_read_packet(sw->gameport, buf, SW_LENGTH, i); /* Read ID packet, this initializes the stick */
496 static void sw_poll(struct gameport *gameport)
498 struct sw *sw = gameport_get_drvdata(gameport);
505 static int sw_open(struct input_dev *dev)
507 struct sw *sw = input_get_drvdata(dev);
509 gameport_start_polling(sw->gameport);
513 static void sw_close(struct input_dev *dev)
515 struct sw *sw = input_get_drvdata(dev);
517 gameport_stop_polling(sw->gameport);
521 * sw_print_packet() prints the contents of a SideWinder packet.
524 static void sw_print_packet(char *name, int length, unsigned char *buf, char bits)
528 printk(KERN_INFO "sidewinder.c: %s packet, %d bits. [", name, length);
529 for (i = (((length + 3) >> 2) - 1); i >= 0; i--)
530 printk("%x", (int)sw_get_bits(buf, i << 2, 4, bits));
535 * sw_3dp_id() translates the 3DP id into a human legible string.
536 * Unfortunately I don't know how to do this for the other SW types.
539 static void sw_3dp_id(unsigned char *buf, char *comment, size_t size)
544 for (i = 0; i < 7; i++) /* ASCII PnP ID */
545 pnp[i] = sw_get_bits(buf, 24+8*i, 8, 1);
547 for (i = 0; i < 8; i++) /* ASCII firmware revision */
548 rev[i] = sw_get_bits(buf, 88+8*i, 8, 1);
552 snprintf(comment, size, " [PnP %d.%02d id %s rev %s]",
553 (int) ((sw_get_bits(buf, 8, 6, 1) << 6) | /* Two 6-bit values */
554 sw_get_bits(buf, 16, 6, 1)) / 100,
555 (int) ((sw_get_bits(buf, 8, 6, 1) << 6) |
556 sw_get_bits(buf, 16, 6, 1)) % 100,
561 * sw_guess_mode() checks the upper two button bits for toggling -
562 * indication of that the joystick is in 3-bit mode. This is documented
563 * behavior for 3DP ID packet, and for example the FSP does this in
564 * normal packets instead. Fun ...
567 static int sw_guess_mode(unsigned char *buf, int len)
570 unsigned char xor = 0;
572 for (i = 1; i < len; i++)
573 xor |= (buf[i - 1] ^ buf[i]) & 6;
575 return !!xor * 2 + 1;
579 * sw_connect() probes for SideWinder type joysticks.
582 static int sw_connect(struct gameport *gameport, struct gameport_driver *drv)
585 struct input_dev *input_dev;
588 unsigned char *buf = NULL; /* [SW_LENGTH] */
589 unsigned char *idbuf = NULL; /* [SW_LENGTH] */
595 sw = kzalloc(sizeof(struct sw), GFP_KERNEL);
596 buf = kmalloc(SW_LENGTH, GFP_KERNEL);
597 idbuf = kmalloc(SW_LENGTH, GFP_KERNEL);
598 if (!sw || !buf || !idbuf) {
603 sw->gameport = gameport;
605 gameport_set_drvdata(gameport, sw);
607 err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
611 dbg("Init 0: Opened %s, io %#x, speed %d",
612 gameport->phys, gameport->io, gameport->speed);
614 i = sw_read_packet(gameport, buf, SW_LENGTH, 0); /* Read normal packet */
616 dbg("Init 1: Mode %d. Length %d.", m , i);
618 if (!i) { /* No data. 3d Pro analog mode? */
619 sw_init_digital(gameport); /* Switch to digital */
621 i = sw_read_packet(gameport, buf, SW_LENGTH, 0); /* Retry reading packet */
623 dbg("Init 1b: Length %d.", i);
624 if (!i) { /* No data -> FAIL */
630 j = sw_read_packet(gameport, idbuf, SW_LENGTH, i); /* Read ID. This initializes the stick */
631 m |= sw_guess_mode(idbuf, j); /* ID packet should carry mode info [3DP] */
632 dbg("Init 2: Mode %d. ID Length %d.", m, j);
634 if (j <= 0) { /* Read ID failed. Happens in 1-bit mode on PP */
636 i = sw_read_packet(gameport, buf, SW_LENGTH, 0); /* Retry reading packet */
637 m |= sw_guess_mode(buf, i);
638 dbg("Init 2b: Mode %d. Length %d.", m, i);
644 j = sw_read_packet(gameport, idbuf, SW_LENGTH, i); /* Retry reading ID */
645 dbg("Init 2c: ID Length %d.", j);
649 k = SW_FAIL; /* Try SW_FAIL times */
655 i = sw_read_packet(gameport, buf, SW_LENGTH, 0); /* Read data packet */
656 dbg("Init 3: Mode %d. Length %d. Last %d. Tries %d.", m, i, l, k);
658 if (i > l) { /* Longer? As we can only lose bits, it makes */
659 /* no sense to try detection for a packet shorter */
660 l = i; /* than the previous one */
663 sw->gameport = gameport;
667 dbg("Init 3a: Case %d.\n", i * m);
671 sw->number++; /* fall through */
672 case 45: /* Ambiguous packet length */
673 if (j <= 40) { /* ID length less or eq 40 -> FSP */
675 sw->type = SW_ID_FSP;
678 sw->number++; /* fall through */
680 sw->number++; /* fall through */
686 sw->type = SW_ID_FFW;
688 case 48: /* Ambiguous */
689 if (j == 14) { /* ID length 14*3 -> FFP */
690 sw->type = SW_ID_FFP;
691 sprintf(comment, " [AC %s]", sw_get_bits(idbuf,38,1,3) ? "off" : "on");
696 sw->bits = 3; /* fall through */
698 sw->length = 22; /* fall through */
700 sw->type = SW_ID_3DP;
702 sw_3dp_id(idbuf, comment, sizeof(comment));
707 } while (k && sw->type == -1);
709 if (sw->type == -1) {
710 printk(KERN_WARNING "sidewinder.c: unknown joystick device detected "
711 "on %s, contact <vojtech@ucw.cz>\n", gameport->phys);
712 sw_print_packet("ID", j * 3, idbuf, 3);
713 sw_print_packet("Data", i * m, buf, m);
719 sw_print_packet("ID", j * 3, idbuf, 3);
720 sw_print_packet("Data", i * m, buf, m);
723 gameport_set_poll_handler(gameport, sw_poll);
724 gameport_set_poll_interval(gameport, 20);
729 for (i = 0; i < sw->number; i++) {
732 snprintf(sw->name, sizeof(sw->name),
733 "Microsoft SideWinder %s", sw_name[sw->type]);
734 snprintf(sw->phys[i], sizeof(sw->phys[i]),
735 "%s/input%d", gameport->phys, i);
737 sw->dev[i] = input_dev = input_allocate_device();
743 input_dev->name = sw->name;
744 input_dev->phys = sw->phys[i];
745 input_dev->id.bustype = BUS_GAMEPORT;
746 input_dev->id.vendor = GAMEPORT_ID_VENDOR_MICROSOFT;
747 input_dev->id.product = sw->type;
748 input_dev->id.version = 0x0100;
749 input_dev->dev.parent = &gameport->dev;
751 input_set_drvdata(input_dev, sw);
753 input_dev->open = sw_open;
754 input_dev->close = sw_close;
756 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
758 for (j = 0; (bits = sw_bit[sw->type][j]); j++) {
759 int min, max, fuzz, flat;
761 code = sw_abs[sw->type][j];
762 min = bits == 1 ? -1 : 0;
763 max = (1 << bits) - 1;
764 fuzz = (bits >> 1) >= 2 ? 1 << ((bits >> 1) - 2) : 0;
765 flat = code == ABS_THROTTLE || bits < 5 ?
768 input_set_abs_params(input_dev, code,
769 min, max, fuzz, flat);
772 for (j = 0; (code = sw_btn[sw->type][j]); j++)
773 __set_bit(code, input_dev->keybit);
775 dbg("%s%s [%d-bit id %d data %d]\n", sw->name, comment, m, l, k);
777 err = input_register_device(sw->dev[i]);
787 fail4: input_free_device(sw->dev[i]);
788 fail3: while (--i >= 0)
789 input_unregister_device(sw->dev[i]);
790 fail2: gameport_close(gameport);
791 fail1: gameport_set_drvdata(gameport, NULL);
796 static void sw_disconnect(struct gameport *gameport)
798 struct sw *sw = gameport_get_drvdata(gameport);
801 for (i = 0; i < sw->number; i++)
802 input_unregister_device(sw->dev[i]);
803 gameport_close(gameport);
804 gameport_set_drvdata(gameport, NULL);
808 static struct gameport_driver sw_drv = {
810 .name = "sidewinder",
811 .owner = THIS_MODULE,
813 .description = DRIVER_DESC,
814 .connect = sw_connect,
815 .disconnect = sw_disconnect,
818 module_gameport_driver(sw_drv);