decoders/spiflash/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2011-2016 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 .lists import *
  22
  23 L = len(cmds)
  24
  25 # Don't forget to keep this in sync with 'cmds' is lists.py.
  26 class Ann:
  27     WRSR, PP, READ, WRDI, RDSR, WREN, FAST_READ, SE, RDSCUR, WRSCUR, \
  28     RDSR2, CE, ESRY, DSRY, WRITE1, WRITE2, REMS, RDID, RDP_RES, CP, ENSO, DP, \
  29     READ2X, EXSO, CE2, STATUS, BE, REMS2, \
  30     BIT, FIELD, WARN = range(L + 3)
  31
  32 def cmd_annotation_classes():
  33     return tuple([tuple([cmd[0].lower(), cmd[1]]) for cmd in cmds.values()])
  34
  35 def decode_dual_bytes(sio0, sio1):
  36     # Given a byte in SIO0 (MOSI) of even bits and a byte in
  37     # SIO1 (MISO) of odd bits, return a tuple of two bytes.
  38     def combine_byte(even, odd):
  39         result = 0
  40         for bit in range(4):
  41             if even & (1 << bit):
  42                 result |= 1 << (bit*2)
  43             if odd & (1 << bit):
  44                 result |= 1 << ((bit*2) + 1)
  45         return result
  46     return (combine_byte(sio0 >> 4, sio1 >> 4), combine_byte(sio0, sio1))
  47
  48 def decode_status_reg(data):
  49     # TODO: Additional per-bit(s) self.put() calls with correct start/end.
  50
  51     # Bits[0:0]: WIP (write in progress)
  52     s = 'W' if (data & (1 << 0)) else 'No w'
  53     ret = '%srite operation in progress.\n' % s
  54
  55     # Bits[1:1]: WEL (write enable latch)
  56     s = '' if (data & (1 << 1)) else 'not '
  57     ret += 'Internal write enable latch is %sset.\n' % s
  58
  59     # Bits[5:2]: Block protect bits
  60     # TODO: More detailed decoding (chip-dependent).
  61     ret += 'Block protection bits (BP3-BP0): 0x%x.\n' % ((data & 0x3c) >> 2)
  62
  63     # Bits[6:6]: Continuously program mode (CP mode)
  64     s = '' if (data & (1 << 6)) else 'not '
  65     ret += 'Device is %sin continuously program mode (CP mode).\n' % s
  66
  67     # Bits[7:7]: SRWD (status register write disable)
  68     s = 'not ' if (data & (1 << 7)) else ''
  69     ret += 'Status register writes are %sallowed.\n' % s
  70
  71     return ret
  72
  73 class Decoder(srd.Decoder):
  74     api_version = 3
  75     id = 'spiflash'
  76     name = 'SPI flash'
  77     longname = 'SPI flash chips'
  78     desc = 'xx25 series SPI (NOR) flash chip protocol.'
  79     license = 'gplv2+'
  80     inputs = ['spi']
  81     outputs = ['spiflash']
  82     annotations = cmd_annotation_classes() + (
  83         ('bit', 'Bit'),
  84         ('field', 'Field'),
  85         ('warning', 'Warning'),
  86     )
  87     annotation_rows = (
  88         ('bits', 'Bits', (L + 0,)),
  89         ('fields', 'Fields', (L + 1,)),
  90         ('commands', 'Commands', tuple(range(len(cmds)))),
  91         ('warnings', 'Warnings', (L + 2,)),
  92     )
  93     options = (
  94         {'id': 'chip', 'desc': 'Chip', 'default': tuple(chips.keys())[0],
  95             'values': tuple(chips.keys())},
  96         {'id': 'format', 'desc': 'Data format', 'default': 'hex',
  97             'values': ('hex', 'ascii')},
  98     )
  99
 100     def __init__(self):
 101         self.reset()
 102
 103     def reset(self):
 104         self.device_id = -1
 105         self.on_end_transaction = None
 106         self.end_current_transaction()
 107
 108         # Build dict mapping command keys to handler functions. Each
 109         # command in 'cmds' (defined in lists.py) has a matching
 110         # handler self.handle_<shortname>.
 111         def get_handler(cmd):
 112             s = 'handle_%s' % cmds[cmd][0].lower().replace('/', '_')
 113             return getattr(self, s)
 114         self.cmd_handlers = dict((cmd, get_handler(cmd)) for cmd in cmds.keys())
 115
 116     def end_current_transaction(self):
 117         if self.on_end_transaction is not None: # Callback for CS# transition.
 118             self.on_end_transaction()
 119             self.on_end_transaction = None
 120         self.state = None
 121         self.cmdstate = 1
 122         self.addr = 0
 123         self.data = []
 124
 125     def start(self):
 126         self.out_ann = self.register(srd.OUTPUT_ANN)
 127         self.chip = chips[self.options['chip']]
 128         self.vendor = self.options['chip'].split('_')[0]
 129
 130     def putx(self, data):
 131         # Simplification, most annotations span exactly one SPI byte/packet.
 132         self.put(self.ss, self.es, self.out_ann, data)
 133
 134     def putf(self, data):
 135         self.put(self.ss_field, self.es_field, self.out_ann, data)
 136
 137     def putc(self, data):
 138         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
 139
 140     def device(self):
 141         return device_name[self.vendor].get(self.device_id, 'Unknown')
 142
 143     def vendor_device(self):
 144         return '%s %s' % (self.chip['vendor'], self.device())
 145
 146     def cmd_ann_list(self):
 147         x, s = cmds[self.state][0], cmds[self.state][1]
 148         return ['Command: %s (%s)' % (s, x), 'Command: %s' % s,
 149                 'Cmd: %s' % s, 'Cmd: %s' % x, x]
 150
 151     def cmd_vendor_dev_list(self):
 152         c, d = cmds[self.state], 'Device = %s' % self.vendor_device()
 153         return ['%s (%s): %s' % (c[1], c[0], d), '%s: %s' % (c[1], d),
 154                 '%s: %s' % (c[0], d), d, self.vendor_device()]
 155
 156     def emit_cmd_byte(self):
 157         self.ss_cmd = self.ss
 158         self.putx([Ann.FIELD, self.cmd_ann_list()])
 159         self.addr = 0
 160
 161     def emit_addr_bytes(self, mosi):
 162         self.addr |= (mosi << ((4 - self.cmdstate) * 8))
 163         b = ((3 - (self.cmdstate - 2)) * 8) - 1
 164         self.putx([Ann.BIT,
 165             ['Address bits %d..%d: 0x%02x' % (b, b - 7, mosi),
 166              'Addr bits %d..%d: 0x%02x' % (b, b - 7, mosi),
 167              'Addr bits %d..%d' % (b, b - 7), 'A%d..A%d' % (b, b - 7)]])
 168         if self.cmdstate == 2:
 169             self.ss_field = self.ss
 170         if self.cmdstate == 4:
 171             self.es_field = self.es
 172             self.putf([Ann.FIELD, ['Address: 0x%06x' % self.addr,
 173                 'Addr: 0x%06x' % self.addr, '0x%06x' % self.addr]])
 174
 175     def handle_wren(self, mosi, miso):
 176         self.putx([Ann.WREN, self.cmd_ann_list()])
 177         self.state = None
 178
 179     def handle_wrdi(self, mosi, miso):
 180         pass # TODO
 181
 182     def handle_rdid(self, mosi, miso):
 183         if self.cmdstate == 1:
 184             # Byte 1: Master sends command ID.
 185             self.emit_cmd_byte()
 186         elif self.cmdstate == 2:
 187             # Byte 2: Slave sends the JEDEC manufacturer ID.
 188             self.putx([Ann.FIELD, ['Manufacturer ID: 0x%02x' % miso]])
 189         elif self.cmdstate == 3:
 190             # Byte 3: Slave sends the memory type.
 191             self.putx([Ann.FIELD, ['Memory type: 0x%02x' % miso]])
 192         elif self.cmdstate == 4:
 193             # Byte 4: Slave sends the device ID.
 194             self.device_id = miso
 195             self.putx([Ann.FIELD, ['Device ID: 0x%02x' % miso]])
 196
 197         if self.cmdstate == 4:
 198             self.es_cmd = self.es
 199             self.putc([Ann.RDID, self.cmd_vendor_dev_list()])
 200             self.state = None
 201         else:
 202             self.cmdstate += 1
 203
 204     def handle_rdsr(self, mosi, miso):
 205         # Read status register: Master asserts CS#, sends RDSR command,
 206         # reads status register byte. If CS# is kept asserted, the status
 207         # register can be read continuously / multiple times in a row.
 208         # When done, the master de-asserts CS# again.
 209         if self.cmdstate == 1:
 210             # Byte 1: Master sends command ID.
 211             self.emit_cmd_byte()
 212         elif self.cmdstate >= 2:
 213             # Bytes 2-x: Slave sends status register as long as master clocks.
 214             self.es_cmd = self.es
 215             self.putx([Ann.BIT, [decode_status_reg(miso)]])
 216             self.putx([Ann.FIELD, ['Status register']])
 217             self.putc([Ann.RDSR, self.cmd_ann_list()])
 218         self.cmdstate += 1
 219
 220     def handle_rdsr2(self, mosi, miso):
 221         # Read status register 2: Master asserts CS#, sends RDSR2 command,
 222         # reads status register 2 byte. If CS# is kept asserted, the status
 223         # register 2 can be read continuously / multiple times in a row.
 224         # When done, the master de-asserts CS# again.
 225         if self.cmdstate == 1:
 226             # Byte 1: Master sends command ID.
 227             self.emit_cmd_byte()
 228         elif self.cmdstate >= 2:
 229             # Bytes 2-x: Slave sends status register 2 as long as master clocks.
 230             self.es_cmd = self.es
 231             # TODO: Decode status register 2 correctly.
 232             self.putx([Ann.BIT, [decode_status_reg(miso)]])
 233             self.putx([Ann.FIELD, ['Status register 2']])
 234             self.putc([Ann.RDSR2, self.cmd_ann_list()])
 235         self.cmdstate += 1
 236
 237     def handle_wrsr(self, mosi, miso):
 238         # Write status register: Master asserts CS#, sends WRSR command,
 239         # writes 1 or 2 status register byte(s).
 240         # When done, the master de-asserts CS# again. If this doesn't happen
 241         # the WRSR command will not be executed.
 242         if self.cmdstate == 1:
 243             # Byte 1: Master sends command ID.
 244             self.emit_cmd_byte()
 245         elif self.cmdstate == 2:
 246             # Byte 2: Master sends status register 1.
 247             self.putx([Ann.BIT, [decode_status_reg(miso)]])
 248             self.putx([Ann.FIELD, ['Status register 1']])
 249         elif self.cmdstate == 3:
 250             # Byte 3: Master sends status register 2.
 251             # TODO: Decode status register 2 correctly.
 252             self.putx([Ann.BIT, [decode_status_reg(miso)]])
 253             self.putx([Ann.FIELD, ['Status register 2']])
 254             self.es_cmd = self.es
 255             self.putc([Ann.WRSR, self.cmd_ann_list()])
 256         self.cmdstate += 1
 257
 258     def handle_read(self, mosi, miso):
 259         # Read data bytes: Master asserts CS#, sends READ command, sends
 260         # 3-byte address, reads >= 1 data bytes, de-asserts CS#.
 261         if self.cmdstate == 1:
 262             # Byte 1: Master sends command ID.
 263             self.emit_cmd_byte()
 264         elif self.cmdstate in (2, 3, 4):
 265             # Bytes 2/3/4: Master sends read address (24bits, MSB-first).
 266             self.emit_addr_bytes(mosi)
 267         elif self.cmdstate >= 5:
 268             # Bytes 5-x: Master reads data bytes (until CS# de-asserted).
 269             self.es_field = self.es # Will be overwritten for each byte.
 270             if self.cmdstate == 5:
 271                 self.ss_field = self.ss
 272                 self.on_end_transaction = lambda: self.output_data_block('Data', Ann.READ)
 273             self.data.append(miso)
 274         self.cmdstate += 1
 275
 276     def handle_write_common(self, mosi, miso, ann):
 277         # Write data bytes: Master asserts CS#, sends WRITE command, sends
 278         # 3-byte address, writes >= 1 data bytes, de-asserts CS#.
 279         if self.cmdstate == 1:
 280             # Byte 1: Master sends command ID.
 281             self.emit_cmd_byte()
 282         elif self.cmdstate in (2, 3, 4):
 283             # Bytes 2/3/4: Master sends write address (24bits, MSB-first).
 284             self.emit_addr_bytes(mosi)
 285         elif self.cmdstate >= 5:
 286             # Bytes 5-x: Master writes data bytes (until CS# de-asserted).
 287             self.es_field = self.es # Will be overwritten for each byte.
 288             if self.cmdstate == 5:
 289                 self.ss_field = self.ss
 290                 self.on_end_transaction = lambda: self.output_data_block('Data', ann)
 291             self.data.append(mosi)
 292         self.cmdstate += 1
 293
 294     def handle_write1(self, mosi, miso):
 295         self.handle_write_common(mosi, miso, Ann.WRITE1)
 296
 297     def handle_write2(self, mosi, miso):
 298         self.handle_write_common(mosi, miso, Ann.WRITE2)
 299
 300     def handle_fast_read(self, mosi, miso):
 301         # Fast read: Master asserts CS#, sends FAST READ command, sends
 302         # 3-byte address + 1 dummy byte, reads >= 1 data bytes, de-asserts CS#.
 303         if self.cmdstate == 1:
 304             # Byte 1: Master sends command ID.
 305             self.emit_cmd_byte()
 306         elif self.cmdstate in (2, 3, 4):
 307             # Bytes 2/3/4: Master sends read address (24bits, MSB-first).
 308             self.emit_addr_bytes(mosi)
 309         elif self.cmdstate == 5:
 310             self.putx([Ann.BIT, ['Dummy byte: 0x%02x' % mosi]])
 311         elif self.cmdstate >= 6:
 312             # Bytes 6-x: Master reads data bytes (until CS# de-asserted).
 313             self.es_field = self.es # Will be overwritten for each byte.
 314             if self.cmdstate == 6:
 315                 self.ss_field = self.ss
 316                 self.on_end_transaction = lambda: self.output_data_block('Data', Ann.FAST_READ)
 317             self.data.append(miso)
 318         self.cmdstate += 1
 319
 320     def handle_2read(self, mosi, miso):
 321         # 2x I/O read (fast read dual I/O): Master asserts CS#, sends 2READ
 322         # command, sends 3-byte address + 1 dummy byte, reads >= 1 data bytes,
 323         # de-asserts CS#. All data after the command is sent via two I/O pins.
 324         # MOSI = SIO0 = even bits, MISO = SIO1 = odd bits.
 325         if self.cmdstate != 1:
 326             b1, b2 = decode_dual_bytes(mosi, miso)
 327         if self.cmdstate == 1:
 328             # Byte 1: Master sends command ID.
 329             self.emit_cmd_byte()
 330         elif self.cmdstate == 2:
 331             # Bytes 2/3(/4): Master sends read address (24bits, MSB-first).
 332             # Handle bytes 2 and 3 here.
 333             self.emit_addr_bytes(b1)
 334             self.cmdstate = 3
 335             self.emit_addr_bytes(b2)
 336         elif self.cmdstate == 4:
 337             # Byte 5: Dummy byte. Also handle byte 4 (address LSB) here.
 338             self.emit_addr_bytes(b1)
 339             self.cmdstate = 5
 340             self.putx([Ann.BIT, ['Dummy byte: 0x%02x' % b2]])
 341         elif self.cmdstate >= 6:
 342             # Bytes 6-x: Master reads data bytes (until CS# de-asserted).
 343             self.es_field = self.es # Will be overwritten for each byte.
 344             if self.cmdstate == 6:
 345                 self.ss_field = self.ss
 346                 self.on_end_transaction = lambda: self.output_data_block('Data', Ann.READ2X)
 347             self.data.append(b1)
 348             self.data.append(b2)
 349         self.cmdstate += 1
 350
 351     def handle_status(self, mosi, miso):
 352         if self.cmdstate == 1:
 353             # Byte 1: Master sends command ID.
 354             self.emit_cmd_byte()
 355             self.on_end_transaction = lambda: self.putc([Ann.STATUS, [cmds[self.state][1]]])
 356         else:
 357             # Will be overwritten for each byte.
 358             self.es_cmd = self.es
 359             self.es_field = self.es
 360             if self.cmdstate == 2:
 361                 self.ss_field = self.ss
 362             self.putx([Ann.BIT, ['Status register byte %d: 0x%02x' % ((self.cmdstate % 2) + 1, miso)]])
 363         self.cmdstate += 1
 364
 365     # TODO: Warn/abort if we don't see the necessary amount of bytes.
 366     # TODO: Warn if WREN was not seen before.
 367     def handle_se(self, mosi, miso):
 368         if self.cmdstate == 1:
 369             # Byte 1: Master sends command ID.
 370             self.emit_cmd_byte()
 371         elif self.cmdstate in (2, 3, 4):
 372             # Bytes 2/3/4: Master sends sector address (24bits, MSB-first).
 373             self.emit_addr_bytes(mosi)
 374
 375         if self.cmdstate == 4:
 376             self.es_cmd = self.es
 377             d = 'Erase sector %d (0x%06x)' % (self.addr, self.addr)
 378             self.putc([Ann.SE, [d]])
 379             # TODO: Max. size depends on chip, check that too if possible.
 380             if self.addr % 4096 != 0:
 381                 # Sector addresses must be 4K-aligned (same for all 3 chips).
 382                 self.putc([Ann.WARN, ['Warning: Invalid sector address!']])
 383             self.state = None
 384         else:
 385             self.cmdstate += 1
 386
 387     def handle_be(self, mosi, miso):
 388         pass # TODO
 389
 390     # TODO: Warn if WREN was not seen before.
 391     def handle_ce(self, mosi, miso):
 392         self.putx([Ann.CE, self.cmd_ann_list()])
 393
 394     # TODO: Warn if WREN was not seen before.
 395     def handle_ce2(self, mosi, miso):
 396         self.putx([Ann.CE2, self.cmd_ann_list()])
 397
 398     def handle_pp(self, mosi, miso):
 399         # Page program: Master asserts CS#, sends PP command, sends 3-byte
 400         # page address, sends >= 1 data bytes, de-asserts CS#.
 401         if self.cmdstate == 1:
 402             # Byte 1: Master sends command ID.
 403             self.emit_cmd_byte()
 404         elif self.cmdstate in (2, 3, 4):
 405             # Bytes 2/3/4: Master sends page address (24bits, MSB-first).
 406             self.emit_addr_bytes(mosi)
 407         elif self.cmdstate >= 5:
 408             # Bytes 5-x: Master sends data bytes (until CS# de-asserted).
 409             self.es_field = self.es # Will be overwritten for each byte.
 410             if self.cmdstate == 5:
 411                 self.ss_field = self.ss
 412                 self.on_end_transaction = lambda: self.output_data_block('Data', Ann.PP)
 413             self.data.append(mosi)
 414         self.cmdstate += 1
 415
 416     def handle_cp(self, mosi, miso):
 417         pass # TODO
 418
 419     def handle_dp(self, mosi, miso):
 420         pass # TODO
 421
 422     def handle_rdp_res(self, mosi, miso):
 423         if self.cmdstate == 1:
 424             # Byte 1: Master sends command ID.
 425             self.emit_cmd_byte()
 426         elif self.cmdstate in (2, 3, 4):
 427             # Bytes 2/3/4: Master sends three dummy bytes.
 428             self.putx([Ann.FIELD, ['Dummy byte: %02x' % mosi]])
 429         elif self.cmdstate == 5:
 430             # Byte 5: Slave sends device ID.
 431             self.es_cmd = self.es
 432             self.device_id = miso
 433             self.putx([Ann.FIELD, ['Device ID: %s' % self.device()]])
 434             d = 'Device = %s' % self.vendor_device()
 435             self.putc([Ann.RDP_RES, self.cmd_vendor_dev_list()])
 436             self.state = None
 437         self.cmdstate += 1
 438
 439     def handle_rems(self, mosi, miso):
 440         if self.cmdstate == 1:
 441             # Byte 1: Master sends command ID.
 442             self.emit_cmd_byte()
 443         elif self.cmdstate in (2, 3):
 444             # Bytes 2/3: Master sends two dummy bytes.
 445             self.putx([Ann.FIELD, ['Dummy byte: 0x%02x' % mosi]])
 446         elif self.cmdstate == 4:
 447             # Byte 4: Master sends 0x00 or 0x01.
 448             # 0x00: Master wants manufacturer ID as first reply byte.
 449             # 0x01: Master wants device ID as first reply byte.
 450             self.manufacturer_id_first = True if (mosi == 0x00) else False
 451             d = 'manufacturer' if (mosi == 0x00) else 'device'
 452             self.putx([Ann.FIELD, ['Master wants %s ID first' % d]])
 453         elif self.cmdstate == 5:
 454             # Byte 5: Slave sends manufacturer ID (or device ID).
 455             self.ids = [miso]
 456             d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
 457             self.putx([Ann.FIELD, ['%s ID: 0x%02x' % (d, miso)]])
 458         elif self.cmdstate == 6:
 459             # Byte 6: Slave sends device ID (or manufacturer ID).
 460             self.ids.append(miso)
 461             d = 'Device' if self.manufacturer_id_first else 'Manufacturer'
 462             self.putx([Ann.FIELD, ['%s ID: 0x%02x' % (d, miso)]])
 463
 464         if self.cmdstate == 6:
 465             id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
 466             self.device_id = id
 467             self.es_cmd = self.es
 468             self.putc([Ann.REMS, self.cmd_vendor_dev_list()])
 469             self.state = None
 470         else:
 471             self.cmdstate += 1
 472
 473     def handle_rems2(self, mosi, miso):
 474         pass # TODO
 475
 476     def handle_enso(self, mosi, miso):
 477         pass # TODO
 478
 479     def handle_exso(self, mosi, miso):
 480         pass # TODO
 481
 482     def handle_rdscur(self, mosi, miso):
 483         pass # TODO
 484
 485     def handle_wrscur(self, mosi, miso):
 486         pass # TODO
 487
 488     def handle_esry(self, mosi, miso):
 489         pass # TODO
 490
 491     def handle_dsry(self, mosi, miso):
 492         pass # TODO
 493
 494     def output_data_block(self, label, idx):
 495         # Print accumulated block of data
 496         # (called on CS# de-assert via self.on_end_transaction callback).
 497         self.es_cmd = self.es # End on the CS# de-assert sample.
 498         if self.options['format'] == 'hex':
 499             s = ' '.join([('%02x' % b) for b in self.data])
 500         else:
 501             s = ''.join(map(chr, self.data))
 502         self.putf([Ann.FIELD, ['%s (%d bytes)' % (label, len(self.data))]])
 503         self.putc([idx, ['%s (addr 0x%06x, %d bytes): %s' % \
 504                    (cmds[self.state][1], self.addr, len(self.data), s)]])
 505
 506     def decode(self, ss, es, data):
 507         ptype, mosi, miso = data
 508
 509         self.ss, self.es = ss, es
 510
 511         if ptype == 'CS-CHANGE':
 512             self.end_current_transaction()
 513
 514         if ptype != 'DATA':
 515             return
 516
 517         # If we encountered a known chip command, enter the resp. state.
 518         if self.state is None:
 519             self.state = mosi
 520             self.cmdstate = 1
 521
 522         # Handle commands.
 523         try:
 524             self.cmd_handlers[self.state](mosi, miso)
 525         except KeyError:
 526             self.putx([Ann.BIT, ['Unknown command: 0x%02x' % mosi]])
 527             self.state = None