3f0dc18c71df247d6577414168f0099f253c62ff
[libsigrokdecode.git] / 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 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 # 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 Decoder(srd.Decoder):
161     id = 'mx25lxx05d'
162     name = 'Macronix MX25Lxx05D'
163     longname = 'Macronix MX25Lxx05D SPI flash chip decoder'
164     desc = 'Macronix MX25Lxx05D SPI flash chip decoder'
165     longdesc = 'TODO'
166     author = 'Uwe Hermann'
167     email = 'uwe@hermann-uwe.de'
168     license = 'gplv2+'
169     inputs = ['spi', 'spi', 'logic']
170     outputs = ['mx25lxx05d']
171     probes = [] # TODO: HOLD#, WP#/ACC
172     options = {} # TODO
173
174     def __init__(self, **kwargs):
175         self.state = IDLE
176         self.cmdstate = 1 # TODO
177         self.out = []
178
179     def start(self, metadata):
180         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'mx25lxx05d')
181         self.out_ann = self.add(srd.OUTPUT_ANN, 'mx25lxx05d')
182
183     def report(self):
184         pass
185
186     def handle_wren(self, miso_packet, mosi_packet):
187         self.out += [{'type': self.cmd, 'range': mosi_packet['range'],
188                       'data': None, 'ann': cmds[self.state]}]
189         self.state = IDLE
190
191     # TODO: Check/display device ID / name
192     def handle_rdid(self, miso_packet, mosi_packet):
193         ## self.state = IDLE
194         ## return # FIXME
195
196         if self.cmdstate == 1:
197             # Byte 1: Master sends command ID.
198             self.start_sample = mosi_packet['range'][0]
199             o = [] # TODO
200         elif self.cmdstate == 2:
201             # Byte 2: Slave sends the JEDEC manufacturer ID.
202             o = [{'type': self.cmd, 'range': miso_packet['range'],
203                   'data': miso_packet['data'], 'ann': 'Manufacturer ID'}]
204         elif self.cmdstate == 3:
205             # Byte 3: Slave sends the memory type (0x20 for this chip).
206             o = [{'type': self.cmd, 'range': miso_packet['range'],
207                   'data': miso_packet['data'], 'ann': 'Memory type'}]
208         elif self.cmdstate == 4:
209             # Byte 4: Slave sends the device ID.
210             self.device_id = miso_packet['data']
211             o = [{'type': self.cmd, 'range': miso_packet['range'],
212                   'data': miso_packet['data'], 'ann': 'Device ID'}]
213
214         if self.cmdstate == 4:
215             # TODO: Check self.device_id is valid & exists in device_names.
216             # TODO: Same device ID? Check!
217             dev = 'Device: Macronix %s' % device_name[self.device_id]
218             o += [{'type': 'RDID', # TODO: self.cmd?
219                    'range': (self.start_sample, miso_packet['range'][1]),
220                    'data': None, # TODO?
221                    'ann': dev}]
222             self.state = IDLE
223         else:
224             self.cmdstate += 1
225
226         self.out += o
227
228     # TODO: Warn/abort if we don't see the necessary amount of bytes.
229     # TODO: Warn if WREN was not seen before.
230     def handle_se(self, miso_packet, mosi_packet):
231         if self.cmdstate == 1:
232             # Byte 1: Master sends command ID.
233             self.addr = 0
234             self.start_sample = mosi_packet['range'][0]
235             o = [{'type': self.cmd, 'range': mosi_packet['range'],
236                   'data': self.cmd, 'ann': 'Command ID'}]
237         elif self.cmdstate in (2, 3, 4):
238             # Bytes 2/3/4: Master sends address of the sector to erase.
239             # Note: Assumes SPI data is 8 bits wide (it is for MX25Lxx05D).
240             # TODO: LSB-first of MSB-first?
241             self.addr <<= 8
242             self.addr |= mosi_packet['data']
243             o = [] # TODO: Output 'Address byte 1' and such fields?
244
245         if self.cmdstate == 4:
246             o += [{'type': self.cmd,
247                    'range': (self.start_sample, mosi_packet['range'][1]),
248                    'data': '0x%x' % self.addr, 'ann': cmds[self.state]}]
249             # TODO: Max. size depends on chip, check that too if possible.
250             if self.addr % 4096 != 0:
251                 # Sector addresses must be 4K-aligned (same for all 3 chips).
252                 o += [{'type': self.cmd, # TODO: Type == 'Warning' or such?
253                        'range': (self.start_sample, mosi_packet['range'][1]),
254                        'data': None, 'ann': 'Warning: Invalid sector address!'}]
255             self.state = IDLE
256         else:
257             self.cmdstate += 1
258
259         self.out += o
260
261     def handle_rems(self, miso_packet, mosi_packet):
262         if self.cmdstate == 1:
263             # Byte 1: Master sends command ID.
264             self.start_sample = mosi_packet['range'][0]
265             o = [{'type': self.cmd, 'range': mosi_packet['range'],
266                   'data': self.cmd, 'ann': 'Command ID'}]
267         elif self.cmdstate in (2, 3):
268             # Bytes 2/3: Master sends two dummy bytes.
269             # TODO: Check dummy bytes? Check reply from device?
270             o = [{'type': self.cmd, 'range': mosi_packet['range'],
271                   'data': mosi_packet['data'], 'ann': 'Dummy byte'}]
272         elif self.cmdstate == 4:
273             # Byte 4: Master sends 0x00 or 0x01.
274             # 0x00: Master wants manufacturer ID as first reply byte.
275             # 0x01: Master wants device ID as first reply byte.
276             b = mosi_packet['data']
277             self.manufacturer_id_first = True if (b == 0x00) else False
278             d = 'manufacturer' if (b == 0x00) else 'device'
279             o = [{'type': self.cmd, 'range': mosi_packet['range'],
280                   'data': b, 'ann': '%s (%s ID first)' % (cmds[self.cmd], d)}]
281         elif self.cmdstate == 5:
282             # Byte 5: Slave sends manufacturer ID (or device ID).
283             self.ids = [miso_packet['data']]
284             o = []
285         elif self.cmdstate in (5, 6):
286             # Byte 6: Slave sends device ID (or manufacturer ID).
287             self.ids += [miso_packet['data']]
288             ann = 'Manufacturer' if self.manufacturer_id_first else 'Device'
289             o = [{'type': self.cmd, 'range': miso_packet['range'],
290                   'data': '0x%02x' % self.ids[0], 'ann': ann}]
291             ann = 'Device' if self.manufacturer_id_first else 'Manufacturer'
292             o += [{'type': self.cmd, 'range': miso_packet['range'],
293                    'data': '0x%02x' % self.ids[1], 'ann': '%s ID' % ann}]
294         else:
295             # TODO: Error?
296             pass
297
298         if self.cmdstate == 6:
299             self.end_sample = miso_packet['range'][1]
300             id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
301             dev = 'Device: Macronix %s' % device_name[id]
302             o += [{'type': self.cmd,
303                    'range': (self.start_sample, self.end_sample),
304                    'data': None, # TODO: Both IDs? Which format?
305                    'ann': dev}]
306             self.state = IDLE
307         else:
308             self.cmdstate += 1
309
310         self.out += o
311
312     def decode(self, timeoffset, duration, data):
313         self.out = []
314
315         # Iterate over all SPI MISO/MOSI packets. TODO: HOLD#, WP#/ACC?
316         for i in range(len(miso_packets)):
317
318             p_miso = miso_packets[i]
319             p_mosi = mosi_packets[i]
320
321             # Assumption: Every p_miso has a p_mosi entry with same range.
322
323             # For now, skip non-data packets.
324             if p_mosi['type'] != 'D':
325                 continue
326
327             cmd = p_mosi['data']
328
329             # If we encountered a known chip command, enter the resp. state.
330             if self.state == IDLE:
331                 if cmd in cmds:
332                     self.state = cmd
333                     self.cmd = cmd # TODO: Eliminate?
334                     self.cmdstate = 1
335                 else:
336                     pass # TODO
337
338             # Handle commands.
339             # TODO: Use some generic way to invoke the resp. method.
340             if self.state == CMD_WREN:
341                 self.handle_wren(p_miso, p_mosi)
342             elif self.state == CMD_SE:
343                 self.handle_se(p_miso, p_mosi)
344             elif self.state == CMD_RDID:
345                 self.handle_rdid(p_miso, p_mosi)
346             if self.state == CMD_REMS:
347                 self.handle_rems(p_miso, p_mosi)
348             else:
349                 pass
350
351         if self.out != []:
352             # self.put(0, 0, self.out_proto, out_proto)
353             self.put(0, 0, self.out_ann, self.out)
354