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         {'id': 'edge_off', 'desc': 'Edge counter value after start/reset', 'default': 0},
  57         {'id': 'word_off', 'desc': 'Word counter value after start/reset', 'default': 0},
  58         {'id': 'dead_cycles', 'desc': 'Ignore this many edges after reset', 'default': 0},
  59     )
  60
  61     def __init__(self):
  62         self.reset()
  63
  64     def reset(self):
  65         pass
  66
  67     def metadata(self, key, value):
  68         if key == srd.SRD_CONF_SAMPLERATE:
  69             self.samplerate = value
  70
  71     def start(self):
  72         self.out_ann = self.register(srd.OUTPUT_ANN)
  73
  74     def putc(self, cls, ss, annlist):
  75         self.put(ss, self.samplenum, self.out_ann, [cls, annlist])
  76
  77     def decode(self):
  78         opt_edge_map = {'rising': 'r', 'falling': 'f', 'any': 'e'}
  79
  80         data_edge = self.options['data_edge']
  81         divider = self.options['divider']
  82         if divider < 0:
  83             divider = 0
  84         reset_edge = self.options['reset_edge']
  85
  86         condition = [{PIN_DATA: opt_edge_map[data_edge]}]
  87         have_reset = self.has_channel(PIN_RESET)
  88         if have_reset:
  89             cond_reset = len(condition)
  90             condition.append({PIN_RESET: opt_edge_map[reset_edge]})
  91
  92         edge_count = int(self.options['edge_off'])
  93         edge_start = None
  94         word_count = int(self.options['word_off'])
  95         word_start = None
  96         dead_count = 0
  97         while True:
  98             self.wait(condition)
  99             now = self.samplenum
 100
 101             if have_reset and self.matched[cond_reset]:
 102                 edge_count = int(self.options['edge_off'])
 103                 edge_start = now
 104                 word_count = int(self.options['word_off'])
 105                 word_start = now
 106                 self.putc(ROW_RESET, now, ['Word reset', 'Reset', 'Rst', 'R'])
 107                 dead_count = int(self.options['dead_cycles'])
 108                 continue
 109
 110             if dead_count:
 111                 dead_count -= 1
 112                 edge_start = now
 113                 word_start = now
 114                 continue
 115
 116             # Implementation note: In the absence of a RESET condition
 117             # before the first data edge, any arbitrary choice of where
 118             # to start the annotation is valid. One may choose to emit a
 119             # narrow annotation (where ss=es), or assume that the cycle
 120             # which corresponds to the counter value started at sample
 121             # number 0. We decided to go with the latter here, to avoid
 122             # narrow annotations (see bug #1210). None of this matters in
 123             # the presence of a RESET condition in the input stream.
 124             if edge_start is None:
 125                 edge_start = 0
 126             if word_start is None:
 127                 word_start = 0
 128
 129             edge_count += 1
 130             self.putc(ROW_EDGE, edge_start, ["{:d}".format(edge_count)])
 131             edge_start = now
 132
 133             if divider and (edge_count % divider) == 0:
 134                 word_count += 1
 135                 self.putc(ROW_WORD, word_start, ["{:d}".format(word_count)])
 136                 word_start = now