]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/spi/__init__.py
spi: Output per-bit annotations and OUTPUT_PYTHON data.
[libsigrokdecode.git] / decoders / spi / __init__.py
index 3276fed93f6f95499f2a769ab3896085b6824e7b..a1f0f1c3ebf1fe044a9e84352cfad9c014a13e34 100644 (file)
@@ -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 <uwe@hermann-uwe.de>
 ##
 ## 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 *