Espressif TinyUSB fork with DFU runtime
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ha Thach ab18b8794f
Merge pull request #1797 from hathach/fix-midi-len
6 months ago
.codespell add ignore-words to make it easier to 6 months ago
.github clean up 6 months ago
docs more typos 6 months ago
examples Merge pull request #1767 from pete-pjb/master 6 months ago
hw more typos 6 months ago
lib Fix typos 6 months ago
src fix midi MS Header wTotalLength computation 6 months ago
test move build Fuzzer into pre-commit 6 months ago
tools add 11 months ago
.codespellrc update .codespell 6 months ago
.gitattributes Add gitattributes 3 years ago
.gitignore Unify skip and only logic for build scripts 1 year ago
.gitmodules stm32u5: Fix submodules paths 8 months ago
.readthedocs.yaml rename to .readthedocs.yaml 2 years ago
CODE_OF_CONDUCT.rst code_of_conduct: refactor file from markdown to restructuredtext 2 years ago
CONTRIBUTORS.rst increase version, update doc for release 1 year ago
LICENSE migrate license from BSD 3 clause to MIT 4 years ago
README.rst more docs update 10 months ago
pkg.yml Change mynewt package type to sdk 3 years ago
repository.yml update repository.yml 10 months ago
version.yml add repo & version yml 5 years ago


.. figure:: docs/assets/logo.svg
:alt: TinyUSB

|Build Status| |Documentation Status| |License|

TinyUSB is an open-source cross-platform USB Host/Device stack for
embedded system, designed to be memory-safe with no dynamic allocation
and thread-safe with all interrupt events are deferred then handled in
the non-ISR task function.

Please take a look at the online `documentation <>`__.

.. figure:: docs/assets/stack.svg
:width: 500px
:alt: stackup


├── docs # Documentation
├── examples # Sample with Makefile build support
├── hw
│<span class="escaped-code-point" data-escaped="[U+00A0]"><span class="char"> </span></span><span class="escaped-code-point" data-escaped="[U+00A0]"><span class="char"> </span></span> ├── bsp # Supported boards source files
│<span class="escaped-code-point" data-escaped="[U+00A0]"><span class="char"> </span></span><span class="escaped-code-point" data-escaped="[U+00A0]"><span class="char"> </span></span> └── 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:

- **Allwinner:** F1C100s/F1C200s
- **Broadcom:** BCM2837, BCM2711
- **Dialog:** DA1469x
- **Espressif:** ESP32-S2, ESP32-S3
- **GigaDevice:** GD32VF103
- **Infineon:** XMC4500
- **MicroChip:** SAMD11, SAMD21, SAMD51, SAME5x, SAMG55, SAML21, SAML22, SAME7x
- **NordicSemi:** nRF52833, nRF52840, nRF5340
- **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505
- **NXP:**

- iMX RT Series: RT10xx, RT11xx
- Kinetis: KL25, K32L2
- LPC Series: 11u, 13, 15, 17, 18, 40, 43, 51u, 54, 55

- **Raspberry Pi:** RP2040
- **Renesas:** RX63N, RX65N, RX72N
- **Silabs:** EFM32GG
- **Sony:** CXD56
- **ST:** STM32 series: F0, F1, F2, F3, F4, F7, H7, G4, L0, L1, L4, L4+, WB
- **TI:** MSP430, MSP432E4, TM4C123
- **ValentyUSB:** eptri

Here is the list of `Supported Devices`_ that can be used with provided examples.

Device Stack

Supports multiple device configurations by dynamically changing USB descriptors, low power functions such like suspend, resume, and remote wakeup. The following device classes are supported:

- Audio Class 2.0 (UAC2)
- Bluetooth Host Controller Interface (BTH HCI)
- Communication Device Class (CDC)
- Device Firmware Update (DFU): DFU mode (WIP) and Runtime
- Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
- Mass Storage Class (MSC): with multiple LUNs
- Musical Instrument Digital Interface (MIDI)
- Network with RNDIS, Ethernet Control Model (ECM), Network Control Model (NCM)
- Test and Measurement Class (USBTMC)
- Video class 1.5 (UVC): work in progress
- 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

If you have a special requirement, `usbd_app_driver_get_cb()` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <>`_

Host Stack

- Human Interface Device (HID): Keyboard, Mouse, Generic
- Mass Storage Class (MSC)
- Hub with multiple-level support

OS Abstraction layer

TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR) events into a central queue, then processing them later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as Communication Device Class (CDC) FIFO. Therefore the stack needs to use some of the OS's basic APIs. Following OSes are already supported out of the box.

- **No OS**
- **FreeRTOS**
- `RT-Thread <>`_: `repo <>`_
- **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its `own repo <>`_


- Info

- `Uses`_
- `Changelog`_
- `Contributors`_

- `Reference`_

- `Supported Devices`_
- `Getting Started`_
- `Concurrency`_

- `Contributing`_

- `Code of Conduct`_
- `Structure`_
- `Porting`_


All TinyUSB sources in the ``src`` folder are licensed under MIT
license, the `Full license is here <LICENSE>`__. However, each file can be
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.

.. |Build Status| image::
.. |Documentation Status| image::
.. |License| image::

.. _Uses: docs/info/uses.rst
.. _Changelog: docs/info/changelog.rst
.. _Contributors: CONTRIBUTORS.rst
.. _Reference: docs/reference/index.rst
.. _Supported Devices: docs/reference/supported.rst
.. _Getting Started: docs/reference/getting_started.rst
.. _Concurrency: docs/reference/concurrency.rst
.. _Contributing: docs/contributing/index.rst
.. _Code of Conduct: CODE_OF_CONDUCT.rst
.. _Structure: docs/contributing/structure.rst
.. _Porting: docs/contributing/porting.rst