Skip to content

Commit 6a36c74

Browse files
hathachhathach
committed
embed metadata to family.c and board.h to generate supported boards doc
1 parent 86ad6e5 commit 6a36c74

File tree

247 files changed

+1697
-7
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+1697
-7
lines changed

‎docs/info/changelog.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ General
1717
- Build ARM IAR with CircleCI
1818
- Improve HIL with dual/host_info_to_device_cdc optional for pico/pico2, enable dwc2 dma test
1919

20-
2120
API Changes
2221
-----------
2322

@@ -31,7 +30,6 @@ API Changes
3130
- ``CFG_TUD/TUH_DWC2_SLAVE_ENABLE`` enable dwc2 slave mode
3231
- ``CFG_TUD/TUH_DWC2_DMA_ENABLE`` enable dwc2 dma mode
3332

34-
3533
Controller Driver (DCD & HCD)
3634
-----------------------------
3735

‎docs/reference/boards.rst

Lines changed: 315 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/reference/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ Index
7979
.. toctree::
8080
:maxdepth: 2
8181

82-
supported
8382
getting_started
83+
supported
84+
boards
8485
dependencies
8586
concurrency

‎hw/bsp/broadcom_32bit/boards/raspberrypi_zero/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Raspberry Pi Zero
29+
url: https://www.raspberrypi.org/products/raspberry-pi-zero/
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/broadcom_32bit/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: Raspberry Pi
29+
*/
30+
2731
#include "bsp/board_api.h"
2832
#include "board.h"
2933

‎hw/bsp/broadcom_64bit/boards/raspberrypi_cm4/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Raspberry CM4
29+
url: https://www.raspberrypi.org/products/compute-module-4
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/broadcom_64bit/boards/raspberrypi_zero2/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Raspberry Zero2
29+
url: https://www.raspberrypi.org/products/raspberry-pi-zero-2-w
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/broadcom_64bit/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: Raspberry Pi
29+
*/
30+
2731
#include "bsp/board_api.h"
2832
#include "board.h"
2933

‎hw/bsp/brtmm90x/boards/mm900evxb/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: MM900EVxB
29+
url: https://brtchip.com/product/mm900ev1b
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/brtmm90x/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: Bridgetek
29+
*/
30+
2731
#include "bsp/board_api.h"
2832
#include "board.h"
2933

‎hw/bsp/ch32f20x/boards/ch32f205r-r0/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
* THE SOFTWARE.
2323
*/
2424

25+
/* metadata:
26+
name: CH32F205r-r0
27+
url: https://github.com/openwch/ch32f20x
28+
*/
29+
2530
#ifndef BOARD_H_
2631
#define BOARD_H_
2732

‎hw/bsp/ch32f20x/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: WCH
29+
*/
30+
2731
#include "stdio.h"
2832
#include "debug_uart.h"
2933

‎hw/bsp/ch32v10x/boards/ch32v103r_r1_1v0/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: CH32V103R-R1-1v1
3+
url: https://github.com/openwch/ch32v103/tree/main/SCHPCB/CH32V103R-R1-1v1
4+
*/
5+
16
#ifndef BOARD_H_
27
#define BOARD_H_
38

‎hw/bsp/ch32v10x/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/* metadata:
2+
manufacturer: WCH
3+
*/
4+
15
#include <stdio.h>
26

37
// https://github.com/openwch/ch32v307/pull/90

‎hw/bsp/ch32v20x/boards/ch32v203c_r0_1v0/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: CH32V203C-R0-1v0
3+
url: https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
4+
*/
5+
16
#ifndef BOARD_H_
27
#define BOARD_H_
38

‎hw/bsp/ch32v20x/boards/ch32v203g_r0_1v0/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: CH32V203G-R0-1v0
3+
url: https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
4+
*/
5+
16
#ifndef BOARD_H_
27
#define BOARD_H_
38

‎hw/bsp/ch32v20x/boards/nanoch32v203/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: nanoCH32V203
3+
url: https://github.com/wuxx/nanoCH32V203
4+
*/
5+
16
#ifndef BOARD_H_
27
#define BOARD_H_
38

‎hw/bsp/ch32v20x/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/* metadata:
2+
manufacturer: WCH
3+
*/
4+
15
#include <stdio.h>
26

37
// https://github.com/openwch/ch32v307/pull/90

‎hw/bsp/ch32v307/boards/ch32v307v_r1_1v0/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
* THE SOFTWARE.
2323
*/
2424

25+
/* metadata:
26+
name: CH32V307V-R1-1v0
27+
url: https://github.com/openwch/ch32v307/tree/main/SCHPCB/CH32V307V-R1-1v0
28+
*/
29+
2530
#ifndef BOARD_H_
2631
#define BOARD_H_
2732

‎hw/bsp/ch32v307/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: WCH
29+
*/
30+
2731
#include "stdio.h"
2832

2933
// https://github.com/openwch/ch32v307/pull/90

‎hw/bsp/da1469x/boards/da14695_dk_usb/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: DA14695-00HQDEVKT-U
3+
url: https://www.renesas.com/en/products/wireless-connectivity/bluetooth-low-energy/da14695-00hqdevkt-u-smartbond-da14695-bluetooth-low-energy-52-usb-development-kit
4+
*/
5+
16
#ifndef BOARD_H
27
#define BOARD_H
38

‎hw/bsp/da1469x/boards/da1469x_dk_pro/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/* metadata:
2+
name: DA1469x Development Kit Pro
3+
url: https://lpccs-docs.renesas.com/um-b-090-da1469x_getting_started/DA1469x_The_hardware/DA1469x_The_hardware.html
4+
*/
5+
16
#ifndef BOARD_H
27
#define BOARD_H
38

‎hw/bsp/da1469x/family.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
manufacturer: Renesas
29+
*/
30+
2731
#include "bsp/board_api.h"
2832
#include "board.h"
2933
#include <hal/hal_gpio.h>

‎hw/bsp/espressif/boards/adafruit_feather_esp32_v2/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Adafruit Feather ESP32 v2
29+
url: https://www.adafruit.com/product/5400
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/adafruit_feather_esp32s2/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Adafruit Feather ESP32S2
29+
url: https://www.adafruit.com/product/5000
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/adafruit_feather_esp32s3/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Adafruit Feather ESP32S3
29+
url: https://www.adafruit.com/product/5323
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/adafruit_magtag_29gray/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Adafruit MagTag 2.9" Grayscale
29+
url: https://www.adafruit.com/product/4800
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/adafruit_metro_esp32s2/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Adafruit Metro ESP32-S2
29+
url: https://www.adafruit.com/product/4775
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_addax_1/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif Addax-1
29+
url: n/a
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_c3_devkitc/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif C3 DevKitC
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c3/esp32-c3-devkitc-02/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_c6_devkitc/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif C6 DevKitC
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_kaluga_1/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif Kaluga 1
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-kaluga-1/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_p4_function_ev/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif P4 Function EV
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32p4/esp32-p4-function-ev-board/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_s2_devkitc/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif S2 DevKitC
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-devkitc-1/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_s3_devkitc/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif S3 DevKitC
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitc-1/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

‎hw/bsp/espressif/boards/espressif_s3_devkitm/board.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
* This file is part of the TinyUSB stack.
2525
*/
2626

27+
/* metadata:
28+
name: Espresif S3 DevKitM
29+
url: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitm-1/index.html
30+
*/
31+
2732
#ifndef BOARD_H_
2833
#define BOARD_H_
2934

0 commit comments

Comments
 (0)