abdul124/nac3
1
0
Fork 0
forked from M-Labs/nac3
Code Pull Requests Activity
New ARTIQ compiler, third iteration
266 Commits 28 Branches 0 Tags 143 MiB
Rust 89.4%
Python 7.4%
Nix 1.9%
C++ 0.9%
Shell 0.2%
Other 0.2%
4457af7277
Go to file
pca006132 4457af7277 rpc: Fixed alignment problem. 
Fixes issue #42.

Previously there was no fix for the variable alignment.
We calculate the position of the variable based on the size
of the previous variable, so we could break the alignment requirement
for variables. For example, having a `i64` after `bool` could break
the alignment required for `i64` and trigger DataAbort or data
corruption.

However, this requires the same data layout and LLVM type for the
variables. If this cannot be maintained, this would break the alignment
on the other side of the RPC, either from host to kernel or kernel to
host.
2020-07-16 14:06:39 +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 rpc: Fixed alignment problem. 2020-07-16 14:06:39 +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 logger: changed from RefCell to Mutex. 2020-07-15 17:04:16 +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: style 2020-07-11 19:02:37 +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 into the 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.

Configuration

Configuring the device is done using the config.txt text file at the root of the SD card, plus the contents of the config folder. When searching for a configuration key, the firmware first looks for a file named /config/[key].bin and, if it exists, returns the contents of that file. If not, it looks into /config.txt, which contains a list of key=value pairs, one per line. The config folder allows configuration values that consist in binary data, such as the startup kernel.

The following configuration keys are available:

  • mac: Ethernet MAC address.
  • ip: IPv4 address.
  • ip6: IPv6 address.
  • startup: startup kernel in ELF format (as produced by artiq_compile).
  • rtioclk: source of RTIO clock; valid values are external and internal.

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.