1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
4 * Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
5 *
6 * USB/RS232 I-Force joysticks and wheels.
7 */
8
9 #include <linux/export.h>
10 #include <linux/unaligned.h>
11 #include "iforce.h"
12
13 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
14 MODULE_DESCRIPTION("Core I-Force joysticks and wheels driver");
15 MODULE_LICENSE("GPL");
16
17 static signed short btn_joystick[] =
18 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
19 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A,
20 BTN_B, BTN_C, BTN_DEAD, -1 };
21
22 static signed short btn_joystick_avb[] =
23 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
24 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_DEAD, -1 };
25
26 static signed short btn_wheel[] =
27 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
28 BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
29
30 static signed short abs_joystick[] =
31 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
32
33 static signed short abs_joystick_rudder[] =
34 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y, -1 };
35
36 static signed short abs_avb_pegasus[] =
37 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
38 ABS_HAT1X, ABS_HAT1Y, -1 };
39
40 static signed short abs_wheel[] =
41 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
42
43 static signed short ff_iforce[] =
44 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
45 FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
46 FF_AUTOCENTER, -1 };
47
48 static struct iforce_device iforce_device[] = {
49 { 0x044f, 0xa01c, "Thrustmaster Motor Sport GT", btn_wheel, abs_wheel, ff_iforce },
50 { 0x046d, 0xc281, "Logitech WingMan Force", btn_joystick, abs_joystick, ff_iforce },
51 { 0x046d, 0xc291, "Logitech WingMan Formula Force", btn_wheel, abs_wheel, ff_iforce },
52 { 0x05ef, 0x020a, "AVB Top Shot Pegasus", btn_joystick_avb, abs_avb_pegasus, ff_iforce },
53 { 0x05ef, 0x8884, "AVB Mag Turbo Force", btn_wheel, abs_wheel, ff_iforce },
54 { 0x05ef, 0x8886, "Boeder Force Feedback Wheel", 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 { 0x06a3, 0xff04, "Saitek R440 Force Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
59 { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback", btn_wheel, abs_wheel, ff_iforce }, //?
60 { 0x06f8, 0x0001, "Guillemot Jet Leader Force Feedback", btn_joystick, abs_joystick_rudder, ff_iforce },
61 { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
62 { 0x06f8, 0xa302, "Guillemot Jet Leader 3D", btn_joystick, abs_joystick, ff_iforce }, //?
63 { 0x06d6, 0x29bc, "Trust Force Feedback Race Master", btn_wheel, abs_wheel, ff_iforce },
64 { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]", btn_joystick, abs_joystick, ff_iforce }
65 };
66
iforce_playback(struct input_dev * dev,int effect_id,int value)67 static int iforce_playback(struct input_dev *dev, int effect_id, int value)
68 {
69 struct iforce *iforce = input_get_drvdata(dev);
70 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
71
72 if (value > 0)
73 set_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
74 else
75 clear_bit(FF_CORE_SHOULD_PLAY, core_effect->flags);
76
77 iforce_control_playback(iforce, effect_id, value);
78 return 0;
79 }
80
iforce_set_gain(struct input_dev * dev,u16 gain)81 static void iforce_set_gain(struct input_dev *dev, u16 gain)
82 {
83 struct iforce *iforce = input_get_drvdata(dev);
84 unsigned char data[3];
85
86 data[0] = gain >> 9;
87 iforce_send_packet(iforce, FF_CMD_GAIN, data);
88 }
89
iforce_set_autocenter(struct input_dev * dev,u16 magnitude)90 static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
91 {
92 struct iforce *iforce = input_get_drvdata(dev);
93 unsigned char data[3];
94
95 data[0] = 0x03;
96 data[1] = magnitude >> 9;
97 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
98
99 data[0] = 0x04;
100 data[1] = 0x01;
101 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
102 }
103
104 /*
105 * Function called when an ioctl is performed on the event dev entry.
106 * It uploads an effect to the device
107 */
iforce_upload_effect(struct input_dev * dev,struct ff_effect * effect,struct ff_effect * old)108 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
109 {
110 struct iforce *iforce = input_get_drvdata(dev);
111 struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
112 int ret;
113
114 if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
115 /* Check the effect is not already being updated */
116 if (test_bit(FF_CORE_UPDATE, core_effect->flags))
117 return -EAGAIN;
118 }
119
120 /*
121 * Upload the effect
122 */
123 switch (effect->type) {
124 case FF_PERIODIC:
125 ret = iforce_upload_periodic(iforce, effect, old);
126 break;
127
128 case FF_CONSTANT:
129 ret = iforce_upload_constant(iforce, effect, old);
130 break;
131
132 case FF_SPRING:
133 case FF_DAMPER:
134 ret = iforce_upload_condition(iforce, effect, old);
135 break;
136
137 default:
138 return -EINVAL;
139 }
140
141 if (ret == 0) {
142 /* A packet was sent, forbid new updates until we are notified
143 * that the packet was updated
144 */
145 set_bit(FF_CORE_UPDATE, core_effect->flags);
146 }
147 return ret;
148 }
149
150 /*
151 * Erases an effect: it frees the effect id and mark as unused the memory
152 * allocated for the parameters
153 */
iforce_erase_effect(struct input_dev * dev,int effect_id)154 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
155 {
156 struct iforce *iforce = input_get_drvdata(dev);
157 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
158 int err = 0;
159
160 if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
161 err = release_resource(&core_effect->mod1_chunk);
162
163 if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
164 err = release_resource(&core_effect->mod2_chunk);
165
166 /* TODO: remember to change that if more FF_MOD* bits are added */
167 core_effect->flags[0] = 0;
168
169 return err;
170 }
171
iforce_open(struct input_dev * dev)172 static int iforce_open(struct input_dev *dev)
173 {
174 struct iforce *iforce = input_get_drvdata(dev);
175
176 iforce->xport_ops->start_io(iforce);
177
178 if (test_bit(EV_FF, dev->evbit)) {
179 /* Enable force feedback */
180 iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
181 }
182
183 return 0;
184 }
185
iforce_close(struct input_dev * dev)186 static void iforce_close(struct input_dev *dev)
187 {
188 struct iforce *iforce = input_get_drvdata(dev);
189 int i;
190
191 if (test_bit(EV_FF, dev->evbit)) {
192 /* Check: no effects should be present in memory */
193 for (i = 0; i < dev->ff->max_effects; i++) {
194 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags)) {
195 dev_warn(&dev->dev,
196 "%s: Device still owns effects\n",
197 __func__);
198 break;
199 }
200 }
201
202 /* Disable force feedback playback */
203 iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
204 /* Wait for the command to complete */
205 wait_event_interruptible(iforce->wait,
206 !test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
207 }
208
209 iforce->xport_ops->stop_io(iforce);
210 }
211
iforce_init_device(struct device * parent,u16 bustype,struct iforce * iforce)212 int iforce_init_device(struct device *parent, u16 bustype,
213 struct iforce *iforce)
214 {
215 struct input_dev *input_dev;
216 struct ff_device *ff;
217 u8 c[] = "CEOV";
218 u8 buf[IFORCE_MAX_LENGTH];
219 size_t len;
220 int i, error;
221 int ff_effects = 0;
222
223 input_dev = input_allocate_device();
224 if (!input_dev)
225 return -ENOMEM;
226
227 init_waitqueue_head(&iforce->wait);
228 spin_lock_init(&iforce->xmit_lock);
229 mutex_init(&iforce->mem_mutex);
230 iforce->xmit.buf = iforce->xmit_data;
231 iforce->dev = input_dev;
232
233 /*
234 * Input device fields.
235 */
236
237 input_dev->id.bustype = bustype;
238 input_dev->dev.parent = parent;
239
240 input_set_drvdata(input_dev, iforce);
241
242 input_dev->name = "Unknown I-Force device";
243 input_dev->open = iforce_open;
244 input_dev->close = iforce_close;
245
246 /*
247 * On-device memory allocation.
248 */
249
250 iforce->device_memory.name = "I-Force device effect memory";
251 iforce->device_memory.start = 0;
252 iforce->device_memory.end = 200;
253 iforce->device_memory.flags = IORESOURCE_MEM;
254 iforce->device_memory.parent = NULL;
255 iforce->device_memory.child = NULL;
256 iforce->device_memory.sibling = NULL;
257
258 /*
259 * Wait until device ready - until it sends its first response.
260 */
261
262 for (i = 0; i < 20; i++)
263 if (!iforce_get_id_packet(iforce, 'O', buf, &len))
264 break;
265
266 if (i == 20) { /* 5 seconds */
267 dev_err(&input_dev->dev,
268 "Timeout waiting for response from device.\n");
269 error = -ENODEV;
270 goto fail;
271 }
272
273 /*
274 * Get device info.
275 */
276
277 if (!iforce_get_id_packet(iforce, 'M', buf, &len) && len >= 3)
278 input_dev->id.vendor = get_unaligned_le16(buf + 1);
279 else
280 dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
281
282 if (!iforce_get_id_packet(iforce, 'P', buf, &len) && len >= 3)
283 input_dev->id.product = get_unaligned_le16(buf + 1);
284 else
285 dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
286
287 if (!iforce_get_id_packet(iforce, 'B', buf, &len) && len >= 3)
288 iforce->device_memory.end = get_unaligned_le16(buf + 1);
289 else
290 dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
291
292 if (!iforce_get_id_packet(iforce, 'N', buf, &len) && len >= 2)
293 ff_effects = buf[1];
294 else
295 dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
296
297 /* Check if the device can store more effects than the driver can really handle */
298 if (ff_effects > IFORCE_EFFECTS_MAX) {
299 dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
300 IFORCE_EFFECTS_MAX, ff_effects);
301 ff_effects = IFORCE_EFFECTS_MAX;
302 }
303
304 /*
305 * Display additional info.
306 */
307
308 for (i = 0; c[i]; i++)
309 if (!iforce_get_id_packet(iforce, c[i], buf, &len))
310 iforce_dump_packet(iforce, "info",
311 (FF_CMD_QUERY & 0xff00) | len, buf);
312
313 /*
314 * Disable spring, enable force feedback.
315 */
316 iforce_set_autocenter(input_dev, 0);
317
318 /*
319 * Find appropriate device entry
320 */
321
322 for (i = 0; iforce_device[i].idvendor; i++)
323 if (iforce_device[i].idvendor == input_dev->id.vendor &&
324 iforce_device[i].idproduct == input_dev->id.product)
325 break;
326
327 iforce->type = iforce_device + i;
328 input_dev->name = iforce->type->name;
329
330 /*
331 * Set input device bitfields and ranges.
332 */
333
334 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
335 BIT_MASK(EV_FF_STATUS);
336
337 for (i = 0; iforce->type->btn[i] >= 0; i++)
338 set_bit(iforce->type->btn[i], input_dev->keybit);
339
340 for (i = 0; iforce->type->abs[i] >= 0; i++) {
341
342 signed short t = iforce->type->abs[i];
343
344 switch (t) {
345 case ABS_X:
346 case ABS_Y:
347 case ABS_WHEEL:
348 input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
349 set_bit(t, input_dev->ffbit);
350 break;
351
352 case ABS_THROTTLE:
353 case ABS_GAS:
354 case ABS_BRAKE:
355 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
356 break;
357
358 case ABS_RUDDER:
359 input_set_abs_params(input_dev, t, -128, 127, 0, 0);
360 break;
361
362 case ABS_HAT0X:
363 case ABS_HAT0Y:
364 case ABS_HAT1X:
365 case ABS_HAT1Y:
366 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
367 break;
368 }
369 }
370
371 if (ff_effects) {
372
373 for (i = 0; iforce->type->ff[i] >= 0; i++)
374 set_bit(iforce->type->ff[i], input_dev->ffbit);
375
376 error = input_ff_create(input_dev, ff_effects);
377 if (error)
378 goto fail;
379
380 ff = input_dev->ff;
381 ff->upload = iforce_upload_effect;
382 ff->erase = iforce_erase_effect;
383 ff->set_gain = iforce_set_gain;
384 ff->set_autocenter = iforce_set_autocenter;
385 ff->playback = iforce_playback;
386 }
387 /*
388 * Register input device.
389 */
390
391 error = input_register_device(iforce->dev);
392 if (error)
393 goto fail;
394
395 return 0;
396
397 fail: input_free_device(input_dev);
398 return error;
399 }
400 EXPORT_SYMBOL(iforce_init_device);
401