]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/avr_isp/pd.py
license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / avr_isp / pd.py
index be8ee29fee464054b3e3ceddd61a11e579fee8e6..6a3a241015db89f7d21204fa9058a5bd6de06966 100644 (file)
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## 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,8 +14,7 @@
 ## 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 <http://www.gnu.org/licenses/>.
 ##
 
 import sigrokdecode as srd
@@ -24,36 +23,45 @@ from .parts import *
 VENDOR_CODE_ATMEL = 0x1e
 
 class Decoder(srd.Decoder):
-    api_version = 1
+    api_version = 2
     id = 'avr_isp'
     name = 'AVR ISP'
     longname = 'AVR In-System Programming'
     desc = 'Protocol for in-system programming Atmel AVR MCUs.'
     license = 'gplv2+'
-    inputs = ['spi', 'logic']
+    inputs = ['spi']
     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):
+    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'),
+        ('warnings', 'Warnings'),
+        ('dev', 'Device'),
+    )
+    annotation_rows = (
+        ('bits', 'Bits', ()),
+        ('commands', 'Commands', tuple(range(7 + 1))),
+        ('warnings', 'Warnings', (8,)),
+        ('dev', 'Device', (9,)),
+    )
+
+    def __init__(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):
-        # self.out_python = self.register(srd.OUTPUT_PYTHON)
         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.
@@ -62,13 +70,13 @@ class Decoder(srd.Decoder):
 
         # Sanity check on reply.
         if ret[1:4] != [0xac, 0x53, cmd[2]]:
-            self.putx([1, ['Warning: Unexpected bytes in reply!']])
+            self.putx([8, ['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([1, ['Vendor code: 0x%02x (%s)' % (ret[3], v)]])
 
         # Store for later.
         self.xx = cmd[1] # Same as ret[2].
@@ -77,36 +85,37 @@ 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([8, ['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([8, ['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([2, ['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([8, ['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([3, ['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]])
+        data = [9, ['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([8, ['Warning: Unexpected bytes in reply!']])
 
         self.xx, self.yy, self.zz, self.mm = 0, 0, 0, 0
 
@@ -114,32 +123,32 @@ 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([4, ['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([8, ['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([5, ['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([6, ['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([7, ['Read extended fuse bits: 0x%02x' % ret[3]]])
 
         # TODO: Decode fuse bits.
         # TODO: Sanity check on reply.
@@ -169,29 +178,32 @@ class Decoder(srd.Decoder):
     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 = []
-