enricobuehler
d6596ff81b
Rework the client READMEs to be accurate and inviting to first-time
visitors, and fill in the gaps where crates and tools had none.
- Rewrite clients/{apple,android,decky} READMEs (features-first, trim
dense internal narrative; drop the stale "one session at a time" /
"renegotiation not implemented" section from the Apple README).
- Add READMEs for clients/{linux,windows,probe}, which had none.
- Add crate READMEs for punktfunk-host, punktfunk-core, pf-driver-proto.
- Add brief READMEs for tools/{loss-harness,latency-probe}.
- Fix packaging/README duplicate "Option B" heading (bootc -> Option C).
- Fix docs-site/README stale docs/ -> design/ reference.
- De-stale packaging/windows/drivers/pf-dualsense README (drop "M0 spike"
/ external-checkout framing; reflect in-tree workspace + shipped +
installer-bundled + multi-pad), keeping the driver-authoring lore.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1.0 KiB
pf-driver-proto
The shared host ↔ driver binary contract for punktfunk's Windows pf-vdisplay virtual display — the control IOCTLs and the IDD-push frame transport, defined exactly once.
It's a path dependency of both the host workspace (crates/punktfunk-host)
and the out-of-workspace driver workspace (packaging/windows/drivers/),
so it must resolve identically from either build graph. That's why it's deliberately self-contained:
no_std (+ alloc), platform-neutral (GUID/LUID are plain integers each side converts to its own OS
type), and free of *.workspace = true inheritance.
Defining every wire struct here — with const size/offset asserts and bytemuck round-trips — turns
host↔driver ABI drift into a compile error instead of a silent frame or IOCTL corruption.
See the crate root (src/) for the wire types; the Windows virtual-display design is in
design/windows-virtual-display-rust-port.md.