Add doc directory with the manual

f8eef1b5 · Jorge Machado · f670f838 · f8eef1b5
Commit f8eef1b5 authored Jan 29, 2021 by Jorge Machado
Hide whitespace changes
Inline Side-by-side

Showing with 58 additions and 0 deletions

manual.txt FCWR_tests/sw/doc/manual.txt +58 -0

No files found.
--- a/FCWR_tests/sw/doc/manual.txt
+++ b/FCWR_tests/sw/doc/manual.txt
+The gateware with all the necessary IP cores is included into the BOOT.bin file.
+Once the linux is completely running, the user and pass are the word "root".
+To configure all the devices, run: /wr/fmc_conf.sh
+
+HMC PLL:
+The HMC PLL can be configured though the device tree. Its main VCO is running at 3.0 GHz, and all its channel
+divisors can be modified in the device tree. Also, each channel frequency can be modified at runtime writing the 
+desired frequency in the channel frequency parameter that can be found in a frequency file of the next directory:
+/sys/devices/platform/amba_pl@0/a0010000.axi_quad_spi/spi_master/spi32766/spi32766.0/iio:device1/
+Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/HMC7044.pdf
+Device tree manual: https://wiki.analog.com/resources/tools-software/linux-drivers/iio-pll/hmc7044
+
+For example, to set the channel 5 to 10 MHz:
+echo "10000000" > /sys/devices/platform/amba_pl@0/a0010000.axi_quad_spi/spi_master/spi32766/spi32766.0/iio:device1/out_altvoltage5_10mhz_clk_frequency
+
+Helper oscillator:
+The helper oscillator frequency can be modified writing the desired frequency in the next file:
+/sys/devices/platform/amba_pl@0/a0001000.i2c/i2c-4/4-0067/frequency
+Datasheet: https://www.mouser.es/datasheet/2/368/si549_datasheet-1274151.pdf
+
+For example, to set the oscillator to 45 MHz:
+echo "45000000" > /sys/devices/platform/amba_pl@0/a0001000.i2c/i2c-4/4-0067/frequency
+
+Auxiliary oscillator:
+The auxiliary oscillator frequency can be modified writing the desired frequency in the next file:
+/sys/devices/platform/amba_pl@0/a0002000.i2c/i2c-5/5-0067/frequency
+Datasheet: https://www.mouser.es/datasheet/2/368/si549_datasheet-1274151.pdf
+
+For example, to set the oscillator to 60 MHz:
+echo "60000000" > /sys/devices/platform/amba_pl@0/a0002000.i2c/i2c-5/5-0067/frequency
+
+LMX2594 PLL:
+The LMX2594 PLL can be configured with the lmx2594_programmer tool. The tool needs a register configuration file. 
+The default configuration file must be located in: /wr/lmx2594.conf.
+The configuration file currently located in the /wr/ directory configures the LMX2594 PLL with 10MHz input and 62.5 MHz
+in both outputs.
+To generate a new configuration file, it is necessary to download and install the TICS Pro tool that can be found 
+in the next link: https://www.ti.com/tool/TICSPRO-SW
+Datasheet: https://www.ti.com/lit/ds/symlink/lmx2594.pdf
+
+DAC:
+The example script that configures four different values of the DAC can be found in the next file:
+/wr/dac_sweep.sh
+Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/AD5541A.pdf
+
+
+
+
+All the clocks are routed to the PL PMOD 0 connector of the ZCU board:
+
+Pin 1: HMC channel 0 (ref_clk). Default frequency: 100 MHz
+Pin 3: HMC channel 1 (WR_CLK). Default frequency: 62.5 MHz
+Pin 5: HMC channel 11 (mgt_clk2). Default frequency: 62.5 MHz
+Pin 7: HMC channel 13 (mgt_clk1). Default frequency: 62.5 MHz
+Pin 2: ext_gm_fpga (SMC ref in). Default frequency: 10 MHz
+Pin 4: lmx_gm_clk. Default frequency: 62.5 MHz
+Pin 6: helper DAC. Default frequency: 45 MHz
+Pin 8: aux DAC. Default frequency: 50 MHz
\ No newline at end of file