[doc] board descriptions: add links to appropriate chipset for each b…

…oard
ebirger · Apr 5, 2016 · f6239c9 · f6239c9
1 parent 7d48258
commit f6239c9
Show file tree

Hide file tree

Showing 19 changed files with 45 additions and 36 deletions.
diff --git a/boards/board.c b/boards/board.c
@@ -85,7 +85,7 @@ extern ili93xx_db_transport_t stm32_fsmc_ili93xx_trns;
 #endif
 
 const board_t board = {
-#define BOARD_START(_desc) .desc = _desc,
+#define BOARD_START(_desc, _chipset) .desc = _desc,
 
 #define DEFAULT_CONSOLE(uart) .default_console_id = uart,
 

diff --git a/boards/cc3200_launchxl.board b/boards/cc3200_launchxl.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("CC3200-LAUNCHXL (CC3200 Connected Launchpad)")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("CC3200-LAUNCHXL (CC3200 Connected Launchpad)", cc3200)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/ek_lm3s6965.board b/boards/ek_lm3s6965.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("EK LM3S6965")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("EK LM3S6965", lm3s6965)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/ek_lm4f120xl.board b/boards/ek_lm4f120xl.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("EK LM4F120XL (Stellaris Launchpad)")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("EK LM4F120XL (Stellaris Launchpad)", lm4f120xl)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/ek_tm4c123gxl.board b/boards/ek_tm4c123gxl.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("EK TM4C123GXL (Tiva C Launchpad)")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("EK TM4C123GXL (Tiva C Launchpad)", tm4c123g)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/ek_tm4c1294xl.board b/boards/ek_tm4c1294xl.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("EK TM4C1294XL (Tiva C Connected Launchpad)")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("EK TM4C1294XL (Tiva C Connected Launchpad)", tm4c1294)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/esp8266.board b/boards/esp8266.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("ESP8266")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("ESP8266", NA)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART0))

diff --git a/boards/frdm_kl25z.board b/boards/frdm_kl25z.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("Freescale FRDM-KL-25Z")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("Freescale FRDM-KL-25Z", frdm_kl25z)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(0))

diff --git a/boards/msp430f5529.board b/boards/msp430f5529.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("TI MSP430F5529")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("TI MSP430F5529", msp430f5529)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USCIA1))

diff --git a/boards/rdk_idm.board b/boards/rdk_idm.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("RDK-IDM (LM3S6918)")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("RDK-IDM (LM3S6918)", lm3s6918)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(UART1))

diff --git a/boards/stm32_armjishu_28.board b/boards/stm32_armjishu_28.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("'ARMJishu' 28'' STM32F103RB based board")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("'ARMJishu' 28'' STM32F103RB based board", stm32f103rbt)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART_PORT1))

diff --git a/boards/stm32_hy_24.board b/boards/stm32_hy_24.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("HY 24'' STM32F103VET6 based board")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("HY 24'' STM32F103VET6 based board", stm32f103vet6)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART_PORT2))

diff --git a/boards/stm32f3discovery.board b/boards/stm32f3discovery.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("STM32F3Discovery")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("STM32F3Discovery", stm32f303xx)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART_PORT2))

diff --git a/boards/stm32f429idiscovery.board b/boards/stm32f429idiscovery.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("STM32F429IDiscovery")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("STM32F429IDiscovery", stm32f429xx)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART_PORT3))

diff --git a/boards/stm32f4discovery.board b/boards/stm32f4discovery.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("STM32F4Discovery")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("STM32F4Discovery", stm32f407xx)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART_PORT2))

diff --git a/boards/trinket_pro.board b/boards/trinket_pro.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("Trinket Pro")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("Trinket Pro", NA)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(USART0))

diff --git a/boards/unix_sim.board b/boards/unix_sim.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("Unix based simulator")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("Unix based simulator", NA)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(STDIO_ID))

diff --git a/boards/x86_sim.board b/boards/x86_sim.board
@@ -1,5 +1,5 @@
-/* BOARD_START(_desc) */
-BOARD_START("X86 based simulator")
+/* BOARD_START(_desc, _chipset) */
+BOARD_START("X86 based simulator", NA)
 
 /* DEFAULT_CONSOLE */
 DEFAULT_CONSOLE(UART_RES(0))

diff --git a/doc/gen_boards_descs.c b/doc/gen_boards_descs.c
@@ -45,6 +45,7 @@ static void print_header(void)
 
 struct board {
     const char *desc;
+    const char *chipset;
     struct res {
         enum res_type {
             RES_NONE = 0,
@@ -104,7 +105,10 @@ struct board {
 #define I2C_RES(res) #res
 #define SPI_RES(res) #res
 
-#define BOARD_START(_desc) { .desc = _desc, .res = (struct res []){
+#define BOARD_START(_desc, _chipset) { \
+    .desc = _desc, \
+    .chipset = #_chipset, \
+    .res = (struct res []){
 #define BOARD_END(...) {} } },
 
 #define DEFAULT_CONSOLE(uart) { \
@@ -278,6 +282,11 @@ static void print_boards(void)
         enum res_type t;
 
         print_section("%s", b->desc);
+        if (strcmp(b->chipset, "NA"))
+        {
+            P("Chipset [%s](/page/chipset_guide.html#%s)\n", b->chipset,
+                b->chipset);
+        }
 
         for (t = RES_NONE + 1; t != RES_LAST; t++)
             print_res_by_type(b->res, t);