2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
21 import sigrokdecode as srd
24 VENDOR_CODE_ATMEL = 0x1e
26 class Decoder(srd.Decoder):
30 longname = 'AVR In-System Programming'
31 desc = 'Protocol for in-system programming Atmel AVR MCUs.'
33 inputs = ['spi', 'logic']
37 {'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'},
41 ['pe', 'Programming enable'],
42 ['rsb0', 'Read signature byte 0'],
43 ['rsb1', 'Read signature byte 1'],
44 ['rsb2', 'Read signature byte 2'],
46 ['rfb', 'Read fuse bits'],
47 ['rhfb', 'Read high fuse bits'],
48 ['refb', 'Read extended fuse bits'],
49 ['warnings', 'Warnings'],
52 def __init__(self, **kwargs):
54 self.mosi_bytes, self.miso_bytes = [], []
55 self.cmd_ss, self.cmd_es = 0, 0
56 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
59 # self.out_python = self.register(srd.OUTPUT_PYTHON)
60 self.out_ann = self.register(srd.OUTPUT_ANN)
63 self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
65 def handle_cmd_programming_enable(self, cmd, ret):
67 # Note: The chip doesn't send any ACK for 'Programming enable'.
68 self.putx([0, ['Programming enable']])
70 # Sanity check on reply.
71 if ret[1:4] != [0xac, 0x53, cmd[2]]:
72 self.putx([8, ['Warning: Unexpected bytes in reply!']])
74 def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
75 # Signature byte 0x00: vendor code.
76 self.vendor_code = ret[3]
77 v = vendor_code[self.vendor_code]
78 self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
81 self.xx = cmd[1] # Same as ret[2].
85 # Sanity check on reply.
86 if ret[1] != 0x30 or ret[2] != cmd[1]:
87 self.putx([8, ['Warning: Unexpected bytes in reply!']])
89 # Sanity check for the vendor code.
90 if self.vendor_code != VENDOR_CODE_ATMEL:
91 self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])
93 def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
94 # Signature byte 0x01: part family and memory size.
95 self.part_fam_flash_size = ret[3]
96 self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])
101 # Sanity check on reply.
102 if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
103 self.putx([8, ['Warning: Unexpected bytes in reply!']])
105 def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
106 # Signature byte 0x02: part number.
107 self.part_number = ret[3]
108 self.putx([3, ['Part number: 0x%02x' % ret[3]]])
111 p = part[(self.part_fam_flash_size, self.part_number)]
112 self.putx([3, ['Device: Atmel %s' % p]])
114 # Sanity check on reply.
115 if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
116 self.putx([8, ['Warning: Unexpected bytes in reply!']])
118 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
120 def handle_cmd_chip_erase(self, cmd, ret):
121 # Chip erase (erases both flash an EEPROM).
122 # Upon successful chip erase, the lock bits will also be erased.
123 # The only way to end a Chip Erase cycle is to release RESET#.
124 self.putx([4, ['Chip erase']])
126 # TODO: Check/handle RESET#.
128 # Sanity check on reply.
129 bit = (ret[2] & (1 << 7)) >> 7
130 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
131 self.putx([8, ['Warning: Unexpected bytes in reply!']])
133 def handle_cmd_read_fuse_bits(self, cmd, ret):
135 self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]])
137 # TODO: Decode fuse bits.
138 # TODO: Sanity check on reply.
140 def handle_cmd_read_fuse_high_bits(self, cmd, ret):
141 # Read fuse high bits.
142 self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]])
144 # TODO: Decode fuse bits.
145 # TODO: Sanity check on reply.
147 def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
148 # Read extended fuse bits.
149 self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])
151 # TODO: Decode fuse bits.
152 # TODO: Sanity check on reply.
154 def handle_command(self, cmd, ret):
155 if cmd[:2] == [0xac, 0x53]:
156 self.handle_cmd_programming_enable(cmd, ret)
157 elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
158 self.handle_cmd_chip_erase(cmd, ret)
159 elif cmd[:3] == [0x50, 0x00, 0x00]:
160 self.handle_cmd_read_fuse_bits(cmd, ret)
161 elif cmd[:3] == [0x58, 0x08, 0x00]:
162 self.handle_cmd_read_fuse_high_bits(cmd, ret)
163 elif cmd[:3] == [0x50, 0x08, 0x00]:
164 self.handle_cmd_read_extended_fuse_bits(cmd, ret)
165 elif cmd[0] == 0x30 and cmd[2] == 0x00:
166 self.handle_cmd_read_signature_byte_0x00(cmd, ret)
167 elif cmd[0] == 0x30 and cmd[2] == 0x01:
168 self.handle_cmd_read_signature_byte_0x01(cmd, ret)
169 elif cmd[0] == 0x30 and cmd[2] == 0x02:
170 self.handle_cmd_read_signature_byte_0x02(cmd, ret)
172 c = '%02x %02x %02x %02x' % tuple(cmd)
173 r = '%02x %02x %02x %02x' % tuple(ret)
174 self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
176 def decode(self, ss, es, data):
177 ptype, mosi, miso = data
179 # For now, only use DATA and BITS packets.
180 if ptype not in ('DATA', 'BITS'):
183 # Store the individual bit values and ss/es numbers. The next packet
184 # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
186 self.miso_bits, self.mosi_bits = miso, mosi
189 self.ss, self.es = ss, es
191 if len(self.mosi_bytes) == 0:
195 self.mosi_bytes.append(mosi)
196 self.miso_bytes.append(miso)
198 # All commands consist of 4 bytes.
199 if len(self.mosi_bytes) < 4:
204 self.handle_command(self.mosi_bytes, self.miso_bytes)