[FOR-UPSTREAM] HID: ayaneo: Add AYANEO 3 detachable controller driver - #101
Open
matmartinez wants to merge 1 commit into
Open
[FOR-UPSTREAM] HID: ayaneo: Add AYANEO 3 detachable controller driver#101matmartinez wants to merge 1 commit into
matmartinez wants to merge 1 commit into
Conversation
The AYANEO 3 handheld has a detachable controller with swappable
modules ("Magic Modules"). The controller exposes three USB HID
interfaces behind 1c4f:0002 (a generic SigmaMicro VID/PID, hence the
DMI gate): a gamepad, a keyboard for the extra buttons, and a vendor
interface accepting 65-byte commands.
Add a driver for the vendor interface providing module identification
(module_left/module_right sysfs attributes), software eject of the
modules (eject sysfs attribute, blocking until the firmware confirms
the release handshake), and RGB control of the joystick rings as a
multicolor LED class device named ayaneo:rgb:joystick_rings, matching
the name InputPlumber already expects for this device.
This complements the ayaneo-ec platform driver, which exposes module
attach state and controller power. A full physical eject is performed
by writing to eject and then cutting power through ayaneo-ec's
controller_power attribute; that orchestration is deliberately left
to userspace.
The protocol was reverse engineered in the Handheld Daemon project by
Antheas Kapenekakis. Tested on an AYANEO 3 (7.2.0-ogc4.1): module
identification, RGB, and a full eject/reinsert/repower cycle.
Signed-off-by: Matías Martínez <hello@matias.me>
Author
|
Per pastaq's guidance in ShadowBlip/OpenGamepadUI#528, this is now also submitted to the unstable review repo as OpenGamingCollective/linux-unstable#3 (same commit rebased onto its master). Happy to close either one — whichever fits your flow. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a HID driver for the AYANEO 3's detachable controller ("Magic Modules"), restoring the module functionality that was lost when Bazzite 44 dropped Handheld Daemon (see ShadowBlip/OpenGamepadUI#528, ublue-os/bazzite context).
What it does
Binds the controller's vendor HID interface (
1c4f:0002, application usage0xff000001; DMI-gated to the AYANEO 3 since the VID/PID is a generic SigmaMicro ID) and provides:module_left/module_rightsysfs attributes (raw firmware module-type IDs; bits 0–5 type, bit 6 rotated)ejectsysfs attribute (left/right/both), blocks until the firmware confirms the release handshakeayaneo:rgb:joystick_rings— the name InputPlumber's50-ayaneo_3.yamlalready expectsreset: quick controller config resetEC power-off is deliberately left to userspace: the full pop-out flow is
eject→ write0to ayaneo-ec'scontroller_power, so orchestration/UX can live in OpenGamepadUI (plugin planned as the next step, per #528).The protocol was reverse engineered in Handheld Daemon by Antheas Kapenekakis; this ports it onto the
ayaneo-ecfoundation (already in this tree since 6.19). Includes aDocumentation/ABI/entry and a MAINTAINERS entry; checkpatch --strict clean except the standard-ENOSYSoutput-report-fallback false positive.Testing
Built and tested on an AYANEO 3 running Bazzite 44 (this tree's 7.2.0-ogc4.1 via kernel-packages):
hid-ayaneo 0003:1C4F:0002.0007: modules: left 0x04 right 0x50eject→ firmware confirm (~4s) → EC power off → module released → reinsert →controller_modulesback toboth→ power on → controller re-enumerates (custom mode persists in controller flash) → driver rebindsA companion PR to kernel-packages adds
CONFIG_HID_AYANEO=m.Marked
[FOR-UPSTREAM]: I intend to submit this to LKML (linux-input) once the sysfs interface has been sanity-checked by the folks working on the AYANEO stack — feedback requested in ShadowBlip/OpenGamepadUI#528. Happy to adjust naming/semantics here first so the OGC tree matches what goes to the list.