blob: 2dfeb4bea83a0babfc248a675477216054e7df0d [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
maximilian attems8b2b4032007-07-28 13:07:16 +020010 * http://www.linux-mtd.infradead.org/doc/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.
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +030027 * BBT table is not serialized, has to be fixed
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License version 2 as
31 * published by the Free Software Foundation.
32 *
33 */
34
David Woodhouse552d9202006-05-14 01:20:46 +010035#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/delay.h>
37#include <linux/errno.h>
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +020038#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/sched.h>
40#include <linux/slab.h>
41#include <linux/types.h>
42#include <linux/mtd/mtd.h>
43#include <linux/mtd/nand.h>
44#include <linux/mtd/nand_ecc.h>
45#include <linux/mtd/compatmac.h>
46#include <linux/interrupt.h>
47#include <linux/bitops.h>
Richard Purdie8fe833c2006-03-31 02:31:14 -080048#include <linux/leds.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <asm/io.h>
50
51#ifdef CONFIG_MTD_PARTITIONS
52#include <linux/mtd/partitions.h>
53#endif
54
55/* Define default oob placement schemes for large and small page devices */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020056static struct nand_ecclayout nand_oob_8 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 .eccbytes = 3,
58 .eccpos = {0, 1, 2},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020059 .oobfree = {
60 {.offset = 3,
61 .length = 2},
62 {.offset = 6,
63 .length = 2}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070064};
65
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020066static struct nand_ecclayout nand_oob_16 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 .eccbytes = 6,
68 .eccpos = {0, 1, 2, 3, 6, 7},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020069 .oobfree = {
70 {.offset = 8,
71 . length = 8}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020074static struct nand_ecclayout nand_oob_64 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 .eccbytes = 24,
76 .eccpos = {
David Woodhousee0c7d762006-05-13 18:07:53 +010077 40, 41, 42, 43, 44, 45, 46, 47,
78 48, 49, 50, 51, 52, 53, 54, 55,
79 56, 57, 58, 59, 60, 61, 62, 63},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020080 .oobfree = {
81 {.offset = 2,
82 .length = 38}}
Linus Torvalds1da177e2005-04-16 15:20:36 -070083};
84
Thomas Gleixner81ec5362007-12-12 17:27:03 +010085static struct nand_ecclayout nand_oob_128 = {
86 .eccbytes = 48,
87 .eccpos = {
88 80, 81, 82, 83, 84, 85, 86, 87,
89 88, 89, 90, 91, 92, 93, 94, 95,
90 96, 97, 98, 99, 100, 101, 102, 103,
91 104, 105, 106, 107, 108, 109, 110, 111,
92 112, 113, 114, 115, 116, 117, 118, 119,
93 120, 121, 122, 123, 124, 125, 126, 127},
94 .oobfree = {
95 {.offset = 2,
96 .length = 78}}
97};
98
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020099static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200100 int new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200102static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
103 struct mtd_oob_ops *ops);
104
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200105/*
Joe Perches8e87d782008-02-03 17:22:34 +0200106 * For devices which display every fart in the system on a separate LED. Is
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200107 * compiled away when LED support is disabled.
108 */
109DEFINE_LED_TRIGGER(nand_led_trigger);
110
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530111static int check_offs_len(struct mtd_info *mtd,
112 loff_t ofs, uint64_t len)
113{
114 struct nand_chip *chip = mtd->priv;
115 int ret = 0;
116
117 /* Start address must align on block boundary */
118 if (ofs & ((1 << chip->phys_erase_shift) - 1)) {
119 DEBUG(MTD_DEBUG_LEVEL0, "%s: Unaligned address\n", __func__);
120 ret = -EINVAL;
121 }
122
123 /* Length must align on block boundary */
124 if (len & ((1 << chip->phys_erase_shift) - 1)) {
125 DEBUG(MTD_DEBUG_LEVEL0, "%s: Length not block aligned\n",
126 __func__);
127 ret = -EINVAL;
128 }
129
130 /* Do not allow past end of device */
131 if (ofs + len > mtd->size) {
132 DEBUG(MTD_DEBUG_LEVEL0, "%s: Past end of device\n",
133 __func__);
134 ret = -EINVAL;
135 }
136
137 return ret;
138}
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140/**
141 * nand_release_device - [GENERIC] release chip
142 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000143 *
144 * Deselect, release chip lock and wake up anyone waiting on the device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100146static void nand_release_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200148 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 /* De-select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200151 chip->select_chip(mtd, -1);
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100152
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200153 /* Release the controller and the chip */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200154 spin_lock(&chip->controller->lock);
155 chip->controller->active = NULL;
156 chip->state = FL_READY;
157 wake_up(&chip->controller->wq);
158 spin_unlock(&chip->controller->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159}
160
161/**
162 * nand_read_byte - [DEFAULT] read one byte from the chip
163 * @mtd: MTD device structure
164 *
165 * Default read function for 8bit buswith
166 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200167static uint8_t nand_read_byte(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200169 struct nand_chip *chip = mtd->priv;
170 return readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
173/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
175 * @mtd: MTD device structure
176 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000177 * Default read function for 16bit buswith with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * endianess conversion
179 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200180static uint8_t nand_read_byte16(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200182 struct nand_chip *chip = mtd->priv;
183 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184}
185
186/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 * nand_read_word - [DEFAULT] read one word from the chip
188 * @mtd: MTD device structure
189 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000190 * Default read function for 16bit buswith without
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * endianess conversion
192 */
193static u16 nand_read_word(struct mtd_info *mtd)
194{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200195 struct nand_chip *chip = mtd->priv;
196 return readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * nand_select_chip - [DEFAULT] control CE line
201 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700202 * @chipnr: chipnumber to select, -1 for deselect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 *
204 * Default select function for 1 chip devices.
205 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200206static void nand_select_chip(struct mtd_info *mtd, int chipnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200208 struct nand_chip *chip = mtd->priv;
209
210 switch (chipnr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 case -1:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200212 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 break;
214 case 0:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 break;
216
217 default:
218 BUG();
219 }
220}
221
222/**
223 * nand_write_buf - [DEFAULT] write buffer to chip
224 * @mtd: MTD device structure
225 * @buf: data buffer
226 * @len: number of bytes to write
227 *
228 * Default write function for 8bit buswith
229 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200230static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
232 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200233 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
David Woodhousee0c7d762006-05-13 18:07:53 +0100235 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200236 writeb(buf[i], chip->IO_ADDR_W);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237}
238
239/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000240 * nand_read_buf - [DEFAULT] read chip data into buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * @mtd: MTD device structure
242 * @buf: buffer to store date
243 * @len: number of bytes to read
244 *
245 * Default read function for 8bit buswith
246 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200247static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
249 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200250 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
David Woodhousee0c7d762006-05-13 18:07:53 +0100252 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200253 buf[i] = readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
256/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000257 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 * @mtd: MTD device structure
259 * @buf: buffer containing the data to compare
260 * @len: number of bytes to compare
261 *
262 * Default verify function for 8bit buswith
263 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200264static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
266 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200267 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
David Woodhousee0c7d762006-05-13 18:07:53 +0100269 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200270 if (buf[i] != readb(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 return 0;
273}
274
275/**
276 * nand_write_buf16 - [DEFAULT] write buffer to chip
277 * @mtd: MTD device structure
278 * @buf: data buffer
279 * @len: number of bytes to write
280 *
281 * Default write function for 16bit buswith
282 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200283static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200286 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 u16 *p = (u16 *) buf;
288 len >>= 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000289
David Woodhousee0c7d762006-05-13 18:07:53 +0100290 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200291 writew(p[i], chip->IO_ADDR_W);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
295/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000296 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 * @mtd: MTD device structure
298 * @buf: buffer to store date
299 * @len: number of bytes to read
300 *
301 * Default read function for 16bit buswith
302 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200303static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304{
305 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200306 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 u16 *p = (u16 *) buf;
308 len >>= 1;
309
David Woodhousee0c7d762006-05-13 18:07:53 +0100310 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200311 p[i] = readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000315 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 * @mtd: MTD device structure
317 * @buf: buffer containing the data to compare
318 * @len: number of bytes to compare
319 *
320 * Default verify function for 16bit buswith
321 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200322static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
324 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200325 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 u16 *p = (u16 *) buf;
327 len >>= 1;
328
David Woodhousee0c7d762006-05-13 18:07:53 +0100329 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200330 if (p[i] != readw(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 return -EFAULT;
332
333 return 0;
334}
335
336/**
337 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
338 * @mtd: MTD device structure
339 * @ofs: offset from device start
340 * @getchip: 0, if the chip is already selected
341 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000342 * Check, if the block is bad.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 */
344static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
345{
346 int page, chipnr, res = 0;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200347 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 u16 bad;
349
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100350 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 if (getchip) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200353 chipnr = (int)(ofs >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200355 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200358 chip->select_chip(mtd, chipnr);
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200361 if (chip->options & NAND_BUSWIDTH_16) {
362 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100363 page);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200364 bad = cpu_to_le16(chip->read_word(mtd));
365 if (chip->badblockpos & 0x1)
Vitaly Wool49196f32005-11-02 16:54:46 +0000366 bad >>= 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 if ((bad & 0xFF) != 0xff)
368 res = 1;
369 } else {
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100370 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos, page);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200371 if (chip->read_byte(mtd) != 0xff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 res = 1;
373 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000374
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200375 if (getchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 nand_release_device(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 return res;
379}
380
381/**
382 * nand_default_block_markbad - [DEFAULT] mark a block bad
383 * @mtd: MTD device structure
384 * @ofs: offset from device start
385 *
386 * This is the default implementation, which can be overridden by
387 * a hardware specific driver.
388*/
389static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
390{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200391 struct nand_chip *chip = mtd->priv;
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200392 uint8_t buf[2] = { 0, 0 };
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200393 int block, ret;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 /* Get block number */
Andre Renaud4226b512007-04-17 13:50:59 -0400396 block = (int)(ofs >> chip->bbt_erase_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200397 if (chip->bbt)
398 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400 /* Do we have a flash based bad block table ? */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200401 if (chip->options & NAND_USE_FLASH_BBT)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200402 ret = nand_update_bbt(mtd, ofs);
403 else {
404 /* We write two bytes, so we dont have to mess with 16 bit
405 * access
406 */
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300407 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200408 ofs += mtd->oobsize;
Ricard Wanderlöfff0dab62006-10-23 09:33:34 +0200409 chip->ops.len = chip->ops.ooblen = 2;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200410 chip->ops.datbuf = NULL;
411 chip->ops.oobbuf = buf;
412 chip->ops.ooboffs = chip->badblockpos & ~0x01;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000413
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200414 ret = nand_do_write_oob(mtd, ofs, &chip->ops);
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300415 nand_release_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200416 }
417 if (!ret)
418 mtd->ecc_stats.badblocks++;
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300419
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200420 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000423/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 * nand_check_wp - [GENERIC] check if the chip is write protected
425 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000426 * Check, if the device is write protected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000428 * The function expects, that the device is already selected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100430static int nand_check_wp(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200432 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 /* Check the WP bit */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200434 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
435 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436}
437
438/**
439 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
440 * @mtd: MTD device structure
441 * @ofs: offset from device start
442 * @getchip: 0, if the chip is already selected
443 * @allowbbt: 1, if its allowed to access the bbt area
444 *
445 * Check, if the block is bad. Either by reading the bad block table or
446 * calling of the scan function.
447 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200448static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
449 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200451 struct nand_chip *chip = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000452
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200453 if (!chip->bbt)
454 return chip->block_bad(mtd, ofs, getchip);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 /* Return info from the table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100457 return nand_isbad_bbt(mtd, ofs, allowbbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
459
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200460/**
461 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
462 * @mtd: MTD device structure
463 * @timeo: Timeout
464 *
465 * Helper function for nand_wait_ready used when needing to wait in interrupt
466 * context.
467 */
468static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
469{
470 struct nand_chip *chip = mtd->priv;
471 int i;
472
473 /* Wait for the device to get ready */
474 for (i = 0; i < timeo; i++) {
475 if (chip->dev_ready(mtd))
476 break;
477 touch_softlockup_watchdog();
478 mdelay(1);
479 }
480}
481
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000482/*
Thomas Gleixner3b887752005-02-22 21:56:49 +0000483 * Wait for the ready pin, after a command
484 * The timeout is catched later.
485 */
David Woodhouse4b648b02006-09-25 17:05:24 +0100486void nand_wait_ready(struct mtd_info *mtd)
Thomas Gleixner3b887752005-02-22 21:56:49 +0000487{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200488 struct nand_chip *chip = mtd->priv;
David Woodhousee0c7d762006-05-13 18:07:53 +0100489 unsigned long timeo = jiffies + 2;
Thomas Gleixner3b887752005-02-22 21:56:49 +0000490
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200491 /* 400ms timeout */
492 if (in_interrupt() || oops_in_progress)
493 return panic_nand_wait_ready(mtd, 400);
494
Richard Purdie8fe833c2006-03-31 02:31:14 -0800495 led_trigger_event(nand_led_trigger, LED_FULL);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000496 /* wait until command is processed or timeout occures */
497 do {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200498 if (chip->dev_ready(mtd))
Richard Purdie8fe833c2006-03-31 02:31:14 -0800499 break;
Ingo Molnar8446f1d2005-09-06 15:16:27 -0700500 touch_softlockup_watchdog();
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000501 } while (time_before(jiffies, timeo));
Richard Purdie8fe833c2006-03-31 02:31:14 -0800502 led_trigger_event(nand_led_trigger, LED_OFF);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000503}
David Woodhouse4b648b02006-09-25 17:05:24 +0100504EXPORT_SYMBOL_GPL(nand_wait_ready);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506/**
507 * nand_command - [DEFAULT] Send command to NAND device
508 * @mtd: MTD device structure
509 * @command: the command to be sent
510 * @column: the column address for this command, -1 if none
511 * @page_addr: the page address for this command, -1 if none
512 *
513 * Send command to NAND device. This function is used for small page
514 * devices (256/512 Bytes per page)
515 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200516static void nand_command(struct mtd_info *mtd, unsigned int command,
517 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200519 register struct nand_chip *chip = mtd->priv;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200520 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 /*
523 * Write out the command to the device.
524 */
525 if (command == NAND_CMD_SEQIN) {
526 int readcmd;
527
Joern Engel28318772006-05-22 23:18:05 +0200528 if (column >= mtd->writesize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 /* OOB area */
Joern Engel28318772006-05-22 23:18:05 +0200530 column -= mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 readcmd = NAND_CMD_READOOB;
532 } else if (column < 256) {
533 /* First 256 bytes --> READ0 */
534 readcmd = NAND_CMD_READ0;
535 } else {
536 column -= 256;
537 readcmd = NAND_CMD_READ1;
538 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200539 chip->cmd_ctrl(mtd, readcmd, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200540 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200542 chip->cmd_ctrl(mtd, command, ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200544 /*
545 * Address cycle, when necessary
546 */
547 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
548 /* Serially input address */
549 if (column != -1) {
550 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200551 if (chip->options & NAND_BUSWIDTH_16)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200552 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200553 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200554 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 }
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200556 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200557 chip->cmd_ctrl(mtd, page_addr, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200558 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200559 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200560 /* One more address cycle for devices > 32MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200561 if (chip->chipsize > (32 << 20))
562 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200563 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200564 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000565
566 /*
567 * program and erase have their own busy handlers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 * status and sequential in needs no delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100569 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 case NAND_CMD_PAGEPROG:
573 case NAND_CMD_ERASE1:
574 case NAND_CMD_ERASE2:
575 case NAND_CMD_SEQIN:
576 case NAND_CMD_STATUS:
577 return;
578
579 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200580 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200582 udelay(chip->chip_delay);
583 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200584 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200585 chip->cmd_ctrl(mtd,
586 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200587 while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 return;
589
David Woodhousee0c7d762006-05-13 18:07:53 +0100590 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000592 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * If we don't have access to the busy pin, we apply the given
594 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100595 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200596 if (!chip->dev_ready) {
597 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000599 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 /* Apply this short delay always to ensure that we do wait tWB in
602 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100603 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000604
605 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
607
608/**
609 * nand_command_lp - [DEFAULT] Send command to NAND large page device
610 * @mtd: MTD device structure
611 * @command: the command to be sent
612 * @column: the column address for this command, -1 if none
613 * @page_addr: the page address for this command, -1 if none
614 *
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200615 * Send command to NAND device. This is the version for the new large page
616 * devices We dont have the separate regions as we have in the small page
617 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200619static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
620 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200622 register struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624 /* Emulate NAND_CMD_READOOB */
625 if (command == NAND_CMD_READOOB) {
Joern Engel28318772006-05-22 23:18:05 +0200626 column += mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 command = NAND_CMD_READ0;
628 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000629
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200630 /* Command latch cycle */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200631 chip->cmd_ctrl(mtd, command & 0xff,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200632 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634 if (column != -1 || page_addr != -1) {
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200635 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
637 /* Serially input address */
638 if (column != -1) {
639 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200640 if (chip->options & NAND_BUSWIDTH_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200642 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200643 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200644 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200647 chip->cmd_ctrl(mtd, page_addr, ctrl);
648 chip->cmd_ctrl(mtd, page_addr >> 8,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200649 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 /* One more address cycle for devices > 128MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200651 if (chip->chipsize > (128 << 20))
652 chip->cmd_ctrl(mtd, page_addr >> 16,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200653 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200656 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000657
658 /*
659 * program and erase have their own busy handlers
David A. Marlin30f464b2005-01-17 18:35:25 +0000660 * status, sequential in, and deplete1 need no delay
661 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 case NAND_CMD_CACHEDPROG:
665 case NAND_CMD_PAGEPROG:
666 case NAND_CMD_ERASE1:
667 case NAND_CMD_ERASE2:
668 case NAND_CMD_SEQIN:
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200669 case NAND_CMD_RNDIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 case NAND_CMD_STATUS:
David A. Marlin30f464b2005-01-17 18:35:25 +0000671 case NAND_CMD_DEPLETE1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 return;
673
David Woodhousee0c7d762006-05-13 18:07:53 +0100674 /*
675 * read error status commands require only a short delay
676 */
David A. Marlin30f464b2005-01-17 18:35:25 +0000677 case NAND_CMD_STATUS_ERROR:
678 case NAND_CMD_STATUS_ERROR0:
679 case NAND_CMD_STATUS_ERROR1:
680 case NAND_CMD_STATUS_ERROR2:
681 case NAND_CMD_STATUS_ERROR3:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200682 udelay(chip->chip_delay);
David A. Marlin30f464b2005-01-17 18:35:25 +0000683 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
685 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200686 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200688 udelay(chip->chip_delay);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200689 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
690 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
691 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
692 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200693 while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return;
695
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200696 case NAND_CMD_RNDOUT:
697 /* No ready / busy check necessary */
698 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
699 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
700 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
701 NAND_NCE | NAND_CTRL_CHANGE);
702 return;
703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 case NAND_CMD_READ0:
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200705 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
706 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
707 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
708 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000709
David Woodhousee0c7d762006-05-13 18:07:53 +0100710 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000712 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 * If we don't have access to the busy pin, we apply the given
714 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100715 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200716 if (!chip->dev_ready) {
717 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
Thomas Gleixner3b887752005-02-22 21:56:49 +0000721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 /* Apply this short delay always to ensure that we do wait tWB in
723 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100724 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000725
726 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727}
728
729/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200730 * panic_nand_get_device - [GENERIC] Get chip for selected access
731 * @chip: the nand chip descriptor
732 * @mtd: MTD device structure
733 * @new_state: the state which is requested
734 *
735 * Used when in panic, no locks are taken.
736 */
737static void panic_nand_get_device(struct nand_chip *chip,
738 struct mtd_info *mtd, int new_state)
739{
740 /* Hardware controller shared among independend devices */
741 chip->controller->active = chip;
742 chip->state = new_state;
743}
744
745/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 * nand_get_device - [GENERIC] Get chip for selected access
Randy Dunlap844d3b42006-06-28 21:48:27 -0700747 * @chip: the nand chip descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000749 * @new_state: the state which is requested
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 *
751 * Get the device and lock it for exclusive access
752 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200753static int
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200754nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200756 spinlock_t *lock = &chip->controller->lock;
757 wait_queue_head_t *wq = &chip->controller->wq;
David Woodhousee0c7d762006-05-13 18:07:53 +0100758 DECLARE_WAITQUEUE(wait, current);
David Woodhousee0c7d762006-05-13 18:07:53 +0100759 retry:
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100760 spin_lock(lock);
761
vimal singhb8b3ee92009-07-09 20:41:22 +0530762 /* Hardware controller shared among independent devices */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200763 if (!chip->controller->active)
764 chip->controller->active = chip;
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200765
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200766 if (chip->controller->active == chip && chip->state == FL_READY) {
767 chip->state = new_state;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100768 spin_unlock(lock);
Vitaly Wool962034f2005-09-15 14:58:53 +0100769 return 0;
770 }
771 if (new_state == FL_PM_SUSPENDED) {
Li Yang6b0d9a82009-11-17 14:45:49 -0800772 if (chip->controller->active->state == FL_PM_SUSPENDED) {
773 chip->state = FL_PM_SUSPENDED;
774 spin_unlock(lock);
775 return 0;
776 } else {
777 spin_unlock(lock);
778 return -EAGAIN;
779 }
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100780 }
781 set_current_state(TASK_UNINTERRUPTIBLE);
782 add_wait_queue(wq, &wait);
783 spin_unlock(lock);
784 schedule();
785 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 goto retry;
787}
788
789/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200790 * panic_nand_wait - [GENERIC] wait until the command is done
791 * @mtd: MTD device structure
792 * @chip: NAND chip structure
793 * @timeo: Timeout
794 *
795 * Wait for command done. This is a helper function for nand_wait used when
796 * we are in interrupt context. May happen when in panic and trying to write
797 * an oops trough mtdoops.
798 */
799static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
800 unsigned long timeo)
801{
802 int i;
803 for (i = 0; i < timeo; i++) {
804 if (chip->dev_ready) {
805 if (chip->dev_ready(mtd))
806 break;
807 } else {
808 if (chip->read_byte(mtd) & NAND_STATUS_READY)
809 break;
810 }
811 mdelay(1);
812 }
813}
814
815/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 * nand_wait - [DEFAULT] wait until the command is done
817 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700818 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 *
820 * Wait for command done. This applies to erase and program only
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000821 * Erase can take up to 400ms and program up to 20ms according to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 * general NAND and SmartMedia specs
Randy Dunlap844d3b42006-06-28 21:48:27 -0700823 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200824static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
826
David Woodhousee0c7d762006-05-13 18:07:53 +0100827 unsigned long timeo = jiffies;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200828 int status, state = chip->state;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 if (state == FL_ERASING)
David Woodhousee0c7d762006-05-13 18:07:53 +0100831 timeo += (HZ * 400) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 else
David Woodhousee0c7d762006-05-13 18:07:53 +0100833 timeo += (HZ * 20) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Richard Purdie8fe833c2006-03-31 02:31:14 -0800835 led_trigger_event(nand_led_trigger, LED_FULL);
836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 /* Apply this short delay always to ensure that we do wait tWB in
838 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100839 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200841 if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
842 chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000843 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200844 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200846 if (in_interrupt() || oops_in_progress)
847 panic_nand_wait(mtd, chip, timeo);
848 else {
849 while (time_before(jiffies, timeo)) {
850 if (chip->dev_ready) {
851 if (chip->dev_ready(mtd))
852 break;
853 } else {
854 if (chip->read_byte(mtd) & NAND_STATUS_READY)
855 break;
856 }
857 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800860 led_trigger_event(nand_led_trigger, LED_OFF);
861
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200862 status = (int)chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 return status;
864}
865
866/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200867 * nand_read_page_raw - [Intern] read raw page data without ecc
868 * @mtd: mtd info structure
869 * @chip: nand chip info structure
870 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +0100871 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -0800872 *
873 * Not for syndrome calculating ecc controllers, which use a special oob layout
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200874 */
875static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -0700876 uint8_t *buf, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200877{
878 chip->read_buf(mtd, buf, mtd->writesize);
879 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
880 return 0;
881}
882
883/**
David Brownell52ff49d2009-03-04 12:01:36 -0800884 * nand_read_page_raw_syndrome - [Intern] read raw page data without ecc
885 * @mtd: mtd info structure
886 * @chip: nand chip info structure
887 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +0100888 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -0800889 *
890 * We need a special oob layout and handling even when OOB isn't used.
891 */
892static int nand_read_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -0700893 uint8_t *buf, int page)
David Brownell52ff49d2009-03-04 12:01:36 -0800894{
895 int eccsize = chip->ecc.size;
896 int eccbytes = chip->ecc.bytes;
897 uint8_t *oob = chip->oob_poi;
898 int steps, size;
899
900 for (steps = chip->ecc.steps; steps > 0; steps--) {
901 chip->read_buf(mtd, buf, eccsize);
902 buf += eccsize;
903
904 if (chip->ecc.prepad) {
905 chip->read_buf(mtd, oob, chip->ecc.prepad);
906 oob += chip->ecc.prepad;
907 }
908
909 chip->read_buf(mtd, oob, eccbytes);
910 oob += eccbytes;
911
912 if (chip->ecc.postpad) {
913 chip->read_buf(mtd, oob, chip->ecc.postpad);
914 oob += chip->ecc.postpad;
915 }
916 }
917
918 size = mtd->oobsize - (oob - chip->oob_poi);
919 if (size)
920 chip->read_buf(mtd, oob, size);
921
922 return 0;
923}
924
925/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +0300926 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200927 * @mtd: mtd info structure
928 * @chip: nand chip info structure
929 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +0100930 * @page: page number to read
David A. Marlin068e3c02005-01-24 03:07:46 +0000931 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200932static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -0700933 uint8_t *buf, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200935 int i, eccsize = chip->ecc.size;
936 int eccbytes = chip->ecc.bytes;
937 int eccsteps = chip->ecc.steps;
938 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +0100939 uint8_t *ecc_calc = chip->buffers->ecccalc;
940 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +0100941 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200942
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -0700943 chip->ecc.read_page_raw(mtd, chip, buf, page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200944
945 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
946 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
947
948 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +0200949 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200950
951 eccsteps = chip->ecc.steps;
952 p = buf;
953
954 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
955 int stat;
956
957 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Matt Reimerc32b8dc2007-10-17 14:33:23 -0700958 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +0200959 mtd->ecc_stats.failed++;
960 else
961 mtd->ecc_stats.corrected += stat;
962 }
963 return 0;
Thomas Gleixner22c60f52005-04-04 19:56:32 +0100964}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966/**
Alexey Korolev3d459552008-05-15 17:23:18 +0100967 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
968 * @mtd: mtd info structure
969 * @chip: nand chip info structure
Alexey Korolev17c1d2b2008-08-20 22:32:08 +0100970 * @data_offs: offset of requested data within the page
971 * @readlen: data length
972 * @bufpoi: buffer to store read data
Alexey Korolev3d459552008-05-15 17:23:18 +0100973 */
974static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip, uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
975{
976 int start_step, end_step, num_steps;
977 uint32_t *eccpos = chip->ecc.layout->eccpos;
978 uint8_t *p;
979 int data_col_addr, i, gaps = 0;
980 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
981 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
982
983 /* Column address wihin the page aligned to ECC size (256bytes). */
984 start_step = data_offs / chip->ecc.size;
985 end_step = (data_offs + readlen - 1) / chip->ecc.size;
986 num_steps = end_step - start_step + 1;
987
988 /* Data size aligned to ECC ecc.size*/
989 datafrag_len = num_steps * chip->ecc.size;
990 eccfrag_len = num_steps * chip->ecc.bytes;
991
992 data_col_addr = start_step * chip->ecc.size;
993 /* If we read not a page aligned data */
994 if (data_col_addr != 0)
995 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
996
997 p = bufpoi + data_col_addr;
998 chip->read_buf(mtd, p, datafrag_len);
999
1000 /* Calculate ECC */
1001 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1002 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1003
1004 /* The performance is faster if to position offsets
1005 according to ecc.pos. Let make sure here that
1006 there are no gaps in ecc positions */
1007 for (i = 0; i < eccfrag_len - 1; i++) {
1008 if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
1009 eccpos[i + start_step * chip->ecc.bytes + 1]) {
1010 gaps = 1;
1011 break;
1012 }
1013 }
1014 if (gaps) {
1015 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1016 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1017 } else {
1018 /* send the command to read the particular ecc bytes */
1019 /* take care about buswidth alignment in read_buf */
1020 aligned_pos = eccpos[start_step * chip->ecc.bytes] & ~(busw - 1);
1021 aligned_len = eccfrag_len;
1022 if (eccpos[start_step * chip->ecc.bytes] & (busw - 1))
1023 aligned_len++;
1024 if (eccpos[(start_step + num_steps) * chip->ecc.bytes] & (busw - 1))
1025 aligned_len++;
1026
1027 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize + aligned_pos, -1);
1028 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1029 }
1030
1031 for (i = 0; i < eccfrag_len; i++)
1032 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + start_step * chip->ecc.bytes]];
1033
1034 p = bufpoi + data_col_addr;
1035 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1036 int stat;
1037
1038 stat = chip->ecc.correct(mtd, p, &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
1039 if (stat == -1)
1040 mtd->ecc_stats.failed++;
1041 else
1042 mtd->ecc_stats.corrected += stat;
1043 }
1044 return 0;
1045}
1046
1047/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001048 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001049 * @mtd: mtd info structure
1050 * @chip: nand chip info structure
1051 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001052 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001053 *
1054 * Not for syndrome calculating ecc controllers which need a special oob layout
1055 */
1056static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001057 uint8_t *buf, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001058{
1059 int i, eccsize = chip->ecc.size;
1060 int eccbytes = chip->ecc.bytes;
1061 int eccsteps = chip->ecc.steps;
1062 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001063 uint8_t *ecc_calc = chip->buffers->ecccalc;
1064 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001065 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001066
1067 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1068 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1069 chip->read_buf(mtd, p, eccsize);
1070 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1071 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001072 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001073
1074 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001075 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001076
1077 eccsteps = chip->ecc.steps;
1078 p = buf;
1079
1080 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1081 int stat;
1082
1083 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Matt Reimerc32b8dc2007-10-17 14:33:23 -07001084 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001085 mtd->ecc_stats.failed++;
1086 else
1087 mtd->ecc_stats.corrected += stat;
1088 }
1089 return 0;
1090}
1091
1092/**
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001093 * nand_read_page_hwecc_oob_first - [REPLACABLE] hw ecc, read oob first
1094 * @mtd: mtd info structure
1095 * @chip: nand chip info structure
1096 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001097 * @page: page number to read
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001098 *
1099 * Hardware ECC for large page chips, require OOB to be read first.
1100 * For this ECC mode, the write_page method is re-used from ECC_HW.
1101 * These methods read/write ECC from the OOB area, unlike the
1102 * ECC_HW_SYNDROME support with multiple ECC steps, follows the
1103 * "infix ECC" scheme and reads/writes ECC from the data area, by
1104 * overwriting the NAND manufacturer bad block markings.
1105 */
1106static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
1107 struct nand_chip *chip, uint8_t *buf, int page)
1108{
1109 int i, eccsize = chip->ecc.size;
1110 int eccbytes = chip->ecc.bytes;
1111 int eccsteps = chip->ecc.steps;
1112 uint8_t *p = buf;
1113 uint8_t *ecc_code = chip->buffers->ecccode;
1114 uint32_t *eccpos = chip->ecc.layout->eccpos;
1115 uint8_t *ecc_calc = chip->buffers->ecccalc;
1116
1117 /* Read the OOB area first */
1118 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1119 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1120 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1121
1122 for (i = 0; i < chip->ecc.total; i++)
1123 ecc_code[i] = chip->oob_poi[eccpos[i]];
1124
1125 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1126 int stat;
1127
1128 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1129 chip->read_buf(mtd, p, eccsize);
1130 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1131
1132 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
1133 if (stat < 0)
1134 mtd->ecc_stats.failed++;
1135 else
1136 mtd->ecc_stats.corrected += stat;
1137 }
1138 return 0;
1139}
1140
1141/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001142 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001143 * @mtd: mtd info structure
1144 * @chip: nand chip info structure
1145 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001146 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001147 *
1148 * The hw generator calculates the error syndrome automatically. Therefor
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001149 * we need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001150 */
1151static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001152 uint8_t *buf, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001153{
1154 int i, eccsize = chip->ecc.size;
1155 int eccbytes = chip->ecc.bytes;
1156 int eccsteps = chip->ecc.steps;
1157 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001158 uint8_t *oob = chip->oob_poi;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001159
1160 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1161 int stat;
1162
1163 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1164 chip->read_buf(mtd, p, eccsize);
1165
1166 if (chip->ecc.prepad) {
1167 chip->read_buf(mtd, oob, chip->ecc.prepad);
1168 oob += chip->ecc.prepad;
1169 }
1170
1171 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1172 chip->read_buf(mtd, oob, eccbytes);
1173 stat = chip->ecc.correct(mtd, p, oob, NULL);
1174
Matt Reimerc32b8dc2007-10-17 14:33:23 -07001175 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001176 mtd->ecc_stats.failed++;
1177 else
1178 mtd->ecc_stats.corrected += stat;
1179
1180 oob += eccbytes;
1181
1182 if (chip->ecc.postpad) {
1183 chip->read_buf(mtd, oob, chip->ecc.postpad);
1184 oob += chip->ecc.postpad;
1185 }
1186 }
1187
1188 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001189 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001190 if (i)
1191 chip->read_buf(mtd, oob, i);
1192
1193 return 0;
1194}
1195
1196/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001197 * nand_transfer_oob - [Internal] Transfer oob to client buffer
1198 * @chip: nand chip structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07001199 * @oob: oob destination address
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001200 * @ops: oob ops structure
Vitaly Wool70145682006-11-03 18:20:38 +03001201 * @len: size of oob to transfer
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001202 */
1203static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
Vitaly Wool70145682006-11-03 18:20:38 +03001204 struct mtd_oob_ops *ops, size_t len)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001205{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001206 switch(ops->mode) {
1207
1208 case MTD_OOB_PLACE:
1209 case MTD_OOB_RAW:
1210 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1211 return oob + len;
1212
1213 case MTD_OOB_AUTO: {
1214 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001215 uint32_t boffs = 0, roffs = ops->ooboffs;
1216 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001217
1218 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001219 /* Read request not from offset 0 ? */
1220 if (unlikely(roffs)) {
1221 if (roffs >= free->length) {
1222 roffs -= free->length;
1223 continue;
1224 }
1225 boffs = free->offset + roffs;
1226 bytes = min_t(size_t, len,
1227 (free->length - roffs));
1228 roffs = 0;
1229 } else {
1230 bytes = min_t(size_t, len, free->length);
1231 boffs = free->offset;
1232 }
1233 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001234 oob += bytes;
1235 }
1236 return oob;
1237 }
1238 default:
1239 BUG();
1240 }
1241 return NULL;
1242}
1243
1244/**
1245 * nand_do_read_ops - [Internal] Read data with ECC
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001246 *
David A. Marlin068e3c02005-01-24 03:07:46 +00001247 * @mtd: MTD device structure
1248 * @from: offset to read from
Randy Dunlap844d3b42006-06-28 21:48:27 -07001249 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +00001250 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001251 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +00001252 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001253static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1254 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +00001255{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001256 int chipnr, page, realpage, col, bytes, aligned;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001257 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001258 struct mtd_ecc_stats stats;
1259 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1260 int sndcmd = 1;
1261 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001262 uint32_t readlen = ops->len;
Vitaly Wool70145682006-11-03 18:20:38 +03001263 uint32_t oobreadlen = ops->ooblen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001264 uint8_t *bufpoi, *oob, *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001266 stats = mtd->ecc_stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001268 chipnr = (int)(from >> chip->chip_shift);
1269 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001271 realpage = (int)(from >> chip->page_shift);
1272 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001274 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001276 buf = ops->datbuf;
1277 oob = ops->oobbuf;
1278
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001279 while(1) {
1280 bytes = min(mtd->writesize - col, readlen);
1281 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001282
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001283 /* Is the current page in the buffer ? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001284 if (realpage != chip->pagebuf || oob) {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001285 bufpoi = aligned ? buf : chip->buffers->databuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001287 if (likely(sndcmd)) {
1288 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1289 sndcmd = 0;
1290 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001292 /* Now read the page into the buffer */
David Woodhouse956e9442006-09-25 17:12:39 +01001293 if (unlikely(ops->mode == MTD_OOB_RAW))
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001294 ret = chip->ecc.read_page_raw(mtd, chip,
1295 bufpoi, page);
Alexey Korolev3d459552008-05-15 17:23:18 +01001296 else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
1297 ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
David Woodhouse956e9442006-09-25 17:12:39 +01001298 else
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001299 ret = chip->ecc.read_page(mtd, chip, bufpoi,
1300 page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001301 if (ret < 0)
David Woodhousee0c7d762006-05-13 18:07:53 +01001302 break;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001303
1304 /* Transfer not aligned data */
1305 if (!aligned) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001306 if (!NAND_SUBPAGE_READ(chip) && !oob)
1307 chip->pagebuf = realpage;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001308 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001310
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001311 buf += bytes;
1312
1313 if (unlikely(oob)) {
1314 /* Raw mode does data:oob:data:oob */
Vitaly Wool70145682006-11-03 18:20:38 +03001315 if (ops->mode != MTD_OOB_RAW) {
1316 int toread = min(oobreadlen,
1317 chip->ecc.layout->oobavail);
1318 if (toread) {
1319 oob = nand_transfer_oob(chip,
1320 oob, ops, toread);
1321 oobreadlen -= toread;
1322 }
1323 } else
1324 buf = nand_transfer_oob(chip,
1325 buf, ops, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001326 }
1327
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001328 if (!(chip->options & NAND_NO_READRDY)) {
1329 /*
1330 * Apply delay or wait for ready/busy pin. Do
1331 * this before the AUTOINCR check, so no
1332 * problems arise if a chip which does auto
1333 * increment is marked as NOAUTOINCR by the
1334 * board driver.
1335 */
1336 if (!chip->dev_ready)
1337 udelay(chip->chip_delay);
1338 else
1339 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001341 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001342 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001343 buf += bytes;
1344 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001346 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001347
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001348 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001349 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
1351 /* For subsequent reads align to page boundary. */
1352 col = 0;
1353 /* Increment page address */
1354 realpage++;
1355
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001356 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 /* Check, if we cross a chip boundary */
1358 if (!page) {
1359 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001360 chip->select_chip(mtd, -1);
1361 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001363
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001364 /* Check, if the chip supports auto page increment
1365 * or if we have hit a block boundary.
David Woodhousee0c7d762006-05-13 18:07:53 +01001366 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001367 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001368 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 }
1370
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001371 ops->retlen = ops->len - (size_t) readlen;
Vitaly Wool70145682006-11-03 18:20:38 +03001372 if (oob)
1373 ops->oobretlen = ops->ooblen - oobreadlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001375 if (ret)
1376 return ret;
1377
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001378 if (mtd->ecc_stats.failed - stats.failed)
1379 return -EBADMSG;
1380
1381 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001382}
1383
1384/**
1385 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
1386 * @mtd: MTD device structure
1387 * @from: offset to read from
1388 * @len: number of bytes to read
1389 * @retlen: pointer to variable to store the number of read bytes
1390 * @buf: the databuffer to put data
1391 *
1392 * Get hold of the chip and call nand_do_read
1393 */
1394static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1395 size_t *retlen, uint8_t *buf)
1396{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001397 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001398 int ret;
1399
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001400 /* Do not allow reads past end of device */
1401 if ((from + len) > mtd->size)
1402 return -EINVAL;
1403 if (!len)
1404 return 0;
1405
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001406 nand_get_device(chip, mtd, FL_READING);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001407
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001408 chip->ops.len = len;
1409 chip->ops.datbuf = buf;
1410 chip->ops.oobbuf = NULL;
1411
1412 ret = nand_do_read_ops(mtd, from, &chip->ops);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001413
Richard Purdie7fd5aec2006-08-27 01:23:33 -07001414 *retlen = chip->ops.retlen;
1415
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001416 nand_release_device(mtd);
1417
1418 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419}
1420
1421/**
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001422 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
1423 * @mtd: mtd info structure
1424 * @chip: nand chip info structure
1425 * @page: page number to read
1426 * @sndcmd: flag whether to issue read command or not
1427 */
1428static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1429 int page, int sndcmd)
1430{
1431 if (sndcmd) {
1432 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1433 sndcmd = 0;
1434 }
1435 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1436 return sndcmd;
1437}
1438
1439/**
1440 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
1441 * with syndromes
1442 * @mtd: mtd info structure
1443 * @chip: nand chip info structure
1444 * @page: page number to read
1445 * @sndcmd: flag whether to issue read command or not
1446 */
1447static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1448 int page, int sndcmd)
1449{
1450 uint8_t *buf = chip->oob_poi;
1451 int length = mtd->oobsize;
1452 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1453 int eccsize = chip->ecc.size;
1454 uint8_t *bufpoi = buf;
1455 int i, toread, sndrnd = 0, pos;
1456
1457 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1458 for (i = 0; i < chip->ecc.steps; i++) {
1459 if (sndrnd) {
1460 pos = eccsize + i * (eccsize + chunk);
1461 if (mtd->writesize > 512)
1462 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1463 else
1464 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1465 } else
1466 sndrnd = 1;
1467 toread = min_t(int, length, chunk);
1468 chip->read_buf(mtd, bufpoi, toread);
1469 bufpoi += toread;
1470 length -= toread;
1471 }
1472 if (length > 0)
1473 chip->read_buf(mtd, bufpoi, length);
1474
1475 return 1;
1476}
1477
1478/**
1479 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
1480 * @mtd: mtd info structure
1481 * @chip: nand chip info structure
1482 * @page: page number to write
1483 */
1484static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1485 int page)
1486{
1487 int status = 0;
1488 const uint8_t *buf = chip->oob_poi;
1489 int length = mtd->oobsize;
1490
1491 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1492 chip->write_buf(mtd, buf, length);
1493 /* Send command to program the OOB data */
1494 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1495
1496 status = chip->waitfunc(mtd, chip);
1497
Savin Zlobec0d420f92006-06-21 11:51:20 +02001498 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001499}
1500
1501/**
1502 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
1503 * with syndrome - only for large page flash !
1504 * @mtd: mtd info structure
1505 * @chip: nand chip info structure
1506 * @page: page number to write
1507 */
1508static int nand_write_oob_syndrome(struct mtd_info *mtd,
1509 struct nand_chip *chip, int page)
1510{
1511 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1512 int eccsize = chip->ecc.size, length = mtd->oobsize;
1513 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1514 const uint8_t *bufpoi = chip->oob_poi;
1515
1516 /*
1517 * data-ecc-data-ecc ... ecc-oob
1518 * or
1519 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1520 */
1521 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1522 pos = steps * (eccsize + chunk);
1523 steps = 0;
1524 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001525 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001526
1527 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1528 for (i = 0; i < steps; i++) {
1529 if (sndcmd) {
1530 if (mtd->writesize <= 512) {
1531 uint32_t fill = 0xFFFFFFFF;
1532
1533 len = eccsize;
1534 while (len > 0) {
1535 int num = min_t(int, len, 4);
1536 chip->write_buf(mtd, (uint8_t *)&fill,
1537 num);
1538 len -= num;
1539 }
1540 } else {
1541 pos = eccsize + i * (eccsize + chunk);
1542 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1543 }
1544 } else
1545 sndcmd = 1;
1546 len = min_t(int, length, chunk);
1547 chip->write_buf(mtd, bufpoi, len);
1548 bufpoi += len;
1549 length -= len;
1550 }
1551 if (length > 0)
1552 chip->write_buf(mtd, bufpoi, length);
1553
1554 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1555 status = chip->waitfunc(mtd, chip);
1556
1557 return status & NAND_STATUS_FAIL ? -EIO : 0;
1558}
1559
1560/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001561 * nand_do_read_oob - [Intern] NAND read out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 * @mtd: MTD device structure
1563 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001564 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 *
1566 * NAND read out-of-band data from the spare area
1567 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001568static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1569 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001571 int page, realpage, chipnr, sndcmd = 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001572 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001573 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
Vitaly Wool70145682006-11-03 18:20:38 +03001574 int readlen = ops->ooblen;
1575 int len;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001576 uint8_t *buf = ops->oobbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
vimal singh20d8e242009-07-07 15:49:49 +05301578 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08Lx, len = %i\n",
1579 __func__, (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Adrian Hunter03736152007-01-31 17:58:29 +02001581 if (ops->mode == MTD_OOB_AUTO)
Vitaly Wool70145682006-11-03 18:20:38 +03001582 len = chip->ecc.layout->oobavail;
Adrian Hunter03736152007-01-31 17:58:29 +02001583 else
1584 len = mtd->oobsize;
1585
1586 if (unlikely(ops->ooboffs >= len)) {
vimal singh20d8e242009-07-07 15:49:49 +05301587 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
1588 "outside oob\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001589 return -EINVAL;
1590 }
1591
1592 /* Do not allow reads past end of device */
1593 if (unlikely(from >= mtd->size ||
1594 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1595 (from >> chip->page_shift)) * len)) {
vimal singh20d8e242009-07-07 15:49:49 +05301596 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
1597 "of device\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001598 return -EINVAL;
1599 }
Vitaly Wool70145682006-11-03 18:20:38 +03001600
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001601 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001602 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001604 /* Shift to get page */
1605 realpage = (int)(from >> chip->page_shift);
1606 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001608 while(1) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001609 sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
Vitaly Wool70145682006-11-03 18:20:38 +03001610
1611 len = min(len, readlen);
1612 buf = nand_transfer_oob(chip, buf, ops, len);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001613
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001614 if (!(chip->options & NAND_NO_READRDY)) {
1615 /*
1616 * Apply delay or wait for ready/busy pin. Do this
1617 * before the AUTOINCR check, so no problems arise if a
1618 * chip which does auto increment is marked as
1619 * NOAUTOINCR by the board driver.
Thomas Gleixner19870da2005-07-15 14:53:51 +01001620 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001621 if (!chip->dev_ready)
1622 udelay(chip->chip_delay);
Thomas Gleixner19870da2005-07-15 14:53:51 +01001623 else
1624 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 }
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001626
Vitaly Wool70145682006-11-03 18:20:38 +03001627 readlen -= len;
Savin Zlobec0d420f92006-06-21 11:51:20 +02001628 if (!readlen)
1629 break;
1630
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001631 /* Increment page address */
1632 realpage++;
1633
1634 page = realpage & chip->pagemask;
1635 /* Check, if we cross a chip boundary */
1636 if (!page) {
1637 chipnr++;
1638 chip->select_chip(mtd, -1);
1639 chip->select_chip(mtd, chipnr);
1640 }
1641
1642 /* Check, if the chip supports auto page increment
1643 * or if we have hit a block boundary.
1644 */
1645 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
1646 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 }
1648
Vitaly Wool70145682006-11-03 18:20:38 +03001649 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 return 0;
1651}
1652
1653/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001654 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001657 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001659 * NAND read data and/or out-of-band data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001661static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1662 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001664 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001665 int ret = -ENOTSUPP;
1666
1667 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
1669 /* Do not allow reads past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03001670 if (ops->datbuf && (from + ops->len) > mtd->size) {
vimal singh20d8e242009-07-07 15:49:49 +05301671 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
1672 "beyond end of device\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 return -EINVAL;
1674 }
1675
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001676 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001678 switch(ops->mode) {
1679 case MTD_OOB_PLACE:
1680 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001681 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001682 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001683
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001684 default:
1685 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 }
1687
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001688 if (!ops->datbuf)
1689 ret = nand_do_read_oob(mtd, from, ops);
1690 else
1691 ret = nand_do_read_ops(mtd, from, ops);
1692
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001693 out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001695 return ret;
1696}
1697
1698
1699/**
1700 * nand_write_page_raw - [Intern] raw page write function
1701 * @mtd: mtd info structure
1702 * @chip: nand chip info structure
1703 * @buf: data buffer
David Brownell52ff49d2009-03-04 12:01:36 -08001704 *
1705 * Not for syndrome calculating ecc controllers, which use a special oob layout
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001706 */
1707static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1708 const uint8_t *buf)
1709{
1710 chip->write_buf(mtd, buf, mtd->writesize);
1711 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
1713
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001714/**
David Brownell52ff49d2009-03-04 12:01:36 -08001715 * nand_write_page_raw_syndrome - [Intern] raw page write function
1716 * @mtd: mtd info structure
1717 * @chip: nand chip info structure
1718 * @buf: data buffer
1719 *
1720 * We need a special oob layout and handling even when ECC isn't checked.
1721 */
1722static void nand_write_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1723 const uint8_t *buf)
1724{
1725 int eccsize = chip->ecc.size;
1726 int eccbytes = chip->ecc.bytes;
1727 uint8_t *oob = chip->oob_poi;
1728 int steps, size;
1729
1730 for (steps = chip->ecc.steps; steps > 0; steps--) {
1731 chip->write_buf(mtd, buf, eccsize);
1732 buf += eccsize;
1733
1734 if (chip->ecc.prepad) {
1735 chip->write_buf(mtd, oob, chip->ecc.prepad);
1736 oob += chip->ecc.prepad;
1737 }
1738
1739 chip->read_buf(mtd, oob, eccbytes);
1740 oob += eccbytes;
1741
1742 if (chip->ecc.postpad) {
1743 chip->write_buf(mtd, oob, chip->ecc.postpad);
1744 oob += chip->ecc.postpad;
1745 }
1746 }
1747
1748 size = mtd->oobsize - (oob - chip->oob_poi);
1749 if (size)
1750 chip->write_buf(mtd, oob, size);
1751}
1752/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001753 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001754 * @mtd: mtd info structure
1755 * @chip: nand chip info structure
1756 * @buf: data buffer
1757 */
1758static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1759 const uint8_t *buf)
1760{
1761 int i, eccsize = chip->ecc.size;
1762 int eccbytes = chip->ecc.bytes;
1763 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001764 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001765 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001766 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001767
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001768 /* Software ecc calculation */
1769 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1770 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001771
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001772 for (i = 0; i < chip->ecc.total; i++)
1773 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001774
Thomas Gleixner90424de2007-04-05 11:44:05 +02001775 chip->ecc.write_page_raw(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001776}
1777
1778/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001779 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001780 * @mtd: mtd info structure
1781 * @chip: nand chip info structure
1782 * @buf: data buffer
1783 */
1784static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1785 const uint8_t *buf)
1786{
1787 int i, eccsize = chip->ecc.size;
1788 int eccbytes = chip->ecc.bytes;
1789 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001790 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001791 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001792 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001793
1794 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1795 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01001796 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001797 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1798 }
1799
1800 for (i = 0; i < chip->ecc.total; i++)
1801 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1802
1803 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1804}
1805
1806/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001807 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001808 * @mtd: mtd info structure
1809 * @chip: nand chip info structure
1810 * @buf: data buffer
1811 *
1812 * The hw generator calculates the error syndrome automatically. Therefor
1813 * we need a special oob layout and handling.
1814 */
1815static void nand_write_page_syndrome(struct mtd_info *mtd,
1816 struct nand_chip *chip, const uint8_t *buf)
1817{
1818 int i, eccsize = chip->ecc.size;
1819 int eccbytes = chip->ecc.bytes;
1820 int eccsteps = chip->ecc.steps;
1821 const uint8_t *p = buf;
1822 uint8_t *oob = chip->oob_poi;
1823
1824 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1825
1826 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1827 chip->write_buf(mtd, p, eccsize);
1828
1829 if (chip->ecc.prepad) {
1830 chip->write_buf(mtd, oob, chip->ecc.prepad);
1831 oob += chip->ecc.prepad;
1832 }
1833
1834 chip->ecc.calculate(mtd, p, oob);
1835 chip->write_buf(mtd, oob, eccbytes);
1836 oob += eccbytes;
1837
1838 if (chip->ecc.postpad) {
1839 chip->write_buf(mtd, oob, chip->ecc.postpad);
1840 oob += chip->ecc.postpad;
1841 }
1842 }
1843
1844 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001845 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001846 if (i)
1847 chip->write_buf(mtd, oob, i);
1848}
1849
1850/**
David Woodhouse956e9442006-09-25 17:12:39 +01001851 * nand_write_page - [REPLACEABLE] write one page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001852 * @mtd: MTD device structure
1853 * @chip: NAND chip descriptor
1854 * @buf: the data to write
1855 * @page: page number to write
1856 * @cached: cached programming
Jesper Juhlefbfe96c2006-10-27 23:24:47 +02001857 * @raw: use _raw version of write_page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001858 */
1859static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
David Woodhouse956e9442006-09-25 17:12:39 +01001860 const uint8_t *buf, int page, int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001861{
1862 int status;
1863
1864 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
1865
David Woodhouse956e9442006-09-25 17:12:39 +01001866 if (unlikely(raw))
1867 chip->ecc.write_page_raw(mtd, chip, buf);
1868 else
1869 chip->ecc.write_page(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001870
1871 /*
1872 * Cached progamming disabled for now, Not sure if its worth the
1873 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
1874 */
1875 cached = 0;
1876
1877 if (!cached || !(chip->options & NAND_CACHEPRG)) {
1878
1879 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001880 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001881 /*
1882 * See if operation failed and additional status checks are
1883 * available
1884 */
1885 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
1886 status = chip->errstat(mtd, chip, FL_WRITING, status,
1887 page);
1888
1889 if (status & NAND_STATUS_FAIL)
1890 return -EIO;
1891 } else {
1892 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001893 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001894 }
1895
1896#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1897 /* Send command to read back the data */
1898 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1899
1900 if (chip->verify_buf(mtd, buf, mtd->writesize))
1901 return -EIO;
1902#endif
1903 return 0;
1904}
1905
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001906/**
1907 * nand_fill_oob - [Internal] Transfer client buffer to oob
1908 * @chip: nand chip structure
1909 * @oob: oob data buffer
1910 * @ops: oob ops structure
1911 */
1912static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
1913 struct mtd_oob_ops *ops)
1914{
1915 size_t len = ops->ooblen;
1916
1917 switch(ops->mode) {
1918
1919 case MTD_OOB_PLACE:
1920 case MTD_OOB_RAW:
1921 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
1922 return oob + len;
1923
1924 case MTD_OOB_AUTO: {
1925 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001926 uint32_t boffs = 0, woffs = ops->ooboffs;
1927 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001928
1929 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001930 /* Write request not from offset 0 ? */
1931 if (unlikely(woffs)) {
1932 if (woffs >= free->length) {
1933 woffs -= free->length;
1934 continue;
1935 }
1936 boffs = free->offset + woffs;
1937 bytes = min_t(size_t, len,
1938 (free->length - woffs));
1939 woffs = 0;
1940 } else {
1941 bytes = min_t(size_t, len, free->length);
1942 boffs = free->offset;
1943 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001944 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001945 oob += bytes;
1946 }
1947 return oob;
1948 }
1949 default:
1950 BUG();
1951 }
1952 return NULL;
1953}
1954
Thomas Gleixner29072b92006-09-28 15:38:36 +02001955#define NOTALIGNED(x) (x & (chip->subpagesize - 1)) != 0
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001956
1957/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001958 * nand_do_write_ops - [Internal] NAND write with ECC
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001959 * @mtd: MTD device structure
1960 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001961 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001962 *
1963 * NAND write with ECC
1964 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001965static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
1966 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001967{
Thomas Gleixner29072b92006-09-28 15:38:36 +02001968 int chipnr, realpage, page, blockmask, column;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001969 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001970 uint32_t writelen = ops->len;
1971 uint8_t *oob = ops->oobbuf;
1972 uint8_t *buf = ops->datbuf;
Thomas Gleixner29072b92006-09-28 15:38:36 +02001973 int ret, subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001974
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001975 ops->retlen = 0;
Thomas Gleixner29072b92006-09-28 15:38:36 +02001976 if (!writelen)
1977 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001978
1979 /* reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001980 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
vimal singh20d8e242009-07-07 15:49:49 +05301981 printk(KERN_NOTICE "%s: Attempt to write not "
1982 "page aligned data\n", __func__);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001983 return -EINVAL;
1984 }
1985
Thomas Gleixner29072b92006-09-28 15:38:36 +02001986 column = to & (mtd->writesize - 1);
1987 subpage = column || (writelen & (mtd->writesize - 1));
1988
1989 if (subpage && oob)
1990 return -EINVAL;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001991
Thomas Gleixner6a930962006-06-28 00:11:45 +02001992 chipnr = (int)(to >> chip->chip_shift);
1993 chip->select_chip(mtd, chipnr);
1994
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001995 /* Check, if it is write protected */
1996 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001997 return -EIO;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001998
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001999 realpage = (int)(to >> chip->page_shift);
2000 page = realpage & chip->pagemask;
2001 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2002
2003 /* Invalidate the page cache, when we write to the cached page */
2004 if (to <= (chip->pagebuf << chip->page_shift) &&
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002005 (chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002006 chip->pagebuf = -1;
2007
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01002008 /* If we're not given explicit OOB data, let it be 0xFF */
2009 if (likely(!oob))
2010 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002011
2012 while(1) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02002013 int bytes = mtd->writesize;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002014 int cached = writelen > bytes && page != blockmask;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002015 uint8_t *wbuf = buf;
2016
2017 /* Partial page write ? */
2018 if (unlikely(column || writelen < (mtd->writesize - 1))) {
2019 cached = 0;
2020 bytes = min_t(int, bytes - column, (int) writelen);
2021 chip->pagebuf = -1;
2022 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2023 memcpy(&chip->buffers->databuf[column], buf, bytes);
2024 wbuf = chip->buffers->databuf;
2025 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002026
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002027 if (unlikely(oob))
2028 oob = nand_fill_oob(chip, oob, ops);
2029
Thomas Gleixner29072b92006-09-28 15:38:36 +02002030 ret = chip->write_page(mtd, chip, wbuf, page, cached,
David Woodhouse956e9442006-09-25 17:12:39 +01002031 (ops->mode == MTD_OOB_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002032 if (ret)
2033 break;
2034
2035 writelen -= bytes;
2036 if (!writelen)
2037 break;
2038
Thomas Gleixner29072b92006-09-28 15:38:36 +02002039 column = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002040 buf += bytes;
2041 realpage++;
2042
2043 page = realpage & chip->pagemask;
2044 /* Check, if we cross a chip boundary */
2045 if (!page) {
2046 chipnr++;
2047 chip->select_chip(mtd, -1);
2048 chip->select_chip(mtd, chipnr);
2049 }
2050 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002051
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002052 ops->retlen = ops->len - writelen;
Vitaly Wool70145682006-11-03 18:20:38 +03002053 if (unlikely(oob))
2054 ops->oobretlen = ops->ooblen;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002055 return ret;
2056}
2057
2058/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002059 * panic_nand_write - [MTD Interface] NAND write with ECC
2060 * @mtd: MTD device structure
2061 * @to: offset to write to
2062 * @len: number of bytes to write
2063 * @retlen: pointer to variable to store the number of written bytes
2064 * @buf: the data to write
2065 *
2066 * NAND write with ECC. Used when performing writes in interrupt context, this
2067 * may for example be called by mtdoops when writing an oops while in panic.
2068 */
2069static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2070 size_t *retlen, const uint8_t *buf)
2071{
2072 struct nand_chip *chip = mtd->priv;
2073 int ret;
2074
2075 /* Do not allow reads past end of device */
2076 if ((to + len) > mtd->size)
2077 return -EINVAL;
2078 if (!len)
2079 return 0;
2080
2081 /* Wait for the device to get ready. */
2082 panic_nand_wait(mtd, chip, 400);
2083
2084 /* Grab the device. */
2085 panic_nand_get_device(chip, mtd, FL_WRITING);
2086
2087 chip->ops.len = len;
2088 chip->ops.datbuf = (uint8_t *)buf;
2089 chip->ops.oobbuf = NULL;
2090
2091 ret = nand_do_write_ops(mtd, to, &chip->ops);
2092
2093 *retlen = chip->ops.retlen;
2094 return ret;
2095}
2096
2097/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002098 * nand_write - [MTD Interface] NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 * @mtd: MTD device structure
2100 * @to: offset to write to
2101 * @len: number of bytes to write
2102 * @retlen: pointer to variable to store the number of written bytes
2103 * @buf: the data to write
2104 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002105 * NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002107static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002108 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002110 struct nand_chip *chip = mtd->priv;
2111 int ret;
2112
2113 /* Do not allow reads past end of device */
2114 if ((to + len) > mtd->size)
2115 return -EINVAL;
2116 if (!len)
2117 return 0;
2118
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002119 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002120
2121 chip->ops.len = len;
2122 chip->ops.datbuf = (uint8_t *)buf;
2123 chip->ops.oobbuf = NULL;
2124
2125 ret = nand_do_write_ops(mtd, to, &chip->ops);
2126
Richard Purdie7fd5aec2006-08-27 01:23:33 -07002127 *retlen = chip->ops.retlen;
2128
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002129 nand_release_device(mtd);
2130
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002131 return ret;
2132}
2133
2134/**
2135 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
2136 * @mtd: MTD device structure
2137 * @to: offset to write to
2138 * @ops: oob operation description structure
2139 *
2140 * NAND write out-of-band
2141 */
2142static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2143 struct mtd_oob_ops *ops)
2144{
Adrian Hunter03736152007-01-31 17:58:29 +02002145 int chipnr, page, status, len;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002146 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
vimal singh20d8e242009-07-07 15:49:49 +05302148 DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
2149 __func__, (unsigned int)to, (int)ops->ooblen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
Adrian Hunter03736152007-01-31 17:58:29 +02002151 if (ops->mode == MTD_OOB_AUTO)
2152 len = chip->ecc.layout->oobavail;
2153 else
2154 len = mtd->oobsize;
2155
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 /* Do not allow write past end of page */
Adrian Hunter03736152007-01-31 17:58:29 +02002157 if ((ops->ooboffs + ops->ooblen) > len) {
vimal singh20d8e242009-07-07 15:49:49 +05302158 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
2159 "past end of page\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 return -EINVAL;
2161 }
2162
Adrian Hunter03736152007-01-31 17:58:29 +02002163 if (unlikely(ops->ooboffs >= len)) {
vimal singh20d8e242009-07-07 15:49:49 +05302164 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
2165 "write outside oob\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002166 return -EINVAL;
2167 }
2168
2169 /* Do not allow reads past end of device */
2170 if (unlikely(to >= mtd->size ||
2171 ops->ooboffs + ops->ooblen >
2172 ((mtd->size >> chip->page_shift) -
2173 (to >> chip->page_shift)) * len)) {
vimal singh20d8e242009-07-07 15:49:49 +05302174 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
2175 "end of device\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002176 return -EINVAL;
2177 }
2178
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002179 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002180 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002182 /* Shift to get page */
2183 page = (int)(to >> chip->page_shift);
2184
2185 /*
2186 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2187 * of my DiskOnChip 2000 test units) will clear the whole data page too
2188 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2189 * it in the doc2000 driver in August 1999. dwmw2.
2190 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002191 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
2193 /* Check, if it is write protected */
2194 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002195 return -EROFS;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002196
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002198 if (page == chip->pagebuf)
2199 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002201 memset(chip->oob_poi, 0xff, mtd->oobsize);
2202 nand_fill_oob(chip, ops->oobbuf, ops);
2203 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
2204 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002205
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002206 if (status)
2207 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
Vitaly Wool70145682006-11-03 18:20:38 +03002209 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002211 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002212}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002214/**
2215 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2216 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07002217 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002218 * @ops: oob operation description structure
2219 */
2220static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2221 struct mtd_oob_ops *ops)
2222{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002223 struct nand_chip *chip = mtd->priv;
2224 int ret = -ENOTSUPP;
2225
2226 ops->retlen = 0;
2227
2228 /* Do not allow writes past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002229 if (ops->datbuf && (to + ops->len) > mtd->size) {
vimal singh20d8e242009-07-07 15:49:49 +05302230 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
2231 "end of device\n", __func__);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002232 return -EINVAL;
2233 }
2234
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002235 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002236
2237 switch(ops->mode) {
2238 case MTD_OOB_PLACE:
2239 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002240 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002241 break;
2242
2243 default:
2244 goto out;
2245 }
2246
2247 if (!ops->datbuf)
2248 ret = nand_do_write_oob(mtd, to, ops);
2249 else
2250 ret = nand_do_write_ops(mtd, to, ops);
2251
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002252 out:
2253 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 return ret;
2255}
2256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 * single_erease_cmd - [GENERIC] NAND standard block erase command function
2259 * @mtd: MTD device structure
2260 * @page: the page address of the block which will be erased
2261 *
2262 * Standard erase command for NAND chips
2263 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002264static void single_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002266 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002268 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2269 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270}
2271
2272/**
2273 * multi_erease_cmd - [GENERIC] AND specific block erase command function
2274 * @mtd: MTD device structure
2275 * @page: the page address of the block which will be erased
2276 *
2277 * AND multi block erase command function
2278 * Erase 4 consecutive blocks
2279 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002280static void multi_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002282 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002284 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2285 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2286 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2287 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2288 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289}
2290
2291/**
2292 * nand_erase - [MTD Interface] erase block(s)
2293 * @mtd: MTD device structure
2294 * @instr: erase instruction
2295 *
2296 * Erase one ore more blocks
2297 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002298static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299{
David Woodhousee0c7d762006-05-13 18:07:53 +01002300 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002302
David A. Marlin30f464b2005-01-17 18:35:25 +00002303#define BBT_PAGE_MASK 0xffffff3f
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002305 * nand_erase_nand - [Internal] erase block(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 * @mtd: MTD device structure
2307 * @instr: erase instruction
2308 * @allowbbt: allow erasing the bbt area
2309 *
2310 * Erase one ore more blocks
2311 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002312int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2313 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314{
Adrian Hunter69423d92008-12-10 13:37:21 +00002315 int page, status, pages_per_block, ret, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002316 struct nand_chip *chip = mtd->priv;
Adrian Hunter69423d92008-12-10 13:37:21 +00002317 loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002318 unsigned int bbt_masked_page = 0xffffffff;
Adrian Hunter69423d92008-12-10 13:37:21 +00002319 loff_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320
vimal singh20d8e242009-07-07 15:49:49 +05302321 DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
2322 __func__, (unsigned long long)instr->addr,
2323 (unsigned long long)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
Vimal Singh6fe5a6a2010-02-03 14:12:24 +05302325 if (check_offs_len(mtd, instr->addr, instr->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Adrian Hunterbb0eb212008-08-12 12:40:50 +03002328 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329
2330 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002331 nand_get_device(chip, mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332
2333 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002334 page = (int)(instr->addr >> chip->page_shift);
2335 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336
2337 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002338 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339
2340 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002341 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 /* Check, if it is write protected */
2344 if (nand_check_wp(mtd)) {
vimal singh20d8e242009-07-07 15:49:49 +05302345 DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
2346 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 instr->state = MTD_ERASE_FAILED;
2348 goto erase_exit;
2349 }
2350
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002351 /*
2352 * If BBT requires refresh, set the BBT page mask to see if the BBT
2353 * should be rewritten. Otherwise the mask is set to 0xffffffff which
2354 * can not be matched. This is also done when the bbt is actually
2355 * erased to avoid recusrsive updates
2356 */
2357 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
2358 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
David A. Marlin30f464b2005-01-17 18:35:25 +00002359
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 /* Loop through the pages */
2361 len = instr->len;
2362
2363 instr->state = MTD_ERASING;
2364
2365 while (len) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002366 /*
2367 * heck if we have a bad block, we do not erase bad blocks !
2368 */
2369 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2370 chip->page_shift, 0, allowbbt)) {
vimal singh20d8e242009-07-07 15:49:49 +05302371 printk(KERN_WARNING "%s: attempt to erase a bad block "
2372 "at page 0x%08x\n", __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 instr->state = MTD_ERASE_FAILED;
2374 goto erase_exit;
2375 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002376
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002377 /*
2378 * Invalidate the page cache, if we erase the block which
2379 * contains the current cached page
2380 */
2381 if (page <= chip->pagebuf && chip->pagebuf <
2382 (page + pages_per_block))
2383 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002385 chip->erase_cmd(mtd, page & chip->pagemask);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002386
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002387 status = chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002389 /*
2390 * See if operation failed and additional status checks are
2391 * available
2392 */
2393 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2394 status = chip->errstat(mtd, chip, FL_ERASING,
2395 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00002396
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00002398 if (status & NAND_STATUS_FAIL) {
vimal singh20d8e242009-07-07 15:49:49 +05302399 DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
2400 "page 0x%08x\n", __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 instr->state = MTD_ERASE_FAILED;
Adrian Hunter69423d92008-12-10 13:37:21 +00002402 instr->fail_addr =
2403 ((loff_t)page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404 goto erase_exit;
2405 }
David A. Marlin30f464b2005-01-17 18:35:25 +00002406
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002407 /*
2408 * If BBT requires refresh, set the BBT rewrite flag to the
2409 * page being erased
2410 */
2411 if (bbt_masked_page != 0xffffffff &&
2412 (page & BBT_PAGE_MASK) == bbt_masked_page)
Adrian Hunter69423d92008-12-10 13:37:21 +00002413 rewrite_bbt[chipnr] =
2414 ((loff_t)page << chip->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002415
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 /* Increment page address and decrement length */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002417 len -= (1 << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 page += pages_per_block;
2419
2420 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002421 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002423 chip->select_chip(mtd, -1);
2424 chip->select_chip(mtd, chipnr);
David A. Marlin30f464b2005-01-17 18:35:25 +00002425
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002426 /*
2427 * If BBT requires refresh and BBT-PERCHIP, set the BBT
2428 * page mask to see if this BBT should be rewritten
2429 */
2430 if (bbt_masked_page != 0xffffffff &&
2431 (chip->bbt_td->options & NAND_BBT_PERCHIP))
2432 bbt_masked_page = chip->bbt_td->pages[chipnr] &
2433 BBT_PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 }
2435 }
2436 instr->state = MTD_ERASE_DONE;
2437
David Woodhousee0c7d762006-05-13 18:07:53 +01002438 erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439
2440 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441
2442 /* Deselect and wake up anyone waiting on the device */
2443 nand_release_device(mtd);
2444
David Woodhouse49defc02007-10-06 15:01:59 -04002445 /* Do call back function */
2446 if (!ret)
2447 mtd_erase_callback(instr);
2448
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002449 /*
2450 * If BBT requires refresh and erase was successful, rewrite any
2451 * selected bad block tables
2452 */
2453 if (bbt_masked_page == 0xffffffff || ret)
2454 return ret;
2455
2456 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2457 if (!rewrite_bbt[chipnr])
2458 continue;
2459 /* update the BBT for chip */
vimal singh20d8e242009-07-07 15:49:49 +05302460 DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
2461 "(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
2462 rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002463 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
David A. Marlin30f464b2005-01-17 18:35:25 +00002464 }
2465
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 /* Return more or less happy */
2467 return ret;
2468}
2469
2470/**
2471 * nand_sync - [MTD Interface] sync
2472 * @mtd: MTD device structure
2473 *
2474 * Sync is actually a wait for chip ready function
2475 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002476static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002478 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479
vimal singh20d8e242009-07-07 15:49:49 +05302480 DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
2482 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002483 nand_get_device(chip, mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01002485 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486}
2487
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002489 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07002491 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002493static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494{
2495 /* Check for invalid offset */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002496 if (offs > mtd->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 return -EINVAL;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002498
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002499 return nand_block_checkbad(mtd, offs, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500}
2501
2502/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002503 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 * @mtd: MTD device structure
2505 * @ofs: offset relative to mtd start
2506 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002507static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002509 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 int ret;
2511
David Woodhousee0c7d762006-05-13 18:07:53 +01002512 if ((ret = nand_block_isbad(mtd, ofs))) {
2513 /* If it was bad already, return success and do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 if (ret > 0)
2515 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01002516 return ret;
2517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002519 return chip->block_markbad(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520}
2521
2522/**
Vitaly Wool962034f2005-09-15 14:58:53 +01002523 * nand_suspend - [MTD Interface] Suspend the NAND flash
2524 * @mtd: MTD device structure
2525 */
2526static int nand_suspend(struct mtd_info *mtd)
2527{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002528 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002529
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002530 return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01002531}
2532
2533/**
2534 * nand_resume - [MTD Interface] Resume the NAND flash
2535 * @mtd: MTD device structure
2536 */
2537static void nand_resume(struct mtd_info *mtd)
2538{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002539 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002540
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002541 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01002542 nand_release_device(mtd);
2543 else
vimal singh20d8e242009-07-07 15:49:49 +05302544 printk(KERN_ERR "%s called for a chip which is not "
2545 "in suspended state\n", __func__);
Vitaly Wool962034f2005-09-15 14:58:53 +01002546}
2547
Thomas Gleixnera36ed292006-05-23 11:37:03 +02002548/*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002549 * Set default functions
2550 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002551static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002552{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002554 if (!chip->chip_delay)
2555 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
2557 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002558 if (chip->cmdfunc == NULL)
2559 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560
2561 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002562 if (chip->waitfunc == NULL)
2563 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002565 if (!chip->select_chip)
2566 chip->select_chip = nand_select_chip;
2567 if (!chip->read_byte)
2568 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2569 if (!chip->read_word)
2570 chip->read_word = nand_read_word;
2571 if (!chip->block_bad)
2572 chip->block_bad = nand_block_bad;
2573 if (!chip->block_markbad)
2574 chip->block_markbad = nand_default_block_markbad;
2575 if (!chip->write_buf)
2576 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2577 if (!chip->read_buf)
2578 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2579 if (!chip->verify_buf)
2580 chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2581 if (!chip->scan_bbt)
2582 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002583
2584 if (!chip->controller) {
2585 chip->controller = &chip->hwcontrol;
2586 spin_lock_init(&chip->controller->lock);
2587 init_waitqueue_head(&chip->controller->wq);
2588 }
2589
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002590}
2591
2592/*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002593 * Get the flash and manufacturer id and lookup if the type is supported
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002594 */
2595static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002596 struct nand_chip *chip,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002597 int busw, int *maf_id)
2598{
2599 struct nand_flash_dev *type = NULL;
2600 int i, dev_id, maf_idx;
Ben Dooksed8165c2008-04-14 14:58:58 +01002601 int tmp_id, tmp_manf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602
2603 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002604 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605
Karl Beldanef89a882008-09-15 14:37:29 +02002606 /*
2607 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
2608 * after power-up
2609 */
2610 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
2611
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002613 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614
2615 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002616 *maf_id = chip->read_byte(mtd);
2617 dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618
Ben Dooksed8165c2008-04-14 14:58:58 +01002619 /* Try again to make sure, as some systems the bus-hold or other
2620 * interface concerns can cause random data which looks like a
2621 * possibly credible NAND flash to appear. If the two results do
2622 * not match, ignore the device completely.
2623 */
2624
2625 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2626
2627 /* Read manufacturer and device IDs */
2628
2629 tmp_manf = chip->read_byte(mtd);
2630 tmp_id = chip->read_byte(mtd);
2631
2632 if (tmp_manf != *maf_id || tmp_id != dev_id) {
2633 printk(KERN_INFO "%s: second ID read did not match "
2634 "%02x,%02x against %02x,%02x\n", __func__,
2635 *maf_id, dev_id, tmp_manf, tmp_id);
2636 return ERR_PTR(-ENODEV);
2637 }
2638
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002639 /* Lookup the flash id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 for (i = 0; nand_flash_ids[i].name != NULL; i++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002641 if (dev_id == nand_flash_ids[i].id) {
2642 type = &nand_flash_ids[i];
2643 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 }
2646
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002647 if (!type)
2648 return ERR_PTR(-ENODEV);
2649
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002650 if (!mtd->name)
2651 mtd->name = type->name;
2652
Adrian Hunter69423d92008-12-10 13:37:21 +00002653 chip->chipsize = (uint64_t)type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002654
2655 /* Newer devices have all the information in additional id bytes */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002656 if (!type->pagesize) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002657 int extid;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002658 /* The 3rd id byte holds MLC / multichip data */
2659 chip->cellinfo = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002660 /* The 4th id byte is the important one */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002661 extid = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002662 /* Calc pagesize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002663 mtd->writesize = 1024 << (extid & 0x3);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002664 extid >>= 2;
2665 /* Calc oobsize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002666 mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002667 extid >>= 2;
2668 /* Calc blocksize. Blocksize is multiples of 64KiB */
2669 mtd->erasesize = (64 * 1024) << (extid & 0x03);
2670 extid >>= 2;
2671 /* Get buswidth information */
2672 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2673
2674 } else {
2675 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002676 * Old devices have chip data hardcoded in the device id table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002677 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002678 mtd->erasesize = type->erasesize;
2679 mtd->writesize = type->pagesize;
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002680 mtd->oobsize = mtd->writesize / 32;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002681 busw = type->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002682 }
2683
2684 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01002685 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002686 if (nand_manuf_ids[maf_idx].id == *maf_id)
2687 break;
2688 }
2689
2690 /*
2691 * Check, if buswidth is correct. Hardware drivers should set
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002692 * chip correct !
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002693 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002694 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002695 printk(KERN_INFO "NAND device: Manufacturer ID:"
2696 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
2697 dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
2698 printk(KERN_WARNING "NAND bus width %d instead %d bit\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002699 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002700 busw ? 16 : 8);
2701 return ERR_PTR(-EINVAL);
2702 }
2703
2704 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002705 chip->page_shift = ffs(mtd->writesize) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002706 /* Convert chipsize to number of pages per chip -1. */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002707 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002708
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002709 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002710 ffs(mtd->erasesize) - 1;
Adrian Hunter69423d92008-12-10 13:37:21 +00002711 if (chip->chipsize & 0xffffffff)
2712 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
2713 else
2714 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32)) + 32 - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002715
2716 /* Set the bad block position */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002717 chip->badblockpos = mtd->writesize > 512 ?
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002718 NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2719
2720 /* Get chip options, preserve non chip based options */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002721 chip->options &= ~NAND_CHIPOPTIONS_MSK;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002722 chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002723
2724 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002725 * Set chip as a default. Board drivers can override it, if necessary
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002726 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002727 chip->options |= NAND_NO_AUTOINCR;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002728
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002729 /* Check if chip is a not a samsung device. Do not clear the
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002730 * options for chips which are not having an extended id.
2731 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002732 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002733 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002734
2735 /* Check for AND chips with 4 page planes */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002736 if (chip->options & NAND_4PAGE_ARRAY)
2737 chip->erase_cmd = multi_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002738 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002739 chip->erase_cmd = single_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002740
2741 /* Do not replace user supplied command function ! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002742 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
2743 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002744
2745 printk(KERN_INFO "NAND device: Manufacturer ID:"
2746 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id, dev_id,
2747 nand_manuf_ids[maf_idx].name, type->name);
2748
2749 return type;
2750}
2751
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002752/**
David Woodhouse3b85c322006-09-25 17:06:53 +01002753 * nand_scan_ident - [NAND Interface] Scan for the NAND device
2754 * @mtd: MTD device structure
2755 * @maxchips: Number of chips to scan for
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002756 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002757 * This is the first phase of the normal nand_scan() function. It
2758 * reads the flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002759 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002760 * The mtd->owner field must be set to the module of the caller.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002761 */
David Woodhouse3b85c322006-09-25 17:06:53 +01002762int nand_scan_ident(struct mtd_info *mtd, int maxchips)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002763{
2764 int i, busw, nand_maf_id;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002765 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002766 struct nand_flash_dev *type;
2767
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002768 /* Get buswidth to select the correct functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002769 busw = chip->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002770 /* Set the default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002771 nand_set_defaults(chip, busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002772
2773 /* Read the flash type */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002774 type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002775
2776 if (IS_ERR(type)) {
Ben Dooksb1c6e6d2009-11-02 18:12:33 +00002777 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
2778 printk(KERN_WARNING "No NAND device found.\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002779 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002780 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 }
2782
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002783 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01002784 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002785 chip->select_chip(mtd, i);
Karl Beldanef89a882008-09-15 14:37:29 +02002786 /* See comment in nand_get_flash_type for reset */
2787 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002789 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002791 if (nand_maf_id != chip->read_byte(mtd) ||
2792 type->id != chip->read_byte(mtd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 break;
2794 }
2795 if (i > 1)
2796 printk(KERN_INFO "%d NAND chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002797
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002799 chip->numchips = i;
2800 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801
David Woodhouse3b85c322006-09-25 17:06:53 +01002802 return 0;
2803}
2804
2805
2806/**
2807 * nand_scan_tail - [NAND Interface] Scan for the NAND device
2808 * @mtd: MTD device structure
David Woodhouse3b85c322006-09-25 17:06:53 +01002809 *
2810 * This is the second phase of the normal nand_scan() function. It
2811 * fills out all the uninitialized function pointers with the defaults
2812 * and scans for a bad block table if appropriate.
2813 */
2814int nand_scan_tail(struct mtd_info *mtd)
2815{
2816 int i;
2817 struct nand_chip *chip = mtd->priv;
2818
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002819 if (!(chip->options & NAND_OWN_BUFFERS))
2820 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
2821 if (!chip->buffers)
2822 return -ENOMEM;
2823
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01002824 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01002825 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002826
2827 /*
2828 * If no default placement scheme is given, select an appropriate one
2829 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002830 if (!chip->ecc.layout) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002831 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832 case 8:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002833 chip->ecc.layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 break;
2835 case 16:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002836 chip->ecc.layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837 break;
2838 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002839 chip->ecc.layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 break;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01002841 case 128:
2842 chip->ecc.layout = &nand_oob_128;
2843 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002845 printk(KERN_WARNING "No oob scheme defined for "
2846 "oobsize %d\n", mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 BUG();
2848 }
2849 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002850
David Woodhouse956e9442006-09-25 17:12:39 +01002851 if (!chip->write_page)
2852 chip->write_page = nand_write_page;
2853
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002854 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002855 * check ECC mode, default to software if 3byte/512byte hardware ECC is
2856 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01002857 */
David Woodhouse956e9442006-09-25 17:12:39 +01002858
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002859 switch (chip->ecc.mode) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07002860 case NAND_ECC_HW_OOB_FIRST:
2861 /* Similar to NAND_ECC_HW, but a separate read_page handle */
2862 if (!chip->ecc.calculate || !chip->ecc.correct ||
2863 !chip->ecc.hwctl) {
2864 printk(KERN_WARNING "No ECC functions supplied; "
2865 "Hardware ECC not possible\n");
2866 BUG();
2867 }
2868 if (!chip->ecc.read_page)
2869 chip->ecc.read_page = nand_read_page_hwecc_oob_first;
2870
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002871 case NAND_ECC_HW:
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002872 /* Use standard hwecc read page function ? */
2873 if (!chip->ecc.read_page)
2874 chip->ecc.read_page = nand_read_page_hwecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002875 if (!chip->ecc.write_page)
2876 chip->ecc.write_page = nand_write_page_hwecc;
David Brownell52ff49d2009-03-04 12:01:36 -08002877 if (!chip->ecc.read_page_raw)
2878 chip->ecc.read_page_raw = nand_read_page_raw;
2879 if (!chip->ecc.write_page_raw)
2880 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002881 if (!chip->ecc.read_oob)
2882 chip->ecc.read_oob = nand_read_oob_std;
2883 if (!chip->ecc.write_oob)
2884 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002885
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002886 case NAND_ECC_HW_SYNDROME:
Scott Wood78b65172007-12-13 11:15:28 -06002887 if ((!chip->ecc.calculate || !chip->ecc.correct ||
2888 !chip->ecc.hwctl) &&
2889 (!chip->ecc.read_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06002890 chip->ecc.read_page == nand_read_page_hwecc ||
Scott Wood78b65172007-12-13 11:15:28 -06002891 !chip->ecc.write_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06002892 chip->ecc.write_page == nand_write_page_hwecc)) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07002893 printk(KERN_WARNING "No ECC functions supplied; "
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002894 "Hardware ECC not possible\n");
2895 BUG();
2896 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002897 /* Use standard syndrome read/write page function ? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002898 if (!chip->ecc.read_page)
2899 chip->ecc.read_page = nand_read_page_syndrome;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002900 if (!chip->ecc.write_page)
2901 chip->ecc.write_page = nand_write_page_syndrome;
David Brownell52ff49d2009-03-04 12:01:36 -08002902 if (!chip->ecc.read_page_raw)
2903 chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
2904 if (!chip->ecc.write_page_raw)
2905 chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002906 if (!chip->ecc.read_oob)
2907 chip->ecc.read_oob = nand_read_oob_syndrome;
2908 if (!chip->ecc.write_oob)
2909 chip->ecc.write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002910
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002911 if (mtd->writesize >= chip->ecc.size)
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002912 break;
2913 printk(KERN_WARNING "%d byte HW ECC not possible on "
2914 "%d byte page size, fallback to SW ECC\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002915 chip->ecc.size, mtd->writesize);
2916 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002918 case NAND_ECC_SOFT:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002919 chip->ecc.calculate = nand_calculate_ecc;
2920 chip->ecc.correct = nand_correct_data;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002921 chip->ecc.read_page = nand_read_page_swecc;
Alexey Korolev3d459552008-05-15 17:23:18 +01002922 chip->ecc.read_subpage = nand_read_subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002923 chip->ecc.write_page = nand_write_page_swecc;
David Brownell52ff49d2009-03-04 12:01:36 -08002924 chip->ecc.read_page_raw = nand_read_page_raw;
2925 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002926 chip->ecc.read_oob = nand_read_oob_std;
2927 chip->ecc.write_oob = nand_write_oob_std;
Singh, Vimal9a732902008-12-12 00:10:57 +00002928 if (!chip->ecc.size)
2929 chip->ecc.size = 256;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002930 chip->ecc.bytes = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002932
2933 case NAND_ECC_NONE:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002934 printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
2935 "This is not recommended !!\n");
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002936 chip->ecc.read_page = nand_read_page_raw;
2937 chip->ecc.write_page = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002938 chip->ecc.read_oob = nand_read_oob_std;
David Brownell52ff49d2009-03-04 12:01:36 -08002939 chip->ecc.read_page_raw = nand_read_page_raw;
2940 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002941 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002942 chip->ecc.size = mtd->writesize;
2943 chip->ecc.bytes = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944 break;
David Woodhouse956e9442006-09-25 17:12:39 +01002945
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002947 printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002948 chip->ecc.mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002949 BUG();
2950 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002952 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002953 * The number of bytes available for a client to place data into
2954 * the out of band area
2955 */
2956 chip->ecc.layout->oobavail = 0;
David Brownell81d19b02009-04-21 19:51:20 -07002957 for (i = 0; chip->ecc.layout->oobfree[i].length
2958 && i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002959 chip->ecc.layout->oobavail +=
2960 chip->ecc.layout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03002961 mtd->oobavail = chip->ecc.layout->oobavail;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002962
2963 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002964 * Set the number of read / write steps for one page depending on ECC
2965 * mode
2966 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002967 chip->ecc.steps = mtd->writesize / chip->ecc.size;
2968 if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02002969 printk(KERN_WARNING "Invalid ecc parameters\n");
2970 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02002972 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002973
Thomas Gleixner29072b92006-09-28 15:38:36 +02002974 /*
2975 * Allow subpage writes up to ecc.steps. Not possible for MLC
2976 * FLASH.
2977 */
2978 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
2979 !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
2980 switch(chip->ecc.steps) {
2981 case 2:
2982 mtd->subpage_sft = 1;
2983 break;
2984 case 4:
2985 case 8:
Thomas Gleixner81ec5362007-12-12 17:27:03 +01002986 case 16:
Thomas Gleixner29072b92006-09-28 15:38:36 +02002987 mtd->subpage_sft = 2;
2988 break;
2989 }
2990 }
2991 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
2992
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02002993 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002994 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995
2996 /* De-select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002997 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998
2999 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003000 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
3002 /* Fill in remaining MTD driver data */
3003 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02003004 mtd->flags = MTD_CAP_NANDFLASH;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003005 mtd->erase = nand_erase;
3006 mtd->point = NULL;
3007 mtd->unpoint = NULL;
3008 mtd->read = nand_read;
3009 mtd->write = nand_write;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02003010 mtd->panic_write = panic_nand_write;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 mtd->read_oob = nand_read_oob;
3012 mtd->write_oob = nand_write_oob;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 mtd->sync = nand_sync;
3014 mtd->lock = NULL;
3015 mtd->unlock = NULL;
Vitaly Wool962034f2005-09-15 14:58:53 +01003016 mtd->suspend = nand_suspend;
3017 mtd->resume = nand_resume;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 mtd->block_isbad = nand_block_isbad;
3019 mtd->block_markbad = nand_block_markbad;
3020
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003021 /* propagate ecc.layout to mtd_info */
3022 mtd->ecclayout = chip->ecc.layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003024 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003025 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003026 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027
3028 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003029 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030}
3031
Rusty Russella6e6abd2009-03-31 13:05:31 -06003032/* is_module_text_address() isn't exported, and it's mostly a pointless
David Woodhouse3b85c322006-09-25 17:06:53 +01003033 test if this is a module _anyway_ -- they'd have to try _really_ hard
3034 to call us from in-kernel code if the core NAND support is modular. */
3035#ifdef MODULE
3036#define caller_is_module() (1)
3037#else
3038#define caller_is_module() \
Rusty Russella6e6abd2009-03-31 13:05:31 -06003039 is_module_text_address((unsigned long)__builtin_return_address(0))
David Woodhouse3b85c322006-09-25 17:06:53 +01003040#endif
3041
3042/**
3043 * nand_scan - [NAND Interface] Scan for the NAND device
3044 * @mtd: MTD device structure
3045 * @maxchips: Number of chips to scan for
3046 *
3047 * This fills out all the uninitialized function pointers
3048 * with the defaults.
3049 * The flash ID is read and the mtd/chip structures are
3050 * filled with the appropriate values.
3051 * The mtd->owner field must be set to the module of the caller
3052 *
3053 */
3054int nand_scan(struct mtd_info *mtd, int maxchips)
3055{
3056 int ret;
3057
3058 /* Many callers got this wrong, so check for it for a while... */
3059 if (!mtd->owner && caller_is_module()) {
vimal singh20d8e242009-07-07 15:49:49 +05303060 printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
3061 __func__);
David Woodhouse3b85c322006-09-25 17:06:53 +01003062 BUG();
3063 }
3064
3065 ret = nand_scan_ident(mtd, maxchips);
3066 if (!ret)
3067 ret = nand_scan_tail(mtd);
3068 return ret;
3069}
3070
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003072 * nand_release - [NAND Interface] Free resources held by the NAND device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073 * @mtd: MTD device structure
3074*/
David Woodhousee0c7d762006-05-13 18:07:53 +01003075void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003077 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078
3079#ifdef CONFIG_MTD_PARTITIONS
3080 /* Deregister partitions */
David Woodhousee0c7d762006-05-13 18:07:53 +01003081 del_mtd_partitions(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082#endif
3083 /* Deregister the device */
David Woodhousee0c7d762006-05-13 18:07:53 +01003084 del_mtd_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085
Jesper Juhlfa671642005-11-07 01:01:27 -08003086 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003087 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003088 if (!(chip->options & NAND_OWN_BUFFERS))
3089 kfree(chip->buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090}
3091
David Woodhousee0c7d762006-05-13 18:07:53 +01003092EXPORT_SYMBOL_GPL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01003093EXPORT_SYMBOL_GPL(nand_scan_ident);
3094EXPORT_SYMBOL_GPL(nand_scan_tail);
David Woodhousee0c7d762006-05-13 18:07:53 +01003095EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08003096
3097static int __init nand_base_init(void)
3098{
3099 led_trigger_register_simple("nand-disk", &nand_led_trigger);
3100 return 0;
3101}
3102
3103static void __exit nand_base_exit(void)
3104{
3105 led_trigger_unregister_simple(nand_led_trigger);
3106}
3107
3108module_init(nand_base_init);
3109module_exit(nand_base_exit);
3110
David Woodhousee0c7d762006-05-13 18:07:53 +01003111MODULE_LICENSE("GPL");
3112MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
3113MODULE_DESCRIPTION("Generic NAND flash driver code");