Merge pull request #3194 from hathach/at32-doc

update doc for at32

28 files changed, 68 insertions, 0 deletions

diff --git a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.cmake b/hw/bsp/at32f402_405/boards/at_start_f405/board.cmake
index 0d09680a1..0d09680a1 100644
--- a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.cmake
+++ b/hw/bsp/at32f402_405/boards/at_start_f405/board.cmake
diff --git a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.h b/hw/bsp/at32f402_405/boards/at_start_f405/board.h
index 0061fd242..2d6cc3e57 100644
--- a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.h
+++ b/hw/bsp/at32f402_405/boards/at_start_f405/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F405
+   url: https://www.arterychip.com/en/product/AT32F405.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.mk b/hw/bsp/at32f402_405/boards/at_start_f405/board.mk
index 25a719ccf..25a719ccf 100644
--- a/hw/bsp/at32f402_405/boards/AT_START_F402_405/board.mk
+++ b/hw/bsp/at32f402_405/boards/at_start_f405/board.mk
diff --git a/hw/bsp/at32f402_405/family.c b/hw/bsp/at32f402_405/family.c
index 2dbc538b8..7d94f2564 100644
--- a/hw/bsp/at32f402_405/family.c
+++ b/hw/bsp/at32f402_405/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f402_405_clock.h"
 #include "bsp/board_api.h"
 #include "board.h"
diff --git a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.cmake b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.cmake
index 25c9558f9..25c9558f9 100644
--- a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.cmake
+++ b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.cmake
diff --git a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.h b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.h
index 55d9d05dc..472901cfe 100644
--- a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.h
+++ b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F403a
+   url: https://www.arterychip.com/en/product/AT32F403.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
@@ -37,6 +42,11 @@
 #define LED_STATE_ON          0 // Active Low
 #define LED_GPIO_CLK_EN()     crm_periph_clock_enable(CRM_GPIOD_PERIPH_CLOCK, TRUE)
 
+// #define LED_PORT              GPIOA
+// #define LED_PIN               GPIO_PINS_1
+// #define LED_STATE_ON          0 // Active Low
+// #define LED_GPIO_CLK_EN()     crm_periph_clock_enable(CRM_GPIOA_PERIPH_CLOCK, TRUE)
+
 // Button
 #define BUTTON_PORT           GPIOA
 #define BUTTON_PIN            GPIO_PINS_0
diff --git a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.mk b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.mk
index 9bb6843aa..9bb6843aa 100644
--- a/hw/bsp/at32f403a_407/boards/AT_START_F403A_407/board.mk
+++ b/hw/bsp/at32f403a_407/boards/at_start_f403a/board.mk
diff --git a/hw/bsp/at32f403a_407/family.c b/hw/bsp/at32f403a_407/family.c
index f9a6dd70d..b05a0435f 100644
--- a/hw/bsp/at32f403a_407/family.c
+++ b/hw/bsp/at32f403a_407/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f403a_407_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"
diff --git a/hw/bsp/at32f413/boards/AT_START_F413/board.cmake b/hw/bsp/at32f413/boards/at_start_f413/board.cmake
index 0a9cc4bbd..0a9cc4bbd 100644
--- a/hw/bsp/at32f413/boards/AT_START_F413/board.cmake
+++ b/hw/bsp/at32f413/boards/at_start_f413/board.cmake
diff --git a/hw/bsp/at32f413/boards/AT_START_F413/board.h b/hw/bsp/at32f413/boards/at_start_f413/board.h
index 13ec7a207..4b386a2f4 100644
--- a/hw/bsp/at32f413/boards/AT_START_F413/board.h
+++ b/hw/bsp/at32f413/boards/at_start_f413/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F413
+   url: https://www.arterychip.com/en/product/AT32F413.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f413/boards/AT_START_F413/board.mk b/hw/bsp/at32f413/boards/at_start_f413/board.mk
index 30fc6b9af..30fc6b9af 100644
--- a/hw/bsp/at32f413/boards/AT_START_F413/board.mk
+++ b/hw/bsp/at32f413/boards/at_start_f413/board.mk
diff --git a/hw/bsp/at32f413/family.c b/hw/bsp/at32f413/family.c
index 6e12c6015..bb16d4d5b 100644
--- a/hw/bsp/at32f413/family.c
+++ b/hw/bsp/at32f413/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f413_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"
diff --git a/hw/bsp/at32f415/boards/AT_START_F415/board.cmake b/hw/bsp/at32f415/boards/at_start_f415/board.cmake
index 43fc43a70..43fc43a70 100644
--- a/hw/bsp/at32f415/boards/AT_START_F415/board.cmake
+++ b/hw/bsp/at32f415/boards/at_start_f415/board.cmake
diff --git a/hw/bsp/at32f415/boards/AT_START_F415/board.h b/hw/bsp/at32f415/boards/at_start_f415/board.h
index 8b933f9e9..0464d383e 100644
--- a/hw/bsp/at32f415/boards/AT_START_F415/board.h
+++ b/hw/bsp/at32f415/boards/at_start_f415/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F415
+   url: https://www.arterychip.com/en/product/AT32F415.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f415/boards/AT_START_F415/board.mk b/hw/bsp/at32f415/boards/at_start_f415/board.mk
index 7ea7dc593..7ea7dc593 100644
--- a/hw/bsp/at32f415/boards/AT_START_F415/board.mk
+++ b/hw/bsp/at32f415/boards/at_start_f415/board.mk
diff --git a/hw/bsp/at32f415/family.c b/hw/bsp/at32f415/family.c
index b8ccae97d..381b79eeb 100644
--- a/hw/bsp/at32f415/family.c
+++ b/hw/bsp/at32f415/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f415_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"
diff --git a/hw/bsp/at32f423/boards/AT_START_F423/board.cmake b/hw/bsp/at32f423/boards/at_start_f423/board.cmake
index f97a12194..f97a12194 100644
--- a/hw/bsp/at32f423/boards/AT_START_F423/board.cmake
+++ b/hw/bsp/at32f423/boards/at_start_f423/board.cmake
diff --git a/hw/bsp/at32f423/boards/AT_START_F423/board.h b/hw/bsp/at32f423/boards/at_start_f423/board.h
index fc8e2d8a5..ef85b4977 100644
--- a/hw/bsp/at32f423/boards/AT_START_F423/board.h
+++ b/hw/bsp/at32f423/boards/at_start_f423/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F423
+   url: https://www.arterychip.com/en/product/AT32F423.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f423/boards/AT_START_F423/board.mk b/hw/bsp/at32f423/boards/at_start_f423/board.mk
index f7ef2117d..f7ef2117d 100644
--- a/hw/bsp/at32f423/boards/AT_START_F423/board.mk
+++ b/hw/bsp/at32f423/boards/at_start_f423/board.mk
diff --git a/hw/bsp/at32f423/family.c b/hw/bsp/at32f423/family.c
index 5e9e70dd8..723a8a2c9 100644
--- a/hw/bsp/at32f423/family.c
+++ b/hw/bsp/at32f423/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f423_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"
diff --git a/hw/bsp/at32f425/boards/AT_START_F425/board.cmake b/hw/bsp/at32f425/boards/at_start_f425/board.cmake
index 535bb3cb4..535bb3cb4 100644
--- a/hw/bsp/at32f425/boards/AT_START_F425/board.cmake
+++ b/hw/bsp/at32f425/boards/at_start_f425/board.cmake
diff --git a/hw/bsp/at32f425/boards/AT_START_F425/board.h b/hw/bsp/at32f425/boards/at_start_f425/board.h
index ddfe1f71b..145eab3b9 100644
--- a/hw/bsp/at32f425/boards/AT_START_F425/board.h
+++ b/hw/bsp/at32f425/boards/at_start_f425/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F425
+   url: https://www.arterychip.com/en/product/AT32F425.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f425/boards/AT_START_F425/board.mk b/hw/bsp/at32f425/boards/at_start_f425/board.mk
index f7aeba1db..f7aeba1db 100644
--- a/hw/bsp/at32f425/boards/AT_START_F425/board.mk
+++ b/hw/bsp/at32f425/boards/at_start_f425/board.mk
diff --git a/hw/bsp/at32f425/family.c b/hw/bsp/at32f425/family.c
index 26e69bf31..963e1485f 100644
--- a/hw/bsp/at32f425/family.c
+++ b/hw/bsp/at32f425/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f425_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"
diff --git a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.cmake b/hw/bsp/at32f435_437/boards/at_start_f437/board.cmake
index fc54dbcab..fc54dbcab 100644
--- a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.cmake
+++ b/hw/bsp/at32f435_437/boards/at_start_f437/board.cmake
diff --git a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.h b/hw/bsp/at32f435_437/boards/at_start_f437/board.h
index ef4ec6dcf..b6de119bc 100644
--- a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.h
+++ b/hw/bsp/at32f435_437/boards/at_start_f437/board.h
@@ -24,6 +24,11 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   name: AT-START-F437
+   url: https://www.arterychip.com/en/product/AT32F437.jsp
+*/
+
 #ifndef BOARD_H_
 #define BOARD_H_
 
diff --git a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.mk b/hw/bsp/at32f435_437/boards/at_start_f437/board.mk
index e663d59f0..e663d59f0 100644
--- a/hw/bsp/at32f435_437/boards/AT_START_F435_437/board.mk
+++ b/hw/bsp/at32f435_437/boards/at_start_f437/board.mk
diff --git a/hw/bsp/at32f435_437/family.c b/hw/bsp/at32f435_437/family.c
index c93beeb5a..702fdd2a8 100644
--- a/hw/bsp/at32f435_437/family.c
+++ b/hw/bsp/at32f435_437/family.c
@@ -24,6 +24,10 @@
  * This file is part of the TinyUSB stack.
  */
 
+/* metadata:
+   manufacturer: Artery
+*/
+
 #include "at32f435_437_clock.h"
 #include "board.h"
 #include "bsp/board_api.h"