Skip to content

Commit

Permalink
docs/getting: guidelines to bump the yosys plugin moved to conda-eda
Browse files Browse the repository at this point in the history
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
  • Loading branch information
umarcor committed Aug 9, 2022
1 parent 6c979a1 commit 5da03c1
Showing 1 changed file with 5 additions and 37 deletions.
42 changes: 5 additions & 37 deletions docs/getting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,41 +161,9 @@ If the above commands exited without errors, you have successfully installed and
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.
Sometimes it may be preferable to get the latest versions of the tools even before the full Toolchain is validated and
upgraded.
These versions *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 <https://github.com/antmicro/yosys-uhdm-plugin-integration/releases>`_:

.. 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
See :doc:`f4pga:GettingStarted:ToolchainInstallation:Conda:Bumping`.

0 comments on commit 5da03c1

Please sign in to comment.