nand_base.c 97.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/*
 *  drivers/mtd/nand.c
 *
 *  Overview:
 *   This is the generic MTD driver for NAND flash devices. It should be
 *   capable of working with almost all NAND chips currently available.
 *   Basic support for AG-AND chips is provided.
8
 *
L
Linus Torvalds 已提交
9
 *	Additional technical information is available on
10
 *	http://www.linux-mtd.infradead.org/doc/nand.html
11
 *
L
Linus Torvalds 已提交
12
 *  Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
13
 *		  2002-2006 Thomas Gleixner (tglx@linutronix.de)
L
Linus Torvalds 已提交
14
 *
15
 *  Credits:
16 17
 *	David Woodhouse for adding multichip support
 *
L
Linus Torvalds 已提交
18 19 20
 *	Aleph One Ltd. and Toby Churchill Ltd. for supporting the
 *	rework for 2K page size chips
 *
21
 *  TODO:
L
Linus Torvalds 已提交
22 23
 *	Enable cached programming for 2k page size chips
 *	Check, if mtd->ecctype should be set to MTD_ECC_HW
24
 *	if we have HW ECC support.
L
Linus Torvalds 已提交
25 26
 *	The AG-AND chips have nice features for speed improvement,
 *	which are not supported yet. Read / program 4 pages in one go.
27
 *	BBT table is not serialized, has to be fixed
L
Linus Torvalds 已提交
28 29 30 31 32 33 34
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */

35
#include <linux/module.h>
L
Linus Torvalds 已提交
36 37
#include <linux/delay.h>
#include <linux/errno.h>
T
Thomas Gleixner 已提交
38
#include <linux/err.h>
L
Linus Torvalds 已提交
39 40 41 42 43 44
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/nand_ecc.h>
45
#include <linux/mtd/nand_bch.h>
L
Linus Torvalds 已提交
46 47
#include <linux/interrupt.h>
#include <linux/bitops.h>
48
#include <linux/leds.h>
49
#include <linux/io.h>
L
Linus Torvalds 已提交
50 51 52
#include <linux/mtd/partitions.h>

/* Define default oob placement schemes for large and small page devices */
53
static struct nand_ecclayout nand_oob_8 = {
L
Linus Torvalds 已提交
54 55
	.eccbytes = 3,
	.eccpos = {0, 1, 2},
56 57 58 59
	.oobfree = {
		{.offset = 3,
		 .length = 2},
		{.offset = 6,
60
		 .length = 2} }
L
Linus Torvalds 已提交
61 62
};

63
static struct nand_ecclayout nand_oob_16 = {
L
Linus Torvalds 已提交
64 65
	.eccbytes = 6,
	.eccpos = {0, 1, 2, 3, 6, 7},
66 67
	.oobfree = {
		{.offset = 8,
68
		 . length = 8} }
L
Linus Torvalds 已提交
69 70
};

71
static struct nand_ecclayout nand_oob_64 = {
L
Linus Torvalds 已提交
72 73
	.eccbytes = 24,
	.eccpos = {
74 75 76
		   40, 41, 42, 43, 44, 45, 46, 47,
		   48, 49, 50, 51, 52, 53, 54, 55,
		   56, 57, 58, 59, 60, 61, 62, 63},
77 78
	.oobfree = {
		{.offset = 2,
79
		 .length = 38} }
L
Linus Torvalds 已提交
80 81
};

82 83 84 85 86 87 88 89 90 91 92
static struct nand_ecclayout nand_oob_128 = {
	.eccbytes = 48,
	.eccpos = {
		   80, 81, 82, 83, 84, 85, 86, 87,
		   88, 89, 90, 91, 92, 93, 94, 95,
		   96, 97, 98, 99, 100, 101, 102, 103,
		   104, 105, 106, 107, 108, 109, 110, 111,
		   112, 113, 114, 115, 116, 117, 118, 119,
		   120, 121, 122, 123, 124, 125, 126, 127},
	.oobfree = {
		{.offset = 2,
93
		 .length = 78} }
94 95
};

96
static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
97
			   int new_state);
L
Linus Torvalds 已提交
98

99 100 101
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops);

T
Thomas Gleixner 已提交
102
/*
J
Joe Perches 已提交
103
 * For devices which display every fart in the system on a separate LED. Is
T
Thomas Gleixner 已提交
104 105 106 107
 * compiled away when LED support is disabled.
 */
DEFINE_LED_TRIGGER(nand_led_trigger);

108 109 110 111 112 113 114 115
static int check_offs_len(struct mtd_info *mtd,
					loff_t ofs, uint64_t len)
{
	struct nand_chip *chip = mtd->priv;
	int ret = 0;

	/* Start address must align on block boundary */
	if (ofs & ((1 << chip->phys_erase_shift) - 1)) {
116
		pr_debug("%s: unaligned address\n", __func__);
117 118 119 120 121
		ret = -EINVAL;
	}

	/* Length must align on block boundary */
	if (len & ((1 << chip->phys_erase_shift) - 1)) {
122
		pr_debug("%s: length not block aligned\n", __func__);
123 124 125 126 127 128
		ret = -EINVAL;
	}

	return ret;
}

L
Linus Torvalds 已提交
129 130
/**
 * nand_release_device - [GENERIC] release chip
131
 * @mtd: MTD device structure
132
 *
133
 * Deselect, release chip lock and wake up anyone waiting on the device.
L
Linus Torvalds 已提交
134
 */
135
static void nand_release_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
136
{
137
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
138 139

	/* De-select the NAND device */
140
	chip->select_chip(mtd, -1);
141

T
Thomas Gleixner 已提交
142
	/* Release the controller and the chip */
143 144 145 146 147
	spin_lock(&chip->controller->lock);
	chip->controller->active = NULL;
	chip->state = FL_READY;
	wake_up(&chip->controller->wq);
	spin_unlock(&chip->controller->lock);
L
Linus Torvalds 已提交
148 149 150 151
}

/**
 * nand_read_byte - [DEFAULT] read one byte from the chip
152
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
153
 *
154
 * Default read function for 8bit buswidth
L
Linus Torvalds 已提交
155
 */
156
static uint8_t nand_read_byte(struct mtd_info *mtd)
L
Linus Torvalds 已提交
157
{
158 159
	struct nand_chip *chip = mtd->priv;
	return readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
160 161 162
}

/**
M
Masanari Iida 已提交
163
 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
164
 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
165
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
166
 *
167 168
 * Default read function for 16bit buswidth with endianness conversion.
 *
L
Linus Torvalds 已提交
169
 */
170
static uint8_t nand_read_byte16(struct mtd_info *mtd)
L
Linus Torvalds 已提交
171
{
172 173
	struct nand_chip *chip = mtd->priv;
	return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
L
Linus Torvalds 已提交
174 175 176 177
}

/**
 * nand_read_word - [DEFAULT] read one word from the chip
178
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
179
 *
180
 * Default read function for 16bit buswidth without endianness conversion.
L
Linus Torvalds 已提交
181 182 183
 */
static u16 nand_read_word(struct mtd_info *mtd)
{
184 185
	struct nand_chip *chip = mtd->priv;
	return readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
186 187 188 189
}

/**
 * nand_select_chip - [DEFAULT] control CE line
190 191
 * @mtd: MTD device structure
 * @chipnr: chipnumber to select, -1 for deselect
L
Linus Torvalds 已提交
192 193 194
 *
 * Default select function for 1 chip devices.
 */
195
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
L
Linus Torvalds 已提交
196
{
197 198 199
	struct nand_chip *chip = mtd->priv;

	switch (chipnr) {
L
Linus Torvalds 已提交
200
	case -1:
201
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
202 203 204 205 206 207 208 209 210 211 212
		break;
	case 0:
		break;

	default:
		BUG();
	}
}

/**
 * nand_write_buf - [DEFAULT] write buffer to chip
213 214 215
 * @mtd: MTD device structure
 * @buf: data buffer
 * @len: number of bytes to write
L
Linus Torvalds 已提交
216
 *
217
 * Default write function for 8bit buswidth.
L
Linus Torvalds 已提交
218
 */
219
static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
220 221
{
	int i;
222
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
223

224
	for (i = 0; i < len; i++)
225
		writeb(buf[i], chip->IO_ADDR_W);
L
Linus Torvalds 已提交
226 227 228
}

/**
229
 * nand_read_buf - [DEFAULT] read chip data into buffer
230 231 232
 * @mtd: MTD device structure
 * @buf: buffer to store date
 * @len: number of bytes to read
L
Linus Torvalds 已提交
233
 *
234
 * Default read function for 8bit buswidth.
L
Linus Torvalds 已提交
235
 */
236
static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
237 238
{
	int i;
239
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
240

241
	for (i = 0; i < len; i++)
242
		buf[i] = readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
243 244 245 246
}

/**
 * nand_write_buf16 - [DEFAULT] write buffer to chip
247 248 249
 * @mtd: MTD device structure
 * @buf: data buffer
 * @len: number of bytes to write
L
Linus Torvalds 已提交
250
 *
251
 * Default write function for 16bit buswidth.
L
Linus Torvalds 已提交
252
 */
253
static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
254 255
{
	int i;
256
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
257 258
	u16 *p = (u16 *) buf;
	len >>= 1;
259

260
	for (i = 0; i < len; i++)
261
		writew(p[i], chip->IO_ADDR_W);
262

L
Linus Torvalds 已提交
263 264 265
}

/**
266
 * nand_read_buf16 - [DEFAULT] read chip data into buffer
267 268 269
 * @mtd: MTD device structure
 * @buf: buffer to store date
 * @len: number of bytes to read
L
Linus Torvalds 已提交
270
 *
271
 * Default read function for 16bit buswidth.
L
Linus Torvalds 已提交
272
 */
273
static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
274 275
{
	int i;
276
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
277 278 279
	u16 *p = (u16 *) buf;
	len >>= 1;

280
	for (i = 0; i < len; i++)
281
		p[i] = readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
282 283 284 285
}

/**
 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
286 287 288
 * @mtd: MTD device structure
 * @ofs: offset from device start
 * @getchip: 0, if the chip is already selected
L
Linus Torvalds 已提交
289
 *
290
 * Check, if the block is bad.
L
Linus Torvalds 已提交
291 292 293
 */
static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
{
294
	int page, chipnr, res = 0, i = 0;
295
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
296 297
	u16 bad;

298
	if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
299 300
		ofs += mtd->erasesize - mtd->writesize;

301 302
	page = (int)(ofs >> chip->page_shift) & chip->pagemask;

L
Linus Torvalds 已提交
303
	if (getchip) {
304
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
305

306
		nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
307 308

		/* Select the NAND device */
309
		chip->select_chip(mtd, chipnr);
310
	}
L
Linus Torvalds 已提交
311

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
	do {
		if (chip->options & NAND_BUSWIDTH_16) {
			chip->cmdfunc(mtd, NAND_CMD_READOOB,
					chip->badblockpos & 0xFE, page);
			bad = cpu_to_le16(chip->read_word(mtd));
			if (chip->badblockpos & 0x1)
				bad >>= 8;
			else
				bad &= 0xFF;
		} else {
			chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
					page);
			bad = chip->read_byte(mtd);
		}

		if (likely(chip->badblockbits == 8))
			res = bad != 0xFF;
329
		else
330 331 332 333 334
			res = hweight8(bad) < chip->badblockbits;
		ofs += mtd->writesize;
		page = (int)(ofs >> chip->page_shift) & chip->pagemask;
		i++;
	} while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
335

336
	if (getchip)
L
Linus Torvalds 已提交
337
		nand_release_device(mtd);
338

L
Linus Torvalds 已提交
339 340 341 342 343
	return res;
}

/**
 * nand_default_block_markbad - [DEFAULT] mark a block bad
344 345
 * @mtd: MTD device structure
 * @ofs: offset from device start
L
Linus Torvalds 已提交
346
 *
347
 * This is the default implementation, which can be overridden by a hardware
348 349 350 351 352 353 354 355
 * specific driver. We try operations in the following order, according to our
 * bbt_options (NAND_BBT_NO_OOB_BBM and NAND_BBT_USE_FLASH):
 *  (1) erase the affected block, to allow OOB marker to be written cleanly
 *  (2) update in-memory BBT
 *  (3) write bad block marker to OOB area of affected block
 *  (4) update flash-based BBT
 * Note that we retain the first error encountered in (3) or (4), finish the
 * procedures, and dump the error in the end.
L
Linus Torvalds 已提交
356 357 358
*/
static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
{
359
	struct nand_chip *chip = mtd->priv;
360
	uint8_t buf[2] = { 0, 0 };
361 362
	int block, res, ret = 0, i = 0;
	int write_oob = !(chip->bbt_options & NAND_BBT_NO_OOB_BBM);
363

364
	if (write_oob) {
365 366 367 368 369 370 371 372 373 374
		struct erase_info einfo;

		/* Attempt erase before marking OOB */
		memset(&einfo, 0, sizeof(einfo));
		einfo.mtd = mtd;
		einfo.addr = ofs;
		einfo.len = 1 << chip->phys_erase_shift;
		nand_erase_nand(mtd, &einfo, 0);
	}

L
Linus Torvalds 已提交
375
	/* Get block number */
376
	block = (int)(ofs >> chip->bbt_erase_shift);
377
	/* Mark block bad in memory-based BBT */
378 379
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
380

381 382
	/* Write bad block marker to OOB */
	if (write_oob) {
383
		struct mtd_oob_ops ops;
384
		loff_t wr_ofs = ofs;
385

386
		nand_get_device(chip, mtd, FL_WRITING);
387

388 389
		ops.datbuf = NULL;
		ops.oobbuf = buf;
390 391 392 393 394 395 396
		ops.ooboffs = chip->badblockpos;
		if (chip->options & NAND_BUSWIDTH_16) {
			ops.ooboffs &= ~0x01;
			ops.len = ops.ooblen = 2;
		} else {
			ops.len = ops.ooblen = 1;
		}
B
Brian Norris 已提交
397
		ops.mode = MTD_OPS_PLACE_OOB;
398

399
		/* Write to first/last page(s) if necessary */
400 401
		if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
			wr_ofs += mtd->erasesize - mtd->writesize;
402
		do {
403 404 405
			res = nand_do_write_oob(mtd, wr_ofs, &ops);
			if (!ret)
				ret = res;
406 407

			i++;
408
			wr_ofs += mtd->writesize;
409
		} while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
410

411
		nand_release_device(mtd);
412
	}
413 414 415 416 417 418 419 420

	/* Update flash-based bad block table */
	if (chip->bbt_options & NAND_BBT_USE_FLASH) {
		res = nand_update_bbt(mtd, ofs);
		if (!ret)
			ret = res;
	}

421 422
	if (!ret)
		mtd->ecc_stats.badblocks++;
423

424
	return ret;
L
Linus Torvalds 已提交
425 426
}

427
/**
L
Linus Torvalds 已提交
428
 * nand_check_wp - [GENERIC] check if the chip is write protected
429
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
430
 *
431 432
 * Check, if the device is write protected. The function expects, that the
 * device is already selected.
L
Linus Torvalds 已提交
433
 */
434
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
435
{
436
	struct nand_chip *chip = mtd->priv;
437

438
	/* Broken xD cards report WP despite being writable */
439 440 441
	if (chip->options & NAND_BROKEN_XD)
		return 0;

L
Linus Torvalds 已提交
442
	/* Check the WP bit */
443 444
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
445 446 447 448
}

/**
 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
449 450 451 452
 * @mtd: MTD device structure
 * @ofs: offset from device start
 * @getchip: 0, if the chip is already selected
 * @allowbbt: 1, if its allowed to access the bbt area
L
Linus Torvalds 已提交
453 454 455 456
 *
 * Check, if the block is bad. Either by reading the bad block table or
 * calling of the scan function.
 */
457 458
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
459
{
460
	struct nand_chip *chip = mtd->priv;
461

462 463
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
464

L
Linus Torvalds 已提交
465
	/* Return info from the table */
466
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
467 468
}

469 470
/**
 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
471 472
 * @mtd: MTD device structure
 * @timeo: Timeout
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
 *
 * Helper function for nand_wait_ready used when needing to wait in interrupt
 * context.
 */
static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
{
	struct nand_chip *chip = mtd->priv;
	int i;

	/* Wait for the device to get ready */
	for (i = 0; i < timeo; i++) {
		if (chip->dev_ready(mtd))
			break;
		touch_softlockup_watchdog();
		mdelay(1);
	}
}

491
/* Wait for the ready pin, after a command. The timeout is caught later. */
492
void nand_wait_ready(struct mtd_info *mtd)
493
{
494
	struct nand_chip *chip = mtd->priv;
495
	unsigned long timeo = jiffies + 2;
496

497 498 499 500
	/* 400ms timeout */
	if (in_interrupt() || oops_in_progress)
		return panic_nand_wait_ready(mtd, 400);

501
	led_trigger_event(nand_led_trigger, LED_FULL);
502
	/* Wait until command is processed or timeout occurs */
503
	do {
504
		if (chip->dev_ready(mtd))
505
			break;
I
Ingo Molnar 已提交
506
		touch_softlockup_watchdog();
507
	} while (time_before(jiffies, timeo));
508
	led_trigger_event(nand_led_trigger, LED_OFF);
509
}
510
EXPORT_SYMBOL_GPL(nand_wait_ready);
511

L
Linus Torvalds 已提交
512 513
/**
 * nand_command - [DEFAULT] Send command to NAND device
514 515 516 517
 * @mtd: MTD device structure
 * @command: the command to be sent
 * @column: the column address for this command, -1 if none
 * @page_addr: the page address for this command, -1 if none
L
Linus Torvalds 已提交
518
 *
519 520
 * Send command to NAND device. This function is used for small page devices
 * (256/512 Bytes per page).
L
Linus Torvalds 已提交
521
 */
522 523
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
524
{
525
	register struct nand_chip *chip = mtd->priv;
526
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
527

528
	/* Write out the command to the device */
L
Linus Torvalds 已提交
529 530 531
	if (command == NAND_CMD_SEQIN) {
		int readcmd;

J
Joern Engel 已提交
532
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
533
			/* OOB area */
J
Joern Engel 已提交
534
			column -= mtd->writesize;
L
Linus Torvalds 已提交
535 536 537 538 539 540 541 542
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
543
		chip->cmd_ctrl(mtd, readcmd, ctrl);
544
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
545
	}
546
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
547

548
	/* Address cycle, when necessary */
549 550 551 552
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
553
		if (chip->options & NAND_BUSWIDTH_16)
554
			column >>= 1;
555
		chip->cmd_ctrl(mtd, column, ctrl);
556 557 558
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
559
		chip->cmd_ctrl(mtd, page_addr, ctrl);
560
		ctrl &= ~NAND_CTRL_CHANGE;
561
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
562
		/* One more address cycle for devices > 32MiB */
563 564
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
565
	}
566
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
567 568

	/*
569 570
	 * Program and erase have their own busy handlers status and sequential
	 * in needs no delay
571
	 */
L
Linus Torvalds 已提交
572
	switch (command) {
573

L
Linus Torvalds 已提交
574 575 576 577 578 579 580 581
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
	case NAND_CMD_STATUS:
		return;

	case NAND_CMD_RESET:
582
		if (chip->dev_ready)
L
Linus Torvalds 已提交
583
			break;
584 585
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
586
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
587 588
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
589 590
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
				;
L
Linus Torvalds 已提交
591 592
		return;

593
		/* This applies to read commands */
L
Linus Torvalds 已提交
594
	default:
595
		/*
L
Linus Torvalds 已提交
596 597
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
598
		 */
599 600
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
601
			return;
602
		}
L
Linus Torvalds 已提交
603
	}
604 605 606 607
	/*
	 * Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine.
	 */
608
	ndelay(100);
609 610

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
611 612 613 614
}

/**
 * nand_command_lp - [DEFAULT] Send command to NAND large page device
615 616 617 618
 * @mtd: MTD device structure
 * @command: the command to be sent
 * @column: the column address for this command, -1 if none
 * @page_addr: the page address for this command, -1 if none
L
Linus Torvalds 已提交
619
 *
620
 * Send command to NAND device. This is the version for the new large page
621 622
 * devices. We don't have the separate regions as we have in the small page
 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
L
Linus Torvalds 已提交
623
 */
624 625
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
626
{
627
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
628 629 630

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
631
		column += mtd->writesize;
L
Linus Torvalds 已提交
632 633
		command = NAND_CMD_READ0;
	}
634

635
	/* Command latch cycle */
636
	chip->cmd_ctrl(mtd, command & 0xff,
637
		       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
638 639

	if (column != -1 || page_addr != -1) {
640
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
641 642 643 644

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
645
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
646
				column >>= 1;
647
			chip->cmd_ctrl(mtd, column, ctrl);
648
			ctrl &= ~NAND_CTRL_CHANGE;
649
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
650
		}
L
Linus Torvalds 已提交
651
		if (page_addr != -1) {
652 653
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
654
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
655
			/* One more address cycle for devices > 128MiB */
656 657
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
658
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
659 660
		}
	}
661
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
662 663

	/*
664 665
	 * Program and erase have their own busy handlers status, sequential
	 * in, and deplete1 need no delay.
666
	 */
L
Linus Torvalds 已提交
667
	switch (command) {
668

L
Linus Torvalds 已提交
669 670 671 672 673
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
674
	case NAND_CMD_RNDIN:
L
Linus Torvalds 已提交
675
	case NAND_CMD_STATUS:
676
	case NAND_CMD_DEPLETE1:
L
Linus Torvalds 已提交
677 678
		return;

679 680 681 682 683
	case NAND_CMD_STATUS_ERROR:
	case NAND_CMD_STATUS_ERROR0:
	case NAND_CMD_STATUS_ERROR1:
	case NAND_CMD_STATUS_ERROR2:
	case NAND_CMD_STATUS_ERROR3:
684
		/* Read error status commands require only a short delay */
685
		udelay(chip->chip_delay);
686
		return;
L
Linus Torvalds 已提交
687 688

	case NAND_CMD_RESET:
689
		if (chip->dev_ready)
L
Linus Torvalds 已提交
690
			break;
691
		udelay(chip->chip_delay);
692 693 694 695
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
696 697
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
				;
L
Linus Torvalds 已提交
698 699
		return;

700 701 702 703 704 705 706 707
	case NAND_CMD_RNDOUT:
		/* No ready / busy check necessary */
		chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
		return;

L
Linus Torvalds 已提交
708
	case NAND_CMD_READ0:
709 710 711 712
		chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
713

714
		/* This applies to read commands */
L
Linus Torvalds 已提交
715
	default:
716
		/*
L
Linus Torvalds 已提交
717
		 * If we don't have access to the busy pin, we apply the given
718
		 * command delay.
719
		 */
720 721
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
722
			return;
723
		}
L
Linus Torvalds 已提交
724
	}
725

726 727 728 729
	/*
	 * Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine.
	 */
730
	ndelay(100);
731 732

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
733 734
}

735 736
/**
 * panic_nand_get_device - [GENERIC] Get chip for selected access
737 738 739
 * @chip: the nand chip descriptor
 * @mtd: MTD device structure
 * @new_state: the state which is requested
740 741 742 743 744 745
 *
 * Used when in panic, no locks are taken.
 */
static void panic_nand_get_device(struct nand_chip *chip,
		      struct mtd_info *mtd, int new_state)
{
746
	/* Hardware controller shared among independent devices */
747 748 749 750
	chip->controller->active = chip;
	chip->state = new_state;
}

L
Linus Torvalds 已提交
751 752
/**
 * nand_get_device - [GENERIC] Get chip for selected access
753 754 755
 * @chip: the nand chip descriptor
 * @mtd: MTD device structure
 * @new_state: the state which is requested
L
Linus Torvalds 已提交
756 757 758
 *
 * Get the device and lock it for exclusive access
 */
759
static int
760
nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
761
{
762 763
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
764
	DECLARE_WAITQUEUE(wait, current);
765
retry:
766 767
	spin_lock(lock);

768
	/* Hardware controller shared among independent devices */
769 770
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
771

772 773
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
774
		spin_unlock(lock);
775 776 777
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
778 779 780 781 782
		if (chip->controller->active->state == FL_PM_SUSPENDED) {
			chip->state = FL_PM_SUSPENDED;
			spin_unlock(lock);
			return 0;
		}
783 784 785 786 787 788
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
789 790 791
	goto retry;
}

792
/**
793 794 795 796
 * panic_nand_wait - [GENERIC] wait until the command is done
 * @mtd: MTD device structure
 * @chip: NAND chip structure
 * @timeo: timeout
797 798 799
 *
 * Wait for command done. This is a helper function for nand_wait used when
 * we are in interrupt context. May happen when in panic and trying to write
800
 * an oops through mtdoops.
801 802 803 804 805 806 807 808 809 810 811 812 813 814
 */
static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
			    unsigned long timeo)
{
	int i;
	for (i = 0; i < timeo; i++) {
		if (chip->dev_ready) {
			if (chip->dev_ready(mtd))
				break;
		} else {
			if (chip->read_byte(mtd) & NAND_STATUS_READY)
				break;
		}
		mdelay(1);
815
	}
816 817
}

L
Linus Torvalds 已提交
818
/**
819 820 821
 * nand_wait - [DEFAULT] wait until the command is done
 * @mtd: MTD device structure
 * @chip: NAND chip structure
L
Linus Torvalds 已提交
822
 *
823 824 825
 * Wait for command done. This applies to erase and program only. Erase can
 * take up to 400ms and program up to 20ms according to general NAND and
 * SmartMedia specs.
R
Randy Dunlap 已提交
826
 */
827
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
828 829
{

830
	unsigned long timeo = jiffies;
831
	int status, state = chip->state;
832

L
Linus Torvalds 已提交
833
	if (state == FL_ERASING)
834
		timeo += (HZ * 400) / 1000;
L
Linus Torvalds 已提交
835
	else
836
		timeo += (HZ * 20) / 1000;
L
Linus Torvalds 已提交
837

838 839
	led_trigger_event(nand_led_trigger, LED_FULL);

840 841 842 843
	/*
	 * Apply this short delay always to ensure that we do wait tWB in any
	 * case on any machine.
	 */
844
	ndelay(100);
L
Linus Torvalds 已提交
845

846 847
	if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
		chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
848
	else
849
		chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
850

851 852 853 854 855 856 857 858 859 860 861 862
	if (in_interrupt() || oops_in_progress)
		panic_nand_wait(mtd, chip, timeo);
	else {
		while (time_before(jiffies, timeo)) {
			if (chip->dev_ready) {
				if (chip->dev_ready(mtd))
					break;
			} else {
				if (chip->read_byte(mtd) & NAND_STATUS_READY)
					break;
			}
			cond_resched();
L
Linus Torvalds 已提交
863 864
		}
	}
865 866
	led_trigger_event(nand_led_trigger, LED_OFF);

867
	status = (int)chip->read_byte(mtd);
868 869
	/* This can happen if in case of timeout or buggy dev_ready */
	WARN_ON(!(status & NAND_STATUS_READY));
L
Linus Torvalds 已提交
870 871 872
	return status;
}

873
/**
874 875 876 877
 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
878 879 880 881
 * @invert: when = 0, unlock the range of blocks within the lower and
 *                    upper boundary address
 *          when = 1, unlock the range of blocks outside the boundaries
 *                    of the lower and upper boundary address
882
 *
883
 * Returs unlock status.
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
 */
static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
					uint64_t len, int invert)
{
	int ret = 0;
	int status, page;
	struct nand_chip *chip = mtd->priv;

	/* Submit address of first page to unlock */
	page = ofs >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);

	/* Submit address of last page to unlock */
	page = (ofs + len) >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
				(page | invert) & chip->pagemask);

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	/* See if device thinks it succeeded */
904
	if (status & NAND_STATUS_FAIL) {
905
		pr_debug("%s: error status = 0x%08x\n",
906 907 908 909 910 911 912 913
					__func__, status);
		ret = -EIO;
	}

	return ret;
}

/**
914 915 916 917
 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
918
 *
919
 * Returns unlock status.
920 921 922 923 924 925 926
 */
int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr;
	struct nand_chip *chip = mtd->priv;

927
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
			__func__, (unsigned long long)ofs, len);

	if (check_offs_len(mtd, ofs, len))
		ret = -EINVAL;

	/* Align to last block address if size addresses end of the device */
	if (ofs + len == mtd->size)
		len -= mtd->erasesize;

	nand_get_device(chip, mtd, FL_UNLOCKING);

	/* Shift to get chip number */
	chipnr = ofs >> chip->chip_shift;

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
946
		pr_debug("%s: device is write protected!\n",
947 948 949 950 951 952 953 954 955 956 957 958
					__func__);
		ret = -EIO;
		goto out;
	}

	ret = __nand_unlock(mtd, ofs, len, 0);

out:
	nand_release_device(mtd);

	return ret;
}
959
EXPORT_SYMBOL(nand_unlock);
960 961

/**
962 963 964 965
 * nand_lock - [REPLACEABLE] locks all blocks present in the device
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
966
 *
967 968 969 970
 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
 * have this feature, but it allows only to lock all blocks, not for specified
 * range for block. Implementing 'lock' feature by making use of 'unlock', for
 * now.
971
 *
972
 * Returns lock status.
973 974 975 976 977 978 979
 */
int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr, status, page;
	struct nand_chip *chip = mtd->priv;

980
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
981 982 983 984 985 986 987 988 989 990 991 992 993 994
			__func__, (unsigned long long)ofs, len);

	if (check_offs_len(mtd, ofs, len))
		ret = -EINVAL;

	nand_get_device(chip, mtd, FL_LOCKING);

	/* Shift to get chip number */
	chipnr = ofs >> chip->chip_shift;

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
995
		pr_debug("%s: device is write protected!\n",
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
					__func__);
		status = MTD_ERASE_FAILED;
		ret = -EIO;
		goto out;
	}

	/* Submit address of first page to lock */
	page = ofs >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	/* See if device thinks it succeeded */
1009
	if (status & NAND_STATUS_FAIL) {
1010
		pr_debug("%s: error status = 0x%08x\n",
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
					__func__, status);
		ret = -EIO;
		goto out;
	}

	ret = __nand_unlock(mtd, ofs, len, 0x1);

out:
	nand_release_device(mtd);

	return ret;
}
1023
EXPORT_SYMBOL(nand_lock);
1024

1025
/**
1026
 * nand_read_page_raw - [INTERN] read raw page data without ecc
1027 1028 1029
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1030
 * @oob_required: caller requires OOB data read to chip->oob_poi
1031
 * @page: page number to read
1032
 *
1033
 * Not for syndrome calculating ECC controllers, which use a special oob layout.
1034 1035
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1036
			      uint8_t *buf, int oob_required, int page)
1037 1038
{
	chip->read_buf(mtd, buf, mtd->writesize);
1039 1040
	if (oob_required)
		chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1041 1042 1043
	return 0;
}

1044
/**
1045
 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
1046 1047 1048
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1049
 * @oob_required: caller requires OOB data read to chip->oob_poi
1050
 * @page: page number to read
1051 1052 1053
 *
 * We need a special oob layout and handling even when OOB isn't used.
 */
1054
static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
1055 1056
				       struct nand_chip *chip, uint8_t *buf,
				       int oob_required, int page)
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
{
	int eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	uint8_t *oob = chip->oob_poi;
	int steps, size;

	for (steps = chip->ecc.steps; steps > 0; steps--) {
		chip->read_buf(mtd, buf, eccsize);
		buf += eccsize;

		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->read_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
		}
	}

	size = mtd->oobsize - (oob - chip->oob_poi);
	if (size)
		chip->read_buf(mtd, oob, size);

	return 0;
}

L
Linus Torvalds 已提交
1088
/**
1089
 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
1090 1091 1092
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1093
 * @oob_required: caller requires OOB data read to chip->oob_poi
1094
 * @page: page number to read
1095
 */
1096
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1097
				uint8_t *buf, int oob_required, int page)
L
Linus Torvalds 已提交
1098
{
1099 1100 1101 1102
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1103 1104
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1105
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1106
	unsigned int max_bitflips = 0;
1107

1108
	chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
1109 1110 1111 1112 1113

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);

	for (i = 0; i < chip->ecc.total; i++)
1114
		ecc_code[i] = chip->oob_poi[eccpos[i]];
1115 1116 1117 1118 1119 1120 1121 1122

	eccsteps = chip->ecc.steps;
	p = buf;

	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;

		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1123
		if (stat < 0) {
1124
			mtd->ecc_stats.failed++;
1125
		} else {
1126
			mtd->ecc_stats.corrected += stat;
1127 1128
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1129
	}
1130
	return max_bitflips;
1131
}
L
Linus Torvalds 已提交
1132

1133
/**
1134
 * nand_read_subpage - [REPLACEABLE] software ECC based sub-page read function
1135 1136 1137 1138 1139
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @data_offs: offset of requested data within the page
 * @readlen: data length
 * @bufpoi: buffer to store read data
1140
 */
1141 1142
static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
			uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
1143 1144 1145 1146 1147 1148 1149
{
	int start_step, end_step, num_steps;
	uint32_t *eccpos = chip->ecc.layout->eccpos;
	uint8_t *p;
	int data_col_addr, i, gaps = 0;
	int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
	int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
1150
	int index = 0;
1151
	unsigned int max_bitflips = 0;
1152

1153
	/* Column address within the page aligned to ECC size (256bytes) */
1154 1155 1156 1157
	start_step = data_offs / chip->ecc.size;
	end_step = (data_offs + readlen - 1) / chip->ecc.size;
	num_steps = end_step - start_step + 1;

1158
	/* Data size aligned to ECC ecc.size */
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
	datafrag_len = num_steps * chip->ecc.size;
	eccfrag_len = num_steps * chip->ecc.bytes;

	data_col_addr = start_step * chip->ecc.size;
	/* If we read not a page aligned data */
	if (data_col_addr != 0)
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);

	p = bufpoi + data_col_addr;
	chip->read_buf(mtd, p, datafrag_len);

1170
	/* Calculate ECC */
1171 1172 1173
	for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
		chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);

1174 1175
	/*
	 * The performance is faster if we position offsets according to
1176
	 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
1177
	 */
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	for (i = 0; i < eccfrag_len - 1; i++) {
		if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
			eccpos[i + start_step * chip->ecc.bytes + 1]) {
			gaps = 1;
			break;
		}
	}
	if (gaps) {
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
		chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	} else {
1189
		/*
1190
		 * Send the command to read the particular ECC bytes take care
1191 1192
		 * about buswidth alignment in read_buf.
		 */
1193 1194 1195
		index = start_step * chip->ecc.bytes;

		aligned_pos = eccpos[index] & ~(busw - 1);
1196
		aligned_len = eccfrag_len;
1197
		if (eccpos[index] & (busw - 1))
1198
			aligned_len++;
1199
		if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
1200 1201
			aligned_len++;

1202 1203
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
					mtd->writesize + aligned_pos, -1);
1204 1205 1206 1207
		chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
	}

	for (i = 0; i < eccfrag_len; i++)
1208
		chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
1209 1210 1211 1212 1213

	p = bufpoi + data_col_addr;
	for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
		int stat;

1214 1215
		stat = chip->ecc.correct(mtd, p,
			&chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
1216
		if (stat < 0) {
1217
			mtd->ecc_stats.failed++;
1218
		} else {
1219
			mtd->ecc_stats.corrected += stat;
1220 1221
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1222
	}
1223
	return max_bitflips;
1224 1225
}

1226
/**
1227
 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
1228 1229 1230
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1231
 * @oob_required: caller requires OOB data read to chip->oob_poi
1232
 * @page: page number to read
1233
 *
1234
 * Not for syndrome calculating ECC controllers which need a special oob layout.
1235
 */
1236
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1237
				uint8_t *buf, int oob_required, int page)
L
Linus Torvalds 已提交
1238
{
1239 1240 1241 1242
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1243 1244
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1245
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1246
	unsigned int max_bitflips = 0;
1247 1248 1249 1250 1251

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
L
Linus Torvalds 已提交
1252
	}
1253
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
L
Linus Torvalds 已提交
1254

1255
	for (i = 0; i < chip->ecc.total; i++)
1256
		ecc_code[i] = chip->oob_poi[eccpos[i]];
L
Linus Torvalds 已提交
1257

1258 1259
	eccsteps = chip->ecc.steps;
	p = buf;
1260

1261 1262
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1263

1264
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1265
		if (stat < 0) {
1266
			mtd->ecc_stats.failed++;
1267
		} else {
1268
			mtd->ecc_stats.corrected += stat;
1269 1270
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1271
	}
1272
	return max_bitflips;
1273
}
L
Linus Torvalds 已提交
1274

1275
/**
1276
 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
1277 1278 1279
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1280
 * @oob_required: caller requires OOB data read to chip->oob_poi
1281
 * @page: page number to read
1282
 *
1283 1284 1285 1286 1287
 * Hardware ECC for large page chips, require OOB to be read first. For this
 * ECC mode, the write_page method is re-used from ECC_HW. These methods
 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with
 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from
 * the data area, by overwriting the NAND manufacturer bad block markings.
1288 1289
 */
static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
1290
	struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
1291 1292 1293 1294 1295 1296 1297 1298
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
	uint8_t *ecc_code = chip->buffers->ecccode;
	uint32_t *eccpos = chip->ecc.layout->eccpos;
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1299
	unsigned int max_bitflips = 0;
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316

	/* Read the OOB area first */
	chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);

	for (i = 0; i < chip->ecc.total; i++)
		ecc_code[i] = chip->oob_poi[eccpos[i]];

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;

		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);

		stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
1317
		if (stat < 0) {
1318
			mtd->ecc_stats.failed++;
1319
		} else {
1320
			mtd->ecc_stats.corrected += stat;
1321 1322
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1323
	}
1324
	return max_bitflips;
1325 1326
}

1327
/**
1328
 * nand_read_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page read
1329 1330 1331
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1332
 * @oob_required: caller requires OOB data read to chip->oob_poi
1333
 * @page: page number to read
1334
 *
1335 1336
 * The hw generator calculates the error syndrome automatically. Therefore we
 * need a special oob layout and handling.
1337 1338
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1339
				   uint8_t *buf, int oob_required, int page)
1340 1341 1342 1343 1344
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1345
	uint8_t *oob = chip->oob_poi;
1346
	unsigned int max_bitflips = 0;
L
Linus Torvalds 已提交
1347

1348 1349
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
1350

1351 1352
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1353

1354 1355 1356 1357
		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}
L
Linus Torvalds 已提交
1358

1359 1360 1361
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1362

1363
		if (stat < 0) {
1364
			mtd->ecc_stats.failed++;
1365
		} else {
1366
			mtd->ecc_stats.corrected += stat;
1367 1368
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1369

1370
		oob += eccbytes;
L
Linus Torvalds 已提交
1371

1372 1373 1374
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
1375
		}
1376
	}
L
Linus Torvalds 已提交
1377

1378
	/* Calculate remaining oob bytes */
1379
	i = mtd->oobsize - (oob - chip->oob_poi);
1380 1381
	if (i)
		chip->read_buf(mtd, oob, i);
1382

1383
	return max_bitflips;
1384
}
L
Linus Torvalds 已提交
1385

1386
/**
1387
 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
1388 1389 1390 1391
 * @chip: nand chip structure
 * @oob: oob destination address
 * @ops: oob ops structure
 * @len: size of oob to transfer
1392 1393
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1394
				  struct mtd_oob_ops *ops, size_t len)
1395
{
1396
	switch (ops->mode) {
1397

1398 1399
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_RAW:
1400 1401 1402
		memcpy(oob, chip->oob_poi + ops->ooboffs, len);
		return oob + len;

1403
	case MTD_OPS_AUTO_OOB: {
1404
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
1405 1406
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1407

1408
		for (; free->length && len; free++, len -= bytes) {
1409
			/* Read request not from offset 0? */
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
			if (unlikely(roffs)) {
				if (roffs >= free->length) {
					roffs -= free->length;
					continue;
				}
				boffs = free->offset + roffs;
				bytes = min_t(size_t, len,
					      (free->length - roffs));
				roffs = 0;
			} else {
				bytes = min_t(size_t, len, free->length);
				boffs = free->offset;
			}
			memcpy(oob, chip->oob_poi + boffs, bytes);
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
1435
 * nand_do_read_ops - [INTERN] Read data with ECC
1436 1437 1438
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob ops structure
1439 1440 1441
 *
 * Internal function. Called with chip held.
 */
1442 1443
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1444
{
1445
	int chipnr, page, realpage, col, bytes, aligned, oob_required;
1446 1447 1448
	struct nand_chip *chip = mtd->priv;
	struct mtd_ecc_stats stats;
	int ret = 0;
1449
	uint32_t readlen = ops->len;
1450
	uint32_t oobreadlen = ops->ooblen;
1451
	uint32_t max_oobsize = ops->mode == MTD_OPS_AUTO_OOB ?
1452 1453
		mtd->oobavail : mtd->oobsize;

1454
	uint8_t *bufpoi, *oob, *buf;
1455
	unsigned int max_bitflips = 0;
L
Linus Torvalds 已提交
1456

1457
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1458

1459 1460
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1461

1462 1463
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1464

1465
	col = (int)(from & (mtd->writesize - 1));
1466

1467 1468
	buf = ops->datbuf;
	oob = ops->oobbuf;
1469
	oob_required = oob ? 1 : 0;
1470

1471
	while (1) {
1472 1473
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
1474

1475
		/* Is the current page in the buffer? */
1476
		if (realpage != chip->pagebuf || oob) {
1477
			bufpoi = aligned ? buf : chip->buffers->databuf;
1478

1479
			chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
L
Linus Torvalds 已提交
1480

1481 1482 1483 1484
			/*
			 * Now read the page into the buffer.  Absent an error,
			 * the read methods return max bitflips per ecc step.
			 */
1485
			if (unlikely(ops->mode == MTD_OPS_RAW))
1486
				ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
1487 1488
							      oob_required,
							      page);
1489 1490
			else if (!aligned && NAND_HAS_SUBPAGE_READ(chip) &&
				 !oob)
1491 1492
				ret = chip->ecc.read_subpage(mtd, chip,
							col, bytes, bufpoi);
1493
			else
1494
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
1495
							  oob_required, page);
1496 1497 1498 1499
			if (ret < 0) {
				if (!aligned)
					/* Invalidate page cache */
					chip->pagebuf = -1;
L
Linus Torvalds 已提交
1500
				break;
1501
			}
1502

1503 1504
			max_bitflips = max_t(unsigned int, max_bitflips, ret);

1505 1506
			/* Transfer not aligned data */
			if (!aligned) {
1507
				if (!NAND_HAS_SUBPAGE_READ(chip) && !oob &&
1508
				    !(mtd->ecc_stats.failed - stats.failed) &&
1509
				    (ops->mode != MTD_OPS_RAW)) {
1510
					chip->pagebuf = realpage;
1511 1512
					chip->pagebuf_bitflips = ret;
				} else {
1513 1514
					/* Invalidate page cache */
					chip->pagebuf = -1;
1515
				}
1516
				memcpy(buf, chip->buffers->databuf + col, bytes);
1517 1518
			}

1519 1520 1521
			buf += bytes;

			if (unlikely(oob)) {
1522 1523 1524 1525 1526 1527 1528
				int toread = min(oobreadlen, max_oobsize);

				if (toread) {
					oob = nand_transfer_oob(chip,
						oob, ops, toread);
					oobreadlen -= toread;
				}
1529 1530
			}
		} else {
1531
			memcpy(buf, chip->buffers->databuf + col, bytes);
1532
			buf += bytes;
1533 1534
			max_bitflips = max_t(unsigned int, max_bitflips,
					     chip->pagebuf_bitflips);
1535
		}
L
Linus Torvalds 已提交
1536

1537
		readlen -= bytes;
1538

1539
		if (!readlen)
1540
			break;
L
Linus Torvalds 已提交
1541

1542
		/* For subsequent reads align to page boundary */
L
Linus Torvalds 已提交
1543 1544 1545 1546
		col = 0;
		/* Increment page address */
		realpage++;

1547
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1548 1549 1550
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1551 1552
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1553 1554 1555
		}
	}

1556
	ops->retlen = ops->len - (size_t) readlen;
1557 1558
	if (oob)
		ops->oobretlen = ops->ooblen - oobreadlen;
L
Linus Torvalds 已提交
1559

1560
	if (ret < 0)
1561 1562
		return ret;

1563 1564 1565
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

1566
	return max_bitflips;
1567 1568 1569
}

/**
L
Lucas De Marchi 已提交
1570
 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
1571 1572 1573 1574 1575
 * @mtd: MTD device structure
 * @from: offset to read from
 * @len: number of bytes to read
 * @retlen: pointer to variable to store the number of read bytes
 * @buf: the databuffer to put data
1576
 *
1577
 * Get hold of the chip and call nand_do_read.
1578 1579 1580 1581
 */
static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
		     size_t *retlen, uint8_t *buf)
{
1582
	struct nand_chip *chip = mtd->priv;
1583
	struct mtd_oob_ops ops;
1584 1585
	int ret;

1586
	nand_get_device(chip, mtd, FL_READING);
1587 1588 1589
	ops.len = len;
	ops.datbuf = buf;
	ops.oobbuf = NULL;
1590
	ops.mode = MTD_OPS_PLACE_OOB;
1591 1592
	ret = nand_do_read_ops(mtd, from, &ops);
	*retlen = ops.retlen;
1593 1594
	nand_release_device(mtd);
	return ret;
L
Linus Torvalds 已提交
1595 1596
}

1597
/**
1598
 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
1599 1600 1601
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to read
1602 1603
 */
static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1604
			     int page)
1605
{
1606
	chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1607
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1608
	return 0;
1609 1610 1611
}

/**
1612
 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
1613
 *			    with syndromes
1614 1615 1616
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to read
1617 1618
 */
static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1619
				  int page)
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
{
	uint8_t *buf = chip->oob_poi;
	int length = mtd->oobsize;
	int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
	int eccsize = chip->ecc.size;
	uint8_t *bufpoi = buf;
	int i, toread, sndrnd = 0, pos;

	chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
	for (i = 0; i < chip->ecc.steps; i++) {
		if (sndrnd) {
			pos = eccsize + i * (eccsize + chunk);
			if (mtd->writesize > 512)
				chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
			else
				chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
		} else
			sndrnd = 1;
		toread = min_t(int, length, chunk);
		chip->read_buf(mtd, bufpoi, toread);
		bufpoi += toread;
		length -= toread;
	}
	if (length > 0)
		chip->read_buf(mtd, bufpoi, length);

1646
	return 0;
1647 1648 1649
}

/**
1650
 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
1651 1652 1653
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to write
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
 */
static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
			      int page)
{
	int status = 0;
	const uint8_t *buf = chip->oob_poi;
	int length = mtd->oobsize;

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
	chip->write_buf(mtd, buf, length);
	/* Send command to program the OOB data */
	chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);

	status = chip->waitfunc(mtd, chip);

S
Savin Zlobec 已提交
1669
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1670 1671 1672
}

/**
1673
 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
1674 1675 1676 1677
 *			     with syndrome - only for large page flash
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to write
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
 */
static int nand_write_oob_syndrome(struct mtd_info *mtd,
				   struct nand_chip *chip, int page)
{
	int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
	int eccsize = chip->ecc.size, length = mtd->oobsize;
	int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
	const uint8_t *bufpoi = chip->oob_poi;

	/*
	 * data-ecc-data-ecc ... ecc-oob
	 * or
	 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
	 */
	if (!chip->ecc.prepad && !chip->ecc.postpad) {
		pos = steps * (eccsize + chunk);
		steps = 0;
	} else
1696
		pos = eccsize;
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
	for (i = 0; i < steps; i++) {
		if (sndcmd) {
			if (mtd->writesize <= 512) {
				uint32_t fill = 0xFFFFFFFF;

				len = eccsize;
				while (len > 0) {
					int num = min_t(int, len, 4);
					chip->write_buf(mtd, (uint8_t *)&fill,
							num);
					len -= num;
				}
			} else {
				pos = eccsize + i * (eccsize + chunk);
				chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
			}
		} else
			sndcmd = 1;
		len = min_t(int, length, chunk);
		chip->write_buf(mtd, bufpoi, len);
		bufpoi += len;
		length -= len;
	}
	if (length > 0)
		chip->write_buf(mtd, bufpoi, length);

	chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
	status = chip->waitfunc(mtd, chip);

	return status & NAND_STATUS_FAIL ? -EIO : 0;
}

L
Linus Torvalds 已提交
1731
/**
1732
 * nand_do_read_oob - [INTERN] NAND read out-of-band
1733 1734 1735
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob operations description structure
L
Linus Torvalds 已提交
1736
 *
1737
 * NAND read out-of-band data from the spare area.
L
Linus Torvalds 已提交
1738
 */
1739 1740
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1741
{
1742
	int page, realpage, chipnr;
1743
	struct nand_chip *chip = mtd->priv;
1744
	struct mtd_ecc_stats stats;
1745 1746
	int readlen = ops->ooblen;
	int len;
1747
	uint8_t *buf = ops->oobbuf;
1748
	int ret = 0;
1749

1750
	pr_debug("%s: from = 0x%08Lx, len = %i\n",
1751
			__func__, (unsigned long long)from, readlen);
L
Linus Torvalds 已提交
1752

1753 1754
	stats = mtd->ecc_stats;

1755
	if (ops->mode == MTD_OPS_AUTO_OOB)
1756
		len = chip->ecc.layout->oobavail;
1757 1758 1759 1760
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1761 1762
		pr_debug("%s: attempt to start read outside oob\n",
				__func__);
1763 1764 1765 1766 1767 1768 1769
		return -EINVAL;
	}

	/* Do not allow reads past end of device */
	if (unlikely(from >= mtd->size ||
		     ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
					(from >> chip->page_shift)) * len)) {
1770 1771
		pr_debug("%s: attempt to read beyond end of device\n",
				__func__);
1772 1773
		return -EINVAL;
	}
1774

1775
	chipnr = (int)(from >> chip->chip_shift);
1776
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1777

1778 1779 1780
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1781

1782
	while (1) {
1783
		if (ops->mode == MTD_OPS_RAW)
1784
			ret = chip->ecc.read_oob_raw(mtd, chip, page);
1785
		else
1786 1787 1788 1789
			ret = chip->ecc.read_oob(mtd, chip, page);

		if (ret < 0)
			break;
1790 1791 1792

		len = min(len, readlen);
		buf = nand_transfer_oob(chip, buf, ops, len);
1793

1794
		readlen -= len;
S
Savin Zlobec 已提交
1795 1796 1797
		if (!readlen)
			break;

1798 1799 1800 1801 1802 1803 1804 1805 1806
		/* Increment page address */
		realpage++;

		page = realpage & chip->pagemask;
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1807 1808 1809
		}
	}

1810 1811 1812 1813
	ops->oobretlen = ops->ooblen - readlen;

	if (ret < 0)
		return ret;
1814 1815 1816 1817 1818

	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
L
Linus Torvalds 已提交
1819 1820 1821
}

/**
1822
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
1823 1824 1825
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob operation description structure
L
Linus Torvalds 已提交
1826
 *
1827
 * NAND read data and/or out-of-band data.
L
Linus Torvalds 已提交
1828
 */
1829 1830
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1831
{
1832
	struct nand_chip *chip = mtd->priv;
1833 1834 1835
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1836 1837

	/* Do not allow reads past end of device */
1838
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1839 1840
		pr_debug("%s: attempt to read beyond end of device\n",
				__func__);
L
Linus Torvalds 已提交
1841 1842 1843
		return -EINVAL;
	}

1844
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1845

1846
	switch (ops->mode) {
1847 1848 1849
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_AUTO_OOB:
	case MTD_OPS_RAW:
1850
		break;
L
Linus Torvalds 已提交
1851

1852 1853 1854
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1855

1856 1857 1858 1859
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1860

1861
out:
1862 1863 1864
	nand_release_device(mtd);
	return ret;
}
1865

L
Linus Torvalds 已提交
1866

1867
/**
1868
 * nand_write_page_raw - [INTERN] raw page write function
1869 1870 1871
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1872
 * @oob_required: must write chip->oob_poi to OOB
1873
 *
1874
 * Not for syndrome calculating ECC controllers, which use a special oob layout.
1875
 */
1876
static int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1877
				const uint8_t *buf, int oob_required)
1878 1879
{
	chip->write_buf(mtd, buf, mtd->writesize);
1880 1881
	if (oob_required)
		chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1882 1883

	return 0;
L
Linus Torvalds 已提交
1884 1885
}

1886
/**
1887
 * nand_write_page_raw_syndrome - [INTERN] raw page write function
1888 1889 1890
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1891
 * @oob_required: must write chip->oob_poi to OOB
1892 1893 1894
 *
 * We need a special oob layout and handling even when ECC isn't checked.
 */
1895
static int nand_write_page_raw_syndrome(struct mtd_info *mtd,
1896
					struct nand_chip *chip,
1897
					const uint8_t *buf, int oob_required)
1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
{
	int eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	uint8_t *oob = chip->oob_poi;
	int steps, size;

	for (steps = chip->ecc.steps; steps > 0; steps--) {
		chip->write_buf(mtd, buf, eccsize);
		buf += eccsize;

		if (chip->ecc.prepad) {
			chip->write_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->read_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->write_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
		}
	}

	size = mtd->oobsize - (oob - chip->oob_poi);
	if (size)
		chip->write_buf(mtd, oob, size);
1925 1926

	return 0;
1927
}
1928
/**
1929
 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
1930 1931 1932
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1933
 * @oob_required: must write chip->oob_poi to OOB
1934
 */
1935
static int nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1936
				  const uint8_t *buf, int oob_required)
1937
{
1938 1939 1940
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1941
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1942
	const uint8_t *p = buf;
1943
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1944

1945
	/* Software ECC calculation */
1946 1947
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1948

1949 1950
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1951

1952
	return chip->ecc.write_page_raw(mtd, chip, buf, 1);
1953
}
1954

1955
/**
1956
 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
1957 1958 1959
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1960
 * @oob_required: must write chip->oob_poi to OOB
1961
 */
1962
static int nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1963
				  const uint8_t *buf, int oob_required)
1964 1965 1966 1967
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1968
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1969
	const uint8_t *p = buf;
1970
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1971

1972 1973
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1974
		chip->write_buf(mtd, p, eccsize);
1975
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1976 1977
	}

1978 1979 1980 1981
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];

	chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1982 1983

	return 0;
1984 1985
}

1986
/**
1987
 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
1988 1989 1990
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1991
 * @oob_required: must write chip->oob_poi to OOB
L
Linus Torvalds 已提交
1992
 *
1993 1994
 * The hw generator calculates the error syndrome automatically. Therefore we
 * need a special oob layout and handling.
1995
 */
1996
static int nand_write_page_syndrome(struct mtd_info *mtd,
1997 1998
				    struct nand_chip *chip,
				    const uint8_t *buf, int oob_required)
L
Linus Torvalds 已提交
1999
{
2000 2001 2002 2003 2004
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	const uint8_t *p = buf;
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
2005

2006
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
L
Linus Torvalds 已提交
2007

2008 2009
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
2010

2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
		if (chip->ecc.prepad) {
			chip->write_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->ecc.calculate(mtd, p, oob);
		chip->write_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->write_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
L
Linus Torvalds 已提交
2023 2024
		}
	}
2025 2026

	/* Calculate remaining oob bytes */
2027
	i = mtd->oobsize - (oob - chip->oob_poi);
2028 2029
	if (i)
		chip->write_buf(mtd, oob, i);
2030 2031

	return 0;
2032 2033 2034
}

/**
2035
 * nand_write_page - [REPLACEABLE] write one page
2036 2037 2038
 * @mtd: MTD device structure
 * @chip: NAND chip descriptor
 * @buf: the data to write
2039
 * @oob_required: must write chip->oob_poi to OOB
2040 2041 2042
 * @page: page number to write
 * @cached: cached programming
 * @raw: use _raw version of write_page
2043 2044
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
2045 2046
			   const uint8_t *buf, int oob_required, int page,
			   int cached, int raw)
2047 2048 2049 2050 2051
{
	int status;

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);

2052
	if (unlikely(raw))
2053
		status = chip->ecc.write_page_raw(mtd, chip, buf, oob_required);
2054
	else
2055 2056 2057 2058
		status = chip->ecc.write_page(mtd, chip, buf, oob_required);

	if (status < 0)
		return status;
2059 2060

	/*
2061
	 * Cached progamming disabled for now. Not sure if it's worth the
2062
	 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
2063 2064 2065 2066 2067 2068
	 */
	cached = 0;

	if (!cached || !(chip->options & NAND_CACHEPRG)) {

		chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
2069
		status = chip->waitfunc(mtd, chip);
2070 2071
		/*
		 * See if operation failed and additional status checks are
2072
		 * available.
2073 2074 2075 2076 2077 2078 2079 2080 2081
		 */
		if ((status & NAND_STATUS_FAIL) && (chip->errstat))
			status = chip->errstat(mtd, chip, FL_WRITING, status,
					       page);

		if (status & NAND_STATUS_FAIL)
			return -EIO;
	} else {
		chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
2082
		status = chip->waitfunc(mtd, chip);
2083 2084 2085
	}

	return 0;
L
Linus Torvalds 已提交
2086 2087
}

2088
/**
2089
 * nand_fill_oob - [INTERN] Transfer client buffer to oob
2090
 * @mtd: MTD device structure
2091 2092 2093
 * @oob: oob data buffer
 * @len: oob data write length
 * @ops: oob ops structure
2094
 */
2095 2096
static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
			      struct mtd_oob_ops *ops)
2097
{
2098 2099 2100 2101 2102 2103 2104 2105
	struct nand_chip *chip = mtd->priv;

	/*
	 * Initialise to all 0xFF, to avoid the possibility of left over OOB
	 * data from a previous OOB read.
	 */
	memset(chip->oob_poi, 0xff, mtd->oobsize);

2106
	switch (ops->mode) {
2107

2108 2109
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_RAW:
2110 2111 2112
		memcpy(chip->oob_poi + ops->ooboffs, oob, len);
		return oob + len;

2113
	case MTD_OPS_AUTO_OOB: {
2114
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
2115 2116
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
2117

2118
		for (; free->length && len; free++, len -= bytes) {
2119
			/* Write request not from offset 0? */
2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
			if (unlikely(woffs)) {
				if (woffs >= free->length) {
					woffs -= free->length;
					continue;
				}
				boffs = free->offset + woffs;
				bytes = min_t(size_t, len,
					      (free->length - woffs));
				woffs = 0;
			} else {
				bytes = min_t(size_t, len, free->length);
				boffs = free->offset;
			}
2133
			memcpy(chip->oob_poi + boffs, oob, bytes);
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

2144
#define NOTALIGNED(x)	((x & (chip->subpagesize - 1)) != 0)
L
Linus Torvalds 已提交
2145 2146

/**
2147
 * nand_do_write_ops - [INTERN] NAND write with ECC
2148 2149 2150
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operations description structure
L
Linus Torvalds 已提交
2151
 *
2152
 * NAND write with ECC.
L
Linus Torvalds 已提交
2153
 */
2154 2155
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2156
{
2157
	int chipnr, realpage, page, blockmask, column;
2158
	struct nand_chip *chip = mtd->priv;
2159
	uint32_t writelen = ops->len;
2160 2161

	uint32_t oobwritelen = ops->ooblen;
2162
	uint32_t oobmaxlen = ops->mode == MTD_OPS_AUTO_OOB ?
2163 2164
				mtd->oobavail : mtd->oobsize;

2165 2166
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
2167
	int ret, subpage;
2168
	int oob_required = oob ? 1 : 0;
L
Linus Torvalds 已提交
2169

2170
	ops->retlen = 0;
2171 2172
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
2173

2174
	/* Reject writes, which are not page aligned */
2175
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
2176 2177
		pr_notice("%s: attempt to write non page aligned data\n",
			   __func__);
L
Linus Torvalds 已提交
2178 2179 2180
		return -EINVAL;
	}

2181 2182 2183 2184 2185
	column = to & (mtd->writesize - 1);
	subpage = column || (writelen & (mtd->writesize - 1));

	if (subpage && oob)
		return -EINVAL;
L
Linus Torvalds 已提交
2186

2187 2188 2189
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
2190 2191
	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
2192
		return -EIO;
L
Linus Torvalds 已提交
2193

2194 2195 2196 2197 2198 2199
	realpage = (int)(to >> chip->page_shift);
	page = realpage & chip->pagemask;
	blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;

	/* Invalidate the page cache, when we write to the cached page */
	if (to <= (chip->pagebuf << chip->page_shift) &&
2200
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
2201
		chip->pagebuf = -1;
2202

2203
	/* Don't allow multipage oob writes with offset */
J
Jon Povey 已提交
2204
	if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen))
2205 2206
		return -EINVAL;

2207
	while (1) {
2208
		int bytes = mtd->writesize;
2209
		int cached = writelen > bytes && page != blockmask;
2210 2211
		uint8_t *wbuf = buf;

2212
		/* Partial page write? */
2213 2214 2215 2216 2217 2218 2219 2220
		if (unlikely(column || writelen < (mtd->writesize - 1))) {
			cached = 0;
			bytes = min_t(int, bytes - column, (int) writelen);
			chip->pagebuf = -1;
			memset(chip->buffers->databuf, 0xff, mtd->writesize);
			memcpy(&chip->buffers->databuf[column], buf, bytes);
			wbuf = chip->buffers->databuf;
		}
L
Linus Torvalds 已提交
2221

2222 2223
		if (unlikely(oob)) {
			size_t len = min(oobwritelen, oobmaxlen);
2224
			oob = nand_fill_oob(mtd, oob, len, ops);
2225
			oobwritelen -= len;
2226 2227 2228
		} else {
			/* We still need to erase leftover OOB data */
			memset(chip->oob_poi, 0xff, mtd->oobsize);
2229
		}
2230

2231 2232
		ret = chip->write_page(mtd, chip, wbuf, oob_required, page,
				       cached, (ops->mode == MTD_OPS_RAW));
2233 2234 2235 2236 2237 2238 2239
		if (ret)
			break;

		writelen -= bytes;
		if (!writelen)
			break;

2240
		column = 0;
2241 2242 2243 2244 2245 2246 2247 2248 2249
		buf += bytes;
		realpage++;

		page = realpage & chip->pagemask;
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2250 2251
		}
	}
2252 2253

	ops->retlen = ops->len - writelen;
2254 2255
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2256 2257 2258
	return ret;
}

2259 2260
/**
 * panic_nand_write - [MTD Interface] NAND write with ECC
2261 2262 2263 2264 2265
 * @mtd: MTD device structure
 * @to: offset to write to
 * @len: number of bytes to write
 * @retlen: pointer to variable to store the number of written bytes
 * @buf: the data to write
2266 2267 2268 2269 2270 2271 2272 2273
 *
 * NAND write with ECC. Used when performing writes in interrupt context, this
 * may for example be called by mtdoops when writing an oops while in panic.
 */
static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			    size_t *retlen, const uint8_t *buf)
{
	struct nand_chip *chip = mtd->priv;
2274
	struct mtd_oob_ops ops;
2275 2276
	int ret;

2277
	/* Wait for the device to get ready */
2278 2279
	panic_nand_wait(mtd, chip, 400);

2280
	/* Grab the device */
2281 2282
	panic_nand_get_device(chip, mtd, FL_WRITING);

2283 2284 2285
	ops.len = len;
	ops.datbuf = (uint8_t *)buf;
	ops.oobbuf = NULL;
2286
	ops.mode = MTD_OPS_PLACE_OOB;
2287

2288
	ret = nand_do_write_ops(mtd, to, &ops);
2289

2290
	*retlen = ops.retlen;
2291 2292 2293
	return ret;
}

2294
/**
2295
 * nand_write - [MTD Interface] NAND write with ECC
2296 2297 2298 2299 2300
 * @mtd: MTD device structure
 * @to: offset to write to
 * @len: number of bytes to write
 * @retlen: pointer to variable to store the number of written bytes
 * @buf: the data to write
2301
 *
2302
 * NAND write with ECC.
2303
 */
2304 2305
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2306 2307
{
	struct nand_chip *chip = mtd->priv;
2308
	struct mtd_oob_ops ops;
2309 2310
	int ret;

2311
	nand_get_device(chip, mtd, FL_WRITING);
2312 2313 2314
	ops.len = len;
	ops.datbuf = (uint8_t *)buf;
	ops.oobbuf = NULL;
2315
	ops.mode = MTD_OPS_PLACE_OOB;
2316 2317
	ret = nand_do_write_ops(mtd, to, &ops);
	*retlen = ops.retlen;
2318
	nand_release_device(mtd);
2319
	return ret;
2320
}
2321

L
Linus Torvalds 已提交
2322
/**
2323
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
2324 2325 2326
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operation description structure
L
Linus Torvalds 已提交
2327
 *
2328
 * NAND write out-of-band.
L
Linus Torvalds 已提交
2329
 */
2330 2331
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2332
{
2333
	int chipnr, page, status, len;
2334
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2335

2336
	pr_debug("%s: to = 0x%08x, len = %i\n",
2337
			 __func__, (unsigned int)to, (int)ops->ooblen);
L
Linus Torvalds 已提交
2338

2339
	if (ops->mode == MTD_OPS_AUTO_OOB)
2340 2341 2342 2343
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2344
	/* Do not allow write past end of page */
2345
	if ((ops->ooboffs + ops->ooblen) > len) {
2346 2347
		pr_debug("%s: attempt to write past end of page\n",
				__func__);
L
Linus Torvalds 已提交
2348 2349 2350
		return -EINVAL;
	}

2351
	if (unlikely(ops->ooboffs >= len)) {
2352 2353
		pr_debug("%s: attempt to start write outside oob\n",
				__func__);
2354 2355 2356
		return -EINVAL;
	}

2357
	/* Do not allow write past end of device */
2358 2359 2360 2361
	if (unlikely(to >= mtd->size ||
		     ops->ooboffs + ops->ooblen >
			((mtd->size >> chip->page_shift) -
			 (to >> chip->page_shift)) * len)) {
2362 2363
		pr_debug("%s: attempt to write beyond end of device\n",
				__func__);
2364 2365 2366
		return -EINVAL;
	}

2367
	chipnr = (int)(to >> chip->chip_shift);
2368
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2369

2370 2371 2372 2373 2374 2375 2376 2377 2378
	/* Shift to get page */
	page = (int)(to >> chip->page_shift);

	/*
	 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
	 * of my DiskOnChip 2000 test units) will clear the whole data page too
	 * if we don't do this. I have no clue why, but I seem to have 'fixed'
	 * it in the doc2000 driver in August 1999.  dwmw2.
	 */
2379
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2380 2381 2382

	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
2383
		return -EROFS;
2384

L
Linus Torvalds 已提交
2385
	/* Invalidate the page cache, if we write to the cached page */
2386 2387
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2388

2389
	nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
2390

2391
	if (ops->mode == MTD_OPS_RAW)
2392 2393 2394
		status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
	else
		status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
L
Linus Torvalds 已提交
2395

2396 2397
	if (status)
		return status;
L
Linus Torvalds 已提交
2398

2399
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2400

2401
	return 0;
2402 2403 2404 2405
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2406 2407 2408
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operation description structure
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
 */
static int nand_write_oob(struct mtd_info *mtd, loff_t to,
			  struct mtd_oob_ops *ops)
{
	struct nand_chip *chip = mtd->priv;
	int ret = -ENOTSUPP;

	ops->retlen = 0;

	/* Do not allow writes past end of device */
2419
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2420 2421
		pr_debug("%s: attempt to write beyond end of device\n",
				__func__);
2422 2423 2424
		return -EINVAL;
	}

2425
	nand_get_device(chip, mtd, FL_WRITING);
2426

2427
	switch (ops->mode) {
2428 2429 2430
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_AUTO_OOB:
	case MTD_OPS_RAW:
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
		break;

	default:
		goto out;
	}

	if (!ops->datbuf)
		ret = nand_do_write_oob(mtd, to, ops);
	else
		ret = nand_do_write_ops(mtd, to, ops);

2442
out:
L
Linus Torvalds 已提交
2443 2444 2445 2446 2447
	nand_release_device(mtd);
	return ret;
}

/**
2448
 * single_erase_cmd - [GENERIC] NAND standard block erase command function
2449 2450
 * @mtd: MTD device structure
 * @page: the page address of the block which will be erased
L
Linus Torvalds 已提交
2451
 *
2452
 * Standard erase command for NAND chips.
L
Linus Torvalds 已提交
2453
 */
2454
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2455
{
2456
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2457
	/* Send commands to erase a block */
2458 2459
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2460 2461 2462
}

/**
2463
 * multi_erase_cmd - [GENERIC] AND specific block erase command function
2464 2465
 * @mtd: MTD device structure
 * @page: the page address of the block which will be erased
L
Linus Torvalds 已提交
2466
 *
2467
 * AND multi block erase command function. Erase 4 consecutive blocks.
L
Linus Torvalds 已提交
2468
 */
2469
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2470
{
2471
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2472
	/* Send commands to erase a block */
2473 2474 2475 2476 2477
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2478 2479 2480 2481
}

/**
 * nand_erase - [MTD Interface] erase block(s)
2482 2483
 * @mtd: MTD device structure
 * @instr: erase instruction
L
Linus Torvalds 已提交
2484
 *
2485
 * Erase one ore more blocks.
L
Linus Torvalds 已提交
2486
 */
2487
static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
L
Linus Torvalds 已提交
2488
{
2489
	return nand_erase_nand(mtd, instr, 0);
L
Linus Torvalds 已提交
2490
}
2491

2492
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
2493
/**
2494
 * nand_erase_nand - [INTERN] erase block(s)
2495 2496 2497
 * @mtd: MTD device structure
 * @instr: erase instruction
 * @allowbbt: allow erasing the bbt area
L
Linus Torvalds 已提交
2498
 *
2499
 * Erase one ore more blocks.
L
Linus Torvalds 已提交
2500
 */
2501 2502
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2503
{
2504
	int page, status, pages_per_block, ret, chipnr;
2505
	struct nand_chip *chip = mtd->priv;
2506
	loff_t rewrite_bbt[NAND_MAX_CHIPS] = {0};
2507
	unsigned int bbt_masked_page = 0xffffffff;
2508
	loff_t len;
L
Linus Torvalds 已提交
2509

2510 2511 2512
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
			__func__, (unsigned long long)instr->addr,
			(unsigned long long)instr->len);
L
Linus Torvalds 已提交
2513

2514
	if (check_offs_len(mtd, instr->addr, instr->len))
L
Linus Torvalds 已提交
2515 2516 2517
		return -EINVAL;

	/* Grab the lock and see if the device is available */
2518
	nand_get_device(chip, mtd, FL_ERASING);
L
Linus Torvalds 已提交
2519 2520

	/* Shift to get first page */
2521 2522
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2523 2524

	/* Calculate pages in each block */
2525
	pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
L
Linus Torvalds 已提交
2526 2527

	/* Select the NAND device */
2528
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2529 2530 2531

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2532 2533
		pr_debug("%s: device is write protected!\n",
				__func__);
L
Linus Torvalds 已提交
2534 2535 2536 2537
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

2538 2539 2540 2541
	/*
	 * If BBT requires refresh, set the BBT page mask to see if the BBT
	 * should be rewritten. Otherwise the mask is set to 0xffffffff which
	 * can not be matched. This is also done when the bbt is actually
2542
	 * erased to avoid recursive updates.
2543 2544 2545
	 */
	if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
		bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
2546

L
Linus Torvalds 已提交
2547 2548 2549 2550 2551 2552
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
W
Wolfram Sang 已提交
2553
		/* Check if we have a bad block, we do not erase bad blocks! */
2554 2555
		if (nand_block_checkbad(mtd, ((loff_t) page) <<
					chip->page_shift, 0, allowbbt)) {
2556 2557
			pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
				    __func__, page);
L
Linus Torvalds 已提交
2558 2559 2560
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2561

2562 2563
		/*
		 * Invalidate the page cache, if we erase the block which
2564
		 * contains the current cached page.
2565 2566 2567 2568
		 */
		if (page <= chip->pagebuf && chip->pagebuf <
		    (page + pages_per_block))
			chip->pagebuf = -1;
L
Linus Torvalds 已提交
2569

2570
		chip->erase_cmd(mtd, page & chip->pagemask);
2571

2572
		status = chip->waitfunc(mtd, chip);
L
Linus Torvalds 已提交
2573

2574 2575 2576 2577 2578 2579 2580
		/*
		 * See if operation failed and additional status checks are
		 * available
		 */
		if ((status & NAND_STATUS_FAIL) && (chip->errstat))
			status = chip->errstat(mtd, chip, FL_ERASING,
					       status, page);
2581

L
Linus Torvalds 已提交
2582
		/* See if block erase succeeded */
2583
		if (status & NAND_STATUS_FAIL) {
2584 2585
			pr_debug("%s: failed erase, page 0x%08x\n",
					__func__, page);
L
Linus Torvalds 已提交
2586
			instr->state = MTD_ERASE_FAILED;
2587 2588
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2589 2590
			goto erase_exit;
		}
2591

2592 2593
		/*
		 * If BBT requires refresh, set the BBT rewrite flag to the
2594
		 * page being erased.
2595 2596 2597
		 */
		if (bbt_masked_page != 0xffffffff &&
		    (page & BBT_PAGE_MASK) == bbt_masked_page)
2598 2599
			    rewrite_bbt[chipnr] =
					((loff_t)page << chip->page_shift);
2600

L
Linus Torvalds 已提交
2601
		/* Increment page address and decrement length */
2602
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2603 2604 2605
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2606
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2607
			chipnr++;
2608 2609
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
2610

2611 2612
			/*
			 * If BBT requires refresh and BBT-PERCHIP, set the BBT
2613
			 * page mask to see if this BBT should be rewritten.
2614 2615 2616 2617 2618
			 */
			if (bbt_masked_page != 0xffffffff &&
			    (chip->bbt_td->options & NAND_BBT_PERCHIP))
				bbt_masked_page = chip->bbt_td->pages[chipnr] &
					BBT_PAGE_MASK;
L
Linus Torvalds 已提交
2619 2620 2621 2622
		}
	}
	instr->state = MTD_ERASE_DONE;

2623
erase_exit:
L
Linus Torvalds 已提交
2624 2625 2626 2627 2628 2629

	ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;

	/* Deselect and wake up anyone waiting on the device */
	nand_release_device(mtd);

2630 2631 2632 2633
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

2634 2635
	/*
	 * If BBT requires refresh and erase was successful, rewrite any
2636
	 * selected bad block tables.
2637 2638 2639 2640 2641 2642 2643
	 */
	if (bbt_masked_page == 0xffffffff || ret)
		return ret;

	for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
		if (!rewrite_bbt[chipnr])
			continue;
2644
		/* Update the BBT for chip */
2645 2646 2647
		pr_debug("%s: nand_update_bbt (%d:0x%0llx 0x%0x)\n",
				__func__, chipnr, rewrite_bbt[chipnr],
				chip->bbt_td->pages[chipnr]);
2648
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2649 2650
	}

L
Linus Torvalds 已提交
2651 2652 2653 2654 2655 2656
	/* Return more or less happy */
	return ret;
}

/**
 * nand_sync - [MTD Interface] sync
2657
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
2658
 *
2659
 * Sync is actually a wait for chip ready function.
L
Linus Torvalds 已提交
2660
 */
2661
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2662
{
2663
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2664

2665
	pr_debug("%s: called\n", __func__);
L
Linus Torvalds 已提交
2666 2667

	/* Grab the lock and see if the device is available */
2668
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
2669
	/* Release it and go back */
2670
	nand_release_device(mtd);
L
Linus Torvalds 已提交
2671 2672 2673
}

/**
2674
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
2675 2676
 * @mtd: MTD device structure
 * @offs: offset relative to mtd start
L
Linus Torvalds 已提交
2677
 */
2678
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2679
{
2680
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2681 2682 2683
}

/**
2684
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
2685 2686
 * @mtd: MTD device structure
 * @ofs: offset relative to mtd start
L
Linus Torvalds 已提交
2687
 */
2688
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
2689
{
2690
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2691 2692
	int ret;

2693 2694
	ret = nand_block_isbad(mtd, ofs);
	if (ret) {
2695
		/* If it was bad already, return success and do nothing */
L
Linus Torvalds 已提交
2696 2697
		if (ret > 0)
			return 0;
2698 2699
		return ret;
	}
L
Linus Torvalds 已提交
2700

2701
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2702 2703
}

2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747
/**
 * nand_onfi_set_features- [REPLACEABLE] set features for ONFI nand
 * @mtd: MTD device structure
 * @chip: nand chip info structure
 * @addr: feature address.
 * @subfeature_param: the subfeature parameters, a four bytes array.
 */
static int nand_onfi_set_features(struct mtd_info *mtd, struct nand_chip *chip,
			int addr, uint8_t *subfeature_param)
{
	int status;

	if (!chip->onfi_version)
		return -EINVAL;

	chip->cmdfunc(mtd, NAND_CMD_SET_FEATURES, addr, -1);
	chip->write_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
	status = chip->waitfunc(mtd, chip);
	if (status & NAND_STATUS_FAIL)
		return -EIO;
	return 0;
}

/**
 * nand_onfi_get_features- [REPLACEABLE] get features for ONFI nand
 * @mtd: MTD device structure
 * @chip: nand chip info structure
 * @addr: feature address.
 * @subfeature_param: the subfeature parameters, a four bytes array.
 */
static int nand_onfi_get_features(struct mtd_info *mtd, struct nand_chip *chip,
			int addr, uint8_t *subfeature_param)
{
	if (!chip->onfi_version)
		return -EINVAL;

	/* clear the sub feature parameters */
	memset(subfeature_param, 0, ONFI_SUBFEATURE_PARAM_LEN);

	chip->cmdfunc(mtd, NAND_CMD_GET_FEATURES, addr, -1);
	chip->read_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
	return 0;
}

2748 2749
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
2750
 * @mtd: MTD device structure
2751 2752 2753
 */
static int nand_suspend(struct mtd_info *mtd)
{
2754
	struct nand_chip *chip = mtd->priv;
2755

2756
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
2757 2758 2759 2760
}

/**
 * nand_resume - [MTD Interface] Resume the NAND flash
2761
 * @mtd: MTD device structure
2762 2763 2764
 */
static void nand_resume(struct mtd_info *mtd)
{
2765
	struct nand_chip *chip = mtd->priv;
2766

2767
	if (chip->state == FL_PM_SUSPENDED)
2768 2769
		nand_release_device(mtd);
	else
2770 2771
		pr_err("%s called for a chip which is not in suspended state\n",
			__func__);
2772 2773
}

2774
/* Set default functions */
2775
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2776
{
L
Linus Torvalds 已提交
2777
	/* check for proper chip_delay setup, set 20us if not */
2778 2779
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2780 2781

	/* check, if a user supplied command function given */
2782 2783
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2784 2785

	/* check, if a user supplied wait function given */
2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
	if (chip->waitfunc == NULL)
		chip->waitfunc = nand_wait;

	if (!chip->select_chip)
		chip->select_chip = nand_select_chip;
	if (!chip->read_byte)
		chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
	if (!chip->read_word)
		chip->read_word = nand_read_word;
	if (!chip->block_bad)
		chip->block_bad = nand_block_bad;
	if (!chip->block_markbad)
		chip->block_markbad = nand_default_block_markbad;
	if (!chip->write_buf)
		chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
	if (!chip->read_buf)
		chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
	if (!chip->scan_bbt)
		chip->scan_bbt = nand_default_bbt;
2805 2806 2807 2808 2809 2810 2811

	if (!chip->controller) {
		chip->controller = &chip->hwcontrol;
		spin_lock_init(&chip->controller->lock);
		init_waitqueue_head(&chip->controller->wq);
	}

T
Thomas Gleixner 已提交
2812 2813
}

2814
/* Sanitize ONFI strings so we can safely print them */
2815 2816 2817 2818
static void sanitize_string(uint8_t *s, size_t len)
{
	ssize_t i;

2819
	/* Null terminate */
2820 2821
	s[len - 1] = 0;

2822
	/* Remove non printable chars */
2823 2824 2825 2826 2827
	for (i = 0; i < len - 1; i++) {
		if (s[i] < ' ' || s[i] > 127)
			s[i] = '?';
	}

2828
	/* Remove trailing spaces */
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843
	strim(s);
}

static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
{
	int i;
	while (len--) {
		crc ^= *p++ << 8;
		for (i = 0; i < 8; i++)
			crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
	}

	return crc;
}

2844
/*
2845
 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
2846 2847
 */
static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
2848
					int *busw)
2849 2850 2851 2852 2853
{
	struct nand_onfi_params *p = &chip->onfi_params;
	int i;
	int val;

2854
	/* Try ONFI for unknown chip or LP */
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
	if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
		chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
		return 0;

	chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
	for (i = 0; i < 3; i++) {
		chip->read_buf(mtd, (uint8_t *)p, sizeof(*p));
		if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
				le16_to_cpu(p->crc)) {
2865
			pr_info("ONFI param page %d valid\n", i);
2866 2867 2868 2869 2870 2871 2872
			break;
		}
	}

	if (i == 3)
		return 0;

2873
	/* Check version */
2874
	val = le16_to_cpu(p->revision);
2875 2876 2877
	if (val & (1 << 5))
		chip->onfi_version = 23;
	else if (val & (1 << 4))
2878 2879 2880 2881 2882
		chip->onfi_version = 22;
	else if (val & (1 << 3))
		chip->onfi_version = 21;
	else if (val & (1 << 2))
		chip->onfi_version = 20;
2883
	else if (val & (1 << 1))
2884
		chip->onfi_version = 10;
2885 2886 2887 2888
	else
		chip->onfi_version = 0;

	if (!chip->onfi_version) {
2889
		pr_info("%s: unsupported ONFI version: %d\n", __func__, val);
2890 2891
		return 0;
	}
2892 2893 2894 2895 2896 2897 2898 2899

	sanitize_string(p->manufacturer, sizeof(p->manufacturer));
	sanitize_string(p->model, sizeof(p->model));
	if (!mtd->name)
		mtd->name = p->model;
	mtd->writesize = le32_to_cpu(p->byte_per_page);
	mtd->erasesize = le32_to_cpu(p->pages_per_block) * mtd->writesize;
	mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
2900 2901
	chip->chipsize = le32_to_cpu(p->blocks_per_lun);
	chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
2902
	*busw = 0;
2903
	if (le16_to_cpu(p->features) & 1)
2904
		*busw = NAND_BUSWIDTH_16;
2905

2906
	pr_info("ONFI flash detected\n");
2907 2908 2909
	return 1;
}

2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968
/*
 * nand_id_has_period - Check if an ID string has a given wraparound period
 * @id_data: the ID string
 * @arrlen: the length of the @id_data array
 * @period: the period of repitition
 *
 * Check if an ID string is repeated within a given sequence of bytes at
 * specific repetition interval period (e.g., {0x20,0x01,0x7F,0x20} has a
 * period of 2). This is a helper function for nand_id_len(). Returns non-zero
 * if the repetition has a period of @period; otherwise, returns zero.
 */
static int nand_id_has_period(u8 *id_data, int arrlen, int period)
{
	int i, j;
	for (i = 0; i < period; i++)
		for (j = i + period; j < arrlen; j += period)
			if (id_data[i] != id_data[j])
				return 0;
	return 1;
}

/*
 * nand_id_len - Get the length of an ID string returned by CMD_READID
 * @id_data: the ID string
 * @arrlen: the length of the @id_data array

 * Returns the length of the ID string, according to known wraparound/trailing
 * zero patterns. If no pattern exists, returns the length of the array.
 */
static int nand_id_len(u8 *id_data, int arrlen)
{
	int last_nonzero, period;

	/* Find last non-zero byte */
	for (last_nonzero = arrlen - 1; last_nonzero >= 0; last_nonzero--)
		if (id_data[last_nonzero])
			break;

	/* All zeros */
	if (last_nonzero < 0)
		return 0;

	/* Calculate wraparound period */
	for (period = 1; period < arrlen; period++)
		if (nand_id_has_period(id_data, arrlen, period))
			break;

	/* There's a repeated pattern */
	if (period < arrlen)
		return period;

	/* There are trailing zeros */
	if (last_nonzero < arrlen - 1)
		return last_nonzero + 1;

	/* No pattern detected */
	return arrlen;
}

2969 2970 2971 2972 2973 2974 2975 2976
/*
 * Many new NAND share similar device ID codes, which represent the size of the
 * chip. The rest of the parameters must be decoded according to generic or
 * manufacturer-specific "extended ID" decoding patterns.
 */
static void nand_decode_ext_id(struct mtd_info *mtd, struct nand_chip *chip,
				u8 id_data[8], int *busw)
{
2977
	int extid, id_len;
2978 2979 2980 2981 2982
	/* The 3rd id byte holds MLC / multichip data */
	chip->cellinfo = id_data[2];
	/* The 4th id byte is the important one */
	extid = id_data[3];

2983 2984
	id_len = nand_id_len(id_data, 8);

2985 2986 2987
	/*
	 * Field definitions are in the following datasheets:
	 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
2988
	 * New Samsung (6 byte ID): Samsung K9GAG08U0F (p.44)
2989
	 * Hynix MLC   (6 byte ID): Hynix H27UBG8T2B (p.22)
2990
	 *
2991 2992
	 * Check for ID length, non-zero 6th byte, cell type, and Hynix/Samsung
	 * ID to decide what to do.
2993
	 */
2994
	if (id_len == 6 && id_data[0] == NAND_MFR_SAMSUNG &&
2995
			(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
2996
			id_data[5] != 0x00) {
2997 2998 2999 3000
		/* Calc pagesize */
		mtd->writesize = 2048 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
3001
		switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3002 3003 3004 3005 3006 3007 3008 3009 3010
		case 1:
			mtd->oobsize = 128;
			break;
		case 2:
			mtd->oobsize = 218;
			break;
		case 3:
			mtd->oobsize = 400;
			break;
3011
		case 4:
3012 3013
			mtd->oobsize = 436;
			break;
3014 3015 3016 3017 3018 3019 3020
		case 5:
			mtd->oobsize = 512;
			break;
		case 6:
		default: /* Other cases are "reserved" (unknown) */
			mtd->oobsize = 640;
			break;
3021 3022 3023 3024 3025 3026
		}
		extid >>= 2;
		/* Calc blocksize */
		mtd->erasesize = (128 * 1024) <<
			(((extid >> 1) & 0x04) | (extid & 0x03));
		*busw = 0;
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067
	} else if (id_len == 6 && id_data[0] == NAND_MFR_HYNIX &&
			(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
		unsigned int tmp;

		/* Calc pagesize */
		mtd->writesize = 2048 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
		switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
		case 0:
			mtd->oobsize = 128;
			break;
		case 1:
			mtd->oobsize = 224;
			break;
		case 2:
			mtd->oobsize = 448;
			break;
		case 3:
			mtd->oobsize = 64;
			break;
		case 4:
			mtd->oobsize = 32;
			break;
		case 5:
			mtd->oobsize = 16;
			break;
		default:
			mtd->oobsize = 640;
			break;
		}
		extid >>= 2;
		/* Calc blocksize */
		tmp = ((extid >> 1) & 0x04) | (extid & 0x03);
		if (tmp < 0x03)
			mtd->erasesize = (128 * 1024) << tmp;
		else if (tmp == 0x03)
			mtd->erasesize = 768 * 1024;
		else
			mtd->erasesize = (64 * 1024) << tmp;
		*busw = 0;
3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
	} else {
		/* Calc pagesize */
		mtd->writesize = 1024 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
		mtd->oobsize = (8 << (extid & 0x01)) *
			(mtd->writesize >> 9);
		extid >>= 2;
		/* Calc blocksize. Blocksize is multiples of 64KiB */
		mtd->erasesize = (64 * 1024) << (extid & 0x03);
		extid >>= 2;
		/* Get buswidth information */
		*busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
	}
}

3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113
/*
 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
 * decodes a matching ID table entry and assigns the MTD size parameters for
 * the chip.
 */
static void nand_decode_id(struct mtd_info *mtd, struct nand_chip *chip,
				struct nand_flash_dev *type, u8 id_data[8],
				int *busw)
{
	int maf_id = id_data[0];

	mtd->erasesize = type->erasesize;
	mtd->writesize = type->pagesize;
	mtd->oobsize = mtd->writesize / 32;
	*busw = type->options & NAND_BUSWIDTH_16;

	/*
	 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
	 * some Spansion chips have erasesize that conflicts with size
	 * listed in nand_ids table.
	 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
	 */
	if (maf_id == NAND_MFR_AMD && id_data[4] != 0x00 && id_data[5] == 0x00
			&& id_data[6] == 0x00 && id_data[7] == 0x00
			&& mtd->writesize == 512) {
		mtd->erasesize = 128 * 1024;
		mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
	}
}

3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
/*
 * Set the bad block marker/indicator (BBM/BBI) patterns according to some
 * heuristic patterns using various detected parameters (e.g., manufacturer,
 * page size, cell-type information).
 */
static void nand_decode_bbm_options(struct mtd_info *mtd,
				    struct nand_chip *chip, u8 id_data[8])
{
	int maf_id = id_data[0];

	/* Set the bad block position */
	if (mtd->writesize > 512 || (chip->options & NAND_BUSWIDTH_16))
		chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
	else
		chip->badblockpos = NAND_SMALL_BADBLOCK_POS;

	/*
	 * Bad block marker is stored in the last page of each block on Samsung
	 * and Hynix MLC devices; stored in first two pages of each block on
	 * Micron devices with 2KiB pages and on SLC Samsung, Hynix, Toshiba,
	 * AMD/Spansion, and Macronix.  All others scan only the first page.
	 */
	if ((chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
			(maf_id == NAND_MFR_SAMSUNG ||
			 maf_id == NAND_MFR_HYNIX))
		chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
	else if ((!(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
				(maf_id == NAND_MFR_SAMSUNG ||
				 maf_id == NAND_MFR_HYNIX ||
				 maf_id == NAND_MFR_TOSHIBA ||
				 maf_id == NAND_MFR_AMD ||
				 maf_id == NAND_MFR_MACRONIX)) ||
			(mtd->writesize == 2048 &&
			 maf_id == NAND_MFR_MICRON))
		chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
}

T
Thomas Gleixner 已提交
3151
/*
3152
 * Get the flash and manufacturer id and lookup if the type is supported.
T
Thomas Gleixner 已提交
3153 3154
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
3155
						  struct nand_chip *chip,
3156 3157
						  int busw,
						  int *maf_id, int *dev_id,
3158
						  struct nand_flash_dev *type)
T
Thomas Gleixner 已提交
3159
{
3160
	int i, maf_idx;
3161
	u8 id_data[8];
L
Linus Torvalds 已提交
3162 3163

	/* Select the device */
3164
	chip->select_chip(mtd, 0);
L
Linus Torvalds 已提交
3165

3166 3167
	/*
	 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
3168
	 * after power-up.
3169 3170 3171
	 */
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);

L
Linus Torvalds 已提交
3172
	/* Send the command for reading device ID */
3173
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
3174 3175

	/* Read manufacturer and device IDs */
3176
	*maf_id = chip->read_byte(mtd);
3177
	*dev_id = chip->read_byte(mtd);
L
Linus Torvalds 已提交
3178

3179 3180
	/*
	 * Try again to make sure, as some systems the bus-hold or other
3181 3182 3183 3184 3185 3186 3187
	 * interface concerns can cause random data which looks like a
	 * possibly credible NAND flash to appear. If the two results do
	 * not match, ignore the device completely.
	 */

	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);

3188 3189
	/* Read entire ID string */
	for (i = 0; i < 8; i++)
3190
		id_data[i] = chip->read_byte(mtd);
3191

3192
	if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
3193
		pr_info("%s: second ID read did not match "
3194 3195
			"%02x,%02x against %02x,%02x\n", __func__,
			*maf_id, *dev_id, id_data[0], id_data[1]);
3196 3197 3198
		return ERR_PTR(-ENODEV);
	}

T
Thomas Gleixner 已提交
3199
	if (!type)
3200 3201 3202
		type = nand_flash_ids;

	for (; type->name != NULL; type++)
3203
		if (*dev_id == type->id)
3204
			break;
3205

3206 3207
	chip->onfi_version = 0;
	if (!type->name || !type->pagesize) {
3208
		/* Check is chip is ONFI compliant */
3209
		if (nand_flash_detect_onfi(mtd, chip, &busw))
3210
			goto ident_done;
3211 3212
	}

3213
	if (!type->name)
T
Thomas Gleixner 已提交
3214 3215
		return ERR_PTR(-ENODEV);

3216 3217 3218
	if (!mtd->name)
		mtd->name = type->name;

3219
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
3220

3221
	if (!type->pagesize && chip->init_size) {
3222
		/* Set the pagesize, oobsize, erasesize by the driver */
3223 3224
		busw = chip->init_size(mtd, chip, id_data);
	} else if (!type->pagesize) {
3225 3226
		/* Decode parameters from extended ID */
		nand_decode_ext_id(mtd, chip, id_data, &busw);
T
Thomas Gleixner 已提交
3227
	} else {
3228
		nand_decode_id(mtd, chip, type, id_data, &busw);
T
Thomas Gleixner 已提交
3229
	}
3230 3231
	/* Get chip options */
	chip->options |= type->options;
3232

3233 3234 3235
	/*
	 * Check if chip is not a Samsung device. Do not clear the
	 * options for chips which do not have an extended id.
3236 3237 3238 3239 3240
	 */
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
ident_done:

T
Thomas Gleixner 已提交
3241
	/* Try to identify manufacturer */
3242
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
3243 3244 3245
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
3246

T
Thomas Gleixner 已提交
3247 3248
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
3249
	 * chip correct!
T
Thomas Gleixner 已提交
3250
	 */
3251
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
3252
		pr_info("NAND device: Manufacturer ID:"
3253 3254
			" 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
			*dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
3255
		pr_warn("NAND bus width %d instead %d bit\n",
3256 3257
			   (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
			   busw ? 16 : 8);
T
Thomas Gleixner 已提交
3258 3259
		return ERR_PTR(-EINVAL);
	}
3260

3261 3262
	nand_decode_bbm_options(mtd, chip, id_data);

T
Thomas Gleixner 已提交
3263
	/* Calculate the address shift from the page size */
3264
	chip->page_shift = ffs(mtd->writesize) - 1;
3265
	/* Convert chipsize to number of pages per chip -1 */
3266
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
3267

3268
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
3269
		ffs(mtd->erasesize) - 1;
3270 3271
	if (chip->chipsize & 0xffffffff)
		chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
3272 3273 3274 3275
	else {
		chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
		chip->chip_shift += 32 - 1;
	}
L
Linus Torvalds 已提交
3276

A
Artem Bityutskiy 已提交
3277 3278
	chip->badblockbits = 8;

T
Thomas Gleixner 已提交
3279
	/* Check for AND chips with 4 page planes */
3280 3281
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
3282
	else
3283
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
3284

3285
	/* Do not replace user supplied command function! */
3286 3287
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
3288

3289 3290 3291 3292 3293
	pr_info("NAND device: Manufacturer ID: 0x%02x, Chip ID: 0x%02x (%s %s),"
		" page size: %d, OOB size: %d\n",
		*maf_id, *dev_id, nand_manuf_ids[maf_idx].name,
		chip->onfi_version ? chip->onfi_params.model : type->name,
		mtd->writesize, mtd->oobsize);
T
Thomas Gleixner 已提交
3294 3295 3296 3297 3298

	return type;
}

/**
3299
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
3300 3301 3302
 * @mtd: MTD device structure
 * @maxchips: number of chips to scan for
 * @table: alternative NAND ID table
T
Thomas Gleixner 已提交
3303
 *
3304 3305
 * This is the first phase of the normal nand_scan() function. It reads the
 * flash ID and sets up MTD fields accordingly.
T
Thomas Gleixner 已提交
3306
 *
3307
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
3308
 */
3309 3310
int nand_scan_ident(struct mtd_info *mtd, int maxchips,
		    struct nand_flash_dev *table)
T
Thomas Gleixner 已提交
3311
{
3312
	int i, busw, nand_maf_id, nand_dev_id;
3313
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
3314 3315 3316
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
3317
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
3318
	/* Set the default functions */
3319
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
3320 3321

	/* Read the flash type */
3322 3323
	type = nand_get_flash_type(mtd, chip, busw,
				&nand_maf_id, &nand_dev_id, table);
T
Thomas Gleixner 已提交
3324 3325

	if (IS_ERR(type)) {
3326
		if (!(chip->options & NAND_SCAN_SILENT_NODEV))
3327
			pr_warn("No NAND device found\n");
3328
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
3329
		return PTR_ERR(type);
L
Linus Torvalds 已提交
3330 3331
	}

3332 3333
	chip->select_chip(mtd, -1);

T
Thomas Gleixner 已提交
3334
	/* Check for a chip array */
3335
	for (i = 1; i < maxchips; i++) {
3336
		chip->select_chip(mtd, i);
3337 3338
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
3339
		/* Send the command for reading device ID */
3340
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
3341
		/* Read manufacturer and device IDs */
3342
		if (nand_maf_id != chip->read_byte(mtd) ||
3343 3344
		    nand_dev_id != chip->read_byte(mtd)) {
			chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3345
			break;
3346 3347
		}
		chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3348 3349
	}
	if (i > 1)
3350
		pr_info("%d NAND chips detected\n", i);
3351

L
Linus Torvalds 已提交
3352
	/* Store the number of chips and calc total size for mtd */
3353 3354
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
3355

3356 3357
	return 0;
}
3358
EXPORT_SYMBOL(nand_scan_ident);
3359 3360 3361 3362


/**
 * nand_scan_tail - [NAND Interface] Scan for the NAND device
3363
 * @mtd: MTD device structure
3364
 *
3365 3366 3367
 * This is the second phase of the normal nand_scan() function. It fills out
 * all the uninitialized function pointers with the defaults and scans for a
 * bad block table if appropriate.
3368 3369 3370 3371 3372 3373
 */
int nand_scan_tail(struct mtd_info *mtd)
{
	int i;
	struct nand_chip *chip = mtd->priv;

3374 3375 3376 3377
	/* New bad blocks should be marked in OOB, flash-based BBT, or both */
	BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
			!(chip->bbt_options & NAND_BBT_USE_FLASH));

3378 3379 3380 3381 3382
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

3383
	/* Set the internal oob buffer location, just after the page data */
3384
	chip->oob_poi = chip->buffers->databuf + mtd->writesize;
L
Linus Torvalds 已提交
3385

T
Thomas Gleixner 已提交
3386
	/*
3387
	 * If no default placement scheme is given, select an appropriate one.
T
Thomas Gleixner 已提交
3388
	 */
3389
	if (!chip->ecc.layout && (chip->ecc.mode != NAND_ECC_SOFT_BCH)) {
3390
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
3391
		case 8:
3392
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
3393 3394
			break;
		case 16:
3395
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
3396 3397
			break;
		case 64:
3398
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
3399
			break;
3400 3401 3402
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
3403
		default:
3404 3405
			pr_warn("No oob scheme defined for oobsize %d\n",
				   mtd->oobsize);
L
Linus Torvalds 已提交
3406 3407 3408
			BUG();
		}
	}
3409

3410 3411 3412
	if (!chip->write_page)
		chip->write_page = nand_write_page;

3413 3414 3415 3416 3417 3418
	/* set for ONFI nand */
	if (!chip->onfi_set_features)
		chip->onfi_set_features = nand_onfi_set_features;
	if (!chip->onfi_get_features)
		chip->onfi_get_features = nand_onfi_get_features;

3419
	/*
3420
	 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
T
Thomas Gleixner 已提交
3421
	 * selected and we have 256 byte pagesize fallback to software ECC
3422
	 */
3423

3424
	switch (chip->ecc.mode) {
3425 3426 3427 3428
	case NAND_ECC_HW_OOB_FIRST:
		/* Similar to NAND_ECC_HW, but a separate read_page handle */
		if (!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) {
3429
			pr_warn("No ECC functions supplied; "
3430
				   "hardware ECC not possible\n");
3431 3432 3433 3434 3435
			BUG();
		}
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc_oob_first;

T
Thomas Gleixner 已提交
3436
	case NAND_ECC_HW:
3437
		/* Use standard hwecc read page function? */
3438 3439
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
3440 3441
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
3442 3443 3444 3445
		if (!chip->ecc.read_page_raw)
			chip->ecc.read_page_raw = nand_read_page_raw;
		if (!chip->ecc.write_page_raw)
			chip->ecc.write_page_raw = nand_write_page_raw;
3446 3447 3448 3449
		if (!chip->ecc.read_oob)
			chip->ecc.read_oob = nand_read_oob_std;
		if (!chip->ecc.write_oob)
			chip->ecc.write_oob = nand_write_oob_std;
3450

T
Thomas Gleixner 已提交
3451
	case NAND_ECC_HW_SYNDROME:
3452 3453 3454
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
3455
		     chip->ecc.read_page == nand_read_page_hwecc ||
3456
		     !chip->ecc.write_page ||
3457
		     chip->ecc.write_page == nand_write_page_hwecc)) {
3458
			pr_warn("No ECC functions supplied; "
3459
				   "hardware ECC not possible\n");
T
Thomas Gleixner 已提交
3460 3461
			BUG();
		}
3462
		/* Use standard syndrome read/write page function? */
3463 3464
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
3465 3466
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
3467 3468 3469 3470
		if (!chip->ecc.read_page_raw)
			chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
		if (!chip->ecc.write_page_raw)
			chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
3471 3472 3473 3474
		if (!chip->ecc.read_oob)
			chip->ecc.read_oob = nand_read_oob_syndrome;
		if (!chip->ecc.write_oob)
			chip->ecc.write_oob = nand_write_oob_syndrome;
3475

3476 3477 3478 3479 3480
		if (mtd->writesize >= chip->ecc.size) {
			if (!chip->ecc.strength) {
				pr_warn("Driver must set ecc.strength when using hardware ECC\n");
				BUG();
			}
T
Thomas Gleixner 已提交
3481
			break;
3482
		}
3483
		pr_warn("%d byte HW ECC not possible on "
3484 3485
			   "%d byte page size, fallback to SW ECC\n",
			   chip->ecc.size, mtd->writesize);
3486
		chip->ecc.mode = NAND_ECC_SOFT;
3487

T
Thomas Gleixner 已提交
3488
	case NAND_ECC_SOFT:
3489 3490
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
3491
		chip->ecc.read_page = nand_read_page_swecc;
3492
		chip->ecc.read_subpage = nand_read_subpage;
3493
		chip->ecc.write_page = nand_write_page_swecc;
3494 3495
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3496 3497
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
3498 3499
		if (!chip->ecc.size)
			chip->ecc.size = 256;
3500
		chip->ecc.bytes = 3;
M
Mike Dunn 已提交
3501
		chip->ecc.strength = 1;
L
Linus Torvalds 已提交
3502
		break;
3503

3504 3505
	case NAND_ECC_SOFT_BCH:
		if (!mtd_nand_has_bch()) {
3506
			pr_warn("CONFIG_MTD_ECC_BCH not enabled\n");
3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520
			BUG();
		}
		chip->ecc.calculate = nand_bch_calculate_ecc;
		chip->ecc.correct = nand_bch_correct_data;
		chip->ecc.read_page = nand_read_page_swecc;
		chip->ecc.read_subpage = nand_read_subpage;
		chip->ecc.write_page = nand_write_page_swecc;
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
		/*
		 * Board driver should supply ecc.size and ecc.bytes values to
		 * select how many bits are correctable; see nand_bch_init()
3521 3522
		 * for details. Otherwise, default to 4 bits for large page
		 * devices.
3523 3524 3525 3526 3527 3528 3529 3530 3531 3532
		 */
		if (!chip->ecc.size && (mtd->oobsize >= 64)) {
			chip->ecc.size = 512;
			chip->ecc.bytes = 7;
		}
		chip->ecc.priv = nand_bch_init(mtd,
					       chip->ecc.size,
					       chip->ecc.bytes,
					       &chip->ecc.layout);
		if (!chip->ecc.priv) {
3533
			pr_warn("BCH ECC initialization failed!\n");
3534 3535
			BUG();
		}
M
Mike Dunn 已提交
3536
		chip->ecc.strength =
3537
			chip->ecc.bytes * 8 / fls(8 * chip->ecc.size);
3538 3539
		break;

3540
	case NAND_ECC_NONE:
3541
		pr_warn("NAND_ECC_NONE selected by board driver. "
3542
			   "This is not recommended!\n");
3543 3544
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
3545
		chip->ecc.read_oob = nand_read_oob_std;
3546 3547
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3548
		chip->ecc.write_oob = nand_write_oob_std;
3549 3550
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
M
Mike Dunn 已提交
3551
		chip->ecc.strength = 0;
L
Linus Torvalds 已提交
3552
		break;
3553

L
Linus Torvalds 已提交
3554
	default:
3555
		pr_warn("Invalid NAND_ECC_MODE %d\n", chip->ecc.mode);
3556
		BUG();
L
Linus Torvalds 已提交
3557
	}
3558

3559
	/* For many systems, the standard OOB write also works for raw */
3560 3561
	if (!chip->ecc.read_oob_raw)
		chip->ecc.read_oob_raw = chip->ecc.read_oob;
3562 3563 3564
	if (!chip->ecc.write_oob_raw)
		chip->ecc.write_oob_raw = chip->ecc.write_oob;

3565 3566
	/*
	 * The number of bytes available for a client to place data into
3567
	 * the out of band area.
3568 3569
	 */
	chip->ecc.layout->oobavail = 0;
3570 3571
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
3572 3573
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
3574
	mtd->oobavail = chip->ecc.layout->oobavail;
3575

T
Thomas Gleixner 已提交
3576 3577
	/*
	 * Set the number of read / write steps for one page depending on ECC
3578
	 * mode.
T
Thomas Gleixner 已提交
3579
	 */
3580
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
3581
	if (chip->ecc.steps * chip->ecc.size != mtd->writesize) {
3582
		pr_warn("Invalid ECC parameters\n");
T
Thomas Gleixner 已提交
3583
		BUG();
L
Linus Torvalds 已提交
3584
	}
3585
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
3586

3587
	/* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
3588 3589
	if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
	    !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
3590
		switch (chip->ecc.steps) {
3591 3592 3593 3594 3595
		case 2:
			mtd->subpage_sft = 1;
			break;
		case 4:
		case 8:
3596
		case 16:
3597 3598 3599 3600 3601 3602
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

3603
	/* Initialize state */
3604
	chip->state = FL_READY;
L
Linus Torvalds 已提交
3605 3606

	/* Invalidate the pagebuffer reference */
3607
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
3608

3609 3610 3611 3612
	/* Large page NAND with SOFT_ECC should support subpage reads */
	if ((chip->ecc.mode == NAND_ECC_SOFT) && (chip->page_shift > 9))
		chip->options |= NAND_SUBPAGE_READ;

L
Linus Torvalds 已提交
3613 3614
	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
3615 3616
	mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
						MTD_CAP_NANDFLASH;
3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631
	mtd->_erase = nand_erase;
	mtd->_point = NULL;
	mtd->_unpoint = NULL;
	mtd->_read = nand_read;
	mtd->_write = nand_write;
	mtd->_panic_write = panic_nand_write;
	mtd->_read_oob = nand_read_oob;
	mtd->_write_oob = nand_write_oob;
	mtd->_sync = nand_sync;
	mtd->_lock = NULL;
	mtd->_unlock = NULL;
	mtd->_suspend = nand_suspend;
	mtd->_resume = nand_resume;
	mtd->_block_isbad = nand_block_isbad;
	mtd->_block_markbad = nand_block_markbad;
3632
	mtd->writebufsize = mtd->writesize;
L
Linus Torvalds 已提交
3633

M
Mike Dunn 已提交
3634
	/* propagate ecc info to mtd_info */
3635
	mtd->ecclayout = chip->ecc.layout;
3636
	mtd->ecc_strength = chip->ecc.strength;
3637 3638 3639 3640 3641 3642 3643
	/*
	 * Initialize bitflip_threshold to its default prior scan_bbt() call.
	 * scan_bbt() might invoke mtd_read(), thus bitflip_threshold must be
	 * properly set.
	 */
	if (!mtd->bitflip_threshold)
		mtd->bitflip_threshold = mtd->ecc_strength;
L
Linus Torvalds 已提交
3644

3645
	/* Check, if we should skip the bad block table scan */
3646
	if (chip->options & NAND_SKIP_BBTSCAN)
3647
		return 0;
L
Linus Torvalds 已提交
3648 3649

	/* Build bad block table */
3650
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3651
}
3652
EXPORT_SYMBOL(nand_scan_tail);
L
Linus Torvalds 已提交
3653

3654 3655
/*
 * is_module_text_address() isn't exported, and it's mostly a pointless
3656
 * test if this is a module _anyway_ -- they'd have to try _really_ hard
3657 3658
 * to call us from in-kernel code if the core NAND support is modular.
 */
3659 3660 3661 3662
#ifdef MODULE
#define caller_is_module() (1)
#else
#define caller_is_module() \
3663
	is_module_text_address((unsigned long)__builtin_return_address(0))
3664 3665 3666 3667
#endif

/**
 * nand_scan - [NAND Interface] Scan for the NAND device
3668 3669
 * @mtd: MTD device structure
 * @maxchips: number of chips to scan for
3670
 *
3671 3672 3673 3674
 * This fills out all the uninitialized function pointers with the defaults.
 * The flash ID is read and the mtd/chip structures are filled with the
 * appropriate values. The mtd->owner field must be set to the module of the
 * caller.
3675 3676 3677 3678 3679 3680 3681
 */
int nand_scan(struct mtd_info *mtd, int maxchips)
{
	int ret;

	/* Many callers got this wrong, so check for it for a while... */
	if (!mtd->owner && caller_is_module()) {
3682
		pr_crit("%s called with NULL mtd->owner!\n", __func__);
3683 3684 3685
		BUG();
	}

3686
	ret = nand_scan_ident(mtd, maxchips, NULL);
3687 3688 3689 3690
	if (!ret)
		ret = nand_scan_tail(mtd);
	return ret;
}
3691
EXPORT_SYMBOL(nand_scan);
3692

L
Linus Torvalds 已提交
3693
/**
3694
 * nand_release - [NAND Interface] Free resources held by the NAND device
3695 3696
 * @mtd: MTD device structure
 */
3697
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3698
{
3699
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3700

3701 3702 3703
	if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
		nand_bch_free((struct nand_bch_control *)chip->ecc.priv);

3704
	mtd_device_unregister(mtd);
L
Linus Torvalds 已提交
3705

J
Jesper Juhl 已提交
3706
	/* Free bad block table memory */
3707
	kfree(chip->bbt);
3708 3709
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
3710 3711 3712 3713 3714

	/* Free bad block descriptor memory */
	if (chip->badblock_pattern && chip->badblock_pattern->options
			& NAND_BBT_DYNAMICSTRUCT)
		kfree(chip->badblock_pattern);
L
Linus Torvalds 已提交
3715
}
3716
EXPORT_SYMBOL_GPL(nand_release);
3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731

static int __init nand_base_init(void)
{
	led_trigger_register_simple("nand-disk", &nand_led_trigger);
	return 0;
}

static void __exit nand_base_exit(void)
{
	led_trigger_unregister_simple(nand_led_trigger);
}

module_init(nand_base_init);
module_exit(nand_base_exit);

3732
MODULE_LICENSE("GPL");
3733 3734
MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
3735
MODULE_DESCRIPTION("Generic NAND flash driver code");