2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012 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 # AVR ISP protocol decoder
23 import sigrokdecode as srd
26 VENDOR_CODE_ATMEL = 0x1e
28 class Decoder(srd.Decoder):
32 longname = 'AVR In-System Programming'
33 desc = 'Protocol for in-system programming Atmel AVR MCUs.'
35 inputs = ['spi', 'logic']
39 {'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'},
43 ['Text', 'Human-readable text'],
44 ['Warnings', 'Human-readable warnings'],
47 def __init__(self, **kwargs):
49 self.mosi_bytes, self.miso_bytes = [], []
50 self.cmd_ss, self.cmd_es = 0, 0
51 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
53 def start(self, metadata):
54 # self.out_proto = self.add(srd.OUTPUT_PROTO, 'avr_isp')
55 self.out_ann = self.add(srd.OUTPUT_ANN, 'avr_isp')
61 self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
63 def handle_cmd_programming_enable(self, cmd, ret):
65 # Note: The chip doesn't send any ACK for 'Programming enable'.
66 self.putx([0, ['Programming enable']])
68 # Sanity check on reply.
69 if ret[1:4] != [0xac, 0x53, cmd[2]]:
70 self.putx([1, ['Warning: Unexpected bytes in reply!']])
72 def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
73 # Signature byte 0x00: vendor code.
74 self.vendor_code = ret[3]
75 v = vendor_code[self.vendor_code]
76 self.putx([0, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
79 self.xx = cmd[1] # Same as ret[2].
83 # Sanity check on reply.
84 if ret[1] != 0x30 or ret[2] != cmd[1]:
85 self.putx([1, ['Warning: Unexpected bytes in reply!']])
87 # Sanity check for the vendor code.
88 if self.vendor_code != VENDOR_CODE_ATMEL:
89 self.putx([1, ['Warning: Vendor code was not 0x1e (Atmel)!']])
91 def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
92 # Signature byte 0x01: part family and memory size.
93 self.part_fam_flash_size = ret[3]
94 self.putx([0, ['Part family / memory size: 0x%02x' % ret[3]]])
99 # Sanity check on reply.
100 if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
101 self.putx([1, ['Warning: Unexpected bytes in reply!']])
103 def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
104 # Signature byte 0x02: part number.
105 self.part_number = ret[3]
106 self.putx([0, ['Part number: 0x%02x' % ret[3]]])
109 p = part[(self.part_fam_flash_size, self.part_number)]
110 self.putx([0, ['Device: Atmel %s' % p]])
112 # Sanity check on reply.
113 if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
114 self.putx([1, ['Warning: Unexpected bytes in reply!']])
116 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
118 def handle_cmd_chip_erase(self, cmd, ret):
119 # Chip erase (erases both flash an EEPROM).
120 # Upon successful chip erase, the lock bits will also be erased.
121 # The only way to end a Chip Erase cycle is to release RESET#.
122 self.putx([0, ['Chip erase']])
124 # TODO: Check/handle RESET#.
126 # Sanity check on reply.
127 bit = (ret[2] & (1 << 7)) >> 7
128 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
129 self.putx([1, ['Warning: Unexpected bytes in reply!']])
131 def handle_cmd_read_fuse_bits(self, cmd, ret):
133 self.putx([0, ['Read fuse bits: 0x%02x' % ret[3]]])
135 # TODO: Decode fuse bits.
136 # TODO: Sanity check on reply.
138 def handle_cmd_read_fuse_high_bits(self, cmd, ret):
139 # Read fuse high bits.
140 self.putx([0, ['Read fuse high bits: 0x%02x' % ret[3]]])
142 # TODO: Decode fuse bits.
143 # TODO: Sanity check on reply.
145 def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
146 # Read extended fuse bits.
147 self.putx([0, ['Read extended fuse bits: 0x%02x' % ret[3]]])
149 # TODO: Decode fuse bits.
150 # TODO: Sanity check on reply.
152 def handle_command(self, cmd, ret):
153 if cmd[:2] == [0xac, 0x53]:
154 self.handle_cmd_programming_enable(cmd, ret)
155 elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
156 self.handle_cmd_chip_erase(cmd, ret)
157 elif cmd[:3] == [0x50, 0x00, 0x00]:
158 self.handle_cmd_read_fuse_bits(cmd, ret)
159 elif cmd[:3] == [0x58, 0x08, 0x00]:
160 self.handle_cmd_read_fuse_high_bits(cmd, ret)
161 elif cmd[:3] == [0x50, 0x08, 0x00]:
162 self.handle_cmd_read_extended_fuse_bits(cmd, ret)
163 elif cmd[0] == 0x30 and cmd[2] == 0x00:
164 self.handle_cmd_read_signature_byte_0x00(cmd, ret)
165 elif cmd[0] == 0x30 and cmd[2] == 0x01:
166 self.handle_cmd_read_signature_byte_0x01(cmd, ret)
167 elif cmd[0] == 0x30 and cmd[2] == 0x02:
168 self.handle_cmd_read_signature_byte_0x02(cmd, ret)
170 c = '%02x %02x %02x %02x' % tuple(cmd)
171 r = '%02x %02x %02x %02x' % tuple(ret)
172 self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
174 def decode(self, ss, es, data):
175 ptype, mosi, miso = data
180 # self.put(0, 0, self.out_ann,
181 # [0, ['MOSI: 0x%02x, MISO: 0x%02x' % (mosi, miso)]])
183 self.ss, self.es = ss, es
186 self.mosi_bytes.append(mosi)
187 self.miso_bytes.append(miso)
189 if len(self.mosi_bytes) == 0:
192 # All commands consist of 4 bytes.
193 if len(self.mosi_bytes) < 4:
198 self.handle_command(self.mosi_bytes, self.miso_bytes)