1/*
  2 * Generic NAND driver
  3 *
  4 * Author: Vitaly Wool <vitalywool@gmail.com>
  5 *
  6 * This program is free software; you can redistribute it and/or modify
  7 * it under the terms of the GNU General Public License version 2 as
  8 * published by the Free Software Foundation.
  9 *
 10 */
 11
 12#include <linux/io.h>
 13#include <linux/module.h>
 14#include <linux/platform_device.h>
 15#include <linux/slab.h>
 16#include <linux/mtd/mtd.h>
 17#include <linux/mtd/nand.h>
 18#include <linux/mtd/partitions.h>
 19
 20struct plat_nand_data {
 21	struct nand_chip	chip;
 22	struct mtd_info		mtd;
 23	void __iomem		*io_base;
 24	int			nr_parts;
 25	struct mtd_partition	*parts;
 26};
 27
 28/*
 29 * Probe for the NAND device.
 30 */
 31static int __devinit plat_nand_probe(struct platform_device *pdev)
 32{
 33	struct platform_nand_data *pdata = pdev->dev.platform_data;
 34	struct plat_nand_data *data;
 35	struct resource *res;
 36	int err = 0;
 37
 38	if (pdata->chip.nr_chips < 1) {
 39		dev_err(&pdev->dev, "invalid number of chips specified\n");
 40		return -EINVAL;
 41	}
 42
 43	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 44	if (!res)
 45		return -ENXIO;
 46
 47	/* Allocate memory for the device structure (and zero it) */
 48	data = kzalloc(sizeof(struct plat_nand_data), GFP_KERNEL);
 49	if (!data) {
 50		dev_err(&pdev->dev, "failed to allocate device structure.\n");
 51		return -ENOMEM;
 52	}
 53
 54	if (!request_mem_region(res->start, resource_size(res),
 55				dev_name(&pdev->dev))) {
 56		dev_err(&pdev->dev, "request_mem_region failed\n");
 57		err = -EBUSY;
 58		goto out_free;
 59	}
 60
 61	data->io_base = ioremap(res->start, resource_size(res));
 62	if (data->io_base == NULL) {
 63		dev_err(&pdev->dev, "ioremap failed\n");
 64		err = -EIO;
 65		goto out_release_io;
 66	}
 67
 68	data->chip.priv = &data;
 69	data->mtd.priv = &data->chip;
 70	data->mtd.owner = THIS_MODULE;
 71	data->mtd.name = dev_name(&pdev->dev);
 72
 73	data->chip.IO_ADDR_R = data->io_base;
 74	data->chip.IO_ADDR_W = data->io_base;
 75	data->chip.cmd_ctrl = pdata->ctrl.cmd_ctrl;
 76	data->chip.dev_ready = pdata->ctrl.dev_ready;
 77	data->chip.select_chip = pdata->ctrl.select_chip;
 78	data->chip.write_buf = pdata->ctrl.write_buf;
 79	data->chip.read_buf = pdata->ctrl.read_buf;
 80	data->chip.chip_delay = pdata->chip.chip_delay;
 81	data->chip.options |= pdata->chip.options;
 82
 83	data->chip.ecc.hwctl = pdata->ctrl.hwcontrol;
 84	data->chip.ecc.layout = pdata->chip.ecclayout;
 85	data->chip.ecc.mode = NAND_ECC_SOFT;
 86
 87	platform_set_drvdata(pdev, data);
 88
 89	/* Handle any platform specific setup */
 90	if (pdata->ctrl.probe) {
 91		err = pdata->ctrl.probe(pdev);
 92		if (err)
 93			goto out;
 94	}
 95
 96	/* Scan to find existence of the device */
 97	if (nand_scan(&data->mtd, pdata->chip.nr_chips)) {
 98		err = -ENXIO;
 99		goto out;
100	}
101
102	if (pdata->chip.part_probe_types) {
103		err = parse_mtd_partitions(&data->mtd,
104					pdata->chip.part_probe_types,
105					&data->parts, 0);
106		if (err > 0) {
107			mtd_device_register(&data->mtd, data->parts, err);
108			return 0;
109		}
110	}
111	if (pdata->chip.set_parts)
112		pdata->chip.set_parts(data->mtd.size, &pdata->chip);
113	if (pdata->chip.partitions) {
114		data->parts = pdata->chip.partitions;
115		err = mtd_device_register(&data->mtd, data->parts,
116			pdata->chip.nr_partitions);
117	} else
118		err = mtd_device_register(&data->mtd, NULL, 0);
119
120	if (!err)
121		return err;
122
123	nand_release(&data->mtd);
124out:
125	if (pdata->ctrl.remove)
126		pdata->ctrl.remove(pdev);
127	platform_set_drvdata(pdev, NULL);
128	iounmap(data->io_base);
129out_release_io:
130	release_mem_region(res->start, resource_size(res));
131out_free:
132	kfree(data);
133	return err;
134}
135
136/*
137 * Remove a NAND device.
138 */
139static int __devexit plat_nand_remove(struct platform_device *pdev)
140{
141	struct plat_nand_data *data = platform_get_drvdata(pdev);
142	struct platform_nand_data *pdata = pdev->dev.platform_data;
143	struct resource *res;
144
145	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
146
147	nand_release(&data->mtd);
148	if (data->parts && data->parts != pdata->chip.partitions)
149		kfree(data->parts);
150	if (pdata->ctrl.remove)
151		pdata->ctrl.remove(pdev);
152	iounmap(data->io_base);
153	release_mem_region(res->start, resource_size(res));
154	kfree(data);
155
156	return 0;
157}
158
159static struct platform_driver plat_nand_driver = {
160	.probe		= plat_nand_probe,
161	.remove		= __devexit_p(plat_nand_remove),
162	.driver		= {
163		.name	= "gen_nand",
164		.owner	= THIS_MODULE,
165	},
166};
167
168static int __init plat_nand_init(void)
169{
170	return platform_driver_register(&plat_nand_driver);
171}
172
173static void __exit plat_nand_exit(void)
174{
175	platform_driver_unregister(&plat_nand_driver);
176}
177
178module_init(plat_nand_init);
179module_exit(plat_nand_exit);
180
181MODULE_LICENSE("GPL");
182MODULE_AUTHOR("Vitaly Wool");
183MODULE_DESCRIPTION("Simple generic NAND driver");
184MODULE_ALIAS("platform:gen_nand");