WIP: Himbächel Gowin support.

.github/workflows/package.yml

@@ -46,6 +46,7 @@ jobs:
           ./package-pypi-machxo2.sh
           ./package-pypi-nexus.sh
           ./package-pypi-gowin.sh
+          ./package-pypi-himbaechel-gowin.sh
       - name: Upload Python artifact
         uses: actions/upload-artifact@v4
         with:
@@ -57,6 +58,7 @@ jobs:
           ./package-npmjs-ecp5.sh
           ./package-npmjs-machxo2.sh
           ./package-npmjs-nexus.sh
+          ./package-npmjs-himbaechel-gowin.sh
       - name: Upload JavaScript artifact
         uses: actions/upload-artifact@v4
         with:
@@ -119,6 +121,11 @@ jobs:
         pip install pypi-gowin/dist/*.whl
         yowasp-nextpnr-gowin --help
         yowasp-nextpnr-gowin --device GW1N-LV1QN48C6/I5 --test
+    - name: Test Himbächel Gowin Python artifact
+      run: |
+        pip install pypi-himbaechel-gowin/dist/*.whl
+        yowasp-nextpnr-himbaechel-gowin --help
+        yowasp-nextpnr-himbaechel-gowin --device GW1NR-LV9QN88PC6/I5 --vopt family=GW1N-9C --test
   check: # group all `test (*)` workflows into one for the required status check
     needs: [test-python]
     if: ${{ always() && !contains(needs.*.result, 'cancelled') }}

README.md

@@ -24,6 +24,8 @@ Notes
 
 For technical reasons, the `ecppack`, `ecpunpack`, `ecpbram`, `ecppll`, and `ecpmulti` tools from the MachXO2 toolchain shipped in the `yowasp-nextpnr-machxo2` PyPI package are installed under the names `yowasp-xo2pack`, `yowasp-xo2unpack`, `yowasp-xo2bram`, `yowasp-xo2pll`, and `yowasp-xo2multi` respectively. These commands run bit-for-bit identical code as their `yowasp-ecp*` prefixed brethren from the `yowasp-nextpnr-ecp5` PyPI package of the same version.
 
+For technical reasons, the `nextpnr-himbaechel` tool is installed under the name `nextpnr-himbaechel-gowin`. Newly added Himbächel microarchitectures will be installed under a correspondingly suffixed name.
+
 
 Versioning
 ----------

build.sh

@@ -134,9 +134,12 @@ cmake -B nextpnr-build -S nextpnr-src \
   -DBUILD_PYTHON=OFF \
   -DEXTERNAL_CHIPDB=ON \
   -DEXTERNAL_CHIPDB_ROOT=/share \
-  -DARCH="ice40;ecp5;machxo2;nexus;gowin" \
+  -DARCH="ice40;ecp5;machxo2;nexus;gowin;himbaechel" \
+  -DHIMBAECHEL_SPLIT=ON \
+  -DHIMBAECHEL_UARCH="gowin" \
   -DICESTORM_INSTALL_PREFIX=$(pwd)/icestorm-prefix \
   -DTRELLIS_INSTALL_PREFIX=$(pwd)/libtrellis-prefix \
   -DOXIDE_INSTALL_PREFIX=$(pwd)/prjoxide-prefix \
-  -DGOWIN_BBA_EXECUTABLE=$(pwd)/apycula-prefix/bin/gowin_bba
+  -DGOWIN_BBA_EXECUTABLE=$(pwd)/apycula-prefix/bin/gowin_bba \
+  -DAPYCULA_INSTALL_PREFIX=$(pwd)/apycula-prefix
 cmake --build nextpnr-build

npmjs-himbaechel-gowin/.gitignore

@@ -0,0 +1,9 @@
+/package-lock.json
+/package.json
+/node_modules
+/dist
+
+/*.wasm
+/gen
+/share
+/index.*

npmjs-himbaechel-gowin/lib/api.d.ts

@@ -0,0 +1,36 @@
+export type Tree = {
+    [name: string]: Tree | string | Uint8Array
+};
+
+export type InputStream =
+    (byteLength: number) => Uint8Array | null;
+
+export type OutputStream =
+    (bytes: Uint8Array | null) => void;
+
+export type RunOptions = {
+    stdin?:  InputStream  | null;
+    stdout?: OutputStream | null;
+    stderr?: OutputStream | null;
+    decodeASCII?: boolean;
+    synchronously?: boolean;
+};
+
+export type Command =
+    (args?: string[], files?: Tree, options?: RunOptions) => Promise<Tree> | Tree | undefined;
+
+export class Exit extends Error {
+    code: number;
+    files: Tree;
+}
+
+//--------8<--------8<--------8<--------8<--------8<--------8<--------8<--------8<--------8<--------
+
+export const runNextpnrHimbaechelGowin: Command;
+
+export const commands: {
+    'gowin_pll': Command,
+    'gowin_pack': Command,
+    'gowin_unpack': Command,
+    'nextpnr-himbaechel-gowin': Command,
+};

npmjs-himbaechel-gowin/lib/api.js

@@ -0,0 +1,27 @@
+import { Application } from '@yowasp/runtime';
+import { instantiate as instantiateNextpnrHimbaechelGowin } from '../gen/nextpnr-himbaechel-gowin.js';
+
+export { Exit } from '@yowasp/runtime';
+
+const resources = () => import('./resources-nextpnr-himbaechel-gowin.js');
+
+const runGowinPll = () => { throw new Error("unimplemented") }; // TODO
+const runGowinPack = () => { throw new Error("unimplemented") }; // TODO
+const runGowinUnpack = () => { throw new Error("unimplemented") }; // TODO
+
+const nextpnrHimbaechelGowin = new Application(resources, instantiateNextpnrHimbaechelGowin, 'yowasp-nextpnr-himbaechel-gowin');
+const runNextpnrHimbaechelGowin = nextpnrHimbaechelGowin.run.bind(nextpnrHimbaechelGowin);
+
+export {
+    runGowinPll,
+    runGowinPack,
+    runGowinUnpack,
+    runNextpnrHimbaechelGowin,
+};
+
+export const commands = {
+    'gowin_pll': runGowinPll,
+    'gowin_pack': runGowinPack,
+    'gowin_unpack': runGowinUnpack,
+    'nextpnr-himbaechel-gowin': runNextpnrHimbaechelGowin,
+};

npmjs-himbaechel-gowin/package-in.json

@@ -0,0 +1 @@
+../npmjs-common/package-in.json

npmjs-himbaechel-gowin/package-local.json

@@ -0,0 +1,7 @@
+{
+    "scripts": {
+        "transpile": [
+            "../nextpnr-build/nextpnr-himbaechel-gowin.wasm"
+        ]
+    }
+}

npmjs-himbaechel-gowin/prepare.py

@@ -0,0 +1 @@
+../npmjs-common/prepare.py

package-npmjs-himbaechel-gowin.sh

@@ -0,0 +1,17 @@
+#!/bin/sh -ex
+
+cd $(dirname $0)
+
+PYTHON=${PYTHON:-python}
+
+mkdir -p npmjs-himbaechel-gowin/share/himbaechel/gowin
+cp nextpnr-build/share/himbaechel/gowin/*.bin \
+   npmjs-himbaechel-gowin/share/himbaechel/gowin
+
+cd npmjs-himbaechel-gowin
+${PYTHON} prepare.py himbaechel-gowin
+npm install
+npm run all
+
+mkdir -p dist
+npm pack --pack-destination dist

package-pypi-himbaechel-gowin.sh

@@ -0,0 +1,16 @@
+#!/bin/sh -ex
+
+PYTHON=${PYTHON:-python}
+
+cd $(dirname $0)
+
+mkdir -p pypi-himbaechel-gowin/yowasp_nextpnr_himbaechel_gowin/bin/
+cp nextpnr-build/nextpnr-himbaechel-gowin.wasm \
+   pypi-himbaechel-gowin/yowasp_nextpnr_himbaechel_gowin/
+mkdir -p pypi-himbaechel-gowin/yowasp_nextpnr_himbaechel_gowin/share/himbaechel/gowin
+cp nextpnr-build/share/himbaechel/gowin/*.bin \
+   pypi-himbaechel-gowin/yowasp_nextpnr_himbaechel_gowin/share/himbaechel/gowin
+
+cd pypi-himbaechel-gowin
+rm -rf build && ${PYTHON} -m build -w
+sha256sum dist/*.whl

pypi-himbaechel-gowin/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+/*.egg-info
+/.eggs
+/build
+/dist
+
+/yowasp_*/share

pypi-himbaechel-gowin/README.md

@@ -0,0 +1 @@
+../README.md

pypi-himbaechel-gowin/dependencies-apycula.txt

@@ -0,0 +1 @@
+../apycula-meta/requirements.txt

pypi-himbaechel-gowin/dependencies.txt

@@ -0,0 +1 @@
+yowasp-runtime~=1.1

pypi-himbaechel-gowin/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools~=67.0", "setuptools_scm~=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+dynamic = ["version", "dependencies"]
+
+name = "yowasp-nextpnr-himbaechel-gowin"
+description = "nextpnr-himbaechel-gowin FPGA place and route tool"
+readme = "README.md"
+authors = [{name = "Catherine", email = "[email protected]"}]
+license = {text = "ISC"}
+classifiers = [
+	"License :: OSI Approved :: ISC License (ISCL)"
+]
+
+[project.scripts]
+yowasp-nextpnr-himbaechel-gowin = "yowasp_nextpnr_himbaechel_gowin:_run_nextpnr_himbaechel_gowin_argv"
+
+[project.urls]
+"Homepage" = "https://yowasp.org/"
+"Source Code" = "https://github.com/YoWASP/nextpnr"
+"Bug Tracker" = "https://github.com/YoWASP/nextpnr/issues"
+
+[tool.setuptools.package-data]
+yowasp_nextpnr_himbaechel_gowin = [
+	"*.wasm",
+	"share/himbaechel/gowin/chipdb-*.bin",
+]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["dependencies.txt", "dependencies-apycula.txt"]}

pypi-himbaechel-gowin/setup.py

@@ -0,0 +1,10 @@
+import os, sys
+sys.path.append(os.path.join(os.path.dirname(__file__), "..", "pypi-common"))
+
+from setuptools import setup
+from yowasp_nextpnr_version import version
+
+
+setup(
+    version=version(),
+)

pypi-himbaechel-gowin/yowasp_nextpnr_himbaechel_gowin/__init__.py

@@ -0,0 +1,11 @@
+import sys
+import yowasp_runtime
+
+
+def run_nextpnr_himbaechel_gowin(argv):
+    return yowasp_runtime.run_wasm(__package__, "nextpnr-himbaechel-gowin.wasm", resources=["share"],
+        argv=["yowasp-nextpnr-himbaechel-gowin", *argv])
+
+
+def _run_nextpnr_himbaechel_gowin_argv():
+    sys.exit(run_nextpnr_himbaechel_gowin(sys.argv[1:]))