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 arounf 51Gbytees 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
54 /* Constants for YAFFS1 mode */
55 #define YAFFS_BYTES_PER_SPARE 16
56 #define YAFFS_BYTES_PER_CHUNK 512
57 #define YAFFS_CHUNK_SIZE_SHIFT 9
58 #define YAFFS_CHUNKS_PER_BLOCK 32
59 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
61 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
62 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
64 #define YAFFS_MAX_CHUNK_ID 0x000fffff
66 #define YAFFS_ALLOCATION_NOBJECTS 100
67 #define YAFFS_ALLOCATION_NTNODES 100
68 #define YAFFS_ALLOCATION_NLINKS 100
70 #define YAFFS_NOBJECT_BUCKETS 256
72 #define YAFFS_OBJECT_SPACE 0x40000
73 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1)
75 #define YAFFS_CHECKPOINT_VERSION 5
77 #ifdef CONFIG_YAFFS_UNICODE
78 #define YAFFS_MAX_NAME_LENGTH 127
79 #define YAFFS_MAX_ALIAS_LENGTH 79
81 #define YAFFS_MAX_NAME_LENGTH 255
82 #define YAFFS_MAX_ALIAS_LENGTH 159
85 #define YAFFS_SHORT_NAME_LENGTH 15
87 /* Some special object ids for pseudo objects */
88 #define YAFFS_OBJECTID_ROOT 1
89 #define YAFFS_OBJECTID_LOSTNFOUND 2
90 #define YAFFS_OBJECTID_UNLINKED 3
91 #define YAFFS_OBJECTID_DELETED 4
93 /* Fake object Id for summary data */
94 #define YAFFS_OBJECTID_SUMMARY 0x10
96 /* Pseudo object ids for checkpointing */
97 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
98 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
100 #define YAFFS_MAX_SHORT_OP_CACHES 20
102 #define YAFFS_N_TEMP_BUFFERS 6
104 /* We limit the number attempts at sucessfully saving a chunk of data.
105 * Small-page devices have 32 pages per block; large-page devices have 64.
106 * Default to something in the order of 5 to 10 blocks worth of chunks.
108 #define YAFFS_WR_ATTEMPTS (5*64)
110 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
111 * The range is limited slightly to help distinguish bad numbers from good.
112 * This also allows us to perhaps in the future use special numbers for
114 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
115 * and is a larger number than the lifetime of a 2GB device.
117 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
118 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
120 /* Special sequence number for bad block that failed to be marked bad */
121 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
123 /* ChunkCache is used for short read/write operations.*/
125 struct yaffs_obj *object;
129 int n_bytes; /* Only valid if the cache is dirty */
130 int locked; /* Can't push out or flush while locked. */
134 /* yaffs1 tags structures in RAM
135 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
136 * otherwise the structure size will get blown out.
140 unsigned chunk_id:20;
141 unsigned serial_number:2;
142 unsigned n_bytes_lsb:10;
145 unsigned n_bytes_msb:2;
148 union yaffs_tags_union {
149 struct yaffs_tags as_tags;
154 /* Stuff used for extended tags in YAFFS2 */
156 enum yaffs_ecc_result {
157 YAFFS_ECC_RESULT_UNKNOWN,
158 YAFFS_ECC_RESULT_NO_ERROR,
159 YAFFS_ECC_RESULT_FIXED,
160 YAFFS_ECC_RESULT_UNFIXED
163 enum yaffs_obj_type {
164 YAFFS_OBJECT_TYPE_UNKNOWN,
165 YAFFS_OBJECT_TYPE_FILE,
166 YAFFS_OBJECT_TYPE_SYMLINK,
167 YAFFS_OBJECT_TYPE_DIRECTORY,
168 YAFFS_OBJECT_TYPE_HARDLINK,
169 YAFFS_OBJECT_TYPE_SPECIAL
172 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
174 struct yaffs_ext_tags {
175 unsigned chunk_used; /* Status of the chunk: used or unused */
176 unsigned obj_id; /* If 0 this is not used */
177 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
178 unsigned n_bytes; /* Only valid for data chunks */
180 /* The following stuff only has meaning when we read */
181 enum yaffs_ecc_result ecc_result;
185 unsigned is_deleted; /* The chunk is marked deleted */
186 unsigned serial_number; /* Yaffs1 2-bit serial number */
189 unsigned seq_number; /* The sequence number of this block */
191 /* Extra info if this is an object header (YAFFS2 only) */
193 unsigned extra_available; /* Extra info available if not zero */
194 unsigned extra_parent_id; /* The parent object */
195 unsigned extra_is_shrink; /* Is it a shrink header? */
196 unsigned extra_shadows; /* Does this shadow another object? */
198 enum yaffs_obj_type extra_obj_type; /* What object type? */
200 loff_t extra_file_size; /* Length if it is a file */
201 unsigned extra_equiv_id; /* Equivalent object for a hard link */
204 /* Spare structure for YAFFS1 */
210 u8 page_status; /* set to 0 to delete the chunk */
220 /*Special structure for passing through to mtd */
221 struct yaffs_nand_spare {
222 struct yaffs_spare spare;
227 /* Block data in RAM */
229 enum yaffs_block_state {
230 YAFFS_BLOCK_STATE_UNKNOWN = 0,
232 YAFFS_BLOCK_STATE_SCANNING,
235 YAFFS_BLOCK_STATE_NEEDS_SCAN,
236 /* The block might have something on it (ie it is allocating or full,
237 * perhaps empty) but it needs to be scanned to determine its true
239 * This state is only valid during scanning.
240 * NB We tolerate empty because the pre-scanner might be incapable of
242 * However, if this state is returned on a YAFFS2 device,
243 * then we expect a sequence number
246 YAFFS_BLOCK_STATE_EMPTY,
247 /* This block is empty */
249 YAFFS_BLOCK_STATE_ALLOCATING,
250 /* This block is partially allocated.
251 * At least one page holds valid data.
252 * This is the one currently being used for page
253 * allocation. Should never be more than one of these.
254 * If a block is only partially allocated at mount it is treated as
258 YAFFS_BLOCK_STATE_FULL,
259 /* All the pages in this block have been allocated.
260 * If a block was only partially allocated when mounted we treat
261 * it as fully allocated.
264 YAFFS_BLOCK_STATE_DIRTY,
265 /* The block was full and now all chunks have been deleted.
266 * Erase me, reuse me.
269 YAFFS_BLOCK_STATE_CHECKPOINT,
270 /* This block is assigned to holding checkpoint data. */
272 YAFFS_BLOCK_STATE_COLLECTING,
273 /* This block is being garbage collected */
275 YAFFS_BLOCK_STATE_DEAD
276 /* This block has failed and is not in use */
279 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
281 struct yaffs_block_info {
283 int soft_del_pages:10; /* number of soft deleted pages */
284 int pages_in_use:10; /* number of pages in use */
285 unsigned block_state:4; /* One of the above block states. */
286 /* NB use unsigned because enum is sometimes
288 u32 needs_retiring:1; /* Data has failed on this block, */
289 /*need to get valid data off and retire*/
290 u32 skip_erased_check:1;/* Skip the erased check on this block */
291 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
292 Block should be prioritised for GC */
293 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
294 failures on this block and tried to reuse it */
295 u32 has_summary:1; /* The block has a summary */
297 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
298 u32 seq_number; /* block sequence number for yaffs2 */
302 /* -------------------------- Object structure -------------------------------*/
303 /* This is the object structure as stored on NAND */
305 struct yaffs_obj_hdr {
306 enum yaffs_obj_type type;
308 /* Apply to everything */
310 u16 sum_no_longer_used; /* checksum of name. No longer used */
311 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
313 /* The following apply to all object types except for hard links */
314 u32 yst_mode; /* protection */
322 /* File size applies to files only */
325 /* Equivalent object id applies to hard links only. */
328 /* Alias is for symlinks only. */
329 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
331 u32 yst_rdev; /* stuff for block and char devices (major/min) */
337 u32 inband_shadowed_obj_id;
338 u32 inband_is_shrink;
342 int shadows_obj; /* This object header shadows the
343 specified object if > 0 */
345 /* is_shrink applies to object headers written when wemake a hole. */
350 /*--------------------------- Tnode -------------------------- */
353 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
356 /*------------------------ Object -----------------------------*/
357 /* An object can be one of:
358 * - a directory (no data, has children links
359 * - a regular file (data.... not prunes :->).
360 * - a symlink [symbolic link] (the alias).
364 struct yaffs_file_var {
369 struct yaffs_tnode *top;
372 struct yaffs_dir_var {
373 struct list_head children; /* list of child links */
374 struct list_head dirty; /* Entry for list of dirty directories */
377 struct yaffs_symlink_var {
381 struct yaffs_hardlink_var {
382 struct yaffs_obj *equiv_obj;
386 union yaffs_obj_var {
387 struct yaffs_file_var file_variant;
388 struct yaffs_dir_var dir_variant;
389 struct yaffs_symlink_var symlink_variant;
390 struct yaffs_hardlink_var hardlink_variant;
394 u8 deleted:1; /* This should only apply to unlinked files. */
395 u8 soft_del:1; /* it has also been soft deleted */
396 u8 unlinked:1; /* An unlinked file.*/
397 u8 fake:1; /* A fake object has no presence on NAND. */
398 u8 rename_allowed:1; /* Some objects cannot be renamed. */
400 u8 dirty:1; /* the object needs to be written to flash */
401 u8 valid:1; /* When the file system is being loaded up, this
402 * object might be created before the data
404 * ie. file data chunks encountered before
407 u8 lazy_loaded:1; /* This object has been lazy loaded and
408 * is missing some detail */
410 u8 defered_free:1; /* Object is removed from NAND, but is
411 * still in the inode cache.
412 * Free of object is defered.
413 * until the inode is released.
415 u8 being_created:1; /* This object is still being created
416 * so skip some verification checks. */
417 u8 is_shadowed:1; /* This object is shadowed on the way
418 * to being renamed. */
420 u8 xattr_known:1; /* We know if this has object has xattribs
422 u8 has_xattr:1; /* This object has xattribs.
423 * Only valid if xattr_known. */
425 u8 serial; /* serial number of chunk in NAND.*/
426 u16 sum; /* sum of the name to speed searching */
428 struct yaffs_dev *my_dev; /* The device I'm on */
430 struct list_head hash_link; /* list of objects in hash bucket */
432 struct list_head hard_links; /* hard linked object chain*/
434 /* directory structure stuff */
435 /* also used for linking up the free list */
436 struct yaffs_obj *parent;
437 struct list_head siblings;
439 /* Where's my object header in NAND? */
442 int n_data_chunks; /* Number of data chunks for this file. */
444 u32 obj_id; /* the object id value */
448 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
450 #ifdef CONFIG_YAFFS_WINCE
466 enum yaffs_obj_type variant_type;
468 union yaffs_obj_var variant;
472 struct yaffs_obj_bucket {
473 struct list_head list;
477 /* yaffs_checkpt_obj holds the definition of an object as dumped
481 struct yaffs_checkpt_obj {
486 enum yaffs_obj_type variant_type:3;
495 loff_t size_or_equiv_obj;
498 /*--------------------- Temporary buffers ----------------
500 * These are chunk-sized working buffers. Each device has a few.
503 struct yaffs_buffer {
508 /*----------------- Device ---------------------------------*/
514 * Entry parameters set up way early. Yaffs sets up the rest.
515 * The structure should be zeroed out before use so that unused
516 * and defualt values are zero.
519 int inband_tags; /* Use unband tags */
520 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
522 int chunks_per_block; /* does not need to be a power of 2 */
523 int spare_bytes_per_chunk; /* spare area size */
524 int start_block; /* Start block we're allowed to use */
525 int end_block; /* End block we're allowed to use */
526 int n_reserved_blocks; /* Tuneable so that we can reduce
527 * reserved blocks on NOR and RAM. */
529 int n_caches; /* If <= 0, then short op caching is disabled,
530 * else the number of short op caches.
532 int use_nand_ecc; /* Flag to decide whether or not to use
533 * NAND driver ECC on data (yaffs1) */
534 int tags_9bytes; /* Use 9 byte tags */
535 int no_tags_ecc; /* Flag to decide whether or not to do ECC
536 * on packed tags (yaffs2) */
538 int is_yaffs2; /* Use yaffs2 mode on this device */
540 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
542 int refresh_period; /* How often to check for a block refresh */
544 /* Checkpoint control. Can be set before or after initialisation */
548 int enable_xattr; /* Enable xattribs */
550 /* NAND access functions (Must be set before calling YAFFS) */
552 int (*write_chunk_fn) (struct yaffs_dev *dev,
553 int nand_chunk, const u8 *data,
554 const struct yaffs_spare *spare);
555 int (*read_chunk_fn) (struct yaffs_dev *dev,
556 int nand_chunk, u8 *data,
557 struct yaffs_spare *spare);
558 int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
559 int (*initialise_flash_fn) (struct yaffs_dev *dev);
560 int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
562 /* yaffs2 mode functions */
563 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
564 int nand_chunk, const u8 *data,
565 const struct yaffs_ext_tags *tags);
566 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
567 int nand_chunk, u8 *data,
568 struct yaffs_ext_tags *tags);
569 int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
570 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
571 enum yaffs_block_state *state,
574 /* The remove_obj_fn function must be supplied by OS flavours that
576 * yaffs direct uses it to implement the faster readdir.
577 * Linux uses it to protect the directory during unlocking.
579 void (*remove_obj_fn) (struct yaffs_obj *obj);
581 /* Callback to mark the superblock dirty */
582 void (*sb_dirty_fn) (struct yaffs_dev *dev);
584 /* Callback to control garbage collection. */
585 unsigned (*gc_control) (struct yaffs_dev *dev);
587 /* Debug control flags. Don't use unless you know what you're doing */
588 int use_header_file_size; /* Flag to determine if we should use
589 * file sizes from the header */
590 int disable_lazy_load; /* Disable lazy loading on this device */
591 int wide_tnodes_disabled; /* Set to disable wide tnodes */
592 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
595 int defered_dir_update; /* Set to defer directory updates */
597 #ifdef CONFIG_YAFFS_AUTO_UNICODE
600 int always_check_erased; /* Force chunk erased check always on */
606 struct yaffs_param param;
608 /* Context storage. Holds extra OS specific data for this device */
611 void *driver_context;
613 struct list_head dev_list;
615 /* Runtime parameters. Set up by YAFFS. */
616 int data_bytes_per_chunk;
618 /* Non-wide tnode stuff */
619 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
620 * the tnodes are not wide enough.
622 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
624 /* Stuff to support wide tnodes */
629 /* Stuff for figuring out file offset to chunk conversions */
630 u32 chunk_shift; /* Shift value */
631 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
632 u32 chunk_mask; /* Mask to use for power-of-2 case */
638 /* Stuff to support block offsetting to support start block zero */
639 int internal_start_block;
640 int internal_end_block;
644 /* Runtime checkpointing stuff */
645 int checkpt_page_seq; /* running sequence number of checkpt pages */
646 int checkpt_byte_count;
647 int checkpt_byte_offs;
649 int checkpt_open_write;
650 int blocks_in_checkpt;
651 int checkpt_cur_chunk;
652 int checkpt_cur_block;
653 int checkpt_next_block;
654 int *checkpt_block_list;
655 int checkpt_max_blocks;
659 int checkpoint_blocks_required; /* Number of blocks needed to store
660 * current checkpoint set */
663 struct yaffs_block_info *block_info;
664 u8 *chunk_bits; /* bitmap of chunks in use */
665 unsigned block_info_alt:1; /* allocated using alternative alloc */
666 unsigned chunk_bits_alt:1; /* allocated using alternative alloc */
667 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
668 * Must be consistent with chunks_per_block.
672 int alloc_block; /* Current block being allocated off */
674 int alloc_block_finder; /* Used to search for next allocation block */
676 /* Object and Tnode memory management */
683 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
688 /* Garbage collection control */
689 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
692 unsigned has_pending_prioritised_gc; /* We think this device might
693 have pending prioritised gcs */
695 unsigned gc_block_finder;
696 unsigned gc_dirtiest;
697 unsigned gc_pages_in_use;
698 unsigned gc_not_done;
702 struct yaffs_summary_tags *gc_sum_tags;
704 /* Special directories */
705 struct yaffs_obj *root_dir;
706 struct yaffs_obj *lost_n_found;
708 int buffered_block; /* Which block is buffered here? */
709 int doing_buffered_block_rewrite;
711 struct yaffs_cache *cache;
714 /* Stuff for background deletion and unlinked files. */
715 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
717 struct yaffs_obj *del_dir; /* Directory where deleted objects are
718 sent to disappear. */
719 struct yaffs_obj *unlinked_deletion; /* Current file being
720 background deleted. */
721 int n_deleted_files; /* Count of files awaiting deletion; */
722 int n_unlinked_files; /* Count of unlinked files. */
723 int n_bg_deletions; /* Count of background deletions. */
725 /* Temporary buffer management */
726 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
729 int unmanaged_buffer_allocs;
730 int unmanaged_buffer_deallocs;
732 /* yaffs2 runtime stuff */
733 unsigned seq_number; /* Sequence number of currently
735 unsigned oldest_dirty_seq;
736 unsigned oldest_dirty_block;
738 /* Block refreshing */
739 int refresh_skip; /* A skip down counter.
740 * Refresh happens when this gets to zero. */
742 /* Dirty directory handling */
743 struct list_head dirty_dirs; /* List of dirty directories */
746 int chunks_per_summary;
747 struct yaffs_summary_tags *sum_tags;
753 u32 n_erase_failures;
756 u32 passive_gc_count;
757 u32 oldest_dirty_gc_count;
760 u32 n_retried_writes;
761 u32 n_retired_blocks;
764 u32 n_tags_ecc_fixed;
765 u32 n_tags_ecc_unfixed;
767 u32 n_unmarked_deletions;
775 /* The CheckpointDevice structure holds the device information that changes
776 *at runtime and must be preserved over unmount/mount cycles.
778 struct yaffs_checkpt_dev {
781 int alloc_block; /* Current block being allocated off */
785 int n_deleted_files; /* Count of files awaiting deletion; */
786 int n_unlinked_files; /* Count of unlinked files. */
787 int n_bg_deletions; /* Count of background deletions. */
789 /* yaffs2 runtime stuff */
790 unsigned seq_number; /* Sequence number of currently
791 * allocating block */
795 struct yaffs_checkpt_validity {
802 struct yaffs_shadow_fixer {
805 struct yaffs_shadow_fixer *next;
808 /* Structure for doing xattr modifications */
809 struct yaffs_xattr_mod {
810 int set; /* If 0 then this is a deletion */
818 /*----------------------- YAFFS Functions -----------------------*/
820 int yaffs_guts_initialise(struct yaffs_dev *dev);
821 void yaffs_deinitialise(struct yaffs_dev *dev);
823 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
825 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
826 struct yaffs_obj *new_dir, const YCHAR * new_name);
828 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
829 int yaffs_del_obj(struct yaffs_obj *obj);
831 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
832 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
833 int yaffs_get_obj_inode(struct yaffs_obj *obj);
834 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
835 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
837 /* File operations */
838 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
840 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
841 int n_bytes, int write_trhrough);
842 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
844 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
845 const YCHAR *name, u32 mode, u32 uid,
848 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
850 /* Flushing and checkpointing */
851 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
853 int yaffs_checkpoint_save(struct yaffs_dev *dev);
854 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
856 /* Directory operations */
857 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
858 u32 mode, u32 uid, u32 gid);
859 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
861 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
863 /* Link operations */
864 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
865 struct yaffs_obj *equiv_obj);
867 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
869 /* Symlink operations */
870 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
871 const YCHAR *name, u32 mode, u32 uid,
872 u32 gid, const YCHAR *alias);
873 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
875 /* Special inodes (fifos, sockets and devices) */
876 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
877 const YCHAR *name, u32 mode, u32 uid,
880 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
881 const void *value, int size, int flags);
882 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
884 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
885 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
887 /* Special directories */
888 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
889 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
891 void yaffs_handle_defered_free(struct yaffs_obj *obj);
893 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
895 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
898 int yaffs_dump_obj(struct yaffs_obj *obj);
900 void yaffs_guts_test(struct yaffs_dev *dev);
902 /* A few useful functions to be used within the core files*/
903 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
905 int yaffs_check_ff(u8 *buffer, int n_bytes);
906 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
907 struct yaffs_block_info *bi);
909 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
910 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
912 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
914 enum yaffs_obj_type type);
915 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
916 int nand_chunk, int in_scan);
917 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
918 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
919 const struct yaffs_obj_hdr *oh);
920 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
921 YCHAR *yaffs_clone_str(const YCHAR *str);
922 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
923 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
924 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
925 int force, int is_shrink, int shadows,
926 struct yaffs_xattr_mod *xop);
927 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
928 int backward_scanning);
929 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
930 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
931 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
932 struct yaffs_file_var *file_struct,
934 struct yaffs_tnode *passed_tn);
936 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
937 int n_bytes, int write_trhrough);
938 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
939 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
941 int yaffs_count_free_chunks(struct yaffs_dev *dev);
943 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
944 struct yaffs_file_var *file_struct,
947 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
950 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
953 * Marshalling functions to get loff_t file sizes into aand out of
956 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize);
957 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh);