2 * NAND flash driver for the MikroTik RouterBoard 4xx series
4 * Copyright (C) 2008-2011 Gabor Juhos <juhosg@openwrt.org>
5 * Copyright (C) 2008 Imre Kaloz <kaloz@openwrt.org>
7 * This file was based on the driver for Linux 2.6.22 published by
8 * MikroTik for their RouterBoard 4xx series devices.
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License version 2 as published
12 * by the Free Software Foundation.
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/mtd/nand.h>
19 #include <linux/mtd/mtd.h>
20 #include <linux/mtd/partitions.h>
21 #include <linux/platform_device.h>
22 #include <linux/delay.h>
24 #include <linux/gpio.h>
25 #include <linux/slab.h>
27 #include <asm/mach-ath79/ath79.h>
28 #include <asm/mach-ath79/rb4xx_cpld.h>
30 #define DRV_NAME "rb4xx-nand"
31 #define DRV_VERSION "0.2.0"
32 #define DRV_DESC "NAND flash driver for RouterBoard 4xx series"
34 #define RB4XX_NAND_GPIO_READY 5
35 #define RB4XX_NAND_GPIO_ALE 37
36 #define RB4XX_NAND_GPIO_CLE 38
37 #define RB4XX_NAND_GPIO_NCE 39
39 struct rb4xx_nand_info {
40 struct nand_chip chip;
45 * We need to use the OLD Yaffs-1 OOB layout, otherwise the RB bootloader
46 * will not be able to find the kernel that we load.
48 static struct nand_ecclayout rb4xx_nand_ecclayout = {
50 .eccpos = { 8, 9, 10, 13, 14, 15 },
52 .oobfree = { { 0, 4 }, { 6, 2 }, { 11, 2 }, { 4, 1 } }
55 static struct mtd_partition rb4xx_nand_partitions[] = {
60 .mask_flags = MTD_WRITEABLE,
64 .offset = (256 * 1024),
65 .size = (4 * 1024 * 1024) - (256 * 1024),
69 .offset = MTDPART_OFS_NXTBLK,
70 .size = MTDPART_SIZ_FULL,
74 static int rb4xx_nand_dev_ready(struct mtd_info *mtd)
76 return gpio_get_value_cansleep(RB4XX_NAND_GPIO_READY);
79 static void rb4xx_nand_write_cmd(unsigned char cmd)
81 unsigned char data = cmd;
84 err = rb4xx_cpld_write(&data, 1);
86 pr_err("rb4xx_nand: write cmd failed, err=%d\n", err);
89 static void rb4xx_nand_cmd_ctrl(struct mtd_info *mtd, int cmd,
92 if (ctrl & NAND_CTRL_CHANGE) {
93 gpio_set_value_cansleep(RB4XX_NAND_GPIO_CLE,
94 (ctrl & NAND_CLE) ? 1 : 0);
95 gpio_set_value_cansleep(RB4XX_NAND_GPIO_ALE,
96 (ctrl & NAND_ALE) ? 1 : 0);
97 gpio_set_value_cansleep(RB4XX_NAND_GPIO_NCE,
98 (ctrl & NAND_NCE) ? 0 : 1);
101 if (cmd != NAND_CMD_NONE)
102 rb4xx_nand_write_cmd(cmd);
105 static unsigned char rb4xx_nand_read_byte(struct mtd_info *mtd)
107 unsigned char data = 0;
110 err = rb4xx_cpld_read(&data, NULL, 1);
112 pr_err("rb4xx_nand: read data failed, err=%d\n", err);
119 static void rb4xx_nand_write_buf(struct mtd_info *mtd, const unsigned char *buf,
124 err = rb4xx_cpld_write(buf, len);
126 pr_err("rb4xx_nand: write buf failed, err=%d\n", err);
129 static void rb4xx_nand_read_buf(struct mtd_info *mtd, unsigned char *buf,
134 err = rb4xx_cpld_read(buf, NULL, len);
136 pr_err("rb4xx_nand: read buf failed, err=%d\n", err);
139 static int __devinit rb4xx_nand_probe(struct platform_device *pdev)
141 struct rb4xx_nand_info *info;
144 printk(KERN_INFO DRV_DESC " version " DRV_VERSION "\n");
146 ret = gpio_request(RB4XX_NAND_GPIO_READY, "NAND RDY");
148 dev_err(&pdev->dev, "unable to request gpio %d\n",
149 RB4XX_NAND_GPIO_READY);
153 ret = gpio_direction_input(RB4XX_NAND_GPIO_READY);
155 dev_err(&pdev->dev, "unable to set input mode on gpio %d\n",
156 RB4XX_NAND_GPIO_READY);
157 goto err_free_gpio_ready;
160 ret = gpio_request(RB4XX_NAND_GPIO_ALE, "NAND ALE");
162 dev_err(&pdev->dev, "unable to request gpio %d\n",
163 RB4XX_NAND_GPIO_ALE);
164 goto err_free_gpio_ready;
167 ret = gpio_direction_output(RB4XX_NAND_GPIO_ALE, 0);
169 dev_err(&pdev->dev, "unable to set output mode on gpio %d\n",
170 RB4XX_NAND_GPIO_ALE);
171 goto err_free_gpio_ale;
174 ret = gpio_request(RB4XX_NAND_GPIO_CLE, "NAND CLE");
176 dev_err(&pdev->dev, "unable to request gpio %d\n",
177 RB4XX_NAND_GPIO_CLE);
178 goto err_free_gpio_ale;
181 ret = gpio_direction_output(RB4XX_NAND_GPIO_CLE, 0);
183 dev_err(&pdev->dev, "unable to set output mode on gpio %d\n",
184 RB4XX_NAND_GPIO_CLE);
185 goto err_free_gpio_cle;
188 ret = gpio_request(RB4XX_NAND_GPIO_NCE, "NAND NCE");
190 dev_err(&pdev->dev, "unable to request gpio %d\n",
191 RB4XX_NAND_GPIO_NCE);
192 goto err_free_gpio_cle;
195 ret = gpio_direction_output(RB4XX_NAND_GPIO_NCE, 1);
197 dev_err(&pdev->dev, "unable to set output mode on gpio %d\n",
198 RB4XX_NAND_GPIO_ALE);
199 goto err_free_gpio_nce;
202 info = kzalloc(sizeof(*info), GFP_KERNEL);
204 dev_err(&pdev->dev, "rb4xx-nand: no memory for private data\n");
206 goto err_free_gpio_nce;
209 info->chip.priv = &info;
210 info->mtd.priv = &info->chip;
211 info->mtd.owner = THIS_MODULE;
213 info->chip.cmd_ctrl = rb4xx_nand_cmd_ctrl;
214 info->chip.dev_ready = rb4xx_nand_dev_ready;
215 info->chip.read_byte = rb4xx_nand_read_byte;
216 info->chip.write_buf = rb4xx_nand_write_buf;
217 info->chip.read_buf = rb4xx_nand_read_buf;
219 info->chip.verify_buf = rb4xx_nand_verify_buf;
222 info->chip.chip_delay = 25;
223 info->chip.ecc.mode = NAND_ECC_SOFT;
225 platform_set_drvdata(pdev, info);
227 ret = nand_scan_ident(&info->mtd, 1, NULL);
233 if (info->mtd.writesize == 512)
234 info->chip.ecc.layout = &rb4xx_nand_ecclayout;
236 ret = nand_scan_tail(&info->mtd);
239 goto err_set_drvdata;
242 mtd_device_register(&info->mtd, rb4xx_nand_partitions,
243 ARRAY_SIZE(rb4xx_nand_partitions));
245 goto err_release_nand;
250 nand_release(&info->mtd);
252 platform_set_drvdata(pdev, NULL);
256 gpio_free(RB4XX_NAND_GPIO_NCE);
258 gpio_free(RB4XX_NAND_GPIO_CLE);
260 gpio_free(RB4XX_NAND_GPIO_ALE);
262 gpio_free(RB4XX_NAND_GPIO_READY);
267 static int __devexit rb4xx_nand_remove(struct platform_device *pdev)
269 struct rb4xx_nand_info *info = platform_get_drvdata(pdev);
271 nand_release(&info->mtd);
272 platform_set_drvdata(pdev, NULL);
274 gpio_free(RB4XX_NAND_GPIO_NCE);
275 gpio_free(RB4XX_NAND_GPIO_CLE);
276 gpio_free(RB4XX_NAND_GPIO_ALE);
277 gpio_free(RB4XX_NAND_GPIO_READY);
282 static struct platform_driver rb4xx_nand_driver = {
283 .probe = rb4xx_nand_probe,
284 .remove = __devexit_p(rb4xx_nand_remove),
287 .owner = THIS_MODULE,
291 static int __init rb4xx_nand_init(void)
293 return platform_driver_register(&rb4xx_nand_driver);
296 static void __exit rb4xx_nand_exit(void)
298 platform_driver_unregister(&rb4xx_nand_driver);
301 module_init(rb4xx_nand_init);
302 module_exit(rb4xx_nand_exit);
304 MODULE_DESCRIPTION(DRV_DESC);
305 MODULE_VERSION(DRV_VERSION);
306 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
307 MODULE_AUTHOR("Imre Kaloz <kaloz@openwrt.org>");
308 MODULE_LICENSE("GPL v2");