Fix no-backlight colours for H100 series and M3.
[kugel-rb.git] / bootloader / main-pp.c
blobefeecb80ab4f79f9aceba7d88490b56ed506dac0
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
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 #endif
75 /* Maximum allowed firmware image size. 10MB is more than enough */
76 #define MAX_LOADSIZE (10*1024*1024)
78 /* A buffer to load the original firmware or Rockbox into */
79 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
81 /* Bootloader version */
82 char version[] = APPSVERSION;
84 /* Locations and sizes in hidden partition on Sansa */
85 #if (CONFIG_STORAGE & STORAGE_SD)
86 #define PPMI_SECTOR_OFFSET 1024
87 #define PPMI_SECTORS 1
88 #define MI4_HEADER_SECTORS 1
89 #define NUM_PARTITIONS 2
91 #else
92 #define NUM_PARTITIONS 1
94 #endif
96 #define MI4_HEADER_SIZE 0x200
98 /* mi4 header structure */
99 struct mi4header_t {
100 unsigned char magic[4];
101 uint32_t version;
102 uint32_t length;
103 uint32_t crc32;
104 uint32_t enctype;
105 uint32_t mi4size;
106 uint32_t plaintext;
107 uint32_t dsa_key[10];
108 uint32_t pad[109];
109 unsigned char type[4];
110 unsigned char model[4];
113 /* PPMI header structure */
114 struct ppmi_header_t {
115 unsigned char magic[4];
116 uint32_t length;
117 uint32_t pad[126];
120 inline unsigned int le2int(unsigned char* buf)
122 int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
124 return res;
127 inline void int2le(unsigned int val, unsigned char* addr)
129 addr[0] = val & 0xFF;
130 addr[1] = (val >> 8) & 0xff;
131 addr[2] = (val >> 16) & 0xff;
132 addr[3] = (val >> 24) & 0xff;
135 struct tea_key {
136 const char * name;
137 uint32_t key[4];
140 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
141 struct tea_key tea_keytable[] = {
142 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
143 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
144 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
145 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
146 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
147 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
148 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
149 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
150 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
151 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
152 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
153 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
154 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
155 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
156 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
157 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
158 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
163 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
165 "Following is an adaptation of the reference encryption and decryption
166 routines in C, released into the public domain by David Wheeler and
167 Roger Needham:"
171 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
172 to the reference implementation and the main loop is 8 iterations, not
176 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
177 uint32_t sum=0xF1BBCDC8, i; /* set up */
178 uint32_t delta=0x9E3779B9; /* a key schedule constant */
179 uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3]; /* cache key */
180 for(i=0; i<8; i++) { /* basic cycle start */
181 *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
182 *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
183 sum -= delta; /* end cycle */
187 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
188 integers) and the key is incremented after each block
191 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
193 uint32_t v0, v1;
194 unsigned int i;
196 for (i = 0; i < (n / 8); i++) {
197 v0 = le2int(src);
198 v1 = le2int(src+4);
200 tea_decrypt(&v0, &v1, key);
202 int2le(v0, dest);
203 int2le(v1, dest+4);
205 src += 8;
206 dest += 8;
208 /* Now increment the key */
209 key[0]++;
210 if (key[0]==0) {
211 key[1]++;
212 if (key[1]==0) {
213 key[2]++;
214 if (key[2]==0) {
215 key[3]++;
222 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
224 unsigned char magic_dec[8];
225 tea_decrypt_buf(magic_enc, magic_dec, 8, key);
227 return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
230 static int tea_find_key(struct mi4header_t *mi4header, int fd)
232 unsigned int i;
233 int rc;
234 unsigned int j;
235 uint32_t key[4];
236 unsigned char magic_enc[8];
237 int key_found = -1;
238 unsigned int magic_location = mi4header->length-4;
239 int unaligned = 0;
241 if ( (magic_location % 8) != 0 )
243 unaligned = 1;
244 magic_location -= 4;
247 /* Load encrypted magic 0xaa55aa55 to check key */
248 lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
249 rc = read(fd, magic_enc, 8);
250 if(rc < 8 )
251 return EREAD_IMAGE_FAILED;
253 printf("Searching for key:");
255 for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
256 key[0] = tea_keytable[i].key[0];
257 key[1] = tea_keytable[i].key[1];
258 key[2] = tea_keytable[i].key[2];
259 key[3] = tea_keytable[i].key[3];
261 /* Now increment the key */
262 for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
263 key[0]++;
264 if (key[0]==0) {
265 key[1]++;
266 if (key[1]==0) {
267 key[2]++;
268 if (key[2]==0) {
269 key[3]++;
275 if (tea_test_key(magic_enc,key,unaligned))
277 key_found = i;
278 printf("%s...found", tea_keytable[i].name);
279 } else {
280 /* printf("%s...failed", tea_keytable[i].name); */
284 return key_found;
288 /* Load mi4 format firmware image */
289 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
291 int fd;
292 struct mi4header_t mi4header;
293 int rc;
294 unsigned long sum;
295 char filename[MAX_PATH];
297 snprintf(filename,sizeof(filename), BOOTDIR "/%s",firmware);
298 fd = open(filename, O_RDONLY);
299 if(fd < 0)
301 snprintf(filename,sizeof(filename),"/%s",firmware);
302 fd = open(filename, O_RDONLY);
303 if(fd < 0)
304 return EFILE_NOT_FOUND;
307 read(fd, &mi4header, MI4_HEADER_SIZE);
309 /* MI4 file size */
310 printf("mi4 size: %x", mi4header.mi4size);
312 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
313 return EFILE_TOO_BIG;
315 /* CRC32 */
316 printf("CRC32: %x", mi4header.crc32);
318 /* Rockbox model id */
319 printf("Model id: %.4s", mi4header.model);
321 /* Read binary type (RBOS, RBBL) */
322 printf("Binary type: %.4s", mi4header.type);
324 /* Load firmware file */
325 lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
326 rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
327 if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
328 return EREAD_IMAGE_FAILED;
330 /* Check CRC32 to see if we have a valid file */
331 sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
333 printf("Calculated CRC32: %x", sum);
335 if(sum != mi4header.crc32)
336 return EBAD_CHKSUM;
338 if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
340 /* Load encrypted firmware */
341 int key_index = tea_find_key(&mi4header, fd);
343 if (key_index < 0)
344 return EINVALID_FORMAT;
346 /* Plaintext part is already loaded */
347 buf += mi4header.plaintext;
349 /* Decrypt in-place */
350 tea_decrypt_buf(buf, buf,
351 mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
352 tea_keytable[key_index].key);
354 printf("%s key used", tea_keytable[key_index].name);
356 /* Check decryption was successfull */
357 if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
359 return EREAD_IMAGE_FAILED;
363 return EOK;
366 #if (CONFIG_STORAGE & STORAGE_SD)
367 /* Load mi4 firmware from a hidden disk partition */
368 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
369 unsigned int buffer_size, bool disable_rebuild)
371 struct mi4header_t mi4header;
372 struct ppmi_header_t ppmi_header;
373 unsigned long sum;
375 /* Read header to find out how long the mi4 file is. */
376 storage_read_sectors(0, pinfo->start + PPMI_SECTOR_OFFSET,
377 PPMI_SECTORS, &ppmi_header);
379 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
380 if( memcmp(ppmi_header.magic, "PPMI", 4) )
381 return EFILE_NOT_FOUND;
383 printf("BL mi4 size: %x", ppmi_header.length);
385 /* Read mi4 header of the OF */
386 storage_read_sectors(0, pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
387 + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
389 /* We don't support encrypted mi4 files yet */
390 if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
391 return EINVALID_FORMAT;
393 /* MI4 file size */
394 printf("OF mi4 size: %x", mi4header.mi4size);
396 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
397 return EFILE_TOO_BIG;
399 /* CRC32 */
400 printf("CRC32: %x", mi4header.crc32);
402 /* Rockbox model id */
403 printf("Model id: %.4s", mi4header.model);
405 /* Read binary type (RBOS, RBBL) */
406 printf("Binary type: %.4s", mi4header.type);
408 /* Load firmware */
409 storage_read_sectors(0, pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
410 + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
411 (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
413 /* Check CRC32 to see if we have a valid file */
414 sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
416 printf("Calculated CRC32: %x", sum);
418 if(sum != mi4header.crc32)
419 return EBAD_CHKSUM;
421 #ifdef SANSA_E200
422 if (disable_rebuild)
424 char block[512];
426 printf("Disabling database rebuild");
428 storage_read_sectors(0, pinfo->start + 0x3c08, 1, block);
429 block[0xe1] = 0;
430 storage_write_sectors(0, pinfo->start + 0x3c08, 1, block);
432 #else
433 (void) disable_rebuild;
434 #endif
436 return EOK;
438 #endif
440 void* main(void)
442 int i;
443 int btn;
444 int rc;
445 int num_partitions;
446 struct partinfo* pinfo;
447 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
448 int usb_retry = 0;
449 bool usb = false;
450 #else
451 char buf[256];
452 unsigned short* identify_info;
453 #endif
455 chksum_crc32gentab ();
457 system_init();
458 kernel_init();
460 lcd_init();
462 font_init();
463 show_logo();
465 adc_init();
466 button_init();
467 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
468 i2c_init();
469 _backlight_on();
470 #endif
472 if (button_hold())
474 verbose = true;
475 lcd_clear_display();
476 printf("Hold switch on");
477 printf("Shutting down...");
478 sleep(HZ);
479 power_off();
482 btn = button_read_device();
484 /* Enable bootloader messages if any button is pressed */
485 if (btn) {
486 lcd_clear_display();
487 verbose = true;
490 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
491 #if !defined(USE_ROCKBOX_USB)
492 usb_init();
493 while (usb_drv_powered() && usb_retry < 5 && !usb)
495 usb_retry++;
496 sleep(HZ/4);
497 usb = (usb_detect() == USB_INSERTED);
499 if (usb)
500 btn |= BOOTLOADER_BOOT_OF;
501 #endif /* USE_ROCKBOX_USB */
502 #endif
504 lcd_setfont(FONT_SYSFIXED);
506 printf("Rockbox boot loader");
507 printf("Version: %s", version);
508 printf(MODEL_NAME);
510 i=storage_init();
511 #if !(CONFIG_STORAGE & STORAGE_SD)
512 if (i==0) {
513 identify_info=ata_get_identify();
514 /* Show model */
515 for (i=0; i < 20; i++) {
516 ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
518 buf[40]=0;
519 for (i=39; i && buf[i]==' '; i--) {
520 buf[i]=0;
522 printf(buf);
523 } else {
524 error(EATA, i);
526 #endif
528 disk_init(IF_MV(0));
529 num_partitions = disk_mount_all();
530 if (num_partitions<=0)
532 error(EDISK,num_partitions);
535 /* Just list the first 2 partitions since we don't have any devices yet
536 that have more than that */
537 for(i=0; i<NUM_PARTITIONS; i++)
539 pinfo = disk_partinfo(i);
540 printf("Partition %d: 0x%02x %ld MB",
541 i, pinfo->type, pinfo->size / 2048);
544 if(btn & BOOTLOADER_BOOT_OF)
546 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
547 The rest of the loading is done in crt0.S.
548 1) First try reading from the hidden partition (on Sansa only).
549 2) Next try a decrypted mi4 file in /System/OF.mi4
550 3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
551 a mi4 firmware decrypted and header stripped using mi4code.
553 printf("Loading original firmware...");
555 #if (CONFIG_STORAGE & STORAGE_SD)
556 /* First try a (hidden) firmware partition */
557 printf("Trying firmware partition");
558 pinfo = disk_partinfo(1);
559 if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
561 rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
562 if (rc < EOK) {
563 printf("Can't load from partition");
564 printf(strerror(rc));
565 } else {
566 return (void*)loadbuffer;
568 } else {
569 printf("No hidden partition found.");
571 #endif
573 #if defined(PHILIPS_HDD1630)
574 printf("Trying /System/OF.ebn");
575 rc=load_mi4(loadbuffer, "/System/OF.ebn", MAX_LOADSIZE);
576 if (rc < EOK) {
577 printf("Can't load /System/OF.ebn");
578 printf(strerror(rc));
579 } else {
580 return (void*)loadbuffer;
582 #endif
584 printf("Trying /System/OF.mi4");
585 rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
586 if (rc < EOK) {
587 printf("Can't load /System/OF.mi4");
588 printf(strerror(rc));
589 } else {
590 return (void*)loadbuffer;
593 printf("Trying /System/OF.bin");
594 rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
595 if (rc < EOK) {
596 printf("Can't load /System/OF.bin");
597 printf(strerror(rc));
598 } else {
599 return (void*)loadbuffer;
602 error(0, 0);
604 } else {
605 #if 0 /* e200: enable to be able to dump the hidden partition */
606 if(btn & BUTTON_UP)
608 int fd;
609 pinfo = disk_partinfo(1);
610 fd = open("/part.bin", O_CREAT|O_RDWR);
611 char sector[512];
612 for(i=0; i<40960; i++){
613 if (!(i%100))
615 printf("dumping sector %d", i);
617 storage_read_sectors(IF_MV2(0,) pinfo->start + i, 1, sector);
618 write(fd,sector,512);
620 close(fd);
622 #endif
623 printf("Loading Rockbox...");
624 rc=load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
625 if (rc < EOK) {
626 printf("Can't load " BOOTFILE ": ");
627 printf(strerror(rc));
629 #ifdef OLD_BOOTFILE
630 /* Try loading rockbox from old rockbox.e200/rockbox.h10 format */
631 rc=load_firmware(loadbuffer, OLD_BOOTFILE, MAX_LOADSIZE);
632 if (rc < EOK) {
633 printf("Can't load " OLD_BOOTFILE" : ");
634 error(EBOOTFILE, rc);
636 #endif
640 return (void*)loadbuffer;