2 * $Id: grip.c,v 1.21 2002/01/22 20:27:57 vojtech Exp $
4 * Copyright (c) 1998-2001 Vojtech Pavlik
8 * Gravis/Kensington GrIP protocol 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/kernel.h>
32 #include <linux/module.h>
33 #include <linux/init.h>
34 #include <linux/slab.h>
35 #include <linux/gameport.h>
36 #include <linux/input.h>
37 #include <linux/jiffies.h>
39 #define DRIVER_DESC "Gravis GrIP protocol joystick driver"
41 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
42 MODULE_DESCRIPTION(DRIVER_DESC);
43 MODULE_LICENSE("GPL");
45 #define GRIP_MODE_GPP 1
46 #define GRIP_MODE_BD 2
47 #define GRIP_MODE_XT 3
48 #define GRIP_MODE_DC 4
50 #define GRIP_LENGTH_GPP 24
51 #define GRIP_STROBE_GPP 200 /* 200 us */
52 #define GRIP_LENGTH_XT 4
53 #define GRIP_STROBE_XT 64 /* 64 us */
54 #define GRIP_MAX_CHUNKS_XT 10
55 #define GRIP_MAX_BITS_XT 30
58 struct gameport *gameport;
59 struct input_dev *dev[2];
60 unsigned char mode[2];
66 static int grip_btn_gpp[] = { BTN_START, BTN_SELECT, BTN_TR2, BTN_Y, 0, BTN_TL2, BTN_A, BTN_B, BTN_X, 0, BTN_TL, BTN_TR, -1 };
67 static int grip_btn_bd[] = { BTN_THUMB, BTN_THUMB2, BTN_TRIGGER, BTN_TOP, BTN_BASE, -1 };
68 static int grip_btn_xt[] = { BTN_TRIGGER, BTN_THUMB, BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_SELECT, BTN_START, BTN_MODE, -1 };
69 static int grip_btn_dc[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, -1 };
71 static int grip_abs_gpp[] = { ABS_X, ABS_Y, -1 };
72 static int grip_abs_bd[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
73 static int grip_abs_xt[] = { ABS_X, ABS_Y, ABS_BRAKE, ABS_GAS, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, -1 };
74 static int grip_abs_dc[] = { ABS_X, ABS_Y, ABS_RX, ABS_RY, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
76 static char *grip_name[] = { NULL, "Gravis GamePad Pro", "Gravis Blackhawk Digital",
77 "Gravis Xterminator Digital", "Gravis Xterminator DualControl" };
78 static int *grip_abs[] = { NULL, grip_abs_gpp, grip_abs_bd, grip_abs_xt, grip_abs_dc };
79 static int *grip_btn[] = { NULL, grip_btn_gpp, grip_btn_bd, grip_btn_xt, grip_btn_dc };
80 static char grip_anx[] = { 0, 0, 3, 5, 5 };
81 static char grip_cen[] = { 0, 0, 2, 2, 4 };
84 * grip_gpp_read_packet() reads a Gravis GamePad Pro packet.
87 static int grip_gpp_read_packet(struct gameport *gameport, int shift, unsigned int *data)
94 int strobe = gameport_time(gameport, GRIP_STROBE_GPP);
100 local_irq_save(flags);
102 v = gameport_read(gameport) >> shift;
106 u = v; v = (gameport_read(gameport) >> shift) & 3;
108 data[0] |= (v >> 1) << i++;
111 } while (i < GRIP_LENGTH_GPP && t > 0);
113 local_irq_restore(flags);
115 if (i < GRIP_LENGTH_GPP) return -1;
117 for (i = 0; i < GRIP_LENGTH_GPP && (data[0] & 0xfe4210) ^ 0x7c0000; i++)
118 data[0] = data[0] >> 1 | (data[0] & 1) << (GRIP_LENGTH_GPP - 1);
120 return -(i == GRIP_LENGTH_GPP);
124 * grip_xt_read_packet() reads a Gravis Xterminator packet.
127 static int grip_xt_read_packet(struct gameport *gameport, int shift, unsigned int *data)
129 unsigned int i, j, buf, crc;
130 unsigned char u, v, w;
135 int strobe = gameport_time(gameport, GRIP_STROBE_XT);
137 data[0] = data[1] = data[2] = data[3] = 0;
138 status = buf = i = j = 0;
141 local_irq_save(flags);
143 v = w = (gameport_read(gameport) >> shift) & 3;
147 u = (gameport_read(gameport) >> shift) & 3;
152 buf = (buf << 1) | (u >> 1);
157 if ((((u ^ v) & (v ^ w)) >> 1) & ~(u | v | w) & 1) {
159 crc = buf ^ (buf >> 7) ^ (buf >> 14);
160 if (!((crc ^ (0x25cb9e70 >> ((crc >> 2) & 0x1c))) & 0xf)) {
161 data[buf >> 18] = buf >> 4;
162 status |= 1 << (buf >> 18);
174 } while (status != 0xf && i < GRIP_MAX_BITS_XT && j < GRIP_MAX_CHUNKS_XT && t > 0);
176 local_irq_restore(flags);
178 return -(status != 0xf);
182 * grip_timer() repeatedly polls the joysticks and generates events.
185 static void grip_poll(struct gameport *gameport)
187 struct grip *grip = gameport_get_drvdata(gameport);
188 unsigned int data[GRIP_LENGTH_XT];
189 struct input_dev *dev;
192 for (i = 0; i < 2; i++) {
197 switch (grip->mode[i]) {
201 if (grip_gpp_read_packet(grip->gameport, (i << 1) + 4, data)) {
206 input_report_abs(dev, ABS_X, ((*data >> 15) & 1) - ((*data >> 16) & 1));
207 input_report_abs(dev, ABS_Y, ((*data >> 13) & 1) - ((*data >> 12) & 1));
209 for (j = 0; j < 12; j++)
211 input_report_key(dev, grip_btn_gpp[j], (*data >> j) & 1);
217 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
222 input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
223 input_report_abs(dev, ABS_Y, 63 - ((data[0] >> 8) & 0x3f));
224 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
226 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
227 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
229 for (j = 0; j < 5; j++)
230 input_report_key(dev, grip_btn_bd[j], (data[3] >> (j + 4)) & 1);
236 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
241 input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
242 input_report_abs(dev, ABS_Y, 63 - ((data[0] >> 8) & 0x3f));
243 input_report_abs(dev, ABS_BRAKE, (data[1] >> 2) & 0x3f);
244 input_report_abs(dev, ABS_GAS, (data[1] >> 8) & 0x3f);
245 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
247 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
248 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
249 input_report_abs(dev, ABS_HAT1X, ((data[2] >> 5) & 1) - ((data[2] >> 4) & 1));
250 input_report_abs(dev, ABS_HAT1Y, ((data[2] >> 6) & 1) - ((data[2] >> 7) & 1));
252 for (j = 0; j < 11; j++)
253 input_report_key(dev, grip_btn_xt[j], (data[3] >> (j + 3)) & 1);
258 if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
263 input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
264 input_report_abs(dev, ABS_Y, (data[0] >> 8) & 0x3f);
265 input_report_abs(dev, ABS_RX, (data[1] >> 2) & 0x3f);
266 input_report_abs(dev, ABS_RY, (data[1] >> 8) & 0x3f);
267 input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
269 input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
270 input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
272 for (j = 0; j < 9; j++)
273 input_report_key(dev, grip_btn_dc[j], (data[3] >> (j + 3)) & 1);
283 static int grip_open(struct input_dev *dev)
285 struct grip *grip = dev->private;
287 gameport_start_polling(grip->gameport);
291 static void grip_close(struct input_dev *dev)
293 struct grip *grip = dev->private;
295 gameport_stop_polling(grip->gameport);
298 static int grip_connect(struct gameport *gameport, struct gameport_driver *drv)
301 struct input_dev *input_dev;
302 unsigned int data[GRIP_LENGTH_XT];
306 if (!(grip = kzalloc(sizeof(struct grip), GFP_KERNEL)))
309 grip->gameport = gameport;
311 gameport_set_drvdata(gameport, grip);
313 err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
317 for (i = 0; i < 2; i++) {
318 if (!grip_gpp_read_packet(gameport, (i << 1) + 4, data)) {
319 grip->mode[i] = GRIP_MODE_GPP;
322 if (!grip_xt_read_packet(gameport, (i << 1) + 4, data)) {
323 if (!(data[3] & 7)) {
324 grip->mode[i] = GRIP_MODE_BD;
327 if (!(data[2] & 0xf0)) {
328 grip->mode[i] = GRIP_MODE_XT;
331 grip->mode[i] = GRIP_MODE_DC;
336 if (!grip->mode[0] && !grip->mode[1]) {
341 gameport_set_poll_handler(gameport, grip_poll);
342 gameport_set_poll_interval(gameport, 20);
344 for (i = 0; i < 2; i++) {
348 grip->dev[i] = input_dev = input_allocate_device();
354 sprintf(grip->phys[i], "%s/input%d", gameport->phys, i);
356 input_dev->name = grip_name[grip->mode[i]];
357 input_dev->phys = grip->phys[i];
358 input_dev->id.bustype = BUS_GAMEPORT;
359 input_dev->id.vendor = GAMEPORT_ID_VENDOR_GRAVIS;
360 input_dev->id.product = grip->mode[i];
361 input_dev->id.version = 0x0100;
362 input_dev->cdev.dev = &gameport->dev;
363 input_dev->private = grip;
365 input_dev->open = grip_open;
366 input_dev->close = grip_close;
368 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
370 for (j = 0; (t = grip_abs[grip->mode[i]][j]) >= 0; j++) {
372 if (j < grip_cen[grip->mode[i]])
373 input_set_abs_params(input_dev, t, 14, 52, 1, 2);
374 else if (j < grip_anx[grip->mode[i]])
375 input_set_abs_params(input_dev, t, 3, 57, 1, 0);
377 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
380 for (j = 0; (t = grip_btn[grip->mode[i]][j]) >= 0; j++)
382 set_bit(t, input_dev->keybit);
384 input_register_device(grip->dev[i]);
389 fail3: for (i = 0; i < 2; i++)
391 input_unregister_device(grip->dev[i]);
392 fail2: gameport_close(gameport);
393 fail1: gameport_set_drvdata(gameport, NULL);
398 static void grip_disconnect(struct gameport *gameport)
400 struct grip *grip = gameport_get_drvdata(gameport);
403 for (i = 0; i < 2; i++)
405 input_unregister_device(grip->dev[i]);
406 gameport_close(gameport);
407 gameport_set_drvdata(gameport, NULL);
411 static struct gameport_driver grip_drv = {
415 .description = DRIVER_DESC,
416 .connect = grip_connect,
417 .disconnect = grip_disconnect,
420 static int __init grip_init(void)
422 gameport_register_driver(&grip_drv);
426 static void __exit grip_exit(void)
428 gameport_unregister_driver(&grip_drv);
431 module_init(grip_init);
432 module_exit(grip_exit);