1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2011 by Amaury Pouly
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
24 #include "mkimxboot.h"
29 struct imx_fw_variant_desc_t
31 /* Offset within file */
33 /* Total size of the firmware */
40 enum imx_model_t model
;
41 /* md5sum of the file */
45 /* Variant descriptions */
46 struct imx_fw_variant_desc_t fw_variants
[VARIANT_COUNT
];
49 struct imx_model_desc_t
51 /* Descriptive name of this model */
52 const char *model_name
;
53 /* Dualboot code for this model */
54 const unsigned char *dualboot
;
55 /* Size of dualboot functions for this model */
57 /* Model name used in the Rockbox header in ".sansa" files - these match the
58 -add parameter to the "scramble" tool */
59 const char *rb_model_name
;
60 /* Model number used to initialise the checksum in the Rockbox header in
61 ".sansa" files - these are the same as MODEL_NUMBER in config-target.h */
62 const int rb_model_num
;
63 /* Number of keys needed to decrypt/encrypt */
66 struct crypto_key_t
*keys
;
67 /* Dualboot load address */
68 uint32_t dualboot_addr
;
69 /* Bootloader load address */
70 uint32_t bootloader_addr
;
73 static const char *imx_fw_variant
[] =
75 [VARIANT_DEFAULT
] = "default",
76 [VARIANT_ZENXFI2_RECOVERY
] = "ZEN X-Fi2 Recovery",
77 [VARIANT_ZENXFI2_NAND
] = "ZEN X-Fi2 NAND",
78 [VARIANT_ZENXFI2_SD
] = "ZEN X-Fi2 eMMC/SD",
81 static const struct imx_md5sum_t imx_sums
[] =
85 MODEL_FUZEPLUS
, "c3e27620a877dc6b200b97dcb3e0ecc7", "2.38.6",
86 { [VARIANT_DEFAULT
] = { 0, 34652624 } }
89 /* Version 1.23.01e */
90 MODEL_ZENXFI2
, "e37e2c24abdff8e624d0a29f79157850", "1.23.01e",
93 /* Version 1.23.01e */
94 MODEL_ZENXFI2
, "2beff2168212d332f13cfc36ca46989d", "1.23.01e",
96 [VARIANT_ZENXFI2_RECOVERY
] = { 0x93010, 684192},
97 [VARIANT_ZENXFI2_NAND
] = { 0x13a0b0, 42410704 },
98 [VARIANT_ZENXFI2_SD
] = { 0x29ac380, 42304208 }
102 /* Version 1.00.15e */
103 MODEL_ZENXFI3
, "658a24eeef5f7186ca731085d8822a87", "1.00.15e",
104 { [VARIANT_DEFAULT
] = {0, 18110576} }
107 /* Version 1.00.22e */
108 MODEL_ZENXFI3
, "a5114cd45ea4554ec221f51a71083862", "1.00.22e",
109 { [VARIANT_DEFAULT
] = {0, 18110576} }
113 static struct crypto_key_t zero_key
=
115 .method
= CRYPTO_KEY
,
119 static const struct imx_model_desc_t imx_models
[] =
121 [MODEL_FUZEPLUS
] = { "Fuze+", dualboot_fuzeplus
, sizeof(dualboot_fuzeplus
), "fuz+", 72,
122 1, &zero_key
, 0, 0x40000000 },
123 [MODEL_ZENXFI2
] = {"Zen X-Fi2", dualboot_zenxfi2
, sizeof(dualboot_zenxfi2
), "zxf2", 82,
124 1, &zero_key
, 0, 0x40000000 },
125 [MODEL_ZENXFI3
] = {"Zen X-Fi3", dualboot_zenxfi3
, sizeof(dualboot_zenxfi3
), "zxf3", 83,
126 1, &zero_key
, 0, 0x40000000 },
129 #define NR_IMX_SUMS (sizeof(imx_sums) / sizeof(imx_sums[0]))
130 #define NR_IMX_MODELS (sizeof(imx_models) / sizeof(imx_models[0]))
132 #define MAGIC_ROCK 0x726f636b /* 'rock' */
133 #define MAGIC_RECOVERY 0xfee1dead
134 #define MAGIC_NORMAL 0xcafebabe
136 static enum imx_error_t
patch_std_zero_host_play(int jump_before
, int model
,
137 enum imx_output_type_t type
, struct sb_file_t
*sb_file
, void *boot
, size_t boot_sz
)
139 /* We assume the file has three boot sections: ____, host, play and one
140 * resource section rsrc.
144 * We patch the file by inserting the dualboot code before the <jump_before>th
145 * call in the ____ section. We give it as argument the section name 'rock'
146 * and add a section called 'rock' after rsrc which contains the bootloader.
148 * Single Boot & Recovery:
149 * -----------------------
150 * We patch the file by inserting the bootloader code after the <jump_before>th
151 * call in the ____ section and get rid of everything else. In recovery mode,
152 * we give 0xfee1dead as argument */
154 /* Do not override real key and IV */
155 sb_file
->override_crypto_iv
= false;
156 sb_file
->override_real_key
= false;
158 /* first locate the good instruction */
159 struct sb_section_t
*sec
= &sb_file
->sections
[0];
161 while(jump_idx
< sec
->nr_insts
&& jump_before
> 0)
162 if(sec
->insts
[jump_idx
++].inst
== SB_INST_CALL
)
164 if(jump_idx
== sec
->nr_insts
)
166 printf("[ERR] Cannot locate call in section ____\n");
167 return IMX_DONT_KNOW_HOW_TO_PATCH
;
170 if(type
== IMX_DUALBOOT
)
172 /* create a new instruction array with a hole for two instructions */
173 struct sb_inst_t
*new_insts
= xmalloc(sizeof(struct sb_inst_t
) * (sec
->nr_insts
+ 2));
174 memcpy(new_insts
, sec
->insts
, sizeof(struct sb_inst_t
) * jump_idx
);
175 memcpy(new_insts
+ jump_idx
+ 2, sec
->insts
+ jump_idx
,
176 sizeof(struct sb_inst_t
) * (sec
->nr_insts
- jump_idx
));
177 /* first instruction is be a load */
178 struct sb_inst_t
*load
= &new_insts
[jump_idx
];
179 memset(load
, 0, sizeof(struct sb_inst_t
));
180 load
->inst
= SB_INST_LOAD
;
181 load
->size
= imx_models
[model
].dualboot_size
;
182 load
->addr
= imx_models
[model
].dualboot_addr
;
183 /* duplicate memory because it will be free'd */
184 load
->data
= memdup(imx_models
[model
].dualboot
, imx_models
[model
].dualboot_size
);
185 /* second instruction is a call */
186 struct sb_inst_t
*call
= &new_insts
[jump_idx
+ 1];
187 memset(call
, 0, sizeof(struct sb_inst_t
));
188 call
->inst
= SB_INST_CALL
;
189 call
->addr
= imx_models
[model
].dualboot_addr
;
190 call
->argument
= MAGIC_ROCK
;
191 /* free old instruction array */
193 sec
->insts
= new_insts
;
196 /* create a new section */
197 struct sb_section_t rock_sec
;
198 memset(&rock_sec
, 0, sizeof(rock_sec
));
199 /* section has two instructions: load and call */
200 rock_sec
.identifier
= MAGIC_ROCK
;
201 rock_sec
.alignment
= BLOCK_SIZE
;
202 rock_sec
.nr_insts
= 2;
203 rock_sec
.insts
= xmalloc(2 * sizeof(struct sb_inst_t
));
204 memset(rock_sec
.insts
, 0, 2 * sizeof(struct sb_inst_t
));
205 rock_sec
.insts
[0].inst
= SB_INST_LOAD
;
206 rock_sec
.insts
[0].size
= boot_sz
;
207 rock_sec
.insts
[0].data
= memdup(boot
, boot_sz
);
208 rock_sec
.insts
[0].addr
= imx_models
[model
].bootloader_addr
;
209 rock_sec
.insts
[1].inst
= SB_INST_JUMP
;
210 rock_sec
.insts
[1].addr
= imx_models
[model
].bootloader_addr
;
211 rock_sec
.insts
[1].argument
= MAGIC_NORMAL
;
213 sb_file
->sections
= augment_array(sb_file
->sections
,
214 sizeof(struct sb_section_t
), sb_file
->nr_sections
,
216 sb_file
->nr_sections
++;
220 else if(type
== IMX_SINGLEBOOT
|| type
== IMX_RECOVERY
)
222 bool recovery
= type
== IMX_RECOVERY
;
223 /* remove everything after the call and add two instructions: load and call */
224 struct sb_inst_t
*new_insts
= xmalloc(sizeof(struct sb_inst_t
) * (jump_idx
+ 2));
225 memcpy(new_insts
, sec
->insts
, sizeof(struct sb_inst_t
) * jump_idx
);
226 for(int i
= jump_idx
; i
< sec
->nr_insts
; i
++)
227 sb_free_instruction(sec
->insts
[i
]);
228 memset(new_insts
+ jump_idx
, 0, 2 * sizeof(struct sb_inst_t
));
229 new_insts
[jump_idx
+ 0].inst
= SB_INST_LOAD
;
230 new_insts
[jump_idx
+ 0].size
= boot_sz
;
231 new_insts
[jump_idx
+ 0].data
= memdup(boot
, boot_sz
);
232 new_insts
[jump_idx
+ 0].addr
= imx_models
[model
].bootloader_addr
;
233 new_insts
[jump_idx
+ 1].inst
= SB_INST_JUMP
;
234 new_insts
[jump_idx
+ 1].addr
= imx_models
[model
].bootloader_addr
;
235 new_insts
[jump_idx
+ 1].argument
= recovery
? MAGIC_RECOVERY
: MAGIC_NORMAL
;
238 sec
->insts
= new_insts
;
239 sec
->nr_insts
= jump_idx
+ 2;
240 /* remove all other sections */
241 for(int i
= 1; i
< sb_file
->nr_sections
; i
++)
242 sb_free_section(sb_file
->sections
[i
]);
243 struct sb_section_t
*new_sec
= xmalloc(sizeof(struct sb_section_t
));
244 memcpy(new_sec
, &sb_file
->sections
[0], sizeof(struct sb_section_t
));
245 free(sb_file
->sections
);
246 sb_file
->sections
= new_sec
;
247 sb_file
->nr_sections
= 1;
253 printf("[ERR] Bad output type !\n");
254 return IMX_DONT_KNOW_HOW_TO_PATCH
;
258 static enum imx_error_t
patch_firmware(enum imx_model_t model
,
259 enum imx_firmware_variant_t variant
, enum imx_output_type_t type
,
260 struct sb_file_t
*sb_file
, void *boot
, size_t boot_sz
)
265 /* The Fuze+ uses the standard ____, host, play sections, patch after third
266 * call in ____ section */
267 return patch_std_zero_host_play(3, model
, type
, sb_file
, boot
, boot_sz
);
269 /* The ZEN X-Fi3 uses the standard ____, hSst, pSay sections, patch after third
270 * call in ____ section. Although sections names use the S variant, they are standard. */
271 return patch_std_zero_host_play(3, model
, type
, sb_file
, boot
, boot_sz
);
273 /* The ZEN X-Fi2 has two types of firmware: recovery and normal.
274 * Normal uses the standard ___, host, play sections and recovery only ____ */
277 case VARIANT_ZENXFI2_RECOVERY
:
278 case VARIANT_ZENXFI2_NAND
:
279 case VARIANT_ZENXFI2_SD
:
280 return patch_std_zero_host_play(1, model
, type
, sb_file
, boot
, boot_sz
);
282 return IMX_DONT_KNOW_HOW_TO_PATCH
;
286 return IMX_DONT_KNOW_HOW_TO_PATCH
;
290 static void imx_printf(void *user
, bool error
, color_t c
, const char *fmt
, ...)
306 static uint32_t get_uint32be(unsigned char *p
)
308 return (p
[0] << 24) | (p
[1] << 16) | (p
[2] << 8) | p
[3];
311 void dump_imx_dev_info(const char *prefix
)
313 printf("%smkimxboot models:\n", prefix
);
314 for(int i
= 0; i
< NR_IMX_MODELS
; i
++)
316 printf("%s %s: idx=%d rb_model=%s rb_num=%d\n", prefix
,
317 imx_models
[i
].model_name
, i
, imx_models
[i
].rb_model_name
,
318 imx_models
[i
].rb_model_num
);
320 printf("%smkimxboot variants:\n", prefix
);
321 for(int i
= 0; i
< VARIANT_COUNT
; i
++)
323 printf("%s %d: %s\n", prefix
, i
, imx_fw_variant
[i
]);
325 printf("%smkimxboot mapping:\n", prefix
);
326 for(int i
= 0; i
< NR_IMX_SUMS
; i
++)
328 printf("%s md5sum=%s -> idx=%d, ver=%s\n", prefix
, imx_sums
[i
].md5sum
,
329 imx_sums
[i
].model
, imx_sums
[i
].version
);
330 for(int j
= 0; j
< VARIANT_COUNT
; j
++)
331 if(imx_sums
[i
].fw_variants
[j
].size
)
332 printf("%s variant=%d -> offset=%#x size=%#x\n", prefix
,
333 j
, (unsigned)imx_sums
[i
].fw_variants
[j
].offset
,
334 (unsigned)imx_sums
[i
].fw_variants
[j
].size
);
338 enum imx_error_t
mkimxboot(const char *infile
, const char *bootfile
,
339 const char *outfile
, struct imx_option_t opt
)
342 if(opt
.fw_variant
> VARIANT_COUNT
) {
345 dump_imx_dev_info("[INFO] ");
346 /* compute MD5 sum of the file */
347 uint8_t file_md5sum
[16];
350 FILE *f
= fopen(infile
, "rb");
353 printf("[ERR] Cannot open input file\n");
354 return IMX_OPEN_ERROR
;
356 fseek(f
, 0, SEEK_END
);
357 size_t sz
= ftell(f
);
358 fseek(f
, 0, SEEK_SET
);
359 void *buf
= xmalloc(sz
);
360 if(fread(buf
, sz
, 1, f
) != 1)
364 printf("[ERR] Cannot read file\n");
365 return IMX_READ_ERROR
;
370 md5_update(&ctx
, buf
, sz
);
371 md5_finish(&ctx
, file_md5sum
);
374 printf("[INFO] MD5 sum of the file: ");
375 print_hex(file_md5sum
, 16, true);
377 enum imx_model_t model
;
382 while(i
< NR_IMX_SUMS
)
385 if(strlen(imx_sums
[i
].md5sum
) != 32)
387 printf("[INFO] Invalid MD5 sum in imx_sums\n");
390 for(int j
= 0; j
< 16; j
++)
393 if(convxdigit(imx_sums
[i
].md5sum
[2 * j
], &a
) || convxdigit(imx_sums
[i
].md5sum
[2 * j
+ 1], &b
))
395 printf("[ERR][INTERNAL] Bad checksum format: %s\n", imx_sums
[i
].md5sum
);
398 md5
[j
] = (a
<< 4) | b
;
400 if(memcmp(file_md5sum
, md5
, 16) == 0)
406 printf("[ERR] MD5 sum doesn't match any known file\n");
409 model
= imx_sums
[i
].model
;
412 printf("[INFO] File is for model %d (%s, version %s)\n", model
,
413 imx_models
[model
].model_name
, imx_sums
[md5_idx
].version
);
414 /* load rockbox file */
419 FILE *f
= fopen(bootfile
, "rb");
422 printf("[ERR] Cannot open boot file\n");
423 return IMX_OPEN_ERROR
;
425 fseek(f
, 0, SEEK_END
);
426 boot_size
= ftell(f
);
427 fseek(f
, 0, SEEK_SET
);
428 boot
= xmalloc(boot_size
);
429 if(fread(boot
, boot_size
, 1, f
) != 1)
433 printf("[ERR] Cannot read boot file\n");
434 return IMX_READ_ERROR
;
438 /* Check boot file */
443 printf("[ERR] Bootloader file is too small to be valid\n");
445 return IMX_BOOT_INVALID
;
447 /* check model name */
448 uint8_t *name
= boot
+ 4;
449 if(memcmp(name
, imx_models
[model
].rb_model_name
, 4) != 0)
451 printf("[ERR] Bootloader model doesn't match found model for input file\n");
453 return IMX_BOOT_MISMATCH
;
456 uint32_t sum
= imx_models
[model
].rb_model_num
;
457 for(int i
= 8; i
< boot_size
; i
++)
459 if(sum
!= get_uint32be(boot
))
461 printf("[ERR] Bootloader checksum mismatch\n");
463 return IMX_BOOT_CHECKSUM_ERROR
;
467 struct sb_file_t
*sb_file
;
470 if(imx_sums
[md5_idx
].fw_variants
[opt
.fw_variant
].size
== 0)
472 printf("[ERR] Input file does not contain variant '%s'\n", imx_fw_variant
[opt
.fw_variant
]);
474 return IMX_VARIANT_MISMATCH
;
479 add_keys(imx_models
[model
].keys
, imx_models
[model
].nr_keys
);
480 sb_file
= sb_read_file_ex(infile
, imx_sums
[md5_idx
].fw_variants
[opt
.fw_variant
].offset
,
481 imx_sums
[md5_idx
].fw_variants
[opt
.fw_variant
].size
, false, NULL
, &imx_printf
, &err
);
486 return IMX_FIRST_SB_ERROR
+ err
;
490 enum imx_error_t ret
= patch_firmware(model
, opt
.fw_variant
, opt
.output
, sb_file
, boot
+ 8, boot_size
- 8);
491 if(ret
== IMX_SUCCESS
)
492 ret
= sb_write_file(sb_file
, outfile
);
500 enum imx_error_t
extract_firmware(const char *infile
,
501 enum imx_firmware_variant_t fw_variant
, const char *outfile
)
504 if(fw_variant
> VARIANT_COUNT
) {
507 dump_imx_dev_info("[INFO] ");
508 /* compute MD5 sum of the file */
509 uint8_t file_md5sum
[16];
510 FILE *f
= fopen(infile
, "rb");
513 printf("[ERR] Cannot open input file\n");
514 return IMX_OPEN_ERROR
;
516 fseek(f
, 0, SEEK_END
);
517 size_t sz
= ftell(f
);
518 fseek(f
, 0, SEEK_SET
);
519 void *buf
= xmalloc(sz
);
520 if(fread(buf
, sz
, 1, f
) != 1)
524 printf("[ERR] Cannot read file\n");
525 return IMX_READ_ERROR
;
529 md5_update(&ctx
, buf
, sz
);
530 md5_finish(&ctx
, file_md5sum
);
533 printf("[INFO] MD5 sum of the file: ");
534 print_hex(file_md5sum
, 16, true);
536 enum imx_model_t model
;
541 while(i
< NR_IMX_SUMS
)
544 if(strlen(imx_sums
[i
].md5sum
) != 32)
546 printf("[INFO] Invalid MD5 sum in imx_sums\n");
549 for(int j
= 0; j
< 16; j
++)
552 if(convxdigit(imx_sums
[i
].md5sum
[2 * j
], &a
) || convxdigit(imx_sums
[i
].md5sum
[2 * j
+ 1], &b
))
554 printf("[ERR][INTERNAL] Bad checksum format: %s\n", imx_sums
[i
].md5sum
);
558 md5
[j
] = (a
<< 4) | b
;
560 if(memcmp(file_md5sum
, md5
, 16) == 0)
566 printf("[ERR] MD5 sum doesn't match any known file\n");
569 model
= imx_sums
[i
].model
;
572 printf("[INFO] File is for model %d (%s, version %s)\n", model
,
573 imx_models
[model
].model_name
, imx_sums
[md5_idx
].version
);
575 if(imx_sums
[md5_idx
].fw_variants
[fw_variant
].size
== 0)
577 printf("[ERR] Input file does not contain variant '%s'\n", imx_fw_variant
[fw_variant
]);
579 return IMX_VARIANT_MISMATCH
;
582 f
= fopen(outfile
, "wb");
585 printf("[ERR] Cannot open input file\n");
587 return IMX_OPEN_ERROR
;
589 enum imx_error_t ret
= IMX_SUCCESS
;
591 if(fwrite(buf
+ imx_sums
[md5_idx
].fw_variants
[fw_variant
].offset
,
592 imx_sums
[md5_idx
].fw_variants
[fw_variant
].size
, 1, f
) != 1)
594 printf("[ERR] Cannot write file\n");