spiflash: Implement Release Power-down / Device ID (0xAB) command.

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

diff --git a/decoders/spiflash/pd.py b/decoders/spiflash/pd.py
index 056b0a0358dee65d46a70e6a1d00d5d9090f6762..3d40ceb0663d424a3ff65f4cf7b0151e2491c5a8 100644 (file)
--- a/decoders/spiflash/pd.py
+++ b/decoders/spiflash/pd.py
@@ -24,6 +24,19 @@ from .lists import *
 def cmd_annotation_classes():
     return tuple([tuple([cmd[0].lower(), cmd[1]]) for cmd in cmds.values()])
 
+def decode_dual_bytes(sio0, sio1):
+    # Given a byte in SIO0 (MOSI) of even bits and a byte in
+    # SIO1 (MISO) of odd bits, return a tuple of two bytes.
+    def combine_byte(even, odd):
+        result = 0
+        for bit in range(4):
+            if even & (1 << bit):
+                result |= 1 << (bit*2)
+            if odd & (1 << bit):
+                result |= 1 << ((bit*2) + 1)
+        return result
+    return (combine_byte(sio0 >> 4, sio1 >> 4), combine_byte(sio0, sio1))
+
 def decode_status_reg(data):
     # TODO: Additional per-bit(s) self.put() calls with correct start/end.
 
@@ -71,12 +84,22 @@ class Decoder(srd.Decoder):
     options = (
         {'id': 'chip', 'desc': 'Chip', 'default': tuple(chips.keys())[0],
             'values': tuple(chips.keys())},
+        {'id': 'format', 'desc': 'Data format', 'default': 'hex',
+            'values': ('hex', 'ascii')},
     )
 
     def __init__(self):
         self.on_end_transaction = None
         self.end_current_transaction()
 
+        # Build dict mapping command keys to handler functions. Each
+        # command in 'cmds' (defined in lists.py) has a matching
+        # handler self.handle_<shortname>.
+        def get_handler(cmd):
+            s = 'handle_%s' % cmds[cmd][0].lower().replace('/', '_')
+            return getattr(self, s)
+        self.cmd_handlers = dict((cmd, get_handler(cmd)) for cmd in cmds.keys())
+
     def end_current_transaction(self):
         if self.on_end_transaction is not None: # Callback for CS# transition.
             self.on_end_transaction()
@@ -192,13 +215,27 @@ class Decoder(srd.Decoder):
             # Bytes 6-x: Master reads data bytes (until CS# de-asserted).
             if self.cmdstate == 6:
                 self.ss_block = self.ss
-                self.on_end_transaction = lambda: self.output_block("Read")
+                self.on_end_transaction = lambda: self.output_data_block('Read')
             self.data.append(miso)
 
         self.cmdstate += 1
 
     def handle_2read(self, mosi, miso):
-        pass # TODO
+        # Fast read dual I/O: Same as fast read, but all data
+        # after the command is sent via two I/O pins.
+        # MOSI = SIO0 = even bits, MISO = SIO1 = odd bits.
+        # Recombine the bytes and pass them up to the handle_fast_read command.
+        if self.cmdstate == 1:
+            # Byte 1: Master sends command ID.
+            self.putx([5, ['Command: %s' % cmds[self.state][1]]])
+            self.cmdstate = 2
+        else:
+            # Dual I/O mode.
+            a, b = decode_dual_bytes(mosi, miso)
+            # Pass same byte in as both MISO & MOSI, parser state determines
+            # which one it cares about.
+            self.handle_fast_read(a, a)
+            self.handle_fast_read(b, b)
 
     # TODO: Warn/abort if we don't see the necessary amount of bytes.
     # TODO: Warn if WREN was not seen before.
@@ -265,7 +302,20 @@ class Decoder(srd.Decoder):
         pass # TODO
 
     def handle_rdp_res(self, mosi, miso):
-        pass # TODO
+        if self.cmdstate == 1:
+            # Byte 1: Master sends command ID.
+            self.ss_block = self.ss
+            self.putx([16, ['Command: %s' % cmds[self.state][1]]])
+        elif self.cmdstate in (2, 3, 4):
+            # Bytes 2/3/4: Master sends three dummy bytes.
+            self.putx([24, ['Dummy byte: %02x' % mosi]])
+        elif self.cmdstate == 5:
+            # Byte 5: Slave sends device ID.
+            self.ids = [miso]
+            self.putx([24, ['Device: Macronix %s' % device_name[self.ids[0]]]])
+            self.state = None
+
+        self.cmdstate += 1
 
     def handle_rems(self, mosi, miso):
         if self.cmdstate == 1:
@@ -326,7 +376,10 @@ class Decoder(srd.Decoder):
         # Print accumulated block of data
         # (called on CS# de-assert via self.on_end_transaction callback).
         self.es_block = self.es # Ends on the CS# de-assert sample.
-        s = ' '.join([('%02x' % b) for b in self.data])
+        if self.options['format'] == 'hex':
+            s = ' '.join([('%02x' % b) for b in self.data])
+        else:
+            s = ''.join(map(chr, self.data))
         self.putb([25, ['%s %d bytes: %s' % (label, len(self.data), s)]])
 
     def decode(self, ss, es, data):
@@ -346,10 +399,8 @@ class Decoder(srd.Decoder):
             self.cmdstate = 1
 
         # Handle commands.
-        if self.state in cmds:
-            s = 'handle_%s' % cmds[self.state][0].lower().replace('/', '_')
-            handle_reg = getattr(self, s)
-            handle_reg(mosi, miso)
-        else:
+        try:
+            self.cmd_handlers[self.state](mosi, miso)
+        except KeyError:
             self.putx([24, ['Unknown command: 0x%02x' % mosi]])
             self.state = None