Ooops, forgot CREDITS.
[kugel-rb.git] / bootloader / main-pp.c
blob4f1fe2a4e1c787ff38c47527621933e509811a85
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
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 ****************************************************************************/
24 #include <stdio.h>
25 #include <stdlib.h>
27 #include "config.h"
28 #include "common.h"
29 #include "cpu.h"
30 #include "file.h"
31 #include "system.h"
32 #include "kernel.h"
33 #include "lcd.h"
34 #include "font.h"
35 #include "storage.h"
36 #include "adc.h"
37 #include "button.h"
38 #include "disk.h"
39 #include "crc32-mi4.h"
40 #include <string.h>
41 #include "power.h"
42 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
43 #include "i2c.h"
44 #include "backlight-target.h"
45 #endif
46 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
47 #include "usb.h"
48 #include "usb_drv.h"
49 #endif
50 #if defined(SAMSUNG_YH925)
51 /* this function (in lcd-yh925.c) resets the screen orientation for the OF
52 * for use with dualbooting */
53 void lcd_reset(void);
54 #endif
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
87 #elif CONFIG_KEYPAD == PBELL_VIBE500_PAD
88 #define BOOTLOADER_BOOT_OF BUTTON_OK
90 #endif
92 /* Maximum allowed firmware image size. 10MB is more than enough */
93 #define MAX_LOADSIZE (10*1024*1024)
95 /* A buffer to load the original firmware or Rockbox into */
96 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
98 /* Bootloader version */
99 char version[] = APPSVERSION;
101 /* Locations and sizes in hidden partition on Sansa */
102 #if (CONFIG_STORAGE & STORAGE_SD)
103 #define PPMI_SECTOR_OFFSET 1024
104 #define PPMI_SECTORS 1
105 #define MI4_HEADER_SECTORS 1
106 #define NUM_PARTITIONS 2
108 #else
109 #define NUM_PARTITIONS 1
111 #endif
113 #define MI4_HEADER_SIZE 0x200
115 /* mi4 header structure */
116 struct mi4header_t {
117 unsigned char magic[4];
118 uint32_t version;
119 uint32_t length;
120 uint32_t crc32;
121 uint32_t enctype;
122 uint32_t mi4size;
123 uint32_t plaintext;
124 uint32_t dsa_key[10];
125 uint32_t pad[109];
126 unsigned char type[4];
127 unsigned char model[4];
130 /* PPMI header structure */
131 struct ppmi_header_t {
132 unsigned char magic[4];
133 uint32_t length;
134 uint32_t pad[126];
137 inline unsigned int le2int(unsigned char* buf)
139 int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
141 return res;
144 inline void int2le(unsigned int val, unsigned char* addr)
146 addr[0] = val & 0xFF;
147 addr[1] = (val >> 8) & 0xff;
148 addr[2] = (val >> 16) & 0xff;
149 addr[3] = (val >> 24) & 0xff;
152 struct tea_key {
153 const char * name;
154 uint32_t key[4];
157 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
158 struct tea_key tea_keytable[] = {
159 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
160 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
161 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
162 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
163 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
164 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
165 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
166 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
167 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
168 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
169 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
170 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
171 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
172 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
173 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
174 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
175 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
176 { "vibe500", { 0xe3a66156, 0x77c6b67a, 0xe821dca5, 0xca8ca37c } },
181 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
183 "Following is an adaptation of the reference encryption and decryption
184 routines in C, released into the public domain by David Wheeler and
185 Roger Needham:"
189 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
190 to the reference implementation and the main loop is 8 iterations, not
194 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
195 uint32_t sum=0xF1BBCDC8, i; /* set up */
196 uint32_t delta=0x9E3779B9; /* a key schedule constant */
197 uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3]; /* cache key */
198 for(i=0; i<8; i++) { /* basic cycle start */
199 *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
200 *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
201 sum -= delta; /* end cycle */
205 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
206 integers) and the key is incremented after each block
209 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
211 uint32_t v0, v1;
212 unsigned int i;
214 for (i = 0; i < (n / 8); i++) {
215 v0 = le2int(src);
216 v1 = le2int(src+4);
218 tea_decrypt(&v0, &v1, key);
220 int2le(v0, dest);
221 int2le(v1, dest+4);
223 src += 8;
224 dest += 8;
226 /* Now increment the key */
227 key[0]++;
228 if (key[0]==0) {
229 key[1]++;
230 if (key[1]==0) {
231 key[2]++;
232 if (key[2]==0) {
233 key[3]++;
240 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
242 unsigned char magic_dec[8];
243 tea_decrypt_buf(magic_enc, magic_dec, 8, key);
245 return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
248 static int tea_find_key(struct mi4header_t *mi4header, int fd)
250 unsigned int i;
251 int rc;
252 unsigned int j;
253 uint32_t key[4];
254 unsigned char magic_enc[8];
255 int key_found = -1;
256 unsigned int magic_location = mi4header->length-4;
257 int unaligned = 0;
259 if ( (magic_location % 8) != 0 )
261 unaligned = 1;
262 magic_location -= 4;
265 /* Load encrypted magic 0xaa55aa55 to check key */
266 lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
267 rc = read(fd, magic_enc, 8);
268 if(rc < 8 )
269 return EREAD_IMAGE_FAILED;
271 printf("Searching for key:");
273 for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
274 key[0] = tea_keytable[i].key[0];
275 key[1] = tea_keytable[i].key[1];
276 key[2] = tea_keytable[i].key[2];
277 key[3] = tea_keytable[i].key[3];
279 /* Now increment the key */
280 for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
281 key[0]++;
282 if (key[0]==0) {
283 key[1]++;
284 if (key[1]==0) {
285 key[2]++;
286 if (key[2]==0) {
287 key[3]++;
293 if (tea_test_key(magic_enc,key,unaligned))
295 key_found = i;
296 printf("%s...found", tea_keytable[i].name);
297 } else {
298 /* printf("%s...failed", tea_keytable[i].name); */
302 return key_found;
306 /* Load mi4 format firmware image */
307 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
309 int fd;
310 struct mi4header_t mi4header;
311 int rc;
312 unsigned long sum;
313 char filename[MAX_PATH];
315 snprintf(filename,sizeof(filename), BOOTDIR "/%s",firmware);
316 fd = open(filename, O_RDONLY);
317 if(fd < 0)
319 snprintf(filename,sizeof(filename),"/%s",firmware);
320 fd = open(filename, O_RDONLY);
321 if(fd < 0)
322 return EFILE_NOT_FOUND;
325 read(fd, &mi4header, MI4_HEADER_SIZE);
327 /* MI4 file size */
328 printf("mi4 size: %x", mi4header.mi4size);
330 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
331 return EFILE_TOO_BIG;
333 /* CRC32 */
334 printf("CRC32: %x", mi4header.crc32);
336 /* Rockbox model id */
337 printf("Model id: %.4s", mi4header.model);
339 /* Read binary type (RBOS, RBBL) */
340 printf("Binary type: %.4s", mi4header.type);
342 /* Load firmware file */
343 lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
344 rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
345 if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
346 return EREAD_IMAGE_FAILED;
348 /* Check CRC32 to see if we have a valid file */
349 sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
351 printf("Calculated CRC32: %x", sum);
353 if(sum != mi4header.crc32)
354 return EBAD_CHKSUM;
356 if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
358 /* Load encrypted firmware */
359 int key_index = tea_find_key(&mi4header, fd);
361 if (key_index < 0)
362 return EINVALID_FORMAT;
364 /* Plaintext part is already loaded */
365 buf += mi4header.plaintext;
367 /* Decrypt in-place */
368 tea_decrypt_buf(buf, buf,
369 mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
370 tea_keytable[key_index].key);
372 printf("%s key used", tea_keytable[key_index].name);
374 /* Check decryption was successfull */
375 if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
377 return EREAD_IMAGE_FAILED;
381 return EOK;
384 #if (CONFIG_STORAGE & STORAGE_SD)
385 /* Load mi4 firmware from a hidden disk partition */
386 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
387 unsigned int buffer_size, bool disable_rebuild)
389 struct mi4header_t mi4header;
390 struct ppmi_header_t ppmi_header;
391 unsigned long sum;
393 /* Read header to find out how long the mi4 file is. */
394 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET,
395 PPMI_SECTORS, &ppmi_header);
397 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
398 if( memcmp(ppmi_header.magic, "PPMI", 4) )
399 return EFILE_NOT_FOUND;
401 printf("BL mi4 size: %x", ppmi_header.length);
403 /* Read mi4 header of the OF */
404 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
405 + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
407 /* We don't support encrypted mi4 files yet */
408 if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
409 return EINVALID_FORMAT;
411 /* MI4 file size */
412 printf("OF mi4 size: %x", mi4header.mi4size);
414 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
415 return EFILE_TOO_BIG;
417 /* CRC32 */
418 printf("CRC32: %x", mi4header.crc32);
420 /* Rockbox model id */
421 printf("Model id: %.4s", mi4header.model);
423 /* Read binary type (RBOS, RBBL) */
424 printf("Binary type: %.4s", mi4header.type);
426 /* Load firmware */
427 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
428 + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
429 (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
431 /* Check CRC32 to see if we have a valid file */
432 sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
434 printf("Calculated CRC32: %x", sum);
436 if(sum != mi4header.crc32)
437 return EBAD_CHKSUM;
439 #ifdef SANSA_E200
440 if (disable_rebuild)
442 char block[512];
444 printf("Disabling database rebuild");
446 storage_read_sectors(pinfo->start + 0x3c08, 1, block);
447 block[0xe1] = 0;
448 storage_write_sectors(pinfo->start + 0x3c08, 1, block);
450 #else
451 (void) disable_rebuild;
452 #endif
454 return EOK;
456 #endif
458 void* main(void)
460 int i;
461 int btn;
462 int rc;
463 int num_partitions;
464 struct partinfo* pinfo;
465 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200) \
466 || defined (SANSA_VIEW)
467 #if !defined(USE_ROCKBOX_USB)
468 int usb_retry = 0;
469 #endif
470 bool usb = false;
471 #else
472 char buf[256];
473 unsigned short* identify_info;
474 #endif
476 chksum_crc32gentab ();
478 system_init();
479 kernel_init();
481 lcd_init();
483 font_init();
484 show_logo();
486 adc_init();
487 button_init();
488 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
489 i2c_init();
490 _backlight_on();
491 #endif
493 if (button_hold())
495 verbose = true;
496 lcd_clear_display();
497 printf("Hold switch on");
498 printf("Shutting down...");
499 sleep(HZ);
500 power_off();
503 btn = button_read_device();
505 /* Enable bootloader messages if any button is pressed */
506 if (btn) {
507 lcd_clear_display();
508 verbose = true;
511 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
512 #if !defined(USE_ROCKBOX_USB)
513 usb_init();
514 while (usb_drv_powered() && usb_retry < 5 && !usb)
516 usb_retry++;
517 sleep(HZ/4);
518 usb = (usb_detect() == USB_INSERTED);
520 if (usb)
521 btn |= BOOTLOADER_BOOT_OF;
522 #endif /* USE_ROCKBOX_USB */
523 #endif
525 lcd_setfont(FONT_SYSFIXED);
527 printf("Rockbox boot loader");
528 printf("Version: %s", version);
529 printf(MODEL_NAME);
531 i=storage_init();
532 #if !(CONFIG_STORAGE & STORAGE_SD)
533 if (i==0) {
534 identify_info=ata_get_identify();
535 /* Show model */
536 for (i=0; i < 20; i++) {
537 ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
539 buf[40]=0;
540 for (i=39; i && buf[i]==' '; i--) {
541 buf[i]=0;
543 printf(buf);
544 } else {
545 error(EATA, i);
547 #endif
549 disk_init(IF_MV(0));
550 num_partitions = disk_mount_all();
551 if (num_partitions<=0)
553 error(EDISK,num_partitions);
556 /* Just list the first 2 partitions since we don't have any devices yet
557 that have more than that */
558 for(i=0; i<NUM_PARTITIONS; i++)
560 pinfo = disk_partinfo(i);
561 printf("Partition %d: 0x%02x %ld MB",
562 i, pinfo->type, pinfo->size / 2048);
565 /* Try loading Rockbox, if that fails, fall back to the OF */
566 if((btn & BOOTLOADER_BOOT_OF) == 0)
568 printf("Loading Rockbox...");
569 rc = load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
570 if (rc < EOK)
572 bool old_verbose = verbose;
573 verbose = true;
574 printf("Can't load " BOOTFILE ": ");
575 printf(strerror(rc));
576 verbose = old_verbose;
577 btn |= BOOTLOADER_BOOT_OF;
578 sleep(5*HZ);
580 else
581 return (void*)loadbuffer;
584 if(btn & BOOTLOADER_BOOT_OF)
586 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
587 The rest of the loading is done in crt0.S.
588 1) First try reading from the hidden partition (on Sansa only).
589 2) Next try a decrypted mi4 file in /System/OF.mi4
590 3) Finally, try a raw firmware binary in /System/OF.bin. It should be
591 a mi4 firmware decrypted and header stripped using mi4code.
593 printf("Loading original firmware...");
595 #if (CONFIG_STORAGE & STORAGE_SD)
596 /* First try a (hidden) firmware partition */
597 printf("Trying firmware partition");
598 pinfo = disk_partinfo(1);
599 if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
601 rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
602 if (rc < EOK) {
603 printf("Can't load from partition");
604 printf(strerror(rc));
605 } else {
606 return (void*)loadbuffer;
608 } else {
609 printf("No hidden partition found.");
611 #endif
613 #if defined(PHILIPS_HDD1630) || defined(PHILIPS_HDD6330)
614 printf("Trying /System/OF.ebn");
615 rc=load_mi4(loadbuffer, "/System/OF.ebn", MAX_LOADSIZE);
616 if (rc < EOK) {
617 printf("Can't load /System/OF.ebn");
618 printf(strerror(rc));
619 } else {
620 return (void*)loadbuffer;
622 #endif
624 printf("Trying /System/OF.mi4");
625 rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
626 if (rc < EOK) {
627 printf("Can't load /System/OF.mi4");
628 printf(strerror(rc));
629 } else {
630 #if defined(SAMSUNG_YH925)
631 lcd_reset();
632 #endif
633 return (void*)loadbuffer;
636 printf("Trying /System/OF.bin");
637 rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
638 if (rc < EOK) {
639 printf("Can't load /System/OF.bin");
640 printf(strerror(rc));
641 } else {
642 #if defined(SAMSUNG_YH925)
643 lcd_reset();
644 #endif
645 return (void*)loadbuffer;
648 error(0, 0);
650 return (void*)loadbuffer;