decoders/mx25lxx05d.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2011 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, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 #
  22 # Macronix MX25Lxx05D SPI (NOR) flash chip decoder.
  23 # Works for MX25L1605D/MX25L3205D/MX25L6405D.
  24 #
  25
  26 #
  27 # TODO: Description
  28 #
  29 # Details:
  30 # http://www.macronix.com/QuickPlace/hq/PageLibrary4825740B00298A3B.nsf/h_Index/3F21BAC2E121E17848257639003A3146/$File/MX25L1605D-3205D-6405D-1.5.pdf
  31 #
  32
  33 import sigrok
  34
  35 # States
  36 IDLE = -1
  37
  38 # Chip commands (also used as additional decoder states).
  39 CMD_WREN      = 0x06
  40 CMD_WRDI      = 0x04
  41 CMD_RDID      = 0x9f
  42 CMD_RDSR      = 0x05
  43 CMD_WRSR      = 0x01
  44 CMD_READ      = 0x03
  45 CMD_FAST_READ = 0x0b
  46 CMD_2READ     = 0xbb
  47 CMD_SE        = 0x20
  48 CMD_BE        = 0xd8
  49 CMD_CE        = 0x60
  50 CMD_CE2       = 0xc7
  51 CMD_PP        = 0x02
  52 CMD_CP        = 0xad
  53 CMD_DP        = 0xb9
  54 # CMD_RDP       = 0xab
  55 # CMD_RES       = 0xab
  56 CMD_RDP_RES   = 0xab # Note: RDP/RES have the same ID.
  57 CMD_REMS      = 0x90
  58 CMD_REMS2     = 0xef
  59 CMD_ENSO      = 0xb1
  60 CMD_EXSO      = 0xc1
  61 CMD_RDSCUR    = 0x2b
  62 CMD_WRSCUR    = 0x2f
  63 CMD_ESRY      = 0x70
  64 CMD_DSRY      = 0x80
  65
  66 # TODO: (Short) command names as strings in a dict, too?
  67
  68 # Dict which maps command IDs to their description.
  69 cmds = {
  70     CMD_WREN: 'Write enable',
  71     CMD_WRDI: 'Write disable',
  72     CMD_RDID: 'Read identification',
  73     CMD_RDSR: 'Read status register',
  74     CMD_WRSR: 'Write status register',
  75     CMD_READ: 'Read data',
  76     CMD_FAST_READ: 'Fast read data',
  77     CMD_2READ: '2x I/O read',
  78     CMD_SE: 'Sector erase',
  79     CMD_BE: 'Block erase',
  80     CMD_CE: 'Chip erase',
  81     CMD_CE2: 'Chip erase', # Alternative command ID
  82     CMD_PP: 'Page program',
  83     CMD_CP: 'Continuously program mode',
  84     CMD_DP: 'Deep power down',
  85     # CMD_RDP: 'Release from deep powerdown',
  86     # CMD_RES: 'Read electronic ID',
  87     CMD_RDP_RES: 'Release from deep powerdown / Read electronic ID',
  88     CMD_REMS: 'Read electronic manufacturer & device ID',
  89     CMD_REMS2: 'Read ID for 2x I/O mode',
  90     CMD_ENSO: 'Enter secured OTP',
  91     CMD_EXSO: 'Exit secured OTP',
  92     CMD_RDSCUR: 'Read security register',
  93     CMD_WRSCUR: 'Write security register',
  94     CMD_ESRY: 'Enable SO to output RY/BY#',
  95     CMD_DSRY: 'Disable SO to output RY/BY#',
  96 }
  97
  98 device_name = {
  99     0x14: 'MX25L1605D',
 100     0x15: 'MX25L3205D',
 101     0x16: 'MX25L6405D',
 102 }
 103
 104 # FIXME: This is just some example input for testing purposes...
 105
 106 mosi_packets = [
 107     # REMS
 108     {'type': 'D',  'range': (100, 110), 'data': 0x90, 'ann': ''},
 109     {'type': 'D',  'range': (120, 130), 'data': 0xff, 'ann': ''},
 110     {'type': 'D',  'range': (170, 180), 'data': 0xff, 'ann': ''},
 111     {'type': 'D',  'range': (190, 200), 'data': 0x00, 'ann': ''},
 112     {'type': 'D',  'range': (400, 410), 'data': 0xff, 'ann': ''},
 113     {'type': 'D',  'range': (411, 421), 'data': 0xff, 'ann': ''},
 114     # RDID
 115     {'type': 'D',  'range': (10, 11), 'data': 0x9f, 'ann': ''},
 116     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 117     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 118     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 119     # SE
 120     {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
 121     {'type': 'D',  'range': (10, 11), 'data': 0x12, 'ann': ''},
 122     {'type': 'D',  'range': (10, 11), 'data': 0x34, 'ann': ''},
 123     {'type': 'D',  'range': (10, 11), 'data': 0x56, 'ann': ''},
 124     # SE
 125     {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
 126     {'type': 'D',  'range': (10, 11), 'data': 0x44, 'ann': ''},
 127     {'type': 'D',  'range': (10, 11), 'data': 0x55, 'ann': ''},
 128     {'type': 'D',  'range': (10, 11), 'data': 0x66, 'ann': ''},
 129     # WREN
 130     {'type': 'D',  'range': (10, 11), 'data': 0x06, 'ann': ''},
 131 ]
 132
 133 miso_packets = [
 134     # REMS
 135     {'type': 'D',  'range': (100, 110), 'data': 0xff, 'ann': ''},
 136     {'type': 'D',  'range': (120, 130), 'data': 0xff, 'ann': ''},
 137     {'type': 'D',  'range': (170, 180), 'data': 0xff, 'ann': ''},
 138     {'type': 'D',  'range': (190, 200), 'data': 0xff, 'ann': ''},
 139     {'type': 'D',  'range': (400, 410), 'data': 0xc2, 'ann': ''},
 140     {'type': 'D',  'range': (411, 421), 'data': 0x14, 'ann': ''},
 141     # RDID
 142     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 143     {'type': 'D',  'range': (10, 11), 'data': 0xc2, 'ann': ''},
 144     {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
 145     {'type': 'D',  'range': (10, 11), 'data': 0x15, 'ann': ''},
 146     # SE
 147     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 148     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 149     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 150     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 151     # SE
 152     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 153     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 154     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 155     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 156     # WREN
 157     {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
 158 ]
 159
 160 class Sample():
 161     def __init__(self, data):
 162         self.data = data
 163     def probe(self, probe):
 164         s = ord(self.data[int(probe / 8)]) & (1 << (probe % 8))
 165         return True if s else False
 166
 167 def sampleiter(data, unitsize):
 168     for i in range(0, len(data), unitsize):
 169         yield(Sample(data[i:i+unitsize]))
 170
 171 class Decoder(sigrok.Decoder):
 172     id = 'mx25lxx05d'
 173     name = 'Macronix MX25Lxx05D'
 174     longname = 'Macronix MX25Lxx05D SPI flash chip decoder'
 175     desc = 'Macronix MX25Lxx05D SPI flash chip decoder'
 176     longdesc = 'TODO'
 177     author = 'Uwe Hermann'
 178     email = 'uwe@hermann-uwe.de'
 179     license = 'gplv2+'
 180     inputs = ['spi', 'spi', 'logic']
 181     outputs = ['mx25lxx05d']
 182     probes = {} # TODO: HOLD#, WP#/ACC
 183     options = {} # TODO
 184
 185     def __init__(self, **kwargs):
 186         self.probes = Decoder.probes.copy()
 187         self.output_protocol = None
 188         self.output_annotation = None
 189         self.state = IDLE
 190         self.cmdstate = 1 # TODO
 191         self.out = []
 192
 193     def start(self, metadata):
 194         self.unitsize = metadata['unitsize']
 195         # self.output_protocol = self.output_new(2)
 196         self.output_annotation = self.output_new(1)
 197
 198     def report(self):
 199         pass
 200
 201     def handle_wren(self, miso_packet, mosi_packet):
 202         self.out += [{'type': self.cmd, 'range': mosi_packet['range'],
 203                       'data': None, 'ann': cmds[self.state]}]
 204         self.state = IDLE
 205
 206     # TODO: Check/display device ID / name
 207     def handle_rdid(self, miso_packet, mosi_packet):
 208         ## self.state = IDLE
 209         ## return # FIXME
 210
 211         if self.cmdstate == 1:
 212             # Byte 1: Master sends command ID.
 213             self.start_sample = mosi_packet['range'][0]
 214             o = [] # TODO
 215         elif self.cmdstate == 2:
 216             # Byte 2: Slave sends the JEDEC manufacturer ID.
 217             o = [{'type': self.cmd, 'range': miso_packet['range'],
 218                   'data': miso_packet['data'], 'ann': 'Manufacturer ID'}]
 219         elif self.cmdstate == 3:
 220             # Byte 3: Slave sends the memory type (0x20 for this chip).
 221             o = [{'type': self.cmd, 'range': miso_packet['range'],
 222                   'data': miso_packet['data'], 'ann': 'Memory type'}]
 223         elif self.cmdstate == 4:
 224             # Byte 4: Slave sends the device ID.
 225             self.device_id = miso_packet['data']
 226             o = [{'type': self.cmd, 'range': miso_packet['range'],
 227                   'data': miso_packet['data'], 'ann': 'Device ID'}]
 228
 229         if self.cmdstate == 4:
 230             # TODO: Check self.device_id is valid & exists in device_names.
 231             # TODO: Same device ID? Check!
 232             dev = 'Device: Macronix %s' % device_name[self.device_id]
 233             o += [{'type': 'RDID', # TODO: self.cmd?
 234                    'range': (self.start_sample, miso_packet['range'][1]),
 235                    'data': None, # TODO?
 236                    'ann': dev}]
 237             self.state = IDLE
 238         else:
 239             self.cmdstate += 1
 240
 241         self.out += o
 242
 243     # TODO: Warn/abort if we don't see the necessary amount of bytes.
 244     # TODO: Warn if WREN was not seen before.
 245     def handle_se(self, miso_packet, mosi_packet):
 246         if self.cmdstate == 1:
 247             # Byte 1: Master sends command ID.
 248             self.addr = 0
 249             self.start_sample = mosi_packet['range'][0]
 250             o = [{'type': self.cmd, 'range': mosi_packet['range'],
 251                   'data': self.cmd, 'ann': 'Command ID'}]
 252         elif self.cmdstate in (2, 3, 4):
 253             # Bytes 2/3/4: Master sends address of the sector to erase.
 254             # Note: Assumes SPI data is 8 bits wide (it is for MX25Lxx05D).
 255             # TODO: LSB-first of MSB-first?
 256             self.addr <<= 8
 257             self.addr |= mosi_packet['data']
 258             o = [] # TODO: Output 'Address byte 1' and such fields?
 259
 260         if self.cmdstate == 4:
 261             o += [{'type': self.cmd,
 262                    'range': (self.start_sample, mosi_packet['range'][1]),
 263                    'data': '0x%x' % self.addr, 'ann': cmds[self.state]}]
 264             # TODO: Max. size depends on chip, check that too if possible.
 265             if self.addr % 4096 != 0:
 266                 # Sector addresses must be 4K-aligned (same for all 3 chips).
 267                 o += [{'type': self.cmd, # TODO: Type == 'Warning' or such?
 268                        'range': (self.start_sample, mosi_packet['range'][1]),
 269                        'data': None, 'ann': 'Warning: Invalid sector address!'}]
 270             self.state = IDLE
 271         else:
 272             self.cmdstate += 1
 273
 274         self.out += o
 275
 276     def handle_rems(self, miso_packet, mosi_packet):
 277         if self.cmdstate == 1:
 278             # Byte 1: Master sends command ID.
 279             self.start_sample = mosi_packet['range'][0]
 280             o = [{'type': self.cmd, 'range': mosi_packet['range'],
 281                   'data': self.cmd, 'ann': 'Command ID'}]
 282         elif self.cmdstate in (2, 3):
 283             # Bytes 2/3: Master sends two dummy bytes.
 284             # TODO: Check dummy bytes? Check reply from device?
 285             o = [{'type': self.cmd, 'range': mosi_packet['range'],
 286                   'data': mosi_packet['data'], 'ann': 'Dummy byte'}]
 287         elif self.cmdstate == 4:
 288             # Byte 4: Master sends 0x00 or 0x01.
 289             # 0x00: Master wants manufacturer ID as first reply byte.
 290             # 0x01: Master wants device ID as first reply byte.
 291             b = mosi_packet['data']
 292             self.manufacturer_id_first = True if (b == 0x00) else False
 293             d = 'manufacturer' if (b == 0x00) else 'device'
 294             o = [{'type': self.cmd, 'range': mosi_packet['range'],
 295                   'data': b, 'ann': '%s (%s ID first)' % (cmds[self.cmd], d)}]
 296         elif self.cmdstate == 5:
 297             # Byte 5: Slave sends manufacturer ID (or device ID).
 298             self.ids = [miso_packet['data']]
 299             o = []
 300         elif self.cmdstate in (5, 6):
 301             # Byte 6: Slave sends device ID (or manufacturer ID).
 302             self.ids += [miso_packet['data']]
 303             ann = 'Manufacturer' if self.manufacturer_id_first else 'Device'
 304             o = [{'type': self.cmd, 'range': miso_packet['range'],
 305                   'data': '0x%02x' % self.ids[0], 'ann': ann}]
 306             ann = 'Device' if self.manufacturer_id_first else 'Manufacturer'
 307             o += [{'type': self.cmd, 'range': miso_packet['range'],
 308                    'data': '0x%02x' % self.ids[1], 'ann': '%s ID' % ann}]
 309         else:
 310             # TODO: Error?
 311             pass
 312
 313         if self.cmdstate == 6:
 314             self.end_sample = miso_packet['range'][1]
 315             id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
 316             dev = 'Device: Macronix %s' % device_name[id]
 317             o += [{'type': self.cmd,
 318                    'range': (self.start_sample, self.end_sample),
 319                    'data': None, # TODO: Both IDs? Which format?
 320                    'ann': dev}]
 321             self.state = IDLE
 322         else:
 323             self.cmdstate += 1
 324
 325         self.out += o
 326
 327     def decode(self, timeoffset, duration, data):
 328         self.out = []
 329
 330         # Iterate over all SPI MISO/MOSI packets. TODO: HOLD#, WP#/ACC?
 331         for i in range(len(miso_packets)):
 332
 333             p_miso = miso_packets[i]
 334             p_mosi = mosi_packets[i]
 335
 336             # Assumption: Every p_miso has a p_mosi entry with same range.
 337
 338             # For now, skip non-data packets.
 339             if p_mosi['type'] != 'D':
 340                 continue
 341
 342             cmd = p_mosi['data']
 343
 344             # If we encountered a known chip command, enter the resp. state.
 345             if self.state == IDLE:
 346                 if cmd in cmds:
 347                     self.state = cmd
 348                     self.cmd = cmd # TODO: Eliminate?
 349                     self.cmdstate = 1
 350                 else:
 351                     pass # TODO
 352
 353             # Handle commands.
 354             # TODO: Use some generic way to invoke the resp. method.
 355             if self.state == CMD_WREN:
 356                 self.handle_wren(p_miso, p_mosi)
 357             elif self.state == CMD_SE:
 358                 self.handle_se(p_miso, p_mosi)
 359             elif self.state == CMD_RDID:
 360                 self.handle_rdid(p_miso, p_mosi)
 361             if self.state == CMD_REMS:
 362                 self.handle_rems(p_miso, p_mosi)
 363             else:
 364                 pass
 365
 366         if self.out != []:
 367             # self.put(self.output_protocol, 0, 0, out_proto)
 368             self.put(self.output_annotation, 0, 0, self.out)
 369