2 * YAFFS: Yet another FFS. A NAND-flash specific file system.
3 * yaffs_guts.h: Configuration etc for yaffs_guts
5 * Copyright (C) 2002 Aleph One Ltd.
6 * for Toby Churchill Ltd and Brightstar Engineering
8 * Created by Charles Manning <charles@aleph1.co.uk>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 2.1 as
12 * published by the Free Software Foundation.
15 * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
17 * $Id: yaffs_guts.h,v 1.2 2004-11-16 02:36:15 charles Exp $
20 #ifndef __YAFFS_GUTS_H__
21 #define __YAFFS_GUTS_H__
23 #include "devextras.h"
33 // And what have we got...
34 #define YAFFS_MAGIC 0x5941FF53
36 #define YAFFS_NTNODES_LEVEL0 16
37 #define YAFFS_TNODES_LEVEL0_BITS 4
38 #define YAFFS_TNODES_LEVEL0_MASK 0xf
40 #define YAFFS_NTNODES_INTERNAL (YAFFS_NTNODES_LEVEL0 / 2)
41 #define YAFFS_TNODES_INTERNAL_BITS (YAFFS_TNODES_LEVEL0_BITS - 1)
42 #define YAFFS_TNODES_INTERNAL_MASK 0x7
43 #define YAFFS_TNODES_MAX_LEVEL 6
45 #ifndef CONFIG_YAFFS_NO_YAFFS1
46 #define YAFFS_BYTES_PER_SPARE 16
47 #define YAFFS_BYTES_PER_CHUNK 512
48 #define YAFFS_CHUNK_SIZE_SHIFT 9
49 #define YAFFS_CHUNKS_PER_BLOCK 32
50 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
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 #ifdef CONFIG_YAFFS_UNICODE
67 #define YAFFS_MAX_NAME_LENGTH 127
68 #define YAFFS_MAX_ALIAS_LENGTH 79
70 #define YAFFS_MAX_NAME_LENGTH 255
71 #define YAFFS_MAX_ALIAS_LENGTH 159
74 #define YAFFS_SHORT_NAME_LENGTH 15
77 #define YAFFS_OBJECTID_ROOT 1
78 #define YAFFS_OBJECTID_LOSTNFOUND 2
79 #define YAFFS_OBJECTID_UNLINKED 3
80 #define YAFFS_OBJECTID_DELETED 4
82 #define YAFFS_MAX_SHORT_OP_CACHES 20
84 #define YAFFS_N_TEMP_BUFFERS 4
86 // Sequence numbers are used in YAFFS2 to determine block allocation order.
87 // The range is limited slightly to help distinguish bad numbers from good.
88 // This also allows us to perhaps in the future use special numbers for
90 // EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
91 // and is a larger number than the lifetime of a 2GB device.
93 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
94 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00
97 // ChunkCache is used for short read/write operations.
100 struct yaffs_ObjectStruct *object;
104 int nBytes; // Only valid if the cache is dirty
105 int locked; // Can't push out or flush while locked..
106 #ifdef CONFIG_YAFFS_YAFFS2
109 __u8 data[YAFFS_BYTES_PER_CHUNK];
114 #ifndef CONFIG_YAFFS_NO_YAFFS1
115 // Tags structures in RAM
116 // NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
117 // the structure size will get blown out.
122 unsigned serialNumber:2;
123 unsigned byteCount:10;
124 unsigned objectId:18;
126 unsigned unusedStuff:2;
140 YAFFS_ECC_RESULT_UNKNOWN,
141 YAFFS_ECC_RESULT_NO_ERROR,
142 YAFFS_ECC_RESULT_FIXED,
143 YAFFS_ECC_RESULT_UNFIXED
149 unsigned validMarker0;
150 unsigned chunkUsed; // Status of the chunk: used or unused
151 unsigned objectId; // If 0 then this is not part of an object (unused)
152 unsigned chunkId; // If 0 then this is a header
153 unsigned byteCount; // Only valid for data chunks
154 // The following stuff only has meaning when we read
155 yaffs_ECCResult eccResult; // Only valid when we read.
156 unsigned blockBad; // Only valid on reading
159 unsigned chunkDeleted; // The chunk is marked deleted
160 unsigned serialNumber; // Yaffs1 2-bit serial number
163 unsigned sequenceNumber; // The sequence number of this block
165 unsigned validMarker1;
167 } yaffs_ExtendedTags;
169 #ifndef CONFIG_YAFFS_NO_YAFFS1
177 __u8 pageStatus; // set to 0 to delete the chunk
187 //Special structure for passing through to mtd
188 struct yaffs_NANDSpare {
199 YAFFS_BLOCK_STATE_UNKNOWN = 0,
201 YAFFS_BLOCK_STATE_SCANNING,
202 YAFFS_BLOCK_STATE_NEEDS_SCANNING,// The block might have something on it (ie it is allocating or full, perhaps empty)
203 // but it needs to be scanned to determine its true state.
204 // This state is only valid during yaffs_Scan.
205 // NB We tolerate empty because the pre-scanner might be incapable of deciding
206 // However, if this state is returned on a YAFFS2 device, then we expect a sequence number
208 YAFFS_BLOCK_STATE_EMPTY, // This block is empty
210 YAFFS_BLOCK_STATE_ALLOCATING, // This block is partially allocated.
211 // This is the one currently being used for page
212 // allocation. Should never be more than one of these
215 YAFFS_BLOCK_STATE_FULL, // All the pages in this block have been allocated.
216 // At least one page holds valid data.
218 YAFFS_BLOCK_STATE_DIRTY, // All pages have been allocated and deleted.
219 // Erase me, reuse me.
221 YAFFS_BLOCK_STATE_COLLECTING, // This block is being garbage collected
223 YAFFS_BLOCK_STATE_DEAD // This block has failed and is not in use
233 int softDeletions:8; // number of soft deleted pages
234 int pagesInUse:8; // number of pages in use
235 __u32 blockState:4; // One of the above block states
236 __u32 needsRetiring:1; // Data has failed on this block, need to get valid data off
237 // and retire the block.
238 #ifdef CONFIG_YAFFS_YAFFS2
239 __u32 hasShrinkHeader:1;// This block has at least one object header that does a shrink
240 __u32 sequenceNumber; // block sequence number for yaffs2
246 //////////////////// Object structure ///////////////////////////
247 // This is the object structure as stored on NAND
251 YAFFS_OBJECT_TYPE_UNKNOWN,
252 YAFFS_OBJECT_TYPE_FILE,
253 YAFFS_OBJECT_TYPE_SYMLINK,
254 YAFFS_OBJECT_TYPE_DIRECTORY,
255 YAFFS_OBJECT_TYPE_HARDLINK,
256 YAFFS_OBJECT_TYPE_SPECIAL
261 yaffs_ObjectType type;
263 // Apply to everything
265 __u16 sum__NoLongerUsed; // checksum of name. Calc this off the name to prevent inconsistencies
266 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
268 // Thes following apply to directories, files, symlinks - not hard links
269 __u32 st_mode; // protection
271 #ifdef CONFIG_YAFFS_WINCE
272 __u32 notForWinCE[5];
274 __u32 st_uid; // user ID of owner
275 __u32 st_gid; // group ID of owner
276 __u32 st_atime; // time of last access
277 __u32 st_mtime; // time of last modification
278 __u32 st_ctime; // time of last change
281 // File size applies to files only
284 // Equivalent object id applies to hard links only.
285 int equivalentObjectId;
287 // Alias is for symlinks only.
288 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
290 __u32 st_rdev; // device stuff for block and char devices (maj/min)
292 #ifdef CONFIG_YAFFS_WINCE
298 __u32 roomToGrow[11];
301 // isShrink applies to bject headers written when we shrink the file (ie resize)
304 } yaffs_ObjectHeader;
308 //////////////////// Tnode ///////////////////////////
310 union yaffs_Tnode_union
312 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
313 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL+1];
315 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
317 __u16 level0[YAFFS_NTNODES_LEVEL0];
321 typedef union yaffs_Tnode_union yaffs_Tnode;
323 struct yaffs_TnodeList_struct
325 struct yaffs_TnodeList_struct *next;
329 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
333 /////////////////// Object ////////////////////////////////
334 // An object can be one of:
335 // - a directory (no data, has children links
336 // - a regular file (data.... not prunes :->).
337 // - a symlink [symbolic link] (the alias).
344 __u32 scannedFileSize;
347 } yaffs_FileStructure;
351 struct list_head children; // list of child links
352 } yaffs_DirectoryStructure;
357 } yaffs_SymLinkStructure;
361 struct yaffs_ObjectStruct *equivalentObject;
362 __u32 equivalentObjectId;
363 } yaffs_HardLinkStructure;
367 yaffs_FileStructure fileVariant;
368 yaffs_DirectoryStructure directoryVariant;
369 yaffs_SymLinkStructure symLinkVariant;
370 yaffs_HardLinkStructure hardLinkVariant;
371 } yaffs_ObjectVariant;
374 struct yaffs_ObjectStruct
376 __u8 deleted: 1; // This should only apply to unlinked files.
377 __u8 softDeleted: 1; // it has also been soft deleted
378 __u8 unlinked: 1; // An unlinked file. The file should be in the unlinked pseudo directory.
379 __u8 fake:1; // A fake object has no presence on NAND.
380 __u8 renameAllowed:1;
381 __u8 unlinkAllowed:1;
382 __u8 dirty:1; // the object needs to be written to flash
383 __u8 valid:1; // When the file system is being loaded up, this
384 // object might be created before the data
385 // is available (ie. file data records appear before the header).
386 __u8 serial; // serial number of chunk in NAND. Store here so we don't have to
388 __u8 deferedFree: 1; // For Linux kernel. Object is removed from NAND, but still in the inode cache.
389 // Free of object is defered.
391 // read back the old one to update.
392 __u16 sum; // sum of the name to speed searching
394 struct yaffs_DeviceStruct *myDev; // The device I'm on
397 struct list_head hashLink; // list of objects in this hash bucket
400 struct list_head hardLinks; // all the equivalent hard linked objects
402 // directory structure stuff
403 struct yaffs_ObjectStruct *parent; //my parent directory
404 struct list_head siblings; // siblings in a directory
405 // also used for linking up the free list
407 // Where's my data in NAND?
408 int chunkId; // where it lives
412 __u32 objectId; // the object id value
415 __u32 st_mode; // protection
417 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
418 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH+1];
425 #ifdef CONFIG_YAFFS_WINCE
430 __u32 st_uid; // user ID of owner
431 __u32 st_gid; // group ID of owner
432 __u32 st_atime; // time of last access
433 __u32 st_mtime; // time of last modification
434 __u32 st_ctime; // time of last change
437 __u32 st_rdev; // device stuff for block and char devices
442 struct inode *myInode;
448 yaffs_ObjectType variantType;
450 yaffs_ObjectVariant variant;
456 typedef struct yaffs_ObjectStruct yaffs_Object;
459 struct yaffs_ObjectList_struct
461 yaffs_Object *objects;
462 struct yaffs_ObjectList_struct *next;
465 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
469 struct list_head list;
471 } yaffs_ObjectBucket;
473 ///////////////////// Temporary buffers ////////////////////
475 // These are chunk-sized working buffers. Each device has a few
479 int line; // track from whence this buffer was allocated
483 //////////////////// Device ////////////////////////////////
485 struct yaffs_DeviceStruct
487 // Entry parameters set up way early. Yaffs sets up the rest.
488 int nBytesPerChunk; // Should be a power of 2 >= 512
489 int nChunksPerBlock; // does not need to be a power of 2
490 int nBytesPerSpare; // spare area size
491 int startBlock; // Start block we're allowed to use
492 int endBlock; // End block we're allowed to use
493 int nReservedBlocks; // We want this tuneable so that we can reduce
494 // reserved blocks on NOR and RAM.
496 int nShortOpCaches; // If <= 0, then short op caching is disabled, else
497 // the number of short op caches (don't use too many).
499 int useHeaderFileSize; // Flag to determine if we should use file sizes from the header
501 int useNANDECC; // Flag to decide whether or not to use NANDECC
504 void *genericDevice; // Pointer to device context
505 // On an mtd this holds the mtd pointer.
507 // NAND access functions (Must be set before calling YAFFS)
510 int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, const yaffs_Spare *spare);
511 int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
512 int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
513 int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
515 #ifdef CONFIG_YAFFS_YAFFS2
516 int (*writeChunkWithTagsToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_ExtendedTags *tags);
517 int (*readChunkWithTagsFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_ExtendedTags *tags);
518 int (*markNANDBlockBad)(struct yaffs_DeviceStruct *dev, int blockNo);
519 int (*queryNANDBlock)(struct yaffs_DeviceStruct *dev, int blockNo, yaffs_BlockState *state, int *sequenceNumber);
524 // End of stuff that must be set before initialisation.
526 // Runtime parameters. Set up by YAFFS.
528 __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
529 __u16 chunkGroupSize; // == 2^^chunkGroupBits
533 struct semaphore sem;// Semaphore for waiting on erasure.
534 struct semaphore grossLock; // Gross locking semaphore
538 void (*putSuperFunc)(struct super_block *sb);
544 yaffs_BlockInfo *blockInfo;
545 __u8 *chunkBits; // bitmap of chunks in use
546 int chunkBitmapStride; // Number of bytes of chunkBits per block.
547 // Must be consistent with nChunksPerBlock.
551 int allocationBlock; // Current block being allocated off
552 __u32 allocationPage;
553 int allocationBlockFinder; // Used to search for next allocation block
557 yaffs_Tnode *freeTnodes;
559 yaffs_TnodeList *allocatedTnodeList;
563 yaffs_Object *freeObjects;
566 yaffs_ObjectList *allocatedObjectList;
568 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
572 int currentDirtyChecker; // Used to find current dirtiest block
574 __u32 *gcCleanupList; // objects to delete at the end of a GC.
576 // Operations since mount
580 int nErasureFailures;
582 int garbageCollections;
583 int passiveGarbageCollections;
591 int nUnmarkedDeletions;
593 yaffs_Object *rootDir;
594 yaffs_Object *lostNFoundDir;
596 // Buffer areas for storing data to recover from write failures
597 // __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
598 // yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
599 int bufferedBlock; // Which block is buffered here?
600 int doingBufferedBlockRewrite;
602 yaffs_ChunkCache *srCache;
607 // Stuff for background deletion and unlinked files.
608 yaffs_Object *unlinkedDir; // Directory where unlinked and deleted files live.
609 yaffs_Object *deletedDir; // Directory where deleted objects are sent to disappear.
610 yaffs_Object *unlinkedDeletion; // Current file being background deleted.
611 int nDeletedFiles; // Count of files awaiting deletion;
612 int nUnlinkedFiles; // Count of unlinked files.
613 int nBackgroundDeletions; // Count of background deletions.
617 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
619 int unmanagedTempAllocations;
620 int unmanagedTempDeallocations;
622 // yaffs2 runtime stuff
623 unsigned sequenceNumber; //Sequence number of currently allocating block
624 unsigned oldestDirtySequence;
628 typedef struct yaffs_DeviceStruct yaffs_Device;
631 // Function to manipulate block info
632 static Y_INLINE yaffs_BlockInfo* yaffs_GetBlockInfo(yaffs_Device *dev, int blk)
634 if(blk < dev->startBlock || blk > dev->endBlock)
636 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),blk));
639 return &dev->blockInfo[blk - dev->startBlock];
643 //////////// YAFFS Functions //////////////////
645 int yaffs_GutsInitialise(yaffs_Device *dev);
646 void yaffs_Deinitialise(yaffs_Device *dev);
648 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
652 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName, yaffs_Object *newDir, const YCHAR *newName);
654 // generic Object functions
655 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
656 int yaffs_DeleteFile(yaffs_Object *obj);
658 // Object access functions.
659 int yaffs_GetObjectName(yaffs_Object *obj,YCHAR *name,int buffSize);
660 int yaffs_GetObjectFileLength(yaffs_Object *obj);
661 int yaffs_GetObjectInode(yaffs_Object *obj);
662 unsigned yaffs_GetObjectType(yaffs_Object *obj);
663 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
665 // Change inode attributes
666 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
667 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
670 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
671 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
672 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
674 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid);
675 int yaffs_FlushFile(yaffs_Object *obj,int updateTime);
678 // Directory operations
679 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid);
680 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const YCHAR *name);
681 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
683 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number);
686 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name, yaffs_Object *equivalentObject);
688 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
690 // Symlink operations
691 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name, __u32 mode, __u32 uid, __u32 gid, const YCHAR *alias);
692 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
694 // Special inodes (fifos, sockets and devices)
695 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid,__u32 rdev);
698 // Special directories
699 yaffs_Object *yaffs_Root(yaffs_Device *dev);
700 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
702 #ifdef CONFIG_YAFFS_WINCE
703 // CONFIG_YAFFS_WINCE special stuff
704 void yfsd_WinFileTimeNow(__u32 target[2]);
709 void yaffs_HandleDeferedFree(yaffs_Object *obj);
716 int yaffs_DumpObject(yaffs_Object *obj);
719 void yaffs_GutsTest(yaffs_Device *dev);
722 void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
723 void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND,int lyn);
724 int yaffs_CheckFF(__u8 *buffer,int nBytes);