configure.ac/Makefile.am: Alphabetical order.

[libsigrokdecode.git] / decoders / spi / __init__.py

diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py
index 3276fed93f6f95499f2a769ab3896085b6824e7b..fedcc5fbbbd4af3bf33216411a54d8d349d90bb9 100644 (file)
--- a/decoders/spi/__init__.py
+++ b/decoders/spi/__init__.py
@@ -18,5 +18,31 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
+'''
+Serial Peripheral Interface protocol decoder.
+
+Details:
+TODO
+
+Protocol output format:
+
+SPI packet:
+[<cmd>, <data1>, <data2>]
+
+Commands:
+ - 'DATA': <data1> contains the MISO data, <data2> contains the MOSI data.
+   The data is _usually_ 8 bits (but can also be fewer or more bits).
+   Both data items are Python numbers, not strings.
+ - 'CS CHANGE': <data1> is the old CS# pin value, <data2> is the new value.
+   Both data items are Python numbers (0/1), not strings.
+
+Examples:
+ ['CS-CHANGE', 1, 0]
+ ['DATA', 0xff, 0x3a]
+ ['DATA', 0x65, 0x00]
+ ['CS-CHANGE', 0, 1]
+
+'''
+
 from .spi import *