From 469f168e79ea8e0d9bbd0ac12fa212cfafcb5df8 Mon Sep 17 00:00:00 2001 From: mwojcik Date: Fri, 8 Oct 2021 14:45:50 +0200 Subject: [PATCH] Updated README to include satman information --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 029ff0f..fdae0d7 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Note: if you are using Nix channels the first time, you need to be aware of this Pure build with Nix and execution on a remote JTAG server: ```shell -nix-build -A zc706-nist_clock-jtag # or zc706-nist_qc2-jtag or zc706-nist_clock_satellite-jtag +nix-build -A zc706-nist_clock-jtag # or zc706-nist_qc2-jtag or zc706-nist_clock_satellite-jtag etc. ./remote_run.sh ``` @@ -54,8 +54,8 @@ Impure incremental build and execution on a remote JTAG server: ```shell nix-shell cd src -gateware/zc706.py -g ../build/gateware # build gateware -make # build firmware +gateware/zc706.py -g ../build/gateware -v # build gateware +make GWARGS="-v " # build firmware cd .. ./remote_run.sh -i ``` @@ -64,6 +64,8 @@ Notes: - This is developed with Nixpkgs 21.05, and the ``nixbld.m-labs.hk`` binary substituter can also be used here (see the ARTIQ manual for the public key and instructions). - The impure build process is also compatible with non-Nix systems. +- When calling make, you need to specify both the variant and firmware type. +- Firmware type must be either ``runtime`` for DRTIO-less or DRTIO master variants, or ``satman`` for DRTIO satellite. - If the board is connected to the local machine, use the ``local_run.sh`` script. - To update ``zynq-rs``, update the cargo files as per usual for Rust projects, but also keep ``zynq-rs.nix`` in sync.