use hidraw backend of hidapi instead of libusb backend #4054

Be-ing · 2021-07-03T16:45:13Z

This has two advantages:

Bluetooth HID devices are supported. These are relatively rare, but we have had a request to support these before: https://mixxx.discourse.group/t/bluetooth-remote/16195/8
HID reports of more than 64 bytes and libusb backend libusb/hidapi#274 does not affect the hidraw backend, so the hacks around this bug can be removed for the Kontrol S4 Mk2 & Mk3 mappings.

The disadvantage is that hid_get_input_report for explicitly requesting a specific input report is not yet implemented for the hidraw backend. I will work on this upstream. That is used by #3038 but not in any mappings currently in the main branch.

Be-ing · 2021-07-03T18:51:12Z

@JoergAtGithub what are you thoughts on this?

Be-ing · 2021-07-03T18:51:41Z

Note that libusb is still used as a fallback for BSD.

src/controllers/hid/hidenumerator.cpp

uklotzde

I don't have any objections. But since this is a major change I would like to collect more feedback before merging.

Be-ing · 2021-07-04T22:46:33Z

Hopefully we can remove our own Findhidapi.cmake module soon since CMake support was just merged upstream.

JoergAtGithub · 2021-07-06T04:59:20Z

I think hidraw would be the best solution for Linux, if libusb/hidapi#259 get implemented, which should be trivial. The only reason, that it's not in hidraw is, that the necessary API was not available in very old kernels.

What happens if a mapping uses hid_get_input_report? What does it return if called with hidraw backend? Random data, which initialize all knobs and faders to random positions at startup, would be a problem.

Removing this ugly fallback code from the mappings would mean, that they can't work with sytems like BSD anymore. But are there Mixxx builds for BSD?

JoergAtGithub · 2021-07-06T05:04:03Z

Do hidraw devices work with the same udev settings as libusb devices, or must existing Linux users adapt there settings for hidraw?

Be-ing · 2021-07-06T10:54:33Z

Do hidraw devices work with the same udev settings as libusb devices, or must existing Linux users adapt there settings for hidraw?

No, I adapted the udev rule file in this branch.

Be-ing · 2021-07-06T11:13:57Z

What happens if a mapping uses hid_get_input_report? What does it return if called with hidraw backend? Random data, which initialize all knobs and faders to random positions at startup, would be a problem.

I have not tested. This is no issue now though because no merged mapping uses it. I would like to try it with my S4 Mk3, so I'll work on implementing it upstream.

JoergAtGithub · 2021-07-06T18:03:02Z

The following comment says udev rules are for HID and USB bulk:

mixxx/res/linux/mixxx-usb-uaccess.rules

Line 1 in b5904a7

    
           # This udev rule allows Mixxx to access HID and USB Bulk controllers when running as a normal user

Didn't the later still need the old udev rules on Linux?

to deduplicate dependency lists

needed for hidraw backend of hidapi

The hidraw backend supports Bluetooth HID. This also works around a bug in the libusb backend affecting the Native Instruments Traktor Kontrol S4 Mk2 & Mk3: libusb/hidapi#274

HID devices can use USB or Bluetooth.

Be-ing · 2021-07-06T23:29:01Z

As the comments lower in the udev rule file says, older Hercules and Native Instruments controllers are accessed via the USB Bulk endpoints through libusb, in addition to the newer HID controllers.

Merge?

Holzhaus · 2021-07-06T23:49:38Z

Thank you.

I'm a bit worried because this backend only works on Linux. This means that any mapping for controllers that send more than 64 byte reports would either work on Linux or on Windows, but not both. This means we should try to help upstream to resolve that issue, even if it's not present on Linux with hidraw.

Regarding hid_get_input_report: Please add a comment near that method that explains that it's not working with hidraw.

Other than that, the PR looks good, but I have no HID controller to test it with. It would be good if someone confirms that it works fine.

Be-ing · 2021-07-06T23:54:18Z

You're misunderstanding. The bug with splitting packets over 64 bytes only occurs with the libusb backend. It does not occur on Windows nor macOS. This PR is fixing that so it works the same on Linux as Windows and macOS.

for hidraw backend on Linux

Be-ing · 2021-07-06T23:57:17Z

Regarding hid_get_input_report: Please add a comment near that method that explains that it's not working with hidraw.

Done: f17c8bf

uklotzde · 2021-07-06T23:58:24Z

Ok, then I'll do a quick test tomorrow to check if it actually works. Using a different controller would be helpful, if someone owns one.

Holzhaus · 2021-07-07T00:02:19Z

You're misunderstanding. The bug with splitting packets over 64 bytes only occurs with the libusb backend. It does not occur on Windows nor macOS. This PR is fixing that so it works the same on Linux as Windows and macOS.

Thanks for clarifying. I had the impression that issues is present on all OSes and this only fixes it for Linux.

The point still applies for BSD, and although it still would be nice to have full compatibility on all OSes I think we can live with it.

Be-ing · 2021-07-07T00:06:21Z

The point still applies for BSD, and although it still would be nice to have full compatibility on all OSes I think we can live with it.

BSDs are likely still affected, yes, and we don't officially support BSD. In practice I am doubtful that anyone has tried using a Kontrol S4 Mk2 or M3 with Mixxx on BSD. If you're out there, speak up and prove me wrong. :)

uklotzde · 2021-07-07T17:02:41Z

S4 MK3, Firmware v0.6.1, after installing the new .rules files:

info [Controller] Found HID device: { 17cc:1720 r61 | Usage: ff01:0000 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0001 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0001 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0030 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0001 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0030 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0030 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0030 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0080 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0080 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0080 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:0080 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00d8 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00d8 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00f0 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00f0 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00e0 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }
info [Controller] Duplicate HID device, excluding { 17cc:1720 r61 | Usage: ff01:00e0 | Interface: #3 | Manufacturer: Native Instruments | Product: Traktor Kontrol S4 MK3 | S/N: 0XXXXXXX }

I can confirm that it works with the new mapping.

Be-ing · 2021-07-08T00:58:05Z

Regarding hid_get_input_report: Please add a comment near that method that explains that it's not working with hidraw.

I added a to-do card to the 2.4 project board.

mcuee · 2021-09-04T03:06:54Z

@uklotzde Just wondering if you can comment on this hidapi issue with regard to the Duplicate HID device under Linux hidraw backend. Please post the output of "lsusb -vvv" and "hidtest" (from hidapi) under Linux about your device (Traktor Kontrol S4 MK3). Thanks.
libusb/hidapi#298

…j#4054.

github-actions bot added the build label Jul 3, 2021

Be-ing force-pushed the hidapi_hidraw branch 7 times, most recently from 6774b9f to 6b1650b Compare July 3, 2021 17:40

Be-ing force-pushed the hidapi_hidraw branch from 757e42f to 6dd77b1 Compare July 4, 2021 01:38

uklotzde reviewed Jul 4, 2021

View reviewed changes

src/controllers/hid/hidenumerator.cpp Show resolved Hide resolved

uklotzde approved these changes Jul 4, 2021

View reviewed changes

Be-ing added 7 commits July 6, 2021 18:27

use debian_buildenv.sh in build-checks GH Actions workflow

4d25559

to deduplicate dependency lists

debian_buildenv.sh: add libudev-dev dependency

81ba203

needed for hidraw backend of hidapi

CMake: link hidraw backend of hidapi on Linux instead of libusb

d6fcf90

The hidraw backend supports Bluetooth HID. This also works around a bug in the libusb backend affecting the Native Instruments Traktor Kontrol S4 Mk2 & Mk3: libusb/hidapi#274

update udev rules for hidraw backend of hidapi

43d83fb

HidEnumerator: filter duplicate devices

5c58257

HidEnumerator: remove "USB" from debug messages

c1b09e6

HID devices can use USB or Bluetooth.

HidEnumerator: add link to upstream bug report for hidapi

a005337

Be-ing force-pushed the hidapi_hidraw branch from b5904a7 to a005337 Compare July 6, 2021 23:27

HidController: add FIXME to implement hid_get_input_report upstream

f17c8bf

for hidraw backend on Linux

Holzhaus merged commit b7f31ae into mixxxdj:main Jul 7, 2021

Be-ing deleted the hidapi_hidraw branch July 7, 2021 21:07

Be-ing mentioned this pull request Jul 18, 2021

Install UDev rules to the proper location by default #4114

Closed

mcuee mentioned this pull request Sep 4, 2021

hid_enumerate with hidraw backend returns lots of duplicate hid_device_infos libusb/hidapi#298

Closed

JoergAtGithub added a commit to JoergAtGithub/mixxx that referenced this pull request May 30, 2022

Increase minimum hidapi to 0.11.2, which solves the FIXME from mixxxd…

5b9ace7

…j#4054.

JoergAtGithub mentioned this pull request May 30, 2022

Update hidapi to 0.12.0 #4777

Closed

daschuer mentioned this pull request May 29, 2023

2.4.0 changelog updates #11605

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use hidraw backend of hidapi instead of libusb backend #4054

use hidraw backend of hidapi instead of libusb backend #4054

Be-ing commented Jul 3, 2021 •

edited

Loading

Be-ing commented Jul 3, 2021

Be-ing commented Jul 3, 2021

uklotzde left a comment

Be-ing commented Jul 4, 2021 •

edited

Loading

JoergAtGithub commented Jul 6, 2021 •

edited

Loading

JoergAtGithub commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Be-ing commented Jul 6, 2021

JoergAtGithub commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Holzhaus commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Be-ing commented Jul 6, 2021

uklotzde commented Jul 6, 2021

Holzhaus commented Jul 7, 2021 •

edited

Loading

Be-ing commented Jul 7, 2021

uklotzde commented Jul 7, 2021 •

edited

Loading

Be-ing commented Jul 8, 2021

mcuee commented Sep 4, 2021 •

edited

Loading

use hidraw backend of hidapi instead of libusb backend #4054

use hidraw backend of hidapi instead of libusb backend #4054

Conversation

Be-ing commented Jul 3, 2021 • edited Loading

Be-ing commented Jul 3, 2021

Be-ing commented Jul 3, 2021

uklotzde left a comment

Choose a reason for hiding this comment

Be-ing commented Jul 4, 2021 • edited Loading

JoergAtGithub commented Jul 6, 2021 • edited Loading

JoergAtGithub commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Be-ing commented Jul 6, 2021

JoergAtGithub commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Holzhaus commented Jul 6, 2021

Be-ing commented Jul 6, 2021

Be-ing commented Jul 6, 2021

uklotzde commented Jul 6, 2021

Holzhaus commented Jul 7, 2021 • edited Loading

Be-ing commented Jul 7, 2021

uklotzde commented Jul 7, 2021 • edited Loading

Be-ing commented Jul 8, 2021

mcuee commented Sep 4, 2021 • edited Loading

Be-ing commented Jul 3, 2021 •

edited

Loading

Be-ing commented Jul 4, 2021 •

edited

Loading

JoergAtGithub commented Jul 6, 2021 •

edited

Loading

Holzhaus commented Jul 7, 2021 •

edited

Loading

uklotzde commented Jul 7, 2021 •

edited

Loading

mcuee commented Sep 4, 2021 •

edited

Loading