blob: 7442b3a29b256341601638d0f2b1597881d51f79 [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;
Li Yang6b0d9a82009-11-17 14:45:49 -0800776 }
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100777 }
778 set_current_state(TASK_UNINTERRUPTIBLE);
779 add_wait_queue(wq, &wait);
780 spin_unlock(lock);
781 schedule();
782 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 goto retry;
784}
785
786/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200787 * panic_nand_wait - [GENERIC] wait until the command is done
788 * @mtd: MTD device structure
789 * @chip: NAND chip structure
790 * @timeo: Timeout
791 *
792 * Wait for command done. This is a helper function for nand_wait used when
793 * we are in interrupt context. May happen when in panic and trying to write
794 * an oops trough mtdoops.
795 */
796static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
797 unsigned long timeo)
798{
799 int i;
800 for (i = 0; i < timeo; i++) {
801 if (chip->dev_ready) {
802 if (chip->dev_ready(mtd))
803 break;
804 } else {
805 if (chip->read_byte(mtd) & NAND_STATUS_READY)
806 break;
807 }
808 mdelay(1);
809 }
810}
811
812/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 * nand_wait - [DEFAULT] wait until the command is done
814 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -0700815 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 *
817 * Wait for command done. This applies to erase and program only
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000818 * Erase can take up to 400ms and program up to 20ms according to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 * general NAND and SmartMedia specs
Randy Dunlap844d3b42006-06-28 21:48:27 -0700820 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200821static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
823
David Woodhousee0c7d762006-05-13 18:07:53 +0100824 unsigned long timeo = jiffies;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200825 int status, state = chip->state;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 if (state == FL_ERASING)
David Woodhousee0c7d762006-05-13 18:07:53 +0100828 timeo += (HZ * 400) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 else
David Woodhousee0c7d762006-05-13 18:07:53 +0100830 timeo += (HZ * 20) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Richard Purdie8fe833c2006-03-31 02:31:14 -0800832 led_trigger_event(nand_led_trigger, LED_FULL);
833
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 /* Apply this short delay always to ensure that we do wait tWB in
835 * any case on any machine. */
David Woodhousee0c7d762006-05-13 18:07:53 +0100836 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200838 if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
839 chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000840 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200841 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200843 if (in_interrupt() || oops_in_progress)
844 panic_nand_wait(mtd, chip, timeo);
845 else {
846 while (time_before(jiffies, timeo)) {
847 if (chip->dev_ready) {
848 if (chip->dev_ready(mtd))
849 break;
850 } else {
851 if (chip->read_byte(mtd) & NAND_STATUS_READY)
852 break;
853 }
854 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800857 led_trigger_event(nand_led_trigger, LED_OFF);
858
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200859 status = (int)chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 return status;
861}
862
863/**
Vimal Singh7d70f332010-02-08 15:50:49 +0530864 * __nand_unlock - [REPLACABLE] unlocks specified locked blockes
865 *
866 * @param mtd - mtd info
867 * @param ofs - offset to start unlock from
868 * @param len - length to unlock
869 * @invert - when = 0, unlock the range of blocks within the lower and
870 * upper boundary address
871 * whne = 1, unlock the range of blocks outside the boundaries
872 * of the lower and upper boundary address
873 *
874 * @return - unlock status
875 */
876static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
877 uint64_t len, int invert)
878{
879 int ret = 0;
880 int status, page;
881 struct nand_chip *chip = mtd->priv;
882
883 /* Submit address of first page to unlock */
884 page = ofs >> chip->page_shift;
885 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
886
887 /* Submit address of last page to unlock */
888 page = (ofs + len) >> chip->page_shift;
889 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
890 (page | invert) & chip->pagemask);
891
892 /* Call wait ready function */
893 status = chip->waitfunc(mtd, chip);
894 udelay(1000);
895 /* See if device thinks it succeeded */
896 if (status & 0x01) {
897 DEBUG(MTD_DEBUG_LEVEL0, "%s: Error status = 0x%08x\n",
898 __func__, status);
899 ret = -EIO;
900 }
901
902 return ret;
903}
904
905/**
906 * nand_unlock - [REPLACABLE] unlocks specified locked blockes
907 *
908 * @param mtd - mtd info
909 * @param ofs - offset to start unlock from
910 * @param len - length to unlock
911 *
912 * @return - unlock status
913 */
914int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
915{
916 int ret = 0;
917 int chipnr;
918 struct nand_chip *chip = mtd->priv;
919
920 DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
921 __func__, (unsigned long long)ofs, len);
922
923 if (check_offs_len(mtd, ofs, len))
924 ret = -EINVAL;
925
926 /* Align to last block address if size addresses end of the device */
927 if (ofs + len == mtd->size)
928 len -= mtd->erasesize;
929
930 nand_get_device(chip, mtd, FL_UNLOCKING);
931
932 /* Shift to get chip number */
933 chipnr = ofs >> chip->chip_shift;
934
935 chip->select_chip(mtd, chipnr);
936
937 /* Check, if it is write protected */
938 if (nand_check_wp(mtd)) {
939 DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
940 __func__);
941 ret = -EIO;
942 goto out;
943 }
944
945 ret = __nand_unlock(mtd, ofs, len, 0);
946
947out:
948 /* de-select the NAND device */
949 chip->select_chip(mtd, -1);
950
951 nand_release_device(mtd);
952
953 return ret;
954}
955
956/**
957 * nand_lock - [REPLACABLE] locks all blockes present in the device
958 *
959 * @param mtd - mtd info
960 * @param ofs - offset to start unlock from
961 * @param len - length to unlock
962 *
963 * @return - lock status
964 *
965 * This feature is not support in many NAND parts. 'Micron' NAND parts
966 * do have this feature, but it allows only to lock all blocks not for
967 * specified range for block.
968 *
969 * Implementing 'lock' feature by making use of 'unlock', for now.
970 */
971int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
972{
973 int ret = 0;
974 int chipnr, status, page;
975 struct nand_chip *chip = mtd->priv;
976
977 DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
978 __func__, (unsigned long long)ofs, len);
979
980 if (check_offs_len(mtd, ofs, len))
981 ret = -EINVAL;
982
983 nand_get_device(chip, mtd, FL_LOCKING);
984
985 /* Shift to get chip number */
986 chipnr = ofs >> chip->chip_shift;
987
988 chip->select_chip(mtd, chipnr);
989
990 /* Check, if it is write protected */
991 if (nand_check_wp(mtd)) {
992 DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
993 __func__);
994 status = MTD_ERASE_FAILED;
995 ret = -EIO;
996 goto out;
997 }
998
999 /* Submit address of first page to lock */
1000 page = ofs >> chip->page_shift;
1001 chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);
1002
1003 /* Call wait ready function */
1004 status = chip->waitfunc(mtd, chip);
1005 udelay(1000);
1006 /* See if device thinks it succeeded */
1007 if (status & 0x01) {
1008 DEBUG(MTD_DEBUG_LEVEL0, "%s: Error status = 0x%08x\n",
1009 __func__, status);
1010 ret = -EIO;
1011 goto out;
1012 }
1013
1014 ret = __nand_unlock(mtd, ofs, len, 0x1);
1015
1016out:
1017 /* de-select the NAND device */
1018 chip->select_chip(mtd, -1);
1019
1020 nand_release_device(mtd);
1021
1022 return ret;
1023}
1024
1025/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001026 * nand_read_page_raw - [Intern] read raw page data without ecc
1027 * @mtd: mtd info structure
1028 * @chip: nand chip info structure
1029 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001030 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001031 *
1032 * Not for syndrome calculating ecc controllers, which use a special oob layout
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001033 */
1034static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001035 uint8_t *buf, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001036{
1037 chip->read_buf(mtd, buf, mtd->writesize);
1038 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1039 return 0;
1040}
1041
1042/**
David Brownell52ff49d2009-03-04 12:01:36 -08001043 * nand_read_page_raw_syndrome - [Intern] read raw page data without ecc
1044 * @mtd: mtd info structure
1045 * @chip: nand chip info structure
1046 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001047 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001048 *
1049 * We need a special oob layout and handling even when OOB isn't used.
1050 */
1051static int nand_read_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001052 uint8_t *buf, int page)
David Brownell52ff49d2009-03-04 12:01:36 -08001053{
1054 int eccsize = chip->ecc.size;
1055 int eccbytes = chip->ecc.bytes;
1056 uint8_t *oob = chip->oob_poi;
1057 int steps, size;
1058
1059 for (steps = chip->ecc.steps; steps > 0; steps--) {
1060 chip->read_buf(mtd, buf, eccsize);
1061 buf += eccsize;
1062
1063 if (chip->ecc.prepad) {
1064 chip->read_buf(mtd, oob, chip->ecc.prepad);
1065 oob += chip->ecc.prepad;
1066 }
1067
1068 chip->read_buf(mtd, oob, eccbytes);
1069 oob += eccbytes;
1070
1071 if (chip->ecc.postpad) {
1072 chip->read_buf(mtd, oob, chip->ecc.postpad);
1073 oob += chip->ecc.postpad;
1074 }
1075 }
1076
1077 size = mtd->oobsize - (oob - chip->oob_poi);
1078 if (size)
1079 chip->read_buf(mtd, oob, size);
1080
1081 return 0;
1082}
1083
1084/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001085 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001086 * @mtd: mtd info structure
1087 * @chip: nand chip info structure
1088 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001089 * @page: page number to read
David A. Marlin068e3c02005-01-24 03:07:46 +00001090 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001091static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001092 uint8_t *buf, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001094 int i, eccsize = chip->ecc.size;
1095 int eccbytes = chip->ecc.bytes;
1096 int eccsteps = chip->ecc.steps;
1097 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001098 uint8_t *ecc_calc = chip->buffers->ecccalc;
1099 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001100 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001101
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001102 chip->ecc.read_page_raw(mtd, chip, buf, page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001103
1104 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1105 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1106
1107 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001108 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001109
1110 eccsteps = chip->ecc.steps;
1111 p = buf;
1112
1113 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1114 int stat;
1115
1116 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Matt Reimerc32b8dc2007-10-17 14:33:23 -07001117 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001118 mtd->ecc_stats.failed++;
1119 else
1120 mtd->ecc_stats.corrected += stat;
1121 }
1122 return 0;
Thomas Gleixner22c60f52005-04-04 19:56:32 +01001123}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125/**
Alexey Korolev3d459552008-05-15 17:23:18 +01001126 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
1127 * @mtd: mtd info structure
1128 * @chip: nand chip info structure
Alexey Korolev17c1d2be2008-08-20 22:32:08 +01001129 * @data_offs: offset of requested data within the page
1130 * @readlen: data length
1131 * @bufpoi: buffer to store read data
Alexey Korolev3d459552008-05-15 17:23:18 +01001132 */
1133static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip, uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
1134{
1135 int start_step, end_step, num_steps;
1136 uint32_t *eccpos = chip->ecc.layout->eccpos;
1137 uint8_t *p;
1138 int data_col_addr, i, gaps = 0;
1139 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
1140 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
1141
1142 /* Column address wihin the page aligned to ECC size (256bytes). */
1143 start_step = data_offs / chip->ecc.size;
1144 end_step = (data_offs + readlen - 1) / chip->ecc.size;
1145 num_steps = end_step - start_step + 1;
1146
1147 /* Data size aligned to ECC ecc.size*/
1148 datafrag_len = num_steps * chip->ecc.size;
1149 eccfrag_len = num_steps * chip->ecc.bytes;
1150
1151 data_col_addr = start_step * chip->ecc.size;
1152 /* If we read not a page aligned data */
1153 if (data_col_addr != 0)
1154 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
1155
1156 p = bufpoi + data_col_addr;
1157 chip->read_buf(mtd, p, datafrag_len);
1158
1159 /* Calculate ECC */
1160 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1161 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1162
1163 /* The performance is faster if to position offsets
1164 according to ecc.pos. Let make sure here that
1165 there are no gaps in ecc positions */
1166 for (i = 0; i < eccfrag_len - 1; i++) {
1167 if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
1168 eccpos[i + start_step * chip->ecc.bytes + 1]) {
1169 gaps = 1;
1170 break;
1171 }
1172 }
1173 if (gaps) {
1174 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1175 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1176 } else {
1177 /* send the command to read the particular ecc bytes */
1178 /* take care about buswidth alignment in read_buf */
1179 aligned_pos = eccpos[start_step * chip->ecc.bytes] & ~(busw - 1);
1180 aligned_len = eccfrag_len;
1181 if (eccpos[start_step * chip->ecc.bytes] & (busw - 1))
1182 aligned_len++;
1183 if (eccpos[(start_step + num_steps) * chip->ecc.bytes] & (busw - 1))
1184 aligned_len++;
1185
1186 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize + aligned_pos, -1);
1187 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1188 }
1189
1190 for (i = 0; i < eccfrag_len; i++)
1191 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + start_step * chip->ecc.bytes]];
1192
1193 p = bufpoi + data_col_addr;
1194 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1195 int stat;
1196
1197 stat = chip->ecc.correct(mtd, p, &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
1198 if (stat == -1)
1199 mtd->ecc_stats.failed++;
1200 else
1201 mtd->ecc_stats.corrected += stat;
1202 }
1203 return 0;
1204}
1205
1206/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001207 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001208 * @mtd: mtd info structure
1209 * @chip: nand chip info structure
1210 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001211 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001212 *
1213 * Not for syndrome calculating ecc controllers which need a special oob layout
1214 */
1215static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001216 uint8_t *buf, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001217{
1218 int i, eccsize = chip->ecc.size;
1219 int eccbytes = chip->ecc.bytes;
1220 int eccsteps = chip->ecc.steps;
1221 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001222 uint8_t *ecc_calc = chip->buffers->ecccalc;
1223 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001224 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001225
1226 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1227 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1228 chip->read_buf(mtd, p, eccsize);
1229 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1230 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001231 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001232
1233 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001234 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001235
1236 eccsteps = chip->ecc.steps;
1237 p = buf;
1238
1239 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1240 int stat;
1241
1242 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Matt Reimerc32b8dc2007-10-17 14:33:23 -07001243 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001244 mtd->ecc_stats.failed++;
1245 else
1246 mtd->ecc_stats.corrected += stat;
1247 }
1248 return 0;
1249}
1250
1251/**
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001252 * nand_read_page_hwecc_oob_first - [REPLACABLE] hw ecc, read oob first
1253 * @mtd: mtd info structure
1254 * @chip: nand chip info structure
1255 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001256 * @page: page number to read
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001257 *
1258 * Hardware ECC for large page chips, require OOB to be read first.
1259 * For this ECC mode, the write_page method is re-used from ECC_HW.
1260 * These methods read/write ECC from the OOB area, unlike the
1261 * ECC_HW_SYNDROME support with multiple ECC steps, follows the
1262 * "infix ECC" scheme and reads/writes ECC from the data area, by
1263 * overwriting the NAND manufacturer bad block markings.
1264 */
1265static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
1266 struct nand_chip *chip, uint8_t *buf, int page)
1267{
1268 int i, eccsize = chip->ecc.size;
1269 int eccbytes = chip->ecc.bytes;
1270 int eccsteps = chip->ecc.steps;
1271 uint8_t *p = buf;
1272 uint8_t *ecc_code = chip->buffers->ecccode;
1273 uint32_t *eccpos = chip->ecc.layout->eccpos;
1274 uint8_t *ecc_calc = chip->buffers->ecccalc;
1275
1276 /* Read the OOB area first */
1277 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1278 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1279 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1280
1281 for (i = 0; i < chip->ecc.total; i++)
1282 ecc_code[i] = chip->oob_poi[eccpos[i]];
1283
1284 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1285 int stat;
1286
1287 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1288 chip->read_buf(mtd, p, eccsize);
1289 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1290
1291 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
1292 if (stat < 0)
1293 mtd->ecc_stats.failed++;
1294 else
1295 mtd->ecc_stats.corrected += stat;
1296 }
1297 return 0;
1298}
1299
1300/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001301 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001302 * @mtd: mtd info structure
1303 * @chip: nand chip info structure
1304 * @buf: buffer to store read data
Jaswinder Singh Rajput58475fb2009-09-24 13:04:53 +01001305 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001306 *
1307 * The hw generator calculates the error syndrome automatically. Therefor
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001308 * we need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001309 */
1310static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001311 uint8_t *buf, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001312{
1313 int i, eccsize = chip->ecc.size;
1314 int eccbytes = chip->ecc.bytes;
1315 int eccsteps = chip->ecc.steps;
1316 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001317 uint8_t *oob = chip->oob_poi;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001318
1319 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1320 int stat;
1321
1322 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1323 chip->read_buf(mtd, p, eccsize);
1324
1325 if (chip->ecc.prepad) {
1326 chip->read_buf(mtd, oob, chip->ecc.prepad);
1327 oob += chip->ecc.prepad;
1328 }
1329
1330 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1331 chip->read_buf(mtd, oob, eccbytes);
1332 stat = chip->ecc.correct(mtd, p, oob, NULL);
1333
Matt Reimerc32b8dc2007-10-17 14:33:23 -07001334 if (stat < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001335 mtd->ecc_stats.failed++;
1336 else
1337 mtd->ecc_stats.corrected += stat;
1338
1339 oob += eccbytes;
1340
1341 if (chip->ecc.postpad) {
1342 chip->read_buf(mtd, oob, chip->ecc.postpad);
1343 oob += chip->ecc.postpad;
1344 }
1345 }
1346
1347 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001348 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001349 if (i)
1350 chip->read_buf(mtd, oob, i);
1351
1352 return 0;
1353}
1354
1355/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001356 * nand_transfer_oob - [Internal] Transfer oob to client buffer
1357 * @chip: nand chip structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07001358 * @oob: oob destination address
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001359 * @ops: oob ops structure
Vitaly Wool70145682006-11-03 18:20:38 +03001360 * @len: size of oob to transfer
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001361 */
1362static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
Vitaly Wool70145682006-11-03 18:20:38 +03001363 struct mtd_oob_ops *ops, size_t len)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001364{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001365 switch(ops->mode) {
1366
1367 case MTD_OOB_PLACE:
1368 case MTD_OOB_RAW:
1369 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1370 return oob + len;
1371
1372 case MTD_OOB_AUTO: {
1373 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001374 uint32_t boffs = 0, roffs = ops->ooboffs;
1375 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001376
1377 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001378 /* Read request not from offset 0 ? */
1379 if (unlikely(roffs)) {
1380 if (roffs >= free->length) {
1381 roffs -= free->length;
1382 continue;
1383 }
1384 boffs = free->offset + roffs;
1385 bytes = min_t(size_t, len,
1386 (free->length - roffs));
1387 roffs = 0;
1388 } else {
1389 bytes = min_t(size_t, len, free->length);
1390 boffs = free->offset;
1391 }
1392 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001393 oob += bytes;
1394 }
1395 return oob;
1396 }
1397 default:
1398 BUG();
1399 }
1400 return NULL;
1401}
1402
1403/**
1404 * nand_do_read_ops - [Internal] Read data with ECC
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001405 *
David A. Marlin068e3c02005-01-24 03:07:46 +00001406 * @mtd: MTD device structure
1407 * @from: offset to read from
Randy Dunlap844d3b42006-06-28 21:48:27 -07001408 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +00001409 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001410 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +00001411 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001412static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1413 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +00001414{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001415 int chipnr, page, realpage, col, bytes, aligned;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001416 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001417 struct mtd_ecc_stats stats;
1418 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1419 int sndcmd = 1;
1420 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001421 uint32_t readlen = ops->len;
Vitaly Wool70145682006-11-03 18:20:38 +03001422 uint32_t oobreadlen = ops->ooblen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001423 uint8_t *bufpoi, *oob, *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001425 stats = mtd->ecc_stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001427 chipnr = (int)(from >> chip->chip_shift);
1428 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001430 realpage = (int)(from >> chip->page_shift);
1431 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001433 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001435 buf = ops->datbuf;
1436 oob = ops->oobbuf;
1437
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001438 while(1) {
1439 bytes = min(mtd->writesize - col, readlen);
1440 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001441
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001442 /* Is the current page in the buffer ? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001443 if (realpage != chip->pagebuf || oob) {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001444 bufpoi = aligned ? buf : chip->buffers->databuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001446 if (likely(sndcmd)) {
1447 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1448 sndcmd = 0;
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001451 /* Now read the page into the buffer */
David Woodhouse956e9442006-09-25 17:12:39 +01001452 if (unlikely(ops->mode == MTD_OOB_RAW))
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001453 ret = chip->ecc.read_page_raw(mtd, chip,
1454 bufpoi, page);
Alexey Korolev3d459552008-05-15 17:23:18 +01001455 else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
1456 ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
David Woodhouse956e9442006-09-25 17:12:39 +01001457 else
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001458 ret = chip->ecc.read_page(mtd, chip, bufpoi,
1459 page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001460 if (ret < 0)
David Woodhousee0c7d762006-05-13 18:07:53 +01001461 break;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001462
1463 /* Transfer not aligned data */
1464 if (!aligned) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001465 if (!NAND_SUBPAGE_READ(chip) && !oob)
1466 chip->pagebuf = realpage;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001467 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001469
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001470 buf += bytes;
1471
1472 if (unlikely(oob)) {
1473 /* Raw mode does data:oob:data:oob */
Vitaly Wool70145682006-11-03 18:20:38 +03001474 if (ops->mode != MTD_OOB_RAW) {
1475 int toread = min(oobreadlen,
1476 chip->ecc.layout->oobavail);
1477 if (toread) {
1478 oob = nand_transfer_oob(chip,
1479 oob, ops, toread);
1480 oobreadlen -= toread;
1481 }
1482 } else
1483 buf = nand_transfer_oob(chip,
1484 buf, ops, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001485 }
1486
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001487 if (!(chip->options & NAND_NO_READRDY)) {
1488 /*
1489 * Apply delay or wait for ready/busy pin. Do
1490 * this before the AUTOINCR check, so no
1491 * problems arise if a chip which does auto
1492 * increment is marked as NOAUTOINCR by the
1493 * board driver.
1494 */
1495 if (!chip->dev_ready)
1496 udelay(chip->chip_delay);
1497 else
1498 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001500 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001501 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001502 buf += bytes;
1503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001505 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001506
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001507 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001508 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
1510 /* For subsequent reads align to page boundary. */
1511 col = 0;
1512 /* Increment page address */
1513 realpage++;
1514
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001515 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 /* Check, if we cross a chip boundary */
1517 if (!page) {
1518 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001519 chip->select_chip(mtd, -1);
1520 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001522
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001523 /* Check, if the chip supports auto page increment
1524 * or if we have hit a block boundary.
David Woodhousee0c7d762006-05-13 18:07:53 +01001525 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001526 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001527 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 }
1529
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001530 ops->retlen = ops->len - (size_t) readlen;
Vitaly Wool70145682006-11-03 18:20:38 +03001531 if (oob)
1532 ops->oobretlen = ops->ooblen - oobreadlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001534 if (ret)
1535 return ret;
1536
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001537 if (mtd->ecc_stats.failed - stats.failed)
1538 return -EBADMSG;
1539
1540 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001541}
1542
1543/**
1544 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
1545 * @mtd: MTD device structure
1546 * @from: offset to read from
1547 * @len: number of bytes to read
1548 * @retlen: pointer to variable to store the number of read bytes
1549 * @buf: the databuffer to put data
1550 *
1551 * Get hold of the chip and call nand_do_read
1552 */
1553static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1554 size_t *retlen, uint8_t *buf)
1555{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001556 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001557 int ret;
1558
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001559 /* Do not allow reads past end of device */
1560 if ((from + len) > mtd->size)
1561 return -EINVAL;
1562 if (!len)
1563 return 0;
1564
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001565 nand_get_device(chip, mtd, FL_READING);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001566
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001567 chip->ops.len = len;
1568 chip->ops.datbuf = buf;
1569 chip->ops.oobbuf = NULL;
1570
1571 ret = nand_do_read_ops(mtd, from, &chip->ops);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001572
Richard Purdie7fd5aec2006-08-27 01:23:33 -07001573 *retlen = chip->ops.retlen;
1574
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001575 nand_release_device(mtd);
1576
1577 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578}
1579
1580/**
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001581 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
1582 * @mtd: mtd info structure
1583 * @chip: nand chip info structure
1584 * @page: page number to read
1585 * @sndcmd: flag whether to issue read command or not
1586 */
1587static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1588 int page, int sndcmd)
1589{
1590 if (sndcmd) {
1591 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1592 sndcmd = 0;
1593 }
1594 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1595 return sndcmd;
1596}
1597
1598/**
1599 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
1600 * with syndromes
1601 * @mtd: mtd info structure
1602 * @chip: nand chip info structure
1603 * @page: page number to read
1604 * @sndcmd: flag whether to issue read command or not
1605 */
1606static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1607 int page, int sndcmd)
1608{
1609 uint8_t *buf = chip->oob_poi;
1610 int length = mtd->oobsize;
1611 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1612 int eccsize = chip->ecc.size;
1613 uint8_t *bufpoi = buf;
1614 int i, toread, sndrnd = 0, pos;
1615
1616 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1617 for (i = 0; i < chip->ecc.steps; i++) {
1618 if (sndrnd) {
1619 pos = eccsize + i * (eccsize + chunk);
1620 if (mtd->writesize > 512)
1621 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1622 else
1623 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1624 } else
1625 sndrnd = 1;
1626 toread = min_t(int, length, chunk);
1627 chip->read_buf(mtd, bufpoi, toread);
1628 bufpoi += toread;
1629 length -= toread;
1630 }
1631 if (length > 0)
1632 chip->read_buf(mtd, bufpoi, length);
1633
1634 return 1;
1635}
1636
1637/**
1638 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
1639 * @mtd: mtd info structure
1640 * @chip: nand chip info structure
1641 * @page: page number to write
1642 */
1643static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1644 int page)
1645{
1646 int status = 0;
1647 const uint8_t *buf = chip->oob_poi;
1648 int length = mtd->oobsize;
1649
1650 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1651 chip->write_buf(mtd, buf, length);
1652 /* Send command to program the OOB data */
1653 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1654
1655 status = chip->waitfunc(mtd, chip);
1656
Savin Zlobec0d420f92006-06-21 11:51:20 +02001657 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001658}
1659
1660/**
1661 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
1662 * with syndrome - only for large page flash !
1663 * @mtd: mtd info structure
1664 * @chip: nand chip info structure
1665 * @page: page number to write
1666 */
1667static int nand_write_oob_syndrome(struct mtd_info *mtd,
1668 struct nand_chip *chip, int page)
1669{
1670 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1671 int eccsize = chip->ecc.size, length = mtd->oobsize;
1672 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1673 const uint8_t *bufpoi = chip->oob_poi;
1674
1675 /*
1676 * data-ecc-data-ecc ... ecc-oob
1677 * or
1678 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1679 */
1680 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1681 pos = steps * (eccsize + chunk);
1682 steps = 0;
1683 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001684 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001685
1686 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1687 for (i = 0; i < steps; i++) {
1688 if (sndcmd) {
1689 if (mtd->writesize <= 512) {
1690 uint32_t fill = 0xFFFFFFFF;
1691
1692 len = eccsize;
1693 while (len > 0) {
1694 int num = min_t(int, len, 4);
1695 chip->write_buf(mtd, (uint8_t *)&fill,
1696 num);
1697 len -= num;
1698 }
1699 } else {
1700 pos = eccsize + i * (eccsize + chunk);
1701 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1702 }
1703 } else
1704 sndcmd = 1;
1705 len = min_t(int, length, chunk);
1706 chip->write_buf(mtd, bufpoi, len);
1707 bufpoi += len;
1708 length -= len;
1709 }
1710 if (length > 0)
1711 chip->write_buf(mtd, bufpoi, length);
1712
1713 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1714 status = chip->waitfunc(mtd, chip);
1715
1716 return status & NAND_STATUS_FAIL ? -EIO : 0;
1717}
1718
1719/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001720 * nand_do_read_oob - [Intern] NAND read out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 * @mtd: MTD device structure
1722 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001723 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 *
1725 * NAND read out-of-band data from the spare area
1726 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001727static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1728 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729{
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001730 int page, realpage, chipnr, sndcmd = 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001731 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001732 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
Vitaly Wool70145682006-11-03 18:20:38 +03001733 int readlen = ops->ooblen;
1734 int len;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001735 uint8_t *buf = ops->oobbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
vimal singh20d8e242009-07-07 15:49:49 +05301737 DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08Lx, len = %i\n",
1738 __func__, (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
Adrian Hunter03736152007-01-31 17:58:29 +02001740 if (ops->mode == MTD_OOB_AUTO)
Vitaly Wool70145682006-11-03 18:20:38 +03001741 len = chip->ecc.layout->oobavail;
Adrian Hunter03736152007-01-31 17:58:29 +02001742 else
1743 len = mtd->oobsize;
1744
1745 if (unlikely(ops->ooboffs >= len)) {
vimal singh20d8e242009-07-07 15:49:49 +05301746 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
1747 "outside oob\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001748 return -EINVAL;
1749 }
1750
1751 /* Do not allow reads past end of device */
1752 if (unlikely(from >= mtd->size ||
1753 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1754 (from >> chip->page_shift)) * len)) {
vimal singh20d8e242009-07-07 15:49:49 +05301755 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
1756 "of device\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001757 return -EINVAL;
1758 }
Vitaly Wool70145682006-11-03 18:20:38 +03001759
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001760 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001761 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001763 /* Shift to get page */
1764 realpage = (int)(from >> chip->page_shift);
1765 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001767 while(1) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001768 sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
Vitaly Wool70145682006-11-03 18:20:38 +03001769
1770 len = min(len, readlen);
1771 buf = nand_transfer_oob(chip, buf, ops, len);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001772
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001773 if (!(chip->options & NAND_NO_READRDY)) {
1774 /*
1775 * Apply delay or wait for ready/busy pin. Do this
1776 * before the AUTOINCR check, so no problems arise if a
1777 * chip which does auto increment is marked as
1778 * NOAUTOINCR by the board driver.
Thomas Gleixner19870da2005-07-15 14:53:51 +01001779 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001780 if (!chip->dev_ready)
1781 udelay(chip->chip_delay);
Thomas Gleixner19870da2005-07-15 14:53:51 +01001782 else
1783 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001785
Vitaly Wool70145682006-11-03 18:20:38 +03001786 readlen -= len;
Savin Zlobec0d420f92006-06-21 11:51:20 +02001787 if (!readlen)
1788 break;
1789
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001790 /* Increment page address */
1791 realpage++;
1792
1793 page = realpage & chip->pagemask;
1794 /* Check, if we cross a chip boundary */
1795 if (!page) {
1796 chipnr++;
1797 chip->select_chip(mtd, -1);
1798 chip->select_chip(mtd, chipnr);
1799 }
1800
1801 /* Check, if the chip supports auto page increment
1802 * or if we have hit a block boundary.
1803 */
1804 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
1805 sndcmd = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
1807
Vitaly Wool70145682006-11-03 18:20:38 +03001808 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 return 0;
1810}
1811
1812/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001813 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 * @from: offset to read from
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001816 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001818 * NAND read data and/or out-of-band data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001820static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1821 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001823 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001824 int ret = -ENOTSUPP;
1825
1826 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
1828 /* Do not allow reads past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03001829 if (ops->datbuf && (from + ops->len) > mtd->size) {
vimal singh20d8e242009-07-07 15:49:49 +05301830 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
1831 "beyond end of device\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 return -EINVAL;
1833 }
1834
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001835 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001837 switch(ops->mode) {
1838 case MTD_OOB_PLACE:
1839 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001840 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001841 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001842
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001843 default:
1844 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 }
1846
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001847 if (!ops->datbuf)
1848 ret = nand_do_read_oob(mtd, from, ops);
1849 else
1850 ret = nand_do_read_ops(mtd, from, ops);
1851
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001852 out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001854 return ret;
1855}
1856
1857
1858/**
1859 * nand_write_page_raw - [Intern] raw page write function
1860 * @mtd: mtd info structure
1861 * @chip: nand chip info structure
1862 * @buf: data buffer
David Brownell52ff49d2009-03-04 12:01:36 -08001863 *
1864 * Not for syndrome calculating ecc controllers, which use a special oob layout
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001865 */
1866static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1867 const uint8_t *buf)
1868{
1869 chip->write_buf(mtd, buf, mtd->writesize);
1870 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871}
1872
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001873/**
David Brownell52ff49d2009-03-04 12:01:36 -08001874 * nand_write_page_raw_syndrome - [Intern] raw page write function
1875 * @mtd: mtd info structure
1876 * @chip: nand chip info structure
1877 * @buf: data buffer
1878 *
1879 * We need a special oob layout and handling even when ECC isn't checked.
1880 */
1881static void nand_write_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1882 const uint8_t *buf)
1883{
1884 int eccsize = chip->ecc.size;
1885 int eccbytes = chip->ecc.bytes;
1886 uint8_t *oob = chip->oob_poi;
1887 int steps, size;
1888
1889 for (steps = chip->ecc.steps; steps > 0; steps--) {
1890 chip->write_buf(mtd, buf, eccsize);
1891 buf += eccsize;
1892
1893 if (chip->ecc.prepad) {
1894 chip->write_buf(mtd, oob, chip->ecc.prepad);
1895 oob += chip->ecc.prepad;
1896 }
1897
1898 chip->read_buf(mtd, oob, eccbytes);
1899 oob += eccbytes;
1900
1901 if (chip->ecc.postpad) {
1902 chip->write_buf(mtd, oob, chip->ecc.postpad);
1903 oob += chip->ecc.postpad;
1904 }
1905 }
1906
1907 size = mtd->oobsize - (oob - chip->oob_poi);
1908 if (size)
1909 chip->write_buf(mtd, oob, size);
1910}
1911/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001912 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001913 * @mtd: mtd info structure
1914 * @chip: nand chip info structure
1915 * @buf: data buffer
1916 */
1917static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1918 const uint8_t *buf)
1919{
1920 int i, eccsize = chip->ecc.size;
1921 int eccbytes = chip->ecc.bytes;
1922 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001923 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001924 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001925 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001926
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001927 /* Software ecc calculation */
1928 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1929 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001930
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001931 for (i = 0; i < chip->ecc.total; i++)
1932 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001933
Thomas Gleixner90424de2007-04-05 11:44:05 +02001934 chip->ecc.write_page_raw(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001935}
1936
1937/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001938 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001939 * @mtd: mtd info structure
1940 * @chip: nand chip info structure
1941 * @buf: data buffer
1942 */
1943static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1944 const uint8_t *buf)
1945{
1946 int i, eccsize = chip->ecc.size;
1947 int eccbytes = chip->ecc.bytes;
1948 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001949 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001950 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001951 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001952
1953 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1954 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01001955 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001956 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1957 }
1958
1959 for (i = 0; i < chip->ecc.total; i++)
1960 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1961
1962 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1963}
1964
1965/**
Artem Bityutskiyd29ebdb2006-10-19 16:04:02 +03001966 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001967 * @mtd: mtd info structure
1968 * @chip: nand chip info structure
1969 * @buf: data buffer
1970 *
1971 * The hw generator calculates the error syndrome automatically. Therefor
1972 * we need a special oob layout and handling.
1973 */
1974static void nand_write_page_syndrome(struct mtd_info *mtd,
1975 struct nand_chip *chip, const uint8_t *buf)
1976{
1977 int i, eccsize = chip->ecc.size;
1978 int eccbytes = chip->ecc.bytes;
1979 int eccsteps = chip->ecc.steps;
1980 const uint8_t *p = buf;
1981 uint8_t *oob = chip->oob_poi;
1982
1983 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1984
1985 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1986 chip->write_buf(mtd, p, eccsize);
1987
1988 if (chip->ecc.prepad) {
1989 chip->write_buf(mtd, oob, chip->ecc.prepad);
1990 oob += chip->ecc.prepad;
1991 }
1992
1993 chip->ecc.calculate(mtd, p, oob);
1994 chip->write_buf(mtd, oob, eccbytes);
1995 oob += eccbytes;
1996
1997 if (chip->ecc.postpad) {
1998 chip->write_buf(mtd, oob, chip->ecc.postpad);
1999 oob += chip->ecc.postpad;
2000 }
2001 }
2002
2003 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04002004 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002005 if (i)
2006 chip->write_buf(mtd, oob, i);
2007}
2008
2009/**
David Woodhouse956e9442006-09-25 17:12:39 +01002010 * nand_write_page - [REPLACEABLE] write one page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002011 * @mtd: MTD device structure
2012 * @chip: NAND chip descriptor
2013 * @buf: the data to write
2014 * @page: page number to write
2015 * @cached: cached programming
Jesper Juhlefbfe96c2006-10-27 23:24:47 +02002016 * @raw: use _raw version of write_page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002017 */
2018static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
David Woodhouse956e9442006-09-25 17:12:39 +01002019 const uint8_t *buf, int page, int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002020{
2021 int status;
2022
2023 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
2024
David Woodhouse956e9442006-09-25 17:12:39 +01002025 if (unlikely(raw))
2026 chip->ecc.write_page_raw(mtd, chip, buf);
2027 else
2028 chip->ecc.write_page(mtd, chip, buf);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002029
2030 /*
2031 * Cached progamming disabled for now, Not sure if its worth the
2032 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
2033 */
2034 cached = 0;
2035
2036 if (!cached || !(chip->options & NAND_CACHEPRG)) {
2037
2038 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002039 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002040 /*
2041 * See if operation failed and additional status checks are
2042 * available
2043 */
2044 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2045 status = chip->errstat(mtd, chip, FL_WRITING, status,
2046 page);
2047
2048 if (status & NAND_STATUS_FAIL)
2049 return -EIO;
2050 } else {
2051 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002052 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002053 }
2054
2055#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
2056 /* Send command to read back the data */
2057 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
2058
2059 if (chip->verify_buf(mtd, buf, mtd->writesize))
2060 return -EIO;
2061#endif
2062 return 0;
2063}
2064
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002065/**
2066 * nand_fill_oob - [Internal] Transfer client buffer to oob
2067 * @chip: nand chip structure
2068 * @oob: oob data buffer
2069 * @ops: oob ops structure
2070 */
2071static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
2072 struct mtd_oob_ops *ops)
2073{
2074 size_t len = ops->ooblen;
2075
2076 switch(ops->mode) {
2077
2078 case MTD_OOB_PLACE:
2079 case MTD_OOB_RAW:
2080 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
2081 return oob + len;
2082
2083 case MTD_OOB_AUTO: {
2084 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002085 uint32_t boffs = 0, woffs = ops->ooboffs;
2086 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002087
2088 for(; free->length && len; free++, len -= bytes) {
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002089 /* Write request not from offset 0 ? */
2090 if (unlikely(woffs)) {
2091 if (woffs >= free->length) {
2092 woffs -= free->length;
2093 continue;
2094 }
2095 boffs = free->offset + woffs;
2096 bytes = min_t(size_t, len,
2097 (free->length - woffs));
2098 woffs = 0;
2099 } else {
2100 bytes = min_t(size_t, len, free->length);
2101 boffs = free->offset;
2102 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02002103 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002104 oob += bytes;
2105 }
2106 return oob;
2107 }
2108 default:
2109 BUG();
2110 }
2111 return NULL;
2112}
2113
Thomas Gleixner29072b92006-09-28 15:38:36 +02002114#define NOTALIGNED(x) (x & (chip->subpagesize - 1)) != 0
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002115
2116/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002117 * nand_do_write_ops - [Internal] NAND write with ECC
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002118 * @mtd: MTD device structure
2119 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002120 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002121 *
2122 * NAND write with ECC
2123 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002124static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
2125 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002126{
Thomas Gleixner29072b92006-09-28 15:38:36 +02002127 int chipnr, realpage, page, blockmask, column;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002128 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002129 uint32_t writelen = ops->len;
2130 uint8_t *oob = ops->oobbuf;
2131 uint8_t *buf = ops->datbuf;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002132 int ret, subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002133
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002134 ops->retlen = 0;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002135 if (!writelen)
2136 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002137
2138 /* reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002139 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
vimal singh20d8e242009-07-07 15:49:49 +05302140 printk(KERN_NOTICE "%s: Attempt to write not "
2141 "page aligned data\n", __func__);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002142 return -EINVAL;
2143 }
2144
Thomas Gleixner29072b92006-09-28 15:38:36 +02002145 column = to & (mtd->writesize - 1);
2146 subpage = column || (writelen & (mtd->writesize - 1));
2147
2148 if (subpage && oob)
2149 return -EINVAL;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002150
Thomas Gleixner6a930962006-06-28 00:11:45 +02002151 chipnr = (int)(to >> chip->chip_shift);
2152 chip->select_chip(mtd, chipnr);
2153
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002154 /* Check, if it is write protected */
2155 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002156 return -EIO;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002157
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002158 realpage = (int)(to >> chip->page_shift);
2159 page = realpage & chip->pagemask;
2160 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2161
2162 /* Invalidate the page cache, when we write to the cached page */
2163 if (to <= (chip->pagebuf << chip->page_shift) &&
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002164 (chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002165 chip->pagebuf = -1;
2166
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01002167 /* If we're not given explicit OOB data, let it be 0xFF */
2168 if (likely(!oob))
2169 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002170
2171 while(1) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02002172 int bytes = mtd->writesize;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002173 int cached = writelen > bytes && page != blockmask;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002174 uint8_t *wbuf = buf;
2175
2176 /* Partial page write ? */
2177 if (unlikely(column || writelen < (mtd->writesize - 1))) {
2178 cached = 0;
2179 bytes = min_t(int, bytes - column, (int) writelen);
2180 chip->pagebuf = -1;
2181 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2182 memcpy(&chip->buffers->databuf[column], buf, bytes);
2183 wbuf = chip->buffers->databuf;
2184 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002185
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002186 if (unlikely(oob))
2187 oob = nand_fill_oob(chip, oob, ops);
2188
Thomas Gleixner29072b92006-09-28 15:38:36 +02002189 ret = chip->write_page(mtd, chip, wbuf, page, cached,
David Woodhouse956e9442006-09-25 17:12:39 +01002190 (ops->mode == MTD_OOB_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002191 if (ret)
2192 break;
2193
2194 writelen -= bytes;
2195 if (!writelen)
2196 break;
2197
Thomas Gleixner29072b92006-09-28 15:38:36 +02002198 column = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002199 buf += bytes;
2200 realpage++;
2201
2202 page = realpage & chip->pagemask;
2203 /* Check, if we cross a chip boundary */
2204 if (!page) {
2205 chipnr++;
2206 chip->select_chip(mtd, -1);
2207 chip->select_chip(mtd, chipnr);
2208 }
2209 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002210
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002211 ops->retlen = ops->len - writelen;
Vitaly Wool70145682006-11-03 18:20:38 +03002212 if (unlikely(oob))
2213 ops->oobretlen = ops->ooblen;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002214 return ret;
2215}
2216
2217/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002218 * panic_nand_write - [MTD Interface] NAND write with ECC
2219 * @mtd: MTD device structure
2220 * @to: offset to write to
2221 * @len: number of bytes to write
2222 * @retlen: pointer to variable to store the number of written bytes
2223 * @buf: the data to write
2224 *
2225 * NAND write with ECC. Used when performing writes in interrupt context, this
2226 * may for example be called by mtdoops when writing an oops while in panic.
2227 */
2228static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2229 size_t *retlen, const uint8_t *buf)
2230{
2231 struct nand_chip *chip = mtd->priv;
2232 int ret;
2233
2234 /* Do not allow reads past end of device */
2235 if ((to + len) > mtd->size)
2236 return -EINVAL;
2237 if (!len)
2238 return 0;
2239
2240 /* Wait for the device to get ready. */
2241 panic_nand_wait(mtd, chip, 400);
2242
2243 /* Grab the device. */
2244 panic_nand_get_device(chip, mtd, FL_WRITING);
2245
2246 chip->ops.len = len;
2247 chip->ops.datbuf = (uint8_t *)buf;
2248 chip->ops.oobbuf = NULL;
2249
2250 ret = nand_do_write_ops(mtd, to, &chip->ops);
2251
2252 *retlen = chip->ops.retlen;
2253 return ret;
2254}
2255
2256/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002257 * nand_write - [MTD Interface] NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 * @mtd: MTD device structure
2259 * @to: offset to write to
2260 * @len: number of bytes to write
2261 * @retlen: pointer to variable to store the number of written bytes
2262 * @buf: the data to write
2263 *
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002264 * NAND write with ECC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002266static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002267 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002269 struct nand_chip *chip = mtd->priv;
2270 int ret;
2271
2272 /* Do not allow reads past end of device */
2273 if ((to + len) > mtd->size)
2274 return -EINVAL;
2275 if (!len)
2276 return 0;
2277
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002278 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002279
2280 chip->ops.len = len;
2281 chip->ops.datbuf = (uint8_t *)buf;
2282 chip->ops.oobbuf = NULL;
2283
2284 ret = nand_do_write_ops(mtd, to, &chip->ops);
2285
Richard Purdie7fd5aec2006-08-27 01:23:33 -07002286 *retlen = chip->ops.retlen;
2287
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002288 nand_release_device(mtd);
2289
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002290 return ret;
2291}
2292
2293/**
2294 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
2295 * @mtd: MTD device structure
2296 * @to: offset to write to
2297 * @ops: oob operation description structure
2298 *
2299 * NAND write out-of-band
2300 */
2301static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2302 struct mtd_oob_ops *ops)
2303{
Adrian Hunter03736152007-01-31 17:58:29 +02002304 int chipnr, page, status, len;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002305 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306
vimal singh20d8e242009-07-07 15:49:49 +05302307 DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
2308 __func__, (unsigned int)to, (int)ops->ooblen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Adrian Hunter03736152007-01-31 17:58:29 +02002310 if (ops->mode == MTD_OOB_AUTO)
2311 len = chip->ecc.layout->oobavail;
2312 else
2313 len = mtd->oobsize;
2314
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 /* Do not allow write past end of page */
Adrian Hunter03736152007-01-31 17:58:29 +02002316 if ((ops->ooboffs + ops->ooblen) > len) {
vimal singh20d8e242009-07-07 15:49:49 +05302317 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
2318 "past end of page\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 return -EINVAL;
2320 }
2321
Adrian Hunter03736152007-01-31 17:58:29 +02002322 if (unlikely(ops->ooboffs >= len)) {
vimal singh20d8e242009-07-07 15:49:49 +05302323 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
2324 "write outside oob\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002325 return -EINVAL;
2326 }
2327
2328 /* Do not allow reads past end of device */
2329 if (unlikely(to >= mtd->size ||
2330 ops->ooboffs + ops->ooblen >
2331 ((mtd->size >> chip->page_shift) -
2332 (to >> chip->page_shift)) * len)) {
vimal singh20d8e242009-07-07 15:49:49 +05302333 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
2334 "end of device\n", __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002335 return -EINVAL;
2336 }
2337
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002338 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002339 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002341 /* Shift to get page */
2342 page = (int)(to >> chip->page_shift);
2343
2344 /*
2345 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2346 * of my DiskOnChip 2000 test units) will clear the whole data page too
2347 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2348 * it in the doc2000 driver in August 1999. dwmw2.
2349 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002350 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
2352 /* Check, if it is write protected */
2353 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002354 return -EROFS;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002355
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002357 if (page == chip->pagebuf)
2358 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002360 memset(chip->oob_poi, 0xff, mtd->oobsize);
2361 nand_fill_oob(chip, ops->oobbuf, ops);
2362 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
2363 memset(chip->oob_poi, 0xff, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002364
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002365 if (status)
2366 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367
Vitaly Wool70145682006-11-03 18:20:38 +03002368 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002370 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002371}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002373/**
2374 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2375 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07002376 * @to: offset to write to
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002377 * @ops: oob operation description structure
2378 */
2379static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2380 struct mtd_oob_ops *ops)
2381{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002382 struct nand_chip *chip = mtd->priv;
2383 int ret = -ENOTSUPP;
2384
2385 ops->retlen = 0;
2386
2387 /* Do not allow writes past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002388 if (ops->datbuf && (to + ops->len) > mtd->size) {
vimal singh20d8e242009-07-07 15:49:49 +05302389 DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
2390 "end of device\n", __func__);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002391 return -EINVAL;
2392 }
2393
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002394 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002395
2396 switch(ops->mode) {
2397 case MTD_OOB_PLACE:
2398 case MTD_OOB_AUTO:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002399 case MTD_OOB_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002400 break;
2401
2402 default:
2403 goto out;
2404 }
2405
2406 if (!ops->datbuf)
2407 ret = nand_do_write_oob(mtd, to, ops);
2408 else
2409 ret = nand_do_write_ops(mtd, to, ops);
2410
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002411 out:
2412 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 return ret;
2414}
2415
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 * single_erease_cmd - [GENERIC] NAND standard block erase command function
2418 * @mtd: MTD device structure
2419 * @page: the page address of the block which will be erased
2420 *
2421 * Standard erase command for NAND chips
2422 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002423static void single_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002425 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002427 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2428 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429}
2430
2431/**
2432 * multi_erease_cmd - [GENERIC] AND specific block erase command function
2433 * @mtd: MTD device structure
2434 * @page: the page address of the block which will be erased
2435 *
2436 * AND multi block erase command function
2437 * Erase 4 consecutive blocks
2438 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002439static void multi_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002441 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002443 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2444 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2445 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2446 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2447 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448}
2449
2450/**
2451 * nand_erase - [MTD Interface] erase block(s)
2452 * @mtd: MTD device structure
2453 * @instr: erase instruction
2454 *
2455 * Erase one ore more blocks
2456 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002457static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458{
David Woodhousee0c7d762006-05-13 18:07:53 +01002459 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002461
David A. Marlin30f464b2005-01-17 18:35:25 +00002462#define BBT_PAGE_MASK 0xffffff3f
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002464 * nand_erase_nand - [Internal] erase block(s)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 * @mtd: MTD device structure
2466 * @instr: erase instruction
2467 * @allowbbt: allow erasing the bbt area
2468 *
2469 * Erase one ore more blocks
2470 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002471int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2472 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473{
Adrian Hunter69423d92008-12-10 13:37:21 +00002474 int page, status, pages_per_block, ret, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002475 struct nand_chip *chip = mtd->priv;
Adrian Hunter69423d92008-12-10 13:37:21 +00002476 loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002477 unsigned int bbt_masked_page = 0xffffffff;
Adrian Hunter69423d92008-12-10 13:37:21 +00002478 loff_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479
vimal singh20d8e242009-07-07 15:49:49 +05302480 DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
2481 __func__, (unsigned long long)instr->addr,
2482 (unsigned long long)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483
Vimal Singh6fe5a6a2010-02-03 14:12:24 +05302484 if (check_offs_len(mtd, instr->addr, instr->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486
Adrian Hunterbb0eb212008-08-12 12:40:50 +03002487 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
2489 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002490 nand_get_device(chip, mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491
2492 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002493 page = (int)(instr->addr >> chip->page_shift);
2494 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495
2496 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002497 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498
2499 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002500 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 /* Check, if it is write protected */
2503 if (nand_check_wp(mtd)) {
vimal singh20d8e242009-07-07 15:49:49 +05302504 DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
2505 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 instr->state = MTD_ERASE_FAILED;
2507 goto erase_exit;
2508 }
2509
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002510 /*
2511 * If BBT requires refresh, set the BBT page mask to see if the BBT
2512 * should be rewritten. Otherwise the mask is set to 0xffffffff which
2513 * can not be matched. This is also done when the bbt is actually
2514 * erased to avoid recusrsive updates
2515 */
2516 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
2517 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
David A. Marlin30f464b2005-01-17 18:35:25 +00002518
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 /* Loop through the pages */
2520 len = instr->len;
2521
2522 instr->state = MTD_ERASING;
2523
2524 while (len) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002525 /*
2526 * heck if we have a bad block, we do not erase bad blocks !
2527 */
2528 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2529 chip->page_shift, 0, allowbbt)) {
vimal singh20d8e242009-07-07 15:49:49 +05302530 printk(KERN_WARNING "%s: attempt to erase a bad block "
2531 "at page 0x%08x\n", __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 instr->state = MTD_ERASE_FAILED;
2533 goto erase_exit;
2534 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002535
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002536 /*
2537 * Invalidate the page cache, if we erase the block which
2538 * contains the current cached page
2539 */
2540 if (page <= chip->pagebuf && chip->pagebuf <
2541 (page + pages_per_block))
2542 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002544 chip->erase_cmd(mtd, page & chip->pagemask);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002545
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002546 status = chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002548 /*
2549 * See if operation failed and additional status checks are
2550 * available
2551 */
2552 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2553 status = chip->errstat(mtd, chip, FL_ERASING,
2554 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00002555
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00002557 if (status & NAND_STATUS_FAIL) {
vimal singh20d8e242009-07-07 15:49:49 +05302558 DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
2559 "page 0x%08x\n", __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 instr->state = MTD_ERASE_FAILED;
Adrian Hunter69423d92008-12-10 13:37:21 +00002561 instr->fail_addr =
2562 ((loff_t)page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 goto erase_exit;
2564 }
David A. Marlin30f464b2005-01-17 18:35:25 +00002565
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002566 /*
2567 * If BBT requires refresh, set the BBT rewrite flag to the
2568 * page being erased
2569 */
2570 if (bbt_masked_page != 0xffffffff &&
2571 (page & BBT_PAGE_MASK) == bbt_masked_page)
Adrian Hunter69423d92008-12-10 13:37:21 +00002572 rewrite_bbt[chipnr] =
2573 ((loff_t)page << chip->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002574
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 /* Increment page address and decrement length */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002576 len -= (1 << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 page += pages_per_block;
2578
2579 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002580 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002582 chip->select_chip(mtd, -1);
2583 chip->select_chip(mtd, chipnr);
David A. Marlin30f464b2005-01-17 18:35:25 +00002584
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002585 /*
2586 * If BBT requires refresh and BBT-PERCHIP, set the BBT
2587 * page mask to see if this BBT should be rewritten
2588 */
2589 if (bbt_masked_page != 0xffffffff &&
2590 (chip->bbt_td->options & NAND_BBT_PERCHIP))
2591 bbt_masked_page = chip->bbt_td->pages[chipnr] &
2592 BBT_PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 }
2594 }
2595 instr->state = MTD_ERASE_DONE;
2596
David Woodhousee0c7d762006-05-13 18:07:53 +01002597 erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598
2599 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600
2601 /* Deselect and wake up anyone waiting on the device */
2602 nand_release_device(mtd);
2603
David Woodhouse49defc02007-10-06 15:01:59 -04002604 /* Do call back function */
2605 if (!ret)
2606 mtd_erase_callback(instr);
2607
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002608 /*
2609 * If BBT requires refresh and erase was successful, rewrite any
2610 * selected bad block tables
2611 */
2612 if (bbt_masked_page == 0xffffffff || ret)
2613 return ret;
2614
2615 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2616 if (!rewrite_bbt[chipnr])
2617 continue;
2618 /* update the BBT for chip */
vimal singh20d8e242009-07-07 15:49:49 +05302619 DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
2620 "(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
2621 rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002622 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
David A. Marlin30f464b2005-01-17 18:35:25 +00002623 }
2624
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 /* Return more or less happy */
2626 return ret;
2627}
2628
2629/**
2630 * nand_sync - [MTD Interface] sync
2631 * @mtd: MTD device structure
2632 *
2633 * Sync is actually a wait for chip ready function
2634 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002635static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002637 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638
vimal singh20d8e242009-07-07 15:49:49 +05302639 DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640
2641 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002642 nand_get_device(chip, mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01002644 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645}
2646
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002648 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 * @mtd: MTD device structure
Randy Dunlap844d3b42006-06-28 21:48:27 -07002650 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002652static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653{
2654 /* Check for invalid offset */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002655 if (offs > mtd->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 return -EINVAL;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002657
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002658 return nand_block_checkbad(mtd, offs, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659}
2660
2661/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002662 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 * @mtd: MTD device structure
2664 * @ofs: offset relative to mtd start
2665 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002666static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002668 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 int ret;
2670
David Woodhousee0c7d762006-05-13 18:07:53 +01002671 if ((ret = nand_block_isbad(mtd, ofs))) {
2672 /* If it was bad already, return success and do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673 if (ret > 0)
2674 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01002675 return ret;
2676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002678 return chip->block_markbad(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679}
2680
2681/**
Vitaly Wool962034f2005-09-15 14:58:53 +01002682 * nand_suspend - [MTD Interface] Suspend the NAND flash
2683 * @mtd: MTD device structure
2684 */
2685static int nand_suspend(struct mtd_info *mtd)
2686{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002687 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002688
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002689 return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01002690}
2691
2692/**
2693 * nand_resume - [MTD Interface] Resume the NAND flash
2694 * @mtd: MTD device structure
2695 */
2696static void nand_resume(struct mtd_info *mtd)
2697{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002698 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002699
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002700 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01002701 nand_release_device(mtd);
2702 else
vimal singh20d8e242009-07-07 15:49:49 +05302703 printk(KERN_ERR "%s called for a chip which is not "
2704 "in suspended state\n", __func__);
Vitaly Wool962034f2005-09-15 14:58:53 +01002705}
2706
Thomas Gleixnera36ed292006-05-23 11:37:03 +02002707/*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002708 * Set default functions
2709 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002710static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002711{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002713 if (!chip->chip_delay)
2714 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715
2716 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002717 if (chip->cmdfunc == NULL)
2718 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719
2720 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002721 if (chip->waitfunc == NULL)
2722 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002724 if (!chip->select_chip)
2725 chip->select_chip = nand_select_chip;
2726 if (!chip->read_byte)
2727 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2728 if (!chip->read_word)
2729 chip->read_word = nand_read_word;
2730 if (!chip->block_bad)
2731 chip->block_bad = nand_block_bad;
2732 if (!chip->block_markbad)
2733 chip->block_markbad = nand_default_block_markbad;
2734 if (!chip->write_buf)
2735 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2736 if (!chip->read_buf)
2737 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2738 if (!chip->verify_buf)
2739 chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2740 if (!chip->scan_bbt)
2741 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002742
2743 if (!chip->controller) {
2744 chip->controller = &chip->hwcontrol;
2745 spin_lock_init(&chip->controller->lock);
2746 init_waitqueue_head(&chip->controller->wq);
2747 }
2748
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002749}
2750
2751/*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002752 * Get the flash and manufacturer id and lookup if the type is supported
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002753 */
2754static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002755 struct nand_chip *chip,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002756 int busw, int *maf_id)
2757{
2758 struct nand_flash_dev *type = NULL;
2759 int i, dev_id, maf_idx;
Ben Dooksed8165c2008-04-14 14:58:58 +01002760 int tmp_id, tmp_manf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761
2762 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002763 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764
Karl Beldanef89a882008-09-15 14:37:29 +02002765 /*
2766 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
2767 * after power-up
2768 */
2769 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
2770
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002772 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773
2774 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002775 *maf_id = chip->read_byte(mtd);
2776 dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777
Ben Dooksed8165c2008-04-14 14:58:58 +01002778 /* Try again to make sure, as some systems the bus-hold or other
2779 * interface concerns can cause random data which looks like a
2780 * possibly credible NAND flash to appear. If the two results do
2781 * not match, ignore the device completely.
2782 */
2783
2784 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2785
2786 /* Read manufacturer and device IDs */
2787
2788 tmp_manf = chip->read_byte(mtd);
2789 tmp_id = chip->read_byte(mtd);
2790
2791 if (tmp_manf != *maf_id || tmp_id != dev_id) {
2792 printk(KERN_INFO "%s: second ID read did not match "
2793 "%02x,%02x against %02x,%02x\n", __func__,
2794 *maf_id, dev_id, tmp_manf, tmp_id);
2795 return ERR_PTR(-ENODEV);
2796 }
2797
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002798 /* Lookup the flash id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 for (i = 0; nand_flash_ids[i].name != NULL; i++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002800 if (dev_id == nand_flash_ids[i].id) {
2801 type = &nand_flash_ids[i];
2802 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 }
2805
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002806 if (!type)
2807 return ERR_PTR(-ENODEV);
2808
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002809 if (!mtd->name)
2810 mtd->name = type->name;
2811
Adrian Hunter69423d92008-12-10 13:37:21 +00002812 chip->chipsize = (uint64_t)type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002813
2814 /* Newer devices have all the information in additional id bytes */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002815 if (!type->pagesize) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002816 int extid;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002817 /* The 3rd id byte holds MLC / multichip data */
2818 chip->cellinfo = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002819 /* The 4th id byte is the important one */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002820 extid = chip->read_byte(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002821 /* Calc pagesize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002822 mtd->writesize = 1024 << (extid & 0x3);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002823 extid >>= 2;
2824 /* Calc oobsize */
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002825 mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002826 extid >>= 2;
2827 /* Calc blocksize. Blocksize is multiples of 64KiB */
2828 mtd->erasesize = (64 * 1024) << (extid & 0x03);
2829 extid >>= 2;
2830 /* Get buswidth information */
2831 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2832
2833 } else {
2834 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002835 * Old devices have chip data hardcoded in the device id table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002836 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002837 mtd->erasesize = type->erasesize;
2838 mtd->writesize = type->pagesize;
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02002839 mtd->oobsize = mtd->writesize / 32;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002840 busw = type->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002841 }
2842
2843 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01002844 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002845 if (nand_manuf_ids[maf_idx].id == *maf_id)
2846 break;
2847 }
2848
2849 /*
2850 * Check, if buswidth is correct. Hardware drivers should set
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002851 * chip correct !
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002852 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002853 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002854 printk(KERN_INFO "NAND device: Manufacturer ID:"
2855 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
2856 dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
2857 printk(KERN_WARNING "NAND bus width %d instead %d bit\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002858 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002859 busw ? 16 : 8);
2860 return ERR_PTR(-EINVAL);
2861 }
2862
2863 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002864 chip->page_shift = ffs(mtd->writesize) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002865 /* Convert chipsize to number of pages per chip -1. */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002866 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002867
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002868 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002869 ffs(mtd->erasesize) - 1;
Adrian Hunter69423d92008-12-10 13:37:21 +00002870 if (chip->chipsize & 0xffffffff)
2871 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
2872 else
2873 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32)) + 32 - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002874
2875 /* Set the bad block position */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002876 chip->badblockpos = mtd->writesize > 512 ?
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002877 NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2878
2879 /* Get chip options, preserve non chip based options */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002880 chip->options &= ~NAND_CHIPOPTIONS_MSK;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002881 chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002882
2883 /*
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002884 * Set chip as a default. Board drivers can override it, if necessary
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002885 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002886 chip->options |= NAND_NO_AUTOINCR;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002887
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002888 /* Check if chip is a not a samsung device. Do not clear the
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002889 * options for chips which are not having an extended id.
2890 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002891 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002892 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002893
2894 /* Check for AND chips with 4 page planes */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002895 if (chip->options & NAND_4PAGE_ARRAY)
2896 chip->erase_cmd = multi_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002897 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002898 chip->erase_cmd = single_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002899
2900 /* Do not replace user supplied command function ! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002901 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
2902 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002903
2904 printk(KERN_INFO "NAND device: Manufacturer ID:"
2905 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id, dev_id,
2906 nand_manuf_ids[maf_idx].name, type->name);
2907
2908 return type;
2909}
2910
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002911/**
David Woodhouse3b85c322006-09-25 17:06:53 +01002912 * nand_scan_ident - [NAND Interface] Scan for the NAND device
2913 * @mtd: MTD device structure
2914 * @maxchips: Number of chips to scan for
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002915 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002916 * This is the first phase of the normal nand_scan() function. It
2917 * reads the flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002918 *
David Woodhouse3b85c322006-09-25 17:06:53 +01002919 * The mtd->owner field must be set to the module of the caller.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002920 */
David Woodhouse3b85c322006-09-25 17:06:53 +01002921int nand_scan_ident(struct mtd_info *mtd, int maxchips)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002922{
2923 int i, busw, nand_maf_id;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002924 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002925 struct nand_flash_dev *type;
2926
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002927 /* Get buswidth to select the correct functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002928 busw = chip->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002929 /* Set the default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002930 nand_set_defaults(chip, busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002931
2932 /* Read the flash type */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002933 type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002934
2935 if (IS_ERR(type)) {
Ben Dooksb1c6e6d2009-11-02 18:12:33 +00002936 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
2937 printk(KERN_WARNING "No NAND device found.\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002938 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002939 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 }
2941
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002942 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01002943 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002944 chip->select_chip(mtd, i);
Karl Beldanef89a882008-09-15 14:37:29 +02002945 /* See comment in nand_get_flash_type for reset */
2946 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002948 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002950 if (nand_maf_id != chip->read_byte(mtd) ||
2951 type->id != chip->read_byte(mtd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952 break;
2953 }
2954 if (i > 1)
2955 printk(KERN_INFO "%d NAND chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002956
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002958 chip->numchips = i;
2959 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960
David Woodhouse3b85c322006-09-25 17:06:53 +01002961 return 0;
2962}
2963
2964
2965/**
2966 * nand_scan_tail - [NAND Interface] Scan for the NAND device
2967 * @mtd: MTD device structure
David Woodhouse3b85c322006-09-25 17:06:53 +01002968 *
2969 * This is the second phase of the normal nand_scan() function. It
2970 * fills out all the uninitialized function pointers with the defaults
2971 * and scans for a bad block table if appropriate.
2972 */
2973int nand_scan_tail(struct mtd_info *mtd)
2974{
2975 int i;
2976 struct nand_chip *chip = mtd->priv;
2977
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002978 if (!(chip->options & NAND_OWN_BUFFERS))
2979 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
2980 if (!chip->buffers)
2981 return -ENOMEM;
2982
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01002983 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01002984 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002985
2986 /*
2987 * If no default placement scheme is given, select an appropriate one
2988 */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002989 if (!chip->ecc.layout) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002990 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991 case 8:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002992 chip->ecc.layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993 break;
2994 case 16:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002995 chip->ecc.layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996 break;
2997 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02002998 chip->ecc.layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999 break;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003000 case 128:
3001 chip->ecc.layout = &nand_oob_128;
3002 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003003 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003004 printk(KERN_WARNING "No oob scheme defined for "
3005 "oobsize %d\n", mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006 BUG();
3007 }
3008 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003009
David Woodhouse956e9442006-09-25 17:12:39 +01003010 if (!chip->write_page)
3011 chip->write_page = nand_write_page;
3012
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003013 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003014 * check ECC mode, default to software if 3byte/512byte hardware ECC is
3015 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01003016 */
David Woodhouse956e9442006-09-25 17:12:39 +01003017
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003018 switch (chip->ecc.mode) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003019 case NAND_ECC_HW_OOB_FIRST:
3020 /* Similar to NAND_ECC_HW, but a separate read_page handle */
3021 if (!chip->ecc.calculate || !chip->ecc.correct ||
3022 !chip->ecc.hwctl) {
3023 printk(KERN_WARNING "No ECC functions supplied; "
3024 "Hardware ECC not possible\n");
3025 BUG();
3026 }
3027 if (!chip->ecc.read_page)
3028 chip->ecc.read_page = nand_read_page_hwecc_oob_first;
3029
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003030 case NAND_ECC_HW:
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003031 /* Use standard hwecc read page function ? */
3032 if (!chip->ecc.read_page)
3033 chip->ecc.read_page = nand_read_page_hwecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003034 if (!chip->ecc.write_page)
3035 chip->ecc.write_page = nand_write_page_hwecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003036 if (!chip->ecc.read_page_raw)
3037 chip->ecc.read_page_raw = nand_read_page_raw;
3038 if (!chip->ecc.write_page_raw)
3039 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003040 if (!chip->ecc.read_oob)
3041 chip->ecc.read_oob = nand_read_oob_std;
3042 if (!chip->ecc.write_oob)
3043 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003044
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003045 case NAND_ECC_HW_SYNDROME:
Scott Wood78b65172007-12-13 11:15:28 -06003046 if ((!chip->ecc.calculate || !chip->ecc.correct ||
3047 !chip->ecc.hwctl) &&
3048 (!chip->ecc.read_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003049 chip->ecc.read_page == nand_read_page_hwecc ||
Scott Wood78b65172007-12-13 11:15:28 -06003050 !chip->ecc.write_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003051 chip->ecc.write_page == nand_write_page_hwecc)) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003052 printk(KERN_WARNING "No ECC functions supplied; "
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003053 "Hardware ECC not possible\n");
3054 BUG();
3055 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003056 /* Use standard syndrome read/write page function ? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003057 if (!chip->ecc.read_page)
3058 chip->ecc.read_page = nand_read_page_syndrome;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003059 if (!chip->ecc.write_page)
3060 chip->ecc.write_page = nand_write_page_syndrome;
David Brownell52ff49d2009-03-04 12:01:36 -08003061 if (!chip->ecc.read_page_raw)
3062 chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
3063 if (!chip->ecc.write_page_raw)
3064 chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003065 if (!chip->ecc.read_oob)
3066 chip->ecc.read_oob = nand_read_oob_syndrome;
3067 if (!chip->ecc.write_oob)
3068 chip->ecc.write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003069
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003070 if (mtd->writesize >= chip->ecc.size)
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003071 break;
3072 printk(KERN_WARNING "%d byte HW ECC not possible on "
3073 "%d byte page size, fallback to SW ECC\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003074 chip->ecc.size, mtd->writesize);
3075 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003077 case NAND_ECC_SOFT:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003078 chip->ecc.calculate = nand_calculate_ecc;
3079 chip->ecc.correct = nand_correct_data;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003080 chip->ecc.read_page = nand_read_page_swecc;
Alexey Korolev3d459552008-05-15 17:23:18 +01003081 chip->ecc.read_subpage = nand_read_subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003082 chip->ecc.write_page = nand_write_page_swecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003083 chip->ecc.read_page_raw = nand_read_page_raw;
3084 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003085 chip->ecc.read_oob = nand_read_oob_std;
3086 chip->ecc.write_oob = nand_write_oob_std;
Singh, Vimal9a732902008-12-12 00:10:57 +00003087 if (!chip->ecc.size)
3088 chip->ecc.size = 256;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003089 chip->ecc.bytes = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003091
3092 case NAND_ECC_NONE:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003093 printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
3094 "This is not recommended !!\n");
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02003095 chip->ecc.read_page = nand_read_page_raw;
3096 chip->ecc.write_page = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003097 chip->ecc.read_oob = nand_read_oob_std;
David Brownell52ff49d2009-03-04 12:01:36 -08003098 chip->ecc.read_page_raw = nand_read_page_raw;
3099 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003100 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003101 chip->ecc.size = mtd->writesize;
3102 chip->ecc.bytes = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 break;
David Woodhouse956e9442006-09-25 17:12:39 +01003104
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 default:
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003106 printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003107 chip->ecc.mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003108 BUG();
3109 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003110
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003111 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003112 * The number of bytes available for a client to place data into
3113 * the out of band area
3114 */
3115 chip->ecc.layout->oobavail = 0;
David Brownell81d19b02009-04-21 19:51:20 -07003116 for (i = 0; chip->ecc.layout->oobfree[i].length
3117 && i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003118 chip->ecc.layout->oobavail +=
3119 chip->ecc.layout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03003120 mtd->oobavail = chip->ecc.layout->oobavail;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003121
3122 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003123 * Set the number of read / write steps for one page depending on ECC
3124 * mode
3125 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003126 chip->ecc.steps = mtd->writesize / chip->ecc.size;
3127 if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003128 printk(KERN_WARNING "Invalid ecc parameters\n");
3129 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003131 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003132
Thomas Gleixner29072b92006-09-28 15:38:36 +02003133 /*
3134 * Allow subpage writes up to ecc.steps. Not possible for MLC
3135 * FLASH.
3136 */
3137 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
3138 !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
3139 switch(chip->ecc.steps) {
3140 case 2:
3141 mtd->subpage_sft = 1;
3142 break;
3143 case 4:
3144 case 8:
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003145 case 16:
Thomas Gleixner29072b92006-09-28 15:38:36 +02003146 mtd->subpage_sft = 2;
3147 break;
3148 }
3149 }
3150 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
3151
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02003152 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003153 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154
3155 /* De-select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003156 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
3158 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003159 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160
3161 /* Fill in remaining MTD driver data */
3162 mtd->type = MTD_NANDFLASH;
Joern Engel5fa43392006-05-22 23:18:29 +02003163 mtd->flags = MTD_CAP_NANDFLASH;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164 mtd->erase = nand_erase;
3165 mtd->point = NULL;
3166 mtd->unpoint = NULL;
3167 mtd->read = nand_read;
3168 mtd->write = nand_write;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02003169 mtd->panic_write = panic_nand_write;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 mtd->read_oob = nand_read_oob;
3171 mtd->write_oob = nand_write_oob;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172 mtd->sync = nand_sync;
3173 mtd->lock = NULL;
3174 mtd->unlock = NULL;
Vitaly Wool962034f2005-09-15 14:58:53 +01003175 mtd->suspend = nand_suspend;
3176 mtd->resume = nand_resume;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003177 mtd->block_isbad = nand_block_isbad;
3178 mtd->block_markbad = nand_block_markbad;
3179
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003180 /* propagate ecc.layout to mtd_info */
3181 mtd->ecclayout = chip->ecc.layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003183 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003184 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003185 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186
3187 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003188 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189}
3190
Rusty Russella6e6abd2009-03-31 13:05:31 -06003191/* is_module_text_address() isn't exported, and it's mostly a pointless
David Woodhouse3b85c322006-09-25 17:06:53 +01003192 test if this is a module _anyway_ -- they'd have to try _really_ hard
3193 to call us from in-kernel code if the core NAND support is modular. */
3194#ifdef MODULE
3195#define caller_is_module() (1)
3196#else
3197#define caller_is_module() \
Rusty Russella6e6abd2009-03-31 13:05:31 -06003198 is_module_text_address((unsigned long)__builtin_return_address(0))
David Woodhouse3b85c322006-09-25 17:06:53 +01003199#endif
3200
3201/**
3202 * nand_scan - [NAND Interface] Scan for the NAND device
3203 * @mtd: MTD device structure
3204 * @maxchips: Number of chips to scan for
3205 *
3206 * This fills out all the uninitialized function pointers
3207 * with the defaults.
3208 * The flash ID is read and the mtd/chip structures are
3209 * filled with the appropriate values.
3210 * The mtd->owner field must be set to the module of the caller
3211 *
3212 */
3213int nand_scan(struct mtd_info *mtd, int maxchips)
3214{
3215 int ret;
3216
3217 /* Many callers got this wrong, so check for it for a while... */
3218 if (!mtd->owner && caller_is_module()) {
vimal singh20d8e242009-07-07 15:49:49 +05303219 printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
3220 __func__);
David Woodhouse3b85c322006-09-25 17:06:53 +01003221 BUG();
3222 }
3223
3224 ret = nand_scan_ident(mtd, maxchips);
3225 if (!ret)
3226 ret = nand_scan_tail(mtd);
3227 return ret;
3228}
3229
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003231 * nand_release - [NAND Interface] Free resources held by the NAND device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232 * @mtd: MTD device structure
3233*/
David Woodhousee0c7d762006-05-13 18:07:53 +01003234void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003235{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003236 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237
3238#ifdef CONFIG_MTD_PARTITIONS
3239 /* Deregister partitions */
David Woodhousee0c7d762006-05-13 18:07:53 +01003240 del_mtd_partitions(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241#endif
3242 /* Deregister the device */
David Woodhousee0c7d762006-05-13 18:07:53 +01003243 del_mtd_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244
Jesper Juhlfa671642005-11-07 01:01:27 -08003245 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003246 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003247 if (!(chip->options & NAND_OWN_BUFFERS))
3248 kfree(chip->buffers);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249}
3250
Vimal Singh7d70f332010-02-08 15:50:49 +05303251EXPORT_SYMBOL_GPL(nand_lock);
3252EXPORT_SYMBOL_GPL(nand_unlock);
David Woodhousee0c7d762006-05-13 18:07:53 +01003253EXPORT_SYMBOL_GPL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01003254EXPORT_SYMBOL_GPL(nand_scan_ident);
3255EXPORT_SYMBOL_GPL(nand_scan_tail);
David Woodhousee0c7d762006-05-13 18:07:53 +01003256EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08003257
3258static int __init nand_base_init(void)
3259{
3260 led_trigger_register_simple("nand-disk", &nand_led_trigger);
3261 return 0;
3262}
3263
3264static void __exit nand_base_exit(void)
3265{
3266 led_trigger_unregister_simple(nand_led_trigger);
3267}
3268
3269module_init(nand_base_init);
3270module_exit(nand_base_exit);
3271
David Woodhousee0c7d762006-05-13 18:07:53 +01003272MODULE_LICENSE("GPL");
3273MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
3274MODULE_DESCRIPTION("Generic NAND flash driver code");