[linux-block.git] / drivers / hid / hid-axff.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Force feedback support for ACRUX game controllers
 *
 * From what I have gathered, these devices are mass produced in China
 * by several vendors. They often share the same design as the original
 * Xbox 360 controller.
 *
 * 1a34:0802 "ACRUX USB GAMEPAD 8116"
 *  - tested with an EXEQ EQ-PCU-02090 game controller.
 *
 * Copyright (c) 2010 Sergei Kolzun <x0r@dv-life.ru>
 */

/*
 */

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

#include "hid-ids.h"

#ifdef CONFIG_HID_ACRUX_FF

struct axff_device {
	struct hid_report *report;
};

static int axff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct axff_device *axff = data;
	struct hid_report *report = axff->report;
	int field_count = 0;
	int left, right;
	int i, j;

	left = effect->u.rumble.strong_magnitude;
	right = effect->u.rumble.weak_magnitude;

	dbg_hid("called with 0x%04x 0x%04x", left, right);

	left = left * 0xff / 0xffff;
	right = right * 0xff / 0xffff;

	for (i = 0; i < report->maxfield; i++) {
		for (j = 0; j < report->field[i]->report_count; j++) {
			report->field[i]->value[j] =
				field_count % 2 ? right : left;
			field_count++;
		}
	}

	dbg_hid("running with 0x%02x 0x%02x", left, right);
	hid_hw_request(hid, axff->report, HID_REQ_SET_REPORT);

	return 0;
}

static int axff_init(struct hid_device *hid)
{
	struct axff_device *axff;
	struct hid_report *report;
	struct hid_input *hidinput;
	struct list_head *report_list =&hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct input_dev *dev;
	int field_count = 0;
	int i, j;
	int error;

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

	if (list_empty(report_list)) {
		hid_err(hid, "no output reports found\n");
		return -ENODEV;
	}

	report = list_first_entry(report_list, struct hid_report, list);
	for (i = 0; i < report->maxfield; i++) {
		for (j = 0; j < report->field[i]->report_count; j++) {
			report->field[i]->value[j] = 0x00;
			field_count++;
		}
	}

	if (field_count < 4 && hid->product != 0xf705) {
		hid_err(hid, "not enough fields in the report: %d\n",
			field_count);
		return -ENODEV;
	}

	axff = kzalloc(sizeof(struct axff_device), GFP_KERNEL);
	if (!axff)
		return -ENOMEM;

	set_bit(FF_RUMBLE, dev->ffbit);

	error = input_ff_create_memless(dev, axff, axff_play);
	if (error)
		goto err_free_mem;

	axff->report = report;
	hid_hw_request(hid, axff->report, HID_REQ_SET_REPORT);

	hid_info(hid, "Force Feedback for ACRUX game controllers by Sergei Kolzun <x0r@dv-life.ru>\n");

	return 0;

err_free_mem:
	kfree(axff);
	return error;
}
#else
static inline int axff_init(struct hid_device *hid)
{
	return 0;
}
#endif

static int ax_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int error;

	dev_dbg(&hdev->dev, "ACRUX HID hardware probe...\n");

	error = hid_parse(hdev);
	if (error) {
		hid_err(hdev, "parse failed\n");
		return error;
	}

	error = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	if (error) {
		hid_err(hdev, "hw start failed\n");
		return error;
	}

	error = axff_init(hdev);
	if (error) {
		/*
		 * Do not fail device initialization completely as device
		 * may still be partially operable, just warn.
		 */
		hid_warn(hdev,
			 "Failed to enable force feedback support, error: %d\n",
			 error);
	}

	/*
	 * We need to start polling device right away, otherwise
	 * it will go into a coma.
	 */
	error = hid_hw_open(hdev);
	if (error) {
		dev_err(&hdev->dev, "hw open failed\n");
		hid_hw_stop(hdev);
		return error;
	}

	return 0;
}

static void ax_remove(struct hid_device *hdev)
{
	hid_hw_close(hdev);
	hid_hw_stop(hdev);
}

static const struct hid_device_id ax_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_ACRUX, 0x0802), },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ACRUX, 0xf705), },
	{ }
};
MODULE_DEVICE_TABLE(hid, ax_devices);

static struct hid_driver ax_driver = {
	.name		= "acrux",
	.id_table	= ax_devices,
	.probe		= ax_probe,
	.remove		= ax_remove,
};
module_hid_driver(ax_driver);

MODULE_AUTHOR("Sergei Kolzun");
MODULE_DESCRIPTION("Force feedback support for ACRUX game controllers");
MODULE_LICENSE("GPL");
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
c0dbcc33 SK	2	/*
	3	* Force feedback support for ACRUX game controllers
	4	*
	5	* From what I have gathered, these devices are mass produced in China
	6	* by several vendors. They often share the same design as the original
	7	* Xbox 360 controller.
	8	*
	9	* 1a34:0802 "ACRUX USB GAMEPAD 8116"
b55ebc27	10	* - tested with an EXEQ EQ-PCU-02090 game controller.
c0dbcc33 SK	11	*
	12	* Copyright (c) 2010 Sergei Kolzun <x0r@dv-life.ru>
	13	*/
	14
	15	/*
c0dbcc33 SK	16	*/
	17
	18	#include <linux/input.h>
	19	#include <linux/slab.h>
c0dbcc33	20	#include <linux/hid.h>
8f86a2c3	21	#include <linux/module.h>
c0dbcc33 SK	22
c0dbcc33 SK	23	#include "hid-ids.h"
0ae43810 DT	24
0ae43810 DT	25	#ifdef CONFIG_HID_ACRUX_FF
c0dbcc33 SK	26
	27	struct axff_device {
	28	struct hid_report *report;
	29	};
	30
	31	static int axff_play(struct input_dev dev, void data, struct ff_effect *effect)
	32	{
	33	struct hid_device *hid = input_get_drvdata(dev);
	34	struct axff_device *axff = data;
b55ebc27 SK	35	struct hid_report *report = axff->report;
b55ebc27 SK	36	int field_count = 0;
c0dbcc33	37	int left, right;
b55ebc27	38	int i, j;
c0dbcc33 SK	39
	40	left = effect->u.rumble.strong_magnitude;
	41	right = effect->u.rumble.weak_magnitude;
	42
	43	dbg_hid("called with 0x%04x 0x%04x", left, right);
	44
	45	left = left * 0xff / 0xffff;
	46	right = right * 0xff / 0xffff;
	47
b55ebc27 SK	48	for (i = 0; i < report->maxfield; i++) {
	49	for (j = 0; j < report->field[i]->report_count; j++) {
	50	report->field[i]->value[j] =
	51	field_count % 2 ? right : left;
	52	field_count++;
	53	}
	54	}
	55
c0dbcc33	56	dbg_hid("running with 0x%02x 0x%02x", left, right);
d8814272	57	hid_hw_request(hid, axff->report, HID_REQ_SET_REPORT);
c0dbcc33 SK	58
	59	return 0;
	60	}
	61
	62	static int axff_init(struct hid_device *hid)
	63	{
	64	struct axff_device *axff;
	65	struct hid_report *report;
d9d4b1e4	66	struct hid_input *hidinput;
c0dbcc33	67	struct list_head *report_list =&hid->report_enum[HID_OUTPUT_REPORT].report_list;
d9d4b1e4	68	struct input_dev *dev;
b55ebc27 SK	69	int field_count = 0;
b55ebc27 SK	70	int i, j;
c0dbcc33 SK	71	int error;
c0dbcc33 SK	72
d9d4b1e4 AS	73	if (list_empty(&hid->inputs)) {
	74	hid_err(hid, "no inputs found\n");
	75	return -ENODEV;
	76	}
	77	hidinput = list_first_entry(&hid->inputs, struct hid_input, list);
	78	dev = hidinput->input;
	79
c0dbcc33	80	if (list_empty(report_list)) {
4291ee30	81	hid_err(hid, "no output reports found\n");
c0dbcc33 SK	82	return -ENODEV;
	83	}
	84
	85	report = list_first_entry(report_list, struct hid_report, list);
b55ebc27 SK	86	for (i = 0; i < report->maxfield; i++) {
	87	for (j = 0; j < report->field[i]->report_count; j++) {
	88	report->field[i]->value[j] = 0x00;
	89	field_count++;
	90	}
	91	}
c0dbcc33	92
e17f5d76	93	if (field_count < 4 && hid->product != 0xf705) {
b55ebc27 SK	94	hid_err(hid, "not enough fields in the report: %d\n",
b55ebc27 SK	95	field_count);
c0dbcc33 SK	96	return -ENODEV;
	97	}
	98
	99	axff = kzalloc(sizeof(struct axff_device), GFP_KERNEL);
	100	if (!axff)
	101	return -ENOMEM;
	102
	103	set_bit(FF_RUMBLE, dev->ffbit);
	104
	105	error = input_ff_create_memless(dev, axff, axff_play);
	106	if (error)
	107	goto err_free_mem;
	108
	109	axff->report = report;
d8814272	110	hid_hw_request(hid, axff->report, HID_REQ_SET_REPORT);
c0dbcc33	111
b55ebc27	112	hid_info(hid, "Force Feedback for ACRUX game controllers by Sergei Kolzun <x0r@dv-life.ru>\n");
c0dbcc33 SK	113
	114	return 0;
	115
	116	err_free_mem:
	117	kfree(axff);
	118	return error;
	119	}
0ae43810 DT	120	#else
	121	static inline int axff_init(struct hid_device *hid)
	122	{
	123	return 0;
	124	}
	125	#endif
c0dbcc33 SK	126
	127	static int ax_probe(struct hid_device hdev, const struct hid_device_id id)
	128	{
	129	int error;
	130
4291ee30	131	dev_dbg(&hdev->dev, "ACRUX HID hardware probe...\n");
c0dbcc33 SK	132
	133	error = hid_parse(hdev);
	134	if (error) {
4291ee30	135	hid_err(hdev, "parse failed\n");
c0dbcc33 SK	136	return error;
	137	}
	138
	139	error = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	140	if (error) {
4291ee30	141	hid_err(hdev, "hw start failed\n");
c0dbcc33 SK	142	return error;
	143	}
	144
	145	error = axff_init(hdev);
	146	if (error) {
	147	/*
	148	* Do not fail device initialization completely as device
	149	* may still be partially operable, just warn.
	150	*/
4291ee30	151	hid_warn(hdev,
c0dbcc33 SK	152	"Failed to enable force feedback support, error: %d\n",
	153	error);
	154	}
	155
0ae43810 DT	156	/*
	157	* We need to start polling device right away, otherwise
	158	* it will go into a coma.
	159	*/
	160	error = hid_hw_open(hdev);
	161	if (error) {
	162	dev_err(&hdev->dev, "hw open failed\n");
b30d89d1	163	hid_hw_stop(hdev);
0ae43810 DT	164	return error;
	165	}
	166
c0dbcc33 SK	167	return 0;
	168	}
	169
0ae43810 DT	170	static void ax_remove(struct hid_device *hdev)
	171	{
	172	hid_hw_close(hdev);
	173	hid_hw_stop(hdev);
	174	}
	175
c0dbcc33 SK	176	static const struct hid_device_id ax_devices[] = {
c0dbcc33 SK	177	{ HID_USB_DEVICE(USB_VENDOR_ID_ACRUX, 0x0802), },
e17f5d76	178	{ HID_USB_DEVICE(USB_VENDOR_ID_ACRUX, 0xf705), },
c0dbcc33 SK	179	{ }
	180	};
	181	MODULE_DEVICE_TABLE(hid, ax_devices);
	182
	183	static struct hid_driver ax_driver = {
0ae43810 DT	184	.name = "acrux",
	185	.id_table = ax_devices,
	186	.probe = ax_probe,
	187	.remove = ax_remove,
c0dbcc33	188	};
f425458e	189	module_hid_driver(ax_driver);
c0dbcc33 SK	190
	191	MODULE_AUTHOR("Sergei Kolzun");
	192	MODULE_DESCRIPTION("Force feedback support for ACRUX game controllers");
	193	MODULE_LICENSE("GPL");