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/err.h>
13 #include <linux/io.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/slab.h>
17 #include <linux/mtd/mtd.h>
18 #include <linux/mtd/nand.h>
19 #include <linux/mtd/partitions.h>
20 
21 struct plat_nand_data {
22 	struct nand_chip	chip;
23 	struct mtd_info		mtd;
24 	void __iomem		*io_base;
25 };
26 
27 /*
28  * Probe for the NAND device.
29  */
plat_nand_probe(struct platform_device * pdev)30 static int plat_nand_probe(struct platform_device *pdev)
31 {
32 	struct platform_nand_data *pdata = dev_get_platdata(&pdev->dev);
33 	struct mtd_part_parser_data ppdata;
34 	struct plat_nand_data *data;
35 	struct resource *res;
36 	const char **part_types;
37 	int err = 0;
38 
39 	if (!pdata) {
40 		dev_err(&pdev->dev, "platform_nand_data is missing\n");
41 		return -EINVAL;
42 	}
43 
44 	if (pdata->chip.nr_chips < 1) {
45 		dev_err(&pdev->dev, "invalid number of chips specified\n");
46 		return -EINVAL;
47 	}
48 
49 	/* Allocate memory for the device structure (and zero it) */
50 	data = devm_kzalloc(&pdev->dev, sizeof(struct plat_nand_data),
51 			    GFP_KERNEL);
52 	if (!data)
53 		return -ENOMEM;
54 
55 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
56 	data->io_base = devm_ioremap_resource(&pdev->dev, res);
57 	if (IS_ERR(data->io_base))
58 		return PTR_ERR(data->io_base);
59 
60 	data->chip.priv = &data;
61 	data->mtd.priv = &data->chip;
62 	data->mtd.dev.parent = &pdev->dev;
63 
64 	data->chip.IO_ADDR_R = data->io_base;
65 	data->chip.IO_ADDR_W = data->io_base;
66 	data->chip.cmd_ctrl = pdata->ctrl.cmd_ctrl;
67 	data->chip.dev_ready = pdata->ctrl.dev_ready;
68 	data->chip.select_chip = pdata->ctrl.select_chip;
69 	data->chip.write_buf = pdata->ctrl.write_buf;
70 	data->chip.read_buf = pdata->ctrl.read_buf;
71 	data->chip.read_byte = pdata->ctrl.read_byte;
72 	data->chip.chip_delay = pdata->chip.chip_delay;
73 	data->chip.options |= pdata->chip.options;
74 	data->chip.bbt_options |= pdata->chip.bbt_options;
75 
76 	data->chip.ecc.hwctl = pdata->ctrl.hwcontrol;
77 	data->chip.ecc.layout = pdata->chip.ecclayout;
78 	data->chip.ecc.mode = NAND_ECC_SOFT;
79 
80 	platform_set_drvdata(pdev, data);
81 
82 	/* Handle any platform specific setup */
83 	if (pdata->ctrl.probe) {
84 		err = pdata->ctrl.probe(pdev);
85 		if (err)
86 			goto out;
87 	}
88 
89 	/* Scan to find existence of the device */
90 	if (nand_scan(&data->mtd, pdata->chip.nr_chips)) {
91 		err = -ENXIO;
92 		goto out;
93 	}
94 
95 	part_types = pdata->chip.part_probe_types;
96 
97 	ppdata.of_node = pdev->dev.of_node;
98 	err = mtd_device_parse_register(&data->mtd, part_types, &ppdata,
99 					pdata->chip.partitions,
100 					pdata->chip.nr_partitions);
101 
102 	if (!err)
103 		return err;
104 
105 	nand_release(&data->mtd);
106 out:
107 	if (pdata->ctrl.remove)
108 		pdata->ctrl.remove(pdev);
109 	return err;
110 }
111 
112 /*
113  * Remove a NAND device.
114  */
plat_nand_remove(struct platform_device * pdev)115 static int plat_nand_remove(struct platform_device *pdev)
116 {
117 	struct plat_nand_data *data = platform_get_drvdata(pdev);
118 	struct platform_nand_data *pdata = dev_get_platdata(&pdev->dev);
119 
120 	nand_release(&data->mtd);
121 	if (pdata->ctrl.remove)
122 		pdata->ctrl.remove(pdev);
123 
124 	return 0;
125 }
126 
127 static const struct of_device_id plat_nand_match[] = {
128 	{ .compatible = "gen_nand" },
129 	{},
130 };
131 MODULE_DEVICE_TABLE(of, plat_nand_match);
132 
133 static struct platform_driver plat_nand_driver = {
134 	.probe	= plat_nand_probe,
135 	.remove	= plat_nand_remove,
136 	.driver	= {
137 		.name		= "gen_nand",
138 		.of_match_table = plat_nand_match,
139 	},
140 };
141 
142 module_platform_driver(plat_nand_driver);
143 
144 MODULE_LICENSE("GPL");
145 MODULE_AUTHOR("Vitaly Wool");
146 MODULE_DESCRIPTION("Simple generic NAND driver");
147 MODULE_ALIAS("platform:gen_nand");
148