Merge branch 'image_v2.6.0'

.coveragerc

@@ -0,0 +1,10 @@
+[run]
+branch = True
+
+[report]
+omit =
+    pynq/lib/*
+    pynq/ert.py
+    pynq/xclbin.py
+    pynq/tinynumpy.py
+    pynq/_cli/*

.gitattributes

@@ -33,5 +33,7 @@
 *.a binary -crlf
 *.bsp binary
 
-# Populate git commit ID into __init__.py
+# Populate git blob ID into __init__.py
+# This ID will always be tied to a specific release tag
+# since the file will be modified to edit the version
 pynq/__init__.py ident

.github/workflows/python-package.yml

@@ -0,0 +1,56 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python
+
+on:
+  push:
+    branches: [ image_v2.6.0 ]
+  pull_request:
+    branches: [ image_v2.6.0 ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest pyfakefs pytest-cov pytest-asyncio codecov
+        # Install required dependencies for pynq since we import it in setup.py
+        pip install numpy cffi
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 pynq --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 pynq --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Install PYNQ
+      run:
+        pip install -e .
+    - name: Test with pytest
+      run: |
+        pytest --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
+    - name: Upload pytest test results
+      uses: actions/upload-artifact@v1
+      with:
+        name: pytest-results-${{ matrix.python-version }}
+        path: junit/test-results-${{ matrix.python-version }}.xml
+      # Use always() to always run this step to publish test results when there are test failures
+      if: ${{ always() }}
+    - name: Upload coverage
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+

.gitignore

@@ -27,6 +27,11 @@ thumbs.db
 build/
 sdcard/
 
+# Raw overlay files
+*.bit
+*.hwh
+*.xsa
+
 # Test failure outputs
 ######################
 tests/*.exp

CONTRIBUTING.md

@@ -1,59 +1,91 @@
-We welcome contributions to PYNQ.  Please first sign our <a href="https://www.clahub.com/agreements/Xilinx/PYNQ"> Contributor License Agreement</a>.
+## Contributing to PYNQ
 
-If you have an idea how to improve PYNQ:
+We welcome contributions to PYNQ - please see our guidelines below for preparing your pull request.  
 
-1. Share your proposal via <a href="https://github.com/Xilinx/PYNQ/issues" target="_blank">Github issues</a>.
-
-   A general set of rules on what to submit:
-
-	 1. We welcome submissions to the pynq Python package, sdbuild flows and documentation.
+### 1. A general set of rules on what to submit
 
-	 2. For development boards, we only host boards that we officially support. To 
-	 build new SDCard images for custom PYNQ enabled boards, we encourage users 
-	 to build a new board-only repository.  For reference, please see the 
-	 <a href="https://github.com/Avnet/Ultra96-PYNQ" target="_blank">Avnet Ultra96</a>
-	 or <a href="https://github.com/Xilinx/ZCU111-PYNQ" target="_blank">Xilinx ZCU111</a> 
-	 repositories. 
+- We welcome submissions to the pynq Python package, sdbuild flows and documentation.
+
+- For development boards, we only host boards that we officially support. To 
+build new SDCard images for custom PYNQ enabled boards, we encourage users 
+to build a new board-only repository.  For reference, please see the 
+<a href="https://github.com/Avnet/Ultra96-PYNQ" target="_blank">Avnet Ultra96</a>
+or <a href="https://github.com/Xilinx/ZCU111-PYNQ" target="_blank">Xilinx ZCU111</a> 
+repositories. 
 
-   3. For custom overlays, we only host overlays that we officially support. To 
-   create new custom overlays, we encourage users to build a new overlay 
-   repository. For reference, please see the 
-   <a href="https://github.com/Xilinx/PYNQ-HelloWorld" target="_blank">PYNQ-HelloWorld</a> 
-   and <a href="https://github.com/Xilinx/BNN-PYNQ" target="_blank">BNN-PYNQ</a> repositories.
+- For custom overlays, we only host overlays that we officially support. To 
+create new custom overlays, we encourage users to build a new overlay 
+repository. For reference, please see the 
+<a href="https://github.com/Xilinx/PYNQ-HelloWorld" target="_blank">PYNQ-HelloWorld</a> 
+and <a href="https://github.com/Xilinx/BNN-PYNQ" target="_blank">BNN-PYNQ</a> repositories.
 
-   4. For Microblaze peripheral drivers, we encourage users to submit their C/C++ within 
-   a Jupyter notebook using the microblaze IPython magic.  Please see 
-   the <a href="https://github.com/Xilinx/PYNQ/tree/master/boards/Pynq-Z1/base/notebooks/microblaze" target="_blank">Microblaze example notebooks</a> 
-   for how to write custom device drivers.
+- For Microblaze peripheral device drivers, we encourage users to submit their C/C++ within 
+a Jupyter notebook using the microblaze IPython magic.  Please see 
+the <a href="https://github.com/Xilinx/PYNQ/tree/master/boards/Pynq-Z1/base/notebooks/microblaze" target="_blank">Microblaze example notebooks</a> 
+for how to write custom device drivers.
 
 
-2. Submitting your pull request:
+### 2. Submit your patch using a pull request
+
+Please use GitHub Pull Requests for sending code contributions. When sending code sign your 
+work as described below. Be sure to use the same license for your contributions as the current 
+license of the PYNQ.
+
+
+### 3. Sign Your Work
+
+Please use the *Signed-off-by* line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) defined by https://developercertificate.org/ reproduced below::
+
+```
+  Developer Certificate of Origin
+  Version 1.1
+
+  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+  1 Letterman Drive
+  Suite D4700
+  San Francisco, CA, 94129
+
+  Everyone is permitted to copy and distribute verbatim copies of this
+  license document, but changing it is not allowed.
+
+
+  Developer's Certificate of Origin 1.1
+
+  By making a contribution to this project, I certify that:
+
+  (a) The contribution was created in whole or in part by me and I
+      have the right to submit it under the open source license
+      indicated in the file; or
+
+  (b) The contribution is based upon previous work that, to the best
+      of my knowledge, is covered under an appropriate open source
+      license and I have the right under that license to submit that
+      work with modifications, whether created in whole or in part
+      by me, under the same open source license (unless I am
+      permitted to submit under a different license), as indicated
+      in the file; or
 
-	1. Fork this repository to your own github account using the *fork* button above.
+  (c) The contribution was provided directly to me by some other
+      person who certified (a), (b) or (c) and I have not modified
+      it.
 
-	2. Clone the fork to a local computer using *git clone*. Checkout the branch you want to work on.
+  (d) I understand and agree that this project and the contribution
+      are public and that a record of the contribution (including all
+      personal information I submit with it, including my sign-off) is
+      maintained indefinitely and may be redistributed consistent with
+      this project or the open source license(s) involved.
+```
 
-	3. You can modify the Vivado projects, Python source code, or notebooks.
+Here is an example Signed-off-by line which indicates that the contributor accepts DCO::
 
-	4. Modify the documentation if necessary.
+```
+  This is my commit message
 
-	5. Make sure your patch follows code standards:
-		1. <a href="https://www.doc.ic.ac.uk/lab/cplus/cstyle.html" target="_blank">C/C++ code</a>
-		2. <a href="https://www.python.org/dev/peps/pep-0008/" target="_blank">Python / Jupyter notebook</a>
+  Signed-off-by: Jane Doe <[email protected]>
+```
 
-	6. Use *git add*, *git commit*, *git push* to add changes to your fork.
 
-	7. Submit a pull request by clicking the *pull request* button on your github repo:
-		1. The <a href="https://github.com/Xilinx/PYNQ" target="_blank">master branch</a> should always be
-		   treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed
-           to be very important such that without this fix, a lot of things break.
-        2. For new features, small bug fixes, doc updates, and many other fixes, users should pull request against
-           the development branch, which has the newest image version. For example, if we have released 
-           image v2.3 but you see a new branch `image_v2.4`, then you should pull request against 
-           `image_v2.4` branch.
+### 4. We will review your contribution 
 
-	Check the <a href="http://git.huit.harvard.edu/guide/" target="_blank">guide to git</a> for more information.
-
-3. We will review your contribution and, if any additional fixes or modifications are 
-necessary, may provide feedback to guide you. When accepted, your pull request will 
-be merged to the repository.
+If any additional fixes or modifications are necessary, we may provide feedback to guide 
+you. When accepted, your pull request will be merged to the repository.

README.md

@@ -1,4 +1,6 @@
-![alt tag](./logo.png)
+![pynq_logo](https://github.com/Xilinx/PYNQ/raw/master/logo.png)
+
+![python](https://github.com/Xilinx/PYNQ/workflows/Python/badge.svg)
 
 PYNQ is an open-source project from Xilinx that makes it easy to design embedded systems with Zynq All Programmable Systems on Chips (APSoCs). Using the Python language and libraries, designers can exploit the benefits of programmable logic and microprocessors in Zynq to build more capable and exciting embedded systems.
 PYNQ users can now create high performance embedded applications with
@@ -74,6 +76,6 @@ Please ask questions on the <a href="https://discuss.pynq.io" target="_blank">PY
 
 ## SDBuild Open Source Components
 
-**License and Copyrights Info** [TAR/GZIP](http://bit.ly/2Os4h03)
+**License and Copyrights Info** [TAR/GZIP](http://bit.ly/pynq_v2_6_license)
 
-**Open Components Source Code** [TAR/GZIP](http://bit.ly/2AUmcUY)
+**Open Components Source Code** [TAR/GZIP](http://bit.ly/pynq_v2_6_components)

THIRD_PARTY_LIC

@@ -21,7 +21,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-pynq/tinynumpy.py derived from tinynumpy under the following license
+pynq/_3rdparty/tinynumpy.py derived from tinynumpy under the following license
 MIT License
 
 Copyright (c) 2014 by Wade Brainerd <[email protected]>
@@ -41,7 +41,7 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FO
 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-pynq/ert.py, pynq/xrt.py and pynq/xclbin.py used under the following license
+pynq/_3rdpart/ert.py, pynq/_3rdparty/xrt.py and pynq/_3rdparty/xclbin.py used under the following license
 
 Copyright (C) 2016-2018 Xilinx, Inc
 

boards/Pynq-Z1/Pynq-Z1.spec

@@ -1,5 +1,6 @@
 ARCH_Pynq-Z1 := arm
 BSP_Pynq-Z1 :=
 BITSTREAM_Pynq-Z1 := base/base.bit
+FPGA_MANAGER_Pynq-Z1 := 1
 
-STAGE4_PACKAGES_Pynq-Z1 := pynq boot_leds ethernet
+STAGE4_PACKAGES_Pynq-Z1 := xrt pynq boot_leds ethernet