TinyUSB
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system. It is designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events are deferred then handled in the stack's task function.
.
├── docs # Documentation
├── examples # Sample with Makefile and Segger Embedded build support
├── 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.
├── tests # Unit tests for the stack
└── tools # Files used internally
Device Stack
Support multiple device configurations by dynamically changing usb descriptors. Low power functions such as suspend, resume and remote wakeup. Following device classes are supported:
- Communication Class (CDC)
- Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
- Mass Storage Class (MSC): with multiple LUNs
- Musical Instrument Digital Interface (MIDI)
Host Stack
Most active development is on the Device stack. The Host stack is under rework and largely untested.
- Human Interface Device (HID): Keyboard, Mouse, Generic
- Mass Storage Class (MSC)
- Hub currently only support 1 level of hub (due to my laziness)
OS Abtraction layer
Currently the following OS are supported with tinyusb out of the box with a simple change of CFG_TUSB_OS macro.
- No OS
- FreeRTOS
- MyNewt (work in progress)
Supported MCUs
The stack supports the following MCUs
- Nordic: nRF52840
- NXP: LPC11Uxx, LPC13xx, LPC175x_6x, LPC177x_8x, LPC18xx, LPC40xx, LPC43xx
- MicroChip: SAMD21, SAMD51
- ST: STM32F4
Here is the list of supported Boards
Compiler & IDE
The stack is developed with GCC compiler, and should be compilable with others. Folder examples provide Makefile and Segger Embedded Studio build support.
Getting Started
Here is the details for getting started with the stack.
Porting
Want to help add TinyUSB support for a new MCU? Read here for an explanation on the low-level API needed by TinyUSB.
License
MIT license for all TinyUSB sources src folder, Full license is here. However each file is individually licensed especially those in lib and hw/mcu folder. Please make sure you understand all the license term for files you use in your project.
Uses
TinyUSB is currently used by these other projects:
If your project also uses TinyUSB and want to share, feel free to create a pull request.