decoders/parallel/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2013-2016 Uwe Hermann <uwe@hermann-uwe.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 from common.srdhelper import bitpack
  22
  23 '''
  24 OUTPUT_PYTHON format:
  25
  26 Packet:
  27 [<ptype>, <pdata>]
  28
  29 <ptype>, <pdata>
  30  - 'ITEM', [<item>, <itembitsize>]
  31  - 'WORD', [<word>, <wordbitsize>, <worditemcount>]
  32
  33 <item>:
  34  - A single item (a number). It can be of arbitrary size. The max. number
  35    of bits in this item is specified in <itembitsize>.
  36
  37 <itembitsize>:
  38  - The size of an item (in bits). For a 4-bit parallel bus this is 4,
  39    for a 16-bit parallel bus this is 16, and so on.
  40
  41 <word>:
  42  - A single word (a number). It can be of arbitrary size. The max. number
  43    of bits in this word is specified in <wordbitsize>. The (exact) number
  44    of items in this word is specified in <worditemcount>.
  45
  46 <wordbitsize>:
  47  - The size of a word (in bits). For a 2-item word with 8-bit items
  48    <wordbitsize> is 16, for a 3-item word with 4-bit items <wordbitsize>
  49    is 12, and so on.
  50
  51 <worditemcount>:
  52  - The size of a word (in number of items). For a 4-item word (no matter
  53    how many bits each item consists of) <worditemcount> is 4, for a 7-item
  54    word <worditemcount> is 7, and so on.
  55 '''
  56
  57 NUM_CHANNELS = 8
  58
  59 class Pin:
  60     CLOCK = 0
  61     DATA_0 = CLOCK + 1
  62     DATA_N = DATA_0 + NUM_CHANNELS
  63     # BEWARE! DATA_N points _beyond_ the data partition (Python range(3)
  64     # semantics, useful to have to simplify other code locations).
  65     RESET = DATA_N
  66
  67 class Ann:
  68     ITEM, WORD, WARN = range(3)
  69
  70 class ChannelError(Exception):
  71     pass
  72
  73 class Decoder(srd.Decoder):
  74     api_version = 3
  75     id = 'parallel'
  76     name = 'Parallel'
  77     longname = 'Parallel sync bus'
  78     desc = 'Generic parallel synchronous bus.'
  79     license = 'gplv2+'
  80     inputs = ['logic']
  81     outputs = ['parallel']
  82     tags = ['Util']
  83     optional_channels = tuple(
  84         [{'id': 'clk', 'name': 'CLK', 'desc': 'Clock line'}] +
  85         [
  86             {'id': 'd%d' % i, 'name': 'D%d' % i, 'desc': 'Data line %d' % i}
  87             for i in range(NUM_CHANNELS)
  88         ] +
  89         [{'id': 'rst', 'name': 'RST', 'desc': 'RESET line'}]
  90     )
  91     options = (
  92         {'id': 'clock_edge', 'desc': 'Clock edge to sample on',
  93             'default': 'rising', 'values': ('rising', 'falling', 'either')},
  94         {'id': 'reset_polarity', 'desc': 'Reset line polarity',
  95             'default': 'low-active', 'values': ('low-active', 'high-active')},
  96         {'id': 'wordsize', 'desc': 'Data wordsize (# bus cycles)',
  97             'default': 0},
  98         {'id': 'endianness', 'desc': 'Data endianness',
  99             'default': 'little', 'values': ('little', 'big')},
 100     )
 101     annotations = (
 102         ('item', 'Item'),
 103         ('word', 'Word'),
 104         ('warning', 'Warning'),
 105     )
 106     annotation_rows = (
 107         ('items', 'Items', (Ann.ITEM,)),
 108         ('words', 'Words', (Ann.WORD,)),
 109         ('warnings', 'Warnings', (Ann.WARN,)),
 110     )
 111
 112     def __init__(self):
 113         self.reset()
 114
 115     def reset(self):
 116         self.pend_item = None
 117         self.word_items = []
 118
 119     def start(self):
 120         self.out_python = self.register(srd.OUTPUT_PYTHON)
 121         self.out_ann = self.register(srd.OUTPUT_ANN)
 122
 123     def putg(self, ss, es, ann, txts):
 124         self.put(ss, es, self.out_ann, [ann, txts])
 125
 126     def putpy(self, ss, es, ann, data):
 127         self.put(ss, es, self.out_python, [ann, data])
 128
 129     def flush_word(self, bus_width):
 130         if not self.word_items:
 131             return
 132         word_size = self.options['wordsize']
 133
 134         items = self.word_items
 135         ss, es = items[0][0], items[-1][1]
 136         items = [i[2] for i in items]
 137         if self.options['endianness'] == 'big':
 138             items.reverse()
 139         word = sum([d << (i * bus_width) for i, d in enumerate(items)])
 140
 141         txts = [self.fmt_word.format(word)]
 142         self.putg(ss, es, Ann.WORD, txts)
 143         self.putpy(ss, es, 'WORD', (word, bus_width, word_size))
 144
 145         if len(items) != word_size:
 146             txts = ['incomplete word size', 'word size', 'ws']
 147             self.putg(ss, es, Ann.WARN, txts)
 148
 149         self.word_items.clear()
 150
 151     def queue_word(self, now, item, bus_width):
 152         wordsize = self.options['wordsize']
 153         if not wordsize:
 154             return
 155
 156         # Terminate a previously seen item of a word first. Emit the
 157         # word's annotation when the last item's end was seen.
 158         if self.word_items:
 159             ss, _, data = self.word_items[-1]
 160             es = now
 161             self.word_items[-1] = (ss, es, data)
 162             if len(self.word_items) == wordsize:
 163                 self.flush_word(bus_width)
 164
 165         # Start tracking the currently seen item (yet unknown end time).
 166         if item is not None:
 167             pend = (now, None, item)
 168             self.word_items.append(pend)
 169
 170     def handle_bits(self, now, item, bus_width):
 171
 172         # Optionally flush a previously started item.
 173         if self.pend_item:
 174             ss, _, data = self.pend_item
 175             self.pend_item = None
 176             es = now
 177             txts = [self.fmt_item.format(data)]
 178             self.putg(ss, es, Ann.ITEM, txts)
 179             self.putpy(ss, es, 'ITEM', (data, bus_width))
 180
 181         # Optionally queue the currently seen item.
 182         if item is not None:
 183             self.pend_item = (now, None, item)
 184
 185         # Pass the current item to the word accumulation logic.
 186         self.queue_word(now, item, bus_width)
 187
 188     def decode(self):
 189         # Determine which (optional) channels have input data. Insist in
 190         # a non-empty input data set. Cope with sparse connection maps.
 191         # Store enough state to later "compress" sampled input data.
 192         data_indices = [
 193             idx if self.has_channel(idx) else None
 194             for idx in range(Pin.DATA_0, Pin.DATA_N)
 195         ]
 196         has_data = [idx for idx in data_indices if idx is not None]
 197         if not has_data:
 198             raise ChannelError('Need at least one data channel.')
 199         max_connected = max(has_data)
 200
 201         # Pre-determine which input data to strip off, the width of
 202         # individual items and multiplexed words, as well as format
 203         # strings here. This simplifies call sites which run in tight
 204         # loops later.
 205         upper_data_bound = max_connected + 1
 206         num_item_bits = upper_data_bound - Pin.DATA_0
 207         num_word_items = self.options['wordsize']
 208         num_word_bits = num_item_bits * num_word_items
 209         num_digits = (num_item_bits + 4 - 1) // 4
 210         self.fmt_item = "{{:0{}x}}".format(num_digits)
 211         num_digits = (num_word_bits + 4 - 1) // 4
 212         self.fmt_word = "{{:0{}x}}".format(num_digits)
 213
 214         # Determine .wait() conditions, depending on the presence of a
 215         # clock signal. Either inspect samples on the configured edge of
 216         # the clock, or inspect samples upon ANY edge of ANY of the pins
 217         # which provide input data.
 218         conds = []
 219         cond_idx_clock = None
 220         cond_idx_data_0 = None
 221         cond_idx_data_N = None
 222         cond_idx_reset = None
 223         has_clock = self.has_channel(Pin.CLOCK)
 224         if has_clock:
 225             cond_idx_clock = len(conds)
 226             edge = {
 227                 'rising': 'r',
 228                 'falling': 'f',
 229                 'either': 'e',
 230             }.get(self.options['clock_edge'])
 231             conds.append({Pin.CLOCK: edge})
 232         else:
 233             cond_idx_data_0 = len(conds)
 234             conds.extend([{idx: 'e'} for idx in has_data])
 235             cond_idx_data_N = len(conds)
 236         has_reset = self.has_channel(Pin.RESET)
 237         if has_reset:
 238             cond_idx_reset = len(conds)
 239             conds.append({Pin.RESET: 'e'})
 240             reset_active = {
 241                 'low-active': 0,
 242                 'high-active': 1,
 243             }.get(self.options['reset_polarity'])
 244
 245         # Keep processing the input stream. Assume "always zero" for
 246         # not-connected input lines. Pass data bits (all inputs except
 247         # clock and reset) to the handle_bits() method. Handle reset
 248         # edges first and data changes then, within the same iteration.
 249         # This results in robust operation for low-oversampled input.
 250         in_reset = False
 251         while True:
 252             pins = self.wait(conds)
 253             clock_edge = cond_idx_clock is not None and self.matched[cond_idx_clock]
 254             data_edge = cond_idx_data_0 is not None and [idx for idx in range(cond_idx_data_0, cond_idx_data_N) if self.matched[idx]]
 255             reset_edge = cond_idx_reset is not None and self.matched[cond_idx_reset]
 256
 257             if reset_edge:
 258                 in_reset = pins[Pin.RESET] == reset_active
 259                 if in_reset:
 260                     self.handle_bits(self.samplenum, None, num_item_bits)
 261                     self.flush_word(num_item_bits)
 262             if in_reset:
 263                 continue
 264
 265             if clock_edge or data_edge:
 266                 data_bits = [0 if idx is None else pins[idx] for idx in data_indices]
 267                 data_bits = data_bits[:num_item_bits]
 268                 item = bitpack(data_bits)
 269                 self.handle_bits(self.samplenum, item, num_item_bits)