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