1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
4 * Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
6 * USB/RS232 I-Force joysticks and wheels.
14 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
15 MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
16 MODULE_LICENSE("GPL");
18 static signed short btn_joystick[] =
19 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
20 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A,
21 BTN_B, BTN_C, BTN_DEAD, -1 };
23 static signed short btn_joystick_avb[] =
24 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
25 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_DEAD, -1 };
27 static signed short btn_wheel[] =
28 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
29 BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
31 static signed short abs_joystick[] =
32 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
34 static signed short abs_joystick_rudder[] =
35 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y, -1 };
37 static signed short abs_avb_pegasus[] =
38 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
39 ABS_HAT1X, ABS_HAT1Y, -1 };
41 static signed short abs_wheel[] =
42 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
44 static signed short ff_iforce[] =
45 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
46 FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
49 static struct iforce_device iforce_device[] = {
50 { 0x044f, 0xa01c, "Thrustmaster Motor Sport GT", btn_wheel, abs_wheel, ff_iforce },
51 { 0x046d, 0xc281, "Logitech WingMan Force", btn_joystick, abs_joystick, ff_iforce },
52 { 0x046d, 0xc291, "Logitech WingMan Formula Force", btn_wheel, abs_wheel, ff_iforce },
53 { 0x05ef, 0x020a, "AVB Top Shot Pegasus", btn_joystick_avb, abs_avb_pegasus, ff_iforce },
54 { 0x05ef, 0x8884, "AVB Mag Turbo Force", btn_wheel, abs_wheel, ff_iforce },
55 { 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
56 { 0x061c, 0xc0a4, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce }, //?
57 { 0x061c, 0xc084, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce },
58 { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback", btn_wheel, abs_wheel, ff_iforce }, //?
59 { 0x06f8, 0x0001, "Guillemot Jet Leader Force Feedback", btn_joystick, abs_joystick_rudder, ff_iforce },
60 { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
61 { 0x06f8, 0xa302, "Guillemot Jet Leader 3D", btn_joystick, abs_joystick, ff_iforce }, //?
62 { 0x06d6, 0x29bc, "Trust Force Feedback Race Master", btn_wheel, abs_wheel, ff_iforce },
63 { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]", btn_joystick, abs_joystick, ff_iforce }
66 static int iforce_playback(struct input_dev *dev, int effect_id, int value)
68 struct iforce *iforce = input_get_drvdata(dev);
69 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
72 set_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
74 clear_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
76 iforce_control_playback(iforce, effect_id, value);
80 static void iforce_set_gain(struct input_dev *dev, u16 gain)
82 struct iforce *iforce = input_get_drvdata(dev);
83 unsigned char data[3];
86 iforce_send_packet(iforce, FF_CMD_GAIN, data);
89 static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
91 struct iforce *iforce = input_get_drvdata(dev);
92 unsigned char data[3];
95 data[1] = magnitude >> 9;
96 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
100 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
104 * Function called when an ioctl is performed on the event dev entry.
105 * It uploads an effect to the device
107 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
109 struct iforce *iforce = input_get_drvdata(dev);
110 struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
113 if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
114 /* Check the effect is not already being updated */
115 if (test_bit(FF_CORE_UPDATE, core_effect->flags))
122 switch (effect->type) {
125 ret = iforce_upload_periodic(iforce, effect, old);
129 ret = iforce_upload_constant(iforce, effect, old);
134 ret = iforce_upload_condition(iforce, effect, old);
142 /* A packet was sent, forbid new updates until we are notified
143 * that the packet was updated
145 set_bit(FF_CORE_UPDATE, core_effect->flags);
151 * Erases an effect: it frees the effect id and mark as unused the memory
152 * allocated for the parameters
154 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
156 struct iforce *iforce = input_get_drvdata(dev);
157 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
160 if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
161 err = release_resource(&core_effect->mod1_chunk);
163 if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
164 err = release_resource(&core_effect->mod2_chunk);
166 /* TODO: remember to change that if more FF_MOD* bits are added */
167 core_effect->flags[0] = 0;
172 static int iforce_open(struct input_dev *dev)
174 struct iforce *iforce = input_get_drvdata(dev);
176 switch (iforce->bus) {
177 #ifdef CONFIG_JOYSTICK_IFORCE_USB
179 iforce->irq->dev = iforce->usbdev;
180 if (usb_submit_urb(iforce->irq, GFP_KERNEL))
186 if (test_bit(EV_FF, dev->evbit)) {
187 /* Enable force feedback */
188 iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
194 static void iforce_close(struct input_dev *dev)
196 struct iforce *iforce = input_get_drvdata(dev);
199 if (test_bit(EV_FF, dev->evbit)) {
200 /* Check: no effects should be present in memory */
201 for (i = 0; i < dev->ff->max_effects; i++) {
202 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags)) {
204 "%s: Device still owns effects\n",
210 /* Disable force feedback playback */
211 iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
212 /* Wait for the command to complete */
213 wait_event_interruptible(iforce->wait,
214 !test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
217 switch (iforce->bus) {
218 #ifdef CONFIG_JOYSTICK_IFORCE_USB
220 usb_kill_urb(iforce->irq);
221 usb_kill_urb(iforce->out);
222 usb_kill_urb(iforce->ctrl);
225 #ifdef CONFIG_JOYSTICK_IFORCE_232
227 //TODO: Wait for the last packets to be sent
233 int iforce_init_device(struct iforce *iforce)
235 struct input_dev *input_dev;
236 struct ff_device *ff;
237 unsigned char c[] = "CEOV";
241 input_dev = input_allocate_device();
245 init_waitqueue_head(&iforce->wait);
246 spin_lock_init(&iforce->xmit_lock);
247 mutex_init(&iforce->mem_mutex);
248 iforce->xmit.buf = iforce->xmit_data;
249 iforce->dev = input_dev;
252 * Input device fields.
255 switch (iforce->bus) {
256 #ifdef CONFIG_JOYSTICK_IFORCE_USB
258 input_dev->id.bustype = BUS_USB;
259 input_dev->dev.parent = &iforce->usbdev->dev;
262 #ifdef CONFIG_JOYSTICK_IFORCE_232
264 input_dev->id.bustype = BUS_RS232;
265 input_dev->dev.parent = &iforce->serio->dev;
270 input_set_drvdata(input_dev, iforce);
272 input_dev->name = "Unknown I-Force device";
273 input_dev->open = iforce_open;
274 input_dev->close = iforce_close;
277 * On-device memory allocation.
280 iforce->device_memory.name = "I-Force device effect memory";
281 iforce->device_memory.start = 0;
282 iforce->device_memory.end = 200;
283 iforce->device_memory.flags = IORESOURCE_MEM;
284 iforce->device_memory.parent = NULL;
285 iforce->device_memory.child = NULL;
286 iforce->device_memory.sibling = NULL;
289 * Wait until device ready - until it sends its first response.
292 for (i = 0; i < 20; i++)
293 if (!iforce_get_id_packet(iforce, "O"))
296 if (i == 20) { /* 5 seconds */
297 dev_err(&input_dev->dev,
298 "Timeout waiting for response from device.\n");
307 if (!iforce_get_id_packet(iforce, "M"))
308 input_dev->id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
310 dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
312 if (!iforce_get_id_packet(iforce, "P"))
313 input_dev->id.product = (iforce->edata[2] << 8) | iforce->edata[1];
315 dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
317 if (!iforce_get_id_packet(iforce, "B"))
318 iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
320 dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
322 if (!iforce_get_id_packet(iforce, "N"))
323 ff_effects = iforce->edata[1];
325 dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
327 /* Check if the device can store more effects than the driver can really handle */
328 if (ff_effects > IFORCE_EFFECTS_MAX) {
329 dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
330 IFORCE_EFFECTS_MAX, ff_effects);
331 ff_effects = IFORCE_EFFECTS_MAX;
335 * Display additional info.
338 for (i = 0; c[i]; i++)
339 if (!iforce_get_id_packet(iforce, c + i))
340 iforce_dump_packet(iforce, "info", iforce->ecmd, iforce->edata);
343 * Disable spring, enable force feedback.
345 iforce_set_autocenter(input_dev, 0);
348 * Find appropriate device entry
351 for (i = 0; iforce_device[i].idvendor; i++)
352 if (iforce_device[i].idvendor == input_dev->id.vendor &&
353 iforce_device[i].idproduct == input_dev->id.product)
356 iforce->type = iforce_device + i;
357 input_dev->name = iforce->type->name;
360 * Set input device bitfields and ranges.
363 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
364 BIT_MASK(EV_FF_STATUS);
366 for (i = 0; iforce->type->btn[i] >= 0; i++)
367 set_bit(iforce->type->btn[i], input_dev->keybit);
369 for (i = 0; iforce->type->abs[i] >= 0; i++) {
371 signed short t = iforce->type->abs[i];
379 input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
380 set_bit(t, input_dev->ffbit);
387 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
392 input_set_abs_params(input_dev, t, -128, 127, 0, 0);
400 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
407 for (i = 0; iforce->type->ff[i] >= 0; i++)
408 set_bit(iforce->type->ff[i], input_dev->ffbit);
410 error = input_ff_create(input_dev, ff_effects);
415 ff->upload = iforce_upload_effect;
416 ff->erase = iforce_erase_effect;
417 ff->set_gain = iforce_set_gain;
418 ff->set_autocenter = iforce_set_autocenter;
419 ff->playback = iforce_playback;
422 * Register input device.
425 error = input_register_device(iforce->dev);
431 fail: input_free_device(input_dev);
435 static int __init iforce_init(void)
439 #ifdef CONFIG_JOYSTICK_IFORCE_USB
440 err = usb_register(&iforce_usb_driver);
444 #ifdef CONFIG_JOYSTICK_IFORCE_232
445 err = serio_register_driver(&iforce_serio_drv);
446 #ifdef CONFIG_JOYSTICK_IFORCE_USB
448 usb_deregister(&iforce_usb_driver);
454 static void __exit iforce_exit(void)
456 #ifdef CONFIG_JOYSTICK_IFORCE_USB
457 usb_deregister(&iforce_usb_driver);
459 #ifdef CONFIG_JOYSTICK_IFORCE_232
460 serio_unregister_driver(&iforce_serio_drv);
464 module_init(iforce_init);
465 module_exit(iforce_exit);