kingkevin
/
espressif_tinyusb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Espressif TinyUSB fork with DFU runtime
2,339 Commits 2 Branches 4 Tags 34 MiB
C 96.7%
Makefile 1.3%
Python 0.7%
C++ 0.6%
Assembly 0.4%
Other 0.3%
Go to file
Nathan Conrad d742c3e15c s/USBTMC488/USB488/ ; fix types in bitfield 2019-09-19 19:56:00 -04:00
.github/ISSUE_TEMPLATE Update issue templates 2019-08-20 12:39:55 +07:00
docs Update boards.md 2019-09-17 13:29:39 -04:00
examples Move descriptors to usbd.h 2019-09-19 19:51:37 -04:00
hw pyboardv11: Fix typo in HSE_VALUE define so that SysTick runs at correct 2019-09-17 13:29:41 -04:00
lib update license year to 2019 2019-05-14 11:48:05 +07:00
src s/USBTMC488/USB488/ ; fix types in bitfield 2019-09-19 19:56:00 -04:00
test more house keeping 2019-07-19 20:20:13 +07:00
tools rename cdc_msc_hid to cdc_msc, hid has its own example hid_composite now 2019-09-11 13:09:14 +07:00
.gitignore Ignore build artifact files. 2019-09-09 19:21:29 -04:00
.gitmodules remove submodule stm32lib 2019-09-05 23:45:53 +07:00
.travis.yml travis fix typo 2019-07-08 18:25:14 +07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-04-08 13:24:31 +07:00
LICENSE migrate license from BSD 3 clause to MIT 2019-03-20 16:11:42 +07:00
README.md ported stm32f2, added board stm32f207zg nucleo 2019-09-12 10:41:03 +07:00
changelog.md start to add webusb example (not work yet) 2019-07-11 23:12:53 +07:00
pkg.yml clean up 2018-09-02 20:30:07 +07:00
repository.yml correct mynewt version 2019-03-21 19:26:53 +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

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

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

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 Due to the newt package build system, Mynewt examples are better to be on its own repo

Supported MCUs

The stack supports the following MCUs

  • Nordic: nRF52840
  • NXP: LPC11Uxx, LPC13xx, LPC175x_6x, LPC177x_8x, LPC18xx, LPC40xx, LPC43xx, LPC51Uxx
  • MicroChip: SAMD21, SAMD51 (device only)
  • ST: STM32F0, STM32F2, STM32F3, STM32F4, STM32F7, STM32H7 (device only)

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