##
## 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
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'
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'],
]
+ annotation_rows = (
+ ('bits', 'Bits', (70,)),
+ ('cmd-reply', 'Commands/replies',
+ tuple(range(0, 63 + 1)) + tuple(range(65, 69 + 1))),
+ ('cmd-token', 'Command tokens', (64,)),
+ )
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.cmd_token_bits = []
self.is_acmd = False # Indicates CMD vs. ACMD
self.blocklen = 0
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.
#
# - 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)
+ self.cmd_token_bits.append(self.mosi_bits)
# TODO: Record MISO too?
# All command tokens are 6 bytes long.
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
# 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:
+ self.putx([64, [s + ': %02x %02x %02x %02x %02x %02x' % tuple(t)]])
+
+ def tb(byte, bit):
+ return self.cmd_token_bits[5 - byte][7 - 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]
+ self.putb([70, ['Start bit: %d' % bit]])
+ if bit != 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]])
- if self.transmitterbit != 0:
+ # 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]
+ self.putb([70, ['Transmitter bit: %d' % bit]])
+ if bit != 1:
# 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
+ # Bits[45:40]: Command index (BCD; valid: 0-63)
+ cmd = self.cmd_index = t[5] & 0x3f
# TODO
- self.put(0, 0, self.out_ann,
- [0, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]])
+ 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])]])
- # Argument
+ # Bits[39:8]: 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.bit_ss, self.bit_es = tb(4, 7)[1], tb(1, 0)[2]
+ self.putb([70, ['Argument: 0x%04x' % self.arg]])
# TODO: Sanity check on argument? Must be per-cmd?
- # CRC
+ # Bits[7:1]: CRC
# TODO: Check CRC.
- self.crc = t[5] >> 1
- self.put(0, 0, self.out_ann, [0, ['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]])
- if self.endbit != 1:
+ crc = t[5] >> 1
+ self.bit_ss, self.bit_es = tb(0, 7)[1], tb(0, 1)[2]
+ self.putb([70, ['CRC: 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]])
+ if bit != 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):
self.is_acmd = False
self.cmd_token = []
+ self.cmd_token_bits = []
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'
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'
# 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'
# 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):
# 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.
+ def putbit(bit, data):
+ b = self.miso_bits[7 - bit]
+ self.bit_ss, self.bit_es = b[1], b[2]
+ self.putb([70, 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
+
+ # 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.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':
# 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)
projects / libsigrokdecode.git / blobdiff