Skip to contentSkip to conversation

HID: hyperx: add driver for the HyperX QuadCast 2 mute button

PATCH Applied Benjamin Blume 2 participants 2 messages Jul 13 – Aug 3

Subsystems (2)
lore
Share & tools
lore

Benjamin Blume

author maintainer
#0 lore raw

PATCH 1/1 HID: hyperx: add driver for the HyperX QuadCast 2 mute button

The tap-to-mute button of the HyperX QuadCast 2 (03f0:07b4) is handled entirely in the device firmware. The firmware gates the audio internally but never sends the Telephony "Phone Mute" usage (0x2f) that its own report descriptor advertises, and it does not touch the UAC feature unit either. Consequently neither an evdev key event nor an ALSA mixer change is ever generated, and userspace has no way to learn that the microphone was muted:
desktops keep showing the microphone as live, and conferencing applications keep displaying an unmuted microphone while transmitting silence.

The mute state is reported through a vendor-defined collection instead:

06 c0 ff Usage Page (Vendor-Defined 0xFFC0)
a1 01 Collection (Application)

  06 c1 ff          Usage Page (Vendor-Defined 0xFFC1)
  85 77             Report ID (0x77)
  09 f0             Usage (0xF0)
  75 08  95 3f      Report Size (8), Report Count (63)
  81 02             Input (Data,Var,Abs)

Pressing the button emits a 64-byte report on that collection:

77 06 00 00 ... microphone unmuted
77 06 01 00 ... microphone muted

where byte 1 identifies the mute event and byte 2 carries the resulting state. As the payload is an opaque vendor blob carrying no HID usages, hid-input cannot map it and a hwdb entry cannot express it either.

Add a driver that decodes the report and emits KEY_MICMUTE, which makes the button behave like any other microphone mute key.

Note that the device reports the resulting absolute state, whereas KEY_MICMUTE is a momentary key that userspace acts on as a toggle, so the driver emits one keypress per state change.

Tested on a HyperX QuadCast 2 (03f0:07b4).

---

Notes for reviewers:

The report descriptor also declares a Telephony collection (usage page 0x0b) with Phone Mute (0x2f) on report ID 5, which is why the device already advertises KEY_MICMUTE. The firmware never sends that report; the mute state only ever arrives on the vendor collection decoded here. The driver therefore reuses the input device of that telephony collection rather than creating a second one.

Open question: the device reports an absolute mute state, so SW_MUTE_DEVICE would model it more faithfully than KEY_MICMUTE. I went with KEY_MICMUTE because that is what desktop environments actually act on today, at the cost of turning an absolute state into a toggle. Happy to emit the switch in addition (or instead) if you prefer.

The device also exposes a host-controllable mute LED (/sys/class/leds/input*::mute), which is left untouched by this patch: the firmware already drives it in lockstep with its internal mute state.

 MAINTAINERS              |   6 ++
 drivers/hid/Kconfig      |  13 +++++
 drivers/hid/Makefile     |   1 +
 drivers/hid/hid-hyperx.c | 117 +++++++++++++++++++++++++++++++++++++++
 drivers/hid/hid-ids.h    |   1 +
 5 files changed, 138 insertions(+)
 create mode 100644 drivers/hid/hid-hyperx.c
MAINTAINERS +6 -0
index 806bd2d..542d606 100644
@@ -11530,6 +11530,12 @@ F:	include/uapi/linux/hid*
 F:	samples/hid/
 F:	tools/testing/selftests/hid/
 
+HID HYPERX DRIVER
+M:	Benjamin Blume <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/hid/hid-hyperx.c
+
 HID LOGITECH DRIVERS
 R:	Filipe Laíns <[email protected]>
 L:	[email protected]
drivers/hid/Kconfig +13 -0
index f9bcaeb..e00bac8 100644
@@ -433,6 +433,19 @@ config HOLTEK_FF
 	  Say Y here if you have a Holtek On Line Grip based game controller
 	  and want to have force feedback support for it.
 
+config HID_HYPERX
+	tristate "HyperX microphones"
+	depends on USB_HID
+	help
+	  Support for the mute button of HyperX microphones.
+
+	  The button is handled in the device firmware and only reports the
+	  resulting mute state through a vendor-defined collection, so without
+	  this driver userspace never learns that the microphone was muted.
+
+	  Supported devices:
+	  - HyperX QuadCast 2
+
 config HID_VIVALDI_COMMON
 	tristate
 	help
drivers/hid/Makefile +1 -0
index 23e6e3d..4138be7 100644
@@ -67,6 +67,7 @@ obj-$(CONFIG_HID_HOLTEK)	+= hid-holtek-kbd.o
 obj-$(CONFIG_HID_HOLTEK)	+= hid-holtek-mouse.o
 obj-$(CONFIG_HID_HOLTEK)	+= hid-holtekff.o
 obj-$(CONFIG_HID_HYPERV_MOUSE)	+= hid-hyperv.o
+obj-$(CONFIG_HID_HYPERX)	+= hid-hyperx.o
 obj-$(CONFIG_HID_ICADE)		+= hid-icade.o
 obj-$(CONFIG_HID_ITE)		+= hid-ite.o
 obj-$(CONFIG_HID_JABRA)		+= hid-jabra.o
drivers/hid/hid-hyperx.c new file +117 -0

117 lines not on this page · raw message

drivers/hid/hid-ids.h +1 -0
index 1059922..76674b3 100644
@@ -688,6 +688,7 @@
 #define USB_DEVICE_ID_HORI_WIRELESS_SWITCH_PAD	0x00f6
 
 #define USB_VENDOR_ID_HP		0x03f0
+#define USB_PRODUCT_ID_HP_HYPERX_QUADCAST_2			0x07b4
 #define USB_PRODUCT_ID_HP_ELITE_PRESENTER_MOUSE_464A		0x464a
 #define USB_PRODUCT_ID_HP_LOGITECH_OEM_USB_OPTICAL_MOUSE_0A4A	0x0a4a
 #define USB_PRODUCT_ID_HP_LOGITECH_OEM_USB_OPTICAL_MOUSE_0B4A	0x0b4a
Signature · 1 line
2.55.0
maintainer Applied
#1 lore raw
Quoted 31 lines · Benjamin Blume

The tap-to-mute button of the HyperX QuadCast 2 (03f0:07b4) is handled entirely in the device firmware. The firmware gates the audio internally but never sends the Telephony "Phone Mute" usage (0x2f) that its own report descriptor advertises, and it does not touch the UAC feature unit either. Consequently neither an evdev key event nor an ALSA mixer change is ever generated, and userspace has no way to learn that the microphone was muted:
desktops keep showing the microphone as live, and conferencing applications keep displaying an unmuted microphone while transmitting silence.

The mute state is reported through a vendor-defined collection instead:

06 c0 ff Usage Page (Vendor-Defined 0xFFC0)
a1 01 Collection (Application)

  06 c1 ff          Usage Page (Vendor-Defined 0xFFC1)
  85 77             Report ID (0x77)
  09 f0             Usage (0xF0)
  75 08  95 3f      Report Size (8), Report Count (63)
  81 02             Input (Data,Var,Abs)

Pressing the button emits a 64-byte report on that collection:

77 06 00 00 ... microphone unmuted
77 06 01 00 ... microphone muted

where byte 1 identifies the mute event and byte 2 carries the resulting state. As the payload is an opaque vendor blob carrying no HID usages, hid-input cannot map it and a hwdb entry cannot express it either.

Add a driver that decodes the report and emits KEY_MICMUTE, which makes the button behave like any other microphone mute key.

Quoted 7 lines

Note that the device reports the resulting absolute state, whereas KEY_MICMUTE is a momentary key that userspace acts on as a toggle, so the driver emits one keypress per state change.

Tested on a HyperX QuadCast 2 (03f0:07b4).

Applied, thanks.

Signature · 2 lines
Jiri Kosina
SUSE Labs