]>
Commit | Line | Data |
---|---|---|
1b1c914f UH |
1 | ## |
2 | ## This file is part of the sigrok project. | |
3 | ## | |
9b4d8a57 | 4 | ## Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de> |
1b1c914f UH |
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 | ||
156509ca | 21 | # Macronix MX25Lxx05D SPI (NOR) flash chip protocol decoder |
1b1c914f | 22 | |
156509ca | 23 | # Note: Works for MX25L1605D/MX25L3205D/MX25L6405D. |
1b1c914f | 24 | |
677d597b | 25 | import sigrokdecode as srd |
1b1c914f UH |
26 | |
27 | # States | |
28 | IDLE = -1 | |
29 | ||
30 | # Chip commands (also used as additional decoder states). | |
31 | CMD_WREN = 0x06 | |
32 | CMD_WRDI = 0x04 | |
33 | CMD_RDID = 0x9f | |
34 | CMD_RDSR = 0x05 | |
35 | CMD_WRSR = 0x01 | |
36 | CMD_READ = 0x03 | |
37 | CMD_FAST_READ = 0x0b | |
38 | CMD_2READ = 0xbb | |
39 | CMD_SE = 0x20 | |
40 | CMD_BE = 0xd8 | |
41 | CMD_CE = 0x60 | |
42 | CMD_CE2 = 0xc7 | |
43 | CMD_PP = 0x02 | |
44 | CMD_CP = 0xad | |
45 | CMD_DP = 0xb9 | |
46 | # CMD_RDP = 0xab | |
47 | # CMD_RES = 0xab | |
48 | CMD_RDP_RES = 0xab # Note: RDP/RES have the same ID. | |
49 | CMD_REMS = 0x90 | |
50 | CMD_REMS2 = 0xef | |
51 | CMD_ENSO = 0xb1 | |
52 | CMD_EXSO = 0xc1 | |
53 | CMD_RDSCUR = 0x2b | |
54 | CMD_WRSCUR = 0x2f | |
55 | CMD_ESRY = 0x70 | |
56 | CMD_DSRY = 0x80 | |
57 | ||
58 | # TODO: (Short) command names as strings in a dict, too? | |
59 | ||
60 | # Dict which maps command IDs to their description. | |
61 | cmds = { | |
62 | CMD_WREN: 'Write enable', | |
63 | CMD_WRDI: 'Write disable', | |
64 | CMD_RDID: 'Read identification', | |
65 | CMD_RDSR: 'Read status register', | |
66 | CMD_WRSR: 'Write status register', | |
67 | CMD_READ: 'Read data', | |
68 | CMD_FAST_READ: 'Fast read data', | |
69 | CMD_2READ: '2x I/O read', | |
70 | CMD_SE: 'Sector erase', | |
71 | CMD_BE: 'Block erase', | |
72 | CMD_CE: 'Chip erase', | |
73 | CMD_CE2: 'Chip erase', # Alternative command ID | |
74 | CMD_PP: 'Page program', | |
75 | CMD_CP: 'Continuously program mode', | |
76 | CMD_DP: 'Deep power down', | |
77 | # CMD_RDP: 'Release from deep powerdown', | |
78 | # CMD_RES: 'Read electronic ID', | |
79 | CMD_RDP_RES: 'Release from deep powerdown / Read electronic ID', | |
80 | CMD_REMS: 'Read electronic manufacturer & device ID', | |
81 | CMD_REMS2: 'Read ID for 2x I/O mode', | |
82 | CMD_ENSO: 'Enter secured OTP', | |
83 | CMD_EXSO: 'Exit secured OTP', | |
84 | CMD_RDSCUR: 'Read security register', | |
85 | CMD_WRSCUR: 'Write security register', | |
86 | CMD_ESRY: 'Enable SO to output RY/BY#', | |
87 | CMD_DSRY: 'Disable SO to output RY/BY#', | |
88 | } | |
89 | ||
90 | device_name = { | |
91 | 0x14: 'MX25L1605D', | |
92 | 0x15: 'MX25L3205D', | |
93 | 0x16: 'MX25L6405D', | |
94 | } | |
95 | ||
7cfbf663 UH |
96 | def decode_status_reg(data): |
97 | # TODO: Additional per-bit(s) self.put() calls with correct start/end. | |
98 | ||
99 | # Bits[0:0]: WIP (write in progress) | |
100 | s = 'W' if (data & (1 << 0)) else 'No w' | |
101 | ret = '%srite operation in progress.\n' % s | |
102 | ||
103 | # Bits[1:1]: WEL (write enable latch) | |
104 | s = '' if (data & (1 << 1)) else 'not ' | |
105 | ret += 'Internal write enable latch is %sset.\n' % s | |
106 | ||
107 | # Bits[5:2]: Block protect bits | |
108 | # TODO: More detailed decoding (chip-dependent). | |
109 | ret += 'Block protection bits (BP3-BP0): 0x%x.\n' % ((data & 0x3c) >> 2) | |
110 | ||
111 | # Bits[6:6]: Continuously program mode (CP mode) | |
112 | s = '' if (data & (1 << 6)) else 'not ' | |
113 | ret += 'Device is %sin continuously program mode (CP mode).\n' % s | |
114 | ||
115 | # Bits[7:7]: SRWD (status register write disable) | |
116 | s = '' if (data & (1 << 7)) else 'not ' | |
117 | ret += 'Status register writes are %sallowed.\n' % s | |
118 | ||
119 | return ret | |
120 | ||
677d597b | 121 | class Decoder(srd.Decoder): |
a2c2afd9 | 122 | api_version = 1 |
1b1c914f | 123 | id = 'mx25lxx05d' |
9a12a6e7 | 124 | name = 'MX25Lxx05D' |
3d3da57d | 125 | longname = 'Macronix MX25Lxx05D' |
a465436e | 126 | desc = 'SPI (NOR) flash chip protocol.' |
1b1c914f | 127 | license = 'gplv2+' |
385508e9 | 128 | inputs = ['spi', 'logic'] |
1b1c914f | 129 | outputs = ['mx25lxx05d'] |
385508e9 | 130 | probes = [] |
b77614bc | 131 | optional_probes = [ |
385508e9 UH |
132 | {'id': 'hold', 'name': 'HOLD#', 'desc': 'TODO.'}, |
133 | {'id': 'wp_acc', 'name': 'WP#/ACC', 'desc': 'TODO.'}, | |
134 | ] | |
1b1c914f | 135 | options = {} # TODO |
9b4d8a57 | 136 | annotations = [ |
ee3e279c | 137 | ['Text', 'Human-readable text'], |
9b4d8a57 | 138 | ] |
1b1c914f UH |
139 | |
140 | def __init__(self, **kwargs): | |
1b1c914f UH |
141 | self.state = IDLE |
142 | self.cmdstate = 1 # TODO | |
e4022299 UH |
143 | self.addr = 0 |
144 | self.data = [] | |
1b1c914f UH |
145 | |
146 | def start(self, metadata): | |
56202222 UH |
147 | # self.out_proto = self.add(srd.OUTPUT_PROTO, 'mx25lxx05d') |
148 | self.out_ann = self.add(srd.OUTPUT_ANN, 'mx25lxx05d') | |
1b1c914f UH |
149 | |
150 | def report(self): | |
151 | pass | |
152 | ||
385508e9 | 153 | def putx(self, data): |
ee3e279c | 154 | # Simplification, most annotations span exactly one SPI byte/packet. |
9b4d8a57 UH |
155 | self.put(self.ss, self.es, self.out_ann, data) |
156 | ||
157 | def handle_wren(self, mosi, miso): | |
385508e9 | 158 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) |
1b1c914f UH |
159 | self.state = IDLE |
160 | ||
161 | # TODO: Check/display device ID / name | |
9b4d8a57 | 162 | def handle_rdid(self, mosi, miso): |
1b1c914f UH |
163 | if self.cmdstate == 1: |
164 | # Byte 1: Master sends command ID. | |
9b4d8a57 | 165 | self.start_sample = self.ss |
385508e9 | 166 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) |
1b1c914f UH |
167 | elif self.cmdstate == 2: |
168 | # Byte 2: Slave sends the JEDEC manufacturer ID. | |
385508e9 | 169 | self.putx([0, ['Manufacturer ID: 0x%02x' % miso]]) |
1b1c914f UH |
170 | elif self.cmdstate == 3: |
171 | # Byte 3: Slave sends the memory type (0x20 for this chip). | |
385508e9 | 172 | self.putx([0, ['Memory type: 0x%02x' % miso]]) |
1b1c914f UH |
173 | elif self.cmdstate == 4: |
174 | # Byte 4: Slave sends the device ID. | |
9b4d8a57 | 175 | self.device_id = miso |
385508e9 | 176 | self.putx([0, ['Device ID: 0x%02x' % miso]]) |
1b1c914f UH |
177 | |
178 | if self.cmdstate == 4: | |
179 | # TODO: Check self.device_id is valid & exists in device_names. | |
180 | # TODO: Same device ID? Check! | |
9b4d8a57 UH |
181 | d = 'Device: Macronix %s' % device_name[self.device_id] |
182 | self.put(self.start_sample, self.es, self.out_ann, [0, [d]]) | |
1b1c914f UH |
183 | self.state = IDLE |
184 | else: | |
185 | self.cmdstate += 1 | |
186 | ||
1b1c914f UH |
187 | # TODO: Warn/abort if we don't see the necessary amount of bytes. |
188 | # TODO: Warn if WREN was not seen before. | |
9b4d8a57 | 189 | def handle_se(self, mosi, miso): |
1b1c914f UH |
190 | if self.cmdstate == 1: |
191 | # Byte 1: Master sends command ID. | |
192 | self.addr = 0 | |
9b4d8a57 | 193 | self.start_sample = self.ss |
385508e9 | 194 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) |
1b1c914f | 195 | elif self.cmdstate in (2, 3, 4): |
87e574b7 UH |
196 | # Bytes 2/3/4: Master sends sectror address (24bits, MSB-first). |
197 | self.addr |= (mosi << ((4 - self.cmdstate) * 8)) | |
198 | # self.putx([0, ['Sector address, byte %d: 0x%02x' % \ | |
199 | # (4 - self.cmdstate, mosi)]]) | |
1b1c914f UH |
200 | |
201 | if self.cmdstate == 4: | |
87e574b7 | 202 | d = 'Erase sector %d (0x%06x)' % (self.addr, self.addr) |
9b4d8a57 | 203 | self.put(self.start_sample, self.es, self.out_ann, [0, [d]]) |
1b1c914f UH |
204 | # TODO: Max. size depends on chip, check that too if possible. |
205 | if self.addr % 4096 != 0: | |
206 | # Sector addresses must be 4K-aligned (same for all 3 chips). | |
9b4d8a57 UH |
207 | d = 'Warning: Invalid sector address!' # TODO: type == WARN? |
208 | self.put(self.start_sample, self.es, self.out_ann, [0, [d]]) | |
1b1c914f UH |
209 | self.state = IDLE |
210 | else: | |
211 | self.cmdstate += 1 | |
212 | ||
9b4d8a57 | 213 | def handle_rems(self, mosi, miso): |
1b1c914f UH |
214 | if self.cmdstate == 1: |
215 | # Byte 1: Master sends command ID. | |
9b4d8a57 | 216 | self.start_sample = self.ss |
385508e9 | 217 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) |
1b1c914f UH |
218 | elif self.cmdstate in (2, 3): |
219 | # Bytes 2/3: Master sends two dummy bytes. | |
220 | # TODO: Check dummy bytes? Check reply from device? | |
385508e9 | 221 | self.putx([0, ['Dummy byte: %s' % mosi]]) |
1b1c914f UH |
222 | elif self.cmdstate == 4: |
223 | # Byte 4: Master sends 0x00 or 0x01. | |
224 | # 0x00: Master wants manufacturer ID as first reply byte. | |
225 | # 0x01: Master wants device ID as first reply byte. | |
9b4d8a57 UH |
226 | self.manufacturer_id_first = True if (mosi == 0x00) else False |
227 | d = 'manufacturer' if (mosi == 0x00) else 'device' | |
385508e9 | 228 | self.putx([0, ['Master wants %s ID first' % d]]) |
1b1c914f UH |
229 | elif self.cmdstate == 5: |
230 | # Byte 5: Slave sends manufacturer ID (or device ID). | |
9b4d8a57 UH |
231 | self.ids = [miso] |
232 | d = 'Manufacturer' if self.manufacturer_id_first else 'Device' | |
385508e9 | 233 | self.putx([0, ['%s ID' % d]]) |
9b4d8a57 | 234 | elif self.cmdstate == 6: |
1b1c914f | 235 | # Byte 6: Slave sends device ID (or manufacturer ID). |
7f7ea759 | 236 | self.ids.append(miso) |
9b4d8a57 | 237 | d = 'Manufacturer' if self.manufacturer_id_first else 'Device' |
385508e9 | 238 | self.putx([0, ['%s ID' % d]]) |
1b1c914f UH |
239 | else: |
240 | # TODO: Error? | |
241 | pass | |
242 | ||
243 | if self.cmdstate == 6: | |
9b4d8a57 | 244 | self.end_sample = self.es |
1b1c914f | 245 | id = self.ids[1] if self.manufacturer_id_first else self.ids[0] |
385508e9 | 246 | self.putx([0, ['Device: Macronix %s' % device_name[id]]]) |
1b1c914f UH |
247 | self.state = IDLE |
248 | else: | |
249 | self.cmdstate += 1 | |
250 | ||
9b4d8a57 | 251 | def handle_rdsr(self, mosi, miso): |
e4022299 UH |
252 | # Read status register: Master asserts CS#, sends RDSR command, |
253 | # reads status register byte. If CS# is kept asserted, the status | |
254 | # register can be read continuously / multiple times in a row. | |
255 | # When done, the master de-asserts CS# again. | |
256 | if self.cmdstate == 1: | |
257 | # Byte 1: Master sends command ID. | |
258 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) | |
259 | elif self.cmdstate >= 2: | |
260 | # Bytes 2-x: Slave sends status register as long as master clocks. | |
261 | if self.cmdstate <= 3: # TODO: While CS# asserted. | |
262 | self.putx([0, ['Status register: 0x%02x' % miso]]) | |
7cfbf663 | 263 | self.putx([0, [decode_status_reg(miso)]]) |
e4022299 UH |
264 | |
265 | if self.cmdstate == 3: # TODO: If CS# got de-asserted. | |
266 | self.state = IDLE | |
267 | return | |
268 | ||
269 | self.cmdstate += 1 | |
270 | ||
271 | def handle_pp(self, mosi, miso): | |
272 | # Page program: Master asserts CS#, sends PP command, sends 3-byte | |
273 | # page address, sends >= 1 data bytes, de-asserts CS#. | |
274 | if self.cmdstate == 1: | |
275 | # Byte 1: Master sends command ID. | |
276 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) | |
277 | elif self.cmdstate in (2, 3, 4): | |
278 | # Bytes 2/3/4: Master sends page address (24bits, MSB-first). | |
279 | self.addr |= (mosi << ((4 - self.cmdstate) * 8)) | |
280 | # self.putx([0, ['Page address, byte %d: 0x%02x' % \ | |
281 | # (4 - self.cmdstate, mosi)]]) | |
282 | if self.cmdstate == 4: | |
283 | self.putx([0, ['Page address: 0x%06x' % self.addr]]) | |
284 | self.addr = 0 | |
285 | elif self.cmdstate >= 5: | |
286 | # Bytes 5-x: Master sends data bytes (until CS# de-asserted). | |
287 | # TODO: For now we hardcode 256 bytes per page / PP command. | |
288 | if self.cmdstate <= 256 + 4: # TODO: While CS# asserted. | |
289 | self.data.append(mosi) | |
290 | # self.putx([0, ['New data byte: 0x%02x' % mosi]]) | |
291 | ||
292 | if self.cmdstate == 256 + 4: # TODO: If CS# got de-asserted. | |
293 | # s = ', '.join(map(hex, self.data)) | |
294 | s = ''.join(map(chr, self.data)) | |
295 | self.putx([0, ['Page data: %s' % s]]) | |
296 | self.data = [] | |
297 | self.state = IDLE | |
298 | return | |
299 | ||
300 | self.cmdstate += 1 | |
1b1c914f | 301 | |
5ebb76fe UH |
302 | def handle_read(self, mosi, miso): |
303 | # Read data bytes: Master asserts CS#, sends READ command, sends | |
304 | # 3-byte address, reads >= 1 data bytes, de-asserts CS#. | |
305 | if self.cmdstate == 1: | |
306 | # Byte 1: Master sends command ID. | |
307 | self.putx([0, ['Command: %s' % cmds[self.cmd]]]) | |
308 | elif self.cmdstate in (2, 3, 4): | |
309 | # Bytes 2/3/4: Master sends read address (24bits, MSB-first). | |
310 | self.addr |= (mosi << ((4 - self.cmdstate) * 8)) | |
311 | # self.putx([0, ['Read address, byte %d: 0x%02x' % \ | |
312 | # (4 - self.cmdstate, mosi)]]) | |
313 | if self.cmdstate == 4: | |
314 | self.putx([0, ['Read address: 0x%06x' % self.addr]]) | |
315 | self.addr = 0 | |
316 | elif self.cmdstate >= 5: | |
317 | # Bytes 5-x: Master reads data bytes (until CS# de-asserted). | |
318 | # TODO: For now we hardcode 256 bytes per READ command. | |
319 | if self.cmdstate <= 256 + 4: # TODO: While CS# asserted. | |
320 | self.data.append(miso) | |
321 | # self.putx([0, ['New read byte: 0x%02x' % miso]]) | |
322 | ||
323 | if self.cmdstate == 256 + 4: # TODO: If CS# got de-asserted. | |
324 | # s = ', '.join(map(hex, self.data)) | |
325 | s = ''.join(map(chr, self.data)) | |
326 | self.putx([0, ['Read data: %s' % s]]) | |
327 | self.data = [] | |
328 | self.state = IDLE | |
329 | return | |
330 | ||
331 | self.cmdstate += 1 | |
332 | ||
2b9837d9 | 333 | def decode(self, ss, es, data): |
1b1c914f | 334 | |
9b4d8a57 | 335 | ptype, mosi, miso = data |
1b1c914f | 336 | |
e4022299 UH |
337 | # if ptype == 'DATA': |
338 | # s = 'MOSI: 0x%02x, MISO: 0x%02x' % (mosi, miso) | |
339 | # self.put(0, 0, self.out_ann, [0, [s]]) | |
340 | # pass | |
341 | ||
342 | # if ptype == 'CS-CHANGE': | |
343 | # if mosi == 1 and miso == 0: | |
344 | # self.put(0, 0, self.out_ann, [0, ['Asserting CS#']]) | |
345 | # elif mosi == 0 and miso == 1: | |
346 | # self.put(0, 0, self.out_ann, [0, ['De-asserting CS#']]) | |
347 | # return | |
348 | ||
3e3c0330 | 349 | if ptype != 'DATA': |
9b4d8a57 | 350 | return |
1b1c914f | 351 | |
9b4d8a57 | 352 | cmd = mosi |
e4022299 | 353 | self.ss, self.es = ss, es |
1b1c914f | 354 | |
9b4d8a57 UH |
355 | # If we encountered a known chip command, enter the resp. state. |
356 | if self.state == IDLE: | |
357 | if cmd in cmds: | |
358 | self.state = cmd | |
359 | self.cmd = cmd # TODO: Eliminate? | |
360 | self.cmdstate = 1 | |
1b1c914f | 361 | else: |
9b4d8a57 | 362 | pass # TODO |
1b1c914f | 363 | |
9b4d8a57 UH |
364 | # Handle commands. |
365 | # TODO: Use some generic way to invoke the resp. method. | |
366 | if self.state == CMD_WREN: | |
367 | self.handle_wren(mosi, miso) | |
368 | elif self.state == CMD_SE: | |
369 | self.handle_se(mosi, miso) | |
370 | elif self.state == CMD_RDID: | |
371 | self.handle_rdid(mosi, miso) | |
e4022299 | 372 | elif self.state == CMD_REMS: |
9b4d8a57 | 373 | self.handle_rems(mosi, miso) |
e4022299 | 374 | elif self.state == CMD_RDSR: |
9b4d8a57 | 375 | self.handle_rdsr(mosi, miso) |
e4022299 UH |
376 | elif self.state == CMD_PP: |
377 | self.handle_pp(mosi, miso) | |
5ebb76fe UH |
378 | elif self.state == CMD_READ: |
379 | self.handle_read(mosi, miso) | |
9b4d8a57 UH |
380 | else: |
381 | self.put(0, 0, self.out_ann, [0, ['Unknown command: 0x%02x' % cmd]]) | |
382 | self.state = IDLE | |
1b1c914f | 383 |