puck_hid.cpp 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020
  1. #include "puck_hid.h"
  2. #include "bonds.h"
  3. #include "config.h"
  4. #include "identity.h"
  5. #include "haptics.h"
  6. #include "fault_diag.h"
  7. #include "rf_link.h"
  8. #include "triton.h"
  9. #include "mode_lizard.h"
  10. #include "wake_hid.h"
  11. #include "usb_tx.h"
  12. #include <Adafruit_TinyUSB.h>
  13. #include <Arduino.h>
  14. #include <string.h>
  15. #include "src/common/hid_reports.h"
  16. uint8_t g_fwdNewOnly = 1;
  17. // Content dedup for the Steam input forward: only forward a 0x45/0x42 report when its body EXCLUDING the
  18. // counter byte differs from the last one forwarded on that slot. The controller's counter (rep[1]) FREE-RUNS
  19. // -- it advances on every reply even with static input -- so the seq-based g_fwdNewOnly can't suppress true
  20. // repeats, and a poll rate above the controller's ~250 Hz sample rate forwards identical inputs with only the
  21. // counter bumped (host tester reads >250/s for a <=250 Hz controller). Content dedup is what the real puck
  22. // effectively does. On by default; console "CD" toggles for A/B.
  23. uint8_t g_fwdContentDedup = 1;
  24. SteamPuckController g_steamPuck;
  25. // millis() a power-off (0x9F) was last relayed to each slot; 0 = never. See puckNotePowerOff() / task().
  26. static volatile unsigned long g_powerOffMs[NSLOT] = { 0 };
  27. // Present a powered-off slot as DISCONNECTED to Steam for this long, to ride out the controller's post-off
  28. // F1 tail (measured ~<=1s of dying replies after the "off!" command) without bouncing the connection state.
  29. #define POWEROFF_HOLD_MS 2000u
  30. void puckNotePowerOff(uint8_t slot)
  31. {
  32. if (slot >=
  33. NSLOT) { // 0xFF broadcast ("all off": host suspend, panel/test button)
  34. for (int s = 0; s < NSLOT; s++)
  35. if (g_slot[s].used)
  36. g_powerOffMs[s] = millis();
  37. } else {
  38. g_powerOffMs[slot] = millis();
  39. }
  40. }
  41. // True while `slot` is inside its post-power-off hold window (present it disconnected, ignore dying replies).
  42. static inline bool slotPoweringOff(int slot)
  43. {
  44. return slot >= 0 && slot < NSLOT && g_powerOffMs[slot] &&
  45. (millis() - g_powerOffMs[slot] < POWEROFF_HOLD_MS);
  46. }
  47. // Cloned puck HID report descriptor: mouse(0x40)+keyboard(0x41)+vendor(FF00) with the 63-byte FEATURE
  48. // command reports on report id 1/2. Each of the 4 interfaces uses this.
  49. // Pure MODE_LIZARD only: same puck/lizard descriptor plus a tiny Consumer Control report for media keys.
  50. // MODE_STEAM must keep PUCK_HID_DESC verbatim so Steam's controller/haptics path sees the normal puck shape.
  51. static const uint8_t PUCK_LIZARD_HID_DESC[] = {
  52. 0x05, 0x01, 0x09, 0x02, 0xA1, 0x01, 0x85, 0x40, 0x09, 0x01, 0xA1, 0x00,
  53. 0x05, 0x09, 0x19, 0x01, 0x29, 0x02, 0x15, 0x00, 0x25, 0x01, 0x75, 0x01,
  54. 0x95, 0x02, 0x81, 0x02, 0x75, 0x06, 0x95, 0x01, 0x81, 0x01, 0x05, 0x01,
  55. 0x09, 0x30, 0x09, 0x31, 0x15, 0x81, 0x25, 0x7F, 0x75, 0x08, 0x95, 0x02,
  56. 0x81, 0x06, 0x95, 0x01, 0x09, 0x38, 0x81, 0x06, 0x05, 0x0C, 0x0A, 0x38,
  57. 0x02, 0x95, 0x01, 0x81, 0x06, 0xC0, 0xC0, 0x05, 0x01, 0x09, 0x06, 0xA1,
  58. 0x01, 0x85, 0x41, 0x05, 0x07, 0x19, 0xE0, 0x29, 0xE7, 0x15, 0x00, 0x25,
  59. 0x01, 0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x81, 0x01, 0x19, 0x00, 0x29,
  60. 0x65, 0x15, 0x00, 0x25, 0x65, 0x75, 0x08, 0x95, 0x06, 0x81, 0x00, 0xC0,
  61. 0x06, 0x00, 0xFF, 0x09, 0x01, 0xA1, 0x01, 0x85, 0x42, 0x15, 0x00, 0x26,
  62. 0xFF, 0x00, 0x75, 0x08, 0x95, 0x35, 0x09, 0x42, 0x81, 0x02, 0x85, 0x44,
  63. 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x05, 0x09, 0x44, 0x81,
  64. 0x02, 0x85, 0x79, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x01,
  65. 0x09, 0x79, 0x81, 0x02, 0x85, 0x43, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75,
  66. 0x08, 0x95, 0x0E, 0x09, 0x43, 0x81, 0x02, 0x85, 0x7B, 0x15, 0x00, 0x26,
  67. 0xFF, 0x00, 0x75, 0x08, 0x95, 0x0C, 0x09, 0x7B, 0x81, 0x02, 0x85, 0x45,
  68. 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x2D, 0x09, 0x45, 0x81,
  69. 0x02, 0x85, 0x80, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x09,
  70. 0x09, 0x80, 0x91, 0x02, 0x85, 0x81, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75,
  71. 0x08, 0x95, 0x07, 0x09, 0x81, 0x91, 0x02, 0x85, 0x82, 0x15, 0x00, 0x26,
  72. 0xFF, 0x00, 0x75, 0x08, 0x95, 0x03, 0x09, 0x82, 0x91, 0x02, 0x85, 0x83,
  73. 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x09, 0x09, 0x83, 0x91,
  74. 0x02, 0x85, 0x84, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x08,
  75. 0x09, 0x84, 0x91, 0x02, 0x85, 0x85, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75,
  76. 0x08, 0x95, 0x03, 0x09, 0x85, 0x91, 0x02, 0x85, 0x86, 0x15, 0x00, 0x26,
  77. 0xFF, 0x00, 0x75, 0x08, 0x95, 0x03, 0x09, 0x86, 0x91, 0x02, 0x85, 0x87,
  78. 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x3F, 0x09, 0x87, 0x91,
  79. 0x02, 0x85, 0x89, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75, 0x08, 0x95, 0x3F,
  80. 0x09, 0x89, 0x91, 0x02, 0x85, 0x88, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x75,
  81. 0x08, 0x95, 0x3F, 0x09, 0x88, 0x91, 0x02, 0x85, 0x01, 0x95, 0x3F, 0x09,
  82. 0x01, 0xB1, 0x02, 0x85, 0x02, 0x95, 0x3F, 0x09, 0x01, 0xB1, 0x02, 0xC0,
  83. 0x05, 0x0C, 0x09, 0x01, 0xA1, 0x01, 0x85, 0x03, 0x15, 0x00, 0x25, 0x01,
  84. 0x09, 0xE9, 0x09, 0xEA, 0x75, 0x01, 0x95, 0x02, 0x81, 0x02, 0x75, 0x06,
  85. 0x95, 0x01, 0x81, 0x01, 0xC0
  86. };
  87. static Adafruit_USBD_HID hid[NSLOT];
  88. // Drop Steam's relayed 0x81 CLEAR_DIGITAL_MAPPINGS in Steam mode (console "S81" toggles; on by default). It's
  89. // the confirmed amp-clicker in Steam's per-connect config and OpenPuck doesn't need it (own input translation
  90. // + id9=0 keepalive). Reversible from the console if it regresses.
  91. bool g_drop81 = true;
  92. // Per-slot shadow of the controller's SET_SETTINGS_VALUES array (id-indexed u16, ids 0..0x52). Steam writes
  93. // it with 0x87 and READS IT BACK with 0x89 to verify its config "took"; on the real puck the controller
  94. // answers 0x89 from this array. OpenPuck can't relay-and-return over the NO-ACK RF link, so it maintains the
  95. // shadow here and answers 0x89 from it -- WITHOUT this, Steam's verify never matches and it re-clears (0x81)
  96. // + re-writes (0x87) forever = the connect config storm that buzzes the amp and floods the usbd task.
  97. static uint16_t g_setShadow[NSLOT][0x53];
  98. // ---- feature-command capture (diagnostic) ---------------------------------------------------------------
  99. // Log the USB feature command channel (Steam's SET/GET) to serial to see the connect handshake -- WITHOUT a
  100. // Serial.printf on the fragile 800B usbd task (that path can blow the stack -> LOCKUP; it's why production
  101. // avoids printf here). handleSet/handleGet (usbd task) push a compact record under PRIMASK; puckCmdLogDrain()
  102. // prints them from loop() context. When g_cmdCapture is on, the high-rate I45 input stream is also suppressed
  103. // (rf_link) so the command sequence is readable. Toggle from the console with "FC".
  104. bool g_cmdCapture = true;
  105. struct FCmdRec {
  106. uint8_t dir; // 0 = SET (host->puck write), 1 = GET (host read)
  107. uint8_t iface; // HID interface index = bond slot the command hit
  108. uint8_t rid, cmd, len, b[10];
  109. };
  110. static FCmdRec g_fc[32];
  111. static volatile uint8_t g_fcHead, g_fcTail;
  112. static void fcPush(uint8_t dir, int iface, uint8_t rid, uint8_t cmd,
  113. uint8_t len, const uint8_t *b, uint8_t n)
  114. {
  115. if (!g_cmdCapture)
  116. return;
  117. uint32_t pm = __get_PRIMASK();
  118. __disable_irq();
  119. uint8_t h = g_fcHead, nx = (uint8_t)((h + 1) & 31);
  120. if (nx !=
  121. g_fcTail) { // drop-newest when full (loop drains fast); never block the usbd task
  122. g_fc[h].dir = dir;
  123. g_fc[h].iface = (uint8_t)iface;
  124. g_fc[h].rid = rid;
  125. g_fc[h].cmd = cmd;
  126. g_fc[h].len = len;
  127. for (uint8_t i = 0; i < 10; i++)
  128. g_fc[h].b[i] = (i < n) ? b[i] : 0;
  129. g_fcHead = nx;
  130. }
  131. __set_PRIMASK(pm);
  132. }
  133. void puckCmdLogDrain(void)
  134. {
  135. // boosted: runs at Steam's feature-storm rate and CDC flush enters the same TinyUSB DMA claim window
  136. // as HID sends (the issue-72 livelock; see usb_tx.cpp)
  137. usbTxBoost();
  138. while (g_fcHead != g_fcTail) {
  139. if (Serial.availableForWrite() < 70)
  140. break; // don't stall loop on CDC backpressure; resume next iteration
  141. FCmdRec r = g_fc[g_fcTail];
  142. g_fcTail = (uint8_t)((g_fcTail + 1) & 31);
  143. Serial.printf("# FC %s if=%u rid=%u cmd=%02X len=%u:",
  144. r.dir ? "GET" : "SET", r.iface, r.rid, r.cmd,
  145. r.len);
  146. for (uint8_t i = 0; i < 10; i++)
  147. Serial.printf(" %02X", r.b[i]);
  148. Serial.println();
  149. }
  150. usbTxUnboost();
  151. }
  152. // ===================== seamless LIZARD decision =====================
  153. // Steam, while running, re-sends settings report 0x87 (lizard-off) every ~3s as a heartbeat (captured on HW),
  154. // and ANY OUTPUT report likewise stamps g_steamAliveMs. When the heartbeat stops we fall back to lizard, so the
  155. // controller drives desktop keyboard+mouse whenever Steam isn't running. MODE_LIZARD forces lizard always.
  156. // millis of last Steam OUTPUT/settings write; 0 at boot => lizard until Steam appears
  157. static unsigned long g_steamAliveMs = 0;
  158. // Fall back to lizard this long after Steam's ~3s settings heartbeat stops. Keep >2x the cadence: the haptic
  159. // relay is gated by !lizardActive(), so a shorter window lets a jittered/delayed heartbeat flip lizard
  160. // mid-session while Steam is still running -> a haptic arriving in that window gets gated out (dropped). 7s
  161. // tolerates one missed beat. Do not shorten without a lizard trigger independent of the heartbeat timeout.
  162. #define LIZARD_WD_MS 7000u
  163. static bool g_autoLizard =
  164. true; // master switch; false => Steam mode always forwards 0x45
  165. // Single source of truth, shared by the USB input path AND the haptic relay gate: if we ever relay a 0x82 to
  166. // the controller while presenting lizard (Steam isn't reading 0x45 back), Steam loops the same haptic -> buzz.
  167. static inline bool steamDrivingGamepad()
  168. {
  169. return g_steamAliveMs && (millis() - g_steamAliveMs < LIZARD_WD_MS);
  170. }
  171. static inline bool lizardActive()
  172. {
  173. return modeIsPuck(g_usbMode) &&
  174. (g_usbMode == MODE_LIZARD ||
  175. (g_autoLizard && !steamDrivingGamepad()));
  176. }
  177. // Public accessor for the haptic layer (haptics.cpp gates the lizard-suppression keepalive on this).
  178. bool puckLizardActive()
  179. {
  180. return lizardActive();
  181. }
  182. static inline void hostStampAlive()
  183. {
  184. g_steamAliveMs = millis();
  185. }
  186. // Right after the host resumes from suspend, MUTE input forwarding briefly. Otherwise the controller's input
  187. // in that instant (a trackpad click/trigger, or residual button state from the wake gesture) gets forwarded
  188. // as a real click/keypress into the just-woken desktop. Set when task() sees the suspended->active transition.
  189. static unsigned long g_resumeMs = 0;
  190. #define POST_RESUME_MUTE_MS 1500u
  191. // How long to keep re-asserting the 0x79 DISCONNECT edge to Steam after a controller drops, so a single
  192. // lost report can't strand Steam in "connected" (see task()). Bounded to avoid forever-spamming disc.
  193. #define DISC_RESEND_MS 6000u
  194. // ===================== puck feature command channel =====================
  195. // `slot` is the interface index (interface N == bond slot N).
  196. static void handleSet(int slot, uint8_t rid, hid_report_type_t type,
  197. uint8_t const *b, uint16_t n)
  198. {
  199. // Steam OUTPUT reports 0x80-0x89. The haptic/actuator reports (0x80-0x86) are relayed to the controller,
  200. // and ONLY when they arrive on the CONNECTED slot's interface: we have one controller but expose 4 puck
  201. // slots, and a report aimed at a DIFFERENT slot made the controller buzz at random (the slot gate below
  202. // fixes that). Must NOT clamp to 0x82-only: ping/grip/test haptics ride other report IDs (0x85/0x86). The
  203. // 63-byte settings/config reports 0x87/0x88/0x89 are NOT haptics and reach the controller via the
  204. // feature-0x01 passthrough path instead.
  205. if (type == HID_REPORT_TYPE_OUTPUT) {
  206. if (rid >= 0x80 && rid <= 0x89) {
  207. // capture ALL OUTPUT reports (even un-relayed) for the 'H' dump
  208. hapLogAdd((uint8_t)slot, rid, b, n);
  209. // ANY Steam OUTPUT report (not just the 0x87 heartbeat) means Steam is present and driving ->
  210. // leave lizard for gamepad NOW, so a haptic arriving before the first 0x87 isn't relayed while
  211. // we're still presenting lizard (-> buzz loop).
  212. hostStampAlive();
  213. }
  214. // Post-resume mute also gates haptics: while onReport45 is muted Steam reads NO 0x45 back, which is the
  215. // exact condition under which Steam loops the same haptic command (-> connect/wake buzz loop).
  216. bool muted = g_resumeMs &&
  217. millis() - g_resumeMs < POST_RESUME_MUTE_MS;
  218. // Drop the OUTPUT-report form of 0x81 too (Steam's haptic-reset action, a 7-byte report id 0x81 with
  219. // payloads 00../01..). Same amp-clicker as the feature-0x01 0x81; g_drop81 only covered the feature
  220. // path, so this OUTPUT form was still leaking through and clicking. OpenPuck doesn't need it.
  221. bool dropOut81 =
  222. (g_drop81 && g_usbMode == MODE_STEAM && rid == 0x81);
  223. if (g_hapticRelay && rid >= 0x80 && rid <= 0x86 && !dropOut81 &&
  224. n >= 1 && hapticRelaySlotOk(slot) && !lizardActive() &&
  225. !muted) {
  226. if (!haptic82Blocked(slot)) {
  227. relayEnqueue(rid, b,
  228. (uint8_t)(n > RELAY_MAXP ?
  229. RELAY_MAXP :
  230. n),
  231. (uint8_t)slot);
  232. // Track on/off from what was actually RELAYED (= the controller's believed state): a
  233. // BLOCKED stop must leave "on" set (controller may be latched -> reconnect stop-burst),
  234. // a blocked ON must not set it (nothing reached the controller -> no spurious clicks).
  235. if (rid == 0x82)
  236. haptic82HostReport(b, n);
  237. }
  238. }
  239. #if OPK_LOG
  240. // Per-report Serial echo: gated to the diagnostic build only. handleSet runs on the TinyUSB device
  241. // task, whose FreeRTOS stack is just 800 bytes; a Serial.printf there costs 200-500B and, stacked
  242. // under TinyUSB's control-transfer frames + a preempting USB ISR, can blow the stack -> the exact
  243. // SP-corruption-during-exception-entry that shows up as RR_LOCKUP. Production keeps this path
  244. // printf-free; the same data is already in the OPK_LOG capture ring (hapLogAdd) for the WebUSB panel.
  245. if (Serial.availableForWrite() > 80) {
  246. Serial.printf("# OUT if%d rid=%02X n=%u:", slot, rid,
  247. n);
  248. for (uint16_t i = 0; i < n && i < 14; i++)
  249. Serial.printf(" %02X", b[i]);
  250. Serial.println();
  251. }
  252. #endif
  253. return;
  254. }
  255. if (type != HID_REPORT_TYPE_FEATURE || n < 1)
  256. return;
  257. Slot &S = g_slot[slot];
  258. uint8_t cmd = b[0], len = (n > 1) ? b[1] : 0;
  259. const uint8_t *pl = b + 2;
  260. uint16_t pln = (n >= 2) ? n - 2 : 0;
  261. // Capture EVERY feature SET (the whole cmd channel: 0x83 attr, 0xAE strings, 0xB4 conn, 0xA2/A3 bond, the
  262. // feature-1 relay, AND any host battery query) to the WebUSB ring so the panel's capture view shows it.
  263. hapLogAdd((uint8_t)slot, cmd, b, n);
  264. // ...and to the serial feature-command capture (diagnostic; drained in loop, see puckCmdLogDrain).
  265. fcPush(0, slot, rid, cmd, len, pl, pln > 10 ? 10 : (uint8_t)pln);
  266. // ...and to the flight recorder (survives a watchdog reset). This runs ON the fragile usbd task, so the
  267. // command flood that (theory) overflows it lands in the post-mortem trail rather than being lost with USB.
  268. faultDiagTrace(FR_SET, (uint16_t)((rid << 8) | cmd));
  269. // settings/haptic/LED report (incl. 0x87 lizard-off heartbeat, SDL Triton lizard-disable)
  270. if (cmd >= 0x80 && cmd <= 0x89)
  271. hostStampAlive();
  272. // Controller power-off: Steam's "turn off controller" is feature-0x01 frame 9F 04 6F 66 66 21 ("off!"),
  273. // confirmed from a real puck capture. The feature-0x01 relay below forwards it once; hapticSendShutdown
  274. // bursts it for NO-ACK reliability. Slot-targeted: the command arrived on THIS controller's interface,
  275. // so only this controller powers off (broadcasting killed all connected controllers at once).
  276. if (rid == 1 && cmd == 0x9F)
  277. hapticSendShutdown((uint8_t)slot);
  278. // report 0x01 = raw passthrough -> queue for RF relay to the controller
  279. if (rid == 1 && n >= 2) {
  280. // (feature-1 commands -- haptics, LED, 0x87 settings, 0x9F power-off -- are captured by the
  281. // general feature-SET hapLogAdd above.)
  282. bool haptic82 = (cmd == 0x82 && len <= pln);
  283. bool muted = g_resumeMs &&
  284. millis() - g_resumeMs < POST_RESUME_MUTE_MS;
  285. // Steam-mode: DROP the relayed 0x81 CLEAR_DIGITAL_MAPPINGS (g_drop81, console "S81"). It EXECUTES on
  286. // the controller (rid<0x87, legacy framing) and each one re-arms the haptic amp (non-idempotent, ibex
  287. // func_0x0001bbf0) = the connect click/buzz; Steam sends ~13 in its per-connect config. OpenPuck does
  288. // its OWN input translation and holds mappings cleared via the id9=0 keepalive, so it does NOT need the
  289. // controller's mapping engine -> Steam's 0x81 is pure downside here. The manual "Clear stuck buzz"
  290. // (hapticReinit) sends its own 0x81 via relayEnqueue directly, so that cure path is unaffected.
  291. bool drop =
  292. (g_drop81 && g_usbMode == MODE_STEAM && cmd == 0x81);
  293. // Do NOT relay commands OpenPuck answers LOCALLY (identity/bond/settings READS). Relaying them to the
  294. // controller is pointless (their reply can't come back over the NO-ACK RF link -- we answer from the
  295. // handleSet/handleGet switch), and 0x83 GET_ATTRIBUTES in particular is < 0x87 so it EXECUTES on the
  296. // controller -- captured as the remaining periodic CLICK, fired every time Steam re-polls identity
  297. // (0x83/0xAE on all 4 interfaces). Only actuator/config commands (0x80-0x82/0x84-0x88 haptics+config,
  298. // 0x9F power) should reach the controller.
  299. bool localAnswer = (cmd == 0x83 || cmd == 0x89 || cmd == 0xAE ||
  300. cmd == 0xA2 || cmd == 0xA3 || cmd == 0xAD ||
  301. cmd == 0xB4 || cmd == 0xED || cmd == 0xA4);
  302. // never push haptics while presenting lizard (Steam isn't reading 0x45 -> would buzz-loop).
  303. // HR toggle (g_hapticRelay): when off, suppress the actuator/haptic range (0x80-0x86) -- the
  304. // trackpad texture-feedback stream Steam pushes while dragging -- to isolate its cost on drag
  305. // smoothness. Config (0x87/0x88) and power-off (0x9F) still relay so nothing else regresses.
  306. bool hapticCmd = (cmd >= 0x80 && cmd <= 0x86);
  307. bool relayOk = hapticRelaySlotOk(slot) && !drop &&
  308. !localAnswer &&
  309. !(haptic82 && (lizardActive() || muted)) &&
  310. !(hapticCmd && !g_hapticRelay);
  311. if (relayOk && (!haptic82 || !haptic82Blocked(slot))) {
  312. // Relay the DECLARED length (up to the 60B RF frame ceiling), not a truncation: Steam's
  313. // multi-register 0x87 settings blocks (LED brightness) and calibration writes exceed the old
  314. // 18B cap, and the chopped frames were why those settings never landed on the controller.
  315. uint8_t rl = (len <= pln) ? len : (uint8_t)pln;
  316. #if OPK_LOG
  317. if (len > RELAY_MAXP && Serial.availableForWrite() > 60)
  318. Serial.printf(
  319. "# RELAY TRUNC cmd=%02X len=%u>%u\n",
  320. cmd, len, (unsigned)RELAY_MAXP);
  321. #endif
  322. relayEnqueue(cmd, pl, rl, (uint8_t)slot);
  323. // track from RELAYED frames only (see the OUTPUT path)
  324. if (haptic82)
  325. haptic82HostReport(pl, len);
  326. }
  327. }
  328. #if OPK_LOG
  329. // Diagnostic-build only -- see the OUTPUT-path note: no Serial.printf on the 800B usbd-task stack in
  330. // production (LOCKUP mitigation). The feature SET is already captured to the OPK_LOG ring above.
  331. if (Serial.availableForWrite() > 80) {
  332. Serial.printf("# SET if%d rid=%02X cmd=%02X len=%u:", slot, rid,
  333. cmd, len);
  334. for (uint16_t i = 0; i < n && i < 14; i++)
  335. Serial.printf(" %02X", b[i]);
  336. Serial.println();
  337. }
  338. #endif
  339. memset(S.resp, 0, sizeof S.resp);
  340. S.resp_len = 0;
  341. switch (cmd) {
  342. case 0x83:
  343. S.resp[0] = 0x83;
  344. S.resp[1] = sizeof ATTR83;
  345. memcpy(S.resp + 2, ATTR83, sizeof ATTR83);
  346. // Report-id 1 = an attributes query RELAYED to the bonded CONTROLLER; it must report the CONTROLLER's
  347. // product id (0x1302), NOT the puck/dongle's (0x1304) -- else Steam sees "a controller with a dongle's
  348. // id" (HANDOFF.md) and drops to the LEGACY 0x81 CLEAR_DIGITAL_MAPPINGS init path, whose rapid re-arm
  349. // storm is the connect buzz; with the correct id Steam uses the modern quiet 0x87 id9=0 path. Report-id
  350. // 2 stays the puck (0x1304). ATTR83 stores product as u32 LE at offset 1, so only the low byte flips
  351. // (0x04 -> 0x02); everything else in the blob is identical.
  352. if (rid == 1)
  353. S.resp[2 + 1] =
  354. 0x02; // product 0x1304 -> 0x1302 (controller)
  355. S.resp_len = 63;
  356. break;
  357. case 0xAE: {
  358. uint8_t idx = pln > 0 ? pl[0] : 1;
  359. // Report-id 1 = string attributes of the bonded CONTROLLER, not the puck. Steam matches the connected
  360. // controller to its bond by SERIAL: it reads the controller's serial here (rid 1) and compares to the
  361. // 16-byte serial in the bond record it reads via 0xA3. OpenPuck was returning the PUCK's serial (g_unit,
  362. // "FXB..."), which never matches any bond's controller serial ("FXA...") -> Steam can't associate the
  363. // controller with a puck -> "paired to" list is EMPTY -> Steam treats it as unconfigured and re-runs the
  364. // 0x81/0x87 config storm every connect (the buzz). So on rid 1, answer with the CONTROLLER's serial from
  365. // this interface's bond record (rec[8..24], the same 16-byte serial 0xA3 returns). Captured: Steam
  366. // hammered this read (AE x39 on rid1) exactly because the identity never matched. rid 2 = puck (unchanged).
  367. // idx 0/1/4 = board/unit/alt serial (real controller returns the SAME serial for 0 and 4; the clone
  368. // was returning "NA" for idx 4, which failed Steam's read -> retry).
  369. S.resp[0] = 0xAE;
  370. S.resp[1] = 0x14;
  371. S.resp[2] = idx;
  372. memset(S.resp + 3, 0, 60);
  373. if (rid == 1 && slot >= 0 && slot < NSLOT &&
  374. g_slot[slot].used && (idx == 0 || idx == 1 || idx == 4)) {
  375. // THIS slot's paired-controller serial, straight from its bond record (rec[8..24], the same
  376. // 16-byte serial 0xA3 returns) -- per device, nothing hardcoded. Copied without a stack temp
  377. // (this runs on the fragile 800B usbd task; every byte off the stack helps under a Steam
  378. // re-enumeration burst).
  379. memcpy(S.resp + 3, g_slot[slot].rec + 8, 16);
  380. } else {
  381. // rid 2 = the puck's own board/unit serials (device-derived). Any other idx -> "NA".
  382. const char *s = (rid == 1) ? "NA" :
  383. (idx == 0 || idx == 4) ? g_board :
  384. (idx == 1) ? g_unit :
  385. "NA";
  386. memcpy(S.resp + 3, s, strlen(s));
  387. }
  388. S.resp_len = 63;
  389. break;
  390. }
  391. // connection/version state per slot: value 0x02 = controller connected, 0x01 = not
  392. case 0xB4:
  393. // SDL Triton polls this on init; treat like Steam contact so we forward 0x45
  394. hostStampAlive();
  395. S.resp[0] = 0xB4;
  396. S.resp[1] = 0x01;
  397. // Report disconnected during the post-power-off hold so B4 agrees with the 0x79 disconnect (they used
  398. // different windows -- 500ms here vs the 300ms conn/DOWN edge -- so right after a power-off Steam's B4
  399. // probe answered "still connected" and contradicted the disconnect we just pushed).
  400. S.resp[2] = (slot >= 0 && slot < NSLOT && !g_xbox &&
  401. g_slot[slot].used && !slotPoweringOff(slot) &&
  402. (millis() - g_connReplyMs[slot] < 500)) ?
  403. 0x02 :
  404. 0x01;
  405. S.resp_len = 63;
  406. break;
  407. case 0xAD:
  408. g_pairing = (pln > 0 && pl[0] != 0);
  409. #if OPK_LOG
  410. Serial.printf("# pairing %s\n", g_pairing ? "ON" : "off");
  411. #endif
  412. S.resp[0] = 0xAD;
  413. S.resp[1] = 0;
  414. S.resp_len = 63;
  415. break;
  416. case 0xA2: // write/clear THIS interface's slot
  417. if (len >= 24 && pln >= 24) {
  418. if (recEmpty(pl)) {
  419. S.used = false;
  420. memset(S.rec, 0, 24);
  421. } else {
  422. memcpy(S.rec, pl, 24);
  423. S.used = true;
  424. }
  425. g_dirty = true;
  426. #if OPK_LOG
  427. Serial.printf("# slot %d %s\n", slot,
  428. recEmpty(pl) ? "cleared" : "bonded");
  429. #endif
  430. }
  431. S.resp[0] = 0xA2;
  432. S.resp[1] = 0;
  433. S.resp_len = 63;
  434. break;
  435. case 0xA3: // read THIS interface's slot
  436. S.resp[0] = 0xA3;
  437. S.resp[1] = 0x18;
  438. memset(S.resp + 2, 0, 24);
  439. if (S.used)
  440. memcpy(S.resp + 2, S.rec, 24);
  441. S.resp_len = 63;
  442. break;
  443. case 0x87:
  444. // SET_SETTINGS_VALUES: payload = N x [id][val16 LE]. Shadow each into g_setShadow[slot] so the 0x89
  445. // read-back below matches what Steam wrote -- this is THE fix that stops Steam's endless config-verify
  446. // retry (the 0x81/0x87 storm that buzzes the amp). (Still relayed to the controller by the feature-1
  447. // path above; this just maintains the dongle-side shadow the real controller would return on 0x89.)
  448. // ACK with [0x87][0], not the default payload echo (a clean success reply, like the real dongle).
  449. if (slot >= 0 && slot < NSLOT)
  450. for (uint16_t i = 0; i + 2 < pln; i += 3) {
  451. uint8_t id = pl[i];
  452. if (id < 0x53)
  453. g_setShadow[slot][id] =
  454. (uint16_t)(pl[i + 1] |
  455. (pl[i + 2] << 8));
  456. }
  457. S.resp[0] = 0x87;
  458. S.resp[1] = 0;
  459. S.resp_len = 63;
  460. break;
  461. case 0x89: {
  462. // GET_SETTINGS_VALUES: Steam reads back setting `id` (payload[0]) from the id-indexed array. Answer
  463. // from the shadow 0x87 populated: [0x89][3][id][val16 LE]. (Steam didn't use 0x89 in the captured
  464. // session -- it provisions via 0xED below -- but this is the correct real-dongle behavior; harmless.)
  465. uint8_t id = (pln > 0) ? pl[0] : 0;
  466. uint16_t v = (slot >= 0 && slot < NSLOT && id < 0x53) ?
  467. g_setShadow[slot][id] :
  468. 0;
  469. S.resp[0] = 0x89;
  470. S.resp[1] = 3;
  471. S.resp[2] = id;
  472. S.resp[3] = (uint8_t)v;
  473. S.resp[4] = (uint8_t)(v >> 8);
  474. S.resp_len = 63;
  475. break;
  476. }
  477. case 0xED: {
  478. // GET-SETTING-BY-PATH (keyed). Steam SETs the path string, then GETs the value; the REAL controller
  479. // returns the setting's value, but OpenPuck was ECHOING the path -> Steam sees the controller as
  480. // un-provisioned/un-bonded and re-runs its full LEGACY config every connect (0x81 CLEAR_DIGITAL_MAPPINGS
  481. // = the amp clicks/buzz; captured: 0xED reads of "esb/bond"/"user/wireless_transport" that got echoed).
  482. // Answer the paths Steam checks at connect so it treats the controller as provisioned + bonded:
  483. // esb/bond -> this slot's 24-byte bond record (the controller's record of ITS puck)
  484. // esb/bond_2 -> a 2nd-puck bond; OpenPuck bonds one puck per slot -> absent (empty)
  485. // user/wireless_transport -> 1 byte = the ACTIVE (connected) slot's transport code (see below)
  486. // Anything else -> empty ([0xED][0]) rather than a garbage path echo.
  487. const char *p = (const char *)pl;
  488. uint16_t pl_n = pln;
  489. auto pathIs = [&](const char *k) -> bool {
  490. uint16_t kl = (uint16_t)strlen(k);
  491. return pl_n >= kl && memcmp(p, k, kl) == 0 &&
  492. (pl_n == kl || p[kl] == 0);
  493. };
  494. S.resp[0] = 0xED;
  495. if (slot >= 0 && slot < NSLOT && g_slot[slot].used &&
  496. pathIs("esb/bond")) {
  497. S.resp[1] = 0x18;
  498. memcpy(S.resp + 2, g_slot[slot].rec, 24);
  499. } else if (pathIs("user/wireless_transport")) {
  500. // Steam reads this (a CONTROLLER setting, relayed rid1) to mark which bond slot is ACTIVE in the
  501. // pairing list, mapping active_slot = value XOR 2 (HANDOFF: slot0->0x02, slot1->0x03, slot2->0x00,
  502. // slot3->0x01). It's a single DONGLE-WIDE value = the currently-connected slot, NOT this
  503. // interface's own index (returning the raw index made Steam mark slot^2 active -> the live puck
  504. // showed "Inactive"). Report the connected slot's code so Steam marks the live puck active.
  505. int act = 0;
  506. unsigned long best = 0, now = millis();
  507. for (int s2 = 0; s2 < NSLOT; s2++)
  508. if (g_slot[s2].used && g_connReplyMs[s2] &&
  509. (now - g_connReplyMs[s2]) < 1200u &&
  510. (best == 0 || g_connReplyMs[s2] > best)) {
  511. best = g_connReplyMs[s2];
  512. act = s2;
  513. }
  514. S.resp[1] = 1;
  515. S.resp[2] = (uint8_t)(act ^ 2);
  516. } else {
  517. S.resp[1] =
  518. 0; // absent/empty -- valid "no value" reply, not a path echo
  519. }
  520. S.resp_len = 63;
  521. break;
  522. }
  523. default:
  524. S.resp[0] = cmd;
  525. S.resp[1] = len;
  526. if (pln)
  527. memcpy(S.resp + 2, pl, pln > 60 ? 60 : pln);
  528. S.resp_len = 63;
  529. break;
  530. }
  531. }
  532. static uint16_t handleGet(int slot, uint8_t rid, hid_report_type_t type,
  533. uint8_t *buf, uint16_t reqlen)
  534. {
  535. (void)rid;
  536. if (type != HID_REPORT_TYPE_FEATURE)
  537. return 0;
  538. // Do NOT treat a feature GET as "Steam is driving." A bare read is weak evidence: on Linux the kernel
  539. // hid-steam driver (and any hidapi enumerator) issues GET_FEATURE probes even with Steam's window closed,
  540. // which pinned steamDrivingGamepad() true forever and blocked the Steam-closed lizard fallback (keyboard/
  541. // mouse dead, and the lizard-off writes those readers pair with the probe also killed the autonomous
  542. // touchpad haptics). Steam actually taking over is detected by its OUTPUT/SET WRITES (the 0x87 lizard-off
  543. // heartbeat ~every 3s, and 0x82 haptics), which stamp g_steamAliveMs on the handleSet paths. So drop the
  544. // GET-based stamp entirely; a read alone no longer suppresses lizard.
  545. Slot &S = g_slot[slot];
  546. uint16_t n = S.resp_len ? S.resp_len : 63;
  547. if (n > reqlen)
  548. n = reqlen;
  549. memcpy(buf, S.resp, n);
  550. // Flight recorder (every GET, un-deduped): a read STORM -- e.g. the "AE x39" identity hammering seen before
  551. // the identity fix -- is itself a wedge signal, so we want it filling the post-mortem trail if it happens.
  552. faultDiagTrace(FR_GET, (uint16_t)((rid << 8) | S.resp[0]));
  553. // Battery diagnostic: in gamepad (Steam) mode battery is read host-side via the feature channel, NOT the
  554. // forwarded 0x43 (that path is verbatim-identical to lizard mode, where battery works). Capture what Steam
  555. // GETs so a WebUSB-panel (or CDC) capture in Steam mode shows the report id it polls for battery (then we
  556. // answer it with g_battery in handleSet). De-duped by report id so the high-rate polling doesn't flood the
  557. // ring/console -- a freshly-requested id is logged once, then again only after 1s.
  558. {
  559. // Dedup by (rid, interface, response-cmd) so each interface's GET is captured (not collapsed to one
  560. // line across all 4 slots) -- the per-interface bond/identity responses are exactly what we need to
  561. // see -- while still not flooding on high-rate same-report polling.
  562. static uint8_t lastRid = 0xFF, lastSlot = 0xFF, lastCmd = 0xFF;
  563. static unsigned long lastMs = 0;
  564. if (rid != lastRid || (uint8_t)slot != lastSlot ||
  565. S.resp[0] != lastCmd || millis() - lastMs > 1000) {
  566. lastRid = rid;
  567. lastSlot = (uint8_t)slot;
  568. lastCmd = S.resp[0];
  569. lastMs = millis();
  570. // ring marker 0xFC = "host feature GET" (panel renders it as "GET rid=.."); payload = what we returned
  571. hapLogAdd(0xFC, rid, S.resp, n);
  572. // serial feature-command capture: what Steam READ on this interface + our answer
  573. fcPush(1, slot, rid, S.resp[0], (uint8_t)n, S.resp + 2,
  574. 10);
  575. #if OPK_LOG
  576. // Diagnostic build only -- no Serial.printf on the 800B usbd-task stack in production (LOCKUP
  577. // mitigation). The GET is captured to the OPK_LOG ring above for the WebUSB panel.
  578. if (Serial.availableForWrite() > 80)
  579. Serial.printf(
  580. "# GET if%d rid=%02X reqlen=%u -> %02X %02X %02X (batt=%u%%)\n",
  581. slot, rid, reqlen, S.resp[0], S.resp[1],
  582. S.resp[2],
  583. (slot >= 0 && slot < NSLOT) ?
  584. g_battery[slot] :
  585. 0);
  586. #endif
  587. }
  588. }
  589. return n;
  590. }
  591. // one callback pair per interface (the Adafruit core routes by interface to the matching object)
  592. #define SLOTCB(N) \
  593. static void setcb##N(uint8_t r, hid_report_type_t t, uint8_t const *b, \
  594. uint16_t n) \
  595. { \
  596. handleSet(N, r, t, b, n); \
  597. } \
  598. static uint16_t getcb##N(uint8_t r, hid_report_type_t t, uint8_t *bf, \
  599. uint16_t rl) \
  600. { \
  601. return handleGet(N, r, t, bf, rl); \
  602. }
  603. // clang-format off
  604. SLOTCB(0)
  605. SLOTCB(1)
  606. SLOTCB(2)
  607. SLOTCB(3)
  608. // clang-format on
  609. typedef uint16_t (*getcb_t)(uint8_t, hid_report_type_t, uint8_t *, uint16_t);
  610. typedef void (*setcb_t)(uint8_t, hid_report_type_t, uint8_t const *, uint16_t);
  611. static getcb_t GETCB[NSLOT] = { getcb0, getcb1, getcb2, getcb3 };
  612. static setcb_t SETCB[NSLOT] = { setcb0, setcb1, setcb2, setcb3 };
  613. // ===================== IController =====================
  614. void SteamPuckController::begin()
  615. {
  616. USBDevice.setID(0x28DE, 0x1304);
  617. // Distinct bcdDevice so Windows keys a FRESH usbflags entry (cache is VID:PID:bcdDevice) and actually runs
  618. // MS OS 2.0 / WinUSB binding for the WebUSB vendor interface, instead of reusing a stale "no WinUSB" entry
  619. // tied to the real Steam Controller (28DE:1304, no WebUSB interface). The normal (wake-mouse) and one-shot
  620. // debug (CDC) boots present DIFFERENT interface sets, so they need DIFFERENT bcdDevice values or Windows
  621. // serves one's cached descriptor for the other across a reboot.
  622. USBDevice.setDeviceVersion(
  623. g_debugCdcThisBoot ?
  624. 0x0212 :
  625. (g_usbMode == MODE_LIZARD ? 0x0213 : 0x0211));
  626. USBDevice.setManufacturerDescriptor("Valve Software");
  627. USBDevice.setProductDescriptor("Steam Controller Puck");
  628. const uint8_t *desc = (g_usbMode == MODE_LIZARD) ?
  629. PUCK_LIZARD_HID_DESC :
  630. PUCK_HID_DESC;
  631. const uint16_t descLen = (g_usbMode == MODE_LIZARD) ?
  632. sizeof PUCK_LIZARD_HID_DESC :
  633. sizeof PUCK_HID_DESC;
  634. for (int i = 0; i < NSLOT; i++) {
  635. hid[i].setReportDescriptor(desc, descLen);
  636. hid[i].setReportCallback(GETCB[i], SETCB[i]);
  637. // 1ms USB poll (was default 10ms = 100/s cap -> choppy)
  638. hid[i].setPollInterval(1);
  639. hid[i].begin();
  640. }
  641. }
  642. // Forward the controller's report 0x45 to Steam, or drive lizard kb/mouse when Steam is closed. PURELY a
  643. // USB-side decision -- changes nothing about the RF poll or the host->controller relay. Per-slot: each
  644. // controller's 0x45 goes to its OWN hid[slot], so Steam sees four independent inputs. Lizard, by contrast,
  645. // presents ONE mouse + keyboard (a desktop can only consume one): rfLizard merges every bonded controller's
  646. // input (g_in[] across all used slots, populated by the per-slot decode) onto hid[0], so all connected
  647. // controllers drive the same cursor/keys together -- and it works regardless of which bond slot is live.
  648. void SteamPuckController::onReport45(int slot, const uint8_t *rep, bool fresh,
  649. uint8_t bodyTlen)
  650. {
  651. (void)fresh;
  652. (void)bodyTlen;
  653. // Host asleep -> forward NOTHING. While suspended, every sendReport attempt can translate into a host wake,
  654. // making the PC wake on any controller movement. Waking is an explicit gesture only (Steam-button short
  655. // press / controller connect), handled in rf_link.cpp via the device-level USB resume signal.
  656. if (USBDevice.suspended())
  657. return;
  658. // Just woke? Hold off forwarding so the wake gesture's residual controller input doesn't click/type into
  659. // the freshly-woken desktop.
  660. if (g_resumeMs && millis() - g_resumeMs < POST_RESUME_MUTE_MS)
  661. return;
  662. if (slot < 0 || slot >= NSLOT)
  663. return;
  664. if (!g_slot[slot].used)
  665. return;
  666. // Report id: 0x45 = legacy main input; 0x42 = new-firmware (SC2 beta ~2026-07) main input (53B). Forward
  667. // whichever the controller actually sent, verbatim, under its own id -- both are declared in PUCK_HID_DESC
  668. // and this is exactly what the real puck does. rep[0] is the id byte (rep points at it in the F1 TLV).
  669. const uint8_t rid = rep[0];
  670. if (lizardActive()) {
  671. // All bonded controllers share ONE desktop mouse/keyboard (mounted on hid[0] regardless of
  672. // which RF slots are in use). rfLizard merges g_in[] across every used slot internally, so we
  673. // fire it ONCE per cycle -- gated on the lowest CONNECTED slot's report so it runs at a steady
  674. // cadence (not once per slot, which would multiply the output rate). g_in[] is populated by the
  675. // per-slot decode for BOTH report 0x45 and the beta 0x42 (byte-identical front section), so
  676. // lizard works on new-firmware controllers too without reading rep[] here.
  677. // Gate on the lowest RECENTLY-REPLYING slot, not merely the lowest bonded one: a bonded-but-
  678. // offline low slot (e.g. a stale/phantom bond from a cloned backup) must not starve lizard when
  679. // a higher slot is the live controller (main's #98 fix -- do not regress it). onReport45 only
  680. // runs for a slot that just decoded a report, so the reporting slot is itself connected.
  681. unsigned long now = millis();
  682. int lizSlot = -1;
  683. for (int s = 0; s < NSLOT; s++)
  684. if (g_slot[s].used && g_connReplyMs[s] &&
  685. (now - g_connReplyMs[s]) < 1200u) {
  686. lizSlot = s;
  687. break;
  688. }
  689. if (slot == lizSlot)
  690. rfLizard(&hid[0], &hid[0], 0x40, 0x41);
  691. } else {
  692. // body length after the id byte, clamped to the descriptor's declared size for this report id
  693. // (0x42 = 53B vendor input, 0x45 = 45B input).
  694. uint8_t maxb = (rid == 0x42) ? 53 : 45;
  695. uint8_t blen = bodyTlen - 1;
  696. if (blen > maxb)
  697. blen = maxb;
  698. // forward the puck's raw pad coords untouched (Steam does its own interpolation/smoothing). Forward
  699. // only FRESH reports: the real puck dedupes, so stale repeats make Steam's velocity/smoothing
  700. // stair-step. g_fwdNewOnly toggles for A/B.
  701. //
  702. // Do NOT gate on hid[slot].ready() here: usbTxHid enqueues into a ring buffer (drop-oldest)
  703. // that exists precisely to hold a report while the endpoint is briefly busy -- usbTxDrain
  704. // sends it the instant the host next polls. Gating on ready() at enqueue time DROPPED every
  705. // fresh report that landed while the endpoint was busy (~1 ms after each send), which at
  706. // 300+ captured reports/s silently discarded ~a third of them (measured: RF new/s ~313 but
  707. // host delivered ~180). Always enqueue; the ring paces delivery to the host without loss.
  708. bool send = (fresh || !g_fwdNewOnly);
  709. // Content dedup: the counter byte (rep[1]) free-runs, so drop a report whose body AFTER the
  710. // counter is byte-identical to the last one forwarded on this slot -- a true repeat (same
  711. // physical input, bumped counter), not a new sample. Caps delivery at the controller's real
  712. // distinct-report rate instead of the (higher) poll rate. See g_fwdContentDedup above.
  713. if (send && g_fwdContentDedup && blen >= 2) {
  714. static uint8_t lastBody[NSLOT][53];
  715. static uint8_t lastBodyLen[NSLOT] = { 0 };
  716. uint8_t clen =
  717. (uint8_t)(blen - 1); // bytes after the counter
  718. if (clen > sizeof lastBody[0])
  719. clen = sizeof lastBody[0];
  720. if (lastBodyLen[slot] == clen &&
  721. memcmp(lastBody[slot], rep + 2, clen) == 0)
  722. send = false; // identical input, only the counter moved
  723. else {
  724. lastBodyLen[slot] = clen;
  725. memcpy(lastBody[slot], rep + 2, clen);
  726. }
  727. }
  728. if (send)
  729. usbTxHid(
  730. &hid[slot], rid, rep + 1,
  731. blen); // Steam/SDL Triton: input report 0x45 (old) / 0x42 (new fw)
  732. }
  733. }
  734. // Forward the controller's NON-input status reports (0x43 power/battery, 0x44) to Steam verbatim -- the real
  735. // puck does this and it's how Steam reads battery. Same host-asleep / post-resume gating as 0x45; no lizard
  736. // path (status reports aren't input, so they forward regardless of the lizard decision). Per-slot: each
  737. // controller's status goes to its own hid[slot].
  738. void SteamPuckController::onAuxReport(int slot, uint8_t rid,
  739. const uint8_t *data, uint8_t n)
  740. {
  741. if (USBDevice.suspended())
  742. return;
  743. if (g_resumeMs && millis() - g_resumeMs < POST_RESUME_MUTE_MS)
  744. return;
  745. if (slot < 0 || slot >= NSLOT)
  746. return;
  747. // Forward the controller's status report VERBATIM (the real puck does this; it's how the host reads
  748. // battery). Padding the report to the descriptor-declared length broke battery in both lizard and
  749. // Steam, so it's reverted -- send exactly what the controller sent.
  750. if (g_slot[slot].used && hid[slot].ready()) {
  751. // capture the pushed status report (0x43 battery / 0x44) device->host for the WebUSB panel: this is
  752. // the channel Steam actually reads battery from; marker 0xFB = "->host push".
  753. hapLogAdd(0xFB, rid, data, n);
  754. usbTxHid(&hid[slot], rid, data, n);
  755. }
  756. }
  757. // wake nudge: a bare USB resume signal is NOT enough to wake some hosts (Windows in particular) -- they only
  758. // wake when actual mouse/keyboard input follows. So on a deliberate wake gesture we play a HARMLESS mouse
  759. // JIGGLE (move a few px right, then back -- NET ZERO cursor, NO button): real mouse activity wakes the host
  760. // but clicks/activates nothing (an open Start menu stays open). Queued by wakeEvent() (rf_link, on a Steam
  761. // short press / controller connect while suspended); delivered once the suspended bus has resumed. Per-slot
  762. // so every connected interface gets the jiggle (Windows can credit any of them with the wake).
  763. static uint8_t g_nudgeStep[NSLOT] = { 0 }; // 0=idle; 1=jiggle+, 2=jiggle-
  764. static unsigned long g_nudgeMs[NSLOT] = { 0 };
  765. #define NUDGE_JIGGLE_PX 10
  766. void SteamPuckController::wakeEvent()
  767. {
  768. // arm the jiggle on every connected slot -- any one of them is enough to wake Windows
  769. for (int s = 0; s < NSLOT; s++) {
  770. if (g_slot[s].used) {
  771. g_nudgeStep[s] = 1;
  772. g_nudgeMs[s] = millis();
  773. }
  774. }
  775. }
  776. static void wakeNudgeTask()
  777. {
  778. if (USBDevice.suspended())
  779. return; // wait for resume; reports can't cross a suspended bus
  780. // Expire stale arms (bus never resumed) and see if any slot still wants a wake nudge.
  781. bool armed = false;
  782. for (int s = 0; s < NSLOT; s++) {
  783. if (!g_nudgeStep[s])
  784. continue;
  785. if (millis() - g_nudgeMs[s] > 5000) {
  786. g_nudgeStep[s] = 0;
  787. continue;
  788. }
  789. armed = true;
  790. }
  791. if (!armed)
  792. return;
  793. // Ride the BOOT MOUSE -- the interface Windows armed as the wake source; a gamepad-slot report does not
  794. // wake Modern Standby. A single jiggle on it wakes the host regardless of how many slots are connected.
  795. if (wakeHidPresent()) {
  796. if (!wakeHidReady())
  797. return;
  798. static unsigned long stepMs = 0;
  799. static uint8_t step = 1;
  800. if (millis() - stepMs < 15)
  801. return; // pace the edges
  802. stepMs = millis();
  803. wakeHidMove((step == 1) ? NUDGE_JIGGLE_PX : -NUDGE_JIGGLE_PX,
  804. 0);
  805. if (step >=
  806. 2) { // jiggle (right, then back) delivered -> disarm every slot
  807. step = 1;
  808. for (int s = 0; s < NSLOT; s++)
  809. g_nudgeStep[s] = 0;
  810. } else
  811. step++;
  812. return;
  813. }
  814. // Fallback (debug-CDC boot: no wake mouse): per-slot jiggle on the gamepad slot HIDs.
  815. static unsigned long stepMs[NSLOT] = { 0 };
  816. for (int s = 0; s < NSLOT; s++) {
  817. if (!g_nudgeStep[s])
  818. continue;
  819. if (!hid[s].ready())
  820. continue;
  821. if (millis() - stepMs[s] < 15)
  822. continue; // pace the edges
  823. stepMs[s] = millis();
  824. hid_mouse_report_t m;
  825. m.buttons = 0;
  826. m.x = (g_nudgeStep[s] == 1) ? NUDGE_JIGGLE_PX :
  827. -NUDGE_JIGGLE_PX;
  828. m.y = 0;
  829. m.wheel = 0;
  830. m.pan = 0;
  831. usbTxHid(&hid[s], 0x40, &m,
  832. sizeof m); // jiggle right, then back
  833. g_nudgeStep[s] = (g_nudgeStep[s] >= 2) ?
  834. 0 :
  835. (uint8_t)(g_nudgeStep[s] + 1);
  836. }
  837. }
  838. // USB connection presentation (like the real dongle): report 0x79 = connection state (01=disc, 02=conn),
  839. // edge-triggered, + periodic 0x7B status. Live-captured: this is what Steam reads to mark the controller
  840. // connected. Without it Steam shows disconnected even though 0x45 input is streaming.
  841. void SteamPuckController::task()
  842. {
  843. wakeNudgeTask();
  844. {
  845. static bool wasSusp = false;
  846. // stamp the suspended->active edge for the post-resume mute
  847. bool susp = USBDevice.suspended();
  848. if (wasSusp && !susp)
  849. g_resumeMs = millis();
  850. wasSusp = susp;
  851. }
  852. // no periodic 0x79/0x7B while the host sleeps -- those sends can wake it too
  853. if (USBDevice.suspended())
  854. return;
  855. // Lizard<->Steam handoff: release whatever the OUTGOING path was holding. lizardActive() is a pure
  856. // runtime decision -- Steam opening/closing (its ~3s settings heartbeat starting/stopping) flips it with
  857. // NO USB re-enumeration -- so a key/mouse-button held when Steam TAKES OVER, or a gamepad button held
  858. // when Steam CLOSES, is otherwise never released and sticks on the host until a reconnect or power-cycle
  859. // (the reported "stuck input after switching modes"). The link-drop neutral in rf_link only covers an RF
  860. // outage, not this handoff. Fire a neutral through the path we're leaving on each edge. Placed after the
  861. // suspend early-return: while suspended nothing can be sent, and a flip across a sleep is covered on
  862. // resume (this edge fires once, plus the post-resume input mute). MODE_LIZARD never leaves lizard, so
  863. // this is inert there.
  864. {
  865. static bool wasLizard = lizardActive();
  866. bool nowLizard = lizardActive();
  867. if (nowLizard != wasLizard) {
  868. if (wasLizard) {
  869. // leaving lizard -> release held desktop keyboard/mouse/consumer
  870. rfLizardRelease(&hid[0], &hid[0], 0x40, 0x41);
  871. } else {
  872. // leaving gamepad-forward -> release held 0x45 buttons/sticks/triggers on every slot
  873. static const uint8_t neutral45[45] = { 0 };
  874. for (int s = 0; s < NSLOT; s++)
  875. if (g_slot[s].used && hid[s].ready())
  876. usbTxHid(&hid[s], 0x45,
  877. neutral45,
  878. sizeof neutral45);
  879. }
  880. wasLizard = nowLizard;
  881. }
  882. }
  883. // Per-slot 0x79/0x7B: each connected slot reports its OWN edge and its OWN status. State arrays are
  884. // per-slot so each controller's "connected" edge fires once and is re-sent only until Steam acks THAT
  885. // slot. The real puck's per-slot edge-triggered 0x79 prevents re-triggering Steam's connect-chime loop.
  886. static bool usbConn[NSLOT] = { 0 };
  887. static unsigned long last79[NSLOT] = { 0 }, last7B[NSLOT] = { 0 },
  888. connEdgeMs[NSLOT] = { 0 },
  889. discEdgeMs[NSLOT] = { 0 }, last43[NSLOT] = { 0 },
  890. poHandled[NSLOT] = { 0 };
  891. for (int s = 0; s < NSLOT; s++) {
  892. if (!g_slot[s].used || !hid[s].ready())
  893. continue;
  894. // Power-off just relayed to this slot -> force ONE clean disconnect to Steam now, regardless of the
  895. // prior edge state. The controller's noisy shutdown (it keeps streaming F1 for ~1s after "off!") can
  896. // leave usbConn desynced from what Steam shows, so the ordinary conn!=usbConn edge sometimes never
  897. // fired -> Steam kept the controller in its list (the "doesn't get removed" case). Anchor discEdgeMs
  898. // too so the bounded resend covers a dropped packet.
  899. if (g_powerOffMs[s] && g_powerOffMs[s] != poHandled[s]) {
  900. poHandled[s] = g_powerOffMs[s];
  901. uint8_t st = 0x01;
  902. hapLogAdd(0xFB, 0x79, &st, 1); // ->host push (capture)
  903. usbTxHid(&hid[s], 0x79, &st, 1);
  904. usbConn[s] = false;
  905. discEdgeMs[s] = millis();
  906. last79[s] = millis();
  907. }
  908. // Hold the slot DISCONNECTED through the controller's post-power-off F1 tail (see slotPoweringOff);
  909. // otherwise a stray dying reply bounces conn true -> a phantom 0x79=02 that Steam reads as a reconnect
  910. // and answers by re-running its connect config (the "reappears for a split second").
  911. bool conn = !slotPoweringOff(s) &&
  912. (millis() - g_connReplyMs[s] < 300);
  913. // 0x79 connection state: on edge, then repeated every 750ms ONLY until Steam reacts (its first OUTPUT/
  914. // settings write after the edge -- g_steamAliveMs). The real puck sends 0x79 ONCE, edge-triggered; an
  915. // unconditional forever-resend re-triggers Steam's connect handling (connect chime) every 750ms before
  916. // Steam consumes 0x45 -> a loop of connect-time haptic buzzes. Resending until acked still covers
  917. // "Steam missed the edge".
  918. bool steamAcked = g_steamAliveMs &&
  919. (int32_t)(g_steamAliveMs - connEdgeMs[s]) >=
  920. 0;
  921. // The DISCONNECT edge (0x79=01) also needs resending: it used to be sent exactly ONCE, so a single
  922. // dropped report left Steam believing the controller was still connected indefinitely -- observed as
  923. // "WebUSB panel shows the slot DOWN (g_connReplyMs stale) while Steam still lists it connected, and the
  924. // controller light is solid (it re-adopted the beacon) but no input flows." Resend disc every 750ms but
  925. // BOUNDED to DISC_RESEND_MS so a lost packet converges without the forever-spam the "real puck sends
  926. // 0x79 once" note warns against.
  927. bool discResend = !conn &&
  928. (millis() - discEdgeMs[s] < DISC_RESEND_MS);
  929. if (conn != usbConn[s] ||
  930. (conn && !steamAcked && millis() - last79[s] >= 750) ||
  931. (discResend && millis() - last79[s] >= 750)) {
  932. if (conn && !usbConn[s])
  933. connEdgeMs[s] = millis();
  934. if (!conn &&
  935. usbConn[s]) // connect->disc edge: anchor the resend window
  936. discEdgeMs[s] = millis();
  937. uint8_t st = conn ? 0x02 : 0x01;
  938. hapLogAdd(0xFB, 0x79, &st, 1); // ->host push (capture)
  939. usbTxHid(&hid[s], 0x79, &st, 1);
  940. usbConn[s] = conn;
  941. last79[s] = millis();
  942. } else if (conn && millis() - last7B[s] >= 2000) {
  943. // 0x7B status, live-captured template. Byte 8 is the controller->puck signal strength as signed
  944. // dBm (capture showed 0xDD = -35) -- patch in the smoothed RSSI the radio samples on each
  945. // controller reply (rf_link). 0 = no sample yet -> keep the capture value rather than garbage.
  946. //
  947. // CALIBRATION: our raw RSSISAMPLE reads ~RSSI_DBM_OFFSET dB lower than the real Valve puck at the
  948. // same distance (Pro Micro PCB-trace antenna vs Valve's tuned front-end). The 2Mbit ESB link has
  949. // ~55dB margin, so a -75dBm reading still works across a house, but Steam's bar maps raw dBm to
  950. // "weak" long before that. The offset lines our close-range value up with the puck's captured -35
  951. // so the bar tracks usable range, not antenna gain. Clamp keeps it in a sane window.
  952. uint8_t s7b[12] = { 0xF7, 0x01, 0x89, 0x00, 0x00, 0x00,
  953. 0x03, 0x00, 0xDD, 0x00, 0x3A, 0x02 };
  954. if (g_linkRssi[s]) {
  955. int mag = (int)g_linkRssi[s] - RSSI_DBM_OFFSET;
  956. if (mag < 25)
  957. mag = 25;
  958. else if (mag > 95)
  959. mag = 95;
  960. s7b[8] = (uint8_t)(0u - (uint8_t)mag);
  961. }
  962. hapLogAdd(0xFB, 0x7B, s7b, 12); // ->host push (capture)
  963. usbTxHid(&hid[s], 0x7B, s7b, 12);
  964. last7B[s] = millis();
  965. }
  966. // Synthesized 0x43 = ID_TRITON_BATTERY_STATUS for SDL/Steam's gamepad driver. The verbatim forward of
  967. // the controller's own 0x43 (onAuxReport) is what the LIZARD/kernel path reads, but SDL's Triton driver
  968. // requires the FULL TritonBatteryStatus_t length (r >= 1 + 14) and lapses to the "wired" glyph without a
  969. // fresh one -- so we push a clean 14-byte report from g_battery every 2s. Body: [ucChargeState][ucBattery
  970. // Level][voltages/current/temp = 0]; SDL only reads the first two. Map unknown/reset state -> discharging
  971. // so it shows ON_BATTERY + % rather than UNKNOWN. Skipped until the controller has reported a level.
  972. if (conn && g_battery[s] && millis() - last43[s] >= 2000) {
  973. uint8_t st = g_batteryState[s];
  974. // EChargeState discharging -> SDL_POWERSTATE_ON_BATTERY
  975. if (st != 1 && st != 2 && st != 4)
  976. st = 1;
  977. uint8_t b43[14] = { 0 };
  978. b43[0] = st; // ucChargeState
  979. b43[1] = g_battery[s]; // ucBatteryLevel (percent)
  980. hapLogAdd(0xFB, 0x43, b43, 14); // ->host push (capture)
  981. usbTxHid(&hid[s], 0x43, b43, sizeof b43);
  982. last43[s] = millis();
  983. }
  984. }
  985. // Reset edge state for slots that are no longer used/ready (so a re-bond sees a fresh edge).
  986. for (int s = 0; s < NSLOT; s++)
  987. if (!g_slot[s].used || !hid[s].ready())
  988. usbConn[s] = false;
  989. }