M-Labs/artiq-zynq
10
1
Fork 19
Code Issues 12 Pull Requests Releases Wiki Activity
ARTIQ Zynq-based core device support
240 Commits 4 Branches 0 Tags 4.6 MiB
Rust 41.8%
C++ 22.4%
C 22.1%
Python 7.1%
Assembly 2.9%
Other 3.6%
10643d878c
Go to file
Sebastien Bourdeauducq 10643d878c README: fix md syntax
2020-07-11 18:10:25 +08:00
examples Exception handling: Implemented RPC exception. 2020-07-06 15:34:49 +08:00
openocd openocd: remove reference to deleted file 2020-07-06 10:19:22 +08:00
src create gateware folder 2020-07-11 17:49:54 +08:00
.gitignore move build artifacts out of tree 2020-05-07 13:52:40 +08:00
channel-rust-nightly.toml shell.nix: use local channel-rust-nightly.toml 2020-04-11 19:01:42 +08:00
default.nix create gateware folder 2020-07-11 17:49:54 +08:00
local_run.sh local_run: fixed bash opt bug. 2020-07-06 15:15:35 +08:00
mkbootimage.nix add Antmicro Zynq mkbootimage utility 2020-05-01 10:51:13 +08:00
README.md README: fix md syntax 2020-07-11 18:10:25 +08:00
remote_run.sh run scripts: added option to avoid loading bitstream 2020-07-06 11:06:18 +08:00
rustPlatform.nix pure Nix build system 2020-04-30 21:04:28 +08:00
shell.nix shell.nix: add binutils 2020-07-07 19:39:30 +08:00

README.md

ARTIQ on Zynq

How to use

  1. Install ARTIQ-6 or newer.
  2. Select the latest successful build on Hydra: https://nixbld.m-labs.hk/jobset/artiq/zynq
  3. Search for the job named <board>-<variant>-sd (for example: zc706-nist_clock-sd or zc706-nist_qc2-sd).
  4. Download the boot.bin "binary distribution" and place it at the root of a FAT-formatted SD card.
  5. Optionally, create a config.txt configuration file at the root of the SD card containing key=value pairs on each line. Use the ip, ip6 and mac keys to respectively set the IPv4, IPv6 and MAC address of the board. Configuring an IPv6 address is entirely optional. If these keys are not found, the firmware will use default values that may or may not be compatible with your network.
  6. Insert the SD card in the development board and set up the board to boot from the SD card. For the ZC706, this is achieved by placing the large DIP switch SW11 in the 00110 position.
  7. Power up the board. After the firmware starts successfully, it should respond to ping at its IP addresses, and boot messages can be observed from its UART at 115200bps.
  8. Create and use an ARTIQ device database as usual, but set "target": "cortexa9" in the arguments of the core device.

Development instructions

Configure Nix channels:

nix-channel --add https://nixbld.m-labs.hk/channel/custom/artiq/fast-beta/artiq-fast
nix-channel --update

Pure build with Nix and execution on a remote JTAG server:

nix-build -A zc706-simple-jtag  # or zc706-nist_qc2-jtag or zc706-nist_clock-jtag
./remote_run.sh

Impure incremental build and execution on a remote JTAG server:

nix-shell
cd src
gateware/zc706.py -g ../build/gateware  # build gateware
make                                    # build firmware
cd ..
./remote_run.sh -i

Notes:

  • This is known to work with Nixpkgs 20.03 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.
  • If the board is connected to the local machine, use the local_run.sh script.