xref: /linux/drivers/hid/hid-lgff.c (revision d39d0ed196aa1685bb24771e92f78633c66ac9cb)
1 /*
2  * Force feedback support for hid-compliant for some of the devices from
3  * Logitech, namely:
4  * - WingMan Cordless RumblePad
5  * - WingMan Force 3D
6  *
7  *  Copyright (c) 2002-2004 Johann Deneux
8  *  Copyright (c) 2006 Anssi Hannula <anssi.hannula@gmail.com>
9  */
10 
11 /*
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Should you need to contact me, the author, you can do so by
27  * e-mail - mail your message to <johann.deneux@it.uu.se>
28  */
29 
30 #include <linux/input.h>
31 #include <linux/usb.h>
32 #include <linux/hid.h>
33 
34 #include "usbhid/usbhid.h"
35 #include "hid-lg.h"
36 
37 struct dev_type {
38 	u16 idVendor;
39 	u16 idProduct;
40 	const signed short *ff;
41 };
42 
43 static const signed short ff_rumble[] = {
44 	FF_RUMBLE,
45 	-1
46 };
47 
48 static const signed short ff_joystick[] = {
49 	FF_CONSTANT,
50 	-1
51 };
52 
53 static const signed short ff_joystick_ac[] = {
54 	FF_CONSTANT,
55 	FF_AUTOCENTER,
56 	-1
57 };
58 
59 static const signed short ff_wheel[] = {
60 	FF_CONSTANT,
61 	FF_AUTOCENTER,
62 	-1
63 };
64 
65 static const struct dev_type devices[] = {
66 	{ 0x046d, 0xc211, ff_rumble },
67 	{ 0x046d, 0xc219, ff_rumble },
68 	{ 0x046d, 0xc283, ff_joystick },
69 	{ 0x046d, 0xc286, ff_joystick_ac },
70 	{ 0x046d, 0xc287, ff_joystick_ac },
71 	{ 0x046d, 0xc293, ff_joystick },
72 	{ 0x046d, 0xc294, ff_wheel },
73 	{ 0x046d, 0xc295, ff_joystick },
74 	{ 0x046d, 0xca03, ff_wheel },
75 };
76 
77 static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
78 {
79 	struct hid_device *hid = input_get_drvdata(dev);
80 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
81 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
82 	int x, y;
83 	unsigned int left, right;
84 
85 #define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
86 
87 	switch (effect->type) {
88 	case FF_CONSTANT:
89 		x = effect->u.ramp.start_level + 0x7f;	/* 0x7f is center */
90 		y = effect->u.ramp.end_level + 0x7f;
91 		CLAMP(x);
92 		CLAMP(y);
93 		report->field[0]->value[0] = 0x51;
94 		report->field[0]->value[1] = 0x08;
95 		report->field[0]->value[2] = x;
96 		report->field[0]->value[3] = y;
97 		dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
98 		usbhid_submit_report(hid, report, USB_DIR_OUT);
99 		break;
100 
101 	case FF_RUMBLE:
102 		right = effect->u.rumble.strong_magnitude;
103 		left = effect->u.rumble.weak_magnitude;
104 		right = right * 0xff / 0xffff;
105 		left = left * 0xff / 0xffff;
106 		CLAMP(left);
107 		CLAMP(right);
108 		report->field[0]->value[0] = 0x42;
109 		report->field[0]->value[1] = 0x00;
110 		report->field[0]->value[2] = left;
111 		report->field[0]->value[3] = right;
112 		dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
113 		usbhid_submit_report(hid, report, USB_DIR_OUT);
114 		break;
115 	}
116 	return 0;
117 }
118 
119 static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
120 {
121 	struct hid_device *hid = input_get_drvdata(dev);
122 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
123 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
124 	__s32 *value = report->field[0]->value;
125 	magnitude = (magnitude >> 12) & 0xf;
126 	*value++ = 0xfe;
127 	*value++ = 0x0d;
128 	*value++ = magnitude;   /* clockwise strength */
129 	*value++ = magnitude;   /* counter-clockwise strength */
130 	*value++ = 0x80;
131 	*value++ = 0x00;
132 	*value = 0x00;
133 	usbhid_submit_report(hid, report, USB_DIR_OUT);
134 }
135 
136 int lgff_init(struct hid_device* hid)
137 {
138 	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
139 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
140 	struct input_dev *dev = hidinput->input;
141 	struct hid_report *report;
142 	struct hid_field *field;
143 	const signed short *ff_bits = ff_joystick;
144 	int error;
145 	int i;
146 
147 	/* Find the report to use */
148 	if (list_empty(report_list)) {
149 		err_hid("No output report found");
150 		return -1;
151 	}
152 
153 	/* Check that the report looks ok */
154 	report = list_entry(report_list->next, struct hid_report, list);
155 	field = report->field[0];
156 	if (!field) {
157 		err_hid("NULL field");
158 		return -1;
159 	}
160 
161 	for (i = 0; i < ARRAY_SIZE(devices); i++) {
162 		if (dev->id.vendor == devices[i].idVendor &&
163 		    dev->id.product == devices[i].idProduct) {
164 			ff_bits = devices[i].ff;
165 			break;
166 		}
167 	}
168 
169 	for (i = 0; ff_bits[i] >= 0; i++)
170 		set_bit(ff_bits[i], dev->ffbit);
171 
172 	error = input_ff_create_memless(dev, NULL, hid_lgff_play);
173 	if (error)
174 		return error;
175 
176 	if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
177 		dev->ff->set_autocenter = hid_lgff_set_autocenter;
178 
179 	printk(KERN_INFO "Force feedback for Logitech force feedback devices by Johann Deneux <johann.deneux@it.uu.se>\n");
180 
181 	return 0;
182 }
183