erko_howto_tools.txt

* RadioHDL with GIT (LOFAR2.0)
* Flash and reboot unb2
* Flash and reboot on L2TS using tunnel to SDPTR
* HDL images to keep on dop349
* RadioHDL with SVN (APERTIF/ARTS)
* RadioHDL issues
* ARGS
* GIT workflow
* SVN
* SDP HW tests (SDPTR, upe_gear, tcpdump)
* Confluence
* Polarion
* LaTeX
* Markdown
* Vi
* Remote access
* Remote access using step
* Regression test
* License server
* Screen to run a terminal session without ssh connection
* Quartus Qsys IP files in GIT
* Quartus version
* Quartus issues
* Linux
* ICT diensten
* Python
* Numpy, matplotlib.pyplot
* Jupyter
* Graphana
* Zenodo DOI
* Install OpenSCAD
* Drawio
* DTS-lab unb2c
* Flake8, black
* MATLAB




*******************************************************************************
* RadioHDL with GIT
*******************************************************************************

# Setup vendor specific environment variables in .bashrc

  * bashrc defines root directories that contain one or more versions of tool installations
    - define MENTOR_DIR : modelsim installations
    - define ALTERA_DIR : altera installations

    - LM_LICENSE_FILE=<our_license@our_compagny>

# Setup RadioHDL development environment for hdl/. The hdl/libraries, hdl/boards and hdl/applications are
# developed simultaneously and therefor in one git hdl/ repository

> cd git
  alias initsdp='cd $HOMEDATA/git/hdl;. ./init_hdl.sh;cd ../upe_gear;. ./init_upe.sh;cd ../sdptr;. ./init_sdptr.sh;cd ..'

> cd ~/git/hdl

> . ./init_hdl.sh

  * init_hdl.sh defines:
    - RADIOHDL_WORK directory for where the source code resides
    - HDL_BUILD_DIR directory for where the targets will be build
    - HDL_IOFILE_SIM_DIR=${HDL_BUILD_DIR}/sim for simulating with Modelsim using file IO

  * init_hdl copies git user_components.ipx into Altera dir's
    - cp ${RADIOHDL_WORK}/hdl_user_components.ipx $altera_dir/ip/altera/user_components.ipx

  * init_hdl.sh automatically also sources ../radiohdl/init_radiohdl.sh if necessary
  * init_hdl.sh automatically also sources ../args/init_args.sh if necessary


source also radiohdl tools
. ../radiohdl/init_radiohdl.sh

  * init_radiohdl.sh defines:
    - RADIOHDL_GEAR directory of where the init_radiohdl.sh is located
    - HDL_BUILD_DIR = ${HDL_BUILD_DIR}/build if not already defined
    - RADIOHDL_CONFIG = ${RADIOHDL_GEAR}/config if not already defined

  * init_radiohdl.sh extends:
    - PATH with ${RADIOHDL_GEAR}/core
                ${RADIOHDL_GEAR}/quartus
                ${RADIOHDL_GEAR}/modelsim
    - PYTHONPATH with ${RADIOHDL_GEAR}/core
                      ${RADIOHDL_GEAR}/components


> compile_altera_simlibs unb1   # creates build/unb1/hdl_libraries_ip_stratixiv.txt
                                # creates build/quartus/<tool version> simulation models that need to be moved

> generate_ip_libs unb1         # creates build/unb1/qmegawiz/
                                # creates build/unb1/quartus_sh --> empty dir, why is it there?

> quartus_config unb1           # creates build/unb1/quartus/<hdllib libraries> for synthesis
                                # creates build/unb1/quartus/technology_select_pkg.vhd

> modelsim_config unb1          # creates build/unb1/modelsim/<hdllib libraries> for simulation
                                # creates build/unb1/modelsim/modelsim_project_files.txt for Modelsim commands.do
                                # creates build/unb1/modelsim/technology_select_pkg.vhd

> run_qsys unb1 unb1_minimal_qsys   # creates QSYS block in build/unb1/quartus/unb1_minimal_qsys
> run_qcomp unb1 unb1_minimal_qsys  # creates

> run_modelsim unb1 &

Questasim had Exit code 5 = "Cannot create/open/find/read/write a design library"
during tb simulation load --> fixed by "sudo chmod a+w -R modelsim_altera_libs/18.0".

> run_quartus unb1 &

# Modify QSYS
> quartus_config unb2c
> run_quartus unb2c &
 - Open project
   . for sdp open: lofar2_unb2c_sdp_station_full revision, because mother revision has no qpf
 - Tools/Platform Designer
   . Platform designer system choose qsys from build
 - In system view:
   . remove components
   . add components from Uniboard library (double click avs_common_mm or use green +)
     set parameter g_addr_w for avs_common_mm
     use qsys_unb2c_test_ prefix in component name ip file, but then rename component without prefix in System view window
     for sdp use prefix: qsys_lofar2_unb2c_sdp_station_
   . connect busses via the graphical dots, similar as for other ports
   . use periperal names that match the upe_gear default name + instance scheme
     double click export name to change it, none for default
   . System/assign base addresses
     System/assign interrupt numbers
     if needed do: Sync system infos button at bottom
   . copy component from Generate/Show instance template --> qsys_unb2c_test_pkg.vhd
   . no need to generate HDL
 - Ignore warning about avs_eth_0 IP parameterization
 - File save.
> Copy qsys and ip files to the quartus dir of the mother design.

   board unb2c
   . cp build/unb2c/quartus/unb2c_test_1GbE_I/ip/qsys_unb2c_test/*.ip boards/uniboard2c/designs/unb2c_test/quartus/ip/qsys_unb2c_test/
   . cp build/unb2c/quartus/unb2c_test_1GbE_I/qsys_unb2c_test.qsys boards/uniboard2c/designs/unb2c_test/quartus

   lofar2 unb2c
   . ls -lt build/unb2c/quartus/lofar2_unb2c_sdp_station_full/ip/qsys_lofar2_unb2c_sdp_station/*.ip
   . cp build/unb2c/quartus/lofar2_unb2c_sdp_station_full/ip/qsys_lofar2_unb2c_sdp_station/*.ip applications/lofar2/designs/lofar2_unb2c_sdp_station/quartus/ip/qsys_lofar2_unb2c_sdp_station/
   . cp build/unb2c/quartus/lofar2_unb2c_sdp_station_full/qsys_lofar2_unb2c_sdp_station.qsys applications/lofar2/designs/lofar2_unb2c_sdp_station/quartus

   lofar2 unb2b
   . ls -lt build/unb2b/quartus/lofar2_unb2b_sdp_station_full_wg/ip/qsys_lofar2_unb2b_sdp_station/*.ip
   . cp build/unb2b/quartus/lofar2_unb2b_sdp_station_full_wg/ip/qsys_lofar2_unb2b_sdp_station/*.ip applications/lofar2/designs/lofar2_unb2b_sdp_station/quartus/ip/qsys_lofar2_unb2b_sdp_station/
   . cp build/unb2b/quartus/lofar2_unb2b_sdp_station_full_wg/qsys_lofar2_unb2b_sdp_station.qsys applications/lofar2/designs/lofar2_unb2b_sdp_station/quartus

> Edit the quartus/lofar2_unb2c_sdp_station_ip.tcl to include the new peripheral ip files
> The hdllib.cfg of each revision design will copy the qsys and ip files to each
  revision build quartus dir, so all revisions use the same qsys.

# Run command line synthesis for unb2c_test revision
quartus_config unb2c
run_qsys_pro unb2c unb2c_test_1GbE_I
gen_rom_mmap.py --avalon -d unb2c_test -r unb2c_test_1GbE_I
run_reg unb2c unb2c_test_1GbE_I
run_qcomp unb2c unb2c_test_1GbE_I --clk=CLK
run_rbf unb2c unb2c_test_1GbE_I
==> All in one: build_image unb2c unb2c_test --rev=unb2c_test_1GbE_I --seed=1,2

quartus_config unb2c
run_qsys_pro unb2c unb2c_test_1GbE_II
gen_rom_mmap.py --avalon -d unb2c_test -r unb2c_test_1GbE_II
run_reg unb2c unb2c_test_1GbE_II
run_qcomp unb2c unb2c_test_1GbE_II --clk=CLK
run_rbf unb2c unb2c_test_1GbE_II
==> All in one: build_image unb2c unb2c_test --rev=unb2c_test_1GbE_II --seed=1,2

quartus_config unb2c
run_qsys_pro unb2c unb2c_test_ddr_16G
gen_rom_mmap.py --avalon -d unb2c_test -r unb2c_test_ddr_16G
run_reg unb2c unb2c_test_ddr_16G
run_qcomp unb2c unb2c_test_ddr_16G --clk=CLK
run_rbf unb2c unb2c_test_ddr_16G
==> All in one: build_image unb2c unb2c_test --rev=unb2c_test_ddr_16G --seed=1,2

# Run command line synthesis for dts, l2ts
quartus_config unb2c
run_qsys_pro unb2c lofar2_unb2c_sdp_station_full
gen_rom_mmap.py --avalon -d lofar2_unb2c_sdp_station -r lofar2_unb2c_sdp_station_full
run_reg unb2c lofar2_unb2c_sdp_station_full
run_qcomp unb2c lofar2_unb2c_sdp_station_full --clk=CLK
run_rbf unb2c lofar2_unb2c_sdp_station_full
==> All in one: build_image unb2c lofar2_unb2c_sdp_station --rev=lofar2_unb2c_sdp_station_full --seed=1

# Run command line synthesis for sdp-arts
quartus_config unb2b
run_qsys_pro unb2b lofar2_unb2b_sdp_station_full_wg
gen_rom_mmap.py --avalon -d lofar2_unb2b_sdp_station -r lofar2_unb2b_sdp_station_full_wg
run_reg unb2b lofar2_unb2b_sdp_station_full_wg
run_qcomp unb2b lofar2_unb2b_sdp_station_full_wg --clk=CLK
run_rbf unb2b lofar2_unb2b_sdp_station_full_wg
==> All in one: build_image unb2b lofar2_unb2b_sdp_station --rev=lofar2_unb2b_sdp_station_full_wg --seed=1

> quartus_config unb2b; run_qsys_pro unb2b lofar2_unb2b_sdp_station_full_wg; gen_rom_mmap.py --avalon -d lofar2_unb2b_sdp_station -r lofar2_unb2b_sdp_station_full_wg; run_reg unb2b lofar2_unb2b_sdp_station_full_wg; run_qcomp unb2b lofar2_unb2b_sdp_station_full_wg --clk=CLK; run_rbf unb2b lofar2_unb2b_sdp_station_full_wg