From a30db2ba2e5e227c564df12ecf477748e5c4d0d5 Mon Sep 17 00:00:00 2001
From: Stephan Maka <stephan@spaceboyz.net>
Date: Tue, 25 Aug 2020 01:20:51 +0200
Subject: [PATCH] artiq-board: get/remove/re-add version identifiers

---
 artiq-fast/artiq-board.nix               | 64 ++++++++++++++++++++----
 artiq-fast/scripts/get-identifiers.py    | 24 +++++++++
 artiq-fast/scripts/remove-identifiers.py | 16 ++++++
 3 files changed, 94 insertions(+), 10 deletions(-)
 create mode 100644 artiq-fast/scripts/get-identifiers.py
 create mode 100644 artiq-fast/scripts/remove-identifiers.py

diff --git a/artiq-fast/artiq-board.nix b/artiq-fast/artiq-board.nix
index 69ae67c..f6237e8 100644
--- a/artiq-fast/artiq-board.nix
+++ b/artiq-fast/artiq-board.nix
@@ -52,15 +52,14 @@ let
   name = "artiq-board-${target}-${variant}-${version}";
   installPath = "${pkgs.python3Packages.python.sitePackages}/artiq/board-support/${target}-${variant}";
 
-  boardModule = 
+  boardModule =
     # Board packages are Python modules so that they get added to the ARTIQ Python
     # environment, and artiq_flash finds them.
     pkgs.python3Packages.toPythonModule (pkgs.stdenv.mkDerivation {
       name = "${name}-firmware";
       inherit version src;
       phases = [ "buildPhase" "installCheckPhase" "installPhase" "checkPhase" ];
-      nativeBuildInputs = [
-        vivado
+      buildInputs = [
         pkgs.gnumake pkgs.which
         artiqpkgs.cargo
         artiqpkgs.rustc
@@ -94,11 +93,28 @@ let
         '';
     });
 
+  vivadoIdentifiers = import (pkgs.stdenv.mkDerivation {
+    name = "${name}-vivado-identifiers.nix";
+    src = "${boardModule}/src/gateware";
+    buildInputs = [ pkgs.python ];
+    phases = [ "unpackPhase" "buildPhase" ];
+    buildPhase = "python ${./scripts/get-identifiers.py} top.v > $out";
+  });
+
+  vivadoInput = pkgs.stdenv.mkDerivation {
+    name = "${name}-vivado-input";
+    src = "${boardModule}/src/gateware";
+    buildInputs = [ pkgs.python ];
+    phases = [ "unpackPhase" "patchPhase" "installPhase" ];
+    patchPhase = "python ${./scripts/remove-identifiers.py} top.v";
+    installPhase = "cp -ar . $out";
+  };
+
   vivadoInputArchive = pkgs.stdenv.mkDerivation {
     name = "${name}-vivado-input.nar.base64";
     buildInputs = [ pkgs.nix ];
     phases = [ "installPhase" ];
-    installPhase = "nix-store --dump ${boardModule}/src/gateware | base64 -w0 > $out";
+    installPhase = "nix-store --dump ${vivadoInput} | base64 -w0 > $out";
   };
 
   # Funnelling the source code through a Nix string allows dropping
@@ -110,22 +126,49 @@ let
     ));
 
   # Depends on just Vivado and the generated Bitstream source
-  vivadoOutput = pkgs.stdenvNoCC.mkDerivation {
-    name = builtins.unsafeDiscardStringContext "${name}-vivado-output";
+  vivadoCheckpoint = pkgs.stdenvNoCC.mkDerivation {
+    name = builtins.unsafeDiscardStringContext "${name}-vivado-checkpoint";
 
     unpackPhase = "base64 -d < ${pureVivadoInputArchive} | nix-store --restore gateware";
     buildInputs = [ vivado pkgs.nix ];
     buildPhase = ''
       cd gateware
-      vivado -mode batch -source top.tcl
+      vivado -mode batch -source top_route.tcl
     '';
 
+    installPhase = ''
+      mkdir -p $out
+
+      chmod a+r top_route.dcp
+      cp top_route.dcp $out
+      cp top_bitstream.tcl $out
+    '';
+  };
+
+  vivadoOutput = pkgs.stdenvNoCC.mkDerivation {
+    name = builtins.unsafeDiscardStringContext "${name}-vivado-output";
+    src = vivadoCheckpoint;
+    buildInputs = [ vivado ];
+    buildPhase =
+      ''
+      cat >top.tcl <<EOF
+      open_checkpoint top_route.dcp
+      '' +
+      (pkgs.lib.concatMapStrings ({ cell, init }:
+        ''
+        set_property INIT ${init} [get_cell ${cell}]
+        ''
+      ) vivadoIdentifiers) +
+      ''
+      source "top_bitstream.tcl"
+      EOF
+      vivado -mode batch -source top.tcl
+      '';
     installPhase = ''
       TARGET_DIR=$out/${builtins.unsafeDiscardStringContext installPath}
       mkdir -p $TARGET_DIR
-
       chmod a+r top.bit
-      cp top.bit $TARGET_DIR
+      cp top.bit $TARGET_DIR/
     '';
 
     # temporarily disabled because there is currently always at least one Kasli bitstream
@@ -146,7 +189,8 @@ let
       check_log "Timing constraints are not met\."
     '';
   };
-in pkgs.buildEnv rec {
+in
+pkgs.buildEnv rec {
   inherit name;
   paths = [ boardModule vivadoOutput ];
   pathsToLink = [ "/${installPath}" ];
diff --git a/artiq-fast/scripts/get-identifiers.py b/artiq-fast/scripts/get-identifiers.py
new file mode 100644
index 0000000..15edea0
--- /dev/null
+++ b/artiq-fast/scripts/get-identifiers.py
@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+
+import sys, re
+
+if len(sys.argv) != 2:
+    raise ValueError('Filename argument missing')
+
+filename = sys.argv[1]
+
+with open(filename, 'r') as f:
+    data = f.read()
+
+identifiers = re.findall(r"\.INIT\((\d+'d\d+\)\s*\)\s*identifier_str\d+)", data)
+
+f = sys.stdout
+f.write("[\n")
+for identifier in identifiers:
+    m = re.match(r"(\d+)'d(\d+)\)\s*\)\s*(\S+)", identifier)
+    if m is not None:
+        cell = m.group(3)
+        # the literal must be converted to hex for Vivado Tcl `set_property`
+        init = "{}'h{:X}".format(m.group(1), int(m.group(2)))
+        f.write('    {{ cell = "{}"; init = "{}"; }}\n'.format(cell, init))
+f.write("]\n")
diff --git a/artiq-fast/scripts/remove-identifiers.py b/artiq-fast/scripts/remove-identifiers.py
new file mode 100644
index 0000000..88156e2
--- /dev/null
+++ b/artiq-fast/scripts/remove-identifiers.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+import sys, re
+
+if len(sys.argv) != 2:
+    raise ValueError('Filename argument missing')
+
+filename = sys.argv[1]
+
+with open(filename, 'r') as f:
+    data = f.read()
+
+data = re.sub(r"\.INIT\((\d+'d\d+)\)(\s*)\)(\s*)identifier_str", r".INIT(32'hAAAAAAAA)\2)\3identifier_str", data)
+
+with open(filename, 'w') as f:
+    f.write(data)