2 * $Id: a3d.c,v 1.10 2000/05/29 11:19:50 vojtech Exp $
4 * Copyright (c) 1998-2000 Vojtech Pavlik
10 * FP-Gaming Assasin 3D joystick driver for Linux
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * Should you need to contact me, the author, you can do so either by
29 * e-mail - mail your message to <vojtech@suse.cz>, or by paper mail:
30 * Vojtech Pavlik, Ucitelska 1576, Prague 8, 182 00 Czech Republic
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/malloc.h>
36 #include <linux/init.h>
37 #include <linux/gameport.h>
38 #include <linux/input.h>
40 #define A3D_MAX_START 400 /* 400 us */
41 #define A3D_MAX_STROBE 60 /* 40 us */
42 #define A3D_DELAY_READ 3 /* 3 ms */
43 #define A3D_MAX_LENGTH 40 /* 40*3 bits */
44 #define A3D_REFRESH_TIME HZ/50 /* 20 ms */
46 #define A3D_MODE_A3D 1 /* Assassin 3D */
47 #define A3D_MODE_PAN 2 /* Panther */
48 #define A3D_MODE_OEM 3 /* Panther OEM version */
49 #define A3D_MODE_PXL 4 /* Panther XL */
51 char *a3d_names
[] = { NULL
, "FP-Gaming Assassin 3D", "MadCatz Panther", "OEM Panther",
52 "MadCatz Panther XL", "MadCatz Panther XL w/ rudder" };
55 struct gameport
*gameport
;
58 struct timer_list timer
;
69 * a3d_read_packet() reads an Assassin 3D packet.
72 static int a3d_read_packet(struct gameport
*gameport
, int length
, char *data
)
80 t
= gameport_time(gameport
, A3D_MAX_START
);
81 s
= gameport_time(gameport
, A3D_MAX_STROBE
);
85 gameport_trigger(gameport
);
86 v
= gameport_read(gameport
);
88 while (t
> 0 && i
< length
) {
90 u
= v
; v
= gameport_read(gameport
);
97 __restore_flags(flags
);
103 * a3d_csum() computes checksum of triplet packet
106 static int a3d_csum(char *data
, int count
)
109 for (i
= 0; i
< count
- 2; i
++) csum
+= data
[i
];
110 return (csum
& 0x3f) != ((data
[count
- 2] << 3) | data
[count
- 1]);
113 static void a3d_read(struct a3d
*a3d
, unsigned char *data
)
115 struct input_dev
*dev
= &a3d
->dev
;
123 input_report_rel(dev
, REL_X
, ((data
[5] << 6) | (data
[6] << 3) | data
[ 7]) - ((data
[5] & 4) << 7));
124 input_report_rel(dev
, REL_Y
, ((data
[8] << 6) | (data
[9] << 3) | data
[10]) - ((data
[8] & 4) << 7));
126 input_report_key(dev
, BTN_RIGHT
, data
[2] & 1);
127 input_report_key(dev
, BTN_LEFT
, data
[3] & 2);
128 input_report_key(dev
, BTN_MIDDLE
, data
[3] & 4);
130 a3d
->axes
[0] = ((signed char)((data
[11] << 6) | (data
[12] << 3) | (data
[13]))) + 128;
131 a3d
->axes
[1] = ((signed char)((data
[14] << 6) | (data
[15] << 3) | (data
[16]))) + 128;
132 a3d
->axes
[2] = ((signed char)((data
[17] << 6) | (data
[18] << 3) | (data
[19]))) + 128;
133 a3d
->axes
[3] = ((signed char)((data
[20] << 6) | (data
[21] << 3) | (data
[22]))) + 128;
135 a3d
->buttons
= ((data
[3] << 3) | data
[4]) & 0xf;
141 input_report_rel(dev
, REL_X
, ((data
[ 9] << 6) | (data
[10] << 3) | data
[11]) - ((data
[ 9] & 4) << 7));
142 input_report_rel(dev
, REL_Y
, ((data
[12] << 6) | (data
[13] << 3) | data
[14]) - ((data
[12] & 4) << 7));
144 input_report_key(dev
, BTN_RIGHT
, data
[2] & 1);
145 input_report_key(dev
, BTN_LEFT
, data
[3] & 2);
146 input_report_key(dev
, BTN_MIDDLE
, data
[3] & 4);
147 input_report_key(dev
, BTN_SIDE
, data
[7] & 2);
148 input_report_key(dev
, BTN_EXTRA
, data
[7] & 4);
150 input_report_abs(dev
, ABS_X
, ((signed char)((data
[15] << 6) | (data
[16] << 3) | (data
[17]))) + 128);
151 input_report_abs(dev
, ABS_Y
, ((signed char)((data
[18] << 6) | (data
[19] << 3) | (data
[20]))) + 128);
152 input_report_abs(dev
, ABS_RUDDER
, ((signed char)((data
[21] << 6) | (data
[22] << 3) | (data
[23]))) + 128);
153 input_report_abs(dev
, ABS_THROTTLE
, ((signed char)((data
[24] << 6) | (data
[25] << 3) | (data
[26]))) + 128);
155 input_report_abs(dev
, ABS_HAT0X
, ( data
[5] & 1) - ((data
[5] >> 2) & 1));
156 input_report_abs(dev
, ABS_HAT0Y
, ((data
[5] >> 1) & 1) - ((data
[6] >> 2) & 1));
157 input_report_abs(dev
, ABS_HAT1X
, ((data
[4] >> 1) & 1) - ( data
[3] & 1));
158 input_report_abs(dev
, ABS_HAT1Y
, ((data
[4] >> 2) & 1) - ( data
[4] & 1));
160 input_report_key(dev
, BTN_TRIGGER
, data
[8] & 1);
161 input_report_key(dev
, BTN_THUMB
, data
[8] & 2);
162 input_report_key(dev
, BTN_TOP
, data
[8] & 4);
163 input_report_key(dev
, BTN_PINKIE
, data
[7] & 1);
171 * a3d_timer() reads and analyzes A3D joystick data.
174 static void a3d_timer(unsigned long private)
176 struct a3d
*a3d
= (void *) private;
177 unsigned char data
[A3D_MAX_LENGTH
];
179 if (a3d_read_packet(a3d
->gameport
, a3d
->length
, data
) != a3d
->length
180 || data
[0] != a3d
->mode
|| a3d_csum(data
, a3d
->length
))
181 a3d
->bads
++; else a3d_read(a3d
, data
);
182 mod_timer(&a3d
->timer
, jiffies
+ A3D_REFRESH_TIME
);
186 * a3d_adc_cooked_read() copies the acis and button data to the
187 * callers arrays. It could do the read itself, but the caller could
188 * call this more than 50 times a second, which would use too much CPU.
191 int a3d_adc_cooked_read(struct gameport
*gameport
, int *axes
, int *buttons
)
193 struct a3d
*a3d
= gameport
->driver
;
195 for (i
= 0; i
< 4; i
++)
196 axes
[i
] = (a3d
->axes
[i
] < 254) ? a3d
->axes
[i
] : -1;
197 *buttons
= a3d
->buttons
;
202 * a3d_adc_open() is the gameport open routine. It refuses to serve
203 * any but cooked data.
206 int a3d_adc_open(struct gameport
*gameport
, int mode
)
208 struct a3d
*a3d
= gameport
->driver
;
209 if (mode
!= GAMEPORT_MODE_COOKED
)
212 mod_timer(&a3d
->timer
, jiffies
+ A3D_REFRESH_TIME
);
217 * a3d_adc_close() is a callback from the input close routine.
220 static void a3d_adc_close(struct gameport
*gameport
)
222 struct a3d
*a3d
= gameport
->driver
;
224 del_timer(&a3d
->timer
);
228 * a3d_open() is a callback from the input open routine.
231 static int a3d_open(struct input_dev
*dev
)
233 struct a3d
*a3d
= dev
->private;
235 mod_timer(&a3d
->timer
, jiffies
+ A3D_REFRESH_TIME
);
240 * a3d_close() is a callback from the input close routine.
243 static void a3d_close(struct input_dev
*dev
)
245 struct a3d
*a3d
= dev
->private;
247 del_timer(&a3d
->timer
);
251 * a3d_connect() probes for A3D joysticks.
254 static void a3d_connect(struct gameport
*gameport
, struct gameport_dev
*dev
)
257 unsigned char data
[A3D_MAX_LENGTH
];
260 if (!(a3d
= kmalloc(sizeof(struct a3d
), GFP_KERNEL
)))
262 memset(a3d
, 0, sizeof(struct a3d
));
264 gameport
->private = a3d
;
266 a3d
->gameport
= gameport
;
267 init_timer(&a3d
->timer
);
268 a3d
->timer
.data
= (long) a3d
;
269 a3d
->timer
.function
= a3d_timer
;
271 if (gameport_open(gameport
, dev
, GAMEPORT_MODE_RAW
))
274 i
= a3d_read_packet(gameport
, A3D_MAX_LENGTH
, data
);
276 if (!i
|| a3d_csum(data
, i
))
281 if (!a3d
->mode
|| a3d
->mode
> 5) {
282 printk(KERN_WARNING
"a3d.c: Unknown A3D device detected "
283 "(gameport%d, id=%d), contact <vojtech@suse.cz>\n", gameport
->number
, a3d
->mode
);
288 if (a3d
->mode
== A3D_MODE_PXL
) {
290 int axes
[] = { ABS_X
, ABS_Y
, ABS_THROTTLE
, ABS_RUDDER
};
294 a3d
->dev
.evbit
[0] |= BIT(EV_ABS
) | BIT(EV_KEY
) | BIT(EV_REL
);
295 a3d
->dev
.relbit
[0] |= BIT(REL_X
) | BIT(REL_Y
);
296 a3d
->dev
.absbit
[0] |= BIT(ABS_X
) | BIT(ABS_Y
) | BIT(ABS_THROTTLE
) | BIT(ABS_RUDDER
)
297 | BIT(ABS_HAT0X
) | BIT(ABS_HAT0Y
) | BIT(ABS_HAT1X
) | BIT(ABS_HAT1Y
);
299 a3d
->dev
.keybit
[LONG(BTN_MOUSE
)] |= BIT(BTN_RIGHT
) | BIT(BTN_LEFT
) | BIT(BTN_MIDDLE
)
300 | BIT(BTN_SIDE
) | BIT(BTN_EXTRA
);
302 a3d
->dev
.keybit
[LONG(BTN_JOYSTICK
)] |= BIT(BTN_TRIGGER
) | BIT(BTN_THUMB
) | BIT(BTN_TOP
) | BIT(BTN_PINKIE
);
306 for (i
= 0; i
< 4; i
++) {
308 a3d
->dev
.absmin
[axes
[i
]] = 48;
309 a3d
->dev
.absmax
[axes
[i
]] = a3d
->dev
.abs
[axes
[i
]] * 2 - 48;
310 a3d
->dev
.absflat
[axes
[i
]] = 8;
312 a3d
->dev
.absmin
[axes
[i
]] = 2;
313 a3d
->dev
.absmax
[axes
[i
]] = 253;
315 a3d
->dev
.absmin
[ABS_HAT0X
+ i
] = -1;
316 a3d
->dev
.absmax
[ABS_HAT0X
+ i
] = 1;
322 a3d
->dev
.evbit
[0] |= BIT(EV_KEY
) | BIT(EV_REL
);
323 a3d
->dev
.relbit
[0] |= BIT(REL_X
) | BIT(REL_Y
);
324 a3d
->dev
.keybit
[LONG(BTN_MOUSE
)] |= BIT(BTN_RIGHT
) | BIT(BTN_LEFT
) | BIT(BTN_MIDDLE
);
326 a3d
->adc
.driver
= a3d
;
327 a3d
->adc
.open
= a3d_adc_open
;
328 a3d
->adc
.close
= a3d_adc_close
;
329 a3d
->adc
.cooked_read
= a3d_adc_cooked_read
;
331 a3d
->adc
.type
= GAMEPORT_EXT
;
335 gameport_register_port(&a3d
->adc
);
336 printk(KERN_INFO
"gameport%d: %s on gameport%d.0\n",
337 a3d
->adc
.number
, a3d_names
[a3d
->mode
], gameport
->number
);
340 a3d
->dev
.private = a3d
;
341 a3d
->dev
.open
= a3d_open
;
342 a3d
->dev
.close
= a3d_close
;
344 a3d
->dev
.name
= a3d_names
[a3d
->mode
];
345 a3d
->dev
.idbus
= BUS_GAMEPORT
;
346 a3d
->dev
.idvendor
= GAMEPORT_ID_VENDOR_MADCATZ
;
347 a3d
->dev
.idproduct
= a3d
->mode
;
348 a3d
->dev
.idversion
= 0x0100;
350 input_register_device(&a3d
->dev
);
351 printk(KERN_INFO
"input%d: %s on gameport%d.0\n",
352 a3d
->dev
.number
, a3d_names
[a3d
->mode
], gameport
->number
);
355 fail2
: gameport_close(gameport
);
359 static void a3d_disconnect(struct gameport
*gameport
)
362 struct a3d
*a3d
= gameport
->private;
363 input_unregister_device(&a3d
->dev
);
364 if (a3d
->mode
< A3D_MODE_PXL
)
365 gameport_unregister_port(&a3d
->adc
);
366 gameport_close(gameport
);
370 static struct gameport_dev a3d_dev
= {
371 connect
: a3d_connect
,
372 disconnect
: a3d_disconnect
,
375 int __init
a3d_init(void)
377 gameport_register_device(&a3d_dev
);
381 void __exit
a3d_exit(void)
383 gameport_unregister_device(&a3d_dev
);
386 module_init(a3d_init
);
387 module_exit(a3d_exit
);