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 #endif
  74
  75 /* Maximum allowed firmware image size. 10MB is more than enough */
  76 #define MAX_LOADSIZE (10*1024*1024)
  77
  78 /* A buffer to load the original firmware or Rockbox into */
  79 unsigned char *loadbuffer = (unsigned char *)DRAM_START;
  80
  81 /* Bootloader version */
  82 char version[] = APPSVERSION;
  83
  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
  90
  91 #else
  92 #define NUM_PARTITIONS      1
  93
  94 #endif
  95
  96 #define MI4_HEADER_SIZE     0x200
  97
  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];
 111 };
 112
 113 /* PPMI header structure */
 114 struct ppmi_header_t {
 115     unsigned char magic[4];
 116     uint32_t length;
 117     uint32_t pad[126];
 118 };
 119
 120 inline unsigned int le2int(unsigned char* buf)
 121 {
 122    int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
 123
 124    return res;
 125 }
 126
 127 inline void int2le(unsigned int val, unsigned char* addr)
 128 {
 129     addr[0] = val & 0xFF;
 130     addr[1] = (val >> 8) & 0xff;
 131     addr[2] = (val >> 16) & 0xff;
 132     addr[3] = (val >> 24) & 0xff;
 133 }
 134
 135 struct tea_key {
 136   const char * name;
 137   uint32_t     key[4];
 138 };
 139
 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 } },
 159 };
 160
 161 /*
 162
 163 tea_decrypt() from http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
 164
 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:"
 168
 169 */
 170
 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
 173          32.
 174 */
 175
 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 */
 184     }
 185 }
 186
 187 /* mi4 files are encrypted in 64-bit blocks (two little-endian 32-bit
 188    integers) and the key is incremented after each block
 189  */
 190
 191 static void tea_decrypt_buf(unsigned char* src, unsigned char* dest, size_t n, uint32_t * key)
 192 {
 193     uint32_t v0, v1;
 194     unsigned int i;
 195
 196     for (i = 0; i < (n / 8); i++) {
 197         v0 = le2int(src);
 198         v1 = le2int(src+4);
 199
 200         tea_decrypt(&v0, &v1, key);
 201
 202         int2le(v0, dest);
 203         int2le(v1, dest+4);
 204
 205         src += 8;
 206         dest += 8;
 207
 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]++;
 216                 }
 217             }
 218         }
 219     }
 220 }
 221
 222 static inline bool tea_test_key(unsigned char magic_enc[8], uint32_t * key, int unaligned)
 223 {
 224     unsigned char magic_dec[8];
 225     tea_decrypt_buf(magic_enc, magic_dec, 8, key);
 226
 227     return (le2int(&magic_dec[4*unaligned]) == 0xaa55aa55);
 228 }
 229
 230 static int tea_find_key(struct mi4header_t *mi4header, int fd)
 231 {
 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;
 240
 241     if ( (magic_location % 8) != 0 )
 242     {
 243         unaligned = 1;
 244         magic_location -= 4;
 245     }
 246
 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;
 252
 253     printf("Searching for key:");
 254
 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];
 260
 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]++;
 270                     }
 271                 }
 272             }
 273         }
 274
 275         if (tea_test_key(magic_enc,key,unaligned))
 276         {
 277             key_found = i;
 278             printf("%s...found", tea_keytable[i].name);
 279         } else {
 280            /* printf("%s...failed", tea_keytable[i].name); */
 281         }
 282     }
 283
 284     return key_found;
 285 }
 286
 287
 288 /* Load mi4 format firmware image */
 289 int load_mi4(unsigned char* buf, char* firmware, unsigned int buffer_size)
 290 {
 291     int fd;
 292     struct mi4header_t mi4header;
 293     int rc;
 294     unsigned long sum;
 295     char filename[MAX_PATH];
 296
 297     snprintf(filename,sizeof(filename), BOOTDIR "/%s",firmware);
 298     fd = open(filename, O_RDONLY);
 299     if(fd < 0)
 300     {
 301         snprintf(filename,sizeof(filename),"/%s",firmware);
 302         fd = open(filename, O_RDONLY);
 303         if(fd < 0)
 304             return EFILE_NOT_FOUND;
 305     }
 306
 307     read(fd, &mi4header, MI4_HEADER_SIZE);
 308
 309     /* MI4 file size */
 310     printf("mi4 size: %x", mi4header.mi4size);
 311
 312     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 313         return EFILE_TOO_BIG;
 314
 315     /* CRC32 */
 316     printf("CRC32: %x", mi4header.crc32);
 317
 318     /* Rockbox model id */
 319     printf("Model id: %.4s", mi4header.model);
 320
 321     /* Read binary type (RBOS, RBBL) */
 322     printf("Binary type: %.4s", mi4header.type);
 323
 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;
 329
 330     /* Check CRC32 to see if we have a valid file */
 331     sum = chksum_crc32 (buf, mi4header.mi4size - MI4_HEADER_SIZE);
 332
 333     printf("Calculated CRC32: %x", sum);
 334
 335     if(sum != mi4header.crc32)
 336         return EBAD_CHKSUM;
 337
 338     if( (mi4header.plaintext + MI4_HEADER_SIZE) != mi4header.mi4size)
 339     {
 340         /* Load encrypted firmware */
 341         int key_index = tea_find_key(&mi4header, fd);
 342
 343         if (key_index < 0)
 344             return EINVALID_FORMAT;
 345
 346         /* Plaintext part is already loaded */
 347         buf += mi4header.plaintext;
 348
 349         /* Decrypt in-place */
 350         tea_decrypt_buf(buf, buf,
 351                         mi4header.mi4size-(mi4header.plaintext+MI4_HEADER_SIZE),
 352                         tea_keytable[key_index].key);
 353
 354         printf("%s key used", tea_keytable[key_index].name);
 355
 356         /* Check decryption was successfull */
 357         if(le2int(&buf[mi4header.length-mi4header.plaintext-4]) != 0xaa55aa55)
 358         {
 359             return EREAD_IMAGE_FAILED;
 360         }
 361     }
 362
 363     return EOK;
 364 }
 365
 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)
 370 {
 371     struct mi4header_t mi4header;
 372     struct ppmi_header_t ppmi_header;
 373     unsigned long sum;
 374
 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);
 378
 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;
 382
 383     printf("BL mi4 size: %x", ppmi_header.length);
 384
 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);
 388
 389     /* We don't support encrypted mi4 files yet */
 390     if( (mi4header.plaintext) != (mi4header.mi4size-MI4_HEADER_SIZE))
 391         return EINVALID_FORMAT;
 392
 393     /* MI4 file size */
 394     printf("OF mi4 size: %x", mi4header.mi4size);
 395
 396     if ((mi4header.mi4size-MI4_HEADER_SIZE) > buffer_size)
 397         return EFILE_TOO_BIG;
 398
 399     /* CRC32 */
 400     printf("CRC32: %x", mi4header.crc32);
 401
 402     /* Rockbox model id */
 403     printf("Model id: %.4s", mi4header.model);
 404
 405     /* Read binary type (RBOS, RBBL) */
 406     printf("Binary type: %.4s", mi4header.type);
 407
 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);
 412
 413     /* Check CRC32 to see if we have a valid file */
 414     sum = chksum_crc32 (buf,mi4header.mi4size-MI4_HEADER_SIZE);
 415
 416     printf("Calculated CRC32: %x", sum);
 417
 418     if(sum != mi4header.crc32)
 419         return EBAD_CHKSUM;
 420
 421 #ifdef SANSA_E200
 422     if (disable_rebuild)
 423     {
 424         char block[512];
 425
 426         printf("Disabling database rebuild");
 427
 428         storage_read_sectors(0, pinfo->start + 0x3c08, 1, block);
 429         block[0xe1] = 0;
 430         storage_write_sectors(0, pinfo->start + 0x3c08, 1, block);
 431     }
 432 #else
 433     (void) disable_rebuild;
 434 #endif
 435
 436     return EOK;
 437 }
 438 #endif
 439
 440 void* main(void)
 441 {
 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 #if !defined(USE_ROCKBOX_USB)
 449     int usb_retry = 0;
 450 #endif
 451     bool usb = false;
 452 #else
 453     char buf[256];
 454     unsigned short* identify_info;
 455 #endif
 456
 457     chksum_crc32gentab ();
 458
 459     system_init();
 460     kernel_init();
 461
 462     lcd_init();
 463
 464     font_init();
 465     show_logo();
 466
 467     adc_init();
 468     button_init();
 469 #if defined(SANSA_E200) || defined(PHILIPS_SA9200)
 470     i2c_init();
 471     _backlight_on();
 472 #endif
 473
 474     if (button_hold())
 475     {
 476         verbose = true;
 477         lcd_clear_display();
 478         printf("Hold switch on");
 479         printf("Shutting down...");
 480         sleep(HZ);
 481         power_off();
 482     }
 483
 484     btn = button_read_device();
 485
 486     /* Enable bootloader messages if any button is pressed */
 487     if (btn) {
 488         lcd_clear_display();
 489         verbose = true;
 490     }
 491
 492 #if defined(SANSA_E200) || defined(SANSA_C200) || defined(PHILIPS_SA9200)
 493 #if !defined(USE_ROCKBOX_USB)
 494     usb_init();
 495     while (usb_drv_powered() && usb_retry < 5 && !usb)
 496     {
 497         usb_retry++;
 498         sleep(HZ/4);
 499         usb = (usb_detect() == USB_INSERTED);
 500     }
 501     if (usb)
 502         btn |= BOOTLOADER_BOOT_OF;
 503 #endif /* USE_ROCKBOX_USB */
 504 #endif
 505
 506     lcd_setfont(FONT_SYSFIXED);
 507
 508     printf("Rockbox boot loader");
 509     printf("Version: %s", version);
 510     printf(MODEL_NAME);
 511
 512     i=storage_init();
 513 #if !(CONFIG_STORAGE & STORAGE_SD)
 514     if (i==0) {
 515         identify_info=ata_get_identify();
 516         /* Show model */
 517         for (i=0; i < 20; i++) {
 518             ((unsigned short*)buf)[i]=htobe16(identify_info[i+27]);
 519         }
 520         buf[40]=0;
 521         for (i=39; i && buf[i]==' '; i--) {
 522             buf[i]=0;
 523         }
 524         printf(buf);
 525     } else {
 526         error(EATA, i);
 527     }
 528 #endif
 529
 530     disk_init(IF_MV(0));
 531     num_partitions = disk_mount_all();
 532     if (num_partitions<=0)
 533     {
 534         error(EDISK,num_partitions);
 535     }
 536
 537     /* Just list the first 2 partitions since we don't have any devices yet
 538        that have more than that */
 539     for(i=0; i<NUM_PARTITIONS; i++)
 540     {
 541         pinfo = disk_partinfo(i);
 542         printf("Partition %d: 0x%02x %ld MB",
 543                 i, pinfo->type, pinfo->size / 2048);
 544     }
 545
 546     /* Try loading Rockbox, if that fails, fall back to the OF */
 547     if((btn & BOOTLOADER_BOOT_OF) == 0)
 548     {
 549         printf("Loading Rockbox...");
 550         rc = load_mi4(loadbuffer, BOOTFILE, MAX_LOADSIZE);
 551         if (rc < EOK)
 552         {
 553             bool old_verbose = verbose;
 554             verbose = true;
 555             printf("Can't load " BOOTFILE ": ");
 556             printf(strerror(rc));
 557             verbose = old_verbose;
 558             btn |= BOOTLOADER_BOOT_OF;
 559             sleep(5*HZ);
 560         }
 561         else
 562             return (void*)loadbuffer;
 563     }
 564
 565     if(btn & BOOTLOADER_BOOT_OF)
 566     {
 567         /* Load original mi4 firmware in to a memory buffer called loadbuffer.
 568            The rest of the loading is done in crt0.S.
 569            1) First try reading from the hidden partition (on Sansa only).
 570            2) Next try a decrypted mi4 file in /System/OF.mi4
 571            3) Finally, try a raw firmware binary in /System/OF.mi4. It should be
 572               a mi4 firmware decrypted and header stripped using mi4code.
 573         */
 574         printf("Loading original firmware...");
 575
 576 #if (CONFIG_STORAGE & STORAGE_SD)
 577         /* First try a (hidden) firmware partition */
 578         printf("Trying firmware partition");
 579         pinfo = disk_partinfo(1);
 580         if(pinfo->type == PARTITION_TYPE_OS2_HIDDEN_C_DRIVE)
 581         {
 582             rc = load_mi4_part(loadbuffer, pinfo, MAX_LOADSIZE, usb);
 583             if (rc < EOK) {
 584                 printf("Can't load from partition");
 585                 printf(strerror(rc));
 586             } else {
 587                 return (void*)loadbuffer;
 588             }
 589         } else {
 590             printf("No hidden partition found.");
 591         }
 592 #endif
 593
 594 #if defined(PHILIPS_HDD1630)
 595         printf("Trying /System/OF.ebn");
 596         rc=load_mi4(loadbuffer, "/System/OF.ebn", MAX_LOADSIZE);
 597         if (rc < EOK) {
 598             printf("Can't load /System/OF.ebn");
 599             printf(strerror(rc));
 600         } else {
 601             return (void*)loadbuffer;
 602         }
 603 #endif
 604
 605         printf("Trying /System/OF.mi4");
 606         rc=load_mi4(loadbuffer, "/System/OF.mi4", MAX_LOADSIZE);
 607         if (rc < EOK) {
 608             printf("Can't load /System/OF.mi4");
 609             printf(strerror(rc));
 610         } else {
 611             return (void*)loadbuffer;
 612         }
 613
 614         printf("Trying /System/OF.bin");
 615         rc=load_raw_firmware(loadbuffer, "/System/OF.bin", MAX_LOADSIZE);
 616         if (rc < EOK) {
 617             printf("Can't load /System/OF.bin");
 618             printf(strerror(rc));
 619         } else {
 620             return (void*)loadbuffer;
 621         }
 622
 623         error(0, 0);
 624     }
 625     return (void*)loadbuffer;
 626 }