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