[libsigrokdecode.git] / decoders / mx25lxx05d / mx25lxx05d.py

##
## This file is part of the sigrok project.
##
## Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

# Macronix MX25Lxx05D SPI (NOR) flash chip protocol decoder

# Note: Works for MX25L1605D/MX25L3205D/MX25L6405D.

import sigrokdecode as srd

# States
IDLE = -1

# Chip commands (also used as additional decoder states).
CMD_WREN      = 0x06
CMD_WRDI      = 0x04
CMD_RDID      = 0x9f
CMD_RDSR      = 0x05
CMD_WRSR      = 0x01
CMD_READ      = 0x03
CMD_FAST_READ = 0x0b
CMD_2READ     = 0xbb
CMD_SE        = 0x20
CMD_BE        = 0xd8
CMD_CE        = 0x60
CMD_CE2       = 0xc7
CMD_PP        = 0x02
CMD_CP        = 0xad
CMD_DP        = 0xb9
# CMD_RDP       = 0xab
# CMD_RES       = 0xab
CMD_RDP_RES   = 0xab # Note: RDP/RES have the same ID.
CMD_REMS      = 0x90
CMD_REMS2     = 0xef
CMD_ENSO      = 0xb1
CMD_EXSO      = 0xc1
CMD_RDSCUR    = 0x2b
CMD_WRSCUR    = 0x2f
CMD_ESRY      = 0x70
CMD_DSRY      = 0x80

# TODO: (Short) command names as strings in a dict, too?

# Dict which maps command IDs to their description.
cmds = {
    CMD_WREN: 'Write enable',
    CMD_WRDI: 'Write disable',
    CMD_RDID: 'Read identification',
    CMD_RDSR: 'Read status register',
    CMD_WRSR: 'Write status register',
    CMD_READ: 'Read data',
    CMD_FAST_READ: 'Fast read data',
    CMD_2READ: '2x I/O read',
    CMD_SE: 'Sector erase',
    CMD_BE: 'Block erase',
    CMD_CE: 'Chip erase',
    CMD_CE2: 'Chip erase', # Alternative command ID
    CMD_PP: 'Page program',
    CMD_CP: 'Continuously program mode',
    CMD_DP: 'Deep power down',
    # CMD_RDP: 'Release from deep powerdown',
    # CMD_RES: 'Read electronic ID',
    CMD_RDP_RES: 'Release from deep powerdown / Read electronic ID',
    CMD_REMS: 'Read electronic manufacturer & device ID',
    CMD_REMS2: 'Read ID for 2x I/O mode',
    CMD_ENSO: 'Enter secured OTP',
    CMD_EXSO: 'Exit secured OTP',
    CMD_RDSCUR: 'Read security register',
    CMD_WRSCUR: 'Write security register',
    CMD_ESRY: 'Enable SO to output RY/BY#',
    CMD_DSRY: 'Disable SO to output RY/BY#',
}

device_name = {
    0x14: 'MX25L1605D',
    0x15: 'MX25L3205D',
    0x16: 'MX25L6405D',
}

class Decoder(srd.Decoder):
    api_version = 1
    id = 'mx25lxx05d'
    name = 'MX25Lxx05D'
    longname = 'Macronix MX25Lxx05D'
    desc = 'Macronix MX25Lxx05D SPI flash chip decoder'
    longdesc = 'TODO'
    license = 'gplv2+'
    inputs = ['spi', 'logic']
    outputs = ['mx25lxx05d']
    probes = []
    optional_probes = [
        {'id': 'hold', 'name': 'HOLD#', 'desc': 'TODO.'},
        {'id': 'wp_acc', 'name': 'WP#/ACC', 'desc': 'TODO.'},
    ]
    options = {} # TODO
    annotations = [
        ['TODO', 'TODO'],
    ]

    def __init__(self, **kwargs):
        self.state = IDLE
        self.cmdstate = 1 # TODO

    def start(self, metadata):
        # self.out_proto = self.add(srd.OUTPUT_PROTO, 'mx25lxx05d')
        self.out_ann = self.add(srd.OUTPUT_ANN, 'mx25lxx05d')

    def report(self):
        pass

    def putx(self, data):
        # Simplification, most annotations span extactly one SPI byte/packet.
        self.put(self.ss, self.es, self.out_ann, data)

    def handle_wren(self, mosi, miso):
        self.putx([0, ['Command: %s' % cmds[self.cmd]]])
        self.state = IDLE

    # TODO: Check/display device ID / name
    def handle_rdid(self, mosi, miso):
        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.start_sample = self.ss
            self.putx([0, ['Command: %s' % cmds[self.cmd]]])
        elif self.cmdstate == 2:
            # Byte 2: Slave sends the JEDEC manufacturer ID.
            self.putx([0, ['Manufacturer ID: 0x%02x' % miso]])
        elif self.cmdstate == 3:
            # Byte 3: Slave sends the memory type (0x20 for this chip).
            self.putx([0, ['Memory type: 0x%02x' % miso]])
        elif self.cmdstate == 4:
            # Byte 4: Slave sends the device ID.
            self.device_id = miso
            self.putx([0, ['Device ID: 0x%02x' % miso]])

        if self.cmdstate == 4:
            # TODO: Check self.device_id is valid & exists in device_names.
            # TODO: Same device ID? Check!
            d = 'Device: Macronix %s' % device_name[self.device_id]
            self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
            self.state = IDLE
        else:
            self.cmdstate += 1

    # TODO: Warn/abort if we don't see the necessary amount of bytes.
    # TODO: Warn if WREN was not seen before.
    def handle_se(self, mosi, miso):
        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.addr = 0
            self.start_sample = self.ss
            self.putx([0, ['Command: %s' % cmds[self.cmd]]])
        elif self.cmdstate in (2, 3, 4):
            # Bytes 2/3/4: Master sends address of the sector to erase.
            # Note: Assumes SPI data is 8 bits wide (it is for MX25Lxx05D).
            # TODO: LSB-first of MSB-first?
            self.addr <<= 8
            self.addr |= mosi
            self.putx([0, ['Address byte %d: 0x%02x' % (self.cmdstate - 1,
                        miso)]]) # TODO: Count from 0 or 1?

        if self.cmdstate == 4:
            d = 'Erase sector %d' % self.addr
            self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
            # TODO: Max. size depends on chip, check that too if possible.
            if self.addr % 4096 != 0:
                # Sector addresses must be 4K-aligned (same for all 3 chips).
                d = 'Warning: Invalid sector address!' # TODO: type == WARN?
                self.put(self.start_sample, self.es, self.out_ann, [0, [d]])
            self.state = IDLE
        else:
            self.cmdstate += 1

    def handle_rems(self, mosi, miso):
        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.start_sample = self.ss
            self.putx([0, ['Command: %s' % cmds[self.cmd]]])
        elif self.cmdstate in (2, 3):
            # Bytes 2/3: Master sends two dummy bytes.
            # TODO: Check dummy bytes? Check reply from device?
            self.putx([0, ['Dummy byte: %s' % mosi]])
        elif self.cmdstate == 4:
            # Byte 4: Master sends 0x00 or 0x01.
            # 0x00: Master wants manufacturer ID as first reply byte.
            # 0x01: Master wants device ID as first reply byte.
            self.manufacturer_id_first = True if (mosi == 0x00) else False
            d = 'manufacturer' if (mosi == 0x00) else 'device'
            self.putx([0, ['Master wants %s ID first' % d]])
        elif self.cmdstate == 5:
            # Byte 5: Slave sends manufacturer ID (or device ID).
            self.ids = [miso]
            d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
            self.putx([0, ['%s ID' % d]])
        elif self.cmdstate == 6:
            # Byte 6: Slave sends device ID (or manufacturer ID).
            self.ids.append(miso)
            d = 'Manufacturer' if self.manufacturer_id_first else 'Device'
            self.putx([0, ['%s ID' % d]])
        else:
            # TODO: Error?
            pass

        if self.cmdstate == 6:
            self.end_sample = self.es
            id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
            self.putx([0, ['Device: Macronix %s' % device_name[id]]])
            self.state = IDLE
        else:
            self.cmdstate += 1

    def handle_rdsr(self, mosi, miso):
        self.putx([0, ['Command: %s (0x%02x)' % (cmds[self.cmd], miso)]])
        self.state = IDLE

    def decode(self, ss, es, data):

        ptype, mosi, miso = data

        if ptype != 'data':
            return

        cmd = mosi
        self.ss = ss
        self.es = es

        # If we encountered a known chip command, enter the resp. state.
        if self.state == IDLE:
            if cmd in cmds:
                self.state = cmd
                self.cmd = cmd # TODO: Eliminate?
                self.cmdstate = 1
            else:
                pass # TODO

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