Hardware
/
f4pga-examples
mirror of https://github.com/chipsalliance/f4pga-examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #357 from antmicro/umarcor/docs/bump-plugin 

docs/getting: guidelines to bump the yosys plugin moved to conda-eda
This commit is contained in:
Karol Gugala 2022-08-11 16:38:45 +02:00 committed by GitHub
parent 6c979a1a0f 7638f167cd
commit c4da134437
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/getting.rst
View File

@ -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`.