Update dfu-convert.py build util to support python 3.
[SCSI2SD-V6.git] / tools / dfu-convert.py
1 #!/usr/bin/env python
2
3 # Written by Antonio Galea - 2010/11/18
4 # Distributed under Gnu LGPL 3.0
5 # see http://www.gnu.org/licenses/lgpl-3.0.txt
6 #
7 # Removed ihex functionality and dependency, Bitcraze - 2014-12-11
8 # Added support for python3, Bitcraze - 2020-02-18
9
10 import sys,struct,zlib,os
11 from optparse import OptionParser
12
13 python3 = False
14 if (sys.version_info > (3, 0)):
15       python3 = True
16
17 DEFAULT_DEVICE="0x0483:0xdf11"
18
19 def named(tuple,names):
20   return dict(zip(names.split(),tuple))
21 def consume(fmt,data,names):
22   n = struct.calcsize(fmt)
23   return named(struct.unpack(fmt,data[:n]),names),data[n:]
24 def cstring(string):
25   return string.split('\0',1)[0]
26 def compute_crc(data):
27   return 0xFFFFFFFF & -zlib.crc32(data) -1
28
29 def parse(file,dump_images=False):
30   print('File: "%s"' % file)
31   data = open(file,'rb').read()
32   crc = compute_crc(data[:-4])
33   prefix, data = consume('<5sBIB',data,'signature version size targets')
34   print('%(signature)s v%(version)d, image size: %(size)d, targets: %(targets)d' % prefix)
35   for t in range(prefix['targets']):
36     tprefix, data  = consume('<6sBI255s2I',data,'signature altsetting named name size elements')
37     tprefix['num'] = t
38     if tprefix['named']:
39       tprefix['name'] = cstring(tprefix['name'])
40     else:
41       tprefix['name'] = ''
42     print('%(signature)s %(num)d, alt setting: %(altsetting)s, name: "%(name)s", size: %(size)d, elements: %(elements)d' % tprefix)
43     tsize = tprefix['size']
44     target, data = data[:tsize], data[tsize:]
45     for e in range(tprefix['elements']):
46       eprefix, target = consume('<2I',target,'address size')
47       eprefix['num'] = e
48       print('  %(num)d, address: 0x%(address)08x, size: %(size)d' % eprefix)
49       esize = eprefix['size']
50       image, target = target[:esize], target[esize:]
51       if dump_images:
52         out = '%s.target%d.image%d.bin' % (file,t,e)
53         open(out,'wb').write(image)
54         print('    DUMPED IMAGE TO "%s"' % out)
55     if len(target):
56       print("target %d: PARSE ERROR" % t)
57   suffix = named(struct.unpack('<4H3sBI',data[:16]),'device product vendor dfu ufd len crc')
58   print('usb: %(vendor)04x:%(product)04x, device: 0x%(device)04x, dfu: 0x%(dfu)04x, %(ufd)s, %(len)d, 0x%(crc)08x' % suffix)
59   if crc != suffix['crc']:
60     print("CRC ERROR: computed crc32 is 0x%08x" % crc)
61   data = data[16:]
62   if data:
63     print("PARSE ERROR")
64
65 def build(file,targets,device=DEFAULT_DEVICE):
66   data = ''
67   if (python3):
68         data = b''
69   for t,target in enumerate(targets):
70     tdata = ''
71     if (python3):
72           tdata = b''
73     for image in target:
74       tdata += struct.pack('<2I',image['address'],len(image['data']))+image['data']
75
76     trgt = 'Target'
77     st = 'ST...'
78     if (python3):
79       trgt = b'Target'
80       st = b'ST...'
81     tdata = struct.pack('<6sBI255s2I',trgt,0,1,st,len(tdata),len(target)) + tdata
82     data += tdata
83
84   dfu_se = 'DfuSe'
85   ufd = 'UFD'
86   if (python3):
87     dfu_se = b'DfuSe'
88     ufd = b'UFD'
89   data  = struct.pack('<5sBIB',dfu_se,1,len(data)+11,len(targets)) + data
90
91   v,d=map(lambda x: int(x,0) & 0xFFFF, device.split(':',1))
92   data += struct.pack('<4H3sB',0,d,v,0x011a,ufd,16)
93   crc   = compute_crc(data)
94   data += struct.pack('<I',crc)
95   open(file,'wb').write(data)
96
97 if __name__=="__main__":
98   usage = """
99 %prog [-d|--dump] infile.dfu
100 %prog {-b|--build} address:file.bin [-b address:file.bin ...] [{-D|--device}=vendor:device] outfile.dfu"""
101
102   parser = OptionParser(usage=usage)
103   parser.add_option("-b", "--build", action="append", dest="binfiles",
104     help="build a DFU file from given BINFILES", metavar="BINFILES")
105   parser.add_option("-D", "--device", action="store", dest="device",
106     help="build for DEVICE, defaults to %s" % DEFAULT_DEVICE, metavar="DEVICE")
107   parser.add_option("-d", "--dump", action="store_true", dest="dump_images",
108     default=False, help="dump contained images to current directory")
109   (options, args) = parser.parse_args()
110
111   if options.binfiles and len(args)==1:
112     target = []
113
114     if options.binfiles:
115       for arg in options.binfiles:
116         try:
117           address,binfile = arg.split(':',1)
118         except ValueError:
119           print("Address:file couple '%s' invalid." % arg)
120           sys.exit(1)
121         try:
122           address = int(address,0) & 0xFFFFFFFF
123         except ValueError:
124           print("Address %s invalid." % address)
125           sys.exit(1)
126         if not os.path.isfile(binfile):
127           print("Unreadable file '%s'." % binfile)
128           sys.exit(1)
129         target.append({ 'address': address, 'data': open(binfile,'rb').read() })
130
131     outfile = args[0]
132     device = DEFAULT_DEVICE
133     if options.device:
134       device=options.device
135     try:
136       v,d=map(lambda x: int(x,0) & 0xFFFF, device.split(':',1))
137     except:
138       print("Invalid device '%s'." % device)
139       sys.exit(1)
140     build(outfile,[target],device)
141   elif len(args)==1:
142     infile = args[0]
143     if not os.path.isfile(infile):
144       print("Unreadable file '%s'." % infile)
145       sys.exit(1)
146     parse(infile, dump_images=options.dump_images)
147   else:
148     parser.print_help()
149     sys.exit(1)