Merge image_v3.1.1 into master for v3.1.1 release

Author: jogomojo

CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use PYNQ in your research, please cite it using the metadata below."
+authors:
+  - name: 'Advanced Micro Devices, Inc.'
+title: "PYNQ"
+type: software
+license: 'BSD-3-Clause'
+version: 3.1.1
+date-released: "2025-09-24"
+url: 'https://pynq.io'
+repository-code: "https://github.com/Xilinx/PYNQ"

README.md

@@ -52,6 +52,10 @@ for how to improve PYNQ.
 
 Please ask questions on the <a href="https://discuss.pynq.io" target="_blank">PYNQ support forum</a>.
 
+## Citing PYNQ
+
+If you use PYNQ in your research, please cite this GitHub repository by using the metadata given in <a href="https://github.com/Xilinx/PYNQ/blob/master/CITATION.cff" target="_blank">CITATION.cff</a>.
+
 ## Licenses
 
 **PYNQ** License: [BSD 3-Clause License](https://github.com/Xilinx/PYNQ/blob/master/LICENSE)

build.mk

@@ -3,7 +3,7 @@
 
 # Builds final pynq source distribution with overlays and BSPs included
 
-VERSION := 3.1.0
+VERSION := 3.1.1
 SDIST := dist/pynq-$(VERSION).tar.gz
 
 BITS := boards/Pynq-Z1/logictools/logictools.bit \

docs/source/conf.py

@@ -100,9 +100,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '3.1'
+version = '3.1.1'
 # The full version, including alpha/beta/rc tags.
-release = '3.1'
+release = '3.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/getting_started/terminal.rst

@@ -5,7 +5,7 @@ If you can't access the terminal from Jupyter, you can connect the micro-USB
 cable from your computer to the board and open a terminal. You can use the
 terminal to check the network connection of the board. You will need to have
 terminal emulator software installed on your computer. `PuTTY
-<http://www.putty.org/>`_ is one application that can be used, and is available
+<http://putty.software/>`_ is one application that can be used, and is available
 for free on Windows. To open a terminal, you will need to know the COM port for
 the board.
 

docs/source/pynq_sd_card.rst

@@ -93,7 +93,7 @@ build environment on your host OS using the following steps:
 
      Replace ``/tools/Xilinx`` and ``/home/user/petalinux`` with the actual paths 
      to your Xilinx installations on the host system. The ``:ro`` option mounts 
-     tool directories read-only, and ``--privileged`` is required for parts of 
+     tool directories as read-only, and ``--privileged`` is required for parts of 
      the build process.
 
   5. Inside the container, set up the tool environment:
@@ -109,11 +109,6 @@ build environment on your host OS using the following steps:
      Navigate to the sdbuild directory and follow the building instructions 
      in the next section.
 
-     .. note::
-        Rebuilding the PYNQ source distribution (SDIST) currently does not work 
-        inside Docker due to limitations in the Vitis tools. If you need to 
-        rebuild the SDIST, consider using a virtual machine with a supported 
-        Ubuntu distribution instead.
 
 Use an existing Ubuntu OS
 -------------------------

pynq/__init__.py

@@ -24,7 +24,7 @@
     from .pmbus import DataRecorder, get_rails
 
 __all__ = ["lib", "tests"]
-__version__ = "3.1"
+__version__ = "3.1.1"
 # This ID will always be tied to a specific release tag
 # since the file will be modified to edit the version
 __git_id__ = "$Id$"

pynq/lib/video/pcam5c.py

@@ -4,6 +4,7 @@
 import contextlib
 import os
 from enum import Enum
+import glob
 
 import cffi
 
@@ -67,10 +68,22 @@ def __init__(self, description):
         virtaddr_gamma_lut = self.gamma_lut.mmio.array.ctypes.data
         virtaddr_demosaic = self.demosaic.mmio.array.ctypes.data
 
-        # todo read /sys/bus/i2c/devices/i2c-6/of_node/label
-
+        i2c_devices = glob.glob('/dev/i2c-*')
+        i2c_index = 6 ## legacy
+        for dev_path in i2c_devices:
+            adapter_number = os.path.basename(dev_path).split('-')[-1]
+            name_path = f'/sys/bus/i2c/devices/i2c-{adapter_number}/of_node/label'
+            try:
+                with open(name_path, 'r') as name_file:                
+                    label = name_file.read().strip()
+                    if 'RPICAM' in label:
+                        i2c_index = int(adapter_number)
+            except FileNotFoundError:
+                continue
+
+        print(i2c_index)
         self._handle = pcam5c_lib.pcam_mipi(
-            6,
+            i2c_index,
             int(MIPIMode.r1280x720_60.value),
             virtaddr_gpio_ip_reset,
             virtaddr_v_proc_sys,

pynq/pl_server/device.py

@@ -233,7 +233,7 @@ def load_ip_data(self, ip_name, data, zero=False):
         ip_dict = self.ip_dict
         mem_dict = self.mem_dict
         if ip_name in ip_dict:
-            address = ip_dict[ip_name]["addr_range"]
+            address = ip_dict[ip_name]["base_address"]
             target_size = ip_dict[ip_name]["addr_range"]
         elif ip_name in mem_dict:
             address = mem_dict[ip_name]["base_address"]

pynq/pl_server/embedded_device.py

@@ -646,6 +646,7 @@ def gen_cache(self, bitstream, parser=None):
 
             if os.path.exists(bitstream.bitfile_name):
                 gs=GlobalState(bitfile_name=str(bitstream.bitfile_name),
+                                 bitfile_hash=bitstream_hash(bitstream.bitfile_name),
                                  timestamp=ts,
                                  active_name=self.name,
                                  psddr=parser.mem_dict.get("PSDDR", {}))