X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fspi%2F__init__.py;h=dc5cbc0596a8d753c6f67b8d7404babe3351055f;hb=81f301b4c84c2993afd87773aff6d10130f2dceb;hp=7527913841f8003dcb0bfe6bd47e8f1b1bb6af75;hpb=50bd5d259677faf87bb3408e111d0e833d7ba9b4;p=libsigrokdecode.git
diff --git a/decoders/spi/__init__.py b/decoders/spi/__init__.py
index 7527913..dc5cbc0 100644
--- a/decoders/spi/__init__.py
+++ b/decoders/spi/__init__.py
@@ -14,35 +14,19 @@
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+## along with this program; if not, see .
##
'''
-Serial Peripheral Interface protocol decoder.
+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.
-Details:
-TODO
-
-Protocol output format:
-
-SPI packet:
-[, , ]
-
-Commands:
- - 'DATA': contains the MISO data, 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': is the old CS# pin value, 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]
+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 *
-
+from .pd import Decoder