decoders/avr_isp/pd.py

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