firmware/kingst-la: remove redundant manpage conversion output

[sigrok-util.git] / firmware / kingst-la / sigrok-fwextract-kingst-la2016

diff --git a/firmware/kingst-la/sigrok-fwextract-kingst-la2016 b/firmware/kingst-la/sigrok-fwextract-kingst-la2016
index 8d9e1b4eb78b0069428edaf4172aa91546dd6716..4357994207762fadb837fbcf5d9d92ff8dc5f9cb 100755 (executable)
--- a/firmware/kingst-la/sigrok-fwextract-kingst-la2016
+++ b/firmware/kingst-la/sigrok-fwextract-kingst-la2016
@@ -24,6 +24,7 @@ import re
 import struct
 import codecs
 import importlib.util
+import zlib
 
 # reuse parseelf.py module from saleae-logic16:
 fwdir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -45,7 +46,7 @@ class qt_resources(object):
             s = self._elf.read_section(shdr), shdr
             self._elf_sections[idx] = s
         return s
-    
+
     def _get_elf_sym_value(self, sname):
         sym = self._elf.symtab[sname]
         section, shdr = self._get_elf_section(sym["st_shndx"])
@@ -55,19 +56,19 @@ class qt_resources(object):
             print("warning: symbol %s should be %d bytes, but in section is only %d bytes" % (
                 sname, sym["st_size"], len(value)))
         return value
-    
+
     # qt resource stuff:
     def _get_resource_name(self, offset):
         length, i = struct.unpack(">HI", self._res_names[offset:offset + 2 + 4])
         offset += 2 + 4
         name = self._res_names[offset:offset + 2 * length].decode("utf-16be")
         return name
-    
+
     def _get_resource_data(self, offset):
         length = struct.unpack(">I", self._res_datas[offset:offset + 4])[0]
         offset += 4
         return self._res_datas[offset:offset + length]
-    
+
     def _read_resources(self):
         RCCFileInfo_Directory = 0x02
         def read_table():
@@ -93,17 +94,17 @@ class qt_resources(object):
             child_count, first_child = which[2:]
             for i in range(child_count):
                 child = table[first_child + i]
-                if child[1] & RCCFileInfo_Directory:                
+                if child[1] & RCCFileInfo_Directory:
                     read_dir_entries(table, child, parents + [child[0]])
                 else:
                     country, language, data_offset = child[2:]
                     full_name = "/".join(parents + [child[0]])
                     self._resources[full_name] = data_offset
-        
+
         self._res_datas = self._get_elf_sym_value("_ZL16qt_resource_data")
         self._res_names = self._get_elf_sym_value("_ZL16qt_resource_name")
         self._res_struct = self._get_elf_sym_value("_ZL18qt_resource_struct")
-        
+
         self._resources = {} # res_fn -> res_offset
         table = read_table()
         read_dir_entries(table, table[0])
@@ -118,21 +119,26 @@ class qt_resources(object):
             m = re.match(res_fn_re, key)
             if m is not None:
                 yield key
-    
+
 class res_writer(object):
     def __init__(self, res):
         self.res = res
-        
-    def _write_file(self, fn, data, decoder=None):
+
+    def _write_file(self, fn, data, decoder=None, zero_pad_to=None):
         if decoder is not None:
             data = decoder(data)
+        if zero_pad_to is not None:
+            if len(data) > zero_pad_to:
+                raise Exception("can not zero_pad_to %d bytes -- data is already %d bytes" % (zero_pad_to, len(data)))
+            data += b"\0" * (zero_pad_to - len(data))
         with open(fn, "wb") as fp:
             fp.write(data)
-        print("saved %d bytes to %s" % (len(data), fn))
-        
-    def extract(self, res_fn, out_fn, decoder=None):
-        self._write_file(out_fn, self.res.get_resource(res_fn), decoder=decoder)
-    
+        data_crc32 = zlib.crc32(data) & 0xffffffff
+        print("saved %d bytes to %s (crc32=%08x)" % (len(data), fn, data_crc32))
+
+    def extract(self, res_fn, out_fn, decoder=None, zero_pad_to=None):
+        self._write_file(out_fn, self.res.get_resource(res_fn), decoder=decoder, zero_pad_to=zero_pad_to)
+
     def extract_re(self, res_fn_re, out_fn, decoder=None):
         for res_fn in res.find_resource_names(res_fn_re):
             fn = re.sub(res_fn_re, out_fn, res_fn).lower()
@@ -184,9 +190,35 @@ if __name__ == "__main__":
     if len(sys.argv) != 2:
         print("sigrok-fwextract-kingst-la2016 <programfile>")
         sys.exit()
-    
+
     res = qt_resources(sys.argv[1])
-    
+
     writer = res_writer(res)
-    writer.extract("fwfpga/LA2016A", "kingst-la2016a-fpga.bitstream")
-    writer.extract_re(r"fwusb/fw(.*)", r"kingst-la-\1.fw", decoder=maybe_intel_hex_as_blob)
+
+    '''
+    05-APR-2021
+    This extraction script has been tested with the
+    vendor software versions v3.5.0 and v3.5.1
+    These files were extracted and tested successfully:
+    saved 5430 bytes to kingst-la-01a2.fw (crc32=720551a9)
+    saved 178362 bytes to kingst-la2016a1-fpga.bitstream (crc32=7cc894fa)
+    saved 178542 bytes to kingst-la2016-fpga.bitstream (crc32=20694ff1)
+    saved 178379 bytes to kingst-la1016a1-fpga.bitstream (crc32=166866be)
+    saved 178151 bytes to kingst-la1016-fpga.bitstream (crc32=7db70001)
+    '''
+
+    # extract all firmware and fpga bitstreams
+    # writer.extract_re(r"fwfpga/(.*)", r"kingst-\1-fpga.bitstream")
+    # writer.extract_re(r"fwusb/fw(.*)", r"kingst-la-\1.fw", decoder=maybe_intel_hex_as_blob)
+
+    # extract fx2 mcu firmware for both the la2016 and la1016
+    # note that 0x01a2 is the usb pid for both of these devices
+    writer.extract_re("fwusb/fw01A2", "kingst-la-01a2.fw", decoder=maybe_intel_hex_as_blob)
+
+    # extract fpga bitstreams for la2016
+    # there are two bitstreams, newer hardware uses the 'a1' bitstream
+    writer.extract_re("fwfpga/LA2016(.*)", r"kingst-la2016\1-fpga.bitstream")
+
+    # extract fpga bitstreams for la1016
+    # there are two bitstreams, newer hardware uses the 'a1' bitstream
+    writer.extract_re("fwfpga/LA1016(.*)", r"kingst-la1016\1-fpga.bitstream")