Skip to content

Commit

Permalink
move mcu supported to README.rst, separated supported boards to board…
Browse files Browse the repository at this point in the history 
…s.rst
  • Loading branch information
@hathach
hathach committed Dec 27, 2024
1 parent 6a36c74 commit 2d31b59
Show file tree
Hide file tree
Showing 6 changed files with 173 additions and 531 deletions.
209 changes: 142 additions & 67 deletions README.rst
View file

Large diffs are not rendered by default.

39 changes: 22 additions & 17 deletions docs/reference/boards.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@
Supported Boards
****************

Following boards are supported and can be used to run stock examples
The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project.
It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices

- One LED : for status
- One Button : to get input from user
- One UART : optional for device, but required for host examples

Following boards are supported

Analog Devices
==============
--------------

============= ================ ======== =========================================================================================================================== ======
Board Name Family URL Note
Expand All @@ -23,7 +28,7 @@ max78002evkit MAX78002 EVKIT max78002 https://www.analog.com/en/resources/e
============= ================ ======== =========================================================================================================================== ======

Bridgetek
=========
---------

========= ========= ======== ===================================== ======
Board Name Family URL Note
Expand All @@ -32,7 +37,7 @@ mm900evxb MM900EVxB brtmm90x https://brtchip.com/product/mm900ev1b
========= ========= ======== ===================================== ======

Espressif
=========
---------

========================= ============================== ========= ======================================================================================================== ======
Board Name Family URL Note
Expand All @@ -54,7 +59,7 @@ espressif_saola_1 Espresif S2 Saola 1 espressif https://do
========================= ============================== ========= ======================================================================================================== ======

GigaDevice
==========
----------

================== ================== ========= ============================= ======
Board Name Family URL Note
Expand All @@ -63,7 +68,7 @@ sipeed_longan_nano Sipeed Longan Nano gd32vf103 https://longan.sipeed.com/en/
================== ================== ========= ============================= ======

Infineon
========
--------

============= ================= ======== ============================================================================= ======
Board Name Family URL Note
Expand All @@ -73,7 +78,7 @@ xmc4700_relax XMC4700 relax kit xmc4000 https://www.infineon.com/cms/en/prod
============= ================= ======== ============================================================================= ======

Microchip
=========
---------

========================= =================================== ========== ================================================================================= ======
Board Name Family URL Note
Expand Down Expand Up @@ -107,7 +112,7 @@ sensorwatch_m0 SensorWatch saml2x http
========================= =================================== ========== ================================================================================= ======

MindMotion
==========
----------

===================== ====================================== ======== =============================================================================================== ======
Board Name Family URL Note
Expand All @@ -117,7 +122,7 @@ mm32f327x_pitaya_lite DshanMCU Pitaya Lite with MM32F3273G8P mm32 https:/
===================== ====================================== ======== =============================================================================================== ======

NXP
===
---

================== ========================================= ============= ========================================================================================================================================================================= ======
Board Name Family URL Note
Expand Down Expand Up @@ -165,7 +170,7 @@ mcxn947brk MCXN947 Breakout mcx n/
================== ========================================= ============= ========================================================================================================================================================================= ======

Nordic Semiconductor
====================
--------------------

=========================== ===================================== ======== ============================================================================== ======
Board Name Family URL Note
Expand All @@ -183,7 +188,7 @@ pca10100 Nordic nRF52833 DK nrf ht
=========================== ===================================== ======== ============================================================================== ======

Raspberry Pi
============
------------

================= ================= ============== ========================================================== ======
Board Name Family URL Note
Expand All @@ -194,7 +199,7 @@ raspberrypi_zero2 Raspberry Zero2 broadcom_64bit https://www.raspberrypi.or
================= ================= ============== ========================================================== ======

Renesas
=======
-------

============== =========================== ======== ================================================================================================================================================================ ======
Board Name Family URL Note
Expand All @@ -212,7 +217,7 @@ uno_r4 Arduino UNO R4 ra https://store-usa.arduino
============== =========================== ======== ================================================================================================================================================================ ======

STMicroelectronics
==================
------------------

=================== ================================= ======== ================================================================= ======
Board Name Family URL Note
Expand Down Expand Up @@ -272,7 +277,7 @@ stm32wb55nucleo STM32 P-NUCLEO-WB55 stm32wb https://www.st
=================== ================================= ======== ================================================================= ======

Sunxi
=====
-----

======= ================= ======== ========================================= ======
Board Name Family URL Note
Expand All @@ -281,7 +286,7 @@ f1c100s Lctech Pi F1C200s f1c100s https://linux-sunxi.org/Lctech_Pi_F1C200s
======= ================= ======== ========================================= ======

Texas Instruments
=================
-----------------

================= ===================== ======== ========================================= ======
Board Name Family URL Note
Expand All @@ -292,7 +297,7 @@ ek_tm4c123gxl TM4C123G LaunchPad tm4c https://www.ti.com/tool/EK-T
================= ===================== ======== ========================================= ======

Tomu
====
----

======= ====== ======== ========================= ======
Board Name Family URL Note
Expand All @@ -301,7 +306,7 @@ fomu fomu fomu https://tomu.im/fomu.html
======= ====== ======== ========================= ======

WCH
===
---

================ ================ ======== ===================================================================== ======
Board Name Family URL Note
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/getting_started.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ It is relatively simple to incorporate tinyusb to your project
Examples
--------

For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API() should be used. Most examples will work on most of `the supported boards <supported.rst>`_. Firstly we need to ``git clone`` if not already
For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API() should be used. Most examples will work on most of `the supported boards <boards.rst>`_. Firstly we need to ``git clone`` if not already

.. code-block::
Expand Down
1 change: 0 additions & 1 deletion docs/reference/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Index
:maxdepth: 2

getting_started
supported
boards
dependencies
concurrency
Loading

0 comments on commit 2d31b59

Please sign in to comment.