X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fspi%2Fpd.py;h=21012c19996031a2dcd001ac5e220f741653d8f7;hp=b6c96bca82c1f18276587197b984bfefd6aa8118;hb=be465111b552c7c2a2262ac49758a30a8bf1b1d5;hpb=efa641735217e5425f93e69cbaddf70d75c7e9e4

diff --git a/decoders/spi/pd.py b/decoders/spi/pd.py
index b6c96bc..21012c1 100644
--- a/decoders/spi/pd.py
+++ b/decoders/spi/pd.py
@@ -23,6 +23,26 @@
 
 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.
@@ -68,6 +88,7 @@ class Decoder(srd.Decoder):
     ]
 
     def __init__(self):
+        self.samplerate = None
         self.oldsck = 1
         self.bitcount = 0
         self.mosidata = 0
@@ -80,9 +101,15 @@ class Decoder(srd.Decoder):
         self.oldpins = None
         self.state = 'IDLE'
 
-    def start(self, metadata):
-        self.out_proto = self.add(srd.OUTPUT_PROTO, 'spi')
-        self.out_ann = self.add(srd.OUTPUT_ANN, 'spi')
+    def metadata(self, key, value):
+        if key == srd.SRD_CONF_SAMPLERATE:
+            self.samplerate = value
+
+    def start(self):
+        self.out_proto = self.register(srd.OUTPUT_PYTHON)
+        self.out_ann = self.register(srd.OUTPUT_ANN)
+        self.out_bitrate = self.register(srd.OUTPUT_META,
+                meta=(int, 'Bitrate', 'Bitrate during transfers'))
 
     def report(self):
         return 'SPI: %d bytes received' % self.bytesreceived
@@ -123,11 +150,19 @@ class Decoder(srd.Decoder):
         if self.bitcount != ws:
             return
 
+        # Pass MOSI and MISO to the next PD up the stack
         self.putpw(['DATA', self.mosidata, self.misodata])
+
+        # Annotations
         self.putw([0, ['%02X/%02X' % (self.mosidata, self.misodata)]])
         self.putw([1, ['%02X' % self.misodata]])
         self.putw([2, ['%02X' % self.mosidata]])
 
+        # Meta bitrate
+        elapsed = 1 / float(self.samplerate) * (self.samplenum - self.startsample + 1)
+        bitrate = int(1 / elapsed * self.options['wordsize'])
+        self.put(self.startsample, self.samplenum, self.out_bitrate, bitrate)
+
         if self.cs_was_deasserted_during_data_word:
             self.putw([3, ['CS# was deasserted during this data word!']])
 
@@ -167,6 +202,8 @@ class Decoder(srd.Decoder):
         self.handle_bit(miso, mosi, sck, cs)
 
     def decode(self, ss, es, data):
+        if self.samplerate is None:
+            raise Exception("Cannot decode without samplerate.")
         # TODO: Either MISO or MOSI could be optional. CS# is optional.
         for (self.samplenum, pins) in data: