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, see <http://www.gnu.org/licenses/>.
20 import sigrokdecode as srd
23 VENDOR_CODE_ATMEL = 0x1e
25 class Decoder(srd.Decoder):
29 longname = 'AVR In-System Programming'
30 desc = 'Protocol for in-system programming Atmel AVR MCUs.'
35 ('pe', 'Programming enable'),
36 ('rsb0', 'Read signature byte 0'),
37 ('rsb1', 'Read signature byte 1'),
38 ('rsb2', 'Read signature byte 2'),
40 ('rfb', 'Read fuse bits'),
41 ('rhfb', 'Read high fuse bits'),
42 ('refb', 'Read extended fuse bits'),
43 ('warnings', 'Warnings'),
48 ('commands', 'Commands', tuple(range(7 + 1))),
49 ('warnings', 'Warnings', (8,)),
50 ('dev', 'Device', (9,)),
55 self.mosi_bytes, self.miso_bytes = [], []
56 self.ss_cmd, self.es_cmd = 0, 0
57 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
61 self.out_ann = self.register(srd.OUTPUT_ANN)
64 self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
66 def handle_cmd_programming_enable(self, cmd, ret):
68 # Note: The chip doesn't send any ACK for 'Programming enable'.
69 self.putx([0, ['Programming enable']])
71 # Sanity check on reply.
72 if ret[1:4] != [0xac, 0x53, cmd[2]]:
73 self.putx([8, ['Warning: Unexpected bytes in reply!']])
75 def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
76 # Signature byte 0x00: vendor code.
77 self.vendor_code = ret[3]
78 v = vendor_code[self.vendor_code]
79 self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
82 self.xx = cmd[1] # Same as ret[2].
86 # Sanity check on reply.
87 if ret[1] != 0x30 or ret[2] != cmd[1]:
88 self.putx([8, ['Warning: Unexpected bytes in reply!']])
90 # Sanity check for the vendor code.
91 if self.vendor_code != VENDOR_CODE_ATMEL:
92 self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])
94 def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
95 # Signature byte 0x01: part family and memory size.
96 self.part_fam_flash_size = ret[3]
97 self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])
101 self.ss_device = self.ss_cmd
103 # Sanity check on reply.
104 if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
105 self.putx([8, ['Warning: Unexpected bytes in reply!']])
107 def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
108 # Signature byte 0x02: part number.
109 self.part_number = ret[3]
110 self.putx([3, ['Part number: 0x%02x' % ret[3]]])
112 p = part[(self.part_fam_flash_size, self.part_number)]
113 data = [9, ['Device: Atmel %s' % p]]
114 self.put(self.ss_device, self.es_cmd, self.out_ann, data)
116 # Sanity check on reply.
117 if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
118 self.putx([8, ['Warning: Unexpected bytes in reply!']])
120 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
122 def handle_cmd_chip_erase(self, cmd, ret):
123 # Chip erase (erases both flash an EEPROM).
124 # Upon successful chip erase, the lock bits will also be erased.
125 # The only way to end a Chip Erase cycle is to release RESET#.
126 self.putx([4, ['Chip erase']])
128 # TODO: Check/handle RESET#.
130 # Sanity check on reply.
131 bit = (ret[2] & (1 << 7)) >> 7
132 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
133 self.putx([8, ['Warning: Unexpected bytes in reply!']])
135 def handle_cmd_read_fuse_bits(self, cmd, ret):
137 self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]])
139 # TODO: Decode fuse bits.
140 # TODO: Sanity check on reply.
142 def handle_cmd_read_fuse_high_bits(self, cmd, ret):
143 # Read fuse high bits.
144 self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]])
146 # TODO: Decode fuse bits.
147 # TODO: Sanity check on reply.
149 def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
150 # Read extended fuse bits.
151 self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])
153 # TODO: Decode fuse bits.
154 # TODO: Sanity check on reply.
156 def handle_command(self, cmd, ret):
157 if cmd[:2] == [0xac, 0x53]:
158 self.handle_cmd_programming_enable(cmd, ret)
159 elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
160 self.handle_cmd_chip_erase(cmd, ret)
161 elif cmd[:3] == [0x50, 0x00, 0x00]:
162 self.handle_cmd_read_fuse_bits(cmd, ret)
163 elif cmd[:3] == [0x58, 0x08, 0x00]:
164 self.handle_cmd_read_fuse_high_bits(cmd, ret)
165 elif cmd[:3] == [0x50, 0x08, 0x00]:
166 self.handle_cmd_read_extended_fuse_bits(cmd, ret)
167 elif cmd[0] == 0x30 and cmd[2] == 0x00:
168 self.handle_cmd_read_signature_byte_0x00(cmd, ret)
169 elif cmd[0] == 0x30 and cmd[2] == 0x01:
170 self.handle_cmd_read_signature_byte_0x01(cmd, ret)
171 elif cmd[0] == 0x30 and cmd[2] == 0x02:
172 self.handle_cmd_read_signature_byte_0x02(cmd, ret)
174 c = '%02x %02x %02x %02x' % tuple(cmd)
175 r = '%02x %02x %02x %02x' % tuple(ret)
176 self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
178 def decode(self, ss, es, data):
179 ptype, mosi, miso = data
181 # For now, only use DATA and BITS packets.
182 if ptype not in ('DATA', 'BITS'):
185 # Store the individual bit values and ss/es numbers. The next packet
186 # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
188 self.miso_bits, self.mosi_bits = miso, mosi
191 self.ss, self.es = ss, es
193 if len(self.mosi_bytes) == 0:
197 self.mosi_bytes.append(mosi)
198 self.miso_bytes.append(miso)
200 # All commands consist of 4 bytes.
201 if len(self.mosi_bytes) < 4:
206 self.handle_command(self.mosi_bytes, self.miso_bytes)