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.'
36 ('pe', 'Programming enable'),
37 ('rsb0', 'Read signature byte 0'),
38 ('rsb1', 'Read signature byte 1'),
39 ('rsb2', 'Read signature byte 2'),
41 ('rfb', 'Read fuse bits'),
42 ('rhfb', 'Read high fuse bits'),
43 ('refb', 'Read extended fuse bits'),
44 ('warnings', 'Warnings'),
49 ('commands', 'Commands', tuple(range(7 + 1))),
50 ('warnings', 'Warnings', (8,)),
51 ('dev', 'Device', (9,)),
56 self.mosi_bytes, self.miso_bytes = [], []
57 self.ss_cmd, self.es_cmd = 0, 0
58 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
62 self.out_ann = self.register(srd.OUTPUT_ANN)
65 self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
67 def handle_cmd_programming_enable(self, cmd, ret):
69 # Note: The chip doesn't send any ACK for 'Programming enable'.
70 self.putx([0, ['Programming enable']])
72 # Sanity check on reply.
73 if ret[1:4] != [0xac, 0x53, cmd[2]]:
74 self.putx([8, ['Warning: Unexpected bytes in reply!']])
76 def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
77 # Signature byte 0x00: vendor code.
78 self.vendor_code = ret[3]
79 v = vendor_code[self.vendor_code]
80 self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
83 self.xx = cmd[1] # Same as ret[2].
87 # Sanity check on reply.
88 if ret[1] != 0x30 or ret[2] != cmd[1]:
89 self.putx([8, ['Warning: Unexpected bytes in reply!']])
91 # Sanity check for the vendor code.
92 if self.vendor_code != VENDOR_CODE_ATMEL:
93 self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])
95 def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
96 # Signature byte 0x01: part family and memory size.
97 self.part_fam_flash_size = ret[3]
98 self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])
102 self.ss_device = self.ss_cmd
104 # Sanity check on reply.
105 if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
106 self.putx([8, ['Warning: Unexpected bytes in reply!']])
108 def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
109 # Signature byte 0x02: part number.
110 self.part_number = ret[3]
111 self.putx([3, ['Part number: 0x%02x' % ret[3]]])
113 p = part[(self.part_fam_flash_size, self.part_number)]
114 data = [9, ['Device: Atmel %s' % p]]
115 self.put(self.ss_device, self.es_cmd, self.out_ann, data)
117 # Sanity check on reply.
118 if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
119 self.putx([8, ['Warning: Unexpected bytes in reply!']])
121 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
123 def handle_cmd_chip_erase(self, cmd, ret):
124 # Chip erase (erases both flash an EEPROM).
125 # Upon successful chip erase, the lock bits will also be erased.
126 # The only way to end a Chip Erase cycle is to release RESET#.
127 self.putx([4, ['Chip erase']])
129 # TODO: Check/handle RESET#.
131 # Sanity check on reply.
132 bit = (ret[2] & (1 << 7)) >> 7
133 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
134 self.putx([8, ['Warning: Unexpected bytes in reply!']])
136 def handle_cmd_read_fuse_bits(self, cmd, ret):
138 self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]])
140 # TODO: Decode fuse bits.
141 # TODO: Sanity check on reply.
143 def handle_cmd_read_fuse_high_bits(self, cmd, ret):
144 # Read fuse high bits.
145 self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]])
147 # TODO: Decode fuse bits.
148 # TODO: Sanity check on reply.
150 def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
151 # Read extended fuse bits.
152 self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])
154 # TODO: Decode fuse bits.
155 # TODO: Sanity check on reply.
157 def handle_command(self, cmd, ret):
158 if cmd[:2] == [0xac, 0x53]:
159 self.handle_cmd_programming_enable(cmd, ret)
160 elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
161 self.handle_cmd_chip_erase(cmd, ret)
162 elif cmd[:3] == [0x50, 0x00, 0x00]:
163 self.handle_cmd_read_fuse_bits(cmd, ret)
164 elif cmd[:3] == [0x58, 0x08, 0x00]:
165 self.handle_cmd_read_fuse_high_bits(cmd, ret)
166 elif cmd[:3] == [0x50, 0x08, 0x00]:
167 self.handle_cmd_read_extended_fuse_bits(cmd, ret)
168 elif cmd[0] == 0x30 and cmd[2] == 0x00:
169 self.handle_cmd_read_signature_byte_0x00(cmd, ret)
170 elif cmd[0] == 0x30 and cmd[2] == 0x01:
171 self.handle_cmd_read_signature_byte_0x01(cmd, ret)
172 elif cmd[0] == 0x30 and cmd[2] == 0x02:
173 self.handle_cmd_read_signature_byte_0x02(cmd, ret)
175 c = '%02x %02x %02x %02x' % tuple(cmd)
176 r = '%02x %02x %02x %02x' % tuple(ret)
177 self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
179 def decode(self, ss, es, data):
180 ptype, mosi, miso = data
182 # For now, only use DATA and BITS packets.
183 if ptype not in ('DATA', 'BITS'):
186 # Store the individual bit values and ss/es numbers. The next packet
187 # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
189 self.miso_bits, self.mosi_bits = miso, mosi
192 self.ss, self.es = ss, es
194 if len(self.mosi_bytes) == 0:
198 self.mosi_bytes.append(mosi)
199 self.miso_bytes.append(miso)
201 # All commands consist of 4 bytes.
202 if len(self.mosi_bytes) < 4:
207 self.handle_command(self.mosi_bytes, self.miso_bytes)