Merge pull request #63 from vkottler/dev/3.3.0

3.3.0 - Add more advanced SVD support

.github/workflows/python-package.yml

@@ -10,6 +10,7 @@ on:
 env:
   TWINE_PASSWORD: ${{secrets.TWINE_PASSWORD}}
   GITHUB_API_TOKEN: ${{secrets.API_TOKEN}}
+  CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
 
 jobs:
   build:
@@ -18,7 +19,6 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.11"
           - "3.12"
         system:
           - ubuntu-latest
@@ -57,29 +57,33 @@ jobs:
 
       - run: mk docs
         if: |
-          matrix.python-version == '3.11'
+          matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
 
       - run: mk python-test
         env:
           PY_TEST_EXTRA_ARGS: --cov-report=xml
 
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v3.1.5
+        with:
+          fail_ci_if_error: true
+          verbose: true
+          token: ${{secrets.CODECOV_TOKEN}}
 
       - run: mk pypi-upload-ci
         env:
           TWINE_USERNAME: __token__
         if: |
-          matrix.python-version == '3.11'
+          matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
           && env.TWINE_PASSWORD != ''
           && github.ref_name == 'master'
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=ifgen version=3.2.1
+                            repo=ifgen version=3.3.0
         if: |
-          matrix.python-version == '3.11'
+          matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
           && env.GITHUB_API_TOKEN != ''
           && github.ref_name == 'master'

.gitignore

@@ -15,3 +15,4 @@ coverage*.xml
 tags
 mklocal
 docs
+src

.pylintrc

@@ -1,6 +1,7 @@
 [DESIGN]
-max-args=8
+max-args=9
 max-attributes=8
+max-locals=17
 
 [MESSAGES CONTROL]
 disable=duplicate-code

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Vaughn Kottler
+Copyright (c) 2024 Vaughn Kottler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=c432187b0744b91a3bf18c6fc28df5eb
+    hash=35493b15233479037424afb95e796e3e
     =====================================
 -->
 
-# ifgen ([3.2.1](https://pypi.org/project/ifgen/))
+# ifgen ([3.3.0](https://pypi.org/project/ifgen/))
 
 [![python](https://img.shields.io/pypi/pyversions/ifgen.svg)](https://pypi.org/project/ifgen/)
 ![Build Status](https://github.com/vkottler/ifgen/workflows/Python%20Package/badge.svg)
@@ -29,7 +29,6 @@
 
 This package is tested with the following Python minor versions:
 
-* [`python3.11`](https://docs.python.org/3.11/)
 * [`python3.12`](https://docs.python.org/3.12/)
 
 ## Platform Support

ifgen/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=302dd11b12a573508cf3316546a384ef
+# hash=bf2c126f5c469e9b0483e934ee695f9e
 # =====================================
 
 """
@@ -10,4 +10,4 @@
 
 DESCRIPTION = "An interface generator for distributed computing."
 PKG_NAME = "ifgen"
-VERSION = "3.2.1"
+VERSION = "3.3.0"

ifgen/commands/gen.py

@@ -5,6 +5,7 @@
 # built-in
 from argparse import ArgumentParser as _ArgumentParser
 from argparse import Namespace as _Namespace
+import sys
 
 # third-party
 from vcorelib.args import CommandFunction as _CommandFunction
@@ -22,6 +23,8 @@ def gen_cmd(args: _Namespace) -> int:
 
     root = normalize(args.root)
 
+    sys.setrecursionlimit(args.recursion)
+
     generate(root.resolve(), load(combine_if_not_absolute(root, args.config)))
 
     return 0
@@ -30,16 +33,25 @@ def gen_cmd(args: _Namespace) -> int:
 def add_gen_cmd(parser: _ArgumentParser) -> _CommandFunction:
     """Add gen-command arguments to its parser."""
 
+    parser.add_argument(
+        "--recursion",
+        type=int,
+        default=10000,
+        help="recursion limit to set (default: '%(default)s')",
+    )
     parser.add_argument(
         "-c",
         "--config",
         default=f"{PKG_NAME}.yaml",
-        help="configuration file to use",
+        help="configuration file to use (default: '%(default)s')",
     )
     parser.add_argument(
         "-r",
         "--root",
         default=".",
-        help="root directory to use for relative paths",
+        help=(
+            "root directory to use for relative "
+            "paths (default: '%(default)s')"
+        ),
     )
     return gen_cmd

ifgen/commands/svd.py

@@ -14,6 +14,7 @@
 
 # internal
 from ifgen import PKG_NAME
+from ifgen.config.svd import SvdConfig
 from ifgen.svd import register_processors
 from ifgen.svd.group import base, enums
 from ifgen.svd.task import SvdProcessingTask
@@ -23,23 +24,26 @@ def svd_cmd(args: _Namespace) -> int:
     """Execute the svd command."""
 
     register_processors()
+    logger = getLogger(__name__)
 
     path = find_file(
-        args.svd_file,
-        package=PKG_NAME,
-        logger=getLogger(__name__),
-        include_cwd=True,
+        args.svd_file, package=PKG_NAME, logger=logger, include_cwd=True
     )
     assert path is not None, args.svd_file
 
-    enable_pruning = path.with_suffix("").name in {"XMC4700"}
+    config = SvdConfig.decode(
+        find_file(args.config, logger=logger, include_cwd=True)
+    )
 
     # Only enable certain pruning strategies for certain processors.
+    enable_pruning = path.with_suffix("").name in config.data.setdefault(
+        "enable_pruning", []
+    )
     enums.PRUNE_ENUMS = enable_pruning
     base.PRUNE_STRUCTS = enable_pruning
 
     SvdProcessingTask.svd(path, args.min_enum_width).generate_configs(
-        args.output
+        args.output, config
     )
 
     return 0
@@ -56,7 +60,17 @@ def add_svd_cmd(parser: _ArgumentParser) -> _CommandFunction:
         "--output",
         type=Path,
         default=f"{PKG_NAME}-out",
-        help="output directory for configuration files",
+        help=(
+            "output directory for configuration "
+            "files (default '%(default)s')"
+        ),
+    )
+
+    parser.add_argument(
+        "-c",
+        "--config",
+        default=f"package://{PKG_NAME}/svd.yaml",
+        help="configuration rules to use (default: '%(default)s')",
     )
 
     parser.add_argument(

ifgen/config/svd.py

@@ -0,0 +1,13 @@
+"""
+A module implementing an SVD-command configuration interface for the package.
+"""
+
+# third-party
+from vcorelib.dict.codec import BasicDictCodec as _BasicDictCodec
+
+# internal
+from ifgen.schemas import IfgenDictCodec
+
+
+class SvdConfig(IfgenDictCodec, _BasicDictCodec):
+    """The top-level configuration object for the package."""

ifgen/data/schemas/SvdConfig.yaml

@@ -0,0 +1,18 @@
+---
+type: object
+additionalProperties: false
+required: []
+
+properties:
+  enable_pruning:
+    type: array
+    default: [XMC4700]
+    items:
+      type: string
+
+  devices:
+    type: object
+    additionalProperties: false
+    patternProperties:
+      "^[a-zA-Z0-9-_.]+$":
+        $ref: package://ifgen/schemas/SvdInstanceConfig.yaml

ifgen/data/schemas/SvdInstanceConfig.yaml

@@ -0,0 +1,18 @@
+---
+type: object
+additionalProperties: false
+required: []
+
+properties:
+  ignore_peripherals:
+    type: array
+    items:
+      type: object
+      additionalProperties: false
+      required: [name, reason]
+
+      properties:
+        name:
+          type: string
+        reason:
+          type: string

ifgen/data/svd.yaml

@@ -0,0 +1,15 @@
+---
+
+# Note: ignored peripherals still get generated YAML outputs, they're just
+# not included in the generated top-level ifgen.yaml.
+
+devices:
+  mimxrt1176_cm4: &rt1176
+    ignore_peripherals:
+      - name: caam
+        reason: Register map not in reference manual / (#64).
+      - name: dcic1
+        reason: (#64) dimIncrement not supported.
+      - name: rdc
+        reason: (#64) dimIncrement not supported.
+  mimxrt1176_cm7: *rt1176

ifgen/dev_requirements.txt

@@ -12,4 +12,4 @@ sphinx-book-theme
 pytest-cov
 setuptools-wrapper
 types-setuptools
-yambs
+yambs>=3.0.4

ifgen/environment/field.py

@@ -31,7 +31,7 @@ def process_field(
         difference = expected - size
 
         assert difference >= 0, (
-            f"({struct_name}.{field_name}) current={size} "
+            f"{difference} ({struct_name}.{field_name}) current={size} "
             f"!= expected={expected}"
         )
 

ifgen/svd/group/enums.py

@@ -144,7 +144,7 @@ def translate_enums(enum: EnumeratedValues) -> EnumValues:
         enum_data: dict[str, Any] = {}
         value.handle_description(enum_data)
 
-        value_str: str = value.raw_data["value"]
+        value_str: str = value.raw_data["value"].lower()
 
         prefix = ""
         for possible_prefix in ("#", "0b", "0x"):
@@ -154,7 +154,7 @@ def translate_enums(enum: EnumeratedValues) -> EnumValues:
 
         if prefix in ("#", "0b"):
             enum_data["value"] = int(
-                value_str[len(prefix) :].replace("X", "1"), 2
+                value_str[len(prefix) :].replace("x", "1"), 2
             )
         elif prefix == "0x":
             enum_data["value"] = int(value_str[len(prefix) :], 16)