]>
Commit | Line | Data |
---|---|---|
3bd76451 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
3bd76451 | 3 | ## |
ad30cb46 | 4 | ## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de> |
3bd76451 UH |
5 | ## |
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. | |
10 | ## | |
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. | |
15 | ## | |
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 | |
19 | ## | |
20 | ||
3bd76451 | 21 | import sigrokdecode as srd |
77adad94 | 22 | from .parts import * |
3bd76451 UH |
23 | |
24 | VENDOR_CODE_ATMEL = 0x1e | |
25 | ||
26 | class Decoder(srd.Decoder): | |
27 | api_version = 1 | |
28 | id = 'avr_isp' | |
29 | name = 'AVR ISP' | |
d523eae6 | 30 | longname = 'AVR In-System Programming' |
3bd76451 UH |
31 | desc = 'Protocol for in-system programming Atmel AVR MCUs.' |
32 | license = 'gplv2+' | |
33 | inputs = ['spi', 'logic'] | |
34 | outputs = ['avr_isp'] | |
35 | probes = [] | |
36 | optional_probes = [ | |
37 | {'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'}, | |
38 | ] | |
39 | options = {} | |
40 | annotations = [ | |
ad30cb46 UH |
41 | ['pe', 'Programming enable'], |
42 | ['rsb0', 'Read signature byte 0'], | |
43 | ['rsb1', 'Read signature byte 1'], | |
44 | ['rsb2', 'Read signature byte 2'], | |
45 | ['ce', 'Chip erase'], | |
46 | ['rfb', 'Read fuse bits'], | |
47 | ['rhfb', 'Read high fuse bits'], | |
48 | ['refb', 'Read extended fuse bits'], | |
49 | ['warnings', 'Warnings'], | |
3bd76451 UH |
50 | ] |
51 | ||
52 | def __init__(self, **kwargs): | |
53 | self.state = 'IDLE' | |
54 | self.mosi_bytes, self.miso_bytes = [], [] | |
55 | self.cmd_ss, self.cmd_es = 0, 0 | |
56 | self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0 | |
57 | ||
8915b346 | 58 | def start(self): |
c515eed7 | 59 | # self.out_python = self.register(srd.OUTPUT_PYTHON) |
be465111 | 60 | self.out_ann = self.register(srd.OUTPUT_ANN) |
3bd76451 | 61 | |
3bd76451 UH |
62 | def putx(self, data): |
63 | self.put(self.cmd_ss, self.cmd_es, self.out_ann, data) | |
64 | ||
65 | def handle_cmd_programming_enable(self, cmd, ret): | |
66 | # Programming enable. | |
67 | # Note: The chip doesn't send any ACK for 'Programming enable'. | |
68 | self.putx([0, ['Programming enable']]) | |
69 | ||
70 | # Sanity check on reply. | |
71 | if ret[1:4] != [0xac, 0x53, cmd[2]]: | |
ad30cb46 | 72 | self.putx([8, ['Warning: Unexpected bytes in reply!']]) |
3bd76451 UH |
73 | |
74 | def handle_cmd_read_signature_byte_0x00(self, cmd, ret): | |
75 | # Signature byte 0x00: vendor code. | |
76 | self.vendor_code = ret[3] | |
77 | v = vendor_code[self.vendor_code] | |
ad30cb46 | 78 | self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]]) |
3bd76451 UH |
79 | |
80 | # Store for later. | |
81 | self.xx = cmd[1] # Same as ret[2]. | |
82 | self.yy = cmd[3] | |
83 | self.zz = ret[0] | |
84 | ||
85 | # Sanity check on reply. | |
86 | if ret[1] != 0x30 or ret[2] != cmd[1]: | |
ad30cb46 | 87 | self.putx([8, ['Warning: Unexpected bytes in reply!']]) |
3bd76451 UH |
88 | |
89 | # Sanity check for the vendor code. | |
90 | if self.vendor_code != VENDOR_CODE_ATMEL: | |
ad30cb46 | 91 | self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']]) |
3bd76451 UH |
92 | |
93 | def handle_cmd_read_signature_byte_0x01(self, cmd, ret): | |
94 | # Signature byte 0x01: part family and memory size. | |
95 | self.part_fam_flash_size = ret[3] | |
ad30cb46 | 96 | self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]]) |
3bd76451 UH |
97 | |
98 | # Store for later. | |
99 | self.mm = cmd[3] | |
100 | ||
101 | # Sanity check on reply. | |
102 | if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy: | |
ad30cb46 | 103 | self.putx([8, ['Warning: Unexpected bytes in reply!']]) |
3bd76451 UH |
104 | |
105 | def handle_cmd_read_signature_byte_0x02(self, cmd, ret): | |
106 | # Signature byte 0x02: part number. | |
107 | self.part_number = ret[3] | |
ad30cb46 | 108 | self.putx([3, ['Part number: 0x%02x' % ret[3]]]) |
3bd76451 UH |
109 | |
110 | # TODO: Fix range. | |
111 | p = part[(self.part_fam_flash_size, self.part_number)] | |
ad30cb46 | 112 | self.putx([3, ['Device: Atmel %s' % p]]) |
3bd76451 UH |
113 | |
114 | # Sanity check on reply. | |
115 | if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm: | |
ad30cb46 | 116 | self.putx([8, ['Warning: Unexpected bytes in reply!']]) |
3bd76451 UH |
117 | |
118 | self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0 | |
119 | ||
120 | def handle_cmd_chip_erase(self, cmd, ret): | |
1fd698dc UH |
121 | # Chip erase (erases both flash an EEPROM). |
122 | # Upon successful chip erase, the lock bits will also be erased. | |
123 | # The only way to end a Chip Erase cycle is to release RESET#. | |
ad30cb46 | 124 | self.putx([4, ['Chip erase']]) |
3bd76451 | 125 | |
1fd698dc UH |
126 | # TODO: Check/handle RESET#. |
127 | ||
128 | # Sanity check on reply. | |
129 | bit = (ret[2] & (1 << 7)) >> 7 | |
130 | if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]: | |
ad30cb46 | 131 | self.putx([8, ['Warning: Unexpected bytes in reply!']]) |
1fd698dc | 132 | |
3bd76451 UH |
133 | def handle_cmd_read_fuse_bits(self, cmd, ret): |
134 | # Read fuse bits. | |
ad30cb46 | 135 | self.putx([5, ['Read fuse bits: 0x%02x' % ret[3]]]) |
3bd76451 UH |
136 | |
137 | # TODO: Decode fuse bits. | |
138 | # TODO: Sanity check on reply. | |
139 | ||
140 | def handle_cmd_read_fuse_high_bits(self, cmd, ret): | |
141 | # Read fuse high bits. | |
ad30cb46 | 142 | self.putx([6, ['Read fuse high bits: 0x%02x' % ret[3]]]) |
3bd76451 UH |
143 | |
144 | # TODO: Decode fuse bits. | |
145 | # TODO: Sanity check on reply. | |
146 | ||
147 | def handle_cmd_read_extended_fuse_bits(self, cmd, ret): | |
148 | # Read extended fuse bits. | |
ad30cb46 | 149 | self.putx([7, ['Read extended fuse bits: 0x%02x' % ret[3]]]) |
3bd76451 UH |
150 | |
151 | # TODO: Decode fuse bits. | |
152 | # TODO: Sanity check on reply. | |
153 | ||
154 | def handle_command(self, cmd, ret): | |
155 | if cmd[:2] == [0xac, 0x53]: | |
156 | self.handle_cmd_programming_enable(cmd, ret) | |
157 | elif cmd[0] == 0xac and (cmd[1] & (1 << 7)) == (1 << 7): | |
158 | self.handle_cmd_chip_erase(cmd, ret) | |
159 | elif cmd[:3] == [0x50, 0x00, 0x00]: | |
160 | self.handle_cmd_read_fuse_bits(cmd, ret) | |
161 | elif cmd[:3] == [0x58, 0x08, 0x00]: | |
162 | self.handle_cmd_read_fuse_high_bits(cmd, ret) | |
163 | elif cmd[:3] == [0x50, 0x08, 0x00]: | |
164 | self.handle_cmd_read_extended_fuse_bits(cmd, ret) | |
165 | elif cmd[0] == 0x30 and cmd[2] == 0x00: | |
166 | self.handle_cmd_read_signature_byte_0x00(cmd, ret) | |
167 | elif cmd[0] == 0x30 and cmd[2] == 0x01: | |
168 | self.handle_cmd_read_signature_byte_0x01(cmd, ret) | |
169 | elif cmd[0] == 0x30 and cmd[2] == 0x02: | |
170 | self.handle_cmd_read_signature_byte_0x02(cmd, ret) | |
171 | else: | |
172 | c = '%02x %02x %02x %02x' % tuple(cmd) | |
173 | r = '%02x %02x %02x %02x' % tuple(ret) | |
174 | self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]]) | |
175 | ||
176 | def decode(self, ss, es, data): | |
177 | ptype, mosi, miso = data | |
178 | ||
ad30cb46 UH |
179 | # For now, only use DATA and BITS packets. |
180 | if ptype not in ('DATA', 'BITS'): | |
3bd76451 UH |
181 | return |
182 | ||
ad30cb46 UH |
183 | # Store the individual bit values and ss/es numbers. The next packet |
184 | # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one. | |
185 | if ptype == 'BITS': | |
186 | self.miso_bits, self.mosi_bits = miso, mosi | |
187 | return | |
3bd76451 UH |
188 | |
189 | self.ss, self.es = ss, es | |
190 | ||
011ed1a3 UH |
191 | if len(self.mosi_bytes) == 0: |
192 | self.cmd_ss = ss | |
193 | ||
3bd76451 UH |
194 | # Append new bytes. |
195 | self.mosi_bytes.append(mosi) | |
196 | self.miso_bytes.append(miso) | |
197 | ||
3bd76451 UH |
198 | # All commands consist of 4 bytes. |
199 | if len(self.mosi_bytes) < 4: | |
200 | return | |
201 | ||
202 | self.cmd_es = es | |
203 | ||
204 | self.handle_command(self.mosi_bytes, self.miso_bytes) | |
205 | ||
206 | self.mosi_bytes = [] | |
207 | self.miso_bytes = [] | |
208 |