X-Git-Url: http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Favr_isp%2Fpd.py;h=6a3a241015db89f7d21204fa9058a5bd6de06966;hp=68be0ca4a7708363bf01d5e778ff24ce2586ffbe;hb=HEAD;hpb=d523eae6e0617e6ad5055738ea4864deacae4313 diff --git a/decoders/avr_isp/pd.py b/decoders/avr_isp/pd.py index 68be0ca..9e3c5df 100644 --- a/decoders/avr_isp/pd.py +++ b/decoders/avr_isp/pd.py @@ -1,7 +1,7 @@ ## -## This file is part of the sigrok project. +## This file is part of the libsigrokdecode project. ## -## Copyright (C) 2012 Uwe Hermann +## Copyright (C) 2012-2014 Uwe Hermann ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -14,66 +14,83 @@ ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; if not, write to the Free Software -## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## along with this program; if not, see . ## -# AVR ISP protocol decoder - import sigrokdecode as srd from .parts import * +class Ann: + PE, RSB0, RSB1, RSB2, CE, RFB, RHFB, REFB, \ + RLB, REEM, RP, LPMP, WP, WARN, DEV, = range(15) + VENDOR_CODE_ATMEL = 0x1e class Decoder(srd.Decoder): - api_version = 1 + api_version = 3 id = 'avr_isp' name = 'AVR ISP' longname = 'AVR In-System Programming' - desc = 'Protocol for in-system programming Atmel AVR MCUs.' + desc = 'Atmel AVR In-System Programming (ISP) protocol.' license = 'gplv2+' - inputs = ['spi', 'logic'] - outputs = ['avr_isp'] - probes = [] - optional_probes = [ - {'id': 'reset', 'name': 'RESET#', 'desc': 'Target AVR MCU reset'}, - ] - options = {} - annotations = [ - ['Text', 'Human-readable text'], - ['Warnings', 'Human-readable warnings'], - ] - - def __init__(self, **kwargs): + inputs = ['spi'] + outputs = [] + tags = ['Debug/trace'] + annotations = ( + ('pe', 'Programming enable'), + ('rsb0', 'Read signature byte 0'), + ('rsb1', 'Read signature byte 1'), + ('rsb2', 'Read signature byte 2'), + ('ce', 'Chip erase'), + ('rfb', 'Read fuse bits'), + ('rhfb', 'Read high fuse bits'), + ('refb', 'Read extended fuse bits'), + ('rlb', 'Read lock bits'), + ('reem', 'Read EEPROM memory'), + ('rp', 'Read program memory'), + ('lpmp' , 'Load program memory page'), + ('wp', 'Write program memory'), + ('warning', 'Warning'), + ('dev', 'Device'), + ) + annotation_rows = ( + ('commands', 'Commands', (Ann.PE, Ann.RSB0, Ann.RSB1, Ann.RSB2, + Ann.CE, Ann.RFB, Ann.RHFB, Ann.REFB, + Ann.RLB, Ann.REEM, Ann.RP, Ann.LPMP, Ann.WP,)), + ('warnings', 'Warnings', (Ann.WARN,)), + ('devs', 'Devices', (Ann.DEV,)), + ) + + def __init__(self): + self.reset() + + def reset(self): self.state = 'IDLE' self.mosi_bytes, self.miso_bytes = [], [] - self.cmd_ss, self.cmd_es = 0, 0 + self.ss_cmd, self.es_cmd = 0, 0 self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0 + self.ss_device = None - def start(self, metadata): - # self.out_proto = self.add(srd.OUTPUT_PROTO, 'avr_isp') - self.out_ann = self.add(srd.OUTPUT_ANN, 'avr_isp') - - def report(self): - pass + def start(self): + self.out_ann = self.register(srd.OUTPUT_ANN) def putx(self, data): - self.put(self.cmd_ss, self.cmd_es, self.out_ann, data) + self.put(self.ss_cmd, self.es_cmd, self.out_ann, data) def handle_cmd_programming_enable(self, cmd, ret): # Programming enable. # Note: The chip doesn't send any ACK for 'Programming enable'. - self.putx([0, ['Programming enable']]) + self.putx([Ann.PE, ['Programming enable']]) # Sanity check on reply. if ret[1:4] != [0xac, 0x53, cmd[2]]: - self.putx([1, ['Warning: Unexpected bytes in reply!']]) + self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']]) def handle_cmd_read_signature_byte_0x00(self, cmd, ret): # Signature byte 0x00: vendor code. self.vendor_code = ret[3] v = vendor_code[self.vendor_code] - self.putx([0, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]]) + self.putx([Ann.RSB0, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]]) # Store for later. self.xx = cmd[1] # Same as ret[2]. @@ -82,36 +99,40 @@ class Decoder(srd.Decoder): # Sanity check on reply. if ret[1] != 0x30 or ret[2] != cmd[1]: - self.putx([1, ['Warning: Unexpected bytes in reply!']]) + self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']]) # Sanity check for the vendor code. if self.vendor_code != VENDOR_CODE_ATMEL: - self.putx([1, ['Warning: Vendor code was not 0x1e (Atmel)!']]) + self.putx([Ann.WARN, ['Warning: Vendor code was not 0x1e (Atmel)!']]) def handle_cmd_read_signature_byte_0x01(self, cmd, ret): # Signature byte 0x01: part family and memory size. self.part_fam_flash_size = ret[3] - self.putx([0, ['Part family / memory size: 0x%02x' % ret[3]]]) + self.putx([Ann.RSB1, ['Part family / memory size: 0x%02x' % ret[3]]]) # Store for later. self.mm = cmd[3] + self.ss_device = self.ss_cmd # Sanity check on reply. if ret[1] != 0x30 or ret[2] != cmd[1] or ret[0] != self.yy: - self.putx([1, ['Warning: Unexpected bytes in reply!']]) + self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']]) def handle_cmd_read_signature_byte_0x02(self, cmd, ret): # Signature byte 0x02: part number. self.part_number = ret[3] - self.putx([0, ['Part number: 0x%02x' % ret[3]]]) + self.putx([Ann.RSB2, ['Part number: 0x%02x' % ret[3]]]) - # TODO: Fix range. - p = part[(self.part_fam_flash_size, self.part_number)] - self.putx([0, ['Device: Atmel %s' % p]]) + # Part name if known + key = (self.part_fam_flash_size, self.part_number) + if key in part: + p = part[key] + data = [Ann.DEV, ['Device: Atmel %s' % p]] + self.put(self.ss_device, self.es_cmd, self.out_ann, data) # Sanity check on reply. if ret[1] != 0x30 or ret[2] != self.xx or ret[0] != self.mm: - self.putx([1, ['Warning: Unexpected bytes in reply!']]) + self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']]) self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0 @@ -119,36 +140,78 @@ class Decoder(srd.Decoder): # Chip erase (erases both flash an EEPROM). # Upon successful chip erase, the lock bits will also be erased. # The only way to end a Chip Erase cycle is to release RESET#. - self.putx([0, ['Chip erase']]) + self.putx([Ann.CE, ['Chip erase']]) # TODO: Check/handle RESET#. # Sanity check on reply. bit = (ret[2] & (1 << 7)) >> 7 if ret[1] != 0xac or bit != 1 or ret[3] != cmd[2]: - self.putx([1, ['Warning: Unexpected bytes in reply!']]) + self.putx([Ann.WARN, ['Warning: Unexpected bytes in reply!']]) def handle_cmd_read_fuse_bits(self, cmd, ret): # Read fuse bits. - self.putx([0, ['Read fuse bits: 0x%02x' % ret[3]]]) + self.putx([Ann.RFB, ['Read fuse bits: 0x%02x' % ret[3]]]) # TODO: Decode fuse bits. # TODO: Sanity check on reply. def handle_cmd_read_fuse_high_bits(self, cmd, ret): # Read fuse high bits. - self.putx([0, ['Read fuse high bits: 0x%02x' % ret[3]]]) + self.putx([Ann.RHFB, ['Read fuse high bits: 0x%02x' % ret[3]]]) # TODO: Decode fuse bits. # TODO: Sanity check on reply. def handle_cmd_read_extended_fuse_bits(self, cmd, ret): # Read extended fuse bits. - self.putx([0, ['Read extended fuse bits: 0x%02x' % ret[3]]]) + self.putx([Ann.REFB, ['Read extended fuse bits: 0x%02x' % ret[3]]]) # TODO: Decode fuse bits. # TODO: Sanity check on reply. + def handle_cmd_read_lock_bits(self, cmd, ret): + # Read lock bits + self.putx([Ann.RLB, ['Read lock bits: 0x%02x' % ret[3]]]) + + def handle_cmd_read_eeprom_memory(self, cmd, ret): + # Read EEPROM Memory + _addr = ((cmd[1] & 1) << 8) + cmd[2] + self.putx([Ann.REEM, ['Read EEPROM Memory: [0x%03x]: 0x%02x' % (_addr, ret[3])]]) + + def handle_cmd_read_program_memory(self, cmd, ret): + # Read Program Memory + _HL = 'Low' + _H = 'L' + if cmd[0] & 0x08: + _HL = 'High' + _H = 'H' + _addr = ((cmd[1] & 0x0f) << 8) + cmd[2] + self.putx([Ann.RP, [ + 'Read program memory %s: [0x%03x]: 0x%02x' % (_HL, _addr, ret[3]), + '[%03x%s]:%02x' % (_addr, _H, ret[3]), + '%02x' % ret[3] + ]]) + + def handle_cmd_load_program_memory_page(self, cmd, ret): + # Load Program Memory Page + _HL = 'Low' + _H = 'L' + if cmd[0] & 0x08: + _HL = 'High' + _H = 'H' + _addr = cmd[2] & 0x1F + self.putx([Ann.LPMP, [ + 'Load program memory page %s: [0x%03x]: 0x%02x' % (_HL, _addr, cmd[3]), + '[%03x%s]=%02x' % (_addr, _H, cmd[3]), + '%02x' % cmd[3] + ]]) + + def handle_cmd_write_program_memory_page(self, cmd, ret): + # Write Program Memory Page + _addr = ((cmd[1] & 0x0F) << 3) + (cmd[2] << 5) + self.putx([Ann.WP, ['Write program memory page: 0x%02x' % _addr]]) + def handle_command(self, cmd, ret): if cmd[:2] == [0xac, 0x53]: self.handle_cmd_programming_enable(cmd, ret) @@ -166,37 +229,50 @@ class Decoder(srd.Decoder): self.handle_cmd_read_signature_byte_0x01(cmd, ret) elif cmd[0] == 0x30 and cmd[2] == 0x02: self.handle_cmd_read_signature_byte_0x02(cmd, ret) + elif cmd[:2] == [0x58, 0x00]: + self.handle_cmd_read_lock_bits(cmd,ret) + elif cmd[0] == 0xa0 and (cmd[1] & (3 << 6)) == (0 << 6): + self.handle_cmd_read_eeprom_memory(cmd, ret) + elif (cmd[0] == 0x20 or cmd[0] == 0x28) and ((cmd[1] & 0xf0) == 0x00): + self.handle_cmd_read_program_memory(cmd, ret) + elif (cmd[0] == 0x40 or cmd[0] == 0x48) and ((cmd[1] & 0xf0) == 0x00): + self.handle_cmd_load_program_memory_page(cmd, ret) + elif (cmd[0] == 0x4C and ((cmd[1] & 0xf0) == 0x00)): + self.handle_cmd_write_program_memory_page(cmd, ret) else: c = '%02x %02x %02x %02x' % tuple(cmd) r = '%02x %02x %02x %02x' % tuple(ret) - self.putx([0, ['Unknown command: %s (reply: %s)!' % (c, r)]]) + self.putx([Ann.WARN, ['Unknown command: %s (reply: %s)!' % (c, r)]]) def decode(self, ss, es, data): ptype, mosi, miso = data - if ptype != 'DATA': + # For now, only use DATA and BITS packets. + if ptype not in ('DATA', 'BITS'): return - # self.put(0, 0, self.out_ann, - # [0, ['MOSI: 0x%02x, MISO: 0x%02x' % (mosi, miso)]]) + # Store the individual bit values and ss/es numbers. The next packet + # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one. + if ptype == 'BITS': + self.miso_bits, self.mosi_bits = miso, mosi + return self.ss, self.es = ss, es + if len(self.mosi_bytes) == 0: + self.ss_cmd = ss + # Append new bytes. self.mosi_bytes.append(mosi) self.miso_bytes.append(miso) - if len(self.mosi_bytes) == 0: - self.cmd_ss = ss - # All commands consist of 4 bytes. if len(self.mosi_bytes) < 4: return - self.cmd_es = es + self.es_cmd = es self.handle_command(self.mosi_bytes, self.miso_bytes) self.mosi_bytes = [] self.miso_bytes = [] -