Merge pull request #62 from PyFPGA/0.4.0-rc0

0.4.0 rc0

Author: rodrigomelo9

Makefile

@@ -2,6 +2,13 @@
 
 .PHONY: docs
 
+ifeq ($(OS),Windows_NT)
+  PATH_SEP := ;
+else
+  PATH_SEP := :
+endif
+export PATH := $(CURDIR)/tests/mocks$(PATH_SEP)$(PATH)
+
 all: docs lint test
 
 docs:
@@ -13,8 +20,8 @@ lint:
 	git diff --check --cached
 
 test:
-	pytest
-	cd examples/projects && bash regress.sh --notool
+	pytest -vv
+	cd tests && bash regress.sh
 
 clean:
 	py3clean .

docs/extending.rst

@@ -18,12 +18,13 @@ Add support for the new tool
    pyfpga/factory.py # UPDATE
    pyfpga/helpers/prj2bit.py # UPDATE
 
-Add tests and a tool mock-up
+Add tests and tools mock-ups
 ----------------------------
 
 .. code-block:: bash
 
    tests/test_tools.py # UPDATE
+   tests/regress.sh # UPDATE
    tests/support.py # UPDATE if exceptions are needed
    tests/mocks/<NEWCOMMAND>
 
@@ -36,7 +37,6 @@ Add examples
    examples/sources/cons/<NEWBOARD>/clk.<EXT>
    examples/sources/cons/<NEWBOARD>/led.<EXT>
    examples/projects/<NEWTOOL>.py
-   examples/projects/regress.sh # UPDATE
    examples/helpers/<NEWTOOL>.sh
    examples/hooks/<NEWTOOL>.py # OPTIONAL
 
@@ -61,9 +61,7 @@ Verify the functionality
 
 .. code-block:: bash
 
-   cd examples/projects/
-   bash regress.sh <NEWTOOL>
-   cd ../../tests/
+   cd tests
    python3 support.py --tool <NEWTOOL>
 
 Updated the documentation

examples/README.md

@@ -5,7 +5,6 @@ In this section, you will find:
 * `projects`: basic but complete examples for each supported tool.
 * `helpers`: examples of the PyFPGA helpers.
 * `hooks`: how to use this feature.
-* `misc`: miscellaneous examples.
 
 For an example where all the tools are employed based on the same code, you can check
 [support.py](../tests/support.py) (located under the [tests](../tests) directory).

examples/helpers/diamond.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -e
+
+HDIR=../../pyfpga/helpers
+
+python3 $HDIR/hdl2bit.py -t diamond -o results/diamond-vlog -p lfxp2-5e-5tn144c \
+    -i ../sources/vlog/include1 -i ../sources/vlog/include2 \
+    -f ../sources/vlog/blink.v -f ../sources/vlog/top.v \
+    -f ../sources/cons/brevia2/clk.lpf -f ../sources/cons/brevia2/led.lpf \
+    --define DEFINE1 1 --define DEFINE2 1 --param FREQ 125000000 --param SECS 1 Top
+
+python3 $HDIR/hdl2bit.py -t diamond -o results/diamond-vhdl -p lfxp2-5e-5tn144c --project example \
+    -f ../sources/vhdl/blink.vhdl,blink_lib -f ../sources/vhdl/blink_pkg.vhdl,blink_lib -f ../sources/vhdl/top.vhdl \
+    -f ../sources/cons/brevia2/clk.lpf -f ../sources/cons/brevia2/led.lpf \
+    --param FREQ 125000000 --param SECS 1 --last cfg Top
+
+python3 $HDIR/prj2bit.py results/diamond-vhdl/example.ldf
+
+# Diamond programming is not yet supported

examples/helpers/ise.sh

@@ -16,3 +16,5 @@ python3 $HDIR/hdl2bit.py -t ise -o results/ise-vhdl -p xc6slx16-3-csg32 --projec
     --param FREQ 125000000 --param SECS 1 --last cfg Top
 
 python3 $HDIR/prj2bit.py results/ise-vhdl/example.xise
+
+python3 $HDIR/bitprog.py -t ise results/ise-vhdl/example.bit

examples/helpers/libero.sh

@@ -16,3 +16,5 @@ python3 $HDIR/hdl2bit.py -t libero -o results/libero-vhdl -p m2s010-1-tq144 --pr
     --param FREQ 125000000 --param SECS 1 --last cfg Top
 
 python3 $HDIR/prj2bit.py results/libero-vhdl/libero/example.prjx
+
+python3 $HDIR/bitprog.py -t libero results/libero-vhdl/example.ppd

examples/helpers/openflow.sh

@@ -9,3 +9,12 @@ python3 $HDIR/hdl2bit.py -t openflow -o results/openflow-vlog -p hx1k-tq144 \
     -f ../sources/vlog/blink.v -f ../sources/vlog/top.v \
     -f ../sources/cons/icestick/clk.pcf -f ../sources/cons/icestick/led.pcf \
     --define DEFINE1 1 --define DEFINE2 1 --param FREQ 100000000 --param SECS 1 Top
+
+python3 $HDIR/hdl2bit.py -t openflow -o results/openflow-vhdl -p hx1k-tq144 --project example \
+    -f ../sources/vhdl/blink.vhdl,blink_lib -f ../sources/vhdl/blink_pkg.vhdl,blink_lib -f ../sources/vhdl/top.vhdl \
+    -f ../sources/cons/icestick/clk.pcf -f ../sources/cons/icestick/led.pcf \
+    --param FREQ 125000000 --param SECS 1 --last syn Top
+
+# OpenFlow doesn't have a project file, so it is not supported by prj2bit
+
+python3 $HDIR/bitprog.py -t openflow results/openflow-vhdl/openflow.bit

examples/helpers/quartus.sh

@@ -16,3 +16,5 @@ python3 $HDIR/hdl2bit.py -t quartus -o results/quartus-vhdl -p 5CSEBA6U23I7 --pr
     --param FREQ 125000000 --param SECS 1 --last cfg Top
 
 python3 $HDIR/prj2bit.py results/quartus-vhdl/example.qpf
+
+python3 $HDIR/bitprog.py -t quartus results/quartus-vhdl/example.sof

examples/helpers/vivado.sh

@@ -16,3 +16,5 @@ python3 $HDIR/hdl2bit.py -t vivado -o results/vivado-vhdl -p xc7z010-1-clg400 --
     --param FREQ 125000000 --param SECS 1 --last cfg Top
 
 python3 $HDIR/prj2bit.py results/vivado-vhdl/example.xpr
+
+python3 $HDIR/bitprog.py -t vivado results/vivado-vhdl/example.bit

examples/projects/diamond.py

@@ -15,9 +15,6 @@
 parser.add_argument(
     '--action', choices=['make', 'prog', 'all'], default='make'
 )
-parser.add_argument(
-    '--notool', action='store_true'
-)
 args = parser.parse_args()
 
 prj = Diamond(odir=f'results/diamond/{args.source}/{args.board}')
@@ -46,11 +43,7 @@
 
 prj.set_top('Top')
 
-try:
-    if args.action in ['make', 'all']:
-        prj.make()
-    if args.action in ['prog', 'all']:
-        prj.prog()
-except RuntimeError:
-    if not args.notool:
-        raise
+if args.action in ['make', 'all']:
+    prj.make()
+if args.action in ['prog', 'all']:
+    prj.prog()