2 * (C) Copyright 2006 DENX Software Engineering
4 * See file CREDITS for list of people who contributed to this
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 #if (CONFIG_COMMANDS & CFG_CMD_NAND)
26 #ifdef CONFIG_NEW_NAND_CODE
29 #include <asm/arch/pxa-regs.h>
31 /* mk@tbd move this to pxa-regs */
32 #define OSCR_CLK_FREQ 3.250 /* MHz */
35 #define CFG_DFC_DEBUG1
43 # define DFC_DEBUG1(fmt, args...) printf(fmt, ##args)
45 # define DFC_DEBUG1(fmt, args...)
49 # define DFC_DEBUG2(fmt, args...) printf(fmt, ##args)
51 # define DFC_DEBUG2(fmt, args...)
55 # define DFC_DEBUG3(fmt, args...) printf(fmt, ##args)
57 # define DFC_DEBUG3(fmt, args...)
60 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
62 static struct nand_bbt_descr delta_bbt_descr = {
66 .pattern = scan_ff_pattern
69 static struct nand_oobinfo delta_oob = {
70 .useecc = MTD_NANDECC_AUTOPL_USR, /* MTD_NANDECC_PLACEONLY, */
72 .eccpos = {2, 3, 4, 5, 6, 7},
73 .oobfree = { {8, 2}, {12, 4} }
78 * not required for Monahans DFC
80 static void delta_hwcontrol(struct mtd_info *mtdinfo, int cmd)
85 /* read device ready pin */
86 static int delta_device_ready(struct mtd_info *mtdinfo)
96 * Write buf to the DFC Controller Data Buffer
98 static void delta_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
100 unsigned long bytes_multi = len & 0xfffffffc;
101 unsigned long rest = len & 0x3;
102 unsigned long *long_buf;
105 DFC_DEBUG2("delta_write_buf: writing %d bytes starting with 0x%x.\n", len, *((unsigned long*) buf));
107 for(i=0; i<bytes_multi; i+=4) {
108 long_buf = (unsigned long*) &buf[i];
113 printf("delta_write_buf: ERROR, writing non 4-byte aligned data.\n");
120 * These functions are quite problematic for the DFC. Luckily they are
121 * not used in the current nand code, except for nand_command, which
122 * we've defined our own anyway. The problem is, that we always need
123 * to write 4 bytes to the DFC Data Buffer, but in these functions we
124 * don't know if to buffer the bytes/half words until we've gathered 4
125 * bytes or if to send them straight away.
127 * Solution: Don't use these with Mona's DFC and complain loudly.
129 static void delta_write_word(struct mtd_info *mtd, u16 word)
131 printf("delta_write_word: WARNING, this function does not work with the Monahans DFC!\n");
133 static void delta_write_byte(struct mtd_info *mtd, u_char byte)
135 printf("delta_write_byte: WARNING, this function does not work with the Monahans DFC!\n");
139 * static void delta_read_buf(struct mtd_info *mtd, const u_char *buf, int len)
141 * Shouldn't this be "u_char * const buf" ?
143 static void delta_read_buf(struct mtd_info *mtd, u_char* const buf, int len)
147 /* we have to be carefull not to overflow the buffer if len is
148 * not a multiple of 4 */
149 unsigned long bytes_multi = len & 0xfffffffc;
150 unsigned long rest = len & 0x3;
151 unsigned long *long_buf;
153 DFC_DEBUG3("delta_read_buf: reading %d bytes.\n", len);
154 /* if there are any, first copy multiple of 4 bytes */
156 for(i=0; i<bytes_multi; i+=4) {
157 long_buf = (unsigned long*) &buf[i];
162 /* ...then the rest */
164 unsigned long rest_data = NDDB;
166 buf[i+j] = (u_char) ((rest_data>>j) & 0xff);
173 * read a word. Not implemented as not used in NAND code.
175 static u16 delta_read_word(struct mtd_info *mtd)
177 printf("delta_write_byte: UNIMPLEMENTED.\n");
180 /* global var, too bad: mk@tbd: move to ->priv pointer */
181 static unsigned long read_buf = 0;
182 static int bytes_read = -1;
183 static unsigned long last_cmd = 0;
185 /* read a byte from NDDB Because we can only read 4 bytes from NDDB at
186 * a time, we buffer the remaining bytes. The buffer is reset when a
187 * new command is sent to the chip.
189 static u_char delta_read_byte(struct mtd_info *mtd)
191 /* struct nand_chip *this = mtd->priv; */
200 byte = (unsigned char) (read_buf>>(8 * bytes_read++));
204 DFC_DEBUG2("delta_read_byte: byte %u: 0x%x of (0x%x).\n", bytes_read - 1, byte, read_buf);
208 /* calculate delta between OSCR values start and now */
209 static unsigned long get_delta(unsigned long start)
211 unsigned long cur = OSCR;
213 if(cur < start) /* OSCR overflowed */
214 return (cur + (start^0xffffffff));
216 return (cur - start);
219 /* delay function, this doesn't belong here */
220 static void wait_us(unsigned long us)
222 unsigned long start = OSCR;
225 while (get_delta(start) < us) {
230 static void delta_clear_nddb()
232 NDCR &= ~NDCR_ND_RUN;
233 wait_us(CFG_NAND_OTHER_TO);
236 /* wait_event with timeout */
237 static unsigned long delta_wait_event2(unsigned long event)
239 unsigned long ndsr, timeout, start = OSCR;
243 else if(event & (NDSR_CS0_CMDD | NDSR_CS0_BBD))
244 timeout = CFG_NAND_PROG_ERASE_TO * OSCR_CLK_FREQ;
246 timeout = CFG_NAND_OTHER_TO * OSCR_CLK_FREQ;
254 if(get_delta(start) > timeout) {
255 DFC_DEBUG1("delta_wait_event: TIMEOUT waiting for event: 0x%x.\n", event);
265 /* poll the NAND Controller Status Register for event */
266 static void delta_wait_event(unsigned long event)
280 /* we don't always wan't to do this */
281 static void delta_new_cmd()
284 unsigned long status;
286 while(retry++ <= CFG_NAND_SENDCMD_RETRY) {
290 /* set NDCR[NDRUN] */
291 if(!(NDCR & NDCR_ND_RUN))
294 status = delta_wait_event2(NDSR_WRCMDREQ);
296 if(status & NDSR_WRCMDREQ)
299 DFC_DEBUG2("delta_new_cmd: FAILED to get WRITECMDREQ, retry: %d.\n", retry);
302 DFC_DEBUG1("delta_new_cmd: giving up after %d retries.\n", retry);
306 if(NDSR & NDSR_WRCMDREQ) {
307 NDSR |= NDSR_WRCMDREQ; /* Ack */
314 /* this function is called after Programm and Erase Operations to
315 * check for success or failure */
316 static int delta_wait(struct mtd_info *mtd, struct nand_chip *this, int state)
318 unsigned long ndsr=0, event=0;
320 /* mk@tbd set appropriate timeouts */
321 /* if (state == FL_ERASING) */
322 /* timeo = CFG_HZ * 400; */
324 /* timeo = CFG_HZ * 20; */
325 if(state == FL_WRITING) {
326 event = NDSR_CS0_CMDD | NDSR_CS0_BBD;
327 } else if(state == FL_ERASING) {
328 event = NDSR_CS0_CMDD | NDSR_CS0_BBD;
331 ndsr = delta_wait_event2(event);
333 if((ndsr & NDSR_CS0_BBD) || (ndsr & 0xff000000))
334 return(0x1); /* Status Read error */
338 /* cmdfunc send commands to the DFC */
339 static void delta_cmdfunc(struct mtd_info *mtd, unsigned command,
340 int column, int page_addr)
342 /* register struct nand_chip *this = mtd->priv; */
343 unsigned long ndcb0=0, ndcb1=0, ndcb2=0, event=0;
344 unsigned long what_the_hack;
346 /* clear the ugly byte read buffer */
351 /* if command is a double byte cmd, we set bit double cmd bit 19 */
352 /* command2 = (command>>8) & 0xFF; */
353 /* ndcb0 = command | ((command2 ? 1 : 0) << 19); *\/ */
357 DFC_DEBUG3("delta_cmdfunc: NAND_CMD_READ0, page_addr: 0x%x, column: 0x%x.\n", page_addr, (column>>1));
359 ndcb0 = (NAND_CMD_READ0 | (4<<16));
360 column >>= 1; /* adjust for 16 bit bus */
361 ndcb1 = (((column>>1) & 0xff) |
362 ((page_addr<<8) & 0xff00) |
363 ((page_addr<<8) & 0xff0000) |
364 ((page_addr<<8) & 0xff000000)); /* make this 0x01000000 ? */
368 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_READ1 unimplemented!\n");
370 case NAND_CMD_READOOB:
371 DFC_DEBUG1("delta_cmdfunc: NAND_CMD_READOOB unimplemented!\n");
373 case NAND_CMD_READID:
374 last_cmd = NAND_CMD_READID;
376 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_READID.\n");
377 ndcb0 = (NAND_CMD_READID | (3 << 21) | (1 << 16)); /* addr cycles*/
380 case NAND_CMD_PAGEPROG:
381 /* sent as a multicommand in NAND_CMD_SEQIN */
382 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_PAGEPROG empty due to multicmd.\n");
384 case NAND_CMD_ERASE1:
385 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_ERASE1, page_addr: 0x%x, column: 0x%x.\n", page_addr, (column>>1));
387 ndcb0 = (0xd060 | (1<<25) | (2<<21) | (1<<19) | (3<<16));
388 ndcb1 = (page_addr & 0x00ffffff);
390 case NAND_CMD_ERASE2:
391 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_ERASE2 empty due to multicmd.\n");
394 /* send PAGE_PROG command(0x1080) */
396 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_SEQIN/PAGE_PROG, page_addr: 0x%x, column: 0x%x.\n", page_addr, (column>>1));
397 ndcb0 = (0x1080 | (1<<25) | (1<<21) | (1<<19) | (4<<16));
398 column >>= 1; /* adjust for 16 bit bus */
399 ndcb1 = (((column>>1) & 0xff) |
400 ((page_addr<<8) & 0xff00) |
401 ((page_addr<<8) & 0xff0000) |
402 ((page_addr<<8) & 0xff000000)); /* make this 0x01000000 ? */
405 /* case NAND_CMD_SEQIN_pointer_operation: */
407 /* /\* This is confusing because the command names are */
408 /* * different compared to the ones in the K9K12Q0C */
409 /* * datasheet. Infact this has nothing to do with */
410 /* * reading, as the but with page programming */
412 /* * Here we send the multibyte commands */
413 /* * cmd1=0x00, cmd2=0x80 (for programming main area) or */
414 /* * cmd1=0x50, cmd2=0x80 (for spare area) */
416 /* * When all data is written to the buffer, the page */
417 /* * program command (0x10) is sent to actually write */
421 /* printf("delta_cmdfunc: NAND_CMD_SEQIN pointer op called.\n"); */
423 /* ndcb0 = (NAND_CMD_SEQIN<<8) | (1<<21) | (1<<19) | (4<<16); */
424 /* if(column >= mtd->oobblock) { */
425 /* /\* OOB area *\/ */
426 /* column -= mtd->oobblock; */
427 /* ndcb0 |= NAND_CMD_READOOB; */
428 /* } else if (column < 256) { */
429 /* /\* First 256 bytes --> READ0 *\/ */
430 /* ndcb0 |= NAND_CMD_READ0; */
432 /* /\* Only for 8 bit devices - not delta!!! *\/ */
434 /* ndcb0 |= NAND_CMD_READ1; */
436 /* event = NDSR_WRDREQ; */
438 case NAND_CMD_STATUS:
439 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_STATUS.\n");
440 /* oh, this is not nice. for some reason the real
441 * status byte is in the second read from the data
442 * buffer. The hack is to read the first byte right
443 * here, so the next read access by the nand code
444 * yields the right one.
447 ndcb0 = NAND_CMD_STATUS | (4<<21);
449 #undef READ_STATUS_BUG
450 #ifdef READ_STATUS_BUG
454 delta_wait_event2(event);
455 what_the_hack = NDDB;
456 if(what_the_hack != 0xffffffff) {
457 DFC_DEBUG2("what the hack.\n");
458 read_buf = what_the_hack;
465 DFC_DEBUG2("delta_cmdfunc: NAND_CMD_RESET.\n");
466 ndcb0 = NAND_CMD_RESET | (5<<21);
467 event = NDSR_CS0_CMDD;
470 printk("delta_cmdfunc: error, unsupported command.\n");
480 delta_wait_event2(event);
485 static void delta_dfc_gpio_init()
487 DFC_DEBUG2("Setting up DFC GPIO's.\n");
489 /* no idea what is done here, see zylonite.c */
492 DF_ALE_WE1 = 0x00000001;
493 DF_ALE_WE2 = 0x00000001;
494 DF_nCS0 = 0x00000001;
495 DF_nCS1 = 0x00000001;
503 DF_IO10 = 0x00000001;
505 DF_IO11 = 0x00000001;
507 DF_IO12 = 0x00000001;
509 DF_IO13 = 0x00000001;
511 DF_IO14 = 0x00000001;
513 DF_IO15 = 0x00000001;
523 * Board-specific NAND initialization. The following members of the
524 * argument are board-specific (per include/linux/mtd/nand_new.h):
525 * - IO_ADDR_R?: address to read the 8 I/O lines of the flash device
526 * - IO_ADDR_W?: address to write the 8 I/O lines of the flash device
527 * - hwcontrol: hardwarespecific function for accesing control-lines
528 * - dev_ready: hardwarespecific function for accesing device ready/busy line
529 * - enable_hwecc?: function to enable (reset) hardware ecc generator. Must
530 * only be provided if a hardware ECC is available
531 * - eccmode: mode of ecc, see defines
532 * - chip_delay: chip dependent delay for transfering data from array to
534 * - options: various chip options. They can partly be set to inform
535 * nand_scan about special functionality. See the defines for further
537 * Members with a "?" were not set in the merged testing-NAND branch,
538 * so they are not set here either.
540 void board_nand_init(struct nand_chip *nand)
542 unsigned long tCH, tCS, tWH, tWP, tRH, tRP, tRP_high, tR, tWHR, tAR;
544 /* set up GPIO Control Registers */
545 delta_dfc_gpio_init();
547 /* turn on the NAND Controller Clock (104 MHz @ D0) */
548 CKENA |= (CKENA_4_NAND | CKENA_9_SMC);
551 /* printf("stupid loop start...\n"); */
553 /* printf("stupid loop end.\n"); */
556 /* NAND Timing Parameters (in ns) */
557 #define NAND_TIMING_tCH 10
558 #define NAND_TIMING_tCS 0
559 #define NAND_TIMING_tWH 20
560 #define NAND_TIMING_tWP 40
562 #define NAND_TIMING_tRH 20
563 #define NAND_TIMING_tRP 40
565 /* #define NAND_TIMING_tRH 25 */
566 /* #define NAND_TIMING_tRP 50 */
568 #define NAND_TIMING_tR 11123
569 /* #define NAND_TIMING_tWHR 110 */
570 #define NAND_TIMING_tWHR 100
571 #define NAND_TIMING_tAR 10
573 /* Maximum values for NAND Interface Timing Registers in DFC clock
575 #define DFC_MAX_tCH 7
576 #define DFC_MAX_tCS 7
577 #define DFC_MAX_tWH 7
578 #define DFC_MAX_tWP 7
579 #define DFC_MAX_tRH 7
580 #define DFC_MAX_tRP 15
581 #define DFC_MAX_tR 65535
582 #define DFC_MAX_tWHR 15
583 #define DFC_MAX_tAR 15
585 #define DFC_CLOCK 104 /* DFC Clock is 104 MHz */
586 #define DFC_CLK_PER_US DFC_CLOCK/1000 /* clock period in ns */
587 #define MIN(x, y) ((x < y) ? x : y)
590 #undef CFG_TIMING_TIGHT
591 #ifndef CFG_TIMING_TIGHT
592 tCH = MIN(((unsigned long) (NAND_TIMING_tCH * DFC_CLK_PER_US) + 1),
594 tCS = MIN(((unsigned long) (NAND_TIMING_tCS * DFC_CLK_PER_US) + 1),
596 tWH = MIN(((unsigned long) (NAND_TIMING_tWH * DFC_CLK_PER_US) + 1),
598 tWP = MIN(((unsigned long) (NAND_TIMING_tWP * DFC_CLK_PER_US) + 1),
600 tRH = MIN(((unsigned long) (NAND_TIMING_tRH * DFC_CLK_PER_US) + 1),
602 tRP = MIN(((unsigned long) (NAND_TIMING_tRP * DFC_CLK_PER_US) + 1),
604 tR = MIN(((unsigned long) (NAND_TIMING_tR * DFC_CLK_PER_US) + 1),
606 tWHR = MIN(((unsigned long) (NAND_TIMING_tWHR * DFC_CLK_PER_US) + 1),
608 tAR = MIN(((unsigned long) (NAND_TIMING_tAR * DFC_CLK_PER_US) + 1),
610 #else /* this is the tight timing */
612 tCH = MIN(((unsigned long) (NAND_TIMING_tCH * DFC_CLK_PER_US)),
614 tCS = MIN(((unsigned long) (NAND_TIMING_tCS * DFC_CLK_PER_US)),
616 tWH = MIN(((unsigned long) (NAND_TIMING_tWH * DFC_CLK_PER_US)),
618 tWP = MIN(((unsigned long) (NAND_TIMING_tWP * DFC_CLK_PER_US)),
620 tRH = MIN(((unsigned long) (NAND_TIMING_tRH * DFC_CLK_PER_US)),
622 tRP = MIN(((unsigned long) (NAND_TIMING_tRP * DFC_CLK_PER_US)),
624 tR = MIN(((unsigned long) (NAND_TIMING_tR * DFC_CLK_PER_US) - tCH - 2),
626 tWHR = MIN(((unsigned long) (NAND_TIMING_tWHR * DFC_CLK_PER_US) - tCH - 2),
628 tAR = MIN(((unsigned long) (NAND_TIMING_tAR * DFC_CLK_PER_US) - 2),
630 #endif /* CFG_TIMING_TIGHT */
633 DFC_DEBUG2("tCH=%u, tCS=%u, tWH=%u, tWP=%u, tRH=%u, tRP=%u, tR=%u, tWHR=%u, tAR=%u.\n", tCH, tCS, tWH, tWP, tRH, tRP, tR, tWHR, tAR);
635 /* tRP value is split in the register */
643 NDTR0CS0 = (tCH << 19) |
651 NDTR1CS0 = (tR << 16) |
657 /* If it doesn't work (unlikely) think about:
659 * - chip select don't care
660 * - read id byte count
662 * Intentionally enabled by not setting bits:
665 * - cs don't care, see if we can enable later!
666 * - row address start position (after second cycle)
667 * - pages per block = 32
668 * - ND_RDY : clears command buffer
670 /* NDCR_NCSX | /\* Chip select busy don't care *\/ */
672 NDCR = (NDCR_SPARE_EN | /* use the spare area */
673 NDCR_DWIDTH_C | /* 16bit DFC data bus width */
674 NDCR_DWIDTH_M | /* 16 bit Flash device data bus width */
675 (2 << 16) | /* read id count = 7 ???? mk@tbd */
676 NDCR_ND_ARB_EN | /* enable bus arbiter */
677 NDCR_RDYM | /* flash device ready ir masked */
678 NDCR_CS0_PAGEDM | /* ND_nCSx page done ir masked */
680 NDCR_CS0_CMDDM | /* ND_CSx command done ir masked */
682 NDCR_CS0_BBDM | /* ND_CSx bad block detect ir masked */
684 NDCR_DBERRM | /* double bit error ir masked */
685 NDCR_SBERRM | /* single bit error ir masked */
686 NDCR_WRDREQM | /* write data request ir masked */
687 NDCR_RDDREQM | /* read data request ir masked */
688 NDCR_WRCMDREQM); /* write command request ir masked */
691 /* wait 10 us due to cmd buffer clear reset */
695 nand->hwcontrol = delta_hwcontrol;
696 /* nand->dev_ready = delta_device_ready; */
697 nand->eccmode = NAND_ECC_SOFT;
698 nand->chip_delay = NAND_DELAY_US;
699 nand->options = NAND_BUSWIDTH_16;
700 nand->waitfunc = delta_wait;
701 nand->read_byte = delta_read_byte;
702 nand->write_byte = delta_write_byte;
703 nand->read_word = delta_read_word;
704 nand->write_word = delta_write_word;
705 nand->read_buf = delta_read_buf;
706 nand->write_buf = delta_write_buf;
708 nand->cmdfunc = delta_cmdfunc;
709 nand->autooob = &delta_oob;
710 nand->badblock_pattern = &delta_bbt_descr;
714 #error "U-Boot legacy NAND support not available for delta board."