]> sigrok.org Git - libsigrokdecode.git/blame - decoders/tlc5620/pd.py
atsha204a: Shorten self.opcode to op in a few places.
[libsigrokdecode.git] / decoders / tlc5620 / pd.py
CommitLineData
92d1aba3 1##
50bd5d25 2## This file is part of the libsigrokdecode project.
92d1aba3 3##
ce0c47f3 4## Copyright (C) 2012-2015 Uwe Hermann <uwe@hermann-uwe.de>
92d1aba3
UH
5##
6## This program is free software; you can redistribute it and/or modify
7## it under the terms of the GNU General Public License as published by
8## the Free Software Foundation; either version 2 of the License, or
9## (at your option) any later version.
10##
11## This program is distributed in the hope that it will be useful,
12## but WITHOUT ANY WARRANTY; without even the implied warranty of
13## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14## GNU General Public License for more details.
15##
16## You should have received a copy of the GNU General Public License
4539e9ca 17## along with this program; if not, see <http://www.gnu.org/licenses/>.
92d1aba3
UH
18##
19
92d1aba3
UH
20import sigrokdecode as srd
21
22dacs = {
23 0: 'DACA',
24 1: 'DACB',
25 2: 'DACC',
26 3: 'DACD',
27}
28
29class Decoder(srd.Decoder):
af495297 30 api_version = 3
92d1aba3
UH
31 id = 'tlc5620'
32 name = 'TI TLC5620'
33 longname = 'Texas Instruments TLC5620'
34 desc = 'Texas Instruments TLC5620 8-bit quad DAC.'
35 license = 'gplv2+'
36 inputs = ['logic']
37 outputs = ['tlc5620']
6a15597a 38 channels = (
92d1aba3
UH
39 {'id': 'clk', 'name': 'CLK', 'desc': 'Serial interface clock'},
40 {'id': 'data', 'name': 'DATA', 'desc': 'Serial interface data'},
da9bcbd9 41 )
6a15597a 42 optional_channels = (
92d1aba3
UH
43 {'id': 'load', 'name': 'LOAD', 'desc': 'Serial interface load control'},
44 {'id': 'ldac', 'name': 'LDAC', 'desc': 'Load DAC'},
da9bcbd9 45 )
04c310c8
UH
46 options = (
47 {'id': 'vref_a', 'desc': 'Reference voltage DACA (V)', 'default': 3.3},
48 {'id': 'vref_b', 'desc': 'Reference voltage DACB (V)', 'default': 3.3},
49 {'id': 'vref_c', 'desc': 'Reference voltage DACC (V)', 'default': 3.3},
50 {'id': 'vref_d', 'desc': 'Reference voltage DACD (V)', 'default': 3.3},
51 )
da9bcbd9
BV
52 annotations = (
53 ('dac-select', 'DAC select'),
54 ('gain', 'Gain'),
55 ('value', 'DAC value'),
56 ('data-latch', 'Data latch point'),
57 ('ldac-fall', 'LDAC falling edge'),
ce0c47f3 58 ('bit', 'Bit'),
3992b1e1
UH
59 ('reg-write', 'Register write'),
60 ('voltage-update', 'Voltage update'),
61 ('voltage-update-all', 'Voltage update (all DACs)'),
a945c536 62 ('invalid-cmd', 'Invalid command'),
ce0c47f3
UH
63 )
64 annotation_rows = (
65 ('bits', 'Bits', (5,)),
66 ('fields', 'Fields', (0, 1, 2)),
3992b1e1
UH
67 ('registers', 'Registers', (6, 7)),
68 ('voltage-updates', 'Voltage updates', (8,)),
ce0c47f3 69 ('events', 'Events', (3, 4)),
a945c536 70 ('errors', 'Errors', (9,)),
da9bcbd9 71 )
92d1aba3 72
92b7b49f 73 def __init__(self):
10aeb8ea
GS
74 self.reset()
75
76 def reset(self):
92d1aba3 77 self.bits = []
3992b1e1 78 self.ss_dac_first = None
92d1aba3
UH
79 self.ss_dac = self.es_dac = 0
80 self.ss_gain = self.es_gain = 0
81 self.ss_value = self.es_value = 0
17db4008 82 self.dac_select = self.gain = self.dac_value = None
3992b1e1 83 self.dacval = {'A': '?', 'B': '?', 'C': '?', 'D': '?'}
04c310c8 84 self.gains = {'A': '?', 'B': '?', 'C': '?', 'D': '?'}
92d1aba3 85
8915b346 86 def start(self):
be465111 87 self.out_ann = self.register(srd.OUTPUT_ANN)
92d1aba3 88
92d1aba3 89 def handle_11bits(self):
e57813d5
UH
90 # Only look at the last 11 bits, the rest is ignored by the TLC5620.
91 if len(self.bits) > 11:
92 self.bits = self.bits[-11:]
93
a945c536
UH
94 # If there are less than 11 bits, something is probably wrong.
95 if len(self.bits) < 11:
96 ss, es = self.samplenum, self.samplenum
97 if len(self.bits) >= 2:
98 ss = self.bits[0][1]
99 es = self.bits[-1][1] + (self.bits[1][1] - self.bits[0][1])
100 self.put(ss, es, self.out_ann, [9, ['Command too short']])
101 self.bits = []
102 return False
103
e57813d5
UH
104 self.ss_dac = self.bits[0][1]
105 self.es_dac = self.ss_gain = self.bits[2][1]
106 self.es_gain = self.ss_value = self.bits[3][1]
107 self.clock_width = self.es_gain - self.ss_gain
108 self.es_value = self.bits[10][1] + self.clock_width # Guessed.
109
3992b1e1
UH
110 if self.ss_dac_first is None:
111 self.ss_dac_first = self.ss_dac
112
ce0c47f3 113 s = ''.join(str(i[0]) for i in self.bits[:2])
7fb4935e 114 self.dac_select = s = dacs[int(s, 2)]
92d1aba3 115 self.put(self.ss_dac, self.es_dac, self.out_ann,
7fb4935e
UH
116 [0, ['DAC select: %s' % s, 'DAC sel: %s' % s,
117 'DAC: %s' % s, 'D: %s' % s, s, s[3]]])
92d1aba3 118
ce0c47f3 119 self.gain = g = 1 + self.bits[2][0]
92d1aba3 120 self.put(self.ss_gain, self.es_gain, self.out_ann,
7fb4935e 121 [1, ['Gain: x%d' % g, 'G: x%d' % g, 'x%d' % g]])
92d1aba3 122
ce0c47f3 123 s = ''.join(str(i[0]) for i in self.bits[3:])
7fb4935e 124 self.dac_value = v = int(s, 2)
92d1aba3 125 self.put(self.ss_value, self.es_value, self.out_ann,
7fb4935e
UH
126 [2, ['DAC value: %d' % v, 'Value: %d' % v, 'Val: %d' % v,
127 'V: %d' % v, '%d' % v]])
17db4008 128
ce0c47f3
UH
129 # Emit an annotation for each bit.
130 for i in range(1, 11):
131 self.put(self.bits[i - 1][1], self.bits[i][1], self.out_ann,
132 [5, [str(self.bits[i - 1][0])]])
133 self.put(self.bits[10][1], self.bits[10][1] + self.clock_width,
134 self.out_ann, [5, [str(self.bits[10][0])]])
135
e57813d5
UH
136 self.bits = []
137
a945c536
UH
138 return True
139
17db4008 140 def handle_falling_edge_load(self):
a945c536
UH
141 if not self.handle_11bits():
142 return
7fb4935e 143 s, v, g = self.dac_select, self.dac_value, self.gain
17db4008 144 self.put(self.samplenum, self.samplenum, self.out_ann,
ce0c47f3 145 [3, ['Falling edge on LOAD', 'LOAD fall', 'F']])
04c310c8
UH
146 vref = self.options['vref_%s' % self.dac_select[3].lower()]
147 v = '%.2fV' % (vref * (v / 256) * self.gain)
3992b1e1
UH
148 if self.ldac == 0:
149 # If LDAC is low, the voltage is set immediately.
150 self.put(self.ss_dac, self.es_value, self.out_ann,
04c310c8
UH
151 [7, ['Setting %s voltage to %s' % (s, v),
152 '%s=%s' % (s, v)]])
3992b1e1
UH
153 else:
154 # If LDAC is high, the voltage is not set immediately, but rather
155 # stored in a register. When LDAC goes low all four DAC voltages
156 # (DAC A/B/C/D) will be set at the same time.
157 self.put(self.ss_dac, self.es_value, self.out_ann,
04c310c8
UH
158 [6, ['Setting %s register value to %s' % \
159 (s, v), '%s=%s' % (s, v)]])
3992b1e1
UH
160 # Save the last value the respective DAC was set to.
161 self.dacval[self.dac_select[-1]] = str(self.dac_value)
04c310c8 162 self.gains[self.dac_select[-1]] = self.gain
17db4008
UH
163
164 def handle_falling_edge_ldac(self):
165 self.put(self.samplenum, self.samplenum, self.out_ann,
ce0c47f3 166 [4, ['Falling edge on LDAC', 'LDAC fall', 'LDAC', 'L']])
17db4008 167
3992b1e1
UH
168 # Don't emit any annotations if we didn't see any register writes.
169 if self.ss_dac_first is None:
170 return
171
04c310c8
UH
172 # Calculate voltages based on Vref and the per-DAC gain.
173 dacval = {}
174 for key, val in self.dacval.items():
175 if val == '?':
176 dacval[key] = '?'
177 else:
178 vref = self.options['vref_%s' % key.lower()]
179 v = vref * (int(val) / 256) * self.gains[key]
180 dacval[key] = '%.2fV' % v
181
182 s = ''.join(['DAC%s=%s ' % (d, dacval[d]) for d in 'ABCD']).strip()
3992b1e1
UH
183 self.put(self.ss_dac_first, self.samplenum, self.out_ann,
184 [8, ['Updating voltages: %s' % s, s, s.replace('DAC', '')]])
185 self.ss_dac_first = None
186
af495297
UH
187 def handle_new_dac_bit(self, datapin):
188 self.bits.append([datapin, self.samplenum])
92d1aba3 189
af495297
UH
190 def decode(self):
191 while True:
92d1aba3 192 # DATA is shifted in the DAC on the falling CLK edge (MSB-first).
17db4008 193 # A falling edge of LOAD will latch the data.
92d1aba3 194
af495297
UH
195 # Wait for one (or multiple) of the following conditions:
196 # a) Falling edge on CLK, and/or
197 # b) Falling edge on LOAD, and/or
198 # b) Falling edge on LDAC
199 pins = self.wait([{0: 'f'}, {2: 'f'}, {3: 'f'}])
200 self.ldac = pins[3]
201
202 # Handle those conditions (one or more) that matched this time.
203 if self.matched[0]:
204 self.handle_new_dac_bit(pins[1])
205 if self.matched[1]:
17db4008 206 self.handle_falling_edge_load()
af495297 207 if self.matched[2]:
17db4008 208 self.handle_falling_edge_ldac()