feat(host/pads): the Windows Xbox backend, compiled and tested on Windows

Adds `xbox_windows` — the host half of the HID Xbox pad: the sealed-channel open under
the Bluetooth identity (SwDeviceCreate `pf_xboxwireless` + `USB\VID_045E&PID_0B13`, so
hidclass derives the real-pad `HID\VID_045E&PID_0B13` child ids), device_type 4 stamped
before the magic, and the `PadProto` impl that publishes through `xbox_proto`. No rich
plane: an Xbox pad has no touchpad, lightbar, adaptive triggers or IMU in its HID
contract, so apply_rich/clear_rich/neutralize_gyro are deliberately no-ops.

Rumble comes back off the driver's republished output reports. The Bluetooth rumble
report carries magnitudes on a 0..100 scale, not 0..255 — assuming otherwise silently
costs 60% of the range — and the enable mask gates each motor independently.

The two INF/driver guard tests now cover the new identity. `hwid_devtype_table_matches
_the_driver` caught the addition on its vacuity count, which is exactly what it is for.

Verified on the Arc laptop (.221, Win11 26200): `cargo test -p pf-inject --lib` 100/100
green, `cargo clippy --lib --profile test -- -D warnings` clean, fmt clean. Note
`clippy --all-targets` fails there on a PRE-EXISTING issue unrelated to this change —
tests/motion_contract.rs imports the linux-gated `switch_proto`.

Still unbuilt: the driver itself (.221 has no WDK) and the host routing that would send
an Xbox pad here instead of to XUSB. The report descriptor remains constructed rather
than captured — diff it against a real pad before shipping.
This commit is contained in:
2026-08-09 12:24:14 +02:00
parent f266636392
commit 99f2130b28
3 changed files with 300 additions and 1 deletions
@@ -1018,6 +1018,7 @@ mod drain_tests {
WinDsIdentity::dualsense_edge().hwid,
super::super::dualshock4_windows::DS4_HWID,
super::super::steam_deck_windows::DECK_HWID,
super::super::xbox_windows::XBOX_HWID,
] {
let want = hwid.to_ascii_lowercase();
let rooted = format!("root\\{want}");
@@ -1071,7 +1072,7 @@ mod drain_tests {
.collect();
assert_eq!(
entries.len(),
4,
5,
"parsed {entries:?} out of the driver's table — the shape changed and this test went \
vacuous; fix the parse rather than deleting the assert"
);
@@ -1098,6 +1099,10 @@ mod drain_tests {
super::super::steam_deck_windows::DECK_HWID,
pf_driver_proto::gamepad::DEVTYPE_STEAMDECK,
),
(
super::super::xbox_windows::XBOX_HWID,
pf_driver_proto::gamepad::DEVTYPE_XBOX,
),
] {
let want = hwid.to_ascii_lowercase();
let got = entries.iter().find(|(id, _)| *id == want);
@@ -0,0 +1,288 @@
//! Virtual Xbox Wireless Controller on Windows via the UMDF HID minidriver (device-type 4) — the
//! HID-visible alternative to [`super::gamepad_windows`]'s XUSB companion.
//!
//! **Why this exists.** `pf-xusb` registers only `GUID_DEVINTERFACE_XUSB` and exposes no HID
//! collection, so Steam's hidapi enumeration, DirectInput, `joy.cpl` and WGI/GameInput cannot see
//! the pad at all — only classic `XInputGetState` via xinput1_4's interface walk ever does. A field
//! report (2026-08-09) spent two weeks on a dead controller for exactly that reason; switching the
//! client to DualSense — a real HID pad through this very driver — fixed it in seconds. This
//! backend gives the Xbox pad the same footing, reusing the driver, sealed channel, INF, signing
//! and install path the PlayStation pads already ship on.
//!
//! Transport is identical to the PS/Deck pads: a `SwDeviceCreate` devnode plus the sealed
//! shared-memory channel, with `device_type = 4` stamped before the magic so the driver resolves
//! the Xbox identity before hidclass asks it for descriptors. The codec is
//! [`super::xbox_proto`]; the report it writes mirrors the driver's `XBOX_RDESC` byte for byte.
//!
//! ⚠️ **The synthesized USB identity is a BLUETOOTH Xbox pad (`045E:0B13`) on purpose.** The wired
//! ids the rest of the tree uses (`045E:028E` X-Box 360, `045E:02EA` Xbox One S USB) are
//! vendor-class XUSB/GIP devices that expose no HID interface on real hardware — a HID child
//! claiming one is a device that has never existed, and Windows' inbox promotion would have nothing
//! to match. See `pf-gamepad`'s `XBOX_PID` for the alternate to try if `0B13` is not promoted.
//!
//! ⚠️ **No rich plane.** An Xbox pad has no touchpad, no lightbar, no adaptive triggers and no
//! IMU in its HID contract, so `apply_rich` / `clear_rich` / `neutralize_gyro` are deliberately
//! no-ops — same shape as the Linux xpad backend. Motion sent toward this backend is decoded and
//! dropped, which is what `GamepadPref::motion_reaches` already tells clients.
use super::dualsense_windows::{
create_swdevice, publish_input, OutputDrain, SwDeviceProfile, OFF_DEVTYPE, OFF_DRIVER_PROTO,
OFF_INPUT, OFF_OUT_RING_VER, OFF_PAD_INDEX, SHM_MAGIC, SHM_SIZE,
};
use super::gamepad_raii::PadChannel;
use super::xbox_proto::{neutral_xbox_report, serialize_xbox_state, XboxState, XBOX_REPORT_LEN};
use crate::uhid_manager::{PadFeedback, PadProto, UhidManager};
use anyhow::Result;
use punktfunk_core::quic::RichInput;
use std::time::Duration;
/// The hardware id this pad's devnode carries. Must be one `pf_gamepad.inx` declares — a package
/// rename must never touch it (`dualsense_windows::tests::hwid_matches_inf` enforces that).
pub(super) const XBOX_HWID: &str = "pf_xboxwireless";
/// The USB VID&PID token synthesized onto the devnode so hidclass derives the real-pad HID child
/// ids (`HID\VID_045E&PID_0B13`) — the identity SDL/RawInput/WGI read, and the one Windows' own
/// Xbox INFs match when they decide whether to promote a HID gamepad to an Xbox-profile pad.
const XBOX_USB_VID_PID: &str = "VID_045E&PID_0B13";
/// A single virtual Xbox pad: the `SwDeviceCreate`'d `pf_xbox_<index>` devnode plus the sealed
/// shared-memory channel. Dropping it removes the devnode and closes both sections.
pub struct XboxWinPad {
/// Per-session devnode from SwDeviceCreate, when it succeeds (RAII — `SwDeviceClose` on drop).
_sw: Option<super::gamepad_raii::SwDevice>,
/// The sealed channel: unnamed DATA section (`PadShm`) + bootstrap mailbox + handle delivery.
channel: PadChannel,
/// Watches the section's `driver_proto` field and logs attach / never-attached diagnosis.
attach: super::gamepad_raii::DriverAttach,
/// This pad's v2.3 input-seqlock generation — see `publish_input`.
input_gen: u32,
/// Output-plane cursor: ring drain (v2.1+ driver) or legacy latest-slot seq (old driver).
drain: OutputDrain,
}
impl XboxWinPad {
/// Create the sealed channel, stamp `device_type = Xbox` FIRST + the pad index + the neutral
/// report + the magic LAST, then spawn the devnode under the Bluetooth Xbox identity.
fn open(index: u8) -> Result<XboxWinPad> {
let boot_name = pf_driver_proto::gamepad::pad_boot_name(index);
let mut channel = PadChannel::create(boot_name.clone(), SHM_SIZE)?;
let base = channel.data_base();
// SAFETY: base points at SHM_SIZE writable bytes; the OFF_* offsets are in range. The
// device_type MUST land before the magic — the driver reads it the moment it attaches, and
// a late stamp enumerates the pad with the default DualSense identity (the Deck's bug).
unsafe {
*base.add(OFF_DEVTYPE) = pf_driver_proto::gamepad::DEVTYPE_XBOX;
std::ptr::write_unaligned(base.add(OFF_PAD_INDEX) as *mut u32, index as u32);
// Ring capability `2` = "this host drains the v2.2 long ring" (see the DualSense open).
std::ptr::write_unaligned(base.add(OFF_OUT_RING_VER) as *mut u32, 2);
std::ptr::write_unaligned(
base.add(OFF_INPUT) as *mut [u8; XBOX_REPORT_LEN],
neutral_xbox_report(),
);
std::ptr::write_unaligned(base as *mut u32, SHM_MAGIC);
}
let inst = format!("pf_xbox_{index}");
let (hsw, instance_id) = create_swdevice(&SwDeviceProfile {
instance: &inst,
container_tag: 0x5046_5842, // "PFXB"
container_index: index,
hwid: XBOX_HWID,
usb_vid_pid: XBOX_USB_VID_PID,
// A Bluetooth pad is not a USB composite device, so there is no interface number to
// synthesize — unlike the Deck, whose Steam promotion gate needs `&MI_02`.
usb_mi: None,
description: "Punktfunk Virtual Xbox Wireless Controller",
})?; // Propagate — swallowing latched the slot to a pad with no devnode (see the DS4 twin).
channel.bind_devnode(
index as u32,
instance_id.clone(),
super::gamepad_raii::ProofTransport::HidFeatureReport,
);
let _sw = Some(super::gamepad_raii::SwDevice::new(hsw));
// Bounded eager delivery — the driver must read `device_type = 4` before hidclass asks it
// for descriptors, or the pad enumerates as a DualSense.
channel.deliver_eager(Duration::from_millis(1500));
Ok(XboxWinPad {
_sw,
channel,
attach: super::gamepad_raii::DriverAttach::new(
"pf_xboxwireless",
"pf_gamepad.inf", // one driver package serves every identity
"C:\\Windows\\ServiceProfiles\\LocalService\\AppData\\Local\\Temp\\pf_gamepad-driver.log",
boot_name,
instance_id,
),
input_gen: 0,
drain: OutputDrain::new(),
})
}
/// Serialize `st` and publish it to the section's input slot under the v2.3 seqlock, so a
/// driver read can never land mid-copy.
fn write_state(&mut self, st: &XboxState) {
let r = serialize_xbox_state(st);
// SAFETY: `data_base()` points at a live SHM_SIZE-byte section and `r` is the codec's
// fixed-size report.
unsafe { publish_input(self.channel.data_base(), &mut self.input_gen, &r) };
}
/// Poll the section's output slot for a game's rumble, tick the sealed-channel delivery and
/// feed the driver-attach health watcher.
fn service(&mut self) -> (Option<(u16, u16)>, bool) {
self.channel.pump();
// SAFETY: base points at SHM_SIZE bytes.
let proto = unsafe {
std::ptr::read_unaligned(self.channel.data_base().add(OFF_DRIVER_PROTO) as *const u32)
};
self.attach.observe(proto);
let mut rumble = None;
let base = self.channel.data_base();
let resync = self.drain.drain(base, |bytes| {
if let Some(r) = parse_xbox_output(bytes) {
rumble = Some(r); // oldest → newest: the last rumble-carrying report wins
}
});
(rumble, resync)
}
}
/// Parse an Xbox output report into `(low, high)` motor levels on the wire's 0..65535 scale.
///
/// The Bluetooth Xbox rumble report is id `0x03`: `[id, enable, left_trigger, right_trigger,
/// left, right, duration, delay, loop]`, with magnitudes on a **0..100** scale (not 0..255 — a
/// detail that silently costs 60 % of the rumble range if you assume otherwise). The `enable`
/// mask picks which motors the values apply to; bit 2 is the left (low-frequency) motor and bit 3
/// the right (high-frequency) one, matching how the wire's `low`/`high` pair is used elsewhere.
/// The two trigger motors have no wire representation and are ignored.
///
/// ⚠️ Never seen a real report — this shape is from the documented protocol, not a capture.
fn parse_xbox_output(bytes: &[u8]) -> Option<(u16, u16)> {
// The driver republishes output reports report-id-prefixed, like the PS backends.
if bytes.len() < 6 || bytes[0] != 0x03 {
return None;
}
let enable = bytes[1];
let scale = |v: u8| -> u16 { (v.min(100) as u32 * 65535 / 100) as u16 };
let low = if enable & 0x04 != 0 {
scale(bytes[4])
} else {
0
};
let high = if enable & 0x08 != 0 {
scale(bytes[5])
} else {
0
};
Some((low, high))
}
/// The Windows-Xbox half of the shared stateful manager (see [`PadProto`]). Lifecycle (slot table,
/// unplug sweep, heartbeat, rumble dedup) lives in [`UhidManager`], exactly as for the PS pads.
#[derive(Default)]
pub struct XboxWinProto;
impl PadProto for XboxWinProto {
type Pad = XboxWinPad;
type State = XboxState;
const LABEL: &'static str = "Xbox Wireless/Windows";
const DEVICE: &'static str = "Xbox Wireless Controller";
const CREATE_HINT: &'static str =
" (install/repair: punktfunk-host.exe driver install --gamepad)";
fn open(&mut self, idx: u8) -> Result<XboxWinPad> {
let p = XboxWinPad::open(idx)?;
tracing::info!(
index = idx,
"virtual Xbox Wireless Controller created (Windows UMDF HID identity 045E:0B13)"
);
Ok(p)
}
fn neutral(&self) -> XboxState {
XboxState::default()
}
/// Every control this pad has arrives in the frame, so a frame fully replaces the state —
/// there are no rich-plane fields to preserve (contrast the Deck's trackpads/motion).
fn merge_frame(&self, _prev: &XboxState, f: &punktfunk_core::input::GamepadFrame) -> XboxState {
XboxState::from_gamepad(
f.buttons,
f.left_trigger,
f.right_trigger,
f.ls_x,
f.ls_y,
f.rs_x,
f.rs_y,
)
}
/// No rich plane on an Xbox pad — see the module note.
fn apply_rich(&self, _st: &mut XboxState, _rich: RichInput) {}
/// No motion plane, so there is never stale gyro to neutralize.
fn neutralize_gyro(&self, _st: &mut XboxState) -> bool {
false
}
fn clear_rich(&self, _st: &mut XboxState) {}
fn write_state(&self, pad: &mut XboxWinPad, st: &XboxState) {
pad.write_state(st);
}
/// Motor rumble on the universal 0xCA plane. No rich host→client feedback (no lightbar or
/// adaptive triggers), so `hidout` stays empty — parity with the Linux xpad backend.
fn service(&self, pad: &mut XboxWinPad, _idx: u8) -> PadFeedback {
let (rumble, resync) = pad.service();
PadFeedback {
rumble,
hidout: Vec::new(),
rumble_drove: Some(rumble.is_some()),
resync,
}
}
}
/// All virtual Xbox pads of a Windows session, with the same method surface (via the shared
/// [`UhidManager`]) as the other Windows pad managers.
pub type XboxWindowsManager = UhidManager<XboxWinProto>;
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn rumble_scales_off_the_zero_to_hundred_protocol_range() {
// Both motors enabled, full scale.
let full = [0x03, 0x0F, 0, 0, 100, 100, 0, 0, 1];
assert_eq!(parse_xbox_output(&full), Some((65535, 65535)));
// Half on the left motor only.
let half = [0x03, 0x04, 0, 0, 50, 100, 0, 0, 1];
assert_eq!(parse_xbox_output(&half), Some((32767, 0)));
}
/// A value above the protocol's 0..100 range must clamp, not wrap past full scale.
#[test]
fn out_of_range_magnitudes_clamp() {
let over = [0x03, 0x0F, 0, 0, 255, 255, 0, 0, 1];
assert_eq!(parse_xbox_output(&over), Some((65535, 65535)));
}
/// The enable mask gates each motor independently — a report that enables neither is a stop.
#[test]
fn the_enable_mask_gates_each_motor() {
let none = [0x03, 0x00, 0, 0, 100, 100, 0, 0, 1];
assert_eq!(parse_xbox_output(&none), Some((0, 0)));
let right_only = [0x03, 0x08, 0, 0, 100, 100, 0, 0, 1];
assert_eq!(parse_xbox_output(&right_only), Some((0, 65535)));
}
/// Anything that is not the rumble report — or is truncated — is ignored rather than parsed
/// out of whatever bytes happen to be there.
#[test]
fn non_rumble_reports_are_ignored() {
assert_eq!(parse_xbox_output(&[0x01, 0x0F, 0, 0, 100, 100]), None);
assert_eq!(parse_xbox_output(&[0x03, 0x0F, 0]), None);
assert_eq!(parse_xbox_output(&[]), None);
}
}
+6
View File
@@ -484,6 +484,12 @@ pub mod uhid_manager;
/// has until a Windows box is reachable.
#[path = "inject/proto/xbox_proto.rs"]
pub mod xbox_proto;
/// Windows: virtual Xbox Wireless Controller via the same UMDF minidriver (device-type 4) — the
/// HID-visible alternative to [`gamepad_windows`]'s XUSB companion, which Steam / WGI / GameInput /
/// DirectInput cannot enumerate at all because it registers only the XUSB device interface.
#[cfg(target_os = "windows")]
#[path = "inject/windows/xbox_windows.rs"]
pub mod xbox_windows;
/// Stub — virtual gamepads need Linux uinput or the Windows UMDF drivers; events are dropped elsewhere.
#[cfg(not(any(target_os = "linux", target_os = "windows")))]
pub mod gamepad {