Skip to content
An open source cross-platform USB stack for embedded system
C C++ Makefile Other
Branch: master
Clone or download
Pull request Compare This branch is 15 commits behind hathach:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
docs
examples
hw
lib
src
test
tools
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.md
changelog.md
pkg.yml
repository.yml
tinyusb.Doxyfile
version.yml

README.md

TinyUSB

tinyUSB_240x100

Build Status License

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.

tinyusb

.
├── 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.
├── test            # Unit tests for the stack
└── tools           # Files used internally

Supported MCUs

The stack supports the following MCUs

  • Nordic: nRF52840
  • NXP: LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx
  • MicroChip: SAMD21, SAMD51 (device only)
  • ST: STM32 series: L0, F0, F1, F2, F3, F4, F7, H7 (device only)

Here is the list of supported Boards that can be used with provided examples.

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)
  • 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

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

TinyUSB is completely thread-safe by pushing all ISR events into a central queue, then process it later in the non-ISR context. It also uses semphore/mutex to access shared resource such as CDC FIFO. Therefore the stack needs to use some of OS's basic APIs. Following OSes are already supported out of the box.

  • No OS : Disabling USB IRQ is used as way to provide mutex
  • FreeRTOS
  • Mynewt Due to the newt package build system, Mynewt examples are better to be on its own repo

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. Here is instruction to build example.

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:

Let's me know if your project also uses TinyUSB and want to share.

You can’t perform that action at this time.