From 4b1c8d16f72bb5d8f2eb8a2e8dde35abdd2f2a88 Mon Sep 17 00:00:00 2001 From: hathach Date: Mon, 29 Jun 2026 10:16:25 +0700 Subject: docs: add build-doc tooling and a README for every example Documentation tooling: - Add the `build-doc` skill and `tools/build_doc.py` wrapper for local Sphinx builds (clean / -W / open). - Enable Markdown (MyST) in conf.py and auto-collect examples/{device,host,dual}/*/README.md into a 3-level Examples nav (Examples > Device/Host/Dual > example), noting each page's source location and normalizing headings to a single H1. - Remove the stale `.claude/commands/build-doc.md`; point the AGENTS.md Documentation section at the skill. Example docs: - Add a README.md for every device/host/dual example: what it does, USB interface table, notable tusb_config.h settings, generic CMake + Make build steps, and how to try it. - Fold each *_freertos variant into its base README, noting the FreeRTOS source path and any RTOS-specific behavior. Generated docs/examples/ output is git-ignored. Builds clean with `sphinx-build -W`. Co-Authored-By: Claude Opus 4.8 (1M context) --- examples/device/cdc_msc/README.md | 58 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 examples/device/cdc_msc/README.md (limited to 'examples/device/cdc_msc') diff --git a/examples/device/cdc_msc/README.md b/examples/device/cdc_msc/README.md new file mode 100644 index 000000000..9fb3881d4 --- /dev/null +++ b/examples/device/cdc_msc/README.md @@ -0,0 +1,58 @@ +# CDC + MSC + +A composite USB device that exposes **two interfaces at once**: + +- **CDC** — a virtual serial port (`/dev/ttyACMx`, or a COM port on Windows) that echoes back everything it receives. +- **MSC** — a small mass-storage disk that mounts as a removable drive. + +This is the canonical TinyUSB example for a multi-interface (composite) device. + +## What it does + +- **CDC:** reads incoming data and echoes it straight back. Pressing the on-board button sends a serial-state (UART) notification to the host. +- **MSC:** presents an 8 KB FAT12 RAM disk (16 × 512-byte blocks — the smallest size Windows will mount) labelled `TinyUSB MSC`, containing a single `README.TXT`. The disk lives in RAM, so changes are not persistent. +- **LED** shows bus state: 250 ms blink = not mounted, 1000 ms = mounted, 2500 ms = suspended. + +## USB Descriptors + +| Interface | Class driver | +|-----------|--------------| +| 0–1 | CDC (virtual serial) | +| 2 | MSC (mass storage) | + +## Configuration + +Notable `tusb_config.h` settings: + +```c +#define CFG_TUD_CDC 1 +#define CFG_TUD_MSC 1 +#define CFG_TUD_CDC_RX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64) +#define CFG_TUD_CDC_TX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64) +#define CFG_TUD_MSC_EP_BUFSIZE 512 +``` + +## Building + +CMake: + +```bash +mkdir build && cd build +cmake -DBOARD=raspberry_pi_pico .. +cmake --build . +``` + +Make: + +```bash +make BOARD=raspberry_pi_pico all +``` + +## FreeRTOS variant + +A FreeRTOS build is in `examples/device/cdc_msc_freertos` — identical CDC + MSC behavior, with the device, CDC, and LED-blink work split across FreeRTOS tasks. + +## Try it + +- **Serial:** open the CDC port (`screen /dev/ttyACM0`, PuTTY, …) and type — characters are echoed back. +- **Storage:** a small `TinyUSB MSC` drive appears; open `README.TXT` to confirm it mounted. -- cgit v1.3.1