2 * linux/drivers/mtd/onenand/omap2.c
4 * OneNAND driver for OMAP2 / OMAP3
6 * Copyright © 2005-2006 Nokia Corporation
8 * Author: Jarkko Lavinen <jarkko.lavinen@nokia.com> and Juha Yrjölä
9 * IRQ and DMA support written by Timo Teras
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License version 2 as published by
13 * the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; see the file COPYING. If not, write to the Free Software
22 * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <linux/device.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/mtd/mtd.h>
30 #include <linux/mtd/onenand.h>
31 #include <linux/mtd/partitions.h>
32 #include <linux/platform_device.h>
33 #include <linux/interrupt.h>
34 #include <linux/delay.h>
35 #include <linux/dma-mapping.h>
38 #include <asm/mach/flash.h>
39 #include <mach/gpmc.h>
40 #include <mach/onenand.h>
41 #include <mach/gpio.h>
46 #include <mach/board.h>
48 #define DRIVER_NAME "omap2-onenand"
50 #define ONENAND_IO_SIZE SZ_128K
51 #define ONENAND_BUFRAM_SIZE (1024 * 5)
53 struct omap2_onenand {
54 struct platform_device *pdev;
56 unsigned long phys_base;
59 struct mtd_partition *parts;
60 struct onenand_chip onenand;
61 struct completion irq_done;
62 struct completion dma_done;
65 int (*setup)(void __iomem *base, int freq);
68 static void omap2_onenand_dma_cb(int lch, u16 ch_status, void *data)
70 struct omap2_onenand *c = data;
72 complete(&c->dma_done);
75 static irqreturn_t omap2_onenand_interrupt(int irq, void *dev_id)
77 struct omap2_onenand *c = dev_id;
79 complete(&c->irq_done);
84 static inline unsigned short read_reg(struct omap2_onenand *c, int reg)
86 return readw(c->onenand.base + reg);
89 static inline void write_reg(struct omap2_onenand *c, unsigned short value,
92 writew(value, c->onenand.base + reg);
95 static void wait_err(char *msg, int state, unsigned int ctrl, unsigned int intr)
97 printk(KERN_ERR "onenand_wait: %s! state %d ctrl 0x%04x intr 0x%04x\n",
98 msg, state, ctrl, intr);
101 static void wait_warn(char *msg, int state, unsigned int ctrl,
104 printk(KERN_WARNING "onenand_wait: %s! state %d ctrl 0x%04x "
105 "intr 0x%04x\n", msg, state, ctrl, intr);
108 static int omap2_onenand_wait(struct mtd_info *mtd, int state)
110 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
111 unsigned int intr = 0;
113 unsigned long timeout;
116 if (state == FL_RESETING) {
119 for (i = 0; i < 20; i++) {
121 intr = read_reg(c, ONENAND_REG_INTERRUPT);
122 if (intr & ONENAND_INT_MASTER)
125 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
126 if (ctrl & ONENAND_CTRL_ERROR) {
127 wait_err("controller error", state, ctrl, intr);
130 if (!(intr & ONENAND_INT_RESET)) {
131 wait_err("timeout", state, ctrl, intr);
137 if (state != FL_READING) {
140 /* Turn interrupts on */
141 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
142 if (!(syscfg & ONENAND_SYS_CFG1_IOBE)) {
143 syscfg |= ONENAND_SYS_CFG1_IOBE;
144 write_reg(c, syscfg, ONENAND_REG_SYS_CFG1);
145 if (cpu_is_omap34xx())
146 /* Add a delay to let GPIO settle */
147 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
150 INIT_COMPLETION(c->irq_done);
152 result = gpio_get_value(c->gpio_irq);
154 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
155 intr = read_reg(c, ONENAND_REG_INTERRUPT);
156 wait_err("gpio error", state, ctrl, intr);
164 result = wait_for_completion_timeout(&c->irq_done,
165 msecs_to_jiffies(20));
167 /* Timeout after 20ms */
168 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
169 if (ctrl & ONENAND_CTRL_ONGO) {
171 * The operation seems to be still going
172 * so give it some more time.
178 ONENAND_REG_INTERRUPT);
179 wait_err("timeout", state, ctrl, intr);
182 intr = read_reg(c, ONENAND_REG_INTERRUPT);
183 if ((intr & ONENAND_INT_MASTER) == 0)
184 wait_warn("timeout", state, ctrl, intr);
190 /* Turn interrupts off */
191 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
192 syscfg &= ~ONENAND_SYS_CFG1_IOBE;
193 write_reg(c, syscfg, ONENAND_REG_SYS_CFG1);
195 timeout = jiffies + msecs_to_jiffies(20);
197 if (time_before(jiffies, timeout)) {
198 intr = read_reg(c, ONENAND_REG_INTERRUPT);
199 if (intr & ONENAND_INT_MASTER)
202 /* Timeout after 20ms */
203 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
204 if (ctrl & ONENAND_CTRL_ONGO) {
206 * The operation seems to be still going
207 * so give it some more time.
212 msecs_to_jiffies(20);
221 intr = read_reg(c, ONENAND_REG_INTERRUPT);
222 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
224 if (intr & ONENAND_INT_READ) {
225 int ecc = read_reg(c, ONENAND_REG_ECC_STATUS);
228 unsigned int addr1, addr8;
230 addr1 = read_reg(c, ONENAND_REG_START_ADDRESS1);
231 addr8 = read_reg(c, ONENAND_REG_START_ADDRESS8);
232 if (ecc & ONENAND_ECC_2BIT_ALL) {
233 printk(KERN_ERR "onenand_wait: ECC error = "
234 "0x%04x, addr1 %#x, addr8 %#x\n",
236 mtd->ecc_stats.failed++;
238 } else if (ecc & ONENAND_ECC_1BIT_ALL) {
239 printk(KERN_NOTICE "onenand_wait: correctable "
240 "ECC error = 0x%04x, addr1 %#x, "
241 "addr8 %#x\n", ecc, addr1, addr8);
242 mtd->ecc_stats.corrected++;
245 } else if (state == FL_READING) {
246 wait_err("timeout", state, ctrl, intr);
250 if (ctrl & ONENAND_CTRL_ERROR) {
251 wait_err("controller error", state, ctrl, intr);
252 if (ctrl & ONENAND_CTRL_LOCK)
253 printk(KERN_ERR "onenand_wait: "
254 "Device is write protected!!!\n");
259 wait_warn("unexpected controller status", state, ctrl, intr);
264 static inline int omap2_onenand_bufferram_offset(struct mtd_info *mtd, int area)
266 struct onenand_chip *this = mtd->priv;
268 if (ONENAND_CURRENT_BUFFERRAM(this)) {
269 if (area == ONENAND_DATARAM)
270 return mtd->writesize;
271 if (area == ONENAND_SPARERAM)
278 #if defined(CONFIG_ARCH_OMAP3) || defined(MULTI_OMAP2)
280 static int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
281 unsigned char *buffer, int offset,
284 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
285 struct onenand_chip *this = mtd->priv;
286 dma_addr_t dma_src, dma_dst;
288 unsigned long timeout;
289 void *buf = (void *)buffer;
291 volatile unsigned *done;
293 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
294 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
297 /* panic_write() may be in an interrupt context */
301 if (buf >= high_memory) {
304 if (((size_t)buf & PAGE_MASK) !=
305 ((size_t)(buf + count - 1) & PAGE_MASK))
307 p1 = vmalloc_to_page(buf);
310 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
316 memcpy(buf + count, this->base + bram_offset + count, xtra);
319 dma_src = c->phys_base + bram_offset;
320 dma_dst = dma_map_single(&c->pdev->dev, buf, count, DMA_FROM_DEVICE);
321 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
322 dev_err(&c->pdev->dev,
323 "Couldn't DMA map a %d byte buffer\n",
328 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
329 count >> 2, 1, 0, 0, 0);
330 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
332 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
335 INIT_COMPLETION(c->dma_done);
336 omap_start_dma(c->dma_channel);
338 timeout = jiffies + msecs_to_jiffies(20);
339 done = &c->dma_done.done;
340 while (time_before(jiffies, timeout))
344 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
347 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
354 memcpy(buf, this->base + bram_offset, count);
358 static int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
359 const unsigned char *buffer,
360 int offset, size_t count)
362 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
363 struct onenand_chip *this = mtd->priv;
364 dma_addr_t dma_src, dma_dst;
366 unsigned long timeout;
367 void *buf = (void *)buffer;
368 volatile unsigned *done;
370 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
371 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
374 /* panic_write() may be in an interrupt context */
378 if (buf >= high_memory) {
381 if (((size_t)buf & PAGE_MASK) !=
382 ((size_t)(buf + count - 1) & PAGE_MASK))
384 p1 = vmalloc_to_page(buf);
387 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
390 dma_src = dma_map_single(&c->pdev->dev, buf, count, DMA_TO_DEVICE);
391 dma_dst = c->phys_base + bram_offset;
392 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
393 dev_err(&c->pdev->dev,
394 "Couldn't DMA map a %d byte buffer\n",
399 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
400 count >> 2, 1, 0, 0, 0);
401 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
403 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
406 INIT_COMPLETION(c->dma_done);
407 omap_start_dma(c->dma_channel);
409 timeout = jiffies + msecs_to_jiffies(20);
410 done = &c->dma_done.done;
411 while (time_before(jiffies, timeout))
415 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
418 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
425 memcpy(this->base + bram_offset, buf, count);
431 int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
432 unsigned char *buffer, int offset,
435 int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
436 const unsigned char *buffer,
437 int offset, size_t count);
441 #if defined(CONFIG_ARCH_OMAP2) || defined(MULTI_OMAP2)
443 static int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
444 unsigned char *buffer, int offset,
447 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
448 struct onenand_chip *this = mtd->priv;
449 dma_addr_t dma_src, dma_dst;
452 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
453 /* DMA is not used. Revisit PM requirements before enabling it. */
454 if (1 || (c->dma_channel < 0) ||
455 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
456 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
457 memcpy(buffer, (__force void *)(this->base + bram_offset),
462 dma_src = c->phys_base + bram_offset;
463 dma_dst = dma_map_single(&c->pdev->dev, buffer, count,
465 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
466 dev_err(&c->pdev->dev,
467 "Couldn't DMA map a %d byte buffer\n",
472 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
473 count / 4, 1, 0, 0, 0);
474 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
476 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
479 INIT_COMPLETION(c->dma_done);
480 omap_start_dma(c->dma_channel);
481 wait_for_completion(&c->dma_done);
483 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
488 static int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
489 const unsigned char *buffer,
490 int offset, size_t count)
492 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
493 struct onenand_chip *this = mtd->priv;
494 dma_addr_t dma_src, dma_dst;
497 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
498 /* DMA is not used. Revisit PM requirements before enabling it. */
499 if (1 || (c->dma_channel < 0) ||
500 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
501 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
502 memcpy((__force void *)(this->base + bram_offset), buffer,
507 dma_src = dma_map_single(&c->pdev->dev, (void *) buffer, count,
509 dma_dst = c->phys_base + bram_offset;
510 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
511 dev_err(&c->pdev->dev,
512 "Couldn't DMA map a %d byte buffer\n",
517 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S16,
518 count / 2, 1, 0, 0, 0);
519 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
521 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
524 INIT_COMPLETION(c->dma_done);
525 omap_start_dma(c->dma_channel);
526 wait_for_completion(&c->dma_done);
528 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
535 int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
536 unsigned char *buffer, int offset,
539 int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
540 const unsigned char *buffer,
541 int offset, size_t count);
545 static struct platform_driver omap2_onenand_driver;
547 static int __adjust_timing(struct device *dev, void *data)
550 struct omap2_onenand *c;
552 c = dev_get_drvdata(dev);
554 BUG_ON(c->setup == NULL);
556 /* DMA is not in use so this is all that is needed */
557 /* Revisit for OMAP3! */
558 ret = c->setup(c->onenand.base, c->freq);
563 int omap2_onenand_rephase(void)
565 return driver_for_each_device(&omap2_onenand_driver.driver, NULL,
566 NULL, __adjust_timing);
569 static void __devexit omap2_onenand_shutdown(struct platform_device *pdev)
571 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
573 /* With certain content in the buffer RAM, the OMAP boot ROM code
574 * can recognize the flash chip incorrectly. Zero it out before
577 memset((__force void *)c->onenand.base, 0, ONENAND_BUFRAM_SIZE);
580 static int __devinit omap2_onenand_probe(struct platform_device *pdev)
582 struct omap_onenand_platform_data *pdata;
583 struct omap2_onenand *c;
586 pdata = pdev->dev.platform_data;
588 dev_err(&pdev->dev, "platform data missing\n");
592 c = kzalloc(sizeof(struct omap2_onenand), GFP_KERNEL);
596 init_completion(&c->irq_done);
597 init_completion(&c->dma_done);
598 c->gpmc_cs = pdata->cs;
599 c->gpio_irq = pdata->gpio_irq;
600 c->dma_channel = pdata->dma_channel;
601 if (c->dma_channel < 0) {
602 /* if -1, don't use DMA */
606 r = gpmc_cs_request(c->gpmc_cs, ONENAND_IO_SIZE, &c->phys_base);
608 dev_err(&pdev->dev, "Cannot request GPMC CS\n");
612 if (request_mem_region(c->phys_base, ONENAND_IO_SIZE,
613 pdev->dev.driver->name) == NULL) {
614 dev_err(&pdev->dev, "Cannot reserve memory region at 0x%08lx, "
615 "size: 0x%x\n", c->phys_base, ONENAND_IO_SIZE);
619 c->onenand.base = ioremap(c->phys_base, ONENAND_IO_SIZE);
620 if (c->onenand.base == NULL) {
622 goto err_release_mem_region;
625 if (pdata->onenand_setup != NULL) {
626 r = pdata->onenand_setup(c->onenand.base, c->freq);
628 dev_err(&pdev->dev, "Onenand platform setup failed: "
632 c->setup = pdata->onenand_setup;
636 if ((r = gpio_request(c->gpio_irq, "OneNAND irq")) < 0) {
637 dev_err(&pdev->dev, "Failed to request GPIO%d for "
638 "OneNAND\n", c->gpio_irq);
641 gpio_direction_input(c->gpio_irq);
643 if ((r = request_irq(gpio_to_irq(c->gpio_irq),
644 omap2_onenand_interrupt, IRQF_TRIGGER_RISING,
645 pdev->dev.driver->name, c)) < 0)
646 goto err_release_gpio;
649 if (c->dma_channel >= 0) {
650 r = omap_request_dma(0, pdev->dev.driver->name,
651 omap2_onenand_dma_cb, (void *) c,
654 omap_set_dma_write_mode(c->dma_channel,
655 OMAP_DMA_WRITE_NON_POSTED);
656 omap_set_dma_src_data_pack(c->dma_channel, 1);
657 omap_set_dma_src_burst_mode(c->dma_channel,
658 OMAP_DMA_DATA_BURST_8);
659 omap_set_dma_dest_data_pack(c->dma_channel, 1);
660 omap_set_dma_dest_burst_mode(c->dma_channel,
661 OMAP_DMA_DATA_BURST_8);
664 "failed to allocate DMA for OneNAND, "
665 "using PIO instead\n");
670 dev_info(&pdev->dev, "initializing on CS%d, phys base 0x%08lx, virtual "
671 "base %p\n", c->gpmc_cs, c->phys_base,
675 c->mtd.name = dev_name(&pdev->dev);
676 c->mtd.priv = &c->onenand;
677 c->mtd.owner = THIS_MODULE;
679 c->mtd.dev.parent = &pdev->dev;
681 if (c->dma_channel >= 0) {
682 struct onenand_chip *this = &c->onenand;
684 this->wait = omap2_onenand_wait;
685 if (cpu_is_omap34xx()) {
686 this->read_bufferram = omap3_onenand_read_bufferram;
687 this->write_bufferram = omap3_onenand_write_bufferram;
689 this->read_bufferram = omap2_onenand_read_bufferram;
690 this->write_bufferram = omap2_onenand_write_bufferram;
694 if ((r = onenand_scan(&c->mtd, 1)) < 0)
695 goto err_release_dma;
697 switch ((c->onenand.version_id >> 4) & 0xf) {
712 #ifdef CONFIG_MTD_PARTITIONS
713 if (pdata->parts != NULL)
714 r = add_mtd_partitions(&c->mtd, pdata->parts,
718 r = add_mtd_device(&c->mtd);
720 goto err_release_onenand;
722 platform_set_drvdata(pdev, c);
727 onenand_release(&c->mtd);
729 if (c->dma_channel != -1)
730 omap_free_dma(c->dma_channel);
732 free_irq(gpio_to_irq(c->gpio_irq), c);
735 gpio_free(c->gpio_irq);
737 iounmap(c->onenand.base);
738 err_release_mem_region:
739 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
741 gpmc_cs_free(c->gpmc_cs);
748 static int __devexit omap2_onenand_remove(struct platform_device *pdev)
750 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
754 #ifdef CONFIG_MTD_PARTITIONS
756 del_mtd_partitions(&c->mtd);
758 del_mtd_device(&c->mtd);
760 del_mtd_device(&c->mtd);
763 onenand_release(&c->mtd);
764 if (c->dma_channel != -1)
765 omap_free_dma(c->dma_channel);
766 omap2_onenand_shutdown(pdev);
767 platform_set_drvdata(pdev, NULL);
769 free_irq(gpio_to_irq(c->gpio_irq), c);
770 gpio_free(c->gpio_irq);
772 iounmap(c->onenand.base);
773 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
779 static struct platform_driver omap2_onenand_driver = {
780 .probe = omap2_onenand_probe,
781 .remove = omap2_onenand_remove,
782 .shutdown = omap2_onenand_shutdown,
785 .owner = THIS_MODULE,
789 static int __init omap2_onenand_init(void)
791 printk(KERN_INFO "OneNAND driver initializing\n");
792 return platform_driver_register(&omap2_onenand_driver);
795 static void __exit omap2_onenand_exit(void)
797 platform_driver_unregister(&omap2_onenand_driver);
800 module_init(omap2_onenand_init);
801 module_exit(omap2_onenand_exit);
803 MODULE_ALIAS(DRIVER_NAME);
804 MODULE_LICENSE("GPL");
805 MODULE_AUTHOR("Jarkko Lavinen <jarkko.lavinen@nokia.com>");
806 MODULE_DESCRIPTION("Glue layer for OneNAND flash on OMAP2 / OMAP3");