From 2abdefa18760d794ea0c1f2fba65c64a79526511 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Wed, 29 Jun 2022 10:32:36 +0200 Subject: [PATCH] docs: merge 'xc7/nightly' into 'getting' Signed-off-by: Unai Martinez-Corral --- docs/getting.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ xc7/nightly.rst | 38 -------------------------------------- 2 files changed, 42 insertions(+), 38 deletions(-) delete mode 100644 xc7/nightly.rst diff --git a/docs/getting.rst b/docs/getting.rst index 106f6b8..90e9ea7 100644 --- a/docs/getting.rst +++ b/docs/getting.rst @@ -153,3 +153,45 @@ If the above commands exited without errors, you have successfully installed and * Subdir :ghsrc:`xc7` for the Artix-7 devices * Subdir :ghsrc:`eos-s3` for the EOS S3 devices + +Bumping specific tools +====================== + +Sometimes it may be preferable to get the latest versions of the tools even before the full Toolchain is validated and upgraded. +These tools **are not guaranteered to be bug free**, but they enable users to take advantage of the latest fixes available. + +Updating Yosys SystemVerilog plugin +----------------------------------- + +.. Warning:: + The expected usage of the plugin by using the ``read_systemverilog`` command (used by default in F4PGA flow) should work. + When using the plugin by calling ``read_uhdm`` command, take additional care to use the same Surelog and UHDM version for creating and reading the UHDM file - updating only the plugin can create a mismatch in this case. + +Make sure ``curl``, ``jq``, ``tar`` and ``wget`` are installed (used to automatically download newest version): + +.. code-block:: bash + :name: activate-xc7 + + apt install curl jq tar wget + +Activate the conda repository for the correct family: + +.. code-block:: bash + :name: activate-xc7 + + conda activate xc7 + +Obtain the latest release of the plugin from `here `_: + +.. code-block:: bash + :name: get-plugin + + curl https://api.github.com/repos/antmicro/yosys-uhdm-plugin-integration/releases/latest | jq .assets[1] | grep "browser_download_url" | grep -Eo 'https://[^\"]*' | xargs wget -O - | tar -xz + +Install the plugin using provided installation script. +It will use the ``yosys-config`` from conda, so it will install into the conda environment. + +.. code-block:: bash + :name: install-plugin + + ./install-plugin.sh diff --git a/xc7/nightly.rst b/xc7/nightly.rst deleted file mode 100644 index a7ffc49..0000000 --- a/xc7/nightly.rst +++ /dev/null @@ -1,38 +0,0 @@ -Obtaining nightly version of the tools -====================================== - -Sometimes it may be preferable to get the latest versions of the tools even before the full Toolchain is validated and upgraded. These tools **are not guaranteered to be bug free**, but they enable users to take advantage of the latest fixes available. - -Updating Yosys SystemVerilog plugin ------------------------------------ - -**Warning**: the expected usage of the plugin by using the :code:`read_systemverilog` command (used by default in F4PGA flow) should work. When using the plugin by calling :code:`read_uhdm` command, take additional care to use the same Surelog and UHDM version for creating and reading the UHDM file - updating only the plugin can create a mismatch in this case. - - -Make sure :code:`curl`, :code:`jq`, :code:`tar` and :code:`wget` are installed (used to automatically download newest version): - -.. code-block:: bash - :name: activate-xc7 - - apt install curl jq tar wget - -Activate the conda repository for the correct family: - -.. code-block:: bash - :name: activate-xc7 - - conda activate xc7 - -Obtain the latest release of the plugin from `here `_: - -.. code-block:: bash - :name: get-plugin - - curl https://api.github.com/repos/antmicro/yosys-uhdm-plugin-integration/releases/latest | jq .assets[1] | grep "browser_download_url" | grep -Eo 'https://[^\"]*' | xargs wget -O - | tar -xz - -Install the plugin using provided installation script. It will use the `yosys-config` from conda, so it will install into the conda environment. - -.. code-block:: bash - :name: install-plugin - - ./install-plugin.sh