blob: f23ab2c70433ebabbe62b838afe63b8010bbadad [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/mtd/nand.c
3 *
4 * Overview:
5 * This is the generic MTD driver for NAND flash devices. It should be
6 * capable of working with almost all NAND chips currently available.
7 * Basic support for AG-AND chips is provided.
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00008 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * Additional technical information is available on
10 * http://www.linux-mtd.infradead.org/tech/nand.html
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000011 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020013 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020015 * Credits:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000016 * David Woodhouse for adding multichip support
17 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
19 * rework for 2K page size chips
20 *
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020021 * TODO:
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 * Enable cached programming for 2k page size chips
23 * Check, if mtd->ecctype should be set to MTD_ECC_HW
24 * if we have HW ecc support.
25 * The AG-AND chips have nice features for speed improvement,
26 * which are not supported yet. Read / program 4 pages in one go.
27 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * This program is free software; you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License version 2 as
30 * published by the Free Software Foundation.
31 *
32 */
33
David Woodhouse552d9202006-05-14 01:20:46 +010034#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/delay.h>
36#include <linux/errno.h>
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +020037#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/sched.h>
39#include <linux/slab.h>
40#include <linux/types.h>
41#include <linux/mtd/mtd.h>
42#include <linux/mtd/nand.h>
43#include <linux/mtd/nand_ecc.h>
44#include <linux/mtd/compatmac.h>
45#include <linux/interrupt.h>
46#include <linux/bitops.h>
Richard Purdie8fe833c2006-03-31 02:31:14 -080047#include <linux/leds.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <asm/io.h>
49
50#ifdef CONFIG_MTD_PARTITIONS
51#include <linux/mtd/partitions.h>
52#endif
53
54/* Define default oob placement schemes for large and small page devices */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020055static struct nand_ecclayout nand_oob_8 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 .eccbytes = 3,
57 .eccpos = {0, 1, 2},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020058 .oobfree = {
59 {.offset = 3,
60 .length = 2},
61 {.offset = 6,
62 .length = 2}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
64
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020065static struct nand_ecclayout nand_oob_16 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 .eccbytes = 6,
67 .eccpos = {0, 1, 2, 3, 6, 7},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020068 .oobfree = {
69 {.offset = 8,
70 . length = 8}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070071};
72
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020073static struct nand_ecclayout nand_oob_64 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 .eccbytes = 24,
75 .eccpos = {
David Woodhousee0c7d762006-05-13 18:07:53 +010076 40, 41, 42, 43, 44, 45, 46, 47,
77 48, 49, 50, 51, 52, 53, 54, 55,
78 56, 57, 58, 59, 60, 61, 62, 63},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020079 .oobfree = {
80 {.offset = 2,
81 .length = 38}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020084static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +020085 int new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020087static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
88 struct mtd_oob_ops *ops);
89
Thomas Gleixnerd470a972006-05-23 23:48:57 +020090/*
91 * For devices which display every fart in the system on a seperate LED. Is
92 * compiled away when LED support is disabled.
93 */
94DEFINE_LED_TRIGGER(nand_led_trigger);
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/**
97 * nand_release_device - [GENERIC] release chip
98 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000099 *
100 * Deselect, release chip lock and wake up anyone waiting on the device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100102static void nand_release_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200104 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106 /* De-select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200107 chip->select_chip(mtd, -1);
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100108
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200109 /* Release the controller and the chip */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200110 spin_lock(&chip->controller->lock);
111 chip->controller->active = NULL;
112 chip->state = FL_READY;
113 wake_up(&chip->controller->wq);
114 spin_unlock(&chip->controller->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115}
116
117/**
118 * nand_read_byte - [DEFAULT] read one byte from the chip
119 * @mtd: MTD device structure
120 *
121 * Default read function for 8bit buswith
122 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200123static uint8_t nand_read_byte(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200125 struct nand_chip *chip = mtd->priv;
126 return readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127}
128
129/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
131 * @mtd: MTD device structure
132 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000133 * Default read function for 16bit buswith with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * endianess conversion
135 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200136static uint8_t nand_read_byte16(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200138 struct nand_chip *chip = mtd->priv;
139 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
142/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 * nand_read_word - [DEFAULT] read one word from the chip
144 * @mtd: MTD device structure
145 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000146 * Default read function for 16bit buswith without
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 * endianess conversion
148 */
149static u16 nand_read_word(struct mtd_info *mtd)
150{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200151 struct nand_chip *chip = mtd->priv;
152 return readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153}
154
155/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 * nand_select_chip - [DEFAULT] control CE line
157 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700158 * @chipnr: chipnumber to select, -1 for deselect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 *
160 * Default select function for 1 chip devices.
161 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200162static void nand_select_chip(struct mtd_info *mtd, int chipnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200164 struct nand_chip *chip = mtd->priv;
165
166 switch (chipnr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 case -1:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200168 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 break;
170 case 0:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 break;
172
173 default:
174 BUG();
175 }
176}
177
178/**
179 * nand_write_buf - [DEFAULT] write buffer to chip
180 * @mtd: MTD device structure
181 * @buf: data buffer
182 * @len: number of bytes to write
183 *
184 * Default write function for 8bit buswith
185 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200186static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187{
188 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200189 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
David Woodhousee0c7d762006-05-13 18:07:53 +0100191 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200192 writeb(buf[i], chip->IO_ADDR_W);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193}
194
195/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000196 * nand_read_buf - [DEFAULT] read chip data into buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 * @mtd: MTD device structure
198 * @buf: buffer to store date
199 * @len: number of bytes to read
200 *
201 * Default read function for 8bit buswith
202 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200203static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
205 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200206 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
David Woodhousee0c7d762006-05-13 18:07:53 +0100208 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200209 buf[i] = readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210}
211
212/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000213 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * @mtd: MTD device structure
215 * @buf: buffer containing the data to compare
216 * @len: number of bytes to compare
217 *
218 * Default verify function for 8bit buswith
219 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200220static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221{
222 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200223 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
David Woodhousee0c7d762006-05-13 18:07:53 +0100225 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200226 if (buf[i] != readb(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 return 0;
229}
230
231/**
232 * nand_write_buf16 - [DEFAULT] write buffer to chip
233 * @mtd: MTD device structure
234 * @buf: data buffer
235 * @len: number of bytes to write
236 *
237 * Default write function for 16bit buswith
238 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200239static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200242 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 u16 *p = (u16 *) buf;
244 len >>= 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000245
David Woodhousee0c7d762006-05-13 18:07:53 +0100246 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200247 writew(p[i], chip->IO_ADDR_W);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249}
250
251/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000252 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 * @mtd: MTD device structure
254 * @buf: buffer to store date
255 * @len: number of bytes to read
256 *
257 * Default read function for 16bit buswith
258 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200259static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
261 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200262 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 u16 *p = (u16 *) buf;
264 len >>= 1;
265
David Woodhousee0c7d762006-05-13 18:07:53 +0100266 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200267 p[i] = readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
270/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000271 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 * @mtd: MTD device structure
273 * @buf: buffer containing the data to compare
274 * @len: number of bytes to compare
275 *
276 * Default verify function for 16bit buswith
277 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200278static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279{
280 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200281 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 u16 *p = (u16 *) buf;
283 len >>= 1;
284
David Woodhousee0c7d762006-05-13 18:07:53 +0100285 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200286 if (p[i] != readw(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 return -EFAULT;
288
289 return 0;
290}
291
292/**
293 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
294 * @mtd: MTD device structure
295 * @ofs: offset from device start
296 * @getchip: 0, if the chip is already selected
297 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000298 * Check, if the block is bad.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 */
300static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
301{
302 int page, chipnr, res = 0;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200303 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 u16 bad;
305
306 if (getchip) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200307 page = (int)(ofs >> chip->page_shift);
308 chipnr = (int)(ofs >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200310 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200313 chip->select_chip(mtd, chipnr);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000314 } else
David Woodhousee0c7d762006-05-13 18:07:53 +0100315 page = (int)ofs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200317 if (chip->options & NAND_BUSWIDTH_16) {
318 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
319 page & chip->pagemask);
320 bad = cpu_to_le16(chip->read_word(mtd));
321 if (chip->badblockpos & 0x1)
Vitaly Wool49196f32005-11-02 16:54:46 +0000322 bad >>= 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 if ((bad & 0xFF) != 0xff)
324 res = 1;
325 } else {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200326 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
327 page & chip->pagemask);
328 if (chip->read_byte(mtd) != 0xff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 res = 1;
330 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000331
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200332 if (getchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 nand_release_device(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 return res;
336}
337
338/**
339 * nand_default_block_markbad - [DEFAULT] mark a block bad
340 * @mtd: MTD device structure
341 * @ofs: offset from device start
342 *
343 * This is the default implementation, which can be overridden by
344 * a hardware specific driver.
345*/
346static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
347{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200348 struct nand_chip *chip = mtd->priv;
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200349 uint8_t buf[2] = { 0, 0 };
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200350 int block, ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 /* Get block number */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200353 block = ((int)ofs) >> chip->bbt_erase_shift;
354 if (chip->bbt)
355 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357 /* Do we have a flash based bad block table ? */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200358 if (chip->options & NAND_USE_FLASH_BBT)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200359 ret = nand_update_bbt(mtd, ofs);
360 else {
361 /* We write two bytes, so we dont have to mess with 16 bit
362 * access
363 */
364 ofs += mtd->oobsize;
365 chip->ops.len = 2;
366 chip->ops.datbuf = NULL;
367 chip->ops.oobbuf = buf;
368 chip->ops.ooboffs = chip->badblockpos & ~0x01;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000369
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200370 ret = nand_do_write_oob(mtd, ofs, &chip->ops);
371 }
372 if (!ret)
373 mtd->ecc_stats.badblocks++;
374 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375}
376
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000377/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 * nand_check_wp - [GENERIC] check if the chip is write protected
379 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000380 * Check, if the device is write protected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000382 * The function expects, that the device is already selected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100384static int nand_check_wp(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200386 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* Check the WP bit */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200388 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
389 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390}
391
392/**
393 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
394 * @mtd: MTD device structure
395 * @ofs: offset from device start
396 * @getchip: 0, if the chip is already selected
397 * @allowbbt: 1, if its allowed to access the bbt area
398 *
399 * Check, if the block is bad. Either by reading the bad block table or
400 * calling of the scan function.
401 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200402static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
403 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200405 struct nand_chip *chip = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000406
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200407 if (!chip->bbt)
408 return chip->block_bad(mtd, ofs, getchip);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 /* Return info from the table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100411 return nand_isbad_bbt(mtd, ofs, allowbbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
413
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000414/*
Thomas Gleixner3b887752005-02-22 21:56:49 +0000415 * Wait for the ready pin, after a command
416 * The timeout is catched later.
417 */
David Woodhouse4b648b02006-09-25 17:05:24 +0100418void nand_wait_ready(struct mtd_info *mtd)
Thomas Gleixner3b887752005-02-22 21:56:49 +0000419{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200420 struct nand_chip *chip = mtd->priv;
David Woodhousee0c7d762006-05-13 18:07:53 +0100421 unsigned long timeo = jiffies + 2;
Thomas Gleixner3b887752005-02-22 21:56:49 +0000422
Richard Purdie8fe833c2006-03-31 02:31:14 -0800423 led_trigger_event(nand_led_trigger, LED_FULL);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000424 /* wait until command is processed or timeout occures */
425 do {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200426 if (chip->dev_ready(mtd))
Richard Purdie8fe833c2006-03-31 02:31:14 -0800427 break;
Ingo Molnar8446f1d2005-09-06 15:16:27 -0700428 touch_softlockup_watchdog();
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000429 } while (time_before(jiffies, timeo));
Richard Purdie8fe833c2006-03-31 02:31:14 -0800430 led_trigger_event(nand_led_trigger, LED_OFF);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000431}
David Woodhouse4b648b02006-09-25 17:05:24 +0100432EXPORT_SYMBOL_GPL(nand_wait_ready);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434/**
435 * nand_command - [DEFAULT] Send command to NAND device
436 * @mtd: MTD device structure
437 * @command: the command to be sent
438 * @column: the column address for this command, -1 if none
439 * @page_addr: the page address for this command, -1 if none
440 *
441 * Send command to NAND device. This function is used for small page
442 * devices (256/512 Bytes per page)
443 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200444static void nand_command(struct mtd_info *mtd, unsigned int command,
445 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200447 register struct nand_chip *chip = mtd->priv;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200448 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 /*
451 * Write out the command to the device.
452 */
453 if (command == NAND_CMD_SEQIN) {
454 int readcmd;
455
Joern Engel28318772006-05-22 23:18:05 +0200456 if (column >= mtd->writesize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 /* OOB area */
Joern Engel28318772006-05-22 23:18:05 +0200458 column -= mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 readcmd = NAND_CMD_READOOB;
460 } else if (column < 256) {
461 /* First 256 bytes --> READ0 */
462 readcmd = NAND_CMD_READ0;
463 } else {
464 column -= 256;
465 readcmd = NAND_CMD_READ1;
466 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200467 chip->cmd_ctrl(mtd, readcmd, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200468 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200470 chip->cmd_ctrl(mtd, command, ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200472 /*
473 * Address cycle, when necessary
474 */
475 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
476 /* Serially input address */
477 if (column != -1) {
478 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200479 if (chip->options & NAND_BUSWIDTH_16)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200480 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200481 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200482 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200484 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200485 chip->cmd_ctrl(mtd, page_addr, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200486 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200487 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200488 /* One more address cycle for devices > 32MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200489 if (chip->chipsize > (32 << 20))
490 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200491 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200492 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000493
494 /*
495 * program and erase have their own busy handlers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 * status and sequential in needs no delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100497 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 case NAND_CMD_PAGEPROG:
501 case NAND_CMD_ERASE1:
502 case NAND_CMD_ERASE2:
503 case NAND_CMD_SEQIN:
504 case NAND_CMD_STATUS:
505 return;
506
507 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200508 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200510 udelay(chip->chip_delay);
511 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200512 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200513 chip->cmd_ctrl(mtd,
514 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200515 while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 return;
517
David Woodhousee0c7d762006-05-13 18:07:53 +0100518 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000520 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 * If we don't have access to the busy pin, we apply the given
522 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100523 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200524 if (!chip->dev_ready) {
525 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000527 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 /* Apply this short delay always to ensure that we do wait tWB in
530 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100531 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000532
533 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
536/**
537 * nand_command_lp - [DEFAULT] Send command to NAND large page device
538 * @mtd: MTD device structure
539 * @command: the command to be sent
540 * @column: the column address for this command, -1 if none
541 * @page_addr: the page address for this command, -1 if none
542 *
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200543 * Send command to NAND device. This is the version for the new large page
544 * devices We dont have the separate regions as we have in the small page
545 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200547static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
548 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200550 register struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552 /* Emulate NAND_CMD_READOOB */
553 if (command == NAND_CMD_READOOB) {
Joern Engel28318772006-05-22 23:18:05 +0200554 column += mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 command = NAND_CMD_READ0;
556 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000557
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200558 /* Command latch cycle */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200559 chip->cmd_ctrl(mtd, command & 0xff,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200560 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
562 if (column != -1 || page_addr != -1) {
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200563 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565 /* Serially input address */
566 if (column != -1) {
567 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200568 if (chip->options & NAND_BUSWIDTH_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200570 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200571 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200572 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200575 chip->cmd_ctrl(mtd, page_addr, ctrl);
576 chip->cmd_ctrl(mtd, page_addr >> 8,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200577 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 /* One more address cycle for devices > 128MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200579 if (chip->chipsize > (128 << 20))
580 chip->cmd_ctrl(mtd, page_addr >> 16,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200581 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200584 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000585
586 /*
587 * program and erase have their own busy handlers
David A. Marlin30f464b2005-01-17 18:35:25 +0000588 * status, sequential in, and deplete1 need no delay
589 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 case NAND_CMD_CACHEDPROG:
593 case NAND_CMD_PAGEPROG:
594 case NAND_CMD_ERASE1:
595 case NAND_CMD_ERASE2:
596 case NAND_CMD_SEQIN:
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200597 case NAND_CMD_RNDIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 case NAND_CMD_STATUS:
David A. Marlin30f464b2005-01-17 18:35:25 +0000599 case NAND_CMD_DEPLETE1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return;
601
David Woodhousee0c7d762006-05-13 18:07:53 +0100602 /*
603 * read error status commands require only a short delay
604 */
David A. Marlin30f464b2005-01-17 18:35:25 +0000605 case NAND_CMD_STATUS_ERROR:
606 case NAND_CMD_STATUS_ERROR0:
607 case NAND_CMD_STATUS_ERROR1:
608 case NAND_CMD_STATUS_ERROR2:
609 case NAND_CMD_STATUS_ERROR3:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200610 udelay(chip->chip_delay);
David A. Marlin30f464b2005-01-17 18:35:25 +0000611 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200614 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200616 udelay(chip->chip_delay);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200617 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
618 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
619 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
620 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200621 while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return;
623
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200624 case NAND_CMD_RNDOUT:
625 /* No ready / busy check necessary */
626 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
627 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
628 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
629 NAND_NCE | NAND_CTRL_CHANGE);
630 return;
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 case NAND_CMD_READ0:
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200633 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
634 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
635 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
636 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000637
David Woodhousee0c7d762006-05-13 18:07:53 +0100638 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000640 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 * If we don't have access to the busy pin, we apply the given
642 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100643 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200644 if (!chip->dev_ready) {
645 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000647 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
Thomas Gleixner3b887752005-02-22 21:56:49 +0000649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 /* Apply this short delay always to ensure that we do wait tWB in
651 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100652 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000653
654 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
656
657/**
658 * nand_get_device - [GENERIC] Get chip for selected access
Randy Dunlap844d3b42006-06-28 21:48:27 -0700659 * @chip: the nand chip descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000661 * @new_state: the state which is requested
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 *
663 * Get the device and lock it for exclusive access
664 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200665static int
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200666nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200668 spinlock_t *lock = &chip->controller->lock;
669 wait_queue_head_t *wq = &chip->controller->wq;
David Woodhousee0c7d762006-05-13 18:07:53 +0100670 DECLARE_WAITQUEUE(wait, current);
David Woodhousee0c7d762006-05-13 18:07:53 +0100671 retry:
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100672 spin_lock(lock);
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 /* Hardware controller shared among independend devices */
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200675 /* Hardware controller shared among independend devices */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200676 if (!chip->controller->active)
677 chip->controller->active = chip;
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200678
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200679 if (chip->controller->active == chip && chip->state == FL_READY) {
680 chip->state = new_state;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100681 spin_unlock(lock);
Vitaly Wool962034f2005-09-15 14:58:53 +0100682 return 0;
683 }
684 if (new_state == FL_PM_SUSPENDED) {
685 spin_unlock(lock);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200686 return (chip->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100687 }
688 set_current_state(TASK_UNINTERRUPTIBLE);
689 add_wait_queue(wq, &wait);
690 spin_unlock(lock);
691 schedule();
692 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 goto retry;
694}
695
696/**
697 * nand_wait - [DEFAULT] wait until the command is done
698 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700699 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 *
701 * Wait for command done. This applies to erase and program only
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000702 * Erase can take up to 400ms and program up to 20ms according to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * general NAND and SmartMedia specs
Randy Dunlap844d3b42006-06-28 21:48:27 -0700704 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200705static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
707
David Woodhousee0c7d762006-05-13 18:07:53 +0100708 unsigned long timeo = jiffies;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200709 int status, state = chip->state;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 if (state == FL_ERASING)
David Woodhousee0c7d762006-05-13 18:07:53 +0100712 timeo += (HZ * 400) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 else
David Woodhousee0c7d762006-05-13 18:07:53 +0100714 timeo += (HZ * 20) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Richard Purdie8fe833c2006-03-31 02:31:14 -0800716 led_trigger_event(nand_led_trigger, LED_FULL);
717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 /* Apply this short delay always to ensure that we do wait tWB in
719 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100720 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200722 if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
723 chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000724 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200725 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000727 while (time_before(jiffies, timeo)) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200728 if (chip->dev_ready) {
729 if (chip->dev_ready(mtd))
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000730 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 } else {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200732 if (chip->read_byte(mtd) & NAND_STATUS_READY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 break;
734 }
Thomas Gleixner20a6c212005-03-01 09:32:48 +0000735 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800737 led_trigger_event(nand_led_trigger, LED_OFF);
738
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200739 status = (int)chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 return status;
741}
742
743/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200744 * nand_read_page_raw - [Intern] read raw page data without ecc
745 * @mtd: mtd info structure
746 * @chip: nand chip info structure
747 * @buf: buffer to store read data
748 */
749static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
750 uint8_t *buf)
751{
752 chip->read_buf(mtd, buf, mtd->writesize);
753 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
754 return 0;
755}
756
757/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +0300758 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200759 * @mtd: mtd info structure
760 * @chip: nand chip info structure
761 * @buf: buffer to store read data
David A. Marlin068e3c02005-01-24 03:07:46 +0000762 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200763static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
764 uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200766 int i, eccsize = chip->ecc.size;
767 int eccbytes = chip->ecc.bytes;
768 int eccsteps = chip->ecc.steps;
769 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100770 uint8_t *ecc_calc = chip->buffers->ecccalc;
771 uint8_t *ecc_code = chip->buffers->ecccode;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200772 int *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200773
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200774 nand_read_page_raw(mtd, chip, buf);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200775
776 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
777 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
778
779 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200780 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200781
782 eccsteps = chip->ecc.steps;
783 p = buf;
784
785 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
786 int stat;
787
788 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
789 if (stat == -1)
790 mtd->ecc_stats.failed++;
791 else
792 mtd->ecc_stats.corrected += stat;
793 }
794 return 0;
Thomas Gleixner22c60f52005-04-04 19:56:32 +0100795}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +0300798 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200799 * @mtd: mtd info structure
800 * @chip: nand chip info structure
801 * @buf: buffer to store read data
802 *
803 * Not for syndrome calculating ecc controllers which need a special oob layout
804 */
805static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
806 uint8_t *buf)
807{
808 int i, eccsize = chip->ecc.size;
809 int eccbytes = chip->ecc.bytes;
810 int eccsteps = chip->ecc.steps;
811 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100812 uint8_t *ecc_calc = chip->buffers->ecccalc;
813 uint8_t *ecc_code = chip->buffers->ecccode;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200814 int *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200815
816 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
817 chip->ecc.hwctl(mtd, NAND_ECC_READ);
818 chip->read_buf(mtd, p, eccsize);
819 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
820 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200821 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200822
823 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200824 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200825
826 eccsteps = chip->ecc.steps;
827 p = buf;
828
829 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
830 int stat;
831
832 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
833 if (stat == -1)
834 mtd->ecc_stats.failed++;
835 else
836 mtd->ecc_stats.corrected += stat;
837 }
838 return 0;
839}
840
841/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +0300842 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200843 * @mtd: mtd info structure
844 * @chip: nand chip info structure
845 * @buf: buffer to store read data
846 *
847 * The hw generator calculates the error syndrome automatically. Therefor
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200848 * we need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200849 */
850static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
851 uint8_t *buf)
852{
853 int i, eccsize = chip->ecc.size;
854 int eccbytes = chip->ecc.bytes;
855 int eccsteps = chip->ecc.steps;
856 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200857 uint8_t *oob = chip->oob_poi;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200858
859 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
860 int stat;
861
862 chip->ecc.hwctl(mtd, NAND_ECC_READ);
863 chip->read_buf(mtd, p, eccsize);
864
865 if (chip->ecc.prepad) {
866 chip->read_buf(mtd, oob, chip->ecc.prepad);
867 oob += chip->ecc.prepad;
868 }
869
870 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
871 chip->read_buf(mtd, oob, eccbytes);
872 stat = chip->ecc.correct(mtd, p, oob, NULL);
873
874 if (stat == -1)
875 mtd->ecc_stats.failed++;
876 else
877 mtd->ecc_stats.corrected += stat;
878
879 oob += eccbytes;
880
881 if (chip->ecc.postpad) {
882 chip->read_buf(mtd, oob, chip->ecc.postpad);
883 oob += chip->ecc.postpad;
884 }
885 }
886
887 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +0400888 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200889 if (i)
890 chip->read_buf(mtd, oob, i);
891
892 return 0;
893}
894
895/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200896 * nand_transfer_oob - [Internal] Transfer oob to client buffer
897 * @chip: nand chip structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700898 * @oob: oob destination address
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200899 * @ops: oob ops structure
900 */
901static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
902 struct mtd_oob_ops *ops)
903{
904 size_t len = ops->ooblen;
905
906 switch(ops->mode) {
907
908 case MTD_OOB_PLACE:
909 case MTD_OOB_RAW:
910 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
911 return oob + len;
912
913 case MTD_OOB_AUTO: {
914 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200915 uint32_t boffs = 0, roffs = ops->ooboffs;
916 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200917
918 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200919 /* Read request not from offset 0 ? */
920 if (unlikely(roffs)) {
921 if (roffs >= free->length) {
922 roffs -= free->length;
923 continue;
924 }
925 boffs = free->offset + roffs;
926 bytes = min_t(size_t, len,
927 (free->length - roffs));
928 roffs = 0;
929 } else {
930 bytes = min_t(size_t, len, free->length);
931 boffs = free->offset;
932 }
933 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200934 oob += bytes;
935 }
936 return oob;
937 }
938 default:
939 BUG();
940 }
941 return NULL;
942}
943
944/**
945 * nand_do_read_ops - [Internal] Read data with ECC
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200946 *
David A. Marlin068e3c02005-01-24 03:07:46 +0000947 * @mtd: MTD device structure
948 * @from: offset to read from
Randy Dunlap844d3b42006-06-28 21:48:27 -0700949 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +0000950 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200951 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +0000952 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200953static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
954 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +0000955{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200956 int chipnr, page, realpage, col, bytes, aligned;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200957 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200958 struct mtd_ecc_stats stats;
959 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
960 int sndcmd = 1;
961 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200962 uint32_t readlen = ops->len;
963 uint8_t *bufpoi, *oob, *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200965 stats = mtd->ecc_stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200967 chipnr = (int)(from >> chip->chip_shift);
968 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200970 realpage = (int)(from >> chip->page_shift);
971 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200973 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200975 buf = ops->datbuf;
976 oob = ops->oobbuf;
977
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200978 while(1) {
979 bytes = min(mtd->writesize - col, readlen);
980 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000981
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200982 /* Is the current page in the buffer ? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200983 if (realpage != chip->pagebuf || oob) {
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100984 bufpoi = aligned ? buf : chip->buffers->databuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200986 if (likely(sndcmd)) {
987 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
988 sndcmd = 0;
989 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200991 /* Now read the page into the buffer */
David Woodhouse956e9442006-09-25 17:12:39 +0100992 if (unlikely(ops->mode == MTD_OOB_RAW))
993 ret = chip->ecc.read_page_raw(mtd, chip, bufpoi);
994 else
995 ret = chip->ecc.read_page(mtd, chip, bufpoi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200996 if (ret < 0)
David Woodhousee0c7d762006-05-13 18:07:53 +0100997 break;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200998
999 /* Transfer not aligned data */
1000 if (!aligned) {
1001 chip->pagebuf = realpage;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001002 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001004
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001005 buf += bytes;
1006
1007 if (unlikely(oob)) {
1008 /* Raw mode does data:oob:data:oob */
1009 if (ops->mode != MTD_OOB_RAW)
1010 oob = nand_transfer_oob(chip, oob, ops);
1011 else
1012 buf = nand_transfer_oob(chip, buf, ops);
1013 }
1014
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001015 if (!(chip->options & NAND_NO_READRDY)) {
1016 /*
1017 * Apply delay or wait for ready/busy pin. Do
1018 * this before the AUTOINCR check, so no
1019 * problems arise if a chip which does auto
1020 * increment is marked as NOAUTOINCR by the
1021 * board driver.
1022 */
1023 if (!chip->dev_ready)
1024 udelay(chip->chip_delay);
1025 else
1026 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001028 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001029 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001030 buf += bytes;
1031 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001033 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001034
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001035 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001036 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038 /* For subsequent reads align to page boundary. */
1039 col = 0;
1040 /* Increment page address */
1041 realpage++;
1042
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001043 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 /* Check, if we cross a chip boundary */
1045 if (!page) {
1046 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001047 chip->select_chip(mtd, -1);
1048 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001050
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001051 /* Check, if the chip supports auto page increment
1052 * or if we have hit a block boundary.
David Woodhousee0c7d762006-05-13 18:07:53 +01001053 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001054 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001055 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
1057
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001058 ops->retlen = ops->len - (size_t) readlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001060 if (ret)
1061 return ret;
1062
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001063 if (mtd->ecc_stats.failed - stats.failed)
1064 return -EBADMSG;
1065
1066 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001067}
1068
1069/**
1070 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
1071 * @mtd: MTD device structure
1072 * @from: offset to read from
1073 * @len: number of bytes to read
1074 * @retlen: pointer to variable to store the number of read bytes
1075 * @buf: the databuffer to put data
1076 *
1077 * Get hold of the chip and call nand_do_read
1078 */
1079static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1080 size_t *retlen, uint8_t *buf)
1081{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001082 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001083 int ret;
1084
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001085 /* Do not allow reads past end of device */
1086 if ((from + len) > mtd->size)
1087 return -EINVAL;
1088 if (!len)
1089 return 0;
1090
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001091 nand_get_device(chip, mtd, FL_READING);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001092
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001093 chip->ops.len = len;
1094 chip->ops.datbuf = buf;
1095 chip->ops.oobbuf = NULL;
1096
1097 ret = nand_do_read_ops(mtd, from, &chip->ops);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001098
Richard Purdie7fd5aec2006-08-27 01:23:33 -07001099 *retlen = chip->ops.retlen;
1100
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001101 nand_release_device(mtd);
1102
1103 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104}
1105
1106/**
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001107 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
1108 * @mtd: mtd info structure
1109 * @chip: nand chip info structure
1110 * @page: page number to read
1111 * @sndcmd: flag whether to issue read command or not
1112 */
1113static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1114 int page, int sndcmd)
1115{
1116 if (sndcmd) {
1117 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1118 sndcmd = 0;
1119 }
1120 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1121 return sndcmd;
1122}
1123
1124/**
1125 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
1126 * with syndromes
1127 * @mtd: mtd info structure
1128 * @chip: nand chip info structure
1129 * @page: page number to read
1130 * @sndcmd: flag whether to issue read command or not
1131 */
1132static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1133 int page, int sndcmd)
1134{
1135 uint8_t *buf = chip->oob_poi;
1136 int length = mtd->oobsize;
1137 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1138 int eccsize = chip->ecc.size;
1139 uint8_t *bufpoi = buf;
1140 int i, toread, sndrnd = 0, pos;
1141
1142 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1143 for (i = 0; i < chip->ecc.steps; i++) {
1144 if (sndrnd) {
1145 pos = eccsize + i * (eccsize + chunk);
1146 if (mtd->writesize > 512)
1147 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1148 else
1149 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1150 } else
1151 sndrnd = 1;
1152 toread = min_t(int, length, chunk);
1153 chip->read_buf(mtd, bufpoi, toread);
1154 bufpoi += toread;
1155 length -= toread;
1156 }
1157 if (length > 0)
1158 chip->read_buf(mtd, bufpoi, length);
1159
1160 return 1;
1161}
1162
1163/**
1164 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
1165 * @mtd: mtd info structure
1166 * @chip: nand chip info structure
1167 * @page: page number to write
1168 */
1169static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1170 int page)
1171{
1172 int status = 0;
1173 const uint8_t *buf = chip->oob_poi;
1174 int length = mtd->oobsize;
1175
1176 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1177 chip->write_buf(mtd, buf, length);
1178 /* Send command to program the OOB data */
1179 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1180
1181 status = chip->waitfunc(mtd, chip);
1182
Savin Zlobec0d420f92006-06-21 11:51:20 +02001183 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001184}
1185
1186/**
1187 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
1188 * with syndrome - only for large page flash !
1189 * @mtd: mtd info structure
1190 * @chip: nand chip info structure
1191 * @page: page number to write
1192 */
1193static int nand_write_oob_syndrome(struct mtd_info *mtd,
1194 struct nand_chip *chip, int page)
1195{
1196 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1197 int eccsize = chip->ecc.size, length = mtd->oobsize;
1198 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1199 const uint8_t *bufpoi = chip->oob_poi;
1200
1201 /*
1202 * data-ecc-data-ecc ... ecc-oob
1203 * or
1204 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1205 */
1206 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1207 pos = steps * (eccsize + chunk);
1208 steps = 0;
1209 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001210 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001211
1212 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1213 for (i = 0; i < steps; i++) {
1214 if (sndcmd) {
1215 if (mtd->writesize <= 512) {
1216 uint32_t fill = 0xFFFFFFFF;
1217
1218 len = eccsize;
1219 while (len > 0) {
1220 int num = min_t(int, len, 4);
1221 chip->write_buf(mtd, (uint8_t *)&fill,
1222 num);
1223 len -= num;
1224 }
1225 } else {
1226 pos = eccsize + i * (eccsize + chunk);
1227 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1228 }
1229 } else
1230 sndcmd = 1;
1231 len = min_t(int, length, chunk);
1232 chip->write_buf(mtd, bufpoi, len);
1233 bufpoi += len;
1234 length -= len;
1235 }
1236 if (length > 0)
1237 chip->write_buf(mtd, bufpoi, length);
1238
1239 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1240 status = chip->waitfunc(mtd, chip);
1241
1242 return status & NAND_STATUS_FAIL ? -EIO : 0;
1243}
1244
1245/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001246 * nand_do_read_oob - [Intern] NAND read out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 * @mtd: MTD device structure
1248 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001249 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 *
1251 * NAND read out-of-band data from the spare area
1252 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001253static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1254 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001256 int page, realpage, chipnr, sndcmd = 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001257 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001258 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001259 int readlen = ops->len;
1260 uint8_t *buf = ops->oobbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Andrew Morton7e9a0bb2006-05-30 09:06:41 +01001262 DEBUG(MTD_DEBUG_LEVEL3, "nand_read_oob: from = 0x%08Lx, len = %i\n",
1263 (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001265 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001266 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001268 /* Shift to get page */
1269 realpage = (int)(from >> chip->page_shift);
1270 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001272 while(1) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001273 sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1274 buf = nand_transfer_oob(chip, buf, ops);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001275
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001276 if (!(chip->options & NAND_NO_READRDY)) {
1277 /*
1278 * Apply delay or wait for ready/busy pin. Do this
1279 * before the AUTOINCR check, so no problems arise if a
1280 * chip which does auto increment is marked as
1281 * NOAUTOINCR by the board driver.
Thomas Gleixner19870da2005-07-15 14:53:51 +01001282 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001283 if (!chip->dev_ready)
1284 udelay(chip->chip_delay);
Thomas Gleixner19870da2005-07-15 14:53:51 +01001285 else
1286 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 }
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001288
Savin Zlobec0d420f92006-06-21 11:51:20 +02001289 readlen -= ops->ooblen;
1290 if (!readlen)
1291 break;
1292
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001293 /* Increment page address */
1294 realpage++;
1295
1296 page = realpage & chip->pagemask;
1297 /* Check, if we cross a chip boundary */
1298 if (!page) {
1299 chipnr++;
1300 chip->select_chip(mtd, -1);
1301 chip->select_chip(mtd, chipnr);
1302 }
1303
1304 /* Check, if the chip supports auto page increment
1305 * or if we have hit a block boundary.
1306 */
1307 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
1308 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 }
1310
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001311 ops->retlen = ops->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 return 0;
1313}
1314
1315/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001316 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001319 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001321 * NAND read data and/or out-of-band data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001323static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1324 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001326 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001327 int ret = -ENOTSUPP;
1328
1329 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
1331 /* Do not allow reads past end of device */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001332 if ((from + ops->len) > mtd->size) {
1333 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_oob: "
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001334 "Attempt read beyond end of device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 return -EINVAL;
1336 }
1337
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001338 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001340 switch(ops->mode) {
1341 case MTD_OOB_PLACE:
1342 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001343 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001344 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001345
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001346 default:
1347 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 }
1349
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001350 if (!ops->datbuf)
1351 ret = nand_do_read_oob(mtd, from, ops);
1352 else
1353 ret = nand_do_read_ops(mtd, from, ops);
1354
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001355 out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001357 return ret;
1358}
1359
1360
1361/**
1362 * nand_write_page_raw - [Intern] raw page write function
1363 * @mtd: mtd info structure
1364 * @chip: nand chip info structure
1365 * @buf: data buffer
1366 */
1367static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1368 const uint8_t *buf)
1369{
1370 chip->write_buf(mtd, buf, mtd->writesize);
1371 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372}
1373
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001374/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001375 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001376 * @mtd: mtd info structure
1377 * @chip: nand chip info structure
1378 * @buf: data buffer
1379 */
1380static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1381 const uint8_t *buf)
1382{
1383 int i, eccsize = chip->ecc.size;
1384 int eccbytes = chip->ecc.bytes;
1385 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001386 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001387 const uint8_t *p = buf;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02001388 int *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001389
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001390 /* Software ecc calculation */
1391 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1392 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001393
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001394 for (i = 0; i < chip->ecc.total; i++)
1395 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001396
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001397 nand_write_page_raw(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001398}
1399
1400/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001401 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001402 * @mtd: mtd info structure
1403 * @chip: nand chip info structure
1404 * @buf: data buffer
1405 */
1406static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1407 const uint8_t *buf)
1408{
1409 int i, eccsize = chip->ecc.size;
1410 int eccbytes = chip->ecc.bytes;
1411 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001412 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001413 const uint8_t *p = buf;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02001414 int *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001415
1416 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1417 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01001418 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001419 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1420 }
1421
1422 for (i = 0; i < chip->ecc.total; i++)
1423 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1424
1425 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1426}
1427
1428/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001429 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001430 * @mtd: mtd info structure
1431 * @chip: nand chip info structure
1432 * @buf: data buffer
1433 *
1434 * The hw generator calculates the error syndrome automatically. Therefor
1435 * we need a special oob layout and handling.
1436 */
1437static void nand_write_page_syndrome(struct mtd_info *mtd,
1438 struct nand_chip *chip, const uint8_t *buf)
1439{
1440 int i, eccsize = chip->ecc.size;
1441 int eccbytes = chip->ecc.bytes;
1442 int eccsteps = chip->ecc.steps;
1443 const uint8_t *p = buf;
1444 uint8_t *oob = chip->oob_poi;
1445
1446 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1447
1448 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1449 chip->write_buf(mtd, p, eccsize);
1450
1451 if (chip->ecc.prepad) {
1452 chip->write_buf(mtd, oob, chip->ecc.prepad);
1453 oob += chip->ecc.prepad;
1454 }
1455
1456 chip->ecc.calculate(mtd, p, oob);
1457 chip->write_buf(mtd, oob, eccbytes);
1458 oob += eccbytes;
1459
1460 if (chip->ecc.postpad) {
1461 chip->write_buf(mtd, oob, chip->ecc.postpad);
1462 oob += chip->ecc.postpad;
1463 }
1464 }
1465
1466 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001467 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001468 if (i)
1469 chip->write_buf(mtd, oob, i);
1470}
1471
1472/**
David Woodhouse956e9442006-09-25 17:12:39 +01001473 * nand_write_page - [REPLACEABLE] write one page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001474 * @mtd: MTD device structure
1475 * @chip: NAND chip descriptor
1476 * @buf: the data to write
1477 * @page: page number to write
1478 * @cached: cached programming
1479 */
1480static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
David Woodhouse956e9442006-09-25 17:12:39 +01001481 const uint8_t *buf, int page, int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001482{
1483 int status;
1484
1485 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
1486
David Woodhouse956e9442006-09-25 17:12:39 +01001487 if (unlikely(raw))
1488 chip->ecc.write_page_raw(mtd, chip, buf);
1489 else
1490 chip->ecc.write_page(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001491
1492 /*
1493 * Cached progamming disabled for now, Not sure if its worth the
1494 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
1495 */
1496 cached = 0;
1497
1498 if (!cached || !(chip->options & NAND_CACHEPRG)) {
1499
1500 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001501 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001502 /*
1503 * See if operation failed and additional status checks are
1504 * available
1505 */
1506 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
1507 status = chip->errstat(mtd, chip, FL_WRITING, status,
1508 page);
1509
1510 if (status & NAND_STATUS_FAIL)
1511 return -EIO;
1512 } else {
1513 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001514 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001515 }
1516
1517#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1518 /* Send command to read back the data */
1519 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1520
1521 if (chip->verify_buf(mtd, buf, mtd->writesize))
1522 return -EIO;
1523#endif
1524 return 0;
1525}
1526
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001527/**
1528 * nand_fill_oob - [Internal] Transfer client buffer to oob
1529 * @chip: nand chip structure
1530 * @oob: oob data buffer
1531 * @ops: oob ops structure
1532 */
1533static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
1534 struct mtd_oob_ops *ops)
1535{
1536 size_t len = ops->ooblen;
1537
1538 switch(ops->mode) {
1539
1540 case MTD_OOB_PLACE:
1541 case MTD_OOB_RAW:
1542 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
1543 return oob + len;
1544
1545 case MTD_OOB_AUTO: {
1546 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001547 uint32_t boffs = 0, woffs = ops->ooboffs;
1548 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001549
1550 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001551 /* Write request not from offset 0 ? */
1552 if (unlikely(woffs)) {
1553 if (woffs >= free->length) {
1554 woffs -= free->length;
1555 continue;
1556 }
1557 boffs = free->offset + woffs;
1558 bytes = min_t(size_t, len,
1559 (free->length - woffs));
1560 woffs = 0;
1561 } else {
1562 bytes = min_t(size_t, len, free->length);
1563 boffs = free->offset;
1564 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001565 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001566 oob += bytes;
1567 }
1568 return oob;
1569 }
1570 default:
1571 BUG();
1572 }
1573 return NULL;
1574}
1575
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001576#define NOTALIGNED(x) (x & (mtd->writesize-1)) != 0
1577
1578/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001579 * nand_do_write_ops - [Internal] NAND write with ECC
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001580 * @mtd: MTD device structure
1581 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001582 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001583 *
1584 * NAND write with ECC
1585 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001586static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
1587 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001588{
1589 int chipnr, realpage, page, blockmask;
1590 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001591 uint32_t writelen = ops->len;
1592 uint8_t *oob = ops->oobbuf;
1593 uint8_t *buf = ops->datbuf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001594 int bytes = mtd->writesize;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001595 int ret;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001596
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001597 ops->retlen = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001598
1599 /* reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001600 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001601 printk(KERN_NOTICE "nand_write: "
1602 "Attempt to write not page aligned data\n");
1603 return -EINVAL;
1604 }
1605
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001606 if (!writelen)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001607 return 0;
1608
Thomas Gleixner6a930962006-06-28 00:11:45 +02001609 chipnr = (int)(to >> chip->chip_shift);
1610 chip->select_chip(mtd, chipnr);
1611
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001612 /* Check, if it is write protected */
1613 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001614 return -EIO;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001615
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001616 realpage = (int)(to >> chip->page_shift);
1617 page = realpage & chip->pagemask;
1618 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1619
1620 /* Invalidate the page cache, when we write to the cached page */
1621 if (to <= (chip->pagebuf << chip->page_shift) &&
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001622 (chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001623 chip->pagebuf = -1;
1624
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01001625 /* If we're not given explicit OOB data, let it be 0xFF */
1626 if (likely(!oob))
1627 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001628
1629 while(1) {
1630 int cached = writelen > bytes && page != blockmask;
1631
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001632 if (unlikely(oob))
1633 oob = nand_fill_oob(chip, oob, ops);
1634
David Woodhouse956e9442006-09-25 17:12:39 +01001635 ret = chip->write_page(mtd, chip, buf, page, cached,
1636 (ops->mode == MTD_OOB_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001637 if (ret)
1638 break;
1639
1640 writelen -= bytes;
1641 if (!writelen)
1642 break;
1643
1644 buf += bytes;
1645 realpage++;
1646
1647 page = realpage & chip->pagemask;
1648 /* Check, if we cross a chip boundary */
1649 if (!page) {
1650 chipnr++;
1651 chip->select_chip(mtd, -1);
1652 chip->select_chip(mtd, chipnr);
1653 }
1654 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001655
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001656 ops->retlen = ops->len - writelen;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001657 return ret;
1658}
1659
1660/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001661 * nand_write - [MTD Interface] NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 * @mtd: MTD device structure
1663 * @to: offset to write to
1664 * @len: number of bytes to write
1665 * @retlen: pointer to variable to store the number of written bytes
1666 * @buf: the data to write
1667 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001668 * NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001670static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001671 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001673 struct nand_chip *chip = mtd->priv;
1674 int ret;
1675
1676 /* Do not allow reads past end of device */
1677 if ((to + len) > mtd->size)
1678 return -EINVAL;
1679 if (!len)
1680 return 0;
1681
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001682 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001683
1684 chip->ops.len = len;
1685 chip->ops.datbuf = (uint8_t *)buf;
1686 chip->ops.oobbuf = NULL;
1687
1688 ret = nand_do_write_ops(mtd, to, &chip->ops);
1689
Richard Purdie7fd5aec2006-08-27 01:23:33 -07001690 *retlen = chip->ops.retlen;
1691
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001692 nand_release_device(mtd);
1693
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001694 return ret;
1695}
1696
1697/**
1698 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
1699 * @mtd: MTD device structure
1700 * @to: offset to write to
1701 * @ops: oob operation description structure
1702 *
1703 * NAND write out-of-band
1704 */
1705static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
1706 struct mtd_oob_ops *ops)
1707{
1708 int chipnr, page, status;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001709 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001711 DEBUG(MTD_DEBUG_LEVEL3, "nand_write_oob: to = 0x%08x, len = %i\n",
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001712 (unsigned int)to, (int)ops->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713
1714 /* Do not allow write past end of page */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001715 if ((ops->ooboffs + ops->len) > mtd->oobsize) {
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001716 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: "
1717 "Attempt to write past end of page\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 return -EINVAL;
1719 }
1720
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001721 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001722 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001724 /* Shift to get page */
1725 page = (int)(to >> chip->page_shift);
1726
1727 /*
1728 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
1729 * of my DiskOnChip 2000 test units) will clear the whole data page too
1730 * if we don't do this. I have no clue why, but I seem to have 'fixed'
1731 * it in the doc2000 driver in August 1999. dwmw2.
1732 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001733 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
1735 /* Check, if it is write protected */
1736 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001737 return -EROFS;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001738
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001740 if (page == chip->pagebuf)
1741 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001743 memset(chip->oob_poi, 0xff, mtd->oobsize);
1744 nand_fill_oob(chip, ops->oobbuf, ops);
1745 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
1746 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001747
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001748 if (status)
1749 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001751 ops->retlen = ops->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001753 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001754}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001756/**
1757 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
1758 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07001759 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001760 * @ops: oob operation description structure
1761 */
1762static int nand_write_oob(struct mtd_info *mtd, loff_t to,
1763 struct mtd_oob_ops *ops)
1764{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001765 struct nand_chip *chip = mtd->priv;
1766 int ret = -ENOTSUPP;
1767
1768 ops->retlen = 0;
1769
1770 /* Do not allow writes past end of device */
1771 if ((to + ops->len) > mtd->size) {
1772 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_oob: "
1773 "Attempt read beyond end of device\n");
1774 return -EINVAL;
1775 }
1776
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001777 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001778
1779 switch(ops->mode) {
1780 case MTD_OOB_PLACE:
1781 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001782 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001783 break;
1784
1785 default:
1786 goto out;
1787 }
1788
1789 if (!ops->datbuf)
1790 ret = nand_do_write_oob(mtd, to, ops);
1791 else
1792 ret = nand_do_write_ops(mtd, to, ops);
1793
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001794 out:
1795 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 return ret;
1797}
1798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 * single_erease_cmd - [GENERIC] NAND standard block erase command function
1801 * @mtd: MTD device structure
1802 * @page: the page address of the block which will be erased
1803 *
1804 * Standard erase command for NAND chips
1805 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001806static void single_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001808 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001810 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
1811 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812}
1813
1814/**
1815 * multi_erease_cmd - [GENERIC] AND specific block erase command function
1816 * @mtd: MTD device structure
1817 * @page: the page address of the block which will be erased
1818 *
1819 * AND multi block erase command function
1820 * Erase 4 consecutive blocks
1821 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001822static void multi_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001824 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001826 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
1827 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
1828 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
1829 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
1830 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831}
1832
1833/**
1834 * nand_erase - [MTD Interface] erase block(s)
1835 * @mtd: MTD device structure
1836 * @instr: erase instruction
1837 *
1838 * Erase one ore more blocks
1839 */
David Woodhousee0c7d762006-05-13 18:07:53 +01001840static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841{
David Woodhousee0c7d762006-05-13 18:07:53 +01001842 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001844
David A. Marlin30f464b2005-01-17 18:35:25 +00001845#define BBT_PAGE_MASK 0xffffff3f
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001847 * nand_erase_nand - [Internal] erase block(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 * @mtd: MTD device structure
1849 * @instr: erase instruction
1850 * @allowbbt: allow erasing the bbt area
1851 *
1852 * Erase one ore more blocks
1853 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001854int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
1855 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856{
1857 int page, len, status, pages_per_block, ret, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001858 struct nand_chip *chip = mtd->priv;
1859 int rewrite_bbt[NAND_MAX_CHIPS]={0};
1860 unsigned int bbt_masked_page = 0xffffffff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001862 DEBUG(MTD_DEBUG_LEVEL3, "nand_erase: start = 0x%08x, len = %i\n",
1863 (unsigned int)instr->addr, (unsigned int)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864
1865 /* Start address must align on block boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001866 if (instr->addr & ((1 << chip->phys_erase_shift) - 1)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01001867 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Unaligned address\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 return -EINVAL;
1869 }
1870
1871 /* Length must align on block boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001872 if (instr->len & ((1 << chip->phys_erase_shift) - 1)) {
1873 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
1874 "Length not block aligned\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 return -EINVAL;
1876 }
1877
1878 /* Do not allow erase past end of device */
1879 if ((instr->len + instr->addr) > mtd->size) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001880 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
1881 "Erase past end of device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 return -EINVAL;
1883 }
1884
1885 instr->fail_addr = 0xffffffff;
1886
1887 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001888 nand_get_device(chip, mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
1890 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001891 page = (int)(instr->addr >> chip->page_shift);
1892 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
1894 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001895 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
1897 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001898 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 /* Check, if it is write protected */
1901 if (nand_check_wp(mtd)) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001902 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
1903 "Device is write protected!!!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 instr->state = MTD_ERASE_FAILED;
1905 goto erase_exit;
1906 }
1907
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001908 /*
1909 * If BBT requires refresh, set the BBT page mask to see if the BBT
1910 * should be rewritten. Otherwise the mask is set to 0xffffffff which
1911 * can not be matched. This is also done when the bbt is actually
1912 * erased to avoid recusrsive updates
1913 */
1914 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
1915 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
David A. Marlin30f464b2005-01-17 18:35:25 +00001916
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 /* Loop through the pages */
1918 len = instr->len;
1919
1920 instr->state = MTD_ERASING;
1921
1922 while (len) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001923 /*
1924 * heck if we have a bad block, we do not erase bad blocks !
1925 */
1926 if (nand_block_checkbad(mtd, ((loff_t) page) <<
1927 chip->page_shift, 0, allowbbt)) {
1928 printk(KERN_WARNING "nand_erase: attempt to erase a "
1929 "bad block at page 0x%08x\n", page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 instr->state = MTD_ERASE_FAILED;
1931 goto erase_exit;
1932 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001933
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001934 /*
1935 * Invalidate the page cache, if we erase the block which
1936 * contains the current cached page
1937 */
1938 if (page <= chip->pagebuf && chip->pagebuf <
1939 (page + pages_per_block))
1940 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001942 chip->erase_cmd(mtd, page & chip->pagemask);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001943
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001944 status = chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001946 /*
1947 * See if operation failed and additional status checks are
1948 * available
1949 */
1950 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
1951 status = chip->errstat(mtd, chip, FL_ERASING,
1952 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00001953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00001955 if (status & NAND_STATUS_FAIL) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001956 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
1957 "Failed erase, page 0x%08x\n", page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 instr->state = MTD_ERASE_FAILED;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001959 instr->fail_addr = (page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 goto erase_exit;
1961 }
David A. Marlin30f464b2005-01-17 18:35:25 +00001962
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001963 /*
1964 * If BBT requires refresh, set the BBT rewrite flag to the
1965 * page being erased
1966 */
1967 if (bbt_masked_page != 0xffffffff &&
1968 (page & BBT_PAGE_MASK) == bbt_masked_page)
1969 rewrite_bbt[chipnr] = (page << chip->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001970
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 /* Increment page address and decrement length */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001972 len -= (1 << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 page += pages_per_block;
1974
1975 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001976 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001978 chip->select_chip(mtd, -1);
1979 chip->select_chip(mtd, chipnr);
David A. Marlin30f464b2005-01-17 18:35:25 +00001980
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001981 /*
1982 * If BBT requires refresh and BBT-PERCHIP, set the BBT
1983 * page mask to see if this BBT should be rewritten
1984 */
1985 if (bbt_masked_page != 0xffffffff &&
1986 (chip->bbt_td->options & NAND_BBT_PERCHIP))
1987 bbt_masked_page = chip->bbt_td->pages[chipnr] &
1988 BBT_PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 }
1990 }
1991 instr->state = MTD_ERASE_DONE;
1992
David Woodhousee0c7d762006-05-13 18:07:53 +01001993 erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994
1995 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
1996 /* Do call back function */
1997 if (!ret)
1998 mtd_erase_callback(instr);
1999
2000 /* Deselect and wake up anyone waiting on the device */
2001 nand_release_device(mtd);
2002
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002003 /*
2004 * If BBT requires refresh and erase was successful, rewrite any
2005 * selected bad block tables
2006 */
2007 if (bbt_masked_page == 0xffffffff || ret)
2008 return ret;
2009
2010 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2011 if (!rewrite_bbt[chipnr])
2012 continue;
2013 /* update the BBT for chip */
2014 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase_nand: nand_update_bbt "
2015 "(%d:0x%0x 0x%0x)\n", chipnr, rewrite_bbt[chipnr],
2016 chip->bbt_td->pages[chipnr]);
2017 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
David A. Marlin30f464b2005-01-17 18:35:25 +00002018 }
2019
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 /* Return more or less happy */
2021 return ret;
2022}
2023
2024/**
2025 * nand_sync - [MTD Interface] sync
2026 * @mtd: MTD device structure
2027 *
2028 * Sync is actually a wait for chip ready function
2029 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002030static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002032 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
David Woodhousee0c7d762006-05-13 18:07:53 +01002034 DEBUG(MTD_DEBUG_LEVEL3, "nand_sync: called\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
2036 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002037 nand_get_device(chip, mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01002039 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040}
2041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002043 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07002045 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002047static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048{
2049 /* Check for invalid offset */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002050 if (offs > mtd->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 return -EINVAL;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002052
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002053 return nand_block_checkbad(mtd, offs, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054}
2055
2056/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002057 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 * @mtd: MTD device structure
2059 * @ofs: offset relative to mtd start
2060 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002061static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002063 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 int ret;
2065
David Woodhousee0c7d762006-05-13 18:07:53 +01002066 if ((ret = nand_block_isbad(mtd, ofs))) {
2067 /* If it was bad already, return success and do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 if (ret > 0)
2069 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01002070 return ret;
2071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002073 return chip->block_markbad(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074}
2075
2076/**
Vitaly Wool962034f2005-09-15 14:58:53 +01002077 * nand_suspend - [MTD Interface] Suspend the NAND flash
2078 * @mtd: MTD device structure
2079 */
2080static int nand_suspend(struct mtd_info *mtd)
2081{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002082 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002083
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002084 return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01002085}
2086
2087/**
2088 * nand_resume - [MTD Interface] Resume the NAND flash
2089 * @mtd: MTD device structure
2090 */
2091static void nand_resume(struct mtd_info *mtd)
2092{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002093 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002094
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002095 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01002096 nand_release_device(mtd);
2097 else
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +02002098 printk(KERN_ERR "nand_resume() called for a chip which is not "
2099 "in suspended state\n");
Vitaly Wool962034f2005-09-15 14:58:53 +01002100}
2101
Thomas Gleixnera36ed292006-05-23 11:37:03 +02002102/*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002103 * Set default functions
2104 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002105static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002106{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002108 if (!chip->chip_delay)
2109 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
2111 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002112 if (chip->cmdfunc == NULL)
2113 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114
2115 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002116 if (chip->waitfunc == NULL)
2117 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002119 if (!chip->select_chip)
2120 chip->select_chip = nand_select_chip;
2121 if (!chip->read_byte)
2122 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2123 if (!chip->read_word)
2124 chip->read_word = nand_read_word;
2125 if (!chip->block_bad)
2126 chip->block_bad = nand_block_bad;
2127 if (!chip->block_markbad)
2128 chip->block_markbad = nand_default_block_markbad;
2129 if (!chip->write_buf)
2130 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2131 if (!chip->read_buf)
2132 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2133 if (!chip->verify_buf)
2134 chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2135 if (!chip->scan_bbt)
2136 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002137
2138 if (!chip->controller) {
2139 chip->controller = &chip->hwcontrol;
2140 spin_lock_init(&chip->controller->lock);
2141 init_waitqueue_head(&chip->controller->wq);
2142 }
2143
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002144}
2145
2146/*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002147 * Get the flash and manufacturer id and lookup if the type is supported
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002148 */
2149static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002150 struct nand_chip *chip,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002151 int busw, int *maf_id)
2152{
2153 struct nand_flash_dev *type = NULL;
2154 int i, dev_id, maf_idx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
2156 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002157 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158
2159 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002160 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161
2162 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002163 *maf_id = chip->read_byte(mtd);
2164 dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002166 /* Lookup the flash id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 for (i = 0; nand_flash_ids[i].name != NULL; i++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002168 if (dev_id == nand_flash_ids[i].id) {
2169 type = &nand_flash_ids[i];
2170 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 }
2173
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002174 if (!type)
2175 return ERR_PTR(-ENODEV);
2176
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002177 if (!mtd->name)
2178 mtd->name = type->name;
2179
2180 chip->chipsize = type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002181
2182 /* Newer devices have all the information in additional id bytes */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002183 if (!type->pagesize) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002184 int extid;
2185 /* The 3rd id byte contains non relevant data ATM */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002186 extid = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002187 /* The 4th id byte is the important one */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002188 extid = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002189 /* Calc pagesize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002190 mtd->writesize = 1024 << (extid & 0x3);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002191 extid >>= 2;
2192 /* Calc oobsize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002193 mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002194 extid >>= 2;
2195 /* Calc blocksize. Blocksize is multiples of 64KiB */
2196 mtd->erasesize = (64 * 1024) << (extid & 0x03);
2197 extid >>= 2;
2198 /* Get buswidth information */
2199 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2200
2201 } else {
2202 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002203 * Old devices have chip data hardcoded in the device id table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002204 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002205 mtd->erasesize = type->erasesize;
2206 mtd->writesize = type->pagesize;
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002207 mtd->oobsize = mtd->writesize / 32;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002208 busw = type->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002209 }
2210
2211 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01002212 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002213 if (nand_manuf_ids[maf_idx].id == *maf_id)
2214 break;
2215 }
2216
2217 /*
2218 * Check, if buswidth is correct. Hardware drivers should set
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002219 * chip correct !
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002220 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002221 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002222 printk(KERN_INFO "NAND device: Manufacturer ID:"
2223 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
2224 dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
2225 printk(KERN_WARNING "NAND bus width %d instead %d bit\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002226 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002227 busw ? 16 : 8);
2228 return ERR_PTR(-EINVAL);
2229 }
2230
2231 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002232 chip->page_shift = ffs(mtd->writesize) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002233 /* Convert chipsize to number of pages per chip -1. */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002234 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002235
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002236 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002237 ffs(mtd->erasesize) - 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002238 chip->chip_shift = ffs(chip->chipsize) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002239
2240 /* Set the bad block position */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002241 chip->badblockpos = mtd->writesize > 512 ?
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002242 NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2243
2244 /* Get chip options, preserve non chip based options */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002245 chip->options &= ~NAND_CHIPOPTIONS_MSK;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002246 chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002247
2248 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002249 * Set chip as a default. Board drivers can override it, if necessary
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002250 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002251 chip->options |= NAND_NO_AUTOINCR;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002252
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002253 /* Check if chip is a not a samsung device. Do not clear the
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002254 * options for chips which are not having an extended id.
2255 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002256 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002257 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002258
2259 /* Check for AND chips with 4 page planes */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002260 if (chip->options & NAND_4PAGE_ARRAY)
2261 chip->erase_cmd = multi_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002262 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002263 chip->erase_cmd = single_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002264
2265 /* Do not replace user supplied command function ! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002266 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
2267 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002268
2269 printk(KERN_INFO "NAND device: Manufacturer ID:"
2270 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id, dev_id,
2271 nand_manuf_ids[maf_idx].name, type->name);
2272
2273 return type;
2274}
2275
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002276/**
David Woodhouse3b85c322006-09-25 17:06:53 +01002277 * nand_scan_ident - [NAND Interface] Scan for the NAND device
2278 * @mtd: MTD device structure
2279 * @maxchips: Number of chips to scan for
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002280 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002281 * This is the first phase of the normal nand_scan() function. It
2282 * reads the flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002283 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002284 * The mtd->owner field must be set to the module of the caller.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002285 */
David Woodhouse3b85c322006-09-25 17:06:53 +01002286int nand_scan_ident(struct mtd_info *mtd, int maxchips)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002287{
2288 int i, busw, nand_maf_id;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002289 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002290 struct nand_flash_dev *type;
2291
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002292 /* Get buswidth to select the correct functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002293 busw = chip->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002294 /* Set the default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002295 nand_set_defaults(chip, busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002296
2297 /* Read the flash type */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002298 type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002299
2300 if (IS_ERR(type)) {
David Woodhousee0c7d762006-05-13 18:07:53 +01002301 printk(KERN_WARNING "No NAND device found!!!\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002302 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002303 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 }
2305
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002306 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01002307 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002308 chip->select_chip(mtd, i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002310 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002312 if (nand_maf_id != chip->read_byte(mtd) ||
2313 type->id != chip->read_byte(mtd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 break;
2315 }
2316 if (i > 1)
2317 printk(KERN_INFO "%d NAND chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002318
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002320 chip->numchips = i;
2321 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322
David Woodhouse3b85c322006-09-25 17:06:53 +01002323 return 0;
2324}
2325
2326
2327/**
2328 * nand_scan_tail - [NAND Interface] Scan for the NAND device
2329 * @mtd: MTD device structure
2330 * @maxchips: Number of chips to scan for
2331 *
2332 * This is the second phase of the normal nand_scan() function. It
2333 * fills out all the uninitialized function pointers with the defaults
2334 * and scans for a bad block table if appropriate.
2335 */
2336int nand_scan_tail(struct mtd_info *mtd)
2337{
2338 int i;
2339 struct nand_chip *chip = mtd->priv;
2340
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002341 if (!(chip->options & NAND_OWN_BUFFERS))
2342 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
2343 if (!chip->buffers)
2344 return -ENOMEM;
2345
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01002346 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01002347 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002348
2349 /*
2350 * If no default placement scheme is given, select an appropriate one
2351 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002352 if (!chip->ecc.layout) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002353 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 case 8:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002355 chip->ecc.layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 break;
2357 case 16:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002358 chip->ecc.layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 break;
2360 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002361 chip->ecc.layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 break;
2363 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002364 printk(KERN_WARNING "No oob scheme defined for "
2365 "oobsize %d\n", mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 BUG();
2367 }
2368 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002369
David Woodhouse956e9442006-09-25 17:12:39 +01002370 if (!chip->write_page)
2371 chip->write_page = nand_write_page;
2372
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002373 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002374 * check ECC mode, default to software if 3byte/512byte hardware ECC is
2375 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01002376 */
David Woodhouse956e9442006-09-25 17:12:39 +01002377 if (!chip->ecc.read_page_raw)
2378 chip->ecc.read_page_raw = nand_read_page_raw;
2379 if (!chip->ecc.write_page_raw)
2380 chip->ecc.write_page_raw = nand_write_page_raw;
2381
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002382 switch (chip->ecc.mode) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002383 case NAND_ECC_HW:
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002384 /* Use standard hwecc read page function ? */
2385 if (!chip->ecc.read_page)
2386 chip->ecc.read_page = nand_read_page_hwecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002387 if (!chip->ecc.write_page)
2388 chip->ecc.write_page = nand_write_page_hwecc;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002389 if (!chip->ecc.read_oob)
2390 chip->ecc.read_oob = nand_read_oob_std;
2391 if (!chip->ecc.write_oob)
2392 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002393
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002394 case NAND_ECC_HW_SYNDROME:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002395 if (!chip->ecc.calculate || !chip->ecc.correct ||
2396 !chip->ecc.hwctl) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002397 printk(KERN_WARNING "No ECC functions supplied, "
2398 "Hardware ECC not possible\n");
2399 BUG();
2400 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002401 /* Use standard syndrome read/write page function ? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002402 if (!chip->ecc.read_page)
2403 chip->ecc.read_page = nand_read_page_syndrome;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002404 if (!chip->ecc.write_page)
2405 chip->ecc.write_page = nand_write_page_syndrome;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002406 if (!chip->ecc.read_oob)
2407 chip->ecc.read_oob = nand_read_oob_syndrome;
2408 if (!chip->ecc.write_oob)
2409 chip->ecc.write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002410
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002411 if (mtd->writesize >= chip->ecc.size)
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002412 break;
2413 printk(KERN_WARNING "%d byte HW ECC not possible on "
2414 "%d byte page size, fallback to SW ECC\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002415 chip->ecc.size, mtd->writesize);
2416 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002418 case NAND_ECC_SOFT:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002419 chip->ecc.calculate = nand_calculate_ecc;
2420 chip->ecc.correct = nand_correct_data;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002421 chip->ecc.read_page = nand_read_page_swecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002422 chip->ecc.write_page = nand_write_page_swecc;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002423 chip->ecc.read_oob = nand_read_oob_std;
2424 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002425 chip->ecc.size = 256;
2426 chip->ecc.bytes = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002428
2429 case NAND_ECC_NONE:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002430 printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
2431 "This is not recommended !!\n");
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002432 chip->ecc.read_page = nand_read_page_raw;
2433 chip->ecc.write_page = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002434 chip->ecc.read_oob = nand_read_oob_std;
2435 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002436 chip->ecc.size = mtd->writesize;
2437 chip->ecc.bytes = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 break;
David Woodhouse956e9442006-09-25 17:12:39 +01002439
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002441 printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002442 chip->ecc.mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002443 BUG();
2444 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002446 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002447 * The number of bytes available for a client to place data into
2448 * the out of band area
2449 */
2450 chip->ecc.layout->oobavail = 0;
2451 for (i = 0; chip->ecc.layout->oobfree[i].length; i++)
2452 chip->ecc.layout->oobavail +=
2453 chip->ecc.layout->oobfree[i].length;
2454
2455 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002456 * Set the number of read / write steps for one page depending on ECC
2457 * mode
2458 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002459 chip->ecc.steps = mtd->writesize / chip->ecc.size;
2460 if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002461 printk(KERN_WARNING "Invalid ecc parameters\n");
2462 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002464 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002465
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02002466 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002467 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468
2469 /* De-select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002470 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471
2472 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002473 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475 /* Fill in remaining MTD driver data */
2476 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02002477 mtd->flags = MTD_CAP_NANDFLASH;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 mtd->ecctype = MTD_ECC_SW;
2479 mtd->erase = nand_erase;
2480 mtd->point = NULL;
2481 mtd->unpoint = NULL;
2482 mtd->read = nand_read;
2483 mtd->write = nand_write;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 mtd->read_oob = nand_read_oob;
2485 mtd->write_oob = nand_write_oob;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 mtd->sync = nand_sync;
2487 mtd->lock = NULL;
2488 mtd->unlock = NULL;
Vitaly Wool962034f2005-09-15 14:58:53 +01002489 mtd->suspend = nand_suspend;
2490 mtd->resume = nand_resume;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 mtd->block_isbad = nand_block_isbad;
2492 mtd->block_markbad = nand_block_markbad;
2493
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002494 /* propagate ecc.layout to mtd_info */
2495 mtd->ecclayout = chip->ecc.layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496
Thomas Gleixner0040bf32005-02-09 12:20:00 +00002497 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002498 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00002499 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500
2501 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002502 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503}
2504
David Woodhouse3b85c322006-09-25 17:06:53 +01002505/* module_text_address() isn't exported, and it's mostly a pointless
2506 test if this is a module _anyway_ -- they'd have to try _really_ hard
2507 to call us from in-kernel code if the core NAND support is modular. */
2508#ifdef MODULE
2509#define caller_is_module() (1)
2510#else
2511#define caller_is_module() \
2512 module_text_address((unsigned long)__builtin_return_address(0))
2513#endif
2514
2515/**
2516 * nand_scan - [NAND Interface] Scan for the NAND device
2517 * @mtd: MTD device structure
2518 * @maxchips: Number of chips to scan for
2519 *
2520 * This fills out all the uninitialized function pointers
2521 * with the defaults.
2522 * The flash ID is read and the mtd/chip structures are
2523 * filled with the appropriate values.
2524 * The mtd->owner field must be set to the module of the caller
2525 *
2526 */
2527int nand_scan(struct mtd_info *mtd, int maxchips)
2528{
2529 int ret;
2530
2531 /* Many callers got this wrong, so check for it for a while... */
2532 if (!mtd->owner && caller_is_module()) {
2533 printk(KERN_CRIT "nand_scan() called with NULL mtd->owner!\n");
2534 BUG();
2535 }
2536
2537 ret = nand_scan_ident(mtd, maxchips);
2538 if (!ret)
2539 ret = nand_scan_tail(mtd);
2540 return ret;
2541}
2542
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002544 * nand_release - [NAND Interface] Free resources held by the NAND device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 * @mtd: MTD device structure
2546*/
David Woodhousee0c7d762006-05-13 18:07:53 +01002547void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002549 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
2551#ifdef CONFIG_MTD_PARTITIONS
2552 /* Deregister partitions */
David Woodhousee0c7d762006-05-13 18:07:53 +01002553 del_mtd_partitions(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554#endif
2555 /* Deregister the device */
David Woodhousee0c7d762006-05-13 18:07:53 +01002556 del_mtd_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557
Jesper Juhlfa671642005-11-07 01:01:27 -08002558 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002559 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002560 if (!(chip->options & NAND_OWN_BUFFERS))
2561 kfree(chip->buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562}
2563
David Woodhousee0c7d762006-05-13 18:07:53 +01002564EXPORT_SYMBOL_GPL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01002565EXPORT_SYMBOL_GPL(nand_scan_ident);
2566EXPORT_SYMBOL_GPL(nand_scan_tail);
David Woodhousee0c7d762006-05-13 18:07:53 +01002567EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08002568
2569static int __init nand_base_init(void)
2570{
2571 led_trigger_register_simple("nand-disk", &nand_led_trigger);
2572 return 0;
2573}
2574
2575static void __exit nand_base_exit(void)
2576{
2577 led_trigger_unregister_simple(nand_led_trigger);
2578}
2579
2580module_init(nand_base_init);
2581module_exit(nand_base_exit);
2582
David Woodhousee0c7d762006-05-13 18:07:53 +01002583MODULE_LICENSE("GPL");
2584MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
2585MODULE_DESCRIPTION("Generic NAND flash driver code");