1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2006 by Barry Wardell
12 * Based on Rockbox iriver bootloader by Linus Nielsen Feltzing
13 * and the ipodlinux bootloader by Daniel Palffy and Bernard Leach
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 ****************************************************************************/
39 #include "crc32-mi4.h"
42 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
44 #include "backlight-target.h"
46 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
51 /* Show the Rockbox logo - in show_logo.c */
52 extern int show_logo(void);
54 /* Button definitions */
55 #if CONFIG_KEYPAD == IRIVER_H10_PAD
56 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
58 #elif CONFIG_KEYPAD == SANSA_E200_PAD
59 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
61 #elif CONFIG_KEYPAD == SANSA_C200_PAD
62 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
64 #elif CONFIG_KEYPAD == MROBE100_PAD
65 #define BOOTLOADER_BOOT_OF BUTTON_POWER
67 #elif CONFIG_KEYPAD == PHILIPS_SA9200_PAD
68 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
70 #elif CONFIG_KEYPAD == PHILIPS_HDD1630_PAD
71 #define BOOTLOADER_BOOT_OF BUTTON_MENU
73 #elif CONFIG_KEYPAD == SAMSUNG_YH_PAD
74 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
76 #elif CONFIG_KEYPAD == SANSA_FUZE_PAD
77 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
81 /* Maximum allowed firmware image size. 10MB is more than enough */
82 #define MAX_LOADSIZE (10*1024*1024)
84 /* A buffer to load the original firmware or Rockbox into */
85 unsigned char *loadbuffer
= (unsigned char *)DRAM_START
;
87 /* Bootloader version */
88 char version
[] = APPSVERSION
;
90 /* Locations and sizes in hidden partition on Sansa */
91 #if (CONFIG_STORAGE & STORAGE_SD)
92 #define PPMI_SECTOR_OFFSET 1024
93 #define PPMI_SECTORS 1
94 #define MI4_HEADER_SECTORS 1
95 #define NUM_PARTITIONS 2
98 #define NUM_PARTITIONS 1
102 #define MI4_HEADER_SIZE 0x200
104 /* mi4 header structure */
106 unsigned char magic
[4];
113 uint32_t dsa_key
[10];
115 unsigned char type
[4];
116 unsigned char model
[4];
119 /* PPMI header structure */
120 struct ppmi_header_t
{
121 unsigned char magic
[4];
126 inline unsigned int le2int(unsigned char* buf
)
128 int32_t res
= (buf
[3] << 24) | (buf
[2] << 16) | (buf
[1] << 8) | buf
[0];
133 inline void int2le(unsigned int val
, unsigned char* addr
)
135 addr
[0] = val
& 0xFF;
136 addr
[1] = (val
>> 8) & 0xff;
137 addr
[2] = (val
>> 16) & 0xff;
138 addr
[3] = (val
>> 24) & 0xff;
146 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
147 struct tea_key tea_keytable
[] = {
148 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
149 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
150 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
151 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
152 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
153 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
154 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
155 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
156 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
157 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
158 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
159 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
160 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
161 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
162 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
163 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
164 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
169 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
171 "Following is an adaptation of the reference encryption and decryption
172 routines in C, released into the public domain by David Wheeler and
177 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
178 to the reference implementation and the main loop is 8 iterations, not
182 static void tea_decrypt(uint32_t* v0
, uint32_t* v1
, uint32_t* k
) {
183 uint32_t sum
=0xF1BBCDC8, i
; /* set up */
184 uint32_t delta
=0x9E3779B9; /* a key schedule constant */
185 uint32_t k0
=k
[0], k1
=k
[1], k2
=k
[2], k3
=k
[3]; /* cache key */
186 for(i
=0; i
<8; i
++) { /* basic cycle start */
187 *v1
-= ((*v0
<<4) + k2
) ^ (*v0
+ sum
) ^ ((*v0
>>5) + k3
);
188 *v0
-= ((*v1
<<4) + k0
) ^ (*v1
+ sum
) ^ ((*v1
>>5) + k1
);
189 sum
-= delta
; /* end cycle */
193 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
194 integers) and the key is incremented after each block
197 static void tea_decrypt_buf(unsigned char* src
, unsigned char* dest
, size_t n
, uint32_t * key
)
202 for (i
= 0; i
< (n
/ 8); i
++) {
206 tea_decrypt(&v0
, &v1
, key
);
214 /* Now increment the key */
228 static inline bool tea_test_key(unsigned char magic_enc
[8], uint32_t * key
, int unaligned
)
230 unsigned char magic_dec
[8];
231 tea_decrypt_buf(magic_enc
, magic_dec
, 8, key
);
233 return (le2int(&magic_dec
[4*unaligned
]) == 0xaa55aa55);
236 static int tea_find_key(struct mi4header_t
*mi4header
, int fd
)
242 unsigned char magic_enc
[8];
244 unsigned int magic_location
= mi4header
->length
-4;
247 if ( (magic_location
% 8) != 0 )
253 /* Load encrypted magic 0xaa55aa55 to check key */
254 lseek(fd
, MI4_HEADER_SIZE
+ magic_location
, SEEK_SET
);
255 rc
= read(fd
, magic_enc
, 8);
257 return EREAD_IMAGE_FAILED
;
259 printf("Searching for key:");
261 for (i
=0; i
< NUM_KEYS
&& (key_found
<0) ; i
++) {
262 key
[0] = tea_keytable
[i
].key
[0];
263 key
[1] = tea_keytable
[i
].key
[1];
264 key
[2] = tea_keytable
[i
].key
[2];
265 key
[3] = tea_keytable
[i
].key
[3];
267 /* Now increment the key */
268 for(j
=0; j
<((magic_location
-mi4header
->plaintext
)/8); j
++){
281 if (tea_test_key(magic_enc
,key
,unaligned
))
284 printf("%s...found", tea_keytable
[i
].name
);
286 /* printf("%s...failed", tea_keytable[i].name); */
294 /* Load mi4 format firmware image */
295 int load_mi4(unsigned char* buf
, char* firmware
, unsigned int buffer_size
)
298 struct mi4header_t mi4header
;
301 char filename
[MAX_PATH
];
303 snprintf(filename
,sizeof(filename
), BOOTDIR
"/%s",firmware
);
304 fd
= open(filename
, O_RDONLY
);
307 snprintf(filename
,sizeof(filename
),"/%s",firmware
);
308 fd
= open(filename
, O_RDONLY
);
310 return EFILE_NOT_FOUND
;
313 read(fd
, &mi4header
, MI4_HEADER_SIZE
);
316 printf("mi4 size: %x", mi4header
.mi4size
);
318 if ((mi4header
.mi4size
-MI4_HEADER_SIZE
) > buffer_size
)
319 return EFILE_TOO_BIG
;
322 printf("CRC32: %x", mi4header
.crc32
);
324 /* Rockbox model id */
325 printf("Model id: %.4s", mi4header
.model
);
327 /* Read binary type (RBOS, RBBL) */
328 printf("Binary type: %.4s", mi4header
.type
);
330 /* Load firmware file */
331 lseek(fd
, MI4_HEADER_SIZE
, SEEK_SET
);
332 rc
= read(fd
, buf
, mi4header
.mi4size
-MI4_HEADER_SIZE
);
333 if(rc
< (int)mi4header
.mi4size
-MI4_HEADER_SIZE
)
334 return EREAD_IMAGE_FAILED
;
336 /* Check CRC32 to see if we have a valid file */
337 sum
= chksum_crc32 (buf
, mi4header
.mi4size
- MI4_HEADER_SIZE
);
339 printf("Calculated CRC32: %x", sum
);
341 if(sum
!= mi4header
.crc32
)
344 if( (mi4header
.plaintext
+ MI4_HEADER_SIZE
) != mi4header
.mi4size
)
346 /* Load encrypted firmware */
347 int key_index
= tea_find_key(&mi4header
, fd
);
350 return EINVALID_FORMAT
;
352 /* Plaintext part is already loaded */
353 buf
+= mi4header
.plaintext
;
355 /* Decrypt in-place */
356 tea_decrypt_buf(buf
, buf
,
357 mi4header
.mi4size
-(mi4header
.plaintext
+MI4_HEADER_SIZE
),
358 tea_keytable
[key_index
].key
);
360 printf("%s key used", tea_keytable
[key_index
].name
);
362 /* Check decryption was successfull */
363 if(le2int(&buf
[mi4header
.length
-mi4header
.plaintext
-4]) != 0xaa55aa55)
365 return EREAD_IMAGE_FAILED
;
372 #if (CONFIG_STORAGE & STORAGE_SD)
373 /* Load mi4 firmware from a hidden disk partition */
374 int load_mi4_part(unsigned char* buf
, struct partinfo
* pinfo
,
375 unsigned int buffer_size
, bool disable_rebuild
)
377 struct mi4header_t mi4header
;
378 struct ppmi_header_t ppmi_header
;
381 /* Read header to find out how long the mi4 file is. */
382 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
,
383 PPMI_SECTORS
, &ppmi_header
);
385 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
386 if( memcmp(ppmi_header
.magic
, "PPMI", 4) )
387 return EFILE_NOT_FOUND
;
389 printf("BL mi4 size: %x", ppmi_header
.length
);
391 /* Read mi4 header of the OF */
392 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
+ PPMI_SECTORS
393 + (ppmi_header
.length
/512), MI4_HEADER_SECTORS
, &mi4header
);
395 /* We don't support encrypted mi4 files yet */
396 if( (mi4header
.plaintext
) != (mi4header
.mi4size
-MI4_HEADER_SIZE
))
397 return EINVALID_FORMAT
;
400 printf("OF mi4 size: %x", mi4header
.mi4size
);
402 if ((mi4header
.mi4size
-MI4_HEADER_SIZE
) > buffer_size
)
403 return EFILE_TOO_BIG
;
406 printf("CRC32: %x", mi4header
.crc32
);
408 /* Rockbox model id */
409 printf("Model id: %.4s", mi4header
.model
);
411 /* Read binary type (RBOS, RBBL) */
412 printf("Binary type: %.4s", mi4header
.type
);
415 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
+ PPMI_SECTORS
416 + (ppmi_header
.length
/512) + MI4_HEADER_SECTORS
,
417 (mi4header
.mi4size
-MI4_HEADER_SIZE
)/512, buf
);
419 /* Check CRC32 to see if we have a valid file */
420 sum
= chksum_crc32 (buf
,mi4header
.mi4size
-MI4_HEADER_SIZE
);
422 printf("Calculated CRC32: %x", sum
);
424 if(sum
!= mi4header
.crc32
)
432 printf("Disabling database rebuild");
434 storage_read_sectors(0, pinfo
->start
+ 0x3c08, 1, block
);
436 storage_write_sectors(0, pinfo
->start
+ 0x3c08, 1, block
);
439 (void) disable_rebuild
;
452 struct partinfo
* pinfo
;
453 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200) \
454 || defined (SANSA_VIEW)
455 #if !defined(USE_ROCKBOX_USB)
461 unsigned short* identify_info
;
464 chksum_crc32gentab ();
476 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
485 printf("Hold switch on");
486 printf("Shutting down...");
491 btn
= button_read_device();
493 /* Enable bootloader messages if any button is pressed */
499 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
500 #if !defined(USE_ROCKBOX_USB)
502 while (usb_drv_powered() && usb_retry
< 5 && !usb
)
506 usb
= (usb_detect() == USB_INSERTED
);
509 btn
|= BOOTLOADER_BOOT_OF
;
510 #endif /* USE_ROCKBOX_USB */
513 lcd_setfont(FONT_SYSFIXED
);
515 printf("Rockbox boot loader");
516 printf("Version: %s", version
);
520 #if !(CONFIG_STORAGE & STORAGE_SD)
522 identify_info
=ata_get_identify();
524 for (i
=0; i
< 20; i
++) {
525 ((unsigned short*)buf
)[i
]=htobe16(identify_info
[i
+27]);
528 for (i
=39; i
&& buf
[i
]==' '; i
--) {
538 num_partitions
= disk_mount_all();
539 if (num_partitions
<=0)
541 error(EDISK
,num_partitions
);
544 /* Just list the first 2 partitions since we don't have any devices yet
545 that have more than that */
546 for(i
=0; i
<NUM_PARTITIONS
; i
++)
548 pinfo
= disk_partinfo(i
);
549 printf("Partition %d: 0x%02x %ld MB",
550 i
, pinfo
->type
, pinfo
->size
/ 2048);
553 /* Try loading Rockbox, if that fails, fall back to the OF */
554 if((btn
& BOOTLOADER_BOOT_OF
) == 0)
556 printf("Loading Rockbox...");
557 rc
= load_mi4(loadbuffer
, BOOTFILE
, MAX_LOADSIZE
);
560 bool old_verbose
= verbose
;
562 printf("Can't load " BOOTFILE
": ");
563 printf(strerror(rc
));
564 verbose
= old_verbose
;
565 btn
|= BOOTLOADER_BOOT_OF
;
569 return (void*)loadbuffer
;
572 if(btn
& BOOTLOADER_BOOT_OF
)
574 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
575 The rest of the loading is done in crt0.S.
576 1) First try reading from the hidden partition (on Sansa only).
577 2) Next try a decrypted mi4 file in /System/OF.mi4
578 3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
579 a mi4 firmware decrypted and header stripped using mi4code.
581 printf("Loading original firmware...");
583 #if (CONFIG_STORAGE & STORAGE_SD)
584 /* First try a (hidden) firmware partition */
585 printf("Trying firmware partition");
586 pinfo
= disk_partinfo(1);
587 if(pinfo
->type
== PARTITION_TYPE_OS2_HIDDEN_C_DRIVE
)
589 rc
= load_mi4_part(loadbuffer
, pinfo
, MAX_LOADSIZE
, usb
);
591 printf("Can't load from partition");
592 printf(strerror(rc
));
594 return (void*)loadbuffer
;
597 printf("No hidden partition found.");
601 #if defined(PHILIPS_HDD1630)
602 printf("Trying /System/OF.ebn");
603 rc
=load_mi4(loadbuffer
, "/System/OF.ebn", MAX_LOADSIZE
);
605 printf("Can't load /System/OF.ebn");
606 printf(strerror(rc
));
608 return (void*)loadbuffer
;
612 printf("Trying /System/OF.mi4");
613 rc
=load_mi4(loadbuffer
, "/System/OF.mi4", MAX_LOADSIZE
);
615 printf("Can't load /System/OF.mi4");
616 printf(strerror(rc
));
618 return (void*)loadbuffer
;
621 printf("Trying /System/OF.bin");
622 rc
=load_raw_firmware(loadbuffer
, "/System/OF.bin", MAX_LOADSIZE
);
624 printf("Can't load /System/OF.bin");
625 printf(strerror(rc
));
627 return (void*)loadbuffer
;
632 return (void*)loadbuffer
;