diff options
| -rw-r--r-- | decoders/sdcard_spi/pd.py | 97 |
1 files changed, 50 insertions, 47 deletions
diff --git a/decoders/sdcard_spi/pd.py b/decoders/sdcard_spi/pd.py index 5b34209..af896af 100644 --- a/decoders/sdcard_spi/pd.py +++ b/decoders/sdcard_spi/pd.py @@ -1,7 +1,7 @@ ## ## This file is part of the libsigrokdecode project. ## -## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de> +## Copyright (C) 2012-2020 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 @@ -18,8 +18,15 @@ ## import sigrokdecode as srd +from common.srdhelper import SrdIntEnum from common.sdcard import (cmd_names, acmd_names) +responses = '1 1b 2 3 7'.split() + +a = ['CMD%d' % i for i in range(64)] + ['ACMD%d' % i for i in range(64)] + \ + ['R' + r.upper() for r in responses] + ['BIT', 'BIT_WARNING'] +Ann = SrdIntEnum.from_list('Ann', a) + class Decoder(srd.Decoder): api_version = 3 id = 'sdcard_spi' @@ -32,18 +39,14 @@ class Decoder(srd.Decoder): 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)) + ( \ - ('r1', 'R1 reply'), - ('r1b', 'R1B reply'), - ('r2', 'R2 reply'), - ('r3', 'R3 reply'), - ('r7', 'R7 reply'), + tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + \ + tuple(('r%s' % r, 'R%s response' % r) for r in responses) + ( \ ('bit', 'Bit'), ('bit-warning', 'Bit warning'), ) annotation_rows = ( - ('bits', 'Bits', (133, 134)), - ('commands-replies', 'Commands/replies', tuple(range(133))), + ('bits', 'Bits', (Ann.BIT, Ann.BIT_WARNING)), + ('commands-replies', 'Commands/replies', Ann.prefixes('CMD ACMD R')), ) def __init__(self): @@ -122,39 +125,39 @@ class Decoder(srd.Decoder): # Bits[47:47]: Start bit (always 0) bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2] if bit == 0: - self.putb([134, ['Start bit: %d' % bit]]) + self.putb([Ann.BIT, ['Start bit: %d' % bit]]) else: - self.putb([135, ['Start bit: %s (Warning: Must be 0!)' % bit]]) + self.putb([Ann.BIT_WARNING, ['Start bit: %s (Warning: Must be 0!)' % bit]]) # Bits[46:46]: Transmitter bit (1 == host) bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2] if bit == 1: - self.putb([134, ['Transmitter bit: %d' % bit]]) + self.putb([Ann.BIT, ['Transmitter bit: %d' % bit]]) else: - self.putb([135, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]]) + self.putb([Ann.BIT_WARNING, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]]) # Bits[45:40]: Command index (BCD; valid: 0-63) cmd = self.cmd_index = t[0] & 0x3f self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2] - self.putb([134, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]]) + self.putb([Ann.BIT, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]]) # Bits[39:8]: Argument self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4] self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2] - self.putb([134, ['Argument: 0x%04x' % self.arg]]) + self.putb([Ann.BIT, ['Argument: 0x%04x' % self.arg]]) # Bits[7:1]: CRC7 # TODO: Check CRC7. crc = t[5] >> 1 self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2] - self.putb([134, ['CRC7: 0x%01x' % crc]]) + self.putb([Ann.BIT, ['CRC7: 0x%01x' % crc]]) # Bits[0:0]: End bit (always 1) bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2] if bit == 1: - self.putb([134, ['End bit: %d' % bit]]) + self.putb([Ann.BIT, ['End bit: %d' % bit]]) else: - self.putb([135, ['End bit: %d (Warning: Must be 1!)' % bit]]) + self.putb([Ann.BIT_WARNING, ['End bit: %d (Warning: Must be 1!)' % bit]]) # Handle command. if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59): @@ -167,21 +170,21 @@ class Decoder(srd.Decoder): def handle_cmd0(self): # CMD0: GO_IDLE_STATE - self.putc(0, 'Reset the SD card') + self.putc(Ann.CMD0, 'Reset the SD card') self.state = 'GET RESPONSE R1' def handle_cmd1(self): # CMD1: SEND_OP_COND - self.putc(1, 'Send HCS info and activate the card init process') + self.putc(Ann.CMD1, 'Send HCS info and activate the card init process') hcs = (self.arg & (1 << 30)) >> 30 self.ss_bit = self.cmd_token_bits[5 - 4][6][1] self.es_bit = self.cmd_token_bits[5 - 4][6][2] - self.putb([134, ['HCS: %d' % hcs]]) + self.putb([Ann.BIT, ['HCS: %d' % hcs]]) self.state = 'GET RESPONSE R1' def handle_cmd9(self): # CMD9: SEND_CSD (128 bits / 16 bytes) - self.putc(9, 'Ask card to send its card specific data (CSD)') + self.putc(Ann.CMD9, 'Ask card to send its card specific data (CSD)') if len(self.read_buf) == 0: self.ss_cmd = self.ss self.read_buf.append(self.miso) @@ -191,7 +194,7 @@ class Decoder(srd.Decoder): return self.es_cmd = self.es self.read_buf = self.read_buf[4:] # TODO: Document or redo. - self.putx([9, ['CSD: %s' % self.read_buf]]) + self.putx([Ann.CMD9, ['CSD: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] ### self.state = 'GET RESPONSE R1' @@ -199,11 +202,11 @@ class Decoder(srd.Decoder): def handle_cmd10(self): # CMD10: SEND_CID (128 bits / 16 bytes) - self.putc(10, 'Ask card to send its card identification (CID)') + self.putc(Ann.CMD10, 'Ask card to send its card identification (CID)') self.read_buf.append(self.miso) if len(self.read_buf) < 16: return - self.putx([10, ['CID: %s' % self.read_buf]]) + self.putx([Ann.CMD10, ['CID: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] self.state = 'GET RESPONSE R1' @@ -212,18 +215,18 @@ class Decoder(srd.Decoder): # CMD16: SET_BLOCKLEN self.blocklen = self.arg # TODO: Sanity check on block length. - self.putc(16, 'Set the block length to %d bytes' % self.blocklen) + self.putc(Ann.CMD16, 'Set the block length to %d bytes' % self.blocklen) self.state = 'GET RESPONSE R1' def handle_cmd17(self): # CMD17: READ_SINGLE_BLOCK - self.putc(17, 'Read a block from address 0x%04x' % self.arg) + self.putc(Ann.CMD17, 'Read a block from address 0x%04x' % self.arg) self.is_cmd17 = True 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.putc(Ann.CMD24, 'Write a block to address 0x%04x' % self.arg) self.is_cmd24 = True self.state = 'GET RESPONSE R1' @@ -232,7 +235,7 @@ class Decoder(srd.Decoder): def handle_cmd55(self): # CMD55: APP_CMD - self.putc(55, 'Next command is an application-specific command') + self.putc(Ann.CMD55, 'Next command is an application-specific command') self.is_acmd = True self.state = 'GET RESPONSE R1' @@ -240,12 +243,12 @@ class Decoder(srd.Decoder): # CMD59: CRC_ON_OFF crc_on_off = self.arg & (1 << 0) s = 'on' if crc_on_off == 1 else 'off' - self.putc(59, 'Turn the SD card CRC option %s' % s) + self.putc(Ann.CMD59, 'Turn the SD card CRC option %s' % s) self.state = 'GET RESPONSE R1' def handle_acmd41(self): # ACMD41: SD_SEND_OP_COND - self.putc(64 + 41, 'Send HCS info and activate the card init process') + self.putc(Ann.ACMD41, 'Send HCS info and activate the card init process') self.state = 'GET RESPONSE R1' def handle_cmd999(self): @@ -293,12 +296,12 @@ class Decoder(srd.Decoder): # Sent by the card after every command except for SEND_STATUS. self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2] - self.putx([65, ['R1: 0x%02x' % res]]) + self.putx([Ann.R1, ['R1: 0x%02x' % res]]) def putbit(bit, data): b = self.miso_bits[bit] self.ss_bit, self.es_bit = b[1], b[2] - self.putb([134, data]) + self.putb([Ann.BIT, data]) # Bit 0: 'In idle state' bit s = '' if (res & (1 << 0)) else 'not ' @@ -374,16 +377,16 @@ class Decoder(srd.Decoder): return if len(self.read_buf) == self.blocklen: self.es_data = self.es - self.put(self.ss_data, self.es_data, self.out_ann, [17, ['Block data: %s' % self.read_buf]]) + self.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD17, ['Block data: %s' % self.read_buf]]) elif len(self.read_buf) == (self.blocklen + 1): self.ss_crc = self.ss elif len(self.read_buf) == (self.blocklen + 2): self.es_crc = self.es # TODO: Check CRC. - self.put(self.ss_crc, self.es_crc, self.out_ann, [17, ['CRC']]) + self.put(self.ss_crc, self.es_crc, self.out_ann, [Ann.CMD17, ['CRC']]) self.state = 'IDLE' elif miso == 0xfe: - self.put(self.ss, self.es, self.out_ann, [17, ['Start Block']]) + self.put(self.ss, self.es, self.out_ann, [Ann.CMD17, ['Start Block']]) self.cmd17_start_token_found = True def handle_data_cmd24(self, mosi): @@ -401,11 +404,11 @@ class Decoder(srd.Decoder): 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.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD24, ['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.put(self.ss, self.es, self.out_ann, [Ann.CMD24, ['Start Block']]) self.cmd24_start_token_found = True def handle_data_response(self, miso): @@ -425,18 +428,18 @@ class Decoder(srd.Decoder): # Should we return to IDLE here? return m = self.miso_bits - self.put(m[7][1], m[5][2], self.out_ann, [134, ['Don\'t care']]) - self.put(m[4][1], m[4][2], self.out_ann, [134, ['Always 0']]) + self.put(m[7][1], m[5][2], self.out_ann, [Ann.BIT, ['Don\'t care']]) + self.put(m[4][1], m[4][2], self.out_ann, [Ann.BIT, ['Always 0']]) if miso == 0x05: - self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data accepted']]) + self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data accepted']]) elif miso == 0x0b: - self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (CRC error)']]) + self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (CRC error)']]) elif miso == 0x0d: - self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (write error)']]) - self.put(m[0][1], m[0][2], self.out_ann, [134, ['Always 1']]) + self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (write error)']]) + self.put(m[0][1], m[0][2], self.out_ann, [Ann.BIT, ['Always 1']]) ann_class = None if self.is_cmd24: - ann_class = 24 + ann_class = Ann.CMD24 if ann_class is not None: self.put(self.ss, self.es, self.out_ann, [ann_class, ['Data Response']]) if self.is_cmd24: @@ -451,9 +454,9 @@ class Decoder(srd.Decoder): if miso != 0x00: ann_class = None if self.is_cmd24: - ann_class = 24 + ann_class = Ann.CMD24 if ann_class is not None: - self.put(self.ss_busy, self.es_busy, self.out_ann, [24, ['Card is busy']]) + self.put(self.ss_busy, self.es_busy, self.out_ann, [Ann.CMD24, ['Card is busy']]) self.state = 'IDLE' return else: |