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