No Description

hathach ee6ed084f4 clean up text 7 years ago
docs b28cc6ddb1 added dcd_remote_wakeup() stub for all ports 7 years ago
examples ee6ed084f4 clean up text 7 years ago
hw 38f7d281d4 more board clean up 7 years ago
lib c211ee19dd migrate license from BSD 3 clause to MIT 7 years ago
src ee6ed084f4 clean up text 7 years ago
tests c211ee19dd migrate license from BSD 3 clause to MIT 7 years ago
tools 1e9848d917 replace dcd_edpt_(clear)stall by usbd_edpt_(clear)stall 7 years ago
.gitignore bf70f89240 Introduce a Makefile for the OS_NONE device example 7 years ago
.gitmodules 6787fbeff0 move lpcopen to its own repo (submodule) 7 years ago
.travis.yml 1a0c4fbb9b add pca10056 to travis buidl 7 years ago
LICENSE c211ee19dd migrate license from BSD 3 clause to MIT 7 years ago
README.md 28610198df clean up 7 years ago
pkg.yml 1a4a27324b clean up 7 years ago
repository.yml a2a267ddfa correct mynewt version 7 years ago
tinyusb.Doxyfile 3c24671960 mass rename TUSB_CFG to CFG_TUSB 8 years ago
version.yml 424162d340 add repo & version yml 7 years ago

README.md

TinyUSB

Build Status License

TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system.

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

Device Stack

  • Human Interface Device (HID): Keyboard, Mouse, Generic
  • Communication Class (CDC)
  • Mass Storage Class (MSC)
  • 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.

Uses

TinyUSB is currently used by these other projects:

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 Full license is here and most of the code base. However each file/folder 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.