1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2002-2004
6 * Copyright (C) 2003 Arabella Software Ltd.
16 /* The DEBUG define must be before common to enable debugging */
24 #include <fdt_support.h>
27 #include <asm/processor.h>
29 #include <asm/byteorder.h>
30 #include <asm/unaligned.h>
31 #include <env_internal.h>
32 #include <mtd/cfi_flash.h>
36 * This file implements a Common Flash Interface (CFI) driver for
39 * The width of the port and the width of the chips are determined at
40 * initialization. These widths are used to calculate the address for
41 * access CFI data structures.
44 * JEDEC Standard JESD68 - Common Flash Interface (CFI)
45 * JEDEC Standard JEP137-A Common Flash Interface (CFI) ID Codes
46 * Intel Application Note 646 Common Flash Interface (CFI) and Command Sets
47 * Intel 290667-008 3 Volt Intel StrataFlash Memory datasheet
48 * AMD CFI Specification, Release 2.0 December 1, 2001
49 * AMD/Spansion Application Note: Migration from Single-byte to Three-byte
50 * Device IDs, Publication Number 25538 Revision A, November 8, 2001
52 * Define CONFIG_SYS_WRITE_SWAPPED_DATA, if you have to swap the Bytes between
53 * reading and writing ... (yes there is such a Hardware).
56 DECLARE_GLOBAL_DATA_PTR;
58 static uint flash_offset_cfi[2] = { FLASH_OFFSET_CFI, FLASH_OFFSET_CFI_ALT };
59 #ifdef CONFIG_FLASH_CFI_MTD
60 static uint flash_verbose = 1;
62 #define flash_verbose 1
65 flash_info_t flash_info[CFI_MAX_FLASH_BANKS]; /* FLASH chips info */
68 * Check if chip width is defined. If not, start detecting with 8bit.
70 #ifndef CONFIG_SYS_FLASH_CFI_WIDTH
71 #define CONFIG_SYS_FLASH_CFI_WIDTH FLASH_CFI_8BIT
74 #ifdef CONFIG_CFI_FLASH_USE_WEAK_ACCESSORS
75 #define __maybe_weak __weak
77 #define __maybe_weak static
81 * 0xffff is an undefined value for the configuration register. When
82 * this value is returned, the configuration register shall not be
83 * written at all (default mode).
85 static u16 cfi_flash_config_reg(int i)
87 #ifdef CONFIG_SYS_CFI_FLASH_CONFIG_REGS
88 return ((u16 [])CONFIG_SYS_CFI_FLASH_CONFIG_REGS)[i];
94 #if defined(CONFIG_SYS_MAX_FLASH_BANKS_DETECT)
95 int cfi_flash_num_flash_banks = CONFIG_SYS_MAX_FLASH_BANKS_DETECT;
97 int cfi_flash_num_flash_banks;
100 #ifdef CONFIG_CFI_FLASH /* for driver model */
101 static void cfi_flash_init_dm(void)
105 cfi_flash_num_flash_banks = 0;
107 * The uclass_first_device() will probe the first device and
108 * uclass_next_device() will probe the rest if they exist. So
109 * that cfi_flash_probe() will get called assigning the base
110 * addresses that are available.
112 for (uclass_first_device(UCLASS_MTD, &dev);
114 uclass_next_device(&dev)) {
118 phys_addr_t cfi_flash_bank_addr(int i)
120 return flash_info[i].base;
123 __weak phys_addr_t cfi_flash_bank_addr(int i)
125 return ((phys_addr_t [])CONFIG_SYS_FLASH_BANKS_LIST)[i];
129 __weak unsigned long cfi_flash_bank_size(int i)
131 #ifdef CONFIG_SYS_FLASH_BANKS_SIZES
132 return ((unsigned long [])CONFIG_SYS_FLASH_BANKS_SIZES)[i];
138 __maybe_weak void flash_write8(u8 value, void *addr)
140 __raw_writeb(value, addr);
143 __maybe_weak void flash_write16(u16 value, void *addr)
145 __raw_writew(value, addr);
148 __maybe_weak void flash_write32(u32 value, void *addr)
150 __raw_writel(value, addr);
153 __maybe_weak void flash_write64(u64 value, void *addr)
155 /* No architectures currently implement __raw_writeq() */
156 *(volatile u64 *)addr = value;
159 __maybe_weak u8 flash_read8(void *addr)
161 return __raw_readb(addr);
164 __maybe_weak u16 flash_read16(void *addr)
166 return __raw_readw(addr);
169 __maybe_weak u32 flash_read32(void *addr)
171 return __raw_readl(addr);
174 __maybe_weak u64 flash_read64(void *addr)
176 /* No architectures currently implement __raw_readq() */
177 return *(volatile u64 *)addr;
180 /*-----------------------------------------------------------------------
182 #if defined(CONFIG_ENV_IS_IN_FLASH) || defined(CONFIG_ENV_ADDR_REDUND) || \
183 (defined(CONFIG_SYS_MONITOR_BASE) && \
184 (CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE))
185 static flash_info_t *flash_get_info(ulong base)
190 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
191 info = &flash_info[i];
192 if (info->size && info->start[0] <= base &&
193 base <= info->start[0] + info->size - 1)
201 unsigned long flash_sector_size(flash_info_t *info, flash_sect_t sect)
203 if (sect != (info->sector_count - 1))
204 return info->start[sect + 1] - info->start[sect];
206 return info->start[0] + info->size - info->start[sect];
209 /*-----------------------------------------------------------------------
210 * create an address based on the offset and the port width
213 flash_map(flash_info_t *info, flash_sect_t sect, uint offset)
215 unsigned int byte_offset = offset * info->portwidth;
217 return (void *)(info->start[sect] + byte_offset);
220 static inline void flash_unmap(flash_info_t *info, flash_sect_t sect,
221 unsigned int offset, void *addr)
225 /*-----------------------------------------------------------------------
226 * make a proper sized command based on the port and chip widths
228 static void flash_make_cmd(flash_info_t *info, u32 cmd, void *cmdbuf)
233 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
234 u32 cmd_le = cpu_to_le32(cmd);
237 uchar *cp = (uchar *) cmdbuf;
239 for (i = info->portwidth; i > 0; i--) {
240 cword_offset = (info->portwidth - i) % info->chipwidth;
241 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
242 cp_offset = info->portwidth - i;
243 val = *((uchar *)&cmd_le + cword_offset);
246 val = *((uchar *)&cmd + sizeof(u32) - cword_offset - 1);
248 cp[cp_offset] = (cword_offset >= sizeof(u32)) ? 0x00 : val;
253 /*-----------------------------------------------------------------------
256 static void print_longlong(char *str, unsigned long long data)
262 for (i = 0; i < 8; i++)
263 sprintf(&str[i * 2], "%2.2x", *cp++);
266 static void flash_printqry(struct cfi_qry *qry)
271 for (x = 0; x < sizeof(struct cfi_qry); x += 16) {
273 for (y = 0; y < 16; y++)
274 debug("%2.2x ", p[x + y]);
276 for (y = 0; y < 16; y++) {
277 unsigned char c = p[x + y];
279 if (c >= 0x20 && c <= 0x7e)
289 /*-----------------------------------------------------------------------
290 * read a character at a port width address
292 static inline uchar flash_read_uchar(flash_info_t *info, uint offset)
297 cp = flash_map(info, 0, offset);
298 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
299 retval = flash_read8(cp);
301 retval = flash_read8(cp + info->portwidth - 1);
303 flash_unmap(info, 0, offset, cp);
307 /*-----------------------------------------------------------------------
308 * read a word at a port width address, assume 16bit bus
310 static inline ushort flash_read_word(flash_info_t *info, uint offset)
312 ushort *addr, retval;
314 addr = flash_map(info, 0, offset);
315 retval = flash_read16(addr);
316 flash_unmap(info, 0, offset, addr);
320 /*-----------------------------------------------------------------------
321 * read a long word by picking the least significant byte of each maximum
322 * port size word. Swap for ppc format.
324 static ulong flash_read_long (flash_info_t *info, flash_sect_t sect,
333 addr = flash_map(info, sect, offset);
336 debug("long addr is at %p info->portwidth = %d\n", addr,
338 for (x = 0; x < 4 * info->portwidth; x++)
339 debug("addr[%x] = 0x%x\n", x, flash_read8(addr + x));
341 #if defined(__LITTLE_ENDIAN) || defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
342 retval = ((flash_read8(addr) << 16) |
343 (flash_read8(addr + info->portwidth) << 24) |
344 (flash_read8(addr + 2 * info->portwidth)) |
345 (flash_read8(addr + 3 * info->portwidth) << 8));
347 retval = ((flash_read8(addr + 2 * info->portwidth - 1) << 24) |
348 (flash_read8(addr + info->portwidth - 1) << 16) |
349 (flash_read8(addr + 4 * info->portwidth - 1) << 8) |
350 (flash_read8(addr + 3 * info->portwidth - 1)));
352 flash_unmap(info, sect, offset, addr);
358 * Write a proper sized command to the correct address
360 static void flash_write_cmd(flash_info_t *info, flash_sect_t sect,
361 uint offset, u32 cmd)
366 addr = flash_map(info, sect, offset);
367 flash_make_cmd(info, cmd, &cword);
368 switch (info->portwidth) {
370 debug("fwc addr %p cmd %x %x 8bit x %d bit\n", addr, cmd,
371 cword.w8, info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
372 flash_write8(cword.w8, addr);
374 case FLASH_CFI_16BIT:
375 debug("fwc addr %p cmd %x %4.4x 16bit x %d bit\n", addr,
377 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
378 flash_write16(cword.w16, addr);
380 case FLASH_CFI_32BIT:
381 debug("fwc addr %p cmd %x %8.8x 32bit x %d bit\n", addr,
383 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
384 flash_write32(cword.w32, addr);
386 case FLASH_CFI_64BIT:
391 print_longlong(str, cword.w64);
393 debug("fwrite addr %p cmd %x %s 64 bit x %d bit\n",
395 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
398 flash_write64(cword.w64, addr);
402 /* Ensure all the instructions are fully finished */
405 flash_unmap(info, sect, offset, addr);
408 static void flash_unlock_seq(flash_info_t *info, flash_sect_t sect)
410 flash_write_cmd(info, sect, info->addr_unlock1, AMD_CMD_UNLOCK_START);
411 flash_write_cmd(info, sect, info->addr_unlock2, AMD_CMD_UNLOCK_ACK);
414 /*-----------------------------------------------------------------------
416 static int flash_isequal(flash_info_t *info, flash_sect_t sect, uint offset,
423 addr = flash_map(info, sect, offset);
424 flash_make_cmd(info, cmd, &cword);
426 debug("is= cmd %x(%c) addr %p ", cmd, cmd, addr);
427 switch (info->portwidth) {
429 debug("is= %x %x\n", flash_read8(addr), cword.w8);
430 retval = (flash_read8(addr) == cword.w8);
432 case FLASH_CFI_16BIT:
433 debug("is= %4.4x %4.4x\n", flash_read16(addr), cword.w16);
434 retval = (flash_read16(addr) == cword.w16);
436 case FLASH_CFI_32BIT:
437 debug("is= %8.8x %8.8x\n", flash_read32(addr), cword.w32);
438 retval = (flash_read32(addr) == cword.w32);
440 case FLASH_CFI_64BIT:
446 print_longlong(str1, flash_read64(addr));
447 print_longlong(str2, cword.w64);
448 debug("is= %s %s\n", str1, str2);
451 retval = (flash_read64(addr) == cword.w64);
457 flash_unmap(info, sect, offset, addr);
462 /*-----------------------------------------------------------------------
464 static int flash_isset(flash_info_t *info, flash_sect_t sect, uint offset,
471 addr = flash_map(info, sect, offset);
472 flash_make_cmd(info, cmd, &cword);
473 switch (info->portwidth) {
475 retval = ((flash_read8(addr) & cword.w8) == cword.w8);
477 case FLASH_CFI_16BIT:
478 retval = ((flash_read16(addr) & cword.w16) == cword.w16);
480 case FLASH_CFI_32BIT:
481 retval = ((flash_read32(addr) & cword.w32) == cword.w32);
483 case FLASH_CFI_64BIT:
484 retval = ((flash_read64(addr) & cword.w64) == cword.w64);
490 flash_unmap(info, sect, offset, addr);
495 /*-----------------------------------------------------------------------
497 static int flash_toggle(flash_info_t *info, flash_sect_t sect, uint offset,
504 addr = flash_map(info, sect, offset);
505 flash_make_cmd(info, cmd, &cword);
506 switch (info->portwidth) {
508 retval = flash_read8(addr) != flash_read8(addr);
510 case FLASH_CFI_16BIT:
511 retval = flash_read16(addr) != flash_read16(addr);
513 case FLASH_CFI_32BIT:
514 retval = flash_read32(addr) != flash_read32(addr);
516 case FLASH_CFI_64BIT:
517 retval = ((flash_read32(addr) != flash_read32(addr)) ||
518 (flash_read32(addr + 4) != flash_read32(addr + 4)));
524 flash_unmap(info, sect, offset, addr);
530 * flash_is_busy - check to see if the flash is busy
532 * This routine checks the status of the chip and returns true if the
535 static int flash_is_busy(flash_info_t *info, flash_sect_t sect)
539 switch (info->vendor) {
540 case CFI_CMDSET_INTEL_PROG_REGIONS:
541 case CFI_CMDSET_INTEL_STANDARD:
542 case CFI_CMDSET_INTEL_EXTENDED:
543 retval = !flash_isset(info, sect, 0, FLASH_STATUS_DONE);
545 case CFI_CMDSET_AMD_STANDARD:
546 case CFI_CMDSET_AMD_EXTENDED:
547 #ifdef CONFIG_FLASH_CFI_LEGACY
548 case CFI_CMDSET_AMD_LEGACY:
550 if (info->sr_supported) {
551 flash_write_cmd(info, sect, info->addr_unlock1,
552 FLASH_CMD_READ_STATUS);
553 retval = !flash_isset(info, sect, 0,
556 retval = flash_toggle(info, sect, 0,
564 debug("%s: %d\n", __func__, retval);
568 /*-----------------------------------------------------------------------
569 * wait for XSR.7 to be set. Time out with an error if it does not.
570 * This routine does not set the flash to read-array mode.
572 static int flash_status_check(flash_info_t *info, flash_sect_t sector,
573 ulong tout, char *prompt)
577 #if CONFIG_SYS_HZ != 1000
578 /* Avoid overflow for large HZ */
579 if ((ulong)CONFIG_SYS_HZ > 100000)
580 tout *= (ulong)CONFIG_SYS_HZ / 1000;
582 tout = DIV_ROUND_UP(tout * (ulong)CONFIG_SYS_HZ, 1000);
585 /* Wait for command completion */
586 #ifdef CONFIG_SYS_LOW_RES_TIMER
589 start = get_timer(0);
591 while (flash_is_busy(info, sector)) {
592 if (get_timer(start) > tout) {
593 printf("Flash %s timeout at address %lx data %lx\n",
594 prompt, info->start[sector],
595 flash_read_long(info, sector, 0));
596 flash_write_cmd(info, sector, 0, info->cmd_reset);
600 udelay(1); /* also triggers watchdog */
605 /*-----------------------------------------------------------------------
606 * Wait for XSR.7 to be set, if it times out print an error, otherwise
607 * do a full status check.
609 * This routine sets the flash to read-array mode.
611 static int flash_full_status_check(flash_info_t *info, flash_sect_t sector,
612 ulong tout, char *prompt)
616 retcode = flash_status_check(info, sector, tout, prompt);
617 switch (info->vendor) {
618 case CFI_CMDSET_INTEL_PROG_REGIONS:
619 case CFI_CMDSET_INTEL_EXTENDED:
620 case CFI_CMDSET_INTEL_STANDARD:
621 if (retcode == ERR_OK &&
622 !flash_isset(info, sector, 0, FLASH_STATUS_DONE)) {
624 printf("Flash %s error at address %lx\n", prompt,
625 info->start[sector]);
626 if (flash_isset(info, sector, 0, FLASH_STATUS_ECLBS |
627 FLASH_STATUS_PSLBS)) {
628 puts("Command Sequence Error.\n");
629 } else if (flash_isset(info, sector, 0,
630 FLASH_STATUS_ECLBS)) {
631 puts("Block Erase Error.\n");
632 retcode = ERR_NOT_ERASED;
633 } else if (flash_isset(info, sector, 0,
634 FLASH_STATUS_PSLBS)) {
635 puts("Locking Error\n");
637 if (flash_isset(info, sector, 0, FLASH_STATUS_DPS)) {
638 puts("Block locked.\n");
639 retcode = ERR_PROTECTED;
641 if (flash_isset(info, sector, 0, FLASH_STATUS_VPENS))
642 puts("Vpp Low Error.\n");
644 flash_write_cmd(info, sector, 0, info->cmd_reset);
653 static int use_flash_status_poll(flash_info_t *info)
655 #ifdef CONFIG_SYS_CFI_FLASH_STATUS_POLL
656 if (info->vendor == CFI_CMDSET_AMD_EXTENDED ||
657 info->vendor == CFI_CMDSET_AMD_STANDARD)
663 static int flash_status_poll(flash_info_t *info, void *src, void *dst,
664 ulong tout, char *prompt)
666 #ifdef CONFIG_SYS_CFI_FLASH_STATUS_POLL
670 #if CONFIG_SYS_HZ != 1000
671 /* Avoid overflow for large HZ */
672 if ((ulong)CONFIG_SYS_HZ > 100000)
673 tout *= (ulong)CONFIG_SYS_HZ / 1000;
675 tout = DIV_ROUND_UP(tout * (ulong)CONFIG_SYS_HZ, 1000);
678 /* Wait for command completion */
679 #ifdef CONFIG_SYS_LOW_RES_TIMER
682 start = get_timer(0);
685 switch (info->portwidth) {
687 ready = flash_read8(dst) == flash_read8(src);
689 case FLASH_CFI_16BIT:
690 ready = flash_read16(dst) == flash_read16(src);
692 case FLASH_CFI_32BIT:
693 ready = flash_read32(dst) == flash_read32(src);
695 case FLASH_CFI_64BIT:
696 ready = flash_read64(dst) == flash_read64(src);
704 if (get_timer(start) > tout) {
705 printf("Flash %s timeout at address %lx data %lx\n",
706 prompt, (ulong)dst, (ulong)flash_read8(dst));
709 udelay(1); /* also triggers watchdog */
711 #endif /* CONFIG_SYS_CFI_FLASH_STATUS_POLL */
715 /*-----------------------------------------------------------------------
717 static void flash_add_byte(flash_info_t *info, cfiword_t *cword, uchar c)
719 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
722 unsigned long long ll;
725 switch (info->portwidth) {
729 case FLASH_CFI_16BIT:
730 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
733 cword->w16 = (cword->w16 >> 8) | w;
735 cword->w16 = (cword->w16 << 8) | c;
738 case FLASH_CFI_32BIT:
739 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
742 cword->w32 = (cword->w32 >> 8) | l;
744 cword->w32 = (cword->w32 << 8) | c;
747 case FLASH_CFI_64BIT:
748 #if defined(__LITTLE_ENDIAN) && !defined(CONFIG_SYS_WRITE_SWAPPED_DATA)
751 cword->w64 = (cword->w64 >> 8) | ll;
753 cword->w64 = (cword->w64 << 8) | c;
760 * Loop through the sector table starting from the previously found sector.
761 * Searches forwards or backwards, dependent on the passed address.
763 static flash_sect_t find_sector(flash_info_t *info, ulong addr)
765 static flash_sect_t saved_sector; /* previously found sector */
766 static flash_info_t *saved_info; /* previously used flash bank */
767 flash_sect_t sector = saved_sector;
769 if (info != saved_info || sector >= info->sector_count)
772 while ((sector < info->sector_count - 1) &&
773 (info->start[sector] < addr))
775 while ((info->start[sector] > addr) && (sector > 0))
777 * also decrements the sector in case of an overshot
782 saved_sector = sector;
787 /*-----------------------------------------------------------------------
789 static int flash_write_cfiword(flash_info_t *info, ulong dest, cfiword_t cword)
791 void *dstaddr = (void *)dest;
793 flash_sect_t sect = 0;
796 /* Check if Flash is (sufficiently) erased */
797 switch (info->portwidth) {
799 flag = ((flash_read8(dstaddr) & cword.w8) == cword.w8);
801 case FLASH_CFI_16BIT:
802 flag = ((flash_read16(dstaddr) & cword.w16) == cword.w16);
804 case FLASH_CFI_32BIT:
805 flag = ((flash_read32(dstaddr) & cword.w32) == cword.w32);
807 case FLASH_CFI_64BIT:
808 flag = ((flash_read64(dstaddr) & cword.w64) == cword.w64);
815 return ERR_NOT_ERASED;
817 /* Disable interrupts which might cause a timeout here */
818 flag = disable_interrupts();
820 switch (info->vendor) {
821 case CFI_CMDSET_INTEL_PROG_REGIONS:
822 case CFI_CMDSET_INTEL_EXTENDED:
823 case CFI_CMDSET_INTEL_STANDARD:
824 flash_write_cmd(info, 0, 0, FLASH_CMD_CLEAR_STATUS);
825 flash_write_cmd(info, 0, 0, FLASH_CMD_WRITE);
827 case CFI_CMDSET_AMD_EXTENDED:
828 case CFI_CMDSET_AMD_STANDARD:
829 sect = find_sector(info, dest);
830 flash_unlock_seq(info, sect);
831 flash_write_cmd(info, sect, info->addr_unlock1, AMD_CMD_WRITE);
834 #ifdef CONFIG_FLASH_CFI_LEGACY
835 case CFI_CMDSET_AMD_LEGACY:
836 sect = find_sector(info, dest);
837 flash_unlock_seq(info, 0);
838 flash_write_cmd(info, 0, info->addr_unlock1, AMD_CMD_WRITE);
844 switch (info->portwidth) {
846 flash_write8(cword.w8, dstaddr);
848 case FLASH_CFI_16BIT:
849 flash_write16(cword.w16, dstaddr);
851 case FLASH_CFI_32BIT:
852 flash_write32(cword.w32, dstaddr);
854 case FLASH_CFI_64BIT:
855 flash_write64(cword.w64, dstaddr);
859 /* re-enable interrupts if necessary */
864 sect = find_sector(info, dest);
866 if (use_flash_status_poll(info))
867 return flash_status_poll(info, &cword, dstaddr,
868 info->write_tout, "write");
870 return flash_full_status_check(info, sect,
871 info->write_tout, "write");
874 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
876 static int flash_write_cfibuffer(flash_info_t *info, ulong dest, uchar *cp,
883 u8 *dst = (u8 *)dest;
890 switch (info->portwidth) {
894 case FLASH_CFI_16BIT:
897 case FLASH_CFI_32BIT:
900 case FLASH_CFI_64BIT:
910 while ((cnt-- > 0) && (flag == 1)) {
911 switch (info->portwidth) {
913 flag = ((flash_read8(dst2) & flash_read8(src)) ==
917 case FLASH_CFI_16BIT:
918 flag = ((flash_read16(dst2) & flash_read16(src)) ==
922 case FLASH_CFI_32BIT:
923 flag = ((flash_read32(dst2) & flash_read32(src)) ==
927 case FLASH_CFI_64BIT:
928 flag = ((flash_read64(dst2) & flash_read64(src)) ==
935 retcode = ERR_NOT_ERASED;
940 sector = find_sector(info, dest);
942 switch (info->vendor) {
943 case CFI_CMDSET_INTEL_PROG_REGIONS:
944 case CFI_CMDSET_INTEL_STANDARD:
945 case CFI_CMDSET_INTEL_EXTENDED:
946 write_cmd = (info->vendor == CFI_CMDSET_INTEL_PROG_REGIONS) ?
947 FLASH_CMD_WRITE_BUFFER_PROG :
948 FLASH_CMD_WRITE_TO_BUFFER;
949 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
950 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_STATUS);
951 flash_write_cmd(info, sector, 0, write_cmd);
952 retcode = flash_status_check(info, sector,
953 info->buffer_write_tout,
955 if (retcode == ERR_OK) {
956 /* reduce the number of loops by the width of
960 flash_write_cmd(info, sector, 0, cnt - 1);
962 switch (info->portwidth) {
964 flash_write8(flash_read8(src), dst);
967 case FLASH_CFI_16BIT:
968 flash_write16(flash_read16(src), dst);
971 case FLASH_CFI_32BIT:
972 flash_write32(flash_read32(src), dst);
975 case FLASH_CFI_64BIT:
976 flash_write64(flash_read64(src), dst);
984 flash_write_cmd(info, sector, 0,
985 FLASH_CMD_WRITE_BUFFER_CONFIRM);
986 retcode = flash_full_status_check(
987 info, sector, info->buffer_write_tout,
993 case CFI_CMDSET_AMD_STANDARD:
994 case CFI_CMDSET_AMD_EXTENDED:
995 flash_unlock_seq(info, sector);
997 #ifdef CONFIG_FLASH_SPANSION_S29WS_N
998 offset = ((unsigned long)dst - info->start[sector]) >> shift;
1000 flash_write_cmd(info, sector, offset, AMD_CMD_WRITE_TO_BUFFER);
1002 flash_write_cmd(info, sector, offset, cnt - 1);
1004 switch (info->portwidth) {
1005 case FLASH_CFI_8BIT:
1007 flash_write8(flash_read8(src), dst);
1011 case FLASH_CFI_16BIT:
1013 flash_write16(flash_read16(src), dst);
1017 case FLASH_CFI_32BIT:
1019 flash_write32(flash_read32(src), dst);
1023 case FLASH_CFI_64BIT:
1025 flash_write64(flash_read64(src), dst);
1030 retcode = ERR_INVAL;
1034 flash_write_cmd(info, sector, 0, AMD_CMD_WRITE_BUFFER_CONFIRM);
1035 if (use_flash_status_poll(info))
1036 retcode = flash_status_poll(info, src - (1 << shift),
1038 info->buffer_write_tout,
1041 retcode = flash_full_status_check(info, sector,
1042 info->buffer_write_tout,
1047 debug("Unknown Command Set\n");
1048 retcode = ERR_INVAL;
1055 #endif /* CONFIG_SYS_FLASH_USE_BUFFER_WRITE */
1057 /*-----------------------------------------------------------------------
1059 int flash_erase(flash_info_t *info, int s_first, int s_last)
1066 if (info->flash_id != FLASH_MAN_CFI) {
1067 puts("Can't erase unknown flash type - aborted\n");
1070 if (s_first < 0 || s_first > s_last) {
1071 puts("- no sectors to erase\n");
1076 for (sect = s_first; sect <= s_last; ++sect)
1077 if (info->protect[sect])
1080 printf("- Warning: %d protected sectors will not be erased!\n",
1082 } else if (flash_verbose) {
1086 for (sect = s_first; sect <= s_last; sect++) {
1092 if (info->protect[sect] == 0) { /* not protected */
1093 #ifdef CONFIG_SYS_FLASH_CHECK_BLANK_BEFORE_ERASE
1100 * Check if whole sector is erased
1102 size = flash_sector_size(info, sect);
1104 flash = (u32 *)info->start[sect];
1105 /* divide by 4 for longword access */
1107 for (k = 0; k < size; k++) {
1108 if (flash_read32(flash++) != 0xffffffff) {
1119 switch (info->vendor) {
1120 case CFI_CMDSET_INTEL_PROG_REGIONS:
1121 case CFI_CMDSET_INTEL_STANDARD:
1122 case CFI_CMDSET_INTEL_EXTENDED:
1123 flash_write_cmd(info, sect, 0,
1124 FLASH_CMD_CLEAR_STATUS);
1125 flash_write_cmd(info, sect, 0,
1126 FLASH_CMD_BLOCK_ERASE);
1127 flash_write_cmd(info, sect, 0,
1128 FLASH_CMD_ERASE_CONFIRM);
1130 case CFI_CMDSET_AMD_STANDARD:
1131 case CFI_CMDSET_AMD_EXTENDED:
1132 flash_unlock_seq(info, sect);
1133 flash_write_cmd(info, sect,
1135 AMD_CMD_ERASE_START);
1136 flash_unlock_seq(info, sect);
1137 flash_write_cmd(info, sect, 0,
1138 info->cmd_erase_sector);
1140 #ifdef CONFIG_FLASH_CFI_LEGACY
1141 case CFI_CMDSET_AMD_LEGACY:
1142 flash_unlock_seq(info, 0);
1143 flash_write_cmd(info, 0, info->addr_unlock1,
1144 AMD_CMD_ERASE_START);
1145 flash_unlock_seq(info, 0);
1146 flash_write_cmd(info, sect, 0,
1147 AMD_CMD_ERASE_SECTOR);
1151 debug("Unknown flash vendor %d\n",
1156 if (use_flash_status_poll(info)) {
1160 cword.w64 = 0xffffffffffffffffULL;
1161 dest = flash_map(info, sect, 0);
1162 st = flash_status_poll(info, &cword, dest,
1163 info->erase_blk_tout,
1165 flash_unmap(info, sect, 0, dest);
1167 st = flash_full_status_check(info, sect,
1168 info->erase_blk_tout,
1174 else if (flash_verbose)
1185 #ifdef CONFIG_SYS_FLASH_EMPTY_INFO
1186 static int sector_erased(flash_info_t *info, int i)
1193 * Check if whole sector is erased
1195 size = flash_sector_size(info, i);
1196 flash = (u32 *)info->start[i];
1197 /* divide by 4 for longword access */
1200 for (k = 0; k < size; k++) {
1201 if (flash_read32(flash++) != 0xffffffff)
1202 return 0; /* not erased */
1205 return 1; /* erased */
1207 #endif /* CONFIG_SYS_FLASH_EMPTY_INFO */
1209 void flash_print_info(flash_info_t *info)
1213 if (info->flash_id != FLASH_MAN_CFI) {
1214 puts("missing or unknown FLASH type\n");
1218 printf("%s flash (%d x %d)",
1220 (info->portwidth << 3), (info->chipwidth << 3));
1221 if (info->size < 1024 * 1024)
1222 printf(" Size: %ld kB in %d Sectors\n",
1223 info->size >> 10, info->sector_count);
1225 printf(" Size: %ld MB in %d Sectors\n",
1226 info->size >> 20, info->sector_count);
1228 switch (info->vendor) {
1229 case CFI_CMDSET_INTEL_PROG_REGIONS:
1230 printf("Intel Prog Regions");
1232 case CFI_CMDSET_INTEL_STANDARD:
1233 printf("Intel Standard");
1235 case CFI_CMDSET_INTEL_EXTENDED:
1236 printf("Intel Extended");
1238 case CFI_CMDSET_AMD_STANDARD:
1239 printf("AMD Standard");
1241 case CFI_CMDSET_AMD_EXTENDED:
1242 printf("AMD Extended");
1244 #ifdef CONFIG_FLASH_CFI_LEGACY
1245 case CFI_CMDSET_AMD_LEGACY:
1246 printf("AMD Legacy");
1250 printf("Unknown (%d)", info->vendor);
1253 printf(" command set, Manufacturer ID: 0x%02X, Device ID: 0x",
1254 info->manufacturer_id);
1255 printf(info->chipwidth == FLASH_CFI_16BIT ? "%04X" : "%02X",
1257 if ((info->device_id & 0xff) == 0x7E) {
1258 printf(info->chipwidth == FLASH_CFI_16BIT ? "%04X" : "%02X",
1261 if (info->vendor == CFI_CMDSET_AMD_STANDARD && info->legacy_unlock)
1262 printf("\n Advanced Sector Protection (PPB) enabled");
1263 printf("\n Erase timeout: %ld ms, write timeout: %ld ms\n",
1264 info->erase_blk_tout, info->write_tout);
1265 if (info->buffer_size > 1) {
1266 printf(" Buffer write timeout: %ld ms, ",
1267 info->buffer_write_tout);
1268 printf("buffer size: %d bytes\n", info->buffer_size);
1271 puts("\n Sector Start Addresses:");
1272 for (i = 0; i < info->sector_count; ++i) {
1277 #ifdef CONFIG_SYS_FLASH_EMPTY_INFO
1278 /* print empty and read-only info */
1279 printf(" %08lX %c %s ",
1281 sector_erased(info, i) ? 'E' : ' ',
1282 info->protect[i] ? "RO" : " ");
1283 #else /* ! CONFIG_SYS_FLASH_EMPTY_INFO */
1284 printf(" %08lX %s ",
1286 info->protect[i] ? "RO" : " ");
1292 /*-----------------------------------------------------------------------
1293 * This is used in a few places in write_buf() to show programming
1294 * progress. Making it a function is nasty because it needs to do side
1295 * effect updates to digit and dots. Repeated code is nasty too, so
1296 * we define it once here.
1298 #ifdef CONFIG_FLASH_SHOW_PROGRESS
1299 #define FLASH_SHOW_PROGRESS(scale, dots, digit, dots_sub) \
1300 if (flash_verbose) { \
1302 if (scale > 0 && dots <= 0) { \
1303 if ((digit % 5) == 0) \
1304 printf("%d", digit / 5); \
1312 #define FLASH_SHOW_PROGRESS(scale, dots, digit, dots_sub)
1315 /*-----------------------------------------------------------------------
1316 * Copy memory to flash, returns:
1319 * 2 - Flash not erased
1321 int write_buff(flash_info_t *info, uchar *src, ulong addr, ulong cnt)
1328 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
1331 #ifdef CONFIG_FLASH_SHOW_PROGRESS
1332 int digit = CONFIG_FLASH_SHOW_PROGRESS;
1337 * Suppress if there are fewer than CONFIG_FLASH_SHOW_PROGRESS writes.
1339 if (cnt >= CONFIG_FLASH_SHOW_PROGRESS) {
1340 scale = (int)((cnt + CONFIG_FLASH_SHOW_PROGRESS - 1) /
1341 CONFIG_FLASH_SHOW_PROGRESS);
1345 /* get lower aligned address */
1346 wp = (addr & ~(info->portwidth - 1));
1348 /* handle unaligned start */
1353 for (i = 0; i < aln; ++i)
1354 flash_add_byte(info, &cword, flash_read8(p + i));
1356 for (; (i < info->portwidth) && (cnt > 0); i++) {
1357 flash_add_byte(info, &cword, *src++);
1360 for (; (cnt == 0) && (i < info->portwidth); ++i)
1361 flash_add_byte(info, &cword, flash_read8(p + i));
1363 rc = flash_write_cfiword(info, wp, cword);
1368 FLASH_SHOW_PROGRESS(scale, dots, digit, i);
1371 /* handle the aligned part */
1372 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
1373 buffered_size = (info->portwidth / info->chipwidth);
1374 buffered_size *= info->buffer_size;
1375 while (cnt >= info->portwidth) {
1376 /* prohibit buffer write when buffer_size is 1 */
1377 if (info->buffer_size == 1) {
1379 for (i = 0; i < info->portwidth; i++)
1380 flash_add_byte(info, &cword, *src++);
1381 rc = flash_write_cfiword(info, wp, cword);
1384 wp += info->portwidth;
1385 cnt -= info->portwidth;
1389 /* write buffer until next buffered_size aligned boundary */
1390 i = buffered_size - (wp % buffered_size);
1393 rc = flash_write_cfibuffer(info, wp, src, i);
1396 i -= i & (info->portwidth - 1);
1400 FLASH_SHOW_PROGRESS(scale, dots, digit, i);
1401 /* Only check every once in a while */
1402 if ((cnt & 0xFFFF) < buffered_size && ctrlc())
1406 while (cnt >= info->portwidth) {
1408 for (i = 0; i < info->portwidth; i++)
1409 flash_add_byte(info, &cword, *src++);
1410 rc = flash_write_cfiword(info, wp, cword);
1413 wp += info->portwidth;
1414 cnt -= info->portwidth;
1415 FLASH_SHOW_PROGRESS(scale, dots, digit, info->portwidth);
1416 /* Only check every once in a while */
1417 if ((cnt & 0xFFFF) < info->portwidth && ctrlc())
1420 #endif /* CONFIG_SYS_FLASH_USE_BUFFER_WRITE */
1426 * handle unaligned tail bytes
1430 for (i = 0; (i < info->portwidth) && (cnt > 0); ++i) {
1431 flash_add_byte(info, &cword, *src++);
1434 for (; i < info->portwidth; ++i)
1435 flash_add_byte(info, &cword, flash_read8(p + i));
1437 return flash_write_cfiword(info, wp, cword);
1440 static inline int manufact_match(flash_info_t *info, u32 manu)
1442 return info->manufacturer_id == ((manu & FLASH_VENDMASK) >> 16);
1445 /*-----------------------------------------------------------------------
1447 #ifdef CONFIG_SYS_FLASH_PROTECTION
1449 static int cfi_protect_bugfix(flash_info_t *info, long sector, int prot)
1451 if (manufact_match(info, INTEL_MANUFACT) &&
1452 info->device_id == NUMONYX_256MBIT) {
1455 * "Numonyx Axcell P33/P30 Specification Update" :)
1457 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_ID);
1458 if (!flash_isequal(info, sector, FLASH_OFFSET_PROTECT,
1461 * cmd must come before FLASH_CMD_PROTECT + 20us
1462 * Disable interrupts which might cause a timeout here.
1464 int flag = disable_interrupts();
1468 cmd = FLASH_CMD_PROTECT_SET;
1470 cmd = FLASH_CMD_PROTECT_CLEAR;
1472 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT);
1473 flash_write_cmd(info, sector, 0, cmd);
1474 /* re-enable interrupts if necessary */
1476 enable_interrupts();
1483 int flash_real_protect(flash_info_t *info, long sector, int prot)
1487 switch (info->vendor) {
1488 case CFI_CMDSET_INTEL_PROG_REGIONS:
1489 case CFI_CMDSET_INTEL_STANDARD:
1490 case CFI_CMDSET_INTEL_EXTENDED:
1491 if (!cfi_protect_bugfix(info, sector, prot)) {
1492 flash_write_cmd(info, sector, 0,
1493 FLASH_CMD_CLEAR_STATUS);
1494 flash_write_cmd(info, sector, 0,
1497 flash_write_cmd(info, sector, 0,
1498 FLASH_CMD_PROTECT_SET);
1500 flash_write_cmd(info, sector, 0,
1501 FLASH_CMD_PROTECT_CLEAR);
1504 case CFI_CMDSET_AMD_EXTENDED:
1505 case CFI_CMDSET_AMD_STANDARD:
1506 /* U-Boot only checks the first byte */
1507 if (manufact_match(info, ATM_MANUFACT)) {
1509 flash_unlock_seq(info, 0);
1510 flash_write_cmd(info, 0,
1512 ATM_CMD_SOFTLOCK_START);
1513 flash_unlock_seq(info, 0);
1514 flash_write_cmd(info, sector, 0,
1517 flash_write_cmd(info, 0,
1519 AMD_CMD_UNLOCK_START);
1520 if (info->device_id == ATM_ID_BV6416)
1521 flash_write_cmd(info, sector,
1522 0, ATM_CMD_UNLOCK_SECT);
1525 if (info->legacy_unlock) {
1526 int flag = disable_interrupts();
1529 flash_unlock_seq(info, 0);
1530 flash_write_cmd(info, 0, info->addr_unlock1,
1531 AMD_CMD_SET_PPB_ENTRY);
1532 lock_flag = flash_isset(info, sector, 0, 0x01);
1535 flash_write_cmd(info, sector, 0,
1536 AMD_CMD_PPB_LOCK_BC1);
1537 flash_write_cmd(info, sector, 0,
1538 AMD_CMD_PPB_LOCK_BC2);
1540 debug("sector %ld %slocked\n", sector,
1541 lock_flag ? "" : "already ");
1544 debug("unlock %ld\n", sector);
1545 flash_write_cmd(info, 0, 0,
1546 AMD_CMD_PPB_UNLOCK_BC1);
1547 flash_write_cmd(info, 0, 0,
1548 AMD_CMD_PPB_UNLOCK_BC2);
1550 debug("sector %ld %sunlocked\n", sector,
1551 !lock_flag ? "" : "already ");
1554 enable_interrupts();
1556 if (flash_status_check(info, sector,
1557 info->erase_blk_tout,
1558 prot ? "protect" : "unprotect"))
1559 printf("status check error\n");
1561 flash_write_cmd(info, 0, 0,
1562 AMD_CMD_SET_PPB_EXIT_BC1);
1563 flash_write_cmd(info, 0, 0,
1564 AMD_CMD_SET_PPB_EXIT_BC2);
1567 #ifdef CONFIG_FLASH_CFI_LEGACY
1568 case CFI_CMDSET_AMD_LEGACY:
1569 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
1570 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT);
1572 flash_write_cmd(info, sector, 0,
1573 FLASH_CMD_PROTECT_SET);
1575 flash_write_cmd(info, sector, 0,
1576 FLASH_CMD_PROTECT_CLEAR);
1581 * Flash needs to be in status register read mode for
1582 * flash_full_status_check() to work correctly
1584 flash_write_cmd(info, sector, 0, FLASH_CMD_READ_STATUS);
1585 retcode = flash_full_status_check(info, sector, info->erase_blk_tout,
1586 prot ? "protect" : "unprotect");
1588 info->protect[sector] = prot;
1591 * On some of Intel's flash chips (marked via legacy_unlock)
1592 * unprotect unprotects all locking.
1594 if (prot == 0 && info->legacy_unlock) {
1597 for (i = 0; i < info->sector_count; i++) {
1598 if (info->protect[i])
1599 flash_real_protect(info, i, 1);
1606 /*-----------------------------------------------------------------------
1607 * flash_read_user_serial - read the OneTimeProgramming cells
1609 void flash_read_user_serial(flash_info_t *info, void *buffer, int offset,
1616 src = flash_map(info, 0, FLASH_OFFSET_USER_PROTECTION);
1617 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1618 memcpy(dst, src + offset, len);
1619 flash_write_cmd(info, 0, 0, info->cmd_reset);
1621 flash_unmap(info, 0, FLASH_OFFSET_USER_PROTECTION, src);
1625 * flash_read_factory_serial - read the device Id from the protection area
1627 void flash_read_factory_serial(flash_info_t *info, void *buffer, int offset,
1632 src = flash_map(info, 0, FLASH_OFFSET_INTEL_PROTECTION);
1633 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1634 memcpy(buffer, src + offset, len);
1635 flash_write_cmd(info, 0, 0, info->cmd_reset);
1637 flash_unmap(info, 0, FLASH_OFFSET_INTEL_PROTECTION, src);
1640 #endif /* CONFIG_SYS_FLASH_PROTECTION */
1642 /*-----------------------------------------------------------------------
1643 * Reverse the order of the erase regions in the CFI QRY structure.
1644 * This is needed for chips that are either a) correctly detected as
1645 * top-boot, or b) buggy.
1647 static void cfi_reverse_geometry(struct cfi_qry *qry)
1652 for (i = 0, j = qry->num_erase_regions - 1; i < j; i++, j--) {
1653 tmp = get_unaligned(&qry->erase_region_info[i]);
1654 put_unaligned(get_unaligned(&qry->erase_region_info[j]),
1655 &qry->erase_region_info[i]);
1656 put_unaligned(tmp, &qry->erase_region_info[j]);
1660 /*-----------------------------------------------------------------------
1661 * read jedec ids from device and set corresponding fields in info struct
1663 * Note: assume cfi->vendor, cfi->portwidth and cfi->chipwidth are correct
1666 static void cmdset_intel_read_jedec_ids(flash_info_t *info)
1668 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1670 flash_write_cmd(info, 0, 0, FLASH_CMD_READ_ID);
1671 udelay(1000); /* some flash are slow to respond */
1672 info->manufacturer_id = flash_read_uchar(info,
1673 FLASH_OFFSET_MANUFACTURER_ID);
1674 info->device_id = (info->chipwidth == FLASH_CFI_16BIT) ?
1675 flash_read_word(info, FLASH_OFFSET_DEVICE_ID) :
1676 flash_read_uchar(info, FLASH_OFFSET_DEVICE_ID);
1677 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1680 static int cmdset_intel_init(flash_info_t *info, struct cfi_qry *qry)
1682 info->cmd_reset = FLASH_CMD_RESET;
1684 cmdset_intel_read_jedec_ids(info);
1685 flash_write_cmd(info, 0, info->cfi_offset, FLASH_CMD_CFI);
1687 #ifdef CONFIG_SYS_FLASH_PROTECTION
1688 /* read legacy lock/unlock bit from intel flash */
1689 if (info->ext_addr) {
1690 info->legacy_unlock =
1691 flash_read_uchar(info, info->ext_addr + 5) & 0x08;
1698 static void cmdset_amd_read_jedec_ids(flash_info_t *info)
1704 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1705 flash_unlock_seq(info, 0);
1706 flash_write_cmd(info, 0, info->addr_unlock1, FLASH_CMD_READ_ID);
1707 udelay(1000); /* some flash are slow to respond */
1709 manu_id = flash_read_uchar(info, FLASH_OFFSET_MANUFACTURER_ID);
1710 /* JEDEC JEP106Z specifies ID codes up to bank 7 */
1711 while (manu_id == FLASH_CONTINUATION_CODE && bank_id < 0x800) {
1713 manu_id = flash_read_uchar(info,
1714 bank_id | FLASH_OFFSET_MANUFACTURER_ID);
1716 info->manufacturer_id = manu_id;
1718 debug("info->ext_addr = 0x%x, cfi_version = 0x%x\n",
1719 info->ext_addr, info->cfi_version);
1720 if (info->ext_addr && info->cfi_version >= 0x3134) {
1721 /* read software feature (at 0x53) */
1722 feature = flash_read_uchar(info, info->ext_addr + 0x13);
1723 debug("feature = 0x%x\n", feature);
1724 info->sr_supported = feature & 0x1;
1727 switch (info->chipwidth) {
1728 case FLASH_CFI_8BIT:
1729 info->device_id = flash_read_uchar(info,
1730 FLASH_OFFSET_DEVICE_ID);
1731 if (info->device_id == 0x7E) {
1732 /* AMD 3-byte (expanded) device ids */
1733 info->device_id2 = flash_read_uchar(info,
1734 FLASH_OFFSET_DEVICE_ID2);
1735 info->device_id2 <<= 8;
1736 info->device_id2 |= flash_read_uchar(info,
1737 FLASH_OFFSET_DEVICE_ID3);
1740 case FLASH_CFI_16BIT:
1741 info->device_id = flash_read_word(info,
1742 FLASH_OFFSET_DEVICE_ID);
1743 if ((info->device_id & 0xff) == 0x7E) {
1744 /* AMD 3-byte (expanded) device ids */
1745 info->device_id2 = flash_read_uchar(info,
1746 FLASH_OFFSET_DEVICE_ID2);
1747 info->device_id2 <<= 8;
1748 info->device_id2 |= flash_read_uchar(info,
1749 FLASH_OFFSET_DEVICE_ID3);
1755 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1759 static int cmdset_amd_init(flash_info_t *info, struct cfi_qry *qry)
1761 info->cmd_reset = AMD_CMD_RESET;
1762 info->cmd_erase_sector = AMD_CMD_ERASE_SECTOR;
1764 cmdset_amd_read_jedec_ids(info);
1765 flash_write_cmd(info, 0, info->cfi_offset, FLASH_CMD_CFI);
1767 #ifdef CONFIG_SYS_FLASH_PROTECTION
1768 if (info->ext_addr) {
1769 /* read sector protect/unprotect scheme (at 0x49) */
1770 if (flash_read_uchar(info, info->ext_addr + 9) == 0x8)
1771 info->legacy_unlock = 1;
1778 #ifdef CONFIG_FLASH_CFI_LEGACY
1779 static void flash_read_jedec_ids(flash_info_t *info)
1781 info->manufacturer_id = 0;
1782 info->device_id = 0;
1783 info->device_id2 = 0;
1785 switch (info->vendor) {
1786 case CFI_CMDSET_INTEL_PROG_REGIONS:
1787 case CFI_CMDSET_INTEL_STANDARD:
1788 case CFI_CMDSET_INTEL_EXTENDED:
1789 cmdset_intel_read_jedec_ids(info);
1791 case CFI_CMDSET_AMD_STANDARD:
1792 case CFI_CMDSET_AMD_EXTENDED:
1793 cmdset_amd_read_jedec_ids(info);
1800 /*-----------------------------------------------------------------------
1801 * Call board code to request info about non-CFI flash.
1802 * board_flash_get_legacy needs to fill in at least:
1803 * info->portwidth, info->chipwidth and info->interface for Jedec probing.
1805 static int flash_detect_legacy(phys_addr_t base, int banknum)
1807 flash_info_t *info = &flash_info[banknum];
1809 if (board_flash_get_legacy(base, banknum, info)) {
1810 /* board code may have filled info completely. If not, we
1811 * use JEDEC ID probing.
1813 if (!info->vendor) {
1815 CFI_CMDSET_AMD_STANDARD,
1816 CFI_CMDSET_INTEL_STANDARD
1820 for (i = 0; i < ARRAY_SIZE(modes); i++) {
1821 info->vendor = modes[i];
1823 (ulong)map_physmem(base,
1826 if (info->portwidth == FLASH_CFI_8BIT &&
1827 info->interface == FLASH_CFI_X8X16) {
1828 info->addr_unlock1 = 0x2AAA;
1829 info->addr_unlock2 = 0x5555;
1831 info->addr_unlock1 = 0x5555;
1832 info->addr_unlock2 = 0x2AAA;
1834 flash_read_jedec_ids(info);
1835 debug("JEDEC PROBE: ID %x %x %x\n",
1836 info->manufacturer_id,
1839 if (jedec_flash_match(info, info->start[0]))
1842 unmap_physmem((void *)info->start[0],
1847 switch (info->vendor) {
1848 case CFI_CMDSET_INTEL_PROG_REGIONS:
1849 case CFI_CMDSET_INTEL_STANDARD:
1850 case CFI_CMDSET_INTEL_EXTENDED:
1851 info->cmd_reset = FLASH_CMD_RESET;
1853 case CFI_CMDSET_AMD_STANDARD:
1854 case CFI_CMDSET_AMD_EXTENDED:
1855 case CFI_CMDSET_AMD_LEGACY:
1856 info->cmd_reset = AMD_CMD_RESET;
1859 info->flash_id = FLASH_MAN_CFI;
1862 return 0; /* use CFI */
1865 static inline int flash_detect_legacy(phys_addr_t base, int banknum)
1867 return 0; /* use CFI */
1871 /*-----------------------------------------------------------------------
1872 * detect if flash is compatible with the Common Flash Interface (CFI)
1873 * http://www.jedec.org/download/search/jesd68.pdf
1875 static void flash_read_cfi(flash_info_t *info, void *buf, unsigned int start,
1881 for (i = 0; i < len; i++)
1882 p[i] = flash_read_uchar(info, start + i);
1885 static void __flash_cmd_reset(flash_info_t *info)
1888 * We do not yet know what kind of commandset to use, so we issue
1889 * the reset command in both Intel and AMD variants, in the hope
1890 * that AMD flash roms ignore the Intel command.
1892 flash_write_cmd(info, 0, 0, AMD_CMD_RESET);
1894 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
1897 void flash_cmd_reset(flash_info_t *info)
1898 __attribute__((weak, alias("__flash_cmd_reset")));
1900 static int __flash_detect_cfi(flash_info_t *info, struct cfi_qry *qry)
1904 /* Issue FLASH reset command */
1905 flash_cmd_reset(info);
1907 for (cfi_offset = 0; cfi_offset < ARRAY_SIZE(flash_offset_cfi);
1909 flash_write_cmd(info, 0, flash_offset_cfi[cfi_offset],
1911 if (flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP, 'Q') &&
1912 flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 1, 'R') &&
1913 flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 2, 'Y')) {
1914 flash_read_cfi(info, qry, FLASH_OFFSET_CFI_RESP,
1915 sizeof(struct cfi_qry));
1916 info->interface = le16_to_cpu(qry->interface_desc);
1918 info->cfi_offset = flash_offset_cfi[cfi_offset];
1919 debug("device interface is %d\n",
1921 debug("found port %d chip %d ",
1922 info->portwidth, info->chipwidth);
1923 debug("port %d bits chip %d bits\n",
1924 info->portwidth << CFI_FLASH_SHIFT_WIDTH,
1925 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
1927 /* calculate command offsets as in the Linux driver */
1928 info->addr_unlock1 = 0x555;
1929 info->addr_unlock2 = 0x2aa;
1932 * modify the unlock address if we are
1933 * in compatibility mode
1935 if (/* x8/x16 in x8 mode */
1936 (info->chipwidth == FLASH_CFI_BY8 &&
1937 info->interface == FLASH_CFI_X8X16) ||
1938 /* x16/x32 in x16 mode */
1939 (info->chipwidth == FLASH_CFI_BY16 &&
1940 info->interface == FLASH_CFI_X16X32)) {
1941 info->addr_unlock1 = 0xaaa;
1942 info->addr_unlock2 = 0x555;
1945 info->name = "CFI conformant";
1953 static int flash_detect_cfi(flash_info_t *info, struct cfi_qry *qry)
1955 debug("flash detect cfi\n");
1957 for (info->portwidth = CONFIG_SYS_FLASH_CFI_WIDTH;
1958 info->portwidth <= FLASH_CFI_64BIT; info->portwidth <<= 1) {
1959 for (info->chipwidth = FLASH_CFI_BY8;
1960 info->chipwidth <= info->portwidth;
1961 info->chipwidth <<= 1)
1962 if (__flash_detect_cfi(info, qry))
1965 debug("not found\n");
1970 * Manufacturer-specific quirks. Add workarounds for geometry
1971 * reversal, etc. here.
1973 static void flash_fixup_amd(flash_info_t *info, struct cfi_qry *qry)
1975 /* check if flash geometry needs reversal */
1976 if (qry->num_erase_regions > 1) {
1977 /* reverse geometry if top boot part */
1978 if (info->cfi_version < 0x3131) {
1979 /* CFI < 1.1, try to guess from device id */
1980 if ((info->device_id & 0x80) != 0)
1981 cfi_reverse_geometry(qry);
1982 } else if (flash_read_uchar(info, info->ext_addr + 0xf) == 3) {
1983 /* CFI >= 1.1, deduct from top/bottom flag */
1984 /* note: ext_addr is valid since cfi_version > 0 */
1985 cfi_reverse_geometry(qry);
1990 static void flash_fixup_atmel(flash_info_t *info, struct cfi_qry *qry)
1992 int reverse_geometry = 0;
1994 /* Check the "top boot" bit in the PRI */
1995 if (info->ext_addr && !(flash_read_uchar(info, info->ext_addr + 6) & 1))
1996 reverse_geometry = 1;
1998 /* AT49BV6416(T) list the erase regions in the wrong order.
1999 * However, the device ID is identical with the non-broken
2000 * AT49BV642D they differ in the high byte.
2002 if (info->device_id == 0xd6 || info->device_id == 0xd2)
2003 reverse_geometry = !reverse_geometry;
2005 if (reverse_geometry)
2006 cfi_reverse_geometry(qry);
2009 static void flash_fixup_stm(flash_info_t *info, struct cfi_qry *qry)
2011 /* check if flash geometry needs reversal */
2012 if (qry->num_erase_regions > 1) {
2013 /* reverse geometry if top boot part */
2014 if (info->cfi_version < 0x3131) {
2015 /* CFI < 1.1, guess by device id */
2016 if (info->device_id == 0x22CA || /* M29W320DT */
2017 info->device_id == 0x2256 || /* M29W320ET */
2018 info->device_id == 0x22D7) { /* M29W800DT */
2019 cfi_reverse_geometry(qry);
2021 } else if (flash_read_uchar(info, info->ext_addr + 0xf) == 3) {
2022 /* CFI >= 1.1, deduct from top/bottom flag */
2023 /* note: ext_addr is valid since cfi_version > 0 */
2024 cfi_reverse_geometry(qry);
2029 static void flash_fixup_sst(flash_info_t *info, struct cfi_qry *qry)
2032 * SST, for many recent nor parallel flashes, says they are
2033 * CFI-conformant. This is not true, since qry struct.
2034 * reports a std. AMD command set (0x0002), while SST allows to
2035 * erase two different sector sizes for the same memory.
2036 * 64KB sector (SST call it block) needs 0x30 to be erased.
2037 * 4KB sector (SST call it sector) needs 0x50 to be erased.
2038 * Since CFI query detect the 4KB number of sectors, users expects
2039 * a sector granularity of 4KB, and it is here set.
2041 if (info->device_id == 0x5D23 || /* SST39VF3201B */
2042 info->device_id == 0x5C23) { /* SST39VF3202B */
2043 /* set sector granularity to 4KB */
2044 info->cmd_erase_sector = 0x50;
2048 static void flash_fixup_num(flash_info_t *info, struct cfi_qry *qry)
2051 * The M29EW devices seem to report the CFI information wrong
2052 * when it's in 8 bit mode.
2053 * There's an app note from Numonyx on this issue.
2054 * So adjust the buffer size for M29EW while operating in 8-bit mode
2056 if (qry->max_buf_write_size > 0x8 &&
2057 info->device_id == 0x7E &&
2058 (info->device_id2 == 0x2201 ||
2059 info->device_id2 == 0x2301 ||
2060 info->device_id2 == 0x2801 ||
2061 info->device_id2 == 0x4801)) {
2062 debug("Adjusted buffer size on Numonyx flash");
2063 debug(" M29EW family in 8 bit mode\n");
2064 qry->max_buf_write_size = 0x8;
2069 * The following code cannot be run from FLASH!
2072 ulong flash_get_size(phys_addr_t base, int banknum)
2074 flash_info_t *info = &flash_info[banknum];
2076 flash_sect_t sect_cnt;
2080 uchar num_erase_regions;
2081 int erase_region_size;
2082 int erase_region_count;
2084 unsigned long max_size;
2086 memset(&qry, 0, sizeof(qry));
2089 info->cfi_version = 0;
2090 #ifdef CONFIG_SYS_FLASH_PROTECTION
2091 info->legacy_unlock = 0;
2094 info->start[0] = (ulong)map_physmem(base, info->portwidth, MAP_NOCACHE);
2096 if (flash_detect_cfi(info, &qry)) {
2097 info->vendor = le16_to_cpu(get_unaligned(&qry.p_id));
2098 info->ext_addr = le16_to_cpu(get_unaligned(&qry.p_adr));
2099 num_erase_regions = qry.num_erase_regions;
2101 if (info->ext_addr) {
2102 info->cfi_version = (ushort)flash_read_uchar(info,
2103 info->ext_addr + 3) << 8;
2104 info->cfi_version |= (ushort)flash_read_uchar(info,
2105 info->ext_addr + 4);
2109 flash_printqry(&qry);
2112 switch (info->vendor) {
2113 case CFI_CMDSET_INTEL_PROG_REGIONS:
2114 case CFI_CMDSET_INTEL_STANDARD:
2115 case CFI_CMDSET_INTEL_EXTENDED:
2116 cmdset_intel_init(info, &qry);
2118 case CFI_CMDSET_AMD_STANDARD:
2119 case CFI_CMDSET_AMD_EXTENDED:
2120 cmdset_amd_init(info, &qry);
2123 printf("CFI: Unknown command set 0x%x\n",
2126 * Unfortunately, this means we don't know how
2127 * to get the chip back to Read mode. Might
2128 * as well try an Intel-style reset...
2130 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
2134 /* Do manufacturer-specific fixups */
2135 switch (info->manufacturer_id) {
2136 case 0x0001: /* AMD */
2137 case 0x0037: /* AMIC */
2138 flash_fixup_amd(info, &qry);
2141 flash_fixup_atmel(info, &qry);
2144 flash_fixup_stm(info, &qry);
2146 case 0x00bf: /* SST */
2147 flash_fixup_sst(info, &qry);
2149 case 0x0089: /* Numonyx */
2150 flash_fixup_num(info, &qry);
2154 debug("manufacturer is %d\n", info->vendor);
2155 debug("manufacturer id is 0x%x\n", info->manufacturer_id);
2156 debug("device id is 0x%x\n", info->device_id);
2157 debug("device id2 is 0x%x\n", info->device_id2);
2158 debug("cfi version is 0x%04x\n", info->cfi_version);
2160 size_ratio = info->portwidth / info->chipwidth;
2161 /* if the chip is x8/x16 reduce the ratio by half */
2162 if (info->interface == FLASH_CFI_X8X16 &&
2163 info->chipwidth == FLASH_CFI_BY8) {
2166 debug("size_ratio %d port %d bits chip %d bits\n",
2167 size_ratio, info->portwidth << CFI_FLASH_SHIFT_WIDTH,
2168 info->chipwidth << CFI_FLASH_SHIFT_WIDTH);
2169 info->size = 1 << qry.dev_size;
2170 /* multiply the size by the number of chips */
2171 info->size *= size_ratio;
2172 max_size = cfi_flash_bank_size(banknum);
2173 if (max_size && info->size > max_size) {
2174 debug("[truncated from %ldMiB]", info->size >> 20);
2175 info->size = max_size;
2177 debug("found %d erase regions\n", num_erase_regions);
2180 for (i = 0; i < num_erase_regions; i++) {
2181 if (i > NUM_ERASE_REGIONS) {
2182 printf("%d erase regions found, only %d used\n",
2183 num_erase_regions, NUM_ERASE_REGIONS);
2187 tmp = le32_to_cpu(get_unaligned(
2188 &qry.erase_region_info[i]));
2189 debug("erase region %u: 0x%08lx\n", i, tmp);
2191 erase_region_count = (tmp & 0xffff) + 1;
2194 (tmp & 0xffff) ? ((tmp & 0xffff) * 256) : 128;
2195 debug("erase_region_count = %d ", erase_region_count);
2196 debug("erase_region_size = %d\n", erase_region_size);
2197 for (j = 0; j < erase_region_count; j++) {
2198 if (sector - base >= info->size)
2200 if (sect_cnt >= CONFIG_SYS_MAX_FLASH_SECT) {
2201 printf("ERROR: too many flash sectors\n");
2204 info->start[sect_cnt] =
2205 (ulong)map_physmem(sector,
2208 sector += (erase_region_size * size_ratio);
2211 * Only read protection status from
2212 * supported devices (intel...)
2214 switch (info->vendor) {
2215 case CFI_CMDSET_INTEL_PROG_REGIONS:
2216 case CFI_CMDSET_INTEL_EXTENDED:
2217 case CFI_CMDSET_INTEL_STANDARD:
2219 * Set flash to read-id mode. Otherwise
2220 * reading protected status is not
2223 flash_write_cmd(info, sect_cnt, 0,
2225 info->protect[sect_cnt] =
2226 flash_isset(info, sect_cnt,
2227 FLASH_OFFSET_PROTECT,
2228 FLASH_STATUS_PROTECT);
2229 flash_write_cmd(info, sect_cnt, 0,
2232 case CFI_CMDSET_AMD_EXTENDED:
2233 case CFI_CMDSET_AMD_STANDARD:
2234 if (!info->legacy_unlock) {
2235 /* default: not protected */
2236 info->protect[sect_cnt] = 0;
2240 /* Read protection (PPB) from sector */
2241 flash_write_cmd(info, 0, 0,
2243 flash_unlock_seq(info, 0);
2244 flash_write_cmd(info, 0,
2247 info->protect[sect_cnt] =
2250 FLASH_OFFSET_PROTECT,
2251 FLASH_STATUS_PROTECT);
2254 /* default: not protected */
2255 info->protect[sect_cnt] = 0;
2262 info->sector_count = sect_cnt;
2263 info->buffer_size = 1 << le16_to_cpu(qry.max_buf_write_size);
2264 tmp = 1 << qry.block_erase_timeout_typ;
2265 info->erase_blk_tout = tmp *
2266 (1 << qry.block_erase_timeout_max);
2267 tmp = (1 << qry.buf_write_timeout_typ) *
2268 (1 << qry.buf_write_timeout_max);
2270 /* round up when converting to ms */
2271 info->buffer_write_tout = (tmp + 999) / 1000;
2272 tmp = (1 << qry.word_write_timeout_typ) *
2273 (1 << qry.word_write_timeout_max);
2274 /* round up when converting to ms */
2275 info->write_tout = (tmp + 999) / 1000;
2276 info->flash_id = FLASH_MAN_CFI;
2277 if (info->interface == FLASH_CFI_X8X16 &&
2278 info->chipwidth == FLASH_CFI_BY8) {
2279 /* XXX - Need to test on x8/x16 in parallel. */
2280 info->portwidth >>= 1;
2283 flash_write_cmd(info, 0, 0, info->cmd_reset);
2286 return (info->size);
2289 #ifdef CONFIG_FLASH_CFI_MTD
2290 void flash_set_verbose(uint v)
2296 static void cfi_flash_set_config_reg(u32 base, u16 val)
2298 #ifdef CONFIG_SYS_CFI_FLASH_CONFIG_REGS
2300 * Only set this config register if really defined
2301 * to a valid value (0xffff is invalid)
2307 * Set configuration register. Data is "encrypted" in the 16 lower
2310 flash_write16(FLASH_CMD_SETUP, (void *)(base + (val << 1)));
2311 flash_write16(FLASH_CMD_SET_CR_CONFIRM, (void *)(base + (val << 1)));
2314 * Finally issue reset-command to bring device back to
2317 flash_write16(FLASH_CMD_RESET, (void *)base);
2321 /*-----------------------------------------------------------------------
2324 static void flash_protect_default(void)
2326 #if defined(CONFIG_SYS_FLASH_AUTOPROTECT_LIST)
2331 } apl[] = CONFIG_SYS_FLASH_AUTOPROTECT_LIST;
2334 /* Monitor protection ON by default */
2335 #if defined(CONFIG_SYS_MONITOR_BASE) && \
2336 (CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE) && \
2337 (!defined(CONFIG_MONITOR_IS_IN_RAM))
2338 flash_protect(FLAG_PROTECT_SET,
2339 CONFIG_SYS_MONITOR_BASE,
2340 CONFIG_SYS_MONITOR_BASE + monitor_flash_len - 1,
2341 flash_get_info(CONFIG_SYS_MONITOR_BASE));
2344 /* Environment protection ON by default */
2345 #ifdef CONFIG_ENV_IS_IN_FLASH
2346 flash_protect(FLAG_PROTECT_SET,
2348 CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1,
2349 flash_get_info(CONFIG_ENV_ADDR));
2352 /* Redundant environment protection ON by default */
2353 #ifdef CONFIG_ENV_ADDR_REDUND
2354 flash_protect(FLAG_PROTECT_SET,
2355 CONFIG_ENV_ADDR_REDUND,
2356 CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1,
2357 flash_get_info(CONFIG_ENV_ADDR_REDUND));
2360 #if defined(CONFIG_SYS_FLASH_AUTOPROTECT_LIST)
2361 for (i = 0; i < ARRAY_SIZE(apl); i++) {
2362 debug("autoprotecting from %08lx to %08lx\n",
2363 apl[i].start, apl[i].start + apl[i].size - 1);
2364 flash_protect(FLAG_PROTECT_SET,
2366 apl[i].start + apl[i].size - 1,
2367 flash_get_info(apl[i].start));
2372 unsigned long flash_init(void)
2374 unsigned long size = 0;
2377 #ifdef CONFIG_SYS_FLASH_PROTECTION
2378 /* read environment from EEPROM */
2381 env_get_f("unlock", s, sizeof(s));
2384 #ifdef CONFIG_CFI_FLASH /* for driver model */
2385 cfi_flash_init_dm();
2388 /* Init: no FLASHes known */
2389 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; ++i) {
2390 flash_info[i].flash_id = FLASH_UNKNOWN;
2392 /* Optionally write flash configuration register */
2393 cfi_flash_set_config_reg(cfi_flash_bank_addr(i),
2394 cfi_flash_config_reg(i));
2396 if (!flash_detect_legacy(cfi_flash_bank_addr(i), i))
2397 flash_get_size(cfi_flash_bank_addr(i), i);
2398 size += flash_info[i].size;
2399 if (flash_info[i].flash_id == FLASH_UNKNOWN) {
2400 #ifndef CONFIG_SYS_FLASH_QUIET_TEST
2401 printf("## Unknown flash on Bank %d ", i + 1);
2402 printf("- Size = 0x%08lx = %ld MB\n",
2404 flash_info[i].size >> 20);
2405 #endif /* CONFIG_SYS_FLASH_QUIET_TEST */
2407 #ifdef CONFIG_SYS_FLASH_PROTECTION
2408 else if (strcmp(s, "yes") == 0) {
2410 * Only the U-Boot image and it's environment
2411 * is protected, all other sectors are
2412 * unprotected (unlocked) if flash hardware
2413 * protection is used (CONFIG_SYS_FLASH_PROTECTION)
2414 * and the environment variable "unlock" is
2417 if (flash_info[i].legacy_unlock) {
2421 * Disable legacy_unlock temporarily,
2422 * since flash_real_protect would
2423 * relock all other sectors again
2426 flash_info[i].legacy_unlock = 0;
2429 * Legacy unlocking (e.g. Intel J3) ->
2430 * unlock only one sector. This will
2431 * unlock all sectors.
2433 flash_real_protect(&flash_info[i], 0, 0);
2435 flash_info[i].legacy_unlock = 1;
2438 * Manually mark other sectors as
2439 * unlocked (unprotected)
2441 for (k = 1; k < flash_info[i].sector_count; k++)
2442 flash_info[i].protect[k] = 0;
2445 * No legancy unlocking -> unlock all sectors
2447 flash_protect(FLAG_PROTECT_CLEAR,
2448 flash_info[i].start[0],
2449 flash_info[i].start[0]
2450 + flash_info[i].size - 1,
2454 #endif /* CONFIG_SYS_FLASH_PROTECTION */
2457 flash_protect_default();
2458 #ifdef CONFIG_FLASH_CFI_MTD
2465 #ifdef CONFIG_CFI_FLASH /* for driver model */
2466 static int cfi_flash_probe(struct udevice *dev)
2468 const fdt32_t *cell;
2472 addrc = dev_read_addr_cells(dev);
2473 sizec = dev_read_size_cells(dev);
2475 /* decode regs; there may be multiple reg tuples. */
2476 cell = dev_read_prop(dev, "reg", &len);
2480 len /= sizeof(fdt32_t);
2484 addr = dev_translate_address(dev, cell + idx);
2486 flash_info[cfi_flash_num_flash_banks].dev = dev;
2487 flash_info[cfi_flash_num_flash_banks].base = addr;
2488 cfi_flash_num_flash_banks++;
2490 idx += addrc + sizec;
2492 gd->bd->bi_flashstart = flash_info[0].base;
2497 static const struct udevice_id cfi_flash_ids[] = {
2498 { .compatible = "cfi-flash" },
2499 { .compatible = "jedec-flash" },
2503 U_BOOT_DRIVER(cfi_flash) = {
2504 .name = "cfi_flash",
2506 .of_match = cfi_flash_ids,
2507 .probe = cfi_flash_probe,
2509 #endif /* CONFIG_CFI_FLASH */