2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
4 * Copyright (C) 2002-2011 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 Lesser General Public License version 2.1 as
11 * published by the Free Software Foundation.
13 * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
16 #ifndef __YAFFS_GUTS_H__
17 #define __YAFFS_GUTS_H__
28 * And what have we got...
30 #define YAFFS_MAGIC 0x5941ff53
33 * Tnodes form a tree with the tnodes in "levels"
34 * Levels greater than 0 hold 8 slots which point to other tnodes.
35 * Those at level 0 hold 16 slots which point to chunks in NAND.
37 * A maximum level of 8 thust supports files of size up to:
41 * Thus a max level of 8 supports files with up to 2^^28 chunks which gives
42 * a maximum file size of around 512Gbytees with 2k chunks.
44 #define YAFFS_NTNODES_LEVEL0 16
45 #define YAFFS_TNODES_LEVEL0_BITS 4
46 #define YAFFS_TNODES_LEVEL0_MASK 0xf
48 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
49 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
50 #define YAFFS_TNODES_INTERNAL_MASK 0x7
51 #define YAFFS_TNODES_MAX_LEVEL 8
52 #define YAFFS_TNODES_MAX_BITS (YAFFS_TNODES_LEVEL0_BITS + \
53 YAFFS_TNODES_INTERNAL_BITS * \
54 YAFFS_TNODES_MAX_LEVEL)
55 #define YAFFS_MAX_CHUNK_ID ((1 << YAFFS_TNODES_MAX_BITS) - 1)
57 #define YAFFS_MAX_FILE_SIZE_32 0x7fffffff
59 /* Constants for YAFFS1 mode */
60 #define YAFFS_BYTES_PER_SPARE 16
61 #define YAFFS_BYTES_PER_CHUNK 512
62 #define YAFFS_CHUNK_SIZE_SHIFT 9
63 #define YAFFS_CHUNKS_PER_BLOCK 32
64 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
66 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
67 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
71 #define YAFFS_ALLOCATION_NOBJECTS 100
72 #define YAFFS_ALLOCATION_NTNODES 100
73 #define YAFFS_ALLOCATION_NLINKS 100
75 #define YAFFS_NOBJECT_BUCKETS 256
77 #define YAFFS_OBJECT_SPACE 0x40000
78 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1)
80 /* Binary data version stamps */
81 #define YAFFS_SUMMARY_VERSION 1
83 #ifdef CONFIG_YAFFS_UNICODE
84 #define YAFFS_MAX_NAME_LENGTH 127
85 #define YAFFS_MAX_ALIAS_LENGTH 79
87 #define YAFFS_MAX_NAME_LENGTH 255
88 #define YAFFS_MAX_ALIAS_LENGTH 159
91 #define YAFFS_SHORT_NAME_LENGTH 15
93 /* Some special object ids for pseudo objects */
94 #define YAFFS_OBJECTID_ROOT 1
95 #define YAFFS_OBJECTID_LOSTNFOUND 2
96 #define YAFFS_OBJECTID_UNLINKED 3
97 #define YAFFS_OBJECTID_DELETED 4
99 /* Fake object Id for summary data */
100 #define YAFFS_OBJECTID_SUMMARY 0x10
102 /* Pseudo object ids for checkpointing */
103 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
104 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
106 #define YAFFS_MAX_SHORT_OP_CACHES 20
108 #define YAFFS_N_TEMP_BUFFERS 6
110 /* We limit the number attempts at sucessfully saving a chunk of data.
111 * Small-page devices have 32 pages per block; large-page devices have 64.
112 * Default to something in the order of 5 to 10 blocks worth of chunks.
114 #define YAFFS_WR_ATTEMPTS (5*64)
116 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
117 * The range is limited slightly to help distinguish bad numbers from good.
118 * This also allows us to perhaps in the future use special numbers for
120 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
121 * and is a larger number than the lifetime of a 2GB device.
123 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
124 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
126 /* Special sequence number for bad block that failed to be marked bad */
127 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
129 /* ChunkCache is used for short read/write operations.*/
131 struct yaffs_obj *object;
135 int n_bytes; /* Only valid if the cache is dirty */
136 int locked; /* Can't push out or flush while locked. */
140 /* yaffs1 tags structures in RAM
141 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
142 * otherwise the structure size will get blown out.
154 union yaffs_tags_union {
155 struct yaffs_tags as_tags;
160 /* Stuff used for extended tags in YAFFS2 */
162 enum yaffs_ecc_result {
163 YAFFS_ECC_RESULT_UNKNOWN,
164 YAFFS_ECC_RESULT_NO_ERROR,
165 YAFFS_ECC_RESULT_FIXED,
166 YAFFS_ECC_RESULT_UNFIXED
171 * When this is stored in flash we store it as a u32 instead
172 * to prevent any alignment change issues as compiler variants change.
175 enum yaffs_obj_type {
176 YAFFS_OBJECT_TYPE_UNKNOWN,
177 YAFFS_OBJECT_TYPE_FILE,
178 YAFFS_OBJECT_TYPE_SYMLINK,
179 YAFFS_OBJECT_TYPE_DIRECTORY,
180 YAFFS_OBJECT_TYPE_HARDLINK,
181 YAFFS_OBJECT_TYPE_SPECIAL
184 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
186 struct yaffs_ext_tags {
187 unsigned chunk_used; /* Status of the chunk: used or unused */
188 unsigned obj_id; /* If 0 this is not used */
189 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
190 unsigned n_bytes; /* Only valid for data chunks */
192 /* The following stuff only has meaning when we read */
193 enum yaffs_ecc_result ecc_result;
197 unsigned is_deleted; /* The chunk is marked deleted */
198 unsigned serial_number; /* Yaffs1 2-bit serial number */
201 unsigned seq_number; /* The sequence number of this block */
203 /* Extra info if this is an object header (YAFFS2 only) */
205 unsigned extra_available; /* Extra info available if not zero */
206 unsigned extra_parent_id; /* The parent object */
207 unsigned extra_is_shrink; /* Is it a shrink header? */
208 unsigned extra_shadows; /* Does this shadow another object? */
210 enum yaffs_obj_type extra_obj_type; /* What object type? */
212 loff_t extra_file_size; /* Length if it is a file */
213 unsigned extra_equiv_id; /* Equivalent object for a hard link */
216 /* Spare structure for YAFFS1 */
222 u8 page_status; /* set to 0 to delete the chunk */
232 /*Special structure for passing through to mtd */
233 struct yaffs_nand_spare {
234 struct yaffs_spare spare;
239 /* Block data in RAM */
241 enum yaffs_block_state {
242 YAFFS_BLOCK_STATE_UNKNOWN = 0,
244 YAFFS_BLOCK_STATE_SCANNING,
247 YAFFS_BLOCK_STATE_NEEDS_SCAN,
248 /* The block might have something on it (ie it is allocating or full,
249 * perhaps empty) but it needs to be scanned to determine its true
251 * This state is only valid during scanning.
252 * NB We tolerate empty because the pre-scanner might be incapable of
254 * However, if this state is returned on a YAFFS2 device,
255 * then we expect a sequence number
258 YAFFS_BLOCK_STATE_EMPTY,
259 /* This block is empty */
261 YAFFS_BLOCK_STATE_ALLOCATING,
262 /* This block is partially allocated.
263 * At least one page holds valid data.
264 * This is the one currently being used for page
265 * allocation. Should never be more than one of these.
266 * If a block is only partially allocated at mount it is treated as
270 YAFFS_BLOCK_STATE_FULL,
271 /* All the pages in this block have been allocated.
272 * If a block was only partially allocated when mounted we treat
273 * it as fully allocated.
276 YAFFS_BLOCK_STATE_DIRTY,
277 /* The block was full and now all chunks have been deleted.
278 * Erase me, reuse me.
281 YAFFS_BLOCK_STATE_CHECKPOINT,
282 /* This block is assigned to holding checkpoint data. */
284 YAFFS_BLOCK_STATE_COLLECTING,
285 /* This block is being garbage collected */
287 YAFFS_BLOCK_STATE_DEAD
288 /* This block has failed and is not in use */
291 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
293 struct yaffs_block_info {
295 s32 soft_del_pages:10; /* number of soft deleted pages */
296 s32 pages_in_use:10; /* number of pages in use */
297 u32 block_state:4; /* One of the above block states. */
298 /* NB use unsigned because enum is sometimes
300 u32 needs_retiring:1; /* Data has failed on this block, */
301 /*need to get valid data off and retire*/
302 u32 skip_erased_check:1;/* Skip the erased check on this block */
303 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
304 Block should be prioritised for GC */
305 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
306 failures on this block and tried to reuse it */
307 u32 has_summary:1; /* The block has a summary */
309 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
310 u32 seq_number; /* block sequence number for yaffs2 */
314 /* -------------------------- Object structure -------------------------------*/
315 /* This is the object structure as stored on NAND */
317 struct yaffs_obj_hdr {
318 u32 type; /* enum yaffs_obj_type */
320 /* Apply to everything */
322 u16 sum_no_longer_used; /* checksum of name. No longer used */
323 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
325 /* The following apply to all object types except for hard links */
326 u32 yst_mode; /* protection */
334 /* File size applies to files only */
337 /* Equivalent object id applies to hard links only. */
340 /* Alias is for symlinks only. */
341 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
343 u32 yst_rdev; /* stuff for block and char devices (major/min) */
349 u32 inband_shadowed_obj_id;
350 u32 inband_is_shrink;
354 int shadows_obj; /* This object header shadows the
355 specified object if > 0 */
357 /* is_shrink applies to object headers written when wemake a hole. */
362 /*--------------------------- Tnode -------------------------- */
365 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
368 /*------------------------ Object -----------------------------*/
369 /* An object can be one of:
370 * - a directory (no data, has children links
371 * - a regular file (data.... not prunes :->).
372 * - a symlink [symbolic link] (the alias).
376 /* The file variant has three file sizes:
377 * - file_size : size of file as written into Yaffs - including data in cache.
378 * - stored_size - size of file as stored on media.
379 * - shrink_size - size of file that has been shrunk back to.
381 * The stored_size and file_size might be different because the data written
382 * into the cache will increase the file_size but the stored_size will only
383 * change when the data is actually stored.
386 struct yaffs_file_var {
391 struct yaffs_tnode *top;
394 struct yaffs_dir_var {
395 struct list_head children; /* list of child links */
396 struct list_head dirty; /* Entry for list of dirty directories */
399 struct yaffs_symlink_var {
403 struct yaffs_hardlink_var {
404 struct yaffs_obj *equiv_obj;
408 union yaffs_obj_var {
409 struct yaffs_file_var file_variant;
410 struct yaffs_dir_var dir_variant;
411 struct yaffs_symlink_var symlink_variant;
412 struct yaffs_hardlink_var hardlink_variant;
416 u8 deleted:1; /* This should only apply to unlinked files. */
417 u8 soft_del:1; /* it has also been soft deleted */
418 u8 unlinked:1; /* An unlinked file.*/
419 u8 fake:1; /* A fake object has no presence on NAND. */
420 u8 rename_allowed:1; /* Some objects cannot be renamed. */
422 u8 dirty:1; /* the object needs to be written to flash */
423 u8 valid:1; /* When the file system is being loaded up, this
424 * object might be created before the data
426 * ie. file data chunks encountered before
429 u8 lazy_loaded:1; /* This object has been lazy loaded and
430 * is missing some detail */
432 u8 defered_free:1; /* Object is removed from NAND, but is
433 * still in the inode cache.
434 * Free of object is defered.
435 * until the inode is released.
437 u8 being_created:1; /* This object is still being created
438 * so skip some verification checks. */
439 u8 is_shadowed:1; /* This object is shadowed on the way
440 * to being renamed. */
442 u8 xattr_known:1; /* We know if this has object has xattribs
444 u8 has_xattr:1; /* This object has xattribs.
445 * Only valid if xattr_known. */
447 u8 serial; /* serial number of chunk in NAND.*/
448 u16 sum; /* sum of the name to speed searching */
450 struct yaffs_dev *my_dev; /* The device I'm on */
452 struct list_head hash_link; /* list of objects in hash bucket */
454 struct list_head hard_links; /* hard linked object chain*/
456 /* directory structure stuff */
457 /* also used for linking up the free list */
458 struct yaffs_obj *parent;
459 struct list_head siblings;
461 /* Where's my object header in NAND? */
464 int n_data_chunks; /* Number of data chunks for this file. */
466 u32 obj_id; /* the object id value */
470 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
472 #ifdef CONFIG_YAFFS_WINCE
488 u32 variant_type; /* enum yaffs_object_type */
490 union yaffs_obj_var variant;
494 struct yaffs_obj_bucket {
495 struct list_head list;
500 /*--------------------- Temporary buffers ----------------
502 * These are chunk-sized working buffers. Each device has a few.
505 struct yaffs_buffer {
510 /*----------------- Device ---------------------------------*/
516 * Entry parameters set up way early. Yaffs sets up the rest.
517 * The structure should be zeroed out before use so that unused
518 * and default values are zero.
521 int inband_tags; /* Use unband tags */
522 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
524 int chunks_per_block; /* does not need to be a power of 2 */
525 int spare_bytes_per_chunk; /* spare area size */
526 int start_block; /* Start block we're allowed to use */
527 int end_block; /* End block we're allowed to use */
528 int n_reserved_blocks; /* Tuneable so that we can reduce
529 * reserved blocks on NOR and RAM. */
531 int n_caches; /* If <= 0, then short op caching is disabled,
532 * else the number of short op caches.
534 int cache_bypass_aligned; /* If non-zero then bypass the cache for
538 int use_nand_ecc; /* Flag to decide whether or not to use
539 * NAND driver ECC on data (yaffs1) */
540 int tags_9bytes; /* Use 9 byte tags */
541 int no_tags_ecc; /* Flag to decide whether or not to do ECC
542 * on packed tags (yaffs2) */
544 int is_yaffs2; /* Use yaffs2 mode on this device */
546 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
548 int refresh_period; /* How often to check for a block refresh */
550 /* Checkpoint control. Can be set before or after initialisation */
554 int enable_xattr; /* Enable xattribs */
557 * Set to limit the number of objects created.
561 int hide_lost_n_found; /* Set non-zero to hide the lost-n-found dir. */
563 /* The remove_obj_fn function must be supplied by OS flavours that
565 * yaffs direct uses it to implement the faster readdir.
566 * Linux uses it to protect the directory during unlocking.
568 void (*remove_obj_fn) (struct yaffs_obj *obj);
570 /* Callback to mark the superblock dirty */
571 void (*sb_dirty_fn) (struct yaffs_dev *dev);
573 /* Callback to control garbage collection. */
574 unsigned (*gc_control_fn) (struct yaffs_dev *dev);
576 /* Debug control flags. Don't use unless you know what you're doing */
577 int use_header_file_size; /* Flag to determine if we should use
578 * file sizes from the header */
579 int disable_lazy_load; /* Disable lazy loading on this device */
580 int wide_tnodes_disabled; /* Set to disable wide tnodes */
581 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
584 int defered_dir_update; /* Set to defer directory updates */
586 #ifdef CONFIG_YAFFS_AUTO_UNICODE
589 int always_check_erased; /* Force chunk erased check always on */
592 int disable_bad_block_marking;
596 struct yaffs_driver {
597 int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
598 const u8 *data, int data_len,
599 const u8 *oob, int oob_len);
600 int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
601 u8 *data, int data_len,
602 u8 *oob, int oob_len,
603 enum yaffs_ecc_result *ecc_result);
604 int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
605 int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
606 int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
607 int (*drv_initialise_fn) (struct yaffs_dev *dev);
608 int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
611 struct yaffs_tags_handler {
612 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
613 int nand_chunk, const u8 *data,
614 const struct yaffs_ext_tags *tags);
615 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
616 int nand_chunk, u8 *data,
617 struct yaffs_ext_tags *tags);
619 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
620 enum yaffs_block_state *state,
622 int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
626 struct yaffs_param param;
627 struct yaffs_driver drv;
628 struct yaffs_tags_handler tagger;
630 /* Context storage. Holds extra OS specific data for this device */
633 void *driver_context;
635 struct list_head dev_list;
638 /* Runtime parameters. Set up by YAFFS. */
639 int data_bytes_per_chunk;
641 /* Non-wide tnode stuff */
642 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
643 * the tnodes are not wide enough.
645 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
647 /* Stuff to support wide tnodes */
652 /* Stuff for figuring out file offset to chunk conversions */
653 u32 chunk_shift; /* Shift value */
654 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
655 u32 chunk_mask; /* Mask to use for power-of-2 case */
661 /* Stuff to support block offsetting to support start block zero */
662 int internal_start_block;
663 int internal_end_block;
667 /* Runtime checkpointing stuff */
668 int checkpt_page_seq; /* running sequence number of checkpt pages */
669 int checkpt_byte_count;
670 int checkpt_byte_offs;
672 int checkpt_open_write;
673 int blocks_in_checkpt;
674 int checkpt_cur_chunk;
675 int checkpt_cur_block;
676 int checkpt_next_block;
677 int *checkpt_block_list;
678 int checkpt_max_blocks;
682 int checkpoint_blocks_required; /* Number of blocks needed to store
683 * current checkpoint set */
686 struct yaffs_block_info *block_info;
687 u8 *chunk_bits; /* bitmap of chunks in use */
688 u8 block_info_alt:1; /* allocated using alternative alloc */
689 u8 chunk_bits_alt:1; /* allocated using alternative alloc */
690 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
691 * Must be consistent with chunks_per_block.
695 int alloc_block; /* Current block being allocated off */
697 int alloc_block_finder; /* Used to search for next allocation block */
699 /* Object and Tnode memory management */
706 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
711 /* Garbage collection control */
712 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
715 unsigned has_pending_prioritised_gc; /* We think this device might
716 have pending prioritised gcs */
718 unsigned gc_block_finder;
719 unsigned gc_dirtiest;
720 unsigned gc_pages_in_use;
721 unsigned gc_not_done;
725 struct yaffs_summary_tags *gc_sum_tags;
727 /* Special directories */
728 struct yaffs_obj *root_dir;
729 struct yaffs_obj *lost_n_found;
731 int buffered_block; /* Which block is buffered here? */
732 int doing_buffered_block_rewrite;
734 struct yaffs_cache *cache;
737 /* Stuff for background deletion and unlinked files. */
738 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
740 struct yaffs_obj *del_dir; /* Directory where deleted objects are
741 sent to disappear. */
742 struct yaffs_obj *unlinked_deletion; /* Current file being
743 background deleted. */
744 int n_deleted_files; /* Count of files awaiting deletion; */
745 int n_unlinked_files; /* Count of unlinked files. */
746 int n_bg_deletions; /* Count of background deletions. */
748 /* Temporary buffer management */
749 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
752 int unmanaged_buffer_allocs;
753 int unmanaged_buffer_deallocs;
755 /* yaffs2 runtime stuff */
756 unsigned seq_number; /* Sequence number of currently
758 unsigned oldest_dirty_seq;
759 unsigned oldest_dirty_block;
761 /* Block refreshing */
762 int refresh_skip; /* A skip down counter.
763 * Refresh happens when this gets to zero. */
765 /* Dirty directory handling */
766 struct list_head dirty_dirs; /* List of dirty directories */
769 int chunks_per_summary;
770 struct yaffs_summary_tags *sum_tags;
778 u32 n_erase_failures;
781 u32 passive_gc_count;
782 u32 oldest_dirty_gc_count;
785 u32 n_retried_writes;
786 u32 n_retired_blocks;
789 u32 n_tags_ecc_fixed;
790 u32 n_tags_ecc_unfixed;
792 u32 n_unmarked_deletions;
801 * Checkpointing definitions.
804 #define YAFFS_CHECKPOINT_VERSION 8
806 /* yaffs_checkpt_obj holds the definition of an object as dumped
811 /* Checkpint object bits in bitfield: offset, length */
812 #define CHECKPOINT_VARIANT_BITS 0, 3
813 #define CHECKPOINT_DELETED_BITS 3, 1
814 #define CHECKPOINT_SOFT_DEL_BITS 4, 1
815 #define CHECKPOINT_UNLINKED_BITS 5, 1
816 #define CHECKPOINT_FAKE_BITS 6, 1
817 #define CHECKPOINT_RENAME_ALLOWED_BITS 7, 1
818 #define CHECKPOINT_UNLINK_ALLOWED_BITS 8, 1
819 #define CHECKPOINT_SERIAL_BITS 9, 8
821 struct yaffs_checkpt_obj {
828 loff_t size_or_equiv_obj;
831 /* The CheckpointDevice structure holds the device information that changes
832 *at runtime and must be preserved over unmount/mount cycles.
834 struct yaffs_checkpt_dev {
837 int alloc_block; /* Current block being allocated off */
841 int n_deleted_files; /* Count of files awaiting deletion; */
842 int n_unlinked_files; /* Count of unlinked files. */
843 int n_bg_deletions; /* Count of background deletions. */
845 /* yaffs2 runtime stuff */
846 unsigned seq_number; /* Sequence number of currently
847 * allocating block */
851 struct yaffs_checkpt_validity {
858 struct yaffs_shadow_fixer {
861 struct yaffs_shadow_fixer *next;
864 /* Structure for doing xattr modifications */
865 struct yaffs_xattr_mod {
866 int set; /* If 0 then this is a deletion */
874 /*----------------------- YAFFS Functions -----------------------*/
876 int yaffs_guts_initialise(struct yaffs_dev *dev);
877 void yaffs_deinitialise(struct yaffs_dev *dev);
879 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
881 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
882 struct yaffs_obj *new_dir, const YCHAR * new_name);
884 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
885 int yaffs_del_obj(struct yaffs_obj *obj);
886 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
887 enum yaffs_obj_type type);
890 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
891 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
892 int yaffs_get_obj_inode(struct yaffs_obj *obj);
893 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
894 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
896 /* File operations */
897 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
899 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
900 int n_bytes, int write_trhrough);
901 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
903 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
904 const YCHAR *name, u32 mode, u32 uid,
907 int yaffs_flush_file(struct yaffs_obj *in,
912 /* Flushing and checkpointing */
913 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
915 int yaffs_checkpoint_save(struct yaffs_dev *dev);
916 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
918 /* Directory operations */
919 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
920 u32 mode, u32 uid, u32 gid);
921 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
923 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
925 /* Link operations */
926 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
927 struct yaffs_obj *equiv_obj);
929 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
931 /* Symlink operations */
932 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
933 const YCHAR *name, u32 mode, u32 uid,
934 u32 gid, const YCHAR *alias);
935 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
937 /* Special inodes (fifos, sockets and devices) */
938 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
939 const YCHAR *name, u32 mode, u32 uid,
942 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
943 const void *value, int size, int flags);
944 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
946 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
947 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
949 /* Special directories */
950 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
951 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
953 void yaffs_handle_defered_free(struct yaffs_obj *obj);
955 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
957 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
960 int yaffs_dump_obj(struct yaffs_obj *obj);
962 void yaffs_guts_test(struct yaffs_dev *dev);
963 int yaffs_guts_ll_init(struct yaffs_dev *dev);
966 /* A few useful functions to be used within the core files*/
967 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
969 int yaffs_check_ff(u8 *buffer, int n_bytes);
970 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
971 struct yaffs_block_info *bi);
973 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
974 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
976 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
978 enum yaffs_obj_type type);
979 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
980 int nand_chunk, int in_scan);
981 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
982 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
983 const struct yaffs_obj_hdr *oh);
984 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
985 YCHAR *yaffs_clone_str(const YCHAR *str);
986 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
987 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
988 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
989 int force, int is_shrink, int shadows,
990 struct yaffs_xattr_mod *xop);
991 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
992 int backward_scanning);
993 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
994 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
995 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
996 struct yaffs_file_var *file_struct,
998 struct yaffs_tnode *passed_tn);
1000 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
1001 int n_bytes, int write_trhrough);
1002 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
1003 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
1005 int yaffs_count_free_chunks(struct yaffs_dev *dev);
1007 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
1008 struct yaffs_file_var *file_struct,
1011 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
1014 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
1016 int yaffs_guts_format_dev(struct yaffs_dev *dev);
1018 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
1019 int *chunk_out, u32 *offset_out);
1021 * Marshalling functions to get loff_t file sizes into aand out of
1024 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize);
1025 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh);
1026 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1029 * Debug function to count number of blocks in each state
1030 * NB Needs to be called with correct number of integers
1033 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1035 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1036 struct yaffs_ext_tags *tags);