X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fspi%2F__init__.py;h=a1f0f1c3ebf1fe044a9e84352cfad9c014a13e34;hb=d78e0beb6594de5dfd2a17d72f532a42f85ca55c;hp=3276fed93f6f95499f2a769ab3896085b6824e7b;hpb=64c29e28e0efa184319f7831b3eca18c7f73f7d0;p=libsigrokdecode.git diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py index 3276fed..a1f0f1c 100644 --- a/decoders/spi/__init__.py +++ b/decoders/spi/__init__.py @@ -1,5 +1,5 @@ ## -## This file is part of the sigrok project. +## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2012 Uwe Hermann ## @@ -18,5 +18,16 @@ ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ## -from .spi import * +''' +The SPI (Serial Peripheral Interface) protocol decoder supports synchronous +SPI(-like) protocols with a clock line, a MISO and MOSI line for data +transfer in two directions, and an optional CS# pin. +Either MISO or MOSI (but not both) can be optional. + +If CS# is supplied, data is only decoded when CS# is asserted (clock +transitions where CS# is not asserted are ignored). If CS# is not supplied, +data is decoded on every clock transition (depending on SPI mode). +''' + +from .pd import *