diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdb123a4..4d5a65f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,16 @@ file with `scripts/gen-third-party-notices.sh` when the dependency tree changes. ## Before you push +Enable the repo git hooks once per clone — they run the exact rustfmt gates CI runs (main +workspace + the UMDF driver workspace) on every commit and push, so a push can never fail CI +on formatting alone: + +```sh +git config core.hooksPath scripts/git-hooks +``` + +Then the usual full pass: + ```sh cargo fmt --all --check cargo clippy --workspace --all-targets -- -D warnings diff --git a/crates/pf-console-ui/src/glyphs.rs b/crates/pf-console-ui/src/glyphs.rs index 2073b399..72422b44 100644 --- a/crates/pf-console-ui/src/glyphs.rs +++ b/crates/pf-console-ui/src/glyphs.rs @@ -22,9 +22,9 @@ pub(crate) enum GlyphStyle { impl GlyphStyle { pub(crate) fn from_pref(pref: Option) -> GlyphStyle { match pref { - Some( - GamepadPref::DualSense | GamepadPref::DualSenseEdge | GamepadPref::DualShock4, - ) => GlyphStyle::Shapes, + Some(GamepadPref::DualSense | GamepadPref::DualSenseEdge | GamepadPref::DualShock4) => { + GlyphStyle::Shapes + } Some(_) => GlyphStyle::Letters, None => GlyphStyle::Keyboard, } diff --git a/crates/punktfunk-host/src/inject.rs b/crates/punktfunk-host/src/inject.rs index 17f98ff4..bc1565e1 100644 --- a/crates/punktfunk-host/src/inject.rs +++ b/crates/punktfunk-host/src/inject.rs @@ -473,6 +473,11 @@ fn gs_button_to_evdev(b: u32) -> Option { #[cfg(target_os = "linux")] #[path = "inject/linux/dualsense.rs"] pub mod dualsense; +/// Windows: virtual DualSense **Edge** via the same UMDF minidriver + shared-memory channel +/// (device-type 2) — the wire back grips land on the Edge's native back/Fn buttons. +#[cfg(target_os = "windows")] +#[path = "inject/windows/dualsense_edge_windows.rs"] +pub mod dualsense_edge_windows; /// Transport-independent DualSense HID contract, shared by the Linux UHID backend ([`dualsense`]) /// and the Windows UMDF-driver backend ([`dualsense_windows`]). #[cfg(any(target_os = "linux", target_os = "windows"))] @@ -482,11 +487,6 @@ pub mod dualsense_proto; #[cfg(target_os = "windows")] #[path = "inject/windows/dualsense_windows.rs"] pub mod dualsense_windows; -/// Windows: virtual DualSense **Edge** via the same UMDF minidriver + shared-memory channel -/// (device-type 2) — the wire back grips land on the Edge's native back/Fn buttons. -#[cfg(target_os = "windows")] -#[path = "inject/windows/dualsense_edge_windows.rs"] -pub mod dualsense_edge_windows; #[cfg(target_os = "linux")] #[path = "inject/linux/dualshock4.rs"] pub mod dualshock4; @@ -527,15 +527,6 @@ pub mod pad_slots; #[cfg(target_os = "linux")] #[path = "inject/linux/steam_controller.rs"] pub mod steam_controller; -/// Linux: virtual Nintendo Switch Pro Controller via UHID (kernel `hid-nintendo`). -#[cfg(target_os = "linux")] -#[path = "inject/linux/switch_pro.rs"] -pub mod switch_pro; -/// Transport-independent Switch Pro Controller codec + the canned `hid-nintendo` handshake -/// replies, used by the Linux UHID backend ([`switch_pro`]). -#[cfg(target_os = "linux")] -#[path = "inject/proto/switch_proto.rs"] -pub mod switch_proto; /// Linux: virtual Steam Deck via the USB gadget subsystem (`raw_gadget` + `dummy_hcd`) — the only /// virtual-Deck transport Steam Input promotes (presents the controller on USB interface 2). /// SteamOS-host only (needs `dummy_hcd` + `raw_gadget`). @@ -559,6 +550,15 @@ pub mod steam_remap; #[cfg(target_os = "linux")] #[path = "inject/linux/steam_usbip.rs"] pub mod steam_usbip; +/// Linux: virtual Nintendo Switch Pro Controller via UHID (kernel `hid-nintendo`). +#[cfg(target_os = "linux")] +#[path = "inject/linux/switch_pro.rs"] +pub mod switch_pro; +/// Transport-independent Switch Pro Controller codec + the canned `hid-nintendo` handshake +/// replies, used by the Linux UHID backend ([`switch_pro`]). +#[cfg(target_os = "linux")] +#[path = "inject/proto/switch_proto.rs"] +pub mod switch_proto; /// The generic stateful virtual-pad manager ([`uhid_manager::UhidManager`]) — event routing, frame /// merge, heartbeat, and feedback pump shared by the five UHID/UMDF backends; each supplies only /// its per-controller protocol via [`uhid_manager::PadProto`] (G12). diff --git a/crates/punktfunk-host/src/inject/linux/dualsense.rs b/crates/punktfunk-host/src/inject/linux/dualsense.rs index 7b79fb14..4fd2a6a6 100644 --- a/crates/punktfunk-host/src/inject/linux/dualsense.rs +++ b/crates/punktfunk-host/src/inject/linux/dualsense.rs @@ -13,10 +13,9 @@ //! UMDF-driver backend; this module is just the `/dev/uhid` plumbing around it. use super::dualsense_proto::{ - edge_paddle_bits, parse_ds_output, serialize_state, DsFeedback, DsState, - DS_EDGE_PRODUCT, DS_FEATURE_CALIBRATION, DS_FEATURE_FIRMWARE, DS_FEATURE_PAIRING, - DS_INPUT_REPORT_LEN, DS_PRODUCT, DS_TOUCH_H, DS_TOUCH_W, DS_VENDOR, DUALSENSE_EDGE_RDESC, - DUALSENSE_RDESC, + edge_paddle_bits, parse_ds_output, serialize_state, DsFeedback, DsState, DS_EDGE_PRODUCT, + DS_FEATURE_CALIBRATION, DS_FEATURE_FIRMWARE, DS_FEATURE_PAIRING, DS_INPUT_REPORT_LEN, + DS_PRODUCT, DS_TOUCH_H, DS_TOUCH_W, DS_VENDOR, DUALSENSE_EDGE_RDESC, DUALSENSE_RDESC, }; use crate::inject::uhid_manager::{PadFeedback, PadProto, UhidManager}; use anyhow::{Context, Result}; @@ -102,7 +101,8 @@ impl DualSensePad { format!("open {UHID_PATH} (is the 60-punktfunk.rules uhid rule installed + are you in 'input'?)") })?; let mut ds = DualSensePad { fd, seq: 0, ts: 0 }; - ds.send_create2(index, id).context("UHID_CREATE2 DualSense")?; + ds.send_create2(index, id) + .context("UHID_CREATE2 DualSense")?; Ok(ds) } diff --git a/crates/punktfunk-host/src/inject/linux/switch_pro.rs b/crates/punktfunk-host/src/inject/linux/switch_pro.rs index 0ecdbae0..ae333ae1 100644 --- a/crates/punktfunk-host/src/inject/linux/switch_pro.rs +++ b/crates/punktfunk-host/src/inject/linux/switch_pro.rs @@ -84,7 +84,12 @@ impl SwitchProPad { let mut ev = [0u8; UHID_EVENT_SIZE]; ev[0..4].copy_from_slice(&UHID_CREATE2.to_ne_bytes()); // union (uhid_create2_req) starts at byte 4. - put_cstr(&mut ev, 4, 128, &format!("Punktfunk Switch Pro Controller {index}")); // name[128] + put_cstr( + &mut ev, + 4, + 128, + &format!("Punktfunk Switch Pro Controller {index}"), + ); // name[128] put_cstr(&mut ev, 132, 64, &format!("punktfunk/switchpro/{index}")); // phys[64] put_cstr(&mut ev, 196, 64, &format!("punktfunk-swpro-{index}")); // uniq[64] ev[260..262].copy_from_slice(&(PROCON_RDESC.len() as u16).to_ne_bytes()); // rd_size @@ -123,7 +128,13 @@ impl SwitchProPad { let reply = match id { // Device info — the fatal one (probe aborts without it): type = Pro Controller + // this pad's virtual MAC. Real hardware acks it with 0x82. - 0x02 => build_subcmd_reply(&st, self.timer, 0x82, id, &device_info_payload(&switch_mac(self.index))), + 0x02 => build_subcmd_reply( + &st, + self.timer, + 0x82, + id, + &device_info_payload(&switch_mac(self.index)), + ), // SPI flash read: echoed addr + len + the canned calibration bytes. An unmapped // range answers zeroes (echoed header, zero data) — the driver then warns and uses // its defaults instead of stalling through 2 × 1 s timeouts. @@ -134,7 +145,11 @@ impl SwitchProPad { .unwrap_or(0); let len = args.get(4).copied().unwrap_or(0); let payload = spi_flash_read(addr, len).unwrap_or_else(|| { - tracing::debug!(addr = format!("{addr:#x}"), len, "unmapped SPI read — zero fill"); + tracing::debug!( + addr = format!("{addr:#x}"), + len, + "unmapped SPI read — zero fill" + ); let mut p = Vec::with_capacity(5 + len as usize); p.extend_from_slice(&addr.to_le_bytes()); p.push(len); diff --git a/crates/punktfunk-host/src/inject/proto/steam_proto.rs b/crates/punktfunk-host/src/inject/proto/steam_proto.rs index a42bd1f4..fdcb0ef1 100644 --- a/crates/punktfunk-host/src/inject/proto/steam_proto.rs +++ b/crates/punktfunk-host/src/inject/proto/steam_proto.rs @@ -404,7 +404,7 @@ pub fn sc_from_gamepad( // SC grips at the Deck's L5/R5 bit positions (9.7 / 10.0): the wire primary pair L4/R4. set(&mut b, on(gs::BTN_PADDLE2), btn::L5); // left grip set(&mut b, on(gs::BTN_PADDLE1), btn::R5); // right grip - // Joystick click (10.6 — the bit the Deck calls L3) + right-pad click (10.2). + // Joystick click (10.6 — the bit the Deck calls L3) + right-pad click (10.2). set(&mut b, on(gs::BTN_LS_CLICK), btn::L3); set( &mut b, @@ -444,7 +444,7 @@ pub fn serialize_sc_state(r: &mut [u8; STEAM_REPORT_LEN], st: &SteamState, seq: r[10] = ((buttons >> 16) & 0xFF) as u8; r[11] = (st.lt >> 7).min(255) as u8; // left trigger, u8 r[12] = (st.rt >> 7).min(255) as u8; // right trigger, u8 - // Bytes 16..20 carry EITHER the joystick OR the left pad, per the 10.3 touched bit. + // Bytes 16..20 carry EITHER the joystick OR the left pad, per the 10.3 touched bit. let (x, y) = if buttons & btn::LPAD_TOUCH != 0 { (st.lpad_x, st.lpad_y) } else { @@ -824,11 +824,7 @@ mod tests { fn sc_serialize_and_mapping() { // Full mapping: face + grips + clicks + a deflected right stick. let s = sc_from_gamepad( - gs::BTN_A - | gs::BTN_PADDLE1 - | gs::BTN_PADDLE2 - | gs::BTN_LS_CLICK - | gs::BTN_RS_CLICK, + gs::BTN_A | gs::BTN_PADDLE1 | gs::BTN_PADDLE2 | gs::BTN_LS_CLICK | gs::BTN_RS_CLICK, 1000, -2000, 3000, diff --git a/crates/punktfunk-host/src/inject/proto/switch_proto.rs b/crates/punktfunk-host/src/inject/proto/switch_proto.rs index d4ab7aed..8f1aa2b2 100644 --- a/crates/punktfunk-host/src/inject/proto/switch_proto.rs +++ b/crates/punktfunk-host/src/inject/proto/switch_proto.rs @@ -486,7 +486,7 @@ mod tests { fn pack12_layout() { assert_eq!(pack12(0x578, 0x578), [0x78, 0x85, 0x57]); // 1400/1400 (the cal pair) assert_eq!(pack12(0x800, 0x800), [0x00, 0x08, 0x80]); // 2048/2048 (the center pair) - // Extract back: a = b0 | (b1 & 0xF) << 8; b = (b1 >> 4) | b2 << 4. + // Extract back: a = b0 | (b1 & 0xF) << 8; b = (b1 >> 4) | b2 << 4. let p = pack12(0xABC, 0x123); let a = p[0] as u16 | ((p[1] as u16 & 0xF) << 8); let b = ((p[1] as u16) >> 4) | ((p[2] as u16) << 4); diff --git a/crates/punktfunk-host/src/inject/windows/dualsense_windows.rs b/crates/punktfunk-host/src/inject/windows/dualsense_windows.rs index 3b4de1ec..a30a8551 100644 --- a/crates/punktfunk-host/src/inject/windows/dualsense_windows.rs +++ b/crates/punktfunk-host/src/inject/windows/dualsense_windows.rs @@ -88,6 +88,11 @@ pub(super) struct SwDeviceProfile<'a> { pub hwid: &'a str, /// The USB VID&PID token (`VID_054C&PID_0CE6`) used to synthesize the USB hardware/compatible ids. pub usb_vid_pid: &'a str, + /// USB composite interface number to synthesize (`&MI_xx` appended to the USB hardware ids). + /// hidclass mirrors the parent's `USB\VID…` tokens into the HID child's hardware ids, and + /// hidapi/SDL/Steam parse the child's `MI_` token as `bInterfaceNumber` (defaulting to 0 when + /// absent) — the Steam Deck's controller lives on interface 2, the gate the N4 spike hit. + pub usb_mi: Option, /// Device description shown in Device Manager. pub description: &'a str, } @@ -126,8 +131,9 @@ pub(super) fn create_swdevice(p: &SwDeviceProfile) -> Result<(HSWDEVICE, Option< .chain(std::iter::once(0)) .collect() }; - let usb_rev = format!("USB\\{}&REV_0100", p.usb_vid_pid); - let usb = format!("USB\\{}", p.usb_vid_pid); + let mi = p.usb_mi.map(|n| format!("&MI_{n:02}")).unwrap_or_default(); + let usb_rev = format!("USB\\{}&REV_0100{mi}", p.usb_vid_pid); + let usb = format!("USB\\{}{mi}", p.usb_vid_pid); let hwids = multi_sz(&[ p.hwid, // FIRST → the INF binds our UMDF driver on this id usb_rev.as_str(), @@ -297,6 +303,7 @@ impl DsWinPad { container_index: index, hwid: id.hwid, usb_vid_pid: id.usb_vid_pid, + usb_mi: None, // single-interface USB devices (real DS/Edge have no MI_ token) description: id.description, }) { Ok((h, i)) => (Some(h), i), @@ -498,6 +505,9 @@ pub fn deck_spike_hold(index: u8, secs: u64) -> Result<()> { container_index: index, hwid: "pf_steamdeck", usb_vid_pid: "VID_28DE&PID_1205", + // The Deck's controller interface — the promotion gate the first spike run hit + // (hidapi parses MI_ from the child hwids; absent = interface 0, Steam wants 2). + usb_mi: Some(2), description: "punktfunk Virtual Steam Deck (spike)", })?; let _sw = super::gamepad_raii::SwDevice::new(hsw); @@ -515,9 +525,8 @@ pub fn deck_spike_hold(index: u8, secs: u64) -> Result<()> { channel.pump(); // Log any feature/output traffic Steam sends — each one is spike evidence. // SAFETY: base points at SHM_SIZE bytes; OFF_OUT_SEQ is in range. - let seq = unsafe { - std::ptr::read_unaligned(channel.data_base().add(OFF_OUT_SEQ) as *const u32) - }; + let seq = + unsafe { std::ptr::read_unaligned(channel.data_base().add(OFF_OUT_SEQ) as *const u32) }; if seq != last_out_seq { last_out_seq = seq; let mut out = [0u8; 16]; diff --git a/crates/punktfunk-host/src/inject/windows/dualshock4_windows.rs b/crates/punktfunk-host/src/inject/windows/dualshock4_windows.rs index c119fa05..110d53e0 100644 --- a/crates/punktfunk-host/src/inject/windows/dualshock4_windows.rs +++ b/crates/punktfunk-host/src/inject/windows/dualshock4_windows.rs @@ -64,6 +64,7 @@ impl Ds4WinPad { container_index: index, hwid: "pf_dualshock4", usb_vid_pid: "VID_054C&PID_09CC", + usb_mi: None, description: "punktfunk Virtual DualShock 4", }) { Ok((h, id)) => (Some(h), id), diff --git a/crates/punktfunk-host/src/main.rs b/crates/punktfunk-host/src/main.rs index 0c667d74..f14087af 100644 --- a/crates/punktfunk-host/src/main.rs +++ b/crates/punktfunk-host/src/main.rs @@ -432,7 +432,8 @@ fn real_main() -> Result<()> { // report byte 10 (0x80|0x40) next to Cross. let edge = args.iter().any(|a| a == "--edge"); let extra_buttons: u32 = if edge { - punktfunk_core::input::gamepad::BTN_PADDLE1 | punktfunk_core::input::gamepad::BTN_PADDLE2 + punktfunk_core::input::gamepad::BTN_PADDLE1 + | punktfunk_core::input::gamepad::BTN_PADDLE2 } else { 0 }; diff --git a/crates/punktfunk-host/src/punktfunk1.rs b/crates/punktfunk-host/src/punktfunk1.rs index e75d2399..fa61a44d 100644 --- a/crates/punktfunk-host/src/punktfunk1.rs +++ b/crates/punktfunk-host/src/punktfunk1.rs @@ -5400,14 +5400,14 @@ mod tests { pick_gamepad(DualSenseEdge, None, false, true), DualSenseEdge ); - assert_eq!( - pick_gamepad(Auto, Some("edge"), true, false), - DualSenseEdge - ); + assert_eq!(pick_gamepad(Auto, Some("edge"), true, false), DualSenseEdge); assert_eq!(pick_gamepad(DualSenseEdge, None, false, false), Xbox360); // Switch Pro: native on Linux (UHID hid-nintendo); Xbox360 on Windows and elsewhere. assert_eq!(pick_gamepad(SwitchPro, None, true, false), SwitchPro); - assert_eq!(pick_gamepad(Auto, Some("switchpro"), true, false), SwitchPro); + assert_eq!( + pick_gamepad(Auto, Some("switchpro"), true, false), + SwitchPro + ); assert_eq!(pick_gamepad(Auto, Some("switch"), true, false), SwitchPro); assert_eq!(pick_gamepad(SwitchPro, None, false, true), Xbox360); assert_eq!(pick_gamepad(SwitchPro, None, false, false), Xbox360); diff --git a/scripts/git-hooks/pre-commit b/scripts/git-hooks/pre-commit new file mode 100755 index 00000000..6473f721 --- /dev/null +++ b/scripts/git-hooks/pre-commit @@ -0,0 +1,9 @@ +#!/bin/sh +# Repo pre-commit hook: the same rustfmt gates as pre-push, but at commit time for faster +# feedback. Enable once per clone: +# +# git config core.hooksPath scripts/git-hooks +# +# NOTE this is the convenience layer only — plumbing commits (commit-tree) bypass pre-commit, +# which is why pre-push re-runs the identical checks and is the actual enforcement point. +exec "$(git rev-parse --show-toplevel)/scripts/git-hooks/pre-push" diff --git a/scripts/git-hooks/pre-push b/scripts/git-hooks/pre-push new file mode 100755 index 00000000..cfa87958 --- /dev/null +++ b/scripts/git-hooks/pre-push @@ -0,0 +1,37 @@ +#!/bin/sh +# Repo pre-push hook: run the exact rustfmt gates CI runs, so a push can never fail on +# formatting alone. Enable once per clone: +# +# git config core.hooksPath scripts/git-hooks +# +# Kept to the CHEAP checks on purpose (rustfmt only parses — a couple of seconds): clippy/tests +# stay in CI and the per-box verify recipes. Runs regardless of how the commits were made +# (plain `git commit`, amends, or plumbing like commit-tree — pre-push sees them all). +# +# Escape hatch for a genuine emergency: `git push --no-verify`. + +set -eu +root=$(git rev-parse --show-toplevel) + +fail() { + echo "pre-push: $1" >&2 + echo "pre-push: fix with: $2" >&2 + echo "pre-push: (bypass in an emergency with: git push --no-verify)" >&2 + exit 1 +} + +# 1. Main workspace — mirrors ci.yml "Format": cargo fmt --all --check. +if ! (cd "$root" && cargo fmt --all --check >/dev/null 2>&1); then + fail "main workspace is not rustfmt-clean (ci.yml would fail)" \ + "cargo fmt --all" +fi + +# 2. UMDF driver workspace — mirrors windows-drivers.yml's gate (the shipped drivers + the +# audited safe layer; pf-vdisplay is deliberately NOT gated there, so not here either). +if ! (cd "$root/packaging/windows/drivers" \ + && cargo fmt -p pf-umdf-util -p pf-xusb -p pf-dualsense --check >/dev/null 2>&1); then + fail "driver workspace is not rustfmt-clean (windows-drivers.yml would fail)" \ + "(cd packaging/windows/drivers && cargo fmt -p pf-umdf-util -p pf-xusb -p pf-dualsense)" +fi + +exit 0