2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
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.
15 #include "yaffs_guts.h"
18 #include "yaffs_nandif.h"
19 #include "yaffs_packedtags2.h"
23 #include "yaffs_trace.h"
27 /* NB For use with inband tags....
28 * We assume that the data buffer is of size totalBytersPerChunk so that we can also
29 * use it to load the tags.
31 int ynandif_WriteChunkWithTagsToNAND(struct yaffs_dev * dev, int nand_chunk,
33 const struct yaffs_ext_tags * tags)
37 struct yaffs_packed_tags2 pt;
39 unsigned spareSize = 0;
40 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
44 ("nandmtd2_WriteChunkWithTagsToNAND chunk %d data %p tags %p"
45 TENDSTR), nand_chunk, data, tags));
48 /* For yaffs2 writing there must be both data and tags.
49 * If we're using inband tags, then the tags are stuffed into
50 * the end of the data buffer.
53 if(dev->param.inband_tags){
54 struct yaffs_packed_tags2_tags_only *pt2tp;
55 pt2tp = (struct yaffs_packed_tags2_tags_only *)(data + dev->data_bytes_per_chunk);
56 yaffs_pack_tags2_tags_only(pt2tp,tags);
61 yaffs_pack_tags2(&pt, tags,!dev->param.no_tags_ecc);
63 spareSize = sizeof(struct yaffs_packed_tags2);
66 retval = geometry->writeChunk(dev,nand_chunk,
67 data, dev->param.total_bytes_per_chunk, spare, spareSize);
72 int ynandif_ReadChunkWithTagsFromNAND(struct yaffs_dev * dev, int nand_chunk,
73 u8 * data, struct yaffs_ext_tags * tags)
75 struct yaffs_packed_tags2 pt;
80 int eccStatus; //0 = ok, 1 = fixed, -1 = unfixed
81 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
85 ("nandmtd2_ReadChunkWithTagsFromNAND chunk %d data %p tags %p"
86 TENDSTR), nand_chunk, data, tags));
91 }else if(dev->param.inband_tags){
95 data = yaffs_get_temp_buffer(dev,__LINE__);
102 spareSize = sizeof(struct yaffs_packed_tags2);
105 retval = geometry->readChunk(dev,nand_chunk,
107 data ? dev->param.total_bytes_per_chunk : 0,
111 if(dev->param.inband_tags){
113 struct yaffs_packed_tags2_tags_only * pt2tp;
114 pt2tp = (struct yaffs_packed_tags2_tags_only *)&data[dev->data_bytes_per_chunk];
115 yaffs_unpack_tags2_tags_only(tags,pt2tp);
120 yaffs_unpack_tags2(tags, &pt,!dev->param.no_tags_ecc);
124 if(tags && tags->chunk_used){
126 tags->ecc_result == YAFFS_ECC_RESULT_UNFIXED)
127 tags->ecc_result = YAFFS_ECC_RESULT_UNFIXED;
128 else if(eccStatus > 0 ||
129 tags->ecc_result == YAFFS_ECC_RESULT_FIXED)
130 tags->ecc_result = YAFFS_ECC_RESULT_FIXED;
132 tags->ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
136 yaffs_release_temp_buffer(dev,data,__LINE__);
141 int ynandif_MarkNANDBlockBad(struct yaffs_dev *dev, int blockId)
143 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
145 return geometry->markBlockBad(dev,blockId);
148 int ynandif_EraseBlockInNAND(struct yaffs_dev *dev, int blockId)
150 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
152 return geometry->eraseBlock(dev,blockId);
157 static int ynandif_IsBlockOk(struct yaffs_dev *dev, int blockId)
159 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
161 return geometry->checkBlockOk(dev,blockId);
164 int ynandif_QueryNANDBlock(struct yaffs_dev *dev, int blockId, enum yaffs_block_state *state, u32 *seq_number)
167 struct yaffs_ext_tags tags;
171 chunkNo = blockId * dev->param.chunks_per_block;
173 if(!ynandif_IsBlockOk(dev,blockId)){
174 *state = YAFFS_BLOCK_STATE_DEAD;
178 ynandif_ReadChunkWithTagsFromNAND(dev,chunkNo,NULL,&tags);
182 *state = YAFFS_BLOCK_STATE_EMPTY;
186 *state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;
187 *seq_number = tags.seq_number;
195 int ynandif_InitialiseNAND(struct yaffs_dev *dev)
197 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
199 geometry->initialise(dev);
204 int ynandif_Deinitialise_flash_fn(struct yaffs_dev *dev)
206 ynandif_Geometry *geometry = (ynandif_Geometry *)(dev->driver_context);
208 geometry->deinitialise(dev);
215 yaffs_add_dev_from_geometry(const YCHAR *name,
216 const ynandif_Geometry *geometry)
218 YCHAR *clonedName = YMALLOC(sizeof(YCHAR) * (yaffs_strnlen(name,YAFFS_MAX_NAME_LENGTH)+1));
219 struct yaffs_dev *dev = YMALLOC(sizeof(struct yaffs_dev));
221 if(dev && clonedName){
222 memset(dev,0,sizeof(struct yaffs_dev));
223 yaffs_strcpy(clonedName,name);
225 dev->param.name = clonedName;
226 dev->param.write_chunk_tags_fn = ynandif_WriteChunkWithTagsToNAND;
227 dev->param.read_chunk_tags_fn = ynandif_ReadChunkWithTagsFromNAND;
228 dev->param.erase_fn = ynandif_EraseBlockInNAND;
229 dev->param.initialise_flash_fn = ynandif_InitialiseNAND;
230 dev->param.query_block_fn = ynandif_QueryNANDBlock;
231 dev->param.bad_block_fn = ynandif_MarkNANDBlockBad;
232 dev->param.n_caches = 20;
233 dev->param.start_block = geometry->start_block;
234 dev->param.end_block = geometry->end_block;
235 dev->param.total_bytes_per_chunk = geometry->dataSize;
236 dev->param.spare_bytes_per_chunk = geometry->spareSize;
237 dev->param.inband_tags = geometry->inband_tags;
238 dev->param.chunks_per_block = geometry->pagesPerBlock;
239 dev->param.use_nand_ecc = geometry->hasECC;
240 dev->param.is_yaffs2 = geometry->useYaffs2;
241 dev->param.n_reserved_blocks = 5;
242 dev->driver_context = (void *)geometry;
244 yaffs_add_device(dev);