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