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