From 85c4719f3372e4f23634366e9b0d717e3d95673e Mon Sep 17 00:00:00 2001
From: Stephan Maka <stephan@spaceboyz.net>
Date: Fri, 28 Aug 2020 00:47:13 +0200
Subject: [PATCH] artiq-board: use new --gateware-identifier-str

---
 artiq-fast/artiq-board.nix               | 30 ++++++++----------------
 artiq-fast/generate-identifier.py        | 24 +++++++++++++++++++
 artiq-fast/scripts/get-identifiers.py    | 24 -------------------
 artiq-fast/scripts/remove-identifiers.py | 16 -------------
 4 files changed, 34 insertions(+), 60 deletions(-)
 create mode 100755 artiq-fast/generate-identifier.py
 delete mode 100644 artiq-fast/scripts/get-identifiers.py
 delete mode 100644 artiq-fast/scripts/remove-identifiers.py

diff --git a/artiq-fast/artiq-board.nix b/artiq-fast/artiq-board.nix
index f6237e8..d2f58f8 100644
--- a/artiq-fast/artiq-board.nix
+++ b/artiq-fast/artiq-board.nix
@@ -59,7 +59,7 @@ let
       name = "${name}-firmware";
       inherit version src;
       phases = [ "buildPhase" "installCheckPhase" "installPhase" "checkPhase" ];
-      buildInputs = [
+      nativeBuildInputs = [
         pkgs.gnumake pkgs.which
         artiqpkgs.cargo
         artiqpkgs.rustc
@@ -73,7 +73,7 @@ let
         ''
         export CARGO_HOME=${cargoVendored}
         export TARGET_AR=or1k-linux-ar
-        ${buildCommand} --no-compile-gateware
+        ${buildCommand} --no-compile-gateware --gateware-identifier-str=unprogrammed
         '';
       installPhase =
         ''
@@ -93,28 +93,18 @@ 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";
-  };
+  identifierStr = "${version};${variant}";
+  identifiers = import (
+    pkgs.runCommandLocal "${name}-identifiers.nix" {
+      buildInputs = [ pkgs.python3 ];
+    } ''python ${./generate-identifier.py} "${identifierStr}" > $out''
+  );
 
   vivadoInputArchive = pkgs.stdenv.mkDerivation {
     name = "${name}-vivado-input.nar.base64";
     buildInputs = [ pkgs.nix ];
     phases = [ "installPhase" ];
-    installPhase = "nix-store --dump ${vivadoInput} | base64 -w0 > $out";
+    installPhase = "nix-store --dump ${boardModule}/src/gateware | base64 -w0 > $out";
   };
 
   # Funnelling the source code through a Nix string allows dropping
@@ -158,7 +148,7 @@ let
         ''
         set_property INIT ${init} [get_cell ${cell}]
         ''
-      ) vivadoIdentifiers) +
+      ) identifiers) +
       ''
       source "top_bitstream.tcl"
       EOF
diff --git a/artiq-fast/generate-identifier.py b/artiq-fast/generate-identifier.py
new file mode 100755
index 0000000..942505b
--- /dev/null
+++ b/artiq-fast/generate-identifier.py
@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+#
+# Encodes data like ARTIQ build_soc.py ReprogrammableIdentifier
+
+import sys
+
+if len(sys.argv) != 2:
+    raise ValueError('argument missing')
+
+identifier_str = sys.argv[1]
+contents = list(identifier_str.encode())
+l = len(contents)
+if l > 255:
+    raise ValueError("Identifier string must be 255 characters or less")
+contents.insert(0, l)
+
+f = sys.stdout
+f.write("[\n");
+for i in range(7):
+    init = sum(1 << j if c & (1 << i) else 0 for j, c in enumerate(contents))
+    f.write(
+        '  {{ cell = "identifier_str{}"; init = "256\'h{:X}"; }}\n'.format(i, init)
+    )
+f.write("]\n");
diff --git a/artiq-fast/scripts/get-identifiers.py b/artiq-fast/scripts/get-identifiers.py
deleted file mode 100644
index 15edea0..0000000
--- a/artiq-fast/scripts/get-identifiers.py
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/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
deleted file mode 100644
index 88156e2..0000000
--- a/artiq-fast/scripts/remove-identifiers.py
+++ /dev/null
@@ -1,16 +0,0 @@
-#!/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)