X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fsdcard_spi%2Fpd.py;h=122e9ea118410cb930dd595322f619a897388464;hp=3ffa1e5774d0528736450cde7919258ee6ed8bde;hb=361c1e76a85bb14dce7b9f3e97deb9fe09416a7b;hpb=0169f19c53e195df2f96c4df731ad3214c59e20a diff --git a/decoders/sdcard_spi/pd.py b/decoders/sdcard_spi/pd.py index 3ffa1e5..122e9ea 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 Uwe Hermann +## Copyright (C) 2012-2014 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 @@ -18,8 +18,6 @@ ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ## -# SD card (SPI mode) low-level protocol decoder - import sigrokdecode as srd cmd_name = { @@ -71,6 +69,12 @@ cmd_name = { 51: 'SEND_SCR', } +def ann_cmd_list(): + l = [] + for i in range(63 + 1): + l.append(['cmd%d' % i, 'CMD%d' % i]) + return l + class Decoder(srd.Decoder): api_version = 1 id = 'sdcard_spi' @@ -83,14 +87,21 @@ class Decoder(srd.Decoder): probes = [] optional_probes = [] options = {} - annotations = [ - ['Text', 'Human-readable text'], - ['Warnings', 'Human-readable warnings'], + annotations = ann_cmd_list() + [ + ['cmd-token', 'Command token'], + ['r1', 'R1 reply'], + ['r1b', 'R1B reply'], + ['r2', 'R2 reply'], + ['r3', 'R3 reply'], + ['r7', 'R7 reply'], + ['bits', 'Bits'], ] def __init__(self, **kwargs): 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.cmd_token = [] self.is_acmd = False # Indicates CMD vs. ACMD @@ -98,12 +109,15 @@ class Decoder(srd.Decoder): self.read_buf = [] def start(self): - # self.out_proto = self.register(srd.OUTPUT_PYTHON) + # 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) + def putb(self, data): + self.put(self.bit_ss, self.bit_es, self.out_ann, data) + def handle_command_token(self, mosi, miso): # Command tokens (6 bytes) are sent (MSB-first) by the host. # @@ -115,6 +129,9 @@ class Decoder(srd.Decoder): # - CMD[07:01]: CRC7 # - CMD[00:00]: End bit (always 1) + if len(self.cmd_token) == 0: + self.cmd_ss = self.ss + self.cmd_token.append(mosi) # TODO: Record MISO too? @@ -122,6 +139,8 @@ class Decoder(srd.Decoder): if len(self.cmd_token) < 6: return + self.cmd_es = self.es + # Received all 6 bytes of the command token. Now decode it. t = self.cmd_token @@ -129,47 +148,43 @@ class Decoder(srd.Decoder): # CMD or ACMD? s = 'ACMD' if self.is_acmd else 'CMD' # TODO - self.put(0, 0, self.out_ann, - [0, [s + ': %02x %02x %02x %02x %02x %02x' % tuple(t)]]) + self.putx([64, [s + ': %02x %02x %02x %02x %02x %02x' % tuple(t)]]) # Start bit self.startbit = (t[0] & (1 << 7)) >> 7 - self.put(0, 0, self.out_ann, - [0, ['Start bit: %d' % self.startbit]]) + self.putb([70, ['Start bit: %d' % self.startbit]]) if self.startbit != 0: # TODO - self.put(0, 0, self.out_ann, [1, ['Warning: Start bit != 0']]) + self.putb([1, ['Warning: Start bit != 0']]) # Transmitter bit self.transmitterbit = (t[0] & (1 << 6)) >> 6 - self.put(0, 0, self.out_ann, - [0, ['Transmitter bit: %d' % self.transmitterbit]]) + self.putb([70, ['Transmitter bit: %d' % self.transmitterbit]]) if self.transmitterbit != 0: # TODO - self.put(0, 0, self.out_ann, [1, ['Warning: Transmitter bit != 1']]) + self.putb([1, ['Warning: Transmitter bit != 1']]) # Command index cmd = self.cmd_index = t[0] & 0x3f # TODO - self.put(0, 0, self.out_ann, - [0, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]]) + self.putb([70, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]]) # Argument self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4] - self.put(0, 0, self.out_ann, [0, ['Argument: 0x%04x' % self.arg]]) + self.putb([70, ['Argument: 0x%04x' % self.arg]]) # TODO: Sanity check on argument? Must be per-cmd? # CRC # TODO: Check CRC. self.crc = t[5] >> 1 - self.put(0, 0, self.out_ann, [0, ['CRC: 0x%01x' % self.crc]]) + self.putb([70, ['CRC: 0x%01x' % self.crc]]) # End bit self.endbit = t[5] & (1 << 0) - self.put(0, 0, self.out_ann, [0, ['End bit: %d' % self.endbit]]) + self.putb([70, ['End bit: %d' % self.endbit]]) if self.endbit != 1: # TODO - self.put(0, 0, self.out_ann, [1, ['Warning: End bit != 1']]) + self.putb([1, ['Warning: End bit != 1']]) # Handle command. if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59): @@ -184,25 +199,28 @@ class Decoder(srd.Decoder): def handle_cmd0(self, ): # CMD0: GO_IDLE_STATE # TODO - self.put(0, 0, self.out_ann, [0, ['CMD0: Card reset / idle state']]) + self.putx([0, ['CMD0: Card reset / idle state']]) self.state = 'GET RESPONSE R1' def handle_cmd1(self): # CMD1: SEND_OP_COND # TODO hcs = (self.arg & (1 << 30)) >> 30 - self.put(0, 0, self.out_ann, [0, ['HCS bit = %d' % hcs]]) + self.putb([1, ['HCS bit = %d' % hcs]]) self.state = 'GET RESPONSE R1' def handle_cmd9(self): # CMD9: SEND_CSD (128 bits / 16 bytes) + if len(self.read_buf) == 0: + self.cmd_ss = 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.put(0, 0, self.out_ann, [0, ['CSD: %s' % self.read_buf]]) + self.putx([9, ['CSD: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] ### self.state = 'GET RESPONSE R1' @@ -213,7 +231,7 @@ class Decoder(srd.Decoder): self.read_buf.append(self.miso) if len(self.read_buf) < 16: return - self.put(0, 0, self.out_ann, [0, ['CID: %s' % self.read_buf]]) + self.putx([10, ['CID: %s' % self.read_buf]]) # TODO: Decode all bits. self.read_buf = [] self.state = 'GET RESPONSE R1' @@ -222,19 +240,21 @@ class Decoder(srd.Decoder): # CMD16: SET_BLOCKLEN self.blocklen = self.arg # TODO # TODO: Sanity check on block length. - self.put(0, 0, self.out_ann, [0, ['Block length: %d' % self.blocklen]]) + self.putx([16, ['Block length: %d' % self.blocklen]]) self.state = 'GET RESPONSE R1' def handle_cmd17(self): # CMD17: READ_SINGLE_BLOCK + if len(self.read_buf) == 0: + self.cmd_ss = self.ss self.read_buf.append(self.miso) if len(self.read_buf) == 1: - self.put(0, 0, self.out_ann, - [0, ['Read block at address: 0x%04x' % self.arg]]) + self.putx([0, ['Read block at address: 0x%04x' % self.arg]]) if len(self.read_buf) < self.blocklen + 2: # FIXME return + self.cmd_es = self.es self.read_buf = self.read_buf[2:] # FIXME - self.put(0, 0, self.out_ann, [0, ['Block data: %s' % self.read_buf]]) + self.putx([17, ['Block data: %s' % self.read_buf]]) self.read_buf = [] self.state = 'GET RESPONSE R1' @@ -254,7 +274,7 @@ 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.put(0, 0, self.out_ann, [0, ['SD card CRC option: %s' % s]]) + self.putb([59, ['SD card CRC option: %s' % s]]) self.state = 'GET RESPONSE R1' def handle_cid_register(self): @@ -298,41 +318,39 @@ class Decoder(srd.Decoder): # The R1 response token format (1 byte). # Sent by the card after every command except for SEND_STATUS. - self.put(0, 0, self.out_ann, [0, ['R1: 0x%02x' % res]]) + self.cmd_ss, self.cmd_es = self.ss, self.es + + self.putx([65, ['R1: 0x%02x' % res]]) # TODO: Configurable whether all bits are decoded. # 'In idle state' bit s = '' if (res & (1 << 0)) else 'not ' - self.put(0, 0, self.out_ann, [0, ['Card is %sin idle state' % s]]) + self.putb([0, ['Card is %sin idle state' % s]]) # 'Erase reset' bit s = '' if (res & (1 << 1)) else 'not ' - self.put(0, 0, self.out_ann, [0, ['Erase sequence %scleared' % s]]) + self.putb([0, ['Erase sequence %scleared' % s]]) # 'Illegal command' bit s = 'I' if (res & (1 << 2)) else 'No i' - self.put(0, 0, self.out_ann, [0, ['%sllegal command detected' % s]]) + self.putb([0, ['%sllegal command detected' % s]]) # 'Communication CRC error' bit s = 'failed' if (res & (1 << 3)) else 'was successful' - self.put(0, 0, self.out_ann, - [0, ['CRC check of last command %s' % s]]) + self.putb([0, ['CRC check of last command %s' % s]]) # 'Erase sequence error' bit s = 'E' if (res & (1 << 4)) else 'No e' - self.put(0, 0, self.out_ann, - [0, ['%srror in the sequence of erase commands' % s]]) + self.putb([0, ['%srror in the sequence of erase commands' % s]]) # 'Address error' bit s = 'M' if (res & (1 << 4)) else 'No m' - self.put(0, 0, self.out_ann, - [0, ['%sisaligned address used in command' % s]]) + self.putb([0, ['%sisaligned address used in command' % s]]) # 'Parameter error' bit s = '' if (res & (1 << 4)) else 'not ' - self.put(0, 0, self.out_ann, - [0, ['Command argument %soutside allowed range' % s]]) + self.putb([0, ['Command argument %soutside allowed range' % s]]) self.state = 'IDLE' @@ -363,7 +381,7 @@ class Decoder(srd.Decoder): if ptype != 'DATA': return - self.put(0, 0, self.out_ann, [0, ['0x%02x 0x%02x' % (mosi, miso)]]) + self.ss, self.es = ss, es # State machine. if self.state == 'IDLE': @@ -387,7 +405,6 @@ class Decoder(srd.Decoder): # Call the respective handler method for the response. s = 'handle_response_%s' % self.state[13:].lower() - # self.put(0, 0, self.out_ann, [0, [s]]) # TODO handle_response = getattr(self, s) handle_response(miso)