urukul: explain proto_rev

This commit is contained in:
occheung 2025-07-10 09:36:26 +08:00
parent 2ffa2d0a2f
commit cd904e98c6

View File

@ -53,6 +53,18 @@ Urukul 4412 has higher frequency resolution (47 bit against 32 at Urukul 4410),
* Synchronization
* RAM
### Protocol Revision (proto_rev)
| Build Channel | Proto. Rev. | ARTIQ Version |
|:-------------:|:-----------:|:-------------:|
| Legacy | 8 | Any |
| Release | 8 | Any |
| Master | 9 | ARTIQ 9+ |
Urukul firmware solely determines the expected `proto_rev`. You **should** fill in the `proto_rev` field in the JSON file to protect against future changes.
_Note: "Any" refers to ARTIQ versions that are still maintained (beta, release, legacy). I am sure you can find some ancient ARTIQ version that does not understand what is a Urukul._
## Testing
After running `artiq_sinara_tester`:
@ -141,7 +153,8 @@ customer needs, and if it is connected to the [Clocker](clocker.md), check that
ValueError: Urukul proto_rev mismatch
```
Check the ports are connected respectively to the JSON description.
- Check the ports are connected respectively to the JSON description.
- Are you using the correct firmware?
### PLL lock timeout