]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/sdcard_sd/pd.py
sdcard_sd: Use a Bit class to improve readability.
[libsigrokdecode.git] / decoders / sdcard_sd / pd.py
index d0e72d278257d7bd2d5ac6c74a3f018c6db57cdd..b7f6a85d33355ff8e5fa8cb66e4bb992849c3803 100644 (file)
@@ -37,6 +37,10 @@ s = ['GET_COMMAND_TOKEN', 'HANDLE_CMD999'] + \
     ['GET_RESPONSE_R%s' % r.upper() for r in responses]
 St = SrdStrEnum.from_list('St', s)
 
+class Bit:
+    def __init__(self, s, e, b):
+        self.ss, self.es, self.bit = s, e ,b
+
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'sdcard_sd'
@@ -94,21 +98,21 @@ class Decoder(srd.Decoder):
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
     def putbit(self, b, data):
-        self.put(self.token[b][0], self.token[b][1], self.out_ann,
+        self.put(self.token[b].ss, self.token[b].es, self.out_ann,
             [Ann.DECODED_BIT, data])
 
     def putt(self, data):
-        self.put(self.token[0][0], self.token[47][1], self.out_ann, data)
+        self.put(self.token[0].ss, self.token[47].es, self.out_ann, data)
 
     def putf(self, s, e, data):
-        self.put(self.token[s][0], self.token[e][1], self.out_ann, data)
+        self.put(self.token[s].ss, self.token[e].es, self.out_ann, data)
 
     def puta(self, s, e, data):
-        self.put(self.token[47 - 8 - e][0], self.token[47 - 8 - s][1],
+        self.put(self.token[47 - 8 - e].ss, self.token[47 - 8 - s].es,
                  self.out_ann, data)
 
     def putc(self, desc):
-        cmd = self.cmd + 64 if self.is_acmd else self.cmd
+        cmd = Ann.ACMD0 + self.cmd if self.is_acmd else self.cmd
         self.last_cmd = cmd
         self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str,
                          self.cmd_str.split(' ')[0]]])
@@ -120,14 +124,14 @@ class Decoder(srd.Decoder):
         c = acmd_names if self.is_acmd else cmd_names
         return c.get(cmd, 'Unknown')
 
-    def get_token_bits(self, cmd, n):
+    def get_token_bits(self, cmd_pin, n):
         # Get a bit, return True if we already got 'n' bits, False otherwise.
-        self.token.append([self.samplenum, self.samplenum, cmd])
+        self.token.append(Bit(self.samplenum, self.samplenum, cmd_pin))
         if len(self.token) > 0:
-            self.token[len(self.token) - 2][1] = self.samplenum
+            self.token[len(self.token) - 2].es = self.samplenum
         if len(self.token) < n:
             return False
-        self.token[n - 1][1] += self.token[n - 1][0] - self.token[n - 2][0]
+        self.token[n - 1].es += self.token[n - 1].ss - self.token[n - 2].ss
         return True
 
     def handle_common_token_fields(self):
@@ -135,33 +139,33 @@ class Decoder(srd.Decoder):
 
         # Annotations for each individual bit.
         for bit in range(len(self.token)):
-            self.putf(bit, bit, [Ann.BIT, ['%d' % s[bit][2]]])
+            self.putf(bit, bit, [Ann.BIT, ['%d' % s[bit].bit]])
 
         # CMD[47:47]: Start bit (always 0)
         self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']])
 
         # CMD[46:46]: Transmission bit (1 == host)
-        t = 'host' if s[1][2] == 1 else 'card'
+        t = 'host' if s[1].bit == 1 else 'card'
         self.putf(1, 1, [Ann.F_TRANSM, ['Transmission: ' + t, 'T: ' + t, 'T']])
 
         # CMD[45:40]: Command index (BCD; valid: 0-63)
-        self.cmd = int('0b' + ''.join([str(s[i][2]) for i in range(2, 8)]), 2)
+        self.cmd = int('0b' + ''.join([str(s[i].bit) for i in range(2, 8)]), 2)
         c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd)
         self.putf(2, 7, [Ann.F_CMD, ['Command: ' + c, 'Cmd: ' + c,
                                'CMD%d' % self.cmd, 'Cmd', 'C']])
 
         # CMD[39:08]: Argument
-        self.arg = int('0b' + ''.join([str(s[i][2]) for i in range(8, 40)]), 2)
+        self.arg = int('0b' + ''.join([str(s[i].bit) for i in range(8, 40)]), 2)
         self.putf(8, 39, [Ann.F_ARG, ['Argument: 0x%08x' % self.arg, 'Arg', 'A']])
 
         # CMD[07:01]: CRC7
-        self.crc = int('0b' + ''.join([str(s[i][2]) for i in range(40, 47)]), 2)
+        self.crc = int('0b' + ''.join([str(s[i].bit) for i in range(40, 47)]), 2)
         self.putf(40, 46, [Ann.F_CRC, ['CRC: 0x%x' % self.crc, 'CRC', 'C']])
 
         # CMD[00:00]: End bit (always 1)
         self.putf(47, 47, [Ann.F_END, ['End bit', 'End', 'E']])
 
-    def get_command_token(self, cmd):
+    def get_command_token(self, cmd_pin):
         # Command tokens (48 bits) are sent serially (MSB-first) by the host
         # (over the CMD line), either to one SD card or to multiple ones.
         #
@@ -173,7 +177,7 @@ class Decoder(srd.Decoder):
         #  - Bits[07:01]: CRC7
         #  - Bits[00:00]: End bit (always 1)
 
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
 
         self.handle_common_token_fields()
@@ -181,7 +185,7 @@ class Decoder(srd.Decoder):
         # Handle command.
         s = 'ACMD' if self.is_acmd else 'CMD'
         self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd))
-        if self.cmd in (0, 2, 3, 6, 7, 8, 9, 10, 13, 41, 51, 55):
+        if hasattr(self, 'handle_%s%d' % (s.lower(), self.cmd)):
             self.state = St['HANDLE_CMD%d' % self.cmd]
         else:
             self.state = St.HANDLE_CMD999
@@ -301,7 +305,7 @@ class Decoder(srd.Decoder):
     # They're sent serially (MSB-first) by the card that the host
     # addressed previously, or (synchronously) by all connected cards.
 
-    def handle_response_r1(self, cmd):
+    def handle_response_r1(self, cmd_pin):
         # R1: Normal response command
         #  - Bits[47:47]: Start bit (always 0)
         #  - Bits[46:46]: Transmission bit (0 == card)
@@ -309,7 +313,7 @@ class Decoder(srd.Decoder):
         #  - Bits[39:08]: Card status
         #  - Bits[07:01]: CRC7
         #  - Bits[00:00]: End bit (always 1)
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
         self.handle_common_token_fields()
         self.putr(Ann.R1)
@@ -318,38 +322,38 @@ class Decoder(srd.Decoder):
             self.putbit(8 + i, [card_status[31 - i]])
         self.token, self.state = [], St.GET_COMMAND_TOKEN
 
-    def handle_response_r1b(self, cmd):
+    def handle_response_r1b(self, cmd_pin):
         # R1b: Same as R1 with an optional busy signal (on the data line)
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
         self.handle_common_token_fields()
         self.puta(0, 31, [Ann.DECODED_F, ['Card status', 'Status', 'S']])
         self.putr(Ann.R1B)
         self.token, self.state = [], St.GET_COMMAND_TOKEN
 
-    def handle_response_r2(self, cmd):
+    def handle_response_r2(self, cmd_pin):
         # R2: CID/CSD register
         #  - Bits[135:135]: Start bit (always 0)
         #  - Bits[134:134]: Transmission bit (0 == card)
         #  - Bits[133:128]: Reserved (always 0b111111)
         #  - Bits[127:001]: CID or CSD register including internal CRC7
         #  - Bits[000:000]: End bit (always 1)
-        if not self.get_token_bits(cmd, 136):
+        if not self.get_token_bits(cmd_pin, 136):
             return
         # Annotations for each individual bit.
         for bit in range(len(self.token)):
-            self.putf(bit, bit, [Ann.BIT, ['%d' % self.token[bit][2]]])
+            self.putf(bit, bit, [Ann.BIT, ['%d' % self.token[bit].bit]])
         self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']])
-        t = 'host' if self.token[1][2] == 1 else 'card'
+        t = 'host' if self.token[1].bit == 1 else 'card'
         self.putf(1, 1, [Ann.F_TRANSM, ['Transmission: ' + t, 'T: ' + t, 'T']])
         self.putf(2, 7, [Ann.F_CMD, ['Reserved', 'Res', 'R']])
         self.putf(8, 134, [Ann.F_ARG, ['Argument', 'Arg', 'A']])
         self.putf(135, 135, [Ann.F_END, ['End bit', 'End', 'E']])
         self.putf(8, 134, [Ann.DECODED_F, ['CID/CSD register', 'CID/CSD', 'C']])
-        self.putf(0, 135, [55, ['R2']])
+        self.putf(0, 135, [Ann.R2, ['R2']])
         self.token, self.state = [], St.GET_COMMAND_TOKEN
 
-    def handle_response_r3(self, cmd):
+    def handle_response_r3(self, cmd_pin):
         # R3: OCR register
         #  - Bits[47:47]: Start bit (always 0)
         #  - Bits[46:46]: Transmission bit (0 == card)
@@ -357,14 +361,14 @@ class Decoder(srd.Decoder):
         #  - Bits[39:08]: OCR register
         #  - Bits[07:01]: Reserved (always 0b111111)
         #  - Bits[00:00]: End bit (always 1)
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
         self.putr(Ann.R3)
         # Annotations for each individual bit.
         for bit in range(len(self.token)):
-            self.putf(bit, bit, [Ann.BIT, ['%d' % self.token[bit][2]]])
+            self.putf(bit, bit, [Ann.BIT, ['%d' % self.token[bit].bit]])
         self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']])
-        t = 'host' if self.token[1][2] == 1 else 'card'
+        t = 'host' if self.token[1].bit == 1 else 'card'
         self.putf(1, 1, [Ann.F_TRANSM, ['Transmission: ' + t, 'T: ' + t, 'T']])
         self.putf(2, 7, [Ann.F_CMD, ['Reserved', 'Res', 'R']])
         self.putf(8, 39, [Ann.F_ARG, ['Argument', 'Arg', 'A']])
@@ -373,7 +377,7 @@ class Decoder(srd.Decoder):
         self.puta(0, 31, [Ann.DECODED_F, ['OCR register', 'OCR reg', 'OCR', 'O']])
         self.token, self.state = [], St.GET_COMMAND_TOKEN
 
-    def handle_response_r6(self, cmd):
+    def handle_response_r6(self, cmd_pin):
         # R6: Published RCA response
         #  - Bits[47:47]: Start bit (always 0)
         #  - Bits[46:46]: Transmission bit (0 == card)
@@ -382,7 +386,7 @@ class Decoder(srd.Decoder):
         #  - Bits[23:08]: Argument[15:0]: Card status bits
         #  - Bits[07:01]: CRC7
         #  - Bits[00:00]: End bit (always 1)
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
         self.handle_common_token_fields()
         self.puta(0, 15, [Ann.DECODED_F, ['Card status bits', 'Status', 'S']])
@@ -390,7 +394,7 @@ class Decoder(srd.Decoder):
         self.putr(Ann.R6)
         self.token, self.state = [], St.GET_COMMAND_TOKEN
 
-    def handle_response_r7(self, cmd):
+    def handle_response_r7(self, cmd_pin):
         # R7: Card interface condition
         #  - Bits[47:47]: Start bit (always 0)
         #  - Bits[46:46]: Transmission bit (0 == card)
@@ -400,7 +404,7 @@ class Decoder(srd.Decoder):
         #  - Bits[15:08]: Echo-back of check pattern
         #  - Bits[07:01]: CRC7
         #  - Bits[00:00]: End bit (always 1)
-        if not self.get_token_bits(cmd, 48):
+        if not self.get_token_bits(cmd_pin, 48):
             return
         self.handle_common_token_fields()
 
@@ -410,7 +414,7 @@ class Decoder(srd.Decoder):
         self.puta(12, 31, [Ann.DECODED_F, ['Reserved', 'Res', 'R']])
 
         # Arg[11:08]: Voltage accepted
-        v = ''.join(str(i[2]) for i in self.token[28:32])
+        v = ''.join(str(i.bit) for i in self.token[28:32])
         av = accepted_voltages.get(int('0b' + v, 2), 'Unknown')
         self.puta(8, 11, [Ann.DECODED_F,
             ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']])
@@ -424,15 +428,15 @@ class Decoder(srd.Decoder):
     def decode(self):
         while True:
             # Wait for a rising CLK edge.
-            (cmd, clk, dat0, dat1, dat2, dat3) = self.wait({Pin.CLK: 'r'})
+            (cmd_pin, clk, dat0, dat1, dat2, dat3) = self.wait({Pin.CLK: 'r'})
 
             # State machine.
             if self.state == St.GET_COMMAND_TOKEN:
                 if len(self.token) == 0:
                     # Wait for start bit (CMD = 0).
-                    if cmd != 0:
+                    if cmd_pin != 0:
                         continue
-                self.get_command_token(cmd)
+                self.get_command_token(cmd_pin)
             elif self.state.value.startswith('HANDLE_CMD'):
                 # Call the respective handler method for the command.
                 a, cmdstr = 'a' if self.is_acmd else '', self.state.value[10:].lower()
@@ -444,9 +448,9 @@ class Decoder(srd.Decoder):
             elif self.state.value.startswith('GET_RESPONSE'):
                 if len(self.token) == 0:
                     # Wait for start bit (CMD = 0).
-                    if cmd != 0:
+                    if cmd_pin != 0:
                         continue
                 # Call the respective handler method for the response.
                 s = 'handle_response_%s' % self.state.value[13:].lower()
                 handle_response = getattr(self, s)
-                handle_response(cmd)
+                handle_response(cmd_pin)