yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another FFS. A NAND-flash specific file system.
   3  * yaffs_guts.h: Configuration etc for yaffs_guts
   4  *
   5  * Copyright (C) 2002 Aleph One Ltd.
   6  *   for Toby Churchill Ltd and Brightstar Engineering
   7  *
   8  * Created by Charles Manning <charles@aleph1.co.uk>
   9  *
  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.
  13  *
  14  *
  15  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  16  *
  17  * $Id: yaffs_guts.h,v 1.3 2004-12-17 04:39:04 charles Exp $
  18  */
  19
  20 #ifndef __YAFFS_GUTS_H__
  21 #define __YAFFS_GUTS_H__
  22
  23 #include "devextras.h"
  24 #include "yportenv.h"
  25
  26 #define YAFFS_OK        1
  27 #define YAFFS_FAIL  0
  28
  29 // Give us a Y=0x59,
  30 // Give us an A=0x41,
  31 // Give us an FF=0xFF
  32 // Give us an S=0x53
  33 // And what have we got...
  34 #define YAFFS_MAGIC                                     0x5941FF53
  35
  36 #define YAFFS_NTNODES_LEVEL0            16
  37 #define YAFFS_TNODES_LEVEL0_BITS        4
  38 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  39
  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
  44
  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)
  51 #endif
  52
  53 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  54 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  55
  56 #define YAFFS_MAX_CHUNK_ID                      0x000FFFFF
  57
  58 #define YAFFS_UNUSED_OBJECT_ID          0x0003FFFF
  59
  60 #define YAFFS_ALLOCATION_NOBJECTS       100
  61 #define YAFFS_ALLOCATION_NTNODES        100
  62 #define YAFFS_ALLOCATION_NLINKS         100
  63
  64 #define YAFFS_NOBJECT_BUCKETS           256
  65
  66
  67 #define YAFFS_OBJECT_SPACE                      0x40000
  68
  69 #ifdef CONFIG_YAFFS_UNICODE
  70 #define YAFFS_MAX_NAME_LENGTH           127
  71 #define YAFFS_MAX_ALIAS_LENGTH          79
  72 #else
  73 #define YAFFS_MAX_NAME_LENGTH           255
  74 #define YAFFS_MAX_ALIAS_LENGTH          159
  75 #endif
  76
  77 #define YAFFS_SHORT_NAME_LENGTH         15
  78
  79
  80 #define YAFFS_OBJECTID_ROOT                     1
  81 #define YAFFS_OBJECTID_LOSTNFOUND       2
  82 #define YAFFS_OBJECTID_UNLINKED         3
  83 #define YAFFS_OBJECTID_DELETED          4
  84
  85 #define YAFFS_MAX_SHORT_OP_CACHES       20
  86
  87 #define YAFFS_N_TEMP_BUFFERS            4
  88
  89 // Sequence numbers are used in YAFFS2 to determine block allocation order.
  90 // The range is limited slightly to help distinguish bad numbers from good.
  91 // This also allows us to perhaps in the future use special numbers for
  92 // special purposes.
  93 // EFFFFF00 allows the allocation of 8 blocks per second (~1Mbytes) for 15 years,
  94 // and is a larger number than the lifetime of a 2GB device.
  95
  96 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
  97 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xEFFFFF00
  98
  99
 100 // ChunkCache is used for short read/write operations.
 101 typedef struct
 102 {
 103         struct yaffs_ObjectStruct *object;
 104         int chunkId;
 105         int lastUse;
 106         int dirty;
 107         int nBytes;     // Only valid if the cache is dirty
 108         int locked; // Can't push out or flush while locked..
 109 #ifdef CONFIG_YAFFS_YAFFS2
 110         __u8 *data;
 111 #else
 112         __u8 data[YAFFS_BYTES_PER_CHUNK];
 113 #endif
 114 } yaffs_ChunkCache;
 115
 116
 117 #ifndef CONFIG_YAFFS_NO_YAFFS1
 118 // Tags structures in RAM
 119 // NB This uses bitfield. Bitfields should not straddle a u32 boundary otherwise
 120 // the structure size will get blown out.
 121
 122 typedef struct
 123 {
 124         unsigned chunkId:20;
 125     unsigned serialNumber:2;
 126     unsigned byteCount:10;
 127     unsigned objectId:18;
 128     unsigned ecc:12;
 129     unsigned unusedStuff:2;
 130
 131 } yaffs_Tags;
 132
 133 typedef union
 134 {
 135     yaffs_Tags asTags;
 136     __u8       asBytes[8];
 137 } yaffs_TagsUnion;
 138
 139 #endif
 140
 141 typedef enum
 142 {
 143         YAFFS_ECC_RESULT_UNKNOWN,
 144         YAFFS_ECC_RESULT_NO_ERROR,
 145         YAFFS_ECC_RESULT_FIXED,
 146         YAFFS_ECC_RESULT_UNFIXED
 147 } yaffs_ECCResult;
 148
 149 typedef struct
 150 {
 151
 152         unsigned validMarker0;
 153         unsigned chunkUsed;                 //  Status of the chunk: used or unused
 154         unsigned objectId;                      // If 0 then this is not part of an object (unused)
 155         unsigned chunkId;                       // If 0 then this is a header
 156         unsigned byteCount;                 // Only valid for data chunks
 157         // The following stuff only has meaning when we read
 158         yaffs_ECCResult eccResult;  // Only valid when we read.
 159         unsigned blockBad;                      // Only valid on reading
 160
 161         // YAFFS 1 stuff
 162         unsigned chunkDeleted;          // The chunk is marked deleted
 163         unsigned serialNumber;          // Yaffs1 2-bit serial number
 164
 165         // YAFFS2 stuff
 166         unsigned sequenceNumber;        // The sequence number of this block
 167
 168         unsigned validMarker1;
 169
 170 } yaffs_ExtendedTags;
 171
 172 #ifndef CONFIG_YAFFS_NO_YAFFS1
 173 // Spare structure
 174 typedef struct
 175 {
 176     __u8  tagByte0;
 177     __u8  tagByte1;
 178     __u8  tagByte2;
 179     __u8  tagByte3;
 180     __u8  pageStatus;   // set to 0 to delete the chunk
 181     __u8  blockStatus;
 182     __u8  tagByte4;
 183     __u8  tagByte5;
 184     __u8  ecc1[3];
 185     __u8  tagByte6;
 186     __u8  tagByte7;
 187     __u8  ecc2[3];
 188 } yaffs_Spare;
 189
 190 //Special structure for passing through to mtd
 191 struct yaffs_NANDSpare {
 192         yaffs_Spare     spare;
 193         int             eccres1;
 194         int             eccres2;
 195 };
 196 #endif
 197
 198
 199 // Block data in RAM
 200
 201 typedef enum {
 202         YAFFS_BLOCK_STATE_UNKNOWN       = 0,
 203
 204         YAFFS_BLOCK_STATE_SCANNING,
 205         YAFFS_BLOCK_STATE_NEEDS_SCANNING,// The block might have something on it (ie it is allocating or full, perhaps empty)
 206                                                                         // but it needs to be scanned to determine its true state.
 207                                                                         // This state is only valid during yaffs_Scan.
 208                                                                         // NB We tolerate empty because the pre-scanner might be incapable of deciding
 209                                                                         // However, if this state is returned on a YAFFS2 device, then we expect a sequence number
 210
 211         YAFFS_BLOCK_STATE_EMPTY,                // This block is empty
 212
 213         YAFFS_BLOCK_STATE_ALLOCATING,   // This block is partially allocated.
 214                                                                         // This is the one currently being used for page
 215                                                                         // allocation. Should never be more than one of these
 216
 217
 218         YAFFS_BLOCK_STATE_FULL,                 // All the pages in this block have been allocated.
 219                                                                         // At least one page holds valid data.
 220
 221         YAFFS_BLOCK_STATE_DIRTY,                // All pages have been allocated and deleted.
 222                                                                         // Erase me, reuse me.
 223
 224         YAFFS_BLOCK_STATE_COLLECTING,   // This block is being garbage collected
 225
 226         YAFFS_BLOCK_STATE_DEAD                  // This block has failed and is not in use
 227
 228 } yaffs_BlockState;
 229
 230
 231
 232
 233 typedef struct
 234 {
 235
 236     int   softDeletions:8;  // number of soft deleted pages
 237     int   pagesInUse:8;         // number of pages in use
 238     __u32 blockState:4;         // One of the above block states
 239     __u32 needsRetiring:1;      // Data has failed on this block, need to get valid data off
 240                                                 // and retire the block.
 241 #ifdef CONFIG_YAFFS_YAFFS2
 242         __u32 hasShrinkHeader:1;// This block has at least one object header that does a shrink
 243         __u32 sequenceNumber;   // block sequence number for yaffs2
 244 #endif
 245
 246 } yaffs_BlockInfo;
 247
 248
 249 //////////////////// Object structure ///////////////////////////
 250 // This is the object structure as stored on NAND
 251
 252 typedef enum
 253 {
 254         YAFFS_OBJECT_TYPE_UNKNOWN,
 255         YAFFS_OBJECT_TYPE_FILE,
 256         YAFFS_OBJECT_TYPE_SYMLINK,
 257         YAFFS_OBJECT_TYPE_DIRECTORY,
 258         YAFFS_OBJECT_TYPE_HARDLINK,
 259         YAFFS_OBJECT_TYPE_SPECIAL
 260 } yaffs_ObjectType;
 261
 262 typedef struct
 263 {
 264         yaffs_ObjectType type;
 265
 266         // Apply to everything
 267         int   parentObjectId;
 268         __u16 sum__NoLongerUsed;        // checksum of name. Calc this off the name to prevent inconsistencies
 269         YCHAR  name[YAFFS_MAX_NAME_LENGTH + 1];
 270
 271         // Thes following apply to directories, files, symlinks - not hard links
 272         __u32 st_mode;  // protection
 273
 274 #ifdef CONFIG_YAFFS_WINCE
 275         __u32 notForWinCE[5];
 276 #else
 277         __u32 st_uid;   // user ID of owner
 278         __u32 st_gid;    // group ID of owner
 279         __u32 st_atime; // time of last access
 280         __u32 st_mtime; // time of last modification
 281         __u32 st_ctime; // time of last change
 282 #endif
 283
 284         // File size  applies to files only
 285         int fileSize;
 286
 287         // Equivalent object id applies to hard links only.
 288         int  equivalentObjectId;
 289
 290         // Alias is for symlinks only.
 291         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 292
 293         __u32 st_rdev;  // device stuff for block and char devices (maj/min)
 294
 295 #ifdef CONFIG_YAFFS_WINCE
 296         __u32 win_ctime[2];
 297         __u32 win_atime[2];
 298         __u32 win_mtime[2];
 299         __u32 roomToGrow[5];
 300 #else
 301         __u32 roomToGrow[11];
 302 #endif
 303
 304         // isShrink applies to bject headers written when we shrink the file (ie resize)
 305         __u32 isShrink;
 306
 307 } yaffs_ObjectHeader;
 308
 309
 310
 311 ////////////////////  Tnode ///////////////////////////
 312
 313 union yaffs_Tnode_union
 314 {
 315 #ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
 316         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL+1];
 317 #else
 318         union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
 319 #endif
 320         __u16 level0[YAFFS_NTNODES_LEVEL0];
 321
 322 };
 323
 324 typedef union yaffs_Tnode_union yaffs_Tnode;
 325
 326 struct yaffs_TnodeList_struct
 327 {
 328         struct yaffs_TnodeList_struct *next;
 329         yaffs_Tnode *tnodes;
 330 };
 331
 332 typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
 333
 334
 335
 336 ///////////////////  Object ////////////////////////////////
 337 // An object can be one of:
 338 // - a directory (no data, has children links
 339 // - a regular file (data.... not prunes :->).
 340 // - a symlink [symbolic link] (the alias).
 341 // - a hard link
 342
 343
 344 typedef struct
 345 {
 346         __u32 fileSize;
 347         __u32 scannedFileSize;
 348         int   topLevel;
 349         yaffs_Tnode *top;
 350 } yaffs_FileStructure;
 351
 352 typedef struct
 353 {
 354         struct list_head children; // list of child links
 355 } yaffs_DirectoryStructure;
 356
 357 typedef struct
 358 {
 359         YCHAR *alias;
 360 } yaffs_SymLinkStructure;
 361
 362 typedef struct
 363 {
 364         struct yaffs_ObjectStruct *equivalentObject;
 365         __u32   equivalentObjectId;
 366 } yaffs_HardLinkStructure;
 367
 368 typedef union
 369 {
 370         yaffs_FileStructure fileVariant;
 371         yaffs_DirectoryStructure directoryVariant;
 372         yaffs_SymLinkStructure symLinkVariant;
 373         yaffs_HardLinkStructure hardLinkVariant;
 374 } yaffs_ObjectVariant;
 375
 376
 377 struct  yaffs_ObjectStruct
 378 {
 379         __u8 deleted: 1;                // This should only apply to unlinked files.
 380         __u8 softDeleted: 1;    // it has also been soft deleted
 381         __u8 unlinked: 1;               // An unlinked file. The file should be in the unlinked pseudo directory.
 382         __u8 fake:1;                    // A fake object has no presence on NAND.
 383         __u8 renameAllowed:1;
 384         __u8 unlinkAllowed:1;
 385         __u8 dirty:1;                   // the object needs to be written to flash
 386         __u8 valid:1;                   // When the file system is being loaded up, this
 387                                                         // object might be created before the data
 388                                                         // is available (ie. file data records appear before the header).
 389         __u8 serial;                    // serial number of chunk in NAND. Store here so we don't have to
 390
 391         __u8  deferedFree: 1;           // For Linux kernel. Object is removed from NAND, but still in the inode cache.
 392                                         // Free of object is defered.
 393
 394                                                         // read back the old one to update.
 395         __u16 sum;                              // sum of the name to speed searching
 396
 397         struct yaffs_DeviceStruct *myDev; // The device I'm on
 398
 399
 400         struct list_head hashLink;      // list of objects in this hash bucket
 401
 402
 403         struct list_head hardLinks; // all the equivalent hard linked objects
 404                                                                 // live on this list
 405         // directory structure stuff
 406         struct yaffs_ObjectStruct  *parent;     //my parent directory
 407         struct list_head siblings;      // siblings in a directory
 408                                                                 // also used for linking up the free list
 409
 410         // Where's my data in NAND?
 411         int chunkId;            // where it lives
 412
 413         int nDataChunks;
 414
 415         __u32 objectId;         // the object id value
 416
 417
 418         __u32 st_mode;          // protection
 419
 420 #ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
 421         YCHAR shortName[YAFFS_SHORT_NAME_LENGTH+1];
 422 #endif
 423
 424 #ifndef __KERNEL__
 425         __u32 inUse;
 426 #endif
 427
 428 #ifdef CONFIG_YAFFS_WINCE
 429         __u32 win_ctime[2];
 430         __u32 win_mtime[2];
 431         __u32 win_atime[2];
 432 #else
 433         __u32 st_uid;           // user ID of owner
 434         __u32 st_gid;           // group ID of owner
 435         __u32 st_atime;         // time of last access
 436         __u32 st_mtime;         // time of last modification
 437         __u32 st_ctime;         // time of last change
 438 #endif
 439
 440         __u32 st_rdev;      // device stuff for block and char devices
 441
 442
 443
 444 #ifdef __KERNEL__
 445         struct inode *myInode;
 446
 447 #endif
 448
 449
 450
 451         yaffs_ObjectType variantType;
 452
 453         yaffs_ObjectVariant variant;
 454
 455 };
 456
 457
 458
 459 typedef struct yaffs_ObjectStruct yaffs_Object;
 460
 461
 462 struct yaffs_ObjectList_struct
 463 {
 464         yaffs_Object *objects;
 465         struct yaffs_ObjectList_struct *next;
 466 };
 467
 468 typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
 469
 470 typedef struct
 471 {
 472         struct list_head list;
 473         int count;
 474 } yaffs_ObjectBucket;
 475
 476 ///////////////////// Temporary buffers ////////////////////
 477 //
 478 // These are chunk-sized working buffers. Each device has a few
 479
 480 typedef struct {
 481         __u8 *buffer;
 482         int line; // track from whence this buffer was allocated
 483         int maxLine;
 484 } yaffs_TempBuffer;
 485
 486 //////////////////// Device ////////////////////////////////
 487
 488 struct yaffs_DeviceStruct
 489 {
 490         // Entry parameters set up way early. Yaffs sets up the rest.
 491         int   nBytesPerChunk;    // Should be a power of 2 >= 512
 492         int       nChunksPerBlock;       // does not need to be a power of 2
 493         int   nBytesPerSpare;    // spare area size
 494         int   startBlock;                // Start block we're allowed to use
 495         int   endBlock;                  // End block we're allowed to use
 496         int   nReservedBlocks;   // We want this tuneable so that we can reduce
 497                                                          // reserved blocks on NOR and RAM.
 498
 499         int   nShortOpCaches;   // If <= 0, then short op caching is disabled, else
 500                                                         // the number of short op caches (don't use too many).
 501
 502         int useHeaderFileSize; // Flag to determine if we should use file sizes from the header
 503
 504         int   useNANDECC;               // Flag to decide whether or not to use NANDECC
 505
 506
 507         void *genericDevice; // Pointer to device context
 508                                                  // On an mtd this holds the mtd pointer.
 509
 510         // NAND access functions (Must be set before calling YAFFS)
 511
 512
 513         int (*writeChunkToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, const yaffs_Spare *spare);
 514         int (*readChunkFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_Spare *spare);
 515         int (*eraseBlockInNAND)(struct yaffs_DeviceStruct *dev,int blockInNAND);
 516         int (*initialiseNAND)(struct yaffs_DeviceStruct *dev);
 517
 518 #ifdef CONFIG_YAFFS_YAFFS2
 519         int (*writeChunkWithTagsToNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, const __u8 *data, yaffs_ExtendedTags *tags);
 520         int (*readChunkWithTagsFromNAND)(struct yaffs_DeviceStruct *dev,int chunkInNAND, __u8 *data, yaffs_ExtendedTags *tags);
 521         int (*markNANDBlockBad)(struct yaffs_DeviceStruct *dev, int blockNo);
 522         int (*queryNANDBlock)(struct yaffs_DeviceStruct *dev, int blockNo, yaffs_BlockState *state, int *sequenceNumber);
 523 #endif
 524
 525         int isYaffs2;
 526
 527         // End of stuff that must be set before initialisation.
 528
 529         // Runtime parameters. Set up by YAFFS.
 530
 531         __u16 chunkGroupBits; // 0 for devices <= 32MB. else log2(nchunks) - 16
 532         __u16 chunkGroupSize; // == 2^^chunkGroupBits
 533
 534 #ifdef __KERNEL__
 535
 536         struct semaphore sem;// Semaphore for waiting on erasure.
 537         struct semaphore grossLock; // Gross locking semaphore
 538         __u8 * spareBuffer; // For mtdif2 use. Don't know the size of the buffer at compile time so we have to allocate it.
 539         void (*putSuperFunc)(struct super_block *sb);
 540 #endif
 541
 542         int isMounted;
 543
 544         // Block Info
 545         yaffs_BlockInfo *blockInfo;
 546         __u8 *chunkBits;   // bitmap of chunks in use
 547         int   chunkBitmapStride; // Number of bytes of chunkBits per block.
 548                                                          //     Must be consistent with nChunksPerBlock.
 549
 550
 551         int   nErasedBlocks;
 552         int   allocationBlock;                  // Current block being allocated off
 553         __u32 allocationPage;
 554         int   allocationBlockFinder;    // Used to search for next allocation block
 555
 556         // Runtime state
 557         int   nTnodesCreated;
 558         yaffs_Tnode *freeTnodes;
 559         int  nFreeTnodes;
 560         yaffs_TnodeList *allocatedTnodeList;
 561
 562
 563         int   nObjectsCreated;
 564         yaffs_Object *freeObjects;
 565         int   nFreeObjects;
 566
 567         yaffs_ObjectList *allocatedObjectList;
 568
 569         yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
 570
 571         int       nFreeChunks;
 572
 573         int   currentDirtyChecker;      // Used to find current dirtiest block
 574
 575         __u32  *gcCleanupList; // objects to delete at the end of a GC.
 576
 577         // Operations since mount
 578         int nPageWrites;
 579         int nPageReads;
 580         int nBlockErasures;
 581         int nErasureFailures;
 582         int nGCCopies;
 583         int garbageCollections;
 584         int passiveGarbageCollections;
 585         int nRetriedWrites;
 586         int nRetiredBlocks;
 587         int eccFixed;
 588         int eccUnfixed;
 589         int tagsEccFixed;
 590         int tagsEccUnfixed;
 591         int nDeletions;
 592         int nUnmarkedDeletions;
 593
 594         yaffs_Object *rootDir;
 595         yaffs_Object *lostNFoundDir;
 596
 597         // Buffer areas for storing data to recover from write failures
 598 //      __u8            bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
 599 //      yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
 600         int bufferedBlock;      // Which block is buffered here?
 601         int doingBufferedBlockRewrite;
 602
 603         yaffs_ChunkCache *srCache;
 604         int srLastUse;
 605
 606         int cacheHits;
 607
 608         // Stuff for background deletion and unlinked files.
 609         yaffs_Object *unlinkedDir;              // Directory where unlinked and deleted files live.
 610         yaffs_Object *deletedDir;               // Directory where deleted objects are sent to disappear.
 611         yaffs_Object *unlinkedDeletion; // Current file being background deleted.
 612         int nDeletedFiles;                              // Count of files awaiting deletion;
 613         int nUnlinkedFiles;                             // Count of unlinked files.
 614         int nBackgroundDeletions;                       // Count of background deletions.
 615
 616         //__u8 *localBuffer;
 617
 618         yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
 619         int maxTemp;
 620         int unmanagedTempAllocations;
 621         int unmanagedTempDeallocations;
 622
 623         // yaffs2 runtime stuff
 624         unsigned sequenceNumber;                //Sequence number of currently allocating block
 625         unsigned oldestDirtySequence;
 626
 627 };
 628
 629 typedef struct yaffs_DeviceStruct yaffs_Device;
 630
 631
 632 // Function to manipulate block info
 633 static  Y_INLINE yaffs_BlockInfo* yaffs_GetBlockInfo(yaffs_Device *dev, int blk)
 634 {
 635         if(blk < dev->startBlock || blk > dev->endBlock)
 636         {
 637                 T(YAFFS_TRACE_ERROR,(TSTR("**>> yaffs: getBlockInfo block %d is not valid" TENDSTR),blk));
 638                 YBUG();
 639         }
 640         return &dev->blockInfo[blk - dev->startBlock];
 641 }
 642
 643
 644 //////////// YAFFS Functions //////////////////
 645
 646 int yaffs_GutsInitialise(yaffs_Device *dev);
 647 void yaffs_Deinitialise(yaffs_Device *dev);
 648
 649 int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
 650
 651
 652 // Rename
 653 int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName, yaffs_Object *newDir, const YCHAR *newName);
 654
 655 // generic Object functions
 656 int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
 657 int yaffs_DeleteFile(yaffs_Object *obj);
 658
 659 // Object access functions.
 660 int yaffs_GetObjectName(yaffs_Object *obj,YCHAR *name,int buffSize);
 661 int yaffs_GetObjectFileLength(yaffs_Object *obj);
 662 int yaffs_GetObjectInode(yaffs_Object *obj);
 663 unsigned yaffs_GetObjectType(yaffs_Object *obj);
 664 int yaffs_GetObjectLinkCount(yaffs_Object *obj);
 665
 666 // Change inode attributes
 667 int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
 668 int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
 669
 670 // File operations
 671 int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, __u32 offset, int nBytes);
 672 int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, __u32 offset, int nBytes);
 673 int yaffs_ResizeFile(yaffs_Object *obj, int newSize);
 674
 675 yaffs_Object *yaffs_MknodFile(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid);
 676 int yaffs_FlushFile(yaffs_Object *obj,int updateTime);
 677
 678
 679 // Directory operations
 680 yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid);
 681 yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir,const YCHAR *name);
 682 int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,int (*fn)(yaffs_Object *));
 683
 684 yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev,__u32 number);
 685
 686 // Link operations
 687 yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name, yaffs_Object *equivalentObject);
 688
 689 yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
 690
 691 // Symlink operations
 692 yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name, __u32 mode,  __u32 uid, __u32 gid, const YCHAR *alias);
 693 YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
 694
 695 // Special inodes (fifos, sockets and devices)
 696 yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent,const YCHAR *name, __u32 mode, __u32 uid, __u32 gid,__u32 rdev);
 697
 698
 699 // Special directories
 700 yaffs_Object *yaffs_Root(yaffs_Device *dev);
 701 yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
 702
 703 #ifdef CONFIG_YAFFS_WINCE
 704 // CONFIG_YAFFS_WINCE special stuff
 705 void  yfsd_WinFileTimeNow(__u32 target[2]);
 706 #endif
 707
 708 #ifdef __KERNEL__
 709
 710 void yaffs_HandleDeferedFree(yaffs_Object *obj);
 711 #endif
 712
 713
 714
 715
 716 // Debug dump
 717 int yaffs_DumpObject(yaffs_Object *obj);
 718
 719
 720 void yaffs_GutsTest(yaffs_Device *dev);
 721
 722
 723 void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
 724 void yaffs_DeleteChunk(yaffs_Device *dev,int chunkId,int markNAND,int lyn);
 725 int yaffs_CheckFF(__u8 *buffer,int nBytes);
 726
 727 #endif
 728