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)
50 #if defined(SAMSUNG_YH925)
51 /* this function (in lcd-yh925.c) resets the screen orientation for the OF
52 * for use with dualbooting */
56 /* Show the Rockbox logo - in show_logo.c */
57 extern int show_logo(void);
59 /* Button definitions */
60 #if CONFIG_KEYPAD == IRIVER_H10_PAD
61 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
63 #elif CONFIG_KEYPAD == SANSA_E200_PAD
64 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
66 #elif CONFIG_KEYPAD == SANSA_C200_PAD
67 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
69 #elif CONFIG_KEYPAD == MROBE100_PAD
70 #define BOOTLOADER_BOOT_OF BUTTON_POWER
72 #elif CONFIG_KEYPAD == PHILIPS_SA9200_PAD
73 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
75 #elif CONFIG_KEYPAD == PHILIPS_HDD1630_PAD
76 #define BOOTLOADER_BOOT_OF BUTTON_MENU
78 #elif CONFIG_KEYPAD == PHILIPS_HDD6330_PAD
79 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
81 #elif CONFIG_KEYPAD == SAMSUNG_YH_PAD
82 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
84 #elif CONFIG_KEYPAD == SANSA_FUZE_PAD
85 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
89 /* Maximum allowed firmware image size. 10MB is more than enough */
90 #define MAX_LOADSIZE (10*1024*1024)
92 /* A buffer to load the original firmware or Rockbox into */
93 unsigned char *loadbuffer
= (unsigned char *)DRAM_START
;
95 /* Bootloader version */
96 char version
[] = APPSVERSION
;
98 /* Locations and sizes in hidden partition on Sansa */
99 #if (CONFIG_STORAGE & STORAGE_SD)
100 #define PPMI_SECTOR_OFFSET 1024
101 #define PPMI_SECTORS 1
102 #define MI4_HEADER_SECTORS 1
103 #define NUM_PARTITIONS 2
106 #define NUM_PARTITIONS 1
110 #define MI4_HEADER_SIZE 0x200
112 /* mi4 header structure */
114 unsigned char magic
[4];
121 uint32_t dsa_key
[10];
123 unsigned char type
[4];
124 unsigned char model
[4];
127 /* PPMI header structure */
128 struct ppmi_header_t
{
129 unsigned char magic
[4];
134 inline unsigned int le2int(unsigned char* buf
)
136 int32_t res
= (buf
[3] << 24) | (buf
[2] << 16) | (buf
[1] << 8) | buf
[0];
141 inline void int2le(unsigned int val
, unsigned char* addr
)
143 addr
[0] = val
& 0xFF;
144 addr
[1] = (val
>> 8) & 0xff;
145 addr
[2] = (val
>> 16) & 0xff;
146 addr
[3] = (val
>> 24) & 0xff;
154 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
155 struct tea_key tea_keytable
[] = {
156 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
157 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
158 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
159 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
160 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
161 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
162 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
163 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
164 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
165 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
166 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
167 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
168 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
169 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
170 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
171 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
172 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
177 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
179 "Following is an adaptation of the reference encryption and decryption
180 routines in C, released into the public domain by David Wheeler and
185 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
186 to the reference implementation and the main loop is 8 iterations, not
190 static void tea_decrypt(uint32_t* v0
, uint32_t* v1
, uint32_t* k
) {
191 uint32_t sum
=0xF1BBCDC8, i
; /* set up */
192 uint32_t delta
=0x9E3779B9; /* a key schedule constant */
193 uint32_t k0
=k
[0], k1
=k
[1], k2
=k
[2], k3
=k
[3]; /* cache key */
194 for(i
=0; i
<8; i
++) { /* basic cycle start */
195 *v1
-= ((*v0
<<4) + k2
) ^ (*v0
+ sum
) ^ ((*v0
>>5) + k3
);
196 *v0
-= ((*v1
<<4) + k0
) ^ (*v1
+ sum
) ^ ((*v1
>>5) + k1
);
197 sum
-= delta
; /* end cycle */
201 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
202 integers) and the key is incremented after each block
205 static void tea_decrypt_buf(unsigned char* src
, unsigned char* dest
, size_t n
, uint32_t * key
)
210 for (i
= 0; i
< (n
/ 8); i
++) {
214 tea_decrypt(&v0
, &v1
, key
);
222 /* Now increment the key */
236 static inline bool tea_test_key(unsigned char magic_enc
[8], uint32_t * key
, int unaligned
)
238 unsigned char magic_dec
[8];
239 tea_decrypt_buf(magic_enc
, magic_dec
, 8, key
);
241 return (le2int(&magic_dec
[4*unaligned
]) == 0xaa55aa55);
244 static int tea_find_key(struct mi4header_t
*mi4header
, int fd
)
250 unsigned char magic_enc
[8];
252 unsigned int magic_location
= mi4header
->length
-4;
255 if ( (magic_location
% 8) != 0 )
261 /* Load encrypted magic 0xaa55aa55 to check key */
262 lseek(fd
, MI4_HEADER_SIZE
+ magic_location
, SEEK_SET
);
263 rc
= read(fd
, magic_enc
, 8);
265 return EREAD_IMAGE_FAILED
;
267 printf("Searching for key:");
269 for (i
=0; i
< NUM_KEYS
&& (key_found
<0) ; i
++) {
270 key
[0] = tea_keytable
[i
].key
[0];
271 key
[1] = tea_keytable
[i
].key
[1];
272 key
[2] = tea_keytable
[i
].key
[2];
273 key
[3] = tea_keytable
[i
].key
[3];
275 /* Now increment the key */
276 for(j
=0; j
<((magic_location
-mi4header
->plaintext
)/8); j
++){
289 if (tea_test_key(magic_enc
,key
,unaligned
))
292 printf("%s...found", tea_keytable
[i
].name
);
294 /* printf("%s...failed", tea_keytable[i].name); */
302 /* Load mi4 format firmware image */
303 int load_mi4(unsigned char* buf
, char* firmware
, unsigned int buffer_size
)
306 struct mi4header_t mi4header
;
309 char filename
[MAX_PATH
];
311 snprintf(filename
,sizeof(filename
), BOOTDIR
"/%s",firmware
);
312 fd
= open(filename
, O_RDONLY
);
315 snprintf(filename
,sizeof(filename
),"/%s",firmware
);
316 fd
= open(filename
, O_RDONLY
);
318 return EFILE_NOT_FOUND
;
321 read(fd
, &mi4header
, MI4_HEADER_SIZE
);
324 printf("mi4 size: %x", mi4header
.mi4size
);
326 if ((mi4header
.mi4size
-MI4_HEADER_SIZE
) > buffer_size
)
327 return EFILE_TOO_BIG
;
330 printf("CRC32: %x", mi4header
.crc32
);
332 /* Rockbox model id */
333 printf("Model id: %.4s", mi4header
.model
);
335 /* Read binary type (RBOS, RBBL) */
336 printf("Binary type: %.4s", mi4header
.type
);
338 /* Load firmware file */
339 lseek(fd
, MI4_HEADER_SIZE
, SEEK_SET
);
340 rc
= read(fd
, buf
, mi4header
.mi4size
-MI4_HEADER_SIZE
);
341 if(rc
< (int)mi4header
.mi4size
-MI4_HEADER_SIZE
)
342 return EREAD_IMAGE_FAILED
;
344 /* Check CRC32 to see if we have a valid file */
345 sum
= chksum_crc32 (buf
, mi4header
.mi4size
- MI4_HEADER_SIZE
);
347 printf("Calculated CRC32: %x", sum
);
349 if(sum
!= mi4header
.crc32
)
352 if( (mi4header
.plaintext
+ MI4_HEADER_SIZE
) != mi4header
.mi4size
)
354 /* Load encrypted firmware */
355 int key_index
= tea_find_key(&mi4header
, fd
);
358 return EINVALID_FORMAT
;
360 /* Plaintext part is already loaded */
361 buf
+= mi4header
.plaintext
;
363 /* Decrypt in-place */
364 tea_decrypt_buf(buf
, buf
,
365 mi4header
.mi4size
-(mi4header
.plaintext
+MI4_HEADER_SIZE
),
366 tea_keytable
[key_index
].key
);
368 printf("%s key used", tea_keytable
[key_index
].name
);
370 /* Check decryption was successfull */
371 if(le2int(&buf
[mi4header
.length
-mi4header
.plaintext
-4]) != 0xaa55aa55)
373 return EREAD_IMAGE_FAILED
;
380 #if (CONFIG_STORAGE & STORAGE_SD)
381 /* Load mi4 firmware from a hidden disk partition */
382 int load_mi4_part(unsigned char* buf
, struct partinfo
* pinfo
,
383 unsigned int buffer_size
, bool disable_rebuild
)
385 struct mi4header_t mi4header
;
386 struct ppmi_header_t ppmi_header
;
389 /* Read header to find out how long the mi4 file is. */
390 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
,
391 PPMI_SECTORS
, &ppmi_header
);
393 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
394 if( memcmp(ppmi_header
.magic
, "PPMI", 4) )
395 return EFILE_NOT_FOUND
;
397 printf("BL mi4 size: %x", ppmi_header
.length
);
399 /* Read mi4 header of the OF */
400 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
+ PPMI_SECTORS
401 + (ppmi_header
.length
/512), MI4_HEADER_SECTORS
, &mi4header
);
403 /* We don't support encrypted mi4 files yet */
404 if( (mi4header
.plaintext
) != (mi4header
.mi4size
-MI4_HEADER_SIZE
))
405 return EINVALID_FORMAT
;
408 printf("OF mi4 size: %x", mi4header
.mi4size
);
410 if ((mi4header
.mi4size
-MI4_HEADER_SIZE
) > buffer_size
)
411 return EFILE_TOO_BIG
;
414 printf("CRC32: %x", mi4header
.crc32
);
416 /* Rockbox model id */
417 printf("Model id: %.4s", mi4header
.model
);
419 /* Read binary type (RBOS, RBBL) */
420 printf("Binary type: %.4s", mi4header
.type
);
423 storage_read_sectors(0, pinfo
->start
+ PPMI_SECTOR_OFFSET
+ PPMI_SECTORS
424 + (ppmi_header
.length
/512) + MI4_HEADER_SECTORS
,
425 (mi4header
.mi4size
-MI4_HEADER_SIZE
)/512, buf
);
427 /* Check CRC32 to see if we have a valid file */
428 sum
= chksum_crc32 (buf
,mi4header
.mi4size
-MI4_HEADER_SIZE
);
430 printf("Calculated CRC32: %x", sum
);
432 if(sum
!= mi4header
.crc32
)
440 printf("Disabling database rebuild");
442 storage_read_sectors(0, pinfo
->start
+ 0x3c08, 1, block
);
444 storage_write_sectors(0, pinfo
->start
+ 0x3c08, 1, block
);
447 (void) disable_rebuild
;
460 struct partinfo
* pinfo
;
461 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200) \
462 || defined (SANSA_VIEW)
463 #if !defined(USE_ROCKBOX_USB)
469 unsigned short* identify_info
;
472 chksum_crc32gentab ();
484 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
493 printf("Hold switch on");
494 printf("Shutting down...");
499 btn
= button_read_device();
501 /* Enable bootloader messages if any button is pressed */
507 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
508 #if !defined(USE_ROCKBOX_USB)
510 while (usb_drv_powered() && usb_retry
< 5 && !usb
)
514 usb
= (usb_detect() == USB_INSERTED
);
517 btn
|= BOOTLOADER_BOOT_OF
;
518 #endif /* USE_ROCKBOX_USB */
521 lcd_setfont(FONT_SYSFIXED
);
523 printf("Rockbox boot loader");
524 printf("Version: %s", version
);
528 #if !(CONFIG_STORAGE & STORAGE_SD)
530 identify_info
=ata_get_identify();
532 for (i
=0; i
< 20; i
++) {
533 ((unsigned short*)buf
)[i
]=htobe16(identify_info
[i
+27]);
536 for (i
=39; i
&& buf
[i
]==' '; i
--) {
546 num_partitions
= disk_mount_all();
547 if (num_partitions
<=0)
549 error(EDISK
,num_partitions
);
552 /* Just list the first 2 partitions since we don't have any devices yet
553 that have more than that */
554 for(i
=0; i
<NUM_PARTITIONS
; i
++)
556 pinfo
= disk_partinfo(i
);
557 printf("Partition %d: 0x%02x %ld MB",
558 i
, pinfo
->type
, pinfo
->size
/ 2048);
561 /* Try loading Rockbox, if that fails, fall back to the OF */
562 if((btn
& BOOTLOADER_BOOT_OF
) == 0)
564 printf("Loading Rockbox...");
565 rc
= load_mi4(loadbuffer
, BOOTFILE
, MAX_LOADSIZE
);
568 bool old_verbose
= verbose
;
570 printf("Can't load " BOOTFILE
": ");
571 printf(strerror(rc
));
572 verbose
= old_verbose
;
573 btn
|= BOOTLOADER_BOOT_OF
;
577 return (void*)loadbuffer
;
580 if(btn
& BOOTLOADER_BOOT_OF
)
582 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
583 The rest of the loading is done in crt0.S.
584 1) First try reading from the hidden partition (on Sansa only).
585 2) Next try a decrypted mi4 file in /System/OF.mi4
586 3) Finally, try a raw firmware binary in /System/OF.bin. It should be
587 a mi4 firmware decrypted and header stripped using mi4code.
589 printf("Loading original firmware...");
591 #if (CONFIG_STORAGE & STORAGE_SD)
592 /* First try a (hidden) firmware partition */
593 printf("Trying firmware partition");
594 pinfo
= disk_partinfo(1);
595 if(pinfo
->type
== PARTITION_TYPE_OS2_HIDDEN_C_DRIVE
)
597 rc
= load_mi4_part(loadbuffer
, pinfo
, MAX_LOADSIZE
, usb
);
599 printf("Can't load from partition");
600 printf(strerror(rc
));
602 return (void*)loadbuffer
;
605 printf("No hidden partition found.");
609 #if defined(PHILIPS_HDD1630) || defined(PHILIPS_HDD6330)
610 printf("Trying /System/OF.ebn");
611 rc
=load_mi4(loadbuffer
, "/System/OF.ebn", MAX_LOADSIZE
);
613 printf("Can't load /System/OF.ebn");
614 printf(strerror(rc
));
616 return (void*)loadbuffer
;
620 printf("Trying /System/OF.mi4");
621 rc
=load_mi4(loadbuffer
, "/System/OF.mi4", MAX_LOADSIZE
);
623 printf("Can't load /System/OF.mi4");
624 printf(strerror(rc
));
626 #if defined(SAMSUNG_YH925)
629 return (void*)loadbuffer
;
632 printf("Trying /System/OF.bin");
633 rc
=load_raw_firmware(loadbuffer
, "/System/OF.bin", MAX_LOADSIZE
);
635 printf("Can't load /System/OF.bin");
636 printf(strerror(rc
));
638 #if defined(SAMSUNG_YH925)
641 return (void*)loadbuffer
;
646 return (void*)loadbuffer
;