1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2002-2004
4 * Brad Kemp, Seranoa Networks, Brad.Kemp@seranoa.com
6 * Copyright (C) 2003 Arabella Software Ltd.
7 * Yuli Barcohen <yuli@arabellasw.com>
13 * Tolunay Orkun <listmember@orkun.us>
16 /* The DEBUG define must be before common to enable debugging */
24 #include <fdt_support.h>
25 #include <asm/processor.h>
27 #include <asm/byteorder.h>
28 #include <asm/unaligned.h>
29 #include <env_internal.h>
30 #include <mtd/cfi_flash.h>
34 * This file implements a Common Flash Interface (CFI) driver for
37 * The width of the port and the width of the chips are determined at
38 * initialization. These widths are used to calculate the address for
39 * access CFI data structures.
42 * JEDEC Standard JESD68 - Common Flash Interface (CFI)
43 * JEDEC Standard JEP137-A Common Flash Interface (CFI) ID Codes
44 * Intel Application Note 646 Common Flash Interface (CFI) and Command Sets
45 * Intel 290667-008 3 Volt Intel StrataFlash Memory datasheet
46 * AMD CFI Specification, Release 2.0 December 1, 2001
47 * AMD/Spansion Application Note: Migration from Single-byte to Three-byte
48 * Device IDs, Publication Number 25538 Revision A, November 8, 2001
50 * Define CONFIG_SYS_WRITE_SWAPPED_DATA, if you have to swap the Bytes between
51 * reading and writing ... (yes there is such a Hardware).
54 DECLARE_GLOBAL_DATA_PTR;
56 static uint flash_offset_cfi[2] = { FLASH_OFFSET_CFI, FLASH_OFFSET_CFI_ALT };
57 #ifdef CONFIG_FLASH_CFI_MTD
58 static uint flash_verbose = 1;
60 #define flash_verbose 1
63 flash_info_t flash_info[CFI_MAX_FLASH_BANKS]; /* FLASH chips info */
66 * Check if chip width is defined. If not, start detecting with 8bit.
68 #ifndef CONFIG_SYS_FLASH_CFI_WIDTH
69 #define CONFIG_SYS_FLASH_CFI_WIDTH FLASH_CFI_8BIT
72 #ifdef CONFIG_CFI_FLASH_USE_WEAK_ACCESSORS
73 #define __maybe_weak __weak
75 #define __maybe_weak static
79 * 0xffff is an undefined value for the configuration register. When
80 * this value is returned, the configuration register shall not be
81 * written at all (default mode).
83 static u16 cfi_flash_config_reg(int i)
85 #ifdef CONFIG_SYS_CFI_FLASH_CONFIG_REGS
86 return ((u16 [])CONFIG_SYS_CFI_FLASH_CONFIG_REGS)[i];
92 #if defined(CONFIG_SYS_MAX_FLASH_BANKS_DETECT)
93 int cfi_flash_num_flash_banks = CONFIG_SYS_MAX_FLASH_BANKS_DETECT;
95 int cfi_flash_num_flash_banks;
98 #ifdef CONFIG_CFI_FLASH /* for driver model */
99 static void cfi_flash_init_dm(void)
103 cfi_flash_num_flash_banks = 0;
105 * The uclass_first_device() will probe the first device and
106 * uclass_next_device() will probe the rest if they exist. So
107 * that cfi_flash_probe() will get called assigning the base
108 * addresses that are available.
110 for (uclass_first_device(UCLASS_MTD, &dev);
112 uclass_next_device(&dev)) {
116 phys_addr_t cfi_flash_bank_addr(int i)
118 return flash_info[i].base;
121 __weak phys_addr_t cfi_flash_bank_addr(int i)
123 return ((phys_addr_t [])CONFIG_SYS_FLASH_BANKS_LIST)[i];
127 __weak unsigned long cfi_flash_bank_size(int i)
129 #ifdef CONFIG_SYS_FLASH_BANKS_SIZES
130 return ((unsigned long [])CONFIG_SYS_FLASH_BANKS_SIZES)[i];
136 __maybe_weak void flash_write8(u8 value, void *addr)
138 __raw_writeb(value, addr);
141 __maybe_weak void flash_write16(u16 value, void *addr)
143 __raw_writew(value, addr);
146 __maybe_weak void flash_write32(u32 value, void *addr)
148 __raw_writel(value, addr);
151 __maybe_weak void flash_write64(u64 value, void *addr)
153 /* No architectures currently implement __raw_writeq() */
154 *(volatile u64 *)addr = value;
157 __maybe_weak u8 flash_read8(void *addr)
159 return __raw_readb(addr);
162 __maybe_weak u16 flash_read16(void *addr)
164 return __raw_readw(addr);
167 __maybe_weak u32 flash_read32(void *addr)
169 return __raw_readl(addr);
172 __maybe_weak u64 flash_read64(void *addr)
174 /* No architectures currently implement __raw_readq() */
175 return *(volatile u64 *)addr;
178 /*-----------------------------------------------------------------------
180 #if defined(CONFIG_ENV_IS_IN_FLASH) || defined(CONFIG_ENV_ADDR_REDUND) || \
181 (defined(CONFIG_SYS_MONITOR_BASE) && \
182 (CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE))
183 static flash_info_t *flash_get_info(ulong base)
188 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
189 info = &flash_info[i];
190 if (info->size && info->start[0] <= base &&
191 base <= info->start[0] + info->size - 1)
199 unsigned long flash_sector_size(flash_info_t *info, flash_sect_t sect)
201 if (sect != (info->sector_count - 1))
202 return info->start[sect + 1] - info->start[sect];
204 return info->start[0] + info->size - info->start[sect];
207 /*-----------------------------------------------------------------------
208 * create an address based on the offset and the port width
211 flash_map(flash_info_t *info, flash_sect_t sect, uint offset)
213 unsigned int byte_offset = offset * info->portwidth;
215 return (void *)(info->start[sect] + byte_offset);
218 static inline void flash_unmap(flash_info_t *info, flash_sect_t sect,
219 unsigned int offset, void *addr)
223 /*-----------------------------------------------------------------------
224 * make a proper sized command based on the port and chip widths
226 static void flash_make_cmd(flash_info_t *info, u32 cmd, void *cmdbuf)
231 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
232 u32 cmd_le = cpu_to_le32(cmd);
235 uchar *cp = (uchar *) cmdbuf;
237 for (i = info->portwidth; i > 0; i--) {
238 cword_offset = (info->portwidth - i) % info->chipwidth;
239 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
240 cp_offset = info->portwidth - i;
241 val = *((uchar *)&cmd_le + cword_offset);
244 val = *((uchar *)&cmd + sizeof(u32) - cword_offset - 1);
246 cp[cp_offset] = (cword_offset >= sizeof(u32)) ? 0x00 : val;
251 /*-----------------------------------------------------------------------
254 static void print_longlong(char *str, unsigned long long data)
260 for (i = 0; i < 8; i++)
261 sprintf(&str[i * 2], "%2.2x", *cp++);
264 static void flash_printqry(struct cfi_qry *qry)
269 for (x = 0; x < sizeof(struct cfi_qry); x += 16) {
271 for (y = 0; y < 16; y++)
272 debug("%2.2x ", p[x + y]);
274 for (y = 0; y < 16; y++) {
275 unsigned char c = p[x + y];
277 if (c >= 0x20 && c <= 0x7e)
287 /*-----------------------------------------------------------------------
288 * read a character at a port width address
290 static inline uchar flash_read_uchar(flash_info_t *info, uint offset)
295 cp = flash_map(info, 0, offset);
296 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
297 retval = flash_read8(cp);
299 retval = flash_read8(cp + info->portwidth - 1);
301 flash_unmap(info, 0, offset, cp);
305 /*-----------------------------------------------------------------------
306 * read a word at a port width address, assume 16bit bus
308 static inline ushort flash_read_word(flash_info_t *info, uint offset)
310 ushort *addr, retval;
312 addr = flash_map(info, 0, offset);
313 retval = flash_read16(addr);
314 flash_unmap(info, 0, offset, addr);
318 /*-----------------------------------------------------------------------
319 * read a long word by picking the least significant byte of each maximum
320 * port size word. Swap for ppc format.
322 static ulong flash_read_long (flash_info_t *info, flash_sect_t sect,
331 addr = flash_map(info, sect, offset);
334 debug("long addr is at %p info->portwidth = %d\n", addr,
336 for (x = 0; x < 4 * info->portwidth; x++)
337 debug("addr[%x] = 0x%x\n", x, flash_read8(addr + x));
339 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
340 retval = ((flash_read8(addr) << 16) |
341 (flash_read8(addr + info->portwidth) << 24) |
342 (flash_read8(addr + 2 * info->portwidth)) |
343 (flash_read8(addr + 3 * info->portwidth) << 8));
345 retval = ((flash_read8(addr + 2 * info->portwidth - 1) << 24) |
346 (flash_read8(addr + info->portwidth - 1) << 16) |
347 (flash_read8(addr + 4 * info->portwidth - 1) << 8) |
348 (flash_read8(addr + 3 * info->portwidth - 1)));
350 flash_unmap(info, sect, offset, addr);
356 * Write a proper sized command to the correct address
358 static void flash_write_cmd(flash_info_t *info, flash_sect_t sect,
359 uint offset, u32 cmd)
364 addr = flash_map(info, sect, offset);
365 flash_make_cmd(info, cmd, &cword);
366 switch (info->portwidth) {
368 debug("fwc addr %p cmd %x %x 8bit x %d bit\n", addr, cmd,
369 cword.w8, info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
370 flash_write8(cword.w8, addr);
372 case FLASH_CFI_16BIT:
373 debug("fwc addr %p cmd %x %4.4x 16bit x %d bit\n", addr,
375 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
376 flash_write16(cword.w16, addr);
378 case FLASH_CFI_32BIT:
379 debug("fwc addr %p cmd %x %8.8x 32bit x %d bit\n", addr,
381 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
382 flash_write32(cword.w32, addr);
384 case FLASH_CFI_64BIT:
389 print_longlong(str, cword.w64);
391 debug("fwrite addr %p cmd %x %s 64 bit x %d bit\n",
393 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
396 flash_write64(cword.w64, addr);
400 /* Ensure all the instructions are fully finished */
403 flash_unmap(info, sect, offset, addr);
406 static void flash_unlock_seq(flash_info_t *info, flash_sect_t sect)
408 flash_write_cmd(info, sect, info->addr_unlock1, AMD_CMD_UNLOCK_START);
409 flash_write_cmd(info, sect, info->addr_unlock2, AMD_CMD_UNLOCK_ACK);
412 /*-----------------------------------------------------------------------
414 static int flash_isequal(flash_info_t *info, flash_sect_t sect, uint offset,
421 addr = flash_map(info, sect, offset);
422 flash_make_cmd(info, cmd, &cword);
424 debug("is= cmd %x(%c) addr %p ", cmd, cmd, addr);
425 switch (info->portwidth) {
427 debug("is= %x %x\n", flash_read8(addr), cword.w8);
428 retval = (flash_read8(addr) == cword.w8);
430 case FLASH_CFI_16BIT:
431 debug("is= %4.4x %4.4x\n", flash_read16(addr), cword.w16);
432 retval = (flash_read16(addr) == cword.w16);
434 case FLASH_CFI_32BIT:
435 debug("is= %8.8x %8.8x\n", flash_read32(addr), cword.w32);
436 retval = (flash_read32(addr) == cword.w32);
438 case FLASH_CFI_64BIT:
444 print_longlong(str1, flash_read64(addr));
445 print_longlong(str2, cword.w64);
446 debug("is= %s %s\n", str1, str2);
449 retval = (flash_read64(addr) == cword.w64);
455 flash_unmap(info, sect, offset, addr);
460 /*-----------------------------------------------------------------------
462 static int flash_isset(flash_info_t *info, flash_sect_t sect, uint offset,
469 addr = flash_map(info, sect, offset);
470 flash_make_cmd(info, cmd, &cword);
471 switch (info->portwidth) {
473 retval = ((flash_read8(addr) & cword.w8) == cword.w8);
475 case FLASH_CFI_16BIT:
476 retval = ((flash_read16(addr) & cword.w16) == cword.w16);
478 case FLASH_CFI_32BIT:
479 retval = ((flash_read32(addr) & cword.w32) == cword.w32);
481 case FLASH_CFI_64BIT:
482 retval = ((flash_read64(addr) & cword.w64) == cword.w64);
488 flash_unmap(info, sect, offset, addr);
493 /*-----------------------------------------------------------------------
495 static int flash_toggle(flash_info_t *info, flash_sect_t sect, uint offset,
502 addr = flash_map(info, sect, offset);
503 flash_make_cmd(info, cmd, &cword);
504 switch (info->portwidth) {
506 retval = flash_read8(addr) != flash_read8(addr);
508 case FLASH_CFI_16BIT:
509 retval = flash_read16(addr) != flash_read16(addr);
511 case FLASH_CFI_32BIT:
512 retval = flash_read32(addr) != flash_read32(addr);
514 case FLASH_CFI_64BIT:
515 retval = ((flash_read32(addr) != flash_read32(addr)) ||
516 (flash_read32(addr + 4) != flash_read32(addr + 4)));
522 flash_unmap(info, sect, offset, addr);
528 * flash_is_busy - check to see if the flash is busy
530 * This routine checks the status of the chip and returns true if the
533 static int flash_is_busy(flash_info_t *info, flash_sect_t sect)
537 switch (info->vendor) {
538 case CFI_CMDSET_INTEL_PROG_REGIONS:
539 case CFI_CMDSET_INTEL_STANDARD:
540 case CFI_CMDSET_INTEL_EXTENDED:
541 retval = !flash_isset(info, sect, 0, FLASH_STATUS_DONE);
543 case CFI_CMDSET_AMD_STANDARD:
544 case CFI_CMDSET_AMD_EXTENDED:
545 #ifdef CONFIG_FLASH_CFI_LEGACY
546 case CFI_CMDSET_AMD_LEGACY:
548 if (info->sr_supported) {
549 flash_write_cmd(info, sect, info->addr_unlock1,
550 FLASH_CMD_READ_STATUS);
551 retval = !flash_isset(info, sect, 0,
554 retval = flash_toggle(info, sect, 0,
562 debug("%s: %d\n", __func__, retval);
566 /*-----------------------------------------------------------------------
567 * wait for XSR.7 to be set. Time out with an error if it does not.
568 * This routine does not set the flash to read-array mode.
570 static int flash_status_check(flash_info_t *info, flash_sect_t sector,
571 ulong tout, char *prompt)
575 #if CONFIG_SYS_HZ != 1000
576 /* Avoid overflow for large HZ */
577 if ((ulong)CONFIG_SYS_HZ > 100000)
578 tout *= (ulong)CONFIG_SYS_HZ / 1000;
580 tout = DIV_ROUND_UP(tout * (ulong)CONFIG_SYS_HZ, 1000);
583 /* Wait for command completion */
584 #ifdef CONFIG_SYS_LOW_RES_TIMER
587 start = get_timer(0);
589 while (flash_is_busy(info, sector)) {
590 if (get_timer(start) > tout) {
591 printf("Flash %s timeout at address %lx data %lx\n",
592 prompt, info->start[sector],
593 flash_read_long(info, sector, 0));
594 flash_write_cmd(info, sector, 0, info->cmd_reset);
598 udelay(1); /* also triggers watchdog */
603 /*-----------------------------------------------------------------------
604 * Wait for XSR.7 to be set, if it times out print an error, otherwise
605 * do a full status check.
607 * This routine sets the flash to read-array mode.
609 static int flash_full_status_check(flash_info_t *info, flash_sect_t sector,
610 ulong tout, char *prompt)
614 retcode = flash_status_check(info, sector, tout, prompt);
615 switch (info->vendor) {
616 case CFI_CMDSET_INTEL_PROG_REGIONS:
617 case CFI_CMDSET_INTEL_EXTENDED:
618 case CFI_CMDSET_INTEL_STANDARD:
619 if (retcode == ERR_OK &&
620 !flash_isset(info, sector, 0, FLASH_STATUS_DONE)) {
622 printf("Flash %s error at address %lx\n", prompt,
623 info->start[sector]);
624 if (flash_isset(info, sector, 0, FLASH_STATUS_ECLBS |
625 FLASH_STATUS_PSLBS)) {
626 puts("Command Sequence Error.\n");
627 } else if (flash_isset(info, sector, 0,
628 FLASH_STATUS_ECLBS)) {
629 puts("Block Erase Error.\n");
630 retcode = ERR_NOT_ERASED;
631 } else if (flash_isset(info, sector, 0,
632 FLASH_STATUS_PSLBS)) {
633 puts("Locking Error\n");
635 if (flash_isset(info, sector, 0, FLASH_STATUS_DPS)) {
636 puts("Block locked.\n");
637 retcode = ERR_PROTECTED;
639 if (flash_isset(info, sector, 0, FLASH_STATUS_VPENS))
640 puts("Vpp Low Error.\n");
642 flash_write_cmd(info, sector, 0, info->cmd_reset);
651 static int use_flash_status_poll(flash_info_t *info)
653 #ifdef CONFIG_SYS_CFI_FLASH_STATUS_POLL
654 if (info->vendor == CFI_CMDSET_AMD_EXTENDED ||
655 info->vendor == CFI_CMDSET_AMD_STANDARD)
661 static int flash_status_poll(flash_info_t *info, void *src, void *dst,
662 ulong tout, char *prompt)
664 #ifdef CONFIG_SYS_CFI_FLASH_STATUS_POLL
668 #if CONFIG_SYS_HZ != 1000
669 /* Avoid overflow for large HZ */
670 if ((ulong)CONFIG_SYS_HZ > 100000)
671 tout *= (ulong)CONFIG_SYS_HZ / 1000;
673 tout = DIV_ROUND_UP(tout * (ulong)CONFIG_SYS_HZ, 1000);
676 /* Wait for command completion */
677 #ifdef CONFIG_SYS_LOW_RES_TIMER
680 start = get_timer(0);
683 switch (info->portwidth) {
685 ready = flash_read8(dst) == flash_read8(src);
687 case FLASH_CFI_16BIT:
688 ready = flash_read16(dst) == flash_read16(src);
690 case FLASH_CFI_32BIT:
691 ready = flash_read32(dst) == flash_read32(src);
693 case FLASH_CFI_64BIT:
694 ready = flash_read64(dst) == flash_read64(src);
702 if (get_timer(start) > tout) {
703 printf("Flash %s timeout at address %lx data %lx\n",
704 prompt, (ulong)dst, (ulong)flash_read8(dst));
707 udelay(1); /* also triggers watchdog */
709 #endif /* CONFIG_SYS_CFI_FLASH_STATUS_POLL */
713 /*-----------------------------------------------------------------------
715 static void flash_add_byte(flash_info_t *info, cfiword_t *cword, uchar c)
717 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
720 unsigned long long ll;
723 switch (info->portwidth) {
727 case FLASH_CFI_16BIT:
728 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
731 cword->w16 = (cword->w16 >> 8) | w;
733 cword->w16 = (cword->w16 << 8) | c;
736 case FLASH_CFI_32BIT:
737 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
740 cword->w32 = (cword->w32 >> 8) | l;
742 cword->w32 = (cword->w32 << 8) | c;
745 case FLASH_CFI_64BIT:
746 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
749 cword->w64 = (cword->w64 >> 8) | ll;
751 cword->w64 = (cword->w64 << 8) | c;
758 * Loop through the sector table starting from the previously found sector.
759 * Searches forwards or backwards, dependent on the passed address.
761 static flash_sect_t find_sector(flash_info_t *info, ulong addr)
763 static flash_sect_t saved_sector; /* previously found sector */
764 static flash_info_t *saved_info; /* previously used flash bank */
765 flash_sect_t sector = saved_sector;
767 if (info != saved_info || sector >= info->sector_count)
770 while ((sector < info->sector_count - 1) &&
771 (info->start[sector] < addr))
773 while ((info->start[sector] > addr) && (sector > 0))
775 * also decrements the sector in case of an overshot
780 saved_sector = sector;
785 /*-----------------------------------------------------------------------
787 static int flash_write_cfiword(flash_info_t *info, ulong dest, cfiword_t cword)
789 void *dstaddr = (void *)dest;
791 flash_sect_t sect = 0;
794 /* Check if Flash is (sufficiently) erased */
795 switch (info->portwidth) {
797 flag = ((flash_read8(dstaddr) & cword.w8) == cword.w8);
799 case FLASH_CFI_16BIT:
800 flag = ((flash_read16(dstaddr) & cword.w16) == cword.w16);
802 case FLASH_CFI_32BIT:
803 flag = ((flash_read32(dstaddr) & cword.w32) == cword.w32);
805 case FLASH_CFI_64BIT:
806 flag = ((flash_read64(dstaddr) & cword.w64) == cword.w64);
813 return ERR_NOT_ERASED;
815 /* Disable interrupts which might cause a timeout here */
816 flag = disable_interrupts();
818 switch (info->vendor) {
819 case CFI_CMDSET_INTEL_PROG_REGIONS:
820 case CFI_CMDSET_INTEL_EXTENDED:
821 case CFI_CMDSET_INTEL_STANDARD:
822 flash_write_cmd(info, 0, 0, FLASH_CMD_CLEAR_STATUS);
823 flash_write_cmd(info, 0, 0, FLASH_CMD_WRITE);
825 case CFI_CMDSET_AMD_EXTENDED:
826 case CFI_CMDSET_AMD_STANDARD:
827 sect = find_sector(info, dest);
828 flash_unlock_seq(info, sect);
829 flash_write_cmd(info, sect, info->addr_unlock1, AMD_CMD_WRITE);
832 #ifdef CONFIG_FLASH_CFI_LEGACY
833 case CFI_CMDSET_AMD_LEGACY:
834 sect = find_sector(info, dest);
835 flash_unlock_seq(info, 0);
836 flash_write_cmd(info, 0, info->addr_unlock1, AMD_CMD_WRITE);
842 switch (info->portwidth) {
844 flash_write8(cword.w8, dstaddr);
846 case FLASH_CFI_16BIT:
847 flash_write16(cword.w16, dstaddr);
849 case FLASH_CFI_32BIT:
850 flash_write32(cword.w32, dstaddr);
852 case FLASH_CFI_64BIT:
853 flash_write64(cword.w64, dstaddr);
857 /* re-enable interrupts if necessary */
862 sect = find_sector(info, dest);
864 if (use_flash_status_poll(info))
865 return flash_status_poll(info, &cword, dstaddr,
866 info->write_tout, "write");
868 return flash_full_status_check(info, sect,
869 info->write_tout, "write");
872 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
874 static int flash_write_cfibuffer(flash_info_t *info, ulong dest, uchar *cp,
881 u8 *dst = (u8 *)dest;
888 switch (info->portwidth) {
892 case FLASH_CFI_16BIT:
895 case FLASH_CFI_32BIT:
898 case FLASH_CFI_64BIT:
908 while ((cnt-- > 0) && (flag == 1)) {
909 switch (info->portwidth) {
911 flag = ((flash_read8(dst2) & flash_read8(src)) ==
915 case FLASH_CFI_16BIT:
916 flag = ((flash_read16(dst2) & flash_read16(src)) ==
920 case FLASH_CFI_32BIT:
921 flag = ((flash_read32(dst2) & flash_read32(src)) ==
925 case FLASH_CFI_64BIT:
926 flag = ((flash_read64(dst2) & flash_read64(src)) ==
933 retcode = ERR_NOT_ERASED;
938 sector = find_sector(info, dest);
940 switch (info->vendor) {
941 case CFI_CMDSET_INTEL_PROG_REGIONS:
942 case CFI_CMDSET_INTEL_STANDARD:
943 case CFI_CMDSET_INTEL_EXTENDED:
944 write_cmd = (info->vendor == CFI_CMDSET_INTEL_PROG_REGIONS) ?
945 FLASH_CMD_WRITE_BUFFER_PROG :
946 FLASH_CMD_WRITE_TO_BUFFER;
947 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
948 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_STATUS);
949 flash_write_cmd(info, sector, 0, write_cmd);
950 retcode = flash_status_check(info, sector,
951 info->buffer_write_tout,
953 if (retcode == ERR_OK) {
954 /* reduce the number of loops by the width of
958 flash_write_cmd(info, sector, 0, cnt - 1);
960 switch (info->portwidth) {
962 flash_write8(flash_read8(src), dst);
965 case FLASH_CFI_16BIT:
966 flash_write16(flash_read16(src), dst);
969 case FLASH_CFI_32BIT:
970 flash_write32(flash_read32(src), dst);
973 case FLASH_CFI_64BIT:
974 flash_write64(flash_read64(src), dst);
982 flash_write_cmd(info, sector, 0,
983 FLASH_CMD_WRITE_BUFFER_CONFIRM);
984 retcode = flash_full_status_check(
985 info, sector, info->buffer_write_tout,
991 case CFI_CMDSET_AMD_STANDARD:
992 case CFI_CMDSET_AMD_EXTENDED:
993 flash_unlock_seq(info, sector);
995 #ifdef CONFIG_FLASH_SPANSION_S29WS_N
996 offset = ((unsigned long)dst - info->start[sector]) >> shift;
998 flash_write_cmd(info, sector, offset, AMD_CMD_WRITE_TO_BUFFER);
1000 flash_write_cmd(info, sector, offset, cnt - 1);
1002 switch (info->portwidth) {
1003 case FLASH_CFI_8BIT:
1005 flash_write8(flash_read8(src), dst);
1009 case FLASH_CFI_16BIT:
1011 flash_write16(flash_read16(src), dst);
1015 case FLASH_CFI_32BIT:
1017 flash_write32(flash_read32(src), dst);
1021 case FLASH_CFI_64BIT:
1023 flash_write64(flash_read64(src), dst);
1028 retcode = ERR_INVAL;
1032 flash_write_cmd(info, sector, 0, AMD_CMD_WRITE_BUFFER_CONFIRM);
1033 if (use_flash_status_poll(info))
1034 retcode = flash_status_poll(info, src - (1 << shift),
1036 info->buffer_write_tout,
1039 retcode = flash_full_status_check(info, sector,
1040 info->buffer_write_tout,
1045 debug("Unknown Command Set\n");
1046 retcode = ERR_INVAL;
1053 #endif /* CONFIG_SYS_FLASH_USE_BUFFER_WRITE */
1055 /*-----------------------------------------------------------------------
1057 int flash_erase(flash_info_t *info, int s_first, int s_last)
1064 if (info->flash_id != FLASH_MAN_CFI) {
1065 puts("Can't erase unknown flash type - aborted\n");
1068 if (s_first < 0 || s_first > s_last) {
1069 puts("- no sectors to erase\n");
1074 for (sect = s_first; sect <= s_last; ++sect)
1075 if (info->protect[sect])
1078 printf("- Warning: %d protected sectors will not be erased!\n",
1080 } else if (flash_verbose) {
1084 for (sect = s_first; sect <= s_last; sect++) {
1090 if (info->protect[sect] == 0) { /* not protected */
1091 #ifdef CONFIG_SYS_FLASH_CHECK_BLANK_BEFORE_ERASE
1098 * Check if whole sector is erased
1100 size = flash_sector_size(info, sect);
1102 flash = (u32 *)info->start[sect];
1103 /* divide by 4 for longword access */
1105 for (k = 0; k < size; k++) {
1106 if (flash_read32(flash++) != 0xffffffff) {
1117 switch (info->vendor) {
1118 case CFI_CMDSET_INTEL_PROG_REGIONS:
1119 case CFI_CMDSET_INTEL_STANDARD:
1120 case CFI_CMDSET_INTEL_EXTENDED:
1121 flash_write_cmd(info, sect, 0,
1122 FLASH_CMD_CLEAR_STATUS);
1123 flash_write_cmd(info, sect, 0,
1124 FLASH_CMD_BLOCK_ERASE);
1125 flash_write_cmd(info, sect, 0,
1126 FLASH_CMD_ERASE_CONFIRM);
1128 case CFI_CMDSET_AMD_STANDARD:
1129 case CFI_CMDSET_AMD_EXTENDED:
1130 flash_unlock_seq(info, sect);
1131 flash_write_cmd(info, sect,
1133 AMD_CMD_ERASE_START);
1134 flash_unlock_seq(info, sect);
1135 flash_write_cmd(info, sect, 0,
1136 info->cmd_erase_sector);
1138 #ifdef CONFIG_FLASH_CFI_LEGACY
1139 case CFI_CMDSET_AMD_LEGACY:
1140 flash_unlock_seq(info, 0);
1141 flash_write_cmd(info, 0, info->addr_unlock1,
1142 AMD_CMD_ERASE_START);
1143 flash_unlock_seq(info, 0);
1144 flash_write_cmd(info, sect, 0,
1145 AMD_CMD_ERASE_SECTOR);
1149 debug("Unknown flash vendor %d\n",
1154 if (use_flash_status_poll(info)) {
1158 cword.w64 = 0xffffffffffffffffULL;
1159 dest = flash_map(info, sect, 0);
1160 st = flash_status_poll(info, &cword, dest,
1161 info->erase_blk_tout,
1163 flash_unmap(info, sect, 0, dest);
1165 st = flash_full_status_check(info, sect,
1166 info->erase_blk_tout,
1172 else if (flash_verbose)
1183 #ifdef CONFIG_SYS_FLASH_EMPTY_INFO
1184 static int sector_erased(flash_info_t *info, int i)
1191 * Check if whole sector is erased
1193 size = flash_sector_size(info, i);
1194 flash = (u32 *)info->start[i];
1195 /* divide by 4 for longword access */
1198 for (k = 0; k < size; k++) {
1199 if (flash_read32(flash++) != 0xffffffff)
1200 return 0; /* not erased */
1203 return 1; /* erased */
1205 #endif /* CONFIG_SYS_FLASH_EMPTY_INFO */
1207 void flash_print_info(flash_info_t *info)
1211 if (info->flash_id != FLASH_MAN_CFI) {
1212 puts("missing or unknown FLASH type\n");
1216 printf("%s flash (%d x %d)",
1218 (info->portwidth << 3), (info->chipwidth << 3));
1219 if (info->size < 1024 * 1024)
1220 printf(" Size: %ld kB in %d Sectors\n",
1221 info->size >> 10, info->sector_count);
1223 printf(" Size: %ld MB in %d Sectors\n",
1224 info->size >> 20, info->sector_count);
1226 switch (info->vendor) {
1227 case CFI_CMDSET_INTEL_PROG_REGIONS:
1228 printf("Intel Prog Regions");
1230 case CFI_CMDSET_INTEL_STANDARD:
1231 printf("Intel Standard");
1233 case CFI_CMDSET_INTEL_EXTENDED:
1234 printf("Intel Extended");
1236 case CFI_CMDSET_AMD_STANDARD:
1237 printf("AMD Standard");
1239 case CFI_CMDSET_AMD_EXTENDED:
1240 printf("AMD Extended");
1242 #ifdef CONFIG_FLASH_CFI_LEGACY
1243 case CFI_CMDSET_AMD_LEGACY:
1244 printf("AMD Legacy");
1248 printf("Unknown (%d)", info->vendor);
1251 printf(" command set, Manufacturer ID: 0x%02X, Device ID: 0x",
1252 info->manufacturer_id);
1253 printf(info->chipwidth == FLASH_CFI_16BIT ? "%04X" : "%02X",
1255 if ((info->device_id & 0xff) == 0x7E) {
1256 printf(info->chipwidth == FLASH_CFI_16BIT ? "%04X" : "%02X",
1259 if (info->vendor == CFI_CMDSET_AMD_STANDARD && info->legacy_unlock)
1260 printf("\n Advanced Sector Protection (PPB) enabled");
1261 printf("\n Erase timeout: %ld ms, write timeout: %ld ms\n",
1262 info->erase_blk_tout, info->write_tout);
1263 if (info->buffer_size > 1) {
1264 printf(" Buffer write timeout: %ld ms, ",
1265 info->buffer_write_tout);
1266 printf("buffer size: %d bytes\n", info->buffer_size);
1269 puts("\n Sector Start Addresses:");
1270 for (i = 0; i < info->sector_count; ++i) {
1275 #ifdef CONFIG_SYS_FLASH_EMPTY_INFO
1276 /* print empty and read-only info */
1277 printf(" %08lX %c %s ",
1279 sector_erased(info, i) ? 'E' : ' ',
1280 info->protect[i] ? "RO" : " ");
1281 #else /* ! CONFIG_SYS_FLASH_EMPTY_INFO */
1282 printf(" %08lX %s ",
1284 info->protect[i] ? "RO" : " ");
1290 /*-----------------------------------------------------------------------
1291 * This is used in a few places in write_buf() to show programming
1292 * progress. Making it a function is nasty because it needs to do side
1293 * effect updates to digit and dots. Repeated code is nasty too, so
1294 * we define it once here.
1296 #ifdef CONFIG_FLASH_SHOW_PROGRESS
1297 #define FLASH_SHOW_PROGRESS(scale, dots, digit, dots_sub) \
1298 if (flash_verbose) { \
1300 if (scale > 0 && dots <= 0) { \
1301 if ((digit % 5) == 0) \
1302 printf("%d", digit / 5); \
1310 #define FLASH_SHOW_PROGRESS(scale, dots, digit, dots_sub)
1313 /*-----------------------------------------------------------------------
1314 * Copy memory to flash, returns:
1317 * 2 - Flash not erased
1319 int write_buff(flash_info_t *info, uchar *src, ulong addr, ulong cnt)
1326 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
1329 #ifdef CONFIG_FLASH_SHOW_PROGRESS
1330 int digit = CONFIG_FLASH_SHOW_PROGRESS;
1335 * Suppress if there are fewer than CONFIG_FLASH_SHOW_PROGRESS writes.
1337 if (cnt >= CONFIG_FLASH_SHOW_PROGRESS) {
1338 scale = (int)((cnt + CONFIG_FLASH_SHOW_PROGRESS - 1) /
1339 CONFIG_FLASH_SHOW_PROGRESS);
1343 /* get lower aligned address */
1344 wp = (addr & ~(info->portwidth - 1));
1346 /* handle unaligned start */
1351 for (i = 0; i < aln; ++i)
1352 flash_add_byte(info, &cword, flash_read8(p + i));
1354 for (; (i < info->portwidth) && (cnt > 0); i++) {
1355 flash_add_byte(info, &cword, *src++);
1358 for (; (cnt == 0) && (i < info->portwidth); ++i)
1359 flash_add_byte(info, &cword, flash_read8(p + i));
1361 rc = flash_write_cfiword(info, wp, cword);
1366 FLASH_SHOW_PROGRESS(scale, dots, digit, i);
1369 /* handle the aligned part */
1370 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
1371 buffered_size = (info->portwidth / info->chipwidth);
1372 buffered_size *= info->buffer_size;
1373 while (cnt >= info->portwidth) {
1374 /* prohibit buffer write when buffer_size is 1 */
1375 if (info->buffer_size == 1) {
1377 for (i = 0; i < info->portwidth; i++)
1378 flash_add_byte(info, &cword, *src++);
1379 rc = flash_write_cfiword(info, wp, cword);
1382 wp += info->portwidth;
1383 cnt -= info->portwidth;
1387 /* write buffer until next buffered_size aligned boundary */
1388 i = buffered_size - (wp % buffered_size);
1391 rc = flash_write_cfibuffer(info, wp, src, i);
1394 i -= i & (info->portwidth - 1);
1398 FLASH_SHOW_PROGRESS(scale, dots, digit, i);
1399 /* Only check every once in a while */
1400 if ((cnt & 0xFFFF) < buffered_size && ctrlc())
1404 while (cnt >= info->portwidth) {
1406 for (i = 0; i < info->portwidth; i++)
1407 flash_add_byte(info, &cword, *src++);
1408 rc = flash_write_cfiword(info, wp, cword);
1411 wp += info->portwidth;
1412 cnt -= info->portwidth;
1413 FLASH_SHOW_PROGRESS(scale, dots, digit, info->portwidth);
1414 /* Only check every once in a while */
1415 if ((cnt & 0xFFFF) < info->portwidth && ctrlc())
1418 #endif /* CONFIG_SYS_FLASH_USE_BUFFER_WRITE */
1424 * handle unaligned tail bytes
1428 for (i = 0; (i < info->portwidth) && (cnt > 0); ++i) {
1429 flash_add_byte(info, &cword, *src++);
1432 for (; i < info->portwidth; ++i)
1433 flash_add_byte(info, &cword, flash_read8(p + i));
1435 return flash_write_cfiword(info, wp, cword);
1438 static inline int manufact_match(flash_info_t *info, u32 manu)
1440 return info->manufacturer_id == ((manu & FLASH_VENDMASK) >> 16);
1443 /*-----------------------------------------------------------------------
1445 #ifdef CONFIG_SYS_FLASH_PROTECTION
1447 static int cfi_protect_bugfix(flash_info_t *info, long sector, int prot)
1449 if (manufact_match(info, INTEL_MANUFACT) &&
1450 info->device_id == NUMONYX_256MBIT) {
1453 * "Numonyx Axcell P33/P30 Specification Update" :)
1455 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_ID);
1456 if (!flash_isequal(info, sector, FLASH_OFFSET_PROTECT,
1459 * cmd must come before FLASH_CMD_PROTECT + 20us
1460 * Disable interrupts which might cause a timeout here.
1462 int flag = disable_interrupts();
1466 cmd = FLASH_CMD_PROTECT_SET;
1468 cmd = FLASH_CMD_PROTECT_CLEAR;
1470 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT);
1471 flash_write_cmd(info, sector, 0, cmd);
1472 /* re-enable interrupts if necessary */
1474 enable_interrupts();
1481 int flash_real_protect(flash_info_t *info, long sector, int prot)
1485 switch (info->vendor) {
1486 case CFI_CMDSET_INTEL_PROG_REGIONS:
1487 case CFI_CMDSET_INTEL_STANDARD:
1488 case CFI_CMDSET_INTEL_EXTENDED:
1489 if (!cfi_protect_bugfix(info, sector, prot)) {
1490 flash_write_cmd(info, sector, 0,
1491 FLASH_CMD_CLEAR_STATUS);
1492 flash_write_cmd(info, sector, 0,
1495 flash_write_cmd(info, sector, 0,
1496 FLASH_CMD_PROTECT_SET);
1498 flash_write_cmd(info, sector, 0,
1499 FLASH_CMD_PROTECT_CLEAR);
1502 case CFI_CMDSET_AMD_EXTENDED:
1503 case CFI_CMDSET_AMD_STANDARD:
1504 /* U-Boot only checks the first byte */
1505 if (manufact_match(info, ATM_MANUFACT)) {
1507 flash_unlock_seq(info, 0);
1508 flash_write_cmd(info, 0,
1510 ATM_CMD_SOFTLOCK_START);
1511 flash_unlock_seq(info, 0);
1512 flash_write_cmd(info, sector, 0,
1515 flash_write_cmd(info, 0,
1517 AMD_CMD_UNLOCK_START);
1518 if (info->device_id == ATM_ID_BV6416)
1519 flash_write_cmd(info, sector,
1520 0, ATM_CMD_UNLOCK_SECT);
1523 if (info->legacy_unlock) {
1524 int flag = disable_interrupts();
1527 flash_unlock_seq(info, 0);
1528 flash_write_cmd(info, 0, info->addr_unlock1,
1529 AMD_CMD_SET_PPB_ENTRY);
1530 lock_flag = flash_isset(info, sector, 0, 0x01);
1533 flash_write_cmd(info, sector, 0,
1534 AMD_CMD_PPB_LOCK_BC1);
1535 flash_write_cmd(info, sector, 0,
1536 AMD_CMD_PPB_LOCK_BC2);
1538 debug("sector %ld %slocked\n", sector,
1539 lock_flag ? "" : "already ");
1542 debug("unlock %ld\n", sector);
1543 flash_write_cmd(info, 0, 0,
1544 AMD_CMD_PPB_UNLOCK_BC1);
1545 flash_write_cmd(info, 0, 0,
1546 AMD_CMD_PPB_UNLOCK_BC2);
1548 debug("sector %ld %sunlocked\n", sector,
1549 !lock_flag ? "" : "already ");
1552 enable_interrupts();
1554 if (flash_status_check(info, sector,
1555 info->erase_blk_tout,
1556 prot ? "protect" : "unprotect"))
1557 printf("status check error\n");
1559 flash_write_cmd(info, 0, 0,
1560 AMD_CMD_SET_PPB_EXIT_BC1);
1561 flash_write_cmd(info, 0, 0,
1562 AMD_CMD_SET_PPB_EXIT_BC2);
1565 #ifdef CONFIG_FLASH_CFI_LEGACY
1566 case CFI_CMDSET_AMD_LEGACY:
1567 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
1568 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT);
1570 flash_write_cmd(info, sector, 0,
1571 FLASH_CMD_PROTECT_SET);
1573 flash_write_cmd(info, sector, 0,
1574 FLASH_CMD_PROTECT_CLEAR);
1579 * Flash needs to be in status register read mode for
1580 * flash_full_status_check() to work correctly
1582 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_STATUS);
1583 retcode = flash_full_status_check(info, sector, info->erase_blk_tout,
1584 prot ? "protect" : "unprotect");
1586 info->protect[sector] = prot;
1589 * On some of Intel's flash chips (marked via legacy_unlock)
1590 * unprotect unprotects all locking.
1592 if (prot == 0 && info->legacy_unlock) {
1595 for (i = 0; i < info->sector_count; i++) {
1596 if (info->protect[i])
1597 flash_real_protect(info, i, 1);
1604 /*-----------------------------------------------------------------------
1605 * flash_read_user_serial - read the OneTimeProgramming cells
1607 void flash_read_user_serial(flash_info_t *info, void *buffer, int offset,
1614 src = flash_map(info, 0, FLASH_OFFSET_USER_PROTECTION);
1615 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1616 memcpy(dst, src + offset, len);
1617 flash_write_cmd(info, 0, 0, info->cmd_reset);
1619 flash_unmap(info, 0, FLASH_OFFSET_USER_PROTECTION, src);
1623 * flash_read_factory_serial - read the device Id from the protection area
1625 void flash_read_factory_serial(flash_info_t *info, void *buffer, int offset,
1630 src = flash_map(info, 0, FLASH_OFFSET_INTEL_PROTECTION);
1631 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1632 memcpy(buffer, src + offset, len);
1633 flash_write_cmd(info, 0, 0, info->cmd_reset);
1635 flash_unmap(info, 0, FLASH_OFFSET_INTEL_PROTECTION, src);
1638 #endif /* CONFIG_SYS_FLASH_PROTECTION */
1640 /*-----------------------------------------------------------------------
1641 * Reverse the order of the erase regions in the CFI QRY structure.
1642 * This is needed for chips that are either a) correctly detected as
1643 * top-boot, or b) buggy.
1645 static void cfi_reverse_geometry(struct cfi_qry *qry)
1650 for (i = 0, j = qry->num_erase_regions - 1; i < j; i++, j--) {
1651 tmp = get_unaligned(&qry->erase_region_info[i]);
1652 put_unaligned(get_unaligned(&qry->erase_region_info[j]),
1653 &qry->erase_region_info[i]);
1654 put_unaligned(tmp, &qry->erase_region_info[j]);
1658 /*-----------------------------------------------------------------------
1659 * read jedec ids from device and set corresponding fields in info struct
1661 * Note: assume cfi->vendor, cfi->portwidth and cfi->chipwidth are correct
1664 static void cmdset_intel_read_jedec_ids(flash_info_t *info)
1666 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1668 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1669 udelay(1000); /* some flash are slow to respond */
1670 info->manufacturer_id = flash_read_uchar(info,
1671 FLASH_OFFSET_MANUFACTURER_ID);
1672 info->device_id = (info->chipwidth == FLASH_CFI_16BIT) ?
1673 flash_read_word(info, FLASH_OFFSET_DEVICE_ID) :
1674 flash_read_uchar(info, FLASH_OFFSET_DEVICE_ID);
1675 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1678 static int cmdset_intel_init(flash_info_t *info, struct cfi_qry *qry)
1680 info->cmd_reset = FLASH_CMD_RESET;
1682 cmdset_intel_read_jedec_ids(info);
1683 flash_write_cmd(info, 0, info->cfi_offset, FLASH_CMD_CFI);
1685 #ifdef CONFIG_SYS_FLASH_PROTECTION
1686 /* read legacy lock/unlock bit from intel flash */
1687 if (info->ext_addr) {
1688 info->legacy_unlock =
1689 flash_read_uchar(info, info->ext_addr + 5) & 0x08;
1696 static void cmdset_amd_read_jedec_ids(flash_info_t *info)
1702 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1703 flash_unlock_seq(info, 0);
1704 flash_write_cmd(info, 0, info->addr_unlock1, FLASH_CMD_READ_ID);
1705 udelay(1000); /* some flash are slow to respond */
1707 manu_id = flash_read_uchar(info, FLASH_OFFSET_MANUFACTURER_ID);
1708 /* JEDEC JEP106Z specifies ID codes up to bank 7 */
1709 while (manu_id == FLASH_CONTINUATION_CODE && bank_id < 0x800) {
1711 manu_id = flash_read_uchar(info,
1712 bank_id | FLASH_OFFSET_MANUFACTURER_ID);
1714 info->manufacturer_id = manu_id;
1716 debug("info->ext_addr = 0x%x, cfi_version = 0x%x\n",
1717 info->ext_addr, info->cfi_version);
1718 if (info->ext_addr && info->cfi_version >= 0x3134) {
1719 /* read software feature (at 0x53) */
1720 feature = flash_read_uchar(info, info->ext_addr + 0x13);
1721 debug("feature = 0x%x\n", feature);
1722 info->sr_supported = feature & 0x1;
1725 switch (info->chipwidth) {
1726 case FLASH_CFI_8BIT:
1727 info->device_id = flash_read_uchar(info,
1728 FLASH_OFFSET_DEVICE_ID);
1729 if (info->device_id == 0x7E) {
1730 /* AMD 3-byte (expanded) device ids */
1731 info->device_id2 = flash_read_uchar(info,
1732 FLASH_OFFSET_DEVICE_ID2);
1733 info->device_id2 <<= 8;
1734 info->device_id2 |= flash_read_uchar(info,
1735 FLASH_OFFSET_DEVICE_ID3);
1738 case FLASH_CFI_16BIT:
1739 info->device_id = flash_read_word(info,
1740 FLASH_OFFSET_DEVICE_ID);
1741 if ((info->device_id & 0xff) == 0x7E) {
1742 /* AMD 3-byte (expanded) device ids */
1743 info->device_id2 = flash_read_uchar(info,
1744 FLASH_OFFSET_DEVICE_ID2);
1745 info->device_id2 <<= 8;
1746 info->device_id2 |= flash_read_uchar(info,
1747 FLASH_OFFSET_DEVICE_ID3);
1753 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1757 static int cmdset_amd_init(flash_info_t *info, struct cfi_qry *qry)
1759 info->cmd_reset = AMD_CMD_RESET;
1760 info->cmd_erase_sector = AMD_CMD_ERASE_SECTOR;
1762 cmdset_amd_read_jedec_ids(info);
1763 flash_write_cmd(info, 0, info->cfi_offset, FLASH_CMD_CFI);
1765 #ifdef CONFIG_SYS_FLASH_PROTECTION
1766 if (info->ext_addr) {
1767 /* read sector protect/unprotect scheme (at 0x49) */
1768 if (flash_read_uchar(info, info->ext_addr + 9) == 0x8)
1769 info->legacy_unlock = 1;
1776 #ifdef CONFIG_FLASH_CFI_LEGACY
1777 static void flash_read_jedec_ids(flash_info_t *info)
1779 info->manufacturer_id = 0;
1780 info->device_id = 0;
1781 info->device_id2 = 0;
1783 switch (info->vendor) {
1784 case CFI_CMDSET_INTEL_PROG_REGIONS:
1785 case CFI_CMDSET_INTEL_STANDARD:
1786 case CFI_CMDSET_INTEL_EXTENDED:
1787 cmdset_intel_read_jedec_ids(info);
1789 case CFI_CMDSET_AMD_STANDARD:
1790 case CFI_CMDSET_AMD_EXTENDED:
1791 cmdset_amd_read_jedec_ids(info);
1798 /*-----------------------------------------------------------------------
1799 * Call board code to request info about non-CFI flash.
1800 * board_flash_get_legacy needs to fill in at least:
1801 * info->portwidth, info->chipwidth and info->interface for Jedec probing.
1803 static int flash_detect_legacy(phys_addr_t base, int banknum)
1805 flash_info_t *info = &flash_info[banknum];
1807 if (board_flash_get_legacy(base, banknum, info)) {
1808 /* board code may have filled info completely. If not, we
1809 * use JEDEC ID probing.
1811 if (!info->vendor) {
1813 CFI_CMDSET_AMD_STANDARD,
1814 CFI_CMDSET_INTEL_STANDARD
1818 for (i = 0; i < ARRAY_SIZE(modes); i++) {
1819 info->vendor = modes[i];
1821 (ulong)map_physmem(base,
1824 if (info->portwidth == FLASH_CFI_8BIT &&
1825 info->interface == FLASH_CFI_X8X16) {
1826 info->addr_unlock1 = 0x2AAA;
1827 info->addr_unlock2 = 0x5555;
1829 info->addr_unlock1 = 0x5555;
1830 info->addr_unlock2 = 0x2AAA;
1832 flash_read_jedec_ids(info);
1833 debug("JEDEC PROBE: ID %x %x %x\n",
1834 info->manufacturer_id,
1837 if (jedec_flash_match(info, info->start[0]))
1840 unmap_physmem((void *)info->start[0],
1845 switch (info->vendor) {
1846 case CFI_CMDSET_INTEL_PROG_REGIONS:
1847 case CFI_CMDSET_INTEL_STANDARD:
1848 case CFI_CMDSET_INTEL_EXTENDED:
1849 info->cmd_reset = FLASH_CMD_RESET;
1851 case CFI_CMDSET_AMD_STANDARD:
1852 case CFI_CMDSET_AMD_EXTENDED:
1853 case CFI_CMDSET_AMD_LEGACY:
1854 info->cmd_reset = AMD_CMD_RESET;
1857 info->flash_id = FLASH_MAN_CFI;
1860 return 0; /* use CFI */
1863 static inline int flash_detect_legacy(phys_addr_t base, int banknum)
1865 return 0; /* use CFI */
1869 /*-----------------------------------------------------------------------
1870 * detect if flash is compatible with the Common Flash Interface (CFI)
1871 * http://www.jedec.org/download/search/jesd68.pdf
1873 static void flash_read_cfi(flash_info_t *info, void *buf, unsigned int start,
1879 for (i = 0; i < len; i++)
1880 p[i] = flash_read_uchar(info, start + i);
1883 static void __flash_cmd_reset(flash_info_t *info)
1886 * We do not yet know what kind of commandset to use, so we issue
1887 * the reset command in both Intel and AMD variants, in the hope
1888 * that AMD flash roms ignore the Intel command.
1890 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1892 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1895 void flash_cmd_reset(flash_info_t *info)
1896 __attribute__((weak, alias("__flash_cmd_reset")));
1898 static int __flash_detect_cfi(flash_info_t *info, struct cfi_qry *qry)
1902 /* Issue FLASH reset command */
1903 flash_cmd_reset(info);
1905 for (cfi_offset = 0; cfi_offset < ARRAY_SIZE(flash_offset_cfi);
1907 flash_write_cmd(info, 0, flash_offset_cfi[cfi_offset],
1909 if (flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP, 'Q') &&
1910 flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 1, 'R') &&
1911 flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 2, 'Y')) {
1912 flash_read_cfi(info, qry, FLASH_OFFSET_CFI_RESP,
1913 sizeof(struct cfi_qry));
1914 info->interface = le16_to_cpu(qry->interface_desc);
1916 info->cfi_offset = flash_offset_cfi[cfi_offset];
1917 debug("device interface is %d\n",
1919 debug("found port %d chip %d ",
1920 info->portwidth, info->chipwidth);
1921 debug("port %d bits chip %d bits\n",
1922 info->portwidth << CFI_FLASH_SHIFT_WIDTH,
1923 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
1925 /* calculate command offsets as in the Linux driver */
1926 info->addr_unlock1 = 0x555;
1927 info->addr_unlock2 = 0x2aa;
1930 * modify the unlock address if we are
1931 * in compatibility mode
1933 if (/* x8/x16 in x8 mode */
1934 (info->chipwidth == FLASH_CFI_BY8 &&
1935 info->interface == FLASH_CFI_X8X16) ||
1936 /* x16/x32 in x16 mode */
1937 (info->chipwidth == FLASH_CFI_BY16 &&
1938 info->interface == FLASH_CFI_X16X32)) {
1939 info->addr_unlock1 = 0xaaa;
1940 info->addr_unlock2 = 0x555;
1943 info->name = "CFI conformant";
1951 static int flash_detect_cfi(flash_info_t *info, struct cfi_qry *qry)
1953 debug("flash detect cfi\n");
1955 for (info->portwidth = CONFIG_SYS_FLASH_CFI_WIDTH;
1956 info->portwidth <= FLASH_CFI_64BIT; info->portwidth <<= 1) {
1957 for (info->chipwidth = FLASH_CFI_BY8;
1958 info->chipwidth <= info->portwidth;
1959 info->chipwidth <<= 1)
1960 if (__flash_detect_cfi(info, qry))
1963 debug("not found\n");
1968 * Manufacturer-specific quirks. Add workarounds for geometry
1969 * reversal, etc. here.
1971 static void flash_fixup_amd(flash_info_t *info, struct cfi_qry *qry)
1973 /* check if flash geometry needs reversal */
1974 if (qry->num_erase_regions > 1) {
1975 /* reverse geometry if top boot part */
1976 if (info->cfi_version < 0x3131) {
1977 /* CFI < 1.1, try to guess from device id */
1978 if ((info->device_id & 0x80) != 0)
1979 cfi_reverse_geometry(qry);
1980 } else if (flash_read_uchar(info, info->ext_addr + 0xf) == 3) {
1981 /* CFI >= 1.1, deduct from top/bottom flag */
1982 /* note: ext_addr is valid since cfi_version > 0 */
1983 cfi_reverse_geometry(qry);
1988 static void flash_fixup_atmel(flash_info_t *info, struct cfi_qry *qry)
1990 int reverse_geometry = 0;
1992 /* Check the "top boot" bit in the PRI */
1993 if (info->ext_addr && !(flash_read_uchar(info, info->ext_addr + 6) & 1))
1994 reverse_geometry = 1;
1996 /* AT49BV6416(T) list the erase regions in the wrong order.
1997 * However, the device ID is identical with the non-broken
1998 * AT49BV642D they differ in the high byte.
2000 if (info->device_id == 0xd6 || info->device_id == 0xd2)
2001 reverse_geometry = !reverse_geometry;
2003 if (reverse_geometry)
2004 cfi_reverse_geometry(qry);
2007 static void flash_fixup_stm(flash_info_t *info, struct cfi_qry *qry)
2009 /* check if flash geometry needs reversal */
2010 if (qry->num_erase_regions > 1) {
2011 /* reverse geometry if top boot part */
2012 if (info->cfi_version < 0x3131) {
2013 /* CFI < 1.1, guess by device id */
2014 if (info->device_id == 0x22CA || /* M29W320DT */
2015 info->device_id == 0x2256 || /* M29W320ET */
2016 info->device_id == 0x22D7) { /* M29W800DT */
2017 cfi_reverse_geometry(qry);
2019 } else if (flash_read_uchar(info, info->ext_addr + 0xf) == 3) {
2020 /* CFI >= 1.1, deduct from top/bottom flag */
2021 /* note: ext_addr is valid since cfi_version > 0 */
2022 cfi_reverse_geometry(qry);
2027 static void flash_fixup_sst(flash_info_t *info, struct cfi_qry *qry)
2030 * SST, for many recent nor parallel flashes, says they are
2031 * CFI-conformant. This is not true, since qry struct.
2032 * reports a std. AMD command set (0x0002), while SST allows to
2033 * erase two different sector sizes for the same memory.
2034 * 64KB sector (SST call it block) needs 0x30 to be erased.
2035 * 4KB sector (SST call it sector) needs 0x50 to be erased.
2036 * Since CFI query detect the 4KB number of sectors, users expects
2037 * a sector granularity of 4KB, and it is here set.
2039 if (info->device_id == 0x5D23 || /* SST39VF3201B */
2040 info->device_id == 0x5C23) { /* SST39VF3202B */
2041 /* set sector granularity to 4KB */
2042 info->cmd_erase_sector = 0x50;
2046 static void flash_fixup_num(flash_info_t *info, struct cfi_qry *qry)
2049 * The M29EW devices seem to report the CFI information wrong
2050 * when it's in 8 bit mode.
2051 * There's an app note from Numonyx on this issue.
2052 * So adjust the buffer size for M29EW while operating in 8-bit mode
2054 if (qry->max_buf_write_size > 0x8 &&
2055 info->device_id == 0x7E &&
2056 (info->device_id2 == 0x2201 ||
2057 info->device_id2 == 0x2301 ||
2058 info->device_id2 == 0x2801 ||
2059 info->device_id2 == 0x4801)) {
2060 debug("Adjusted buffer size on Numonyx flash");
2061 debug(" M29EW family in 8 bit mode\n");
2062 qry->max_buf_write_size = 0x8;
2067 * The following code cannot be run from FLASH!
2070 ulong flash_get_size(phys_addr_t base, int banknum)
2072 flash_info_t *info = &flash_info[banknum];
2074 flash_sect_t sect_cnt;
2078 uchar num_erase_regions;
2079 int erase_region_size;
2080 int erase_region_count;
2082 unsigned long max_size;
2084 memset(&qry, 0, sizeof(qry));
2087 info->cfi_version = 0;
2088 #ifdef CONFIG_SYS_FLASH_PROTECTION
2089 info->legacy_unlock = 0;
2092 info->start[0] = (ulong)map_physmem(base, info->portwidth, MAP_NOCACHE);
2094 if (flash_detect_cfi(info, &qry)) {
2095 info->vendor = le16_to_cpu(get_unaligned(&qry.p_id));
2096 info->ext_addr = le16_to_cpu(get_unaligned(&qry.p_adr));
2097 num_erase_regions = qry.num_erase_regions;
2099 if (info->ext_addr) {
2100 info->cfi_version = (ushort)flash_read_uchar(info,
2101 info->ext_addr + 3) << 8;
2102 info->cfi_version |= (ushort)flash_read_uchar(info,
2103 info->ext_addr + 4);
2107 flash_printqry(&qry);
2110 switch (info->vendor) {
2111 case CFI_CMDSET_INTEL_PROG_REGIONS:
2112 case CFI_CMDSET_INTEL_STANDARD:
2113 case CFI_CMDSET_INTEL_EXTENDED:
2114 cmdset_intel_init(info, &qry);
2116 case CFI_CMDSET_AMD_STANDARD:
2117 case CFI_CMDSET_AMD_EXTENDED:
2118 cmdset_amd_init(info, &qry);
2121 printf("CFI: Unknown command set 0x%x\n",
2124 * Unfortunately, this means we don't know how
2125 * to get the chip back to Read mode. Might
2126 * as well try an Intel-style reset...
2128 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
2132 /* Do manufacturer-specific fixups */
2133 switch (info->manufacturer_id) {
2134 case 0x0001: /* AMD */
2135 case 0x0037: /* AMIC */
2136 flash_fixup_amd(info, &qry);
2139 flash_fixup_atmel(info, &qry);
2142 flash_fixup_stm(info, &qry);
2144 case 0x00bf: /* SST */
2145 flash_fixup_sst(info, &qry);
2147 case 0x0089: /* Numonyx */
2148 flash_fixup_num(info, &qry);
2152 debug("manufacturer is %d\n", info->vendor);
2153 debug("manufacturer id is 0x%x\n", info->manufacturer_id);
2154 debug("device id is 0x%x\n", info->device_id);
2155 debug("device id2 is 0x%x\n", info->device_id2);
2156 debug("cfi version is 0x%04x\n", info->cfi_version);
2158 size_ratio = info->portwidth / info->chipwidth;
2159 /* if the chip is x8/x16 reduce the ratio by half */
2160 if (info->interface == FLASH_CFI_X8X16 &&
2161 info->chipwidth == FLASH_CFI_BY8) {
2164 debug("size_ratio %d port %d bits chip %d bits\n",
2165 size_ratio, info->portwidth << CFI_FLASH_SHIFT_WIDTH,
2166 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
2167 info->size = 1 << qry.dev_size;
2168 /* multiply the size by the number of chips */
2169 info->size *= size_ratio;
2170 max_size = cfi_flash_bank_size(banknum);
2171 if (max_size && info->size > max_size) {
2172 debug("[truncated from %ldMiB]", info->size >> 20);
2173 info->size = max_size;
2175 debug("found %d erase regions\n", num_erase_regions);
2178 for (i = 0; i < num_erase_regions; i++) {
2179 if (i > NUM_ERASE_REGIONS) {
2180 printf("%d erase regions found, only %d used\n",
2181 num_erase_regions, NUM_ERASE_REGIONS);
2185 tmp = le32_to_cpu(get_unaligned(
2186 &qry.erase_region_info[i]));
2187 debug("erase region %u: 0x%08lx\n", i, tmp);
2189 erase_region_count = (tmp & 0xffff) + 1;
2192 (tmp & 0xffff) ? ((tmp & 0xffff) * 256) : 128;
2193 debug("erase_region_count = %d ", erase_region_count);
2194 debug("erase_region_size = %d\n", erase_region_size);
2195 for (j = 0; j < erase_region_count; j++) {
2196 if (sector - base >= info->size)
2198 if (sect_cnt >= CONFIG_SYS_MAX_FLASH_SECT) {
2199 printf("ERROR: too many flash sectors\n");
2202 info->start[sect_cnt] =
2203 (ulong)map_physmem(sector,
2206 sector += (erase_region_size * size_ratio);
2209 * Only read protection status from
2210 * supported devices (intel...)
2212 switch (info->vendor) {
2213 case CFI_CMDSET_INTEL_PROG_REGIONS:
2214 case CFI_CMDSET_INTEL_EXTENDED:
2215 case CFI_CMDSET_INTEL_STANDARD:
2217 * Set flash to read-id mode. Otherwise
2218 * reading protected status is not
2221 flash_write_cmd(info, sect_cnt, 0,
2223 info->protect[sect_cnt] =
2224 flash_isset(info, sect_cnt,
2225 FLASH_OFFSET_PROTECT,
2226 FLASH_STATUS_PROTECT);
2227 flash_write_cmd(info, sect_cnt, 0,
2230 case CFI_CMDSET_AMD_EXTENDED:
2231 case CFI_CMDSET_AMD_STANDARD:
2232 if (!info->legacy_unlock) {
2233 /* default: not protected */
2234 info->protect[sect_cnt] = 0;
2238 /* Read protection (PPB) from sector */
2239 flash_write_cmd(info, 0, 0,
2241 flash_unlock_seq(info, 0);
2242 flash_write_cmd(info, 0,
2245 info->protect[sect_cnt] =
2248 FLASH_OFFSET_PROTECT,
2249 FLASH_STATUS_PROTECT);
2252 /* default: not protected */
2253 info->protect[sect_cnt] = 0;
2260 info->sector_count = sect_cnt;
2261 info->buffer_size = 1 << le16_to_cpu(qry.max_buf_write_size);
2262 tmp = 1 << qry.block_erase_timeout_typ;
2263 info->erase_blk_tout = tmp *
2264 (1 << qry.block_erase_timeout_max);
2265 tmp = (1 << qry.buf_write_timeout_typ) *
2266 (1 << qry.buf_write_timeout_max);
2268 /* round up when converting to ms */
2269 info->buffer_write_tout = (tmp + 999) / 1000;
2270 tmp = (1 << qry.word_write_timeout_typ) *
2271 (1 << qry.word_write_timeout_max);
2272 /* round up when converting to ms */
2273 info->write_tout = (tmp + 999) / 1000;
2274 info->flash_id = FLASH_MAN_CFI;
2275 if (info->interface == FLASH_CFI_X8X16 &&
2276 info->chipwidth == FLASH_CFI_BY8) {
2277 /* XXX - Need to test on x8/x16 in parallel. */
2278 info->portwidth >>= 1;
2281 flash_write_cmd(info, 0, 0, info->cmd_reset);
2284 return (info->size);
2287 #ifdef CONFIG_FLASH_CFI_MTD
2288 void flash_set_verbose(uint v)
2294 static void cfi_flash_set_config_reg(u32 base, u16 val)
2296 #ifdef CONFIG_SYS_CFI_FLASH_CONFIG_REGS
2298 * Only set this config register if really defined
2299 * to a valid value (0xffff is invalid)
2305 * Set configuration register. Data is "encrypted" in the 16 lower
2308 flash_write16(FLASH_CMD_SETUP, (void *)(base + (val << 1)));
2309 flash_write16(FLASH_CMD_SET_CR_CONFIRM, (void *)(base + (val << 1)));
2312 * Finally issue reset-command to bring device back to
2315 flash_write16(FLASH_CMD_RESET, (void *)base);
2319 /*-----------------------------------------------------------------------
2322 static void flash_protect_default(void)
2324 #if defined(CONFIG_SYS_FLASH_AUTOPROTECT_LIST)
2329 } apl[] = CONFIG_SYS_FLASH_AUTOPROTECT_LIST;
2332 /* Monitor protection ON by default */
2333 #if defined(CONFIG_SYS_MONITOR_BASE) && \
2334 (CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE) && \
2335 (!defined(CONFIG_MONITOR_IS_IN_RAM))
2336 flash_protect(FLAG_PROTECT_SET,
2337 CONFIG_SYS_MONITOR_BASE,
2338 CONFIG_SYS_MONITOR_BASE + monitor_flash_len - 1,
2339 flash_get_info(CONFIG_SYS_MONITOR_BASE));
2342 /* Environment protection ON by default */
2343 #ifdef CONFIG_ENV_IS_IN_FLASH
2344 flash_protect(FLAG_PROTECT_SET,
2346 CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1,
2347 flash_get_info(CONFIG_ENV_ADDR));
2350 /* Redundant environment protection ON by default */
2351 #ifdef CONFIG_ENV_ADDR_REDUND
2352 flash_protect(FLAG_PROTECT_SET,
2353 CONFIG_ENV_ADDR_REDUND,
2354 CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1,
2355 flash_get_info(CONFIG_ENV_ADDR_REDUND));
2358 #if defined(CONFIG_SYS_FLASH_AUTOPROTECT_LIST)
2359 for (i = 0; i < ARRAY_SIZE(apl); i++) {
2360 debug("autoprotecting from %08lx to %08lx\n",
2361 apl[i].start, apl[i].start + apl[i].size - 1);
2362 flash_protect(FLAG_PROTECT_SET,
2364 apl[i].start + apl[i].size - 1,
2365 flash_get_info(apl[i].start));
2370 unsigned long flash_init(void)
2372 unsigned long size = 0;
2375 #ifdef CONFIG_SYS_FLASH_PROTECTION
2376 /* read environment from EEPROM */
2379 env_get_f("unlock", s, sizeof(s));
2382 #ifdef CONFIG_CFI_FLASH /* for driver model */
2383 cfi_flash_init_dm();
2386 /* Init: no FLASHes known */
2387 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; ++i) {
2388 flash_info[i].flash_id = FLASH_UNKNOWN;
2390 /* Optionally write flash configuration register */
2391 cfi_flash_set_config_reg(cfi_flash_bank_addr(i),
2392 cfi_flash_config_reg(i));
2394 if (!flash_detect_legacy(cfi_flash_bank_addr(i), i))
2395 flash_get_size(cfi_flash_bank_addr(i), i);
2396 size += flash_info[i].size;
2397 if (flash_info[i].flash_id == FLASH_UNKNOWN) {
2398 #ifndef CONFIG_SYS_FLASH_QUIET_TEST
2399 printf("## Unknown flash on Bank %d ", i + 1);
2400 printf("- Size = 0x%08lx = %ld MB\n",
2402 flash_info[i].size >> 20);
2403 #endif /* CONFIG_SYS_FLASH_QUIET_TEST */
2405 #ifdef CONFIG_SYS_FLASH_PROTECTION
2406 else if (strcmp(s, "yes") == 0) {
2408 * Only the U-Boot image and it's environment
2409 * is protected, all other sectors are
2410 * unprotected (unlocked) if flash hardware
2411 * protection is used (CONFIG_SYS_FLASH_PROTECTION)
2412 * and the environment variable "unlock" is
2415 if (flash_info[i].legacy_unlock) {
2419 * Disable legacy_unlock temporarily,
2420 * since flash_real_protect would
2421 * relock all other sectors again
2424 flash_info[i].legacy_unlock = 0;
2427 * Legacy unlocking (e.g. Intel J3) ->
2428 * unlock only one sector. This will
2429 * unlock all sectors.
2431 flash_real_protect(&flash_info[i], 0, 0);
2433 flash_info[i].legacy_unlock = 1;
2436 * Manually mark other sectors as
2437 * unlocked (unprotected)
2439 for (k = 1; k < flash_info[i].sector_count; k++)
2440 flash_info[i].protect[k] = 0;
2443 * No legancy unlocking -> unlock all sectors
2445 flash_protect(FLAG_PROTECT_CLEAR,
2446 flash_info[i].start[0],
2447 flash_info[i].start[0]
2448 + flash_info[i].size - 1,
2452 #endif /* CONFIG_SYS_FLASH_PROTECTION */
2455 flash_protect_default();
2456 #ifdef CONFIG_FLASH_CFI_MTD
2463 #ifdef CONFIG_CFI_FLASH /* for driver model */
2464 static int cfi_flash_probe(struct udevice *dev)
2466 const fdt32_t *cell;
2470 addrc = dev_read_addr_cells(dev);
2471 sizec = dev_read_size_cells(dev);
2473 /* decode regs; there may be multiple reg tuples. */
2474 cell = dev_read_prop(dev, "reg", &len);
2478 len /= sizeof(fdt32_t);
2482 addr = dev_translate_address(dev, cell + idx);
2484 flash_info[cfi_flash_num_flash_banks].dev = dev;
2485 flash_info[cfi_flash_num_flash_banks].base = addr;
2486 cfi_flash_num_flash_banks++;
2488 idx += addrc + sizec;
2490 gd->bd->bi_flashstart = flash_info[0].base;
2495 static const struct udevice_id cfi_flash_ids[] = {
2496 { .compatible = "cfi-flash" },
2497 { .compatible = "jedec-flash" },
2501 U_BOOT_DRIVER(cfi_flash) = {
2502 .name = "cfi_flash",
2504 .of_match = cfi_flash_ids,
2505 .probe = cfi_flash_probe,
2507 #endif /* CONFIG_CFI_FLASH */