Skip to content

Fork of tinyusb project with Espressif-specific patches.

License

Notifications You must be signed in to change notification settings

espressif/tinyusb

Repository files navigation

TinyUSB

Build StatusCircleCI StatusDocumentation StatusStatic AnalysisFuzzing StatusLicense

Sponsors

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

Adafruit Logo

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

  • Human Interface Device (HID): Keyboard, Mouse, Generic
  • Mass Storage Class (MSC)
  • Communication Device Class: CDC-ACM
  • Vendor serial over USB: FTDI, CP210x, CH34x, PL2303
  • 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

ManufacturerFamilyDeviceHostHighspeedDriverNote
AllwinnerF1C100s/F1C200ssunximusb variant
AnalogMAX3421Emax3421via SPI
MAX32 650, 666, 690, MAX78002musb1-dir ep
Artery AT32F403a_407, F413fsdev
F415, F435_437, F423, F425dwc2
F402_F405dwc2F405 is HS
BridgetekFT90xft9xx1-dir ep
BroadcomBCM2711, BCM2837dwc2
DialogDA1469xda146xx
Espressif ESP32S2, S3dwc2
P4dwc2
H4dwc2
GigaDeviceGD32VF103dwc2
InfineonXMC4500dwc2
MicroChipSAMD11, D21, L21, L22samd
D51, E5xsamd
G55samg1-dir ep
E70,S70,V70,V71samx7x1-dir ep
PIC24picci_fs variant
32 mm, mk, mxpicci_fs variant
dsPIC33picci_fs variant
32mzpic32mzmusb variant
MindMotionmm32mm32f327x_otgci_fs variant
NordicSeminRF 52833, 52840, 5340nrf5xonly ep8 is ISO
NuvotonNUC120nuc120
NUC121/NUC125nuc121
NUC126nuc121
NUC505nuc505
NXPiMXRTRT 10xx, 11xxci_hs, ehci
KinetisKLci_fs, khci
K32L2khcici_fs variant
LPC11u, 13, 15lpc_ip3511
17, 40lpc17_40, ohci
18, 43ci_hs, ehci
51ulpc_ip3511
54, 55lpc_ip3511
MCXN9ci_fs, ci_hs, ehci
A15ci_fs
Raspberry PiRP2040, RP2350rp2040, pio_usb
RenesasRX63N, 65N, 72Nrusb2
RA4M1, 4M3, 6M1rusb2
6M5rusb2
SilabsEFM32GG12dwc2
SonyCXD56cxd56
ST STM32F0, F3, L0, L1, L5, WBx5stm32_fsdev
F1102, 103stm32_fsdev
105, 107dwc2
F2, F4, F7, H7, H7RSdwc2
C0, G0, H5stm32_fsdev
G4stm32_fsdev
L44x2, 4x3stm32_fsdev
4x5, 4x6, 4+dwc2
N6dwc2
U0stm32_fsdev
U3stm32_fsdev
U5535, 545stm32_fsdev
575, 585dwc2
59x,5Ax,5Fx,5Gxdwc2
TIMSP430msp430x5xx
MSP432E4, TM4C123musb
ValentyUSBeptrieptri
WCHCH32F20xch32_usbhs
CH32V20xstm32_fsdev/ch32_usbfs
CH32V305, CH32V307ch32_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:

About

Fork of tinyusb project with Espressif-specific patches.

Resources

License

Stars

Watchers

Forks

Languages

  • C87.6%
  • Linker Script6.5%
  • CMake2.5%
  • Makefile1.3%
  • Python1.2%
  • C++0.5%
  • Other0.4%