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 #define YAFFS_CHECKPOINT_VERSION        7
  83
  84 #ifdef CONFIG_YAFFS_UNICODE
  85 #define YAFFS_MAX_NAME_LENGTH           127
  86 #define YAFFS_MAX_ALIAS_LENGTH          79
  87 #else
  88 #define YAFFS_MAX_NAME_LENGTH           255
  89 #define YAFFS_MAX_ALIAS_LENGTH          159
  90 #endif
  91
  92 #define YAFFS_SHORT_NAME_LENGTH         15
  93
  94 /* Some special object ids for pseudo objects */
  95 #define YAFFS_OBJECTID_ROOT             1
  96 #define YAFFS_OBJECTID_LOSTNFOUND       2
  97 #define YAFFS_OBJECTID_UNLINKED         3
  98 #define YAFFS_OBJECTID_DELETED          4
  99
 100 /* Fake object Id for summary data */
 101 #define YAFFS_OBJECTID_SUMMARY          0x10
 102
 103 /* Pseudo object ids for checkpointing */
 104 #define YAFFS_OBJECTID_CHECKPOINT_DATA  0x20
 105 #define YAFFS_SEQUENCE_CHECKPOINT_DATA  0x21
 106
 107 #define YAFFS_MAX_SHORT_OP_CACHES       20
 108
 109 #define YAFFS_N_TEMP_BUFFERS            6
 110
 111 /* We limit the number attempts at sucessfully saving a chunk of data.
 112  * Small-page devices have 32 pages per block; large-page devices have 64.
 113  * Default to something in the order of 5 to 10 blocks worth of chunks.
 114  */
 115 #define YAFFS_WR_ATTEMPTS               (5*64)
 116
 117 /* Sequence numbers are used in YAFFS2 to determine block allocation order.
 118  * The range is limited slightly to help distinguish bad numbers from good.
 119  * This also allows us to perhaps in the future use special numbers for
 120  * special purposes.
 121  * EFFFFF00 allows the allocation of 8 blocks/second (~1Mbytes) for 15 years,
 122  * and is a larger number than the lifetime of a 2GB device.
 123  */
 124 #define YAFFS_LOWEST_SEQUENCE_NUMBER    0x00001000
 125 #define YAFFS_HIGHEST_SEQUENCE_NUMBER   0xefffff00
 126
 127 /* Special sequence number for bad block that failed to be marked bad */
 128 #define YAFFS_SEQUENCE_BAD_BLOCK        0xffff0000
 129
 130 /* ChunkCache is used for short read/write operations.*/
 131 struct yaffs_cache {
 132         struct yaffs_obj *object;
 133         int chunk_id;
 134         int last_use;
 135         int dirty;
 136         int n_bytes;            /* Only valid if the cache is dirty */
 137         int locked;             /* Can't push out or flush while locked. */
 138         u8 *data;
 139 };
 140
 141 /* yaffs1 tags structures in RAM
 142  * NB This uses bitfield. Bitfields should not straddle a u32 boundary
 143  * otherwise the structure size will get blown out.
 144  */
 145
 146 struct yaffs_tags {
 147         u32 chunk_id:20;
 148         u32 serial_number:2;
 149         u32 n_bytes_lsb:10;
 150         u32 obj_id:18;
 151         u32 ecc:12;
 152         u32 n_bytes_msb:2;
 153 };
 154
 155 union yaffs_tags_union {
 156         struct yaffs_tags as_tags;
 157         u8 as_bytes[8];
 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 /* -------------------------- Object structure -------------------------------*/
 316 /* This is the object structure as stored on NAND */
 317
 318 struct yaffs_obj_hdr {
 319         u32 type;  /* enum yaffs_obj_type  */
 320
 321         /* Apply to everything  */
 322         int parent_obj_id;
 323         u16 sum_no_longer_used; /* checksum of name. No longer used */
 324         YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
 325
 326         /* The following apply to all object types except for hard links */
 327         u32 yst_mode;           /* protection */
 328
 329         u32 yst_uid;
 330         u32 yst_gid;
 331         u32 yst_atime;
 332         u32 yst_mtime;
 333         u32 yst_ctime;
 334
 335         /* File size  applies to files only */
 336         u32 file_size_low;
 337
 338         /* Equivalent object id applies to hard links only. */
 339         int equiv_id;
 340
 341         /* Alias is for symlinks only. */
 342         YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
 343
 344         u32 yst_rdev;   /* stuff for block and char devices (major/min) */
 345
 346         u32 win_ctime[2];
 347         u32 win_atime[2];
 348         u32 win_mtime[2];
 349
 350         u32 inband_shadowed_obj_id;
 351         u32 inband_is_shrink;
 352
 353         u32 file_size_high;
 354         u32 reserved[1];
 355         int shadows_obj;        /* This object header shadows the
 356                                 specified object if > 0 */
 357
 358         /* is_shrink applies to object headers written when wemake a hole. */
 359         u32 is_shrink;
 360
 361 };
 362
 363 /*--------------------------- Tnode -------------------------- */
 364
 365 struct yaffs_tnode {
 366         struct yaffs_tnode *internal[YAFFS_NTNODES_INTERNAL];
 367 };
 368
 369 /*------------------------  Object -----------------------------*/
 370 /* An object can be one of:
 371  * - a directory (no data, has children links
 372  * - a regular file (data.... not prunes :->).
 373  * - a symlink [symbolic link] (the alias).
 374  * - a hard link
 375  */
 376
 377 struct yaffs_file_var {
 378         loff_t file_size;
 379         loff_t scanned_size;
 380         loff_t shrink_size;
 381         int top_level;
 382         struct yaffs_tnode *top;
 383 };
 384
 385 struct yaffs_dir_var {
 386         struct list_head children;      /* list of child links */
 387         struct list_head dirty; /* Entry for list of dirty directories */
 388 };
 389
 390 struct yaffs_symlink_var {
 391         YCHAR *alias;
 392 };
 393
 394 struct yaffs_hardlink_var {
 395         struct yaffs_obj *equiv_obj;
 396         u32 equiv_id;
 397 };
 398
 399 union yaffs_obj_var {
 400         struct yaffs_file_var file_variant;
 401         struct yaffs_dir_var dir_variant;
 402         struct yaffs_symlink_var symlink_variant;
 403         struct yaffs_hardlink_var hardlink_variant;
 404 };
 405
 406 struct yaffs_obj {
 407         u8 deleted:1;           /* This should only apply to unlinked files. */
 408         u8 soft_del:1;          /* it has also been soft deleted */
 409         u8 unlinked:1;          /* An unlinked file.*/
 410         u8 fake:1;              /* A fake object has no presence on NAND. */
 411         u8 rename_allowed:1;    /* Some objects cannot be renamed. */
 412         u8 unlink_allowed:1;
 413         u8 dirty:1;             /* the object needs to be written to flash */
 414         u8 valid:1;             /* When the file system is being loaded up, this
 415                                  * object might be created before the data
 416                                  * is available
 417                                  * ie. file data chunks encountered before
 418                                 * the header.
 419                                  */
 420         u8 lazy_loaded:1;       /* This object has been lazy loaded and
 421                                  * is missing some detail */
 422
 423         u8 defered_free:1;      /* Object is removed from NAND, but is
 424                                  * still in the inode cache.
 425                                  * Free of object is defered.
 426                                  * until the inode is released.
 427                                  */
 428         u8 being_created:1;     /* This object is still being created
 429                                  * so skip some verification checks. */
 430         u8 is_shadowed:1;       /* This object is shadowed on the way
 431                                  * to being renamed. */
 432
 433         u8 xattr_known:1;       /* We know if this has object has xattribs
 434                                  * or not. */
 435         u8 has_xattr:1;         /* This object has xattribs.
 436                                  * Only valid if xattr_known. */
 437
 438         u8 serial;              /* serial number of chunk in NAND.*/
 439         u16 sum;                /* sum of the name to speed searching */
 440
 441         struct yaffs_dev *my_dev;       /* The device I'm on */
 442
 443         struct list_head hash_link;     /* list of objects in hash bucket */
 444
 445         struct list_head hard_links;    /* hard linked object chain*/
 446
 447         /* directory structure stuff */
 448         /* also used for linking up the free list */
 449         struct yaffs_obj *parent;
 450         struct list_head siblings;
 451
 452         /* Where's my object header in NAND? */
 453         int hdr_chunk;
 454
 455         int n_data_chunks;      /* Number of data chunks for this file. */
 456
 457         u32 obj_id;             /* the object id value */
 458
 459         u32 yst_mode;
 460
 461         YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
 462
 463 #ifdef CONFIG_YAFFS_WINCE
 464         u32 win_ctime[2];
 465         u32 win_mtime[2];
 466         u32 win_atime[2];
 467 #else
 468         u32 yst_uid;
 469         u32 yst_gid;
 470         u32 yst_atime;
 471         u32 yst_mtime;
 472         u32 yst_ctime;
 473 #endif
 474
 475         u32 yst_rdev;
 476
 477         void *my_inode;
 478
 479         u32 variant_type; /* enum yaffs_object_type */
 480
 481         union yaffs_obj_var variant;
 482
 483 };
 484
 485 struct yaffs_obj_bucket {
 486         struct list_head list;
 487         int count;
 488 };
 489
 490 /* yaffs_checkpt_obj holds the definition of an object as dumped
 491  * by checkpointing.
 492  */
 493
 494 struct yaffs_checkpt_obj {
 495         int struct_type;
 496         u32 obj_id;
 497         u32 parent_id;
 498         int hdr_chunk;
 499         u32 variant_type:3; /* enum yaffs_obj_type */
 500         u8 deleted:1;
 501         u8 soft_del:1;
 502         u8 unlinked:1;
 503         u8 fake:1;
 504         u8 rename_allowed:1;
 505         u8 unlink_allowed:1;
 506         u8 serial;
 507         int n_data_chunks;
 508         loff_t size_or_equiv_obj;
 509 };
 510
 511 /*--------------------- Temporary buffers ----------------
 512  *
 513  * These are chunk-sized working buffers. Each device has a few.
 514  */
 515
 516 struct yaffs_buffer {
 517         u8 *buffer;
 518         int in_use;
 519 };
 520
 521 /*----------------- Device ---------------------------------*/
 522
 523 struct yaffs_param {
 524         const YCHAR *name;
 525
 526         /*
 527          * Entry parameters set up way early. Yaffs sets up the rest.
 528          * The structure should be zeroed out before use so that unused
 529          * and default values are zero.
 530          */
 531
 532         int inband_tags;        /* Use unband tags */
 533         u32 total_bytes_per_chunk;      /* Should be >= 512, does not need to
 534                                          be a power of 2 */
 535         int chunks_per_block;   /* does not need to be a power of 2 */
 536         int spare_bytes_per_chunk;      /* spare area size */
 537         int start_block;        /* Start block we're allowed to use */
 538         int end_block;          /* End block we're allowed to use */
 539         int n_reserved_blocks;  /* Tuneable so that we can reduce
 540                                  * reserved blocks on NOR and RAM. */
 541
 542         int n_caches;           /* If <= 0, then short op caching is disabled,
 543                                  * else the number of short op caches.
 544                                  */
 545         int cache_bypass_aligned; /* If non-zero then bypass the cache for
 546                                    * aligned writes.
 547                                    */
 548
 549         int use_nand_ecc;       /* Flag to decide whether or not to use
 550                                  * NAND driver ECC on data (yaffs1) */
 551         int tags_9bytes;        /* Use 9 byte tags */
 552         int no_tags_ecc;        /* Flag to decide whether or not to do ECC
 553                                  * on packed tags (yaffs2) */
 554
 555         int is_yaffs2;          /* Use yaffs2 mode on this device */
 556
 557         int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
 558
 559         int refresh_period;     /* How often to check for a block refresh */
 560
 561         /* Checkpoint control. Can be set before or after initialisation */
 562         u8 skip_checkpt_rd;
 563         u8 skip_checkpt_wr;
 564
 565         int enable_xattr;       /* Enable xattribs */
 566
 567         int max_objects;        /*
 568                                  * Set to limit the number of objects created.
 569                                  * 0 = no limit.
 570                                 */
 571
 572         /* The remove_obj_fn function must be supplied by OS flavours that
 573          * need it.
 574          * yaffs direct uses it to implement the faster readdir.
 575          * Linux uses it to protect the directory during unlocking.
 576          */
 577         void (*remove_obj_fn) (struct yaffs_obj *obj);
 578
 579         /* Callback to mark the superblock dirty */
 580         void (*sb_dirty_fn) (struct yaffs_dev *dev);
 581
 582         /*  Callback to control garbage collection. */
 583         unsigned (*gc_control_fn) (struct yaffs_dev *dev);
 584
 585         /* Debug control flags. Don't use unless you know what you're doing */
 586         int use_header_file_size;       /* Flag to determine if we should use
 587                                          * file sizes from the header */
 588         int disable_lazy_load;  /* Disable lazy loading on this device */
 589         int wide_tnodes_disabled;       /* Set to disable wide tnodes */
 590         int disable_soft_del;   /* yaffs 1 only: Set to disable the use of
 591                                  * softdeletion. */
 592
 593         int defered_dir_update; /* Set to defer directory updates */
 594
 595 #ifdef CONFIG_YAFFS_AUTO_UNICODE
 596         int auto_unicode;
 597 #endif
 598         int always_check_erased;        /* Force chunk erased check always on */
 599
 600         int disable_summary;
 601         int disable_bad_block_marking;
 602
 603 };
 604
 605 struct yaffs_driver {
 606         int (*drv_write_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 607                                    const u8 *data, int data_len,
 608                                    const u8 *oob, int oob_len);
 609         int (*drv_read_chunk_fn) (struct yaffs_dev *dev, int nand_chunk,
 610                                    u8 *data, int data_len,
 611                                    u8 *oob, int oob_len,
 612                                    enum yaffs_ecc_result *ecc_result);
 613         int (*drv_erase_fn) (struct yaffs_dev *dev, int block_no);
 614         int (*drv_mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 615         int (*drv_check_bad_fn) (struct yaffs_dev *dev, int block_no);
 616         int (*drv_initialise_fn) (struct yaffs_dev *dev);
 617         int (*drv_deinitialise_fn) (struct yaffs_dev *dev);
 618 };
 619
 620 struct yaffs_tags_handler {
 621         int (*write_chunk_tags_fn) (struct yaffs_dev *dev,
 622                                     int nand_chunk, const u8 *data,
 623                                     const struct yaffs_ext_tags *tags);
 624         int (*read_chunk_tags_fn) (struct yaffs_dev *dev,
 625                                    int nand_chunk, u8 *data,
 626                                    struct yaffs_ext_tags *tags);
 627
 628         int (*query_block_fn) (struct yaffs_dev *dev, int block_no,
 629                                enum yaffs_block_state *state,
 630                                u32 *seq_number);
 631         int (*mark_bad_fn) (struct yaffs_dev *dev, int block_no);
 632 };
 633
 634 struct yaffs_dev {
 635         struct yaffs_param param;
 636         struct yaffs_driver drv;
 637         struct yaffs_tags_handler tagger;
 638
 639         /* Context storage. Holds extra OS specific data for this device */
 640
 641         void *os_context;
 642         void *driver_context;
 643
 644         struct list_head dev_list;
 645
 646         int ll_init;
 647         /* Runtime parameters. Set up by YAFFS. */
 648         int data_bytes_per_chunk;
 649
 650         /* Non-wide tnode stuff */
 651         u16 chunk_grp_bits;     /* Number of bits that need to be resolved if
 652                                  * the tnodes are not wide enough.
 653                                  */
 654         u16 chunk_grp_size;     /* == 2^^chunk_grp_bits */
 655
 656         /* Stuff to support wide tnodes */
 657         u32 tnode_width;
 658         u32 tnode_mask;
 659         u32 tnode_size;
 660
 661         /* Stuff for figuring out file offset to chunk conversions */
 662         u32 chunk_shift;        /* Shift value */
 663         u32 chunk_div;          /* Divisor after shifting: 1 for 2^n sizes */
 664         u32 chunk_mask;         /* Mask to use for power-of-2 case */
 665
 666         int is_mounted;
 667         int read_only;
 668         int is_checkpointed;
 669
 670         /* Stuff to support block offsetting to support start block zero */
 671         int internal_start_block;
 672         int internal_end_block;
 673         int block_offset;
 674         int chunk_offset;
 675
 676         /* Runtime checkpointing stuff */
 677         int checkpt_page_seq;   /* running sequence number of checkpt pages */
 678         int checkpt_byte_count;
 679         int checkpt_byte_offs;
 680         u8 *checkpt_buffer;
 681         int checkpt_open_write;
 682         int blocks_in_checkpt;
 683         int checkpt_cur_chunk;
 684         int checkpt_cur_block;
 685         int checkpt_next_block;
 686         int *checkpt_block_list;
 687         int checkpt_max_blocks;
 688         u32 checkpt_sum;
 689         u32 checkpt_xor;
 690
 691         int checkpoint_blocks_required; /* Number of blocks needed to store
 692                                          * current checkpoint set */
 693
 694         /* Block Info */
 695         struct yaffs_block_info *block_info;
 696         u8 *chunk_bits;         /* bitmap of chunks in use */
 697         u8 block_info_alt:1;    /* allocated using alternative alloc */
 698         u8 chunk_bits_alt:1;    /* allocated using alternative alloc */
 699         int chunk_bit_stride;   /* Number of bytes of chunk_bits per block.
 700                                  * Must be consistent with chunks_per_block.
 701                                  */
 702
 703         int n_erased_blocks;
 704         int alloc_block;        /* Current block being allocated off */
 705         u32 alloc_page;
 706         int alloc_block_finder; /* Used to search for next allocation block */
 707
 708         /* Object and Tnode memory management */
 709         void *allocator;
 710         int n_obj;
 711         int n_tnodes;
 712
 713         int n_hardlinks;
 714
 715         struct yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
 716         u32 bucket_finder;
 717
 718         int n_free_chunks;
 719
 720         /* Garbage collection control */
 721         u32 *gc_cleanup_list;   /* objects to delete at the end of a GC. */
 722         u32 n_clean_ups;
 723
 724         unsigned has_pending_prioritised_gc;    /* We think this device might
 725                                                 have pending prioritised gcs */
 726         unsigned gc_disable;
 727         unsigned gc_block_finder;
 728         unsigned gc_dirtiest;
 729         unsigned gc_pages_in_use;
 730         unsigned gc_not_done;
 731         unsigned gc_block;
 732         unsigned gc_chunk;
 733         unsigned gc_skip;
 734         struct yaffs_summary_tags *gc_sum_tags;
 735
 736         /* Special directories */
 737         struct yaffs_obj *root_dir;
 738         struct yaffs_obj *lost_n_found;
 739
 740         int buffered_block;     /* Which block is buffered here? */
 741         int doing_buffered_block_rewrite;
 742
 743         struct yaffs_cache *cache;
 744         int cache_last_use;
 745
 746         /* Stuff for background deletion and unlinked files. */
 747         struct yaffs_obj *unlinked_dir; /* Directory where unlinked and deleted
 748                                          files live. */
 749         struct yaffs_obj *del_dir;      /* Directory where deleted objects are
 750                                         sent to disappear. */
 751         struct yaffs_obj *unlinked_deletion;    /* Current file being
 752                                                         background deleted. */
 753         int n_deleted_files;    /* Count of files awaiting deletion; */
 754         int n_unlinked_files;   /* Count of unlinked files. */
 755         int n_bg_deletions;     /* Count of background deletions. */
 756
 757         /* Temporary buffer management */
 758         struct yaffs_buffer temp_buffer[YAFFS_N_TEMP_BUFFERS];
 759         int max_temp;
 760         int temp_in_use;
 761         int unmanaged_buffer_allocs;
 762         int unmanaged_buffer_deallocs;
 763
 764         /* yaffs2 runtime stuff */
 765         unsigned seq_number;    /* Sequence number of currently
 766                                         allocating block */
 767         unsigned oldest_dirty_seq;
 768         unsigned oldest_dirty_block;
 769
 770         /* Block refreshing */
 771         int refresh_skip;       /* A skip down counter.
 772                                  * Refresh happens when this gets to zero. */
 773
 774         /* Dirty directory handling */
 775         struct list_head dirty_dirs;    /* List of dirty directories */
 776
 777         /* Summary */
 778         int chunks_per_summary;
 779         struct yaffs_summary_tags *sum_tags;
 780
 781         /* Statistics */
 782         u32 n_page_writes;
 783         u32 n_page_reads;
 784         u32 n_erasures;
 785         u32 n_bad_queries;
 786         u32 n_bad_markings;
 787         u32 n_erase_failures;
 788         u32 n_gc_copies;
 789         u32 all_gcs;
 790         u32 passive_gc_count;
 791         u32 oldest_dirty_gc_count;
 792         u32 n_gc_blocks;
 793         u32 bg_gcs;
 794         u32 n_retried_writes;
 795         u32 n_retired_blocks;
 796         u32 n_ecc_fixed;
 797         u32 n_ecc_unfixed;
 798         u32 n_tags_ecc_fixed;
 799         u32 n_tags_ecc_unfixed;
 800         u32 n_deletions;
 801         u32 n_unmarked_deletions;
 802         u32 refresh_count;
 803         u32 cache_hits;
 804         u32 tags_used;
 805         u32 summary_used;
 806
 807 };
 808
 809 /* The CheckpointDevice structure holds the device information that changes
 810  *at runtime and must be preserved over unmount/mount cycles.
 811  */
 812 struct yaffs_checkpt_dev {
 813         int struct_type;
 814         int n_erased_blocks;
 815         int alloc_block;        /* Current block being allocated off */
 816         u32 alloc_page;
 817         int n_free_chunks;
 818
 819         int n_deleted_files;    /* Count of files awaiting deletion; */
 820         int n_unlinked_files;   /* Count of unlinked files. */
 821         int n_bg_deletions;     /* Count of background deletions. */
 822
 823         /* yaffs2 runtime stuff */
 824         unsigned seq_number;    /* Sequence number of currently
 825                                  * allocating block */
 826
 827 };
 828
 829 struct yaffs_checkpt_validity {
 830         int struct_type;
 831         u32 magic;
 832         u32 version;
 833         u32 head;
 834 };
 835
 836 struct yaffs_shadow_fixer {
 837         int obj_id;
 838         int shadowed_id;
 839         struct yaffs_shadow_fixer *next;
 840 };
 841
 842 /* Structure for doing xattr modifications */
 843 struct yaffs_xattr_mod {
 844         int set;                /* If 0 then this is a deletion */
 845         const YCHAR *name;
 846         const void *data;
 847         int size;
 848         int flags;
 849         int result;
 850 };
 851
 852 /*----------------------- YAFFS Functions -----------------------*/
 853
 854 int yaffs_guts_initialise(struct yaffs_dev *dev);
 855 void yaffs_deinitialise(struct yaffs_dev *dev);
 856
 857 int yaffs_get_n_free_chunks(struct yaffs_dev *dev);
 858
 859 int yaffs_rename_obj(struct yaffs_obj *old_dir, const YCHAR * old_name,
 860                      struct yaffs_obj *new_dir, const YCHAR * new_name);
 861
 862 int yaffs_unlinker(struct yaffs_obj *dir, const YCHAR * name);
 863 int yaffs_del_obj(struct yaffs_obj *obj);
 864 struct yaffs_obj *yaffs_retype_obj(struct yaffs_obj *obj,
 865                                    enum yaffs_obj_type type);
 866
 867
 868 int yaffs_get_obj_name(struct yaffs_obj *obj, YCHAR * name, int buffer_size);
 869 loff_t yaffs_get_obj_length(struct yaffs_obj *obj);
 870 int yaffs_get_obj_inode(struct yaffs_obj *obj);
 871 unsigned yaffs_get_obj_type(struct yaffs_obj *obj);
 872 int yaffs_get_obj_link_count(struct yaffs_obj *obj);
 873
 874 /* File operations */
 875 int yaffs_file_rd(struct yaffs_obj *obj, u8 * buffer, loff_t offset,
 876                   int n_bytes);
 877 int yaffs_wr_file(struct yaffs_obj *obj, const u8 * buffer, loff_t offset,
 878                   int n_bytes, int write_trhrough);
 879 int yaffs_resize_file(struct yaffs_obj *obj, loff_t new_size);
 880
 881 struct yaffs_obj *yaffs_create_file(struct yaffs_obj *parent,
 882                                     const YCHAR *name, u32 mode, u32 uid,
 883                                     u32 gid);
 884
 885 int yaffs_flush_file(struct yaffs_obj *in,
 886                      int update_time,
 887                      int data_sync,
 888                      int discard_cache);
 889
 890 /* Flushing and checkpointing */
 891 void yaffs_flush_whole_cache(struct yaffs_dev *dev, int discard);
 892
 893 int yaffs_checkpoint_save(struct yaffs_dev *dev);
 894 int yaffs_checkpoint_restore(struct yaffs_dev *dev);
 895
 896 /* Directory operations */
 897 struct yaffs_obj *yaffs_create_dir(struct yaffs_obj *parent, const YCHAR *name,
 898                                    u32 mode, u32 uid, u32 gid);
 899 struct yaffs_obj *yaffs_find_by_name(struct yaffs_obj *the_dir,
 900                                      const YCHAR *name);
 901 struct yaffs_obj *yaffs_find_by_number(struct yaffs_dev *dev, u32 number);
 902
 903 /* Link operations */
 904 struct yaffs_obj *yaffs_link_obj(struct yaffs_obj *parent, const YCHAR *name,
 905                                  struct yaffs_obj *equiv_obj);
 906
 907 struct yaffs_obj *yaffs_get_equivalent_obj(struct yaffs_obj *obj);
 908
 909 /* Symlink operations */
 910 struct yaffs_obj *yaffs_create_symlink(struct yaffs_obj *parent,
 911                                        const YCHAR *name, u32 mode, u32 uid,
 912                                        u32 gid, const YCHAR *alias);
 913 YCHAR *yaffs_get_symlink_alias(struct yaffs_obj *obj);
 914
 915 /* Special inodes (fifos, sockets and devices) */
 916 struct yaffs_obj *yaffs_create_special(struct yaffs_obj *parent,
 917                                        const YCHAR *name, u32 mode, u32 uid,
 918                                        u32 gid, u32 rdev);
 919
 920 int yaffs_set_xattrib(struct yaffs_obj *obj, const YCHAR *name,
 921                       const void *value, int size, int flags);
 922 int yaffs_get_xattrib(struct yaffs_obj *obj, const YCHAR *name, void *value,
 923                       int size);
 924 int yaffs_list_xattrib(struct yaffs_obj *obj, char *buffer, int size);
 925 int yaffs_remove_xattrib(struct yaffs_obj *obj, const YCHAR *name);
 926
 927 /* Special directories */
 928 struct yaffs_obj *yaffs_root(struct yaffs_dev *dev);
 929 struct yaffs_obj *yaffs_lost_n_found(struct yaffs_dev *dev);
 930
 931 void yaffs_handle_defered_free(struct yaffs_obj *obj);
 932
 933 void yaffs_update_dirty_dirs(struct yaffs_dev *dev);
 934
 935 int yaffs_bg_gc(struct yaffs_dev *dev, unsigned urgency);
 936
 937 /* Debug dump  */
 938 int yaffs_dump_obj(struct yaffs_obj *obj);
 939
 940 void yaffs_guts_test(struct yaffs_dev *dev);
 941 int yaffs_guts_ll_init(struct yaffs_dev *dev);
 942
 943
 944 /* A few useful functions to be used within the core files*/
 945 void yaffs_chunk_del(struct yaffs_dev *dev, int chunk_id, int mark_flash,
 946                      int lyn);
 947 int yaffs_check_ff(u8 *buffer, int n_bytes);
 948 void yaffs_handle_chunk_error(struct yaffs_dev *dev,
 949                               struct yaffs_block_info *bi);
 950
 951 u8 *yaffs_get_temp_buffer(struct yaffs_dev *dev);
 952 void yaffs_release_temp_buffer(struct yaffs_dev *dev, u8 *buffer);
 953
 954 struct yaffs_obj *yaffs_find_or_create_by_number(struct yaffs_dev *dev,
 955                                                  int number,
 956                                                  enum yaffs_obj_type type);
 957 int yaffs_put_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
 958                             int nand_chunk, int in_scan);
 959 void yaffs_set_obj_name(struct yaffs_obj *obj, const YCHAR *name);
 960 void yaffs_set_obj_name_from_oh(struct yaffs_obj *obj,
 961                                 const struct yaffs_obj_hdr *oh);
 962 void yaffs_add_obj_to_dir(struct yaffs_obj *directory, struct yaffs_obj *obj);
 963 YCHAR *yaffs_clone_str(const YCHAR *str);
 964 void yaffs_link_fixup(struct yaffs_dev *dev, struct list_head *hard_list);
 965 void yaffs_block_became_dirty(struct yaffs_dev *dev, int block_no);
 966 int yaffs_update_oh(struct yaffs_obj *in, const YCHAR *name,
 967                     int force, int is_shrink, int shadows,
 968                     struct yaffs_xattr_mod *xop);
 969 void yaffs_handle_shadowed_obj(struct yaffs_dev *dev, int obj_id,
 970                                int backward_scanning);
 971 int yaffs_check_alloc_available(struct yaffs_dev *dev, int n_chunks);
 972 struct yaffs_tnode *yaffs_get_tnode(struct yaffs_dev *dev);
 973 struct yaffs_tnode *yaffs_add_find_tnode_0(struct yaffs_dev *dev,
 974                                            struct yaffs_file_var *file_struct,
 975                                            u32 chunk_id,
 976                                            struct yaffs_tnode *passed_tn);
 977
 978 int yaffs_do_file_wr(struct yaffs_obj *in, const u8 *buffer, loff_t offset,
 979                      int n_bytes, int write_trhrough);
 980 void yaffs_resize_file_down(struct yaffs_obj *obj, loff_t new_size);
 981 void yaffs_skip_rest_of_block(struct yaffs_dev *dev);
 982
 983 int yaffs_count_free_chunks(struct yaffs_dev *dev);
 984
 985 struct yaffs_tnode *yaffs_find_tnode_0(struct yaffs_dev *dev,
 986                                        struct yaffs_file_var *file_struct,
 987                                        u32 chunk_id);
 988
 989 u32 yaffs_get_group_base(struct yaffs_dev *dev, struct yaffs_tnode *tn,
 990                          unsigned pos);
 991
 992 int yaffs_is_non_empty_dir(struct yaffs_obj *obj);
 993
 994 int yaffs_guts_format_dev(struct yaffs_dev *dev);
 995
 996 void yaffs_addr_to_chunk(struct yaffs_dev *dev, loff_t addr,
 997                                 int *chunk_out, u32 *offset_out);
 998 /*
 999  * Marshalling functions to get loff_t file sizes into aand out of
1000  * object headers.
1001  */
1002 void yaffs_oh_size_load(struct yaffs_obj_hdr *oh, loff_t fsize);
1003 loff_t yaffs_oh_to_size(struct yaffs_obj_hdr *oh);
1004 loff_t yaffs_max_file_size(struct yaffs_dev *dev);
1005
1006 /*
1007  * Debug function to count number of blocks in each state
1008  * NB Needs to be called with correct number of integers
1009  */
1010
1011 void yaffs_count_blocks_by_state(struct yaffs_dev *dev, int bs[10]);
1012
1013 int yaffs_find_chunk_in_file(struct yaffs_obj *in, int inode_chunk,
1014                                     struct yaffs_ext_tags *tags);
1015
1016 #endif