]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/tlc5620/pd.py
tlc5620: Handle the case of less than 11 bits in a command.
[libsigrokdecode.git] / decoders / tlc5620 / pd.py
index 2a407d1687cc288a15349544a94107af5f1518fe..e086c4d811dd527659437b6a0744a60409ce07cf 100644 (file)
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2015 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -50,62 +50,121 @@ class Decoder(srd.Decoder):
         ('value', 'DAC value'),
         ('data-latch', 'Data latch point'),
         ('ldac-fall', 'LDAC falling edge'),
+        ('bit', 'Bit'),
+        ('reg-write', 'Register write'),
+        ('voltage-update', 'Voltage update'),
+        ('voltage-update-all', 'Voltage update (all DACs)'),
+        ('invalid-cmd', 'Invalid command'),
+    )
+    annotation_rows = (
+        ('bits', 'Bits', (5,)),
+        ('fields', 'Fields', (0, 1, 2)),
+        ('registers', 'Registers', (6, 7)),
+        ('voltage-updates', 'Voltage updates', (8,)),
+        ('events', 'Events', (3, 4)),
+        ('errors', 'Errors', (9,)),
     )
 
     def __init__(self, **kwargs):
         self.oldpins = self.oldclk = self.oldload = self.oldldac = None
-        self.datapin = None
         self.bits = []
+        self.ss_dac_first = None
         self.ss_dac = self.es_dac = 0
         self.ss_gain = self.es_gain = 0
         self.ss_value = self.es_value = 0
         self.dac_select = self.gain = self.dac_value = None
+        self.dacval = {'A': '?', 'B': '?', 'C': '?', 'D': '?'}
 
     def start(self):
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
     def handle_11bits(self):
-        s = ''.join(str(i) for i in self.bits[:2])
+        # Only look at the last 11 bits, the rest is ignored by the TLC5620.
+        if len(self.bits) > 11:
+            self.bits = self.bits[-11:]
+
+        # If there are less than 11 bits, something is probably wrong.
+        if len(self.bits) < 11:
+            ss, es = self.samplenum, self.samplenum
+            if len(self.bits) >= 2:
+                ss = self.bits[0][1]
+                es = self.bits[-1][1] + (self.bits[1][1] - self.bits[0][1])
+            self.put(ss, es, self.out_ann, [9, ['Command too short']])
+            self.bits = []
+            return False
+
+        self.ss_dac = self.bits[0][1]
+        self.es_dac = self.ss_gain = self.bits[2][1]
+        self.es_gain = self.ss_value = self.bits[3][1]
+        self.clock_width = self.es_gain - self.ss_gain
+        self.es_value = self.bits[10][1] + self.clock_width # Guessed.
+
+        if self.ss_dac_first is None:
+            self.ss_dac_first = self.ss_dac
+
+        s = ''.join(str(i[0]) for i in self.bits[:2])
         self.dac_select = s = dacs[int(s, 2)]
         self.put(self.ss_dac, self.es_dac, self.out_ann,
                  [0, ['DAC select: %s' % s, 'DAC sel: %s' % s,
                       'DAC: %s' % s, 'D: %s' % s, s, s[3]]])
 
-        self.gain = g = 1 + self.bits[2]
+        self.gain = g = 1 + self.bits[2][0]
         self.put(self.ss_gain, self.es_gain, self.out_ann,
                  [1, ['Gain: x%d' % g, 'G: x%d' % g, 'x%d' % g]])
 
-        s = ''.join(str(i) for i in self.bits[3:])
+        s = ''.join(str(i[0]) for i in self.bits[3:])
         self.dac_value = v = int(s, 2)
         self.put(self.ss_value, self.es_value, self.out_ann,
                  [2, ['DAC value: %d' % v, 'Value: %d' % v, 'Val: %d' % v,
                       'V: %d' % v, '%d' % v]])
 
+        # Emit an annotation for each bit.
+        for i in range(1, 11):
+            self.put(self.bits[i - 1][1], self.bits[i][1], self.out_ann,
+                     [5, [str(self.bits[i - 1][0])]])
+        self.put(self.bits[10][1], self.bits[10][1] + self.clock_width,
+                 self.out_ann, [5, [str(self.bits[10][0])]])
+
+        self.bits = []
+
+        return True
+
     def handle_falling_edge_load(self):
+        if not self.handle_11bits():
+            return
         s, v, g = self.dac_select, self.dac_value, self.gain
         self.put(self.samplenum, self.samplenum, self.out_ann,
-                 [3, ['Setting %s value to %d (x%d gain)' % (s, v, g),
-                      '%s=%d (x%d gain)' % (s, v, g)]])
+                 [3, ['Falling edge on LOAD', 'LOAD fall', 'F']])
+        if self.ldac == 0:
+            # If LDAC is low, the voltage is set immediately.
+            self.put(self.ss_dac, self.es_value, self.out_ann,
+                     [7, ['Setting %s voltage to %d (x%d gain)' % (s, v, g),
+                          '%s=%d (x%d gain)' % (s, v, g)]])
+        else:
+            # If LDAC is high, the voltage is not set immediately, but rather
+            # stored in a register. When LDAC goes low all four DAC voltages
+            # (DAC A/B/C/D) will be set at the same time.
+            self.put(self.ss_dac, self.es_value, self.out_ann,
+                     [6, ['Setting %s register value to %d (x%d gain)' % \
+                          (s, v, g), '%s=%d (x%d gain)' % (s, v, g)]])
+        # Save the last value the respective DAC was set to.
+        self.dacval[self.dac_select[-1]] = str(self.dac_value)
 
     def handle_falling_edge_ldac(self):
         self.put(self.samplenum, self.samplenum, self.out_ann,
-                 [4, ['Falling edge on LDAC pin', 'LDAC fall', 'LDAC']])
+                 [4, ['Falling edge on LDAC', 'LDAC fall', 'LDAC', 'L']])
+
+        # Don't emit any annotations if we didn't see any register writes.
+        if self.ss_dac_first is None:
+            return
+
+        s = ''.join(['DAC%s=%s ' % (d, self.dacval[d]) for d in 'ABCD']).strip()
+        self.put(self.ss_dac_first, self.samplenum, self.out_ann,
+                 [8, ['Updating voltages: %s' % s, s, s.replace('DAC', '')]])
+        self.ss_dac_first = None
 
     def handle_new_dac_bit(self):
-        self.bits.append(self.datapin)
-
-        # Wait until we have read 11 bits, then parse them.
-        l, s = len(self.bits), self.samplenum
-        if l == 1:
-            self.ss_dac = s
-        elif l == 2:
-            self.es_dac = self.ss_gain = s
-        elif l == 3:
-            self.es_gain = self.ss_value = s
-        elif l == 11:
-            self.es_value = s
-            self.handle_11bits()
-            self.bits = []
+        self.bits.append([self.datapin, self.samplenum])
 
     def decode(self, ss, es, data):
         for (self.samplenum, pins) in data:
@@ -114,6 +173,7 @@ class Decoder(srd.Decoder):
             if self.oldpins == pins:
                 continue
             self.oldpins, (clk, self.datapin, load, ldac) = pins, pins
+            self.ldac = ldac
 
             # DATA is shifted in the DAC on the falling CLK edge (MSB-first).
             # A falling edge of LOAD will latch the data.