*** empty log message ***
[yaffs/.git] / yaffs_guts.h
index 3ae36e7214d16dc622d16b52678546925e63e460..d37ac44be92775873a5f96a492ff6a8486052dee 100644 (file)
-/*
- * YAFFS: Yet another FFS. A NAND-flash specific file system. 
- * yaffs_guts.h: Configuration etc for yaffs_guts
- *
- * Copyright (C) 2002 Aleph One Ltd.
- *   for Toby Churchill Ltd and Brightstar Engineering
- *
- * Created by Charles Manning <charles@aleph1.co.uk>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation.
- *
- */
-
-#ifndef __YAFFS_GUTS_H__
-#define __YAFFS_GUTS_H__
-
-#include "devextras.h"
-
-
-#define YAFFS_OK       1
-#define YAFFS_FAIL  0
-
-// Y=0x59, A=0x41, S=0x53
-#define YAFFS_MAGIC                                    0x5941FF53
-
-#define YAFFS_NTNODES_LEVEL0           16
-#define YAFFS_TNODES_LEVEL0_BITS       4
-#define YAFFS_TNODES_LEVEL0_MASK       0xf
-
-#define YAFFS_NTNODES_INTERNAL                 (YAFFS_NTNODES_LEVEL0 / 2)
-#define YAFFS_TNODES_INTERNAL_BITS     (YAFFS_TNODES_LEVEL0_BITS - 1)
-#define YAFFS_TNODES_INTERNAL_MASK     0x7
-#define YAFFS_TNODES_MAX_LEVEL         6
-               
-#define YAFFS_BYTES_PER_CHUNK          512
-#define YAFFS_CHUNK_SIZE_SHIFT         9
-
-#define YAFFS_BYTES_PER_SPARE          16
-
-#define YAFFS_CHUNKS_PER_BLOCK         32
-#define YAFFS_BYTES_PER_BLOCK          (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
-
-#define YAFFS_MAX_CHUNK_ID                     0x000FFFFF
-
-#define YAFFS_UNUSED_OBJECT_ID         0x0003FFFF
-
-#define YAFFS_ALLOCATION_NOBJECTS      100
-#define YAFFS_ALLOCATION_NTNODES       100
-#define YAFFS_ALLOCATION_NLINKS                100
-
-#define YAFFS_NOBJECT_BUCKETS          256
-
-
-#define YAFFS_RESERVED_BLOCKS          5
-
-#define YAFFS_OBJECT_SPACE                     0x40000
-#define YAFFS_MAX_NAME_LENGTH          255
-
-#define YAFFS_MAX_ALIAS_LENGTH         211
-
-#define YAFFS_OBJECTID_ROOT                    1
-#define YAFFS_ROOT_MODE                                0666
-#define YAFFS_OBJECTID_LOSTNFOUND      2
-#define YAFFS_LOSTNFOUND_NAME          "lost+found"
-
-// Tags structures in RAM
-// NB This uses bitfield. Bitfields should not stradle a u32 boundary otherwise
-// the structure size will get blown out.
-
-typedef struct
-{
-    unsigned chunkId:20;
-    unsigned serialNumber:2;
-    unsigned byteCount:10;
-    unsigned objectId:18;
-    unsigned ecc:12;
-    unsigned unusedStuff:2;
-} yaffs_Tags;
-
-typedef union
-{
-    yaffs_Tags asTags;
-    __u8       asBytes[8];
-} yaffs_TagsUnion;
-
-
-// Spare structure
-typedef struct
-{
-    __u8  tagByte0;
-    __u8  tagByte1;
-    __u8  tagByte2;
-    __u8  tagByte3;
-    __u8  pageStatus; // Currently unused, but sort of set aside to distinguish
-                                 // unused - vs- used -vs- deleted chunks. We achieve this by
-                                         // using the objectId tags.
-    __u8  blockStatus;
-    __u8  tagByte4;
-    __u8  tagByte5;
-    __u8  ecc1[3];
-    __u8  tagByte6;
-    __u8  tagByte7;
-    __u8  ecc2[3];
-} yaffs_Spare;
-
-// Block data in RAM
-
-typedef enum {
-       YAFFS_BLOCK_STATE_UddNKNOWN     = 0,
-       YAFFS_BLOCK_STATE_SCANNING,             // Used while the block is being scanned.
-                                                                       // NB Don't erase blocks while they're being scanned
-       
-       YAFFS_BLOCK_STATE_EMPTY,                // This block is empty
-       
-       YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated. 
-                                                                       // This is the one currently being used for page
-                                                                       // allocation. Should never be more than one of these
-                                                       
-
-       YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.
-                                                                       // At least one page holds valid data.
-                                                        
-       YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted. 
-                                                                       // Erase me, reuse me.
-                                                       
-       YAFFS_BLOCK_STATE_DEAD = 0x99   // This block has failed and is not in use
-
-} yaffs_BlockState;
-
-
-
-
-typedef struct
-{
-       __u32 pageBits;   // bitmap of pages in use
-    __u8  blockState; // One of the above block states
-    __u8  pagesInUse; // number of pages in use
-} yaffs_BlockInfo;
-
-
-//////////////////// Object structure ///////////////////////////
-// This is the object structure as stored on NAND
-
-typedef enum
-{
-       YAFFS_OBJECT_TYPE_UNKNOWN,
-       YAFFS_OBJECT_TYPE_FILE,
-       YAFFS_OBJECT_TYPE_SYMLINK,
-       YAFFS_OBJECT_TYPE_DIRECTORY,
-       YAFFS_OBJECT_TYPE_HARDLINK
-} yaffs_ObjectType;
-
-typedef struct
-{
-       yaffs_ObjectType type;
-
-       // Apply to everything  
-       int   parentObjectId;
-       __u16 sum;      // checksum of name
-       char  name[YAFFS_MAX_NAME_LENGTH + 1];
-
-       // Thes following apply to directories, files, symlinks - not hard links
-       __u32 st_mode;  // protection
-       __u32 st_uid;   // user ID of owner
-       __u32 st_gid;    // group ID of owner 
-       __u32 st_atime; // time of last access
-       __u32 st_mtime; // time of last modification
-       __u32 st_ctime; // time of last change
-       
-       // File size  applies to files only
-       int fileSize; 
-               
-       // Equivalent object id applies to hard links only.
-       int  equivalentObjectId;
-       char alias[YAFFS_MAX_ALIAS_LENGTH + 1];
-       
-       
-} yaffs_ObjectHeader;
-
-
-
-////////////////////  Tnode ///////////////////////////
-
-union yaffs_Tnode_union
-{
-       union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
-       __u16 level0[YAFFS_NTNODES_LEVEL0];
-       
-};
-
-typedef union yaffs_Tnode_union yaffs_Tnode;
-
-struct yaffs_TnodeList_struct
-{
-       struct yaffs_TnodeList_struct *next;
-       yaffs_Tnode *tnodes;
-};
-
-typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
-
-
-
-///////////////////  Object ////////////////////////////////
-// An object can be one of:
-// - a directory (no data, has children links
-// - a regular file (data.... not prunes :->).
-// - a symlink [symbolic link] (the alias).
-// - a hard link
-
-
-typedef struct 
-{
-       __u32 fileSize;
-       __u32 topLevel;
-       yaffs_Tnode *top;
-} yaffs_FileStructure;
-
-typedef struct
-{
-       struct list_head children; // list of child links
-} yaffs_DirectoryStructure;
-
-typedef struct
-{
-       char *alias;
-} yaffs_SymLinkStructure;
-
-typedef struct
-{
-       struct yaffs_ObjectStruct *equivalentObject;
-       __u32   equivalentObjectId;
-} yaffs_HardLinkStructure;
-
-typedef union
-{
-       yaffs_FileStructure fileVariant;
-       yaffs_DirectoryStructure directoryVariant;
-       yaffs_SymLinkStructure symLinkVariant;
-       yaffs_HardLinkStructure hardLinkVariant;
-} yaffs_ObjectVariant;
-
-
-struct  yaffs_ObjectStruct
-{
-       __u8 fake:1;                    // A fake object has no presence on NAND.
-       __u8 renameAllowed:1;
-       __u8 unlinkAllowed:1;
-       __u8 dirty:1;                   // the object needs to be written to flash
-       __u8 valid:1;                   // When the file system is being loaded up, this 
-                                                       // object might be created before the data
-                                                       // is available (ie. file data records appear before the header).
-       __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to
-                                                       // read back the old one to update.
-       __u16 sum;                              // sum of the name to speed searching
-       
-       struct yaffs_DeviceStruct *myDev; // The device I'm on
-       
-                                                               
-       struct list_head hashLink;      // list of objects in this hash bucket
-                                                       
-
-       struct list_head hardLinks; // all the equivalent hard linked objects
-                                                               // live on this list
-       // directory structure stuff
-       struct yaffs_ObjectStruct  *parent;     //my parent directory
-       struct list_head siblings;      // siblings in a directory
-                                                               // also used for linking up the free list
-               
-       // Where's my data in NAND?
-       int chunkId;            // where it lives
-       
-       __u32 objectId;         // the object id value
-       
-       
-       __u32 st_mode;          // protection
-       __u32 st_uid;           // user ID of owner
-       __u32 st_gid;           // group ID of owner 
-       __u32 st_atime;         // time of last access
-       __u32 st_mtime;         // time of last modification
-       __u32 st_ctime;         // time of last change
-
-       
-       yaffs_ObjectType variantType;
-       
-       yaffs_ObjectVariant variant;
-       
-};
-
-
-
-typedef struct yaffs_ObjectStruct yaffs_Object;
-
-
-struct yaffs_ObjectList_struct
-{
-       yaffs_Object *objects;
-       struct yaffs_ObjectList_struct *next;
-};
-
-typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
-
-typedef struct
-{
-       struct list_head list;
-       __u32 count;
-} yaffs_ObjectBucket;
-
-
-//////////////////// Device ////////////////////////////////
-
-struct yaffs_DeviceStruct
-{
-       // Entry parameters set up way early. Yaffs sets up the rest.
-       __u32 nBlocks;          // Size of whole device in blocks
-       __u32 startBlock;       // Start block we're allowed to use
-       __u32 endBlock;         // End block we're allowed to use
-       __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
-       __u16 chunkGroupSize; // == 2^^chunkGroupBits
-       
-       
-       void *genericDevice; // Pointer to device context
-                                                // On an mtd this holds the mtd pointer.
-       
-#ifdef __KERNEL__
-
-       struct semaphore sem;// Semaphore for waiting on erasure.
-
-#endif
-       
-       
-       // NAND access functions (Must be set before calling YAFFS)
-       
-       int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);
-       int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
-       int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);        
-       int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
-
-#ifdef __KERNEL__
-       void (*putSuperFunc)(struct super_block *sb);
-#endif
-
-       // Runtime parameters.
-       yaffs_BlockInfo *blockInfo;
-       int   nErasedBlocks;
-       int   allocationBlock;
-       __u32 allocationPage;
-       
-       // Runtime state
-       int   nTnodesCreated;   
-       yaffs_Tnode *freeTnodes;
-       int  nFreeTnodes;
-       yaffs_TnodeList *allocatedTnodeList;
-
-
-       int   nObjectsCreated;
-       yaffs_Object *freeObjects;
-       int   nFreeObjects;
-
-       yaffs_ObjectList *allocatedObjectList;
-
-       yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
-
-       int       nFreeChunks;
-               
-       int   currentDirtyChecker;      // Used to find current dirtiest block
-       
-       int   garbageCollectionRequired;
-       
-       yaffs_Object *rootDir;
-       yaffs_Object *lostNFoundDir;
-       
-       
-};
-
- typedef struct yaffs_DeviceStruct yaffs_Device;
-
-
-
-//////////// YAFFS Functions //////////////////
-
-int yaffs_GutsInitialise(yaffs_Device *dev);
-void yaffs_Deinitialise(yaffs_Device *dev);
-
-int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
-
-
-// Rename
-int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);
-
-// generic Object functions
-int yaffs_Unlink(yaffs_Object *dir, const char *name);
-
-// Object access functions.
-int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);
-int yaffs_GetObjectFileLength(yaffs_Object *obj);
-int yaffs_GetObjectInode(yaffs_Object *obj);
-unsigned yaffs_GetObjectType(yaffs_Object *obj);
-int yaffs_GetObjectLinkCount(yaffs_Object *obj);
-
-// Change inode attributes
-int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
-int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
-
-// File operations
-int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
-int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
-int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
-
-yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
-int yaffs_FlushFile(yaffs_Object *obj);
-
-
-// Directory operations
-yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);
-yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);
-int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
-
-yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,int number);
-
-// Link operations
-yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);
-
-yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
-
-// Symlink operations
-yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode,  __u32 uid, __u32 gid, const char *alias);
-char *yaffs_GetSymlinkAlias(yaffs_Object *obj);
-
-
-// Special directories
-yaffs_Object *yaffs_Root(yaffs_Device *dev);
-yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
-
-
-// Debug dump 
-int yaffs_DumpObject(yaffs_Object *obj);
-
-
-void yaffs_GutsTest(yaffs_Device *dev);
-
-
-#endif
+/*\r
+ * YAFFS: Yet another FFS. A NAND-flash specific file system. \r
+ * yaffs_guts.h: Configuration etc for yaffs_guts\r
+ *\r
+ * Copyright (C) 2002 Aleph One Ltd.\r
+ *   for Toby Churchill Ltd and Brightstar Engineering\r
+ *\r
+ * Created by Charles Manning <charles@aleph1.co.uk>\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License version 2 as\r
+ * published by the Free Software Foundation.\r
+ *\r
+ */\r
+\r
+#ifndef __YAFFS_GUTS_H__\r
+#define __YAFFS_GUTS_H__\r
+\r
+#include "devextras.h"\r
+\r
+\r
+#define YAFFS_OK       1\r
+#define YAFFS_FAIL  0\r
+\r
+// Y=0x59, A=0x41, S=0x53\r
+#define YAFFS_MAGIC                                    0x5941FF53\r
+\r
+#define YAFFS_NTNODES_LEVEL0           16\r
+#define YAFFS_TNODES_LEVEL0_BITS       4\r
+#define YAFFS_TNODES_LEVEL0_MASK       0xf\r
+\r
+#define YAFFS_NTNODES_INTERNAL                 (YAFFS_NTNODES_LEVEL0 / 2)\r
+#define YAFFS_TNODES_INTERNAL_BITS     (YAFFS_TNODES_LEVEL0_BITS - 1)\r
+#define YAFFS_TNODES_INTERNAL_MASK     0x7\r
+#define YAFFS_TNODES_MAX_LEVEL         6\r
+               \r
+#define YAFFS_BYTES_PER_CHUNK          512\r
+#define YAFFS_CHUNK_SIZE_SHIFT         9\r
+\r
+#define YAFFS_BYTES_PER_SPARE          16\r
+\r
+#define YAFFS_CHUNKS_PER_BLOCK         32\r
+#define YAFFS_BYTES_PER_BLOCK          (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)\r
+\r
+#define YAFFS_MAX_CHUNK_ID                     0x000FFFFF\r
+\r
+#define YAFFS_UNUSED_OBJECT_ID         0x0003FFFF\r
+\r
+#define YAFFS_ALLOCATION_NOBJECTS      100\r
+#define YAFFS_ALLOCATION_NTNODES       100\r
+#define YAFFS_ALLOCATION_NLINKS                100\r
+\r
+#define YAFFS_NOBJECT_BUCKETS          256\r
+\r
+\r
+#define YAFFS_RESERVED_BLOCKS          5\r
+\r
+#define YAFFS_OBJECT_SPACE                     0x40000\r
+#define YAFFS_MAX_NAME_LENGTH          255\r
+\r
+#define YAFFS_MAX_ALIAS_LENGTH         159\r
+\r
+#define YAFFS_OBJECTID_ROOT                    1\r
+#define YAFFS_OBJECTID_LOSTNFOUND      2\r
+\r
+// Tags structures in RAM\r
+// NB This uses bitfield. Bitfields should not stradle a u32 boundary otherwise\r
+// the structure size will get blown out.\r
+\r
+typedef struct\r
+{\r
+    unsigned chunkId:20;\r
+    unsigned serialNumber:2;\r
+    unsigned byteCount:10;\r
+    unsigned objectId:18;\r
+    unsigned ecc:12;\r
+    unsigned unusedStuff:2;\r
+} yaffs_Tags;\r
+\r
+typedef union\r
+{\r
+    yaffs_Tags asTags;\r
+    __u8       asBytes[8];\r
+} yaffs_TagsUnion;\r
+\r
+\r
+// Spare structure\r
+typedef struct\r
+{\r
+    __u8  tagByte0;\r
+    __u8  tagByte1;\r
+    __u8  tagByte2;\r
+    __u8  tagByte3;\r
+    __u8  pageStatus; // Currently unused, but sort of set aside to distinguish\r
+                                 // unused - vs- used -vs- deleted chunks. We achieve this by\r
+                                         // using the objectId tags.\r
+    __u8  blockStatus;\r
+    __u8  tagByte4;\r
+    __u8  tagByte5;\r
+    __u8  ecc1[3];\r
+    __u8  tagByte6;\r
+    __u8  tagByte7;\r
+    __u8  ecc2[3];\r
+} yaffs_Spare;\r
+\r
+// Block data in RAM\r
+\r
+typedef enum {\r
+       YAFFS_BLOCK_STATE_UddNKNOWN     = 0,\r
+       YAFFS_BLOCK_STATE_SCANNING,             // Used while the block is being scanned.\r
+                                                                       // NB Don't erase blocks while they're being scanned\r
+       \r
+       YAFFS_BLOCK_STATE_EMPTY,                // This block is empty\r
+       \r
+       YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated. \r
+                                                                       // This is the one currently being used for page\r
+                                                                       // allocation. Should never be more than one of these\r
+                                                       \r
+\r
+       YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.\r
+                                                                       // At least one page holds valid data.\r
+                                                        \r
+       YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted. \r
+                                                                       // Erase me, reuse me.\r
+                                                       \r
+       YAFFS_BLOCK_STATE_DEAD = 0x99   // This block has failed and is not in use\r
+\r
+} yaffs_BlockState;\r
+\r
+\r
+\r
+\r
+typedef struct\r
+{\r
+       __u32 pageBits;   // bitmap of pages in use\r
+    __u8  blockState; // One of the above block states\r
+    __u8  pagesInUse; // number of pages in use\r
+} yaffs_BlockInfo;\r
+\r
+\r
+//////////////////// Object structure ///////////////////////////\r
+// This is the object structure as stored on NAND\r
+\r
+typedef enum\r
+{\r
+       YAFFS_OBJECT_TYPE_UNKNOWN,\r
+       YAFFS_OBJECT_TYPE_FILE,\r
+       YAFFS_OBJECT_TYPE_SYMLINK,\r
+       YAFFS_OBJECT_TYPE_DIRECTORY,\r
+       YAFFS_OBJECT_TYPE_HARDLINK,\r
+       YAFFS_OBJECT_TYPE_SPECIAL\r
+} yaffs_ObjectType;\r
+\r
+typedef struct\r
+{\r
+       yaffs_ObjectType type;\r
+\r
+       // Apply to everything  \r
+       int   parentObjectId;\r
+       __u16 sum;      // checksum of name\r
+       char  name[YAFFS_MAX_NAME_LENGTH + 1];\r
+\r
+       // Thes following apply to directories, files, symlinks - not hard links\r
+       __u32 st_mode;  // protection\r
+       __u32 st_uid;   // user ID of owner\r
+       __u32 st_gid;    // group ID of owner \r
+       __u32 st_atime; // time of last access\r
+       __u32 st_mtime; // time of last modification\r
+       __u32 st_ctime; // time of last change\r
+       \r
+       // File size  applies to files only\r
+       int fileSize; \r
+               \r
+       // Equivalent object id applies to hard links only.\r
+       int  equivalentObjectId;\r
+       \r
+       // Alias is for symlinks only.\r
+       char alias[YAFFS_MAX_ALIAS_LENGTH + 1];\r
+       \r
+       __u32 st_rdev;  // device stuff for block and char devices (maj/min)\r
+       // Roowm to grow...\r
+       __u32 roomToGrow[12];\r
+       \r
+} yaffs_ObjectHeader;\r
+\r
+\r
+\r
+////////////////////  Tnode ///////////////////////////\r
+\r
+union yaffs_Tnode_union\r
+{\r
+       union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];\r
+       __u16 level0[YAFFS_NTNODES_LEVEL0];\r
+       \r
+};\r
+\r
+typedef union yaffs_Tnode_union yaffs_Tnode;\r
+\r
+struct yaffs_TnodeList_struct\r
+{\r
+       struct yaffs_TnodeList_struct *next;\r
+       yaffs_Tnode *tnodes;\r
+};\r
+\r
+typedef struct yaffs_TnodeList_struct yaffs_TnodeList;\r
+\r
+\r
+\r
+///////////////////  Object ////////////////////////////////\r
+// An object can be one of:\r
+// - a directory (no data, has children links\r
+// - a regular file (data.... not prunes :->).\r
+// - a symlink [symbolic link] (the alias).\r
+// - a hard link\r
+\r
+\r
+typedef struct \r
+{\r
+       __u32 fileSize;\r
+       __u32 scannedFileSize;\r
+       __u32 topLevel;\r
+       yaffs_Tnode *top;\r
+} yaffs_FileStructure;\r
+\r
+typedef struct\r
+{\r
+       struct list_head children; // list of child links\r
+} yaffs_DirectoryStructure;\r
+\r
+typedef struct\r
+{\r
+       char *alias;\r
+} yaffs_SymLinkStructure;\r
+\r
+typedef struct\r
+{\r
+       struct yaffs_ObjectStruct *equivalentObject;\r
+       __u32   equivalentObjectId;\r
+} yaffs_HardLinkStructure;\r
+\r
+typedef union\r
+{\r
+       yaffs_FileStructure fileVariant;\r
+       yaffs_DirectoryStructure directoryVariant;\r
+       yaffs_SymLinkStructure symLinkVariant;\r
+       yaffs_HardLinkStructure hardLinkVariant;\r
+} yaffs_ObjectVariant;\r
+\r
+\r
+struct  yaffs_ObjectStruct\r
+{\r
+       __u8 fake:1;                    // A fake object has no presence on NAND.\r
+       __u8 renameAllowed:1;\r
+       __u8 unlinkAllowed:1;\r
+       __u8 dirty:1;                   // the object needs to be written to flash\r
+       __u8 valid:1;                   // When the file system is being loaded up, this \r
+                                                       // object might be created before the data\r
+                                                       // is available (ie. file data records appear before the header).\r
+       __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to\r
+                                                       // read back the old one to update.\r
+       __u16 sum;                              // sum of the name to speed searching\r
+       \r
+       struct yaffs_DeviceStruct *myDev; // The device I'm on\r
+       \r
+                                                               \r
+       struct list_head hashLink;      // list of objects in this hash bucket\r
+                                                       \r
+\r
+       struct list_head hardLinks; // all the equivalent hard linked objects\r
+                                                               // live on this list\r
+       // directory structure stuff\r
+       struct yaffs_ObjectStruct  *parent;     //my parent directory\r
+       struct list_head siblings;      // siblings in a directory\r
+                                                               // also used for linking up the free list\r
+               \r
+       // Where's my data in NAND?\r
+       int chunkId;            // where it lives\r
+\r
+       int nDataChunks;        // really only for debugging.\r
+       \r
+       __u32 objectId;         // the object id value\r
+       \r
+       \r
+       __u32 st_mode;          // protection\r
+       __u32 st_uid;           // user ID of owner\r
+       __u32 st_gid;           // group ID of owner \r
+       __u32 st_atime;         // time of last access\r
+       __u32 st_mtime;         // time of last modification\r
+       __u32 st_ctime;         // time of last change\r
+       __u32 st_rdev;      // device stuff for block and char devices\r
+\r
+#ifdef WIN32\r
+       __u32 inUse;\r
+#endif\r
+\r
+       \r
+       yaffs_ObjectType variantType;\r
+       \r
+       yaffs_ObjectVariant variant;\r
+       \r
+};\r
+\r
+\r
+\r
+typedef struct yaffs_ObjectStruct yaffs_Object;\r
+\r
+\r
+struct yaffs_ObjectList_struct\r
+{\r
+       yaffs_Object *objects;\r
+       struct yaffs_ObjectList_struct *next;\r
+};\r
+\r
+typedef struct yaffs_ObjectList_struct yaffs_ObjectList;\r
+\r
+typedef struct\r
+{\r
+       struct list_head list;\r
+       __u32 count;\r
+} yaffs_ObjectBucket;\r
+\r
+\r
+//////////////////// Device ////////////////////////////////\r
+\r
+struct yaffs_DeviceStruct\r
+{\r
+       // Entry parameters set up way early. Yaffs sets up the rest.\r
+       __u32 nBlocks;          // Size of whole device in blocks\r
+       __u32 startBlock;       // Start block we're allowed to use\r
+       __u32 endBlock;         // End block we're allowed to use\r
+       __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16\r
+       __u16 chunkGroupSize; // == 2^^chunkGroupBits\r
+       \r
+       \r
+       void *genericDevice; // Pointer to device context\r
+                                                // On an mtd this holds the mtd pointer.\r
+       \r
+#ifdef __KERNEL__\r
+\r
+       struct semaphore sem;// Semaphore for waiting on erasure.\r
+\r
+#endif\r
+       \r
+       \r
+       // NAND access functions (Must be set before calling YAFFS)\r
+       \r
+       int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_Spare *spare);\r
+       int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);\r
+       int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);        \r
+       int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);\r
+\r
+#ifdef __KERNEL__\r
+       void (*putSuperFunc)(struct super_block *sb);\r
+#endif\r
+\r
+       // Runtime parameters.\r
+       yaffs_BlockInfo *blockInfo;\r
+       int   nErasedBlocks;\r
+       int   allocationBlock;\r
+       __u32 allocationPage;\r
+       \r
+       // Runtime state\r
+       int   nTnodesCreated;   \r
+       yaffs_Tnode *freeTnodes;\r
+       int  nFreeTnodes;\r
+       yaffs_TnodeList *allocatedTnodeList;\r
+\r
+\r
+       int   nObjectsCreated;\r
+       yaffs_Object *freeObjects;\r
+       int   nFreeObjects;\r
+\r
+       yaffs_ObjectList *allocatedObjectList;\r
+\r
+       yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];\r
+\r
+       int       nFreeChunks;\r
+               \r
+       int   currentDirtyChecker;      // Used to find current dirtiest block\r
+       \r
+       int   garbageCollectionRequired;\r
+       \r
+       // Operations since mount\r
+       int nPageWrites;\r
+       int nPageReads;\r
+       int nBlockErasures;\r
+       int nGCCopies;\r
+       int nRetriedWrites;\r
+       \r
+       yaffs_Object *rootDir;\r
+       yaffs_Object *lostNFoundDir;\r
+       \r
+       \r
+};\r
+\r
+ typedef struct yaffs_DeviceStruct yaffs_Device;\r
+\r
+\r
+\r
+//////////// YAFFS Functions //////////////////\r
+\r
+int yaffs_GutsInitialise(yaffs_Device *dev);\r
+void yaffs_Deinitialise(yaffs_Device *dev);\r
+\r
+int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);\r
+\r
+\r
+// Rename\r
+int yaffs_RenameObject(yaffs_Object *oldDir, const char *oldName, yaffs_Object *newDir, const char *newName);\r
+\r
+// generic Object functions\r
+int yaffs_Unlink(yaffs_Object *dir, const char *name);\r
+\r
+// Object access functions.\r
+int yaffs_GetObjectName(yaffs_Object *obj,char *name,int buffSize);\r
+int yaffs_GetObjectFileLength(yaffs_Object *obj);\r
+int yaffs_GetObjectInode(yaffs_Object *obj);\r
+unsigned yaffs_GetObjectType(yaffs_Object *obj);\r
+int yaffs_GetObjectLinkCount(yaffs_Object *obj);\r
+\r
+// Change inode attributes\r
+int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);\r
+int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);\r
+\r
+// File operations\r
+int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);\r
+int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);\r
+int yaffs_ResizeFile(yaffs_Object *obj, int newSize);\r
+\r
+yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);\r
+int yaffs_FlushFile(yaffs_Object *obj);\r
+\r
+\r
+// Directory operations\r
+yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid);\r
+yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const char *name);\r
+int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));\r
+\r
+yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,int number);\r
+\r
+// Link operations\r
+yaffs_Object *yaffs_Link(yaffs_Object *parent, const char *name, yaffs_Object *equivalentObject);\r
+\r
+yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);\r
+\r
+// Symlink operations\r
+yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const char *name, __u32 mode,  __u32 uid, __u32 gid, const char *alias);\r
+char *yaffs_GetSymlinkAlias(yaffs_Object *obj);\r
+\r
+// Special inodes (fifos, sockets and devices)\r
+yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const char *name, __u32 mode, __u32 uid, __u32 gid,__u32 rdev);\r
+\r
+\r
+// Special directories\r
+yaffs_Object *yaffs_Root(yaffs_Device *dev);\r
+yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);\r
+\r
+\r
+// Debug dump \r
+int yaffs_DumpObject(yaffs_Object *obj);\r
+\r
+\r
+void yaffs_GutsTest(yaffs_Device *dev);\r
+\r
+\r
+#endif\r