[deliverable/linux.git] / drivers / hid / hid-tmff.c

/*
 * Force feedback support for various HID compliant devices by ThrustMaster:
 *    ThrustMaster FireStorm Dual Power 2
 * and possibly others whose device ids haven't been added.
 *
 *  Modified to support ThrustMaster devices by Zinx Verituse
 *  on 2003-01-25 from the Logitech force feedback driver,
 *  which is by Johann Deneux.
 *
 *  Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
 *  Copyright (c) 2002 Johann Deneux
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include <linux/hid.h>
#include <linux/input.h>
#include <linux/usb.h>

#include "hid-ids.h"

static const signed short ff_rumble[] = {
	FF_RUMBLE,
	-1
};

static const signed short ff_joystick[] = {
	FF_CONSTANT,
	-1
};

#ifdef CONFIG_THRUSTMASTER_FF
#include "usbhid/usbhid.h"

/* Usages for thrustmaster devices I know about */
#define THRUSTMASTER_USAGE_FF	(HID_UP_GENDESK | 0xbb)

struct tmff_device {
	struct hid_report *report;
	struct hid_field *ff_field;
};

/* Changes values from 0 to 0xffff into values from minimum to maximum */
static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
{
	int ret;

	ret = (in * (maximum - minimum) / 0xffff) + minimum;
	if (ret < minimum)
		return minimum;
	if (ret > maximum)
		return maximum;
	return ret;
}

/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
static inline int tmff_scale_s8(int in, int minimum, int maximum)
{
	int ret;

	ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
	if (ret < minimum)
		return minimum;
	if (ret > maximum)
		return maximum;
	return ret;
}

static int tmff_play(struct input_dev *dev, void *data,
		struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct tmff_device *tmff = data;
	struct hid_field *ff_field = tmff->ff_field;
	int x, y;
	int left, right;	/* Rumbling */

	switch (effect->type) {
	case FF_CONSTANT:
		x = tmff_scale_s8(effect->u.ramp.start_level,
					ff_field->logical_minimum,
					ff_field->logical_maximum);
		y = tmff_scale_s8(effect->u.ramp.end_level,
					ff_field->logical_minimum,
					ff_field->logical_maximum);

		dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
		ff_field->value[0] = x;
		ff_field->value[1] = y;
		usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
		break;

	case FF_RUMBLE:
		left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
					ff_field->logical_minimum,
					ff_field->logical_maximum);
		right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
					ff_field->logical_minimum,
					ff_field->logical_maximum);

		dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
		ff_field->value[0] = left;
		ff_field->value[1] = right;
		usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
		break;
	}
	return 0;
}

static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
{
	struct tmff_device *tmff;
	struct hid_report *report;
	struct list_head *report_list;
	struct hid_input *hidinput = list_entry(hid->inputs.next,
							struct hid_input, list);
	struct input_dev *input_dev = hidinput->input;
	int error;
	int i;

	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
	if (!tmff)
		return -ENOMEM;

	/* Find the report to use */
	report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	list_for_each_entry(report, report_list, list) {
		int fieldnum;

		for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
			struct hid_field *field = report->field[fieldnum];

			if (field->maxusage <= 0)
				continue;

			switch (field->usage[0].hid) {
			case THRUSTMASTER_USAGE_FF:
				if (field->report_count < 2) {
					dev_warn(&hid->dev, "ignoring FF field "
						"with report_count < 2\n");
					continue;
				}

				if (field->logical_maximum ==
						field->logical_minimum) {
					dev_warn(&hid->dev, "ignoring FF field "
							"with logical_maximum "
							"== logical_minimum\n");
					continue;
				}

				if (tmff->report && tmff->report != report) {
					dev_warn(&hid->dev, "ignoring FF field "
							"in other report\n");
					continue;
				}

				if (tmff->ff_field && tmff->ff_field != field) {
					dev_warn(&hid->dev, "ignoring "
							"duplicate FF field\n");
					continue;
				}

				tmff->report = report;
				tmff->ff_field = field;

				for (i = 0; ff_bits[i] >= 0; i++)
					set_bit(ff_bits[i], input_dev->ffbit);

				break;

			default:
				dev_warn(&hid->dev, "ignoring unknown output "
						"usage %08x\n",
						field->usage[0].hid);
				continue;
			}
		}
	}

	if (!tmff->report) {
		dev_err(&hid->dev, "can't find FF field in output reports\n");
		error = -ENODEV;
		goto fail;
	}

	error = input_ff_create_memless(input_dev, tmff, tmff_play);
	if (error)
		goto fail;

	dev_info(&hid->dev, "force feedback for ThrustMaster devices by Zinx "
			"Verituse <zinx@epicsol.org>");
	return 0;

fail:
	kfree(tmff);
	return error;
}
#else
static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
{
	return 0;
}
#endif

static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret;

	ret = hid_parse(hdev);
	if (ret) {
		dev_err(&hdev->dev, "parse failed\n");
		goto err;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	if (ret) {
		dev_err(&hdev->dev, "hw start failed\n");
		goto err;
	}

	tmff_init(hdev, (void *)id->driver_data);

	return 0;
err:
	return ret;
}

static const struct hid_device_id tm_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
		.driver_data = (unsigned long)ff_rumble },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304),   /* FireStorm Dual Power 2 (and 3) */
		.driver_data = (unsigned long)ff_rumble },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323),   /* Dual Trigger 3-in-1 (PC Mode) */
		.driver_data = (unsigned long)ff_rumble },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324),   /* Dual Trigger 3-in-1 (PS3 Mode) */
		.driver_data = (unsigned long)ff_rumble },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651),	/* FGT Rumble Force Wheel */
		.driver_data = (unsigned long)ff_rumble },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654),	/* FGT Force Feedback Wheel */
		.driver_data = (unsigned long)ff_joystick },
	{ }
};
MODULE_DEVICE_TABLE(hid, tm_devices);

static struct hid_driver tm_driver = {
	.name = "thrustmaster",
	.id_table = tm_devices,
	.probe = tm_probe,
};

static int __init tm_init(void)
{
	return hid_register_driver(&tm_driver);
}

static void __exit tm_exit(void)
{
	hid_unregister_driver(&tm_driver);
}

module_init(tm_init);
module_exit(tm_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Force feedback support for various HID compliant devices by ThrustMaster:
	3	* ThrustMaster FireStorm Dual Power 2
	4	* and possibly others whose device ids haven't been added.
	5	*
	6	* Modified to support ThrustMaster devices by Zinx Verituse
	7	* on 2003-01-25 from the Logitech force feedback driver,
	8	* which is by Johann Deneux.
	9	*
	10	* Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
	11	* Copyright (c) 2002 Johann Deneux
	12	*/
	13
	14	/*
	15	* This program is free software; you can redistribute it and/or modify
	16	* it under the terms of the GNU General Public License as published by
	17	* the Free Software Foundation; either version 2 of the License, or
	18	* (at your option) any later version.
	19	*
	20	* This program is distributed in the hope that it will be useful,
	21	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	22	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	23	* GNU General Public License for more details.
	24	*
	25	* You should have received a copy of the GNU General Public License
	26	* along with this program; if not, write to the Free Software
	27	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	28	*/
	29
10e41a71	30	#include <linux/hid.h>
1da177e4	31	#include <linux/input.h>
1da177e4 LT	32	#include <linux/usb.h>
1da177e4 LT	33
10e41a71 JS	34	#include "hid-ids.h"
10e41a71 JS	35
b27c9590 DT	36	static const signed short ff_rumble[] = {
	37	FF_RUMBLE,
	38	-1
	39	};
	40
	41	static const signed short ff_joystick[] = {
	42	FF_CONSTANT,
	43	-1
	44	};
	45
0f6f4319 JK	46	#ifdef CONFIG_THRUSTMASTER_FF
	47	#include "usbhid/usbhid.h"
	48
	49	/* Usages for thrustmaster devices I know about */
	50	#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK \| 0xbb)
	51
1da177e4	52	struct tmff_device {
1da177e4	53	struct hid_report *report;
b27c9590	54	struct hid_field *ff_field;
dc76c912	55	};
1da177e4	56
dc76c912	57	/* Changes values from 0 to 0xffff into values from minimum to maximum */
10e41a71	58	static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
dc76c912 AH	59	{
dc76c912 AH	60	int ret;
1da177e4	61
dc76c912 AH	62	ret = (in * (maximum - minimum) / 0xffff) + minimum;
	63	if (ret < minimum)
	64	return minimum;
	65	if (ret > maximum)
	66	return maximum;
	67	return ret;
	68	}
1da177e4	69
b27c9590	70	/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
10e41a71	71	static inline int tmff_scale_s8(int in, int minimum, int maximum)
b27c9590 DT	72	{
	73	int ret;
	74
	75	ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
	76	if (ret < minimum)
	77	return minimum;
	78	if (ret > maximum)
	79	return maximum;
	80	return ret;
	81	}
	82
10e41a71 JS	83	static int tmff_play(struct input_dev dev, void data,
10e41a71 JS	84	struct ff_effect *effect)
dc76c912	85	{
e0712985	86	struct hid_device *hid = input_get_drvdata(dev);
dc76c912	87	struct tmff_device *tmff = data;
b27c9590 DT	88	struct hid_field *ff_field = tmff->ff_field;
b27c9590 DT	89	int x, y;
dc76c912	90	int left, right; /* Rumbling */
1da177e4	91
b27c9590 DT	92	switch (effect->type) {
b27c9590 DT	93	case FF_CONSTANT:
10e41a71	94	x = tmff_scale_s8(effect->u.ramp.start_level,
b27c9590 DT	95	ff_field->logical_minimum,
b27c9590 DT	96	ff_field->logical_maximum);
10e41a71	97	y = tmff_scale_s8(effect->u.ramp.end_level,
b27c9590 DT	98	ff_field->logical_minimum,
	99	ff_field->logical_maximum);
	100
	101	dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
	102	ff_field->value[0] = x;
	103	ff_field->value[1] = y;
	104	usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
	105	break;
	106
	107	case FF_RUMBLE:
10e41a71	108	left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
b27c9590 DT	109	ff_field->logical_minimum,
b27c9590 DT	110	ff_field->logical_maximum);
10e41a71	111	right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
b27c9590 DT	112	ff_field->logical_minimum,
	113	ff_field->logical_maximum);
	114
	115	dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
	116	ff_field->value[0] = left;
	117	ff_field->value[1] = right;
	118	usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
	119	break;
	120	}
dc76c912 AH	121	return 0;
dc76c912 AH	122	}
1da177e4	123
10e41a71	124	static int tmff_init(struct hid_device hid, const signed short ff_bits)
1da177e4	125	{
dc76c912	126	struct tmff_device *tmff;
3ba5619f LZ	127	struct hid_report *report;
3ba5619f LZ	128	struct list_head *report_list;
10e41a71 JS	129	struct hid_input *hidinput = list_entry(hid->inputs.next,
10e41a71 JS	130	struct hid_input, list);
c5b7c7c3	131	struct input_dev *input_dev = hidinput->input;
dc76c912	132	int error;
b27c9590	133	int i;
1da177e4	134
dc76c912 AH	135	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
dc76c912 AH	136	if (!tmff)
1da177e4 LT	137	return -ENOMEM;
1da177e4 LT	138
1da177e4	139	/* Find the report to use */
3ba5619f LZ	140	report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
3ba5619f LZ	141	list_for_each_entry(report, report_list, list) {
1da177e4 LT	142	int fieldnum;
	143
	144	for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
	145	struct hid_field *field = report->field[fieldnum];
	146
	147	if (field->maxusage <= 0)
	148	continue;
	149
	150	switch (field->usage[0].hid) {
b27c9590 DT	151	case THRUSTMASTER_USAGE_FF:
b27c9590 DT	152	if (field->report_count < 2) {
79575019 JS	153	dev_warn(&hid->dev, "ignoring FF field "
79575019 JS	154	"with report_count < 2\n");
b27c9590 DT	155	continue;
b27c9590 DT	156	}
1da177e4	157
10e41a71 JS	158	if (field->logical_maximum ==
10e41a71 JS	159	field->logical_minimum) {
79575019 JS	160	dev_warn(&hid->dev, "ignoring FF field "
	161	"with logical_maximum "
	162	"== logical_minimum\n");
b27c9590 DT	163	continue;
b27c9590 DT	164	}
1da177e4	165
b27c9590	166	if (tmff->report && tmff->report != report) {
79575019 JS	167	dev_warn(&hid->dev, "ignoring FF field "
79575019 JS	168	"in other report\n");
b27c9590 DT	169	continue;
b27c9590 DT	170	}
1da177e4	171
b27c9590	172	if (tmff->ff_field && tmff->ff_field != field) {
79575019 JS	173	dev_warn(&hid->dev, "ignoring "
79575019 JS	174	"duplicate FF field\n");
b27c9590 DT	175	continue;
	176	}
	177
	178	tmff->report = report;
	179	tmff->ff_field = field;
	180
b27c9590 DT	181	for (i = 0; ff_bits[i] >= 0; i++)
b27c9590 DT	182	set_bit(ff_bits[i], input_dev->ffbit);
1da177e4	183
b27c9590	184	break;
1da177e4	185
b27c9590	186	default:
79575019 JS	187	dev_warn(&hid->dev, "ignoring unknown output "
79575019 JS	188	"usage %08x\n",
10e41a71	189	field->usage[0].hid);
b27c9590	190	continue;
1da177e4	191	}
1da177e4 LT	192	}
	193	}
	194
b27c9590	195	if (!tmff->report) {
79575019	196	dev_err(&hid->dev, "can't find FF field in output reports\n");
b27c9590 DT	197	error = -ENODEV;
b27c9590 DT	198	goto fail;
1da177e4 LT	199	}
1da177e4 LT	200
10e41a71	201	error = input_ff_create_memless(input_dev, tmff, tmff_play);
b27c9590 DT	202	if (error)
b27c9590 DT	203	goto fail;
1da177e4	204
79575019 JS	205	dev_info(&hid->dev, "force feedback for ThrustMaster devices by Zinx "
79575019 JS	206	"Verituse <zinx@epicsol.org>");
1da177e4	207	return 0;
b27c9590	208
10e41a71	209	fail:
b27c9590 DT	210	kfree(tmff);
b27c9590 DT	211	return error;
1da177e4	212	}
0f6f4319 JK	213	#else
	214	static inline int tmff_init(struct hid_device hid, const signed short ff_bits)
	215	{
	216	return 0;
	217	}
	218	#endif
1da177e4	219
10e41a71 JS	220	static int tm_probe(struct hid_device hdev, const struct hid_device_id id)
	221	{
	222	int ret;
	223
	224	ret = hid_parse(hdev);
	225	if (ret) {
	226	dev_err(&hdev->dev, "parse failed\n");
	227	goto err;
	228	}
	229
	230	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	231	if (ret) {
	232	dev_err(&hdev->dev, "hw start failed\n");
	233	goto err;
	234	}
	235
	236	tmff_init(hdev, (void *)id->driver_data);
	237
	238	return 0;
	239	err:
	240	return ret;
	241	}
	242
	243	static const struct hid_device_id tm_devices[] = {
	244	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
	245	.driver_data = (unsigned long)ff_rumble },
7a84b133 RAG	246	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */
	247	.driver_data = (unsigned long)ff_rumble },
	248	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */
	249	.driver_data = (unsigned long)ff_rumble },
	250	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */
10e41a71 JS	251	.driver_data = (unsigned long)ff_rumble },
	252	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
	253	.driver_data = (unsigned long)ff_rumble },
	254	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
	255	.driver_data = (unsigned long)ff_joystick },
	256	{ }
	257	};
	258	MODULE_DEVICE_TABLE(hid, tm_devices);
	259
	260	static struct hid_driver tm_driver = {
	261	.name = "thrustmaster",
	262	.id_table = tm_devices,
	263	.probe = tm_probe,
	264	};
	265
a24f423b	266	static int __init tm_init(void)
10e41a71 JS	267	{
	268	return hid_register_driver(&tm_driver);
	269	}
	270
a24f423b	271	static void __exit tm_exit(void)
10e41a71 JS	272	{
	273	hid_unregister_driver(&tm_driver);
	274	}
	275
	276	module_init(tm_init);
	277	module_exit(tm_exit);
	278	MODULE_LICENSE("GPL");