diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 36189e7..ffb1c16 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -24,3 +24,5 @@ - [UART Logs](./sw_sup/uart_logs.md) - [Flashing the Firmware](./sw_sup/flashing_firmware.md) - [Moninj](./sw_sup/moninj.md) + - [Clocking](sw_sup/clocking.md) + - [device_db.py](sw_sup/device_db.md) \ No newline at end of file diff --git a/src/extra/CONFIG.TXT b/src/extra/CONFIG.TXT index 180275f..7aca184 100644 --- a/src/extra/CONFIG.TXT +++ b/src/extra/CONFIG.TXT @@ -1 +1,2 @@ ip=192.168.1.75 +rtio_clock=int_125 diff --git a/src/sw_sup/clocking.md b/src/sw_sup/clocking.md new file mode 100644 index 0000000..bc0cdc0 --- /dev/null +++ b/src/sw_sup/clocking.md @@ -0,0 +1,68 @@ +# Clocking + +This page describes ways to set up clocking. Official documentation references: + +* [Carrier configuration](https://m-labs.hk/artiq/manual/installing.html#miscellaneous-configuration-of-the-core-device) +* Devices' [available options](https://m-labs.hk/artiq/manual/core_drivers_reference.html), [Urukul example](https://m-labs.hk/artiq/manual/core_drivers_reference.html#artiq.coredevice.urukul.CPLD) + +In general, any RF card and Carriers require some clock source. Most of them have both internal clock signal generator +and external MMCX and/or SMA connectors to accept the signal. By default the internal clock is used for Carriers, +and external MMCX is used for RF cards. However, internal clock may be not good enough for the end-user application, +so the end-user may want to change the clock source at any time. + +## Kasli/Kasli-SoC + +For setting clocking on the Carriers you will just need to set `rtio_clock` in the core device config. Be aware, that +setting any external clocking will require appropriate external clock signal to be supplied into `CLK IN` SMA connector +on the front panel to boot. Therefore, firmware will be halted, the `ERR` LED will be red and **no Ethernet connection +will be established**. Since the clock signal is distributed by DRTIO, there is generally no need in setting it up on +satellites. + +If you have connection with the Carrier, you can use coremgmt command: + +```shell +artiq_coremgmt config write -s rtio_clock