Change PD options to be a tuple of dictionaries.

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

diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py
index 8734acf3f36ebe57bb468351846ee2a5f97e884e..a1f0f1c3ebf1fe044a9e84352cfad9c014a13e34 100644 (file)
--- 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 <uwe@hermann-uwe.de>
 ##
@@ -19,29 +19,15 @@
 ##
 
 '''
-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.
-
-Example:
- ['CS-CHANGE', 1, 0]
- ['DATA', 0xff, 0x3a]
- ['DATA', 0x65, 0x00]
- ['CS-CHANGE', 0, 1]
+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 .spi import *
+from .pd import *