2 * Freescale UPM NAND driver.
4 * Copyright © 2007-2008 MontaVista Software, Inc.
6 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/delay.h>
17 #include <linux/mtd/nand.h>
18 #include <linux/mtd/nand_ecc.h>
19 #include <linux/mtd/partitions.h>
20 #include <linux/mtd/mtd.h>
21 #include <linux/of_platform.h>
22 #include <linux/of_gpio.h>
24 #include <linux/slab.h>
25 #include <asm/fsl_lbc.h>
27 #define FSL_UPM_WAIT_RUN_PATTERN 0x1
28 #define FSL_UPM_WAIT_WRITE_BYTE 0x2
29 #define FSL_UPM_WAIT_WRITE_BUFFER 0x4
34 struct nand_chip chip;
36 #ifdef CONFIG_MTD_PARTITIONS
37 struct mtd_partition *parts;
41 uint8_t upm_addr_offset;
42 uint8_t upm_cmd_offset;
43 void __iomem *io_base;
44 int rnb_gpio[NAND_MAX_CHIPS];
45 uint32_t mchip_offsets[NAND_MAX_CHIPS];
47 uint32_t mchip_number;
52 #define to_fsl_upm_nand(mtd) container_of(mtd, struct fsl_upm_nand, mtd)
54 static int fun_chip_ready(struct mtd_info *mtd)
56 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
58 if (gpio_get_value(fun->rnb_gpio[fun->mchip_number]))
61 dev_vdbg(fun->dev, "busy\n");
65 static void fun_wait_rnb(struct fsl_upm_nand *fun)
67 if (fun->rnb_gpio[fun->mchip_number] >= 0) {
70 while (--cnt && !fun_chip_ready(&fun->mtd))
73 dev_err(fun->dev, "tired waiting for RNB\n");
79 static void fun_cmd_ctrl(struct mtd_info *mtd, int cmd, unsigned int ctrl)
81 struct nand_chip *chip = mtd->priv;
82 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
85 if (!(ctrl & fun->last_ctrl)) {
86 fsl_upm_end_pattern(&fun->upm);
88 if (cmd == NAND_CMD_NONE)
91 fun->last_ctrl = ctrl & (NAND_ALE | NAND_CLE);
94 if (ctrl & NAND_CTRL_CHANGE) {
96 fsl_upm_start_pattern(&fun->upm, fun->upm_addr_offset);
97 else if (ctrl & NAND_CLE)
98 fsl_upm_start_pattern(&fun->upm, fun->upm_cmd_offset);
101 mar = (cmd << (32 - fun->upm.width)) |
102 fun->mchip_offsets[fun->mchip_number];
103 fsl_upm_run_pattern(&fun->upm, chip->IO_ADDR_R, mar);
105 if (fun->wait_flags & FSL_UPM_WAIT_RUN_PATTERN)
109 static void fun_select_chip(struct mtd_info *mtd, int mchip_nr)
111 struct nand_chip *chip = mtd->priv;
112 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
114 if (mchip_nr == -1) {
115 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
116 } else if (mchip_nr >= 0 && mchip_nr < NAND_MAX_CHIPS) {
117 fun->mchip_number = mchip_nr;
118 chip->IO_ADDR_R = fun->io_base + fun->mchip_offsets[mchip_nr];
119 chip->IO_ADDR_W = chip->IO_ADDR_R;
125 static uint8_t fun_read_byte(struct mtd_info *mtd)
127 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
129 return in_8(fun->chip.IO_ADDR_R);
132 static void fun_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
134 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
137 for (i = 0; i < len; i++)
138 buf[i] = in_8(fun->chip.IO_ADDR_R);
141 static void fun_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
143 struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd);
146 for (i = 0; i < len; i++) {
147 out_8(fun->chip.IO_ADDR_W, buf[i]);
148 if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BYTE)
151 if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BUFFER)
155 static int __devinit fun_chip_init(struct fsl_upm_nand *fun,
156 const struct device_node *upm_np,
157 const struct resource *io_res)
160 struct device_node *flash_np;
161 #ifdef CONFIG_MTD_PARTITIONS
162 static const char *part_types[] = { "cmdlinepart", NULL, };
165 fun->chip.IO_ADDR_R = fun->io_base;
166 fun->chip.IO_ADDR_W = fun->io_base;
167 fun->chip.cmd_ctrl = fun_cmd_ctrl;
168 fun->chip.chip_delay = fun->chip_delay;
169 fun->chip.read_byte = fun_read_byte;
170 fun->chip.read_buf = fun_read_buf;
171 fun->chip.write_buf = fun_write_buf;
172 fun->chip.ecc.mode = NAND_ECC_SOFT;
173 if (fun->mchip_count > 1)
174 fun->chip.select_chip = fun_select_chip;
176 if (fun->rnb_gpio[0] >= 0)
177 fun->chip.dev_ready = fun_chip_ready;
179 fun->mtd.priv = &fun->chip;
180 fun->mtd.owner = THIS_MODULE;
182 flash_np = of_get_next_child(upm_np, NULL);
186 fun->mtd.name = kasprintf(GFP_KERNEL, "%x.%s", io_res->start,
188 if (!fun->mtd.name) {
193 ret = nand_scan(&fun->mtd, fun->mchip_count);
197 #ifdef CONFIG_MTD_PARTITIONS
198 ret = parse_mtd_partitions(&fun->mtd, part_types, &fun->parts, 0);
200 #ifdef CONFIG_MTD_OF_PARTS
202 ret = of_mtd_parse_partitions(fun->dev, flash_np, &fun->parts);
208 ret = add_mtd_partitions(&fun->mtd, fun->parts, ret);
211 ret = add_mtd_device(&fun->mtd);
213 of_node_put(flash_np);
217 static int __devinit fun_probe(struct of_device *ofdev,
218 const struct of_device_id *ofid)
220 struct fsl_upm_nand *fun;
221 struct resource io_res;
222 const uint32_t *prop;
228 fun = kzalloc(sizeof(*fun), GFP_KERNEL);
232 ret = of_address_to_resource(ofdev->node, 0, &io_res);
234 dev_err(&ofdev->dev, "can't get IO base\n");
238 ret = fsl_upm_find(io_res.start, &fun->upm);
240 dev_err(&ofdev->dev, "can't find UPM\n");
244 prop = of_get_property(ofdev->node, "fsl,upm-addr-offset", &size);
245 if (!prop || size != sizeof(uint32_t)) {
246 dev_err(&ofdev->dev, "can't get UPM address offset\n");
250 fun->upm_addr_offset = *prop;
252 prop = of_get_property(ofdev->node, "fsl,upm-cmd-offset", &size);
253 if (!prop || size != sizeof(uint32_t)) {
254 dev_err(&ofdev->dev, "can't get UPM command offset\n");
258 fun->upm_cmd_offset = *prop;
260 prop = of_get_property(ofdev->node,
261 "fsl,upm-addr-line-cs-offsets", &size);
262 if (prop && (size / sizeof(uint32_t)) > 0) {
263 fun->mchip_count = size / sizeof(uint32_t);
264 if (fun->mchip_count >= NAND_MAX_CHIPS) {
265 dev_err(&ofdev->dev, "too much multiple chips\n");
268 for (i = 0; i < fun->mchip_count; i++)
269 fun->mchip_offsets[i] = prop[i];
271 fun->mchip_count = 1;
274 for (i = 0; i < fun->mchip_count; i++) {
275 fun->rnb_gpio[i] = -1;
276 rnb_gpio = of_get_gpio(ofdev->node, i);
278 ret = gpio_request(rnb_gpio, dev_name(&ofdev->dev));
281 "can't request RNB gpio #%d\n", i);
284 gpio_direction_input(rnb_gpio);
285 fun->rnb_gpio[i] = rnb_gpio;
286 } else if (rnb_gpio == -EINVAL) {
287 dev_err(&ofdev->dev, "RNB gpio #%d is invalid\n", i);
292 prop = of_get_property(ofdev->node, "chip-delay", NULL);
294 fun->chip_delay = *prop;
296 fun->chip_delay = 50;
298 prop = of_get_property(ofdev->node, "fsl,upm-wait-flags", &size);
299 if (prop && size == sizeof(uint32_t))
300 fun->wait_flags = *prop;
302 fun->wait_flags = FSL_UPM_WAIT_RUN_PATTERN |
303 FSL_UPM_WAIT_WRITE_BYTE;
305 fun->io_base = devm_ioremap_nocache(&ofdev->dev, io_res.start,
306 io_res.end - io_res.start + 1);
312 fun->dev = &ofdev->dev;
313 fun->last_ctrl = NAND_CLE;
315 ret = fun_chip_init(fun, ofdev->node, &io_res);
319 dev_set_drvdata(&ofdev->dev, fun);
323 for (i = 0; i < fun->mchip_count; i++) {
324 if (fun->rnb_gpio[i] < 0)
326 gpio_free(fun->rnb_gpio[i]);
334 static int __devexit fun_remove(struct of_device *ofdev)
336 struct fsl_upm_nand *fun = dev_get_drvdata(&ofdev->dev);
339 nand_release(&fun->mtd);
340 kfree(fun->mtd.name);
342 for (i = 0; i < fun->mchip_count; i++) {
343 if (fun->rnb_gpio[i] < 0)
345 gpio_free(fun->rnb_gpio[i]);
353 static struct of_device_id of_fun_match[] = {
354 { .compatible = "fsl,upm-nand" },
357 MODULE_DEVICE_TABLE(of, of_fun_match);
359 static struct of_platform_driver of_fun_driver = {
360 .name = "fsl,upm-nand",
361 .match_table = of_fun_match,
363 .remove = __devexit_p(fun_remove),
366 static int __init fun_module_init(void)
368 return of_register_platform_driver(&of_fun_driver);
370 module_init(fun_module_init);
372 static void __exit fun_module_exit(void)
374 of_unregister_platform_driver(&of_fun_driver);
376 module_exit(fun_module_exit);
378 MODULE_LICENSE("GPL");
379 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
380 MODULE_DESCRIPTION("Driver for NAND chips working through Freescale "
381 "LocalBus User-Programmable Machine");