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