[libsigrokdecode.git] / decoders / sdcard_sd / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2015-2020 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
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## 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, see <http://www.gnu.org/licenses/>.
##

import sigrokdecode as srd
from common.srdhelper import SrdStrEnum
from common.sdcard import (cmd_names, acmd_names, accepted_voltages, card_status, sd_status)

s = ['GET_COMMAND_TOKEN', 'HANDLE_CMD999'] + \
    ['HANDLE_CMD%d' % i for i in range(64)] + \
    ['HANDLE_ACMD%d' % i for i in range(64)] + \
    ['GET_RESPONSE_R%s' % r for r in ['1', '2', '3', '6', '7']]
St = SrdStrEnum.from_list('St', s)

class Decoder(srd.Decoder):
    api_version = 3
    id = 'sdcard_sd'
    name = 'SD card (SD mode)'
    longname = 'Secure Digital card (SD mode)'
    desc = 'Secure Digital card (SD mode) low-level protocol.'
    license = 'gplv2+'
    inputs = ['logic']
    outputs = []
    tags = ['Memory']
    channels = (
        {'id': 'cmd',  'name': 'CMD',  'desc': 'Command'},
        {'id': 'clk',  'name': 'CLK',  'desc': 'Clock'},
    )
    optional_channels = (
        {'id': 'dat0', 'name': 'DAT0', 'desc': 'Data pin 0'},
        {'id': 'dat1', 'name': 'DAT1', 'desc': 'Data pin 1'},
        {'id': 'dat2', 'name': 'DAT2', 'desc': 'Data pin 2'},
        {'id': 'dat3', 'name': 'DAT3', 'desc': 'Data pin 3'},
    )
    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)) + ( \
        ('bit', 'Bit'),
        ('field-start', 'Start bit'),
        ('field-transmission', 'Transmission bit'),
        ('field-cmd', 'Command'),
        ('field-arg', 'Argument'),
        ('field-crc', 'CRC'),
        ('field-end', 'End bit'),
        ('decoded-bit', 'Decoded bit'),
        ('decoded-field', 'Decoded field'),
    )
    annotation_rows = (
        ('raw-bits', 'Raw bits', (128,)),
        ('decoded-bits', 'Decoded bits', (135,)),
        ('decoded-fields', 'Decoded fields', (136,)),
        ('fields', 'Fields', tuple(range(129, 135))),
        ('commands', 'Commands', tuple(range(128))),
    )

    def __init__(self):
        self.reset()

    def reset(self):
        self.state = St.GET_COMMAND_TOKEN
        self.token = []
        self.is_acmd = False # Indicates CMD vs. ACMD
        self.cmd = None
        self.last_cmd = None
        self.arg = None

    def start(self):
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def putbit(self, b, data):
        self.put(self.token[b][0], self.token[b][1], self.out_ann, [135, data])

    def putt(self, data):
        self.put(self.token[0][0], self.token[47][1], self.out_ann, data)

    def putf(self, s, e, data):
        self.put(self.token[s][0], self.token[e][1], self.out_ann, data)

    def puta(self, s, e, data):
        self.put(self.token[47 - 8 - e][0], self.token[47 - 8 - s][1],
                 self.out_ann, data)

    def putc(self, cmd, desc):
        self.last_cmd = cmd
        self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str,
                         self.cmd_str.split(' ')[0]]])

    def putr(self, desc):
        self.putt([self.last_cmd, ['Reply: %s' % desc]])

    def cmd_name(self, cmd):
        c = acmd_names if self.is_acmd else cmd_names
        return c.get(cmd, 'Unknown')

    def get_token_bits(self, cmd, n):
        # Get a bit, return True if we already got 'n' bits, False otherwise.
        self.token.append([self.samplenum, self.samplenum, cmd])
        if len(self.token) > 0:
            self.token[len(self.token) - 2][1] = self.samplenum
        if len(self.token) < n:
            return False
        self.token[n - 1][1] += self.token[n - 1][0] - self.token[n - 2][0]
        return True

    def handle_common_token_fields(self):
        s = self.token

        # Annotations for each individual bit.
        for bit in range(len(self.token)):
            self.putf(bit, bit, [128, ['%d' % s[bit][2]]])

        # CMD[47:47]: Start bit (always 0)
        self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])

        # CMD[46:46]: Transmission bit (1 == host)
        t = 'host' if s[1][2] == 1 else 'card'
        self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])

        # CMD[45:40]: Command index (BCD; valid: 0-63)
        self.cmd = int('0b' + ''.join([str(s[i][2]) for i in range(2, 8)]), 2)
        c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd)
        self.putf(2, 7, [131, ['Command: ' + c, 'Cmd: ' + c,
                               'CMD%d' % self.cmd, 'Cmd', 'C']])

        # CMD[39:08]: Argument
        self.arg = int('0b' + ''.join([str(s[i][2]) for i in range(8, 40)]), 2)
        self.putf(8, 39, [132, ['Argument: 0x%08x' % self.arg, 'Arg', 'A']])

        # CMD[07:01]: CRC7
        self.crc = int('0b' + ''.join([str(s[i][2]) for i in range(40, 47)]), 2)
        self.putf(40, 46, [133, ['CRC: 0x%x' % self.crc, 'CRC', 'C']])

        # CMD[00:00]: End bit (always 1)
        self.putf(47, 47, [134, ['End bit', 'End', 'E']])

    def get_command_token(self, cmd):
        # Command tokens (48 bits) are sent serially (MSB-first) by the host
        # (over the CMD line), either to one SD card or to multiple ones.
        #
        # Format:
        #  - Bits[47:47]: Start bit (always 0)
        #  - Bits[46:46]: Transmission bit (1 == host)
        #  - Bits[45:40]: Command index (BCD; valid: 0-63)
        #  - Bits[39:08]: Argument
        #  - Bits[07:01]: CRC7
        #  - Bits[00:00]: End bit (always 1)

        if not self.get_token_bits(cmd, 48):
            return

        self.handle_common_token_fields()

        # Handle command.
        s = 'ACMD' if self.is_acmd else 'CMD'
        self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd))
        if self.cmd in (0, 2, 3, 6, 7, 8, 9, 10, 13, 41, 51, 55):
            self.state = St['HANDLE_CMD%d' % self.cmd]
        else:
            self.state = St.HANDLE_CMD999
            self.putc(self.cmd, '%s%d' % (s, self.cmd))

    def handle_cmd0(self):
        # CMD0 (GO_IDLE_STATE) -> no response
        self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(0, 'Reset all SD cards')
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_cmd2(self):
        # CMD2 (ALL_SEND_CID) -> R2
        self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(2, 'Ask card for CID number')
        self.token, self.state = [], St.GET_RESPONSE_R2

    def handle_cmd3(self):
        # CMD3 (SEND_RELATIVE_ADDR) -> R6
        self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(3, 'Ask card for new relative card address (RCA)')
        self.token, self.state = [], St.GET_RESPONSE_R6

    def handle_cmd6(self):
        # CMD6 (SWITCH_FUNC) -> R1
        self.putc(6, 'Switch/check card function')
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_cmd7(self):
        # CMD7 (SELECT/DESELECT_CARD) -> R1b
        self.putc(7, 'Select / deselect card')
        self.token, self.state = [], St.GET_RESPONSE_R6

    def handle_cmd8(self):
        # CMD8 (SEND_IF_COND) -> R7
        self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
        self.puta(8, 11, [136, ['Supply voltage', 'Voltage', 'VHS', 'V']])
        self.puta(0, 7, [136, ['Check pattern', 'Check pat', 'Check', 'C']])
        self.putc(8, 'Send interface condition to card')
        self.token, self.state = [], St.GET_RESPONSE_R7
        # TODO: Handle case when card doesn't reply with R7 (no reply at all).

    def handle_cmd9(self):
        # CMD9 (SEND_CSD) -> R2
        self.puta(16, 31, [136, ['RCA', 'R']])
        self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(9, 'Send card-specific data (CSD)')
        self.token, self.state = [], St.GET_RESPONSE_R2

    def handle_cmd10(self):
        # CMD10 (SEND_CID) -> R2
        self.puta(16, 31, [136, ['RCA', 'R']])
        self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(9, 'Send card identification data (CID)')
        self.token, self.state = [], St.GET_RESPONSE_R2

    def handle_cmd13(self):
        # CMD13 (SEND_STATUS) -> R1
        self.puta(16, 31, [136, ['RCA', 'R']])
        self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(13, 'Send card status register')
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_cmd16(self):
        # CMD16 (SET_BLOCKLEN) -> R1
        self.puta(0, 31, [136, ['Block length', 'Blocklen', 'BL', 'B']])
        self.putc(16, 'Set the block length to %d bytes' % self.arg)
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_cmd55(self):
        # CMD55 (APP_CMD) -> R1
        self.puta(16, 31, [136, ['RCA', 'R']])
        self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(55, 'Next command is an application-specific command')
        self.is_acmd = True
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_acmd6(self):
        # ACMD6 (SET_BUS_WIDTH) -> R1
        self.putc(64 + 6, 'Read SD config register (SCR)')
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_acmd13(self):
        # ACMD13 (SD_STATUS) -> R1
        self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
        self.putc(64 + 13, 'Set SD status')
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_acmd41(self):
        # ACMD41 (SD_SEND_OP_COND) -> R3
        self.puta(0, 23, [136, ['VDD voltage window', 'VDD volt', 'VDD', 'V']])
        self.puta(24, 24, [136, ['S18R']])
        self.puta(25, 27, [136, ['Reserved', 'Res', 'R']])
        self.puta(28, 28, [136, ['XPC']])
        self.puta(29, 29, [136, ['Reserved for eSD', 'Reserved', 'Res', 'R']])
        self.puta(30, 30, [136, ['Host capacity support info', 'Host capacity',
                                 'HCS', 'H']])
        self.puta(31, 31, [136, ['Reserved', 'Res', 'R']])
        self.putc(64 + 41, 'Send HCS info and activate the card init process')
        self.token, self.state = [], St.GET_RESPONSE_R3

    def handle_acmd51(self):
        # ACMD51 (SEND_SCR) -> R1
        self.putc(64 + 51, 'Read SD config register (SCR)')
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_cmd999(self):
        self.token, self.state = [], St.GET_RESPONSE_R1

    def handle_acmd999(self):
        self.token, self.state = [], St.GET_RESPONSE_R1

    # Response tokens can have one of four formats (depends on content).
    # They can have a total length of 48 or 136 bits.
    # They're sent serially (MSB-first) by the card that the host
    # addressed previously, or (synchronously) by all connected cards.

    def handle_response_r1(self, cmd):
        # R1: Normal response command
        #  - Bits[47:47]: Start bit (always 0)
        #  - Bits[46:46]: Transmission bit (0 == card)
        #  - Bits[45:40]: Command index (BCD; valid: 0-63)
        #  - Bits[39:08]: Card status
        #  - Bits[07:01]: CRC7
        #  - Bits[00:00]: End bit (always 1)
        if not self.get_token_bits(cmd, 48):
            return
        self.handle_common_token_fields()
        self.putr('R1')
        self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
        for i in range(32):
            self.putbit(8 + i, [card_status[31 - i]])
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_response_r1b(self, cmd):
        # R1b: Same as R1 with an optional busy signal (on the data line)
        if not self.get_token_bits(cmd, 48):
            return
        self.handle_common_token_fields()
        self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
        self.putr('R1b')
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_response_r2(self, cmd):
        # R2: CID/CSD register
        #  - Bits[135:135]: Start bit (always 0)
        #  - Bits[134:134]: Transmission bit (0 == card)
        #  - Bits[133:128]: Reserved (always 0b111111)
        #  - Bits[127:001]: CID or CSD register including internal CRC7
        #  - Bits[000:000]: End bit (always 1)
        if not self.get_token_bits(cmd, 136):
            return
        # Annotations for each individual bit.
        for bit in range(len(self.token)):
            self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
        self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
        t = 'host' if self.token[1][2] == 1 else 'card'
        self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
        self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
        self.putf(8, 134, [132, ['Argument', 'Arg', 'A']])
        self.putf(135, 135, [134, ['End bit', 'End', 'E']])
        self.putf(8, 134, [136, ['CID/CSD register', 'CID/CSD', 'C']])
        self.putf(0, 135, [55, ['R2']])
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_response_r3(self, cmd):
        # R3: OCR register
        #  - Bits[47:47]: Start bit (always 0)
        #  - Bits[46:46]: Transmission bit (0 == card)
        #  - Bits[45:40]: Reserved (always 0b111111)
        #  - Bits[39:08]: OCR register
        #  - Bits[07:01]: Reserved (always 0b111111)
        #  - Bits[00:00]: End bit (always 1)
        if not self.get_token_bits(cmd, 48):
            return
        self.putr('R3')
        # Annotations for each individual bit.
        for bit in range(len(self.token)):
            self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
        self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
        t = 'host' if self.token[1][2] == 1 else 'card'
        self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
        self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
        self.putf(8, 39, [132, ['Argument', 'Arg', 'A']])
        self.putf(40, 46, [133, ['Reserved', 'Res', 'R']])
        self.putf(47, 47, [134, ['End bit', 'End', 'E']])
        self.puta(0, 31, [136, ['OCR register', 'OCR reg', 'OCR', 'O']])
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_response_r6(self, cmd):
        # R6: Published RCA response
        #  - Bits[47:47]: Start bit (always 0)
        #  - Bits[46:46]: Transmission bit (0 == card)
        #  - Bits[45:40]: Command index (always 0b000011)
        #  - Bits[39:24]: Argument[31:16]: New published RCA of the card
        #  - Bits[23:08]: Argument[15:0]: Card status bits
        #  - Bits[07:01]: CRC7
        #  - Bits[00:00]: End bit (always 1)
        if not self.get_token_bits(cmd, 48):
            return
        self.handle_common_token_fields()
        self.puta(0, 15, [136, ['Card status bits', 'Status', 'S']])
        self.puta(16, 31, [136, ['Relative card address', 'RCA', 'R']])
        self.putr('R6')
        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def handle_response_r7(self, cmd):
        # R7: Card interface condition
        #  - Bits[47:47]: Start bit (always 0)
        #  - Bits[46:46]: Transmission bit (0 == card)
        #  - Bits[45:40]: Command index (always 0b001000)
        #  - Bits[39:20]: Reserved bits (all-zero)
        #  - Bits[19:16]: Voltage accepted
        #  - Bits[15:08]: Echo-back of check pattern
        #  - Bits[07:01]: CRC7
        #  - Bits[00:00]: End bit (always 1)
        if not self.get_token_bits(cmd, 48):
            return
        self.handle_common_token_fields()

        self.putr('R7')

        # Arg[31:12]: Reserved bits (all-zero)
        self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])

        # Arg[11:08]: Voltage accepted
        v = ''.join(str(i[2]) for i in self.token[28:32])
        av = accepted_voltages.get(int('0b' + v, 2), 'Unknown')
        self.puta(8, 11, [136, ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']])

        # Arg[07:00]: Echo-back of check pattern
        self.puta(0, 7, [136, ['Echo-back of check pattern', 'Echo', 'E']])

        self.token, self.state = [], St.GET_COMMAND_TOKEN

    def decode(self):
        while True:
            # Wait for a rising CLK edge.
            (cmd, clk, dat0, dat1, dat2, dat3) = self.wait({1: 'r'})

            # State machine.
            if self.state == St.GET_COMMAND_TOKEN:
                if len(self.token) == 0:
                    # Wait for start bit (CMD = 0).
                    if cmd != 0:
                        continue
                self.get_command_token(cmd)
            elif self.state.value.startswith('HANDLE_CMD'):
                # Call the respective handler method for the command.
                a, cmdstr = 'a' if self.is_acmd else '', self.state.value[10:].lower()
                handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
                handle_cmd()
                # Leave ACMD mode again after the first command after CMD55.
                if self.is_acmd and cmdstr not in ('55', '63'):
                    self.is_acmd = False
            elif self.state.value.startswith('GET_RESPONSE'):
                if len(self.token) == 0:
                    # Wait for start bit (CMD = 0).
                    if cmd != 0:
                        continue
                # Call the respective handler method for the response.
                s = 'handle_response_%s' % self.state.value[13:].lower()
                handle_response = getattr(self, s)
                handle_response(cmd)
Commit	Line	Data
08c41387	1	##
ada4c3a3	2	## This file is part of the libsigrokdecode project.
08c41387	3	##
624710c9	4	## Copyright (C) 2015-2020 Uwe Hermann <uwe@hermann-uwe.de>
08c41387 UH	5	##
	6	## This program is free software; you can redistribute it and/or modify
	7	## it under the terms of the GNU General Public License as published by
	8	## the Free Software Foundation; either version 2 of the License, or
	9	## (at your option) any later version.
	10	##
	11	## This program is distributed in the hope that it will be useful,
	12	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	## GNU General Public License for more details.
	15	##
	16	## You should have received a copy of the GNU General Public License
4539e9ca	17	## along with this program; if not, see <http://www.gnu.org/licenses/>.
08c41387 UH	18	##
	19
	20	import sigrokdecode as srd
624710c9	21	from common.srdhelper import SrdStrEnum
135b790c	22	from common.sdcard import (cmd_names, acmd_names, accepted_voltages, card_status, sd_status)
08c41387	23
624710c9 UH	24	s = ['GET_COMMAND_TOKEN', 'HANDLE_CMD999'] + \
	25	['HANDLE_CMD%d' % i for i in range(64)] + \
	26	['HANDLE_ACMD%d' % i for i in range(64)] + \
	27	['GET_RESPONSE_R%s' % r for r in ['1', '2', '3', '6', '7']]
	28	St = SrdStrEnum.from_list('St', s)
	29
08c41387	30	class Decoder(srd.Decoder):
11535843	31	api_version = 3
08c41387 UH	32	id = 'sdcard_sd'
	33	name = 'SD card (SD mode)'
	34	longname = 'Secure Digital card (SD mode)'
	35	desc = 'Secure Digital card (SD mode) low-level protocol.'
	36	license = 'gplv2+'
	37	inputs = ['logic']
6cbba91f	38	outputs = []
d6d8a8a4	39	tags = ['Memory']
08c41387 UH	40	channels = (
	41	{'id': 'cmd', 'name': 'CMD', 'desc': 'Command'},
	42	{'id': 'clk', 'name': 'CLK', 'desc': 'Clock'},
	43	)
	44	optional_channels = (
	45	{'id': 'dat0', 'name': 'DAT0', 'desc': 'Data pin 0'},
	46	{'id': 'dat1', 'name': 'DAT1', 'desc': 'Data pin 1'},
	47	{'id': 'dat2', 'name': 'DAT2', 'desc': 'Data pin 2'},
	48	{'id': 'dat3', 'name': 'DAT3', 'desc': 'Data pin 3'},
	49	)
	50	annotations = \
	51	tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
	52	tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
e144452b	53	('bit', 'Bit'),
08c41387 UH	54	('field-start', 'Start bit'),
	55	('field-transmission', 'Transmission bit'),
	56	('field-cmd', 'Command'),
	57	('field-arg', 'Argument'),
	58	('field-crc', 'CRC'),
	59	('field-end', 'End bit'),
e144452b UH	60	('decoded-bit', 'Decoded bit'),
e144452b UH	61	('decoded-field', 'Decoded field'),
08c41387 UH	62	)
	63	annotation_rows = (
	64	('raw-bits', 'Raw bits', (128,)),
	65	('decoded-bits', 'Decoded bits', (135,)),
	66	('decoded-fields', 'Decoded fields', (136,)),
	67	('fields', 'Fields', tuple(range(129, 135))),
e144452b	68	('commands', 'Commands', tuple(range(128))),
08c41387 UH	69	)
08c41387 UH	70
92b7b49f	71	def __init__(self):
10aeb8ea GS	72	self.reset()
	73
	74	def reset(self):
624710c9	75	self.state = St.GET_COMMAND_TOKEN
08c41387	76	self.token = []
08c41387 UH	77	self.is_acmd = False # Indicates CMD vs. ACMD
08c41387 UH	78	self.cmd = None
f8eb6c3f	79	self.last_cmd = None
08c41387 UH	80	self.arg = None
	81
	82	def start(self):
	83	self.out_ann = self.register(srd.OUTPUT_ANN)
	84
	85	def putbit(self, b, data):
	86	self.put(self.token[b][0], self.token[b][1], self.out_ann, [135, data])
	87
	88	def putt(self, data):
	89	self.put(self.token[0][0], self.token[47][1], self.out_ann, data)
	90
08c41387 UH	91	def putf(self, s, e, data):
	92	self.put(self.token[s][0], self.token[e][1], self.out_ann, data)
	93
	94	def puta(self, s, e, data):
	95	self.put(self.token[47 - 8 - e][0], self.token[47 - 8 - s][1],
	96	self.out_ann, data)
	97
	98	def putc(self, cmd, desc):
f8eb6c3f	99	self.last_cmd = cmd
08c41387 UH	100	self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str,
	101	self.cmd_str.split(' ')[0]]])
	102
f8eb6c3f WS	103	def putr(self, desc):
f8eb6c3f WS	104	self.putt([self.last_cmd, ['Reply: %s' % desc]])
08c41387	105
08c41387 UH	106	def cmd_name(self, cmd):
	107	c = acmd_names if self.is_acmd else cmd_names
	108	return c.get(cmd, 'Unknown')
	109
	110	def get_token_bits(self, cmd, n):
	111	# Get a bit, return True if we already got 'n' bits, False otherwise.
	112	self.token.append([self.samplenum, self.samplenum, cmd])
	113	if len(self.token) > 0:
	114	self.token[len(self.token) - 2][1] = self.samplenum
	115	if len(self.token) < n:
	116	return False
	117	self.token[n - 1][1] += self.token[n - 1][0] - self.token[n - 2][0]
	118	return True
	119
	120	def handle_common_token_fields(self):
	121	s = self.token
	122
	123	# Annotations for each individual bit.
	124	for bit in range(len(self.token)):
	125	self.putf(bit, bit, [128, ['%d' % s[bit][2]]])
	126
	127	# CMD[47:47]: Start bit (always 0)
	128	self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
	129
	130	# CMD[46:46]: Transmission bit (1 == host)
	131	t = 'host' if s[1][2] == 1 else 'card'
	132	self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
	133
	134	# CMD[45:40]: Command index (BCD; valid: 0-63)
	135	self.cmd = int('0b' + ''.join([str(s[i][2]) for i in range(2, 8)]), 2)
	136	c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd)
	137	self.putf(2, 7, [131, ['Command: ' + c, 'Cmd: ' + c,
	138	'CMD%d' % self.cmd, 'Cmd', 'C']])
	139
	140	# CMD[39:08]: Argument
619ed6b4 WS	141	self.arg = int('0b' + ''.join([str(s[i][2]) for i in range(8, 40)]), 2)
619ed6b4 WS	142	self.putf(8, 39, [132, ['Argument: 0x%08x' % self.arg, 'Arg', 'A']])
08c41387 UH	143
	144	# CMD[07:01]: CRC7
	145	self.crc = int('0b' + ''.join([str(s[i][2]) for i in range(40, 47)]), 2)
	146	self.putf(40, 46, [133, ['CRC: 0x%x' % self.crc, 'CRC', 'C']])
	147
	148	# CMD[00:00]: End bit (always 1)
	149	self.putf(47, 47, [134, ['End bit', 'End', 'E']])
	150
	151	def get_command_token(self, cmd):
	152	# Command tokens (48 bits) are sent serially (MSB-first) by the host
	153	# (over the CMD line), either to one SD card or to multiple ones.
	154	#
	155	# Format:
	156	# - Bits[47:47]: Start bit (always 0)
	157	# - Bits[46:46]: Transmission bit (1 == host)
	158	# - Bits[45:40]: Command index (BCD; valid: 0-63)
	159	# - Bits[39:08]: Argument
	160	# - Bits[07:01]: CRC7
	161	# - Bits[00:00]: End bit (always 1)
	162
	163	if not self.get_token_bits(cmd, 48):
	164	return
	165
	166	self.handle_common_token_fields()
	167
	168	# Handle command.
	169	s = 'ACMD' if self.is_acmd else 'CMD'
	170	self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd))
ee390f67	171	if self.cmd in (0, 2, 3, 6, 7, 8, 9, 10, 13, 41, 51, 55):
624710c9	172	self.state = St['HANDLE_CMD%d' % self.cmd]
08c41387	173	else:
624710c9	174	self.state = St.HANDLE_CMD999
08c41387 UH	175	self.putc(self.cmd, '%s%d' % (s, self.cmd))
	176
	177	def handle_cmd0(self):
	178	# CMD0 (GO_IDLE_STATE) -> no response
	179	self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	180	self.putc(0, 'Reset all SD cards')
624710c9	181	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	182
	183	def handle_cmd2(self):
	184	# CMD2 (ALL_SEND_CID) -> R2
	185	self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	186	self.putc(2, 'Ask card for CID number')
624710c9	187	self.token, self.state = [], St.GET_RESPONSE_R2
08c41387 UH	188
	189	def handle_cmd3(self):
	190	# CMD3 (SEND_RELATIVE_ADDR) -> R6
	191	self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	192	self.putc(3, 'Ask card for new relative card address (RCA)')
624710c9	193	self.token, self.state = [], St.GET_RESPONSE_R6
08c41387 UH	194
	195	def handle_cmd6(self):
	196	# CMD6 (SWITCH_FUNC) -> R1
	197	self.putc(6, 'Switch/check card function')
624710c9	198	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	199
	200	def handle_cmd7(self):
	201	# CMD7 (SELECT/DESELECT_CARD) -> R1b
	202	self.putc(7, 'Select / deselect card')
624710c9	203	self.token, self.state = [], St.GET_RESPONSE_R6
08c41387 UH	204
	205	def handle_cmd8(self):
	206	# CMD8 (SEND_IF_COND) -> R7
	207	self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
	208	self.puta(8, 11, [136, ['Supply voltage', 'Voltage', 'VHS', 'V']])
	209	self.puta(0, 7, [136, ['Check pattern', 'Check pat', 'Check', 'C']])
1cf5aeaf	210	self.putc(8, 'Send interface condition to card')
624710c9	211	self.token, self.state = [], St.GET_RESPONSE_R7
08c41387 UH	212	# TODO: Handle case when card doesn't reply with R7 (no reply at all).
	213
	214	def handle_cmd9(self):
	215	# CMD9 (SEND_CSD) -> R2
	216	self.puta(16, 31, [136, ['RCA', 'R']])
	217	self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	218	self.putc(9, 'Send card-specific data (CSD)')
624710c9	219	self.token, self.state = [], St.GET_RESPONSE_R2
08c41387 UH	220
	221	def handle_cmd10(self):
	222	# CMD10 (SEND_CID) -> R2
	223	self.puta(16, 31, [136, ['RCA', 'R']])
	224	self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	225	self.putc(9, 'Send card identification data (CID)')
624710c9	226	self.token, self.state = [], St.GET_RESPONSE_R2
08c41387 UH	227
	228	def handle_cmd13(self):
	229	# CMD13 (SEND_STATUS) -> R1
	230	self.puta(16, 31, [136, ['RCA', 'R']])
	231	self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	232	self.putc(13, 'Send card status register')
624710c9	233	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	234
	235	def handle_cmd16(self):
	236	# CMD16 (SET_BLOCKLEN) -> R1
08c41387	237	self.puta(0, 31, [136, ['Block length', 'Blocklen', 'BL', 'B']])
d507f5e4	238	self.putc(16, 'Set the block length to %d bytes' % self.arg)
624710c9	239	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	240
	241	def handle_cmd55(self):
	242	# CMD55 (APP_CMD) -> R1
	243	self.puta(16, 31, [136, ['RCA', 'R']])
	244	self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	245	self.putc(55, 'Next command is an application-specific command')
	246	self.is_acmd = True
624710c9	247	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	248
	249	def handle_acmd6(self):
	250	# ACMD6 (SET_BUS_WIDTH) -> R1
	251	self.putc(64 + 6, 'Read SD config register (SCR)')
624710c9	252	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	253
	254	def handle_acmd13(self):
	255	# ACMD13 (SD_STATUS) -> R1
	256	self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
	257	self.putc(64 + 13, 'Set SD status')
624710c9	258	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	259
	260	def handle_acmd41(self):
	261	# ACMD41 (SD_SEND_OP_COND) -> R3
	262	self.puta(0, 23, [136, ['VDD voltage window', 'VDD volt', 'VDD', 'V']])
	263	self.puta(24, 24, [136, ['S18R']])
	264	self.puta(25, 27, [136, ['Reserved', 'Res', 'R']])
	265	self.puta(28, 28, [136, ['XPC']])
	266	self.puta(29, 29, [136, ['Reserved for eSD', 'Reserved', 'Res', 'R']])
	267	self.puta(30, 30, [136, ['Host capacity support info', 'Host capacity',
	268	'HCS', 'H']])
	269	self.puta(31, 31, [136, ['Reserved', 'Res', 'R']])
	270	self.putc(64 + 41, 'Send HCS info and activate the card init process')
624710c9	271	self.token, self.state = [], St.GET_RESPONSE_R3
08c41387 UH	272
	273	def handle_acmd51(self):
	274	# ACMD51 (SEND_SCR) -> R1
	275	self.putc(64 + 51, 'Read SD config register (SCR)')
624710c9	276	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	277
08c41387 UH	278	def handle_cmd999(self):
624710c9	279	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	280
08c41387 UH	281	def handle_acmd999(self):
624710c9	282	self.token, self.state = [], St.GET_RESPONSE_R1
08c41387 UH	283
	284	# Response tokens can have one of four formats (depends on content).
	285	# They can have a total length of 48 or 136 bits.
	286	# They're sent serially (MSB-first) by the card that the host
	287	# addressed previously, or (synchronously) by all connected cards.
	288
	289	def handle_response_r1(self, cmd):
	290	# R1: Normal response command
	291	# - Bits[47:47]: Start bit (always 0)
	292	# - Bits[46:46]: Transmission bit (0 == card)
	293	# - Bits[45:40]: Command index (BCD; valid: 0-63)
	294	# - Bits[39:08]: Card status
	295	# - Bits[07:01]: CRC7
	296	# - Bits[00:00]: End bit (always 1)
	297	if not self.get_token_bits(cmd, 48):
	298	return
	299	self.handle_common_token_fields()
f8eb6c3f	300	self.putr('R1')
08c41387 UH	301	self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
	302	for i in range(32):
	303	self.putbit(8 + i, [card_status[31 - i]])
624710c9	304	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	305
	306	def handle_response_r1b(self, cmd):
	307	# R1b: Same as R1 with an optional busy signal (on the data line)
	308	if not self.get_token_bits(cmd, 48):
	309	return
	310	self.handle_common_token_fields()
	311	self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
f8eb6c3f	312	self.putr('R1b')
624710c9	313	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	314
	315	def handle_response_r2(self, cmd):
	316	# R2: CID/CSD register
	317	# - Bits[135:135]: Start bit (always 0)
	318	# - Bits[134:134]: Transmission bit (0 == card)
	319	# - Bits[133:128]: Reserved (always 0b111111)
	320	# - Bits[127:001]: CID or CSD register including internal CRC7
	321	# - Bits[000:000]: End bit (always 1)
	322	if not self.get_token_bits(cmd, 136):
	323	return
	324	# Annotations for each individual bit.
	325	for bit in range(len(self.token)):
	326	self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
	327	self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
	328	t = 'host' if self.token[1][2] == 1 else 'card'
	329	self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
	330	self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
	331	self.putf(8, 134, [132, ['Argument', 'Arg', 'A']])
	332	self.putf(135, 135, [134, ['End bit', 'End', 'E']])
	333	self.putf(8, 134, [136, ['CID/CSD register', 'CID/CSD', 'C']])
	334	self.putf(0, 135, [55, ['R2']])
624710c9	335	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	336
	337	def handle_response_r3(self, cmd):
	338	# R3: OCR register
	339	# - Bits[47:47]: Start bit (always 0)
	340	# - Bits[46:46]: Transmission bit (0 == card)
	341	# - Bits[45:40]: Reserved (always 0b111111)
	342	# - Bits[39:08]: OCR register
	343	# - Bits[07:01]: Reserved (always 0b111111)
	344	# - Bits[00:00]: End bit (always 1)
	345	if not self.get_token_bits(cmd, 48):
	346	return
f8eb6c3f	347	self.putr('R3')
08c41387 UH	348	# Annotations for each individual bit.
	349	for bit in range(len(self.token)):
	350	self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
	351	self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
	352	t = 'host' if self.token[1][2] == 1 else 'card'
	353	self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
	354	self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
	355	self.putf(8, 39, [132, ['Argument', 'Arg', 'A']])
	356	self.putf(40, 46, [133, ['Reserved', 'Res', 'R']])
	357	self.putf(47, 47, [134, ['End bit', 'End', 'E']])
	358	self.puta(0, 31, [136, ['OCR register', 'OCR reg', 'OCR', 'O']])
624710c9	359	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	360
	361	def handle_response_r6(self, cmd):
	362	# R6: Published RCA response
	363	# - Bits[47:47]: Start bit (always 0)
	364	# - Bits[46:46]: Transmission bit (0 == card)
	365	# - Bits[45:40]: Command index (always 0b000011)
	366	# - Bits[39:24]: Argument[31:16]: New published RCA of the card
	367	# - Bits[23:08]: Argument[15:0]: Card status bits
	368	# - Bits[07:01]: CRC7
	369	# - Bits[00:00]: End bit (always 1)
	370	if not self.get_token_bits(cmd, 48):
	371	return
	372	self.handle_common_token_fields()
	373	self.puta(0, 15, [136, ['Card status bits', 'Status', 'S']])
	374	self.puta(16, 31, [136, ['Relative card address', 'RCA', 'R']])
f8eb6c3f	375	self.putr('R6')
624710c9	376	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387 UH	377
	378	def handle_response_r7(self, cmd):
	379	# R7: Card interface condition
	380	# - Bits[47:47]: Start bit (always 0)
	381	# - Bits[46:46]: Transmission bit (0 == card)
	382	# - Bits[45:40]: Command index (always 0b001000)
	383	# - Bits[39:20]: Reserved bits (all-zero)
	384	# - Bits[19:16]: Voltage accepted
	385	# - Bits[15:08]: Echo-back of check pattern
	386	# - Bits[07:01]: CRC7
	387	# - Bits[00:00]: End bit (always 1)
	388	if not self.get_token_bits(cmd, 48):
	389	return
	390	self.handle_common_token_fields()
	391
f8eb6c3f	392	self.putr('R7')
08c41387 UH	393
	394	# Arg[31:12]: Reserved bits (all-zero)
	395	self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
	396
	397	# Arg[11:08]: Voltage accepted
	398	v = ''.join(str(i[2]) for i in self.token[28:32])
	399	av = accepted_voltages.get(int('0b' + v, 2), 'Unknown')
	400	self.puta(8, 11, [136, ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']])
	401
	402	# Arg[07:00]: Echo-back of check pattern
	403	self.puta(0, 7, [136, ['Echo-back of check pattern', 'Echo', 'E']])
	404
624710c9	405	self.token, self.state = [], St.GET_COMMAND_TOKEN
08c41387	406
11535843 GS	407	def decode(self):
11535843 GS	408	while True:
08c41387	409	# Wait for a rising CLK edge.
11535843	410	(cmd, clk, dat0, dat1, dat2, dat3) = self.wait({1: 'r'})
08c41387 UH	411
08c41387 UH	412	# State machine.
624710c9	413	if self.state == St.GET_COMMAND_TOKEN:
08c41387 UH	414	if len(self.token) == 0:
	415	# Wait for start bit (CMD = 0).
	416	if cmd != 0:
	417	continue
	418	self.get_command_token(cmd)
624710c9	419	elif self.state.value.startswith('HANDLE_CMD'):
08c41387	420	# Call the respective handler method for the command.
624710c9	421	a, cmdstr = 'a' if self.is_acmd else '', self.state.value[10:].lower()
08c41387 UH	422	handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
	423	handle_cmd()
	424	# Leave ACMD mode again after the first command after CMD55.
	425	if self.is_acmd and cmdstr not in ('55', '63'):
	426	self.is_acmd = False
624710c9	427	elif self.state.value.startswith('GET_RESPONSE'):
08c41387 UH	428	if len(self.token) == 0:
	429	# Wait for start bit (CMD = 0).
	430	if cmd != 0:
	431	continue
	432	# Call the respective handler method for the response.
624710c9	433	s = 'handle_response_%s' % self.state.value[13:].lower()
08c41387 UH	434	handle_response = getattr(self, s)
08c41387 UH	435	handle_response(cmd)