Theme Editor: Put together a simple GUI to test going back and forth between a tree...
[kugel-rb.git] / bootloader / main-pp.c
blob37f42eda4328aafafef1cc882cc529a2432ed4e5
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 #include "version.h"
43 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
44 #include "i2c.h"
45 #include "backlight-target.h"
46 #endif
47 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
48 #include "usb.h"
49 #include "usb_drv.h"
50 #endif
51 #if defined(SAMSUNG_YH925)
52 /* this function (in lcd-yh925.c) resets the screen orientation for the OF
53 * for use with dualbooting */
54 void lcd_reset(void);
55 #endif
57 /* Show the Rockbox logo - in show_logo.c */
58 extern int show_logo(void);
60 /* Button definitions */
61 #if CONFIG_KEYPAD == IRIVER_H10_PAD
62 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
64 #elif CONFIG_KEYPAD == SANSA_E200_PAD
65 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
67 #elif CONFIG_KEYPAD == SANSA_C200_PAD
68 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
70 #elif CONFIG_KEYPAD == MROBE100_PAD
71 #define BOOTLOADER_BOOT_OF BUTTON_POWER
73 #elif CONFIG_KEYPAD == PHILIPS_SA9200_PAD
74 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
76 #elif CONFIG_KEYPAD == PHILIPS_HDD1630_PAD
77 #define BOOTLOADER_BOOT_OF BUTTON_MENU
79 #elif CONFIG_KEYPAD == PHILIPS_HDD6330_PAD
80 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
82 #elif CONFIG_KEYPAD == SAMSUNG_YH_PAD
83 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
85 #elif CONFIG_KEYPAD == SANSA_FUZE_PAD
86 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
88 #elif CONFIG_KEYPAD == PBELL_VIBE500_PAD
89 #define BOOTLOADER_BOOT_OF BUTTON_OK
91 #endif
93 /* Maximum allowed firmware image size. 10MB is more than enough */
94 #define MAX_LOADSIZE (10*1024*1024)
96 /* A buffer to load the original firmware or Rockbox into */
97 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
99 /* Locations and sizes in hidden partition on Sansa */
100 #if (CONFIG_STORAGE & STORAGE_SD)
101 #define PPMI_SECTOR_OFFSET 1024
102 #define PPMI_SECTORS 1
103 #define MI4_HEADER_SECTORS 1
104 #define NUM_PARTITIONS 2
106 #else
107 #define NUM_PARTITIONS 1
109 #endif
111 #define MI4_HEADER_SIZE 0x200
113 /* mi4 header structure */
114 struct mi4header_t {
115 unsigned char magic[4];
116 uint32_t version;
117 uint32_t length;
118 uint32_t crc32;
119 uint32_t enctype;
120 uint32_t mi4size;
121 uint32_t plaintext;
122 uint32_t dsa_key[10];
123 uint32_t pad[109];
124 unsigned char type[4];
125 unsigned char model[4];
128 /* PPMI header structure */
129 struct ppmi_header_t {
130 unsigned char magic[4];
131 uint32_t length;
132 uint32_t pad[126];
135 inline unsigned int le2int(unsigned char* buf)
137 int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
139 return res;
142 inline void int2le(unsigned int val, unsigned char* addr)
144 addr[0] = val & 0xFF;
145 addr[1] = (val >> 8) & 0xff;
146 addr[2] = (val >> 16) & 0xff;
147 addr[3] = (val >> 24) & 0xff;
150 struct tea_key {
151 const char * name;
152 uint32_t key[4];
155 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
156 struct tea_key tea_keytable[] = {
157 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
158 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
159 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
160 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
161 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
162 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
163 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
164 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
165 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
166 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
167 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
168 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
169 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
170 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
171 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
172 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
173 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
174 { "vibe500", { 0xe3a66156, 0x77c6b67a, 0xe821dca5, 0xca8ca37c } },
179 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
181 "Following is an adaptation of the reference encryption and decryption
182 routines in C, released into the public domain by David Wheeler and
183 Roger Needham:"
187 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
188 to the reference implementation and the main loop is 8 iterations, not
192 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
193 uint32_t sum=0xF1BBCDC8, i; /* set up */
194 uint32_t delta=0x9E3779B9; /* a key schedule constant */
195 uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3]; /* cache key */
196 for(i=0; i<8; i++) { /* basic cycle start */
197 *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
198 *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
199 sum -= delta; /* end cycle */
203 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
204 integers) and the key is incremented after each block
207 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
209 uint32_t v0, v1;
210 unsigned int i;
212 for (i = 0; i < (n / 8); i++) {
213 v0 = le2int(src);
214 v1 = le2int(src+4);
216 tea_decrypt(&v0, &v1, key);
218 int2le(v0, dest);
219 int2le(v1, dest+4);
221 src += 8;
222 dest += 8;
224 /* Now increment the key */
225 key[0]++;
226 if (key[0]==0) {
227 key[1]++;
228 if (key[1]==0) {
229 key[2]++;
230 if (key[2]==0) {
231 key[3]++;
238 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
240 unsigned char magic_dec[8];
241 tea_decrypt_buf(magic_enc, magic_dec, 8, key);
243 return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
246 static int tea_find_key(struct mi4header_t *mi4header, int fd)
248 unsigned int i;
249 int rc;
250 unsigned int j;
251 uint32_t key[4];
252 unsigned char magic_enc[8];
253 int key_found = -1;
254 unsigned int magic_location = mi4header->length-4;
255 int unaligned = 0;
257 if ( (magic_location % 8) != 0 )
259 unaligned = 1;
260 magic_location -= 4;
263 /* Load encrypted magic 0xaa55aa55 to check key */
264 lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
265 rc = read(fd, magic_enc, 8);
266 if(rc < 8 )
267 return EREAD_IMAGE_FAILED;
269 printf("Searching for key:");
271 for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
272 key[0] = tea_keytable[i].key[0];
273 key[1] = tea_keytable[i].key[1];
274 key[2] = tea_keytable[i].key[2];
275 key[3] = tea_keytable[i].key[3];
277 /* Now increment the key */
278 for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
279 key[0]++;
280 if (key[0]==0) {
281 key[1]++;
282 if (key[1]==0) {
283 key[2]++;
284 if (key[2]==0) {
285 key[3]++;
291 if (tea_test_key(magic_enc,key,unaligned))
293 key_found = i;
294 printf("%s...found", tea_keytable[i].name);
295 } else {
296 /* printf("%s...failed", tea_keytable[i].name); */
300 return key_found;
304 /* Load mi4 format firmware image */
305 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
307 int fd;
308 struct mi4header_t mi4header;
309 int rc;
310 unsigned long sum;
311 char filename[MAX_PATH];
313 snprintf(filename,sizeof(filename), BOOTDIR "/%s",firmware);
314 fd = open(filename, O_RDONLY);
315 if(fd < 0)
317 snprintf(filename,sizeof(filename),"/%s",firmware);
318 fd = open(filename, O_RDONLY);
319 if(fd < 0)
320 return EFILE_NOT_FOUND;
323 read(fd, &mi4header, MI4_HEADER_SIZE);
325 /* MI4 file size */
326 printf("mi4 size: %x", mi4header.mi4size);
328 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
329 return EFILE_TOO_BIG;
331 /* CRC32 */
332 printf("CRC32: %x", mi4header.crc32);
334 /* Rockbox model id */
335 printf("Model id: %.4s", mi4header.model);
337 /* Read binary type (RBOS, RBBL) */
338 printf("Binary type: %.4s", mi4header.type);
340 /* Load firmware file */
341 lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
342 rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
343 if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
344 return EREAD_IMAGE_FAILED;
346 /* Check CRC32 to see if we have a valid file */
347 sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
349 printf("Calculated CRC32: %x", sum);
351 if(sum != mi4header.crc32)
352 return EBAD_CHKSUM;
354 if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
356 /* Load encrypted firmware */
357 int key_index = tea_find_key(&mi4header, fd);
359 if (key_index < 0)
360 return EINVALID_FORMAT;
362 /* Plaintext part is already loaded */
363 buf += mi4header.plaintext;
365 /* Decrypt in-place */
366 tea_decrypt_buf(buf, buf,
367 mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
368 tea_keytable[key_index].key);
370 printf("%s key used", tea_keytable[key_index].name);
372 /* Check decryption was successfull */
373 if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
375 return EREAD_IMAGE_FAILED;
379 return EOK;
382 #if (CONFIG_STORAGE & STORAGE_SD)
383 /* Load mi4 firmware from a hidden disk partition */
384 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
385 unsigned int buffer_size, bool disable_rebuild)
387 struct mi4header_t mi4header;
388 struct ppmi_header_t ppmi_header;
389 unsigned long sum;
391 /* Read header to find out how long the mi4 file is. */
392 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET,
393 PPMI_SECTORS, &ppmi_header);
395 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
396 if( memcmp(ppmi_header.magic, "PPMI", 4) )
397 return EFILE_NOT_FOUND;
399 printf("BL mi4 size: %x", ppmi_header.length);
401 /* Read mi4 header of the OF */
402 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
403 + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
405 /* We don't support encrypted mi4 files yet */
406 if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
407 return EINVALID_FORMAT;
409 /* MI4 file size */
410 printf("OF mi4 size: %x", mi4header.mi4size);
412 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
413 return EFILE_TOO_BIG;
415 /* CRC32 */
416 printf("CRC32: %x", mi4header.crc32);
418 /* Rockbox model id */
419 printf("Model id: %.4s", mi4header.model);
421 /* Read binary type (RBOS, RBBL) */
422 printf("Binary type: %.4s", mi4header.type);
424 /* Load firmware */
425 storage_read_sectors(pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
426 + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
427 (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
429 /* Check CRC32 to see if we have a valid file */
430 sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
432 printf("Calculated CRC32: %x", sum);
434 if(sum != mi4header.crc32)
435 return EBAD_CHKSUM;
437 #ifdef SANSA_E200
438 if (disable_rebuild)
440 char block[512];
442 printf("Disabling database rebuild");
444 storage_read_sectors(pinfo->start + 0x3c08, 1, block);
445 block[0xe1] = 0;
446 storage_write_sectors(pinfo->start + 0x3c08, 1, block);
448 #else
449 (void) disable_rebuild;
450 #endif
452 return EOK;
454 #endif
456 void* main(void)
458 int i;
459 int btn;
460 int rc;
461 int num_partitions;
462 struct partinfo* pinfo;
463 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200) \
464 || defined (SANSA_VIEW)
465 #if !defined(USE_ROCKBOX_USB)
466 int usb_retry = 0;
467 #endif
468 bool usb = false;
469 #else
470 char buf[256];
471 unsigned short* identify_info;
472 #endif
474 chksum_crc32gentab ();
476 system_init();
477 kernel_init();
479 lcd_init();
481 font_init();
482 show_logo();
484 adc_init();
485 button_init();
486 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
487 i2c_init();
488 _backlight_on();
489 #endif
491 if (button_hold())
493 verbose = true;
494 lcd_clear_display();
495 printf("Hold switch on");
496 printf("Shutting down...");
497 sleep(HZ);
498 power_off();
501 btn = button_read_device();
503 /* Enable bootloader messages if any button is pressed */
504 if (btn) {
505 lcd_clear_display();
506 verbose = true;
509 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
510 #if !defined(USE_ROCKBOX_USB)
511 usb_init();
512 while (usb_drv_powered() && usb_retry < 5 && !usb)
514 usb_retry++;
515 sleep(HZ/4);
516 usb = (usb_detect() == USB_INSERTED);
518 if (usb)
519 btn |= BOOTLOADER_BOOT_OF;
520 #endif /* USE_ROCKBOX_USB */
521 #endif
523 lcd_setfont(FONT_SYSFIXED);
525 printf("Rockbox boot loader");
526 printf("Version: " RBVERSION);
527 printf(MODEL_NAME);
529 i=storage_init();
530 #if !(CONFIG_STORAGE & STORAGE_SD)
531 if (i==0) {
532 identify_info=ata_get_identify();
533 /* Show model */
534 for (i=0; i < 20; i++) {
535 ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
537 buf[40]=0;
538 for (i=39; i && buf[i]==' '; i--) {
539 buf[i]=0;
541 printf(buf);
542 } else {
543 error(EATA, i);
545 #endif
547 disk_init(IF_MV(0));
548 num_partitions = disk_mount_all();
549 if (num_partitions<=0)
551 error(EDISK,num_partitions);
554 /* Just list the first 2 partitions since we don't have any devices yet
555 that have more than that */
556 for(i=0; i<NUM_PARTITIONS; i++)
558 pinfo = disk_partinfo(i);
559 printf("Partition %d: 0x%02x %ld MB",
560 i, pinfo->type, pinfo->size / 2048);
563 /* Try loading Rockbox, if that fails, fall back to the OF */
564 if((btn & BOOTLOADER_BOOT_OF) == 0)
566 printf("Loading Rockbox...");
567 rc = load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
568 if (rc < EOK)
570 bool old_verbose = verbose;
571 verbose = true;
572 printf("Can't load " BOOTFILE ": ");
573 printf(strerror(rc));
574 verbose = old_verbose;
575 btn |= BOOTLOADER_BOOT_OF;
576 sleep(5*HZ);
578 else
579 return (void*)loadbuffer;
582 if(btn & BOOTLOADER_BOOT_OF)
584 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
585 The rest of the loading is done in crt0.S.
586 1) First try reading from the hidden partition (on Sansa only).
587 2) Next try a decrypted mi4 file in /System/OF.mi4
588 3) Finally, try a raw firmware binary in /System/OF.bin. It should be
589 a mi4 firmware decrypted and header stripped using mi4code.
591 printf("Loading original firmware...");
593 #if (CONFIG_STORAGE & STORAGE_SD)
594 /* First try a (hidden) firmware partition */
595 printf("Trying firmware partition");
596 pinfo = disk_partinfo(1);
597 if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
599 rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
600 if (rc < EOK) {
601 printf("Can't load from partition");
602 printf(strerror(rc));
603 } else {
604 return (void*)loadbuffer;
606 } else {
607 printf("No hidden partition found.");
609 #endif
611 #if defined(PHILIPS_HDD1630) || defined(PHILIPS_HDD6330)
612 printf("Trying /System/OF.ebn");
613 rc=load_mi4(loadbuffer, "/System/OF.ebn", MAX_LOADSIZE);
614 if (rc < EOK) {
615 printf("Can't load /System/OF.ebn");
616 printf(strerror(rc));
617 } else {
618 return (void*)loadbuffer;
620 #endif
622 printf("Trying /System/OF.mi4");
623 rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
624 if (rc < EOK) {
625 printf("Can't load /System/OF.mi4");
626 printf(strerror(rc));
627 } else {
628 #if defined(SAMSUNG_YH925)
629 lcd_reset();
630 #endif
631 return (void*)loadbuffer;
634 printf("Trying /System/OF.bin");
635 rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
636 if (rc < EOK) {
637 printf("Can't load /System/OF.bin");
638 printf(strerror(rc));
639 } else {
640 #if defined(SAMSUNG_YH925)
641 lcd_reset();
642 #endif
643 return (void*)loadbuffer;
646 error(0, 0);
648 return (void*)loadbuffer;