Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

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