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