Colour targets: Revert an optimisation from almost 18 months ago that actually turned...
[Rockbox.git] / bootloader / main-pp.c
blobd454fc84a2548cf88a9d15849c21f512e9ced44f
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>
26 #include "common.h"
27 #include "cpu.h"
28 #include "file.h"
29 #include "system.h"
30 #include "kernel.h"
31 #include "lcd.h"
32 #include "font.h"
33 #include "ata.h"
34 #include "button.h"
35 #include "disk.h"
36 #include "crc32-mi4.h"
37 #include <string.h>
38 #include "power.h"
39 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
40 #include "i2c.h"
41 #include "backlight-target.h"
42 #endif
43 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
44 #include "usb.h"
45 #include "usb_drv.h"
46 #endif
48 /* Show the Rockbox logo - in show_logo.c */
49 extern int show_logo(void);
51 /* Button definitions */
52 #if CONFIG_KEYPAD == IRIVER_H10_PAD
53 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
55 #elif CONFIG_KEYPAD == SANSA_E200_PAD
56 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
58 #elif CONFIG_KEYPAD == SANSA_C200_PAD
59 #define BOOTLOADER_BOOT_OF BUTTON_LEFT
61 #elif CONFIG_KEYPAD == MROBE100_PAD
62 #define BOOTLOADER_BOOT_OF BUTTON_POWER
64 #elif CONFIG_KEYPAD == PHILIPS_SA9200_PAD
65 #define BOOTLOADER_BOOT_OF BUTTON_VOL_UP
67 #elif CONFIG_KEYPAD == PHILIPS_HDD1630_PAD
68 #define BOOTLOADER_BOOT_OF BUTTON_MENU
70 #endif
72 /* Maximum allowed firmware image size. 10MB is more than enough */
73 #define MAX_LOADSIZE (10*1024*1024)
75 /* A buffer to load the original firmware or Rockbox into */
76 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
78 /* Bootloader version */
79 char version[] = APPSVERSION;
81 /* Locations and sizes in hidden partition on Sansa */
82 #if defined(HAVE_ATA_SD)
83 #define PPMI_SECTOR_OFFSET 1024
84 #define PPMI_SECTORS 1
85 #define MI4_HEADER_SECTORS 1
86 #define NUM_PARTITIONS 2
88 #else
89 #define NUM_PARTITIONS 1
91 #endif
93 #define MI4_HEADER_SIZE 0x200
95 /* mi4 header structure */
96 struct mi4header_t {
97 unsigned char magic[4];
98 uint32_t version;
99 uint32_t length;
100 uint32_t crc32;
101 uint32_t enctype;
102 uint32_t mi4size;
103 uint32_t plaintext;
104 uint32_t dsa_key[10];
105 uint32_t pad[109];
106 unsigned char type[4];
107 unsigned char model[4];
110 /* PPMI header structure */
111 struct ppmi_header_t {
112 unsigned char magic[4];
113 uint32_t length;
114 uint32_t pad[126];
117 inline unsigned int le2int(unsigned char* buf)
119 int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
121 return res;
124 inline void int2le(unsigned int val, unsigned char* addr)
126 addr[0] = val & 0xFF;
127 addr[1] = (val >> 8) & 0xff;
128 addr[2] = (val >> 16) & 0xff;
129 addr[3] = (val >> 24) & 0xff;
132 struct tea_key {
133 const char * name;
134 uint32_t key[4];
137 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
138 struct tea_key tea_keytable[] = {
139 { "default" , { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
140 { "sansa", { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
141 { "sansa_gh", { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
142 { "sansa_103", { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
143 { "rhapsody", { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
144 { "p610", { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
145 { "p640", { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
146 { "virgin", { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
147 { "20gc_eng", { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
148 { "20gc_fre", { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
149 { "elio_p722", { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
150 { "c200", { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
151 { "c200_103", { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
152 { "c200_106", { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
153 { "view", { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
154 { "sa9200", { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
155 { "hdd1630", { 0x04543ced, 0xcebfdbad, 0xf7477872, 0x0d12342e } },
160 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
162 "Following is an adaptation of the reference encryption and decryption
163 routines in C, released into the public domain by David Wheeler and
164 Roger Needham:"
168 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
169 to the reference implementation and the main loop is 8 iterations, not
173 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
174 uint32_t sum=0xF1BBCDC8, i; /* set up */
175 uint32_t delta=0x9E3779B9; /* a key schedule constant */
176 uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3]; /* cache key */
177 for(i=0; i<8; i++) { /* basic cycle start */
178 *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
179 *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
180 sum -= delta; /* end cycle */
184 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
185 integers) and the key is incremented after each block
188 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
190 uint32_t v0, v1;
191 unsigned int i;
193 for (i = 0; i < (n / 8); i++) {
194 v0 = le2int(src);
195 v1 = le2int(src+4);
197 tea_decrypt(&v0, &v1, key);
199 int2le(v0, dest);
200 int2le(v1, dest+4);
202 src += 8;
203 dest += 8;
205 /* Now increment the key */
206 key[0]++;
207 if (key[0]==0) {
208 key[1]++;
209 if (key[1]==0) {
210 key[2]++;
211 if (key[2]==0) {
212 key[3]++;
219 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
221 unsigned char magic_dec[8];
222 tea_decrypt_buf(magic_enc, magic_dec, 8, key);
224 return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
227 static int tea_find_key(struct mi4header_t *mi4header, int fd)
229 unsigned int i;
230 int rc;
231 unsigned int j;
232 uint32_t key[4];
233 unsigned char magic_enc[8];
234 int key_found = -1;
235 unsigned int magic_location = mi4header->length-4;
236 int unaligned = 0;
238 if ( (magic_location % 8) != 0 )
240 unaligned = 1;
241 magic_location -= 4;
244 /* Load encrypted magic 0xaa55aa55 to check key */
245 lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
246 rc = read(fd, magic_enc, 8);
247 if(rc < 8 )
248 return EREAD_IMAGE_FAILED;
250 printf("Searching for key:");
252 for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
253 key[0] = tea_keytable[i].key[0];
254 key[1] = tea_keytable[i].key[1];
255 key[2] = tea_keytable[i].key[2];
256 key[3] = tea_keytable[i].key[3];
258 /* Now increment the key */
259 for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
260 key[0]++;
261 if (key[0]==0) {
262 key[1]++;
263 if (key[1]==0) {
264 key[2]++;
265 if (key[2]==0) {
266 key[3]++;
272 if (tea_test_key(magic_enc,key,unaligned))
274 key_found = i;
275 printf("%s...found", tea_keytable[i].name);
276 } else {
277 /* printf("%s...failed", tea_keytable[i].name); */
281 return key_found;
285 /* Load mi4 format firmware image */
286 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
288 int fd;
289 struct mi4header_t mi4header;
290 int rc;
291 unsigned long sum;
292 char filename[MAX_PATH];
294 snprintf(filename,sizeof(filename),"/.rockbox/%s",firmware);
295 fd = open(filename, O_RDONLY);
296 if(fd < 0)
298 snprintf(filename,sizeof(filename),"/%s",firmware);
299 fd = open(filename, O_RDONLY);
300 if(fd < 0)
301 return EFILE_NOT_FOUND;
304 read(fd, &mi4header, MI4_HEADER_SIZE);
306 /* MI4 file size */
307 printf("mi4 size: %x", mi4header.mi4size);
309 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
310 return EFILE_TOO_BIG;
312 /* CRC32 */
313 printf("CRC32: %x", mi4header.crc32);
315 /* Rockbox model id */
316 printf("Model id: %.4s", mi4header.model);
318 /* Read binary type (RBOS, RBBL) */
319 printf("Binary type: %.4s", mi4header.type);
321 /* Load firmware file */
322 lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
323 rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
324 if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
325 return EREAD_IMAGE_FAILED;
327 /* Check CRC32 to see if we have a valid file */
328 sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
330 printf("Calculated CRC32: %x", sum);
332 if(sum != mi4header.crc32)
333 return EBAD_CHKSUM;
335 if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
337 /* Load encrypted firmware */
338 int key_index = tea_find_key(&mi4header, fd);
340 if (key_index < 0)
341 return EINVALID_FORMAT;
343 /* Plaintext part is already loaded */
344 buf += mi4header.plaintext;
346 /* Decrypt in-place */
347 tea_decrypt_buf(buf, buf,
348 mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
349 tea_keytable[key_index].key);
351 printf("%s key used", tea_keytable[key_index].name);
353 /* Check decryption was successfull */
354 if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
356 return EREAD_IMAGE_FAILED;
360 return EOK;
363 #if defined(HAVE_ATA_SD)
364 /* Load mi4 firmware from a hidden disk partition */
365 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
366 unsigned int buffer_size, bool disable_rebuild)
368 struct mi4header_t mi4header;
369 struct ppmi_header_t ppmi_header;
370 unsigned long sum;
372 /* Read header to find out how long the mi4 file is. */
373 ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET,
374 PPMI_SECTORS, &ppmi_header);
376 /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
377 if( memcmp(ppmi_header.magic, "PPMI", 4) )
378 return EFILE_NOT_FOUND;
380 printf("BL mi4 size: %x", ppmi_header.length);
382 /* Read mi4 header of the OF */
383 ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
384 + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
386 /* We don't support encrypted mi4 files yet */
387 if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
388 return EINVALID_FORMAT;
390 /* MI4 file size */
391 printf("OF mi4 size: %x", mi4header.mi4size);
393 if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
394 return EFILE_TOO_BIG;
396 /* CRC32 */
397 printf("CRC32: %x", mi4header.crc32);
399 /* Rockbox model id */
400 printf("Model id: %.4s", mi4header.model);
402 /* Read binary type (RBOS, RBBL) */
403 printf("Binary type: %.4s", mi4header.type);
405 /* Load firmware */
406 ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
407 + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
408 (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
410 /* Check CRC32 to see if we have a valid file */
411 sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
413 printf("Calculated CRC32: %x", sum);
415 if(sum != mi4header.crc32)
416 return EBAD_CHKSUM;
418 #ifdef SANSA_E200
419 if (disable_rebuild)
421 char block[512];
423 printf("Disabling database rebuild");
425 ata_read_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
426 block[0xe1] = 0;
427 ata_write_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
429 #else
430 (void) disable_rebuild;
431 #endif
433 return EOK;
435 #endif
437 void* main(void)
439 int i;
440 int btn;
441 int rc;
442 int num_partitions;
443 struct partinfo* pinfo;
444 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
445 int usb_retry = 0;
446 bool usb = false;
447 #else
448 char buf[256];
449 unsigned short* identify_info;
450 #endif
452 chksum_crc32gentab ();
454 system_init();
455 kernel_init();
457 lcd_init();
459 font_init();
460 show_logo();
462 button_init();
463 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
464 i2c_init();
465 _backlight_on();
466 #endif
468 if (button_hold())
470 verbose = true;
471 lcd_clear_display();
472 printf("Hold switch on");
473 printf("Shutting down...");
474 sleep(HZ);
475 power_off();
478 btn = button_read_device();
480 /* Enable bootloader messages if any button is pressed */
481 if (btn) {
482 lcd_clear_display();
483 verbose = true;
486 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
487 #if !defined(USE_ROCKBOX_USB)
488 usb_init();
489 while (usb_drv_powered() && usb_retry < 5 && !usb)
491 usb_retry++;
492 sleep(HZ/4);
493 usb = (usb_detect() == USB_INSERTED);
495 if (usb)
496 btn |= BOOTLOADER_BOOT_OF;
497 #endif /* USE_ROCKBOX_USB */
498 #endif
500 lcd_setfont(FONT_SYSFIXED);
502 printf("Rockbox boot loader");
503 printf("Version: %s", version);
504 printf(MODEL_NAME);
506 i=ata_init();
507 #if !defined(HAVE_ATA_SD)
508 if (i==0) {
509 identify_info=ata_get_identify();
510 /* Show model */
511 for (i=0; i < 20; i++) {
512 ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
514 buf[40]=0;
515 for (i=39; i && buf[i]==' '; i--) {
516 buf[i]=0;
518 printf(buf);
519 } else {
520 error(EATA, i);
522 #endif
524 disk_init(IF_MV(0));
525 num_partitions = disk_mount_all();
526 if (num_partitions<=0)
528 error(EDISK,num_partitions);
531 /* Just list the first 2 partitions since we don't have any devices yet
532 that have more than that */
533 for(i=0; i<NUM_PARTITIONS; i++)
535 pinfo = disk_partinfo(i);
536 printf("Partition %d: 0x%02x %ld MB",
537 i, pinfo->type, pinfo->size / 2048);
540 if(btn & BOOTLOADER_BOOT_OF)
542 /* Load original mi4 firmware in to a memory buffer called loadbuffer.
543 The rest of the loading is done in crt0.S.
544 1) First try reading from the hidden partition (on Sansa only).
545 2) Next try a decrypted mi4 file in /System/OF.mi4
546 3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
547 a mi4 firmware decrypted and header stripped using mi4code.
549 printf("Loading original firmware...");
551 #if defined(HAVE_ATA_SD)
552 /* First try a (hidden) firmware partition */
553 printf("Trying firmware partition");
554 pinfo = disk_partinfo(1);
555 if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
557 rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
558 if (rc < EOK) {
559 printf("Can't load from partition");
560 printf(strerror(rc));
561 } else {
562 return (void*)loadbuffer;
564 } else {
565 printf("No hidden partition found.");
567 #endif
569 printf("Trying /System/OF.mi4");
570 rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
571 if (rc < EOK) {
572 printf("Can't load /System/OF.mi4");
573 printf(strerror(rc));
574 } else {
575 return (void*)loadbuffer;
578 printf("Trying /System/OF.bin");
579 rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
580 if (rc < EOK) {
581 printf("Can't load /System/OF.bin");
582 printf(strerror(rc));
583 } else {
584 return (void*)loadbuffer;
587 error(0, 0);
589 } else {
590 #if 0 /* e200: enable to be able to dump the hidden partition */
591 if(btn & BUTTON_UP)
593 int fd;
594 pinfo = disk_partinfo(1);
595 fd = open("/part.bin", O_CREAT|O_RDWR);
596 char sector[512];
597 for(i=0; i<40960; i++){
598 if (!(i%100))
600 printf("dumping sector %d", i);
602 ata_read_sectors(IF_MV2(0,) pinfo->start + i, 1, sector);
603 write(fd,sector,512);
605 close(fd);
607 #endif
608 printf("Loading Rockbox...");
609 rc=load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
610 if (rc < EOK) {
611 printf("Can't load %s:", BOOTFILE);
612 printf(strerror(rc));
614 #ifdef OLD_BOOTFILE
615 /* Try loading rockbox from old rockbox.e200/rockbox.h10 format */
616 rc=load_firmware(loadbuffer, OLD_BOOTFILE, MAX_LOADSIZE);
617 if (rc < EOK) {
618 printf("Can't load %s:", OLD_BOOTFILE);
619 error(EBOOTFILE, rc);
621 #endif
625 return (void*)loadbuffer;
628 #if !defined(SANSA_E200) && !defined(SANSA_C200) && !defined(PHILIPS_SA9200)
629 /* These functions are present in the firmware library, but we reimplement
630 them here because the originals do a lot more than we want */
631 void usb_acknowledge(void)
635 void usb_wait_for_disconnect(void)
638 #endif