3 ## This file is part of the sigrok-util project.
5 ## Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
7 ## This program is free software; you can redistribute it and/or modify
8 ## it under the terms of the GNU General Public License as published by
9 ## the Free Software Foundation; either version 3 of the License, or
10 ## (at your option) any later version.
12 ## This program is distributed in the hope that it will be useful,
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ## GNU General Public License for more details.
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
21 # This utility extracts FX2 MCU firmware and FPGA bitstream images from
22 # the "KingstVIS" vendor software. The blobs are kept in Qt resources
23 # sections. The script was tested with several v3.5 software versions.
34 # Reuse the parseelf.py module from saleae-logic16.
35 fwdir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
36 parseelf_py = os.path.join(fwdir, "saleae-logic16", "parseelf.py")
37 spec = importlib.util.spec_from_file_location("parseelf", parseelf_py)
38 parseelf = importlib.util.module_from_spec(spec)
39 spec.loader.exec_module(parseelf)
41 class qt_resources(object):
42 def __init__(self, program):
43 self._elf = parseelf.elf(program)
44 self._elf_sections = {} # idx -> data
45 self._read_resources()
47 def _get_elf_section(self, idx):
48 s = self._elf_sections.get(idx)
50 shdr = self._elf.shdrs[idx]
51 s = self._elf.read_section(shdr), shdr
52 self._elf_sections[idx] = s
55 def _get_elf_sym_value(self, sname):
56 sym = self._elf.symtab[sname]
57 section, shdr = self._get_elf_section(sym["st_shndx"])
58 addr = sym["st_value"] - shdr["sh_addr"]
59 value = section[addr:addr + sym["st_size"]]
60 if len(value) != sym["st_size"]:
61 print("warning: symbol %s should be %d bytes, but in section is only %d bytes" % (
62 sname, sym["st_size"], len(value)))
66 def _get_resource_name(self, offset):
67 length, i = struct.unpack(">HI", self._res_names[offset:offset + 2 + 4])
69 name = self._res_names[offset:offset + 2 * length].decode("utf-16be")
72 def _get_resource_data(self, offset):
73 length = struct.unpack(">I", self._res_datas[offset:offset + 4])[0]
75 return self._res_datas[offset:offset + length]
77 def _read_resources(self):
78 RCCFileInfo_Directory = 0x02
82 while offset < len(self._res_struct):
83 name_offset, flags = struct.unpack(">IH", self._res_struct[offset:offset+4+2])
85 name = self._get_resource_name(name_offset)
86 if flags & RCCFileInfo_Directory:
87 child_count, first_child_offset = struct.unpack(">II", self._res_struct[offset:offset + 4 + 4])
89 table.append((name, flags, child_count, first_child_offset))
91 country, language, data_offset = struct.unpack(">HHI", self._res_struct[offset:offset + 2 + 2 + 4])
93 table.append((name, flags, country, language, data_offset))
95 def read_dir_entries(table, which, parents=[]):
96 name, flags = which[:2]
97 if not flags & RCCFileInfo_Directory:
98 raise Exception("not a directory!")
99 child_count, first_child = which[2:]
100 for i in range(child_count):
101 child = table[first_child + i]
102 if child[1] & RCCFileInfo_Directory:
103 read_dir_entries(table, child, parents + [child[0]])
105 country, language, data_offset = child[2:]
106 full_name = "/".join(parents + [child[0]])
107 self._resources[full_name] = data_offset
109 self._res_datas = self._get_elf_sym_value("_ZL16qt_resource_data")
110 self._res_names = self._get_elf_sym_value("_ZL16qt_resource_name")
111 self._res_struct = self._get_elf_sym_value("_ZL18qt_resource_struct")
113 self._resources = {} # res_fn -> res_offset
115 read_dir_entries(table, table[0])
117 def get_resource(self, res_fn):
118 offset = self._resources[res_fn]
119 data = self._get_resource_data(offset)
122 def find_resource_names(self, res_fn_re):
123 for key in self._resources.keys():
124 m = re.match(res_fn_re, key)
128 class res_writer(object):
129 def __init__(self, res):
132 def _write_file(self, fn, data, decoder=None, zero_pad_to=None):
133 if decoder is not None:
135 if zero_pad_to is not None:
136 if len(data) > zero_pad_to:
137 raise Exception("can not zero_pad_to %d bytes -- data is already %d bytes" % (zero_pad_to, len(data)))
138 data += b"\0" * (zero_pad_to - len(data))
139 with open(fn, "wb") as fp:
141 data_crc32 = zlib.crc32(data) & 0xffffffff
142 print("saved %d bytes to %s (crc32=%08x)" % (len(data), fn, data_crc32))
144 def extract(self, res_fn, out_fn, decoder=None, zero_pad_to=None):
145 self._write_file(out_fn, self.res.get_resource(res_fn), decoder=decoder, zero_pad_to=zero_pad_to)
147 def extract_re(self, res_fn_re, out_fn, decoder=None):
148 for res_fn in res.find_resource_names(res_fn_re):
149 fn = re.sub(res_fn_re, out_fn, res_fn).lower()
150 self._write_file(fn, self.res.get_resource(res_fn), decoder=decoder)
152 def decode_intel_hex(hexdata):
153 """ return list of (address, data)
156 # Assume LF-only or CR-LF style end-of-line.
157 for line in hexdata.split(b"\n"):
159 if chr(line[0]) != ":": raise Exception("invalid line: %r" % line)
161 record = codecs.decode(line[offset:], "hex")
162 byte_count, address, record_type = struct.unpack(">BHB", record[:1 + 2 + 1])
165 data = record[offset:offset + byte_count]
167 checksum = record[offset]
168 ex_checksum = (~sum(record[:offset]) + 1) & 0xff
169 if ex_checksum != checksum: raise Exception("invalid checksum %#x in %r" % (checksum, line))
171 datas.append((address, data))
172 elif record_type == 1:
176 def intel_hex_as_blob(hexdata):
177 """ return continuous bytes sequence including all data
178 (loosing start address here)
180 data = decode_intel_hex(hexdata)
183 length = last[0] + len(last[1])
184 img = bytearray(length)
185 for off, part in data:
186 img[off:off + len(part)] = part
189 def maybe_intel_hex_as_blob(data):
190 if data[0] == ord(":") and max(data) < 127:
191 return intel_hex_as_blob(data)
192 return data # Keep binary data.
194 if __name__ == "__main__":
195 parser = argparse.ArgumentParser(description = "KingstVIS firmware extraction")
196 parser.add_argument('executable', help = "KingstVIS executable file")
197 options = parser.parse_args()
198 exe_fn = options.executable
200 res = qt_resources(exe_fn)
201 writer = res_writer(res)
203 # Extract all MCU firmware and FPGA bitstream images. The sigrok
204 # project may not cover all KingstVIS supported devices. Users can
205 # either just copy those files which are strictly required for their
206 # specific device (diagnostics will identify those). Or just copy a
207 # few more files while some of them remain unused later (their size
208 # is small). Seeing which files would be contained is considered
209 # valuable, to identify device variants or candidate models.
210 writer.extract_re(r"fwusb/fw(.*)", r"kingst-la-\1.fw", decoder=maybe_intel_hex_as_blob)
211 writer.extract_re(r"fwfpga/(.*)", r"kingst-\1-fpga.bitstream")