mirror of
https://github.com/hathach/tinyusb.git
synced 2026-08-18 11:02:16 +00:00
dcb060c894
Tidy the CH58x register/buffer layout the initial port left rough. Register map (USBOTG_FS_TypeDef): - Extend the struct to the full CH583/582 datasheet Table 17-2 map instead of stopping at UEP567_MOD (0x0E) with the per-endpoint registers living only in raw-address macros. - Express the per-endpoint DMA/length/control registers as arrays of 4-byte slots (ch58x_ep_dma_t / ch58x_ep_ctrl_t): EP0-3 DMA at 0x10, EP0-4 ctrl at 0x20, EP5-7 DMA/ctrl split to 0x54/0x64 (EP4 has no DMA register of its own; it shares EP0's). TU_VERIFY_STATIC pins the slot sizes and block offsets, so the EP_TX_LEN/EP_CTRL/EP_DMA macros walk each block by the 4-byte stride (pointer arithmetic off slot 0, so the unused ternary branch can't trip -Warray-bounds). - Gate the two driver sites on CFG_TUSB_MCU == OPT_MCU_CH58X directly rather than the CH32_USBFS_EP_REGS_CUSTOM alias, which was only ever defined in the CH58x branch. EP buffers (the data struct): - Replace buffer[EP_MAX][2][64] on CH58x with named per-endpoint buffers: EP0/EP4 use the dedicated 192B ep0_ep4_buffer, so the old array left buffer[0]/buffer[4] allocated-but-unused. - Drop EP3's oversized iso buffer (out[64] + in[1023]); EP3 is bulk-only on CH58x, so it uses a plain 128-byte buffer like the others. The data struct shrinks from ~2636 to 1292 bytes. - Keep the now uniformly-64-byte buffers safe: dcd_edpt_iso_alloc()/iso_activate() refuse isochronous on CH58x (no iso support; 8-bit T_LEN caps a packet at 255B), and update_in()/update_out() additionally cap each packet copy to 64 bytes so a class that ignores the iso-alloc result cannot run a memcpy past a buffer into a neighbour's. Non-CH58x parts (e.g. ch32v103) keep the struct-based macros, buffer[EP_MAX], and the iso buffer unchanged. Verified on ch582m_evt HIL (ci.lan): all device examples pass; ch32v103 build unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
TinyUSB
=======
|Sponsor| |Build Status| |CircleCI Status| |Documentation Status| |Static Analysis| |Fuzzing Status| |Membrowse| |License|
Overview
--------
.. figure:: docs/assets/logo.svg
:alt: TinyUSB
:align: left
.. raw:: html
<div class="clear-both"></div>
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems. It’s designed for memory safety
(no dynamic allocation) and thread safety (all interrupts deferred to non-ISR task functions). The stack emphasizes portability,
small footprint, and real-time performance across 50+ MCU families.
Sponsors
--------
TinyUSB's continued development is made possible by its sponsors. If TinyUSB helps your products or projects, consider funding its development on `GitHub Sponsors`_.
Platinum
^^^^^^^^
`Adafruit`_ has backed TinyUSB since day one as its founding and sole Platinum sponsor. Buying their products directly funds the project's development.
.. figure:: docs/assets/adafruit_logo.svg
:alt: Adafruit Logo
:align: left
:target: https://www.adafruit.com
.. raw:: html
<div class="clear-both"></div>
Sponsors (QWORD)
^^^^^^^^^^^^^^^^
.. QWORD-SPONSORS-START
*No QWORD sponsors yet — be the first!*
.. QWORD-SPONSORS-END
Backers (DWORD)
^^^^^^^^^^^^^^^
.. DWORD-BACKERS-START
*No backers yet — be the first!*
.. DWORD-BACKERS-END
Supporters (Word)
^^^^^^^^^^^^^^^^^
.. WORD-SUPPORTERS-START
*No supporters yet — be the first!*
.. WORD-SUPPORTERS-END
Thanks (Byte)
^^^^^^^^^^^^^
.. BYTE-THANKS-START
*No names listed yet — be the first!*
.. BYTE-THANKS-END
.. _GitHub Sponsors: https://github.com/sponsors/hathach
.. _Adafruit: https://www.adafruit.com
Key Features
------------
* **Thread-safe:** USB interrupts deferred to task context
* **Memory-safe:** No dynamic allocation, all buffers static
* **Portable:** Supports 50+ MCU families
* **Comprehensive:** Includes CDC, HID, MSC, Audio, and Host support
* **RTOS-friendly:** Works with bare metal, FreeRTOS, RT-Thread, and Mynewt
.. figure:: docs/assets/stack.svg
:width: 500px
:align: left
:alt: stackup
.. raw:: html
<div class="clear-both"></div>
::
.
├── docs # Documentation
├── examples # Examples with make and cmake build system
├── 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 # Tests: unit test, fuzzing, hardware test
└── tools # Files used internally
Getting started
---------------
See the `online documentation <https://docs.tinyusb.org>`_ for information about using TinyUSB and how it is implemented.
Check out `Getting Started`_ guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the ``cdc_msc`` example. There is a handful of `Supported Boards`_ that should work out of the box.
We use `GitHub Discussions <https://github.com/hathach/tinyusb/discussions>`_ as our forum. It is a great place to ask questions and advice from the community or to discuss your TinyUSB-based projects.
For bugs and feature requests, please `raise an issue <https://github.com/hathach/tinyusb/issues>`_ and follow the templates there.
See `Porting`_ guide for adding support for new MCUs and boards.
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 1.0/2.0 (UAC1/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 ...
- Printer class
- Mass Storage Class (MSC): with multiple LUNs
- Musical Instrument Digital Interface (MIDI)
- Media Transfer Protocol (MTP/PTP)
- 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 <https://github.com/WICG/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 <https://github.com/raspberrypi/pico-sdk/pull/197>`_
Host Stack
----------
- Communication Device Class: CDC-ACM
- Vendor serial over USB: FTDI, CP210x, CH34x, PL2303
- Human Interface Device (HID): Keyboard, Mouse, Generic
- Mass Storage Class (MSC)
- Musical Instrument Digital Interface (MIDI)
- Hub with multiple-level support
Similar to the Device Stack, if you have a special requirement, ``usbh_app_driver_get_cb()`` can be used to write your own class driver without modifying the stack.
Power Delivery Stack
--------------------
- Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)
- Super early stage, only for testing purpose
- Only support STM32 G4
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 <https://github.com/RT-Thread/rt-thread>`_: `repo <https://github.com/RT-Thread-packages/tinyusb>`_
- **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its `own repo <https://github.com/hathach/mynewt-tinyusb-example>`_
Supported CPUs
--------------
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Manufacturer | Family | Device | Host | Highspeed | Driver | Note |
+==============+=============================+========+======+===========+========================+====================+
| Allwinner | F1C100s/F1C200s | ✅ | | ✅ | sunxi | musb variant |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Analog | MAX3421E | | ✅ | ❌ | max3421 | via SPI |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | MAX32 650, 666, 690, | ✅ | | ✅ | musb | 1-dir ep |
| | MAX78002 | | | | | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Artery AT32 | F403a_407, F413 | ✅ | | | fsdev | 512 USB RAM |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | F415, F435_437, F423, | ✅ | ✅ | | dwc2 | |
| | F425, F45x | | | | | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | F402_F405 | ✅ | ✅ | ✅ | dwc2 | F405 is HS |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Bridgetek | FT90x | ✅ | | ✅ | ft9xx | 1-dir ep |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Broadcom | BCM2711, BCM2837 | ✅ | | ✅ | dwc2 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Dialog | DA1469x | ✅ | ❌ | ❌ | da146xx | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Espressif | S2, S3, H4 | ✅ | ✅ | ❌ | dwc2 | |
| ESP32 +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | P4 | ✅ | ✅ | ✅ | dwc2 | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | S31 | ✅ | ✅ | ✅ | dwc2 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| GigaDevice | GD32VF103 | ✅ | | ❌ | dwc2 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| HPMicro | HPM6750 | ✅ | ✅ | ✅ | ci_hs, ehci | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Infineon | XMC4500 | ✅ | ✅ | ❌ | dwc2 | |
+--------------+-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| MicroChip | SAM | D11, D21, L21, L22 | ✅ | | ❌ | samd | |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | D51, E5x | ✅ | | ❌ | samd | |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | G55 | ✅ | | ❌ | samg | 1-dir ep |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | E70,S70,V70,V71 | ✅ | | ✅ | samx7x | 1-dir ep |
| +-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| | PIC | 24 | ✅ | | | pic | ci_fs variant |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | 32 mm, mk, mx | ✅ | | | pic | ci_fs variant |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | dsPIC33 | ✅ | | | pic | ci_fs variant |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | 32mz | ✅ | | | pic32mz | musb variant |
+--------------+-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| MindMotion | mm32 | ✅ | | ❌ | mm32f327x_otg | ci_fs variant |
+--------------+-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| NordicSemi | nRF52, nRF53 | ✅ | ❌ | ❌ | nrf5x | only ep8 is ISO |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | nRF54 | ✅ | ❌ | ✅ | dwc2 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Nuvoton | NUC120 | ✅ | ❌ | ❌ | nuc120 | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | NUC121/NUC125, NUC126 | ✅ | ❌ | ❌ | nuc121 | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | NUC505 | ✅ | | ✅ | nuc505 | |
+--------------+---------+-------------------+--------+------+-----------+------------------------+--------------------+
| NXP | iMXRT | RT 10xx, 11xx | ✅ | ✅ | ✅ | ci_hs, ehci | |
| +---------+-------------------+--------+------+-----------+------------------------+--------------------+
| | Kinetis | KL | ✅ | 🟡 | ❌ | ci_fs, khci | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | K32L2 | ✅ | | ❌ | khci | ci_fs variant |
| +---------+-------------------+--------+------+-----------+------------------------+--------------------+
| | LPC | 11u, 13, 15 | ✅ | ❌ | ❌ | lpc_ip3511 | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | 17, 40 | ✅ | 🟡 | ❌ | lpc17_40, ohci | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | 18, 43 | ✅ | ✅ | ✅ | ci_hs, ehci | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | 51u | ✅ | ❌ | ❌ | lpc_ip3511 | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | 54 | 🟡 | 🟡 | ✅ | lpc_ip3511, lpc_ip3516 | NRND [1]_ |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | 55 | ✅ | ✅ | ✅ | lpc_ip3511, lpc_ip3516 | |
| +---------+-------------------+--------+------+-----------+------------------------+--------------------+
| | MCX | N9 | ✅ | | ✅ | ci_fs, ci_hs, ehci | |
| | +-------------------+--------+------+-----------+------------------------+--------------------+
| | | A15 | ✅ | | | ci_fs | |
| +---------+-------------------+--------+------+-----------+------------------------+--------------------+
| | RW61x | ✅ | ✅ | ✅ | ci_hs, ehci | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Raspberry Pi | RP2040, RP2350 | ✅ | ✅ | ❌ | rp2040, pio_usb | |
+--------------+-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| Renesas | RX | 63N, 65N, 72N | ✅ | ✅ | ❌ | rusb2 | |
| +-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| | RA | 4M1, 4M3, 6M1 | ✅ | ✅ | ❌ | rusb2 | |
| | +-----------------------+--------+------+-----------+------------------------+--------------------+
| | | 6M5 | ✅ | ✅ | ✅ | rusb2 | |
+--------------+-----+-----------------------+--------+------+-----------+------------------------+--------------------+
| Silabs | EFM32GG12 | ✅ | | ❌ | dwc2 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| Sony | CXD56 | ✅ | ❌ | ✅ | cxd56 | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| ST STM32 | F0, F3, L0, L1, L5, WBx5 | ✅ | ❌ | ❌ | stm32_fsdev | |
| +----+------------------------+--------+------+-----------+------------------------+--------------------+
| | F1 | 102, 103 | ✅ | ❌ | ❌ | stm32_fsdev | 512 USB RAM |
| | +------------------------+--------+------+-----------+------------------------+--------------------+
| | | 105, 107 | ✅ | ✅ | ❌ | dwc2 | |
| +----+------------------------+--------+------+-----------+------------------------+--------------------+
| | F2, F4, F7, H7, H7RS | ✅ | ✅ | ✅ | dwc2 | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | C0, C5, G0, H5, U3 | ✅ | ✅ | ❌ | stm32_fsdev | 2KB USB RAM |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | G4 | ✅ | ❌ | ❌ | stm32_fsdev | 1KB USB RAM |
| +----+------------------------+--------+------+-----------+------------------------+--------------------+
| | L4 | 4x2, 4x3 | ✅ | ❌ | ❌ | stm32_fsdev | 1KB USB RAM |
| | +------------------------+--------+------+-----------+------------------------+--------------------+
| | | 4x5, 4x6, 4+ | ✅ | ✅ | ❌ | dwc2 | |
| +----+------------------------+--------+------+-----------+------------------------+--------------------+
| | N6 | ✅ | ✅ | ✅ | dwc2 | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | U0 | ✅ | ❌ | ❌ | stm32_fsdev | 1KB USB RAM |
| +----+------------------------+--------+------+-----------+------------------------+--------------------+
| | U5 | 535, 545 | ✅ | ✅ | ❌ | stm32_fsdev | 2KB USB RAM |
| | +------------------------+--------+------+-----------+------------------------+--------------------+
| | | 575, 585 | ✅ | ✅ | ❌ | dwc2 | |
| | +------------------------+--------+------+-----------+------------------------+--------------------+
| | | 59x,5Ax,5Fx,5Gx | ✅ | ✅ | ✅ | dwc2 | |
+--------------+----+------------------------+--------+------+-----------+------------------------+--------------------+
| TI | MSP430 | ✅ | ❌ | ❌ | msp430x5xx | |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | MSP432E4, TM4C123 | ✅ | | ❌ | musb | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| ValentyUSB | eptri | ✅ | ❌ | ❌ | eptri | |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
| WCH | CH32F20x | 🟡 | | ✅ | ch32_usbhs | ISO data loss [2]_ |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | CH32V20x | 🟡 | | ❌ | stm32_fsdev/ch32_usbfs | ISO data loss [2]_ |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | CH32V305, CH32V307 | 🟡 | | ✅ | ch32_usbfs/hs | ISO data loss [2]_ |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
Table Legend
^^^^^^^^^^^^
========= =========================
✅ Supported
🟡 Partial support
❌ Not supported by hardware
\[empty\] Unknown
========= =========================
.. [1] NRND (Not Recommended for New Design), see `NXP LPC54600 issues <docs/reference/device_issues.rst#nxp-lpc54600>`_
.. [2] ISO data loss, see `WCH CH32F20x/CH32V20x/CH32V30x issues <docs/reference/device_issues.rst#wch-ch32f20x-ch32v20x-ch32v30x>`_
Development Tools
-----------------
The following tools are provided freely to support the development of the TinyUSB project:
- `IAR Build Tools (CX) <https://iar.com>`_ Professional IDE and compiler for embedded development.
- `JetBrains CLion <https://www.jetbrains.com/clion/>`_ Cross-platform IDE for C and C++ development.
- `PVS-Studio <https://pvs-studio.com/en/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source>`_ static analyzer for C, C++, C#, and Java code.
.. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/build.yml/badge.svg
:target: https://github.com/hathach/tinyusb/actions/workflows/build.yml
.. |CircleCI Status| image:: https://dl.circleci.com/status-badge/img/circleci/4AYHvUhFxdnY4rA7LEsdqW/QmrpoL2AjGqetvFQNqtWyq/tree/master.svg?style=svg
:target: https://dl.circleci.com/status-badge/redirect/circleci/4AYHvUhFxdnY4rA7LEsdqW/QmrpoL2AjGqetvFQNqtWyq/tree/master
.. |Documentation Status| image:: https://readthedocs.org/projects/tinyusb/badge/?version=latest
:target: https://docs.tinyusb.org/en/latest/?badge=latest
.. |Static Analysis| image:: https://github.com/hathach/tinyusb/actions/workflows/static_analysis.yml/badge.svg
:target: https://github.com/hathach/tinyusb/actions/workflows/static_analysis.yml
.. |Fuzzing Status| image:: https://oss-fuzz-build-logs.storage.googleapis.com/badges/tinyusb.svg
:target: https://oss-fuzz-build-logs.storage.googleapis.com/index.html#tinyusb
.. |Membrowse| image:: https://membrowse.com/badge.svg
:target: https://membrowse.com/public/hathach/tinyusb
.. |License| image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
:target: https://opensource.org/licenses/MIT
.. |Sponsor| image:: https://img.shields.io/badge/sponsor-%E2%9D%A4-ec6cb9.svg
:target: https://github.com/sponsors/hathach
.. _Changelog: docs/info/changelog.rst
.. _Contributors: CONTRIBUTORS.rst
.. _Getting Started: docs/getting_started.rst
.. _Supported Boards: docs/reference/boards.rst
.. _Dependencies: docs/reference/dependencies.rst
.. _Concurrency: docs/reference/concurrency.rst
.. _Code of Conduct: CODE_OF_CONDUCT.rst
.. _Porting: docs/porting.rst