2 * drivers/mtd/nand/sharpsl.c
4 * Copyright (C) 2004 Richard Purdie
6 * $Id: sharpsl.c,v 1.4 2005/01/23 11:09:19 rpurdie Exp $
8 * Based on Sharp's NAND driver sharp_sl.c
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 #include <linux/genhd.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <linux/delay.h>
20 #include <linux/mtd/mtd.h>
21 #include <linux/mtd/nand.h>
22 #include <linux/mtd/nand_ecc.h>
23 #include <linux/mtd/partitions.h>
24 #include <linux/interrupt.h>
26 #include <asm/hardware.h>
27 #include <asm/mach-types.h>
29 static void __iomem *sharpsl_io_base;
30 static int sharpsl_phys_base = 0x0C000000;
33 #define ECCLPLB sharpsl_io_base+0x00 /* line parity 7 - 0 bit */
34 #define ECCLPUB sharpsl_io_base+0x04 /* line parity 15 - 8 bit */
35 #define ECCCP sharpsl_io_base+0x08 /* column parity 5 - 0 bit */
36 #define ECCCNTR sharpsl_io_base+0x0C /* ECC byte counter */
37 #define ECCCLRR sharpsl_io_base+0x10 /* cleare ECC */
38 #define FLASHIO sharpsl_io_base+0x14 /* Flash I/O */
39 #define FLASHCTL sharpsl_io_base+0x18 /* Flash Control */
41 /* Flash control bit */
42 #define FLRYBY (1 << 5)
43 #define FLCE1 (1 << 4)
45 #define FLALE (1 << 2)
46 #define FLCLE (1 << 1)
47 #define FLCE0 (1 << 0)
51 * MTD structure for SharpSL
53 static struct mtd_info *sharpsl_mtd = NULL;
56 * Define partitions for flash device
58 #define DEFAULT_NUM_PARTITIONS 3
60 static int nr_partitions;
61 static struct mtd_partition sharpsl_nand_default_partition_info[] = {
63 .name = "System Area",
65 .size = 7 * 1024 * 1024,
68 .name = "Root Filesystem",
69 .offset = 7 * 1024 * 1024,
70 .size = 30 * 1024 * 1024,
73 .name = "Home Filesystem",
74 .offset = MTDPART_OFS_APPEND ,
75 .size = MTDPART_SIZ_FULL ,
80 * hardware specific access to control-lines
83 sharpsl_nand_hwcontrol(struct mtd_info* mtd, int cmd)
87 writeb(readb(FLASHCTL) | FLCLE, FLASHCTL);
90 writeb(readb(FLASHCTL) & ~FLCLE, FLASHCTL);
94 writeb(readb(FLASHCTL) | FLALE, FLASHCTL);
97 writeb(readb(FLASHCTL) & ~FLALE, FLASHCTL);
100 case NAND_CTL_SETNCE:
101 writeb(readb(FLASHCTL) & ~(FLCE0|FLCE1), FLASHCTL);
103 case NAND_CTL_CLRNCE:
104 writeb(readb(FLASHCTL) | (FLCE0|FLCE1), FLASHCTL);
109 static uint8_t scan_ff_pattern[] = { 0xff, 0xff };
111 static struct nand_bbt_descr sharpsl_bbt = {
115 .pattern = scan_ff_pattern
119 sharpsl_nand_dev_ready(struct mtd_info* mtd)
121 return !((readb(FLASHCTL) & FLRYBY) == 0);
125 sharpsl_nand_enable_hwecc(struct mtd_info* mtd, int mode)
131 sharpsl_nand_calculate_ecc(struct mtd_info* mtd, const u_char* dat,
134 ecc_code[0] = ~readb(ECCLPUB);
135 ecc_code[1] = ~readb(ECCLPLB);
136 ecc_code[2] = (~readb(ECCCP) << 2) | 0x03;
137 return readb(ECCCNTR) != 0;
141 #ifdef CONFIG_MTD_PARTITIONS
142 const char *part_probes[] = { "cmdlinepart", NULL };
147 * Main initialization routine
150 sharpsl_nand_init(void)
152 struct nand_chip *this;
153 struct mtd_partition* sharpsl_partition_info;
156 /* Allocate memory for MTD device structure and private data */
157 sharpsl_mtd = kmalloc(sizeof(struct mtd_info) + sizeof(struct nand_chip),
160 printk ("Unable to allocate SharpSL NAND MTD device structure.\n");
164 /* map physical adress */
165 sharpsl_io_base = ioremap(sharpsl_phys_base, 0x1000);
166 if(!sharpsl_io_base){
167 printk("ioremap to access Sharp SL NAND chip failed\n");
172 /* Get pointer to private data */
173 this = (struct nand_chip *) (&sharpsl_mtd[1]);
175 /* Initialize structures */
176 memset((char *) sharpsl_mtd, 0, sizeof(struct mtd_info));
177 memset((char *) this, 0, sizeof(struct nand_chip));
179 /* Link the private data with the MTD structure */
180 sharpsl_mtd->priv = this;
185 writeb(readb(FLASHCTL) | FLWP, FLASHCTL);
187 /* Set address of NAND IO lines */
188 this->IO_ADDR_R = FLASHIO;
189 this->IO_ADDR_W = FLASHIO;
190 /* Set address of hardware control function */
191 this->hwcontrol = sharpsl_nand_hwcontrol;
192 this->dev_ready = sharpsl_nand_dev_ready;
193 /* 15 us command delay time */
194 this->chip_delay = 15;
195 /* set eccmode using hardware ECC */
196 this->eccmode = NAND_ECC_HW3_256;
197 this->enable_hwecc = sharpsl_nand_enable_hwecc;
198 this->calculate_ecc = sharpsl_nand_calculate_ecc;
199 this->correct_data = nand_correct_data;
200 this->badblock_pattern = &sharpsl_bbt;
202 /* Scan to find existence of the device */
203 err=nand_scan(sharpsl_mtd,1);
205 iounmap(sharpsl_io_base);
210 /* Register the partitions */
211 sharpsl_mtd->name = "sharpsl-nand";
212 nr_partitions = parse_mtd_partitions(sharpsl_mtd, part_probes,
213 &sharpsl_partition_info, 0);
215 if (nr_partitions <= 0) {
216 nr_partitions = DEFAULT_NUM_PARTITIONS;
217 sharpsl_partition_info = sharpsl_nand_default_partition_info;
218 if (machine_is_poodle()) {
219 sharpsl_partition_info[1].size=30 * 1024 * 1024;
220 } else if (machine_is_corgi() || machine_is_shepherd()) {
221 sharpsl_partition_info[1].size=25 * 1024 * 1024;
222 } else if (machine_is_husky()) {
223 sharpsl_partition_info[1].size=53 * 1024 * 1024;
227 if (machine_is_husky()) {
228 /* Need to use small eraseblock size for backward compatibility */
229 sharpsl_mtd->flags |= MTD_NO_VIRTBLOCKS;
232 add_mtd_partitions(sharpsl_mtd, sharpsl_partition_info, nr_partitions);
237 module_init(sharpsl_nand_init);
243 static void __exit sharpsl_nand_cleanup(void)
245 struct nand_chip *this = (struct nand_chip *) &sharpsl_mtd[1];
247 /* Release resources, unregister device */
248 nand_release(sharpsl_mtd);
250 iounmap(sharpsl_io_base);
252 /* Free the MTD device structure */
255 module_exit(sharpsl_nand_cleanup);
258 MODULE_LICENSE("GPL");
259 MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
260 MODULE_DESCRIPTION("Device specific logic for NAND flash on Sharp SL-C7xx Series");