3 * Brad Kemp, Seranoa Networks, Brad.Kemp@seranoa.com
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 #include <asm/processor.h>
26 #include <asm/cache.h>
30 * This file implements a Common Flash Interface (CFI) driver for U-Boot.
31 * The width of the port and the width of the chips are determined at initialization.
32 * These widths are used to calculate the address for access CFI data structures.
33 * It has been tested on an Intel Strataflash implementation.
36 * JEDEC Standard JESD68 - Common Flash Interface (CFI)
37 * JEDEC Standard JEP137-A Common Flash Interface (CFI) ID Codes
38 * Intel Application Note 646 Common Flash Interface (CFI) and Command Sets
39 * Intel 290667-008 3 Volt Intel StrataFlash Memory datasheet
42 * Use Primary Extended Query table (PRI) and Alternate Algorithm Query Table (ALT) to determine if protection is available
43 * Add support for other command sets Use the PRI and ALT to determine command set
44 * Verify erase and program timeouts.
47 #define FLASH_CMD_CFI 0x98
48 #define FLASH_CMD_READ_ID 0x90
49 #define FLASH_CMD_RESET 0xff
50 #define FLASH_CMD_BLOCK_ERASE 0x20
51 #define FLASH_CMD_ERASE_CONFIRM 0xD0
52 #define FLASH_CMD_WRITE 0x40
53 #define FLASH_CMD_PROTECT 0x60
54 #define FLASH_CMD_PROTECT_SET 0x01
55 #define FLASH_CMD_PROTECT_CLEAR 0xD0
56 #define FLASH_CMD_CLEAR_STATUS 0x50
57 #define FLASH_CMD_WRITE_TO_BUFFER 0xE8
58 #define FLASH_CMD_WRITE_BUFFER_CONFIRM 0xD0
60 #define FLASH_STATUS_DONE 0x80
61 #define FLASH_STATUS_ESS 0x40
62 #define FLASH_STATUS_ECLBS 0x20
63 #define FLASH_STATUS_PSLBS 0x10
64 #define FLASH_STATUS_VPENS 0x08
65 #define FLASH_STATUS_PSS 0x04
66 #define FLASH_STATUS_DPS 0x02
67 #define FLASH_STATUS_R 0x01
68 #define FLASH_STATUS_PROTECT 0x01
70 #define FLASH_OFFSET_CFI 0x55
71 #define FLASH_OFFSET_CFI_RESP 0x10
72 #define FLASH_OFFSET_WTOUT 0x1F
73 #define FLASH_OFFSET_WBTOUT 0x20
74 #define FLASH_OFFSET_ETOUT 0x21
75 #define FLASH_OFFSET_CETOUT 0x22
76 #define FLASH_OFFSET_WMAX_TOUT 0x23
77 #define FLASH_OFFSET_WBMAX_TOUT 0x24
78 #define FLASH_OFFSET_EMAX_TOUT 0x25
79 #define FLASH_OFFSET_CEMAX_TOUT 0x26
80 #define FLASH_OFFSET_SIZE 0x27
81 #define FLASH_OFFSET_INTERFACE 0x28
82 #define FLASH_OFFSET_BUFFER_SIZE 0x2A
83 #define FLASH_OFFSET_NUM_ERASE_REGIONS 0x2C
84 #define FLASH_OFFSET_ERASE_REGIONS 0x2D
85 #define FLASH_OFFSET_PROTECT 0x02
86 #define FLASH_OFFSET_USER_PROTECTION 0x85
87 #define FLASH_OFFSET_INTEL_PROTECTION 0x81
89 #define FLASH_MAN_CFI 0x01000000
103 #define NUM_ERASE_REGIONS 4
105 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS]; /* info for FLASH chips */
107 /*-----------------------------------------------------------------------
111 static void flash_add_byte(flash_info_t * info, cfiword_t * cword, uchar c);
112 static void flash_make_cmd(flash_info_t * info, uchar cmd, void *cmdbuf);
113 static void flash_write_cmd(flash_info_t * info, int sect, uchar offset,
115 static int flash_isequal(flash_info_t * info, int sect, uchar offset,
117 static int flash_isset(flash_info_t * info, int sect, uchar offset, uchar cmd);
118 static int flash_detect_cfi(flash_info_t * info);
119 static ulong flash_get_size(ulong base, int banknum);
120 static int flash_write_cfiword(flash_info_t * info, ulong dest,
122 static int flash_full_status_check(flash_info_t * info, ulong sector,
123 ulong tout, char *prompt);
124 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
125 static int flash_write_cfibuffer(flash_info_t * info, ulong dest, uchar * cp,
128 /*-----------------------------------------------------------------------
129 * create an address based on the offset and the port width
131 inline uchar *flash_make_addr(flash_info_t * info, int sect, int offset)
133 return ((uchar *) (info->start[sect] + (offset * info->portwidth)));
136 /*-----------------------------------------------------------------------
137 * read a character at a port width address
139 inline uchar flash_read_uchar(flash_info_t * info, uchar offset)
142 cp = flash_make_addr(info, 0, offset);
143 return (cp[info->portwidth - 1]);
146 /*-----------------------------------------------------------------------
147 * read a short word by swapping for ppc format.
149 ushort flash_read_ushort(flash_info_t * info, int sect, uchar offset)
153 addr = flash_make_addr(info, sect, offset);
154 return ((addr[(2 * info->portwidth) - 1] << 8) |
155 addr[info->portwidth - 1]);
159 /*-----------------------------------------------------------------------
160 * read a long word by picking the least significant byte of each maiximum
161 * port size word. Swap for ppc format.
163 ulong flash_read_long(flash_info_t * info, int sect, uchar offset)
167 addr = flash_make_addr(info, sect, offset);
168 return ((addr[(2 * info->portwidth) - 1] << 24) |
169 (addr[(info->portwidth) - 1] << 16) |
170 (addr[(4 * info->portwidth) - 1] << 8) |
171 addr[(3 * info->portwidth) - 1]);
175 /*-----------------------------------------------------------------------
177 unsigned long flash_init(void)
181 unsigned long address;
183 /* The flash is positioned back to back, with the demultiplexing of the chip
184 * based on the A24 address line.
188 address = CONFIG_SYS_FLASH_BASE;
191 /* Init: no FLASHes known */
192 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; ++i) {
193 flash_info[i].flash_id = FLASH_UNKNOWN;
194 size += flash_info[i].size = flash_get_size(address, i);
195 address += CONFIG_SYS_FLASH_INCREMENT;
196 if (flash_info[i].flash_id == FLASH_UNKNOWN) {
198 ("## Unknown FLASH on Bank %d - Size = 0x%08lx = %ld MB\n",
199 i, flash_info[0].size, flash_info[i].size << 20);
203 #if 0 /* test-only */
204 /* Monitor protection ON by default */
205 #if (CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE)
207 flash_info[0].start[i] < CONFIG_SYS_MONITOR_BASE + monitor_flash_len - 1;
209 (void)flash_real_protect(&flash_info[0], i, 1);
216 /*-----------------------------------------------------------------------
218 int flash_erase(flash_info_t * info, int s_first, int s_last)
224 if (info->flash_id != FLASH_MAN_CFI) {
225 printf("Can't erase unknown flash type - aborted\n");
228 if ((s_first < 0) || (s_first > s_last)) {
229 printf("- no sectors to erase\n");
234 for (sect = s_first; sect <= s_last; ++sect) {
235 if (info->protect[sect]) {
240 printf("- Warning: %d protected sectors will not be erased!\n",
246 for (sect = s_first; sect <= s_last; sect++) {
247 if (info->protect[sect] == 0) { /* not protected */
248 flash_write_cmd(info, sect, 0, FLASH_CMD_CLEAR_STATUS);
249 flash_write_cmd(info, sect, 0, FLASH_CMD_BLOCK_ERASE);
250 flash_write_cmd(info, sect, 0, FLASH_CMD_ERASE_CONFIRM);
252 if (flash_full_status_check
253 (info, sect, info->erase_blk_tout, "erase")) {
263 /*-----------------------------------------------------------------------
265 void flash_print_info(flash_info_t * info)
269 if (info->flash_id != FLASH_MAN_CFI) {
270 printf("missing or unknown FLASH type\n");
274 printf("CFI conformant FLASH (%d x %d)",
275 (info->portwidth << 3), (info->chipwidth << 3));
276 printf(" Size: %ld MB in %d Sectors\n",
277 info->size >> 20, info->sector_count);
279 (" Erase timeout %ld ms, write timeout %ld ms, buffer write timeout %ld ms, buffer size %d\n",
280 info->erase_blk_tout, info->write_tout, info->buffer_write_tout,
283 printf(" Sector Start Addresses:");
284 for (i = 0; i < info->sector_count; ++i) {
288 info->start[i], info->protect[i] ? " (RO)" : " ");
294 /*-----------------------------------------------------------------------
295 * Copy memory to flash, returns:
298 * 2 - Flash not erased
300 int write_buff(flash_info_t * info, uchar * src, ulong addr, ulong cnt)
308 /* get lower aligned address */
309 wp = (addr & ~(info->portwidth - 1));
311 /* handle unaligned start */
312 if ((aln = addr - wp) != 0) {
315 for (i = 0; i < aln; ++i, ++cp)
316 flash_add_byte(info, &cword, (*(uchar *) cp));
318 for (; (i < info->portwidth) && (cnt > 0); i++) {
319 flash_add_byte(info, &cword, *src++);
323 for (; (cnt == 0) && (i < info->portwidth); ++i, ++cp)
324 flash_add_byte(info, &cword, (*(uchar *) cp));
325 if ((rc = flash_write_cfiword(info, wp, cword)) != 0)
329 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
330 while (cnt >= info->portwidth) {
331 i = info->buffer_size > cnt ? cnt : info->buffer_size;
332 if ((rc = flash_write_cfibuffer(info, wp, src, i)) != ERR_OK)
339 /* handle the aligned part */
340 while (cnt >= info->portwidth) {
342 for (i = 0; i < info->portwidth; i++) {
343 flash_add_byte(info, &cword, *src++);
345 if ((rc = flash_write_cfiword(info, wp, cword)) != 0)
347 wp += info->portwidth;
348 cnt -= info->portwidth;
350 #endif /* CONFIG_SYS_FLASH_USE_BUFFER_WRITE */
356 * handle unaligned tail bytes
359 for (i = 0, cp = wp; (i < info->portwidth) && (cnt > 0); ++i, ++cp) {
360 flash_add_byte(info, &cword, *src++);
363 for (; i < info->portwidth; ++i, ++cp) {
364 flash_add_byte(info, &cword, (*(uchar *) cp));
367 return flash_write_cfiword(info, wp, cword);
370 /*-----------------------------------------------------------------------
372 int flash_real_protect(flash_info_t * info, long sector, int prot)
376 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
377 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT);
379 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT_SET);
381 flash_write_cmd(info, sector, 0, FLASH_CMD_PROTECT_CLEAR);
384 flash_full_status_check(info, sector, info->erase_blk_tout,
385 prot ? "protect" : "unprotect")) == 0) {
387 info->protect[sector] = prot;
388 /* Intel's unprotect unprotects all locking */
391 for (i = 0; i < info->sector_count; i++) {
392 if (info->protect[i])
393 flash_real_protect(info, i, 1);
401 /*-----------------------------------------------------------------------
402 * wait for XSR.7 to be set. Time out with an error if it does not.
403 * This routine does not set the flash to read-array mode.
405 static int flash_status_check(flash_info_t * info, ulong sector, ulong tout,
410 /* Wait for command completion */
411 start = get_timer(0);
412 while (!flash_isset(info, sector, 0, FLASH_STATUS_DONE)) {
413 if (get_timer(start) > info->erase_blk_tout) {
414 printf("Flash %s timeout at address %lx\n", prompt,
415 info->start[sector]);
416 flash_write_cmd(info, sector, 0, FLASH_CMD_RESET);
423 /*-----------------------------------------------------------------------
424 * Wait for XSR.7 to be set, if it times out print an error, otherwise do a full status check.
425 * This routine sets the flash to read-array mode.
427 static int flash_full_status_check(flash_info_t * info, ulong sector,
428 ulong tout, char *prompt)
431 retcode = flash_status_check(info, sector, tout, prompt);
432 if ((retcode == ERR_OK)
433 && !flash_isequal(info, sector, 0, FLASH_STATUS_DONE)) {
435 printf("Flash %s error at address %lx\n", prompt,
436 info->start[sector]);
439 FLASH_STATUS_ECLBS | FLASH_STATUS_PSLBS)) {
440 printf("Command Sequence Error.\n");
441 } else if (flash_isset(info, sector, 0, FLASH_STATUS_ECLBS)) {
442 printf("Block Erase Error.\n");
443 retcode = ERR_NOT_ERASED;
444 } else if (flash_isset(info, sector, 0, FLASH_STATUS_PSLBS)) {
445 printf("Locking Error\n");
447 if (flash_isset(info, sector, 0, FLASH_STATUS_DPS)) {
448 printf("Block locked.\n");
449 retcode = ERR_PROTECTED;
451 if (flash_isset(info, sector, 0, FLASH_STATUS_VPENS))
452 printf("Vpp Low Error.\n");
454 flash_write_cmd(info, sector, 0, FLASH_CMD_RESET);
458 /*-----------------------------------------------------------------------
460 static void flash_add_byte(flash_info_t * info, cfiword_t * cword, uchar c)
462 switch (info->portwidth) {
466 case FLASH_CFI_16BIT:
467 cword->w = (cword->w << 8) | c;
469 case FLASH_CFI_32BIT:
470 cword->l = (cword->l << 8) | c;
474 /*-----------------------------------------------------------------------
475 * make a proper sized command based on the port and chip widths
477 static void flash_make_cmd(flash_info_t * info, uchar cmd, void *cmdbuf)
480 uchar *cp = (uchar *) cmdbuf;
481 for (i = 0; i < info->portwidth; i++)
482 *cp++ = ((i + 1) % info->chipwidth) ? '\0' : cmd;
486 * Write a proper sized command to the correct address
488 static void flash_write_cmd(flash_info_t * info, int sect, uchar offset,
492 volatile cfiptr_t addr;
494 addr.cp = flash_make_addr(info, sect, offset);
495 flash_make_cmd(info, cmd, &cword);
496 switch (info->portwidth) {
500 case FLASH_CFI_16BIT:
503 case FLASH_CFI_32BIT:
509 /*-----------------------------------------------------------------------
511 static int flash_isequal(flash_info_t * info, int sect, uchar offset, uchar cmd)
516 cptr.cp = flash_make_addr(info, sect, offset);
517 flash_make_cmd(info, cmd, &cword);
518 switch (info->portwidth) {
520 retval = (cptr.cp[0] == cword.c);
522 case FLASH_CFI_16BIT:
523 retval = (cptr.wp[0] == cword.w);
525 case FLASH_CFI_32BIT:
526 retval = (cptr.lp[0] == cword.l);
535 /*-----------------------------------------------------------------------
537 static int flash_isset(flash_info_t * info, int sect, uchar offset, uchar cmd)
542 cptr.cp = flash_make_addr(info, sect, offset);
543 flash_make_cmd(info, cmd, &cword);
544 switch (info->portwidth) {
546 retval = ((cptr.cp[0] & cword.c) == cword.c);
548 case FLASH_CFI_16BIT:
549 retval = ((cptr.wp[0] & cword.w) == cword.w);
551 case FLASH_CFI_32BIT:
552 retval = ((cptr.lp[0] & cword.l) == cword.l);
561 /*-----------------------------------------------------------------------
562 * detect if flash is compatible with the Common Flash Interface (CFI)
563 * http://www.jedec.org/download/search/jesd68.pdf
566 static int flash_detect_cfi(flash_info_t * info)
569 for (info->portwidth = FLASH_CFI_8BIT;
570 info->portwidth <= FLASH_CFI_32BIT; info->portwidth <<= 1) {
571 for (info->chipwidth = FLASH_CFI_BY8;
572 info->chipwidth <= info->portwidth;
573 info->chipwidth <<= 1) {
574 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
575 flash_write_cmd(info, 0, FLASH_OFFSET_CFI,
577 if (flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP, 'Q')
578 && flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 1,
580 && flash_isequal(info, 0, FLASH_OFFSET_CFI_RESP + 2,
589 * The following code cannot be run from FLASH!
592 static ulong flash_get_size(ulong base, int banknum)
594 flash_info_t *info = &flash_info[banknum];
597 unsigned long sector;
600 uchar num_erase_regions;
601 int erase_region_size;
602 int erase_region_count;
604 info->start[0] = base;
606 invalidate_dcache_range(base, base + 0x400);
608 if (flash_detect_cfi(info)) {
610 size_ratio = info->portwidth / info->chipwidth;
612 flash_read_uchar(info, FLASH_OFFSET_NUM_ERASE_REGIONS);
616 for (i = 0; i < num_erase_regions; i++) {
617 if (i > NUM_ERASE_REGIONS) {
618 printf("%d erase regions found, only %d used\n",
619 num_erase_regions, NUM_ERASE_REGIONS);
623 flash_read_long(info, 0,
624 FLASH_OFFSET_ERASE_REGIONS);
626 (tmp & 0xffff) ? ((tmp & 0xffff) * 256) : 128;
628 erase_region_count = (tmp & 0xffff) + 1;
629 for (j = 0; j < erase_region_count; j++) {
630 info->start[sect_cnt] = sector;
631 sector += (erase_region_size * size_ratio);
632 info->protect[sect_cnt] =
633 flash_isset(info, sect_cnt,
634 FLASH_OFFSET_PROTECT,
635 FLASH_STATUS_PROTECT);
640 info->sector_count = sect_cnt;
641 /* multiply the size by the number of chips */
643 (1 << flash_read_uchar(info, FLASH_OFFSET_SIZE)) *
646 (1 << flash_read_ushort(info, 0, FLASH_OFFSET_BUFFER_SIZE));
647 tmp = 1 << flash_read_uchar(info, FLASH_OFFSET_ETOUT);
648 info->erase_blk_tout =
650 (1 << flash_read_uchar(info, FLASH_OFFSET_EMAX_TOUT)));
651 tmp = 1 << flash_read_uchar(info, FLASH_OFFSET_WBTOUT);
652 info->buffer_write_tout =
654 (1 << flash_read_uchar(info, FLASH_OFFSET_WBMAX_TOUT)));
655 tmp = 1 << flash_read_uchar(info, FLASH_OFFSET_WTOUT);
658 (1 << flash_read_uchar(info, FLASH_OFFSET_WMAX_TOUT))) /
660 info->flash_id = FLASH_MAN_CFI;
663 flash_write_cmd(info, 0, 0, FLASH_CMD_RESET);
665 printf("portwidth=%d chipwidth=%d\n", info->portwidth, info->chipwidth); /* test-only */
668 printf("found %d erase regions\n", num_erase_regions);
671 printf("size=%08x sectors=%08x \n", info->size, info->sector_count);
676 /*-----------------------------------------------------------------------
678 static int flash_write_cfiword(flash_info_t * info, ulong dest, cfiword_t cword)
685 ctladdr.cp = flash_make_addr(info, 0, 0);
686 cptr.cp = (uchar *) dest;
688 /* Check if Flash is (sufficiently) erased */
689 switch (info->portwidth) {
691 flag = ((cptr.cp[0] & cword.c) == cword.c);
693 case FLASH_CFI_16BIT:
694 flag = ((cptr.wp[0] & cword.w) == cword.w);
696 case FLASH_CFI_32BIT:
697 flag = ((cptr.lp[0] & cword.l) == cword.l);
705 /* Disable interrupts which might cause a timeout here */
706 flag = disable_interrupts();
708 flash_write_cmd(info, 0, 0, FLASH_CMD_CLEAR_STATUS);
709 flash_write_cmd(info, 0, 0, FLASH_CMD_WRITE);
711 switch (info->portwidth) {
713 cptr.cp[0] = cword.c;
715 case FLASH_CFI_16BIT:
716 cptr.wp[0] = cword.w;
718 case FLASH_CFI_32BIT:
719 cptr.lp[0] = cword.l;
723 /* re-enable interrupts if necessary */
727 return flash_full_status_check(info, 0, info->write_tout, "write");
730 #ifdef CONFIG_SYS_FLASH_USE_BUFFER_WRITE
732 /* loop through the sectors from the highest address
733 * when the passed address is greater or equal to the sector address
736 static int find_sector(flash_info_t * info, ulong addr)
739 for (sector = info->sector_count - 1; sector >= 0; sector--) {
740 if (addr >= info->start[sector])
746 static int flash_write_cfibuffer(flash_info_t * info, ulong dest, uchar * cp,
753 volatile cfiptr_t src;
754 volatile cfiptr_t dst;
757 dst.cp = (uchar *) dest;
758 sector = find_sector(info, dest);
759 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
760 flash_write_cmd(info, sector, 0, FLASH_CMD_WRITE_TO_BUFFER);
761 if ((retcode = flash_status_check(info, sector, info->buffer_write_tout,
762 "write to buffer")) == ERR_OK) {
763 switch (info->portwidth) {
767 case FLASH_CFI_16BIT:
770 case FLASH_CFI_32BIT:
777 flash_write_cmd(info, sector, 0, (uchar) cnt - 1);
779 switch (info->portwidth) {
781 *dst.cp++ = *src.cp++;
783 case FLASH_CFI_16BIT:
784 *dst.wp++ = *src.wp++;
786 case FLASH_CFI_32BIT:
787 *dst.lp++ = *src.lp++;
794 flash_write_cmd(info, sector, 0,
795 FLASH_CMD_WRITE_BUFFER_CONFIRM);
797 flash_full_status_check(info, sector,
798 info->buffer_write_tout,
801 flash_write_cmd(info, sector, 0, FLASH_CMD_CLEAR_STATUS);
804 #endif /* CONFIG_SYS_USE_FLASH_BUFFER_WRITE */