From 7638f167cde359bfa7686264653527745df5cfd0 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 9 Aug 2022 13:09:31 +0200 Subject: [PATCH] docs/getting: guidelines to bump the yosys plugin moved to conda-eda Signed-off-by: Unai Martinez-Corral --- docs/getting.rst | 46 +++++----------------------------------------- 1 file changed, 5 insertions(+), 41 deletions(-) diff --git a/docs/getting.rst b/docs/getting.rst index 87b984a..5aefc2e 100644 --- a/docs/getting.rst +++ b/docs/getting.rst @@ -158,44 +158,8 @@ 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: get-utils - - 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 +.. HINT:: + Sometimes it may be preferable to get the latest versions of the tools before the pinned versions in this repository + are updated. + Latest versions *are not guaranteered to be bug free*, but they enable users to take advantage of fixes. + See :ref:`f4pga:GettingStarted:ToolchainInstallation:Conda:Bumping`.