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.
12 #include <asm/unaligned.h>
15 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
16 MODULE_DESCRIPTION("Core I-Force joysticks and wheels driver");
17 MODULE_LICENSE("GPL");
19 static signed short btn_joystick[] =
20 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
21 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A,
22 BTN_B, BTN_C, BTN_DEAD, -1 };
24 static signed short btn_joystick_avb[] =
25 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
26 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_DEAD, -1 };
28 static signed short btn_wheel[] =
29 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
30 BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
32 static signed short abs_joystick[] =
33 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
35 static signed short abs_joystick_rudder[] =
36 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y, -1 };
38 static signed short abs_avb_pegasus[] =
39 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
40 ABS_HAT1X, ABS_HAT1Y, -1 };
42 static signed short abs_wheel[] =
43 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
45 static signed short ff_iforce[] =
46 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
47 FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
50 static struct iforce_device iforce_device[] = {
51 { 0x044f, 0xa01c, "Thrustmaster Motor Sport GT", btn_wheel, abs_wheel, ff_iforce },
52 { 0x046d, 0xc281, "Logitech WingMan Force", btn_joystick, abs_joystick, ff_iforce },
53 { 0x046d, 0xc291, "Logitech WingMan Formula Force", btn_wheel, abs_wheel, ff_iforce },
54 { 0x05ef, 0x020a, "AVB Top Shot Pegasus", btn_joystick_avb, abs_avb_pegasus, ff_iforce },
55 { 0x05ef, 0x8884, "AVB Mag Turbo Force", btn_wheel, abs_wheel, ff_iforce },
56 { 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
57 { 0x061c, 0xc0a4, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce }, //?
58 { 0x061c, 0xc084, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce },
59 { 0x06a3, 0xff04, "Saitek R440 Force Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
60 { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback", btn_wheel, abs_wheel, ff_iforce }, //?
61 { 0x06f8, 0x0001, "Guillemot Jet Leader Force Feedback", btn_joystick, abs_joystick_rudder, ff_iforce },
62 { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
63 { 0x06f8, 0xa302, "Guillemot Jet Leader 3D", btn_joystick, abs_joystick, ff_iforce }, //?
64 { 0x06d6, 0x29bc, "Trust Force Feedback Race Master", btn_wheel, abs_wheel, ff_iforce },
65 { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]", btn_joystick, abs_joystick, ff_iforce }
68 static int iforce_playback(struct input_dev *dev, int effect_id, int value)
70 struct iforce *iforce = input_get_drvdata(dev);
71 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
74 set_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
76 clear_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
78 iforce_control_playback(iforce, effect_id, value);
82 static void iforce_set_gain(struct input_dev *dev, u16 gain)
84 struct iforce *iforce = input_get_drvdata(dev);
85 unsigned char data[3];
88 iforce_send_packet(iforce, FF_CMD_GAIN, data);
91 static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
93 struct iforce *iforce = input_get_drvdata(dev);
94 unsigned char data[3];
97 data[1] = magnitude >> 9;
98 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
102 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
106 * Function called when an ioctl is performed on the event dev entry.
107 * It uploads an effect to the device
109 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
111 struct iforce *iforce = input_get_drvdata(dev);
112 struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
115 if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
116 /* Check the effect is not already being updated */
117 if (test_bit(FF_CORE_UPDATE, core_effect->flags))
124 switch (effect->type) {
126 ret = iforce_upload_periodic(iforce, effect, old);
130 ret = iforce_upload_constant(iforce, effect, old);
135 ret = iforce_upload_condition(iforce, effect, old);
143 /* A packet was sent, forbid new updates until we are notified
144 * that the packet was updated
146 set_bit(FF_CORE_UPDATE, core_effect->flags);
152 * Erases an effect: it frees the effect id and mark as unused the memory
153 * allocated for the parameters
155 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
157 struct iforce *iforce = input_get_drvdata(dev);
158 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
161 if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
162 err = release_resource(&core_effect->mod1_chunk);
164 if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
165 err = release_resource(&core_effect->mod2_chunk);
167 /* TODO: remember to change that if more FF_MOD* bits are added */
168 core_effect->flags[0] = 0;
173 static int iforce_open(struct input_dev *dev)
175 struct iforce *iforce = input_get_drvdata(dev);
177 iforce->xport_ops->start_io(iforce);
179 if (test_bit(EV_FF, dev->evbit)) {
180 /* Enable force feedback */
181 iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
187 static void iforce_close(struct input_dev *dev)
189 struct iforce *iforce = input_get_drvdata(dev);
192 if (test_bit(EV_FF, dev->evbit)) {
193 /* Check: no effects should be present in memory */
194 for (i = 0; i < dev->ff->max_effects; i++) {
195 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags)) {
197 "%s: Device still owns effects\n",
203 /* Disable force feedback playback */
204 iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
205 /* Wait for the command to complete */
206 wait_event_interruptible(iforce->wait,
207 !test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
210 iforce->xport_ops->stop_io(iforce);
213 int iforce_init_device(struct device *parent, u16 bustype,
214 struct iforce *iforce)
216 struct input_dev *input_dev;
217 struct ff_device *ff;
219 u8 buf[IFORCE_MAX_LENGTH];
224 input_dev = input_allocate_device();
228 init_waitqueue_head(&iforce->wait);
229 spin_lock_init(&iforce->xmit_lock);
230 mutex_init(&iforce->mem_mutex);
231 iforce->xmit.buf = iforce->xmit_data;
232 iforce->dev = input_dev;
235 * Input device fields.
238 input_dev->id.bustype = bustype;
239 input_dev->dev.parent = parent;
241 input_set_drvdata(input_dev, iforce);
243 input_dev->name = "Unknown I-Force device";
244 input_dev->open = iforce_open;
245 input_dev->close = iforce_close;
248 * On-device memory allocation.
251 iforce->device_memory.name = "I-Force device effect memory";
252 iforce->device_memory.start = 0;
253 iforce->device_memory.end = 200;
254 iforce->device_memory.flags = IORESOURCE_MEM;
255 iforce->device_memory.parent = NULL;
256 iforce->device_memory.child = NULL;
257 iforce->device_memory.sibling = NULL;
260 * Wait until device ready - until it sends its first response.
263 for (i = 0; i < 20; i++)
264 if (!iforce_get_id_packet(iforce, 'O', buf, &len))
267 if (i == 20) { /* 5 seconds */
268 dev_err(&input_dev->dev,
269 "Timeout waiting for response from device.\n");
278 if (!iforce_get_id_packet(iforce, 'M', buf, &len) || len < 3)
279 input_dev->id.vendor = get_unaligned_le16(buf + 1);
281 dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
283 if (!iforce_get_id_packet(iforce, 'P', buf, &len) || len < 3)
284 input_dev->id.product = get_unaligned_le16(buf + 1);
286 dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
288 if (!iforce_get_id_packet(iforce, 'B', buf, &len) || len < 3)
289 iforce->device_memory.end = get_unaligned_le16(buf + 1);
291 dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
293 if (!iforce_get_id_packet(iforce, 'N', buf, &len) || len < 2)
296 dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
298 /* Check if the device can store more effects than the driver can really handle */
299 if (ff_effects > IFORCE_EFFECTS_MAX) {
300 dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
301 IFORCE_EFFECTS_MAX, ff_effects);
302 ff_effects = IFORCE_EFFECTS_MAX;
306 * Display additional info.
309 for (i = 0; c[i]; i++)
310 if (!iforce_get_id_packet(iforce, c[i], buf, &len))
311 iforce_dump_packet(iforce, "info",
312 (FF_CMD_QUERY & 0xff00) | len, buf);
315 * Disable spring, enable force feedback.
317 iforce_set_autocenter(input_dev, 0);
320 * Find appropriate device entry
323 for (i = 0; iforce_device[i].idvendor; i++)
324 if (iforce_device[i].idvendor == input_dev->id.vendor &&
325 iforce_device[i].idproduct == input_dev->id.product)
328 iforce->type = iforce_device + i;
329 input_dev->name = iforce->type->name;
332 * Set input device bitfields and ranges.
335 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
336 BIT_MASK(EV_FF_STATUS);
338 for (i = 0; iforce->type->btn[i] >= 0; i++)
339 set_bit(iforce->type->btn[i], input_dev->keybit);
341 for (i = 0; iforce->type->abs[i] >= 0; i++) {
343 signed short t = iforce->type->abs[i];
349 input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
350 set_bit(t, input_dev->ffbit);
356 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
360 input_set_abs_params(input_dev, t, -128, 127, 0, 0);
367 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
374 for (i = 0; iforce->type->ff[i] >= 0; i++)
375 set_bit(iforce->type->ff[i], input_dev->ffbit);
377 error = input_ff_create(input_dev, ff_effects);
382 ff->upload = iforce_upload_effect;
383 ff->erase = iforce_erase_effect;
384 ff->set_gain = iforce_set_gain;
385 ff->set_autocenter = iforce_set_autocenter;
386 ff->playback = iforce_playback;
389 * Register input device.
392 error = input_register_device(iforce->dev);
398 fail: input_free_device(input_dev);
401 EXPORT_SYMBOL(iforce_init_device);