scripts: snippets: Add support for board revisions

Allows snippets to specify additional files for specific revisions
of boards

Signed-off-by: Jamie McCrae <[email protected]>

Author: nordicjm

scripts/schemas/snippet-schema.yaml

@@ -46,13 +46,36 @@ properties:
           qemu_cortex_m3:
             append:
               EXTRA_DTC_OVERLAY_FILE: m3.overlay
+
+      Board revisions can also be used which includes additional files:
+        name: foo
+        boards:
+          nrf9160dk/nrf9160:
+            append:
+              # Base file will be applied first
+              EXTRA_DTC_OVERLAY_FILE: first.overlay
+            revisions:
+              "0.7.0":
+                append:
+                  # Will be applied on top of common board file
+                  EXTRA_DTC_OVERLAY_FILE: extra_0_7_0.overlay
     type: object
     patternProperties:
       "(.*)":
         type: object
         properties:
           append:
             include: append-schema
+          revisions:
+            type: object
+            patternProperties:
+              "(.*)":
+                type: object
+                properties:
+                  append:
+                    include: append-schema
+                additionalProperties: false
+          additionalProperties: false
         additionalProperties: false
 required:
   - name

scripts/snippets.py

@@ -31,12 +31,13 @@
 # Marker type for an 'append:' configuration. Maps variables
 # to the list of values to append to them.
 Appends = Dict[str, List[str]]
+BoardRevisionAppends = Dict[str, Dict[str, List[str]]]
 
 def _new_append():
     return defaultdict(list)
 
 def _new_board2appends():
-    return defaultdict(_new_append)
+    return defaultdict(lambda: defaultdict(_new_append))
 
 @dataclass
 class Snippet:
@@ -45,7 +46,7 @@ class Snippet:
 
     name: str
     appends: Appends = field(default_factory=_new_append)
-    board2appends: Dict[str, Appends] = field(default_factory=_new_board2appends)
+    board2appends: Dict[str, BoardRevisionAppends] = field(default_factory=_new_board2appends)
 
     def process_data(self, pathobj: Path, snippet_data: dict, sysbuild: bool):
         '''Process the data in a snippet.yml file, after it is loaded into a
@@ -68,10 +69,16 @@ def append_value(variable, value):
             if board.startswith('/') and not board.endswith('/'):
                 _err(f"snippet file {pathobj}: board {board} starts with '/', so "
                      "it must end with '/' to use a regular expression")
+            for revision, appenddata in settings.get('revisions', {}).items():
+                for variable, value in appenddata.get('append', {}).items():
+                    if (sysbuild is True and variable[0:3] == 'SB_') or \
+                    (sysbuild is False and variable[0:3] != 'SB_'):
+                        self.board2appends[board][revision][variable].append(
+                            append_value(variable, value))
             for variable, value in settings.get('append', {}).items():
                 if (sysbuild is True and variable[0:3] == 'SB_') or \
                 (sysbuild is False and variable[0:3] != 'SB_'):
-                    self.board2appends[board][variable].append(
+                    self.board2appends[board][""][variable].append(
                         append_value(variable, value))
 
 class Snippets(UserDict):
@@ -167,7 +174,18 @@ def print_appends_for_board(self, board: str, appends: Appends):
             self.print(f'''\
 # Appends for board '{board}'
 if("${{BOARD}}${{BOARD_QUALIFIERS}}" STREQUAL "{board}")''')
-        self.print_appends(appends, 1)
+
+        # Output board variables first then board revision variables
+        self.print_appends(appends[""], 1)
+
+        for revision in appends:
+            if revision != "":
+                self.print(f'''\
+  # Appends for revision '{revision}'
+  if("${{BOARD_REVISION}}" STREQUAL "{revision}")''')
+                self.print_appends(appends[revision], 2)
+                self.print('  endif()')
+
         self.print('endif()')
 
     def print_appends(self, appends: Appends, indent: int):