bootloader/main-pp.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2006 by Barry Wardell
  11  *
  12  * Based on Rockbox iriver bootloader by Linus Nielsen Feltzing
  13  * and the ipodlinux bootloader by Daniel Palffy and Bernard Leach
  14  *
  15  * All files in this archive are subject to the GNU General Public License.
  16  * See the file COPYING in the source tree root for full license agreement.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include "common.h"
  25 #include "cpu.h"
  26 #include "file.h"
  27 #include "system.h"
  28 #include "kernel.h"
  29 #include "lcd.h"
  30 #include "font.h"
  31 #include "ata.h"
  32 #include "button.h"
  33 #include "disk.h"
  34 #include "crc32-mi4.h"
  35 #include <string.h>
  36 #include "power.h"
  37 #if defined(SANSA_E200)
  38 #include "i2c.h"
  39 #include "backlight-target.h"
  40 #endif
  41 #if defined(SANSA_E200) || defined(SANSA_C200)
  42 #include "usb.h"
  43 #include "usb_drv.h"
  44 #endif
  45
  46
  47 /* Button definitions */
  48 #if CONFIG_KEYPAD == IRIVER_H10_PAD
  49 #define BOOTLOADER_BOOT_OF      BUTTON_LEFT
  50
  51 #elif CONFIG_KEYPAD == SANSA_E200_PAD
  52 #define BOOTLOADER_BOOT_OF      BUTTON_LEFT
  53
  54 #elif CONFIG_KEYPAD == SANSA_C200_PAD
  55 #define BOOTLOADER_BOOT_OF      BUTTON_LEFT
  56
  57 #elif CONFIG_KEYPAD == MROBE100_PAD
  58 #define BOOTLOADER_BOOT_OF      BUTTON_LEFT
  59
  60 #endif
  61
  62 /* Maximum allowed firmware image size. 10MB is more than enough */
  63 #define MAX_LOADSIZE (10*1024*1024)
  64
  65 /* A buffer to load the original firmware or Rockbox into */
  66 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
  67
  68 /* Bootloader version */
  69 char version[] = APPSVERSION;
  70
  71 /* Locations and sizes in hidden partition on Sansa */
  72 #if defined(SANSA_E200) || defined(SANSA_C200)
  73 #define PPMI_SECTOR_OFFSET  1024
  74 #define PPMI_SECTORS        1
  75 #define MI4_HEADER_SECTORS  1
  76 #define NUM_PARTITIONS      2
  77
  78 #else
  79 #define NUM_PARTITIONS      1
  80
  81 #endif
  82
  83 #define MI4_HEADER_SIZE     0x200
  84
  85 /* mi4 header structure */
  86 struct mi4header_t {
  87     unsigned char magic[4];
  88     uint32_t version;
  89     uint32_t length;
  90     uint32_t crc32;
  91     uint32_t enctype;
  92     uint32_t mi4size;
  93     uint32_t plaintext;
  94     uint32_t dsa_key[10];
  95     uint32_t pad[109];
  96     unsigned char type[4];
  97     unsigned char model[4];
  98 };
  99
 100 /* PPMI header structure */
 101 struct ppmi_header_t {
 102     unsigned char magic[4];
 103     uint32_t length;
 104     uint32_t pad[126];
 105 };
 106
 107 inline unsigned int le2int(unsigned char* buf)
 108 {
 109    int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
 110
 111    return res;
 112 }
 113
 114 inline void int2le(unsigned int val, unsigned char* addr)
 115 {
 116     addr[0] = val & 0xFF;
 117     addr[1] = (val >> 8) & 0xff;
 118     addr[2] = (val >> 16) & 0xff;
 119     addr[3] = (val >> 24) & 0xff;
 120 }
 121
 122 struct tea_key {
 123   const char * name;
 124   uint32_t     key[4];
 125 };
 126
 127 #define NUM_KEYS (sizeof(tea_keytable)/sizeof(tea_keytable[0]))
 128 struct tea_key tea_keytable[] = {
 129   { "default" ,          { 0x20d36cc0, 0x10e8c07d, 0xc0e7dcaa, 0x107eb080 } },
 130   { "sansa",             { 0xe494e96e, 0x3ee32966, 0x6f48512b, 0xa93fbb42 } },
 131   { "sansa_gh",          { 0xd7b10538, 0xc662945b, 0x1b3fce68, 0xf389c0e6 } },
 132   { "sansa_103",         { 0x1d29ddc0, 0x2579c2cd, 0xce339e1a, 0x75465dfe } },
 133   { "rhapsody",          { 0x7aa9c8dc, 0xbed0a82a, 0x16204cc7, 0x5904ef38 } },
 134   { "p610",              { 0x950e83dc, 0xec4907f9, 0x023734b9, 0x10cfb7c7 } },
 135   { "p640",              { 0x220c5f23, 0xd04df68e, 0x431b5e25, 0x4dcc1fa1 } },
 136   { "virgin",            { 0xe83c29a1, 0x04862973, 0xa9b3f0d4, 0x38be2a9c } },
 137   { "20gc_eng",          { 0x0240772c, 0x6f3329b5, 0x3ec9a6c5, 0xb0c9e493 } },
 138   { "20gc_fre",          { 0xbede8817, 0xb23bfe4f, 0x80aa682d, 0xd13f598c } },
 139   { "elio_p722",         { 0x6af3b9f8, 0x777483f5, 0xae8181cc, 0xfa6d8a84 } },
 140   { "c200",              { 0xbf2d06fa, 0xf0e23d59, 0x29738132, 0xe2d04ca7 } },
 141   { "c200_103",          { 0x2a7968de, 0x15127979, 0x142e60a7, 0xe49c1893 } },
 142   { "c200_106",          { 0xa913d139, 0xf842f398, 0x3e03f1a6, 0x060ee012 } },
 143 };
 144
 145 /*
 146
 147 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
 148
 149 "Following is an adaptation of the reference encryption and decryption
 150 routines in C, released into the public domain by David Wheeler and
 151 Roger Needham:"
 152
 153 */
 154
 155 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
 156          to the reference implementation and the main loop is 8 iterations, not
 157          32.
 158 */
 159
 160 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
 161     uint32_t sum=0xF1BBCDC8, i;                    /* set up */
 162     uint32_t delta=0x9E3779B9;                     /* a key schedule constant */
 163     uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3];   /* cache key */
 164     for(i=0; i<8; i++) {                               /* basic cycle start */
 165         *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
 166         *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
 167         sum -= delta;                                   /* end cycle */
 168     }
 169 }
 170
 171 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
 172    integers) and the key is incremented after each block
 173  */
 174
 175 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
 176 {
 177     uint32_t v0, v1;
 178     unsigned int i;
 179
 180     for (i = 0; i < (n / 8); i++) {
 181         v0 = le2int(src);
 182         v1 = le2int(src+4);
 183
 184         tea_decrypt(&v0, &v1, key);
 185
 186         int2le(v0, dest);
 187         int2le(v1, dest+4);
 188
 189         src += 8;
 190         dest += 8;
 191
 192         /* Now increment the key */
 193         key[0]++;
 194         if (key[0]==0) {
 195             key[1]++;
 196             if (key[1]==0) {
 197                 key[2]++;
 198                 if (key[2]==0) {
 199                     key[3]++;
 200                 }
 201             }
 202         }
 203     }
 204 }
 205
 206 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
 207 {
 208     unsigned char magic_dec[8];
 209     tea_decrypt_buf(magic_enc, magic_dec, 8, key);
 210
 211     return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
 212 }
 213
 214 static int tea_find_key(struct mi4header_t *mi4header, int fd)
 215 {
 216     unsigned int i;
 217     int rc;
 218     unsigned int j;
 219     uint32_t key[4];
 220     unsigned char magic_enc[8];
 221     int key_found = -1;
 222     unsigned int magic_location = mi4header->length-4;
 223     int unaligned = 0;
 224
 225     if ( (magic_location % 8) != 0 )
 226     {
 227         unaligned = 1;
 228         magic_location -= 4;
 229     }
 230
 231     /* Load encrypted magic 0xaa55aa55 to check key */
 232     lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
 233     rc = read(fd, magic_enc, 8);
 234     if(rc < 8 )
 235         return EREAD_IMAGE_FAILED;
 236
 237     printf("Searching for key:");
 238
 239     for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
 240         key[0] = tea_keytable[i].key[0];
 241         key[1] = tea_keytable[i].key[1];
 242         key[2] = tea_keytable[i].key[2];
 243         key[3] = tea_keytable[i].key[3];
 244
 245         /* Now increment the key */
 246         for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
 247             key[0]++;
 248             if (key[0]==0) {
 249                 key[1]++;
 250                 if (key[1]==0) {
 251                     key[2]++;
 252                     if (key[2]==0) {
 253                         key[3]++;
 254                     }
 255                 }
 256             }
 257         }
 258
 259         if (tea_test_key(magic_enc,key,unaligned))
 260         {
 261             key_found = i;
 262             printf("%s...found", tea_keytable[i].name);
 263         } else {
 264            /* printf("%s...failed", tea_keytable[i].name); */
 265         }
 266     }
 267
 268     return key_found;
 269 }
 270
 271
 272 /* Load mi4 format firmware image */
 273 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
 274 {
 275     int fd;
 276     struct mi4header_t mi4header;
 277     int rc;
 278     unsigned long sum;
 279     char filename[MAX_PATH];
 280
 281     snprintf(filename,sizeof(filename),"/.rockbox/%s",firmware);
 282     fd = open(filename, O_RDONLY);
 283     if(fd < 0)
 284     {
 285         snprintf(filename,sizeof(filename),"/%s",firmware);
 286         fd = open(filename, O_RDONLY);
 287         if(fd < 0)
 288             return EFILE_NOT_FOUND;
 289     }
 290
 291     read(fd, &mi4header, MI4_HEADER_SIZE);
 292
 293     /* MI4 file size */
 294     printf("mi4 size: %x", mi4header.mi4size);
 295
 296     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 297         return EFILE_TOO_BIG;
 298
 299     /* CRC32 */
 300     printf("CRC32: %x", mi4header.crc32);
 301
 302     /* Rockbox model id */
 303     printf("Model id: %.4s", mi4header.model);
 304
 305     /* Read binary type (RBOS, RBBL) */
 306     printf("Binary type: %.4s", mi4header.type);
 307
 308     /* Load firmware file */
 309     lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
 310     rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
 311     if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
 312         return EREAD_IMAGE_FAILED;
 313
 314     /* Check CRC32 to see if we have a valid file */
 315     sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
 316
 317     printf("Calculated CRC32: %x", sum);
 318
 319     if(sum != mi4header.crc32)
 320         return EBAD_CHKSUM;
 321
 322     if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
 323     {
 324         /* Load encrypted firmware */
 325         int key_index = tea_find_key(&mi4header, fd);
 326
 327         if (key_index < 0)
 328             return EINVALID_FORMAT;
 329
 330         /* Plaintext part is already loaded */
 331         buf += mi4header.plaintext;
 332
 333         /* Decrypt in-place */
 334         tea_decrypt_buf(buf, buf,
 335                         mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
 336                         tea_keytable[key_index].key);
 337
 338         printf("%s key used", tea_keytable[key_index].name);
 339
 340         /* Check decryption was successfull */
 341         if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
 342         {
 343             return EREAD_IMAGE_FAILED;
 344         }
 345     }
 346
 347     return EOK;
 348 }
 349
 350 #if defined(SANSA_E200) || defined(SANSA_C200)
 351 /* Load mi4 firmware from a hidden disk partition */
 352 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
 353                   unsigned int buffer_size, bool disable_rebuild)
 354 {
 355     struct mi4header_t mi4header;
 356     struct ppmi_header_t ppmi_header;
 357     unsigned long sum;
 358
 359     /* Read header to find out how long the mi4 file is. */
 360     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET,
 361                             PPMI_SECTORS, &ppmi_header);
 362
 363     /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
 364     if( memcmp(ppmi_header.magic, "PPMI", 4) )
 365         return EFILE_NOT_FOUND;
 366
 367     printf("BL mi4 size: %x", ppmi_header.length);
 368
 369     /* Read mi4 header of the OF */
 370     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
 371                        + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
 372
 373     /* We don't support encrypted mi4 files yet */
 374     if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
 375         return EINVALID_FORMAT;
 376
 377     /* MI4 file size */
 378     printf("OF mi4 size: %x", mi4header.mi4size);
 379
 380     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 381         return EFILE_TOO_BIG;
 382
 383     /* CRC32 */
 384     printf("CRC32: %x", mi4header.crc32);
 385
 386     /* Rockbox model id */
 387     printf("Model id: %.4s", mi4header.model);
 388
 389     /* Read binary type (RBOS, RBBL) */
 390     printf("Binary type: %.4s", mi4header.type);
 391
 392     /* Load firmware */
 393     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
 394                         + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
 395                         (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
 396
 397     /* Check CRC32 to see if we have a valid file */
 398     sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
 399
 400     printf("Calculated CRC32: %x", sum);
 401
 402     if(sum != mi4header.crc32)
 403         return EBAD_CHKSUM;
 404
 405 #ifdef SANSA_E200
 406     if (disable_rebuild)
 407     {
 408         char block[512];
 409
 410         printf("Disabling database rebuild");
 411
 412         ata_read_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
 413         block[0xe1] = 0;
 414         ata_write_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
 415     }
 416 #else
 417     (void) disable_rebuild;
 418 #endif
 419
 420     return EOK;
 421 }
 422 #endif
 423
 424 void* main(void)
 425 {
 426     int i;
 427     int btn;
 428     int rc;
 429     int num_partitions;
 430     struct partinfo* pinfo;
 431 #if defined(SANSA_E200) || defined(SANSA_C200)
 432     int usb_retry = 0;
 433     bool usb = false;
 434 #else
 435     char buf[256];
 436     unsigned short* identify_info;
 437 #endif
 438
 439     chksum_crc32gentab ();
 440
 441     system_init();
 442     kernel_init();
 443     lcd_init();
 444     font_init();
 445     button_init();
 446 #if defined(SANSA_E200)
 447     i2c_init();
 448     _backlight_on();
 449 #endif
 450
 451 #if LCD_DEPTH > 1
 452     lcd_set_foreground(LCD_WHITE);
 453     lcd_set_background(LCD_BLACK);
 454 #endif
 455     lcd_clear_display();
 456
 457     if (button_hold())
 458     {
 459         verbose = true;
 460         printf("Hold switch on");
 461         printf("Shutting down...");
 462         sleep(HZ);
 463         power_off();
 464     }
 465
 466     btn = button_read_device();
 467 #if defined(SANSA_E200) || defined(SANSA_C200)
 468 #if !defined(USE_ROCKBOX_USB)
 469     usb_init();
 470     while (usb_drv_powered() && usb_retry < 5 && !usb)
 471     {
 472         usb_retry++;
 473         sleep(HZ/4);
 474         usb = (usb_detect() == USB_INSERTED);
 475     }
 476     if (usb)
 477         btn |= BOOTLOADER_BOOT_OF;
 478 #endif /* USE_ROCKBOX_USB */
 479 #endif
 480     /* Enable bootloader messages if any button is pressed */
 481     if (btn)
 482         verbose = true;
 483
 484     lcd_setfont(FONT_SYSFIXED);
 485
 486     printf("Rockbox boot loader");
 487     printf("Version: %s", version);
 488     printf(MODEL_NAME);
 489
 490     i=ata_init();
 491 #if !defined(SANSA_E200) && !defined(SANSA_C200)
 492     if (i==0) {
 493         identify_info=ata_get_identify();
 494         /* Show model */
 495         for (i=0; i < 20; i++) {
 496             ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
 497         }
 498         buf[40]=0;
 499         for (i=39; i && buf[i]==' '; i--) {
 500             buf[i]=0;
 501         }
 502         printf(buf);
 503     } else {
 504         error(EATA, i);
 505     }
 506 #endif
 507
 508     disk_init(IF_MV(0));
 509     num_partitions = disk_mount_all();
 510     if (num_partitions<=0)
 511     {
 512         error(EDISK,num_partitions);
 513     }
 514
 515     /* Just list the first 2 partitions since we don't have any devices yet
 516        that have more than that */
 517     for(i=0; i<NUM_PARTITIONS; i++)
 518     {
 519         pinfo = disk_partinfo(i);
 520         printf("Partition %d: 0x%02x %ld MB",
 521                 i, pinfo->type, pinfo->size / 2048);
 522     }
 523
 524     if(btn & BOOTLOADER_BOOT_OF)
 525     {
 526         /* Load original mi4 firmware in to a memory buffer called loadbuffer.
 527            The rest of the loading is done in crt0.S.
 528            1) First try reading from the hidden partition (on Sansa only).
 529            2) Next try a decrypted mi4 file in /System/OF.mi4
 530            3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
 531               a mi4 firmware decrypted and header stripped using mi4code.
 532         */
 533         printf("Loading original firmware...");
 534
 535 #if defined(SANSA_E200) || defined(SANSA_C200)
 536         /* First try a (hidden) firmware partition */
 537         printf("Trying firmware partition");
 538         pinfo = disk_partinfo(1);
 539         if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
 540         {
 541             rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
 542             if (rc < EOK) {
 543                 printf("Can't load from partition");
 544                 printf(strerror(rc));
 545             } else {
 546                 return (void*)loadbuffer;
 547             }
 548         } else {
 549             printf("No hidden partition found.");
 550         }
 551 #endif
 552
 553         printf("Trying /System/OF.mi4");
 554         rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
 555         if (rc < EOK) {
 556             printf("Can't load /System/OF.mi4");
 557             printf(strerror(rc));
 558         } else {
 559             return (void*)loadbuffer;
 560         }
 561
 562         printf("Trying /System/OF.bin");
 563         rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
 564         if (rc < EOK) {
 565             printf("Can't load /System/OF.bin");
 566             printf(strerror(rc));
 567         } else {
 568             return (void*)loadbuffer;
 569         }
 570
 571         error(0, 0);
 572
 573     } else {
 574 #if 0 /* e200: enable to be able to dump the hidden partition */
 575         if(btn & BUTTON_UP)
 576         {
 577             int fd;
 578             pinfo = disk_partinfo(1);
 579             fd = open("/part.bin", O_CREAT|O_RDWR);
 580             char sector[512];
 581             for(i=0; i<40960; i++){
 582                 if (!(i%100))
 583                 {
 584                     printf("dumping sector %d", i);
 585                 }
 586                 ata_read_sectors(IF_MV2(0,) pinfo->start + i, 1, sector);
 587                 write(fd,sector,512);
 588             }
 589             close(fd);
 590         }
 591 #endif
 592         printf("Loading Rockbox...");
 593         rc=load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
 594         if (rc < EOK) {
 595             printf("Can't load %s:", BOOTFILE);
 596             printf(strerror(rc));
 597
 598 #ifdef OLD_BOOTFILE
 599             /* Try loading rockbox from old rockbox.e200/rockbox.h10 format */
 600             rc=load_firmware(loadbuffer, OLD_BOOTFILE, MAX_LOADSIZE);
 601             if (rc < EOK) {
 602                 printf("Can't load %s:", OLD_BOOTFILE);
 603                 error(EBOOTFILE, rc);
 604             }
 605 #endif
 606         }
 607     }
 608
 609     return (void*)loadbuffer;
 610 }
 611
 612 #if !defined(SANSA_E200) && !defined(SANSA_C200)
 613 /* These functions are present in the firmware library, but we reimplement
 614    them here because the originals do a lot more than we want */
 615 void usb_acknowledge(void)
 616 {
 617 }
 618
 619 void usb_wait_for_disconnect(void)
 620 {
 621 }
 622 #endif
 623