decoders/spi/__init__.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012 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 The SPI (Serial Peripheral Interface) protocol decoder supports synchronous
  22 SPI(-like) protocols with a clock line, a MISO and MOSI line for data
  23 transfer in two directions, and an optional CS# pin.
  24
  25 Either MISO or MOSI (but not both) can be optional.
  26
  27 If CS# is supplied, data is only decoded when CS# is asserted (clock
  28 transitions where CS# is not asserted are ignored). If CS# is not supplied,
  29 data is decoded on every clock transition (depending on SPI mode).
  30 '''
  31
  32 from .pd import Decoder