Add Zephyr port

This port is meant to grow to encompass all existing boards. For
now, it is a port while we transition over.

It is named `zephyr-cp` to differentiate it from the MicroPython
`zephyr` port. They are separate implementations.

Author: tannewt

.github/actions/deps/external/action.yml

@@ -22,7 +22,8 @@ runs:
       if: >-
         inputs.port != 'none' &&
         inputs.port != 'litex' &&
-        inputs.port != 'espressif'
+        inputs.port != 'espressif' &&
+        inputs.port != 'zephyr-cp'
       uses: carlosperate/arm-none-eabi-gcc-action@v1
       with:
         # When changing this update what Windows grabs too!
@@ -51,7 +52,7 @@ runs:
 
     # common
     - name: Cache python dependencies
-      if: inputs.port != 'espressif'
+      if: inputs.port != 'espressif' && inputs.port != 'zephyr-cp'
       uses: ./.github/actions/deps/python
       with:
         action: ${{ inputs.action }}

.github/actions/deps/ports/action.yml

@@ -4,33 +4,29 @@ inputs:
   board:
     required: true
     type: string
-
-outputs:
   port:
-    value: ${{ steps.board-to-port.outputs.port }}
+    required: true
+    type: string
 
 runs:
   using: composite
   steps:
-    - name: Board to port
-      id: board-to-port
-      run: |
-        PORT=$(find ports/*/boards/ -type d -name ${{ inputs.board }} | sed 's/^ports\///g;s/\/boards.*//g')
-        if [ -z $PORT ]; then (exit 1); else echo >> $GITHUB_OUTPUT "port=$PORT"; fi
-      shell: bash
-
     - name: Set up broadcom
-      if: steps.board-to-port.outputs.port == 'broadcom'
+      if: inputs.port == 'broadcom'
       uses: ./.github/actions/deps/ports/broadcom
 
     - name: Set up espressif
-      if: steps.board-to-port.outputs.port == 'espressif'
+      if: inputs.port == 'espressif'
       uses: ./.github/actions/deps/ports/espressif
 
     - name: Set up litex
-      if: steps.board-to-port.outputs.port == 'litex'
+      if: inputs.port == 'litex'
       uses: ./.github/actions/deps/ports/litex
 
     - name: Set up nordic
-      if: steps.board-to-port.outputs.port == 'nordic'
+      if: inputs.port == 'nordic'
       uses: ./.github/actions/deps/ports/nordic
+
+    - name: Set up Zephyr
+      if: inputs.port == 'zephyr-cp'
+      uses: ./.github/actions/deps/ports/zephyr-cp

.github/actions/deps/ports/zephyr-cp/action.yml

@@ -0,0 +1,15 @@
+name: Fetch Zephyr port deps
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Zephyr project
+      uses: zephyrproject-rtos/action-zephyr-setup@v1
+      with:
+        app-path: zephyr-config
+        base-path: ports/zephyr-cp
+        toolchains: arm-zephyr-eabi
+    - name: Export cmake info
+      run: west zephyr-export
+      shell: bash
+      working-directory: ports/zephyr-cp

.github/actions/deps/submodules/action.yml

@@ -80,7 +80,7 @@ runs:
         git fetch --no-recurse-submodules --shallow-since="2021-07-01" origin $GITHUB_SHA
         git repack -d
         echo "::endgroup::"
-        CP_VERSION=$(tools/describe)
+        CP_VERSION=$(python py/version.py)
         echo "$CP_VERSION"
         echo "CP_VERSION=$CP_VERSION" >> $GITHUB_ENV
         echo "cp-version=$CP_VERSION" >> $GITHUB_OUTPUT

.github/workflows/build-board-custom.yml

@@ -97,7 +97,7 @@ jobs:
         download: false
     - name: Versions
       run: |
-        tools/describe
+        python py/version.py
         gcc --version
         python3 --version
         cmake --version || true

.github/workflows/build-boards.yml

@@ -9,6 +9,9 @@ on:
       cp-version:
         required: true
         type: string
+      port:
+        required: true
+        type: string
     secrets:
       AWS_ACCESS_KEY_ID:
         required: false
@@ -43,6 +46,7 @@ jobs:
       uses: ./.github/actions/deps/ports
       with:
         board: ${{ matrix.board }}
+        port: ${{ inputs.port }}
 
     - name: Set up submodules
       id: set-up-submodules
@@ -51,7 +55,7 @@ jobs:
     - name: Set up external
       uses: ./.github/actions/deps/external
       with:
-        port: ${{ steps.set-up-port.outputs.port }}
+        port: ${{ inputs.port }}
     - name: Set up mpy-cross
       if: steps.set-up-submodules.outputs.frozen == 'True'
       uses: ./.github/actions/mpy_cross

.github/workflows/build.yml

@@ -299,6 +299,35 @@ jobs:
     # ERROR: Platform MINGW64_NT-10.0-17763-x86_64 appears to be unsupported
     # https://github.com/espressif/esp-idf/issues/7062
 
+  windows-zephyr:
+    strategy:
+      matrix:
+        os: [windows-2022, windows-2025]
+    runs-on: ${{ matrix.os }}
+    needs: scheduler
+    if: needs.scheduler.outputs.windows == 'True'
+    env:
+      CP_VERSION: ${{ needs.scheduler.outputs.cp-version }}
+    steps:
+    - name: Set up repository
+      uses: actions/checkout@v4
+      with:
+        submodules: false
+        show-progress: false
+        fetch-depth: 1
+        persist-credentials: false
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+    - name: Set up Zephyr
+      uses: ./.github/actions/deps/ports/zephyr-cp
+    - name: Set up submodules
+      uses: ./.github/actions/deps/submodules
+    - name: build mpy-cross
+      run: make -j4 -C mpy-cross
+    - name: build ek_ra8d1
+      run: make -j4 -C ports/zephyr-cp BOARD=renesas_ek_ra8d1
+
   ports:
     needs: [scheduler, mpy-cross, tests]
     if: needs.scheduler.outputs.ports != '{}'
@@ -311,3 +340,4 @@ jobs:
     with:
       boards: ${{ toJSON(fromJSON(needs.scheduler.outputs.ports)[matrix.port]) }}
       cp-version: ${{ needs.scheduler.outputs.cp-version }}
+      port: ${{ matrix.port }}

.pre-commit-config.yaml

@@ -25,7 +25,8 @@ repos:
             tests/unicode/data/utf-8_invalid.txt|
             tests/extmod/data/qr.pgm|
             tests/basics/bytearray_byte_operations.py|
-            ports/raspberrypi/sdk
+            ports/raspberrypi/sdk|
+            ports/zephyr-cp/cptools/compat2driver.py
           )
 -   repo: local
     hooks:

conf.py

@@ -32,8 +32,6 @@
 from sphinx import addnodes
 from sphinx.ext import intersphinx
 
-tools_describe = str(pathlib.Path(__file__).parent / "tools/describe")
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -145,7 +143,7 @@ def autoapi_prepare_jinja_env(jinja_env):
 
 final_version = ""
 git_describe = subprocess.run(
-    [tools_describe],
+    ["python", "py/version.py"],
     stdout=subprocess.PIPE,
     stderr=subprocess.STDOUT,
     encoding="utf-8"

docs/shared_bindings_matrix.py

@@ -26,7 +26,7 @@
 import pathlib
 import re
 import subprocess
-
+import tomllib
 
 from concurrent.futures import ThreadPoolExecutor
 
@@ -43,6 +43,7 @@
     "renode",
     "silabs",
     "stm",
+    "zephyr-cp",
 ]
 
 ALIASES_BY_BOARD = {
@@ -130,21 +131,29 @@ def get_board_mapping():
     boards = {}
     for port in SUPPORTED_PORTS:
         board_path = root_dir / "ports" / port / "boards"
-        for board_path in os.scandir(board_path):
+        # Zephyr port has vendor specific subdirectories to match zephyr (and
+        # clean up the boards folder.)
+        g = "*/*" if port == "zephyr-cp" else "*"
+        for board_path in board_path.glob(g):
             if board_path.is_dir():
                 board_id = board_path.name
+                if port == "zephyr-cp":
+                    vendor = board_path.parent.name
+                    board_id = f"{vendor}_{board_id}"
                 aliases = ALIASES_BY_BOARD.get(board_path.name, [])
                 boards[board_id] = {
                     "port": port,
                     "download_count": 0,
                     "aliases": aliases,
+                    "directory": board_path,
                 }
                 for alias in aliases:
                     boards[alias] = {
                         "port": port,
                         "download_count": 0,
                         "alias": True,
                         "aliases": [],
+                        "directory": board_path,
                     }
     return boards
 
@@ -295,15 +304,6 @@ def lookup_setting(settings, key, default=""):
     return value
 
 
-def all_ports_all_boards(ports=SUPPORTED_PORTS):
-    for port in ports:
-        port_dir = get_circuitpython_root_dir() / "ports" / port
-        for entry in (port_dir / "boards").iterdir():
-            if not entry.is_dir():
-                continue
-            yield (port, entry)
-
-
 def support_matrix_by_board(use_branded_name=True, withurl=True,
                             add_port=False, add_chips=False,
                             add_pins=False, add_branded_name=False):
@@ -313,29 +313,44 @@ def support_matrix_by_board(use_branded_name=True, withurl=True,
     base = build_module_map()
 
     def support_matrix(arg):
-        port, entry = arg
-        port_dir = get_circuitpython_root_dir() / "ports" / port
-        settings = get_settings_from_makefile(str(port_dir), entry.name)
+        board_id, board_info = arg
+        port = board_info["port"]
+        board_directory = board_info["directory"]
+        port_dir = board_directory.parent.parent
+        if port != "zephyr-cp":
+            settings = get_settings_from_makefile(str(port_dir), board_directory.name)
+            autogen_board_info = None
+        else:
+            circuitpython_toml_fn = board_directory / "circuitpython.toml"
+            with circuitpython_toml_fn.open("rb") as f:
+                settings = tomllib.load(f)
+
+            autogen_board_info_fn = board_directory / "autogen_board_info.toml"
+            with autogen_board_info_fn.open("rb") as f:
+                autogen_board_info = tomllib.load(f)
 
         if use_branded_name or add_branded_name:
-            with open(entry / "mpconfigboard.h") as get_name:
-                board_contents = get_name.read()
-            board_name_re = re.search(
-                r"(?<=MICROPY_HW_BOARD_NAME)\s+(.+)", board_contents
-            )
-            if board_name_re:
-                branded_name = board_name_re.group(1).strip('"')
-                if '"' in branded_name:  # sometimes the closing " is not at line end
-                    branded_name = branded_name[:branded_name.index('"')]
-                board_name = branded_name
+            if autogen_board_info:
+                branded_name = autogen_board_info["name"]
+            else:
+                with open(board_directory / "mpconfigboard.h") as get_name:
+                    board_contents = get_name.read()
+                board_name_re = re.search(
+                    r"(?<=MICROPY_HW_BOARD_NAME)\s+(.+)", board_contents
+                )
+                if board_name_re:
+                    branded_name = board_name_re.group(1).strip('"')
+                    if '"' in branded_name:  # sometimes the closing " is not at line end
+                        branded_name = branded_name[:branded_name.index('"')]
+                    board_name = branded_name
 
         if use_branded_name:
             board_name = branded_name
         else:
-            board_name = entry.name
+            board_name = board_directory.name
 
         if add_chips:
-            with open(entry / "mpconfigboard.h") as get_name:
+            with open(board_directory / "mpconfigboard.h") as get_name:
                 board_contents = get_name.read()
             mcu_re = re.search(
                 r'(?<=MICROPY_HW_MCU_NAME)\s+(.+)', board_contents
@@ -346,7 +361,7 @@ def support_matrix(arg):
                     mcu = mcu[:mcu.index('"')]
             else:
                 mcu = ""
-            with open(entry / "mpconfigboard.mk") as get_name:
+            with open(board_directory / "mpconfigboard.mk") as get_name:
                 board_contents = get_name.read()
             flash_re = re.search(
                 r'(?<=EXTERNAL_FLASH_DEVICES)\s+=\s+(.+)', board_contents
@@ -363,7 +378,7 @@ def support_matrix(arg):
         if add_pins:
             pins = []
             try:
-                with open(entry / "pins.c") as get_name:
+                with open(board_directory / "pins.c") as get_name:
                     pin_lines = get_name.readlines()
             except FileNotFoundError:  # silabs boards have no pins.c
                 pass
@@ -376,17 +391,25 @@ def support_matrix(arg):
                         pins.append((board_pin, chip_pin))
 
         board_modules = []
-        for module in base:
-            key = base[module]["key"]
-            if int(lookup_setting(settings, key, "0")):
-                board_modules.append(base[module]["name"])
+        if autogen_board_info:
+            autogen_modules = autogen_board_info["modules"]
+            for k in autogen_modules:
+                if autogen_modules[k]:
+                    board_modules.append(k)
+        else:
+            for module in base:
+                key = base[module]["key"]
+                if int(lookup_setting(settings, key, "0")):
+                    board_modules.append(base[module]["name"])
         board_modules.sort()
 
         if "CIRCUITPY_BUILD_EXTENSIONS" in settings:
-            board_extensions = [
-                extension.strip()
-                for extension in settings["CIRCUITPY_BUILD_EXTENSIONS"].split(",")
-            ]
+            board_extensions = settings["CIRCUITPY_BUILD_EXTENSIONS"]
+            if isinstance(board_extensions, str):
+                board_extensions = [
+                    extension.strip()
+                    for extension in board_extensions.split(",")
+                ]
         else:
             raise OSError(f"Board extensions undefined: {board_name}.")
 
@@ -420,8 +443,8 @@ def support_matrix(arg):
                 board_info
             )
         ]
-        if entry.name in ALIASES_BY_BOARD:
-            for alias in ALIASES_BY_BOARD[entry.name]:
+        if board_id in ALIASES_BY_BOARD:
+            for alias in ALIASES_BY_BOARD[board_id]:
                 if use_branded_name:
                     if alias in ALIASES_BRAND_NAMES:
                         alias = ALIASES_BRAND_NAMES[alias]
@@ -450,8 +473,14 @@ def support_matrix(arg):
 
         return board_matrix  # this is now a list of (board,modules)
 
+
+    board_mapping = get_board_mapping()
+    real_boards = []
+    for board in board_mapping:
+        if not board_mapping[board].get("alias", False):
+            real_boards.append((board, board_mapping[board]))
     executor = ThreadPoolExecutor(max_workers=os.cpu_count())
-    mapped_exec = executor.map(support_matrix, all_ports_all_boards())
+    mapped_exec = executor.map(support_matrix, real_boards)
     # flatmap with comprehensions
     boards = dict(
         sorted(