Pull bugzilla-5653 into release branch
[linux-2.6] / drivers / input / joystick / turbografx.c
1 /*
2  * $Id: turbografx.c,v 1.14 2002/01/22 20:30:39 vojtech Exp $
3  *
4  *  Copyright (c) 1998-2001 Vojtech Pavlik
5  *
6  *  Based on the work of:
7  *      Steffen Schwenke
8  */
9
10 /*
11  * TurboGraFX parallel port interface driver for Linux.
12  */
13
14 /*
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28  *
29  * Should you need to contact me, the author, you can do so either by
30  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
31  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
32  */
33
34 #include <linux/kernel.h>
35 #include <linux/parport.h>
36 #include <linux/input.h>
37 #include <linux/module.h>
38 #include <linux/moduleparam.h>
39 #include <linux/init.h>
40 #include <linux/mutex.h>
41
42 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
43 MODULE_DESCRIPTION("TurboGraFX parallel port interface driver");
44 MODULE_LICENSE("GPL");
45
46 #define TGFX_MAX_PORTS          3
47 #define TGFX_MAX_DEVICES        7
48
49 struct tgfx_config {
50         int args[TGFX_MAX_DEVICES + 1];
51         int nargs;
52 };
53
54 static struct tgfx_config tgfx[TGFX_MAX_PORTS] __initdata;
55
56 module_param_array_named(map, tgfx[0].args, int, &tgfx[0].nargs, 0);
57 MODULE_PARM_DESC(map, "Describes first set of devices (<parport#>,<js1>,<js2>,..<js7>");
58 module_param_array_named(map2, tgfx[1].args, int, &tgfx[1].nargs, 0);
59 MODULE_PARM_DESC(map2, "Describes second set of devices");
60 module_param_array_named(map3, tgfx[2].args, int, &tgfx[2].nargs, 0);
61 MODULE_PARM_DESC(map3, "Describes third set of devices");
62
63 __obsolete_setup("tgfx=");
64 __obsolete_setup("tgfx_2=");
65 __obsolete_setup("tgfx_3=");
66
67 #define TGFX_REFRESH_TIME       HZ/100  /* 10 ms */
68
69 #define TGFX_TRIGGER            0x08
70 #define TGFX_UP                 0x10
71 #define TGFX_DOWN               0x20
72 #define TGFX_LEFT               0x40
73 #define TGFX_RIGHT              0x80
74
75 #define TGFX_THUMB              0x02
76 #define TGFX_THUMB2             0x04
77 #define TGFX_TOP                0x01
78 #define TGFX_TOP2               0x08
79
80 static int tgfx_buttons[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2 };
81
82 static struct tgfx {
83         struct pardevice *pd;
84         struct timer_list timer;
85         struct input_dev *dev[TGFX_MAX_DEVICES];
86         char name[TGFX_MAX_DEVICES][64];
87         char phys[TGFX_MAX_DEVICES][32];
88         int sticks;
89         int used;
90         struct mutex sem;
91 } *tgfx_base[TGFX_MAX_PORTS];
92
93 /*
94  * tgfx_timer() reads and analyzes TurboGraFX joystick data.
95  */
96
97 static void tgfx_timer(unsigned long private)
98 {
99         struct tgfx *tgfx = (void *) private;
100         struct input_dev *dev;
101         int data1, data2, i;
102
103         for (i = 0; i < 7; i++)
104                 if (tgfx->sticks & (1 << i)) {
105
106                         dev = tgfx->dev[i];
107
108                         parport_write_data(tgfx->pd->port, ~(1 << i));
109                         data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
110                         data2 = parport_read_control(tgfx->pd->port) ^ 0x04;    /* CAVEAT parport */
111
112                         input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
113                         input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
114
115                         input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
116                         input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
117                         input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
118                         input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
119                         input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
120
121                         input_sync(dev);
122                 }
123
124         mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
125 }
126
127 static int tgfx_open(struct input_dev *dev)
128 {
129         struct tgfx *tgfx = dev->private;
130         int err;
131
132         err = mutex_lock_interruptible(&tgfx->sem);
133         if (err)
134                 return err;
135
136         if (!tgfx->used++) {
137                 parport_claim(tgfx->pd);
138                 parport_write_control(tgfx->pd->port, 0x04);
139                 mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
140         }
141
142         mutex_unlock(&tgfx->sem);
143         return 0;
144 }
145
146 static void tgfx_close(struct input_dev *dev)
147 {
148         struct tgfx *tgfx = dev->private;
149
150         mutex_lock(&tgfx->sem);
151         if (!--tgfx->used) {
152                 del_timer_sync(&tgfx->timer);
153                 parport_write_control(tgfx->pd->port, 0x00);
154                 parport_release(tgfx->pd);
155         }
156         mutex_unlock(&tgfx->sem);
157 }
158
159
160
161 /*
162  * tgfx_probe() probes for tg gamepads.
163  */
164
165 static struct tgfx __init *tgfx_probe(int parport, int *n_buttons, int n_devs)
166 {
167         struct tgfx *tgfx;
168         struct input_dev *input_dev;
169         struct parport *pp;
170         struct pardevice *pd;
171         int i, j;
172         int err;
173
174         pp = parport_find_number(parport);
175         if (!pp) {
176                 printk(KERN_ERR "turbografx.c: no such parport\n");
177                 err = -EINVAL;
178                 goto err_out;
179         }
180
181         pd = parport_register_device(pp, "turbografx", NULL, NULL, NULL, PARPORT_DEV_EXCL, NULL);
182         if (!pd) {
183                 printk(KERN_ERR "turbografx.c: parport busy already - lp.o loaded?\n");
184                 err = -EBUSY;
185                 goto err_put_pp;
186         }
187
188         tgfx = kzalloc(sizeof(struct tgfx), GFP_KERNEL);
189         if (!tgfx) {
190                 printk(KERN_ERR "turbografx.c: Not enough memory\n");
191                 err = -ENOMEM;
192                 goto err_unreg_pardev;
193         }
194
195         mutex_init(&tgfx->sem);
196         tgfx->pd = pd;
197         init_timer(&tgfx->timer);
198         tgfx->timer.data = (long) tgfx;
199         tgfx->timer.function = tgfx_timer;
200
201         for (i = 0; i < n_devs; i++) {
202                 if (n_buttons[i] < 1)
203                         continue;
204
205                 if (n_buttons[i] > 6) {
206                         printk(KERN_ERR "turbografx.c: Invalid number of buttons %d\n", n_buttons[i]);
207                         err = -EINVAL;
208                         goto err_unreg_devs;
209                 }
210
211                 tgfx->dev[i] = input_dev = input_allocate_device();
212                 if (!input_dev) {
213                         printk(KERN_ERR "turbografx.c: Not enough memory for input device\n");
214                         err = -ENOMEM;
215                         goto err_unreg_devs;
216                 }
217
218                 tgfx->sticks |= (1 << i);
219                 snprintf(tgfx->name[i], sizeof(tgfx->name[i]),
220                          "TurboGraFX %d-button Multisystem joystick", n_buttons[i]);
221                 snprintf(tgfx->phys[i], sizeof(tgfx->phys[i]),
222                          "%s/input%d", tgfx->pd->port->name, i);
223
224                 input_dev->name = tgfx->name[i];
225                 input_dev->phys = tgfx->phys[i];
226                 input_dev->id.bustype = BUS_PARPORT;
227                 input_dev->id.vendor = 0x0003;
228                 input_dev->id.product = n_buttons[i];
229                 input_dev->id.version = 0x0100;
230
231                 input_dev->private = tgfx;
232                 input_dev->open = tgfx_open;
233                 input_dev->close = tgfx_close;
234
235                 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
236                 input_set_abs_params(input_dev, ABS_X, -1, 1, 0, 0);
237                 input_set_abs_params(input_dev, ABS_Y, -1, 1, 0, 0);
238
239                 for (j = 0; j < n_buttons[i]; j++)
240                         set_bit(tgfx_buttons[j], input_dev->keybit);
241
242                 err = input_register_device(tgfx->dev[i]);
243                 if (err)
244                         goto err_free_dev;
245         }
246
247         if (!tgfx->sticks) {
248                 printk(KERN_ERR "turbografx.c: No valid devices specified\n");
249                 err = -EINVAL;
250                 goto err_free_tgfx;
251         }
252
253         return tgfx;
254
255  err_free_dev:
256         input_free_device(tgfx->dev[i]);
257  err_unreg_devs:
258         while (--i >= 0)
259                 if (tgfx->dev[i])
260                         input_unregister_device(tgfx->dev[i]);
261  err_free_tgfx:
262         kfree(tgfx);
263  err_unreg_pardev:
264         parport_unregister_device(pd);
265  err_put_pp:
266         parport_put_port(pp);
267  err_out:
268         return ERR_PTR(err);
269 }
270
271 static void tgfx_remove(struct tgfx *tgfx)
272 {
273         int i;
274
275         for (i = 0; i < TGFX_MAX_DEVICES; i++)
276                 if (tgfx->dev[i])
277                         input_unregister_device(tgfx->dev[i]);
278         parport_unregister_device(tgfx->pd);
279         kfree(tgfx);
280 }
281
282 static int __init tgfx_init(void)
283 {
284         int i;
285         int have_dev = 0;
286         int err = 0;
287
288         for (i = 0; i < TGFX_MAX_PORTS; i++) {
289                 if (tgfx[i].nargs == 0 || tgfx[i].args[0] < 0)
290                         continue;
291
292                 if (tgfx[i].nargs < 2) {
293                         printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
294                         err = -EINVAL;
295                         break;
296                 }
297
298                 tgfx_base[i] = tgfx_probe(tgfx[i].args[0], tgfx[i].args + 1, tgfx[i].nargs - 1);
299                 if (IS_ERR(tgfx_base[i])) {
300                         err = PTR_ERR(tgfx_base[i]);
301                         break;
302                 }
303
304                 have_dev = 1;
305         }
306
307         if (err) {
308                 while (--i >= 0)
309                         if (tgfx_base[i])
310                                 tgfx_remove(tgfx_base[i]);
311                 return err;
312         }
313
314         return have_dev ? 0 : -ENODEV;
315 }
316
317 static void __exit tgfx_exit(void)
318 {
319         int i;
320
321         for (i = 0; i < TGFX_MAX_PORTS; i++)
322                 if (tgfx_base[i])
323                         tgfx_remove(tgfx_base[i]);
324 }
325
326 module_init(tgfx_init);
327 module_exit(tgfx_exit);