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