[people/ms/u-boot.git] / drivers / mtd / nand / nand_util.c

/*
 * drivers/mtd/nand/nand_util.c
 *
 * Copyright (C) 2006 by Weiss-Electronic GmbH.
 * All rights reserved.
 *
 * @author:	Guido Classen <clagix@gmail.com>
 * @descr:	NAND Flash support
 * @references: borrowed heavily from Linux mtd-utils code:
 *		flash_eraseall.c by Arcom Control System Ltd
 *		nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
 *			       and Thomas Gleixner (tglx@linutronix.de)
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 * Copyright 2010 Freescale Semiconductor
 * The portions of this file whose copyright is held by Freescale and which
 * are not considered a derived work of GPL v2-only code may be distributed
 * and/or modified under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 */

#include <common.h>
#include <command.h>
#include <watchdog.h>
#include <malloc.h>
#include <div64.h>

#include <asm/errno.h>
#include <linux/mtd/mtd.h>
#include <nand.h>
#include <jffs2/jffs2.h>

typedef struct erase_info erase_info_t;
typedef struct mtd_info	  mtd_info_t;

/* support only for native endian JFFS2 */
#define cpu_to_je16(x) (x)
#define cpu_to_je32(x) (x)

/*****************************************************************************/
static int nand_block_bad_scrub(struct mtd_info *mtd, loff_t ofs, int getchip)
{
	return 0;
}

/**
 * nand_erase_opts: - erase NAND flash with support for various options
 *		      (jffs2 formating)
 *
 * @param meminfo	NAND device to erase
 * @param opts		options,  @see struct nand_erase_options
 * @return		0 in case of success
 *
 * This code is ported from flash_eraseall.c from Linux mtd utils by
 * Arcom Control System Ltd.
 */
int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
{
	struct jffs2_unknown_node cleanmarker;
	erase_info_t erase;
	unsigned long erase_length, erased_length; /* in blocks */
	int bbtest = 1;
	int result;
	int percent_complete = -1;
	int (*nand_block_bad_old)(struct mtd_info *, loff_t, int) = NULL;
	const char *mtd_device = meminfo->name;
	struct mtd_oob_ops oob_opts;
	struct nand_chip *chip = meminfo->priv;

	if ((opts->offset & (meminfo->writesize - 1)) != 0) {
		printf("Attempt to erase non page aligned data\n");
		return -1;
	}

	memset(&erase, 0, sizeof(erase));
	memset(&oob_opts, 0, sizeof(oob_opts));

	erase.mtd = meminfo;
	erase.len  = meminfo->erasesize;
	erase.addr = opts->offset;
	erase_length = lldiv(opts->length + meminfo->erasesize - 1,
			     meminfo->erasesize);

	cleanmarker.magic = cpu_to_je16 (JFFS2_MAGIC_BITMASK);
	cleanmarker.nodetype = cpu_to_je16 (JFFS2_NODETYPE_CLEANMARKER);
	cleanmarker.totlen = cpu_to_je32(8);

	/* scrub option allows to erase badblock. To prevent internal
	 * check from erase() method, set block check method to dummy
	 * and disable bad block table while erasing.
	 */
	if (opts->scrub) {
		struct nand_chip *priv_nand = meminfo->priv;

		nand_block_bad_old = priv_nand->block_bad;
		priv_nand->block_bad = nand_block_bad_scrub;
		/* we don't need the bad block table anymore...
		 * after scrub, there are no bad blocks left!
		 */
		if (priv_nand->bbt) {
			kfree(priv_nand->bbt);
		}
		priv_nand->bbt = NULL;
	}

	for (erased_length = 0;
	     erased_length < erase_length;
	     erase.addr += meminfo->erasesize) {

		WATCHDOG_RESET ();

		if (!opts->scrub && bbtest) {
			int ret = meminfo->block_isbad(meminfo, erase.addr);
			if (ret > 0) {
				if (!opts->quiet)
					printf("\rSkipping bad block at  "
					       "0x%08llx                 "
					       "                         \n",
					       erase.addr);

				if (!opts->spread)
					erased_length++;

				continue;

			} else if (ret < 0) {
				printf("\n%s: MTD get bad block failed: %d\n",
				       mtd_device,
				       ret);
				return -1;
			}
		}

		erased_length++;

		result = meminfo->erase(meminfo, &erase);
		if (result != 0) {
			printf("\n%s: MTD Erase failure: %d\n",
			       mtd_device, result);
			continue;
		}

		/* format for JFFS2 ? */
		if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
			chip->ops.ooblen = 8;
			chip->ops.datbuf = NULL;
			chip->ops.oobbuf = (uint8_t *)&cleanmarker;
			chip->ops.ooboffs = 0;
			chip->ops.mode = MTD_OOB_AUTO;

			result = meminfo->write_oob(meminfo,
			                            erase.addr,
			                            &chip->ops);
			if (result != 0) {
				printf("\n%s: MTD writeoob failure: %d\n",
				       mtd_device, result);
				continue;
			}
		}

		if (!opts->quiet) {
			unsigned long long n = erased_length * 100ULL;
			int percent;

			do_div(n, erase_length);
			percent = (int)n;

			/* output progress message only at whole percent
			 * steps to reduce the number of messages printed
			 * on (slow) serial consoles
			 */
			if (percent != percent_complete) {
				percent_complete = percent;

				printf("\rErasing at 0x%llx -- %3d%% complete.",
				       erase.addr, percent);

				if (opts->jffs2 && result == 0)
					printf(" Cleanmarker written at 0x%llx.",
					       erase.addr);
			}
		}
	}
	if (!opts->quiet)
		printf("\n");

	if (nand_block_bad_old) {
		struct nand_chip *priv_nand = meminfo->priv;

		priv_nand->block_bad = nand_block_bad_old;
		priv_nand->scan_bbt(meminfo);
	}

	return 0;
}

#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK

/******************************************************************************
 * Support for locking / unlocking operations of some NAND devices
 *****************************************************************************/

#define NAND_CMD_LOCK		0x2a
#define NAND_CMD_LOCK_TIGHT	0x2c
#define NAND_CMD_UNLOCK1	0x23
#define NAND_CMD_UNLOCK2	0x24
#define NAND_CMD_LOCK_STATUS	0x7a

/**
 * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
 *	      state
 *
 * @param mtd		nand mtd instance
 * @param tight		bring device in lock tight mode
 *
 * @return		0 on success, -1 in case of error
 *
 * The lock / lock-tight command only applies to the whole chip. To get some
 * parts of the chip lock and others unlocked use the following sequence:
 *
 * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
 * - Call nand_unlock() once for each consecutive area to be unlocked
 * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
 *
 *   If the device is in lock-tight state software can't change the
 *   current active lock/unlock state of all pages. nand_lock() / nand_unlock()
 *   calls will fail. It is only posible to leave lock-tight state by
 *   an hardware signal (low pulse on _WP pin) or by power down.
 */
int nand_lock(struct mtd_info *mtd, int tight)
{
	int ret = 0;
	int status;
	struct nand_chip *chip = mtd->priv;

	/* select the NAND device */
	chip->select_chip(mtd, 0);

	chip->cmdfunc(mtd,
		      (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
		      -1, -1);

	/* call wait ready function */
	status = chip->waitfunc(mtd, chip);

	/* see if device thinks it succeeded */
	if (status & 0x01) {
		ret = -1;
	}

	/* de-select the NAND device */
	chip->select_chip(mtd, -1);
	return ret;
}

/**
 * nand_get_lock_status: - query current lock state from one page of NAND
 *			   flash
 *
 * @param mtd		nand mtd instance
 * @param offset	page address to query (muss be page aligned!)
 *
 * @return		-1 in case of error
 *			>0 lock status:
 *			  bitfield with the following combinations:
 *			  NAND_LOCK_STATUS_TIGHT: page in tight state
 *			  NAND_LOCK_STATUS_LOCK:  page locked
 *			  NAND_LOCK_STATUS_UNLOCK: page unlocked
 *
 */
int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
{
	int ret = 0;
	int chipnr;
	int page;
	struct nand_chip *chip = mtd->priv;

	/* select the NAND device */
	chipnr = (int)(offset >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);


	if ((offset & (mtd->writesize - 1)) != 0) {
		printf ("nand_get_lock_status: "
			"Start address must be beginning of "
			"nand page!\n");
		ret = -1;
		goto out;
	}

	/* check the Lock Status */
	page = (int)(offset >> chip->page_shift);
	chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);

	ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
					  | NAND_LOCK_STATUS_LOCK
					  | NAND_LOCK_STATUS_UNLOCK);

 out:
	/* de-select the NAND device */
	chip->select_chip(mtd, -1);
	return ret;
}

/**
 * nand_unlock: - Unlock area of NAND pages
 *		  only one consecutive area can be unlocked at one time!
 *
 * @param mtd		nand mtd instance
 * @param start		start byte address
 * @param length	number of bytes to unlock (must be a multiple of
 *			page size nand->writesize)
 *
 * @return		0 on success, -1 in case of error
 */
int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
{
	int ret = 0;
	int chipnr;
	int status;
	int page;
	struct nand_chip *chip = mtd->priv;
	printf ("nand_unlock: start: %08x, length: %d!\n",
		(int)start, (int)length);

	/* select the NAND device */
	chipnr = (int)(start >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

	/* check the WP bit */
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
		printf ("nand_unlock: Device is write protected!\n");
		ret = -1;
		goto out;
	}

	if ((start & (mtd->erasesize - 1)) != 0) {
		printf ("nand_unlock: Start address must be beginning of "
			"nand block!\n");
		ret = -1;
		goto out;
	}

	if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
		printf ("nand_unlock: Length must be a multiple of nand block "
			"size %08x!\n", mtd->erasesize);
		ret = -1;
		goto out;
	}

	/*
	 * Set length so that the last address is set to the
	 * starting address of the last block
	 */
	length -= mtd->erasesize;

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

	/* submit ADDRESS of LAST page to unlock */
	page += (int)(length >> chip->page_shift);
	chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);

	/* call wait ready function */
	status = chip->waitfunc(mtd, chip);
	/* see if device thinks it succeeded */
	if (status & 0x01) {
		/* there was an error */
		ret = -1;
		goto out;
	}

 out:
	/* de-select the NAND device */
	chip->select_chip(mtd, -1);
	return ret;
}
#endif

/**
 * check_skip_len
 *
 * Check if there are any bad blocks, and whether length including bad
 * blocks fits into device
 *
 * @param nand NAND device
 * @param offset offset in flash
 * @param length image length
 * @return 0 if the image fits and there are no bad blocks
 *         1 if the image fits, but there are bad blocks
 *        -1 if the image does not fit
 */
static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length)
{
	size_t len_excl_bad = 0;
	int ret = 0;

	while (len_excl_bad < length) {
		size_t block_len, block_off;
		loff_t block_start;

		if (offset >= nand->size)
			return -1;

		block_start = offset & ~(loff_t)(nand->erasesize - 1);
		block_off = offset & (nand->erasesize - 1);
		block_len = nand->erasesize - block_off;

		if (!nand_block_isbad(nand, block_start))
			len_excl_bad += block_len;
		else
			ret = 1;

		offset += block_len;
	}

	return ret;
}

/**
 * nand_write_skip_bad:
 *
 * Write image to NAND flash.
 * Blocks that are marked bad are skipped and the is written to the next
 * block instead as long as the image is short enough to fit even after
 * skipping the bad blocks.
 *
 * @param nand  	NAND device
 * @param offset	offset in flash
 * @param length	buffer length
 * @param buf           buffer to read from
 * @return		0 in case of success
 */
int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
			u_char *buffer)
{
	int rval;
	size_t left_to_write = *length;
	u_char *p_buffer = buffer;
	int need_skip;

	/*
	 * nand_write() handles unaligned, partial page writes.
	 *
	 * We allow length to be unaligned, for convenience in
	 * using the $filesize variable.
	 *
	 * However, starting at an unaligned offset makes the
	 * semantics of bad block skipping ambiguous (really,
	 * you should only start a block skipping access at a
	 * partition boundary).  So don't try to handle that.
	 */
	if ((offset & (nand->writesize - 1)) != 0) {
		printf ("Attempt to write non page aligned data\n");
		*length = 0;
		return -EINVAL;
	}

	need_skip = check_skip_len(nand, offset, *length);
	if (need_skip < 0) {
		printf ("Attempt to write outside the flash area\n");
		*length = 0;
		return -EINVAL;
	}

	if (!need_skip) {
		rval = nand_write (nand, offset, length, buffer);
		if (rval == 0)
			return 0;

		*length = 0;
		printf ("NAND write to offset %llx failed %d\n",
			offset, rval);
		return rval;
	}

	while (left_to_write > 0) {
		size_t block_offset = offset & (nand->erasesize - 1);
		size_t write_size;

		WATCHDOG_RESET ();

		if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
			printf ("Skip bad block 0x%08llx\n",
				offset & ~(nand->erasesize - 1));
			offset += nand->erasesize - block_offset;
			continue;
		}

		if (left_to_write < (nand->erasesize - block_offset))
			write_size = left_to_write;
		else
			write_size = nand->erasesize - block_offset;

		rval = nand_write (nand, offset, &write_size, p_buffer);
		if (rval != 0) {
			printf ("NAND write to offset %llx failed %d\n",
				offset, rval);
			*length -= left_to_write;
			return rval;
		}

		left_to_write -= write_size;
		offset        += write_size;
		p_buffer      += write_size;
	}

	return 0;
}

/**
 * nand_read_skip_bad:
 *
 * Read image from NAND flash.
 * Blocks that are marked bad are skipped and the next block is readen
 * instead as long as the image is short enough to fit even after skipping the
 * bad blocks.
 *
 * @param nand NAND device
 * @param offset offset in flash
 * @param length buffer length, on return holds remaining bytes to read
 * @param buffer buffer to write to
 * @return 0 in case of success
 */
int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
		       u_char *buffer)
{
	int rval;
	size_t left_to_read = *length;
	u_char *p_buffer = buffer;
	int need_skip;

	if ((offset & (nand->writesize - 1)) != 0) {
		printf ("Attempt to read non page aligned data\n");
		*length = 0;
		return -EINVAL;
	}

	need_skip = check_skip_len(nand, offset, *length);
	if (need_skip < 0) {
		printf ("Attempt to read outside the flash area\n");
		*length = 0;
		return -EINVAL;
	}

	if (!need_skip) {
		rval = nand_read (nand, offset, length, buffer);
		if (!rval || rval == -EUCLEAN)
			return 0;

		*length = 0;
		printf ("NAND read from offset %llx failed %d\n",
			offset, rval);
		return rval;
	}

	while (left_to_read > 0) {
		size_t block_offset = offset & (nand->erasesize - 1);
		size_t read_length;

		WATCHDOG_RESET ();

		if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
			printf ("Skipping bad block 0x%08llx\n",
				offset & ~(nand->erasesize - 1));
			offset += nand->erasesize - block_offset;
			continue;
		}

		if (left_to_read < (nand->erasesize - block_offset))
			read_length = left_to_read;
		else
			read_length = nand->erasesize - block_offset;

		rval = nand_read (nand, offset, &read_length, p_buffer);
		if (rval && rval != -EUCLEAN) {
			printf ("NAND read from offset %llx failed %d\n",
				offset, rval);
			*length -= left_to_read;
			return rval;
		}

		left_to_read -= read_length;
		offset       += read_length;
		p_buffer     += read_length;
	}

	return 0;
}
Commit	Line	Data
2255b2d2	1	/*
7817cb20	2	* drivers/mtd/nand/nand_util.c
2255b2d2 SR	3	*
	4	* Copyright (C) 2006 by Weiss-Electronic GmbH.
	5	* All rights reserved.
	6	*
	7	* @author: Guido Classen <clagix@gmail.com>
	8	* @descr: NAND Flash support
	9	* @references: borrowed heavily from Linux mtd-utils code:
	10	* flash_eraseall.c by Arcom Control System Ltd
	11	* nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
	12	* and Thomas Gleixner (tglx@linutronix.de)
	13	*
	14	* See file CREDITS for list of people who contributed to this
	15	* project.
	16	*
	17	* This program is free software; you can redistribute it and/or
	18	* modify it under the terms of the GNU General Public License version
	19	* 2 as published by the Free Software Foundation.
	20	*
	21	* This program is distributed in the hope that it will be useful,
	22	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	23	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	24	* GNU General Public License for more details.
	25	*
	26	* You should have received a copy of the GNU General Public License
	27	* along with this program; if not, write to the Free Software
	28	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	29	* MA 02111-1307 USA
	30	*
f9a52541 SW	31	* Copyright 2010 Freescale Semiconductor
	32	* The portions of this file whose copyright is held by Freescale and which
	33	* are not considered a derived work of GPL v2-only code may be distributed
	34	* and/or modified under the terms of the GNU General Public License as
	35	* published by the Free Software Foundation; either version 2 of the
	36	* License, or (at your option) any later version.
2255b2d2 SR	37	*/
	38
	39	#include <common.h>
2255b2d2 SR	40	#include <command.h>
	41	#include <watchdog.h>
	42	#include <malloc.h>
3a6d56c2	43	#include <div64.h>
2255b2d2	44
cfa460ad WJ	45	#include <asm/errno.h>
cfa460ad WJ	46	#include <linux/mtd/mtd.h>
2255b2d2 SR	47	#include <nand.h>
	48	#include <jffs2/jffs2.h>
	49
	50	typedef struct erase_info erase_info_t;
	51	typedef struct mtd_info mtd_info_t;
	52
	53	/* support only for native endian JFFS2 */
	54	#define cpu_to_je16(x) (x)
	55	#define cpu_to_je32(x) (x)
	56
	57	/*****************************************************************************/
	58	static int nand_block_bad_scrub(struct mtd_info *mtd, loff_t ofs, int getchip)
	59	{
	60	return 0;
	61	}
	62
	63	/**
	64	* nand_erase_opts: - erase NAND flash with support for various options
	65	* (jffs2 formating)
	66	*
	67	* @param meminfo NAND device to erase
	68	* @param opts options, @see struct nand_erase_options
	69	* @return 0 in case of success
	70	*
	71	* This code is ported from flash_eraseall.c from Linux mtd utils by
	72	* Arcom Control System Ltd.
	73	*/
	74	int nand_erase_opts(nand_info_t meminfo, const nand_erase_options_t opts)
	75	{
	76	struct jffs2_unknown_node cleanmarker;
2255b2d2	77	erase_info_t erase;
30486322	78	unsigned long erase_length, erased_length; /* in blocks */
2255b2d2 SR	79	int bbtest = 1;
	80	int result;
	81	int percent_complete = -1;
	82	int (nand_block_bad_old)(struct mtd_info , loff_t, int) = NULL;
	83	const char *mtd_device = meminfo->name;
cfa460ad WJ	84	struct mtd_oob_ops oob_opts;
cfa460ad WJ	85	struct nand_chip *chip = meminfo->priv;
2255b2d2	86
30486322 SW	87	if ((opts->offset & (meminfo->writesize - 1)) != 0) {
	88	printf("Attempt to erase non page aligned data\n");
	89	return -1;
	90	}
	91
2255b2d2	92	memset(&erase, 0, sizeof(erase));
cfa460ad	93	memset(&oob_opts, 0, sizeof(oob_opts));
2255b2d2 SR	94
	95	erase.mtd = meminfo;
	96	erase.len = meminfo->erasesize;
856f0544	97	erase.addr = opts->offset;
30486322 SW	98	erase_length = lldiv(opts->length + meminfo->erasesize - 1,
30486322 SW	99	meminfo->erasesize);
2255b2d2	100
cfa460ad WJ	101	cleanmarker.magic = cpu_to_je16 (JFFS2_MAGIC_BITMASK);
	102	cleanmarker.nodetype = cpu_to_je16 (JFFS2_NODETYPE_CLEANMARKER);
	103	cleanmarker.totlen = cpu_to_je32(8);
2255b2d2 SR	104
	105	/* scrub option allows to erase badblock. To prevent internal
	106	* check from erase() method, set block check method to dummy
	107	* and disable bad block table while erasing.
	108	*/
	109	if (opts->scrub) {
	110	struct nand_chip *priv_nand = meminfo->priv;
	111
	112	nand_block_bad_old = priv_nand->block_bad;
	113	priv_nand->block_bad = nand_block_bad_scrub;
	114	/* we don't need the bad block table anymore...
	115	* after scrub, there are no bad blocks left!
	116	*/
	117	if (priv_nand->bbt) {
	118	kfree(priv_nand->bbt);
	119	}
	120	priv_nand->bbt = NULL;
	121	}
	122
30486322 SW	123	for (erased_length = 0;
30486322 SW	124	erased_length < erase_length;
2255b2d2	125	erase.addr += meminfo->erasesize) {
4cbb651b	126
2255b2d2 SR	127	WATCHDOG_RESET ();
	128
	129	if (!opts->scrub && bbtest) {
	130	int ret = meminfo->block_isbad(meminfo, erase.addr);
	131	if (ret > 0) {
	132	if (!opts->quiet)
	133	printf("\rSkipping bad block at "
8d2effea	134	"0x%08llx "
87621bc2 WD	135	" \n",
87621bc2 WD	136	erase.addr);
30486322 SW	137
	138	if (!opts->spread)
	139	erased_length++;
	140
2255b2d2 SR	141	continue;
	142
	143	} else if (ret < 0) {
	144	printf("\n%s: MTD get bad block failed: %d\n",
	145	mtd_device,
	146	ret);
	147	return -1;
	148	}
	149	}
	150
30486322 SW	151	erased_length++;
30486322 SW	152
2255b2d2 SR	153	result = meminfo->erase(meminfo, &erase);
	154	if (result != 0) {
	155	printf("\n%s: MTD Erase failure: %d\n",
	156	mtd_device, result);
	157	continue;
	158	}
	159
	160	/* format for JFFS2 ? */
bd78bc6b SW	161	if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
bd78bc6b SW	162	chip->ops.ooblen = 8;
cfa460ad	163	chip->ops.datbuf = NULL;
bd78bc6b SW	164	chip->ops.oobbuf = (uint8_t *)&cleanmarker;
	165	chip->ops.ooboffs = 0;
	166	chip->ops.mode = MTD_OOB_AUTO;
4cbb651b	167
cfa460ad	168	result = meminfo->write_oob(meminfo,
bd78bc6b SW	169	erase.addr,
bd78bc6b SW	170	&chip->ops);
cfa460ad WJ	171	if (result != 0) {
cfa460ad WJ	172	printf("\n%s: MTD writeoob failure: %d\n",
bd78bc6b	173	mtd_device, result);
cfa460ad	174	continue;
2255b2d2 SR	175	}
	176	}
	177
	178	if (!opts->quiet) {
30486322	179	unsigned long long n = erased_length * 100ULL;
5bd7fe9a MF	180	int percent;
	181
	182	do_div(n, erase_length);
	183	percent = (int)n;
2255b2d2 SR	184
	185	/* output progress message only at whole percent
	186	* steps to reduce the number of messages printed
	187	* on (slow) serial consoles
	188	*/
	189	if (percent != percent_complete) {
	190	percent_complete = percent;
	191
8d2effea	192	printf("\rErasing at 0x%llx -- %3d%% complete.",
bd78bc6b	193	erase.addr, percent);
2255b2d2 SR	194
2255b2d2 SR	195	if (opts->jffs2 && result == 0)
8d2effea	196	printf(" Cleanmarker written at 0x%llx.",
bd78bc6b	197	erase.addr);
2255b2d2 SR	198	}
	199	}
	200	}
	201	if (!opts->quiet)
	202	printf("\n");
	203
	204	if (nand_block_bad_old) {
	205	struct nand_chip *priv_nand = meminfo->priv;
	206
	207	priv_nand->block_bad = nand_block_bad_old;
	208	priv_nand->scan_bbt(meminfo);
	209	}
	210
	211	return 0;
	212	}
	213
50657c27 NM	214	#ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
50657c27 NM	215
2255b2d2 SR	216	/******************************************************************************
	217	* Support for locking / unlocking operations of some NAND devices
	218	*****************************************************************************/
	219
	220	#define NAND_CMD_LOCK 0x2a
	221	#define NAND_CMD_LOCK_TIGHT 0x2c
	222	#define NAND_CMD_UNLOCK1 0x23
	223	#define NAND_CMD_UNLOCK2 0x24
	224	#define NAND_CMD_LOCK_STATUS 0x7a
	225
	226	/**
	227	* nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
	228	* state
	229	*
50657c27	230	* @param mtd nand mtd instance
2255b2d2 SR	231	* @param tight bring device in lock tight mode
	232	*
	233	* @return 0 on success, -1 in case of error
	234	*
	235	* The lock / lock-tight command only applies to the whole chip. To get some
	236	* parts of the chip lock and others unlocked use the following sequence:
	237	*
	238	* - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
	239	* - Call nand_unlock() once for each consecutive area to be unlocked
	240	* - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
	241	*
	242	* If the device is in lock-tight state software can't change the
	243	* current active lock/unlock state of all pages. nand_lock() / nand_unlock()
	244	* calls will fail. It is only posible to leave lock-tight state by
	245	* an hardware signal (low pulse on _WP pin) or by power down.
	246	*/
50657c27	247	int nand_lock(struct mtd_info *mtd, int tight)
2255b2d2 SR	248	{
	249	int ret = 0;
	250	int status;
50657c27	251	struct nand_chip *chip = mtd->priv;
2255b2d2 SR	252
2255b2d2 SR	253	/* select the NAND device */
50657c27	254	chip->select_chip(mtd, 0);
2255b2d2	255
50657c27	256	chip->cmdfunc(mtd,
2255b2d2 SR	257	(tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
	258	-1, -1);
	259
	260	/* call wait ready function */
50657c27	261	status = chip->waitfunc(mtd, chip);
2255b2d2 SR	262
	263	/* see if device thinks it succeeded */
	264	if (status & 0x01) {
	265	ret = -1;
	266	}
	267
	268	/* de-select the NAND device */
50657c27	269	chip->select_chip(mtd, -1);
2255b2d2 SR	270	return ret;
	271	}
	272
	273	/**
	274	* nand_get_lock_status: - query current lock state from one page of NAND
	275	* flash
	276	*
50657c27	277	* @param mtd nand mtd instance
2255b2d2 SR	278	* @param offset page address to query (muss be page aligned!)
	279	*
	280	* @return -1 in case of error
	281	* >0 lock status:
	282	* bitfield with the following combinations:
	283	* NAND_LOCK_STATUS_TIGHT: page in tight state
	284	* NAND_LOCK_STATUS_LOCK: page locked
	285	* NAND_LOCK_STATUS_UNLOCK: page unlocked
	286	*
	287	*/
378adfcd	288	int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
2255b2d2 SR	289	{
	290	int ret = 0;
	291	int chipnr;
	292	int page;
50657c27	293	struct nand_chip *chip = mtd->priv;
2255b2d2 SR	294
2255b2d2 SR	295	/* select the NAND device */
50657c27 NM	296	chipnr = (int)(offset >> chip->chip_shift);
50657c27 NM	297	chip->select_chip(mtd, chipnr);
2255b2d2 SR	298
2255b2d2 SR	299
50657c27	300	if ((offset & (mtd->writesize - 1)) != 0) {
2255b2d2 SR	301	printf ("nand_get_lock_status: "
	302	"Start address must be beginning of "
	303	"nand page!\n");
	304	ret = -1;
	305	goto out;
	306	}
	307
	308	/* check the Lock Status */
50657c27 NM	309	page = (int)(offset >> chip->page_shift);
50657c27 NM	310	chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
2255b2d2	311
50657c27	312	ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
2255b2d2 SR	313	\| NAND_LOCK_STATUS_LOCK
	314	\| NAND_LOCK_STATUS_UNLOCK);
	315
	316	out:
	317	/* de-select the NAND device */
50657c27	318	chip->select_chip(mtd, -1);
2255b2d2 SR	319	return ret;
	320	}
	321
	322	/**
	323	* nand_unlock: - Unlock area of NAND pages
	324	* only one consecutive area can be unlocked at one time!
	325	*
50657c27	326	* @param mtd nand mtd instance
2255b2d2 SR	327	* @param start start byte address
2255b2d2 SR	328	* @param length number of bytes to unlock (must be a multiple of
cfa460ad	329	* page size nand->writesize)
2255b2d2 SR	330	*
	331	* @return 0 on success, -1 in case of error
	332	*/
50657c27	333	int nand_unlock(struct mtd_info *mtd, ulong start, ulong length)
2255b2d2 SR	334	{
	335	int ret = 0;
	336	int chipnr;
	337	int status;
	338	int page;
50657c27	339	struct nand_chip *chip = mtd->priv;
2255b2d2 SR	340	printf ("nand_unlock: start: %08x, length: %d!\n",
	341	(int)start, (int)length);
	342
	343	/* select the NAND device */
50657c27 NM	344	chipnr = (int)(start >> chip->chip_shift);
50657c27 NM	345	chip->select_chip(mtd, chipnr);
2255b2d2 SR	346
2255b2d2 SR	347	/* check the WP bit */
50657c27 NM	348	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
50657c27 NM	349	if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
2255b2d2 SR	350	printf ("nand_unlock: Device is write protected!\n");
	351	ret = -1;
	352	goto out;
	353	}
	354
50657c27	355	if ((start & (mtd->erasesize - 1)) != 0) {
2255b2d2	356	printf ("nand_unlock: Start address must be beginning of "
50657c27	357	"nand block!\n");
2255b2d2 SR	358	ret = -1;
	359	goto out;
	360	}
	361
50657c27 NM	362	if (length == 0 \|\| (length & (mtd->erasesize - 1)) != 0) {
	363	printf ("nand_unlock: Length must be a multiple of nand block "
	364	"size %08x!\n", mtd->erasesize);
2255b2d2 SR	365	ret = -1;
	366	goto out;
	367	}
	368
50657c27 NM	369	/*
	370	* Set length so that the last address is set to the
	371	* starting address of the last block
	372	*/
	373	length -= mtd->erasesize;
	374
2255b2d2	375	/* submit address of first page to unlock */
50657c27 NM	376	page = (int)(start >> chip->page_shift);
50657c27 NM	377	chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
2255b2d2 SR	378
2255b2d2 SR	379	/* submit ADDRESS of LAST page to unlock */
50657c27 NM	380	page += (int)(length >> chip->page_shift);
50657c27 NM	381	chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
2255b2d2 SR	382
2255b2d2 SR	383	/* call wait ready function */
50657c27	384	status = chip->waitfunc(mtd, chip);
2255b2d2 SR	385	/* see if device thinks it succeeded */
	386	if (status & 0x01) {
	387	/* there was an error */
	388	ret = -1;
	389	goto out;
	390	}
	391
	392	out:
	393	/* de-select the NAND device */
50657c27	394	chip->select_chip(mtd, -1);
2255b2d2 SR	395	return ret;
2255b2d2 SR	396	}
cfa460ad	397	#endif
2255b2d2	398
dfbf617f	399	/**
f9a52541	400	* check_skip_len
dfbf617f	401	*
f9a52541 SW	402	* Check if there are any bad blocks, and whether length including bad
f9a52541 SW	403	* blocks fits into device
dfbf617f SW	404	*
	405	* @param nand NAND device
	406	* @param offset offset in flash
	407	* @param length image length
f9a52541 SW	408	* @return 0 if the image fits and there are no bad blocks
	409	* 1 if the image fits, but there are bad blocks
	410	* -1 if the image does not fit
dfbf617f	411	*/
f9a52541	412	static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length)
dfbf617f	413	{
dfbf617f	414	size_t len_excl_bad = 0;
f9a52541	415	int ret = 0;
dfbf617f SW	416
dfbf617f SW	417	while (len_excl_bad < length) {
f9a52541 SW	418	size_t block_len, block_off;
f9a52541 SW	419	loff_t block_start;
dfbf617f	420
f9a52541 SW	421	if (offset >= nand->size)
f9a52541 SW	422	return -1;
dfbf617f	423
f9a52541 SW	424	block_start = offset & ~(loff_t)(nand->erasesize - 1);
	425	block_off = offset & (nand->erasesize - 1);
	426	block_len = nand->erasesize - block_off;
dfbf617f	427
f9a52541 SW	428	if (!nand_block_isbad(nand, block_start))
	429	len_excl_bad += block_len;
	430	else
	431	ret = 1;
	432
	433	offset += block_len;
dfbf617f SW	434	}
dfbf617f SW	435
f9a52541	436	return ret;
dfbf617f SW	437	}
	438
	439	/**
	440	* nand_write_skip_bad:
	441	*
	442	* Write image to NAND flash.
	443	* Blocks that are marked bad are skipped and the is written to the next
	444	* block instead as long as the image is short enough to fit even after
	445	* skipping the bad blocks.
	446	*
	447	* @param nand NAND device
	448	* @param offset offset in flash
	449	* @param length buffer length
	450	* @param buf buffer to read from
	451	* @return 0 in case of success
	452	*/
378adfcd	453	int nand_write_skip_bad(nand_info_t nand, loff_t offset, size_t length,
4b070809	454	u_char *buffer)
dfbf617f SW	455	{
	456	int rval;
	457	size_t left_to_write = *length;
dfbf617f	458	u_char *p_buffer = buffer;
f9a52541	459	int need_skip;
dfbf617f	460
f9a52541 SW	461	/*
	462	* nand_write() handles unaligned, partial page writes.
	463	*
	464	* We allow length to be unaligned, for convenience in
	465	* using the $filesize variable.
	466	*
	467	* However, starting at an unaligned offset makes the
	468	* semantics of bad block skipping ambiguous (really,
	469	* you should only start a block skipping access at a
	470	* partition boundary). So don't try to handle that.
	471	*/
	472	if ((offset & (nand->writesize - 1)) != 0) {
dfbf617f	473	printf ("Attempt to write non page aligned data\n");
f9a52541	474	*length = 0;
dfbf617f SW	475	return -EINVAL;
	476	}
	477
f9a52541 SW	478	need_skip = check_skip_len(nand, offset, *length);
f9a52541 SW	479	if (need_skip < 0) {
dfbf617f	480	printf ("Attempt to write outside the flash area\n");
f9a52541	481	*length = 0;
dfbf617f SW	482	return -EINVAL;
	483	}
	484
f9a52541	485	if (!need_skip) {
dfbf617f	486	rval = nand_write (nand, offset, length, buffer);
f9a52541 SW	487	if (rval == 0)
f9a52541 SW	488	return 0;
2077e348	489
f9a52541 SW	490	*length = 0;
	491	printf ("NAND write to offset %llx failed %d\n",
	492	offset, rval);
2077e348	493	return rval;
dfbf617f SW	494	}
	495
	496	while (left_to_write > 0) {
	497	size_t block_offset = offset & (nand->erasesize - 1);
	498	size_t write_size;
	499
1fc1d9ae GB	500	WATCHDOG_RESET ();
1fc1d9ae GB	501
dfbf617f	502	if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
378adfcd	503	printf ("Skip bad block 0x%08llx\n",
dfbf617f SW	504	offset & ~(nand->erasesize - 1));
	505	offset += nand->erasesize - block_offset;
	506	continue;
	507	}
	508
	509	if (left_to_write < (nand->erasesize - block_offset))
	510	write_size = left_to_write;
	511	else
	512	write_size = nand->erasesize - block_offset;
	513
	514	rval = nand_write (nand, offset, &write_size, p_buffer);
	515	if (rval != 0) {
378adfcd	516	printf ("NAND write to offset %llx failed %d\n",
4b070809	517	offset, rval);
dfbf617f SW	518	*length -= left_to_write;
	519	return rval;
	520	}
	521
	522	left_to_write -= write_size;
	523	offset += write_size;
	524	p_buffer += write_size;
	525	}
	526
	527	return 0;
	528	}
	529
	530	/**
	531	* nand_read_skip_bad:
	532	*
	533	* Read image from NAND flash.
	534	* Blocks that are marked bad are skipped and the next block is readen
	535	* instead as long as the image is short enough to fit even after skipping the
	536	* bad blocks.
	537	*
	538	* @param nand NAND device
	539	* @param offset offset in flash
	540	* @param length buffer length, on return holds remaining bytes to read
	541	* @param buffer buffer to write to
	542	* @return 0 in case of success
	543	*/
378adfcd	544	int nand_read_skip_bad(nand_info_t nand, loff_t offset, size_t length,
dfbf617f SW	545	u_char *buffer)
	546	{
	547	int rval;
	548	size_t left_to_read = *length;
dfbf617f	549	u_char *p_buffer = buffer;
f9a52541	550	int need_skip;
dfbf617f	551
f9a52541 SW	552	if ((offset & (nand->writesize - 1)) != 0) {
	553	printf ("Attempt to read non page aligned data\n");
	554	*length = 0;
	555	return -EINVAL;
	556	}
dfbf617f	557
f9a52541 SW	558	need_skip = check_skip_len(nand, offset, *length);
f9a52541 SW	559	if (need_skip < 0) {
dfbf617f	560	printf ("Attempt to read outside the flash area\n");
f9a52541	561	*length = 0;
dfbf617f SW	562	return -EINVAL;
	563	}
	564
f9a52541	565	if (!need_skip) {
dfbf617f	566	rval = nand_read (nand, offset, length, buffer);
3ebf70db VG	567	if (!rval \|\| rval == -EUCLEAN)
3ebf70db VG	568	return 0;
f9a52541 SW	569
f9a52541 SW	570	*length = 0;
3ebf70db VG	571	printf ("NAND read from offset %llx failed %d\n",
3ebf70db VG	572	offset, rval);
2077e348	573	return rval;
dfbf617f SW	574	}
	575
	576	while (left_to_read > 0) {
	577	size_t block_offset = offset & (nand->erasesize - 1);
	578	size_t read_length;
	579
1fc1d9ae GB	580	WATCHDOG_RESET ();
1fc1d9ae GB	581
dfbf617f	582	if (nand_block_isbad (nand, offset & ~(nand->erasesize - 1))) {
378adfcd	583	printf ("Skipping bad block 0x%08llx\n",
dfbf617f SW	584	offset & ~(nand->erasesize - 1));
	585	offset += nand->erasesize - block_offset;
	586	continue;
	587	}
	588
	589	if (left_to_read < (nand->erasesize - block_offset))
	590	read_length = left_to_read;
	591	else
	592	read_length = nand->erasesize - block_offset;
	593
	594	rval = nand_read (nand, offset, &read_length, p_buffer);
3ebf70db	595	if (rval && rval != -EUCLEAN) {
378adfcd	596	printf ("NAND read from offset %llx failed %d\n",
4b070809	597	offset, rval);
dfbf617f SW	598	*length -= left_to_read;
	599	return rval;
	600	}
	601
	602	left_to_read -= read_length;
	603	offset += read_length;
	604	p_buffer += read_length;
	605	}
	606
	607	return 0;
	608	}