summaryrefslogtreecommitdiff
path: root/docs/reference/boards.rst
diff options
context:
space:
mode:
authorhathach <[email protected]>2024-12-27 09:58:07 +0700
committerhathach <[email protected]>2024-12-27 11:34:35 +0700
commit824793a428aea082b4ae887ce7a26b4736e1d2cc (patch)
treeffe24c44e4349eb0599a0517c7aaed81e8c6e5d1 /docs/reference/boards.rst
parent6a36c74b10b25f1455d83ba473fff52a9dbcc6d2 (diff)
move mcu supported to README.rst, separated supported boards to boards.rst
Diffstat (limited to 'docs/reference/boards.rst')
-rw-r--r--docs/reference/boards.rst39
1 files changed, 22 insertions, 17 deletions
diff --git a/docs/reference/boards.rst b/docs/reference/boards.rst
index 424336dad..4739467bc 100644
--- a/docs/reference/boards.rst
+++ b/docs/reference/boards.rst
@@ -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
@@ -23,7 +28,7 @@ max78002evkit MAX78002 EVKIT max78002 https://www.analog.com/en/resources/e
============= ================ ======== =========================================================================================================================== ======
Bridgetek
-=========
+---------
========= ========= ======== ===================================== ======
Board Name Family URL Note
@@ -32,7 +37,7 @@ mm900evxb MM900EVxB brtmm90x https://brtchip.com/product/mm900ev1b
========= ========= ======== ===================================== ======
Espressif
-=========
+---------
========================= ============================== ========= ======================================================================================================== ======
Board Name Family URL Note
@@ -54,7 +59,7 @@ espressif_saola_1 Espresif S2 Saola 1 espressif https://do
========================= ============================== ========= ======================================================================================================== ======
GigaDevice
-==========
+----------
================== ================== ========= ============================= ======
Board Name Family URL Note
@@ -63,7 +68,7 @@ sipeed_longan_nano Sipeed Longan Nano gd32vf103 https://longan.sipeed.com/en/
================== ================== ========= ============================= ======
Infineon
-========
+--------
============= ================= ======== ============================================================================= ======
Board Name Family URL Note
@@ -73,7 +78,7 @@ xmc4700_relax XMC4700 relax kit xmc4000 https://www.infineon.com/cms/en/prod
============= ================= ======== ============================================================================= ======
Microchip
-=========
+---------
========================= =================================== ========== ================================================================================= ======
Board Name Family URL Note
@@ -107,7 +112,7 @@ sensorwatch_m0 SensorWatch saml2x http
========================= =================================== ========== ================================================================================= ======
MindMotion
-==========
+----------
===================== ====================================== ======== =============================================================================================== ======
Board Name Family URL Note
@@ -117,7 +122,7 @@ mm32f327x_pitaya_lite DshanMCU Pitaya Lite with MM32F3273G8P mm32 https:/
===================== ====================================== ======== =============================================================================================== ======
NXP
-===
+---
================== ========================================= ============= ========================================================================================================================================================================= ======
Board Name Family URL Note
@@ -165,7 +170,7 @@ mcxn947brk MCXN947 Breakout mcx n/
================== ========================================= ============= ========================================================================================================================================================================= ======
Nordic Semiconductor
-====================
+--------------------
=========================== ===================================== ======== ============================================================================== ======
Board Name Family URL Note
@@ -183,7 +188,7 @@ pca10100 Nordic nRF52833 DK nrf ht
=========================== ===================================== ======== ============================================================================== ======
Raspberry Pi
-============
+------------
================= ================= ============== ========================================================== ======
Board Name Family URL Note
@@ -194,7 +199,7 @@ raspberrypi_zero2 Raspberry Zero2 broadcom_64bit https://www.raspberrypi.or
================= ================= ============== ========================================================== ======
Renesas
-=======
+-------
============== =========================== ======== ================================================================================================================================================================ ======
Board Name Family URL Note
@@ -212,7 +217,7 @@ uno_r4 Arduino UNO R4 ra https://store-usa.arduino
============== =========================== ======== ================================================================================================================================================================ ======
STMicroelectronics
-==================
+------------------
=================== ================================= ======== ================================================================= ======
Board Name Family URL Note
@@ -272,7 +277,7 @@ stm32wb55nucleo STM32 P-NUCLEO-WB55 stm32wb https://www.st
=================== ================================= ======== ================================================================= ======
Sunxi
-=====
+-----
======= ================= ======== ========================================= ======
Board Name Family URL Note
@@ -281,7 +286,7 @@ f1c100s Lctech Pi F1C200s f1c100s https://linux-sunxi.org/Lctech_Pi_F1C200s
======= ================= ======== ========================================= ======
Texas Instruments
-=================
+-----------------
================= ===================== ======== ========================================= ======
Board Name Family URL Note
@@ -292,7 +297,7 @@ ek_tm4c123gxl TM4C123G LaunchPad tm4c https://www.ti.com/tool/EK-T
================= ===================== ======== ========================================= ======
Tomu
-====
+----
======= ====== ======== ========================= ======
Board Name Family URL Note
@@ -301,7 +306,7 @@ fomu fomu fomu https://tomu.im/fomu.html
======= ====== ======== ========================= ======
WCH
-===
+---
================ ================ ======== ===================================================================== ======
Board Name Family URL Note