2 * MOUSSE/MPC8240 Board definitions.
3 * Flash Routines for MOUSSE onboard AMD29LV106DB devices
6 * Marius Groeger <mgroeger@sysgo.de>
7 * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
10 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
12 * (C) Copyright 1999, by Curt McDowell, 08-06-99, Broadcom Corp.
13 * (C) Copyright 2001, James Dougherty, 07/18/01, Broadcom Corp.
15 * See file CREDITS for list of people who contributed to this
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License as
20 * published by the Free Software Foundation; either version 2 of
21 * the License, or (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
40 int flashLibDebug = 0;
41 int flashLibInited = 0;
46 #define PRINTF if (flashLibDebug) printf
48 #define PRIVATE static
53 flash_info_t flash_info[CFG_MAX_FLASH_BANKS];
55 #define SLEEP_DELAY 166
56 #define FLASH_SECTOR_SIZE (64*1024)
57 /***********************************************************************
59 * Virtual Flash Devices on Mousse board
61 * These must be kept in sync with the definitions in flashLib.h.
63 ***********************************************************************/
65 PRIVATE flash_dev_t flashDev[] = {
66 /* Bank 0 sector SA0 (16 kB) */
67 { "SA0",FLASH0_BANK, FLASH0_SEG0_START, 1, 14,
68 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
70 /* Bank 0 sector SA1 (8 kB) */
71 { "SA1", FLASH0_BANK, FLASH0_SEG0_START + 0x4000, 1, 13,
72 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
74 /* Bank 0 sector SA2 (8 kB) */
75 { "SA2", FLASH0_BANK, FLASH0_SEG0_START + 0x6000, 1, 13,
76 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
78 /* Bank 0 sector SA3 is occluded by Mousse I/O devices */
79 /* Bank 0 sectors SA4-SA18, after Mousse devices up to PLCC (960 kB) */
80 { "KERNEL", FLASH0_BANK, FLASH0_SEG1_START, 15, 16,
81 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
83 /* Bank 0 sectors SA19-SA26, jumper can occlude this by PLCC (512 kB) */
84 /* This is where the Kahlua boot vector and boot ROM code resides. */
85 { "BOOT",FLASH0_BANK, FLASH0_SEG2_START, 8, 16,
86 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
88 /* Bank 0 sectors SA27-SA34 (512 kB) */
89 { "RAMDISK",FLASH0_BANK, FLASH0_SEG3_START, 8, 16,
90 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
94 int flashDevCount = (sizeof (flashDev) / sizeof (flashDev[0]));
96 #define DEV(no) (&flashDev[no])
97 #define DEV_NO(dev) ((dev) - flashDev)
99 /***********************************************************************
101 * Private Flash Routines
103 ***********************************************************************/
108 * "addr" is always the PROM raw address, which is the address of an
109 * 8-bit quantity for flash 0 and 16-bit quantity for flash 1.
111 * "pos" is always a logical byte position from the PROM beginning.
114 #define FLASH0_ADDR(dev, addr) \
115 ((unsigned char *) ((dev)->base + (addr)))
117 #define FLASH0_WRITE(dev, addr, value) \
118 (*FLASH0_ADDR(dev, addr) = (value))
120 #define FLASH0_READ(dev, addr) \
121 (*FLASH0_ADDR(dev, addr))
123 PRIVATE int flashCheck(flash_dev_t *dev)
125 if (! flashLibInited) {
126 printf("flashCheck: flashLib not initialized\n");
130 if (dev < &flashDev[0] || dev >= &flashDev[flashDevCount]) {
131 printf("flashCheck: Bad dev parameter\n");
136 printf("flashCheck: Device %d not available\n", DEV_NO(dev));
143 PRIVATE void flashReset(flash_dev_t *dev)
145 PRINTF("flashReset: dev=%d\n", DEV_NO(dev));
147 if (dev->bank == FLASH0_BANK) {
148 FLASH0_WRITE(dev, 0x555, 0xaa);
149 FLASH0_WRITE(dev, 0xaaa, 0x55);
150 FLASH0_WRITE(dev, 0x555, 0xf0);
155 PRINTF("flashReset: done\n");
158 PRIVATE int flashProbe(flash_dev_t *dev)
160 int rv, deviceID, vendorID;
162 PRINTF("flashProbe: dev=%d\n", DEV_NO(dev));
164 if (dev->bank != FLASH0_BANK) {
169 FLASH0_WRITE(dev, 0xaaa, 0xaa);
170 FLASH0_WRITE(dev, 0x555, 0x55);
171 FLASH0_WRITE(dev, 0xaaa, 0x90);
175 vendorID = FLASH0_READ(dev, 0);
176 deviceID = FLASH0_READ(dev, 2);
178 FLASH0_WRITE(dev, 0, 0xf0);
180 PRINTF("flashProbe: vendor=0x%x device=0x%x\n", vendorID, deviceID);
182 if (vendorID == dev->vendorID && deviceID == dev->deviceID)
188 PRINTF("flashProbe: rv=%d\n", rv);
193 PRIVATE int flashWait(flash_dev_t *dev, int addr, int expect, int erase)
199 PRINTF("flashWait: dev=%d addr=0x%x expect=0x%x erase=%d\n",
200 DEV_NO(dev), addr, expect, erase);
203 if (dev->bank != FLASH0_BANK) {
209 polls = FLASH_ERASE_SECTOR_TIMEOUT; /* Ticks */
211 polls = FLASH_PROGRAM_POLLS; /* Loops */
213 for (i = 0; i < polls; i++) {
217 data = FLASH0_READ(dev, addr);
219 if (((data ^ expect) & 0x80) == 0) {
226 * If the 0x20 bit has come on, it could actually be because
227 * the operation succeeded, so check the done bit again.
230 data = FLASH0_READ(dev, addr);
232 if (((data ^ expect) & 0x80) == 0) {
237 printf("flashWait: Program error (dev: %d, addr: 0x%x)\n",
246 printf("flashWait: Timeout %s (dev: %d, addr: 0x%x)\n",
247 erase ? "erasing sector" : "programming byte",
253 PRINTF("flashWait: rv=%d\n", rv);
259 /***********************************************************************
261 * Public Flash Routines
263 ***********************************************************************/
265 STATUS flashLibInit(void)
269 PRINTF("flashLibInit: devices=%d\n", flashDevCount);
271 for (i = 0; i < flashDevCount; i++) {
272 flash_dev_t *dev = &flashDev[i];
274 * For bank 1, probe both without and with byte swappage,
275 * so that this module works on both old and new Mousse boards.
280 if (flashProbe(dev) != ERROR)
285 if (flashProbe(dev) != ERROR)
291 PRINTF("\n FLASH %s[%d]: iobase=0x%x - %d sectors %d KB",
292 flashDev[i].name,i,flashDev[i].base, flashDev[i].sectors,
293 (flashDev[i].sectors * FLASH_SECTOR_SIZE)/1024);
300 PRINTF("flashLibInit: done\n");
305 STATUS flashEraseSector(flash_dev_t *dev, int sector)
309 PRINTF("flashErasesector: dev=%d sector=%d\n", DEV_NO(dev), sector);
311 if (flashCheck(dev) == ERROR)
314 if (sector < 0 || sector >= dev->sectors) {
315 printf("flashEraseSector: Sector out of range (dev: %d, sector: %d)\n",
316 DEV_NO(dev), sector);
320 pos = FLASH_SECTOR_POS(dev, sector);
322 if (dev->bank != FLASH0_BANK) {
328 FLASH0_WRITE(dev, 0xaaa, 0xaa);
329 FLASH0_WRITE(dev, 0x555, 0x55);
330 FLASH0_WRITE(dev, 0xaaa, 0x80);
331 FLASH0_WRITE(dev, 0xaaa, 0xaa);
332 FLASH0_WRITE(dev, 0x555, 0x55);
333 FLASH0_WRITE(dev, addr, 0x30);
335 return flashWait(dev, addr, 0xff, 1);
339 * Note: it takes about as long to flash all sectors together with Chip
340 * Erase as it does to flash them one at a time (about 30 seconds for 2
341 * MB). Also since we want to be able to treat subsets of sectors as if
342 * they were complete devices, we don't use Chip Erase.
345 STATUS flashErase(flash_dev_t *dev)
349 PRINTF("flashErase: dev=%d sectors=%d\n", DEV_NO(dev), dev->sectors);
351 if (flashCheck(dev) == ERROR)
354 for (sector = 0; sector < dev->sectors; sector++) {
355 if (flashEraseSector(dev, sector) == ERROR)
362 * Read and write bytes
365 STATUS flashRead(flash_dev_t *dev, int pos, char *buf, int len)
369 PRINTF("flashRead: dev=%d pos=0x%x buf=0x%x len=0x%x\n",
370 DEV_NO(dev), pos, (int) buf, len);
372 if (flashCheck(dev) == ERROR)
375 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS(dev)) {
376 printf("flashRead: Position out of range "
377 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
378 DEV_NO(dev), pos, len);
385 if (dev->bank == FLASH0_BANK) {
389 PRINTF("flashRead: memcpy(0x%x, 0x%x, 0x%x)\n",
390 (int) buf, (int) FLASH0_ADDR(dev, pos), len);
392 memcpy(buf, FLASH0_ADDR(dev, addr), words);
395 PRINTF("flashRead: rv=OK\n");
400 STATUS flashWrite(flash_dev_t *dev, int pos, char *buf, int len)
404 PRINTF("flashWrite: dev=%d pos=0x%x buf=0x%x len=0x%x\n",
405 DEV_NO(dev), pos, (int) buf, len);
407 if (flashCheck(dev) == ERROR)
410 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS(dev)) {
411 printf("flashWrite: Position out of range "
412 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
413 DEV_NO(dev), pos, len);
420 if (dev->bank == FLASH0_BANK) {
428 if (~FLASH0_READ(dev, addr) & tmp) {
429 printf("flashWrite: Attempt to program 0 to 1 "
430 "(dev: %d, addr: 0x%x, data: 0x%x)\n",
431 DEV_NO(dev), addr, tmp);
434 FLASH0_WRITE(dev, 0xaaa, 0xaa);
435 FLASH0_WRITE(dev, 0x555, 0x55);
436 FLASH0_WRITE(dev, 0xaaa, 0xa0);
437 FLASH0_WRITE(dev, addr, tmp);
438 if (flashWait(dev, addr, tmp, 0) < 0)
445 PRINTF("flashWrite: rv=OK\n");
451 * flashWritable returns TRUE if a range contains all F's.
454 STATUS flashWritable(flash_dev_t *dev, int pos, int len)
459 PRINTF("flashWritable: dev=%d pos=0x%x len=0x%x\n",
460 DEV_NO(dev), pos, len);
462 if (flashCheck(dev) == ERROR)
465 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS(dev)) {
466 printf("flashWritable: Position out of range "
467 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
468 DEV_NO(dev), pos, len);
477 if (dev->bank == FLASH0_BANK) {
482 if (FLASH0_READ(dev, addr) != 0xff) {
493 PRINTF("flashWrite: rv=%d\n", rv);
499 * NOTE: the below code cannot run from FLASH!!!
501 /***********************************************************************
505 ***********************************************************************/
507 STATUS flashDiag(flash_dev_t *dev)
509 unsigned int *buf = 0;
513 if (flashCheck(dev) == ERROR)
516 printf("flashDiag: Testing device %d, "
517 "base: 0x%x, %d sectors @ %d kB = %d kB\n",
518 DEV_NO(dev), dev->base,
520 1 << (dev->lgSectorSize - 10),
521 dev->sectors << (dev->lgSectorSize - 10));
523 len = 1 << dev->lgSectorSize;
525 printf("flashDiag: Erasing\n");
527 if (flashErase(dev) == ERROR) {
528 printf("flashDiag: Erase failed\n");
531 printf("%d bytes requested ...\n", len);
533 printf("allocated %d bytes ...\n", len);
535 printf("flashDiag: Out of memory\n");
540 * Write unique counting pattern to each sector
543 for (sector = 0; sector < dev->sectors; sector++) {
544 printf("flashDiag: Write sector %d\n", sector);
546 for (i = 0; i < len / 4; i++)
547 buf[i] = sector << 24 | i;
550 sector << dev->lgSectorSize,
553 printf("flashDiag: Write failed (dev: %d, sector: %d)\n",
554 DEV_NO(dev), sector);
563 for (sector = 0; sector < dev->sectors; sector++) {
564 printf("flashDiag: Verify sector %d\n", sector);
567 sector << dev->lgSectorSize,
570 printf("flashDiag: Read failed (dev: %d, sector: %d)\n",
571 DEV_NO(dev), sector);
575 for (i = 0; i < len / 4; i++) {
576 if (buf[i] != (sector << 24 | i)) {
577 printf("flashDiag: Verify error "
578 "(dev: %d, sector: %d, offset: 0x%x)\n",
579 DEV_NO(dev), sector, i);
580 printf("flashDiag: Expected 0x%08x, got 0x%08x\n",
581 sector << 24 | i, buf[i]);
588 printf("flashDiag: Erasing\n");
590 if (flashErase(dev) == ERROR) {
591 printf("flashDiag: Final erase failed\n");
602 printf("flashDiag: Device %d passed\n", DEV_NO(dev));
604 printf("flashDiag: Device %d failed\n", DEV_NO(dev));
609 STATUS flashDiagAll(void)
614 PRINTF("flashDiagAll: devices=%d\n", flashDevCount);
616 for (i = 0; i < flashDevCount; i++) {
617 flash_dev_t *dev = &flashDev[i];
619 if (dev->found && flashDiag(dev) == ERROR)
624 printf("flashDiagAll: Passed\n");
626 printf("flashDiagAll: Failed because of earlier errors\n");
632 /*-----------------------------------------------------------------------
634 unsigned long flash_init (void)
636 unsigned long size = 0;
637 flash_dev_t *dev = NULL;
641 * Provide info for FLASH (up to 960K) of Kernel Image data.
643 dev = FLASH_DEV_BANK0_LOW;
644 flash_info[FLASH_BANK_KERNEL].flash_id =
645 (dev->vendorID << 16) | dev->deviceID;
646 flash_info[FLASH_BANK_KERNEL].sector_count = dev->sectors;
647 flash_info[FLASH_BANK_KERNEL].size =
648 flash_info[FLASH_BANK_KERNEL].sector_count * FLASH_SECTOR_SIZE;
649 flash_info[FLASH_BANK_KERNEL].start[FIRST_SECTOR] = dev->base;
650 size += flash_info[FLASH_BANK_KERNEL].size;
653 * Provide info for 512K PLCC FLASH ROM (U-Boot)
655 dev = FLASH_DEV_BANK0_BOOT;
656 flash_info[FLASH_BANK_BOOT].flash_id =
657 (dev->vendorID << 16) | dev->deviceID;
658 flash_info[FLASH_BANK_BOOT].sector_count = dev->sectors;
659 flash_info[FLASH_BANK_BOOT].size =
660 flash_info[FLASH_BANK_BOOT].sector_count * FLASH_SECTOR_SIZE;
661 flash_info[FLASH_BANK_BOOT].start[FIRST_SECTOR] = dev->base;
662 size += flash_info[FLASH_BANK_BOOT].size;
666 * Provide info for 512K FLASH0 segment (U-Boot)
668 dev = FLASH_DEV_BANK0_HIGH;
669 flash_info[FLASH_BANK_AUX].flash_id =
670 (dev->vendorID << 16) | dev->deviceID;
671 flash_info[FLASH_BANK_AUX].sector_count = dev->sectors;
672 flash_info[FLASH_BANK_AUX].size =
673 flash_info[FLASH_BANK_AUX].sector_count * FLASH_SECTOR_SIZE;
674 flash_info[FLASH_BANK_AUX].start[FIRST_SECTOR] = dev->base;
675 size += flash_info[FLASH_BANK_AUX].size;
682 * Get flash device from U-Boot flash info.
685 getFlashDevFromInfo(flash_info_t* info)
692 for (i = 0; i < flashDevCount; i++) {
693 flash_dev_t *dev = &flashDev[i];
694 if(dev->found && (dev->base == info->start[0]))
697 printf("ERROR: notice, no FLASH mapped at address 0x%x\n",
698 (unsigned int)info->start[0]);
703 flash_get_size (vu_long *addr, flash_info_t *info)
706 for(i = 0; i < flashDevCount; i++) {
707 flash_dev_t *dev = &flashDev[i];
709 if(dev->base == (unsigned int)addr){
710 info->flash_id = (dev->vendorID << 16) | dev->deviceID;
711 info->sector_count = dev->sectors;
712 info->size = info->sector_count * FLASH_SECTOR_SIZE;
713 return dev->sectors * FLASH_SECTOR_SIZE;
721 flash_print_info (flash_info_t *info)
726 if (info->flash_id == FLASH_UNKNOWN) {
727 printf ("missing or unknown FLASH type\n");
731 switch ((info->flash_id >> 16) & 0xff) {
736 printf ("Unknown Vendor ");
739 chip = (unsigned int) info->flash_id & 0x000000ff;
744 printf ("AM29F040B (4 Mbit)\n");
750 printf ("AM29LV160B (16 Mbit / 2M x 8bit)\n");
754 printf ("Unknown Chip Type:0x%x\n", chip);
758 printf (" Size: %ld bytes in %d Sectors\n",
759 info->size, info->sector_count);
761 printf (" Sector Start Addresses:");
762 for (i=0; i<info->sector_count; ++i) {
766 info->start[FIRST_SECTOR] + i*FLASH_SECTOR_SIZE,
767 info->protect[i] ? " (RO)" : " "
775 * Erase a range of flash sectors.
777 int flash_erase (flash_info_t *info, int s_first, int s_last)
779 vu_long *addr = (vu_long*)(info->start[0]);
780 int prot, sect, l_sect;
781 flash_dev_t* dev = NULL;
783 if ((s_first < 0) || (s_first > s_last)) {
784 if (info->flash_id == FLASH_UNKNOWN) {
785 printf ("- missing\n");
787 printf ("- no sectors to erase\n");
793 for (sect = s_first; sect <= s_last; sect++) {
794 if (info->protect[sect]) {
800 printf ("- Warning: %d protected sectors will not be erased!\n",
808 /* Start erase on unprotected sectors */
809 dev = getFlashDevFromInfo(info);
811 printf("Erase FLASH[%s] -%d sectors:", dev->name, dev->sectors);
812 for (sect = s_first; sect<=s_last; sect++) {
813 if (info->protect[sect] == 0) { /* not protected */
814 addr = (vu_long*)(dev->base);
815 /* printf("erase_sector: sector=%d, addr=0x%x\n",
818 if(ERROR == flashEraseSector(dev, sect)){
819 printf("ERROR: could not erase sector %d on FLASH[%s]\n",
830 /*-----------------------------------------------------------------------
831 * Write a word to Flash, returns:
834 * 2 - Flash not erased
837 write_word (flash_info_t *info, ulong dest, ulong data)
840 flash_dev_t* dev = getFlashDevFromInfo(info);
841 int addr = dest - info->start[0];
846 if(OK != flashWrite(dev, addr, (char*)&data, sizeof(ulong))){
847 printf("ERROR: could not write to addr=0x%x, data=0x%x\n",
848 (unsigned int)addr, (unsigned)data);
852 if((addr % FLASH_SECTOR_SIZE) == 0)
856 PRINTF("write_word:0x%x, base=0x%x, addr=0x%x, data=0x%x\n",
857 (unsigned)info->start[0],
859 (unsigned)(dest - info->start[0]),
868 /*-----------------------------------------------------------------------
869 * Copy memory to flash, returns:
872 * 2 - Flash not erased
875 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
879 flash_dev_t* dev = getFlashDevFromInfo(info);
882 printf("FLASH[%s]:", dev->name);
883 wp = (addr & ~3); /* get lower word aligned address */
886 * handle unaligned start bytes
888 if ((l = addr - wp) != 0) {
890 for (i=0, cp=wp; i<l; ++i, ++cp) {
891 data = (data << 8) | (*(uchar *)cp);
893 for (; i<4 && cnt>0; ++i) {
894 data = (data << 8) | *src++;
898 for (; cnt==0 && i<4; ++i, ++cp) {
899 data = (data << 8) | (*(uchar *)cp);
901 if ((rc = write_word(info, wp, data)) != 0) {
908 * handle word aligned part
912 for (i=0; i<4; ++i) {
913 data = (data << 8) | *src++;
915 if ((rc = write_word(info, wp, data)) != 0) {
927 * handle unaligned tail bytes
930 for (i=0, cp=wp; i<4 && cnt>0; ++i, ++cp) {
931 data = (data << 8) | *src++;
934 for (; i<4; ++i, ++cp) {
935 data = (data << 8) | (*(uchar *)cp);
938 return (write_word(info, wp, data));
943 /*-----------------------------------------------------------------------