1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
293db446aSBoris Brezillon /*
393db446aSBoris Brezillon * Generic NAND driver
493db446aSBoris Brezillon *
593db446aSBoris Brezillon * Author: Vitaly Wool <vitalywool@gmail.com>
693db446aSBoris Brezillon */
793db446aSBoris Brezillon
893db446aSBoris Brezillon #include <linux/err.h>
993db446aSBoris Brezillon #include <linux/io.h>
1093db446aSBoris Brezillon #include <linux/module.h>
1193db446aSBoris Brezillon #include <linux/platform_device.h>
1293db446aSBoris Brezillon #include <linux/slab.h>
1393db446aSBoris Brezillon #include <linux/mtd/mtd.h>
14c7921bb3SBoris Brezillon #include <linux/mtd/platnand.h>
1593db446aSBoris Brezillon
1693db446aSBoris Brezillon struct plat_nand_data {
17612e048eSMiquel Raynal struct nand_controller controller;
1893db446aSBoris Brezillon struct nand_chip chip;
1993db446aSBoris Brezillon void __iomem *io_base;
2093db446aSBoris Brezillon };
2193db446aSBoris Brezillon
plat_nand_attach_chip(struct nand_chip * chip)22612e048eSMiquel Raynal static int plat_nand_attach_chip(struct nand_chip *chip)
23612e048eSMiquel Raynal {
24325fd539SMiquel Raynal if (chip->ecc.engine_type == NAND_ECC_ENGINE_TYPE_SOFT &&
25325fd539SMiquel Raynal chip->ecc.algo == NAND_ECC_ALGO_UNKNOWN)
26612e048eSMiquel Raynal chip->ecc.algo = NAND_ECC_ALGO_HAMMING;
27612e048eSMiquel Raynal
28612e048eSMiquel Raynal return 0;
29612e048eSMiquel Raynal }
30612e048eSMiquel Raynal
31612e048eSMiquel Raynal static const struct nand_controller_ops plat_nand_ops = {
32612e048eSMiquel Raynal .attach_chip = plat_nand_attach_chip,
33612e048eSMiquel Raynal };
34612e048eSMiquel Raynal
3593db446aSBoris Brezillon /*
3693db446aSBoris Brezillon * Probe for the NAND device.
3793db446aSBoris Brezillon */
plat_nand_probe(struct platform_device * pdev)3893db446aSBoris Brezillon static int plat_nand_probe(struct platform_device *pdev)
3993db446aSBoris Brezillon {
4093db446aSBoris Brezillon struct platform_nand_data *pdata = dev_get_platdata(&pdev->dev);
4193db446aSBoris Brezillon struct plat_nand_data *data;
4293db446aSBoris Brezillon struct mtd_info *mtd;
4393db446aSBoris Brezillon const char **part_types;
4493db446aSBoris Brezillon int err = 0;
4593db446aSBoris Brezillon
4693db446aSBoris Brezillon if (!pdata) {
4793db446aSBoris Brezillon dev_err(&pdev->dev, "platform_nand_data is missing\n");
4893db446aSBoris Brezillon return -EINVAL;
4993db446aSBoris Brezillon }
5093db446aSBoris Brezillon
5193db446aSBoris Brezillon if (pdata->chip.nr_chips < 1) {
5293db446aSBoris Brezillon dev_err(&pdev->dev, "invalid number of chips specified\n");
5393db446aSBoris Brezillon return -EINVAL;
5493db446aSBoris Brezillon }
5593db446aSBoris Brezillon
5693db446aSBoris Brezillon /* Allocate memory for the device structure (and zero it) */
5793db446aSBoris Brezillon data = devm_kzalloc(&pdev->dev, sizeof(struct plat_nand_data),
5893db446aSBoris Brezillon GFP_KERNEL);
5993db446aSBoris Brezillon if (!data)
6093db446aSBoris Brezillon return -ENOMEM;
6193db446aSBoris Brezillon
62612e048eSMiquel Raynal data->controller.ops = &plat_nand_ops;
63612e048eSMiquel Raynal nand_controller_init(&data->controller);
64612e048eSMiquel Raynal data->chip.controller = &data->controller;
65612e048eSMiquel Raynal
667e256143SCai Huoqing data->io_base = devm_platform_ioremap_resource(pdev, 0);
6793db446aSBoris Brezillon if (IS_ERR(data->io_base))
6893db446aSBoris Brezillon return PTR_ERR(data->io_base);
6993db446aSBoris Brezillon
7093db446aSBoris Brezillon nand_set_flash_node(&data->chip, pdev->dev.of_node);
7193db446aSBoris Brezillon mtd = nand_to_mtd(&data->chip);
7293db446aSBoris Brezillon mtd->dev.parent = &pdev->dev;
7393db446aSBoris Brezillon
7482fc5099SBoris Brezillon data->chip.legacy.IO_ADDR_R = data->io_base;
7582fc5099SBoris Brezillon data->chip.legacy.IO_ADDR_W = data->io_base;
76bf6065c6SBoris Brezillon data->chip.legacy.cmd_ctrl = pdata->ctrl.cmd_ctrl;
778395b753SBoris Brezillon data->chip.legacy.dev_ready = pdata->ctrl.dev_ready;
787d6c37e9SBoris Brezillon data->chip.legacy.select_chip = pdata->ctrl.select_chip;
79716bbbabSBoris Brezillon data->chip.legacy.write_buf = pdata->ctrl.write_buf;
80716bbbabSBoris Brezillon data->chip.legacy.read_buf = pdata->ctrl.read_buf;
813cece3abSBoris Brezillon data->chip.legacy.chip_delay = pdata->chip.chip_delay;
8293db446aSBoris Brezillon data->chip.options |= pdata->chip.options;
8393db446aSBoris Brezillon data->chip.bbt_options |= pdata->chip.bbt_options;
8493db446aSBoris Brezillon
8593db446aSBoris Brezillon platform_set_drvdata(pdev, data);
8693db446aSBoris Brezillon
8793db446aSBoris Brezillon /* Handle any platform specific setup */
8893db446aSBoris Brezillon if (pdata->ctrl.probe) {
8993db446aSBoris Brezillon err = pdata->ctrl.probe(pdev);
9093db446aSBoris Brezillon if (err)
9193db446aSBoris Brezillon goto out;
9293db446aSBoris Brezillon }
9393db446aSBoris Brezillon
94325fd539SMiquel Raynal /*
95325fd539SMiquel Raynal * This driver assumes that the default ECC engine should be TYPE_SOFT.
96325fd539SMiquel Raynal * Set ->engine_type before registering the NAND devices in order to
97325fd539SMiquel Raynal * provide a driver specific default value.
98325fd539SMiquel Raynal */
99325fd539SMiquel Raynal data->chip.ecc.engine_type = NAND_ECC_ENGINE_TYPE_SOFT;
100325fd539SMiquel Raynal
10193db446aSBoris Brezillon /* Scan to find existence of the device */
10200ad378fSBoris Brezillon err = nand_scan(&data->chip, pdata->chip.nr_chips);
10393db446aSBoris Brezillon if (err)
10493db446aSBoris Brezillon goto out;
10593db446aSBoris Brezillon
10693db446aSBoris Brezillon part_types = pdata->chip.part_probe_types;
10793db446aSBoris Brezillon
10893db446aSBoris Brezillon err = mtd_device_parse_register(mtd, part_types, NULL,
10993db446aSBoris Brezillon pdata->chip.partitions,
11093db446aSBoris Brezillon pdata->chip.nr_partitions);
11193db446aSBoris Brezillon
11293db446aSBoris Brezillon if (!err)
11393db446aSBoris Brezillon return err;
11493db446aSBoris Brezillon
1155284024bSMiquel Raynal nand_cleanup(&data->chip);
11693db446aSBoris Brezillon out:
11793db446aSBoris Brezillon if (pdata->ctrl.remove)
11893db446aSBoris Brezillon pdata->ctrl.remove(pdev);
11993db446aSBoris Brezillon return err;
12093db446aSBoris Brezillon }
12193db446aSBoris Brezillon
12293db446aSBoris Brezillon /*
12393db446aSBoris Brezillon * Remove a NAND device.
12493db446aSBoris Brezillon */
plat_nand_remove(struct platform_device * pdev)125*ec185b18SUwe Kleine-König static void plat_nand_remove(struct platform_device *pdev)
12693db446aSBoris Brezillon {
12793db446aSBoris Brezillon struct plat_nand_data *data = platform_get_drvdata(pdev);
12893db446aSBoris Brezillon struct platform_nand_data *pdata = dev_get_platdata(&pdev->dev);
129d1aae005SMiquel Raynal struct nand_chip *chip = &data->chip;
130d1aae005SMiquel Raynal int ret;
13193db446aSBoris Brezillon
132d1aae005SMiquel Raynal ret = mtd_device_unregister(nand_to_mtd(chip));
133d1aae005SMiquel Raynal WARN_ON(ret);
134d1aae005SMiquel Raynal nand_cleanup(chip);
13593db446aSBoris Brezillon if (pdata->ctrl.remove)
13693db446aSBoris Brezillon pdata->ctrl.remove(pdev);
13793db446aSBoris Brezillon }
13893db446aSBoris Brezillon
13993db446aSBoris Brezillon static const struct of_device_id plat_nand_match[] = {
14093db446aSBoris Brezillon { .compatible = "gen_nand" },
14193db446aSBoris Brezillon {},
14293db446aSBoris Brezillon };
14393db446aSBoris Brezillon MODULE_DEVICE_TABLE(of, plat_nand_match);
14493db446aSBoris Brezillon
14593db446aSBoris Brezillon static struct platform_driver plat_nand_driver = {
14693db446aSBoris Brezillon .probe = plat_nand_probe,
147*ec185b18SUwe Kleine-König .remove_new = plat_nand_remove,
14893db446aSBoris Brezillon .driver = {
14993db446aSBoris Brezillon .name = "gen_nand",
15093db446aSBoris Brezillon .of_match_table = plat_nand_match,
15193db446aSBoris Brezillon },
15293db446aSBoris Brezillon };
15393db446aSBoris Brezillon
15493db446aSBoris Brezillon module_platform_driver(plat_nand_driver);
15593db446aSBoris Brezillon
15693db446aSBoris Brezillon MODULE_LICENSE("GPL");
15793db446aSBoris Brezillon MODULE_AUTHOR("Vitaly Wool");
15893db446aSBoris Brezillon MODULE_DESCRIPTION("Simple generic NAND driver");
15993db446aSBoris Brezillon MODULE_ALIAS("platform:gen_nand");
160