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"
33 #include "hid-lg4ff.h"
36 #define to_hid_device(pdev) container_of(pdev, struct hid_device, dev)
38 #define LG4FF_MMODE_IS_MULTIMODE 0
39 #define LG4FF_MMODE_SWITCHED 1
40 #define LG4FF_MMODE_NOT_MULTIMODE 2
42 #define LG4FF_MODE_NATIVE_IDX 0
43 #define LG4FF_MODE_DFEX_IDX 1
44 #define LG4FF_MODE_DFP_IDX 2
45 #define LG4FF_MODE_G25_IDX 3
46 #define LG4FF_MODE_DFGT_IDX 4
47 #define LG4FF_MODE_G27_IDX 5
48 #define LG4FF_MODE_G29_IDX 6
49 #define LG4FF_MODE_MAX_IDX 7
51 #define LG4FF_MODE_NATIVE BIT(LG4FF_MODE_NATIVE_IDX)
52 #define LG4FF_MODE_DFEX BIT(LG4FF_MODE_DFEX_IDX)
53 #define LG4FF_MODE_DFP BIT(LG4FF_MODE_DFP_IDX)
54 #define LG4FF_MODE_G25 BIT(LG4FF_MODE_G25_IDX)
55 #define LG4FF_MODE_DFGT BIT(LG4FF_MODE_DFGT_IDX)
56 #define LG4FF_MODE_G27 BIT(LG4FF_MODE_G27_IDX)
57 #define LG4FF_MODE_G29 BIT(LG4FF_MODE_G29_IDX)
59 #define LG4FF_DFEX_TAG "DF-EX"
60 #define LG4FF_DFEX_NAME "Driving Force / Formula EX"
61 #define LG4FF_DFP_TAG "DFP"
62 #define LG4FF_DFP_NAME "Driving Force Pro"
63 #define LG4FF_G25_TAG "G25"
64 #define LG4FF_G25_NAME "G25 Racing Wheel"
65 #define LG4FF_G27_TAG "G27"
66 #define LG4FF_G27_NAME "G27 Racing Wheel"
67 #define LG4FF_G29_TAG "G29"
68 #define LG4FF_G29_NAME "G29 Racing Wheel"
69 #define LG4FF_DFGT_TAG "DFGT"
70 #define LG4FF_DFGT_NAME "Driving Force GT"
72 #define LG4FF_FFEX_REV_MAJ 0x21
73 #define LG4FF_FFEX_REV_MIN 0x00
75 static void lg4ff_set_range_dfp(struct hid_device *hid, u16 range);
76 static void lg4ff_set_range_g25(struct hid_device *hid, u16 range);
78 struct lg4ff_wheel_data {
83 #ifdef CONFIG_LEDS_CLASS
85 struct led_classdev *led[5];
87 const u32 alternate_modes;
88 const char * const real_tag;
89 const char * const real_name;
90 const u16 real_product_id;
92 void (*set_range)(struct hid_device *hid, u16 range);
95 struct lg4ff_device_entry {
96 spinlock_t report_lock; /* Protect output HID report */
97 struct hid_report *report;
98 struct lg4ff_wheel_data wdata;
101 static const signed short lg4ff_wheel_effects[] = {
108 const u32 product_id;
109 const signed short *ff_effects;
112 void (*set_range)(struct hid_device *hid, u16 range);
115 struct lg4ff_compat_mode_switch {
116 const u8 cmd_count; /* Number of commands to send */
120 struct lg4ff_wheel_ident_info {
124 const u16 real_product_id;
127 struct lg4ff_multimode_wheel {
128 const u16 product_id;
129 const u32 alternate_modes;
130 const char *real_tag;
131 const char *real_name;
134 struct lg4ff_alternate_mode {
135 const u16 product_id;
140 static const struct lg4ff_wheel lg4ff_devices[] = {
141 {USB_DEVICE_ID_LOGITECH_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
142 {USB_DEVICE_ID_LOGITECH_MOMO_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
143 {USB_DEVICE_ID_LOGITECH_DFP_WHEEL, lg4ff_wheel_effects, 40, 900, lg4ff_set_range_dfp},
144 {USB_DEVICE_ID_LOGITECH_G25_WHEEL, lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
145 {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL, lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
146 {USB_DEVICE_ID_LOGITECH_G27_WHEEL, lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
147 {USB_DEVICE_ID_LOGITECH_G29_WHEEL, lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
148 {USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2, lg4ff_wheel_effects, 40, 270, NULL},
149 {USB_DEVICE_ID_LOGITECH_WII_WHEEL, lg4ff_wheel_effects, 40, 270, NULL}
152 static const struct lg4ff_multimode_wheel lg4ff_multimode_wheels[] = {
153 {USB_DEVICE_ID_LOGITECH_DFP_WHEEL,
154 LG4FF_MODE_NATIVE | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
155 LG4FF_DFP_TAG, LG4FF_DFP_NAME},
156 {USB_DEVICE_ID_LOGITECH_G25_WHEEL,
157 LG4FF_MODE_NATIVE | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
158 LG4FF_G25_TAG, LG4FF_G25_NAME},
159 {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL,
160 LG4FF_MODE_NATIVE | LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
161 LG4FF_DFGT_TAG, LG4FF_DFGT_NAME},
162 {USB_DEVICE_ID_LOGITECH_G27_WHEEL,
163 LG4FF_MODE_NATIVE | LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
164 LG4FF_G27_TAG, LG4FF_G27_NAME},
165 {USB_DEVICE_ID_LOGITECH_G29_WHEEL,
166 LG4FF_MODE_NATIVE | LG4FF_MODE_G29 | LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
167 LG4FF_G29_TAG, LG4FF_G29_NAME},
170 static const struct lg4ff_alternate_mode lg4ff_alternate_modes[] = {
171 [LG4FF_MODE_NATIVE_IDX] = {0, "native", ""},
172 [LG4FF_MODE_DFEX_IDX] = {USB_DEVICE_ID_LOGITECH_WHEEL, LG4FF_DFEX_TAG, LG4FF_DFEX_NAME},
173 [LG4FF_MODE_DFP_IDX] = {USB_DEVICE_ID_LOGITECH_DFP_WHEEL, LG4FF_DFP_TAG, LG4FF_DFP_NAME},
174 [LG4FF_MODE_G25_IDX] = {USB_DEVICE_ID_LOGITECH_G25_WHEEL, LG4FF_G25_TAG, LG4FF_G25_NAME},
175 [LG4FF_MODE_DFGT_IDX] = {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL, LG4FF_DFGT_TAG, LG4FF_DFGT_NAME},
176 [LG4FF_MODE_G27_IDX] = {USB_DEVICE_ID_LOGITECH_G27_WHEEL, LG4FF_G27_TAG, LG4FF_G27_NAME},
177 [LG4FF_MODE_G29_IDX] = {USB_DEVICE_ID_LOGITECH_G29_WHEEL, LG4FF_G29_TAG, LG4FF_G29_NAME},
180 /* Multimode wheel identificators */
181 static const struct lg4ff_wheel_ident_info lg4ff_dfp_ident_info = {
182 LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
185 USB_DEVICE_ID_LOGITECH_DFP_WHEEL
188 static const struct lg4ff_wheel_ident_info lg4ff_g25_ident_info = {
189 LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
192 USB_DEVICE_ID_LOGITECH_G25_WHEEL
195 static const struct lg4ff_wheel_ident_info lg4ff_g27_ident_info = {
196 LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
199 USB_DEVICE_ID_LOGITECH_G27_WHEEL
202 static const struct lg4ff_wheel_ident_info lg4ff_dfgt_ident_info = {
203 LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
206 USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
209 static const struct lg4ff_wheel_ident_info lg4ff_g29_ident_info = {
210 LG4FF_MODE_G29 | LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
213 USB_DEVICE_ID_LOGITECH_G29_WHEEL
216 static const struct lg4ff_wheel_ident_info lg4ff_g29_ident_info2 = {
217 LG4FF_MODE_G29 | LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
220 USB_DEVICE_ID_LOGITECH_G29_WHEEL
223 /* Multimode wheel identification checklists */
224 static const struct lg4ff_wheel_ident_info *lg4ff_main_checklist[] = {
225 &lg4ff_g29_ident_info,
226 &lg4ff_g29_ident_info2,
227 &lg4ff_dfgt_ident_info,
228 &lg4ff_g27_ident_info,
229 &lg4ff_g25_ident_info,
230 &lg4ff_dfp_ident_info
233 /* Compatibility mode switching commands */
234 /* EXT_CMD9 - Understood by G27 and DFGT */
235 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfex = {
237 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
238 0xf8, 0x09, 0x00, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DF-EX with detach */
241 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfp = {
243 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
244 0xf8, 0x09, 0x01, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DFP with detach */
247 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g25 = {
249 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
250 0xf8, 0x09, 0x02, 0x01, 0x00, 0x00, 0x00} /* Switch mode to G25 with detach */
253 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfgt = {
255 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
256 0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DFGT with detach */
259 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g27 = {
261 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
262 0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00} /* Switch mode to G27 with detach */
265 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g29 = {
267 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
268 0xf8, 0x09, 0x05, 0x01, 0x01, 0x00, 0x00} /* Switch mode to G29 with detach */
271 /* EXT_CMD1 - Understood by DFP, G25, G27 and DFGT */
272 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext01_dfp = {
274 {0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
277 /* EXT_CMD16 - Understood by G25 and G27 */
278 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext16_g25 = {
280 {0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
283 /* Recalculates X axis value accordingly to currently selected range */
284 static s32 lg4ff_adjust_dfp_x_axis(s32 value, u16 range)
291 else if (range == 200)
293 else if (range < 200)
298 new_value = 8192 + mult_frac(value - 8192, max_range, range);
301 else if (new_value > 16383)
307 int lg4ff_adjust_input_event(struct hid_device *hid, struct hid_field *field,
308 struct hid_usage *usage, s32 value, struct lg_drv_data *drv_data)
310 struct lg4ff_device_entry *entry = drv_data->device_props;
314 hid_err(hid, "Device properties not found");
318 switch (entry->wdata.product_id) {
319 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
320 switch (usage->code) {
322 new_value = lg4ff_adjust_dfp_x_axis(value, entry->wdata.range);
323 input_event(field->hidinput->input, usage->type, usage->code, new_value);
333 static void lg4ff_init_wheel_data(struct lg4ff_wheel_data * const wdata, const struct lg4ff_wheel *wheel,
334 const struct lg4ff_multimode_wheel *mmode_wheel,
335 const u16 real_product_id)
337 u32 alternate_modes = 0;
338 const char *real_tag = NULL;
339 const char *real_name = NULL;
342 alternate_modes = mmode_wheel->alternate_modes;
343 real_tag = mmode_wheel->real_tag;
344 real_name = mmode_wheel->real_name;
348 struct lg4ff_wheel_data t_wdata = { .product_id = wheel->product_id,
349 .real_product_id = real_product_id,
350 .min_range = wheel->min_range,
351 .max_range = wheel->max_range,
352 .set_range = wheel->set_range,
353 .alternate_modes = alternate_modes,
354 .real_tag = real_tag,
355 .real_name = real_name };
357 memcpy(wdata, &t_wdata, sizeof(t_wdata));
361 static int lg4ff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
363 struct hid_device *hid = input_get_drvdata(dev);
364 struct lg4ff_device_entry *entry;
365 struct lg_drv_data *drv_data;
370 drv_data = hid_get_drvdata(hid);
372 hid_err(hid, "Private driver data not found!\n");
376 entry = drv_data->device_props;
378 hid_err(hid, "Device properties not found!\n");
381 value = entry->report->field[0]->value;
383 #define CLAMP(x) do { if (x < 0) x = 0; else if (x > 0xff) x = 0xff; } while (0)
385 switch (effect->type) {
387 x = effect->u.ramp.start_level + 0x80; /* 0x80 is no force */
390 spin_lock_irqsave(&entry->report_lock, flags);
392 /* De-activate force in slot-1*/
401 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
402 spin_unlock_irqrestore(&entry->report_lock, flags);
406 value[0] = 0x11; /* Slot 1 */
414 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
415 spin_unlock_irqrestore(&entry->report_lock, flags);
421 /* Sends default autocentering command compatible with
422 * all wheels except Formula Force EX */
423 static void lg4ff_set_autocenter_default(struct input_dev *dev, u16 magnitude)
425 struct hid_device *hid = input_get_drvdata(dev);
426 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
427 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
428 s32 *value = report->field[0]->value;
429 u32 expand_a, expand_b;
430 struct lg4ff_device_entry *entry;
431 struct lg_drv_data *drv_data;
434 drv_data = hid_get_drvdata(hid);
436 hid_err(hid, "Private driver data not found!\n");
440 entry = drv_data->device_props;
442 hid_err(hid, "Device properties not found!\n");
445 value = entry->report->field[0]->value;
447 /* De-activate Auto-Center */
448 spin_lock_irqsave(&entry->report_lock, flags);
449 if (magnitude == 0) {
458 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
459 spin_unlock_irqrestore(&entry->report_lock, flags);
463 if (magnitude <= 0xaaaa) {
464 expand_a = 0x0c * magnitude;
465 expand_b = 0x80 * magnitude;
467 expand_a = (0x0c * 0xaaaa) + 0x06 * (magnitude - 0xaaaa);
468 expand_b = (0x80 * 0xaaaa) + 0xff * (magnitude - 0xaaaa);
471 /* Adjust for non-MOMO wheels */
472 switch (entry->wdata.product_id) {
473 case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL:
474 case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2:
477 expand_a = expand_a >> 1;
483 value[2] = expand_a / 0xaaaa;
484 value[3] = expand_a / 0xaaaa;
485 value[4] = expand_b / 0xaaaa;
489 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
491 /* Activate Auto-Center */
500 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
501 spin_unlock_irqrestore(&entry->report_lock, flags);
504 /* Sends autocentering command compatible with Formula Force EX */
505 static void lg4ff_set_autocenter_ffex(struct input_dev *dev, u16 magnitude)
507 struct hid_device *hid = input_get_drvdata(dev);
508 struct lg4ff_device_entry *entry;
509 struct lg_drv_data *drv_data;
512 magnitude = magnitude * 90 / 65535;
514 drv_data = hid_get_drvdata(hid);
516 hid_err(hid, "Private driver data not found!\n");
520 entry = drv_data->device_props;
522 hid_err(hid, "Device properties not found!\n");
525 value = entry->report->field[0]->value;
527 spin_lock_irqsave(&entry->report_lock, flags);
530 value[2] = magnitude >> 14;
531 value[3] = magnitude >> 14;
532 value[4] = magnitude;
536 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
537 spin_unlock_irqrestore(&entry->report_lock, flags);
540 /* Sends command to set range compatible with G25/G27/Driving Force GT */
541 static void lg4ff_set_range_g25(struct hid_device *hid, u16 range)
543 struct lg4ff_device_entry *entry;
544 struct lg_drv_data *drv_data;
548 drv_data = hid_get_drvdata(hid);
550 hid_err(hid, "Private driver data not found!\n");
554 entry = drv_data->device_props;
556 hid_err(hid, "Device properties not found!\n");
559 value = entry->report->field[0]->value;
560 dbg_hid("G25/G27/DFGT: setting range to %u\n", range);
562 spin_lock_irqsave(&entry->report_lock, flags);
565 value[2] = range & 0x00ff;
566 value[3] = (range & 0xff00) >> 8;
571 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
572 spin_unlock_irqrestore(&entry->report_lock, flags);
575 /* Sends commands to set range compatible with Driving Force Pro wheel */
576 static void lg4ff_set_range_dfp(struct hid_device *hid, u16 range)
578 struct lg4ff_device_entry *entry;
579 struct lg_drv_data *drv_data;
581 int start_left, start_right, full_range;
584 drv_data = hid_get_drvdata(hid);
586 hid_err(hid, "Private driver data not found!\n");
590 entry = drv_data->device_props;
592 hid_err(hid, "Device properties not found!\n");
595 value = entry->report->field[0]->value;
596 dbg_hid("Driving Force Pro: setting range to %u\n", range);
598 /* Prepare "coarse" limit command */
599 spin_lock_irqsave(&entry->report_lock, flags);
601 value[1] = 0x00; /* Set later */
615 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
617 /* Prepare "fine" limit command */
626 if (range == 200 || range == 900) { /* Do not apply any fine limit */
627 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
628 spin_unlock_irqrestore(&entry->report_lock, flags);
632 /* Construct fine limit command */
633 start_left = (((full_range - range + 1) * 2047) / full_range);
634 start_right = 0xfff - start_left;
636 value[2] = start_left >> 4;
637 value[3] = start_right >> 4;
639 value[5] = (start_right & 0xe) << 4 | (start_left & 0xe);
642 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
643 spin_unlock_irqrestore(&entry->report_lock, flags);
646 static const struct lg4ff_compat_mode_switch *lg4ff_get_mode_switch_command(const u16 real_product_id, const u16 target_product_id)
648 switch (real_product_id) {
649 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
650 switch (target_product_id) {
651 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
652 return &lg4ff_mode_switch_ext01_dfp;
653 /* DFP can only be switched to its native mode */
658 case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
659 switch (target_product_id) {
660 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
661 return &lg4ff_mode_switch_ext01_dfp;
662 case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
663 return &lg4ff_mode_switch_ext16_g25;
664 /* G25 can only be switched to DFP mode or its native mode */
669 case USB_DEVICE_ID_LOGITECH_G27_WHEEL:
670 switch (target_product_id) {
671 case USB_DEVICE_ID_LOGITECH_WHEEL:
672 return &lg4ff_mode_switch_ext09_dfex;
673 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
674 return &lg4ff_mode_switch_ext09_dfp;
675 case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
676 return &lg4ff_mode_switch_ext09_g25;
677 case USB_DEVICE_ID_LOGITECH_G27_WHEEL:
678 return &lg4ff_mode_switch_ext09_g27;
679 /* G27 can only be switched to DF-EX, DFP, G25 or its native mode */
684 case USB_DEVICE_ID_LOGITECH_G29_WHEEL:
685 switch (target_product_id) {
686 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
687 return &lg4ff_mode_switch_ext09_dfp;
688 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL:
689 return &lg4ff_mode_switch_ext09_dfgt;
690 case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
691 return &lg4ff_mode_switch_ext09_g25;
692 case USB_DEVICE_ID_LOGITECH_G27_WHEEL:
693 return &lg4ff_mode_switch_ext09_g27;
694 case USB_DEVICE_ID_LOGITECH_G29_WHEEL:
695 return &lg4ff_mode_switch_ext09_g29;
696 /* G29 can only be switched to DF-EX, DFP, DFGT, G25, G27 or its native mode */
701 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL:
702 switch (target_product_id) {
703 case USB_DEVICE_ID_LOGITECH_WHEEL:
704 return &lg4ff_mode_switch_ext09_dfex;
705 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
706 return &lg4ff_mode_switch_ext09_dfp;
707 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL:
708 return &lg4ff_mode_switch_ext09_dfgt;
709 /* DFGT can only be switched to DF-EX, DFP or its native mode */
714 /* No other wheels have multiple modes */
720 static int lg4ff_switch_compatibility_mode(struct hid_device *hid, const struct lg4ff_compat_mode_switch *s)
722 struct lg4ff_device_entry *entry;
723 struct lg_drv_data *drv_data;
728 drv_data = hid_get_drvdata(hid);
730 hid_err(hid, "Private driver data not found!\n");
734 entry = drv_data->device_props;
736 hid_err(hid, "Device properties not found!\n");
739 value = entry->report->field[0]->value;
741 spin_lock_irqsave(&entry->report_lock, flags);
742 for (i = 0; i < s->cmd_count; i++) {
745 for (j = 0; j < 7; j++)
746 value[j] = s->cmd[j + (7*i)];
748 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
750 spin_unlock_irqrestore(&entry->report_lock, flags);
755 static ssize_t lg4ff_alternate_modes_show(struct device *dev, struct device_attribute *attr, char *buf)
757 struct hid_device *hid = to_hid_device(dev);
758 struct lg4ff_device_entry *entry;
759 struct lg_drv_data *drv_data;
763 drv_data = hid_get_drvdata(hid);
765 hid_err(hid, "Private driver data not found!\n");
769 entry = drv_data->device_props;
771 hid_err(hid, "Device properties not found!\n");
775 if (!entry->wdata.real_name) {
776 hid_err(hid, "NULL pointer to string\n");
780 for (i = 0; i < LG4FF_MODE_MAX_IDX; i++) {
781 if (entry->wdata.alternate_modes & BIT(i)) {
782 /* Print tag and full name */
783 count += scnprintf(buf + count, PAGE_SIZE - count, "%s: %s",
784 lg4ff_alternate_modes[i].tag,
785 !lg4ff_alternate_modes[i].product_id ? entry->wdata.real_name : lg4ff_alternate_modes[i].name);
786 if (count >= PAGE_SIZE - 1)
789 /* Mark the currently active mode with an asterisk */
790 if (lg4ff_alternate_modes[i].product_id == entry->wdata.product_id ||
791 (lg4ff_alternate_modes[i].product_id == 0 && entry->wdata.product_id == entry->wdata.real_product_id))
792 count += scnprintf(buf + count, PAGE_SIZE - count, " *\n");
794 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
796 if (count >= PAGE_SIZE - 1)
804 static ssize_t lg4ff_alternate_modes_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
806 struct hid_device *hid = to_hid_device(dev);
807 struct lg4ff_device_entry *entry;
808 struct lg_drv_data *drv_data;
809 const struct lg4ff_compat_mode_switch *s;
810 u16 target_product_id = 0;
814 drv_data = hid_get_drvdata(hid);
816 hid_err(hid, "Private driver data not found!\n");
820 entry = drv_data->device_props;
822 hid_err(hid, "Device properties not found!\n");
826 /* Allow \n at the end of the input parameter */
827 lbuf = kasprintf(GFP_KERNEL, "%s", buf);
832 if (lbuf[i-1] == '\n') {
840 for (i = 0; i < LG4FF_MODE_MAX_IDX; i++) {
841 const u16 mode_product_id = lg4ff_alternate_modes[i].product_id;
842 const char *tag = lg4ff_alternate_modes[i].tag;
844 if (entry->wdata.alternate_modes & BIT(i)) {
845 if (!strcmp(tag, lbuf)) {
846 if (!mode_product_id)
847 target_product_id = entry->wdata.real_product_id;
849 target_product_id = mode_product_id;
855 if (i == LG4FF_MODE_MAX_IDX) {
856 hid_info(hid, "Requested mode \"%s\" is not supported by the device\n", lbuf);
860 kfree(lbuf); /* Not needed anymore */
862 if (target_product_id == entry->wdata.product_id) /* Nothing to do */
865 /* Automatic switching has to be disabled for the switch to DF-EX mode to work correctly */
866 if (target_product_id == USB_DEVICE_ID_LOGITECH_WHEEL && !lg4ff_no_autoswitch) {
867 hid_info(hid, "\"%s\" cannot be switched to \"DF-EX\" mode. Load the \"hid_logitech\" module with \"lg4ff_no_autoswitch=1\" parameter set and try again\n",
868 entry->wdata.real_name);
872 /* Take care of hardware limitations */
873 if ((entry->wdata.real_product_id == USB_DEVICE_ID_LOGITECH_DFP_WHEEL || entry->wdata.real_product_id == USB_DEVICE_ID_LOGITECH_G25_WHEEL) &&
874 entry->wdata.product_id > target_product_id) {
875 hid_info(hid, "\"%s\" cannot be switched back into \"%s\" mode\n", entry->wdata.real_name, lg4ff_alternate_modes[i].name);
879 s = lg4ff_get_mode_switch_command(entry->wdata.real_product_id, target_product_id);
881 hid_err(hid, "Invalid target product ID %X\n", target_product_id);
885 ret = lg4ff_switch_compatibility_mode(hid, s);
886 return (ret == 0 ? count : ret);
888 static DEVICE_ATTR(alternate_modes, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, lg4ff_alternate_modes_show, lg4ff_alternate_modes_store);
890 /* Export the currently set range of the wheel */
891 static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr,
894 struct hid_device *hid = to_hid_device(dev);
895 struct lg4ff_device_entry *entry;
896 struct lg_drv_data *drv_data;
899 drv_data = hid_get_drvdata(hid);
901 hid_err(hid, "Private driver data not found!\n");
905 entry = drv_data->device_props;
907 hid_err(hid, "Device properties not found!\n");
911 count = scnprintf(buf, PAGE_SIZE, "%u\n", entry->wdata.range);
915 /* Set range to user specified value, call appropriate function
916 * according to the type of the wheel */
917 static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr,
918 const char *buf, size_t count)
920 struct hid_device *hid = to_hid_device(dev);
921 struct lg4ff_device_entry *entry;
922 struct lg_drv_data *drv_data;
923 u16 range = simple_strtoul(buf, NULL, 10);
925 drv_data = hid_get_drvdata(hid);
927 hid_err(hid, "Private driver data not found!\n");
931 entry = drv_data->device_props;
933 hid_err(hid, "Device properties not found!\n");
938 range = entry->wdata.max_range;
940 /* Check if the wheel supports range setting
941 * and that the range is within limits for the wheel */
942 if (entry->wdata.set_range && range >= entry->wdata.min_range && range <= entry->wdata.max_range) {
943 entry->wdata.set_range(hid, range);
944 entry->wdata.range = range;
949 static DEVICE_ATTR(range, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, lg4ff_range_show, lg4ff_range_store);
951 static ssize_t lg4ff_real_id_show(struct device *dev, struct device_attribute *attr, char *buf)
953 struct hid_device *hid = to_hid_device(dev);
954 struct lg4ff_device_entry *entry;
955 struct lg_drv_data *drv_data;
958 drv_data = hid_get_drvdata(hid);
960 hid_err(hid, "Private driver data not found!\n");
964 entry = drv_data->device_props;
966 hid_err(hid, "Device properties not found!\n");
970 if (!entry->wdata.real_tag || !entry->wdata.real_name) {
971 hid_err(hid, "NULL pointer to string\n");
975 count = scnprintf(buf, PAGE_SIZE, "%s: %s\n", entry->wdata.real_tag, entry->wdata.real_name);
979 static ssize_t lg4ff_real_id_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
981 /* Real ID is a read-only value */
984 static DEVICE_ATTR(real_id, S_IRUGO, lg4ff_real_id_show, lg4ff_real_id_store);
986 #ifdef CONFIG_LEDS_CLASS
987 static void lg4ff_set_leds(struct hid_device *hid, u8 leds)
989 struct lg_drv_data *drv_data;
990 struct lg4ff_device_entry *entry;
994 drv_data = hid_get_drvdata(hid);
996 hid_err(hid, "Private driver data not found!\n");
1000 entry = drv_data->device_props;
1002 hid_err(hid, "Device properties not found!\n");
1005 value = entry->report->field[0]->value;
1007 spin_lock_irqsave(&entry->report_lock, flags);
1015 hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
1016 spin_unlock_irqrestore(&entry->report_lock, flags);
1019 static void lg4ff_led_set_brightness(struct led_classdev *led_cdev,
1020 enum led_brightness value)
1022 struct device *dev = led_cdev->dev->parent;
1023 struct hid_device *hid = container_of(dev, struct hid_device, dev);
1024 struct lg_drv_data *drv_data = hid_get_drvdata(hid);
1025 struct lg4ff_device_entry *entry;
1029 hid_err(hid, "Device data not found.");
1033 entry = drv_data->device_props;
1036 hid_err(hid, "Device properties not found.");
1040 for (i = 0; i < 5; i++) {
1041 if (led_cdev != entry->wdata.led[i])
1043 state = (entry->wdata.led_state >> i) & 1;
1044 if (value == LED_OFF && state) {
1045 entry->wdata.led_state &= ~(1 << i);
1046 lg4ff_set_leds(hid, entry->wdata.led_state);
1047 } else if (value != LED_OFF && !state) {
1048 entry->wdata.led_state |= 1 << i;
1049 lg4ff_set_leds(hid, entry->wdata.led_state);
1055 static enum led_brightness lg4ff_led_get_brightness(struct led_classdev *led_cdev)
1057 struct device *dev = led_cdev->dev->parent;
1058 struct hid_device *hid = container_of(dev, struct hid_device, dev);
1059 struct lg_drv_data *drv_data = hid_get_drvdata(hid);
1060 struct lg4ff_device_entry *entry;
1064 hid_err(hid, "Device data not found.");
1068 entry = drv_data->device_props;
1071 hid_err(hid, "Device properties not found.");
1075 for (i = 0; i < 5; i++)
1076 if (led_cdev == entry->wdata.led[i]) {
1077 value = (entry->wdata.led_state >> i) & 1;
1081 return value ? LED_FULL : LED_OFF;
1085 static u16 lg4ff_identify_multimode_wheel(struct hid_device *hid, const u16 reported_product_id, const u16 bcdDevice)
1090 /* identify current mode from USB PID */
1091 for (i = 1; i < ARRAY_SIZE(lg4ff_alternate_modes); i++) {
1092 dbg_hid("Testing whether PID is %X\n", lg4ff_alternate_modes[i].product_id);
1093 if (reported_product_id == lg4ff_alternate_modes[i].product_id)
1097 if (i == ARRAY_SIZE(lg4ff_alternate_modes))
1100 current_mode = BIT(i);
1102 for (i = 0; i < ARRAY_SIZE(lg4ff_main_checklist); i++) {
1103 const u16 mask = lg4ff_main_checklist[i]->mask;
1104 const u16 result = lg4ff_main_checklist[i]->result;
1105 const u16 real_product_id = lg4ff_main_checklist[i]->real_product_id;
1107 if ((current_mode & lg4ff_main_checklist[i]->modes) && \
1108 (bcdDevice & mask) == result) {
1109 dbg_hid("Found wheel with real PID %X whose reported PID is %X\n", real_product_id, reported_product_id);
1110 return real_product_id;
1114 /* No match found. This is either Driving Force or an unknown
1115 * wheel model, do not touch it */
1116 dbg_hid("Wheel with bcdDevice %X was not recognized as multimode wheel, leaving in its current mode\n", bcdDevice);
1120 static int lg4ff_handle_multimode_wheel(struct hid_device *hid, u16 *real_product_id, const u16 bcdDevice)
1122 const u16 reported_product_id = hid->product;
1125 *real_product_id = lg4ff_identify_multimode_wheel(hid, reported_product_id, bcdDevice);
1126 /* Probed wheel is not a multimode wheel */
1127 if (!*real_product_id) {
1128 *real_product_id = reported_product_id;
1129 dbg_hid("Wheel is not a multimode wheel\n");
1130 return LG4FF_MMODE_NOT_MULTIMODE;
1133 /* Switch from "Driving Force" mode to native mode automatically.
1134 * Otherwise keep the wheel in its current mode */
1135 if (reported_product_id == USB_DEVICE_ID_LOGITECH_WHEEL &&
1136 reported_product_id != *real_product_id &&
1137 !lg4ff_no_autoswitch) {
1138 const struct lg4ff_compat_mode_switch *s = lg4ff_get_mode_switch_command(*real_product_id, *real_product_id);
1141 hid_err(hid, "Invalid product id %X\n", *real_product_id);
1142 return LG4FF_MMODE_NOT_MULTIMODE;
1145 ret = lg4ff_switch_compatibility_mode(hid, s);
1147 /* Wheel could not have been switched to native mode,
1148 * leave it in "Driving Force" mode and continue */
1149 hid_err(hid, "Unable to switch wheel mode, errno %d\n", ret);
1150 return LG4FF_MMODE_IS_MULTIMODE;
1152 return LG4FF_MMODE_SWITCHED;
1155 return LG4FF_MMODE_IS_MULTIMODE;
1159 int lg4ff_init(struct hid_device *hid)
1161 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
1162 struct input_dev *dev = hidinput->input;
1163 struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
1164 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
1165 const struct usb_device_descriptor *udesc = &(hid_to_usb_dev(hid)->descriptor);
1166 const u16 bcdDevice = le16_to_cpu(udesc->bcdDevice);
1167 const struct lg4ff_multimode_wheel *mmode_wheel = NULL;
1168 struct lg4ff_device_entry *entry;
1169 struct lg_drv_data *drv_data;
1171 int mmode_ret, mmode_idx = -1;
1172 u16 real_product_id;
1174 /* Check that the report looks ok */
1175 if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 7))
1178 drv_data = hid_get_drvdata(hid);
1180 hid_err(hid, "Cannot add device, private driver data not allocated\n");
1183 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
1186 spin_lock_init(&entry->report_lock);
1187 entry->report = report;
1188 drv_data->device_props = entry;
1190 /* Check if a multimode wheel has been connected and
1191 * handle it appropriately */
1192 mmode_ret = lg4ff_handle_multimode_wheel(hid, &real_product_id, bcdDevice);
1194 /* Wheel has been told to switch to native mode. There is no point in going on
1195 * with the initialization as the wheel will do a USB reset when it switches mode
1197 if (mmode_ret == LG4FF_MMODE_SWITCHED)
1199 else if (mmode_ret < 0) {
1200 hid_err(hid, "Unable to switch device mode during initialization, errno %d\n", mmode_ret);
1205 /* Check what wheel has been connected */
1206 for (i = 0; i < ARRAY_SIZE(lg4ff_devices); i++) {
1207 if (hid->product == lg4ff_devices[i].product_id) {
1208 dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices[i].product_id);
1213 if (i == ARRAY_SIZE(lg4ff_devices)) {
1214 hid_err(hid, "This device is flagged to be handled by the lg4ff module but this module does not know how to handle it. "
1215 "Please report this as a bug to LKML, Simon Wood <simon@mungewell.org> or "
1216 "Michal Maly <madcatxster@devoid-pointer.net>\n");
1221 if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1222 for (mmode_idx = 0; mmode_idx < ARRAY_SIZE(lg4ff_multimode_wheels); mmode_idx++) {
1223 if (real_product_id == lg4ff_multimode_wheels[mmode_idx].product_id)
1227 if (mmode_idx == ARRAY_SIZE(lg4ff_multimode_wheels)) {
1228 hid_err(hid, "Device product ID %X is not listed as a multimode wheel", real_product_id);
1234 /* Set supported force feedback capabilities */
1235 for (j = 0; lg4ff_devices[i].ff_effects[j] >= 0; j++)
1236 set_bit(lg4ff_devices[i].ff_effects[j], dev->ffbit);
1238 error = input_ff_create_memless(dev, NULL, lg4ff_play);
1243 /* Initialize device properties */
1244 if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1245 BUG_ON(mmode_idx == -1);
1246 mmode_wheel = &lg4ff_multimode_wheels[mmode_idx];
1248 lg4ff_init_wheel_data(&entry->wdata, &lg4ff_devices[i], mmode_wheel, real_product_id);
1250 /* Check if autocentering is available and
1251 * set the centering force to zero by default */
1252 if (test_bit(FF_AUTOCENTER, dev->ffbit)) {
1253 /* Formula Force EX expects different autocentering command */
1254 if ((bcdDevice >> 8) == LG4FF_FFEX_REV_MAJ &&
1255 (bcdDevice & 0xff) == LG4FF_FFEX_REV_MIN)
1256 dev->ff->set_autocenter = lg4ff_set_autocenter_ffex;
1258 dev->ff->set_autocenter = lg4ff_set_autocenter_default;
1260 dev->ff->set_autocenter(dev, 0);
1263 /* Create sysfs interface */
1264 error = device_create_file(&hid->dev, &dev_attr_range);
1266 hid_warn(hid, "Unable to create sysfs interface for \"range\", errno %d\n", error);
1267 if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1268 error = device_create_file(&hid->dev, &dev_attr_real_id);
1270 hid_warn(hid, "Unable to create sysfs interface for \"real_id\", errno %d\n", error);
1271 error = device_create_file(&hid->dev, &dev_attr_alternate_modes);
1273 hid_warn(hid, "Unable to create sysfs interface for \"alternate_modes\", errno %d\n", error);
1275 dbg_hid("sysfs interface created\n");
1277 /* Set the maximum range to start with */
1278 entry->wdata.range = entry->wdata.max_range;
1279 if (entry->wdata.set_range)
1280 entry->wdata.set_range(hid, entry->wdata.range);
1282 #ifdef CONFIG_LEDS_CLASS
1283 /* register led subsystem - G27/G29 only */
1284 entry->wdata.led_state = 0;
1285 for (j = 0; j < 5; j++)
1286 entry->wdata.led[j] = NULL;
1288 if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_G27_WHEEL ||
1289 lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_G29_WHEEL) {
1290 struct led_classdev *led;
1294 lg4ff_set_leds(hid, 0);
1296 name_sz = strlen(dev_name(&hid->dev)) + 8;
1298 for (j = 0; j < 5; j++) {
1299 led = kzalloc(sizeof(struct led_classdev)+name_sz, GFP_KERNEL);
1301 hid_err(hid, "can't allocate memory for LED %d\n", j);
1305 name = (void *)(&led[1]);
1306 snprintf(name, name_sz, "%s::RPM%d", dev_name(&hid->dev), j+1);
1308 led->brightness = 0;
1309 led->max_brightness = 1;
1310 led->brightness_get = lg4ff_led_get_brightness;
1311 led->brightness_set = lg4ff_led_set_brightness;
1313 entry->wdata.led[j] = led;
1314 error = led_classdev_register(&hid->dev, led);
1317 hid_err(hid, "failed to register LED %d. Aborting.\n", j);
1319 /* Deregister LEDs (if any) */
1320 for (j = 0; j < 5; j++) {
1321 led = entry->wdata.led[j];
1322 entry->wdata.led[j] = NULL;
1325 led_classdev_unregister(led);
1328 goto out; /* Let the driver continue without LEDs */
1334 hid_info(hid, "Force feedback support for Logitech Gaming Wheels\n");
1338 drv_data->device_props = NULL;
1343 int lg4ff_deinit(struct hid_device *hid)
1345 struct lg4ff_device_entry *entry;
1346 struct lg_drv_data *drv_data;
1348 drv_data = hid_get_drvdata(hid);
1350 hid_err(hid, "Error while deinitializing device, no private driver data.\n");
1353 entry = drv_data->device_props;
1355 goto out; /* Nothing more to do */
1357 /* Multimode devices will have at least the "MODE_NATIVE" bit set */
1358 if (entry->wdata.alternate_modes) {
1359 device_remove_file(&hid->dev, &dev_attr_real_id);
1360 device_remove_file(&hid->dev, &dev_attr_alternate_modes);
1363 device_remove_file(&hid->dev, &dev_attr_range);
1364 #ifdef CONFIG_LEDS_CLASS
1367 struct led_classdev *led;
1369 /* Deregister LEDs (if any) */
1370 for (j = 0; j < 5; j++) {
1372 led = entry->wdata.led[j];
1373 entry->wdata.led[j] = NULL;
1376 led_classdev_unregister(led);
1382 drv_data->device_props = NULL;
1386 dbg_hid("Device successfully unregistered\n");