feat(CapabilityMap): add generic hidraw button driver #563
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| version: 2 | ||
| kind: CapabilityMap | ||
| name: GPD Win 5 HID Buttons | ||
| id: gpd_win5_hid | ||
|
|
||
| # GPD Win 5 vendor HID report (VID 0x2f24, PID 0x0137, Usage Page 0xFF00) | ||
| # Idle: 01 a5 00 5a ff 00 01 09 00 00 00 00 | ||
| # BUF[8] = 0x68 mode switch, 0x00 released | ||
| # BUF[9] = 0x69 left back, 0x00 released | ||
| # BUF[10] = 0x6a right back, 0x00 released | ||
| mapping: | ||
| - name: Mode Switch | ||
| source_events: | ||
| - hidraw: | ||
| input_type: button | ||
| byte_start: 8 | ||
| target_event: | ||
| gamepad: | ||
| button: QuickAccess | ||
|
|
||
| - name: Left Back | ||
| source_events: | ||
| - hidraw: | ||
| input_type: button | ||
| byte_start: 9 | ||
| target_event: | ||
| gamepad: | ||
| button: LeftPaddle1 | ||
|
|
||
| - name: Right Back | ||
| source_events: | ||
| - hidraw: | ||
| input_type: button | ||
| byte_start: 10 | ||
| target_event: | ||
| gamepad: | ||
| button: RightPaddle1 |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| pub mod translator; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| use crate::{ | ||
| config::capability_map::CapabilityMapConfigV2, | ||
| input::{ | ||
| capability::Capability, | ||
| event::{native::NativeEvent, value::InputValue}, | ||
| }, | ||
| }; | ||
|
|
||
| #[derive(Debug, Clone)] | ||
| struct HidrawButtonMapping { | ||
| report_id: Option<u8>, | ||
| byte_index: usize, | ||
| detection: DetectionMode, | ||
| capability: Capability, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone)] | ||
| enum DetectionMode { | ||
| NonZero, | ||
| Value(u8), | ||
| /// Bit position (LSB=0) | ||
| Bit(u8), | ||
| } | ||
|
|
||
| /// Translates raw HID reports into [NativeEvent]s using a capability map. | ||
| #[derive(Debug)] | ||
| pub struct HidrawEventTranslator { | ||
| mappings: Vec<HidrawButtonMapping>, | ||
| state: Vec<bool>, | ||
| } | ||
|
|
||
| impl HidrawEventTranslator { | ||
| /// Create a new translator from a V2 capability map. | ||
| pub fn new(capability_map: &CapabilityMapConfigV2) -> Self { | ||
| let mut mappings = Vec::new(); | ||
|
|
||
| for mapping in capability_map.mapping.iter() { | ||
| for source in mapping.source_events.iter() { | ||
|
pastaq marked this conversation as resolved.
|
||
| let Some(hidraw) = source.hidraw.as_ref() else { | ||
| continue; | ||
| }; | ||
|
|
||
| if hidraw.input_type != "button" { | ||
| log::warn!( | ||
| "Unsupported hidraw input_type '{}' in mapping '{}', skipping", | ||
| hidraw.input_type, | ||
| mapping.name, | ||
| ); | ||
| continue; | ||
| } | ||
|
Comment on lines
+43
to
+50
Contributor
There was a problem hiding this comment. Since this implementation only supports simple button decoding, it would be nice to add a |
||
|
|
||
| let cap: Capability = mapping.target_event.clone().into(); | ||
| if cap == Capability::NotImplemented { | ||
| log::warn!( | ||
| "Unresolved target capability in mapping '{}', skipping", | ||
| mapping.name, | ||
| ); | ||
| continue; | ||
| } | ||
|
|
||
| let detection = if let Some(value) = hidraw.value { | ||
| DetectionMode::Value(value) | ||
| } else if let Some(bit) = hidraw.bit_offset { | ||
| DetectionMode::Bit(bit) | ||
| } else { | ||
| DetectionMode::NonZero | ||
| }; | ||
|
|
||
| mappings.push(HidrawButtonMapping { | ||
| report_id: hidraw.report_id, | ||
| byte_index: hidraw.byte_start as usize, | ||
| detection, | ||
| capability: cap, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| let state = vec![false; mappings.len()]; | ||
| Self { mappings, state } | ||
| } | ||
|
|
||
| pub fn has_mappings(&self) -> bool { | ||
|
pastaq marked this conversation as resolved.
Outdated
|
||
| !self.mappings.is_empty() | ||
| } | ||
|
|
||
| pub fn capabilities(&self) -> Vec<Capability> { | ||
| self.mappings.iter().map(|m| m.capability.clone()).collect() | ||
| } | ||
|
|
||
| /// Translate a raw HID report into [NativeEvent]s. Only emits events on | ||
| /// state changes. | ||
| pub fn translate(&mut self, report: &[u8]) -> Vec<NativeEvent> { | ||
| let mut events = Vec::new(); | ||
|
|
||
| for (idx, mapping) in self.mappings.iter().enumerate() { | ||
| if let Some(expected_id) = mapping.report_id { | ||
| if report.first().copied() != Some(expected_id) { | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| if mapping.byte_index >= report.len() { | ||
| continue; | ||
|
pastaq marked this conversation as resolved.
|
||
| } | ||
|
|
||
| let byte_val = report[mapping.byte_index]; | ||
| let pressed = match mapping.detection { | ||
| DetectionMode::NonZero => byte_val != 0, | ||
| DetectionMode::Value(expected) => byte_val == expected, | ||
| DetectionMode::Bit(bit) => (byte_val & (1 << bit)) != 0, | ||
| }; | ||
|
|
||
| if pressed != self.state[idx] { | ||
| self.state[idx] = pressed; | ||
| events.push(NativeEvent::new( | ||
| mapping.capability.clone(), | ||
| InputValue::Bool(pressed), | ||
| )); | ||
| } | ||
| } | ||
|
|
||
| events | ||
| } | ||
|
|
||
| /// Returns whether the capability map contains any hidraw source events. | ||
| pub fn has_hidraw_mappings(capability_map: &CapabilityMapConfigV2) -> bool { | ||
| capability_map | ||
| .mapping | ||
| .iter() | ||
| .any(|m| m.source_events.iter().any(|s| s.hidraw.is_some())) | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| pub mod context; | ||
| pub mod dbus; | ||
| pub mod evdev; | ||
| pub mod hidraw; | ||
| pub mod native; | ||
| pub mod value; | ||
|
|
||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the purpose of this field in decoding hidraw data?