2 * YAFFS: Yet another FFS. A NAND-flash specific file system.
3 * yaffs_tagscompat.h: Tags compatability layer to use YAFFS1 formatted NAND.
5 * Copyright (C) 2002 Aleph One Ltd.
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.
13 * $Id: yaffs_tagscompat.c,v 1.3 2005-07-31 06:47:12 marty Exp $
16 #include "yaffs_guts.h"
17 #include "yaffs_tagscompat.h"
18 #include "yaffs_ecc.h"
20 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND);
22 static void yaffs_CheckWrittenBlock(yaffs_Device *dev,int chunkInNAND);
23 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare);
24 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_Spare *spare);
25 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND);
29 static const char yaffs_countBitsTable[256] =
31 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
32 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
33 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
34 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
35 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
36 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
37 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
38 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
39 1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
40 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
41 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
42 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
43 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
44 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
45 3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
46 4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8
49 static int yaffs_CountBits(__u8 x)
52 retVal = yaffs_countBitsTable[x];
57 /////////////// Tags ECC calculations ///////////////////
59 void yaffs_CalcECC(const __u8 *data, yaffs_Spare *spare)
61 yaffs_ECCCalculate(data , spare->ecc1);
62 yaffs_ECCCalculate(&data[256] , spare->ecc2);
65 void yaffs_CalcTagsECC(yaffs_Tags *tags)
69 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
76 for(i = 0; i < 8; i++)
78 for(j = 1; j &0xff; j<<=1)
93 int yaffs_CheckECCOnTags(yaffs_Tags *tags)
95 unsigned ecc = tags->ecc;
97 yaffs_CalcTagsECC(tags);
103 // TODO: Handle the failure better. Retire?
104 unsigned char *b = ((yaffs_TagsUnion *)tags)->asBytes;
108 b[ecc / 8] ^= (1 << (ecc & 7));
110 // Now recvalc the ecc
111 yaffs_CalcTagsECC(tags);
113 return 1; // recovered error
117 // Wierd ecc failure value
118 // TODO Need to do somethiong here
119 return -1; //unrecovered error
125 //////////////////////////// Tags ///////////////////////////////////////
127 static void yaffs_LoadTagsIntoSpare(yaffs_Spare *sparePtr, yaffs_Tags *tagsPtr)
129 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
131 yaffs_CalcTagsECC(tagsPtr);
133 sparePtr->tagByte0 = tu->asBytes[0];
134 sparePtr->tagByte1 = tu->asBytes[1];
135 sparePtr->tagByte2 = tu->asBytes[2];
136 sparePtr->tagByte3 = tu->asBytes[3];
137 sparePtr->tagByte4 = tu->asBytes[4];
138 sparePtr->tagByte5 = tu->asBytes[5];
139 sparePtr->tagByte6 = tu->asBytes[6];
140 sparePtr->tagByte7 = tu->asBytes[7];
143 static void yaffs_GetTagsFromSpare(yaffs_Device *dev, yaffs_Spare *sparePtr,yaffs_Tags *tagsPtr)
145 yaffs_TagsUnion *tu = (yaffs_TagsUnion *)tagsPtr;
148 tu->asBytes[0]= sparePtr->tagByte0;
149 tu->asBytes[1]= sparePtr->tagByte1;
150 tu->asBytes[2]= sparePtr->tagByte2;
151 tu->asBytes[3]= sparePtr->tagByte3;
152 tu->asBytes[4]= sparePtr->tagByte4;
153 tu->asBytes[5]= sparePtr->tagByte5;
154 tu->asBytes[6]= sparePtr->tagByte6;
155 tu->asBytes[7]= sparePtr->tagByte7;
157 result = yaffs_CheckECCOnTags(tagsPtr);
164 dev->tagsEccUnfixed++;
168 static void yaffs_SpareInitialise(yaffs_Spare *spare)
170 memset(spare,0xFF,sizeof(yaffs_Spare));
176 static int yaffs_WriteChunkToNAND(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare)
178 if(chunkInNAND < dev->startBlock * dev->nChunksPerBlock)
180 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d is not valid" TENDSTR),chunkInNAND));
185 return dev->writeChunkToNAND(dev,chunkInNAND,data,spare);
190 static int yaffs_ReadChunkFromNAND(struct yaffs_DeviceStruct *dev,
194 yaffs_ECCResult *eccResult,
195 int doErrorCorrection)
198 yaffs_Spare localSpare;
207 // If we don't have a real spare, then we use a local one.
208 // Need this for the calculation of the ecc
215 retVal = dev->readChunkFromNAND(dev,chunkInNAND,data,spare);
216 if(data && doErrorCorrection)
219 //Todo handle any errors
220 int eccResult1,eccResult2;
223 yaffs_ECCCalculate(data,calcEcc);
224 eccResult1 = yaffs_ECCCorrect (data,spare->ecc1, calcEcc);
225 yaffs_ECCCalculate(&data[256],calcEcc);
226 eccResult2 = yaffs_ECCCorrect(&data[256],spare->ecc2, calcEcc);
230 T(YAFFS_TRACE_ERROR, (TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
233 else if(eccResult1<0)
235 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
241 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
244 else if(eccResult2<0)
246 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
250 if(eccResult1 || eccResult2)
252 // Hoosterman, we had a data problem on this page
253 yaffs_HandleReadDataError(dev,chunkInNAND);
256 if(eccResult1 < 0 || eccResult2 < 0)
257 *eccResult = YAFFS_ECC_RESULT_UNFIXED;
258 else if(eccResult1 > 0 || eccResult2 > 0)
259 *eccResult = YAFFS_ECC_RESULT_FIXED;
261 *eccResult = YAFFS_ECC_RESULT_NO_ERROR;
266 // Must allocate enough memory for spare+2*sizeof(int) for ecc results from device.
267 struct yaffs_NANDSpare nspare;
268 retVal = dev->readChunkFromNAND(dev,chunkInNAND,data,(yaffs_Spare*)&nspare);
269 memcpy (spare, &nspare, sizeof(yaffs_Spare));
270 if(data && doErrorCorrection)
274 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:0" TENDSTR),chunkInNAND));
276 else if(nspare.eccres1<0)
278 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:0" TENDSTR),chunkInNAND));
283 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error fix performed on chunk %d:1" TENDSTR),chunkInNAND));
285 else if(nspare.eccres2<0)
287 T(YAFFS_TRACE_ERROR,(TSTR("**>>ecc error unfixed on chunk %d:1" TENDSTR),chunkInNAND));
290 if(nspare.eccres1 || nspare.eccres2)
292 // Hoosterman, we had a data problem on this page
293 yaffs_HandleReadDataError(dev,chunkInNAND);
296 if(nspare.eccres1 < 0 || nspare.eccres2 < 0)
297 *eccResult = YAFFS_ECC_RESULT_UNFIXED;
298 else if(nspare.eccres1 > 0 || nspare.eccres2 > 0)
299 *eccResult = YAFFS_ECC_RESULT_FIXED;
301 *eccResult = YAFFS_ECC_RESULT_NO_ERROR;
310 static int yaffs_CheckChunkErased(struct yaffs_DeviceStruct *dev,int chunkInNAND)
314 static __u8 cmpbuf[YAFFS_BYTES_PER_CHUNK];
315 static __u8 data[YAFFS_BYTES_PER_CHUNK];
316 // Might as well always allocate the larger size for dev->useNANDECC == true;
317 static __u8 spare[sizeof(struct yaffs_NANDSpare)];
319 dev->readChunkFromNAND(dev,chunkInNAND,data,(yaffs_Spare *)spare);
323 memset(cmpbuf,0xff,YAFFS_BYTES_PER_CHUNK);
327 if(memcmp(cmpbuf,data,YAFFS_BYTES_PER_CHUNK)) return YAFFS_FAIL;
328 if(memcmp(cmpbuf,spare,16)) return YAFFS_FAIL;
337 int yaffs_EraseBlockInNAND(struct yaffs_DeviceStruct *dev,int blockInNAND)
339 dev->nBlockErasures++;
340 return dev->eraseBlockInNAND(dev,blockInNAND);
343 int yaffs_InitialiseNAND(struct yaffs_DeviceStruct *dev)
345 return dev->initialiseNAND(dev);
351 static int yaffs_WriteNewChunkToNAND(struct yaffs_DeviceStruct *dev, const __u8 *data, yaffs_Spare *spare,int useReserve)
358 unsigned char rbData[YAFFS_BYTES_PER_CHUNK];
362 chunk = yaffs_AllocateChunk(dev,useReserve);
367 // First check this chunk is erased...
368 #ifndef CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
369 writeOk = yaffs_CheckChunkErased(dev,chunk);
373 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs chunk %d was not erased" TENDSTR),chunk));
377 writeOk = yaffs_WriteChunkToNAND(dev,chunk,data,spare);
383 // If verify fails, then delete this chunk and try again
384 // To verify we compare everything except the block and
385 // page status bytes.
386 // NB We check a raw read without ECC correction applied
387 yaffs_ReadChunkFromNAND(dev,chunk,rbData,&rbSpare,0);
389 #ifndef CONFIG_YAFFS_DISABLE_WRITE_VERIFY
390 if(!yaffs_VerifyCompare(data,rbData,spare,&rbSpare))
393 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write verify failed on chunk %d" TENDSTR), chunk));
402 // Copy the data into the write buffer.
403 // NB We do this at the end to prevent duplicates in the case of a write error.
405 yaffs_HandleWriteChunkOk(dev,chunk,data,spare);
409 yaffs_HandleWriteChunkError(dev,chunk);
413 } while(chunk >= 0 && ! writeOk);
417 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs write required %d attempts" TENDSTR),attempts));
418 dev->nRetriedWrites+= (attempts - 1);
427 // Functions for robustisizing
432 static void yaffs_RetireBlock(yaffs_Device *dev,int blockInNAND)
434 // Ding the blockStatus in the first two pages of the block.
438 memset(&spare, 0xff,sizeof(yaffs_Spare));
440 spare.blockStatus = 0;
442 // TODO change this retirement marking for other NAND types
443 yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock, NULL , &spare);
444 yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock + 1, NULL , &spare);
446 yaffs_GetBlockInfo(dev,blockInNAND)->blockState = YAFFS_BLOCK_STATE_DEAD;
447 dev->nRetiredBlocks++;
453 static int yaffs_RewriteBufferedBlock(yaffs_Device *dev)
455 dev->doingBufferedBlockRewrite = 1;
457 // Remove erased chunks
458 // Rewrite existing chunks to a new block
459 // Set current write block to the new block
461 dev->doingBufferedBlockRewrite = 0;
468 static void yaffs_HandleReadDataError(yaffs_Device *dev,int chunkInNAND)
470 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
472 // Mark the block for retirement
473 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
474 T(YAFFS_TRACE_ERROR | YAFFS_TRACE_BAD_BLOCKS,(TSTR("**>>Block %d marked for retirement" TENDSTR),blockInNAND));
478 // Just do a garbage collection on the affected block then retire the block
484 static void yaffs_CheckWrittenBlock(yaffs_Device *dev,int chunkInNAND)
488 static void yaffs_HandleWriteChunkOk(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_Spare *spare)
492 static void yaffs_HandleUpdateChunk(yaffs_Device *dev,int chunkInNAND, const yaffs_Spare *spare)
496 static void yaffs_HandleWriteChunkError(yaffs_Device *dev,int chunkInNAND)
498 int blockInNAND = chunkInNAND/dev->nChunksPerBlock;
500 // Mark the block for retirement
501 yaffs_GetBlockInfo(dev,blockInNAND)->needsRetiring = 1;
503 yaffs_DeleteChunk(dev,chunkInNAND,1,__LINE__);
509 static int yaffs_VerifyCompare(const __u8 *d0, const __u8 * d1, const yaffs_Spare *s0, const yaffs_Spare *s1)
513 if( memcmp(d0,d1,YAFFS_BYTES_PER_CHUNK) != 0 ||
514 s0->tagByte0 != s1->tagByte0 ||
515 s0->tagByte1 != s1->tagByte1 ||
516 s0->tagByte2 != s1->tagByte2 ||
517 s0->tagByte3 != s1->tagByte3 ||
518 s0->tagByte4 != s1->tagByte4 ||
519 s0->tagByte5 != s1->tagByte5 ||
520 s0->tagByte6 != s1->tagByte6 ||
521 s0->tagByte7 != s1->tagByte7 ||
522 s0->ecc1[0] != s1->ecc1[0] ||
523 s0->ecc1[1] != s1->ecc1[1] ||
524 s0->ecc1[2] != s1->ecc1[2] ||
525 s0->ecc2[0] != s1->ecc2[0] ||
526 s0->ecc2[1] != s1->ecc2[1] ||
527 s0->ecc2[2] != s1->ecc2[2] )
540 unsigned validMarker0;
541 unsigned chunkUsed; // Status of the chunk: used or unused
542 unsigned objectId; // If 0 then this is not part of an object (unused)
543 unsigned chunkId; // If 0 then this is a header
544 unsigned byteCount; // Only valid for data chunks
545 // The following stuff only has meaning when we read
546 yaffs_ECCResult eccResult; // Only valid when we read.
547 unsigned blockBad; // Only valid on reading
550 unsigned chunkDeleted; // The chunk is marked deleted
551 unsigned serialNumber; // Yaffs1 2-bit serial number
554 unsigned sequenceNumber; // The sequence number of this block
556 unsigned validMarker1;
558 } yaffs_ExtendedTags;
564 unsigned serialNumber:2;
565 unsigned byteCount:10;
566 unsigned objectId:18;
568 unsigned unusedStuff:2;
574 int yaffs_TagsCompatabilityWriteChunkWithTagsToNAND(yaffs_Device *dev,int chunkInNAND,const __u8 *data, const yaffs_ExtendedTags *eTags)
579 yaffs_SpareInitialise(&spare);
581 if(eTags->chunkDeleted)
583 spare.pageStatus = 0;
587 tags.objectId = eTags->objectId;
588 tags.chunkId = eTags->chunkId;
589 tags.byteCount = eTags->byteCount;
590 tags.serialNumber = eTags->serialNumber;
593 if (!dev->useNANDECC && data)
595 yaffs_CalcECC(data,&spare);
599 yaffs_LoadTagsIntoSpare(&spare,&tags);
603 return yaffs_WriteChunkToNAND(dev,chunkInNAND,data,&spare);
607 int yaffs_TagsCompatabilityReadChunkWithTagsFromNAND(yaffs_Device *dev,int chunkInNAND, __u8 *data, yaffs_ExtendedTags *eTags)
612 yaffs_ECCResult eccResult;
615 static yaffs_Spare spareFF;
620 memset(&spareFF,0xFF,sizeof(spareFF));
624 if(yaffs_ReadChunkFromNAND(dev,chunkInNAND,data,&spare,&eccResult,1))
626 // added NCB - eTags may be NULL
629 int deleted = (yaffs_CountBits(spare.pageStatus) < 7) ? 1 : 0;
631 yaffs_GetTagsFromSpare(dev,&spare,&tags);
633 eTags->chunkDeleted = deleted;
634 eTags->objectId = tags.objectId;
635 eTags->chunkId = tags.chunkId;
636 eTags->byteCount = tags.byteCount;
637 eTags->serialNumber = tags.serialNumber;
638 eTags->eccResult = eccResult;
639 eTags->blockBad = 0; // We're reading it therefore it is not a bad block
641 // NCB added 18/2/2005
642 eTags->chunkUsed = (memcmp(&spareFF,&spare,sizeof(spareFF)) != 0) ? 1:0;
653 int yaffs_TagsCompatabilityMarkNANDBlockBad(struct yaffs_DeviceStruct *dev, int blockInNAND)
658 memset(&spare, 0xff,sizeof(yaffs_Spare));
660 spare.blockStatus = 0;
662 yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock, NULL , &spare);
663 yaffs_WriteChunkToNAND(dev, blockInNAND * dev->nChunksPerBlock + 1, NULL , &spare);
670 int yaffs_TagsCompatabilityQueryNANDBlock(struct yaffs_DeviceStruct *dev, int blockNo, yaffs_BlockState *state, int *sequenceNumber)
673 yaffs_Spare spare0,spare1;
674 static yaffs_Spare spareFF;
676 yaffs_ECCResult dummy;
680 memset(&spareFF,0xFF,sizeof(spareFF));
686 yaffs_ReadChunkFromNAND(dev,blockNo * dev->nChunksPerBlock,NULL,&spare0,&dummy,1);
687 yaffs_ReadChunkFromNAND(dev,blockNo * dev->nChunksPerBlock + 1,NULL,&spare1,&dummy,1);
689 if(yaffs_CountBits(spare0.blockStatus & spare1.blockStatus) < 7)
690 *state = YAFFS_BLOCK_STATE_DEAD;
691 else if(memcmp(&spareFF,&spare0,sizeof(spareFF)) == 0)
692 *state = YAFFS_BLOCK_STATE_EMPTY;
694 *state = YAFFS_BLOCK_STATE_NEEDS_SCANNING;