##
## This file is part of the libsigrokdecode project.
##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2014 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
## 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 <http://www.gnu.org/licenses/>.
##
-# SD card (SPI mode) low-level protocol decoder
-
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',
-}
+from common.sdcard import (cmd_names, acmd_names)
class Decoder(srd.Decoder):
- api_version = 1
+ api_version = 2
id = 'sdcard_spi'
name = 'SD card (SPI mode)'
longname = 'Secure Digital card (SPI mode)'
license = 'gplv2+'
inputs = ['spi']
outputs = ['sdcard_spi']
- probes = []
- optional_probes = []
- options = {}
- annotations = [
- ['Text', 'Human-readable text'],
- ['Warnings', 'Human-readable warnings'],
- ]
-
- def __init__(self, **kwargs):
+ 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'),
+ ('bits', 'Bits'),
+ ('bit-warnings', 'Bit warnings'),
+ )
+ annotation_rows = (
+ ('bits', 'Bits', (134, 135)),
+ ('cmd-reply', 'Commands/replies', tuple(range(134))),
+ )
+
+ def __init__(self):
self.state = 'IDLE'
- self.samplenum = 0
- self.cmd_ss, self.cmd_es = 0, 0
+ self.ss, self.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
self.blocklen = 0
self.read_buf = []
+ self.cmd_str = ''
def start(self):
- # self.out_proto = 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.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.
# - CMD[07:01]: CRC7
# - CMD[00:00]: End bit (always 1)
+ if len(self.cmd_token) == 0:
+ self.ss_cmd = self.ss
+
self.cmd_token.append(mosi)
- # TODO: Record MISO too?
+ self.cmd_token_bits.append(self.mosi_bits)
# All command tokens are 6 bytes long.
if len(self.cmd_token) < 6:
return
- # Received all 6 bytes of the command token. Now decode it.
+ self.es_cmd = self.es
t = self.cmd_token
# 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)]])
-
- # Start bit
- self.startbit = (t[0] & (1 << 7)) >> 7
- self.put(0, 0, self.out_ann,
- [0, ['Start bit: %d' % self.startbit]])
- if self.startbit != 0:
- # TODO
- self.put(0, 0, self.out_ann, [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]])
- if self.transmitterbit != 0:
- # TODO
- self.put(0, 0, self.out_ann, [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])]])
- # 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]])
- # TODO: Sanity check on argument? Must be per-cmd?
+ def tb(byte, bit):
+ return self.cmd_token_bits[5 - byte][bit]
- # CRC
- # TODO: Check CRC.
- self.crc = t[5] >> 1
- self.put(0, 0, self.out_ann, [0, ['CRC: 0x%01x' % self.crc]])
+ # 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]])
+ else:
+ self.putb([135, ['Start bit: %s (Warning: Must be 0!)' % bit]])
- # End bit
- self.endbit = t[5] & (1 << 0)
- self.put(0, 0, self.out_ann, [0, ['End bit: %d' % self.endbit]])
- if self.endbit != 1:
- # TODO
- self.put(0, 0, self.out_ann, [1, ['Warning: End bit != 1']])
+ # 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]])
+ else:
+ 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.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.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.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.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([134, ['End bit: %d' % bit]])
+ else:
+ 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, 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
-
- self.cmd_token = []
-
- def handle_cmd0(self, ):
+ def handle_cmd0(self):
# CMD0: GO_IDLE_STATE
- # TODO
- self.put(0, 0, self.out_ann, [0, ['CMD0: Card reset / idle state']])
+ self.putc(0, 'Reset the SD card')
self.state = 'GET RESPONSE R1'
def handle_cmd1(self):
# CMD1: SEND_OP_COND
- # TODO
+ self.putc(1, 'Send HCS info and activate the card init process')
hcs = (self.arg & (1 << 30)) >> 30
- self.put(0, 0, self.out_ann, [0, ['HCS bit = %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.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.read_buf = self.read_buf[4:] ### TODO: Document or redo.
- self.put(0, 0, self.out_ann, [0, ['CSD: %s' % self.read_buf]])
+ 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 = []
### self.state = 'GET RESPONSE R1'
def handle_cmd10(self):
# CMD10: SEND_CID (128 bits / 16 bytes)
+ self.putc(10, 'Ask card to send its card identification (CID)')
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'
def handle_cmd16(self):
# CMD16: SET_BLOCKLEN
- self.blocklen = self.arg # TODO
+ self.blocklen = self.arg
# TODO: Sanity check on block length.
- self.put(0, 0, self.out_ann, [0, ['Block length: %d' % self.blocklen]])
+ self.putc(16, '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.ss_cmd = 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]])
if len(self.read_buf) < self.blocklen + 2: # FIXME
return
+ self.es_cmd = 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'
- def handle_cmd41(self):
- # ACMD41: SD_SEND_OP_COND
- self.state = 'GET RESPONSE R1'
-
def handle_cmd49(self):
self.state = 'GET RESPONSE R1'
def handle_cmd55(self):
# CMD55: APP_CMD
+ self.putc(55, 'Next command is an application-specific command')
self.is_acmd = True
self.state = 'GET RESPONSE R1'
# 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.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'
def handle_cid_register(self):
# 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.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2]
+ self.putx([65, ['R1: 0x%02x' % res]])
- # TODO: Configurable whether all bits are decoded.
+ def putbit(bit, data):
+ b = self.miso_bits[bit]
+ self.ss_bit, self.es_bit = b[1], b[2]
+ self.putb([134, data])
- # 'In idle state' bit
+ # Bit 0: '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]])
+ putbit(0, ['Card is %sin idle state' % s])
- # 'Erase reset' bit
+ # Bit 1: 'Erase reset' bit
s = '' if (res & (1 << 1)) else 'not '
- self.put(0, 0, self.out_ann, [0, ['Erase sequence %scleared' % s]])
+ putbit(1, ['Erase sequence %scleared' % s])
- # 'Illegal command' bit
+ # Bit 2: 'Illegal command' bit
s = 'I' if (res & (1 << 2)) else 'No i'
- self.put(0, 0, self.out_ann, [0, ['%sllegal command detected' % s]])
+ putbit(2, ['%sllegal command detected' % s])
- # 'Communication CRC error' bit
+ # Bit 3: '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]])
+ putbit(3, ['CRC check of last command %s' % s])
- # 'Erase sequence error' bit
+ # Bit 4: '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]])
+ putbit(4, ['%srror in the sequence of erase commands' % s])
- # 'Address error' bit
+ # Bit 5: '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]])
+ putbit(5, ['%sisaligned address used in command' % s])
- # 'Parameter error' bit
+ # Bit 6: 'Parameter error' bit
s = '' if (res & (1 << 4)) else 'not '
- self.put(0, 0, self.out_ann,
- [0, ['Command argument %soutside allowed range' % s]])
+ putbit(6, ['Command argument %soutside allowed range' % s])
+
+ # Bit 7: Always set to 0
+ putbit(7, ['Bit 7 (always 0)'])
self.state = 'IDLE'
def decode(self, ss, es, data):
ptype, mosi, miso = data
- # For now, ignore non-data packets.
- if ptype != 'DATA':
+ # For now, only use DATA and BITS packets.
+ if ptype not in ('DATA', 'BITS'):
return
- self.put(0, 0, self.out_ann, [0, ['0x%02x 0x%02x' % (mosi, miso)]])
+ # Store the individual bit values and ss/es numbers. The next packet
+ # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
+ if ptype == 'BITS':
+ self.miso_bits, self.mosi_bits = miso, mosi
+ return
+
+ self.ss, self.es = ss, es
# State machine.
if self.state == 'IDLE':
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?
# 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)
self.state = 'IDLE'
- else:
- raise Exception('Invalid state: %s' % self.state)
-
projects / libsigrokdecode.git / blobdiff