summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiFiPhile <[email protected]>2026-06-02 10:41:27 +0200
committerHiFiPhile <[email protected]>2026-06-02 10:43:55 +0200
commite35b070dae92fd2750b8116a6ca0f1de393c7a6a (patch)
treeebb1f698c7a25e98c03833172eac01e6ae092849
parent9c316a458cdfcc00f1d349e24f3504337a59daa1 (diff)
rename to device issues
Signed-off-by: HiFiPhile <[email protected]>
-rw-r--r--README.rst8
-rw-r--r--docs/index.rst2
-rw-r--r--docs/reference/device_issues.rst39
-rw-r--r--docs/reference/index.rst1
-rw-r--r--docs/troubleshooting.rst2
5 files changed, 46 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index c376599ec..e039c2b61 100644
--- a/README.rst
+++ b/README.rst
@@ -207,7 +207,7 @@ Supported CPUs
| | +-------------------+--------+------+-----------+------------------------+---------------------------------------------+
| | | 51u | ✔ | ✖ | ✖ | lpc_ip3511 | |
| | +-------------------+--------+------+-----------+------------------------+---------------------------------------------+
-| | | 54 | ⚠ | ⚠ | ✔ | lpc_ip3511, lpc_ip3516 | :ref:`NRND, read errata <LPC54600 Errata>` |
+| | | 54 | ⚠ | ⚠ | ✔ | lpc_ip3511, lpc_ip3516 | :ref:`NRND, read errata <LPC54600 Issues>` |
| | +-------------------+--------+------+-----------+------------------------+---------------------------------------------+
| | | 55 | ✔ | ✔ | ✔ | lpc_ip3511, lpc_ip3516 | |
| +---------+-------------------+--------+------+-----------+------------------------+---------------------------------------------+
@@ -261,11 +261,11 @@ Supported CPUs
+--------------+-----------------------------+--------+------+-----------+------------------------+---------------------------------------------+
| ValentyUSB | eptri | ✔ | ✖ | ✖ | eptri | |
+--------------+-----------------------------+--------+------+-----------+------------------------+---------------------------------------------+
-| WCH | CH32F20x | ⚠ | | ✔ | ch32_usbhs | :ref:`ISO data loss <WCH CH32X Errata>` |
+| WCH | CH32F20x | ⚠ | | ✔ | ch32_usbhs | :ref:`ISO data loss <WCH CH32X Issues>` |
| +-----------------------------+--------+------+-----------+------------------------+---------------------------------------------+
-| | CH32V20x | ⚠ | | ✖ | stm32_fsdev/ch32_usbfs | :ref:`ISO data loss <WCH CH32X Errata>` |
+| | CH32V20x | ⚠ | | ✖ | stm32_fsdev/ch32_usbfs | :ref:`ISO data loss <WCH CH32X Issues>` |
| +-----------------------------+--------+------+-----------+------------------------+---------------------------------------------+
-| | CH32V305, CH32V307 | ⚠ | | ✔ | ch32_usbfs/hs | :ref:`ISO data loss <WCH CH32X Errata>` |
+| | CH32V305, CH32V307 | ⚠ | | ✔ | ch32_usbfs/hs | :ref:`ISO data loss <WCH CH32X Issues>` |
+--------------+-----------------------------+--------+------+-----------+------------------------+---------------------------------------------+
Table Legend
diff --git a/docs/index.rst b/docs/index.rst
index a8762c2c2..b80804ad4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,7 +10,7 @@
reference/index
faq
troubleshooting
- reference/errata
+ reference/device_issues
.. toctree::
:maxdepth: 1
diff --git a/docs/reference/device_issues.rst b/docs/reference/device_issues.rst
new file mode 100644
index 000000000..22677f967
--- /dev/null
+++ b/docs/reference/device_issues.rst
@@ -0,0 +1,39 @@
+Device specific known issues and workarounds
+===============================================
+This page lists known issues and workarounds for specific devices.
+
+.. _LPC54600 Issues:
+
+NXP LPC54600
+----------------
+**Severity: High**
+
+**Not recommended for USB device applications (except high-speed host controller)**
+
+Reference: `LPC54600 Errata Sheet`_
+
+.. _LPC54600 Errata Sheet: https://www.nxp.com/docs/en/errata/ES_LPC546XX.pdf
+
+The LPC54600 series have a very buggy USB controller, with totally 17 issues listed in the errata which is more than half of the total issues.
+
+Most severe issues are:
+
+- USB.2: In USB high-speed device mode, the NBytes field is not correct after BULK IN transfer
+- USB.5: In USB full-speed host mode, linked list on done queue is broken.
+- USB.15: USB high-speed device in endpoint TX data corruption
+
+.. _WCH CH32X Issues:
+
+WCH CH32V10X/CH32V20X/CH32V30X
+---------------------------------
+**Severity: Medium**
+
+**Not recommended for USB audio applications**
+
+Reference: `CH32V30X Reference Manual`_ USBFS/USBHS controller chapter
+
+.. _CH32V30X Reference Manual: https://www.wch-ic.com/downloads/CH32FV2x_V3xRM_PDF.html
+
+Data corruption may occur on isochronous endpoints. Due to the lacking of FIFO for interrupt status registers, later completed transfer will overwrite `INT_ST` and `RX_LEN` register if previous transfer processing is not completed.
+
+Other types of transfers are not affected.
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index d3c96eeee..fe504627d 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -12,4 +12,5 @@ Complete reference documentation for TinyUSB APIs, configuration, and supported
boards
dependencies
concurrency
+ device_issues
glossary
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index 531d471ed..613c7fcef 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -76,7 +76,7 @@ Invalid board name in build command.
Runtime Issues
==============
-Check :doc:`reference/errata` for known hardware-specific issues that may affect USB functionality on your device.
+Check :doc:`reference/device_issues` for known hardware-specific issues that may affect USB functionality on your device.
Device Mode Problems
--------------------