sdcard_spi: Fix some abbreviations and names to match the spec.

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

diff --git a/decoders/sdcard_spi/pd.py b/decoders/sdcard_spi/pd.py
index 478dfc8ca33e627ad7e1fbaeecb2ad334671c666..5054d9e9d0f2adf4dd4c0eca2e1444cd249e72e8 100644 (file)
--- a/decoders/sdcard_spi/pd.py
+++ b/decoders/sdcard_spi/pd.py
@@ -28,7 +28,8 @@ class Decoder(srd.Decoder):
     desc = 'Secure Digital card (SPI mode) low-level protocol.'
     license = 'gplv2+'
     inputs = ['spi']
-    outputs = ['sdcard_spi']
+    outputs = []
+    tags = ['Memory']
     annotations = \
         tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
         tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
@@ -46,6 +47,9 @@ class Decoder(srd.Decoder):
     )
 
     def __init__(self):
+        self.reset()
+
+    def reset(self):
         self.state = 'IDLE'
         self.ss, self.es = 0, 0
         self.ss_bit, self.es_bit = 0, 0
@@ -56,6 +60,8 @@ class Decoder(srd.Decoder):
         self.blocklen = 0
         self.read_buf = []
         self.cmd_str = ''
+        self.is_cmd24 = False
+        self.cmd24_start_token_found = False
 
     def start(self):
         self.out_ann = self.register(srd.OUTPUT_ANN)
@@ -148,7 +154,7 @@ class Decoder(srd.Decoder):
             self.putb([135, ['End bit: %d (Warning: Must be 1!)' % bit]])
 
         # Handle command.
-        if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59):
+        if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59):
             self.state = 'HANDLE CMD%d' % cmd
             self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd))
         else:
@@ -220,6 +226,12 @@ class Decoder(srd.Decoder):
         self.read_buf = []
         self.state = 'GET RESPONSE R1'
 
+    def handle_cmd24(self):
+        # CMD24: WRITE_BLOCK
+        self.putc(24, 'Write a block to address 0x%04x' % self.arg)
+        self.is_cmd24 = True
+        self.state = 'GET RESPONSE R1'
+
     def handle_cmd49(self):
         self.state = 'GET RESPONSE R1'
 
@@ -324,7 +336,8 @@ class Decoder(srd.Decoder):
         # Bit 7: Always set to 0
         putbit(7, ['Bit 7 (always 0)'])
 
-        self.state = 'IDLE'
+        if self.is_cmd24:
+            self.state = 'HANDLE DATA BLOCK CMD24'
 
     def handle_response_r1b(self, res):
         # TODO
@@ -346,6 +359,50 @@ class Decoder(srd.Decoder):
         # TODO
         pass
 
+    def handle_data_cmd24(self, mosi):
+        if self.cmd24_start_token_found:
+            if len(self.read_buf) == 0:
+                self.ss_data = self.ss
+                if not self.blocklen:
+                    # Assume a fixed block size when inspection of the
+                    # previous traffic did not provide the respective
+                    # parameter value.
+                    # TODO Make the default block size a user adjustable option?
+                    self.blocklen = 512
+            self.read_buf.append(mosi)
+            # Wait until block transfer completed.
+            if len(self.read_buf) < self.blocklen:
+                return
+            self.es_data = self.es
+            self.put(self.ss_data, self.es_data, self.out_ann, [24, ['Block data: %s' % self.read_buf]])
+            self.read_buf = []
+            self.state = 'DATA RESPONSE'
+        elif mosi == 0xfe:
+            self.put(self.ss, self.es, self.out_ann, [24, ['Start Block']])
+            self.cmd24_start_token_found = True
+
+    def handle_data_response(self, miso):
+        miso &= 0x1f
+        if miso & 0x11 != 0x01:
+            # This is not the byte we are waiting for.
+            # Should we return to IDLE here?
+            return
+        self.put(self.miso_bits[7][1], self.miso_bits[5][2], self.out_ann, [134, ['don\'t care']])
+        self.put(self.miso_bits[4][1], self.miso_bits[4][2], self.out_ann, [134, ['0']])
+        if miso == 0x05:
+            self.put(self.miso_bits[3][1], self.miso_bits[1][2], self.out_ann, [134, ['Data accepted']])
+        elif miso == 0x0b:
+            self.put(self.miso_bits[3][1], self.miso_bits[1][2], self.out_ann, [134, ['Data rejected (CRC error)']])
+        elif miso == 0x0d:
+            self.put(self.miso_bits[3][1], self.miso_bits[1][2], self.out_ann, [134, ['Data rejected (write error)']])
+        self.put(self.miso_bits[0][1], self.miso_bits[0][2], self.out_ann, [134, ['1']])
+        ann_class = None
+        if self.is_cmd24:
+            ann_class = 24
+        if ann_class is not None:
+            self.put(self.ss, self.es, self.out_ann, [ann_class, ['Data Response']])
+        self.state = 'IDLE'
+
     def decode(self, ss, es, data):
         ptype, mosi, miso = data
 
@@ -385,10 +442,14 @@ class Decoder(srd.Decoder):
             # Ignore stray 0xff bytes, some devices seem to send those!?
             if miso == 0xff: # TODO?
                 return
-
             # Call the respective handler method for the response.
+            # Assume return to IDLE state, but allow response handlers
+            # to advance to some other state when applicable.
             s = 'handle_response_%s' % self.state[13:].lower()
             handle_response = getattr(self, s)
-            handle_response(miso)
-
             self.state = 'IDLE'
+            handle_response(miso)
+        elif self.state == 'HANDLE DATA BLOCK CMD24':
+            self.handle_data_cmd24(mosi)
+        elif self.state == 'DATA RESPONSE':
+            self.handle_data_response(miso)