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 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 ['text', 'Human-readable text'],
42 ['warnings', 'Human-readable warnings'],
45 def __init__(self, **kwargs):
47 self.mosi_bytes, self.miso_bytes = [], []
48 self.cmd_ss, self.cmd_es = 0, 0
49 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
52 # self.out_python = self.register(srd.OUTPUT_PYTHON)
53 self.out_ann = self.register(srd.OUTPUT_ANN)
56 self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
58 def handle_cmd_programming_enable(self, cmd, ret):
60 # Note: The chip doesn't send any ACK for 'Programming enable'.
61 self.putx([0, ['Programming enable']])
63 # Sanity check on reply.
64 if ret[1:4] != [0xac, 0x53, cmd[2]]:
65 self.putx([1, ['Warning: Unexpected bytes in reply!']])
67 def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
68 # Signature byte 0x00: vendor code.
69 self.vendor_code = ret[3]
70 v = vendor_code[self.vendor_code]
71 self.putx([0, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
74 self.xx = cmd[1] # Same as ret[2].
78 # Sanity check on reply.
79 if ret[1] != 0x30 or ret[2] != cmd[1]:
80 self.putx([1, ['Warning: Unexpected bytes in reply!']])
82 # Sanity check for the vendor code.
83 if self.vendor_code != VENDOR_CODE_ATMEL:
84 self.putx([1, ['Warning: Vendor code was not 0x1e (Atmel)!']])
86 def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
87 # Signature byte 0x01: part family and memory size.
88 self.part_fam_flash_size = ret[3]
89 self.putx([0, ['Part family / memory size: 0x%02x' % ret[3]]])
94 # Sanity check on reply.
95 if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy:
96 self.putx([1, ['Warning: Unexpected bytes in reply!']])
98 def handle_cmd_read_signature_byte_0x02(self, cmd, ret):
99 # Signature byte 0x02: part number.
100 self.part_number = ret[3]
101 self.putx([0, ['Part number: 0x%02x' % ret[3]]])
104 p = part[(self.part_fam_flash_size, self.part_number)]
105 self.putx([0, ['Device: Atmel %s' % p]])
107 # Sanity check on reply.
108 if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm:
109 self.putx([1, ['Warning: Unexpected bytes in reply!']])
111 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
113 def handle_cmd_chip_erase(self, cmd, ret):
114 # Chip erase (erases both flash an EEPROM).
115 # Upon successful chip erase, the lock bits will also be erased.
116 # The only way to end a Chip Erase cycle is to release RESET#.
117 self.putx([0, ['Chip erase']])
119 # TODO: Check/handle RESET#.
121 # Sanity check on reply.
122 bit = (ret[2] & (1 << 7)) >> 7
123 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]:
124 self.putx([1, ['Warning: Unexpected bytes in reply!']])
126 def handle_cmd_read_fuse_bits(self, cmd, ret):
128 self.putx([0, ['Read fuse bits: 0x%02x' % ret[3]]])
130 # TODO: Decode fuse bits.
131 # TODO: Sanity check on reply.
133 def handle_cmd_read_fuse_high_bits(self, cmd, ret):
134 # Read fuse high bits.
135 self.putx([0, ['Read fuse high bits: 0x%02x' % ret[3]]])
137 # TODO: Decode fuse bits.
138 # TODO: Sanity check on reply.
140 def handle_cmd_read_extended_fuse_bits(self, cmd, ret):
141 # Read extended fuse bits.
142 self.putx([0, ['Read extended fuse bits: 0x%02x' % ret[3]]])
144 # TODO: Decode fuse bits.
145 # TODO: Sanity check on reply.
147 def handle_command(self, cmd, ret):
148 if cmd[:2] == [0xac, 0x53]:
149 self.handle_cmd_programming_enable(cmd, ret)
150 elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7):
151 self.handle_cmd_chip_erase(cmd, ret)
152 elif cmd[:3] == [0x50, 0x00, 0x00]:
153 self.handle_cmd_read_fuse_bits(cmd, ret)
154 elif cmd[:3] == [0x58, 0x08, 0x00]:
155 self.handle_cmd_read_fuse_high_bits(cmd, ret)
156 elif cmd[:3] == [0x50, 0x08, 0x00]:
157 self.handle_cmd_read_extended_fuse_bits(cmd, ret)
158 elif cmd[0] == 0x30 and cmd[2] == 0x00:
159 self.handle_cmd_read_signature_byte_0x00(cmd, ret)
160 elif cmd[0] == 0x30 and cmd[2] == 0x01:
161 self.handle_cmd_read_signature_byte_0x01(cmd, ret)
162 elif cmd[0] == 0x30 and cmd[2] == 0x02:
163 self.handle_cmd_read_signature_byte_0x02(cmd, ret)
165 c = '%02x %02x %02x %02x' % tuple(cmd)
166 r = '%02x %02x %02x %02x' % tuple(ret)
167 self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]])
169 def decode(self, ss, es, data):
170 ptype, mosi, miso = data
175 # self.put(0, 0, self.out_ann,
176 # [0, ['MOSI: 0x%02x, MISO: 0x%02x' % (mosi, miso)]])
178 self.ss, self.es = ss, es
180 if len(self.mosi_bytes) == 0:
184 self.mosi_bytes.append(mosi)
185 self.miso_bytes.append(miso)
187 # All commands consist of 4 bytes.
188 if len(self.mosi_bytes) < 4:
193 self.handle_command(self.mosi_bytes, self.miso_bytes)