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 static int tgfx[] __initdata = { -1, 0, 0, 0, 0, 0, 0, 0 };
46 static int tgfx_nargs __initdata = 0;
47 module_param_array_named(map, tgfx, int, &tgfx_nargs, 0);
48 MODULE_PARM_DESC(map, "Describes first set of devices (<parport#>,<js1>,<js2>,..<js7>");
49 
50 static int tgfx_2[] __initdata = { -1, 0, 0, 0, 0, 0, 0, 0 };
51 static int tgfx_nargs_2 __initdata = 0;
52 module_param_array_named(map2, tgfx_2, int, &tgfx_nargs_2, 0);
53 MODULE_PARM_DESC(map2, "Describes second set of devices");
54 
55 static int tgfx_3[] __initdata = { -1, 0, 0, 0, 0, 0, 0, 0 };
56 static int tgfx_nargs_3 __initdata = 0;
57 module_param_array_named(map3, tgfx_3, int, &tgfx_nargs_3, 0);
58 MODULE_PARM_DESC(map3, "Describes third set of devices");
59 
60 __obsolete_setup("tgfx=");
61 __obsolete_setup("tgfx_2=");
62 __obsolete_setup("tgfx_3=");
63 
64 #define TGFX_REFRESH_TIME	HZ/100	/* 10 ms */
65 
66 #define TGFX_TRIGGER		0x08
67 #define TGFX_UP			0x10
68 #define TGFX_DOWN		0x20
69 #define TGFX_LEFT		0x40
70 #define TGFX_RIGHT		0x80
71 
72 #define TGFX_THUMB		0x02
73 #define TGFX_THUMB2		0x04
74 #define TGFX_TOP		0x01
75 #define TGFX_TOP2		0x08
76 
77 static int tgfx_buttons[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2 };
78 static char *tgfx_name = "TurboGraFX Multisystem joystick";
79 
80 static struct tgfx {
81 	struct pardevice *pd;
82 	struct timer_list timer;
83 	struct input_dev dev[7];
84 	char phys[7][32];
85 	int sticks;
86 	int used;
87 	struct semaphore sem;
88 } *tgfx_base[3];
89 
90 /*
91  * tgfx_timer() reads and analyzes TurboGraFX joystick data.
92  */
93 
94 static void tgfx_timer(unsigned long private)
95 {
96 	struct tgfx *tgfx = (void *) private;
97 	struct input_dev *dev;
98 	int data1, data2, i;
99 
100 	for (i = 0; i < 7; i++)
101 		if (tgfx->sticks & (1 << i)) {
102 
103 			dev = tgfx->dev + i;
104 
105 			parport_write_data(tgfx->pd->port, ~(1 << i));
106 			data1 = parport_read_status(tgfx->pd->port) ^ 0x7f;
107 			data2 = parport_read_control(tgfx->pd->port) ^ 0x04;	/* CAVEAT parport */
108 
109 			input_report_abs(dev, ABS_X, !!(data1 & TGFX_RIGHT) - !!(data1 & TGFX_LEFT));
110 			input_report_abs(dev, ABS_Y, !!(data1 & TGFX_DOWN ) - !!(data1 & TGFX_UP  ));
111 
112 			input_report_key(dev, BTN_TRIGGER, (data1 & TGFX_TRIGGER));
113 			input_report_key(dev, BTN_THUMB,   (data2 & TGFX_THUMB  ));
114 			input_report_key(dev, BTN_THUMB2,  (data2 & TGFX_THUMB2 ));
115 			input_report_key(dev, BTN_TOP,     (data2 & TGFX_TOP    ));
116 			input_report_key(dev, BTN_TOP2,    (data2 & TGFX_TOP2   ));
117 
118 			input_sync(dev);
119 		}
120 
121 	mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
122 }
123 
124 static int tgfx_open(struct input_dev *dev)
125 {
126 	struct tgfx *tgfx = dev->private;
127 	int err;
128 
129 	err = down_interruptible(&tgfx->sem);
130 	if (err)
131 		return err;
132 
133 	if (!tgfx->used++) {
134 		parport_claim(tgfx->pd);
135 		parport_write_control(tgfx->pd->port, 0x04);
136 		mod_timer(&tgfx->timer, jiffies + TGFX_REFRESH_TIME);
137 	}
138 
139 	up(&tgfx->sem);
140 	return 0;
141 }
142 
143 static void tgfx_close(struct input_dev *dev)
144 {
145 	struct tgfx *tgfx = dev->private;
146 
147 	down(&tgfx->sem);
148 	if (!--tgfx->used) {
149 		del_timer_sync(&tgfx->timer);
150 		parport_write_control(tgfx->pd->port, 0x00);
151 		parport_release(tgfx->pd);
152 	}
153 	up(&tgfx->sem);
154 }
155 
156 /*
157  * tgfx_probe() probes for tg gamepads.
158  */
159 
160 static struct tgfx __init *tgfx_probe(int *config, int nargs)
161 {
162 	struct tgfx *tgfx;
163 	struct parport *pp;
164 	int i, j;
165 
166 	if (config[0] < 0)
167 		return NULL;
168 
169 	if (nargs < 2) {
170 		printk(KERN_ERR "turbografx.c: at least one joystick must be specified\n");
171 		return NULL;
172 	}
173 
174 	pp = parport_find_number(config[0]);
175 
176 	if (!pp) {
177 		printk(KERN_ERR "turbografx.c: no such parport\n");
178 		return NULL;
179 	}
180 
181 	if (!(tgfx = kcalloc(1, sizeof(struct tgfx), GFP_KERNEL))) {
182 		parport_put_port(pp);
183 		return NULL;
184 	}
185 
186 	init_MUTEX(&tgfx->sem);
187 
188 	tgfx->pd = parport_register_device(pp, "turbografx", NULL, NULL, NULL, PARPORT_DEV_EXCL, NULL);
189 
190 	parport_put_port(pp);
191 
192 	if (!tgfx->pd) {
193 		printk(KERN_ERR "turbografx.c: parport busy already - lp.o loaded?\n");
194 		kfree(tgfx);
195 		return NULL;
196 	}
197 
198 	init_timer(&tgfx->timer);
199 	tgfx->timer.data = (long) tgfx;
200 	tgfx->timer.function = tgfx_timer;
201 
202 	tgfx->sticks = 0;
203 
204 	for (i = 0; i < nargs - 1; i++)
205 		if (config[i+1] > 0 && config[i+1] < 6) {
206 
207 			tgfx->sticks |= (1 << i);
208 
209 			tgfx->dev[i].private = tgfx;
210 			tgfx->dev[i].open = tgfx_open;
211 			tgfx->dev[i].close = tgfx_close;
212 
213 			sprintf(tgfx->phys[i], "%s/input0", tgfx->pd->port->name);
214 
215 			tgfx->dev[i].name = tgfx_name;
216 			tgfx->dev[i].phys = tgfx->phys[i];
217 			tgfx->dev[i].id.bustype = BUS_PARPORT;
218 			tgfx->dev[i].id.vendor = 0x0003;
219 			tgfx->dev[i].id.product = config[i+1];
220 			tgfx->dev[i].id.version = 0x0100;
221 
222 			tgfx->dev[i].evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
223 			tgfx->dev[i].absbit[0] = BIT(ABS_X) | BIT(ABS_Y);
224 
225 			for (j = 0; j < config[i+1]; j++)
226 				set_bit(tgfx_buttons[j], tgfx->dev[i].keybit);
227 
228 			tgfx->dev[i].absmin[ABS_X] = -1; tgfx->dev[i].absmax[ABS_X] = 1;
229 			tgfx->dev[i].absmin[ABS_Y] = -1; tgfx->dev[i].absmax[ABS_Y] = 1;
230 
231 			input_register_device(tgfx->dev + i);
232 			printk(KERN_INFO "input: %d-button Multisystem joystick on %s\n",
233 				config[i+1], tgfx->pd->port->name);
234 		}
235 
236         if (!tgfx->sticks) {
237 		parport_unregister_device(tgfx->pd);
238 		kfree(tgfx);
239 		return NULL;
240         }
241 
242 	return tgfx;
243 }
244 
245 static int __init tgfx_init(void)
246 {
247 	tgfx_base[0] = tgfx_probe(tgfx, tgfx_nargs);
248 	tgfx_base[1] = tgfx_probe(tgfx_2, tgfx_nargs_2);
249 	tgfx_base[2] = tgfx_probe(tgfx_3, tgfx_nargs_3);
250 
251 	if (tgfx_base[0] || tgfx_base[1] || tgfx_base[2])
252 		return 0;
253 
254 	return -ENODEV;
255 }
256 
257 static void __exit tgfx_exit(void)
258 {
259 	int i, j;
260 
261 	for (i = 0; i < 3; i++)
262 		if (tgfx_base[i]) {
263 			for (j = 0; j < 7; j++)
264 				if (tgfx_base[i]->sticks & (1 << j))
265 					input_unregister_device(tgfx_base[i]->dev + j);
266 		parport_unregister_device(tgfx_base[i]->pd);
267 	}
268 }
269 
270 module_init(tgfx_init);
271 module_exit(tgfx_exit);
272