[libsigrokdecode.git] / decoders / avr_isp / pd.py

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012-2014 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
##

import sigrokdecode as srd
from .parts import *

VENDOR_CODE_ATMEL = 0x1e

class Decoder(srd.Decoder):
    api_version = 1
    id = 'avr_isp'
    name = 'AVR ISP'
    longname = 'AVR In-System Programming'
    desc = 'Protocol for in-system programming Atmel AVR MCUs.'
    license = 'gplv2+'
    inputs = ['spi', 'logic']
    outputs = ['avr_isp']
    optional_probes = (
        {'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'},
    )
    annotations = (
        ('pe', 'Programming enable'),
        ('rsb0', 'Read signature byte 0'),
        ('rsb1', 'Read signature byte 1'),
        ('rsb2', 'Read signature byte 2'),
        ('ce', 'Chip erase'),
        ('rfb', 'Read fuse bits'),
        ('rhfb', 'Read high fuse bits'),
        ('refb', 'Read extended fuse bits'),
        ('warnings', 'Warnings'),
        ('dev', 'Device'),
    )
    annotation_rows = (
        ('bits', 'Bits', ()),
        ('commands', 'Commands', tuple(range(7 + 1))),
        ('warnings', 'Warnings', (8,)),
        ('dev', 'Device', (9,)),
    )

    def __init__(self, **kwargs):
        self.state = 'IDLE'
        self.mosi_bytes, self.miso_bytes = [], []
        self.cmd_ss, self.cmd_es = 0, 0
        self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
        self.device_ss = None

    def start(self):
        # self.out_python = self.register(srd.OUTPUT_PYTHON)
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def putx(self, data):
        self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)

    def handle_cmd_programming_enable(self, cmd, ret):
        # Programming enable.
        # Note: The chip doesn't send any ACK for 'Programming enable'.
        self.putx([0, ['Programming enable']])

        # Sanity check on reply.
        if ret[1:4] != [0xac, 0x53, cmd[2]]:
            self.putx([8, ['Warning: Unexpected bytes in reply!']])

    def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
        # Signature byte 0x00: vendor code.
        self.vendor_code = ret[3]
        v = vendor_code[self.vendor_code]
        self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])

        # Store for later.
        self.xx = cmd[1] # Same as ret[2].
        self.yy = cmd[3]
        self.zz = ret[0]

        # Sanity check on reply.
        if ret[1] != 0x30 or ret[2] != cmd[1]:
            self.putx([8, ['Warning: Unexpected bytes in reply!']])

        # Sanity check for the vendor code.
        if self.vendor_code != VENDOR_CODE_ATMEL:
            self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])

    def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
        # Signature byte 0x01: part family and memory size.
        self.part_fam_flash_size = ret[3]
        self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])

        # Store for later.
        self.mm = cmd[3]
        self.device_ss = self.cmd_ss

        # Sanity check on reply.
        if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
            self.putx([8, ['Warning: Unexpected bytes in reply!']])

    def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
        # Signature byte 0x02: part number.
        self.part_number = ret[3]
        self.putx([3, ['Part number: 0x%02x' % ret[3]]])

        p = part[(self.part_fam_flash_size, self.part_number)]
        data = [9, ['Device: Atmel %s' % p]]
        self.put(self.device_ss, self.cmd_es, self.out_ann, data)

        # Sanity check on reply.
        if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
            self.putx([8, ['Warning: Unexpected bytes in reply!']])

        self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0

    def handle_cmd_chip_erase(self, cmd, ret):
        # Chip erase (erases both flash an EEPROM).
        # Upon successful chip erase, the lock bits will also be erased.
        # The only way to end a Chip Erase cycle is to release RESET#.
        self.putx([4, ['Chip erase']])

        # TODO: Check/handle RESET#.

        # Sanity check on reply.
        bit = (ret[2] & (1 << 7)) >> 7
        if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
            self.putx([8, ['Warning: Unexpected bytes in reply!']])

    def handle_cmd_read_fuse_bits(self, cmd, ret):
        # Read fuse bits.
        self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]])

        # TODO: Decode fuse bits.
        # TODO: Sanity check on reply.

    def handle_cmd_read_fuse_high_bits(self, cmd, ret):
        # Read fuse high bits.
        self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]])

        # TODO: Decode fuse bits.
        # TODO: Sanity check on reply.

    def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
        # Read extended fuse bits.
        self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])

        # TODO: Decode fuse bits.
        # TODO: Sanity check on reply.

    def handle_command(self, cmd, ret):
        if cmd[:2] == [0xac, 0x53]:
            self.handle_cmd_programming_enable(cmd, ret)
        elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
            self.handle_cmd_chip_erase(cmd, ret)
        elif cmd[:3] == [0x50, 0x00, 0x00]:
            self.handle_cmd_read_fuse_bits(cmd, ret)
        elif cmd[:3] == [0x58, 0x08, 0x00]:
            self.handle_cmd_read_fuse_high_bits(cmd, ret)
        elif cmd[:3] == [0x50, 0x08, 0x00]:
            self.handle_cmd_read_extended_fuse_bits(cmd, ret)
        elif cmd[0] == 0x30 and cmd[2] == 0x00:
            self.handle_cmd_read_signature_byte_0x00(cmd, ret)
        elif cmd[0] == 0x30 and cmd[2] == 0x01:
            self.handle_cmd_read_signature_byte_0x01(cmd, ret)
        elif cmd[0] == 0x30 and cmd[2] == 0x02:
            self.handle_cmd_read_signature_byte_0x02(cmd, ret)
        else:
            c = '%02x %02x %02x %02x' % tuple(cmd)
            r = '%02x %02x %02x %02x' % tuple(ret)
            self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])

    def decode(self, ss, es, data):
        ptype, mosi, miso = data

        # For now, only use DATA and BITS packets.
        if ptype not in ('DATA', 'BITS'):
            return

        # Store the individual bit values and ss/es numbers. The next packet
        # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
        if ptype == 'BITS':
            self.miso_bits, self.mosi_bits = miso, mosi
            return

        self.ss, self.es = ss, es

        if len(self.mosi_bytes) == 0:
            self.cmd_ss = ss

        # Append new bytes.
        self.mosi_bytes.append(mosi)
        self.miso_bytes.append(miso)

        # All commands consist of 4 bytes.
        if len(self.mosi_bytes) < 4:
            return

        self.cmd_es = es

        self.handle_command(self.mosi_bytes, self.miso_bytes)

        self.mosi_bytes = []
        self.miso_bytes = []
Commit	Line	Data
	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2012-2014 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 .parts import *
	23
	24	VENDOR_CODE_ATMEL = 0x1e
	25
	26	class Decoder(srd.Decoder):
	27	api_version = 1
	28	id = 'avr_isp'
	29	name = 'AVR ISP'
	30	longname = 'AVR In-System Programming'
	31	desc = 'Protocol for in-system programming Atmel AVR MCUs.'
	32	license = 'gplv2+'
	33	inputs = ['spi', 'logic']
	34	outputs = ['avr_isp']
	35	optional_probes = (
	36	{'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'},
	37	)
	38	annotations = (
	39	('pe', 'Programming enable'),
	40	('rsb0', 'Read signature byte 0'),
	41	('rsb1', 'Read signature byte 1'),
	42	('rsb2', 'Read signature byte 2'),
	43	('ce', 'Chip erase'),
	44	('rfb', 'Read fuse bits'),
	45	('rhfb', 'Read high fuse bits'),
	46	('refb', 'Read extended fuse bits'),
	47	('warnings', 'Warnings'),
	48	('dev', 'Device'),
	49	)
	50	annotation_rows = (
	51	('bits', 'Bits', ()),
	52	('commands', 'Commands', tuple(range(7 + 1))),
	53	('warnings', 'Warnings', (8,)),
	54	('dev', 'Device', (9,)),
	55	)
	56
	57	def __init__(self, **kwargs):
	58	self.state = 'IDLE'
	59	self.mosi_bytes, self.miso_bytes = [], []
	60	self.cmd_ss, self.cmd_es = 0, 0
	61	self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
	62	self.device_ss = None
	63
	64	def start(self):
	65	# self.out_python = self.register(srd.OUTPUT_PYTHON)
	66	self.out_ann = self.register(srd.OUTPUT_ANN)
	67
	68	def putx(self, data):
	69	self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
	70
	71	def handle_cmd_programming_enable(self, cmd, ret):
	72	# Programming enable.
	73	# Note: The chip doesn't send any ACK for 'Programming enable'.
	74	self.putx([0, ['Programming enable']])
	75
	76	# Sanity check on reply.
	77	if ret[1:4] != [0xac, 0x53, cmd[2]]:
	78	self.putx([8, ['Warning: Unexpected bytes in reply!']])
	79
	80	def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
	81	# Signature byte 0x00: vendor code.
	82	self.vendor_code = ret[3]
	83	v = vendor_code[self.vendor_code]
	84	self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
	85
	86	# Store for later.
	87	self.xx = cmd[1] # Same as ret[2].
	88	self.yy = cmd[3]
	89	self.zz = ret[0]
	90
	91	# Sanity check on reply.
	92	if ret[1] != 0x30 or ret[2] != cmd[1]:
	93	self.putx([8, ['Warning: Unexpected bytes in reply!']])
	94
	95	# Sanity check for the vendor code.
	96	if self.vendor_code != VENDOR_CODE_ATMEL:
	97	self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])
	98
	99	def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
	100	# Signature byte 0x01: part family and memory size.
	101	self.part_fam_flash_size = ret[3]
	102	self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])
	103
	104	# Store for later.
	105	self.mm = cmd[3]
	106	self.device_ss = self.cmd_ss
	107
	108	# Sanity check on reply.
	109	if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
	110	self.putx([8, ['Warning: Unexpected bytes in reply!']])
	111
	112	def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
	113	# Signature byte 0x02: part number.
	114	self.part_number = ret[3]
	115	self.putx([3, ['Part number: 0x%02x' % ret[3]]])
	116
	117	p = part[(self.part_fam_flash_size, self.part_number)]
	118	data = [9, ['Device: Atmel %s' % p]]
	119	self.put(self.device_ss, self.cmd_es, self.out_ann, data)
	120
	121	# Sanity check on reply.
	122	if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
	123	self.putx([8, ['Warning: Unexpected bytes in reply!']])
	124
	125	self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
	126
	127	def handle_cmd_chip_erase(self, cmd, ret):
	128	# Chip erase (erases both flash an EEPROM).
	129	# Upon successful chip erase, the lock bits will also be erased.
	130	# The only way to end a Chip Erase cycle is to release RESET#.
	131	self.putx([4, ['Chip erase']])
	132
	133	# TODO: Check/handle RESET#.
	134
	135	# Sanity check on reply.
	136	bit = (ret[2] & (1 << 7)) >> 7
	137	if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
	138	self.putx([8, ['Warning: Unexpected bytes in reply!']])
	139
	140	def handle_cmd_read_fuse_bits(self, cmd, ret):
	141	# Read fuse bits.
	142	self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]])
	143
	144	# TODO: Decode fuse bits.
	145	# TODO: Sanity check on reply.
	146
	147	def handle_cmd_read_fuse_high_bits(self, cmd, ret):
	148	# Read fuse high bits.
	149	self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]])
	150
	151	# TODO: Decode fuse bits.
	152	# TODO: Sanity check on reply.
	153
	154	def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
	155	# Read extended fuse bits.
	156	self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])
	157
	158	# TODO: Decode fuse bits.
	159	# TODO: Sanity check on reply.
	160
	161	def handle_command(self, cmd, ret):
	162	if cmd[:2] == [0xac, 0x53]:
	163	self.handle_cmd_programming_enable(cmd, ret)
	164	elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
	165	self.handle_cmd_chip_erase(cmd, ret)
	166	elif cmd[:3] == [0x50, 0x00, 0x00]:
	167	self.handle_cmd_read_fuse_bits(cmd, ret)
	168	elif cmd[:3] == [0x58, 0x08, 0x00]:
	169	self.handle_cmd_read_fuse_high_bits(cmd, ret)
	170	elif cmd[:3] == [0x50, 0x08, 0x00]:
	171	self.handle_cmd_read_extended_fuse_bits(cmd, ret)
	172	elif cmd[0] == 0x30 and cmd[2] == 0x00:
	173	self.handle_cmd_read_signature_byte_0x00(cmd, ret)
	174	elif cmd[0] == 0x30 and cmd[2] == 0x01:
	175	self.handle_cmd_read_signature_byte_0x01(cmd, ret)
	176	elif cmd[0] == 0x30 and cmd[2] == 0x02:
	177	self.handle_cmd_read_signature_byte_0x02(cmd, ret)
	178	else:
	179	c = '%02x %02x %02x %02x' % tuple(cmd)
	180	r = '%02x %02x %02x %02x' % tuple(ret)
	181	self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
	182
	183	def decode(self, ss, es, data):
	184	ptype, mosi, miso = data
	185
	186	# For now, only use DATA and BITS packets.
	187	if ptype not in ('DATA', 'BITS'):
	188	return
	189
	190	# Store the individual bit values and ss/es numbers. The next packet
	191	# is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
	192	if ptype == 'BITS':
	193	self.miso_bits, self.mosi_bits = miso, mosi
	194	return
	195
	196	self.ss, self.es = ss, es
	197
	198	if len(self.mosi_bytes) == 0:
	199	self.cmd_ss = ss
	200
	201	# Append new bytes.
	202	self.mosi_bytes.append(mosi)
	203	self.miso_bytes.append(miso)
	204
	205	# All commands consist of 4 bytes.
	206	if len(self.mosi_bytes) < 4:
	207	return
	208
	209	self.cmd_es = es
	210
	211	self.handle_command(self.mosi_bytes, self.miso_bytes)
	212
	213	self.mosi_bytes = []
	214	self.miso_bytes = []
	215