2 * drivers/mtd/nand/sharpsl.c
4 * Copyright (C) 2004 Richard Purdie
5 * Copyright (C) 2008 Dmitry Baryshkov
7 * Based on Sharp's NAND driver sharp_sl.c
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include <linux/genhd.h>
16 #include <linux/slab.h>
17 #include <linux/module.h>
18 #include <linux/delay.h>
19 #include <linux/mtd/mtd.h>
20 #include <linux/mtd/nand.h>
21 #include <linux/mtd/nand_ecc.h>
22 #include <linux/mtd/partitions.h>
23 #include <linux/mtd/sharpsl.h>
24 #include <linux/interrupt.h>
25 #include <linux/platform_device.h>
28 #include <mach/hardware.h>
29 #include <asm/mach-types.h>
33 struct nand_chip chip;
38 #define mtd_to_sharpsl(_mtd) container_of(_mtd, struct sharpsl_nand, mtd)
41 #define ECCLPLB 0x00 /* line parity 7 - 0 bit */
42 #define ECCLPUB 0x04 /* line parity 15 - 8 bit */
43 #define ECCCP 0x08 /* column parity 5 - 0 bit */
44 #define ECCCNTR 0x0C /* ECC byte counter */
45 #define ECCCLRR 0x10 /* cleare ECC */
46 #define FLASHIO 0x14 /* Flash I/O */
47 #define FLASHCTL 0x18 /* Flash Control */
49 /* Flash control bit */
50 #define FLRYBY (1 << 5)
51 #define FLCE1 (1 << 4)
53 #define FLALE (1 << 2)
54 #define FLCLE (1 << 1)
55 #define FLCE0 (1 << 0)
58 * hardware specific access to control-lines
60 * NAND_CNE: bit 0 -> ! bit 0 & 4
61 * NAND_CLE: bit 1 -> bit 1
62 * NAND_ALE: bit 2 -> bit 2
65 static void sharpsl_nand_hwcontrol(struct mtd_info *mtd, int cmd,
68 struct sharpsl_nand *sharpsl = mtd_to_sharpsl(mtd);
69 struct nand_chip *chip = mtd->priv;
71 if (ctrl & NAND_CTRL_CHANGE) {
72 unsigned char bits = ctrl & 0x07;
74 bits |= (ctrl & 0x01) << 4;
78 writeb((readb(sharpsl->io + FLASHCTL) & ~0x17) | bits, sharpsl->io + FLASHCTL);
81 if (cmd != NAND_CMD_NONE)
82 writeb(cmd, chip->IO_ADDR_W);
85 static int sharpsl_nand_dev_ready(struct mtd_info *mtd)
87 struct sharpsl_nand *sharpsl = mtd_to_sharpsl(mtd);
88 return !((readb(sharpsl->io + FLASHCTL) & FLRYBY) == 0);
91 static void sharpsl_nand_enable_hwecc(struct mtd_info *mtd, int mode)
93 struct sharpsl_nand *sharpsl = mtd_to_sharpsl(mtd);
94 writeb(0, sharpsl->io + ECCCLRR);
97 static int sharpsl_nand_calculate_ecc(struct mtd_info *mtd, const u_char * dat, u_char * ecc_code)
99 struct sharpsl_nand *sharpsl = mtd_to_sharpsl(mtd);
100 ecc_code[0] = ~readb(sharpsl->io + ECCLPUB);
101 ecc_code[1] = ~readb(sharpsl->io + ECCLPLB);
102 ecc_code[2] = (~readb(sharpsl->io + ECCCP) << 2) | 0x03;
103 return readb(sharpsl->io + ECCCNTR) != 0;
106 #ifdef CONFIG_MTD_PARTITIONS
107 static const char *part_probes[] = { "cmdlinepart", NULL };
111 * Main initialization routine
113 static int __devinit sharpsl_nand_probe(struct platform_device *pdev)
115 struct nand_chip *this;
116 #ifdef CONFIG_MTD_PARTITIONS
117 struct mtd_partition *sharpsl_partition_info;
122 struct sharpsl_nand *sharpsl;
123 struct sharpsl_nand_platform_data *data = pdev->dev.platform_data;
126 dev_err(&pdev->dev, "no platform data!\n");
130 /* Allocate memory for MTD device structure and private data */
131 sharpsl = kzalloc(sizeof(struct sharpsl_nand), GFP_KERNEL);
133 printk("Unable to allocate SharpSL NAND MTD device structure.\n");
137 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
139 dev_err(&pdev->dev, "no io memory resource defined!\n");
144 /* map physical address */
145 sharpsl->io = ioremap(r->start, resource_size(r));
147 printk("ioremap to access Sharp SL NAND chip failed\n");
152 /* Get pointer to private data */
153 this = (struct nand_chip *)(&sharpsl->chip);
155 /* Link the private data with the MTD structure */
156 sharpsl->mtd.priv = this;
157 sharpsl->mtd.owner = THIS_MODULE;
159 platform_set_drvdata(pdev, sharpsl);
164 writeb(readb(sharpsl->io + FLASHCTL) | FLWP, sharpsl->io + FLASHCTL);
166 /* Set address of NAND IO lines */
167 this->IO_ADDR_R = sharpsl->io + FLASHIO;
168 this->IO_ADDR_W = sharpsl->io + FLASHIO;
169 /* Set address of hardware control function */
170 this->cmd_ctrl = sharpsl_nand_hwcontrol;
171 this->dev_ready = sharpsl_nand_dev_ready;
172 /* 15 us command delay time */
173 this->chip_delay = 15;
174 /* set eccmode using hardware ECC */
175 this->ecc.mode = NAND_ECC_HW;
176 this->ecc.size = 256;
178 this->badblock_pattern = data->badblock_pattern;
179 this->ecc.layout = data->ecc_layout;
180 this->ecc.hwctl = sharpsl_nand_enable_hwecc;
181 this->ecc.calculate = sharpsl_nand_calculate_ecc;
182 this->ecc.correct = nand_correct_data;
184 /* Scan to find existence of the device */
185 err = nand_scan(&sharpsl->mtd, 1);
189 /* Register the partitions */
190 sharpsl->mtd.name = "sharpsl-nand";
191 #ifdef CONFIG_MTD_PARTITIONS
192 nr_partitions = parse_mtd_partitions(&sharpsl->mtd, part_probes, &sharpsl_partition_info, 0);
193 if (nr_partitions <= 0) {
194 nr_partitions = data->nr_partitions;
195 sharpsl_partition_info = data->partitions;
198 if (nr_partitions > 0)
199 err = add_mtd_partitions(&sharpsl->mtd, sharpsl_partition_info, nr_partitions);
202 err = add_mtd_device(&sharpsl->mtd);
210 nand_release(&sharpsl->mtd);
213 platform_set_drvdata(pdev, NULL);
214 iounmap(sharpsl->io);
224 static int __devexit sharpsl_nand_remove(struct platform_device *pdev)
226 struct sharpsl_nand *sharpsl = platform_get_drvdata(pdev);
228 /* Release resources, unregister device */
229 nand_release(&sharpsl->mtd);
231 platform_set_drvdata(pdev, NULL);
233 iounmap(sharpsl->io);
235 /* Free the MTD device structure */
241 static struct platform_driver sharpsl_nand_driver = {
243 .name = "sharpsl-nand",
244 .owner = THIS_MODULE,
246 .probe = sharpsl_nand_probe,
247 .remove = __devexit_p(sharpsl_nand_remove),
251 * Define partitions for flash device
253 static struct mtd_partition sharpsl_nand_partitions[] = {
255 .name = "System Area",
257 .size = 7 * 1024 * 1024,
260 .name = "Root Filesystem",
261 .offset = 7 * 1024 * 1024,
262 .size = 30 * 1024 * 1024,
265 .name = "Home Filesystem",
266 .offset = MTDPART_OFS_APPEND,
267 .size = MTDPART_SIZ_FULL,
271 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
273 static struct nand_bbt_descr sharpsl_bbt = {
277 .pattern = scan_ff_pattern
280 static struct nand_bbt_descr sharpsl_akita_bbt = {
284 .pattern = scan_ff_pattern
287 static struct nand_ecclayout akita_oobinfo = {
290 0x5, 0x1, 0x2, 0x3, 0x6, 0x7, 0x15, 0x11,
291 0x12, 0x13, 0x16, 0x17, 0x25, 0x21, 0x22, 0x23,
292 0x26, 0x27, 0x35, 0x31, 0x32, 0x33, 0x36, 0x37},
293 .oobfree = {{0x08, 0x09}}
296 static struct sharpsl_nand_platform_data sharpsl_nand_platform_data = {
297 .badblock_pattern = &sharpsl_bbt,
298 .partitions = sharpsl_nand_partitions,
299 .nr_partitions = ARRAY_SIZE(sharpsl_nand_partitions),
302 static struct resource sharpsl_nand_resources[] = {
306 .flags = IORESOURCE_MEM,
310 static struct platform_device sharpsl_nand_device = {
311 .name = "sharpsl-nand",
313 .resource = sharpsl_nand_resources,
314 .num_resources = ARRAY_SIZE(sharpsl_nand_resources),
315 .dev.platform_data = &sharpsl_nand_platform_data,
318 static int __init sharpsl_nand_init(void)
320 if (machine_is_poodle()) {
321 sharpsl_nand_partitions[1].size = 22 * 1024 * 1024;
322 } else if (machine_is_corgi() || machine_is_shepherd()) {
323 sharpsl_nand_partitions[1].size = 25 * 1024 * 1024;
324 } else if (machine_is_husky()) {
325 sharpsl_nand_partitions[1].size = 53 * 1024 * 1024;
326 } else if (machine_is_spitz()) {
327 sharpsl_nand_partitions[1].size = 5 * 1024 * 1024;
328 } else if (machine_is_akita()) {
329 sharpsl_nand_partitions[1].size = 58 * 1024 * 1024;
330 sharpsl_nand_platform_data.badblock_pattern = &sharpsl_akita_bbt;
331 sharpsl_nand_platform_data.ecc_layout = &akita_oobinfo;
332 } else if (machine_is_borzoi()) {
333 sharpsl_nand_partitions[1].size = 32 * 1024 * 1024;
336 platform_device_register(&sharpsl_nand_device);
337 return platform_driver_register(&sharpsl_nand_driver);
339 module_init(sharpsl_nand_init);
341 static void __exit sharpsl_nand_exit(void)
343 platform_driver_unregister(&sharpsl_nand_driver);
344 platform_device_unregister(&sharpsl_nand_device);
346 module_exit(sharpsl_nand_exit);
348 MODULE_LICENSE("GPL");
349 MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
350 MODULE_DESCRIPTION("Device specific logic for NAND flash on Sharp SL-C7xx Series");