decoders/sdcard_sd/pd.py

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