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
32 #define YAFFS_NTNODES_LEVEL0 16
33 #define YAFFS_TNODES_LEVEL0_BITS 4
34 #define YAFFS_TNODES_LEVEL0_MASK 0xf
36 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
37 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
38 #define YAFFS_TNODES_INTERNAL_MASK 0x7
39 #define YAFFS_TNODES_MAX_LEVEL 6
41 #ifndef CONFIG_YAFFS_NO_YAFFS1
42 #define YAFFS_BYTES_PER_SPARE 16
43 #define YAFFS_BYTES_PER_CHUNK 512
44 #define YAFFS_CHUNK_SIZE_SHIFT 9
45 #define YAFFS_CHUNKS_PER_BLOCK 32
46 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
49 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
50 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
52 #define YAFFS_MAX_CHUNK_ID 0x000fffff
54 #define YAFFS_ALLOCATION_NOBJECTS 100
55 #define YAFFS_ALLOCATION_NTNODES 100
56 #define YAFFS_ALLOCATION_NLINKS 100
58 #define YAFFS_NOBJECT_BUCKETS 256
60 #define YAFFS_OBJECT_SPACE 0x40000
61 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE - 1)
63 #define YAFFS_CHECKPOINT_VERSION 4
65 #ifdef CONFIG_YAFFS_UNICODE
66 #define YAFFS_MAX_NAME_LENGTH 127
67 #define YAFFS_MAX_ALIAS_LENGTH 79
69 #define YAFFS_MAX_NAME_LENGTH 255
70 #define YAFFS_MAX_ALIAS_LENGTH 159
73 #define YAFFS_SHORT_NAME_LENGTH 15
75 /* Some special object ids for pseudo objects */
76 #define YAFFS_OBJECTID_ROOT 1
77 #define YAFFS_OBJECTID_LOSTNFOUND 2
78 #define YAFFS_OBJECTID_UNLINKED 3
79 #define YAFFS_OBJECTID_DELETED 4
81 /* Fake object Id for summary data */
82 #define YAFFS_OBJECTID_SUMMARY 0x10
84 /* Pseudo object ids for checkpointing */
85 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
86 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
88 #define YAFFS_MAX_SHORT_OP_CACHES 20
90 #define YAFFS_N_TEMP_BUFFERS 6
92 /* We limit the number attempts at sucessfully saving a chunk of data.
93 * Small-page devices have 32 pages per block; large-page devices have 64.
94 * Default to something in the order of 5 to 10 blocks worth of chunks.
96 #define YAFFS_WR_ATTEMPTS (5*64)
98 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
99 * The range is limited slightly to help distinguish bad numbers from good.
100 * This also allows us to perhaps in the future use special numbers for
102 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
103 * and is a larger number than the lifetime of a 2GB device.
105 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
106 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
108 /* Special sequence number for bad block that failed to be marked bad */
109 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
111 /* ChunkCache is used for short read/write operations.*/
113 struct yaffs_obj *object;
117 int n_bytes; /* Only valid if the cache is dirty */
118 int locked; /* Can't push out or flush while locked. */
122 /* Tags structures in RAM
123 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
124 * otherwise the structure size will get blown out.
127 #ifndef CONFIG_YAFFS_NO_YAFFS1
129 unsigned chunk_id:20;
130 unsigned serial_number:2;
131 unsigned n_bytes_lsb:10;
134 unsigned n_bytes_msb:2;
137 union yaffs_tags_union {
138 struct yaffs_tags as_tags;
144 /* Stuff used for extended tags in YAFFS2 */
146 enum yaffs_ecc_result {
147 YAFFS_ECC_RESULT_UNKNOWN,
148 YAFFS_ECC_RESULT_NO_ERROR,
149 YAFFS_ECC_RESULT_FIXED,
150 YAFFS_ECC_RESULT_UNFIXED
153 enum yaffs_obj_type {
154 YAFFS_OBJECT_TYPE_UNKNOWN,
155 YAFFS_OBJECT_TYPE_FILE,
156 YAFFS_OBJECT_TYPE_SYMLINK,
157 YAFFS_OBJECT_TYPE_DIRECTORY,
158 YAFFS_OBJECT_TYPE_HARDLINK,
159 YAFFS_OBJECT_TYPE_SPECIAL
162 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
164 struct yaffs_ext_tags {
165 unsigned chunk_used; /* Status of the chunk: used or unused */
166 unsigned obj_id; /* If 0 this is not used */
167 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
168 unsigned n_bytes; /* Only valid for data chunks */
170 /* The following stuff only has meaning when we read */
171 enum yaffs_ecc_result ecc_result;
175 unsigned is_deleted; /* The chunk is marked deleted */
176 unsigned serial_number; /* Yaffs1 2-bit serial number */
179 unsigned seq_number; /* The sequence number of this block */
181 /* Extra info if this is an object header (YAFFS2 only) */
183 unsigned extra_available; /* Extra info available if not zero */
184 unsigned extra_parent_id; /* The parent object */
185 unsigned extra_is_shrink; /* Is it a shrink header? */
186 unsigned extra_shadows; /* Does this shadow another object? */
188 enum yaffs_obj_type extra_obj_type; /* What object type? */
190 unsigned extra_length; /* Length if it is a file */
191 unsigned extra_equiv_id; /* Equivalent object for a hard link */
194 /* Spare structure for YAFFS1 */
200 u8 page_status; /* set to 0 to delete the chunk */
210 /*Special structure for passing through to mtd */
211 struct yaffs_nand_spare {
212 struct yaffs_spare spare;
217 /* Block data in RAM */
219 enum yaffs_block_state {
220 YAFFS_BLOCK_STATE_UNKNOWN = 0,
222 YAFFS_BLOCK_STATE_SCANNING,
225 YAFFS_BLOCK_STATE_NEEDS_SCAN,
226 /* The block might have something on it (ie it is allocating or full,
227 * perhaps empty) but it needs to be scanned to determine its true
229 * This state is only valid during scanning.
230 * NB We tolerate empty because the pre-scanner might be incapable of
232 * However, if this state is returned on a YAFFS2 device,
233 * then we expect a sequence number
236 YAFFS_BLOCK_STATE_EMPTY,
237 /* This block is empty */
239 YAFFS_BLOCK_STATE_ALLOCATING,
240 /* This block is partially allocated.
241 * At least one page holds valid data.
242 * This is the one currently being used for page
243 * allocation. Should never be more than one of these.
244 * If a block is only partially allocated at mount it is treated as
248 YAFFS_BLOCK_STATE_FULL,
249 /* All the pages in this block have been allocated.
250 * If a block was only partially allocated when mounted we treat
251 * it as fully allocated.
254 YAFFS_BLOCK_STATE_DIRTY,
255 /* The block was full and now all chunks have been deleted.
256 * Erase me, reuse me.
259 YAFFS_BLOCK_STATE_CHECKPOINT,
260 /* This block is assigned to holding checkpoint data. */
262 YAFFS_BLOCK_STATE_COLLECTING,
263 /* This block is being garbage collected */
265 YAFFS_BLOCK_STATE_DEAD
266 /* This block has failed and is not in use */
269 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
271 struct yaffs_block_info {
273 int soft_del_pages:10; /* number of soft deleted pages */
274 int pages_in_use:10; /* number of pages in use */
275 unsigned block_state:4; /* One of the above block states. */
276 /* NB use unsigned because enum is sometimes
278 u32 needs_retiring:1; /* Data has failed on this block, */
279 /*need to get valid data off and retire*/
280 u32 skip_erased_check:1;/* Skip the erased check on this block */
281 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
282 Block should be prioritised for GC */
283 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
284 failures on this block and tried to reuse it */
285 u32 has_summary:1; /* The block has a summary */
287 #ifdef CONFIG_YAFFS_YAFFS2
288 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
289 u32 seq_number; /* block sequence number for yaffs2 */
294 /* -------------------------- Object structure -------------------------------*/
295 /* This is the object structure as stored on NAND */
297 struct yaffs_obj_hdr {
298 enum yaffs_obj_type type;
300 /* Apply to everything */
302 u16 sum_no_longer_used; /* checksum of name. No longer used */
303 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
305 /* The following apply to all object types except for hard links */
306 u32 yst_mode; /* protection */
314 /* File size applies to files only */
317 /* Equivalent object id applies to hard links only. */
320 /* Alias is for symlinks only. */
321 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
323 u32 yst_rdev; /* stuff for block and char devices (major/min) */
329 u32 inband_shadowed_obj_id;
330 u32 inband_is_shrink;
333 int shadows_obj; /* This object header shadows the
334 specified object if > 0 */
336 /* is_shrink applies to object headers written when wemake a hole. */
341 /*--------------------------- Tnode -------------------------- */
344 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
347 /*------------------------ Object -----------------------------*/
348 /* An object can be one of:
349 * - a directory (no data, has children links
350 * - a regular file (data.... not prunes :->).
351 * - a symlink [symbolic link] (the alias).
355 struct yaffs_file_var {
360 struct yaffs_tnode *top;
363 struct yaffs_dir_var {
364 struct list_head children; /* list of child links */
365 struct list_head dirty; /* Entry for list of dirty directories */
368 struct yaffs_symlink_var {
372 struct yaffs_hardlink_var {
373 struct yaffs_obj *equiv_obj;
377 union yaffs_obj_var {
378 struct yaffs_file_var file_variant;
379 struct yaffs_dir_var dir_variant;
380 struct yaffs_symlink_var symlink_variant;
381 struct yaffs_hardlink_var hardlink_variant;
385 u8 deleted:1; /* This should only apply to unlinked files. */
386 u8 soft_del:1; /* it has also been soft deleted */
387 u8 unlinked:1; /* An unlinked file.*/
388 u8 fake:1; /* A fake object has no presence on NAND. */
389 u8 rename_allowed:1; /* Some objects cannot be renamed. */
391 u8 dirty:1; /* the object needs to be written to flash */
392 u8 valid:1; /* When the file system is being loaded up, this
393 * object might be created before the data
395 * ie. file data chunks encountered before
398 u8 lazy_loaded:1; /* This object has been lazy loaded and
399 * is missing some detail */
401 u8 defered_free:1; /* Object is removed from NAND, but is
402 * still in the inode cache.
403 * Free of object is defered.
404 * until the inode is released.
406 u8 being_created:1; /* This object is still being created
407 * so skip some verification checks. */
408 u8 is_shadowed:1; /* This object is shadowed on the way
409 * to being renamed. */
411 u8 xattr_known:1; /* We know if this has object has xattribs
413 u8 has_xattr:1; /* This object has xattribs.
414 * Only valid if xattr_known. */
416 u8 serial; /* serial number of chunk in NAND.*/
417 u16 sum; /* sum of the name to speed searching */
419 struct yaffs_dev *my_dev; /* The device I'm on */
421 struct list_head hash_link; /* list of objects in hash bucket */
423 struct list_head hard_links; /* hard linked object chain*/
425 /* directory structure stuff */
426 /* also used for linking up the free list */
427 struct yaffs_obj *parent;
428 struct list_head siblings;
430 /* Where's my object header in NAND? */
433 int n_data_chunks; /* Number of data chunks for this file. */
435 u32 obj_id; /* the object id value */
439 #ifndef CONFIG_YAFFS_NO_SHORT_NAMES
440 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
443 #ifdef CONFIG_YAFFS_WINCE
459 enum yaffs_obj_type variant_type;
461 union yaffs_obj_var variant;
465 struct yaffs_obj_bucket {
466 struct list_head list;
470 /* yaffs_checkpt_obj holds the definition of an object as dumped
474 struct yaffs_checkpt_obj {
479 enum yaffs_obj_type variant_type:3;
488 u32 size_or_equiv_obj;
491 /*--------------------- Temporary buffers ----------------
493 * These are chunk-sized working buffers. Each device has a few.
496 struct yaffs_buffer {
501 /*----------------- Device ---------------------------------*/
507 * Entry parameters set up way early. Yaffs sets up the rest.
508 * The structure should be zeroed out before use so that unused
509 * and defualt values are zero.
512 int inband_tags; /* Use unband tags */
513 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
515 int chunks_per_block; /* does not need to be a power of 2 */
516 int spare_bytes_per_chunk; /* spare area size */
517 int start_block; /* Start block we're allowed to use */
518 int end_block; /* End block we're allowed to use */
519 int n_reserved_blocks; /* Tuneable so that we can reduce
520 * reserved blocks on NOR and RAM. */
522 int n_caches; /* If <= 0, then short op caching is disabled,
523 * else the number of short op caches.
525 int use_nand_ecc; /* Flag to decide whether or not to use
526 * NAND driver ECC on data (yaffs1) */
527 int no_tags_ecc; /* Flag to decide whether or not to do ECC
528 * on packed tags (yaffs2) */
530 int is_yaffs2; /* Use yaffs2 mode on this device */
532 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
534 int refresh_period; /* How often to check for a block refresh */
536 /* Checkpoint control. Can be set before or after initialisation */
540 int enable_xattr; /* Enable xattribs */
542 /* NAND access functions (Must be set before calling YAFFS) */
544 int (*write_chunk_fn) (struct yaffs_dev *dev,
545 int nand_chunk, const u8 *data,
546 const struct yaffs_spare *spare);
547 int (*read_chunk_fn) (struct yaffs_dev *dev,
548 int nand_chunk, u8 *data,
549 struct yaffs_spare *spare);
550 int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
551 int (*initialise_flash_fn) (struct yaffs_dev *dev);
552 int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
554 #ifdef CONFIG_YAFFS_YAFFS2
555 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
556 int nand_chunk, const u8 *data,
557 const struct yaffs_ext_tags *tags);
558 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
559 int nand_chunk, u8 *data,
560 struct yaffs_ext_tags *tags);
561 int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
562 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
563 enum yaffs_block_state *state,
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) (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 */
599 struct yaffs_param param;
601 /* Context storage. Holds extra OS specific data for this device */
604 void *driver_context;
606 struct list_head dev_list;
608 /* Runtime parameters. Set up by YAFFS. */
609 int data_bytes_per_chunk;
611 /* Non-wide tnode stuff */
612 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
613 * the tnodes are not wide enough.
615 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
617 /* Stuff to support wide tnodes */
622 /* Stuff for figuring out file offset to chunk conversions */
623 u32 chunk_shift; /* Shift value */
624 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
625 u32 chunk_mask; /* Mask to use for power-of-2 case */
631 /* Stuff to support block offsetting to support start block zero */
632 int internal_start_block;
633 int internal_end_block;
637 /* Runtime checkpointing stuff */
638 int checkpt_page_seq; /* running sequence number of checkpt pages */
639 int checkpt_byte_count;
640 int checkpt_byte_offs;
642 int checkpt_open_write;
643 int blocks_in_checkpt;
644 int checkpt_cur_chunk;
645 int checkpt_cur_block;
646 int checkpt_next_block;
647 int *checkpt_block_list;
648 int checkpt_max_blocks;
652 int checkpoint_blocks_required; /* Number of blocks needed to store
653 * current checkpoint set */
656 struct yaffs_block_info *block_info;
657 u8 *chunk_bits; /* bitmap of chunks in use */
658 unsigned block_info_alt:1; /* allocated using alternative alloc */
659 unsigned chunk_bits_alt:1; /* allocated using alternative alloc */
660 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
661 * Must be consistent with chunks_per_block.
665 int alloc_block; /* Current block being allocated off */
667 int alloc_block_finder; /* Used to search for next allocation block */
669 /* Object and Tnode memory management */
676 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
681 /* Garbage collection control */
682 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
685 unsigned has_pending_prioritised_gc; /* We think this device might
686 have pending prioritised gcs */
688 unsigned gc_block_finder;
689 unsigned gc_dirtiest;
690 unsigned gc_pages_in_use;
691 unsigned gc_not_done;
695 struct yaffs_summary_tags *gc_sum_tags;
697 /* Special directories */
698 struct yaffs_obj *root_dir;
699 struct yaffs_obj *lost_n_found;
701 int buffered_block; /* Which block is buffered here? */
702 int doing_buffered_block_rewrite;
704 struct yaffs_cache *cache;
707 /* Stuff for background deletion and unlinked files. */
708 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
710 struct yaffs_obj *del_dir; /* Directory where deleted objects are
711 sent to disappear. */
712 struct yaffs_obj *unlinked_deletion; /* Current file being
713 background deleted. */
714 int n_deleted_files; /* Count of files awaiting deletion; */
715 int n_unlinked_files; /* Count of unlinked files. */
716 int n_bg_deletions; /* Count of background deletions. */
718 /* Temporary buffer management */
719 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
722 int unmanaged_buffer_allocs;
723 int unmanaged_buffer_deallocs;
725 /* yaffs2 runtime stuff */
726 unsigned seq_number; /* Sequence number of currently
728 unsigned oldest_dirty_seq;
729 unsigned oldest_dirty_block;
731 /* Block refreshing */
732 int refresh_skip; /* A skip down counter.
733 * Refresh happens when this gets to zero. */
735 /* Dirty directory handling */
736 struct list_head dirty_dirs; /* List of dirty directories */
739 int chunks_per_summary;
740 struct yaffs_summary_tags *sum_tags;
746 u32 n_erase_failures;
749 u32 passive_gc_count;
750 u32 oldest_dirty_gc_count;
753 u32 n_retired_writes;
754 u32 n_retired_blocks;
757 u32 n_tags_ecc_fixed;
758 u32 n_tags_ecc_unfixed;
760 u32 n_unmarked_deletions;
768 /* The CheckpointDevice structure holds the device information that changes
769 *at runtime and must be preserved over unmount/mount cycles.
771 struct yaffs_checkpt_dev {
774 int alloc_block; /* Current block being allocated off */
778 int n_deleted_files; /* Count of files awaiting deletion; */
779 int n_unlinked_files; /* Count of unlinked files. */
780 int n_bg_deletions; /* Count of background deletions. */
782 /* yaffs2 runtime stuff */
783 unsigned seq_number; /* Sequence number of currently
784 * allocating block */
788 struct yaffs_checkpt_validity {
795 struct yaffs_shadow_fixer {
798 struct yaffs_shadow_fixer *next;
801 /* Structure for doing xattr modifications */
802 struct yaffs_xattr_mod {
803 int set; /* If 0 then this is a deletion */
811 /*----------------------- YAFFS Functions -----------------------*/
813 int yaffs_guts_initialise(struct yaffs_dev *dev);
814 void yaffs_deinitialise(struct yaffs_dev *dev);
816 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
818 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
819 struct yaffs_obj *new_dir, const YCHAR * new_name);
821 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
822 int yaffs_del_obj(struct yaffs_obj *obj);
824 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
825 int yaffs_get_obj_length(struct yaffs_obj *obj);
826 int yaffs_get_obj_inode(struct yaffs_obj *obj);
827 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
828 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
830 /* File operations */
831 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
833 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
834 int n_bytes, int write_trhrough);
835 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
837 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
838 const YCHAR *name, u32 mode, u32 uid,
841 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
843 /* Flushing and checkpointing */
844 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
846 int yaffs_checkpoint_save(struct yaffs_dev *dev);
847 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
849 /* Directory operations */
850 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
851 u32 mode, u32 uid, u32 gid);
852 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
854 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
856 /* Link operations */
857 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
858 struct yaffs_obj *equiv_obj);
860 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
862 /* Symlink operations */
863 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
864 const YCHAR *name, u32 mode, u32 uid,
865 u32 gid, const YCHAR *alias);
866 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
868 /* Special inodes (fifos, sockets and devices) */
869 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
870 const YCHAR *name, u32 mode, u32 uid,
873 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
874 const void *value, int size, int flags);
875 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
877 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
878 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
880 /* Special directories */
881 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
882 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
884 void yaffs_handle_defered_free(struct yaffs_obj *obj);
886 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
888 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
891 int yaffs_dump_obj(struct yaffs_obj *obj);
893 void yaffs_guts_test(struct yaffs_dev *dev);
895 /* A few useful functions to be used within the core files*/
896 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
898 int yaffs_check_ff(u8 *buffer, int n_bytes);
899 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
900 struct yaffs_block_info *bi);
902 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
903 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
905 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
907 enum yaffs_obj_type type);
908 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
909 int nand_chunk, int in_scan);
910 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
911 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
912 const struct yaffs_obj_hdr *oh);
913 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
914 YCHAR *yaffs_clone_str(const YCHAR *str);
915 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
916 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
917 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
918 int force, int is_shrink, int shadows,
919 struct yaffs_xattr_mod *xop);
920 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
921 int backward_scanning);
922 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
923 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
924 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
925 struct yaffs_file_var *file_struct,
927 struct yaffs_tnode *passed_tn);
929 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
930 int n_bytes, int write_trhrough);
931 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
932 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
934 int yaffs_count_free_chunks(struct yaffs_dev *dev);
936 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
937 struct yaffs_file_var *file_struct,
940 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
943 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);