Skip to content

clocks

Clock configuration for the external LMK04828 distribution IC (generates PL_CLK and PL_SYSREF) and the LMX2594 PLL IC (generates the DAC/ADC reference clock).

rfsoc_rfdc.clocks

Classes

ExternalClkConfig(chip, freq_in, freq_out)

Bases: ABC

Source code in rfsoc_rfdc/clocks.py 
 8
 9
10
11
12
13
def __init__(self, chip, freq_in, freq_out):
    self.chip = chip
    self.freq_in, self.freq_out = freq_in, freq_out
    self.file = None
    self.loc = None
    self.reg = None
Attributes
chip = chip instance-attribute
file = None instance-attribute
loc = None instance-attribute
reg = None instance-attribute
Functions
find_matching_file(config_dir) abstractmethod
Source code in rfsoc_rfdc/clocks.py 
15
16
17
@abstractmethod
def find_matching_file(self, config_dir):
    pass
read_registers()
Source code in rfsoc_rfdc/clocks.py 
19
20
21
22
23
24
def read_registers(self):
    if not self.loc:
        raise ValueError("File location not set")
    with open(self.loc, 'r') as file:
        reg = [line.rstrip("\n") for line in file]
        self.reg = [int(r.split('\t')[-1], 16) for r in reg]
program_clock()
Source code in rfsoc_rfdc/clocks.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def program_clock(self):
    if not self.reg:
        raise ValueError("Registers not loaded")

    if isinstance(self, LMK04828ClkConfig):
        devices = xrfclk.lmk_devices
        write_func = xrfclk.xrfclk._write_LMK_regs
    elif isinstance(self, LMX2594ClkConfig):
        devices = xrfclk.lmx_devices
        write_func = xrfclk.xrfclk._write_LMX_regs
    else:
        raise ValueError("Unknown clock type")

    for device in devices:
        write_func(self.reg, device)
to_dict() abstractmethod
Source code in rfsoc_rfdc/clocks.py 
42
43
44
@abstractmethod
def to_dict(self):
    pass

LMK04828ClkConfig(chip, freq_in, freq_out, mts_pl_clk_freq=0.0, mts_pl_sysref_freq=0.0)

Bases: ExternalClkConfig

Source code in rfsoc_rfdc/clocks.py 
48
49
50
51
def __init__(self, chip, freq_in, freq_out, mts_pl_clk_freq=0.0, mts_pl_sysref_freq=0.0):
    super().__init__(chip, freq_in, freq_out)
    self.mts_pl_clk_freq = mts_pl_clk_freq
    self.mts_pl_sysref_freq = mts_pl_sysref_freq
Attributes
mts_pl_clk_freq = mts_pl_clk_freq instance-attribute
mts_pl_sysref_freq = mts_pl_sysref_freq instance-attribute
Functions
find_matching_file(config_dir)
Source code in rfsoc_rfdc/clocks.py 
53
54
55
56
57
58
59
60
def find_matching_file(self, config_dir):
    expected_filename = f"{self.chip}_{self.freq_in}_{self.freq_out}_{self.mts_pl_clk_freq}_{self.mts_pl_sysref_freq}.txt"
    for filename in os.listdir(config_dir):
        if filename == expected_filename:
            self.file = filename
            self.loc = os.path.join(config_dir, filename)
            return True
    return False
to_dict()
Source code in rfsoc_rfdc/clocks.py 
62
63
64
65
66
67
68
69
70
71
72
def to_dict(self):
    return {
        'file': self.file,
        'loc': self.loc,
        'chip': self.chip,
        'freq_in': self.freq_in,
        'freq_out': self.freq_out,
        'mts_pl_clk_freq': self.mts_pl_clk_freq,
        'mts_pl_sysref_freq': self.mts_pl_sysref_freq,
        'reg': self.reg
    }

LMX2594ClkConfig(chip, freq_in, freq_out)

Bases: ExternalClkConfig

Source code in rfsoc_rfdc/clocks.py 
76
77
def __init__(self, chip, freq_in, freq_out):
    super().__init__(chip, freq_in, freq_out)
Functions
find_matching_file(config_dir)
Source code in rfsoc_rfdc/clocks.py 
79
80
81
82
83
84
85
86
def find_matching_file(self, config_dir):
    expected_filename = f"{self.chip}_{self.freq_in}_{self.freq_out}.txt"
    for filename in os.listdir(config_dir):
        if filename == expected_filename:
            self.file = filename
            self.loc = os.path.join(config_dir, filename)
            return True
    return False
to_dict()
Source code in rfsoc_rfdc/clocks.py 
88
89
90
91
92
93
94
95
96
def to_dict(self):
    return {
        'file': self.file,
        'loc': self.loc,
        'chip': self.chip,
        'freq_in': self.freq_in,
        'freq_out': self.freq_out,
        'reg': self.reg
    }

Functions

find_and_program_clocks(lmk_config, lmx_config, config_dir)

Find matching configuration files and program the clocks.

:param lmk_config: LMK04828ClkConfig object :param lmx_config: LMX2594ClkConfig object :param config_dir: Directory containing clock configuration files :return: Dictionary containing updated LMK and LMX configurations

Source code in rfsoc_rfdc/clocks.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def find_and_program_clocks(lmk_config, lmx_config, config_dir):
    """
    Find matching configuration files and program the clocks.

    :param lmk_config: LMK04828ClkConfig object
    :param lmx_config: LMX2594ClkConfig object
    :param config_dir: Directory containing clock configuration files
    :return: Dictionary containing updated LMK and LMX configurations
    """
    # Ensure LMK and LMX devices are known
    if not xrfclk.lmk_devices and not xrfclk.lmx_devices:
        xrfclk.xrfclk._find_devices()

    # Find matching files
    if not lmk_config.find_matching_file(config_dir):
        raise FileNotFoundError(
            "Could not find matching LMK configuration file.")
    if not lmx_config.find_matching_file(config_dir):
        raise FileNotFoundError(
            "Could not find matching LMX configuration file.")

    # Read registers
    lmk_config.read_registers()
    lmx_config.read_registers()

    # Program clocks
    lmk_config.program_clock()
    lmx_config.program_clock()

    # Return configurations as a dictionary
    return lmk_config.to_dict(), lmx_config.to_dict()