xref: /openbmc/linux/drivers/hid/hid-lgff.c (revision 367b8112)
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_wheel[] = {
54 	FF_CONSTANT,
55 	FF_AUTOCENTER,
56 	-1
57 };
58 
59 static const struct dev_type devices[] = {
60 	{ 0x046d, 0xc211, ff_rumble },
61 	{ 0x046d, 0xc219, ff_rumble },
62 	{ 0x046d, 0xc283, ff_joystick },
63 	{ 0x046d, 0xc286, ff_joystick },
64 	{ 0x046d, 0xc294, ff_joystick },
65 	{ 0x046d, 0xc295, ff_joystick },
66 	{ 0x046d, 0xca03, ff_wheel },
67 };
68 
69 static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
70 {
71 	struct hid_device *hid = input_get_drvdata(dev);
72 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
73 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
74 	int x, y;
75 	unsigned int left, right;
76 
77 #define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
78 
79 	switch (effect->type) {
80 	case FF_CONSTANT:
81 		x = effect->u.ramp.start_level + 0x7f;	/* 0x7f is center */
82 		y = effect->u.ramp.end_level + 0x7f;
83 		CLAMP(x);
84 		CLAMP(y);
85 		report->field[0]->value[0] = 0x51;
86 		report->field[0]->value[1] = 0x08;
87 		report->field[0]->value[2] = x;
88 		report->field[0]->value[3] = y;
89 		dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
90 		usbhid_submit_report(hid, report, USB_DIR_OUT);
91 		break;
92 
93 	case FF_RUMBLE:
94 		right = effect->u.rumble.strong_magnitude;
95 		left = effect->u.rumble.weak_magnitude;
96 		right = right * 0xff / 0xffff;
97 		left = left * 0xff / 0xffff;
98 		CLAMP(left);
99 		CLAMP(right);
100 		report->field[0]->value[0] = 0x42;
101 		report->field[0]->value[1] = 0x00;
102 		report->field[0]->value[2] = left;
103 		report->field[0]->value[3] = right;
104 		dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
105 		usbhid_submit_report(hid, report, USB_DIR_OUT);
106 		break;
107 	}
108 	return 0;
109 }
110 
111 static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
112 {
113 	struct hid_device *hid = input_get_drvdata(dev);
114 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
115 	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
116 	__s32 *value = report->field[0]->value;
117 	magnitude = (magnitude >> 12) & 0xf;
118 	*value++ = 0xfe;
119 	*value++ = 0x0d;
120 	*value++ = magnitude;   /* clockwise strength */
121 	*value++ = magnitude;   /* counter-clockwise strength */
122 	*value++ = 0x80;
123 	*value++ = 0x00;
124 	*value = 0x00;
125 	usbhid_submit_report(hid, report, USB_DIR_OUT);
126 }
127 
128 int lgff_init(struct hid_device* hid)
129 {
130 	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
131 	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
132 	struct input_dev *dev = hidinput->input;
133 	struct hid_report *report;
134 	struct hid_field *field;
135 	const signed short *ff_bits = ff_joystick;
136 	int error;
137 	int i;
138 
139 	/* Find the report to use */
140 	if (list_empty(report_list)) {
141 		err_hid("No output report found");
142 		return -1;
143 	}
144 
145 	/* Check that the report looks ok */
146 	report = list_entry(report_list->next, struct hid_report, list);
147 	if (!report) {
148 		err_hid("NULL output report");
149 		return -1;
150 	}
151 
152 	field = report->field[0];
153 	if (!field) {
154 		err_hid("NULL field");
155 		return -1;
156 	}
157 
158 	for (i = 0; i < ARRAY_SIZE(devices); i++) {
159 		if (dev->id.vendor == devices[i].idVendor &&
160 		    dev->id.product == devices[i].idProduct) {
161 			ff_bits = devices[i].ff;
162 			break;
163 		}
164 	}
165 
166 	for (i = 0; ff_bits[i] >= 0; i++)
167 		set_bit(ff_bits[i], dev->ffbit);
168 
169 	error = input_ff_create_memless(dev, NULL, hid_lgff_play);
170 	if (error)
171 		return error;
172 
173 	if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
174 		dev->ff->set_autocenter = hid_lgff_set_autocenter;
175 
176 	printk(KERN_INFO "Force feedback for Logitech force feedback devices by Johann Deneux <johann.deneux@it.uu.se>\n");
177 
178 	return 0;
179 }
180