Merge with /pub/scm/linux/kernel/git/torvalds/linux-2.6.git
[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
41 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
42 MODULE_DESCRIPTION("TurboGraFX parallel port interface driver");
43 MODULE_LICENSE("GPL");
44
45 #define TGFX_MAX_PORTS          3
46 #define TGFX_MAX_DEVICES        7
47
48 struct tgfx_config {
49         int args[TGFX_MAX_DEVICES + 1];
50         int nargs;
51 };
52
53 static struct tgfx_config tgfx[TGFX_MAX_PORTS] __initdata;
54
55 module_param_array_named(map, tgfx[0].args, int, &tgfx[0].nargs, 0);
56 MODULE_PARM_DESC(map, "Describes first set of devices (<parport#>,<js1>,<js2>,..<js7>");
57 module_param_array_named(map2, tgfx[1].args, int, &tgfx[1].nargs, 0);
58 MODULE_PARM_DESC(map2, "Describes second set of devices");
59 module_param_array_named(map3, tgfx[2].args, int, &tgfx[2].nargs, 0);
60 MODULE_PARM_DESC(map3, "Describes third set of devices");
61
62 __obsolete_setup("tgfx=");
63 __obsolete_setup("tgfx_2=");
64 __obsolete_setup("tgfx_3=");
65
66 #define TGFX_REFRESH_TIME       HZ/100  /* 10 ms */
67
68 #define TGFX_TRIGGER            0x08
69 #define TGFX_UP                 0x10
70 #define TGFX_DOWN               0x20
71 #define TGFX_LEFT               0x40
72 #define TGFX_RIGHT              0x80
73
74 #define TGFX_THUMB              0x02
75 #define TGFX_THUMB2             0x04
76 #define TGFX_TOP                0x01
77 #define TGFX_TOP2               0x08
78
79 static int tgfx_buttons[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2 };
80
81 static struct tgfx {
82         struct pardevice *pd;
83         struct timer_list timer;
84         struct input_dev *dev[TGFX_MAX_DEVICES];
85         char name[TGFX_MAX_DEVICES][64];
86         char phys[TGFX_MAX_DEVICES][32];
87         int sticks;
88         int used;
89         struct semaphore sem;
90 } *tgfx_base[TGFX_MAX_PORTS];
91
92 /*
93  * tgfx_timer() reads and analyzes TurboGraFX joystick data.
94  */
95
96 static void tgfx_timer(unsigned long private)
97 {
98         struct tgfx *tgfx = (void *) private;
99         struct input_dev *dev;
100         int data1, data2, i;
101
102         for (i = 0; i < 7; i++)
103                 if (tgfx->sticks & (1 << i)) {
104
105                         dev = tgfx->dev[i];
106
107                         parport_write_data(tgfx->pd->port, ~(1 << i));
108                         data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
109                         data2 = parport_read_control(tgfx->pd->port) ^ 0x04;    /* CAVEAT parport */
110
111                         input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
112                         input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
113
114                         input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
115                         input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
116                         input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
117                         input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
118                         input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
119
120                         input_sync(dev);
121                 }
122
123         mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
124 }
125
126 static int tgfx_open(struct input_dev *dev)
127 {
128         struct tgfx *tgfx = dev->private;
129         int err;
130
131         err = down_interruptible(&tgfx->sem);
132         if (err)
133                 return err;
134
135         if (!tgfx->used++) {
136                 parport_claim(tgfx->pd);
137                 parport_write_control(tgfx->pd->port, 0x04);
138                 mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
139         }
140
141         up(&tgfx->sem);
142         return 0;
143 }
144
145 static void tgfx_close(struct input_dev *dev)
146 {
147         struct tgfx *tgfx = dev->private;
148
149         down(&tgfx->sem);
150         if (!--tgfx->used) {
151                 del_timer_sync(&tgfx->timer);
152                 parport_write_control(tgfx->pd->port, 0x00);
153                 parport_release(tgfx->pd);
154         }
155         up(&tgfx->sem);
156 }
157
158
159
160 /*
161  * tgfx_probe() probes for tg gamepads.
162  */
163
164 static struct tgfx __init *tgfx_probe(int parport, int *n_buttons, int n_devs)
165 {
166         struct tgfx *tgfx;
167         struct input_dev *input_dev;
168         struct parport *pp;
169         struct pardevice *pd;
170         int i, j;
171         int err;
172
173         pp = parport_find_number(parport);
174         if (!pp) {
175                 printk(KERN_ERR "turbografx.c: no such parport\n");
176                 err = -EINVAL;
177                 goto err_out;
178         }
179
180         pd = parport_register_device(pp, "turbografx", NULL, NULL, NULL, PARPORT_DEV_EXCL, NULL);
181         if (!pd) {
182                 printk(KERN_ERR "turbografx.c: parport busy already - lp.o loaded?\n");
183                 err = -EBUSY;
184                 goto err_put_pp;
185         }
186
187         tgfx = kzalloc(sizeof(struct tgfx), GFP_KERNEL);
188         if (!tgfx) {
189                 printk(KERN_ERR "turbografx.c: Not enough memory\n");
190                 err = -ENOMEM;
191                 goto err_unreg_pardev;
192         }
193
194         init_MUTEX(&tgfx->sem);
195         tgfx->pd = pd;
196         init_timer(&tgfx->timer);
197         tgfx->timer.data = (long) tgfx;
198         tgfx->timer.function = tgfx_timer;
199
200         for (i = 0; i < n_devs; i++) {
201                 if (n_buttons[i] < 1)
202                         continue;
203
204                 if (n_buttons[i] > 6) {
205                         printk(KERN_ERR "turbografx.c: Invalid number of buttons %d\n", n_buttons[i]);
206                         err = -EINVAL;
207                         goto err_free_devs;
208                 }
209
210                 tgfx->dev[i] = input_dev = input_allocate_device();
211                 if (!input_dev) {
212                         printk(KERN_ERR "turbografx.c: Not enough memory for input device\n");
213                         err = -ENOMEM;
214                         goto err_free_devs;
215                 }
216
217                 tgfx->sticks |= (1 << i);
218                 snprintf(tgfx->name[i], sizeof(tgfx->name[i]),
219                          "TurboGraFX %d-button Multisystem joystick", n_buttons[i]);
220                 snprintf(tgfx->phys[i], sizeof(tgfx->phys[i]),
221                          "%s/input%d", tgfx->pd->port->name, i);
222
223                 input_dev->name = tgfx->name[i];
224                 input_dev->phys = tgfx->phys[i];
225                 input_dev->id.bustype = BUS_PARPORT;
226                 input_dev->id.vendor = 0x0003;
227                 input_dev->id.product = n_buttons[i];
228                 input_dev->id.version = 0x0100;
229
230                 input_dev->private = tgfx;
231                 input_dev->open = tgfx_open;
232                 input_dev->close = tgfx_close;
233
234                 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
235                 input_set_abs_params(input_dev, ABS_X, -1, 1, 0, 0);
236                 input_set_abs_params(input_dev, ABS_Y, -1, 1, 0, 0);
237
238                 for (j = 0; j < n_buttons[i]; j++)
239                         set_bit(tgfx_buttons[j], input_dev->keybit);
240
241                 input_register_device(tgfx->dev[i]);
242         }
243
244         if (!tgfx->sticks) {
245                 printk(KERN_ERR "turbografx.c: No valid devices specified\n");
246                 err = -EINVAL;
247                 goto err_free_tgfx;
248         }
249
250         return tgfx;
251
252  err_free_devs:
253         while (--i >= 0)
254                 input_unregister_device(tgfx->dev[i]);
255  err_free_tgfx:
256         kfree(tgfx);
257  err_unreg_pardev:
258         parport_unregister_device(pd);
259  err_put_pp:
260         parport_put_port(pp);
261  err_out:
262         return ERR_PTR(err);
263 }
264
265 static void __exit tgfx_remove(struct tgfx *tgfx)
266 {
267         int i;
268
269         for (i = 0; i < TGFX_MAX_DEVICES; i++)
270                 if (tgfx->dev[i])
271                         input_unregister_device(tgfx->dev[i]);
272         parport_unregister_device(tgfx->pd);
273         kfree(tgfx);
274 }
275
276 static int __init tgfx_init(void)
277 {
278         int i;
279         int have_dev = 0;
280         int err = 0;
281
282         for (i = 0; i < TGFX_MAX_PORTS; i++) {
283                 if (tgfx[i].nargs == 0 || tgfx[i].args[0] < 0)
284                         continue;
285
286                 if (tgfx[i].nargs < 2) {
287                         printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
288                         err = -EINVAL;
289                         break;
290                 }
291
292                 tgfx_base[i] = tgfx_probe(tgfx[i].args[0], tgfx[i].args + 1, tgfx[i].nargs - 1);
293                 if (IS_ERR(tgfx_base[i])) {
294                         err = PTR_ERR(tgfx_base[i]);
295                         break;
296                 }
297
298                 have_dev = 1;
299         }
300
301         if (err) {
302                 while (--i >= 0)
303                         tgfx_remove(tgfx_base[i]);
304                 return err;
305         }
306
307         return have_dev ? 0 : -ENODEV;
308 }
309
310 static void __exit tgfx_exit(void)
311 {
312         int i;
313
314         for (i = 0; i < TGFX_MAX_PORTS; i++)
315                 if (tgfx_base[i])
316                         tgfx_remove(tgfx_base[i]);
317 }
318
319 module_init(tgfx_init);
320 module_exit(tgfx_exit);