Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 1 | /* |
| 2 | * drivers/mtd/nand/orion_nand.c |
| 3 | * |
| 4 | * NAND support for Marvell Orion SoC platforms |
| 5 | * |
| 6 | * Tzachi Perelstein <tzachi@marvell.com> |
| 7 | * |
| 8 | * This file is licensed under the terms of the GNU General Public |
| 9 | * License version 2. This program is licensed "as is" without any |
| 10 | * warranty of any kind, whether express or implied. |
| 11 | */ |
| 12 | |
| 13 | #include <linux/slab.h> |
| 14 | #include <linux/module.h> |
| 15 | #include <linux/platform_device.h> |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 16 | #include <linux/of.h> |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 17 | #include <linux/mtd/mtd.h> |
| 18 | #include <linux/mtd/nand.h> |
| 19 | #include <linux/mtd/partitions.h> |
Andrew Lunn | 9c2bd50 | 2012-02-19 11:01:22 +0100 | [diff] [blame] | 20 | #include <linux/clk.h> |
| 21 | #include <linux/err.h> |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 22 | #include <linux/io.h> |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 23 | #include <asm/sizes.h> |
Arnd Bergmann | c02cecb | 2012-08-24 15:21:54 +0200 | [diff] [blame] | 24 | #include <linux/platform_data/mtd-orion_nand.h> |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 25 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 26 | static void orion_nand_cmd_ctrl(struct mtd_info *mtd, int cmd, unsigned int ctrl) |
| 27 | { |
Boris BREZILLON | 4bd4ebc | 2015-12-01 12:03:04 +0100 | [diff] [blame] | 28 | struct nand_chip *nc = mtd_to_nand(mtd); |
Boris BREZILLON | d699ed2 | 2015-12-10 09:00:41 +0100 | [diff] [blame] | 29 | struct orion_nand_data *board = nand_get_controller_data(nc); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 30 | u32 offs; |
| 31 | |
| 32 | if (cmd == NAND_CMD_NONE) |
| 33 | return; |
| 34 | |
| 35 | if (ctrl & NAND_CLE) |
| 36 | offs = (1 << board->cle); |
| 37 | else if (ctrl & NAND_ALE) |
| 38 | offs = (1 << board->ale); |
| 39 | else |
| 40 | return; |
| 41 | |
| 42 | if (nc->options & NAND_BUSWIDTH_16) |
| 43 | offs <<= 1; |
| 44 | |
| 45 | writeb(cmd, nc->IO_ADDR_W + offs); |
| 46 | } |
| 47 | |
Nicolas Pitre | bfee1a4 | 2009-05-31 22:25:40 -0400 | [diff] [blame] | 48 | static void orion_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len) |
| 49 | { |
Boris BREZILLON | 4bd4ebc | 2015-12-01 12:03:04 +0100 | [diff] [blame] | 50 | struct nand_chip *chip = mtd_to_nand(mtd); |
Nicolas Pitre | bfee1a4 | 2009-05-31 22:25:40 -0400 | [diff] [blame] | 51 | void __iomem *io_base = chip->IO_ADDR_R; |
| 52 | uint64_t *buf64; |
| 53 | int i = 0; |
| 54 | |
| 55 | while (len && (unsigned long)buf & 7) { |
| 56 | *buf++ = readb(io_base); |
| 57 | len--; |
| 58 | } |
| 59 | buf64 = (uint64_t *)buf; |
| 60 | while (i < len/8) { |
Paulius Zaleckas | a88a2b8 | 2010-04-23 13:17:47 -0400 | [diff] [blame] | 61 | /* |
| 62 | * Since GCC has no proper constraint (PR 43518) |
| 63 | * force x variable to r2/r3 registers as ldrd instruction |
| 64 | * requires first register to be even. |
| 65 | */ |
| 66 | register uint64_t x asm ("r2"); |
| 67 | |
Simon Kagstrom | 94da210 | 2009-08-20 09:19:53 +0200 | [diff] [blame] | 68 | asm volatile ("ldrd\t%0, [%1]" : "=&r" (x) : "r" (io_base)); |
Nicolas Pitre | bfee1a4 | 2009-05-31 22:25:40 -0400 | [diff] [blame] | 69 | buf64[i++] = x; |
| 70 | } |
| 71 | i *= 8; |
| 72 | while (i < len) |
| 73 | buf[i++] = readb(io_base); |
| 74 | } |
| 75 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 76 | static int __init orion_nand_probe(struct platform_device *pdev) |
| 77 | { |
| 78 | struct mtd_info *mtd; |
| 79 | struct nand_chip *nc; |
| 80 | struct orion_nand_data *board; |
H Hartley Sweeten | e990306 | 2009-12-14 16:48:34 -0500 | [diff] [blame] | 81 | struct resource *res; |
Andrew Lunn | 9c2bd50 | 2012-02-19 11:01:22 +0100 | [diff] [blame] | 82 | struct clk *clk; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 83 | void __iomem *io_base; |
| 84 | int ret = 0; |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 85 | u32 val = 0; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 86 | |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 87 | nc = devm_kzalloc(&pdev->dev, |
Boris BREZILLON | 53cd268 | 2015-12-10 09:00:17 +0100 | [diff] [blame] | 88 | sizeof(struct nand_chip), |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 89 | GFP_KERNEL); |
| 90 | if (!nc) |
| 91 | return -ENOMEM; |
Boris BREZILLON | 53cd268 | 2015-12-10 09:00:17 +0100 | [diff] [blame] | 92 | mtd = nand_to_mtd(nc); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 93 | |
H Hartley Sweeten | e990306 | 2009-12-14 16:48:34 -0500 | [diff] [blame] | 94 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 95 | io_base = devm_ioremap_resource(&pdev->dev, res); |
H Hartley Sweeten | e990306 | 2009-12-14 16:48:34 -0500 | [diff] [blame] | 96 | |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 97 | if (IS_ERR(io_base)) |
| 98 | return PTR_ERR(io_base); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 99 | |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 100 | if (pdev->dev.of_node) { |
| 101 | board = devm_kzalloc(&pdev->dev, sizeof(struct orion_nand_data), |
| 102 | GFP_KERNEL); |
Michael Opdenacker | a0fa0b6 | 2014-10-16 06:58:35 +0200 | [diff] [blame] | 103 | if (!board) |
| 104 | return -ENOMEM; |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 105 | if (!of_property_read_u32(pdev->dev.of_node, "cle", &val)) |
| 106 | board->cle = (u8)val; |
| 107 | else |
| 108 | board->cle = 0; |
| 109 | if (!of_property_read_u32(pdev->dev.of_node, "ale", &val)) |
| 110 | board->ale = (u8)val; |
| 111 | else |
| 112 | board->ale = 1; |
| 113 | if (!of_property_read_u32(pdev->dev.of_node, |
| 114 | "bank-width", &val)) |
| 115 | board->width = (u8)val * 8; |
| 116 | else |
| 117 | board->width = 8; |
| 118 | if (!of_property_read_u32(pdev->dev.of_node, |
| 119 | "chip-delay", &val)) |
| 120 | board->chip_delay = (u8)val; |
Jingoo Han | 453810b | 2013-07-30 17:18:33 +0900 | [diff] [blame] | 121 | } else { |
| 122 | board = dev_get_platdata(&pdev->dev); |
| 123 | } |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 124 | |
Frans Klaver | 8463099 | 2015-06-10 22:38:58 +0200 | [diff] [blame] | 125 | mtd->dev.parent = &pdev->dev; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 126 | |
Boris BREZILLON | d699ed2 | 2015-12-10 09:00:41 +0100 | [diff] [blame] | 127 | nand_set_controller_data(nc, board); |
Brian Norris | a61ae81 | 2015-10-30 20:33:25 -0700 | [diff] [blame] | 128 | nand_set_flash_node(nc, pdev->dev.of_node); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 129 | nc->IO_ADDR_R = nc->IO_ADDR_W = io_base; |
| 130 | nc->cmd_ctrl = orion_nand_cmd_ctrl; |
Nicolas Pitre | bfee1a4 | 2009-05-31 22:25:40 -0400 | [diff] [blame] | 131 | nc->read_buf = orion_nand_read_buf; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 132 | nc->ecc.mode = NAND_ECC_SOFT; |
Rafał Miłecki | ac7efcb | 2016-04-08 12:23:48 +0200 | [diff] [blame] | 133 | nc->ecc.algo = NAND_ECC_HAMMING; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 134 | |
Saeed Bishara | f4db56f | 2008-05-04 19:25:52 -1100 | [diff] [blame] | 135 | if (board->chip_delay) |
| 136 | nc->chip_delay = board->chip_delay; |
| 137 | |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 138 | WARN(board->width > 16, |
| 139 | "%d bit bus width out of range", |
| 140 | board->width); |
| 141 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 142 | if (board->width == 16) |
| 143 | nc->options |= NAND_BUSWIDTH_16; |
| 144 | |
Ben Dooks | eedfea2 | 2010-04-20 10:26:18 +0100 | [diff] [blame] | 145 | if (board->dev_ready) |
| 146 | nc->dev_ready = board->dev_ready; |
| 147 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 148 | platform_set_drvdata(pdev, mtd); |
| 149 | |
Andrew Lunn | 9c2bd50 | 2012-02-19 11:01:22 +0100 | [diff] [blame] | 150 | /* Not all platforms can gate the clock, so it is not |
| 151 | an error if the clock does not exists. */ |
| 152 | clk = clk_get(&pdev->dev, NULL); |
| 153 | if (!IS_ERR(clk)) { |
| 154 | clk_prepare_enable(clk); |
| 155 | clk_put(clk); |
| 156 | } |
| 157 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 158 | if (nand_scan(mtd, 1)) { |
| 159 | ret = -ENXIO; |
| 160 | goto no_dev; |
| 161 | } |
| 162 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 163 | mtd->name = "orion_nand"; |
Brian Norris | a61ae81 | 2015-10-30 20:33:25 -0700 | [diff] [blame] | 164 | ret = mtd_device_register(mtd, board->parts, board->nr_parts); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 165 | if (ret) { |
| 166 | nand_release(mtd); |
| 167 | goto no_dev; |
| 168 | } |
| 169 | |
| 170 | return 0; |
| 171 | |
| 172 | no_dev: |
Simon Baatz | baffab2 | 2012-07-19 00:04:09 +0200 | [diff] [blame] | 173 | if (!IS_ERR(clk)) { |
| 174 | clk_disable_unprepare(clk); |
| 175 | clk_put(clk); |
| 176 | } |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 177 | |
| 178 | return ret; |
| 179 | } |
| 180 | |
Bill Pemberton | 810b7e0 | 2012-11-19 13:26:04 -0500 | [diff] [blame] | 181 | static int orion_nand_remove(struct platform_device *pdev) |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 182 | { |
| 183 | struct mtd_info *mtd = platform_get_drvdata(pdev); |
Andrew Lunn | 9c2bd50 | 2012-02-19 11:01:22 +0100 | [diff] [blame] | 184 | struct clk *clk; |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 185 | |
| 186 | nand_release(mtd); |
| 187 | |
Andrew Lunn | 9c2bd50 | 2012-02-19 11:01:22 +0100 | [diff] [blame] | 188 | clk = clk_get(&pdev->dev, NULL); |
| 189 | if (!IS_ERR(clk)) { |
| 190 | clk_disable_unprepare(clk); |
| 191 | clk_put(clk); |
| 192 | } |
| 193 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 194 | return 0; |
| 195 | } |
| 196 | |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 197 | #ifdef CONFIG_OF |
Jingoo Han | cb3346a | 2014-05-07 17:50:23 +0900 | [diff] [blame] | 198 | static const struct of_device_id orion_nand_of_match_table[] = { |
Andrew Lunn | 7784350 | 2012-07-18 19:22:54 +0200 | [diff] [blame] | 199 | { .compatible = "marvell,orion-nand", }, |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 200 | {}, |
| 201 | }; |
Luis de Bethencourt | 98d1a5e | 2015-09-18 00:14:02 +0200 | [diff] [blame] | 202 | MODULE_DEVICE_TABLE(of, orion_nand_of_match_table); |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 203 | #endif |
| 204 | |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 205 | static struct platform_driver orion_nand_driver = { |
Bill Pemberton | 5153b88 | 2012-11-19 13:21:24 -0500 | [diff] [blame] | 206 | .remove = orion_nand_remove, |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 207 | .driver = { |
| 208 | .name = "orion_nand", |
Jamie Lentin | a0fabf72 | 2012-04-18 11:06:41 +0100 | [diff] [blame] | 209 | .of_match_table = of_match_ptr(orion_nand_of_match_table), |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 210 | }, |
| 211 | }; |
| 212 | |
Jingoo Han | d9ba310 | 2013-03-05 13:29:20 +0900 | [diff] [blame] | 213 | module_platform_driver_probe(orion_nand_driver, orion_nand_probe); |
Tzachi Perelstein | 2a1dba2 | 2007-10-17 01:10:40 +0200 | [diff] [blame] | 214 | |
| 215 | MODULE_LICENSE("GPL"); |
| 216 | MODULE_AUTHOR("Tzachi Perelstein"); |
| 217 | MODULE_DESCRIPTION("NAND glue for Orion platforms"); |
Kay Sievers | 1ff1842 | 2008-04-18 13:44:27 -0700 | [diff] [blame] | 218 | MODULE_ALIAS("platform:orion_nand"); |