Merge with rsync://rsync.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
[linux-2.6] / drivers / input / joystick / iforce / iforce-main.c
1 /*
2  * $Id: iforce-main.c,v 1.19 2002/07/07 10:22:50 jdeneux Exp $
3  *
4  *  Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
5  *  Copyright (c) 2001-2002 Johann Deneux <deneux@ifrance.com>
6  *
7  *  USB/RS232 I-Force joysticks and wheels.
8  */
9
10 /*
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24  *
25  * Should you need to contact me, the author, you can do so either by
26  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
27  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
28  */
29
30 #include "iforce.h"
31
32 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>, Johann Deneux <deneux@ifrance.com>");
33 MODULE_DESCRIPTION("USB/RS232 I-Force joysticks and wheels driver");
34 MODULE_LICENSE("GPL");
35
36 static signed short btn_joystick[] =
37 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
38   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
39
40 static signed short btn_avb_pegasus[] =
41 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
42   BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
43
44 static signed short btn_wheel[] =
45 { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE,
46   BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_A, BTN_B, BTN_C, -1 };
47
48 static signed short btn_avb_tw[] =
49 { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE,
50   BTN_BASE2, BTN_BASE3, BTN_BASE4, -1 };
51
52 static signed short btn_avb_wheel[] =
53 { BTN_GEAR_DOWN, BTN_GEAR_UP, BTN_BASE, BTN_BASE2, BTN_BASE3,
54   BTN_BASE4, BTN_BASE5, BTN_BASE6, -1 };
55
56 static signed short abs_joystick[] =
57 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
58
59 static signed short abs_avb_pegasus[] =
60 { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RUDDER, ABS_HAT0X, ABS_HAT0Y,
61   ABS_HAT1X, ABS_HAT1Y, -1 };
62
63 static signed short abs_wheel[] =
64 { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, -1 };
65
66 static signed short ff_iforce[] =
67 { FF_PERIODIC, FF_CONSTANT, FF_SPRING, FF_DAMPER,
68   FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP, FF_SAW_DOWN, FF_GAIN,
69   FF_AUTOCENTER, -1 };
70
71 static struct iforce_device iforce_device[] = {
72         { 0x044f, 0xa01c, "Thrustmaster Motor Sport GT",                btn_wheel, abs_wheel, ff_iforce },
73         { 0x046d, 0xc281, "Logitech WingMan Force",                     btn_joystick, abs_joystick, ff_iforce },
74         { 0x046d, 0xc291, "Logitech WingMan Formula Force",             btn_wheel, abs_wheel, ff_iforce },
75         { 0x05ef, 0x020a, "AVB Top Shot Pegasus",                       btn_avb_pegasus, abs_avb_pegasus, ff_iforce },
76         { 0x05ef, 0x8884, "AVB Mag Turbo Force",                        btn_avb_wheel, abs_wheel, ff_iforce },
77         { 0x05ef, 0x8888, "AVB Top Shot Force Feedback Racing Wheel",   btn_avb_tw, abs_wheel, ff_iforce }, //?
78         { 0x061c, 0xc0a4, "ACT LABS Force RS",                          btn_wheel, abs_wheel, ff_iforce }, //?
79         { 0x06f8, 0x0001, "Guillemot Race Leader Force Feedback",       btn_wheel, abs_wheel, ff_iforce }, //?
80         { 0x06f8, 0x0004, "Guillemot Force Feedback Racing Wheel",      btn_wheel, abs_wheel, ff_iforce }, //?
81         { 0x06f8, 0x0004, "Gullemot Jet Leader 3D",                     btn_joystick, abs_joystick, ff_iforce }, //?
82         { 0x0000, 0x0000, "Unknown I-Force Device [%04x:%04x]",         btn_joystick, abs_joystick, ff_iforce }
83 };
84
85
86
87 static int iforce_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
88 {
89         struct iforce* iforce = (struct iforce*)(dev->private);
90         unsigned char data[3];
91
92         if (type != EV_FF)
93                 return -1;
94
95         switch (code) {
96
97                 case FF_GAIN:
98
99                         data[0] = value >> 9;
100                         iforce_send_packet(iforce, FF_CMD_GAIN, data);
101
102                         return 0;
103
104                 case FF_AUTOCENTER:
105
106                         data[0] = 0x03;
107                         data[1] = value >> 9;
108                         iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
109
110                         data[0] = 0x04;
111                         data[1] = 0x01;
112                         iforce_send_packet(iforce, FF_CMD_AUTOCENTER, data);
113
114                         return 0;
115
116                 default: /* Play or stop an effect */
117
118                         if (!CHECK_OWNERSHIP(code, iforce)) {
119                                 return -1;
120                         }
121                         if (value > 0) {
122                                 set_bit(FF_CORE_SHOULD_PLAY, iforce->core_effects[code].flags);
123                         }
124                         else {
125                                 clear_bit(FF_CORE_SHOULD_PLAY, iforce->core_effects[code].flags);
126                         }
127
128                         iforce_control_playback(iforce, code, value);
129                         return 0;
130         }
131
132         return -1;
133 }
134
135 /*
136  * Function called when an ioctl is performed on the event dev entry.
137  * It uploads an effect to the device
138  */
139 static int iforce_upload_effect(struct input_dev *dev, struct ff_effect *effect)
140 {
141         struct iforce* iforce = (struct iforce*)(dev->private);
142         int id;
143         int ret;
144         int is_update;
145
146 /* Check this effect type is supported by this device */
147         if (!test_bit(effect->type, iforce->dev.ffbit))
148                 return -EINVAL;
149
150 /*
151  * If we want to create a new effect, get a free id
152  */
153         if (effect->id == -1) {
154
155                 for (id=0; id < FF_EFFECTS_MAX; ++id)
156                         if (!test_and_set_bit(FF_CORE_IS_USED, iforce->core_effects[id].flags)) break;
157
158                 if ( id == FF_EFFECTS_MAX || id >= iforce->dev.ff_effects_max)
159                         return -ENOMEM;
160
161                 effect->id = id;
162                 iforce->core_effects[id].owner = current->pid;
163                 iforce->core_effects[id].flags[0] = (1<<FF_CORE_IS_USED);       /* Only IS_USED bit must be set */
164
165                 is_update = FALSE;
166         }
167         else {
168                 /* We want to update an effect */
169                 if (!CHECK_OWNERSHIP(effect->id, iforce)) return -EACCES;
170
171                 /* Parameter type cannot be updated */
172                 if (effect->type != iforce->core_effects[effect->id].effect.type)
173                         return -EINVAL;
174
175                 /* Check the effect is not already being updated */
176                 if (test_bit(FF_CORE_UPDATE, iforce->core_effects[effect->id].flags)) {
177                         return -EAGAIN;
178                 }
179
180                 is_update = TRUE;
181         }
182
183 /*
184  * Upload the effect
185  */
186         switch (effect->type) {
187
188                 case FF_PERIODIC:
189                         ret = iforce_upload_periodic(iforce, effect, is_update);
190                         break;
191
192                 case FF_CONSTANT:
193                         ret = iforce_upload_constant(iforce, effect, is_update);
194                         break;
195
196                 case FF_SPRING:
197                 case FF_DAMPER:
198                         ret = iforce_upload_condition(iforce, effect, is_update);
199                         break;
200
201                 default:
202                         return -EINVAL;
203         }
204         if (ret == 0) {
205                 /* A packet was sent, forbid new updates until we are notified
206                  * that the packet was updated
207                  */
208                 set_bit(FF_CORE_UPDATE, iforce->core_effects[effect->id].flags);
209         }
210         iforce->core_effects[effect->id].effect = *effect;
211         return ret;
212 }
213
214 /*
215  * Erases an effect: it frees the effect id and mark as unused the memory
216  * allocated for the parameters
217  */
218 static int iforce_erase_effect(struct input_dev *dev, int effect_id)
219 {
220         struct iforce* iforce = (struct iforce*)(dev->private);
221         int err = 0;
222         struct iforce_core_effect* core_effect;
223
224         /* Check who is trying to erase this effect */
225         if (iforce->core_effects[effect_id].owner != current->pid) {
226                 printk(KERN_WARNING "iforce-main.c: %d tried to erase an effect belonging to %d\n", current->pid, iforce->core_effects[effect_id].owner);
227                 return -EACCES;
228         }
229
230         if (effect_id < 0 || effect_id >= FF_EFFECTS_MAX)
231                 return -EINVAL;
232
233         core_effect = iforce->core_effects + effect_id;
234
235         if (test_bit(FF_MOD1_IS_USED, core_effect->flags))
236                 err = release_resource(&(iforce->core_effects[effect_id].mod1_chunk));
237
238         if (!err && test_bit(FF_MOD2_IS_USED, core_effect->flags))
239                 err = release_resource(&(iforce->core_effects[effect_id].mod2_chunk));
240
241         /*TODO: remember to change that if more FF_MOD* bits are added */
242         core_effect->flags[0] = 0;
243
244         return err;
245 }
246
247 static int iforce_open(struct input_dev *dev)
248 {
249         struct iforce *iforce = dev->private;
250
251         switch (iforce->bus) {
252 #ifdef CONFIG_JOYSTICK_IFORCE_USB
253                 case IFORCE_USB:
254                         iforce->irq->dev = iforce->usbdev;
255                         if (usb_submit_urb(iforce->irq, GFP_KERNEL))
256                                 return -EIO;
257                         break;
258 #endif
259         }
260
261         /* Enable force feedback */
262         iforce_send_packet(iforce, FF_CMD_ENABLE, "\004");
263
264         return 0;
265 }
266
267 static int iforce_flush(struct input_dev *dev, struct file *file)
268 {
269         struct iforce *iforce = dev->private;
270         int i;
271
272         /* Erase all effects this process owns */
273         for (i=0; i<dev->ff_effects_max; ++i) {
274
275                 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags) &&
276                         current->pid == iforce->core_effects[i].owner) {
277
278                         /* Stop effect */
279                         input_report_ff(dev, i, 0);
280
281                         /* Free ressources assigned to effect */
282                         if (iforce_erase_effect(dev, i)) {
283                                 printk(KERN_WARNING "iforce_flush: erase effect %d failed\n", i);
284                         }
285                 }
286
287         }
288         return 0;
289 }
290
291 static void iforce_release(struct input_dev *dev)
292 {
293         struct iforce *iforce = dev->private;
294         int i;
295
296         /* Check: no effect should be present in memory */
297         for (i=0; i<dev->ff_effects_max; ++i) {
298                 if (test_bit(FF_CORE_IS_USED, iforce->core_effects[i].flags))
299                         break;
300         }
301         if (i<dev->ff_effects_max) {
302                 printk(KERN_WARNING "iforce_release: Device still owns effects\n");
303         }
304
305         /* Disable force feedback playback */
306         iforce_send_packet(iforce, FF_CMD_ENABLE, "\001");
307
308         switch (iforce->bus) {
309 #ifdef CONFIG_JOYSTICK_IFORCE_USB
310                 case IFORCE_USB:
311                         usb_unlink_urb(iforce->irq);
312
313                         /* The device was unplugged before the file
314                          * was released */
315                         if (iforce->usbdev == NULL) {
316                                 iforce_delete_device(iforce);
317                                 kfree(iforce);
318                         }
319                 break;
320 #endif
321         }
322 }
323
324 void iforce_delete_device(struct iforce *iforce)
325 {
326         switch (iforce->bus) {
327 #ifdef CONFIG_JOYSTICK_IFORCE_USB
328         case IFORCE_USB:
329                 iforce_usb_delete(iforce);
330                 break;
331 #endif
332 #ifdef CONFIG_JOYSTICK_IFORCE_232
333         case IFORCE_232:
334                 //TODO: Wait for the last packets to be sent
335                 break;
336 #endif
337         }
338 }
339
340 int iforce_init_device(struct iforce *iforce)
341 {
342         unsigned char c[] = "CEOV";
343         int i;
344
345         init_waitqueue_head(&iforce->wait);
346         spin_lock_init(&iforce->xmit_lock);
347         init_MUTEX(&iforce->mem_mutex);
348         iforce->xmit.buf = iforce->xmit_data;
349
350         iforce->dev.ff_effects_max = 10;
351
352 /*
353  * Input device fields.
354  */
355
356         switch (iforce->bus) {
357 #ifdef CONFIG_JOYSTICK_IFORCE_USB
358         case IFORCE_USB:
359                 iforce->dev.id.bustype = BUS_USB;
360                 iforce->dev.dev = &iforce->usbdev->dev;
361                 break;
362 #endif
363 #ifdef CONFIG_JOYSTICK_IFORCE_232
364         case IFORCE_232:
365                 iforce->dev.id.bustype = BUS_RS232;
366                 iforce->dev.dev = &iforce->serio->dev;
367                 break;
368 #endif
369         }
370
371         iforce->dev.private = iforce;
372         iforce->dev.name = "Unknown I-Force device";
373         iforce->dev.open = iforce_open;
374         iforce->dev.close = iforce_release;
375         iforce->dev.flush = iforce_flush;
376         iforce->dev.event = iforce_input_event;
377         iforce->dev.upload_effect = iforce_upload_effect;
378         iforce->dev.erase_effect = iforce_erase_effect;
379
380 /*
381  * On-device memory allocation.
382  */
383
384         iforce->device_memory.name = "I-Force device effect memory";
385         iforce->device_memory.start = 0;
386         iforce->device_memory.end = 200;
387         iforce->device_memory.flags = IORESOURCE_MEM;
388         iforce->device_memory.parent = NULL;
389         iforce->device_memory.child = NULL;
390         iforce->device_memory.sibling = NULL;
391
392 /*
393  * Wait until device ready - until it sends its first response.
394  */
395
396         for (i = 0; i < 20; i++)
397                 if (!iforce_get_id_packet(iforce, "O"))
398                         break;
399
400         if (i == 20) { /* 5 seconds */
401                 printk(KERN_ERR "iforce-main.c: Timeout waiting for response from device.\n");
402                 return -1;
403         }
404
405 /*
406  * Get device info.
407  */
408
409         if (!iforce_get_id_packet(iforce, "M"))
410                 iforce->dev.id.vendor = (iforce->edata[2] << 8) | iforce->edata[1];
411         else
412                 printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet M\n");
413
414         if (!iforce_get_id_packet(iforce, "P"))
415                 iforce->dev.id.product = (iforce->edata[2] << 8) | iforce->edata[1];
416         else
417                 printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet P\n");
418
419         if (!iforce_get_id_packet(iforce, "B"))
420                 iforce->device_memory.end = (iforce->edata[2] << 8) | iforce->edata[1];
421         else
422                 printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet B\n");
423
424         if (!iforce_get_id_packet(iforce, "N"))
425                 iforce->dev.ff_effects_max = iforce->edata[1];
426         else
427                 printk(KERN_WARNING "iforce-main.c: Device does not respond to id packet N\n");
428
429         /* Check if the device can store more effects than the driver can really handle */
430         if (iforce->dev.ff_effects_max > FF_EFFECTS_MAX) {
431                 printk(KERN_WARNING "input??: Device can handle %d effects, but N_EFFECTS_MAX is set to %d in iforce.h\n",
432                         iforce->dev.ff_effects_max, FF_EFFECTS_MAX);
433                 iforce->dev.ff_effects_max = FF_EFFECTS_MAX;
434         }
435
436 /*
437  * Display additional info.
438  */
439
440         for (i = 0; c[i]; i++)
441                 if (!iforce_get_id_packet(iforce, c + i))
442                         iforce_dump_packet("info", iforce->ecmd, iforce->edata);
443
444 /*
445  * Disable spring, enable force feedback.
446  * FIXME: We should use iforce_set_autocenter() et al here.
447  */
448
449         iforce_send_packet(iforce, FF_CMD_AUTOCENTER, "\004\000");
450
451 /*
452  * Find appropriate device entry
453  */
454
455         for (i = 0; iforce_device[i].idvendor; i++)
456                 if (iforce_device[i].idvendor == iforce->dev.id.vendor &&
457                     iforce_device[i].idproduct == iforce->dev.id.product)
458                         break;
459
460         iforce->type = iforce_device + i;
461         iforce->dev.name = iforce->type->name;
462
463 /*
464  * Set input device bitfields and ranges.
465  */
466
467         iforce->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS) | BIT(EV_FF) | BIT(EV_FF_STATUS);
468
469         for (i = 0; iforce->type->btn[i] >= 0; i++) {
470                 signed short t = iforce->type->btn[i];
471                 set_bit(t, iforce->dev.keybit);
472         }
473         set_bit(BTN_DEAD, iforce->dev.keybit);
474
475         for (i = 0; iforce->type->abs[i] >= 0; i++) {
476
477                 signed short t = iforce->type->abs[i];
478                 set_bit(t, iforce->dev.absbit);
479
480                 switch (t) {
481
482                         case ABS_X:
483                         case ABS_Y:
484                         case ABS_WHEEL:
485
486                                 iforce->dev.absmax[t] =  1920;
487                                 iforce->dev.absmin[t] = -1920;
488                                 iforce->dev.absflat[t] = 128;
489                                 iforce->dev.absfuzz[t] = 16;
490
491                                 set_bit(t, iforce->dev.ffbit);
492                                 break;
493
494                         case ABS_THROTTLE:
495                         case ABS_GAS:
496                         case ABS_BRAKE:
497
498                                 iforce->dev.absmax[t] = 255;
499                                 iforce->dev.absmin[t] = 0;
500                                 break;
501
502                         case ABS_RUDDER:
503
504                                 iforce->dev.absmax[t] = 127;
505                                 iforce->dev.absmin[t] = -128;
506                                 break;
507
508                         case ABS_HAT0X:
509                         case ABS_HAT0Y:
510                         case ABS_HAT1X:
511                         case ABS_HAT1Y:
512                                 iforce->dev.absmax[t] =  1;
513                                 iforce->dev.absmin[t] = -1;
514                                 break;
515                 }
516         }
517
518         for (i = 0; iforce->type->ff[i] >= 0; i++)
519                 set_bit(iforce->type->ff[i], iforce->dev.ffbit);
520
521 /*
522  * Register input device.
523  */
524
525         input_register_device(&iforce->dev);
526
527         printk(KERN_DEBUG "iforce->dev.open = %p\n", iforce->dev.open);
528
529         printk(KERN_INFO "input: %s [%d effects, %ld bytes memory]\n",
530                 iforce->dev.name, iforce->dev.ff_effects_max,
531                 iforce->device_memory.end);
532
533         return 0;
534 }
535
536 static int __init iforce_init(void)
537 {
538 #ifdef CONFIG_JOYSTICK_IFORCE_USB
539         usb_register(&iforce_usb_driver);
540 #endif
541 #ifdef CONFIG_JOYSTICK_IFORCE_232
542         serio_register_driver(&iforce_serio_drv);
543 #endif
544         return 0;
545 }
546
547 static void __exit iforce_exit(void)
548 {
549 #ifdef CONFIG_JOYSTICK_IFORCE_USB
550         usb_deregister(&iforce_usb_driver);
551 #endif
552 #ifdef CONFIG_JOYSTICK_IFORCE_232
553         serio_unregister_driver(&iforce_serio_drv);
554 #endif
555 }
556
557 module_init(iforce_init);
558 module_exit(iforce_exit);