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 /* Special sequence number for bad block that failed to be marked bad */
112 #define YAFFS_SEQUENCE_BAD_BLOCK 0xFFFF0000
114 /* ChunkCache is used for short read/write operations.*/
116 struct yaffs_ObjectStruct *object;
120 int nBytes; /* Only valid if the cache is dirty */
121 int locked; /* Can't push out or flush while locked. */
122 #ifdef CONFIG_YAFFS_YAFFS2
125 __u8 data[YAFFS_BYTES_PER_CHUNK];
131 /* Tags structures in RAM
132 * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
133 * the structure size will get blown out.
136 #ifndef CONFIG_YAFFS_NO_YAFFS1
139 unsigned serialNumber:2;
140 unsigned byteCountLSB:10;
141 unsigned objectId:18;
143 unsigned byteCountMSB:2;
153 /* Stuff used for extended tags in YAFFS2 */
156 YAFFS_ECC_RESULT_UNKNOWN,
157 YAFFS_ECC_RESULT_NO_ERROR,
158 YAFFS_ECC_RESULT_FIXED,
159 YAFFS_ECC_RESULT_UNFIXED
163 YAFFS_OBJECT_TYPE_UNKNOWN,
164 YAFFS_OBJECT_TYPE_FILE,
165 YAFFS_OBJECT_TYPE_SYMLINK,
166 YAFFS_OBJECT_TYPE_DIRECTORY,
167 YAFFS_OBJECT_TYPE_HARDLINK,
168 YAFFS_OBJECT_TYPE_SPECIAL
171 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
175 unsigned validMarker0;
176 unsigned chunkUsed; /* Status of the chunk: used or unused */
177 unsigned objectId; /* If 0 then this is not part of an object (unused) */
178 unsigned chunkId; /* If 0 then this is a header, else a data chunk */
179 unsigned byteCount; /* Only valid for data chunks */
181 /* The following stuff only has meaning when we read */
182 yaffs_ECCResult eccResult;
186 unsigned chunkDeleted; /* The chunk is marked deleted */
187 unsigned serialNumber; /* Yaffs1 2-bit serial number */
190 unsigned sequenceNumber; /* The sequence number of this block */
192 /* Extra info if this is an object header (YAFFS2 only) */
194 unsigned extraHeaderInfoAvailable; /* There is extra info available if this is not zero */
195 unsigned extraParentObjectId; /* The parent object */
196 unsigned extraIsShrinkHeader; /* Is it a shrink header? */
197 unsigned extraShadows; /* Does this shadow another object? */
199 yaffs_ObjectType extraObjectType; /* What object type? */
201 unsigned extraFileLength; /* Length if it is a file */
202 unsigned extraEquivalentObjectId; /* Equivalent object Id if it is a hard link */
204 unsigned validMarker1;
206 } yaffs_ExtendedTags;
208 /* Spare structure for YAFFS1 */
214 __u8 pageStatus; /* set to 0 to delete the chunk */
224 /*Special structure for passing through to mtd */
225 struct yaffs_NANDSpare {
231 /* Block data in RAM */
234 YAFFS_BLOCK_STATE_UNKNOWN = 0,
236 YAFFS_BLOCK_STATE_SCANNING,
237 YAFFS_BLOCK_STATE_NEEDS_SCANNING,
238 /* The block might have something on it (ie it is allocating or full, perhaps empty)
239 * but it needs to be scanned to determine its true state.
240 * This state is only valid during yaffs_Scan.
241 * NB We tolerate empty because the pre-scanner might be incapable of deciding
242 * However, if this state is returned on a YAFFS2 device, then we expect a sequence number
245 YAFFS_BLOCK_STATE_EMPTY,
246 /* This block is empty */
248 YAFFS_BLOCK_STATE_ALLOCATING,
249 /* This block is partially allocated.
250 * At least one page holds valid data.
251 * This is the one currently being used for page
252 * allocation. Should never be more than one of these
255 YAFFS_BLOCK_STATE_FULL,
256 /* All the pages in this block have been allocated.
259 YAFFS_BLOCK_STATE_DIRTY,
260 /* All pages have been allocated and deleted.
261 * Erase me, reuse me.
264 YAFFS_BLOCK_STATE_CHECKPOINT,
265 /* This block is assigned to holding checkpoint data.
268 YAFFS_BLOCK_STATE_COLLECTING,
269 /* This block is being garbage collected */
271 YAFFS_BLOCK_STATE_DEAD
272 /* This block has failed and is not in use */
275 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
280 int softDeletions:10; /* number of soft deleted pages */
281 int pagesInUse:10; /* number of pages in use */
282 unsigned blockState:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
283 __u32 needsRetiring:1; /* Data has failed on this block, need to get valid data off */
284 /* and retire the block. */
285 __u32 skipErasedCheck:1; /* If this is set we can skip the erased check on this block */
286 __u32 gcPrioritise:1; /* An ECC check or blank check has failed on this block.
287 It should be prioritised for GC */
288 __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
290 #ifdef CONFIG_YAFFS_YAFFS2
291 __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */
292 __u32 sequenceNumber; /* block sequence number for yaffs2 */
297 /* -------------------------- Object structure -------------------------------*/
298 /* This is the object structure as stored on NAND */
301 yaffs_ObjectType type;
303 /* Apply to everything */
305 __u16 sum__NoLongerUsed; /* checksum of name. No longer used */
306 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
308 /* The following apply to directories, files, symlinks - not hard links */
309 __u32 yst_mode; /* protection */
311 #ifdef CONFIG_YAFFS_WINCE
312 __u32 notForWinCE[5];
321 /* File size applies to files only */
324 /* Equivalent object id applies to hard links only. */
325 int equivalentObjectId;
327 /* Alias is for symlinks only. */
328 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
330 __u32 yst_rdev; /* device stuff for block and char devices (major/min) */
332 #ifdef CONFIG_YAFFS_WINCE
340 __u32 inbandShadowsObject;
341 __u32 inbandIsShrink;
343 __u32 reservedSpace[2];
344 int shadowsObject; /* This object header shadows the specified object if > 0 */
346 /* isShrink applies to object headers written when we shrink the file (ie resize) */
349 } yaffs_ObjectHeader;
351 /*--------------------------- Tnode -------------------------- */
353 union yaffs_Tnode_union {
354 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
355 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
357 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
359 /* __u16 level0[YAFFS_NTNODES_LEVEL0]; */
363 typedef union yaffs_Tnode_union yaffs_Tnode;
365 struct yaffs_TnodeList_struct {
366 struct yaffs_TnodeList_struct *next;
370 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
372 /*------------------------ Object -----------------------------*/
373 /* An object can be one of:
374 * - a directory (no data, has children links
375 * - a regular file (data.... not prunes :->).
376 * - a symlink [symbolic link] (the alias).
382 __u32 scannedFileSize;
386 } yaffs_FileStructure;
389 struct ylist_head children; /* list of child links */
390 } yaffs_DirectoryStructure;
394 } yaffs_SymLinkStructure;
397 struct yaffs_ObjectStruct *equivalentObject;
398 __u32 equivalentObjectId;
399 } yaffs_HardLinkStructure;
402 yaffs_FileStructure fileVariant;
403 yaffs_DirectoryStructure directoryVariant;
404 yaffs_SymLinkStructure symLinkVariant;
405 yaffs_HardLinkStructure hardLinkVariant;
406 } yaffs_ObjectVariant;
408 struct yaffs_ObjectStruct {
409 __u8 deleted:1; /* This should only apply to unlinked files. */
410 __u8 softDeleted:1; /* it has also been soft deleted */
411 __u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/
412 __u8 fake:1; /* A fake object has no presence on NAND. */
413 __u8 renameAllowed:1; /* Some objects are not allowed to be renamed. */
414 __u8 unlinkAllowed:1;
415 __u8 dirty:1; /* the object needs to be written to flash */
416 __u8 valid:1; /* When the file system is being loaded up, this
417 * object might be created before the data
418 * is available (ie. file data records appear before the header).
420 __u8 lazyLoaded:1; /* This object has been lazy loaded and is missing some detail */
422 __u8 deferedFree:1; /* For Linux kernel. Object is removed from NAND, but is
423 * still in the inode cache. Free of object is defered.
424 * until the inode is released.
426 __u8 beingCreated:1; /* This object is still being created so skip some checks. */
428 __u8 serial; /* serial number of chunk in NAND. Cached here */
429 __u16 sum; /* sum of the name to speed searching */
431 struct yaffs_DeviceStruct *myDev; /* The device I'm on */
433 struct ylist_head hashLink; /* list of objects in this hash bucket */
435 struct ylist_head hardLinks; /* all the equivalent hard linked objects */
437 /* directory structure stuff */
438 /* also used for linking up the free list */
439 struct yaffs_ObjectStruct *parent;
440 struct ylist_head siblings;
442 /* Where's my object header in NAND? */
445 int nDataChunks; /* Number of data chunks attached to the file. */
447 __u32 objectId; /* the object id value */
451 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
452 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
459 #ifdef CONFIG_YAFFS_WINCE
474 struct inode *myInode;
478 yaffs_ObjectType variantType;
480 yaffs_ObjectVariant variant;
484 typedef struct yaffs_ObjectStruct yaffs_Object;
486 struct yaffs_ObjectList_struct {
487 yaffs_Object *objects;
488 struct yaffs_ObjectList_struct *next;
491 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
494 struct ylist_head list;
496 } yaffs_ObjectBucket;
499 /* yaffs_CheckpointObject holds the definition of an object as dumped
508 yaffs_ObjectType variantType:3;
513 __u8 renameAllowed:1;
514 __u8 unlinkAllowed:1;
518 __u32 fileSizeOrEquivalentObjectId;
519 } yaffs_CheckpointObject;
521 /*--------------------- Temporary buffers ----------------
523 * These are chunk-sized working buffers. Each device has a few
528 int line; /* track from whence this buffer was allocated */
532 /*----------------- Device ---------------------------------*/
534 struct yaffs_DeviceStruct {
535 struct ylist_head devList;
538 /* Entry parameters set up way early. Yaffs sets up the rest.*/
539 int nDataBytesPerChunk; /* Should be a power of 2 >= 512 */
540 int nChunksPerBlock; /* does not need to be a power of 2 */
541 int spareBytesPerChunk; /* spare area size */
542 int startBlock; /* Start block we're allowed to use */
543 int endBlock; /* End block we're allowed to use */
544 int nReservedBlocks; /* We want this tuneable so that we can reduce */
545 /* reserved blocks on NOR and RAM. */
548 /* Stuff used by the shared space checkpointing mechanism */
549 /* If this value is zero, then this mechanism is disabled */
551 /* 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 on data (yaffs1) */
561 int noTagsECC; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
563 void *genericDevice; /* Pointer to device context
564 * On an mtd this holds the mtd pointer.
568 /* NAND access functions (Must be set before calling YAFFS)*/
570 int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
571 int chunkInNAND, const __u8 *data,
572 const yaffs_Spare *spare);
573 int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
574 int chunkInNAND, __u8 *data,
576 int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
578 int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
579 int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
581 #ifdef CONFIG_YAFFS_YAFFS2
582 int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
583 int chunkInNAND, const __u8 *data,
584 const yaffs_ExtendedTags *tags);
585 int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
586 int chunkInNAND, __u8 *data,
587 yaffs_ExtendedTags *tags);
588 int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
589 int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
590 yaffs_BlockState *state, __u32 *sequenceNumber);
595 /* The removeObjectCallback function must be supplied by OS flavours that
596 * need it. The Linux kernel does not use this, but yaffs direct does use
597 * it to implement the faster readdir
599 void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
601 /* Callback to mark the superblock dirsty */
602 void (*markSuperBlockDirty)(void *superblock);
604 int wideTnodesDisabled; /* Set to disable wide tnodes */
606 YCHAR *pathDividers; /* String of legal path dividers */
609 /* End of stuff that must be set before initialisation. */
611 /* Checkpoint control. Can be set before or after initialisation */
612 __u8 skipCheckpointRead;
613 __u8 skipCheckpointWrite;
615 /* Runtime parameters. Set up by YAFFS. */
617 __u16 chunkGroupBits; /* 0 for devices <= 32MB. else log2(nchunks) - 16 */
618 __u16 chunkGroupSize; /* == 2^^chunkGroupBits */
620 /* Stuff to support wide tnodes */
624 /* Stuff for figuring out file offset to chunk conversions */
625 __u32 chunkShift; /* Shift value */
626 __u32 chunkDiv; /* Divisor after shifting: 1 for power-of-2 sizes */
627 __u32 chunkMask; /* Mask to use for power-of-2 case */
629 /* Stuff to handle inband tags */
631 __u32 totalBytesPerChunk;
635 struct semaphore sem; /* Semaphore for waiting on erasure.*/
636 struct semaphore grossLock; /* Gross locking semaphore */
637 __u8 *spareBuffer; /* For mtdif2 use. Don't know the size of the buffer
638 * at compile time so we have to allocate it.
640 void (*putSuperFunc) (struct super_block *sb);
648 /* Stuff to support block offsetting to support start block zero */
649 int internalStartBlock;
650 int internalEndBlock;
655 /* Runtime checkpointing stuff */
656 int checkpointPageSequence; /* running sequence number of checkpoint pages */
657 int checkpointByteCount;
658 int checkpointByteOffset;
659 __u8 *checkpointBuffer;
660 int checkpointOpenForWrite;
661 int blocksInCheckpoint;
662 int checkpointCurrentChunk;
663 int checkpointCurrentBlock;
664 int checkpointNextBlock;
665 int *checkpointBlockList;
666 int checkpointMaxBlocks;
670 int nCheckpointBlocksRequired; /* Number of blocks needed to store current checkpoint set */
673 yaffs_BlockInfo *blockInfo;
674 __u8 *chunkBits; /* bitmap of chunks in use */
675 unsigned blockInfoAlt:1; /* was allocated using alternative strategy */
676 unsigned chunkBitsAlt:1; /* was allocated using alternative strategy */
677 int chunkBitmapStride; /* Number of bytes of chunkBits per block.
678 * Must be consistent with nChunksPerBlock.
682 int allocationBlock; /* Current block being allocated off */
683 __u32 allocationPage;
684 int allocationBlockFinder; /* Used to search for next allocation block */
688 yaffs_Tnode *freeTnodes;
690 yaffs_TnodeList *allocatedTnodeList;
697 yaffs_Object *freeObjects;
702 yaffs_ObjectList *allocatedObjectList;
704 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
708 int currentDirtyChecker; /* Used to find current dirtiest block */
710 __u32 *gcCleanupList; /* objects to delete at the end of a GC. */
711 int nonAggressiveSkip; /* GC state/mode */
717 int nErasureFailures;
719 int garbageCollections;
720 int passiveGarbageCollections;
728 int nUnmarkedDeletions;
730 int hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
732 /* Special directories */
733 yaffs_Object *rootDir;
734 yaffs_Object *lostNFoundDir;
736 /* Buffer areas for storing data to recover from write failures TODO
737 * __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
738 * yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
741 int bufferedBlock; /* Which block is buffered here? */
742 int doingBufferedBlockRewrite;
744 yaffs_ChunkCache *srCache;
749 /* Stuff for background deletion and unlinked files.*/
750 yaffs_Object *unlinkedDir; /* Directory where unlinked and deleted files live. */
751 yaffs_Object *deletedDir; /* Directory where deleted objects are sent to disappear. */
752 yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
753 int nDeletedFiles; /* Count of files awaiting deletion;*/
754 int nUnlinkedFiles; /* Count of unlinked files. */
755 int nBackgroundDeletions; /* Count of background deletions. */
758 /* Temporary buffer management */
759 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
762 int unmanagedTempAllocations;
763 int unmanagedTempDeallocations;
765 /* yaffs2 runtime stuff */
766 unsigned sequenceNumber; /* Sequence number of currently allocating block */
767 unsigned oldestDirtySequence;
771 typedef struct yaffs_DeviceStruct yaffs_Device;
773 /* The static layout of block usage etc is stored in the super block header */
777 int checkpointStartBlock;
778 int checkpointEndBlock;
782 } yaffs_SuperBlockHeader;
784 /* The CheckpointDevice structure holds the device information that changes at runtime and
785 * must be preserved over unmount/mount cycles.
790 int allocationBlock; /* Current block being allocated off */
791 __u32 allocationPage;
794 int nDeletedFiles; /* Count of files awaiting deletion;*/
795 int nUnlinkedFiles; /* Count of unlinked files. */
796 int nBackgroundDeletions; /* Count of background deletions. */
798 /* yaffs2 runtime stuff */
799 unsigned sequenceNumber; /* Sequence number of currently allocating block */
800 unsigned oldestDirtySequence;
802 } yaffs_CheckpointDevice;
810 } yaffs_CheckpointValidity;
813 /*----------------------- YAFFS Functions -----------------------*/
815 int yaffs_GutsInitialise(yaffs_Device *dev);
816 void yaffs_Deinitialise(yaffs_Device *dev);
818 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
820 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
821 yaffs_Object *newDir, const YCHAR *newName);
823 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
824 int yaffs_DeleteObject(yaffs_Object *obj);
826 int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
827 int yaffs_GetObjectFileLength(yaffs_Object *obj);
828 int yaffs_GetObjectInode(yaffs_Object *obj);
829 unsigned yaffs_GetObjectType(yaffs_Object *obj);
830 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
832 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
833 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
835 /* File operations */
836 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
838 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
839 int nBytes, int writeThrough);
840 int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
842 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
843 __u32 mode, __u32 uid, __u32 gid);
845 int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
847 /* Flushing and checkpointing */
848 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
850 int yaffs_CheckpointSave(yaffs_Device *dev);
851 int yaffs_CheckpointRestore(yaffs_Device *dev);
853 /* Directory operations */
854 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
855 __u32 mode, __u32 uid, __u32 gid);
856 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
857 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
858 int (*fn) (yaffs_Object *));
860 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
862 /* Link operations */
863 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
864 yaffs_Object *equivalentObject);
866 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
868 /* Symlink operations */
869 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
870 __u32 mode, __u32 uid, __u32 gid,
872 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
874 /* Special inodes (fifos, sockets and devices) */
875 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
876 __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
878 /* Special directories */
879 yaffs_Object *yaffs_Root(yaffs_Device *dev);
880 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
882 #ifdef CONFIG_YAFFS_WINCE
883 /* CONFIG_YAFFS_WINCE special stuff */
884 void yfsd_WinFileTimeNow(__u32 target[2]);
889 void yaffs_HandleDeferedFree(yaffs_Object *obj);
893 int yaffs_DumpObject(yaffs_Object *obj);
895 void yaffs_GutsTest(yaffs_Device *dev);
897 /* A few useful functions */
898 void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
899 void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn);
900 int yaffs_CheckFF(__u8 *buffer, int nBytes);
901 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
903 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo);
904 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);