2 * Force feedback support for Logitech Gaming Wheels
4 * Including G27, G25, DFP, DFGT, FFEX, Momo, Momo2 &
5 * Speed Force Wireless (WiiWheel)
7 * Copyright (c) 2010 Simon Wood <simon@mungewell.org>
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.
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.
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
27 #include <linux/input.h>
28 #include <linux/usb.h>
29 #include <linux/hid.h>
31 #include "usbhid/usbhid.h"
35 #define DFGT_REV_MAJ 0x13
36 #define DFGT_REV_MIN 0x22
37 #define DFGT2_REV_MIN 0x26
38 #define DFP_REV_MAJ 0x11
39 #define DFP_REV_MIN 0x06
40 #define FFEX_REV_MAJ 0x21
41 #define FFEX_REV_MIN 0x00
42 #define G25_REV_MAJ 0x12
43 #define G25_REV_MIN 0x22
44 #define G27_REV_MAJ 0x12
45 #define G27_REV_MIN 0x38
47 #define to_hid_device(pdev) container_of(pdev, struct hid_device, dev)
49 static void hid_lg4ff_set_range_dfp(struct hid_device *hid, u16 range);
50 static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range);
51 static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr, char *buf);
52 static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count);
54 static DEVICE_ATTR(range, S_IRWXU | S_IRWXG | S_IRWXO, lg4ff_range_show, lg4ff_range_store);
56 struct lg4ff_device_entry {
61 #ifdef CONFIG_LEDS_CLASS
63 struct led_classdev *led[5];
65 struct list_head list;
66 void (*set_range)(struct hid_device *hid, u16 range);
69 static const signed short lg4ff_wheel_effects[] = {
76 const __u32 product_id;
77 const signed short *ff_effects;
78 const __u16 min_range;
79 const __u16 max_range;
80 void (*set_range)(struct hid_device *hid, u16 range);
83 static const struct lg4ff_wheel lg4ff_devices[] = {
84 {USB_DEVICE_ID_LOGITECH_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
85 {USB_DEVICE_ID_LOGITECH_MOMO_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
86 {USB_DEVICE_ID_LOGITECH_DFP_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_dfp},
87 {USB_DEVICE_ID_LOGITECH_G25_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
88 {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
89 {USB_DEVICE_ID_LOGITECH_G27_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
90 {USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2, lg4ff_wheel_effects, 40, 270, NULL},
91 {USB_DEVICE_ID_LOGITECH_WII_WHEEL, lg4ff_wheel_effects, 40, 270, NULL}
94 struct lg4ff_native_cmd {
95 const __u8 cmd_num; /* Number of commands to send */
99 struct lg4ff_usb_revision {
102 const struct lg4ff_native_cmd *command;
105 static const struct lg4ff_native_cmd native_dfp = {
107 {0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
110 static const struct lg4ff_native_cmd native_dfgt = {
112 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* 1st command */
113 0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00} /* 2nd command */
116 static const struct lg4ff_native_cmd native_g25 = {
118 {0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
121 static const struct lg4ff_native_cmd native_g27 = {
123 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* 1st command */
124 0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00} /* 2nd command */
127 static const struct lg4ff_usb_revision lg4ff_revs[] = {
128 {DFGT_REV_MAJ, DFGT_REV_MIN, &native_dfgt}, /* Driving Force GT */
129 {DFGT_REV_MAJ, DFGT2_REV_MIN, &native_dfgt}, /* Driving Force GT v2 */
130 {DFP_REV_MAJ, DFP_REV_MIN, &native_dfp}, /* Driving Force Pro */
131 {G25_REV_MAJ, G25_REV_MIN, &native_g25}, /* G25 */
132 {G27_REV_MAJ, G27_REV_MIN, &native_g27}, /* G27 */
135 /* Recalculates X axis value accordingly to currently selected range */
136 static __s32 lg4ff_adjust_dfp_x_axis(__s32 value, __u16 range)
143 else if (range == 200)
145 else if (range < 200)
150 new_value = 8192 + mult_frac(value - 8192, max_range, range);
153 else if (new_value > 16383)
159 int lg4ff_adjust_input_event(struct hid_device *hid, struct hid_field *field,
160 struct hid_usage *usage, __s32 value, struct lg_drv_data *drv_data)
162 struct lg4ff_device_entry *entry = drv_data->device_props;
166 hid_err(hid, "Device properties not found");
170 switch (entry->product_id) {
171 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
172 switch (usage->code) {
174 new_value = lg4ff_adjust_dfp_x_axis(value, entry->range);
175 input_event(field->hidinput->input, usage->type, usage->code, new_value);
185 static int hid_lg4ff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
187 struct hid_device *hid = input_get_drvdata(dev);
188 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
189 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
190 __s32 *value = report->field[0]->value;
193 #define CLAMP(x) do { if (x < 0) x = 0; else if (x > 0xff) x = 0xff; } while (0)
195 switch (effect->type) {
197 x = effect->u.ramp.start_level + 0x80; /* 0x80 is no force */
199 value[0] = 0x11; /* Slot 1 */
207 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
213 /* Sends default autocentering command compatible with
214 * all wheels except Formula Force EX */
215 static void hid_lg4ff_set_autocenter_default(struct input_dev *dev, u16 magnitude)
217 struct hid_device *hid = input_get_drvdata(dev);
218 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
219 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
220 __s32 *value = report->field[0]->value;
221 __u32 expand_a, expand_b;
223 /* De-activate Auto-Center */
224 if (magnitude == 0) {
233 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
237 if (magnitude <= 0xaaaa) {
238 expand_a = 0x0c * magnitude;
239 expand_b = 0x80 * magnitude;
241 expand_a = (0x0c * 0xaaaa) + 0x06 * (magnitude - 0xaaaa);
242 expand_b = (0x80 * 0xaaaa) + 0xff * (magnitude - 0xaaaa);
247 value[2] = expand_a / 0xaaaa;
248 value[3] = expand_a / 0xaaaa;
249 value[4] = expand_b / 0xaaaa;
253 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
255 /* Activate Auto-Center */
264 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
267 /* Sends autocentering command compatible with Formula Force EX */
268 static void hid_lg4ff_set_autocenter_ffex(struct input_dev *dev, u16 magnitude)
270 struct hid_device *hid = input_get_drvdata(dev);
271 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
272 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
273 __s32 *value = report->field[0]->value;
274 magnitude = magnitude * 90 / 65535;
278 value[2] = magnitude >> 14;
279 value[3] = magnitude >> 14;
280 value[4] = magnitude;
284 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
287 /* Sends command to set range compatible with G25/G27/Driving Force GT */
288 static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range)
290 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
291 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
292 __s32 *value = report->field[0]->value;
294 dbg_hid("G25/G27/DFGT: setting range to %u\n", range);
298 value[2] = range & 0x00ff;
299 value[3] = (range & 0xff00) >> 8;
304 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
307 /* Sends commands to set range compatible with Driving Force Pro wheel */
308 static void hid_lg4ff_set_range_dfp(struct hid_device *hid, __u16 range)
310 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
311 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
312 int start_left, start_right, full_range;
313 __s32 *value = report->field[0]->value;
315 dbg_hid("Driving Force Pro: setting range to %u\n", range);
317 /* Prepare "coarse" limit command */
319 value[1] = 0x00; /* Set later */
327 report->field[0]->value[1] = 0x03;
330 report->field[0]->value[1] = 0x02;
333 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
335 /* Prepare "fine" limit command */
344 if (range == 200 || range == 900) { /* Do not apply any fine limit */
345 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
349 /* Construct fine limit command */
350 start_left = (((full_range - range + 1) * 2047) / full_range);
351 start_right = 0xfff - start_left;
353 value[2] = start_left >> 4;
354 value[3] = start_right >> 4;
356 value[5] = (start_right & 0xe) << 4 | (start_left & 0xe);
359 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
362 static void hid_lg4ff_switch_native(struct hid_device *hid, const struct lg4ff_native_cmd *cmd)
364 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
365 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
369 while (j < 7*cmd->cmd_num) {
370 for (i = 0; i < 7; i++)
371 report->field[0]->value[i] = cmd->cmd[j++];
373 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
377 /* Read current range and display it in terminal */
378 static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr, char *buf)
380 struct hid_device *hid = to_hid_device(dev);
381 struct lg4ff_device_entry *entry;
382 struct lg_drv_data *drv_data;
385 drv_data = hid_get_drvdata(hid);
387 hid_err(hid, "Private driver data not found!\n");
391 entry = drv_data->device_props;
393 hid_err(hid, "Device properties not found!\n");
397 count = scnprintf(buf, PAGE_SIZE, "%u\n", entry->range);
401 /* Set range to user specified value, call appropriate function
402 * according to the type of the wheel */
403 static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
405 struct hid_device *hid = to_hid_device(dev);
406 struct lg4ff_device_entry *entry;
407 struct lg_drv_data *drv_data;
408 __u16 range = simple_strtoul(buf, NULL, 10);
410 drv_data = hid_get_drvdata(hid);
412 hid_err(hid, "Private driver data not found!\n");
416 entry = drv_data->device_props;
418 hid_err(hid, "Device properties not found!\n");
423 range = entry->max_range;
425 /* Check if the wheel supports range setting
426 * and that the range is within limits for the wheel */
427 if (entry->set_range != NULL && range >= entry->min_range && range <= entry->max_range) {
428 entry->set_range(hid, range);
429 entry->range = range;
435 #ifdef CONFIG_LEDS_CLASS
436 static void lg4ff_set_leds(struct hid_device *hid, __u8 leds)
438 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
439 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
440 __s32 *value = report->field[0]->value;
449 hid_hw_request(hid, report, HID_REQ_SET_REPORT);
452 static void lg4ff_led_set_brightness(struct led_classdev *led_cdev,
453 enum led_brightness value)
455 struct device *dev = led_cdev->dev->parent;
456 struct hid_device *hid = container_of(dev, struct hid_device, dev);
457 struct lg_drv_data *drv_data = hid_get_drvdata(hid);
458 struct lg4ff_device_entry *entry;
462 hid_err(hid, "Device data not found.");
466 entry = (struct lg4ff_device_entry *)drv_data->device_props;
469 hid_err(hid, "Device properties not found.");
473 for (i = 0; i < 5; i++) {
474 if (led_cdev != entry->led[i])
476 state = (entry->led_state >> i) & 1;
477 if (value == LED_OFF && state) {
478 entry->led_state &= ~(1 << i);
479 lg4ff_set_leds(hid, entry->led_state);
480 } else if (value != LED_OFF && !state) {
481 entry->led_state |= 1 << i;
482 lg4ff_set_leds(hid, entry->led_state);
488 static enum led_brightness lg4ff_led_get_brightness(struct led_classdev *led_cdev)
490 struct device *dev = led_cdev->dev->parent;
491 struct hid_device *hid = container_of(dev, struct hid_device, dev);
492 struct lg_drv_data *drv_data = hid_get_drvdata(hid);
493 struct lg4ff_device_entry *entry;
497 hid_err(hid, "Device data not found.");
501 entry = (struct lg4ff_device_entry *)drv_data->device_props;
504 hid_err(hid, "Device properties not found.");
508 for (i = 0; i < 5; i++)
509 if (led_cdev == entry->led[i]) {
510 value = (entry->led_state >> i) & 1;
514 return value ? LED_FULL : LED_OFF;
518 int lg4ff_init(struct hid_device *hid)
520 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
521 struct input_dev *dev = hidinput->input;
522 struct lg4ff_device_entry *entry;
523 struct lg_drv_data *drv_data;
524 struct usb_device_descriptor *udesc;
526 __u16 bcdDevice, rev_maj, rev_min;
528 /* Check that the report looks ok */
529 if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 7))
532 /* Check what wheel has been connected */
533 for (i = 0; i < ARRAY_SIZE(lg4ff_devices); i++) {
534 if (hid->product == lg4ff_devices[i].product_id) {
535 dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices[i].product_id);
540 if (i == ARRAY_SIZE(lg4ff_devices)) {
541 hid_err(hid, "Device is not supported by lg4ff driver. If you think it should be, consider reporting a bug to"
542 "LKML, Simon Wood <simon@mungewell.org> or Michal Maly <madcatxster@gmail.com>\n");
546 /* Attempt to switch wheel to native mode when applicable */
547 udesc = &(hid_to_usb_dev(hid)->descriptor);
549 hid_err(hid, "NULL USB device descriptor\n");
552 bcdDevice = le16_to_cpu(udesc->bcdDevice);
553 rev_maj = bcdDevice >> 8;
554 rev_min = bcdDevice & 0xff;
556 if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_WHEEL) {
557 dbg_hid("Generic wheel detected, can it do native?\n");
558 dbg_hid("USB revision: %2x.%02x\n", rev_maj, rev_min);
560 for (j = 0; j < ARRAY_SIZE(lg4ff_revs); j++) {
561 if (lg4ff_revs[j].rev_maj == rev_maj && lg4ff_revs[j].rev_min == rev_min) {
562 hid_lg4ff_switch_native(hid, lg4ff_revs[j].command);
563 hid_info(hid, "Switched to native mode\n");
568 /* Set supported force feedback capabilities */
569 for (j = 0; lg4ff_devices[i].ff_effects[j] >= 0; j++)
570 set_bit(lg4ff_devices[i].ff_effects[j], dev->ffbit);
572 error = input_ff_create_memless(dev, NULL, hid_lg4ff_play);
577 /* Get private driver data */
578 drv_data = hid_get_drvdata(hid);
580 hid_err(hid, "Cannot add device, private driver data not allocated\n");
584 /* Initialize device properties */
585 entry = kzalloc(sizeof(struct lg4ff_device_entry), GFP_KERNEL);
587 hid_err(hid, "Cannot add device, insufficient memory to allocate device properties.\n");
590 drv_data->device_props = entry;
592 entry->product_id = lg4ff_devices[i].product_id;
593 entry->min_range = lg4ff_devices[i].min_range;
594 entry->max_range = lg4ff_devices[i].max_range;
595 entry->set_range = lg4ff_devices[i].set_range;
597 /* Check if autocentering is available and
598 * set the centering force to zero by default */
599 if (test_bit(FF_AUTOCENTER, dev->ffbit)) {
600 if (rev_maj == FFEX_REV_MAJ && rev_min == FFEX_REV_MIN) /* Formula Force EX expects different autocentering command */
601 dev->ff->set_autocenter = hid_lg4ff_set_autocenter_ffex;
603 dev->ff->set_autocenter = hid_lg4ff_set_autocenter_default;
605 dev->ff->set_autocenter(dev, 0);
608 /* Create sysfs interface */
609 error = device_create_file(&hid->dev, &dev_attr_range);
612 dbg_hid("sysfs interface created\n");
614 /* Set the maximum range to start with */
615 entry->range = entry->max_range;
616 if (entry->set_range != NULL)
617 entry->set_range(hid, entry->range);
619 #ifdef CONFIG_LEDS_CLASS
620 /* register led subsystem - G27 only */
621 entry->led_state = 0;
622 for (j = 0; j < 5; j++)
623 entry->led[j] = NULL;
625 if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_G27_WHEEL) {
626 struct led_classdev *led;
630 lg4ff_set_leds(hid, 0);
632 name_sz = strlen(dev_name(&hid->dev)) + 8;
634 for (j = 0; j < 5; j++) {
635 led = kzalloc(sizeof(struct led_classdev)+name_sz, GFP_KERNEL);
637 hid_err(hid, "can't allocate memory for LED %d\n", j);
641 name = (void *)(&led[1]);
642 snprintf(name, name_sz, "%s::RPM%d", dev_name(&hid->dev), j+1);
645 led->max_brightness = 1;
646 led->brightness_get = lg4ff_led_get_brightness;
647 led->brightness_set = lg4ff_led_set_brightness;
650 error = led_classdev_register(&hid->dev, led);
653 hid_err(hid, "failed to register LED %d. Aborting.\n", j);
655 /* Deregister LEDs (if any) */
656 for (j = 0; j < 5; j++) {
658 entry->led[j] = NULL;
661 led_classdev_unregister(led);
664 goto out; /* Let the driver continue without LEDs */
670 hid_info(hid, "Force feedback support for Logitech Gaming Wheels\n");
676 int lg4ff_deinit(struct hid_device *hid)
678 struct lg4ff_device_entry *entry;
679 struct lg_drv_data *drv_data;
681 device_remove_file(&hid->dev, &dev_attr_range);
683 drv_data = hid_get_drvdata(hid);
685 hid_err(hid, "Error while deinitializing device, no private driver data.\n");
688 entry = drv_data->device_props;
690 hid_err(hid, "Error while deinitializing device, no device properties data.\n");
694 #ifdef CONFIG_LEDS_CLASS
697 struct led_classdev *led;
699 /* Deregister LEDs (if any) */
700 for (j = 0; j < 5; j++) {
703 entry->led[j] = NULL;
706 led_classdev_unregister(led);
712 /* Deallocate memory */
715 dbg_hid("Device successfully unregistered\n");