xref: /openbmc/linux/drivers/hid/hid-lg4ff.c (revision bbec1bd0faa211a0a0abaf947cd4a236d080ad28)
132c88cbcSSimon Wood /*
264013800SSimon Wood  *  Force feedback support for Logitech Gaming Wheels
332c88cbcSSimon Wood  *
464013800SSimon Wood  *  Including G27, G25, DFP, DFGT, FFEX, Momo, Momo2 &
564013800SSimon Wood  *  Speed Force Wireless (WiiWheel)
632c88cbcSSimon Wood  *
732c88cbcSSimon Wood  *  Copyright (c) 2010 Simon Wood <simon@mungewell.org>
832c88cbcSSimon Wood  */
932c88cbcSSimon Wood 
1032c88cbcSSimon Wood /*
1132c88cbcSSimon Wood  * This program is free software; you can redistribute it and/or modify
1232c88cbcSSimon Wood  * it under the terms of the GNU General Public License as published by
1332c88cbcSSimon Wood  * the Free Software Foundation; either version 2 of the License, or
1432c88cbcSSimon Wood  * (at your option) any later version.
1532c88cbcSSimon Wood  *
1632c88cbcSSimon Wood  * This program is distributed in the hope that it will be useful,
1732c88cbcSSimon Wood  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1832c88cbcSSimon Wood  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1932c88cbcSSimon Wood  * GNU General Public License for more details.
2032c88cbcSSimon Wood  *
2132c88cbcSSimon Wood  * You should have received a copy of the GNU General Public License
2232c88cbcSSimon Wood  * along with this program; if not, write to the Free Software
2332c88cbcSSimon Wood  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2432c88cbcSSimon Wood  */
2532c88cbcSSimon Wood 
2632c88cbcSSimon Wood 
2732c88cbcSSimon Wood #include <linux/input.h>
2832c88cbcSSimon Wood #include <linux/usb.h>
2932c88cbcSSimon Wood #include <linux/hid.h>
3032c88cbcSSimon Wood 
3132c88cbcSSimon Wood #include "usbhid/usbhid.h"
3232c88cbcSSimon Wood #include "hid-lg.h"
33a54dc779SMichal Malý #include "hid-lg4ff.h"
347362cd22SMichal Malý #include "hid-ids.h"
3532c88cbcSSimon Wood 
3630bb75d7SMichal Malý #define to_hid_device(pdev) container_of(pdev, struct hid_device, dev)
3730bb75d7SMichal Malý 
38b96d23ecSMichal Malý #define LG4FF_MMODE_IS_MULTIMODE 0
39e7c23449SMichal Malý #define LG4FF_MMODE_SWITCHED 1
40e7c23449SMichal Malý #define LG4FF_MMODE_NOT_MULTIMODE 2
41e7c23449SMichal Malý 
42b96d23ecSMichal Malý #define LG4FF_MODE_NATIVE_IDX 0
43b96d23ecSMichal Malý #define LG4FF_MODE_DFEX_IDX 1
44b96d23ecSMichal Malý #define LG4FF_MODE_DFP_IDX 2
45b96d23ecSMichal Malý #define LG4FF_MODE_G25_IDX 3
46b96d23ecSMichal Malý #define LG4FF_MODE_DFGT_IDX 4
47b96d23ecSMichal Malý #define LG4FF_MODE_G27_IDX 5
48b96d23ecSMichal Malý #define LG4FF_MODE_MAX_IDX 6
49b96d23ecSMichal Malý 
50b96d23ecSMichal Malý #define LG4FF_MODE_NATIVE BIT(LG4FF_MODE_NATIVE_IDX)
51b96d23ecSMichal Malý #define LG4FF_MODE_DFEX BIT(LG4FF_MODE_DFEX_IDX)
52b96d23ecSMichal Malý #define LG4FF_MODE_DFP BIT(LG4FF_MODE_DFP_IDX)
53b96d23ecSMichal Malý #define LG4FF_MODE_G25 BIT(LG4FF_MODE_G25_IDX)
54b96d23ecSMichal Malý #define LG4FF_MODE_DFGT BIT(LG4FF_MODE_DFGT_IDX)
55b96d23ecSMichal Malý #define LG4FF_MODE_G27 BIT(LG4FF_MODE_G27_IDX)
56b96d23ecSMichal Malý 
57b96d23ecSMichal Malý #define LG4FF_DFEX_TAG "DF-EX"
58b96d23ecSMichal Malý #define LG4FF_DFEX_NAME "Driving Force / Formula EX"
59b96d23ecSMichal Malý #define LG4FF_DFP_TAG "DFP"
60b96d23ecSMichal Malý #define LG4FF_DFP_NAME "Driving Force Pro"
61b96d23ecSMichal Malý #define LG4FF_G25_TAG "G25"
62b96d23ecSMichal Malý #define LG4FF_G25_NAME "G25 Racing Wheel"
63b96d23ecSMichal Malý #define LG4FF_G27_TAG "G27"
64b96d23ecSMichal Malý #define LG4FF_G27_NAME "G27 Racing Wheel"
65b96d23ecSMichal Malý #define LG4FF_DFGT_TAG "DFGT"
66b96d23ecSMichal Malý #define LG4FF_DFGT_NAME "Driving Force GT"
67b96d23ecSMichal Malý 
68e7c23449SMichal Malý #define LG4FF_FFEX_REV_MAJ 0x21
69e7c23449SMichal Malý #define LG4FF_FFEX_REV_MIN 0x00
70e7c23449SMichal Malý 
71d0afd848SMichal Malý static void lg4ff_set_range_dfp(struct hid_device *hid, u16 range);
72d0afd848SMichal Malý static void lg4ff_set_range_g25(struct hid_device *hid, u16 range);
7330bb75d7SMichal Malý 
7472529c65SMichal Malý struct lg4ff_wheel_data {
755d9d60adSMichal Malý 	const u32 product_id;
762a552c30SMichal Malý 	u16 range;
775d9d60adSMichal Malý 	const u16 min_range;
785d9d60adSMichal Malý 	const u16 max_range;
7922bcefdcSSimon Wood #ifdef CONFIG_LEDS_CLASS
802a552c30SMichal Malý 	u8  led_state;
8122bcefdcSSimon Wood 	struct led_classdev *led[5];
8222bcefdcSSimon Wood #endif
835d9d60adSMichal Malý 	const u32 alternate_modes;
845d9d60adSMichal Malý 	const char * const real_tag;
855d9d60adSMichal Malý 	const char * const real_name;
865d9d60adSMichal Malý 	const u16 real_product_id;
8772529c65SMichal Malý 
8830bb75d7SMichal Malý 	void (*set_range)(struct hid_device *hid, u16 range);
8930bb75d7SMichal Malý };
9030bb75d7SMichal Malý 
9172529c65SMichal Malý struct lg4ff_device_entry {
92c918fe78SMichal Malý 	spinlock_t report_lock; /* Protect output HID report */
93c28abd8cSMichal Malý 	struct hid_report *report;
9472529c65SMichal Malý 	struct lg4ff_wheel_data wdata;
9572529c65SMichal Malý };
9672529c65SMichal Malý 
977362cd22SMichal Malý static const signed short lg4ff_wheel_effects[] = {
9832c88cbcSSimon Wood 	FF_CONSTANT,
9932c88cbcSSimon Wood 	FF_AUTOCENTER,
10032c88cbcSSimon Wood 	-1
10132c88cbcSSimon Wood };
10232c88cbcSSimon Wood 
1037362cd22SMichal Malý struct lg4ff_wheel {
1042a552c30SMichal Malý 	const u32 product_id;
1057362cd22SMichal Malý 	const signed short *ff_effects;
1062a552c30SMichal Malý 	const u16 min_range;
1072a552c30SMichal Malý 	const u16 max_range;
10830bb75d7SMichal Malý 	void (*set_range)(struct hid_device *hid, u16 range);
1097362cd22SMichal Malý };
1107362cd22SMichal Malý 
111e7c23449SMichal Malý struct lg4ff_compat_mode_switch {
1122a552c30SMichal Malý 	const u8 cmd_count;	/* Number of commands to send */
1132a552c30SMichal Malý 	const u8 cmd[];
114e7c23449SMichal Malý };
115e7c23449SMichal Malý 
116e7c23449SMichal Malý struct lg4ff_wheel_ident_info {
117*bbec1bd0SSimon Wood 	const u32 modes;
118e7c23449SMichal Malý 	const u16 mask;
119e7c23449SMichal Malý 	const u16 result;
120e7c23449SMichal Malý 	const u16 real_product_id;
121e7c23449SMichal Malý };
122e7c23449SMichal Malý 
123b96d23ecSMichal Malý struct lg4ff_multimode_wheel {
124b96d23ecSMichal Malý 	const u16 product_id;
125b96d23ecSMichal Malý 	const u32 alternate_modes;
126b96d23ecSMichal Malý 	const char *real_tag;
127b96d23ecSMichal Malý 	const char *real_name;
128b96d23ecSMichal Malý };
129b96d23ecSMichal Malý 
130b96d23ecSMichal Malý struct lg4ff_alternate_mode {
131b96d23ecSMichal Malý 	const u16 product_id;
132b96d23ecSMichal Malý 	const char *tag;
133b96d23ecSMichal Malý 	const char *name;
134b96d23ecSMichal Malý };
135b96d23ecSMichal Malý 
1367362cd22SMichal Malý static const struct lg4ff_wheel lg4ff_devices[] = {
13730bb75d7SMichal Malý 	{USB_DEVICE_ID_LOGITECH_WHEEL,       lg4ff_wheel_effects, 40, 270, NULL},
13830bb75d7SMichal Malý 	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL,  lg4ff_wheel_effects, 40, 270, NULL},
139d0afd848SMichal Malý 	{USB_DEVICE_ID_LOGITECH_DFP_WHEEL,   lg4ff_wheel_effects, 40, 900, lg4ff_set_range_dfp},
140d0afd848SMichal Malý 	{USB_DEVICE_ID_LOGITECH_G25_WHEEL,   lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
141d0afd848SMichal Malý 	{USB_DEVICE_ID_LOGITECH_DFGT_WHEEL,  lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
142d0afd848SMichal Malý 	{USB_DEVICE_ID_LOGITECH_G27_WHEEL,   lg4ff_wheel_effects, 40, 900, lg4ff_set_range_g25},
14330bb75d7SMichal Malý 	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2, lg4ff_wheel_effects, 40, 270, NULL},
14430bb75d7SMichal Malý 	{USB_DEVICE_ID_LOGITECH_WII_WHEEL,   lg4ff_wheel_effects, 40, 270, NULL}
1457362cd22SMichal Malý };
1467362cd22SMichal Malý 
147b96d23ecSMichal Malý static const struct lg4ff_multimode_wheel lg4ff_multimode_wheels[] = {
148b96d23ecSMichal Malý 	{USB_DEVICE_ID_LOGITECH_DFP_WHEEL,
149b96d23ecSMichal Malý 	 LG4FF_MODE_NATIVE | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
150b96d23ecSMichal Malý 	 LG4FF_DFP_TAG, LG4FF_DFP_NAME},
151b96d23ecSMichal Malý 	{USB_DEVICE_ID_LOGITECH_G25_WHEEL,
152b96d23ecSMichal Malý 	 LG4FF_MODE_NATIVE | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
153b96d23ecSMichal Malý 	 LG4FF_G25_TAG, LG4FF_G25_NAME},
154b96d23ecSMichal Malý 	{USB_DEVICE_ID_LOGITECH_DFGT_WHEEL,
155b96d23ecSMichal Malý 	 LG4FF_MODE_NATIVE | LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
156b96d23ecSMichal Malý 	 LG4FF_DFGT_TAG, LG4FF_DFGT_NAME},
157b96d23ecSMichal Malý 	{USB_DEVICE_ID_LOGITECH_G27_WHEEL,
158b96d23ecSMichal Malý 	 LG4FF_MODE_NATIVE | LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
159b96d23ecSMichal Malý 	 LG4FF_G27_TAG, LG4FF_G27_NAME},
160b96d23ecSMichal Malý };
161b96d23ecSMichal Malý 
162b96d23ecSMichal Malý static const struct lg4ff_alternate_mode lg4ff_alternate_modes[] = {
163b96d23ecSMichal Malý 	[LG4FF_MODE_NATIVE_IDX] = {0, "native", ""},
164b96d23ecSMichal Malý 	[LG4FF_MODE_DFEX_IDX] = {USB_DEVICE_ID_LOGITECH_WHEEL, LG4FF_DFEX_TAG, LG4FF_DFEX_NAME},
165b96d23ecSMichal Malý 	[LG4FF_MODE_DFP_IDX] = {USB_DEVICE_ID_LOGITECH_DFP_WHEEL, LG4FF_DFP_TAG, LG4FF_DFP_NAME},
166b96d23ecSMichal Malý 	[LG4FF_MODE_G25_IDX] = {USB_DEVICE_ID_LOGITECH_G25_WHEEL, LG4FF_G25_TAG, LG4FF_G25_NAME},
167b96d23ecSMichal Malý 	[LG4FF_MODE_DFGT_IDX] = {USB_DEVICE_ID_LOGITECH_DFGT_WHEEL, LG4FF_DFGT_TAG, LG4FF_DFGT_NAME},
168b96d23ecSMichal Malý 	[LG4FF_MODE_G27_IDX] = {USB_DEVICE_ID_LOGITECH_G27_WHEEL, LG4FF_G27_TAG, LG4FF_G27_NAME}
169b96d23ecSMichal Malý };
170b96d23ecSMichal Malý 
171e7c23449SMichal Malý /* Multimode wheel identificators */
172e7c23449SMichal Malý static const struct lg4ff_wheel_ident_info lg4ff_dfp_ident_info = {
173*bbec1bd0SSimon Wood 	LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
174e7c23449SMichal Malý 	0xf000,
175e7c23449SMichal Malý 	0x1000,
176e7c23449SMichal Malý 	USB_DEVICE_ID_LOGITECH_DFP_WHEEL
17796440c8aSMichal Malý };
17896440c8aSMichal Malý 
179e7c23449SMichal Malý static const struct lg4ff_wheel_ident_info lg4ff_g25_ident_info = {
180*bbec1bd0SSimon Wood 	LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
181e7c23449SMichal Malý 	0xff00,
182e7c23449SMichal Malý 	0x1200,
183e7c23449SMichal Malý 	USB_DEVICE_ID_LOGITECH_G25_WHEEL
18496440c8aSMichal Malý };
18596440c8aSMichal Malý 
186e7c23449SMichal Malý static const struct lg4ff_wheel_ident_info lg4ff_g27_ident_info = {
187*bbec1bd0SSimon Wood 	LG4FF_MODE_G27 | LG4FF_MODE_G25 | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
188e7c23449SMichal Malý 	0xfff0,
189e7c23449SMichal Malý 	0x1230,
190e7c23449SMichal Malý 	USB_DEVICE_ID_LOGITECH_G27_WHEEL
191e7c23449SMichal Malý };
192e7c23449SMichal Malý 
193e7c23449SMichal Malý static const struct lg4ff_wheel_ident_info lg4ff_dfgt_ident_info = {
194*bbec1bd0SSimon Wood 	LG4FF_MODE_DFGT | LG4FF_MODE_DFP | LG4FF_MODE_DFEX,
195e7c23449SMichal Malý 	0xff00,
196e7c23449SMichal Malý 	0x1300,
197e7c23449SMichal Malý 	USB_DEVICE_ID_LOGITECH_DFGT_WHEEL
198e7c23449SMichal Malý };
199e7c23449SMichal Malý 
200e7c23449SMichal Malý /* Multimode wheel identification checklists */
201*bbec1bd0SSimon Wood static const struct lg4ff_wheel_ident_info *lg4ff_main_checklist[] = {
202*bbec1bd0SSimon Wood 	&lg4ff_dfgt_ident_info,
203e7c23449SMichal Malý 	&lg4ff_g27_ident_info,
204e7c23449SMichal Malý 	&lg4ff_g25_ident_info,
205*bbec1bd0SSimon Wood 	&lg4ff_dfp_ident_info
206e7c23449SMichal Malý };
207e7c23449SMichal Malý 
208e7c23449SMichal Malý /* Compatibility mode switching commands */
209f31a2de3SMichal Malý /* EXT_CMD9 - Understood by G27 and DFGT */
210f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfex = {
211f31a2de3SMichal Malý 	2,
212f31a2de3SMichal Malý 	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* Revert mode upon USB reset */
213f31a2de3SMichal Malý 	 0xf8, 0x09, 0x00, 0x01, 0x00, 0x00, 0x00}	/* Switch mode to DF-EX with detach */
214f31a2de3SMichal Malý };
215f31a2de3SMichal Malý 
216f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfp = {
217f31a2de3SMichal Malý 	2,
218f31a2de3SMichal Malý 	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* Revert mode upon USB reset */
219f31a2de3SMichal Malý 	 0xf8, 0x09, 0x01, 0x01, 0x00, 0x00, 0x00}	/* Switch mode to DFP with detach */
220f31a2de3SMichal Malý };
221f31a2de3SMichal Malý 
222f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g25 = {
223f31a2de3SMichal Malý 	2,
224f31a2de3SMichal Malý 	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* Revert mode upon USB reset */
225f31a2de3SMichal Malý 	 0xf8, 0x09, 0x02, 0x01, 0x00, 0x00, 0x00}	/* Switch mode to G25 with detach */
226f31a2de3SMichal Malý };
227f31a2de3SMichal Malý 
228f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_dfgt = {
229f31a2de3SMichal Malý 	2,
230f31a2de3SMichal Malý 	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* Revert mode upon USB reset */
231f31a2de3SMichal Malý 	 0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00}	/* Switch mode to DFGT with detach */
232f31a2de3SMichal Malý };
233f31a2de3SMichal Malý 
234f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext09_g27 = {
235f31a2de3SMichal Malý 	2,
236f31a2de3SMichal Malý 	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* Revert mode upon USB reset */
237f31a2de3SMichal Malý 	 0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00}	/* Switch mode to G27 with detach */
238f31a2de3SMichal Malý };
239f31a2de3SMichal Malý 
240f31a2de3SMichal Malý /* EXT_CMD1 - Understood by DFP, G25, G27 and DFGT */
241f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext01_dfp = {
24296440c8aSMichal Malý 	1,
24396440c8aSMichal Malý 	{0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
24496440c8aSMichal Malý };
24596440c8aSMichal Malý 
246f31a2de3SMichal Malý /* EXT_CMD16 - Understood by G25 and G27 */
247f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch lg4ff_mode_switch_ext16_g25 = {
24896440c8aSMichal Malý 	1,
24996440c8aSMichal Malý 	{0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
25096440c8aSMichal Malý };
25196440c8aSMichal Malý 
2522b24a960SMichal Malý /* Recalculates X axis value accordingly to currently selected range */
2532a552c30SMichal Malý static s32 lg4ff_adjust_dfp_x_axis(s32 value, u16 range)
2542b24a960SMichal Malý {
2552a552c30SMichal Malý 	u16 max_range;
2562a552c30SMichal Malý 	s32 new_value;
2572b24a960SMichal Malý 
2582b24a960SMichal Malý 	if (range == 900)
2592b24a960SMichal Malý 		return value;
2602b24a960SMichal Malý 	else if (range == 200)
2612b24a960SMichal Malý 		return value;
2622b24a960SMichal Malý 	else if (range < 200)
2632b24a960SMichal Malý 		max_range = 200;
2642b24a960SMichal Malý 	else
2652b24a960SMichal Malý 		max_range = 900;
2662b24a960SMichal Malý 
2672b24a960SMichal Malý 	new_value = 8192 + mult_frac(value - 8192, max_range, range);
2682b24a960SMichal Malý 	if (new_value < 0)
2692b24a960SMichal Malý 		return 0;
2702b24a960SMichal Malý 	else if (new_value > 16383)
2712b24a960SMichal Malý 		return 16383;
2722b24a960SMichal Malý 	else
2732b24a960SMichal Malý 		return new_value;
2742b24a960SMichal Malý }
2752b24a960SMichal Malý 
2762b24a960SMichal Malý int lg4ff_adjust_input_event(struct hid_device *hid, struct hid_field *field,
2772a552c30SMichal Malý 			     struct hid_usage *usage, s32 value, struct lg_drv_data *drv_data)
2782b24a960SMichal Malý {
2792b24a960SMichal Malý 	struct lg4ff_device_entry *entry = drv_data->device_props;
2802a552c30SMichal Malý 	s32 new_value = 0;
2812b24a960SMichal Malý 
2822b24a960SMichal Malý 	if (!entry) {
2832b24a960SMichal Malý 		hid_err(hid, "Device properties not found");
2842b24a960SMichal Malý 		return 0;
2852b24a960SMichal Malý 	}
2862b24a960SMichal Malý 
28772529c65SMichal Malý 	switch (entry->wdata.product_id) {
2882b24a960SMichal Malý 	case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
2892b24a960SMichal Malý 		switch (usage->code) {
2902b24a960SMichal Malý 		case ABS_X:
29172529c65SMichal Malý 			new_value = lg4ff_adjust_dfp_x_axis(value, entry->wdata.range);
2922b24a960SMichal Malý 			input_event(field->hidinput->input, usage->type, usage->code, new_value);
2932b24a960SMichal Malý 			return 1;
2942b24a960SMichal Malý 		default:
2952b24a960SMichal Malý 			return 0;
2962b24a960SMichal Malý 		}
2972b24a960SMichal Malý 	default:
2982b24a960SMichal Malý 		return 0;
2992b24a960SMichal Malý 	}
3002b24a960SMichal Malý }
3012b24a960SMichal Malý 
3025d9d60adSMichal Malý static void lg4ff_init_wheel_data(struct lg4ff_wheel_data * const wdata, const struct lg4ff_wheel *wheel,
3035d9d60adSMichal Malý 				  const struct lg4ff_multimode_wheel *mmode_wheel,
3045d9d60adSMichal Malý 				  const u16 real_product_id)
3055d9d60adSMichal Malý {
3065d9d60adSMichal Malý 	u32 alternate_modes = 0;
3075d9d60adSMichal Malý 	const char *real_tag = NULL;
3085d9d60adSMichal Malý 	const char *real_name = NULL;
3095d9d60adSMichal Malý 
3105d9d60adSMichal Malý 	if (mmode_wheel) {
3115d9d60adSMichal Malý 		alternate_modes = mmode_wheel->alternate_modes;
3125d9d60adSMichal Malý 		real_tag = mmode_wheel->real_tag;
3135d9d60adSMichal Malý 		real_name = mmode_wheel->real_name;
3145d9d60adSMichal Malý 	}
3155d9d60adSMichal Malý 
3165d9d60adSMichal Malý 	{
3175d9d60adSMichal Malý 		struct lg4ff_wheel_data t_wdata =  { .product_id = wheel->product_id,
3185d9d60adSMichal Malý 						     .real_product_id = real_product_id,
3195d9d60adSMichal Malý 						     .min_range = wheel->min_range,
3205d9d60adSMichal Malý 						     .max_range = wheel->max_range,
3215d9d60adSMichal Malý 						     .set_range = wheel->set_range,
3225d9d60adSMichal Malý 						     .alternate_modes = alternate_modes,
3235d9d60adSMichal Malý 						     .real_tag = real_tag,
3245d9d60adSMichal Malý 						     .real_name = real_name };
3255d9d60adSMichal Malý 
3265d9d60adSMichal Malý 		memcpy(wdata, &t_wdata, sizeof(t_wdata));
3275d9d60adSMichal Malý 	}
3285d9d60adSMichal Malý }
3295d9d60adSMichal Malý 
330d0afd848SMichal Malý static int lg4ff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
33132c88cbcSSimon Wood {
33232c88cbcSSimon Wood 	struct hid_device *hid = input_get_drvdata(dev);
333c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
334c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
335c918fe78SMichal Malý 	unsigned long flags;
336c28abd8cSMichal Malý 	s32 *value;
33732c88cbcSSimon Wood 	int x;
33832c88cbcSSimon Wood 
339c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
340c918fe78SMichal Malý 	if (!drv_data) {
341c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
342c918fe78SMichal Malý 		return -EINVAL;
343c918fe78SMichal Malý 	}
344c918fe78SMichal Malý 
345c918fe78SMichal Malý 	entry = drv_data->device_props;
346c918fe78SMichal Malý 	if (!entry) {
347c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
348c918fe78SMichal Malý 		return -EINVAL;
349c918fe78SMichal Malý 	}
350c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
351c918fe78SMichal Malý 
352a80fe5d6SMichal Malý #define CLAMP(x) do { if (x < 0) x = 0; else if (x > 0xff) x = 0xff; } while (0)
35332c88cbcSSimon Wood 
35432c88cbcSSimon Wood 	switch (effect->type) {
35532c88cbcSSimon Wood 	case FF_CONSTANT:
35632c88cbcSSimon Wood 		x = effect->u.ramp.start_level + 0x80;	/* 0x80 is no force */
35732c88cbcSSimon Wood 		CLAMP(x);
35856930e7aSSimon Wood 
359c918fe78SMichal Malý 		spin_lock_irqsave(&entry->report_lock, flags);
36056930e7aSSimon Wood 		if (x == 0x80) {
36156930e7aSSimon Wood 			/* De-activate force in slot-1*/
36256930e7aSSimon Wood 			value[0] = 0x13;
36356930e7aSSimon Wood 			value[1] = 0x00;
36456930e7aSSimon Wood 			value[2] = 0x00;
36556930e7aSSimon Wood 			value[3] = 0x00;
36656930e7aSSimon Wood 			value[4] = 0x00;
36756930e7aSSimon Wood 			value[5] = 0x00;
36856930e7aSSimon Wood 			value[6] = 0x00;
36956930e7aSSimon Wood 
370c28abd8cSMichal Malý 			hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
371c918fe78SMichal Malý 			spin_unlock_irqrestore(&entry->report_lock, flags);
37256930e7aSSimon Wood 			return 0;
37356930e7aSSimon Wood 		}
37456930e7aSSimon Wood 
37574479ba8SMichal Malý 		value[0] = 0x11;	/* Slot 1 */
37674479ba8SMichal Malý 		value[1] = 0x08;
37774479ba8SMichal Malý 		value[2] = x;
37874479ba8SMichal Malý 		value[3] = 0x80;
37974479ba8SMichal Malý 		value[4] = 0x00;
38074479ba8SMichal Malý 		value[5] = 0x00;
38174479ba8SMichal Malý 		value[6] = 0x00;
38232c88cbcSSimon Wood 
383c28abd8cSMichal Malý 		hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
384c918fe78SMichal Malý 		spin_unlock_irqrestore(&entry->report_lock, flags);
38532c88cbcSSimon Wood 		break;
38632c88cbcSSimon Wood 	}
38732c88cbcSSimon Wood 	return 0;
38832c88cbcSSimon Wood }
38932c88cbcSSimon Wood 
3906e2de8e0SMichal Malý /* Sends default autocentering command compatible with
3916e2de8e0SMichal Malý  * all wheels except Formula Force EX */
392d0afd848SMichal Malý static void lg4ff_set_autocenter_default(struct input_dev *dev, u16 magnitude)
39332c88cbcSSimon Wood {
39432c88cbcSSimon Wood 	struct hid_device *hid = input_get_drvdata(dev);
39532c88cbcSSimon Wood 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
39632c88cbcSSimon Wood 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
3972a552c30SMichal Malý 	s32 *value = report->field[0]->value;
3982a552c30SMichal Malý 	u32 expand_a, expand_b;
3991859762eSSimon Wood 	struct lg4ff_device_entry *entry;
4001859762eSSimon Wood 	struct lg_drv_data *drv_data;
401c918fe78SMichal Malý 	unsigned long flags;
4021859762eSSimon Wood 
4031859762eSSimon Wood 	drv_data = hid_get_drvdata(hid);
4041859762eSSimon Wood 	if (!drv_data) {
4051859762eSSimon Wood 		hid_err(hid, "Private driver data not found!\n");
4061859762eSSimon Wood 		return;
4071859762eSSimon Wood 	}
4081859762eSSimon Wood 
4091859762eSSimon Wood 	entry = drv_data->device_props;
4101859762eSSimon Wood 	if (!entry) {
4111859762eSSimon Wood 		hid_err(hid, "Device properties not found!\n");
4121859762eSSimon Wood 		return;
4131859762eSSimon Wood 	}
414c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
415f8c23156SSimon Wood 
416d2c02da5SSimon Wood 	/* De-activate Auto-Center */
417c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
418d2c02da5SSimon Wood 	if (magnitude == 0) {
419d2c02da5SSimon Wood 		value[0] = 0xf5;
420d2c02da5SSimon Wood 		value[1] = 0x00;
421d2c02da5SSimon Wood 		value[2] = 0x00;
422d2c02da5SSimon Wood 		value[3] = 0x00;
423d2c02da5SSimon Wood 		value[4] = 0x00;
424d2c02da5SSimon Wood 		value[5] = 0x00;
425d2c02da5SSimon Wood 		value[6] = 0x00;
426d2c02da5SSimon Wood 
427c28abd8cSMichal Malý 		hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
428c918fe78SMichal Malý 		spin_unlock_irqrestore(&entry->report_lock, flags);
429d2c02da5SSimon Wood 		return;
430d2c02da5SSimon Wood 	}
431d2c02da5SSimon Wood 
432f8c23156SSimon Wood 	if (magnitude <= 0xaaaa) {
433f8c23156SSimon Wood 		expand_a = 0x0c * magnitude;
434f8c23156SSimon Wood 		expand_b = 0x80 * magnitude;
435f8c23156SSimon Wood 	} else {
436f8c23156SSimon Wood 		expand_a = (0x0c * 0xaaaa) + 0x06 * (magnitude - 0xaaaa);
437f8c23156SSimon Wood 		expand_b = (0x80 * 0xaaaa) + 0xff * (magnitude - 0xaaaa);
438f8c23156SSimon Wood 	}
43932c88cbcSSimon Wood 
4401859762eSSimon Wood 	/* Adjust for non-MOMO wheels */
44172529c65SMichal Malý 	switch (entry->wdata.product_id) {
4421859762eSSimon Wood 	case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL:
4431859762eSSimon Wood 	case USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2:
4441859762eSSimon Wood 		break;
4451859762eSSimon Wood 	default:
4461859762eSSimon Wood 		expand_a = expand_a >> 1;
4471859762eSSimon Wood 		break;
4481859762eSSimon Wood 	}
4491859762eSSimon Wood 
45074479ba8SMichal Malý 	value[0] = 0xfe;
45174479ba8SMichal Malý 	value[1] = 0x0d;
452f8c23156SSimon Wood 	value[2] = expand_a / 0xaaaa;
453f8c23156SSimon Wood 	value[3] = expand_a / 0xaaaa;
454f8c23156SSimon Wood 	value[4] = expand_b / 0xaaaa;
45574479ba8SMichal Malý 	value[5] = 0x00;
45674479ba8SMichal Malý 	value[6] = 0x00;
45732c88cbcSSimon Wood 
458c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
459d2c02da5SSimon Wood 
460d2c02da5SSimon Wood 	/* Activate Auto-Center */
461d2c02da5SSimon Wood 	value[0] = 0x14;
462d2c02da5SSimon Wood 	value[1] = 0x00;
463d2c02da5SSimon Wood 	value[2] = 0x00;
464d2c02da5SSimon Wood 	value[3] = 0x00;
465d2c02da5SSimon Wood 	value[4] = 0x00;
466d2c02da5SSimon Wood 	value[5] = 0x00;
467d2c02da5SSimon Wood 	value[6] = 0x00;
468d2c02da5SSimon Wood 
469c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
470c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
47132c88cbcSSimon Wood }
47232c88cbcSSimon Wood 
4736e2de8e0SMichal Malý /* Sends autocentering command compatible with Formula Force EX */
474d0afd848SMichal Malý static void lg4ff_set_autocenter_ffex(struct input_dev *dev, u16 magnitude)
4756e2de8e0SMichal Malý {
4766e2de8e0SMichal Malý 	struct hid_device *hid = input_get_drvdata(dev);
477c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
478c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
479c918fe78SMichal Malý 	unsigned long flags;
480c28abd8cSMichal Malý 	s32 *value;
4816e2de8e0SMichal Malý 	magnitude = magnitude * 90 / 65535;
4826e2de8e0SMichal Malý 
483c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
484c918fe78SMichal Malý 	if (!drv_data) {
485c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
486c918fe78SMichal Malý 		return;
487c918fe78SMichal Malý 	}
488c918fe78SMichal Malý 
489c918fe78SMichal Malý 	entry = drv_data->device_props;
490c918fe78SMichal Malý 	if (!entry) {
491c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
492c918fe78SMichal Malý 		return;
493c918fe78SMichal Malý 	}
494c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
495c918fe78SMichal Malý 
496c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
49774479ba8SMichal Malý 	value[0] = 0xfe;
49874479ba8SMichal Malý 	value[1] = 0x03;
49974479ba8SMichal Malý 	value[2] = magnitude >> 14;
50074479ba8SMichal Malý 	value[3] = magnitude >> 14;
50174479ba8SMichal Malý 	value[4] = magnitude;
50274479ba8SMichal Malý 	value[5] = 0x00;
50374479ba8SMichal Malý 	value[6] = 0x00;
5046e2de8e0SMichal Malý 
505c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
506c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
5076e2de8e0SMichal Malý }
5086e2de8e0SMichal Malý 
50930bb75d7SMichal Malý /* Sends command to set range compatible with G25/G27/Driving Force GT */
510d0afd848SMichal Malý static void lg4ff_set_range_g25(struct hid_device *hid, u16 range)
51130bb75d7SMichal Malý {
512c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
513c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
514c918fe78SMichal Malý 	unsigned long flags;
515c28abd8cSMichal Malý 	s32 *value;
51674479ba8SMichal Malý 
517c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
518c918fe78SMichal Malý 	if (!drv_data) {
519c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
520c918fe78SMichal Malý 		return;
521c918fe78SMichal Malý 	}
522c918fe78SMichal Malý 
523c918fe78SMichal Malý 	entry = drv_data->device_props;
524c918fe78SMichal Malý 	if (!entry) {
525c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
526c918fe78SMichal Malý 		return;
527c918fe78SMichal Malý 	}
528c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
52930bb75d7SMichal Malý 	dbg_hid("G25/G27/DFGT: setting range to %u\n", range);
53030bb75d7SMichal Malý 
531c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
53274479ba8SMichal Malý 	value[0] = 0xf8;
53374479ba8SMichal Malý 	value[1] = 0x81;
53474479ba8SMichal Malý 	value[2] = range & 0x00ff;
53574479ba8SMichal Malý 	value[3] = (range & 0xff00) >> 8;
53674479ba8SMichal Malý 	value[4] = 0x00;
53774479ba8SMichal Malý 	value[5] = 0x00;
53874479ba8SMichal Malý 	value[6] = 0x00;
53930bb75d7SMichal Malý 
540c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
541c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
54230bb75d7SMichal Malý }
54330bb75d7SMichal Malý 
54430bb75d7SMichal Malý /* Sends commands to set range compatible with Driving Force Pro wheel */
545d0afd848SMichal Malý static void lg4ff_set_range_dfp(struct hid_device *hid, u16 range)
54630bb75d7SMichal Malý {
547c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
548c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
549c918fe78SMichal Malý 	unsigned long flags;
550c28abd8cSMichal Malý 	int start_left, start_right, full_range;
551c28abd8cSMichal Malý 	s32 *value;
55274479ba8SMichal Malý 
553c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
554c918fe78SMichal Malý 	if (!drv_data) {
555c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
556c918fe78SMichal Malý 		return;
557c918fe78SMichal Malý 	}
558c918fe78SMichal Malý 
559c918fe78SMichal Malý 	entry = drv_data->device_props;
560c918fe78SMichal Malý 	if (!entry) {
561c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
562c918fe78SMichal Malý 		return;
563c918fe78SMichal Malý 	}
564c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
56530bb75d7SMichal Malý 	dbg_hid("Driving Force Pro: setting range to %u\n", range);
56630bb75d7SMichal Malý 
56730bb75d7SMichal Malý 	/* Prepare "coarse" limit command */
568c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
56974479ba8SMichal Malý 	value[0] = 0xf8;
57074479ba8SMichal Malý 	value[1] = 0x00;	/* Set later */
57174479ba8SMichal Malý 	value[2] = 0x00;
57274479ba8SMichal Malý 	value[3] = 0x00;
57374479ba8SMichal Malý 	value[4] = 0x00;
57474479ba8SMichal Malý 	value[5] = 0x00;
57574479ba8SMichal Malý 	value[6] = 0x00;
57630bb75d7SMichal Malý 
57730bb75d7SMichal Malý 	if (range > 200) {
578c28abd8cSMichal Malý 		value[1] = 0x03;
57930bb75d7SMichal Malý 		full_range = 900;
58030bb75d7SMichal Malý 	} else {
581c28abd8cSMichal Malý 		value[1] = 0x02;
58230bb75d7SMichal Malý 		full_range = 200;
58330bb75d7SMichal Malý 	}
584c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
58530bb75d7SMichal Malý 
58630bb75d7SMichal Malý 	/* Prepare "fine" limit command */
58774479ba8SMichal Malý 	value[0] = 0x81;
58874479ba8SMichal Malý 	value[1] = 0x0b;
58974479ba8SMichal Malý 	value[2] = 0x00;
59074479ba8SMichal Malý 	value[3] = 0x00;
59174479ba8SMichal Malý 	value[4] = 0x00;
59274479ba8SMichal Malý 	value[5] = 0x00;
59374479ba8SMichal Malý 	value[6] = 0x00;
59430bb75d7SMichal Malý 
59530bb75d7SMichal Malý 	if (range == 200 || range == 900) {	/* Do not apply any fine limit */
596c28abd8cSMichal Malý 		hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
597c918fe78SMichal Malý 		spin_unlock_irqrestore(&entry->report_lock, flags);
59830bb75d7SMichal Malý 		return;
59930bb75d7SMichal Malý 	}
60030bb75d7SMichal Malý 
60130bb75d7SMichal Malý 	/* Construct fine limit command */
60230bb75d7SMichal Malý 	start_left = (((full_range - range + 1) * 2047) / full_range);
60330bb75d7SMichal Malý 	start_right = 0xfff - start_left;
60430bb75d7SMichal Malý 
60574479ba8SMichal Malý 	value[2] = start_left >> 4;
60674479ba8SMichal Malý 	value[3] = start_right >> 4;
60774479ba8SMichal Malý 	value[4] = 0xff;
60874479ba8SMichal Malý 	value[5] = (start_right & 0xe) << 4 | (start_left & 0xe);
60974479ba8SMichal Malý 	value[6] = 0xff;
61030bb75d7SMichal Malý 
611c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
612c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
61330bb75d7SMichal Malý }
61430bb75d7SMichal Malý 
615f31a2de3SMichal Malý static const struct lg4ff_compat_mode_switch *lg4ff_get_mode_switch_command(const u16 real_product_id, const u16 target_product_id)
616f31a2de3SMichal Malý {
617f31a2de3SMichal Malý 	switch (real_product_id) {
618f31a2de3SMichal Malý 	case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
619f31a2de3SMichal Malý 		switch (target_product_id) {
620f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
621f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext01_dfp;
622f31a2de3SMichal Malý 		/* DFP can only be switched to its native mode */
623f31a2de3SMichal Malý 		default:
624f31a2de3SMichal Malý 			return NULL;
625f31a2de3SMichal Malý 		}
626f31a2de3SMichal Malý 		break;
627f31a2de3SMichal Malý 	case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
628f31a2de3SMichal Malý 		switch (target_product_id) {
629f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
630f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext01_dfp;
631f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
632f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext16_g25;
633f31a2de3SMichal Malý 		/* G25 can only be switched to DFP mode or its native mode */
634f31a2de3SMichal Malý 		default:
635f31a2de3SMichal Malý 			return NULL;
636f31a2de3SMichal Malý 		}
637f31a2de3SMichal Malý 		break;
638f31a2de3SMichal Malý 	case USB_DEVICE_ID_LOGITECH_G27_WHEEL:
639f31a2de3SMichal Malý 		switch (target_product_id) {
640f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_WHEEL:
641f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_dfex;
642f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
643f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_dfp;
644f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_G25_WHEEL:
645f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_g25;
646f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_G27_WHEEL:
647f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_g27;
648f31a2de3SMichal Malý 		/* G27 can only be switched to DF-EX, DFP, G25 or its native mode */
649f31a2de3SMichal Malý 		default:
650f31a2de3SMichal Malý 			return NULL;
651f31a2de3SMichal Malý 		}
652f31a2de3SMichal Malý 		break;
653f31a2de3SMichal Malý 	case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL:
654f31a2de3SMichal Malý 		switch (target_product_id) {
655f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_WHEEL:
656f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_dfex;
657f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_DFP_WHEEL:
658f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_dfp;
659f31a2de3SMichal Malý 		case USB_DEVICE_ID_LOGITECH_DFGT_WHEEL:
660f31a2de3SMichal Malý 			return &lg4ff_mode_switch_ext09_dfgt;
661f31a2de3SMichal Malý 		/* DFGT can only be switched to DF-EX, DFP or its native mode */
662f31a2de3SMichal Malý 		default:
663f31a2de3SMichal Malý 			return NULL;
664f31a2de3SMichal Malý 		}
665f31a2de3SMichal Malý 		break;
666f31a2de3SMichal Malý 	/* No other wheels have multiple modes */
667f31a2de3SMichal Malý 	default:
668f31a2de3SMichal Malý 		return NULL;
669f31a2de3SMichal Malý 	}
670f31a2de3SMichal Malý }
671f31a2de3SMichal Malý 
672e7c23449SMichal Malý static int lg4ff_switch_compatibility_mode(struct hid_device *hid, const struct lg4ff_compat_mode_switch *s)
67396440c8aSMichal Malý {
674c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
675c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
676c918fe78SMichal Malý 	unsigned long flags;
677c28abd8cSMichal Malý 	s32 *value;
678e7c23449SMichal Malý 	u8 i;
67996440c8aSMichal Malý 
680c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
681c918fe78SMichal Malý 	if (!drv_data) {
682c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
683c918fe78SMichal Malý 		return -EINVAL;
684c918fe78SMichal Malý 	}
685c918fe78SMichal Malý 
686c918fe78SMichal Malý 	entry = drv_data->device_props;
687c918fe78SMichal Malý 	if (!entry) {
688c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
689c918fe78SMichal Malý 		return -EINVAL;
690c918fe78SMichal Malý 	}
691c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
692c918fe78SMichal Malý 
693c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
694e7c23449SMichal Malý 	for (i = 0; i < s->cmd_count; i++) {
695c1740d13SMichal Malý 		u8 j;
69696440c8aSMichal Malý 
697c1740d13SMichal Malý 		for (j = 0; j < 7; j++)
698c1740d13SMichal Malý 			value[j] = s->cmd[j + (7*i)];
699c1740d13SMichal Malý 
700c28abd8cSMichal Malý 		hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
70196440c8aSMichal Malý 	}
702c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
703c1740d13SMichal Malý 	hid_hw_wait(hid);
704e7c23449SMichal Malý 	return 0;
70596440c8aSMichal Malý }
70632c88cbcSSimon Wood 
707b96d23ecSMichal Malý static ssize_t lg4ff_alternate_modes_show(struct device *dev, struct device_attribute *attr, char *buf)
708b96d23ecSMichal Malý {
709b96d23ecSMichal Malý 	struct hid_device *hid = to_hid_device(dev);
710b96d23ecSMichal Malý 	struct lg4ff_device_entry *entry;
711b96d23ecSMichal Malý 	struct lg_drv_data *drv_data;
712b96d23ecSMichal Malý 	ssize_t count = 0;
713b96d23ecSMichal Malý 	int i;
714b96d23ecSMichal Malý 
715b96d23ecSMichal Malý 	drv_data = hid_get_drvdata(hid);
716b96d23ecSMichal Malý 	if (!drv_data) {
717b96d23ecSMichal Malý 		hid_err(hid, "Private driver data not found!\n");
718b96d23ecSMichal Malý 		return 0;
719b96d23ecSMichal Malý 	}
720b96d23ecSMichal Malý 
721b96d23ecSMichal Malý 	entry = drv_data->device_props;
722b96d23ecSMichal Malý 	if (!entry) {
723b96d23ecSMichal Malý 		hid_err(hid, "Device properties not found!\n");
724b96d23ecSMichal Malý 		return 0;
725b96d23ecSMichal Malý 	}
726b96d23ecSMichal Malý 
72772529c65SMichal Malý 	if (!entry->wdata.real_name) {
728b96d23ecSMichal Malý 		hid_err(hid, "NULL pointer to string\n");
729b96d23ecSMichal Malý 		return 0;
730b96d23ecSMichal Malý 	}
731b96d23ecSMichal Malý 
732b96d23ecSMichal Malý 	for (i = 0; i < LG4FF_MODE_MAX_IDX; i++) {
73372529c65SMichal Malý 		if (entry->wdata.alternate_modes & BIT(i)) {
734b96d23ecSMichal Malý 			/* Print tag and full name */
735b96d23ecSMichal Malý 			count += scnprintf(buf + count, PAGE_SIZE - count, "%s: %s",
736b96d23ecSMichal Malý 					   lg4ff_alternate_modes[i].tag,
73772529c65SMichal Malý 					   !lg4ff_alternate_modes[i].product_id ? entry->wdata.real_name : lg4ff_alternate_modes[i].name);
738b96d23ecSMichal Malý 			if (count >= PAGE_SIZE - 1)
739b96d23ecSMichal Malý 				return count;
740b96d23ecSMichal Malý 
741b96d23ecSMichal Malý 			/* Mark the currently active mode with an asterisk */
74272529c65SMichal Malý 			if (lg4ff_alternate_modes[i].product_id == entry->wdata.product_id ||
74372529c65SMichal Malý 			    (lg4ff_alternate_modes[i].product_id == 0 && entry->wdata.product_id == entry->wdata.real_product_id))
744b96d23ecSMichal Malý 				count += scnprintf(buf + count, PAGE_SIZE - count, " *\n");
745b96d23ecSMichal Malý 			else
746b96d23ecSMichal Malý 				count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
747b96d23ecSMichal Malý 
748b96d23ecSMichal Malý 			if (count >= PAGE_SIZE - 1)
749b96d23ecSMichal Malý 				return count;
750b96d23ecSMichal Malý 		}
751b96d23ecSMichal Malý 	}
752b96d23ecSMichal Malý 
753b96d23ecSMichal Malý 	return count;
754b96d23ecSMichal Malý }
755b96d23ecSMichal Malý 
756b96d23ecSMichal Malý static ssize_t lg4ff_alternate_modes_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
757b96d23ecSMichal Malý {
758f31a2de3SMichal Malý 	struct hid_device *hid = to_hid_device(dev);
759f31a2de3SMichal Malý 	struct lg4ff_device_entry *entry;
760f31a2de3SMichal Malý 	struct lg_drv_data *drv_data;
761f31a2de3SMichal Malý 	const struct lg4ff_compat_mode_switch *s;
762f31a2de3SMichal Malý 	u16 target_product_id = 0;
763f31a2de3SMichal Malý 	int i, ret;
764f31a2de3SMichal Malý 	char *lbuf;
765f31a2de3SMichal Malý 
766f31a2de3SMichal Malý 	drv_data = hid_get_drvdata(hid);
767f31a2de3SMichal Malý 	if (!drv_data) {
768f31a2de3SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
769f31a2de3SMichal Malý 		return -EINVAL;
770f31a2de3SMichal Malý 	}
771f31a2de3SMichal Malý 
772f31a2de3SMichal Malý 	entry = drv_data->device_props;
773f31a2de3SMichal Malý 	if (!entry) {
774f31a2de3SMichal Malý 		hid_err(hid, "Device properties not found!\n");
775f31a2de3SMichal Malý 		return -EINVAL;
776f31a2de3SMichal Malý 	}
777f31a2de3SMichal Malý 
778f31a2de3SMichal Malý 	/* Allow \n at the end of the input parameter */
779f31a2de3SMichal Malý 	lbuf = kasprintf(GFP_KERNEL, "%s", buf);
780f31a2de3SMichal Malý 	if (!lbuf)
781f31a2de3SMichal Malý 		return -ENOMEM;
782f31a2de3SMichal Malý 
783f31a2de3SMichal Malý 	i = strlen(lbuf);
784f31a2de3SMichal Malý 	if (lbuf[i-1] == '\n') {
785f31a2de3SMichal Malý 		if (i == 1) {
786f31a2de3SMichal Malý 			kfree(lbuf);
787f31a2de3SMichal Malý 			return -EINVAL;
788f31a2de3SMichal Malý 		}
789f31a2de3SMichal Malý 		lbuf[i-1] = '\0';
790f31a2de3SMichal Malý 	}
791f31a2de3SMichal Malý 
792f31a2de3SMichal Malý 	for (i = 0; i < LG4FF_MODE_MAX_IDX; i++) {
793f31a2de3SMichal Malý 		const u16 mode_product_id = lg4ff_alternate_modes[i].product_id;
794f31a2de3SMichal Malý 		const char *tag = lg4ff_alternate_modes[i].tag;
795f31a2de3SMichal Malý 
79672529c65SMichal Malý 		if (entry->wdata.alternate_modes & BIT(i)) {
797f31a2de3SMichal Malý 			if (!strcmp(tag, lbuf)) {
798f31a2de3SMichal Malý 				if (!mode_product_id)
79972529c65SMichal Malý 					target_product_id = entry->wdata.real_product_id;
800f31a2de3SMichal Malý 				else
801f31a2de3SMichal Malý 					target_product_id = mode_product_id;
802f31a2de3SMichal Malý 				break;
803f31a2de3SMichal Malý 			}
804f31a2de3SMichal Malý 		}
805f31a2de3SMichal Malý 	}
806f31a2de3SMichal Malý 
807f31a2de3SMichal Malý 	if (i == LG4FF_MODE_MAX_IDX) {
808f31a2de3SMichal Malý 		hid_info(hid, "Requested mode \"%s\" is not supported by the device\n", lbuf);
809f31a2de3SMichal Malý 		kfree(lbuf);
810f31a2de3SMichal Malý 		return -EINVAL;
811f31a2de3SMichal Malý 	}
812f31a2de3SMichal Malý 	kfree(lbuf); /* Not needed anymore */
813f31a2de3SMichal Malý 
81472529c65SMichal Malý 	if (target_product_id == entry->wdata.product_id) /* Nothing to do */
815f31a2de3SMichal Malý 		return count;
816f31a2de3SMichal Malý 
817f31a2de3SMichal Malý 	/* Automatic switching has to be disabled for the switch to DF-EX mode to work correctly */
818f31a2de3SMichal Malý 	if (target_product_id == USB_DEVICE_ID_LOGITECH_WHEEL && !lg4ff_no_autoswitch) {
819f31a2de3SMichal Malý 		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",
82072529c65SMichal Malý 			 entry->wdata.real_name);
821f31a2de3SMichal Malý 		return -EINVAL;
822f31a2de3SMichal Malý 	}
823f31a2de3SMichal Malý 
824f31a2de3SMichal Malý 	/* Take care of hardware limitations */
82572529c65SMichal Malý 	if ((entry->wdata.real_product_id == USB_DEVICE_ID_LOGITECH_DFP_WHEEL || entry->wdata.real_product_id == USB_DEVICE_ID_LOGITECH_G25_WHEEL) &&
82672529c65SMichal Malý 	    entry->wdata.product_id > target_product_id) {
82772529c65SMichal Malý 		hid_info(hid, "\"%s\" cannot be switched back into \"%s\" mode\n", entry->wdata.real_name, lg4ff_alternate_modes[i].name);
828f31a2de3SMichal Malý 		return -EINVAL;
829f31a2de3SMichal Malý 	}
830f31a2de3SMichal Malý 
83172529c65SMichal Malý 	s = lg4ff_get_mode_switch_command(entry->wdata.real_product_id, target_product_id);
832f31a2de3SMichal Malý 	if (!s) {
833f31a2de3SMichal Malý 		hid_err(hid, "Invalid target product ID %X\n", target_product_id);
834f31a2de3SMichal Malý 		return -EINVAL;
835f31a2de3SMichal Malý 	}
836f31a2de3SMichal Malý 
837f31a2de3SMichal Malý 	ret = lg4ff_switch_compatibility_mode(hid, s);
838f31a2de3SMichal Malý 	return (ret == 0 ? count : ret);
839b96d23ecSMichal Malý }
840b96d23ecSMichal Malý static DEVICE_ATTR(alternate_modes, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, lg4ff_alternate_modes_show, lg4ff_alternate_modes_store);
841b96d23ecSMichal Malý 
842fbf85e2aSMichal Malý /* Export the currently set range of the wheel */
843fbf85e2aSMichal Malý static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr,
8442f1cec32SVivien Didelot 				char *buf)
84530bb75d7SMichal Malý {
84630bb75d7SMichal Malý 	struct hid_device *hid = to_hid_device(dev);
8473b6b17b7SMichal Malý 	struct lg4ff_device_entry *entry;
8483b6b17b7SMichal Malý 	struct lg_drv_data *drv_data;
84930bb75d7SMichal Malý 	size_t count;
85030bb75d7SMichal Malý 
8513b6b17b7SMichal Malý 	drv_data = hid_get_drvdata(hid);
8523b6b17b7SMichal Malý 	if (!drv_data) {
8533b6b17b7SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
8543b6b17b7SMichal Malý 		return 0;
85530bb75d7SMichal Malý 	}
8563b6b17b7SMichal Malý 
8573b6b17b7SMichal Malý 	entry = drv_data->device_props;
8583b6b17b7SMichal Malý 	if (!entry) {
8593b6b17b7SMichal Malý 		hid_err(hid, "Device properties not found!\n");
86030bb75d7SMichal Malý 		return 0;
86130bb75d7SMichal Malý 	}
86230bb75d7SMichal Malý 
86372529c65SMichal Malý 	count = scnprintf(buf, PAGE_SIZE, "%u\n", entry->wdata.range);
86430bb75d7SMichal Malý 	return count;
86530bb75d7SMichal Malý }
86630bb75d7SMichal Malý 
86730bb75d7SMichal Malý /* Set range to user specified value, call appropriate function
86830bb75d7SMichal Malý  * according to the type of the wheel */
869fbf85e2aSMichal Malý static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr,
8702f1cec32SVivien Didelot 				 const char *buf, size_t count)
87130bb75d7SMichal Malý {
87230bb75d7SMichal Malý 	struct hid_device *hid = to_hid_device(dev);
8733b6b17b7SMichal Malý 	struct lg4ff_device_entry *entry;
8743b6b17b7SMichal Malý 	struct lg_drv_data *drv_data;
8752a552c30SMichal Malý 	u16 range = simple_strtoul(buf, NULL, 10);
87630bb75d7SMichal Malý 
8773b6b17b7SMichal Malý 	drv_data = hid_get_drvdata(hid);
8783b6b17b7SMichal Malý 	if (!drv_data) {
8793b6b17b7SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
88029ff6657SSimon Wood 		return -EINVAL;
88130bb75d7SMichal Malý 	}
8823b6b17b7SMichal Malý 
8833b6b17b7SMichal Malý 	entry = drv_data->device_props;
8843b6b17b7SMichal Malý 	if (!entry) {
8853b6b17b7SMichal Malý 		hid_err(hid, "Device properties not found!\n");
88629ff6657SSimon Wood 		return -EINVAL;
88730bb75d7SMichal Malý 	}
88830bb75d7SMichal Malý 
88930bb75d7SMichal Malý 	if (range == 0)
89072529c65SMichal Malý 		range = entry->wdata.max_range;
89130bb75d7SMichal Malý 
89230bb75d7SMichal Malý 	/* Check if the wheel supports range setting
89330bb75d7SMichal Malý 	 * and that the range is within limits for the wheel */
89472529c65SMichal Malý 	if (entry->wdata.set_range && range >= entry->wdata.min_range && range <= entry->wdata.max_range) {
89572529c65SMichal Malý 		entry->wdata.set_range(hid, range);
89672529c65SMichal Malý 		entry->wdata.range = range;
89730bb75d7SMichal Malý 	}
89830bb75d7SMichal Malý 
89930bb75d7SMichal Malý 	return count;
90030bb75d7SMichal Malý }
901fbf85e2aSMichal Malý static DEVICE_ATTR(range, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, lg4ff_range_show, lg4ff_range_store);
90230bb75d7SMichal Malý 
903b96d23ecSMichal Malý static ssize_t lg4ff_real_id_show(struct device *dev, struct device_attribute *attr, char *buf)
904b96d23ecSMichal Malý {
905b96d23ecSMichal Malý 	struct hid_device *hid = to_hid_device(dev);
906b96d23ecSMichal Malý 	struct lg4ff_device_entry *entry;
907b96d23ecSMichal Malý 	struct lg_drv_data *drv_data;
908b96d23ecSMichal Malý 	size_t count;
909b96d23ecSMichal Malý 
910b96d23ecSMichal Malý 	drv_data = hid_get_drvdata(hid);
911b96d23ecSMichal Malý 	if (!drv_data) {
912b96d23ecSMichal Malý 		hid_err(hid, "Private driver data not found!\n");
913b96d23ecSMichal Malý 		return 0;
914b96d23ecSMichal Malý 	}
915b96d23ecSMichal Malý 
916b96d23ecSMichal Malý 	entry = drv_data->device_props;
917b96d23ecSMichal Malý 	if (!entry) {
918b96d23ecSMichal Malý 		hid_err(hid, "Device properties not found!\n");
919b96d23ecSMichal Malý 		return 0;
920b96d23ecSMichal Malý 	}
921b96d23ecSMichal Malý 
92272529c65SMichal Malý 	if (!entry->wdata.real_tag || !entry->wdata.real_name) {
923b96d23ecSMichal Malý 		hid_err(hid, "NULL pointer to string\n");
924b96d23ecSMichal Malý 		return 0;
925b96d23ecSMichal Malý 	}
926b96d23ecSMichal Malý 
92772529c65SMichal Malý 	count = scnprintf(buf, PAGE_SIZE, "%s: %s\n", entry->wdata.real_tag, entry->wdata.real_name);
928b96d23ecSMichal Malý 	return count;
929b96d23ecSMichal Malý }
930b96d23ecSMichal Malý 
931b96d23ecSMichal Malý static ssize_t lg4ff_real_id_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
932b96d23ecSMichal Malý {
933b96d23ecSMichal Malý 	/* Real ID is a read-only value */
934b96d23ecSMichal Malý 	return -EPERM;
935b96d23ecSMichal Malý }
936b96d23ecSMichal Malý static DEVICE_ATTR(real_id, S_IRUGO, lg4ff_real_id_show, lg4ff_real_id_store);
937b96d23ecSMichal Malý 
93822bcefdcSSimon Wood #ifdef CONFIG_LEDS_CLASS
9392a552c30SMichal Malý static void lg4ff_set_leds(struct hid_device *hid, u8 leds)
94022bcefdcSSimon Wood {
941c918fe78SMichal Malý 	struct lg_drv_data *drv_data;
942c918fe78SMichal Malý 	struct lg4ff_device_entry *entry;
943c918fe78SMichal Malý 	unsigned long flags;
944c28abd8cSMichal Malý 	s32 *value;
94522bcefdcSSimon Wood 
946c918fe78SMichal Malý 	drv_data = hid_get_drvdata(hid);
947c918fe78SMichal Malý 	if (!drv_data) {
948c918fe78SMichal Malý 		hid_err(hid, "Private driver data not found!\n");
949c918fe78SMichal Malý 		return;
950c918fe78SMichal Malý 	}
951c918fe78SMichal Malý 
952c918fe78SMichal Malý 	entry = drv_data->device_props;
953c918fe78SMichal Malý 	if (!entry) {
954c918fe78SMichal Malý 		hid_err(hid, "Device properties not found!\n");
955c918fe78SMichal Malý 		return;
956c918fe78SMichal Malý 	}
957c28abd8cSMichal Malý 	value = entry->report->field[0]->value;
958c918fe78SMichal Malý 
959c918fe78SMichal Malý 	spin_lock_irqsave(&entry->report_lock, flags);
96074479ba8SMichal Malý 	value[0] = 0xf8;
96174479ba8SMichal Malý 	value[1] = 0x12;
96274479ba8SMichal Malý 	value[2] = leds;
96374479ba8SMichal Malý 	value[3] = 0x00;
96474479ba8SMichal Malý 	value[4] = 0x00;
96574479ba8SMichal Malý 	value[5] = 0x00;
96674479ba8SMichal Malý 	value[6] = 0x00;
967c28abd8cSMichal Malý 	hid_hw_request(hid, entry->report, HID_REQ_SET_REPORT);
968c918fe78SMichal Malý 	spin_unlock_irqrestore(&entry->report_lock, flags);
96922bcefdcSSimon Wood }
97022bcefdcSSimon Wood 
97122bcefdcSSimon Wood static void lg4ff_led_set_brightness(struct led_classdev *led_cdev,
97222bcefdcSSimon Wood 			enum led_brightness value)
97322bcefdcSSimon Wood {
97422bcefdcSSimon Wood 	struct device *dev = led_cdev->dev->parent;
97522bcefdcSSimon Wood 	struct hid_device *hid = container_of(dev, struct hid_device, dev);
9764629fd16SAxel Lin 	struct lg_drv_data *drv_data = hid_get_drvdata(hid);
97722bcefdcSSimon Wood 	struct lg4ff_device_entry *entry;
97822bcefdcSSimon Wood 	int i, state = 0;
97922bcefdcSSimon Wood 
98022bcefdcSSimon Wood 	if (!drv_data) {
98122bcefdcSSimon Wood 		hid_err(hid, "Device data not found.");
98222bcefdcSSimon Wood 		return;
98322bcefdcSSimon Wood 	}
98422bcefdcSSimon Wood 
985371a1d9eSMichal Malý 	entry = drv_data->device_props;
98622bcefdcSSimon Wood 
98722bcefdcSSimon Wood 	if (!entry) {
98822bcefdcSSimon Wood 		hid_err(hid, "Device properties not found.");
98922bcefdcSSimon Wood 		return;
99022bcefdcSSimon Wood 	}
99122bcefdcSSimon Wood 
99222bcefdcSSimon Wood 	for (i = 0; i < 5; i++) {
99372529c65SMichal Malý 		if (led_cdev != entry->wdata.led[i])
99422bcefdcSSimon Wood 			continue;
99572529c65SMichal Malý 		state = (entry->wdata.led_state >> i) & 1;
99622bcefdcSSimon Wood 		if (value == LED_OFF && state) {
99772529c65SMichal Malý 			entry->wdata.led_state &= ~(1 << i);
99872529c65SMichal Malý 			lg4ff_set_leds(hid, entry->wdata.led_state);
99922bcefdcSSimon Wood 		} else if (value != LED_OFF && !state) {
100072529c65SMichal Malý 			entry->wdata.led_state |= 1 << i;
100172529c65SMichal Malý 			lg4ff_set_leds(hid, entry->wdata.led_state);
100222bcefdcSSimon Wood 		}
100322bcefdcSSimon Wood 		break;
100422bcefdcSSimon Wood 	}
100522bcefdcSSimon Wood }
100622bcefdcSSimon Wood 
100722bcefdcSSimon Wood static enum led_brightness lg4ff_led_get_brightness(struct led_classdev *led_cdev)
100822bcefdcSSimon Wood {
100922bcefdcSSimon Wood 	struct device *dev = led_cdev->dev->parent;
101022bcefdcSSimon Wood 	struct hid_device *hid = container_of(dev, struct hid_device, dev);
10114629fd16SAxel Lin 	struct lg_drv_data *drv_data = hid_get_drvdata(hid);
101222bcefdcSSimon Wood 	struct lg4ff_device_entry *entry;
101322bcefdcSSimon Wood 	int i, value = 0;
101422bcefdcSSimon Wood 
101522bcefdcSSimon Wood 	if (!drv_data) {
101622bcefdcSSimon Wood 		hid_err(hid, "Device data not found.");
101722bcefdcSSimon Wood 		return LED_OFF;
101822bcefdcSSimon Wood 	}
101922bcefdcSSimon Wood 
1020371a1d9eSMichal Malý 	entry = drv_data->device_props;
102122bcefdcSSimon Wood 
102222bcefdcSSimon Wood 	if (!entry) {
102322bcefdcSSimon Wood 		hid_err(hid, "Device properties not found.");
102422bcefdcSSimon Wood 		return LED_OFF;
102522bcefdcSSimon Wood 	}
102622bcefdcSSimon Wood 
102722bcefdcSSimon Wood 	for (i = 0; i < 5; i++)
102872529c65SMichal Malý 		if (led_cdev == entry->wdata.led[i]) {
102972529c65SMichal Malý 			value = (entry->wdata.led_state >> i) & 1;
103022bcefdcSSimon Wood 			break;
103122bcefdcSSimon Wood 		}
103222bcefdcSSimon Wood 
103322bcefdcSSimon Wood 	return value ? LED_FULL : LED_OFF;
103422bcefdcSSimon Wood }
103522bcefdcSSimon Wood #endif
103622bcefdcSSimon Wood 
1037e7c23449SMichal Malý static u16 lg4ff_identify_multimode_wheel(struct hid_device *hid, const u16 reported_product_id, const u16 bcdDevice)
1038e7c23449SMichal Malý {
1039*bbec1bd0SSimon Wood 	u32 current_mode;
1040*bbec1bd0SSimon Wood 	int i;
1041e7c23449SMichal Malý 
1042*bbec1bd0SSimon Wood 	/* identify current mode from USB PID */
1043*bbec1bd0SSimon Wood 	for (i = 1; i < ARRAY_SIZE(lg4ff_alternate_modes); i++) {
1044*bbec1bd0SSimon Wood 		dbg_hid("Testing whether PID is %X\n", lg4ff_alternate_modes[i].product_id);
1045*bbec1bd0SSimon Wood 		if (reported_product_id == lg4ff_alternate_modes[i].product_id)
1046e7c23449SMichal Malý 			break;
1047e7c23449SMichal Malý 	}
1048e7c23449SMichal Malý 
1049*bbec1bd0SSimon Wood 	if (i == ARRAY_SIZE(lg4ff_alternate_modes))
1050*bbec1bd0SSimon Wood 		return 0;
1051e7c23449SMichal Malý 
1052*bbec1bd0SSimon Wood 	current_mode = BIT(i);
1053*bbec1bd0SSimon Wood 
1054*bbec1bd0SSimon Wood 	for (i = 0; i < ARRAY_SIZE(lg4ff_main_checklist); i++) {
1055*bbec1bd0SSimon Wood 		const u16 mask = lg4ff_main_checklist[i]->mask;
1056*bbec1bd0SSimon Wood 		const u16 result = lg4ff_main_checklist[i]->result;
1057*bbec1bd0SSimon Wood 		const u16 real_product_id = lg4ff_main_checklist[i]->real_product_id;
1058*bbec1bd0SSimon Wood 
1059*bbec1bd0SSimon Wood 		if ((current_mode & lg4ff_main_checklist[i]->modes) && \
1060*bbec1bd0SSimon Wood 				(bcdDevice & mask) == result) {
1061e7c23449SMichal Malý 			dbg_hid("Found wheel with real PID %X whose reported PID is %X\n", real_product_id, reported_product_id);
1062e7c23449SMichal Malý 			return real_product_id;
1063e7c23449SMichal Malý 		}
1064e7c23449SMichal Malý 	}
1065e7c23449SMichal Malý 
1066f31a2de3SMichal Malý 	/* No match found. This is either Driving Force or an unknown
1067f31a2de3SMichal Malý 	 * wheel model, do not touch it */
1068e7c23449SMichal Malý 	dbg_hid("Wheel with bcdDevice %X was not recognized as multimode wheel, leaving in its current mode\n", bcdDevice);
1069e7c23449SMichal Malý 	return 0;
1070e7c23449SMichal Malý }
1071e7c23449SMichal Malý 
1072e7c23449SMichal Malý static int lg4ff_handle_multimode_wheel(struct hid_device *hid, u16 *real_product_id, const u16 bcdDevice)
1073e7c23449SMichal Malý {
1074e7c23449SMichal Malý 	const u16 reported_product_id = hid->product;
1075e7c23449SMichal Malý 	int ret;
1076e7c23449SMichal Malý 
1077e7c23449SMichal Malý 	*real_product_id = lg4ff_identify_multimode_wheel(hid, reported_product_id, bcdDevice);
1078e7c23449SMichal Malý 	/* Probed wheel is not a multimode wheel */
1079e7c23449SMichal Malý 	if (!*real_product_id) {
1080e7c23449SMichal Malý 		*real_product_id = reported_product_id;
1081e7c23449SMichal Malý 		dbg_hid("Wheel is not a multimode wheel\n");
1082e7c23449SMichal Malý 		return LG4FF_MMODE_NOT_MULTIMODE;
1083e7c23449SMichal Malý 	}
1084e7c23449SMichal Malý 
1085e7c23449SMichal Malý 	/* Switch from "Driving Force" mode to native mode automatically.
1086e7c23449SMichal Malý 	 * Otherwise keep the wheel in its current mode */
1087e7c23449SMichal Malý 	if (reported_product_id == USB_DEVICE_ID_LOGITECH_WHEEL &&
1088a54dc779SMichal Malý 	    reported_product_id != *real_product_id &&
1089a54dc779SMichal Malý 	    !lg4ff_no_autoswitch) {
1090f31a2de3SMichal Malý 		const struct lg4ff_compat_mode_switch *s = lg4ff_get_mode_switch_command(*real_product_id, *real_product_id);
1091e7c23449SMichal Malý 
1092f31a2de3SMichal Malý 		if (!s) {
1093e7c23449SMichal Malý 			hid_err(hid, "Invalid product id %X\n", *real_product_id);
1094b96d23ecSMichal Malý 			return LG4FF_MMODE_NOT_MULTIMODE;
1095e7c23449SMichal Malý 		}
1096e7c23449SMichal Malý 
1097e7c23449SMichal Malý 		ret = lg4ff_switch_compatibility_mode(hid, s);
1098e7c23449SMichal Malý 		if (ret) {
1099e7c23449SMichal Malý 			/* Wheel could not have been switched to native mode,
1100e7c23449SMichal Malý 			 * leave it in "Driving Force" mode and continue */
1101e7c23449SMichal Malý 			hid_err(hid, "Unable to switch wheel mode, errno %d\n", ret);
1102b96d23ecSMichal Malý 			return LG4FF_MMODE_IS_MULTIMODE;
1103e7c23449SMichal Malý 		}
1104e7c23449SMichal Malý 		return LG4FF_MMODE_SWITCHED;
1105e7c23449SMichal Malý 	}
1106e7c23449SMichal Malý 
1107b96d23ecSMichal Malý 	return LG4FF_MMODE_IS_MULTIMODE;
1108e7c23449SMichal Malý }
1109e7c23449SMichal Malý 
1110e7c23449SMichal Malý 
111132c88cbcSSimon Wood int lg4ff_init(struct hid_device *hid)
111232c88cbcSSimon Wood {
111332c88cbcSSimon Wood 	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
111432c88cbcSSimon Wood 	struct input_dev *dev = hidinput->input;
1115c28abd8cSMichal Malý 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
1116c28abd8cSMichal Malý 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
1117e7c23449SMichal Malý 	const struct usb_device_descriptor *udesc = &(hid_to_usb_dev(hid)->descriptor);
1118e7c23449SMichal Malý 	const u16 bcdDevice = le16_to_cpu(udesc->bcdDevice);
11195d9d60adSMichal Malý 	const struct lg4ff_multimode_wheel *mmode_wheel = NULL;
112030bb75d7SMichal Malý 	struct lg4ff_device_entry *entry;
11213b6b17b7SMichal Malý 	struct lg_drv_data *drv_data;
1122b96d23ecSMichal Malý 	int error, i, j;
1123b96d23ecSMichal Malý 	int mmode_ret, mmode_idx = -1;
1124e7c23449SMichal Malý 	u16 real_product_id;
112532c88cbcSSimon Wood 
112632c88cbcSSimon Wood 	/* Check that the report looks ok */
11270fb6bd06SKees Cook 	if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 7))
112832c88cbcSSimon Wood 		return -1;
112932c88cbcSSimon Wood 
113072529c65SMichal Malý 	drv_data = hid_get_drvdata(hid);
113172529c65SMichal Malý 	if (!drv_data) {
113272529c65SMichal Malý 		hid_err(hid, "Cannot add device, private driver data not allocated\n");
113372529c65SMichal Malý 		return -1;
113472529c65SMichal Malý 	}
113572529c65SMichal Malý 	entry = kzalloc(sizeof(*entry), GFP_KERNEL);
113672529c65SMichal Malý 	if (!entry)
113772529c65SMichal Malý 		return -ENOMEM;
1138c918fe78SMichal Malý 	spin_lock_init(&entry->report_lock);
1139c28abd8cSMichal Malý 	entry->report = report;
114072529c65SMichal Malý 	drv_data->device_props = entry;
114172529c65SMichal Malý 
1142e7c23449SMichal Malý 	/* Check if a multimode wheel has been connected and
1143e7c23449SMichal Malý 	 * handle it appropriately */
1144b96d23ecSMichal Malý 	mmode_ret = lg4ff_handle_multimode_wheel(hid, &real_product_id, bcdDevice);
1145e7c23449SMichal Malý 
1146e7c23449SMichal Malý 	/* Wheel has been told to switch to native mode. There is no point in going on
1147e7c23449SMichal Malý 	 * with the initialization as the wheel will do a USB reset when it switches mode
1148e7c23449SMichal Malý 	 */
1149b96d23ecSMichal Malý 	if (mmode_ret == LG4FF_MMODE_SWITCHED)
1150e7c23449SMichal Malý 		return 0;
115172529c65SMichal Malý 	else if (mmode_ret < 0) {
115272529c65SMichal Malý 		hid_err(hid, "Unable to switch device mode during initialization, errno %d\n", mmode_ret);
115372529c65SMichal Malý 		error = mmode_ret;
115472529c65SMichal Malý 		goto err_init;
115572529c65SMichal Malý 	}
1156e7c23449SMichal Malý 
11577362cd22SMichal Malý 	/* Check what wheel has been connected */
11587362cd22SMichal Malý 	for (i = 0; i < ARRAY_SIZE(lg4ff_devices); i++) {
11597362cd22SMichal Malý 		if (hid->product == lg4ff_devices[i].product_id) {
11607362cd22SMichal Malý 			dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices[i].product_id);
11617362cd22SMichal Malý 			break;
11627362cd22SMichal Malý 		}
11637362cd22SMichal Malý 	}
11647362cd22SMichal Malý 
11657362cd22SMichal Malý 	if (i == ARRAY_SIZE(lg4ff_devices)) {
11669c2a6bd1SMichal Malý 		hid_err(hid, "This device is flagged to be handled by the lg4ff module but this module does not know how to handle it. "
11679c2a6bd1SMichal Malý 			     "Please report this as a bug to LKML, Simon Wood <simon@mungewell.org> or "
11689c2a6bd1SMichal Malý 			     "Michal Maly <madcatxster@devoid-pointer.net>\n");
116972529c65SMichal Malý 		error = -1;
117072529c65SMichal Malý 		goto err_init;
11717362cd22SMichal Malý 	}
11727362cd22SMichal Malý 
1173b96d23ecSMichal Malý 	if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1174b96d23ecSMichal Malý 		for (mmode_idx = 0; mmode_idx < ARRAY_SIZE(lg4ff_multimode_wheels); mmode_idx++) {
1175b96d23ecSMichal Malý 			if (real_product_id == lg4ff_multimode_wheels[mmode_idx].product_id)
1176b96d23ecSMichal Malý 				break;
1177b96d23ecSMichal Malý 		}
1178b96d23ecSMichal Malý 
1179b96d23ecSMichal Malý 		if (mmode_idx == ARRAY_SIZE(lg4ff_multimode_wheels)) {
1180b96d23ecSMichal Malý 			hid_err(hid, "Device product ID %X is not listed as a multimode wheel", real_product_id);
118172529c65SMichal Malý 			error = -1;
118272529c65SMichal Malý 			goto err_init;
1183b96d23ecSMichal Malý 		}
1184b96d23ecSMichal Malý 	}
1185b96d23ecSMichal Malý 
11867362cd22SMichal Malý 	/* Set supported force feedback capabilities */
11877362cd22SMichal Malý 	for (j = 0; lg4ff_devices[i].ff_effects[j] >= 0; j++)
11887362cd22SMichal Malý 		set_bit(lg4ff_devices[i].ff_effects[j], dev->ffbit);
118932c88cbcSSimon Wood 
1190d0afd848SMichal Malý 	error = input_ff_create_memless(dev, NULL, lg4ff_play);
119132c88cbcSSimon Wood 
119232c88cbcSSimon Wood 	if (error)
119372529c65SMichal Malý 		goto err_init;
119432c88cbcSSimon Wood 
11955d9d60adSMichal Malý 	/* Initialize device properties */
1196b96d23ecSMichal Malý 	if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1197b96d23ecSMichal Malý 		BUG_ON(mmode_idx == -1);
11985d9d60adSMichal Malý 		mmode_wheel = &lg4ff_multimode_wheels[mmode_idx];
1199b96d23ecSMichal Malý 	}
12005d9d60adSMichal Malý 	lg4ff_init_wheel_data(&entry->wdata, &lg4ff_devices[i], mmode_wheel, real_product_id);
120130bb75d7SMichal Malý 
1202114a55cfSSimon Wood 	/* Check if autocentering is available and
1203114a55cfSSimon Wood 	 * set the centering force to zero by default */
1204114a55cfSSimon Wood 	if (test_bit(FF_AUTOCENTER, dev->ffbit)) {
1205e7c23449SMichal Malý 		/* Formula Force EX expects different autocentering command */
1206e7c23449SMichal Malý 		if ((bcdDevice >> 8) == LG4FF_FFEX_REV_MAJ &&
1207e7c23449SMichal Malý 		    (bcdDevice & 0xff) == LG4FF_FFEX_REV_MIN)
1208d0afd848SMichal Malý 			dev->ff->set_autocenter = lg4ff_set_autocenter_ffex;
1209114a55cfSSimon Wood 		else
1210d0afd848SMichal Malý 			dev->ff->set_autocenter = lg4ff_set_autocenter_default;
1211114a55cfSSimon Wood 
1212114a55cfSSimon Wood 		dev->ff->set_autocenter(dev, 0);
1213114a55cfSSimon Wood 	}
1214114a55cfSSimon Wood 
121530bb75d7SMichal Malý 	/* Create sysfs interface */
121630bb75d7SMichal Malý 	error = device_create_file(&hid->dev, &dev_attr_range);
121730bb75d7SMichal Malý 	if (error)
1218d61a70ecSMichal Malý 		hid_warn(hid, "Unable to create sysfs interface for \"range\", errno %d\n", error);
1219b96d23ecSMichal Malý 	if (mmode_ret == LG4FF_MMODE_IS_MULTIMODE) {
1220b96d23ecSMichal Malý 		error = device_create_file(&hid->dev, &dev_attr_real_id);
1221b96d23ecSMichal Malý 		if (error)
1222d61a70ecSMichal Malý 			hid_warn(hid, "Unable to create sysfs interface for \"real_id\", errno %d\n", error);
1223b96d23ecSMichal Malý 		error = device_create_file(&hid->dev, &dev_attr_alternate_modes);
1224b96d23ecSMichal Malý 		if (error)
1225d61a70ecSMichal Malý 			hid_warn(hid, "Unable to create sysfs interface for \"alternate_modes\", errno %d\n", error);
1226b96d23ecSMichal Malý 	}
122730bb75d7SMichal Malý 	dbg_hid("sysfs interface created\n");
122830bb75d7SMichal Malý 
122930bb75d7SMichal Malý 	/* Set the maximum range to start with */
123072529c65SMichal Malý 	entry->wdata.range = entry->wdata.max_range;
123172529c65SMichal Malý 	if (entry->wdata.set_range)
123272529c65SMichal Malý 		entry->wdata.set_range(hid, entry->wdata.range);
123330bb75d7SMichal Malý 
123422bcefdcSSimon Wood #ifdef CONFIG_LEDS_CLASS
123522bcefdcSSimon Wood 	/* register led subsystem - G27 only */
123672529c65SMichal Malý 	entry->wdata.led_state = 0;
123722bcefdcSSimon Wood 	for (j = 0; j < 5; j++)
123872529c65SMichal Malý 		entry->wdata.led[j] = NULL;
123922bcefdcSSimon Wood 
124022bcefdcSSimon Wood 	if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_G27_WHEEL) {
124122bcefdcSSimon Wood 		struct led_classdev *led;
124222bcefdcSSimon Wood 		size_t name_sz;
124322bcefdcSSimon Wood 		char *name;
124422bcefdcSSimon Wood 
124522bcefdcSSimon Wood 		lg4ff_set_leds(hid, 0);
124622bcefdcSSimon Wood 
124722bcefdcSSimon Wood 		name_sz = strlen(dev_name(&hid->dev)) + 8;
124822bcefdcSSimon Wood 
124922bcefdcSSimon Wood 		for (j = 0; j < 5; j++) {
125022bcefdcSSimon Wood 			led = kzalloc(sizeof(struct led_classdev)+name_sz, GFP_KERNEL);
125122bcefdcSSimon Wood 			if (!led) {
125222bcefdcSSimon Wood 				hid_err(hid, "can't allocate memory for LED %d\n", j);
125372529c65SMichal Malý 				goto err_leds;
125422bcefdcSSimon Wood 			}
125522bcefdcSSimon Wood 
125622bcefdcSSimon Wood 			name = (void *)(&led[1]);
125722bcefdcSSimon Wood 			snprintf(name, name_sz, "%s::RPM%d", dev_name(&hid->dev), j+1);
125822bcefdcSSimon Wood 			led->name = name;
125922bcefdcSSimon Wood 			led->brightness = 0;
126022bcefdcSSimon Wood 			led->max_brightness = 1;
126122bcefdcSSimon Wood 			led->brightness_get = lg4ff_led_get_brightness;
126222bcefdcSSimon Wood 			led->brightness_set = lg4ff_led_set_brightness;
126322bcefdcSSimon Wood 
126472529c65SMichal Malý 			entry->wdata.led[j] = led;
126522bcefdcSSimon Wood 			error = led_classdev_register(&hid->dev, led);
126622bcefdcSSimon Wood 
126722bcefdcSSimon Wood 			if (error) {
126822bcefdcSSimon Wood 				hid_err(hid, "failed to register LED %d. Aborting.\n", j);
126972529c65SMichal Malý err_leds:
127022bcefdcSSimon Wood 				/* Deregister LEDs (if any) */
127122bcefdcSSimon Wood 				for (j = 0; j < 5; j++) {
127272529c65SMichal Malý 					led = entry->wdata.led[j];
127372529c65SMichal Malý 					entry->wdata.led[j] = NULL;
127422bcefdcSSimon Wood 					if (!led)
127522bcefdcSSimon Wood 						continue;
127622bcefdcSSimon Wood 					led_classdev_unregister(led);
127722bcefdcSSimon Wood 					kfree(led);
127822bcefdcSSimon Wood 				}
127922bcefdcSSimon Wood 				goto out;	/* Let the driver continue without LEDs */
128022bcefdcSSimon Wood 			}
128122bcefdcSSimon Wood 		}
128222bcefdcSSimon Wood 	}
128322bcefdcSSimon Wood out:
1284c6e6dc87SJiri Kosina #endif
128564013800SSimon Wood 	hid_info(hid, "Force feedback support for Logitech Gaming Wheels\n");
128632c88cbcSSimon Wood 	return 0;
128772529c65SMichal Malý 
128872529c65SMichal Malý err_init:
128972529c65SMichal Malý 	drv_data->device_props = NULL;
129072529c65SMichal Malý 	kfree(entry);
129172529c65SMichal Malý 	return error;
129232c88cbcSSimon Wood }
129332c88cbcSSimon Wood 
129430bb75d7SMichal Malý int lg4ff_deinit(struct hid_device *hid)
129530bb75d7SMichal Malý {
129630bb75d7SMichal Malý 	struct lg4ff_device_entry *entry;
12973b6b17b7SMichal Malý 	struct lg_drv_data *drv_data;
12986a2e176bSMichal Malý 
12993b6b17b7SMichal Malý 	drv_data = hid_get_drvdata(hid);
13003b6b17b7SMichal Malý 	if (!drv_data) {
13013b6b17b7SMichal Malý 		hid_err(hid, "Error while deinitializing device, no private driver data.\n");
130230bb75d7SMichal Malý 		return -1;
130330bb75d7SMichal Malý 	}
13043b6b17b7SMichal Malý 	entry = drv_data->device_props;
1305e7c23449SMichal Malý 	if (!entry)
1306e7c23449SMichal Malý 		goto out; /* Nothing more to do */
1307e7c23449SMichal Malý 
1308b96d23ecSMichal Malý 	/* Multimode devices will have at least the "MODE_NATIVE" bit set */
130972529c65SMichal Malý 	if (entry->wdata.alternate_modes) {
1310b96d23ecSMichal Malý 		device_remove_file(&hid->dev, &dev_attr_real_id);
1311b96d23ecSMichal Malý 		device_remove_file(&hid->dev, &dev_attr_alternate_modes);
1312b96d23ecSMichal Malý 	}
1313b96d23ecSMichal Malý 
131472529c65SMichal Malý 	device_remove_file(&hid->dev, &dev_attr_range);
131522bcefdcSSimon Wood #ifdef CONFIG_LEDS_CLASS
131622bcefdcSSimon Wood 	{
131722bcefdcSSimon Wood 		int j;
131822bcefdcSSimon Wood 		struct led_classdev *led;
131922bcefdcSSimon Wood 
132022bcefdcSSimon Wood 		/* Deregister LEDs (if any) */
132122bcefdcSSimon Wood 		for (j = 0; j < 5; j++) {
132222bcefdcSSimon Wood 
132372529c65SMichal Malý 			led = entry->wdata.led[j];
132472529c65SMichal Malý 			entry->wdata.led[j] = NULL;
132522bcefdcSSimon Wood 			if (!led)
132622bcefdcSSimon Wood 				continue;
132722bcefdcSSimon Wood 			led_classdev_unregister(led);
132822bcefdcSSimon Wood 			kfree(led);
132922bcefdcSSimon Wood 		}
133022bcefdcSSimon Wood 	}
133122bcefdcSSimon Wood #endif
1332b211a638SMichal Malý 	hid_hw_stop(hid);
1333b211a638SMichal Malý 	drv_data->device_props = NULL;
133422bcefdcSSimon Wood 
13353b6b17b7SMichal Malý 	kfree(entry);
1336e7c23449SMichal Malý out:
133730bb75d7SMichal Malý 	dbg_hid("Device successfully unregistered\n");
133830bb75d7SMichal Malý 	return 0;
133930bb75d7SMichal Malý }
1340