2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2018 Stefan BrĂ¼ns <stefan.bruens@rwth-aachen.de>
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 PIN_DATA, PIN_RESET = range(2)
23 ROW_EDGE, ROW_WORD, ROW_RESET = range(3)
25 class Decoder(srd.Decoder):
29 longname = 'Edge counter'
30 desc = 'Count the number of edges in a signal.'
36 {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
39 {'id': 'reset', 'name': 'Reset', 'desc': 'Reset line'},
42 ('edge_count', 'Edge count'),
43 ('word_count', 'Word count'),
44 ('word_reset', 'Word reset'),
47 ('edge_counts', 'Edges', (ROW_EDGE,)),
48 ('word_counts', 'Words', (ROW_WORD,)),
49 ('word_resets', 'Word resets', (ROW_RESET,)),
52 {'id': 'data_edge', 'desc': 'Edges to count (data)', 'default': 'any',
53 'values': ('any', 'rising', 'falling')},
54 {'id': 'divider', 'desc': 'Count divider (word width)', 'default': 0},
55 {'id': 'reset_edge', 'desc': 'Edge which clears counters (reset)',
56 'default': 'falling', 'values': ('rising', 'falling')},
57 {'id': 'edge_off', 'desc': 'Edge counter value after start/reset', 'default': 0},
58 {'id': 'word_off', 'desc': 'Word counter value after start/reset', 'default': 0},
59 {'id': 'dead_cycles', 'desc': 'Ignore this many edges after reset', 'default': 0},
60 {'id': 'start_with_reset', 'desc': 'Assume decode starts with reset',
61 'default': 'no', 'values': ('no', 'yes')},
70 def metadata(self, key, value):
71 if key == srd.SRD_CONF_SAMPLERATE:
72 self.samplerate = value
75 self.out_ann = self.register(srd.OUTPUT_ANN)
77 def putc(self, cls, ss, annlist):
78 self.put(ss, self.samplenum, self.out_ann, [cls, annlist])
81 opt_edge_map = {'rising': 'r', 'falling': 'f', 'any': 'e'}
83 data_edge = self.options['data_edge']
84 divider = self.options['divider']
87 reset_edge = self.options['reset_edge']
89 condition = [{PIN_DATA: opt_edge_map[data_edge]}]
90 have_reset = self.has_channel(PIN_RESET)
92 cond_reset = len(condition)
93 condition.append({PIN_RESET: opt_edge_map[reset_edge]})
95 edge_count = int(self.options['edge_off'])
97 word_count = int(self.options['word_off'])
100 if self.options['start_with_reset'] == 'yes':
101 dead_count = int(self.options['dead_cycles'])
109 if have_reset and self.matched[cond_reset]:
110 edge_count = int(self.options['edge_off'])
112 word_count = int(self.options['word_off'])
114 self.putc(ROW_RESET, now, ['Word reset', 'Reset', 'Rst', 'R'])
115 dead_count = int(self.options['dead_cycles'])
124 # Implementation note: In the absence of a RESET condition
125 # before the first data edge, any arbitrary choice of where
126 # to start the annotation is valid. One may choose to emit a
127 # narrow annotation (where ss=es), or assume that the cycle
128 # which corresponds to the counter value started at sample
129 # number 0. We decided to go with the latter here, to avoid
130 # narrow annotations (see bug #1210). None of this matters in
131 # the presence of a RESET condition in the input stream.
132 if edge_start is None:
134 if word_start is None:
138 self.putc(ROW_EDGE, edge_start, ["{:d}".format(edge_count)])
141 word_edge_count = edge_count - int(self.options['edge_off'])
142 if divider and (word_edge_count % divider) == 0:
144 self.putc(ROW_WORD, word_start, ["{:d}".format(word_count)])