diff --git a/src/hw/suservo.md b/src/hw/suservo.md index a1af88e..1eed705 100644 --- a/src/hw/suservo.md +++ b/src/hw/suservo.md @@ -4,6 +4,31 @@ ## JSON +With enabled SUServo mode, you only need to add `suservo` to JSON file, with its Sampler and Urukul(s) removed. + +### ARTIQ 9+ Entry + +```json +{ + "type": "suservo", + "sampler_ports": [, ], + "urukul_ports": [[, ], ..], // A list of port pairs + "clk_sel": 2, + "synchronization": true/false, + "proto_rev": <8 or 9, default 9> // CPLD firmware version +} +``` + +### Legacy Entry + +__This is only applicable prior to ARTIQ-9. Please use the up-to-date entries otherwise.__ + +Here are the key differences from the up-to-date entries: +- Urukul EEM ports must be specified via `urukul0_ports` and `urukul1_ports`, which implies; +- At most 2 Urukuls per SU-Servo. +- Urukul synchronization is not supported. +- Protocal revision (`proto_rev`) is unconfigurable. + ```json { "type": "suservo", @@ -11,12 +36,9 @@ "urukul0_ports": [, ], "urukul1_ports": [, ], // optional "clk_sel": 2, // select 0 to 2 - "proto_rev": <8 or 9, default 9> // CPLD firmware version } ``` -With enabled SUServo mode, you only need to add `suservo` to JSON file, with its Sampler and Urukul(s) removed. - ## Building and Flashing A SU-Servo consists of a set of Samplers and Urukuls.