Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 1 | /* |
| 2 | * drivers/mtd/ndfc.c |
| 3 | * |
| 4 | * Overview: |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 5 | * Platform independent driver for NDFC (NanD Flash Controller) |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 6 | * integrated into EP440 cores |
| 7 | * |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 8 | * Ported to an OF platform driver by Sean MacLennan |
| 9 | * |
| 10 | * The NDFC supports multiple chips, but this driver only supports a |
| 11 | * single chip since I do not have access to any boards with |
| 12 | * multiple chips. |
| 13 | * |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 14 | * Author: Thomas Gleixner |
| 15 | * |
| 16 | * Copyright 2006 IBM |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 17 | * Copyright 2008 PIKA Technologies |
| 18 | * Sean MacLennan <smaclennan@pikatech.com> |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 19 | * |
| 20 | * This program is free software; you can redistribute it and/or modify it |
| 21 | * under the terms of the GNU General Public License as published by the |
| 22 | * Free Software Foundation; either version 2 of the License, or (at your |
| 23 | * option) any later version. |
| 24 | * |
| 25 | */ |
| 26 | #include <linux/module.h> |
| 27 | #include <linux/mtd/nand.h> |
| 28 | #include <linux/mtd/nand_ecc.h> |
| 29 | #include <linux/mtd/partitions.h> |
| 30 | #include <linux/mtd/ndfc.h> |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 31 | #include <linux/mtd/mtd.h> |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 32 | #include <linux/of_platform.h> |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 33 | #include <asm/io.h> |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 34 | |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 35 | |
| 36 | struct ndfc_controller { |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 37 | struct of_device *ofdev; |
| 38 | void __iomem *ndfcbase; |
| 39 | struct mtd_info mtd; |
| 40 | struct nand_chip chip; |
| 41 | int chip_select; |
| 42 | struct nand_hw_control ndfc_control; |
| 43 | #ifdef CONFIG_MTD_PARTITIONS |
| 44 | struct mtd_partition *parts; |
| 45 | #endif |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 46 | }; |
| 47 | |
| 48 | static struct ndfc_controller ndfc_ctrl; |
| 49 | |
| 50 | static void ndfc_select_chip(struct mtd_info *mtd, int chip) |
| 51 | { |
| 52 | uint32_t ccr; |
| 53 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 54 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 55 | ccr = in_be32(ndfc->ndfcbase + NDFC_CCR); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 56 | if (chip >= 0) { |
| 57 | ccr &= ~NDFC_CCR_BS_MASK; |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 58 | ccr |= NDFC_CCR_BS(chip + ndfc->chip_select); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 59 | } else |
| 60 | ccr |= NDFC_CCR_RESET_CE; |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 61 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 62 | } |
| 63 | |
Thomas Gleixner | 7abd3ef | 2006-05-23 23:25:53 +0200 | [diff] [blame] | 64 | static void ndfc_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl) |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 65 | { |
Thomas Gleixner | 1794c13 | 2006-06-22 13:06:43 +0200 | [diff] [blame] | 66 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 67 | |
Thomas Gleixner | 7abd3ef | 2006-05-23 23:25:53 +0200 | [diff] [blame] | 68 | if (cmd == NAND_CMD_NONE) |
| 69 | return; |
| 70 | |
| 71 | if (ctrl & NAND_CLE) |
Thomas Gleixner | 1794c13 | 2006-06-22 13:06:43 +0200 | [diff] [blame] | 72 | writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_CMD); |
Thomas Gleixner | 7abd3ef | 2006-05-23 23:25:53 +0200 | [diff] [blame] | 73 | else |
Thomas Gleixner | 1794c13 | 2006-06-22 13:06:43 +0200 | [diff] [blame] | 74 | writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_ALE); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | static int ndfc_ready(struct mtd_info *mtd) |
| 78 | { |
| 79 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 80 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 81 | return in_be32(ndfc->ndfcbase + NDFC_STAT) & NDFC_STAT_IS_READY; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | static void ndfc_enable_hwecc(struct mtd_info *mtd, int mode) |
| 85 | { |
| 86 | uint32_t ccr; |
| 87 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 88 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 89 | ccr = in_be32(ndfc->ndfcbase + NDFC_CCR); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 90 | ccr |= NDFC_CCR_RESET_ECC; |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 91 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 92 | wmb(); |
| 93 | } |
| 94 | |
| 95 | static int ndfc_calculate_ecc(struct mtd_info *mtd, |
| 96 | const u_char *dat, u_char *ecc_code) |
| 97 | { |
| 98 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 99 | uint32_t ecc; |
| 100 | uint8_t *p = (uint8_t *)&ecc; |
| 101 | |
| 102 | wmb(); |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 103 | ecc = in_be32(ndfc->ndfcbase + NDFC_ECC); |
| 104 | /* The NDFC uses Smart Media (SMC) bytes order */ |
| 105 | ecc_code[0] = p[2]; |
| 106 | ecc_code[1] = p[1]; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 107 | ecc_code[2] = p[3]; |
| 108 | |
| 109 | return 0; |
| 110 | } |
| 111 | |
| 112 | /* |
| 113 | * Speedups for buffer read/write/verify |
| 114 | * |
| 115 | * NDFC allows 32bit read/write of data. So we can speed up the buffer |
| 116 | * functions. No further checking, as nand_base will always read/write |
| 117 | * page aligned. |
| 118 | */ |
| 119 | static void ndfc_read_buf(struct mtd_info *mtd, uint8_t *buf, int len) |
| 120 | { |
| 121 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 122 | uint32_t *p = (uint32_t *) buf; |
| 123 | |
| 124 | for(;len > 0; len -= 4) |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 125 | *p++ = in_be32(ndfc->ndfcbase + NDFC_DATA); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | static void ndfc_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len) |
| 129 | { |
| 130 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 131 | uint32_t *p = (uint32_t *) buf; |
| 132 | |
| 133 | for(;len > 0; len -= 4) |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 134 | out_be32(ndfc->ndfcbase + NDFC_DATA, *p++); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | static int ndfc_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len) |
| 138 | { |
| 139 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 140 | uint32_t *p = (uint32_t *) buf; |
| 141 | |
| 142 | for(;len > 0; len -= 4) |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 143 | if (*p++ != in_be32(ndfc->ndfcbase + NDFC_DATA)) |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 144 | return -EFAULT; |
| 145 | return 0; |
| 146 | } |
| 147 | |
| 148 | /* |
| 149 | * Initialize chip structure |
| 150 | */ |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 151 | static int ndfc_chip_init(struct ndfc_controller *ndfc, |
| 152 | struct device_node *node) |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 153 | { |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 154 | #ifdef CONFIG_MTD_PARTITIONS |
| 155 | #ifdef CONFIG_MTD_CMDLINE_PARTS |
| 156 | static const char *part_types[] = { "cmdlinepart", NULL }; |
| 157 | #else |
| 158 | static const char *part_types[] = { NULL }; |
| 159 | #endif |
| 160 | #endif |
| 161 | struct device_node *flash_np; |
| 162 | struct nand_chip *chip = &ndfc->chip; |
| 163 | int ret; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 164 | |
| 165 | chip->IO_ADDR_R = ndfc->ndfcbase + NDFC_DATA; |
| 166 | chip->IO_ADDR_W = ndfc->ndfcbase + NDFC_DATA; |
Thomas Gleixner | 7abd3ef | 2006-05-23 23:25:53 +0200 | [diff] [blame] | 167 | chip->cmd_ctrl = ndfc_hwcontrol; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 168 | chip->dev_ready = ndfc_ready; |
| 169 | chip->select_chip = ndfc_select_chip; |
| 170 | chip->chip_delay = 50; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 171 | chip->controller = &ndfc->ndfc_control; |
| 172 | chip->read_buf = ndfc_read_buf; |
| 173 | chip->write_buf = ndfc_write_buf; |
| 174 | chip->verify_buf = ndfc_verify_buf; |
Thomas Gleixner | 6dfc6d2 | 2006-05-23 12:00:46 +0200 | [diff] [blame] | 175 | chip->ecc.correct = nand_correct_data; |
| 176 | chip->ecc.hwctl = ndfc_enable_hwecc; |
| 177 | chip->ecc.calculate = ndfc_calculate_ecc; |
| 178 | chip->ecc.mode = NAND_ECC_HW; |
| 179 | chip->ecc.size = 256; |
| 180 | chip->ecc.bytes = 3; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 181 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 182 | ndfc->mtd.priv = chip; |
| 183 | ndfc->mtd.owner = THIS_MODULE; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 184 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 185 | flash_np = of_get_next_child(node, NULL); |
| 186 | if (!flash_np) |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 187 | return -ENODEV; |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 188 | |
| 189 | ndfc->mtd.name = kasprintf(GFP_KERNEL, "%s.%s", |
Kay Sievers | c36f1e3 | 2009-03-24 16:38:21 -0700 | [diff] [blame] | 190 | dev_name(&ndfc->ofdev->dev), flash_np->name); |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 191 | if (!ndfc->mtd.name) { |
| 192 | ret = -ENOMEM; |
| 193 | goto err; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 194 | } |
| 195 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 196 | ret = nand_scan(&ndfc->mtd, 1); |
| 197 | if (ret) |
| 198 | goto err; |
| 199 | |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 200 | #ifdef CONFIG_MTD_PARTITIONS |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 201 | ret = parse_mtd_partitions(&ndfc->mtd, part_types, &ndfc->parts, 0); |
| 202 | if (ret < 0) |
| 203 | goto err; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 204 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 205 | #ifdef CONFIG_MTD_OF_PARTS |
| 206 | if (ret == 0) { |
| 207 | ret = of_mtd_parse_partitions(&ndfc->ofdev->dev, flash_np, |
| 208 | &ndfc->parts); |
| 209 | if (ret < 0) |
| 210 | goto err; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 211 | } |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 212 | #endif |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 213 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 214 | if (ret > 0) |
| 215 | ret = add_mtd_partitions(&ndfc->mtd, ndfc->parts, ret); |
| 216 | else |
| 217 | #endif |
| 218 | ret = add_mtd_device(&ndfc->mtd); |
| 219 | |
| 220 | err: |
| 221 | of_node_put(flash_np); |
| 222 | if (ret) |
| 223 | kfree(ndfc->mtd.name); |
| 224 | return ret; |
| 225 | } |
| 226 | |
| 227 | static int __devinit ndfc_probe(struct of_device *ofdev, |
| 228 | const struct of_device_id *match) |
| 229 | { |
| 230 | struct ndfc_controller *ndfc = &ndfc_ctrl; |
| 231 | const u32 *reg; |
| 232 | u32 ccr; |
| 233 | int err, len; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 234 | |
| 235 | spin_lock_init(&ndfc->ndfc_control.lock); |
| 236 | init_waitqueue_head(&ndfc->ndfc_control.wq); |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 237 | ndfc->ofdev = ofdev; |
| 238 | dev_set_drvdata(&ofdev->dev, ndfc); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 239 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 240 | /* Read the reg property to get the chip select */ |
| 241 | reg = of_get_property(ofdev->node, "reg", &len); |
| 242 | if (reg == NULL || len != 12) { |
| 243 | dev_err(&ofdev->dev, "unable read reg property (%d)\n", len); |
| 244 | return -ENOENT; |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 245 | } |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 246 | ndfc->chip_select = reg[0]; |
| 247 | |
| 248 | ndfc->ndfcbase = of_iomap(ofdev->node, 0); |
| 249 | if (!ndfc->ndfcbase) { |
| 250 | dev_err(&ofdev->dev, "failed to get memory\n"); |
| 251 | return -EIO; |
| 252 | } |
| 253 | |
| 254 | ccr = NDFC_CCR_BS(ndfc->chip_select); |
| 255 | |
| 256 | /* It is ok if ccr does not exist - just default to 0 */ |
| 257 | reg = of_get_property(ofdev->node, "ccr", NULL); |
| 258 | if (reg) |
| 259 | ccr |= *reg; |
| 260 | |
| 261 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
| 262 | |
| 263 | /* Set the bank settings if given */ |
| 264 | reg = of_get_property(ofdev->node, "bank-settings", NULL); |
| 265 | if (reg) { |
| 266 | int offset = NDFC_BCFG0 + (ndfc->chip_select << 2); |
| 267 | out_be32(ndfc->ndfcbase + offset, *reg); |
| 268 | } |
| 269 | |
| 270 | err = ndfc_chip_init(ndfc, ofdev->node); |
| 271 | if (err) { |
| 272 | iounmap(ndfc->ndfcbase); |
| 273 | return err; |
| 274 | } |
| 275 | |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 276 | return 0; |
| 277 | } |
| 278 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 279 | static int __devexit ndfc_remove(struct of_device *ofdev) |
| 280 | { |
| 281 | struct ndfc_controller *ndfc = dev_get_drvdata(&ofdev->dev); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 282 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 283 | nand_release(&ndfc->mtd); |
| 284 | |
| 285 | return 0; |
| 286 | } |
| 287 | |
| 288 | static const struct of_device_id ndfc_match[] = { |
| 289 | { .compatible = "ibm,ndfc", }, |
| 290 | {} |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 291 | }; |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 292 | MODULE_DEVICE_TABLE(of, ndfc_match); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 293 | |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 294 | static struct of_platform_driver ndfc_driver = { |
| 295 | .driver = { |
| 296 | .name = "ndfc", |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 297 | }, |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 298 | .match_table = ndfc_match, |
| 299 | .probe = ndfc_probe, |
| 300 | .remove = __devexit_p(ndfc_remove), |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 301 | }; |
| 302 | |
| 303 | static int __init ndfc_nand_init(void) |
| 304 | { |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 305 | return of_register_platform_driver(&ndfc_driver); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | static void __exit ndfc_nand_exit(void) |
| 309 | { |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 310 | of_unregister_platform_driver(&ndfc_driver); |
Thomas Gleixner | ce4c61f | 2006-05-23 11:43:28 +0200 | [diff] [blame] | 311 | } |
| 312 | |
| 313 | module_init(ndfc_nand_init); |
| 314 | module_exit(ndfc_nand_exit); |
| 315 | |
| 316 | MODULE_LICENSE("GPL"); |
| 317 | MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>"); |
Sean MacLennan | a808ad3 | 2008-12-10 13:16:34 +0000 | [diff] [blame] | 318 | MODULE_DESCRIPTION("OF Platform driver for NDFC"); |