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