spi: Provide multiple annotation types.

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

diff --git a/decoders/spi/pd.py b/decoders/spi/pd.py
index 10857866f4cad8ebdc41fe58600cdb688b8d6420..47bbe322a3342e8c5ee548c3e1c8c947f3725b39 100644 (file)
--- a/decoders/spi/pd.py
+++ b/decoders/spi/pd.py
@@ -1,8 +1,8 @@
 ##
-## This file is part of the sigrok project.
+## This file is part of the libsigrokdecode project.
 ##
 ## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -33,9 +33,6 @@ spi_mode = {
     (1, 1): 3, # Mode 3
 }
 
-# Annotation formats
-ANN_HEX = 0
-
 class Decoder(srd.Decoder):
     api_version = 1
     id = 'spi'
@@ -60,9 +57,13 @@ class Decoder(srd.Decoder):
         'cpha': ['Clock phase', 0],
         'bitorder': ['Bit order within the SPI data', 'msb-first'],
         'wordsize': ['Word size of SPI data', 8], # 1-64?
+        'format': ['Data format', 'hex'],
     }
     annotations = [
-        ['Hex', 'SPI data bytes in hex format'],
+        ['MISO/MOSI data', 'MISO/MOSI SPI data'],
+        ['MISO data', 'MISO SPI data'],
+        ['MOSI data', 'MOSI SPI data'],
+        ['Warnings', 'Human-readable warnings'],
     ]
 
     def __init__(self):
@@ -71,6 +72,7 @@ class Decoder(srd.Decoder):
         self.mosidata = 0
         self.misodata = 0
         self.bytesreceived = 0
+        self.startsample = -1
         self.samplenum = -1
         self.cs_was_deasserted_during_data_word = 0
         self.oldcs = -1
@@ -83,6 +85,12 @@ class Decoder(srd.Decoder):
     def report(self):
         return 'SPI: %d bytes received' % self.bytesreceived
 
+    def putpw(self, data):
+        self.put(self.startsample, self.samplenum, self.out_proto, data)
+
+    def putw(self, data):
+        self.put(self.startsample, self.samplenum, self.out_ann, data)
+
     def decode(self, ss, es, data):
         # TODO: Either MISO or MOSI could be optional. CS# is optional.
         for (self.samplenum, pins) in data:
@@ -96,8 +104,6 @@ class Decoder(srd.Decoder):
                 # Send all CS# pin value changes.
                 self.put(self.samplenum, self.samplenum, self.out_proto,
                          ['CS-CHANGE', self.oldcs, cs])
-                self.put(self.samplenum, self.samplenum, self.out_ann,
-                         [0, ['CS-CHANGE: %d->%d' % (self.oldcs, cs)]])
                 self.oldcs = cs
 
             # Ignore sample if the clock pin hasn't changed.
@@ -119,7 +125,7 @@ class Decoder(srd.Decoder):
 
             # If this is the first bit, save its sample number.
             if self.bitcount == 0:
-                self.start_sample = self.samplenum
+                self.startsample = self.samplenum
                 active_low = (self.options['cs_polarity'] == 'active-low')
                 deasserted = cs if active_low else not cs
                 if deasserted:
@@ -145,16 +151,13 @@ class Decoder(srd.Decoder):
             if self.bitcount != ws:
                 continue
 
-            self.put(self.start_sample, self.samplenum, self.out_proto,
-                     ['DATA', self.mosidata, self.misodata])
-            self.put(self.start_sample, self.samplenum, self.out_ann,
-                     [ANN_HEX, ['MOSI: 0x%02x, MISO: 0x%02x' % (self.mosidata,
-                     self.misodata)]])
+            self.putpw(['DATA', self.mosidata, self.misodata])
+            self.putw([0, ['%02X/%02X' % (self.mosidata, self.misodata)]])
+            self.putw([1, ['%02X' % self.misodata]])
+            self.putw([2, ['%02X' % self.mosidata]])
 
             if self.cs_was_deasserted_during_data_word:
-                self.put(self.start_sample, self.samplenum, self.out_ann,
-                         [ANN_HEX, ['WARNING: CS# was deasserted during this '
-                         'SPI data byte!']])
+                self.putw([3, ['CS# was deasserted during this data word!']])
 
             # Reset decoder state.
             self.mosidata = 0