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
42 /* Constants for YAFFS1 mode */
43 #define YAFFS_BYTES_PER_SPARE 16
44 #define YAFFS_BYTES_PER_CHUNK 512
45 #define YAFFS_CHUNK_SIZE_SHIFT 9
46 #define YAFFS_CHUNKS_PER_BLOCK 32
47 #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 /* Pseudo object ids for checkpointing */
82 #define YAFFS_OBJECTID_SB_HEADER 0x10
83 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
84 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
86 #define YAFFS_MAX_SHORT_OP_CACHES 20
88 #define YAFFS_N_TEMP_BUFFERS 6
90 /* We limit the number attempts at sucessfully saving a chunk of data.
91 * Small-page devices have 32 pages per block; large-page devices have 64.
92 * Default to something in the order of 5 to 10 blocks worth of chunks.
94 #define YAFFS_WR_ATTEMPTS (5*64)
96 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
97 * The range is limited slightly to help distinguish bad numbers from good.
98 * This also allows us to perhaps in the future use special numbers for
100 * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
101 * and is a larger number than the lifetime of a 2GB device.
103 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
104 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xefffff00
106 /* Special sequence number for bad block that failed to be marked bad */
107 #define YAFFS_SEQUENCE_BAD_BLOCK 0xffff0000
109 /* ChunkCache is used for short read/write operations.*/
111 struct yaffs_obj *object;
115 int n_bytes; /* Only valid if the cache is dirty */
116 int locked; /* Can't push out or flush while locked. */
120 /* yaffs1 tags structures in RAM
121 * NB This uses bitfield. Bitfields should not straddle a u32 boundary
122 * otherwise the structure size will get blown out.
126 unsigned chunk_id:20;
127 unsigned serial_number:2;
128 unsigned n_bytes_lsb:10;
131 unsigned n_bytes_msb:2;
134 union yaffs_tags_union {
135 struct yaffs_tags as_tags;
140 /* Stuff used for extended tags in YAFFS2 */
142 enum yaffs_ecc_result {
143 YAFFS_ECC_RESULT_UNKNOWN,
144 YAFFS_ECC_RESULT_NO_ERROR,
145 YAFFS_ECC_RESULT_FIXED,
146 YAFFS_ECC_RESULT_UNFIXED
149 enum yaffs_obj_type {
150 YAFFS_OBJECT_TYPE_UNKNOWN,
151 YAFFS_OBJECT_TYPE_FILE,
152 YAFFS_OBJECT_TYPE_SYMLINK,
153 YAFFS_OBJECT_TYPE_DIRECTORY,
154 YAFFS_OBJECT_TYPE_HARDLINK,
155 YAFFS_OBJECT_TYPE_SPECIAL
158 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
160 struct yaffs_ext_tags {
161 unsigned chunk_used; /* Status of the chunk: used or unused */
162 unsigned obj_id; /* If 0 this is not used */
163 unsigned chunk_id; /* If 0 this is a header, else a data chunk */
164 unsigned n_bytes; /* Only valid for data chunks */
166 /* The following stuff only has meaning when we read */
167 enum yaffs_ecc_result ecc_result;
171 unsigned is_deleted; /* The chunk is marked deleted */
172 unsigned serial_number; /* Yaffs1 2-bit serial number */
175 unsigned seq_number; /* The sequence number of this block */
177 /* Extra info if this is an object header (YAFFS2 only) */
179 unsigned extra_available; /* Extra info available if not zero */
180 unsigned extra_parent_id; /* The parent object */
181 unsigned extra_is_shrink; /* Is it a shrink header? */
182 unsigned extra_shadows; /* Does this shadow another object? */
184 enum yaffs_obj_type extra_obj_type; /* What object type? */
186 unsigned extra_length; /* Length if it is a file */
187 unsigned extra_equiv_id; /* Equivalent object for a hard link */
190 /* Spare structure for YAFFS1 */
196 u8 page_status; /* set to 0 to delete the chunk */
206 /*Special structure for passing through to mtd */
207 struct yaffs_nand_spare {
208 struct yaffs_spare spare;
213 /* Block data in RAM */
215 enum yaffs_block_state {
216 YAFFS_BLOCK_STATE_UNKNOWN = 0,
218 YAFFS_BLOCK_STATE_SCANNING,
221 YAFFS_BLOCK_STATE_NEEDS_SCAN,
222 /* The block might have something on it (ie it is allocating or full,
223 * perhaps empty) but it needs to be scanned to determine its true
225 * This state is only valid during scanning.
226 * NB We tolerate empty because the pre-scanner might be incapable of
228 * However, if this state is returned on a YAFFS2 device,
229 * then we expect a sequence number
232 YAFFS_BLOCK_STATE_EMPTY,
233 /* This block is empty */
235 YAFFS_BLOCK_STATE_ALLOCATING,
236 /* This block is partially allocated.
237 * At least one page holds valid data.
238 * This is the one currently being used for page
239 * allocation. Should never be more than one of these.
240 * If a block is only partially allocated at mount it is treated as
244 YAFFS_BLOCK_STATE_FULL,
245 /* All the pages in this block have been allocated.
246 * If a block was only partially allocated when mounted we treat
247 * it as fully allocated.
250 YAFFS_BLOCK_STATE_DIRTY,
251 /* The block was full and now all chunks have been deleted.
252 * Erase me, reuse me.
255 YAFFS_BLOCK_STATE_CHECKPOINT,
256 /* This block is assigned to holding checkpoint data. */
258 YAFFS_BLOCK_STATE_COLLECTING,
259 /* This block is being garbage collected */
261 YAFFS_BLOCK_STATE_DEAD
262 /* This block has failed and is not in use */
265 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
267 struct yaffs_block_info {
269 int soft_del_pages:10; /* number of soft deleted pages */
270 int pages_in_use:10; /* number of pages in use */
271 unsigned block_state:4; /* One of the above block states. */
272 /* NB use unsigned because enum is sometimes
274 u32 needs_retiring:1; /* Data has failed on this block, */
275 /*need to get valid data off and retire*/
276 u32 skip_erased_check:1;/* Skip the erased check on this block */
277 u32 gc_prioritise:1; /* An ECC check or blank check has failed.
278 Block should be prioritised for GC */
279 u32 chunk_error_strikes:3; /* How many times we've had ecc etc
280 failures on this block and tried to reuse it */
282 u32 has_shrink_hdr:1; /* This block has at least one shrink header */
283 u32 seq_number; /* block sequence number for yaffs2 */
287 /* -------------------------- Object structure -------------------------------*/
288 /* This is the object structure as stored on NAND */
290 struct yaffs_obj_hdr {
291 enum yaffs_obj_type type;
293 /* Apply to everything */
295 u16 sum_no_longer_used; /* checksum of name. No longer used */
296 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
298 /* The following apply to all object types except for hard links */
299 u32 yst_mode; /* protection */
307 /* File size applies to files only */
310 /* Equivalent object id applies to hard links only. */
313 /* Alias is for symlinks only. */
314 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
316 u32 yst_rdev; /* stuff for block and char devices (major/min) */
322 u32 inband_shadowed_obj_id;
323 u32 inband_is_shrink;
326 int shadows_obj; /* This object header shadows the
327 specified object if > 0 */
329 /* is_shrink applies to object headers written when wemake a hole. */
334 /*--------------------------- Tnode -------------------------- */
337 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
340 /*------------------------ Object -----------------------------*/
341 /* An object can be one of:
342 * - a directory (no data, has children links
343 * - a regular file (data.... not prunes :->).
344 * - a symlink [symbolic link] (the alias).
348 struct yaffs_file_var {
353 struct yaffs_tnode *top;
356 struct yaffs_dir_var {
357 struct list_head children; /* list of child links */
358 struct list_head dirty; /* Entry for list of dirty directories */
361 struct yaffs_symlink_var {
365 struct yaffs_hardlink_var {
366 struct yaffs_obj *equiv_obj;
370 union yaffs_obj_var {
371 struct yaffs_file_var file_variant;
372 struct yaffs_dir_var dir_variant;
373 struct yaffs_symlink_var symlink_variant;
374 struct yaffs_hardlink_var hardlink_variant;
378 u8 deleted:1; /* This should only apply to unlinked files. */
379 u8 soft_del:1; /* it has also been soft deleted */
380 u8 unlinked:1; /* An unlinked file.*/
381 u8 fake:1; /* A fake object has no presence on NAND. */
382 u8 rename_allowed:1; /* Some objects cannot be renamed. */
384 u8 dirty:1; /* the object needs to be written to flash */
385 u8 valid:1; /* When the file system is being loaded up, this
386 * object might be created before the data
388 * ie. file data chunks encountered before
391 u8 lazy_loaded:1; /* This object has been lazy loaded and
392 * is missing some detail */
394 u8 defered_free:1; /* Object is removed from NAND, but is
395 * still in the inode cache.
396 * Free of object is defered.
397 * until the inode is released.
399 u8 being_created:1; /* This object is still being created
400 * so skip some verification checks. */
401 u8 is_shadowed:1; /* This object is shadowed on the way
402 * to being renamed. */
404 u8 xattr_known:1; /* We know if this has object has xattribs
406 u8 has_xattr:1; /* This object has xattribs.
407 * Only valid if xattr_known. */
409 u8 serial; /* serial number of chunk in NAND.*/
410 u16 sum; /* sum of the name to speed searching */
412 struct yaffs_dev *my_dev; /* The device I'm on */
414 struct list_head hash_link; /* list of objects in hash bucket */
416 struct list_head hard_links; /* hard linked object chain*/
418 /* directory structure stuff */
419 /* also used for linking up the free list */
420 struct yaffs_obj *parent;
421 struct list_head siblings;
423 /* Where's my object header in NAND? */
426 int n_data_chunks; /* Number of data chunks for this file. */
428 u32 obj_id; /* the object id value */
432 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
434 #ifdef CONFIG_YAFFS_WINCE
450 enum yaffs_obj_type variant_type;
452 union yaffs_obj_var variant;
456 struct yaffs_obj_bucket {
457 struct list_head list;
461 /* yaffs_checkpt_obj holds the definition of an object as dumped
465 struct yaffs_checkpt_obj {
470 enum yaffs_obj_type variant_type:3;
479 u32 size_or_equiv_obj;
482 /*--------------------- Temporary buffers ----------------
484 * These are chunk-sized working buffers. Each device has a few.
487 struct yaffs_buffer {
492 /*----------------- Device ---------------------------------*/
498 * Entry parameters set up way early. Yaffs sets up the rest.
499 * The structure should be zeroed out before use so that unused
500 * and defualt values are zero.
503 int inband_tags; /* Use unband tags */
504 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to
506 int chunks_per_block; /* does not need to be a power of 2 */
507 int spare_bytes_per_chunk; /* spare area size */
508 int start_block; /* Start block we're allowed to use */
509 int end_block; /* End block we're allowed to use */
510 int n_reserved_blocks; /* Tuneable so that we can reduce
511 * reserved blocks on NOR and RAM. */
513 int n_caches; /* If <= 0, then short op caching is disabled,
514 * else the number of short op caches.
516 int use_nand_ecc; /* Flag to decide whether or not to use
517 * NAND driver ECC on data (yaffs1) */
518 int tags_9bytes; /* Use 9 byte tags */
519 int no_tags_ecc; /* Flag to decide whether or not to do ECC
520 * on packed tags (yaffs2) */
522 int is_yaffs2; /* Use yaffs2 mode on this device */
524 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
526 int refresh_period; /* How often to check for a block refresh */
528 /* Checkpoint control. Can be set before or after initialisation */
532 int enable_xattr; /* Enable xattribs */
534 /* NAND access functions (Must be set before calling YAFFS) */
536 int (*write_chunk_fn) (struct yaffs_dev *dev,
537 int nand_chunk, const u8 *data,
538 const struct yaffs_spare *spare);
539 int (*read_chunk_fn) (struct yaffs_dev *dev,
540 int nand_chunk, u8 *data,
541 struct yaffs_spare *spare);
542 int (*erase_fn) (struct yaffs_dev *dev, int flash_block);
543 int (*initialise_flash_fn) (struct yaffs_dev *dev);
544 int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
546 /* yaffs2 mode functions */
547 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
548 int nand_chunk, const u8 *data,
549 const struct yaffs_ext_tags *tags);
550 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
551 int nand_chunk, u8 *data,
552 struct yaffs_ext_tags *tags);
553 int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
554 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
555 enum yaffs_block_state *state,
558 /* The remove_obj_fn function must be supplied by OS flavours that
560 * yaffs direct uses it to implement the faster readdir.
561 * Linux uses it to protect the directory during unlocking.
563 void (*remove_obj_fn) (struct yaffs_obj *obj);
565 /* Callback to mark the superblock dirty */
566 void (*sb_dirty_fn) (struct yaffs_dev *dev);
568 /* Callback to control garbage collection. */
569 unsigned (*gc_control) (struct yaffs_dev *dev);
571 /* Debug control flags. Don't use unless you know what you're doing */
572 int use_header_file_size; /* Flag to determine if we should use
573 * file sizes from the header */
574 int disable_lazy_load; /* Disable lazy loading on this device */
575 int wide_tnodes_disabled; /* Set to disable wide tnodes */
576 int disable_soft_del; /* yaffs 1 only: Set to disable the use of
579 int defered_dir_update; /* Set to defer directory updates */
581 #ifdef CONFIG_YAFFS_AUTO_UNICODE
584 int always_check_erased; /* Force chunk erased check always on */
588 struct yaffs_param param;
590 /* Context storage. Holds extra OS specific data for this device */
593 void *driver_context;
595 struct list_head dev_list;
597 /* Runtime parameters. Set up by YAFFS. */
598 int data_bytes_per_chunk;
600 /* Non-wide tnode stuff */
601 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
602 * the tnodes are not wide enough.
604 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
606 /* Stuff to support wide tnodes */
611 /* Stuff for figuring out file offset to chunk conversions */
612 u32 chunk_shift; /* Shift value */
613 u32 chunk_div; /* Divisor after shifting: 1 for 2^n sizes */
614 u32 chunk_mask; /* Mask to use for power-of-2 case */
620 /* Stuff to support block offsetting to support start block zero */
621 int internal_start_block;
622 int internal_end_block;
626 /* Runtime checkpointing stuff */
627 int checkpt_page_seq; /* running sequence number of checkpt pages */
628 int checkpt_byte_count;
629 int checkpt_byte_offs;
631 int checkpt_open_write;
632 int blocks_in_checkpt;
633 int checkpt_cur_chunk;
634 int checkpt_cur_block;
635 int checkpt_next_block;
636 int *checkpt_block_list;
637 int checkpt_max_blocks;
641 int checkpoint_blocks_required; /* Number of blocks needed to store
642 * current checkpoint set */
645 struct yaffs_block_info *block_info;
646 u8 *chunk_bits; /* bitmap of chunks in use */
647 unsigned block_info_alt:1; /* allocated using alternative alloc */
648 unsigned chunk_bits_alt:1; /* allocated using alternative alloc */
649 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
650 * Must be consistent with chunks_per_block.
654 int alloc_block; /* Current block being allocated off */
656 int alloc_block_finder; /* Used to search for next allocation block */
658 /* Object and Tnode memory management */
665 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
670 /* Garbage collection control */
671 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
674 unsigned has_pending_prioritised_gc; /* We think this device might
675 have pending prioritised gcs */
677 unsigned gc_block_finder;
678 unsigned gc_dirtiest;
679 unsigned gc_pages_in_use;
680 unsigned gc_not_done;
685 /* Special directories */
686 struct yaffs_obj *root_dir;
687 struct yaffs_obj *lost_n_found;
689 int buffered_block; /* Which block is buffered here? */
690 int doing_buffered_block_rewrite;
692 struct yaffs_cache *cache;
695 /* Stuff for background deletion and unlinked files. */
696 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
698 struct yaffs_obj *del_dir; /* Directory where deleted objects are
699 sent to disappear. */
700 struct yaffs_obj *unlinked_deletion; /* Current file being
701 background deleted. */
702 int n_deleted_files; /* Count of files awaiting deletion; */
703 int n_unlinked_files; /* Count of unlinked files. */
704 int n_bg_deletions; /* Count of background deletions. */
706 /* Temporary buffer management */
707 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
710 int unmanaged_buffer_allocs;
711 int unmanaged_buffer_deallocs;
713 /* yaffs2 runtime stuff */
714 unsigned seq_number; /* Sequence number of currently
716 unsigned oldest_dirty_seq;
717 unsigned oldest_dirty_block;
719 /* Block refreshing */
720 int refresh_skip; /* A skip down counter.
721 * Refresh happens when this gets to zero. */
723 /* Dirty directory handling */
724 struct list_head dirty_dirs; /* List of dirty directories */
730 u32 n_erase_failures;
733 u32 passive_gc_count;
734 u32 oldest_dirty_gc_count;
737 u32 n_retired_writes;
738 u32 n_retired_blocks;
741 u32 n_tags_ecc_fixed;
742 u32 n_tags_ecc_unfixed;
744 u32 n_unmarked_deletions;
750 /* The CheckpointDevice structure holds the device information that changes
751 *at runtime and must be preserved over unmount/mount cycles.
753 struct yaffs_checkpt_dev {
756 int alloc_block; /* Current block being allocated off */
760 int n_deleted_files; /* Count of files awaiting deletion; */
761 int n_unlinked_files; /* Count of unlinked files. */
762 int n_bg_deletions; /* Count of background deletions. */
764 /* yaffs2 runtime stuff */
765 unsigned seq_number; /* Sequence number of currently
766 * allocating block */
770 struct yaffs_checkpt_validity {
777 struct yaffs_shadow_fixer {
780 struct yaffs_shadow_fixer *next;
783 /* Structure for doing xattr modifications */
784 struct yaffs_xattr_mod {
785 int set; /* If 0 then this is a deletion */
793 /*----------------------- YAFFS Functions -----------------------*/
795 int yaffs_guts_initialise(struct yaffs_dev *dev);
796 void yaffs_deinitialise(struct yaffs_dev *dev);
798 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
800 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
801 struct yaffs_obj *new_dir, const YCHAR * new_name);
803 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
804 int yaffs_del_obj(struct yaffs_obj *obj);
806 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
807 int yaffs_get_obj_length(struct yaffs_obj *obj);
808 int yaffs_get_obj_inode(struct yaffs_obj *obj);
809 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
810 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
812 /* File operations */
813 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
815 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
816 int n_bytes, int write_trhrough);
817 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
819 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
820 const YCHAR *name, u32 mode, u32 uid,
823 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
825 /* Flushing and checkpointing */
826 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
828 int yaffs_checkpoint_save(struct yaffs_dev *dev);
829 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
831 /* Directory operations */
832 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
833 u32 mode, u32 uid, u32 gid);
834 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
836 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
838 /* Link operations */
839 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
840 struct yaffs_obj *equiv_obj);
842 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
844 /* Symlink operations */
845 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
846 const YCHAR *name, u32 mode, u32 uid,
847 u32 gid, const YCHAR *alias);
848 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
850 /* Special inodes (fifos, sockets and devices) */
851 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
852 const YCHAR *name, u32 mode, u32 uid,
855 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
856 const void *value, int size, int flags);
857 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
859 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
860 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
862 /* Special directories */
863 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
864 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
866 void yaffs_handle_defered_free(struct yaffs_obj *obj);
868 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
870 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
873 int yaffs_dump_obj(struct yaffs_obj *obj);
875 void yaffs_guts_test(struct yaffs_dev *dev);
877 /* A few useful functions to be used within the core files*/
878 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
880 int yaffs_check_ff(u8 *buffer, int n_bytes);
881 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
882 struct yaffs_block_info *bi);
884 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
885 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
887 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
889 enum yaffs_obj_type type);
890 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
891 int nand_chunk, int in_scan);
892 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
893 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
894 const struct yaffs_obj_hdr *oh);
895 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
896 YCHAR *yaffs_clone_str(const YCHAR *str);
897 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
898 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
899 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
900 int force, int is_shrink, int shadows,
901 struct yaffs_xattr_mod *xop);
902 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
903 int backward_scanning);
904 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
905 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
906 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
907 struct yaffs_file_var *file_struct,
909 struct yaffs_tnode *passed_tn);
911 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
912 int n_bytes, int write_trhrough);
913 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
914 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
916 int yaffs_count_free_chunks(struct yaffs_dev *dev);
918 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
919 struct yaffs_file_var *file_struct,
922 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
925 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);