examples: add Metlino master, Sayma satellite with TTLOuts via FMC

artiq/examples/metlino_sayma_ttl/device_db.py

@@ -0,0 +1,95 @@
+core_addr = "192.168.1.65"
+
+device_db = {
+    "core": {
+        "type": "local",
+        "module": "artiq.coredevice.core",
+        "class": "Core",
+        "arguments": {"host": core_addr, "ref_period": 1/(8*125e6)}
+    },
+    "core_log": {
+        "type": "controller",
+        "host": "::1",
+        "port": 1068,
+        "command": "aqctl_corelog -p {port} --bind {bind} " + core_addr
+    },
+    "core_cache": {
+        "type": "local",
+        "module": "artiq.coredevice.cache",
+        "class": "CoreCache"
+    },
+    "core_dma": {
+        "type": "local",
+        "module": "artiq.coredevice.dma",
+        "class": "CoreDMA"
+    }
+}
+
+# master peripherals
+for i in range(4):
+    device_db["led" + str(i)] = {
+        "type": "local",
+        "module": "artiq.coredevice.ttl",
+        "class": "TTLOut",
+        "arguments": {"channel": i},
+}
+
+# DEST#1 peripherals
+amc_base = 0x070000
+rtm_base = 0x020000
+
+for i in range(4):
+    device_db["led" + str(4+i)] = {
+        "type": "local",
+        "module": "artiq.coredevice.ttl",
+        "class": "TTLOut",
+        "arguments": {"channel": amc_base + i},
+    }
+
+#DIO (EEM0) starting at RTIO channel 0x000056
+for i in range(8):
+    device_db["ttl" + str(i)] = {
+        "type": "local",
+        "module": "artiq.coredevice.ttl",
+        "class": "TTLOut",
+        "arguments": {"channel": amc_base + 0x000056 + i},
+    }
+
+#DIO (EEM1) starting at RTIO channel 0x00005e
+for i in range(8):
+    device_db["ttl" + str(8+i)] = {
+        "type": "local",
+        "module": "artiq.coredevice.ttl",
+        "class": "TTLOut",
+        "arguments": {"channel": amc_base + 0x00005e + i},
+    }
+
+device_db["fmcdio_dirctl_clk"] = {
+    "type": "local",
+    "module": "artiq.coredevice.ttl",
+    "class": "TTLOut",
+    "arguments": {"channel": amc_base + 0x000066}
+}
+
+device_db["fmcdio_dirctl_ser"] = {
+    "type": "local",
+    "module": "artiq.coredevice.ttl",
+    "class": "TTLOut",
+    "arguments": {"channel": amc_base + 0x000067}
+}
+
+device_db["fmcdio_dirctl_latch"] = {
+    "type": "local",
+    "module": "artiq.coredevice.ttl",
+    "class": "TTLOut",
+    "arguments": {"channel": amc_base + 0x000068}
+}
+
+device_db["fmcdio_dirctl"] = {
+    "type": "local",
+    "module": "artiq.coredevice.shiftreg",
+    "class": "ShiftReg",
+    "arguments": {"clk": "fmcdio_dirctl_clk",
+                  "ser": "fmcdio_dirctl_ser",
+                  "latch": "fmcdio_dirctl_latch"}
+}

artiq/examples/metlino_sayma_ttl/repository/demo.py

@@ -0,0 +1,134 @@
+import sys
+import os
+import select
+
+from artiq.experiment import *
+from artiq.coredevice.fmcdio_vhdci_eem import *
+
+
+def chunker(seq, size):
+    res = []
+    for el in seq:
+        res.append(el)
+        if len(res) == size:
+            yield res
+            res = []
+    if res:
+        yield res
+
+
+def is_enter_pressed() -> TBool:
+    if os.name == "nt":
+        if msvcrt.kbhit() and msvcrt.getch() == b"\r":
+            return True
+        else:
+            return False
+    else:
+        if select.select([sys.stdin, ], [], [], 0.0)[0]:
+            sys.stdin.read(1)
+            return True
+        else:
+            return False
+
+
+class Demo(EnvExperiment):
+    def build(self):
+        self.setattr_device("core")
+        self.setattr_device("fmcdio_dirctl")
+
+        self.leds = dict()
+        self.ttl_outs = dict()
+
+        ddb = self.get_device_db()
+        for name, desc in ddb.items():
+            if isinstance(desc, dict) and desc["type"] == "local":
+                module, cls = desc["module"], desc["class"]
+                if (module, cls) == ("artiq.coredevice.ttl", "TTLOut"):
+                    dev = self.get_device(name)
+                    if "led" in name:   # guess
+                        self.leds[name] = dev
+                    elif "ttl" in name: # to exclude fmcdio_dirctl
+                        self.ttl_outs[name] = dev
+
+        self.leds = sorted(self.leds.items(), key=lambda x: x[1].channel)
+        self.ttl_outs = sorted(self.ttl_outs.items(), key=lambda x: x[1].channel)
+
+        self.dirctl_word = (
+            shiftreg_bits(0, dio_bank0_out_pins | dio_bank1_out_pins) |
+            shiftreg_bits(1, dio_bank0_out_pins | dio_bank1_out_pins)
+        )
+
+    @kernel
+    def drtio_is_up(self, drtio_index):
+        if not self.core.get_rtio_destination_status(drtio_index):
+            return False
+        print("DRTIO #", drtio_index, "is ready\n")
+        return True
+
+    @kernel
+    def test_led(self, led):
+        while not is_enter_pressed():
+            self.core.break_realtime()
+            # do not fill the FIFOs too much to avoid long response times
+            t = now_mu() - self.core.seconds_to_mu(0.2)
+            while self.core.get_rtio_counter_mu() < t:
+                pass
+            for i in range(3):
+                led.pulse(100*ms)
+                delay(100*ms)
+
+    @kernel
+    def test_leds(self):
+        print("*** Testing LEDs.")
+        print("Check for blinking. Press ENTER when done.")
+
+        for i in range(len(self.leds)):
+            led = self.leds[i:i+1]
+            print("Testing LED:", i)
+            self.test_led([dev for _, dev in led][0])
+
+    @kernel
+    def test_ttl_out_chunk(self, ttl_chunk):
+        while not is_enter_pressed():
+            self.core.break_realtime()
+            for _ in range(50000):
+                i = 0
+                for ttl in ttl_chunk:
+                    i += 1
+                    for _ in range(i):
+                        ttl.pulse(1*us)
+                        delay(1*us)
+                    delay(10*us)
+
+    @kernel
+    def test_ttl_outs(self):
+        print("*** Testing TTL outputs.")
+        print("Outputs are tested in groups of 4. Touch each TTL connector")
+        print("with the oscilloscope probe tip, and check that the number of")
+        print("pulses corresponds to its number in the group.")
+        print("Press ENTER when done.")
+
+        # for ttl_chunk in chunker(self.ttl_outs, 4):
+        for i in range(len(self.ttl_outs) // 4):
+            chunk_start, chunk_end = i*4, (i+1)*4
+            ttl_chunk = self.ttl_outs[chunk_start:chunk_end]
+            print("Testing TTL outputs:", chunk_start, chunk_start+1, chunk_start+2, chunk_start+3)
+            self.test_ttl_out_chunk([dev for _, dev in ttl_chunk])
+
+    @kernel
+    def run(self):
+        self.core.reset()
+        delay(10*ms)
+        print("*** Waiting for DRTIO ready...")
+        drtio_indices = [7]
+        for i in drtio_indices:
+            while not self.drtio_is_up(i):
+                pass
+
+        self.fmcdio_dirctl.set(self.dirctl_word)
+        delay(10*ms)
+
+        if self.leds:
+            self.test_leds()
+        if self.ttl_outs:
+            self.test_ttl_outs()