2 * NAND Flash Controller Device Driver
3 * Copyright © 2009-2010, Intel Corporation and its suppliers.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <linux/interrupt.h>
21 #include <linux/delay.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/wait.h>
24 #include <linux/mutex.h>
25 #include <linux/slab.h>
26 #include <linux/pci.h>
27 #include <linux/mtd/mtd.h>
28 #include <linux/module.h>
32 MODULE_LICENSE("GPL");
34 /* We define a module parameter that allows the user to override
35 * the hardware and decide what timing mode should be used.
37 #define NAND_DEFAULT_TIMINGS -1
39 static int onfi_timing_mode = NAND_DEFAULT_TIMINGS;
40 module_param(onfi_timing_mode, int, S_IRUGO);
41 MODULE_PARM_DESC(onfi_timing_mode, "Overrides default ONFI setting."
42 " -1 indicates use default timings");
44 #define DENALI_NAND_NAME "denali-nand"
46 /* We define a macro here that combines all interrupts this driver uses into
47 * a single constant value, for convenience. */
48 #define DENALI_IRQ_ALL (INTR_STATUS__DMA_CMD_COMP | \
49 INTR_STATUS__ECC_TRANSACTION_DONE | \
50 INTR_STATUS__ECC_ERR | \
51 INTR_STATUS__PROGRAM_FAIL | \
52 INTR_STATUS__LOAD_COMP | \
53 INTR_STATUS__PROGRAM_COMP | \
54 INTR_STATUS__TIME_OUT | \
55 INTR_STATUS__ERASE_FAIL | \
56 INTR_STATUS__RST_COMP | \
57 INTR_STATUS__ERASE_COMP)
59 /* indicates whether or not the internal value for the flash bank is
61 #define CHIP_SELECT_INVALID -1
63 #define SUPPORT_8BITECC 1
65 /* This macro divides two integers and rounds fractional values up
66 * to the nearest integer value. */
67 #define CEIL_DIV(X, Y) (((X)%(Y)) ? ((X)/(Y)+1) : ((X)/(Y)))
69 /* this macro allows us to convert from an MTD structure to our own
70 * device context (denali) structure.
72 #define mtd_to_denali(m) container_of(m, struct denali_nand_info, mtd)
74 /* These constants are defined by the driver to enable common driver
75 * configuration options. */
76 #define SPARE_ACCESS 0x41
77 #define MAIN_ACCESS 0x42
78 #define MAIN_SPARE_ACCESS 0x43
81 #define DENALI_WRITE 0x100
83 /* types of device accesses. We can issue commands and get status */
84 #define COMMAND_CYCLE 0
86 #define STATUS_CYCLE 2
88 /* this is a helper macro that allows us to
89 * format the bank into the proper bits for the controller */
90 #define BANK(x) ((x) << 24)
92 /* List of platforms this NAND controller has be integrated into */
93 static const struct pci_device_id denali_pci_ids[] = {
94 { PCI_VDEVICE(INTEL, 0x0701), INTEL_CE4100 },
95 { PCI_VDEVICE(INTEL, 0x0809), INTEL_MRST },
96 { /* end: all zeroes */ }
99 /* forward declarations */
100 static void clear_interrupts(struct denali_nand_info *denali);
101 static uint32_t wait_for_irq(struct denali_nand_info *denali,
103 static void denali_irq_enable(struct denali_nand_info *denali,
105 static uint32_t read_interrupt_status(struct denali_nand_info *denali);
107 /* Certain operations for the denali NAND controller use
108 * an indexed mode to read/write data. The operation is
109 * performed by writing the address value of the command
110 * to the device memory followed by the data. This function
111 * abstracts this common operation.
113 static void index_addr(struct denali_nand_info *denali,
114 uint32_t address, uint32_t data)
116 iowrite32(address, denali->flash_mem);
117 iowrite32(data, denali->flash_mem + 0x10);
120 /* Perform an indexed read of the device */
121 static void index_addr_read_data(struct denali_nand_info *denali,
122 uint32_t address, uint32_t *pdata)
124 iowrite32(address, denali->flash_mem);
125 *pdata = ioread32(denali->flash_mem + 0x10);
128 /* We need to buffer some data for some of the NAND core routines.
129 * The operations manage buffering that data. */
130 static void reset_buf(struct denali_nand_info *denali)
132 denali->buf.head = denali->buf.tail = 0;
135 static void write_byte_to_buf(struct denali_nand_info *denali, uint8_t byte)
137 BUG_ON(denali->buf.tail >= sizeof(denali->buf.buf));
138 denali->buf.buf[denali->buf.tail++] = byte;
141 /* reads the status of the device */
142 static void read_status(struct denali_nand_info *denali)
146 /* initialize the data buffer to store status */
149 cmd = ioread32(denali->flash_reg + WRITE_PROTECT);
151 write_byte_to_buf(denali, NAND_STATUS_WP);
153 write_byte_to_buf(denali, 0);
156 /* resets a specific device connected to the core */
157 static void reset_bank(struct denali_nand_info *denali)
159 uint32_t irq_status = 0;
160 uint32_t irq_mask = INTR_STATUS__RST_COMP |
161 INTR_STATUS__TIME_OUT;
163 clear_interrupts(denali);
165 iowrite32(1 << denali->flash_bank, denali->flash_reg + DEVICE_RESET);
167 irq_status = wait_for_irq(denali, irq_mask);
169 if (irq_status & INTR_STATUS__TIME_OUT)
170 dev_err(denali->dev, "reset bank failed.\n");
173 /* Reset the flash controller */
174 static uint16_t denali_nand_reset(struct denali_nand_info *denali)
178 dev_dbg(denali->dev, "%s, Line %d, Function: %s\n",
179 __FILE__, __LINE__, __func__);
181 for (i = 0 ; i < LLD_MAX_FLASH_BANKS; i++)
182 iowrite32(INTR_STATUS__RST_COMP | INTR_STATUS__TIME_OUT,
183 denali->flash_reg + INTR_STATUS(i));
185 for (i = 0 ; i < LLD_MAX_FLASH_BANKS; i++) {
186 iowrite32(1 << i, denali->flash_reg + DEVICE_RESET);
187 while (!(ioread32(denali->flash_reg +
189 (INTR_STATUS__RST_COMP | INTR_STATUS__TIME_OUT)))
191 if (ioread32(denali->flash_reg + INTR_STATUS(i)) &
192 INTR_STATUS__TIME_OUT)
194 "NAND Reset operation timed out on bank %d\n", i);
197 for (i = 0; i < LLD_MAX_FLASH_BANKS; i++)
198 iowrite32(INTR_STATUS__RST_COMP | INTR_STATUS__TIME_OUT,
199 denali->flash_reg + INTR_STATUS(i));
204 /* this routine calculates the ONFI timing values for a given mode and
205 * programs the clocking register accordingly. The mode is determined by
206 * the get_onfi_nand_para routine.
208 static void nand_onfi_timing_set(struct denali_nand_info *denali,
211 uint16_t Trea[6] = {40, 30, 25, 20, 20, 16};
212 uint16_t Trp[6] = {50, 25, 17, 15, 12, 10};
213 uint16_t Treh[6] = {30, 15, 15, 10, 10, 7};
214 uint16_t Trc[6] = {100, 50, 35, 30, 25, 20};
215 uint16_t Trhoh[6] = {0, 15, 15, 15, 15, 15};
216 uint16_t Trloh[6] = {0, 0, 0, 0, 5, 5};
217 uint16_t Tcea[6] = {100, 45, 30, 25, 25, 25};
218 uint16_t Tadl[6] = {200, 100, 100, 100, 70, 70};
219 uint16_t Trhw[6] = {200, 100, 100, 100, 100, 100};
220 uint16_t Trhz[6] = {200, 100, 100, 100, 100, 100};
221 uint16_t Twhr[6] = {120, 80, 80, 60, 60, 60};
222 uint16_t Tcs[6] = {70, 35, 25, 25, 20, 15};
224 uint16_t TclsRising = 1;
225 uint16_t data_invalid_rhoh, data_invalid_rloh, data_invalid;
226 uint16_t dv_window = 0;
227 uint16_t en_lo, en_hi;
229 uint16_t addr_2_data, re_2_we, re_2_re, we_2_re, cs_cnt;
231 dev_dbg(denali->dev, "%s, Line %d, Function: %s\n",
232 __FILE__, __LINE__, __func__);
234 en_lo = CEIL_DIV(Trp[mode], CLK_X);
235 en_hi = CEIL_DIV(Treh[mode], CLK_X);
237 if ((en_hi * CLK_X) < (Treh[mode] + 2))
241 if ((en_lo + en_hi) * CLK_X < Trc[mode])
242 en_lo += CEIL_DIV((Trc[mode] - (en_lo + en_hi) * CLK_X), CLK_X);
244 if ((en_lo + en_hi) < CLK_MULTI)
245 en_lo += CLK_MULTI - en_lo - en_hi;
247 while (dv_window < 8) {
248 data_invalid_rhoh = en_lo * CLK_X + Trhoh[mode];
250 data_invalid_rloh = (en_lo + en_hi) * CLK_X + Trloh[mode];
254 data_invalid_rloh ? data_invalid_rhoh : data_invalid_rloh;
256 dv_window = data_invalid - Trea[mode];
262 acc_clks = CEIL_DIV(Trea[mode], CLK_X);
264 while (((acc_clks * CLK_X) - Trea[mode]) < 3)
267 if ((data_invalid - acc_clks * CLK_X) < 2)
268 dev_warn(denali->dev, "%s, Line %d: Warning!\n",
271 addr_2_data = CEIL_DIV(Tadl[mode], CLK_X);
272 re_2_we = CEIL_DIV(Trhw[mode], CLK_X);
273 re_2_re = CEIL_DIV(Trhz[mode], CLK_X);
274 we_2_re = CEIL_DIV(Twhr[mode], CLK_X);
275 cs_cnt = CEIL_DIV((Tcs[mode] - Trp[mode]), CLK_X);
277 cs_cnt = CEIL_DIV(Tcs[mode], CLK_X);
282 while (((cs_cnt * CLK_X) + Trea[mode]) < Tcea[mode])
291 /* Sighting 3462430: Temporary hack for MT29F128G08CJABAWP:B */
292 if ((ioread32(denali->flash_reg + MANUFACTURER_ID) == 0) &&
293 (ioread32(denali->flash_reg + DEVICE_ID) == 0x88))
296 iowrite32(acc_clks, denali->flash_reg + ACC_CLKS);
297 iowrite32(re_2_we, denali->flash_reg + RE_2_WE);
298 iowrite32(re_2_re, denali->flash_reg + RE_2_RE);
299 iowrite32(we_2_re, denali->flash_reg + WE_2_RE);
300 iowrite32(addr_2_data, denali->flash_reg + ADDR_2_DATA);
301 iowrite32(en_lo, denali->flash_reg + RDWR_EN_LO_CNT);
302 iowrite32(en_hi, denali->flash_reg + RDWR_EN_HI_CNT);
303 iowrite32(cs_cnt, denali->flash_reg + CS_SETUP_CNT);
306 /* queries the NAND device to see what ONFI modes it supports. */
307 static uint16_t get_onfi_nand_para(struct denali_nand_info *denali)
310 /* we needn't to do a reset here because driver has already
311 * reset all the banks before
313 if (!(ioread32(denali->flash_reg + ONFI_TIMING_MODE) &
314 ONFI_TIMING_MODE__VALUE))
317 for (i = 5; i > 0; i--) {
318 if (ioread32(denali->flash_reg + ONFI_TIMING_MODE) &
323 nand_onfi_timing_set(denali, i);
325 /* By now, all the ONFI devices we know support the page cache */
326 /* rw feature. So here we enable the pipeline_rw_ahead feature */
327 /* iowrite32(1, denali->flash_reg + CACHE_WRITE_ENABLE); */
328 /* iowrite32(1, denali->flash_reg + CACHE_READ_ENABLE); */
333 static void get_samsung_nand_para(struct denali_nand_info *denali,
336 if (device_id == 0xd3) { /* Samsung K9WAG08U1A */
337 /* Set timing register values according to datasheet */
338 iowrite32(5, denali->flash_reg + ACC_CLKS);
339 iowrite32(20, denali->flash_reg + RE_2_WE);
340 iowrite32(12, denali->flash_reg + WE_2_RE);
341 iowrite32(14, denali->flash_reg + ADDR_2_DATA);
342 iowrite32(3, denali->flash_reg + RDWR_EN_LO_CNT);
343 iowrite32(2, denali->flash_reg + RDWR_EN_HI_CNT);
344 iowrite32(2, denali->flash_reg + CS_SETUP_CNT);
348 static void get_toshiba_nand_para(struct denali_nand_info *denali)
352 /* Workaround to fix a controller bug which reports a wrong */
353 /* spare area size for some kind of Toshiba NAND device */
354 if ((ioread32(denali->flash_reg + DEVICE_MAIN_AREA_SIZE) == 4096) &&
355 (ioread32(denali->flash_reg + DEVICE_SPARE_AREA_SIZE) == 64)) {
356 iowrite32(216, denali->flash_reg + DEVICE_SPARE_AREA_SIZE);
357 tmp = ioread32(denali->flash_reg + DEVICES_CONNECTED) *
358 ioread32(denali->flash_reg + DEVICE_SPARE_AREA_SIZE);
360 denali->flash_reg + LOGICAL_PAGE_SPARE_SIZE);
362 iowrite32(15, denali->flash_reg + ECC_CORRECTION);
363 #elif SUPPORT_8BITECC
364 iowrite32(8, denali->flash_reg + ECC_CORRECTION);
369 static void get_hynix_nand_para(struct denali_nand_info *denali,
372 uint32_t main_size, spare_size;
375 case 0xD5: /* Hynix H27UAG8T2A, H27UBG8U5A or H27UCG8VFA */
376 case 0xD7: /* Hynix H27UDG8VEM, H27UCG8UDM or H27UCG8V5A */
377 iowrite32(128, denali->flash_reg + PAGES_PER_BLOCK);
378 iowrite32(4096, denali->flash_reg + DEVICE_MAIN_AREA_SIZE);
379 iowrite32(224, denali->flash_reg + DEVICE_SPARE_AREA_SIZE);
381 ioread32(denali->flash_reg + DEVICES_CONNECTED);
383 ioread32(denali->flash_reg + DEVICES_CONNECTED);
385 denali->flash_reg + LOGICAL_PAGE_DATA_SIZE);
386 iowrite32(spare_size,
387 denali->flash_reg + LOGICAL_PAGE_SPARE_SIZE);
388 iowrite32(0, denali->flash_reg + DEVICE_WIDTH);
390 iowrite32(15, denali->flash_reg + ECC_CORRECTION);
391 #elif SUPPORT_8BITECC
392 iowrite32(8, denali->flash_reg + ECC_CORRECTION);
396 dev_warn(denali->dev,
397 "Spectra: Unknown Hynix NAND (Device ID: 0x%x)."
398 "Will use default parameter values instead.\n",
403 /* determines how many NAND chips are connected to the controller. Note for
404 * Intel CE4100 devices we don't support more than one device.
406 static void find_valid_banks(struct denali_nand_info *denali)
408 uint32_t id[LLD_MAX_FLASH_BANKS];
411 denali->total_used_banks = 1;
412 for (i = 0; i < LLD_MAX_FLASH_BANKS; i++) {
413 index_addr(denali, (uint32_t)(MODE_11 | (i << 24) | 0), 0x90);
414 index_addr(denali, (uint32_t)(MODE_11 | (i << 24) | 1), 0);
415 index_addr_read_data(denali,
416 (uint32_t)(MODE_11 | (i << 24) | 2), &id[i]);
419 "Return 1st ID for bank[%d]: %x\n", i, id[i]);
422 if (!(id[i] & 0x0ff))
425 if ((id[i] & 0x0ff) == (id[0] & 0x0ff))
426 denali->total_used_banks++;
432 if (denali->platform == INTEL_CE4100) {
433 /* Platform limitations of the CE4100 device limit
434 * users to a single chip solution for NAND.
435 * Multichip support is not enabled.
437 if (denali->total_used_banks != 1) {
439 "Sorry, Intel CE4100 only supports "
440 "a single NAND device.\n");
445 "denali->total_used_banks: %d\n", denali->total_used_banks);
448 static void detect_partition_feature(struct denali_nand_info *denali)
450 /* For MRST platform, denali->fwblks represent the
451 * number of blocks firmware is taken,
452 * FW is in protect partition and MTD driver has no
453 * permission to access it. So let driver know how many
454 * blocks it can't touch.
456 if (ioread32(denali->flash_reg + FEATURES) & FEATURES__PARTITION) {
457 if ((ioread32(denali->flash_reg + PERM_SRC_ID(1)) &
458 PERM_SRC_ID__SRCID) == SPECTRA_PARTITION_ID) {
460 ((ioread32(denali->flash_reg + MIN_MAX_BANK(1)) &
461 MIN_MAX_BANK__MIN_VALUE) *
464 (ioread32(denali->flash_reg + MIN_BLK_ADDR(1)) &
465 MIN_BLK_ADDR__VALUE);
467 denali->fwblks = SPECTRA_START_BLOCK;
469 denali->fwblks = SPECTRA_START_BLOCK;
472 static uint16_t denali_nand_timing_set(struct denali_nand_info *denali)
474 uint16_t status = PASS;
475 uint32_t id_bytes[5], addr;
476 uint8_t i, maf_id, device_id;
479 "%s, Line %d, Function: %s\n",
480 __FILE__, __LINE__, __func__);
482 /* Use read id method to get device ID and other
483 * params. For some NAND chips, controller can't
484 * report the correct device ID by reading from
487 addr = (uint32_t)MODE_11 | BANK(denali->flash_bank);
488 index_addr(denali, (uint32_t)addr | 0, 0x90);
489 index_addr(denali, (uint32_t)addr | 1, 0);
490 for (i = 0; i < 5; i++)
491 index_addr_read_data(denali, addr | 2, &id_bytes[i]);
492 maf_id = id_bytes[0];
493 device_id = id_bytes[1];
495 if (ioread32(denali->flash_reg + ONFI_DEVICE_NO_OF_LUNS) &
496 ONFI_DEVICE_NO_OF_LUNS__ONFI_DEVICE) { /* ONFI 1.0 NAND */
497 if (FAIL == get_onfi_nand_para(denali))
499 } else if (maf_id == 0xEC) { /* Samsung NAND */
500 get_samsung_nand_para(denali, device_id);
501 } else if (maf_id == 0x98) { /* Toshiba NAND */
502 get_toshiba_nand_para(denali);
503 } else if (maf_id == 0xAD) { /* Hynix NAND */
504 get_hynix_nand_para(denali, device_id);
507 dev_info(denali->dev,
508 "Dump timing register values:"
509 "acc_clks: %d, re_2_we: %d, re_2_re: %d\n"
510 "we_2_re: %d, addr_2_data: %d, rdwr_en_lo_cnt: %d\n"
511 "rdwr_en_hi_cnt: %d, cs_setup_cnt: %d\n",
512 ioread32(denali->flash_reg + ACC_CLKS),
513 ioread32(denali->flash_reg + RE_2_WE),
514 ioread32(denali->flash_reg + RE_2_RE),
515 ioread32(denali->flash_reg + WE_2_RE),
516 ioread32(denali->flash_reg + ADDR_2_DATA),
517 ioread32(denali->flash_reg + RDWR_EN_LO_CNT),
518 ioread32(denali->flash_reg + RDWR_EN_HI_CNT),
519 ioread32(denali->flash_reg + CS_SETUP_CNT));
521 find_valid_banks(denali);
523 detect_partition_feature(denali);
525 /* If the user specified to override the default timings
526 * with a specific ONFI mode, we apply those changes here.
528 if (onfi_timing_mode != NAND_DEFAULT_TIMINGS)
529 nand_onfi_timing_set(denali, onfi_timing_mode);
534 static void denali_set_intr_modes(struct denali_nand_info *denali,
537 dev_dbg(denali->dev, "%s, Line %d, Function: %s\n",
538 __FILE__, __LINE__, __func__);
541 iowrite32(1, denali->flash_reg + GLOBAL_INT_ENABLE);
543 iowrite32(0, denali->flash_reg + GLOBAL_INT_ENABLE);
546 /* validation function to verify that the controlling software is making
549 static inline bool is_flash_bank_valid(int flash_bank)
551 return (flash_bank >= 0 && flash_bank < 4);
554 static void denali_irq_init(struct denali_nand_info *denali)
556 uint32_t int_mask = 0;
559 /* Disable global interrupts */
560 denali_set_intr_modes(denali, false);
562 int_mask = DENALI_IRQ_ALL;
564 /* Clear all status bits */
565 for (i = 0; i < LLD_MAX_FLASH_BANKS; ++i)
566 iowrite32(0xFFFF, denali->flash_reg + INTR_STATUS(i));
568 denali_irq_enable(denali, int_mask);
571 static void denali_irq_cleanup(int irqnum, struct denali_nand_info *denali)
573 denali_set_intr_modes(denali, false);
574 free_irq(irqnum, denali);
577 static void denali_irq_enable(struct denali_nand_info *denali,
582 for (i = 0; i < LLD_MAX_FLASH_BANKS; ++i)
583 iowrite32(int_mask, denali->flash_reg + INTR_EN(i));
586 /* This function only returns when an interrupt that this driver cares about
587 * occurs. This is to reduce the overhead of servicing interrupts
589 static inline uint32_t denali_irq_detected(struct denali_nand_info *denali)
591 return read_interrupt_status(denali) & DENALI_IRQ_ALL;
594 /* Interrupts are cleared by writing a 1 to the appropriate status bit */
595 static inline void clear_interrupt(struct denali_nand_info *denali,
598 uint32_t intr_status_reg = 0;
600 intr_status_reg = INTR_STATUS(denali->flash_bank);
602 iowrite32(irq_mask, denali->flash_reg + intr_status_reg);
605 static void clear_interrupts(struct denali_nand_info *denali)
607 uint32_t status = 0x0;
608 spin_lock_irq(&denali->irq_lock);
610 status = read_interrupt_status(denali);
611 clear_interrupt(denali, status);
613 denali->irq_status = 0x0;
614 spin_unlock_irq(&denali->irq_lock);
617 static uint32_t read_interrupt_status(struct denali_nand_info *denali)
619 uint32_t intr_status_reg = 0;
621 intr_status_reg = INTR_STATUS(denali->flash_bank);
623 return ioread32(denali->flash_reg + intr_status_reg);
626 /* This is the interrupt service routine. It handles all interrupts
627 * sent to this device. Note that on CE4100, this is a shared
630 static irqreturn_t denali_isr(int irq, void *dev_id)
632 struct denali_nand_info *denali = dev_id;
633 uint32_t irq_status = 0x0;
634 irqreturn_t result = IRQ_NONE;
636 spin_lock(&denali->irq_lock);
638 /* check to see if a valid NAND chip has
641 if (is_flash_bank_valid(denali->flash_bank)) {
642 /* check to see if controller generated
643 * the interrupt, since this is a shared interrupt */
644 irq_status = denali_irq_detected(denali);
645 if (irq_status != 0) {
646 /* handle interrupt */
647 /* first acknowledge it */
648 clear_interrupt(denali, irq_status);
649 /* store the status in the device context for someone
651 denali->irq_status |= irq_status;
652 /* notify anyone who cares that it happened */
653 complete(&denali->complete);
654 /* tell the OS that we've handled this */
655 result = IRQ_HANDLED;
658 spin_unlock(&denali->irq_lock);
661 #define BANK(x) ((x) << 24)
663 static uint32_t wait_for_irq(struct denali_nand_info *denali, uint32_t irq_mask)
665 unsigned long comp_res = 0;
666 uint32_t intr_status = 0;
668 unsigned long timeout = msecs_to_jiffies(1000);
672 wait_for_completion_timeout(&denali->complete, timeout);
673 spin_lock_irq(&denali->irq_lock);
674 intr_status = denali->irq_status;
676 if (intr_status & irq_mask) {
677 denali->irq_status &= ~irq_mask;
678 spin_unlock_irq(&denali->irq_lock);
679 /* our interrupt was detected */
682 /* these are not the interrupts you are looking for -
683 * need to wait again */
684 spin_unlock_irq(&denali->irq_lock);
687 } while (comp_res != 0);
691 printk(KERN_ERR "timeout occurred, status = 0x%x, mask = 0x%x\n",
692 intr_status, irq_mask);
699 /* This helper function setups the registers for ECC and whether or not
700 * the spare area will be transferred. */
701 static void setup_ecc_for_xfer(struct denali_nand_info *denali, bool ecc_en,
704 int ecc_en_flag = 0, transfer_spare_flag = 0;
706 /* set ECC, transfer spare bits if needed */
707 ecc_en_flag = ecc_en ? ECC_ENABLE__FLAG : 0;
708 transfer_spare_flag = transfer_spare ? TRANSFER_SPARE_REG__FLAG : 0;
710 /* Enable spare area/ECC per user's request. */
711 iowrite32(ecc_en_flag, denali->flash_reg + ECC_ENABLE);
712 iowrite32(transfer_spare_flag,
713 denali->flash_reg + TRANSFER_SPARE_REG);
716 /* sends a pipeline command operation to the controller. See the Denali NAND
717 * controller's user guide for more information (section 4.2.3.6).
719 static int denali_send_pipeline_cmd(struct denali_nand_info *denali,
726 uint32_t addr = 0x0, cmd = 0x0, page_count = 1, irq_status = 0,
729 if (op == DENALI_READ)
730 irq_mask = INTR_STATUS__LOAD_COMP;
731 else if (op == DENALI_WRITE)
736 setup_ecc_for_xfer(denali, ecc_en, transfer_spare);
738 /* clear interrupts */
739 clear_interrupts(denali);
741 addr = BANK(denali->flash_bank) | denali->page;
743 if (op == DENALI_WRITE && access_type != SPARE_ACCESS) {
744 cmd = MODE_01 | addr;
745 iowrite32(cmd, denali->flash_mem);
746 } else if (op == DENALI_WRITE && access_type == SPARE_ACCESS) {
747 /* read spare area */
748 cmd = MODE_10 | addr;
749 index_addr(denali, (uint32_t)cmd, access_type);
751 cmd = MODE_01 | addr;
752 iowrite32(cmd, denali->flash_mem);
753 } else if (op == DENALI_READ) {
754 /* setup page read request for access type */
755 cmd = MODE_10 | addr;
756 index_addr(denali, (uint32_t)cmd, access_type);
758 /* page 33 of the NAND controller spec indicates we should not
759 use the pipeline commands in Spare area only mode. So we
762 if (access_type == SPARE_ACCESS) {
763 cmd = MODE_01 | addr;
764 iowrite32(cmd, denali->flash_mem);
766 index_addr(denali, (uint32_t)cmd,
767 0x2000 | op | page_count);
769 /* wait for command to be accepted
770 * can always use status0 bit as the
771 * mask is identical for each
773 irq_status = wait_for_irq(denali, irq_mask);
775 if (irq_status == 0) {
777 "cmd, page, addr on timeout "
778 "(0x%x, 0x%x, 0x%x)\n",
779 cmd, denali->page, addr);
782 cmd = MODE_01 | addr;
783 iowrite32(cmd, denali->flash_mem);
790 /* helper function that simply writes a buffer to the flash */
791 static int write_data_to_flash_mem(struct denali_nand_info *denali,
795 uint32_t i = 0, *buf32;
797 /* verify that the len is a multiple of 4. see comment in
798 * read_data_from_flash_mem() */
799 BUG_ON((len % 4) != 0);
801 /* write the data to the flash memory */
802 buf32 = (uint32_t *)buf;
803 for (i = 0; i < len / 4; i++)
804 iowrite32(*buf32++, denali->flash_mem + 0x10);
805 return i*4; /* intent is to return the number of bytes read */
808 /* helper function that simply reads a buffer from the flash */
809 static int read_data_from_flash_mem(struct denali_nand_info *denali,
813 uint32_t i = 0, *buf32;
815 /* we assume that len will be a multiple of 4, if not
816 * it would be nice to know about it ASAP rather than
817 * have random failures...
818 * This assumption is based on the fact that this
819 * function is designed to be used to read flash pages,
820 * which are typically multiples of 4...
823 BUG_ON((len % 4) != 0);
825 /* transfer the data from the flash */
826 buf32 = (uint32_t *)buf;
827 for (i = 0; i < len / 4; i++)
828 *buf32++ = ioread32(denali->flash_mem + 0x10);
829 return i*4; /* intent is to return the number of bytes read */
832 /* writes OOB data to the device */
833 static int write_oob_data(struct mtd_info *mtd, uint8_t *buf, int page)
835 struct denali_nand_info *denali = mtd_to_denali(mtd);
836 uint32_t irq_status = 0;
837 uint32_t irq_mask = INTR_STATUS__PROGRAM_COMP |
838 INTR_STATUS__PROGRAM_FAIL;
843 if (denali_send_pipeline_cmd(denali, false, false, SPARE_ACCESS,
844 DENALI_WRITE) == PASS) {
845 write_data_to_flash_mem(denali, buf, mtd->oobsize);
847 /* wait for operation to complete */
848 irq_status = wait_for_irq(denali, irq_mask);
850 if (irq_status == 0) {
851 dev_err(denali->dev, "OOB write failed\n");
855 dev_err(denali->dev, "unable to send pipeline command\n");
861 /* reads OOB data from the device */
862 static void read_oob_data(struct mtd_info *mtd, uint8_t *buf, int page)
864 struct denali_nand_info *denali = mtd_to_denali(mtd);
865 uint32_t irq_mask = INTR_STATUS__LOAD_COMP,
866 irq_status = 0, addr = 0x0, cmd = 0x0;
870 if (denali_send_pipeline_cmd(denali, false, true, SPARE_ACCESS,
871 DENALI_READ) == PASS) {
872 read_data_from_flash_mem(denali, buf, mtd->oobsize);
874 /* wait for command to be accepted
875 * can always use status0 bit as the mask is identical for each
877 irq_status = wait_for_irq(denali, irq_mask);
880 dev_err(denali->dev, "page on OOB timeout %d\n",
883 /* We set the device back to MAIN_ACCESS here as I observed
884 * instability with the controller if you do a block erase
885 * and the last transaction was a SPARE_ACCESS. Block erase
886 * is reliable (according to the MTD test infrastructure)
887 * if you are in MAIN_ACCESS.
889 addr = BANK(denali->flash_bank) | denali->page;
890 cmd = MODE_10 | addr;
891 index_addr(denali, (uint32_t)cmd, MAIN_ACCESS);
895 /* this function examines buffers to see if they contain data that
896 * indicate that the buffer is part of an erased region of flash.
898 bool is_erased(uint8_t *buf, int len)
901 for (i = 0; i < len; i++)
906 #define ECC_SECTOR_SIZE 512
908 #define ECC_SECTOR(x) (((x) & ECC_ERROR_ADDRESS__SECTOR_NR) >> 12)
909 #define ECC_BYTE(x) (((x) & ECC_ERROR_ADDRESS__OFFSET))
910 #define ECC_CORRECTION_VALUE(x) ((x) & ERR_CORRECTION_INFO__BYTEMASK)
911 #define ECC_ERROR_CORRECTABLE(x) (!((x) & ERR_CORRECTION_INFO__ERROR_TYPE))
912 #define ECC_ERR_DEVICE(x) (((x) & ERR_CORRECTION_INFO__DEVICE_NR) >> 8)
913 #define ECC_LAST_ERR(x) ((x) & ERR_CORRECTION_INFO__LAST_ERR_INFO)
915 static bool handle_ecc(struct denali_nand_info *denali, uint8_t *buf,
918 bool check_erased_page = false;
920 if (irq_status & INTR_STATUS__ECC_ERR) {
921 /* read the ECC errors. we'll ignore them for now */
922 uint32_t err_address = 0, err_correction_info = 0;
923 uint32_t err_byte = 0, err_sector = 0, err_device = 0;
924 uint32_t err_correction_value = 0;
925 denali_set_intr_modes(denali, false);
928 err_address = ioread32(denali->flash_reg +
930 err_sector = ECC_SECTOR(err_address);
931 err_byte = ECC_BYTE(err_address);
933 err_correction_info = ioread32(denali->flash_reg +
934 ERR_CORRECTION_INFO);
935 err_correction_value =
936 ECC_CORRECTION_VALUE(err_correction_info);
937 err_device = ECC_ERR_DEVICE(err_correction_info);
939 if (ECC_ERROR_CORRECTABLE(err_correction_info)) {
940 /* If err_byte is larger than ECC_SECTOR_SIZE,
941 * means error happened in OOB, so we ignore
942 * it. It's no need for us to correct it
943 * err_device is represented the NAND error
944 * bits are happened in if there are more
945 * than one NAND connected.
947 if (err_byte < ECC_SECTOR_SIZE) {
949 offset = (err_sector *
954 /* correct the ECC error */
955 buf[offset] ^= err_correction_value;
956 denali->mtd.ecc_stats.corrected++;
959 /* if the error is not correctable, need to
960 * look at the page to see if it is an erased
961 * page. if so, then it's not a real ECC error
963 check_erased_page = true;
965 } while (!ECC_LAST_ERR(err_correction_info));
966 /* Once handle all ecc errors, controller will triger
967 * a ECC_TRANSACTION_DONE interrupt, so here just wait
968 * for a while for this interrupt
970 while (!(read_interrupt_status(denali) &
971 INTR_STATUS__ECC_TRANSACTION_DONE))
973 clear_interrupts(denali);
974 denali_set_intr_modes(denali, true);
976 return check_erased_page;
979 /* programs the controller to either enable/disable DMA transfers */
980 static void denali_enable_dma(struct denali_nand_info *denali, bool en)
982 uint32_t reg_val = 0x0;
985 reg_val = DMA_ENABLE__FLAG;
987 iowrite32(reg_val, denali->flash_reg + DMA_ENABLE);
988 ioread32(denali->flash_reg + DMA_ENABLE);
991 /* setups the HW to perform the data DMA */
992 static void denali_setup_dma(struct denali_nand_info *denali, int op)
995 const int page_count = 1;
996 dma_addr_t addr = denali->buf.dma_buf;
998 mode = MODE_10 | BANK(denali->flash_bank);
1000 /* DMA is a four step process */
1002 /* 1. setup transfer type and # of pages */
1003 index_addr(denali, mode | denali->page, 0x2000 | op | page_count);
1005 /* 2. set memory high address bits 23:8 */
1006 index_addr(denali, mode | ((uint16_t)(addr >> 16) << 8), 0x2200);
1008 /* 3. set memory low address bits 23:8 */
1009 index_addr(denali, mode | ((uint16_t)addr << 8), 0x2300);
1011 /* 4. interrupt when complete, burst len = 64 bytes*/
1012 index_addr(denali, mode | 0x14000, 0x2400);
1015 /* writes a page. user specifies type, and this function handles the
1016 * configuration details. */
1017 static void write_page(struct mtd_info *mtd, struct nand_chip *chip,
1018 const uint8_t *buf, bool raw_xfer)
1020 struct denali_nand_info *denali = mtd_to_denali(mtd);
1022 dma_addr_t addr = denali->buf.dma_buf;
1023 size_t size = denali->mtd.writesize + denali->mtd.oobsize;
1025 uint32_t irq_status = 0;
1026 uint32_t irq_mask = INTR_STATUS__DMA_CMD_COMP |
1027 INTR_STATUS__PROGRAM_FAIL;
1029 /* if it is a raw xfer, we want to disable ecc, and send
1031 * !raw_xfer - enable ecc
1032 * raw_xfer - transfer spare
1034 setup_ecc_for_xfer(denali, !raw_xfer, raw_xfer);
1036 /* copy buffer into DMA buffer */
1037 memcpy(denali->buf.buf, buf, mtd->writesize);
1040 /* transfer the data to the spare area */
1041 memcpy(denali->buf.buf + mtd->writesize,
1046 dma_sync_single_for_device(denali->dev, addr, size, DMA_TO_DEVICE);
1048 clear_interrupts(denali);
1049 denali_enable_dma(denali, true);
1051 denali_setup_dma(denali, DENALI_WRITE);
1053 /* wait for operation to complete */
1054 irq_status = wait_for_irq(denali, irq_mask);
1056 if (irq_status == 0) {
1057 dev_err(denali->dev,
1058 "timeout on write_page (type = %d)\n",
1061 (irq_status & INTR_STATUS__PROGRAM_FAIL) ?
1062 NAND_STATUS_FAIL : PASS;
1065 denali_enable_dma(denali, false);
1066 dma_sync_single_for_cpu(denali->dev, addr, size, DMA_TO_DEVICE);
1069 /* NAND core entry points */
1071 /* this is the callback that the NAND core calls to write a page. Since
1072 * writing a page with ECC or without is similar, all the work is done
1073 * by write_page above.
1075 static void denali_write_page(struct mtd_info *mtd, struct nand_chip *chip,
1078 /* for regular page writes, we let HW handle all the ECC
1079 * data written to the device. */
1080 write_page(mtd, chip, buf, false);
1083 /* This is the callback that the NAND core calls to write a page without ECC.
1084 * raw access is similar to ECC page writes, so all the work is done in the
1085 * write_page() function above.
1087 static void denali_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1090 /* for raw page writes, we want to disable ECC and simply write
1091 whatever data is in the buffer. */
1092 write_page(mtd, chip, buf, true);
1095 static int denali_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
1098 return write_oob_data(mtd, chip->oob_poi, page);
1101 static int denali_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
1102 int page, int sndcmd)
1104 read_oob_data(mtd, chip->oob_poi, page);
1106 return 0; /* notify NAND core to send command to
1110 static int denali_read_page(struct mtd_info *mtd, struct nand_chip *chip,
1111 uint8_t *buf, int page)
1113 struct denali_nand_info *denali = mtd_to_denali(mtd);
1115 dma_addr_t addr = denali->buf.dma_buf;
1116 size_t size = denali->mtd.writesize + denali->mtd.oobsize;
1118 uint32_t irq_status = 0;
1119 uint32_t irq_mask = INTR_STATUS__ECC_TRANSACTION_DONE |
1120 INTR_STATUS__ECC_ERR;
1121 bool check_erased_page = false;
1123 if (page != denali->page) {
1124 dev_err(denali->dev, "IN %s: page %d is not"
1125 " equal to denali->page %d, investigate!!",
1126 __func__, page, denali->page);
1130 setup_ecc_for_xfer(denali, true, false);
1132 denali_enable_dma(denali, true);
1133 dma_sync_single_for_device(denali->dev, addr, size, DMA_FROM_DEVICE);
1135 clear_interrupts(denali);
1136 denali_setup_dma(denali, DENALI_READ);
1138 /* wait for operation to complete */
1139 irq_status = wait_for_irq(denali, irq_mask);
1141 dma_sync_single_for_cpu(denali->dev, addr, size, DMA_FROM_DEVICE);
1143 memcpy(buf, denali->buf.buf, mtd->writesize);
1145 check_erased_page = handle_ecc(denali, buf, irq_status);
1146 denali_enable_dma(denali, false);
1148 if (check_erased_page) {
1149 read_oob_data(&denali->mtd, chip->oob_poi, denali->page);
1151 /* check ECC failures that may have occurred on erased pages */
1152 if (check_erased_page) {
1153 if (!is_erased(buf, denali->mtd.writesize))
1154 denali->mtd.ecc_stats.failed++;
1155 if (!is_erased(buf, denali->mtd.oobsize))
1156 denali->mtd.ecc_stats.failed++;
1162 static int denali_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1163 uint8_t *buf, int page)
1165 struct denali_nand_info *denali = mtd_to_denali(mtd);
1167 dma_addr_t addr = denali->buf.dma_buf;
1168 size_t size = denali->mtd.writesize + denali->mtd.oobsize;
1170 uint32_t irq_status = 0;
1171 uint32_t irq_mask = INTR_STATUS__DMA_CMD_COMP;
1173 if (page != denali->page) {
1174 dev_err(denali->dev, "IN %s: page %d is not"
1175 " equal to denali->page %d, investigate!!",
1176 __func__, page, denali->page);
1180 setup_ecc_for_xfer(denali, false, true);
1181 denali_enable_dma(denali, true);
1183 dma_sync_single_for_device(denali->dev, addr, size, DMA_FROM_DEVICE);
1185 clear_interrupts(denali);
1186 denali_setup_dma(denali, DENALI_READ);
1188 /* wait for operation to complete */
1189 irq_status = wait_for_irq(denali, irq_mask);
1191 dma_sync_single_for_cpu(denali->dev, addr, size, DMA_FROM_DEVICE);
1193 denali_enable_dma(denali, false);
1195 memcpy(buf, denali->buf.buf, mtd->writesize);
1196 memcpy(chip->oob_poi, denali->buf.buf + mtd->writesize, mtd->oobsize);
1201 static uint8_t denali_read_byte(struct mtd_info *mtd)
1203 struct denali_nand_info *denali = mtd_to_denali(mtd);
1204 uint8_t result = 0xff;
1206 if (denali->buf.head < denali->buf.tail)
1207 result = denali->buf.buf[denali->buf.head++];
1212 static void denali_select_chip(struct mtd_info *mtd, int chip)
1214 struct denali_nand_info *denali = mtd_to_denali(mtd);
1216 spin_lock_irq(&denali->irq_lock);
1217 denali->flash_bank = chip;
1218 spin_unlock_irq(&denali->irq_lock);
1221 static int denali_waitfunc(struct mtd_info *mtd, struct nand_chip *chip)
1223 struct denali_nand_info *denali = mtd_to_denali(mtd);
1224 int status = denali->status;
1230 static void denali_erase(struct mtd_info *mtd, int page)
1232 struct denali_nand_info *denali = mtd_to_denali(mtd);
1234 uint32_t cmd = 0x0, irq_status = 0;
1236 /* clear interrupts */
1237 clear_interrupts(denali);
1239 /* setup page read request for access type */
1240 cmd = MODE_10 | BANK(denali->flash_bank) | page;
1241 index_addr(denali, (uint32_t)cmd, 0x1);
1243 /* wait for erase to complete or failure to occur */
1244 irq_status = wait_for_irq(denali, INTR_STATUS__ERASE_COMP |
1245 INTR_STATUS__ERASE_FAIL);
1247 denali->status = (irq_status & INTR_STATUS__ERASE_FAIL) ?
1248 NAND_STATUS_FAIL : PASS;
1251 static void denali_cmdfunc(struct mtd_info *mtd, unsigned int cmd, int col,
1254 struct denali_nand_info *denali = mtd_to_denali(mtd);
1259 case NAND_CMD_PAGEPROG:
1261 case NAND_CMD_STATUS:
1262 read_status(denali);
1264 case NAND_CMD_READID:
1265 case NAND_CMD_PARAM:
1267 /*sometimes ManufactureId read from register is not right
1268 * e.g. some of Micron MT29F32G08QAA MLC NAND chips
1269 * So here we send READID cmd to NAND insteand
1271 addr = (uint32_t)MODE_11 | BANK(denali->flash_bank);
1272 index_addr(denali, (uint32_t)addr | 0, 0x90);
1273 index_addr(denali, (uint32_t)addr | 1, 0);
1274 for (i = 0; i < 5; i++) {
1275 index_addr_read_data(denali,
1278 write_byte_to_buf(denali, id);
1281 case NAND_CMD_READ0:
1282 case NAND_CMD_SEQIN:
1283 denali->page = page;
1285 case NAND_CMD_RESET:
1288 case NAND_CMD_READOOB:
1289 /* TODO: Read OOB data */
1292 printk(KERN_ERR ": unsupported command"
1293 " received 0x%x\n", cmd);
1298 /* stubs for ECC functions not used by the NAND core */
1299 static int denali_ecc_calculate(struct mtd_info *mtd, const uint8_t *data,
1302 struct denali_nand_info *denali = mtd_to_denali(mtd);
1303 dev_err(denali->dev,
1304 "denali_ecc_calculate called unexpectedly\n");
1309 static int denali_ecc_correct(struct mtd_info *mtd, uint8_t *data,
1310 uint8_t *read_ecc, uint8_t *calc_ecc)
1312 struct denali_nand_info *denali = mtd_to_denali(mtd);
1313 dev_err(denali->dev,
1314 "denali_ecc_correct called unexpectedly\n");
1319 static void denali_ecc_hwctl(struct mtd_info *mtd, int mode)
1321 struct denali_nand_info *denali = mtd_to_denali(mtd);
1322 dev_err(denali->dev,
1323 "denali_ecc_hwctl called unexpectedly\n");
1326 /* end NAND core entry points */
1328 /* Initialization code to bring the device up to a known good state */
1329 static void denali_hw_init(struct denali_nand_info *denali)
1331 /* tell driver how many bit controller will skip before
1332 * writing ECC code in OOB, this register may be already
1333 * set by firmware. So we read this value out.
1334 * if this value is 0, just let it be.
1336 denali->bbtskipbytes = ioread32(denali->flash_reg +
1337 SPARE_AREA_SKIP_BYTES);
1338 denali_nand_reset(denali);
1339 iowrite32(0x0F, denali->flash_reg + RB_PIN_ENABLED);
1340 iowrite32(CHIP_EN_DONT_CARE__FLAG,
1341 denali->flash_reg + CHIP_ENABLE_DONT_CARE);
1343 iowrite32(0xffff, denali->flash_reg + SPARE_AREA_MARKER);
1345 /* Should set value for these registers when init */
1346 iowrite32(0, denali->flash_reg + TWO_ROW_ADDR_CYCLES);
1347 iowrite32(1, denali->flash_reg + ECC_ENABLE);
1348 denali_nand_timing_set(denali);
1349 denali_irq_init(denali);
1352 /* Althogh controller spec said SLC ECC is forceb to be 4bit,
1353 * but denali controller in MRST only support 15bit and 8bit ECC
1356 #define ECC_8BITS 14
1357 static struct nand_ecclayout nand_8bit_oob = {
1361 #define ECC_15BITS 26
1362 static struct nand_ecclayout nand_15bit_oob = {
1366 static uint8_t bbt_pattern[] = {'B', 'b', 't', '0' };
1367 static uint8_t mirror_pattern[] = {'1', 't', 'b', 'B' };
1369 static struct nand_bbt_descr bbt_main_descr = {
1370 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1371 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1376 .pattern = bbt_pattern,
1379 static struct nand_bbt_descr bbt_mirror_descr = {
1380 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
1381 | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
1386 .pattern = mirror_pattern,
1389 /* initialize driver data structures */
1390 void denali_drv_init(struct denali_nand_info *denali)
1394 /* setup interrupt handler */
1395 /* the completion object will be used to notify
1396 * the callee that the interrupt is done */
1397 init_completion(&denali->complete);
1399 /* the spinlock will be used to synchronize the ISR
1400 * with any element that might be access shared
1401 * data (interrupt status) */
1402 spin_lock_init(&denali->irq_lock);
1404 /* indicate that MTD has not selected a valid bank yet */
1405 denali->flash_bank = CHIP_SELECT_INVALID;
1407 /* initialize our irq_status variable to indicate no interrupts */
1408 denali->irq_status = 0;
1411 /* driver entry point */
1412 static int denali_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
1415 resource_size_t csr_base, mem_base;
1416 unsigned long csr_len, mem_len;
1417 struct denali_nand_info *denali;
1419 denali = kzalloc(sizeof(*denali), GFP_KERNEL);
1423 ret = pci_enable_device(dev);
1425 printk(KERN_ERR "Spectra: pci_enable_device failed.\n");
1426 goto failed_alloc_memery;
1429 if (id->driver_data == INTEL_CE4100) {
1430 /* Due to a silicon limitation, we can only support
1431 * ONFI timing mode 1 and below.
1433 if (onfi_timing_mode < -1 || onfi_timing_mode > 1) {
1434 printk(KERN_ERR "Intel CE4100 only supports"
1435 " ONFI timing mode 1 or below\n");
1437 goto failed_enable_dev;
1439 denali->platform = INTEL_CE4100;
1440 mem_base = pci_resource_start(dev, 0);
1441 mem_len = pci_resource_len(dev, 1);
1442 csr_base = pci_resource_start(dev, 1);
1443 csr_len = pci_resource_len(dev, 1);
1445 denali->platform = INTEL_MRST;
1446 csr_base = pci_resource_start(dev, 0);
1447 csr_len = pci_resource_len(dev, 0);
1448 mem_base = pci_resource_start(dev, 1);
1449 mem_len = pci_resource_len(dev, 1);
1451 mem_base = csr_base + csr_len;
1456 /* Is 32-bit DMA supported? */
1457 ret = dma_set_mask(&dev->dev, DMA_BIT_MASK(32));
1459 printk(KERN_ERR "Spectra: no usable DMA configuration\n");
1460 goto failed_enable_dev;
1462 denali->buf.dma_buf = dma_map_single(&dev->dev, denali->buf.buf,
1466 if (dma_mapping_error(&dev->dev, denali->buf.dma_buf)) {
1467 dev_err(&dev->dev, "Spectra: failed to map DMA buffer\n");
1468 goto failed_enable_dev;
1471 pci_set_master(dev);
1472 denali->dev = &dev->dev;
1473 denali->mtd.dev.parent = &dev->dev;
1475 ret = pci_request_regions(dev, DENALI_NAND_NAME);
1477 printk(KERN_ERR "Spectra: Unable to request memory regions\n");
1478 goto failed_dma_map;
1481 denali->flash_reg = ioremap_nocache(csr_base, csr_len);
1482 if (!denali->flash_reg) {
1483 printk(KERN_ERR "Spectra: Unable to remap memory region\n");
1485 goto failed_req_regions;
1488 denali->flash_mem = ioremap_nocache(mem_base, mem_len);
1489 if (!denali->flash_mem) {
1490 printk(KERN_ERR "Spectra: ioremap_nocache failed!");
1492 goto failed_remap_reg;
1495 denali_hw_init(denali);
1496 denali_drv_init(denali);
1498 /* denali_isr register is done after all the hardware
1499 * initilization is finished*/
1500 if (request_irq(dev->irq, denali_isr, IRQF_SHARED,
1501 DENALI_NAND_NAME, denali)) {
1502 printk(KERN_ERR "Spectra: Unable to allocate IRQ\n");
1504 goto failed_remap_mem;
1507 /* now that our ISR is registered, we can enable interrupts */
1508 denali_set_intr_modes(denali, true);
1510 pci_set_drvdata(dev, denali);
1512 denali->mtd.name = "denali-nand";
1513 denali->mtd.owner = THIS_MODULE;
1514 denali->mtd.priv = &denali->nand;
1516 /* register the driver with the NAND core subsystem */
1517 denali->nand.select_chip = denali_select_chip;
1518 denali->nand.cmdfunc = denali_cmdfunc;
1519 denali->nand.read_byte = denali_read_byte;
1520 denali->nand.waitfunc = denali_waitfunc;
1522 /* scan for NAND devices attached to the controller
1523 * this is the first stage in a two step process to register
1524 * with the nand subsystem */
1525 if (nand_scan_ident(&denali->mtd, LLD_MAX_FLASH_BANKS, NULL)) {
1527 goto failed_req_irq;
1530 /* MTD supported page sizes vary by kernel. We validate our
1531 * kernel supports the device here.
1533 if (denali->mtd.writesize > NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE) {
1535 printk(KERN_ERR "Spectra: device size not supported by this "
1537 goto failed_req_irq;
1540 /* support for multi nand
1541 * MTD known nothing about multi nand,
1542 * so we should tell it the real pagesize
1543 * and anything necessery
1545 denali->devnum = ioread32(denali->flash_reg + DEVICES_CONNECTED);
1546 denali->nand.chipsize <<= (denali->devnum - 1);
1547 denali->nand.page_shift += (denali->devnum - 1);
1548 denali->nand.pagemask = (denali->nand.chipsize >>
1549 denali->nand.page_shift) - 1;
1550 denali->nand.bbt_erase_shift += (denali->devnum - 1);
1551 denali->nand.phys_erase_shift = denali->nand.bbt_erase_shift;
1552 denali->nand.chip_shift += (denali->devnum - 1);
1553 denali->mtd.writesize <<= (denali->devnum - 1);
1554 denali->mtd.oobsize <<= (denali->devnum - 1);
1555 denali->mtd.erasesize <<= (denali->devnum - 1);
1556 denali->mtd.size = denali->nand.numchips * denali->nand.chipsize;
1557 denali->bbtskipbytes *= denali->devnum;
1559 /* second stage of the NAND scan
1560 * this stage requires information regarding ECC and
1561 * bad block management. */
1563 /* Bad block management */
1564 denali->nand.bbt_td = &bbt_main_descr;
1565 denali->nand.bbt_md = &bbt_mirror_descr;
1567 /* skip the scan for now until we have OOB read and write support */
1568 denali->nand.options |= NAND_USE_FLASH_BBT | NAND_SKIP_BBTSCAN;
1569 denali->nand.ecc.mode = NAND_ECC_HW_SYNDROME;
1571 /* Denali Controller only support 15bit and 8bit ECC in MRST,
1572 * so just let controller do 15bit ECC for MLC and 8bit ECC for
1575 if (denali->nand.cellinfo & 0xc &&
1576 (denali->mtd.oobsize > (denali->bbtskipbytes +
1577 ECC_15BITS * (denali->mtd.writesize /
1578 ECC_SECTOR_SIZE)))) {
1579 /* if MLC OOB size is large enough, use 15bit ECC*/
1580 denali->nand.ecc.layout = &nand_15bit_oob;
1581 denali->nand.ecc.bytes = ECC_15BITS;
1582 iowrite32(15, denali->flash_reg + ECC_CORRECTION);
1583 } else if (denali->mtd.oobsize < (denali->bbtskipbytes +
1584 ECC_8BITS * (denali->mtd.writesize /
1585 ECC_SECTOR_SIZE))) {
1586 printk(KERN_ERR "Your NAND chip OOB is not large enough to"
1587 " contain 8bit ECC correction codes");
1588 goto failed_req_irq;
1590 denali->nand.ecc.layout = &nand_8bit_oob;
1591 denali->nand.ecc.bytes = ECC_8BITS;
1592 iowrite32(8, denali->flash_reg + ECC_CORRECTION);
1595 denali->nand.ecc.bytes *= denali->devnum;
1596 denali->nand.ecc.layout->eccbytes *=
1597 denali->mtd.writesize / ECC_SECTOR_SIZE;
1598 denali->nand.ecc.layout->oobfree[0].offset =
1599 denali->bbtskipbytes + denali->nand.ecc.layout->eccbytes;
1600 denali->nand.ecc.layout->oobfree[0].length =
1601 denali->mtd.oobsize - denali->nand.ecc.layout->eccbytes -
1602 denali->bbtskipbytes;
1604 /* Let driver know the total blocks number and
1605 * how many blocks contained by each nand chip.
1606 * blksperchip will help driver to know how many
1607 * blocks is taken by FW.
1609 denali->totalblks = denali->mtd.size >>
1610 denali->nand.phys_erase_shift;
1611 denali->blksperchip = denali->totalblks / denali->nand.numchips;
1613 /* These functions are required by the NAND core framework, otherwise,
1614 * the NAND core will assert. However, we don't need them, so we'll stub
1616 denali->nand.ecc.calculate = denali_ecc_calculate;
1617 denali->nand.ecc.correct = denali_ecc_correct;
1618 denali->nand.ecc.hwctl = denali_ecc_hwctl;
1620 /* override the default read operations */
1621 denali->nand.ecc.size = ECC_SECTOR_SIZE * denali->devnum;
1622 denali->nand.ecc.read_page = denali_read_page;
1623 denali->nand.ecc.read_page_raw = denali_read_page_raw;
1624 denali->nand.ecc.write_page = denali_write_page;
1625 denali->nand.ecc.write_page_raw = denali_write_page_raw;
1626 denali->nand.ecc.read_oob = denali_read_oob;
1627 denali->nand.ecc.write_oob = denali_write_oob;
1628 denali->nand.erase_cmd = denali_erase;
1630 if (nand_scan_tail(&denali->mtd)) {
1632 goto failed_req_irq;
1635 ret = add_mtd_device(&denali->mtd);
1637 dev_err(&dev->dev, "Spectra: Failed to register MTD: %d\n",
1639 goto failed_req_irq;
1644 denali_irq_cleanup(dev->irq, denali);
1646 iounmap(denali->flash_mem);
1648 iounmap(denali->flash_reg);
1650 pci_release_regions(dev);
1652 dma_unmap_single(&dev->dev, denali->buf.dma_buf, DENALI_BUF_SIZE,
1655 pci_disable_device(dev);
1656 failed_alloc_memery:
1661 /* driver exit point */
1662 static void denali_pci_remove(struct pci_dev *dev)
1664 struct denali_nand_info *denali = pci_get_drvdata(dev);
1666 nand_release(&denali->mtd);
1667 del_mtd_device(&denali->mtd);
1669 denali_irq_cleanup(dev->irq, denali);
1671 iounmap(denali->flash_reg);
1672 iounmap(denali->flash_mem);
1673 pci_release_regions(dev);
1674 pci_disable_device(dev);
1675 dma_unmap_single(&dev->dev, denali->buf.dma_buf, DENALI_BUF_SIZE,
1677 pci_set_drvdata(dev, NULL);
1681 MODULE_DEVICE_TABLE(pci, denali_pci_ids);
1683 static struct pci_driver denali_pci_driver = {
1684 .name = DENALI_NAND_NAME,
1685 .id_table = denali_pci_ids,
1686 .probe = denali_pci_probe,
1687 .remove = denali_pci_remove,
1690 static int __devinit denali_init(void)
1692 printk(KERN_INFO "Spectra MTD driver\n");
1693 return pci_register_driver(&denali_pci_driver);
1697 static void __devexit denali_exit(void)
1699 pci_unregister_driver(&denali_pci_driver);
1702 module_init(denali_init);
1703 module_exit(denali_exit);