spi: Add some documentation, move OUTPUT_PROTO docs.
authorUwe Hermann <uwe@hermann-uwe.de>
Thu, 12 Sep 2013 19:22:09 +0000 (21:22 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Thu, 12 Sep 2013 19:26:13 +0000 (21:26 +0200)
Add a short help text for the PD and move the OUTPUT_PROTO docs to pd.py
since they're not meant for the user too see.

decoders/spi/__init__.py
decoders/spi/pd.py

index 7527913841f8003dcb0bfe6bd47e8f1b1bb6af75..582891ac261b1a9d2de5eea7d19d5230c394a74a 100644 (file)
 '''
 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]
+This 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.
 
+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 *
index b6c96bca82c1f18276587197b984bfefd6aa8118..7e4a1e5f9aaf5bedce191815b1d3cbb4e444d3de 100644 (file)
 
 import sigrokdecode as srd
 
+'''
+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]
+'''
+
 # Key: (CPOL, CPHA). Value: SPI mode.
 # Clock polarity (CPOL) = 0/1: Clock is low/high when inactive.
 # Clock phase (CPHA) = 0/1: Data is valid on the leading/trailing clock edge.