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