firmware/rolo.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Randy D. Wood
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #include "config.h"
  23 #include "lcd.h"
  24 #include "lcd-remote.h"
  25 #include "thread.h"
  26 #include "kernel.h"
  27 #include "sprintf.h"
  28 #include "button.h"
  29 #include "file.h"
  30 #include "audio.h"
  31 #include "system.h"
  32 #include "i2c.h"
  33 #include "adc.h"
  34 #include "string.h"
  35 #include "buffer.h"
  36 #include "storage.h"
  37 #include "rolo.h"
  38
  39 #ifdef MI4_FORMAT
  40 #include "crc32-mi4.h"
  41 #undef FIRMWARE_OFFSET_FILE_CRC
  42 #undef FIRMWARE_OFFSET_FILE_DATA
  43 #define FIRMWARE_OFFSET_FILE_CRC     0xC
  44 #define FIRMWARE_OFFSET_FILE_DATA    0x200
  45 #endif
  46
  47 #if !defined(IRIVER_IFP7XX_SERIES)
  48 /* FIX: this doesn't work on iFP */
  49
  50 #define IRQ0_EDGE_TRIGGER 0x80
  51
  52 #ifdef CPU_PP
  53 /* Handle the COP properly - it needs to jump to a function outside SDRAM while
  54  * the new firmware is being loaded, and then jump to the start of SDRAM
  55  * TODO: Use the mailboxes built into the PP processor for this
  56  */
  57
  58 #if NUM_CORES > 1
  59 volatile unsigned char IDATA_ATTR cpu_message = 0;
  60 volatile unsigned char IDATA_ATTR cpu_reply = 0;
  61 extern int cop_idlestackbegin[];
  62
  63 void rolo_restart_cop(void) ICODE_ATTR;
  64 void rolo_restart_cop(void)
  65 {
  66     if (CURRENT_CORE == CPU)
  67     {
  68         /* There should be free thread slots aplenty */
  69         create_thread(rolo_restart_cop, cop_idlestackbegin, IDLE_STACK_SIZE,
  70                       0, "rolo COP" IF_PRIO(, PRIORITY_REALTIME)
  71                       IF_COP(, COP));
  72         return;
  73     }
  74
  75     COP_INT_DIS = -1;
  76
  77     /* Invalidate cache */
  78     cpucache_invalidate();
  79
  80     /* Disable cache */
  81     CACHE_CTL = CACHE_CTL_DISABLE;
  82
  83     /* Tell the main core that we're ready to reload */
  84     cpu_reply = 1;
  85
  86     /* Wait while RoLo loads the image into SDRAM */
  87     /* TODO: Accept checksum failure gracefully */
  88     while(cpu_message != 1);
  89
  90     /* Acknowledge the CPU and then reload */
  91     cpu_reply = 2;
  92
  93     asm volatile(
  94         "mov   r0, %0   \n"
  95         "mov   pc, r0   \n"
  96         : : "I"(DRAM_START)
  97     );
  98 }
  99 #endif /* NUM_CORES > 1 */
 100 #endif /* CPU_PP */
 101
 102 static void rolo_error(const char *text)
 103 {
 104     lcd_clear_display();
 105     lcd_puts(0, 0, "ROLO error:");
 106     lcd_puts_scroll(0, 1, text);
 107     lcd_update();
 108     button_get(true);
 109     button_get(true);
 110     button_get(true);
 111     lcd_stop_scroll();
 112 }
 113
 114 #if CONFIG_CPU == SH7034 || CONFIG_CPU == IMX31L
 115 /* these are in assembler file "descramble.S" for SH7034 */
 116 extern unsigned short descramble(const unsigned char* source,
 117                                  unsigned char* dest, int length);
 118 /* this is in firmware/target/arm/imx31/rolo_restart.S for IMX31 */
 119 extern void rolo_restart(const unsigned char* source, unsigned char* dest,
 120                          int length);
 121 #else
 122
 123 /* explicitly put this code in iram, ICODE_ATTR is defined to be null for some
 124    targets that are low on iram, like the gigabeat F/X */
 125 void rolo_restart(const unsigned char* source, unsigned char* dest,
 126                   long length) __attribute__ ((section(".icode")));
 127 void rolo_restart(const unsigned char* source, unsigned char* dest,
 128                   long length)
 129 {
 130     long i;
 131     unsigned char* localdest = dest;
 132
 133     /* This is the equivalent of a call to memcpy() but this must be done from
 134        iram to avoid overwriting itself and we don't want to depend on memcpy()
 135        always being in iram */
 136     for(i = 0;i < length;i++)
 137         *localdest++ = *source++;
 138
 139 #if defined(CPU_COLDFIRE)
 140     asm (
 141         "movec.l %0,%%vbr    \n"
 142         "move.l  (%0)+,%%sp  \n"
 143         "move.l  (%0),%0     \n"
 144         "jmp     (%0)        \n"
 145         : : "a"(dest)
 146     );
 147 #elif defined(CPU_PP)
 148     CPU_INT_DIS = -1;
 149
 150     /* Flush cache */
 151     cpucache_flush();
 152
 153     /* Disable cache */
 154     CACHE_CTL = CACHE_CTL_DISABLE;
 155
 156     /* Reset the memory mapping registers to zero */
 157     {
 158         volatile unsigned long *mmap_reg;
 159         for (mmap_reg = &MMAP_FIRST; mmap_reg <= &MMAP_LAST; mmap_reg++)
 160             *mmap_reg = 0;
 161     }
 162
 163 #if NUM_CORES > 1
 164     /* Tell the COP it's safe to continue rebooting */
 165     cpu_message = 1;
 166
 167     /* Wait for the COP to tell us it is rebooting */
 168     while(cpu_reply != 2);
 169 #endif
 170
 171     asm volatile(
 172         "mov   r0, %0   \n"
 173         "mov   pc, r0   \n"
 174         : : "I"(DRAM_START)
 175     );
 176
 177 #elif defined(CPU_ARM)
 178 #ifdef HAVE_CPUCACHE_INVALIDATE
 179     /* Flush and invalidate caches */
 180     cpucache_invalidate();
 181 #endif
 182     asm volatile(
 183         "mov   pc, %0            \n"
 184         : : "r"(dest)
 185     );
 186 #elif defined(CPU_MIPS)
 187     __dcache_writeback_all();
 188     asm volatile(
 189         "jr     %0               \n"
 190         : : "r"(dest)
 191     );
 192 #endif
 193 }
 194 #endif
 195
 196 /* This is assigned in the linker control file */
 197 extern unsigned long loadaddress;
 198
 199 /***************************************************************************
 200  *
 201  * Name: rolo_load_app(char *filename,int scrambled)
 202  * Filename must be a fully defined filename including the path and extension
 203  *
 204  ***************************************************************************/
 205 int rolo_load(const char* filename)
 206 {
 207     int fd;
 208     long length;
 209 #if defined(CPU_COLDFIRE) || defined(CPU_ARM) || defined(CPU_MIPS)
 210 #if !defined(MI4_FORMAT)
 211     int i;
 212 #endif
 213     unsigned long checksum,file_checksum;
 214 #else
 215     long file_length;
 216     unsigned short checksum,file_checksum;
 217 #endif
 218     unsigned char* ramstart = (void*)&loadaddress;
 219
 220     lcd_clear_display();
 221     lcd_puts(0, 0, "ROLO...");
 222     lcd_puts(0, 1, "Loading");
 223     lcd_update();
 224 #ifdef HAVE_REMOTE_LCD
 225     lcd_remote_clear_display();
 226     lcd_remote_puts(0, 0, "ROLO...");
 227     lcd_remote_puts(0, 1, "Loading");
 228     lcd_remote_update();
 229 #endif
 230
 231     audio_stop();
 232
 233     fd = open(filename, O_RDONLY);
 234     if(-1 == fd) {
 235         rolo_error("File not found");
 236         return -1;
 237     }
 238
 239     length = filesize(fd) - FIRMWARE_OFFSET_FILE_DATA;
 240
 241 #if CONFIG_CPU != SH7034
 242     /* Read and save checksum */
 243     lseek(fd, FIRMWARE_OFFSET_FILE_CRC, SEEK_SET);
 244     if (read(fd, &file_checksum, 4) != 4) {
 245         rolo_error("Error Reading checksum");
 246         return -1;
 247     }
 248
 249 #if !defined(MI4_FORMAT)
 250     /* Rockbox checksums are big-endian */
 251     file_checksum = betoh32(file_checksum);
 252 #endif
 253
 254 #if defined(CPU_PP) && NUM_CORES > 1
 255     lcd_puts(0, 2, "Waiting for coprocessor...");
 256     lcd_update();
 257     rolo_restart_cop();
 258     /* Wait for COP to be in safe code */
 259     while(cpu_reply != 1);
 260     lcd_puts(0, 2, "                          ");
 261     lcd_update();
 262 #endif
 263
 264     lseek(fd, FIRMWARE_OFFSET_FILE_DATA, SEEK_SET);
 265
 266     if (read(fd, audiobuf, length) != length) {
 267         rolo_error("Error Reading File");
 268         return -1;
 269     }
 270
 271 #ifdef MI4_FORMAT
 272     /* Check CRC32 to see if we have a valid file */
 273     chksum_crc32gentab();
 274     checksum = chksum_crc32 (audiobuf, length);
 275 #else
 276     checksum = MODEL_NUMBER;
 277
 278     for(i = 0;i < length;i++) {
 279         checksum += audiobuf[i];
 280     }
 281 #endif
 282
 283     /* Verify checksum against file header */
 284     if (checksum != file_checksum) {
 285         rolo_error("Checksum Error");
 286         return -1;
 287     }
 288
 289     lcd_puts(0, 1, "Executing");
 290     lcd_update();
 291 #ifdef HAVE_REMOTE_LCD
 292     lcd_remote_puts(0, 1, "Executing");
 293     lcd_remote_update();
 294 #endif
 295     adc_close();
 296 #ifdef HAVE_STORAGE_FLUSH
 297     storage_flush();
 298 #endif
 299
 300 #ifdef CPU_ARM
 301     /* Should do these together since some ARM version should never have
 302      * FIQ disabled and not IRQ (imx31 errata). */
 303     disable_interrupt(IRQ_FIQ_STATUS);
 304 #else
 305     /* Some targets have a higher disable level than HIGEST_IRQ_LEVEL */
 306     set_irq_level(DISABLE_INTERRUPTS);
 307 #endif
 308
 309 #else /* CONFIG_CPU == SH7034 */
 310     /* Read file length from header and compare to real file length */
 311     lseek(fd, FIRMWARE_OFFSET_FILE_LENGTH, SEEK_SET);
 312     if(read(fd, &file_length, 4) != 4) {
 313         rolo_error("Error Reading File Length");
 314         return -1;
 315     }
 316     if (length != file_length) {
 317         rolo_error("File length mismatch");
 318         return -1;
 319     }
 320
 321     /* Read and save checksum */
 322     lseek(fd, FIRMWARE_OFFSET_FILE_CRC, SEEK_SET);
 323     if (read(fd, &file_checksum, 2) != 2) {
 324         rolo_error("Error Reading checksum");
 325         return -1;
 326     }
 327     lseek(fd, FIRMWARE_OFFSET_FILE_DATA, SEEK_SET);
 328
 329     /* verify that file can be read and descrambled */
 330     if ((audiobuf + (2*length)+4) >= audiobufend) {
 331         rolo_error("Not enough room to load file");
 332         return -1;
 333     }
 334
 335     if (read(fd, &audiobuf[length], length) != (int)length) {
 336         rolo_error("Error Reading File");
 337         return -1;
 338     }
 339
 340     lcd_puts(0, 1, "Descramble");
 341     lcd_update();
 342
 343     checksum = descramble(audiobuf + length, audiobuf, length);
 344
 345     /* Verify checksum against file header */
 346     if (checksum != file_checksum) {
 347         rolo_error("Checksum Error");
 348         return -1;
 349     }
 350
 351     lcd_puts(0, 1, "Executing     ");
 352     lcd_update();
 353
 354 #ifdef HAVE_STORAGE_FLUSH
 355     storage_flush();
 356 #endif
 357
 358     set_irq_level(HIGHEST_IRQ_LEVEL);
 359
 360     /* Calling these 2 initialization routines was necessary to get the
 361        the origional Archos version of the firmware to load and execute. */
 362     system_init();           /* Initialize system for restart */
 363     i2c_init();              /* Init i2c bus - it seems like a good idea */
 364     ICR = IRQ0_EDGE_TRIGGER; /* Make IRQ0 edge triggered */
 365     TSTR = 0xE0;             /* disable all timers */
 366     /* model-specific de-init, needed when flashed */
 367     /* Especially the Archos software is picky about this */
 368 #if defined(ARCHOS_RECORDER) || defined(ARCHOS_RECORDERV2) || \
 369     defined(ARCHOS_FMRECORDER)
 370     PAIOR = 0x0FA0;
 371 #endif
 372 #endif
 373     rolo_restart(audiobuf, ramstart, length);
 374
 375     return 0; /* this is never reached */
 376     (void)checksum; (void)file_checksum;
 377 }
 378 #else  /* !defined(IRIVER_IFP7XX_SERIES) */
 379 int rolo_load(const char* filename)
 380 {
 381     /* dummy */
 382     (void)filename;
 383     return 0;
 384 }
 385
 386 #endif /* !defined(IRIVER_IFP7XX_SERIES) */