2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2018 Aleph One Ltd.
6 * Created by Charles Manning <charles@aleph1.co.uk>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include "yaffs_checkptrw.h"
14 #include "yaffs_getblockinfo.h"
15 #include "yaffs_endian.h"
17 struct yaffs_checkpt_chunk_hdr {
25 static int apply_chunk_offset(struct yaffs_dev *dev, int chunk)
27 return chunk - dev->chunk_offset;
30 static int apply_block_offset(struct yaffs_dev *dev, int block)
32 return block - dev->block_offset;
36 static void yaffs2_do_endian_hdr(struct yaffs_dev *dev,
37 struct yaffs_checkpt_chunk_hdr *hdr)
39 if (!dev->swap_endian)
41 hdr->version = swap_s32(hdr->version);
42 hdr->seq = swap_s32(hdr->seq);
43 hdr->sum = swap_u32(hdr->sum);
44 hdr->xor = swap_u32(hdr->xor);
47 static void yaffs2_checkpt_init_chunk_hdr(struct yaffs_dev *dev)
49 struct yaffs_checkpt_chunk_hdr hdr;
51 hdr.version = YAFFS_CHECKPOINT_VERSION;
52 hdr.seq = dev->checkpt_page_seq;
53 hdr.sum = dev->checkpt_sum;
54 hdr.xor = dev->checkpt_xor;
56 dev->checkpt_byte_offs = sizeof(hdr);
58 yaffs2_do_endian_hdr(dev, &hdr);
59 memcpy(dev->checkpt_buffer, &hdr, sizeof(hdr));
62 static int yaffs2_checkpt_check_chunk_hdr(struct yaffs_dev *dev)
64 struct yaffs_checkpt_chunk_hdr hdr;
66 memcpy(&hdr, dev->checkpt_buffer, sizeof(hdr));
67 yaffs2_do_endian_hdr(dev, &hdr);
69 dev->checkpt_byte_offs = sizeof(hdr);
71 return hdr.version == YAFFS_CHECKPOINT_VERSION &&
72 hdr.seq == dev->checkpt_page_seq &&
73 hdr.sum == dev->checkpt_sum &&
74 hdr.xor == dev->checkpt_xor;
77 static int yaffs2_checkpt_space_ok(struct yaffs_dev *dev)
79 int blocks_avail = dev->n_erased_blocks - dev->param.n_reserved_blocks;
81 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
82 "checkpt blocks_avail = %d", blocks_avail);
84 return (blocks_avail <= 0) ? 0 : 1;
87 static int yaffs_checkpt_erase(struct yaffs_dev *dev)
91 if (!dev->drv.drv_erase_fn)
93 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
94 "checking blocks %d to %d",
95 dev->internal_start_block, dev->internal_end_block);
97 for (i = dev->internal_start_block; i <= dev->internal_end_block; i++) {
98 struct yaffs_block_info *bi = yaffs_get_block_info(dev, i);
99 int offset_i = apply_block_offset(dev, i);
102 if (bi->block_state == YAFFS_BLOCK_STATE_CHECKPOINT) {
103 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
104 "erasing checkpt block %d", i);
108 result = dev->drv.drv_erase_fn(dev, offset_i);
110 bi->block_state = YAFFS_BLOCK_STATE_EMPTY;
111 dev->n_erased_blocks++;
112 dev->n_free_chunks +=
113 dev->param.chunks_per_block;
115 dev->drv.drv_mark_bad_fn(dev, offset_i);
116 bi->block_state = YAFFS_BLOCK_STATE_DEAD;
121 dev->blocks_in_checkpt = 0;
126 static void yaffs2_checkpt_find_erased_block(struct yaffs_dev *dev)
129 int blocks_avail = dev->n_erased_blocks - dev->param.n_reserved_blocks;
131 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
132 "allocating checkpt block: erased %d reserved %d avail %d next %d ",
133 dev->n_erased_blocks, dev->param.n_reserved_blocks,
134 blocks_avail, dev->checkpt_next_block);
136 if (dev->checkpt_next_block >= 0 &&
137 dev->checkpt_next_block <= (int)dev->internal_end_block &&
140 for (i = dev->checkpt_next_block; i <= dev->internal_end_block;
142 struct yaffs_block_info *bi;
144 bi = yaffs_get_block_info(dev, i);
145 if (bi->block_state == YAFFS_BLOCK_STATE_EMPTY) {
146 dev->checkpt_next_block = i + 1;
147 dev->checkpt_cur_block = i;
148 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
149 "allocating checkpt block %d", i);
154 yaffs_trace(YAFFS_TRACE_CHECKPOINT, "out of checkpt blocks");
156 dev->checkpt_next_block = -1;
157 dev->checkpt_cur_block = -1;
160 static void yaffs2_checkpt_find_block(struct yaffs_dev *dev)
163 struct yaffs_ext_tags tags;
165 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
166 "find next checkpt block: start: blocks %d next %d",
167 dev->blocks_in_checkpt, dev->checkpt_next_block);
169 if (dev->blocks_in_checkpt < dev->checkpt_max_blocks)
170 for (i = dev->checkpt_next_block; i <= dev->internal_end_block;
172 int chunk = i * dev->param.chunks_per_block;
173 enum yaffs_block_state state;
176 dev->tagger.read_chunk_tags_fn(dev,
177 apply_chunk_offset(dev, chunk),
179 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
180 "find next checkpt block: search: block %d state %d oid %d seq %d eccr %d",
182 tags.obj_id, tags.seq_number,
185 if (tags.seq_number != YAFFS_SEQUENCE_CHECKPOINT_DATA)
188 dev->tagger.query_block_fn(dev,
189 apply_block_offset(dev, i),
191 if (state == YAFFS_BLOCK_STATE_DEAD)
194 /* Right kind of block */
195 dev->checkpt_next_block = tags.obj_id;
196 dev->checkpt_cur_block = i;
197 dev->checkpt_block_list[dev->blocks_in_checkpt] = i;
198 dev->blocks_in_checkpt++;
199 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
200 "found checkpt block %d", i);
204 yaffs_trace(YAFFS_TRACE_CHECKPOINT, "found no more checkpt blocks");
206 dev->checkpt_next_block = -1;
207 dev->checkpt_cur_block = -1;
210 int yaffs2_checkpt_open(struct yaffs_dev *dev, int writing)
214 dev->checkpt_open_write = writing;
216 /* Got the functions we need? */
217 if (!dev->tagger.write_chunk_tags_fn ||
218 !dev->tagger.read_chunk_tags_fn ||
219 !dev->drv.drv_erase_fn ||
220 !dev->drv.drv_mark_bad_fn)
223 if (writing && !yaffs2_checkpt_space_ok(dev))
226 if (!dev->checkpt_buffer)
227 dev->checkpt_buffer =
228 kmalloc(dev->param.total_bytes_per_chunk, GFP_NOFS);
229 if (!dev->checkpt_buffer)
232 dev->checkpt_page_seq = 0;
233 dev->checkpt_byte_count = 0;
234 dev->checkpt_sum = 0;
235 dev->checkpt_xor = 0;
236 dev->checkpt_cur_block = -1;
237 dev->checkpt_cur_chunk = -1;
238 dev->checkpt_next_block = dev->internal_start_block;
241 memset(dev->checkpt_buffer, 0, dev->data_bytes_per_chunk);
242 yaffs2_checkpt_init_chunk_hdr(dev);
243 return yaffs_checkpt_erase(dev);
246 /* Opening for a read */
247 /* Set to a value that will kick off a read */
248 dev->checkpt_byte_offs = dev->data_bytes_per_chunk;
249 /* A checkpoint block list of 1 checkpoint block per 16 block is
250 * (hopefully) going to be way more than we need */
251 dev->blocks_in_checkpt = 0;
252 dev->checkpt_max_blocks =
253 (dev->internal_end_block - dev->internal_start_block) / 16 + 2;
254 if (!dev->checkpt_block_list)
255 dev->checkpt_block_list =
256 kmalloc(sizeof(int) * dev->checkpt_max_blocks, GFP_NOFS);
258 if (!dev->checkpt_block_list)
261 for (i = 0; i < dev->checkpt_max_blocks; i++)
262 dev->checkpt_block_list[i] = -1;
267 int yaffs2_get_checkpt_sum(struct yaffs_dev *dev, u32 * sum)
271 composite_sum = (dev->checkpt_sum << 8) | (dev->checkpt_xor & 0xff);
272 *sum = composite_sum;
276 static int yaffs2_checkpt_flush_buffer(struct yaffs_dev *dev)
280 struct yaffs_ext_tags tags;
282 if (dev->checkpt_cur_block < 0) {
283 yaffs2_checkpt_find_erased_block(dev);
284 dev->checkpt_cur_chunk = 0;
287 if (dev->checkpt_cur_block < 0)
291 tags.obj_id = dev->checkpt_next_block; /* Hint to next place to look */
292 tags.chunk_id = dev->checkpt_page_seq + 1;
293 tags.seq_number = YAFFS_SEQUENCE_CHECKPOINT_DATA;
294 tags.n_bytes = dev->data_bytes_per_chunk;
295 if (dev->checkpt_cur_chunk == 0) {
296 /* First chunk we write for the block? Set block state to
298 struct yaffs_block_info *bi =
299 yaffs_get_block_info(dev, dev->checkpt_cur_block);
300 bi->block_state = YAFFS_BLOCK_STATE_CHECKPOINT;
301 dev->blocks_in_checkpt++;
305 dev->checkpt_cur_block * dev->param.chunks_per_block +
306 dev->checkpt_cur_chunk;
308 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
309 "checkpoint wite buffer nand %d(%d:%d) objid %d chId %d",
310 chunk, dev->checkpt_cur_block, dev->checkpt_cur_chunk,
311 tags.obj_id, tags.chunk_id);
313 offset_chunk = apply_chunk_offset(dev, chunk);
315 dev->n_page_writes++;
317 dev->tagger.write_chunk_tags_fn(dev, offset_chunk,
318 dev->checkpt_buffer, &tags);
319 dev->checkpt_page_seq++;
320 dev->checkpt_cur_chunk++;
321 if (dev->checkpt_cur_chunk >= (int)dev->param.chunks_per_block) {
322 dev->checkpt_cur_chunk = 0;
323 dev->checkpt_cur_block = -1;
325 memset(dev->checkpt_buffer, 0, dev->data_bytes_per_chunk);
327 yaffs2_checkpt_init_chunk_hdr(dev);
333 int yaffs2_checkpt_wr(struct yaffs_dev *dev, const void *data, int n_bytes)
337 u8 *data_bytes = (u8 *) data;
339 if (!dev->checkpt_buffer)
342 if (!dev->checkpt_open_write)
345 while (i < n_bytes && ok) {
346 dev->checkpt_buffer[dev->checkpt_byte_offs] = *data_bytes;
347 dev->checkpt_sum += *data_bytes;
348 dev->checkpt_xor ^= *data_bytes;
350 dev->checkpt_byte_offs++;
353 dev->checkpt_byte_count++;
355 if (dev->checkpt_byte_offs < 0 ||
356 dev->checkpt_byte_offs >= (int)dev->data_bytes_per_chunk)
357 ok = yaffs2_checkpt_flush_buffer(dev);
363 int yaffs2_checkpt_rd(struct yaffs_dev *dev, void *data, int n_bytes)
366 struct yaffs_ext_tags tags;
369 u8 *data_bytes = (u8 *) data;
371 if (!dev->checkpt_buffer)
374 if (dev->checkpt_open_write)
377 while (i < n_bytes) {
379 if (dev->checkpt_byte_offs < 0 ||
380 dev->checkpt_byte_offs >= (int)dev->data_bytes_per_chunk) {
382 if (dev->checkpt_cur_block < 0) {
383 yaffs2_checkpt_find_block(dev);
384 dev->checkpt_cur_chunk = 0;
387 /* Bail out if we can't find a checpoint block */
388 if (dev->checkpt_cur_block < 0)
391 chunk = dev->checkpt_cur_block *
392 dev->param.chunks_per_block +
393 dev->checkpt_cur_chunk;
395 offset_chunk = apply_chunk_offset(dev, chunk);
398 /* Read in the next chunk */
399 dev->tagger.read_chunk_tags_fn(dev,
404 /* Bail out if the chunk is corrupted. */
405 if (tags.chunk_id != (u32)(dev->checkpt_page_seq + 1) ||
406 tags.ecc_result > YAFFS_ECC_RESULT_FIXED ||
407 tags.seq_number != YAFFS_SEQUENCE_CHECKPOINT_DATA)
410 /* Bail out if it is not a checkpoint chunk. */
411 if(!yaffs2_checkpt_check_chunk_hdr(dev))
414 dev->checkpt_page_seq++;
415 dev->checkpt_cur_chunk++;
417 if (dev->checkpt_cur_chunk >=
418 (int)dev->param.chunks_per_block)
419 dev->checkpt_cur_block = -1;
423 *data_bytes = dev->checkpt_buffer[dev->checkpt_byte_offs];
424 dev->checkpt_sum += *data_bytes;
425 dev->checkpt_xor ^= *data_bytes;
426 dev->checkpt_byte_offs++;
429 dev->checkpt_byte_count++;
432 return i; /* Number of bytes read */
435 int yaffs_checkpt_close(struct yaffs_dev *dev)
439 if (dev->checkpt_open_write) {
440 if (dev->checkpt_byte_offs !=
441 sizeof(struct yaffs_checkpt_chunk_hdr))
442 yaffs2_checkpt_flush_buffer(dev);
443 } else if (dev->checkpt_block_list) {
445 i < dev->blocks_in_checkpt &&
446 dev->checkpt_block_list[i] >= 0; i++) {
447 int blk = dev->checkpt_block_list[i];
448 struct yaffs_block_info *bi = NULL;
450 if ((int)dev->internal_start_block <= blk &&
451 blk <= (int)dev->internal_end_block)
452 bi = yaffs_get_block_info(dev, blk);
453 if (bi && bi->block_state == YAFFS_BLOCK_STATE_EMPTY)
454 bi->block_state = YAFFS_BLOCK_STATE_CHECKPOINT;
458 dev->n_free_chunks -=
459 dev->blocks_in_checkpt * dev->param.chunks_per_block;
460 dev->n_erased_blocks -= dev->blocks_in_checkpt;
462 yaffs_trace(YAFFS_TRACE_CHECKPOINT, "checkpoint byte count %d",
463 dev->checkpt_byte_count);
465 if (dev->checkpt_buffer)
471 int yaffs2_checkpt_invalidate_stream(struct yaffs_dev *dev)
473 /* Erase the checkpoint data */
475 yaffs_trace(YAFFS_TRACE_CHECKPOINT,
476 "checkpoint invalidate of %d blocks",
477 dev->blocks_in_checkpt);
479 return yaffs_checkpt_erase(dev);