Espressif TinyUSB fork with DFU runtime
Go to file
hathach 7d6085f870
Merge pull request #45 from hathach/develop
Board uart rename and better support mynewt
2019-03-21 05:13:20 -07:00
docs docs clean up 2018-12-17 12:08:11 +07:00
examples minor clean up 2019-03-21 19:01:04 +07:00
hw clean board uart read & write 2019-03-20 20:58:27 +07:00
lib migrate license from BSD 3 clause to MIT 2019-03-20 16:11:42 +07:00
src more with mynewt 2019-03-21 00:54:42 +07:00
tests migrate license from BSD 3 clause to MIT 2019-03-20 16:11:42 +07:00
tools clean up 2019-03-20 14:41:35 +07:00
.gitignore Introduce a Makefile for the OS_NONE device example 2018-11-25 11:46:06 -08:00
.gitmodules move lpcopen to its own repo (submodule) 2019-03-20 12:37:25 +07:00
.travis.yml add pca10056 to travis buidl 2019-03-20 01:23:59 +07:00
LICENSE migrate license from BSD 3 clause to MIT 2019-03-20 16:11:42 +07:00
README.md update license badge 2019-03-20 16:12:38 +07:00
pkg.yml clean up 2018-09-02 20:30:07 +07:00
repository.yml add repo & verion yml 2018-09-02 16:46:47 +07:00
tinyusb.Doxyfile mass rename TUSB_CFG to CFG_TUSB 2018-04-10 14:31:11 +07:00
version.yml clean up 2018-09-02 20:30:07 +07:00

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, LPC40xx, LPC43xx
  • MicroChip: SAMD21, SAMD51 (device only)
  • ST: STM32F4

Here is the list of supported Boards

Compiler & IDE

The stack is developed with GCC compiler, and should be compilable with others. However, it requires C99 to build with. 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.