decoders/sdcard_sd/pd.py

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