X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fsdcard_spi%2Fpd.py;h=49cfdef1f8522c5bf6bd7c8f490fc3f25ff99d6a;hp=c61c8c25833bd6e277762aaba189eeffe4179bec;hb=HEAD;hpb=780770f1295b7fdeb4481eb42623bad5da1e19a7 diff --git a/decoders/sdcard_spi/pd.py b/decoders/sdcard_spi/pd.py index c61c8c2..49cfdef 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 +## Copyright (C) 2012-2020 Uwe Hermann ## ## 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 @@ -14,113 +14,82 @@ ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; if not, write to the Free Software -## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## along with this program; if not, see . ## import sigrokdecode as srd +from common.srdhelper import SrdIntEnum +from common.sdcard import (cmd_names, acmd_names) -cmd_name = { - # Normal commands (CMD) - 0: 'GO_IDLE_STATE', - 1: 'SEND_OP_COND', - 6: 'SWITCH_FUNC', - 8: 'SEND_IF_COND', - 9: 'SEND_CSD', - 10: 'SEND_CID', - 12: 'STOP_TRANSMISSION', - 13: 'SEND_STATUS', - 16: 'SET_BLOCKLEN', - 17: 'READ_SINGLE_BLOCK', - 18: 'READ_MULTIPLE_BLOCK', - 24: 'WRITE_BLOCK', - 25: 'WRITE_MULTIPLE_BLOCK', - 27: 'PROGRAM_CSD', - 28: 'SET_WRITE_PROT', - 29: 'CLR_WRITE_PROT', - 30: 'SEND_WRITE_PROT', - 32: 'ERASE_WR_BLK_START_ADDR', - 33: 'ERASE_WR_BLK_END_ADDR', - 38: 'ERASE', - 42: 'LOCK_UNLOCK', - 55: 'APP_CMD', - 56: 'GEN_CMD', - 58: 'READ_OCR', - 59: 'CRC_ON_OFF', - # CMD60-63: Reserved for manufacturer - - # Application-specific commands (ACMD) - 13: 'SD_STATUS', - 18: 'Reserved for SD security applications', - 22: 'SEND_NUM_WR_BLOCKS', - 23: 'SET_WR_BLK_ERASE_COUNT', - 25: 'Reserved for SD security applications', - 26: 'Reserved for SD security applications', - 38: 'Reserved for SD security applications', - 41: 'SD_SEND_OP_COND', - 42: 'SET_CLR_CARD_DETECT', - 43: 'Reserved for SD security applications', - 44: 'Reserved for SD security applications', - 45: 'Reserved for SD security applications', - 46: 'Reserved for SD security applications', - 47: 'Reserved for SD security applications', - 48: 'Reserved for SD security applications', - 49: 'Reserved for SD security applications', - 51: 'SEND_SCR', -} +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 = 1 + api_version = 3 id = 'sdcard_spi' name = 'SD card (SPI mode)' longname = 'Secure Digital card (SPI mode)' desc = 'Secure Digital card (SPI mode) low-level protocol.' license = 'gplv2+' inputs = ['spi'] - outputs = ['sdcard_spi'] + outputs = [] + tags = ['Memory'] annotations = \ - [['cmd%d' % i, 'CMD%d' % i] for i in range(63 + 1)] + [ - ['cmd-desc', 'Command description'], - ['r1', 'R1 reply'], - ['r1b', 'R1B reply'], - ['r2', 'R2 reply'], - ['r3', 'R3 reply'], - ['r7', 'R7 reply'], - ['bits', 'Bits'], - ['bit-warnings', 'Bit warnings'], - ] + tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \ + 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', (70, 71)), - ('cmd-reply', 'Commands/replies', - tuple(range(0, 63 + 1)) + tuple(range(65, 69 + 1))), - ('cmd-token', 'Command tokens', (64,)), + ('bits', 'Bits', (Ann.BIT, Ann.BIT_WARNING)), + ('commands-replies', 'Commands/replies', Ann.prefixes('CMD ACMD R')), ) - def __init__(self, **kwargs): + def __init__(self): + self.reset() + + def reset(self): self.state = 'IDLE' - self.samplenum = 0 self.ss, self.es = 0, 0 - self.bit_ss, self.bit_es = 0, 0 - self.cmd_ss, self.cmd_es = 0, 0 + self.ss_bit, self.es_bit = 0, 0 + self.ss_cmd, self.es_cmd = 0, 0 + self.ss_busy, self.es_busy = 0, 0 self.cmd_token = [] self.cmd_token_bits = [] self.is_acmd = False # Indicates CMD vs. ACMD self.blocklen = 0 self.read_buf = [] self.cmd_str = '' + self.is_cmd24 = False + self.cmd24_start_token_found = False + self.is_cmd17 = False + self.cmd17_start_token_found = False + self.busy_first_byte = False def start(self): - # self.out_python = self.register(srd.OUTPUT_PYTHON) self.out_ann = self.register(srd.OUTPUT_ANN) def putx(self, data): - self.put(self.cmd_ss, self.cmd_es, self.out_ann, data) + self.put(self.ss_cmd, self.es_cmd, self.out_ann, data) def putc(self, cmd, desc): self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]]) def putb(self, data): - self.put(self.bit_ss, self.bit_es, self.out_ann, data) + self.put(self.ss_bit, self.es_bit, self.out_ann, data) + + def cmd_name(self, cmd): + c = acmd_names if self.is_acmd else cmd_names + s = c.get(cmd, 'Unknown') + # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}. + # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR. + if cmd in (32, 33): + s += '_ADDR' + return s def handle_command_token(self, mosi, miso): # Command tokens (6 bytes) are sent (MSB-first) by the host. @@ -134,7 +103,7 @@ class Decoder(srd.Decoder): # - CMD[00:00]: End bit (always 1) if len(self.cmd_token) == 0: - self.cmd_ss = self.ss + self.ss_cmd = self.ss self.cmd_token.append(mosi) self.cmd_token_bits.append(self.mosi_bits) @@ -143,7 +112,7 @@ class Decoder(srd.Decoder): if len(self.cmd_token) < 6: return - self.cmd_es = self.es + self.es_cmd = self.es t = self.cmd_token @@ -154,83 +123,78 @@ class Decoder(srd.Decoder): return self.cmd_token_bits[5 - byte][bit] # Bits[47:47]: Start bit (always 0) - bit, self.bit_ss, self.bit_es = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2] + bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2] if bit == 0: - self.putb([70, ['Start bit: %d' % bit]]) + self.putb([Ann.BIT, ['Start bit: %d' % bit]]) else: - self.putb([71, ['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.bit_ss, self.bit_es = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2] + bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2] if bit == 1: - self.putb([70, ['Transmitter bit: %d' % bit]]) + self.putb([Ann.BIT, ['Transmitter bit: %d' % bit]]) else: - self.putb([71, ['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.bit_ss, self.bit_es = tb(5, 5)[1], tb(5, 0)[2] - self.putb([70, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]]) + self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2] + 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.bit_ss, self.bit_es = tb(4, 7)[1], tb(1, 0)[2] - self.putb([70, ['Argument: 0x%04x' % self.arg]]) + self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2] + self.putb([Ann.BIT, ['Argument: 0x%04x' % self.arg]]) # Bits[7:1]: CRC7 # TODO: Check CRC7. crc = t[5] >> 1 - self.bit_ss, self.bit_es = tb(0, 7)[1], tb(0, 1)[2] - self.putb([70, ['CRC7: 0x%01x' % crc]]) + self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2] + self.putb([Ann.BIT, ['CRC7: 0x%01x' % crc]]) # Bits[0:0]: End bit (always 1) - bit, self.bit_ss, self.bit_es = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2] - self.putb([70, ['End bit: %d' % bit]]) + bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2] if bit == 1: - self.putb([70, ['End bit: %d' % bit]]) + self.putb([Ann.BIT, ['End bit: %d' % bit]]) else: - self.putb([71, ['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, 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, cmd_name[cmd]) + self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd)) else: self.state = 'HANDLE CMD999' a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t)) self.putx([cmd, [a]]) - # ... - if self.is_acmd and cmd != 55: - self.is_acmd = False - 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.bit_ss = self.cmd_token_bits[5 - 4][6][1] - self.bit_es = self.cmd_token_bits[5 - 4][6][2] - self.putb([70, ['HCS: %d' % hcs]]) + self.ss_bit = self.cmd_token_bits[5 - 4][6][1] + self.es_bit = self.cmd_token_bits[5 - 4][6][2] + 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.cmd_ss = self.ss + self.ss_cmd = self.ss self.read_buf.append(self.miso) # FIXME ### if len(self.read_buf) < 16: if len(self.read_buf) < 16 + 4: return - self.cmd_es = self.es - self.read_buf = self.read_buf[4:] ### TODO: Document or redo. - self.putx([9, ['CSD: %s' % self.read_buf]]) + self.es_cmd = self.es + self.read_buf = self.read_buf[4:] # TODO: Document or redo. + self.putx([Ann.CMD9, ['CSD: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] ### self.state = 'GET RESPONSE R1' @@ -238,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' @@ -251,26 +215,19 @@ 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) - if len(self.read_buf) == 0: - self.cmd_ss = self.ss - self.read_buf.append(self.miso) - if len(self.read_buf) < self.blocklen + 2: # FIXME - return - self.cmd_es = self.es - self.read_buf = self.read_buf[2:] # FIXME - self.putx([17, ['Block data: %s' % self.read_buf]]) - self.read_buf = [] + self.putc(Ann.CMD17, 'Read a block from address 0x%04x' % self.arg) + self.is_cmd17 = True self.state = 'GET RESPONSE R1' - def handle_cmd41(self): - # ACMD41: SD_SEND_OP_COND - self.putc(41, 'Send HCS info and activate the card init process') + def handle_cmd24(self): + # CMD24: WRITE_BLOCK + self.putc(Ann.CMD24, 'Write a block to address 0x%04x' % self.arg) + self.is_cmd24 = True self.state = 'GET RESPONSE R1' def handle_cmd49(self): @@ -278,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' @@ -286,7 +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(Ann.ACMD41, 'Send HCS info and activate the card init process') self.state = 'GET RESPONSE R1' def handle_cmd999(self): @@ -333,13 +295,13 @@ class Decoder(srd.Decoder): # The R1 response token format (1 byte). # Sent by the card after every command except for SEND_STATUS. - self.cmd_ss, self.cmd_es = self.miso_bits[7][1], self.miso_bits[0][2] - self.putx([65, ['R1: 0x%02x' % res]]) + self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2] + self.putx([Ann.R1, ['R1: 0x%02x' % res]]) def putbit(bit, data): b = self.miso_bits[bit] - self.bit_ss, self.bit_es = b[1], b[2] - self.putb([70, data]) + self.ss_bit, self.es_bit = b[1], b[2] + self.putb([Ann.BIT, data]) # Bit 0: 'In idle state' bit s = '' if (res & (1 << 0)) else 'not ' @@ -372,7 +334,10 @@ class Decoder(srd.Decoder): # Bit 7: Always set to 0 putbit(7, ['Bit 7 (always 0)']) - self.state = 'IDLE' + if self.is_cmd17: + self.state = 'HANDLE DATA BLOCK CMD17' + if self.is_cmd24: + self.state = 'HANDLE DATA BLOCK CMD24' def handle_response_r1b(self, res): # TODO @@ -394,6 +359,109 @@ class Decoder(srd.Decoder): # TODO pass + def handle_data_cmd17(self, miso): + # CMD17 returns one byte R1, then some bytes 0xff, then a Start Block + # (single byte 0xfe), then self.blocklen bytes of data, then always + # 2 bytes of CRC. + if self.cmd17_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 PD option? + self.blocklen = 512 + self.read_buf.append(miso) + # Wait until block transfer completed. + if len(self.read_buf) < self.blocklen: + return + if len(self.read_buf) == self.blocklen: + self.es_data = self.es + 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, [Ann.CMD17, ['CRC']]) + self.state = 'IDLE' + elif miso == 0xfe: + 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): + 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, [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, [Ann.CMD24, ['Start Block']]) + self.cmd24_start_token_found = True + + def handle_data_response(self, miso): + # Data Response token (1 byte). + # + # Format: + # - Bits[7:5]: Don't care. + # - Bits[4:4]: Always 0. + # - Bits[3:1]: Status. + # - 010: Data accepted. + # - 101: Data rejected due to a CRC error. + # - 110: Data rejected due to a write error. + # - Bits[0:0]: Always 1. + miso &= 0x1f + if miso & 0x11 != 0x01: + # This is not the byte we are waiting for. + # Should we return to IDLE here? + return + m = self.miso_bits + 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, [Ann.BIT, ['Data accepted']]) + elif miso == 0x0b: + 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, [Ann.BIT, ['Data rejected (write error)']]) + self.put(m[0][1], m[0][2], self.out_ann, [Ann.BIT, ['Always 1']]) + cls = Ann.CMD24 if self.is_cmd24 else None + if cls is not None: + self.put(self.ss, self.es, self.out_ann, [cls, ['Data Response']]) + if self.is_cmd24: + # We just send a block of data to be written to the card, + # this takes some time. + self.state = 'WAIT WHILE CARD BUSY' + self.busy_first_byte = True + else: + self.state = 'IDLE' + + def wait_while_busy(self, miso): + if miso != 0x00: + cls = Ann.CMD24 if self.is_cmd24 else None + if cls is not None: + self.put(self.ss_busy, self.es_busy, self.out_ann, [cls, ['Card is busy']]) + self.state = 'IDLE' + return + else: + if self.busy_first_byte: + self.ss_busy = self.ss + self.busy_first_byte = False + else: + self.es_busy = self.es + def decode(self, ss, es, data): ptype, mosi, miso = data @@ -421,22 +489,30 @@ class Decoder(srd.Decoder): elif self.state.startswith('HANDLE CMD'): self.miso, self.mosi = miso, mosi # Call the respective handler method for the command. - s = 'handle_cmd%s' % self.state[10:].lower() - handle_cmd = getattr(self, s) + a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower() + handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr)) handle_cmd() self.cmd_token = [] self.cmd_token_bits = [] + # Leave ACMD mode again after the first command after CMD55. + if self.is_acmd and cmdstr != '55': + self.is_acmd = False elif self.state.startswith('GET RESPONSE'): # 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' - else: - raise Exception('Invalid state: %s' % self.state) - + handle_response(miso) + elif self.state == 'HANDLE DATA BLOCK CMD17': + self.handle_data_cmd17(miso) + elif self.state == 'HANDLE DATA BLOCK CMD24': + self.handle_data_cmd24(mosi) + elif self.state == 'DATA RESPONSE': + self.handle_data_response(miso) + elif self.state == 'WAIT WHILE CARD BUSY': + self.wait_while_busy(miso)