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_MAX_IDX 6
50 #define LG4FF_MODE_NATIVE BIT(LG4FF_MODE_NATIVE_IDX)
51 #define LG4FF_MODE_DFEX BIT(LG4FF_MODE_DFEX_IDX)
52 #define LG4FF_MODE_DFP BIT(LG4FF_MODE_DFP_IDX)
53 #define LG4FF_MODE_G25 BIT(LG4FF_MODE_G25_IDX)
54 #define LG4FF_MODE_DFGT BIT(LG4FF_MODE_DFGT_IDX)
55 #define LG4FF_MODE_G27 BIT(LG4FF_MODE_G27_IDX)
57 #define LG4FF_DFEX_TAG "DF-EX"
58 #define LG4FF_DFEX_NAME "Driving Force / Formula EX"
59 #define LG4FF_DFP_TAG "DFP"
60 #define LG4FF_DFP_NAME "Driving Force Pro"
61 #define LG4FF_G25_TAG "G25"
62 #define LG4FF_G25_NAME "G25 Racing Wheel"
63 #define LG4FF_G27_TAG "G27"
64 #define LG4FF_G27_NAME "G27 Racing Wheel"
65 #define LG4FF_DFGT_TAG "DFGT"
66 #define LG4FF_DFGT_NAME "Driving Force GT"
68 #define LG4FF_FFEX_REV_MAJ 0x21
69 #define LG4FF_FFEX_REV_MIN 0x00
71 static void lg4ff_set_range_dfp(struct hid_device
*hid
, u16 range
);
72 static void lg4ff_set_range_g25(struct hid_device
*hid
, u16 range
);
74 struct lg4ff_wheel_data
{
79 #ifdef CONFIG_LEDS_CLASS
81 struct led_classdev
*led
[5];
83 const u32 alternate_modes
;
84 const char * const real_tag
;
85 const char * const real_name
;
86 const u16 real_product_id
;
88 void (*set_range
)(struct hid_device
*hid
, u16 range
);
91 struct lg4ff_device_entry
{
92 spinlock_t report_lock
; /* Protect output HID report */
93 struct hid_report
*report
;
94 struct lg4ff_wheel_data wdata
;
97 static const signed short lg4ff_wheel_effects
[] = {
104 const u32 product_id
;
105 const signed short *ff_effects
;
108 void (*set_range
)(struct hid_device
*hid
, u16 range
);
111 struct lg4ff_compat_mode_switch
{
112 const u8 cmd_count
; /* Number of commands to send */
116 struct lg4ff_wheel_ident_info
{
119 const u16 real_product_id
;
122 struct lg4ff_wheel_ident_checklist
{
124 const struct lg4ff_wheel_ident_info
*models
[];
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_MOMO_WHEEL2
, lg4ff_wheel_effects
, 40, 270, NULL
},
148 {USB_DEVICE_ID_LOGITECH_WII_WHEEL
, lg4ff_wheel_effects
, 40, 270, NULL
}
151 static const struct lg4ff_multimode_wheel lg4ff_multimode_wheels
[] = {
152 {USB_DEVICE_ID_LOGITECH_DFP_WHEEL
,
153 LG4FF_MODE_NATIVE
| LG4FF_MODE_DFP
| LG4FF_MODE_DFEX
,
154 LG4FF_DFP_TAG
, LG4FF_DFP_NAME
},
155 {USB_DEVICE_ID_LOGITECH_G25_WHEEL
,
156 LG4FF_MODE_NATIVE
| LG4FF_MODE_G25
| LG4FF_MODE_DFP
| LG4FF_MODE_DFEX
,
157 LG4FF_G25_TAG
, LG4FF_G25_NAME
},
158 {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
,
159 LG4FF_MODE_NATIVE
| LG4FF_MODE_DFGT
| LG4FF_MODE_DFP
| LG4FF_MODE_DFEX
,
160 LG4FF_DFGT_TAG
, LG4FF_DFGT_NAME
},
161 {USB_DEVICE_ID_LOGITECH_G27_WHEEL
,
162 LG4FF_MODE_NATIVE
| LG4FF_MODE_G27
| LG4FF_MODE_G25
| LG4FF_MODE_DFP
| LG4FF_MODE_DFEX
,
163 LG4FF_G27_TAG
, LG4FF_G27_NAME
},
166 static const struct lg4ff_alternate_mode lg4ff_alternate_modes
[] = {
167 [LG4FF_MODE_NATIVE_IDX
] = {0, "native", ""},
168 [LG4FF_MODE_DFEX_IDX
] = {USB_DEVICE_ID_LOGITECH_WHEEL
, LG4FF_DFEX_TAG
, LG4FF_DFEX_NAME
},
169 [LG4FF_MODE_DFP_IDX
] = {USB_DEVICE_ID_LOGITECH_DFP_WHEEL
, LG4FF_DFP_TAG
, LG4FF_DFP_NAME
},
170 [LG4FF_MODE_G25_IDX
] = {USB_DEVICE_ID_LOGITECH_G25_WHEEL
, LG4FF_G25_TAG
, LG4FF_G25_NAME
},
171 [LG4FF_MODE_DFGT_IDX
] = {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
, LG4FF_DFGT_TAG
, LG4FF_DFGT_NAME
},
172 [LG4FF_MODE_G27_IDX
] = {USB_DEVICE_ID_LOGITECH_G27_WHEEL
, LG4FF_G27_TAG
, LG4FF_G27_NAME
}
175 /* Multimode wheel identificators */
176 static const struct lg4ff_wheel_ident_info lg4ff_dfp_ident_info
= {
179 USB_DEVICE_ID_LOGITECH_DFP_WHEEL
182 static const struct lg4ff_wheel_ident_info lg4ff_g25_ident_info
= {
185 USB_DEVICE_ID_LOGITECH_G25_WHEEL
188 static const struct lg4ff_wheel_ident_info lg4ff_g27_ident_info
= {
191 USB_DEVICE_ID_LOGITECH_G27_WHEEL
194 static const struct lg4ff_wheel_ident_info lg4ff_dfgt_ident_info
= {
197 USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
200 /* Multimode wheel identification checklists */
201 static const struct lg4ff_wheel_ident_checklist lg4ff_main_checklist
= {
203 {&lg4ff_dfgt_ident_info
,
204 &lg4ff_g27_ident_info
,
205 &lg4ff_g25_ident_info
,
206 &lg4ff_dfp_ident_info
}
209 /* Compatibility mode switching commands */
210 /* EXT_CMD9 - Understood by G27 and DFGT */
211 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfex
= {
213 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
214 0xf8, 0x09, 0x00, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DF-EX with detach */
217 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfp
= {
219 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
220 0xf8, 0x09, 0x01, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DFP with detach */
223 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g25
= {
225 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
226 0xf8, 0x09, 0x02, 0x01, 0x00, 0x00, 0x00} /* Switch mode to G25 with detach */
229 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfgt
= {
231 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
232 0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00} /* Switch mode to DFGT with detach */
235 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g27
= {
237 {0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* Revert mode upon USB reset */
238 0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00} /* Switch mode to G27 with detach */
241 /* EXT_CMD1 - Understood by DFP, G25, G27 and DFGT */
242 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext01_dfp
= {
244 {0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
247 /* EXT_CMD16 - Understood by G25 and G27 */
248 static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext16_g25
= {
250 {0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
253 /* Recalculates X axis value accordingly to currently selected range */
254 static s32
lg4ff_adjust_dfp_x_axis(s32 value
, u16 range
)
261 else if (range
== 200)
263 else if (range
< 200)
268 new_value
= 8192 + mult_frac(value
- 8192, max_range
, range
);
271 else if (new_value
> 16383)
277 int lg4ff_adjust_input_event(struct hid_device
*hid
, struct hid_field
*field
,
278 struct hid_usage
*usage
, s32 value
, struct lg_drv_data
*drv_data
)
280 struct lg4ff_device_entry
*entry
= drv_data
->device_props
;
284 hid_err(hid
, "Device properties not found");
288 switch (entry
->wdata
.product_id
) {
289 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
290 switch (usage
->code
) {
292 new_value
= lg4ff_adjust_dfp_x_axis(value
, entry
->wdata
.range
);
293 input_event(field
->hidinput
->input
, usage
->type
, usage
->code
, new_value
);
303 static void lg4ff_init_wheel_data(struct lg4ff_wheel_data
* const wdata
, const struct lg4ff_wheel
*wheel
,
304 const struct lg4ff_multimode_wheel
*mmode_wheel
,
305 const u16 real_product_id
)
307 u32 alternate_modes
= 0;
308 const char *real_tag
= NULL
;
309 const char *real_name
= NULL
;
312 alternate_modes
= mmode_wheel
->alternate_modes
;
313 real_tag
= mmode_wheel
->real_tag
;
314 real_name
= mmode_wheel
->real_name
;
318 struct lg4ff_wheel_data t_wdata
= { .product_id
= wheel
->product_id
,
319 .real_product_id
= real_product_id
,
320 .min_range
= wheel
->min_range
,
321 .max_range
= wheel
->max_range
,
322 .set_range
= wheel
->set_range
,
323 .alternate_modes
= alternate_modes
,
324 .real_tag
= real_tag
,
325 .real_name
= real_name
};
327 memcpy(wdata
, &t_wdata
, sizeof(t_wdata
));
331 static int lg4ff_play(struct input_dev
*dev
, void *data
, struct ff_effect
*effect
)
333 struct hid_device
*hid
= input_get_drvdata(dev
);
334 struct lg4ff_device_entry
*entry
;
335 struct lg_drv_data
*drv_data
;
340 drv_data
= hid_get_drvdata(hid
);
342 hid_err(hid
, "Private driver data not found!\n");
346 entry
= drv_data
->device_props
;
348 hid_err(hid
, "Device properties not found!\n");
351 value
= entry
->report
->field
[0]->value
;
353 #define CLAMP(x) do { if (x < 0) x = 0; else if (x > 0xff) x = 0xff; } while (0)
355 switch (effect
->type
) {
357 x
= effect
->u
.ramp
.start_level
+ 0x80; /* 0x80 is no force */
360 spin_lock_irqsave(&entry
->report_lock
, flags
);
362 /* De-activate force in slot-1*/
371 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
372 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
376 value
[0] = 0x11; /* Slot 1 */
384 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
385 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
391 /* Sends default autocentering command compatible with
392 * all wheels except Formula Force EX */
393 static void lg4ff_set_autocenter_default(struct input_dev
*dev
, u16 magnitude
)
395 struct hid_device
*hid
= input_get_drvdata(dev
);
396 struct list_head
*report_list
= &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
;
397 struct hid_report
*report
= list_entry(report_list
->next
, struct hid_report
, list
);
398 s32
*value
= report
->field
[0]->value
;
399 u32 expand_a
, expand_b
;
400 struct lg4ff_device_entry
*entry
;
401 struct lg_drv_data
*drv_data
;
404 drv_data
= hid_get_drvdata(hid
);
406 hid_err(hid
, "Private driver data not found!\n");
410 entry
= drv_data
->device_props
;
412 hid_err(hid
, "Device properties not found!\n");
415 value
= entry
->report
->field
[0]->value
;
417 /* De-activate Auto-Center */
418 spin_lock_irqsave(&entry
->report_lock
, flags
);
419 if (magnitude
== 0) {
428 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
429 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
433 if (magnitude
<= 0xaaaa) {
434 expand_a
= 0x0c * magnitude
;
435 expand_b
= 0x80 * magnitude
;
437 expand_a
= (0x0c * 0xaaaa) + 0x06 * (magnitude
- 0xaaaa);
438 expand_b
= (0x80 * 0xaaaa) + 0xff * (magnitude
- 0xaaaa);
441 /* Adjust for non-MOMO wheels */
442 switch (entry
->wdata
.product_id
) {
443 case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL
:
444 case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2
:
447 expand_a
= expand_a
>> 1;
453 value
[2] = expand_a
/ 0xaaaa;
454 value
[3] = expand_a
/ 0xaaaa;
455 value
[4] = expand_b
/ 0xaaaa;
459 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
461 /* Activate Auto-Center */
470 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
471 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
474 /* Sends autocentering command compatible with Formula Force EX */
475 static void lg4ff_set_autocenter_ffex(struct input_dev
*dev
, u16 magnitude
)
477 struct hid_device
*hid
= input_get_drvdata(dev
);
478 struct lg4ff_device_entry
*entry
;
479 struct lg_drv_data
*drv_data
;
482 magnitude
= magnitude
* 90 / 65535;
484 drv_data
= hid_get_drvdata(hid
);
486 hid_err(hid
, "Private driver data not found!\n");
490 entry
= drv_data
->device_props
;
492 hid_err(hid
, "Device properties not found!\n");
495 value
= entry
->report
->field
[0]->value
;
497 spin_lock_irqsave(&entry
->report_lock
, flags
);
500 value
[2] = magnitude
>> 14;
501 value
[3] = magnitude
>> 14;
502 value
[4] = magnitude
;
506 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
507 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
510 /* Sends command to set range compatible with G25/G27/Driving Force GT */
511 static void lg4ff_set_range_g25(struct hid_device
*hid
, u16 range
)
513 struct lg4ff_device_entry
*entry
;
514 struct lg_drv_data
*drv_data
;
518 drv_data
= hid_get_drvdata(hid
);
520 hid_err(hid
, "Private driver data not found!\n");
524 entry
= drv_data
->device_props
;
526 hid_err(hid
, "Device properties not found!\n");
529 value
= entry
->report
->field
[0]->value
;
530 dbg_hid("G25/G27/DFGT: setting range to %u\n", range
);
532 spin_lock_irqsave(&entry
->report_lock
, flags
);
535 value
[2] = range
& 0x00ff;
536 value
[3] = (range
& 0xff00) >> 8;
541 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
542 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
545 /* Sends commands to set range compatible with Driving Force Pro wheel */
546 static void lg4ff_set_range_dfp(struct hid_device
*hid
, u16 range
)
548 struct lg4ff_device_entry
*entry
;
549 struct lg_drv_data
*drv_data
;
551 int start_left
, start_right
, full_range
;
554 drv_data
= hid_get_drvdata(hid
);
556 hid_err(hid
, "Private driver data not found!\n");
560 entry
= drv_data
->device_props
;
562 hid_err(hid
, "Device properties not found!\n");
565 value
= entry
->report
->field
[0]->value
;
566 dbg_hid("Driving Force Pro: setting range to %u\n", range
);
568 /* Prepare "coarse" limit command */
569 spin_lock_irqsave(&entry
->report_lock
, flags
);
571 value
[1] = 0x00; /* Set later */
585 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
587 /* Prepare "fine" limit command */
596 if (range
== 200 || range
== 900) { /* Do not apply any fine limit */
597 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
598 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
602 /* Construct fine limit command */
603 start_left
= (((full_range
- range
+ 1) * 2047) / full_range
);
604 start_right
= 0xfff - start_left
;
606 value
[2] = start_left
>> 4;
607 value
[3] = start_right
>> 4;
609 value
[5] = (start_right
& 0xe) << 4 | (start_left
& 0xe);
612 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
613 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
616 static const struct lg4ff_compat_mode_switch
*lg4ff_get_mode_switch_command(const u16 real_product_id
, const u16 target_product_id
)
618 switch (real_product_id
) {
619 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
620 switch (target_product_id
) {
621 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
622 return &lg4ff_mode_switch_ext01_dfp
;
623 /* DFP can only be switched to its native mode */
628 case USB_DEVICE_ID_LOGITECH_G25_WHEEL
:
629 switch (target_product_id
) {
630 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
631 return &lg4ff_mode_switch_ext01_dfp
;
632 case USB_DEVICE_ID_LOGITECH_G25_WHEEL
:
633 return &lg4ff_mode_switch_ext16_g25
;
634 /* G25 can only be switched to DFP mode or its native mode */
639 case USB_DEVICE_ID_LOGITECH_G27_WHEEL
:
640 switch (target_product_id
) {
641 case USB_DEVICE_ID_LOGITECH_WHEEL
:
642 return &lg4ff_mode_switch_ext09_dfex
;
643 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
644 return &lg4ff_mode_switch_ext09_dfp
;
645 case USB_DEVICE_ID_LOGITECH_G25_WHEEL
:
646 return &lg4ff_mode_switch_ext09_g25
;
647 case USB_DEVICE_ID_LOGITECH_G27_WHEEL
:
648 return &lg4ff_mode_switch_ext09_g27
;
649 /* G27 can only be switched to DF-EX, DFP, G25 or its native mode */
654 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
:
655 switch (target_product_id
) {
656 case USB_DEVICE_ID_LOGITECH_WHEEL
:
657 return &lg4ff_mode_switch_ext09_dfex
;
658 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
659 return &lg4ff_mode_switch_ext09_dfp
;
660 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
:
661 return &lg4ff_mode_switch_ext09_dfgt
;
662 /* DFGT can only be switched to DF-EX, DFP or its native mode */
667 /* No other wheels have multiple modes */
673 static int lg4ff_switch_compatibility_mode(struct hid_device
*hid
, const struct lg4ff_compat_mode_switch
*s
)
675 struct lg4ff_device_entry
*entry
;
676 struct lg_drv_data
*drv_data
;
681 drv_data
= hid_get_drvdata(hid
);
683 hid_err(hid
, "Private driver data not found!\n");
687 entry
= drv_data
->device_props
;
689 hid_err(hid
, "Device properties not found!\n");
692 value
= entry
->report
->field
[0]->value
;
694 spin_lock_irqsave(&entry
->report_lock
, flags
);
695 for (i
= 0; i
< s
->cmd_count
; i
++) {
698 for (j
= 0; j
< 7; j
++)
699 value
[j
] = s
->cmd
[j
+ (7*i
)];
701 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
703 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
708 static ssize_t
lg4ff_alternate_modes_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
710 struct hid_device
*hid
= to_hid_device(dev
);
711 struct lg4ff_device_entry
*entry
;
712 struct lg_drv_data
*drv_data
;
716 drv_data
= hid_get_drvdata(hid
);
718 hid_err(hid
, "Private driver data not found!\n");
722 entry
= drv_data
->device_props
;
724 hid_err(hid
, "Device properties not found!\n");
728 if (!entry
->wdata
.real_name
) {
729 hid_err(hid
, "NULL pointer to string\n");
733 for (i
= 0; i
< LG4FF_MODE_MAX_IDX
; i
++) {
734 if (entry
->wdata
.alternate_modes
& BIT(i
)) {
735 /* Print tag and full name */
736 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
, "%s: %s",
737 lg4ff_alternate_modes
[i
].tag
,
738 !lg4ff_alternate_modes
[i
].product_id
? entry
->wdata
.real_name
: lg4ff_alternate_modes
[i
].name
);
739 if (count
>= PAGE_SIZE
- 1)
742 /* Mark the currently active mode with an asterisk */
743 if (lg4ff_alternate_modes
[i
].product_id
== entry
->wdata
.product_id
||
744 (lg4ff_alternate_modes
[i
].product_id
== 0 && entry
->wdata
.product_id
== entry
->wdata
.real_product_id
))
745 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
, " *\n");
747 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
, "\n");
749 if (count
>= PAGE_SIZE
- 1)
757 static ssize_t
lg4ff_alternate_modes_store(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
759 struct hid_device
*hid
= to_hid_device(dev
);
760 struct lg4ff_device_entry
*entry
;
761 struct lg_drv_data
*drv_data
;
762 const struct lg4ff_compat_mode_switch
*s
;
763 u16 target_product_id
= 0;
767 drv_data
= hid_get_drvdata(hid
);
769 hid_err(hid
, "Private driver data not found!\n");
773 entry
= drv_data
->device_props
;
775 hid_err(hid
, "Device properties not found!\n");
779 /* Allow \n at the end of the input parameter */
780 lbuf
= kasprintf(GFP_KERNEL
, "%s", buf
);
785 if (lbuf
[i
-1] == '\n') {
793 for (i
= 0; i
< LG4FF_MODE_MAX_IDX
; i
++) {
794 const u16 mode_product_id
= lg4ff_alternate_modes
[i
].product_id
;
795 const char *tag
= lg4ff_alternate_modes
[i
].tag
;
797 if (entry
->wdata
.alternate_modes
& BIT(i
)) {
798 if (!strcmp(tag
, lbuf
)) {
799 if (!mode_product_id
)
800 target_product_id
= entry
->wdata
.real_product_id
;
802 target_product_id
= mode_product_id
;
808 if (i
== LG4FF_MODE_MAX_IDX
) {
809 hid_info(hid
, "Requested mode \"%s\" is not supported by the device\n", lbuf
);
813 kfree(lbuf
); /* Not needed anymore */
815 if (target_product_id
== entry
->wdata
.product_id
) /* Nothing to do */
818 /* Automatic switching has to be disabled for the switch to DF-EX mode to work correctly */
819 if (target_product_id
== USB_DEVICE_ID_LOGITECH_WHEEL
&& !lg4ff_no_autoswitch
) {
820 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",
821 entry
->wdata
.real_name
);
825 /* Take care of hardware limitations */
826 if ((entry
->wdata
.real_product_id
== USB_DEVICE_ID_LOGITECH_DFP_WHEEL
|| entry
->wdata
.real_product_id
== USB_DEVICE_ID_LOGITECH_G25_WHEEL
) &&
827 entry
->wdata
.product_id
> target_product_id
) {
828 hid_info(hid
, "\"%s\" cannot be switched back into \"%s\" mode\n", entry
->wdata
.real_name
, lg4ff_alternate_modes
[i
].name
);
832 s
= lg4ff_get_mode_switch_command(entry
->wdata
.real_product_id
, target_product_id
);
834 hid_err(hid
, "Invalid target product ID %X\n", target_product_id
);
838 ret
= lg4ff_switch_compatibility_mode(hid
, s
);
839 return (ret
== 0 ? count
: ret
);
841 static DEVICE_ATTR(alternate_modes
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
, lg4ff_alternate_modes_show
, lg4ff_alternate_modes_store
);
843 /* Export the currently set range of the wheel */
844 static ssize_t
lg4ff_range_show(struct device
*dev
, struct device_attribute
*attr
,
847 struct hid_device
*hid
= to_hid_device(dev
);
848 struct lg4ff_device_entry
*entry
;
849 struct lg_drv_data
*drv_data
;
852 drv_data
= hid_get_drvdata(hid
);
854 hid_err(hid
, "Private driver data not found!\n");
858 entry
= drv_data
->device_props
;
860 hid_err(hid
, "Device properties not found!\n");
864 count
= scnprintf(buf
, PAGE_SIZE
, "%u\n", entry
->wdata
.range
);
868 /* Set range to user specified value, call appropriate function
869 * according to the type of the wheel */
870 static ssize_t
lg4ff_range_store(struct device
*dev
, struct device_attribute
*attr
,
871 const char *buf
, size_t count
)
873 struct hid_device
*hid
= to_hid_device(dev
);
874 struct lg4ff_device_entry
*entry
;
875 struct lg_drv_data
*drv_data
;
876 u16 range
= simple_strtoul(buf
, NULL
, 10);
878 drv_data
= hid_get_drvdata(hid
);
880 hid_err(hid
, "Private driver data not found!\n");
884 entry
= drv_data
->device_props
;
886 hid_err(hid
, "Device properties not found!\n");
891 range
= entry
->wdata
.max_range
;
893 /* Check if the wheel supports range setting
894 * and that the range is within limits for the wheel */
895 if (entry
->wdata
.set_range
&& range
>= entry
->wdata
.min_range
&& range
<= entry
->wdata
.max_range
) {
896 entry
->wdata
.set_range(hid
, range
);
897 entry
->wdata
.range
= range
;
902 static DEVICE_ATTR(range
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
, lg4ff_range_show
, lg4ff_range_store
);
904 static ssize_t
lg4ff_real_id_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
906 struct hid_device
*hid
= to_hid_device(dev
);
907 struct lg4ff_device_entry
*entry
;
908 struct lg_drv_data
*drv_data
;
911 drv_data
= hid_get_drvdata(hid
);
913 hid_err(hid
, "Private driver data not found!\n");
917 entry
= drv_data
->device_props
;
919 hid_err(hid
, "Device properties not found!\n");
923 if (!entry
->wdata
.real_tag
|| !entry
->wdata
.real_name
) {
924 hid_err(hid
, "NULL pointer to string\n");
928 count
= scnprintf(buf
, PAGE_SIZE
, "%s: %s\n", entry
->wdata
.real_tag
, entry
->wdata
.real_name
);
932 static ssize_t
lg4ff_real_id_store(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
934 /* Real ID is a read-only value */
937 static DEVICE_ATTR(real_id
, S_IRUGO
, lg4ff_real_id_show
, lg4ff_real_id_store
);
939 #ifdef CONFIG_LEDS_CLASS
940 static void lg4ff_set_leds(struct hid_device
*hid
, u8 leds
)
942 struct lg_drv_data
*drv_data
;
943 struct lg4ff_device_entry
*entry
;
947 drv_data
= hid_get_drvdata(hid
);
949 hid_err(hid
, "Private driver data not found!\n");
953 entry
= drv_data
->device_props
;
955 hid_err(hid
, "Device properties not found!\n");
958 value
= entry
->report
->field
[0]->value
;
960 spin_lock_irqsave(&entry
->report_lock
, flags
);
968 hid_hw_request(hid
, entry
->report
, HID_REQ_SET_REPORT
);
969 spin_unlock_irqrestore(&entry
->report_lock
, flags
);
972 static void lg4ff_led_set_brightness(struct led_classdev
*led_cdev
,
973 enum led_brightness value
)
975 struct device
*dev
= led_cdev
->dev
->parent
;
976 struct hid_device
*hid
= container_of(dev
, struct hid_device
, dev
);
977 struct lg_drv_data
*drv_data
= hid_get_drvdata(hid
);
978 struct lg4ff_device_entry
*entry
;
982 hid_err(hid
, "Device data not found.");
986 entry
= drv_data
->device_props
;
989 hid_err(hid
, "Device properties not found.");
993 for (i
= 0; i
< 5; i
++) {
994 if (led_cdev
!= entry
->wdata
.led
[i
])
996 state
= (entry
->wdata
.led_state
>> i
) & 1;
997 if (value
== LED_OFF
&& state
) {
998 entry
->wdata
.led_state
&= ~(1 << i
);
999 lg4ff_set_leds(hid
, entry
->wdata
.led_state
);
1000 } else if (value
!= LED_OFF
&& !state
) {
1001 entry
->wdata
.led_state
|= 1 << i
;
1002 lg4ff_set_leds(hid
, entry
->wdata
.led_state
);
1008 static enum led_brightness
lg4ff_led_get_brightness(struct led_classdev
*led_cdev
)
1010 struct device
*dev
= led_cdev
->dev
->parent
;
1011 struct hid_device
*hid
= container_of(dev
, struct hid_device
, dev
);
1012 struct lg_drv_data
*drv_data
= hid_get_drvdata(hid
);
1013 struct lg4ff_device_entry
*entry
;
1017 hid_err(hid
, "Device data not found.");
1021 entry
= drv_data
->device_props
;
1024 hid_err(hid
, "Device properties not found.");
1028 for (i
= 0; i
< 5; i
++)
1029 if (led_cdev
== entry
->wdata
.led
[i
]) {
1030 value
= (entry
->wdata
.led_state
>> i
) & 1;
1034 return value
? LED_FULL
: LED_OFF
;
1038 static u16
lg4ff_identify_multimode_wheel(struct hid_device
*hid
, const u16 reported_product_id
, const u16 bcdDevice
)
1040 const struct lg4ff_wheel_ident_checklist
*checklist
;
1041 int i
, from_idx
, to_idx
;
1043 switch (reported_product_id
) {
1044 case USB_DEVICE_ID_LOGITECH_WHEEL
:
1045 case USB_DEVICE_ID_LOGITECH_DFP_WHEEL
:
1046 checklist
= &lg4ff_main_checklist
;
1048 to_idx
= checklist
->count
- 1;
1050 case USB_DEVICE_ID_LOGITECH_G25_WHEEL
:
1051 checklist
= &lg4ff_main_checklist
;
1053 to_idx
= checklist
->count
- 2; /* End identity check at G25 */
1055 case USB_DEVICE_ID_LOGITECH_G27_WHEEL
:
1056 checklist
= &lg4ff_main_checklist
;
1057 from_idx
= 1; /* Start identity check at G27 */
1058 to_idx
= checklist
->count
- 3; /* End identity check at G27 */
1060 case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
:
1061 checklist
= &lg4ff_main_checklist
;
1063 to_idx
= checklist
->count
- 4; /* End identity check at DFGT */
1069 for (i
= from_idx
; i
<= to_idx
; i
++) {
1070 const u16 mask
= checklist
->models
[i
]->mask
;
1071 const u16 result
= checklist
->models
[i
]->result
;
1072 const u16 real_product_id
= checklist
->models
[i
]->real_product_id
;
1074 if ((bcdDevice
& mask
) == result
) {
1075 dbg_hid("Found wheel with real PID %X whose reported PID is %X\n", real_product_id
, reported_product_id
);
1076 return real_product_id
;
1080 /* No match found. This is either Driving Force or an unknown
1081 * wheel model, do not touch it */
1082 dbg_hid("Wheel with bcdDevice %X was not recognized as multimode wheel, leaving in its current mode\n", bcdDevice
);
1086 static int lg4ff_handle_multimode_wheel(struct hid_device
*hid
, u16
*real_product_id
, const u16 bcdDevice
)
1088 const u16 reported_product_id
= hid
->product
;
1091 *real_product_id
= lg4ff_identify_multimode_wheel(hid
, reported_product_id
, bcdDevice
);
1092 /* Probed wheel is not a multimode wheel */
1093 if (!*real_product_id
) {
1094 *real_product_id
= reported_product_id
;
1095 dbg_hid("Wheel is not a multimode wheel\n");
1096 return LG4FF_MMODE_NOT_MULTIMODE
;
1099 /* Switch from "Driving Force" mode to native mode automatically.
1100 * Otherwise keep the wheel in its current mode */
1101 if (reported_product_id
== USB_DEVICE_ID_LOGITECH_WHEEL
&&
1102 reported_product_id
!= *real_product_id
&&
1103 !lg4ff_no_autoswitch
) {
1104 const struct lg4ff_compat_mode_switch
*s
= lg4ff_get_mode_switch_command(*real_product_id
, *real_product_id
);
1107 hid_err(hid
, "Invalid product id %X\n", *real_product_id
);
1108 return LG4FF_MMODE_NOT_MULTIMODE
;
1111 ret
= lg4ff_switch_compatibility_mode(hid
, s
);
1113 /* Wheel could not have been switched to native mode,
1114 * leave it in "Driving Force" mode and continue */
1115 hid_err(hid
, "Unable to switch wheel mode, errno %d\n", ret
);
1116 return LG4FF_MMODE_IS_MULTIMODE
;
1118 return LG4FF_MMODE_SWITCHED
;
1121 return LG4FF_MMODE_IS_MULTIMODE
;
1125 int lg4ff_init(struct hid_device
*hid
)
1127 struct hid_input
*hidinput
= list_entry(hid
->inputs
.next
, struct hid_input
, list
);
1128 struct input_dev
*dev
= hidinput
->input
;
1129 struct list_head
*report_list
= &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
;
1130 struct hid_report
*report
= list_entry(report_list
->next
, struct hid_report
, list
);
1131 const struct usb_device_descriptor
*udesc
= &(hid_to_usb_dev(hid
)->descriptor
);
1132 const u16 bcdDevice
= le16_to_cpu(udesc
->bcdDevice
);
1133 const struct lg4ff_multimode_wheel
*mmode_wheel
= NULL
;
1134 struct lg4ff_device_entry
*entry
;
1135 struct lg_drv_data
*drv_data
;
1137 int mmode_ret
, mmode_idx
= -1;
1138 u16 real_product_id
;
1140 /* Check that the report looks ok */
1141 if (!hid_validate_values(hid
, HID_OUTPUT_REPORT
, 0, 0, 7))
1144 drv_data
= hid_get_drvdata(hid
);
1146 hid_err(hid
, "Cannot add device, private driver data not allocated\n");
1149 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
1152 spin_lock_init(&entry
->report_lock
);
1153 entry
->report
= report
;
1154 drv_data
->device_props
= entry
;
1156 /* Check if a multimode wheel has been connected and
1157 * handle it appropriately */
1158 mmode_ret
= lg4ff_handle_multimode_wheel(hid
, &real_product_id
, bcdDevice
);
1160 /* Wheel has been told to switch to native mode. There is no point in going on
1161 * with the initialization as the wheel will do a USB reset when it switches mode
1163 if (mmode_ret
== LG4FF_MMODE_SWITCHED
)
1165 else if (mmode_ret
< 0) {
1166 hid_err(hid
, "Unable to switch device mode during initialization, errno %d\n", mmode_ret
);
1171 /* Check what wheel has been connected */
1172 for (i
= 0; i
< ARRAY_SIZE(lg4ff_devices
); i
++) {
1173 if (hid
->product
== lg4ff_devices
[i
].product_id
) {
1174 dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices
[i
].product_id
);
1179 if (i
== ARRAY_SIZE(lg4ff_devices
)) {
1180 hid_err(hid
, "This device is flagged to be handled by the lg4ff module but this module does not know how to handle it. "
1181 "Please report this as a bug to LKML, Simon Wood <simon@mungewell.org> or "
1182 "Michal Maly <madcatxster@devoid-pointer.net>\n");
1187 if (mmode_ret
== LG4FF_MMODE_IS_MULTIMODE
) {
1188 for (mmode_idx
= 0; mmode_idx
< ARRAY_SIZE(lg4ff_multimode_wheels
); mmode_idx
++) {
1189 if (real_product_id
== lg4ff_multimode_wheels
[mmode_idx
].product_id
)
1193 if (mmode_idx
== ARRAY_SIZE(lg4ff_multimode_wheels
)) {
1194 hid_err(hid
, "Device product ID %X is not listed as a multimode wheel", real_product_id
);
1200 /* Set supported force feedback capabilities */
1201 for (j
= 0; lg4ff_devices
[i
].ff_effects
[j
] >= 0; j
++)
1202 set_bit(lg4ff_devices
[i
].ff_effects
[j
], dev
->ffbit
);
1204 error
= input_ff_create_memless(dev
, NULL
, lg4ff_play
);
1209 /* Initialize device properties */
1210 if (mmode_ret
== LG4FF_MMODE_IS_MULTIMODE
) {
1211 BUG_ON(mmode_idx
== -1);
1212 mmode_wheel
= &lg4ff_multimode_wheels
[mmode_idx
];
1214 lg4ff_init_wheel_data(&entry
->wdata
, &lg4ff_devices
[i
], mmode_wheel
, real_product_id
);
1216 /* Check if autocentering is available and
1217 * set the centering force to zero by default */
1218 if (test_bit(FF_AUTOCENTER
, dev
->ffbit
)) {
1219 /* Formula Force EX expects different autocentering command */
1220 if ((bcdDevice
>> 8) == LG4FF_FFEX_REV_MAJ
&&
1221 (bcdDevice
& 0xff) == LG4FF_FFEX_REV_MIN
)
1222 dev
->ff
->set_autocenter
= lg4ff_set_autocenter_ffex
;
1224 dev
->ff
->set_autocenter
= lg4ff_set_autocenter_default
;
1226 dev
->ff
->set_autocenter(dev
, 0);
1229 /* Create sysfs interface */
1230 error
= device_create_file(&hid
->dev
, &dev_attr_range
);
1232 hid_warn(hid
, "Unable to create sysfs interface for \"range\", errno %d\n", error
);
1233 if (mmode_ret
== LG4FF_MMODE_IS_MULTIMODE
) {
1234 error
= device_create_file(&hid
->dev
, &dev_attr_real_id
);
1236 hid_warn(hid
, "Unable to create sysfs interface for \"real_id\", errno %d\n", error
);
1237 error
= device_create_file(&hid
->dev
, &dev_attr_alternate_modes
);
1239 hid_warn(hid
, "Unable to create sysfs interface for \"alternate_modes\", errno %d\n", error
);
1241 dbg_hid("sysfs interface created\n");
1243 /* Set the maximum range to start with */
1244 entry
->wdata
.range
= entry
->wdata
.max_range
;
1245 if (entry
->wdata
.set_range
)
1246 entry
->wdata
.set_range(hid
, entry
->wdata
.range
);
1248 #ifdef CONFIG_LEDS_CLASS
1249 /* register led subsystem - G27 only */
1250 entry
->wdata
.led_state
= 0;
1251 for (j
= 0; j
< 5; j
++)
1252 entry
->wdata
.led
[j
] = NULL
;
1254 if (lg4ff_devices
[i
].product_id
== USB_DEVICE_ID_LOGITECH_G27_WHEEL
) {
1255 struct led_classdev
*led
;
1259 lg4ff_set_leds(hid
, 0);
1261 name_sz
= strlen(dev_name(&hid
->dev
)) + 8;
1263 for (j
= 0; j
< 5; j
++) {
1264 led
= kzalloc(sizeof(struct led_classdev
)+name_sz
, GFP_KERNEL
);
1266 hid_err(hid
, "can't allocate memory for LED %d\n", j
);
1270 name
= (void *)(&led
[1]);
1271 snprintf(name
, name_sz
, "%s::RPM%d", dev_name(&hid
->dev
), j
+1);
1273 led
->brightness
= 0;
1274 led
->max_brightness
= 1;
1275 led
->brightness_get
= lg4ff_led_get_brightness
;
1276 led
->brightness_set
= lg4ff_led_set_brightness
;
1278 entry
->wdata
.led
[j
] = led
;
1279 error
= led_classdev_register(&hid
->dev
, led
);
1282 hid_err(hid
, "failed to register LED %d. Aborting.\n", j
);
1284 /* Deregister LEDs (if any) */
1285 for (j
= 0; j
< 5; j
++) {
1286 led
= entry
->wdata
.led
[j
];
1287 entry
->wdata
.led
[j
] = NULL
;
1290 led_classdev_unregister(led
);
1293 goto out
; /* Let the driver continue without LEDs */
1299 hid_info(hid
, "Force feedback support for Logitech Gaming Wheels\n");
1303 drv_data
->device_props
= NULL
;
1308 int lg4ff_deinit(struct hid_device
*hid
)
1310 struct lg4ff_device_entry
*entry
;
1311 struct lg_drv_data
*drv_data
;
1313 drv_data
= hid_get_drvdata(hid
);
1315 hid_err(hid
, "Error while deinitializing device, no private driver data.\n");
1318 entry
= drv_data
->device_props
;
1320 goto out
; /* Nothing more to do */
1322 /* Multimode devices will have at least the "MODE_NATIVE" bit set */
1323 if (entry
->wdata
.alternate_modes
) {
1324 device_remove_file(&hid
->dev
, &dev_attr_real_id
);
1325 device_remove_file(&hid
->dev
, &dev_attr_alternate_modes
);
1328 device_remove_file(&hid
->dev
, &dev_attr_range
);
1329 #ifdef CONFIG_LEDS_CLASS
1332 struct led_classdev
*led
;
1334 /* Deregister LEDs (if any) */
1335 for (j
= 0; j
< 5; j
++) {
1337 led
= entry
->wdata
.led
[j
];
1338 entry
->wdata
.led
[j
] = NULL
;
1341 led_classdev_unregister(led
);
1347 drv_data
->device_props
= NULL
;
1351 dbg_hid("Device successfully unregistered\n");