decoders/parallel/__init__.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2013 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 '''
  21 This protocol decoder can decode synchronous parallel buses with various
  22 data bits/channels counts, an (optional) clock line, and an (optional)
  23 select/enable/reset line.
  24
  25 Data bits are taken from the decoder's lowest connected input pins. The
  26 input signal's data lines count need not span the full amount of the
  27 decoder's maximum supported data lines count. Not connected data lines
  28 are assumed to be low.
  29
  30 Example use cases are: Connect D3/D2/D1/D0 (and CLK) to a 4-bit bus.
  31 Connect D7 and D6 to inspect the two most significant bits of an 8-bit
  32 bus (and have 8-bit values shown instead of just 2-bit values).
  33
  34 When provided, the specified clock edge determines when data lines get
  35 sampled. Without a clock spec, each transition on any of the data lines
  36 will be shown, which can become busy/noisy depending on the input data.
  37
  38 Another signal optionally can control the period of time within which
  39 the data lines' bit pattern gets interpreted. Typical use cases would be
  40 reset, or select, or enable signals that are related to the bus' data
  41 communication. This optional signal can also improve synchronization to
  42 wider payload data which spans several bus cycles (multiplexing).
  43 '''
  44
  45 from .pd import Decoder