[libsigrokdecode.git] / decoders / mx25lxx05d.py

##
## This file is part of the sigrok project.
##
## Copyright (C) 2011 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 decoder.
# Works for MX25L1605D/MX25L3205D/MX25L6405D.
#

#
# TODO: Description
#
# Details:
# http://www.macronix.com/QuickPlace/hq/PageLibrary4825740B00298A3B.nsf/h_Index/3F21BAC2E121E17848257639003A3146/$File/MX25L1605D-3205D-6405D-1.5.pdf
#

import sigrok

# 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',
}

# FIXME: This is just some example input for testing purposes...

mosi_packets = [
    # REMS
    {'type': 'D',  'range': (100, 110), 'data': 0x90, 'ann': ''},
    {'type': 'D',  'range': (120, 130), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (170, 180), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (190, 200), 'data': 0x00, 'ann': ''},
    {'type': 'D',  'range': (400, 410), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (411, 421), 'data': 0xff, 'ann': ''},
    # RDID
    {'type': 'D',  'range': (10, 11), 'data': 0x9f, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    # SE
    {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x12, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x34, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x56, 'ann': ''},
    # SE
    {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x44, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x55, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x66, 'ann': ''},
    # WREN
    {'type': 'D',  'range': (10, 11), 'data': 0x06, 'ann': ''},
]

miso_packets = [
    # REMS
    {'type': 'D',  'range': (100, 110), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (120, 130), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (170, 180), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (190, 200), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (400, 410), 'data': 0xc2, 'ann': ''},
    {'type': 'D',  'range': (411, 421), 'data': 0x14, 'ann': ''},
    # RDID
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xc2, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x20, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0x15, 'ann': ''},
    # SE
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    # SE
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
    # WREN
    {'type': 'D',  'range': (10, 11), 'data': 0xff, 'ann': ''},
]

class Sample():
    def __init__(self, data):
        self.data = data
    def probe(self, probe):
        s = ord(self.data[probe / 8]) & (1 << (probe % 8))
        return True if s else False

def sampleiter(data, unitsize):
    for i in range(0, len(data), unitsize):
        yield(Sample(data[i:i+unitsize]))

class Decoder(sigrok.Decoder):
    id = 'mx25lxx05d'
    name = 'Macronix MX25Lxx05D'
    longname = 'Macronix MX25Lxx05D SPI flash chip decoder'
    desc = 'Macronix MX25Lxx05D SPI flash chip decoder'
    longdesc = 'TODO'
    author = 'Uwe Hermann'
    email = 'uwe@hermann-uwe.de'
    license = 'gplv2+'
    inputs = ['spi', 'spi', 'logic']
    outputs = ['mx25lxx05d']
    probes = {} # TODO: HOLD#, WP#/ACC
    options = {} # TODO

    def __init__(self, **kwargs):
        self.probes = Decoder.probes.copy()
        self.state = IDLE
        self.cmdstate = 1 # TODO
        self.out = []

    def start(self, metadata):
        self.unitsize = metadata['unitsize']

    def report(self):
        pass

    def handle_wren(self, miso_packet, mosi_packet):
        self.out += [{'type': self.cmd, 'range': mosi_packet['range'],
                      'data': None, 'ann': cmds[self.state]}]
        self.state = IDLE

    # TODO: Check/display device ID / name
    def handle_rdid(self, miso_packet, mosi_packet):
        ## self.state = IDLE
        ## return # FIXME

        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.start_sample = mosi_packet['range'][0]
            o = [] # TODO
        elif self.cmdstate == 2:
            # Byte 2: Slave sends the JEDEC manufacturer ID.
            o = [{'type': self.cmd, 'range': miso_packet['range'],
                  'data': miso_packet['data'], 'ann': 'Manufacturer ID'}]
        elif self.cmdstate == 3:
            # Byte 3: Slave sends the memory type (0x20 for this chip).
            o = [{'type': self.cmd, 'range': miso_packet['range'],
                  'data': miso_packet['data'], 'ann': 'Memory type'}]
        elif self.cmdstate == 4:
            # Byte 4: Slave sends the device ID.
            self.device_id = miso_packet['data']
            o = [{'type': self.cmd, 'range': miso_packet['range'],
                  'data': miso_packet['data'], 'ann': 'Device ID'}]

        if self.cmdstate == 4:
            # TODO: Check self.device_id is valid & exists in device_names.
            # TODO: Same device ID? Check!
            dev = 'Device: Macronix %s' % device_name[self.device_id]
            o += [{'type': 'RDID', # TODO: self.cmd?
                   'range': (self.start_sample, miso_packet['range'][1]),
                   'data': None, # TODO?
                   'ann': dev}]
            self.state = IDLE
        else:
            self.cmdstate += 1

        self.out += o

    # 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, miso_packet, mosi_packet):
        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.addr = 0
            self.start_sample = mosi_packet['range'][0]
            o = [{'type': self.cmd, 'range': mosi_packet['range'],
                  'data': self.cmd, 'ann': 'Command ID'}]
        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_packet['data']
            o = [] # TODO: Output 'Address byte 1' and such fields?

        if self.cmdstate == 4:
            o += [{'type': self.cmd,
                   'range': (self.start_sample, mosi_packet['range'][1]),
                   'data': '0x%x' % self.addr, 'ann': cmds[self.state]}]
            # 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).
                o += [{'type': self.cmd, # TODO: Type == 'Warning' or such?
                       'range': (self.start_sample, mosi_packet['range'][1]),
                       'data': None, 'ann': 'Warning: Invalid sector address!'}]
            self.state = IDLE
        else:
            self.cmdstate += 1

        self.out += o

    def handle_rems(self, miso_packet, mosi_packet):
        if self.cmdstate == 1:
            # Byte 1: Master sends command ID.
            self.start_sample = mosi_packet['range'][0]
            o = [{'type': self.cmd, 'range': mosi_packet['range'],
                  'data': self.cmd, 'ann': 'Command ID'}]
        elif self.cmdstate in (2, 3):
            # Bytes 2/3: Master sends two dummy bytes.
            # TODO: Check dummy bytes? Check reply from device?
            o = [{'type': self.cmd, 'range': mosi_packet['range'],
                  'data': mosi_packet['data'], 'ann': 'Dummy byte'}]
        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.
            b = mosi_packet['data']
            self.manufacturer_id_first = True if (b == 0x00) else False
            d = 'manufacturer' if (b == 0x00) else 'device'
            o = [{'type': self.cmd, 'range': mosi_packet['range'],
                  'data': b, 'ann': '%s (%s ID first)' % (cmds[self.cmd], d)}]
        elif self.cmdstate == 5:
            # Byte 5: Slave sends manufacturer ID (or device ID).
            self.ids = [miso_packet['data']]
            o = []
        elif self.cmdstate in (5, 6):
            # Byte 6: Slave sends device ID (or manufacturer ID).
            self.ids += [miso_packet['data']]
            ann = 'Manufacturer' if self.manufacturer_id_first else 'Device'
            o = [{'type': self.cmd, 'range': miso_packet['range'],
                  'data': '0x%02x' % self.ids[0], 'ann': ann}]
            ann = 'Device' if self.manufacturer_id_first else 'Manufacturer'
            o += [{'type': self.cmd, 'range': miso_packet['range'],
                   'data': '0x%02x' % self.ids[1], 'ann': '%s ID' % ann}]
        else:
            # TODO: Error?
            pass

        if self.cmdstate == 6:
            self.end_sample = miso_packet['range'][1]
            id = self.ids[1] if self.manufacturer_id_first else self.ids[0]
            dev = 'Device: Macronix %s' % device_name[id]
            o += [{'type': self.cmd,
                   'range': (self.start_sample, self.end_sample),
                   'data': None, # TODO: Both IDs? Which format?
                   'ann': dev}]
            self.state = IDLE
        else:
            self.cmdstate += 1

        self.out += o

    def decode(self, data):
        self.out = []

        # Iterate over all SPI MISO/MOSI packets. TODO: HOLD#, WP#/ACC?
        for i in xrange(len(miso_packets)):

            p_miso = miso_packets[i]
            p_mosi = mosi_packets[i]

            # Assumption: Every p_miso has a p_mosi entry with same range.

            # For now, skip non-data packets.
            if p_mosi['type'] != 'D':
                continue

            cmd = p_mosi['data']

            # 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(p_miso, p_mosi)
            elif self.state == CMD_SE:
                self.handle_se(p_miso, p_mosi)
            elif self.state == CMD_RDID:
                self.handle_rdid(p_miso, p_mosi)
            if self.state == CMD_REMS:
                self.handle_rems(p_miso, p_mosi)
            else:
                pass

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