Commit 73c5b254 authored by Andrey Smirnov's avatar Andrey Smirnov Committed by Jiri Kosina
Browse files

HID: microsoft: Add rumble support for Xbox One S controller 



Add HID quirk driver for Xbox One S controller over bluetooth.

This driver only adds support for rumble. Standard controller
functionality is exposed by default HID driver.

[jkosina@suse.cz: straightforward rebase on more recent driver code]
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: linux-input@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Cc: Pierre-Loup A. Griffais <pgriffais@valvesoftware.com>
Signed-off-by: default avatarJuha Kuikka <juha.kuikka@gmail.com>
Signed-off-by: default avatarAndrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent f2d3b625

drivers/hid/hid-ids.h

+1 −0
Original line number Diff line number Diff line
@@ -800,6 +800,7 @@ 
#define USB_DEVICE_ID_MS_TOUCH_COVER_2   0x07a7

#define USB_DEVICE_ID_MS_TYPE_COVER_2    0x07a9

#define USB_DEVICE_ID_MS_POWER_COVER     0x07da

#define USB_DEVICE_ID_MS_XBOX_ONE_S_CONTROLLER	0x02fd



#define USB_VENDOR_ID_MOJO		0x8282

#define USB_DEVICE_ID_RETRO_ADAPTER	0x3201

drivers/hid/hid-microsoft.c

+116 −0
Original line number Diff line number Diff line
@@ -29,11 +29,36 @@ 
#define MS_NOGET		BIT(4)

#define MS_DUPLICATE_USAGES	BIT(5)

#define MS_SURFACE_DIAL		BIT(6)

#define MS_QUIRK_FF		BIT(7)



struct ms_data {

	unsigned long quirks;

	struct hid_device *hdev;

	struct work_struct ff_worker;

	__u8 strong;

	__u8 weak;

	void *output_report_dmabuf;

};



#define XB1S_FF_REPORT		3

#define ENABLE_WEAK		BIT(0)

#define ENABLE_STRONG		BIT(1)



enum {

	MAGNITUDE_STRONG = 2,

	MAGNITUDE_WEAK,

	MAGNITUDE_NUM

};



struct xb1s_ff_report {

	__u8	report_id;

	__u8	enable;

	__u8	magnitude[MAGNITUDE_NUM];

	__u8	duration_10ms;

	__u8	start_delay_10ms;

	__u8	loop_count;

} __packed;



static __u8 *ms_report_fixup(struct hid_device *hdev, __u8 *rdesc,

		unsigned int *rsize)

{
@@ -259,6 +284,84 @@ static int ms_event(struct hid_device *hdev, struct hid_field *field, 
	return 0;

}



static void ms_ff_worker(struct work_struct *work)

{

	struct ms_data *ms = container_of(work, struct ms_data, ff_worker);

	struct hid_device *hdev = ms->hdev;

	struct xb1s_ff_report *r = ms->output_report_dmabuf;

	int ret;



	memset(r, 0, sizeof(*r));



	r->report_id = XB1S_FF_REPORT;

	r->enable = ENABLE_WEAK | ENABLE_STRONG;

	/*

	 * Specifying maximum duration and maximum loop count should

	 * cover maximum duration of a single effect, which is 65536

	 * ms

	 */

	r->duration_10ms = U8_MAX;

	r->loop_count = U8_MAX;

	r->magnitude[MAGNITUDE_STRONG] = ms->strong; /* left actuator */

	r->magnitude[MAGNITUDE_WEAK] = ms->weak;     /* right actuator */



	ret = hid_hw_output_report(hdev, (__u8 *)r, sizeof(*r));

	if (ret)

		hid_warn(hdev, "failed to send FF report\n");

}



static int ms_play_effect(struct input_dev *dev, void *data,

			  struct ff_effect *effect)

{

	struct hid_device *hid = input_get_drvdata(dev);

	struct ms_data *ms = hid_get_drvdata(hid);



	if (effect->type != FF_RUMBLE)

		return 0;



	/*

	 * Magnitude is 0..100 so scale the 16-bit input here

	 */

	ms->strong = ((u32) effect->u.rumble.strong_magnitude * 100) / U16_MAX;

	ms->weak = ((u32) effect->u.rumble.weak_magnitude * 100) / U16_MAX;



	schedule_work(&ms->ff_worker);

	return 0;

}



static int ms_init_ff(struct hid_device *hdev)

{

	struct hid_input *hidinput = list_entry(hdev->inputs.next,

						struct hid_input, list);

	struct input_dev *input_dev = hidinput->input;

	struct ms_data *ms = hid_get_drvdata(hdev);



	if (!(ms->quirks & MS_QUIRK_FF))

		return 0;



	ms->hdev = hdev;

	INIT_WORK(&ms->ff_worker, ms_ff_worker);



	ms->output_report_dmabuf = devm_kzalloc(&hdev->dev,

						sizeof(struct xb1s_ff_report),

						GFP_KERNEL);

	if (ms->output_report_dmabuf == NULL)

		return -ENOMEM;



	input_set_capability(input_dev, EV_FF, FF_RUMBLE);

	return input_ff_create_memless(input_dev, NULL, ms_play_effect);

}



static void ms_remove_ff(struct hid_device *hdev)

{

	struct ms_data *ms = hid_get_drvdata(hdev);



	if (!(ms->quirks & MS_QUIRK_FF))

		return;



	cancel_work_sync(&ms->ff_worker);

}



static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id)

{

	unsigned long quirks = id->driver_data;
@@ -292,11 +395,21 @@ static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id) 
		goto err_free;

	}



	ret = ms_init_ff(hdev);

	if (ret)

		hid_err(hdev, "could not initialize ff, continuing anyway");



	return 0;

err_free:

	return ret;

}



static void ms_remove(struct hid_device *hdev)

{

	hid_hw_stop(hdev);

	ms_remove_ff(hdev);

}



static const struct hid_device_id ms_devices[] = {

	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV),

		.driver_data = MS_HIDINPUT },
@@ -333,6 +446,8 @@ static const struct hid_device_id ms_devices[] = { 
		.driver_data = MS_PRESENTER },

	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, 0x091B),

		.driver_data = MS_SURFACE_DIAL },

	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_ONE_S_CONTROLLER),

		.driver_data = MS_QUIRK_FF },

	{ }

};

MODULE_DEVICE_TABLE(hid, ms_devices);
@@ -345,6 +460,7 @@ static struct hid_driver ms_driver = { 
	.input_mapped = ms_input_mapped,

	.event = ms_event,

	.probe = ms_probe,

	.remove = ms_remove,

};

module_hid_driver(ms_driver);