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