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
82 #define YAFFS_CHECKPOINT_VERSION 7
84 #ifdef CONFIG_YAFFS_UNICODE
85 #define YAFFS_MAX_NAME_LENGTH 127
86 #define YAFFS_MAX_ALIAS_LENGTH 79
88 #define YAFFS_MAX_NAME_LENGTH 255
89 #define YAFFS_MAX_ALIAS_LENGTH 159
92 #define YAFFS_SHORT_NAME_LENGTH 15
94 /* Some special object ids for pseudo objects */
95 #define YAFFS_OBJECTID_ROOT 1
96 #define YAFFS_OBJECTID_LOSTNFOUND 2
97 #define YAFFS_OBJECTID_UNLINKED 3
98 #define YAFFS_OBJECTID_DELETED 4
100 /* Fake object Id for summary data */
101 #define YAFFS_OBJECTID_SUMMARY 0x10
103 /* Pseudo object ids for checkpointing */
104 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
105 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
107 #define YAFFS_MAX_SHORT_OP_CACHES 20
109 #define YAFFS_N_TEMP_BUFFERS 6
111 /* We limit the number attempts at sucessfully saving a chunk of data.
112 * Small-page devices have 32 pages per block; large-page devices have 64.
113 * Default to something in the order of 5 to 10 blocks worth of chunks.
115 #define YAFFS_WR_ATTEMPTS (5*64)
117 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
118 * The range is limited slightly to help distinguish bad numbers from good.
119 * This also allows us to perhaps in the future use special numbers for
121 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
122 * and is a larger number than the lifetime of a 2GB device.
124 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
125 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
127 /* Special sequence number for bad block that failed to be marked bad */
128 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
130 /* ChunkCache is used for short read/write operations.*/
132 struct yaffs_obj *object;
136 int n_bytes; /* Only valid if the cache is dirty */
137 int locked; /* Can't push out or flush while locked. */
141 /* yaffs1 tags structures in RAM
142 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
143 * otherwise the structure size will get blown out.
155 union yaffs_tags_union {
156 struct yaffs_tags as_tags;
161 /* Stuff used for extended tags in YAFFS2 */
163 enum yaffs_ecc_result {
164 YAFFS_ECC_RESULT_UNKNOWN,
165 YAFFS_ECC_RESULT_NO_ERROR,
166 YAFFS_ECC_RESULT_REFRESH,
167 YAFFS_ECC_RESULT_FIXED,
168 YAFFS_ECC_RESULT_UNFIXED
171 enum yaffs_obj_type {
172 YAFFS_OBJECT_TYPE_UNKNOWN,
173 YAFFS_OBJECT_TYPE_FILE,
174 YAFFS_OBJECT_TYPE_SYMLINK,
175 YAFFS_OBJECT_TYPE_DIRECTORY,
176 YAFFS_OBJECT_TYPE_HARDLINK,
177 YAFFS_OBJECT_TYPE_SPECIAL
180 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
182 struct yaffs_ext_tags {
183 unsigned chunk_used; /* Status of the chunk: used or unused */
184 unsigned obj_id; /* If 0 this is not used */
185 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
186 unsigned n_bytes; /* Only valid for data chunks */
188 /* The following stuff only has meaning when we read */
189 enum yaffs_ecc_result ecc_result;
193 unsigned is_deleted; /* The chunk is marked deleted */
194 unsigned serial_number; /* Yaffs1 2-bit serial number */
197 unsigned seq_number; /* The sequence number of this block */
199 /* Extra info if this is an object header (YAFFS2 only) */
201 unsigned extra_available; /* Extra info available if not zero */
202 unsigned extra_parent_id; /* The parent object */
203 unsigned extra_is_shrink; /* Is it a shrink header? */
204 unsigned extra_shadows; /* Does this shadow another object? */
206 enum yaffs_obj_type extra_obj_type; /* What object type? */
208 loff_t extra_file_size; /* Length if it is a file */
209 unsigned extra_equiv_id; /* Equivalent object for a hard link */
212 /* Spare structure for YAFFS1 */
218 u8 page_status; /* set to 0 to delete the chunk */
228 /*Special structure for passing through to mtd */
229 struct yaffs_nand_spare {
230 struct yaffs_spare spare;
235 /* Block data in RAM */
237 enum yaffs_block_state {
238 YAFFS_BLOCK_STATE_UNKNOWN = 0,
240 YAFFS_BLOCK_STATE_SCANNING,
243 YAFFS_BLOCK_STATE_NEEDS_SCAN,
244 /* The block might have something on it (ie it is allocating or full,
245 * perhaps empty) but it needs to be scanned to determine its true
247 * This state is only valid during scanning.
248 * NB We tolerate empty because the pre-scanner might be incapable of
250 * However, if this state is returned on a YAFFS2 device,
251 * then we expect a sequence number
254 YAFFS_BLOCK_STATE_EMPTY,
255 /* This block is empty */
257 YAFFS_BLOCK_STATE_ALLOCATING,
258 /* This block is partially allocated.
259 * At least one page holds valid data.
260 * This is the one currently being used for page
261 * allocation. Should never be more than one of these.
262 * If a block is only partially allocated at mount it is treated as
266 YAFFS_BLOCK_STATE_FULL,
267 /* All the pages in this block have been allocated.
268 * If a block was only partially allocated when mounted we treat
269 * it as fully allocated.
272 YAFFS_BLOCK_STATE_DIRTY,
273 /* The block was full and now all chunks have been deleted.
274 * Erase me, reuse me.
277 YAFFS_BLOCK_STATE_CHECKPOINT,
278 /* This block is assigned to holding checkpoint data. */
280 YAFFS_BLOCK_STATE_COLLECTING,
281 /* This block is being garbage collected */
283 YAFFS_BLOCK_STATE_DEAD
284 /* This block has failed and is not in use */
287 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
289 struct yaffs_block_info {
291 s32 soft_del_pages:10; /* number of soft deleted pages */
292 s32 pages_in_use:10; /* number of pages in use */
293 u32 block_state:4; /* One of the above block states. */
294 /* NB use unsigned because enum is sometimes
296 u32 needs_retiring:1; /* Data has failed on this block, */
297 /*need to get valid data off and retire*/
298 u32 skip_erased_check:1;/* Skip the erased check on this block */
299 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
300 Block should be prioritised for GC */
301 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
302 failures on this block and tried to reuse it */
303 u32 has_summary:1; /* The block has a summary */
305 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
306 u32 seq_number; /* block sequence number for yaffs2 */
310 /* -------------------------- Object structure -------------------------------*/
311 /* This is the object structure as stored on NAND */
313 struct yaffs_obj_hdr {
314 enum yaffs_obj_type type;
316 /* Apply to everything */
318 u16 sum_no_longer_used; /* checksum of name. No longer used */
319 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
321 /* The following apply to all object types except for hard links */
322 u32 yst_mode; /* protection */
330 /* File size applies to files only */
333 /* Equivalent object id applies to hard links only. */
336 /* Alias is for symlinks only. */
337 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
339 u32 yst_rdev; /* stuff for block and char devices (major/min) */
345 u32 inband_shadowed_obj_id;
346 u32 inband_is_shrink;
350 int shadows_obj; /* This object header shadows the
351 specified object if > 0 */
353 /* is_shrink applies to object headers written when wemake a hole. */
358 /*--------------------------- Tnode -------------------------- */
361 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
364 /*------------------------ Object -----------------------------*/
365 /* An object can be one of:
366 * - a directory (no data, has children links
367 * - a regular file (data.... not prunes :->).
368 * - a symlink [symbolic link] (the alias).
372 struct yaffs_file_var {
377 struct yaffs_tnode *top;
380 struct yaffs_dir_var {
381 struct list_head children; /* list of child links */
382 struct list_head dirty; /* Entry for list of dirty directories */
385 struct yaffs_symlink_var {
389 struct yaffs_hardlink_var {
390 struct yaffs_obj *equiv_obj;
394 union yaffs_obj_var {
395 struct yaffs_file_var file_variant;
396 struct yaffs_dir_var dir_variant;
397 struct yaffs_symlink_var symlink_variant;
398 struct yaffs_hardlink_var hardlink_variant;
402 u8 deleted:1; /* This should only apply to unlinked files. */
403 u8 soft_del:1; /* it has also been soft deleted */
404 u8 unlinked:1; /* An unlinked file.*/
405 u8 fake:1; /* A fake object has no presence on NAND. */
406 u8 rename_allowed:1; /* Some objects cannot be renamed. */
408 u8 dirty:1; /* the object needs to be written to flash */
409 u8 valid:1; /* When the file system is being loaded up, this
410 * object might be created before the data
412 * ie. file data chunks encountered before
415 u8 lazy_loaded:1; /* This object has been lazy loaded and
416 * is missing some detail */
418 u8 defered_free:1; /* Object is removed from NAND, but is
419 * still in the inode cache.
420 * Free of object is defered.
421 * until the inode is released.
423 u8 being_created:1; /* This object is still being created
424 * so skip some verification checks. */
425 u8 is_shadowed:1; /* This object is shadowed on the way
426 * to being renamed. */
428 u8 xattr_known:1; /* We know if this has object has xattribs
430 u8 has_xattr:1; /* This object has xattribs.
431 * Only valid if xattr_known. */
433 u8 serial; /* serial number of chunk in NAND.*/
434 u16 sum; /* sum of the name to speed searching */
436 struct yaffs_dev *my_dev; /* The device I'm on */
438 struct list_head hash_link; /* list of objects in hash bucket */
440 struct list_head hard_links; /* hard linked object chain*/
442 /* directory structure stuff */
443 /* also used for linking up the free list */
444 struct yaffs_obj *parent;
445 struct list_head siblings;
447 /* Where's my object header in NAND? */
450 int n_data_chunks; /* Number of data chunks for this file. */
452 u32 obj_id; /* the object id value */
456 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
458 #ifdef CONFIG_YAFFS_WINCE
474 enum yaffs_obj_type variant_type;
476 union yaffs_obj_var variant;
480 struct yaffs_obj_bucket {
481 struct list_head list;
485 /* yaffs_checkpt_obj holds the definition of an object as dumped
489 struct yaffs_checkpt_obj {
494 enum yaffs_obj_type variant_type:3;
503 loff_t size_or_equiv_obj;
506 /*--------------------- Temporary buffers ----------------
508 * These are chunk-sized working buffers. Each device has a few.
511 struct yaffs_buffer {
516 /*----------------- Device ---------------------------------*/
522 * Entry parameters set up way early. Yaffs sets up the rest.
523 * The structure should be zeroed out before use so that unused
524 * and default values are zero.
527 int inband_tags; /* Use unband tags */
528 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
530 int chunks_per_block; /* does not need to be a power of 2 */
531 int spare_bytes_per_chunk; /* spare area size */
532 int start_block; /* Start block we're allowed to use */
533 int end_block; /* End block we're allowed to use */
534 int n_reserved_blocks; /* Tuneable so that we can reduce
535 * reserved blocks on NOR and RAM. */
537 int n_caches; /* If <= 0, then short op caching is disabled,
538 * else the number of short op caches.
540 int cache_bypass_aligned; /* If non-zero then bypass the cache for
544 int use_nand_ecc; /* Flag to decide whether or not to use
545 * NAND driver ECC on data (yaffs1) */
546 int tags_9bytes; /* Use 9 byte tags */
547 int no_tags_ecc; /* Flag to decide whether or not to do ECC
548 * on packed tags (yaffs2) */
550 int is_yaffs2; /* Use yaffs2 mode on this device */
552 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
554 int refresh_period; /* How often to check for a block refresh */
556 /* Checkpoint control. Can be set before or after initialisation */
560 int enable_xattr; /* Enable xattribs */
563 * Set to limit the number of objects created.
567 /* The remove_obj_fn function must be supplied by OS flavours that
569 * yaffs direct uses it to implement the faster readdir.
570 * Linux uses it to protect the directory during unlocking.
572 void (*remove_obj_fn) (struct yaffs_obj *obj);
574 /* Callback to mark the superblock dirty */
575 void (*sb_dirty_fn) (struct yaffs_dev *dev);
577 /* Callback to control garbage collection. */
578 unsigned (*gc_control_fn) (struct yaffs_dev *dev);
580 /* Debug control flags. Don't use unless you know what you're doing */
581 int use_header_file_size; /* Flag to determine if we should use
582 * file sizes from the header */
583 int disable_lazy_load; /* Disable lazy loading on this device */
584 int wide_tnodes_disabled; /* Set to disable wide tnodes */
585 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
588 int defered_dir_update; /* Set to defer directory updates */
590 #ifdef CONFIG_YAFFS_AUTO_UNICODE
593 int always_check_erased; /* Force chunk erased check always on */
596 int disable_bad_block_marking;
600 struct yaffs_driver {
601 int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
602 const u8 *data, int data_len,
603 const u8 *oob, int oob_len);
604 int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
605 u8 *data, int data_len,
606 u8 *oob, int oob_len,
607 enum yaffs_ecc_result *ecc_result);
608 int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
609 int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
610 int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
611 int (*drv_initialise_fn) (struct yaffs_dev *dev);
612 int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
615 struct yaffs_tags_handler {
616 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
617 int nand_chunk, const u8 *data,
618 const struct yaffs_ext_tags *tags);
619 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
620 int nand_chunk, u8 *data,
621 struct yaffs_ext_tags *tags);
623 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
624 enum yaffs_block_state *state,
626 int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
630 struct yaffs_param param;
631 struct yaffs_driver drv;
632 struct yaffs_tags_handler tagger;
634 /* Context storage. Holds extra OS specific data for this device */
637 void *driver_context;
639 struct list_head dev_list;
642 /* Runtime parameters. Set up by YAFFS. */
643 int data_bytes_per_chunk;
645 /* Non-wide tnode stuff */
646 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
647 * the tnodes are not wide enough.
649 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
651 /* Stuff to support wide tnodes */
656 /* Stuff for figuring out file offset to chunk conversions */
657 u32 chunk_shift; /* Shift value */
658 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
659 u32 chunk_mask; /* Mask to use for power-of-2 case */
665 /* Stuff to support block offsetting to support start block zero */
666 int internal_start_block;
667 int internal_end_block;
671 /* Runtime checkpointing stuff */
672 int checkpt_page_seq; /* running sequence number of checkpt pages */
673 int checkpt_byte_count;
674 int checkpt_byte_offs;
676 int checkpt_open_write;
677 int blocks_in_checkpt;
678 int checkpt_cur_chunk;
679 int checkpt_cur_block;
680 int checkpt_next_block;
681 int *checkpt_block_list;
682 int checkpt_max_blocks;
686 int checkpoint_blocks_required; /* Number of blocks needed to store
687 * current checkpoint set */
690 struct yaffs_block_info *block_info;
691 u8 *chunk_bits; /* bitmap of chunks in use */
692 u8 block_info_alt:1; /* allocated using alternative alloc */
693 u8 chunk_bits_alt:1; /* allocated using alternative alloc */
694 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
695 * Must be consistent with chunks_per_block.
699 int alloc_block; /* Current block being allocated off */
701 int alloc_block_finder; /* Used to search for next allocation block */
703 /* Object and Tnode memory management */
710 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
715 /* Garbage collection control */
716 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
719 unsigned has_pending_prioritised_gc; /* We think this device might
720 have pending prioritised gcs */
722 unsigned gc_block_finder;
723 unsigned gc_dirtiest;
724 unsigned gc_pages_in_use;
725 unsigned gc_not_done;
729 struct yaffs_summary_tags *gc_sum_tags;
731 /* Special directories */
732 struct yaffs_obj *root_dir;
733 struct yaffs_obj *lost_n_found;
735 int buffered_block; /* Which block is buffered here? */
736 int doing_buffered_block_rewrite;
738 struct yaffs_cache *cache;
741 /* Stuff for background deletion and unlinked files. */
742 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
744 struct yaffs_obj *del_dir; /* Directory where deleted objects are
745 sent to disappear. */
746 struct yaffs_obj *unlinked_deletion; /* Current file being
747 background deleted. */
748 int n_deleted_files; /* Count of files awaiting deletion; */
749 int n_unlinked_files; /* Count of unlinked files. */
750 int n_bg_deletions; /* Count of background deletions. */
752 /* Temporary buffer management */
753 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
756 int unmanaged_buffer_allocs;
757 int unmanaged_buffer_deallocs;
759 /* yaffs2 runtime stuff */
760 unsigned seq_number; /* Sequence number of currently
762 unsigned oldest_dirty_seq;
763 unsigned oldest_dirty_block;
765 /* Block refreshing */
766 int refresh_skip; /* A skip down counter.
767 * Refresh happens when this gets to zero. */
769 /* Dirty directory handling */
770 struct list_head dirty_dirs; /* List of dirty directories */
773 int chunks_per_summary;
774 struct yaffs_summary_tags *sum_tags;
782 u32 n_erase_failures;
785 u32 passive_gc_count;
786 u32 oldest_dirty_gc_count;
789 u32 n_retried_writes;
790 u32 n_retired_blocks;
793 u32 n_tags_ecc_fixed;
794 u32 n_tags_ecc_unfixed;
796 u32 n_unmarked_deletions;
804 /* The CheckpointDevice structure holds the device information that changes
805 *at runtime and must be preserved over unmount/mount cycles.
807 struct yaffs_checkpt_dev {
810 int alloc_block; /* Current block being allocated off */
814 int n_deleted_files; /* Count of files awaiting deletion; */
815 int n_unlinked_files; /* Count of unlinked files. */
816 int n_bg_deletions; /* Count of background deletions. */
818 /* yaffs2 runtime stuff */
819 unsigned seq_number; /* Sequence number of currently
820 * allocating block */
824 struct yaffs_checkpt_validity {
831 struct yaffs_shadow_fixer {
834 struct yaffs_shadow_fixer *next;
837 /* Structure for doing xattr modifications */
838 struct yaffs_xattr_mod {
839 int set; /* If 0 then this is a deletion */
847 /*----------------------- YAFFS Functions -----------------------*/
849 int yaffs_guts_initialise(struct yaffs_dev *dev);
850 void yaffs_deinitialise(struct yaffs_dev *dev);
852 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
854 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
855 struct yaffs_obj *new_dir, const YCHAR * new_name);
857 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
858 int yaffs_del_obj(struct yaffs_obj *obj);
859 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
860 enum yaffs_obj_type type);
863 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
864 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
865 int yaffs_get_obj_inode(struct yaffs_obj *obj);
866 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
867 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
869 /* File operations */
870 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
872 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
873 int n_bytes, int write_trhrough);
874 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
876 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
877 const YCHAR *name, u32 mode, u32 uid,
880 int yaffs_flush_file(struct yaffs_obj *in,
885 /* Flushing and checkpointing */
886 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
888 int yaffs_checkpoint_save(struct yaffs_dev *dev);
889 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
891 /* Directory operations */
892 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
893 u32 mode, u32 uid, u32 gid);
894 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
896 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
898 /* Link operations */
899 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
900 struct yaffs_obj *equiv_obj);
902 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
904 /* Symlink operations */
905 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
906 const YCHAR *name, u32 mode, u32 uid,
907 u32 gid, const YCHAR *alias);
908 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
910 /* Special inodes (fifos, sockets and devices) */
911 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
912 const YCHAR *name, u32 mode, u32 uid,
915 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
916 const void *value, int size, int flags);
917 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
919 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
920 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
922 /* Special directories */
923 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
924 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
926 void yaffs_handle_defered_free(struct yaffs_obj *obj);
928 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
930 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
933 int yaffs_dump_obj(struct yaffs_obj *obj);
935 void yaffs_guts_test(struct yaffs_dev *dev);
936 int yaffs_guts_ll_init(struct yaffs_dev *dev);
939 /* A few useful functions to be used within the core files*/
940 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
942 int yaffs_check_ff(u8 *buffer, int n_bytes);
943 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
944 struct yaffs_block_info *bi,
945 enum yaffs_ecc_result err_type);
947 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
948 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
950 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
952 enum yaffs_obj_type type);
953 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
954 int nand_chunk, int in_scan);
955 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
956 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
957 const struct yaffs_obj_hdr *oh);
958 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
959 YCHAR *yaffs_clone_str(const YCHAR *str);
960 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
961 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
962 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
963 int force, int is_shrink, int shadows,
964 struct yaffs_xattr_mod *xop);
965 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
966 int backward_scanning);
967 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
968 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
969 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
970 struct yaffs_file_var *file_struct,
972 struct yaffs_tnode *passed_tn);
974 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
975 int n_bytes, int write_trhrough);
976 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
977 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
979 int yaffs_count_free_chunks(struct yaffs_dev *dev);
981 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
982 struct yaffs_file_var *file_struct,
985 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
988 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
990 int yaffs_guts_format_dev(struct yaffs_dev *dev);
992 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
993 int *chunk_out, u32 *offset_out);
995 * Marshalling functions to get loff_t file sizes into aand out of
998 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize);
999 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh);
1000 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1003 * Debug function to count number of blocks in each state
1004 * NB Needs to be called with correct number of integers
1007 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1009 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1010 struct yaffs_ext_tags *tags);