webusb_config.h 1.6 KB

12345678910111213141516171819202122
  1. // WebUSB configuration channel: a vendor interface present in EVERY mode so the browser config panel can
  2. // read/set runtime tunables. Binary framed protocol:
  3. // host->dev: 0x01 GET -> reply status blob
  4. // 0x02 <field> <value> SET one byte field (see the switch in webusb_config.cpp)
  5. // 0x03 <mode> switch USB mode (0..6): persist + reboot
  6. // 0x0B reboot into serial DFU (adafruit-nrfutil)
  7. // 0x0C reboot into UF2 bootloader (USB mass storage)
  8. // 0x20 <size u32> <crc32 u32> firmware update: begin staging (disarms any previous)
  9. // 0x21 <off u32> <len> <data...> firmware update: sequential chunk (len<=128, %4==0)
  10. // 0x22 firmware update: verify staged image + COMMIT (applies on next reboot)
  11. // 0x23 clean reboot (after 0x22: boots into the freshly staged firmware)
  12. // 0x24 firmware update: abort/disarm
  13. // dev->host: 0xA5 <len> <payload> status blob (mode/tunables/link state/rates)
  14. // 0xAB 5 <status> <nextOff u32> firmware-update ack, one per 0x20/0x21/0x22/0x24 (fw_update.h)
  15. // No setLandingPage() on purpose -- it would pop a Chrome "open <url>?" notification on every plug-in.
  16. #pragma once
  17. #include <Adafruit_TinyUSB.h>
  18. extern Adafruit_USBD_WebUSB usb_web;
  19. void webusbInit(); // register the SOF-driven blob sender; call once from setup() after usbTxBegin()
  20. void webusbPoll(); // drain host commands + reply; call every loop()