blob: 6eef7fbe8fdb61db44ae4bcd20b12b88f81d3477 [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/**
Masanari Iida064a7692012-11-09 23:20:58 +0900163 * nand_read_byte16 - [DEFAULT] read one byte endianness 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/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 * nand_write_buf16 - [DEFAULT] write buffer to chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700247 * @mtd: MTD device structure
248 * @buf: data buffer
249 * @len: number of bytes to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700251 * Default write function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200253static void nand_write_buf16(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 u16 *p = (u16 *) buf;
258 len >>= 1;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000259
David Woodhousee0c7d762006-05-13 18:07:53 +0100260 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200261 writew(p[i], chip->IO_ADDR_W);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
265/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000266 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700267 * @mtd: MTD device structure
268 * @buf: buffer to store date
269 * @len: number of bytes to read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700271 * Default read function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200273static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
275 int i;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200276 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 u16 *p = (u16 *) buf;
278 len >>= 1;
279
David Woodhousee0c7d762006-05-13 18:07:53 +0100280 for (i = 0; i < len; i++)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200281 p[i] = readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
284/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700286 * @mtd: MTD device structure
287 * @ofs: offset from device start
288 * @getchip: 0, if the chip is already selected
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000290 * Check, if the block is bad.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 */
292static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
293{
Brian Norriscdbec052012-01-13 18:11:48 -0800294 int page, chipnr, res = 0, i = 0;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200295 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 u16 bad;
297
Brian Norris5fb15492011-05-31 16:31:21 -0700298 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -0700299 ofs += mtd->erasesize - mtd->writesize;
300
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100301 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 if (getchip) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200304 chipnr = (int)(ofs >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200306 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
308 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200309 chip->select_chip(mtd, chipnr);
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100310 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Brian Norriscdbec052012-01-13 18:11:48 -0800312 do {
313 if (chip->options & NAND_BUSWIDTH_16) {
314 chip->cmdfunc(mtd, NAND_CMD_READOOB,
315 chip->badblockpos & 0xFE, page);
316 bad = cpu_to_le16(chip->read_word(mtd));
317 if (chip->badblockpos & 0x1)
318 bad >>= 8;
319 else
320 bad &= 0xFF;
321 } else {
322 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
323 page);
324 bad = chip->read_byte(mtd);
325 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000326
Brian Norriscdbec052012-01-13 18:11:48 -0800327 if (likely(chip->badblockbits == 8))
328 res = bad != 0xFF;
329 else
330 res = hweight8(bad) < chip->badblockbits;
331 ofs += mtd->writesize;
332 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
333 i++;
334 } while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
Maxim Levitskye0b58d02010-02-22 20:39:38 +0200335
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200336 if (getchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 nand_release_device(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 return res;
340}
341
342/**
343 * nand_default_block_markbad - [DEFAULT] mark a block bad
Brian Norris8b6e50c2011-05-25 14:59:01 -0700344 * @mtd: MTD device structure
345 * @ofs: offset from device start
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700347 * This is the default implementation, which can be overridden by a hardware
Brian Norrise2414f42012-02-06 13:44:00 -0800348 * specific driver. We try operations in the following order, according to our
349 * bbt_options (NAND_BBT_NO_OOB_BBM and NAND_BBT_USE_FLASH):
350 * (1) erase the affected block, to allow OOB marker to be written cleanly
351 * (2) update in-memory BBT
352 * (3) write bad block marker to OOB area of affected block
353 * (4) update flash-based BBT
354 * Note that we retain the first error encountered in (3) or (4), finish the
355 * procedures, and dump the error in the end.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356*/
357static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
358{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200359 struct nand_chip *chip = mtd->priv;
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200360 uint8_t buf[2] = { 0, 0 };
Brian Norrise2414f42012-02-06 13:44:00 -0800361 int block, res, ret = 0, i = 0;
362 int write_oob = !(chip->bbt_options & NAND_BBT_NO_OOB_BBM);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000363
Brian Norrise2414f42012-02-06 13:44:00 -0800364 if (write_oob) {
Brian Norris00918422012-01-13 18:11:47 -0800365 struct erase_info einfo;
366
367 /* Attempt erase before marking OOB */
368 memset(&einfo, 0, sizeof(einfo));
369 einfo.mtd = mtd;
370 einfo.addr = ofs;
371 einfo.len = 1 << chip->phys_erase_shift;
372 nand_erase_nand(mtd, &einfo, 0);
373 }
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 /* Get block number */
Andre Renaud4226b512007-04-17 13:50:59 -0400376 block = (int)(ofs >> chip->bbt_erase_shift);
Brian Norrise2414f42012-02-06 13:44:00 -0800377 /* Mark block bad in memory-based BBT */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200378 if (chip->bbt)
379 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Brian Norrise2414f42012-02-06 13:44:00 -0800381 /* Write bad block marker to OOB */
382 if (write_oob) {
Brian Norris4a89ff82011-08-30 18:45:45 -0700383 struct mtd_oob_ops ops;
Brian Norrisdf698622012-01-20 20:38:03 -0800384 loff_t wr_ofs = ofs;
Brian Norris4a89ff82011-08-30 18:45:45 -0700385
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300386 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000387
Brian Norris4a89ff82011-08-30 18:45:45 -0700388 ops.datbuf = NULL;
389 ops.oobbuf = buf;
Brian Norris85443312012-01-13 18:11:49 -0800390 ops.ooboffs = chip->badblockpos;
391 if (chip->options & NAND_BUSWIDTH_16) {
392 ops.ooboffs &= ~0x01;
393 ops.len = ops.ooblen = 2;
394 } else {
395 ops.len = ops.ooblen = 1;
396 }
Brian Norris23b1a992011-10-14 20:09:33 -0700397 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norrisdf698622012-01-20 20:38:03 -0800398
Brian Norrise2414f42012-02-06 13:44:00 -0800399 /* Write to first/last page(s) if necessary */
Brian Norrisdf698622012-01-20 20:38:03 -0800400 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
401 wr_ofs += mtd->erasesize - mtd->writesize;
Brian Norris02ed70b2010-07-21 16:53:47 -0700402 do {
Brian Norrise2414f42012-02-06 13:44:00 -0800403 res = nand_do_write_oob(mtd, wr_ofs, &ops);
404 if (!ret)
405 ret = res;
Brian Norris02ed70b2010-07-21 16:53:47 -0700406
Brian Norris02ed70b2010-07-21 16:53:47 -0700407 i++;
Brian Norrisdf698622012-01-20 20:38:03 -0800408 wr_ofs += mtd->writesize;
Brian Norrise2414f42012-02-06 13:44:00 -0800409 } while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
Brian Norris02ed70b2010-07-21 16:53:47 -0700410
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300411 nand_release_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200412 }
Brian Norrise2414f42012-02-06 13:44:00 -0800413
414 /* Update flash-based bad block table */
415 if (chip->bbt_options & NAND_BBT_USE_FLASH) {
416 res = nand_update_bbt(mtd, ofs);
417 if (!ret)
418 ret = res;
419 }
420
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200421 if (!ret)
422 mtd->ecc_stats.badblocks++;
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300423
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200424 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425}
426
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000427/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 * nand_check_wp - [GENERIC] check if the chip is write protected
Brian Norris8b6e50c2011-05-25 14:59:01 -0700429 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700431 * Check, if the device is write protected. The function expects, that the
432 * device is already selected.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100434static int nand_check_wp(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200436 struct nand_chip *chip = mtd->priv;
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200437
Brian Norris8b6e50c2011-05-25 14:59:01 -0700438 /* Broken xD cards report WP despite being writable */
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200439 if (chip->options & NAND_BROKEN_XD)
440 return 0;
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 /* Check the WP bit */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200443 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
444 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445}
446
447/**
448 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
Brian Norris8b6e50c2011-05-25 14:59:01 -0700449 * @mtd: MTD device structure
450 * @ofs: offset from device start
451 * @getchip: 0, if the chip is already selected
452 * @allowbbt: 1, if its allowed to access the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 *
454 * Check, if the block is bad. Either by reading the bad block table or
455 * calling of the scan function.
456 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200457static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
458 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200460 struct nand_chip *chip = mtd->priv;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000461
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200462 if (!chip->bbt)
463 return chip->block_bad(mtd, ofs, getchip);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 /* Return info from the table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100466 return nand_isbad_bbt(mtd, ofs, allowbbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467}
468
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200469/**
470 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700471 * @mtd: MTD device structure
472 * @timeo: Timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200473 *
474 * Helper function for nand_wait_ready used when needing to wait in interrupt
475 * context.
476 */
477static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
478{
479 struct nand_chip *chip = mtd->priv;
480 int i;
481
482 /* Wait for the device to get ready */
483 for (i = 0; i < timeo; i++) {
484 if (chip->dev_ready(mtd))
485 break;
486 touch_softlockup_watchdog();
487 mdelay(1);
488 }
489}
490
Brian Norris7854d3f2011-06-23 14:12:08 -0700491/* Wait for the ready pin, after a command. The timeout is caught later. */
David Woodhouse4b648b02006-09-25 17:05:24 +0100492void nand_wait_ready(struct mtd_info *mtd)
Thomas Gleixner3b887752005-02-22 21:56:49 +0000493{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200494 struct nand_chip *chip = mtd->priv;
David Woodhousee0c7d762006-05-13 18:07:53 +0100495 unsigned long timeo = jiffies + 2;
Thomas Gleixner3b887752005-02-22 21:56:49 +0000496
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200497 /* 400ms timeout */
498 if (in_interrupt() || oops_in_progress)
499 return panic_nand_wait_ready(mtd, 400);
500
Richard Purdie8fe833c2006-03-31 02:31:14 -0800501 led_trigger_event(nand_led_trigger, LED_FULL);
Brian Norris7854d3f2011-06-23 14:12:08 -0700502 /* Wait until command is processed or timeout occurs */
Thomas Gleixner3b887752005-02-22 21:56:49 +0000503 do {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200504 if (chip->dev_ready(mtd))
Richard Purdie8fe833c2006-03-31 02:31:14 -0800505 break;
Ingo Molnar8446f1d2005-09-06 15:16:27 -0700506 touch_softlockup_watchdog();
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000507 } while (time_before(jiffies, timeo));
Richard Purdie8fe833c2006-03-31 02:31:14 -0800508 led_trigger_event(nand_led_trigger, LED_OFF);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000509}
David Woodhouse4b648b02006-09-25 17:05:24 +0100510EXPORT_SYMBOL_GPL(nand_wait_ready);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512/**
513 * nand_command - [DEFAULT] Send command to NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700514 * @mtd: MTD device structure
515 * @command: the command to be sent
516 * @column: the column address for this command, -1 if none
517 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700519 * Send command to NAND device. This function is used for small page devices
520 * (256/512 Bytes per page).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200522static void nand_command(struct mtd_info *mtd, unsigned int command,
523 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200525 register struct nand_chip *chip = mtd->priv;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200526 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Brian Norris8b6e50c2011-05-25 14:59:01 -0700528 /* Write out the command to the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 if (command == NAND_CMD_SEQIN) {
530 int readcmd;
531
Joern Engel28318772006-05-22 23:18:05 +0200532 if (column >= mtd->writesize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 /* OOB area */
Joern Engel28318772006-05-22 23:18:05 +0200534 column -= mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 readcmd = NAND_CMD_READOOB;
536 } else if (column < 256) {
537 /* First 256 bytes --> READ0 */
538 readcmd = NAND_CMD_READ0;
539 } else {
540 column -= 256;
541 readcmd = NAND_CMD_READ1;
542 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200543 chip->cmd_ctrl(mtd, readcmd, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200544 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200546 chip->cmd_ctrl(mtd, command, ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Brian Norris8b6e50c2011-05-25 14:59:01 -0700548 /* Address cycle, when necessary */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200549 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
550 /* Serially input address */
551 if (column != -1) {
552 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200553 if (chip->options & NAND_BUSWIDTH_16)
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200554 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200555 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200556 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 }
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200558 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200559 chip->cmd_ctrl(mtd, page_addr, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200560 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200561 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200562 /* One more address cycle for devices > 32MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200563 if (chip->chipsize > (32 << 20))
564 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200565 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200566 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000567
568 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700569 * Program and erase have their own busy handlers status and sequential
570 * in needs no delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100571 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 case NAND_CMD_PAGEPROG:
575 case NAND_CMD_ERASE1:
576 case NAND_CMD_ERASE2:
577 case NAND_CMD_SEQIN:
578 case NAND_CMD_STATUS:
579 return;
580
581 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200582 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200584 udelay(chip->chip_delay);
585 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200586 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200587 chip->cmd_ctrl(mtd,
588 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200589 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
590 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 return;
592
David Woodhousee0c7d762006-05-13 18:07:53 +0100593 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000595 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 * If we don't have access to the busy pin, we apply the given
597 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100598 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200599 if (!chip->dev_ready) {
600 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000602 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700604 /*
605 * Apply this short delay always to ensure that we do wait tWB in
606 * any case on any machine.
607 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100608 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000609
610 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
612
613/**
614 * nand_command_lp - [DEFAULT] Send command to NAND large page device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700615 * @mtd: MTD device structure
616 * @command: the command to be sent
617 * @column: the column address for this command, -1 if none
618 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 *
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200620 * Send command to NAND device. This is the version for the new large page
Brian Norris7854d3f2011-06-23 14:12:08 -0700621 * devices. We don't have the separate regions as we have in the small page
622 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200624static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
625 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200627 register struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
629 /* Emulate NAND_CMD_READOOB */
630 if (command == NAND_CMD_READOOB) {
Joern Engel28318772006-05-22 23:18:05 +0200631 column += mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 command = NAND_CMD_READ0;
633 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000634
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200635 /* Command latch cycle */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200636 chip->cmd_ctrl(mtd, command & 0xff,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200637 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 if (column != -1 || page_addr != -1) {
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200640 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642 /* Serially input address */
643 if (column != -1) {
644 /* Adjust columns for 16 bit buswidth */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200645 if (chip->options & NAND_BUSWIDTH_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200647 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200648 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200649 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000650 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200652 chip->cmd_ctrl(mtd, page_addr, ctrl);
653 chip->cmd_ctrl(mtd, page_addr >> 8,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200654 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 /* One more address cycle for devices > 128MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200656 if (chip->chipsize > (128 << 20))
657 chip->cmd_ctrl(mtd, page_addr >> 16,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200658 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200661 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000662
663 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700664 * Program and erase have their own busy handlers status, sequential
665 * in, and deplete1 need no delay.
David A. Marlin30f464b2005-01-17 18:35:25 +0000666 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 case NAND_CMD_CACHEDPROG:
670 case NAND_CMD_PAGEPROG:
671 case NAND_CMD_ERASE1:
672 case NAND_CMD_ERASE2:
673 case NAND_CMD_SEQIN:
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200674 case NAND_CMD_RNDIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 case NAND_CMD_STATUS:
David A. Marlin30f464b2005-01-17 18:35:25 +0000676 case NAND_CMD_DEPLETE1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 return;
678
David A. Marlin30f464b2005-01-17 18:35:25 +0000679 case NAND_CMD_STATUS_ERROR:
680 case NAND_CMD_STATUS_ERROR0:
681 case NAND_CMD_STATUS_ERROR1:
682 case NAND_CMD_STATUS_ERROR2:
683 case NAND_CMD_STATUS_ERROR3:
Brian Norris8b6e50c2011-05-25 14:59:01 -0700684 /* Read error status commands require only a short delay */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200685 udelay(chip->chip_delay);
David A. Marlin30f464b2005-01-17 18:35:25 +0000686 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200689 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200691 udelay(chip->chip_delay);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200692 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
693 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
694 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
695 NAND_NCE | NAND_CTRL_CHANGE);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200696 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
697 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 return;
699
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200700 case NAND_CMD_RNDOUT:
701 /* No ready / busy check necessary */
702 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
703 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
704 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
705 NAND_NCE | NAND_CTRL_CHANGE);
706 return;
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 case NAND_CMD_READ0:
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200709 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
710 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
711 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
712 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000713
David Woodhousee0c7d762006-05-13 18:07:53 +0100714 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000716 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 * If we don't have access to the busy pin, we apply the given
Brian Norris8b6e50c2011-05-25 14:59:01 -0700718 * command delay.
David Woodhousee0c7d762006-05-13 18:07:53 +0100719 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200720 if (!chip->dev_ready) {
721 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 }
Thomas Gleixner3b887752005-02-22 21:56:49 +0000725
Brian Norris8b6e50c2011-05-25 14:59:01 -0700726 /*
727 * Apply this short delay always to ensure that we do wait tWB in
728 * any case on any machine.
729 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100730 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000731
732 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733}
734
735/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200736 * panic_nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700737 * @chip: the nand chip descriptor
738 * @mtd: MTD device structure
739 * @new_state: the state which is requested
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200740 *
741 * Used when in panic, no locks are taken.
742 */
743static void panic_nand_get_device(struct nand_chip *chip,
744 struct mtd_info *mtd, int new_state)
745{
Brian Norris7854d3f2011-06-23 14:12:08 -0700746 /* Hardware controller shared among independent devices */
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200747 chip->controller->active = chip;
748 chip->state = new_state;
749}
750
751/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 * nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700753 * @chip: the nand chip descriptor
754 * @mtd: MTD device structure
755 * @new_state: the state which is requested
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 *
757 * Get the device and lock it for exclusive access
758 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200759static int
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200760nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200762 spinlock_t *lock = &chip->controller->lock;
763 wait_queue_head_t *wq = &chip->controller->wq;
David Woodhousee0c7d762006-05-13 18:07:53 +0100764 DECLARE_WAITQUEUE(wait, current);
Florian Fainelli7351d3a2010-09-07 13:23:45 +0200765retry:
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100766 spin_lock(lock);
767
vimal singhb8b3ee92009-07-09 20:41:22 +0530768 /* Hardware controller shared among independent devices */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200769 if (!chip->controller->active)
770 chip->controller->active = chip;
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200771
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200772 if (chip->controller->active == chip && chip->state == FL_READY) {
773 chip->state = new_state;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100774 spin_unlock(lock);
Vitaly Wool962034f2005-09-15 14:58:53 +0100775 return 0;
776 }
777 if (new_state == FL_PM_SUSPENDED) {
Li Yang6b0d9a82009-11-17 14:45:49 -0800778 if (chip->controller->active->state == FL_PM_SUSPENDED) {
779 chip->state = FL_PM_SUSPENDED;
780 spin_unlock(lock);
781 return 0;
Li Yang6b0d9a82009-11-17 14:45:49 -0800782 }
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100783 }
784 set_current_state(TASK_UNINTERRUPTIBLE);
785 add_wait_queue(wq, &wait);
786 spin_unlock(lock);
787 schedule();
788 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 goto retry;
790}
791
792/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700793 * panic_nand_wait - [GENERIC] wait until the command is done
794 * @mtd: MTD device structure
795 * @chip: NAND chip structure
796 * @timeo: timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200797 *
798 * Wait for command done. This is a helper function for nand_wait used when
799 * we are in interrupt context. May happen when in panic and trying to write
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400800 * an oops through mtdoops.
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200801 */
802static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
803 unsigned long timeo)
804{
805 int i;
806 for (i = 0; i < timeo; i++) {
807 if (chip->dev_ready) {
808 if (chip->dev_ready(mtd))
809 break;
810 } else {
811 if (chip->read_byte(mtd) & NAND_STATUS_READY)
812 break;
813 }
814 mdelay(1);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200815 }
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200816}
817
818/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700819 * nand_wait - [DEFAULT] wait until the command is done
820 * @mtd: MTD device structure
821 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700823 * Wait for command done. This applies to erase and program only. Erase can
824 * take up to 400ms and program up to 20ms according to general NAND and
825 * SmartMedia specs.
Randy Dunlap844d3b42006-06-28 21:48:27 -0700826 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200827static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
829
David Woodhousee0c7d762006-05-13 18:07:53 +0100830 unsigned long timeo = jiffies;
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200831 int status, state = chip->state;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 if (state == FL_ERASING)
David Woodhousee0c7d762006-05-13 18:07:53 +0100834 timeo += (HZ * 400) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 else
David Woodhousee0c7d762006-05-13 18:07:53 +0100836 timeo += (HZ * 20) / 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Richard Purdie8fe833c2006-03-31 02:31:14 -0800838 led_trigger_event(nand_led_trigger, LED_FULL);
839
Brian Norris8b6e50c2011-05-25 14:59:01 -0700840 /*
841 * Apply this short delay always to ensure that we do wait tWB in any
842 * case on any machine.
843 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100844 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200846 if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
847 chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000848 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200849 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200851 if (in_interrupt() || oops_in_progress)
852 panic_nand_wait(mtd, chip, timeo);
853 else {
854 while (time_before(jiffies, timeo)) {
855 if (chip->dev_ready) {
856 if (chip->dev_ready(mtd))
857 break;
858 } else {
859 if (chip->read_byte(mtd) & NAND_STATUS_READY)
860 break;
861 }
862 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800865 led_trigger_event(nand_led_trigger, LED_OFF);
866
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200867 status = (int)chip->read_byte(mtd);
Matthieu CASTETf251b8d2012-11-05 15:00:44 +0100868 /* This can happen if in case of timeout or buggy dev_ready */
869 WARN_ON(!(status & NAND_STATUS_READY));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 return status;
871}
872
873/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700874 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700875 * @mtd: mtd info
876 * @ofs: offset to start unlock from
877 * @len: length to unlock
Brian Norris8b6e50c2011-05-25 14:59:01 -0700878 * @invert: when = 0, unlock the range of blocks within the lower and
879 * upper boundary address
880 * when = 1, unlock the range of blocks outside the boundaries
881 * of the lower and upper boundary address
Vimal Singh7d70f332010-02-08 15:50:49 +0530882 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700883 * Returs unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530884 */
885static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
886 uint64_t len, int invert)
887{
888 int ret = 0;
889 int status, page;
890 struct nand_chip *chip = mtd->priv;
891
892 /* Submit address of first page to unlock */
893 page = ofs >> chip->page_shift;
894 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
895
896 /* Submit address of last page to unlock */
897 page = (ofs + len) >> chip->page_shift;
898 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
899 (page | invert) & chip->pagemask);
900
901 /* Call wait ready function */
902 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +0530903 /* See if device thinks it succeeded */
Huang Shijie74830962012-10-14 23:47:24 -0400904 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -0700905 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530906 __func__, status);
907 ret = -EIO;
908 }
909
910 return ret;
911}
912
913/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700914 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700915 * @mtd: mtd info
916 * @ofs: offset to start unlock from
917 * @len: length to unlock
Vimal Singh7d70f332010-02-08 15:50:49 +0530918 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700919 * Returns unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530920 */
921int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
922{
923 int ret = 0;
924 int chipnr;
925 struct nand_chip *chip = mtd->priv;
926
Brian Norris289c0522011-07-19 10:06:09 -0700927 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530928 __func__, (unsigned long long)ofs, len);
929
930 if (check_offs_len(mtd, ofs, len))
931 ret = -EINVAL;
932
933 /* Align to last block address if size addresses end of the device */
934 if (ofs + len == mtd->size)
935 len -= mtd->erasesize;
936
937 nand_get_device(chip, mtd, FL_UNLOCKING);
938
939 /* Shift to get chip number */
940 chipnr = ofs >> chip->chip_shift;
941
942 chip->select_chip(mtd, chipnr);
943
944 /* Check, if it is write protected */
945 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -0700946 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530947 __func__);
948 ret = -EIO;
949 goto out;
950 }
951
952 ret = __nand_unlock(mtd, ofs, len, 0);
953
954out:
Vimal Singh7d70f332010-02-08 15:50:49 +0530955 nand_release_device(mtd);
956
957 return ret;
958}
Florian Fainelli7351d3a2010-09-07 13:23:45 +0200959EXPORT_SYMBOL(nand_unlock);
Vimal Singh7d70f332010-02-08 15:50:49 +0530960
961/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700962 * nand_lock - [REPLACEABLE] locks all blocks present in the device
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700963 * @mtd: mtd info
964 * @ofs: offset to start unlock from
965 * @len: length to unlock
Vimal Singh7d70f332010-02-08 15:50:49 +0530966 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700967 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
968 * have this feature, but it allows only to lock all blocks, not for specified
969 * range for block. Implementing 'lock' feature by making use of 'unlock', for
970 * now.
Vimal Singh7d70f332010-02-08 15:50:49 +0530971 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700972 * Returns lock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530973 */
974int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
975{
976 int ret = 0;
977 int chipnr, status, page;
978 struct nand_chip *chip = mtd->priv;
979
Brian Norris289c0522011-07-19 10:06:09 -0700980 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530981 __func__, (unsigned long long)ofs, len);
982
983 if (check_offs_len(mtd, ofs, len))
984 ret = -EINVAL;
985
986 nand_get_device(chip, mtd, FL_LOCKING);
987
988 /* Shift to get chip number */
989 chipnr = ofs >> chip->chip_shift;
990
991 chip->select_chip(mtd, chipnr);
992
993 /* Check, if it is write protected */
994 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -0700995 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530996 __func__);
997 status = MTD_ERASE_FAILED;
998 ret = -EIO;
999 goto out;
1000 }
1001
1002 /* Submit address of first page to lock */
1003 page = ofs >> chip->page_shift;
1004 chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);
1005
1006 /* Call wait ready function */
1007 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +05301008 /* See if device thinks it succeeded */
Huang Shijie74830962012-10-14 23:47:24 -04001009 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -07001010 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301011 __func__, status);
1012 ret = -EIO;
1013 goto out;
1014 }
1015
1016 ret = __nand_unlock(mtd, ofs, len, 0x1);
1017
1018out:
Vimal Singh7d70f332010-02-08 15:50:49 +05301019 nand_release_device(mtd);
1020
1021 return ret;
1022}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001023EXPORT_SYMBOL(nand_lock);
Vimal Singh7d70f332010-02-08 15:50:49 +05301024
1025/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001026 * nand_read_page_raw - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001027 * @mtd: mtd info structure
1028 * @chip: nand chip info structure
1029 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001030 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001031 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001032 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001033 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001034 */
1035static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001036 uint8_t *buf, int oob_required, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001037{
1038 chip->read_buf(mtd, buf, mtd->writesize);
Brian Norris279f08d2012-05-02 10:15:03 -07001039 if (oob_required)
1040 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001041 return 0;
1042}
1043
1044/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001045 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001046 * @mtd: mtd info structure
1047 * @chip: nand chip info structure
1048 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001049 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001050 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001051 *
1052 * We need a special oob layout and handling even when OOB isn't used.
1053 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001054static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001055 struct nand_chip *chip, uint8_t *buf,
1056 int oob_required, int page)
David Brownell52ff49d2009-03-04 12:01:36 -08001057{
1058 int eccsize = chip->ecc.size;
1059 int eccbytes = chip->ecc.bytes;
1060 uint8_t *oob = chip->oob_poi;
1061 int steps, size;
1062
1063 for (steps = chip->ecc.steps; steps > 0; steps--) {
1064 chip->read_buf(mtd, buf, eccsize);
1065 buf += eccsize;
1066
1067 if (chip->ecc.prepad) {
1068 chip->read_buf(mtd, oob, chip->ecc.prepad);
1069 oob += chip->ecc.prepad;
1070 }
1071
1072 chip->read_buf(mtd, oob, eccbytes);
1073 oob += eccbytes;
1074
1075 if (chip->ecc.postpad) {
1076 chip->read_buf(mtd, oob, chip->ecc.postpad);
1077 oob += chip->ecc.postpad;
1078 }
1079 }
1080
1081 size = mtd->oobsize - (oob - chip->oob_poi);
1082 if (size)
1083 chip->read_buf(mtd, oob, size);
1084
1085 return 0;
1086}
1087
1088/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001089 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001090 * @mtd: mtd info structure
1091 * @chip: nand chip info structure
1092 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001093 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001094 * @page: page number to read
David A. Marlin068e3c02005-01-24 03:07:46 +00001095 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001096static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001097 uint8_t *buf, int oob_required, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001099 int i, eccsize = chip->ecc.size;
1100 int eccbytes = chip->ecc.bytes;
1101 int eccsteps = chip->ecc.steps;
1102 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001103 uint8_t *ecc_calc = chip->buffers->ecccalc;
1104 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001105 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001106 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001107
Brian Norris1fbb9382012-05-02 10:14:55 -07001108 chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001109
1110 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1111 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1112
1113 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001114 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001115
1116 eccsteps = chip->ecc.steps;
1117 p = buf;
1118
1119 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1120 int stat;
1121
1122 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001123 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001124 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001125 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001126 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001127 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1128 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001129 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001130 return max_bitflips;
Thomas Gleixner22c60f52005-04-04 19:56:32 +01001131}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001134 * nand_read_subpage - [REPLACEABLE] software ECC based sub-page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001135 * @mtd: mtd info structure
1136 * @chip: nand chip info structure
1137 * @data_offs: offset of requested data within the page
1138 * @readlen: data length
1139 * @bufpoi: buffer to store read data
Alexey Korolev3d459552008-05-15 17:23:18 +01001140 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001141static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
1142 uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
Alexey Korolev3d459552008-05-15 17:23:18 +01001143{
1144 int start_step, end_step, num_steps;
1145 uint32_t *eccpos = chip->ecc.layout->eccpos;
1146 uint8_t *p;
1147 int data_col_addr, i, gaps = 0;
1148 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
1149 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001150 int index = 0;
Mike Dunn3f91e942012-04-25 12:06:09 -07001151 unsigned int max_bitflips = 0;
Alexey Korolev3d459552008-05-15 17:23:18 +01001152
Brian Norris7854d3f2011-06-23 14:12:08 -07001153 /* Column address within the page aligned to ECC size (256bytes) */
Alexey Korolev3d459552008-05-15 17:23:18 +01001154 start_step = data_offs / chip->ecc.size;
1155 end_step = (data_offs + readlen - 1) / chip->ecc.size;
1156 num_steps = end_step - start_step + 1;
1157
Brian Norris8b6e50c2011-05-25 14:59:01 -07001158 /* Data size aligned to ECC ecc.size */
Alexey Korolev3d459552008-05-15 17:23:18 +01001159 datafrag_len = num_steps * chip->ecc.size;
1160 eccfrag_len = num_steps * chip->ecc.bytes;
1161
1162 data_col_addr = start_step * chip->ecc.size;
1163 /* If we read not a page aligned data */
1164 if (data_col_addr != 0)
1165 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
1166
1167 p = bufpoi + data_col_addr;
1168 chip->read_buf(mtd, p, datafrag_len);
1169
Brian Norris8b6e50c2011-05-25 14:59:01 -07001170 /* Calculate ECC */
Alexey Korolev3d459552008-05-15 17:23:18 +01001171 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1172 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1173
Brian Norris8b6e50c2011-05-25 14:59:01 -07001174 /*
1175 * The performance is faster if we position offsets according to
Brian Norris7854d3f2011-06-23 14:12:08 -07001176 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
Brian Norris8b6e50c2011-05-25 14:59:01 -07001177 */
Alexey Korolev3d459552008-05-15 17:23:18 +01001178 for (i = 0; i < eccfrag_len - 1; i++) {
1179 if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
1180 eccpos[i + start_step * chip->ecc.bytes + 1]) {
1181 gaps = 1;
1182 break;
1183 }
1184 }
1185 if (gaps) {
1186 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1187 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1188 } else {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001189 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07001190 * Send the command to read the particular ECC bytes take care
Brian Norris8b6e50c2011-05-25 14:59:01 -07001191 * about buswidth alignment in read_buf.
1192 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001193 index = start_step * chip->ecc.bytes;
1194
1195 aligned_pos = eccpos[index] & ~(busw - 1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001196 aligned_len = eccfrag_len;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001197 if (eccpos[index] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001198 aligned_len++;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001199 if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001200 aligned_len++;
1201
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001202 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
1203 mtd->writesize + aligned_pos, -1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001204 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1205 }
1206
1207 for (i = 0; i < eccfrag_len; i++)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001208 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
Alexey Korolev3d459552008-05-15 17:23:18 +01001209
1210 p = bufpoi + data_col_addr;
1211 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1212 int stat;
1213
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001214 stat = chip->ecc.correct(mtd, p,
1215 &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001216 if (stat < 0) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001217 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001218 } else {
Alexey Korolev3d459552008-05-15 17:23:18 +01001219 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001220 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1221 }
Alexey Korolev3d459552008-05-15 17:23:18 +01001222 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001223 return max_bitflips;
Alexey Korolev3d459552008-05-15 17:23:18 +01001224}
1225
1226/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001227 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001228 * @mtd: mtd info structure
1229 * @chip: nand chip info structure
1230 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001231 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001232 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001233 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001234 * Not for syndrome calculating ECC controllers which need a special oob layout.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001235 */
1236static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001237 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001238{
1239 int i, eccsize = chip->ecc.size;
1240 int eccbytes = chip->ecc.bytes;
1241 int eccsteps = chip->ecc.steps;
1242 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001243 uint8_t *ecc_calc = chip->buffers->ecccalc;
1244 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001245 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001246 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001247
1248 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1249 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1250 chip->read_buf(mtd, p, eccsize);
1251 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1252 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001253 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001254
1255 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001256 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001257
1258 eccsteps = chip->ecc.steps;
1259 p = buf;
1260
1261 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1262 int stat;
1263
1264 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001265 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001266 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001267 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001268 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001269 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1270 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001271 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001272 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001273}
1274
1275/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001276 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
Brian Norris8b6e50c2011-05-25 14:59:01 -07001277 * @mtd: mtd info structure
1278 * @chip: nand chip info structure
1279 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001280 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001281 * @page: page number to read
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001282 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001283 * Hardware ECC for large page chips, require OOB to be read first. For this
1284 * ECC mode, the write_page method is re-used from ECC_HW. These methods
1285 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with
1286 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from
1287 * the data area, by overwriting the NAND manufacturer bad block markings.
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001288 */
1289static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001290 struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001291{
1292 int i, eccsize = chip->ecc.size;
1293 int eccbytes = chip->ecc.bytes;
1294 int eccsteps = chip->ecc.steps;
1295 uint8_t *p = buf;
1296 uint8_t *ecc_code = chip->buffers->ecccode;
1297 uint32_t *eccpos = chip->ecc.layout->eccpos;
1298 uint8_t *ecc_calc = chip->buffers->ecccalc;
Mike Dunn3f91e942012-04-25 12:06:09 -07001299 unsigned int max_bitflips = 0;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001300
1301 /* Read the OOB area first */
1302 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1303 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1304 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1305
1306 for (i = 0; i < chip->ecc.total; i++)
1307 ecc_code[i] = chip->oob_poi[eccpos[i]];
1308
1309 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1310 int stat;
1311
1312 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1313 chip->read_buf(mtd, p, eccsize);
1314 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1315
1316 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
Mike Dunn3f91e942012-04-25 12:06:09 -07001317 if (stat < 0) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001318 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001319 } else {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001320 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001321 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1322 }
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001323 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001324 return max_bitflips;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001325}
1326
1327/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001328 * nand_read_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page read
Brian Norris8b6e50c2011-05-25 14:59:01 -07001329 * @mtd: mtd info structure
1330 * @chip: nand chip info structure
1331 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001332 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001333 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001334 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001335 * The hw generator calculates the error syndrome automatically. Therefore we
1336 * need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001337 */
1338static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001339 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001340{
1341 int i, eccsize = chip->ecc.size;
1342 int eccbytes = chip->ecc.bytes;
1343 int eccsteps = chip->ecc.steps;
1344 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001345 uint8_t *oob = chip->oob_poi;
Mike Dunn3f91e942012-04-25 12:06:09 -07001346 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001347
1348 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1349 int stat;
1350
1351 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1352 chip->read_buf(mtd, p, eccsize);
1353
1354 if (chip->ecc.prepad) {
1355 chip->read_buf(mtd, oob, chip->ecc.prepad);
1356 oob += chip->ecc.prepad;
1357 }
1358
1359 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1360 chip->read_buf(mtd, oob, eccbytes);
1361 stat = chip->ecc.correct(mtd, p, oob, NULL);
1362
Mike Dunn3f91e942012-04-25 12:06:09 -07001363 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001364 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001365 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001366 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001367 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1368 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001369
1370 oob += eccbytes;
1371
1372 if (chip->ecc.postpad) {
1373 chip->read_buf(mtd, oob, chip->ecc.postpad);
1374 oob += chip->ecc.postpad;
1375 }
1376 }
1377
1378 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001379 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001380 if (i)
1381 chip->read_buf(mtd, oob, i);
1382
Mike Dunn3f91e942012-04-25 12:06:09 -07001383 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001384}
1385
1386/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001387 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -07001388 * @chip: nand chip structure
1389 * @oob: oob destination address
1390 * @ops: oob ops structure
1391 * @len: size of oob to transfer
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001392 */
1393static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
Vitaly Wool70145682006-11-03 18:20:38 +03001394 struct mtd_oob_ops *ops, size_t len)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001395{
Florian Fainellif8ac0412010-09-07 13:23:43 +02001396 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001397
Brian Norris0612b9d2011-08-30 18:45:40 -07001398 case MTD_OPS_PLACE_OOB:
1399 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001400 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1401 return oob + len;
1402
Brian Norris0612b9d2011-08-30 18:45:40 -07001403 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001404 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001405 uint32_t boffs = 0, roffs = ops->ooboffs;
1406 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001407
Florian Fainellif8ac0412010-09-07 13:23:43 +02001408 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001409 /* Read request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001410 if (unlikely(roffs)) {
1411 if (roffs >= free->length) {
1412 roffs -= free->length;
1413 continue;
1414 }
1415 boffs = free->offset + roffs;
1416 bytes = min_t(size_t, len,
1417 (free->length - roffs));
1418 roffs = 0;
1419 } else {
1420 bytes = min_t(size_t, len, free->length);
1421 boffs = free->offset;
1422 }
1423 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001424 oob += bytes;
1425 }
1426 return oob;
1427 }
1428 default:
1429 BUG();
1430 }
1431 return NULL;
1432}
1433
1434/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001435 * nand_do_read_ops - [INTERN] Read data with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001436 * @mtd: MTD device structure
1437 * @from: offset to read from
1438 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +00001439 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001440 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +00001441 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001442static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1443 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +00001444{
Brian Norrise47f3db2012-05-02 10:14:56 -07001445 int chipnr, page, realpage, col, bytes, aligned, oob_required;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001446 struct nand_chip *chip = mtd->priv;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001447 struct mtd_ecc_stats stats;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001448 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001449 uint32_t readlen = ops->len;
Vitaly Wool70145682006-11-03 18:20:38 +03001450 uint32_t oobreadlen = ops->ooblen;
Brian Norris0612b9d2011-08-30 18:45:40 -07001451 uint32_t max_oobsize = ops->mode == MTD_OPS_AUTO_OOB ?
Maxim Levitsky9aca3342010-02-22 20:39:35 +02001452 mtd->oobavail : mtd->oobsize;
1453
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001454 uint8_t *bufpoi, *oob, *buf;
Mike Dunnedbc45402012-04-25 12:06:11 -07001455 unsigned int max_bitflips = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001457 stats = mtd->ecc_stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001459 chipnr = (int)(from >> chip->chip_shift);
1460 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001462 realpage = (int)(from >> chip->page_shift);
1463 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001465 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001467 buf = ops->datbuf;
1468 oob = ops->oobbuf;
Brian Norrise47f3db2012-05-02 10:14:56 -07001469 oob_required = oob ? 1 : 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001470
Florian Fainellif8ac0412010-09-07 13:23:43 +02001471 while (1) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001472 bytes = min(mtd->writesize - col, readlen);
1473 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001474
Brian Norris8b6e50c2011-05-25 14:59:01 -07001475 /* Is the current page in the buffer? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001476 if (realpage != chip->pagebuf || oob) {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001477 bufpoi = aligned ? buf : chip->buffers->databuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Brian Norrisc00a0992012-05-01 17:12:54 -07001479 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Mike Dunnedbc45402012-04-25 12:06:11 -07001481 /*
1482 * Now read the page into the buffer. Absent an error,
1483 * the read methods return max bitflips per ecc step.
1484 */
Brian Norris0612b9d2011-08-30 18:45:40 -07001485 if (unlikely(ops->mode == MTD_OPS_RAW))
Brian Norris1fbb9382012-05-02 10:14:55 -07001486 ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
Brian Norrise47f3db2012-05-02 10:14:56 -07001487 oob_required,
1488 page);
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05001489 else if (!aligned && NAND_HAS_SUBPAGE_READ(chip) &&
1490 !oob)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001491 ret = chip->ecc.read_subpage(mtd, chip,
1492 col, bytes, bufpoi);
David Woodhouse956e9442006-09-25 17:12:39 +01001493 else
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001494 ret = chip->ecc.read_page(mtd, chip, bufpoi,
Brian Norrise47f3db2012-05-02 10:14:56 -07001495 oob_required, page);
Brian Norris6d77b9d2011-09-07 13:13:40 -07001496 if (ret < 0) {
1497 if (!aligned)
1498 /* Invalidate page cache */
1499 chip->pagebuf = -1;
David Woodhousee0c7d762006-05-13 18:07:53 +01001500 break;
Brian Norris6d77b9d2011-09-07 13:13:40 -07001501 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001502
Mike Dunnedbc45402012-04-25 12:06:11 -07001503 max_bitflips = max_t(unsigned int, max_bitflips, ret);
1504
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001505 /* Transfer not aligned data */
1506 if (!aligned) {
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05001507 if (!NAND_HAS_SUBPAGE_READ(chip) && !oob &&
Brian Norris6d77b9d2011-09-07 13:13:40 -07001508 !(mtd->ecc_stats.failed - stats.failed) &&
Mike Dunnedbc45402012-04-25 12:06:11 -07001509 (ops->mode != MTD_OPS_RAW)) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001510 chip->pagebuf = realpage;
Mike Dunnedbc45402012-04-25 12:06:11 -07001511 chip->pagebuf_bitflips = ret;
1512 } else {
Brian Norris6d77b9d2011-09-07 13:13:40 -07001513 /* Invalidate page cache */
1514 chip->pagebuf = -1;
Mike Dunnedbc45402012-04-25 12:06:11 -07001515 }
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001516 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001518
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001519 buf += bytes;
1520
1521 if (unlikely(oob)) {
Maxim Levitskyb64d39d2010-02-22 20:39:37 +02001522 int toread = min(oobreadlen, max_oobsize);
1523
1524 if (toread) {
1525 oob = nand_transfer_oob(chip,
1526 oob, ops, toread);
1527 oobreadlen -= toread;
1528 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001529 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001530 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001531 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001532 buf += bytes;
Mike Dunnedbc45402012-04-25 12:06:11 -07001533 max_bitflips = max_t(unsigned int, max_bitflips,
1534 chip->pagebuf_bitflips);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001535 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001537 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001538
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001539 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001540 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Brian Norris8b6e50c2011-05-25 14:59:01 -07001542 /* For subsequent reads align to page boundary */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 col = 0;
1544 /* Increment page address */
1545 realpage++;
1546
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001547 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 /* Check, if we cross a chip boundary */
1549 if (!page) {
1550 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001551 chip->select_chip(mtd, -1);
1552 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 }
1555
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001556 ops->retlen = ops->len - (size_t) readlen;
Vitaly Wool70145682006-11-03 18:20:38 +03001557 if (oob)
1558 ops->oobretlen = ops->ooblen - oobreadlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Mike Dunn3f91e942012-04-25 12:06:09 -07001560 if (ret < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001561 return ret;
1562
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001563 if (mtd->ecc_stats.failed - stats.failed)
1564 return -EBADMSG;
1565
Mike Dunnedbc45402012-04-25 12:06:11 -07001566 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001567}
1568
1569/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001570 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001571 * @mtd: MTD device structure
1572 * @from: offset to read from
1573 * @len: number of bytes to read
1574 * @retlen: pointer to variable to store the number of read bytes
1575 * @buf: the databuffer to put data
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001576 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001577 * Get hold of the chip and call nand_do_read.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001578 */
1579static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1580 size_t *retlen, uint8_t *buf)
1581{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001582 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07001583 struct mtd_oob_ops ops;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001584 int ret;
1585
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001586 nand_get_device(chip, mtd, FL_READING);
Brian Norris4a89ff82011-08-30 18:45:45 -07001587 ops.len = len;
1588 ops.datbuf = buf;
1589 ops.oobbuf = NULL;
Huang Shijie11041ae2012-07-03 16:44:14 +08001590 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norris4a89ff82011-08-30 18:45:45 -07001591 ret = nand_do_read_ops(mtd, from, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07001592 *retlen = ops.retlen;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001593 nand_release_device(mtd);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001594 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595}
1596
1597/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001598 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001599 * @mtd: mtd info structure
1600 * @chip: nand chip info structure
1601 * @page: page number to read
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001602 */
1603static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001604 int page)
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001605{
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001606 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001607 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001608 return 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001609}
1610
1611/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001612 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001613 * with syndromes
Brian Norris8b6e50c2011-05-25 14:59:01 -07001614 * @mtd: mtd info structure
1615 * @chip: nand chip info structure
1616 * @page: page number to read
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001617 */
1618static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001619 int page)
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001620{
1621 uint8_t *buf = chip->oob_poi;
1622 int length = mtd->oobsize;
1623 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1624 int eccsize = chip->ecc.size;
1625 uint8_t *bufpoi = buf;
1626 int i, toread, sndrnd = 0, pos;
1627
1628 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1629 for (i = 0; i < chip->ecc.steps; i++) {
1630 if (sndrnd) {
1631 pos = eccsize + i * (eccsize + chunk);
1632 if (mtd->writesize > 512)
1633 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1634 else
1635 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1636 } else
1637 sndrnd = 1;
1638 toread = min_t(int, length, chunk);
1639 chip->read_buf(mtd, bufpoi, toread);
1640 bufpoi += toread;
1641 length -= toread;
1642 }
1643 if (length > 0)
1644 chip->read_buf(mtd, bufpoi, length);
1645
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001646 return 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001647}
1648
1649/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001650 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001651 * @mtd: mtd info structure
1652 * @chip: nand chip info structure
1653 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001654 */
1655static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1656 int page)
1657{
1658 int status = 0;
1659 const uint8_t *buf = chip->oob_poi;
1660 int length = mtd->oobsize;
1661
1662 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1663 chip->write_buf(mtd, buf, length);
1664 /* Send command to program the OOB data */
1665 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1666
1667 status = chip->waitfunc(mtd, chip);
1668
Savin Zlobec0d420f92006-06-21 11:51:20 +02001669 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001670}
1671
1672/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001673 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001674 * with syndrome - only for large page flash
1675 * @mtd: mtd info structure
1676 * @chip: nand chip info structure
1677 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001678 */
1679static int nand_write_oob_syndrome(struct mtd_info *mtd,
1680 struct nand_chip *chip, int page)
1681{
1682 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1683 int eccsize = chip->ecc.size, length = mtd->oobsize;
1684 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1685 const uint8_t *bufpoi = chip->oob_poi;
1686
1687 /*
1688 * data-ecc-data-ecc ... ecc-oob
1689 * or
1690 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1691 */
1692 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1693 pos = steps * (eccsize + chunk);
1694 steps = 0;
1695 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02001696 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001697
1698 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1699 for (i = 0; i < steps; i++) {
1700 if (sndcmd) {
1701 if (mtd->writesize <= 512) {
1702 uint32_t fill = 0xFFFFFFFF;
1703
1704 len = eccsize;
1705 while (len > 0) {
1706 int num = min_t(int, len, 4);
1707 chip->write_buf(mtd, (uint8_t *)&fill,
1708 num);
1709 len -= num;
1710 }
1711 } else {
1712 pos = eccsize + i * (eccsize + chunk);
1713 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1714 }
1715 } else
1716 sndcmd = 1;
1717 len = min_t(int, length, chunk);
1718 chip->write_buf(mtd, bufpoi, len);
1719 bufpoi += len;
1720 length -= len;
1721 }
1722 if (length > 0)
1723 chip->write_buf(mtd, bufpoi, length);
1724
1725 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1726 status = chip->waitfunc(mtd, chip);
1727
1728 return status & NAND_STATUS_FAIL ? -EIO : 0;
1729}
1730
1731/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001732 * nand_do_read_oob - [INTERN] NAND read out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07001733 * @mtd: MTD device structure
1734 * @from: offset to read from
1735 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001737 * NAND read out-of-band data from the spare area.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001739static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1740 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741{
Brian Norrisc00a0992012-05-01 17:12:54 -07001742 int page, realpage, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001743 struct nand_chip *chip = mtd->priv;
Brian Norris041e4572011-06-23 16:45:24 -07001744 struct mtd_ecc_stats stats;
Vitaly Wool70145682006-11-03 18:20:38 +03001745 int readlen = ops->ooblen;
1746 int len;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001747 uint8_t *buf = ops->oobbuf;
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03001748 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749
Brian Norris289c0522011-07-19 10:06:09 -07001750 pr_debug("%s: from = 0x%08Lx, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05301751 __func__, (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752
Brian Norris041e4572011-06-23 16:45:24 -07001753 stats = mtd->ecc_stats;
1754
Brian Norris0612b9d2011-08-30 18:45:40 -07001755 if (ops->mode == MTD_OPS_AUTO_OOB)
Vitaly Wool70145682006-11-03 18:20:38 +03001756 len = chip->ecc.layout->oobavail;
Adrian Hunter03736152007-01-31 17:58:29 +02001757 else
1758 len = mtd->oobsize;
1759
1760 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07001761 pr_debug("%s: attempt to start read outside oob\n",
1762 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001763 return -EINVAL;
1764 }
1765
1766 /* Do not allow reads past end of device */
1767 if (unlikely(from >= mtd->size ||
1768 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1769 (from >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07001770 pr_debug("%s: attempt to read beyond end of device\n",
1771 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02001772 return -EINVAL;
1773 }
Vitaly Wool70145682006-11-03 18:20:38 +03001774
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001775 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001776 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001778 /* Shift to get page */
1779 realpage = (int)(from >> chip->page_shift);
1780 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Florian Fainellif8ac0412010-09-07 13:23:43 +02001782 while (1) {
Brian Norris0612b9d2011-08-30 18:45:40 -07001783 if (ops->mode == MTD_OPS_RAW)
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03001784 ret = chip->ecc.read_oob_raw(mtd, chip, page);
Brian Norrisc46f6482011-08-30 18:45:38 -07001785 else
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03001786 ret = chip->ecc.read_oob(mtd, chip, page);
1787
1788 if (ret < 0)
1789 break;
Vitaly Wool70145682006-11-03 18:20:38 +03001790
1791 len = min(len, readlen);
1792 buf = nand_transfer_oob(chip, buf, ops, len);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001793
Vitaly Wool70145682006-11-03 18:20:38 +03001794 readlen -= len;
Savin Zlobec0d420f92006-06-21 11:51:20 +02001795 if (!readlen)
1796 break;
1797
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02001798 /* Increment page address */
1799 realpage++;
1800
1801 page = realpage & chip->pagemask;
1802 /* Check, if we cross a chip boundary */
1803 if (!page) {
1804 chipnr++;
1805 chip->select_chip(mtd, -1);
1806 chip->select_chip(mtd, chipnr);
1807 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 }
1809
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03001810 ops->oobretlen = ops->ooblen - readlen;
1811
1812 if (ret < 0)
1813 return ret;
Brian Norris041e4572011-06-23 16:45:24 -07001814
1815 if (mtd->ecc_stats.failed - stats.failed)
1816 return -EBADMSG;
1817
1818 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819}
1820
1821/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001822 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07001823 * @mtd: MTD device structure
1824 * @from: offset to read from
1825 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001827 * NAND read data and/or out-of-band data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001829static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1830 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001832 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001833 int ret = -ENOTSUPP;
1834
1835 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
1837 /* Do not allow reads past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03001838 if (ops->datbuf && (from + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07001839 pr_debug("%s: attempt to read beyond end of device\n",
1840 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 return -EINVAL;
1842 }
1843
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001844 nand_get_device(chip, mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Florian Fainellif8ac0412010-09-07 13:23:43 +02001846 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07001847 case MTD_OPS_PLACE_OOB:
1848 case MTD_OPS_AUTO_OOB:
1849 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001850 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001851
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001852 default:
1853 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 }
1855
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001856 if (!ops->datbuf)
1857 ret = nand_do_read_oob(mtd, from, ops);
1858 else
1859 ret = nand_do_read_ops(mtd, from, ops);
1860
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001861out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001863 return ret;
1864}
1865
1866
1867/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001868 * nand_write_page_raw - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001869 * @mtd: mtd info structure
1870 * @chip: nand chip info structure
1871 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001872 * @oob_required: must write chip->oob_poi to OOB
David Brownell52ff49d2009-03-04 12:01:36 -08001873 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001874 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001875 */
Josh Wufdbad98d2012-06-25 18:07:45 +08001876static int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001877 const uint8_t *buf, int oob_required)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001878{
1879 chip->write_buf(mtd, buf, mtd->writesize);
Brian Norris279f08d2012-05-02 10:15:03 -07001880 if (oob_required)
1881 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Josh Wufdbad98d2012-06-25 18:07:45 +08001882
1883 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884}
1885
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001886/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001887 * nand_write_page_raw_syndrome - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001888 * @mtd: mtd info structure
1889 * @chip: nand chip info structure
1890 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001891 * @oob_required: must write chip->oob_poi to OOB
David Brownell52ff49d2009-03-04 12:01:36 -08001892 *
1893 * We need a special oob layout and handling even when ECC isn't checked.
1894 */
Josh Wufdbad98d2012-06-25 18:07:45 +08001895static int nand_write_page_raw_syndrome(struct mtd_info *mtd,
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001896 struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001897 const uint8_t *buf, int oob_required)
David Brownell52ff49d2009-03-04 12:01:36 -08001898{
1899 int eccsize = chip->ecc.size;
1900 int eccbytes = chip->ecc.bytes;
1901 uint8_t *oob = chip->oob_poi;
1902 int steps, size;
1903
1904 for (steps = chip->ecc.steps; steps > 0; steps--) {
1905 chip->write_buf(mtd, buf, eccsize);
1906 buf += eccsize;
1907
1908 if (chip->ecc.prepad) {
1909 chip->write_buf(mtd, oob, chip->ecc.prepad);
1910 oob += chip->ecc.prepad;
1911 }
1912
1913 chip->read_buf(mtd, oob, eccbytes);
1914 oob += eccbytes;
1915
1916 if (chip->ecc.postpad) {
1917 chip->write_buf(mtd, oob, chip->ecc.postpad);
1918 oob += chip->ecc.postpad;
1919 }
1920 }
1921
1922 size = mtd->oobsize - (oob - chip->oob_poi);
1923 if (size)
1924 chip->write_buf(mtd, oob, size);
Josh Wufdbad98d2012-06-25 18:07:45 +08001925
1926 return 0;
David Brownell52ff49d2009-03-04 12:01:36 -08001927}
1928/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001929 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001930 * @mtd: mtd info structure
1931 * @chip: nand chip info structure
1932 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001933 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001934 */
Josh Wufdbad98d2012-06-25 18:07:45 +08001935static int nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001936 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001937{
1938 int i, eccsize = chip->ecc.size;
1939 int eccbytes = chip->ecc.bytes;
1940 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001941 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001942 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001943 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001944
Brian Norris7854d3f2011-06-23 14:12:08 -07001945 /* Software ECC calculation */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001946 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1947 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001948
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001949 for (i = 0; i < chip->ecc.total; i++)
1950 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001951
Josh Wufdbad98d2012-06-25 18:07:45 +08001952 return chip->ecc.write_page_raw(mtd, chip, buf, 1);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001953}
1954
1955/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001956 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001957 * @mtd: mtd info structure
1958 * @chip: nand chip info structure
1959 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001960 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001961 */
Josh Wufdbad98d2012-06-25 18:07:45 +08001962static int nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001963 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001964{
1965 int i, eccsize = chip->ecc.size;
1966 int eccbytes = chip->ecc.bytes;
1967 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001968 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001969 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01001970 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001971
1972 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1973 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01001974 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001975 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1976 }
1977
1978 for (i = 0; i < chip->ecc.total; i++)
1979 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1980
1981 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Josh Wufdbad98d2012-06-25 18:07:45 +08001982
1983 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001984}
1985
1986/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001987 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
Brian Norris8b6e50c2011-05-25 14:59:01 -07001988 * @mtd: mtd info structure
1989 * @chip: nand chip info structure
1990 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07001991 * @oob_required: must write chip->oob_poi to OOB
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001992 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001993 * The hw generator calculates the error syndrome automatically. Therefore we
1994 * need a special oob layout and handling.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001995 */
Josh Wufdbad98d2012-06-25 18:07:45 +08001996static int nand_write_page_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001997 struct nand_chip *chip,
1998 const uint8_t *buf, int oob_required)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001999{
2000 int i, eccsize = chip->ecc.size;
2001 int eccbytes = chip->ecc.bytes;
2002 int eccsteps = chip->ecc.steps;
2003 const uint8_t *p = buf;
2004 uint8_t *oob = chip->oob_poi;
2005
2006 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2007
2008 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2009 chip->write_buf(mtd, p, eccsize);
2010
2011 if (chip->ecc.prepad) {
2012 chip->write_buf(mtd, oob, chip->ecc.prepad);
2013 oob += chip->ecc.prepad;
2014 }
2015
2016 chip->ecc.calculate(mtd, p, oob);
2017 chip->write_buf(mtd, oob, eccbytes);
2018 oob += eccbytes;
2019
2020 if (chip->ecc.postpad) {
2021 chip->write_buf(mtd, oob, chip->ecc.postpad);
2022 oob += chip->ecc.postpad;
2023 }
2024 }
2025
2026 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04002027 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002028 if (i)
2029 chip->write_buf(mtd, oob, i);
Josh Wufdbad98d2012-06-25 18:07:45 +08002030
2031 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002032}
2033
2034/**
David Woodhouse956e9442006-09-25 17:12:39 +01002035 * nand_write_page - [REPLACEABLE] write one page
Brian Norris8b6e50c2011-05-25 14:59:01 -07002036 * @mtd: MTD device structure
2037 * @chip: NAND chip descriptor
2038 * @buf: the data to write
Brian Norris1fbb9382012-05-02 10:14:55 -07002039 * @oob_required: must write chip->oob_poi to OOB
Brian Norris8b6e50c2011-05-25 14:59:01 -07002040 * @page: page number to write
2041 * @cached: cached programming
2042 * @raw: use _raw version of write_page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002043 */
2044static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07002045 const uint8_t *buf, int oob_required, int page,
2046 int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002047{
2048 int status;
2049
2050 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
2051
David Woodhouse956e9442006-09-25 17:12:39 +01002052 if (unlikely(raw))
Josh Wufdbad98d2012-06-25 18:07:45 +08002053 status = chip->ecc.write_page_raw(mtd, chip, buf, oob_required);
David Woodhouse956e9442006-09-25 17:12:39 +01002054 else
Josh Wufdbad98d2012-06-25 18:07:45 +08002055 status = chip->ecc.write_page(mtd, chip, buf, oob_required);
2056
2057 if (status < 0)
2058 return status;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002059
2060 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07002061 * Cached progamming disabled for now. Not sure if it's worth the
Brian Norris8b6e50c2011-05-25 14:59:01 -07002062 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002063 */
2064 cached = 0;
2065
2066 if (!cached || !(chip->options & NAND_CACHEPRG)) {
2067
2068 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002069 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002070 /*
2071 * See if operation failed and additional status checks are
Brian Norris8b6e50c2011-05-25 14:59:01 -07002072 * available.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002073 */
2074 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2075 status = chip->errstat(mtd, chip, FL_WRITING, status,
2076 page);
2077
2078 if (status & NAND_STATUS_FAIL)
2079 return -EIO;
2080 } else {
2081 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002082 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002083 }
2084
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002085 return 0;
2086}
2087
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002088/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002089 * nand_fill_oob - [INTERN] Transfer client buffer to oob
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002090 * @mtd: MTD device structure
Brian Norris8b6e50c2011-05-25 14:59:01 -07002091 * @oob: oob data buffer
2092 * @len: oob data write length
2093 * @ops: oob ops structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002094 */
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002095static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
2096 struct mtd_oob_ops *ops)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002097{
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002098 struct nand_chip *chip = mtd->priv;
2099
2100 /*
2101 * Initialise to all 0xFF, to avoid the possibility of left over OOB
2102 * data from a previous OOB read.
2103 */
2104 memset(chip->oob_poi, 0xff, mtd->oobsize);
2105
Florian Fainellif8ac0412010-09-07 13:23:43 +02002106 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002107
Brian Norris0612b9d2011-08-30 18:45:40 -07002108 case MTD_OPS_PLACE_OOB:
2109 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002110 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
2111 return oob + len;
2112
Brian Norris0612b9d2011-08-30 18:45:40 -07002113 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002114 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002115 uint32_t boffs = 0, woffs = ops->ooboffs;
2116 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002117
Florian Fainellif8ac0412010-09-07 13:23:43 +02002118 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002119 /* Write request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002120 if (unlikely(woffs)) {
2121 if (woffs >= free->length) {
2122 woffs -= free->length;
2123 continue;
2124 }
2125 boffs = free->offset + woffs;
2126 bytes = min_t(size_t, len,
2127 (free->length - woffs));
2128 woffs = 0;
2129 } else {
2130 bytes = min_t(size_t, len, free->length);
2131 boffs = free->offset;
2132 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02002133 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002134 oob += bytes;
2135 }
2136 return oob;
2137 }
2138 default:
2139 BUG();
2140 }
2141 return NULL;
2142}
2143
Florian Fainellif8ac0412010-09-07 13:23:43 +02002144#define NOTALIGNED(x) ((x & (chip->subpagesize - 1)) != 0)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002145
2146/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002147 * nand_do_write_ops - [INTERN] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002148 * @mtd: MTD device structure
2149 * @to: offset to write to
2150 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002151 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002152 * NAND write with ECC.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002153 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002154static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
2155 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002156{
Thomas Gleixner29072b92006-09-28 15:38:36 +02002157 int chipnr, realpage, page, blockmask, column;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002158 struct nand_chip *chip = mtd->priv;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002159 uint32_t writelen = ops->len;
Maxim Levitsky782ce792010-02-22 20:39:36 +02002160
2161 uint32_t oobwritelen = ops->ooblen;
Brian Norris0612b9d2011-08-30 18:45:40 -07002162 uint32_t oobmaxlen = ops->mode == MTD_OPS_AUTO_OOB ?
Maxim Levitsky782ce792010-02-22 20:39:36 +02002163 mtd->oobavail : mtd->oobsize;
2164
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002165 uint8_t *oob = ops->oobbuf;
2166 uint8_t *buf = ops->datbuf;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002167 int ret, subpage;
Brian Norrise47f3db2012-05-02 10:14:56 -07002168 int oob_required = oob ? 1 : 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002169
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002170 ops->retlen = 0;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002171 if (!writelen)
2172 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002173
Brian Norris8b6e50c2011-05-25 14:59:01 -07002174 /* Reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002175 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002176 pr_notice("%s: attempt to write non page aligned data\n",
2177 __func__);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002178 return -EINVAL;
2179 }
2180
Thomas Gleixner29072b92006-09-28 15:38:36 +02002181 column = to & (mtd->writesize - 1);
2182 subpage = column || (writelen & (mtd->writesize - 1));
2183
2184 if (subpage && oob)
2185 return -EINVAL;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002186
Thomas Gleixner6a930962006-06-28 00:11:45 +02002187 chipnr = (int)(to >> chip->chip_shift);
2188 chip->select_chip(mtd, chipnr);
2189
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002190 /* Check, if it is write protected */
2191 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002192 return -EIO;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002193
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002194 realpage = (int)(to >> chip->page_shift);
2195 page = realpage & chip->pagemask;
2196 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2197
2198 /* Invalidate the page cache, when we write to the cached page */
2199 if (to <= (chip->pagebuf << chip->page_shift) &&
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002200 (chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002201 chip->pagebuf = -1;
2202
Maxim Levitsky782ce792010-02-22 20:39:36 +02002203 /* Don't allow multipage oob writes with offset */
Jon Poveycdcf12b2010-09-30 20:41:34 +09002204 if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen))
Maxim Levitsky782ce792010-02-22 20:39:36 +02002205 return -EINVAL;
2206
Florian Fainellif8ac0412010-09-07 13:23:43 +02002207 while (1) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02002208 int bytes = mtd->writesize;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002209 int cached = writelen > bytes && page != blockmask;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002210 uint8_t *wbuf = buf;
2211
Brian Norris8b6e50c2011-05-25 14:59:01 -07002212 /* Partial page write? */
Thomas Gleixner29072b92006-09-28 15:38:36 +02002213 if (unlikely(column || writelen < (mtd->writesize - 1))) {
2214 cached = 0;
2215 bytes = min_t(int, bytes - column, (int) writelen);
2216 chip->pagebuf = -1;
2217 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2218 memcpy(&chip->buffers->databuf[column], buf, bytes);
2219 wbuf = chip->buffers->databuf;
2220 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002221
Maxim Levitsky782ce792010-02-22 20:39:36 +02002222 if (unlikely(oob)) {
2223 size_t len = min(oobwritelen, oobmaxlen);
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002224 oob = nand_fill_oob(mtd, oob, len, ops);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002225 oobwritelen -= len;
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002226 } else {
2227 /* We still need to erase leftover OOB data */
2228 memset(chip->oob_poi, 0xff, mtd->oobsize);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002229 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002230
Brian Norrise47f3db2012-05-02 10:14:56 -07002231 ret = chip->write_page(mtd, chip, wbuf, oob_required, page,
2232 cached, (ops->mode == MTD_OPS_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002233 if (ret)
2234 break;
2235
2236 writelen -= bytes;
2237 if (!writelen)
2238 break;
2239
Thomas Gleixner29072b92006-09-28 15:38:36 +02002240 column = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002241 buf += bytes;
2242 realpage++;
2243
2244 page = realpage & chip->pagemask;
2245 /* Check, if we cross a chip boundary */
2246 if (!page) {
2247 chipnr++;
2248 chip->select_chip(mtd, -1);
2249 chip->select_chip(mtd, chipnr);
2250 }
2251 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002252
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002253 ops->retlen = ops->len - writelen;
Vitaly Wool70145682006-11-03 18:20:38 +03002254 if (unlikely(oob))
2255 ops->oobretlen = ops->ooblen;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002256 return ret;
2257}
2258
2259/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002260 * panic_nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002261 * @mtd: MTD device structure
2262 * @to: offset to write to
2263 * @len: number of bytes to write
2264 * @retlen: pointer to variable to store the number of written bytes
2265 * @buf: the data to write
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002266 *
2267 * NAND write with ECC. Used when performing writes in interrupt context, this
2268 * may for example be called by mtdoops when writing an oops while in panic.
2269 */
2270static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2271 size_t *retlen, const uint8_t *buf)
2272{
2273 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07002274 struct mtd_oob_ops ops;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002275 int ret;
2276
Brian Norris8b6e50c2011-05-25 14:59:01 -07002277 /* Wait for the device to get ready */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002278 panic_nand_wait(mtd, chip, 400);
2279
Brian Norris8b6e50c2011-05-25 14:59:01 -07002280 /* Grab the device */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002281 panic_nand_get_device(chip, mtd, FL_WRITING);
2282
Brian Norris4a89ff82011-08-30 18:45:45 -07002283 ops.len = len;
2284 ops.datbuf = (uint8_t *)buf;
2285 ops.oobbuf = NULL;
Huang Shijie11041ae2012-07-03 16:44:14 +08002286 ops.mode = MTD_OPS_PLACE_OOB;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002287
Brian Norris4a89ff82011-08-30 18:45:45 -07002288 ret = nand_do_write_ops(mtd, to, &ops);
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002289
Brian Norris4a89ff82011-08-30 18:45:45 -07002290 *retlen = ops.retlen;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002291 return ret;
2292}
2293
2294/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002295 * nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002296 * @mtd: MTD device structure
2297 * @to: offset to write to
2298 * @len: number of bytes to write
2299 * @retlen: pointer to variable to store the number of written bytes
2300 * @buf: the data to write
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002302 * NAND write with ECC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002304static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002305 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002307 struct nand_chip *chip = mtd->priv;
Brian Norris4a89ff82011-08-30 18:45:45 -07002308 struct mtd_oob_ops ops;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002309 int ret;
2310
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002311 nand_get_device(chip, mtd, FL_WRITING);
Brian Norris4a89ff82011-08-30 18:45:45 -07002312 ops.len = len;
2313 ops.datbuf = (uint8_t *)buf;
2314 ops.oobbuf = NULL;
Huang Shijie11041ae2012-07-03 16:44:14 +08002315 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norris4a89ff82011-08-30 18:45:45 -07002316 ret = nand_do_write_ops(mtd, to, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07002317 *retlen = ops.retlen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002318 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002319 return ret;
2320}
2321
2322/**
2323 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002324 * @mtd: MTD device structure
2325 * @to: offset to write to
2326 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002327 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002328 * NAND write out-of-band.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002329 */
2330static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2331 struct mtd_oob_ops *ops)
2332{
Adrian Hunter03736152007-01-31 17:58:29 +02002333 int chipnr, page, status, len;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002334 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335
Brian Norris289c0522011-07-19 10:06:09 -07002336 pr_debug("%s: to = 0x%08x, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05302337 __func__, (unsigned int)to, (int)ops->ooblen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338
Brian Norris0612b9d2011-08-30 18:45:40 -07002339 if (ops->mode == MTD_OPS_AUTO_OOB)
Adrian Hunter03736152007-01-31 17:58:29 +02002340 len = chip->ecc.layout->oobavail;
2341 else
2342 len = mtd->oobsize;
2343
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 /* Do not allow write past end of page */
Adrian Hunter03736152007-01-31 17:58:29 +02002345 if ((ops->ooboffs + ops->ooblen) > len) {
Brian Norris289c0522011-07-19 10:06:09 -07002346 pr_debug("%s: attempt to write past end of page\n",
2347 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 return -EINVAL;
2349 }
2350
Adrian Hunter03736152007-01-31 17:58:29 +02002351 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002352 pr_debug("%s: attempt to start write outside oob\n",
2353 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002354 return -EINVAL;
2355 }
2356
Jason Liu775adc32011-02-25 13:06:18 +08002357 /* Do not allow write past end of device */
Adrian Hunter03736152007-01-31 17:58:29 +02002358 if (unlikely(to >= mtd->size ||
2359 ops->ooboffs + ops->ooblen >
2360 ((mtd->size >> chip->page_shift) -
2361 (to >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002362 pr_debug("%s: attempt to write beyond end of device\n",
2363 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002364 return -EINVAL;
2365 }
2366
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002367 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002368 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002370 /* Shift to get page */
2371 page = (int)(to >> chip->page_shift);
2372
2373 /*
2374 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2375 * of my DiskOnChip 2000 test units) will clear the whole data page too
2376 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2377 * it in the doc2000 driver in August 1999. dwmw2.
2378 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002379 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380
2381 /* Check, if it is write protected */
2382 if (nand_check_wp(mtd))
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002383 return -EROFS;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002384
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002386 if (page == chip->pagebuf)
2387 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002389 nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
Brian Norris9ce244b2011-08-30 18:45:37 -07002390
Brian Norris0612b9d2011-08-30 18:45:40 -07002391 if (ops->mode == MTD_OPS_RAW)
Brian Norris9ce244b2011-08-30 18:45:37 -07002392 status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
2393 else
2394 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002395
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002396 if (status)
2397 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398
Vitaly Wool70145682006-11-03 18:20:38 +03002399 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002401 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002402}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002404/**
2405 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002406 * @mtd: MTD device structure
2407 * @to: offset to write to
2408 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002409 */
2410static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2411 struct mtd_oob_ops *ops)
2412{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002413 struct nand_chip *chip = mtd->priv;
2414 int ret = -ENOTSUPP;
2415
2416 ops->retlen = 0;
2417
2418 /* Do not allow writes past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002419 if (ops->datbuf && (to + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07002420 pr_debug("%s: attempt to write beyond end of device\n",
2421 __func__);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002422 return -EINVAL;
2423 }
2424
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002425 nand_get_device(chip, mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002426
Florian Fainellif8ac0412010-09-07 13:23:43 +02002427 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07002428 case MTD_OPS_PLACE_OOB:
2429 case MTD_OPS_AUTO_OOB:
2430 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002431 break;
2432
2433 default:
2434 goto out;
2435 }
2436
2437 if (!ops->datbuf)
2438 ret = nand_do_write_oob(mtd, to, ops);
2439 else
2440 ret = nand_do_write_ops(mtd, to, ops);
2441
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002442out:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002443 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 return ret;
2445}
2446
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002448 * single_erase_cmd - [GENERIC] NAND standard block erase command function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002449 * @mtd: MTD device structure
2450 * @page: the page address of the block which will be erased
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002452 * Standard erase command for NAND chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002454static void single_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002456 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002458 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2459 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460}
2461
2462/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002463 * multi_erase_cmd - [GENERIC] AND specific block erase command function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002464 * @mtd: MTD device structure
2465 * @page: the page address of the block which will be erased
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002467 * AND multi block erase command function. Erase 4 consecutive blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002469static void multi_erase_cmd(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002471 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002473 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2474 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2475 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2476 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2477 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
2479
2480/**
2481 * nand_erase - [MTD Interface] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002482 * @mtd: MTD device structure
2483 * @instr: erase instruction
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002485 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002487static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488{
David Woodhousee0c7d762006-05-13 18:07:53 +01002489 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002491
David A. Marlin30f464b2005-01-17 18:35:25 +00002492#define BBT_PAGE_MASK 0xffffff3f
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002494 * nand_erase_nand - [INTERN] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002495 * @mtd: MTD device structure
2496 * @instr: erase instruction
2497 * @allowbbt: allow erasing the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002499 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002501int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2502 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503{
Adrian Hunter69423d92008-12-10 13:37:21 +00002504 int page, status, pages_per_block, ret, chipnr;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002505 struct nand_chip *chip = mtd->priv;
Florian Fainellif8ac0412010-09-07 13:23:43 +02002506 loff_t rewrite_bbt[NAND_MAX_CHIPS] = {0};
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002507 unsigned int bbt_masked_page = 0xffffffff;
Adrian Hunter69423d92008-12-10 13:37:21 +00002508 loff_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509
Brian Norris289c0522011-07-19 10:06:09 -07002510 pr_debug("%s: start = 0x%012llx, len = %llu\n",
2511 __func__, (unsigned long long)instr->addr,
2512 (unsigned long long)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513
Vimal Singh6fe5a6a2010-02-03 14:12:24 +05302514 if (check_offs_len(mtd, instr->addr, instr->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002518 nand_get_device(chip, mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519
2520 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002521 page = (int)(instr->addr >> chip->page_shift);
2522 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523
2524 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002525 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526
2527 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002528 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 /* Check, if it is write protected */
2531 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07002532 pr_debug("%s: device is write protected!\n",
2533 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 instr->state = MTD_ERASE_FAILED;
2535 goto erase_exit;
2536 }
2537
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002538 /*
2539 * If BBT requires refresh, set the BBT page mask to see if the BBT
2540 * should be rewritten. Otherwise the mask is set to 0xffffffff which
2541 * can not be matched. This is also done when the bbt is actually
Brian Norris7854d3f2011-06-23 14:12:08 -07002542 * erased to avoid recursive updates.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002543 */
2544 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
2545 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
David A. Marlin30f464b2005-01-17 18:35:25 +00002546
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 /* Loop through the pages */
2548 len = instr->len;
2549
2550 instr->state = MTD_ERASING;
2551
2552 while (len) {
Wolfram Sang12183a22011-12-21 23:01:20 +01002553 /* Check if we have a bad block, we do not erase bad blocks! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002554 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2555 chip->page_shift, 0, allowbbt)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002556 pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
2557 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 instr->state = MTD_ERASE_FAILED;
2559 goto erase_exit;
2560 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002561
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002562 /*
2563 * Invalidate the page cache, if we erase the block which
Brian Norris8b6e50c2011-05-25 14:59:01 -07002564 * contains the current cached page.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002565 */
2566 if (page <= chip->pagebuf && chip->pagebuf <
2567 (page + pages_per_block))
2568 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002570 chip->erase_cmd(mtd, page & chip->pagemask);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002571
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002572 status = chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002574 /*
2575 * See if operation failed and additional status checks are
2576 * available
2577 */
2578 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2579 status = chip->errstat(mtd, chip, FL_ERASING,
2580 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00002581
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00002583 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -07002584 pr_debug("%s: failed erase, page 0x%08x\n",
2585 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 instr->state = MTD_ERASE_FAILED;
Adrian Hunter69423d92008-12-10 13:37:21 +00002587 instr->fail_addr =
2588 ((loff_t)page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589 goto erase_exit;
2590 }
David A. Marlin30f464b2005-01-17 18:35:25 +00002591
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002592 /*
2593 * If BBT requires refresh, set the BBT rewrite flag to the
Brian Norris8b6e50c2011-05-25 14:59:01 -07002594 * page being erased.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002595 */
2596 if (bbt_masked_page != 0xffffffff &&
2597 (page & BBT_PAGE_MASK) == bbt_masked_page)
Adrian Hunter69423d92008-12-10 13:37:21 +00002598 rewrite_bbt[chipnr] =
2599 ((loff_t)page << chip->page_shift);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002600
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 /* Increment page address and decrement length */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002602 len -= (1 << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 page += pages_per_block;
2604
2605 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002606 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002608 chip->select_chip(mtd, -1);
2609 chip->select_chip(mtd, chipnr);
David A. Marlin30f464b2005-01-17 18:35:25 +00002610
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002611 /*
2612 * If BBT requires refresh and BBT-PERCHIP, set the BBT
Brian Norris8b6e50c2011-05-25 14:59:01 -07002613 * page mask to see if this BBT should be rewritten.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002614 */
2615 if (bbt_masked_page != 0xffffffff &&
2616 (chip->bbt_td->options & NAND_BBT_PERCHIP))
2617 bbt_masked_page = chip->bbt_td->pages[chipnr] &
2618 BBT_PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619 }
2620 }
2621 instr->state = MTD_ERASE_DONE;
2622
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002623erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624
2625 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626
2627 /* Deselect and wake up anyone waiting on the device */
2628 nand_release_device(mtd);
2629
David Woodhouse49defc02007-10-06 15:01:59 -04002630 /* Do call back function */
2631 if (!ret)
2632 mtd_erase_callback(instr);
2633
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002634 /*
2635 * If BBT requires refresh and erase was successful, rewrite any
Brian Norris8b6e50c2011-05-25 14:59:01 -07002636 * selected bad block tables.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002637 */
2638 if (bbt_masked_page == 0xffffffff || ret)
2639 return ret;
2640
2641 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2642 if (!rewrite_bbt[chipnr])
2643 continue;
Brian Norris8b6e50c2011-05-25 14:59:01 -07002644 /* Update the BBT for chip */
Brian Norris289c0522011-07-19 10:06:09 -07002645 pr_debug("%s: nand_update_bbt (%d:0x%0llx 0x%0x)\n",
2646 __func__, chipnr, rewrite_bbt[chipnr],
2647 chip->bbt_td->pages[chipnr]);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002648 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
David A. Marlin30f464b2005-01-17 18:35:25 +00002649 }
2650
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 /* Return more or less happy */
2652 return ret;
2653}
2654
2655/**
2656 * nand_sync - [MTD Interface] sync
Brian Norris8b6e50c2011-05-25 14:59:01 -07002657 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002659 * Sync is actually a wait for chip ready function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002661static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002663 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664
Brian Norris289c0522011-07-19 10:06:09 -07002665 pr_debug("%s: called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666
2667 /* Grab the lock and see if the device is available */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002668 nand_get_device(chip, mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01002670 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671}
2672
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002674 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07002675 * @mtd: MTD device structure
2676 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002678static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002680 return nand_block_checkbad(mtd, offs, 1, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681}
2682
2683/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002684 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07002685 * @mtd: MTD device structure
2686 * @ofs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002688static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002690 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691 int ret;
2692
Florian Fainellif8ac0412010-09-07 13:23:43 +02002693 ret = nand_block_isbad(mtd, ofs);
2694 if (ret) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002695 /* If it was bad already, return success and do nothing */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 if (ret > 0)
2697 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01002698 return ret;
2699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002701 return chip->block_markbad(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702}
2703
2704/**
Huang Shijie7db03ec2012-09-13 14:57:52 +08002705 * nand_onfi_set_features- [REPLACEABLE] set features for ONFI nand
2706 * @mtd: MTD device structure
2707 * @chip: nand chip info structure
2708 * @addr: feature address.
2709 * @subfeature_param: the subfeature parameters, a four bytes array.
2710 */
2711static int nand_onfi_set_features(struct mtd_info *mtd, struct nand_chip *chip,
2712 int addr, uint8_t *subfeature_param)
2713{
2714 int status;
2715
2716 if (!chip->onfi_version)
2717 return -EINVAL;
2718
2719 chip->cmdfunc(mtd, NAND_CMD_SET_FEATURES, addr, -1);
2720 chip->write_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
2721 status = chip->waitfunc(mtd, chip);
2722 if (status & NAND_STATUS_FAIL)
2723 return -EIO;
2724 return 0;
2725}
2726
2727/**
2728 * nand_onfi_get_features- [REPLACEABLE] get features for ONFI nand
2729 * @mtd: MTD device structure
2730 * @chip: nand chip info structure
2731 * @addr: feature address.
2732 * @subfeature_param: the subfeature parameters, a four bytes array.
2733 */
2734static int nand_onfi_get_features(struct mtd_info *mtd, struct nand_chip *chip,
2735 int addr, uint8_t *subfeature_param)
2736{
2737 if (!chip->onfi_version)
2738 return -EINVAL;
2739
2740 /* clear the sub feature parameters */
2741 memset(subfeature_param, 0, ONFI_SUBFEATURE_PARAM_LEN);
2742
2743 chip->cmdfunc(mtd, NAND_CMD_GET_FEATURES, addr, -1);
2744 chip->read_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
2745 return 0;
2746}
2747
2748/**
Vitaly Wool962034f2005-09-15 14:58:53 +01002749 * nand_suspend - [MTD Interface] Suspend the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07002750 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01002751 */
2752static int nand_suspend(struct mtd_info *mtd)
2753{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002754 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002755
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002756 return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01002757}
2758
2759/**
2760 * nand_resume - [MTD Interface] Resume the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07002761 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01002762 */
2763static void nand_resume(struct mtd_info *mtd)
2764{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002765 struct nand_chip *chip = mtd->priv;
Vitaly Wool962034f2005-09-15 14:58:53 +01002766
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002767 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01002768 nand_release_device(mtd);
2769 else
Brian Norrisd0370212011-07-19 10:06:08 -07002770 pr_err("%s called for a chip which is not in suspended state\n",
2771 __func__);
Vitaly Wool962034f2005-09-15 14:58:53 +01002772}
2773
Brian Norris8b6e50c2011-05-25 14:59:01 -07002774/* Set default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002775static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002776{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002778 if (!chip->chip_delay)
2779 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780
2781 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002782 if (chip->cmdfunc == NULL)
2783 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784
2785 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002786 if (chip->waitfunc == NULL)
2787 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002789 if (!chip->select_chip)
2790 chip->select_chip = nand_select_chip;
2791 if (!chip->read_byte)
2792 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2793 if (!chip->read_word)
2794 chip->read_word = nand_read_word;
2795 if (!chip->block_bad)
2796 chip->block_bad = nand_block_bad;
2797 if (!chip->block_markbad)
2798 chip->block_markbad = nand_default_block_markbad;
2799 if (!chip->write_buf)
2800 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2801 if (!chip->read_buf)
2802 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002803 if (!chip->scan_bbt)
2804 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002805
2806 if (!chip->controller) {
2807 chip->controller = &chip->hwcontrol;
2808 spin_lock_init(&chip->controller->lock);
2809 init_waitqueue_head(&chip->controller->wq);
2810 }
2811
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02002812}
2813
Brian Norris8b6e50c2011-05-25 14:59:01 -07002814/* Sanitize ONFI strings so we can safely print them */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002815static void sanitize_string(uint8_t *s, size_t len)
2816{
2817 ssize_t i;
2818
Brian Norris8b6e50c2011-05-25 14:59:01 -07002819 /* Null terminate */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002820 s[len - 1] = 0;
2821
Brian Norris8b6e50c2011-05-25 14:59:01 -07002822 /* Remove non printable chars */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002823 for (i = 0; i < len - 1; i++) {
2824 if (s[i] < ' ' || s[i] > 127)
2825 s[i] = '?';
2826 }
2827
Brian Norris8b6e50c2011-05-25 14:59:01 -07002828 /* Remove trailing spaces */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02002829 strim(s);
2830}
2831
2832static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
2833{
2834 int i;
2835 while (len--) {
2836 crc ^= *p++ << 8;
2837 for (i = 0; i < 8; i++)
2838 crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
2839 }
2840
2841 return crc;
2842}
2843
2844/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07002845 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002846 */
2847static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002848 int *busw)
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002849{
2850 struct nand_onfi_params *p = &chip->onfi_params;
2851 int i;
2852 int val;
2853
Brian Norris7854d3f2011-06-23 14:12:08 -07002854 /* Try ONFI for unknown chip or LP */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002855 chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
2856 if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
2857 chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
2858 return 0;
2859
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002860 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
2861 for (i = 0; i < 3; i++) {
2862 chip->read_buf(mtd, (uint8_t *)p, sizeof(*p));
2863 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
2864 le16_to_cpu(p->crc)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07002865 pr_info("ONFI param page %d valid\n", i);
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002866 break;
2867 }
2868 }
2869
2870 if (i == 3)
2871 return 0;
2872
Brian Norris8b6e50c2011-05-25 14:59:01 -07002873 /* Check version */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002874 val = le16_to_cpu(p->revision);
Brian Norrisb7b1a292010-12-12 00:23:33 -08002875 if (val & (1 << 5))
2876 chip->onfi_version = 23;
2877 else if (val & (1 << 4))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002878 chip->onfi_version = 22;
2879 else if (val & (1 << 3))
2880 chip->onfi_version = 21;
2881 else if (val & (1 << 2))
2882 chip->onfi_version = 20;
Brian Norrisb7b1a292010-12-12 00:23:33 -08002883 else if (val & (1 << 1))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002884 chip->onfi_version = 10;
Brian Norrisb7b1a292010-12-12 00:23:33 -08002885 else
2886 chip->onfi_version = 0;
2887
2888 if (!chip->onfi_version) {
Brian Norrisd0370212011-07-19 10:06:08 -07002889 pr_info("%s: unsupported ONFI version: %d\n", __func__, val);
Brian Norrisb7b1a292010-12-12 00:23:33 -08002890 return 0;
2891 }
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002892
2893 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
2894 sanitize_string(p->model, sizeof(p->model));
2895 if (!mtd->name)
2896 mtd->name = p->model;
2897 mtd->writesize = le32_to_cpu(p->byte_per_page);
2898 mtd->erasesize = le32_to_cpu(p->pages_per_block) * mtd->writesize;
2899 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
Matthieu CASTET63795752012-03-19 15:35:25 +01002900 chip->chipsize = le32_to_cpu(p->blocks_per_lun);
2901 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002902 *busw = 0;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002903 if (le16_to_cpu(p->features) & 1)
Matthieu CASTET08c248f2011-06-26 18:26:55 +02002904 *busw = NAND_BUSWIDTH_16;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002905
Huang Shijied42b5de2012-02-17 11:22:37 +08002906 pr_info("ONFI flash detected\n");
Florian Fainelli6fb277b2010-09-01 22:28:59 +02002907 return 1;
2908}
2909
2910/*
Brian Norrise3b88bd2012-09-24 20:40:52 -07002911 * nand_id_has_period - Check if an ID string has a given wraparound period
2912 * @id_data: the ID string
2913 * @arrlen: the length of the @id_data array
2914 * @period: the period of repitition
2915 *
2916 * Check if an ID string is repeated within a given sequence of bytes at
2917 * specific repetition interval period (e.g., {0x20,0x01,0x7F,0x20} has a
2918 * period of 2). This is a helper function for nand_id_len(). Returns non-zero
2919 * if the repetition has a period of @period; otherwise, returns zero.
2920 */
2921static int nand_id_has_period(u8 *id_data, int arrlen, int period)
2922{
2923 int i, j;
2924 for (i = 0; i < period; i++)
2925 for (j = i + period; j < arrlen; j += period)
2926 if (id_data[i] != id_data[j])
2927 return 0;
2928 return 1;
2929}
2930
2931/*
2932 * nand_id_len - Get the length of an ID string returned by CMD_READID
2933 * @id_data: the ID string
2934 * @arrlen: the length of the @id_data array
2935
2936 * Returns the length of the ID string, according to known wraparound/trailing
2937 * zero patterns. If no pattern exists, returns the length of the array.
2938 */
2939static int nand_id_len(u8 *id_data, int arrlen)
2940{
2941 int last_nonzero, period;
2942
2943 /* Find last non-zero byte */
2944 for (last_nonzero = arrlen - 1; last_nonzero >= 0; last_nonzero--)
2945 if (id_data[last_nonzero])
2946 break;
2947
2948 /* All zeros */
2949 if (last_nonzero < 0)
2950 return 0;
2951
2952 /* Calculate wraparound period */
2953 for (period = 1; period < arrlen; period++)
2954 if (nand_id_has_period(id_data, arrlen, period))
2955 break;
2956
2957 /* There's a repeated pattern */
2958 if (period < arrlen)
2959 return period;
2960
2961 /* There are trailing zeros */
2962 if (last_nonzero < arrlen - 1)
2963 return last_nonzero + 1;
2964
2965 /* No pattern detected */
2966 return arrlen;
2967}
2968
2969/*
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002970 * Many new NAND share similar device ID codes, which represent the size of the
2971 * chip. The rest of the parameters must be decoded according to generic or
2972 * manufacturer-specific "extended ID" decoding patterns.
2973 */
2974static void nand_decode_ext_id(struct mtd_info *mtd, struct nand_chip *chip,
2975 u8 id_data[8], int *busw)
2976{
Brian Norrise3b88bd2012-09-24 20:40:52 -07002977 int extid, id_len;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002978 /* The 3rd id byte holds MLC / multichip data */
2979 chip->cellinfo = id_data[2];
2980 /* The 4th id byte is the important one */
2981 extid = id_data[3];
2982
Brian Norrise3b88bd2012-09-24 20:40:52 -07002983 id_len = nand_id_len(id_data, 8);
2984
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002985 /*
2986 * Field definitions are in the following datasheets:
2987 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
Brian Norrisaf451af2012-10-09 23:26:06 -07002988 * New Samsung (6 byte ID): Samsung K9GAG08U0F (p.44)
Brian Norris73ca3922012-09-24 20:40:54 -07002989 * Hynix MLC (6 byte ID): Hynix H27UBG8T2B (p.22)
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002990 *
Brian Norrisaf451af2012-10-09 23:26:06 -07002991 * Check for ID length, non-zero 6th byte, cell type, and Hynix/Samsung
2992 * ID to decide what to do.
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002993 */
Brian Norrisaf451af2012-10-09 23:26:06 -07002994 if (id_len == 6 && id_data[0] == NAND_MFR_SAMSUNG &&
Brian Norris6924d992012-11-14 21:46:30 -08002995 (chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
Brian Norrisaf451af2012-10-09 23:26:06 -07002996 id_data[5] != 0x00) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07002997 /* Calc pagesize */
2998 mtd->writesize = 2048 << (extid & 0x03);
2999 extid >>= 2;
3000 /* Calc oobsize */
Brian Norrise2d3a352012-09-24 20:40:55 -07003001 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003002 case 1:
3003 mtd->oobsize = 128;
3004 break;
3005 case 2:
3006 mtd->oobsize = 218;
3007 break;
3008 case 3:
3009 mtd->oobsize = 400;
3010 break;
Brian Norrise2d3a352012-09-24 20:40:55 -07003011 case 4:
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003012 mtd->oobsize = 436;
3013 break;
Brian Norrise2d3a352012-09-24 20:40:55 -07003014 case 5:
3015 mtd->oobsize = 512;
3016 break;
3017 case 6:
3018 default: /* Other cases are "reserved" (unknown) */
3019 mtd->oobsize = 640;
3020 break;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003021 }
3022 extid >>= 2;
3023 /* Calc blocksize */
3024 mtd->erasesize = (128 * 1024) <<
3025 (((extid >> 1) & 0x04) | (extid & 0x03));
3026 *busw = 0;
Brian Norris73ca3922012-09-24 20:40:54 -07003027 } else if (id_len == 6 && id_data[0] == NAND_MFR_HYNIX &&
3028 (chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
3029 unsigned int tmp;
3030
3031 /* Calc pagesize */
3032 mtd->writesize = 2048 << (extid & 0x03);
3033 extid >>= 2;
3034 /* Calc oobsize */
3035 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3036 case 0:
3037 mtd->oobsize = 128;
3038 break;
3039 case 1:
3040 mtd->oobsize = 224;
3041 break;
3042 case 2:
3043 mtd->oobsize = 448;
3044 break;
3045 case 3:
3046 mtd->oobsize = 64;
3047 break;
3048 case 4:
3049 mtd->oobsize = 32;
3050 break;
3051 case 5:
3052 mtd->oobsize = 16;
3053 break;
3054 default:
3055 mtd->oobsize = 640;
3056 break;
3057 }
3058 extid >>= 2;
3059 /* Calc blocksize */
3060 tmp = ((extid >> 1) & 0x04) | (extid & 0x03);
3061 if (tmp < 0x03)
3062 mtd->erasesize = (128 * 1024) << tmp;
3063 else if (tmp == 0x03)
3064 mtd->erasesize = 768 * 1024;
3065 else
3066 mtd->erasesize = (64 * 1024) << tmp;
3067 *busw = 0;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003068 } else {
3069 /* Calc pagesize */
3070 mtd->writesize = 1024 << (extid & 0x03);
3071 extid >>= 2;
3072 /* Calc oobsize */
3073 mtd->oobsize = (8 << (extid & 0x01)) *
3074 (mtd->writesize >> 9);
3075 extid >>= 2;
3076 /* Calc blocksize. Blocksize is multiples of 64KiB */
3077 mtd->erasesize = (64 * 1024) << (extid & 0x03);
3078 extid >>= 2;
3079 /* Get buswidth information */
3080 *busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
3081 }
3082}
3083
3084/*
Brian Norrisf23a4812012-09-24 20:40:51 -07003085 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
3086 * decodes a matching ID table entry and assigns the MTD size parameters for
3087 * the chip.
3088 */
3089static void nand_decode_id(struct mtd_info *mtd, struct nand_chip *chip,
3090 struct nand_flash_dev *type, u8 id_data[8],
3091 int *busw)
3092{
3093 int maf_id = id_data[0];
3094
3095 mtd->erasesize = type->erasesize;
3096 mtd->writesize = type->pagesize;
3097 mtd->oobsize = mtd->writesize / 32;
3098 *busw = type->options & NAND_BUSWIDTH_16;
3099
3100 /*
3101 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
3102 * some Spansion chips have erasesize that conflicts with size
3103 * listed in nand_ids table.
3104 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
3105 */
3106 if (maf_id == NAND_MFR_AMD && id_data[4] != 0x00 && id_data[5] == 0x00
3107 && id_data[6] == 0x00 && id_data[7] == 0x00
3108 && mtd->writesize == 512) {
3109 mtd->erasesize = 128 * 1024;
3110 mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
3111 }
3112}
3113
3114/*
Brian Norris7e74c2d2012-09-24 20:40:49 -07003115 * Set the bad block marker/indicator (BBM/BBI) patterns according to some
3116 * heuristic patterns using various detected parameters (e.g., manufacturer,
3117 * page size, cell-type information).
3118 */
3119static void nand_decode_bbm_options(struct mtd_info *mtd,
3120 struct nand_chip *chip, u8 id_data[8])
3121{
3122 int maf_id = id_data[0];
3123
3124 /* Set the bad block position */
3125 if (mtd->writesize > 512 || (chip->options & NAND_BUSWIDTH_16))
3126 chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
3127 else
3128 chip->badblockpos = NAND_SMALL_BADBLOCK_POS;
3129
3130 /*
3131 * Bad block marker is stored in the last page of each block on Samsung
3132 * and Hynix MLC devices; stored in first two pages of each block on
3133 * Micron devices with 2KiB pages and on SLC Samsung, Hynix, Toshiba,
3134 * AMD/Spansion, and Macronix. All others scan only the first page.
3135 */
3136 if ((chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
3137 (maf_id == NAND_MFR_SAMSUNG ||
3138 maf_id == NAND_MFR_HYNIX))
3139 chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
3140 else if ((!(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
3141 (maf_id == NAND_MFR_SAMSUNG ||
3142 maf_id == NAND_MFR_HYNIX ||
3143 maf_id == NAND_MFR_TOSHIBA ||
3144 maf_id == NAND_MFR_AMD ||
3145 maf_id == NAND_MFR_MACRONIX)) ||
3146 (mtd->writesize == 2048 &&
3147 maf_id == NAND_MFR_MICRON))
3148 chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
3149}
3150
3151/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003152 * Get the flash and manufacturer id and lookup if the type is supported.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003153 */
3154static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003155 struct nand_chip *chip,
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003156 int busw,
3157 int *maf_id, int *dev_id,
David Woodhouse5e81e882010-02-26 18:32:56 +00003158 struct nand_flash_dev *type)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003159{
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003160 int i, maf_idx;
Kevin Cernekee426c4572010-05-04 20:58:03 -07003161 u8 id_data[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162
3163 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003164 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165
Karl Beldanef89a882008-09-15 14:37:29 +02003166 /*
3167 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
Brian Norris8b6e50c2011-05-25 14:59:01 -07003168 * after power-up.
Karl Beldanef89a882008-09-15 14:37:29 +02003169 */
3170 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
3171
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003173 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
3175 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003176 *maf_id = chip->read_byte(mtd);
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003177 *dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178
Brian Norris8b6e50c2011-05-25 14:59:01 -07003179 /*
3180 * Try again to make sure, as some systems the bus-hold or other
Ben Dooksed8165c2008-04-14 14:58:58 +01003181 * interface concerns can cause random data which looks like a
3182 * possibly credible NAND flash to appear. If the two results do
3183 * not match, ignore the device completely.
3184 */
3185
3186 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
3187
Brian Norris4aef9b72012-09-24 20:40:48 -07003188 /* Read entire ID string */
3189 for (i = 0; i < 8; i++)
Kevin Cernekee426c4572010-05-04 20:58:03 -07003190 id_data[i] = chip->read_byte(mtd);
Ben Dooksed8165c2008-04-14 14:58:58 +01003191
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003192 if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003193 pr_info("%s: second ID read did not match "
Brian Norrisd0370212011-07-19 10:06:08 -07003194 "%02x,%02x against %02x,%02x\n", __func__,
3195 *maf_id, *dev_id, id_data[0], id_data[1]);
Ben Dooksed8165c2008-04-14 14:58:58 +01003196 return ERR_PTR(-ENODEV);
3197 }
3198
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003199 if (!type)
David Woodhouse5e81e882010-02-26 18:32:56 +00003200 type = nand_flash_ids;
3201
3202 for (; type->name != NULL; type++)
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003203 if (*dev_id == type->id)
Florian Fainellif8ac0412010-09-07 13:23:43 +02003204 break;
David Woodhouse5e81e882010-02-26 18:32:56 +00003205
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003206 chip->onfi_version = 0;
3207 if (!type->name || !type->pagesize) {
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003208 /* Check is chip is ONFI compliant */
Brian Norris47450b32012-09-24 20:40:47 -07003209 if (nand_flash_detect_onfi(mtd, chip, &busw))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003210 goto ident_done;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003211 }
3212
David Woodhouse5e81e882010-02-26 18:32:56 +00003213 if (!type->name)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003214 return ERR_PTR(-ENODEV);
3215
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02003216 if (!mtd->name)
3217 mtd->name = type->name;
3218
Adrian Hunter69423d92008-12-10 13:37:21 +00003219 chip->chipsize = (uint64_t)type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003220
Huang Shijie12a40a52010-09-27 10:43:53 +08003221 if (!type->pagesize && chip->init_size) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07003222 /* Set the pagesize, oobsize, erasesize by the driver */
Huang Shijie12a40a52010-09-27 10:43:53 +08003223 busw = chip->init_size(mtd, chip, id_data);
3224 } else if (!type->pagesize) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003225 /* Decode parameters from extended ID */
3226 nand_decode_ext_id(mtd, chip, id_data, &busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003227 } else {
Brian Norrisf23a4812012-09-24 20:40:51 -07003228 nand_decode_id(mtd, chip, type, id_data, &busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003229 }
Brian Norrisbf7a01b2012-07-13 09:28:24 -07003230 /* Get chip options */
3231 chip->options |= type->options;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003232
Brian Norris8b6e50c2011-05-25 14:59:01 -07003233 /*
3234 * Check if chip is not a Samsung device. Do not clear the
3235 * options for chips which do not have an extended id.
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003236 */
3237 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
3238 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
3239ident_done:
3240
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003241 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01003242 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003243 if (nand_manuf_ids[maf_idx].id == *maf_id)
3244 break;
3245 }
3246
3247 /*
3248 * Check, if buswidth is correct. Hardware drivers should set
Brian Norris8b6e50c2011-05-25 14:59:01 -07003249 * chip correct!
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003250 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003251 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003252 pr_info("NAND device: Manufacturer ID:"
Brian Norrisd0370212011-07-19 10:06:08 -07003253 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
3254 *dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
Brian Norris9a4d4d62011-07-19 10:06:07 -07003255 pr_warn("NAND bus width %d instead %d bit\n",
Brian Norrisd0370212011-07-19 10:06:08 -07003256 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
3257 busw ? 16 : 8);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003258 return ERR_PTR(-EINVAL);
3259 }
3260
Brian Norris7e74c2d2012-09-24 20:40:49 -07003261 nand_decode_bbm_options(mtd, chip, id_data);
3262
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003263 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003264 chip->page_shift = ffs(mtd->writesize) - 1;
Brian Norris8b6e50c2011-05-25 14:59:01 -07003265 /* Convert chipsize to number of pages per chip -1 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003266 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003267
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003268 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003269 ffs(mtd->erasesize) - 1;
Adrian Hunter69423d92008-12-10 13:37:21 +00003270 if (chip->chipsize & 0xffffffff)
3271 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003272 else {
3273 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
3274 chip->chip_shift += 32 - 1;
3275 }
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003276
Artem Bityutskiy26d9be12011-04-28 20:26:59 +03003277 chip->badblockbits = 8;
3278
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003279 /* Check for AND chips with 4 page planes */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003280 if (chip->options & NAND_4PAGE_ARRAY)
3281 chip->erase_cmd = multi_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003282 else
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003283 chip->erase_cmd = single_erase_cmd;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003284
Brian Norris8b6e50c2011-05-25 14:59:01 -07003285 /* Do not replace user supplied command function! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003286 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3287 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003288
Huang Shijie886bd332012-04-09 11:41:37 +08003289 pr_info("NAND device: Manufacturer ID: 0x%02x, Chip ID: 0x%02x (%s %s),"
3290 " page size: %d, OOB size: %d\n",
3291 *maf_id, *dev_id, nand_manuf_ids[maf_idx].name,
3292 chip->onfi_version ? chip->onfi_params.model : type->name,
3293 mtd->writesize, mtd->oobsize);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003294
3295 return type;
3296}
3297
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003298/**
David Woodhouse3b85c322006-09-25 17:06:53 +01003299 * nand_scan_ident - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003300 * @mtd: MTD device structure
3301 * @maxchips: number of chips to scan for
3302 * @table: alternative NAND ID table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003303 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003304 * This is the first phase of the normal nand_scan() function. It reads the
3305 * flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003306 *
David Woodhouse3b85c322006-09-25 17:06:53 +01003307 * The mtd->owner field must be set to the module of the caller.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003308 */
David Woodhouse5e81e882010-02-26 18:32:56 +00003309int nand_scan_ident(struct mtd_info *mtd, int maxchips,
3310 struct nand_flash_dev *table)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003311{
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003312 int i, busw, nand_maf_id, nand_dev_id;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003313 struct nand_chip *chip = mtd->priv;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003314 struct nand_flash_dev *type;
3315
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003316 /* Get buswidth to select the correct functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003317 busw = chip->options & NAND_BUSWIDTH_16;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003318 /* Set the default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003319 nand_set_defaults(chip, busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003320
3321 /* Read the flash type */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003322 type = nand_get_flash_type(mtd, chip, busw,
3323 &nand_maf_id, &nand_dev_id, table);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003324
3325 if (IS_ERR(type)) {
Ben Dooksb1c6e6d2009-11-02 18:12:33 +00003326 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
Brian Norrisd0370212011-07-19 10:06:08 -07003327 pr_warn("No NAND device found\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003328 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003329 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 }
3331
Huang Shijie07300162012-11-09 16:23:45 +08003332 chip->select_chip(mtd, -1);
3333
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003334 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01003335 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003336 chip->select_chip(mtd, i);
Karl Beldanef89a882008-09-15 14:37:29 +02003337 /* See comment in nand_get_flash_type for reset */
3338 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003340 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003341 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003342 if (nand_maf_id != chip->read_byte(mtd) ||
Huang Shijie07300162012-11-09 16:23:45 +08003343 nand_dev_id != chip->read_byte(mtd)) {
3344 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345 break;
Huang Shijie07300162012-11-09 16:23:45 +08003346 }
3347 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348 }
3349 if (i > 1)
Brian Norris9a4d4d62011-07-19 10:06:07 -07003350 pr_info("%d NAND chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003351
Linus Torvalds1da177e2005-04-16 15:20:36 -07003352 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003353 chip->numchips = i;
3354 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003355
David Woodhouse3b85c322006-09-25 17:06:53 +01003356 return 0;
3357}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003358EXPORT_SYMBOL(nand_scan_ident);
David Woodhouse3b85c322006-09-25 17:06:53 +01003359
3360
3361/**
3362 * nand_scan_tail - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003363 * @mtd: MTD device structure
David Woodhouse3b85c322006-09-25 17:06:53 +01003364 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003365 * This is the second phase of the normal nand_scan() function. It fills out
3366 * all the uninitialized function pointers with the defaults and scans for a
3367 * bad block table if appropriate.
David Woodhouse3b85c322006-09-25 17:06:53 +01003368 */
3369int nand_scan_tail(struct mtd_info *mtd)
3370{
3371 int i;
3372 struct nand_chip *chip = mtd->priv;
3373
Brian Norrise2414f42012-02-06 13:44:00 -08003374 /* New bad blocks should be marked in OOB, flash-based BBT, or both */
3375 BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
3376 !(chip->bbt_options & NAND_BBT_USE_FLASH));
3377
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003378 if (!(chip->options & NAND_OWN_BUFFERS))
3379 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
3380 if (!chip->buffers)
3381 return -ENOMEM;
3382
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01003383 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01003384 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003385
3386 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003387 * If no default placement scheme is given, select an appropriate one.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003388 */
Ivan Djelic193bd402011-03-11 11:05:33 +01003389 if (!chip->ecc.layout && (chip->ecc.mode != NAND_ECC_SOFT_BCH)) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003390 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003391 case 8:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003392 chip->ecc.layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393 break;
3394 case 16:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003395 chip->ecc.layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003396 break;
3397 case 64:
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003398 chip->ecc.layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399 break;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003400 case 128:
3401 chip->ecc.layout = &nand_oob_128;
3402 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003403 default:
Brian Norrisd0370212011-07-19 10:06:08 -07003404 pr_warn("No oob scheme defined for oobsize %d\n",
3405 mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 BUG();
3407 }
3408 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003409
David Woodhouse956e9442006-09-25 17:12:39 +01003410 if (!chip->write_page)
3411 chip->write_page = nand_write_page;
3412
Huang Shijie7db03ec2012-09-13 14:57:52 +08003413 /* set for ONFI nand */
3414 if (!chip->onfi_set_features)
3415 chip->onfi_set_features = nand_onfi_set_features;
3416 if (!chip->onfi_get_features)
3417 chip->onfi_get_features = nand_onfi_get_features;
3418
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003419 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003420 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003421 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01003422 */
David Woodhouse956e9442006-09-25 17:12:39 +01003423
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003424 switch (chip->ecc.mode) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003425 case NAND_ECC_HW_OOB_FIRST:
3426 /* Similar to NAND_ECC_HW, but a separate read_page handle */
3427 if (!chip->ecc.calculate || !chip->ecc.correct ||
3428 !chip->ecc.hwctl) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003429 pr_warn("No ECC functions supplied; "
Brian Norrisd0370212011-07-19 10:06:08 -07003430 "hardware ECC not possible\n");
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07003431 BUG();
3432 }
3433 if (!chip->ecc.read_page)
3434 chip->ecc.read_page = nand_read_page_hwecc_oob_first;
3435
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003436 case NAND_ECC_HW:
Brian Norris8b6e50c2011-05-25 14:59:01 -07003437 /* Use standard hwecc read page function? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003438 if (!chip->ecc.read_page)
3439 chip->ecc.read_page = nand_read_page_hwecc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003440 if (!chip->ecc.write_page)
3441 chip->ecc.write_page = nand_write_page_hwecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003442 if (!chip->ecc.read_page_raw)
3443 chip->ecc.read_page_raw = nand_read_page_raw;
3444 if (!chip->ecc.write_page_raw)
3445 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003446 if (!chip->ecc.read_oob)
3447 chip->ecc.read_oob = nand_read_oob_std;
3448 if (!chip->ecc.write_oob)
3449 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003450
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003451 case NAND_ECC_HW_SYNDROME:
Scott Wood78b65172007-12-13 11:15:28 -06003452 if ((!chip->ecc.calculate || !chip->ecc.correct ||
3453 !chip->ecc.hwctl) &&
3454 (!chip->ecc.read_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003455 chip->ecc.read_page == nand_read_page_hwecc ||
Scott Wood78b65172007-12-13 11:15:28 -06003456 !chip->ecc.write_page ||
Scott Wood1c45f602008-01-16 10:36:03 -06003457 chip->ecc.write_page == nand_write_page_hwecc)) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003458 pr_warn("No ECC functions supplied; "
Brian Norrisd0370212011-07-19 10:06:08 -07003459 "hardware ECC not possible\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003460 BUG();
3461 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07003462 /* Use standard syndrome read/write page function? */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003463 if (!chip->ecc.read_page)
3464 chip->ecc.read_page = nand_read_page_syndrome;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003465 if (!chip->ecc.write_page)
3466 chip->ecc.write_page = nand_write_page_syndrome;
David Brownell52ff49d2009-03-04 12:01:36 -08003467 if (!chip->ecc.read_page_raw)
3468 chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
3469 if (!chip->ecc.write_page_raw)
3470 chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003471 if (!chip->ecc.read_oob)
3472 chip->ecc.read_oob = nand_read_oob_syndrome;
3473 if (!chip->ecc.write_oob)
3474 chip->ecc.write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003475
Mike Dunne2788c92012-04-25 12:06:10 -07003476 if (mtd->writesize >= chip->ecc.size) {
3477 if (!chip->ecc.strength) {
3478 pr_warn("Driver must set ecc.strength when using hardware ECC\n");
3479 BUG();
3480 }
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003481 break;
Mike Dunne2788c92012-04-25 12:06:10 -07003482 }
Brian Norris9a4d4d62011-07-19 10:06:07 -07003483 pr_warn("%d byte HW ECC not possible on "
Brian Norrisd0370212011-07-19 10:06:08 -07003484 "%d byte page size, fallback to SW ECC\n",
3485 chip->ecc.size, mtd->writesize);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003486 chip->ecc.mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003488 case NAND_ECC_SOFT:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003489 chip->ecc.calculate = nand_calculate_ecc;
3490 chip->ecc.correct = nand_correct_data;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003491 chip->ecc.read_page = nand_read_page_swecc;
Alexey Korolev3d459552008-05-15 17:23:18 +01003492 chip->ecc.read_subpage = nand_read_subpage;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003493 chip->ecc.write_page = nand_write_page_swecc;
David Brownell52ff49d2009-03-04 12:01:36 -08003494 chip->ecc.read_page_raw = nand_read_page_raw;
3495 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003496 chip->ecc.read_oob = nand_read_oob_std;
3497 chip->ecc.write_oob = nand_write_oob_std;
Singh, Vimal9a732902008-12-12 00:10:57 +00003498 if (!chip->ecc.size)
3499 chip->ecc.size = 256;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003500 chip->ecc.bytes = 3;
Mike Dunn6a918ba2012-03-11 14:21:11 -07003501 chip->ecc.strength = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003503
Ivan Djelic193bd402011-03-11 11:05:33 +01003504 case NAND_ECC_SOFT_BCH:
3505 if (!mtd_nand_has_bch()) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003506 pr_warn("CONFIG_MTD_ECC_BCH not enabled\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01003507 BUG();
3508 }
3509 chip->ecc.calculate = nand_bch_calculate_ecc;
3510 chip->ecc.correct = nand_bch_correct_data;
3511 chip->ecc.read_page = nand_read_page_swecc;
3512 chip->ecc.read_subpage = nand_read_subpage;
3513 chip->ecc.write_page = nand_write_page_swecc;
3514 chip->ecc.read_page_raw = nand_read_page_raw;
3515 chip->ecc.write_page_raw = nand_write_page_raw;
3516 chip->ecc.read_oob = nand_read_oob_std;
3517 chip->ecc.write_oob = nand_write_oob_std;
3518 /*
3519 * Board driver should supply ecc.size and ecc.bytes values to
3520 * select how many bits are correctable; see nand_bch_init()
Brian Norris8b6e50c2011-05-25 14:59:01 -07003521 * for details. Otherwise, default to 4 bits for large page
3522 * devices.
Ivan Djelic193bd402011-03-11 11:05:33 +01003523 */
3524 if (!chip->ecc.size && (mtd->oobsize >= 64)) {
3525 chip->ecc.size = 512;
3526 chip->ecc.bytes = 7;
3527 }
3528 chip->ecc.priv = nand_bch_init(mtd,
3529 chip->ecc.size,
3530 chip->ecc.bytes,
3531 &chip->ecc.layout);
3532 if (!chip->ecc.priv) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003533 pr_warn("BCH ECC initialization failed!\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01003534 BUG();
3535 }
Mike Dunn6a918ba2012-03-11 14:21:11 -07003536 chip->ecc.strength =
Mike Dunne2788c92012-04-25 12:06:10 -07003537 chip->ecc.bytes * 8 / fls(8 * chip->ecc.size);
Ivan Djelic193bd402011-03-11 11:05:33 +01003538 break;
3539
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003540 case NAND_ECC_NONE:
Brian Norris9a4d4d62011-07-19 10:06:07 -07003541 pr_warn("NAND_ECC_NONE selected by board driver. "
Brian Norrisd0370212011-07-19 10:06:08 -07003542 "This is not recommended!\n");
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02003543 chip->ecc.read_page = nand_read_page_raw;
3544 chip->ecc.write_page = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003545 chip->ecc.read_oob = nand_read_oob_std;
David Brownell52ff49d2009-03-04 12:01:36 -08003546 chip->ecc.read_page_raw = nand_read_page_raw;
3547 chip->ecc.write_page_raw = nand_write_page_raw;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02003548 chip->ecc.write_oob = nand_write_oob_std;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003549 chip->ecc.size = mtd->writesize;
3550 chip->ecc.bytes = 0;
Mike Dunn6a918ba2012-03-11 14:21:11 -07003551 chip->ecc.strength = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552 break;
David Woodhouse956e9442006-09-25 17:12:39 +01003553
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554 default:
Brian Norrisd0370212011-07-19 10:06:08 -07003555 pr_warn("Invalid NAND_ECC_MODE %d\n", chip->ecc.mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003556 BUG();
3557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003558
Brian Norris9ce244b2011-08-30 18:45:37 -07003559 /* For many systems, the standard OOB write also works for raw */
Brian Norrisc46f6482011-08-30 18:45:38 -07003560 if (!chip->ecc.read_oob_raw)
3561 chip->ecc.read_oob_raw = chip->ecc.read_oob;
Brian Norris9ce244b2011-08-30 18:45:37 -07003562 if (!chip->ecc.write_oob_raw)
3563 chip->ecc.write_oob_raw = chip->ecc.write_oob;
3564
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003565 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003566 * The number of bytes available for a client to place data into
Brian Norris8b6e50c2011-05-25 14:59:01 -07003567 * the out of band area.
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003568 */
3569 chip->ecc.layout->oobavail = 0;
David Brownell81d19b02009-04-21 19:51:20 -07003570 for (i = 0; chip->ecc.layout->oobfree[i].length
3571 && i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003572 chip->ecc.layout->oobavail +=
3573 chip->ecc.layout->oobfree[i].length;
Vitaly Wool1f922672007-03-06 16:56:34 +03003574 mtd->oobavail = chip->ecc.layout->oobavail;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003575
3576 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003577 * Set the number of read / write steps for one page depending on ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07003578 * mode.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003579 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003580 chip->ecc.steps = mtd->writesize / chip->ecc.size;
Florian Fainellif8ac0412010-09-07 13:23:43 +02003581 if (chip->ecc.steps * chip->ecc.size != mtd->writesize) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07003582 pr_warn("Invalid ECC parameters\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02003583 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003584 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02003585 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003586
Brian Norris8b6e50c2011-05-25 14:59:01 -07003587 /* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
Thomas Gleixner29072b92006-09-28 15:38:36 +02003588 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
3589 !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
Florian Fainellif8ac0412010-09-07 13:23:43 +02003590 switch (chip->ecc.steps) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02003591 case 2:
3592 mtd->subpage_sft = 1;
3593 break;
3594 case 4:
3595 case 8:
Thomas Gleixner81ec5362007-12-12 17:27:03 +01003596 case 16:
Thomas Gleixner29072b92006-09-28 15:38:36 +02003597 mtd->subpage_sft = 2;
3598 break;
3599 }
3600 }
3601 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
3602
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02003603 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003604 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605
Linus Torvalds1da177e2005-04-16 15:20:36 -07003606 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003607 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05003609 /* Large page NAND with SOFT_ECC should support subpage reads */
3610 if ((chip->ecc.mode == NAND_ECC_SOFT) && (chip->page_shift > 9))
3611 chip->options |= NAND_SUBPAGE_READ;
3612
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613 /* Fill in remaining MTD driver data */
3614 mtd->type = MTD_NANDFLASH;
Maxim Levitsky93edbad2010-02-22 20:39:40 +02003615 mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
3616 MTD_CAP_NANDFLASH;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02003617 mtd->_erase = nand_erase;
3618 mtd->_point = NULL;
3619 mtd->_unpoint = NULL;
3620 mtd->_read = nand_read;
3621 mtd->_write = nand_write;
3622 mtd->_panic_write = panic_nand_write;
3623 mtd->_read_oob = nand_read_oob;
3624 mtd->_write_oob = nand_write_oob;
3625 mtd->_sync = nand_sync;
3626 mtd->_lock = NULL;
3627 mtd->_unlock = NULL;
3628 mtd->_suspend = nand_suspend;
3629 mtd->_resume = nand_resume;
3630 mtd->_block_isbad = nand_block_isbad;
3631 mtd->_block_markbad = nand_block_markbad;
Anatolij Gustschincbcab652010-12-16 23:42:16 +01003632 mtd->writebufsize = mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003633
Mike Dunn6a918ba2012-03-11 14:21:11 -07003634 /* propagate ecc info to mtd_info */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02003635 mtd->ecclayout = chip->ecc.layout;
Mike Dunn86c20722012-04-25 12:06:05 -07003636 mtd->ecc_strength = chip->ecc.strength;
Shmulik Ladkaniea3b2ea2012-06-08 18:29:06 +03003637 /*
3638 * Initialize bitflip_threshold to its default prior scan_bbt() call.
3639 * scan_bbt() might invoke mtd_read(), thus bitflip_threshold must be
3640 * properly set.
3641 */
3642 if (!mtd->bitflip_threshold)
3643 mtd->bitflip_threshold = mtd->ecc_strength;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003644
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003645 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003646 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00003647 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648
3649 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003650 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003652EXPORT_SYMBOL(nand_scan_tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003653
Brian Norris8b6e50c2011-05-25 14:59:01 -07003654/*
3655 * is_module_text_address() isn't exported, and it's mostly a pointless
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003656 * test if this is a module _anyway_ -- they'd have to try _really_ hard
Brian Norris8b6e50c2011-05-25 14:59:01 -07003657 * to call us from in-kernel code if the core NAND support is modular.
3658 */
David Woodhouse3b85c322006-09-25 17:06:53 +01003659#ifdef MODULE
3660#define caller_is_module() (1)
3661#else
3662#define caller_is_module() \
Rusty Russella6e6abd2009-03-31 13:05:31 -06003663 is_module_text_address((unsigned long)__builtin_return_address(0))
David Woodhouse3b85c322006-09-25 17:06:53 +01003664#endif
3665
3666/**
3667 * nand_scan - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003668 * @mtd: MTD device structure
3669 * @maxchips: number of chips to scan for
David Woodhouse3b85c322006-09-25 17:06:53 +01003670 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003671 * This fills out all the uninitialized function pointers with the defaults.
3672 * The flash ID is read and the mtd/chip structures are filled with the
3673 * appropriate values. The mtd->owner field must be set to the module of the
3674 * caller.
David Woodhouse3b85c322006-09-25 17:06:53 +01003675 */
3676int nand_scan(struct mtd_info *mtd, int maxchips)
3677{
3678 int ret;
3679
3680 /* Many callers got this wrong, so check for it for a while... */
3681 if (!mtd->owner && caller_is_module()) {
Brian Norrisd0370212011-07-19 10:06:08 -07003682 pr_crit("%s called with NULL mtd->owner!\n", __func__);
David Woodhouse3b85c322006-09-25 17:06:53 +01003683 BUG();
3684 }
3685
David Woodhouse5e81e882010-02-26 18:32:56 +00003686 ret = nand_scan_ident(mtd, maxchips, NULL);
David Woodhouse3b85c322006-09-25 17:06:53 +01003687 if (!ret)
3688 ret = nand_scan_tail(mtd);
3689 return ret;
3690}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003691EXPORT_SYMBOL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01003692
Linus Torvalds1da177e2005-04-16 15:20:36 -07003693/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00003694 * nand_release - [NAND Interface] Free resources held by the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07003695 * @mtd: MTD device structure
3696 */
David Woodhousee0c7d762006-05-13 18:07:53 +01003697void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003698{
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003699 struct nand_chip *chip = mtd->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003700
Ivan Djelic193bd402011-03-11 11:05:33 +01003701 if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
3702 nand_bch_free((struct nand_bch_control *)chip->ecc.priv);
3703
Jamie Iles5ffcaf32011-05-23 10:22:46 +01003704 mtd_device_unregister(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003705
Jesper Juhlfa671642005-11-07 01:01:27 -08003706 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003707 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01003708 if (!(chip->options & NAND_OWN_BUFFERS))
3709 kfree(chip->buffers);
Brian Norris58373ff2010-07-15 12:15:44 -07003710
3711 /* Free bad block descriptor memory */
3712 if (chip->badblock_pattern && chip->badblock_pattern->options
3713 & NAND_BBT_DYNAMICSTRUCT)
3714 kfree(chip->badblock_pattern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003715}
David Woodhousee0c7d762006-05-13 18:07:53 +01003716EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08003717
3718static int __init nand_base_init(void)
3719{
3720 led_trigger_register_simple("nand-disk", &nand_led_trigger);
3721 return 0;
3722}
3723
3724static void __exit nand_base_exit(void)
3725{
3726 led_trigger_unregister_simple(nand_led_trigger);
3727}
3728
3729module_init(nand_base_init);
3730module_exit(nand_base_exit);
3731
David Woodhousee0c7d762006-05-13 18:07:53 +01003732MODULE_LICENSE("GPL");
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003733MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
3734MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
David Woodhousee0c7d762006-05-13 18:07:53 +01003735MODULE_DESCRIPTION("Generic NAND flash driver code");