[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, see <http://www.gnu.org/licenses/>.
##

import sigrokdecode as srd
from .parts import *

class Ann:
    PE, RSB0, RSB1, RSB2, CE, RFB, RHFB, REFB, \
    WARN, DEV, = range(10)

VENDOR_CODE_ATMEL = 0x1e

class Decoder(srd.Decoder):
    api_version = 3
    id = 'avr_isp'
    name = 'AVR ISP'
    longname = 'AVR In-System Programming'
    desc = 'Atmel AVR In-System Programming (ISP) protocol.'
    license = 'gplv2+'
    inputs = ['spi']
    outputs = []
    tags = ['Debug/trace']
    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'),
        ('warning', 'Warning'),
        ('dev', 'Device'),
    )
    annotation_rows = (
        ('bits', 'Bits', ()),
        ('commands', 'Commands', (Ann.PE, Ann.RSB0, Ann.RSB1, Ann.RSB2,
            Ann.CE, Ann.RFB, Ann.RHFB, Ann.REFB,)),
        ('warnings', 'Warnings', (Ann.WARN,)),
        ('devs', 'Devices', (Ann.DEV,)),
    )

    def __init__(self):
        self.reset()

    def reset(self):
        self.state = 'IDLE'
        self.mosi_bytes, self.miso_bytes = [], []
        self.ss_cmd, self.es_cmd = 0, 0
        self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
        self.ss_device = None

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

    def putx(self, data):
        self.put(self.ss_cmd, self.es_cmd, 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([Ann.PE, ['Programming enable']])

        # Sanity check on reply.
        if ret[1:4] != [0xac, 0x53, cmd[2]]:
            self.putx([Ann.WARN, ['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([Ann.RSB0, ['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([Ann.WARN, ['Warning: Unexpected bytes in reply!']])

        # Sanity check for the vendor code.
        if self.vendor_code != VENDOR_CODE_ATMEL:
            self.putx([Ann.WARN, ['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([Ann.RSB1, ['Part family / memory size: 0x%02x' % ret[3]]])

        # Store for later.
        self.mm = cmd[3]
        self.ss_device = self.ss_cmd

        # Sanity check on reply.
        if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
            self.putx([Ann.WARN, ['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([Ann.RSB2, ['Part number: 0x%02x' % ret[3]]])

        p = part[(self.part_fam_flash_size, self.part_number)]
        data = [Ann.DEV, ['Device: Atmel %s' % p]]
        self.put(self.ss_device, self.es_cmd, self.out_ann, data)

        # Sanity check on reply.
        if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
            self.putx([Ann.WARN, ['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([Ann.CE, ['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([Ann.WARN, ['Warning: Unexpected bytes in reply!']])

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