2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
4 * Copyright (C) 2002-2007 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__
19 #include "devextras.h"
29 * And what have we got...
31 #define YAFFS_MAGIC 0x5941FF53
33 #define YAFFS_NTNODES_LEVEL0 16
34 #define YAFFS_TNODES_LEVEL0_BITS 4
35 #define YAFFS_TNODES_LEVEL0_MASK 0xf
37 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
38 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
39 #define YAFFS_TNODES_INTERNAL_MASK 0x7
40 #define YAFFS_TNODES_MAX_LEVEL 6
42 #ifndef CONFIG_YAFFS_NO_YAFFS1
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)
50 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
51 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
53 #define YAFFS_MAX_CHUNK_ID 0x000FFFFF
55 #define YAFFS_UNUSED_OBJECT_ID 0x0003FFFF
57 #define YAFFS_ALLOCATION_NOBJECTS 100
58 #define YAFFS_ALLOCATION_NTNODES 100
59 #define YAFFS_ALLOCATION_NLINKS 100
61 #define YAFFS_NOBJECT_BUCKETS 256
64 #define YAFFS_OBJECT_SPACE 0x40000
66 #define YAFFS_CHECKPOINT_VERSION 3
68 #ifdef CONFIG_YAFFS_UNICODE
69 #define YAFFS_MAX_NAME_LENGTH 127
70 #define YAFFS_MAX_ALIAS_LENGTH 79
72 #define YAFFS_MAX_NAME_LENGTH 255
73 #define YAFFS_MAX_ALIAS_LENGTH 159
76 #define YAFFS_SHORT_NAME_LENGTH 15
78 /* Some special object ids for pseudo objects */
79 #define YAFFS_OBJECTID_ROOT 1
80 #define YAFFS_OBJECTID_LOSTNFOUND 2
81 #define YAFFS_OBJECTID_UNLINKED 3
82 #define YAFFS_OBJECTID_DELETED 4
84 /* Sseudo object ids for checkpointing */
85 #define YAFFS_OBJECTID_SB_HEADER 0x10
86 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
87 #define YAFFS_SEQUENCE_CHECKPOINT_DATA 0x21
91 #define YAFFS_MAX_SHORT_OP_CACHES 20
93 #define YAFFS_N_TEMP_BUFFERS 6
95 /* We limit the number attempts at sucessfully saving a chunk of data.
96 * Small-page devices have 32 pages per block; large-page devices have 64.
97 * Default to something in the order of 5 to 10 blocks worth of chunks.
99 #define YAFFS_WR_ATTEMPTS (5*64)
101 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
102 * The range is limited slightly to help distinguish bad numbers from good.
103 * This also allows us to perhaps in the future use special numbers for
105 * EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
106 * and is a larger number than the lifetime of a 2GB device.
108 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
109 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00
111 /* ChunkCache is used for short read/write operations.*/
113 struct yaffs_ObjectStruct *object;
117 int nBytes; /* Only valid if the cache is dirty */
118 int locked; /* Can't push out or flush while locked. */
119 #ifdef CONFIG_YAFFS_YAFFS2
122 __u8 data[YAFFS_BYTES_PER_CHUNK];
128 /* Tags structures in RAM
129 * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
130 * the structure size will get blown out.
133 #ifndef CONFIG_YAFFS_NO_YAFFS1
136 unsigned serialNumber:2;
137 unsigned byteCount:10;
138 unsigned objectId:18;
140 unsigned unusedStuff:2;
151 /* Stuff used for extended tags in YAFFS2 */
154 YAFFS_ECC_RESULT_UNKNOWN,
155 YAFFS_ECC_RESULT_NO_ERROR,
156 YAFFS_ECC_RESULT_FIXED,
157 YAFFS_ECC_RESULT_UNFIXED
161 YAFFS_OBJECT_TYPE_UNKNOWN,
162 YAFFS_OBJECT_TYPE_FILE,
163 YAFFS_OBJECT_TYPE_SYMLINK,
164 YAFFS_OBJECT_TYPE_DIRECTORY,
165 YAFFS_OBJECT_TYPE_HARDLINK,
166 YAFFS_OBJECT_TYPE_SPECIAL
169 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
173 unsigned validMarker0;
174 unsigned chunkUsed; /* Status of the chunk: used or unused */
175 unsigned objectId; /* If 0 then this is not part of an object (unused) */
176 unsigned chunkId; /* If 0 then this is a header, else a data chunk */
177 unsigned byteCount; /* Only valid for data chunks */
179 /* The following stuff only has meaning when we read */
180 yaffs_ECCResult eccResult;
184 unsigned chunkDeleted; /* The chunk is marked deleted */
185 unsigned serialNumber; /* Yaffs1 2-bit serial number */
188 unsigned sequenceNumber; /* The sequence number of this block */
190 /* Extra info if this is an object header (YAFFS2 only) */
192 unsigned extraHeaderInfoAvailable; /* There is extra info available if this is not zero */
193 unsigned extraParentObjectId; /* The parent object */
194 unsigned extraIsShrinkHeader; /* Is it a shrink header? */
195 unsigned extraShadows; /* Does this shadow another object? */
197 yaffs_ObjectType extraObjectType; /* What object type? */
199 unsigned extraFileLength; /* Length if it is a file */
200 unsigned extraEquivalentObjectId; /* Equivalent object Id if it is a hard link */
202 unsigned validMarker1;
204 } yaffs_ExtendedTags;
206 /* Spare structure for YAFFS1 */
212 __u8 pageStatus; /* set to 0 to delete the chunk */
222 /*Special structure for passing through to mtd */
223 struct yaffs_NANDSpare {
229 /* Block data in RAM */
232 YAFFS_BLOCK_STATE_UNKNOWN = 0,
234 YAFFS_BLOCK_STATE_SCANNING,
235 YAFFS_BLOCK_STATE_NEEDS_SCANNING,
236 /* The block might have something on it (ie it is allocating or full, perhaps empty)
237 * but it needs to be scanned to determine its true state.
238 * This state is only valid during yaffs_Scan.
239 * NB We tolerate empty because the pre-scanner might be incapable of deciding
240 * However, if this state is returned on a YAFFS2 device, then we expect a sequence number
243 YAFFS_BLOCK_STATE_EMPTY,
244 /* This block is empty */
246 YAFFS_BLOCK_STATE_ALLOCATING,
247 /* This block is partially allocated.
248 * At least one page holds valid data.
249 * This is the one currently being used for page
250 * allocation. Should never be more than one of these
253 YAFFS_BLOCK_STATE_FULL,
254 /* All the pages in this block have been allocated.
257 YAFFS_BLOCK_STATE_DIRTY,
258 /* All pages have been allocated and deleted.
259 * Erase me, reuse me.
262 YAFFS_BLOCK_STATE_CHECKPOINT,
263 /* 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)
278 int softDeletions:10; /* number of soft deleted pages */
279 int pagesInUse:10; /* number of pages in use */
280 unsigned blockState:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
281 __u32 needsRetiring:1; /* Data has failed on this block, need to get valid data off */
282 /* and retire the block. */
283 __u32 skipErasedCheck: 1; /* If this is set we can skip the erased check on this block */
284 __u32 gcPrioritise: 1; /* An ECC check or blank check has failed on this block.
285 It should be prioritised for GC */
286 __u32 chunkErrorStrikes: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 hasShrinkHeader:1; /* This block has at least one shrink object header */
290 __u32 sequenceNumber; /* block sequence number for yaffs2 */
295 /* -------------------------- Object structure -------------------------------*/
296 /* This is the object structure as stored on NAND */
299 yaffs_ObjectType type;
301 /* Apply to everything */
303 __u16 sum__NoLongerUsed; /* 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 */
309 #ifdef CONFIG_YAFFS_WINCE
310 __u32 notForWinCE[5];
319 /* File size applies to files only */
322 /* Equivalent object id applies to hard links only. */
323 int equivalentObjectId;
325 /* Alias is for symlinks only. */
326 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
328 __u32 yst_rdev; /* device stuff for block and char devices (major/min) */
330 #ifdef CONFIG_YAFFS_WINCE
338 __u32 inbandShadowsObject;
339 __u32 inbandIsShrink;
341 __u32 reservedSpace[2];
342 int shadowsObject; /* This object header shadows the specified object if > 0 */
344 /* isShrink applies to object headers written when we shrink the file (ie resize) */
347 } yaffs_ObjectHeader;
349 /*--------------------------- Tnode -------------------------- */
351 union yaffs_Tnode_union {
352 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
353 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
355 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
357 /* __u16 level0[YAFFS_NTNODES_LEVEL0]; */
361 typedef union yaffs_Tnode_union yaffs_Tnode;
363 struct yaffs_TnodeList_struct {
364 struct yaffs_TnodeList_struct *next;
368 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
370 /*------------------------ Object -----------------------------*/
371 /* An object can be one of:
372 * - a directory (no data, has children links
373 * - a regular file (data.... not prunes :->).
374 * - a symlink [symbolic link] (the alias).
380 __u32 scannedFileSize;
384 } yaffs_FileStructure;
387 struct ylist_head children; /* list of child links */
388 } yaffs_DirectoryStructure;
392 } yaffs_SymLinkStructure;
395 struct yaffs_ObjectStruct *equivalentObject;
396 __u32 equivalentObjectId;
397 } yaffs_HardLinkStructure;
400 yaffs_FileStructure fileVariant;
401 yaffs_DirectoryStructure directoryVariant;
402 yaffs_SymLinkStructure symLinkVariant;
403 yaffs_HardLinkStructure hardLinkVariant;
404 } yaffs_ObjectVariant;
406 struct yaffs_ObjectStruct {
407 __u8 deleted:1; /* This should only apply to unlinked files. */
408 __u8 softDeleted:1; /* it has also been soft deleted */
409 __u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/
410 __u8 fake:1; /* A fake object has no presence on NAND. */
411 __u8 renameAllowed:1; /* Some objects are not allowed to be renamed. */
412 __u8 unlinkAllowed:1;
413 __u8 dirty:1; /* the object needs to be written to flash */
414 __u8 valid:1; /* When the file system is being loaded up, this
415 * object might be created before the data
416 * is available (ie. file data records appear before the header).
418 __u8 lazyLoaded:1; /* This object has been lazy loaded and is missing some detail */
420 __u8 deferedFree:1; /* For Linux kernel. Object is removed from NAND, but is
421 * still in the inode cache. Free of object is defered.
422 * until the inode is released.
425 __u8 serial; /* serial number of chunk in NAND. Cached here */
426 __u16 sum; /* sum of the name to speed searching */
428 struct yaffs_DeviceStruct *myDev; /* The device I'm on */
430 struct ylist_head hashLink; /* list of objects in this hash bucket */
432 struct ylist_head hardLinks; /* all the equivalent hard linked objects */
434 /* directory structure stuff */
435 /* also used for linking up the free list */
436 struct yaffs_ObjectStruct *parent;
437 struct ylist_head siblings;
439 /* Where's my object header in NAND? */
442 int nDataChunks; /* Number of data chunks attached to the file. */
444 __u32 objectId; /* the object id value */
448 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
449 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
456 #ifdef CONFIG_YAFFS_WINCE
471 struct inode *myInode;
475 yaffs_ObjectType variantType;
477 yaffs_ObjectVariant variant;
481 typedef struct yaffs_ObjectStruct yaffs_Object;
483 struct yaffs_ObjectList_struct {
484 yaffs_Object *objects;
485 struct yaffs_ObjectList_struct *next;
488 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
491 struct ylist_head list;
493 } yaffs_ObjectBucket;
496 /* yaffs_CheckpointObject holds the definition of an object as dumped
505 yaffs_ObjectType variantType:3;
510 __u8 renameAllowed:1;
511 __u8 unlinkAllowed:1;
515 __u32 fileSizeOrEquivalentObjectId;
517 }yaffs_CheckpointObject;
519 /*--------------------- Temporary buffers ----------------
521 * These are chunk-sized working buffers. Each device has a few
526 int line; /* track from whence this buffer was allocated */
530 /*----------------- Device ---------------------------------*/
532 struct yaffs_DeviceStruct {
533 struct ylist_head devList;
536 /* Entry parameters set up way early. Yaffs sets up the rest.*/
537 int nDataBytesPerChunk; /* Should be a power of 2 >= 512 */
538 int nChunksPerBlock; /* does not need to be a power of 2 */
539 int spareBytesPerChunk;/* spare area size */
540 int startBlock; /* Start block we're allowed to use */
541 int endBlock; /* End block we're allowed to use */
542 int nReservedBlocks; /* We want this tuneable so that we can reduce */
543 /* reserved blocks on NOR and RAM. */
546 /* Stuff used by the shared space checkpointing mechanism */
547 /* If this value is zero, then this mechanism is disabled */
549 // int nCheckpointReservedBlocks; /* Blocks to reserve for checkpoint data */
554 int nShortOpCaches; /* If <= 0, then short op caching is disabled, else
555 * the number of short op caches (don't use too many)
558 int useHeaderFileSize; /* Flag to determine if we should use file sizes from the header */
560 int useNANDECC; /* Flag to decide whether or not to use NANDECC */
562 void *genericDevice; /* Pointer to device context
563 * On an mtd this holds the mtd pointer.
567 /* NAND access functions (Must be set before calling YAFFS)*/
569 int (*writeChunkToNAND) (struct yaffs_DeviceStruct * dev,
570 int chunkInNAND, const __u8 * data,
571 const yaffs_Spare * spare);
572 int (*readChunkFromNAND) (struct yaffs_DeviceStruct * dev,
573 int chunkInNAND, __u8 * data,
574 yaffs_Spare * spare);
575 int (*eraseBlockInNAND) (struct yaffs_DeviceStruct * dev,
577 int (*initialiseNAND) (struct yaffs_DeviceStruct * dev);
579 #ifdef CONFIG_YAFFS_YAFFS2
580 int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct * dev,
581 int chunkInNAND, const __u8 * data,
582 const yaffs_ExtendedTags * tags);
583 int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct * dev,
584 int chunkInNAND, __u8 * data,
585 yaffs_ExtendedTags * tags);
586 int (*markNANDBlockBad) (struct yaffs_DeviceStruct * dev, int blockNo);
587 int (*queryNANDBlock) (struct yaffs_DeviceStruct * dev, int blockNo,
588 yaffs_BlockState * state, __u32 *sequenceNumber);
593 /* The removeObjectCallback function must be supplied by OS flavours that
594 * need it. The Linux kernel does not use this, but yaffs direct does use
595 * it to implement the faster readdir
597 void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
599 /* Callback to mark the superblock dirsty */
600 void (*markSuperBlockDirty)(void * superblock);
602 int wideTnodesDisabled; /* Set to disable wide tnodes */
604 YCHAR *pathDividers; /* String of legal path dividers */
607 /* End of stuff that must be set before initialisation. */
609 /* Checkpoint control. Can be set before or after initialisation */
610 __u8 skipCheckpointRead;
611 __u8 skipCheckpointWrite;
613 /* Runtime parameters. Set up by YAFFS. */
615 __u16 chunkGroupBits; /* 0 for devices <= 32MB. else log2(nchunks) - 16 */
616 __u16 chunkGroupSize; /* == 2^^chunkGroupBits */
618 /* Stuff to support wide tnodes */
622 /* Stuff for figuring out file offset to chunk conversions */
623 __u32 chunkShift; /* Shift value */
624 __u32 chunkDiv; /* Divisor after shifting: 1 for power-of-2 sizes */
625 __u32 chunkMask; /* Mask to use for power-of-2 case */
627 /* Stuff to handle inband tags */
629 __u32 totalBytesPerChunk;
633 struct semaphore sem; /* Semaphore for waiting on erasure.*/
634 struct semaphore grossLock; /* Gross locking semaphore */
635 __u8 *spareBuffer; /* For mtdif2 use. Don't know the size of the buffer
636 * at compile time so we have to allocate it.
638 void (*putSuperFunc) (struct super_block * sb);
646 /* Stuff to support block offsetting to support start block zero */
647 int internalStartBlock;
648 int internalEndBlock;
653 /* Runtime checkpointing stuff */
654 int checkpointPageSequence; /* running sequence number of checkpoint pages */
655 int checkpointByteCount;
656 int checkpointByteOffset;
657 __u8 *checkpointBuffer;
658 int checkpointOpenForWrite;
659 int blocksInCheckpoint;
660 int checkpointCurrentChunk;
661 int checkpointCurrentBlock;
662 int checkpointNextBlock;
663 int *checkpointBlockList;
664 int checkpointMaxBlocks;
668 int nCheckpointBlocksRequired; /* Number of blocks needed to store current checkpoint set */
671 yaffs_BlockInfo *blockInfo;
672 __u8 *chunkBits; /* bitmap of chunks in use */
673 unsigned blockInfoAlt:1; /* was allocated using alternative strategy */
674 unsigned chunkBitsAlt:1; /* was allocated using alternative strategy */
675 int chunkBitmapStride; /* Number of bytes of chunkBits per block.
676 * Must be consistent with nChunksPerBlock.
680 int allocationBlock; /* Current block being allocated off */
681 __u32 allocationPage;
682 int allocationBlockFinder; /* Used to search for next allocation block */
686 yaffs_Tnode *freeTnodes;
688 yaffs_TnodeList *allocatedTnodeList;
693 yaffs_Object *freeObjects;
698 yaffs_ObjectList *allocatedObjectList;
700 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
704 int currentDirtyChecker; /* Used to find current dirtiest block */
706 __u32 *gcCleanupList; /* objects to delete at the end of a GC. */
707 int nonAggressiveSkip; /* GC state/mode */
713 int nErasureFailures;
715 int garbageCollections;
716 int passiveGarbageCollections;
724 int nUnmarkedDeletions;
726 int hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
728 /* Special directories */
729 yaffs_Object *rootDir;
730 yaffs_Object *lostNFoundDir;
732 /* Buffer areas for storing data to recover from write failures TODO
733 * __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
734 * yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
737 int bufferedBlock; /* Which block is buffered here? */
738 int doingBufferedBlockRewrite;
740 yaffs_ChunkCache *srCache;
745 /* Stuff for background deletion and unlinked files.*/
746 yaffs_Object *unlinkedDir; /* Directory where unlinked and deleted files live. */
747 yaffs_Object *deletedDir; /* Directory where deleted objects are sent to disappear. */
748 yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
749 int nDeletedFiles; /* Count of files awaiting deletion;*/
750 int nUnlinkedFiles; /* Count of unlinked files. */
751 int nBackgroundDeletions; /* Count of background deletions. */
754 /* Temporary buffer management */
755 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
758 int unmanagedTempAllocations;
759 int unmanagedTempDeallocations;
761 /* yaffs2 runtime stuff */
762 unsigned sequenceNumber; /* Sequence number of currently allocating block */
763 unsigned oldestDirtySequence;
767 typedef struct yaffs_DeviceStruct yaffs_Device;
769 /* The static layout of block usage etc is stored in the super block header */
773 int checkpointStartBlock;
774 int checkpointEndBlock;
778 } yaffs_SuperBlockHeader;
780 /* The CheckpointDevice structure holds the device information that changes at runtime and
781 * must be preserved over unmount/mount cycles.
786 int allocationBlock; /* Current block being allocated off */
787 __u32 allocationPage;
790 int nDeletedFiles; /* Count of files awaiting deletion;*/
791 int nUnlinkedFiles; /* Count of unlinked files. */
792 int nBackgroundDeletions; /* Count of background deletions. */
794 /* yaffs2 runtime stuff */
795 unsigned sequenceNumber; /* Sequence number of currently allocating block */
796 unsigned oldestDirtySequence;
798 } yaffs_CheckpointDevice;
806 } yaffs_CheckpointValidity;
809 /*----------------------- YAFFS Functions -----------------------*/
811 int yaffs_GutsInitialise(yaffs_Device * dev);
812 void yaffs_Deinitialise(yaffs_Device * dev);
814 int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev);
816 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
817 yaffs_Object * newDir, const YCHAR * newName);
819 int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name);
820 int yaffs_DeleteFile(yaffs_Object * obj);
822 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize);
823 int yaffs_GetObjectFileLength(yaffs_Object * obj);
824 int yaffs_GetObjectInode(yaffs_Object * obj);
825 unsigned yaffs_GetObjectType(yaffs_Object * obj);
826 int yaffs_GetObjectLinkCount(yaffs_Object * obj);
828 int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr);
829 int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr);
831 /* File operations */
832 int yaffs_ReadDataFromFile(yaffs_Object * obj, __u8 * buffer, loff_t offset,
834 int yaffs_WriteDataToFile(yaffs_Object * obj, const __u8 * buffer, loff_t offset,
835 int nBytes, int writeThrough);
836 int yaffs_ResizeFile(yaffs_Object * obj, loff_t newSize);
838 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
839 __u32 mode, __u32 uid, __u32 gid);
840 int yaffs_FlushFile(yaffs_Object * obj, int updateTime);
842 /* Flushing and checkpointing */
843 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
845 int yaffs_CheckpointSave(yaffs_Device *dev);
846 int yaffs_CheckpointRestore(yaffs_Device *dev);
848 /* Directory operations */
849 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
850 __u32 mode, __u32 uid, __u32 gid);
851 yaffs_Object *yaffs_FindObjectByName(yaffs_Object * theDir, const YCHAR * name);
852 int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir,
853 int (*fn) (yaffs_Object *));
855 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number);
857 /* Link operations */
858 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
859 yaffs_Object * equivalentObject);
861 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj);
863 /* Symlink operations */
864 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
865 __u32 mode, __u32 uid, __u32 gid,
866 const YCHAR * alias);
867 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj);
869 /* Special inodes (fifos, sockets and devices) */
870 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
871 __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
873 /* Special directories */
874 yaffs_Object *yaffs_Root(yaffs_Device * dev);
875 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev);
877 #ifdef CONFIG_YAFFS_WINCE
878 /* CONFIG_YAFFS_WINCE special stuff */
879 void yfsd_WinFileTimeNow(__u32 target[2]);
884 void yaffs_HandleDeferedFree(yaffs_Object * obj);
888 int yaffs_DumpObject(yaffs_Object * obj);
890 void yaffs_GutsTest(yaffs_Device * dev);
892 /* A few useful functions */
893 void yaffs_InitialiseTags(yaffs_ExtendedTags * tags);
894 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn);
895 int yaffs_CheckFF(__u8 * buffer, int nBytes);
896 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
898 __u8 *yaffs_GetTempBuffer(yaffs_Device * dev, int lineNo);
899 void yaffs_ReleaseTempBuffer(yaffs_Device * dev, __u8 * buffer, int lineNo);