| Message ID | 20201219062336.72568-2-roderick@gaikai.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | HID: new driver for PS5 'DualSense' controller | expand |
Hi 2020. december 19., szombat 7:23 keltezéssel, Roderick Colenbrander írta: > [...] > diff --git a/drivers/hid/hid-playstation.c b/drivers/hid/hid-playstation.c > new file mode 100644 > index 000000000000..8dbd0ae7e082 > --- /dev/null > +++ b/drivers/hid/hid-playstation.c > @@ -0,0 +1,317 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * HID driver for Sony DualSense(TM) controller. > + * > + * Copyright (c) 2020 Sony Interactive Entertainment > + */ > + > +#include <linux/device.h> > +#include <linux/hid.h> > +#include <linux/input/mt.h> > +#include <linux/module.h> > +#include <linux/crc32.h> > +#include <asm/unaligned.h> > + I believe it would be preferable to keep the list of includes lexicographically sorted. > +#include "hid-ids.h" > + > +/* Base class for playstation devices. */ > +struct ps_device { > + struct hid_device *hdev; > + > + int (*parse_report)(struct ps_device *dev, struct hid_report *report, u8 *data, int size); > +}; > + > +#define DS_INPUT_REPORT_USB 0x01 > + > +/* Button masks for DualSense input report. */ > +#define DS_BUTTONS0_HAT_SWITCH GENMASK(3, 0) > +#define DS_BUTTONS0_SQUARE BIT(4) > +#define DS_BUTTONS0_CROSS BIT(5) > +#define DS_BUTTONS0_CIRCLE BIT(6) > +#define DS_BUTTONS0_TRIANGLE BIT(7) > +#define DS_BUTTONS1_L1 BIT(0) > +#define DS_BUTTONS1_R1 BIT(1) > +#define DS_BUTTONS1_L2 BIT(2) > +#define DS_BUTTONS1_R2 BIT(3) > +#define DS_BUTTONS1_CREATE BIT(4) > +#define DS_BUTTONS1_OPTIONS BIT(5) > +#define DS_BUTTONS1_L3 BIT(6) > +#define DS_BUTTONS1_R3 BIT(7) > +#define DS_BUTTONS2_PS_HOME BIT(0) > +#define DS_BUTTONS2_TOUCHPAD BIT(1) I believe it would be preferable to explicitly include everything you need and not to count on other headers indirectly including it for you. In this case `linux/bits.h` is not included. > [...] > +/* Common gamepad buttons across DualShock 3 / 4 and DualSense. > + * Note: for device with a touchpad, touchpad button is not included > + * as it will be part of the touchpad device. > + */ > +static int ps_gamepad_buttons[] = { Any reason why it's not `const`? > + BTN_WEST, /* Square */ > + BTN_NORTH, /* Triangle */ > + BTN_EAST, /* Circle */ > + BTN_SOUTH, /* Cross */ > + BTN_TL, /* L1 */ > + BTN_TR, /* R1 */ > + BTN_TL2, /* L2 */ > + BTN_TR2, /* R2 */ > + BTN_SELECT, /* Create (PS5) / Share (PS4) */ > + BTN_START, /* Option */ > + BTN_THUMBL, /* L3 */ > + BTN_THUMBR, /* R3 */ > + BTN_MODE, /* PS Home */ > +}; > [...] > +static struct input_dev *ps_allocate_input_dev(struct hid_device *hdev, const char *name_suffix) > +{ > + struct input_dev *input_dev; > + > + input_dev = devm_input_allocate_device(&hdev->dev); > + if (!input_dev) > + return ERR_PTR(-ENOMEM); > + > + input_dev->id.bustype = hdev->bus; > + input_dev->id.vendor = hdev->vendor; > + input_dev->id.product = hdev->product; > + input_dev->id.version = hdev->version; > + input_dev->uniq = hdev->uniq; > + > + if (name_suffix) { > + input_dev->name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s %s", hdev->name, > + name_suffix); > + if (!input_dev->name) > + return ERR_PTR(-ENOMEM); > + } else > + input_dev->name = hdev->name; > + As per [1], please use braces around the body of the `else`. > + input_set_drvdata(input_dev, hdev); > + > + return input_dev; > +} > [...] > +static int dualsense_parse_report(struct ps_device *ps_dev, struct hid_report *report, > + u8 *data, int size) > +{ > + struct hid_device *hdev = ps_dev->hdev; > + struct dualsense *ds = (struct dualsense *)ps_dev; I believe `container_of(ps_dev, struct dualsense, base)` would be preferable here (and everywhere this pattern emerges). > + struct dualsense_input_report *ds_report; > + uint8_t value; > + > + /* DualSense in USB uses the full HID report for reportID 1, but > + * Bluetooth uses a minimal HID report for reportID 1 and reports > + * the full report using reportID 49. > + */ > + if (report->id == DS_INPUT_REPORT_USB && hdev->bus == BUS_USB) { > + ds_report = (struct dualsense_input_report *)&data[1]; > + } else { > + hid_err(hdev, "Unhandled reportID=%d\n", report->id); > + return -1; > + } > + > + input_report_abs(ds->gamepad, ABS_X, ds_report->x); > + input_report_abs(ds->gamepad, ABS_Y, ds_report->y); > + input_report_abs(ds->gamepad, ABS_RX, ds_report->rx); > + input_report_abs(ds->gamepad, ABS_RY, ds_report->ry); > + input_report_abs(ds->gamepad, ABS_Z, ds_report->z); > + input_report_abs(ds->gamepad, ABS_RZ, ds_report->rz); > + > + value = ds_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; > + if (value > 7) > + value = 8; /* center */ > + input_report_abs(ds->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); > + input_report_abs(ds->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); > + > + input_report_key(ds->gamepad, BTN_WEST, ds_report->buttons[0] & DS_BUTTONS0_SQUARE); > + input_report_key(ds->gamepad, BTN_SOUTH, ds_report->buttons[0] & DS_BUTTONS0_CROSS); > + input_report_key(ds->gamepad, BTN_EAST, ds_report->buttons[0] & DS_BUTTONS0_CIRCLE); > + input_report_key(ds->gamepad, BTN_NORTH, ds_report->buttons[0] & DS_BUTTONS0_TRIANGLE); > + input_report_key(ds->gamepad, BTN_TL, ds_report->buttons[1] & DS_BUTTONS1_L1); > + input_report_key(ds->gamepad, BTN_TR, ds_report->buttons[1] & DS_BUTTONS1_R1); > + input_report_key(ds->gamepad, BTN_TL2, ds_report->buttons[1] & DS_BUTTONS1_L2); > + input_report_key(ds->gamepad, BTN_TR2, ds_report->buttons[1] & DS_BUTTONS1_R2); > + input_report_key(ds->gamepad, BTN_SELECT, ds_report->buttons[1] & DS_BUTTONS1_CREATE); > + input_report_key(ds->gamepad, BTN_START, ds_report->buttons[1] & DS_BUTTONS1_OPTIONS); > + input_report_key(ds->gamepad, BTN_THUMBL, ds_report->buttons[1] & DS_BUTTONS1_L3); > + input_report_key(ds->gamepad, BTN_THUMBR, ds_report->buttons[1] & DS_BUTTONS1_R3); > + input_report_key(ds->gamepad, BTN_MODE, ds_report->buttons[2] & DS_BUTTONS2_PS_HOME); Possibly this could be replaced with a loop? I have something like this in mind: ``` struct ps_gamepad_button { unsigned int code; uint8_t button_idx; uint8_t mask; } ps_gamepad_buttons[] = {...}; for (...) { struct ps_gamepad_button *b = ...; input_report_key(...); } ``` Or is there any reason why the unrolled version is preffered that I'm missing? > + input_sync(ds->gamepad); > + > + return 0; > +} > + > +static struct ps_device *dualsense_create(struct hid_device *hdev) > +{ > + struct dualsense *ds; > + int ret; > + > + ds = devm_kzalloc(&hdev->dev, sizeof(*ds), GFP_KERNEL); > + if (!ds) > + return ERR_PTR(-ENOMEM); > + > + /* Patch version to allow userspace to distinguish between > + * hid-generic vs hid-playstation axis and button mapping. > + */ > + hdev->version |= 0x8000; Maybe that '0x8000' could be given a name? > + > + ds->base.hdev = hdev; > + ds->base.parse_report = dualsense_parse_report; > + hid_set_drvdata(hdev, ds); > + > + ds->gamepad = ps_gamepad_create(hdev); > + if (IS_ERR(ds->gamepad)) { > + ret = PTR_ERR(ds->gamepad); > + goto err; > + } > + > + return (struct ps_device *)ds; I believe using `&ds->base` instead of `(struct ps_device *)ds` would be somewhat better as it does not subvert the type system as much. > + > +err: > + return ERR_PTR(ret); > +} > + > +static int ps_raw_event(struct hid_device *hdev, struct hid_report *report, > + u8 *data, int size) > +{ > + struct ps_device *dev = hid_get_drvdata(hdev); > + > + if (dev && dev->parse_report) > + return dev->parse_report(dev, report, data, size); > + > + return 0; > +} > + > +static int ps_probe(struct hid_device *hdev, const struct hid_device_id *id) > +{ > + struct ps_device *dev; > + int ret; > + > + ret = hid_parse(hdev); > + if (ret) { > + hid_err(hdev, "parse failed\n"); > + return ret; > + } > + > + ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); > + if (ret) { > + hid_err(hdev, "hw start failed\n"); > + return ret; > + } > + > + ret = hid_hw_open(hdev); > + if (ret) { > + hid_err(hdev, "hw open failed\n"); > + goto err_stop; > + } > + > + if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER) { > + dev = dualsense_create(hdev); > + if (IS_ERR(dev)) { > + hid_err(hdev, "Failed to create dualsense.\n"); > + ret = PTR_ERR(dev); > + goto err_close; > + } > + } else { When would this be possible? > + hid_err(hdev, "Unhandled device\n"); > + ret = -EINVAL; Assuming it's possible, I believe `-ENODEV` is a better error code here. > + goto err_close; > + } > + > + return ret; > + > +err_close: > + hid_hw_close(hdev); > +err_stop: > + hid_hw_stop(hdev); > + return ret; > +} > [...] > +static const struct hid_device_id ps_devices[] = { > + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER), > + .driver_data = 0 }, > [...] `.driver_data` would be initialized to zero anyways, why is it necessary to do so explicitly? [1]: https://www.kernel.org/doc/html/latest/process/coding-style.html Regards, Barnabás Pőcze
Hi Barnabás, Thanks for your review. On Sun, Dec 27, 2020 at 8:24 AM Barnabás Pőcze <pobrn@protonmail.com> wrote: > > Hi > > > 2020. december 19., szombat 7:23 keltezéssel, Roderick Colenbrander írta: > > > [...] > > diff --git a/drivers/hid/hid-playstation.c b/drivers/hid/hid-playstation.c > > new file mode 100644 > > index 000000000000..8dbd0ae7e082 > > --- /dev/null > > +++ b/drivers/hid/hid-playstation.c > > @@ -0,0 +1,317 @@ > > +// SPDX-License-Identifier: GPL-2.0-or-later > > +/* > > + * HID driver for Sony DualSense(TM) controller. > > + * > > + * Copyright (c) 2020 Sony Interactive Entertainment > > + */ > > + > > +#include <linux/device.h> > > +#include <linux/hid.h> > > +#include <linux/input/mt.h> > > +#include <linux/module.h> > > +#include <linux/crc32.h> > > +#include <asm/unaligned.h> > > + > > I believe it would be preferable to keep the list of includes lexicographically > sorted. > > > > +#include "hid-ids.h" > > + > > +/* Base class for playstation devices. */ > > +struct ps_device { > > + struct hid_device *hdev; > > + > > + int (*parse_report)(struct ps_device *dev, struct hid_report *report, u8 *data, int size); > > +}; > > + > > +#define DS_INPUT_REPORT_USB 0x01 > > + > > +/* Button masks for DualSense input report. */ > > +#define DS_BUTTONS0_HAT_SWITCH GENMASK(3, 0) > > +#define DS_BUTTONS0_SQUARE BIT(4) > > +#define DS_BUTTONS0_CROSS BIT(5) > > +#define DS_BUTTONS0_CIRCLE BIT(6) > > +#define DS_BUTTONS0_TRIANGLE BIT(7) > > +#define DS_BUTTONS1_L1 BIT(0) > > +#define DS_BUTTONS1_R1 BIT(1) > > +#define DS_BUTTONS1_L2 BIT(2) > > +#define DS_BUTTONS1_R2 BIT(3) > > +#define DS_BUTTONS1_CREATE BIT(4) > > +#define DS_BUTTONS1_OPTIONS BIT(5) > > +#define DS_BUTTONS1_L3 BIT(6) > > +#define DS_BUTTONS1_R3 BIT(7) > > +#define DS_BUTTONS2_PS_HOME BIT(0) > > +#define DS_BUTTONS2_TOUCHPAD BIT(1) > > I believe it would be preferable to explicitly include everything you need > and not to count on other headers indirectly including it for you. In this > case `linux/bits.h` is not included. > > > > [...] > > +/* Common gamepad buttons across DualShock 3 / 4 and DualSense. > > + * Note: for device with a touchpad, touchpad button is not included > > + * as it will be part of the touchpad device. > > + */ > > +static int ps_gamepad_buttons[] = { > > Any reason why it's not `const`? It should be const. > > > > + BTN_WEST, /* Square */ > > + BTN_NORTH, /* Triangle */ > > + BTN_EAST, /* Circle */ > > + BTN_SOUTH, /* Cross */ > > + BTN_TL, /* L1 */ > > + BTN_TR, /* R1 */ > > + BTN_TL2, /* L2 */ > > + BTN_TR2, /* R2 */ > > + BTN_SELECT, /* Create (PS5) / Share (PS4) */ > > + BTN_START, /* Option */ > > + BTN_THUMBL, /* L3 */ > > + BTN_THUMBR, /* R3 */ > > + BTN_MODE, /* PS Home */ > > +}; > > [...] > > +static struct input_dev *ps_allocate_input_dev(struct hid_device *hdev, const char *name_suffix) > > +{ > > + struct input_dev *input_dev; > > + > > + input_dev = devm_input_allocate_device(&hdev->dev); > > + if (!input_dev) > > + return ERR_PTR(-ENOMEM); > > + > > + input_dev->id.bustype = hdev->bus; > > + input_dev->id.vendor = hdev->vendor; > > + input_dev->id.product = hdev->product; > > + input_dev->id.version = hdev->version; > > + input_dev->uniq = hdev->uniq; > > + > > + if (name_suffix) { > > + input_dev->name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s %s", hdev->name, > > + name_suffix); > > + if (!input_dev->name) > > + return ERR_PTR(-ENOMEM); > > + } else > > + input_dev->name = hdev->name; > > + > > As per [1], please use braces around the body of the `else`. > > > > + input_set_drvdata(input_dev, hdev); > > + > > + return input_dev; > > +} > > [...] > > +static int dualsense_parse_report(struct ps_device *ps_dev, struct hid_report *report, > > + u8 *data, int size) > > +{ > > + struct hid_device *hdev = ps_dev->hdev; > > + struct dualsense *ds = (struct dualsense *)ps_dev; > > I believe `container_of(ps_dev, struct dualsense, base)` would be preferable here > (and everywhere this pattern emerges). Agreed. > > > + struct dualsense_input_report *ds_report; > > + uint8_t value; > > + > > + /* DualSense in USB uses the full HID report for reportID 1, but > > + * Bluetooth uses a minimal HID report for reportID 1 and reports > > + * the full report using reportID 49. > > + */ > > + if (report->id == DS_INPUT_REPORT_USB && hdev->bus == BUS_USB) { > > + ds_report = (struct dualsense_input_report *)&data[1]; > > + } else { > > + hid_err(hdev, "Unhandled reportID=%d\n", report->id); > > + return -1; > > + } > > + > > + input_report_abs(ds->gamepad, ABS_X, ds_report->x); > > + input_report_abs(ds->gamepad, ABS_Y, ds_report->y); > > + input_report_abs(ds->gamepad, ABS_RX, ds_report->rx); > > + input_report_abs(ds->gamepad, ABS_RY, ds_report->ry); > > + input_report_abs(ds->gamepad, ABS_Z, ds_report->z); > > + input_report_abs(ds->gamepad, ABS_RZ, ds_report->rz); > > + > > + value = ds_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; > > + if (value > 7) > > + value = 8; /* center */ > > + input_report_abs(ds->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); > > + input_report_abs(ds->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); > > + > > + input_report_key(ds->gamepad, BTN_WEST, ds_report->buttons[0] & DS_BUTTONS0_SQUARE); > > + input_report_key(ds->gamepad, BTN_SOUTH, ds_report->buttons[0] & DS_BUTTONS0_CROSS); > > + input_report_key(ds->gamepad, BTN_EAST, ds_report->buttons[0] & DS_BUTTONS0_CIRCLE); > > + input_report_key(ds->gamepad, BTN_NORTH, ds_report->buttons[0] & DS_BUTTONS0_TRIANGLE); > > + input_report_key(ds->gamepad, BTN_TL, ds_report->buttons[1] & DS_BUTTONS1_L1); > > + input_report_key(ds->gamepad, BTN_TR, ds_report->buttons[1] & DS_BUTTONS1_R1); > > + input_report_key(ds->gamepad, BTN_TL2, ds_report->buttons[1] & DS_BUTTONS1_L2); > > + input_report_key(ds->gamepad, BTN_TR2, ds_report->buttons[1] & DS_BUTTONS1_R2); > > + input_report_key(ds->gamepad, BTN_SELECT, ds_report->buttons[1] & DS_BUTTONS1_CREATE); > > + input_report_key(ds->gamepad, BTN_START, ds_report->buttons[1] & DS_BUTTONS1_OPTIONS); > > + input_report_key(ds->gamepad, BTN_THUMBL, ds_report->buttons[1] & DS_BUTTONS1_L3); > > + input_report_key(ds->gamepad, BTN_THUMBR, ds_report->buttons[1] & DS_BUTTONS1_R3); > > + input_report_key(ds->gamepad, BTN_MODE, ds_report->buttons[2] & DS_BUTTONS2_PS_HOME); > > Possibly this could be replaced with a loop? I have something like this in mind: > > ``` > struct ps_gamepad_button { > unsigned int code; > uint8_t button_idx; > uint8_t mask; > } ps_gamepad_buttons[] = {...}; > > for (...) { > struct ps_gamepad_button *b = ...; > input_report_key(...); > } > ``` > > Or is there any reason why the unrolled version is preffered that I'm missing? It can be done from a loop. Main reason for unrolled was that it is actually less code and potentially a tiny bit faster, but I bet a compiler would have unrolled it anyway. I don't know what I want to do here. Being explicit feels nice (other drivers do something similar). > > > + input_sync(ds->gamepad); > > + > > + return 0; > > +} > > + > > +static struct ps_device *dualsense_create(struct hid_device *hdev) > > +{ > > + struct dualsense *ds; > > + int ret; > > + > > + ds = devm_kzalloc(&hdev->dev, sizeof(*ds), GFP_KERNEL); > > + if (!ds) > > + return ERR_PTR(-ENOMEM); > > + > > + /* Patch version to allow userspace to distinguish between > > + * hid-generic vs hid-playstation axis and button mapping. > > + */ > > + hdev->version |= 0x8000; > > Maybe that '0x8000' could be given a name? Will do so. Calling it for now 'HID_PLAYSTATION_VERSION_PATCH' or something like that. > > > > + > > + ds->base.hdev = hdev; > > + ds->base.parse_report = dualsense_parse_report; > > + hid_set_drvdata(hdev, ds); > > + > > + ds->gamepad = ps_gamepad_create(hdev); > > + if (IS_ERR(ds->gamepad)) { > > + ret = PTR_ERR(ds->gamepad); > > + goto err; > > + } > > + > > + return (struct ps_device *)ds; > > I believe using `&ds->base` instead of `(struct ps_device *)ds` would be somewhat > better as it does not subvert the type system as much. Thanks, yeah that's cleaner. > > > > + > > +err: > > + return ERR_PTR(ret); > > +} > > + > > +static int ps_raw_event(struct hid_device *hdev, struct hid_report *report, > > + u8 *data, int size) > > +{ > > + struct ps_device *dev = hid_get_drvdata(hdev); > > + > > + if (dev && dev->parse_report) > > + return dev->parse_report(dev, report, data, size); > > + > > + return 0; > > +} > > + > > +static int ps_probe(struct hid_device *hdev, const struct hid_device_id *id) > > +{ > > + struct ps_device *dev; > > + int ret; > > + > > + ret = hid_parse(hdev); > > + if (ret) { > > + hid_err(hdev, "parse failed\n"); > > + return ret; > > + } > > + > > + ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); > > + if (ret) { > > + hid_err(hdev, "hw start failed\n"); > > + return ret; > > + } > > + > > + ret = hid_hw_open(hdev); > > + if (ret) { > > + hid_err(hdev, "hw open failed\n"); > > + goto err_stop; > > + } > > + > > + if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER) { > > + dev = dualsense_create(hdev); > > + if (IS_ERR(dev)) { > > + hid_err(hdev, "Failed to create dualsense.\n"); > > + ret = PTR_ERR(dev); > > + goto err_close; > > + } > > + } else { > > When would this be possible? It isn't possible right now. A colleague really wanted me to add (I originally didn't have it in an internal build), but I don't mind taking it out. > > > > + hid_err(hdev, "Unhandled device\n"); > > + ret = -EINVAL; > > Assuming it's possible, I believe `-ENODEV` is a better error code here. > > > > + goto err_close; > > + } > > + > > + return ret; > > + > > +err_close: > > + hid_hw_close(hdev); > > +err_stop: > > + hid_hw_stop(hdev); > > + return ret; > > +} > > [...] > > +static const struct hid_device_id ps_devices[] = { > > + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER), > > + .driver_data = 0 }, > > [...] > > `.driver_data` would be initialized to zero anyways, why is it necessary to do > so explicitly? It is not needed. > > > [1]: https://www.kernel.org/doc/html/latest/process/coding-style.html > > > Regards, > Barnabás Pőcze Regards, Roderick
2020. december 28., hétfő 0:04 keltezéssel, Roderick Colenbrander írta: > [...] > > > + struct dualsense_input_report *ds_report; > > > + uint8_t value; > > > + > > > + /* DualSense in USB uses the full HID report for reportID 1, but > > > + * Bluetooth uses a minimal HID report for reportID 1 and reports > > > + * the full report using reportID 49. > > > + */ > > > + if (report->id == DS_INPUT_REPORT_USB && hdev->bus == BUS_USB) { > > > + ds_report = (struct dualsense_input_report *)&data[1]; > > > + } else { > > > + hid_err(hdev, "Unhandled reportID=%d\n", report->id); > > > + return -1; > > > + } > > > + > > > + input_report_abs(ds->gamepad, ABS_X, ds_report->x); > > > + input_report_abs(ds->gamepad, ABS_Y, ds_report->y); > > > + input_report_abs(ds->gamepad, ABS_RX, ds_report->rx); > > > + input_report_abs(ds->gamepad, ABS_RY, ds_report->ry); > > > + input_report_abs(ds->gamepad, ABS_Z, ds_report->z); > > > + input_report_abs(ds->gamepad, ABS_RZ, ds_report->rz); > > > + > > > + value = ds_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; > > > + if (value > 7) > > > + value = 8; /* center */ > > > + input_report_abs(ds->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); > > > + input_report_abs(ds->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); > > > + > > > + input_report_key(ds->gamepad, BTN_WEST, ds_report->buttons[0] & DS_BUTTONS0_SQUARE); > > > + input_report_key(ds->gamepad, BTN_SOUTH, ds_report->buttons[0] & DS_BUTTONS0_CROSS); > > > + input_report_key(ds->gamepad, BTN_EAST, ds_report->buttons[0] & DS_BUTTONS0_CIRCLE); > > > + input_report_key(ds->gamepad, BTN_NORTH, ds_report->buttons[0] & DS_BUTTONS0_TRIANGLE); > > > + input_report_key(ds->gamepad, BTN_TL, ds_report->buttons[1] & DS_BUTTONS1_L1); > > > + input_report_key(ds->gamepad, BTN_TR, ds_report->buttons[1] & DS_BUTTONS1_R1); > > > + input_report_key(ds->gamepad, BTN_TL2, ds_report->buttons[1] & DS_BUTTONS1_L2); > > > + input_report_key(ds->gamepad, BTN_TR2, ds_report->buttons[1] & DS_BUTTONS1_R2); > > > + input_report_key(ds->gamepad, BTN_SELECT, ds_report->buttons[1] & DS_BUTTONS1_CREATE); > > > + input_report_key(ds->gamepad, BTN_START, ds_report->buttons[1] & DS_BUTTONS1_OPTIONS); > > > + input_report_key(ds->gamepad, BTN_THUMBL, ds_report->buttons[1] & DS_BUTTONS1_L3); > > > + input_report_key(ds->gamepad, BTN_THUMBR, ds_report->buttons[1] & DS_BUTTONS1_R3); > > > + input_report_key(ds->gamepad, BTN_MODE, ds_report->buttons[2] & DS_BUTTONS2_PS_HOME); > > > > Possibly this could be replaced with a loop? I have something like this in mind: > > > > ``` > > struct ps_gamepad_button { > > unsigned int code; > > uint8_t button_idx; > > uint8_t mask; > > } ps_gamepad_buttons[] = {...}; > > > > for (...) { > > struct ps_gamepad_button *b = ...; > > input_report_key(...); > > } > > ``` > > > > Or is there any reason why the unrolled version is preffered that I'm missing? > > It can be done from a loop. Main reason for unrolled was that it is > actually less code and potentially a tiny bit faster, but I bet a > compiler would have unrolled it anyway. I don't know what I want to do > here. Being explicit feels nice (other drivers do something similar). > [...] I agree that the compiler would've probably unrolled it. I'd personally consider the loop version to be shorter as I'd not consider the static array "code" - it's really just data initialization. Anyways, may I suggest then to align the parameters so that the given parameter of each call starts in the same column? I think it helps readability a good deal.
Hi 2020. december 19., szombat 7:23 keltezéssel, Roderick Colenbrander írta: > [...] > +static const struct hid_device_id ps_devices[] = { > + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER), > + .driver_data = 0 }, > +}; > [...] I have come across an AUR package [1], and looking at the modifications applied there (work-without-modifying-hid-quirks.patch), I think should be a terminating entry in this array. And maybe `MODULE_DEVICE_TABLE()` is also missing? [1]: https://aur.archlinux.org/packages/hid-playstation-dkms/ Regards, Barnabás Pőcze
Hi Barnabás, On Wed, Dec 30, 2020 at 4:08 PM Barnabás Pőcze <pobrn@protonmail.com> wrote: > > Hi > > > 2020. december 19., szombat 7:23 keltezéssel, Roderick Colenbrander írta: > > > [...] > > +static const struct hid_device_id ps_devices[] = { > > + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER), > > + .driver_data = 0 }, > > +}; > > [...] > > I have come across an AUR package [1], and looking at the modifications applied > there (work-without-modifying-hid-quirks.patch), I think should be a terminating > entry in this array. And maybe `MODULE_DEVICE_TABLE()` is also missing? > > [1]: https://aur.archlinux.org/packages/hid-playstation-dkms/ > > > Regards, > Barnabás Pőcze Good catch, that's indeed missing. I wonder how I didn't stumble on that (I used an unmodified kernel here and loaded it out of tree). In any case I will add it and use it in revision 2. Regards, Roderick
diff --git a/MAINTAINERS b/MAINTAINERS index f81d598a8556..0ecae30af074 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7918,6 +7918,12 @@ F: drivers/hid/ F: include/linux/hid* F: include/uapi/linux/hid* +HID PLAYSTATION DRIVER +M: Roderick Colenbrander <roderick.colenbrander@sony.com> +L: linux-input@vger.kernel.org +S: Supported +F: drivers/hid/hid-playstation.c + HID SENSOR HUB DRIVERS M: Jiri Kosina <jikos@kernel.org> M: Jonathan Cameron <jic23@kernel.org> diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index 7bdda1b5b221..d3258e806998 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -853,6 +853,15 @@ config HID_PLANTRONICS Say M here if you may ever plug in a Plantronics USB audio device. +config HID_PLAYSTATION + tristate "PlayStation HID Driver" + default !EXPERT + depends on HID + help + Provides support for Sony PS5 controllers including support for + its special functionalities e.g. touchpad, lights and motion + sensors. + config HID_PRIMAX tristate "Primax non-fully HID-compliant devices" depends on HID diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index 014d21fe7dac..3cdbfb60ca57 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -94,6 +94,7 @@ hid-picolcd-$(CONFIG_HID_PICOLCD_CIR) += hid-picolcd_cir.o hid-picolcd-$(CONFIG_DEBUG_FS) += hid-picolcd_debugfs.o obj-$(CONFIG_HID_PLANTRONICS) += hid-plantronics.o +obj-$(CONFIG_HID_PLAYSTATION) += hid-playstation.o obj-$(CONFIG_HID_PRIMAX) += hid-primax.o obj-$(CONFIG_HID_REDRAGON) += hid-redragon.o obj-$(CONFIG_HID_RETRODE) += hid-retrode.o diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h index 4c5f23640f9c..70c51ec6395c 100644 --- a/drivers/hid/hid-ids.h +++ b/drivers/hid/hid-ids.h @@ -1072,6 +1072,7 @@ #define USB_DEVICE_ID_SONY_PS4_CONTROLLER 0x05c4 #define USB_DEVICE_ID_SONY_PS4_CONTROLLER_2 0x09cc #define USB_DEVICE_ID_SONY_PS4_CONTROLLER_DONGLE 0x0ba0 +#define USB_DEVICE_ID_SONY_PS5_CONTROLLER 0x0ce6 #define USB_DEVICE_ID_SONY_MOTION_CONTROLLER 0x03d5 #define USB_DEVICE_ID_SONY_NAVIGATION_CONTROLLER 0x042f #define USB_DEVICE_ID_SONY_BUZZ_CONTROLLER 0x0002 diff --git a/drivers/hid/hid-playstation.c b/drivers/hid/hid-playstation.c new file mode 100644 index 000000000000..8dbd0ae7e082 --- /dev/null +++ b/drivers/hid/hid-playstation.c @@ -0,0 +1,317 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * HID driver for Sony DualSense(TM) controller. + * + * Copyright (c) 2020 Sony Interactive Entertainment + */ + +#include <linux/device.h> +#include <linux/hid.h> +#include <linux/input/mt.h> +#include <linux/module.h> +#include <linux/crc32.h> +#include <asm/unaligned.h> + +#include "hid-ids.h" + +/* Base class for playstation devices. */ +struct ps_device { + struct hid_device *hdev; + + int (*parse_report)(struct ps_device *dev, struct hid_report *report, u8 *data, int size); +}; + +#define DS_INPUT_REPORT_USB 0x01 + +/* Button masks for DualSense input report. */ +#define DS_BUTTONS0_HAT_SWITCH GENMASK(3, 0) +#define DS_BUTTONS0_SQUARE BIT(4) +#define DS_BUTTONS0_CROSS BIT(5) +#define DS_BUTTONS0_CIRCLE BIT(6) +#define DS_BUTTONS0_TRIANGLE BIT(7) +#define DS_BUTTONS1_L1 BIT(0) +#define DS_BUTTONS1_R1 BIT(1) +#define DS_BUTTONS1_L2 BIT(2) +#define DS_BUTTONS1_R2 BIT(3) +#define DS_BUTTONS1_CREATE BIT(4) +#define DS_BUTTONS1_OPTIONS BIT(5) +#define DS_BUTTONS1_L3 BIT(6) +#define DS_BUTTONS1_R3 BIT(7) +#define DS_BUTTONS2_PS_HOME BIT(0) +#define DS_BUTTONS2_TOUCHPAD BIT(1) + +struct dualsense { + struct ps_device base; + struct input_dev *gamepad; +}; + +struct dualsense_touch_point { + uint8_t contact; + uint8_t x_lo; + uint8_t x_hi:4, y_lo:4; + uint8_t y_hi; +} __packed; + +/* Main DualSense input report excluding any BT/USB specific headers. */ +struct dualsense_input_report { + uint8_t x, y; + uint8_t rx, ry; + uint8_t z, rz; + uint8_t seq_number; + uint8_t buttons[4]; + uint8_t reserved[4]; + + /* Motion sensors */ + __le16 gyro[3]; /* x, y, z */ + __le16 accel[3]; /* x, y, z */ + __le32 sensor_timestamp; + uint8_t reserved2; + + /* Touchpad */ + struct dualsense_touch_point points[2]; + + uint8_t reserved3[12]; + uint8_t status; + uint8_t reserved4[11]; +} __packed; + +/* Common gamepad buttons across DualShock 3 / 4 and DualSense. + * Note: for device with a touchpad, touchpad button is not included + * as it will be part of the touchpad device. + */ +static int ps_gamepad_buttons[] = { + BTN_WEST, /* Square */ + BTN_NORTH, /* Triangle */ + BTN_EAST, /* Circle */ + BTN_SOUTH, /* Cross */ + BTN_TL, /* L1 */ + BTN_TR, /* R1 */ + BTN_TL2, /* L2 */ + BTN_TR2, /* R2 */ + BTN_SELECT, /* Create (PS5) / Share (PS4) */ + BTN_START, /* Option */ + BTN_THUMBL, /* L3 */ + BTN_THUMBR, /* R3 */ + BTN_MODE, /* PS Home */ +}; + +static const struct {int x; int y; } ps_gamepad_hat_mapping[] = { + {0, -1}, {1, -1}, {1, 0}, {1, 1}, {0, 1}, {-1, 1}, {-1, 0}, {-1, -1}, + {0, 0} +}; + +static struct input_dev *ps_allocate_input_dev(struct hid_device *hdev, const char *name_suffix) +{ + struct input_dev *input_dev; + + input_dev = devm_input_allocate_device(&hdev->dev); + if (!input_dev) + return ERR_PTR(-ENOMEM); + + input_dev->id.bustype = hdev->bus; + input_dev->id.vendor = hdev->vendor; + input_dev->id.product = hdev->product; + input_dev->id.version = hdev->version; + input_dev->uniq = hdev->uniq; + + if (name_suffix) { + input_dev->name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s %s", hdev->name, + name_suffix); + if (!input_dev->name) + return ERR_PTR(-ENOMEM); + } else + input_dev->name = hdev->name; + + input_set_drvdata(input_dev, hdev); + + return input_dev; +} + +static struct input_dev *ps_gamepad_create(struct hid_device *hdev) +{ + struct input_dev *gamepad; + unsigned int i; + int ret; + + gamepad = ps_allocate_input_dev(hdev, NULL); + if (IS_ERR(gamepad)) + return ERR_PTR(-ENOMEM); + + input_set_abs_params(gamepad, ABS_X, 0, 255, 0, 0); + input_set_abs_params(gamepad, ABS_Y, 0, 255, 0, 0); + input_set_abs_params(gamepad, ABS_Z, 0, 255, 0, 0); + input_set_abs_params(gamepad, ABS_RX, 0, 255, 0, 0); + input_set_abs_params(gamepad, ABS_RY, 0, 255, 0, 0); + input_set_abs_params(gamepad, ABS_RZ, 0, 255, 0, 0); + + input_set_abs_params(gamepad, ABS_HAT0X, -1, 1, 0, 0); + input_set_abs_params(gamepad, ABS_HAT0Y, -1, 1, 0, 0); + + for (i = 0; i < ARRAY_SIZE(ps_gamepad_buttons); i++) + input_set_capability(gamepad, EV_KEY, ps_gamepad_buttons[i]); + + ret = input_register_device(gamepad); + if (ret) + return ERR_PTR(ret); + + return gamepad; +} + +static int dualsense_parse_report(struct ps_device *ps_dev, struct hid_report *report, + u8 *data, int size) +{ + struct hid_device *hdev = ps_dev->hdev; + struct dualsense *ds = (struct dualsense *)ps_dev; + struct dualsense_input_report *ds_report; + uint8_t value; + + /* DualSense in USB uses the full HID report for reportID 1, but + * Bluetooth uses a minimal HID report for reportID 1 and reports + * the full report using reportID 49. + */ + if (report->id == DS_INPUT_REPORT_USB && hdev->bus == BUS_USB) { + ds_report = (struct dualsense_input_report *)&data[1]; + } else { + hid_err(hdev, "Unhandled reportID=%d\n", report->id); + return -1; + } + + input_report_abs(ds->gamepad, ABS_X, ds_report->x); + input_report_abs(ds->gamepad, ABS_Y, ds_report->y); + input_report_abs(ds->gamepad, ABS_RX, ds_report->rx); + input_report_abs(ds->gamepad, ABS_RY, ds_report->ry); + input_report_abs(ds->gamepad, ABS_Z, ds_report->z); + input_report_abs(ds->gamepad, ABS_RZ, ds_report->rz); + + value = ds_report->buttons[0] & DS_BUTTONS0_HAT_SWITCH; + if (value > 7) + value = 8; /* center */ + input_report_abs(ds->gamepad, ABS_HAT0X, ps_gamepad_hat_mapping[value].x); + input_report_abs(ds->gamepad, ABS_HAT0Y, ps_gamepad_hat_mapping[value].y); + + input_report_key(ds->gamepad, BTN_WEST, ds_report->buttons[0] & DS_BUTTONS0_SQUARE); + input_report_key(ds->gamepad, BTN_SOUTH, ds_report->buttons[0] & DS_BUTTONS0_CROSS); + input_report_key(ds->gamepad, BTN_EAST, ds_report->buttons[0] & DS_BUTTONS0_CIRCLE); + input_report_key(ds->gamepad, BTN_NORTH, ds_report->buttons[0] & DS_BUTTONS0_TRIANGLE); + input_report_key(ds->gamepad, BTN_TL, ds_report->buttons[1] & DS_BUTTONS1_L1); + input_report_key(ds->gamepad, BTN_TR, ds_report->buttons[1] & DS_BUTTONS1_R1); + input_report_key(ds->gamepad, BTN_TL2, ds_report->buttons[1] & DS_BUTTONS1_L2); + input_report_key(ds->gamepad, BTN_TR2, ds_report->buttons[1] & DS_BUTTONS1_R2); + input_report_key(ds->gamepad, BTN_SELECT, ds_report->buttons[1] & DS_BUTTONS1_CREATE); + input_report_key(ds->gamepad, BTN_START, ds_report->buttons[1] & DS_BUTTONS1_OPTIONS); + input_report_key(ds->gamepad, BTN_THUMBL, ds_report->buttons[1] & DS_BUTTONS1_L3); + input_report_key(ds->gamepad, BTN_THUMBR, ds_report->buttons[1] & DS_BUTTONS1_R3); + input_report_key(ds->gamepad, BTN_MODE, ds_report->buttons[2] & DS_BUTTONS2_PS_HOME); + input_sync(ds->gamepad); + + return 0; +} + +static struct ps_device *dualsense_create(struct hid_device *hdev) +{ + struct dualsense *ds; + int ret; + + ds = devm_kzalloc(&hdev->dev, sizeof(*ds), GFP_KERNEL); + if (!ds) + return ERR_PTR(-ENOMEM); + + /* Patch version to allow userspace to distinguish between + * hid-generic vs hid-playstation axis and button mapping. + */ + hdev->version |= 0x8000; + + ds->base.hdev = hdev; + ds->base.parse_report = dualsense_parse_report; + hid_set_drvdata(hdev, ds); + + ds->gamepad = ps_gamepad_create(hdev); + if (IS_ERR(ds->gamepad)) { + ret = PTR_ERR(ds->gamepad); + goto err; + } + + return (struct ps_device *)ds; + +err: + return ERR_PTR(ret); +} + +static int ps_raw_event(struct hid_device *hdev, struct hid_report *report, + u8 *data, int size) +{ + struct ps_device *dev = hid_get_drvdata(hdev); + + if (dev && dev->parse_report) + return dev->parse_report(dev, report, data, size); + + return 0; +} + +static int ps_probe(struct hid_device *hdev, const struct hid_device_id *id) +{ + struct ps_device *dev; + int ret; + + ret = hid_parse(hdev); + if (ret) { + hid_err(hdev, "parse failed\n"); + return ret; + } + + ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); + if (ret) { + hid_err(hdev, "hw start failed\n"); + return ret; + } + + ret = hid_hw_open(hdev); + if (ret) { + hid_err(hdev, "hw open failed\n"); + goto err_stop; + } + + if (hdev->product == USB_DEVICE_ID_SONY_PS5_CONTROLLER) { + dev = dualsense_create(hdev); + if (IS_ERR(dev)) { + hid_err(hdev, "Failed to create dualsense.\n"); + ret = PTR_ERR(dev); + goto err_close; + } + } else { + hid_err(hdev, "Unhandled device\n"); + ret = -EINVAL; + goto err_close; + } + + return ret; + +err_close: + hid_hw_close(hdev); +err_stop: + hid_hw_stop(hdev); + return ret; +} + +static void ps_remove(struct hid_device *hdev) +{ + hid_hw_close(hdev); + hid_hw_stop(hdev); +} + +static const struct hid_device_id ps_devices[] = { + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER), + .driver_data = 0 }, +}; + +static struct hid_driver ps_driver = { + .name = "playstation", + .id_table = ps_devices, + .probe = ps_probe, + .remove = ps_remove, + .raw_event = ps_raw_event, +}; + +module_hid_driver(ps_driver); + +MODULE_LICENSE("GPL"); diff --git a/drivers/hid/hid-quirks.c b/drivers/hid/hid-quirks.c index d9ca874dffac..1ca46cb445be 100644 --- a/drivers/hid/hid-quirks.c +++ b/drivers/hid/hid-quirks.c @@ -565,6 +565,9 @@ static const struct hid_device_id hid_have_special_driver[] = { #if IS_ENABLED(CONFIG_HID_PLANTRONICS) { HID_USB_DEVICE(USB_VENDOR_ID_PLANTRONICS, HID_ANY_ID) }, #endif +#if IS_ENABLED(CONFIG_HID_PLAYSTATION) + { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS5_CONTROLLER) }, +#endif #if IS_ENABLED(CONFIG_HID_PRIMAX) { HID_USB_DEVICE(USB_VENDOR_ID_PRIMAX, USB_DEVICE_ID_PRIMAX_KEYBOARD) }, #endif