From 37bbc6843e30878b05ab81d7272d924ac27e8e25 Mon Sep 17 00:00:00 2001 From: Rafal Kapuscik Date: Tue, 21 Jun 2022 14:21:56 +0200 Subject: [PATCH 1/3] Add documentation on updating the plugin manually Signed-off-by: Rafal Kapuscik --- xc7/nightly.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 xc7/nightly.rst diff --git a/xc7/nightly.rst b/xc7/nightly.rst new file mode 100644 index 0000000..a2849bc --- /dev/null +++ b/xc7/nightly.rst @@ -0,0 +1,29 @@ +Obtaining nightly version of the tools +====================================== + +Sometimes it may be preferable to get the latest versions of the tools even beforethe 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 +----------------------------------- + +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 + + wget https://github.com/antmicro/yosys-uhdm-plugin-integration/releases/download/e3a87e3-2022-06-17/yosys-uhdm-plugin-e3a87e3-Ubuntu-20.04-focal-x86_64.tar.gz + tar -xzf yosys-uhdm-plugin-e3a87e3-Ubuntu-20.04-focal-x86_64.tar.gz + +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 From 2170e50abe0010b3cbe3e9d795b8eb901b80832d Mon Sep 17 00:00:00 2001 From: Rafal Kapuscik Date: Tue, 21 Jun 2022 15:34:56 +0200 Subject: [PATCH 2/3] Fix typo, automatically get newest plugin Signed-off-by: Rafal Kapuscik --- xc7/nightly.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/xc7/nightly.rst b/xc7/nightly.rst index a2849bc..d2c8b21 100644 --- a/xc7/nightly.rst +++ b/xc7/nightly.rst @@ -1,11 +1,18 @@ Obtaining nightly version of the tools ====================================== -Sometimes it may be preferable to get the latest versions of the tools even beforethe 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 tools **are not guaranteered to be bug free**, but they enable users to take advantage of the latest fixes available. Updating Yosys SystemVerilog plugin ----------------------------------- +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 @@ -18,8 +25,7 @@ Obtain the latest release of the plugin from `here Date: Mon, 27 Jun 2022 15:19:04 +0200 Subject: [PATCH 3/3] Add warning for Surelog/UHDM version match Signed-off-by: Rafal Kapuscik --- xc7/nightly.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/xc7/nightly.rst b/xc7/nightly.rst index d2c8b21..a7ffc49 100644 --- a/xc7/nightly.rst +++ b/xc7/nightly.rst @@ -6,6 +6,9 @@ Sometimes it may be preferable to get the latest versions of the tools even befo 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