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.12 2005-08-11 00:34:14 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_MIN_YAFFS2_CHUNK_SIZE 1024
54 #define YAFFS_MIN_YAFFS2_SPARE_SIZE 32
56 #define YAFFS_MAX_CHUNK_ID 0x000FFFFF
58 #define YAFFS_UNUSED_OBJECT_ID 0x0003FFFF
60 #define YAFFS_ALLOCATION_NOBJECTS 100
61 #define YAFFS_ALLOCATION_NTNODES 100
62 #define YAFFS_ALLOCATION_NLINKS 100
64 #define YAFFS_NOBJECT_BUCKETS 256
66 #define YAFFS_OBJECT_SPACE 0x40000
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
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 #define YAFFS_MAX_SHORT_OP_CACHES 20
86 #define YAFFS_N_TEMP_BUFFERS 4
88 // Sequence numbers are used in YAFFS2 to determine block allocation order.
89 // The range is limited slightly to help distinguish bad numbers from good.
90 // This also allows us to perhaps in the future use special numbers for
92 // EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
93 // and is a larger number than the lifetime of a 2GB device.
95 #define YAFFS_LOWEST_SEQUENCE_NUMBER 0x00001000
96 #define YAFFS_HIGHEST_SEQUENCE_NUMBER 0xEFFFFF00
98 // 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];
113 #ifndef CONFIG_YAFFS_NO_YAFFS1
114 // Tags structures in RAM
115 // NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
116 // the structure size will get blown out.
120 unsigned serialNumber:2;
121 unsigned byteCount:10;
122 unsigned objectId:18;
124 unsigned unusedStuff:2;
136 YAFFS_ECC_RESULT_UNKNOWN,
137 YAFFS_ECC_RESULT_NO_ERROR,
138 YAFFS_ECC_RESULT_FIXED,
139 YAFFS_ECC_RESULT_UNFIXED
143 YAFFS_OBJECT_TYPE_UNKNOWN,
144 YAFFS_OBJECT_TYPE_FILE,
145 YAFFS_OBJECT_TYPE_SYMLINK,
146 YAFFS_OBJECT_TYPE_DIRECTORY,
147 YAFFS_OBJECT_TYPE_HARDLINK,
148 YAFFS_OBJECT_TYPE_SPECIAL
153 unsigned validMarker0;
154 unsigned chunkUsed; // Status of the chunk: used or unused
155 unsigned objectId; // If 0 then this is not part of an object (unused)
156 unsigned chunkId; // If 0 then this is a header, else a data chunk
157 unsigned byteCount; // Only valid for data chunks
159 // The following stuff only has meaning when we read
160 yaffs_ECCResult eccResult; // Only valid when we read.
161 unsigned blockBad; // Only valid on reading
164 unsigned chunkDeleted; // The chunk is marked deleted
165 unsigned serialNumber; // Yaffs1 2-bit serial number
168 unsigned sequenceNumber; // The sequence number of this block
170 // Extra info if this is an object header (YAFFS2 only)
172 unsigned extraHeaderInfoAvailable; // There is extra info available if this is not zero
173 unsigned extraParentObjectId; // The parent object
174 unsigned extraIsShrinkHeader; // Is it a shrink header?
175 unsigned extraShadows; // Does this shadow another object?
177 yaffs_ObjectType extraObjectType; // What object type?
179 unsigned extraFileLength; // Length if it is a file
180 unsigned extraEquivalentObjectId; // Equivalent object Id if it is a hard link
182 unsigned validMarker1;
184 } yaffs_ExtendedTags;
192 __u8 pageStatus; // set to 0 to delete the chunk
202 //Special structure for passing through to mtd
203 struct yaffs_NANDSpare {
212 YAFFS_BLOCK_STATE_UNKNOWN = 0,
214 YAFFS_BLOCK_STATE_SCANNING,
215 YAFFS_BLOCK_STATE_NEEDS_SCANNING,
216 // The block might have something on it (ie it is allocating or full, perhaps empty)
217 // but it needs to be scanned to determine its true state.
218 // This state is only valid during yaffs_Scan.
219 // NB We tolerate empty because the pre-scanner might be incapable of deciding
220 // However, if this state is returned on a YAFFS2 device, then we expect a sequence number
222 YAFFS_BLOCK_STATE_EMPTY,
223 // This block is empty
225 YAFFS_BLOCK_STATE_ALLOCATING,
226 // This block is partially allocated.
227 // This is the one currently being used for page
228 // allocation. Should never be more than one of these
230 YAFFS_BLOCK_STATE_FULL,
231 // All the pages in this block have been allocated.
232 // At least one page holds valid data.
234 YAFFS_BLOCK_STATE_DIRTY,
235 // All pages have been allocated and deleted.
236 // Erase me, reuse me.
238 YAFFS_BLOCK_STATE_COLLECTING,
239 // This block is being garbage collected
241 YAFFS_BLOCK_STATE_DEAD
242 // This block has failed and is not in use
247 int softDeletions:12; // number of soft deleted pages
248 int pagesInUse:12; // number of pages in use
249 yaffs_BlockState blockState:4; // One of the above block states
250 __u32 needsRetiring:1; // Data has failed on this block, need to get valid data off
251 // and retire the block.
252 #ifdef CONFIG_YAFFS_YAFFS2
253 __u32 hasShrinkHeader:1; // This block has at least one object header that does a shrink
254 __u32 sequenceNumber; // block sequence number for yaffs2
259 //////////////////// Object structure ///////////////////////////
260 // This is the object structure as stored on NAND
263 yaffs_ObjectType type;
265 // Apply to everything
267 __u16 sum__NoLongerUsed; // checksum of name. Calc this off the name to prevent inconsistencies
268 YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
270 // Thes following apply to directories, files, symlinks - not hard links
271 __u32 yst_mode; // protection
273 #ifdef CONFIG_YAFFS_WINCE
274 __u32 notForWinCE[5];
276 __u32 yst_uid; // user ID of owner
277 __u32 yst_gid; // group ID of owner
278 __u32 yst_atime; // time of last access
279 __u32 yst_mtime; // time of last modification
280 __u32 yst_ctime; // time of last change
283 // File size applies to files only
286 // Equivalent object id applies to hard links only.
287 int equivalentObjectId;
289 // Alias is for symlinks only.
290 YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
292 __u32 yst_rdev; // device stuff for block and char devices (maj/min)
294 #ifdef CONFIG_YAFFS_WINCE
300 __u32 roomToGrow[10];
303 int shadowsObject; // This object header shadows the specified object if not > 0
305 // isShrink applies to object headers written when we shrink the file (ie resize)
308 } yaffs_ObjectHeader;
310 //////////////////// Tnode ///////////////////////////
312 union yaffs_Tnode_union {
313 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
314 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
316 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
318 __u16 level0[YAFFS_NTNODES_LEVEL0];
322 typedef union yaffs_Tnode_union yaffs_Tnode;
324 struct yaffs_TnodeList_struct {
325 struct yaffs_TnodeList_struct *next;
329 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
331 /////////////////// Object ////////////////////////////////
332 // An object can be one of:
333 // - a directory (no data, has children links
334 // - a regular file (data.... not prunes :->).
335 // - a symlink [symbolic link] (the alias).
340 __u32 scannedFileSize;
344 } yaffs_FileStructure;
347 struct list_head children; // list of child links
348 } yaffs_DirectoryStructure;
352 } yaffs_SymLinkStructure;
355 struct yaffs_ObjectStruct *equivalentObject;
356 __u32 equivalentObjectId;
357 } yaffs_HardLinkStructure;
360 yaffs_FileStructure fileVariant;
361 yaffs_DirectoryStructure directoryVariant;
362 yaffs_SymLinkStructure symLinkVariant;
363 yaffs_HardLinkStructure hardLinkVariant;
364 } yaffs_ObjectVariant;
366 struct yaffs_ObjectStruct {
367 __u8 deleted:1; // This should only apply to unlinked files.
368 __u8 softDeleted:1; // it has also been soft deleted
369 __u8 unlinked:1; // An unlinked file. The file should be in the unlinked pseudo directory.
370 __u8 fake:1; // A fake object has no presence on NAND.
371 __u8 renameAllowed:1; // Some objects are not allowed to be renamed.
372 __u8 unlinkAllowed:1;
373 __u8 dirty:1; // the object needs to be written to flash
374 __u8 valid:1; // When the file system is being loaded up, this
375 // object might be created before the data
376 // is available (ie. file data records appear before the header).
377 __u8 serial; // serial number of chunk in NAND. Store here so we don't have to
379 __u8 deferedFree:1; // For Linux kernel. Object is removed from NAND, but still in the inode cache.
380 // Free of object is defered.
382 __u8 lazyLoaded; // Vital info has been loaded from tags. Not all info available.
385 // read back the old one to update.
386 __u16 sum; // sum of the name to speed searching
388 struct yaffs_DeviceStruct *myDev; // The device I'm on
390 struct list_head hashLink; // list of objects in this hash bucket
392 struct list_head hardLinks; // all the equivalent hard linked objects
394 // directory structure stuff
395 struct yaffs_ObjectStruct *parent; //my parent directory
396 struct list_head siblings; // siblings in a directory
397 // also used for linking up the free list
399 // Where's my object header in NAND?
400 int chunkId; // where it lives
402 int nDataChunks; // Number of data chunks attached to the file.
404 __u32 objectId; // the object id value
406 __u32 yst_mode; // protection
408 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
409 YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
416 #ifdef CONFIG_YAFFS_WINCE
421 __u32 yst_uid; // user ID of owner
422 __u32 yst_gid; // group ID of owner
423 __u32 yst_atime; // time of last access
424 __u32 yst_mtime; // time of last modification
425 __u32 yst_ctime; // time of last change
428 __u32 yst_rdev; // device stuff for block and char devices
431 struct inode *myInode;
435 yaffs_ObjectType variantType;
437 yaffs_ObjectVariant variant;
441 typedef struct yaffs_ObjectStruct yaffs_Object;
443 struct yaffs_ObjectList_struct {
444 yaffs_Object *objects;
445 struct yaffs_ObjectList_struct *next;
448 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
451 struct list_head list;
453 } yaffs_ObjectBucket;
455 ///////////////////// Temporary buffers ////////////////////
457 // These are chunk-sized working buffers. Each device has a few
461 int line; // track from whence this buffer was allocated
465 //////////////////// Device ////////////////////////////////
467 struct yaffs_DeviceStruct {
468 struct list_head devList;
471 // Entry parameters set up way early. Yaffs sets up the rest.
472 int nBytesPerChunk; // Should be a power of 2 >= 512
473 int nChunksPerBlock; // does not need to be a power of 2
474 int nBytesPerSpare; // spare area size
475 int startBlock; // Start block we're allowed to use
476 int endBlock; // End block we're allowed to use
477 int nReservedBlocks; // We want this tuneable so that we can reduce
478 // reserved blocks on NOR and RAM.
480 int nShortOpCaches; // If <= 0, then short op caching is disabled, else
481 // the number of short op caches (don't use too many).
483 int useHeaderFileSize; // Flag to determine if we should use file sizes from the header
485 int useNANDECC; // Flag to decide whether or not to use NANDECC
487 void *genericDevice; // Pointer to device context
488 // On an mtd this holds the mtd pointer.
490 // NAND access functions (Must be set before calling YAFFS)
492 int (*writeChunkToNAND) (struct yaffs_DeviceStruct * dev,
493 int chunkInNAND, const __u8 * data,
494 const yaffs_Spare * spare);
495 int (*readChunkFromNAND) (struct yaffs_DeviceStruct * dev,
496 int chunkInNAND, __u8 * data,
497 yaffs_Spare * spare);
498 int (*eraseBlockInNAND) (struct yaffs_DeviceStruct * dev,
500 int (*initialiseNAND) (struct yaffs_DeviceStruct * dev);
502 #ifdef CONFIG_YAFFS_YAFFS2
503 int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct * dev,
504 int chunkInNAND, const __u8 * data,
505 const yaffs_ExtendedTags * tags);
506 int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct * dev,
507 int chunkInNAND, __u8 * data,
508 yaffs_ExtendedTags * tags);
509 int (*markNANDBlockBad) (struct yaffs_DeviceStruct * dev, int blockNo);
510 int (*queryNANDBlock) (struct yaffs_DeviceStruct * dev, int blockNo,
511 yaffs_BlockState * state, int *sequenceNumber);
516 // End of stuff that must be set before initialisation.
518 // Runtime parameters. Set up by YAFFS.
520 __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
521 __u16 chunkGroupSize; // == 2^^chunkGroupBits
525 struct semaphore sem; // Semaphore for waiting on erasure.
526 struct semaphore grossLock; // Gross locking semaphore
527 __u8 *spareBuffer; // For mtdif2 use. Don't know the size of the buffer at compile time so we have to allocate it.
528 void (*putSuperFunc) (struct super_block * sb);
533 // Stuff to support block offsetting to support start block zero
534 int internalStartBlock;
535 int internalEndBlock;
540 yaffs_BlockInfo *blockInfo;
541 __u8 *chunkBits; // bitmap of chunks in use
542 int chunkBitmapStride; // Number of bytes of chunkBits per block.
543 // Must be consistent with nChunksPerBlock.
546 int allocationBlock; // Current block being allocated off
547 __u32 allocationPage;
548 int allocationBlockFinder; // Used to search for next allocation block
552 yaffs_Tnode *freeTnodes;
554 yaffs_TnodeList *allocatedTnodeList;
559 yaffs_Object *freeObjects;
562 yaffs_ObjectList *allocatedObjectList;
564 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
568 int currentDirtyChecker; // Used to find current dirtiest block
570 __u32 *gcCleanupList; // objects to delete at the end of a GC.
572 // Operations since mount
576 int nErasureFailures;
578 int garbageCollections;
579 int passiveGarbageCollections;
587 int nUnmarkedDeletions;
589 yaffs_Object *rootDir;
590 yaffs_Object *lostNFoundDir;
592 // Buffer areas for storing data to recover from write failures TODO
593 // __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
594 // yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
596 int bufferedBlock; // Which block is buffered here?
597 int doingBufferedBlockRewrite;
599 yaffs_ChunkCache *srCache;
604 // Stuff for background deletion and unlinked files.
605 yaffs_Object *unlinkedDir; // Directory where unlinked and deleted files live.
606 yaffs_Object *deletedDir; // Directory where deleted objects are sent to disappear.
607 yaffs_Object *unlinkedDeletion; // Current file being background deleted.
608 int nDeletedFiles; // Count of files awaiting deletion;
609 int nUnlinkedFiles; // Count of unlinked files.
610 int nBackgroundDeletions; // Count of background deletions.
614 yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
616 int unmanagedTempAllocations;
617 int unmanagedTempDeallocations;
619 // yaffs2 runtime stuff
620 unsigned sequenceNumber; //Sequence number of currently allocating block
621 unsigned oldestDirtySequence;
625 typedef struct yaffs_DeviceStruct yaffs_Device;
627 // Function to manipulate block info
628 static Y_INLINE yaffs_BlockInfo *yaffs_GetBlockInfo(yaffs_Device * dev, int blk)
630 if (blk < dev->internalStartBlock || blk > dev->internalEndBlock) {
633 ("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),
637 return &dev->blockInfo[blk - dev->internalStartBlock];
640 //////////// YAFFS Functions //////////////////
642 int yaffs_GutsInitialise(yaffs_Device * dev);
643 void yaffs_Deinitialise(yaffs_Device * dev);
645 int yaffs_GetNumberOfFreeChunks(yaffs_Device * dev);
648 int yaffs_RenameObject(yaffs_Object * oldDir, const YCHAR * oldName,
649 yaffs_Object * newDir, const YCHAR * newName);
651 // generic Object functions
652 int yaffs_Unlink(yaffs_Object * dir, const YCHAR * name);
653 int yaffs_DeleteFile(yaffs_Object * obj);
655 // Object access functions.
656 int yaffs_GetObjectName(yaffs_Object * obj, YCHAR * name, int buffSize);
657 int yaffs_GetObjectFileLength(yaffs_Object * obj);
658 int yaffs_GetObjectInode(yaffs_Object * obj);
659 unsigned yaffs_GetObjectType(yaffs_Object * obj);
660 int yaffs_GetObjectLinkCount(yaffs_Object * obj);
662 // Change inode attributes
663 int yaffs_SetAttributes(yaffs_Object * obj, struct iattr *attr);
664 int yaffs_GetAttributes(yaffs_Object * obj, struct iattr *attr);
667 int yaffs_ReadDataFromFile(yaffs_Object * obj, __u8 * buffer, __u32 offset,
669 int yaffs_WriteDataToFile(yaffs_Object * obj, const __u8 * buffer, __u32 offset,
670 int nBytes, int writeThrough);
671 int yaffs_ResizeFile(yaffs_Object * obj, int newSize);
673 yaffs_Object *yaffs_MknodFile(yaffs_Object * parent, const YCHAR * name,
674 __u32 mode, __u32 uid, __u32 gid);
675 int yaffs_FlushFile(yaffs_Object * obj, int updateTime);
677 // Directory operations
678 yaffs_Object *yaffs_MknodDirectory(yaffs_Object * parent, const YCHAR * name,
679 __u32 mode, __u32 uid, __u32 gid);
680 yaffs_Object *yaffs_FindObjectByName(yaffs_Object * theDir, const YCHAR * name);
681 int yaffs_ApplyToDirectoryChildren(yaffs_Object * theDir,
682 int (*fn) (yaffs_Object *));
684 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device * dev, __u32 number);
687 yaffs_Object *yaffs_Link(yaffs_Object * parent, const YCHAR * name,
688 yaffs_Object * equivalentObject);
690 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object * obj);
692 // Symlink operations
693 yaffs_Object *yaffs_MknodSymLink(yaffs_Object * parent, const YCHAR * name,
694 __u32 mode, __u32 uid, __u32 gid,
695 const YCHAR * alias);
696 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object * obj);
698 // Special inodes (fifos, sockets and devices)
699 yaffs_Object *yaffs_MknodSpecial(yaffs_Object * parent, const YCHAR * name,
700 __u32 mode, __u32 uid, __u32 gid, __u32 rdev);
702 // Special directories
703 yaffs_Object *yaffs_Root(yaffs_Device * dev);
704 yaffs_Object *yaffs_LostNFound(yaffs_Device * dev);
706 #ifdef CONFIG_YAFFS_WINCE
707 // CONFIG_YAFFS_WINCE special stuff
708 void yfsd_WinFileTimeNow(__u32 target[2]);
713 void yaffs_HandleDeferedFree(yaffs_Object * obj);
717 int yaffs_DumpObject(yaffs_Object * obj);
719 void yaffs_GutsTest(yaffs_Device * dev);
721 void yaffs_InitialiseTags(yaffs_ExtendedTags * tags);
722 void yaffs_DeleteChunk(yaffs_Device * dev, int chunkId, int markNAND, int lyn);
723 int yaffs_CheckFF(__u8 * buffer, int nBytes);