From a2fbcb8bfd64d5d97ba37b16b501aa99a0fb3bfb Mon Sep 17 00:00:00 2001
From: occheung <dc@m-labs.hk>
Date: Mon, 18 Sep 2023 23:19:21 -0700
Subject: [PATCH] pre-dac gain/offsets: detect overflow & underflow

And output maximum / minimum DAC code when over/underflow
---
 artiq/gateware/shuttler.py | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/artiq/gateware/shuttler.py b/artiq/gateware/shuttler.py
index 1eb2221bf..c6da201e5 100644
--- a/artiq/gateware/shuttler.py
+++ b/artiq/gateware/shuttler.py
@@ -111,6 +111,9 @@ class Dac(Module):
         self.gain = Signal(16)
         self.offset = Signal(16)
 
+        overflow = Signal()
+        underflow = Signal()
+
         ###
 
         subs = [
@@ -120,12 +123,25 @@ class Dac(Module):
 
         # Infer signed multiplication
         data_raw = Signal((14, True))
-        data_buf = Signal(14)
+        data_buf = Signal(16)
         self.sync.rio += [
             data_raw.eq(reduce(add, [sub.data for sub in subs])),
-            # Extra buffer for better DSP timing
+            # Extra buffer for timing for the DSP
             data_buf.eq(((data_raw * Cat(self.gain, ~self.gain[-1])) + (self.offset << 16))[16:]),
-            self.data.eq(data_buf),
+            If(overflow,
+                self.data.eq(0x1fff),
+            ).Elif(underflow,
+                self.data.eq(0x2000),
+            ).Else(
+                self.data.eq(data_buf),
+            ),
+        ]
+
+        self.comb += [
+            # Overflow condition
+            overflow.eq(~data_buf[-1] & (data_buf[-2] | data_buf[-3])),
+            # Underflow condition
+            underflow.eq(data_buf[-1] & (~data_buf[-2] | ~data_buf[-3])),
         ]
 
         self.i = [ sub.i for sub in subs ]