1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * mkamsboot.c - a tool for merging bootloader code into an Sansa V2
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
33 |----------------------| 0x400
34 | FIRMWARE BLOCK | (contains the OF version on some fuzev2 firmwares
35 |----------------------| 0x600
37 |----------------------| 0x400 + firmware block size
39 ---------------------- END
41 We replace the main firmware block while preserving the potential OF version
42 (bytes 0x600..0x400+firmware_size) as follows:
45 ---------------------- 0x0
49 |----------------------|
51 |----------------------|
53 | compressed RB image |
55 |----------------------|
57 | compressed OF image |
59 |----------------------|
60 | UCL unpack function |
61 ----------------------
63 This entire block fits into the space previously occupied by the main
64 firmware block - the space saved by compressing the OF image is used
65 to store the compressed version of the Rockbox bootloader.
67 On version 1 firmwares, the OF image is typically about 120KB, which allows
68 us to store a Rockbox bootloader with an uncompressed size of about 60KB-70KB.
69 Version 2 firmwares are bigger and are stored in SDRAM (instead of IRAM).
70 In both cases, the RAM we are using is mapped at offset 0x0.
72 mkamsboot then corrects the checksums and writes a new legal firmware
73 file which can be installed on the device.
75 When the Sansa device boots, this firmware block is loaded to RAM at
76 address 0x0 and executed.
78 Firstly, the dual-boot code will copy the UCL unpack function to the
81 Then, depending on the detection of the dual-boot keypress, either the
82 OF image or the Rockbox image is copied to the end of RAM (just before
83 the ucl unpack function) and uncompressed to the start of RAM.
85 Finally, the ucl unpack function branches to address 0x0, passing
86 execution to the uncompressed firmware.
94 #include <sys/types.h>
102 #include "mkamsboot.h"
106 /* Header for ARM code binaries */
107 #include "dualboot.h"
109 /* Win32 compatibility */
114 /* fw_revision: version 2 is used in Clipv2, Clip+ and Fuzev2 firmwares */
115 /* hw_revision: 4 for m200, 2 for e200/c200, 1 or 2 for fuze/clip, 1 for clip+ */
116 const struct ams_models ams_identity
[] = {
117 [MODEL_C200V2
] = { 2, 1, "c200", dualboot_c200v2
, sizeof(dualboot_c200v2
), "c2v2", 44 },
118 [MODEL_CLIPPLUS
]= { 1, 2, "Clip+", dualboot_clipplus
, sizeof(dualboot_clipplus
), "cli+", 66 },
119 [MODEL_CLIPV2
] = { 2, 2, "Clip", dualboot_clipv2
, sizeof(dualboot_clipv2
), "clv2", 60 },
120 [MODEL_CLIP
] = { 1, 1, "Clip", dualboot_clip
, sizeof(dualboot_clip
), "clip", 40 },
121 [MODEL_E200V2
] = { 2, 1, "e200", dualboot_e200v2
, sizeof(dualboot_e200v2
), "e2v2", 41 },
122 [MODEL_FUZEV2
] = { 2, 2, "Fuze", dualboot_fuzev2
, sizeof(dualboot_fuzev2
), "fuz2", 68 },
123 [MODEL_FUZE
] = { 1, 1, "Fuze", dualboot_fuze
, sizeof(dualboot_fuze
), "fuze", 43 },
124 [MODEL_M200V4
] = { 4, 1, "m200", dualboot_m200v4
, sizeof(dualboot_m200v4
), "m2v4", 42 },
128 /* Checksums of unmodified original firmwares - for safety, and device
130 static struct md5sums sansasums
[] = {
131 /* NOTE: Different regional versions of the firmware normally only
132 differ in the filename - the md5sums are identical */
134 /* model version md5 */
135 { MODEL_E200V2
, "3.01.11", "e622ca8cb6df423f54b8b39628a1f0a3" },
136 { MODEL_E200V2
, "3.01.14", "2c1d0383fc3584b2cc83ba8cc2243af6" },
137 { MODEL_E200V2
, "3.01.16", "12563ad71b25a1034cf2092d1e0218c4" },
139 { MODEL_FUZE
, "1.01.11", "cac8ffa03c599330ac02c4d41de66166" },
140 { MODEL_FUZE
, "1.01.15", "df0e2c1612727f722c19a3c764cff7f2" },
141 { MODEL_FUZE
, "1.01.22", "5aff5486fe8dd64239cc71eac470af98" },
142 { MODEL_FUZE
, "1.02.26", "7c632c479461c48c8833baed74eb5e4f" },
143 { MODEL_FUZE
, "1.02.28", "5b34260f6470e75f702a9c6825471752" },
144 { MODEL_FUZE
, "1.02.31", "66d01b37462a5ef7ccc6ad37188b4235" },
146 { MODEL_C200V2
, "3.02.05", "b6378ebd720b0ade3fad4dc7ab61c1a5" },
148 { MODEL_M200V4
, "4.00.45", "82e3194310d1514e3bbcd06e84c4add3" },
149 { MODEL_M200V4
, "4.01.08-A", "fc9dd6116001b3e6a150b898f1b091f0" },
150 { MODEL_M200V4
, "4.01.08-E", "d3fb7d8ec8624ee65bc99f8dab0e2369" },
152 { MODEL_CLIP
, "1.01.17", "12caad785d506219d73f538772afd99e" },
153 { MODEL_CLIP
, "1.01.18", "d720b266bd5afa38a198986ef0508a45" },
154 { MODEL_CLIP
, "1.01.20", "236d8f75189f468462c03f6d292cf2ac" },
155 { MODEL_CLIP
, "1.01.29", "c12711342169c66e209540cd1f27cd26" },
156 { MODEL_CLIP
, "1.01.30", "f2974d47c536549c9d8259170f1dbe4d" },
157 { MODEL_CLIP
, "1.01.32", "d835d12342500732ffb9c4ee54abec15" },
158 { MODEL_CLIP
, "1.01.35", "b4d0edb3b8f2a4e8eee0a344f7f8e480" },
160 { MODEL_CLIPV2
, "2.01.16", "c57fb3fcbe07c2c9b360f060938f80cb" },
161 { MODEL_CLIPV2
, "2.01.32", "0ad3723e52022509089d938d0fbbf8c5" },
162 { MODEL_CLIPV2
, "2.01.35", "a3cbbd22b9508d7f8a9a1a39acc342c2" },
164 { MODEL_CLIPPLUS
, "01.02.09", "656d38114774c2001dc18e6726df3c5d" },
165 { MODEL_CLIPPLUS
, "01.02.13", "5f89872b79ef440b0e5ee3a7a44328b2" },
166 { MODEL_CLIPPLUS
, "01.02.15", "680a4f521e790ad25b93b1b16f3a207d" },
168 { MODEL_FUZEV2
, "2.01.17", "8b85fb05bf645d08a4c8c3e344ec9ebe" },
169 { MODEL_FUZEV2
, "2.02.26", "d4f6f85c3e4a8ea8f2e5acc421641801" },
170 { MODEL_FUZEV2
, "2.03.31", "74fb197ccd51707388f3b233402186a6" },
171 { MODEL_FUZEV2
, "2.03.33", "1599cc73d02ea7fe53fe2d4379c24b66" },
174 #define NUM_MD5S (sizeof(sansasums)/sizeof(sansasums[0]))
176 static unsigned int model_memory_size(int model
)
178 /* The OF boots with IRAM (320kB) mapped at 0x0 */
180 if(model
== MODEL_CLIPV2
)
182 /* The decompressed Clipv2 OF is around 380kB.
183 * Let's use the full IRAM (1MB on AMSv2)
189 /* The IRAM is 320kB on AMSv1, and 320 will be enough on Fuzev1/Clip+ */
194 int firmware_revision(int model
)
196 return ams_identity
[model
].fw_revision
;
199 static off_t
filesize(int fd
)
203 if (fstat(fd
, &buf
) < 0) {
204 perror("[ERR] Checking filesize of input file");
211 static uint32_t get_uint32le(unsigned char* p
)
213 return p
[0] | (p
[1] << 8) | (p
[2] << 16) | (p
[3] << 24);
216 static uint32_t get_uint32be(unsigned char* p
)
218 return (p
[0] << 24) | (p
[1] << 16) | (p
[2] << 8) | p
[3];
221 static void put_uint32le(unsigned char* p
, uint32_t x
)
224 p
[1] = (x
>> 8) & 0xff;
225 p
[2] = (x
>> 16) & 0xff;
226 p
[3] = (x
>> 24) & 0xff;
229 void calc_MD5(unsigned char* buf
, int len
, char *md5str
)
233 unsigned char md5sum
[16];
236 md5_update(&ctx
, buf
, len
);
237 md5_finish(&ctx
, md5sum
);
239 for (i
= 0; i
< 16; ++i
)
240 sprintf(md5str
+ 2*i
, "%02x", md5sum
[i
]);
243 /* Calculate a simple checksum used in Sansa Original Firmwares */
244 static uint32_t calc_checksum(unsigned char* buf
, uint32_t n
)
250 sum
+= get_uint32le(buf
+ i
);
255 /* Compress using nrv2e algorithm : Thumb decompressor fits in 168 bytes ! */
256 static unsigned char* uclpack(unsigned char* inbuf
, int insize
, int* outsize
)
259 unsigned char* outbuf
;
262 /* The following formula comes from the UCL documentation */
263 maxsize
= insize
+ (insize
/ 8) + 256;
265 /* Allocate some memory for the output buffer */
266 outbuf
= malloc(maxsize
);
271 r
= ucl_nrv2e_99_compress(
272 (const ucl_bytep
) inbuf
,
278 if (r
!= UCL_E_OK
|| *outsize
> maxsize
) {
279 /* this should NEVER happen, and implies memory corruption */
280 fprintf(stderr
, "internal error - compression failed: %d\n", r
);
288 #define ERROR(format, ...) \
290 snprintf(errstr, errstrsize, format, __VA_ARGS__); \
294 /* Loads a Sansa AMS Original Firmware file into memory */
295 unsigned char* load_of_file(
296 char* filename
, int model
, off_t
* bufsize
, struct md5sums
*sum
,
297 int* firmware_size
, unsigned char** of_packed
,
298 int* of_packedsize
, char* errstr
, int errstrsize
)
301 unsigned char* buf
=NULL
;
305 unsigned int last_word
;
307 fd
= open(filename
, O_RDONLY
|O_BINARY
);
309 ERROR("[ERR] Could not open %s for reading\n", filename
);
311 *bufsize
= filesize(fd
);
313 buf
= malloc(*bufsize
);
315 ERROR("[ERR] Could not allocate memory for %s\n", filename
);
317 n
= read(fd
, buf
, *bufsize
);
320 ERROR("[ERR] Could not read file %s\n", filename
);
324 /* Calculate MD5 checksum of OF */
325 calc_MD5(buf
, *bufsize
, sum
->md5
);
327 while ((i
< NUM_MD5S
) && (strcmp(sansasums
[i
].md5
, sum
->md5
) != 0))
332 if(sum
->model
!= model
) {
333 ERROR("[ERR] OF File provided is %sv%d version %s, not for %sv%d\n",
334 ams_identity
[sum
->model
].model_name
, ams_identity
[sum
->model
].hw_revision
,
335 sum
->version
, ams_identity
[model
].model_name
, ams_identity
[model
].hw_revision
339 /* OF unknown, give a list of tested versions for the requested model */
341 char tested_versions
[100];
342 tested_versions
[0] = '\0';
344 for (i
= 0; i
< NUM_MD5S
; i
++)
345 if (sansasums
[i
].model
== model
) {
346 if (tested_versions
[0] != '\0') {
347 strncat(tested_versions
, ", ",
348 sizeof(tested_versions
) - strlen(tested_versions
) - 1);
350 strncat(tested_versions
, sansasums
[i
].version
,
351 sizeof(tested_versions
) - strlen(tested_versions
) - 1);
354 ERROR("[ERR] Original firmware unknown, please try an other version." \
355 " Tested %sv%d versions are : %s\n",
356 ams_identity
[model
].model_name
, ams_identity
[model
].hw_revision
, tested_versions
);
359 /* TODO: Do some more sanity checks on the OF image. Some images (like
360 m200v4) dont have a checksum at the end, only padding (0xdeadbeef). */
361 last_word
= *bufsize
- 4;
362 checksum
= get_uint32le(buf
+ last_word
);
363 if (checksum
!= 0xefbeadde && checksum
!= calc_checksum(buf
, last_word
))
364 ERROR("%s", "[ERR] Whole file checksum failed\n");
366 if (ams_identity
[sum
->model
].bootloader
== NULL
)
367 ERROR("[ERR] Unsupported model - \"%s\"\n", ams_identity
[sum
->model
].model_name
);
369 /* Get the firmware size */
370 if (ams_identity
[sum
->model
].fw_revision
== 1)
371 *firmware_size
= get_uint32le(&buf
[0x0c]);
372 else if (ams_identity
[sum
->model
].fw_revision
== 2)
373 *firmware_size
= get_uint32le(&buf
[0x10]);
375 /* Compress the original firmware image */
376 *of_packed
= uclpack(buf
+ 0x400, *firmware_size
, of_packedsize
);
377 if (*of_packed
== NULL
)
378 ERROR("[ERR] Could not compress %s\n", filename
);
387 /* Loads a rockbox bootloader file into memory */
388 unsigned char* load_rockbox_file(
389 char* filename
, int *model
, int* bufsize
, int* rb_packedsize
,
390 char* errstr
, int errstrsize
)
393 unsigned char* buf
= NULL
;
394 unsigned char* packed
= NULL
;
395 unsigned char header
[8];
400 fd
= open(filename
, O_RDONLY
|O_BINARY
);
402 ERROR("[ERR] Could not open %s for reading\n", filename
);
404 /* Read Rockbox header */
405 n
= read(fd
, header
, sizeof(header
));
406 if (n
!= sizeof(header
))
407 ERROR("[ERR] Could not read file %s\n", filename
);
409 for(*model
= 0; *model
< NUM_MODELS
; (*model
)++)
410 if (memcmp(ams_identity
[*model
].rb_model_name
, header
+ 4, 4) == 0)
413 if(*model
== NUM_MODELS
)
414 ERROR("[ERR] Model name \"%4.4s\" unknown. Is this really a rockbox bootloader?\n", header
+ 4);
416 *bufsize
= filesize(fd
) - sizeof(header
);
418 buf
= malloc(*bufsize
);
420 ERROR("[ERR] Could not allocate memory for %s\n", filename
);
422 n
= read(fd
, buf
, *bufsize
);
425 ERROR("[ERR] Could not read file %s\n", filename
);
428 sum
= ams_identity
[*model
].rb_model_num
;
429 for (i
= 0; i
< *bufsize
; i
++) {
430 /* add 8 unsigned bits but keep a 32 bit sum */
434 if (sum
!= get_uint32be(header
))
435 ERROR("[ERR] Checksum mismatch in %s\n", filename
);
437 packed
= uclpack(buf
, *bufsize
, rb_packedsize
);
439 ERROR("[ERR] Could not compress %s\n", filename
);
451 /* Patches a Sansa AMS Original Firmware file */
453 int model
, int fw_revision
, int firmware_size
, unsigned char* buf
,
454 int len
, unsigned char* of_packed
, int of_packedsize
,
455 unsigned char* rb_packed
, int rb_packedsize
)
458 uint32_t sum
, filesum
;
462 /* Zero the original firmware area - not needed, but helps debugging */
463 memset(buf
+ 0x600, 0, firmware_size
);
465 /* Insert dual-boot bootloader at offset 0x200, we preserve the OF
466 * version string located between 0x0 and 0x200 */
467 memcpy(buf
+ 0x600, ams_identity
[model
].bootloader
, ams_identity
[model
].bootloader_size
);
469 /* Insert vectors, they won't overwrite the OF version string */
471 /* Reset vector: branch 0x200 bytes away, to our dualboot code */
472 static const uint8_t b_0x200
[4] = { 0x7e, 0x00, 0x00, 0xea }; // b 0x200
473 memcpy(buf
+ 0x400, b_0x200
, sizeof(b_0x200
));
475 /* Other vectors: infinite loops */
476 static const uint8_t b_1b
[4] = { 0xfe, 0xff, 0xff, 0xea }; // 1: b 1b
477 for (i
=1; i
< 8; i
++)
478 memcpy(buf
+ 0x400 + 4*i
, b_1b
, sizeof(b_1b
));
480 /* We are filling the firmware buffer backwards from the end */
481 p
= buf
+ 0x400 + firmware_size
;
483 /* 1 - UCL unpack function */
484 p
-= sizeof(nrv2e_d8
);
485 memcpy(p
, nrv2e_d8
, sizeof(nrv2e_d8
));
487 /* 2 - Compressed copy of original firmware */
489 memcpy(p
, of_packed
, of_packedsize
);
491 /* 3 - Compressed copy of Rockbox bootloader */
493 memcpy(p
, rb_packed
, rb_packedsize
);
495 /* Write the locations of the various images to the variables at the
496 start of the dualboot image - we save the location of the last byte
497 in each image, along with the size in bytes */
499 /* UCL unpack function */
500 put_uint32le(&buf
[0x604], firmware_size
- 1);
501 put_uint32le(&buf
[0x608], sizeof(nrv2e_d8
));
503 /* Compressed original firmware image */
504 put_uint32le(&buf
[0x60c], firmware_size
- sizeof(nrv2e_d8
) - 1);
505 put_uint32le(&buf
[0x610], of_packedsize
);
507 /* Compressed Rockbox image */
508 put_uint32le(&buf
[0x614], firmware_size
- sizeof(nrv2e_d8
) - of_packedsize
510 put_uint32le(&buf
[0x618], rb_packedsize
);
512 ucl_dest
= model_memory_size(model
) - 1; /* last byte of memory */
513 put_uint32le(&buf
[0x61c], ucl_dest
);
515 /* Update the firmware block checksum */
516 sum
= calc_checksum(buf
+ 0x400, firmware_size
);
518 if (fw_revision
== 1) {
519 put_uint32le(&buf
[0x04], sum
);
520 put_uint32le(&buf
[0x204], sum
);
521 } else if (fw_revision
== 2) {
522 put_uint32le(&buf
[0x08], sum
);
523 put_uint32le(&buf
[0x208], sum
);
525 /* Update the header checksums */
526 put_uint32le(&buf
[0x1fc], calc_checksum(buf
, 0x1fc));
527 put_uint32le(&buf
[0x3fc], calc_checksum(buf
+ 0x200, 0x1fc));
530 /* Update the whole-file checksum */
532 for (i
=0;i
< (unsigned)len
- 4; i
+=4)
533 filesum
+= get_uint32le(&buf
[i
]);
535 put_uint32le(buf
+ len
- 4, filesum
);
538 /* returns != 0 if the firmware can be safely patched */
539 int check_sizes(int model
, int rb_packed_size
, int rb_unpacked_size
,
540 int of_packed_size
, int of_unpacked_size
, int *total_size
,
541 char *errstr
, int errstrsize
)
543 /* XXX: we keep the first 0x200 bytes block unmodified, we just replace
545 unsigned int packed_size
= ams_identity
[model
].bootloader_size
+ sizeof(nrv2e_d8
) +
546 of_packed_size
+ rb_packed_size
+ 0x200;
548 /* how much memory is available */
549 unsigned int memory_size
= model_memory_size(model
);
551 /* the memory used when unpacking the OF */
552 unsigned int ram_of
= sizeof(nrv2e_d8
) + of_packed_size
+ of_unpacked_size
;
554 /* the memory used when unpacking the bootloader */
555 unsigned int ram_rb
= sizeof(nrv2e_d8
) + rb_packed_size
+ rb_unpacked_size
;
557 *total_size
= packed_size
;
559 #define ERROR(format, ...) \
561 snprintf(errstr, errstrsize, format, __VA_ARGS__); \
565 /* will packed data fit in the OF file ? */
566 if(packed_size
> of_unpacked_size
)
568 "[ERR] Packed data (%d bytes) doesn't fit in the firmware "
569 "(%d bytes)\n", packed_size
, of_unpacked_size
572 else if(ram_rb
> memory_size
)
573 ERROR("[ERR] Rockbox can't be unpacked at runtime, needs %d bytes "
574 "of memory and only %d available\n", ram_rb
, memory_size
577 else if(ram_of
> memory_size
)
578 ERROR("[ERR] OF can't be unpacked at runtime, needs %d bytes "
579 "of memory and only %d available\n", ram_of
, memory_size