decoders/mx25lxx05d/mx25lxx05d.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2011-2012 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 sigrokdecode as srd
  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 class Decoder(srd.Decoder):
 105     api_version = 1
 106     id = 'mx25lxx05d'
 107     name = 'MX25Lxx05D'
 108     longname = 'Macronix MX25Lxx05D'
 109     desc = 'Macronix MX25Lxx05D SPI flash chip decoder'
 110     longdesc = 'TODO'
 111     license = 'gplv2+'
 112     inputs = ['spi', 'spi', 'logic']
 113     outputs = ['mx25lxx05d']
 114     probes = [] # TODO: HOLD#, WP#/ACC
 115     options = {} # TODO
 116     annotations = [
 117         ['TODO', 'TODO'],
 118     ]
 119
 120     def __init__(self, **kwargs):
 121         self.state = IDLE
 122         self.cmdstate = 1 # TODO
 123
 124     def start(self, metadata):
 125         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'mx25lxx05d')
 126         self.out_ann = self.add(srd.OUTPUT_ANN, 'mx25lxx05d')
 127
 128     def report(self):
 129         pass
 130
 131     def putann(self, data):
 132         # Simplification, most annotations span extactly one SPI byte/packet.
 133         self.put(self.ss, self.es, self.out_ann, data)
 134
 135     def handle_wren(self, mosi, miso):
 136         self.putann([0, ['Command: %s' % cmds[self.cmd]]])
 137         self.state = IDLE
 138
 139     # TODO: Check/display device ID / name
 140     def handle_rdid(self, mosi, miso):
 141         if self.cmdstate == 1:
 142             # Byte 1: Master sends command ID.
 143             self.start_sample = self.ss
 144             self.putann([0, ['Command: %s' % cmds[self.cmd]]])
 145         elif self.cmdstate == 2:
 146             # Byte 2: Slave sends the JEDEC manufacturer ID.
 147             self.putann([0, ['Manufacturer ID: 0x%02x' % miso]])
 148         elif self.cmdstate == 3:
 149             # Byte 3: Slave sends the memory type (0x20 for this chip).
 150             self.putann([0, ['Memory type: 0x%02x' % miso]])
 151         elif self.cmdstate == 4:
 152             # Byte 4: Slave sends the device ID.
 153             self.device_id = miso
 154             self.putann([0, ['Device ID: 0x%02x' % miso]])
 155
 156         if self.cmdstate == 4:
 157             # TODO: Check self.device_id is valid & exists in device_names.
 158             # TODO: Same device ID? Check!
 159             d = 'Device: Macronix %s' % device_name[self.device_id]
 160             self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
 161             self.state = IDLE
 162         else:
 163             self.cmdstate += 1
 164
 165     # TODO: Warn/abort if we don't see the necessary amount of bytes.
 166     # TODO: Warn if WREN was not seen before.
 167     def handle_se(self, mosi, miso):
 168         if self.cmdstate == 1:
 169             # Byte 1: Master sends command ID.
 170             self.addr = 0
 171             self.start_sample = self.ss
 172             self.putann([0, ['Command: %s' % cmds[self.cmd]]])
 173         elif self.cmdstate in (2, 3, 4):
 174             # Bytes 2/3/4: Master sends address of the sector to erase.
 175             # Note: Assumes SPI data is 8 bits wide (it is for MX25Lxx05D).
 176             # TODO: LSB-first of MSB-first?
 177             self.addr <<= 8
 178             self.addr |= mosi
 179             self.putann([0, ['Address byte %d: 0x%02x' % (self.cmdstate - 1,
 180                         miso)]]) # TODO: Count from 0 or 1?
 181
 182         if self.cmdstate == 4:
 183             d = 'Erase sector %d' % self.addr
 184             self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
 185             # TODO: Max. size depends on chip, check that too if possible.
 186             if self.addr % 4096 != 0:
 187                 # Sector addresses must be 4K-aligned (same for all 3 chips).
 188                 d = 'Warning: Invalid sector address!' # TODO: type == WARN?
 189                 self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
 190             self.state = IDLE
 191         else:
 192             self.cmdstate += 1
 193
 194     def handle_rems(self, mosi, miso):
 195         if self.cmdstate == 1:
 196             # Byte 1: Master sends command ID.
 197             self.start_sample = self.ss
 198             self.putann([0, ['Command: %s' % cmds[self.cmd]]])
 199         elif self.cmdstate in (2, 3):
 200             # Bytes 2/3: Master sends two dummy bytes.
 201             # TODO: Check dummy bytes? Check reply from device?
 202             self.putann([0, ['Dummy byte: %s' % mosi]])
 203         elif self.cmdstate == 4:
 204             # Byte 4: Master sends 0x00 or 0x01.
 205             # 0x00: Master wants manufacturer ID as first reply byte.
 206             # 0x01: Master wants device ID as first reply byte.
 207             self.manufacturer_id_first = True if (mosi == 0x00) else False
 208             d = 'manufacturer' if (mosi == 0x00) else 'device'
 209             self.putann([0, ['Master wants %s ID first' % d]])
 210         elif self.cmdstate == 5:
 211             # Byte 5: Slave sends manufacturer ID (or device ID).
 212             self.ids = [miso]
 213             d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
 214             self.putann([0, ['%s ID' % d]])
 215         elif self.cmdstate == 6:
 216             # Byte 6: Slave sends device ID (or manufacturer ID).
 217             self.ids += [miso]
 218             d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
 219             self.putann([0, ['%s ID' % d]])
 220         else:
 221             # TODO: Error?
 222             pass
 223
 224         if self.cmdstate == 6:
 225             self.end_sample = self.es
 226             id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
 227             self.putann([0, ['Device: Macronix %s' % device_name[id]]])
 228             self.state = IDLE
 229         else:
 230             self.cmdstate += 1
 231
 232     def handle_rdsr(self, mosi, miso):
 233         self.putann([0, ['Command: %s (0x%02x)' % (cmds[self.cmd], miso)]])
 234         self.state = IDLE
 235
 236     def decode(self, ss, es, data):
 237
 238         ptype, mosi, miso = data
 239
 240         if ptype != 'data':
 241             return
 242
 243         cmd = mosi
 244         self.ss = ss
 245         self.es = es
 246
 247         # If we encountered a known chip command, enter the resp. state.
 248         if self.state == IDLE:
 249             if cmd in cmds:
 250                 self.state = cmd
 251                 self.cmd = cmd # TODO: Eliminate?
 252                 self.cmdstate = 1
 253             else:
 254                 pass # TODO
 255         else:
 256             pass
 257
 258         # Handle commands.
 259         # TODO: Use some generic way to invoke the resp. method.
 260         if self.state == CMD_WREN:
 261             self.handle_wren(mosi, miso)
 262         elif self.state == CMD_SE:
 263             self.handle_se(mosi, miso)
 264         elif self.state == CMD_RDID:
 265             self.handle_rdid(mosi, miso)
 266         if self.state == CMD_REMS:
 267             self.handle_rems(mosi, miso)
 268         if self.state == CMD_RDSR:
 269             self.handle_rdsr(mosi, miso)
 270         else:
 271             self.put(0, 0, self.out_ann, [0, ['Unknown command: 0x%02x' % cmd]])
 272             self.state = IDLE
 273