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

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * 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 <[email protected]>
 *  Copyright (c) 2002 Johann Deneux
 */

/*
 */

#include <linux/hid.h>
#include <linux/input.h>
#include <linux/slab.h>
#include <linux/module.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

/* 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;
		hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
		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;
		hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
		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) {
					hid_warn(hid, "ignoring FF field with report_count < 2\n");
					continue;
				}

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

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

				if (tmff->ff_field && tmff->ff_field != field) {
					hid_warn(hid, "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:
				hid_warn(hid, "ignoring unknown output usage %08x\n",
					 field->usage[0].hid);
				continue;
			}
		}
	}

	if (!tmff->report) {
		hid_err(hid, "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;

	hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <[email protected]>\n");
	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) {
		hid_err(hdev, "parse failed\n");
		goto err;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	if (ret) {
		hid_err(hdev, "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, 0xb605),   /* NASCAR PRO FF2 Wheel */
		.driver_data = (unsigned long)ff_joystick },
	{ 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, 0xb653),	/* RGT Force Feedback CLUTCH Raging Wheel */
		.driver_data = (unsigned long)ff_joystick },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654),	/* FGT Force Feedback Wheel */
		.driver_data = (unsigned long)ff_joystick },
	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a),	/* F430 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,
};
module_hid_driver(tm_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
	3	* Force feedback support for various HID compliant devices by ThrustMaster:
	4	* ThrustMaster FireStorm Dual Power 2
	5	* and possibly others whose device ids haven't been added.
	6	*
	7	* Modified to support ThrustMaster devices by Zinx Verituse
	8	* on 2003-01-25 from the Logitech force feedback driver,
	9	* which is by Johann Deneux.
	10	*
	11	* Copyright (c) 2003 Zinx Verituse <[email protected]>
	12	* Copyright (c) 2002 Johann Deneux
	13	*/
	14
	15	/*
1da177e4 LT	16	*/
1da177e4 LT	17
10e41a71	18	#include <linux/hid.h>
1da177e4	19	#include <linux/input.h>
5a0e3ad6	20	#include <linux/slab.h>
8f86a2c3	21	#include <linux/module.h>
1da177e4	22
10e41a71 JS	23	#include "hid-ids.h"
10e41a71 JS	24
b27c9590 DT	25	static const signed short ff_rumble[] = {
	26	FF_RUMBLE,
	27	-1
	28	};
	29
	30	static const signed short ff_joystick[] = {
	31	FF_CONSTANT,
	32	-1
	33	};
	34
0f6f4319	35	#ifdef CONFIG_THRUSTMASTER_FF
0f6f4319 JK	36
	37	/* Usages for thrustmaster devices I know about */
	38	#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK \| 0xbb)
	39
1da177e4	40	struct tmff_device {
1da177e4	41	struct hid_report *report;
b27c9590	42	struct hid_field *ff_field;
dc76c912	43	};
1da177e4	44
dc76c912	45	/* Changes values from 0 to 0xffff into values from minimum to maximum */
10e41a71	46	static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
dc76c912 AH	47	{
dc76c912 AH	48	int ret;
1da177e4	49
dc76c912 AH	50	ret = (in * (maximum - minimum) / 0xffff) + minimum;
	51	if (ret < minimum)
	52	return minimum;
	53	if (ret > maximum)
	54	return maximum;
	55	return ret;
	56	}
1da177e4	57
b27c9590	58	/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
10e41a71	59	static inline int tmff_scale_s8(int in, int minimum, int maximum)
b27c9590 DT	60	{
	61	int ret;
	62
	63	ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
	64	if (ret < minimum)
	65	return minimum;
	66	if (ret > maximum)
	67	return maximum;
	68	return ret;
	69	}
	70
10e41a71 JS	71	static int tmff_play(struct input_dev dev, void data,
10e41a71 JS	72	struct ff_effect *effect)
dc76c912	73	{
e0712985	74	struct hid_device *hid = input_get_drvdata(dev);
dc76c912	75	struct tmff_device *tmff = data;
b27c9590 DT	76	struct hid_field *ff_field = tmff->ff_field;
b27c9590 DT	77	int x, y;
dc76c912	78	int left, right; /* Rumbling */
1da177e4	79
b27c9590 DT	80	switch (effect->type) {
b27c9590 DT	81	case FF_CONSTANT:
10e41a71	82	x = tmff_scale_s8(effect->u.ramp.start_level,
b27c9590 DT	83	ff_field->logical_minimum,
b27c9590 DT	84	ff_field->logical_maximum);
10e41a71	85	y = tmff_scale_s8(effect->u.ramp.end_level,
b27c9590 DT	86	ff_field->logical_minimum,
	87	ff_field->logical_maximum);
	88
	89	dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
	90	ff_field->value[0] = x;
	91	ff_field->value[1] = y;
d8814272	92	hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
b27c9590 DT	93	break;
	94
	95	case FF_RUMBLE:
10e41a71	96	left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
b27c9590 DT	97	ff_field->logical_minimum,
b27c9590 DT	98	ff_field->logical_maximum);
10e41a71	99	right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
b27c9590 DT	100	ff_field->logical_minimum,
	101	ff_field->logical_maximum);
	102
	103	dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
	104	ff_field->value[0] = left;
	105	ff_field->value[1] = right;
d8814272	106	hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
b27c9590 DT	107	break;
b27c9590 DT	108	}
dc76c912 AH	109	return 0;
dc76c912 AH	110	}
1da177e4	111
10e41a71	112	static int tmff_init(struct hid_device hid, const signed short ff_bits)
1da177e4	113	{
dc76c912	114	struct tmff_device *tmff;
3ba5619f LZ	115	struct hid_report *report;
3ba5619f LZ	116	struct list_head *report_list;
10e41a71 JS	117	struct hid_input *hidinput = list_entry(hid->inputs.next,
10e41a71 JS	118	struct hid_input, list);
c5b7c7c3	119	struct input_dev *input_dev = hidinput->input;
dc76c912	120	int error;
b27c9590	121	int i;
1da177e4	122
dc76c912 AH	123	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
dc76c912 AH	124	if (!tmff)
1da177e4 LT	125	return -ENOMEM;
1da177e4 LT	126
1da177e4	127	/* Find the report to use */
3ba5619f LZ	128	report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
3ba5619f LZ	129	list_for_each_entry(report, report_list, list) {
1da177e4 LT	130	int fieldnum;
	131
	132	for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
	133	struct hid_field *field = report->field[fieldnum];
	134
	135	if (field->maxusage <= 0)
	136	continue;
	137
	138	switch (field->usage[0].hid) {
b27c9590 DT	139	case THRUSTMASTER_USAGE_FF:
b27c9590 DT	140	if (field->report_count < 2) {
4291ee30	141	hid_warn(hid, "ignoring FF field with report_count < 2\n");
b27c9590 DT	142	continue;
b27c9590 DT	143	}
1da177e4	144
10e41a71 JS	145	if (field->logical_maximum ==
10e41a71 JS	146	field->logical_minimum) {
4291ee30	147	hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
b27c9590 DT	148	continue;
b27c9590 DT	149	}
1da177e4	150
b27c9590	151	if (tmff->report && tmff->report != report) {
4291ee30	152	hid_warn(hid, "ignoring FF field in other report\n");
b27c9590 DT	153	continue;
b27c9590 DT	154	}
1da177e4	155
b27c9590	156	if (tmff->ff_field && tmff->ff_field != field) {
4291ee30	157	hid_warn(hid, "ignoring duplicate FF field\n");
b27c9590 DT	158	continue;
	159	}
	160
	161	tmff->report = report;
	162	tmff->ff_field = field;
	163
b27c9590 DT	164	for (i = 0; ff_bits[i] >= 0; i++)
b27c9590 DT	165	set_bit(ff_bits[i], input_dev->ffbit);
1da177e4	166
b27c9590	167	break;
1da177e4	168
b27c9590	169	default:
4291ee30 JP	170	hid_warn(hid, "ignoring unknown output usage %08x\n",
4291ee30 JP	171	field->usage[0].hid);
b27c9590	172	continue;
1da177e4	173	}
1da177e4 LT	174	}
	175	}
	176
b27c9590	177	if (!tmff->report) {
4291ee30	178	hid_err(hid, "can't find FF field in output reports\n");
b27c9590 DT	179	error = -ENODEV;
b27c9590 DT	180	goto fail;
1da177e4 LT	181	}
1da177e4 LT	182
10e41a71	183	error = input_ff_create_memless(input_dev, tmff, tmff_play);
b27c9590 DT	184	if (error)
b27c9590 DT	185	goto fail;
1da177e4	186
4291ee30	187	hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <[email protected]>\n");
1da177e4	188	return 0;
b27c9590	189
10e41a71	190	fail:
b27c9590 DT	191	kfree(tmff);
b27c9590 DT	192	return error;
1da177e4	193	}
0f6f4319 JK	194	#else
	195	static inline int tmff_init(struct hid_device hid, const signed short ff_bits)
	196	{
	197	return 0;
	198	}
	199	#endif
1da177e4	200
10e41a71 JS	201	static int tm_probe(struct hid_device hdev, const struct hid_device_id id)
	202	{
	203	int ret;
	204
	205	ret = hid_parse(hdev);
	206	if (ret) {
4291ee30	207	hid_err(hdev, "parse failed\n");
10e41a71 JS	208	goto err;
	209	}
	210
	211	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	212	if (ret) {
4291ee30	213	hid_err(hdev, "hw start failed\n");
10e41a71 JS	214	goto err;
	215	}
	216
	217	tmff_init(hdev, (void *)id->driver_data);
	218
	219	return 0;
	220	err:
	221	return ret;
	222	}
	223
	224	static const struct hid_device_id tm_devices[] = {
	225	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
	226	.driver_data = (unsigned long)ff_rumble },
7a84b133 RAG	227	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */
	228	.driver_data = (unsigned long)ff_rumble },
	229	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */
	230	.driver_data = (unsigned long)ff_rumble },
	231	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */
10e41a71	232	.driver_data = (unsigned long)ff_rumble },
1477edb4 VC	233	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */
1477edb4 VC	234	.driver_data = (unsigned long)ff_joystick },
10e41a71 JS	235	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
10e41a71 JS	236	.driver_data = (unsigned long)ff_rumble },
3ee8f0a2 MR	237	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */
3ee8f0a2 MR	238	.driver_data = (unsigned long)ff_joystick },
10e41a71 JS	239	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
10e41a71 JS	240	.driver_data = (unsigned long)ff_joystick },
d65c3768 SW	241	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */
d65c3768 SW	242	.driver_data = (unsigned long)ff_joystick },
10e41a71 JS	243	{ }
	244	};
	245	MODULE_DEVICE_TABLE(hid, tm_devices);
	246
	247	static struct hid_driver tm_driver = {
	248	.name = "thrustmaster",
	249	.id_table = tm_devices,
	250	.probe = tm_probe,
	251	};
f425458e	252	module_hid_driver(tm_driver);
10e41a71	253
10e41a71	254	MODULE_LICENSE("GPL");