2 * Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
3 * Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
5 * USB/RS232 I-Force joysticks and wheels.
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.
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.
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
23 * Should you need to contact me, the author, you can do so either by
24 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
25 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
30 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
31 MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
32 MODULE_LICENSE("GPL");
34 static signed short btn_joystick[] =
35 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
36 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
38 static signed short btn_avb_pegasus[] =
39 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
40 BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
42 static signed short btn_wheel[] =
43 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
44 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
46 static signed short btn_avb_tw[] =
47 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
48 BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
50 static signed short btn_avb_wheel[] =
51 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
52 BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
54 static signed short abs_joystick[] =
55 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
57 static signed short abs_avb_pegasus[] =
58 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
59 ABS_HAT1X, ABS_HAT1Y, -1 };
61 static signed short abs_wheel[] =
62 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
64 static signed short ff_iforce[] =
65 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
66 FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
69 static struct iforce_device iforce_device[] = {
70 { 0x044f, 0xa01c, "Thrustmaster Motor Sport GT", btn_wheel, abs_wheel, ff_iforce },
71 { 0x046d, 0xc281, "Logitech WingMan Force", btn_joystick, abs_joystick, ff_iforce },
72 { 0x046d, 0xc291, "Logitech WingMan Formula Force", btn_wheel, abs_wheel, ff_iforce },
73 { 0x05ef, 0x020a, "AVB Top Shot Pegasus", btn_avb_pegasus, abs_avb_pegasus, ff_iforce },
74 { 0x05ef, 0x8884, "AVB Mag Turbo Force", btn_avb_wheel, abs_wheel, ff_iforce },
75 { 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel", btn_avb_tw, abs_wheel, ff_iforce }, //?
76 { 0x061c, 0xc0a4, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce }, //?
77 { 0x061c, 0xc084, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce },
78 { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback", btn_wheel, abs_wheel, ff_iforce }, //?
79 { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
80 { 0x06f8, 0x0004, "Gullemot Jet Leader 3D", btn_joystick, abs_joystick, ff_iforce }, //?
81 { 0x06d6, 0x29bc, "Trust Force Feedback Race Master", btn_wheel, abs_wheel, ff_iforce },
82 { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]", btn_joystick, abs_joystick, ff_iforce }
85 static int iforce_playback(struct input_dev *dev, int effect_id, int value)
87 struct iforce *iforce = input_get_drvdata(dev);
88 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
91 set_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
93 clear_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
95 iforce_control_playback(iforce, effect_id, value);
99 static void iforce_set_gain(struct input_dev *dev, u16 gain)
101 struct iforce *iforce = input_get_drvdata(dev);
102 unsigned char data[3];
105 iforce_send_packet(iforce, FF_CMD_GAIN, data);
108 static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
110 struct iforce *iforce = input_get_drvdata(dev);
111 unsigned char data[3];
114 data[1] = magnitude >> 9;
115 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
119 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
123 * Function called when an ioctl is performed on the event dev entry.
124 * It uploads an effect to the device
126 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
128 struct iforce *iforce = input_get_drvdata(dev);
129 struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
132 if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
133 /* Check the effect is not already being updated */
134 if (test_bit(FF_CORE_UPDATE, core_effect->flags))
141 switch (effect->type) {
144 ret = iforce_upload_periodic(iforce, effect, old);
148 ret = iforce_upload_constant(iforce, effect, old);
153 ret = iforce_upload_condition(iforce, effect, old);
161 /* A packet was sent, forbid new updates until we are notified
162 * that the packet was updated
164 set_bit(FF_CORE_UPDATE, core_effect->flags);
170 * Erases an effect: it frees the effect id and mark as unused the memory
171 * allocated for the parameters
173 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
175 struct iforce *iforce = input_get_drvdata(dev);
176 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
179 if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
180 err = release_resource(&core_effect->mod1_chunk);
182 if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
183 err = release_resource(&core_effect->mod2_chunk);
185 /* TODO: remember to change that if more FF_MOD* bits are added */
186 core_effect->flags[0] = 0;
191 static int iforce_open(struct input_dev *dev)
193 struct iforce *iforce = input_get_drvdata(dev);
195 switch (iforce->bus) {
196 #ifdef CONFIG_JOYSTICK_IFORCE_USB
198 iforce->irq->dev = iforce->usbdev;
199 if (usb_submit_urb(iforce->irq, GFP_KERNEL))
205 if (test_bit(EV_FF, dev->evbit)) {
206 /* Enable force feedback */
207 iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
213 static void iforce_close(struct input_dev *dev)
215 struct iforce *iforce = input_get_drvdata(dev);
218 if (test_bit(EV_FF, dev->evbit)) {
219 /* Check: no effects should be present in memory */
220 for (i = 0; i < dev->ff->max_effects; i++) {
221 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags)) {
223 "%s: Device still owns effects\n",
229 /* Disable force feedback playback */
230 iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
231 /* Wait for the command to complete */
232 wait_event_interruptible(iforce->wait,
233 !test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
236 switch (iforce->bus) {
237 #ifdef CONFIG_JOYSTICK_IFORCE_USB
239 usb_kill_urb(iforce->irq);
240 usb_kill_urb(iforce->out);
241 usb_kill_urb(iforce->ctrl);
244 #ifdef CONFIG_JOYSTICK_IFORCE_232
246 //TODO: Wait for the last packets to be sent
252 int iforce_init_device(struct iforce *iforce)
254 struct input_dev *input_dev;
255 struct ff_device *ff;
256 unsigned char c[] = "CEOV";
260 input_dev = input_allocate_device();
264 init_waitqueue_head(&iforce->wait);
265 spin_lock_init(&iforce->xmit_lock);
266 mutex_init(&iforce->mem_mutex);
267 iforce->xmit.buf = iforce->xmit_data;
268 iforce->dev = input_dev;
271 * Input device fields.
274 switch (iforce->bus) {
275 #ifdef CONFIG_JOYSTICK_IFORCE_USB
277 input_dev->id.bustype = BUS_USB;
278 input_dev->dev.parent = &iforce->usbdev->dev;
281 #ifdef CONFIG_JOYSTICK_IFORCE_232
283 input_dev->id.bustype = BUS_RS232;
284 input_dev->dev.parent = &iforce->serio->dev;
289 input_set_drvdata(input_dev, iforce);
291 input_dev->name = "Unknown I-Force device";
292 input_dev->open = iforce_open;
293 input_dev->close = iforce_close;
296 * On-device memory allocation.
299 iforce->device_memory.name = "I-Force device effect memory";
300 iforce->device_memory.start = 0;
301 iforce->device_memory.end = 200;
302 iforce->device_memory.flags = IORESOURCE_MEM;
303 iforce->device_memory.parent = NULL;
304 iforce->device_memory.child = NULL;
305 iforce->device_memory.sibling = NULL;
308 * Wait until device ready - until it sends its first response.
311 for (i = 0; i < 20; i++)
312 if (!iforce_get_id_packet(iforce, "O"))
315 if (i == 20) { /* 5 seconds */
316 err("Timeout waiting for response from device.");
325 if (!iforce_get_id_packet(iforce, "M"))
326 input_dev->id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
328 dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
330 if (!iforce_get_id_packet(iforce, "P"))
331 input_dev->id.product = (iforce->edata[2] << 8) | iforce->edata[1];
333 dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
335 if (!iforce_get_id_packet(iforce, "B"))
336 iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
338 dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
340 if (!iforce_get_id_packet(iforce, "N"))
341 ff_effects = iforce->edata[1];
343 dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
345 /* Check if the device can store more effects than the driver can really handle */
346 if (ff_effects > IFORCE_EFFECTS_MAX) {
347 dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
348 IFORCE_EFFECTS_MAX, ff_effects);
349 ff_effects = IFORCE_EFFECTS_MAX;
353 * Display additional info.
356 for (i = 0; c[i]; i++)
357 if (!iforce_get_id_packet(iforce, c + i))
358 iforce_dump_packet("info", iforce->ecmd, iforce->edata);
361 * Disable spring, enable force feedback.
363 iforce_set_autocenter(input_dev, 0);
366 * Find appropriate device entry
369 for (i = 0; iforce_device[i].idvendor; i++)
370 if (iforce_device[i].idvendor == input_dev->id.vendor &&
371 iforce_device[i].idproduct == input_dev->id.product)
374 iforce->type = iforce_device + i;
375 input_dev->name = iforce->type->name;
378 * Set input device bitfields and ranges.
381 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
382 BIT_MASK(EV_FF_STATUS);
384 for (i = 0; iforce->type->btn[i] >= 0; i++)
385 set_bit(iforce->type->btn[i], input_dev->keybit);
386 set_bit(BTN_DEAD, input_dev->keybit);
388 for (i = 0; iforce->type->abs[i] >= 0; i++) {
390 signed short t = iforce->type->abs[i];
398 input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
399 set_bit(t, input_dev->ffbit);
406 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
411 input_set_abs_params(input_dev, t, -128, 127, 0, 0);
419 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
426 for (i = 0; iforce->type->ff[i] >= 0; i++)
427 set_bit(iforce->type->ff[i], input_dev->ffbit);
429 error = input_ff_create(input_dev, ff_effects);
434 ff->upload = iforce_upload_effect;
435 ff->erase = iforce_erase_effect;
436 ff->set_gain = iforce_set_gain;
437 ff->set_autocenter = iforce_set_autocenter;
438 ff->playback = iforce_playback;
441 * Register input device.
444 error = input_register_device(iforce->dev);
450 fail: input_free_device(input_dev);
454 static int __init iforce_init(void)
458 #ifdef CONFIG_JOYSTICK_IFORCE_USB
459 err = usb_register(&iforce_usb_driver);
463 #ifdef CONFIG_JOYSTICK_IFORCE_232
464 err = serio_register_driver(&iforce_serio_drv);
465 #ifdef CONFIG_JOYSTICK_IFORCE_USB
467 usb_deregister(&iforce_usb_driver);
473 static void __exit iforce_exit(void)
475 #ifdef CONFIG_JOYSTICK_IFORCE_USB
476 usb_deregister(&iforce_usb_driver);
478 #ifdef CONFIG_JOYSTICK_IFORCE_232
479 serio_unregister_driver(&iforce_serio_drv);
483 module_init(iforce_init);
484 module_exit(iforce_exit);