vhdl support and configuration page #72

nobodywasishere · 2021-04-18T22:51:05Z

Fixes Support VHDL and mixed language designs #65 by adding VHDL support via GHDL
Adds a page describing different configuration options, and common errors

Currently GHDL / ghdl-yosys-plugin aren't in the conda file / on the conda repository, so that will have to be done before / after this (or added to this) to make sure VHDL can work for anyone. Advice on what to do about this is welcome.

Unfortunately ghdl-yosys-plugin isn't compatible with YoWASP (to the best of my knowledge) so full-fledged Yosys will have to be used for VHDL support. I could be wrong in this though, I haven't looked too much into it.

I tested this with YosysHQ/fpga-toolchain.

mithro · 2021-04-18T22:57:46Z

Hi,

Thank you for sending the pull request! It's awesome to see you contributing to this project. However, before I can look at this request you need to add DCO sign-off to commits in this repository.

We require DCO sign-off for all commits to this repository (including all authors). Please see the following URL to see more information and BeeWare also have a Beginners guide to DCOs.

You can use git commit --amend --signoff and then a git push --force to add the signoff. You can also use git rebase --signoff.

Thanks!

Signed-off-by: Michael Riegert <[email protected]>

mithro · 2021-04-19T01:14:02Z

So the readthedocs build is failing with;

  File "/home/docs/checkouts/readthedocs.org/user_builds/sphinxcontrib-hdl-diagrams/checkouts/72/sphinxcontrib_hdl_diagrams/__init__.py", line 489, in render_diagram_html
    fname, outfn = render_diagram(self, code, options, format, skin, yosys_script)
  File "/home/docs/checkouts/readthedocs.org/user_builds/sphinxcontrib-hdl-diagrams/checkouts/72/sphinxcontrib_hdl_diagrams/__init__.py", line 425, in render_diagram
    vhdl_to_verilog(source_path, ilfn, module, self.builder.config.hdl_diagram_ghdl, yosys)
  File "/home/docs/checkouts/readthedocs.org/user_builds/sphinxcontrib-hdl-diagrams/checkouts/72/sphinxcontrib_hdl_diagrams/__init__.py", line 391, in vhdl_to_verilog
    assert yosys != "yowasp", HDLDiagramError('Cannot use YoWASP for VHDL - GHDL is not compatible with YoWASP')
AssertionError: Cannot use YoWASP for VHDL - GHDL is not compatible with YoWASP

Exception occurred:
  File "/home/docs/checkouts/readthedocs.org/user_builds/sphinxcontrib-hdl-diagrams/checkouts/72/sphinxcontrib_hdl_diagrams/__init__.py", line 391, in vhdl_to_verilog
    assert yosys != "yowasp", HDLDiagramError('Cannot use YoWASP for VHDL - GHDL is not compatible with YoWASP')
AssertionError: Cannot use YoWASP for VHDL - GHDL is not compatible with YoWASP

I think we just need to install the VHDL plugins using conda?

mithro · 2021-04-19T01:15:46Z

There is already a conda package for ghdlsynth at https://github.com/hdl/conda-eda/tree/master/syn

GitHub
hdl/conda-eda
Conda recipes for FPGA EDA tools for simulation, synthesis, place and route and bitstream generation. - hdl/conda-eda

mithro

Generally looks really good!

Just a few small comments.

sphinxcontrib_hdl_diagrams/__init__.py

mithro · 2021-04-19T01:22:06Z

I think we can just add ghdlsynth to https://github.com/SymbiFlow/sphinxcontrib-hdl-diagrams/blob/master/environment.yml#L14 and set the configuration to system rather than yowasp?

GitHub
SymbiFlow/sphinxcontrib-hdl-diagrams
Sphinx Extension which generates various types of diagrams from Verilog code. - SymbiFlow/sphinxcontrib-hdl-diagrams

nobodywasishere · 2021-04-19T02:14:16Z

I think we can just add ghdlsynth to https://github.com/SymbiFlow/sphinxcontrib-hdl-diagrams/blob/master/environment.yml#L14 and set the configuration to system rather than yowasp?

I tried adding it to the environment.yml locally but conda failed to find it, probably because it's not in the repositories. Otherwise, I think that can work. The conda version of yosys doesn't give an error about being unable to load plugins at runtime as well.

GitHub
SymbiFlow/sphinxcontrib-hdl-diagrams
Sphinx Extension which generates various types of diagrams from Verilog code. - SymbiFlow/sphinxcontrib-hdl-diagrams

daniellimws

This is really nice! Just left with fixing the docs before we merge.

umarcor · 2021-04-20T14:20:29Z

FTR, Yosys on Windows does not support loading modules dynamically. They need to be built-in. Therefore, the Conda package is suitable for Linux hosts only. However, GHDL and Yosys (with built-in ghdl-yosys-plugin) are available on MSYS2. Therefore, Windows users should be able to use this extension together with Sphinx installed on MSYS2. As a matter of fact, that's how/where I build/test the docs of open source projects every day. I will give this a try.

README.rst

umarcor · 2021-04-21T10:09:18Z

README.rst

+Which will pass ``-m ghdl`` to Yosys when calling it. Similarly, setting this to the path of a
+ghdl-yosys-plugin shared library will also work.
+
+Unfortunately, at this time GHDL and ghdl-yosys-plugin aren't supported by YoWASP.


Let's welcome help from others explicitly!

Unfortunately, at this time GHDL and ghdl-yosys-plugin aren't supported by YoWASP. However, we'd love to have it available. Are you aware of some proof-of-concept linking WASM compiled from both C++ and Ada? Do you want to give it a try? Let us know!

umarcor · 2021-04-21T10:10:30Z

docs/code/vhdl/alu.vhdl

@@ -0,0 +1,23 @@
+library IEEE;


Maybe add some VHDL 2008 example too? That's one relevant feature of GHDL compared to almost any other available VHDL parsing tool.

umarcor · 2021-04-21T10:13:34Z

docs/conf.py

@@ -58,6 +58,10 @@
    'sphinxcontrib_hdl_diagrams',
 ]

+# Uncomment for YosysHQ/fpga-toolchain


I wonder if this can be passed as a CLI or envvar. In #73, I use make -C docs html for building the docs. That's something I do in many other projects with Docs based on Sphinx. Hence, I'd love to do HDL_DIAGRAM=system:prebuilt make -C docs html or anything similar, instead of manually modifying the conf script.

Nonetheless, I think we can handle this a separated PR, after this is merged.

umarcor · 2021-04-21T10:16:27Z

docs/configuration/index.rst

+GHDL
++++
+
+GHDL can either be prebuilt into Yosys or loaded at runtime. If it is loaded at


There is some duplication between the info in the README and the info here, isn't it? I would suggest keeping the GHDL details in one place (here). In fact, I'd suggest moving Usage from the readme to the docs.

docs/index.rst

umarcor · 2021-04-21T10:26:04Z

sphinxcontrib_hdl_diagrams/__init__.py

        print("Running YoWASP yosys: {}".format(ycmd))
        yowasp_yosys.run_yosys(ycmd)
    elif yosys == 'system':
-        ycmd = "yosys -p '{cmd}' {src}".format(src=src, cmd=cmd)
+        ycmd = "yosys {options} -p '{cmd}' {src}".format(options=options, src=src, cmd=cmd)


There is a commit in #73 for cleaning this. You might want to pick it.

umarcor · 2021-04-21T10:27:26Z

sphinxcontrib_hdl_diagrams/__init__.py

+        yosys_opt = "-m ghdl "
+    elif ghdl == "prebuilt":
+        yosys_opt = ""
+    elif os.path.exists(ghdl):


I would use Path(ghdl).exists(). This is a Python language preference.

Are you sure about this? I tried this as an example and got an error:

>>> from os import path >>> path('conf.py').exists() Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: 'module' object is not callable

On a similar note, os.path maybe should be replaced with just path throughout the code as it's imported independently from os (or the latter should be removed and use os.path everywhere). Seems redundant to have both.

import os # line 26 . . . from os import path # line 33

Sorry. I should have specified:

from pathlib import Path

See https://docs.python.org/3/library/pathlib.html, https://docs.python.org/3/library/pathlib.html#pathlib.Path.exists and https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-the-os-module.

sphinxcontrib_hdl_diagrams/__init__.py

umarcor · 2021-04-21T10:32:08Z

sphinxcontrib_hdl_diagrams/__init__.py

+            raise HDLDiagramError("Cannot use YoWASP for VHDL (yet)")
+        module = options['module']
+        ilfn = path.join(self.builder.outdir, self.builder.imagedir, options['outname'] + '.v')
+        vhdl_to_verilog(source_path, ilfn, module, self.builder.config.hdl_diagram_ghdl, yosys)


I'm not sure to understand this approach. My perception is that you are supporting Verilog sources only or VHDL sources only. Then, you convert VHDL to Verilog as a preprocess step, and then use exactly the same functions you'd use for "regular" Verilog sources. Therefore, generating drawings of mixed-language designs is not supported by this PR. Is this correct? If so, I would explain it somewhere, together with inviting people to contribute for making mixed-language diagrams possible.

You are 100% right. After going back through the fomu workshop mixed-hdl example, I want to implement this differently than what I have now. I'm going to continue this discussion back on #65.

Signed-off-by: Michael Riegert <[email protected]>

nobodywasishere · 2021-04-23T05:58:48Z

So it looks like to get ghdl-yosys-plugin and ghdl added to symbiflow conda we'll have to get gcc-ada added as well (I'd recommend adding it to conda-forge instead of symbiflow). There's already one for MinGW but that doesn't help for Linux/MacOS. I've opened this issue to keep track of it. I've also started work here on updating the ghdl-yosys-plugin package recipe.

I don't think the missing package should block this from being merged, it would just mean that VHDL support wouldn't be able to be used until it does (if people are using conda for generating their docs).

Make conda.mk optional

cb701d3

Signed-off-by: Michael Riegert <[email protected]>

nobodywasishere force-pushed the vhdl-support branch from bd68305 to f2e00cd Compare April 18, 2021 23:17

mithro requested review from daniellimws and umarcor April 19, 2021 01:13

mithro reviewed Apr 19, 2021

View reviewed changes

sphinxcontrib_hdl_diagrams/__init__.py Outdated Show resolved Hide resolved

sphinxcontrib_hdl_diagrams/__init__.py Outdated Show resolved Hide resolved

nobodywasishere force-pushed the vhdl-support branch from f2e00cd to 1095a38 Compare April 19, 2021 03:56

daniellimws approved these changes Apr 20, 2021

View reviewed changes

umarcor mentioned this pull request Apr 21, 2021

Support using sphinxcontrib-hdl-diagrams on MSYS2 #73

Draft

4 tasks

umarcor reviewed Apr 21, 2021

View reviewed changes

nobodywasishere mentioned this pull request Apr 22, 2021

Support VHDL and mixed language designs #65

Open

nobodywasishere added 2 commits April 22, 2021 19:45

Add configuration page and documentation on VHDL/GHDL support

10e9a98

Signed-off-by: Michael Riegert <[email protected]>

Add VHDL support via GHDL

2c20f5b

Signed-off-by: Michael Riegert <[email protected]>

nobodywasishere force-pushed the vhdl-support branch from 6c7e615 to 2c20f5b Compare April 23, 2021 03:50

umarcor mentioned this pull request Jul 22, 2021

Generate an static site and host it in GitHub Pages antonblanchard/microwatt#302

Open

umarcor mentioned this pull request Jul 30, 2021

Potentially useful SW VHDL/VHDLDomain#6

Open

umarcor mentioned this pull request Jan 22, 2022

Sphinx builder and autodoc plugin for HDL TerosTechnology/colibri#244

Open

nobodywasishere closed this Jun 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

vhdl support and configuration page #72

vhdl support and configuration page #72

nobodywasishere commented Apr 18, 2021

mithro commented Apr 18, 2021

mithro commented Apr 19, 2021

mithro commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

mithro left a comment

mithro commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

nobodywasishere commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

daniellimws left a comment

umarcor commented Apr 20, 2021

umarcor Apr 21, 2021

umarcor Apr 21, 2021

umarcor Apr 21, 2021

umarcor Apr 21, 2021

umarcor Apr 21, 2021

umarcor Apr 21, 2021

nobodywasishere Apr 23, 2021

umarcor Apr 23, 2021

umarcor Apr 21, 2021 •

edited

Loading

nobodywasishere Apr 21, 2021

nobodywasishere commented Apr 23, 2021

vhdl support and configuration page #72

vhdl support and configuration page #72

Conversation

nobodywasishere commented Apr 18, 2021

mithro commented Apr 18, 2021

mithro commented Apr 19, 2021

mithro commented Apr 19, 2021 • edited by unfurl-links bot Loading

mithro left a comment

Choose a reason for hiding this comment

mithro commented Apr 19, 2021 • edited by unfurl-links bot Loading

nobodywasishere commented Apr 19, 2021 • edited by unfurl-links bot Loading

daniellimws left a comment

Choose a reason for hiding this comment

umarcor commented Apr 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

umarcor Apr 21, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nobodywasishere commented Apr 23, 2021

mithro commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

mithro commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

nobodywasishere commented Apr 19, 2021 •

edited by unfurl-links bot

Loading

umarcor Apr 21, 2021 •

edited

Loading