Theme Editor: Added rendering support for some more tags
[kugel-rb.git] / rbutil / mkamsboot / mkamsboot.c
blobf47afe312a54ed9b6862b3482838f139c38e6569
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * mkamsboot.c - a tool for merging bootloader code into an Sansa V2
11 * (AMS) firmware file
13 * Copyright (C) 2008 Dave Chapman
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ****************************************************************************/
27 Insert a Rockbox bootloader into a Sansa AMS original firmware file.
29 Layout of a Sansa AMS original firmware file:
31 ---------------------- 0x0
32 | HEADER |
33 |----------------------| 0x400
34 | FIRMWARE BLOCK |
35 |----------------------| 0x400 + firmware block size
36 | LIBRARIES/DATA |
37 ---------------------- END
39 We replace the main firmware block (bytes 0x400..0x400+firmware_size)
40 as follows:
43 ---------------------- 0x0
44 | |
45 | Dual-boot code |
46 | |
47 |----------------------|
48 | EMPTY SPACE |
49 |----------------------|
50 | |
51 | compressed RB image |
52 | |
53 |----------------------|
54 | |
55 | compressed OF image |
56 | |
57 |----------------------|
58 | UCL unpack function |
59 ----------------------
61 This entire block fits into the space previously occupied by the main
62 firmware block - the space saved by compressing the OF image is used
63 to store the compressed version of the Rockbox bootloader.
65 On version 1 firmwares, the OF image is typically about 120KB, which allows
66 us to store a Rockbox bootloader with an uncompressed size of about 60KB-70KB.
67 Version 2 firmwares are bigger and are stored in SDRAM (instead of IRAM).
68 In both cases, the RAM we are using is mapped at offset 0x0.
70 mkamsboot then corrects the checksums and writes a new legal firmware
71 file which can be installed on the device.
73 When the Sansa device boots, this firmware block is loaded to RAM at
74 address 0x0 and executed.
76 Firstly, the dual-boot code will copy the UCL unpack function to the
77 end of RAM.
79 Then, depending on the detection of the dual-boot keypress, either the
80 OF image or the Rockbox image is copied to the end of RAM (just before
81 the ucl unpack function) and uncompressed to the start of RAM.
83 Finally, the ucl unpack function branches to address 0x0, passing
84 execution to the uncompressed firmware.
89 #include <stdio.h>
90 #include <stdlib.h>
91 #include <stdint.h>
92 #include <sys/types.h>
93 #include <sys/stat.h>
94 #include <fcntl.h>
95 #include <unistd.h>
96 #include <string.h>
98 #include <ucl/ucl.h>
100 #include "mkamsboot.h"
102 #include "md5.h"
104 /* Header for ARM code binaries */
105 #include "dualboot.h"
107 /* Win32 compatibility */
108 #ifndef O_BINARY
109 #define O_BINARY 0
110 #endif
112 /* 4 for m200, 2 for e200/c200, 1 or 2 for fuze/clip, 1 for clip+ */
113 const unsigned short hw_revisions[] = {
114 [MODEL_FUZE] = 1,
115 [MODEL_CLIP] = 1,
116 [MODEL_CLIPV2] = 2,
117 [MODEL_E200V2] = 2,
118 [MODEL_M200V4] = 4,
119 [MODEL_C200V2] = 2,
120 [MODEL_CLIPPLUS]= 1,
121 [MODEL_FUZEV2] = 2,
124 /* version 2 is used in Clipv2, Clip+ and Fuzev2 firmwares */
125 const unsigned short fw_revisions[] = {
126 [MODEL_FUZE] = 1,
127 [MODEL_CLIP] = 1,
128 [MODEL_CLIPV2] = 2,
129 [MODEL_E200V2] = 1,
130 [MODEL_M200V4] = 1,
131 [MODEL_C200V2] = 1,
132 [MODEL_CLIPPLUS]= 2,
133 [MODEL_FUZEV2] = 2,
136 /* Descriptive name of these models */
137 const char* model_names[] = {
138 [MODEL_FUZE] = "Fuze",
139 [MODEL_CLIP] = "Clip",
140 [MODEL_CLIPV2] = "Clip",
141 [MODEL_CLIPPLUS]= "Clip+",
142 [MODEL_E200V2] = "e200",
143 [MODEL_M200V4] = "m200",
144 [MODEL_C200V2] = "c200",
145 [MODEL_FUZEV2] = "Fuze",
148 /* Dualboot functions for these models */
149 static const unsigned char* bootloaders[] = {
150 [MODEL_FUZE] = dualboot_fuze,
151 [MODEL_CLIP] = dualboot_clip,
152 [MODEL_CLIPV2] = dualboot_clipv2,
153 [MODEL_E200V2] = dualboot_e200v2,
154 [MODEL_M200V4] = dualboot_m200v4,
155 [MODEL_C200V2] = dualboot_c200v2,
156 [MODEL_CLIPPLUS]= dualboot_clipplus,
157 [MODEL_FUZEV2] = dualboot_fuzev2,
160 /* Size of dualboot functions for these models */
161 const int bootloader_sizes[] = {
162 [MODEL_FUZE] = sizeof(dualboot_fuze),
163 [MODEL_CLIP] = sizeof(dualboot_clip),
164 [MODEL_CLIPV2] = sizeof(dualboot_clipv2),
165 [MODEL_E200V2] = sizeof(dualboot_e200v2),
166 [MODEL_M200V4] = sizeof(dualboot_m200v4),
167 [MODEL_C200V2] = sizeof(dualboot_c200v2),
168 [MODEL_CLIPPLUS]= sizeof(dualboot_clipplus),
169 [MODEL_FUZEV2] = sizeof(dualboot_fuzev2),
172 /* Model names used in the Rockbox header in ".sansa" files - these match the
173 -add parameter to the "scramble" tool */
174 static const char* rb_model_names[] = {
175 [MODEL_FUZE] = "fuze",
176 [MODEL_CLIP] = "clip",
177 [MODEL_CLIPV2] = "clv2",
178 [MODEL_E200V2] = "e2v2",
179 [MODEL_M200V4] = "m2v4",
180 [MODEL_C200V2] = "c2v2",
181 [MODEL_CLIPPLUS]= "cli+",
182 [MODEL_FUZEV2] = "fuz2",
185 /* Model numbers used to initialise the checksum in the Rockbox header in
186 ".sansa" files - these are the same as MODEL_NUMBER in config-target.h */
187 static const int rb_model_num[] = {
188 [MODEL_FUZE] = 43,
189 [MODEL_CLIP] = 40,
190 [MODEL_CLIPV2] = 60,
191 [MODEL_E200V2] = 41,
192 [MODEL_M200V4] = 42,
193 [MODEL_C200V2] = 44,
194 [MODEL_CLIPPLUS]= 66,
195 [MODEL_FUZEV2] = 68,
198 /* Checksums of unmodified original firmwares - for safety, and device
199 detection */
200 static struct md5sums sansasums[] = {
201 /* NOTE: Different regional versions of the firmware normally only
202 differ in the filename - the md5sums are identical */
204 /* model version md5 */
205 { MODEL_E200V2, "3.01.11", "e622ca8cb6df423f54b8b39628a1f0a3" },
206 { MODEL_E200V2, "3.01.14", "2c1d0383fc3584b2cc83ba8cc2243af6" },
207 { MODEL_E200V2, "3.01.16", "12563ad71b25a1034cf2092d1e0218c4" },
209 { MODEL_FUZE, "1.01.11", "cac8ffa03c599330ac02c4d41de66166" },
210 { MODEL_FUZE, "1.01.15", "df0e2c1612727f722c19a3c764cff7f2" },
211 { MODEL_FUZE, "1.01.22", "5aff5486fe8dd64239cc71eac470af98" },
212 { MODEL_FUZE, "1.02.26", "7c632c479461c48c8833baed74eb5e4f" },
213 { MODEL_FUZE, "1.02.28", "5b34260f6470e75f702a9c6825471752" },
214 { MODEL_FUZE, "1.02.31", "66d01b37462a5ef7ccc6ad37188b4235" },
216 { MODEL_C200V2, "3.02.05", "b6378ebd720b0ade3fad4dc7ab61c1a5" },
218 { MODEL_M200V4, "4.00.45", "82e3194310d1514e3bbcd06e84c4add3" },
219 { MODEL_M200V4, "4.01.08-A", "fc9dd6116001b3e6a150b898f1b091f0" },
220 { MODEL_M200V4, "4.01.08-E", "d3fb7d8ec8624ee65bc99f8dab0e2369" },
222 { MODEL_CLIP, "1.01.17", "12caad785d506219d73f538772afd99e" },
223 { MODEL_CLIP, "1.01.18", "d720b266bd5afa38a198986ef0508a45" },
224 { MODEL_CLIP, "1.01.20", "236d8f75189f468462c03f6d292cf2ac" },
225 { MODEL_CLIP, "1.01.29", "c12711342169c66e209540cd1f27cd26" },
226 { MODEL_CLIP, "1.01.30", "f2974d47c536549c9d8259170f1dbe4d" },
227 { MODEL_CLIP, "1.01.32", "d835d12342500732ffb9c4ee54abec15" },
228 { MODEL_CLIP, "1.01.35", "b4d0edb3b8f2a4e8eee0a344f7f8e480" },
230 { MODEL_CLIPV2, "2.01.16", "c57fb3fcbe07c2c9b360f060938f80cb" },
231 { MODEL_CLIPV2, "2.01.32", "0ad3723e52022509089d938d0fbbf8c5" },
232 { MODEL_CLIPV2, "2.01.35", "a3cbbd22b9508d7f8a9a1a39acc342c2" },
234 { MODEL_CLIPPLUS, "01.02.09", "656d38114774c2001dc18e6726df3c5d" },
235 { MODEL_CLIPPLUS, "01.02.13", "5f89872b79ef440b0e5ee3a7a44328b2" },
236 { MODEL_CLIPPLUS, "01.02.15", "680a4f521e790ad25b93b1b16f3a207d" },
238 { MODEL_FUZEV2, "2.01.17", "8b85fb05bf645d08a4c8c3e344ec9ebe" },
239 { MODEL_FUZEV2, "2.02.26", "d4f6f85c3e4a8ea8f2e5acc421641801" },
240 { MODEL_FUZEV2, "2.03.31", "74fb197ccd51707388f3b233402186a6" },
241 { MODEL_FUZEV2, "2.03.33", "1599cc73d02ea7fe53fe2d4379c24b66" },
244 #define NUM_MD5S (sizeof(sansasums)/sizeof(sansasums[0]))
246 static unsigned int model_memory_size(int model)
248 if(model == MODEL_CLIPV2)
250 /* The decompressed Clipv2 OF is around 380kB.
251 * Since it doesn't fit in the 0x50000 bytes IRAM, the OF starts
252 * with DRAM mapped at 0x0
254 * We could use all the available memory (supposedly 8MB)
255 * but 1MB ought to be enough for our use
257 return 1 << 20;
259 else
260 { /* The OF boots with IRAM (320kB) mapped at 0x0 */
261 return 320 << 10;
265 int firmware_revision(int model)
267 return fw_revisions[model];
270 static off_t filesize(int fd)
272 struct stat buf;
274 if (fstat(fd, &buf) < 0) {
275 perror("[ERR] Checking filesize of input file");
276 return -1;
277 } else {
278 return(buf.st_size);
282 static uint32_t get_uint32le(unsigned char* p)
284 return p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24);
287 static uint32_t get_uint32be(unsigned char* p)
289 return (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];
292 static void put_uint32le(unsigned char* p, uint32_t x)
294 p[0] = x & 0xff;
295 p[1] = (x >> 8) & 0xff;
296 p[2] = (x >> 16) & 0xff;
297 p[3] = (x >> 24) & 0xff;
300 void calc_MD5(unsigned char* buf, int len, char *md5str)
302 int i;
303 md5_context ctx;
304 unsigned char md5sum[16];
306 md5_starts(&ctx);
307 md5_update(&ctx, buf, len);
308 md5_finish(&ctx, md5sum);
310 for (i = 0; i < 16; ++i)
311 sprintf(md5str + 2*i, "%02x", md5sum[i]);
314 /* Calculate a simple checksum used in Sansa Original Firmwares */
315 static uint32_t calc_checksum(unsigned char* buf, uint32_t n)
317 uint32_t sum = 0;
318 uint32_t i;
320 for (i=0;i<n;i+=4)
321 sum += get_uint32le(buf + i);
323 return sum;
326 /* Compress using nrv2e algorithm : Thumb decompressor fits in 168 bytes ! */
327 static unsigned char* uclpack(unsigned char* inbuf, int insize, int* outsize)
329 int maxsize;
330 unsigned char* outbuf;
331 int r;
333 /* The following formula comes from the UCL documentation */
334 maxsize = insize + (insize / 8) + 256;
336 /* Allocate some memory for the output buffer */
337 outbuf = malloc(maxsize);
339 if (outbuf == NULL)
340 return NULL;
342 r = ucl_nrv2e_99_compress(
343 (const ucl_bytep) inbuf,
344 (ucl_uint) insize,
345 (ucl_bytep) outbuf,
346 (ucl_uintp) outsize,
347 0, 10, NULL, NULL);
349 if (r != UCL_E_OK || *outsize > maxsize) {
350 /* this should NEVER happen, and implies memory corruption */
351 fprintf(stderr, "internal error - compression failed: %d\n", r);
352 free(outbuf);
353 return NULL;
356 return outbuf;
359 #define ERROR(format, ...) \
360 do { \
361 snprintf(errstr, errstrsize, format, __VA_ARGS__); \
362 goto error; \
363 } while(0)
365 /* Loads a Sansa AMS Original Firmware file into memory */
366 unsigned char* load_of_file(
367 char* filename, int model, off_t* bufsize, struct md5sums *sum,
368 int* firmware_size, unsigned char** of_packed,
369 int* of_packedsize, char* errstr, int errstrsize)
371 int fd;
372 unsigned char* buf =NULL;
373 off_t n;
374 unsigned int i=0;
375 uint32_t checksum;
376 unsigned int last_word;
378 fd = open(filename, O_RDONLY|O_BINARY);
379 if (fd < 0)
380 ERROR("[ERR] Could not open %s for reading\n", filename);
382 *bufsize = filesize(fd);
384 buf = malloc(*bufsize);
385 if (buf == NULL)
386 ERROR("[ERR] Could not allocate memory for %s\n", filename);
388 n = read(fd, buf, *bufsize);
390 if (n != *bufsize)
391 ERROR("[ERR] Could not read file %s\n", filename);
393 /* check the file */
395 /* Calculate MD5 checksum of OF */
396 calc_MD5(buf, *bufsize, sum->md5);
398 while ((i < NUM_MD5S) && (strcmp(sansasums[i].md5, sum->md5) != 0))
399 i++;
401 if (i < NUM_MD5S) {
402 *sum = sansasums[i];
403 if(sum->model != model) {
404 ERROR("[ERR] OF File provided is %sv%d version %s, not for %sv%d\n",
405 model_names[sum->model], hw_revisions[sum->model],
406 sum->version, model_names[model], hw_revisions[model]
409 } else {
410 /* OF unknown, give a list of tested versions for the requested model */
412 char tested_versions[100];
413 tested_versions[0] = '\0';
415 for (i = 0; i < NUM_MD5S ; i++)
416 if (sansasums[i].model == model) {
417 if (tested_versions[0] != '\0') {
418 strncat(tested_versions, ", ",
419 sizeof(tested_versions) - strlen(tested_versions) - 1);
421 strncat(tested_versions, sansasums[i].version,
422 sizeof(tested_versions) - strlen(tested_versions) - 1);
425 ERROR("[ERR] Original firmware unknown, please try an other version." \
426 " Tested %sv%d versions are : %s\n",
427 model_names[model], hw_revisions[model], tested_versions);
430 /* TODO: Do some more sanity checks on the OF image. Some images (like
431 m200v4) dont have a checksum at the end, only padding (0xdeadbeef). */
432 last_word = *bufsize - 4;
433 checksum = get_uint32le(buf + last_word);
434 if (checksum != 0xefbeadde && checksum != calc_checksum(buf, last_word))
435 ERROR("%s", "[ERR] Whole file checksum failed\n");
437 if (bootloaders[sum->model] == NULL)
438 ERROR("[ERR] Unsupported model - \"%s\"\n", model_names[sum->model]);
440 /* Get the firmware size */
441 if (fw_revisions[sum->model] == 1)
442 *firmware_size = get_uint32le(&buf[0x0c]);
443 else if (fw_revisions[sum->model] == 2)
444 *firmware_size = get_uint32le(&buf[0x10]);
446 /* Compress the original firmware image */
447 *of_packed = uclpack(buf + 0x400, *firmware_size, of_packedsize);
448 if (*of_packed == NULL)
449 ERROR("[ERR] Could not compress %s\n", filename);
451 return buf;
453 error:
454 free(buf);
455 return NULL;
458 /* Loads a rockbox bootloader file into memory */
459 unsigned char* load_rockbox_file(
460 char* filename, int *model, int* bufsize, int* rb_packedsize,
461 char* errstr, int errstrsize)
463 int fd;
464 unsigned char* buf = NULL;
465 unsigned char* packed = NULL;
466 unsigned char header[8];
467 uint32_t sum;
468 off_t n;
469 int i;
471 fd = open(filename, O_RDONLY|O_BINARY);
472 if (fd < 0)
473 ERROR("[ERR] Could not open %s for reading\n", filename);
475 /* Read Rockbox header */
476 n = read(fd, header, sizeof(header));
477 if (n != sizeof(header))
478 ERROR("[ERR] Could not read file %s\n", filename);
480 for(*model = 0; *model < NUM_MODELS; (*model)++)
481 if (memcmp(rb_model_names[*model], header + 4, 4) == 0)
482 break;
484 if(*model == NUM_MODELS)
485 ERROR("[ERR] Model name \"%4.4s\" unknown. Is this really a rockbox bootloader?\n", header + 4);
487 *bufsize = filesize(fd) - sizeof(header);
489 buf = malloc(*bufsize);
490 if (buf == NULL)
491 ERROR("[ERR] Could not allocate memory for %s\n", filename);
493 n = read(fd, buf, *bufsize);
495 if (n != *bufsize)
496 ERROR("[ERR] Could not read file %s\n", filename);
498 /* Check checksum */
499 sum = rb_model_num[*model];
500 for (i = 0; i < *bufsize; i++) {
501 /* add 8 unsigned bits but keep a 32 bit sum */
502 sum += buf[i];
505 if (sum != get_uint32be(header))
506 ERROR("[ERR] Checksum mismatch in %s\n", filename);
508 packed = uclpack(buf, *bufsize, rb_packedsize);
509 if(packed == NULL)
510 ERROR("[ERR] Could not compress %s\n", filename);
512 free(buf);
513 return packed;
515 error:
516 free(buf);
517 return NULL;
520 #undef ERROR
522 /* Patches a Sansa AMS Original Firmware file */
523 void patch_firmware(
524 int model, int fw_revision, int firmware_size, unsigned char* buf,
525 int len, unsigned char* of_packed, int of_packedsize,
526 unsigned char* rb_packed, int rb_packedsize)
528 unsigned char *p;
529 uint32_t sum, filesum;
530 uint32_t ucl_dest;
531 unsigned int i;
533 /* Zero the original firmware area - not needed, but helps debugging */
534 memset(buf + 0x400, 0, firmware_size);
536 /* Insert dual-boot bootloader at offset 0 */
537 memcpy(buf + 0x400, bootloaders[model], bootloader_sizes[model]);
539 /* We are filling the firmware buffer backwards from the end */
540 p = buf + 0x400 + firmware_size;
542 /* 1 - UCL unpack function */
543 p -= sizeof(nrv2e_d8);
544 memcpy(p, nrv2e_d8, sizeof(nrv2e_d8));
546 /* 2 - Compressed copy of original firmware */
547 p -= of_packedsize;
548 memcpy(p, of_packed, of_packedsize);
550 /* 3 - Compressed copy of Rockbox bootloader */
551 p -= rb_packedsize;
552 memcpy(p, rb_packed, rb_packedsize);
554 /* Write the locations of the various images to the variables at the
555 start of the dualboot image - we save the location of the last byte
556 in each image, along with the size in bytes */
558 /* UCL unpack function */
559 put_uint32le(&buf[0x420], firmware_size - 1);
560 put_uint32le(&buf[0x424], sizeof(nrv2e_d8));
562 /* Compressed original firmware image */
563 put_uint32le(&buf[0x428], firmware_size - sizeof(nrv2e_d8) - 1);
564 put_uint32le(&buf[0x42c], of_packedsize);
566 /* Compressed Rockbox image */
567 put_uint32le(&buf[0x430], firmware_size - sizeof(nrv2e_d8) - of_packedsize
568 - 1);
569 put_uint32le(&buf[0x434], rb_packedsize);
571 ucl_dest = model_memory_size(model) - 1; /* last byte of memory */
572 put_uint32le(&buf[0x438], ucl_dest);
574 /* Update the firmware block checksum */
575 sum = calc_checksum(buf + 0x400, firmware_size);
577 if (fw_revision == 1) {
578 put_uint32le(&buf[0x04], sum);
579 put_uint32le(&buf[0x204], sum);
580 } else if (fw_revision == 2) {
581 put_uint32le(&buf[0x08], sum);
582 put_uint32le(&buf[0x208], sum);
584 /* Update the header checksums */
585 put_uint32le(&buf[0x1fc], calc_checksum(buf, 0x1fc));
586 put_uint32le(&buf[0x3fc], calc_checksum(buf + 0x200, 0x1fc));
589 /* Update the whole-file checksum */
590 filesum = 0;
591 for (i=0;i < (unsigned)len - 4; i+=4)
592 filesum += get_uint32le(&buf[i]);
594 put_uint32le(buf + len - 4, filesum);
597 /* returns != 0 if the firmware can be safely patched */
598 int check_sizes(int model, int rb_packed_size, int rb_unpacked_size,
599 int of_packed_size, int of_unpacked_size, int *total_size,
600 char *errstr, int errstrsize)
602 unsigned int packed_size = bootloader_sizes[model] + sizeof(nrv2e_d8) +
603 of_packed_size + rb_packed_size;
605 /* how much memory is available */
606 unsigned int memory_size = model_memory_size(model);
608 /* the memory used when unpacking the OF */
609 unsigned int ram_of = sizeof(nrv2e_d8) + of_packed_size + of_unpacked_size;
611 /* the memory used when unpacking the bootloader */
612 unsigned int ram_rb = sizeof(nrv2e_d8) + rb_packed_size + rb_unpacked_size;
614 *total_size = packed_size;
616 #define ERROR(format, ...) \
617 do { \
618 snprintf(errstr, errstrsize, format, __VA_ARGS__); \
619 return 0; \
620 } while(0)
622 /* will packed data fit in the OF file ? */
623 if(packed_size > of_unpacked_size)
624 ERROR(
625 "[ERR] Packed data (%d bytes) doesn't fit in the firmware "
626 "(%d bytes)\n", packed_size, of_unpacked_size
629 else if(ram_rb > memory_size)
630 ERROR("[ERR] Rockbox can't be unpacked at runtime, needs %d bytes "
631 "of memory and only %d available\n", ram_rb, memory_size
634 else if(ram_of > memory_size)
635 ERROR("[ERR] OF can't be unpacked at runtime, needs %d bytes "
636 "of memory and only %d available\n", ram_of, memory_size
639 return 1;
641 #undef ERROR