3 # Copyright (C) 2010 Michael Buesch <mb@bu3sch.de>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License version 2
7 # as published by the Free Software Foundation.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
18 def indexToName(index):
19 D11UCODE_NAMETAG_START = 0
20 D11LCN0BSINITVALS24 = 1
22 D11LCN1BSINITVALS24 = 3
24 D11LCN2BSINITVALS24 = 5
26 D11N0ABSINITVALS16 = 7
29 D11UCODE_OVERSIGHT16_MIMO = 10
30 D11UCODE_OVERSIGHT16_MIMOSZ = 11
31 D11UCODE_OVERSIGHT24_LCN = 12
32 D11UCODE_OVERSIGHT24_LCNSZ = 13
33 D11UCODE_OVERSIGHT_BOMMAJOR = 14
34 D11UCODE_OVERSIGHT_BOMMINOR = 15
37 D11UCODE_NAMETAG_START : "start",
38 D11LCN0BSINITVALS24 : "LCN0 bs initvals 24",
39 D11LCN0INITVALS24 : "LCN0 initvals 24",
40 D11LCN1BSINITVALS24 : "LCN1 bs initvals 24",
41 D11LCN1INITVALS24 : "LCN1 initvals 24",
42 D11LCN2BSINITVALS24 : "LCN2 bs initvals 24",
43 D11LCN2INITVALS24 : "LCN2 initvals 24",
44 D11N0ABSINITVALS16 : "N0A bs initvals 16",
45 D11N0BSINITVALS16 : "N0 bs initvals 16",
46 D11N0INITVALS16 : "N0 initvals 16",
47 D11UCODE_OVERSIGHT16_MIMO : "microcode 16 MIMO",
48 D11UCODE_OVERSIGHT16_MIMOSZ : "microcode 16 MIMO size",
49 D11UCODE_OVERSIGHT24_LCN : "microcode 24 LCN",
50 D11UCODE_OVERSIGHT24_LCNSZ : "microcode 24 LCN size",
51 D11UCODE_OVERSIGHT_BOMMAJOR : "bom major",
52 D11UCODE_OVERSIGHT_BOMMINOR : "bom minor",
59 def parseHeader(hdr_data):
61 for i in range(0, len(hdr_data), 3 * 4):
62 offset = ord(hdr_data[i + 0]) | (ord(hdr_data[i + 1]) << 8) |\
63 (ord(hdr_data[i + 2]) << 16) | (ord(hdr_data[i + 3]) << 24)
64 length = ord(hdr_data[i + 4]) | (ord(hdr_data[i + 5]) << 8) |\
65 (ord(hdr_data[i + 6]) << 16) | (ord(hdr_data[i + 7]) << 24)
66 index = ord(hdr_data[i + 8]) | (ord(hdr_data[i + 9]) << 8) |\
67 (ord(hdr_data[i + 10]) << 16) | (ord(hdr_data[i + 11]) << 24)
69 sections.append( (offset, length, index) )
70 sections.sort(key = lambda x: x[2]) # Sort by index
73 def generateHeaderData(sections):
75 for section in sections:
76 (offset, length, index) = section
77 data.append(chr(offset & 0xFF))
78 data.append(chr((offset >> 8) & 0xFF))
79 data.append(chr((offset >> 16) & 0xFF))
80 data.append(chr((offset >> 24) & 0xFF))
81 data.append(chr(length & 0xFF))
82 data.append(chr((length >> 8) & 0xFF))
83 data.append(chr((length >> 16) & 0xFF))
84 data.append(chr((length >> 24) & 0xFF))
85 data.append(chr(index & 0xFF))
86 data.append(chr((index >> 8) & 0xFF))
87 data.append(chr((index >> 16) & 0xFF))
88 data.append(chr((index >> 24) & 0xFF))
91 def getSectionByIndex(sections, searchIndex):
92 for section in sections:
93 (offset, length, index) = section
94 if searchIndex == index:
98 def parseHeaderFile(hdr_filepath):
100 hdr_data = file(hdr_filepath, "rb").read()
102 print "Failed to read header file: %s" % e.strerror
104 if len(hdr_data) % (3 * 4) != 0:
105 print "Invalid header file format"
107 return parseHeader(hdr_data)
109 def dumpInfo(hdr_filepath):
110 sections = parseHeaderFile(hdr_filepath)
113 for section in sections:
114 (offset, length, index) = section
115 print "Index %2d %24s ==> offset:0x%08X length:0x%08X" %\
116 (index, indexToName(index), offset, length)
119 def extractSection(hdr_filepath, bin_filepath, extractIndex, outfilePath):
120 sections = parseHeaderFile(hdr_filepath)
123 section = getSectionByIndex(sections, extractIndex)
125 print "Did not find a section with index %d" % extractIndex
127 (offset, length, index) = section
129 bin_data = file(bin_filepath, "rb").read()
131 print "Failed to read bin file: %s" % e.strerror
134 outfile = file(outfilePath, "wb")
135 outfile.write(bin_data[offset : offset + length])
137 print "Binfile index error."
140 print "Failed to write output file: %s" % e.strerror
144 def mergeSection(hdr_filepath, bin_filepath, mergeIndex, mergefilePath):
145 sections = parseHeaderFile(hdr_filepath)
149 bin_data = file(bin_filepath, "rb").read()
151 print "Failed to read bin file: %s" % e.strerror
154 merge_data = file(mergefilePath, "rb").read()
156 print "Failed to open merge output file: %s" % e.strerror
161 for section in sections:
162 (offset, length, index) = section
163 if index == mergeIndex:
164 # We overwrite this section
165 newBin.append(merge_data)
166 newSections.append( (newOffset, len(merge_data), index) )
167 newOffset += len(merge_data)
170 newBin.append(bin_data[offset : offset + length])
172 print "Failed to read input data"
174 newSections.append( (newOffset, length, index) )
176 newBin = "".join(newBin)
177 newHdr = generateHeaderData(newSections)
179 file(bin_filepath, "wb").write(newBin)
180 file(hdr_filepath, "wb").write(newHdr)
182 print "Failed to write bin or header file: %s" % e.strerror
187 print "BRCM80211 firmware converter tool"
189 print "Usage: %s [OPTIONS]" % sys.argv[0]
191 print " -H|--header FILE Use FILE as header file"
192 print " -B|--bin FILE Use FILE as bin file"
195 print " -d|--dump Dump general information"
196 print " -x|--extract INDEX:FILE Extract the section with index INDEX to FILE"
197 print " -m|--merge INDEX:FILE Merges FILE into the bin file stream at INDEX"
198 print " A Merge modifies the files specified in -H and -B"
200 print " -h|--help Print this help text"
211 (opts, args) = getopt.getopt(sys.argv[1:],
213 [ "help", "header=", "bin=", "dump", "extract=", "merge=", ])
214 except getopt.GetoptError:
218 if o in ("-h", "--help"):
221 if o in ("-H", "--header"):
223 if o in ("-B", "--bin"):
225 if o in ("-d", "--dump"):
227 if o in ("-x", "--extract"):
228 opt_action = "extract"
231 opt_index = int(v[0])
233 except IndexError, ValueError:
234 print "Invalid -x|--extract index number\n"
237 if o in ("-m", "--merge"):
241 opt_index = int(v[0])
243 except IndexError, ValueError:
244 print "Invalid -m|--merge index and/or merge file name\n"
248 print "No action specified\n"
251 if opt_action == "dump":
253 print "No header file specified\n"
256 return dumpInfo(opt_header)
257 elif opt_action == "extract":
258 if not opt_header or not opt_bin:
259 print "No header or bin file specified\n"
262 return extractSection(opt_header, opt_bin, opt_index, opt_outfile)
263 elif opt_action == "merge":
264 if not opt_header or not opt_bin:
265 print "No header or bin file specified\n"
268 return mergeSection(opt_header, opt_bin, opt_index, opt_mergefile)
271 if __name__ == "__main__":