No Description

hathach 6645be65f5 Merge pull request #36 from tannewt/fix_write_protect 7 years ago
docs 455da57f9d docs clean up 7 years ago
examples 59c1b4b427 zero init internal class/device data 7 years ago
hw 1a84f5da54 nrf5x Let application decide USBD_IRQn priority 7 years ago
lib a3713f801d clean up compiler attribute 7 years ago
src c870efffc0 Fix write protected MSC. The bits were flipped. 7 years ago
tests 52abbec7c5 Remove txbuf in favor of fifo. 7 years ago
tools bf70f89240 Introduce a Makefile for the OS_NONE device example 7 years ago
.gitignore bf70f89240 Introduce a Makefile for the OS_NONE device example 7 years ago
.gitmodules 048fc9694c Split out txbuf and add unit test. 7 years ago
.travis.yml 52abbec7c5 Remove txbuf in favor of fifo. 7 years ago
LICENSE fafef1aa17 Update LICENSE 7 years ago
README.md e6224bccf9 adding makefile support for nrf5x 7 years ago
pkg.yml 1a4a27324b clean up 7 years ago
repository.yml 424162d340 add repo & version yml 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)

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

  • NXP: LPC11Uxx, LPC13xx, LPC175x_6x, LPC177x_8x, LPC40xx, LPC43xx
  • MicroChip: SAMD21, SAMD51 (device only)
  • Nordic: nRF52840

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

BSD 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.