3 * Gary Jennejohn, DENX Software Engineering, gj@denx.de.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 #include <asm/byteorder.h>
31 #ifdef CFG_HUSH_PARSER
35 #ifdef CONFIG_AUTO_UPDATE
37 #ifndef CONFIG_USB_OHCI_NEW
38 #error "must define CONFIG_USB_OHCI"
41 #ifndef CONFIG_USB_STORAGE
42 #error "must define CONFIG_USB_STORAGE"
45 #ifndef CFG_HUSH_PARSER
46 #error "must define CFG_HUSH_PARSER"
49 #if !defined(CONFIG_CMD_FAT)
50 #error "must define CONFIG_CMD_FAT"
54 * Check whether a USB memory stick is plugged in.
56 * 1) if prepare.img ist found load it into memory. If it is
58 * 2) if preinst.img is found load it into memory. If it is
59 * valid then run it. Update the EEPROM.
60 * 3) if firmw_01.img is found load it into memory. If it is valid,
61 * burn it into FLASH and update the EEPROM.
62 * 4) if kernl_01.img is found load it into memory. If it is valid,
63 * burn it into FLASH and update the EEPROM.
64 * 5) if app.img is found load it into memory. If it is valid,
65 * burn it into FLASH and update the EEPROM.
66 * 6) if disk.img is found load it into memory. If it is valid,
67 * burn it into FLASH and update the EEPROM.
68 * 7) if postinst.img is found load it into memory. If it is
69 * valid then run it. Update the EEPROM.
76 #define debug(fmt,args...) printf (fmt ,##args)
78 #define debug(fmt,args...)
81 /* possible names of files on the USB stick. */
82 #define AU_PREPARE "prepare.img"
83 #define AU_PREINST "preinst.img"
84 #define AU_FIRMWARE "firmw_01.img"
85 #define AU_KERNEL "kernl_01.img"
86 #define AU_APP "app.img"
87 #define AU_DISK "disk.img"
88 #define AU_POSTINST "postinst.img"
96 /* layout of the FLASH. ST = start address, ND = end address. */
97 #ifndef CONFIG_FLASH_8MB /* 16 MB Flash, 32 MB RAM */
98 #define AU_FL_FIRMWARE_ST 0x00000000
99 #define AU_FL_FIRMWARE_ND 0x0009FFFF
100 #define AU_FL_VFD_ST 0x000A0000
101 #define AU_FL_VFD_ND 0x000BFFFF
102 #define AU_FL_KERNEL_ST 0x000C0000
103 #define AU_FL_KERNEL_ND 0x001BFFFF
104 #define AU_FL_APP_ST 0x001C0000
105 #define AU_FL_APP_ND 0x005BFFFF
106 #define AU_FL_DISK_ST 0x005C0000
107 #define AU_FL_DISK_ND 0x00FFFFFF
108 #else /* 8 MB Flash, 32 MB RAM */
109 #define AU_FL_FIRMWARE_ST 0x00000000
110 #define AU_FL_FIRMWARE_ND 0x0005FFFF
111 #define AU_FL_KERNEL_ST 0x00060000
112 #define AU_FL_KERNEL_ND 0x0013FFFF
113 #define AU_FL_APP_ST 0x00140000
114 #define AU_FL_APP_ND 0x0067FFFF
115 #define AU_FL_DISK_ST 0x00680000
116 #define AU_FL_DISK_ND 0x007DFFFF
117 #define AU_FL_VFD_ST 0x007E0000
118 #define AU_FL_VFD_ND 0x007FFFFF
119 #endif /* CONFIG_FLASH_8MB */
121 /* a structure with the offsets to values in the EEPROM */
129 /* layout of the EEPROM - offset from the start. All entries are 32 bit. */
130 #define AU_EEPROM_TIME_PREINST 64
131 #define AU_EEPROM_SIZE_PREINST 68
132 #define AU_EEPROM_DCRC_PREINST 72
133 #define AU_EEPROM_TIME_FIRMWARE 76
134 #define AU_EEPROM_SIZE_FIRMWARE 80
135 #define AU_EEPROM_DCRC_FIRMWARE 84
136 #define AU_EEPROM_TIME_KERNEL 88
137 #define AU_EEPROM_SIZE_KERNEL 92
138 #define AU_EEPROM_DCRC_KERNEL 96
139 #define AU_EEPROM_TIME_APP 100
140 #define AU_EEPROM_SIZE_APP 104
141 #define AU_EEPROM_DCRC_APP 108
142 #define AU_EEPROM_TIME_DISK 112
143 #define AU_EEPROM_SIZE_DISK 116
144 #define AU_EEPROM_DCRC_DISK 120
145 #define AU_EEPROM_TIME_POSTINST 124
146 #define AU_EEPROM_SIZE_POSTINST 128
147 #define AU_EEPROM_DCRC_POSTINST 132
149 static int au_usb_stor_curr_dev; /* current device */
151 /* index of each file in the following arrays */
152 #define IDX_PREPARE 0
153 #define IDX_PREINST 1
154 #define IDX_FIRMWARE 2
158 #define IDX_POSTINST 6
159 /* max. number of files which could interest us */
160 #define AU_MAXFILES 7
161 /* pointers to file names */
162 char *aufile[AU_MAXFILES];
163 /* sizes of flash areas for each file */
164 long ausize[AU_MAXFILES];
165 /* offsets into the EEEPROM */
166 struct eeprom_layout auee_off[AU_MAXFILES] = { \
168 {AU_EEPROM_TIME_PREINST, AU_EEPROM_SIZE_PREINST, AU_EEPROM_DCRC_PREINST,}, \
169 {AU_EEPROM_TIME_FIRMWARE, AU_EEPROM_SIZE_FIRMWARE, AU_EEPROM_DCRC_FIRMWARE,}, \
170 {AU_EEPROM_TIME_KERNEL, AU_EEPROM_SIZE_KERNEL, AU_EEPROM_DCRC_KERNEL,}, \
171 {AU_EEPROM_TIME_APP, AU_EEPROM_SIZE_APP, AU_EEPROM_DCRC_APP,}, \
172 {AU_EEPROM_TIME_DISK, AU_EEPROM_SIZE_DISK, AU_EEPROM_DCRC_DISK,}, \
173 {AU_EEPROM_TIME_POSTINST, AU_EEPROM_SIZE_POSTINST, AU_EEPROM_DCRC_POSTINST,} \
175 /* array of flash areas start and end addresses */
176 struct flash_layout aufl_layout[AU_MAXFILES - 3] = { \
177 {AU_FL_FIRMWARE_ST, AU_FL_FIRMWARE_ND,}, \
178 {AU_FL_KERNEL_ST, AU_FL_KERNEL_ND,}, \
179 {AU_FL_APP_ST, AU_FL_APP_ND,}, \
180 {AU_FL_DISK_ST, AU_FL_DISK_ND,}, \
182 /* convert the index into aufile[] to an index into aufl_layout[] */
183 #define FIDX_TO_LIDX(idx) ((idx) - 2)
185 /* where to load files into memory */
186 #define LOAD_ADDR ((unsigned char *)0x0C100000)
187 /* the app is the largest image */
188 #define MAX_LOADSZ ausize[IDX_APP]
191 extern int fat_register_device(block_dev_desc_t *, int);
192 extern int file_fat_detectfs(void);
193 extern long file_fat_read(const char *, void *, unsigned long);
194 extern int i2c_read (unsigned char, unsigned int, int , unsigned char* , int);
195 extern int i2c_write (uchar, uint, int , uchar* , int);
197 extern int trab_vfd (ulong);
198 extern int transfer_pic(unsigned char, unsigned char *, int, int);
200 extern int flash_sect_erase(ulong, ulong);
201 extern int flash_sect_protect (int, ulong, ulong);
202 extern int flash_write (char *, ulong, ulong);
203 /* change char* to void* to shutup the compiler */
204 extern int i2c_write_multiple (uchar, uint, int, void *, int);
205 extern int i2c_read_multiple (uchar, uint, int, void *, int);
206 extern int u_boot_hush_start(void);
209 au_check_cksum_valid(int idx, long nbytes)
213 hdr = (image_header_t *)LOAD_ADDR;
214 #if defined(CONFIG_FIT)
215 if (genimg_get_format ((void *)hdr) != IMAGE_FORMAT_LEGACY) {
216 puts ("Non legacy image format not supported\n");
221 if (nbytes != image_get_image_size (hdr))
223 printf ("Image %s bad total SIZE\n", aufile[idx]);
226 /* check the data CRC */
227 if (!image_check_dcrc (hdr))
229 printf ("Image %s bad data checksum\n", aufile[idx]);
236 au_check_header_valid(int idx, long nbytes)
239 unsigned long checksum;
240 unsigned char buf[4];
242 hdr = (image_header_t *)LOAD_ADDR;
243 #if defined(CONFIG_FIT)
244 if (genimg_get_format ((void *)hdr) != IMAGE_FORMAT_LEGACY) {
245 puts ("Non legacy image format not supported\n");
250 /* check the easy ones first */
251 #undef CHECK_VALID_DEBUG
252 #ifdef CHECK_VALID_DEBUG
253 printf("magic %#x %#x ", image_get_magic (hdr), IH_MAGIC);
254 printf("arch %#x %#x ", image_get_arch (hdr), IH_ARCH_ARM);
255 printf("size %#x %#lx ", image_get_data_size (hdr), nbytes);
256 printf("type %#x %#x ", image_get_type (hdr), IH_TYPE_KERNEL);
258 if (nbytes < image_get_header_size ())
260 printf ("Image %s bad header SIZE\n", aufile[idx]);
263 if (!image_check_magic (hdr) || !image_check_arch (hdr, IH_ARCH_ARM))
265 printf ("Image %s bad MAGIC or ARCH\n", aufile[idx]);
268 /* check the hdr CRC */
269 if (!image_check_hcrc (hdr)) {
270 printf ("Image %s bad header checksum\n", aufile[idx]);
273 /* check the type - could do this all in one gigantic if() */
274 if ((idx == IDX_FIRMWARE) && !image_check_type (hdr, IH_TYPE_FIRMWARE)) {
275 printf ("Image %s wrong type\n", aufile[idx]);
278 if ((idx == IDX_KERNEL) && !image_check_type (hdr, IH_TYPE_KERNEL)) {
279 printf ("Image %s wrong type\n", aufile[idx]);
282 if ((idx == IDX_DISK) && !image_check_type (hdr, IH_TYPE_FILESYSTEM)) {
283 printf ("Image %s wrong type\n", aufile[idx]);
286 if ((idx == IDX_APP) && !image_check_type (hdr, IH_TYPE_RAMDISK)
287 && !image_check_type (hdr, IH_TYPE_FILESYSTEM)) {
288 printf ("Image %s wrong type\n", aufile[idx]);
291 if ((idx == IDX_PREPARE || idx == IDX_PREINST || idx == IDX_POSTINST)
292 && !image_check_type (hdr, IH_TYPE_SCRIPT))
294 printf ("Image %s wrong type\n", aufile[idx]);
297 /* special case for prepare.img */
298 if (idx == IDX_PREPARE)
300 /* recycle checksum */
301 checksum = image_get_data_size (hdr);
302 /* for kernel and app the image header must also fit into flash */
303 if ((idx != IDX_DISK) && (idx != IDX_FIRMWARE))
304 checksum += image_get_header_size ();
305 /* check the size does not exceed space in flash. HUSH scripts */
306 /* all have ausize[] set to 0 */
307 if ((ausize[idx] != 0) && (ausize[idx] < checksum)) {
308 printf ("Image %s is bigger than FLASH\n", aufile[idx]);
311 /* check the time stamp from the EEPROM */
313 i2c_read_multiple(0x54, auee_off[idx].time, 1, buf, sizeof(buf));
314 #ifdef CHECK_VALID_DEBUG
315 printf ("buf[0] %#x buf[1] %#x buf[2] %#x buf[3] %#x "
316 "as int %#x time %#x\n",
317 buf[0], buf[1], buf[2], buf[3],
318 *((unsigned int *)buf), image_get_time (hdr));
321 if (*((unsigned int *)buf) >= image_get_time (hdr)) {
322 printf ("Image %s is too old\n", aufile[idx]);
329 /* power control defines */
330 #define CPLD_VFD_BK ((volatile char *)0x04038002)
331 #define POWER_OFF (1 << 1)
334 au_do_update(int idx, long sz)
342 hdr = (image_header_t *)LOAD_ADDR;
343 #if defined(CONFIG_FIT)
344 if (genimg_get_format ((void *)hdr) != IMAGE_FORMAT_LEGACY) {
345 puts ("Non legacy image format not supported\n");
350 /* disable the power switch */
351 *CPLD_VFD_BK |= POWER_OFF;
353 /* execute a script */
354 if (image_check_type (hdr, IH_TYPE_SCRIPT)) {
355 addr = (char *)((char *)hdr + image_get_header_size ());
356 /* stick a NULL at the end of the script, otherwise */
357 /* parse_string_outer() runs off the end. */
358 addr[image_get_data_size (hdr)] = 0;
360 parse_string_outer(addr, FLAG_PARSE_SEMICOLON);
364 start = aufl_layout[FIDX_TO_LIDX(idx)].start;
365 end = aufl_layout[FIDX_TO_LIDX(idx)].end;
367 /* unprotect the address range */
368 /* this assumes that ONLY the firmware is protected! */
369 if (idx == IDX_FIRMWARE) {
370 #undef AU_UPDATE_TEST
371 #ifdef AU_UPDATE_TEST
372 /* erase it where Linux goes */
373 start = aufl_layout[1].start;
374 end = aufl_layout[1].end;
376 flash_sect_protect(0, start, end);
380 * erase the address range.
382 debug ("flash_sect_erase(%lx, %lx);\n", start, end);
383 flash_sect_erase(start, end);
385 /* strip the header - except for the kernel and ramdisk */
386 if (image_check_type (hdr, IH_TYPE_KERNEL) ||
387 image_check_type (hdr, IH_TYPE_RAMDISK)) {
389 off = image_get_header_size ();
390 nbytes = image_get_image_size (hdr);
392 addr = (char *)((char *)hdr + image_get_header_size ());
393 #ifdef AU_UPDATE_TEST
394 /* copy it to where Linux goes */
395 if (idx == IDX_FIRMWARE)
396 start = aufl_layout[1].start;
399 nbytes = image_get_data_size (hdr);
402 /* copy the data from RAM to FLASH */
403 debug ("flash_write(%p, %lx %x)\n", addr, start, nbytes);
404 rc = flash_write(addr, start, nbytes);
406 printf("Flashing failed due to error %d\n", rc);
410 /* check the dcrc of the copy */
411 if (crc32 (0, (uchar *)(start + off), image_get_data_size (hdr)) !=
412 image_get_dcrc (hdr)) {
413 printf ("Image %s Bad Data Checksum After COPY\n", aufile[idx]);
417 /* protect the address range */
418 /* this assumes that ONLY the firmware is protected! */
419 if (idx == IDX_FIRMWARE)
420 flash_sect_protect(1, start, end);
425 au_update_eeprom(int idx)
431 /* special case for prepare.img */
432 if (idx == IDX_PREPARE) {
433 /* enable the power switch */
434 *CPLD_VFD_BK &= ~POWER_OFF;
438 hdr = (image_header_t *)LOAD_ADDR;
439 #if defined(CONFIG_FIT)
440 if (genimg_get_format ((void *)hdr) != IMAGE_FORMAT_LEGACY) {
441 puts ("Non legacy image format not supported\n");
446 /* write the time field into EEPROM */
447 off = auee_off[idx].time;
448 val = image_get_time (hdr);
449 i2c_write_multiple(0x54, off, 1, &val, sizeof(val));
450 /* write the size field into EEPROM */
451 off = auee_off[idx].size;
452 val = image_get_data_size (hdr);
453 i2c_write_multiple(0x54, off, 1, &val, sizeof(val));
454 /* write the dcrc field into EEPROM */
455 off = auee_off[idx].dcrc;
456 val = image_get_dcrc (hdr);
457 i2c_write_multiple(0x54, off, 1, &val, sizeof(val));
458 /* enable the power switch */
459 *CPLD_VFD_BK &= ~POWER_OFF;
464 * this is called from board_init() after the hardware has been set up
465 * and is usable. That seems like a good time to do this.
466 * Right now the return value is ignored.
471 block_dev_desc_t *stor_dev;
473 int i, res = 0, bitmap_first, cnt, old_ctrlc, got_ctrlc;
480 memset(arr, 0, sizeof(arr));
481 i2c_write_multiple(0x54, 64, 1, arr, sizeof(arr));
483 au_usb_stor_curr_dev = -1;
485 if (usb_stop() < 0) {
486 debug ("usb_stop failed\n");
489 if (usb_init() < 0) {
490 debug ("usb_init failed\n");
494 * check whether a storage device is attached (assume that it's
495 * a USB memory stick, since nothing else should be attached).
497 au_usb_stor_curr_dev = usb_stor_scan(0);
498 if (au_usb_stor_curr_dev == -1) {
499 debug ("No device found. Not initialized?\n");
503 /* check whether it has a partition table */
504 stor_dev = get_dev("usb", 0);
505 if (stor_dev == NULL) {
506 debug ("uknown device type\n");
510 if (fat_register_device(stor_dev, 1) != 0) {
511 debug ("Unable to use USB %d:%d for fatls\n",
512 au_usb_stor_curr_dev, 1);
516 if (file_fat_detectfs() != 0) {
517 debug ("file_fat_detectfs failed\n");
520 /* initialize the array of file names */
521 memset(aufile, 0, sizeof(aufile));
522 aufile[IDX_PREPARE] = AU_PREPARE;
523 aufile[IDX_PREINST] = AU_PREINST;
524 aufile[IDX_FIRMWARE] = AU_FIRMWARE;
525 aufile[IDX_KERNEL] = AU_KERNEL;
526 aufile[IDX_APP] = AU_APP;
527 aufile[IDX_DISK] = AU_DISK;
528 aufile[IDX_POSTINST] = AU_POSTINST;
529 /* initialize the array of flash sizes */
530 memset(ausize, 0, sizeof(ausize));
531 ausize[IDX_FIRMWARE] = (AU_FL_FIRMWARE_ND + 1) - AU_FL_FIRMWARE_ST;
532 ausize[IDX_KERNEL] = (AU_FL_KERNEL_ND + 1) - AU_FL_KERNEL_ST;
533 ausize[IDX_APP] = (AU_FL_APP_ND + 1) - AU_FL_APP_ST;
534 ausize[IDX_DISK] = (AU_FL_DISK_ND + 1) - AU_FL_DISK_ST;
536 * now check whether start and end are defined using environment
541 env = getenv("firmware_st");
543 start = simple_strtoul(env, NULL, 16);
544 env = getenv("firmware_nd");
546 end = simple_strtoul(env, NULL, 16);
547 if (start >= 0 && end && end > start) {
548 ausize[IDX_FIRMWARE] = (end + 1) - start;
549 aufl_layout[0].start = start;
550 aufl_layout[0].end = end;
554 env = getenv("kernel_st");
556 start = simple_strtoul(env, NULL, 16);
557 env = getenv("kernel_nd");
559 end = simple_strtoul(env, NULL, 16);
560 if (start >= 0 && end && end > start) {
561 ausize[IDX_KERNEL] = (end + 1) - start;
562 aufl_layout[1].start = start;
563 aufl_layout[1].end = end;
567 env = getenv("app_st");
569 start = simple_strtoul(env, NULL, 16);
570 env = getenv("app_nd");
572 end = simple_strtoul(env, NULL, 16);
573 if (start >= 0 && end && end > start) {
574 ausize[IDX_APP] = (end + 1) - start;
575 aufl_layout[2].start = start;
576 aufl_layout[2].end = end;
580 env = getenv("disk_st");
582 start = simple_strtoul(env, NULL, 16);
583 env = getenv("disk_nd");
585 end = simple_strtoul(env, NULL, 16);
586 if (start >= 0 && end && end > start) {
587 ausize[IDX_DISK] = (end + 1) - start;
588 aufl_layout[3].start = start;
589 aufl_layout[3].end = end;
591 /* make certain that HUSH is runnable */
593 /* make sure that we see CTRL-C and save the old state */
594 old_ctrlc = disable_ctrlc(0);
597 /* just loop thru all the possible files */
598 for (i = 0; i < AU_MAXFILES; i++) {
599 /* just read the header */
600 sz = file_fat_read(aufile[i], LOAD_ADDR, image_get_header_size ());
601 debug ("read %s sz %ld hdr %d\n",
602 aufile[i], sz, image_get_header_size ());
603 if (sz <= 0 || sz < image_get_header_size ()) {
604 debug ("%s not found\n", aufile[i]);
607 if (au_check_header_valid(i, sz) < 0) {
608 debug ("%s header not valid\n", aufile[i]);
611 sz = file_fat_read(aufile[i], LOAD_ADDR, MAX_LOADSZ);
612 debug ("read %s sz %ld hdr %d\n",
613 aufile[i], sz, image_get_header_size ());
614 if (sz <= 0 || sz <= image_get_header_size ()) {
615 debug ("%s not found\n", aufile[i]);
618 if (au_check_cksum_valid(i, sz) < 0) {
619 debug ("%s checksum not valid\n", aufile[i]);
623 /* now that we have a valid file we can display the */
625 if (bitmap_first == 0) {
626 env = getenv("bitmap2");
630 /* not so simple - bitmap2 is supposed to */
631 /* contain the address of the bitmap */
632 env = (char *)simple_strtoul(env, NULL, 16);
633 /* NOTE: these are taken from vfd_logo.h. If that file changes then */
634 /* these defines MUST also be updated! These may be wrong for bitmap2. */
635 #define VFD_LOGO_WIDTH 112
636 #define VFD_LOGO_HEIGHT 72
637 /* must call transfer_pic directly */
638 transfer_pic(3, (unsigned char *)env,
639 VFD_LOGO_HEIGHT, VFD_LOGO_WIDTH);
644 /* this is really not a good idea, but it's what the */
645 /* customer wants. */
649 res = au_do_update(i, sz);
650 /* let the user break out of the loop */
651 if (ctrlc() || had_ctrlc()) {
659 } while (res < 0 && cnt < 3);
665 * it doesn't make sense to update the EEPROM if the
666 * update was interrupted by the user due to errors.
671 /* enable the power switch */
672 *CPLD_VFD_BK &= ~POWER_OFF;
674 /* restore the old state */
675 disable_ctrlc(old_ctrlc);
680 #endif /* CONFIG_AUTO_UPDATE */