M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 1
Code Issues Projects Releases Wiki Activity

phaser: update README

This commit is contained in:
Robert Jördens 2016-10-12 16:00:46 +02:00
parent 0d1ed247e2
commit 9880b1ebd0
1 changed files with 35 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README_PHASER.rst
View File

@ -3,30 +3,27 @@ ARTIQ Phaser
This ARTIQ branch contains a proof-of-concept design of a GHz-datarate multichannel direct digital synthesizer (DDS) compatible with ARTIQ's RTIO channels. This ARTIQ branch contains a proof-of-concept design of a GHz-datarate multichannel direct digital synthesizer (DDS) compatible with ARTIQ's RTIO channels.
In later developments this proof-of-concept can be expanded to provide a two-tone output with spline modulation and multi-DAC synchronization. In later developments this proof-of-concept can be expanded to provide a two-tone output with spline modulation and multi-DAC synchronization.
Ultimately it will be the basis for the ARTIQ Sayma project. See https://github.com/m-labs/sayma and https://github.com/m-labs/artiq-hardware Ultimately it will be the basis for the ARTIQ Sayma Smart Arbitrary Waveform Generator project. See https://github.com/m-labs/sayma and https://github.com/m-labs/artiq-hardware.
The hardware required is a KC705 with an AD9154-FMC-EBZ plugged into the HPC connector and a low-jitter 2 GHz reference clock. *Features*:
Features:
* 4 channels * 4 channels
* 500 MHz data rate per channel (KC705 limitation) * 500 MHz data rate per channel (KC705 limitation)
* 4x interpolation to 2 GHz DAC sample rate * 4x interpolation to 2 GHz DAC sample rate
* Real-time control over amplitude, frequency, phase through ARTIQ RTIO * Real-time control over amplitude, frequency, phase of each channel through ARTIQ RTIO commands
channels * Full configurability of the AD9154 and AD9516 through SPI with ARTIQ kernel support
* Full configurability of the AD9154 and AD9516 through SPI with ARTIQ kernel
support
* All SPI registers and register bits exposed as human readable names * All SPI registers and register bits exposed as human readable names
* Parametrized JESD204B core (also capable of operation with eight lanes) * Parametrized JESD204B core (also capable of operation with eight lanes)
* The code can be reconfigured, e.g. to support 2 channels at 1 GHz datarate or to support 4 channels at 300 MHz data rate, no interpolation, and using mix mode to stress the second and third Nyquist zones (150-300 MHz and 300-450 MHz). * The code can be reconfigured. Possible example configurations are: support 2 channels at 1 GHz datarate, support 4 channels at 300 MHz data rate, no interpolation, and using mix mode to stress the second and third Nyquist zones (150-300 MHz and 300-450 MHz).
The hardware required to use the ARTIQ phaser branch is a KC705 with an AD9154-FMC-EBZ plugged into the HPC connector and a low-noise 2 GHz reference clock.
This work was supported by the Army Research Lab. This work was supported by the Army Research Lab.
The additions and modifications to ARTIQ that were implemented for this project are: The code that was developed for this project is located in several repositories:
* In ARTIQ, the SAWG and Phaser code: https://github.com/m-labs/artiq/compare/phaser * In ARTIQ, the SAWG and Phaser code: https://github.com/m-labs/artiq/compare/phaser
* The CORDIC core has been reused from the PDQ2 gateware * The CORDIC core has been reused from the PDQ2 gateware https://github.com/m-labs/pdq2
https://github.com/m-labs/pdq2
* The Migen/MiSoC JESD204B core: https://github.com/m-labs/jesd204b * The Migen/MiSoC JESD204B core: https://github.com/m-labs/jesd204b
@ -34,20 +31,10 @@ Installation
------------ ------------
These installation instructions are a short form of those in the ARTIQ manual. These installation instructions are a short form of those in the ARTIQ manual.
Please refer to the manual for more details: Please refer to and follow the ARTIQ manual for more details:
https://m-labs.hk/artiq/manual-release-2/index.html https://m-labs.hk/artiq/manual-release-2/index.html
* Set up a new conda environment and activate it. * Set up a new conda environment and activate it.
* Checkout the ARTIQ phaser branch and the JESD204B core: ::
mkdir ~/src
cd ~/src
git clone --recursive -b phaser https://github.com/m-labs/artiq.git
git clone https://github.com/m-labs/jesd204b.git
cd jesd204b
python setup.py develop
cd ../artiq
* Install the standard ARTIQ runtime/install dependencies. * Install the standard ARTIQ runtime/install dependencies.
See ``conda/artiq/meta.yaml`` for a list. See ``conda/artiq/meta.yaml`` for a list.
They are all packaged as conda packages in ``m-labs/main``. They are all packaged as conda packages in ``m-labs/main``.
@ -60,17 +47,26 @@ https://m-labs.hk/artiq/manual-release-2/index.html
- llvm-or1k - llvm-or1k
- rust-core-or1k - rust-core-or1k
- cargo - cargo
- binutils-or1k-linux >=2.27 - binutils-or1k-linux
* Vivado * Install a recent version of Vivado (tested and developed with 2016.2).
* Checkout the ARTIQ phaser branch and the JESD204B core: ::
Follow the ARTIQ manual's chapter on installing. mkdir ~/src
cd ~/src
git clone --recursive -b phaser https://github.com/m-labs/artiq.git
git clone https://github.com/m-labs/jesd204b.git
cd jesd204b
python setup.py develop
cd ../artiq
python setup.py develop
Setup Setup
----- -----
* Setup the KC705 (VADJ, jumpers, etc.) observing the ARTIQ manual. * Setup the KC705 (jumpers, etc.) observing the ARTIQ manual.
VADJ does not need to be changed.
* On the AD9154-FMC-EBZ put jumpers: * On the AD9154-FMC-EBZ put jumpers:
- on XP1, between pin 5 and 6 (will keep the PIC in reset) - on XP1, between pin 5 and 6 (will keep the PIC in reset)
@ -80,17 +76,17 @@ Setup
python -m artiq.gateware.targets.kc705 -H phaser --toolchain vivado python -m artiq.gateware.targets.kc705 -H phaser --toolchain vivado
* Run the following OpenOCD commands to flash the ARTIQ transmitter design: :: * Run the following OpenOCD command to flash the ARTIQ transmitter design: ::
init openocd -f board/kc705.cfg -c "init; jtagspi_init 0 bscan_spi_xc7k325t.bit; jtagspi_program misoc_phaser_kc705/gateware/top.bin 0x000000; jtagspi_program misoc_phaser_kc705/software/bios/bios.bin 0xaf0000; jtagspi_program misoc_phaser_kc705/software/runtime/runtime.fbi 0xb00000; xc7_program xc7.tap; exit"
jtagspi_init 0 bscan_spi_xc7k325t.bit
jtagspi_program misoc_phaser_kc705/gateware/top.bin 0x000000
jtagspi_program misoc_phaser_kc705/software/bios/bios.bin 0xaf0000
jtagspi_program misoc_phaser_kc705/software/runtime/runtime.fbi 0xb00000
xc7_program xc7.tap
exit
The proxy bitstream ``bscan_spi_xc7k325t.bit`` can be found at https://github.com/jordens/bscan_spi_bitstreams or in any ARTIQ conda package for the KC705. See the source code of ``artiq_flash.py`` from ARTIQ for more details. The proxy bitstream ``bscan_spi_xc7k325t.bit`` can be found at https://github.com/jordens/bscan_spi_bitstreams or in any ARTIQ conda package for the KC705.
See the source code of ``artiq_flash.py`` from ARTIQ for more details.
If you are using the OpenOCD Conda package:
* locate the OpenOCD scripts directory with: ``python3 -c "import artiq.frontend.artiq_flash as af; print(af.scripts_path)"``
* add ``-s <scripts directory>`` to the OpenOCD command line.
* Refer to the ARTIQ documentation to configure an IP address and other settings for the transmitter device. * Refer to the ARTIQ documentation to configure an IP address and other settings for the transmitter device.
If the board was running stock ARTIQ before, the settings will be kept. If the board was running stock ARTIQ before, the settings will be kept.
@ -103,12 +99,11 @@ Usage
----- -----
* An example device database, several status and test scripts are provided in ``artiq/examples/phaser/``. * An example device database, several status and test scripts are provided in ``artiq/examples/phaser/``.
* After each boot, run the ``dac_setup.py`` experiment to establish and align the data link (``artiq_run repository/dac_setup.py``). * After each boot, run the ``dac_setup.py`` experiment to establish the JESD204B links (``artiq_run repository/dac_setup.py``).
* run ``artiq_run repository/sawg.py`` for an example that sets up amplitudes, frequencies, * Run ``artiq_run repository/sawg.py`` for an example that sets up amplitudes, frequencies, and phases on all four DDS channels.
and phases on all four DDS channels.
* Implement your own experiments using the SAWG channels. * Implement your own experiments using the SAWG channels.
* Verify clock stability between the 2 GHz reference clock and the DAC outputs. * Verify clock stability between the 2 GHz reference clock and the DAC outputs.
* Verify phase alignment between the DAC channels. * Verify phase alignment between the DAC channels.
* Changes to the AD9154 configuration can also be performed at runtime in experiments. * Changes to the AD9154 configuration can also be performed at runtime in experiments.
See the example ``startup_kernel.py``. See the example ``dac_setup.py``.
This can e.g. be used to enable and evaluate mix mode without having to change any other code (bitstream/bios/runtime/startup_kernel). This can e.g. be used to enable and evaluate mix mode without having to change any other code (bitstream/bios/runtime/startup_kernel).