blob: 557b8462f55ed6f46961d2201affedd2c2746401 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Overview:
3 * This is the generic MTD driver for NAND flash devices. It should be
4 * capable of working with almost all NAND chips currently available.
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00005 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Additional technical information is available on
maximilian attems8b2b4032007-07-28 13:07:16 +02007 * http://www.linux-mtd.infradead.org/doc/nand.html
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00008 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020010 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020012 * Credits:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +000013 * David Woodhouse for adding multichip support
14 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
16 * rework for 2K page size chips
17 *
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +020018 * TODO:
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * Enable cached programming for 2k page size chips
20 * Check, if mtd->ecctype should be set to MTD_ECC_HW
Brian Norris7854d3f2011-06-23 14:12:08 -070021 * if we have HW ECC support.
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +030022 * BBT table is not serialized, has to be fixed
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License version 2 as
26 * published by the Free Software Foundation.
27 *
28 */
29
Ezequiel Garcia20171642013-11-25 08:30:31 -030030#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
David Woodhouse552d9202006-05-14 01:20:46 +010032#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/delay.h>
34#include <linux/errno.h>
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +020035#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sched.h>
37#include <linux/slab.h>
Kamal Dasu66507c72014-05-01 20:51:19 -040038#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/types.h>
40#include <linux/mtd/mtd.h>
41#include <linux/mtd/nand.h>
42#include <linux/mtd/nand_ecc.h>
Ivan Djelic193bd402011-03-11 11:05:33 +010043#include <linux/mtd/nand_bch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/interrupt.h>
45#include <linux/bitops.h>
Richard Purdie8fe833c2006-03-31 02:31:14 -080046#include <linux/leds.h>
Florian Fainelli7351d3a2010-09-07 13:23:45 +020047#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/mtd/partitions.h>
Brian Norris5844fee2015-01-23 00:22:27 -080049#include <linux/of_mtd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51/* Define default oob placement schemes for large and small page devices */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020052static struct nand_ecclayout nand_oob_8 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 .eccbytes = 3,
54 .eccpos = {0, 1, 2},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020055 .oobfree = {
56 {.offset = 3,
57 .length = 2},
58 {.offset = 6,
Florian Fainellif8ac0412010-09-07 13:23:43 +020059 .length = 2} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070060};
61
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020062static struct nand_ecclayout nand_oob_16 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 .eccbytes = 6,
64 .eccpos = {0, 1, 2, 3, 6, 7},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020065 .oobfree = {
66 {.offset = 8,
Florian Fainellif8ac0412010-09-07 13:23:43 +020067 . length = 8} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020070static struct nand_ecclayout nand_oob_64 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 .eccbytes = 24,
72 .eccpos = {
David Woodhousee0c7d762006-05-13 18:07:53 +010073 40, 41, 42, 43, 44, 45, 46, 47,
74 48, 49, 50, 51, 52, 53, 54, 55,
75 56, 57, 58, 59, 60, 61, 62, 63},
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020076 .oobfree = {
77 {.offset = 2,
Florian Fainellif8ac0412010-09-07 13:23:43 +020078 .length = 38} }
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
Thomas Gleixner81ec5362007-12-12 17:27:03 +010081static struct nand_ecclayout nand_oob_128 = {
82 .eccbytes = 48,
83 .eccpos = {
84 80, 81, 82, 83, 84, 85, 86, 87,
85 88, 89, 90, 91, 92, 93, 94, 95,
86 96, 97, 98, 99, 100, 101, 102, 103,
87 104, 105, 106, 107, 108, 109, 110, 111,
88 112, 113, 114, 115, 116, 117, 118, 119,
89 120, 121, 122, 123, 124, 125, 126, 127},
90 .oobfree = {
91 {.offset = 2,
Florian Fainellif8ac0412010-09-07 13:23:43 +020092 .length = 78} }
Thomas Gleixner81ec5362007-12-12 17:27:03 +010093};
94
Huang Shijie6a8214a2012-11-19 14:43:30 +080095static int nand_get_device(struct mtd_info *mtd, int new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020097static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
98 struct mtd_oob_ops *ops);
99
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200100/*
Joe Perches8e87d782008-02-03 17:22:34 +0200101 * For devices which display every fart in the system on a separate LED. Is
Thomas Gleixnerd470a972006-05-23 23:48:57 +0200102 * compiled away when LED support is disabled.
103 */
104DEFINE_LED_TRIGGER(nand_led_trigger);
105
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530106static int check_offs_len(struct mtd_info *mtd,
107 loff_t ofs, uint64_t len)
108{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100109 struct nand_chip *chip = mtd_to_nand(mtd);
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530110 int ret = 0;
111
112 /* Start address must align on block boundary */
Dan Carpenterdaae74c2013-08-09 12:49:05 +0300113 if (ofs & ((1ULL << chip->phys_erase_shift) - 1)) {
Brian Norris289c0522011-07-19 10:06:09 -0700114 pr_debug("%s: unaligned address\n", __func__);
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530115 ret = -EINVAL;
116 }
117
118 /* Length must align on block boundary */
Dan Carpenterdaae74c2013-08-09 12:49:05 +0300119 if (len & ((1ULL << chip->phys_erase_shift) - 1)) {
Brian Norris289c0522011-07-19 10:06:09 -0700120 pr_debug("%s: length not block aligned\n", __func__);
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530121 ret = -EINVAL;
122 }
123
Vimal Singh6fe5a6a2010-02-03 14:12:24 +0530124 return ret;
125}
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/**
128 * nand_release_device - [GENERIC] release chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700129 * @mtd: MTD device structure
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000130 *
Huang Shijieb0bb6902012-11-19 14:43:29 +0800131 * Release chip lock and wake up anyone waiting on the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100133static void nand_release_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100135 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200137 /* Release the controller and the chip */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200138 spin_lock(&chip->controller->lock);
139 chip->controller->active = NULL;
140 chip->state = FL_READY;
141 wake_up(&chip->controller->wq);
142 spin_unlock(&chip->controller->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143}
144
145/**
146 * nand_read_byte - [DEFAULT] read one byte from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700147 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700149 * Default read function for 8bit buswidth
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200151static uint8_t nand_read_byte(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100153 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200154 return readb(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155}
156
157/**
Masanari Iida064a7692012-11-09 23:20:58 +0900158 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700159 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700161 * Default read function for 16bit buswidth with endianness conversion.
162 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200164static uint8_t nand_read_byte16(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100166 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200167 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168}
169
170/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 * nand_read_word - [DEFAULT] read one word from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700172 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700174 * Default read function for 16bit buswidth without endianness conversion.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 */
176static u16 nand_read_word(struct mtd_info *mtd)
177{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100178 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200179 return readw(chip->IO_ADDR_R);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180}
181
182/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * nand_select_chip - [DEFAULT] control CE line
Brian Norris8b6e50c2011-05-25 14:59:01 -0700184 * @mtd: MTD device structure
185 * @chipnr: chipnumber to select, -1 for deselect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 *
187 * Default select function for 1 chip devices.
188 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200189static void nand_select_chip(struct mtd_info *mtd, int chipnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100191 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200192
193 switch (chipnr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 case -1:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200195 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 break;
197 case 0:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 break;
199
200 default:
201 BUG();
202 }
203}
204
205/**
Uwe Kleine-König05f78352013-12-05 22:22:04 +0100206 * nand_write_byte - [DEFAULT] write single byte to chip
207 * @mtd: MTD device structure
208 * @byte: value to write
209 *
210 * Default function to write a byte to I/O[7:0]
211 */
212static void nand_write_byte(struct mtd_info *mtd, uint8_t byte)
213{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100214 struct nand_chip *chip = mtd_to_nand(mtd);
Uwe Kleine-König05f78352013-12-05 22:22:04 +0100215
216 chip->write_buf(mtd, &byte, 1);
217}
218
219/**
220 * nand_write_byte16 - [DEFAULT] write single byte to a chip with width 16
221 * @mtd: MTD device structure
222 * @byte: value to write
223 *
224 * Default function to write a byte to I/O[7:0] on a 16-bit wide chip.
225 */
226static void nand_write_byte16(struct mtd_info *mtd, uint8_t byte)
227{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100228 struct nand_chip *chip = mtd_to_nand(mtd);
Uwe Kleine-König05f78352013-12-05 22:22:04 +0100229 uint16_t word = byte;
230
231 /*
232 * It's not entirely clear what should happen to I/O[15:8] when writing
233 * a byte. The ONFi spec (Revision 3.1; 2012-09-19, Section 2.16) reads:
234 *
235 * When the host supports a 16-bit bus width, only data is
236 * transferred at the 16-bit width. All address and command line
237 * transfers shall use only the lower 8-bits of the data bus. During
238 * command transfers, the host may place any value on the upper
239 * 8-bits of the data bus. During address transfers, the host shall
240 * set the upper 8-bits of the data bus to 00h.
241 *
242 * One user of the write_byte callback is nand_onfi_set_features. The
243 * four parameters are specified to be written to I/O[7:0], but this is
244 * neither an address nor a command transfer. Let's assume a 0 on the
245 * upper I/O lines is OK.
246 */
247 chip->write_buf(mtd, (uint8_t *)&word, 2);
248}
249
250/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 * nand_write_buf - [DEFAULT] write buffer to chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700252 * @mtd: MTD device structure
253 * @buf: data buffer
254 * @len: number of bytes to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700256 * Default write function for 8bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200258static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100260 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Alexander Shiyan76413832013-04-13 09:32:13 +0400262 iowrite8_rep(chip->IO_ADDR_W, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
265/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000266 * nand_read_buf - [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 8bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200273static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100275 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Alexander Shiyan76413832013-04-13 09:32:13 +0400277 ioread8_rep(chip->IO_ADDR_R, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
280/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 * nand_write_buf16 - [DEFAULT] write buffer to chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700282 * @mtd: MTD device structure
283 * @buf: data buffer
284 * @len: number of bytes to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700286 * Default write function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200288static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100290 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 u16 *p = (u16 *) buf;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000292
Alexander Shiyan76413832013-04-13 09:32:13 +0400293 iowrite16_rep(chip->IO_ADDR_W, p, len >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294}
295
296/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000297 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -0700298 * @mtd: MTD device structure
299 * @buf: buffer to store date
300 * @len: number of bytes to read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 *
Brian Norris7854d3f2011-06-23 14:12:08 -0700302 * Default read function for 16bit buswidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 */
Thomas Gleixner58dd8f2b2006-05-23 11:52:35 +0200304static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100306 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 u16 *p = (u16 *) buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Alexander Shiyan76413832013-04-13 09:32:13 +0400309 ioread16_rep(chip->IO_ADDR_R, p, len >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
312/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
Brian Norris8b6e50c2011-05-25 14:59:01 -0700314 * @mtd: MTD device structure
315 * @ofs: offset from device start
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 *
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000317 * Check, if the block is bad.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 */
Archit Taneja9f3e0422016-02-03 14:29:49 +0530319static int nand_block_bad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
Archit Taneja9f3e0422016-02-03 14:29:49 +0530321 int page, res = 0, i = 0;
Boris BREZILLON862eba52015-12-01 12:03:03 +0100322 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 u16 bad;
324
Brian Norris5fb15492011-05-31 16:31:21 -0700325 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
Kevin Cernekeeb60b08b2010-05-04 20:58:10 -0700326 ofs += mtd->erasesize - mtd->writesize;
327
Thomas Knobloch1a12f462007-05-03 07:39:37 +0100328 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
329
Brian Norriscdbec052012-01-13 18:11:48 -0800330 do {
331 if (chip->options & NAND_BUSWIDTH_16) {
332 chip->cmdfunc(mtd, NAND_CMD_READOOB,
333 chip->badblockpos & 0xFE, page);
334 bad = cpu_to_le16(chip->read_word(mtd));
335 if (chip->badblockpos & 0x1)
336 bad >>= 8;
337 else
338 bad &= 0xFF;
339 } else {
340 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
341 page);
342 bad = chip->read_byte(mtd);
343 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000344
Brian Norriscdbec052012-01-13 18:11:48 -0800345 if (likely(chip->badblockbits == 8))
346 res = bad != 0xFF;
347 else
348 res = hweight8(bad) < chip->badblockbits;
349 ofs += mtd->writesize;
350 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
351 i++;
352 } while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
Maxim Levitskye0b58d02010-02-22 20:39:38 +0200353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 return res;
355}
356
357/**
Brian Norris5a0edb22013-07-30 17:52:58 -0700358 * nand_default_block_markbad - [DEFAULT] mark a block bad via bad block marker
Brian Norris8b6e50c2011-05-25 14:59:01 -0700359 * @mtd: MTD device structure
360 * @ofs: offset from device start
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700362 * This is the default implementation, which can be overridden by a hardware
Brian Norris5a0edb22013-07-30 17:52:58 -0700363 * specific driver. It provides the details for writing a bad block marker to a
364 * block.
365 */
366static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
367{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100368 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norris5a0edb22013-07-30 17:52:58 -0700369 struct mtd_oob_ops ops;
370 uint8_t buf[2] = { 0, 0 };
371 int ret = 0, res, i = 0;
372
Brian Norris0ec56dc2015-02-28 02:02:30 -0800373 memset(&ops, 0, sizeof(ops));
Brian Norris5a0edb22013-07-30 17:52:58 -0700374 ops.oobbuf = buf;
375 ops.ooboffs = chip->badblockpos;
376 if (chip->options & NAND_BUSWIDTH_16) {
377 ops.ooboffs &= ~0x01;
378 ops.len = ops.ooblen = 2;
379 } else {
380 ops.len = ops.ooblen = 1;
381 }
382 ops.mode = MTD_OPS_PLACE_OOB;
383
384 /* Write to first/last page(s) if necessary */
385 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
386 ofs += mtd->erasesize - mtd->writesize;
387 do {
388 res = nand_do_write_oob(mtd, ofs, &ops);
389 if (!ret)
390 ret = res;
391
392 i++;
393 ofs += mtd->writesize;
394 } while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
395
396 return ret;
397}
398
399/**
400 * nand_block_markbad_lowlevel - mark a block bad
401 * @mtd: MTD device structure
402 * @ofs: offset from device start
403 *
404 * This function performs the generic NAND bad block marking steps (i.e., bad
405 * block table(s) and/or marker(s)). We only allow the hardware driver to
406 * specify how to write bad block markers to OOB (chip->block_markbad).
407 *
Brian Norrisb32843b2013-07-30 17:52:59 -0700408 * We try operations in the following order:
Brian Norrise2414f42012-02-06 13:44:00 -0800409 * (1) erase the affected block, to allow OOB marker to be written cleanly
Brian Norrisb32843b2013-07-30 17:52:59 -0700410 * (2) write bad block marker to OOB area of affected block (unless flag
411 * NAND_BBT_NO_OOB_BBM is present)
412 * (3) update the BBT
413 * Note that we retain the first error encountered in (2) or (3), finish the
Brian Norrise2414f42012-02-06 13:44:00 -0800414 * procedures, and dump the error in the end.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415*/
Brian Norris5a0edb22013-07-30 17:52:58 -0700416static int nand_block_markbad_lowlevel(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100418 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norrisb32843b2013-07-30 17:52:59 -0700419 int res, ret = 0;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000420
Brian Norrisb32843b2013-07-30 17:52:59 -0700421 if (!(chip->bbt_options & NAND_BBT_NO_OOB_BBM)) {
Brian Norris00918422012-01-13 18:11:47 -0800422 struct erase_info einfo;
423
424 /* Attempt erase before marking OOB */
425 memset(&einfo, 0, sizeof(einfo));
426 einfo.mtd = mtd;
427 einfo.addr = ofs;
Dan Carpenterdaae74c2013-08-09 12:49:05 +0300428 einfo.len = 1ULL << chip->phys_erase_shift;
Brian Norris00918422012-01-13 18:11:47 -0800429 nand_erase_nand(mtd, &einfo, 0);
Brian Norris00918422012-01-13 18:11:47 -0800430
Brian Norrisb32843b2013-07-30 17:52:59 -0700431 /* Write bad block marker to OOB */
Huang Shijie6a8214a2012-11-19 14:43:30 +0800432 nand_get_device(mtd, FL_WRITING);
Brian Norris5a0edb22013-07-30 17:52:58 -0700433 ret = chip->block_markbad(mtd, ofs);
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300434 nand_release_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200435 }
Brian Norrise2414f42012-02-06 13:44:00 -0800436
Brian Norrisb32843b2013-07-30 17:52:59 -0700437 /* Mark block bad in BBT */
438 if (chip->bbt) {
439 res = nand_markbad_bbt(mtd, ofs);
Brian Norrise2414f42012-02-06 13:44:00 -0800440 if (!ret)
441 ret = res;
442 }
443
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200444 if (!ret)
445 mtd->ecc_stats.badblocks++;
Artem Bityutskiyc0b8ba72007-07-23 16:06:50 +0300446
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200447 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448}
449
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000450/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 * nand_check_wp - [GENERIC] check if the chip is write protected
Brian Norris8b6e50c2011-05-25 14:59:01 -0700452 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700454 * Check, if the device is write protected. The function expects, that the
455 * device is already selected.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100457static int nand_check_wp(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100459 struct nand_chip *chip = mtd_to_nand(mtd);
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200460
Brian Norris8b6e50c2011-05-25 14:59:01 -0700461 /* Broken xD cards report WP despite being writable */
Maxim Levitsky93edbad2010-02-22 20:39:40 +0200462 if (chip->options & NAND_BROKEN_XD)
463 return 0;
464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 /* Check the WP bit */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200466 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
467 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468}
469
470/**
Gu Zhengc30e1f72014-09-03 17:49:10 +0800471 * nand_block_isreserved - [GENERIC] Check if a block is marked reserved.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700472 * @mtd: MTD device structure
473 * @ofs: offset from device start
Ezequiel Garcia8471bb72014-05-21 19:06:12 -0300474 *
Gu Zhengc30e1f72014-09-03 17:49:10 +0800475 * Check if the block is marked as reserved.
Ezequiel Garcia8471bb72014-05-21 19:06:12 -0300476 */
477static int nand_block_isreserved(struct mtd_info *mtd, loff_t ofs)
478{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100479 struct nand_chip *chip = mtd_to_nand(mtd);
Ezequiel Garcia8471bb72014-05-21 19:06:12 -0300480
481 if (!chip->bbt)
482 return 0;
483 /* Return info from the table */
484 return nand_isreserved_bbt(mtd, ofs);
485}
486
487/**
488 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
489 * @mtd: MTD device structure
490 * @ofs: offset from device start
Brian Norris8b6e50c2011-05-25 14:59:01 -0700491 * @allowbbt: 1, if its allowed to access the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 *
493 * Check, if the block is bad. Either by reading the bad block table or
494 * calling of the scan function.
495 */
Archit Taneja9f3e0422016-02-03 14:29:49 +0530496static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100498 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000499
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200500 if (!chip->bbt)
Archit Taneja9f3e0422016-02-03 14:29:49 +0530501 return chip->block_bad(mtd, ofs);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 /* Return info from the table */
David Woodhousee0c7d762006-05-13 18:07:53 +0100504 return nand_isbad_bbt(mtd, ofs, allowbbt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505}
506
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200507/**
508 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
Brian Norris8b6e50c2011-05-25 14:59:01 -0700509 * @mtd: MTD device structure
510 * @timeo: Timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200511 *
512 * Helper function for nand_wait_ready used when needing to wait in interrupt
513 * context.
514 */
515static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
516{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100517 struct nand_chip *chip = mtd_to_nand(mtd);
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200518 int i;
519
520 /* Wait for the device to get ready */
521 for (i = 0; i < timeo; i++) {
522 if (chip->dev_ready(mtd))
523 break;
524 touch_softlockup_watchdog();
525 mdelay(1);
526 }
527}
528
Alex Smithb70af9b2015-10-06 14:52:07 +0100529/**
530 * nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
531 * @mtd: MTD device structure
532 *
533 * Wait for the ready pin after a command, and warn if a timeout occurs.
534 */
David Woodhouse4b648b02006-09-25 17:05:24 +0100535void nand_wait_ready(struct mtd_info *mtd)
Thomas Gleixner3b887752005-02-22 21:56:49 +0000536{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100537 struct nand_chip *chip = mtd_to_nand(mtd);
Alex Smithb70af9b2015-10-06 14:52:07 +0100538 unsigned long timeo = 400;
Thomas Gleixner3b887752005-02-22 21:56:49 +0000539
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200540 if (in_interrupt() || oops_in_progress)
Alex Smithb70af9b2015-10-06 14:52:07 +0100541 return panic_nand_wait_ready(mtd, timeo);
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200542
Richard Purdie8fe833c2006-03-31 02:31:14 -0800543 led_trigger_event(nand_led_trigger, LED_FULL);
Brian Norris7854d3f2011-06-23 14:12:08 -0700544 /* Wait until command is processed or timeout occurs */
Alex Smithb70af9b2015-10-06 14:52:07 +0100545 timeo = jiffies + msecs_to_jiffies(timeo);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000546 do {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200547 if (chip->dev_ready(mtd))
Alex Smithb70af9b2015-10-06 14:52:07 +0100548 goto out;
549 cond_resched();
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000550 } while (time_before(jiffies, timeo));
Alex Smithb70af9b2015-10-06 14:52:07 +0100551
Brian Norris9ebfdf52016-03-04 17:19:23 -0800552 if (!chip->dev_ready(mtd))
553 pr_warn_ratelimited("timeout while waiting for chip to become ready\n");
Alex Smithb70af9b2015-10-06 14:52:07 +0100554out:
Richard Purdie8fe833c2006-03-31 02:31:14 -0800555 led_trigger_event(nand_led_trigger, LED_OFF);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000556}
David Woodhouse4b648b02006-09-25 17:05:24 +0100557EXPORT_SYMBOL_GPL(nand_wait_ready);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/**
Roger Quadros60c70d62015-02-23 17:26:39 +0200560 * nand_wait_status_ready - [GENERIC] Wait for the ready status after commands.
561 * @mtd: MTD device structure
562 * @timeo: Timeout in ms
563 *
564 * Wait for status ready (i.e. command done) or timeout.
565 */
566static void nand_wait_status_ready(struct mtd_info *mtd, unsigned long timeo)
567{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100568 register struct nand_chip *chip = mtd_to_nand(mtd);
Roger Quadros60c70d62015-02-23 17:26:39 +0200569
570 timeo = jiffies + msecs_to_jiffies(timeo);
571 do {
572 if ((chip->read_byte(mtd) & NAND_STATUS_READY))
573 break;
574 touch_softlockup_watchdog();
575 } while (time_before(jiffies, timeo));
576};
577
578/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 * nand_command - [DEFAULT] Send command to NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700580 * @mtd: MTD device structure
581 * @command: the command to be sent
582 * @column: the column address for this command, -1 if none
583 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700585 * Send command to NAND device. This function is used for small page devices
Artem Bityutskiy51148f12013-03-05 15:00:51 +0200586 * (512 Bytes per page).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200588static void nand_command(struct mtd_info *mtd, unsigned int command,
589 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100591 register struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200592 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Brian Norris8b6e50c2011-05-25 14:59:01 -0700594 /* Write out the command to the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 if (command == NAND_CMD_SEQIN) {
596 int readcmd;
597
Joern Engel28318772006-05-22 23:18:05 +0200598 if (column >= mtd->writesize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 /* OOB area */
Joern Engel28318772006-05-22 23:18:05 +0200600 column -= mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 readcmd = NAND_CMD_READOOB;
602 } else if (column < 256) {
603 /* First 256 bytes --> READ0 */
604 readcmd = NAND_CMD_READ0;
605 } else {
606 column -= 256;
607 readcmd = NAND_CMD_READ1;
608 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200609 chip->cmd_ctrl(mtd, readcmd, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200610 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200612 chip->cmd_ctrl(mtd, command, ctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Brian Norris8b6e50c2011-05-25 14:59:01 -0700614 /* Address cycle, when necessary */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200615 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
616 /* Serially input address */
617 if (column != -1) {
618 /* Adjust columns for 16 bit buswidth */
Brian Norris3dad2342014-01-29 14:08:12 -0800619 if (chip->options & NAND_BUSWIDTH_16 &&
620 !nand_opcode_8bits(command))
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200621 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200622 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200623 ctrl &= ~NAND_CTRL_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 }
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200625 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200626 chip->cmd_ctrl(mtd, page_addr, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200627 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200628 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200629 /* One more address cycle for devices > 32MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200630 if (chip->chipsize > (32 << 20))
631 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200632 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200633 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000634
635 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700636 * Program and erase have their own busy handlers status and sequential
637 * in needs no delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100638 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 case NAND_CMD_PAGEPROG:
642 case NAND_CMD_ERASE1:
643 case NAND_CMD_ERASE2:
644 case NAND_CMD_SEQIN:
645 case NAND_CMD_STATUS:
646 return;
647
648 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200649 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200651 udelay(chip->chip_delay);
652 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200653 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200654 chip->cmd_ctrl(mtd,
655 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Roger Quadros60c70d62015-02-23 17:26:39 +0200656 /* EZ-NAND can take upto 250ms as per ONFi v4.0 */
657 nand_wait_status_ready(mtd, 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return;
659
David Woodhousee0c7d762006-05-13 18:07:53 +0100660 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000662 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 * If we don't have access to the busy pin, we apply the given
664 * command delay
David Woodhousee0c7d762006-05-13 18:07:53 +0100665 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200666 if (!chip->dev_ready) {
667 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000669 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 }
Brian Norris8b6e50c2011-05-25 14:59:01 -0700671 /*
672 * Apply this short delay always to ensure that we do wait tWB in
673 * any case on any machine.
674 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100675 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000676
677 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
679
680/**
681 * nand_command_lp - [DEFAULT] Send command to NAND large page device
Brian Norris8b6e50c2011-05-25 14:59:01 -0700682 * @mtd: MTD device structure
683 * @command: the command to be sent
684 * @column: the column address for this command, -1 if none
685 * @page_addr: the page address for this command, -1 if none
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 *
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200687 * Send command to NAND device. This is the version for the new large page
Brian Norris7854d3f2011-06-23 14:12:08 -0700688 * devices. We don't have the separate regions as we have in the small page
689 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 */
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200691static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
692 int column, int page_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100694 register struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696 /* Emulate NAND_CMD_READOOB */
697 if (command == NAND_CMD_READOOB) {
Joern Engel28318772006-05-22 23:18:05 +0200698 column += mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 command = NAND_CMD_READ0;
700 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000701
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200702 /* Command latch cycle */
Alexander Shiyanfb066ad2013-02-28 12:02:19 +0400703 chip->cmd_ctrl(mtd, command, NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 if (column != -1 || page_addr != -1) {
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200706 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708 /* Serially input address */
709 if (column != -1) {
710 /* Adjust columns for 16 bit buswidth */
Brian Norris3dad2342014-01-29 14:08:12 -0800711 if (chip->options & NAND_BUSWIDTH_16 &&
712 !nand_opcode_8bits(command))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 column >>= 1;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200714 chip->cmd_ctrl(mtd, column, ctrl);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200715 ctrl &= ~NAND_CTRL_CHANGE;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200716 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000717 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 if (page_addr != -1) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200719 chip->cmd_ctrl(mtd, page_addr, ctrl);
720 chip->cmd_ctrl(mtd, page_addr >> 8,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200721 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 /* One more address cycle for devices > 128MiB */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200723 if (chip->chipsize > (128 << 20))
724 chip->cmd_ctrl(mtd, page_addr >> 16,
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200725 NAND_NCE | NAND_ALE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 }
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200728 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000729
730 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -0700731 * Program and erase have their own busy handlers status, sequential
Gerhard Sittig7a442f12014-03-29 14:36:22 +0100732 * in and status need no delay.
David A. Marlin30f464b2005-01-17 18:35:25 +0000733 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 switch (command) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 case NAND_CMD_CACHEDPROG:
737 case NAND_CMD_PAGEPROG:
738 case NAND_CMD_ERASE1:
739 case NAND_CMD_ERASE2:
740 case NAND_CMD_SEQIN:
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200741 case NAND_CMD_RNDIN:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 case NAND_CMD_STATUS:
David A. Marlin30f464b2005-01-17 18:35:25 +0000743 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
745 case NAND_CMD_RESET:
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200746 if (chip->dev_ready)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 break;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200748 udelay(chip->chip_delay);
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200749 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
750 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
751 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
752 NAND_NCE | NAND_CTRL_CHANGE);
Roger Quadros60c70d62015-02-23 17:26:39 +0200753 /* EZ-NAND can take upto 250ms as per ONFi v4.0 */
754 nand_wait_status_ready(mtd, 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 return;
756
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200757 case NAND_CMD_RNDOUT:
758 /* No ready / busy check necessary */
759 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
760 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
761 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
762 NAND_NCE | NAND_CTRL_CHANGE);
763 return;
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 case NAND_CMD_READ0:
Thomas Gleixner12efdde2006-05-24 22:57:09 +0200766 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
767 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
768 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
769 NAND_NCE | NAND_CTRL_CHANGE);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000770
David Woodhousee0c7d762006-05-13 18:07:53 +0100771 /* This applies to read commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 default:
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000773 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 * If we don't have access to the busy pin, we apply the given
Brian Norris8b6e50c2011-05-25 14:59:01 -0700775 * command delay.
David Woodhousee0c7d762006-05-13 18:07:53 +0100776 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200777 if (!chip->dev_ready) {
778 udelay(chip->chip_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 return;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +0000780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 }
Thomas Gleixner3b887752005-02-22 21:56:49 +0000782
Brian Norris8b6e50c2011-05-25 14:59:01 -0700783 /*
784 * Apply this short delay always to ensure that we do wait tWB in
785 * any case on any machine.
786 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100787 ndelay(100);
Thomas Gleixner3b887752005-02-22 21:56:49 +0000788
789 nand_wait_ready(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790}
791
792/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200793 * panic_nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700794 * @chip: the nand chip descriptor
795 * @mtd: MTD device structure
796 * @new_state: the state which is requested
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200797 *
798 * Used when in panic, no locks are taken.
799 */
800static void panic_nand_get_device(struct nand_chip *chip,
801 struct mtd_info *mtd, int new_state)
802{
Brian Norris7854d3f2011-06-23 14:12:08 -0700803 /* Hardware controller shared among independent devices */
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200804 chip->controller->active = chip;
805 chip->state = new_state;
806}
807
808/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * nand_get_device - [GENERIC] Get chip for selected access
Brian Norris8b6e50c2011-05-25 14:59:01 -0700810 * @mtd: MTD device structure
811 * @new_state: the state which is requested
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 *
813 * Get the device and lock it for exclusive access
814 */
Thomas Gleixner2c0a2be2006-05-23 11:50:56 +0200815static int
Huang Shijie6a8214a2012-11-19 14:43:30 +0800816nand_get_device(struct mtd_info *mtd, int new_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
Boris BREZILLON862eba52015-12-01 12:03:03 +0100818 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200819 spinlock_t *lock = &chip->controller->lock;
820 wait_queue_head_t *wq = &chip->controller->wq;
David Woodhousee0c7d762006-05-13 18:07:53 +0100821 DECLARE_WAITQUEUE(wait, current);
Florian Fainelli7351d3a2010-09-07 13:23:45 +0200822retry:
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100823 spin_lock(lock);
824
vimal singhb8b3ee92009-07-09 20:41:22 +0530825 /* Hardware controller shared among independent devices */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200826 if (!chip->controller->active)
827 chip->controller->active = chip;
Thomas Gleixnera36ed292006-05-23 11:37:03 +0200828
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200829 if (chip->controller->active == chip && chip->state == FL_READY) {
830 chip->state = new_state;
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100831 spin_unlock(lock);
Vitaly Wool962034f2005-09-15 14:58:53 +0100832 return 0;
833 }
834 if (new_state == FL_PM_SUSPENDED) {
Li Yang6b0d9a82009-11-17 14:45:49 -0800835 if (chip->controller->active->state == FL_PM_SUSPENDED) {
836 chip->state = FL_PM_SUSPENDED;
837 spin_unlock(lock);
838 return 0;
Li Yang6b0d9a82009-11-17 14:45:49 -0800839 }
Thomas Gleixner0dfc6242005-05-31 20:39:20 +0100840 }
841 set_current_state(TASK_UNINTERRUPTIBLE);
842 add_wait_queue(wq, &wait);
843 spin_unlock(lock);
844 schedule();
845 remove_wait_queue(wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 goto retry;
847}
848
849/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700850 * panic_nand_wait - [GENERIC] wait until the command is done
851 * @mtd: MTD device structure
852 * @chip: NAND chip structure
853 * @timeo: timeout
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200854 *
855 * Wait for command done. This is a helper function for nand_wait used when
856 * we are in interrupt context. May happen when in panic and trying to write
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400857 * an oops through mtdoops.
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200858 */
859static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
860 unsigned long timeo)
861{
862 int i;
863 for (i = 0; i < timeo; i++) {
864 if (chip->dev_ready) {
865 if (chip->dev_ready(mtd))
866 break;
867 } else {
868 if (chip->read_byte(mtd) & NAND_STATUS_READY)
869 break;
870 }
871 mdelay(1);
Florian Fainellif8ac0412010-09-07 13:23:43 +0200872 }
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200873}
874
875/**
Brian Norris8b6e50c2011-05-25 14:59:01 -0700876 * nand_wait - [DEFAULT] wait until the command is done
877 * @mtd: MTD device structure
878 * @chip: NAND chip structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 *
Alex Smithb70af9b2015-10-06 14:52:07 +0100880 * Wait for command done. This applies to erase and program only.
Randy Dunlap844d3b42006-06-28 21:48:27 -0700881 */
Thomas Gleixner7bc33122006-06-20 20:05:05 +0200882static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883{
884
Alex Smithb70af9b2015-10-06 14:52:07 +0100885 int status;
886 unsigned long timeo = 400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Richard Purdie8fe833c2006-03-31 02:31:14 -0800888 led_trigger_event(nand_led_trigger, LED_FULL);
889
Brian Norris8b6e50c2011-05-25 14:59:01 -0700890 /*
891 * Apply this short delay always to ensure that we do wait tWB in any
892 * case on any machine.
893 */
David Woodhousee0c7d762006-05-13 18:07:53 +0100894 ndelay(100);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Artem Bityutskiy14c65782013-03-04 14:21:34 +0200896 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200898 if (in_interrupt() || oops_in_progress)
899 panic_nand_wait(mtd, chip, timeo);
900 else {
Huang Shijie6d2559f2013-01-30 10:03:56 +0800901 timeo = jiffies + msecs_to_jiffies(timeo);
Alex Smithb70af9b2015-10-06 14:52:07 +0100902 do {
Simon Kagstrom2af7c652009-10-05 15:55:52 +0200903 if (chip->dev_ready) {
904 if (chip->dev_ready(mtd))
905 break;
906 } else {
907 if (chip->read_byte(mtd) & NAND_STATUS_READY)
908 break;
909 }
910 cond_resched();
Alex Smithb70af9b2015-10-06 14:52:07 +0100911 } while (time_before(jiffies, timeo));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 }
Richard Purdie8fe833c2006-03-31 02:31:14 -0800913 led_trigger_event(nand_led_trigger, LED_OFF);
914
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +0200915 status = (int)chip->read_byte(mtd);
Matthieu CASTETf251b8d2012-11-05 15:00:44 +0100916 /* This can happen if in case of timeout or buggy dev_ready */
917 WARN_ON(!(status & NAND_STATUS_READY));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 return status;
919}
920
921/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700922 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700923 * @mtd: mtd info
924 * @ofs: offset to start unlock from
925 * @len: length to unlock
Brian Norris8b6e50c2011-05-25 14:59:01 -0700926 * @invert: when = 0, unlock the range of blocks within the lower and
927 * upper boundary address
928 * when = 1, unlock the range of blocks outside the boundaries
929 * of the lower and upper boundary address
Vimal Singh7d70f332010-02-08 15:50:49 +0530930 *
Brian Norris8b6e50c2011-05-25 14:59:01 -0700931 * Returs unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530932 */
933static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
934 uint64_t len, int invert)
935{
936 int ret = 0;
937 int status, page;
Boris BREZILLON862eba52015-12-01 12:03:03 +0100938 struct nand_chip *chip = mtd_to_nand(mtd);
Vimal Singh7d70f332010-02-08 15:50:49 +0530939
940 /* Submit address of first page to unlock */
941 page = ofs >> chip->page_shift;
942 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
943
944 /* Submit address of last page to unlock */
945 page = (ofs + len) >> chip->page_shift;
946 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
947 (page | invert) & chip->pagemask);
948
949 /* Call wait ready function */
950 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +0530951 /* See if device thinks it succeeded */
Huang Shijie74830962012-10-14 23:47:24 -0400952 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -0700953 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530954 __func__, status);
955 ret = -EIO;
956 }
957
958 return ret;
959}
960
961/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -0700962 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
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 * Returns unlock status.
Vimal Singh7d70f332010-02-08 15:50:49 +0530968 */
969int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
970{
971 int ret = 0;
972 int chipnr;
Boris BREZILLON862eba52015-12-01 12:03:03 +0100973 struct nand_chip *chip = mtd_to_nand(mtd);
Vimal Singh7d70f332010-02-08 15:50:49 +0530974
Brian Norris289c0522011-07-19 10:06:09 -0700975 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +0530976 __func__, (unsigned long long)ofs, len);
977
978 if (check_offs_len(mtd, ofs, len))
Brian Norrisb1a23482015-02-28 02:02:27 -0800979 return -EINVAL;
Vimal Singh7d70f332010-02-08 15:50:49 +0530980
981 /* Align to last block address if size addresses end of the device */
982 if (ofs + len == mtd->size)
983 len -= mtd->erasesize;
984
Huang Shijie6a8214a2012-11-19 14:43:30 +0800985 nand_get_device(mtd, FL_UNLOCKING);
Vimal Singh7d70f332010-02-08 15:50:49 +0530986
987 /* Shift to get chip number */
988 chipnr = ofs >> chip->chip_shift;
989
990 chip->select_chip(mtd, chipnr);
991
White Ding57d3a9a2014-07-24 00:10:45 +0800992 /*
993 * Reset the chip.
994 * If we want to check the WP through READ STATUS and check the bit 7
995 * we must reset the chip
996 * some operation can also clear the bit 7 of status register
997 * eg. erase/program a locked block
998 */
999 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
1000
Vimal Singh7d70f332010-02-08 15:50:49 +05301001 /* Check, if it is write protected */
1002 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07001003 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301004 __func__);
1005 ret = -EIO;
1006 goto out;
1007 }
1008
1009 ret = __nand_unlock(mtd, ofs, len, 0);
1010
1011out:
Huang Shijieb0bb6902012-11-19 14:43:29 +08001012 chip->select_chip(mtd, -1);
Vimal Singh7d70f332010-02-08 15:50:49 +05301013 nand_release_device(mtd);
1014
1015 return ret;
1016}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001017EXPORT_SYMBOL(nand_unlock);
Vimal Singh7d70f332010-02-08 15:50:49 +05301018
1019/**
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001020 * nand_lock - [REPLACEABLE] locks all blocks present in the device
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001021 * @mtd: mtd info
1022 * @ofs: offset to start unlock from
1023 * @len: length to unlock
Vimal Singh7d70f332010-02-08 15:50:49 +05301024 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001025 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
1026 * have this feature, but it allows only to lock all blocks, not for specified
1027 * range for block. Implementing 'lock' feature by making use of 'unlock', for
1028 * now.
Vimal Singh7d70f332010-02-08 15:50:49 +05301029 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001030 * Returns lock status.
Vimal Singh7d70f332010-02-08 15:50:49 +05301031 */
1032int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1033{
1034 int ret = 0;
1035 int chipnr, status, page;
Boris BREZILLON862eba52015-12-01 12:03:03 +01001036 struct nand_chip *chip = mtd_to_nand(mtd);
Vimal Singh7d70f332010-02-08 15:50:49 +05301037
Brian Norris289c0522011-07-19 10:06:09 -07001038 pr_debug("%s: start = 0x%012llx, len = %llu\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301039 __func__, (unsigned long long)ofs, len);
1040
1041 if (check_offs_len(mtd, ofs, len))
Brian Norrisb1a23482015-02-28 02:02:27 -08001042 return -EINVAL;
Vimal Singh7d70f332010-02-08 15:50:49 +05301043
Huang Shijie6a8214a2012-11-19 14:43:30 +08001044 nand_get_device(mtd, FL_LOCKING);
Vimal Singh7d70f332010-02-08 15:50:49 +05301045
1046 /* Shift to get chip number */
1047 chipnr = ofs >> chip->chip_shift;
1048
1049 chip->select_chip(mtd, chipnr);
1050
White Ding57d3a9a2014-07-24 00:10:45 +08001051 /*
1052 * Reset the chip.
1053 * If we want to check the WP through READ STATUS and check the bit 7
1054 * we must reset the chip
1055 * some operation can also clear the bit 7 of status register
1056 * eg. erase/program a locked block
1057 */
1058 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
1059
Vimal Singh7d70f332010-02-08 15:50:49 +05301060 /* Check, if it is write protected */
1061 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07001062 pr_debug("%s: device is write protected!\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301063 __func__);
1064 status = MTD_ERASE_FAILED;
1065 ret = -EIO;
1066 goto out;
1067 }
1068
1069 /* Submit address of first page to lock */
1070 page = ofs >> chip->page_shift;
1071 chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);
1072
1073 /* Call wait ready function */
1074 status = chip->waitfunc(mtd, chip);
Vimal Singh7d70f332010-02-08 15:50:49 +05301075 /* See if device thinks it succeeded */
Huang Shijie74830962012-10-14 23:47:24 -04001076 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -07001077 pr_debug("%s: error status = 0x%08x\n",
Vimal Singh7d70f332010-02-08 15:50:49 +05301078 __func__, status);
1079 ret = -EIO;
1080 goto out;
1081 }
1082
1083 ret = __nand_unlock(mtd, ofs, len, 0x1);
1084
1085out:
Huang Shijieb0bb6902012-11-19 14:43:29 +08001086 chip->select_chip(mtd, -1);
Vimal Singh7d70f332010-02-08 15:50:49 +05301087 nand_release_device(mtd);
1088
1089 return ret;
1090}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001091EXPORT_SYMBOL(nand_lock);
Vimal Singh7d70f332010-02-08 15:50:49 +05301092
1093/**
Boris BREZILLON730a43f2015-09-03 18:03:38 +02001094 * nand_check_erased_buf - check if a buffer contains (almost) only 0xff data
1095 * @buf: buffer to test
1096 * @len: buffer length
1097 * @bitflips_threshold: maximum number of bitflips
1098 *
1099 * Check if a buffer contains only 0xff, which means the underlying region
1100 * has been erased and is ready to be programmed.
1101 * The bitflips_threshold specify the maximum number of bitflips before
1102 * considering the region is not erased.
1103 * Note: The logic of this function has been extracted from the memweight
1104 * implementation, except that nand_check_erased_buf function exit before
1105 * testing the whole buffer if the number of bitflips exceed the
1106 * bitflips_threshold value.
1107 *
1108 * Returns a positive number of bitflips less than or equal to
1109 * bitflips_threshold, or -ERROR_CODE for bitflips in excess of the
1110 * threshold.
1111 */
1112static int nand_check_erased_buf(void *buf, int len, int bitflips_threshold)
1113{
1114 const unsigned char *bitmap = buf;
1115 int bitflips = 0;
1116 int weight;
1117
1118 for (; len && ((uintptr_t)bitmap) % sizeof(long);
1119 len--, bitmap++) {
1120 weight = hweight8(*bitmap);
1121 bitflips += BITS_PER_BYTE - weight;
1122 if (unlikely(bitflips > bitflips_threshold))
1123 return -EBADMSG;
1124 }
1125
1126 for (; len >= sizeof(long);
1127 len -= sizeof(long), bitmap += sizeof(long)) {
1128 weight = hweight_long(*((unsigned long *)bitmap));
1129 bitflips += BITS_PER_LONG - weight;
1130 if (unlikely(bitflips > bitflips_threshold))
1131 return -EBADMSG;
1132 }
1133
1134 for (; len > 0; len--, bitmap++) {
1135 weight = hweight8(*bitmap);
1136 bitflips += BITS_PER_BYTE - weight;
1137 if (unlikely(bitflips > bitflips_threshold))
1138 return -EBADMSG;
1139 }
1140
1141 return bitflips;
1142}
1143
1144/**
1145 * nand_check_erased_ecc_chunk - check if an ECC chunk contains (almost) only
1146 * 0xff data
1147 * @data: data buffer to test
1148 * @datalen: data length
1149 * @ecc: ECC buffer
1150 * @ecclen: ECC length
1151 * @extraoob: extra OOB buffer
1152 * @extraooblen: extra OOB length
1153 * @bitflips_threshold: maximum number of bitflips
1154 *
1155 * Check if a data buffer and its associated ECC and OOB data contains only
1156 * 0xff pattern, which means the underlying region has been erased and is
1157 * ready to be programmed.
1158 * The bitflips_threshold specify the maximum number of bitflips before
1159 * considering the region as not erased.
1160 *
1161 * Note:
1162 * 1/ ECC algorithms are working on pre-defined block sizes which are usually
1163 * different from the NAND page size. When fixing bitflips, ECC engines will
1164 * report the number of errors per chunk, and the NAND core infrastructure
1165 * expect you to return the maximum number of bitflips for the whole page.
1166 * This is why you should always use this function on a single chunk and
1167 * not on the whole page. After checking each chunk you should update your
1168 * max_bitflips value accordingly.
1169 * 2/ When checking for bitflips in erased pages you should not only check
1170 * the payload data but also their associated ECC data, because a user might
1171 * have programmed almost all bits to 1 but a few. In this case, we
1172 * shouldn't consider the chunk as erased, and checking ECC bytes prevent
1173 * this case.
1174 * 3/ The extraoob argument is optional, and should be used if some of your OOB
1175 * data are protected by the ECC engine.
1176 * It could also be used if you support subpages and want to attach some
1177 * extra OOB data to an ECC chunk.
1178 *
1179 * Returns a positive number of bitflips less than or equal to
1180 * bitflips_threshold, or -ERROR_CODE for bitflips in excess of the
1181 * threshold. In case of success, the passed buffers are filled with 0xff.
1182 */
1183int nand_check_erased_ecc_chunk(void *data, int datalen,
1184 void *ecc, int ecclen,
1185 void *extraoob, int extraooblen,
1186 int bitflips_threshold)
1187{
1188 int data_bitflips = 0, ecc_bitflips = 0, extraoob_bitflips = 0;
1189
1190 data_bitflips = nand_check_erased_buf(data, datalen,
1191 bitflips_threshold);
1192 if (data_bitflips < 0)
1193 return data_bitflips;
1194
1195 bitflips_threshold -= data_bitflips;
1196
1197 ecc_bitflips = nand_check_erased_buf(ecc, ecclen, bitflips_threshold);
1198 if (ecc_bitflips < 0)
1199 return ecc_bitflips;
1200
1201 bitflips_threshold -= ecc_bitflips;
1202
1203 extraoob_bitflips = nand_check_erased_buf(extraoob, extraooblen,
1204 bitflips_threshold);
1205 if (extraoob_bitflips < 0)
1206 return extraoob_bitflips;
1207
1208 if (data_bitflips)
1209 memset(data, 0xff, datalen);
1210
1211 if (ecc_bitflips)
1212 memset(ecc, 0xff, ecclen);
1213
1214 if (extraoob_bitflips)
1215 memset(extraoob, 0xff, extraooblen);
1216
1217 return data_bitflips + ecc_bitflips + extraoob_bitflips;
1218}
1219EXPORT_SYMBOL(nand_check_erased_ecc_chunk);
1220
1221/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001222 * nand_read_page_raw - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001223 * @mtd: mtd info structure
1224 * @chip: nand chip info structure
1225 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001226 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001227 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001228 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001229 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001230 */
1231static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001232 uint8_t *buf, int oob_required, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001233{
1234 chip->read_buf(mtd, buf, mtd->writesize);
Brian Norris279f08d2012-05-02 10:15:03 -07001235 if (oob_required)
1236 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001237 return 0;
1238}
1239
1240/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001241 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001242 * @mtd: mtd info structure
1243 * @chip: nand chip info structure
1244 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001245 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001246 * @page: page number to read
David Brownell52ff49d2009-03-04 12:01:36 -08001247 *
1248 * We need a special oob layout and handling even when OOB isn't used.
1249 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001250static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001251 struct nand_chip *chip, uint8_t *buf,
1252 int oob_required, int page)
David Brownell52ff49d2009-03-04 12:01:36 -08001253{
1254 int eccsize = chip->ecc.size;
1255 int eccbytes = chip->ecc.bytes;
1256 uint8_t *oob = chip->oob_poi;
1257 int steps, size;
1258
1259 for (steps = chip->ecc.steps; steps > 0; steps--) {
1260 chip->read_buf(mtd, buf, eccsize);
1261 buf += eccsize;
1262
1263 if (chip->ecc.prepad) {
1264 chip->read_buf(mtd, oob, chip->ecc.prepad);
1265 oob += chip->ecc.prepad;
1266 }
1267
1268 chip->read_buf(mtd, oob, eccbytes);
1269 oob += eccbytes;
1270
1271 if (chip->ecc.postpad) {
1272 chip->read_buf(mtd, oob, chip->ecc.postpad);
1273 oob += chip->ecc.postpad;
1274 }
1275 }
1276
1277 size = mtd->oobsize - (oob - chip->oob_poi);
1278 if (size)
1279 chip->read_buf(mtd, oob, size);
1280
1281 return 0;
1282}
1283
1284/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001285 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001286 * @mtd: mtd info structure
1287 * @chip: nand chip info structure
1288 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001289 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001290 * @page: page number to read
David A. Marlin068e3c02005-01-24 03:07:46 +00001291 */
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001292static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001293 uint8_t *buf, int oob_required, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294{
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001295 int i, eccsize = chip->ecc.size;
1296 int eccbytes = chip->ecc.bytes;
1297 int eccsteps = chip->ecc.steps;
1298 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001299 uint8_t *ecc_calc = chip->buffers->ecccalc;
1300 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001301 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001302 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001303
Brian Norris1fbb9382012-05-02 10:14:55 -07001304 chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001305
1306 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1307 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1308
1309 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001310 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001311
1312 eccsteps = chip->ecc.steps;
1313 p = buf;
1314
1315 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1316 int stat;
1317
1318 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Mike Dunn3f91e942012-04-25 12:06:09 -07001319 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001320 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001321 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001322 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001323 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1324 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001325 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001326 return max_bitflips;
Thomas Gleixner22c60f52005-04-04 19:56:32 +01001327}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329/**
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05301330 * nand_read_subpage - [REPLACEABLE] ECC based sub-page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001331 * @mtd: mtd info structure
1332 * @chip: nand chip info structure
1333 * @data_offs: offset of requested data within the page
1334 * @readlen: data length
1335 * @bufpoi: buffer to store read data
Huang Shijiee004deb2014-01-03 11:01:40 +08001336 * @page: page number to read
Alexey Korolev3d459552008-05-15 17:23:18 +01001337 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001338static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
Huang Shijiee004deb2014-01-03 11:01:40 +08001339 uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi,
1340 int page)
Alexey Korolev3d459552008-05-15 17:23:18 +01001341{
1342 int start_step, end_step, num_steps;
1343 uint32_t *eccpos = chip->ecc.layout->eccpos;
1344 uint8_t *p;
1345 int data_col_addr, i, gaps = 0;
1346 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
1347 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
Ron4a4163c2014-03-16 04:01:07 +10301348 int index;
Mike Dunn3f91e942012-04-25 12:06:09 -07001349 unsigned int max_bitflips = 0;
Alexey Korolev3d459552008-05-15 17:23:18 +01001350
Brian Norris7854d3f2011-06-23 14:12:08 -07001351 /* Column address within the page aligned to ECC size (256bytes) */
Alexey Korolev3d459552008-05-15 17:23:18 +01001352 start_step = data_offs / chip->ecc.size;
1353 end_step = (data_offs + readlen - 1) / chip->ecc.size;
1354 num_steps = end_step - start_step + 1;
Ron4a4163c2014-03-16 04:01:07 +10301355 index = start_step * chip->ecc.bytes;
Alexey Korolev3d459552008-05-15 17:23:18 +01001356
Brian Norris8b6e50c2011-05-25 14:59:01 -07001357 /* Data size aligned to ECC ecc.size */
Alexey Korolev3d459552008-05-15 17:23:18 +01001358 datafrag_len = num_steps * chip->ecc.size;
1359 eccfrag_len = num_steps * chip->ecc.bytes;
1360
1361 data_col_addr = start_step * chip->ecc.size;
1362 /* If we read not a page aligned data */
1363 if (data_col_addr != 0)
1364 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
1365
1366 p = bufpoi + data_col_addr;
1367 chip->read_buf(mtd, p, datafrag_len);
1368
Brian Norris8b6e50c2011-05-25 14:59:01 -07001369 /* Calculate ECC */
Alexey Korolev3d459552008-05-15 17:23:18 +01001370 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1371 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1372
Brian Norris8b6e50c2011-05-25 14:59:01 -07001373 /*
1374 * The performance is faster if we position offsets according to
Brian Norris7854d3f2011-06-23 14:12:08 -07001375 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
Brian Norris8b6e50c2011-05-25 14:59:01 -07001376 */
Alexey Korolev3d459552008-05-15 17:23:18 +01001377 for (i = 0; i < eccfrag_len - 1; i++) {
Ron47570bb12014-03-16 04:01:08 +10301378 if (eccpos[i + index] + 1 != eccpos[i + index + 1]) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001379 gaps = 1;
1380 break;
1381 }
1382 }
1383 if (gaps) {
1384 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1385 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1386 } else {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001387 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07001388 * Send the command to read the particular ECC bytes take care
Brian Norris8b6e50c2011-05-25 14:59:01 -07001389 * about buswidth alignment in read_buf.
1390 */
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001391 aligned_pos = eccpos[index] & ~(busw - 1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001392 aligned_len = eccfrag_len;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001393 if (eccpos[index] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001394 aligned_len++;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001395 if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
Alexey Korolev3d459552008-05-15 17:23:18 +01001396 aligned_len++;
1397
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001398 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
1399 mtd->writesize + aligned_pos, -1);
Alexey Korolev3d459552008-05-15 17:23:18 +01001400 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1401 }
1402
1403 for (i = 0; i < eccfrag_len; i++)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001404 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
Alexey Korolev3d459552008-05-15 17:23:18 +01001405
1406 p = bufpoi + data_col_addr;
1407 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1408 int stat;
1409
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001410 stat = chip->ecc.correct(mtd, p,
1411 &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
Boris BREZILLON40cbe6e2015-12-30 20:32:04 +01001412 if (stat == -EBADMSG &&
1413 (chip->ecc.options & NAND_ECC_GENERIC_ERASED_CHECK)) {
1414 /* check for empty pages with bitflips */
1415 stat = nand_check_erased_ecc_chunk(p, chip->ecc.size,
1416 &chip->buffers->ecccode[i],
1417 chip->ecc.bytes,
1418 NULL, 0,
1419 chip->ecc.strength);
1420 }
1421
Mike Dunn3f91e942012-04-25 12:06:09 -07001422 if (stat < 0) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001423 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001424 } else {
Alexey Korolev3d459552008-05-15 17:23:18 +01001425 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001426 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1427 }
Alexey Korolev3d459552008-05-15 17:23:18 +01001428 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001429 return max_bitflips;
Alexey Korolev3d459552008-05-15 17:23:18 +01001430}
1431
1432/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001433 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001434 * @mtd: mtd info structure
1435 * @chip: nand chip info structure
1436 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001437 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001438 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001439 *
Brian Norris7854d3f2011-06-23 14:12:08 -07001440 * Not for syndrome calculating ECC controllers which need a special oob layout.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001441 */
1442static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001443 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001444{
1445 int i, eccsize = chip->ecc.size;
1446 int eccbytes = chip->ecc.bytes;
1447 int eccsteps = chip->ecc.steps;
1448 uint8_t *p = buf;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001449 uint8_t *ecc_calc = chip->buffers->ecccalc;
1450 uint8_t *ecc_code = chip->buffers->ecccode;
Ben Dooks8b099a32007-05-28 19:17:54 +01001451 uint32_t *eccpos = chip->ecc.layout->eccpos;
Mike Dunn3f91e942012-04-25 12:06:09 -07001452 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001453
1454 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1455 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1456 chip->read_buf(mtd, p, eccsize);
1457 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1458 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001459 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001460
1461 for (i = 0; i < chip->ecc.total; i++)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001462 ecc_code[i] = chip->oob_poi[eccpos[i]];
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001463
1464 eccsteps = chip->ecc.steps;
1465 p = buf;
1466
1467 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1468 int stat;
1469
1470 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Boris BREZILLON40cbe6e2015-12-30 20:32:04 +01001471 if (stat == -EBADMSG &&
1472 (chip->ecc.options & NAND_ECC_GENERIC_ERASED_CHECK)) {
1473 /* check for empty pages with bitflips */
1474 stat = nand_check_erased_ecc_chunk(p, eccsize,
1475 &ecc_code[i], eccbytes,
1476 NULL, 0,
1477 chip->ecc.strength);
1478 }
1479
Mike Dunn3f91e942012-04-25 12:06:09 -07001480 if (stat < 0) {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001481 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001482 } else {
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001483 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001484 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1485 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001486 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001487 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001488}
1489
1490/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001491 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
Brian Norris8b6e50c2011-05-25 14:59:01 -07001492 * @mtd: mtd info structure
1493 * @chip: nand chip info structure
1494 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001495 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001496 * @page: page number to read
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001497 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001498 * Hardware ECC for large page chips, require OOB to be read first. For this
1499 * ECC mode, the write_page method is re-used from ECC_HW. These methods
1500 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with
1501 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from
1502 * the data area, by overwriting the NAND manufacturer bad block markings.
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001503 */
1504static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07001505 struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001506{
1507 int i, eccsize = chip->ecc.size;
1508 int eccbytes = chip->ecc.bytes;
1509 int eccsteps = chip->ecc.steps;
1510 uint8_t *p = buf;
1511 uint8_t *ecc_code = chip->buffers->ecccode;
1512 uint32_t *eccpos = chip->ecc.layout->eccpos;
1513 uint8_t *ecc_calc = chip->buffers->ecccalc;
Mike Dunn3f91e942012-04-25 12:06:09 -07001514 unsigned int max_bitflips = 0;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001515
1516 /* Read the OOB area first */
1517 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1518 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1519 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1520
1521 for (i = 0; i < chip->ecc.total; i++)
1522 ecc_code[i] = chip->oob_poi[eccpos[i]];
1523
1524 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1525 int stat;
1526
1527 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1528 chip->read_buf(mtd, p, eccsize);
1529 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1530
1531 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
Boris BREZILLON40cbe6e2015-12-30 20:32:04 +01001532 if (stat == -EBADMSG &&
1533 (chip->ecc.options & NAND_ECC_GENERIC_ERASED_CHECK)) {
1534 /* check for empty pages with bitflips */
1535 stat = nand_check_erased_ecc_chunk(p, eccsize,
1536 &ecc_code[i], eccbytes,
1537 NULL, 0,
1538 chip->ecc.strength);
1539 }
1540
Mike Dunn3f91e942012-04-25 12:06:09 -07001541 if (stat < 0) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001542 mtd->ecc_stats.failed++;
Mike Dunn3f91e942012-04-25 12:06:09 -07001543 } else {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001544 mtd->ecc_stats.corrected += stat;
Mike Dunn3f91e942012-04-25 12:06:09 -07001545 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1546 }
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001547 }
Mike Dunn3f91e942012-04-25 12:06:09 -07001548 return max_bitflips;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07001549}
1550
1551/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001552 * nand_read_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page read
Brian Norris8b6e50c2011-05-25 14:59:01 -07001553 * @mtd: mtd info structure
1554 * @chip: nand chip info structure
1555 * @buf: buffer to store read data
Brian Norris1fbb9382012-05-02 10:14:55 -07001556 * @oob_required: caller requires OOB data read to chip->oob_poi
Brian Norris8b6e50c2011-05-25 14:59:01 -07001557 * @page: page number to read
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001558 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001559 * The hw generator calculates the error syndrome automatically. Therefore we
1560 * need a special oob layout and handling.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001561 */
1562static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Brian Norris1fbb9382012-05-02 10:14:55 -07001563 uint8_t *buf, int oob_required, int page)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001564{
1565 int i, eccsize = chip->ecc.size;
1566 int eccbytes = chip->ecc.bytes;
1567 int eccsteps = chip->ecc.steps;
Boris BREZILLON40cbe6e2015-12-30 20:32:04 +01001568 int eccpadbytes = eccbytes + chip->ecc.prepad + chip->ecc.postpad;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001569 uint8_t *p = buf;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02001570 uint8_t *oob = chip->oob_poi;
Mike Dunn3f91e942012-04-25 12:06:09 -07001571 unsigned int max_bitflips = 0;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001572
1573 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1574 int stat;
1575
1576 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1577 chip->read_buf(mtd, p, eccsize);
1578
1579 if (chip->ecc.prepad) {
1580 chip->read_buf(mtd, oob, chip->ecc.prepad);
1581 oob += chip->ecc.prepad;
1582 }
1583
1584 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1585 chip->read_buf(mtd, oob, eccbytes);
1586 stat = chip->ecc.correct(mtd, p, oob, NULL);
1587
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001588 oob += eccbytes;
1589
1590 if (chip->ecc.postpad) {
1591 chip->read_buf(mtd, oob, chip->ecc.postpad);
1592 oob += chip->ecc.postpad;
1593 }
Boris BREZILLON40cbe6e2015-12-30 20:32:04 +01001594
1595 if (stat == -EBADMSG &&
1596 (chip->ecc.options & NAND_ECC_GENERIC_ERASED_CHECK)) {
1597 /* check for empty pages with bitflips */
1598 stat = nand_check_erased_ecc_chunk(p, chip->ecc.size,
1599 oob - eccpadbytes,
1600 eccpadbytes,
1601 NULL, 0,
1602 chip->ecc.strength);
1603 }
1604
1605 if (stat < 0) {
1606 mtd->ecc_stats.failed++;
1607 } else {
1608 mtd->ecc_stats.corrected += stat;
1609 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1610 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001611 }
1612
1613 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04001614 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001615 if (i)
1616 chip->read_buf(mtd, oob, i);
1617
Mike Dunn3f91e942012-04-25 12:06:09 -07001618 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001619}
1620
1621/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001622 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
Brian Norris8b6e50c2011-05-25 14:59:01 -07001623 * @chip: nand chip structure
1624 * @oob: oob destination address
1625 * @ops: oob ops structure
1626 * @len: size of oob to transfer
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001627 */
1628static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
Vitaly Wool70145682006-11-03 18:20:38 +03001629 struct mtd_oob_ops *ops, size_t len)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001630{
Florian Fainellif8ac0412010-09-07 13:23:43 +02001631 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001632
Brian Norris0612b9d2011-08-30 18:45:40 -07001633 case MTD_OPS_PLACE_OOB:
1634 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001635 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1636 return oob + len;
1637
Brian Norris0612b9d2011-08-30 18:45:40 -07001638 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001639 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001640 uint32_t boffs = 0, roffs = ops->ooboffs;
1641 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001642
Florian Fainellif8ac0412010-09-07 13:23:43 +02001643 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07001644 /* Read request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001645 if (unlikely(roffs)) {
1646 if (roffs >= free->length) {
1647 roffs -= free->length;
1648 continue;
1649 }
1650 boffs = free->offset + roffs;
1651 bytes = min_t(size_t, len,
1652 (free->length - roffs));
1653 roffs = 0;
1654 } else {
1655 bytes = min_t(size_t, len, free->length);
1656 boffs = free->offset;
1657 }
1658 memcpy(oob, chip->oob_poi + boffs, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001659 oob += bytes;
1660 }
1661 return oob;
1662 }
1663 default:
1664 BUG();
1665 }
1666 return NULL;
1667}
1668
1669/**
Brian Norrisba84fb52014-01-03 15:13:33 -08001670 * nand_setup_read_retry - [INTERN] Set the READ RETRY mode
1671 * @mtd: MTD device structure
1672 * @retry_mode: the retry mode to use
1673 *
1674 * Some vendors supply a special command to shift the Vt threshold, to be used
1675 * when there are too many bitflips in a page (i.e., ECC error). After setting
1676 * a new threshold, the host should retry reading the page.
1677 */
1678static int nand_setup_read_retry(struct mtd_info *mtd, int retry_mode)
1679{
Boris BREZILLON862eba52015-12-01 12:03:03 +01001680 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norrisba84fb52014-01-03 15:13:33 -08001681
1682 pr_debug("setting READ RETRY mode %d\n", retry_mode);
1683
1684 if (retry_mode >= chip->read_retries)
1685 return -EINVAL;
1686
1687 if (!chip->setup_read_retry)
1688 return -EOPNOTSUPP;
1689
1690 return chip->setup_read_retry(mtd, retry_mode);
1691}
1692
1693/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001694 * nand_do_read_ops - [INTERN] Read data with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001695 * @mtd: MTD device structure
1696 * @from: offset to read from
1697 * @ops: oob ops structure
David A. Marlin068e3c02005-01-24 03:07:46 +00001698 *
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001699 * Internal function. Called with chip held.
David A. Marlin068e3c02005-01-24 03:07:46 +00001700 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001701static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1702 struct mtd_oob_ops *ops)
David A. Marlin068e3c02005-01-24 03:07:46 +00001703{
Brian Norrise47f3db2012-05-02 10:14:56 -07001704 int chipnr, page, realpage, col, bytes, aligned, oob_required;
Boris BREZILLON862eba52015-12-01 12:03:03 +01001705 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001706 int ret = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001707 uint32_t readlen = ops->len;
Vitaly Wool70145682006-11-03 18:20:38 +03001708 uint32_t oobreadlen = ops->ooblen;
Boris BREZILLON29f10582016-03-07 10:46:52 +01001709 uint32_t max_oobsize = mtd_oobavail(mtd, ops);
Maxim Levitsky9aca3342010-02-22 20:39:35 +02001710
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001711 uint8_t *bufpoi, *oob, *buf;
Kamal Dasu66507c72014-05-01 20:51:19 -04001712 int use_bufpoi;
Mike Dunnedbc45402012-04-25 12:06:11 -07001713 unsigned int max_bitflips = 0;
Brian Norrisba84fb52014-01-03 15:13:33 -08001714 int retry_mode = 0;
Brian Norrisb72f3df2013-12-03 11:04:14 -08001715 bool ecc_fail = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001717 chipnr = (int)(from >> chip->chip_shift);
1718 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001720 realpage = (int)(from >> chip->page_shift);
1721 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001723 col = (int)(from & (mtd->writesize - 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001725 buf = ops->datbuf;
1726 oob = ops->oobbuf;
Brian Norrise47f3db2012-05-02 10:14:56 -07001727 oob_required = oob ? 1 : 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001728
Florian Fainellif8ac0412010-09-07 13:23:43 +02001729 while (1) {
Brian Norrisb72f3df2013-12-03 11:04:14 -08001730 unsigned int ecc_failures = mtd->ecc_stats.failed;
1731
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001732 bytes = min(mtd->writesize - col, readlen);
1733 aligned = (bytes == mtd->writesize);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001734
Kamal Dasu66507c72014-05-01 20:51:19 -04001735 if (!aligned)
1736 use_bufpoi = 1;
1737 else if (chip->options & NAND_USE_BOUNCE_BUFFER)
1738 use_bufpoi = !virt_addr_valid(buf);
1739 else
1740 use_bufpoi = 0;
1741
Brian Norris8b6e50c2011-05-25 14:59:01 -07001742 /* Is the current page in the buffer? */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001743 if (realpage != chip->pagebuf || oob) {
Kamal Dasu66507c72014-05-01 20:51:19 -04001744 bufpoi = use_bufpoi ? chip->buffers->databuf : buf;
1745
1746 if (use_bufpoi && aligned)
1747 pr_debug("%s: using read bounce buffer for buf@%p\n",
1748 __func__, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749
Brian Norrisba84fb52014-01-03 15:13:33 -08001750read_retry:
Brian Norrisc00a0992012-05-01 17:12:54 -07001751 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752
Mike Dunnedbc45402012-04-25 12:06:11 -07001753 /*
1754 * Now read the page into the buffer. Absent an error,
1755 * the read methods return max bitflips per ecc step.
1756 */
Brian Norris0612b9d2011-08-30 18:45:40 -07001757 if (unlikely(ops->mode == MTD_OPS_RAW))
Brian Norris1fbb9382012-05-02 10:14:55 -07001758 ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
Brian Norrise47f3db2012-05-02 10:14:56 -07001759 oob_required,
1760 page);
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05001761 else if (!aligned && NAND_HAS_SUBPAGE_READ(chip) &&
1762 !oob)
Florian Fainelli7351d3a2010-09-07 13:23:45 +02001763 ret = chip->ecc.read_subpage(mtd, chip,
Huang Shijiee004deb2014-01-03 11:01:40 +08001764 col, bytes, bufpoi,
1765 page);
David Woodhouse956e9442006-09-25 17:12:39 +01001766 else
Sneha Narnakaje46a8cf22009-09-18 12:51:46 -07001767 ret = chip->ecc.read_page(mtd, chip, bufpoi,
Brian Norrise47f3db2012-05-02 10:14:56 -07001768 oob_required, page);
Brian Norris6d77b9d2011-09-07 13:13:40 -07001769 if (ret < 0) {
Kamal Dasu66507c72014-05-01 20:51:19 -04001770 if (use_bufpoi)
Brian Norris6d77b9d2011-09-07 13:13:40 -07001771 /* Invalidate page cache */
1772 chip->pagebuf = -1;
David Woodhousee0c7d762006-05-13 18:07:53 +01001773 break;
Brian Norris6d77b9d2011-09-07 13:13:40 -07001774 }
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001775
Mike Dunnedbc45402012-04-25 12:06:11 -07001776 max_bitflips = max_t(unsigned int, max_bitflips, ret);
1777
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001778 /* Transfer not aligned data */
Kamal Dasu66507c72014-05-01 20:51:19 -04001779 if (use_bufpoi) {
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05001780 if (!NAND_HAS_SUBPAGE_READ(chip) && !oob &&
Brian Norrisb72f3df2013-12-03 11:04:14 -08001781 !(mtd->ecc_stats.failed - ecc_failures) &&
Mike Dunnedbc45402012-04-25 12:06:11 -07001782 (ops->mode != MTD_OPS_RAW)) {
Alexey Korolev3d459552008-05-15 17:23:18 +01001783 chip->pagebuf = realpage;
Mike Dunnedbc45402012-04-25 12:06:11 -07001784 chip->pagebuf_bitflips = ret;
1785 } else {
Brian Norris6d77b9d2011-09-07 13:13:40 -07001786 /* Invalidate page cache */
1787 chip->pagebuf = -1;
Mike Dunnedbc45402012-04-25 12:06:11 -07001788 }
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001789 memcpy(buf, chip->buffers->databuf + col, bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001791
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001792 if (unlikely(oob)) {
Maxim Levitskyb64d39d2010-02-22 20:39:37 +02001793 int toread = min(oobreadlen, max_oobsize);
1794
1795 if (toread) {
1796 oob = nand_transfer_oob(chip,
1797 oob, ops, toread);
1798 oobreadlen -= toread;
1799 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001800 }
Brian Norris5bc7c332013-03-13 09:51:31 -07001801
1802 if (chip->options & NAND_NEED_READRDY) {
1803 /* Apply delay or wait for ready/busy pin */
1804 if (!chip->dev_ready)
1805 udelay(chip->chip_delay);
1806 else
1807 nand_wait_ready(mtd);
1808 }
Brian Norrisb72f3df2013-12-03 11:04:14 -08001809
Brian Norrisba84fb52014-01-03 15:13:33 -08001810 if (mtd->ecc_stats.failed - ecc_failures) {
Brian Norris28fa65e2014-02-12 16:08:28 -08001811 if (retry_mode + 1 < chip->read_retries) {
Brian Norrisba84fb52014-01-03 15:13:33 -08001812 retry_mode++;
1813 ret = nand_setup_read_retry(mtd,
1814 retry_mode);
1815 if (ret < 0)
1816 break;
1817
1818 /* Reset failures; retry */
1819 mtd->ecc_stats.failed = ecc_failures;
1820 goto read_retry;
1821 } else {
1822 /* No more retry modes; real failure */
1823 ecc_fail = true;
1824 }
1825 }
1826
1827 buf += bytes;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001828 } else {
David Woodhouse4bf63fc2006-09-25 17:08:04 +01001829 memcpy(buf, chip->buffers->databuf + col, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001830 buf += bytes;
Mike Dunnedbc45402012-04-25 12:06:11 -07001831 max_bitflips = max_t(unsigned int, max_bitflips,
1832 chip->pagebuf_bitflips);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001835 readlen -= bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001836
Brian Norrisba84fb52014-01-03 15:13:33 -08001837 /* Reset to retry mode 0 */
1838 if (retry_mode) {
1839 ret = nand_setup_read_retry(mtd, 0);
1840 if (ret < 0)
1841 break;
1842 retry_mode = 0;
1843 }
1844
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001845 if (!readlen)
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00001846 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
Brian Norris8b6e50c2011-05-25 14:59:01 -07001848 /* For subsequent reads align to page boundary */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 col = 0;
1850 /* Increment page address */
1851 realpage++;
1852
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001853 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 /* Check, if we cross a chip boundary */
1855 if (!page) {
1856 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02001857 chip->select_chip(mtd, -1);
1858 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 }
Huang Shijieb0bb6902012-11-19 14:43:29 +08001861 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02001863 ops->retlen = ops->len - (size_t) readlen;
Vitaly Wool70145682006-11-03 18:20:38 +03001864 if (oob)
1865 ops->oobretlen = ops->ooblen - oobreadlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866
Mike Dunn3f91e942012-04-25 12:06:09 -07001867 if (ret < 0)
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001868 return ret;
1869
Brian Norrisb72f3df2013-12-03 11:04:14 -08001870 if (ecc_fail)
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +02001871 return -EBADMSG;
1872
Mike Dunnedbc45402012-04-25 12:06:11 -07001873 return max_bitflips;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001874}
1875
1876/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001877 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
Brian Norris8b6e50c2011-05-25 14:59:01 -07001878 * @mtd: MTD device structure
1879 * @from: offset to read from
1880 * @len: number of bytes to read
1881 * @retlen: pointer to variable to store the number of read bytes
1882 * @buf: the databuffer to put data
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001883 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07001884 * Get hold of the chip and call nand_do_read.
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001885 */
1886static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1887 size_t *retlen, uint8_t *buf)
1888{
Brian Norris4a89ff82011-08-30 18:45:45 -07001889 struct mtd_oob_ops ops;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001890 int ret;
1891
Huang Shijie6a8214a2012-11-19 14:43:30 +08001892 nand_get_device(mtd, FL_READING);
Brian Norris0ec56dc2015-02-28 02:02:30 -08001893 memset(&ops, 0, sizeof(ops));
Brian Norris4a89ff82011-08-30 18:45:45 -07001894 ops.len = len;
1895 ops.datbuf = buf;
Huang Shijie11041ae2012-07-03 16:44:14 +08001896 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norris4a89ff82011-08-30 18:45:45 -07001897 ret = nand_do_read_ops(mtd, from, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07001898 *retlen = ops.retlen;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001899 nand_release_device(mtd);
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02001900 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901}
1902
1903/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001904 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001905 * @mtd: mtd info structure
1906 * @chip: nand chip info structure
1907 * @page: page number to read
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001908 */
1909static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001910 int page)
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001911{
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001912 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001913 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001914 return 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001915}
1916
1917/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001918 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001919 * with syndromes
Brian Norris8b6e50c2011-05-25 14:59:01 -07001920 * @mtd: mtd info structure
1921 * @chip: nand chip info structure
1922 * @page: page number to read
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001923 */
1924static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001925 int page)
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001926{
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001927 int length = mtd->oobsize;
1928 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1929 int eccsize = chip->ecc.size;
Baruch Siach2ea69d22015-01-22 15:23:05 +02001930 uint8_t *bufpoi = chip->oob_poi;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001931 int i, toread, sndrnd = 0, pos;
1932
1933 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1934 for (i = 0; i < chip->ecc.steps; i++) {
1935 if (sndrnd) {
1936 pos = eccsize + i * (eccsize + chunk);
1937 if (mtd->writesize > 512)
1938 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1939 else
1940 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1941 } else
1942 sndrnd = 1;
1943 toread = min_t(int, length, chunk);
1944 chip->read_buf(mtd, bufpoi, toread);
1945 bufpoi += toread;
1946 length -= toread;
1947 }
1948 if (length > 0)
1949 chip->read_buf(mtd, bufpoi, length);
1950
Shmulik Ladkani5c2ffb12012-05-09 13:06:35 +03001951 return 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001952}
1953
1954/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001955 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07001956 * @mtd: mtd info structure
1957 * @chip: nand chip info structure
1958 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001959 */
1960static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1961 int page)
1962{
1963 int status = 0;
1964 const uint8_t *buf = chip->oob_poi;
1965 int length = mtd->oobsize;
1966
1967 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1968 chip->write_buf(mtd, buf, length);
1969 /* Send command to program the OOB data */
1970 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1971
1972 status = chip->waitfunc(mtd, chip);
1973
Savin Zlobec0d420f92006-06-21 11:51:20 +02001974 return status & NAND_STATUS_FAIL ? -EIO : 0;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001975}
1976
1977/**
Brian Norris7854d3f2011-06-23 14:12:08 -07001978 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07001979 * with syndrome - only for large page flash
1980 * @mtd: mtd info structure
1981 * @chip: nand chip info structure
1982 * @page: page number to write
Thomas Gleixner7bc33122006-06-20 20:05:05 +02001983 */
1984static int nand_write_oob_syndrome(struct mtd_info *mtd,
1985 struct nand_chip *chip, int page)
1986{
1987 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1988 int eccsize = chip->ecc.size, length = mtd->oobsize;
1989 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1990 const uint8_t *bufpoi = chip->oob_poi;
1991
1992 /*
1993 * data-ecc-data-ecc ... ecc-oob
1994 * or
1995 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1996 */
1997 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1998 pos = steps * (eccsize + chunk);
1999 steps = 0;
2000 } else
Vitaly Wool8b0036e2006-07-11 09:11:25 +02002001 pos = eccsize;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002002
2003 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
2004 for (i = 0; i < steps; i++) {
2005 if (sndcmd) {
2006 if (mtd->writesize <= 512) {
2007 uint32_t fill = 0xFFFFFFFF;
2008
2009 len = eccsize;
2010 while (len > 0) {
2011 int num = min_t(int, len, 4);
2012 chip->write_buf(mtd, (uint8_t *)&fill,
2013 num);
2014 len -= num;
2015 }
2016 } else {
2017 pos = eccsize + i * (eccsize + chunk);
2018 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
2019 }
2020 } else
2021 sndcmd = 1;
2022 len = min_t(int, length, chunk);
2023 chip->write_buf(mtd, bufpoi, len);
2024 bufpoi += len;
2025 length -= len;
2026 }
2027 if (length > 0)
2028 chip->write_buf(mtd, bufpoi, length);
2029
2030 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
2031 status = chip->waitfunc(mtd, chip);
2032
2033 return status & NAND_STATUS_FAIL ? -EIO : 0;
2034}
2035
2036/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002037 * nand_do_read_oob - [INTERN] NAND read out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002038 * @mtd: MTD device structure
2039 * @from: offset to read from
2040 * @ops: oob operations description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002042 * NAND read out-of-band data from the spare area.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002044static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
2045 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046{
Brian Norrisc00a0992012-05-01 17:12:54 -07002047 int page, realpage, chipnr;
Boris BREZILLON862eba52015-12-01 12:03:03 +01002048 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norris041e4572011-06-23 16:45:24 -07002049 struct mtd_ecc_stats stats;
Vitaly Wool70145682006-11-03 18:20:38 +03002050 int readlen = ops->ooblen;
2051 int len;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002052 uint8_t *buf = ops->oobbuf;
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03002053 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
Brian Norris289c0522011-07-19 10:06:09 -07002055 pr_debug("%s: from = 0x%08Lx, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05302056 __func__, (unsigned long long)from, readlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057
Brian Norris041e4572011-06-23 16:45:24 -07002058 stats = mtd->ecc_stats;
2059
Boris BREZILLON29f10582016-03-07 10:46:52 +01002060 len = mtd_oobavail(mtd, ops);
Adrian Hunter03736152007-01-31 17:58:29 +02002061
2062 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002063 pr_debug("%s: attempt to start read outside oob\n",
2064 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002065 return -EINVAL;
2066 }
2067
2068 /* Do not allow reads past end of device */
2069 if (unlikely(from >= mtd->size ||
2070 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
2071 (from >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002072 pr_debug("%s: attempt to read beyond end of device\n",
2073 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002074 return -EINVAL;
2075 }
Vitaly Wool70145682006-11-03 18:20:38 +03002076
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002077 chipnr = (int)(from >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002078 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002080 /* Shift to get page */
2081 realpage = (int)(from >> chip->page_shift);
2082 page = realpage & chip->pagemask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
Florian Fainellif8ac0412010-09-07 13:23:43 +02002084 while (1) {
Brian Norris0612b9d2011-08-30 18:45:40 -07002085 if (ops->mode == MTD_OPS_RAW)
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03002086 ret = chip->ecc.read_oob_raw(mtd, chip, page);
Brian Norrisc46f6482011-08-30 18:45:38 -07002087 else
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03002088 ret = chip->ecc.read_oob(mtd, chip, page);
2089
2090 if (ret < 0)
2091 break;
Vitaly Wool70145682006-11-03 18:20:38 +03002092
2093 len = min(len, readlen);
2094 buf = nand_transfer_oob(chip, buf, ops, len);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002095
Brian Norris5bc7c332013-03-13 09:51:31 -07002096 if (chip->options & NAND_NEED_READRDY) {
2097 /* Apply delay or wait for ready/busy pin */
2098 if (!chip->dev_ready)
2099 udelay(chip->chip_delay);
2100 else
2101 nand_wait_ready(mtd);
2102 }
2103
Vitaly Wool70145682006-11-03 18:20:38 +03002104 readlen -= len;
Savin Zlobec0d420f92006-06-21 11:51:20 +02002105 if (!readlen)
2106 break;
2107
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002108 /* Increment page address */
2109 realpage++;
2110
2111 page = realpage & chip->pagemask;
2112 /* Check, if we cross a chip boundary */
2113 if (!page) {
2114 chipnr++;
2115 chip->select_chip(mtd, -1);
2116 chip->select_chip(mtd, chipnr);
2117 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 }
Huang Shijieb0bb6902012-11-19 14:43:29 +08002119 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
Shmulik Ladkani1951f2f2012-05-09 13:13:34 +03002121 ops->oobretlen = ops->ooblen - readlen;
2122
2123 if (ret < 0)
2124 return ret;
Brian Norris041e4572011-06-23 16:45:24 -07002125
2126 if (mtd->ecc_stats.failed - stats.failed)
2127 return -EBADMSG;
2128
2129 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130}
2131
2132/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002133 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002134 * @mtd: MTD device structure
2135 * @from: offset to read from
2136 * @ops: oob operation description structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002138 * NAND read data and/or out-of-band data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002140static int nand_read_oob(struct mtd_info *mtd, loff_t from,
2141 struct mtd_oob_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002143 int ret = -ENOTSUPP;
2144
2145 ops->retlen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 /* Do not allow reads past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002148 if (ops->datbuf && (from + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07002149 pr_debug("%s: attempt to read beyond end of device\n",
2150 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 return -EINVAL;
2152 }
2153
Huang Shijie6a8214a2012-11-19 14:43:30 +08002154 nand_get_device(mtd, FL_READING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Florian Fainellif8ac0412010-09-07 13:23:43 +02002156 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07002157 case MTD_OPS_PLACE_OOB:
2158 case MTD_OPS_AUTO_OOB:
2159 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002160 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002161
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002162 default:
2163 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 }
2165
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002166 if (!ops->datbuf)
2167 ret = nand_do_read_oob(mtd, from, ops);
2168 else
2169 ret = nand_do_read_ops(mtd, from, ops);
2170
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002171out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002173 return ret;
2174}
2175
2176
2177/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002178 * nand_write_page_raw - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002179 * @mtd: mtd info structure
2180 * @chip: nand chip info structure
2181 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002182 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002183 * @page: page number to write
David Brownell52ff49d2009-03-04 12:01:36 -08002184 *
Brian Norris7854d3f2011-06-23 14:12:08 -07002185 * Not for syndrome calculating ECC controllers, which use a special oob layout.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002186 */
Josh Wufdbad98d2012-06-25 18:07:45 +08002187static int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002188 const uint8_t *buf, int oob_required, int page)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002189{
2190 chip->write_buf(mtd, buf, mtd->writesize);
Brian Norris279f08d2012-05-02 10:15:03 -07002191 if (oob_required)
2192 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Josh Wufdbad98d2012-06-25 18:07:45 +08002193
2194 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195}
2196
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002197/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002198 * nand_write_page_raw_syndrome - [INTERN] raw page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002199 * @mtd: mtd info structure
2200 * @chip: nand chip info structure
2201 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002202 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002203 * @page: page number to write
David Brownell52ff49d2009-03-04 12:01:36 -08002204 *
2205 * We need a special oob layout and handling even when ECC isn't checked.
2206 */
Josh Wufdbad98d2012-06-25 18:07:45 +08002207static int nand_write_page_raw_syndrome(struct mtd_info *mtd,
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002208 struct nand_chip *chip,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002209 const uint8_t *buf, int oob_required,
2210 int page)
David Brownell52ff49d2009-03-04 12:01:36 -08002211{
2212 int eccsize = chip->ecc.size;
2213 int eccbytes = chip->ecc.bytes;
2214 uint8_t *oob = chip->oob_poi;
2215 int steps, size;
2216
2217 for (steps = chip->ecc.steps; steps > 0; steps--) {
2218 chip->write_buf(mtd, buf, eccsize);
2219 buf += eccsize;
2220
2221 if (chip->ecc.prepad) {
2222 chip->write_buf(mtd, oob, chip->ecc.prepad);
2223 oob += chip->ecc.prepad;
2224 }
2225
Boris BREZILLON60c3bc12014-02-01 19:10:28 +01002226 chip->write_buf(mtd, oob, eccbytes);
David Brownell52ff49d2009-03-04 12:01:36 -08002227 oob += eccbytes;
2228
2229 if (chip->ecc.postpad) {
2230 chip->write_buf(mtd, oob, chip->ecc.postpad);
2231 oob += chip->ecc.postpad;
2232 }
2233 }
2234
2235 size = mtd->oobsize - (oob - chip->oob_poi);
2236 if (size)
2237 chip->write_buf(mtd, oob, size);
Josh Wufdbad98d2012-06-25 18:07:45 +08002238
2239 return 0;
David Brownell52ff49d2009-03-04 12:01:36 -08002240}
2241/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002242 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002243 * @mtd: mtd info structure
2244 * @chip: nand chip info structure
2245 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002246 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002247 * @page: page number to write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002248 */
Josh Wufdbad98d2012-06-25 18:07:45 +08002249static int nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002250 const uint8_t *buf, int oob_required,
2251 int page)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002252{
2253 int i, eccsize = chip->ecc.size;
2254 int eccbytes = chip->ecc.bytes;
2255 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002256 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002257 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01002258 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002259
Brian Norris7854d3f2011-06-23 14:12:08 -07002260 /* Software ECC calculation */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002261 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
2262 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002263
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002264 for (i = 0; i < chip->ecc.total; i++)
2265 chip->oob_poi[eccpos[i]] = ecc_calc[i];
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002266
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002267 return chip->ecc.write_page_raw(mtd, chip, buf, 1, page);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002268}
2269
2270/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002271 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002272 * @mtd: mtd info structure
2273 * @chip: nand chip info structure
2274 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002275 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002276 * @page: page number to write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002277 */
Josh Wufdbad98d2012-06-25 18:07:45 +08002278static int nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002279 const uint8_t *buf, int oob_required,
2280 int page)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002281{
2282 int i, eccsize = chip->ecc.size;
2283 int eccbytes = chip->ecc.bytes;
2284 int eccsteps = chip->ecc.steps;
David Woodhouse4bf63fc2006-09-25 17:08:04 +01002285 uint8_t *ecc_calc = chip->buffers->ecccalc;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002286 const uint8_t *p = buf;
Ben Dooks8b099a32007-05-28 19:17:54 +01002287 uint32_t *eccpos = chip->ecc.layout->eccpos;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002288
2289 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2290 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
David Woodhouse29da9ce2006-05-26 23:05:44 +01002291 chip->write_buf(mtd, p, eccsize);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002292 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
2293 }
2294
2295 for (i = 0; i < chip->ecc.total; i++)
2296 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2297
2298 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Josh Wufdbad98d2012-06-25 18:07:45 +08002299
2300 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002301}
2302
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302303
2304/**
Brian Norris73c8aaf2015-02-28 02:04:18 -08002305 * nand_write_subpage_hwecc - [REPLACEABLE] hardware ECC based subpage write
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302306 * @mtd: mtd info structure
2307 * @chip: nand chip info structure
Brian Norrisd6a950802013-08-08 17:16:36 -07002308 * @offset: column address of subpage within the page
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302309 * @data_len: data length
Brian Norrisd6a950802013-08-08 17:16:36 -07002310 * @buf: data buffer
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302311 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002312 * @page: page number to write
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302313 */
2314static int nand_write_subpage_hwecc(struct mtd_info *mtd,
2315 struct nand_chip *chip, uint32_t offset,
Brian Norrisd6a950802013-08-08 17:16:36 -07002316 uint32_t data_len, const uint8_t *buf,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002317 int oob_required, int page)
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302318{
2319 uint8_t *oob_buf = chip->oob_poi;
2320 uint8_t *ecc_calc = chip->buffers->ecccalc;
2321 int ecc_size = chip->ecc.size;
2322 int ecc_bytes = chip->ecc.bytes;
2323 int ecc_steps = chip->ecc.steps;
2324 uint32_t *eccpos = chip->ecc.layout->eccpos;
2325 uint32_t start_step = offset / ecc_size;
2326 uint32_t end_step = (offset + data_len - 1) / ecc_size;
2327 int oob_bytes = mtd->oobsize / ecc_steps;
2328 int step, i;
2329
2330 for (step = 0; step < ecc_steps; step++) {
2331 /* configure controller for WRITE access */
2332 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2333
2334 /* write data (untouched subpages already masked by 0xFF) */
Brian Norrisd6a950802013-08-08 17:16:36 -07002335 chip->write_buf(mtd, buf, ecc_size);
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302336
2337 /* mask ECC of un-touched subpages by padding 0xFF */
2338 if ((step < start_step) || (step > end_step))
2339 memset(ecc_calc, 0xff, ecc_bytes);
2340 else
Brian Norrisd6a950802013-08-08 17:16:36 -07002341 chip->ecc.calculate(mtd, buf, ecc_calc);
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302342
2343 /* mask OOB of un-touched subpages by padding 0xFF */
2344 /* if oob_required, preserve OOB metadata of written subpage */
2345 if (!oob_required || (step < start_step) || (step > end_step))
2346 memset(oob_buf, 0xff, oob_bytes);
2347
Brian Norrisd6a950802013-08-08 17:16:36 -07002348 buf += ecc_size;
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302349 ecc_calc += ecc_bytes;
2350 oob_buf += oob_bytes;
2351 }
2352
2353 /* copy calculated ECC for whole page to chip->buffer->oob */
2354 /* this include masked-value(0xFF) for unwritten subpages */
2355 ecc_calc = chip->buffers->ecccalc;
2356 for (i = 0; i < chip->ecc.total; i++)
2357 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2358
2359 /* write OOB buffer to NAND device */
2360 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
2361
2362 return 0;
2363}
2364
2365
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002366/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002367 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
Brian Norris8b6e50c2011-05-25 14:59:01 -07002368 * @mtd: mtd info structure
2369 * @chip: nand chip info structure
2370 * @buf: data buffer
Brian Norris1fbb9382012-05-02 10:14:55 -07002371 * @oob_required: must write chip->oob_poi to OOB
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002372 * @page: page number to write
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002373 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002374 * The hw generator calculates the error syndrome automatically. Therefore we
2375 * need a special oob layout and handling.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002376 */
Josh Wufdbad98d2012-06-25 18:07:45 +08002377static int nand_write_page_syndrome(struct mtd_info *mtd,
Brian Norris1fbb9382012-05-02 10:14:55 -07002378 struct nand_chip *chip,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002379 const uint8_t *buf, int oob_required,
2380 int page)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002381{
2382 int i, eccsize = chip->ecc.size;
2383 int eccbytes = chip->ecc.bytes;
2384 int eccsteps = chip->ecc.steps;
2385 const uint8_t *p = buf;
2386 uint8_t *oob = chip->oob_poi;
2387
2388 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2389
2390 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2391 chip->write_buf(mtd, p, eccsize);
2392
2393 if (chip->ecc.prepad) {
2394 chip->write_buf(mtd, oob, chip->ecc.prepad);
2395 oob += chip->ecc.prepad;
2396 }
2397
2398 chip->ecc.calculate(mtd, p, oob);
2399 chip->write_buf(mtd, oob, eccbytes);
2400 oob += eccbytes;
2401
2402 if (chip->ecc.postpad) {
2403 chip->write_buf(mtd, oob, chip->ecc.postpad);
2404 oob += chip->ecc.postpad;
2405 }
2406 }
2407
2408 /* Calculate remaining oob bytes */
Vitaly Wool7e4178f2006-06-07 09:34:37 +04002409 i = mtd->oobsize - (oob - chip->oob_poi);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002410 if (i)
2411 chip->write_buf(mtd, oob, i);
Josh Wufdbad98d2012-06-25 18:07:45 +08002412
2413 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002414}
2415
2416/**
David Woodhouse956e9442006-09-25 17:12:39 +01002417 * nand_write_page - [REPLACEABLE] write one page
Brian Norris8b6e50c2011-05-25 14:59:01 -07002418 * @mtd: MTD device structure
2419 * @chip: NAND chip descriptor
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302420 * @offset: address offset within the page
2421 * @data_len: length of actual data to be written
Brian Norris8b6e50c2011-05-25 14:59:01 -07002422 * @buf: the data to write
Brian Norris1fbb9382012-05-02 10:14:55 -07002423 * @oob_required: must write chip->oob_poi to OOB
Brian Norris8b6e50c2011-05-25 14:59:01 -07002424 * @page: page number to write
2425 * @cached: cached programming
2426 * @raw: use _raw version of write_page
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002427 */
2428static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302429 uint32_t offset, int data_len, const uint8_t *buf,
2430 int oob_required, int page, int cached, int raw)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002431{
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302432 int status, subpage;
2433
2434 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
2435 chip->ecc.write_subpage)
2436 subpage = offset || (data_len < mtd->writesize);
2437 else
2438 subpage = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002439
2440 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
2441
David Woodhouse956e9442006-09-25 17:12:39 +01002442 if (unlikely(raw))
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302443 status = chip->ecc.write_page_raw(mtd, chip, buf,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002444 oob_required, page);
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302445 else if (subpage)
2446 status = chip->ecc.write_subpage(mtd, chip, offset, data_len,
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002447 buf, oob_required, page);
David Woodhouse956e9442006-09-25 17:12:39 +01002448 else
Boris BREZILLON45aaeff2015-10-13 11:22:18 +02002449 status = chip->ecc.write_page(mtd, chip, buf, oob_required,
2450 page);
Josh Wufdbad98d2012-06-25 18:07:45 +08002451
2452 if (status < 0)
2453 return status;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002454
2455 /*
Brian Norris7854d3f2011-06-23 14:12:08 -07002456 * Cached progamming disabled for now. Not sure if it's worth the
Brian Norris8b6e50c2011-05-25 14:59:01 -07002457 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002458 */
2459 cached = 0;
2460
Artem Bityutskiy3239a6c2013-03-04 14:56:18 +02002461 if (!cached || !NAND_HAS_CACHEPROG(chip)) {
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002462
2463 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002464 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002465 /*
2466 * See if operation failed and additional status checks are
Brian Norris8b6e50c2011-05-25 14:59:01 -07002467 * available.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002468 */
2469 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2470 status = chip->errstat(mtd, chip, FL_WRITING, status,
2471 page);
2472
2473 if (status & NAND_STATUS_FAIL)
2474 return -EIO;
2475 } else {
2476 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002477 status = chip->waitfunc(mtd, chip);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002478 }
2479
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002480 return 0;
2481}
2482
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002483/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002484 * nand_fill_oob - [INTERN] Transfer client buffer to oob
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002485 * @mtd: MTD device structure
Brian Norris8b6e50c2011-05-25 14:59:01 -07002486 * @oob: oob data buffer
2487 * @len: oob data write length
2488 * @ops: oob ops structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002489 */
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002490static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
2491 struct mtd_oob_ops *ops)
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002492{
Boris BREZILLON862eba52015-12-01 12:03:03 +01002493 struct nand_chip *chip = mtd_to_nand(mtd);
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002494
2495 /*
2496 * Initialise to all 0xFF, to avoid the possibility of left over OOB
2497 * data from a previous OOB read.
2498 */
2499 memset(chip->oob_poi, 0xff, mtd->oobsize);
2500
Florian Fainellif8ac0412010-09-07 13:23:43 +02002501 switch (ops->mode) {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002502
Brian Norris0612b9d2011-08-30 18:45:40 -07002503 case MTD_OPS_PLACE_OOB:
2504 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002505 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
2506 return oob + len;
2507
Brian Norris0612b9d2011-08-30 18:45:40 -07002508 case MTD_OPS_AUTO_OOB: {
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002509 struct nand_oobfree *free = chip->ecc.layout->oobfree;
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002510 uint32_t boffs = 0, woffs = ops->ooboffs;
2511 size_t bytes = 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002512
Florian Fainellif8ac0412010-09-07 13:23:43 +02002513 for (; free->length && len; free++, len -= bytes) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07002514 /* Write request not from offset 0? */
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002515 if (unlikely(woffs)) {
2516 if (woffs >= free->length) {
2517 woffs -= free->length;
2518 continue;
2519 }
2520 boffs = free->offset + woffs;
2521 bytes = min_t(size_t, len,
2522 (free->length - woffs));
2523 woffs = 0;
2524 } else {
2525 bytes = min_t(size_t, len, free->length);
2526 boffs = free->offset;
2527 }
Vitaly Wool8b0036e2006-07-11 09:11:25 +02002528 memcpy(chip->oob_poi + boffs, oob, bytes);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002529 oob += bytes;
2530 }
2531 return oob;
2532 }
2533 default:
2534 BUG();
2535 }
2536 return NULL;
2537}
2538
Florian Fainellif8ac0412010-09-07 13:23:43 +02002539#define NOTALIGNED(x) ((x & (chip->subpagesize - 1)) != 0)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002540
2541/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002542 * nand_do_write_ops - [INTERN] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002543 * @mtd: MTD device structure
2544 * @to: offset to write to
2545 * @ops: oob operations description structure
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002546 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002547 * NAND write with ECC.
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002548 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002549static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
2550 struct mtd_oob_ops *ops)
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002551{
Thomas Gleixner29072b92006-09-28 15:38:36 +02002552 int chipnr, realpage, page, blockmask, column;
Boris BREZILLON862eba52015-12-01 12:03:03 +01002553 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002554 uint32_t writelen = ops->len;
Maxim Levitsky782ce792010-02-22 20:39:36 +02002555
2556 uint32_t oobwritelen = ops->ooblen;
Boris BREZILLON29f10582016-03-07 10:46:52 +01002557 uint32_t oobmaxlen = mtd_oobavail(mtd, ops);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002558
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002559 uint8_t *oob = ops->oobbuf;
2560 uint8_t *buf = ops->datbuf;
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302561 int ret;
Brian Norrise47f3db2012-05-02 10:14:56 -07002562 int oob_required = oob ? 1 : 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002563
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002564 ops->retlen = 0;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002565 if (!writelen)
2566 return 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002567
Brian Norris8b6e50c2011-05-25 14:59:01 -07002568 /* Reject writes, which are not page aligned */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002569 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002570 pr_notice("%s: attempt to write non page aligned data\n",
2571 __func__);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002572 return -EINVAL;
2573 }
2574
Thomas Gleixner29072b92006-09-28 15:38:36 +02002575 column = to & (mtd->writesize - 1);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002576
Thomas Gleixner6a930962006-06-28 00:11:45 +02002577 chipnr = (int)(to >> chip->chip_shift);
2578 chip->select_chip(mtd, chipnr);
2579
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002580 /* Check, if it is write protected */
Huang Shijieb0bb6902012-11-19 14:43:29 +08002581 if (nand_check_wp(mtd)) {
2582 ret = -EIO;
2583 goto err_out;
2584 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002585
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002586 realpage = (int)(to >> chip->page_shift);
2587 page = realpage & chip->pagemask;
2588 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2589
2590 /* Invalidate the page cache, when we write to the cached page */
Brian Norris537ab1b2014-07-21 19:08:03 -07002591 if (to <= ((loff_t)chip->pagebuf << chip->page_shift) &&
2592 ((loff_t)chip->pagebuf << chip->page_shift) < (to + ops->len))
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002593 chip->pagebuf = -1;
2594
Maxim Levitsky782ce792010-02-22 20:39:36 +02002595 /* Don't allow multipage oob writes with offset */
Huang Shijieb0bb6902012-11-19 14:43:29 +08002596 if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen)) {
2597 ret = -EINVAL;
2598 goto err_out;
2599 }
Maxim Levitsky782ce792010-02-22 20:39:36 +02002600
Florian Fainellif8ac0412010-09-07 13:23:43 +02002601 while (1) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02002602 int bytes = mtd->writesize;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002603 int cached = writelen > bytes && page != blockmask;
Thomas Gleixner29072b92006-09-28 15:38:36 +02002604 uint8_t *wbuf = buf;
Kamal Dasu66507c72014-05-01 20:51:19 -04002605 int use_bufpoi;
2606 int part_pagewr = (column || writelen < (mtd->writesize - 1));
Thomas Gleixner29072b92006-09-28 15:38:36 +02002607
Kamal Dasu66507c72014-05-01 20:51:19 -04002608 if (part_pagewr)
2609 use_bufpoi = 1;
2610 else if (chip->options & NAND_USE_BOUNCE_BUFFER)
2611 use_bufpoi = !virt_addr_valid(buf);
2612 else
2613 use_bufpoi = 0;
2614
2615 /* Partial page write?, or need to use bounce buffer */
2616 if (use_bufpoi) {
2617 pr_debug("%s: using write bounce buffer for buf@%p\n",
2618 __func__, buf);
Thomas Gleixner29072b92006-09-28 15:38:36 +02002619 cached = 0;
Kamal Dasu66507c72014-05-01 20:51:19 -04002620 if (part_pagewr)
2621 bytes = min_t(int, bytes - column, writelen);
Thomas Gleixner29072b92006-09-28 15:38:36 +02002622 chip->pagebuf = -1;
2623 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2624 memcpy(&chip->buffers->databuf[column], buf, bytes);
2625 wbuf = chip->buffers->databuf;
2626 }
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002627
Maxim Levitsky782ce792010-02-22 20:39:36 +02002628 if (unlikely(oob)) {
2629 size_t len = min(oobwritelen, oobmaxlen);
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002630 oob = nand_fill_oob(mtd, oob, len, ops);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002631 oobwritelen -= len;
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002632 } else {
2633 /* We still need to erase leftover OOB data */
2634 memset(chip->oob_poi, 0xff, mtd->oobsize);
Maxim Levitsky782ce792010-02-22 20:39:36 +02002635 }
Gupta, Pekon837a6ba2013-03-15 17:55:53 +05302636 ret = chip->write_page(mtd, chip, column, bytes, wbuf,
2637 oob_required, page, cached,
2638 (ops->mode == MTD_OPS_RAW));
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002639 if (ret)
2640 break;
2641
2642 writelen -= bytes;
2643 if (!writelen)
2644 break;
2645
Thomas Gleixner29072b92006-09-28 15:38:36 +02002646 column = 0;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002647 buf += bytes;
2648 realpage++;
2649
2650 page = realpage & chip->pagemask;
2651 /* Check, if we cross a chip boundary */
2652 if (!page) {
2653 chipnr++;
2654 chip->select_chip(mtd, -1);
2655 chip->select_chip(mtd, chipnr);
2656 }
2657 }
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002658
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002659 ops->retlen = ops->len - writelen;
Vitaly Wool70145682006-11-03 18:20:38 +03002660 if (unlikely(oob))
2661 ops->oobretlen = ops->ooblen;
Huang Shijieb0bb6902012-11-19 14:43:29 +08002662
2663err_out:
2664 chip->select_chip(mtd, -1);
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02002665 return ret;
2666}
2667
2668/**
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002669 * panic_nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002670 * @mtd: MTD device structure
2671 * @to: offset to write to
2672 * @len: number of bytes to write
2673 * @retlen: pointer to variable to store the number of written bytes
2674 * @buf: the data to write
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002675 *
2676 * NAND write with ECC. Used when performing writes in interrupt context, this
2677 * may for example be called by mtdoops when writing an oops while in panic.
2678 */
2679static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2680 size_t *retlen, const uint8_t *buf)
2681{
Boris BREZILLON862eba52015-12-01 12:03:03 +01002682 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norris4a89ff82011-08-30 18:45:45 -07002683 struct mtd_oob_ops ops;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002684 int ret;
2685
Brian Norris8b6e50c2011-05-25 14:59:01 -07002686 /* Wait for the device to get ready */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002687 panic_nand_wait(mtd, chip, 400);
2688
Brian Norris8b6e50c2011-05-25 14:59:01 -07002689 /* Grab the device */
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002690 panic_nand_get_device(chip, mtd, FL_WRITING);
2691
Brian Norris0ec56dc2015-02-28 02:02:30 -08002692 memset(&ops, 0, sizeof(ops));
Brian Norris4a89ff82011-08-30 18:45:45 -07002693 ops.len = len;
2694 ops.datbuf = (uint8_t *)buf;
Huang Shijie11041ae2012-07-03 16:44:14 +08002695 ops.mode = MTD_OPS_PLACE_OOB;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002696
Brian Norris4a89ff82011-08-30 18:45:45 -07002697 ret = nand_do_write_ops(mtd, to, &ops);
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002698
Brian Norris4a89ff82011-08-30 18:45:45 -07002699 *retlen = ops.retlen;
Simon Kagstrom2af7c652009-10-05 15:55:52 +02002700 return ret;
2701}
2702
2703/**
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002704 * nand_write - [MTD Interface] NAND write with ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07002705 * @mtd: MTD device structure
2706 * @to: offset to write to
2707 * @len: number of bytes to write
2708 * @retlen: pointer to variable to store the number of written bytes
2709 * @buf: the data to write
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002711 * NAND write with ECC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 */
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002713static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002714 size_t *retlen, const uint8_t *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715{
Brian Norris4a89ff82011-08-30 18:45:45 -07002716 struct mtd_oob_ops ops;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002717 int ret;
2718
Huang Shijie6a8214a2012-11-19 14:43:30 +08002719 nand_get_device(mtd, FL_WRITING);
Brian Norris0ec56dc2015-02-28 02:02:30 -08002720 memset(&ops, 0, sizeof(ops));
Brian Norris4a89ff82011-08-30 18:45:45 -07002721 ops.len = len;
2722 ops.datbuf = (uint8_t *)buf;
Huang Shijie11041ae2012-07-03 16:44:14 +08002723 ops.mode = MTD_OPS_PLACE_OOB;
Brian Norris4a89ff82011-08-30 18:45:45 -07002724 ret = nand_do_write_ops(mtd, to, &ops);
Brian Norris4a89ff82011-08-30 18:45:45 -07002725 *retlen = ops.retlen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002726 nand_release_device(mtd);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002727 return ret;
2728}
2729
2730/**
2731 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002732 * @mtd: MTD device structure
2733 * @to: offset to write to
2734 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002735 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002736 * NAND write out-of-band.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002737 */
2738static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2739 struct mtd_oob_ops *ops)
2740{
Adrian Hunter03736152007-01-31 17:58:29 +02002741 int chipnr, page, status, len;
Boris BREZILLON862eba52015-12-01 12:03:03 +01002742 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743
Brian Norris289c0522011-07-19 10:06:09 -07002744 pr_debug("%s: to = 0x%08x, len = %i\n",
vimal singh20d8e242009-07-07 15:49:49 +05302745 __func__, (unsigned int)to, (int)ops->ooblen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746
Boris BREZILLON29f10582016-03-07 10:46:52 +01002747 len = mtd_oobavail(mtd, ops);
Adrian Hunter03736152007-01-31 17:58:29 +02002748
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749 /* Do not allow write past end of page */
Adrian Hunter03736152007-01-31 17:58:29 +02002750 if ((ops->ooboffs + ops->ooblen) > len) {
Brian Norris289c0522011-07-19 10:06:09 -07002751 pr_debug("%s: attempt to write past end of page\n",
2752 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 return -EINVAL;
2754 }
2755
Adrian Hunter03736152007-01-31 17:58:29 +02002756 if (unlikely(ops->ooboffs >= len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002757 pr_debug("%s: attempt to start write outside oob\n",
2758 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002759 return -EINVAL;
2760 }
2761
Jason Liu775adc32011-02-25 13:06:18 +08002762 /* Do not allow write past end of device */
Adrian Hunter03736152007-01-31 17:58:29 +02002763 if (unlikely(to >= mtd->size ||
2764 ops->ooboffs + ops->ooblen >
2765 ((mtd->size >> chip->page_shift) -
2766 (to >> chip->page_shift)) * len)) {
Brian Norris289c0522011-07-19 10:06:09 -07002767 pr_debug("%s: attempt to write beyond end of device\n",
2768 __func__);
Adrian Hunter03736152007-01-31 17:58:29 +02002769 return -EINVAL;
2770 }
2771
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002772 chipnr = (int)(to >> chip->chip_shift);
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002773 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774
Thomas Gleixner7314e9e2006-05-25 09:51:54 +02002775 /* Shift to get page */
2776 page = (int)(to >> chip->page_shift);
2777
2778 /*
2779 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2780 * of my DiskOnChip 2000 test units) will clear the whole data page too
2781 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2782 * it in the doc2000 driver in August 1999. dwmw2.
2783 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002784 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785
2786 /* Check, if it is write protected */
Huang Shijieb0bb6902012-11-19 14:43:29 +08002787 if (nand_check_wp(mtd)) {
2788 chip->select_chip(mtd, -1);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002789 return -EROFS;
Huang Shijieb0bb6902012-11-19 14:43:29 +08002790 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002791
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 /* Invalidate the page cache, if we write to the cached page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002793 if (page == chip->pagebuf)
2794 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795
THOMSON, Adam (Adam)f7220132011-06-14 16:52:38 +02002796 nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
Brian Norris9ce244b2011-08-30 18:45:37 -07002797
Brian Norris0612b9d2011-08-30 18:45:40 -07002798 if (ops->mode == MTD_OPS_RAW)
Brian Norris9ce244b2011-08-30 18:45:37 -07002799 status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
2800 else
2801 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002802
Huang Shijieb0bb6902012-11-19 14:43:29 +08002803 chip->select_chip(mtd, -1);
2804
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002805 if (status)
2806 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807
Vitaly Wool70145682006-11-03 18:20:38 +03002808 ops->oobretlen = ops->ooblen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809
Thomas Gleixner7bc33122006-06-20 20:05:05 +02002810 return 0;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002811}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002813/**
2814 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
Brian Norris8b6e50c2011-05-25 14:59:01 -07002815 * @mtd: MTD device structure
2816 * @to: offset to write to
2817 * @ops: oob operation description structure
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002818 */
2819static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2820 struct mtd_oob_ops *ops)
2821{
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002822 int ret = -ENOTSUPP;
2823
2824 ops->retlen = 0;
2825
2826 /* Do not allow writes past end of device */
Vitaly Wool70145682006-11-03 18:20:38 +03002827 if (ops->datbuf && (to + ops->len) > mtd->size) {
Brian Norris289c0522011-07-19 10:06:09 -07002828 pr_debug("%s: attempt to write beyond end of device\n",
2829 __func__);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002830 return -EINVAL;
2831 }
2832
Huang Shijie6a8214a2012-11-19 14:43:30 +08002833 nand_get_device(mtd, FL_WRITING);
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002834
Florian Fainellif8ac0412010-09-07 13:23:43 +02002835 switch (ops->mode) {
Brian Norris0612b9d2011-08-30 18:45:40 -07002836 case MTD_OPS_PLACE_OOB:
2837 case MTD_OPS_AUTO_OOB:
2838 case MTD_OPS_RAW:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002839 break;
2840
2841 default:
2842 goto out;
2843 }
2844
2845 if (!ops->datbuf)
2846 ret = nand_do_write_oob(mtd, to, ops);
2847 else
2848 ret = nand_do_write_ops(mtd, to, ops);
2849
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002850out:
Thomas Gleixner8593fbc2006-05-29 03:26:58 +02002851 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852 return ret;
2853}
2854
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855/**
Brian Norris49c50b92014-05-06 16:02:19 -07002856 * single_erase - [GENERIC] NAND standard block erase command function
Brian Norris8b6e50c2011-05-25 14:59:01 -07002857 * @mtd: MTD device structure
2858 * @page: the page address of the block which will be erased
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859 *
Brian Norris49c50b92014-05-06 16:02:19 -07002860 * Standard erase command for NAND chips. Returns NAND status.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 */
Brian Norris49c50b92014-05-06 16:02:19 -07002862static int single_erase(struct mtd_info *mtd, int page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863{
Boris BREZILLON862eba52015-12-01 12:03:03 +01002864 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865 /* Send commands to erase a block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002866 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2867 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Brian Norris49c50b92014-05-06 16:02:19 -07002868
2869 return chip->waitfunc(mtd, chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870}
2871
2872/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 * nand_erase - [MTD Interface] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002874 * @mtd: MTD device structure
2875 * @instr: erase instruction
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002877 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 */
David Woodhousee0c7d762006-05-13 18:07:53 +01002879static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880{
David Woodhousee0c7d762006-05-13 18:07:53 +01002881 return nand_erase_nand(mtd, instr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882}
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002883
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884/**
Brian Norris7854d3f2011-06-23 14:12:08 -07002885 * nand_erase_nand - [INTERN] erase block(s)
Brian Norris8b6e50c2011-05-25 14:59:01 -07002886 * @mtd: MTD device structure
2887 * @instr: erase instruction
2888 * @allowbbt: allow erasing the bbt area
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07002890 * Erase one ore more blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002892int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2893 int allowbbt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894{
Adrian Hunter69423d92008-12-10 13:37:21 +00002895 int page, status, pages_per_block, ret, chipnr;
Boris BREZILLON862eba52015-12-01 12:03:03 +01002896 struct nand_chip *chip = mtd_to_nand(mtd);
Adrian Hunter69423d92008-12-10 13:37:21 +00002897 loff_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898
Brian Norris289c0522011-07-19 10:06:09 -07002899 pr_debug("%s: start = 0x%012llx, len = %llu\n",
2900 __func__, (unsigned long long)instr->addr,
2901 (unsigned long long)instr->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
Vimal Singh6fe5a6a2010-02-03 14:12:24 +05302903 if (check_offs_len(mtd, instr->addr, instr->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 /* Grab the lock and see if the device is available */
Huang Shijie6a8214a2012-11-19 14:43:30 +08002907 nand_get_device(mtd, FL_ERASING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908
2909 /* Shift to get first page */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002910 page = (int)(instr->addr >> chip->page_shift);
2911 chipnr = (int)(instr->addr >> chip->chip_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912
2913 /* Calculate pages in each block */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002914 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002915
2916 /* Select the NAND device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002917 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919 /* Check, if it is write protected */
2920 if (nand_check_wp(mtd)) {
Brian Norris289c0522011-07-19 10:06:09 -07002921 pr_debug("%s: device is write protected!\n",
2922 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923 instr->state = MTD_ERASE_FAILED;
2924 goto erase_exit;
2925 }
2926
2927 /* Loop through the pages */
2928 len = instr->len;
2929
2930 instr->state = MTD_ERASING;
2931
2932 while (len) {
Wolfram Sang12183a22011-12-21 23:01:20 +01002933 /* Check if we have a bad block, we do not erase bad blocks! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002934 if (nand_block_checkbad(mtd, ((loff_t) page) <<
Archit Taneja9f3e0422016-02-03 14:29:49 +05302935 chip->page_shift, allowbbt)) {
Brian Norrisd0370212011-07-19 10:06:08 -07002936 pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
2937 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 instr->state = MTD_ERASE_FAILED;
2939 goto erase_exit;
2940 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00002941
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002942 /*
2943 * Invalidate the page cache, if we erase the block which
Brian Norris8b6e50c2011-05-25 14:59:01 -07002944 * contains the current cached page.
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002945 */
2946 if (page <= chip->pagebuf && chip->pagebuf <
2947 (page + pages_per_block))
2948 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949
Brian Norris49c50b92014-05-06 16:02:19 -07002950 status = chip->erase(mtd, page & chip->pagemask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002952 /*
2953 * See if operation failed and additional status checks are
2954 * available
2955 */
2956 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2957 status = chip->errstat(mtd, chip, FL_ERASING,
2958 status, page);
David A. Marlin068e3c02005-01-24 03:07:46 +00002959
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 /* See if block erase succeeded */
David A. Marlina4ab4c52005-01-23 18:30:53 +00002961 if (status & NAND_STATUS_FAIL) {
Brian Norris289c0522011-07-19 10:06:09 -07002962 pr_debug("%s: failed erase, page 0x%08x\n",
2963 __func__, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 instr->state = MTD_ERASE_FAILED;
Adrian Hunter69423d92008-12-10 13:37:21 +00002965 instr->fail_addr =
2966 ((loff_t)page << chip->page_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967 goto erase_exit;
2968 }
David A. Marlin30f464b2005-01-17 18:35:25 +00002969
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970 /* Increment page address and decrement length */
Dan Carpenterdaae74c2013-08-09 12:49:05 +03002971 len -= (1ULL << chip->phys_erase_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972 page += pages_per_block;
2973
2974 /* Check, if we cross a chip boundary */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002975 if (len && !(page & chip->pagemask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 chipnr++;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02002977 chip->select_chip(mtd, -1);
2978 chip->select_chip(mtd, chipnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979 }
2980 }
2981 instr->state = MTD_ERASE_DONE;
2982
Florian Fainelli7351d3a2010-09-07 13:23:45 +02002983erase_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984
2985 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986
2987 /* Deselect and wake up anyone waiting on the device */
Huang Shijieb0bb6902012-11-19 14:43:29 +08002988 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989 nand_release_device(mtd);
2990
David Woodhouse49defc02007-10-06 15:01:59 -04002991 /* Do call back function */
2992 if (!ret)
2993 mtd_erase_callback(instr);
2994
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995 /* Return more or less happy */
2996 return ret;
2997}
2998
2999/**
3000 * nand_sync - [MTD Interface] sync
Brian Norris8b6e50c2011-05-25 14:59:01 -07003001 * @mtd: MTD device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07003003 * Sync is actually a wait for chip ready function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004 */
David Woodhousee0c7d762006-05-13 18:07:53 +01003005static void nand_sync(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006{
Brian Norris289c0522011-07-19 10:06:09 -07003007 pr_debug("%s: called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008
3009 /* Grab the lock and see if the device is available */
Huang Shijie6a8214a2012-11-19 14:43:30 +08003010 nand_get_device(mtd, FL_SYNCING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 /* Release it and go back */
David Woodhousee0c7d762006-05-13 18:07:53 +01003012 nand_release_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013}
3014
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003016 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07003017 * @mtd: MTD device structure
3018 * @offs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003020static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003021{
Archit Taneja9f3e0422016-02-03 14:29:49 +05303022 struct nand_chip *chip = mtd_to_nand(mtd);
3023 int chipnr = (int)(offs >> chip->chip_shift);
3024 int ret;
3025
3026 /* Select the NAND device */
3027 nand_get_device(mtd, FL_READING);
3028 chip->select_chip(mtd, chipnr);
3029
3030 ret = nand_block_checkbad(mtd, offs, 0);
3031
3032 chip->select_chip(mtd, -1);
3033 nand_release_device(mtd);
3034
3035 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036}
3037
3038/**
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003039 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Brian Norris8b6e50c2011-05-25 14:59:01 -07003040 * @mtd: MTD device structure
3041 * @ofs: offset relative to mtd start
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042 */
David Woodhousee0c7d762006-05-13 18:07:53 +01003043static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045 int ret;
3046
Florian Fainellif8ac0412010-09-07 13:23:43 +02003047 ret = nand_block_isbad(mtd, ofs);
3048 if (ret) {
Brian Norris8b6e50c2011-05-25 14:59:01 -07003049 /* If it was bad already, return success and do nothing */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050 if (ret > 0)
3051 return 0;
David Woodhousee0c7d762006-05-13 18:07:53 +01003052 return ret;
3053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054
Brian Norris5a0edb22013-07-30 17:52:58 -07003055 return nand_block_markbad_lowlevel(mtd, ofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056}
3057
3058/**
Huang Shijie7db03ec2012-09-13 14:57:52 +08003059 * nand_onfi_set_features- [REPLACEABLE] set features for ONFI nand
3060 * @mtd: MTD device structure
3061 * @chip: nand chip info structure
3062 * @addr: feature address.
3063 * @subfeature_param: the subfeature parameters, a four bytes array.
3064 */
3065static int nand_onfi_set_features(struct mtd_info *mtd, struct nand_chip *chip,
3066 int addr, uint8_t *subfeature_param)
3067{
3068 int status;
Uwe Kleine-König05f78352013-12-05 22:22:04 +01003069 int i;
Huang Shijie7db03ec2012-09-13 14:57:52 +08003070
David Mosbergerd914c932013-05-29 15:30:13 +03003071 if (!chip->onfi_version ||
3072 !(le16_to_cpu(chip->onfi_params.opt_cmd)
3073 & ONFI_OPT_CMD_SET_GET_FEATURES))
Huang Shijie7db03ec2012-09-13 14:57:52 +08003074 return -EINVAL;
3075
3076 chip->cmdfunc(mtd, NAND_CMD_SET_FEATURES, addr, -1);
Uwe Kleine-König05f78352013-12-05 22:22:04 +01003077 for (i = 0; i < ONFI_SUBFEATURE_PARAM_LEN; ++i)
3078 chip->write_byte(mtd, subfeature_param[i]);
3079
Huang Shijie7db03ec2012-09-13 14:57:52 +08003080 status = chip->waitfunc(mtd, chip);
3081 if (status & NAND_STATUS_FAIL)
3082 return -EIO;
3083 return 0;
3084}
3085
3086/**
3087 * nand_onfi_get_features- [REPLACEABLE] get features for ONFI nand
3088 * @mtd: MTD device structure
3089 * @chip: nand chip info structure
3090 * @addr: feature address.
3091 * @subfeature_param: the subfeature parameters, a four bytes array.
3092 */
3093static int nand_onfi_get_features(struct mtd_info *mtd, struct nand_chip *chip,
3094 int addr, uint8_t *subfeature_param)
3095{
Uwe Kleine-König05f78352013-12-05 22:22:04 +01003096 int i;
3097
David Mosbergerd914c932013-05-29 15:30:13 +03003098 if (!chip->onfi_version ||
3099 !(le16_to_cpu(chip->onfi_params.opt_cmd)
3100 & ONFI_OPT_CMD_SET_GET_FEATURES))
Huang Shijie7db03ec2012-09-13 14:57:52 +08003101 return -EINVAL;
3102
Huang Shijie7db03ec2012-09-13 14:57:52 +08003103 chip->cmdfunc(mtd, NAND_CMD_GET_FEATURES, addr, -1);
Uwe Kleine-König05f78352013-12-05 22:22:04 +01003104 for (i = 0; i < ONFI_SUBFEATURE_PARAM_LEN; ++i)
3105 *subfeature_param++ = chip->read_byte(mtd);
Huang Shijie7db03ec2012-09-13 14:57:52 +08003106 return 0;
3107}
3108
3109/**
Vitaly Wool962034f2005-09-15 14:58:53 +01003110 * nand_suspend - [MTD Interface] Suspend the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07003111 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01003112 */
3113static int nand_suspend(struct mtd_info *mtd)
3114{
Huang Shijie6a8214a2012-11-19 14:43:30 +08003115 return nand_get_device(mtd, FL_PM_SUSPENDED);
Vitaly Wool962034f2005-09-15 14:58:53 +01003116}
3117
3118/**
3119 * nand_resume - [MTD Interface] Resume the NAND flash
Brian Norris8b6e50c2011-05-25 14:59:01 -07003120 * @mtd: MTD device structure
Vitaly Wool962034f2005-09-15 14:58:53 +01003121 */
3122static void nand_resume(struct mtd_info *mtd)
3123{
Boris BREZILLON862eba52015-12-01 12:03:03 +01003124 struct nand_chip *chip = mtd_to_nand(mtd);
Vitaly Wool962034f2005-09-15 14:58:53 +01003125
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003126 if (chip->state == FL_PM_SUSPENDED)
Vitaly Wool962034f2005-09-15 14:58:53 +01003127 nand_release_device(mtd);
3128 else
Brian Norrisd0370212011-07-19 10:06:08 -07003129 pr_err("%s called for a chip which is not in suspended state\n",
3130 __func__);
Vitaly Wool962034f2005-09-15 14:58:53 +01003131}
3132
Scott Branden72ea4032014-11-20 11:18:05 -08003133/**
3134 * nand_shutdown - [MTD Interface] Finish the current NAND operation and
3135 * prevent further operations
3136 * @mtd: MTD device structure
3137 */
3138static void nand_shutdown(struct mtd_info *mtd)
3139{
Brian Norris9ca641b2015-11-09 16:37:28 -08003140 nand_get_device(mtd, FL_PM_SUSPENDED);
Scott Branden72ea4032014-11-20 11:18:05 -08003141}
3142
Brian Norris8b6e50c2011-05-25 14:59:01 -07003143/* Set default functions */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003144static void nand_set_defaults(struct nand_chip *chip, int busw)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003145{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146 /* check for proper chip_delay setup, set 20us if not */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003147 if (!chip->chip_delay)
3148 chip->chip_delay = 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149
3150 /* check, if a user supplied command function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003151 if (chip->cmdfunc == NULL)
3152 chip->cmdfunc = nand_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153
3154 /* check, if a user supplied wait function given */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003155 if (chip->waitfunc == NULL)
3156 chip->waitfunc = nand_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003158 if (!chip->select_chip)
3159 chip->select_chip = nand_select_chip;
Brian Norris68e80782013-07-18 01:17:02 -07003160
Huang Shijie4204ccc2013-08-16 10:10:07 +08003161 /* set for ONFI nand */
3162 if (!chip->onfi_set_features)
3163 chip->onfi_set_features = nand_onfi_set_features;
3164 if (!chip->onfi_get_features)
3165 chip->onfi_get_features = nand_onfi_get_features;
3166
Brian Norris68e80782013-07-18 01:17:02 -07003167 /* If called twice, pointers that depend on busw may need to be reset */
3168 if (!chip->read_byte || chip->read_byte == nand_read_byte)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003169 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
3170 if (!chip->read_word)
3171 chip->read_word = nand_read_word;
3172 if (!chip->block_bad)
3173 chip->block_bad = nand_block_bad;
3174 if (!chip->block_markbad)
3175 chip->block_markbad = nand_default_block_markbad;
Brian Norris68e80782013-07-18 01:17:02 -07003176 if (!chip->write_buf || chip->write_buf == nand_write_buf)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003177 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
Uwe Kleine-König05f78352013-12-05 22:22:04 +01003178 if (!chip->write_byte || chip->write_byte == nand_write_byte)
3179 chip->write_byte = busw ? nand_write_byte16 : nand_write_byte;
Brian Norris68e80782013-07-18 01:17:02 -07003180 if (!chip->read_buf || chip->read_buf == nand_read_buf)
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003181 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003182 if (!chip->scan_bbt)
3183 chip->scan_bbt = nand_default_bbt;
Thomas Gleixnerf75e5092006-05-26 18:52:08 +02003184
3185 if (!chip->controller) {
3186 chip->controller = &chip->hwcontrol;
3187 spin_lock_init(&chip->controller->lock);
3188 init_waitqueue_head(&chip->controller->wq);
3189 }
3190
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003191}
3192
Brian Norris8b6e50c2011-05-25 14:59:01 -07003193/* Sanitize ONFI strings so we can safely print them */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003194static void sanitize_string(uint8_t *s, size_t len)
3195{
3196 ssize_t i;
3197
Brian Norris8b6e50c2011-05-25 14:59:01 -07003198 /* Null terminate */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003199 s[len - 1] = 0;
3200
Brian Norris8b6e50c2011-05-25 14:59:01 -07003201 /* Remove non printable chars */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003202 for (i = 0; i < len - 1; i++) {
3203 if (s[i] < ' ' || s[i] > 127)
3204 s[i] = '?';
3205 }
3206
Brian Norris8b6e50c2011-05-25 14:59:01 -07003207 /* Remove trailing spaces */
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003208 strim(s);
3209}
3210
3211static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
3212{
3213 int i;
3214 while (len--) {
3215 crc ^= *p++ << 8;
3216 for (i = 0; i < 8; i++)
3217 crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
3218 }
3219
3220 return crc;
3221}
3222
Huang Shijie6dcbe0c2013-05-22 10:28:27 +08003223/* Parse the Extended Parameter Page. */
3224static int nand_flash_detect_ext_param_page(struct mtd_info *mtd,
3225 struct nand_chip *chip, struct nand_onfi_params *p)
3226{
3227 struct onfi_ext_param_page *ep;
3228 struct onfi_ext_section *s;
3229 struct onfi_ext_ecc_info *ecc;
3230 uint8_t *cursor;
3231 int ret = -EINVAL;
3232 int len;
3233 int i;
3234
3235 len = le16_to_cpu(p->ext_param_page_length) * 16;
3236 ep = kmalloc(len, GFP_KERNEL);
Brian Norris5cb13272013-09-16 17:59:20 -07003237 if (!ep)
3238 return -ENOMEM;
Huang Shijie6dcbe0c2013-05-22 10:28:27 +08003239
3240 /* Send our own NAND_CMD_PARAM. */
3241 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
3242
3243 /* Use the Change Read Column command to skip the ONFI param pages. */
3244 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
3245 sizeof(*p) * p->num_of_param_pages , -1);
3246
3247 /* Read out the Extended Parameter Page. */
3248 chip->read_buf(mtd, (uint8_t *)ep, len);
3249 if ((onfi_crc16(ONFI_CRC_BASE, ((uint8_t *)ep) + 2, len - 2)
3250 != le16_to_cpu(ep->crc))) {
3251 pr_debug("fail in the CRC.\n");
3252 goto ext_out;
3253 }
3254
3255 /*
3256 * Check the signature.
3257 * Do not strictly follow the ONFI spec, maybe changed in future.
3258 */
3259 if (strncmp(ep->sig, "EPPS", 4)) {
3260 pr_debug("The signature is invalid.\n");
3261 goto ext_out;
3262 }
3263
3264 /* find the ECC section. */
3265 cursor = (uint8_t *)(ep + 1);
3266 for (i = 0; i < ONFI_EXT_SECTION_MAX; i++) {
3267 s = ep->sections + i;
3268 if (s->type == ONFI_SECTION_TYPE_2)
3269 break;
3270 cursor += s->length * 16;
3271 }
3272 if (i == ONFI_EXT_SECTION_MAX) {
3273 pr_debug("We can not find the ECC section.\n");
3274 goto ext_out;
3275 }
3276
3277 /* get the info we want. */
3278 ecc = (struct onfi_ext_ecc_info *)cursor;
3279
Brian Norris4ae7d222013-09-16 18:20:21 -07003280 if (!ecc->codeword_size) {
3281 pr_debug("Invalid codeword size\n");
3282 goto ext_out;
Huang Shijie6dcbe0c2013-05-22 10:28:27 +08003283 }
3284
Brian Norris4ae7d222013-09-16 18:20:21 -07003285 chip->ecc_strength_ds = ecc->ecc_bits;
3286 chip->ecc_step_ds = 1 << ecc->codeword_size;
Brian Norris5cb13272013-09-16 17:59:20 -07003287 ret = 0;
Huang Shijie6dcbe0c2013-05-22 10:28:27 +08003288
3289ext_out:
3290 kfree(ep);
3291 return ret;
3292}
3293
Brian Norris8429bb32013-12-03 15:51:09 -08003294static int nand_setup_read_retry_micron(struct mtd_info *mtd, int retry_mode)
3295{
Boris BREZILLON862eba52015-12-01 12:03:03 +01003296 struct nand_chip *chip = mtd_to_nand(mtd);
Brian Norris8429bb32013-12-03 15:51:09 -08003297 uint8_t feature[ONFI_SUBFEATURE_PARAM_LEN] = {retry_mode};
3298
3299 return chip->onfi_set_features(mtd, chip, ONFI_FEATURE_ADDR_READ_RETRY,
3300 feature);
3301}
3302
3303/*
3304 * Configure chip properties from Micron vendor-specific ONFI table
3305 */
3306static void nand_onfi_detect_micron(struct nand_chip *chip,
3307 struct nand_onfi_params *p)
3308{
3309 struct nand_onfi_vendor_micron *micron = (void *)p->vendor;
3310
3311 if (le16_to_cpu(p->vendor_revision) < 1)
3312 return;
3313
3314 chip->read_retries = micron->read_retry_options;
3315 chip->setup_read_retry = nand_setup_read_retry_micron;
3316}
3317
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003318/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003319 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003320 */
3321static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
Matthieu CASTET08c248f2011-06-26 18:26:55 +02003322 int *busw)
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003323{
3324 struct nand_onfi_params *p = &chip->onfi_params;
Brian Norrisbd9c6e92013-11-29 22:04:28 -08003325 int i, j;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003326 int val;
3327
Brian Norris7854d3f2011-06-23 14:12:08 -07003328 /* Try ONFI for unknown chip or LP */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003329 chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
3330 if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
3331 chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
3332 return 0;
3333
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003334 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
3335 for (i = 0; i < 3; i++) {
Brian Norrisbd9c6e92013-11-29 22:04:28 -08003336 for (j = 0; j < sizeof(*p); j++)
3337 ((uint8_t *)p)[j] = chip->read_byte(mtd);
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003338 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
3339 le16_to_cpu(p->crc)) {
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003340 break;
3341 }
3342 }
3343
Brian Norrisc7f23a72013-08-13 10:51:55 -07003344 if (i == 3) {
3345 pr_err("Could not find valid ONFI parameter page; aborting\n");
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003346 return 0;
Brian Norrisc7f23a72013-08-13 10:51:55 -07003347 }
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003348
Brian Norris8b6e50c2011-05-25 14:59:01 -07003349 /* Check version */
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003350 val = le16_to_cpu(p->revision);
Brian Norrisb7b1a292010-12-12 00:23:33 -08003351 if (val & (1 << 5))
3352 chip->onfi_version = 23;
3353 else if (val & (1 << 4))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003354 chip->onfi_version = 22;
3355 else if (val & (1 << 3))
3356 chip->onfi_version = 21;
3357 else if (val & (1 << 2))
3358 chip->onfi_version = 20;
Brian Norrisb7b1a292010-12-12 00:23:33 -08003359 else if (val & (1 << 1))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003360 chip->onfi_version = 10;
Brian Norrisb7b1a292010-12-12 00:23:33 -08003361
3362 if (!chip->onfi_version) {
Ezequiel Garcia20171642013-11-25 08:30:31 -03003363 pr_info("unsupported ONFI version: %d\n", val);
Brian Norrisb7b1a292010-12-12 00:23:33 -08003364 return 0;
3365 }
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003366
3367 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
3368 sanitize_string(p->model, sizeof(p->model));
3369 if (!mtd->name)
3370 mtd->name = p->model;
Brian Norris4355b702013-08-27 18:45:10 -07003371
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003372 mtd->writesize = le32_to_cpu(p->byte_per_page);
Brian Norris4355b702013-08-27 18:45:10 -07003373
3374 /*
3375 * pages_per_block and blocks_per_lun may not be a power-of-2 size
3376 * (don't ask me who thought of this...). MTD assumes that these
3377 * dimensions will be power-of-2, so just truncate the remaining area.
3378 */
3379 mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);
3380 mtd->erasesize *= mtd->writesize;
3381
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003382 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
Brian Norris4355b702013-08-27 18:45:10 -07003383
3384 /* See erasesize comment */
3385 chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);
Matthieu CASTET63795752012-03-19 15:35:25 +01003386 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
Huang Shijie13fbd172013-09-25 14:58:13 +08003387 chip->bits_per_cell = p->bits_per_cell;
Huang Shijiee2985fc2013-05-17 11:17:30 +08003388
3389 if (onfi_feature(chip) & ONFI_FEATURE_16_BIT_BUS)
Matthieu CASTET08c248f2011-06-26 18:26:55 +02003390 *busw = NAND_BUSWIDTH_16;
Huang Shijiee2985fc2013-05-17 11:17:30 +08003391 else
3392 *busw = 0;
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003393
Huang Shijie10c86ba2013-05-17 11:17:26 +08003394 if (p->ecc_bits != 0xff) {
3395 chip->ecc_strength_ds = p->ecc_bits;
3396 chip->ecc_step_ds = 512;
Huang Shijie6dcbe0c2013-05-22 10:28:27 +08003397 } else if (chip->onfi_version >= 21 &&
3398 (onfi_feature(chip) & ONFI_FEATURE_EXT_PARAM_PAGE)) {
3399
3400 /*
3401 * The nand_flash_detect_ext_param_page() uses the
3402 * Change Read Column command which maybe not supported
3403 * by the chip->cmdfunc. So try to update the chip->cmdfunc
3404 * now. We do not replace user supplied command function.
3405 */
3406 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3407 chip->cmdfunc = nand_command_lp;
3408
3409 /* The Extended Parameter Page is supported since ONFI 2.1. */
3410 if (nand_flash_detect_ext_param_page(mtd, chip, p))
Brian Norrisc7f23a72013-08-13 10:51:55 -07003411 pr_warn("Failed to detect ONFI extended param page\n");
3412 } else {
3413 pr_warn("Could not retrieve ONFI ECC requirements\n");
Huang Shijie10c86ba2013-05-17 11:17:26 +08003414 }
3415
Brian Norris8429bb32013-12-03 15:51:09 -08003416 if (p->jedec_id == NAND_MFR_MICRON)
3417 nand_onfi_detect_micron(chip, p);
3418
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003419 return 1;
3420}
3421
3422/*
Huang Shijie91361812014-02-21 13:39:40 +08003423 * Check if the NAND chip is JEDEC compliant, returns 1 if it is, 0 otherwise.
3424 */
3425static int nand_flash_detect_jedec(struct mtd_info *mtd, struct nand_chip *chip,
3426 int *busw)
3427{
3428 struct nand_jedec_params *p = &chip->jedec_params;
3429 struct jedec_ecc_info *ecc;
3430 int val;
3431 int i, j;
3432
3433 /* Try JEDEC for unknown chip or LP */
3434 chip->cmdfunc(mtd, NAND_CMD_READID, 0x40, -1);
3435 if (chip->read_byte(mtd) != 'J' || chip->read_byte(mtd) != 'E' ||
3436 chip->read_byte(mtd) != 'D' || chip->read_byte(mtd) != 'E' ||
3437 chip->read_byte(mtd) != 'C')
3438 return 0;
3439
3440 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0x40, -1);
3441 for (i = 0; i < 3; i++) {
3442 for (j = 0; j < sizeof(*p); j++)
3443 ((uint8_t *)p)[j] = chip->read_byte(mtd);
3444
3445 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 510) ==
3446 le16_to_cpu(p->crc))
3447 break;
3448 }
3449
3450 if (i == 3) {
3451 pr_err("Could not find valid JEDEC parameter page; aborting\n");
3452 return 0;
3453 }
3454
3455 /* Check version */
3456 val = le16_to_cpu(p->revision);
3457 if (val & (1 << 2))
3458 chip->jedec_version = 10;
3459 else if (val & (1 << 1))
3460 chip->jedec_version = 1; /* vendor specific version */
3461
3462 if (!chip->jedec_version) {
3463 pr_info("unsupported JEDEC version: %d\n", val);
3464 return 0;
3465 }
3466
3467 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
3468 sanitize_string(p->model, sizeof(p->model));
3469 if (!mtd->name)
3470 mtd->name = p->model;
3471
3472 mtd->writesize = le32_to_cpu(p->byte_per_page);
3473
3474 /* Please reference to the comment for nand_flash_detect_onfi. */
3475 mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);
3476 mtd->erasesize *= mtd->writesize;
3477
3478 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
3479
3480 /* Please reference to the comment for nand_flash_detect_onfi. */
3481 chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);
3482 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
3483 chip->bits_per_cell = p->bits_per_cell;
3484
3485 if (jedec_feature(chip) & JEDEC_FEATURE_16_BIT_BUS)
3486 *busw = NAND_BUSWIDTH_16;
3487 else
3488 *busw = 0;
3489
3490 /* ECC info */
3491 ecc = &p->ecc_info[0];
3492
3493 if (ecc->codeword_size >= 9) {
3494 chip->ecc_strength_ds = ecc->ecc_bits;
3495 chip->ecc_step_ds = 1 << ecc->codeword_size;
3496 } else {
3497 pr_warn("Invalid codeword size\n");
3498 }
3499
3500 return 1;
3501}
3502
3503/*
Brian Norrise3b88bd2012-09-24 20:40:52 -07003504 * nand_id_has_period - Check if an ID string has a given wraparound period
3505 * @id_data: the ID string
3506 * @arrlen: the length of the @id_data array
3507 * @period: the period of repitition
3508 *
3509 * Check if an ID string is repeated within a given sequence of bytes at
3510 * specific repetition interval period (e.g., {0x20,0x01,0x7F,0x20} has a
Brian Norrisd4d4f1b2012-11-14 21:54:20 -08003511 * period of 3). This is a helper function for nand_id_len(). Returns non-zero
Brian Norrise3b88bd2012-09-24 20:40:52 -07003512 * if the repetition has a period of @period; otherwise, returns zero.
3513 */
3514static int nand_id_has_period(u8 *id_data, int arrlen, int period)
3515{
3516 int i, j;
3517 for (i = 0; i < period; i++)
3518 for (j = i + period; j < arrlen; j += period)
3519 if (id_data[i] != id_data[j])
3520 return 0;
3521 return 1;
3522}
3523
3524/*
3525 * nand_id_len - Get the length of an ID string returned by CMD_READID
3526 * @id_data: the ID string
3527 * @arrlen: the length of the @id_data array
3528
3529 * Returns the length of the ID string, according to known wraparound/trailing
3530 * zero patterns. If no pattern exists, returns the length of the array.
3531 */
3532static int nand_id_len(u8 *id_data, int arrlen)
3533{
3534 int last_nonzero, period;
3535
3536 /* Find last non-zero byte */
3537 for (last_nonzero = arrlen - 1; last_nonzero >= 0; last_nonzero--)
3538 if (id_data[last_nonzero])
3539 break;
3540
3541 /* All zeros */
3542 if (last_nonzero < 0)
3543 return 0;
3544
3545 /* Calculate wraparound period */
3546 for (period = 1; period < arrlen; period++)
3547 if (nand_id_has_period(id_data, arrlen, period))
3548 break;
3549
3550 /* There's a repeated pattern */
3551 if (period < arrlen)
3552 return period;
3553
3554 /* There are trailing zeros */
3555 if (last_nonzero < arrlen - 1)
3556 return last_nonzero + 1;
3557
3558 /* No pattern detected */
3559 return arrlen;
3560}
3561
Huang Shijie7db906b2013-09-25 14:58:11 +08003562/* Extract the bits of per cell from the 3rd byte of the extended ID */
3563static int nand_get_bits_per_cell(u8 cellinfo)
3564{
3565 int bits;
3566
3567 bits = cellinfo & NAND_CI_CELLTYPE_MSK;
3568 bits >>= NAND_CI_CELLTYPE_SHIFT;
3569 return bits + 1;
3570}
3571
Brian Norrise3b88bd2012-09-24 20:40:52 -07003572/*
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003573 * Many new NAND share similar device ID codes, which represent the size of the
3574 * chip. The rest of the parameters must be decoded according to generic or
3575 * manufacturer-specific "extended ID" decoding patterns.
3576 */
3577static void nand_decode_ext_id(struct mtd_info *mtd, struct nand_chip *chip,
3578 u8 id_data[8], int *busw)
3579{
Brian Norrise3b88bd2012-09-24 20:40:52 -07003580 int extid, id_len;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003581 /* The 3rd id byte holds MLC / multichip data */
Huang Shijie7db906b2013-09-25 14:58:11 +08003582 chip->bits_per_cell = nand_get_bits_per_cell(id_data[2]);
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003583 /* The 4th id byte is the important one */
3584 extid = id_data[3];
3585
Brian Norrise3b88bd2012-09-24 20:40:52 -07003586 id_len = nand_id_len(id_data, 8);
3587
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003588 /*
3589 * Field definitions are in the following datasheets:
3590 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
Brian Norrisaf451af2012-10-09 23:26:06 -07003591 * New Samsung (6 byte ID): Samsung K9GAG08U0F (p.44)
Brian Norris73ca3922012-09-24 20:40:54 -07003592 * Hynix MLC (6 byte ID): Hynix H27UBG8T2B (p.22)
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003593 *
Brian Norrisaf451af2012-10-09 23:26:06 -07003594 * Check for ID length, non-zero 6th byte, cell type, and Hynix/Samsung
3595 * ID to decide what to do.
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003596 */
Brian Norrisaf451af2012-10-09 23:26:06 -07003597 if (id_len == 6 && id_data[0] == NAND_MFR_SAMSUNG &&
Huang Shijie1d0ed692013-09-25 14:58:10 +08003598 !nand_is_slc(chip) && id_data[5] != 0x00) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003599 /* Calc pagesize */
3600 mtd->writesize = 2048 << (extid & 0x03);
3601 extid >>= 2;
3602 /* Calc oobsize */
Brian Norrise2d3a352012-09-24 20:40:55 -07003603 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003604 case 1:
3605 mtd->oobsize = 128;
3606 break;
3607 case 2:
3608 mtd->oobsize = 218;
3609 break;
3610 case 3:
3611 mtd->oobsize = 400;
3612 break;
Brian Norrise2d3a352012-09-24 20:40:55 -07003613 case 4:
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003614 mtd->oobsize = 436;
3615 break;
Brian Norrise2d3a352012-09-24 20:40:55 -07003616 case 5:
3617 mtd->oobsize = 512;
3618 break;
3619 case 6:
Brian Norrise2d3a352012-09-24 20:40:55 -07003620 mtd->oobsize = 640;
3621 break;
Huang Shijie94d04e82013-12-25 17:18:55 +08003622 case 7:
3623 default: /* Other cases are "reserved" (unknown) */
3624 mtd->oobsize = 1024;
3625 break;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003626 }
3627 extid >>= 2;
3628 /* Calc blocksize */
3629 mtd->erasesize = (128 * 1024) <<
3630 (((extid >> 1) & 0x04) | (extid & 0x03));
3631 *busw = 0;
Brian Norris73ca3922012-09-24 20:40:54 -07003632 } else if (id_len == 6 && id_data[0] == NAND_MFR_HYNIX &&
Huang Shijie1d0ed692013-09-25 14:58:10 +08003633 !nand_is_slc(chip)) {
Brian Norris73ca3922012-09-24 20:40:54 -07003634 unsigned int tmp;
3635
3636 /* Calc pagesize */
3637 mtd->writesize = 2048 << (extid & 0x03);
3638 extid >>= 2;
3639 /* Calc oobsize */
3640 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3641 case 0:
3642 mtd->oobsize = 128;
3643 break;
3644 case 1:
3645 mtd->oobsize = 224;
3646 break;
3647 case 2:
3648 mtd->oobsize = 448;
3649 break;
3650 case 3:
3651 mtd->oobsize = 64;
3652 break;
3653 case 4:
3654 mtd->oobsize = 32;
3655 break;
3656 case 5:
3657 mtd->oobsize = 16;
3658 break;
3659 default:
3660 mtd->oobsize = 640;
3661 break;
3662 }
3663 extid >>= 2;
3664 /* Calc blocksize */
3665 tmp = ((extid >> 1) & 0x04) | (extid & 0x03);
3666 if (tmp < 0x03)
3667 mtd->erasesize = (128 * 1024) << tmp;
3668 else if (tmp == 0x03)
3669 mtd->erasesize = 768 * 1024;
3670 else
3671 mtd->erasesize = (64 * 1024) << tmp;
3672 *busw = 0;
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003673 } else {
3674 /* Calc pagesize */
3675 mtd->writesize = 1024 << (extid & 0x03);
3676 extid >>= 2;
3677 /* Calc oobsize */
3678 mtd->oobsize = (8 << (extid & 0x01)) *
3679 (mtd->writesize >> 9);
3680 extid >>= 2;
3681 /* Calc blocksize. Blocksize is multiples of 64KiB */
3682 mtd->erasesize = (64 * 1024) << (extid & 0x03);
3683 extid >>= 2;
3684 /* Get buswidth information */
3685 *busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
Brian Norris60c67382013-06-25 13:17:59 -07003686
3687 /*
3688 * Toshiba 24nm raw SLC (i.e., not BENAND) have 32B OOB per
3689 * 512B page. For Toshiba SLC, we decode the 5th/6th byte as
3690 * follows:
3691 * - ID byte 6, bits[2:0]: 100b -> 43nm, 101b -> 32nm,
3692 * 110b -> 24nm
3693 * - ID byte 5, bit[7]: 1 -> BENAND, 0 -> raw SLC
3694 */
3695 if (id_len >= 6 && id_data[0] == NAND_MFR_TOSHIBA &&
Huang Shijie1d0ed692013-09-25 14:58:10 +08003696 nand_is_slc(chip) &&
Brian Norris60c67382013-06-25 13:17:59 -07003697 (id_data[5] & 0x7) == 0x6 /* 24nm */ &&
3698 !(id_data[4] & 0x80) /* !BENAND */) {
3699 mtd->oobsize = 32 * mtd->writesize >> 9;
3700 }
3701
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003702 }
3703}
3704
3705/*
Brian Norrisf23a4812012-09-24 20:40:51 -07003706 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
3707 * decodes a matching ID table entry and assigns the MTD size parameters for
3708 * the chip.
3709 */
3710static void nand_decode_id(struct mtd_info *mtd, struct nand_chip *chip,
3711 struct nand_flash_dev *type, u8 id_data[8],
3712 int *busw)
3713{
3714 int maf_id = id_data[0];
3715
3716 mtd->erasesize = type->erasesize;
3717 mtd->writesize = type->pagesize;
3718 mtd->oobsize = mtd->writesize / 32;
3719 *busw = type->options & NAND_BUSWIDTH_16;
3720
Huang Shijie1c195e92013-09-25 14:58:12 +08003721 /* All legacy ID NAND are small-page, SLC */
3722 chip->bits_per_cell = 1;
3723
Brian Norrisf23a4812012-09-24 20:40:51 -07003724 /*
3725 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
3726 * some Spansion chips have erasesize that conflicts with size
3727 * listed in nand_ids table.
3728 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
3729 */
3730 if (maf_id == NAND_MFR_AMD && id_data[4] != 0x00 && id_data[5] == 0x00
3731 && id_data[6] == 0x00 && id_data[7] == 0x00
3732 && mtd->writesize == 512) {
3733 mtd->erasesize = 128 * 1024;
3734 mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
3735 }
3736}
3737
3738/*
Brian Norris7e74c2d2012-09-24 20:40:49 -07003739 * Set the bad block marker/indicator (BBM/BBI) patterns according to some
3740 * heuristic patterns using various detected parameters (e.g., manufacturer,
3741 * page size, cell-type information).
3742 */
3743static void nand_decode_bbm_options(struct mtd_info *mtd,
3744 struct nand_chip *chip, u8 id_data[8])
3745{
3746 int maf_id = id_data[0];
3747
3748 /* Set the bad block position */
3749 if (mtd->writesize > 512 || (chip->options & NAND_BUSWIDTH_16))
3750 chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
3751 else
3752 chip->badblockpos = NAND_SMALL_BADBLOCK_POS;
3753
3754 /*
3755 * Bad block marker is stored in the last page of each block on Samsung
3756 * and Hynix MLC devices; stored in first two pages of each block on
3757 * Micron devices with 2KiB pages and on SLC Samsung, Hynix, Toshiba,
3758 * AMD/Spansion, and Macronix. All others scan only the first page.
3759 */
Huang Shijie1d0ed692013-09-25 14:58:10 +08003760 if (!nand_is_slc(chip) &&
Brian Norris7e74c2d2012-09-24 20:40:49 -07003761 (maf_id == NAND_MFR_SAMSUNG ||
3762 maf_id == NAND_MFR_HYNIX))
3763 chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
Huang Shijie1d0ed692013-09-25 14:58:10 +08003764 else if ((nand_is_slc(chip) &&
Brian Norris7e74c2d2012-09-24 20:40:49 -07003765 (maf_id == NAND_MFR_SAMSUNG ||
3766 maf_id == NAND_MFR_HYNIX ||
3767 maf_id == NAND_MFR_TOSHIBA ||
3768 maf_id == NAND_MFR_AMD ||
3769 maf_id == NAND_MFR_MACRONIX)) ||
3770 (mtd->writesize == 2048 &&
3771 maf_id == NAND_MFR_MICRON))
3772 chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
3773}
3774
Huang Shijieec6e87e2013-03-15 11:01:00 +08003775static inline bool is_full_id_nand(struct nand_flash_dev *type)
3776{
3777 return type->id_len;
3778}
3779
3780static bool find_full_id_nand(struct mtd_info *mtd, struct nand_chip *chip,
3781 struct nand_flash_dev *type, u8 *id_data, int *busw)
3782{
3783 if (!strncmp(type->id, id_data, type->id_len)) {
3784 mtd->writesize = type->pagesize;
3785 mtd->erasesize = type->erasesize;
3786 mtd->oobsize = type->oobsize;
3787
Huang Shijie7db906b2013-09-25 14:58:11 +08003788 chip->bits_per_cell = nand_get_bits_per_cell(id_data[2]);
Huang Shijieec6e87e2013-03-15 11:01:00 +08003789 chip->chipsize = (uint64_t)type->chipsize << 20;
3790 chip->options |= type->options;
Huang Shijie57219342013-05-17 11:17:32 +08003791 chip->ecc_strength_ds = NAND_ECC_STRENGTH(type);
3792 chip->ecc_step_ds = NAND_ECC_STEP(type);
Boris BREZILLON57a94e22014-09-22 20:11:50 +02003793 chip->onfi_timing_mode_default =
3794 type->onfi_timing_mode_default;
Huang Shijieec6e87e2013-03-15 11:01:00 +08003795
3796 *busw = type->options & NAND_BUSWIDTH_16;
3797
Cai Zhiyong092b6a12013-12-25 21:19:21 +08003798 if (!mtd->name)
3799 mtd->name = type->name;
3800
Huang Shijieec6e87e2013-03-15 11:01:00 +08003801 return true;
3802 }
3803 return false;
3804}
3805
Brian Norris7e74c2d2012-09-24 20:40:49 -07003806/*
Brian Norris8b6e50c2011-05-25 14:59:01 -07003807 * Get the flash and manufacturer id and lookup if the type is supported.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003808 */
3809static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003810 struct nand_chip *chip,
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003811 int *maf_id, int *dev_id,
David Woodhouse5e81e882010-02-26 18:32:56 +00003812 struct nand_flash_dev *type)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003813{
Cai Zhiyongbb770822013-12-25 20:11:15 +08003814 int busw;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003815 int i, maf_idx;
Kevin Cernekee426c4572010-05-04 20:58:03 -07003816 u8 id_data[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -07003817
3818 /* Select the device */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003819 chip->select_chip(mtd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003820
Karl Beldanef89a882008-09-15 14:37:29 +02003821 /*
3822 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
Brian Norris8b6e50c2011-05-25 14:59:01 -07003823 * after power-up.
Karl Beldanef89a882008-09-15 14:37:29 +02003824 */
3825 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
3826
Linus Torvalds1da177e2005-04-16 15:20:36 -07003827 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003828 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003829
3830 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003831 *maf_id = chip->read_byte(mtd);
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003832 *dev_id = chip->read_byte(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003833
Brian Norris8b6e50c2011-05-25 14:59:01 -07003834 /*
3835 * Try again to make sure, as some systems the bus-hold or other
Ben Dooksed8165c2008-04-14 14:58:58 +01003836 * interface concerns can cause random data which looks like a
3837 * possibly credible NAND flash to appear. If the two results do
3838 * not match, ignore the device completely.
3839 */
3840
3841 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
3842
Brian Norris4aef9b72012-09-24 20:40:48 -07003843 /* Read entire ID string */
3844 for (i = 0; i < 8; i++)
Kevin Cernekee426c4572010-05-04 20:58:03 -07003845 id_data[i] = chip->read_byte(mtd);
Ben Dooksed8165c2008-04-14 14:58:58 +01003846
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003847 if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
Ezequiel Garcia20171642013-11-25 08:30:31 -03003848 pr_info("second ID read did not match %02x,%02x against %02x,%02x\n",
Brian Norrisd0370212011-07-19 10:06:08 -07003849 *maf_id, *dev_id, id_data[0], id_data[1]);
Ben Dooksed8165c2008-04-14 14:58:58 +01003850 return ERR_PTR(-ENODEV);
3851 }
3852
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003853 if (!type)
David Woodhouse5e81e882010-02-26 18:32:56 +00003854 type = nand_flash_ids;
3855
Huang Shijieec6e87e2013-03-15 11:01:00 +08003856 for (; type->name != NULL; type++) {
3857 if (is_full_id_nand(type)) {
3858 if (find_full_id_nand(mtd, chip, type, id_data, &busw))
3859 goto ident_done;
3860 } else if (*dev_id == type->dev_id) {
Brian Norrisdb5b09f2015-05-22 10:43:12 -07003861 break;
Huang Shijieec6e87e2013-03-15 11:01:00 +08003862 }
3863 }
David Woodhouse5e81e882010-02-26 18:32:56 +00003864
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003865 chip->onfi_version = 0;
3866 if (!type->name || !type->pagesize) {
Masahiro Yamada35fc5192014-04-09 16:26:26 +09003867 /* Check if the chip is ONFI compliant */
Brian Norris47450b32012-09-24 20:40:47 -07003868 if (nand_flash_detect_onfi(mtd, chip, &busw))
Florian Fainelli6fb277b2010-09-01 22:28:59 +02003869 goto ident_done;
Huang Shijie91361812014-02-21 13:39:40 +08003870
3871 /* Check if the chip is JEDEC compliant */
3872 if (nand_flash_detect_jedec(mtd, chip, &busw))
3873 goto ident_done;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003874 }
3875
David Woodhouse5e81e882010-02-26 18:32:56 +00003876 if (!type->name)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003877 return ERR_PTR(-ENODEV);
3878
Thomas Gleixnerba0251f2006-05-27 01:02:13 +02003879 if (!mtd->name)
3880 mtd->name = type->name;
3881
Adrian Hunter69423d92008-12-10 13:37:21 +00003882 chip->chipsize = (uint64_t)type->chipsize << 20;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003883
Boris BREZILLONa7f5ba42015-10-01 16:58:27 +02003884 if (!type->pagesize) {
Brian Norrisfc09bbc2012-09-24 20:40:50 -07003885 /* Decode parameters from extended ID */
3886 nand_decode_ext_id(mtd, chip, id_data, &busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003887 } else {
Brian Norrisf23a4812012-09-24 20:40:51 -07003888 nand_decode_id(mtd, chip, type, id_data, &busw);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003889 }
Brian Norrisbf7a01b2012-07-13 09:28:24 -07003890 /* Get chip options */
3891 chip->options |= type->options;
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003892
Brian Norris8b6e50c2011-05-25 14:59:01 -07003893 /*
3894 * Check if chip is not a Samsung device. Do not clear the
3895 * options for chips which do not have an extended id.
Florian Fainellid1e1f4e2010-08-30 18:32:24 +02003896 */
3897 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
3898 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
3899ident_done:
3900
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003901 /* Try to identify manufacturer */
David Woodhouse9a909862006-07-15 13:26:18 +01003902 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003903 if (nand_manuf_ids[maf_idx].id == *maf_id)
3904 break;
3905 }
3906
Matthieu CASTET64b37b22012-11-06 11:51:44 +01003907 if (chip->options & NAND_BUSWIDTH_AUTO) {
3908 WARN_ON(chip->options & NAND_BUSWIDTH_16);
3909 chip->options |= busw;
3910 nand_set_defaults(chip, busw);
3911 } else if (busw != (chip->options & NAND_BUSWIDTH_16)) {
3912 /*
3913 * Check, if buswidth is correct. Hardware drivers should set
3914 * chip correct!
3915 */
Ezequiel Garcia20171642013-11-25 08:30:31 -03003916 pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
3917 *maf_id, *dev_id);
3918 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name, mtd->name);
3919 pr_warn("bus width %d instead %d bit\n",
Brian Norrisd0370212011-07-19 10:06:08 -07003920 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
3921 busw ? 16 : 8);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003922 return ERR_PTR(-EINVAL);
3923 }
3924
Brian Norris7e74c2d2012-09-24 20:40:49 -07003925 nand_decode_bbm_options(mtd, chip, id_data);
3926
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003927 /* Calculate the address shift from the page size */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003928 chip->page_shift = ffs(mtd->writesize) - 1;
Brian Norris8b6e50c2011-05-25 14:59:01 -07003929 /* Convert chipsize to number of pages per chip -1 */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003930 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003931
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003932 chip->bbt_erase_shift = chip->phys_erase_shift =
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003933 ffs(mtd->erasesize) - 1;
Adrian Hunter69423d92008-12-10 13:37:21 +00003934 if (chip->chipsize & 0xffffffff)
3935 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
Florian Fainelli7351d3a2010-09-07 13:23:45 +02003936 else {
3937 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
3938 chip->chip_shift += 32 - 1;
3939 }
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003940
Artem Bityutskiy26d9be12011-04-28 20:26:59 +03003941 chip->badblockbits = 8;
Brian Norris49c50b92014-05-06 16:02:19 -07003942 chip->erase = single_erase;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003943
Brian Norris8b6e50c2011-05-25 14:59:01 -07003944 /* Do not replace user supplied command function! */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02003945 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3946 chip->cmdfunc = nand_command_lp;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003947
Ezequiel Garcia20171642013-11-25 08:30:31 -03003948 pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
3949 *maf_id, *dev_id);
Huang Shijieffdac6cd2014-02-21 13:39:41 +08003950
3951 if (chip->onfi_version)
3952 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3953 chip->onfi_params.model);
3954 else if (chip->jedec_version)
3955 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3956 chip->jedec_params.model);
3957 else
3958 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3959 type->name);
3960
Rafał Miłecki3755a992014-10-21 00:01:04 +02003961 pr_info("%d MiB, %s, erase size: %d KiB, page size: %d, OOB size: %d\n",
Huang Shijie3723e932013-09-25 14:58:14 +08003962 (int)(chip->chipsize >> 20), nand_is_slc(chip) ? "SLC" : "MLC",
Rafał Miłecki3755a992014-10-21 00:01:04 +02003963 mtd->erasesize >> 10, mtd->writesize, mtd->oobsize);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02003964 return type;
3965}
3966
Boris BREZILLON7194a292015-12-10 09:00:37 +01003967static int nand_dt_init(struct nand_chip *chip)
Brian Norris5844fee2015-01-23 00:22:27 -08003968{
Boris BREZILLON7194a292015-12-10 09:00:37 +01003969 struct device_node *dn = nand_get_flash_node(chip);
Brian Norris5844fee2015-01-23 00:22:27 -08003970 int ecc_mode, ecc_strength, ecc_step;
3971
Boris BREZILLON7194a292015-12-10 09:00:37 +01003972 if (!dn)
3973 return 0;
3974
Brian Norris5844fee2015-01-23 00:22:27 -08003975 if (of_get_nand_bus_width(dn) == 16)
3976 chip->options |= NAND_BUSWIDTH_16;
3977
3978 if (of_get_nand_on_flash_bbt(dn))
3979 chip->bbt_options |= NAND_BBT_USE_FLASH;
3980
3981 ecc_mode = of_get_nand_ecc_mode(dn);
3982 ecc_strength = of_get_nand_ecc_strength(dn);
3983 ecc_step = of_get_nand_ecc_step_size(dn);
3984
3985 if ((ecc_step >= 0 && !(ecc_strength >= 0)) ||
3986 (!(ecc_step >= 0) && ecc_strength >= 0)) {
3987 pr_err("must set both strength and step size in DT\n");
3988 return -EINVAL;
3989 }
3990
3991 if (ecc_mode >= 0)
3992 chip->ecc.mode = ecc_mode;
3993
3994 if (ecc_strength >= 0)
3995 chip->ecc.strength = ecc_strength;
3996
3997 if (ecc_step > 0)
3998 chip->ecc.size = ecc_step;
3999
4000 return 0;
4001}
4002
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004003/**
David Woodhouse3b85c322006-09-25 17:06:53 +01004004 * nand_scan_ident - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07004005 * @mtd: MTD device structure
4006 * @maxchips: number of chips to scan for
4007 * @table: alternative NAND ID table
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004008 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07004009 * This is the first phase of the normal nand_scan() function. It reads the
4010 * flash ID and sets up MTD fields accordingly.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004011 *
4012 */
David Woodhouse5e81e882010-02-26 18:32:56 +00004013int nand_scan_ident(struct mtd_info *mtd, int maxchips,
4014 struct nand_flash_dev *table)
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004015{
Cai Zhiyongbb770822013-12-25 20:11:15 +08004016 int i, nand_maf_id, nand_dev_id;
Boris BREZILLON862eba52015-12-01 12:03:03 +01004017 struct nand_chip *chip = mtd_to_nand(mtd);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004018 struct nand_flash_dev *type;
Brian Norris5844fee2015-01-23 00:22:27 -08004019 int ret;
4020
Boris BREZILLON7194a292015-12-10 09:00:37 +01004021 ret = nand_dt_init(chip);
4022 if (ret)
4023 return ret;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004024
Brian Norrisf7a8e382016-01-05 10:39:45 -08004025 if (!mtd->name && mtd->dev.parent)
4026 mtd->name = dev_name(mtd->dev.parent);
4027
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004028 /* Set the default functions */
Cai Zhiyongbb770822013-12-25 20:11:15 +08004029 nand_set_defaults(chip, chip->options & NAND_BUSWIDTH_16);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004030
4031 /* Read the flash type */
Cai Zhiyongbb770822013-12-25 20:11:15 +08004032 type = nand_get_flash_type(mtd, chip, &nand_maf_id,
4033 &nand_dev_id, table);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004034
4035 if (IS_ERR(type)) {
Ben Dooksb1c6e6d2009-11-02 18:12:33 +00004036 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
Brian Norrisd0370212011-07-19 10:06:08 -07004037 pr_warn("No NAND device found\n");
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004038 chip->select_chip(mtd, -1);
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004039 return PTR_ERR(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004040 }
4041
Huang Shijie07300162012-11-09 16:23:45 +08004042 chip->select_chip(mtd, -1);
4043
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004044 /* Check for a chip array */
David Woodhousee0c7d762006-05-13 18:07:53 +01004045 for (i = 1; i < maxchips; i++) {
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004046 chip->select_chip(mtd, i);
Karl Beldanef89a882008-09-15 14:37:29 +02004047 /* See comment in nand_get_flash_type for reset */
4048 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004049 /* Send the command for reading device ID */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004050 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004051 /* Read manufacturer and device IDs */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004052 if (nand_maf_id != chip->read_byte(mtd) ||
Huang Shijie07300162012-11-09 16:23:45 +08004053 nand_dev_id != chip->read_byte(mtd)) {
4054 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004055 break;
Huang Shijie07300162012-11-09 16:23:45 +08004056 }
4057 chip->select_chip(mtd, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004058 }
4059 if (i > 1)
Ezequiel Garcia20171642013-11-25 08:30:31 -03004060 pr_info("%d chips detected\n", i);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004061
Linus Torvalds1da177e2005-04-16 15:20:36 -07004062 /* Store the number of chips and calc total size for mtd */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004063 chip->numchips = i;
4064 mtd->size = i * chip->chipsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004065
David Woodhouse3b85c322006-09-25 17:06:53 +01004066 return 0;
4067}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02004068EXPORT_SYMBOL(nand_scan_ident);
David Woodhouse3b85c322006-09-25 17:06:53 +01004069
Ezequiel Garcia67a9ad92014-05-14 14:58:06 -03004070/*
4071 * Check if the chip configuration meet the datasheet requirements.
4072
4073 * If our configuration corrects A bits per B bytes and the minimum
4074 * required correction level is X bits per Y bytes, then we must ensure
4075 * both of the following are true:
4076 *
4077 * (1) A / B >= X / Y
4078 * (2) A >= X
4079 *
4080 * Requirement (1) ensures we can correct for the required bitflip density.
4081 * Requirement (2) ensures we can correct even when all bitflips are clumped
4082 * in the same sector.
4083 */
4084static bool nand_ecc_strength_good(struct mtd_info *mtd)
4085{
Boris BREZILLON862eba52015-12-01 12:03:03 +01004086 struct nand_chip *chip = mtd_to_nand(mtd);
Ezequiel Garcia67a9ad92014-05-14 14:58:06 -03004087 struct nand_ecc_ctrl *ecc = &chip->ecc;
4088 int corr, ds_corr;
4089
4090 if (ecc->size == 0 || chip->ecc_step_ds == 0)
4091 /* Not enough information */
4092 return true;
4093
4094 /*
4095 * We get the number of corrected bits per page to compare
4096 * the correction density.
4097 */
4098 corr = (mtd->writesize * ecc->strength) / ecc->size;
4099 ds_corr = (mtd->writesize * chip->ecc_strength_ds) / chip->ecc_step_ds;
4100
4101 return corr >= ds_corr && ecc->strength >= chip->ecc_strength_ds;
4102}
David Woodhouse3b85c322006-09-25 17:06:53 +01004103
4104/**
4105 * nand_scan_tail - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07004106 * @mtd: MTD device structure
David Woodhouse3b85c322006-09-25 17:06:53 +01004107 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07004108 * This is the second phase of the normal nand_scan() function. It fills out
4109 * all the uninitialized function pointers with the defaults and scans for a
4110 * bad block table if appropriate.
David Woodhouse3b85c322006-09-25 17:06:53 +01004111 */
4112int nand_scan_tail(struct mtd_info *mtd)
4113{
4114 int i;
Boris BREZILLON862eba52015-12-01 12:03:03 +01004115 struct nand_chip *chip = mtd_to_nand(mtd);
Huang Shijie97de79e02013-10-18 14:20:53 +08004116 struct nand_ecc_ctrl *ecc = &chip->ecc;
Huang Shijief02ea4e2014-01-13 14:27:12 +08004117 struct nand_buffers *nbuf;
David Woodhouse3b85c322006-09-25 17:06:53 +01004118
Brian Norrise2414f42012-02-06 13:44:00 -08004119 /* New bad blocks should be marked in OOB, flash-based BBT, or both */
4120 BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
4121 !(chip->bbt_options & NAND_BBT_USE_FLASH));
4122
Huang Shijief02ea4e2014-01-13 14:27:12 +08004123 if (!(chip->options & NAND_OWN_BUFFERS)) {
4124 nbuf = kzalloc(sizeof(*nbuf) + mtd->writesize
4125 + mtd->oobsize * 3, GFP_KERNEL);
4126 if (!nbuf)
4127 return -ENOMEM;
4128 nbuf->ecccalc = (uint8_t *)(nbuf + 1);
4129 nbuf->ecccode = nbuf->ecccalc + mtd->oobsize;
4130 nbuf->databuf = nbuf->ecccode + mtd->oobsize;
4131
4132 chip->buffers = nbuf;
4133 } else {
4134 if (!chip->buffers)
4135 return -ENOMEM;
4136 }
David Woodhouse4bf63fc2006-09-25 17:08:04 +01004137
David Woodhouse7dcdcbef2006-10-21 17:09:53 +01004138 /* Set the internal oob buffer location, just after the page data */
David Woodhouse784f4d52006-10-22 01:47:45 +01004139 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004140
4141 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07004142 * If no default placement scheme is given, select an appropriate one.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004143 */
Huang Shijie97de79e02013-10-18 14:20:53 +08004144 if (!ecc->layout && (ecc->mode != NAND_ECC_SOFT_BCH)) {
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004145 switch (mtd->oobsize) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004146 case 8:
Huang Shijie97de79e02013-10-18 14:20:53 +08004147 ecc->layout = &nand_oob_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004148 break;
4149 case 16:
Huang Shijie97de79e02013-10-18 14:20:53 +08004150 ecc->layout = &nand_oob_16;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004151 break;
4152 case 64:
Huang Shijie97de79e02013-10-18 14:20:53 +08004153 ecc->layout = &nand_oob_64;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004154 break;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01004155 case 128:
Huang Shijie97de79e02013-10-18 14:20:53 +08004156 ecc->layout = &nand_oob_128;
Thomas Gleixner81ec5362007-12-12 17:27:03 +01004157 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004158 default:
Brian Norrisd0370212011-07-19 10:06:08 -07004159 pr_warn("No oob scheme defined for oobsize %d\n",
4160 mtd->oobsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004161 BUG();
4162 }
4163 }
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004164
David Woodhouse956e9442006-09-25 17:12:39 +01004165 if (!chip->write_page)
4166 chip->write_page = nand_write_page;
4167
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004168 /*
Brian Norris8b6e50c2011-05-25 14:59:01 -07004169 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004170 * selected and we have 256 byte pagesize fallback to software ECC
David Woodhousee0c7d762006-05-13 18:07:53 +01004171 */
David Woodhouse956e9442006-09-25 17:12:39 +01004172
Huang Shijie97de79e02013-10-18 14:20:53 +08004173 switch (ecc->mode) {
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07004174 case NAND_ECC_HW_OOB_FIRST:
4175 /* Similar to NAND_ECC_HW, but a separate read_page handle */
Huang Shijie97de79e02013-10-18 14:20:53 +08004176 if (!ecc->calculate || !ecc->correct || !ecc->hwctl) {
Rafał Miłecki2ac63d92014-08-19 13:55:34 +02004177 pr_warn("No ECC functions supplied; hardware ECC not possible\n");
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07004178 BUG();
4179 }
Huang Shijie97de79e02013-10-18 14:20:53 +08004180 if (!ecc->read_page)
4181 ecc->read_page = nand_read_page_hwecc_oob_first;
Sneha Narnakaje6e0cb132009-09-18 12:51:47 -07004182
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004183 case NAND_ECC_HW:
Brian Norris8b6e50c2011-05-25 14:59:01 -07004184 /* Use standard hwecc read page function? */
Huang Shijie97de79e02013-10-18 14:20:53 +08004185 if (!ecc->read_page)
4186 ecc->read_page = nand_read_page_hwecc;
4187 if (!ecc->write_page)
4188 ecc->write_page = nand_write_page_hwecc;
4189 if (!ecc->read_page_raw)
4190 ecc->read_page_raw = nand_read_page_raw;
4191 if (!ecc->write_page_raw)
4192 ecc->write_page_raw = nand_write_page_raw;
4193 if (!ecc->read_oob)
4194 ecc->read_oob = nand_read_oob_std;
4195 if (!ecc->write_oob)
4196 ecc->write_oob = nand_write_oob_std;
4197 if (!ecc->read_subpage)
4198 ecc->read_subpage = nand_read_subpage;
Helmut Schaa44991b32014-04-09 11:13:24 +02004199 if (!ecc->write_subpage && ecc->hwctl && ecc->calculate)
Huang Shijie97de79e02013-10-18 14:20:53 +08004200 ecc->write_subpage = nand_write_subpage_hwecc;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02004201
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004202 case NAND_ECC_HW_SYNDROME:
Huang Shijie97de79e02013-10-18 14:20:53 +08004203 if ((!ecc->calculate || !ecc->correct || !ecc->hwctl) &&
4204 (!ecc->read_page ||
4205 ecc->read_page == nand_read_page_hwecc ||
4206 !ecc->write_page ||
4207 ecc->write_page == nand_write_page_hwecc)) {
Rafał Miłecki2ac63d92014-08-19 13:55:34 +02004208 pr_warn("No ECC functions supplied; hardware ECC not possible\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004209 BUG();
4210 }
Brian Norris8b6e50c2011-05-25 14:59:01 -07004211 /* Use standard syndrome read/write page function? */
Huang Shijie97de79e02013-10-18 14:20:53 +08004212 if (!ecc->read_page)
4213 ecc->read_page = nand_read_page_syndrome;
4214 if (!ecc->write_page)
4215 ecc->write_page = nand_write_page_syndrome;
4216 if (!ecc->read_page_raw)
4217 ecc->read_page_raw = nand_read_page_raw_syndrome;
4218 if (!ecc->write_page_raw)
4219 ecc->write_page_raw = nand_write_page_raw_syndrome;
4220 if (!ecc->read_oob)
4221 ecc->read_oob = nand_read_oob_syndrome;
4222 if (!ecc->write_oob)
4223 ecc->write_oob = nand_write_oob_syndrome;
Thomas Gleixnerf5bbdac2006-05-25 10:07:16 +02004224
Huang Shijie97de79e02013-10-18 14:20:53 +08004225 if (mtd->writesize >= ecc->size) {
4226 if (!ecc->strength) {
Mike Dunne2788c92012-04-25 12:06:10 -07004227 pr_warn("Driver must set ecc.strength when using hardware ECC\n");
4228 BUG();
4229 }
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004230 break;
Mike Dunne2788c92012-04-25 12:06:10 -07004231 }
Rafał Miłecki2ac63d92014-08-19 13:55:34 +02004232 pr_warn("%d byte HW ECC not possible on %d byte page size, fallback to SW ECC\n",
4233 ecc->size, mtd->writesize);
Huang Shijie97de79e02013-10-18 14:20:53 +08004234 ecc->mode = NAND_ECC_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004235
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004236 case NAND_ECC_SOFT:
Huang Shijie97de79e02013-10-18 14:20:53 +08004237 ecc->calculate = nand_calculate_ecc;
4238 ecc->correct = nand_correct_data;
4239 ecc->read_page = nand_read_page_swecc;
4240 ecc->read_subpage = nand_read_subpage;
4241 ecc->write_page = nand_write_page_swecc;
4242 ecc->read_page_raw = nand_read_page_raw;
4243 ecc->write_page_raw = nand_write_page_raw;
4244 ecc->read_oob = nand_read_oob_std;
4245 ecc->write_oob = nand_write_oob_std;
4246 if (!ecc->size)
4247 ecc->size = 256;
4248 ecc->bytes = 3;
4249 ecc->strength = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004250 break;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004251
Ivan Djelic193bd402011-03-11 11:05:33 +01004252 case NAND_ECC_SOFT_BCH:
4253 if (!mtd_nand_has_bch()) {
Erico Nunes148256f2014-03-11 01:31:26 -03004254 pr_warn("CONFIG_MTD_NAND_ECC_BCH not enabled\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01004255 BUG();
4256 }
Huang Shijie97de79e02013-10-18 14:20:53 +08004257 ecc->calculate = nand_bch_calculate_ecc;
4258 ecc->correct = nand_bch_correct_data;
4259 ecc->read_page = nand_read_page_swecc;
4260 ecc->read_subpage = nand_read_subpage;
4261 ecc->write_page = nand_write_page_swecc;
4262 ecc->read_page_raw = nand_read_page_raw;
4263 ecc->write_page_raw = nand_write_page_raw;
4264 ecc->read_oob = nand_read_oob_std;
4265 ecc->write_oob = nand_write_oob_std;
Ivan Djelic193bd402011-03-11 11:05:33 +01004266 /*
Aaron Sierrae0377cd2015-01-14 17:41:31 -06004267 * Board driver should supply ecc.size and ecc.strength values
4268 * to select how many bits are correctable. Otherwise, default
4269 * to 4 bits for large page devices.
Ivan Djelic193bd402011-03-11 11:05:33 +01004270 */
Huang Shijie97de79e02013-10-18 14:20:53 +08004271 if (!ecc->size && (mtd->oobsize >= 64)) {
4272 ecc->size = 512;
Aaron Sierrae0377cd2015-01-14 17:41:31 -06004273 ecc->strength = 4;
Ivan Djelic193bd402011-03-11 11:05:33 +01004274 }
Aaron Sierrae0377cd2015-01-14 17:41:31 -06004275
4276 /* See nand_bch_init() for details. */
Boris BREZILLONa8c65d52016-03-07 10:46:54 +01004277 ecc->bytes = 0;
4278 ecc->priv = nand_bch_init(mtd);
Huang Shijie97de79e02013-10-18 14:20:53 +08004279 if (!ecc->priv) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07004280 pr_warn("BCH ECC initialization failed!\n");
Ivan Djelic193bd402011-03-11 11:05:33 +01004281 BUG();
4282 }
4283 break;
4284
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004285 case NAND_ECC_NONE:
Rafał Miłecki2ac63d92014-08-19 13:55:34 +02004286 pr_warn("NAND_ECC_NONE selected by board driver. This is not recommended!\n");
Huang Shijie97de79e02013-10-18 14:20:53 +08004287 ecc->read_page = nand_read_page_raw;
4288 ecc->write_page = nand_write_page_raw;
4289 ecc->read_oob = nand_read_oob_std;
4290 ecc->read_page_raw = nand_read_page_raw;
4291 ecc->write_page_raw = nand_write_page_raw;
4292 ecc->write_oob = nand_write_oob_std;
4293 ecc->size = mtd->writesize;
4294 ecc->bytes = 0;
4295 ecc->strength = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004296 break;
David Woodhouse956e9442006-09-25 17:12:39 +01004297
Linus Torvalds1da177e2005-04-16 15:20:36 -07004298 default:
Huang Shijie97de79e02013-10-18 14:20:53 +08004299 pr_warn("Invalid NAND_ECC_MODE %d\n", ecc->mode);
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004300 BUG();
4301 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004302
Brian Norris9ce244b2011-08-30 18:45:37 -07004303 /* For many systems, the standard OOB write also works for raw */
Huang Shijie97de79e02013-10-18 14:20:53 +08004304 if (!ecc->read_oob_raw)
4305 ecc->read_oob_raw = ecc->read_oob;
4306 if (!ecc->write_oob_raw)
4307 ecc->write_oob_raw = ecc->write_oob;
Brian Norris9ce244b2011-08-30 18:45:37 -07004308
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004309 /*
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004310 * The number of bytes available for a client to place data into
Brian Norris8b6e50c2011-05-25 14:59:01 -07004311 * the out of band area.
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004312 */
Boris BREZILLONf5b8aa72016-03-07 10:46:51 +01004313 mtd->oobavail = 0;
4314 if (ecc->layout) {
4315 for (i = 0; ecc->layout->oobfree[i].length; i++)
4316 mtd->oobavail += ecc->layout->oobfree[i].length;
4317 }
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004318
Thomas Petazzoni54c39e92014-07-02 15:16:32 +02004319 /* ECC sanity check: warn if it's too weak */
4320 if (!nand_ecc_strength_good(mtd))
4321 pr_warn("WARNING: %s: the ECC used on your system is too weak compared to the one required by the NAND chip\n",
4322 mtd->name);
Ezequiel Garcia67a9ad92014-05-14 14:58:06 -03004323
Thomas Gleixner5bd34c02006-05-27 22:16:10 +02004324 /*
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004325 * Set the number of read / write steps for one page depending on ECC
Brian Norris8b6e50c2011-05-25 14:59:01 -07004326 * mode.
Thomas Gleixner7aa65bf2006-05-23 11:54:38 +02004327 */
Huang Shijie97de79e02013-10-18 14:20:53 +08004328 ecc->steps = mtd->writesize / ecc->size;
4329 if (ecc->steps * ecc->size != mtd->writesize) {
Brian Norris9a4d4d62011-07-19 10:06:07 -07004330 pr_warn("Invalid ECC parameters\n");
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +02004331 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07004332 }
Huang Shijie97de79e02013-10-18 14:20:53 +08004333 ecc->total = ecc->steps * ecc->bytes;
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004334
Brian Norris8b6e50c2011-05-25 14:59:01 -07004335 /* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
Huang Shijie1d0ed692013-09-25 14:58:10 +08004336 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) && nand_is_slc(chip)) {
Huang Shijie97de79e02013-10-18 14:20:53 +08004337 switch (ecc->steps) {
Thomas Gleixner29072b92006-09-28 15:38:36 +02004338 case 2:
4339 mtd->subpage_sft = 1;
4340 break;
4341 case 4:
4342 case 8:
Thomas Gleixner81ec5362007-12-12 17:27:03 +01004343 case 16:
Thomas Gleixner29072b92006-09-28 15:38:36 +02004344 mtd->subpage_sft = 2;
4345 break;
4346 }
4347 }
4348 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
4349
Thomas Gleixner04bbd0e2006-05-25 09:45:29 +02004350 /* Initialize state */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004351 chip->state = FL_READY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004352
Linus Torvalds1da177e2005-04-16 15:20:36 -07004353 /* Invalidate the pagebuffer reference */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004354 chip->pagebuf = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004355
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05004356 /* Large page NAND with SOFT_ECC should support subpage reads */
Ron Lee4007e2d2014-04-25 15:01:35 +09304357 switch (ecc->mode) {
4358 case NAND_ECC_SOFT:
4359 case NAND_ECC_SOFT_BCH:
4360 if (chip->page_shift > 9)
4361 chip->options |= NAND_SUBPAGE_READ;
4362 break;
4363
4364 default:
4365 break;
4366 }
Jeff Westfahla5ff4f12012-08-13 16:35:30 -05004367
Linus Torvalds1da177e2005-04-16 15:20:36 -07004368 /* Fill in remaining MTD driver data */
Huang Shijie963d1c22013-09-25 14:58:21 +08004369 mtd->type = nand_is_slc(chip) ? MTD_NANDFLASH : MTD_MLCNANDFLASH;
Maxim Levitsky93edbad2010-02-22 20:39:40 +02004370 mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
4371 MTD_CAP_NANDFLASH;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02004372 mtd->_erase = nand_erase;
4373 mtd->_point = NULL;
4374 mtd->_unpoint = NULL;
4375 mtd->_read = nand_read;
4376 mtd->_write = nand_write;
4377 mtd->_panic_write = panic_nand_write;
4378 mtd->_read_oob = nand_read_oob;
4379 mtd->_write_oob = nand_write_oob;
4380 mtd->_sync = nand_sync;
4381 mtd->_lock = NULL;
4382 mtd->_unlock = NULL;
4383 mtd->_suspend = nand_suspend;
4384 mtd->_resume = nand_resume;
Scott Branden72ea4032014-11-20 11:18:05 -08004385 mtd->_reboot = nand_shutdown;
Ezequiel Garcia8471bb72014-05-21 19:06:12 -03004386 mtd->_block_isreserved = nand_block_isreserved;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02004387 mtd->_block_isbad = nand_block_isbad;
4388 mtd->_block_markbad = nand_block_markbad;
Anatolij Gustschincbcab652010-12-16 23:42:16 +01004389 mtd->writebufsize = mtd->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004390
Mike Dunn6a918ba2012-03-11 14:21:11 -07004391 /* propagate ecc info to mtd_info */
Huang Shijie97de79e02013-10-18 14:20:53 +08004392 mtd->ecclayout = ecc->layout;
4393 mtd->ecc_strength = ecc->strength;
4394 mtd->ecc_step_size = ecc->size;
Shmulik Ladkaniea3b2ea2012-06-08 18:29:06 +03004395 /*
4396 * Initialize bitflip_threshold to its default prior scan_bbt() call.
4397 * scan_bbt() might invoke mtd_read(), thus bitflip_threshold must be
4398 * properly set.
4399 */
4400 if (!mtd->bitflip_threshold)
Brian Norris240181f2015-01-12 12:51:29 -08004401 mtd->bitflip_threshold = DIV_ROUND_UP(mtd->ecc_strength * 3, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004402
Thomas Gleixner0040bf32005-02-09 12:20:00 +00004403 /* Check, if we should skip the bad block table scan */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004404 if (chip->options & NAND_SKIP_BBTSCAN)
Thomas Gleixner0040bf32005-02-09 12:20:00 +00004405 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004406
4407 /* Build bad block table */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004408 return chip->scan_bbt(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004409}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02004410EXPORT_SYMBOL(nand_scan_tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004411
Brian Norris8b6e50c2011-05-25 14:59:01 -07004412/*
4413 * is_module_text_address() isn't exported, and it's mostly a pointless
Florian Fainelli7351d3a2010-09-07 13:23:45 +02004414 * test if this is a module _anyway_ -- they'd have to try _really_ hard
Brian Norris8b6e50c2011-05-25 14:59:01 -07004415 * to call us from in-kernel code if the core NAND support is modular.
4416 */
David Woodhouse3b85c322006-09-25 17:06:53 +01004417#ifdef MODULE
4418#define caller_is_module() (1)
4419#else
4420#define caller_is_module() \
Rusty Russella6e6abd2009-03-31 13:05:31 -06004421 is_module_text_address((unsigned long)__builtin_return_address(0))
David Woodhouse3b85c322006-09-25 17:06:53 +01004422#endif
4423
4424/**
4425 * nand_scan - [NAND Interface] Scan for the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07004426 * @mtd: MTD device structure
4427 * @maxchips: number of chips to scan for
David Woodhouse3b85c322006-09-25 17:06:53 +01004428 *
Brian Norris8b6e50c2011-05-25 14:59:01 -07004429 * This fills out all the uninitialized function pointers with the defaults.
4430 * The flash ID is read and the mtd/chip structures are filled with the
Ezequiel GarcĂ­a20c07a52016-04-01 18:29:23 -03004431 * appropriate values.
David Woodhouse3b85c322006-09-25 17:06:53 +01004432 */
4433int nand_scan(struct mtd_info *mtd, int maxchips)
4434{
4435 int ret;
4436
David Woodhouse5e81e882010-02-26 18:32:56 +00004437 ret = nand_scan_ident(mtd, maxchips, NULL);
David Woodhouse3b85c322006-09-25 17:06:53 +01004438 if (!ret)
4439 ret = nand_scan_tail(mtd);
4440 return ret;
4441}
Florian Fainelli7351d3a2010-09-07 13:23:45 +02004442EXPORT_SYMBOL(nand_scan);
David Woodhouse3b85c322006-09-25 17:06:53 +01004443
Linus Torvalds1da177e2005-04-16 15:20:36 -07004444/**
Thomas Gleixner61b03bd2005-11-07 11:15:49 +00004445 * nand_release - [NAND Interface] Free resources held by the NAND device
Brian Norris8b6e50c2011-05-25 14:59:01 -07004446 * @mtd: MTD device structure
4447 */
David Woodhousee0c7d762006-05-13 18:07:53 +01004448void nand_release(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004449{
Boris BREZILLON862eba52015-12-01 12:03:03 +01004450 struct nand_chip *chip = mtd_to_nand(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004451
Ivan Djelic193bd402011-03-11 11:05:33 +01004452 if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
4453 nand_bch_free((struct nand_bch_control *)chip->ecc.priv);
4454
Jamie Iles5ffcaf32011-05-23 10:22:46 +01004455 mtd_device_unregister(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004456
Jesper Juhlfa671642005-11-07 01:01:27 -08004457 /* Free bad block table memory */
Thomas Gleixnerace4dfe2006-05-24 12:07:37 +02004458 kfree(chip->bbt);
David Woodhouse4bf63fc2006-09-25 17:08:04 +01004459 if (!(chip->options & NAND_OWN_BUFFERS))
4460 kfree(chip->buffers);
Brian Norris58373ff2010-07-15 12:15:44 -07004461
4462 /* Free bad block descriptor memory */
4463 if (chip->badblock_pattern && chip->badblock_pattern->options
4464 & NAND_BBT_DYNAMICSTRUCT)
4465 kfree(chip->badblock_pattern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004466}
David Woodhousee0c7d762006-05-13 18:07:53 +01004467EXPORT_SYMBOL_GPL(nand_release);
Richard Purdie8fe833c2006-03-31 02:31:14 -08004468
4469static int __init nand_base_init(void)
4470{
4471 led_trigger_register_simple("nand-disk", &nand_led_trigger);
4472 return 0;
4473}
4474
4475static void __exit nand_base_exit(void)
4476{
4477 led_trigger_unregister_simple(nand_led_trigger);
4478}
4479
4480module_init(nand_base_init);
4481module_exit(nand_base_exit);
4482
David Woodhousee0c7d762006-05-13 18:07:53 +01004483MODULE_LICENSE("GPL");
Florian Fainelli7351d3a2010-09-07 13:23:45 +02004484MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
4485MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
David Woodhousee0c7d762006-05-13 18:07:53 +01004486MODULE_DESCRIPTION("Generic NAND flash driver code");