treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 156
[linux-block.git] / drivers / input / joystick / iforce / iforce-main.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 2/*
1da177e4 3 * Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
598972d4 4 * Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
1da177e4
LT
5 *
6 * USB/RS232 I-Force joysticks and wheels.
7 */
8
9/*
1da177e4
LT
10 */
11
12#include "iforce.h"
13
598972d4 14MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <johann.deneux@gmail.com>");
1da177e4
LT
15MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
16MODULE_LICENSE("GPL");
17
18static signed short btn_joystick[] =
19{ BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
6c6212aa
TS
20 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A,
21 BTN_B, BTN_C, BTN_DEAD, -1 };
1da177e4 22
0b64fa0a 23static signed short btn_joystick_avb[] =
1da177e4 24{ BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
6c6212aa 25 BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_DEAD, -1 };
1da177e4 26
0b64fa0a 27static signed short btn_wheel[] =
1da177e4
LT
28{ BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
29 BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
30
31static signed short abs_joystick[] =
32{ ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
33
d861f7bf
MV
34static signed short abs_joystick_rudder[] =
35{ ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y, -1 };
36
1da177e4
LT
37static signed short abs_avb_pegasus[] =
38{ ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
39 ABS_HAT1X, ABS_HAT1Y, -1 };
40
41static signed short abs_wheel[] =
42{ ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
43
44static 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,
47 FF_AUTOCENTER, -1 };
48
49static 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 },
0b64fa0a
TS
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 }, //?
1da177e4 56 { 0x061c, 0xc0a4, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce }, //?
68947b8f 57 { 0x061c, 0xc084, "ACT LABS Force RS", btn_wheel, abs_wheel, ff_iforce },
1da177e4 58 { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback", btn_wheel, abs_wheel, ff_iforce }, //?
d861f7bf 59 { 0x06f8, 0x0001, "Guillemot Jet Leader Force Feedback", btn_joystick, abs_joystick_rudder, ff_iforce },
1da177e4 60 { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel", btn_wheel, abs_wheel, ff_iforce }, //?
513d8be9 61 { 0x06f8, 0xa302, "Guillemot Jet Leader 3D", btn_joystick, abs_joystick, ff_iforce }, //?
b53174fb 62 { 0x06d6, 0x29bc, "Trust Force Feedback Race Master", btn_wheel, abs_wheel, ff_iforce },
1da177e4
LT
63 { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]", btn_joystick, abs_joystick, ff_iforce }
64};
65
f6a01c85 66static int iforce_playback(struct input_dev *dev, int effect_id, int value)
1da177e4 67{
4615e33f 68 struct iforce *iforce = input_get_drvdata(dev);
f6a01c85 69 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
1da177e4 70
f6a01c85
AH
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);
1da177e4 75
f6a01c85
AH
76 iforce_control_playback(iforce, effect_id, value);
77 return 0;
78}
1da177e4 79
f6a01c85
AH
80static void iforce_set_gain(struct input_dev *dev, u16 gain)
81{
4615e33f 82 struct iforce *iforce = input_get_drvdata(dev);
f6a01c85 83 unsigned char data[3];
1da177e4 84
f6a01c85
AH
85 data[0] = gain >> 9;
86 iforce_send_packet(iforce, FF_CMD_GAIN, data);
87}
1da177e4 88
f6a01c85
AH
89static void iforce_set_autocenter(struct input_dev *dev, u16 magnitude)
90{
4615e33f 91 struct iforce *iforce = input_get_drvdata(dev);
f6a01c85 92 unsigned char data[3];
1da177e4 93
f6a01c85
AH
94 data[0] = 0x03;
95 data[1] = magnitude >> 9;
96 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
1da177e4 97
f6a01c85
AH
98 data[0] = 0x04;
99 data[1] = 0x01;
100 iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
1da177e4
LT
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 */
f6a01c85 107static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
1da177e4 108{
4615e33f 109 struct iforce *iforce = input_get_drvdata(dev);
f6a01c85 110 struct iforce_core_effect *core_effect = &iforce->core_effects[effect->id];
1da177e4 111 int ret;
1da177e4 112
f6a01c85 113 if (__test_and_set_bit(FF_CORE_IS_USED, core_effect->flags)) {
1da177e4 114 /* Check the effect is not already being updated */
f6a01c85 115 if (test_bit(FF_CORE_UPDATE, core_effect->flags))
1da177e4 116 return -EAGAIN;
1da177e4
LT
117 }
118
119/*
120 * Upload the effect
121 */
122 switch (effect->type) {
123
124 case FF_PERIODIC:
f6a01c85 125 ret = iforce_upload_periodic(iforce, effect, old);
1da177e4
LT
126 break;
127
128 case FF_CONSTANT:
f6a01c85 129 ret = iforce_upload_constant(iforce, effect, old);
1da177e4
LT
130 break;
131
132 case FF_SPRING:
133 case FF_DAMPER:
f6a01c85 134 ret = iforce_upload_condition(iforce, effect, old);
1da177e4
LT
135 break;
136
137 default:
138 return -EINVAL;
139 }
f6a01c85 140
1da177e4
LT
141 if (ret == 0) {
142 /* A packet was sent, forbid new updates until we are notified
143 * that the packet was updated
144 */
f6a01c85 145 set_bit(FF_CORE_UPDATE, core_effect->flags);
1da177e4 146 }
1da177e4
LT
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 */
154static int iforce_erase_effect(struct input_dev *dev, int effect_id)
155{
4615e33f 156 struct iforce *iforce = input_get_drvdata(dev);
f6a01c85 157 struct iforce_core_effect *core_effect = &iforce->core_effects[effect_id];
1da177e4 158 int err = 0;
1da177e4
LT
159
160 if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
8d64d372 161 err = release_resource(&core_effect->mod1_chunk);
1da177e4
LT
162
163 if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
8d64d372 164 err = release_resource(&core_effect->mod2_chunk);
1da177e4 165
f6a01c85 166 /* TODO: remember to change that if more FF_MOD* bits are added */
1da177e4
LT
167 core_effect->flags[0] = 0;
168
169 return err;
170}
171
172static int iforce_open(struct input_dev *dev)
173{
4615e33f 174 struct iforce *iforce = input_get_drvdata(dev);
1da177e4
LT
175
176 switch (iforce->bus) {
177#ifdef CONFIG_JOYSTICK_IFORCE_USB
178 case IFORCE_USB:
179 iforce->irq->dev = iforce->usbdev;
180 if (usb_submit_urb(iforce->irq, GFP_KERNEL))
181 return -EIO;
182 break;
183#endif
184 }
185
f6a01c85
AH
186 if (test_bit(EV_FF, dev->evbit)) {
187 /* Enable force feedback */
188 iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
189 }
1da177e4
LT
190
191 return 0;
192}
193
98b7fb04 194static void iforce_close(struct input_dev *dev)
1da177e4 195{
4615e33f 196 struct iforce *iforce = input_get_drvdata(dev);
1da177e4
LT
197 int i;
198
f6a01c85
AH
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)) {
1817b169
GKH
203 dev_warn(&dev->dev,
204 "%s: Device still owns effects\n",
205 __func__);
f6a01c85 206 break;
1da177e4
LT
207 }
208 }
209
f6a01c85
AH
210 /* Disable force feedback playback */
211 iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
c2b27ef6
DT
212 /* Wait for the command to complete */
213 wait_event_interruptible(iforce->wait,
214 !test_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags));
1da177e4 215 }
1da177e4 216
1da177e4
LT
217 switch (iforce->bus) {
218#ifdef CONFIG_JOYSTICK_IFORCE_USB
219 case IFORCE_USB:
98b7fb04
DT
220 usb_kill_urb(iforce->irq);
221 usb_kill_urb(iforce->out);
222 usb_kill_urb(iforce->ctrl);
1da177e4
LT
223 break;
224#endif
225#ifdef CONFIG_JOYSTICK_IFORCE_232
226 case IFORCE_232:
227 //TODO: Wait for the last packets to be sent
228 break;
229#endif
230 }
231}
232
233int iforce_init_device(struct iforce *iforce)
234{
17dd3f0f 235 struct input_dev *input_dev;
f6a01c85 236 struct ff_device *ff;
1da177e4 237 unsigned char c[] = "CEOV";
f6a01c85
AH
238 int i, error;
239 int ff_effects = 0;
1da177e4 240
17dd3f0f 241 input_dev = input_allocate_device();
5ae08f80 242 if (!input_dev)
17dd3f0f
DT
243 return -ENOMEM;
244
1da177e4
LT
245 init_waitqueue_head(&iforce->wait);
246 spin_lock_init(&iforce->xmit_lock);
72ba9f0c 247 mutex_init(&iforce->mem_mutex);
1da177e4 248 iforce->xmit.buf = iforce->xmit_data;
17dd3f0f 249 iforce->dev = input_dev;
1da177e4
LT
250
251/*
252 * Input device fields.
253 */
254
255 switch (iforce->bus) {
256#ifdef CONFIG_JOYSTICK_IFORCE_USB
257 case IFORCE_USB:
17dd3f0f 258 input_dev->id.bustype = BUS_USB;
935e658e 259 input_dev->dev.parent = &iforce->usbdev->dev;
1da177e4
LT
260 break;
261#endif
262#ifdef CONFIG_JOYSTICK_IFORCE_232
263 case IFORCE_232:
17dd3f0f 264 input_dev->id.bustype = BUS_RS232;
935e658e 265 input_dev->dev.parent = &iforce->serio->dev;
1da177e4
LT
266 break;
267#endif
268 }
269
4615e33f
DT
270 input_set_drvdata(input_dev, iforce);
271
17dd3f0f
DT
272 input_dev->name = "Unknown I-Force device";
273 input_dev->open = iforce_open;
98b7fb04 274 input_dev->close = iforce_close;
1da177e4
LT
275
276/*
277 * On-device memory allocation.
278 */
279
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;
287
288/*
289 * Wait until device ready - until it sends its first response.
290 */
291
292 for (i = 0; i < 20; i++)
293 if (!iforce_get_id_packet(iforce, "O"))
294 break;
295
296 if (i == 20) { /* 5 seconds */
7b22a885
GKH
297 dev_err(&input_dev->dev,
298 "Timeout waiting for response from device.\n");
127278ce
DT
299 error = -ENODEV;
300 goto fail;
1da177e4
LT
301 }
302
303/*
304 * Get device info.
305 */
306
307 if (!iforce_get_id_packet(iforce, "M"))
17dd3f0f 308 input_dev->id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
1da177e4 309 else
1817b169 310 dev_warn(&iforce->dev->dev, "Device does not respond to id packet M\n");
1da177e4
LT
311
312 if (!iforce_get_id_packet(iforce, "P"))
17dd3f0f 313 input_dev->id.product = (iforce->edata[2] << 8) | iforce->edata[1];
1da177e4 314 else
1817b169 315 dev_warn(&iforce->dev->dev, "Device does not respond to id packet P\n");
1da177e4
LT
316
317 if (!iforce_get_id_packet(iforce, "B"))
318 iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
319 else
1817b169 320 dev_warn(&iforce->dev->dev, "Device does not respond to id packet B\n");
1da177e4
LT
321
322 if (!iforce_get_id_packet(iforce, "N"))
f6a01c85 323 ff_effects = iforce->edata[1];
1da177e4 324 else
1817b169 325 dev_warn(&iforce->dev->dev, "Device does not respond to id packet N\n");
1da177e4
LT
326
327 /* Check if the device can store more effects than the driver can really handle */
f6a01c85 328 if (ff_effects > IFORCE_EFFECTS_MAX) {
1817b169 329 dev_warn(&iforce->dev->dev, "Limiting number of effects to %d (device reports %d)\n",
f6a01c85
AH
330 IFORCE_EFFECTS_MAX, ff_effects);
331 ff_effects = IFORCE_EFFECTS_MAX;
1da177e4
LT
332 }
333
334/*
335 * Display additional info.
336 */
337
338 for (i = 0; c[i]; i++)
339 if (!iforce_get_id_packet(iforce, c + i))
305180bc 340 iforce_dump_packet(iforce, "info", iforce->ecmd, iforce->edata);
1da177e4
LT
341
342/*
343 * Disable spring, enable force feedback.
1da177e4 344 */
c0338c15 345 iforce_set_autocenter(input_dev, 0);
1da177e4
LT
346
347/*
348 * Find appropriate device entry
349 */
350
351 for (i = 0; iforce_device[i].idvendor; i++)
17dd3f0f
DT
352 if (iforce_device[i].idvendor == input_dev->id.vendor &&
353 iforce_device[i].idproduct == input_dev->id.product)
1da177e4
LT
354 break;
355
356 iforce->type = iforce_device + i;
17dd3f0f 357 input_dev->name = iforce->type->name;
1da177e4
LT
358
359/*
360 * Set input device bitfields and ranges.
361 */
362
7b19ada2
JS
363 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
364 BIT_MASK(EV_FF_STATUS);
1da177e4 365
f6a01c85
AH
366 for (i = 0; iforce->type->btn[i] >= 0; i++)
367 set_bit(iforce->type->btn[i], input_dev->keybit);
1da177e4
LT
368
369 for (i = 0; iforce->type->abs[i] >= 0; i++) {
370
371 signed short t = iforce->type->abs[i];
1da177e4
LT
372
373 switch (t) {
374
375 case ABS_X:
376 case ABS_Y:
377 case ABS_WHEEL:
378
17dd3f0f
DT
379 input_set_abs_params(input_dev, t, -1920, 1920, 16, 128);
380 set_bit(t, input_dev->ffbit);
1da177e4
LT
381 break;
382
383 case ABS_THROTTLE:
384 case ABS_GAS:
385 case ABS_BRAKE:
386
17dd3f0f 387 input_set_abs_params(input_dev, t, 0, 255, 0, 0);
1da177e4
LT
388 break;
389
390 case ABS_RUDDER:
391
17dd3f0f 392 input_set_abs_params(input_dev, t, -128, 127, 0, 0);
1da177e4
LT
393 break;
394
395 case ABS_HAT0X:
396 case ABS_HAT0Y:
397 case ABS_HAT1X:
398 case ABS_HAT1Y:
17dd3f0f
DT
399
400 input_set_abs_params(input_dev, t, -1, 1, 0, 0);
1da177e4
LT
401 break;
402 }
403 }
404
f6a01c85 405 if (ff_effects) {
1da177e4 406
f6a01c85
AH
407 for (i = 0; iforce->type->ff[i] >= 0; i++)
408 set_bit(iforce->type->ff[i], input_dev->ffbit);
409
410 error = input_ff_create(input_dev, ff_effects);
127278ce
DT
411 if (error)
412 goto fail;
f6a01c85
AH
413
414 ff = input_dev->ff;
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;
420 }
1da177e4
LT
421/*
422 * Register input device.
423 */
424
127278ce
DT
425 error = input_register_device(iforce->dev);
426 if (error)
427 goto fail;
1da177e4 428
1da177e4 429 return 0;
127278ce
DT
430
431 fail: input_free_device(input_dev);
432 return error;
1da177e4
LT
433}
434
435static int __init iforce_init(void)
436{
153a9df0
AM
437 int err = 0;
438
1da177e4 439#ifdef CONFIG_JOYSTICK_IFORCE_USB
153a9df0
AM
440 err = usb_register(&iforce_usb_driver);
441 if (err)
442 return err;
1da177e4
LT
443#endif
444#ifdef CONFIG_JOYSTICK_IFORCE_232
153a9df0
AM
445 err = serio_register_driver(&iforce_serio_drv);
446#ifdef CONFIG_JOYSTICK_IFORCE_USB
447 if (err)
448 usb_deregister(&iforce_usb_driver);
1da177e4 449#endif
153a9df0
AM
450#endif
451 return err;
1da177e4
LT
452}
453
454static void __exit iforce_exit(void)
455{
456#ifdef CONFIG_JOYSTICK_IFORCE_USB
457 usb_deregister(&iforce_usb_driver);
458#endif
459#ifdef CONFIG_JOYSTICK_IFORCE_232
460 serio_unregister_driver(&iforce_serio_drv);
461#endif
462}
463
464module_init(iforce_init);
465module_exit(iforce_exit);