]>
Commit | Line | Data |
---|---|---|
92adde51 BE |
1 | ## |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2014 Torsten Duwe <duwe@suse.de> | |
5 | ## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com> | |
6 | ## | |
7 | ## This program is free software; you can redistribute it and/or modify | |
8 | ## it under the terms of the GNU General Public License as published by | |
9 | ## the Free Software Foundation; either version 2 of the License, or | |
10 | ## (at your option) any later version. | |
11 | ## | |
12 | ## This program is distributed in the hope that it will be useful, | |
13 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | ## GNU General Public License for more details. | |
16 | ## | |
17 | ## You should have received a copy of the GNU General Public License | |
4539e9ca | 18 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
92adde51 BE |
19 | ## |
20 | ||
21 | import sigrokdecode as srd | |
2cd9b197 | 22 | from collections import deque |
92adde51 BE |
23 | |
24 | class SamplerateError(Exception): | |
25 | pass | |
26 | ||
27 | def normalize_time(t): | |
a9360134 | 28 | if abs(t) >= 1.0: |
2cd9b197 | 29 | return '%.3f s (%.3f Hz)' % (t, (1/t)) |
a9360134 | 30 | elif abs(t) >= 0.001: |
2cd9b197 UH |
31 | if 1/t/1000 < 1: |
32 | return '%.3f ms (%.3f Hz)' % (t * 1000.0, (1/t)) | |
33 | else: | |
34 | return '%.3f ms (%.3f kHz)' % (t * 1000.0, (1/t)/1000) | |
a9360134 | 35 | elif abs(t) >= 0.000001: |
2cd9b197 UH |
36 | if 1/t/1000/1000 < 1: |
37 | return '%.3f μs (%.3f kHz)' % (t * 1000.0 * 1000.0, (1/t)/1000) | |
38 | else: | |
39 | return '%.3f μs (%.3f MHz)' % (t * 1000.0 * 1000.0, (1/t)/1000/1000) | |
a9360134 | 40 | elif abs(t) >= 0.000000001: |
2cd9b197 UH |
41 | if 1/t/1000/1000/1000: |
42 | return '%.3f ns (%.3f MHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000) | |
43 | else: | |
44 | return '%.3f ns (%.3f GHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000/1000) | |
92adde51 BE |
45 | else: |
46 | return '%f' % t | |
47 | ||
7e09e39c GS |
48 | def terse_times(t): |
49 | if abs(t) >= 1e0: | |
50 | t *= 1e0 | |
51 | return ['{:.0f}s'.format(t), '{:.0f}'.format(t)] | |
52 | if abs(t) >= 1e-3: | |
53 | t *= 1e3 | |
54 | return ['{:.0f}ms'.format(t), '{:.0f}'.format(t)] | |
55 | if abs(t) >= 1e-6: | |
56 | t *= 1e6 | |
57 | return ['{:.0f}us'.format(t), '{:.0f}'.format(t)] | |
58 | if abs(t) >= 1e-9: | |
59 | t *= 1e9 | |
60 | return ['{:.0f}ns'.format(t), '{:.0f}'.format(t)] | |
61 | return ['{:f}'.format(t = t)] | |
62 | ||
6a1b97e6 GS |
63 | class Pin: |
64 | (DATA,) = range(1) | |
65 | ||
66 | class Ann: | |
7e09e39c | 67 | (TIME, TERSE, AVG, DELTA,) = range(4) |
6a1b97e6 | 68 | |
92adde51 | 69 | class Decoder(srd.Decoder): |
831e976a | 70 | api_version = 3 |
92adde51 BE |
71 | id = 'timing' |
72 | name = 'Timing' | |
2cd9b197 | 73 | longname = 'Timing calculation with frequency and averaging' |
92adde51 BE |
74 | desc = 'Calculate time between edges.' |
75 | license = 'gplv2+' | |
76 | inputs = ['logic'] | |
6cbba91f | 77 | outputs = [] |
d6d8a8a4 | 78 | tags = ['Clock/timing', 'Util'] |
92adde51 BE |
79 | channels = ( |
80 | {'id': 'data', 'name': 'Data', 'desc': 'Data line'}, | |
81 | ) | |
82 | annotations = ( | |
83 | ('time', 'Time'), | |
7e09e39c | 84 | ('terse', 'Terse'), |
2cd9b197 | 85 | ('average', 'Average'), |
b8c44f69 | 86 | ('delta', 'Delta'), |
92adde51 BE |
87 | ) |
88 | annotation_rows = ( | |
7e09e39c | 89 | ('times', 'Times', (Ann.TIME, Ann.TERSE,)), |
6a1b97e6 GS |
90 | ('averages', 'Averages', (Ann.AVG,)), |
91 | ('deltas', 'Deltas', (Ann.DELTA,)), | |
2cd9b197 UH |
92 | ) |
93 | options = ( | |
94 | { 'id': 'avg_period', 'desc': 'Averaging period', 'default': 100 }, | |
b8c44f69 KP |
95 | { 'id': 'edge', 'desc': 'Edges to check', 'default': 'any', 'values': ('any', 'rising', 'falling') }, |
96 | { 'id': 'delta', 'desc': 'Show delta from last', 'default': 'no', 'values': ('yes', 'no') }, | |
7e09e39c | 97 | { 'id': 'terse', 'desc': 'Show periods in terse format', 'default': 'no', 'values': ('yes', 'no') }, |
92adde51 BE |
98 | ) |
99 | ||
92b7b49f | 100 | def __init__(self): |
10aeb8ea GS |
101 | self.reset() |
102 | ||
103 | def reset(self): | |
92adde51 | 104 | self.samplerate = None |
92adde51 BE |
105 | |
106 | def metadata(self, key, value): | |
107 | if key == srd.SRD_CONF_SAMPLERATE: | |
108 | self.samplerate = value | |
109 | ||
110 | def start(self): | |
111 | self.out_ann = self.register(srd.OUTPUT_ANN) | |
112 | ||
831e976a | 113 | def decode(self): |
92adde51 BE |
114 | if not self.samplerate: |
115 | raise SamplerateError('Cannot decode without samplerate.') | |
3e962c2f GS |
116 | edge = self.options['edge'] |
117 | avg_period = self.options['avg_period'] | |
74c9c926 | 118 | delta = self.options['delta'] == 'yes' |
7e09e39c | 119 | terse = self.options['terse'] == 'yes' |
c945a82d | 120 | ss = None |
3e962c2f GS |
121 | last_n = deque() |
122 | last_t = None | |
831e976a | 123 | while True: |
3e962c2f | 124 | if edge == 'rising': |
6a1b97e6 | 125 | pin = self.wait({Pin.DATA: 'r'}) |
3e962c2f | 126 | elif edge == 'falling': |
6a1b97e6 | 127 | pin = self.wait({Pin.DATA: 'f'}) |
b8c44f69 | 128 | else: |
6a1b97e6 | 129 | pin = self.wait({Pin.DATA: 'e'}) |
92adde51 | 130 | |
c945a82d GS |
131 | if not ss: |
132 | ss = self.samplenum | |
92adde51 | 133 | continue |
c945a82d GS |
134 | es = self.samplenum |
135 | samples = es - ss | |
b8c44f69 | 136 | t = samples / self.samplerate |
92adde51 | 137 | |
7e09e39c | 138 | if terse: |
74c9c926 GS |
139 | cls, txt = Ann.TERSE, terse_times(t) |
140 | self.put(ss, es, self.out_ann, [cls, txt]) | |
7e09e39c | 141 | else: |
74c9c926 GS |
142 | cls, txt = Ann.TIME, [normalize_time(t)] |
143 | self.put(ss, es, self.out_ann, [cls, txt]) | |
3e962c2f | 144 | if avg_period > 0: |
74c9c926 GS |
145 | if t > 0: |
146 | last_n.append(t) | |
147 | if len(last_n) > avg_period: | |
148 | last_n.popleft() | |
149 | average = sum(last_n) / len(last_n) | |
150 | cls, txt = Ann.AVG, normalize_time(average) | |
151 | self.put(ss, es, self.out_ann, [cls, [txt]]) | |
152 | if last_t and delta: | |
153 | cls, txt = Ann.DELTA, normalize_time(t - last_t) | |
154 | self.put(ss, es, self.out_ann, [cls, [txt]]) | |
2cd9b197 | 155 | |
3e962c2f | 156 | last_t = t |
c945a82d | 157 | ss = es |