Skip to contentSkip to conversation

ALSA: usb: Add support for Reloop Jockey 3 DJ controllers

PATCH Superseded Frank van de Pol 1 participant 3 messages Jun 22 Sound

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover ALSA: usb: Add support for Reloop Jockey 3 DJ controllers

Hi Takashi, Jaroslav, and the ALSA community,

After being away from active ALSA development for some 25 years or so, I am happy to submit this patch to introduce a dedicated driver supporting the Jockey 3 series of DJ Controllers made by Reloop (specifically covering the Master Edition and the Remix variants).

I initially evaluated the feasibility of integrating the required logic to handle the non-standard proprietary Ploytec framing protocol into the standard USB-audio driver via quirks. However, doing so would require introducing numerous hardware-specific exceptions throughout the core layout, adding significant complexity. A clean, isolated driver subdirectory provides much better long-term maintainability without cluttering the existing class-compliant architecture.

Following up on the feedback received from the v1 and v2 submissions of my driver, I have made several updates to the code to improve locking consistency, lifecycle safety, and the general readability and maintainability of the code.

Changes v1 -> v2:
- Migrated URB lifecycle management to use standard usb_anchors.
- Revised and hardened URB buffer memory allocation constraints.
- Addressed locking consistency, scoping issues, and static analysis warnings raised by Takashi and the Sashiko automated review.
- Implemented dynamic PCM rate constraints when a stream is active.
- Implemented full MIDI Running Status support for the control surface.
- Refactored several large code blocks to improve overall readability.
- Added clarifications on hardware-specific quirks and codec format.
- Optimized struct jockey3_chip layout for padding and locality.

Changes v2 -> v3:
- Removed redundant dependencies and defaults from Kconfig.
- Fixed an AB-BA deadlock condition highlighted by Sashiko review.
- Corrected an URB resubmission race condition.
- Implemented explicit USB endpoint validation during initialization.
- Added Sample Rate verification and post-reset recovery handling.
- Abstracted disconnect and stopping status checks out into helper functions.
- Moved substream registration safely under the chip spinlock.
- Implemented native suspend/resume power management triggers and callbacks.
- Refactored jockey3_probe() and jockey3_pcm_trigger() for cleaner state tracking.
- Further refined the internal MIDI Running Status state parser logic.

I have successfully validated and stress-tested this driver across three distinct hardware architectures to ensure robustness regarding DMA, timing, and memory alignment:

- x86_64 (Standard PC desktop environment)
- armhf (32-bit on a Raspberry Pi 1B -- functional, though tight at 96 kHz)
- arm64 (64-bit modern SoC environment on a Raspberry Pi 4)

I look forward to your review and feedback, and I am more than happy to make further architectural adjustments as required.

Best regards,
Frank

Frank van de Pol (1):
ALSA: usb: Add support for Reloop Jockey 3 DJ controllers

 MAINTAINERS                       |    7 +
 sound/usb/Kconfig                 |    1 +
 sound/usb/Makefile                |    1 +
 sound/usb/jockey3/Kconfig         |   17 +
 sound/usb/jockey3/Makefile        |    3 +
 sound/usb/jockey3/jockey3.c       | 1188 +++++++++++++++++++++++++++++
 sound/usb/jockey3/ploytec_proto.c |  330 ++++++++
 sound/usb/jockey3/ploytec_proto.h |   66 ++
 8 files changed, 1613 insertions(+)
 create mode 100644 sound/usb/jockey3/Kconfig
 create mode 100644 sound/usb/jockey3/Makefile
 create mode 100644 sound/usb/jockey3/jockey3.c
 create mode 100644 sound/usb/jockey3/ploytec_proto.c
 create mode 100644 sound/usb/jockey3/ploytec_proto.h
Signature · 1 line
2.47.3
#1 lore raw

PATCH v3 1/1 ALSA: usb: Add support for Reloop Jockey 3 DJ controllers

Introduce a dedicated repository subdirectory and driver for the Reloop Jockey 3 Master Edition and Reloop Jockey 3 Remix USB DJ controllers.

Because these devices utilize a non-standard, proprietary Ploytec USB framing protocol instead of standard USB Audio Class (UAC) mechanisms, they require specialized handling outside of standard quirks.

This driver provides:
- 24-bit multi-channel (6x4) audio capture and playback.
- Support for 44.1, 48, 88.2, and 96 kHz sample rates.
- ALSA RawMIDI input and output mapping for the integrated control surface.

The custom Ploytec encapsulation and streaming format was successfully reverse-engineered via USB protocol analysis and is isolated cleanly into ca local hardware-independent codec abstraction.

---
 MAINTAINERS                       |    7 +
 sound/usb/Kconfig                 |    1 +
 sound/usb/Makefile                |    1 +
 sound/usb/jockey3/Kconfig         |   17 +
 sound/usb/jockey3/Makefile        |    3 +
 sound/usb/jockey3/jockey3.c       | 1188 +++++++++++++++++++++++++++++
 sound/usb/jockey3/ploytec_proto.c |  330 ++++++++
 sound/usb/jockey3/ploytec_proto.h |   66 ++
 8 files changed, 1613 insertions(+)
 create mode 100644 sound/usb/jockey3/Kconfig
 create mode 100644 sound/usb/jockey3/Makefile
 create mode 100644 sound/usb/jockey3/jockey3.c
 create mode 100644 sound/usb/jockey3/ploytec_proto.c
 create mode 100644 sound/usb/jockey3/ploytec_proto.h
MAINTAINERS +7 -0
index 42feedf526c3..531fa0bf23f6 100644
@@ -22539,6 +22539,13 @@ F:	Documentation/filesystems/relay.rst
 F:	include/linux/relay.h
 F:	kernel/relay.c
 
+RELOOP JOCKEY 3 DJ CONTROLLER DRIVER
+M:	Frank van de Pol <[email protected]>
+L:	[email protected]
+S:	Maintained
+T:	git git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound.git
+F:	sound/usb/jockey3/
+
 REGISTER MAP ABSTRACTION
 M:	Mark Brown <[email protected]>
 L:	[email protected]
sound/usb/Kconfig +1 -0
index b4588915efa1..d7edfbaf099b 100644
@@ -205,6 +205,7 @@ config SND_USB_AUDIO_QMI
 	  will be called snd-usb-audio-qmi.
 
 source "sound/usb/line6/Kconfig"
+source "sound/usb/jockey3/Kconfig"
 
 endif	# SND_USB
 
sound/usb/Makefile +1 -0
index e62794a87e73..1f045c00dbc9 100644
@@ -37,3 +37,4 @@ obj-$(CONFIG_SND_USB_US122L) += snd-usbmidi-lib.o
 
 obj-$(CONFIG_SND) += misc/ usx2y/ caiaq/ 6fire/ hiface/ bcd2000/ qcom/
 obj-$(CONFIG_SND_USB_LINE6)	+= line6/
+obj-$(CONFIG_SND_USB_JOCKEY3) += jockey3/
sound/usb/jockey3/Kconfig new file +17 -0
new file mode 100644
index 000000000000..52964ff86a8f
@@ -0,0 +1,17 @@
+# SPDX-License-Identifier: GPL-2.0-only
+config SND_USB_JOCKEY3
+	tristate "Reloop Jockey 3 support"
+	select SND_PCM
+	select SND_RAWMIDI
+	help
+	  Say Y here to include support for the Reloop Jockey 3 DJ controllers.
+          These devices utilize a non-standard, proprietary Ploytec USB
+          protocol.
+
+	  Supported devices:
+
+            * Reloop Jockey 3 Master Edition
+            * Reloop Jockey 3 Remix
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called snd-reloop-jockey3.
sound/usb/jockey3/Makefile new file +3 -0
new file mode 100644
index 000000000000..85f9c6dcba14
@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: GPL-2.0
+obj-$(CONFIG_SND_USB_JOCKEY3) += snd-reloop-jockey3.o
+snd-reloop-jockey3-objs := jockey3.o ploytec_proto.o
sound/usb/jockey3/jockey3.c new file +1188 -0

1,188 lines not on this page · raw message

sound/usb/jockey3/ploytec_proto.c new file +330 -0

330 lines not on this page · raw message

sound/usb/jockey3/ploytec_proto.h new file +66 -0

66 lines not on this page · raw message

Signature · 1 line
2.47.3
#2 lore raw
Quoted 3 lines · Frank van de Pol

Introduce a dedicated repository subdirectory and driver for the Reloop Jockey 3 Master Edition and Reloop Jockey 3 Remix USB DJ controllers.

The Sashiko review for the latest version of my patch has quite a few interesting observations/questions... which I need to have a closer look at and likely need to correct.

https://sashiko.dev/#/patchset/20260622011131.1748298-2-fvdpol%40gmail.com

@Takashi, please let me know if the changes made to reduce repetative patterns and improving readability are going in the right direction and/or any further comments/observations.

Appreciate any feedback,
Hope to get ready for a v4 patch next weekend.

Best regards,
Frank.