From 3879a16e5b39b54bef6c07ded3ceecf41c0767d9 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 28 Jun 2022 14:49:22 +0200 Subject: [PATCH] docs: use openFPGALoader instead of openocd Signed-off-by: Unai Martinez-Corral --- docs/personal-designs.rst | 12 ++++++------ docs/understanding.rst | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/personal-designs.rst b/docs/personal-designs.rst index e93888b..fd7f6f7 100644 --- a/docs/personal-designs.rst +++ b/docs/personal-designs.rst @@ -120,24 +120,24 @@ name you used for your top level module: .. code-block:: bash - openocd -f ${F4PGA_INSTALL_DIR}/${FPGA_FAM}/conda/envs/${FPGA_FAM}/share/openocd/scripts/board/digilent_arty.cfg -c "init; pld load 0 top.bit; exit" + openFPGALoader -b arty_a7_35t top.bit .. tip:: Many of the commands needed to build a project are run multiple times with little to no variation. You might consider adding a few aliases or even a few bash functions to your .bashrc file to save yourself some typing or repeated copy/paste. For example, instead of - using the somewhat cumbersome command used to upload the bitstream to Xilinx 7 series FPGA - every time, you could just add the following lines to your .bashrc file: + using the command used to upload the bitstream to Xilinx 7 series FPGA every time, you + could just add the following lines to your .bashrc file: .. code-block:: bash :name: bash-functions - symbi_bit() { + f4pga_bit() { #Creates and downloads the bitstream to Xilinx 7 series FPGA: - openocd -f /xc7/conda/envs/xc7/share/openocd/scripts/board/digilent_arty.cfg -c "init; pld load 0 top.bit; exit" + openFPGALoader -b $OFL_BOARD top.bit } Now whenever you need to download a bitstream to the Xilinx-7 series you can simply type - ``symbi_bit`` into the terminal and hit enter. + e.g. ``OFL_BOARD=basys3 f4pga_bit`` into the terminal and hit enter. diff --git a/docs/understanding.rst b/docs/understanding.rst index 113906b..17494f7 100644 --- a/docs/understanding.rst +++ b/docs/understanding.rst @@ -175,12 +175,12 @@ family instead of the fabric as in the write_fasm step. .. warning:: If you change the name of the output for your bitstream to something other than top.bit then the - openocd command used in the examples would need to change too. For example if I used - ``-b my_module_top`` in symbiflow_write_bitstream then my openocd command would change to: + openFPGALoader command used in the examples would need to change too. For example if I used + ``-b my_module_top`` in symbiflow_write_bitstream then my openFPGALoader command would change to: .. code-block:: bash - openocd -f /xc7/conda/envs/xc7/share/openocd/scripts/board/digilent_arty.cfg -c "init; pld load 0 my_module_top.bit; exit" + openFPGALoader -b $OFL_BOARD my_module_top.bit Note that the only part of the command that changes is ".bit;"