2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 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
55 #define YAFFS_ALLOCATION_NOBJECTS 100
56 #define YAFFS_ALLOCATION_NTNODES 100
57 #define YAFFS_ALLOCATION_NLINKS 100
59 #define YAFFS_NOBJECT_BUCKETS 256
62 #define YAFFS_OBJECT_SPACE 0x40000
63 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE -1)
65 #define YAFFS_CHECKPOINT_VERSION 4
67 #ifdef CONFIG_YAFFS_UNICODE
68 #define YAFFS_MAX_NAME_LENGTH 127
69 #define YAFFS_MAX_ALIAS_LENGTH 79
71 #define YAFFS_MAX_NAME_LENGTH 255
72 #define YAFFS_MAX_ALIAS_LENGTH 159
75 #define YAFFS_SHORT_NAME_LENGTH 15
77 /* Some special object ids for pseudo objects */
78 #define YAFFS_OBJECTID_ROOT 1
79 #define YAFFS_OBJECTID_LOSTNFOUND 2
80 #define YAFFS_OBJECTID_UNLINKED 3
81 #define YAFFS_OBJECTID_DELETED 4
83 /* Pseudo object ids for checkpointing */
84 #define YAFFS_OBJECTID_SB_HEADER 0x10
85 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
86 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
89 #define YAFFS_MAX_SHORT_OP_CACHES 20
91 #define YAFFS_N_TEMP_BUFFERS 6
93 /* We limit the number attempts at sucessfully saving a chunk of data.
94 * Small-page devices have 32 pages per block; large-page devices have 64.
95 * Default to something in the order of 5 to 10 blocks worth of chunks.
97 #define YAFFS_WR_ATTEMPTS (5*64)
99 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
100 * The range is limited slightly to help distinguish bad numbers from good.
101 * This also allows us to perhaps in the future use special numbers for
103 * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
104 * and is a larger number than the lifetime of a 2GB device.
106 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
107 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00
109 /* Special sequence number for bad block that failed to be marked bad */
110 #define YAFFS_SEQUENCE_BAD_BLOCK 0xFFFF0000
112 /* ChunkCache is used for short read/write operations.*/
114 struct yaffs_obj *object;
118 int n_bytes; /* Only valid if the cache is dirty */
119 int locked; /* Can't push out or flush while locked. */
125 /* Tags structures in RAM
126 * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
127 * the structure size will get blown out.
130 #ifndef CONFIG_YAFFS_NO_YAFFS1
132 unsigned chunk_id:20;
133 unsigned serial_number:2;
134 unsigned n_bytes_lsb:10;
137 unsigned n_bytes_msb:2;
140 union yaffs_tags_union{
141 struct yaffs_tags as_tags;
147 /* Stuff used for extended tags in YAFFS2 */
149 enum yaffs_ecc_result {
150 YAFFS_ECC_RESULT_UNKNOWN,
151 YAFFS_ECC_RESULT_NO_ERROR,
152 YAFFS_ECC_RESULT_FIXED,
153 YAFFS_ECC_RESULT_UNFIXED
156 enum yaffs_obj_type {
157 YAFFS_OBJECT_TYPE_UNKNOWN,
158 YAFFS_OBJECT_TYPE_FILE,
159 YAFFS_OBJECT_TYPE_SYMLINK,
160 YAFFS_OBJECT_TYPE_DIRECTORY,
161 YAFFS_OBJECT_TYPE_HARDLINK,
162 YAFFS_OBJECT_TYPE_SPECIAL
165 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
167 struct yaffs_ext_tags{
170 unsigned chunk_used; /* Status of the chunk: used or unused */
171 unsigned obj_id; /* If 0 then this is not part of an object (unused) */
172 unsigned chunk_id; /* If 0 then this is a header, else a data chunk */
173 unsigned n_bytes; /* Only valid for data chunks */
175 /* The following stuff only has meaning when we read */
176 enum yaffs_ecc_result ecc_result;
180 unsigned is_deleted; /* The chunk is marked deleted */
181 unsigned serial_number; /* Yaffs1 2-bit serial number */
184 unsigned seq_number; /* The sequence number of this block */
186 /* Extra info if this is an object header (YAFFS2 only) */
188 unsigned extra_available; /* There is extra info available if this is not zero */
189 unsigned extra_parent_id; /* The parent object */
190 unsigned extra_is_shrink; /* Is it a shrink header? */
191 unsigned extra_shadows; /* Does this shadow another object? */
193 enum yaffs_obj_type extra_obj_type; /* What object type? */
195 unsigned extra_length; /* Length if it is a file */
196 unsigned extra_equiv_id; /* Equivalent object Id if it is a hard link */
202 /* Spare structure for YAFFS1 */
208 u8 page_status; /* set to 0 to delete the chunk */
218 /*Special structure for passing through to mtd */
219 struct yaffs_nand_spare {
220 struct yaffs_spare spare;
225 /* Block data in RAM */
227 enum yaffs_block_state{
228 YAFFS_BLOCK_STATE_UNKNOWN = 0,
230 YAFFS_BLOCK_STATE_SCANNING,
233 YAFFS_BLOCK_STATE_NEEDS_SCANNING,
234 /* The block might have something on it (ie it is allocating or full, perhaps empty)
235 * but it needs to be scanned to determine its true state.
236 * This state is only valid during scanning.
237 * NB We tolerate empty because the pre-scanner might be incapable of deciding
238 * However, if this state is returned on a YAFFS2 device, then we expect a sequence number
241 YAFFS_BLOCK_STATE_EMPTY,
242 /* This block is empty */
244 YAFFS_BLOCK_STATE_ALLOCATING,
245 /* This block is partially allocated.
246 * At least one page holds valid data.
247 * This is the one currently being used for page
248 * allocation. Should never be more than one of these.
249 * If a block is only partially allocated at mount it is treated as full.
252 YAFFS_BLOCK_STATE_FULL,
253 /* All the pages in this block have been allocated.
254 * If a block was only partially allocated when mounted we treat
255 * it as fully allocated.
258 YAFFS_BLOCK_STATE_DIRTY,
259 /* The block was full and now all chunks have been deleted.
260 * Erase me, reuse me.
263 YAFFS_BLOCK_STATE_CHECKPOINT,
264 /* This block is assigned to holding checkpoint data. */
266 YAFFS_BLOCK_STATE_COLLECTING,
267 /* This block is being garbage collected */
269 YAFFS_BLOCK_STATE_DEAD
270 /* This block has failed and is not in use */
273 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
276 struct yaffs_block_info{
278 int soft_del_pages:10; /* number of soft deleted pages */
279 int pages_in_use:10; /* number of pages in use */
280 unsigned block_state:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
281 u32 needs_retiring:1; /* Data has failed on this block, need to get valid data off */
282 /* and retire the block. */
283 u32 skip_erased_check:1; /* If this is set we can skip the erased check on this block */
284 u32 gc_prioritise:1; /* An ECC check or blank check has failed on this block.
285 It should be prioritised for GC */
286 u32 chunk_error_strikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
288 #ifdef CONFIG_YAFFS_YAFFS2
289 u32 has_shrink_hdr:1; /* This block has at least one shrink object header */
290 u32 seq_number; /* block sequence number for yaffs2 */
295 /* -------------------------- Object structure -------------------------------*/
296 /* This is the object structure as stored on NAND */
298 struct yaffs_obj_hdr {
299 enum yaffs_obj_type type;
301 /* Apply to everything */
303 u16 sum_no_longer_used; /* checksum of name. No longer used */
304 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
306 /* The following apply to directories, files, symlinks - not hard links */
307 u32 yst_mode; /* protection */
315 /* File size applies to files only */
318 /* Equivalent object id applies to hard links only. */
321 /* Alias is for symlinks only. */
322 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
324 u32 yst_rdev; /* device stuff for block and char devices (major/min) */
330 u32 inband_shadowed_obj_id;
331 u32 inband_is_shrink;
334 int shadows_obj; /* This object header shadows the specified object if > 0 */
336 /* is_shrink applies to object headers written when we shrink the file (ie resize) */
341 /*--------------------------- Tnode -------------------------- */
344 struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
349 /*------------------------ Object -----------------------------*/
350 /* An object can be one of:
351 * - a directory (no data, has children links
352 * - a regular file (data.... not prunes :->).
353 * - a symlink [symbolic link] (the alias).
357 struct yaffs_file_var {
362 struct yaffs_tnode *top;
365 struct yaffs_dir_var{
366 struct list_head children; /* list of child links */
367 struct list_head dirty; /* Entry for list of dirty directories */
370 struct yaffs_symlink_var{
374 struct yaffs_hardlink_var{
375 struct yaffs_obj *equiv_obj;
380 struct yaffs_file_var file_variant;
381 struct yaffs_dir_var dir_variant;
382 struct yaffs_symlink_var symlink_variant;
383 struct yaffs_hardlink_var hardlink_variant;
389 u8 deleted:1; /* This should only apply to unlinked files. */
390 u8 soft_del:1; /* it has also been soft deleted */
391 u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/
392 u8 fake:1; /* A fake object has no presence on NAND. */
393 u8 rename_allowed:1; /* Some objects are not allowed to be renamed. */
395 u8 dirty:1; /* the object needs to be written to flash */
396 u8 valid:1; /* When the file system is being loaded up, this
397 * object might be created before the data
398 * is available (ie. file data records appear before the header).
400 u8 lazy_loaded:1; /* This object has been lazy loaded and is missing some detail */
402 u8 defered_free:1; /* For Linux kernel. Object is removed from NAND, but is
403 * still in the inode cache. Free of object is defered.
404 * until the inode is released.
406 u8 being_created:1; /* This object is still being created so skip some checks. */
407 u8 is_shadowed:1; /* This object is shadowed on the way to being renamed. */
409 u8 xattr_known:1; /* We know if this has object has xattribs or not. */
410 u8 has_xattr:1; /* This object has xattribs. Valid if xattr_known. */
412 u8 serial; /* serial number of chunk in NAND. Cached here */
413 u16 sum; /* sum of the name to speed searching */
415 struct yaffs_dev *my_dev; /* The device I'm on */
417 struct list_head hash_link; /* list of objects in this hash bucket */
419 struct list_head hard_links; /* all the equivalent hard linked objects */
421 /* directory structure stuff */
422 /* also used for linking up the free list */
423 struct yaffs_obj *parent;
424 struct list_head siblings;
426 /* Where's my object header in NAND? */
429 int n_data_chunks; /* Number of data chunks attached to the file. */
431 u32 obj_id; /* the object id value */
435 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
436 YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
439 #ifdef CONFIG_YAFFS_WINCE
455 enum yaffs_obj_type variant_type;
457 union yaffs_obj_var variant;
461 struct yaffs_obj_bucket {
462 struct list_head list;
467 /* yaffs_checkpt_obj holds the definition of an object as dumped
471 struct yaffs_checkpt_obj{
476 enum yaffs_obj_type variant_type:3;
485 u32 size_or_equiv_obj;
488 /*--------------------- Temporary buffers ----------------
490 * These are chunk-sized working buffers. Each device has a few
493 struct yaffs_buffer {
495 int line; /* track from whence this buffer was allocated */
499 /*----------------- Device ---------------------------------*/
506 * Entry parameters set up way early. Yaffs sets up the rest.
507 * The structure should be zeroed out before use so that unused
508 * and defualt values are zero.
511 int inband_tags; /* Use unband tags */
512 u32 total_bytes_per_chunk; /* Should be >= 512, does not need to be a power of 2 */
513 int chunks_per_block; /* does not need to be a power of 2 */
514 int spare_bytes_per_chunk; /* spare area size */
515 int start_block; /* Start block we're allowed to use */
516 int end_block; /* End block we're allowed to use */
517 int n_reserved_blocks; /* We want this tuneable so that we can reduce */
518 /* reserved blocks on NOR and RAM. */
521 int n_caches; /* If <= 0, then short op caching is disabled, else
522 * the number of short op caches (don't use too many).
523 * 10 to 20 is a good bet.
525 int use_nand_ecc; /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
526 int no_tags_ecc; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
528 int is_yaffs2; /* Use yaffs2 mode on this device */
530 int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
532 int refresh_period; /* How often we should check to do a block refresh */
534 /* Checkpoint control. Can be set before or after initialisation */
538 int enable_xattr; /* Enable xattribs */
540 /* NAND access functions (Must be set before calling YAFFS)*/
542 int (*write_chunk_fn) (struct yaffs_dev *dev,
543 int nand_chunk, const u8 *data,
544 const struct yaffs_spare *spare);
545 int (*read_chunk_fn) (struct yaffs_dev *dev,
546 int nand_chunk, u8 *data,
547 struct yaffs_spare *spare);
548 int (*erase_fn) (struct yaffs_dev *dev,
550 int (*initialise_flash_fn) (struct yaffs_dev *dev);
551 int (*deinitialise_flash_fn) (struct yaffs_dev *dev);
553 #ifdef CONFIG_YAFFS_YAFFS2
554 int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
555 int nand_chunk, const u8 *data,
556 const struct yaffs_ext_tags *tags);
557 int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
558 int nand_chunk, u8 *data,
559 struct yaffs_ext_tags *tags);
560 int (*bad_block_fn) (struct yaffs_dev *dev, int block_no);
561 int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
562 enum yaffs_block_state *state, u32 *seq_number);
565 /* The remove_obj_fn function must be supplied by OS flavours that
567 * yaffs direct uses it to implement the faster readdir.
568 * Linux uses it to protect the directory during unlocking.
570 void (*remove_obj_fn)(struct yaffs_obj *obj);
572 /* Callback to mark the superblock dirty */
573 void (*sb_dirty_fn)(struct yaffs_dev *dev);
575 /* Callback to control garbage collection. */
576 unsigned (*gc_control)(struct yaffs_dev *dev);
578 /* Debug control flags. Don't use unless you know what you're doing */
579 int use_header_file_size; /* Flag to determine if we should use file sizes from the header */
580 int disable_lazy_load; /* Disable lazy loading on this device */
581 int wide_tnodes_disabled; /* Set to disable wide tnodes */
582 int disable_soft_del; /* yaffs 1 only: Set to disable the use of softdeletion. */
584 int defered_dir_update; /* Set to defer directory updates */
586 #ifdef CONFIG_YAFFS_AUTO_UNICODE
589 int always_check_erased; /* Force chunk erased check always on */
594 struct yaffs_param param;
596 /* Context storage. Holds extra OS specific data for this device */
599 void *driver_context;
601 struct list_head dev_list;
603 /* Runtime parameters. Set up by YAFFS. */
604 int data_bytes_per_chunk;
606 /* Non-wide tnode stuff */
607 u16 chunk_grp_bits; /* Number of bits that need to be resolved if
608 * the tnodes are not wide enough.
610 u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
612 /* Stuff to support wide tnodes */
617 /* Stuff for figuring out file offset to chunk conversions */
618 u32 chunk_shift; /* Shift value */
619 u32 chunk_div; /* Divisor after shifting: 1 for power-of-2 sizes */
620 u32 chunk_mask; /* Mask to use for power-of-2 case */
629 /* Stuff to support block offsetting to support start block zero */
630 int internal_start_block;
631 int internal_end_block;
636 /* Runtime checkpointing stuff */
637 int checkpt_page_seq; /* running sequence number of checkpoint pages */
638 int checkpt_byte_count;
639 int checkpt_byte_offs;
641 int checkpt_open_write;
642 int blocks_in_checkpt;
643 int checkpt_cur_chunk;
644 int checkpt_cur_block;
645 int checkpt_next_block;
646 int *checkpt_block_list;
647 int checkpt_max_blocks;
651 int checkpoint_blocks_required; /* Number of blocks needed to store current checkpoint set */
654 struct yaffs_block_info *block_info;
655 u8 *chunk_bits; /* bitmap of chunks in use */
656 unsigned block_info_alt:1; /* was allocated using alternative strategy */
657 unsigned chunk_bits_alt:1; /* was allocated using alternative strategy */
658 int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
659 * Must be consistent with chunks_per_block.
663 int alloc_block; /* Current block being allocated off */
665 int alloc_block_finder; /* Used to search for next allocation block */
667 /* Object and Tnode memory management */
674 struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
679 /* Garbage collection control */
680 u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
683 unsigned has_pending_prioritised_gc; /* We think this device might have pending prioritised gcs */
685 unsigned gc_block_finder;
686 unsigned gc_dirtiest;
687 unsigned gc_pages_in_use;
688 unsigned gc_not_done;
693 /* Special directories */
694 struct yaffs_obj *root_dir;
695 struct yaffs_obj *lost_n_found;
697 /* Buffer areas for storing data to recover from write failures TODO
698 * u8 buffered_data[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
699 * struct yaffs_spare buffered_spare[YAFFS_CHUNKS_PER_BLOCK];
702 int buffered_block; /* Which block is buffered here? */
703 int doing_buffered_block_rewrite;
705 struct yaffs_cache *cache;
708 /* Stuff for background deletion and unlinked files.*/
709 struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted files live. */
710 struct yaffs_obj *del_dir; /* Directory where deleted objects are sent to disappear. */
711 struct yaffs_obj *unlinked_deletion; /* Current file being background deleted.*/
712 int n_deleted_files; /* Count of files awaiting deletion;*/
713 int n_unlinked_files; /* Count of unlinked files. */
714 int n_bg_deletions; /* Count of background deletions. */
716 /* Temporary buffer management */
717 struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
720 int unmanaged_buffer_allocs;
721 int unmanaged_buffer_deallocs;
723 /* yaffs2 runtime stuff */
724 unsigned seq_number; /* Sequence number of currently allocating block */
725 unsigned oldest_dirty_seq;
726 unsigned oldest_dirty_block;
728 /* Block refreshing */
729 int refresh_skip; /* A skip down counter. Refresh happens when this gets to zero. */
731 /* Dirty directory handling */
732 struct list_head dirty_dirs; /* List of dirty directories */
739 u32 n_erase_failures;
742 u32 passive_gc_count;
743 u32 oldest_dirty_gc_count;
746 u32 n_retired_writes;
747 u32 n_retired_blocks;
750 u32 n_tags_ecc_fixed;
751 u32 n_tags_ecc_unfixed;
753 u32 n_unmarked_deletions;
760 /* The CheckpointDevice structure holds the device information that changes at runtime and
761 * must be preserved over unmount/mount cycles.
763 struct yaffs_checkpt_dev{
766 int alloc_block; /* Current block being allocated off */
770 int n_deleted_files; /* Count of files awaiting deletion;*/
771 int n_unlinked_files; /* Count of unlinked files. */
772 int n_bg_deletions; /* Count of background deletions. */
774 /* yaffs2 runtime stuff */
775 unsigned seq_number; /* Sequence number of currently allocating block */
780 struct yaffs_checkpt_validity{
788 struct yaffs_shadow_fixer {
791 struct yaffs_shadow_fixer *next;
794 /* Structure for doing xattr modifications */
795 struct yaffs_xattr_mod{
796 int set; /* If 0 then this is a deletion */
805 /*----------------------- YAFFS Functions -----------------------*/
807 int yaffs_guts_initialise(struct yaffs_dev *dev);
808 void yaffs_deinitialise(struct yaffs_dev *dev);
810 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
812 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR *old_name,
813 struct yaffs_obj *new_dir, const YCHAR *new_name);
815 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR *name);
816 int yaffs_del_obj(struct yaffs_obj *obj);
818 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR *name, int buffer_size);
819 int yaffs_get_obj_length(struct yaffs_obj *obj);
820 int yaffs_get_obj_inode(struct yaffs_obj *obj);
821 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
822 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
824 /* File operations */
825 int yaffs_file_rd(struct yaffs_obj *obj, u8 *buffer, loff_t offset,
827 int yaffs_wr_file(struct yaffs_obj *obj, const u8 *buffer, loff_t offset,
828 int n_bytes, int write_trhrough);
829 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
831 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent, const YCHAR *name,
832 u32 mode, u32 uid, u32 gid);
834 int yaffs_flush_file(struct yaffs_obj *obj, int update_time, int data_sync);
836 /* Flushing and checkpointing */
837 void yaffs_flush_whole_cache(struct yaffs_dev *dev);
839 int yaffs_checkpoint_save(struct yaffs_dev *dev);
840 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
842 /* Directory operations */
843 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
844 u32 mode, u32 uid, u32 gid);
845 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir, const YCHAR *name);
846 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
848 /* Link operations */
849 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
850 struct yaffs_obj *equiv_obj);
852 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
854 /* Symlink operations */
855 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent, const YCHAR *name,
856 u32 mode, u32 uid, u32 gid,
858 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
860 /* Special inodes (fifos, sockets and devices) */
861 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent, const YCHAR *name,
862 u32 mode, u32 uid, u32 gid, u32 rdev);
865 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name, const void * value, int size, int flags);
866 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value, int size);
867 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
868 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
870 /* Special directories */
871 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
872 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
874 void yaffs_handle_defered_free(struct yaffs_obj *obj);
876 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
878 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
881 int yaffs_dump_obj(struct yaffs_obj *obj);
883 void yaffs_guts_test(struct yaffs_dev *dev);
885 /* A few useful functions to be used within the core files*/
886 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash, int lyn);
887 int yaffs_check_ff(u8 *buffer, int n_bytes);
888 void yaffs_handle_chunk_error(struct yaffs_dev *dev, struct yaffs_block_info *bi);
890 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev, int line_no);
891 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer, int line_no);
893 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
895 enum yaffs_obj_type type);
896 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
897 int nand_chunk, int in_scan);
898 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
899 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
900 const struct yaffs_obj_hdr *oh);
901 void yaffs_add_obj_to_dir(struct yaffs_obj *directory,
902 struct yaffs_obj *obj);
903 YCHAR *yaffs_clone_str(const YCHAR *str);
904 void yaffs_link_fixup(struct yaffs_dev *dev, struct yaffs_obj *hard_list);
905 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
906 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
907 int force, int is_shrink, int shadows,
908 struct yaffs_xattr_mod *xop);
909 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
910 int backward_scanning);
911 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
912 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
913 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
914 struct yaffs_file_var *file_struct,
916 struct yaffs_tnode *passed_tn);
918 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
919 int n_bytes, int write_trhrough);
920 void yaffs_resize_file_down( struct yaffs_obj *obj, loff_t new_size);
921 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
923 int yaffs_count_free_chunks(struct yaffs_dev *dev);
925 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
926 struct yaffs_file_var *file_struct,
929 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn, unsigned pos);