2 * linux/drivers/mtd/onenand/omap2.c
4 * OneNAND driver for OMAP2 / OMAP3
6 * Copyright (C) 2005-2006 Nokia Corporation
8 * Author: Jarkko Lavinen <jarkko.lavinen@nokia.com> and Juha Yrjola
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 <mach/gpmc.h>
39 #include <mach/onenand.h>
40 #include <mach/gpio.h>
43 #include <linux/dma-mapping.h>
44 #include <asm/dma-mapping.h>
47 #include <mach/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);
189 /* Turn interrupts off */
190 syscfg = read_reg(c, ONENAND_REG_SYS_CFG1);
191 syscfg &= ~ONENAND_SYS_CFG1_IOBE;
192 write_reg(c, syscfg, ONENAND_REG_SYS_CFG1);
194 timeout = jiffies + msecs_to_jiffies(20);
195 while (time_before(jiffies, timeout)) {
196 intr = read_reg(c, ONENAND_REG_INTERRUPT);
197 if (intr & ONENAND_INT_MASTER)
202 intr = read_reg(c, ONENAND_REG_INTERRUPT);
203 ctrl = read_reg(c, ONENAND_REG_CTRL_STATUS);
205 if (intr & ONENAND_INT_READ) {
206 int ecc = read_reg(c, ONENAND_REG_ECC_STATUS);
209 unsigned int addr1, addr8;
211 addr1 = read_reg(c, ONENAND_REG_START_ADDRESS1);
212 addr8 = read_reg(c, ONENAND_REG_START_ADDRESS8);
213 if (ecc & ONENAND_ECC_2BIT_ALL) {
214 printk(KERN_ERR "onenand_wait: ECC error = "
215 "0x%04x, addr1 %#x, addr8 %#x\n",
217 mtd->ecc_stats.failed++;
219 } else if (ecc & ONENAND_ECC_1BIT_ALL) {
220 printk(KERN_NOTICE "onenand_wait: correctable "
221 "ECC error = 0x%04x, addr1 %#x, "
222 "addr8 %#x\n", ecc, addr1, addr8);
223 mtd->ecc_stats.corrected++;
226 } else if (state == FL_READING) {
227 wait_err("timeout", state, ctrl, intr);
231 if (ctrl & ONENAND_CTRL_ERROR) {
232 wait_err("controller error", state, ctrl, intr);
233 if (ctrl & ONENAND_CTRL_LOCK)
234 printk(KERN_ERR "onenand_wait: "
235 "Device is write protected!!!\n");
240 wait_warn("unexpected controller status", state, ctrl, intr);
245 static inline int omap2_onenand_bufferram_offset(struct mtd_info *mtd, int area)
247 struct onenand_chip *this = mtd->priv;
249 if (ONENAND_CURRENT_BUFFERRAM(this)) {
250 if (area == ONENAND_DATARAM)
251 return mtd->writesize;
252 if (area == ONENAND_SPARERAM)
259 #if defined(CONFIG_ARCH_OMAP3) || defined(MULTI_OMAP2)
261 static int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
262 unsigned char *buffer, int offset,
265 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
266 struct onenand_chip *this = mtd->priv;
267 dma_addr_t dma_src, dma_dst;
269 unsigned long timeout;
270 void *buf = (void *)buffer;
272 volatile unsigned *done;
274 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
275 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
278 if (buf >= high_memory) {
281 if (((size_t)buf & PAGE_MASK) !=
282 ((size_t)(buf + count - 1) & PAGE_MASK))
284 p1 = vmalloc_to_page(buf);
287 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
293 memcpy(buf + count, this->base + bram_offset + count, xtra);
296 dma_src = c->phys_base + bram_offset;
297 dma_dst = dma_map_single(&c->pdev->dev, buf, count, DMA_FROM_DEVICE);
298 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
299 dev_err(&c->pdev->dev,
300 "Couldn't DMA map a %d byte buffer\n",
305 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
306 count >> 2, 1, 0, 0, 0);
307 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
309 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
312 INIT_COMPLETION(c->dma_done);
313 omap_start_dma(c->dma_channel);
315 timeout = jiffies + msecs_to_jiffies(20);
316 done = &c->dma_done.done;
317 while (time_before(jiffies, timeout))
321 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
324 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
331 memcpy(buf, this->base + bram_offset, count);
335 static int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
336 const unsigned char *buffer,
337 int offset, size_t count)
339 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
340 struct onenand_chip *this = mtd->priv;
341 dma_addr_t dma_src, dma_dst;
343 unsigned long timeout;
344 void *buf = (void *)buffer;
345 volatile unsigned *done;
347 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
348 if (bram_offset & 3 || (size_t)buf & 3 || count < 384)
351 /* panic_write() may be in an interrupt context */
355 if (buf >= high_memory) {
358 if (((size_t)buf & PAGE_MASK) !=
359 ((size_t)(buf + count - 1) & PAGE_MASK))
361 p1 = vmalloc_to_page(buf);
364 buf = page_address(p1) + ((size_t)buf & ~PAGE_MASK);
367 dma_src = dma_map_single(&c->pdev->dev, buf, count, DMA_TO_DEVICE);
368 dma_dst = c->phys_base + bram_offset;
369 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
370 dev_err(&c->pdev->dev,
371 "Couldn't DMA map a %d byte buffer\n",
376 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
377 count >> 2, 1, 0, 0, 0);
378 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
380 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
383 INIT_COMPLETION(c->dma_done);
384 omap_start_dma(c->dma_channel);
386 timeout = jiffies + msecs_to_jiffies(20);
387 done = &c->dma_done.done;
388 while (time_before(jiffies, timeout))
392 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
395 dev_err(&c->pdev->dev, "timeout waiting for DMA\n");
402 memcpy(this->base + bram_offset, buf, count);
408 int omap3_onenand_read_bufferram(struct mtd_info *mtd, int area,
409 unsigned char *buffer, int offset,
412 int omap3_onenand_write_bufferram(struct mtd_info *mtd, int area,
413 const unsigned char *buffer,
414 int offset, size_t count);
418 #if defined(CONFIG_ARCH_OMAP2) || defined(MULTI_OMAP2)
420 static int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
421 unsigned char *buffer, int offset,
424 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
425 struct onenand_chip *this = mtd->priv;
426 dma_addr_t dma_src, dma_dst;
429 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
430 /* DMA is not used. Revisit PM requirements before enabling it. */
431 if (1 || (c->dma_channel < 0) ||
432 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
433 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
434 memcpy(buffer, (__force void *)(this->base + bram_offset),
439 dma_src = c->phys_base + bram_offset;
440 dma_dst = dma_map_single(&c->pdev->dev, buffer, count,
442 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
443 dev_err(&c->pdev->dev,
444 "Couldn't DMA map a %d byte buffer\n",
449 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S32,
450 count / 4, 1, 0, 0, 0);
451 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
453 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
456 INIT_COMPLETION(c->dma_done);
457 omap_start_dma(c->dma_channel);
458 wait_for_completion(&c->dma_done);
460 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_FROM_DEVICE);
465 static int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
466 const unsigned char *buffer,
467 int offset, size_t count)
469 struct omap2_onenand *c = container_of(mtd, struct omap2_onenand, mtd);
470 struct onenand_chip *this = mtd->priv;
471 dma_addr_t dma_src, dma_dst;
474 bram_offset = omap2_onenand_bufferram_offset(mtd, area) + area + offset;
475 /* DMA is not used. Revisit PM requirements before enabling it. */
476 if (1 || (c->dma_channel < 0) ||
477 ((void *) buffer >= (void *) high_memory) || (bram_offset & 3) ||
478 (((unsigned int) buffer) & 3) || (count < 1024) || (count & 3)) {
479 memcpy((__force void *)(this->base + bram_offset), buffer,
484 dma_src = dma_map_single(&c->pdev->dev, (void *) buffer, count,
486 dma_dst = c->phys_base + bram_offset;
487 if (dma_mapping_error(&c->pdev->dev, dma_dst)) {
488 dev_err(&c->pdev->dev,
489 "Couldn't DMA map a %d byte buffer\n",
494 omap_set_dma_transfer_params(c->dma_channel, OMAP_DMA_DATA_TYPE_S16,
495 count / 2, 1, 0, 0, 0);
496 omap_set_dma_src_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
498 omap_set_dma_dest_params(c->dma_channel, 0, OMAP_DMA_AMODE_POST_INC,
501 INIT_COMPLETION(c->dma_done);
502 omap_start_dma(c->dma_channel);
503 wait_for_completion(&c->dma_done);
505 dma_unmap_single(&c->pdev->dev, dma_dst, count, DMA_TO_DEVICE);
512 int omap2_onenand_read_bufferram(struct mtd_info *mtd, int area,
513 unsigned char *buffer, int offset,
516 int omap2_onenand_write_bufferram(struct mtd_info *mtd, int area,
517 const unsigned char *buffer,
518 int offset, size_t count);
522 static struct platform_driver omap2_onenand_driver;
524 static int __adjust_timing(struct device *dev, void *data)
527 struct omap2_onenand *c;
529 c = dev_get_drvdata(dev);
531 BUG_ON(c->setup == NULL);
533 /* DMA is not in use so this is all that is needed */
534 /* Revisit for OMAP3! */
535 ret = c->setup(c->onenand.base, c->freq);
540 int omap2_onenand_rephase(void)
542 return driver_for_each_device(&omap2_onenand_driver.driver, NULL,
543 NULL, __adjust_timing);
546 static void __devexit omap2_onenand_shutdown(struct platform_device *pdev)
548 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
550 /* With certain content in the buffer RAM, the OMAP boot ROM code
551 * can recognize the flash chip incorrectly. Zero it out before
554 memset((__force void *)c->onenand.base, 0, ONENAND_BUFRAM_SIZE);
557 static int __devinit omap2_onenand_probe(struct platform_device *pdev)
559 struct omap_onenand_platform_data *pdata;
560 struct omap2_onenand *c;
563 pdata = pdev->dev.platform_data;
565 dev_err(&pdev->dev, "platform data missing\n");
569 c = kzalloc(sizeof(struct omap2_onenand), GFP_KERNEL);
573 init_completion(&c->irq_done);
574 init_completion(&c->dma_done);
575 c->gpmc_cs = pdata->cs;
576 c->gpio_irq = pdata->gpio_irq;
577 c->dma_channel = pdata->dma_channel;
578 if (c->dma_channel < 0) {
579 /* if -1, don't use DMA */
583 r = gpmc_cs_request(c->gpmc_cs, ONENAND_IO_SIZE, &c->phys_base);
585 dev_err(&pdev->dev, "Cannot request GPMC CS\n");
589 if (request_mem_region(c->phys_base, ONENAND_IO_SIZE,
590 pdev->dev.driver->name) == NULL) {
591 dev_err(&pdev->dev, "Cannot reserve memory region at 0x%08lx, "
592 "size: 0x%x\n", c->phys_base, ONENAND_IO_SIZE);
596 c->onenand.base = ioremap(c->phys_base, ONENAND_IO_SIZE);
597 if (c->onenand.base == NULL) {
599 goto err_release_mem_region;
602 if (pdata->onenand_setup != NULL) {
603 r = pdata->onenand_setup(c->onenand.base, c->freq);
605 dev_err(&pdev->dev, "Onenand platform setup failed: "
609 c->setup = pdata->onenand_setup;
613 if ((r = omap_request_gpio(c->gpio_irq)) < 0) {
614 dev_err(&pdev->dev, "Failed to request GPIO%d for "
615 "OneNAND\n", c->gpio_irq);
618 omap_set_gpio_direction(c->gpio_irq, 1);
620 if ((r = request_irq(OMAP_GPIO_IRQ(c->gpio_irq),
621 omap2_onenand_interrupt, IRQF_TRIGGER_RISING,
622 pdev->dev.driver->name, c)) < 0)
623 goto err_release_gpio;
626 if (c->dma_channel >= 0) {
627 r = omap_request_dma(0, pdev->dev.driver->name,
628 omap2_onenand_dma_cb, (void *) c,
631 omap_set_dma_write_mode(c->dma_channel,
632 OMAP_DMA_WRITE_NON_POSTED);
633 omap_set_dma_src_data_pack(c->dma_channel, 1);
634 omap_set_dma_src_burst_mode(c->dma_channel,
635 OMAP_DMA_DATA_BURST_8);
636 omap_set_dma_dest_data_pack(c->dma_channel, 1);
637 omap_set_dma_dest_burst_mode(c->dma_channel,
638 OMAP_DMA_DATA_BURST_8);
641 "failed to allocate DMA for OneNAND, "
642 "using PIO instead\n");
647 dev_info(&pdev->dev, "initializing on CS%d, phys base 0x%08lx, virtual "
648 "base %p\n", c->gpmc_cs, c->phys_base,
652 c->mtd.name = pdev->dev.bus_id;
653 c->mtd.priv = &c->onenand;
654 c->mtd.owner = THIS_MODULE;
656 if (c->dma_channel >= 0) {
657 struct onenand_chip *this = &c->onenand;
659 this->wait = omap2_onenand_wait;
660 if (cpu_is_omap34xx()) {
661 this->read_bufferram = omap3_onenand_read_bufferram;
662 this->write_bufferram = omap3_onenand_write_bufferram;
664 this->read_bufferram = omap2_onenand_read_bufferram;
665 this->write_bufferram = omap2_onenand_write_bufferram;
669 if ((r = onenand_scan(&c->mtd, 1)) < 0)
670 goto err_release_dma;
672 switch ((c->onenand.version_id >> 4) & 0xf) {
687 #ifdef CONFIG_MTD_PARTITIONS
688 if (pdata->parts != NULL)
689 r = add_mtd_partitions(&c->mtd, pdata->parts,
693 r = add_mtd_device(&c->mtd);
695 goto err_release_onenand;
697 platform_set_drvdata(pdev, c);
702 onenand_release(&c->mtd);
704 if (c->dma_channel != -1)
705 omap_free_dma(c->dma_channel);
707 free_irq(OMAP_GPIO_IRQ(c->gpio_irq), c);
710 omap_free_gpio(c->gpio_irq);
712 iounmap(c->onenand.base);
713 err_release_mem_region:
714 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
716 gpmc_cs_free(c->gpmc_cs);
723 static int __devexit omap2_onenand_remove(struct platform_device *pdev)
725 struct omap2_onenand *c = dev_get_drvdata(&pdev->dev);
729 #ifdef CONFIG_MTD_PARTITIONS
731 del_mtd_partitions(&c->mtd);
733 del_mtd_device(&c->mtd);
735 del_mtd_device(&c->mtd);
738 onenand_release(&c->mtd);
739 if (c->dma_channel != -1)
740 omap_free_dma(c->dma_channel);
741 omap2_onenand_shutdown(pdev);
742 platform_set_drvdata(pdev, NULL);
744 free_irq(OMAP_GPIO_IRQ(c->gpio_irq), c);
745 omap_free_gpio(c->gpio_irq);
747 iounmap(c->onenand.base);
748 release_mem_region(c->phys_base, ONENAND_IO_SIZE);
754 static struct platform_driver omap2_onenand_driver = {
755 .probe = omap2_onenand_probe,
756 .remove = omap2_onenand_remove,
757 .shutdown = omap2_onenand_shutdown,
760 .owner = THIS_MODULE,
764 static int __init omap2_onenand_init(void)
766 printk(KERN_INFO "OneNAND driver initializing\n");
767 return platform_driver_register(&omap2_onenand_driver);
770 static void __exit omap2_onenand_exit(void)
772 platform_driver_unregister(&omap2_onenand_driver);
775 module_init(omap2_onenand_init);
776 module_exit(omap2_onenand_exit);
778 MODULE_ALIAS(DRIVER_NAME);
779 MODULE_LICENSE("GPL");
780 MODULE_AUTHOR("Jarkko Lavinen <jarkko.lavinen@nokia.com>");
781 MODULE_DESCRIPTION("Glue layer for OneNAND flash on OMAP2 / OMAP3");