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>
37 #include <asm/mach/flash.h>
38 #include <asm/arch/gpmc.h>
39 #include <asm/arch/onenand.h>
40 #include <asm/arch/gpio.h>
41 #include <asm/arch/pm.h>
43 #include <linux/dma-mapping.h>
44 #include <asm/dma-mapping.h>
45 #include <asm/arch/dma.h>
47 #include <asm/arch/board.h>
49 #define DRIVER_NAME "omap2-onenand"
51 #define ONENAND_IO_SIZE SZ_128K
52 #define ONENAND_BUFRAM_SIZE (1024 * 5)
54 struct omap2_onenand {
55 struct platform_device *pdev;
57 unsigned long phys_base;
60 struct mtd_partition *parts;
61 struct onenand_chip onenand;
62 struct completion irq_done;
63 struct completion dma_done;
66 int (*setup)(void __iomem *base, int freq);
69 static void omap2_onenand_dma_cb(int lch, u16 ch_status, void *data)
71 struct omap2_onenand *c = data;
73 complete(&c->dma_done);
76 static irqreturn_t omap2_onenand_interrupt(int irq, void *dev_id)
78 struct omap2_onenand *c = dev_id;
80 complete(&c->irq_done);
85 static inline unsigned short read_reg(struct omap2_onenand *c, int reg)
87 return readw(c->onenand.base + reg);
90 static inline void write_reg(struct omap2_onenand *c, unsigned short value,
93 writew(value, c->onenand.base + reg);
96 static void wait_err(char *msg, int state, unsigned int ctrl, unsigned int intr)
98 printk(KERN_ERR "onenand_wait: %s! state %d ctrl 0x%04x intr 0x%04x\n",
99 msg, state, ctrl, intr);
102 static void wait_warn(char *msg, int state, unsigned int ctrl,
105 printk(KERN_WARNING "onenand_wait: %s! state %d ctrl 0x%04x "
106 "intr 0x%04x\n", msg, state, ctrl, intr);
109 static int omap2_onenand_wait(struct mtd_info *mtd, int state)
111 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
112 unsigned int intr = 0;
114 unsigned long timeout;
117 if (state == FL_RESETING) {
120 for (i = 0; i < 20; i++) {
122 intr = read_reg(c, ONENAND_REG_INTERRUPT);
123 if (intr & ONENAND_INT_MASTER)
126 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
127 if (ctrl & ONENAND_CTRL_ERROR) {
128 wait_err("controller error", state, ctrl, intr);
131 if (!(intr & ONENAND_INT_RESET)) {
132 wait_err("timeout", state, ctrl, intr);
138 if (state != FL_READING) {
141 /* Turn interrupts on */
142 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
143 if (!(syscfg & ONENAND_SYS_CFG1_IOBE)) {
144 syscfg |= ONENAND_SYS_CFG1_IOBE;
145 write_reg(c, syscfg, ONENAND_REG_SYS_CFG1);
146 if (cpu_is_omap34xx())
147 /* Add a delay to let GPIO settle */
148 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
151 INIT_COMPLETION(c->irq_done);
153 result = omap_get_gpio_datain(c->gpio_irq);
155 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
156 intr = read_reg(c, ONENAND_REG_INTERRUPT);
157 wait_err("gpio error", state, ctrl, intr);
165 result = wait_for_completion_timeout(&c->irq_done,
166 msecs_to_jiffies(20));
168 /* Timeout after 20ms */
169 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
170 if (ctrl & ONENAND_CTRL_ONGO) {
172 * The operation seems to be still going
173 * so give it some more time.
179 ONENAND_REG_INTERRUPT);
180 wait_err("timeout", state, ctrl, intr);
183 intr = read_reg(c, ONENAND_REG_INTERRUPT);
184 if ((intr & ONENAND_INT_MASTER) == 0)
185 wait_warn("timeout", state, ctrl, intr);
191 /* Turn interrupts off */
192 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
193 syscfg &= ~ONENAND_SYS_CFG1_IOBE;
194 write_reg(c, syscfg, ONENAND_REG_SYS_CFG1);
196 timeout = jiffies + msecs_to_jiffies(20);
198 if (time_before(jiffies, timeout)) {
199 intr = read_reg(c, ONENAND_REG_INTERRUPT);
200 if (intr & ONENAND_INT_MASTER)
203 /* Timeout after 20ms */
204 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
205 if (ctrl & ONENAND_CTRL_ONGO) {
207 * The operation seems to be still going
208 * so give it some more time.
213 msecs_to_jiffies(20);
222 intr = read_reg(c, ONENAND_REG_INTERRUPT);
223 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
225 if (intr & ONENAND_INT_READ) {
226 int ecc = read_reg(c, ONENAND_REG_ECC_STATUS);
229 unsigned int addr1, addr8;
231 addr1 = read_reg(c, ONENAND_REG_START_ADDRESS1);
232 addr8 = read_reg(c, ONENAND_REG_START_ADDRESS8);
233 if (ecc & ONENAND_ECC_2BIT_ALL) {
234 printk(KERN_ERR "onenand_wait: ECC error = "
235 "0x%04x, addr1 %#x, addr8 %#x\n",
237 mtd->ecc_stats.failed++;
239 } else if (ecc & ONENAND_ECC_1BIT_ALL) {
240 printk(KERN_NOTICE "onenand_wait: correctable "
241 "ECC error = 0x%04x, addr1 %#x, "
242 "addr8 %#x\n", ecc, addr1, addr8);
243 mtd->ecc_stats.corrected++;
246 } else if (state == FL_READING) {
247 wait_err("timeout", state, ctrl, intr);
251 if (ctrl & ONENAND_CTRL_ERROR) {
252 wait_err("controller error", state, ctrl, intr);
253 if (ctrl & ONENAND_CTRL_LOCK)
254 printk(KERN_ERR "onenand_wait: "
255 "Device is write protected!!!\n");
260 wait_warn("unexpected controller status", state, ctrl, intr);
265 static inline int omap2_onenand_bufferram_offset(struct mtd_info *mtd, int area)
267 struct onenand_chip *this = mtd->priv;
269 if (ONENAND_CURRENT_BUFFERRAM(this)) {
270 if (area == ONENAND_DATARAM)
271 return mtd->writesize;
272 if (area == ONENAND_SPARERAM)
279 #if defined(CONFIG_ARCH_OMAP3) || defined(MULTI_OMAP2)
281 static int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
282 unsigned char *buffer, int offset,
285 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
286 struct onenand_chip *this = mtd->priv;
287 dma_addr_t dma_src, dma_dst;
289 unsigned long timeout;
290 void *buf = (void *)buffer;
292 volatile unsigned *done;
294 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
295 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
298 if (buf >= high_memory) {
301 if (((size_t)buf & PAGE_MASK) !=
302 ((size_t)(buf + count - 1) & PAGE_MASK))
304 p1 = vmalloc_to_page(buf);
307 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
313 memcpy(buf + count, this->base + bram_offset + count, xtra);
316 dma_src = c->phys_base + bram_offset;
317 dma_dst = dma_map_single(&c->pdev->dev, buf, count, DMA_FROM_DEVICE);
318 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
319 dev_err(&c->pdev->dev,
320 "Couldn't DMA map a %d byte buffer\n",
325 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
326 count >> 2, 1, 0, 0, 0);
327 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
329 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
332 INIT_COMPLETION(c->dma_done);
333 omap_start_dma(c->dma_channel);
335 timeout = jiffies + msecs_to_jiffies(20);
336 done = &c->dma_done.done;
337 while (time_before(jiffies, timeout))
341 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
344 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
351 memcpy(buf, this->base + bram_offset, count);
355 static int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
356 const unsigned char *buffer,
357 int offset, size_t count)
359 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
360 struct onenand_chip *this = mtd->priv;
361 dma_addr_t dma_src, dma_dst;
363 unsigned long timeout;
364 void *buf = (void *)buffer;
365 volatile unsigned *done;
367 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
368 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
371 /* panic_write() may be in an interrupt context */
375 if (buf >= high_memory) {
378 if (((size_t)buf & PAGE_MASK) !=
379 ((size_t)(buf + count - 1) & PAGE_MASK))
381 p1 = vmalloc_to_page(buf);
384 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
387 dma_src = dma_map_single(&c->pdev->dev, buf, count, DMA_TO_DEVICE);
388 dma_dst = c->phys_base + bram_offset;
389 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
390 dev_err(&c->pdev->dev,
391 "Couldn't DMA map a %d byte buffer\n",
396 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
397 count >> 2, 1, 0, 0, 0);
398 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
400 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
403 INIT_COMPLETION(c->dma_done);
404 omap_start_dma(c->dma_channel);
406 timeout = jiffies + msecs_to_jiffies(20);
407 done = &c->dma_done.done;
408 while (time_before(jiffies, timeout))
412 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
415 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
422 memcpy(this->base + bram_offset, buf, count);
428 int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
429 unsigned char *buffer, int offset,
432 int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
433 const unsigned char *buffer,
434 int offset, size_t count);
438 #if defined(CONFIG_ARCH_OMAP2) || defined(MULTI_OMAP2)
440 static int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
441 unsigned char *buffer, int offset,
444 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
445 struct onenand_chip *this = mtd->priv;
446 dma_addr_t dma_src, dma_dst;
449 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
450 /* DMA is not used. Revisit PM requirements before enabling it. */
451 if (1 || (c->dma_channel < 0) ||
452 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
453 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
454 memcpy(buffer, (__force void *)(this->base + bram_offset),
459 dma_src = c->phys_base + bram_offset;
460 dma_dst = dma_map_single(&c->pdev->dev, buffer, count,
462 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
463 dev_err(&c->pdev->dev,
464 "Couldn't DMA map a %d byte buffer\n",
469 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
470 count / 4, 1, 0, 0, 0);
471 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
473 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
476 INIT_COMPLETION(c->dma_done);
477 omap_start_dma(c->dma_channel);
478 wait_for_completion(&c->dma_done);
480 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
485 static int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
486 const unsigned char *buffer,
487 int offset, size_t count)
489 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
490 struct onenand_chip *this = mtd->priv;
491 dma_addr_t dma_src, dma_dst;
494 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
495 /* DMA is not used. Revisit PM requirements before enabling it. */
496 if (1 || (c->dma_channel < 0) ||
497 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
498 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
499 memcpy((__force void *)(this->base + bram_offset), buffer,
504 dma_src = dma_map_single(&c->pdev->dev, (void *) buffer, count,
506 dma_dst = c->phys_base + bram_offset;
507 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
508 dev_err(&c->pdev->dev,
509 "Couldn't DMA map a %d byte buffer\n",
514 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S16,
515 count / 2, 1, 0, 0, 0);
516 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
518 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
521 INIT_COMPLETION(c->dma_done);
522 omap_start_dma(c->dma_channel);
523 wait_for_completion(&c->dma_done);
525 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
532 int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
533 unsigned char *buffer, int offset,
536 int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
537 const unsigned char *buffer,
538 int offset, size_t count);
542 static struct platform_driver omap2_onenand_driver;
544 static int __adjust_timing(struct device *dev, void *data)
547 struct omap2_onenand *c;
549 c = dev_get_drvdata(dev);
551 BUG_ON(c->setup == NULL);
553 /* DMA is not in use so this is all that is needed */
554 /* Revisit for OMAP3! */
555 ret = c->setup(c->onenand.base, c->freq);
560 int omap2_onenand_rephase(void)
562 return driver_for_each_device(&omap2_onenand_driver.driver, NULL,
563 NULL, __adjust_timing);
566 static void __devexit omap2_onenand_shutdown(struct platform_device *pdev)
568 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
570 /* With certain content in the buffer RAM, the OMAP boot ROM code
571 * can recognize the flash chip incorrectly. Zero it out before
574 memset((__force void *)c->onenand.base, 0, ONENAND_BUFRAM_SIZE);
577 static int __devinit omap2_onenand_probe(struct platform_device *pdev)
579 struct omap_onenand_platform_data *pdata;
580 struct omap2_onenand *c;
583 pdata = pdev->dev.platform_data;
585 dev_err(&pdev->dev, "platform data missing\n");
589 c = kzalloc(sizeof(struct omap2_onenand), GFP_KERNEL);
593 init_completion(&c->irq_done);
594 init_completion(&c->dma_done);
595 c->gpmc_cs = pdata->cs;
596 c->gpio_irq = pdata->gpio_irq;
597 c->dma_channel = pdata->dma_channel;
598 if (c->dma_channel < 0) {
599 /* if -1, don't use DMA */
603 r = gpmc_cs_request(c->gpmc_cs, ONENAND_IO_SIZE, &c->phys_base);
605 dev_err(&pdev->dev, "Cannot request GPMC CS\n");
609 if (request_mem_region(c->phys_base, ONENAND_IO_SIZE,
610 pdev->dev.driver->name) == NULL) {
611 dev_err(&pdev->dev, "Cannot reserve memory region at 0x%08lx, "
612 "size: 0x%x\n", c->phys_base, ONENAND_IO_SIZE);
616 c->onenand.base = ioremap(c->phys_base, ONENAND_IO_SIZE);
617 if (c->onenand.base == NULL) {
619 goto err_release_mem_region;
622 if (pdata->onenand_setup != NULL) {
623 r = pdata->onenand_setup(c->onenand.base, c->freq);
625 dev_err(&pdev->dev, "Onenand platform setup failed: "
629 c->setup = pdata->onenand_setup;
633 if ((r = omap_request_gpio(c->gpio_irq)) < 0) {
634 dev_err(&pdev->dev, "Failed to request GPIO%d for "
635 "OneNAND\n", c->gpio_irq);
638 omap_set_gpio_direction(c->gpio_irq, 1);
640 if ((r = request_irq(OMAP_GPIO_IRQ(c->gpio_irq),
641 omap2_onenand_interrupt, IRQF_TRIGGER_RISING,
642 pdev->dev.driver->name, c)) < 0)
643 goto err_release_gpio;
646 if (c->dma_channel >= 0) {
647 r = omap_request_dma(0, pdev->dev.driver->name,
648 omap2_onenand_dma_cb, (void *) c,
651 omap_set_dma_write_mode(c->dma_channel,
652 OMAP_DMA_WRITE_NON_POSTED);
653 omap_set_dma_src_data_pack(c->dma_channel, 1);
654 omap_set_dma_src_burst_mode(c->dma_channel,
655 OMAP_DMA_DATA_BURST_8);
656 omap_set_dma_dest_data_pack(c->dma_channel, 1);
657 omap_set_dma_dest_burst_mode(c->dma_channel,
658 OMAP_DMA_DATA_BURST_8);
661 "failed to allocate DMA for OneNAND, "
662 "using PIO instead\n");
667 dev_info(&pdev->dev, "initializing on CS%d, phys base 0x%08lx, virtual "
668 "base %p\n", c->gpmc_cs, c->phys_base,
672 c->mtd.name = pdev->dev.bus_id;
673 c->mtd.priv = &c->onenand;
674 c->mtd.owner = THIS_MODULE;
676 if (c->dma_channel >= 0) {
677 struct onenand_chip *this = &c->onenand;
679 this->wait = omap2_onenand_wait;
680 if (cpu_is_omap34xx()) {
681 this->read_bufferram = omap3_onenand_read_bufferram;
682 this->write_bufferram = omap3_onenand_write_bufferram;
684 this->read_bufferram = omap2_onenand_read_bufferram;
685 this->write_bufferram = omap2_onenand_write_bufferram;
689 if ((r = onenand_scan(&c->mtd, 1)) < 0)
690 goto err_release_dma;
692 switch ((c->onenand.version_id >> 4) & 0xf) {
707 #ifdef CONFIG_MTD_PARTITIONS
708 if (pdata->parts != NULL)
709 r = add_mtd_partitions(&c->mtd, pdata->parts,
713 r = add_mtd_device(&c->mtd);
715 goto err_release_onenand;
717 platform_set_drvdata(pdev, c);
722 onenand_release(&c->mtd);
724 if (c->dma_channel != -1)
725 omap_free_dma(c->dma_channel);
727 free_irq(OMAP_GPIO_IRQ(c->gpio_irq), c);
730 omap_free_gpio(c->gpio_irq);
732 iounmap(c->onenand.base);
733 err_release_mem_region:
734 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
736 gpmc_cs_free(c->gpmc_cs);
743 static int __devexit omap2_onenand_remove(struct platform_device *pdev)
745 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
749 #ifdef CONFIG_MTD_PARTITIONS
751 del_mtd_partitions(&c->mtd);
753 del_mtd_device(&c->mtd);
755 del_mtd_device(&c->mtd);
758 onenand_release(&c->mtd);
759 if (c->dma_channel != -1)
760 omap_free_dma(c->dma_channel);
761 omap2_onenand_shutdown(pdev);
762 platform_set_drvdata(pdev, NULL);
764 free_irq(OMAP_GPIO_IRQ(c->gpio_irq), c);
765 omap_free_gpio(c->gpio_irq);
767 iounmap(c->onenand.base);
768 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
774 static struct platform_driver omap2_onenand_driver = {
775 .probe = omap2_onenand_probe,
776 .remove = omap2_onenand_remove,
777 .shutdown = omap2_onenand_shutdown,
780 .owner = THIS_MODULE,
784 static int __init omap2_onenand_init(void)
786 printk(KERN_INFO "OneNAND driver initializing\n");
787 return platform_driver_register(&omap2_onenand_driver);
790 static void __exit omap2_onenand_exit(void)
792 platform_driver_unregister(&omap2_onenand_driver);
795 module_init(omap2_onenand_init);
796 module_exit(omap2_onenand_exit);
798 MODULE_ALIAS(DRIVER_NAME);
799 MODULE_LICENSE("GPL");
800 MODULE_AUTHOR("Jarkko Lavinen <jarkko.lavinen@nokia.com>");
801 MODULE_DESCRIPTION("Glue layer for OneNAND flash on OMAP2 / OMAP3");