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