Skip to content

hathach/tinyusb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10,087 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

TinyUSB

Build Status CircleCI Status Documentation Status Static Analysis Fuzzing Status Membrowse License

Sponsors

TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project.

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.

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 2.0 (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 ...
  • 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 βœ” Β  Β  fsdev 512 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 βœ” βœ” βœ– dwc2 Β 
P4 βœ” βœ” βœ” dwc2 Β 
H4 βœ” βœ” βœ– 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 nRF 52833, 52840, 5340 βœ” βœ– βœ– nrf5x only ep8 is ISO
Nuvoton NUC120 βœ” βœ– βœ– nuc120 Β 
NUC121/NUC125, NUC126 βœ” βœ– βœ– nuc121 Β 
NUC505 βœ” Β  βœ” nuc505 Β 
NXP iMXRT RT 10xx, 11xx βœ” βœ” βœ” ci_hs, ehci Β 
Kinetis KL βœ” ⚠ βœ– ci_fs, khci Β 
K32L2 βœ” Β  βœ– khci ci_fs variant
LPC 11u, 13, 15 βœ” βœ– βœ– lpc_ip3511 Β 
17, 40 βœ” ⚠ βœ– lpc17_40, ohci Β 
18, 43 βœ” βœ” βœ” ci_hs, ehci Β 
51u βœ” βœ– βœ– lpc_ip3511 Β 
54, 55 βœ” Β  βœ” lpc_ip3511 Β 
MCX N9 βœ” Β  βœ” ci_fs, ci_hs, ehci Β 
A15 βœ” Β  Β  ci_fs Β 
RW61x βœ” βœ” βœ” ci_hs, ehci Β 
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, 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 Β 
CH32V20x βœ” Β  βœ– stm32_fsdev/ch32_usbfs Β 
CH32V305, CH32V307 βœ” Β  βœ” ch32_usbfs/hs Β 

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: