m-labs · Jan 5, 2016 · Jan 5, 2016 · Jan 5, 2016 · Jan 5, 2016
diff --git a/artiq/frontend/artiq_flash.py b/artiq/frontend/artiq_flash.py
@@ -0,0 +1,132 @@
+#!/usr/bin/env python3.5
+# Copyright (C) 2015 Robert Jordens <jordens@gmail.com>
+
+import argparse
+import os
+import subprocess
+import tempfile
+
+import artiq
+from artiq.frontend.bit2bin import bit2bin
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="ARTIQ flashing/deployment tool",
+        epilog="""\
+Valid actions:
+
+    * proxy: load the flash proxy bitstream
+    * bitstream: write bitstream to flash
+    * bios: write bios to flash
+    * runtime: write runtime to flash
+    * storage: write storage image to flash
+    * load: load bitstream into device (volatile but fast)
+    * start: trigger the target to (re)load its bitstream from flash
+
+Prerequisites:
+
+    * Connect the board through its/a JTAG adapter.
+    * Have OpenOCD installed and in your $PATH.
+    * Have access to the JTAG adapter's devices. Udev rules from OpenOCD:
+      'sudo cp openocd/contrib/99-openocd.rules /etc/udev/rules.d'
+      and replug the device. Ensure you are member of the
+      plugdev group: 'sudo adduser $USER plugdev' and re-login.
+    * Make the matching proxy bitstream accessible in ~/.migen or
+      /usr/local/share/migen or /usr/share/migen. Proxy bitstreams are
+      published at https://github.com/jordens/bscan_spi_bitstreams.
+      This script will tell you which one is needed.
+""")
+    parser.add_argument("-t", "--target", default="kc705",
+                        help="target board, default: %(default)s")
+    parser.add_argument("-m", "--adapter", default="qc2",
+                        help="target adapter, default: %(default)s")
+    parser.add_argument("-f", "--storage", help="write file to storage area")
+    parser.add_argument("-d", "--dir", help="look for files in this directory")
+    parser.add_argument("ACTION", nargs="*",
+                        default="proxy bitstream bios runtime start".split(),
+                        help="actions to perform, default: %(default)s")
+    opts = parser.parse_args()
+
+    config = {
+        "kc705": {
+            "chip": "xc7k325t",
+            "start": "xc7_program xc7.tap",
+            "bitstream": 0x000000,
+            "bios": 0xaf0000,
+            "runtime": 0xb00000,
+            "storage": 0xb40000,
+        },
+        "pipistrello": {
+            "chip": "xc6slx45",
+            "start": "xc6s_program xc6s.tap",
+            "bitstream": 0x000000,
+            "bios": 0x170000,
+            "runtime": 0x180000,
+            "storage": 0x1c0000,
+        },
+    }[opts.target]
+
+    if opts.dir is None:
+        opts.dir = os.path.join(os.path.dirname(artiq.__file__), "binaries",
+                                "{}-{}".format(opts.target, opts.adapter))
+
+    conv = False
+
+    prog = []
+    prog.append("init")
+    for action in opts.ACTION:
+        if action == "proxy":
+            proxy_base = "bscan_spi_{}.bit".format(config["chip"])
+            proxy = None
+            for p in [opts.dir, os.path.expanduser("~/.migen"),
+                    "/usr/local/share/migen", "/usr/share/migen"]:
+                proxy_ = os.path.join(p, proxy_base)
+                if os.access(proxy_, os.R_OK):
+                    proxy = "jtagspi_init 0 {}".format(proxy_)
+                    break
+            if not proxy:
+                raise SystemExit(
+                    "proxy bitstream {} not found".format(proxy_base))
+            prog.append(proxy)
+        elif action == "bitstream":
+            bin = os.path.join(opts.dir, "top.bin")
+            if not os.access(bin, os.R_OK):
+                bin = tempfile.mkstemp()[1]
+                bit = os.path.join(opts.dir, "top.bit")
+                conv = True
+            prog.append("jtagspi_program {} 0x{:x}".format(
+                bin, config["bitstream"]))
+        elif action == "bios":
+            prog.append("jtagspi_program {} 0x{:x}".format(
+                os.path.join(opts.dir, "bios.bin"), config["bios"]))
+        elif action == "runtime":
+            prog.append("jtagspi_program {} 0x{:x}".format(
+                os.path.join(opts.dir, "runtime.fbi"), config["runtime"]))
+        elif action == "storage":
+            prog.append("jtagspi_program {} 0x{:x}".format(
+                opts.storage, config["storage"]))
+        elif action == "load":
+            prog.append("pld load 0 {}".format(
+                os.path.join(opts.dir, "top.bit")))
+        elif action == "start":
+            prog.append(config["start"])
+        else:
+            raise ValueError("invalid action", action)
+    prog.append("exit")
+    try:
+        if conv:
+            bit2bin(bit, bin)
+        subprocess.check_call([
+            "openocd",
+            "-f", os.path.join("board", opts.target + ".cfg"),
+            "-c", "; ".join(prog),
+        ])
+    finally:
+        if conv:
+            os.unlink(bin)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/artiq/frontend/artiq_flash.sh b/artiq/frontend/artiq_flash.sh