board/mcc200/auto_update.c

   1 /*
   2  * (C) Copyright 2006
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  18  * MA 02111-1307 USA
  19  */
  20 #include <common.h>
  21 #include <command.h>
  22 #include <malloc.h>
  23 #include <image.h>
  24 #include <asm/byteorder.h>
  25 #include <usb.h>
  26
  27 #ifdef CFG_HUSH_PARSER
  28 #include <hush.h>
  29 #endif
  30
  31
  32 #ifdef CONFIG_AUTO_UPDATE
  33
  34 #ifndef CONFIG_USB_OHCI
  35 #error "must define CONFIG_USB_OHCI"
  36 #endif
  37
  38 #ifndef CONFIG_USB_STORAGE
  39 #error "must define CONFIG_USB_STORAGE"
  40 #endif
  41
  42 #ifndef CFG_HUSH_PARSER
  43 #error "must define CFG_HUSH_PARSER"
  44 #endif
  45
  46 #if !(CONFIG_COMMANDS & CFG_CMD_FAT)
  47 #error "must define CFG_CMD_FAT"
  48 #endif
  49
  50 #undef AU_DEBUG
  51
  52 #undef debug
  53 #ifdef  AU_DEBUG
  54 #define debug(fmt,args...)      printf (fmt ,##args)
  55 #else
  56 #define debug(fmt,args...)
  57 #endif  /* AU_DEBUG */
  58
  59 /* possible names of files on the USB stick. */
  60 #define AU_FIRMWARE     "u-boot.img"
  61 #define AU_KERNEL       "kernel.img"
  62 #define AU_ROOTFS       "rootfs.img"
  63
  64 struct flash_layout {
  65         long start;
  66         long end;
  67 };
  68
  69 /* layout of the FLASH. ST = start address, ND = end address. */
  70 #define AU_FL_FIRMWARE_ST       0xfC000000
  71 #define AU_FL_FIRMWARE_ND       0xfC03FFFF
  72 #define AU_FL_KERNEL_ST         0xfC0C0000
  73 #define AU_FL_KERNEL_ND         0xfC1BFFFF
  74 #define AU_FL_ROOTFS_ST         0xFC1C0000
  75 #define AU_FL_ROOTFS_ND         0xFCFBFFFF
  76
  77 static int au_usb_stor_curr_dev; /* current device */
  78
  79 /* index of each file in the following arrays */
  80 #define IDX_FIRMWARE    0
  81 #define IDX_KERNEL      1
  82 #define IDX_ROOTFS      2
  83
  84 /* max. number of files which could interest us */
  85 #define AU_MAXFILES 3
  86
  87 /* pointers to file names */
  88 char *aufile[AU_MAXFILES] = {
  89         AU_FIRMWARE,
  90         AU_KERNEL,
  91         AU_ROOTFS
  92 };
  93
  94 /* sizes of flash areas for each file */
  95 long ausize[AU_MAXFILES] = {
  96         (AU_FL_FIRMWARE_ND + 1) - AU_FL_FIRMWARE_ST,
  97         (AU_FL_KERNEL_ND   + 1) - AU_FL_KERNEL_ST,
  98         (AU_FL_ROOTFS_ND   + 1) - AU_FL_ROOTFS_ST,
  99 };
 100
 101 /* array of flash areas start and end addresses */
 102 struct flash_layout aufl_layout[AU_MAXFILES] = {
 103         { AU_FL_FIRMWARE_ST,    AU_FL_FIRMWARE_ND, },
 104         { AU_FL_KERNEL_ST,      AU_FL_KERNEL_ND,   },
 105         { AU_FL_ROOTFS_ST,      AU_FL_ROOTFS_ND,   },
 106 };
 107
 108 /* where to load files into memory */
 109 #define LOAD_ADDR ((unsigned char *)0x00200000)
 110
 111 /* the root file system is the largest image */
 112 #define MAX_LOADSZ ausize[IDX_ROOTFS]
 113
 114 /*i2c address of the keypad status*/
 115 #define I2C_PSOC_KEYPAD_ADDR    0x53
 116
 117 /* keypad mask */
 118 #define KEYPAD_ROW      2
 119 #define KEYPAD_COL      2
 120 #define KEYPAD_MASK_LO  ((1<<(KEYPAD_COL-1+(KEYPAD_ROW*3-3)))&0xFF)
 121 #define KEYPAD_MASK_HI  ((1<<(KEYPAD_COL-1+(KEYPAD_ROW*3-3)))>>8)
 122
 123 /* externals */
 124 extern int fat_register_device(block_dev_desc_t *, int);
 125 extern int file_fat_detectfs(void);
 126 extern long file_fat_read(const char *, void *, unsigned long);
 127 extern int i2c_read (unsigned char, unsigned int, int , unsigned char* , int);
 128 extern int flash_sect_erase(ulong, ulong);
 129 extern int flash_sect_protect (int, ulong, ulong);
 130 extern int flash_write (char *, ulong, ulong);
 131 /* change char* to void* to shutup the compiler */
 132 extern block_dev_desc_t *get_dev (char*, int);
 133 extern int u_boot_hush_start(void);
 134
 135 int au_check_cksum_valid(int idx, long nbytes)
 136 {
 137         image_header_t *hdr;
 138         unsigned long checksum;
 139
 140         hdr = (image_header_t *)LOAD_ADDR;
 141
 142         if (nbytes != (sizeof(*hdr) + ntohl(hdr->ih_size))) {
 143                 printf ("Image %s bad total SIZE\n", aufile[idx]);
 144                 return -1;
 145         }
 146         /* check the data CRC */
 147         checksum = ntohl(hdr->ih_dcrc);
 148
 149         if (crc32 (0, (uchar *)(LOAD_ADDR + sizeof(*hdr)), ntohl(hdr->ih_size)) != checksum) {
 150                 printf ("Image %s bad data checksum\n", aufile[idx]);
 151                 return -1;
 152         }
 153         return 0;
 154 }
 155
 156 int au_check_header_valid(int idx, long nbytes)
 157 {
 158         image_header_t *hdr;
 159         unsigned long checksum;
 160
 161         hdr = (image_header_t *)LOAD_ADDR;
 162         /* check the easy ones first */
 163 #undef CHECK_VALID_DEBUG
 164 #ifdef CHECK_VALID_DEBUG
 165         printf("magic %#x %#x ", ntohl(hdr->ih_magic), IH_MAGIC);
 166         printf("arch %#x %#x ", hdr->ih_arch, IH_CPU_ARM);
 167         printf("size %#x %#lx ", ntohl(hdr->ih_size), nbytes);
 168         printf("type %#x %#x ", hdr->ih_type, IH_TYPE_KERNEL);
 169 #endif
 170         if (nbytes < sizeof(*hdr)) {
 171                 printf ("Image %s bad header SIZE\n", aufile[idx]);
 172                 return -1;
 173         }
 174         if (ntohl(hdr->ih_magic) != IH_MAGIC || hdr->ih_arch != IH_CPU_PPC) {
 175                 printf ("Image %s bad MAGIC or ARCH\n", aufile[idx]);
 176                 return -1;
 177         }
 178         /* check the hdr CRC */
 179         checksum = ntohl(hdr->ih_hcrc);
 180         hdr->ih_hcrc = 0;
 181
 182         if (crc32 (0, (uchar *)hdr, sizeof(*hdr)) != checksum) {
 183                 printf ("Image %s bad header checksum\n", aufile[idx]);
 184                 return -1;
 185         }
 186         hdr->ih_hcrc = htonl(checksum);
 187         /* check the type - could do this all in one gigantic if() */
 188         if ((idx == IDX_FIRMWARE) && (hdr->ih_type != IH_TYPE_FIRMWARE)) {
 189                 printf ("Image %s wrong type\n", aufile[idx]);
 190                 return -1;
 191         }
 192         if ((idx == IDX_KERNEL) && (hdr->ih_type != IH_TYPE_KERNEL)) {
 193                 printf ("Image %s wrong type\n", aufile[idx]);
 194                 return -1;
 195         }
 196         if ((idx == IDX_ROOTFS) &&
 197                 ( (hdr->ih_type != IH_TYPE_RAMDISK) || (hdr->ih_type != IH_TYPE_FILESYSTEM) )
 198            ) {
 199                 printf ("Image %s wrong type\n", aufile[idx]);
 200                 return -1;
 201         }
 202         /* recycle checksum */
 203         checksum = ntohl(hdr->ih_size);
 204         /* for kernel and app the image header must also fit into flash */
 205         if (idx != IDX_FIRMWARE)
 206                 checksum += sizeof(*hdr);
 207         /* check the size does not exceed space in flash. HUSH scripts */
 208         /* all have ausize[] set to 0 */
 209         if ((ausize[idx] != 0) && (ausize[idx] < checksum)) {
 210                 printf ("Image %s is bigger than FLASH\n", aufile[idx]);
 211                 return -1;
 212         }
 213         return 0;
 214 }
 215
 216 int au_do_update(int idx, long sz)
 217 {
 218         image_header_t *hdr;
 219         char *addr;
 220         long start, end;
 221         int off, rc;
 222         uint nbytes;
 223
 224         hdr = (image_header_t *)LOAD_ADDR;
 225
 226         /* execute a script */
 227         if (hdr->ih_type == IH_TYPE_SCRIPT) {
 228                 addr = (char *)((char *)hdr + sizeof(*hdr));
 229                 /* stick a NULL at the end of the script, otherwise */
 230                 /* parse_string_outer() runs off the end. */
 231                 addr[ntohl(hdr->ih_size)] = 0;
 232                 addr += 8;
 233                 parse_string_outer(addr, FLAG_PARSE_SEMICOLON);
 234                 return 0;
 235         }
 236
 237         start = aufl_layout[idx].start;
 238         end = aufl_layout[idx].end;
 239
 240         /* unprotect the address range */
 241         /* this assumes that ONLY the firmware is protected! */
 242         if (idx == IDX_FIRMWARE) {
 243 #undef AU_UPDATE_TEST
 244 #ifdef AU_UPDATE_TEST
 245                 /* erase it where Linux goes */
 246                 start = aufl_layout[1].start;
 247                 end = aufl_layout[1].end;
 248 #endif
 249                 flash_sect_protect(0, start, end);
 250         }
 251
 252         /*
 253          * erase the address range.
 254          */
 255         debug ("flash_sect_erase(%lx, %lx);\n", start, end);
 256         flash_sect_erase(start, end);
 257         wait_ms(100);
 258         /* strip the header - except for the kernel and ramdisk */
 259         if (hdr->ih_type == IH_TYPE_KERNEL || hdr->ih_type == IH_TYPE_RAMDISK) {
 260                 addr = (char *)hdr;
 261                 off = sizeof(*hdr);
 262                 nbytes = sizeof(*hdr) + ntohl(hdr->ih_size);
 263         } else {
 264                 addr = (char *)((char *)hdr + sizeof(*hdr));
 265 #ifdef AU_UPDATE_TEST
 266                 /* copy it to where Linux goes */
 267                 if (idx == IDX_FIRMWARE)
 268                         start = aufl_layout[1].start;
 269 #endif
 270                 off = 0;
 271                 nbytes = ntohl(hdr->ih_size);
 272         }
 273
 274         /* copy the data from RAM to FLASH */
 275         debug ("flash_write(%p, %lx %x)\n", addr, start, nbytes);
 276         rc = flash_write(addr, start, nbytes);
 277         if (rc != 0) {
 278                 printf("Flashing failed due to error %d\n", rc);
 279                 return -1;
 280         }
 281
 282         /* check the data CRC of the copy */
 283         if (crc32 (0, (uchar *)(start + off), ntohl(hdr->ih_size)) != ntohl(hdr->ih_dcrc)) {
 284                 printf ("Image %s Bad Data Checksum after COPY\n", aufile[idx]);
 285                 return -1;
 286         }
 287
 288         /* protect the address range */
 289         /* this assumes that ONLY the firmware is protected! */
 290         if (idx == IDX_FIRMWARE)
 291                 flash_sect_protect(1, start, end);
 292         return 0;
 293 }
 294
 295 /*
 296  * this is called from board_init() after the hardware has been set up
 297  * and is usable. That seems like a good time to do this.
 298  * Right now the return value is ignored.
 299  */
 300 int do_auto_update(void)
 301 {
 302         block_dev_desc_t *stor_dev;
 303         long sz;
 304         int i, res, bitmap_first, cnt, old_ctrlc, got_ctrlc;
 305         char *env;
 306         long start, end;
 307         uchar keypad_status1[2] = {0,0}, keypad_status2[2] = {0,0};
 308
 309         /*
 310          * Read keypad status
 311          */
 312         i2c_read(I2C_PSOC_KEYPAD_ADDR, 0, 0, keypad_status1, 2);
 313         wait_ms(500);
 314         i2c_read(I2C_PSOC_KEYPAD_ADDR, 0, 0, keypad_status2, 2);
 315
 316         /*
 317          * Check keypad
 318          */
 319         if ( !(keypad_status1[1] & KEYPAD_MASK_LO) ||
 320               (keypad_status1[1] != keypad_status2[1])) {
 321                 return 0;
 322         }
 323         au_usb_stor_curr_dev = -1;
 324         /* start USB */
 325         if (usb_stop() < 0) {
 326                 debug ("usb_stop failed\n");
 327                 return -1;
 328         }
 329         if (usb_init() < 0) {
 330                 debug ("usb_init failed\n");
 331                 return -1;
 332         }
 333         /*
 334          * check whether a storage device is attached (assume that it's
 335          * a USB memory stick, since nothing else should be attached).
 336          */
 337         au_usb_stor_curr_dev = usb_stor_scan(0);
 338         if (au_usb_stor_curr_dev == -1) {
 339                 debug ("No device found. Not initialized?\n");
 340                 return -1;
 341         }
 342         /* check whether it has a partition table */
 343         stor_dev = get_dev("usb", 0);
 344         if (stor_dev == NULL) {
 345                 debug ("uknown device type\n");
 346                 return -1;
 347         }
 348         if (fat_register_device(stor_dev, 1) != 0) {
 349                 debug ("Unable to use USB %d:%d for fatls\n",
 350                         au_usb_stor_curr_dev, 1);
 351                 return -1;
 352         }
 353         if (file_fat_detectfs() != 0) {
 354                 debug ("file_fat_detectfs failed\n");
 355         }
 356
 357         /*
 358          * now check whether start and end are defined using environment
 359          * variables.
 360          */
 361         start = -1;
 362         end = 0;
 363         env = getenv("firmware_st");
 364         if (env != NULL)
 365                 start = simple_strtoul(env, NULL, 16);
 366         env = getenv("firmware_nd");
 367         if (env != NULL)
 368                 end = simple_strtoul(env, NULL, 16);
 369         if (start >= 0 && end && end > start) {
 370                 ausize[IDX_FIRMWARE] = (end + 1) - start;
 371                 aufl_layout[IDX_FIRMWARE].start = start;
 372                 aufl_layout[IDX_FIRMWARE].end = end;
 373         }
 374         start = -1;
 375         end = 0;
 376         env = getenv("kernel_st");
 377         if (env != NULL)
 378                 start = simple_strtoul(env, NULL, 16);
 379         env = getenv("kernel_nd");
 380         if (env != NULL)
 381                 end = simple_strtoul(env, NULL, 16);
 382         if (start >= 0 && end && end > start) {
 383                 ausize[IDX_KERNEL] = (end + 1) - start;
 384                 aufl_layout[IDX_KERNEL].start = start;
 385                 aufl_layout[IDX_KERNEL].end = end;
 386         }
 387         start = -1;
 388         end = 0;
 389         env = getenv("rootfs_st");
 390         if (env != NULL)
 391                 start = simple_strtoul(env, NULL, 16);
 392         env = getenv("rootfs_nd");
 393         if (env != NULL)
 394                 end = simple_strtoul(env, NULL, 16);
 395         if (start >= 0 && end && end > start) {
 396                 ausize[IDX_ROOTFS] = (end + 1) - start;
 397                 aufl_layout[IDX_ROOTFS].start = start;
 398                 aufl_layout[IDX_ROOTFS].end = end;
 399         }
 400
 401         /* make certain that HUSH is runnable */
 402         u_boot_hush_start();
 403         /* make sure that we see CTRL-C and save the old state */
 404         old_ctrlc = disable_ctrlc(0);
 405
 406         bitmap_first = 0;
 407         /* just loop thru all the possible files */
 408         for (i = 0; i < AU_MAXFILES; i++) {
 409                 /* just read the header */
 410                 sz = file_fat_read(aufile[i], LOAD_ADDR, sizeof(image_header_t));
 411                 debug ("read %s sz %ld hdr %d\n",
 412                         aufile[i], sz, sizeof(image_header_t));
 413                 if (sz <= 0 || sz < sizeof(image_header_t)) {
 414                         debug ("%s not found\n", aufile[i]);
 415                         continue;
 416                 }
 417                 if (au_check_header_valid(i, sz) < 0) {
 418                         debug ("%s header not valid\n", aufile[i]);
 419                         continue;
 420                 }
 421                 sz = file_fat_read(aufile[i], LOAD_ADDR, MAX_LOADSZ);
 422                 debug ("read %s sz %ld hdr %d\n",
 423                         aufile[i], sz, sizeof(image_header_t));
 424                 if (sz <= 0 || sz <= sizeof(image_header_t)) {
 425                         debug ("%s not found\n", aufile[i]);
 426                         continue;
 427                 }
 428                 if (au_check_cksum_valid(i, sz) < 0) {
 429                         debug ("%s checksum not valid\n", aufile[i]);
 430                         continue;
 431                 }
 432                 /* this is really not a good idea, but it's what the */
 433                 /* customer wants. */
 434                 cnt = 0;
 435                 got_ctrlc = 0;
 436                 do {
 437                         res = au_do_update(i, sz);
 438                         /* let the user break out of the loop */
 439                         if (ctrlc() || had_ctrlc()) {
 440                                 clear_ctrlc();
 441                                 if (res < 0)
 442                                         got_ctrlc = 1;
 443                                 break;
 444                         }
 445                         cnt++;
 446 #ifdef AU_TEST_ONLY
 447                 } while (res < 0 && cnt < (AU_MAXFILES + 1));
 448                 if (cnt < (AU_MAXFILES + 1))
 449 #else
 450                 } while (res < 0);
 451 #endif
 452         }
 453         usb_stop();
 454         /* restore the old state */
 455         disable_ctrlc(old_ctrlc);
 456         return 0;
 457 }
 458 #endif /* CONFIG_AUTO_UPDATE */