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.16 2003-01-31 03:30:33 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 #define YAFFS_BYTES_PER_SPARE 16
47 #define YAFFS_BYTES_PER_CHUNK 512
48 //#define YAFFS_CHUNK_SIZE_SHIFT 9
51 #define YAFFS_CHUNKS_PER_BLOCK 32
52 #define YAFFS_BYTES_PER_BLOCK (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
54 #define YAFFS_MAX_CHUNK_ID 0x000FFFFF
56 #define YAFFS_UNUSED_OBJECT_ID 0x0003FFFF
58 #define YAFFS_ALLOCATION_NOBJECTS 100
59 #define YAFFS_ALLOCATION_NTNODES 100
60 #define YAFFS_ALLOCATION_NLINKS 100
62 #define YAFFS_NOBJECT_BUCKETS 256
65 #define YAFFS_OBJECT_SPACE 0x40000
66 #define YAFFS_MAX_NAME_LENGTH 255
67 #define YAFFS_SHORT_NAME_LENGTH 15
69 #define YAFFS_MAX_ALIAS_LENGTH 159
71 #define YAFFS_OBJECTID_ROOT 1
72 #define YAFFS_OBJECTID_LOSTNFOUND 2
73 #define YAFFS_OBJECTID_UNLINKED 3
75 #define YAFFS_MAX_SHORT_OP_CACHES 20
78 // ChunkCache is used for short read/write operations.
81 struct yaffs_ObjectStruct *object;
85 int nBytes; // Only valid if the cache is dirty
86 __u8 data[YAFFS_BYTES_PER_CHUNK];
89 // Tags structures in RAM
90 // NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
91 // the structure size will get blown out.
96 unsigned serialNumber:2;
97 unsigned byteCount:10;
100 unsigned unusedStuff:2;
117 __u8 pageStatus; // set to 0 to delete the chunk
127 //Special structure for passing through to mtd
128 struct yaffs_NANDSpare {
137 YAFFS_BLOCK_STATE_UNKNOWN = 0,
138 YAFFS_BLOCK_STATE_SCANNING, // Used while the block is being scanned.
139 // NB Don't erase blocks while they're being scanned
141 YAFFS_BLOCK_STATE_EMPTY, // This block is empty
143 YAFFS_BLOCK_STATE_ALLOCATING, // This block is partially allocated.
144 // This is the one currently being used for page
145 // allocation. Should never be more than one of these
148 YAFFS_BLOCK_STATE_FULL, // All the pages in this block have been allocated.
149 // At least one page holds valid data.
151 YAFFS_BLOCK_STATE_DIRTY, // All pages have been allocated and deleted.
152 // Erase me, reuse me.
154 YAFFS_BLOCK_STATE_DEAD // This block has failed and is not in use
163 #ifndef CONFIG_YAFFS_NO_YAFFS2
164 __u32 sequenceNumber; // block sequence number for yaffs2
166 int softDeletions:8; // number of soft deleted pages
167 int pagesInUse:8; // number of pages in use
168 __u32 blockState:4; // One of the above block states
169 __u32 needsRetiring:1; // Data has failed on this block, need to get valid data off
170 // and retire the block.
174 //////////////////// Object structure ///////////////////////////
175 // This is the object structure as stored on NAND
179 YAFFS_OBJECT_TYPE_UNKNOWN,
180 YAFFS_OBJECT_TYPE_FILE,
181 YAFFS_OBJECT_TYPE_SYMLINK,
182 YAFFS_OBJECT_TYPE_DIRECTORY,
183 YAFFS_OBJECT_TYPE_HARDLINK,
184 YAFFS_OBJECT_TYPE_SPECIAL
189 yaffs_ObjectType type;
191 // Apply to everything
193 __u16 sum__NoLongerUsed; // checksum of name. Calc this off the name to prevent inconsistencies
194 char name[YAFFS_MAX_NAME_LENGTH + 1];
196 // Thes following apply to directories, files, symlinks - not hard links
197 __u32 st_mode; // protection
199 #ifdef CONFIG_YAFFS_WINCE
200 __u32 notForWinCE[5];
202 __u32 st_uid; // user ID of owner
203 __u32 st_gid; // group ID of owner
204 __u32 st_atime; // time of last access
205 __u32 st_mtime; // time of last modification
206 __u32 st_ctime; // time of last change
209 // File size applies to files only
212 // Equivalent object id applies to hard links only.
213 int equivalentObjectId;
215 // Alias is for symlinks only.
216 char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
218 __u32 st_rdev; // device stuff for block and char devices (maj/min)
220 #ifdef CONFIG_YAFFS_WINCE
226 __u32 roomToGrow[12];
229 } yaffs_ObjectHeader;
233 //////////////////// Tnode ///////////////////////////
235 union yaffs_Tnode_union
237 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
238 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL+1];
240 union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
242 __u16 level0[YAFFS_NTNODES_LEVEL0];
246 typedef union yaffs_Tnode_union yaffs_Tnode;
248 struct yaffs_TnodeList_struct
250 struct yaffs_TnodeList_struct *next;
254 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
258 /////////////////// Object ////////////////////////////////
259 // An object can be one of:
260 // - a directory (no data, has children links
261 // - a regular file (data.... not prunes :->).
262 // - a symlink [symbolic link] (the alias).
269 __u32 scannedFileSize;
272 } yaffs_FileStructure;
276 struct list_head children; // list of child links
277 } yaffs_DirectoryStructure;
282 } yaffs_SymLinkStructure;
286 struct yaffs_ObjectStruct *equivalentObject;
287 __u32 equivalentObjectId;
288 } yaffs_HardLinkStructure;
292 yaffs_FileStructure fileVariant;
293 yaffs_DirectoryStructure directoryVariant;
294 yaffs_SymLinkStructure symLinkVariant;
295 yaffs_HardLinkStructure hardLinkVariant;
296 } yaffs_ObjectVariant;
299 struct yaffs_ObjectStruct
301 __u8 deleted: 1; // This should only apply to unlinked files.
302 __u8 softDeleted: 1; // it has also been soft deleted
303 __u8 unlinked: 1; // An unlinked file. The file should be in the unlinked pseudo directory.
304 __u8 fake:1; // A fake object has no presence on NAND.
305 __u8 renameAllowed:1;
306 __u8 unlinkAllowed:1;
307 __u8 dirty:1; // the object needs to be written to flash
308 __u8 valid:1; // When the file system is being loaded up, this
309 // object might be created before the data
310 // is available (ie. file data records appear before the header).
311 __u8 serial; // serial number of chunk in NAND. Store here so we don't have to
312 // read back the old one to update.
313 __u16 sum; // sum of the name to speed searching
315 struct yaffs_DeviceStruct *myDev; // The device I'm on
318 struct list_head hashLink; // list of objects in this hash bucket
321 struct list_head hardLinks; // all the equivalent hard linked objects
323 // directory structure stuff
324 struct yaffs_ObjectStruct *parent; //my parent directory
325 struct list_head siblings; // siblings in a directory
326 // also used for linking up the free list
328 // Where's my data in NAND?
329 int chunkId; // where it lives
333 __u32 objectId; // the object id value
336 __u32 st_mode; // protection
338 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
339 char shortName[YAFFS_SHORT_NAME_LENGTH+1];
346 #ifdef CONFIG_YAFFS_WINCE
351 __u32 st_uid; // user ID of owner
352 __u32 st_gid; // group ID of owner
353 __u32 st_atime; // time of last access
354 __u32 st_mtime; // time of last modification
355 __u32 st_ctime; // time of last change
358 __u32 st_rdev; // device stuff for block and char devices
363 struct inode *myInode;
368 yaffs_ObjectType variantType;
370 yaffs_ObjectVariant variant;
376 typedef struct yaffs_ObjectStruct yaffs_Object;
379 struct yaffs_ObjectList_struct
381 yaffs_Object *objects;
382 struct yaffs_ObjectList_struct *next;
385 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
389 struct list_head list;
391 } yaffs_ObjectBucket;
394 //////////////////// Device ////////////////////////////////
396 struct yaffs_DeviceStruct
398 // Entry parameters set up way early. Yaffs sets up the rest.
399 int nBytesPerChunk; // Should be a power of 2 >= 512
400 int nChunksPerBlock; // does not need to be a power of 2
401 int startBlock; // Start block we're allowed to use
402 int endBlock; // End block we're allowed to use
403 int nReservedBlocks; // We want this tuneable so that we can reduce
404 // reserved blocks on NOR and RAM.
406 int useNANDECC; // Flag to decide whether or not to use NANDECC
407 int nShortOpCaches; // If <= 0, then short op caching is disabled, else
408 // the number of short op caches (don't use too many).
411 void *genericDevice; // Pointer to device context
412 // On an mtd this holds the mtd pointer.
414 // NAND access functions (Must be set before calling YAFFS)
416 int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
417 int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
418 int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
419 int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
421 // Runtime parameters. Set up by YAFFS.
423 __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
424 __u16 chunkGroupSize; // == 2^^chunkGroupBits
428 struct semaphore sem;// Semaphore for waiting on erasure.
429 struct semaphore grossLock; // Gross locking semaphore
433 void (*putSuperFunc)(struct super_block *sb);
439 yaffs_BlockInfo *blockInfo;
440 __u8 *chunkBits; // bitmap of chunks in use
441 int chunkBitmapStride; // Number of bytes of chunkBits per block.
442 // Must be consistent with nChunksPerBlock.
446 int allocationBlock; // Current block being allocated off
447 __u32 allocationPage;
448 int allocationBlockFinder; // Used to search for next allocation block
452 yaffs_Tnode *freeTnodes;
454 yaffs_TnodeList *allocatedTnodeList;
458 yaffs_Object *freeObjects;
461 yaffs_ObjectList *allocatedObjectList;
463 yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
467 int currentDirtyChecker; // Used to find current dirtiest block
470 // Operations since mount
475 int garbageCollections;
476 int passiveGarbageCollections;
484 int nUnmarkedDeletions;
486 yaffs_Object *rootDir;
487 yaffs_Object *lostNFoundDir;
489 // Buffer areas for storing data to recover from write failures
490 // __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
491 // yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
492 int bufferedBlock; // Which block is buffered here?
493 int doingBufferedBlockRewrite;
495 yaffs_ChunkCache *srCache;
500 // Stuff for background deletion and unlinked files.
501 yaffs_Object *unlinkedDir; // Directory where unlinked and deleted files live.
502 yaffs_Object *unlinkedDeletion; // Current file being background deleted.
503 int nDeletedFiles; // Count of files awaiting deletion;
504 int nUnlinkedFiles; // Count of unlinked files.
505 int nBackgroundDeletions; // Count of background deletions.
511 typedef struct yaffs_DeviceStruct yaffs_Device;
515 //////////// YAFFS Functions //////////////////
517 int yaffs_GutsInitialise(yaffs_Device *dev);
518 void yaffs_Deinitialise(yaffs_Device *dev);
520 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
524 int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);
526 // generic Object functions
527 int yaffs_Unlink(yaffs_Object *dir, const char *name);
528 int yaffs_DeleteFile(yaffs_Object *obj);
530 // Object access functions.
531 int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);
532 int yaffs_GetObjectFileLength(yaffs_Object *obj);
533 int yaffs_GetObjectInode(yaffs_Object *obj);
534 unsigned yaffs_GetObjectType(yaffs_Object *obj);
535 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
537 // Change inode attributes
538 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
539 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
542 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
543 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
544 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
546 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
547 int yaffs_FlushFile(yaffs_Object *obj,int updateTime);
550 // Directory operations
551 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
552 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
553 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
555 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number);
558 yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
560 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
562 // Symlink operations
563 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode, __u32 uid, __u32 gid, const char *alias);
564 char *yaffs_GetSymlinkAlias(yaffs_Object *obj);
566 // Special inodes (fifos, sockets and devices)
567 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid,__u32 rdev);
570 // Special directories
571 yaffs_Object *yaffs_Root(yaffs_Device *dev);
572 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
574 #ifdef CONFIG_YAFFS_WINCE
575 // CONFIG_YAFFS_WINCE special stuff
576 void yfsd_WinFileTimeNow(__u32 target[2]);
581 int yaffs_DumpObject(yaffs_Object *obj);
584 void yaffs_GutsTest(yaffs_Device *dev);