X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fsdcard_spi%2Fpd.py;h=545cee58a5b6f470c89129fc719aa2fe7d1f0783;hp=4f7c9f75b5fd9dc652a7eeebd82e4f87d688b0e1;hb=4539e9ca58966ce3c9cad4801b16c315e86ace01;hpb=12851357e784b893e24880efc6cd22a0cbcc64ce diff --git a/decoders/sdcard_spi/pd.py b/decoders/sdcard_spi/pd.py index 4f7c9f7..545cee5 100644 --- a/decoders/sdcard_spi/pd.py +++ b/decoders/sdcard_spi/pd.py @@ -14,67 +14,11 @@ ## 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 - -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', -} - -def cmd_list(): - l = [] - for i in range(63 + 1): - l.append(('cmd%d' % i, 'CMD%d' % i)) - - return tuple(l) +from common.sdcard import (cmd_names, acmd_names) class Decoder(srd.Decoder): api_version = 2 @@ -85,8 +29,9 @@ class Decoder(srd.Decoder): license = 'gplv2+' inputs = ['spi'] outputs = ['sdcard_spi'] - annotations = cmd_list() + ( - ('cmd-desc', 'Command description'), + 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'), @@ -96,18 +41,15 @@ class Decoder(srd.Decoder): ('bit-warnings', 'Bit warnings'), ) 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', (134, 135)), + ('cmd-reply', 'Commands/replies', tuple(range(134))), ) - def __init__(self, **kwargs): + def __init__(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.cmd_token = [] self.cmd_token_bits = [] self.is_acmd = False # Indicates CMD vs. ACMD @@ -119,13 +61,22 @@ class Decoder(srd.Decoder): 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. @@ -139,7 +90,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) @@ -148,7 +99,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 @@ -159,56 +110,52 @@ 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([134, ['Start bit: %d' % bit]]) else: - self.putb([71, ['Start bit: %s (Warning: Must be 0!)' % bit]]) + self.putb([135, ['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([134, ['Transmitter bit: %d' % bit]]) else: - self.putb([71, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]]) + self.putb([135, ['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([134, ['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([134, ['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([134, ['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] + self.putb([134, ['End bit: %d' % bit]]) if bit == 1: - self.putb([70, ['End bit: %d' % bit]]) + self.putb([134, ['End bit: %d' % bit]]) else: - self.putb([71, ['End bit: %d (Warning: Must be 1!)' % bit]]) + 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): 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') @@ -218,23 +165,23 @@ class Decoder(srd.Decoder): # CMD1: SEND_OP_COND self.putc(1, '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([134, ['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)') 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.es_cmd = self.es + self.read_buf = self.read_buf[4:] # TODO: Document or redo. self.putx([9, ['CSD: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] @@ -263,21 +210,16 @@ class Decoder(srd.Decoder): # 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.ss_cmd = self.ss self.read_buf.append(self.miso) if len(self.read_buf) < self.blocklen + 2: # FIXME return - self.cmd_es = self.es + self.es_cmd = self.es self.read_buf = self.read_buf[2:] # FIXME self.putx([17, ['Block data: %s' % self.read_buf]]) self.read_buf = [] 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') - self.state = 'GET RESPONSE R1' - def handle_cmd49(self): self.state = 'GET RESPONSE R1' @@ -294,6 +236,11 @@ class Decoder(srd.Decoder): self.putc(59, '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.state = 'GET RESPONSE R1' + def handle_cmd999(self): self.state = 'GET RESPONSE R1' @@ -338,13 +285,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.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2] self.putx([65, ['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([134, data]) # Bit 0: 'In idle state' bit s = '' if (res & (1 << 0)) else 'not ' @@ -426,11 +373,14 @@ 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? @@ -442,6 +392,3 @@ class Decoder(srd.Decoder): handle_response(miso) self.state = 'IDLE' - else: - raise Exception('Invalid state: %s' % self.state) -