embed metadata to family.c and board.h to generate supported boards doc

hathach · Dec 27, 2024 · 6a36c74 · 6a36c74
1 parent 86ad6e5
commit 6a36c74
Show file tree

Hide file tree

Showing 247 changed files with 1,697 additions and 7 deletions.
diff --git a/docs/info/changelog.rst b/docs/info/changelog.rst
@@ -17,7 +17,6 @@ General
 - Build ARM IAR with CircleCI
 - Improve HIL with dual/host_info_to_device_cdc optional for pico/pico2, enable dwc2 dma test
 
-
 API Changes
 -----------
 
@@ -31,7 +30,6 @@ API Changes
   - ``CFG_TUD/TUH_DWC2_SLAVE_ENABLE`` enable dwc2 slave mode
   - ``CFG_TUD/TUH_DWC2_DMA_ENABLE`` enable dwc2 dma mode
 
-
 Controller Driver (DCD & HCD)
 -----------------------------
 

diff --git a/docs/reference/boards.rst b/docs/reference/boards.rst
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -79,7 +79,8 @@ Index
 .. toctree::
    :maxdepth: 2
 
-   supported
    getting_started
+   supported
+   boards
    dependencies
    concurrency
diff --git a/hw/bsp/broadcom_32bit/boards/raspberrypi_zero/board.h b/hw/bsp/broadcom_32bit/boards/raspberrypi_zero/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Raspberry Pi Zero
+   url: https://www.raspberrypi.org/products/raspberry-pi-zero/
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/broadcom_32bit/family.c b/hw/bsp/broadcom_32bit/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Raspberry Pi
+*/
+
 #include "bsp/board_api.h"
 #include "board.h"
 

diff --git a/hw/bsp/broadcom_64bit/boards/raspberrypi_cm4/board.h b/hw/bsp/broadcom_64bit/boards/raspberrypi_cm4/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Raspberry CM4
+   url: https://www.raspberrypi.org/products/compute-module-4
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/broadcom_64bit/boards/raspberrypi_zero2/board.h b/hw/bsp/broadcom_64bit/boards/raspberrypi_zero2/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Raspberry Zero2
+   url: https://www.raspberrypi.org/products/raspberry-pi-zero-2-w
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/broadcom_64bit/family.c b/hw/bsp/broadcom_64bit/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Raspberry Pi
+*/
+
 #include "bsp/board_api.h"
 #include "board.h"
 

diff --git a/hw/bsp/brtmm90x/boards/mm900evxb/board.h b/hw/bsp/brtmm90x/boards/mm900evxb/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: MM900EVxB
+   url: https://brtchip.com/product/mm900ev1b
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/brtmm90x/family.c b/hw/bsp/brtmm90x/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Bridgetek
+*/
+
 #include "bsp/board_api.h"
 #include "board.h"
 

diff --git a/hw/bsp/ch32f20x/boards/ch32f205r-r0/board.h b/hw/bsp/ch32f20x/boards/ch32f205r-r0/board.h
@@ -22,6 +22,11 @@
  * THE SOFTWARE.
  */
 
+/* metadata:
+   name: CH32F205r-r0
+   url: https://github.com/openwch/ch32f20x
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32f20x/family.c b/hw/bsp/ch32f20x/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: WCH
+*/
+
 #include "stdio.h"
 #include "debug_uart.h"
 

diff --git a/hw/bsp/ch32v10x/boards/ch32v103r_r1_1v0/board.h b/hw/bsp/ch32v10x/boards/ch32v103r_r1_1v0/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: CH32V103R-R1-1v1
+   url: https://github.com/openwch/ch32v103/tree/main/SCHPCB/CH32V103R-R1-1v1
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32v10x/family.c b/hw/bsp/ch32v10x/family.c
@@ -1,3 +1,7 @@
+/* metadata:
+   manufacturer: WCH
+*/
+
 #include <stdio.h>
 
 // https://github.com/openwch/ch32v307/pull/90

diff --git a/hw/bsp/ch32v20x/boards/ch32v203c_r0_1v0/board.h b/hw/bsp/ch32v20x/boards/ch32v203c_r0_1v0/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: CH32V203C-R0-1v0
+   url: https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32v20x/boards/ch32v203g_r0_1v0/board.h b/hw/bsp/ch32v20x/boards/ch32v203g_r0_1v0/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: CH32V203G-R0-1v0
+   url: https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32v20x/boards/nanoch32v203/board.h b/hw/bsp/ch32v20x/boards/nanoch32v203/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: nanoCH32V203
+   url: https://github.com/wuxx/nanoCH32V203
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32v20x/family.c b/hw/bsp/ch32v20x/family.c
@@ -1,3 +1,7 @@
+/* metadata:
+manufacturer: WCH
+*/
+
 #include <stdio.h>
 
 // https://github.com/openwch/ch32v307/pull/90

diff --git a/hw/bsp/ch32v307/boards/ch32v307v_r1_1v0/board.h b/hw/bsp/ch32v307/boards/ch32v307v_r1_1v0/board.h
@@ -22,6 +22,11 @@
  * THE SOFTWARE.
  */
 
+/* metadata:
+   name: CH32V307V-R1-1v0
+   url: https://github.com/openwch/ch32v307/tree/main/SCHPCB/CH32V307V-R1-1v0
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/ch32v307/family.c b/hw/bsp/ch32v307/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: WCH
+*/
+
 #include "stdio.h"
 
 // https://github.com/openwch/ch32v307/pull/90

diff --git a/hw/bsp/da1469x/boards/da14695_dk_usb/board.h b/hw/bsp/da1469x/boards/da14695_dk_usb/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: DA14695-00HQDEVKT-U
+   url: https://www.renesas.com/en/products/wireless-connectivity/bluetooth-low-energy/da14695-00hqdevkt-u-smartbond-da14695-bluetooth-low-energy-52-usb-development-kit
+*/
+
 #ifndef BOARD_H
 #define BOARD_H
 

diff --git a/hw/bsp/da1469x/boards/da1469x_dk_pro/board.h b/hw/bsp/da1469x/boards/da1469x_dk_pro/board.h
@@ -1,3 +1,8 @@
+/* metadata:
+   name: DA1469x Development Kit Pro
+   url: https://lpccs-docs.renesas.com/um-b-090-da1469x_getting_started/DA1469x_The_hardware/DA1469x_The_hardware.html
+*/
+
 #ifndef BOARD_H
 #define BOARD_H
 

diff --git a/hw/bsp/da1469x/family.c b/hw/bsp/da1469x/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Renesas
+*/
+
 #include "bsp/board_api.h"
 #include "board.h"
 #include <hal/hal_gpio.h>

diff --git a/hw/bsp/espressif/boards/adafruit_feather_esp32_v2/board.h b/hw/bsp/espressif/boards/adafruit_feather_esp32_v2/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Adafruit Feather ESP32 v2
+   url: https://www.adafruit.com/product/5400
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/adafruit_feather_esp32s2/board.h b/hw/bsp/espressif/boards/adafruit_feather_esp32s2/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Adafruit Feather ESP32S2
+   url: https://www.adafruit.com/product/5000
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/adafruit_feather_esp32s3/board.h b/hw/bsp/espressif/boards/adafruit_feather_esp32s3/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Adafruit Feather ESP32S3
+   url: https://www.adafruit.com/product/5323
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/adafruit_magtag_29gray/board.h b/hw/bsp/espressif/boards/adafruit_magtag_29gray/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Adafruit MagTag 2.9" Grayscale
+   url: https://www.adafruit.com/product/4800
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/adafruit_metro_esp32s2/board.h b/hw/bsp/espressif/boards/adafruit_metro_esp32s2/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Adafruit Metro ESP32-S2
+   url: https://www.adafruit.com/product/4775
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_addax_1/board.h b/hw/bsp/espressif/boards/espressif_addax_1/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif Addax-1
+   url: n/a
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_c3_devkitc/board.h b/hw/bsp/espressif/boards/espressif_c3_devkitc/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif C3 DevKitC
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c3/esp32-c3-devkitc-02/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_c6_devkitc/board.h b/hw/bsp/espressif/boards/espressif_c6_devkitc/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif C6 DevKitC
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_kaluga_1/board.h b/hw/bsp/espressif/boards/espressif_kaluga_1/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif Kaluga 1
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-kaluga-1/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_p4_function_ev/board.h b/hw/bsp/espressif/boards/espressif_p4_function_ev/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif P4 Function EV
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32p4/esp32-p4-function-ev-board/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_s2_devkitc/board.h b/hw/bsp/espressif/boards/espressif_s2_devkitc/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif S2 DevKitC
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-devkitc-1/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_s3_devkitc/board.h b/hw/bsp/espressif/boards/espressif_s3_devkitc/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif S3 DevKitC
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitc-1/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 

diff --git a/hw/bsp/espressif/boards/espressif_s3_devkitm/board.h b/hw/bsp/espressif/boards/espressif_s3_devkitm/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: Espresif S3 DevKitM
+   url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitm-1/index.html
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_