]>
Commit | Line | Data |
---|---|---|
3bd76451 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
3bd76451 UH |
3 | ## |
4 | ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de> | |
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 = [ | |
9f2f42c0 UH |
41 | ['text', 'Human-readable text'], |
42 | ['warnings', 'Human-readable warnings'], | |
3bd76451 UH |
43 | ] |
44 | ||
45 | def __init__(self, **kwargs): | |
46 | self.state = 'IDLE' | |
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 | |
50 | ||
8915b346 | 51 | def start(self): |
c515eed7 | 52 | # self.out_python = self.register(srd.OUTPUT_PYTHON) |
be465111 | 53 | self.out_ann = self.register(srd.OUTPUT_ANN) |
3bd76451 | 54 | |
3bd76451 UH |
55 | def putx(self, data): |
56 | self.put(self.cmd_ss, self.cmd_es, self.out_ann, data) | |
57 | ||
58 | def handle_cmd_programming_enable(self, cmd, ret): | |
59 | # Programming enable. | |
60 | # Note: The chip doesn't send any ACK for 'Programming enable'. | |
61 | self.putx([0, ['Programming enable']]) | |
62 | ||
63 | # Sanity check on reply. | |
64 | if ret[1:4] != [0xac, 0x53, cmd[2]]: | |
65 | self.putx([1, ['Warning: Unexpected bytes in reply!']]) | |
66 | ||
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)]]) | |
72 | ||
73 | # Store for later. | |
74 | self.xx = cmd[1] # Same as ret[2]. | |
75 | self.yy = cmd[3] | |
76 | self.zz = ret[0] | |
77 | ||
78 | # Sanity check on reply. | |
79 | if ret[1] != 0x30 or ret[2] != cmd[1]: | |
80 | self.putx([1, ['Warning: Unexpected bytes in reply!']]) | |
81 | ||
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)!']]) | |
85 | ||
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]]]) | |
90 | ||
91 | # Store for later. | |
92 | self.mm = cmd[3] | |
93 | ||
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!']]) | |
97 | ||
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]]]) | |
102 | ||
103 | # TODO: Fix range. | |
104 | p = part[(self.part_fam_flash_size, self.part_number)] | |
105 | self.putx([0, ['Device: Atmel %s' % p]]) | |
106 | ||
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!']]) | |
110 | ||
111 | self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0 | |
112 | ||
113 | def handle_cmd_chip_erase(self, cmd, ret): | |
1fd698dc UH |
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#. | |
3bd76451 UH |
117 | self.putx([0, ['Chip erase']]) |
118 | ||
1fd698dc UH |
119 | # TODO: Check/handle RESET#. |
120 | ||
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!']]) | |
125 | ||
3bd76451 UH |
126 | def handle_cmd_read_fuse_bits(self, cmd, ret): |
127 | # Read fuse bits. | |
128 | self.putx([0, ['Read fuse bits: 0x%02x' % ret[3]]]) | |
129 | ||
130 | # TODO: Decode fuse bits. | |
131 | # TODO: Sanity check on reply. | |
132 | ||
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]]]) | |
136 | ||
137 | # TODO: Decode fuse bits. | |
138 | # TODO: Sanity check on reply. | |
139 | ||
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]]]) | |
143 | ||
144 | # TODO: Decode fuse bits. | |
145 | # TODO: Sanity check on reply. | |
146 | ||
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) | |
164 | else: | |
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)]]) | |
168 | ||
169 | def decode(self, ss, es, data): | |
170 | ptype, mosi, miso = data | |
171 | ||
172 | if ptype != 'DATA': | |
173 | return | |
174 | ||
175 | # self.put(0, 0, self.out_ann, | |
176 | # [0, ['MOSI: 0x%02x, MISO: 0x%02x' % (mosi, miso)]]) | |
177 | ||
178 | self.ss, self.es = ss, es | |
179 | ||
180 | # Append new bytes. | |
181 | self.mosi_bytes.append(mosi) | |
182 | self.miso_bytes.append(miso) | |
183 | ||
184 | if len(self.mosi_bytes) == 0: | |
185 | self.cmd_ss = ss | |
186 | ||
187 | # All commands consist of 4 bytes. | |
188 | if len(self.mosi_bytes) < 4: | |
189 | return | |
190 | ||
191 | self.cmd_es = es | |
192 | ||
193 | self.handle_command(self.mosi_bytes, self.miso_bytes) | |
194 | ||
195 | self.mosi_bytes = [] | |
196 | self.miso_bytes = [] | |
197 |