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__
20 #include "devextras.h"
21 #include "yaffs_list.h"
30 * And what have we got...
32 #define YAFFS_MAGIC 0x5941FF53
34 #define YAFFS_NTNODES_LEVEL0 16
35 #define YAFFS_TNODES_LEVEL0_BITS 4
36 #define YAFFS_TNODES_LEVEL0_MASK 0xf
38 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
39 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
40 #define YAFFS_TNODES_INTERNAL_MASK 0x7
41 #define YAFFS_TNODES_MAX_LEVEL 6
43 #ifndef CONFIG_YAFFS_NO_YAFFS1
44 #define YAFFS_BYTES_PER_SPARE 16
45 #define YAFFS_BYTES_PER_CHUNK 512
46 #define YAFFS_CHUNK_SIZE_SHIFT 9
47 #define YAFFS_CHUNKS_PER_BLOCK 32
48 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
51 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE 1024
52 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
54 #define YAFFS_MAX_CHUNK_ID 0x000FFFFF
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
65 #define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE -1)
67 #define YAFFS_CHECKPOINT_VERSION 4
69 #ifdef CONFIG_YAFFS_UNICODE
70 #define YAFFS_MAX_NAME_LENGTH 127
71 #define YAFFS_MAX_ALIAS_LENGTH 79
73 #define YAFFS_MAX_NAME_LENGTH 255
74 #define YAFFS_MAX_ALIAS_LENGTH 159
77 #define YAFFS_SHORT_NAME_LENGTH 15
79 /* Some special object ids for pseudo objects */
80 #define YAFFS_OBJECTID_ROOT 1
81 #define YAFFS_OBJECTID_LOSTNFOUND 2
82 #define YAFFS_OBJECTID_UNLINKED 3
83 #define YAFFS_OBJECTID_DELETED 4
85 /* Pseudo object ids for checkpointing */
86 #define YAFFS_OBJECTID_SB_HEADER 0x10
87 #define YAFFS_OBJECTID_CHECKPOINT_DATA 0x20
88 #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. */
127 /* Tags structures in RAM
128 * NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
129 * the structure size will get blown out.
132 #ifndef CONFIG_YAFFS_NO_YAFFS1
135 unsigned serialNumber:2;
136 unsigned byteCountLSB:10;
137 unsigned objectId:18;
139 unsigned byteCountMSB:2;
149 /* Stuff used for extended tags in YAFFS2 */
152 YAFFS_ECC_RESULT_UNKNOWN,
153 YAFFS_ECC_RESULT_NO_ERROR,
154 YAFFS_ECC_RESULT_FIXED,
155 YAFFS_ECC_RESULT_UNFIXED
159 YAFFS_OBJECT_TYPE_UNKNOWN,
160 YAFFS_OBJECT_TYPE_FILE,
161 YAFFS_OBJECT_TYPE_SYMLINK,
162 YAFFS_OBJECT_TYPE_DIRECTORY,
163 YAFFS_OBJECT_TYPE_HARDLINK,
164 YAFFS_OBJECT_TYPE_SPECIAL
167 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
171 unsigned validMarker0;
172 unsigned chunkUsed; /* Status of the chunk: used or unused */
173 unsigned objectId; /* If 0 then this is not part of an object (unused) */
174 unsigned chunkId; /* If 0 then this is a header, else a data chunk */
175 unsigned byteCount; /* Only valid for data chunks */
177 /* The following stuff only has meaning when we read */
178 yaffs_ECCResult eccResult;
182 unsigned chunkDeleted; /* The chunk is marked deleted */
183 unsigned serialNumber; /* Yaffs1 2-bit serial number */
186 unsigned sequenceNumber; /* The sequence number of this block */
188 /* Extra info if this is an object header (YAFFS2 only) */
190 unsigned extraHeaderInfoAvailable; /* There is extra info available if this is not zero */
191 unsigned extraParentObjectId; /* The parent object */
192 unsigned extraIsShrinkHeader; /* Is it a shrink header? */
193 unsigned extraShadows; /* Does this shadow another object? */
195 yaffs_ObjectType extraObjectType; /* What object type? */
197 unsigned extraFileLength; /* Length if it is a file */
198 unsigned extraEquivalentObjectId; /* Equivalent object Id if it is a hard link */
200 unsigned validMarker1;
202 } yaffs_ExtendedTags;
204 /* Spare structure for YAFFS1 */
210 __u8 pageStatus; /* set to 0 to delete the chunk */
220 /*Special structure for passing through to mtd */
221 struct yaffs_NANDSpare {
227 /* Block data in RAM */
230 YAFFS_BLOCK_STATE_UNKNOWN = 0,
232 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.
251 * If a block is only partially allocated at mount it is treated as full.
254 YAFFS_BLOCK_STATE_FULL,
255 /* All the pages in this block have been allocated.
256 * If a block was only partially allocated when mounted we treat
257 * it as fully allocated.
260 YAFFS_BLOCK_STATE_DIRTY,
261 /* The block was full and now all chunks have been deleted.
262 * Erase me, reuse me.
265 YAFFS_BLOCK_STATE_CHECKPOINT,
266 /* 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;
366 /*------------------------ Object -----------------------------*/
367 /* An object can be one of:
368 * - a directory (no data, has children links
369 * - a regular file (data.... not prunes :->).
370 * - a symlink [symbolic link] (the alias).
376 __u32 scannedFileSize;
380 } yaffs_FileStructure;
383 struct ylist_head children; /* list of child links */
384 struct ylist_head dirty; /* Entry for list of dirty directories */
385 } yaffs_DirectoryStructure;
389 } yaffs_SymLinkStructure;
392 struct yaffs_ObjectStruct *equivalentObject;
393 __u32 equivalentObjectId;
394 } yaffs_HardLinkStructure;
397 yaffs_FileStructure fileVariant;
398 yaffs_DirectoryStructure directoryVariant;
399 yaffs_SymLinkStructure symLinkVariant;
400 yaffs_HardLinkStructure hardLinkVariant;
401 } yaffs_ObjectVariant;
405 struct yaffs_ObjectStruct {
406 __u8 deleted:1; /* This should only apply to unlinked files. */
407 __u8 softDeleted:1; /* it has also been soft deleted */
408 __u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/
409 __u8 fake:1; /* A fake object has no presence on NAND. */
410 __u8 renameAllowed:1; /* Some objects are not allowed to be renamed. */
411 __u8 unlinkAllowed:1;
412 __u8 dirty:1; /* the object needs to be written to flash */
413 __u8 valid:1; /* When the file system is being loaded up, this
414 * object might be created before the data
415 * is available (ie. file data records appear before the header).
417 __u8 lazyLoaded:1; /* This object has been lazy loaded and is missing some detail */
419 __u8 deferedFree:1; /* For Linux kernel. Object is removed from NAND, but is
420 * still in the inode cache. Free of object is defered.
421 * until the inode is released.
423 __u8 beingCreated:1; /* This object is still being created so skip some checks. */
424 __u8 isShadowed:1; /* This object is shadowed on the way to being renamed. */
426 __u8 xattrKnown:1; /* We know if this has object has xattribs or not. */
427 __u8 hasXattr:1; /* This object has xattribs. Valid if xattrKnown. */
429 __u8 serial; /* serial number of chunk in NAND. Cached here */
430 __u16 sum; /* sum of the name to speed searching */
432 struct yaffs_DeviceStruct *myDev; /* The device I'm on */
434 struct ylist_head hashLink; /* list of objects in this hash bucket */
436 struct ylist_head hardLinks; /* all the equivalent hard linked objects */
438 /* directory structure stuff */
439 /* also used for linking up the free list */
440 struct yaffs_ObjectStruct *parent;
441 struct ylist_head siblings;
443 /* Where's my object header in NAND? */
446 int nDataChunks; /* Number of data chunks attached to the file. */
448 __u32 objectId; /* the object id value */
452 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
453 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
456 #ifdef CONFIG_YAFFS_WINCE
472 yaffs_ObjectType variantType;
474 yaffs_ObjectVariant variant;
478 typedef struct yaffs_ObjectStruct yaffs_Object;
481 struct ylist_head list;
483 } yaffs_ObjectBucket;
486 /* yaffs_CheckpointObject holds the definition of an object as dumped
495 yaffs_ObjectType variantType:3;
500 __u8 renameAllowed:1;
501 __u8 unlinkAllowed:1;
505 __u32 fileSizeOrEquivalentObjectId;
506 } yaffs_CheckpointObject;
508 /*--------------------- Temporary buffers ----------------
510 * These are chunk-sized working buffers. Each device has a few
515 int line; /* track from whence this buffer was allocated */
519 /*----------------- Device ---------------------------------*/
522 struct yaffs_DeviceParamStruct {
526 * Entry parameters set up way early. Yaffs sets up the rest.
527 * The structure should be zeroed out before use so that unused
528 * and defualt values are zero.
531 int inbandTags; /* Use unband tags */
532 __u32 totalBytesPerChunk; /* Should be >= 512, does not need to be a power of 2 */
533 int nChunksPerBlock; /* does not need to be a power of 2 */
534 int spareBytesPerChunk; /* spare area size */
535 int startBlock; /* Start block we're allowed to use */
536 int endBlock; /* End block we're allowed to use */
537 int nReservedBlocks; /* We want this tuneable so that we can reduce */
538 /* reserved blocks on NOR and RAM. */
541 int nShortOpCaches; /* If <= 0, then short op caching is disabled, else
542 * the number of short op caches (don't use too many).
543 * 10 to 20 is a good bet.
545 int useNANDECC; /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
546 int noTagsECC; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
548 int isYaffs2; /* Use yaffs2 mode on this device */
550 int emptyLostAndFound; /* Auto-empty lost+found directory on mount */
552 int refreshPeriod; /* How often we should check to do a block refresh */
554 /* Checkpoint control. Can be set before or after initialisation */
555 __u8 skipCheckpointRead;
556 __u8 skipCheckpointWrite;
558 int enableXattr; /* Enable xattribs */
560 /* NAND access functions (Must be set before calling YAFFS)*/
562 int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
563 int chunkInNAND, const __u8 *data,
564 const yaffs_Spare *spare);
565 int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
566 int chunkInNAND, __u8 *data,
568 int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
570 int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
571 int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
573 #ifdef CONFIG_YAFFS_YAFFS2
574 int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
575 int chunkInNAND, const __u8 *data,
576 const yaffs_ExtendedTags *tags);
577 int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
578 int chunkInNAND, __u8 *data,
579 yaffs_ExtendedTags *tags);
580 int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
581 int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
582 yaffs_BlockState *state, __u32 *sequenceNumber);
585 /* The removeObjectCallback function must be supplied by OS flavours that
587 * yaffs direct uses it to implement the faster readdir.
588 * Linux uses it to protect the directory during unlocking.
590 void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
592 /* Callback to mark the superblock dirty */
593 void (*markSuperBlockDirty)(struct yaffs_DeviceStruct *dev);
595 /* Callback to control garbage collection. */
596 unsigned (*gcControl)(struct yaffs_DeviceStruct *dev);
598 /* Debug control flags. Don't use unless you know what you're doing */
599 int useHeaderFileSize; /* Flag to determine if we should use file sizes from the header */
600 int disableLazyLoad; /* Disable lazy loading on this device */
601 int wideTnodesDisabled; /* Set to disable wide tnodes */
602 int disableSoftDelete; /* yaffs 1 only: Set to disable the use of softdeletion. */
604 int deferDirectoryUpdate; /* Set to defer directory updates */
606 #ifdef CONFIG_YAFFS_AUTO_UNICODE
612 typedef struct yaffs_DeviceParamStruct yaffs_DeviceParam;
614 struct yaffs_DeviceStruct {
615 struct yaffs_DeviceParamStruct param;
617 /* Context storage. Holds extra OS specific data for this device */
622 struct ylist_head devList;
624 /* Runtime parameters. Set up by YAFFS. */
625 int nDataBytesPerChunk;
627 /* Non-wide tnode stuff */
628 __u16 chunkGroupBits; /* Number of bits that need to be resolved if
629 * the tnodes are not wide enough.
631 __u16 chunkGroupSize; /* == 2^^chunkGroupBits */
633 /* Stuff to support wide tnodes */
638 /* Stuff for figuring out file offset to chunk conversions */
639 __u32 chunkShift; /* Shift value */
640 __u32 chunkDiv; /* Divisor after shifting: 1 for power-of-2 sizes */
641 __u32 chunkMask; /* Mask to use for power-of-2 case */
650 /* Stuff to support block offsetting to support start block zero */
651 int internalStartBlock;
652 int internalEndBlock;
657 /* Runtime checkpointing stuff */
658 int checkpointPageSequence; /* running sequence number of checkpoint pages */
659 int checkpointByteCount;
660 int checkpointByteOffset;
661 __u8 *checkpointBuffer;
662 int checkpointOpenForWrite;
663 int blocksInCheckpoint;
664 int checkpointCurrentChunk;
665 int checkpointCurrentBlock;
666 int checkpointNextBlock;
667 int *checkpointBlockList;
668 int checkpointMaxBlocks;
672 int nCheckpointBlocksRequired; /* Number of blocks needed to store current checkpoint set */
675 yaffs_BlockInfo *blockInfo;
676 __u8 *chunkBits; /* bitmap of chunks in use */
677 unsigned blockInfoAlt:1; /* was allocated using alternative strategy */
678 unsigned chunkBitsAlt:1; /* was allocated using alternative strategy */
679 int chunkBitmapStride; /* Number of bytes of chunkBits per block.
680 * Must be consistent with nChunksPerBlock.
684 int allocationBlock; /* Current block being allocated off */
685 __u32 allocationPage;
686 int allocationBlockFinder; /* Used to search for next allocation block */
688 /* Object and Tnode memory management */
695 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
700 /* Garbage collection control */
701 __u32 *gcCleanupList; /* objects to delete at the end of a GC. */
704 unsigned hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
706 unsigned gcBlockFinder;
708 unsigned gcPagesInUse;
714 /* Special directories */
715 yaffs_Object *rootDir;
716 yaffs_Object *lostNFoundDir;
718 /* Buffer areas for storing data to recover from write failures TODO
719 * __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
720 * yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
723 int bufferedBlock; /* Which block is buffered here? */
724 int doingBufferedBlockRewrite;
726 yaffs_ChunkCache *srCache;
729 /* Stuff for background deletion and unlinked files.*/
730 yaffs_Object *unlinkedDir; /* Directory where unlinked and deleted files live. */
731 yaffs_Object *deletedDir; /* Directory where deleted objects are sent to disappear. */
732 yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
733 int nDeletedFiles; /* Count of files awaiting deletion;*/
734 int nUnlinkedFiles; /* Count of unlinked files. */
735 int nBackgroundDeletions; /* Count of background deletions. */
737 /* Temporary buffer management */
738 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
741 int unmanagedTempAllocations;
742 int unmanagedTempDeallocations;
744 /* yaffs2 runtime stuff */
745 unsigned sequenceNumber; /* Sequence number of currently allocating block */
746 unsigned oldestDirtySequence;
747 unsigned oldestDirtyBlock;
749 /* Block refreshing */
750 int refreshSkip; /* A skip down counter. Refresh happens when this gets to zero. */
752 /* Dirty directory handling */
753 struct ylist_head dirtyDirectories; /* List of dirty directories */
759 __u32 nBlockErasures;
760 __u32 nErasureFailures;
764 __u32 oldestDirtyGCs;
767 __u32 nRetriedWrites;
768 __u32 nRetiredBlocks;
772 __u32 tagsEccUnfixed;
774 __u32 nUnmarkedDeletions;
780 typedef struct yaffs_DeviceStruct yaffs_Device;
782 /* The static layout of block usage etc is stored in the super block header */
786 int checkpointStartBlock;
787 int checkpointEndBlock;
791 } yaffs_SuperBlockHeader;
793 /* The CheckpointDevice structure holds the device information that changes at runtime and
794 * must be preserved over unmount/mount cycles.
799 int allocationBlock; /* Current block being allocated off */
800 __u32 allocationPage;
803 int nDeletedFiles; /* Count of files awaiting deletion;*/
804 int nUnlinkedFiles; /* Count of unlinked files. */
805 int nBackgroundDeletions; /* Count of background deletions. */
807 /* yaffs2 runtime stuff */
808 unsigned sequenceNumber; /* Sequence number of currently allocating block */
810 } yaffs_CheckpointDevice;
818 } yaffs_CheckpointValidity;
821 struct yaffs_ShadowFixerStruct {
824 struct yaffs_ShadowFixerStruct *next;
827 /* Structure for doing xattr modifications */
829 int set; /* If 0 then this is a deletion */
838 /*----------------------- YAFFS Functions -----------------------*/
840 int yaffs_GutsInitialise(yaffs_Device *dev);
841 void yaffs_Deinitialise(yaffs_Device *dev);
843 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
845 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
846 yaffs_Object *newDir, const YCHAR *newName);
848 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
849 int yaffs_DeleteObject(yaffs_Object *obj);
851 int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
852 int yaffs_GetObjectFileLength(yaffs_Object *obj);
853 int yaffs_GetObjectInode(yaffs_Object *obj);
854 unsigned yaffs_GetObjectType(yaffs_Object *obj);
855 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
857 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
858 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
860 /* File operations */
861 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
863 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
864 int nBytes, int writeThrough);
865 int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
867 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
868 __u32 mode, __u32 uid, __u32 gid);
870 int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
872 /* Flushing and checkpointing */
873 void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
875 int yaffs_CheckpointSave(yaffs_Device *dev);
876 int yaffs_CheckpointRestore(yaffs_Device *dev);
878 /* Directory operations */
879 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
880 __u32 mode, __u32 uid, __u32 gid);
881 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
882 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
883 int (*fn) (yaffs_Object *));
885 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
887 /* Link operations */
888 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
889 yaffs_Object *equivalentObject);
891 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
893 /* Symlink operations */
894 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
895 __u32 mode, __u32 uid, __u32 gid,
897 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
899 /* Special inodes (fifos, sockets and devices) */
900 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
901 __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
904 int yaffs_SetXAttribute(yaffs_Object *obj, const YCHAR *name, const void * value, int size, int flags);
905 int yaffs_GetXAttribute(yaffs_Object *obj, const YCHAR *name, void *value, int size);
906 int yaffs_ListXAttributes(yaffs_Object *obj, char *buffer, int size);
907 int yaffs_RemoveXAttribute(yaffs_Object *obj, const YCHAR *name);
909 /* Special directories */
910 yaffs_Object *yaffs_Root(yaffs_Device *dev);
911 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
913 #ifdef CONFIG_YAFFS_WINCE
914 /* CONFIG_YAFFS_WINCE special stuff */
915 void yfsd_WinFileTimeNow(__u32 target[2]);
918 void yaffs_HandleDeferedFree(yaffs_Object *obj);
920 void yaffs_UpdateDirtyDirectories(yaffs_Device *dev);
922 int yaffs_BackgroundGarbageCollect(yaffs_Device *dev, unsigned urgency);
925 int yaffs_DumpObject(yaffs_Object *obj);
927 void yaffs_GutsTest(yaffs_Device *dev);
929 /* A few useful functions to be used within the core files*/
930 void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn);
931 int yaffs_CheckFF(__u8 *buffer, int nBytes);
932 void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
934 __u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo);
935 void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
937 yaffs_Object *yaffs_FindOrCreateObjectByNumber(yaffs_Device *dev,
939 yaffs_ObjectType type);
940 int yaffs_PutChunkIntoFile(yaffs_Object *in, int chunkInInode,
941 int chunkInNAND, int inScan);
942 void yaffs_SetObjectName(yaffs_Object *obj, const YCHAR *name);
943 void yaffs_SetObjectNameFromOH(yaffs_Object *obj, const yaffs_ObjectHeader *oh);
944 void yaffs_AddObjectToDirectory(yaffs_Object *directory,
946 YCHAR *yaffs_CloneString(const YCHAR *str);
947 void yaffs_HardlinkFixup(yaffs_Device *dev, yaffs_Object *hardList);
948 void yaffs_BlockBecameDirty(yaffs_Device *dev, int blockNo);
949 int yaffs_UpdateObjectHeader(yaffs_Object *in, const YCHAR *name,
950 int force, int isShrink, int shadows,
951 yaffs_XAttrMod *xop);
952 void yaffs_HandleShadowedObject(yaffs_Device *dev, int objId,
953 int backwardScanning);
954 int yaffs_CheckSpaceForAllocation(yaffs_Device *dev, int nChunks);
955 yaffs_Tnode *yaffs_GetTnode(yaffs_Device *dev);
956 yaffs_Tnode *yaffs_AddOrFindLevel0Tnode(yaffs_Device *dev,
957 yaffs_FileStructure *fStruct,
959 yaffs_Tnode *passedTn);
961 int yaffs_DoWriteDataToFile(yaffs_Object *in, const __u8 *buffer, loff_t offset,
962 int nBytes, int writeThrough);
963 void yaffs_ResizeDown( yaffs_Object *obj, loff_t newSize);
964 void yaffs_SkipRestOfBlock(yaffs_Device *dev);
966 int yaffs_CountFreeChunks(yaffs_Device *dev);
968 yaffs_Tnode *yaffs_FindLevel0Tnode(yaffs_Device *dev,
969 yaffs_FileStructure *fStruct,
972 __u32 yaffs_GetChunkGroupBase(yaffs_Device *dev, yaffs_Tnode *tn, unsigned pos);