blob: 6d4894acb5671c399d17463cd5788dfa8596cd17 [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
Brian Norris7854d3f2011-06-23 14:12:08 -070024 * if we have HW ECC support.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 * 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>
Ivan Djelic193bd402011-03-11 11:05:33 +010045#include <linux/mtd/nand_bch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/interrupt.h>
47#include <linux/bitops.h>
Richard Purdie8fe833c2006-03-31 02:31:14 -080048#include <linux/leds.h>
Florian Fainelli7351d3a2010-09-07 13:23:45 +020049#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <linux/mtd/partitions.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52/* Define default oob placement schemes for large and small page devices */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020053static struct nand_ecclayout nand_oob_8 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 .eccbytes = 3,
55 .eccpos = {0, 1, 2},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020056 .oobfree = {
57 {.offset = 3,
58 .length = 2},
59 {.offset = 6,
Florian Fainellif8ac0412010-09-07 13:23:43 +020060 .length = 2} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070061};
62
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020063static struct nand_ecclayout nand_oob_16 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 .eccbytes = 6,
65 .eccpos = {0, 1, 2, 3, 6, 7},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020066 .oobfree = {
67 {.offset = 8,
Florian Fainellif8ac0412010-09-07 13:23:43 +020068 . length = 8} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070069};
70
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020071static struct nand_ecclayout nand_oob_64 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 .eccbytes = 24,
73 .eccpos = {
David Woodhousee0c7d762006-05-13 18:07:53 +010074 40, 41, 42, 43, 44, 45, 46, 47,
75 48, 49, 50, 51, 52, 53, 54, 55,
76 56, 57, 58, 59, 60, 61, 62, 63},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020077 .oobfree = {
78 {.offset = 2,
Florian Fainellif8ac0412010-09-07 13:23:43 +020079 .length = 38} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070080};
81
Thomas Gleixner81ec5362007-12-12 17:27:03 +010082static struct nand_ecclayout nand_oob_128 = {
83 .eccbytes = 48,
84 .eccpos = {
85 80, 81, 82, 83, 84, 85, 86, 87,
86 88, 89, 90, 91, 92, 93, 94, 95,
87 96, 97, 98, 99, 100, 101, 102, 103,
88 104, 105, 106, 107, 108, 109, 110, 111,
89 112, 113, 114, 115, 116, 117, 118, 119,
90 120, 121, 122, 123, 124, 125, 126, 127},
91 .oobfree = {
92 {.offset = 2,
Florian Fainellif8ac0412010-09-07 13:23:43 +020093 .length = 78} }
Thomas Gleixner81ec5362007-12-12 17:27:03 +010094};
95
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020096static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +020097 int new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020099static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
100 struct mtd_oob_ops *ops);
101
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200102/*
Joe Perches8e87d782008-02-03 17:22:34 +0200103 * For devices which display every fart in the system on a separate LED. Is
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200104 * compiled away when LED support is disabled.
105 */
106DEFINE_LED_TRIGGER(nand_led_trigger);
107
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530108static int check_offs_len(struct mtd_info *mtd,
109 loff_t ofs, uint64_t len)
110{
111 struct nand_chip *chip = mtd->priv;
112 int ret = 0;
113
114 /* Start address must align on block boundary */
115 if (ofs & ((1 << chip->phys_erase_shift) - 1)) {
Brian Norris289c0522011-07-19 10:06:09 -0700116 pr_debug("%s: unaligned address\n", __func__);
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530117 ret = -EINVAL;
118 }
119
120 /* Length must align on block boundary */
121 if (len & ((1 << chip->phys_erase_shift) - 1)) {
Brian Norris289c0522011-07-19 10:06:09 -0700122 pr_debug("%s: length not block aligned\n", __func__);
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530123 ret = -EINVAL;
124 }
125
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530126 return ret;
127}
128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/**
130 * nand_release_device - [GENERIC] release chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700131 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000132 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700133 * Deselect, release chip lock and wake up anyone waiting on the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100135static void nand_release_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200137 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139 /* De-select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200140 chip->select_chip(mtd, -1);
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100141
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200142 /* Release the controller and the chip */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200143 spin_lock(&chip->controller->lock);
144 chip->controller->active = NULL;
145 chip->state = FL_READY;
146 wake_up(&chip->controller->wq);
147 spin_unlock(&chip->controller->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148}
149
150/**
151 * nand_read_byte - [DEFAULT] read one byte from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700152 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700154 * Default read function for 8bit buswidth
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200156static uint8_t nand_read_byte(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200158 struct nand_chip *chip = mtd->priv;
159 return readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160}
161
162/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
Brian Norris7854d3f2011-06-23 14:12:08 -0700164 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700165 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700167 * Default read function for 16bit buswidth with endianness conversion.
168 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200170static uint8_t nand_read_byte16(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200172 struct nand_chip *chip = mtd->priv;
173 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174}
175
176/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 * nand_read_word - [DEFAULT] read one word from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700178 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700180 * Default read function for 16bit buswidth without endianness conversion.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 */
182static u16 nand_read_word(struct mtd_info *mtd)
183{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200184 struct nand_chip *chip = mtd->priv;
185 return readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186}
187
188/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 * nand_select_chip - [DEFAULT] control CE line
Brian Norris8b6e50c2011-05-25 14:59:01 -0700190 * @mtd: MTD device structure
191 * @chipnr: chipnumber to select, -1 for deselect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 *
193 * Default select function for 1 chip devices.
194 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200195static void nand_select_chip(struct mtd_info *mtd, int chipnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200197 struct nand_chip *chip = mtd->priv;
198
199 switch (chipnr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 case -1:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200201 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 break;
203 case 0:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 break;
205
206 default:
207 BUG();
208 }
209}
210
211/**
212 * nand_write_buf - [DEFAULT] write buffer to chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700213 * @mtd: MTD device structure
214 * @buf: data buffer
215 * @len: number of bytes to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700217 * Default write function for 8bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200219static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
221 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200222 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
David Woodhousee0c7d762006-05-13 18:07:53 +0100224 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200225 writeb(buf[i], chip->IO_ADDR_W);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226}
227
228/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000229 * nand_read_buf - [DEFAULT] read chip data into buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700230 * @mtd: MTD device structure
231 * @buf: buffer to store date
232 * @len: number of bytes to read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700234 * Default read function for 8bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200236static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
238 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200239 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
David Woodhousee0c7d762006-05-13 18:07:53 +0100241 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200242 buf[i] = readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243}
244
245/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000246 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700247 * @mtd: MTD device structure
248 * @buf: buffer containing the data to compare
249 * @len: number of bytes to compare
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700251 * Default verify function for 8bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200253static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
255 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200256 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
David Woodhousee0c7d762006-05-13 18:07:53 +0100258 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200259 if (buf[i] != readb(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 return 0;
262}
263
264/**
265 * nand_write_buf16 - [DEFAULT] write buffer to chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700266 * @mtd: MTD device structure
267 * @buf: data buffer
268 * @len: number of bytes to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700270 * Default write function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200272static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200275 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 u16 *p = (u16 *) buf;
277 len >>= 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000278
David Woodhousee0c7d762006-05-13 18:07:53 +0100279 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200280 writew(p[i], chip->IO_ADDR_W);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
284/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000285 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700286 * @mtd: MTD device structure
287 * @buf: buffer to store date
288 * @len: number of bytes to read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700290 * Default read function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200292static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
294 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200295 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 u16 *p = (u16 *) buf;
297 len >>= 1;
298
David Woodhousee0c7d762006-05-13 18:07:53 +0100299 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200300 p[i] = readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
303/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000304 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700305 * @mtd: MTD device structure
306 * @buf: buffer containing the data to compare
307 * @len: number of bytes to compare
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700309 * Default verify function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200311static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
313 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200314 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 u16 *p = (u16 *) buf;
316 len >>= 1;
317
David Woodhousee0c7d762006-05-13 18:07:53 +0100318 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200319 if (p[i] != readw(chip->IO_ADDR_R))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 return -EFAULT;
321
322 return 0;
323}
324
325/**
326 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700327 * @mtd: MTD device structure
328 * @ofs: offset from device start
329 * @getchip: 0, if the chip is already selected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000331 * Check, if the block is bad.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 */
333static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
334{
Brian Norriscdbec052012-01-13 18:11:48 -0800335 int page, chipnr, res = 0, i = 0;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200336 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 u16 bad;
338
Brian Norris5fb15492011-05-31 16:31:21 -0700339 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -0700340 ofs += mtd->erasesize - mtd->writesize;
341
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100342 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 if (getchip) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200345 chipnr = (int)(ofs >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200347 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200350 chip->select_chip(mtd, chipnr);
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Brian Norriscdbec052012-01-13 18:11:48 -0800353 do {
354 if (chip->options & NAND_BUSWIDTH_16) {
355 chip->cmdfunc(mtd, NAND_CMD_READOOB,
356 chip->badblockpos & 0xFE, page);
357 bad = cpu_to_le16(chip->read_word(mtd));
358 if (chip->badblockpos & 0x1)
359 bad >>= 8;
360 else
361 bad &= 0xFF;
362 } else {
363 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
364 page);
365 bad = chip->read_byte(mtd);
366 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000367
Brian Norriscdbec052012-01-13 18:11:48 -0800368 if (likely(chip->badblockbits == 8))
369 res = bad != 0xFF;
370 else
371 res = hweight8(bad) < chip->badblockbits;
372 ofs += mtd->writesize;
373 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
374 i++;
375 } while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
Maxim Levitskye0b58d02010-02-22 20:39:38 +0200376
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200377 if (getchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 nand_release_device(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 return res;
381}
382
383/**
384 * nand_default_block_markbad - [DEFAULT] mark a block bad
Brian Norris8b6e50c2011-05-25 14:59:01 -0700385 * @mtd: MTD device structure
386 * @ofs: offset from device start
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700388 * This is the default implementation, which can be overridden by a hardware
Brian Norrise2414f42012-02-06 13:44:00 -0800389 * specific driver. We try operations in the following order, according to our
390 * bbt_options (NAND_BBT_NO_OOB_BBM and NAND_BBT_USE_FLASH):
391 * (1) erase the affected block, to allow OOB marker to be written cleanly
392 * (2) update in-memory BBT
393 * (3) write bad block marker to OOB area of affected block
394 * (4) update flash-based BBT
395 * Note that we retain the first error encountered in (3) or (4), finish the
396 * procedures, and dump the error in the end.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397*/
398static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
399{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200400 struct nand_chip *chip = mtd->priv;
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200401 uint8_t buf[2] = { 0, 0 };
Brian Norrise2414f42012-02-06 13:44:00 -0800402 int block, res, ret = 0, i = 0;
403 int write_oob = !(chip->bbt_options & NAND_BBT_NO_OOB_BBM);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000404
Brian Norrise2414f42012-02-06 13:44:00 -0800405 if (write_oob) {
Brian Norris00918422012-01-13 18:11:47 -0800406 struct erase_info einfo;
407
408 /* Attempt erase before marking OOB */
409 memset(&einfo, 0, sizeof(einfo));
410 einfo.mtd = mtd;
411 einfo.addr = ofs;
412 einfo.len = 1 << chip->phys_erase_shift;
413 nand_erase_nand(mtd, &einfo, 0);
414 }
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 /* Get block number */
Andre Renaud4226b512007-04-17 13:50:59 -0400417 block = (int)(ofs >> chip->bbt_erase_shift);
Brian Norrise2414f42012-02-06 13:44:00 -0800418 /* Mark block bad in memory-based BBT */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200419 if (chip->bbt)
420 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Brian Norrise2414f42012-02-06 13:44:00 -0800422 /* Write bad block marker to OOB */
423 if (write_oob) {
Brian Norris4a89ff82011-08-30 18:45:45 -0700424 struct mtd_oob_ops ops;
Brian Norrisdf698622012-01-20 20:38:03 -0800425 loff_t wr_ofs = ofs;
Brian Norris4a89ff82011-08-30 18:45:45 -0700426
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300427 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000428
Brian Norris4a89ff82011-08-30 18:45:45 -0700429 ops.datbuf = NULL;
430 ops.oobbuf = buf;
Brian Norris85443312012-01-13 18:11:49 -0800431 ops.ooboffs = chip->badblockpos;
432 if (chip->options & NAND_BUSWIDTH_16) {
433 ops.ooboffs &= ~0x01;
434 ops.len = ops.ooblen = 2;
435 } else {
436 ops.len = ops.ooblen = 1;
437 }
Brian Norris23b1a992011-10-14 20:09:33 -0700438 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norrisdf698622012-01-20 20:38:03 -0800439
Brian Norrise2414f42012-02-06 13:44:00 -0800440 /* Write to first/last page(s) if necessary */
Brian Norrisdf698622012-01-20 20:38:03 -0800441 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
442 wr_ofs += mtd->erasesize - mtd->writesize;
Brian Norris02ed70b2010-07-21 16:53:47 -0700443 do {
Brian Norrise2414f42012-02-06 13:44:00 -0800444 res = nand_do_write_oob(mtd, wr_ofs, &ops);
445 if (!ret)
446 ret = res;
Brian Norris02ed70b2010-07-21 16:53:47 -0700447
Brian Norris02ed70b2010-07-21 16:53:47 -0700448 i++;
Brian Norrisdf698622012-01-20 20:38:03 -0800449 wr_ofs += mtd->writesize;
Brian Norrise2414f42012-02-06 13:44:00 -0800450 } while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
Brian Norris02ed70b2010-07-21 16:53:47 -0700451
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300452 nand_release_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200453 }
Brian Norrise2414f42012-02-06 13:44:00 -0800454
455 /* Update flash-based bad block table */
456 if (chip->bbt_options & NAND_BBT_USE_FLASH) {
457 res = nand_update_bbt(mtd, ofs);
458 if (!ret)
459 ret = res;
460 }
461
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200462 if (!ret)
463 mtd->ecc_stats.badblocks++;
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300464
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200465 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466}
467
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000468/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 * nand_check_wp - [GENERIC] check if the chip is write protected
Brian Norris8b6e50c2011-05-25 14:59:01 -0700470 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700472 * Check, if the device is write protected. The function expects, that the
473 * device is already selected.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100475static int nand_check_wp(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200477 struct nand_chip *chip = mtd->priv;
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200478
Brian Norris8b6e50c2011-05-25 14:59:01 -0700479 /* Broken xD cards report WP despite being writable */
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200480 if (chip->options & NAND_BROKEN_XD)
481 return 0;
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 /* Check the WP bit */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200484 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
485 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
488/**
489 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
Brian Norris8b6e50c2011-05-25 14:59:01 -0700490 * @mtd: MTD device structure
491 * @ofs: offset from device start
492 * @getchip: 0, if the chip is already selected
493 * @allowbbt: 1, if its allowed to access the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 *
495 * Check, if the block is bad. Either by reading the bad block table or
496 * calling of the scan function.
497 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200498static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
499 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200501 struct nand_chip *chip = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000502
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200503 if (!chip->bbt)
504 return chip->block_bad(mtd, ofs, getchip);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 /* Return info from the table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100507 return nand_isbad_bbt(mtd, ofs, allowbbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508}
509
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200510/**
511 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700512 * @mtd: MTD device structure
513 * @timeo: Timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200514 *
515 * Helper function for nand_wait_ready used when needing to wait in interrupt
516 * context.
517 */
518static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
519{
520 struct nand_chip *chip = mtd->priv;
521 int i;
522
523 /* Wait for the device to get ready */
524 for (i = 0; i < timeo; i++) {
525 if (chip->dev_ready(mtd))
526 break;
527 touch_softlockup_watchdog();
528 mdelay(1);
529 }
530}
531
Brian Norris7854d3f2011-06-23 14:12:08 -0700532/* Wait for the ready pin, after a command. The timeout is caught later. */
David Woodhouse4b648b02006-09-25 17:05:24 +0100533void nand_wait_ready(struct mtd_info *mtd)
Thomas Gleixner3b887752005-02-22 21:56:49 +0000534{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200535 struct nand_chip *chip = mtd->priv;
David Woodhousee0c7d762006-05-13 18:07:53 +0100536 unsigned long timeo = jiffies + 2;
Thomas Gleixner3b887752005-02-22 21:56:49 +0000537
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200538 /* 400ms timeout */
539 if (in_interrupt() || oops_in_progress)
540 return panic_nand_wait_ready(mtd, 400);
541
Richard Purdie8fe833c2006-03-31 02:31:14 -0800542 led_trigger_event(nand_led_trigger, LED_FULL);
Brian Norris7854d3f2011-06-23 14:12:08 -0700543 /* Wait until command is processed or timeout occurs */
Thomas Gleixner3b887752005-02-22 21:56:49 +0000544 do {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200545 if (chip->dev_ready(mtd))
Richard Purdie8fe833c2006-03-31 02:31:14 -0800546 break;
Ingo Molnar8446f1d2005-09-06 15:16:27 -0700547 touch_softlockup_watchdog();
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000548 } while (time_before(jiffies, timeo));
Richard Purdie8fe833c2006-03-31 02:31:14 -0800549 led_trigger_event(nand_led_trigger, LED_OFF);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000550}
David Woodhouse4b648b02006-09-25 17:05:24 +0100551EXPORT_SYMBOL_GPL(nand_wait_ready);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/**
554 * nand_command - [DEFAULT] Send command to NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700555 * @mtd: MTD device structure
556 * @command: the command to be sent
557 * @column: the column address for this command, -1 if none
558 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700560 * Send command to NAND device. This function is used for small page devices
561 * (256/512 Bytes per page).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200563static void nand_command(struct mtd_info *mtd, unsigned int command,
564 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200566 register struct nand_chip *chip = mtd->priv;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200567 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Brian Norris8b6e50c2011-05-25 14:59:01 -0700569 /* Write out the command to the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 if (command == NAND_CMD_SEQIN) {
571 int readcmd;
572
Joern Engel28318772006-05-22 23:18:05 +0200573 if (column >= mtd->writesize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 /* OOB area */
Joern Engel28318772006-05-22 23:18:05 +0200575 column -= mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 readcmd = NAND_CMD_READOOB;
577 } else if (column < 256) {
578 /* First 256 bytes --> READ0 */
579 readcmd = NAND_CMD_READ0;
580 } else {
581 column -= 256;
582 readcmd = NAND_CMD_READ1;
583 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200584 chip->cmd_ctrl(mtd, readcmd, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200585 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200587 chip->cmd_ctrl(mtd, command, ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Brian Norris8b6e50c2011-05-25 14:59:01 -0700589 /* Address cycle, when necessary */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200590 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
591 /* Serially input address */
592 if (column != -1) {
593 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200594 if (chip->options & NAND_BUSWIDTH_16)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200595 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200596 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200597 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 }
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200599 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200600 chip->cmd_ctrl(mtd, page_addr, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200601 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200602 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200603 /* One more address cycle for devices > 32MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200604 if (chip->chipsize > (32 << 20))
605 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200606 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200607 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000608
609 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700610 * Program and erase have their own busy handlers status and sequential
611 * in needs no delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100612 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 case NAND_CMD_PAGEPROG:
616 case NAND_CMD_ERASE1:
617 case NAND_CMD_ERASE2:
618 case NAND_CMD_SEQIN:
619 case NAND_CMD_STATUS:
620 return;
621
622 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200623 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200625 udelay(chip->chip_delay);
626 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200627 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200628 chip->cmd_ctrl(mtd,
629 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200630 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
631 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 return;
633
David Woodhousee0c7d762006-05-13 18:07:53 +0100634 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000636 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 * If we don't have access to the busy pin, we apply the given
638 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100639 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200640 if (!chip->dev_ready) {
641 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000643 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700645 /*
646 * Apply this short delay always to ensure that we do wait tWB in
647 * any case on any machine.
648 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100649 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000650
651 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
654/**
655 * nand_command_lp - [DEFAULT] Send command to NAND large page device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700656 * @mtd: MTD device structure
657 * @command: the command to be sent
658 * @column: the column address for this command, -1 if none
659 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 *
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200661 * Send command to NAND device. This is the version for the new large page
Brian Norris7854d3f2011-06-23 14:12:08 -0700662 * devices. We don't have the separate regions as we have in the small page
663 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200665static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
666 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200668 register struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670 /* Emulate NAND_CMD_READOOB */
671 if (command == NAND_CMD_READOOB) {
Joern Engel28318772006-05-22 23:18:05 +0200672 column += mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 command = NAND_CMD_READ0;
674 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000675
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200676 /* Command latch cycle */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200677 chip->cmd_ctrl(mtd, command & 0xff,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200678 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680 if (column != -1 || page_addr != -1) {
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200681 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683 /* Serially input address */
684 if (column != -1) {
685 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200686 if (chip->options & NAND_BUSWIDTH_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200688 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200689 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200690 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200693 chip->cmd_ctrl(mtd, page_addr, ctrl);
694 chip->cmd_ctrl(mtd, page_addr >> 8,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200695 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 /* One more address cycle for devices > 128MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200697 if (chip->chipsize > (128 << 20))
698 chip->cmd_ctrl(mtd, page_addr >> 16,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200699 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200702 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000703
704 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700705 * Program and erase have their own busy handlers status, sequential
706 * in, and deplete1 need no delay.
David A. Marlin30f464b2005-01-17 18:35:25 +0000707 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 case NAND_CMD_CACHEDPROG:
711 case NAND_CMD_PAGEPROG:
712 case NAND_CMD_ERASE1:
713 case NAND_CMD_ERASE2:
714 case NAND_CMD_SEQIN:
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200715 case NAND_CMD_RNDIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 case NAND_CMD_STATUS:
David A. Marlin30f464b2005-01-17 18:35:25 +0000717 case NAND_CMD_DEPLETE1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 return;
719
David A. Marlin30f464b2005-01-17 18:35:25 +0000720 case NAND_CMD_STATUS_ERROR:
721 case NAND_CMD_STATUS_ERROR0:
722 case NAND_CMD_STATUS_ERROR1:
723 case NAND_CMD_STATUS_ERROR2:
724 case NAND_CMD_STATUS_ERROR3:
Brian Norris8b6e50c2011-05-25 14:59:01 -0700725 /* Read error status commands require only a short delay */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200726 udelay(chip->chip_delay);
David A. Marlin30f464b2005-01-17 18:35:25 +0000727 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200730 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200732 udelay(chip->chip_delay);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200733 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
734 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
735 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
736 NAND_NCE | NAND_CTRL_CHANGE);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200737 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
738 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 return;
740
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200741 case NAND_CMD_RNDOUT:
742 /* No ready / busy check necessary */
743 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
744 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
745 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
746 NAND_NCE | NAND_CTRL_CHANGE);
747 return;
748
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 case NAND_CMD_READ0:
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200750 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
751 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
752 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
753 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000754
David Woodhousee0c7d762006-05-13 18:07:53 +0100755 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000757 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 * If we don't have access to the busy pin, we apply the given
Brian Norris8b6e50c2011-05-25 14:59:01 -0700759 * command delay.
David Woodhousee0c7d762006-05-13 18:07:53 +0100760 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200761 if (!chip->dev_ready) {
762 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000764 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 }
Thomas Gleixner3b887752005-02-22 21:56:49 +0000766
Brian Norris8b6e50c2011-05-25 14:59:01 -0700767 /*
768 * Apply this short delay always to ensure that we do wait tWB in
769 * any case on any machine.
770 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100771 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000772
773 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774}
775
776/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200777 * panic_nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700778 * @chip: the nand chip descriptor
779 * @mtd: MTD device structure
780 * @new_state: the state which is requested
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200781 *
782 * Used when in panic, no locks are taken.
783 */
784static void panic_nand_get_device(struct nand_chip *chip,
785 struct mtd_info *mtd, int new_state)
786{
Brian Norris7854d3f2011-06-23 14:12:08 -0700787 /* Hardware controller shared among independent devices */
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200788 chip->controller->active = chip;
789 chip->state = new_state;
790}
791
792/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 * nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700794 * @chip: the nand chip descriptor
795 * @mtd: MTD device structure
796 * @new_state: the state which is requested
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 *
798 * Get the device and lock it for exclusive access
799 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200800static int
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200801nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200803 spinlock_t *lock = &chip->controller->lock;
804 wait_queue_head_t *wq = &chip->controller->wq;
David Woodhousee0c7d762006-05-13 18:07:53 +0100805 DECLARE_WAITQUEUE(wait, current);
Florian Fainelli7351d3a2010-09-07 13:23:45 +0200806retry:
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100807 spin_lock(lock);
808
vimal singhb8b3ee92009-07-09 20:41:22 +0530809 /* Hardware controller shared among independent devices */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200810 if (!chip->controller->active)
811 chip->controller->active = chip;
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200812
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200813 if (chip->controller->active == chip && chip->state == FL_READY) {
814 chip->state = new_state;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100815 spin_unlock(lock);
Vitaly Wool962034f2005-09-15 14:58:53 +0100816 return 0;
817 }
818 if (new_state == FL_PM_SUSPENDED) {
Li Yang6b0d9a82009-11-17 14:45:49 -0800819 if (chip->controller->active->state == FL_PM_SUSPENDED) {
820 chip->state = FL_PM_SUSPENDED;
821 spin_unlock(lock);
822 return 0;
Li Yang6b0d9a82009-11-17 14:45:49 -0800823 }
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100824 }
825 set_current_state(TASK_UNINTERRUPTIBLE);
826 add_wait_queue(wq, &wait);
827 spin_unlock(lock);
828 schedule();
829 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 goto retry;
831}
832
833/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700834 * panic_nand_wait - [GENERIC] wait until the command is done
835 * @mtd: MTD device structure
836 * @chip: NAND chip structure
837 * @timeo: timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200838 *
839 * Wait for command done. This is a helper function for nand_wait used when
840 * we are in interrupt context. May happen when in panic and trying to write
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400841 * an oops through mtdoops.
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200842 */
843static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
844 unsigned long timeo)
845{
846 int i;
847 for (i = 0; i < timeo; i++) {
848 if (chip->dev_ready) {
849 if (chip->dev_ready(mtd))
850 break;
851 } else {
852 if (chip->read_byte(mtd) & NAND_STATUS_READY)
853 break;
854 }
855 mdelay(1);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200856 }
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200857}
858
859/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700860 * nand_wait - [DEFAULT] wait until the command is done
861 * @mtd: MTD device structure
862 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700864 * Wait for command done. This applies to erase and program only. Erase can
865 * take up to 400ms and program up to 20ms according to general NAND and
866 * SmartMedia specs.
Randy Dunlap844d3b42006-06-28 21:48:27 -0700867 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200868static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
870
David Woodhousee0c7d762006-05-13 18:07:53 +0100871 unsigned long timeo = jiffies;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200872 int status, state = chip->state;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 if (state == FL_ERASING)
David Woodhousee0c7d762006-05-13 18:07:53 +0100875 timeo += (HZ * 400) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 else
David Woodhousee0c7d762006-05-13 18:07:53 +0100877 timeo += (HZ * 20) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Richard Purdie8fe833c2006-03-31 02:31:14 -0800879 led_trigger_event(nand_led_trigger, LED_FULL);
880
Brian Norris8b6e50c2011-05-25 14:59:01 -0700881 /*
882 * Apply this short delay always to ensure that we do wait tWB in any
883 * case on any machine.
884 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100885 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200887 if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
888 chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000889 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200890 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200892 if (in_interrupt() || oops_in_progress)
893 panic_nand_wait(mtd, chip, timeo);
894 else {
895 while (time_before(jiffies, timeo)) {
896 if (chip->dev_ready) {
897 if (chip->dev_ready(mtd))
898 break;
899 } else {
900 if (chip->read_byte(mtd) & NAND_STATUS_READY)
901 break;
902 }
903 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800906 led_trigger_event(nand_led_trigger, LED_OFF);
907
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200908 status = (int)chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 return status;
910}
911
912/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700913 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700914 * @mtd: mtd info
915 * @ofs: offset to start unlock from
916 * @len: length to unlock
Brian Norris8b6e50c2011-05-25 14:59:01 -0700917 * @invert: when = 0, unlock the range of blocks within the lower and
918 * upper boundary address
919 * when = 1, unlock the range of blocks outside the boundaries
920 * of the lower and upper boundary address
Vimal Singh7d70f332010-02-08 15:50:49 +0530921 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700922 * Returs unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530923 */
924static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
925 uint64_t len, int invert)
926{
927 int ret = 0;
928 int status, page;
929 struct nand_chip *chip = mtd->priv;
930
931 /* Submit address of first page to unlock */
932 page = ofs >> chip->page_shift;
933 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
934
935 /* Submit address of last page to unlock */
936 page = (ofs + len) >> chip->page_shift;
937 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
938 (page | invert) & chip->pagemask);
939
940 /* Call wait ready function */
941 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +0530942 /* See if device thinks it succeeded */
943 if (status & 0x01) {
Brian Norris289c0522011-07-19 10:06:09 -0700944 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530945 __func__, status);
946 ret = -EIO;
947 }
948
949 return ret;
950}
951
952/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700953 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700954 * @mtd: mtd info
955 * @ofs: offset to start unlock from
956 * @len: length to unlock
Vimal Singh7d70f332010-02-08 15:50:49 +0530957 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700958 * Returns unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530959 */
960int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
961{
962 int ret = 0;
963 int chipnr;
964 struct nand_chip *chip = mtd->priv;
965
Brian Norris289c0522011-07-19 10:06:09 -0700966 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530967 __func__, (unsigned long long)ofs, len);
968
969 if (check_offs_len(mtd, ofs, len))
970 ret = -EINVAL;
971
972 /* Align to last block address if size addresses end of the device */
973 if (ofs + len == mtd->size)
974 len -= mtd->erasesize;
975
976 nand_get_device(chip, mtd, FL_UNLOCKING);
977
978 /* Shift to get chip number */
979 chipnr = ofs >> chip->chip_shift;
980
981 chip->select_chip(mtd, chipnr);
982
983 /* Check, if it is write protected */
984 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -0700985 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530986 __func__);
987 ret = -EIO;
988 goto out;
989 }
990
991 ret = __nand_unlock(mtd, ofs, len, 0);
992
993out:
Vimal Singh7d70f332010-02-08 15:50:49 +0530994 nand_release_device(mtd);
995
996 return ret;
997}
Florian Fainelli7351d3a2010-09-07 13:23:45 +0200998EXPORT_SYMBOL(nand_unlock);
Vimal Singh7d70f332010-02-08 15:50:49 +0530999
1000/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001001 * nand_lock - [REPLACEABLE] locks all blocks present in the device
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001002 * @mtd: mtd info
1003 * @ofs: offset to start unlock from
1004 * @len: length to unlock
Vimal Singh7d70f332010-02-08 15:50:49 +05301005 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001006 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
1007 * have this feature, but it allows only to lock all blocks, not for specified
1008 * range for block. Implementing 'lock' feature by making use of 'unlock', for
1009 * now.
Vimal Singh7d70f332010-02-08 15:50:49 +05301010 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001011 * Returns lock status.
Vimal Singh7d70f332010-02-08 15:50:49 +05301012 */
1013int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1014{
1015 int ret = 0;
1016 int chipnr, status, page;
1017 struct nand_chip *chip = mtd->priv;
1018
Brian Norris289c0522011-07-19 10:06:09 -07001019 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301020 __func__, (unsigned long long)ofs, len);
1021
1022 if (check_offs_len(mtd, ofs, len))
1023 ret = -EINVAL;
1024
1025 nand_get_device(chip, mtd, FL_LOCKING);
1026
1027 /* Shift to get chip number */
1028 chipnr = ofs >> chip->chip_shift;
1029
1030 chip->select_chip(mtd, chipnr);
1031
1032 /* Check, if it is write protected */
1033 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07001034 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301035 __func__);
1036 status = MTD_ERASE_FAILED;
1037 ret = -EIO;
1038 goto out;
1039 }
1040
1041 /* Submit address of first page to lock */
1042 page = ofs >> chip->page_shift;
1043 chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);
1044
1045 /* Call wait ready function */
1046 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +05301047 /* See if device thinks it succeeded */
1048 if (status & 0x01) {
Brian Norris289c0522011-07-19 10:06:09 -07001049 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301050 __func__, status);
1051 ret = -EIO;
1052 goto out;
1053 }
1054
1055 ret = __nand_unlock(mtd, ofs, len, 0x1);
1056
1057out:
Vimal Singh7d70f332010-02-08 15:50:49 +05301058 nand_release_device(mtd);
1059
1060 return ret;
1061}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001062EXPORT_SYMBOL(nand_lock);
Vimal Singh7d70f332010-02-08 15:50:49 +05301063
1064/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001065 * nand_read_page_raw - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001066 * @mtd: mtd info structure
1067 * @chip: nand chip info structure
1068 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001069 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001070 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001071 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001072 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001073 */
1074static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001075 uint8_t *buf, int oob_required, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001076{
1077 chip->read_buf(mtd, buf, mtd->writesize);
1078 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1079 return 0;
1080}
1081
1082/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001083 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001084 * @mtd: mtd info structure
1085 * @chip: nand chip info structure
1086 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001087 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001088 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001089 *
1090 * We need a special oob layout and handling even when OOB isn't used.
1091 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001092static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001093 struct nand_chip *chip, uint8_t *buf,
1094 int oob_required, int page)
David Brownell52ff49d2009-03-04 12:01:36 -08001095{
1096 int eccsize = chip->ecc.size;
1097 int eccbytes = chip->ecc.bytes;
1098 uint8_t *oob = chip->oob_poi;
1099 int steps, size;
1100
1101 for (steps = chip->ecc.steps; steps > 0; steps--) {
1102 chip->read_buf(mtd, buf, eccsize);
1103 buf += eccsize;
1104
1105 if (chip->ecc.prepad) {
1106 chip->read_buf(mtd, oob, chip->ecc.prepad);
1107 oob += chip->ecc.prepad;
1108 }
1109
1110 chip->read_buf(mtd, oob, eccbytes);
1111 oob += eccbytes;
1112
1113 if (chip->ecc.postpad) {
1114 chip->read_buf(mtd, oob, chip->ecc.postpad);
1115 oob += chip->ecc.postpad;
1116 }
1117 }
1118
1119 size = mtd->oobsize - (oob - chip->oob_poi);
1120 if (size)
1121 chip->read_buf(mtd, oob, size);
1122
1123 return 0;
1124}
1125
1126/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001127 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001128 * @mtd: mtd info structure
1129 * @chip: nand chip info structure
1130 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001131 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001132 * @page: page number to read
David A. Marlin068e3c02005-01-24 03:07:46 +00001133 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001134static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001135 uint8_t *buf, int oob_required, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001137 int i, eccsize = chip->ecc.size;
1138 int eccbytes = chip->ecc.bytes;
1139 int eccsteps = chip->ecc.steps;
1140 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001141 uint8_t *ecc_calc = chip->buffers->ecccalc;
1142 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001143 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001144 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001145
Brian Norris1fbb9382012-05-02 10:14:55 -07001146 chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001147
1148 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1149 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1150
1151 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001152 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001153
1154 eccsteps = chip->ecc.steps;
1155 p = buf;
1156
1157 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1158 int stat;
1159
1160 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001161 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001162 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001163 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001164 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001165 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1166 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001167 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001168 return max_bitflips;
Thomas Gleixner22c60f52005-04-04 19:56:32 +01001169}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001172 * nand_read_subpage - [REPLACEABLE] software ECC based sub-page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001173 * @mtd: mtd info structure
1174 * @chip: nand chip info structure
1175 * @data_offs: offset of requested data within the page
1176 * @readlen: data length
1177 * @bufpoi: buffer to store read data
Alexey Korolev3d459552008-05-15 17:23:18 +01001178 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001179static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
1180 uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
Alexey Korolev3d459552008-05-15 17:23:18 +01001181{
1182 int start_step, end_step, num_steps;
1183 uint32_t *eccpos = chip->ecc.layout->eccpos;
1184 uint8_t *p;
1185 int data_col_addr, i, gaps = 0;
1186 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
1187 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001188 int index = 0;
Mike Dunn3f91e942012-04-25 12:06:09 -07001189 unsigned int max_bitflips = 0;
Alexey Korolev3d459552008-05-15 17:23:18 +01001190
Brian Norris7854d3f2011-06-23 14:12:08 -07001191 /* Column address within the page aligned to ECC size (256bytes) */
Alexey Korolev3d459552008-05-15 17:23:18 +01001192 start_step = data_offs / chip->ecc.size;
1193 end_step = (data_offs + readlen - 1) / chip->ecc.size;
1194 num_steps = end_step - start_step + 1;
1195
Brian Norris8b6e50c2011-05-25 14:59:01 -07001196 /* Data size aligned to ECC ecc.size */
Alexey Korolev3d459552008-05-15 17:23:18 +01001197 datafrag_len = num_steps * chip->ecc.size;
1198 eccfrag_len = num_steps * chip->ecc.bytes;
1199
1200 data_col_addr = start_step * chip->ecc.size;
1201 /* If we read not a page aligned data */
1202 if (data_col_addr != 0)
1203 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
1204
1205 p = bufpoi + data_col_addr;
1206 chip->read_buf(mtd, p, datafrag_len);
1207
Brian Norris8b6e50c2011-05-25 14:59:01 -07001208 /* Calculate ECC */
Alexey Korolev3d459552008-05-15 17:23:18 +01001209 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1210 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1211
Brian Norris8b6e50c2011-05-25 14:59:01 -07001212 /*
1213 * The performance is faster if we position offsets according to
Brian Norris7854d3f2011-06-23 14:12:08 -07001214 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
Brian Norris8b6e50c2011-05-25 14:59:01 -07001215 */
Alexey Korolev3d459552008-05-15 17:23:18 +01001216 for (i = 0; i < eccfrag_len - 1; i++) {
1217 if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
1218 eccpos[i + start_step * chip->ecc.bytes + 1]) {
1219 gaps = 1;
1220 break;
1221 }
1222 }
1223 if (gaps) {
1224 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1225 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1226 } else {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001227 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07001228 * Send the command to read the particular ECC bytes take care
Brian Norris8b6e50c2011-05-25 14:59:01 -07001229 * about buswidth alignment in read_buf.
1230 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001231 index = start_step * chip->ecc.bytes;
1232
1233 aligned_pos = eccpos[index] & ~(busw - 1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001234 aligned_len = eccfrag_len;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001235 if (eccpos[index] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001236 aligned_len++;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001237 if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001238 aligned_len++;
1239
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001240 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
1241 mtd->writesize + aligned_pos, -1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001242 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1243 }
1244
1245 for (i = 0; i < eccfrag_len; i++)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001246 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
Alexey Korolev3d459552008-05-15 17:23:18 +01001247
1248 p = bufpoi + data_col_addr;
1249 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1250 int stat;
1251
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001252 stat = chip->ecc.correct(mtd, p,
1253 &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001254 if (stat < 0) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001255 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001256 } else {
Alexey Korolev3d459552008-05-15 17:23:18 +01001257 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001258 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1259 }
Alexey Korolev3d459552008-05-15 17:23:18 +01001260 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001261 return max_bitflips;
Alexey Korolev3d459552008-05-15 17:23:18 +01001262}
1263
1264/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001265 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001266 * @mtd: mtd info structure
1267 * @chip: nand chip info structure
1268 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001269 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001270 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001271 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001272 * Not for syndrome calculating ECC controllers which need a special oob layout.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001273 */
1274static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001275 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001276{
1277 int i, eccsize = chip->ecc.size;
1278 int eccbytes = chip->ecc.bytes;
1279 int eccsteps = chip->ecc.steps;
1280 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001281 uint8_t *ecc_calc = chip->buffers->ecccalc;
1282 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001283 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001284 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001285
1286 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
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 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001291 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001292
1293 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001294 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001295
1296 eccsteps = chip->ecc.steps;
1297 p = buf;
1298
1299 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1300 int stat;
1301
1302 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001303 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001304 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001305 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001306 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001307 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1308 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001309 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001310 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001311}
1312
1313/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001314 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
Brian Norris8b6e50c2011-05-25 14:59:01 -07001315 * @mtd: mtd info structure
1316 * @chip: nand chip info structure
1317 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001318 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001319 * @page: page number to read
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001320 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001321 * Hardware ECC for large page chips, require OOB to be read first. For this
1322 * ECC mode, the write_page method is re-used from ECC_HW. These methods
1323 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with
1324 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from
1325 * the data area, by overwriting the NAND manufacturer bad block markings.
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001326 */
1327static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001328 struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001329{
1330 int i, eccsize = chip->ecc.size;
1331 int eccbytes = chip->ecc.bytes;
1332 int eccsteps = chip->ecc.steps;
1333 uint8_t *p = buf;
1334 uint8_t *ecc_code = chip->buffers->ecccode;
1335 uint32_t *eccpos = chip->ecc.layout->eccpos;
1336 uint8_t *ecc_calc = chip->buffers->ecccalc;
Mike Dunn3f91e942012-04-25 12:06:09 -07001337 unsigned int max_bitflips = 0;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001338
1339 /* Read the OOB area first */
1340 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1341 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1342 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1343
1344 for (i = 0; i < chip->ecc.total; i++)
1345 ecc_code[i] = chip->oob_poi[eccpos[i]];
1346
1347 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1348 int stat;
1349
1350 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1351 chip->read_buf(mtd, p, eccsize);
1352 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1353
1354 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
Mike Dunn3f91e942012-04-25 12:06:09 -07001355 if (stat < 0) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001356 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001357 } else {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001358 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001359 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1360 }
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001361 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001362 return max_bitflips;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001363}
1364
1365/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001366 * nand_read_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page read
Brian Norris8b6e50c2011-05-25 14:59:01 -07001367 * @mtd: mtd info structure
1368 * @chip: nand chip info structure
1369 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001370 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001371 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001372 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001373 * The hw generator calculates the error syndrome automatically. Therefore we
1374 * need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001375 */
1376static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001377 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001378{
1379 int i, eccsize = chip->ecc.size;
1380 int eccbytes = chip->ecc.bytes;
1381 int eccsteps = chip->ecc.steps;
1382 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001383 uint8_t *oob = chip->oob_poi;
Mike Dunn3f91e942012-04-25 12:06:09 -07001384 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001385
1386 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1387 int stat;
1388
1389 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1390 chip->read_buf(mtd, p, eccsize);
1391
1392 if (chip->ecc.prepad) {
1393 chip->read_buf(mtd, oob, chip->ecc.prepad);
1394 oob += chip->ecc.prepad;
1395 }
1396
1397 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1398 chip->read_buf(mtd, oob, eccbytes);
1399 stat = chip->ecc.correct(mtd, p, oob, NULL);
1400
Mike Dunn3f91e942012-04-25 12:06:09 -07001401 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001402 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001403 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001404 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001405 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1406 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001407
1408 oob += eccbytes;
1409
1410 if (chip->ecc.postpad) {
1411 chip->read_buf(mtd, oob, chip->ecc.postpad);
1412 oob += chip->ecc.postpad;
1413 }
1414 }
1415
1416 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001417 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001418 if (i)
1419 chip->read_buf(mtd, oob, i);
1420
Mike Dunn3f91e942012-04-25 12:06:09 -07001421 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001422}
1423
1424/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001425 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -07001426 * @chip: nand chip structure
1427 * @oob: oob destination address
1428 * @ops: oob ops structure
1429 * @len: size of oob to transfer
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001430 */
1431static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
Vitaly Wool70145682006-11-03 18:20:38 +03001432 struct mtd_oob_ops *ops, size_t len)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001433{
Florian Fainellif8ac0412010-09-07 13:23:43 +02001434 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001435
Brian Norris0612b9d2011-08-30 18:45:40 -07001436 case MTD_OPS_PLACE_OOB:
1437 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001438 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1439 return oob + len;
1440
Brian Norris0612b9d2011-08-30 18:45:40 -07001441 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001442 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001443 uint32_t boffs = 0, roffs = ops->ooboffs;
1444 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001445
Florian Fainellif8ac0412010-09-07 13:23:43 +02001446 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001447 /* Read request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001448 if (unlikely(roffs)) {
1449 if (roffs >= free->length) {
1450 roffs -= free->length;
1451 continue;
1452 }
1453 boffs = free->offset + roffs;
1454 bytes = min_t(size_t, len,
1455 (free->length - roffs));
1456 roffs = 0;
1457 } else {
1458 bytes = min_t(size_t, len, free->length);
1459 boffs = free->offset;
1460 }
1461 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001462 oob += bytes;
1463 }
1464 return oob;
1465 }
1466 default:
1467 BUG();
1468 }
1469 return NULL;
1470}
1471
1472/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001473 * nand_do_read_ops - [INTERN] Read data with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001474 * @mtd: MTD device structure
1475 * @from: offset to read from
1476 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +00001477 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001478 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +00001479 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001480static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1481 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +00001482{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001483 int chipnr, page, realpage, col, bytes, aligned;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001484 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001485 struct mtd_ecc_stats stats;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001486 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001487 uint32_t readlen = ops->len;
Vitaly Wool70145682006-11-03 18:20:38 +03001488 uint32_t oobreadlen = ops->ooblen;
Brian Norris0612b9d2011-08-30 18:45:40 -07001489 uint32_t max_oobsize = ops->mode == MTD_OPS_AUTO_OOB ?
Maxim Levitsky9aca3342010-02-22 20:39:35 +02001490 mtd->oobavail : mtd->oobsize;
1491
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001492 uint8_t *bufpoi, *oob, *buf;
Mike Dunnedbc45402012-04-25 12:06:11 -07001493 unsigned int max_bitflips = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001495 stats = mtd->ecc_stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001497 chipnr = (int)(from >> chip->chip_shift);
1498 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001500 realpage = (int)(from >> chip->page_shift);
1501 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001503 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001505 buf = ops->datbuf;
1506 oob = ops->oobbuf;
1507
Florian Fainellif8ac0412010-09-07 13:23:43 +02001508 while (1) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001509 bytes = min(mtd->writesize - col, readlen);
1510 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001511
Brian Norris8b6e50c2011-05-25 14:59:01 -07001512 /* Is the current page in the buffer? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001513 if (realpage != chip->pagebuf || oob) {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001514 bufpoi = aligned ? buf : chip->buffers->databuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Brian Norrisc00a0992012-05-01 17:12:54 -07001516 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Mike Dunnedbc45402012-04-25 12:06:11 -07001518 /*
1519 * Now read the page into the buffer. Absent an error,
1520 * the read methods return max bitflips per ecc step.
1521 */
Brian Norris0612b9d2011-08-30 18:45:40 -07001522 if (unlikely(ops->mode == MTD_OPS_RAW))
Brian Norris1fbb9382012-05-02 10:14:55 -07001523 ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
1524 1, page);
Alexey Korolev3d459552008-05-15 17:23:18 +01001525 else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001526 ret = chip->ecc.read_subpage(mtd, chip,
1527 col, bytes, bufpoi);
David Woodhouse956e9442006-09-25 17:12:39 +01001528 else
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001529 ret = chip->ecc.read_page(mtd, chip, bufpoi,
Brian Norris1fbb9382012-05-02 10:14:55 -07001530 1, page);
Brian Norris6d77b9d2011-09-07 13:13:40 -07001531 if (ret < 0) {
1532 if (!aligned)
1533 /* Invalidate page cache */
1534 chip->pagebuf = -1;
David Woodhousee0c7d762006-05-13 18:07:53 +01001535 break;
Brian Norris6d77b9d2011-09-07 13:13:40 -07001536 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001537
Mike Dunnedbc45402012-04-25 12:06:11 -07001538 max_bitflips = max_t(unsigned int, max_bitflips, ret);
1539
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001540 /* Transfer not aligned data */
1541 if (!aligned) {
Artem Bityutskiyc1194c72010-09-03 22:01:16 +03001542 if (!NAND_SUBPAGE_READ(chip) && !oob &&
Brian Norris6d77b9d2011-09-07 13:13:40 -07001543 !(mtd->ecc_stats.failed - stats.failed) &&
Mike Dunnedbc45402012-04-25 12:06:11 -07001544 (ops->mode != MTD_OPS_RAW)) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001545 chip->pagebuf = realpage;
Mike Dunnedbc45402012-04-25 12:06:11 -07001546 chip->pagebuf_bitflips = ret;
1547 } else {
Brian Norris6d77b9d2011-09-07 13:13:40 -07001548 /* Invalidate page cache */
1549 chip->pagebuf = -1;
Mike Dunnedbc45402012-04-25 12:06:11 -07001550 }
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001551 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001553
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001554 buf += bytes;
1555
1556 if (unlikely(oob)) {
Maxim Levitsky9aca3342010-02-22 20:39:35 +02001557
Maxim Levitskyb64d39d2010-02-22 20:39:37 +02001558 int toread = min(oobreadlen, max_oobsize);
1559
1560 if (toread) {
1561 oob = nand_transfer_oob(chip,
1562 oob, ops, toread);
1563 oobreadlen -= toread;
1564 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001565 }
1566
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001567 if (!(chip->options & NAND_NO_READRDY)) {
Brian Norrisc00a0992012-05-01 17:12:54 -07001568 /* Apply delay or wait for ready/busy pin */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001569 if (!chip->dev_ready)
1570 udelay(chip->chip_delay);
1571 else
1572 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001574 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001575 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001576 buf += bytes;
Mike Dunnedbc45402012-04-25 12:06:11 -07001577 max_bitflips = max_t(unsigned int, max_bitflips,
1578 chip->pagebuf_bitflips);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001579 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001581 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001582
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001583 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001584 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Brian Norris8b6e50c2011-05-25 14:59:01 -07001586 /* For subsequent reads align to page boundary */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 col = 0;
1588 /* Increment page address */
1589 realpage++;
1590
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001591 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 /* Check, if we cross a chip boundary */
1593 if (!page) {
1594 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001595 chip->select_chip(mtd, -1);
1596 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 }
1599
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001600 ops->retlen = ops->len - (size_t) readlen;
Vitaly Wool70145682006-11-03 18:20:38 +03001601 if (oob)
1602 ops->oobretlen = ops->ooblen - oobreadlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
Mike Dunn3f91e942012-04-25 12:06:09 -07001604 if (ret < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001605 return ret;
1606
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001607 if (mtd->ecc_stats.failed - stats.failed)
1608 return -EBADMSG;
1609
Mike Dunnedbc45402012-04-25 12:06:11 -07001610 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001611}
1612
1613/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001614 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001615 * @mtd: MTD device structure
1616 * @from: offset to read from
1617 * @len: number of bytes to read
1618 * @retlen: pointer to variable to store the number of read bytes
1619 * @buf: the databuffer to put data
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001620 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001621 * Get hold of the chip and call nand_do_read.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001622 */
1623static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1624 size_t *retlen, uint8_t *buf)
1625{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001626 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07001627 struct mtd_oob_ops ops;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001628 int ret;
1629
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001630 nand_get_device(chip, mtd, FL_READING);
Brian Norris4a89ff82011-08-30 18:45:45 -07001631 ops.len = len;
1632 ops.datbuf = buf;
1633 ops.oobbuf = NULL;
Brian Norris23b1a992011-10-14 20:09:33 -07001634 ops.mode = 0;
Brian Norris4a89ff82011-08-30 18:45:45 -07001635 ret = nand_do_read_ops(mtd, from, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07001636 *retlen = ops.retlen;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001637 nand_release_device(mtd);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001638 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
1640
1641/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001642 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001643 * @mtd: mtd info structure
1644 * @chip: nand chip info structure
1645 * @page: page number to read
1646 * @sndcmd: flag whether to issue read command or not
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001647 */
1648static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1649 int page, int sndcmd)
1650{
1651 if (sndcmd) {
1652 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1653 sndcmd = 0;
1654 }
1655 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1656 return sndcmd;
1657}
1658
1659/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001660 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001661 * with syndromes
Brian Norris8b6e50c2011-05-25 14:59:01 -07001662 * @mtd: mtd info structure
1663 * @chip: nand chip info structure
1664 * @page: page number to read
1665 * @sndcmd: flag whether to issue read command or not
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001666 */
1667static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1668 int page, int sndcmd)
1669{
1670 uint8_t *buf = chip->oob_poi;
1671 int length = mtd->oobsize;
1672 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1673 int eccsize = chip->ecc.size;
1674 uint8_t *bufpoi = buf;
1675 int i, toread, sndrnd = 0, pos;
1676
1677 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1678 for (i = 0; i < chip->ecc.steps; i++) {
1679 if (sndrnd) {
1680 pos = eccsize + i * (eccsize + chunk);
1681 if (mtd->writesize > 512)
1682 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1683 else
1684 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1685 } else
1686 sndrnd = 1;
1687 toread = min_t(int, length, chunk);
1688 chip->read_buf(mtd, bufpoi, toread);
1689 bufpoi += toread;
1690 length -= toread;
1691 }
1692 if (length > 0)
1693 chip->read_buf(mtd, bufpoi, length);
1694
1695 return 1;
1696}
1697
1698/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001699 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001700 * @mtd: mtd info structure
1701 * @chip: nand chip info structure
1702 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001703 */
1704static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1705 int page)
1706{
1707 int status = 0;
1708 const uint8_t *buf = chip->oob_poi;
1709 int length = mtd->oobsize;
1710
1711 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1712 chip->write_buf(mtd, buf, length);
1713 /* Send command to program the OOB data */
1714 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1715
1716 status = chip->waitfunc(mtd, chip);
1717
Savin Zlobec0d420f92006-06-21 11:51:20 +02001718 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001719}
1720
1721/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001722 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001723 * with syndrome - only for large page flash
1724 * @mtd: mtd info structure
1725 * @chip: nand chip info structure
1726 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001727 */
1728static int nand_write_oob_syndrome(struct mtd_info *mtd,
1729 struct nand_chip *chip, int page)
1730{
1731 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1732 int eccsize = chip->ecc.size, length = mtd->oobsize;
1733 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1734 const uint8_t *bufpoi = chip->oob_poi;
1735
1736 /*
1737 * data-ecc-data-ecc ... ecc-oob
1738 * or
1739 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1740 */
1741 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1742 pos = steps * (eccsize + chunk);
1743 steps = 0;
1744 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001745 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001746
1747 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1748 for (i = 0; i < steps; i++) {
1749 if (sndcmd) {
1750 if (mtd->writesize <= 512) {
1751 uint32_t fill = 0xFFFFFFFF;
1752
1753 len = eccsize;
1754 while (len > 0) {
1755 int num = min_t(int, len, 4);
1756 chip->write_buf(mtd, (uint8_t *)&fill,
1757 num);
1758 len -= num;
1759 }
1760 } else {
1761 pos = eccsize + i * (eccsize + chunk);
1762 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1763 }
1764 } else
1765 sndcmd = 1;
1766 len = min_t(int, length, chunk);
1767 chip->write_buf(mtd, bufpoi, len);
1768 bufpoi += len;
1769 length -= len;
1770 }
1771 if (length > 0)
1772 chip->write_buf(mtd, bufpoi, length);
1773
1774 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1775 status = chip->waitfunc(mtd, chip);
1776
1777 return status & NAND_STATUS_FAIL ? -EIO : 0;
1778}
1779
1780/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001781 * nand_do_read_oob - [INTERN] NAND read out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07001782 * @mtd: MTD device structure
1783 * @from: offset to read from
1784 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001786 * NAND read out-of-band data from the spare area.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001788static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1789 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790{
Brian Norrisc00a0992012-05-01 17:12:54 -07001791 int page, realpage, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001792 struct nand_chip *chip = mtd->priv;
Brian Norris041e4572011-06-23 16:45:24 -07001793 struct mtd_ecc_stats stats;
Vitaly Wool70145682006-11-03 18:20:38 +03001794 int readlen = ops->ooblen;
1795 int len;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001796 uint8_t *buf = ops->oobbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Brian Norris289c0522011-07-19 10:06:09 -07001798 pr_debug("%s: from = 0x%08Lx, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05301799 __func__, (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Brian Norris041e4572011-06-23 16:45:24 -07001801 stats = mtd->ecc_stats;
1802
Brian Norris0612b9d2011-08-30 18:45:40 -07001803 if (ops->mode == MTD_OPS_AUTO_OOB)
Vitaly Wool70145682006-11-03 18:20:38 +03001804 len = chip->ecc.layout->oobavail;
Adrian Hunter03736152007-01-31 17:58:29 +02001805 else
1806 len = mtd->oobsize;
1807
1808 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07001809 pr_debug("%s: attempt to start read outside oob\n",
1810 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001811 return -EINVAL;
1812 }
1813
1814 /* Do not allow reads past end of device */
1815 if (unlikely(from >= mtd->size ||
1816 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1817 (from >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07001818 pr_debug("%s: attempt to read beyond end of device\n",
1819 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001820 return -EINVAL;
1821 }
Vitaly Wool70145682006-11-03 18:20:38 +03001822
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001823 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001824 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001826 /* Shift to get page */
1827 realpage = (int)(from >> chip->page_shift);
1828 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Florian Fainellif8ac0412010-09-07 13:23:43 +02001830 while (1) {
Brian Norris0612b9d2011-08-30 18:45:40 -07001831 if (ops->mode == MTD_OPS_RAW)
Brian Norrisc00a0992012-05-01 17:12:54 -07001832 chip->ecc.read_oob_raw(mtd, chip, page, 1);
Brian Norrisc46f6482011-08-30 18:45:38 -07001833 else
Brian Norrisc00a0992012-05-01 17:12:54 -07001834 chip->ecc.read_oob(mtd, chip, page, 1);
Vitaly Wool70145682006-11-03 18:20:38 +03001835
1836 len = min(len, readlen);
1837 buf = nand_transfer_oob(chip, buf, ops, len);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001838
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001839 if (!(chip->options & NAND_NO_READRDY)) {
Brian Norrisc00a0992012-05-01 17:12:54 -07001840 /* Apply delay or wait for ready/busy pin */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001841 if (!chip->dev_ready)
1842 udelay(chip->chip_delay);
Thomas Gleixner19870da2005-07-15 14:53:51 +01001843 else
1844 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 }
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001846
Vitaly Wool70145682006-11-03 18:20:38 +03001847 readlen -= len;
Savin Zlobec0d420f92006-06-21 11:51:20 +02001848 if (!readlen)
1849 break;
1850
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001851 /* Increment page address */
1852 realpage++;
1853
1854 page = realpage & chip->pagemask;
1855 /* Check, if we cross a chip boundary */
1856 if (!page) {
1857 chipnr++;
1858 chip->select_chip(mtd, -1);
1859 chip->select_chip(mtd, chipnr);
1860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 }
1862
Vitaly Wool70145682006-11-03 18:20:38 +03001863 ops->oobretlen = ops->ooblen;
Brian Norris041e4572011-06-23 16:45:24 -07001864
1865 if (mtd->ecc_stats.failed - stats.failed)
1866 return -EBADMSG;
1867
1868 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869}
1870
1871/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001872 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07001873 * @mtd: MTD device structure
1874 * @from: offset to read from
1875 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001877 * NAND read data and/or out-of-band data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001879static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1880 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001882 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001883 int ret = -ENOTSUPP;
1884
1885 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
1887 /* Do not allow reads past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03001888 if (ops->datbuf && (from + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07001889 pr_debug("%s: attempt to read beyond end of device\n",
1890 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 return -EINVAL;
1892 }
1893
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001894 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Florian Fainellif8ac0412010-09-07 13:23:43 +02001896 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07001897 case MTD_OPS_PLACE_OOB:
1898 case MTD_OPS_AUTO_OOB:
1899 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001900 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001901
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001902 default:
1903 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 }
1905
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001906 if (!ops->datbuf)
1907 ret = nand_do_read_oob(mtd, from, ops);
1908 else
1909 ret = nand_do_read_ops(mtd, from, ops);
1910
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001911out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001913 return ret;
1914}
1915
1916
1917/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001918 * nand_write_page_raw - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001919 * @mtd: mtd info structure
1920 * @chip: nand chip info structure
1921 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001922 * @oob_required: must write chip->oob_poi to OOB
David Brownell52ff49d2009-03-04 12:01:36 -08001923 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001924 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001925 */
1926static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001927 const uint8_t *buf, int oob_required)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001928{
1929 chip->write_buf(mtd, buf, mtd->writesize);
1930 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931}
1932
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001933/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001934 * nand_write_page_raw_syndrome - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001935 * @mtd: mtd info structure
1936 * @chip: nand chip info structure
1937 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001938 * @oob_required: must write chip->oob_poi to OOB
David Brownell52ff49d2009-03-04 12:01:36 -08001939 *
1940 * We need a special oob layout and handling even when ECC isn't checked.
1941 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001942static void nand_write_page_raw_syndrome(struct mtd_info *mtd,
1943 struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001944 const uint8_t *buf, int oob_required)
David Brownell52ff49d2009-03-04 12:01:36 -08001945{
1946 int eccsize = chip->ecc.size;
1947 int eccbytes = chip->ecc.bytes;
1948 uint8_t *oob = chip->oob_poi;
1949 int steps, size;
1950
1951 for (steps = chip->ecc.steps; steps > 0; steps--) {
1952 chip->write_buf(mtd, buf, eccsize);
1953 buf += eccsize;
1954
1955 if (chip->ecc.prepad) {
1956 chip->write_buf(mtd, oob, chip->ecc.prepad);
1957 oob += chip->ecc.prepad;
1958 }
1959
1960 chip->read_buf(mtd, oob, eccbytes);
1961 oob += eccbytes;
1962
1963 if (chip->ecc.postpad) {
1964 chip->write_buf(mtd, oob, chip->ecc.postpad);
1965 oob += chip->ecc.postpad;
1966 }
1967 }
1968
1969 size = mtd->oobsize - (oob - chip->oob_poi);
1970 if (size)
1971 chip->write_buf(mtd, oob, size);
1972}
1973/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001974 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001975 * @mtd: mtd info structure
1976 * @chip: nand chip info structure
1977 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001978 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001979 */
1980static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001981 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001982{
1983 int i, eccsize = chip->ecc.size;
1984 int eccbytes = chip->ecc.bytes;
1985 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001986 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001987 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001988 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001989
Brian Norris7854d3f2011-06-23 14:12:08 -07001990 /* Software ECC calculation */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001991 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1992 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001993
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001994 for (i = 0; i < chip->ecc.total; i++)
1995 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001996
Brian Norris1fbb9382012-05-02 10:14:55 -07001997 chip->ecc.write_page_raw(mtd, chip, buf, 1);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001998}
1999
2000/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002001 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002002 * @mtd: mtd info structure
2003 * @chip: nand chip info structure
2004 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002005 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002006 */
2007static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07002008 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002009{
2010 int i, eccsize = chip->ecc.size;
2011 int eccbytes = chip->ecc.bytes;
2012 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002013 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002014 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01002015 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002016
2017 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2018 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01002019 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002020 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
2021 }
2022
2023 for (i = 0; i < chip->ecc.total; i++)
2024 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2025
2026 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
2027}
2028
2029/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002030 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
Brian Norris8b6e50c2011-05-25 14:59:01 -07002031 * @mtd: mtd info structure
2032 * @chip: nand chip info structure
2033 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002034 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002035 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002036 * The hw generator calculates the error syndrome automatically. Therefore we
2037 * need a special oob layout and handling.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002038 */
2039static void nand_write_page_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07002040 struct nand_chip *chip,
2041 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002042{
2043 int i, eccsize = chip->ecc.size;
2044 int eccbytes = chip->ecc.bytes;
2045 int eccsteps = chip->ecc.steps;
2046 const uint8_t *p = buf;
2047 uint8_t *oob = chip->oob_poi;
2048
2049 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2050
2051 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2052 chip->write_buf(mtd, p, eccsize);
2053
2054 if (chip->ecc.prepad) {
2055 chip->write_buf(mtd, oob, chip->ecc.prepad);
2056 oob += chip->ecc.prepad;
2057 }
2058
2059 chip->ecc.calculate(mtd, p, oob);
2060 chip->write_buf(mtd, oob, eccbytes);
2061 oob += eccbytes;
2062
2063 if (chip->ecc.postpad) {
2064 chip->write_buf(mtd, oob, chip->ecc.postpad);
2065 oob += chip->ecc.postpad;
2066 }
2067 }
2068
2069 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04002070 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002071 if (i)
2072 chip->write_buf(mtd, oob, i);
2073}
2074
2075/**
David Woodhouse956e9442006-09-25 17:12:39 +01002076 * nand_write_page - [REPLACEABLE] write one page
Brian Norris8b6e50c2011-05-25 14:59:01 -07002077 * @mtd: MTD device structure
2078 * @chip: NAND chip descriptor
2079 * @buf: the data to write
Brian Norris1fbb9382012-05-02 10:14:55 -07002080 * @oob_required: must write chip->oob_poi to OOB
Brian Norris8b6e50c2011-05-25 14:59:01 -07002081 * @page: page number to write
2082 * @cached: cached programming
2083 * @raw: use _raw version of write_page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002084 */
2085static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07002086 const uint8_t *buf, int oob_required, int page,
2087 int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002088{
2089 int status;
2090
2091 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
2092
David Woodhouse956e9442006-09-25 17:12:39 +01002093 if (unlikely(raw))
Brian Norris1fbb9382012-05-02 10:14:55 -07002094 chip->ecc.write_page_raw(mtd, chip, buf, oob_required);
David Woodhouse956e9442006-09-25 17:12:39 +01002095 else
Brian Norris1fbb9382012-05-02 10:14:55 -07002096 chip->ecc.write_page(mtd, chip, buf, oob_required);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002097
2098 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07002099 * Cached progamming disabled for now. Not sure if it's worth the
Brian Norris8b6e50c2011-05-25 14:59:01 -07002100 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002101 */
2102 cached = 0;
2103
2104 if (!cached || !(chip->options & NAND_CACHEPRG)) {
2105
2106 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002107 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002108 /*
2109 * See if operation failed and additional status checks are
Brian Norris8b6e50c2011-05-25 14:59:01 -07002110 * available.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002111 */
2112 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2113 status = chip->errstat(mtd, chip, FL_WRITING, status,
2114 page);
2115
2116 if (status & NAND_STATUS_FAIL)
2117 return -EIO;
2118 } else {
2119 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002120 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002121 }
2122
2123#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
2124 /* Send command to read back the data */
2125 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
2126
2127 if (chip->verify_buf(mtd, buf, mtd->writesize))
2128 return -EIO;
Bastian Hecht09cbe582012-04-27 12:19:31 +02002129
2130 /* Make sure the next page prog is preceded by a status read */
2131 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002132#endif
2133 return 0;
2134}
2135
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002136/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002137 * nand_fill_oob - [INTERN] Transfer client buffer to oob
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002138 * @mtd: MTD device structure
Brian Norris8b6e50c2011-05-25 14:59:01 -07002139 * @oob: oob data buffer
2140 * @len: oob data write length
2141 * @ops: oob ops structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002142 */
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002143static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
2144 struct mtd_oob_ops *ops)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002145{
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002146 struct nand_chip *chip = mtd->priv;
2147
2148 /*
2149 * Initialise to all 0xFF, to avoid the possibility of left over OOB
2150 * data from a previous OOB read.
2151 */
2152 memset(chip->oob_poi, 0xff, mtd->oobsize);
2153
Florian Fainellif8ac0412010-09-07 13:23:43 +02002154 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002155
Brian Norris0612b9d2011-08-30 18:45:40 -07002156 case MTD_OPS_PLACE_OOB:
2157 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002158 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
2159 return oob + len;
2160
Brian Norris0612b9d2011-08-30 18:45:40 -07002161 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002162 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002163 uint32_t boffs = 0, woffs = ops->ooboffs;
2164 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002165
Florian Fainellif8ac0412010-09-07 13:23:43 +02002166 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002167 /* Write request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002168 if (unlikely(woffs)) {
2169 if (woffs >= free->length) {
2170 woffs -= free->length;
2171 continue;
2172 }
2173 boffs = free->offset + woffs;
2174 bytes = min_t(size_t, len,
2175 (free->length - woffs));
2176 woffs = 0;
2177 } else {
2178 bytes = min_t(size_t, len, free->length);
2179 boffs = free->offset;
2180 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02002181 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002182 oob += bytes;
2183 }
2184 return oob;
2185 }
2186 default:
2187 BUG();
2188 }
2189 return NULL;
2190}
2191
Florian Fainellif8ac0412010-09-07 13:23:43 +02002192#define NOTALIGNED(x) ((x & (chip->subpagesize - 1)) != 0)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002193
2194/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002195 * nand_do_write_ops - [INTERN] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002196 * @mtd: MTD device structure
2197 * @to: offset to write to
2198 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002199 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002200 * NAND write with ECC.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002201 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002202static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
2203 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002204{
Thomas Gleixner29072b92006-09-28 15:38:36 +02002205 int chipnr, realpage, page, blockmask, column;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002206 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002207 uint32_t writelen = ops->len;
Maxim Levitsky782ce792010-02-22 20:39:36 +02002208
2209 uint32_t oobwritelen = ops->ooblen;
Brian Norris0612b9d2011-08-30 18:45:40 -07002210 uint32_t oobmaxlen = ops->mode == MTD_OPS_AUTO_OOB ?
Maxim Levitsky782ce792010-02-22 20:39:36 +02002211 mtd->oobavail : mtd->oobsize;
2212
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002213 uint8_t *oob = ops->oobbuf;
2214 uint8_t *buf = ops->datbuf;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002215 int ret, subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002216
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002217 ops->retlen = 0;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002218 if (!writelen)
2219 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002220
Brian Norris8b6e50c2011-05-25 14:59:01 -07002221 /* Reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002222 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002223 pr_notice("%s: attempt to write non page aligned data\n",
2224 __func__);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002225 return -EINVAL;
2226 }
2227
Thomas Gleixner29072b92006-09-28 15:38:36 +02002228 column = to & (mtd->writesize - 1);
2229 subpage = column || (writelen & (mtd->writesize - 1));
2230
2231 if (subpage && oob)
2232 return -EINVAL;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002233
Thomas Gleixner6a930962006-06-28 00:11:45 +02002234 chipnr = (int)(to >> chip->chip_shift);
2235 chip->select_chip(mtd, chipnr);
2236
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002237 /* Check, if it is write protected */
2238 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002239 return -EIO;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002240
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002241 realpage = (int)(to >> chip->page_shift);
2242 page = realpage & chip->pagemask;
2243 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2244
2245 /* Invalidate the page cache, when we write to the cached page */
2246 if (to <= (chip->pagebuf << chip->page_shift) &&
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002247 (chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002248 chip->pagebuf = -1;
2249
Maxim Levitsky782ce792010-02-22 20:39:36 +02002250 /* Don't allow multipage oob writes with offset */
Jon Poveycdcf12b2010-09-30 20:41:34 +09002251 if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen))
Maxim Levitsky782ce792010-02-22 20:39:36 +02002252 return -EINVAL;
2253
Florian Fainellif8ac0412010-09-07 13:23:43 +02002254 while (1) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02002255 int bytes = mtd->writesize;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002256 int cached = writelen > bytes && page != blockmask;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002257 uint8_t *wbuf = buf;
2258
Brian Norris8b6e50c2011-05-25 14:59:01 -07002259 /* Partial page write? */
Thomas Gleixner29072b92006-09-28 15:38:36 +02002260 if (unlikely(column || writelen < (mtd->writesize - 1))) {
2261 cached = 0;
2262 bytes = min_t(int, bytes - column, (int) writelen);
2263 chip->pagebuf = -1;
2264 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2265 memcpy(&chip->buffers->databuf[column], buf, bytes);
2266 wbuf = chip->buffers->databuf;
2267 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002268
Maxim Levitsky782ce792010-02-22 20:39:36 +02002269 if (unlikely(oob)) {
2270 size_t len = min(oobwritelen, oobmaxlen);
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002271 oob = nand_fill_oob(mtd, oob, len, ops);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002272 oobwritelen -= len;
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002273 } else {
2274 /* We still need to erase leftover OOB data */
2275 memset(chip->oob_poi, 0xff, mtd->oobsize);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002276 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002277
Brian Norris1fbb9382012-05-02 10:14:55 -07002278 ret = chip->write_page(mtd, chip, wbuf, 1, page, cached,
Brian Norris0612b9d2011-08-30 18:45:40 -07002279 (ops->mode == MTD_OPS_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002280 if (ret)
2281 break;
2282
2283 writelen -= bytes;
2284 if (!writelen)
2285 break;
2286
Thomas Gleixner29072b92006-09-28 15:38:36 +02002287 column = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002288 buf += bytes;
2289 realpage++;
2290
2291 page = realpage & chip->pagemask;
2292 /* Check, if we cross a chip boundary */
2293 if (!page) {
2294 chipnr++;
2295 chip->select_chip(mtd, -1);
2296 chip->select_chip(mtd, chipnr);
2297 }
2298 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002299
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002300 ops->retlen = ops->len - writelen;
Vitaly Wool70145682006-11-03 18:20:38 +03002301 if (unlikely(oob))
2302 ops->oobretlen = ops->ooblen;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002303 return ret;
2304}
2305
2306/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002307 * panic_nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002308 * @mtd: MTD device structure
2309 * @to: offset to write to
2310 * @len: number of bytes to write
2311 * @retlen: pointer to variable to store the number of written bytes
2312 * @buf: the data to write
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002313 *
2314 * NAND write with ECC. Used when performing writes in interrupt context, this
2315 * may for example be called by mtdoops when writing an oops while in panic.
2316 */
2317static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2318 size_t *retlen, const uint8_t *buf)
2319{
2320 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07002321 struct mtd_oob_ops ops;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002322 int ret;
2323
Brian Norris8b6e50c2011-05-25 14:59:01 -07002324 /* Wait for the device to get ready */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002325 panic_nand_wait(mtd, chip, 400);
2326
Brian Norris8b6e50c2011-05-25 14:59:01 -07002327 /* Grab the device */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002328 panic_nand_get_device(chip, mtd, FL_WRITING);
2329
Brian Norris4a89ff82011-08-30 18:45:45 -07002330 ops.len = len;
2331 ops.datbuf = (uint8_t *)buf;
2332 ops.oobbuf = NULL;
Brian Norris23b1a992011-10-14 20:09:33 -07002333 ops.mode = 0;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002334
Brian Norris4a89ff82011-08-30 18:45:45 -07002335 ret = nand_do_write_ops(mtd, to, &ops);
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002336
Brian Norris4a89ff82011-08-30 18:45:45 -07002337 *retlen = ops.retlen;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002338 return ret;
2339}
2340
2341/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002342 * nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002343 * @mtd: MTD device structure
2344 * @to: offset to write to
2345 * @len: number of bytes to write
2346 * @retlen: pointer to variable to store the number of written bytes
2347 * @buf: the data to write
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002349 * NAND write with ECC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002351static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002352 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002354 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07002355 struct mtd_oob_ops ops;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002356 int ret;
2357
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002358 nand_get_device(chip, mtd, FL_WRITING);
Brian Norris4a89ff82011-08-30 18:45:45 -07002359 ops.len = len;
2360 ops.datbuf = (uint8_t *)buf;
2361 ops.oobbuf = NULL;
Brian Norris23b1a992011-10-14 20:09:33 -07002362 ops.mode = 0;
Brian Norris4a89ff82011-08-30 18:45:45 -07002363 ret = nand_do_write_ops(mtd, to, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07002364 *retlen = ops.retlen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002365 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002366 return ret;
2367}
2368
2369/**
2370 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002371 * @mtd: MTD device structure
2372 * @to: offset to write to
2373 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002374 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002375 * NAND write out-of-band.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002376 */
2377static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2378 struct mtd_oob_ops *ops)
2379{
Adrian Hunter03736152007-01-31 17:58:29 +02002380 int chipnr, page, status, len;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002381 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382
Brian Norris289c0522011-07-19 10:06:09 -07002383 pr_debug("%s: to = 0x%08x, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05302384 __func__, (unsigned int)to, (int)ops->ooblen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385
Brian Norris0612b9d2011-08-30 18:45:40 -07002386 if (ops->mode == MTD_OPS_AUTO_OOB)
Adrian Hunter03736152007-01-31 17:58:29 +02002387 len = chip->ecc.layout->oobavail;
2388 else
2389 len = mtd->oobsize;
2390
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 /* Do not allow write past end of page */
Adrian Hunter03736152007-01-31 17:58:29 +02002392 if ((ops->ooboffs + ops->ooblen) > len) {
Brian Norris289c0522011-07-19 10:06:09 -07002393 pr_debug("%s: attempt to write past end of page\n",
2394 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 return -EINVAL;
2396 }
2397
Adrian Hunter03736152007-01-31 17:58:29 +02002398 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002399 pr_debug("%s: attempt to start write outside oob\n",
2400 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002401 return -EINVAL;
2402 }
2403
Jason Liu775adc32011-02-25 13:06:18 +08002404 /* Do not allow write past end of device */
Adrian Hunter03736152007-01-31 17:58:29 +02002405 if (unlikely(to >= mtd->size ||
2406 ops->ooboffs + ops->ooblen >
2407 ((mtd->size >> chip->page_shift) -
2408 (to >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002409 pr_debug("%s: attempt to write beyond end of device\n",
2410 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002411 return -EINVAL;
2412 }
2413
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002414 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002415 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002417 /* Shift to get page */
2418 page = (int)(to >> chip->page_shift);
2419
2420 /*
2421 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2422 * of my DiskOnChip 2000 test units) will clear the whole data page too
2423 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2424 * it in the doc2000 driver in August 1999. dwmw2.
2425 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002426 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427
2428 /* Check, if it is write protected */
2429 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002430 return -EROFS;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002431
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002433 if (page == chip->pagebuf)
2434 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002436 nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
Brian Norris9ce244b2011-08-30 18:45:37 -07002437
Brian Norris0612b9d2011-08-30 18:45:40 -07002438 if (ops->mode == MTD_OPS_RAW)
Brian Norris9ce244b2011-08-30 18:45:37 -07002439 status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
2440 else
2441 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002442
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002443 if (status)
2444 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Vitaly Wool70145682006-11-03 18:20:38 +03002446 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002448 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002449}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002451/**
2452 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002453 * @mtd: MTD device structure
2454 * @to: offset to write to
2455 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002456 */
2457static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2458 struct mtd_oob_ops *ops)
2459{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002460 struct nand_chip *chip = mtd->priv;
2461 int ret = -ENOTSUPP;
2462
2463 ops->retlen = 0;
2464
2465 /* Do not allow writes past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002466 if (ops->datbuf && (to + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07002467 pr_debug("%s: attempt to write beyond end of device\n",
2468 __func__);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002469 return -EINVAL;
2470 }
2471
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002472 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002473
Florian Fainellif8ac0412010-09-07 13:23:43 +02002474 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07002475 case MTD_OPS_PLACE_OOB:
2476 case MTD_OPS_AUTO_OOB:
2477 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002478 break;
2479
2480 default:
2481 goto out;
2482 }
2483
2484 if (!ops->datbuf)
2485 ret = nand_do_write_oob(mtd, to, ops);
2486 else
2487 ret = nand_do_write_ops(mtd, to, ops);
2488
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002489out:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002490 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 return ret;
2492}
2493
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002495 * single_erase_cmd - [GENERIC] NAND standard block erase command function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002496 * @mtd: MTD device structure
2497 * @page: the page address of the block which will be erased
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002499 * Standard erase command for NAND chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002501static void single_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002503 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002505 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2506 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507}
2508
2509/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002510 * multi_erase_cmd - [GENERIC] AND specific block erase command function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002511 * @mtd: MTD device structure
2512 * @page: the page address of the block which will be erased
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002514 * AND multi block erase command function. Erase 4 consecutive blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002516static void multi_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002518 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002520 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2521 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2522 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2523 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2524 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525}
2526
2527/**
2528 * nand_erase - [MTD Interface] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002529 * @mtd: MTD device structure
2530 * @instr: erase instruction
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002532 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002534static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535{
David Woodhousee0c7d762006-05-13 18:07:53 +01002536 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002538
David A. Marlin30f464b2005-01-17 18:35:25 +00002539#define BBT_PAGE_MASK 0xffffff3f
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002541 * nand_erase_nand - [INTERN] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002542 * @mtd: MTD device structure
2543 * @instr: erase instruction
2544 * @allowbbt: allow erasing the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002546 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002548int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2549 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550{
Adrian Hunter69423d92008-12-10 13:37:21 +00002551 int page, status, pages_per_block, ret, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002552 struct nand_chip *chip = mtd->priv;
Florian Fainellif8ac0412010-09-07 13:23:43 +02002553 loff_t rewrite_bbt[NAND_MAX_CHIPS] = {0};
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002554 unsigned int bbt_masked_page = 0xffffffff;
Adrian Hunter69423d92008-12-10 13:37:21 +00002555 loff_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
Brian Norris289c0522011-07-19 10:06:09 -07002557 pr_debug("%s: start = 0x%012llx, len = %llu\n",
2558 __func__, (unsigned long long)instr->addr,
2559 (unsigned long long)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560
Vimal Singh6fe5a6a2010-02-03 14:12:24 +05302561 if (check_offs_len(mtd, instr->addr, instr->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002565 nand_get_device(chip, mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
2567 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002568 page = (int)(instr->addr >> chip->page_shift);
2569 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570
2571 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002572 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573
2574 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002575 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 /* Check, if it is write protected */
2578 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07002579 pr_debug("%s: device is write protected!\n",
2580 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 instr->state = MTD_ERASE_FAILED;
2582 goto erase_exit;
2583 }
2584
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002585 /*
2586 * If BBT requires refresh, set the BBT page mask to see if the BBT
2587 * should be rewritten. Otherwise the mask is set to 0xffffffff which
2588 * can not be matched. This is also done when the bbt is actually
Brian Norris7854d3f2011-06-23 14:12:08 -07002589 * erased to avoid recursive updates.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002590 */
2591 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
2592 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
David A. Marlin30f464b2005-01-17 18:35:25 +00002593
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 /* Loop through the pages */
2595 len = instr->len;
2596
2597 instr->state = MTD_ERASING;
2598
2599 while (len) {
Wolfram Sang12183a22011-12-21 23:01:20 +01002600 /* Check if we have a bad block, we do not erase bad blocks! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002601 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2602 chip->page_shift, 0, allowbbt)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002603 pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
2604 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 instr->state = MTD_ERASE_FAILED;
2606 goto erase_exit;
2607 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002608
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002609 /*
2610 * Invalidate the page cache, if we erase the block which
Brian Norris8b6e50c2011-05-25 14:59:01 -07002611 * contains the current cached page.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002612 */
2613 if (page <= chip->pagebuf && chip->pagebuf <
2614 (page + pages_per_block))
2615 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002617 chip->erase_cmd(mtd, page & chip->pagemask);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002618
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002619 status = chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002621 /*
2622 * See if operation failed and additional status checks are
2623 * available
2624 */
2625 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2626 status = chip->errstat(mtd, chip, FL_ERASING,
2627 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00002628
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00002630 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -07002631 pr_debug("%s: failed erase, page 0x%08x\n",
2632 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 instr->state = MTD_ERASE_FAILED;
Adrian Hunter69423d92008-12-10 13:37:21 +00002634 instr->fail_addr =
2635 ((loff_t)page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 goto erase_exit;
2637 }
David A. Marlin30f464b2005-01-17 18:35:25 +00002638
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002639 /*
2640 * If BBT requires refresh, set the BBT rewrite flag to the
Brian Norris8b6e50c2011-05-25 14:59:01 -07002641 * page being erased.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002642 */
2643 if (bbt_masked_page != 0xffffffff &&
2644 (page & BBT_PAGE_MASK) == bbt_masked_page)
Adrian Hunter69423d92008-12-10 13:37:21 +00002645 rewrite_bbt[chipnr] =
2646 ((loff_t)page << chip->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002647
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 /* Increment page address and decrement length */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002649 len -= (1 << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 page += pages_per_block;
2651
2652 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002653 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002655 chip->select_chip(mtd, -1);
2656 chip->select_chip(mtd, chipnr);
David A. Marlin30f464b2005-01-17 18:35:25 +00002657
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002658 /*
2659 * If BBT requires refresh and BBT-PERCHIP, set the BBT
Brian Norris8b6e50c2011-05-25 14:59:01 -07002660 * page mask to see if this BBT should be rewritten.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002661 */
2662 if (bbt_masked_page != 0xffffffff &&
2663 (chip->bbt_td->options & NAND_BBT_PERCHIP))
2664 bbt_masked_page = chip->bbt_td->pages[chipnr] &
2665 BBT_PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 }
2667 }
2668 instr->state = MTD_ERASE_DONE;
2669
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002670erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
2672 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673
2674 /* Deselect and wake up anyone waiting on the device */
2675 nand_release_device(mtd);
2676
David Woodhouse49defc02007-10-06 15:01:59 -04002677 /* Do call back function */
2678 if (!ret)
2679 mtd_erase_callback(instr);
2680
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002681 /*
2682 * If BBT requires refresh and erase was successful, rewrite any
Brian Norris8b6e50c2011-05-25 14:59:01 -07002683 * selected bad block tables.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002684 */
2685 if (bbt_masked_page == 0xffffffff || ret)
2686 return ret;
2687
2688 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2689 if (!rewrite_bbt[chipnr])
2690 continue;
Brian Norris8b6e50c2011-05-25 14:59:01 -07002691 /* Update the BBT for chip */
Brian Norris289c0522011-07-19 10:06:09 -07002692 pr_debug("%s: nand_update_bbt (%d:0x%0llx 0x%0x)\n",
2693 __func__, chipnr, rewrite_bbt[chipnr],
2694 chip->bbt_td->pages[chipnr]);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002695 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
David A. Marlin30f464b2005-01-17 18:35:25 +00002696 }
2697
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698 /* Return more or less happy */
2699 return ret;
2700}
2701
2702/**
2703 * nand_sync - [MTD Interface] sync
Brian Norris8b6e50c2011-05-25 14:59:01 -07002704 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002706 * Sync is actually a wait for chip ready function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002708static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002710 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711
Brian Norris289c0522011-07-19 10:06:09 -07002712 pr_debug("%s: called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713
2714 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002715 nand_get_device(chip, mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01002717 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718}
2719
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002721 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07002722 * @mtd: MTD device structure
2723 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002725static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002727 return nand_block_checkbad(mtd, offs, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728}
2729
2730/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002731 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07002732 * @mtd: MTD device structure
2733 * @ofs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002735static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002737 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 int ret;
2739
Florian Fainellif8ac0412010-09-07 13:23:43 +02002740 ret = nand_block_isbad(mtd, ofs);
2741 if (ret) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002742 /* If it was bad already, return success and do nothing */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 if (ret > 0)
2744 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01002745 return ret;
2746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002748 return chip->block_markbad(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749}
2750
2751/**
Vitaly Wool962034f2005-09-15 14:58:53 +01002752 * nand_suspend - [MTD Interface] Suspend the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07002753 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01002754 */
2755static int nand_suspend(struct mtd_info *mtd)
2756{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002757 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002758
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002759 return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01002760}
2761
2762/**
2763 * nand_resume - [MTD Interface] Resume the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07002764 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01002765 */
2766static void nand_resume(struct mtd_info *mtd)
2767{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002768 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002769
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002770 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01002771 nand_release_device(mtd);
2772 else
Brian Norrisd0370212011-07-19 10:06:08 -07002773 pr_err("%s called for a chip which is not in suspended state\n",
2774 __func__);
Vitaly Wool962034f2005-09-15 14:58:53 +01002775}
2776
Brian Norris8b6e50c2011-05-25 14:59:01 -07002777/* Set default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002778static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002779{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002781 if (!chip->chip_delay)
2782 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
2784 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002785 if (chip->cmdfunc == NULL)
2786 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787
2788 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002789 if (chip->waitfunc == NULL)
2790 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002792 if (!chip->select_chip)
2793 chip->select_chip = nand_select_chip;
2794 if (!chip->read_byte)
2795 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2796 if (!chip->read_word)
2797 chip->read_word = nand_read_word;
2798 if (!chip->block_bad)
2799 chip->block_bad = nand_block_bad;
2800 if (!chip->block_markbad)
2801 chip->block_markbad = nand_default_block_markbad;
2802 if (!chip->write_buf)
2803 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2804 if (!chip->read_buf)
2805 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2806 if (!chip->verify_buf)
2807 chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2808 if (!chip->scan_bbt)
2809 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002810
2811 if (!chip->controller) {
2812 chip->controller = &chip->hwcontrol;
2813 spin_lock_init(&chip->controller->lock);
2814 init_waitqueue_head(&chip->controller->wq);
2815 }
2816
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002817}
2818
Brian Norris8b6e50c2011-05-25 14:59:01 -07002819/* Sanitize ONFI strings so we can safely print them */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002820static void sanitize_string(uint8_t *s, size_t len)
2821{
2822 ssize_t i;
2823
Brian Norris8b6e50c2011-05-25 14:59:01 -07002824 /* Null terminate */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002825 s[len - 1] = 0;
2826
Brian Norris8b6e50c2011-05-25 14:59:01 -07002827 /* Remove non printable chars */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002828 for (i = 0; i < len - 1; i++) {
2829 if (s[i] < ' ' || s[i] > 127)
2830 s[i] = '?';
2831 }
2832
Brian Norris8b6e50c2011-05-25 14:59:01 -07002833 /* Remove trailing spaces */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002834 strim(s);
2835}
2836
2837static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
2838{
2839 int i;
2840 while (len--) {
2841 crc ^= *p++ << 8;
2842 for (i = 0; i < 8; i++)
2843 crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
2844 }
2845
2846 return crc;
2847}
2848
2849/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07002850 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002851 */
2852static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002853 int *busw)
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002854{
2855 struct nand_onfi_params *p = &chip->onfi_params;
2856 int i;
2857 int val;
2858
Brian Norris7854d3f2011-06-23 14:12:08 -07002859 /* Try ONFI for unknown chip or LP */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002860 chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
2861 if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
2862 chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
2863 return 0;
2864
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002865 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
2866 for (i = 0; i < 3; i++) {
2867 chip->read_buf(mtd, (uint8_t *)p, sizeof(*p));
2868 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
2869 le16_to_cpu(p->crc)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07002870 pr_info("ONFI param page %d valid\n", i);
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002871 break;
2872 }
2873 }
2874
2875 if (i == 3)
2876 return 0;
2877
Brian Norris8b6e50c2011-05-25 14:59:01 -07002878 /* Check version */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002879 val = le16_to_cpu(p->revision);
Brian Norrisb7b1a292010-12-12 00:23:33 -08002880 if (val & (1 << 5))
2881 chip->onfi_version = 23;
2882 else if (val & (1 << 4))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002883 chip->onfi_version = 22;
2884 else if (val & (1 << 3))
2885 chip->onfi_version = 21;
2886 else if (val & (1 << 2))
2887 chip->onfi_version = 20;
Brian Norrisb7b1a292010-12-12 00:23:33 -08002888 else if (val & (1 << 1))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002889 chip->onfi_version = 10;
Brian Norrisb7b1a292010-12-12 00:23:33 -08002890 else
2891 chip->onfi_version = 0;
2892
2893 if (!chip->onfi_version) {
Brian Norrisd0370212011-07-19 10:06:08 -07002894 pr_info("%s: unsupported ONFI version: %d\n", __func__, val);
Brian Norrisb7b1a292010-12-12 00:23:33 -08002895 return 0;
2896 }
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002897
2898 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
2899 sanitize_string(p->model, sizeof(p->model));
2900 if (!mtd->name)
2901 mtd->name = p->model;
2902 mtd->writesize = le32_to_cpu(p->byte_per_page);
2903 mtd->erasesize = le32_to_cpu(p->pages_per_block) * mtd->writesize;
2904 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
Matthieu CASTET63795752012-03-19 15:35:25 +01002905 chip->chipsize = le32_to_cpu(p->blocks_per_lun);
2906 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002907 *busw = 0;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002908 if (le16_to_cpu(p->features) & 1)
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002909 *busw = NAND_BUSWIDTH_16;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002910
2911 chip->options &= ~NAND_CHIPOPTIONS_MSK;
Brian Norris1826dbc2012-05-01 17:12:55 -07002912 chip->options |= NAND_NO_READRDY & NAND_CHIPOPTIONS_MSK;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002913
Huang Shijied42b5de2012-02-17 11:22:37 +08002914 pr_info("ONFI flash detected\n");
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002915 return 1;
2916}
2917
2918/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07002919 * Get the flash and manufacturer id and lookup if the type is supported.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002920 */
2921static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002922 struct nand_chip *chip,
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002923 int busw,
2924 int *maf_id, int *dev_id,
David Woodhouse5e81e882010-02-26 18:32:56 +00002925 struct nand_flash_dev *type)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002926{
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002927 int i, maf_idx;
Kevin Cernekee426c4572010-05-04 20:58:03 -07002928 u8 id_data[8];
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002929 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930
2931 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002932 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933
Karl Beldanef89a882008-09-15 14:37:29 +02002934 /*
2935 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002936 * after power-up.
Karl Beldanef89a882008-09-15 14:37:29 +02002937 */
2938 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
2939
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002941 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942
2943 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002944 *maf_id = chip->read_byte(mtd);
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002945 *dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946
Brian Norris8b6e50c2011-05-25 14:59:01 -07002947 /*
2948 * Try again to make sure, as some systems the bus-hold or other
Ben Dooksed8165c2008-04-14 14:58:58 +01002949 * interface concerns can cause random data which looks like a
2950 * possibly credible NAND flash to appear. If the two results do
2951 * not match, ignore the device completely.
2952 */
2953
2954 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2955
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002956 for (i = 0; i < 2; i++)
Kevin Cernekee426c4572010-05-04 20:58:03 -07002957 id_data[i] = chip->read_byte(mtd);
Ben Dooksed8165c2008-04-14 14:58:58 +01002958
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002959 if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07002960 pr_info("%s: second ID read did not match "
Brian Norrisd0370212011-07-19 10:06:08 -07002961 "%02x,%02x against %02x,%02x\n", __func__,
2962 *maf_id, *dev_id, id_data[0], id_data[1]);
Ben Dooksed8165c2008-04-14 14:58:58 +01002963 return ERR_PTR(-ENODEV);
2964 }
2965
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002966 if (!type)
David Woodhouse5e81e882010-02-26 18:32:56 +00002967 type = nand_flash_ids;
2968
2969 for (; type->name != NULL; type++)
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002970 if (*dev_id == type->id)
Florian Fainellif8ac0412010-09-07 13:23:43 +02002971 break;
David Woodhouse5e81e882010-02-26 18:32:56 +00002972
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002973 chip->onfi_version = 0;
2974 if (!type->name || !type->pagesize) {
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002975 /* Check is chip is ONFI compliant */
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002976 ret = nand_flash_detect_onfi(mtd, chip, &busw);
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002977 if (ret)
2978 goto ident_done;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002979 }
2980
2981 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2982
2983 /* Read entire ID string */
2984
2985 for (i = 0; i < 8; i++)
2986 id_data[i] = chip->read_byte(mtd);
2987
David Woodhouse5e81e882010-02-26 18:32:56 +00002988 if (!type->name)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002989 return ERR_PTR(-ENODEV);
2990
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02002991 if (!mtd->name)
2992 mtd->name = type->name;
2993
Adrian Hunter69423d92008-12-10 13:37:21 +00002994 chip->chipsize = (uint64_t)type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002995
Huang Shijie12a40a52010-09-27 10:43:53 +08002996 if (!type->pagesize && chip->init_size) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002997 /* Set the pagesize, oobsize, erasesize by the driver */
Huang Shijie12a40a52010-09-27 10:43:53 +08002998 busw = chip->init_size(mtd, chip, id_data);
2999 } else if (!type->pagesize) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003000 int extid;
Thomas Gleixner29072b92006-09-28 15:38:36 +02003001 /* The 3rd id byte holds MLC / multichip data */
Kevin Cernekee426c4572010-05-04 20:58:03 -07003002 chip->cellinfo = id_data[2];
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003003 /* The 4th id byte is the important one */
Kevin Cernekee426c4572010-05-04 20:58:03 -07003004 extid = id_data[3];
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003005
Kevin Cernekee426c4572010-05-04 20:58:03 -07003006 /*
3007 * Field definitions are in the following datasheets:
3008 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
Brian Norris34c5bf62010-08-20 10:50:43 -07003009 * New style (6 byte ID): Samsung K9GBG08U0M (p.40)
Kevin Cernekee426c4572010-05-04 20:58:03 -07003010 *
3011 * Check for wraparound + Samsung ID + nonzero 6th byte
3012 * to decide what to do.
3013 */
3014 if (id_data[0] == id_data[6] && id_data[1] == id_data[7] &&
3015 id_data[0] == NAND_MFR_SAMSUNG &&
Tilman Sauerbeckcfe3fda2010-08-20 14:01:47 -07003016 (chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
Kevin Cernekee426c4572010-05-04 20:58:03 -07003017 id_data[5] != 0x00) {
3018 /* Calc pagesize */
3019 mtd->writesize = 2048 << (extid & 0x03);
3020 extid >>= 2;
3021 /* Calc oobsize */
Brian Norris34c5bf62010-08-20 10:50:43 -07003022 switch (extid & 0x03) {
3023 case 1:
3024 mtd->oobsize = 128;
3025 break;
3026 case 2:
3027 mtd->oobsize = 218;
3028 break;
3029 case 3:
3030 mtd->oobsize = 400;
3031 break;
3032 default:
3033 mtd->oobsize = 436;
3034 break;
3035 }
Kevin Cernekee426c4572010-05-04 20:58:03 -07003036 extid >>= 2;
3037 /* Calc blocksize */
3038 mtd->erasesize = (128 * 1024) <<
3039 (((extid >> 1) & 0x04) | (extid & 0x03));
3040 busw = 0;
3041 } else {
3042 /* Calc pagesize */
3043 mtd->writesize = 1024 << (extid & 0x03);
3044 extid >>= 2;
3045 /* Calc oobsize */
3046 mtd->oobsize = (8 << (extid & 0x01)) *
3047 (mtd->writesize >> 9);
3048 extid >>= 2;
3049 /* Calc blocksize. Blocksize is multiples of 64KiB */
3050 mtd->erasesize = (64 * 1024) << (extid & 0x03);
3051 extid >>= 2;
3052 /* Get buswidth information */
3053 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
3054 }
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003055 } else {
3056 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003057 * Old devices have chip data hardcoded in the device id table.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003058 */
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02003059 mtd->erasesize = type->erasesize;
3060 mtd->writesize = type->pagesize;
Thomas Gleixner4cbb9b82006-05-23 12:37:31 +02003061 mtd->oobsize = mtd->writesize / 32;
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02003062 busw = type->options & NAND_BUSWIDTH_16;
Brian Norris2173bae2010-08-19 08:11:02 -07003063
3064 /*
3065 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
3066 * some Spansion chips have erasesize that conflicts with size
Brian Norris8b6e50c2011-05-25 14:59:01 -07003067 * listed in nand_ids table.
Brian Norris2173bae2010-08-19 08:11:02 -07003068 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
3069 */
3070 if (*maf_id == NAND_MFR_AMD && id_data[4] != 0x00 &&
3071 id_data[5] == 0x00 && id_data[6] == 0x00 &&
3072 id_data[7] == 0x00 && mtd->writesize == 512) {
3073 mtd->erasesize = 128 * 1024;
3074 mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
3075 }
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003076 }
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003077 /* Get chip options, preserve non chip based options */
3078 chip->options &= ~NAND_CHIPOPTIONS_MSK;
3079 chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
3080
Brian Norris8b6e50c2011-05-25 14:59:01 -07003081 /*
3082 * Check if chip is not a Samsung device. Do not clear the
3083 * options for chips which do not have an extended id.
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003084 */
3085 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
3086 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
3087ident_done:
3088
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003089 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01003090 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003091 if (nand_manuf_ids[maf_idx].id == *maf_id)
3092 break;
3093 }
3094
3095 /*
3096 * Check, if buswidth is correct. Hardware drivers should set
Brian Norris8b6e50c2011-05-25 14:59:01 -07003097 * chip correct!
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003098 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003099 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003100 pr_info("NAND device: Manufacturer ID:"
Brian Norrisd0370212011-07-19 10:06:08 -07003101 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
3102 *dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
Brian Norris9a4d4d62011-07-19 10:06:07 -07003103 pr_warn("NAND bus width %d instead %d bit\n",
Brian Norrisd0370212011-07-19 10:06:08 -07003104 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
3105 busw ? 16 : 8);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003106 return ERR_PTR(-EINVAL);
3107 }
3108
3109 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003110 chip->page_shift = ffs(mtd->writesize) - 1;
Brian Norris8b6e50c2011-05-25 14:59:01 -07003111 /* Convert chipsize to number of pages per chip -1 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003112 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003113
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003114 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003115 ffs(mtd->erasesize) - 1;
Adrian Hunter69423d92008-12-10 13:37:21 +00003116 if (chip->chipsize & 0xffffffff)
3117 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003118 else {
3119 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
3120 chip->chip_shift += 32 - 1;
3121 }
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003122
Artem Bityutskiy26d9be12011-04-28 20:26:59 +03003123 chip->badblockbits = 8;
3124
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003125 /* Set the bad block position */
Brian Norris065a1ed2010-08-18 11:25:04 -07003126 if (mtd->writesize > 512 || (busw & NAND_BUSWIDTH_16))
Brian Norrisc7b28e22010-07-13 15:13:00 -07003127 chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
Brian Norris065a1ed2010-08-18 11:25:04 -07003128 else
3129 chip->badblockpos = NAND_SMALL_BADBLOCK_POS;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003130
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -07003131 /*
3132 * Bad block marker is stored in the last page of each block
Brian Norrisc7b28e22010-07-13 15:13:00 -07003133 * on Samsung and Hynix MLC devices; stored in first two pages
3134 * of each block on Micron devices with 2KiB pages and on
Brian Norris8c342332011-11-02 13:34:44 -07003135 * SLC Samsung, Hynix, Toshiba, AMD/Spansion, and Macronix.
3136 * All others scan only the first page.
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -07003137 */
3138 if ((chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
3139 (*maf_id == NAND_MFR_SAMSUNG ||
3140 *maf_id == NAND_MFR_HYNIX))
Brian Norris5fb15492011-05-31 16:31:21 -07003141 chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
Brian Norrisc7b28e22010-07-13 15:13:00 -07003142 else if ((!(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
3143 (*maf_id == NAND_MFR_SAMSUNG ||
3144 *maf_id == NAND_MFR_HYNIX ||
Brian Norris13ed7ae2010-08-20 12:36:12 -07003145 *maf_id == NAND_MFR_TOSHIBA ||
Brian Norris8c342332011-11-02 13:34:44 -07003146 *maf_id == NAND_MFR_AMD ||
3147 *maf_id == NAND_MFR_MACRONIX)) ||
Brian Norrisc7b28e22010-07-13 15:13:00 -07003148 (mtd->writesize == 2048 &&
3149 *maf_id == NAND_MFR_MICRON))
Brian Norris5fb15492011-05-31 16:31:21 -07003150 chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
Brian Norrisc7b28e22010-07-13 15:13:00 -07003151
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003152 /* Check for AND chips with 4 page planes */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003153 if (chip->options & NAND_4PAGE_ARRAY)
3154 chip->erase_cmd = multi_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003155 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003156 chip->erase_cmd = single_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003157
Brian Norris8b6e50c2011-05-25 14:59:01 -07003158 /* Do not replace user supplied command function! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003159 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3160 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003161
Huang Shijie886bd332012-04-09 11:41:37 +08003162 pr_info("NAND device: Manufacturer ID: 0x%02x, Chip ID: 0x%02x (%s %s),"
3163 " page size: %d, OOB size: %d\n",
3164 *maf_id, *dev_id, nand_manuf_ids[maf_idx].name,
3165 chip->onfi_version ? chip->onfi_params.model : type->name,
3166 mtd->writesize, mtd->oobsize);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003167
3168 return type;
3169}
3170
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003171/**
David Woodhouse3b85c322006-09-25 17:06:53 +01003172 * nand_scan_ident - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003173 * @mtd: MTD device structure
3174 * @maxchips: number of chips to scan for
3175 * @table: alternative NAND ID table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003176 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003177 * This is the first phase of the normal nand_scan() function. It reads the
3178 * flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003179 *
David Woodhouse3b85c322006-09-25 17:06:53 +01003180 * The mtd->owner field must be set to the module of the caller.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003181 */
David Woodhouse5e81e882010-02-26 18:32:56 +00003182int nand_scan_ident(struct mtd_info *mtd, int maxchips,
3183 struct nand_flash_dev *table)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003184{
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003185 int i, busw, nand_maf_id, nand_dev_id;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003186 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003187 struct nand_flash_dev *type;
3188
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003189 /* Get buswidth to select the correct functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003190 busw = chip->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003191 /* Set the default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003192 nand_set_defaults(chip, busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003193
3194 /* Read the flash type */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003195 type = nand_get_flash_type(mtd, chip, busw,
3196 &nand_maf_id, &nand_dev_id, table);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003197
3198 if (IS_ERR(type)) {
Ben Dooksb1c6e6d2009-11-02 18:12:33 +00003199 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
Brian Norrisd0370212011-07-19 10:06:08 -07003200 pr_warn("No NAND device found\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003201 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003202 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003203 }
3204
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003205 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01003206 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003207 chip->select_chip(mtd, i);
Karl Beldanef89a882008-09-15 14:37:29 +02003208 /* See comment in nand_get_flash_type for reset */
3209 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003211 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003213 if (nand_maf_id != chip->read_byte(mtd) ||
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003214 nand_dev_id != chip->read_byte(mtd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 break;
3216 }
3217 if (i > 1)
Brian Norris9a4d4d62011-07-19 10:06:07 -07003218 pr_info("%d NAND chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003219
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003221 chip->numchips = i;
3222 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223
David Woodhouse3b85c322006-09-25 17:06:53 +01003224 return 0;
3225}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003226EXPORT_SYMBOL(nand_scan_ident);
David Woodhouse3b85c322006-09-25 17:06:53 +01003227
3228
3229/**
3230 * nand_scan_tail - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003231 * @mtd: MTD device structure
David Woodhouse3b85c322006-09-25 17:06:53 +01003232 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003233 * This is the second phase of the normal nand_scan() function. It fills out
3234 * all the uninitialized function pointers with the defaults and scans for a
3235 * bad block table if appropriate.
David Woodhouse3b85c322006-09-25 17:06:53 +01003236 */
3237int nand_scan_tail(struct mtd_info *mtd)
3238{
3239 int i;
3240 struct nand_chip *chip = mtd->priv;
3241
Brian Norrise2414f42012-02-06 13:44:00 -08003242 /* New bad blocks should be marked in OOB, flash-based BBT, or both */
3243 BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
3244 !(chip->bbt_options & NAND_BBT_USE_FLASH));
3245
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003246 if (!(chip->options & NAND_OWN_BUFFERS))
3247 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
3248 if (!chip->buffers)
3249 return -ENOMEM;
3250
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01003251 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01003252 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003253
3254 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003255 * If no default placement scheme is given, select an appropriate one.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003256 */
Ivan Djelic193bd402011-03-11 11:05:33 +01003257 if (!chip->ecc.layout && (chip->ecc.mode != NAND_ECC_SOFT_BCH)) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003258 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 case 8:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003260 chip->ecc.layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 break;
3262 case 16:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003263 chip->ecc.layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264 break;
3265 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003266 chip->ecc.layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267 break;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003268 case 128:
3269 chip->ecc.layout = &nand_oob_128;
3270 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 default:
Brian Norrisd0370212011-07-19 10:06:08 -07003272 pr_warn("No oob scheme defined for oobsize %d\n",
3273 mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274 BUG();
3275 }
3276 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003277
David Woodhouse956e9442006-09-25 17:12:39 +01003278 if (!chip->write_page)
3279 chip->write_page = nand_write_page;
3280
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003281 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003282 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003283 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01003284 */
David Woodhouse956e9442006-09-25 17:12:39 +01003285
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003286 switch (chip->ecc.mode) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003287 case NAND_ECC_HW_OOB_FIRST:
3288 /* Similar to NAND_ECC_HW, but a separate read_page handle */
3289 if (!chip->ecc.calculate || !chip->ecc.correct ||
3290 !chip->ecc.hwctl) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003291 pr_warn("No ECC functions supplied; "
Brian Norrisd0370212011-07-19 10:06:08 -07003292 "hardware ECC not possible\n");
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003293 BUG();
3294 }
3295 if (!chip->ecc.read_page)
3296 chip->ecc.read_page = nand_read_page_hwecc_oob_first;
3297
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003298 case NAND_ECC_HW:
Brian Norris8b6e50c2011-05-25 14:59:01 -07003299 /* Use standard hwecc read page function? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003300 if (!chip->ecc.read_page)
3301 chip->ecc.read_page = nand_read_page_hwecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003302 if (!chip->ecc.write_page)
3303 chip->ecc.write_page = nand_write_page_hwecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003304 if (!chip->ecc.read_page_raw)
3305 chip->ecc.read_page_raw = nand_read_page_raw;
3306 if (!chip->ecc.write_page_raw)
3307 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003308 if (!chip->ecc.read_oob)
3309 chip->ecc.read_oob = nand_read_oob_std;
3310 if (!chip->ecc.write_oob)
3311 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003312
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003313 case NAND_ECC_HW_SYNDROME:
Scott Wood78b65172007-12-13 11:15:28 -06003314 if ((!chip->ecc.calculate || !chip->ecc.correct ||
3315 !chip->ecc.hwctl) &&
3316 (!chip->ecc.read_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003317 chip->ecc.read_page == nand_read_page_hwecc ||
Scott Wood78b65172007-12-13 11:15:28 -06003318 !chip->ecc.write_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003319 chip->ecc.write_page == nand_write_page_hwecc)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003320 pr_warn("No ECC functions supplied; "
Brian Norrisd0370212011-07-19 10:06:08 -07003321 "hardware ECC not possible\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003322 BUG();
3323 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07003324 /* Use standard syndrome read/write page function? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003325 if (!chip->ecc.read_page)
3326 chip->ecc.read_page = nand_read_page_syndrome;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003327 if (!chip->ecc.write_page)
3328 chip->ecc.write_page = nand_write_page_syndrome;
David Brownell52ff49d2009-03-04 12:01:36 -08003329 if (!chip->ecc.read_page_raw)
3330 chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
3331 if (!chip->ecc.write_page_raw)
3332 chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003333 if (!chip->ecc.read_oob)
3334 chip->ecc.read_oob = nand_read_oob_syndrome;
3335 if (!chip->ecc.write_oob)
3336 chip->ecc.write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003337
Mike Dunne2788c92012-04-25 12:06:10 -07003338 if (mtd->writesize >= chip->ecc.size) {
3339 if (!chip->ecc.strength) {
3340 pr_warn("Driver must set ecc.strength when using hardware ECC\n");
3341 BUG();
3342 }
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003343 break;
Mike Dunne2788c92012-04-25 12:06:10 -07003344 }
Brian Norris9a4d4d62011-07-19 10:06:07 -07003345 pr_warn("%d byte HW ECC not possible on "
Brian Norrisd0370212011-07-19 10:06:08 -07003346 "%d byte page size, fallback to SW ECC\n",
3347 chip->ecc.size, mtd->writesize);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003348 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003350 case NAND_ECC_SOFT:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003351 chip->ecc.calculate = nand_calculate_ecc;
3352 chip->ecc.correct = nand_correct_data;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003353 chip->ecc.read_page = nand_read_page_swecc;
Alexey Korolev3d459552008-05-15 17:23:18 +01003354 chip->ecc.read_subpage = nand_read_subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003355 chip->ecc.write_page = nand_write_page_swecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003356 chip->ecc.read_page_raw = nand_read_page_raw;
3357 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003358 chip->ecc.read_oob = nand_read_oob_std;
3359 chip->ecc.write_oob = nand_write_oob_std;
Singh, Vimal9a732902008-12-12 00:10:57 +00003360 if (!chip->ecc.size)
3361 chip->ecc.size = 256;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003362 chip->ecc.bytes = 3;
Mike Dunn6a918ba2012-03-11 14:21:11 -07003363 chip->ecc.strength = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003364 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003365
Ivan Djelic193bd402011-03-11 11:05:33 +01003366 case NAND_ECC_SOFT_BCH:
3367 if (!mtd_nand_has_bch()) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003368 pr_warn("CONFIG_MTD_ECC_BCH not enabled\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01003369 BUG();
3370 }
3371 chip->ecc.calculate = nand_bch_calculate_ecc;
3372 chip->ecc.correct = nand_bch_correct_data;
3373 chip->ecc.read_page = nand_read_page_swecc;
3374 chip->ecc.read_subpage = nand_read_subpage;
3375 chip->ecc.write_page = nand_write_page_swecc;
3376 chip->ecc.read_page_raw = nand_read_page_raw;
3377 chip->ecc.write_page_raw = nand_write_page_raw;
3378 chip->ecc.read_oob = nand_read_oob_std;
3379 chip->ecc.write_oob = nand_write_oob_std;
3380 /*
3381 * Board driver should supply ecc.size and ecc.bytes values to
3382 * select how many bits are correctable; see nand_bch_init()
Brian Norris8b6e50c2011-05-25 14:59:01 -07003383 * for details. Otherwise, default to 4 bits for large page
3384 * devices.
Ivan Djelic193bd402011-03-11 11:05:33 +01003385 */
3386 if (!chip->ecc.size && (mtd->oobsize >= 64)) {
3387 chip->ecc.size = 512;
3388 chip->ecc.bytes = 7;
3389 }
3390 chip->ecc.priv = nand_bch_init(mtd,
3391 chip->ecc.size,
3392 chip->ecc.bytes,
3393 &chip->ecc.layout);
3394 if (!chip->ecc.priv) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003395 pr_warn("BCH ECC initialization failed!\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01003396 BUG();
3397 }
Mike Dunn6a918ba2012-03-11 14:21:11 -07003398 chip->ecc.strength =
Mike Dunne2788c92012-04-25 12:06:10 -07003399 chip->ecc.bytes * 8 / fls(8 * chip->ecc.size);
Ivan Djelic193bd402011-03-11 11:05:33 +01003400 break;
3401
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003402 case NAND_ECC_NONE:
Brian Norris9a4d4d62011-07-19 10:06:07 -07003403 pr_warn("NAND_ECC_NONE selected by board driver. "
Brian Norrisd0370212011-07-19 10:06:08 -07003404 "This is not recommended!\n");
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02003405 chip->ecc.read_page = nand_read_page_raw;
3406 chip->ecc.write_page = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003407 chip->ecc.read_oob = nand_read_oob_std;
David Brownell52ff49d2009-03-04 12:01:36 -08003408 chip->ecc.read_page_raw = nand_read_page_raw;
3409 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003410 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003411 chip->ecc.size = mtd->writesize;
3412 chip->ecc.bytes = 0;
Mike Dunn6a918ba2012-03-11 14:21:11 -07003413 chip->ecc.strength = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414 break;
David Woodhouse956e9442006-09-25 17:12:39 +01003415
Linus Torvalds1da177e2005-04-16 15:20:36 -07003416 default:
Brian Norrisd0370212011-07-19 10:06:08 -07003417 pr_warn("Invalid NAND_ECC_MODE %d\n", chip->ecc.mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003418 BUG();
3419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420
Brian Norris9ce244b2011-08-30 18:45:37 -07003421 /* For many systems, the standard OOB write also works for raw */
Brian Norrisc46f6482011-08-30 18:45:38 -07003422 if (!chip->ecc.read_oob_raw)
3423 chip->ecc.read_oob_raw = chip->ecc.read_oob;
Brian Norris9ce244b2011-08-30 18:45:37 -07003424 if (!chip->ecc.write_oob_raw)
3425 chip->ecc.write_oob_raw = chip->ecc.write_oob;
3426
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003427 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003428 * The number of bytes available for a client to place data into
Brian Norris8b6e50c2011-05-25 14:59:01 -07003429 * the out of band area.
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003430 */
3431 chip->ecc.layout->oobavail = 0;
David Brownell81d19b02009-04-21 19:51:20 -07003432 for (i = 0; chip->ecc.layout->oobfree[i].length
3433 && i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003434 chip->ecc.layout->oobavail +=
3435 chip->ecc.layout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03003436 mtd->oobavail = chip->ecc.layout->oobavail;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003437
3438 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003439 * Set the number of read / write steps for one page depending on ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07003440 * mode.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003441 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003442 chip->ecc.steps = mtd->writesize / chip->ecc.size;
Florian Fainellif8ac0412010-09-07 13:23:43 +02003443 if (chip->ecc.steps * chip->ecc.size != mtd->writesize) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003444 pr_warn("Invalid ECC parameters\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003445 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003446 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003447 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003448
Brian Norris8b6e50c2011-05-25 14:59:01 -07003449 /* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
Thomas Gleixner29072b92006-09-28 15:38:36 +02003450 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
3451 !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
Florian Fainellif8ac0412010-09-07 13:23:43 +02003452 switch (chip->ecc.steps) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02003453 case 2:
3454 mtd->subpage_sft = 1;
3455 break;
3456 case 4:
3457 case 8:
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003458 case 16:
Thomas Gleixner29072b92006-09-28 15:38:36 +02003459 mtd->subpage_sft = 2;
3460 break;
3461 }
3462 }
3463 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
3464
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02003465 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003466 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467
3468 /* De-select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003469 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470
3471 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003472 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003473
3474 /* Fill in remaining MTD driver data */
3475 mtd->type = MTD_NANDFLASH;
Maxim Levitsky93edbad2010-02-22 20:39:40 +02003476 mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
3477 MTD_CAP_NANDFLASH;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02003478 mtd->_erase = nand_erase;
3479 mtd->_point = NULL;
3480 mtd->_unpoint = NULL;
3481 mtd->_read = nand_read;
3482 mtd->_write = nand_write;
3483 mtd->_panic_write = panic_nand_write;
3484 mtd->_read_oob = nand_read_oob;
3485 mtd->_write_oob = nand_write_oob;
3486 mtd->_sync = nand_sync;
3487 mtd->_lock = NULL;
3488 mtd->_unlock = NULL;
3489 mtd->_suspend = nand_suspend;
3490 mtd->_resume = nand_resume;
3491 mtd->_block_isbad = nand_block_isbad;
3492 mtd->_block_markbad = nand_block_markbad;
Anatolij Gustschincbcab652010-12-16 23:42:16 +01003493 mtd->writebufsize = mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494
Mike Dunn6a918ba2012-03-11 14:21:11 -07003495 /* propagate ecc info to mtd_info */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003496 mtd->ecclayout = chip->ecc.layout;
Mike Dunn86c20722012-04-25 12:06:05 -07003497 mtd->ecc_strength = chip->ecc.strength;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003499 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003500 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003501 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502
3503 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003504 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003506EXPORT_SYMBOL(nand_scan_tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507
Brian Norris8b6e50c2011-05-25 14:59:01 -07003508/*
3509 * is_module_text_address() isn't exported, and it's mostly a pointless
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003510 * test if this is a module _anyway_ -- they'd have to try _really_ hard
Brian Norris8b6e50c2011-05-25 14:59:01 -07003511 * to call us from in-kernel code if the core NAND support is modular.
3512 */
David Woodhouse3b85c322006-09-25 17:06:53 +01003513#ifdef MODULE
3514#define caller_is_module() (1)
3515#else
3516#define caller_is_module() \
Rusty Russella6e6abd2009-03-31 13:05:31 -06003517 is_module_text_address((unsigned long)__builtin_return_address(0))
David Woodhouse3b85c322006-09-25 17:06:53 +01003518#endif
3519
3520/**
3521 * nand_scan - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003522 * @mtd: MTD device structure
3523 * @maxchips: number of chips to scan for
David Woodhouse3b85c322006-09-25 17:06:53 +01003524 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003525 * This fills out all the uninitialized function pointers with the defaults.
3526 * The flash ID is read and the mtd/chip structures are filled with the
3527 * appropriate values. The mtd->owner field must be set to the module of the
3528 * caller.
David Woodhouse3b85c322006-09-25 17:06:53 +01003529 */
3530int nand_scan(struct mtd_info *mtd, int maxchips)
3531{
3532 int ret;
3533
3534 /* Many callers got this wrong, so check for it for a while... */
3535 if (!mtd->owner && caller_is_module()) {
Brian Norrisd0370212011-07-19 10:06:08 -07003536 pr_crit("%s called with NULL mtd->owner!\n", __func__);
David Woodhouse3b85c322006-09-25 17:06:53 +01003537 BUG();
3538 }
3539
David Woodhouse5e81e882010-02-26 18:32:56 +00003540 ret = nand_scan_ident(mtd, maxchips, NULL);
David Woodhouse3b85c322006-09-25 17:06:53 +01003541 if (!ret)
3542 ret = nand_scan_tail(mtd);
3543 return ret;
3544}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003545EXPORT_SYMBOL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01003546
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003548 * nand_release - [NAND Interface] Free resources held by the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003549 * @mtd: MTD device structure
3550 */
David Woodhousee0c7d762006-05-13 18:07:53 +01003551void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003553 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554
Ivan Djelic193bd402011-03-11 11:05:33 +01003555 if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
3556 nand_bch_free((struct nand_bch_control *)chip->ecc.priv);
3557
Jamie Iles5ffcaf32011-05-23 10:22:46 +01003558 mtd_device_unregister(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003559
Jesper Juhlfa671642005-11-07 01:01:27 -08003560 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003561 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003562 if (!(chip->options & NAND_OWN_BUFFERS))
3563 kfree(chip->buffers);
Brian Norris58373ff2010-07-15 12:15:44 -07003564
3565 /* Free bad block descriptor memory */
3566 if (chip->badblock_pattern && chip->badblock_pattern->options
3567 & NAND_BBT_DYNAMICSTRUCT)
3568 kfree(chip->badblock_pattern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003569}
David Woodhousee0c7d762006-05-13 18:07:53 +01003570EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08003571
3572static int __init nand_base_init(void)
3573{
3574 led_trigger_register_simple("nand-disk", &nand_led_trigger);
3575 return 0;
3576}
3577
3578static void __exit nand_base_exit(void)
3579{
3580 led_trigger_unregister_simple(nand_led_trigger);
3581}
3582
3583module_init(nand_base_init);
3584module_exit(nand_base_exit);
3585
David Woodhousee0c7d762006-05-13 18:07:53 +01003586MODULE_LICENSE("GPL");
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003587MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
3588MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
David Woodhousee0c7d762006-05-13 18:07:53 +01003589MODULE_DESCRIPTION("Generic NAND flash driver code");