TinyUSBΒΆ

Sponsor License Build Status CircleCI Status Documentation Status Static Analysis Fuzzing Status Membrowse CodeRabbit Pull Request Reviews Greptile: The War on Bugs

OverviewΒΆ

TinyUSB

TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems. It’s designed for memory safety (no dynamic allocation) and thread safety (all interrupts deferred to non-ISR task functions). The stack emphasizes portability, small footprint, and real-time performance across 50+ MCU families.

SponsorsΒΆ

TinyUSB’s continued development is made possible by its sponsors. If TinyUSB helps your products or projects, consider funding its development on GitHub Sponsors.

PlatinumΒΆ

Adafruit has backed TinyUSB since day one as its founding and sole Platinum sponsor. Buying their products directly funds the project’s development.

Adafruit Logo

Sponsors (QWORD)ΒΆ

No QWORD sponsors yet β€” be the first!

Backers (DWORD)ΒΆ

No backers yet β€” be the first!

Supporters (Word)ΒΆ

cee****

Thanks (Byte)ΒΆ

@8086net, @GCRev

Key FeaturesΒΆ

  • Thread-safe: USB interrupts deferred to task context

  • Memory-safe: No dynamic allocation, all buffers static

  • Portable: Supports 50+ MCU families

  • Comprehensive: Includes CDC, HID, MSC, Audio, and Host support

  • RTOS-friendly: Works with bare metal, FreeRTOS, RT-Thread, and Mynewt

stackup
.
β”œβ”€β”€ docs            # Documentation
β”œβ”€β”€ examples        # Examples with make and cmake build system
β”œβ”€β”€ hw
β”‚   β”œβ”€β”€ bsp         # Supported boards source files
β”‚   └── mcu         # Low level mcu core & peripheral drivers
β”œβ”€β”€ lib             # Sources from 3rd party such as FreeRTOS, FatFs ...
β”œβ”€β”€ src             # All sources files for TinyUSB stack itself.
β”œβ”€β”€ test            # Tests: unit test, fuzzing, hardware test
└── tools           # Files used internally

Getting startedΒΆ

See the online documentation for information about using TinyUSB and how it is implemented.

Check out Getting Started guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the cdc_msc example. There is a handful of Supported Boards that should work out of the box.

We use GitHub Discussions as our forum. It is a great place to ask questions and advice from the community or to discuss your TinyUSB-based projects.

For bugs and feature requests, please raise an issue and follow the templates there.

See Porting guide for adding support for new MCUs and boards.

Device StackΒΆ

Supports multiple device configurations by dynamically changing USB descriptors, low power functions such like suspend, resume, and remote wakeup. The following device classes are supported:

  • Audio Class 1.0/2.0 (UAC1/UAC2)

  • Bluetooth Host Controller Interface (BTH HCI)

  • Communication Device Class (CDC)

  • Device Firmware Update (DFU): DFU mode (WIP) and Runtime

  • Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc …

  • Printer class

  • Mass Storage Class (MSC): with multiple LUNs

  • Musical Instrument Digital Interface (MIDI)

  • Media Transfer Protocol (MTP/PTP)

  • Network with RNDIS, Ethernet Control Model (ECM), Network Control Model (NCM)

  • Test and Measurement Class (USBTMC)

  • Video class 1.5 (UVC): work in progress

  • Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file.

  • WebUSB with vendor-specific class

If you have a special requirement, usbd_app_driver_get_cb() can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface raspberrypi/pico-sdk#197

Host StackΒΆ

  • Communication Device Class: CDC-ACM

  • Vendor serial over USB: FTDI, CP210x, CH34x, PL2303

  • Human Interface Device (HID): Keyboard, Mouse, Generic

  • Mass Storage Class (MSC)

  • Musical Instrument Digital Interface (MIDI)

  • Hub with multiple-level support

Similar to the Device Stack, if you have a special requirement, usbh_app_driver_get_cb() can be used to write your own class driver without modifying the stack.

Power Delivery StackΒΆ

  • Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)

  • Super early stage, only for testing purpose

  • Only support STM32 G4

OS Abstraction layerΒΆ

TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR) events into a central queue, then processing them later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as Communication Device Class (CDC) FIFO. Therefore the stack needs to use some of the OS’s basic APIs. Following OSes are already supported out of the box.

  • No OS

  • FreeRTOS

  • RT-Thread: repo

  • Mynewt Due to the newt package build system, Mynewt examples are better to be on its own repo

Supported CPUsΒΆ

Manufacturer

Family

Device

Host

Highspeed

Driver

Note

Allwinner

F1C100s/F1C200s

βœ…

βœ…

sunxi

musb variant

Analog

MAX3421E

βœ…

❌

max3421

via SPI

MAX32 650, 666, 690, MAX78002

βœ…

βœ…

musb

1-dir ep

Artery AT32

F403a_407, F413

βœ…

stm32_fsdev

768 USB RAM

F415, F435_437, F423, F425, F45x

βœ…

βœ…

dwc2

F402_F405

βœ…

βœ…

βœ…

dwc2

F405 is HS

Bridgetek

FT90x

βœ…

βœ…

ft9xx

1-dir ep

Broadcom

BCM2711, BCM2837

βœ…

βœ…

dwc2

Dialog

DA1469x

βœ…

❌

❌

da146xx

Espressif ESP32

S2, S3, H4

βœ…

βœ…

❌

dwc2

P4

βœ…

βœ…

βœ…

dwc2

S31

βœ…

βœ…

βœ…

dwc2

Geehy APM32

F072

βœ…

❌

stm32_fsdev

1KB USB RAM

F103

βœ…

❌

stm32_fsdev

512 USB RAM

F107

βœ…

βœ…

❌

dwc2

GigaDevice

GD32VF103

βœ…

❌

dwc2

HPMicro

HPM6750

βœ…

βœ…

βœ…

ci_hs, ehci

Infineon

XMC4500

βœ…

βœ…

❌

dwc2

MicroChip

SAM

D11, D21, L21, L22

βœ…

❌

samd

D51, E5x

βœ…

❌

samd

G55

βœ…

❌

samg

1-dir ep

E70,S70,V70,V71

βœ…

βœ…

samx7x

1-dir ep

PIC

24

βœ…

pic

ci_fs variant

32 mm, mk, mx

βœ…

pic

ci_fs variant

dsPIC33

βœ…

pic

ci_fs variant

32mz

βœ…

pic32mz

musb variant

MindMotion

mm32

βœ…

❌

mm32f327x_otg

ci_fs variant

NordicSemi

nRF52, nRF53

βœ…

❌

❌

nrf5x

only ep8 is ISO

nRF54

βœ…

❌

βœ…

dwc2

Nuvoton

NUC120

βœ…

❌

❌

nuc120

NUC121/NUC125, NUC126

βœ…

❌

❌

nuc121

NUC505

βœ…

βœ…

nuc505

NXP

iMXRT

RT 10xx, 11xx

βœ…

βœ…

βœ…

ci_hs, ehci

ERR050101 [4]

Kinetis

KL, K32L

βœ…

🟑

❌

ci_fs

LPC

11u, 13, 15

βœ…

❌

❌

lpc_ip3511

17, 40

βœ…

🟑

❌

lpc17_40, ohci

18, 43

βœ…

βœ…

βœ…

ci_hs, ehci

51u

βœ…

❌

❌

lpc_ip3511

54

🟑

🟑

βœ…

lpc_ip3511, lpc_ip3516

NRND [1]

55

βœ…

βœ…

βœ…

lpc_ip3511, lpc_ip3516

USB.3/USB.5 [5]

MCX

N9

βœ…

βœ…

ci_fs, ci_hs, ehci

A15

βœ…

ci_fs

RW61x

βœ…

βœ…

βœ…

ci_hs, ehci

Puya

PY32F071, PY32F072

βœ…

❌

❌

musb

1-dir ep [6]

Raspberry Pi

RP2040, RP2350

βœ…

βœ…

❌

rp2040, pio_usb

Renesas

RX

63N, 65N, 72N

βœ…

βœ…

❌

rusb2

RA

4M1, 4M3, 6M1

βœ…

βœ…

❌

rusb2

6M5

βœ…

βœ…

βœ…

rusb2

Silabs

EFM32GG12

βœ…

❌

dwc2

Sony

CXD56

βœ…

❌

βœ…

cxd56

ST STM32

F0, F3, L0, L1, L5, WBx5

βœ…

❌

❌

stm32_fsdev

F1

102, 103

βœ…

❌

❌

stm32_fsdev

512 USB RAM

105, 107

βœ…

βœ…

❌

dwc2

F2, F4, F7, H7, H7RS

βœ…

βœ…

βœ…

dwc2

C0, C5, G0, H5, U3

βœ…

βœ…

❌

stm32_fsdev

2KB USB RAM

G4

βœ…

❌

❌

stm32_fsdev

1KB USB RAM

L4

4x2, 4x3

βœ…

❌

❌

stm32_fsdev

1KB USB RAM

4x5, 4x6, 4+

βœ…

βœ…

❌

dwc2

N6

βœ…

βœ…

βœ…

dwc2

U0

βœ…

❌

❌

stm32_fsdev

1KB USB RAM

U5

535, 545

βœ…

βœ…

❌

stm32_fsdev

2KB USB RAM

575, 585

βœ…

βœ…

❌

dwc2

59x,5Ax,5Fx,5Gx

βœ…

βœ…

βœ…

dwc2

TI

MSP430

βœ…

❌

❌

msp430x5xx

MSP432E4, TM4C123

βœ…

❌

musb

ValentyUSB

eptri

βœ…

❌

❌

eptri

WCH

CH32F20x

🟑

βœ…

ch32_usbhs

ISO/INT [2] [3]

CH32V20x

🟑

❌

stm32_fsdev/ch32_usbfs

ISO data loss [2]

CH32V305, CH32V307

🟑

βœ…

ch32_usbfs/hs

ISO/INT [2] [3]

CH583/2, CH32V103

🟑

❌

ch32_usbfs

ISO data loss [2]

CH32X033, CH32X035

🟑

❌

ch32_usbfs

ISO data loss [2]

Table LegendΒΆ

βœ…

Supported

🟑

Partial support

❌

Not supported by hardware

[empty]

Unknown

Development ToolsΒΆ

The following tools are provided freely to support the development of the TinyUSB project: