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

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Force feedback support for hid-compliant for some of the devices from
 * Logitech, namely:
 * - WingMan Cordless RumblePad
 * - WingMan Force 3D
 *
 *  Copyright (c) 2002-2004 Johann Deneux
 *  Copyright (c) 2006 Anssi Hannula <[email protected]>
 */

/*
 *
 * Should you need to contact me, the author, you can do so by
 * e-mail - mail your message to <[email protected]>
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

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

#include "hid-lg.h"

struct dev_type {
	u16 idVendor;
	u16 idProduct;
	const signed short *ff;
};

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

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

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

static const struct dev_type devices[] = {
	{ 0x046d, 0xc211, ff_rumble },
	{ 0x046d, 0xc219, ff_rumble },
	{ 0x046d, 0xc283, ff_joystick },
	{ 0x046d, 0xc286, ff_joystick_ac },
	{ 0x046d, 0xc287, ff_joystick_ac },
	{ 0x046d, 0xc293, ff_joystick },
	{ 0x046d, 0xc295, ff_joystick },
};

static int hid_lgff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	int x, y;
	unsigned int left, right;

#define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff

	switch (effect->type) {
	case FF_CONSTANT:
		x = effect->u.ramp.start_level + 0x7f;	/* 0x7f is center */
		y = effect->u.ramp.end_level + 0x7f;
		CLAMP(x);
		CLAMP(y);
		report->field[0]->value[0] = 0x51;
		report->field[0]->value[1] = 0x08;
		report->field[0]->value[2] = x;
		report->field[0]->value[3] = y;
		dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
		hid_hw_request(hid, report, HID_REQ_SET_REPORT);
		break;

	case FF_RUMBLE:
		right = effect->u.rumble.strong_magnitude;
		left = effect->u.rumble.weak_magnitude;
		right = right * 0xff / 0xffff;
		left = left * 0xff / 0xffff;
		CLAMP(left);
		CLAMP(right);
		report->field[0]->value[0] = 0x42;
		report->field[0]->value[1] = 0x00;
		report->field[0]->value[2] = left;
		report->field[0]->value[3] = right;
		dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
		hid_hw_request(hid, report, HID_REQ_SET_REPORT);
		break;
	}
	return 0;
}

static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	__s32 *value = report->field[0]->value;
	magnitude = (magnitude >> 12) & 0xf;
	*value++ = 0xfe;
	*value++ = 0x0d;
	*value++ = magnitude;   /* clockwise strength */
	*value++ = magnitude;   /* counter-clockwise strength */
	*value++ = 0x80;
	*value++ = 0x00;
	*value = 0x00;
	hid_hw_request(hid, report, HID_REQ_SET_REPORT);
}

int lgff_init(struct hid_device* hid)
{
	struct hid_input *hidinput;
	struct input_dev *dev;
	const signed short *ff_bits = ff_joystick;
	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);
	dev = hidinput->input;

	/* Check that the report looks ok */
	if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 7))
		return -ENODEV;

	for (i = 0; i < ARRAY_SIZE(devices); i++) {
		if (dev->id.vendor == devices[i].idVendor &&
		    dev->id.product == devices[i].idProduct) {
			ff_bits = devices[i].ff;
			break;
		}
	}

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

	error = input_ff_create_memless(dev, NULL, hid_lgff_play);
	if (error)
		return error;

	if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
		dev->ff->set_autocenter = hid_lgff_set_autocenter;

	pr_info("Force feedback for Logitech force feedback devices by Johann Deneux <[email protected]>\n");

	return 0;
}
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4	2	/*
1da177e4 LT	3	* Force feedback support for hid-compliant for some of the devices from
	4	* Logitech, namely:
	5	* - WingMan Cordless RumblePad
	6	* - WingMan Force 3D
	7	*
	8	* Copyright (c) 2002-2004 Johann Deneux
dc76c912	9	* Copyright (c) 2006 Anssi Hannula <[email protected]>
1da177e4 LT	10	*/
	11
	12	/*
1da177e4 LT	13	*
	14	* Should you need to contact me, the author, you can do so by
	15	* e-mail - mail your message to <[email protected]>
	16	*/
	17
4291ee30 JP	18	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
4291ee30 JP	19
1da177e4	20	#include <linux/input.h>
dde5845a	21	#include <linux/hid.h>
606bd0a8	22
606bd0a8	23	#include "hid-lg.h"
1da177e4	24
f9f852df	25	struct dev_type {
1da177e4 LT	26	u16 idVendor;
1da177e4 LT	27	u16 idProduct;
dc76c912	28	const signed short *ff;
1da177e4 LT	29	};
1da177e4 LT	30
dc76c912	31	static const signed short ff_rumble[] = {
1da177e4 LT	32	FF_RUMBLE,
	33	-1
	34	};
	35
dc76c912	36	static const signed short ff_joystick[] = {
1da177e4 LT	37	FF_CONSTANT,
	38	-1
	39	};
	40
f0bca459 SB	41	static const signed short ff_joystick_ac[] = {
	42	FF_CONSTANT,
	43	FF_AUTOCENTER,
	44	-1
	45	};
	46
f9f852df	47	static const struct dev_type devices[] = {
dc76c912 AH	48	{ 0x046d, 0xc211, ff_rumble },
	49	{ 0x046d, 0xc219, ff_rumble },
	50	{ 0x046d, 0xc283, ff_joystick },
f0bca459	51	{ 0x046d, 0xc286, ff_joystick_ac },
74f292ca	52	{ 0x046d, 0xc287, ff_joystick_ac },
fd30ea8c	53	{ 0x046d, 0xc293, ff_joystick },
130b1ab3	54	{ 0x046d, 0xc295, ff_joystick },
1da177e4 LT	55	};
1da177e4 LT	56
dc76c912 AH	57	static int hid_lgff_play(struct input_dev dev, void data, struct ff_effect *effect)
dc76c912 AH	58	{
e0712985	59	struct hid_device *hid = input_get_drvdata(dev);
dc76c912 AH	60	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	61	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	62	int x, y;
	63	unsigned int left, right;
	64
	65	#define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
	66
	67	switch (effect->type) {
	68	case FF_CONSTANT:
	69	x = effect->u.ramp.start_level + 0x7f; /* 0x7f is center */
	70	y = effect->u.ramp.end_level + 0x7f;
	71	CLAMP(x);
	72	CLAMP(y);
	73	report->field[0]->value[0] = 0x51;
	74	report->field[0]->value[1] = 0x08;
	75	report->field[0]->value[2] = x;
	76	report->field[0]->value[3] = y;
58037eb9	77	dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
d8814272	78	hid_hw_request(hid, report, HID_REQ_SET_REPORT);
dc76c912 AH	79	break;
	80
	81	case FF_RUMBLE:
	82	right = effect->u.rumble.strong_magnitude;
	83	left = effect->u.rumble.weak_magnitude;
	84	right = right * 0xff / 0xffff;
	85	left = left * 0xff / 0xffff;
	86	CLAMP(left);
	87	CLAMP(right);
	88	report->field[0]->value[0] = 0x42;
	89	report->field[0]->value[1] = 0x00;
	90	report->field[0]->value[2] = left;
	91	report->field[0]->value[3] = right;
58037eb9	92	dbg_hid("(left, right)=(%04x, %04x)\n", left, right);
d8814272	93	hid_hw_request(hid, report, HID_REQ_SET_REPORT);
dc76c912 AH	94	break;
	95	}
	96	return 0;
	97	}
	98
2bea94db SB	99	static void hid_lgff_set_autocenter(struct input_dev *dev, u16 magnitude)
	100	{
	101	struct hid_device *hid = input_get_drvdata(dev);
	102	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	103	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	104	__s32 *value = report->field[0]->value;
	105	magnitude = (magnitude >> 12) & 0xf;
	106	*value++ = 0xfe;
	107	*value++ = 0x0d;
	108	value++ = magnitude; / clockwise strength */
	109	value++ = magnitude; / counter-clockwise strength */
	110	*value++ = 0x80;
	111	*value++ = 0x00;
	112	*value = 0x00;
d8814272	113	hid_hw_request(hid, report, HID_REQ_SET_REPORT);
2bea94db SB	114	}
2bea94db SB	115
606bd0a8	116	int lgff_init(struct hid_device* hid)
1da177e4	117	{
d9d4b1e4 AS	118	struct hid_input *hidinput;
d9d4b1e4 AS	119	struct input_dev *dev;
00a8691c	120	const signed short *ff_bits = ff_joystick;
dc76c912	121	int error;
00a8691c	122	int i;
1da177e4	123
d9d4b1e4 AS	124	if (list_empty(&hid->inputs)) {
	125	hid_err(hid, "no inputs found\n");
	126	return -ENODEV;
	127	}
	128	hidinput = list_entry(hid->inputs.next, struct hid_input, list);
	129	dev = hidinput->input;
	130
1da177e4	131	/* Check that the report looks ok */
0fb6bd06 KC	132	if (!hid_validate_values(hid, HID_OUTPUT_REPORT, 0, 0, 7))
0fb6bd06 KC	133	return -ENODEV;
1da177e4	134
dc76c912 AH	135	for (i = 0; i < ARRAY_SIZE(devices); i++) {
	136	if (dev->id.vendor == devices[i].idVendor &&
	137	dev->id.product == devices[i].idProduct) {
00a8691c	138	ff_bits = devices[i].ff;
dc76c912	139	break;
1da177e4	140	}
1da177e4	141	}
1da177e4	142
00a8691c DT	143	for (i = 0; ff_bits[i] >= 0; i++)
	144	set_bit(ff_bits[i], dev->ffbit);
	145
dc76c912 AH	146	error = input_ff_create_memless(dev, NULL, hid_lgff_play);
	147	if (error)
	148	return error;
1da177e4	149
2bea94db SB	150	if ( test_bit(FF_AUTOCENTER, dev->ffbit) )
	151	dev->ff->set_autocenter = hid_lgff_set_autocenter;
	152
4291ee30	153	pr_info("Force feedback for Logitech force feedback devices by Johann Deneux <[email protected]>\n");
1da177e4	154
1da177e4 LT	155	return 0;
1da177e4 LT	156	}