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
24 PE, RSB0, RSB1, RSB2, CE, RFB, RHFB, REFB, \
25 WARN, DEV, = range(10)
27 VENDOR_CODE_ATMEL = 0x1e
29 class Decoder(srd.Decoder):
33 longname = 'AVR In-System Programming'
34 desc = 'Atmel AVR In-System Programming (ISP) protocol.'
38 tags = ['Debug/trace']
40 ('pe', 'Programming enable'),
41 ('rsb0', 'Read signature byte 0'),
42 ('rsb1', 'Read signature byte 1'),
43 ('rsb2', 'Read signature byte 2'),
45 ('rfb', 'Read fuse bits'),
46 ('rhfb', 'Read high fuse bits'),
47 ('refb', 'Read extended fuse bits'),
48 ('warning', 'Warning'),
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,)),
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
70 self.out_ann = self.register(srd.OUTPUT_ANN)
73 self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
75 def handle_cmd_programming_enable(self, cmd, ret):
77 # Note: The chip doesn't send any ACK for 'Programming enable'.
78 self.putx([Ann.PE, ['Programming enable']])
80 # Sanity check on reply.
81 if ret[1:4] != [0xac, 0x53, cmd[2]]:
82 self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']])
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)]])
91 self.xx = cmd[1] # Same as ret[2].
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!']])
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)!']])
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]]])
110 self.ss_device = self.ss_cmd
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!']])
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]]])
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)
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!']])
129 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
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']])
137 # TODO: Check/handle RESET#.
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!']])
144 def handle_cmd_read_fuse_bits(self, cmd, ret):
146 self.putx([Ann.RFB, ['Read fuse bits: 0x%02x' % ret[3]]])
148 # TODO: Decode fuse bits.
149 # TODO: Sanity check on reply.
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]]])
155 # TODO: Decode fuse bits.
156 # TODO: Sanity check on reply.
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]]])
162 # TODO: Decode fuse bits.
163 # TODO: Sanity check on reply.
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)
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)]])
187 def decode(self, ss, es, data):
188 ptype, mosi, miso = data
190 # For now, only use DATA and BITS packets.
191 if ptype not in ('DATA', 'BITS'):
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.
197 self.miso_bits, self.mosi_bits = miso, mosi
200 self.ss, self.es = ss, es
202 if len(self.mosi_bytes) == 0:
206 self.mosi_bytes.append(mosi)
207 self.miso_bytes.append(miso)
209 # All commands consist of 4 bytes.
210 if len(self.mosi_bytes) < 4:
215 self.handle_command(self.mosi_bytes, self.miso_bytes)