1 | /* |
2 | * This file is subject to the terms and conditions of the GNU General Public |
3 | * License. See the file "COPYING" in the main directory of this archive |
4 | * for more details. |
5 | * |
6 | * Copyright (C) 2008 Axel Gembe <ago@bastart.eu.org> |
7 | * Copyright (C) 2009 Daniel Dickinson <crazycshore@gmail.com> |
8 | */ |
9 | |
10 | #include <stdio.h> |
11 | #include <stdlib.h> |
12 | #include <string.h> |
13 | #include <stdint.h> |
14 | #include <time.h> |
15 | #include <unistd.h> |
16 | #include <sys/stat.h> |
17 | #include <netinet/in.h> |
18 | |
19 | #include "bcm_tag.h" |
20 | |
21 | #define IMAGETAG_MAGIC1 "Broadcom Corporatio" |
22 | #define IMAGETAG_MAGIC2 "ver. 2.0" |
23 | #define IMAGETAG_VER "6" |
24 | #define IMAGETAG_DEFAULT_LOADADDR 0x80010000 |
25 | #define DEFAULT_FW_OFFSET 0x10000 |
26 | #define DEFAULT_FLASH_START 0xBFC00000 |
27 | #define DEFAULT_FLASH_BS (64 * 1024) |
28 | #define DEADCODE 0xDEADC0DE |
29 | |
30 | union int2char { |
31 | uint32_t input; |
32 | char output[4]; |
33 | }; |
34 | |
35 | /* Convert uint32_t CRC to bigendian and copy it into a character array */ |
36 | #define int2tag(tag, value) intchar.input = htonl(value); \ |
37 | memcpy(tag, intchar.output, sizeof(union int2char)) |
38 | |
39 | /* Kernel header */ |
40 | struct kernelhdr { |
41 | uint32_t loadaddr; /* Kernel load address */ |
42 | uint32_t entry; /* Kernel entry point address */ |
43 | uint32_t lzmalen; /* Compressed length of the LZMA data that follows */ |
44 | }; |
45 | |
46 | static char pirellitab[NUM_PIRELLI][BOARDID_LEN] = PIRELLI_BOARDS; |
47 | |
48 | static uint32_t crc32tab[256] = { |
49 | 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, |
50 | 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, |
51 | 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, |
52 | 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, |
53 | 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, |
54 | 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, |
55 | 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, |
56 | 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, |
57 | 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, |
58 | 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, |
59 | 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, |
60 | 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, |
61 | 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, |
62 | 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, |
63 | 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, |
64 | 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, |
65 | 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, |
66 | 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, |
67 | 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, |
68 | 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, |
69 | 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, |
70 | 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, |
71 | 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, |
72 | 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, |
73 | 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, |
74 | 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, |
75 | 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, |
76 | 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, |
77 | 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, |
78 | 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, |
79 | 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, |
80 | 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D |
81 | }; |
82 | |
83 | uint32_t crc32(uint32_t crc, uint8_t *data, size_t len) |
84 | { |
85 | while (len--) |
86 | crc = (crc >> 8) ^ crc32tab[(crc ^ *data++) & 0xFF]; |
87 | |
88 | return crc; |
89 | } |
90 | |
91 | uint32_t compute_crc32(uint32_t crc, FILE *binfile, size_t compute_start, size_t compute_len) |
92 | { |
93 | uint8_t readbuf[1024]; |
94 | size_t read; |
95 | |
96 | fseek(binfile, compute_start, SEEK_SET); |
97 | |
98 | /* read block of 1024 bytes */ |
99 | while (binfile && !feof(binfile) && !ferror(binfile) && (compute_len >= sizeof(readbuf))) { |
100 | read = fread(readbuf, sizeof(uint8_t), sizeof(readbuf), binfile); |
101 | crc = crc32(crc, readbuf, read); |
102 | compute_len = compute_len - read; |
103 | } |
104 | |
105 | /* Less than 1024 bytes remains, read compute_len bytes */ |
106 | if (binfile && !feof(binfile) && !ferror(binfile) && (compute_len > 0)) { |
107 | read = fread(readbuf, sizeof(uint8_t), compute_len, binfile); |
108 | crc = crc32(crc, readbuf, read); |
109 | } |
110 | |
111 | return crc; |
112 | } |
113 | |
114 | size_t getlen(FILE *fp) |
115 | { |
116 | size_t retval, curpos; |
117 | |
118 | if (!fp) |
119 | return 0; |
120 | |
121 | curpos = ftell(fp); |
122 | fseek(fp, 0, SEEK_END); |
123 | retval = ftell(fp); |
124 | fseek(fp, curpos, SEEK_SET); |
125 | |
126 | return retval; |
127 | } |
128 | |
129 | int tagfile(const char *kernel, const char *rootfs, const char *bin, |
130 | const char *boardid, const char *chipid, const uint32_t fwaddr, |
131 | const uint32_t loadaddr, const uint32_t entry, |
132 | const char *ver, const char *magic2, const uint32_t flash_bs, |
133 | const char *rsignature, const char *layoutver) |
134 | { |
135 | struct bcm_tag tag; |
136 | struct kernelhdr khdr; |
137 | FILE *kernelfile = NULL, *rootfsfile = NULL, *binfile; |
138 | size_t kerneloff, kernellen, rootfsoff, rootfslen, read, imagelen, rootfsoffpadlen, kernelfslen; |
139 | uint8_t readbuf[1024]; |
140 | uint32_t imagecrc = IMAGETAG_CRC_START; |
141 | uint32_t kernelcrc = IMAGETAG_CRC_START; |
142 | uint32_t rootfscrc = IMAGETAG_CRC_START; |
143 | uint32_t kernelfscrc = IMAGETAG_CRC_START; |
144 | const uint32_t deadcode = htonl(DEADCODE); |
145 | union int2char intchar; |
146 | int i; |
147 | int is_pirelli = 0; |
148 | |
149 | memset(&tag, 0, sizeof(struct bcm_tag)); |
150 | |
151 | if (strlen(boardid) >= sizeof(tag.boardid)) { |
152 | fprintf(stderr, "Board id is too long!\n"); |
153 | return 1; |
154 | } |
155 | |
156 | /* Likewise chipid */ |
157 | if (strlen(chipid) >= sizeof(tag.chipid)) { |
158 | fprintf(stderr, "Chip id is too long!\n"); |
159 | return 1; |
160 | } |
161 | |
162 | if (!kernel || !rootfs) { |
163 | fprintf(stderr, "imagetag can't create an image without both kernel and rootfs\n"); |
164 | } |
165 | |
166 | if (kernel && !(kernelfile = fopen(kernel, "rb"))) { |
167 | fprintf(stderr, "Unable to open kernel \"%s\"\n", kernel); |
168 | return 1; |
169 | } |
170 | |
171 | if (rootfs && !(rootfsfile = fopen(rootfs, "rb"))) { |
172 | fprintf(stderr, "Unable to open rootfs \"%s\"\n", rootfs); |
173 | return 1; |
174 | } |
175 | |
176 | if (!bin || !(binfile = fopen(bin, "wb+"))) { |
177 | fprintf(stderr, "Unable to open output file \"%s\"\n", bin); |
178 | return 1; |
179 | } |
180 | |
181 | /* Build the kernel address and length (doesn't need to be aligned, read only) */ |
182 | kerneloff = fwaddr + sizeof(tag); |
183 | kernellen = getlen(kernelfile); |
184 | |
185 | /* Build the kernel header */ |
186 | khdr.loadaddr = htonl(loadaddr); |
187 | khdr.entry = htonl(entry); |
188 | khdr.lzmalen = htonl(kernellen); |
189 | |
190 | /* Increase the kernel size by the header size */ |
191 | kernellen += sizeof(khdr); |
192 | |
193 | /* Build the rootfs address and length (start and end do need to be aligned on flash erase block boundaries */ |
194 | rootfsoff = kerneloff + kernellen; |
195 | rootfsoff = (rootfsoff % flash_bs) > 0 ? (((rootfsoff / flash_bs) + 1) * flash_bs) : rootfsoff; |
196 | rootfslen = getlen(rootfsfile); |
197 | rootfslen = ( (rootfslen % flash_bs) > 0 ? (((rootfslen / flash_bs) + 1) * flash_bs) : rootfslen ); |
198 | imagelen = rootfsoff + rootfslen - kerneloff + sizeof(deadcode); |
199 | rootfsoffpadlen = rootfsoff - (kerneloff + kernellen); |
200 | |
201 | /* Seek to the start of the kernel */ |
202 | fseek(binfile, kerneloff - fwaddr, SEEK_SET); |
203 | |
204 | /* Write the kernel header */ |
205 | fwrite(&khdr, sizeof(khdr), 1, binfile); |
206 | |
207 | /* Write the kernel */ |
208 | while (kernelfile && !feof(kernelfile) && !ferror(kernelfile)) { |
209 | read = fread(readbuf, sizeof(uint8_t), sizeof(readbuf), kernelfile); |
210 | fwrite(readbuf, sizeof(uint8_t), read, binfile); |
211 | } |
212 | |
213 | /* Write the RootFS */ |
214 | fseek(binfile, rootfsoff - fwaddr, SEEK_SET); |
215 | while (rootfsfile && !feof(rootfsfile) && !ferror(rootfsfile)) { |
216 | read = fread(readbuf, sizeof(uint8_t), sizeof(readbuf), rootfsfile); |
217 | fwrite(readbuf, sizeof(uint8_t), read, binfile); |
218 | } |
219 | |
220 | /* Align image to specified erase block size and append deadc0de */ |
221 | printf("Data alignment to %dk with 'deadc0de' appended\n", flash_bs/1024); |
222 | fseek(binfile, rootfsoff + rootfslen - fwaddr, SEEK_SET); |
223 | fwrite(&deadcode, sizeof(uint32_t), 1, binfile); |
224 | |
225 | /* Flush the binfile buffer so that when we read from file, it contains |
226 | * everything in the buffer |
227 | */ |
228 | fflush(binfile); |
229 | |
230 | /* Compute the crc32 of the entire image (deadC0de included) */ |
231 | imagecrc = compute_crc32(imagecrc, binfile, kerneloff - fwaddr, imagelen); |
232 | /* Compute the crc32 of the kernel and padding between kernel and rootfs) */ |
233 | kernelcrc = compute_crc32(kernelcrc, binfile, kerneloff - fwaddr, kernellen + rootfsoffpadlen); |
234 | /* Compute the crc32 of the kernel and padding between kernel and rootfs) */ |
235 | kernelfscrc = compute_crc32(kernelfscrc, binfile, kerneloff - fwaddr, kernellen + rootfsoffpadlen + rootfslen + sizeof(deadcode)); |
236 | /* Compute the crc32 of the flashImageStart to rootLength. |
237 | * The broadcom firmware assumes the rootfs starts the image, |
238 | * therefore uses the rootfs start to determine where to flash |
239 | * the image. Since we have the kernel first we have to give |
240 | * it the kernel address, but the crc uses the length |
241 | * associated with this address, which is added to the kernel |
242 | * length to determine the length of image to flash and thus |
243 | * needs to be rootfs + deadcode |
244 | */ |
245 | rootfscrc = compute_crc32(rootfscrc, binfile, kerneloff - fwaddr, rootfslen + sizeof(deadcode)); |
246 | |
247 | /* Close the files */ |
248 | fclose(kernelfile); |
249 | fclose(rootfsfile); |
250 | |
251 | /* Build the tag */ |
252 | strncpy(tag.tagVersion, ver, TAGVER_LEN); |
253 | strncpy(tag.sig_1, IMAGETAG_MAGIC1, sizeof(tag.sig_1) - 1); |
254 | strncpy(tag.sig_2, magic2, sizeof(tag.sig_2) - 1); |
255 | strcpy(tag.chipid, chipid); |
256 | strcpy(tag.boardid, boardid); |
257 | strcpy(tag.big_endian, "1"); |
258 | sprintf(tag.totalLength, "%lu", imagelen); |
259 | |
260 | /* We don't include CFE */ |
261 | strcpy(tag.cfeAddress, "0"); |
262 | strcpy(tag.cfeLength, "0"); |
263 | |
264 | sprintf(tag.kernelAddress, "%lu", kerneloff); |
265 | sprintf(tag.kernelLength, "%lu", kernellen + rootfsoffpadlen); |
266 | sprintf(tag.flashImageStart, "%lu", kerneloff); |
267 | sprintf(tag.rootLength, "%lu", rootfslen + sizeof(deadcode)); |
268 | |
269 | if (rsignature) { |
270 | strncpy(tag.rsa_signature, rsignature, RSASIG_LEN); |
271 | } |
272 | |
273 | if (layoutver) { |
274 | strncpy(tag.flashLayoutVer, layoutver, TAGLAYOUT_LEN); |
275 | } |
276 | |
277 | for (i = 0; i < NUM_PIRELLI; i++) { |
278 | if (strncmp(boardid, pirellitab[i], BOARDID_LEN) == 0) { |
279 | is_pirelli = 1; |
280 | break; |
281 | } |
282 | } |
283 | |
284 | if ( !is_pirelli ) { |
285 | int2tag(tag.imageCRC, imagecrc); |
286 | } else { |
287 | int2tag(tag.imageCRC, kernelcrc); |
288 | } |
289 | int2tag(tag.kernelCRC, kernelcrc); |
290 | int2tag(tag.rootfsCRC, rootfscrc); |
291 | int2tag(tag.fskernelCRC, kernelfscrc); |
292 | int2tag(tag.headerCRC, crc32(IMAGETAG_CRC_START, (uint8_t*)&tag, sizeof(tag) - 20)); |
293 | |
294 | fseek(binfile, 0L, SEEK_SET); |
295 | fwrite(&tag, sizeof(uint8_t), sizeof(tag), binfile); |
296 | |
297 | fclose(binfile); |
298 | |
299 | return 0; |
300 | } |
301 | |
302 | int main(int argc, char **argv) |
303 | { |
304 | int c, i; |
305 | char *kernel, *rootfs, *bin, *boardid, *chipid, *magic2, *ver, *tagid, *rsignature, *layoutver; |
306 | uint32_t flashstart, fwoffset, loadaddr, entry; |
307 | uint32_t fwaddr, flash_bs; |
308 | int tagidfound = 0; |
309 | |
310 | kernel = rootfs = bin = boardid = chipid = magic2 = ver = rsignature = layoutver = NULL; |
311 | entry = 0; |
312 | |
313 | flashstart = DEFAULT_FLASH_START; |
314 | fwoffset = DEFAULT_FW_OFFSET; |
315 | loadaddr = IMAGETAG_DEFAULT_LOADADDR; |
316 | flash_bs = DEFAULT_FLASH_BS; |
317 | |
318 | printf("Broadcom image tagger - v1.0.0\n"); |
319 | printf("Copyright (C) 2008 Axel Gembe\n"); |
320 | printf("Copyright (C) 2009-2010 Daniel Dickinson\n"); |
321 | |
322 | while ((c = getopt(argc, argv, "i:f:o:b:c:s:n:v:m:k:l:e:h:r:y:")) != -1) { |
323 | switch (c) { |
324 | case 'i': |
325 | kernel = optarg; |
326 | break; |
327 | case 'f': |
328 | rootfs = optarg; |
329 | break; |
330 | case 'o': |
331 | bin = optarg; |
332 | break; |
333 | case 'b': |
334 | boardid = optarg; |
335 | break; |
336 | case 'c': |
337 | chipid = optarg; |
338 | break; |
339 | case 's': |
340 | flashstart = strtoul(optarg, NULL, 16); |
341 | break; |
342 | case 'n': |
343 | fwoffset = strtoul(optarg, NULL, 16); |
344 | break; |
345 | case 'v': |
346 | ver = optarg; |
347 | break; |
348 | case 'm': |
349 | magic2 = optarg; |
350 | break; |
351 | case 'k': |
352 | flash_bs = strtoul(optarg, NULL, 16); |
353 | break; |
354 | case 'l': |
355 | loadaddr = strtoul(optarg, NULL, 16); |
356 | break; |
357 | case 'e': |
358 | entry = strtoul(optarg, NULL, 16); |
359 | break; |
360 | case 'r': |
361 | rsignature = optarg; |
362 | break; |
363 | case 'y': |
364 | layoutver = optarg; |
365 | break; |
366 | case 'h': |
367 | default: |
368 | fprintf(stderr, "Usage: imagetag <parameters>\n\n"); |
369 | fprintf(stderr, " -i <kernel> - The LZMA compressed kernel file to include in the image\n"); |
370 | fprintf(stderr, " -f <rootfs> - The RootFS file to include in the image\n"); |
371 | fprintf(stderr, " -o <bin> - The output file\n"); |
372 | fprintf(stderr, " -b <boardid> - The board id to set in the image (i.e. \"96345GW2\")\n"); |
373 | fprintf(stderr, " -c <chipid> - The chip id to set in the image (i.e. \"6345\")\n"); |
374 | fprintf(stderr, " -s <flashstart> - Flash start address (i.e. \"0xBFC00000\"\n"); |
375 | fprintf(stderr, " -n <fwoffset> - \n"); |
376 | fprintf(stderr, " -v <version> - \n"); |
377 | fprintf(stderr, " -m <magic2> - \n"); |
378 | fprintf(stderr, " -k <flash_bs> - flash erase block size\n"); |
379 | fprintf(stderr, " -l <loadaddr> - Address where the kernel expects to be loaded (defaults to 0x80010000)\n"); |
380 | fprintf(stderr, " -e <entry> - Address where the kernel entry point will end up\n"); |
381 | fprintf(stderr, " -r <signature> - vendor specific signature, for those that need it"); |
382 | fprintf(stderr, " -y <layoutver> - Flash Layout Version (2.2x code versions need this)"); |
383 | fprintf(stderr, " -h - Displays this text\n\n"); |
384 | return 1; |
385 | } |
386 | } |
387 | |
388 | if (!boardid || !chipid) { |
389 | fprintf(stderr, "You need to specify the board (-b) and chip id (-c)!\n"); |
390 | return 1; |
391 | } |
392 | |
393 | if (entry == 0) { |
394 | fprintf(stderr, "You need to specify the kernel entry (-e)\n"); |
395 | return 1; |
396 | } |
397 | |
398 | /* Fallback to defaults */ |
399 | |
400 | fwaddr = flashstart + fwoffset; |
401 | |
402 | if (!magic2) { |
403 | magic2 = malloc(sizeof(char) * 14); |
404 | if (!magic2) { |
405 | perror("malloc"); |
406 | return 1; |
407 | } |
408 | strcpy(magic2, IMAGETAG_MAGIC2); |
409 | } |
410 | |
411 | if (!ver) { |
412 | ver = malloc(sizeof(char) * 4); |
413 | if (!ver) { |
414 | perror("malloc"); |
415 | return 1; |
416 | } |
417 | strcpy(ver, IMAGETAG_VER); |
418 | } |
419 | |
420 | |
421 | return tagfile(kernel, rootfs, bin, boardid, chipid, fwaddr, loadaddr, entry, ver, magic2, flash_bs, rsignature, layoutver); |
422 | } |
423 | |