]> sigrok.org Git - libsigrokdecode.git/blob - decoders/spiflash/pd.py
spiflash: Add FIDELIX FM25Q32 metadata.
[libsigrokdecode.git] / decoders / spiflash / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2011-2015 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 import sigrokdecode as srd
22 from .lists import *
23
24 def cmd_annotation_classes():
25     return tuple([tuple([cmd[0].lower(), cmd[1]]) for cmd in cmds.values()])
26
27 def decode_dual_bytes(sio0, sio1):
28     # Given a byte in SIO0 (MOSI) of even bits and a byte in
29     # SIO1 (MISO) of odd bits, return a tuple of two bytes.
30     def combine_byte(even, odd):
31         result = 0
32         for bit in range(4):
33             if even & (1 << bit):
34                 result |= 1 << (bit*2)
35             if odd & (1 << bit):
36                 result |= 1 << ((bit*2) + 1)
37         return result
38     return (combine_byte(sio0 >> 4, sio1 >> 4), combine_byte(sio0, sio1))
39
40 def decode_status_reg(data):
41     # TODO: Additional per-bit(s) self.put() calls with correct start/end.
42
43     # Bits[0:0]: WIP (write in progress)
44     s = 'W' if (data & (1 << 0)) else 'No w'
45     ret = '%srite operation in progress.\n' % s
46
47     # Bits[1:1]: WEL (write enable latch)
48     s = '' if (data & (1 << 1)) else 'not '
49     ret += 'Internal write enable latch is %sset.\n' % s
50
51     # Bits[5:2]: Block protect bits
52     # TODO: More detailed decoding (chip-dependent).
53     ret += 'Block protection bits (BP3-BP0): 0x%x.\n' % ((data & 0x3c) >> 2)
54
55     # Bits[6:6]: Continuously program mode (CP mode)
56     s = '' if (data & (1 << 6)) else 'not '
57     ret += 'Device is %sin continuously program mode (CP mode).\n' % s
58
59     # Bits[7:7]: SRWD (status register write disable)
60     s = 'not ' if (data & (1 << 7)) else ''
61     ret += 'Status register writes are %sallowed.\n' % s
62
63     return ret
64
65 class Decoder(srd.Decoder):
66     api_version = 2
67     id = 'spiflash'
68     name = 'SPI flash'
69     longname = 'SPI flash chips'
70     desc = 'xx25 series SPI (NOR) flash chip protocol.'
71     license = 'gplv2+'
72     inputs = ['spi']
73     outputs = ['spiflash']
74     annotations = cmd_annotation_classes() + (
75         ('bits', 'Bits'),
76         ('bits2', 'Bits2'),
77         ('warnings', 'Warnings'),
78     )
79     annotation_rows = (
80         ('bits', 'Bits', (24, 25)),
81         ('commands', 'Commands', tuple(range(23 + 1))),
82         ('warnings', 'Warnings', (26,)),
83     )
84     options = (
85         {'id': 'chip', 'desc': 'Chip', 'default': tuple(chips.keys())[0],
86             'values': tuple(chips.keys())},
87         {'id': 'format', 'desc': 'Data format', 'default': 'hex',
88             'values': ('hex', 'ascii')},
89     )
90
91     def __init__(self):
92         self.device_id = -1
93         self.on_end_transaction = None
94         self.end_current_transaction()
95
96         # Build dict mapping command keys to handler functions. Each
97         # command in 'cmds' (defined in lists.py) has a matching
98         # handler self.handle_<shortname>.
99         def get_handler(cmd):
100             s = 'handle_%s' % cmds[cmd][0].lower().replace('/', '_')
101             return getattr(self, s)
102         self.cmd_handlers = dict((cmd, get_handler(cmd)) for cmd in cmds.keys())
103
104     def end_current_transaction(self):
105         if self.on_end_transaction is not None: # Callback for CS# transition.
106             self.on_end_transaction()
107             self.on_end_transaction = None
108         self.state = None
109         self.cmdstate = 1
110         self.addr = 0
111         self.data = []
112
113     def start(self):
114         self.out_ann = self.register(srd.OUTPUT_ANN)
115         self.chip = chips[self.options['chip']]
116         self.vendor = self.options['chip'].split('_')[0]
117
118     def putx(self, data):
119         # Simplification, most annotations span exactly one SPI byte/packet.
120         self.put(self.ss, self.es, self.out_ann, data)
121
122     def putb(self, data):
123         self.put(self.ss_block, self.es_block, self.out_ann, data)
124
125     def vendor_device(self):
126         dev = device_name[self.vendor].get(self.device_id, 'Unknown')
127         return '%s %s' % (self.chip['vendor'], dev)
128
129     def handle_wren(self, mosi, miso):
130         self.putx([0, ['Command: %s' % cmds[self.state][1]]])
131         self.state = None
132
133     def handle_wrdi(self, mosi, miso):
134         pass # TODO
135
136     # TODO: Check/display device ID / name
137     def handle_rdid(self, mosi, miso):
138         if self.cmdstate == 1:
139             # Byte 1: Master sends command ID.
140             self.ss_block = self.ss
141             self.putx([2, ['Command: %s' % cmds[self.state][1]]])
142         elif self.cmdstate == 2:
143             # Byte 2: Slave sends the JEDEC manufacturer ID.
144             self.putx([2, ['Manufacturer ID: 0x%02x' % miso]])
145         elif self.cmdstate == 3:
146             # Byte 3: Slave sends the memory type (0x20 for this chip).
147             self.putx([2, ['Memory type: 0x%02x' % miso]])
148         elif self.cmdstate == 4:
149             # Byte 4: Slave sends the device ID.
150             self.device_id = miso
151             self.putx([2, ['Device ID: 0x%02x' % miso]])
152
153         if self.cmdstate == 4:
154             # TODO: Same device ID? Check!
155             d = 'Device: %s' % self.vendor_device()
156             self.put(self.ss_block, self.es, self.out_ann, [0, [d]])
157             self.state = None
158         else:
159             self.cmdstate += 1
160
161     def handle_rdsr(self, mosi, miso):
162         # Read status register: Master asserts CS#, sends RDSR command,
163         # reads status register byte. If CS# is kept asserted, the status
164         # register can be read continuously / multiple times in a row.
165         # When done, the master de-asserts CS# again.
166         if self.cmdstate == 1:
167             # Byte 1: Master sends command ID.
168             self.putx([3, ['Command: %s' % cmds[self.state][1]]])
169         elif self.cmdstate >= 2:
170             # Bytes 2-x: Slave sends status register as long as master clocks.
171             self.putx([24, ['Status register: 0x%02x' % miso]])
172             self.putx([25, [decode_status_reg(miso)]])
173
174         self.cmdstate += 1
175
176     def handle_wrsr(self, mosi, miso):
177         pass # TODO
178
179     def handle_read(self, mosi, miso):
180         # Read data bytes: Master asserts CS#, sends READ command, sends
181         # 3-byte address, reads >= 1 data bytes, de-asserts CS#.
182         if self.cmdstate == 1:
183             # Byte 1: Master sends command ID.
184             self.putx([5, ['Command: %s' % cmds[self.state][1]]])
185         elif self.cmdstate in (2, 3, 4):
186             # Bytes 2/3/4: Master sends read address (24bits, MSB-first).
187             self.addr |= (mosi << ((4 - self.cmdstate) * 8))
188             # self.putx([0, ['Read address, byte %d: 0x%02x' % \
189             #                (4 - self.cmdstate, mosi)]])
190             if self.cmdstate == 4:
191                 self.putx([24, ['Read address: 0x%06x' % self.addr]])
192                 self.addr = 0
193         elif self.cmdstate >= 5:
194             # Bytes 5-x: Master reads data bytes (until CS# de-asserted).
195             if self.cmdstate == 5:
196                 self.ss_block = self.ss
197                 self.on_end_transaction = lambda: self.output_data_block('Read')
198             self.data.append(miso)
199
200         self.cmdstate += 1
201
202     def handle_fast_read(self, mosi, miso):
203         # Fast read: Master asserts CS#, sends FAST READ command, sends
204         # 3-byte address + 1 dummy byte, reads >= 1 data bytes, de-asserts CS#.
205         if self.cmdstate == 1:
206             # Byte 1: Master sends command ID.
207             self.putx([5, ['Command: %s' % cmds[self.state][1]]])
208         elif self.cmdstate in (2, 3, 4):
209             # Bytes 2/3/4: Master sends read address (24bits, MSB-first).
210             self.putx([24, ['AD%d: 0x%02x' % (self.cmdstate - 1, mosi)]])
211             if self.cmdstate == 2:
212                 self.ss_block = self.ss
213             self.addr |= (mosi << ((4 - self.cmdstate) * 8))
214         elif self.cmdstate == 5:
215             self.putx([24, ['Dummy byte: 0x%02x' % mosi]])
216             self.es_block = self.es
217             self.putb([5, ['Read address: 0x%06x' % self.addr]])
218             self.addr = 0
219         elif self.cmdstate >= 6:
220             # Bytes 6-x: Master reads data bytes (until CS# de-asserted).
221             if self.cmdstate == 6:
222                 self.ss_block = self.ss
223                 self.on_end_transaction = lambda: self.output_data_block('Read')
224             self.data.append(miso)
225
226         self.cmdstate += 1
227
228     def handle_2read(self, mosi, miso):
229         # Fast read dual I/O: Same as fast read, but all data
230         # after the command is sent via two I/O pins.
231         # MOSI = SIO0 = even bits, MISO = SIO1 = odd bits.
232         # Recombine the bytes and pass them up to the handle_fast_read command.
233         if self.cmdstate == 1:
234             # Byte 1: Master sends command ID.
235             self.putx([5, ['Command: %s' % cmds[self.state][1]]])
236             self.cmdstate = 2
237         else:
238             # Dual I/O mode.
239             a, b = decode_dual_bytes(mosi, miso)
240             # Pass same byte in as both MISO & MOSI, parser state determines
241             # which one it cares about.
242             self.handle_fast_read(a, a)
243             self.handle_fast_read(b, b)
244
245     # TODO: Warn/abort if we don't see the necessary amount of bytes.
246     # TODO: Warn if WREN was not seen before.
247     def handle_se(self, mosi, miso):
248         if self.cmdstate == 1:
249             # Byte 1: Master sends command ID.
250             self.addr = 0
251             self.ss_block = self.ss
252             self.putx([8, ['Command: %s' % cmds[self.state][1]]])
253         elif self.cmdstate in (2, 3, 4):
254             # Bytes 2/3/4: Master sends sector address (24bits, MSB-first).
255             self.addr |= (mosi << ((4 - self.cmdstate) * 8))
256             # self.putx([0, ['Sector address, byte %d: 0x%02x' % \
257             #                (4 - self.cmdstate, mosi)]])
258
259         if self.cmdstate == 4:
260             d = 'Erase sector %d (0x%06x)' % (self.addr, self.addr)
261             self.put(self.ss_block, self.es, self.out_ann, [24, [d]])
262             # TODO: Max. size depends on chip, check that too if possible.
263             if self.addr % 4096 != 0:
264                 # Sector addresses must be 4K-aligned (same for all 3 chips).
265                 d = 'Warning: Invalid sector address!'
266                 self.put(self.ss_block, self.es, self.out_ann, [101, [d]])
267             self.state = None
268         else:
269             self.cmdstate += 1
270
271     def handle_be(self, mosi, miso):
272         pass # TODO
273
274     def handle_ce(self, mosi, miso):
275         pass # TODO
276
277     def handle_ce2(self, mosi, miso):
278         pass # TODO
279
280     def handle_pp(self, mosi, miso):
281         # Page program: Master asserts CS#, sends PP command, sends 3-byte
282         # page address, sends >= 1 data bytes, de-asserts CS#.
283         if self.cmdstate == 1:
284             # Byte 1: Master sends command ID.
285             self.putx([12, ['Command: %s' % cmds[self.state][1]]])
286         elif self.cmdstate in (2, 3, 4):
287             # Bytes 2/3/4: Master sends page address (24bits, MSB-first).
288             self.addr |= (mosi << ((4 - self.cmdstate) * 8))
289             # self.putx([0, ['Page address, byte %d: 0x%02x' % \
290             #                (4 - self.cmdstate, mosi)]])
291             if self.cmdstate == 4:
292                 self.putx([24, ['Page address: 0x%06x' % self.addr]])
293                 self.addr = 0
294         elif self.cmdstate >= 5:
295             # Bytes 5-x: Master sends data bytes (until CS# de-asserted).
296             if self.cmdstate == 5:
297                 self.ss_block = self.ss
298                 self.on_end_transaction = lambda: self.output_data_block('Page data')
299             self.data.append(mosi)
300
301         self.cmdstate += 1
302
303     def handle_cp(self, mosi, miso):
304         pass # TODO
305
306     def handle_dp(self, mosi, miso):
307         pass # TODO
308
309     def handle_rdp_res(self, mosi, miso):
310         if self.cmdstate == 1:
311             # Byte 1: Master sends command ID.
312             self.ss_block = self.ss
313             self.putx([16, ['Command: %s' % cmds[self.state][1]]])
314         elif self.cmdstate in (2, 3, 4):
315             # Bytes 2/3/4: Master sends three dummy bytes.
316             self.putx([24, ['Dummy byte: %02x' % mosi]])
317         elif self.cmdstate == 5:
318             # Byte 5: Slave sends device ID.
319             self.device_id = miso
320             self.putx([24, ['Device: %s' % self.vendor_device()]])
321             self.state = None
322
323         self.cmdstate += 1
324
325     def handle_rems(self, mosi, miso):
326         if self.cmdstate == 1:
327             # Byte 1: Master sends command ID.
328             self.ss_block = self.ss
329             self.putx([16, ['Command: %s' % cmds[self.state][1]]])
330         elif self.cmdstate in (2, 3):
331             # Bytes 2/3: Master sends two dummy bytes.
332             # TODO: Check dummy bytes? Check reply from device?
333             self.putx([24, ['Dummy byte: %s' % mosi]])
334         elif self.cmdstate == 4:
335             # Byte 4: Master sends 0x00 or 0x01.
336             # 0x00: Master wants manufacturer ID as first reply byte.
337             # 0x01: Master wants device ID as first reply byte.
338             self.manufacturer_id_first = True if (mosi == 0x00) else False
339             d = 'manufacturer' if (mosi == 0x00) else 'device'
340             self.putx([24, ['Master wants %s ID first' % d]])
341         elif self.cmdstate == 5:
342             # Byte 5: Slave sends manufacturer ID (or device ID).
343             self.ids = [miso]
344             d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
345             self.putx([24, ['%s ID' % d]])
346         elif self.cmdstate == 6:
347             # Byte 6: Slave sends device ID (or manufacturer ID).
348             self.ids.append(miso)
349             d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
350             self.putx([24, ['%s ID' % d]])
351
352         if self.cmdstate == 6:
353             id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
354             self.device_id = id
355             self.putx([24, ['Device: %s' % self.vendor_device()]])
356             self.state = None
357         else:
358             self.cmdstate += 1
359
360     def handle_rems2(self, mosi, miso):
361         pass # TODO
362
363     def handle_enso(self, mosi, miso):
364         pass # TODO
365
366     def handle_exso(self, mosi, miso):
367         pass # TODO
368
369     def handle_rdscur(self, mosi, miso):
370         pass # TODO
371
372     def handle_wrscur(self, mosi, miso):
373         pass # TODO
374
375     def handle_esry(self, mosi, miso):
376         pass # TODO
377
378     def handle_dsry(self, mosi, miso):
379         pass # TODO
380
381     def output_data_block(self, label):
382         # Print accumulated block of data
383         # (called on CS# de-assert via self.on_end_transaction callback).
384         self.es_block = self.es # Ends on the CS# de-assert sample.
385         if self.options['format'] == 'hex':
386             s = ' '.join([('%02x' % b) for b in self.data])
387         else:
388             s = ''.join(map(chr, self.data))
389         self.putb([25, ['%s %d bytes: %s' % (label, len(self.data), s)]])
390
391     def decode(self, ss, es, data):
392         ptype, mosi, miso = data
393
394         self.ss, self.es = ss, es
395
396         if ptype == 'CS-CHANGE':
397             self.end_current_transaction()
398
399         if ptype != 'DATA':
400             return
401
402         # If we encountered a known chip command, enter the resp. state.
403         if self.state is None:
404             self.state = mosi
405             self.cmdstate = 1
406
407         # Handle commands.
408         try:
409             self.cmd_handlers[self.state](mosi, miso)
410         except KeyError:
411             self.putx([24, ['Unknown command: 0x%02x' % mosi]])
412             self.state = None