yaffs_guts.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU Lesser General Public License version 2.1 as
  11  * published by the Free Software Foundation.
  12  *
  13  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  14  */
  15
  16 #ifndef __YAFFS_GUTS_H__
  17 #define __YAFFS_GUTS_H__
  18
  19 #include "yportenv.h"
  20
  21 #define YAFFS_OK        1
  22 #define YAFFS_FAIL  0
  23
  24 /* Give us a  Y=0x59,
  25  * Give us an A=0x41,
  26  * Give us an FF=0xff
  27  * Give us an S=0x53
  28  * And what have we got...
  29  */
  30 #define YAFFS_MAGIC                     0x5941ff53
  31
  32 /*
  33  * Tnodes form a tree with the tnodes in "levels"
  34  * Levels greater than 0 hold 8 slots which point to other tnodes.
  35  * Those at level 0 hold 16 slots which point to chunks in NAND.
  36  *
  37  * A maximum level of 8 thust supports files of size up to:
  38  *
  39  * 2^(3*MAX_LEVEL+4)
  40  *
  41  * Thus a max level of 8 supports files with up to 2^^28 chunks which gives
  42  * a maximum file size of around 512Gbytees with 2k chunks.
  43  */
  44 #define YAFFS_NTNODES_LEVEL0            16
  45 #define YAFFS_TNODES_LEVEL0_BITS        4
  46 #define YAFFS_TNODES_LEVEL0_MASK        0xf
  47
  48 #define YAFFS_NTNODES_INTERNAL          (YAFFS_NTNODES_LEVEL0 / 2)
  49 #define YAFFS_TNODES_INTERNAL_BITS      (YAFFS_TNODES_LEVEL0_BITS - 1)
  50 #define YAFFS_TNODES_INTERNAL_MASK      0x7
  51 #define YAFFS_TNODES_MAX_LEVEL          8
  52 #define YAFFS_TNODES_MAX_BITS           (YAFFS_TNODES_LEVEL0_BITS + \
  53                                         YAFFS_TNODES_INTERNAL_BITS * \
  54                                         YAFFS_TNODES_MAX_LEVEL)
  55 #define YAFFS_MAX_CHUNK_ID              ((1 << YAFFS_TNODES_MAX_BITS) - 1)
  56
  57 #define YAFFS_MAX_FILE_SIZE_32          0x7fffffff
  58
  59 /* Constants for YAFFS1 mode */
  60 #define YAFFS_BYTES_PER_SPARE           16
  61 #define YAFFS_BYTES_PER_CHUNK           512
  62 #define YAFFS_CHUNK_SIZE_SHIFT          9
  63 #define YAFFS_CHUNKS_PER_BLOCK          32
  64 #define YAFFS_BYTES_PER_BLOCK   (YAFFS_CHUNKS_PER_BLOCK*YAFFS_BYTES_PER_CHUNK)
  65
  66 #define YAFFS_MIN_YAFFS2_CHUNK_SIZE     1024
  67 #define YAFFS_MIN_YAFFS2_SPARE_SIZE     32
  68
  69
  70
  71 #define YAFFS_ALLOCATION_NOBJECTS       100
  72 #define YAFFS_ALLOCATION_NTNODES        100
  73 #define YAFFS_ALLOCATION_NLINKS         100
  74
  75 #define YAFFS_NOBJECT_BUCKETS           256
  76
  77 #define YAFFS_OBJECT_SPACE              0x40000
  78 #define YAFFS_MAX_OBJECT_ID             (YAFFS_OBJECT_SPACE - 1)
  79
  80 /* Binary data version stamps */
  81 #define YAFFS_SUMMARY_VERSION           1
  82
  83 #ifdef CONFIG_YAFFS_UNICODE
  84 #define YAFFS_MAX_NAME_LENGTH           127
  85 #define YAFFS_MAX_ALIAS_LENGTH          79
  86 #else
  87 #define YAFFS_MAX_NAME_LENGTH           255
  88 #define YAFFS_MAX_ALIAS_LENGTH          159
  89 #endif
  90
  91 #define YAFFS_SHORT_NAME_LENGTH         15
  92
  93 /* Some special object ids for pseudo objects */
  94 #define YAFFS_OBJECTID_ROOT             1
  95 #define YAFFS_OBJECTID_LOSTNFOUND       2
  96 #define YAFFS_OBJECTID_UNLINKED         3
  97 #define YAFFS_OBJECTID_DELETED          4
  98
  99 /* Fake object Id for summary data */
 100 #define YAFFS_OBJECTID_SUMMARY          0x10
 101
 102 /* Pseudo object ids for checkpointing */
 103 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
 104 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
 105
 106 #define YAFFS_MAX_SHORT_OP_CACHES       20
 107
 108 #define YAFFS_N_TEMP_BUFFERS            6
 109
 110 /* We limit the number attempts at sucessfully saving a chunk of data.
 111  * Small-page devices have 32 pages per block; large-page devices have 64.
 112  * Default to something in the order of 5 to 10 blocks worth of chunks.
 113  */
 114 #define YAFFS_WR_ATTEMPTS               (5*64)
 115
 116 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 117  * The range is limited slightly to help distinguish bad numbers from good.
 118  * This also allows us to perhaps in the future use special numbers for
 119  * special purposes.
 120  * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
 121  * and is a larger number than the lifetime of a 2GB device.
 122  */
 123 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 124 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xefffff00
 125
 126 /* Special sequence number for bad block that failed to be marked bad */
 127 #define YAFFS_SEQUENCE_BAD_BLOCK        0xffff0000
 128
 129 /* ChunkCache is used for short read/write operations.*/
 130 struct yaffs_cache {
 131         struct yaffs_obj *object;
 132         int chunk_id;
 133         int last_use;
 134         int dirty;
 135         int n_bytes;            /* Only valid if the cache is dirty */
 136         int locked;             /* Can't push out or flush while locked. */
 137         u8 *data;
 138 };
 139
 140 /* yaffs1 tags structures in RAM
 141  * NB This uses bitfield. Bitfields should not straddle a u32 boundary
 142  * otherwise the structure size will get blown out.
 143  */
 144
 145 struct yaffs_tags {
 146         u32 chunk_id:20;
 147         u32 serial_number:2;
 148         u32 n_bytes_lsb:10;
 149         u32 obj_id:18;
 150         u32 ecc:12;
 151         u32 n_bytes_msb:2;
 152 };
 153
 154 union yaffs_tags_union {
 155         struct yaffs_tags as_tags;
 156         u8  as_bytes[8];
 157         u32 as_u32[2];
 158 };
 159
 160
 161 /* Stuff used for extended tags in YAFFS2 */
 162
 163 enum yaffs_ecc_result {
 164         YAFFS_ECC_RESULT_UNKNOWN,
 165         YAFFS_ECC_RESULT_NO_ERROR,
 166         YAFFS_ECC_RESULT_FIXED,
 167         YAFFS_ECC_RESULT_UNFIXED
 168 };
 169
 170 /*
 171  * Object type enum:
 172  * When this is stored in flash we store it as a u32 instead
 173  * to prevent any alignment change issues as compiler variants change.
 174  */
 175
 176 enum yaffs_obj_type {
 177         YAFFS_OBJECT_TYPE_UNKNOWN,
 178         YAFFS_OBJECT_TYPE_FILE,
 179         YAFFS_OBJECT_TYPE_SYMLINK,
 180         YAFFS_OBJECT_TYPE_DIRECTORY,
 181         YAFFS_OBJECT_TYPE_HARDLINK,
 182         YAFFS_OBJECT_TYPE_SPECIAL
 183 };
 184
 185 #define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
 186
 187 struct yaffs_ext_tags {
 188         unsigned chunk_used;    /*  Status of the chunk: used or unused */
 189         unsigned obj_id;        /* If 0 this is not used */
 190         unsigned chunk_id;      /* If 0 this is a header, else a data chunk */
 191         unsigned n_bytes;       /* Only valid for data chunks */
 192
 193         /* The following stuff only has meaning when we read */
 194         enum yaffs_ecc_result ecc_result;
 195         unsigned block_bad;
 196
 197         /* YAFFS 1 stuff */
 198         unsigned is_deleted;    /* The chunk is marked deleted */
 199         unsigned serial_number; /* Yaffs1 2-bit serial number */
 200
 201         /* YAFFS2 stuff */
 202         unsigned seq_number;    /* The sequence number of this block */
 203
 204         /* Extra info if this is an object header (YAFFS2 only) */
 205
 206         unsigned extra_available;       /* Extra info available if not zero */
 207         unsigned extra_parent_id;       /* The parent object */
 208         unsigned extra_is_shrink;       /* Is it a shrink header? */
 209         unsigned extra_shadows; /* Does this shadow another object? */
 210
 211         enum yaffs_obj_type extra_obj_type;     /* What object type? */
 212
 213         loff_t extra_file_size;         /* Length if it is a file */
 214         unsigned extra_equiv_id;        /* Equivalent object for a hard link */
 215 };
 216
 217 /* Spare structure for YAFFS1 */
 218 struct yaffs_spare {
 219         u8 tb0;
 220         u8 tb1;
 221         u8 tb2;
 222         u8 tb3;
 223         u8 page_status;         /* set to 0 to delete the chunk */
 224         u8 block_status;
 225         u8 tb4;
 226         u8 tb5;
 227         u8 ecc1[3];
 228         u8 tb6;
 229         u8 tb7;
 230         u8 ecc2[3];
 231 };
 232
 233 /*Special structure for passing through to mtd */
 234 struct yaffs_nand_spare {
 235         struct yaffs_spare spare;
 236         int eccres1;
 237         int eccres2;
 238 };
 239
 240 /* Block data in RAM */
 241
 242 enum yaffs_block_state {
 243         YAFFS_BLOCK_STATE_UNKNOWN = 0,
 244
 245         YAFFS_BLOCK_STATE_SCANNING,
 246         /* Being scanned */
 247
 248         YAFFS_BLOCK_STATE_NEEDS_SCAN,
 249         /* The block might have something on it (ie it is allocating or full,
 250          * perhaps empty) but it needs to be scanned to determine its true
 251          * state.
 252          * This state is only valid during scanning.
 253          * NB We tolerate empty because the pre-scanner might be incapable of
 254          * deciding
 255          * However, if this state is returned on a YAFFS2 device,
 256          * then we expect a sequence number
 257          */
 258
 259         YAFFS_BLOCK_STATE_EMPTY,
 260         /* This block is empty */
 261
 262         YAFFS_BLOCK_STATE_ALLOCATING,
 263         /* This block is partially allocated.
 264          * At least one page holds valid data.
 265          * This is the one currently being used for page
 266          * allocation. Should never be more than one of these.
 267          * If a block is only partially allocated at mount it is treated as
 268          * full.
 269          */
 270
 271         YAFFS_BLOCK_STATE_FULL,
 272         /* All the pages in this block have been allocated.
 273          * If a block was only partially allocated when mounted we treat
 274          * it as fully allocated.
 275          */
 276
 277         YAFFS_BLOCK_STATE_DIRTY,
 278         /* The block was full and now all chunks have been deleted.
 279          * Erase me, reuse me.
 280          */
 281
 282         YAFFS_BLOCK_STATE_CHECKPOINT,
 283         /* This block is assigned to holding checkpoint data. */
 284
 285         YAFFS_BLOCK_STATE_COLLECTING,
 286         /* This block is being garbage collected */
 287
 288         YAFFS_BLOCK_STATE_DEAD
 289             /* This block has failed and is not in use */
 290 };
 291
 292 #define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
 293
 294 struct yaffs_block_info {
 295
 296         s32 soft_del_pages:10;  /* number of soft deleted pages */
 297         s32 pages_in_use:10;    /* number of pages in use */
 298         u32 block_state:4;      /* One of the above block states. */
 299                                 /* NB use unsigned because enum is sometimes
 300                                  * an int */
 301         u32 needs_retiring:1;   /* Data has failed on this block, */
 302                                 /*need to get valid data off and retire*/
 303         u32 skip_erased_check:1;/* Skip the erased check on this block */
 304         u32 gc_prioritise:1;    /* An ECC check or blank check has failed.
 305                                    Block should be prioritised for GC */
 306         u32 chunk_error_strikes:3;      /* How many times we've had ecc etc
 307                                 failures on this block and tried to reuse it */
 308         u32 has_summary:1;      /* The block has a summary */
 309
 310         u32 has_shrink_hdr:1;   /* This block has at least one shrink header */
 311         u32 seq_number;         /* block sequence number for yaffs2 */
 312
 313 };
 314
 315 union yaffs_block_info_union {
 316         struct yaffs_block_info bi;
 317         u32     as_u32[2];
 318 };
 319
 320 /* -------------------------- Object structure -------------------------------*/
 321 /* This is the object structure as stored on NAND */
 322
 323 struct yaffs_obj_hdr {
 324         u32 type;  /* enum yaffs_obj_type  */
 325
 326         /* Apply to everything  */
 327         u32 parent_obj_id;
 328         u16 sum_no_longer_used; /* checksum of name. No longer used */
 329         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 330
 331         /* The following apply to all object types except for hard links */
 332         u32 yst_mode;           /* protection */
 333
 334         u32 yst_uid;
 335         u32 yst_gid;
 336         u32 yst_atime;
 337         u32 yst_mtime;
 338         u32 yst_ctime;
 339
 340         /* File size  applies to files only */
 341         u32 file_size_low;
 342
 343         /* Equivalent object id applies to hard links only. */
 344         int equiv_id;
 345
 346         /* Alias is for symlinks only. */
 347         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 348
 349         u32 yst_rdev;   /* stuff for block and char devices (major/min) */
 350
 351         u32 win_ctime[2];
 352         u32 win_atime[2];
 353         u32 win_mtime[2];
 354
 355         u32 inband_shadowed_obj_id;
 356         u32 inband_is_shrink;
 357
 358         u32 file_size_high;
 359         u32 reserved[1];
 360         int shadows_obj;        /* This object header shadows the
 361                                 specified object if > 0 */
 362
 363         /* is_shrink applies to object headers written when wemake a hole. */
 364         u32 is_shrink;
 365
 366 };
 367
 368 /*--------------------------- Tnode -------------------------- */
 369
 370 struct yaffs_tnode {
 371         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 372 };
 373
 374 /*------------------------  Object -----------------------------*/
 375 /* An object can be one of:
 376  * - a directory (no data, has children links
 377  * - a regular file (data.... not prunes :->).
 378  * - a symlink [symbolic link] (the alias).
 379  * - a hard link
 380  */
 381
 382 /* The file variant has three file sizes:
 383  *  - file_size : size of file as written into Yaffs - including data in cache.
 384  *  - stored_size - size of file as stored on media.
 385  *  - shrink_size - size of file that has been shrunk back to.
 386  *
 387  * The stored_size and file_size might be different because the data written
 388  * into the cache will increase the file_size but the stored_size will only
 389  * change when the data is actually stored.
 390  *
 391  */
 392 struct yaffs_file_var {
 393         loff_t file_size;
 394         loff_t stored_size;
 395         loff_t shrink_size;
 396         int top_level;
 397         struct yaffs_tnode *top;
 398 };
 399
 400 struct yaffs_dir_var {
 401         struct list_head children;      /* list of child links */
 402         struct list_head dirty; /* Entry for list of dirty directories */
 403 };
 404
 405 struct yaffs_symlink_var {
 406         YCHAR *alias;
 407 };
 408
 409 struct yaffs_hardlink_var {
 410         struct yaffs_obj *equiv_obj;
 411         u32 equiv_id;
 412 };
 413
 414 union yaffs_obj_var {
 415         struct yaffs_file_var file_variant;
 416         struct yaffs_dir_var dir_variant;
 417         struct yaffs_symlink_var symlink_variant;
 418         struct yaffs_hardlink_var hardlink_variant;
 419 };
 420
 421 struct yaffs_obj {
 422         u8 deleted:1;           /* This should only apply to unlinked files. */
 423         u8 soft_del:1;          /* it has also been soft deleted */
 424         u8 unlinked:1;          /* An unlinked file.*/
 425         u8 fake:1;              /* A fake object has no presence on NAND. */
 426         u8 rename_allowed:1;    /* Some objects cannot be renamed. */
 427         u8 unlink_allowed:1;
 428         u8 dirty:1;             /* the object needs to be written to flash */
 429         u8 valid:1;             /* When the file system is being loaded up, this
 430                                  * object might be created before the data
 431                                  * is available
 432                                  * ie. file data chunks encountered before
 433                                 * the header.
 434                                  */
 435         u8 lazy_loaded:1;       /* This object has been lazy loaded and
 436                                  * is missing some detail */
 437
 438         u8 defered_free:1;      /* Object is removed from NAND, but is
 439                                  * still in the inode cache.
 440                                  * Free of object is defered.
 441                                  * until the inode is released.
 442                                  */
 443         u8 being_created:1;     /* This object is still being created
 444                                  * so skip some verification checks. */
 445         u8 is_shadowed:1;       /* This object is shadowed on the way
 446                                  * to being renamed. */
 447
 448         u8 xattr_known:1;       /* We know if this has object has xattribs
 449                                  * or not. */
 450         u8 has_xattr:1;         /* This object has xattribs.
 451                                  * Only valid if xattr_known. */
 452
 453         u8 serial;              /* serial number of chunk in NAND.*/
 454         u16 sum;                /* sum of the name to speed searching */
 455
 456         struct yaffs_dev *my_dev;       /* The device I'm on */
 457
 458         struct list_head hash_link;     /* list of objects in hash bucket */
 459
 460         struct list_head hard_links;    /* hard linked object chain*/
 461
 462         /* directory structure stuff */
 463         /* also used for linking up the free list */
 464         struct yaffs_obj *parent;
 465         struct list_head siblings;
 466
 467         /* Where's my object header in NAND? */
 468         int hdr_chunk;
 469
 470         int n_data_chunks;      /* Number of data chunks for this file. */
 471
 472         u32 obj_id;             /* the object id value */
 473
 474         u32 yst_mode;
 475
 476         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 477
 478 #ifdef CONFIG_YAFFS_WINCE
 479         u32 win_ctime[2];
 480         u32 win_mtime[2];
 481         u32 win_atime[2];
 482 #else
 483         u32 yst_uid;
 484         u32 yst_gid;
 485         u32 yst_atime;
 486         u32 yst_mtime;
 487         u32 yst_ctime;
 488 #endif
 489
 490         u32 yst_rdev;
 491
 492         void *my_inode;
 493
 494         u32 variant_type; /* enum yaffs_object_type */
 495
 496         union yaffs_obj_var variant;
 497
 498 };
 499
 500 struct yaffs_obj_bucket {
 501         struct list_head list;
 502         int count;
 503 };
 504
 505
 506 /*--------------------- Temporary buffers ----------------
 507  *
 508  * These are chunk-sized working buffers. Each device has a few.
 509  */
 510
 511 struct yaffs_buffer {
 512         u8 *buffer;
 513         int in_use;
 514 };
 515
 516 /*----------------- Device ---------------------------------*/
 517
 518 struct yaffs_param {
 519         const YCHAR *name;
 520
 521         /*
 522          * Entry parameters set up way early. Yaffs sets up the rest.
 523          * The structure should be zeroed out before use so that unused
 524          * and default values are zero.
 525          */
 526
 527         int inband_tags;        /* Use unband tags */
 528         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 529                                          be a power of 2 */
 530         u32 chunks_per_block;   /* does not need to be a power of 2 */
 531         u32 spare_bytes_per_chunk;      /* spare area size */
 532         u32 start_block;        /* Start block we're allowed to use */
 533         u32 end_block;          /* End block we're allowed to use */
 534         u32 n_reserved_blocks;  /* Tuneable so that we can reduce
 535                                  * reserved blocks on NOR and RAM. */
 536
 537         u32 n_caches;           /* If == 0, then short op caching is disabled,
 538                                  * else the number of short op caches.
 539                                  */
 540         int cache_bypass_aligned; /* If non-zero then bypass the cache for
 541                                    * aligned writes.
 542                                    */
 543
 544         int use_nand_ecc;       /* Flag to decide whether or not to use
 545                                  * NAND driver ECC on data (yaffs1) */
 546         int tags_9bytes;        /* Use 9 byte tags */
 547         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 548                                  * on packed tags (yaffs2) */
 549
 550         int is_yaffs2;          /* Use yaffs2 mode on this device */
 551
 552         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 553
 554         int refresh_period;     /* How often to check for a block refresh */
 555
 556         /* Checkpoint control. Can be set before or after initialisation */
 557         u8 skip_checkpt_rd;
 558         u8 skip_checkpt_wr;
 559
 560         int enable_xattr;       /* Enable xattribs */
 561
 562         int max_objects;        /*
 563                                  * Set to limit the number of objects created.
 564                                  * 0 = no limit.
 565                                 */
 566
 567         int hide_lost_n_found;  /* Set non-zero to hide the lost-n-found dir. */
 568
 569         int stored_endian; /* 0=cpu endian, 1=little endian, 2=big endian */
 570
 571         /* The remove_obj_fn function must be supplied by OS flavours that
 572          * need it.
 573          * yaffs direct uses it to implement the faster readdir.
 574          * Linux uses it to protect the directory during unlocking.
 575          */
 576         void (*remove_obj_fn) (struct yaffs_obj *obj);
 577
 578         /* Callback to mark the superblock dirty */
 579         void (*sb_dirty_fn) (struct yaffs_dev *dev);
 580
 581         /*  Callback to control garbage collection. */
 582         unsigned (*gc_control_fn) (struct yaffs_dev *dev);
 583
 584         /* Debug control flags. Don't use unless you know what you're doing */
 585         int use_header_file_size;       /* Flag to determine if we should use
 586                                          * file sizes from the header */
 587         int disable_lazy_load;  /* Disable lazy loading on this device */
 588         int wide_tnodes_disabled;       /* Set to disable wide tnodes */
 589         int disable_soft_del;   /* yaffs 1 only: Set to disable the use of
 590                                  * softdeletion. */
 591
 592         int defered_dir_update; /* Set to defer directory updates */
 593
 594 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 595         int auto_unicode;
 596 #endif
 597         int always_check_erased;        /* Force chunk erased check always on */
 598
 599         int disable_summary;
 600         int disable_bad_block_marking;
 601
 602 };
 603
 604 struct yaffs_driver {
 605         int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 606                                    const u8 *data, int data_len,
 607                                    const u8 *oob, int oob_len);
 608         int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 609                                    u8 *data, int data_len,
 610                                    u8 *oob, int oob_len,
 611                                    enum yaffs_ecc_result *ecc_result);
 612         int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
 613         int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 614         int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
 615         int (*drv_initialise_fn) (struct yaffs_dev *dev);
 616         int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
 617 };
 618
 619 struct yaffs_tags_handler {
 620         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 621                                     int nand_chunk, const u8 *data,
 622                                     const struct yaffs_ext_tags *tags);
 623         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 624                                    int nand_chunk, u8 *data,
 625                                    struct yaffs_ext_tags *tags);
 626
 627         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 628                                enum yaffs_block_state *state,
 629                                u32 *seq_number);
 630         int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 631 };
 632
 633 struct yaffs_dev {
 634         struct yaffs_param param;
 635         struct yaffs_driver drv;
 636         struct yaffs_tags_handler tagger;
 637
 638         /* Context storage. Holds extra OS specific data for this device */
 639
 640         void *os_context;
 641         void *driver_context;
 642
 643         struct list_head dev_list;
 644
 645         int ll_init;
 646         /* Runtime parameters. Set up by YAFFS. */
 647         u32 data_bytes_per_chunk;
 648
 649         /* Non-wide tnode stuff */
 650         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 651                                  * the tnodes are not wide enough.
 652                                  */
 653         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 654
 655         struct yaffs_tnode *tn_swap_buffer;
 656
 657         /* Stuff to support wide tnodes */
 658         u32 tnode_width;
 659         u32 tnode_mask;
 660         u32 tnode_size;
 661
 662         /* Stuff for figuring out file offset to chunk conversions */
 663         u32 chunk_shift;        /* Shift value */
 664         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 665         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 666
 667         int is_mounted;
 668         int read_only;
 669         int is_checkpointed;
 670         int swap_endian;        /* Stored endian needs endian swap. */
 671
 672         /* Stuff to support block offsetting to support start block zero */
 673         u32 internal_start_block;
 674         u32 internal_end_block;
 675         int block_offset;
 676         int chunk_offset;
 677
 678         /* Runtime checkpointing stuff */
 679         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 680         int checkpt_byte_count;
 681         int checkpt_byte_offs;
 682         u8 *checkpt_buffer;
 683         int checkpt_open_write;
 684         u32 blocks_in_checkpt;
 685         int checkpt_cur_chunk;
 686         int checkpt_cur_block;
 687         int checkpt_next_block;
 688         int *checkpt_block_list;
 689         u32 checkpt_max_blocks;
 690         u32 checkpt_sum;
 691         u32 checkpt_xor;
 692
 693         int checkpoint_blocks_required; /* Number of blocks needed to store
 694                                          * current checkpoint set */
 695
 696         /* Block Info */
 697         struct yaffs_block_info *block_info;
 698         u8 *chunk_bits;         /* bitmap of chunks in use */
 699         u8 block_info_alt:1;    /* allocated using alternative alloc */
 700         u8 chunk_bits_alt:1;    /* allocated using alternative alloc */
 701         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 702                                  * Must be consistent with chunks_per_block.
 703                                  */
 704
 705         int n_erased_blocks;
 706         int alloc_block;        /* Current block being allocated off */
 707         u32 alloc_page;
 708         int alloc_block_finder; /* Used to search for next allocation block */
 709
 710         /* Object and Tnode memory management */
 711         void *allocator;
 712         int n_obj;
 713         int n_tnodes;
 714
 715         int n_hardlinks;
 716
 717         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 718         u32 bucket_finder;
 719
 720         int n_free_chunks;
 721
 722         /* Garbage collection control */
 723         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 724         u32 n_clean_ups;
 725
 726         unsigned has_pending_prioritised_gc;    /* We think this device might
 727                                                 have pending prioritised gcs */
 728         unsigned gc_disable;
 729         unsigned gc_block_finder;
 730         unsigned gc_dirtiest;
 731         unsigned gc_pages_in_use;
 732         unsigned gc_not_done;
 733         unsigned gc_block;
 734         unsigned gc_chunk;
 735         unsigned gc_skip;
 736         struct yaffs_summary_tags *gc_sum_tags;
 737
 738         /* Special directories */
 739         struct yaffs_obj *root_dir;
 740         struct yaffs_obj *lost_n_found;
 741
 742         int buffered_block;     /* Which block is buffered here? */
 743         int doing_buffered_block_rewrite;
 744
 745         struct yaffs_cache *cache;
 746         int cache_last_use;
 747
 748         /* Stuff for background deletion and unlinked files. */
 749         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 750                                          files live. */
 751         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 752                                         sent to disappear. */
 753         struct yaffs_obj *unlinked_deletion;    /* Current file being
 754                                                         background deleted. */
 755         int n_deleted_files;    /* Count of files awaiting deletion; */
 756         int n_unlinked_files;   /* Count of unlinked files. */
 757         int n_bg_deletions;     /* Count of background deletions. */
 758
 759         /* Temporary buffer management */
 760         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 761         int max_temp;
 762         int temp_in_use;
 763         int unmanaged_buffer_allocs;
 764         int unmanaged_buffer_deallocs;
 765
 766         /* yaffs2 runtime stuff */
 767         unsigned seq_number;    /* Sequence number of currently
 768                                         allocating block */
 769         unsigned oldest_dirty_seq;
 770         unsigned oldest_dirty_block;
 771
 772         /* Block refreshing */
 773         int refresh_skip;       /* A skip down counter.
 774                                  * Refresh happens when this gets to zero. */
 775
 776         /* Dirty directory handling */
 777         struct list_head dirty_dirs;    /* List of dirty directories */
 778
 779         /* Summary */
 780         int chunks_per_summary;
 781         struct yaffs_summary_tags *sum_tags;
 782
 783         /* Statistics */
 784         u32 n_page_writes;
 785         u32 n_page_reads;
 786         u32 n_erasures;
 787         u32 n_bad_queries;
 788         u32 n_bad_markings;
 789         u32 n_erase_failures;
 790         u32 n_gc_copies;
 791         u32 all_gcs;
 792         u32 passive_gc_count;
 793         u32 oldest_dirty_gc_count;
 794         u32 n_gc_blocks;
 795         u32 bg_gcs;
 796         u32 n_retried_writes;
 797         u32 n_retired_blocks;
 798         u32 n_ecc_fixed;
 799         u32 n_ecc_unfixed;
 800         u32 n_tags_ecc_fixed;
 801         u32 n_tags_ecc_unfixed;
 802         u32 n_deletions;
 803         u32 n_unmarked_deletions;
 804         u32 refresh_count;
 805         u32 cache_hits;
 806         u32 tags_used;
 807         u32 summary_used;
 808
 809 };
 810
 811 /*
 812  * Checkpointing definitions.
 813  */
 814
 815 #define YAFFS_CHECKPOINT_VERSION        8
 816
 817 /* yaffs_checkpt_obj holds the definition of an object as dumped
 818  * by checkpointing.
 819  */
 820
 821
 822 /*  Checkpint object bits in bitfield: offset, length */
 823 #define CHECKPOINT_VARIANT_BITS         0, 3
 824 #define CHECKPOINT_DELETED_BITS         3, 1
 825 #define CHECKPOINT_SOFT_DEL_BITS        4, 1
 826 #define CHECKPOINT_UNLINKED_BITS        5, 1
 827 #define CHECKPOINT_FAKE_BITS            6, 1
 828 #define CHECKPOINT_RENAME_ALLOWED_BITS  7, 1
 829 #define CHECKPOINT_UNLINK_ALLOWED_BITS  8, 1
 830 #define CHECKPOINT_SERIAL_BITS          9, 8
 831
 832 struct yaffs_checkpt_obj {
 833         int struct_type;
 834         u32 obj_id;
 835         u32 parent_id;
 836         int hdr_chunk;
 837         u32 bit_field;
 838         int n_data_chunks;
 839         loff_t size_or_equiv_obj;
 840 };
 841
 842 /* The CheckpointDevice structure holds the device information that changes
 843  *at runtime and must be preserved over unmount/mount cycles.
 844  */
 845 struct yaffs_checkpt_dev {
 846         int struct_type;
 847         int n_erased_blocks;
 848         int alloc_block;        /* Current block being allocated off */
 849         u32 alloc_page;
 850         int n_free_chunks;
 851
 852         int n_deleted_files;    /* Count of files awaiting deletion; */
 853         int n_unlinked_files;   /* Count of unlinked files. */
 854         int n_bg_deletions;     /* Count of background deletions. */
 855
 856         /* yaffs2 runtime stuff */
 857         unsigned seq_number;    /* Sequence number of currently
 858                                  * allocating block */
 859
 860 };
 861
 862 struct yaffs_checkpt_validity {
 863         int struct_type;
 864         u32 magic;
 865         u32 version;
 866         u32 head;
 867 };
 868
 869 struct yaffs_shadow_fixer {
 870         int obj_id;
 871         int shadowed_id;
 872         struct yaffs_shadow_fixer *next;
 873 };
 874
 875 /* Structure for doing xattr modifications */
 876 struct yaffs_xattr_mod {
 877         int set;                /* If 0 then this is a deletion */
 878         const YCHAR *name;
 879         const void *data;
 880         int size;
 881         int flags;
 882         int result;
 883 };
 884
 885 /*----------------------- YAFFS Functions -----------------------*/
 886
 887 int yaffs_guts_initialise(struct yaffs_dev *dev);
 888 void yaffs_deinitialise(struct yaffs_dev *dev);
 889
 890 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 891
 892 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 893                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 894
 895 int yaffs_unlink_obj(struct yaffs_obj *obj);
 896
 897 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 898 int yaffs_del_obj(struct yaffs_obj *obj);
 899 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
 900                                    enum yaffs_obj_type type);
 901
 902
 903 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 904 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
 905 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 906 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 907 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 908
 909 /* File operations */
 910 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 911                   int n_bytes);
 912 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 913                   int n_bytes, int write_trhrough);
 914 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 915
 916 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 917                                     const YCHAR *name, u32 mode, u32 uid,
 918                                     u32 gid);
 919
 920 int yaffs_flush_file(struct yaffs_obj *in,
 921                      int update_time,
 922                      int data_sync,
 923                      int discard_cache);
 924
 925 /* Flushing and checkpointing */
 926 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
 927
 928 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 929 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 930
 931 /* Directory operations */
 932 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 933                                    u32 mode, u32 uid, u32 gid);
 934 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 935                                      const YCHAR *name);
 936 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 937
 938 /* Link operations */
 939 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 940                                  struct yaffs_obj *equiv_obj);
 941
 942 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 943
 944 /* Symlink operations */
 945 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 946                                        const YCHAR *name, u32 mode, u32 uid,
 947                                        u32 gid, const YCHAR *alias);
 948 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 949
 950 /* Special inodes (fifos, sockets and devices) */
 951 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 952                                        const YCHAR *name, u32 mode, u32 uid,
 953                                        u32 gid, u32 rdev);
 954
 955 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 956                       const void *value, int size, int flags);
 957 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 958                       int size);
 959 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 960 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 961
 962 /* Special directories */
 963 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 964 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 965
 966 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 967
 968 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 969
 970 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 971
 972 /* Debug dump  */
 973 int yaffs_dump_obj(struct yaffs_obj *obj);
 974
 975 void yaffs_guts_test(struct yaffs_dev *dev);
 976 int yaffs_guts_ll_init(struct yaffs_dev *dev);
 977
 978
 979 /* A few useful functions to be used within the core files*/
 980 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 981                      int lyn);
 982 int yaffs_check_ff(u8 *buffer, int n_bytes);
 983 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 984                               struct yaffs_block_info *bi);
 985
 986 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
 987 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
 988
 989 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 990                                                  int number,
 991                                                  enum yaffs_obj_type type);
 992 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 993                             int nand_chunk, int in_scan);
 994 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 995 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 996                                 const struct yaffs_obj_hdr *oh);
 997 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
 998 YCHAR *yaffs_clone_str(const YCHAR *str);
 999 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
1000 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
1001 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
1002                     int force, int is_shrink, int shadows,
1003                     struct yaffs_xattr_mod *xop);
1004 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
1005                                int backward_scanning);
1006 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
1007 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
1008 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
1009                                            struct yaffs_file_var *file_struct,
1010                                            u32 chunk_id,
1011                                            struct yaffs_tnode *passed_tn);
1012
1013 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
1014                      int n_bytes, int write_trhrough);
1015 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
1016 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
1017
1018 int yaffs_count_free_chunks(struct yaffs_dev *dev);
1019
1020 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
1021                                        struct yaffs_file_var *file_struct,
1022                                        u32 chunk_id);
1023
1024 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
1025                          unsigned pos);
1026
1027 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
1028
1029 int yaffs_guts_format_dev(struct yaffs_dev *dev);
1030
1031 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
1032                                 int *chunk_out, u32 *offset_out);
1033 /*
1034  * Marshalling functions to get loff_t file sizes into and out of
1035  * object headers.
1036  */
1037 void yaffs_oh_size_load(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1038                         loff_t fsize, int do_endian);
1039 loff_t yaffs_oh_to_size(struct yaffs_dev *dev, struct yaffs_obj_hdr *oh,
1040                         int do_endian);
1041 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1042
1043 /*
1044  * Debug function to count number of blocks in each state
1045  * NB Needs to be called with correct number of integers
1046  */
1047
1048 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1049
1050 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1051                                     struct yaffs_ext_tags *tags);
1052
1053 /*
1054  * Define LOFF_T_32_BIT if a 32-bit LOFF_T is being used.
1055  * Not serious if you get this wrong - you might just get some warnings.
1056 */
1057
1058 #ifdef  LOFF_T_32_BIT
1059 #define FSIZE_LOW(fsize) (fsize)
1060 #define FSIZE_HIGH(fsize) 0
1061 #define FSIZE_COMBINE(high, low) (low)
1062 #else
1063 #define FSIZE_LOW(fsize) ((fsize) & 0xffffffff)
1064 #define FSIZE_HIGH(fsize)(((fsize) >> 32) & 0xffffffff)
1065 #define FSIZE_COMBINE(high, low) ((((loff_t) (high)) << 32) | \
1066                                         (((loff_t) (low)) & 0xFFFFFFFF))
1067 #endif
1068
1069
1070 #endif