2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
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.
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.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
20 import sigrokdecode as srd
22 # Helper dictionary for edge detection.
24 'rising': lambda x, y: bool(not x and y),
25 'falling': lambda x, y: bool(x and not y),
26 'both': lambda x, y: bool(x ^ y),
29 class SamplerateError(Exception):
32 class Decoder(srd.Decoder):
36 longname = 'Timing jitter calculation'
37 desc = 'Retrieves the timing jitter between two digital signals.'
42 {'id': 'clk', 'name': 'Clock', 'desc': 'Clock reference channel'},
43 {'id': 'sig', 'name': 'Resulting signal', 'desc': 'Resulting signal controlled by the clock'},
46 {'id': 'clk_polarity', 'desc': 'Clock edge polarity',
47 'default': 'rising', 'values': ('rising', 'falling', 'both')},
48 {'id': 'sig_polarity', 'desc': 'Resulting signal edge polarity',
49 'default': 'rising', 'values': ('rising', 'falling', 'both')},
52 ('jitter', 'Jitter value'),
53 ('clk_missed', 'Clock missed'),
54 ('sig_missed', 'Signal missed'),
57 ('jitter', 'Jitter values', (0,)),
58 ('clk_missed', 'Clock missed', (1,)),
59 ('sig_missed', 'Signal missed', (2,)),
62 ('ascii-float', 'Jitter values as newline-separated ASCII floats'),
67 self.samplerate = None
68 self.oldclk, self.oldsig = 0, 0
75 self.clk_edge = edge_detector[self.options['clk_polarity']]
76 self.sig_edge = edge_detector[self.options['sig_polarity']]
77 self.out_ann = self.register(srd.OUTPUT_ANN)
78 self.out_binary = self.register(srd.OUTPUT_BINARY)
79 self.out_clk_missed = self.register(srd.OUTPUT_META,
80 meta=(int, 'Clock missed', 'Clock transition missed'))
81 self.out_sig_missed = self.register(srd.OUTPUT_META,
82 meta=(int, 'Signal missed', 'Resulting signal transition missed'))
84 def metadata(self, key, value):
85 if key == srd.SRD_CONF_SAMPLERATE:
86 self.samplerate = value
88 # Helper function for jitter time annotations.
89 def putx(self, delta):
91 if delta == 0 or delta >= 1:
92 delta_s = '%.1fs' % (delta)
94 delta_s = '%.1ffs' % (delta * 1e15)
96 delta_s = '%.1fps' % (delta * 1e12)
98 delta_s = '%.1fns' % (delta * 1e9)
100 delta_s = '%.1fμs' % (delta * 1e6)
102 delta_s = '%.1fms' % (delta * 1e3)
104 self.put(self.clk_start, self.sig_start, self.out_ann, [0, [delta_s]])
106 # Helper function for ASCII float jitter values (one value per line).
107 def putb(self, delta):
110 # Format the delta to an ASCII float value terminated by a newline.
111 x = str(delta) + '\n'
112 self.put(self.clk_start, self.sig_start, self.out_binary,
113 [0, x.encode('UTF-8')])
115 # Helper function for missed clock and signal annotations.
116 def putm(self, data):
117 self.put(self.samplenum, self.samplenum, self.out_ann, data)
119 def handle_clk(self, clk, sig):
120 if self.clk_start == self.samplenum:
121 # Clock transition already treated.
122 # We have done everything we can with this sample.
125 if self.clk_edge(self.oldclk, clk):
127 # We note the sample and move to the next state.
128 self.clk_start = self.samplenum
132 if self.sig_start is not None \
133 and self.sig_start != self.samplenum \
134 and self.sig_edge(self.oldsig, sig):
135 # If any transition in the resulting signal
136 # occurs while we are waiting for a clock,
137 # we increase the missed signal counter.
139 self.put(self.samplenum, self.samplenum, self.out_sig_missed, self.sig_missed)
140 self.putm([2, ['Missed signal', 'MS']])
141 # No clock edge found, we have done everything we
142 # can with this sample.
145 def handle_sig(self, clk, sig):
146 if self.sig_start == self.samplenum:
147 # Signal transition already treated.
148 # We have done everything we can with this sample.
151 if self.sig_edge(self.oldsig, sig):
153 # We note the sample, calculate the jitter
154 # and move to the next state.
155 self.sig_start = self.samplenum
157 # Calculate and report the timing jitter.
158 delta = (self.sig_start - self.clk_start) / self.samplerate
163 if self.clk_start != self.samplenum \
164 and self.clk_edge(self.oldclk, clk):
165 # If any transition in the clock signal
166 # occurs while we are waiting for a resulting
167 # signal, we increase the missed clock counter.
169 self.put(self.samplenum, self.samplenum, self.out_clk_missed, self.clk_missed)
170 self.putm([1, ['Missed clock', 'MC']])
171 # No resulting signal edge found, we have done
172 # everything we can with this sample.
176 if not self.samplerate:
177 raise SamplerateError('Cannot decode without samplerate.')
179 # Wait for a transition on CLK and/or SIG.
180 clk, sig = self.wait([{0: 'e'}, {1: 'e'}])
183 # For each sample we can move 2 steps forward in the state machine.
185 # Clock state has the lead.
186 if self.state == 'CLK':
187 if self.handle_clk(clk, sig):
189 if self.state == 'SIG':
190 if self.handle_sig(clk, sig):
193 # Save current CLK/SIG values for the next round.
194 self.oldclk, self.oldsig = clk, sig