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_POWER
  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   { "view",              { 0x70e19bda, 0x0c69ea7d, 0x2b8b1ad1, 0xe9767ced } },
 144   { "sa9200",            { 0x33ea0236, 0x9247bdc5, 0xdfaedf9f, 0xd67c9d30 } },
 145 };
 146
 147 /*
 148
 149 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
 150
 151 "Following is an adaptation of the reference encryption and decryption
 152 routines in C, released into the public domain by David Wheeler and
 153 Roger Needham:"
 154
 155 */
 156
 157 /* NOTE: The mi4 version of TEA uses a different initial value to sum compared
 158          to the reference implementation and the main loop is 8 iterations, not
 159          32.
 160 */
 161
 162 static void tea_decrypt(uint32_t* v0, uint32_t* v1, uint32_t* k) {
 163     uint32_t sum=0xF1BBCDC8, i;                    /* set up */
 164     uint32_t delta=0x9E3779B9;                     /* a key schedule constant */
 165     uint32_t k0=k[0], k1=k[1], k2=k[2], k3=k[3];   /* cache key */
 166     for(i=0; i<8; i++) {                               /* basic cycle start */
 167         *v1 -= ((*v0<<4) + k2) ^ (*v0 + sum) ^ ((*v0>>5) + k3);
 168         *v0 -= ((*v1<<4) + k0) ^ (*v1 + sum) ^ ((*v1>>5) + k1);
 169         sum -= delta;                                   /* end cycle */
 170     }
 171 }
 172
 173 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
 174    integers) and the key is incremented after each block
 175  */
 176
 177 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
 178 {
 179     uint32_t v0, v1;
 180     unsigned int i;
 181
 182     for (i = 0; i < (n / 8); i++) {
 183         v0 = le2int(src);
 184         v1 = le2int(src+4);
 185
 186         tea_decrypt(&v0, &v1, key);
 187
 188         int2le(v0, dest);
 189         int2le(v1, dest+4);
 190
 191         src += 8;
 192         dest += 8;
 193
 194         /* Now increment the key */
 195         key[0]++;
 196         if (key[0]==0) {
 197             key[1]++;
 198             if (key[1]==0) {
 199                 key[2]++;
 200                 if (key[2]==0) {
 201                     key[3]++;
 202                 }
 203             }
 204         }
 205     }
 206 }
 207
 208 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
 209 {
 210     unsigned char magic_dec[8];
 211     tea_decrypt_buf(magic_enc, magic_dec, 8, key);
 212
 213     return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
 214 }
 215
 216 static int tea_find_key(struct mi4header_t *mi4header, int fd)
 217 {
 218     unsigned int i;
 219     int rc;
 220     unsigned int j;
 221     uint32_t key[4];
 222     unsigned char magic_enc[8];
 223     int key_found = -1;
 224     unsigned int magic_location = mi4header->length-4;
 225     int unaligned = 0;
 226
 227     if ( (magic_location % 8) != 0 )
 228     {
 229         unaligned = 1;
 230         magic_location -= 4;
 231     }
 232
 233     /* Load encrypted magic 0xaa55aa55 to check key */
 234     lseek(fd, MI4_HEADER_SIZE + magic_location, SEEK_SET);
 235     rc = read(fd, magic_enc, 8);
 236     if(rc < 8 )
 237         return EREAD_IMAGE_FAILED;
 238
 239     printf("Searching for key:");
 240
 241     for (i=0; i < NUM_KEYS && (key_found<0) ; i++) {
 242         key[0] = tea_keytable[i].key[0];
 243         key[1] = tea_keytable[i].key[1];
 244         key[2] = tea_keytable[i].key[2];
 245         key[3] = tea_keytable[i].key[3];
 246
 247         /* Now increment the key */
 248         for(j=0; j<((magic_location-mi4header->plaintext)/8); j++){
 249             key[0]++;
 250             if (key[0]==0) {
 251                 key[1]++;
 252                 if (key[1]==0) {
 253                     key[2]++;
 254                     if (key[2]==0) {
 255                         key[3]++;
 256                     }
 257                 }
 258             }
 259         }
 260
 261         if (tea_test_key(magic_enc,key,unaligned))
 262         {
 263             key_found = i;
 264             printf("%s...found", tea_keytable[i].name);
 265         } else {
 266            /* printf("%s...failed", tea_keytable[i].name); */
 267         }
 268     }
 269
 270     return key_found;
 271 }
 272
 273
 274 /* Load mi4 format firmware image */
 275 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
 276 {
 277     int fd;
 278     struct mi4header_t mi4header;
 279     int rc;
 280     unsigned long sum;
 281     char filename[MAX_PATH];
 282
 283     snprintf(filename,sizeof(filename),"/.rockbox/%s",firmware);
 284     fd = open(filename, O_RDONLY);
 285     if(fd < 0)
 286     {
 287         snprintf(filename,sizeof(filename),"/%s",firmware);
 288         fd = open(filename, O_RDONLY);
 289         if(fd < 0)
 290             return EFILE_NOT_FOUND;
 291     }
 292
 293     read(fd, &mi4header, MI4_HEADER_SIZE);
 294
 295     /* MI4 file size */
 296     printf("mi4 size: %x", mi4header.mi4size);
 297
 298     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 299         return EFILE_TOO_BIG;
 300
 301     /* CRC32 */
 302     printf("CRC32: %x", mi4header.crc32);
 303
 304     /* Rockbox model id */
 305     printf("Model id: %.4s", mi4header.model);
 306
 307     /* Read binary type (RBOS, RBBL) */
 308     printf("Binary type: %.4s", mi4header.type);
 309
 310     /* Load firmware file */
 311     lseek(fd, MI4_HEADER_SIZE, SEEK_SET);
 312     rc = read(fd, buf, mi4header.mi4size-MI4_HEADER_SIZE);
 313     if(rc < (int)mi4header.mi4size-MI4_HEADER_SIZE)
 314         return EREAD_IMAGE_FAILED;
 315
 316     /* Check CRC32 to see if we have a valid file */
 317     sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
 318
 319     printf("Calculated CRC32: %x", sum);
 320
 321     if(sum != mi4header.crc32)
 322         return EBAD_CHKSUM;
 323
 324     if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
 325     {
 326         /* Load encrypted firmware */
 327         int key_index = tea_find_key(&mi4header, fd);
 328
 329         if (key_index < 0)
 330             return EINVALID_FORMAT;
 331
 332         /* Plaintext part is already loaded */
 333         buf += mi4header.plaintext;
 334
 335         /* Decrypt in-place */
 336         tea_decrypt_buf(buf, buf,
 337                         mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
 338                         tea_keytable[key_index].key);
 339
 340         printf("%s key used", tea_keytable[key_index].name);
 341
 342         /* Check decryption was successfull */
 343         if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
 344         {
 345             return EREAD_IMAGE_FAILED;
 346         }
 347     }
 348
 349     return EOK;
 350 }
 351
 352 #if defined(SANSA_E200) || defined(SANSA_C200)
 353 /* Load mi4 firmware from a hidden disk partition */
 354 int load_mi4_part(unsigned char* buf, struct partinfo* pinfo,
 355                   unsigned int buffer_size, bool disable_rebuild)
 356 {
 357     struct mi4header_t mi4header;
 358     struct ppmi_header_t ppmi_header;
 359     unsigned long sum;
 360
 361     /* Read header to find out how long the mi4 file is. */
 362     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET,
 363                             PPMI_SECTORS, &ppmi_header);
 364
 365     /* The first four characters at 0x80000 (sector 1024) should be PPMI*/
 366     if( memcmp(ppmi_header.magic, "PPMI", 4) )
 367         return EFILE_NOT_FOUND;
 368
 369     printf("BL mi4 size: %x", ppmi_header.length);
 370
 371     /* Read mi4 header of the OF */
 372     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
 373                        + (ppmi_header.length/512), MI4_HEADER_SECTORS, &mi4header);
 374
 375     /* We don't support encrypted mi4 files yet */
 376     if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
 377         return EINVALID_FORMAT;
 378
 379     /* MI4 file size */
 380     printf("OF mi4 size: %x", mi4header.mi4size);
 381
 382     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 383         return EFILE_TOO_BIG;
 384
 385     /* CRC32 */
 386     printf("CRC32: %x", mi4header.crc32);
 387
 388     /* Rockbox model id */
 389     printf("Model id: %.4s", mi4header.model);
 390
 391     /* Read binary type (RBOS, RBBL) */
 392     printf("Binary type: %.4s", mi4header.type);
 393
 394     /* Load firmware */
 395     ata_read_sectors(IF_MV2(0,) pinfo->start + PPMI_SECTOR_OFFSET + PPMI_SECTORS
 396                         + (ppmi_header.length/512) + MI4_HEADER_SECTORS,
 397                         (mi4header.mi4size-MI4_HEADER_SIZE)/512, buf);
 398
 399     /* Check CRC32 to see if we have a valid file */
 400     sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
 401
 402     printf("Calculated CRC32: %x", sum);
 403
 404     if(sum != mi4header.crc32)
 405         return EBAD_CHKSUM;
 406
 407 #ifdef SANSA_E200
 408     if (disable_rebuild)
 409     {
 410         char block[512];
 411
 412         printf("Disabling database rebuild");
 413
 414         ata_read_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
 415         block[0xe1] = 0;
 416         ata_write_sectors(IF_MV2(0,) pinfo->start + 0x3c08, 1, block);
 417     }
 418 #else
 419     (void) disable_rebuild;
 420 #endif
 421
 422     return EOK;
 423 }
 424 #endif
 425
 426 void* main(void)
 427 {
 428     int i;
 429     int btn;
 430     int rc;
 431     int num_partitions;
 432     struct partinfo* pinfo;
 433 #if defined(SANSA_E200) || defined(SANSA_C200)
 434     int usb_retry = 0;
 435     bool usb = false;
 436 #else
 437     char buf[256];
 438     unsigned short* identify_info;
 439 #endif
 440
 441     chksum_crc32gentab ();
 442
 443     system_init();
 444     kernel_init();
 445     lcd_init();
 446     font_init();
 447     button_init();
 448 #if defined(SANSA_E200)
 449     i2c_init();
 450     _backlight_on();
 451 #endif
 452
 453 #if LCD_DEPTH > 1
 454     lcd_set_foreground(LCD_WHITE);
 455     lcd_set_background(LCD_BLACK);
 456 #endif
 457     lcd_clear_display();
 458
 459     if (button_hold())
 460     {
 461         verbose = true;
 462         printf("Hold switch on");
 463         printf("Shutting down...");
 464         sleep(HZ);
 465         power_off();
 466     }
 467
 468     btn = button_read_device();
 469
 470     /* Enable bootloader messages if any button is pressed */
 471     if (btn)
 472         verbose = true;
 473
 474 #if defined(SANSA_E200) || defined(SANSA_C200)
 475 #if !defined(USE_ROCKBOX_USB)
 476     usb_init();
 477     while (usb_drv_powered() && usb_retry < 5 && !usb)
 478     {
 479         usb_retry++;
 480         sleep(HZ/4);
 481         usb = (usb_detect() == USB_INSERTED);
 482     }
 483     if (usb)
 484         btn |= BOOTLOADER_BOOT_OF;
 485 #endif /* USE_ROCKBOX_USB */
 486 #endif
 487
 488     lcd_setfont(FONT_SYSFIXED);
 489
 490     printf("Rockbox boot loader");
 491     printf("Version: %s", version);
 492     printf(MODEL_NAME);
 493
 494     i=ata_init();
 495 #if !defined(SANSA_E200) && !defined(SANSA_C200)
 496     if (i==0) {
 497         identify_info=ata_get_identify();
 498         /* Show model */
 499         for (i=0; i < 20; i++) {
 500             ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
 501         }
 502         buf[40]=0;
 503         for (i=39; i && buf[i]==' '; i--) {
 504             buf[i]=0;
 505         }
 506         printf(buf);
 507     } else {
 508         error(EATA, i);
 509     }
 510 #endif
 511
 512     disk_init(IF_MV(0));
 513     num_partitions = disk_mount_all();
 514     if (num_partitions<=0)
 515     {
 516         error(EDISK,num_partitions);
 517     }
 518
 519     /* Just list the first 2 partitions since we don't have any devices yet
 520        that have more than that */
 521     for(i=0; i<NUM_PARTITIONS; i++)
 522     {
 523         pinfo = disk_partinfo(i);
 524         printf("Partition %d: 0x%02x %ld MB",
 525                 i, pinfo->type, pinfo->size / 2048);
 526     }
 527
 528     if(btn & BOOTLOADER_BOOT_OF)
 529     {
 530         /* Load original mi4 firmware in to a memory buffer called loadbuffer.
 531            The rest of the loading is done in crt0.S.
 532            1) First try reading from the hidden partition (on Sansa only).
 533            2) Next try a decrypted mi4 file in /System/OF.mi4
 534            3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
 535               a mi4 firmware decrypted and header stripped using mi4code.
 536         */
 537         printf("Loading original firmware...");
 538
 539 #if defined(SANSA_E200) || defined(SANSA_C200)
 540         /* First try a (hidden) firmware partition */
 541         printf("Trying firmware partition");
 542         pinfo = disk_partinfo(1);
 543         if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
 544         {
 545             rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
 546             if (rc < EOK) {
 547                 printf("Can't load from partition");
 548                 printf(strerror(rc));
 549             } else {
 550                 return (void*)loadbuffer;
 551             }
 552         } else {
 553             printf("No hidden partition found.");
 554         }
 555 #endif
 556
 557         printf("Trying /System/OF.mi4");
 558         rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
 559         if (rc < EOK) {
 560             printf("Can't load /System/OF.mi4");
 561             printf(strerror(rc));
 562         } else {
 563             return (void*)loadbuffer;
 564         }
 565
 566         printf("Trying /System/OF.bin");
 567         rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
 568         if (rc < EOK) {
 569             printf("Can't load /System/OF.bin");
 570             printf(strerror(rc));
 571         } else {
 572             return (void*)loadbuffer;
 573         }
 574
 575         error(0, 0);
 576
 577     } else {
 578 #if 0 /* e200: enable to be able to dump the hidden partition */
 579         if(btn & BUTTON_UP)
 580         {
 581             int fd;
 582             pinfo = disk_partinfo(1);
 583             fd = open("/part.bin", O_CREAT|O_RDWR);
 584             char sector[512];
 585             for(i=0; i<40960; i++){
 586                 if (!(i%100))
 587                 {
 588                     printf("dumping sector %d", i);
 589                 }
 590                 ata_read_sectors(IF_MV2(0,) pinfo->start + i, 1, sector);
 591                 write(fd,sector,512);
 592             }
 593             close(fd);
 594         }
 595 #endif
 596         printf("Loading Rockbox...");
 597         rc=load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
 598         if (rc < EOK) {
 599             printf("Can't load %s:", BOOTFILE);
 600             printf(strerror(rc));
 601
 602 #ifdef OLD_BOOTFILE
 603             /* Try loading rockbox from old rockbox.e200/rockbox.h10 format */
 604             rc=load_firmware(loadbuffer, OLD_BOOTFILE, MAX_LOADSIZE);
 605             if (rc < EOK) {
 606                 printf("Can't load %s:", OLD_BOOTFILE);
 607                 error(EBOOTFILE, rc);
 608             }
 609 #endif
 610         }
 611     }
 612
 613     return (void*)loadbuffer;
 614 }
 615
 616 #if !defined(SANSA_E200) && !defined(SANSA_C200)
 617 /* These functions are present in the firmware library, but we reimplement
 618    them here because the originals do a lot more than we want */
 619 void usb_acknowledge(void)
 620 {
 621 }
 622
 623 void usb_wait_for_disconnect(void)
 624 {
 625 }
 626 #endif
 627