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