3 * Erik Theisen, Wave 7 Optics, etheisen@mindspring.com.
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * See file CREDITS for list of people who contributed to this
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of
13 * the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 #include <asm/processor.h>
32 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS]; /* info for FLASH chips */
34 /*-----------------------------------------------------------------------
37 static ulong flash_get_size (vu_long *addr, flash_info_t *info);
38 static int write_word8(flash_info_t *info, ulong dest, ulong data);
39 static int write_word32 (flash_info_t *info, ulong dest, ulong data);
40 static void flash_get_offsets (ulong base, flash_info_t *info);
42 /*-----------------------------------------------------------------------
45 unsigned long flash_init (void)
48 unsigned long size_b0, base_b0;
49 unsigned long size_b1, base_b1;
51 /* Init: no FLASHes known */
52 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; ++i) {
53 flash_info[i].flash_id = FLASH_UNKNOWN;
56 /* Get Size of Boot and Main Flashes */
57 size_b0 = flash_get_size((vu_long *)FLASH_BASE0_PRELIM, &flash_info[0]);
58 if (flash_info[0].flash_id == FLASH_UNKNOWN) {
59 printf ("## Unknown FLASH on Bank 0 - Size = 0x%08lx = %ld MB\n",
60 size_b0, size_b0<<20);
63 size_b1 = flash_get_size((vu_long *)FLASH_BASE1_PRELIM, &flash_info[1]);
64 if (flash_info[1].flash_id == FLASH_UNKNOWN) {
65 printf ("## Unknown FLASH on Bank 1 - Size = 0x%08lx = %ld MB\n",
66 size_b1, size_b1<<20);
70 /* Calculate base addresses */
74 /* Setup offsets for Boot Flash */
75 flash_get_offsets (base_b0, &flash_info[0]);
77 /* Protect board level data */
78 (void)flash_protect(FLAG_PROTECT_SET,
80 flash_info[0].start[1] - 1,
84 /* Monitor protection ON by default */
85 (void)flash_protect(FLAG_PROTECT_SET,
86 base_b0 + size_b0 - monitor_flash_len,
87 base_b0 + size_b0 - 1,
90 /* Protect the FPGA image */
91 (void)flash_protect(FLAG_PROTECT_SET,
93 FLASH_BASE1_PRELIM + CONFIG_SYS_FPGA_IMAGE_LEN - 1,
96 /* Protect the default boot image */
97 (void)flash_protect(FLAG_PROTECT_SET,
98 FLASH_BASE1_PRELIM + CONFIG_SYS_FPGA_IMAGE_LEN,
99 FLASH_BASE1_PRELIM + CONFIG_SYS_FPGA_IMAGE_LEN + 0x600000 - 1,
102 /* Setup offsets for Main Flash */
103 flash_get_offsets (FLASH_BASE1_PRELIM, &flash_info[1]);
105 return (size_b0 + size_b1);
106 } /* end flash_init() */
108 /*-----------------------------------------------------------------------
110 static void flash_get_offsets (ulong base, flash_info_t *info)
114 /* set up sector start address table - FOR BOOT ROM ONLY!!! */
115 if ((info->flash_id & FLASH_TYPEMASK) == FLASH_AM040) {
116 for (i = 0; i < info->sector_count; i++)
117 info->start[i] = base + (i * 0x00010000);
119 } /* end flash_get_offsets() */
121 /*-----------------------------------------------------------------------
123 void flash_print_info (flash_info_t *info)
129 volatile unsigned long *flash;
131 if (info->flash_id == FLASH_UNKNOWN) {
132 printf ("missing or unknown FLASH type\n");
136 switch (info->flash_id & FLASH_VENDMASK) {
137 case FLASH_MAN_AMD: printf ("1 x AMD "); break;
138 case FLASH_MAN_STM: printf ("1 x STM "); break;
139 case FLASH_MAN_INTEL: printf ("2 x Intel "); break;
140 default: printf ("Unknown Vendor ");
143 switch (info->flash_id & FLASH_TYPEMASK) {
145 if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_AMD)
146 printf ("AM29LV040 (4096 Kbit, uniform sector size)\n");
147 else if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_STM)
148 printf ("M29W040B (4096 Kbit, uniform block size)\n");
150 printf ("UNKNOWN 29x040x (4096 Kbit, uniform sector size)\n");
152 case FLASH_28F320J3A:
153 printf ("28F320J3A (32 Mbit = 128K x 32)\n");
155 case FLASH_28F640J3A:
156 printf ("28F640J3A (64 Mbit = 128K x 64)\n");
158 case FLASH_28F128J3A:
159 printf ("28F128J3A (128 Mbit = 128K x 128)\n");
162 printf ("Unknown Chip Type\n");
165 if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_STM) {
166 printf (" Size: %ld KB in %d Blocks\n",
167 info->size >> 10, info->sector_count);
169 printf (" Size: %ld KB in %d Sectors\n",
170 info->size >> 10, info->sector_count);
173 printf (" Sector Start Addresses:");
174 for (i=0; i<info->sector_count; ++i) {
176 * Check if whole sector is erased
178 if (i != (info->sector_count-1))
179 size = info->start[i+1] - info->start[i];
181 size = info->start[0] + info->size - info->start[i];
183 flash = (volatile unsigned long *)info->start[i];
184 size = size >> 2; /* divide by 4 for longword access */
185 for (k=0; k<size; k++)
187 if (*flash++ != 0xffffffff)
196 printf (" %08lX%s%s",
199 info->protect[i] ? "RO " : " "
203 } /* end flash_print_info() */
206 * The following code cannot be run from FLASH!
208 static ulong flash_get_size (vu_long *addr, flash_info_t *info)
211 ulong base = (ulong)addr;
213 /* Setup default type */
214 info->flash_id = FLASH_UNKNOWN;
215 info->sector_count =0;
218 /* Test for Boot Flash */
219 if (base == FLASH_BASE0_PRELIM) {
221 volatile unsigned char * addr2 = (unsigned char *)addr;
223 /* Write auto select command: read Manufacturer ID */
224 *(addr2 + 0x555) = 0xaa;
225 *(addr2 + 0x2aa) = 0x55;
226 *(addr2 + 0x555) = 0x90;
231 case (unsigned char)AMD_MANUFACT:
232 info->flash_id = FLASH_MAN_AMD;
234 case (unsigned char)STM_MANUFACT:
235 info->flash_id = FLASH_MAN_STM;
238 *addr2 = 0xf0; /* no or unknown flash */
243 value = *(addr2 + 1);
245 case (unsigned char)AMD_ID_LV040B:
246 case (unsigned char)STM_ID_29W040B:
247 info->flash_id += FLASH_AM040;
248 info->sector_count = 8;
249 info->size = 0x00080000;
250 break; /* => 512Kb */
252 *addr2 = 0xf0; /* => no or unknown flash */
256 else { /* MAIN Flash */
258 volatile unsigned long * addr2 = (unsigned long *)addr;
260 /* Write auto select command: read Manufacturer ID */
266 case (unsigned long)INTEL_MANUFACT:
267 info->flash_id = FLASH_MAN_INTEL;
270 *addr2 = 0xff; /* no or unknown flash */
274 /* Device ID - This shit is interleaved... */
275 value = *(addr2 + 1);
277 case (unsigned long)INTEL_ID_28F320J3A:
278 info->flash_id += FLASH_28F320J3A;
279 info->sector_count = 32;
280 info->size = 0x00400000 * 2;
281 break; /* => 2 X 4 MB */
282 case (unsigned long)INTEL_ID_28F640J3A:
283 info->flash_id += FLASH_28F640J3A;
284 info->sector_count = 64;
285 info->size = 0x00800000 * 2;
286 break; /* => 2 X 8 MB */
287 case (unsigned long)INTEL_ID_28F128J3A:
288 info->flash_id += FLASH_28F128J3A;
289 info->sector_count = 128;
290 info->size = 0x01000000 * 2;
291 break; /* => 2 X 16 MB */
293 *addr2 = 0xff; /* => no or unknown flash */
297 /* Make sure we don't exceed CONFIG_SYS_MAX_FLASH_SECT */
298 if (info->sector_count > CONFIG_SYS_MAX_FLASH_SECT) {
299 printf ("** ERROR: sector count %d > max (%d) **\n",
300 info->sector_count, CONFIG_SYS_MAX_FLASH_SECT);
301 info->sector_count = CONFIG_SYS_MAX_FLASH_SECT;
304 /* set up sector start address table */
305 switch (info->flash_id & FLASH_TYPEMASK) {
307 for (i = 0; i < info->sector_count; i++)
308 info->start[i] = base + (i * 0x00010000);
310 case FLASH_28F320J3A:
311 case FLASH_28F640J3A:
312 case FLASH_28F128J3A:
313 for (i = 0; i < info->sector_count; i++)
314 info->start[i] = base + (i * 0x00020000 * 2); /* 2 Banks */
318 /* Test for Boot Flash */
319 if (base == FLASH_BASE0_PRELIM) {
320 volatile unsigned char *addr2;
321 /* check for protected sectors */
322 for (i = 0; i < info->sector_count; i++) {
323 /* read sector protection at sector address, (AX .. A0) = 0x02 */
324 /* D0 = 1 if protected */
325 addr2 = (volatile unsigned char *)(info->start[i]);
326 info->protect[i] = *(addr2 + 2) & 1;
329 /* Restore read mode */
330 *(unsigned char *)base = 0xF0; /* Reset NORMAL Flash */
332 else { /* Main Flash */
333 volatile unsigned long *addr2;
334 /* check for protected sectors */
335 for (i = 0; i < info->sector_count; i++) {
336 /* read sector protection at sector address, (AX .. A0) = 0x02 */
337 /* D0 = 1 if protected */
338 addr2 = (volatile unsigned long *)(info->start[i]);
339 info->protect[i] = *(addr2 + 2) & 0x1;
342 /* Restore read mode */
343 *(unsigned long *)base = 0xFFFFFFFF; /* Reset Flash */
347 } /* end flash_get_size() */
349 /*-----------------------------------------------------------------------
352 static int wait_for_DQ7(ulong addr, uchar cmp_val, ulong tout)
356 volatile uchar *vaddr = (uchar *)addr;
359 for (i = 1; i <= (100 * tout); i++) { /* Wait up to tout ms */
363 /* Check for completion */
364 if ((vaddr[0] & 0x80) == (cmp_val & 0x80)) {
368 /* KEEP THE LUSER HAPPY - Print a dot every 1.1 seconds */
372 /* Kick the dog if needed */
377 } /* wait_for_DQ7() */
379 /*-----------------------------------------------------------------------
382 static int flash_erase8(flash_info_t *info, int s_first, int s_last)
384 int tcode, rcode = 0;
385 volatile uchar *addr = (uchar *)(info->start[0]);
386 volatile uchar *sector_addr;
387 int flag, prot, sect;
389 /* Validate arguments */
390 if ((s_first < 0) || (s_first > s_last)) {
391 if (info->flash_id == FLASH_UNKNOWN)
392 printf ("- missing\n");
394 printf ("- no sectors to erase\n");
398 /* Check for KNOWN flash type */
399 if (info->flash_id == FLASH_UNKNOWN) {
400 printf ("Can't erase unknown flash type - aborted\n");
404 /* Check for protected sectors */
406 for (sect = s_first; sect <= s_last; ++sect) {
407 if (info->protect[sect])
411 printf ("- Warning: %d protected sectors will not be erased!\n", prot);
415 /* Start erase on unprotected sectors */
416 for (sect = s_first; sect <= s_last; sect++) {
417 if (info->protect[sect] == 0) { /* not protected */
418 sector_addr = (uchar *)(info->start[sect]);
420 if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_STM)
421 printf("Erasing block %p\n", sector_addr);
423 printf("Erasing sector %p\n", sector_addr);
425 /* Disable interrupts which might cause Flash to timeout */
426 flag = disable_interrupts();
428 *(addr + 0x555) = (uchar)0xAA;
429 *(addr + 0x2aa) = (uchar)0x55;
430 *(addr + 0x555) = (uchar)0x80;
431 *(addr + 0x555) = (uchar)0xAA;
432 *(addr + 0x2aa) = (uchar)0x55;
433 *sector_addr = (uchar)0x30; /* sector erase */
436 * Wait for each sector to complete, it's more
437 * reliable. According to AMD Spec, you must
438 * issue all erase commands within a specified
439 * timeout. This has been seen to fail, especially
440 * if printf()s are included (for debug)!!
441 * Takes up to 6 seconds.
443 tcode = wait_for_DQ7((ulong)sector_addr, 0x80, 6000);
445 /* re-enable interrupts if necessary */
449 /* Make sure we didn't timeout */
451 printf ("Timeout\n");
457 /* wait at least 80us - let's wait 1 ms */
460 /* reset to read mode */
461 addr = (uchar *)info->start[0];
462 *addr = (uchar)0xF0; /* reset bank */
466 } /* end flash_erase8() */
468 static int flash_erase32(flash_info_t *info, int s_first, int s_last)
471 ulong start, now, last;
474 /* Validate arguments */
475 if ((s_first < 0) || (s_first > s_last)) {
476 if (info->flash_id == FLASH_UNKNOWN)
477 printf ("- missing\n");
479 printf ("- no sectors to erase\n");
483 /* Check for KNOWN flash type */
484 if ((info->flash_id & FLASH_VENDMASK) != FLASH_MAN_INTEL) {
485 printf ("Can erase only Intel flash types - aborted\n");
489 /* Check for protected sectors */
490 for (sect = s_first; sect <= s_last; ++sect) {
491 if (info->protect[sect])
495 printf ("- Warning: %d protected sectors will not be erased!\n", prot);
499 start = get_timer (0);
501 /* Start erase on unprotected sectors */
502 for (sect = s_first; sect <= s_last; sect++) {
504 if (info->protect[sect] == 0) { /* not protected */
505 vu_long *addr = (vu_long *)(info->start[sect]);
506 unsigned long status;
508 /* Disable interrupts which might cause a timeout here */
509 flag = disable_interrupts();
511 *addr = 0x00500050; /* clear status register */
512 *addr = 0x00200020; /* erase setup */
513 *addr = 0x00D000D0; /* erase confirm */
515 /* re-enable interrupts if necessary */
519 /* Wait at least 80us - let's wait 1 ms */
522 while (((status = *addr) & 0x00800080) != 0x00800080) {
523 if ((now = get_timer(start)) > CONFIG_SYS_FLASH_ERASE_TOUT) {
524 printf ("Timeout\n");
525 *addr = 0x00B000B0; /* suspend erase */
526 *addr = 0x00FF00FF; /* reset to read mode */
530 /* show that we're waiting */
531 if ((now - last) > 990) { /* every second */
536 *addr = 0x00FF00FF; /* reset to read mode */
541 } /* end flash_erase32() */
543 int flash_erase(flash_info_t *info, int s_first, int s_last)
545 if ((info->flash_id & FLASH_TYPEMASK) == FLASH_AM040)
546 return flash_erase8(info, s_first, s_last);
548 return flash_erase32(info, s_first, s_last);
549 } /* end flash_erase() */
551 /*-----------------------------------------------------------------------
552 * Copy memory to flash, returns:
555 * 2 - Flash not erased
557 static int write_buff8(flash_info_t *info, uchar *src, ulong addr, ulong cnt)
563 start = get_timer (0);
565 wp = (addr & ~3); /* get lower word
569 * handle unaligned start bytes
571 if ((l = addr - wp) != 0) {
573 for (i=0, cp=wp; i<l; ++i, ++cp) {
574 data = (data << 8) | (*(uchar *)cp);
576 for (; i<4 && cnt>0; ++i) {
577 data = (data << 8) | *src++;
581 for (; cnt==0 && i<4; ++i, ++cp) {
582 data = (data << 8) | (*(uchar *)cp);
585 if ((rc = write_word8(info, wp, data)) != 0) {
592 * handle word aligned part
596 for (i=0; i<4; ++i) {
597 data = (data << 8) | *src++;
599 if ((rc = write_word8(info, wp, data)) != 0) {
604 if (get_timer(start) > 1000) { /* every second */
607 start = get_timer(0);
616 * handle unaligned tail bytes
619 for (i=0, cp=wp; i<4 && cnt>0; ++i, ++cp) {
620 data = (data << 8) | *src++;
623 for (; i<4; ++i, ++cp) {
624 data = (data << 8) | (*(uchar *)cp);
627 return (write_word8(info, wp, data));
628 } /* end write_buff8() */
630 #define FLASH_WIDTH 4 /* flash bus width in bytes */
631 static int write_buff32 (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
637 start = get_timer (0);
639 if (info->flash_id == FLASH_UNKNOWN) {
643 wp = (addr & ~(FLASH_WIDTH-1)); /* get lower FLASH_WIDTH aligned address */
646 * handle unaligned start bytes
648 if ((l = addr - wp) != 0) {
650 for (i=0, cp=wp; i<l; ++i, ++cp) {
651 data = (data << 8) | (*(uchar *)cp);
653 for (; i<FLASH_WIDTH && cnt>0; ++i) {
654 data = (data << 8) | *src++;
658 for (; cnt==0 && i<FLASH_WIDTH; ++i, ++cp) {
659 data = (data << 8) | (*(uchar *)cp);
662 if ((rc = write_word32(info, wp, data)) != 0) {
669 * handle FLASH_WIDTH aligned part
671 while (cnt >= FLASH_WIDTH) {
673 for (i=0; i<FLASH_WIDTH; ++i) {
674 data = (data << 8) | *src++;
676 if ((rc = write_word32(info, wp, data)) != 0) {
681 if (get_timer(start) > 990) { /* every second */
683 start = get_timer(0);
692 * handle unaligned tail bytes
695 for (i=0, cp=wp; i<FLASH_WIDTH && cnt>0; ++i, ++cp) {
696 data = (data << 8) | *src++;
699 for (; i<FLASH_WIDTH; ++i, ++cp) {
700 data = (data << 8) | (*(uchar *)cp);
703 return (write_word32(info, wp, data));
704 } /* write_buff32() */
706 int write_buff(flash_info_t *info, uchar *src, ulong addr, ulong cnt)
710 if ((info->flash_id & FLASH_TYPEMASK) == FLASH_AM040)
711 retval = write_buff8(info, src, addr, cnt);
713 retval = write_buff32(info, src, addr, cnt);
716 } /* end write_buff() */
718 /*-----------------------------------------------------------------------
719 * Write a word to Flash, returns:
722 * 2 - Flash not erased
725 static int write_word8(flash_info_t *info, ulong dest, ulong data)
727 volatile uchar *addr2 = (uchar *)(info->start[0]);
728 volatile uchar *dest2 = (uchar *)dest;
729 volatile uchar *data2 = (uchar *)&data;
731 int i, tcode, rcode = 0;
733 /* Check if Flash is (sufficently) erased */
734 if ((*((volatile uchar *)dest) &
735 (uchar)data) != (uchar)data) {
739 for (i=0; i < (4 / sizeof(uchar)); i++) {
740 /* Disable interrupts which might cause a timeout here */
741 flag = disable_interrupts();
743 *(addr2 + 0x555) = (uchar)0xAA;
744 *(addr2 + 0x2aa) = (uchar)0x55;
745 *(addr2 + 0x555) = (uchar)0xA0;
749 /* Wait for write to complete, up to 1ms */
750 tcode = wait_for_DQ7((ulong)&dest2[i], data2[i], 1);
752 /* re-enable interrupts if necessary */
756 /* Make sure we didn't timeout */
763 } /* end write_word8() */
765 static int write_word32(flash_info_t *info, ulong dest, ulong data)
767 vu_long *addr = (vu_long *)dest;
772 /* Check if Flash is (sufficiently) erased */
773 if ((*addr & data) != data) {
776 /* Disable interrupts which might cause a timeout here */
777 flag = disable_interrupts();
779 *addr = 0x00400040; /* write setup */
782 /* re-enable interrupts if necessary */
786 start = get_timer (0);
788 while (((status = *addr) & 0x00800080) != 0x00800080) {
790 if (get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT) {
791 *addr = 0x00FF00FF; /* restore read mode */
796 *addr = 0x00FF00FF; /* restore read mode */
799 } /* end write_word32() */
802 static int _flash_protect(flash_info_t *info, long sector)
808 volatile long *addr = (long *)sector;
810 switch(info->flash_id & FLASH_TYPEMASK) {
811 case FLASH_28F320J3A:
812 case FLASH_28F640J3A:
813 case FLASH_28F128J3A:
814 /* Disable interrupts which might cause Flash to timeout */
815 flag = disable_interrupts();
818 *addr = 0x00500050L; /* Clear the status register */
819 *addr = 0x00600060L; /* Set lock bit setup */
820 *addr = 0x00010001L; /* Set lock bit confirm */
822 /* Wait for command completion */
823 for (i = 0; i < 10; i++) { /* 75us timeout, wait 100us */
825 if ((*addr & 0x00800080L) == 0x00800080L)
829 /* Not successful? */
831 if (status != 0x00800080L) {
832 printf("Protect %x sector failed: %x\n",
833 (uint)sector, (uint)status);
837 /* Restore read mode */
840 /* re-enable interrupts if necessary */
845 case FLASH_AM040: /* No soft sector protection */
849 /* Turn protection on for this sector */
850 for (i = 0; i < info->sector_count; i++) {
851 if (info->start[i] == sector) {
852 info->protect[i] = 1;
858 } /* end _flash_protect() */
860 static int _flash_unprotect(flash_info_t *info, long sector)
866 volatile long *addr = (long *)sector;
868 switch(info->flash_id & FLASH_TYPEMASK) {
869 case FLASH_28F320J3A:
870 case FLASH_28F640J3A:
871 case FLASH_28F128J3A:
872 /* Disable interrupts which might cause Flash to timeout */
873 flag = disable_interrupts();
875 *addr = 0x00500050L; /* Clear the status register */
876 *addr = 0x00600060L; /* Clear lock bit setup */
877 *addr = 0x00D000D0L; /* Clear lock bit confirm */
879 /* Wait for command completion */
880 for (i = 0; i < 80 ; i++) { /* 700ms timeout, wait 800 */
881 udelay(10000); /* Delay 10ms */
882 if ((*addr & 0x00800080L) == 0x00800080L)
886 /* Not successful? */
888 if (status != 0x00800080L) {
889 printf("Un-protect %x sector failed: %x\n",
890 (uint)sector, (uint)status);
895 /* restore read mode */
898 /* re-enable interrupts if necessary */
903 case FLASH_AM040: /* No soft sector protection */
908 * Fix Intel's little red wagon. Reprotect
909 * sectors that were protected before we undid
910 * protection on a specific sector.
912 for (i = 0; i < info->sector_count; i++) {
913 if (info->start[i] != sector) {
914 if (info->protect[i]) {
915 if (_flash_protect(info, info->start[i]))
919 else /* Turn protection off for this sector */
920 info->protect[i] = 0;
924 } /* end _flash_unprotect() */
927 int flash_real_protect(flash_info_t *info, long sector, int prot)
932 rcode = _flash_protect(info, info->start[sector]);
934 rcode = _flash_unprotect(info, info->start[sector]);
937 } /* end flash_real_protect() */
939 /*-----------------------------------------------------------------------