Unify skip and only logic for build scripts

And switch to a single file that can include mcu, family or board.

Author: tannewt

.gitignore

@@ -26,3 +26,5 @@ cov-int
 # cppcheck build directories
 *-build-dir
 /_bin/
+__pycache__
+

examples/device/audio_4_channel_mic/.skip.MCU_SAMD11

@@ -0,0 +1,3 @@
+mcu:SAMD11
+mcu:SAME5X
+mcu:SAMG

examples/device/audio_4_channel_mic/.skip.MCU_SAME5X

@@ -0,0 +1,3 @@
+mcu:SAMD11
+mcu:SAME5X
+mcu:SAMG

examples/device/audio_4_channel_mic/.skip.MCU_SAMG

@@ -0,0 +1 @@
+mcu:SAMD11

examples/device/audio_4_channel_mic/skip.txt

@@ -0,0 +1,10 @@
+mcu:CXD56
+mcu:MSP430x5xx
+mcu:SAMD11
+mcu:VALENTYUSB_EPTRI
+mcu:MKL25ZXX
+mcu:RP2040
+mcu:SAMX7X
+mcu:GD32VF103
+family:broadcom_64bit
+family:broadcom_32bit

examples/device/audio_test/.skip.MCU_SAMD11

@@ -0,0 +1 @@
+mcu:TM4C123

examples/device/audio_test/.skip.MCU_SAME5X

@@ -0,0 +1 @@
+mcu:SAMD11

examples/device/audio_test/.skip.MCU_SAMG

@@ -0,0 +1,9 @@
+mcu:CXD56
+mcu:MSP430x5xx
+mcu:SAMD11
+mcu:VALENTYUSB_EPTRI
+mcu:RP2040
+mcu:SAMX7X
+mcu:GD32VF103
+family:broadcom_64bit
+family:broadcom_32bit

examples/device/audio_test/skip.txt

@@ -0,0 +1,2 @@
+mcu:SAMD11
+mcu:MKL25ZXX

examples/device/cdc_msc/.skip.MCU_SAMD11

@@ -0,0 +1,10 @@
+mcu:LPC11UXX
+mcu:LPC13XX
+mcu:MSP430x5xx
+mcu:NUC121
+mcu:SAMD11
+mcu:STM32L0
+mcu:MKL25ZXX
+family:broadcom_64bit
+family:broadcom_32bit
+board:curiosity_nano

examples/device/cdc_msc/skip.txt

@@ -0,0 +1,6 @@
+mcu:LPC11UXX
+mcu:LPC13XX
+mcu:NUC121
+mcu:SAMD11
+mcu:SAME5X
+mcu:SAMG

examples/device/cdc_msc_freertos/.skip.MCU_BCM2711

@@ -0,0 +1,2 @@
+mcu:MSP430x5xx
+mcu:SAMD11

examples/device/cdc_msc_freertos/.skip.MCU_BCM2835

@@ -0,0 +1,8 @@
+mcu:LPC175X_6X
+mcu:LPC177X_8X
+mcu:LPC18XX
+mcu:LPC40XX
+mcu:LPC43XX
+mcu:MIMXRT10XX
+mcu:RP2040
+mcu:MSP432E4

examples/device/cdc_msc_freertos/.skip.MCU_BCM2837

@@ -0,0 +1,8 @@
+mcu:LPC175X_6X
+mcu:LPC177X_8X
+mcu:LPC18XX
+mcu:LPC40XX
+mcu:LPC43XX
+mcu:MIMXRT10XX
+mcu:RP2040
+mcu:MSP432E4

examples/device/cdc_msc_freertos/.skip.MCU_CXD56

@@ -4,6 +4,8 @@
 import subprocess
 import time
 
+import build_utils
+
 SUCCEEDED = "\033[32msucceeded\033[0m"
 FAILED = "\033[31mfailed\033[0m"
 SKIPPED = "\033[33mskipped\033[0m"
@@ -50,7 +52,7 @@ def build_board(example, board):
     sram_size = "-"
 
     # Check if board is skipped
-    if skip_example(example, board):
+    if build_utils.skip_example(example, board):
         success = SKIPPED
         skip_count += 1
         print(build_format.format(example, board, success, '-', flash_size, sram_size))
@@ -82,33 +84,6 @@ def build_size(example, board):
     sram_size = int(size_list[1]) + int(size_list[2])
     return (flash_size, sram_size)
 
-def skip_example(example, board):
-    ex_dir = 'examples/' + example
-    board_mk = 'hw/bsp/{}/board.mk'.format(board)
-    with open(board_mk) as mk:
-        mk_contents = mk.read()
-
-        # Skip all OPT_MCU_NONE these are WIP port
-        if '-DCFG_TUSB_MCU=OPT_MCU_NONE' in mk_contents:
-            return 1
-
-        # Skip if CFG_TUSB_MCU in board.mk to match skip file
-        for skip_file in glob.iglob(ex_dir + '/.skip.MCU_*'):
-            mcu_cflag = '-DCFG_TUSB_MCU=OPT_' + os.path.basename(skip_file).split('.')[2]
-            if mcu_cflag in mk_contents:
-                return 1
-
-        # Build only list, if exists only these MCU are built
-        only_list = list(glob.iglob(ex_dir + '/.only.MCU_*'))
-        if len(only_list) > 0:
-            for only_file in only_list:
-                mcu_cflag = '-DCFG_TUSB_MCU=OPT_' + os.path.basename(only_file).split('.')[2]
-                if mcu_cflag in mk_contents:
-                    return 0
-            return 1
-
-    return 0
-
 print(build_separator)
 print(build_format.format('Example', 'Board', '\033[39mResult\033[0m', 'Time', 'Flash', 'SRAM'))
 

examples/device/cdc_msc_freertos/.skip.MCU_GD32VF103

@@ -4,6 +4,8 @@
 import subprocess
 import time
 
+import build_utils
+
 SUCCEEDED = "\033[32msucceeded\033[0m"
 FAILED = "\033[31mfailed\033[0m"
 SKIPPED = "\033[33mskipped\033[0m"
@@ -51,7 +53,7 @@ def build_board(example, board):
     sram_size = "-"
 
     # Check if board is skipped
-    if skip_example(example, board):
+    if build_utils.skip_example(example, board):
         success = SKIPPED
         skip_count += 1
         print(build_format.format(example, board, success, '-', flash_size, sram_size))
@@ -83,9 +85,6 @@ def build_size(example, board):
     sram_size = int(size_list[1]) + int(size_list[2])
     return (flash_size, sram_size)
 
-def skip_example(example, board):
-    return 0
-
 print(build_separator)
 print(build_format.format('Example', 'Board', '\033[39mResult\033[0m', 'Time', 'Flash', 'SRAM'))
 print(build_separator)

examples/device/cdc_msc_freertos/.skip.MCU_MKL25ZXX

@@ -4,6 +4,8 @@
 import subprocess
 import time
 
+import build_utils
+
 SUCCEEDED = "\033[32msucceeded\033[0m"
 FAILED = "\033[31mfailed\033[0m"
 SKIPPED = "\033[33mskipped\033[0m"
@@ -62,7 +64,7 @@ def build_board(example, board):
     sram_size = "-"
 
     # Check if board is skipped
-    if skip_example(example, board):
+    if build_utils.skip_example(example, board):
         success = SKIPPED
         skip_count += 1
         print(build_format.format(example, board, success, '-', flash_size, sram_size))
@@ -95,46 +97,6 @@ def build_size(example, board):
     sram_size = int(size_list[1]) + int(size_list[2])
     return (flash_size, sram_size)
 
-def skip_example(example, board):
-    ex_dir = 'examples/' + example
-    
-    # Check if example is skipped by family or board directory
-    skip_file = ".skip." + example.replace('/', '.');
-    if os.path.isfile("hw/bsp/{}/{}".format(family, skip_file)) or os.path.isfile("hw/bsp/{}/boards/{}/{}".format(family, board, skip_file)):
-        return 1
-
-    # Otherwise check if mcu is excluded by example directory
-
-    # family CMake
-    family_mk = 'hw/bsp/{}/family.cmake'.format(family)
-
-    # family.mk
-    if not os.path.exists(family_mk):
-        family_mk = 'hw/bsp/{}/family.mk'.format(family)
-
-    with open(family_mk) as mk:
-        mk_contents = mk.read()
-
-        # Skip all OPT_MCU_NONE these are WIP port
-        if 'CFG_TUSB_MCU=OPT_MCU_NONE' in mk_contents:
-            return 1
-
-        # Skip if CFG_TUSB_MCU in family.mk to match skip file
-        for skip_file in glob.iglob(ex_dir + '/.skip.MCU_*'):
-            mcu_cflag = 'CFG_TUSB_MCU=OPT_' + os.path.basename(skip_file).split('.')[2]
-            if mcu_cflag in mk_contents:
-                return 1
-
-        # Build only list, if exists only these MCU are built
-        only_list = list(glob.iglob(ex_dir + '/.only.MCU_*'))
-        if len(only_list) > 0:
-            for only_file in only_list:
-                mcu_cflag = 'CFG_TUSB_MCU=OPT_' + os.path.basename(only_file).split('.')[2]
-                if mcu_cflag in mk_contents:
-                    return 0
-            return 1
-    return 0
-
 print(build_separator)
 print(build_format.format('Example', 'Board', '\033[39mResult\033[0m', 'Time', 'Flash', 'SRAM'))
 

examples/device/cdc_msc_freertos/.skip.MCU_MSP430x5xx

@@ -0,0 +1,61 @@
+import pathlib
+
+def skip_example(example, board):
+    ex_dir = pathlib.Path('examples/') / example
+    bsp = pathlib.Path("hw/bsp")
+
+    board_dir = list(bsp.glob("*/boards/" + board))
+    if not board_dir:
+        # Skip unknown boards
+        return True
+
+    board_dir = list(board_dir)[0]
+    
+    family_dir = board_dir.parent.parent
+    family = family_dir.name
+
+    # family CMake
+    family_mk = family_dir / "family.cmake"
+
+    # family.mk
+    if not family_mk.exists():
+        family_mk = family_dir / "family.mk"
+
+    mk_contents = family_mk.read_text()
+
+    # Find the mcu
+    if "CFG_TUSB_MCU=OPT_MCU_" not in mk_contents:
+        board_mk = board_dir / "board.cmake"
+        if not board_mk.exists():
+            board_mk = board_dir / "board.mk"
+
+        mk_contents = board_mk.read_text()
+
+    for token in mk_contents.split():
+        if "CFG_TUSB_MCU=OPT_MCU_" in token:
+            # Strip " because cmake files has them.
+            token = token.strip("\"")
+            _, opt_mcu = token.split("=")
+            mcu = opt_mcu[len("OPT_MCU_"):]
+
+    # Skip all OPT_MCU_NONE these are WIP port
+    if mcu == "NONE":
+        return True
+
+    skip_file = ex_dir / "skip.txt"
+    only_file = ex_dir / "only.txt"
+
+    if skip_file.exists() and only_file.exists():
+        raise RuntimeError("Only have a skip or only file. Not both.")
+    elif skip_file.exists():
+        skips = skip_file.read_text().split()
+        return ("mcu:" + mcu in skips or
+                "board:" + board in skips or
+                "family:" + family in skips)
+    elif only_file.exists():
+        onlys = only_file.read_text().split()
+        return not ("mcu:" + mcu in onlys or
+                    "board:" + board in onlys or
+                    "family:" + family in onlys)
+
+    return False