Urukul proto_rev mismatch with ARTIQ 9

debry

I was successfully able to flash my crates with ARTIQ 9 gateware. The only error that I'm confused about when running experiments is a this Urukul proto_rev mismatch error. I queried the proto rev registers myself on the urukuls and they report revision 8 instead of 9, but running the artiq_ddb_template tool on my system description json files generates a device_db file with revision 9 specified. For now I have changed each occurrence of proto rev 9 to 8 in my device_db file and this is working, but I'm wondering if this is the expected behavior, or if the new gateware ought to have updated the urukuls to rev 9 (or do I need to flash the urukuls separately? I'm a bit fuzzy on which cards have independent firmware from the kasli)

root:Terminating with exception (ValueError: Urukul proto_rev mismatch)
Core Device Traceback:
Traceback (most recent call first):
  File "<artiq>/coredevice/urukul.py", line 531, column 13, in ... artiq.coredevice.urukul.ProtoRev9.init<artiq.coredevice.urukul.ProtoRev9>(...)
    raise ValueError("Urukul proto_rev mismatch")
    ^
  File "<artiq>/coredevice/urukul.py", line 531, in ... artiq.coredevice.urukul.ProtoRev9.init<artiq.coredevice.urukul.ProtoRev9>(...) (RA=+0x1638)
    raise ValueError("Urukul proto_rev mismatch")
  File "<artiq>/coredevice/urukul.py", line 808, in ... artiq.coredevice.urukul.CPLD.init<artiq.coredevice.urukul.CPLD>(...) (RA=+0xf14)
    self.version.init(blind)
  File "/home/artiq/artiq-master/repository/localexp.py", line 0, in localexp.LocalExperiment.initializeDevices(..., ...) (inlined)
    <unknown>
ValueError(0): Urukul proto_rev mismatch

End of Core Device Traceback
Traceback (most recent call last):
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/master/worker_impl.py", line 378, in main
    exp_inst.run()
    ~~~~~~~~~~~~^^
  File "/home/artiq/artiq-master/repository/photons.py", line 49, in run
    self.initializeDevices()
    ~~~~~~~~~~~~~~~~~~~~~~^^
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/language/core.py", line 54, in run_on_core
    return getattr(self, arg).run(run_on_core, ((self,) + k_args), k_kwargs)
           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/coredevice/core.py", line 177, in run
    self._run_compiled(kernel_library, embedding_map, symbolizer, demangler)
    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/coredevice/core.py", line 166, in _run_compiled
    self.comm.serve(embedding_map, symbolizer, demangler)
    ~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/coredevice/comm_kernel.py", line 744, in serve
    self._serve_exception(embedding_map, symbolizer, demangler)
    ~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/h53slficvsrksp4g2hyqpprbw2kqvmq8-python3-3.13.12-env/lib/python3.13/site-packages/artiq/coredevice/comm_kernel.py", line 726, in _serve_exception
    raise python_exn
ValueError: Urukul proto_rev mismatch

occheung

debry For now I have changed each occurrence of proto rev 9 to 8 in my device_db file and this is working

Did you set proto_rev in the JSON description before generating the gateware?

So this is how the device_db generation work for proto_rev (as of now on master): If you specified proto_rev, device_db gets your proto_rev; If you didn't, device_db generates a "proto_rev": 9 entry.

The rationale is: We keep older Urukul proto_revs compatible, but we encourage using proto_rev 9 over 8.

Keeping both entries (on JSON and device_db) becomes important for SU-Servo. There is a pin mapping change on proto_rev 9. The implication is: Gateware generated for SU-Servo with proto_rev 8 is not compatible to that of 9.

Here's the reason why:
https://git.m-labs.hk/M-Labs/urukul-pld/issues/6

debry

Possible related: I also had to change the proto_rev to 8 on my suservo-enabled Urukuls due to the same error, and it no longer throws an error, but I am not seeing any output from those channels. My non-suservo Ukululs are behaving exactly as expected.

debry

Thanks for the info! My system description JSON files did not initially have the proto_rev fields at all (they must have been added since ARTIQ 7). I'll try adding them as follows and re-create the gateware:

"peripherals": [
        {
            "type": "suservo",
            "sampler_ports": [1, 2],
            "urukul0_ports": [3, 4],
            "urukul1_ports": [5, 6],
            "clk_sel": 2,
            "proto_rev": 9
        },
        {
            "type": "urukul",
            "dds": "ad9910",
            "ports": [7, 8],
            "clk_sel": 2,
            "synchronization": true,
            "proto_rev": 9
        },
...

Do you happen to know if this is the correct format?

Also, are there examples of how these should look or ways to generate the system description file automatically? I'm basically wondering where I should have been looking to know ahead of time that I needed to add these lines to the file, because there is a mention of proto_rev 9 in the release notes but it did not jump out at me to mean I would need to manually add these lines to the files.

Thanks again for your help!

debry

I re-built and flashed the gateware to my crate using the above json edits, but the urukuls still report proto_rev 8 when queried and setting the device_db proto_rev lines to 9 results in an error, so I must be missing something. I also get a ValueError: no valid window/delay when calling the init method of urukuls with my device_db proto_rev set back to 8.

debry

Okay I now understand from https://git.m-labs.hk/M-Labs/urukul-pld that I would need to flash the Urukul with a JTAG cable to update it to proto_rev 9. That's probably not something I'm going to do immediately as I don't need the improved phase control at the moment. However, even with everything set back to proto_rev 8 in the device_db, I'm still not seeing output from my su-servo urukuls (normal urukuls seem to be fine). Is there something I need to add to my system description JSON file to tell it that these still have the older gateware?

occheung

"proto_rev": 8 on JSON.
Then rebuild gateware and reflash the Kasli.
I suggest power-cycling the Kasli when restarting a system with a SU-Servo.

debry

I have flashed the Kasli using gateware recompiled with "proto_rev": 8 specified in both the urukul and su-servo blocks of the system description file. However, I still don't get any output from the su-servo urukuls, and I can no longer read values from the sampler (self.suservo0.get_adc(0) always returns exactly 0). Here is our master crate's system description file:

{
    "target": "kasli_soc",
    "min_artiq_version": "7.0",
    "variant": "mitll7_marlo_master",
    "hw_rev": "v1.1",
    "base": "master",
    "core_addr": "169.254.13.38",
    "peripherals": [
        {
            "type": "suservo",
            "sampler_ports": [1, 2],
            "urukul0_ports": [3, 4],
            "urukul1_ports": [5, 6],
            "clk_sel": 2,
            "proto_rev": 8
        },
        {
            "type": "urukul",
            "dds": "ad9910",
            "ports": [7, 8],
            "clk_sel": 2,
            "synchronization": true,
            "proto_rev": 8
        },
        {
            "type": "phaser_drtio",
            "gateware_variant": "mtdds",
            "hardware_variant": "baseband",
            "tones": 26,
            "dds_bandwidth": 250e6,
            "ports": [9]
        },
        {
            "type": "dio",
            "ports": [10],
            "board": "DIO_SMA",
            "bank_direction_low": "input",
            "bank_direction_high": "output"
        }
    ]
}

Let me know if any other debug information would be helpful. Everything else is functional (it's only the su-servo-related components that are not working).

debry

We seem to have gotten the su-servo urukuls working again. I'm not entirely sure what did it, but I'm guessing something to do with a slightly different sequence of the various initialization/set_config/set_dds/set_att methods than what we had been using before. Here's an example that generates the expected RF output and correctly reads the ADC value with proto_rev=8 in case anyone else has similar issues:

from artiq.experiment import *

class SUServoMWE(EnvExperiment):
    "SU Servo MWE"
    def build(self):
        self.setattr_device("core")
        self.setattr_device("suservo0")
        self.setattr_device("suservo0_ch0")
        self.setattr_device("urukul0_cpld")

    @kernel
    def run(self):
        self.core.reset()
        self.core.break_realtime()
        self.suservo0.init()
        self.suservo0.set_config(enable=1)
        delay(10*us)
        
        self.urukul0_cpld.set_att(0, 0.0)       # set attenuation on Urukul channel 0 to 0

        self.suservo0_ch0.set_dds(
            profile=1,
            frequency=80*MHz,
            offset=0.0,
        )
        delay(10*us)
        self.suservo0_ch0.set_y(1, 1.0)
        delay(10*us)
        self.suservo0_ch0.set(en_out=1, en_iir=0, profile=1)
        delay(100*us)
        
        adc_value = self.suservo0.get_adc(0)
        print(adc_value)