Merge branch 'amaranth-lang:main' into main

Author: L0czek

.env.toolchain

@@ -0,0 +1,6 @@
+AMARANTH_USE_YOSYS=builtin
+YOSYS=yowasp-yosys
+NEXTPNR_ICE40=yowasp-nextpnr-ice40
+ICEPACK=yowasp-icepack
+NEXTPNR_ECP5=yowasp-nextpnr-ecp5
+ECPPACK=yowasp-ecppack

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt export-subst

.github/workflows/main.yml

@@ -1,16 +1,60 @@
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 0 * * *' # test daily against git HEAD of dependencies
+
 name: CI
 jobs:
+
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - '3.8'
+        - '3.9'
+        - '3.10'
+        - '3.11'
+        - 'pypy-3.8'
+        - 'pypy-3.9'
+        # this version range needs to be synchronized with the one in pyproject.toml
+        amaranth-version:
+        - '0.4'
+        - 'git'
+        allow-failure:
+        - true
+        - false
+        exclude: # all of these are inverted (this is unfortunately the best way to do this)
+        - amaranth-version: '0.4'
+          allow-failure: false
+        - amaranth-version: 'git'
+          allow-failure: true
+    continue-on-error: '${{ matrix.allow-failure }}'
+    name: "test (${{ matrix.python-version }}, ${{ matrix.amaranth-version }}${{ matrix.allow-failure == 'false' && ', required' || '' }})"
     steps:
       - name: Check out source code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
-      - name: Install dependencies
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Amaranth release
+        if: ${{ matrix.amaranth-version != 'git' }}
         run: |
-          pip install wheel
-      - name: Test
+          pip install 'amaranth[builtin-yosys] ==${{ matrix.amaranth-version }}'
+      - name: Install Amaranth from git
+        if: ${{ matrix.amaranth-version == 'git' }}
         run: |
-          python setup.py test
+          pip install 'amaranth[builtin-yosys] @ git+https://github.com/amaranth-lang/amaranth.git'
+      - name: Run tests
+        run: |
+          python -m unittest discover -t . -s amaranth_boards -p '*.py'
+
+  required: # group all required workflows into one to avoid reconfiguring this in Actions settings
+    needs:
+      - test
+    if: ${{ always() && !contains(needs.*.result, 'cancelled') }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: ${{ contains(needs.*.result, 'failure') && 'false' || 'true' }}

.gitignore

@@ -1,8 +1,13 @@
 # Python
-*.pyc
-/*.egg-info
-/.eggs
+__pycache__/
+*.egg-info
 /dist
 
+# pdm
+/.pdm-plugins
+/.pdm-python
+/.venv
+/pdm.lock
+
 # misc user-created
 /build

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (C) 2019-2021 Amaranth HDL contributors
+Copyright (C) 2019-2023 Amaranth HDL contributors
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

amaranth_boards/__init__.py

@@ -1,9 +1,7 @@
 try:
-    try:
-        from importlib import metadata as importlib_metadata # py3.8+ stdlib
-    except ImportError:
-        import importlib_metadata # py3.7- shim
+    from importlib import metadata as importlib_metadata
     __version__ = importlib_metadata.version(__package__)
+    del importlib_metadata
 except ImportError:
     # No importlib_metadata. This shouldn't normally happen, but some people prefer not installing
     # packages via pip at all, instead using PYTHONPATH directly or copying the package files into

amaranth_boards/alchitry_au.py

@@ -3,7 +3,7 @@
 import shutil
 
 from amaranth.build import *
-from amaranth.vendor.xilinx_7series import *
+from amaranth.vendor import XilinxPlatform
 from .resources import *
 
 
@@ -20,7 +20,7 @@ def find_loader():
     return (loader_prgm, bridge_bin)
 
 
-class AlchitryAuPlatform(Xilinx7SeriesPlatform):
+class AlchitryAuPlatform(XilinxPlatform):
     device      = "XC7A35T" # Artix 7 33K LEs
     package     = "FTG256"
     speed       = "1"

amaranth_boards/arrow_deca.py

@@ -2,7 +2,7 @@
 import subprocess
 
 from amaranth.build import *
-from amaranth.vendor.intel import *
+from amaranth.vendor import IntelPlatform
 from .resources import *
 
 

amaranth_boards/arty_a7.py

@@ -1,15 +1,16 @@
 import os
 import subprocess
+import unittest
 
 from amaranth.build import *
-from amaranth.vendor.xilinx_7series import *
+from amaranth.vendor import XilinxPlatform
 from .resources import *
 
 
 __all__ = ["ArtyA7_35Platform", "ArtyA7_100Platform"]
 
 
-class _ArtyA7Platform(Xilinx7SeriesPlatform):
+class _ArtyA7Platform(XilinxPlatform):
     package     = "csg324"
     speed       = "1L"
     default_clk = "clk100"
@@ -225,6 +226,12 @@ class ArtyA7_100Platform(_ArtyA7Platform):
     device      = "xc7a100ti"
 
 
+class TestCase(unittest.TestCase):
+    def test_smoke(self):
+        from .test.blinky import Blinky
+        ArtyA7_35Platform().build(Blinky(), do_build=False)
+
+
 if __name__ == "__main__":
     from .test.blinky import *
     ArtyA7_35Platform().build(Blinky(), do_program=True)

amaranth_boards/arty_s7.py

@@ -3,14 +3,14 @@
 import subprocess
 
 from amaranth.build import *
-from amaranth.vendor.xilinx_7series import *
+from amaranth.vendor import XilinxPlatform
 from .resources import *
 
 
 __all__ = ["ArtyS7_25Platform", "ArtyS7_50Platform"]
 
 
-class _ArtyS7Platform(Xilinx7SeriesPlatform):
+class _ArtyS7Platform(XilinxPlatform):
     package     = "csga324"
     speed       = "1"
     default_clk = "clk100"

amaranth_boards/arty_z7.py

@@ -2,14 +2,14 @@
 import subprocess
 
 from amaranth.build import *
-from amaranth.vendor.xilinx_7series import *
+from amaranth.vendor import XilinxPlatform
 from .resources import *
 
 
 __all__ = ["ArtyZ720Platform"]
 
 
-class ArtyZ720Platform(Xilinx7SeriesPlatform):
+class ArtyZ720Platform(XilinxPlatform):
     device      = "xc7z020"
     package     = "clg400"
     speed       = "1"

amaranth_boards/atlys.py

@@ -2,14 +2,14 @@
 import textwrap
 
 from amaranth.build import *
-from amaranth.vendor.xilinx_spartan_3_6 import *
+from amaranth.vendor import XilinxPlatform
 from .resources import *
 
 
 __all__ = ["AtlysPlatform"]
 
 
-class AtlysPlatform(XilinxSpartan6Platform):
+class AtlysPlatform(XilinxPlatform):
     """Platform file for Digilent Atlys Spartan 6 board.
     https://reference.digilentinc.com/reference/programmable-logic/atlys/start"""
 

amaranth_boards/blackice.py

@@ -2,7 +2,7 @@
 import subprocess
 
 from amaranth.build import *
-from amaranth.vendor.lattice_ice40 import *
+from amaranth.vendor import LatticeICE40Platform
 from .resources import *
 
 

amaranth_boards/blackice_ii.py

@@ -2,7 +2,7 @@
 import subprocess
 
 from amaranth.build import *
-from amaranth.vendor.lattice_ice40 import *
+from amaranth.vendor import LatticeICE40Platform
 from .resources import *
 
 
@@ -35,7 +35,7 @@ class BlackIceIIPlatform(LatticeICE40Platform):
         ),
 
         SRAMResource(0,
-            cs_n="136", oe_n="29", we_n="120",
+            cs_n="23", oe_n="29", we_n="120",
             a="137 138 139 141 142 42 43 44 73 74 75 76 115 116 117 118 119 78",
             d="136 135 134 130 125 124 122 121 62 61 60 56 55 48 47 45",
             dm_n="24 28",

amaranth_boards/chameleon96.py

@@ -3,7 +3,7 @@
 
 from amaranth import *
 from amaranth.build import *
-from amaranth.vendor.intel import *
+from amaranth.vendor import IntelPlatform
 from .resources import *
 
 

amaranth_boards/cmod_a7.py

@@ -0,0 +1,93 @@
+import os
+import subprocess
+
+from amaranth.build import *
+from amaranth.vendor import XilinxPlatform
+from .resources import *
+
+"""
+Example Usage:
+    platform = CModA7_35Platform(toolchain="Symbiflow")
+    platform.build(Top(), do_program=True)
+
+Supported programmer:
+    openocd
+"""
+
+__all__ = ["CmodA7_15Platform", "CmodA7_35Platform"]
+
+
+class _CmodA7Platform(XilinxPlatform):
+    package     = "cpg236"
+    speed       = "1"
+    default_clk = "clk12"
+    resources   = [
+        Resource("clk12", 0, Pins("L17", dir="i"),
+                 Clock(12e6), Attrs(IOSTANDARD="LVCMOS33")),
+
+        *LEDResources(pins="A17 C16", attrs=Attrs(IOSTANDARD="LVCMOS33")),
+
+        RGBLEDResource(0, r="C17", g="B16", b="B17", invert=True,
+            attrs=Attrs(IOSTANDARD="LVCMOS33")),
+
+        *ButtonResources(pins="A18 B18", attrs=Attrs(IOSTANDARD="LVCMOS33")),
+
+        UARTResource(0,
+            rx="J17", tx="J18",
+            attrs=Attrs(IOSTANDARD="LVCMOS33")
+        ),
+
+        *SPIFlashResources(0,
+            cs_n="K19", clk="E19", copi="D19", cipo="D18", wp_n="G18",
+            hold_n="F18",
+            attrs=Attrs(IOSTANDARD="LVCMOS33")
+        ),
+
+        SRAMResource(0,
+            cs_n="N19", oe_n="P19", we_n="R19",
+            a="M18 M19 K17 N17 P17 P18 R18 W19 U19 V19 W18 T17 T18 U17 U18 V16 W16 W17 V15",
+            d="W15 W13 W14 U15 U16 V13 V14 U14"),
+
+        # One-wire interface to crypto authentication device
+        # May not be populated on the board
+        Resource("atsha204a", 0, Pins("D17", dir="io"),
+            Attrs(IOSTANDARD="LVCMOS33"))
+    ]
+    connectors  = [
+        Connector("pmod", 0, "G17 G19 N18 L18 - - H17 H19 J19 K18 - -"), # JA
+
+        # Pin 24/25 are VCC and GND
+        # Pin 15/16 are analog (XADC)
+        Connector("gpio", 0,
+            """
+            M3  L3 A16  K3 C15  H1 A15 B15 A14  J3  J1  K2
+            L1  L2   -   -  M1  N3  P3  M2  N1  N2  P1   -
+             -  R3  T3  R2  T1  T2  U1  W2  V2  W3  V3  W5
+            V4  U4  V5  W4  U5  U2  W6  U3  U7  W7  U8  V8
+            """),
+
+        Connector("xadc", 0, {
+            "vaux4_n":   "G2",
+            "vaux4_p":   "G3",
+            "vaux12_n":  "J2",
+            "vaux12_p":  "H2"
+        })
+    ]
+
+    def toolchain_program(self, products, name):
+        with products.extract("{}.bit".format(name)) as bitstream_filename:
+            subprocess.check_call(["openFPGALoader",
+                "-b", "cmoda7_35t",
+                "{}".format(bitstream_filename)
+            ])
+
+
+class CmodA7_15Platform(_CmodA7Platform):
+    device      = "xc7a15t"
+
+class CmodA7_35Platform(_CmodA7Platform):
+    device      = "xc7a35t"
+
+if __name__ == "__main__":
+    from .test.blinky import *
+    CmodA7_35Platform().build(Blinky(), do_program=True)