696c8e9f4ec1c82d32918c69d28fccc65737ced6
[libsigrokdecode.git] / decoders / counter / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2018 Stefan BrĂ¼ns <stefan.bruens@rwth-aachen.de>
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
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
18 ##
19
20 import sigrokdecode as srd
21
22 (PIN_DATA, PIN_RESET) = range(2)
23 (ROW_EDGE, ROW_WORD, ROW_RESET) = range(3)
24
25 class Decoder(srd.Decoder):
26     api_version = 3
27     id = 'counter'
28     name = 'Counter'
29     longname = 'Edge counter'
30     desc = 'Count number of edges.'
31     license = 'gplv2+'
32     inputs = ['logic']
33     outputs = []
34     channels = (
35         {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
36     )
37     optional_channels = (
38         {'id': 'reset', 'name': 'Reset', 'desc': 'Reset line'},
39     )
40     annotations = (
41         ('edge_count', 'Edge count'),
42         ('word_count', 'Word count'),
43         ('word_reset', 'Word reset'),
44     )
45     annotation_rows = (
46         ('edge_counts', 'Edges', (ROW_EDGE,)),
47         ('word_counts', 'Words', (ROW_WORD,)),
48         ('word_resets', 'Word resets', (ROW_RESET,)),
49     )
50     options = (
51         {'id': 'data_edge', 'desc': 'Edges to count (data)', 'default': 'any',
52             'values': ('any', 'rising', 'falling')},
53         {'id': 'divider', 'desc': 'Count divider (word width)', 'default': 0},
54         {'id': 'reset_edge', 'desc': 'Edge which clears counters (reset)',
55             'default': 'falling', 'values': ('rising', 'falling')},
56     )
57
58     def __init__(self):
59         self.reset()
60
61     def reset(self):
62         self.edge_count = 0
63         self.word_count = 0
64         self.have_reset = None
65
66     def metadata(self, key, value):
67         if key == srd.SRD_CONF_SAMPLERATE:
68             self.samplerate = value
69
70     def start(self):
71         self.out_ann = self.register(srd.OUTPUT_ANN)
72         self.edge = self.options['data_edge']
73         self.divider = self.options['divider']
74         if self.divider < 0:
75             self.divider = 0
76
77     def putc(self, cls, annlist):
78         self.put(self.samplenum, self.samplenum, self.out_ann, [cls, annlist])
79
80     def decode(self):
81         opt_edge_map = {'rising': 'r', 'falling': 'f', 'any': 'e'}
82
83         condition = [{PIN_DATA: opt_edge_map[self.edge]}]
84         self.have_reset = self.has_channel(PIN_RESET)
85         if self.have_reset:
86             cond_reset = len(condition)
87             condition.append({PIN_RESET: opt_edge_map[self.options['reset_edge']]})
88
89         while True:
90             self.wait(condition)
91
92             if self.have_reset and self.matched[cond_reset]:
93                 self.edge_count = 0
94                 self.word_count = 0
95                 self.putc(ROW_RESET, ['Word reset', 'Reset', 'Rst', 'R'])
96                 continue
97
98             self.edge_count += 1
99             self.putc(ROW_EDGE, [str(self.edge_count)])
100
101             if self.divider > 0 and (self.edge_count % self.divider) == 0:
102                 self.word_count += 1
103                 self.putc(ROW_WORD, [str(self.word_count)])