decoders/sdcard_spi/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2014 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)
  22
  23 class Decoder(srd.Decoder):
  24     api_version = 3
  25     id = 'sdcard_spi'
  26     name = 'SD card (SPI mode)'
  27     longname = 'Secure Digital card (SPI mode)'
  28     desc = 'Secure Digital card (SPI mode) low-level protocol.'
  29     license = 'gplv2+'
  30     inputs = ['spi']
  31     outputs = []
  32     tags = ['Memory']
  33     annotations = \
  34         tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
  35         tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
  36         ('r1', 'R1 reply'),
  37         ('r1b', 'R1B reply'),
  38         ('r2', 'R2 reply'),
  39         ('r3', 'R3 reply'),
  40         ('r7', 'R7 reply'),
  41         ('bits', 'Bits'),
  42         ('bit-warnings', 'Bit warnings'),
  43     )
  44     annotation_rows = (
  45         ('bits', 'Bits', (133, 134)),
  46         ('cmd-reply', 'Commands/replies', tuple(range(133))),
  47     )
  48
  49     def __init__(self):
  50         self.reset()
  51
  52     def reset(self):
  53         self.state = 'IDLE'
  54         self.ss, self.es = 0, 0
  55         self.ss_bit, self.es_bit = 0, 0
  56         self.ss_cmd, self.es_cmd = 0, 0
  57         self.cmd_token = []
  58         self.cmd_token_bits = []
  59         self.is_acmd = False # Indicates CMD vs. ACMD
  60         self.blocklen = 0
  61         self.read_buf = []
  62         self.cmd_str = ''
  63         self.is_cmd24 = False
  64         self.cmd24_start_token_found = False
  65         self.is_cmd17 = False
  66         self.cmd17_start_token_found = False
  67
  68     def start(self):
  69         self.out_ann = self.register(srd.OUTPUT_ANN)
  70
  71     def putx(self, data):
  72         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
  73
  74     def putc(self, cmd, desc):
  75         self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
  76
  77     def putb(self, data):
  78         self.put(self.ss_bit, self.es_bit, self.out_ann, data)
  79
  80     def cmd_name(self, cmd):
  81         c = acmd_names if self.is_acmd else cmd_names
  82         s = c.get(cmd, 'Unknown')
  83         # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}.
  84         # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR.
  85         if cmd in (32, 33):
  86             s += '_ADDR'
  87         return s
  88
  89     def handle_command_token(self, mosi, miso):
  90         # Command tokens (6 bytes) are sent (MSB-first) by the host.
  91         #
  92         # Format:
  93         #  - CMD[47:47]: Start bit (always 0)
  94         #  - CMD[46:46]: Transmitter bit (1 == host)
  95         #  - CMD[45:40]: Command index (BCD; valid: 0-63)
  96         #  - CMD[39:08]: Argument
  97         #  - CMD[07:01]: CRC7
  98         #  - CMD[00:00]: End bit (always 1)
  99
 100         if len(self.cmd_token) == 0:
 101             self.ss_cmd = self.ss
 102
 103         self.cmd_token.append(mosi)
 104         self.cmd_token_bits.append(self.mosi_bits)
 105
 106         # All command tokens are 6 bytes long.
 107         if len(self.cmd_token) < 6:
 108             return
 109
 110         self.es_cmd = self.es
 111
 112         t = self.cmd_token
 113
 114         # CMD or ACMD?
 115         s = 'ACMD' if self.is_acmd else 'CMD'
 116
 117         def tb(byte, bit):
 118             return self.cmd_token_bits[5 - byte][bit]
 119
 120         # Bits[47:47]: Start bit (always 0)
 121         bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
 122         if bit == 0:
 123             self.putb([134, ['Start bit: %d' % bit]])
 124         else:
 125             self.putb([135, ['Start bit: %s (Warning: Must be 0!)' % bit]])
 126
 127         # Bits[46:46]: Transmitter bit (1 == host)
 128         bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
 129         if bit == 1:
 130             self.putb([134, ['Transmitter bit: %d' % bit]])
 131         else:
 132             self.putb([135, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
 133
 134         # Bits[45:40]: Command index (BCD; valid: 0-63)
 135         cmd = self.cmd_index = t[0] & 0x3f
 136         self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2]
 137         self.putb([134, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]])
 138
 139         # Bits[39:8]: Argument
 140         self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
 141         self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2]
 142         self.putb([134, ['Argument: 0x%04x' % self.arg]])
 143
 144         # Bits[7:1]: CRC7
 145         # TODO: Check CRC7.
 146         crc = t[5] >> 1
 147         self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2]
 148         self.putb([134, ['CRC7: 0x%01x' % crc]])
 149
 150         # Bits[0:0]: End bit (always 1)
 151         bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
 152         if bit == 1:
 153             self.putb([134, ['End bit: %d' % bit]])
 154         else:
 155             self.putb([135, ['End bit: %d (Warning: Must be 1!)' % bit]])
 156
 157         # Handle command.
 158         if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59):
 159             self.state = 'HANDLE CMD%d' % cmd
 160             self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd))
 161         else:
 162             self.state = 'HANDLE CMD999'
 163             a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
 164             self.putx([cmd, [a]])
 165
 166     def handle_cmd0(self):
 167         # CMD0: GO_IDLE_STATE
 168         self.putc(0, 'Reset the SD card')
 169         self.state = 'GET RESPONSE R1'
 170
 171     def handle_cmd1(self):
 172         # CMD1: SEND_OP_COND
 173         self.putc(1, 'Send HCS info and activate the card init process')
 174         hcs = (self.arg & (1 << 30)) >> 30
 175         self.ss_bit = self.cmd_token_bits[5 - 4][6][1]
 176         self.es_bit = self.cmd_token_bits[5 - 4][6][2]
 177         self.putb([134, ['HCS: %d' % hcs]])
 178         self.state = 'GET RESPONSE R1'
 179
 180     def handle_cmd9(self):
 181         # CMD9: SEND_CSD (128 bits / 16 bytes)
 182         self.putc(9, 'Ask card to send its card specific data (CSD)')
 183         if len(self.read_buf) == 0:
 184             self.ss_cmd = self.ss
 185         self.read_buf.append(self.miso)
 186         # FIXME
 187         ### if len(self.read_buf) < 16:
 188         if len(self.read_buf) < 16 + 4:
 189             return
 190         self.es_cmd = self.es
 191         self.read_buf = self.read_buf[4:] # TODO: Document or redo.
 192         self.putx([9, ['CSD: %s' % self.read_buf]])
 193         # TODO: Decode all bits.
 194         self.read_buf = []
 195         ### self.state = 'GET RESPONSE R1'
 196         self.state = 'IDLE'
 197
 198     def handle_cmd10(self):
 199         # CMD10: SEND_CID (128 bits / 16 bytes)
 200         self.putc(10, 'Ask card to send its card identification (CID)')
 201         self.read_buf.append(self.miso)
 202         if len(self.read_buf) < 16:
 203             return
 204         self.putx([10, ['CID: %s' % self.read_buf]])
 205         # TODO: Decode all bits.
 206         self.read_buf = []
 207         self.state = 'GET RESPONSE R1'
 208
 209     def handle_cmd16(self):
 210         # CMD16: SET_BLOCKLEN
 211         self.blocklen = self.arg
 212         # TODO: Sanity check on block length.
 213         self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
 214         self.state = 'GET RESPONSE R1'
 215
 216     def handle_cmd17(self):
 217         # CMD17: READ_SINGLE_BLOCK
 218         self.putc(17, 'Read a block from address 0x%04x' % self.arg)
 219         self.is_cmd17 = True
 220         self.state = 'GET RESPONSE R1'
 221
 222     def handle_cmd24(self):
 223         # CMD24: WRITE_BLOCK
 224         self.putc(24, 'Write a block to address 0x%04x' % self.arg)
 225         self.is_cmd24 = True
 226         self.state = 'GET RESPONSE R1'
 227
 228     def handle_cmd49(self):
 229         self.state = 'GET RESPONSE R1'
 230
 231     def handle_cmd55(self):
 232         # CMD55: APP_CMD
 233         self.putc(55, 'Next command is an application-specific command')
 234         self.is_acmd = True
 235         self.state = 'GET RESPONSE R1'
 236
 237     def handle_cmd59(self):
 238         # CMD59: CRC_ON_OFF
 239         crc_on_off = self.arg & (1 << 0)
 240         s = 'on' if crc_on_off == 1 else 'off'
 241         self.putc(59, 'Turn the SD card CRC option %s' % s)
 242         self.state = 'GET RESPONSE R1'
 243
 244     def handle_acmd41(self):
 245         # ACMD41: SD_SEND_OP_COND
 246         self.putc(64 + 41, 'Send HCS info and activate the card init process')
 247         self.state = 'GET RESPONSE R1'
 248
 249     def handle_cmd999(self):
 250         self.state = 'GET RESPONSE R1'
 251
 252     def handle_cid_register(self):
 253         # Card Identification (CID) register, 128bits
 254
 255         cid = self.cid
 256
 257         # Manufacturer ID: CID[127:120] (8 bits)
 258         mid = cid[15]
 259
 260         # OEM/Application ID: CID[119:104] (16 bits)
 261         oid = (cid[14] << 8) | cid[13]
 262
 263         # Product name: CID[103:64] (40 bits)
 264         pnm = 0
 265         for i in range(12, 8 - 1, -1):
 266             pnm <<= 8
 267             pnm |= cid[i]
 268
 269         # Product revision: CID[63:56] (8 bits)
 270         prv = cid[7]
 271
 272         # Product serial number: CID[55:24] (32 bits)
 273         psn = 0
 274         for i in range(6, 3 - 1, -1):
 275             psn <<= 8
 276             psn |= cid[i]
 277
 278         # RESERVED: CID[23:20] (4 bits)
 279
 280         # Manufacturing date: CID[19:8] (12 bits)
 281         # TODO
 282
 283         # CRC7 checksum: CID[7:1] (7 bits)
 284         # TODO
 285
 286         # Not used, always 1: CID[0:0] (1 bit)
 287         # TODO
 288
 289     def handle_response_r1(self, res):
 290         # The R1 response token format (1 byte).
 291         # Sent by the card after every command except for SEND_STATUS.
 292
 293         self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2]
 294         self.putx([65, ['R1: 0x%02x' % res]])
 295
 296         def putbit(bit, data):
 297             b = self.miso_bits[bit]
 298             self.ss_bit, self.es_bit = b[1], b[2]
 299             self.putb([134, data])
 300
 301         # Bit 0: 'In idle state' bit
 302         s = '' if (res & (1 << 0)) else 'not '
 303         putbit(0, ['Card is %sin idle state' % s])
 304
 305         # Bit 1: 'Erase reset' bit
 306         s = '' if (res & (1 << 1)) else 'not '
 307         putbit(1, ['Erase sequence %scleared' % s])
 308
 309         # Bit 2: 'Illegal command' bit
 310         s = 'I' if (res & (1 << 2)) else 'No i'
 311         putbit(2, ['%sllegal command detected' % s])
 312
 313         # Bit 3: 'Communication CRC error' bit
 314         s = 'failed' if (res & (1 << 3)) else 'was successful'
 315         putbit(3, ['CRC check of last command %s' % s])
 316
 317         # Bit 4: 'Erase sequence error' bit
 318         s = 'E' if (res & (1 << 4)) else 'No e'
 319         putbit(4, ['%srror in the sequence of erase commands' % s])
 320
 321         # Bit 5: 'Address error' bit
 322         s = 'M' if (res & (1 << 4)) else 'No m'
 323         putbit(5, ['%sisaligned address used in command' % s])
 324
 325         # Bit 6: 'Parameter error' bit
 326         s = '' if (res & (1 << 4)) else 'not '
 327         putbit(6, ['Command argument %soutside allowed range' % s])
 328
 329         # Bit 7: Always set to 0
 330         putbit(7, ['Bit 7 (always 0)'])
 331
 332         if self.is_cmd17:
 333             self.state = 'HANDLE DATA BLOCK CMD17'
 334         if self.is_cmd24:
 335             self.state = 'HANDLE DATA BLOCK CMD24'
 336
 337     def handle_response_r1b(self, res):
 338         # TODO
 339         pass
 340
 341     def handle_response_r2(self, res):
 342         # TODO
 343         pass
 344
 345     def handle_response_r3(self, res):
 346         # TODO
 347         pass
 348
 349     # Note: Response token formats R4 and R5 are reserved for SDIO.
 350
 351     # TODO: R6?
 352
 353     def handle_response_r7(self, res):
 354         # TODO
 355         pass
 356
 357     def handle_data_cmd17(self, miso):
 358         # CMD17 returns one byte R1, then some bytes 0xff, then a Start Block
 359         # (single byte 0xfe), then self.blocklen bytes of data, then always
 360         # 2 bytes of CRC.
 361         if self.cmd17_start_token_found:
 362             if len(self.read_buf) == 0:
 363                 self.ss_data = self.ss
 364                 if not self.blocklen:
 365                     # Assume a fixed block size when inspection of the previous
 366                     # traffic did not provide the respective parameter value.
 367                     # TODO: Make the default block size a PD option?
 368                     self.blocklen = 512
 369             self.read_buf.append(miso)
 370             # Wait until block transfer completed.
 371             if len(self.read_buf) < self.blocklen:
 372                 return
 373             if len(self.read_buf) == self.blocklen:
 374                 self.es_data = self.es
 375                 self.put(self.ss_data, self.es_data, self.out_ann, [17, ['Block data: %s' % self.read_buf]])
 376             elif len(self.read_buf) == (self.blocklen + 1):
 377                 self.ss_crc = self.ss
 378             elif len(self.read_buf) == (self.blocklen + 2):
 379                 self.es_crc = self.es
 380                 # TODO: Check CRC.
 381                 self.put(self.ss_crc, self.es_crc, self.out_ann, [17, ['CRC']])
 382                 self.state = 'IDLE'
 383         elif miso == 0xfe:
 384             self.put(self.ss, self.es, self.out_ann, [17, ['Start Block']])
 385             self.cmd17_start_token_found = True
 386
 387     def handle_data_cmd24(self, mosi):
 388         if self.cmd24_start_token_found:
 389             if len(self.read_buf) == 0:
 390                 self.ss_data = self.ss
 391                 if not self.blocklen:
 392                     # Assume a fixed block size when inspection of the
 393                     # previous traffic did not provide the respective
 394                     # parameter value.
 395                     # TODO Make the default block size a user adjustable option?
 396                     self.blocklen = 512
 397             self.read_buf.append(mosi)
 398             # Wait until block transfer completed.
 399             if len(self.read_buf) < self.blocklen:
 400                 return
 401             self.es_data = self.es
 402             self.put(self.ss_data, self.es_data, self.out_ann, [24, ['Block data: %s' % self.read_buf]])
 403             self.read_buf = []
 404             self.state = 'DATA RESPONSE'
 405         elif mosi == 0xfe:
 406             self.put(self.ss, self.es, self.out_ann, [24, ['Start Block']])
 407             self.cmd24_start_token_found = True
 408
 409     def handle_data_response(self, miso):
 410         # Data Response token (1 byte).
 411         #
 412         # Format:
 413         #  - Bits[7:5]: Don't care.
 414         #  - Bits[4:4]: Always 0.
 415         #  - Bits[3:1]: Status.
 416         #    - 010: Data accepted.
 417         #    - 101: Data rejected due to a CRC error.
 418         #    - 110: Data rejected due to a write error.
 419         #  - Bits[0:0]: Always 1.
 420         miso &= 0x1f
 421         if miso & 0x11 != 0x01:
 422             # This is not the byte we are waiting for.
 423             # Should we return to IDLE here?
 424             return
 425         m = self.miso_bits
 426         self.put(m[7][1], m[5][2], self.out_ann, [134, ['Don\'t care']])
 427         self.put(m[4][1], m[4][2], self.out_ann, [134, ['Always 0']])
 428         if miso == 0x05:
 429             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data accepted']])
 430         elif miso == 0x0b:
 431             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (CRC error)']])
 432         elif miso == 0x0d:
 433             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (write error)']])
 434         self.put(m[0][1], m[0][2], self.out_ann, [134, ['Always 1']])
 435         ann_class = None
 436         if self.is_cmd24:
 437             ann_class = 24
 438         if ann_class is not None:
 439             self.put(self.ss, self.es, self.out_ann, [ann_class, ['Data Response']])
 440         self.state = 'IDLE'
 441
 442     def decode(self, ss, es, data):
 443         ptype, mosi, miso = data
 444
 445         # For now, only use DATA and BITS packets.
 446         if ptype not in ('DATA', 'BITS'):
 447             return
 448
 449         # Store the individual bit values and ss/es numbers. The next packet
 450         # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
 451         if ptype == 'BITS':
 452             self.miso_bits, self.mosi_bits = miso, mosi
 453             return
 454
 455         self.ss, self.es = ss, es
 456
 457         # State machine.
 458         if self.state == 'IDLE':
 459             # Ignore stray 0xff bytes, some devices seem to send those!?
 460             if mosi == 0xff: # TODO?
 461                 return
 462             self.state = 'GET COMMAND TOKEN'
 463             self.handle_command_token(mosi, miso)
 464         elif self.state == 'GET COMMAND TOKEN':
 465             self.handle_command_token(mosi, miso)
 466         elif self.state.startswith('HANDLE CMD'):
 467             self.miso, self.mosi = miso, mosi
 468             # Call the respective handler method for the command.
 469             a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower()
 470             handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
 471             handle_cmd()
 472             self.cmd_token = []
 473             self.cmd_token_bits = []
 474             # Leave ACMD mode again after the first command after CMD55.
 475             if self.is_acmd and cmdstr != '55':
 476                 self.is_acmd = False
 477         elif self.state.startswith('GET RESPONSE'):
 478             # Ignore stray 0xff bytes, some devices seem to send those!?
 479             if miso == 0xff: # TODO?
 480                 return
 481             # Call the respective handler method for the response.
 482             # Assume return to IDLE state, but allow response handlers
 483             # to advance to some other state when applicable.
 484             s = 'handle_response_%s' % self.state[13:].lower()
 485             handle_response = getattr(self, s)
 486             self.state = 'IDLE'
 487             handle_response(miso)
 488         elif self.state == 'HANDLE DATA BLOCK CMD17':
 489             self.handle_data_cmd17(miso)
 490         elif self.state == 'HANDLE DATA BLOCK CMD24':
 491             self.handle_data_cmd24(mosi)
 492         elif self.state == 'DATA RESPONSE':
 493             self.handle_data_response(miso)