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 * SPDX-License-Identifier: GPL-2.0+
24 int flashLibDebug = 0;
25 int flashLibInited = 0;
30 #define PRINTF if (flashLibDebug) printf
32 #define PRIVATE static
37 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS];
39 #define SLEEP_DELAY 166
40 #define FLASH_SECTOR_SIZE (64*1024)
41 /***********************************************************************
43 * Virtual Flash Devices on Mousse board
45 * These must be kept in sync with the definitions in flashLib.h.
47 ***********************************************************************/
49 PRIVATE flash_dev_t flashDev[] = {
50 /* Bank 0 sector SA0 (16 kB) */
51 { "SA0",FLASH0_BANK, FLASH0_SEG0_START, 1, 14,
52 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
54 /* Bank 0 sector SA1 (8 kB) */
55 { "SA1", FLASH0_BANK, FLASH0_SEG0_START + 0x4000, 1, 13,
56 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
58 /* Bank 0 sector SA2 (8 kB) */
59 { "SA2", FLASH0_BANK, FLASH0_SEG0_START + 0x6000, 1, 13,
60 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
62 /* Bank 0 sector SA3 is occluded by Mousse I/O devices */
63 /* Bank 0 sectors SA4-SA18, after Mousse devices up to PLCC (960 kB) */
64 { "KERNEL", FLASH0_BANK, FLASH0_SEG1_START, 15, 16,
65 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
67 /* Bank 0 sectors SA19-SA26, jumper can occlude this by PLCC (512 kB) */
68 /* This is where the Kahlua boot vector and boot ROM code resides. */
69 { "BOOT",FLASH0_BANK, FLASH0_SEG2_START, 8, 16,
70 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
72 /* Bank 0 sectors SA27-SA34 (512 kB) */
73 { "RAMDISK",FLASH0_BANK, FLASH0_SEG3_START, 8, 16,
74 FLASH0_VENDOR_ID, FLASH0_DEVICE_ID
78 int flashDevCount = (sizeof (flashDev) / sizeof (flashDev[0]));
80 #define DEV(no) (&flashDev[no])
81 #define DEV_NO(dev) ((dev) - flashDev)
83 /***********************************************************************
85 * Private Flash Routines
87 ***********************************************************************/
92 * "addr" is always the PROM raw address, which is the address of an
93 * 8-bit quantity for flash 0 and 16-bit quantity for flash 1.
95 * "pos" is always a logical byte position from the PROM beginning.
98 #define FLASH0_ADDR(dev, addr) \
99 ((unsigned char *) ((dev)->base + (addr)))
101 #define FLASH0_WRITE(dev, addr, value) \
102 (*FLASH0_ADDR(dev, addr) = (value))
104 #define FLASH0_READ(dev, addr) \
105 (*FLASH0_ADDR(dev, addr))
107 PRIVATE int flashCheck (flash_dev_t * dev)
109 if (!flashLibInited) {
110 printf ("flashCheck: flashLib not initialized\n");
114 if (dev < &flashDev[0] || dev >= &flashDev[flashDevCount]) {
115 printf ("flashCheck: Bad dev parameter\n");
120 printf ("flashCheck: Device %d not available\n", DEV_NO (dev));
127 PRIVATE void flashReset (flash_dev_t * dev)
129 PRINTF ("flashReset: dev=%d\n", DEV_NO (dev));
131 if (dev->bank == FLASH0_BANK) {
132 FLASH0_WRITE (dev, 0x555, 0xaa);
133 FLASH0_WRITE (dev, 0xaaa, 0x55);
134 FLASH0_WRITE (dev, 0x555, 0xf0);
137 udelay (SLEEP_DELAY);
139 PRINTF ("flashReset: done\n");
142 PRIVATE int flashProbe (flash_dev_t * dev)
144 int rv, deviceID, vendorID;
146 PRINTF ("flashProbe: dev=%d\n", DEV_NO (dev));
148 if (dev->bank != FLASH0_BANK) {
153 FLASH0_WRITE (dev, 0xaaa, 0xaa);
154 FLASH0_WRITE (dev, 0x555, 0x55);
155 FLASH0_WRITE (dev, 0xaaa, 0x90);
157 udelay (SLEEP_DELAY);
159 vendorID = FLASH0_READ (dev, 0);
160 deviceID = FLASH0_READ (dev, 2);
162 FLASH0_WRITE (dev, 0, 0xf0);
164 PRINTF ("flashProbe: vendor=0x%x device=0x%x\n", vendorID, deviceID);
166 if (vendorID == dev->vendorID && deviceID == dev->deviceID)
172 PRINTF ("flashProbe: rv=%d\n", rv);
177 PRIVATE int flashWait (flash_dev_t * dev, int addr, int expect, int erase)
184 PRINTF ("flashWait: dev=%d addr=0x%x expect=0x%x erase=%d\n",
185 DEV_NO (dev), addr, expect, erase);
188 if (dev->bank != FLASH0_BANK) {
194 polls = FLASH_ERASE_SECTOR_TIMEOUT; /* Ticks */
196 polls = FLASH_PROGRAM_POLLS; /* Loops */
198 for (i = 0; i < polls; i++) {
200 udelay (SLEEP_DELAY);
202 data = FLASH0_READ (dev, addr);
204 if (((data ^ expect) & 0x80) == 0) {
211 * If the 0x20 bit has come on, it could actually be because
212 * the operation succeeded, so check the done bit again.
215 data = FLASH0_READ (dev, addr);
217 if (((data ^ expect) & 0x80) == 0) {
222 printf ("flashWait: Program error (dev: %d, addr: 0x%x)\n",
231 printf ("flashWait: Timeout %s (dev: %d, addr: 0x%x)\n",
232 erase ? "erasing sector" : "programming byte",
238 PRINTF ("flashWait: rv=%d\n", rv);
244 /***********************************************************************
246 * Public Flash Routines
248 ***********************************************************************/
250 STATUS flashLibInit (void)
254 PRINTF ("flashLibInit: devices=%d\n", flashDevCount);
256 for (i = 0; i < flashDevCount; i++) {
257 flash_dev_t *dev = &flashDev[i];
260 * For bank 1, probe both without and with byte swappage,
261 * so that this module works on both old and new Mousse boards.
266 if (flashProbe (dev) != ERROR)
271 if (flashProbe (dev) != ERROR)
277 PRINTF ("\n FLASH %s[%d]: iobase=0x%x - %d sectors %d KB",
278 flashDev[i].name, i, flashDev[i].base,
280 (flashDev[i].sectors * FLASH_SECTOR_SIZE) / 1024);
287 PRINTF ("flashLibInit: done\n");
292 STATUS flashEraseSector (flash_dev_t * dev, int sector)
296 PRINTF ("flashErasesector: dev=%d sector=%d\n", DEV_NO (dev), sector);
298 if (flashCheck (dev) == ERROR)
301 if (sector < 0 || sector >= dev->sectors) {
302 printf ("flashEraseSector: Sector out of range (dev: %d, sector: %d)\n", DEV_NO (dev), sector);
306 pos = FLASH_SECTOR_POS (dev, sector);
308 if (dev->bank != FLASH0_BANK) {
314 FLASH0_WRITE (dev, 0xaaa, 0xaa);
315 FLASH0_WRITE (dev, 0x555, 0x55);
316 FLASH0_WRITE (dev, 0xaaa, 0x80);
317 FLASH0_WRITE (dev, 0xaaa, 0xaa);
318 FLASH0_WRITE (dev, 0x555, 0x55);
319 FLASH0_WRITE (dev, addr, 0x30);
321 return flashWait (dev, addr, 0xff, 1);
325 * Note: it takes about as long to flash all sectors together with Chip
326 * Erase as it does to flash them one at a time (about 30 seconds for 2
327 * MB). Also since we want to be able to treat subsets of sectors as if
328 * they were complete devices, we don't use Chip Erase.
331 STATUS flashErase (flash_dev_t * dev)
335 PRINTF ("flashErase: dev=%d sectors=%d\n", DEV_NO (dev), dev->sectors);
337 if (flashCheck (dev) == ERROR)
340 for (sector = 0; sector < dev->sectors; sector++) {
341 if (flashEraseSector (dev, sector) == ERROR)
348 * Read and write bytes
351 STATUS flashRead (flash_dev_t * dev, int pos, char *buf, int len)
355 PRINTF ("flashRead: dev=%d pos=0x%x buf=0x%x len=0x%x\n",
356 DEV_NO (dev), pos, (int) buf, len);
358 if (flashCheck (dev) == ERROR)
361 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS (dev)) {
362 printf ("flashRead: Position out of range "
363 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
364 DEV_NO (dev), pos, len);
371 if (dev->bank == FLASH0_BANK) {
375 PRINTF ("flashRead: memcpy(0x%x, 0x%x, 0x%x)\n",
376 (int) buf, (int) FLASH0_ADDR (dev, pos), len);
378 memcpy (buf, FLASH0_ADDR (dev, addr), words);
381 PRINTF ("flashRead: rv=OK\n");
386 STATUS flashWrite (flash_dev_t * dev, int pos, char *buf, int len)
390 PRINTF ("flashWrite: dev=%d pos=0x%x buf=0x%x len=0x%x\n",
391 DEV_NO (dev), pos, (int) buf, len);
393 if (flashCheck (dev) == ERROR)
396 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS (dev)) {
397 printf ("flashWrite: Position out of range "
398 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
399 DEV_NO (dev), pos, len);
406 if (dev->bank == FLASH0_BANK) {
414 if (~FLASH0_READ (dev, addr) & tmp) {
415 printf ("flashWrite: Attempt to program 0 to 1 "
416 "(dev: %d, addr: 0x%x, data: 0x%x)\n",
417 DEV_NO (dev), addr, tmp);
420 FLASH0_WRITE (dev, 0xaaa, 0xaa);
421 FLASH0_WRITE (dev, 0x555, 0x55);
422 FLASH0_WRITE (dev, 0xaaa, 0xa0);
423 FLASH0_WRITE (dev, addr, tmp);
424 if (flashWait (dev, addr, tmp, 0) < 0)
431 PRINTF ("flashWrite: rv=OK\n");
437 * flashWritable returns true if a range contains all F's.
440 STATUS flashWritable (flash_dev_t * dev, int pos, int len)
445 PRINTF ("flashWritable: dev=%d pos=0x%x len=0x%x\n",
446 DEV_NO (dev), pos, len);
448 if (flashCheck (dev) == ERROR)
451 if (pos < 0 || len < 0 || pos + len > FLASH_MAX_POS (dev)) {
452 printf ("flashWritable: Position out of range "
453 "(dev: %d, pos: 0x%x, len: 0x%x)\n",
454 DEV_NO (dev), pos, len);
463 if (dev->bank == FLASH0_BANK) {
468 if (FLASH0_READ (dev, addr) != 0xff) {
479 PRINTF ("flashWrite: rv=%d\n", rv);
485 * NOTE: the below code cannot run from FLASH!!!
487 /***********************************************************************
491 ***********************************************************************/
493 STATUS flashDiag (flash_dev_t * dev)
495 unsigned int *buf = 0;
499 if (flashCheck (dev) == ERROR)
502 printf ("flashDiag: Testing device %d, "
503 "base: 0x%x, %d sectors @ %d kB = %d kB\n",
504 DEV_NO (dev), dev->base,
506 1 << (dev->lgSectorSize - 10),
507 dev->sectors << (dev->lgSectorSize - 10));
509 len = 1 << dev->lgSectorSize;
511 printf ("flashDiag: Erasing\n");
513 if (flashErase (dev) == ERROR) {
514 printf ("flashDiag: Erase failed\n");
517 printf ("%d bytes requested ...\n", len);
519 printf ("allocated %d bytes ...\n", len);
521 printf ("flashDiag: Out of memory\n");
526 * Write unique counting pattern to each sector
529 for (sector = 0; sector < dev->sectors; sector++) {
530 printf ("flashDiag: Write sector %d\n", sector);
532 for (i = 0; i < len / 4; i++)
533 buf[i] = sector << 24 | i;
536 sector << dev->lgSectorSize,
537 (char *) buf, len) == ERROR) {
538 printf ("flashDiag: Write failed (dev: %d, sector: %d)\n",
539 DEV_NO (dev), sector);
548 for (sector = 0; sector < dev->sectors; sector++) {
549 printf ("flashDiag: Verify sector %d\n", sector);
552 sector << dev->lgSectorSize,
553 (char *) buf, len) == ERROR) {
554 printf ("flashDiag: Read failed (dev: %d, sector: %d)\n",
555 DEV_NO (dev), sector);
559 for (i = 0; i < len / 4; i++) {
560 if (buf[i] != (sector << 24 | i)) {
561 printf ("flashDiag: Verify error "
562 "(dev: %d, sector: %d, offset: 0x%x)\n",
563 DEV_NO (dev), sector, i);
564 printf ("flashDiag: Expected 0x%08x, got 0x%08x\n",
565 sector << 24 | i, buf[i]);
572 printf ("flashDiag: Erasing\n");
574 if (flashErase (dev) == ERROR) {
575 printf ("flashDiag: Final erase failed\n");
586 printf ("flashDiag: Device %d passed\n", DEV_NO (dev));
588 printf ("flashDiag: Device %d failed\n", DEV_NO (dev));
593 STATUS flashDiagAll (void)
598 PRINTF ("flashDiagAll: devices=%d\n", flashDevCount);
600 for (i = 0; i < flashDevCount; i++) {
601 flash_dev_t *dev = &flashDev[i];
603 if (dev->found && flashDiag (dev) == ERROR)
608 printf ("flashDiagAll: Passed\n");
610 printf ("flashDiagAll: Failed because of earlier errors\n");
616 /*-----------------------------------------------------------------------
618 unsigned long flash_init (void)
620 unsigned long size = 0;
621 flash_dev_t *dev = NULL;
626 * Provide info for FLASH (up to 960K) of Kernel Image data.
628 dev = FLASH_DEV_BANK0_LOW;
629 flash_info[FLASH_BANK_KERNEL].flash_id =
630 (dev->vendorID << 16) | dev->deviceID;
631 flash_info[FLASH_BANK_KERNEL].sector_count = dev->sectors;
632 flash_info[FLASH_BANK_KERNEL].size =
633 flash_info[FLASH_BANK_KERNEL].sector_count * FLASH_SECTOR_SIZE;
634 flash_info[FLASH_BANK_KERNEL].start[FIRST_SECTOR] = dev->base;
635 size += flash_info[FLASH_BANK_KERNEL].size;
638 * Provide info for 512K PLCC FLASH ROM (U-Boot)
640 dev = FLASH_DEV_BANK0_BOOT;
641 flash_info[FLASH_BANK_BOOT].flash_id =
642 (dev->vendorID << 16) | dev->deviceID;
643 flash_info[FLASH_BANK_BOOT].sector_count = dev->sectors;
644 flash_info[FLASH_BANK_BOOT].size =
645 flash_info[FLASH_BANK_BOOT].sector_count * FLASH_SECTOR_SIZE;
646 flash_info[FLASH_BANK_BOOT].start[FIRST_SECTOR] = dev->base;
647 size += flash_info[FLASH_BANK_BOOT].size;
651 * Provide info for 512K FLASH0 segment (U-Boot)
653 dev = FLASH_DEV_BANK0_HIGH;
654 flash_info[FLASH_BANK_AUX].flash_id =
655 (dev->vendorID << 16) | dev->deviceID;
656 flash_info[FLASH_BANK_AUX].sector_count = dev->sectors;
657 flash_info[FLASH_BANK_AUX].size =
658 flash_info[FLASH_BANK_AUX].sector_count * FLASH_SECTOR_SIZE;
659 flash_info[FLASH_BANK_AUX].start[FIRST_SECTOR] = dev->base;
660 size += flash_info[FLASH_BANK_AUX].size;
667 * Get flash device from U-Boot flash info.
669 flash_dev_t *getFlashDevFromInfo (flash_info_t * info)
676 for (i = 0; i < flashDevCount; i++) {
677 flash_dev_t *dev = &flashDev[i];
679 if (dev->found && (dev->base == info->start[0]))
682 printf ("ERROR: notice, no FLASH mapped at address 0x%x\n",
683 (unsigned int) info->start[0]);
687 ulong flash_get_size (vu_long * addr, flash_info_t * info)
691 for (i = 0; i < flashDevCount; i++) {
692 flash_dev_t *dev = &flashDev[i];
695 if (dev->base == (unsigned int) addr) {
696 info->flash_id = (dev->vendorID << 16) | dev->deviceID;
697 info->sector_count = dev->sectors;
698 info->size = info->sector_count * FLASH_SECTOR_SIZE;
699 return dev->sectors * FLASH_SECTOR_SIZE;
706 void flash_print_info (flash_info_t * info)
711 if (info->flash_id == FLASH_UNKNOWN) {
712 printf ("missing or unknown FLASH type\n");
716 switch ((info->flash_id >> 16) & 0xff) {
721 printf ("Unknown Vendor ");
724 chip = (unsigned int) info->flash_id & 0x000000ff;
729 printf ("AM29F040B (4 Mbit)\n");
735 printf ("AM29LV160B (16 Mbit / 2M x 8bit)\n");
739 printf ("Unknown Chip Type:0x%x\n", chip);
743 printf (" Size: %ld bytes in %d Sectors\n",
744 info->size, info->sector_count);
746 printf (" Sector Start Addresses:");
747 for (i = 0; i < info->sector_count; ++i) {
751 info->start[FIRST_SECTOR] + i * FLASH_SECTOR_SIZE,
752 info->protect[i] ? " (RO)" : " ");
759 * Erase a range of flash sectors.
761 int flash_erase (flash_info_t * info, int s_first, int s_last)
764 flash_dev_t *dev = NULL;
766 if ((s_first < 0) || (s_first > s_last)) {
767 if (info->flash_id == FLASH_UNKNOWN) {
768 printf ("- missing\n");
770 printf ("- no sectors to erase\n");
776 for (sect = s_first; sect <= s_last; sect++) {
777 if (info->protect[sect]) {
783 printf ("- Warning: %d protected sectors will not be erased!\n",
789 /* Start erase on unprotected sectors */
790 dev = getFlashDevFromInfo (info);
792 printf ("Erase FLASH[%s] -%d sectors:", dev->name, dev->sectors);
793 for (sect = s_first; sect <= s_last; sect++) {
794 if (info->protect[sect] == 0) { /* not protected */
796 if (ERROR == flashEraseSector (dev, sect)) {
797 printf ("ERROR: could not erase sector %d on FLASH[%s]\n", sect, dev->name);
807 /*-----------------------------------------------------------------------
808 * Write a word to Flash, returns:
811 * 2 - Flash not erased
813 static int write_word (flash_info_t * info, ulong dest, ulong data)
816 flash_dev_t *dev = getFlashDevFromInfo (info);
817 int addr = dest - info->start[0];
822 if (OK != flashWrite (dev, addr, (char *) &data, sizeof (ulong))) {
823 printf ("ERROR: could not write to addr=0x%x, data=0x%x\n",
824 (unsigned int) addr, (unsigned) data);
828 if ((addr % FLASH_SECTOR_SIZE) == 0)
832 PRINTF ("write_word:0x%x, base=0x%x, addr=0x%x, data=0x%x\n",
833 (unsigned) info->start[0],
835 (unsigned) (dest - info->start[0]), (unsigned) data);
841 /*-----------------------------------------------------------------------
842 * Copy memory to flash, returns:
845 * 2 - Flash not erased
848 int write_buff (flash_info_t * info, uchar * src, ulong addr, ulong cnt)
852 flash_dev_t *dev = getFlashDevFromInfo (info);
855 printf ("FLASH[%s]:", dev->name);
856 wp = (addr & ~3); /* get lower word aligned address */
859 * handle unaligned start bytes
861 if ((l = addr - wp) != 0) {
863 for (i = 0, cp = wp; i < l; ++i, ++cp) {
864 data = (data << 8) | (*(uchar *) cp);
866 for (; i < 4 && cnt > 0; ++i) {
867 data = (data << 8) | *src++;
871 for (; cnt == 0 && i < 4; ++i, ++cp) {
872 data = (data << 8) | (*(uchar *) cp);
874 if ((rc = write_word (info, wp, data)) != 0) {
881 * handle word aligned part
885 for (i = 0; i < 4; ++i) {
886 data = (data << 8) | *src++;
888 if ((rc = write_word (info, wp, data)) != 0) {
900 * handle unaligned tail bytes
903 for (i = 0, cp = wp; i < 4 && cnt > 0; ++i, ++cp) {
904 data = (data << 8) | *src++;
907 for (; i < 4; ++i, ++cp) {
908 data = (data << 8) | (*(uchar *) cp);
911 return (write_word (info, wp, data));
916 /*-----------------------------------------------------------------------