doc: add field 'Constraints' to 'boards.yaml'

trabucayre · Jan 12, 2022 · 1e0fcfb · 1e0fcfb
1 parent 02ba4df
commit 1e0fcfb
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/doc/boards.py b/doc/boards.py
@@ -15,6 +15,7 @@ class Board:
     FPGA: str = None
     Memory: str = None
     Flash: str = None
+    Constraints: str = None
 
 
 def ReadDataFromYAML():
@@ -24,16 +25,24 @@ def ReadDataFromYAML():
 
 
 def DataToTable(data, tablefmt: str = "rst"):
+    def processConstraints(constraints):
+        if constraints is None:
+            return None
+        if isinstance(constraints, str):
+            constraints = [constraints]
+        return " ".join([f":ref:`{item} ➚ <constraints:boards:{item.lower()}>`" for item in constraints])
+
     return tabulate(
         [
             [
                 item.ID,
                 f"`{item.Description} <{item.URL}>`__",
                 item.FPGA,
                 item.Memory,
-                item.Flash
+                item.Flash,
+                processConstraints(item.Constraints)
             ] for item in data
         ],
-        headers=["Board name", "Description", "FPGA", "Memory", "Flash"],
+        headers=["Board name", "Description", "FPGA", "Memory", "Flash", "Constraints"],
         tablefmt=tablefmt
     )
diff --git a/doc/boards.yml b/doc/boards.yml
@@ -18,27 +18,31 @@
   FPGA: Artix xc7a35ticsg324
   Memory: OK
   Flash: OK
+  Constraints: Arty-A7-35T
 
 - ID: arty_a7_100t
   Description: Digilent Arty A7
   URL: https://reference.digilentinc.com/reference/programmable-logic/arty-a7/start
   FPGA: Artix xc7a100tcsg324
   Memory: OK
   Flash: OK
+  Constraints: Arty-A7-100T
 
 - ID: arty_s7_25
   Description: Digilent Arty S7
   URL: https://reference.digilentinc.com/reference/programmable-logic/arty-s7/start
   FPGA: Spartan7 xc7s25csga324
   Memory: OK
   Flash: OK
+  Constraints: Arty-S7-25
 
 - ID: arty_s7_50
   Description: Digilent Arty S7
   URL: https://reference.digilentinc.com/reference/programmable-logic/arty-s7/start
   FPGA: Spartan7 xc7s50csga324
   Memory: OK
   Flash: OK
+  Constraints: Arty-S7-50
 
 - ID: arty_z7_10
   Description: Digilent Arty S7
@@ -191,55 +195,65 @@
   FPGA: iCE40UltraPlus UP5K
   Memory: NA
   Flash: AS
+  Constraints: iCEBreaker
 
 - ID: icebreaker-bitsy
   Description: iCEBreaker-bitsy
   URL: https://1bitsquared.com/collections/fpga/products/icebreaker-bitsy
   FPGA: iCE40UltraPlus UP5K
   Memory: NA
   Flash: OK
+  Constraints:
+    - iCEBreaker-bitsy-v0
+    - iCEBreaker-bitsy-v1
 
 - ID: ice40_generic
   Description: icestick
   URL: https://www.latticesemi.com/icestick
   FPGA: iCE40 HX1k
   Memory: NA
   Flash: AS
+  Constraints: IceStick
 
 - ID: ice40_generic
   Description: iCE40-HX8K
   URL: https://www.latticesemi.com/Products/DevelopmentBoardsAndKits/iCE40HX8KBreakoutBoard.aspx
   FPGA: iCE40 HX8k
   Memory: NT
   Flash: AS
+  Constraints: iCE40-HX8K
 
 - ID: ice40_generic
   Description: Olimex iCE40HX1K-EVB
   URL: https://www.olimex.com/Products/FPGA/iCE40/iCE40HX1K-EVB/open-source-hardware
   FPGA: iCE40 HX1k
   Memory: NT
   Flash: AS
+  Constraints: iCE40HX1K-EVB
 
 - ID: ice40_generic
   Description: Olimex iCE40HX8K-EVB
   URL: https://www.olimex.com/Products/FPGA/iCE40/iCE40HX8K-EVB/open-source-hardware
   FPGA: iCE40 HX8k
   Memory: NT
   Flash: AS
+  Constraints: iCE40HX8K-EVB
 
 - ID: ice40_generic
   Description: Icezum Alhambra II
   URL: https://alhambrabits.com/alhambra
   FPGA: iCE40 HX4k
   Memory: NT
   Flash: AS
+  Constraints: IceZumAlhambraII
 
 - ID: kc705
   Description: Xilinx KC705
   URL: https://www.xilinx.com/products/boards-and-kits/ek-k7-kc705-g.html
   FPGA: Kintex7 xc7k325t
   Memory: OK
   Flash: NT
+  Constraints: KC705
 
 - ID: licheeTang
   Description: Sipeed Lichee Tang
@@ -282,6 +296,7 @@
   FPGA: ECP5 LFE5U-25F-8MG285C
   Memory: OK (JTAG)
   Flash: OK (DFU)
+  Constraints: OrangeCrab-r0.2
 
 - ID: pipistrello
   Description: Saanlima Pipistrello LX45
@@ -351,6 +366,11 @@
   FPGA: ECP5 LFE5U
   Memory: OK
   Flash: OK
+  Constraints:
+    - ULX3S-12F
+    - ULX3S-25F
+    - ULX3S-45F
+    - ULX3S-85F
 
 - ID: ulx3s_dfu
   Description: Radiona ULX3S DFU mode
@@ -400,3 +420,4 @@
   FPGA: zynq7000 xc7z020clg484
   Memory: OK
   Flash: NA
+  Constraints: ZedBoard