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#include "usbhid.h"
34
35struct dev_type {
36	u16 idVendor;
37	u16 idProduct;
38	const signed short *ff;
39};
40
41static const signed short ff_rumble[] = {
42	FF_RUMBLE,
43	-1
44};
45
46static const signed short ff_joystick[] = {
47	FF_CONSTANT,
48	-1
49};
50
51static const struct dev_type devices[] = {
52	{ 0x046d, 0xc211, ff_rumble },
53	{ 0x046d, 0xc219, ff_rumble },
54	{ 0x046d, 0xc283, ff_joystick },
55	{ 0x046d, 0xc286, ff_joystick },
56	{ 0x046d, 0xc294, ff_joystick },
57	{ 0x046d, 0xc295, ff_joystick },
58	{ 0x046d, 0xca03, ff_joystick },
59};
60
61static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
62{
63	struct hid_device *hid = input_get_drvdata(dev);
64	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
65	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
66	int x, y;
67	unsigned int left, right;
68
69#define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
70
71	switch (effect->type) {
72	case FF_CONSTANT:
73		x = effect->u.ramp.start_level + 0x7f;	/* 0x7f is center */
74		y = effect->u.ramp.end_level + 0x7f;
75		CLAMP(x);
76		CLAMP(y);
77		report->field[0]->value[0] = 0x51;
78		report->field[0]->value[1] = 0x08;
79		report->field[0]->value[2] = x;
80		report->field[0]->value[3] = y;
81		dbg("(x, y)=(%04x, %04x)", x, y);
82		usbhid_submit_report(hid, report, USB_DIR_OUT);
83		break;
84
85	case FF_RUMBLE:
86		right = effect->u.rumble.strong_magnitude;
87		left = effect->u.rumble.weak_magnitude;
88		right = right * 0xff / 0xffff;
89		left = left * 0xff / 0xffff;
90		CLAMP(left);
91		CLAMP(right);
92		report->field[0]->value[0] = 0x42;
93		report->field[0]->value[1] = 0x00;
94		report->field[0]->value[2] = left;
95		report->field[0]->value[3] = right;
96		dbg("(left, right)=(%04x, %04x)", left, right);
97		usbhid_submit_report(hid, report, USB_DIR_OUT);
98		break;
99	}
100	return 0;
101}
102
103int hid_lgff_init(struct hid_device* hid)
104{
105	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
106	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
107	struct input_dev *dev = hidinput->input;
108	struct hid_report *report;
109	struct hid_field *field;
110	const signed short *ff_bits = ff_joystick;
111	int error;
112	int i;
113
114	/* Find the report to use */
115	if (list_empty(report_list)) {
116		err("No output report found");
117		return -1;
118	}
119
120	/* Check that the report looks ok */
121	report = list_entry(report_list->next, struct hid_report, list);
122	if (!report) {
123		err("NULL output report");
124		return -1;
125	}
126
127	field = report->field[0];
128	if (!field) {
129		err("NULL field");
130		return -1;
131	}
132
133	for (i = 0; i < ARRAY_SIZE(devices); i++) {
134		if (dev->id.vendor == devices[i].idVendor &&
135		    dev->id.product == devices[i].idProduct) {
136			ff_bits = devices[i].ff;
137			break;
138		}
139	}
140
141	for (i = 0; ff_bits[i] >= 0; i++)
142		set_bit(ff_bits[i], dev->ffbit);
143
144	error = input_ff_create_memless(dev, NULL, hid_lgff_play);
145	if (error)
146		return error;
147
148	printk(KERN_INFO "Force feedback for Logitech force feedback devices by Johann Deneux <johann.deneux@it.uu.se>\n");
149
150	return 0;
151}
152