Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs/getting: guidelines to bump the yosys plugin moved to conda-eda #357

Merged
merged 1 commit into from
Aug 11, 2022
Merged

docs/getting: guidelines to bump the yosys plugin moved to conda-eda #357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 5 additions & 41 deletions docs/getting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
.. 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`.