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, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21 from .parts import *
  22
  23 VENDOR_CODE_ATMEL = 0x1e
  24
  25 class Decoder(srd.Decoder):
  26     api_version = 3
  27     id = 'avr_isp'
  28     name = 'AVR ISP'
  29     longname = 'AVR In-System Programming'
  30     desc = 'Protocol for in-system programming Atmel AVR MCUs.'
  31     license = 'gplv2+'
  32     inputs = ['spi']
  33     outputs = ['avr_isp']
  34     annotations = (
  35         ('pe', 'Programming enable'),
  36         ('rsb0', 'Read signature byte 0'),
  37         ('rsb1', 'Read signature byte 1'),
  38         ('rsb2', 'Read signature byte 2'),
  39         ('ce', 'Chip erase'),
  40         ('rfb', 'Read fuse bits'),
  41         ('rhfb', 'Read high fuse bits'),
  42         ('refb', 'Read extended fuse bits'),
  43         ('warnings', 'Warnings'),
  44         ('dev', 'Device'),
  45     )
  46     annotation_rows = (
  47         ('bits', 'Bits', ()),
  48         ('commands', 'Commands', tuple(range(7 + 1))),
  49         ('warnings', 'Warnings', (8,)),
  50         ('dev', 'Device', (9,)),
  51     )
  52
  53     def __init__(self):
  54         self.reset()
  55
  56     def reset(self):
  57         self.state = 'IDLE'
  58         self.mosi_bytes, self.miso_bytes = [], []
  59         self.ss_cmd, self.es_cmd = 0, 0
  60         self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
  61         self.ss_device = None
  62
  63     def start(self):
  64         self.out_ann = self.register(srd.OUTPUT_ANN)
  65
  66     def putx(self, data):
  67         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
  68
  69     def handle_cmd_programming_enable(self, cmd, ret):
  70         # Programming enable.
  71         # Note: The chip doesn't send any ACK for 'Programming enable'.
  72         self.putx([0, ['Programming enable']])
  73
  74         # Sanity check on reply.
  75         if ret[1:4] != [0xac, 0x53, cmd[2]]:
  76             self.putx([8, ['Warning: Unexpected bytes in reply!']])
  77
  78     def handle_cmd_read_signature_byte_0x00(self, cmd, ret):
  79         # Signature byte 0x00: vendor code.
  80         self.vendor_code = ret[3]
  81         v = vendor_code[self.vendor_code]
  82         self.putx([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
  83
  84         # Store for later.
  85         self.xx = cmd[1] # Same as ret[2].
  86         self.yy = cmd[3]
  87         self.zz = ret[0]
  88
  89         # Sanity check on reply.
  90         if ret[1] != 0x30 or ret[2] != cmd[1]:
  91             self.putx([8, ['Warning: Unexpected bytes in reply!']])
  92
  93         # Sanity check for the vendor code.
  94         if self.vendor_code != VENDOR_CODE_ATMEL:
  95             self.putx([8, ['Warning: Vendor code was not 0x1e (Atmel)!']])
  96
  97     def handle_cmd_read_signature_byte_0x01(self, cmd, ret):
  98         # Signature byte 0x01: part family and memory size.
  99         self.part_fam_flash_size = ret[3]
 100         self.putx([2, ['Part family / memory size: 0x%02x' % ret[3]]])
 101
 102         # Store for later.
 103         self.mm = cmd[3]
 104         self.ss_device = self.ss_cmd
 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         p = part[(self.part_fam_flash_size, self.part_number)]
 116         data = [9, ['Device: Atmel %s' % p]]
 117         self.put(self.ss_device, self.es_cmd, self.out_ann, data)
 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.ss_cmd = 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.es_cmd = es
 208
 209         self.handle_command(self.mosi_bytes, self.miso_bytes)
 210
 211         self.mosi_bytes = []
 212         self.miso_bytes = []