Skip to content

RFSoC Overlay

rfsoc_rfdc.rfsoc_overlay

Classes

RFSoCOverlay

Bases: Overlay

Represents an RFSoC overlay.

This class extends the Overlay class and provides additional functionality specific to RFSoC devices.

Parameters:

Name Type Description Default
path_to_bitstream str

Path to the bitstream file (.bit). If not provided, the default bitstream file in the current directory will be used.

 None
**kwargs

Additional keyword arguments to be passed to the Overlay class constructor.

 {}
Source code in rfsoc_rfdc/rfsoc_overlay.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class RFSoCOverlay(Overlay):
    """
    Represents an RFSoC overlay.

    This class extends the `Overlay` class and provides additional functionality specific to RFSoC devices.

    Args:
        path_to_bitstream (str): Path to the bitstream file (.bit). If not provided, the default bitstream file in the current directory will be used.
        **kwargs: Additional keyword arguments to be passed to the `Overlay` class constructor.
    """

    def __init__(self, path_to_bitstream=None, **kwargs):
        """
        Initializes the RFSoCOverlay object.

        Args:
            path_to_bitstream (str): Path to the bitstream file (.bit). If not provided, the default bitstream file in the current directory will be used.
            **kwargs: Additional keyword arguments to be passed to the `Overlay` class constructor.
        """

        # Generate default bitfile name
        if path_to_bitstream is None:
            curr_dir = os.path.dirname(os.path.abspath(__file__))
            bitstream_fname, hwh_fname = self._find_matching_files(curr_dir)
            logging.info(f'"Writing bitstream {bitstream_fname} to RFSoC."')
            path_to_bitstream = os.path.join(curr_dir, bitstream_fname)
        # Create Overlay
        super().__init__(path_to_bitstream, ignore_version=True, **kwargs)

        # Print out all IPs in bit stream file
        for i in self.ip_dict:
            print(i)

    def _find_matching_files(self, directory):
        """
        Finds the matching bitstream (.bit) and hardware handoff files (.hwh) in the given directory.

        Args:
            directory (str): Path to the directory containing the files.

        Returns:
            tuple: A tuple containing the names of the matching bitstream and hardware handoff files.

        Raises:
            FileNotFoundError: If no matching bitstream files are found or if a corresponding hardware handoff file is missing.
        """

        # Get all files in the directory and sort them in increasing order
        all_files = sorted(os.listdir(directory))

        # Regex pattern to match the .bit file
        bit_pattern = r"rfsoc_rfdc.*\.bit$"

        # Find all .bit files that match the pattern
        bit_files = [f for f in all_files if re.match(bit_pattern, f)]

        for bit_file in bit_files:
            # Extract the prefix from the bit file name
            prefix = bit_file.split('.bit')[0]

            # Construct the corresponding .hwh file name
            hwh_file = prefix + '.hwh'

            # Check if the .hwh file exists in the sorted list
            if hwh_file not in all_files:
                raise FileNotFoundError(f"Missing .hwh file for {bit_file}")

            # Return the matched pair
            return bit_file, hwh_file

        # Raise exception if no .bit files are found
        raise FileNotFoundError(
            f"No matching bit stream files found in {directory}")