| Message ID | 20180228184322.29636-2-rodrigorivascosta@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa <rodrigorivascosta@gmail.com> wrote: > There are two ways to connect the Steam Controller: directly to the USB > or with the USB wireless adapter. Both methods are similar, but the > wireless adapter can connect up to 4 devices at the same time. > > The wired device will appear as 3 interfaces: a virtual mouse, a virtual > keyboard and a custom HID device. > > The wireless device will appear as 5 interfaces: a virtual keyboard and > 4 custom HID devices, that will remain silent until a device is actually > connected. > > The custom HID device has a report descriptor with all vendor specific > usages, so the hid-generic is not very useful. In a PC/SteamBox Valve > Steam Client provices a software translation by using direct USB access > and a creates a uinput virtual gamepad. > > This driver was reverse engineered to provide direct kernel support in > case you cannot, or do not want to, use Valve Steam Client. It disables > the virtual keyboard and mouse, as they are not so useful when you have > a working gamepad. > +// SPDX-License-Identifier: GPL-2.0 > +MODULE_LICENSE("GPL"); Not the same. > +static void steam_unregister(struct steam_device *steam) > +{ > + struct input_dev *input; > + > + rcu_read_lock(); > + input = rcu_dereference(steam->input); > + rcu_read_unlock(); > + > + if (input) { if (!input) return; ? > + RCU_INIT_POINTER(steam->input, NULL); > + synchronize_rcu(); > + hid_info(steam->hdev, "Steam Controller disconnected"); > + input_unregister_device(input); > + } > +} > +static bool steam_is_valve_interface(struct hid_device *hdev) > +{ > + struct hid_report_enum *rep_enum; > + struct hid_report *hreport; > + > + /* > + * The wired device creates 3 interfaces: > + * 0: emulated mouse. > + * 1: emulated keyboard. > + * 2: the real game pad. > + * The wireless device creates 5 interfaces: > + * 0: emulated keyboard. > + * 1-4: slots where up to 4 real game pads will be connected to. > + * We know which one is the real gamepad interface because they are the > + * only ones with a feature report. > + */ > + rep_enum = &hdev->report_enum[HID_FEATURE_REPORT]; > + list_for_each_entry(hreport, &rep_enum->report_list, list) { > + /* should we check hreport->id == 0? */ > + return true; > + } > + return false; So, for now it's just an equivalent of return !list_empty(); ? > +} > + /* > + * From this point on, if anything fails return 0 and ignores > + * the error, so that the default HID devices are still bound. > + */ > + steam = devm_kzalloc(&hdev->dev, > + sizeof(struct steam_device), GFP_KERNEL); sizeof(*steam) saves a line. > + if (!steam) { > + ret = -ENOMEM; > + goto mem_fail; > + } > +static void steam_remove(struct hid_device *hdev) > +{ > + struct steam_device *steam = hid_get_drvdata(hdev); > + > + if (steam && (steam->quirks & STEAM_QUIRK_WIRELESS)) { > + hid_info(hdev, "Steam wireless receiver disconnected"); > + hid_hw_close(hdev); > + } > + > + hid_hw_stop(hdev); > + > + if (steam) { > + cancel_work_sync(&steam->work_connect); > + steam_unregister(steam); > + hid_set_drvdata(hdev, NULL); Hmm.. Doesn't HID do this? > + } if (steam) { ... hid_hw_stop(hdev); ... } else { hid_hw_stop(hdev); } ? > +} > +static void steam_do_input_event(struct steam_device *steam, > + struct input_dev *input, u8 *data) > +{ > + /* 24 bits of buttons */ > + u8 b8, b9, b10; > + bool lpad_touched, lpad_and_joy; > + > + b8 = data[8]; > + b9 = data[9]; > + b10 = data[10]; > + > + input_report_abs(input, ABS_Z, data[11]); > + input_report_abs(input, ABS_RZ, data[12]); > + > + /* > + * These two bits tells how to interpret the values X and Y. > + * lpad_and_joy tells that the joystick and the lpad are used at the > + * same time. > + * lpad_touched tells whether X/Y are to be read as lpad coord or > + * joystick values. > + * (lpad_touched || lpad_and_joy) tells if the lpad is really touched. > + */ > + lpad_touched = b10 & 0x08; BIT(3) ? > + lpad_and_joy = b10 & 0x80; BIT(7) ? > + input_event(input, EV_KEY, BTN_TR2, !!(b8 & 0x01)); > + input_event(input, EV_KEY, BTN_TL2, !!(b8 & 0x02)); > + input_event(input, EV_KEY, BTN_TR, !!(b8 & 0x04)); > + input_event(input, EV_KEY, BTN_TL, !!(b8 & 0x08)); > + input_event(input, EV_KEY, BTN_Y, !!(b8 & 0x10)); > + input_event(input, EV_KEY, BTN_B, !!(b8 & 0x20)); > + input_event(input, EV_KEY, BTN_X, !!(b8 & 0x40)); > + input_event(input, EV_KEY, BTN_A, !!(b8 & 0x80)); > + input_event(input, EV_KEY, BTN_SELECT, !!(b9 & 0x10)); > + input_event(input, EV_KEY, BTN_MODE, !!(b9 & 0x20)); > + input_event(input, EV_KEY, BTN_START, !!(b9 & 0x40)); > + input_event(input, EV_KEY, BTN_GEAR_DOWN, !!(b9 & 0x80)); > + input_event(input, EV_KEY, BTN_GEAR_UP, !!(b10 & 0x01)); > + input_event(input, EV_KEY, BTN_THUMBR, !!(b10 & 0x04)); > + input_event(input, EV_KEY, BTN_THUMBL, !!(b10 & 0x40)); > + input_event(input, EV_KEY, BTN_THUMB, lpad_touched || lpad_and_joy); > + input_event(input, EV_KEY, BTN_THUMB2, !!(b10 & 0x10)); BIT(x) ? > + > + input_report_abs(input, ABS_HAT0X, > + !!(b9 & 0x02) - !!(b9 & 0x04)); > + input_report_abs(input, ABS_HAT0Y, > + !!(b9 & 0x08) - !!(b9 & 0x01)); BIT(x) ? > +} > +static int steam_raw_event(struct hid_device *hdev, > + struct hid_report *report, u8 *data, > + int size) > +{ > + struct steam_device *steam = hid_get_drvdata(hdev); > + struct input_dev *input; > + > + if (!steam) > + return 0; When it's possible? > + return 0; > +}
On Wed, Feb 28, 2018 at 09:21:15PM +0200, Andy Shevchenko wrote: > On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa > <rodrigorivascosta@gmail.com> wrote: > > There are two ways to connect the Steam Controller: directly to the USB > > or with the USB wireless adapter. Both methods are similar, but the > > wireless adapter can connect up to 4 devices at the same time. > > > > The wired device will appear as 3 interfaces: a virtual mouse, a virtual > > keyboard and a custom HID device. > > > > The wireless device will appear as 5 interfaces: a virtual keyboard and > > 4 custom HID devices, that will remain silent until a device is actually > > connected. > > > > The custom HID device has a report descriptor with all vendor specific > > usages, so the hid-generic is not very useful. In a PC/SteamBox Valve > > Steam Client provices a software translation by using direct USB access > > and a creates a uinput virtual gamepad. > > > > This driver was reverse engineered to provide direct kernel support in > > case you cannot, or do not want to, use Valve Steam Client. It disables > > the virtual keyboard and mouse, as they are not so useful when you have > > a working gamepad. > > > > +// SPDX-License-Identifier: GPL-2.0 > > > +MODULE_LICENSE("GPL"); > > Not the same. Hmmm... I copied from usb-skeleton.c, IIRC... I'll change to GPL-2.0+, that would be correct, I think. > > > +static void steam_unregister(struct steam_device *steam) > > +{ > > + struct input_dev *input; > > + > > + rcu_read_lock(); > > + input = rcu_dereference(steam->input); > > + rcu_read_unlock(); > > + > > > + if (input) { > > if (!input) > return; > > ? That was because of symmetry, because further patches add more objects. Then if (input) free(input); if (battery) free(battery); /* in the future *( if (input_gyro) free(input_gyro); Sure, the last one can do an early return, but you break symmetry. > > > + RCU_INIT_POINTER(steam->input, NULL); > > + synchronize_rcu(); > > + hid_info(steam->hdev, "Steam Controller disconnected"); > > + input_unregister_device(input); > > + } > > +} > > > +static bool steam_is_valve_interface(struct hid_device *hdev) > > +{ > > + struct hid_report_enum *rep_enum; > > + struct hid_report *hreport; > > + > > + /* > > + * The wired device creates 3 interfaces: > > + * 0: emulated mouse. > > + * 1: emulated keyboard. > > + * 2: the real game pad. > > + * The wireless device creates 5 interfaces: > > + * 0: emulated keyboard. > > + * 1-4: slots where up to 4 real game pads will be connected to. > > + * We know which one is the real gamepad interface because they are the > > + * only ones with a feature report. > > + */ > > + rep_enum = &hdev->report_enum[HID_FEATURE_REPORT]; > > > + list_for_each_entry(hreport, &rep_enum->report_list, list) { > > + /* should we check hreport->id == 0? */ > > + return true; > > + } > > + return false; > > So, for now it's just an equivalent of > > return !list_empty(); > > ? I was expecting to add a few more checks in the middle, but those weren't needed at the end. I'll change that. > > > +} > > > + /* > > + * From this point on, if anything fails return 0 and ignores > > + * the error, so that the default HID devices are still bound. > > + */ > > + steam = devm_kzalloc(&hdev->dev, > > + sizeof(struct steam_device), GFP_KERNEL); > > sizeof(*steam) saves a line. Right, changed. > > > + if (!steam) { > > + ret = -ENOMEM; > > + goto mem_fail; > > + } > > > +static void steam_remove(struct hid_device *hdev) > > +{ > > + struct steam_device *steam = hid_get_drvdata(hdev); > > + > > + if (steam && (steam->quirks & STEAM_QUIRK_WIRELESS)) { > > + hid_info(hdev, "Steam wireless receiver disconnected"); > > + hid_hw_close(hdev); > > + } > > + > > + hid_hw_stop(hdev); > > + > > + if (steam) { > > + cancel_work_sync(&steam->work_connect); > > + steam_unregister(steam); > > > + hid_set_drvdata(hdev, NULL); > > Hmm.. Doesn't HID do this? Do you mean the hid_set_drvdata(hdev, NULL)? I'm not sure, I didn't see that on hid-core.c or hid-generic.c. And a call like this is done in many modules... so I did the same, just to be sure. > > > + } > > if (steam) { > ... > hid_hw_stop(hdev); > ... > } else { > hid_hw_stop(hdev); > } > > ? I have no real preference. Your version has two 'if', mine has two 'if'. What about: static void steam_remove(struct hid_device *hdev) { struct steam_device *steam = hid_get_drvdata(hdev); if (!steam) { hid_hw_stop(hdev); return; } if (steam->quirks & STEAM_QUIRK_WIRELESS) { hid_info(hdev, "Steam wireless receiver disconnected"); hid_hw_close(hdev); } hid_hw_stop(hdev); cancel_work_sync(&steam->work_connect); steam_unregister(steam); hid_set_drvdata(hdev, NULL); } > > > +} > > > +static void steam_do_input_event(struct steam_device *steam, > > + struct input_dev *input, u8 *data) > > +{ > > + /* 24 bits of buttons */ > > + u8 b8, b9, b10; > > + bool lpad_touched, lpad_and_joy; > > + > > + b8 = data[8]; > > + b9 = data[9]; > > + b10 = data[10]; > > + > > + input_report_abs(input, ABS_Z, data[11]); > > + input_report_abs(input, ABS_RZ, data[12]); > > + > > + /* > > + * These two bits tells how to interpret the values X and Y. > > + * lpad_and_joy tells that the joystick and the lpad are used at the > > + * same time. > > + * lpad_touched tells whether X/Y are to be read as lpad coord or > > + * joystick values. > > + * (lpad_touched || lpad_and_joy) tells if the lpad is really touched. > > + */ > > > + lpad_touched = b10 & 0x08; > > BIT(3) ? > > > + lpad_and_joy = b10 & 0x80; > > BIT(7) ? > > > + input_event(input, EV_KEY, BTN_TR2, !!(b8 & 0x01)); > > + input_event(input, EV_KEY, BTN_TL2, !!(b8 & 0x02)); > > + input_event(input, EV_KEY, BTN_TR, !!(b8 & 0x04)); > > + input_event(input, EV_KEY, BTN_TL, !!(b8 & 0x08)); > > + input_event(input, EV_KEY, BTN_Y, !!(b8 & 0x10)); > > + input_event(input, EV_KEY, BTN_B, !!(b8 & 0x20)); > > + input_event(input, EV_KEY, BTN_X, !!(b8 & 0x40)); > > + input_event(input, EV_KEY, BTN_A, !!(b8 & 0x80)); > > + input_event(input, EV_KEY, BTN_SELECT, !!(b9 & 0x10)); > > + input_event(input, EV_KEY, BTN_MODE, !!(b9 & 0x20)); > > + input_event(input, EV_KEY, BTN_START, !!(b9 & 0x40)); > > + input_event(input, EV_KEY, BTN_GEAR_DOWN, !!(b9 & 0x80)); > > + input_event(input, EV_KEY, BTN_GEAR_UP, !!(b10 & 0x01)); > > + input_event(input, EV_KEY, BTN_THUMBR, !!(b10 & 0x04)); > > + input_event(input, EV_KEY, BTN_THUMBL, !!(b10 & 0x40)); > > + input_event(input, EV_KEY, BTN_THUMB, lpad_touched || lpad_and_joy); > > + input_event(input, EV_KEY, BTN_THUMB2, !!(b10 & 0x10)); > > BIT(x) ? > > > + > > + input_report_abs(input, ABS_HAT0X, > > + !!(b9 & 0x02) - !!(b9 & 0x04)); > > + input_report_abs(input, ABS_HAT0Y, > > + !!(b9 & 0x08) - !!(b9 & 0x01)); > > BIT(x) ? That's certainly nicer. Changed. > > > +} > > > +static int steam_raw_event(struct hid_device *hdev, > > + struct hid_report *report, u8 *data, > > + int size) > > +{ > > + struct steam_device *steam = hid_get_drvdata(hdev); > > + struct input_dev *input; > > + > > > + if (!steam) > > + return 0; > > When it's possible? That's because how the new automatic unbinding/rebinding of hid-generic works. This driver binds all the interfaces of the device, including the virtual mouse and keyboard (!steam_is_valve_interface()). Those hid_devices do not have a steam_device, but they still generate raw_events. > > > + return 0; > > +} > > -- > With Best Regards, > Andy Shevchenko Regards. Rodrigo. -- To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Rodrigo, On Wed, Feb 28, 2018 at 11:49:26PM +0100, Rodrigo Rivas Costa wrote: > On Wed, Feb 28, 2018 at 09:21:15PM +0200, Andy Shevchenko wrote: > > On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa > > <rodrigorivascosta@gmail.com> wrote: > > > There are two ways to connect the Steam Controller: directly to the USB > > > or with the USB wireless adapter. Both methods are similar, but the > > > wireless adapter can connect up to 4 devices at the same time. > > > > > > The wired device will appear as 3 interfaces: a virtual mouse, a virtual > > > keyboard and a custom HID device. > > > > > > The wireless device will appear as 5 interfaces: a virtual keyboard and > > > 4 custom HID devices, that will remain silent until a device is actually > > > connected. > > > > > > The custom HID device has a report descriptor with all vendor specific > > > usages, so the hid-generic is not very useful. In a PC/SteamBox Valve > > > Steam Client provices a software translation by using direct USB access > > > and a creates a uinput virtual gamepad. > > > > > > This driver was reverse engineered to provide direct kernel support in > > > case you cannot, or do not want to, use Valve Steam Client. It disables > > > the virtual keyboard and mouse, as they are not so useful when you have > > > a working gamepad. > > > > > > > +// SPDX-License-Identifier: GPL-2.0 > > > > > +MODULE_LICENSE("GPL"); > > > > Not the same. > > Hmmm... I copied from usb-skeleton.c, IIRC... > I'll change to GPL-2.0+, that would be correct, I think. Yep, the usb-skeleton.c is wrong. I have prepared a patch, just not submitted it yet.. GPL-2.0+ is "GPLv2 or later" if that is what you want. Best regards Marcus Folkesson -- To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Thu, Mar 1, 2018 at 12:49 AM, Rodrigo Rivas Costa <rodrigorivascosta@gmail.com> wrote: > On Wed, Feb 28, 2018 at 09:21:15PM +0200, Andy Shevchenko wrote: >> On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa >> <rodrigorivascosta@gmail.com> wrote: >> > + if (input) { >> >> if (!input) >> return; >> >> ? > That was because of symmetry, because further patches add more objects. > Then > if (input) > free(input); > if (battery) > free(battery); > /* in the future *( > if (input_gyro) > free(input_gyro); > > Sure, the last one can do an early return, but you break symmetry. The generic APIs when designed properly are NULL aware at freeing resources. So, it should look like free(input); free(battery); free(input_gyro); >> > + if (steam) { >> > + cancel_work_sync(&steam->work_connect); >> > + steam_unregister(steam); >> >> > + hid_set_drvdata(hdev, NULL); >> >> Hmm.. Doesn't HID do this? > > Do you mean the hid_set_drvdata(hdev, NULL)? I'm not sure, I didn't see > that on hid-core.c or hid-generic.c. And a call like this is done in > many modules... so I did the same, just to be sure. What you are looking for is, AFAIU: drivers/base/dd.c:902: dev_set_drvdata(dev, NULL); >> >> > + } >> >> if (steam) { >> ... >> hid_hw_stop(hdev); >> ... >> } else { >> hid_hw_stop(hdev); >> } >> >> ? > > I have no real preference. Your version has two 'if', mine has two 'if'. > What about: > > static void steam_remove(struct hid_device *hdev) > { > struct steam_device *steam = hid_get_drvdata(hdev); > > if (!steam) { > hid_hw_stop(hdev); > return; > } > > if (steam->quirks & STEAM_QUIRK_WIRELESS) { > hid_info(hdev, "Steam wireless receiver disconnected"); > hid_hw_close(hdev); > } > hid_hw_stop(hdev); > cancel_work_sync(&steam->work_connect); > steam_unregister(steam); > hid_set_drvdata(hdev, NULL); w/o this one. > } For me my version looks more compact to read, but at the end it's up to you. Another option split if (steam) variant into helper, and thus if (steam) steam_non_null_device_remove(); else hid_hw_stop(); But again, up to you (that's why question mark in the first place above).
On Thu, Mar 01, 2018 at 12:20:37PM +0200, Andy Shevchenko wrote: > On Thu, Mar 1, 2018 at 12:49 AM, Rodrigo Rivas Costa > <rodrigorivascosta@gmail.com> wrote: > > On Wed, Feb 28, 2018 at 09:21:15PM +0200, Andy Shevchenko wrote: > >> On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa > >> <rodrigorivascosta@gmail.com> wrote: > > >> > + if (input) { > >> > >> if (!input) > >> return; > >> > >> ? > > That was because of symmetry, because further patches add more objects. > > Then > > if (input) > > free(input); > > if (battery) > > free(battery); > > /* in the future *( > > if (input_gyro) > > free(input_gyro); > > > > Sure, the last one can do an early return, but you break symmetry. > > The generic APIs when designed properly are NULL aware at freeing resources. > > So, it should look like > > free(input); > free(battery); > free(input_gyro); My bad, I didn't mean a literal free() call. More like: static void steam_unregister(struct steam_device *steam) { struct input_dev *input; struct power_supply *battery; rcu_read_lock(); input = rcu_dereference(steam->input); battery = rcu_dereference(steam->battery); input_gyro = rcu_dereference(steam->input_gyro); rcu_read_unlock(); if (input) { RCU_INIT_POINTER(steam->input, NULL); synchronize_rcu(); hid_info(steam->hdev, "Steam Controller '%s' disconnected", steam->serial_no); input_unregister_device(input); } if (battery) { RCU_INIT_POINTER(steam->battery, NULL); synchronize_rcu(); power_supply_unregister(battery); } if (input_gyro) { RCU_INIT_POINTER(steam->input_gyro, NULL); synchronize_rcu(); input_unregister_device(input_gyro); } } Also I think input_unregister_device() does not admit a NULL pointer. Having a special `if (!input_gyro)return;` at the end looks just wrong to me, it is no different from the other ones. > > >> > + if (steam) { > >> > + cancel_work_sync(&steam->work_connect); > >> > + steam_unregister(steam); > >> > >> > + hid_set_drvdata(hdev, NULL); > >> > >> Hmm.. Doesn't HID do this? > > > > Do you mean the hid_set_drvdata(hdev, NULL)? I'm not sure, I didn't see > > that on hid-core.c or hid-generic.c. And a call like this is done in > > many modules... so I did the same, just to be sure. > > What you are looking for is, AFAIU: > > drivers/base/dd.c:902: dev_set_drvdata(dev, NULL); Ah, yes. I usually feel more comfortable setting the pointer to NULL just after freeing the object. But currently I'm not freeing the steam anymore, it is devm'ed, and the actual free happens from dd.c:900. You convinced me, I'll remove that line. > > >> > >> > + } > >> > >> if (steam) { > >> ... > >> hid_hw_stop(hdev); > >> ... > >> } else { > >> hid_hw_stop(hdev); > >> } > >> > >> ? > > > > I have no real preference. Your version has two 'if', mine has two 'if'. > > What about: > > > > static void steam_remove(struct hid_device *hdev) > > { > > struct steam_device *steam = hid_get_drvdata(hdev); > > > > if (!steam) { > > hid_hw_stop(hdev); > > return; > > } > > > > if (steam->quirks & STEAM_QUIRK_WIRELESS) { > > hid_info(hdev, "Steam wireless receiver disconnected"); > > hid_hw_close(hdev); > > } > > hid_hw_stop(hdev); > > cancel_work_sync(&steam->work_connect); > > steam_unregister(steam); > > > hid_set_drvdata(hdev, NULL); > > w/o this one. > > > } > > For me my version looks more compact to read, but at the end it's up to you. > Another option split if (steam) variant into helper, and thus > > if (steam) > steam_non_null_device_remove(); > else > hid_hw_stop(); > > But again, up to you (that's why question mark in the first place above). Well, I don't like code such as: if (cond) { /* a lot of code */ } else { /* one line */ } because at the time I get to the else I don't remember what the condition was about. Regards. Rodrigo > -- > With Best Regards, > Andy Shevchenko -- To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
On Thu, Mar 1, 2018 at 9:13 PM, Rodrigo Rivas Costa <rodrigorivascosta@gmail.com> wrote: > On Thu, Mar 01, 2018 at 12:20:37PM +0200, Andy Shevchenko wrote: >> On Thu, Mar 1, 2018 at 12:49 AM, Rodrigo Rivas Costa >> <rodrigorivascosta@gmail.com> wrote: >> > On Wed, Feb 28, 2018 at 09:21:15PM +0200, Andy Shevchenko wrote: >> >> On Wed, Feb 28, 2018 at 8:43 PM, Rodrigo Rivas Costa >> >> <rodrigorivascosta@gmail.com> wrote: > My bad, I didn't mean a literal free() call. More like: > > static void steam_unregister(struct steam_device *steam) > { > struct input_dev *input; > struct power_supply *battery; > > rcu_read_lock(); > input = rcu_dereference(steam->input); > battery = rcu_dereference(steam->battery); > input_gyro = rcu_dereference(steam->input_gyro); > rcu_read_unlock(); > > if (input) { > RCU_INIT_POINTER(steam->input, NULL); > synchronize_rcu(); > hid_info(steam->hdev, "Steam Controller '%s' disconnected", > steam->serial_no); > input_unregister_device(input); Candidate for a helper static void steam_unregister_input(...) { ... } steam_unregister_input(input); > } > if (battery) { > RCU_INIT_POINTER(steam->battery, NULL); > synchronize_rcu(); > power_supply_unregister(battery); > } Ditto. > if (input_gyro) { > RCU_INIT_POINTER(steam->input_gyro, NULL); > synchronize_rcu(); > input_unregister_device(input_gyro); > } Ditto. > } > > Also I think input_unregister_device() does not admit a NULL pointer. > Having a special `if (!input_gyro)return;` at the end looks just > wrong to me, it is no different from the other ones. See above. Hide that detail in a helper function.
diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index 19c499f5623d..6e80fbf04e03 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -823,6 +823,14 @@ config HID_SPEEDLINK ---help--- Support for Speedlink Vicious and Divine Cezanne mouse. +config HID_STEAM + tristate "Steam Controller support" + depends on HID + ---help--- + Say Y here if you have a Steam Controller if you want to use it + without running the Steam Client. It supports both the wired and + the wireless adaptor. + config HID_STEELSERIES tristate "Steelseries SRW-S1 steering wheel support" depends on HID diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index eb13b9e92d85..60a8abf84682 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -95,6 +95,7 @@ obj-$(CONFIG_HID_SAMSUNG) += hid-samsung.o obj-$(CONFIG_HID_SMARTJOYPLUS) += hid-sjoy.o obj-$(CONFIG_HID_SONY) += hid-sony.o obj-$(CONFIG_HID_SPEEDLINK) += hid-speedlink.o +obj-$(CONFIG_HID_STEAM) += hid-steam.o obj-$(CONFIG_HID_STEELSERIES) += hid-steelseries.o obj-$(CONFIG_HID_SUNPLUS) += hid-sunplus.o obj-$(CONFIG_HID_GREENASIA) += hid-gaff.o diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h index 43ddcdfbd0da..be31a3c20818 100644 --- a/drivers/hid/hid-ids.h +++ b/drivers/hid/hid-ids.h @@ -988,6 +988,10 @@ #define USB_VENDOR_ID_STANTUM_SITRONIX 0x1403 #define USB_DEVICE_ID_MTP_SITRONIX 0x5001 +#define USB_VENDOR_ID_VALVE 0x28de +#define USB_DEVICE_ID_STEAM_CONTROLLER 0x1102 +#define USB_DEVICE_ID_STEAM_CONTROLLER_WIRELESS 0x1142 + #define USB_VENDOR_ID_STEELSERIES 0x1038 #define USB_DEVICE_ID_STEELSERIES_SRWS1 0x1410 diff --git a/drivers/hid/hid-steam.c b/drivers/hid/hid-steam.c new file mode 100644 index 000000000000..96256426c366 --- /dev/null +++ b/drivers/hid/hid-steam.c @@ -0,0 +1,544 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * HID driver for Valve Steam Controller + * + * Copyright (c) 2018 Rodrigo Rivas Costa <rodrigorivascosta@gmail.com> + * + * Supports both the wired and wireless interfaces. + * + * For additional functions, such as disabling the virtual mouse/keyboard or + * changing the right-pad margin you can use the user-space tool at: + * + * https://github.com/rodrigorc/steamctrl + */ + +#include <linux/device.h> +#include <linux/input.h> +#include <linux/hid.h> +#include <linux/module.h> +#include <linux/workqueue.h> +#include <linux/rcupdate.h> +#include "hid-ids.h" + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Rodrigo Rivas Costa <rodrigorivascosta@gmail.com>"); + +#define STEAM_QUIRK_WIRELESS BIT(0) + +/* Touch pads are 40 mm in diameter and 65535 units */ +#define STEAM_PAD_RESOLUTION 1638 +/* Trigger runs are about 5 mm and 256 units */ +#define STEAM_TRIGGER_RESOLUTION 51 +/* Joystick runs are about 5 mm and 256 units */ +#define STEAM_JOYSTICK_RESOLUTION 51 + +#define STEAM_PAD_FUZZ 256 + +struct steam_device { + spinlock_t lock; + struct hid_device *hdev; + struct input_dev __rcu *input; + unsigned long quirks; + struct work_struct work_connect; + bool connected; +}; + +static int steam_input_open(struct input_dev *dev) +{ + struct steam_device *steam = input_get_drvdata(dev); + + return hid_hw_open(steam->hdev); +} + +static void steam_input_close(struct input_dev *dev) +{ + struct steam_device *steam = input_get_drvdata(dev); + + hid_hw_close(steam->hdev); +} + +static int steam_register(struct steam_device *steam) +{ + struct hid_device *hdev = steam->hdev; + struct input_dev *input; + int ret; + + rcu_read_lock(); + input = rcu_dereference(steam->input); + rcu_read_unlock(); + if (input) { + dbg_hid("%s: already connected\n", __func__); + return 0; + } + + hid_info(hdev, "Steam Controller connected"); + + input = input_allocate_device(); + if (!input) + return -ENOMEM; + + input_set_drvdata(input, steam); + input->dev.parent = &hdev->dev; + input->open = steam_input_open; + input->close = steam_input_close; + + input->name = (steam->quirks & STEAM_QUIRK_WIRELESS) ? + "Wireless Steam Controller" : + "Steam Controller"; + input->phys = hdev->phys; + input->uniq = hdev->uniq; + input->id.bustype = hdev->bus; + input->id.vendor = hdev->vendor; + input->id.product = hdev->product; + input->id.version = hdev->version; + + input_set_capability(input, EV_KEY, BTN_TR2); + input_set_capability(input, EV_KEY, BTN_TL2); + input_set_capability(input, EV_KEY, BTN_TR); + input_set_capability(input, EV_KEY, BTN_TL); + input_set_capability(input, EV_KEY, BTN_Y); + input_set_capability(input, EV_KEY, BTN_B); + input_set_capability(input, EV_KEY, BTN_X); + input_set_capability(input, EV_KEY, BTN_A); + input_set_capability(input, EV_KEY, BTN_SELECT); + input_set_capability(input, EV_KEY, BTN_MODE); + input_set_capability(input, EV_KEY, BTN_START); + input_set_capability(input, EV_KEY, BTN_GEAR_DOWN); + input_set_capability(input, EV_KEY, BTN_GEAR_UP); + input_set_capability(input, EV_KEY, BTN_THUMBR); + input_set_capability(input, EV_KEY, BTN_THUMBL); + input_set_capability(input, EV_KEY, BTN_THUMB); + input_set_capability(input, EV_KEY, BTN_THUMB2); + + input_set_abs_params(input, ABS_Z, 0, 255, 0, 0); + input_set_abs_params(input, ABS_RZ, 0, 255, 0, 0); + input_set_abs_params(input, ABS_X, -32767, 32767, 0, 0); + input_set_abs_params(input, ABS_Y, -32767, 32767, 0, 0); + input_set_abs_params(input, ABS_RX, -32767, 32767, + STEAM_PAD_FUZZ, 0); + input_set_abs_params(input, ABS_RY, -32767, 32767, + STEAM_PAD_FUZZ, 0); + input_set_abs_params(input, ABS_HAT1X, -32767, 32767, + STEAM_PAD_FUZZ, 0); + input_set_abs_params(input, ABS_HAT1Y, -32767, 32767, + STEAM_PAD_FUZZ, 0); + input_set_abs_params(input, ABS_HAT0X, -1, 1, 0, 0); + input_set_abs_params(input, ABS_HAT0Y, -1, 1, 0, 0); + input_abs_set_res(input, ABS_X, STEAM_JOYSTICK_RESOLUTION); + input_abs_set_res(input, ABS_Y, STEAM_JOYSTICK_RESOLUTION); + input_abs_set_res(input, ABS_RX, STEAM_PAD_RESOLUTION); + input_abs_set_res(input, ABS_RY, STEAM_PAD_RESOLUTION); + input_abs_set_res(input, ABS_HAT1X, STEAM_PAD_RESOLUTION); + input_abs_set_res(input, ABS_HAT1Y, STEAM_PAD_RESOLUTION); + input_abs_set_res(input, ABS_Z, STEAM_TRIGGER_RESOLUTION); + input_abs_set_res(input, ABS_RZ, STEAM_TRIGGER_RESOLUTION); + + ret = input_register_device(input); + if (ret) + goto input_register_fail; + + rcu_assign_pointer(steam->input, input); + + return 0; + +input_register_fail: + input_free_device(input); + return ret; +} + +static void steam_unregister(struct steam_device *steam) +{ + struct input_dev *input; + + rcu_read_lock(); + input = rcu_dereference(steam->input); + rcu_read_unlock(); + + if (input) { + RCU_INIT_POINTER(steam->input, NULL); + synchronize_rcu(); + hid_info(steam->hdev, "Steam Controller disconnected"); + input_unregister_device(input); + } +} + +static void steam_work_connect_cb(struct work_struct *work) +{ + struct steam_device *steam = container_of(work, struct steam_device, + work_connect); + unsigned long flags; + bool connected; + int ret; + + spin_lock_irqsave(&steam->lock, flags); + connected = steam->connected; + spin_unlock_irqrestore(&steam->lock, flags); + + if (connected) { + ret = steam_register(steam); + if (ret) { + hid_err(steam->hdev, + "%s:steam_register failed with error %d\n", + __func__, ret); + return; + } + } else { + steam_unregister(steam); + } +} + +static bool steam_is_valve_interface(struct hid_device *hdev) +{ + struct hid_report_enum *rep_enum; + struct hid_report *hreport; + + /* + * The wired device creates 3 interfaces: + * 0: emulated mouse. + * 1: emulated keyboard. + * 2: the real game pad. + * The wireless device creates 5 interfaces: + * 0: emulated keyboard. + * 1-4: slots where up to 4 real game pads will be connected to. + * We know which one is the real gamepad interface because they are the + * only ones with a feature report. + */ + rep_enum = &hdev->report_enum[HID_FEATURE_REPORT]; + list_for_each_entry(hreport, &rep_enum->report_list, list) { + /* should we check hreport->id == 0? */ + return true; + } + return false; +} + +static int steam_probe(struct hid_device *hdev, + const struct hid_device_id *id) +{ + struct steam_device *steam; + int ret; + + ret = hid_parse(hdev); + if (ret) { + hid_err(hdev, + "%s:parse of hid interface failed\n", __func__); + return ret; + } + + /* + * Connect the HID device so that Steam Controller keeps on working + * without changes. + */ + ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); + if (ret) { + hid_err(hdev, + "%s:hid_hw_start failed with error %d\n", + __func__, ret); + return ret; + } + + if (!steam_is_valve_interface(hdev)) + return 0; + + /* + * From this point on, if anything fails return 0 and ignores + * the error, so that the default HID devices are still bound. + */ + steam = devm_kzalloc(&hdev->dev, + sizeof(struct steam_device), GFP_KERNEL); + if (!steam) { + ret = -ENOMEM; + goto mem_fail; + } + + spin_lock_init(&steam->lock); + steam->hdev = hdev; + hid_set_drvdata(hdev, steam); + steam->quirks = id->driver_data; + INIT_WORK(&steam->work_connect, steam_work_connect_cb); + + if (steam->quirks & STEAM_QUIRK_WIRELESS) { + ret = hid_hw_open(hdev); + if (ret) { + hid_err(hdev, + "%s:hid_hw_open for wireless\n", + __func__); + goto hid_hw_open_fail; + } + hid_info(hdev, "Steam wireless receiver connected"); + } else { + ret = steam_register(steam); + if (ret) { + hid_err(hdev, + "%s:steam_register failed with error %d\n", + __func__, ret); + goto input_register_fail; + } + } + + return 0; + +input_register_fail: +hid_hw_open_fail: + cancel_work_sync(&steam->work_connect); + hid_set_drvdata(hdev, NULL); +mem_fail: + hid_err(hdev, "%s: failed with error %d\n", + __func__, ret); + return 0; +} + +static void steam_remove(struct hid_device *hdev) +{ + struct steam_device *steam = hid_get_drvdata(hdev); + + if (steam && (steam->quirks & STEAM_QUIRK_WIRELESS)) { + hid_info(hdev, "Steam wireless receiver disconnected"); + hid_hw_close(hdev); + } + + hid_hw_stop(hdev); + + if (steam) { + cancel_work_sync(&steam->work_connect); + steam_unregister(steam); + hid_set_drvdata(hdev, NULL); + } +} + +static void steam_do_connect_event(struct steam_device *steam, bool connected) +{ + unsigned long flags; + + spin_lock_irqsave(&steam->lock, flags); + steam->connected = connected; + spin_unlock_irqrestore(&steam->lock, flags); + + if (schedule_work(&steam->work_connect) == 0) + dbg_hid("%s: connected=%d event already queued\n", + __func__, connected); +} + +/* + * The size for this message payload is 60. + * The known values are: + * (* values are not sent through wireless) + * (* accelerator/gyro is disabled by default) + * Offset| Type | Mapped to |Meaning + * -------+-------+-----------+-------------------------- + * 4-7 | u32 | -- | sequence number + * 8-10 | 24bit | see below | buttons + * 11 | u8 | ABS_Z | left trigger + * 12 | u8 | ABS_RZ | right trigger + * 13-15 | -- | -- | always 0 + * 16-17 | s16 | ABS_X | X value + * 18-19 | s16 | ABS_Y | Y value + * 20-21 | s16 | ABS_RX | right-pad X value + * 22-23 | s16 | ABS_RY | right-pad Y value + * 24-25 | s16 | -- | * left trigger + * 26-27 | s16 | -- | * right trigger + * 28-29 | s16 | -- | * accelerometer X value + * 30-31 | s16 | -- | * accelerometer Y value + * 32-33 | s16 | -- | * accelerometer Z value + * 34-35 | s16 | -- | gyro X value + * 36-36 | s16 | -- | gyro Y value + * 38-39 | s16 | -- | gyro Z value + * 40-41 | s16 | -- | quaternion W value + * 42-43 | s16 | -- | quaternion X value + * 44-45 | s16 | -- | quaternion Y value + * 46-47 | s16 | -- | quaternion Z value + * 48-49 | -- | -- | always 0 + * 50-51 | s16 | -- | * left trigger (uncalibrated) + * 52-53 | s16 | -- | * right trigger (uncalibrated) + * 54-55 | s16 | -- | * joystick X value (uncalibrated) + * 56-57 | s16 | -- | * joystick Y value (uncalibrated) + * 58-59 | s16 | -- | * left-pad X value + * 60-61 | s16 | -- | * left-pad Y value + * 62-63 | u16 | -- | * battery voltage + * + * The buttons are: + * Bit | Mapped to | Description + * ------+------------+-------------------------------- + * 8.0 | BTN_TR2 | right trigger fully pressed + * 8.1 | BTN_TL2 | left trigger fully pressed + * 8.2 | BTN_TR | right shoulder + * 8.3 | BTN_TL | left shoulder + * 8.4 | BTN_Y | button Y + * 8.5 | BTN_B | button B + * 8.6 | BTN_X | button X + * 8.7 | BTN_A | button A + * 9.0 | -ABS_HAT0Y | lef-pad up + * 9.1 | +ABS_HAT0X | lef-pad right + * 9.2 | -ABS_HAT0X | lef-pad left + * 9.3 | +ABS_HAT0Y | lef-pad down + * 9.4 | BTN_SELECT | menu left + * 9.5 | BTN_MODE | steam logo + * 9.6 | BTN_START | menu right + * 9.7 | BTN_GEAR_DOWN | left back lever + * 10.0 | BTN_GEAR_UP | right back lever + * 10.1 | -- | left-pad clicked + * 10.2 | BTN_THUMBR | right-pad clicked + * 10.3 | BTN_THUMB | left-pad touched (but see explanation below) + * 10.4 | BTN_THUMB2 | right-pad touched + * 10.5 | -- | unknown + * 10.6 | BTN_THUMBL | joystick clicked + * 10.7 | -- | lpad_and_joy + */ + +static void steam_do_input_event(struct steam_device *steam, + struct input_dev *input, u8 *data) +{ + /* 24 bits of buttons */ + u8 b8, b9, b10; + bool lpad_touched, lpad_and_joy; + + b8 = data[8]; + b9 = data[9]; + b10 = data[10]; + + input_report_abs(input, ABS_Z, data[11]); + input_report_abs(input, ABS_RZ, data[12]); + + /* + * These two bits tells how to interpret the values X and Y. + * lpad_and_joy tells that the joystick and the lpad are used at the + * same time. + * lpad_touched tells whether X/Y are to be read as lpad coord or + * joystick values. + * (lpad_touched || lpad_and_joy) tells if the lpad is really touched. + */ + lpad_touched = b10 & 0x08; + lpad_and_joy = b10 & 0x80; + input_report_abs(input, lpad_touched ? ABS_HAT1X : ABS_X, + (s16) le16_to_cpup((__le16 *)(data + 16))); + input_report_abs(input, lpad_touched ? ABS_HAT1Y : ABS_Y, + -(s16) le16_to_cpup((__le16 *)(data + 18))); + /* Check if joystick is centered */ + if (lpad_touched && !lpad_and_joy) { + input_report_abs(input, ABS_X, 0); + input_report_abs(input, ABS_Y, 0); + } + /* Check if lpad is untouched */ + if (!(lpad_touched || lpad_and_joy)) { + input_report_abs(input, ABS_HAT1X, 0); + input_report_abs(input, ABS_HAT1Y, 0); + } + + input_report_abs(input, ABS_RX, + (s16) le16_to_cpup((__le16 *)(data + 20))); + input_report_abs(input, ABS_RY, + -(s16) le16_to_cpup((__le16 *)(data + 22))); + + input_event(input, EV_KEY, BTN_TR2, !!(b8 & 0x01)); + input_event(input, EV_KEY, BTN_TL2, !!(b8 & 0x02)); + input_event(input, EV_KEY, BTN_TR, !!(b8 & 0x04)); + input_event(input, EV_KEY, BTN_TL, !!(b8 & 0x08)); + input_event(input, EV_KEY, BTN_Y, !!(b8 & 0x10)); + input_event(input, EV_KEY, BTN_B, !!(b8 & 0x20)); + input_event(input, EV_KEY, BTN_X, !!(b8 & 0x40)); + input_event(input, EV_KEY, BTN_A, !!(b8 & 0x80)); + input_event(input, EV_KEY, BTN_SELECT, !!(b9 & 0x10)); + input_event(input, EV_KEY, BTN_MODE, !!(b9 & 0x20)); + input_event(input, EV_KEY, BTN_START, !!(b9 & 0x40)); + input_event(input, EV_KEY, BTN_GEAR_DOWN, !!(b9 & 0x80)); + input_event(input, EV_KEY, BTN_GEAR_UP, !!(b10 & 0x01)); + input_event(input, EV_KEY, BTN_THUMBR, !!(b10 & 0x04)); + input_event(input, EV_KEY, BTN_THUMBL, !!(b10 & 0x40)); + input_event(input, EV_KEY, BTN_THUMB, lpad_touched || lpad_and_joy); + input_event(input, EV_KEY, BTN_THUMB2, !!(b10 & 0x10)); + + input_report_abs(input, ABS_HAT0X, + !!(b9 & 0x02) - !!(b9 & 0x04)); + input_report_abs(input, ABS_HAT0Y, + !!(b9 & 0x08) - !!(b9 & 0x01)); + + input_sync(input); +} + +static int steam_raw_event(struct hid_device *hdev, + struct hid_report *report, u8 *data, + int size) +{ + struct steam_device *steam = hid_get_drvdata(hdev); + struct input_dev *input; + + if (!steam) + return 0; + + /* + * All messages are size=64, all values little-endian. + * The format is: + * Offset| Meaning + * -------+-------------------------------------------- + * 0-1 | always 0x01, 0x00, maybe protocol version? + * 2 | type of message + * 3 | length of the real payload (not checked) + * 4-n | payload data, depends on the type + * + * There are these known types of message: + * 0x01: input data (60 bytes) + * 0x03: wireless connect/disconnect (1 byte) + * 0x04: battery status (11 bytes) + */ + + if (size != 64 || data[0] != 1 || data[1] != 0) + return 0; + + switch (data[2]) { + case 0x01: + rcu_read_lock(); + input = rcu_dereference(steam->input); + if (likely(input)) { + steam_do_input_event(steam, input, data); + } else { + dbg_hid("%s: input data without connect event\n", + __func__); + steam_do_connect_event(steam, true); + } + rcu_read_unlock(); + break; + case 0x03: + /* + * The payload of this event is a single byte: + * 0x01: disconnected. + * 0x02: connected. + */ + switch (data[4]) { + case 0x01: + steam_do_connect_event(steam, false); + break; + case 0x02: + steam_do_connect_event(steam, true); + break; + } + break; + case 0x04: + /* TODO battery status */ + break; + } + return 0; +} + +static const struct hid_device_id steam_controllers[] = { + { /* Wired Steam Controller */ + HID_USB_DEVICE(USB_VENDOR_ID_VALVE, + USB_DEVICE_ID_STEAM_CONTROLLER) + }, + { /* Wireless Steam Controller */ + HID_USB_DEVICE(USB_VENDOR_ID_VALVE, + USB_DEVICE_ID_STEAM_CONTROLLER_WIRELESS), + .driver_data = STEAM_QUIRK_WIRELESS + }, + {} +}; + +MODULE_DEVICE_TABLE(hid, steam_controllers); + +static struct hid_driver steam_controller_driver = { + .name = "hid-steam", + .id_table = steam_controllers, + .probe = steam_probe, + .remove = steam_remove, + .raw_event = steam_raw_event, +}; + +module_hid_driver(steam_controller_driver);
There are two ways to connect the Steam Controller: directly to the USB or with the USB wireless adapter. Both methods are similar, but the wireless adapter can connect up to 4 devices at the same time. The wired device will appear as 3 interfaces: a virtual mouse, a virtual keyboard and a custom HID device. The wireless device will appear as 5 interfaces: a virtual keyboard and 4 custom HID devices, that will remain silent until a device is actually connected. The custom HID device has a report descriptor with all vendor specific usages, so the hid-generic is not very useful. In a PC/SteamBox Valve Steam Client provices a software translation by using direct USB access and a creates a uinput virtual gamepad. This driver was reverse engineered to provide direct kernel support in case you cannot, or do not want to, use Valve Steam Client. It disables the virtual keyboard and mouse, as they are not so useful when you have a working gamepad. Working: buttons, axes, pads, wireless connect/disconnect. TO-DO: Battery, force-feedback, accelerometer/gyro, led, beeper... Signed-off-by: Rodrigo Rivas Costa <rodrigorivascosta@gmail.com> --- drivers/hid/Kconfig | 8 + drivers/hid/Makefile | 1 + drivers/hid/hid-ids.h | 4 + drivers/hid/hid-steam.c | 544 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 557 insertions(+) create mode 100644 drivers/hid/hid-steam.c