tinyusb

mirror of https://github.com/hathach/tinyusb.git synced 2026-08-18 11:02:16 +00:00

Files

hathach 4b1c8d16f7 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) <noreply@anthropic.com>

2026-06-29 10:16:25 +07:00

src

max32 change bulk endpoint to EP8,9 (2KB FIFO) and Audio ISO to EP10, 11 (4KB FIFO)

2026-04-26 11:42:52 +07:00

CMakeLists.txt

replace printer_to_hid example with printer_to_cdc example

2026-03-06 17:22:38 +07:00

CMakePresets.json

add stm32c5 support

2026-05-10 14:17:00 +02:00

Makefile

replace printer_to_hid example with printer_to_cdc example

2026-03-06 17:22:38 +07:00

README.md

docs: add build-doc tooling and a README for every example

2026-06-29 10:16:25 +07:00

README.md

Printer to CDC

This example demonstrates a USB composite device with a Printer class interface and a CDC serial interface. Data flows bidirectionally between the two:

Data sent to the Printer (from host) is forwarded to the CDC serial port
Data sent to the CDC serial port (from host) is forwarded to the Printer IN endpoint

This is useful for debugging printer class communication or as a reference for implementing printer class devices.

USB Descriptors

Interface	Class	Description
0	CDC ACM	Virtual serial port
2	Printer	USB Printer (bidirectional, protocol 2)

Configuration

Notable tusb_config.h settings:

#define CFG_TUD_CDC                1
#define CFG_TUD_PRINTER            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_PRINTER_RX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)
#define CFG_TUD_PRINTER_TX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)

How to Test

The device exposes two endpoints on the host:

/dev/ttyACM0 (CDC serial port)
/dev/usb/lp0 (USB printer)

Note: the actual device numbers may vary depending on your system.

Prerequisites (Linux):

# Load the USB printer kernel module if not already loaded
sudo modprobe usblp

# Check devices exist
ls /dev/ttyACM* /dev/usb/lp*

Test Printer to CDC (host writes to printer, reads from CDC):

# Terminal 1: read from CDC
cat /dev/ttyACM0

# Terminal 2: write to printer
echo "hello from printer" > /dev/usb/lp0
# "hello from printer" appears in Terminal 1

Test CDC to Printer (host writes to CDC, reads from printer):

# Terminal 1: read from printer IN endpoint
cat /dev/usb/lp0

# Terminal 2: write to CDC
echo "hello from cdc" > /dev/ttyACM0
# "hello from cdc" appears in Terminal 1

Interactive bidirectional test:

# Terminal 1: open CDC serial port
minicom -D /dev/ttyACM0

# Terminal 2: send to printer
echo "tinyusb print example" > /dev/usb/lp0
# Text appears in minicom. Type in minicom to send data back through printer TX.

IEEE 1284 Device ID

The device responds to GET_DEVICE_ID requests with:

MFG:TinyUSB;MDL:Printer to CDC;CMD:PS;CLS:PRINTER;

Verify with:

cat /sys/class/usbmisc/lp0/device/ieee1284_id