BACKPORT: HID: microsoft: Add rumble support to latest xbox controllers

Add rumble support for various Xbox One/Series controllers via Bluetooth.
Controller rumble appears as a haptic device on Android and can be used
with the VibratorManagerAPI.

The only notible change from upstream is to add HID IDs to
hid_have_special_driver in hid-core.c as we are on 4.9 kernel,
otherwise hid-generic takes priority over hid-microsoft.

Tested on dopinder with Moonlight.

Commits from mainline linux:
(cherry-picked from f2d3b625dae10cdf14bcfcacb965b02f5c0acc01)
(cherry-picked from 73c5b254c36529c84c9d19e07905f7103bb32e79)
(cherry-picked from f5554725f30475b05b5178b998366f11ecb50c7f)

Change-Id: Iae2c6782534a7fbdefd44ed11911f8a0019bf631
(cherry picked from commit 43b428c56bfb6830121529e0dad0712d1ede7273)

diff --git a/drivers/hid/hid-core.c b/drivers/hid/hid-core.c
index 0482446a50a181606b2f76ff06b77397846b6d92..fa9faa902e14f522e708565a7a31436882f79a06 100644 (file)
--- a/drivers/hid/hid-core.c
+++ b/drivers/hid/hid-core.c
@@ -2078,6 +2078,11 @@ static const struct hid_device_id hid_have_special_driver[] = {
        { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_600) },
        { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3KV1) },
        { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_POWER_COVER) },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708) },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708_BLE) },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1914) },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797) },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797_BLE) },
        { HID_USB_DEVICE(USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E) },
        { HID_USB_DEVICE(USB_VENDOR_ID_MSI, USB_DEVICE_ID_MSI_GT683R_LED_PANEL) },
 #if IS_ENABLED(CONFIG_HID_NINTENDO)

diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h
index 0239eaaf19f764f94da725dfba5636dbfac895c6..5ff4c9791ee21d67baf23eb900e5342bdd1b15ff 100644 (file)
--- a/drivers/hid/hid-ids.h
+++ b/drivers/hid/hid-ids.h
@@ -748,6 +748,15 @@
 #define USB_DEVICE_ID_MS_TYPE_COVER_PRO_3_JP 0x07dd
 #define USB_DEVICE_ID_MS_TYPE_COVER_PRO_4_JP 0x07e9
 #define USB_DEVICE_ID_MS_POWER_COVER     0x07da
+/*
+ * For a description of the Xbox controller models, refer to:
+ * https://en.wikipedia.org/wiki/Xbox_Wireless_Controller#Summary
+ */
+#define USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708    0x02fd
+#define USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708_BLE        0x0b20
+#define USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1914    0x0b13
+#define USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797    0x0b05
+#define USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797_BLE        0x0b22
 
 #define USB_VENDOR_ID_MOJO             0x8282
 #define USB_DEVICE_ID_RETRO_ADAPTER    0x3201

diff --git a/drivers/hid/hid-microsoft.c b/drivers/hid/hid-microsoft.c
index ba02667beb804420f9e2a0d66ca1f34498c61a03..a986deddc681e7cd8ac4a7054da41360fa67cbe4 100644 (file)
--- a/drivers/hid/hid-microsoft.c
+++ b/drivers/hid/hid-microsoft.c
@@ -22,17 +22,47 @@
 
 #include "hid-ids.h"
 
-#define MS_HIDINPUT            0x01
-#define MS_ERGONOMY            0x02
-#define MS_PRESENTER           0x04
-#define MS_RDESC               0x08
-#define MS_NOGET               0x10
-#define MS_DUPLICATE_USAGES    0x20
+#define MS_HIDINPUT            BIT(0)
+#define MS_ERGONOMY            BIT(1)
+#define MS_PRESENTER           BIT(2)
+#define MS_RDESC               BIT(3)
+#define MS_NOGET               BIT(4)
+#define MS_DUPLICATE_USAGES    BIT(5)
+#define MS_QUIRK_FF            BIT(6)
+
+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)
 {
-       unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
+       struct ms_data *ms = hid_get_drvdata(hdev);
+       unsigned long quirks = ms->quirks;
 
        /*
         * Microsoft Wireless Desktop Receiver (Model 1028) has
@@ -134,7 +164,8 @@ static int ms_input_mapping(struct hid_device *hdev, struct hid_input *hi,
                struct hid_field *field, struct hid_usage *usage,
                unsigned long **bit, int *max)
 {
-       unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
+       struct ms_data *ms = hid_get_drvdata(hdev);
+       unsigned long quirks = ms->quirks;
 
        if (quirks & MS_ERGONOMY) {
                int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max);
@@ -153,7 +184,8 @@ static int ms_input_mapped(struct hid_device *hdev, struct hid_input *hi,
                struct hid_field *field, struct hid_usage *usage,
                unsigned long **bit, int *max)
 {
-       unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
+       struct ms_data *ms = hid_get_drvdata(hdev);
+       unsigned long quirks = ms->quirks;
 
        if (quirks & MS_DUPLICATE_USAGES)
                clear_bit(usage->code, *bit);
@@ -219,12 +251,97 @@ 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;
+       struct ms_data *ms;
        int ret;
 
-       hid_set_drvdata(hdev, (void *)quirks);
+       ms = devm_kzalloc(&hdev->dev, sizeof(*ms), GFP_KERNEL);
+       if (ms == NULL)
+               return -ENOMEM;
+
+       ms->quirks = quirks;
+
+       hid_set_drvdata(hdev, ms);
 
        if (quirks & MS_NOGET)
                hdev->quirks |= HID_QUIRK_NOGET;
@@ -242,11 +359,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 },
@@ -286,9 +413,18 @@ static const struct hid_device_id ms_devices[] = {
                .driver_data = MS_HIDINPUT },
        { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_KEYBOARD),
                .driver_data = MS_ERGONOMY},
-
        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT),
                .driver_data = MS_PRESENTER },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708),
+               .driver_data = MS_QUIRK_FF },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1708_BLE),
+               .driver_data = MS_QUIRK_FF },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1914),
+               .driver_data = MS_QUIRK_FF },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797),
+               .driver_data = MS_QUIRK_FF },
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_XBOX_CONTROLLER_MODEL_1797_BLE),
+               .driver_data = MS_QUIRK_FF },
        { }
 };
 MODULE_DEVICE_TABLE(hid, ms_devices);
@@ -301,6 +437,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);