1 /*
2  *  Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
3  *  Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
4  *
5  *  USB/RS232 I-Force joysticks and wheels.
6  */
7 
8 /*
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22  */
23 
24 #include "iforce.h"
25 
26 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
27 MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
28 MODULE_LICENSE("GPL");
29 
30 static signed short btn_joystick[] =
31 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
32   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A,
33   BTN_B, BTN_C, BTN_DEAD, -1 };
34 
35 static signed short btn_joystick_avb[] =
36 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
37   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_DEAD, -1 };
38 
39 static signed short btn_wheel[] =
40 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
41   BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
42 
43 static signed short abs_joystick[] =
44 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
45 
46 static signed short abs_joystick_rudder[] =
47 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y, -1 };
48 
49 static signed short abs_avb_pegasus[] =
50 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
51   ABS_HAT1X, ABS_HAT1Y, -1 };
52 
53 static signed short abs_wheel[] =
54 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
55 
56 static signed short ff_iforce[] =
57 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
58   FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
59   FF_AUTOCENTER, -1 };
60 
61 static struct iforce_device iforce_device[] = {
62 	{ 0x044f, 0xa01c, "Thrustmaster Motor Sport GT",		btn_wheel, abs_wheel, ff_iforce },
63 	{ 0x046d, 0xc281, "Logitech WingMan Force",			btn_joystick, abs_joystick, ff_iforce },
64 	{ 0x046d, 0xc291, "Logitech WingMan Formula Force",		btn_wheel, abs_wheel, ff_iforce },
65 	{ 0x05ef, 0x020a, "AVB Top Shot Pegasus",			btn_joystick_avb, abs_avb_pegasus, ff_iforce },
66 	{ 0x05ef, 0x8884, "AVB Mag Turbo Force",			btn_wheel, abs_wheel, ff_iforce },
67 	{ 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel",	btn_wheel, abs_wheel, ff_iforce }, //?
68 	{ 0x061c, 0xc0a4, "ACT LABS Force RS",                          btn_wheel, abs_wheel, ff_iforce }, //?
69 	{ 0x061c, 0xc084, "ACT LABS Force RS",				btn_wheel, abs_wheel, ff_iforce },
70 	{ 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback",	btn_wheel, abs_wheel, ff_iforce }, //?
71 	{ 0x06f8, 0x0001, "Guillemot Jet Leader Force Feedback",	btn_joystick, abs_joystick_rudder, ff_iforce },
72 	{ 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel",	btn_wheel, abs_wheel, ff_iforce }, //?
73 	{ 0x06f8, 0xa302, "Guillemot Jet Leader 3D",			btn_joystick, abs_joystick, ff_iforce }, //?
74 	{ 0x06d6, 0x29bc, "Trust Force Feedback Race Master",		btn_wheel, abs_wheel, ff_iforce },
75 	{ 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]",		btn_joystick, abs_joystick, ff_iforce }
76 };
77 
78 static int iforce_playback(struct input_dev *dev, int effect_id, int value)
79 {
80 	struct iforce *iforce = input_get_drvdata(dev);
81 	struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
82 
83 	if (value > 0)
84 		set_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
85 	else
86 		clear_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
87 
88 	iforce_control_playback(iforce, effect_id, value);
89 	return 0;
90 }
91 
92 static void iforce_set_gain(struct input_dev *dev, u16 gain)
93 {
94 	struct iforce *iforce = input_get_drvdata(dev);
95 	unsigned char data[3];
96 
97 	data[0] = gain >> 9;
98 	iforce_send_packet(iforce, FF_CMD_GAIN, data);
99 }
100 
101 static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
102 {
103 	struct iforce *iforce = input_get_drvdata(dev);
104 	unsigned char data[3];
105 
106 	data[0] = 0x03;
107 	data[1] = magnitude >> 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 
115 /*
116  * Function called when an ioctl is performed on the event dev entry.
117  * It uploads an effect to the device
118  */
119 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
120 {
121 	struct iforce *iforce = input_get_drvdata(dev);
122 	struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
123 	int ret;
124 
125 	if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
126 		/* Check the effect is not already being updated */
127 		if (test_bit(FF_CORE_UPDATE, core_effect->flags))
128 			return -EAGAIN;
129 	}
130 
131 /*
132  * Upload the effect
133  */
134 	switch (effect->type) {
135 
136 		case FF_PERIODIC:
137 			ret = iforce_upload_periodic(iforce, effect, old);
138 			break;
139 
140 		case FF_CONSTANT:
141 			ret = iforce_upload_constant(iforce, effect, old);
142 			break;
143 
144 		case FF_SPRING:
145 		case FF_DAMPER:
146 			ret = iforce_upload_condition(iforce, effect, old);
147 			break;
148 
149 		default:
150 			return -EINVAL;
151 	}
152 
153 	if (ret == 0) {
154 		/* A packet was sent, forbid new updates until we are notified
155 		 * that the packet was updated
156 		 */
157 		set_bit(FF_CORE_UPDATE, core_effect->flags);
158 	}
159 	return ret;
160 }
161 
162 /*
163  * Erases an effect: it frees the effect id and mark as unused the memory
164  * allocated for the parameters
165  */
166 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
167 {
168 	struct iforce *iforce = input_get_drvdata(dev);
169 	struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
170 	int err = 0;
171 
172 	if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
173 		err = release_resource(&core_effect->mod1_chunk);
174 
175 	if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
176 		err = release_resource(&core_effect->mod2_chunk);
177 
178 	/* TODO: remember to change that if more FF_MOD* bits are added */
179 	core_effect->flags[0] = 0;
180 
181 	return err;
182 }
183 
184 static int iforce_open(struct input_dev *dev)
185 {
186 	struct iforce *iforce = input_get_drvdata(dev);
187 
188 	switch (iforce->bus) {
189 #ifdef CONFIG_JOYSTICK_IFORCE_USB
190 		case IFORCE_USB:
191 			iforce->irq->dev = iforce->usbdev;
192 			if (usb_submit_urb(iforce->irq, GFP_KERNEL))
193 				return -EIO;
194 			break;
195 #endif
196 	}
197 
198 	if (test_bit(EV_FF, dev->evbit)) {
199 		/* Enable force feedback */
200 		iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
201 	}
202 
203 	return 0;
204 }
205 
206 static void iforce_close(struct input_dev *dev)
207 {
208 	struct iforce *iforce = input_get_drvdata(dev);
209 	int i;
210 
211 	if (test_bit(EV_FF, dev->evbit)) {
212 		/* Check: no effects should be present in memory */
213 		for (i = 0; i < dev->ff->max_effects; i++) {
214 			if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags)) {
215 				dev_warn(&dev->dev,
216 					"%s: Device still owns effects\n",
217 					__func__);
218 				break;
219 			}
220 		}
221 
222 		/* Disable force feedback playback */
223 		iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
224 		/* Wait for the command to complete */
225 		wait_event_interruptible(iforce->wait,
226 			!test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
227 	}
228 
229 	switch (iforce->bus) {
230 #ifdef CONFIG_JOYSTICK_IFORCE_USB
231 	case IFORCE_USB:
232 		usb_kill_urb(iforce->irq);
233 		usb_kill_urb(iforce->out);
234 		usb_kill_urb(iforce->ctrl);
235 		break;
236 #endif
237 #ifdef CONFIG_JOYSTICK_IFORCE_232
238 	case IFORCE_232:
239 		//TODO: Wait for the last packets to be sent
240 		break;
241 #endif
242 	}
243 }
244 
245 int iforce_init_device(struct iforce *iforce)
246 {
247 	struct input_dev *input_dev;
248 	struct ff_device *ff;
249 	unsigned char c[] = "CEOV";
250 	int i, error;
251 	int ff_effects = 0;
252 
253 	input_dev = input_allocate_device();
254 	if (!input_dev)
255 		return -ENOMEM;
256 
257 	init_waitqueue_head(&iforce->wait);
258 	spin_lock_init(&iforce->xmit_lock);
259 	mutex_init(&iforce->mem_mutex);
260 	iforce->xmit.buf = iforce->xmit_data;
261 	iforce->dev = input_dev;
262 
263 /*
264  * Input device fields.
265  */
266 
267 	switch (iforce->bus) {
268 #ifdef CONFIG_JOYSTICK_IFORCE_USB
269 	case IFORCE_USB:
270 		input_dev->id.bustype = BUS_USB;
271 		input_dev->dev.parent = &iforce->usbdev->dev;
272 		break;
273 #endif
274 #ifdef CONFIG_JOYSTICK_IFORCE_232
275 	case IFORCE_232:
276 		input_dev->id.bustype = BUS_RS232;
277 		input_dev->dev.parent = &iforce->serio->dev;
278 		break;
279 #endif
280 	}
281 
282 	input_set_drvdata(input_dev, iforce);
283 
284 	input_dev->name = "Unknown I-Force device";
285 	input_dev->open = iforce_open;
286 	input_dev->close = iforce_close;
287 
288 /*
289  * On-device memory allocation.
290  */
291 
292 	iforce->device_memory.name = "I-Force device effect memory";
293 	iforce->device_memory.start = 0;
294 	iforce->device_memory.end = 200;
295 	iforce->device_memory.flags = IORESOURCE_MEM;
296 	iforce->device_memory.parent = NULL;
297 	iforce->device_memory.child = NULL;
298 	iforce->device_memory.sibling = NULL;
299 
300 /*
301  * Wait until device ready - until it sends its first response.
302  */
303 
304 	for (i = 0; i < 20; i++)
305 		if (!iforce_get_id_packet(iforce, "O"))
306 			break;
307 
308 	if (i == 20) { /* 5 seconds */
309 		dev_err(&input_dev->dev,
310 			"Timeout waiting for response from device.\n");
311 		error = -ENODEV;
312 		goto fail;
313 	}
314 
315 /*
316  * Get device info.
317  */
318 
319 	if (!iforce_get_id_packet(iforce, "M"))
320 		input_dev->id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
321 	else
322 		dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
323 
324 	if (!iforce_get_id_packet(iforce, "P"))
325 		input_dev->id.product = (iforce->edata[2] << 8) | iforce->edata[1];
326 	else
327 		dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
328 
329 	if (!iforce_get_id_packet(iforce, "B"))
330 		iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
331 	else
332 		dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
333 
334 	if (!iforce_get_id_packet(iforce, "N"))
335 		ff_effects = iforce->edata[1];
336 	else
337 		dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
338 
339 	/* Check if the device can store more effects than the driver can really handle */
340 	if (ff_effects > IFORCE_EFFECTS_MAX) {
341 		dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
342 		       IFORCE_EFFECTS_MAX, ff_effects);
343 		ff_effects = IFORCE_EFFECTS_MAX;
344 	}
345 
346 /*
347  * Display additional info.
348  */
349 
350 	for (i = 0; c[i]; i++)
351 		if (!iforce_get_id_packet(iforce, c + i))
352 			iforce_dump_packet(iforce, "info", iforce->ecmd, iforce->edata);
353 
354 /*
355  * Disable spring, enable force feedback.
356  */
357 	iforce_set_autocenter(input_dev, 0);
358 
359 /*
360  * Find appropriate device entry
361  */
362 
363 	for (i = 0; iforce_device[i].idvendor; i++)
364 		if (iforce_device[i].idvendor == input_dev->id.vendor &&
365 		    iforce_device[i].idproduct == input_dev->id.product)
366 			break;
367 
368 	iforce->type = iforce_device + i;
369 	input_dev->name = iforce->type->name;
370 
371 /*
372  * Set input device bitfields and ranges.
373  */
374 
375 	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
376 		BIT_MASK(EV_FF_STATUS);
377 
378 	for (i = 0; iforce->type->btn[i] >= 0; i++)
379 		set_bit(iforce->type->btn[i], input_dev->keybit);
380 
381 	for (i = 0; iforce->type->abs[i] >= 0; i++) {
382 
383 		signed short t = iforce->type->abs[i];
384 
385 		switch (t) {
386 
387 			case ABS_X:
388 			case ABS_Y:
389 			case ABS_WHEEL:
390 
391 				input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
392 				set_bit(t, input_dev->ffbit);
393 				break;
394 
395 			case ABS_THROTTLE:
396 			case ABS_GAS:
397 			case ABS_BRAKE:
398 
399 				input_set_abs_params(input_dev, t, 0, 255, 0, 0);
400 				break;
401 
402 			case ABS_RUDDER:
403 
404 				input_set_abs_params(input_dev, t, -128, 127, 0, 0);
405 				break;
406 
407 			case ABS_HAT0X:
408 			case ABS_HAT0Y:
409 		        case ABS_HAT1X:
410 		        case ABS_HAT1Y:
411 
412 				input_set_abs_params(input_dev, t, -1, 1, 0, 0);
413 				break;
414 		}
415 	}
416 
417 	if (ff_effects) {
418 
419 		for (i = 0; iforce->type->ff[i] >= 0; i++)
420 			set_bit(iforce->type->ff[i], input_dev->ffbit);
421 
422 		error = input_ff_create(input_dev, ff_effects);
423 		if (error)
424 			goto fail;
425 
426 		ff = input_dev->ff;
427 		ff->upload = iforce_upload_effect;
428 		ff->erase = iforce_erase_effect;
429 		ff->set_gain = iforce_set_gain;
430 		ff->set_autocenter = iforce_set_autocenter;
431 		ff->playback = iforce_playback;
432 	}
433 /*
434  * Register input device.
435  */
436 
437 	error = input_register_device(iforce->dev);
438 	if (error)
439 		goto fail;
440 
441 	return 0;
442 
443  fail:	input_free_device(input_dev);
444 	return error;
445 }
446 
447 static int __init iforce_init(void)
448 {
449 	int err = 0;
450 
451 #ifdef CONFIG_JOYSTICK_IFORCE_USB
452 	err = usb_register(&iforce_usb_driver);
453 	if (err)
454 		return err;
455 #endif
456 #ifdef CONFIG_JOYSTICK_IFORCE_232
457 	err = serio_register_driver(&iforce_serio_drv);
458 #ifdef CONFIG_JOYSTICK_IFORCE_USB
459 	if (err)
460 		usb_deregister(&iforce_usb_driver);
461 #endif
462 #endif
463 	return err;
464 }
465 
466 static void __exit iforce_exit(void)
467 {
468 #ifdef CONFIG_JOYSTICK_IFORCE_USB
469 	usb_deregister(&iforce_usb_driver);
470 #endif
471 #ifdef CONFIG_JOYSTICK_IFORCE_232
472 	serio_unregister_driver(&iforce_serio_drv);
473 #endif
474 }
475 
476 module_init(iforce_init);
477 module_exit(iforce_exit);
478