[mirror_ubuntu-hirsute-kernel.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 <zinx@epicsol.org>
 *  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"

#define THRUSTMASTER_DEVICE_ID_2_IN_1_DT	0xb320

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 */
	int motor_swap;

	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);

		/* 2-in-1 strong motor is left */
		if (hid->product == THRUSTMASTER_DEVICE_ID_2_IN_1_DT) {
			motor_swap = left;
			left = right;
			right = motor_swap;
		}

		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;
	struct input_dev *input_dev;
	int error;
	int i;

	if (list_empty(&hid->inputs)) {
		hid_err(hid, "no inputs found\n");
		return -ENODEV;
	}
	hidinput = list_entry(hid->inputs.next, struct hid_input, list);
	input_dev = hidinput->input;

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