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