Skip to content

Commit 824793a

Browse files
hathachhathach
committed
move mcu supported to README.rst, separated supported boards to boards.rst
1 parent 6a36c74 commit 824793a

File tree

7 files changed

+176
-533
lines changed

7 files changed

+176
-533
lines changed

‎README.rst‎

Lines changed: 144 additions & 69 deletions
Large diffs are not rendered by default.

‎docs/reference/boards.rst‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22
Supported Boards
33
****************
44

5-
Following boards are supported and can be used to run stock examples
5+
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.
6+
It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices
67

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

12+
Following boards are supported
813

914
Analog Devices
10-
==============
15+
--------------
1116

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

2530
Bridgetek
26-
=========
31+
---------
2732

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

3439
Espressif
35-
=========
40+
---------
3641

3742
========================= ============================== ========= ======================================================================================================== ======
3843
Board Name Family URL Note
@@ -54,7 +59,7 @@ espressif_saola_1 Espresif S2 Saola 1 espressif https://do
5459
========================= ============================== ========= ======================================================================================================== ======
5560

5661
GigaDevice
57-
==========
62+
----------
5863

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

6570
Infineon
66-
========
71+
--------
6772

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

7580
Microchip
76-
=========
81+
---------
7782

7883
========================= =================================== ========== ================================================================================= ======
7984
Board Name Family URL Note
@@ -107,7 +112,7 @@ sensorwatch_m0 SensorWatch saml2x http
107112
========================= =================================== ========== ================================================================================= ======
108113

109114
MindMotion
110-
==========
115+
----------
111116

112117
===================== ====================================== ======== =============================================================================================== ======
113118
Board Name Family URL Note
@@ -117,7 +122,7 @@ mm32f327x_pitaya_lite DshanMCU Pitaya Lite with MM32F3273G8P mm32 https:/
117122
===================== ====================================== ======== =============================================================================================== ======
118123

119124
NXP
120-
===
125+
---
121126

122127
================== ========================================= ============= ========================================================================================================================================================================= ======
123128
Board Name Family URL Note
@@ -165,7 +170,7 @@ mcxn947brk MCXN947 Breakout mcx n/
165170
================== ========================================= ============= ========================================================================================================================================================================= ======
166171

167172
Nordic Semiconductor
168-
====================
173+
--------------------
169174

170175
=========================== ===================================== ======== ============================================================================== ======
171176
Board Name Family URL Note
@@ -183,7 +188,7 @@ pca10100 Nordic nRF52833 DK nrf ht
183188
=========================== ===================================== ======== ============================================================================== ======
184189

185190
Raspberry Pi
186-
============
191+
------------
187192

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

196201
Renesas
197-
=======
202+
-------
198203

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

214219
STMicroelectronics
215-
==================
220+
------------------
216221

217222
=================== ================================= ======== ================================================================= ======
218223
Board Name Family URL Note
@@ -272,7 +277,7 @@ stm32wb55nucleo STM32 P-NUCLEO-WB55 stm32wb https://www.st
272277
=================== ================================= ======== ================================================================= ======
273278

274279
Sunxi
275-
=====
280+
-----
276281

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

283288
Texas Instruments
284-
=================
289+
-----------------
285290

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

294299
Tomu
295-
====
300+
----
296301

297302
======= ====== ======== ========================= ======
298303
Board Name Family URL Note
@@ -301,7 +306,7 @@ fomu fomu fomu https://tomu.im/fomu.html
301306
======= ====== ======== ========================= ======
302307

303308
WCH
304-
===
309+
---
305310

306311
================ ================ ======== ===================================================================== ======
307312
Board Name Family URL Note

‎docs/reference/getting_started.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ It is relatively simple to incorporate tinyusb to your project
5050
Examples
5151
--------
5252

53-
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
53+
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
5454

5555
.. code-block::
5656

‎docs/reference/index.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ Index
8080
:maxdepth: 2
8181

8282
getting_started
83-
supported
8483
boards
8584
dependencies
8685
concurrency

0 commit comments

Comments
 (0)