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 = ['sdcard_spi']
  32     annotations = \
  33         tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
  34         tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
  35         ('r1', 'R1 reply'),
  36         ('r1b', 'R1B reply'),
  37         ('r2', 'R2 reply'),
  38         ('r3', 'R3 reply'),
  39         ('r7', 'R7 reply'),
  40         ('bits', 'Bits'),
  41         ('bit-warnings', 'Bit warnings'),
  42     )
  43     annotation_rows = (
  44         ('bits', 'Bits', (134, 135)),
  45         ('cmd-reply', 'Commands/replies', tuple(range(134))),
  46     )
  47
  48     def __init__(self):
  49         self.reset()
  50
  51     def reset(self):
  52         self.state = 'IDLE'
  53         self.ss, self.es = 0, 0
  54         self.ss_bit, self.es_bit = 0, 0
  55         self.ss_cmd, self.es_cmd = 0, 0
  56         self.cmd_token = []
  57         self.cmd_token_bits = []
  58         self.is_acmd = False # Indicates CMD vs. ACMD
  59         self.blocklen = 0
  60         self.read_buf = []
  61         self.cmd_str = ''
  62
  63     def start(self):
  64         self.out_ann = self.register(srd.OUTPUT_ANN)
  65
  66     def putx(self, data):
  67         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
  68
  69     def putc(self, cmd, desc):
  70         self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
  71
  72     def putb(self, data):
  73         self.put(self.ss_bit, self.es_bit, self.out_ann, data)
  74
  75     def cmd_name(self, cmd):
  76         c = acmd_names if self.is_acmd else cmd_names
  77         s = c.get(cmd, 'Unknown')
  78         # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}.
  79         # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR.
  80         if cmd in (32, 33):
  81             s += '_ADDR'
  82         return s
  83
  84     def handle_command_token(self, mosi, miso):
  85         # Command tokens (6 bytes) are sent (MSB-first) by the host.
  86         #
  87         # Format:
  88         #  - CMD[47:47]: Start bit (always 0)
  89         #  - CMD[46:46]: Transmitter bit (1 == host)
  90         #  - CMD[45:40]: Command index (BCD; valid: 0-63)
  91         #  - CMD[39:08]: Argument
  92         #  - CMD[07:01]: CRC7
  93         #  - CMD[00:00]: End bit (always 1)
  94
  95         if len(self.cmd_token) == 0:
  96             self.ss_cmd = self.ss
  97
  98         self.cmd_token.append(mosi)
  99         self.cmd_token_bits.append(self.mosi_bits)
 100
 101         # All command tokens are 6 bytes long.
 102         if len(self.cmd_token) < 6:
 103             return
 104
 105         self.es_cmd = self.es
 106
 107         t = self.cmd_token
 108
 109         # CMD or ACMD?
 110         s = 'ACMD' if self.is_acmd else 'CMD'
 111
 112         def tb(byte, bit):
 113             return self.cmd_token_bits[5 - byte][bit]
 114
 115         # Bits[47:47]: Start bit (always 0)
 116         bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
 117         if bit == 0:
 118             self.putb([134, ['Start bit: %d' % bit]])
 119         else:
 120             self.putb([135, ['Start bit: %s (Warning: Must be 0!)' % bit]])
 121
 122         # Bits[46:46]: Transmitter bit (1 == host)
 123         bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
 124         if bit == 1:
 125             self.putb([134, ['Transmitter bit: %d' % bit]])
 126         else:
 127             self.putb([135, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
 128
 129         # Bits[45:40]: Command index (BCD; valid: 0-63)
 130         cmd = self.cmd_index = t[0] & 0x3f
 131         self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2]
 132         self.putb([134, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]])
 133
 134         # Bits[39:8]: Argument
 135         self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
 136         self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2]
 137         self.putb([134, ['Argument: 0x%04x' % self.arg]])
 138
 139         # Bits[7:1]: CRC7
 140         # TODO: Check CRC7.
 141         crc = t[5] >> 1
 142         self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2]
 143         self.putb([134, ['CRC7: 0x%01x' % crc]])
 144
 145         # Bits[0:0]: End bit (always 1)
 146         bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
 147         self.putb([134, ['End bit: %d' % bit]])
 148         if bit == 1:
 149             self.putb([134, ['End bit: %d' % bit]])
 150         else:
 151             self.putb([135, ['End bit: %d (Warning: Must be 1!)' % bit]])
 152
 153         # Handle command.
 154         if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59):
 155             self.state = 'HANDLE CMD%d' % cmd
 156             self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd))
 157         else:
 158             self.state = 'HANDLE CMD999'
 159             a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
 160             self.putx([cmd, [a]])
 161
 162     def handle_cmd0(self):
 163         # CMD0: GO_IDLE_STATE
 164         self.putc(0, 'Reset the SD card')
 165         self.state = 'GET RESPONSE R1'
 166
 167     def handle_cmd1(self):
 168         # CMD1: SEND_OP_COND
 169         self.putc(1, 'Send HCS info and activate the card init process')
 170         hcs = (self.arg & (1 << 30)) >> 30
 171         self.ss_bit = self.cmd_token_bits[5 - 4][6][1]
 172         self.es_bit = self.cmd_token_bits[5 - 4][6][2]
 173         self.putb([134, ['HCS: %d' % hcs]])
 174         self.state = 'GET RESPONSE R1'
 175
 176     def handle_cmd9(self):
 177         # CMD9: SEND_CSD (128 bits / 16 bytes)
 178         self.putc(9, 'Ask card to send its card specific data (CSD)')
 179         if len(self.read_buf) == 0:
 180             self.ss_cmd = self.ss
 181         self.read_buf.append(self.miso)
 182         # FIXME
 183         ### if len(self.read_buf) < 16:
 184         if len(self.read_buf) < 16 + 4:
 185             return
 186         self.es_cmd = self.es
 187         self.read_buf = self.read_buf[4:] # TODO: Document or redo.
 188         self.putx([9, ['CSD: %s' % self.read_buf]])
 189         # TODO: Decode all bits.
 190         self.read_buf = []
 191         ### self.state = 'GET RESPONSE R1'
 192         self.state = 'IDLE'
 193
 194     def handle_cmd10(self):
 195         # CMD10: SEND_CID (128 bits / 16 bytes)
 196         self.putc(10, 'Ask card to send its card identification (CID)')
 197         self.read_buf.append(self.miso)
 198         if len(self.read_buf) < 16:
 199             return
 200         self.putx([10, ['CID: %s' % self.read_buf]])
 201         # TODO: Decode all bits.
 202         self.read_buf = []
 203         self.state = 'GET RESPONSE R1'
 204
 205     def handle_cmd16(self):
 206         # CMD16: SET_BLOCKLEN
 207         self.blocklen = self.arg
 208         # TODO: Sanity check on block length.
 209         self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
 210         self.state = 'GET RESPONSE R1'
 211
 212     def handle_cmd17(self):
 213         # CMD17: READ_SINGLE_BLOCK
 214         self.putc(17, 'Read a block from address 0x%04x' % self.arg)
 215         if len(self.read_buf) == 0:
 216             self.ss_cmd = self.ss
 217         self.read_buf.append(self.miso)
 218         if len(self.read_buf) < self.blocklen + 2: # FIXME
 219             return
 220         self.es_cmd = self.es
 221         self.read_buf = self.read_buf[2:] # FIXME
 222         self.putx([17, ['Block data: %s' % self.read_buf]])
 223         self.read_buf = []
 224         self.state = 'GET RESPONSE R1'
 225
 226     def handle_cmd49(self):
 227         self.state = 'GET RESPONSE R1'
 228
 229     def handle_cmd55(self):
 230         # CMD55: APP_CMD
 231         self.putc(55, 'Next command is an application-specific command')
 232         self.is_acmd = True
 233         self.state = 'GET RESPONSE R1'
 234
 235     def handle_cmd59(self):
 236         # CMD59: CRC_ON_OFF
 237         crc_on_off = self.arg & (1 << 0)
 238         s = 'on' if crc_on_off == 1 else 'off'
 239         self.putc(59, 'Turn the SD card CRC option %s' % s)
 240         self.state = 'GET RESPONSE R1'
 241
 242     def handle_acmd41(self):
 243         # ACMD41: SD_SEND_OP_COND
 244         self.putc(64 + 41, 'Send HCS info and activate the card init process')
 245         self.state = 'GET RESPONSE R1'
 246
 247     def handle_cmd999(self):
 248         self.state = 'GET RESPONSE R1'
 249
 250     def handle_cid_register(self):
 251         # Card Identification (CID) register, 128bits
 252
 253         cid = self.cid
 254
 255         # Manufacturer ID: CID[127:120] (8 bits)
 256         mid = cid[15]
 257
 258         # OEM/Application ID: CID[119:104] (16 bits)
 259         oid = (cid[14] << 8) | cid[13]
 260
 261         # Product name: CID[103:64] (40 bits)
 262         pnm = 0
 263         for i in range(12, 8 - 1, -1):
 264             pnm <<= 8
 265             pnm |= cid[i]
 266
 267         # Product revision: CID[63:56] (8 bits)
 268         prv = cid[7]
 269
 270         # Product serial number: CID[55:24] (32 bits)
 271         psn = 0
 272         for i in range(6, 3 - 1, -1):
 273             psn <<= 8
 274             psn |= cid[i]
 275
 276         # RESERVED: CID[23:20] (4 bits)
 277
 278         # Manufacturing date: CID[19:8] (12 bits)
 279         # TODO
 280
 281         # CRC7 checksum: CID[7:1] (7 bits)
 282         # TODO
 283
 284         # Not used, always 1: CID[0:0] (1 bit)
 285         # TODO
 286
 287     def handle_response_r1(self, res):
 288         # The R1 response token format (1 byte).
 289         # Sent by the card after every command except for SEND_STATUS.
 290
 291         self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2]
 292         self.putx([65, ['R1: 0x%02x' % res]])
 293
 294         def putbit(bit, data):
 295             b = self.miso_bits[bit]
 296             self.ss_bit, self.es_bit = b[1], b[2]
 297             self.putb([134, data])
 298
 299         # Bit 0: 'In idle state' bit
 300         s = '' if (res & (1 << 0)) else 'not '
 301         putbit(0, ['Card is %sin idle state' % s])
 302
 303         # Bit 1: 'Erase reset' bit
 304         s = '' if (res & (1 << 1)) else 'not '
 305         putbit(1, ['Erase sequence %scleared' % s])
 306
 307         # Bit 2: 'Illegal command' bit
 308         s = 'I' if (res & (1 << 2)) else 'No i'
 309         putbit(2, ['%sllegal command detected' % s])
 310
 311         # Bit 3: 'Communication CRC error' bit
 312         s = 'failed' if (res & (1 << 3)) else 'was successful'
 313         putbit(3, ['CRC check of last command %s' % s])
 314
 315         # Bit 4: 'Erase sequence error' bit
 316         s = 'E' if (res & (1 << 4)) else 'No e'
 317         putbit(4, ['%srror in the sequence of erase commands' % s])
 318
 319         # Bit 5: 'Address error' bit
 320         s = 'M' if (res & (1 << 4)) else 'No m'
 321         putbit(5, ['%sisaligned address used in command' % s])
 322
 323         # Bit 6: 'Parameter error' bit
 324         s = '' if (res & (1 << 4)) else 'not '
 325         putbit(6, ['Command argument %soutside allowed range' % s])
 326
 327         # Bit 7: Always set to 0
 328         putbit(7, ['Bit 7 (always 0)'])
 329
 330         self.state = 'IDLE'
 331
 332     def handle_response_r1b(self, res):
 333         # TODO
 334         pass
 335
 336     def handle_response_r2(self, res):
 337         # TODO
 338         pass
 339
 340     def handle_response_r3(self, res):
 341         # TODO
 342         pass
 343
 344     # Note: Response token formats R4 and R5 are reserved for SDIO.
 345
 346     # TODO: R6?
 347
 348     def handle_response_r7(self, res):
 349         # TODO
 350         pass
 351
 352     def decode(self, ss, es, data):
 353         ptype, mosi, miso = data
 354
 355         # For now, only use DATA and BITS packets.
 356         if ptype not in ('DATA', 'BITS'):
 357             return
 358
 359         # Store the individual bit values and ss/es numbers. The next packet
 360         # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
 361         if ptype == 'BITS':
 362             self.miso_bits, self.mosi_bits = miso, mosi
 363             return
 364
 365         self.ss, self.es = ss, es
 366
 367         # State machine.
 368         if self.state == 'IDLE':
 369             # Ignore stray 0xff bytes, some devices seem to send those!?
 370             if mosi == 0xff: # TODO?
 371                 return
 372             self.state = 'GET COMMAND TOKEN'
 373             self.handle_command_token(mosi, miso)
 374         elif self.state == 'GET COMMAND TOKEN':
 375             self.handle_command_token(mosi, miso)
 376         elif self.state.startswith('HANDLE CMD'):
 377             self.miso, self.mosi = miso, mosi
 378             # Call the respective handler method for the command.
 379             a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower()
 380             handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
 381             handle_cmd()
 382             self.cmd_token = []
 383             self.cmd_token_bits = []
 384             # Leave ACMD mode again after the first command after CMD55.
 385             if self.is_acmd and cmdstr != '55':
 386                 self.is_acmd = False
 387         elif self.state.startswith('GET RESPONSE'):
 388             # Ignore stray 0xff bytes, some devices seem to send those!?
 389             if miso == 0xff: # TODO?
 390                 return
 391
 392             # Call the respective handler method for the response.
 393             s = 'handle_response_%s' % self.state[13:].lower()
 394             handle_response = getattr(self, s)
 395             handle_response(miso)
 396
 397             self.state = 'IDLE'