[people/ms/u-boot.git] / fs / yaffs2 / yaffs_mtdif2.c

/*
 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
 *
 * Copyright (C) 2002-2007 Aleph One Ltd.
 *   for Toby Churchill Ltd and Brightstar Engineering
 *
 * Created by Charles Manning <charles@aleph1.co.uk>
 *
 * 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.
 */

/* mtd interface for YAFFS2 */

/* XXX U-BOOT XXX */
#include <common.h>
#include <linux/errno.h>

#include "yportenv.h"
#include "yaffs_trace.h"

#include "yaffs_mtdif2.h"

#include <linux/mtd/mtd.h>
#include <linux/types.h>
#include <linux/time.h>

#include "yaffs_trace.h"
#include "yaffs_packedtags2.h"

#define yaffs_dev_to_mtd(dev) ((struct mtd_info *)((dev)->driver_context))
#define yaffs_dev_to_lc(dev) ((struct yaffs_linux_context *)((dev)->os_context))


/* NB For use with inband tags....
 * We assume that the data buffer is of size total_bytes_per_chunk so
 * that we can also use it to load the tags.
 */
int nandmtd2_write_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
			      const u8 *data,
			      const struct yaffs_ext_tags *tags)
{
	struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
	struct mtd_oob_ops ops;

	int retval = 0;
	loff_t addr;

	struct yaffs_packed_tags2 pt;

	int packed_tags_size =
	    dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
	void *packed_tags_ptr =
	    dev->param.no_tags_ecc ? (void *)&pt.t : (void *)&pt;

	yaffs_trace(YAFFS_TRACE_MTD,
		"nandmtd2_write_chunk_tags chunk %d data %p tags %p",
		nand_chunk, data, tags);

	addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;

	/* For yaffs2 writing there must be both data and tags.
	 * If we're using inband tags, then the tags are stuffed into
	 * the end of the data buffer.
	 */
	if (!data || !tags)
		BUG();
	else if (dev->param.inband_tags) {
		struct yaffs_packed_tags2_tags_only *pt2tp;
		pt2tp =
		    (struct yaffs_packed_tags2_tags_only *)(data +
							dev->
							data_bytes_per_chunk);
		yaffs_pack_tags2_tags_only(pt2tp, tags);
	} else {
		yaffs_pack_tags2(&pt, tags, !dev->param.no_tags_ecc);
	}

	ops.mode = MTD_OPS_AUTO_OOB;
	ops.ooblen = (dev->param.inband_tags) ? 0 : packed_tags_size;
	ops.len = dev->param.total_bytes_per_chunk;
	ops.ooboffs = 0;
	ops.datbuf = (u8 *) data;
	ops.oobbuf = (dev->param.inband_tags) ? NULL : packed_tags_ptr;
	retval = mtd_write_oob(mtd, addr, &ops);

	if (retval == 0)
		return YAFFS_OK;
	else
		return YAFFS_FAIL;
}

int nandmtd2_read_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
			     u8 *data, struct yaffs_ext_tags *tags)
{
	struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
	u8 local_spare[128];
	struct mtd_oob_ops ops;
	size_t dummy;
	int retval = 0;
	int local_data = 0;
	struct yaffs_packed_tags2 pt;
	loff_t addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
	int packed_tags_size =
	    dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
	void *packed_tags_ptr =
	    dev->param.no_tags_ecc ? (void *)&pt.t : (void *)&pt;

	yaffs_trace(YAFFS_TRACE_MTD,
		"nandmtd2_read_chunk_tags chunk %d data %p tags %p",
		nand_chunk, data, tags);

	if (dev->param.inband_tags) {

		if (!data) {
			local_data = 1;
			data = yaffs_get_temp_buffer(dev);
		}

	}

	if (dev->param.inband_tags || (data && !tags))
		retval = mtd_read(mtd, addr, dev->param.total_bytes_per_chunk,
				   &dummy, data);
	else if (tags) {
		ops.mode = MTD_OPS_AUTO_OOB;
		ops.ooblen = packed_tags_size;
		ops.len = data ? dev->data_bytes_per_chunk : packed_tags_size;
		ops.ooboffs = 0;
		ops.datbuf = data;
		ops.oobbuf = local_spare;
		retval = mtd_read_oob(mtd, addr, &ops);
	}

	if (dev->param.inband_tags) {
		if (tags) {
			struct yaffs_packed_tags2_tags_only *pt2tp;
			pt2tp =
				(struct yaffs_packed_tags2_tags_only *)
				&data[dev->data_bytes_per_chunk];
			yaffs_unpack_tags2_tags_only(tags, pt2tp);
		}
	} else {
		if (tags) {
			memcpy(packed_tags_ptr,
			       local_spare,
			       packed_tags_size);
			yaffs_unpack_tags2(tags, &pt, !dev->param.no_tags_ecc);
		}
	}

	if (local_data)
		yaffs_release_temp_buffer(dev, data);

	if (tags && retval == -EBADMSG
	    && tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
		tags->ecc_result = YAFFS_ECC_RESULT_UNFIXED;
		dev->n_ecc_unfixed++;
	}
	if (tags && retval == -EUCLEAN
	    && tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
		tags->ecc_result = YAFFS_ECC_RESULT_FIXED;
		dev->n_ecc_fixed++;
	}
	if (retval == 0)
		return YAFFS_OK;
	else
		return YAFFS_FAIL;
}


int nandmtd2_MarkNANDBlockBad(struct yaffs_dev *dev, int blockNo)
{
	struct mtd_info *mtd = (struct mtd_info *)(dev->driver_context);
	int retval;

	yaffs_trace(YAFFS_TRACE_MTD,
		"nandmtd2_MarkNANDBlockBad %d", blockNo);

	retval =
	    mtd_block_markbad(mtd,
			       blockNo * dev->param.chunks_per_block *
			       dev->data_bytes_per_chunk);

	if (retval == 0)
		return YAFFS_OK;
	else
		return YAFFS_FAIL;

}

int nandmtd2_QueryNANDBlock(struct yaffs_dev *dev, int blockNo,
			    enum yaffs_block_state *state, u32 *sequenceNumber)
{
	struct mtd_info *mtd = (struct mtd_info *)(dev->driver_context);
	int retval;

	yaffs_trace(YAFFS_TRACE_MTD, "nandmtd2_QueryNANDBlock %d", blockNo);
	retval =
	    mtd_block_isbad(mtd,
			     blockNo * dev->param.chunks_per_block *
			     dev->data_bytes_per_chunk);

	if (retval) {
		yaffs_trace(YAFFS_TRACE_MTD, "block is bad");

		*state = YAFFS_BLOCK_STATE_DEAD;
		*sequenceNumber = 0;
	} else {
		struct yaffs_ext_tags t;
		nandmtd2_read_chunk_tags(dev,
					   blockNo *
					   dev->param.chunks_per_block, NULL,
					   &t);

		if (t.chunk_used) {
			*sequenceNumber = t.seq_number;
			*state = YAFFS_BLOCK_STATE_NEEDS_SCAN;
		} else {
			*sequenceNumber = 0;
			*state = YAFFS_BLOCK_STATE_EMPTY;
		}
	}
	yaffs_trace(YAFFS_TRACE_MTD, "block is bad seq %d state %d",
			*sequenceNumber, *state);

	if (retval == 0)
		return YAFFS_OK;
	else
		return YAFFS_FAIL;
}
Commit	Line	Data
0e8cc8bd WJ	1	/*
	2	* YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
	3	*
	4	* Copyright (C) 2002-2007 Aleph One Ltd.
	5	* for Toby Churchill Ltd and Brightstar Engineering
	6	*
	7	* Created by Charles Manning <charles@aleph1.co.uk>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*/
	13
	14	/* mtd interface for YAFFS2 */
	15
90ef117b WJ	16	/* XXX U-BOOT XXX */
90ef117b WJ	17	#include <common.h>
1221ce45	18	#include <linux/errno.h>
90ef117b	19
0e8cc8bd	20	#include "yportenv.h"
753ac610	21	#include "yaffs_trace.h"
0e8cc8bd WJ	22
	23	#include "yaffs_mtdif2.h"
	24
b5bf5cb3 MY	25	#include <linux/mtd/mtd.h>
	26	#include <linux/types.h>
	27	#include <linux/time.h>
0e8cc8bd	28
753ac610	29	#include "yaffs_trace.h"
0e8cc8bd WJ	30	#include "yaffs_packedtags2.h"
0e8cc8bd WJ	31
753ac610 CM	32	#define yaffs_dev_to_mtd(dev) ((struct mtd_info *)((dev)->driver_context))
753ac610 CM	33	#define yaffs_dev_to_lc(dev) ((struct yaffs_linux_context *)((dev)->os_context))
0e8cc8bd	34
0e8cc8bd	35
753ac610 CM	36	/* NB For use with inband tags....
	37	* We assume that the data buffer is of size total_bytes_per_chunk so
	38	* that we can also use it to load the tags.
	39	*/
	40	int nandmtd2_write_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
	41	const u8 *data,
	42	const struct yaffs_ext_tags *tags)
	43	{
	44	struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
	45	struct mtd_oob_ops ops;
0e8cc8bd	46
753ac610	47	int retval = 0;
753ac610	48	loff_t addr;
753ac610 CM	49
	50	struct yaffs_packed_tags2 pt;
	51
	52	int packed_tags_size =
	53	dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
	54	void *packed_tags_ptr =
	55	dev->param.no_tags_ecc ? (void )&pt.t : (void )&pt;
	56
	57	yaffs_trace(YAFFS_TRACE_MTD,
	58	"nandmtd2_write_chunk_tags chunk %d data %p tags %p",
	59	nand_chunk, data, tags);
	60
	61	addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
	62
	63	/* For yaffs2 writing there must be both data and tags.
	64	* If we're using inband tags, then the tags are stuffed into
	65	* the end of the data buffer.
	66	*/
	67	if (!data \|\| !tags)
	68	BUG();
	69	else if (dev->param.inband_tags) {
	70	struct yaffs_packed_tags2_tags_only *pt2tp;
	71	pt2tp =
	72	(struct yaffs_packed_tags2_tags_only *)(data +
	73	dev->
	74	data_bytes_per_chunk);
	75	yaffs_pack_tags2_tags_only(pt2tp, tags);
0e8cc8bd	76	} else {
753ac610	77	yaffs_pack_tags2(&pt, tags, !dev->param.no_tags_ecc);
0e8cc8bd	78	}
753ac610	79
dfe64e2c	80	ops.mode = MTD_OPS_AUTO_OOB;
753ac610 CM	81	ops.ooblen = (dev->param.inband_tags) ? 0 : packed_tags_size;
	82	ops.len = dev->param.total_bytes_per_chunk;
	83	ops.ooboffs = 0;
	84	ops.datbuf = (u8 *) data;
	85	ops.oobbuf = (dev->param.inband_tags) ? NULL : packed_tags_ptr;
dfe64e2c	86	retval = mtd_write_oob(mtd, addr, &ops);
0e8cc8bd WJ	87
	88	if (retval == 0)
	89	return YAFFS_OK;
	90	else
	91	return YAFFS_FAIL;
	92	}
	93
753ac610 CM	94	int nandmtd2_read_chunk_tags(struct yaffs_dev *dev, int nand_chunk,
753ac610 CM	95	u8 data, struct yaffs_ext_tags tags)
0e8cc8bd	96	{
753ac610 CM	97	struct mtd_info *mtd = yaffs_dev_to_mtd(dev);
753ac610 CM	98	u8 local_spare[128];
0e8cc8bd	99	struct mtd_oob_ops ops;
0e8cc8bd WJ	100	size_t dummy;
0e8cc8bd WJ	101	int retval = 0;
753ac610 CM	102	int local_data = 0;
	103	struct yaffs_packed_tags2 pt;
	104	loff_t addr = ((loff_t) nand_chunk) * dev->param.total_bytes_per_chunk;
	105	int packed_tags_size =
	106	dev->param.no_tags_ecc ? sizeof(pt.t) : sizeof(pt);
	107	void *packed_tags_ptr =
	108	dev->param.no_tags_ecc ? (void )&pt.t : (void )&pt;
	109
	110	yaffs_trace(YAFFS_TRACE_MTD,
	111	"nandmtd2_read_chunk_tags chunk %d data %p tags %p",
	112	nand_chunk, data, tags);
	113
	114	if (dev->param.inband_tags) {
	115
	116	if (!data) {
	117	local_data = 1;
	118	data = yaffs_get_temp_buffer(dev);
	119	}
0e8cc8bd	120
753ac610	121	}
0e8cc8bd	122
753ac610	123	if (dev->param.inband_tags \|\| (data && !tags))
dfe64e2c	124	retval = mtd_read(mtd, addr, dev->param.total_bytes_per_chunk,
753ac610	125	&dummy, data);
0e8cc8bd	126	else if (tags) {
dfe64e2c	127	ops.mode = MTD_OPS_AUTO_OOB;
753ac610 CM	128	ops.ooblen = packed_tags_size;
753ac610 CM	129	ops.len = data ? dev->data_bytes_per_chunk : packed_tags_size;
0e8cc8bd WJ	130	ops.ooboffs = 0;
0e8cc8bd WJ	131	ops.datbuf = data;
753ac610	132	ops.oobbuf = local_spare;
dfe64e2c	133	retval = mtd_read_oob(mtd, addr, &ops);
0e8cc8bd	134	}
753ac610 CM	135
	136	if (dev->param.inband_tags) {
	137	if (tags) {
	138	struct yaffs_packed_tags2_tags_only *pt2tp;
	139	pt2tp =
	140	(struct yaffs_packed_tags2_tags_only *)
	141	&data[dev->data_bytes_per_chunk];
	142	yaffs_unpack_tags2_tags_only(tags, pt2tp);
0e8cc8bd WJ	143	}
0e8cc8bd WJ	144	} else {
753ac610 CM	145	if (tags) {
	146	memcpy(packed_tags_ptr,
	147	local_spare,
	148	packed_tags_size);
	149	yaffs_unpack_tags2(tags, &pt, !dev->param.no_tags_ecc);
	150	}
0e8cc8bd	151	}
0e8cc8bd	152
753ac610 CM	153	if (local_data)
753ac610 CM	154	yaffs_release_temp_buffer(dev, data);
0e8cc8bd	155
753ac610 CM	156	if (tags && retval == -EBADMSG
	157	&& tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
	158	tags->ecc_result = YAFFS_ECC_RESULT_UNFIXED;
	159	dev->n_ecc_unfixed++;
	160	}
	161	if (tags && retval == -EUCLEAN
	162	&& tags->ecc_result == YAFFS_ECC_RESULT_NO_ERROR) {
	163	tags->ecc_result = YAFFS_ECC_RESULT_FIXED;
	164	dev->n_ecc_fixed++;
	165	}
0e8cc8bd WJ	166	if (retval == 0)
	167	return YAFFS_OK;
	168	else
	169	return YAFFS_FAIL;
	170	}
	171
753ac610 CM	172
753ac610 CM	173	int nandmtd2_MarkNANDBlockBad(struct yaffs_dev *dev, int blockNo)
0e8cc8bd	174	{
753ac610	175	struct mtd_info mtd = (struct mtd_info )(dev->driver_context);
0e8cc8bd	176	int retval;
753ac610 CM	177
	178	yaffs_trace(YAFFS_TRACE_MTD,
	179	"nandmtd2_MarkNANDBlockBad %d", blockNo);
0e8cc8bd WJ	180
0e8cc8bd WJ	181	retval =
dfe64e2c	182	mtd_block_markbad(mtd,
753ac610 CM	183	blockNo * dev->param.chunks_per_block *
753ac610 CM	184	dev->data_bytes_per_chunk);
0e8cc8bd WJ	185
	186	if (retval == 0)
	187	return YAFFS_OK;
	188	else
	189	return YAFFS_FAIL;
	190
	191	}
	192
753ac610 CM	193	int nandmtd2_QueryNANDBlock(struct yaffs_dev *dev, int blockNo,
753ac610 CM	194	enum yaffs_block_state state, u32 sequenceNumber)
0e8cc8bd	195	{
753ac610	196	struct mtd_info mtd = (struct mtd_info )(dev->driver_context);
0e8cc8bd WJ	197	int retval;
0e8cc8bd WJ	198
753ac610	199	yaffs_trace(YAFFS_TRACE_MTD, "nandmtd2_QueryNANDBlock %d", blockNo);
0e8cc8bd	200	retval =
dfe64e2c	201	mtd_block_isbad(mtd,
753ac610 CM	202	blockNo * dev->param.chunks_per_block *
753ac610 CM	203	dev->data_bytes_per_chunk);
0e8cc8bd WJ	204
0e8cc8bd WJ	205	if (retval) {
753ac610	206	yaffs_trace(YAFFS_TRACE_MTD, "block is bad");
0e8cc8bd WJ	207
	208	*state = YAFFS_BLOCK_STATE_DEAD;
	209	*sequenceNumber = 0;
	210	} else {
753ac610 CM	211	struct yaffs_ext_tags t;
	212	nandmtd2_read_chunk_tags(dev,
	213	blockNo *
	214	dev->param.chunks_per_block, NULL,
	215	&t);
	216
	217	if (t.chunk_used) {
	218	*sequenceNumber = t.seq_number;
	219	*state = YAFFS_BLOCK_STATE_NEEDS_SCAN;
0e8cc8bd WJ	220	} else {
	221	*sequenceNumber = 0;
	222	*state = YAFFS_BLOCK_STATE_EMPTY;
	223	}
	224	}
753ac610 CM	225	yaffs_trace(YAFFS_TRACE_MTD, "block is bad seq %d state %d",
753ac610 CM	226	sequenceNumber, state);
0e8cc8bd WJ	227
	228	if (retval == 0)
	229	return YAFFS_OK;
	230	else
	231	return YAFFS_FAIL;
	232	}