Merge remote-tracking branch 'upstream/master' into pr/1702

1 files changed, 119 insertions, 50 deletions

diff --git a/README.rst b/README.rst
index 05963a655..fe2417451 100644
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,24 @@
+|Build Status| |Documentation Status| |Fuzzing Status| |License|
+
+Sponsors
+========
+
+TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project.
+
+.. figure:: docs/assets/adafruit_logo.svg
+   :alt: Adafruit Logo
+   :target: https://www.adafruit.com
+
+TinyUSB Project
+===============
+
 .. 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 <https://docs.tinyusb.org/>`__.
+the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.
 
 .. figure:: docs/assets/stack.svg
    :width: 500px
@@ -16,46 +26,30 @@ Please take a look at the online `documentation <https://docs.tinyusb.org/>`__.
 
 ::
 
-	.
-	├── docs            # Documentation
-	├── examples        # Sample with Makefile 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
+    .
+    ├── 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
 
-Supported MCUs
-==============
 
-The stack supports the following MCUs:
+Getting started
+===============
+
+See the `online documentation <https://docs.tinyusb.org>`_ for information about using TinyUSB and how it is implemented.
 
-- **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:**
+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.
 
-  - iMX RT Series: RT10xx, RT11xx
-  - Kinetis: KL25, K32L2
-  - LPC Series: 11u, 13, 15, 17, 18, 40, 43, 51u, 54, 55
+For bugs and feature requests, please `raise an issue <https://github.com/hathach/tinyusb/issues>`_ and follow the templates there.
 
-- **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
+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.
 
-Here is the list of `Supported Devices`_ that can be used with provided examples.
+See `Porting`_ guide for adding support for new MCUs and boards.
 
 Device Stack
 ============
@@ -82,8 +76,19 @@ Host Stack
 
 - Human Interface Device (HID): Keyboard, Mouse, Generic
 - Mass Storage Class (MSC)
+- Communication Device Class: CDC-ACM
+- Vendor serial over USB: FTDI, CP210x
 - 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.
+
+TypeC PD 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
 ====================
 
@@ -94,6 +99,76 @@ TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR)
 - `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
+==============
+
+Following CPUs are supported, check out `Supported Devices`_ for comprehensive list of driver, features for each CPU.
+
++--------------+------------------------------------------------------------+
+| Manufacturer | Family                                                     |
++==============+============================================================+
+| Allwinner    | F1C100s/F1C200s                                            |
++--------------+------------------------------------------------------------+
+| Analog       | MAX3421E (usb host shield)                                 |
++--------------+------------------------------------------------------------+
+| Brigetek     | FT90x                                                      |
++--------------+------------------------------------------------------------+
+| Broadcom     | BCM2711, BCM2837                                           |
++--------------+------------------------------------------------------------+
+| Dialog       | DA1469x                                                    |
++--------------+------------------------------------------------------------+
+| Espressif    | ESP32 S2, S3                                               |
++--------------+------------------------------------------------------------+
+| GigaDevice   | GD32VF103                                                  |
++--------------+------------------------------------------------------------+
+| Infineon     | XMC4500                                                    |
++--------------+-----+------------------------------------------------------+
+| MicroChip    | SAM | D11, D21, D51, E5x, G55, L2x, E7x, S7x, V7x          |
+|              +-----+------------------------------------------------------+
+|              | PIC | 24, 32mm, 32mk, 32mx, 32mz, dsPIC33                  |
++--------------+-----+------------------------------------------------------+
+| Mind Montion | mm32                                                       |
++--------------+------------------------------------------------------------+
+| NordicSemi   | nRF52833, nRF52840, nRF5340                                |
++--------------+------------------------------------------------------------+
+| Nuvoton      | NUC 120, 121, 125, 126, 505                                |
++--------------+---------+--------------------------------------------------+
+| NXP          | iMXRT   | RT10xx, RT11xx                                   |
+|              +---------+--------------------------------------------------+
+|              | Kinetis | KL, K32L2                                        |
+|              +---------+--------------------------------------------------+
+|              | LPC     | 11u, 13, 15, 17, 18, 40, 43, 51u, 54, 55         |
+|              +---------+--------------------------------------------------+
+|              | MCX     | N9                                               |
++--------------+---------+--------------------------------------------------+
+| Raspberry Pi | RP2040                                                     |
++--------------+-----+------------------------------------------------------+
+| Renesas      | RX  | 63N, 65N, 72N                                        |
++--------------+-----+------------------------------------------------------+
+|              | RA  | 4M1, 4M3, 6M1, 6M5                                   |
++--------------+-----+------------------------------------------------------+
+| Silabs       | EFM32GG12                                                  |
++--------------+------------------------------------------------------------+
+| Sony         | CXD56                                                      |
++--------------+------------------------------------------------------------+
+| ST STM32     | F0, F1, F2, F3, F4, F7, H7, G0, G4, L0, L1, L4, L4+ U5, WB |
++--------------+------------------------------------------------------------+
+| TI           | MSP430, MSP432E4, TM4C123                                  |
++--------------+------------------------------------------------------------+
+| ValentyUSB   | eptri                                                      |
++--------------+------------------------------------------------------------+
+| WCH          | CH32F20x, CH32V307,                                        |
++--------------+------------------------------------------------------------+
+
+License
+=======
+
+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.
+
 Docs
 ====
 
@@ -107,6 +182,7 @@ Docs
 
   - `Supported Devices`_
   - `Getting Started`_
+  - `Dependencies`_
   - `Concurrency`_
 
 - `Contributing`_
@@ -115,20 +191,12 @@ Docs
   - `Structure`_
   - `Porting`_
 
-License
-=======
-
-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:: https://github.com/hathach/tinyusb/workflows/Build/badge.svg
+.. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/cmake_arm.yml/badge.svg
    :target: https://github.com/hathach/tinyusb/actions
 .. |Documentation Status| image:: https://readthedocs.org/projects/tinyusb/badge/?version=latest
    :target: https://docs.tinyusb.org/en/latest/?badge=latest
+.. |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
 .. |License| image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
    :target: https://opensource.org/licenses/MIT
 
@@ -139,6 +207,7 @@ in your project.
 .. _Reference: docs/reference/index.rst
 .. _Supported Devices: docs/reference/supported.rst
 .. _Getting Started: docs/reference/getting_started.rst
+.. _Dependencies: docs/reference/dependencies.rst
 .. _Concurrency: docs/reference/concurrency.rst
 .. _Contributing: docs/contributing/index.rst
 .. _Code of Conduct: CODE_OF_CONDUCT.rst