2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2007 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.
14 const char *yaffs_checkptrw_c_version =
15 "$Id: yaffs_checkptrw.c,v 1.21 2009-10-29 03:05:55 charles Exp $";
18 #include "yaffs_checkptrw.h"
19 #include "yaffs_getblockinfo.h"
21 static int yaffs_CheckpointSpaceOk(yaffs_Device *dev)
23 int blocksAvailable = dev->nErasedBlocks - dev->nReservedBlocks;
25 T(YAFFS_TRACE_CHECKPOINT,
26 (TSTR("checkpt blocks available = %d" TENDSTR),
29 return (blocksAvailable <= 0) ? 0 : 1;
33 static int yaffs_CheckpointErase(yaffs_Device *dev)
37 if (!dev->eraseBlockInNAND)
39 T(YAFFS_TRACE_CHECKPOINT, (TSTR("checking blocks %d to %d"TENDSTR),
40 dev->internalStartBlock, dev->internalEndBlock));
42 for (i = dev->internalStartBlock; i <= dev->internalEndBlock; i++) {
43 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
44 if (bi->blockState == YAFFS_BLOCK_STATE_CHECKPOINT) {
45 T(YAFFS_TRACE_CHECKPOINT, (TSTR("erasing checkpt block %d"TENDSTR), i));
47 dev->nBlockErasures++;
49 if (dev->eraseBlockInNAND(dev, i - dev->blockOffset /* realign */)) {
50 bi->blockState = YAFFS_BLOCK_STATE_EMPTY;
52 dev->nFreeChunks += dev->nChunksPerBlock;
54 dev->markNANDBlockBad(dev, i);
55 bi->blockState = YAFFS_BLOCK_STATE_DEAD;
60 dev->blocksInCheckpoint = 0;
66 static void yaffs_CheckpointFindNextErasedBlock(yaffs_Device *dev)
69 int blocksAvailable = dev->nErasedBlocks - dev->nReservedBlocks;
70 T(YAFFS_TRACE_CHECKPOINT,
71 (TSTR("allocating checkpt block: erased %d reserved %d avail %d next %d "TENDSTR),
72 dev->nErasedBlocks, dev->nReservedBlocks, blocksAvailable, dev->checkpointNextBlock));
74 if (dev->checkpointNextBlock >= 0 &&
75 dev->checkpointNextBlock <= dev->internalEndBlock &&
76 blocksAvailable > 0) {
78 for (i = dev->checkpointNextBlock; i <= dev->internalEndBlock; i++) {
79 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, i);
80 if (bi->blockState == YAFFS_BLOCK_STATE_EMPTY) {
81 dev->checkpointNextBlock = i + 1;
82 dev->checkpointCurrentBlock = i;
83 T(YAFFS_TRACE_CHECKPOINT, (TSTR("allocating checkpt block %d"TENDSTR), i));
88 T(YAFFS_TRACE_CHECKPOINT, (TSTR("out of checkpt blocks"TENDSTR)));
90 dev->checkpointNextBlock = -1;
91 dev->checkpointCurrentBlock = -1;
94 static void yaffs_CheckpointFindNextCheckpointBlock(yaffs_Device *dev)
97 yaffs_ExtendedTags tags;
99 T(YAFFS_TRACE_CHECKPOINT, (TSTR("find next checkpt block: start: blocks %d next %d" TENDSTR),
100 dev->blocksInCheckpoint, dev->checkpointNextBlock));
102 if (dev->blocksInCheckpoint < dev->checkpointMaxBlocks)
103 for (i = dev->checkpointNextBlock; i <= dev->internalEndBlock; i++) {
104 int chunk = i * dev->nChunksPerBlock;
105 int realignedChunk = chunk - dev->chunkOffset;
107 dev->readChunkWithTagsFromNAND(dev, realignedChunk,
109 T(YAFFS_TRACE_CHECKPOINT, (TSTR("find next checkpt block: search: block %d oid %d seq %d eccr %d" TENDSTR),
110 i, tags.objectId, tags.sequenceNumber, tags.eccResult));
112 if (tags.sequenceNumber == YAFFS_SEQUENCE_CHECKPOINT_DATA) {
113 /* Right kind of block */
114 dev->checkpointNextBlock = tags.objectId;
115 dev->checkpointCurrentBlock = i;
116 dev->checkpointBlockList[dev->blocksInCheckpoint] = i;
117 dev->blocksInCheckpoint++;
118 T(YAFFS_TRACE_CHECKPOINT, (TSTR("found checkpt block %d"TENDSTR), i));
123 T(YAFFS_TRACE_CHECKPOINT, (TSTR("found no more checkpt blocks"TENDSTR)));
125 dev->checkpointNextBlock = -1;
126 dev->checkpointCurrentBlock = -1;
130 int yaffs_CheckpointOpen(yaffs_Device *dev, int forWriting)
134 dev->checkpointOpenForWrite = forWriting;
136 /* Got the functions we need? */
137 if (!dev->writeChunkWithTagsToNAND ||
138 !dev->readChunkWithTagsFromNAND ||
139 !dev->eraseBlockInNAND ||
140 !dev->markNANDBlockBad)
143 if (forWriting && !yaffs_CheckpointSpaceOk(dev))
146 if (!dev->checkpointBuffer)
147 dev->checkpointBuffer = YMALLOC_DMA(dev->totalBytesPerChunk);
148 if (!dev->checkpointBuffer)
152 dev->checkpointPageSequence = 0;
153 dev->checkpointByteCount = 0;
154 dev->checkpointSum = 0;
155 dev->checkpointXor = 0;
156 dev->checkpointCurrentBlock = -1;
157 dev->checkpointCurrentChunk = -1;
158 dev->checkpointNextBlock = dev->internalStartBlock;
160 /* Erase all the blocks in the checkpoint area */
162 memset(dev->checkpointBuffer, 0, dev->nDataBytesPerChunk);
163 dev->checkpointByteOffset = 0;
164 return yaffs_CheckpointErase(dev);
167 /* Set to a value that will kick off a read */
168 dev->checkpointByteOffset = dev->nDataBytesPerChunk;
169 /* A checkpoint block list of 1 checkpoint block per 16 block is (hopefully)
170 * going to be way more than we need */
171 dev->blocksInCheckpoint = 0;
172 dev->checkpointMaxBlocks = (dev->internalEndBlock - dev->internalStartBlock)/16 + 2;
173 dev->checkpointBlockList = YMALLOC(sizeof(int) * dev->checkpointMaxBlocks);
174 if(!dev->checkpointBlockList)
177 for (i = 0; i < dev->checkpointMaxBlocks; i++)
178 dev->checkpointBlockList[i] = -1;
184 int yaffs_GetCheckpointSum(yaffs_Device *dev, __u32 *sum)
187 compositeSum = (dev->checkpointSum << 8) | (dev->checkpointXor & 0xFF);
192 static int yaffs_CheckpointFlushBuffer(yaffs_Device *dev)
197 yaffs_ExtendedTags tags;
199 if (dev->checkpointCurrentBlock < 0) {
200 yaffs_CheckpointFindNextErasedBlock(dev);
201 dev->checkpointCurrentChunk = 0;
204 if (dev->checkpointCurrentBlock < 0)
207 tags.chunkDeleted = 0;
208 tags.objectId = dev->checkpointNextBlock; /* Hint to next place to look */
209 tags.chunkId = dev->checkpointPageSequence + 1;
210 tags.sequenceNumber = YAFFS_SEQUENCE_CHECKPOINT_DATA;
211 tags.byteCount = dev->nDataBytesPerChunk;
212 if (dev->checkpointCurrentChunk == 0) {
213 /* First chunk we write for the block? Set block state to
215 yaffs_BlockInfo *bi = yaffs_GetBlockInfo(dev, dev->checkpointCurrentBlock);
216 bi->blockState = YAFFS_BLOCK_STATE_CHECKPOINT;
217 dev->blocksInCheckpoint++;
220 chunk = dev->checkpointCurrentBlock * dev->nChunksPerBlock + dev->checkpointCurrentChunk;
223 T(YAFFS_TRACE_CHECKPOINT, (TSTR("checkpoint wite buffer nand %d(%d:%d) objid %d chId %d" TENDSTR),
224 chunk, dev->checkpointCurrentBlock, dev->checkpointCurrentChunk, tags.objectId, tags.chunkId));
226 realignedChunk = chunk - dev->chunkOffset;
230 dev->writeChunkWithTagsToNAND(dev, realignedChunk,
231 dev->checkpointBuffer, &tags);
232 dev->checkpointByteOffset = 0;
233 dev->checkpointPageSequence++;
234 dev->checkpointCurrentChunk++;
235 if (dev->checkpointCurrentChunk >= dev->nChunksPerBlock) {
236 dev->checkpointCurrentChunk = 0;
237 dev->checkpointCurrentBlock = -1;
239 memset(dev->checkpointBuffer, 0, dev->nDataBytesPerChunk);
245 int yaffs_CheckpointWrite(yaffs_Device *dev, const void *data, int nBytes)
251 __u8 * dataBytes = (__u8 *)data;
255 if (!dev->checkpointBuffer)
258 if (!dev->checkpointOpenForWrite)
261 while (i < nBytes && ok) {
262 dev->checkpointBuffer[dev->checkpointByteOffset] = *dataBytes;
263 dev->checkpointSum += *dataBytes;
264 dev->checkpointXor ^= *dataBytes;
266 dev->checkpointByteOffset++;
269 dev->checkpointByteCount++;
272 if (dev->checkpointByteOffset < 0 ||
273 dev->checkpointByteOffset >= dev->nDataBytesPerChunk)
274 ok = yaffs_CheckpointFlushBuffer(dev);
280 int yaffs_CheckpointRead(yaffs_Device *dev, void *data, int nBytes)
284 yaffs_ExtendedTags tags;
290 __u8 *dataBytes = (__u8 *)data;
292 if (!dev->checkpointBuffer)
295 if (dev->checkpointOpenForWrite)
298 while (i < nBytes && ok) {
301 if (dev->checkpointByteOffset < 0 ||
302 dev->checkpointByteOffset >= dev->nDataBytesPerChunk) {
304 if (dev->checkpointCurrentBlock < 0) {
305 yaffs_CheckpointFindNextCheckpointBlock(dev);
306 dev->checkpointCurrentChunk = 0;
309 if (dev->checkpointCurrentBlock < 0)
312 chunk = dev->checkpointCurrentBlock *
313 dev->nChunksPerBlock +
314 dev->checkpointCurrentChunk;
316 realignedChunk = chunk - dev->chunkOffset;
320 /* read in the next chunk */
321 /* printf("read checkpoint page %d\n",dev->checkpointPage); */
322 dev->readChunkWithTagsFromNAND(dev,
324 dev->checkpointBuffer,
327 if (tags.chunkId != (dev->checkpointPageSequence + 1) ||
328 tags.eccResult > YAFFS_ECC_RESULT_FIXED ||
329 tags.sequenceNumber != YAFFS_SEQUENCE_CHECKPOINT_DATA)
332 dev->checkpointByteOffset = 0;
333 dev->checkpointPageSequence++;
334 dev->checkpointCurrentChunk++;
336 if (dev->checkpointCurrentChunk >= dev->nChunksPerBlock)
337 dev->checkpointCurrentBlock = -1;
342 *dataBytes = dev->checkpointBuffer[dev->checkpointByteOffset];
343 dev->checkpointSum += *dataBytes;
344 dev->checkpointXor ^= *dataBytes;
345 dev->checkpointByteOffset++;
348 dev->checkpointByteCount++;
355 int yaffs_CheckpointClose(yaffs_Device *dev)
358 if (dev->checkpointOpenForWrite) {
359 if (dev->checkpointByteOffset != 0)
360 yaffs_CheckpointFlushBuffer(dev);
361 } else if(dev->checkpointBlockList){
363 for (i = 0; i < dev->blocksInCheckpoint && dev->checkpointBlockList[i] >= 0; i++) {
364 int blk = dev->checkpointBlockList[i];
365 yaffs_BlockInfo *bi = NULL;
366 if( dev->internalStartBlock <= blk && blk <= dev->internalEndBlock)
367 bi = yaffs_GetBlockInfo(dev, blk);
368 if (bi && bi->blockState == YAFFS_BLOCK_STATE_EMPTY)
369 bi->blockState = YAFFS_BLOCK_STATE_CHECKPOINT;
371 /* Todo this looks odd... */
374 YFREE(dev->checkpointBlockList);
375 dev->checkpointBlockList = NULL;
378 dev->nFreeChunks -= dev->blocksInCheckpoint * dev->nChunksPerBlock;
379 dev->nErasedBlocks -= dev->blocksInCheckpoint;
382 T(YAFFS_TRACE_CHECKPOINT, (TSTR("checkpoint byte count %d" TENDSTR),
383 dev->checkpointByteCount));
385 if (dev->checkpointBuffer) {
386 /* free the buffer */
387 YFREE(dev->checkpointBuffer);
388 dev->checkpointBuffer = NULL;
394 int yaffs_CheckpointInvalidateStream(yaffs_Device *dev)
396 /* Erase the checkpoint data */
398 T(YAFFS_TRACE_CHECKPOINT, (TSTR("checkpoint invalidate"TENDSTR)));
400 return yaffs_CheckpointErase(dev);