Skip to content

Commit

Permalink
docs: added helpers
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigomelo9 committed Jul 15, 2024
1 parent 79bb0b4 commit d9b02da
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 10 deletions.
6 changes: 5 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ help:

.PHONY: help Makefile

$(BUILDDIR)/hdl2bit $(BUILDDIR)/prj2bit:
@mkdir -p $(@D)
@python3 ../pyfpga/helpers/$(@F).py -h > $@

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
%: Makefile $(BUILDDIR)/hdl2bit $(BUILDDIR)/prj2bit
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
12 changes: 12 additions & 0 deletions docs/helpers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Helpers
=======

hdl2bit
-------

.. literalinclude:: _build/hdl2bit

prj2bit
-------

.. literalinclude:: _build/prj2bit
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ PyFPGA's documentation
basic
advanced
api
helpers
tools
internals
13 changes: 4 additions & 9 deletions docs/tools.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
Tools support
=============

.. ATTENTION::

(2024-05-31) To be updated.

+---------------+-----------+---------+-----+-----------------------------------------------+
| Tools | Vendor | Version | Tcl | Comment |
+===============+===========+=========+=====+===============================================+
| ISE | Xilinx | 14.7 | 8.4 | Discontinued in 2013 |
+---------------+-----------+---------+-----+-----------------------------------------------+
| Libero-SoC | Microsemi | 12.2 | 8.5 | Important changes in version 12.0 (2019) |
| Libero-SoC | Microsemi | 2024.1 | 8.5 | Important changes in version 12.0 (2019) |
+---------------+-----------+---------+-----+-----------------------------------------------+
| Quartus Prime | Intel | 19.1 | 8.6 | Known as Quartus II until version 15.0 (2015) |
| Openflow | | | | |
+---------------+-----------+---------+-----+-----------------------------------------------+
| Vivado | Xilinx | 2019.1 | 8.5 | Introduced in 2012, it superseded ISE |
| Quartus Prime | Intel | 23.1 | 8.6 | Known as Quartus II until version 15.0 (2015) |
+---------------+-----------+---------+-----+-----------------------------------------------+
| Yosys | | 0.9-dev | 8.6 | The open-source synthesizer |
| Vivado | Xilinx | 2022.1 | 8.5 | Introduced in 2012, it superseded ISE |
+---------------+-----------+---------+-----+-----------------------------------------------+


* ISE supports devices starting from Spartan 3/Virtex 4 until some first members of the 7 series.
Previous Spartan/Virtex devices were supported until version 10. Vivado supports devices starting
from the 7 series.
Expand Down

0 comments on commit d9b02da

Please sign in to comment.