Re: [PATCH] HID: sony: Support for DS4 clones that do not implement feature report 0x81

[Ivan Mironov]

Ignore this patch, I am working on a better one.

On Wed, 2021-01-13 at 22:34 +0500, Ivan Mironov wrote:
> There are clones of DualShock 4 that are very similar to the originals,
> except of 1) they do not support HID feature report 0x81 and 2) they do
> not have any USB Audio interfaces despite they physically have audio
> jack.
> 
> Such controllers are working fine with Linux when connected via
> Bluetooth, but not when connected via USB. Here is how failed USB
> connection attempt looks in log:
> 
> 	usb 1-5: New USB device found, idVendor=054c, idProduct=05c4, bcdDevice= 1.00
> 	usb 1-5: New USB device strings: Mfr=1, Product=2, SerialNumber=0
> 	usb 1-5: Product: Wireless Controller
> 	usb 1-5: Manufacturer: Sony Computer Entertainment
> 	sony 0003:054C:05C4.0007: failed to retrieve feature report 0x81 with the DualShock 4 MAC address
> 	sony 0003:054C:05C4.0007: hidraw6: USB HID v81.11 Gamepad [Sony Computer Entertainment Wireless Controller] on usb-0000:00:14.0-5/input0
> 	sony 0003:054C:05C4.0007: failed to claim input
> 
> This patch adds support of using feature report 0x12 as a fallback for
> Bluetooth MAC address retrieval. Feature report 0x12 also seems to be
> used by DS4Windows[1] for all DS4 controllers.
> 
> [1] https://github.com/Ryochan7/DS4Windows/blob/1b74a4440089f38a24ee2c2483c1d733a0692b8f/DS4Windows/HidLibrary/HidDevice.cs#L479
> 
> Signed-off-by: Ivan Mironov <mironov.ivan@xxxxxxxxx>
> ---
>  drivers/hid/hid-sony.c | 72 ++++++++++++++++++++++++++++++------------
>  1 file changed, 52 insertions(+), 20 deletions(-)
> 
> diff --git a/drivers/hid/hid-sony.c b/drivers/hid/hid-sony.c
> index e3a557dc9ffd..97df12180e45 100644
> --- a/drivers/hid/hid-sony.c
> +++ b/drivers/hid/hid-sony.c
> @@ -491,6 +491,7 @@ struct motion_output_report_02 {
>  
> 
>  #define DS4_FEATURE_REPORT_0x02_SIZE 37
>  #define DS4_FEATURE_REPORT_0x05_SIZE 41
> +#define DS4_FEATURE_REPORT_0x12_SIZE 16
>  #define DS4_FEATURE_REPORT_0x81_SIZE 7
>  #define DS4_FEATURE_REPORT_0xA3_SIZE 49
>  #define DS4_INPUT_REPORT_0x11_SIZE 78
> @@ -2593,6 +2594,53 @@ static int sony_get_bt_devaddr(struct sony_sc *sc)
>  	return 0;
>  }
>  
> 
> +static int sony_get_usb_ds4_devaddr(struct sony_sc *sc)
> +{
> +	u8 *buf = NULL;
> +	int ret;
> +
> +	buf = kmalloc(max(DS4_FEATURE_REPORT_0x12_SIZE, DS4_FEATURE_REPORT_0x81_SIZE), GFP_KERNEL);
> +	if (!buf)
> +		return -ENOMEM;
> +
> +	/*
> +	 * The MAC address of a DS4 controller connected via USB can be
> +	 * retrieved with feature report 0x81. The address begins at
> +	 * offset 1.
> +	 */
> +	ret = hid_hw_raw_request(sc->hdev, 0x81, buf,
> +			DS4_FEATURE_REPORT_0x81_SIZE, HID_FEATURE_REPORT,
> +			HID_REQ_GET_REPORT);
> +	if (ret == DS4_FEATURE_REPORT_0x81_SIZE) {
> +		memcpy(sc->mac_address, &buf[1], sizeof(sc->mac_address));
> +		goto out_free;
> +	}
> +	dbg_hid("%s: hid_hw_raw_request(..., 0x81, ...) returned %d\n", __func__, ret);
> +
> +	/*
> +	 * Some variants do not implement feature report 0x81 at all.
> +	 * Fortunately, feature report 0x12 also contains the MAC address of
> +	 * a controller.
> +	 */
> +	ret = hid_hw_raw_request(sc->hdev, 0x12, buf,
> +			DS4_FEATURE_REPORT_0x12_SIZE, HID_FEATURE_REPORT,
> +			HID_REQ_GET_REPORT);
> +	if (ret == DS4_FEATURE_REPORT_0x12_SIZE) {
> +		memcpy(sc->mac_address, &buf[1], sizeof(sc->mac_address));
> +		goto out_free;
> +	}
> +	dbg_hid("%s: hid_hw_raw_request(..., 0x12, ...) returned %d\n", __func__, ret);
> +
> +	hid_err(sc->hdev, "failed to retrieve feature reports 0x81 and 0x12 with the DualShock 4 MAC address\n");
> +	ret = ret < 0 ? ret : -EINVAL;
> +
> +out_free:
> +
> +	kfree(buf);
> +
> +	return ret;
> +}
> +
>  static int sony_check_add(struct sony_sc *sc)
>  {
>  	u8 *buf = NULL;
> @@ -2613,26 +2661,9 @@ static int sony_check_add(struct sony_sc *sc)
>  			return 0;
>  		}
>  	} else if (sc->quirks & (DUALSHOCK4_CONTROLLER_USB | DUALSHOCK4_DONGLE)) {
> -		buf = kmalloc(DS4_FEATURE_REPORT_0x81_SIZE, GFP_KERNEL);
> -		if (!buf)
> -			return -ENOMEM;
> -
> -		/*
> -		 * The MAC address of a DS4 controller connected via USB can be
> -		 * retrieved with feature report 0x81. The address begins at
> -		 * offset 1.
> -		 */
> -		ret = hid_hw_raw_request(sc->hdev, 0x81, buf,
> -				DS4_FEATURE_REPORT_0x81_SIZE, HID_FEATURE_REPORT,
> -				HID_REQ_GET_REPORT);
> -
> -		if (ret != DS4_FEATURE_REPORT_0x81_SIZE) {
> -			hid_err(sc->hdev, "failed to retrieve feature report 0x81 with the DualShock 4 MAC address\n");
> -			ret = ret < 0 ? ret : -EINVAL;
> -			goto out_free;
> -		}
> -
> -		memcpy(sc->mac_address, &buf[1], sizeof(sc->mac_address));
> +		ret = sony_get_usb_ds4_devaddr(sc);
> +		if (ret < 0)
> +			return ret;
>  
> 
>  		snprintf(sc->hdev->uniq, sizeof(sc->hdev->uniq),
>  			 "%pMR", sc->mac_address);
> @@ -2670,6 +2701,7 @@ static int sony_check_add(struct sony_sc *sc)
>  		return 0;
>  	}
>  
> 
> +	dbg_hid("%s: retrieved MAC address: %s\n", __func__, sc->hdev->uniq);
>  	ret = sony_check_add_dev_list(sc);
>  
> 
>  out_free: