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