xref: /linux/drivers/input/joystick/iforce/iforce-main.c (revision ccea15f45eb0ab12d658f88b5d4be005cb2bb1a7) 
1 /*
2  * $Id: iforce-main.c,v 1.19 2002/07/07 10:22:50 jdeneux Exp $
3  *
4  *  Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
5  *  Copyright (c) 2001-2002 Johann Deneux <deneux@ifrance.com>
6  *
7  *  USB/RS232 I-Force joysticks and wheels.
8  */
9 
10 /*
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24  *
25  * Should you need to contact me, the author, you can do so either by
26  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
27  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
28  */
29 
30 #include "iforce.h"
31 
32 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <deneux@ifrance.com>");
33 MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
34 MODULE_LICENSE("GPL");
35 
36 static signed short btn_joystick[] =
37 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
38   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
39 
40 static signed short btn_avb_pegasus[] =
41 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
42   BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
43 
44 static signed short btn_wheel[] =
45 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
46   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
47 
48 static signed short btn_avb_tw[] =
49 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
50   BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
51 
52 static signed short btn_avb_wheel[] =
53 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
54   BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
55 
56 static signed short abs_joystick[] =
57 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
58 
59 static signed short abs_avb_pegasus[] =
60 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
61   ABS_HAT1X, ABS_HAT1Y, -1 };
62 
63 static signed short abs_wheel[] =
64 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
65 
66 static signed short ff_iforce[] =
67 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
68   FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
69   FF_AUTOCENTER, -1 };
70 
71 static struct iforce_device iforce_device[] = {
72 	{ 0x044f, 0xa01c, "Thrustmaster Motor Sport GT",		btn_wheel, abs_wheel, ff_iforce },
73 	{ 0x046d, 0xc281, "Logitech WingMan Force",			btn_joystick, abs_joystick, ff_iforce },
74 	{ 0x046d, 0xc291, "Logitech WingMan Formula Force",		btn_wheel, abs_wheel, ff_iforce },
75 	{ 0x05ef, 0x020a, "AVB Top Shot Pegasus",			btn_avb_pegasus, abs_avb_pegasus, ff_iforce },
76 	{ 0x05ef, 0x8884, "AVB Mag Turbo Force",			btn_avb_wheel, abs_wheel, ff_iforce },
77 	{ 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel",	btn_avb_tw, abs_wheel, ff_iforce }, //?
78 	{ 0x061c, 0xc0a4, "ACT LABS Force RS",                          btn_wheel, abs_wheel, ff_iforce }, //?
79 	{ 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback",	btn_wheel, abs_wheel, ff_iforce }, //?
80 	{ 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel",	btn_wheel, abs_wheel, ff_iforce }, //?
81 	{ 0x06f8, 0x0004, "Gullemot Jet Leader 3D",			btn_joystick, abs_joystick, ff_iforce }, //?
82 	{ 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]",		btn_joystick, abs_joystick, ff_iforce }
83 };
84 
85 
86 
87 static int iforce_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
88 {
89 	struct iforce* iforce = (struct iforce*)(dev->private);
90 	unsigned char data[3];
91 
92 	if (type != EV_FF)
93 		return -1;
94 
95 	switch (code) {
96 
97 		case FF_GAIN:
98 
99 			data[0] = value >> 9;
100 			iforce_send_packet(iforce, FF_CMD_GAIN, data);
101 
102 			return 0;
103 
104 		case FF_AUTOCENTER:
105 
106 			data[0] = 0x03;
107 			data[1] = value >> 9;
108 			iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
109 
110 			data[0] = 0x04;
111 			data[1] = 0x01;
112 			iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
113 
114 			return 0;
115 
116 		default: /* Play or stop an effect */
117 
118 			if (!CHECK_OWNERSHIP(code, iforce)) {
119 				return -1;
120 			}
121 			if (value > 0) {
122 				set_bit(FF_CORE_SHOULD_PLAY, iforce->core_effects[code].flags);
123 			}
124 			else {
125 				clear_bit(FF_CORE_SHOULD_PLAY, iforce->core_effects[code].flags);
126 			}
127 
128 			iforce_control_playback(iforce, code, value);
129 			return 0;
130 	}
131 
132 	return -1;
133 }
134 
135 /*
136  * Function called when an ioctl is performed on the event dev entry.
137  * It uploads an effect to the device
138  */
139 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect)
140 {
141 	struct iforce* iforce = (struct iforce*)(dev->private);
142 	int id;
143 	int ret;
144 	int is_update;
145 
146 /* Check this effect type is supported by this device */
147 	if (!test_bit(effect->type, iforce->dev->ffbit))
148 		return -EINVAL;
149 
150 /*
151  * If we want to create a new effect, get a free id
152  */
153 	if (effect->id == -1) {
154 
155 		for (id = 0; id < FF_EFFECTS_MAX; ++id)
156 			if (!test_and_set_bit(FF_CORE_IS_USED, iforce->core_effects[id].flags))
157 				break;
158 
159 		if (id == FF_EFFECTS_MAX || id >= iforce->dev->ff_effects_max)
160 			return -ENOMEM;
161 
162 		effect->id = id;
163 		iforce->core_effects[id].owner = current->pid;
164 		iforce->core_effects[id].flags[0] = (1 << FF_CORE_IS_USED);	/* Only IS_USED bit must be set */
165 
166 		is_update = FALSE;
167 	}
168 	else {
169 		/* We want to update an effect */
170 		if (!CHECK_OWNERSHIP(effect->id, iforce))
171 			return -EACCES;
172 
173 		/* Parameter type cannot be updated */
174 		if (effect->type != iforce->core_effects[effect->id].effect.type)
175 			return -EINVAL;
176 
177 		/* Check the effect is not already being updated */
178 		if (test_bit(FF_CORE_UPDATE, iforce->core_effects[effect->id].flags))
179 			return -EAGAIN;
180 
181 		is_update = TRUE;
182 	}
183 
184 /*
185  * Upload the effect
186  */
187 	switch (effect->type) {
188 
189 		case FF_PERIODIC:
190 			ret = iforce_upload_periodic(iforce, effect, is_update);
191 			break;
192 
193 		case FF_CONSTANT:
194 			ret = iforce_upload_constant(iforce, effect, is_update);
195 			break;
196 
197 		case FF_SPRING:
198 		case FF_DAMPER:
199 			ret = iforce_upload_condition(iforce, effect, is_update);
200 			break;
201 
202 		default:
203 			return -EINVAL;
204 	}
205 	if (ret == 0) {
206 		/* A packet was sent, forbid new updates until we are notified
207 		 * that the packet was updated
208 		 */
209 		set_bit(FF_CORE_UPDATE, iforce->core_effects[effect->id].flags);
210 	}
211 	iforce->core_effects[effect->id].effect = *effect;
212 	return ret;
213 }
214 
215 /*
216  * Erases an effect: it frees the effect id and mark as unused the memory
217  * allocated for the parameters
218  */
219 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
220 {
221 	struct iforce* iforce = (struct iforce*)(dev->private);
222 	int err = 0;
223 	struct iforce_core_effect* core_effect;
224 
225 	/* Check who is trying to erase this effect */
226 	if (iforce->core_effects[effect_id].owner != current->pid) {
227 		printk(KERN_WARNING "iforce-main.c: %d tried to erase an effect belonging to %d\n", current->pid, iforce->core_effects[effect_id].owner);
228 		return -EACCES;
229 	}
230 
231 	if (effect_id < 0 || effect_id >= FF_EFFECTS_MAX)
232 		return -EINVAL;
233 
234 	core_effect = iforce->core_effects + effect_id;
235 
236 	if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
237 		err = release_resource(&(iforce->core_effects[effect_id].mod1_chunk));
238 
239 	if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
240 		err = release_resource(&(iforce->core_effects[effect_id].mod2_chunk));
241 
242 	/*TODO: remember to change that if more FF_MOD* bits are added */
243 	core_effect->flags[0] = 0;
244 
245 	return err;
246 }
247 
248 static int iforce_open(struct input_dev *dev)
249 {
250 	struct iforce *iforce = dev->private;
251 
252 	switch (iforce->bus) {
253 #ifdef CONFIG_JOYSTICK_IFORCE_USB
254 		case IFORCE_USB:
255 			iforce->irq->dev = iforce->usbdev;
256 			if (usb_submit_urb(iforce->irq, GFP_KERNEL))
257 				return -EIO;
258 			break;
259 #endif
260 	}
261 
262 	/* Enable force feedback */
263 	iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
264 
265 	return 0;
266 }
267 
268 static int iforce_flush(struct input_dev *dev, struct file *file)
269 {
270 	struct iforce *iforce = dev->private;
271 	int i;
272 
273 	/* Erase all effects this process owns */
274 	for (i=0; i<dev->ff_effects_max; ++i) {
275 
276 		if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags) &&
277 			current->pid == iforce->core_effects[i].owner) {
278 
279 			/* Stop effect */
280 			input_report_ff(dev, i, 0);
281 
282 			/* Free ressources assigned to effect */
283 			if (iforce_erase_effect(dev, i)) {
284 				printk(KERN_WARNING "iforce_flush: erase effect %d failed\n", i);
285 			}
286 		}
287 
288 	}
289 	return 0;
290 }
291 
292 static void iforce_release(struct input_dev *dev)
293 {
294 	struct iforce *iforce = dev->private;
295 	int i;
296 
297 	/* Check: no effect should be present in memory */
298 	for (i=0; i<dev->ff_effects_max; ++i) {
299 		if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags))
300 			break;
301 	}
302 	if (i<dev->ff_effects_max) {
303 		printk(KERN_WARNING "iforce_release: Device still owns effects\n");
304 	}
305 
306 	/* Disable force feedback playback */
307 	iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
308 
309 	switch (iforce->bus) {
310 #ifdef CONFIG_JOYSTICK_IFORCE_USB
311 		case IFORCE_USB:
312 			usb_unlink_urb(iforce->irq);
313 
314 			/* The device was unplugged before the file
315 			 * was released */
316 			if (iforce->usbdev == NULL) {
317 				iforce_delete_device(iforce);
318 				kfree(iforce);
319 			}
320 		break;
321 #endif
322 	}
323 }
324 
325 void iforce_delete_device(struct iforce *iforce)
326 {
327 	switch (iforce->bus) {
328 #ifdef CONFIG_JOYSTICK_IFORCE_USB
329 	case IFORCE_USB:
330 		iforce_usb_delete(iforce);
331 		break;
332 #endif
333 #ifdef CONFIG_JOYSTICK_IFORCE_232
334 	case IFORCE_232:
335 		//TODO: Wait for the last packets to be sent
336 		break;
337 #endif
338 	}
339 }
340 
341 int iforce_init_device(struct iforce *iforce)
342 {
343 	struct input_dev *input_dev;
344 	unsigned char c[] = "CEOV";
345 	int i;
346 
347 	input_dev = input_allocate_device();
348 	if (!input_dev)
349 		return -ENOMEM;
350 
351 	init_waitqueue_head(&iforce->wait);
352 	spin_lock_init(&iforce->xmit_lock);
353 	mutex_init(&iforce->mem_mutex);
354 	iforce->xmit.buf = iforce->xmit_data;
355 	iforce->dev = input_dev;
356 
357 /*
358  * Input device fields.
359  */
360 
361 	switch (iforce->bus) {
362 #ifdef CONFIG_JOYSTICK_IFORCE_USB
363 	case IFORCE_USB:
364 		input_dev->id.bustype = BUS_USB;
365 		input_dev->cdev.dev = &iforce->usbdev->dev;
366 		break;
367 #endif
368 #ifdef CONFIG_JOYSTICK_IFORCE_232
369 	case IFORCE_232:
370 		input_dev->id.bustype = BUS_RS232;
371 		input_dev->cdev.dev = &iforce->serio->dev;
372 		break;
373 #endif
374 	}
375 
376 	input_dev->private = iforce;
377 	input_dev->name = "Unknown I-Force device";
378 	input_dev->open = iforce_open;
379 	input_dev->close = iforce_release;
380 	input_dev->flush = iforce_flush;
381 	input_dev->event = iforce_input_event;
382 	input_dev->upload_effect = iforce_upload_effect;
383 	input_dev->erase_effect = iforce_erase_effect;
384 	input_dev->ff_effects_max = 10;
385 
386 /*
387  * On-device memory allocation.
388  */
389 
390 	iforce->device_memory.name = "I-Force device effect memory";
391 	iforce->device_memory.start = 0;
392 	iforce->device_memory.end = 200;
393 	iforce->device_memory.flags = IORESOURCE_MEM;
394 	iforce->device_memory.parent = NULL;
395 	iforce->device_memory.child = NULL;
396 	iforce->device_memory.sibling = NULL;
397 
398 /*
399  * Wait until device ready - until it sends its first response.
400  */
401 
402 	for (i = 0; i < 20; i++)
403 		if (!iforce_get_id_packet(iforce, "O"))
404 			break;
405 
406 	if (i == 20) { /* 5 seconds */
407 		printk(KERN_ERR "iforce-main.c: Timeout waiting for response from device.\n");
408 		input_free_device(input_dev);
409 		return -ENODEV;
410 	}
411 
412 /*
413  * Get device info.
414  */
415 
416 	if (!iforce_get_id_packet(iforce, "M"))
417 		input_dev->id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
418 	else
419 		printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet M\n");
420 
421 	if (!iforce_get_id_packet(iforce, "P"))
422 		input_dev->id.product = (iforce->edata[2] << 8) | iforce->edata[1];
423 	else
424 		printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet P\n");
425 
426 	if (!iforce_get_id_packet(iforce, "B"))
427 		iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
428 	else
429 		printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet B\n");
430 
431 	if (!iforce_get_id_packet(iforce, "N"))
432 		iforce->dev->ff_effects_max = iforce->edata[1];
433 	else
434 		printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet N\n");
435 
436 	/* Check if the device can store more effects than the driver can really handle */
437 	if (iforce->dev->ff_effects_max > FF_EFFECTS_MAX) {
438 		printk(KERN_WARNING "input??: Device can handle %d effects, but N_EFFECTS_MAX is set to %d in iforce.h\n",
439 			iforce->dev->ff_effects_max, FF_EFFECTS_MAX);
440 		iforce->dev->ff_effects_max = FF_EFFECTS_MAX;
441 	}
442 
443 /*
444  * Display additional info.
445  */
446 
447 	for (i = 0; c[i]; i++)
448 		if (!iforce_get_id_packet(iforce, c + i))
449 			iforce_dump_packet("info", iforce->ecmd, iforce->edata);
450 
451 /*
452  * Disable spring, enable force feedback.
453  * FIXME: We should use iforce_set_autocenter() et al here.
454  */
455 
456 	iforce_send_packet(iforce, FF_CMD_AUTOCENTER, "\004\000");
457 
458 /*
459  * Find appropriate device entry
460  */
461 
462 	for (i = 0; iforce_device[i].idvendor; i++)
463 		if (iforce_device[i].idvendor == input_dev->id.vendor &&
464 		    iforce_device[i].idproduct == input_dev->id.product)
465 			break;
466 
467 	iforce->type = iforce_device + i;
468 	input_dev->name = iforce->type->name;
469 
470 /*
471  * Set input device bitfields and ranges.
472  */
473 
474 	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS) | BIT(EV_FF) | BIT(EV_FF_STATUS);
475 
476 	for (i = 0; iforce->type->btn[i] >= 0; i++) {
477 		signed short t = iforce->type->btn[i];
478 		set_bit(t, input_dev->keybit);
479 	}
480 	set_bit(BTN_DEAD, input_dev->keybit);
481 
482 	for (i = 0; iforce->type->abs[i] >= 0; i++) {
483 
484 		signed short t = iforce->type->abs[i];
485 
486 		switch (t) {
487 
488 			case ABS_X:
489 			case ABS_Y:
490 			case ABS_WHEEL:
491 
492 				input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
493 				set_bit(t, input_dev->ffbit);
494 				break;
495 
496 			case ABS_THROTTLE:
497 			case ABS_GAS:
498 			case ABS_BRAKE:
499 
500 				input_set_abs_params(input_dev, t, 0, 255, 0, 0);
501 				break;
502 
503 			case ABS_RUDDER:
504 
505 				input_set_abs_params(input_dev, t, -128, 127, 0, 0);
506 				break;
507 
508 			case ABS_HAT0X:
509 			case ABS_HAT0Y:
510 		        case ABS_HAT1X:
511 		        case ABS_HAT1Y:
512 
513 				input_set_abs_params(input_dev, t, -1, 1, 0, 0);
514 				break;
515 		}
516 	}
517 
518 	for (i = 0; iforce->type->ff[i] >= 0; i++)
519 		set_bit(iforce->type->ff[i], input_dev->ffbit);
520 
521 /*
522  * Register input device.
523  */
524 
525 	input_register_device(iforce->dev);
526 
527 	printk(KERN_DEBUG "iforce->dev->open = %p\n", iforce->dev->open);
528 
529 	return 0;
530 }
531 
532 static int __init iforce_init(void)
533 {
534 #ifdef CONFIG_JOYSTICK_IFORCE_USB
535 	usb_register(&iforce_usb_driver);
536 #endif
537 #ifdef CONFIG_JOYSTICK_IFORCE_232
538 	serio_register_driver(&iforce_serio_drv);
539 #endif
540 	return 0;
541 }
542 
543 static void __exit iforce_exit(void)
544 {
545 #ifdef CONFIG_JOYSTICK_IFORCE_USB
546 	usb_deregister(&iforce_usb_driver);
547 #endif
548 #ifdef CONFIG_JOYSTICK_IFORCE_232
549 	serio_unregister_driver(&iforce_serio_drv);
550 #endif
551 }
552 
553 module_init(iforce_init);
554 module_exit(iforce_exit);
555