/*
* YAFFS: Yet another Flash File System . A NAND-flash specific file system.
*
- * Copyright (C) 2002-2007 Aleph One Ltd.
+ * Copyright (C) 2002-2010 Aleph One Ltd.
* for Toby Churchill Ltd and Brightstar Engineering
*
* Created by Charles Manning <charles@aleph1.co.uk>
#ifndef __YAFFS_GUTS_H__
#define __YAFFS_GUTS_H__
-#include "devextras.h"
#include "yportenv.h"
+#include "devextras.h"
+#include "yaffs_list.h"
#define YAFFS_OK 1
#define YAFFS_FAIL 0
#define YAFFS_MAX_CHUNK_ID 0x000FFFFF
-#define YAFFS_UNUSED_OBJECT_ID 0x0003FFFF
#define YAFFS_ALLOCATION_NOBJECTS 100
#define YAFFS_ALLOCATION_NTNODES 100
#define YAFFS_OBJECT_SPACE 0x40000
+#define YAFFS_MAX_OBJECT_ID (YAFFS_OBJECT_SPACE -1)
#define YAFFS_CHECKPOINT_VERSION 4
/* ChunkCache is used for short read/write operations.*/
typedef struct {
- struct yaffs_ObjectStruct *object;
- int chunkId;
- int lastUse;
+ struct yaffs_obj_s *object;
+ int chunk_id;
+ int last_use;
int dirty;
- int nBytes; /* Only valid if the cache is dirty */
+ int n_bytes; /* Only valid if the cache is dirty */
int locked; /* Can't push out or flush while locked. */
__u8 *data;
-} yaffs_ChunkCache;
+} yaffs_cache_t;
#ifndef CONFIG_YAFFS_NO_YAFFS1
typedef struct {
- unsigned chunkId:20;
- unsigned serialNumber:2;
- unsigned byteCountLSB:10;
- unsigned objectId:18;
+ unsigned chunk_id:20;
+ unsigned serial_number:2;
+ unsigned n_bytes_lsb:10;
+ unsigned obj_id:18;
unsigned ecc:12;
- unsigned byteCountMSB:2;
-} yaffs_Tags;
+ unsigned n_bytes_msb:2;
+} yaffs_tags_t;
typedef union {
- yaffs_Tags asTags;
- __u8 asBytes[8];
-} yaffs_TagsUnion;
+ yaffs_tags_t as_tags;
+ __u8 as_bytes[8];
+} yaffs_tags_union_t;
#endif
YAFFS_ECC_RESULT_NO_ERROR,
YAFFS_ECC_RESULT_FIXED,
YAFFS_ECC_RESULT_UNFIXED
-} yaffs_ECCResult;
+} yaffs_ecc_result;
typedef enum {
YAFFS_OBJECT_TYPE_UNKNOWN,
YAFFS_OBJECT_TYPE_DIRECTORY,
YAFFS_OBJECT_TYPE_HARDLINK,
YAFFS_OBJECT_TYPE_SPECIAL
-} yaffs_ObjectType;
+} yaffs_obj_type;
#define YAFFS_OBJECT_TYPE_MAX YAFFS_OBJECT_TYPE_SPECIAL
typedef struct {
- unsigned validMarker0;
- unsigned chunkUsed; /* Status of the chunk: used or unused */
- unsigned objectId; /* If 0 then this is not part of an object (unused) */
- unsigned chunkId; /* If 0 then this is a header, else a data chunk */
- unsigned byteCount; /* Only valid for data chunks */
+ unsigned validity1;
+ unsigned chunk_used; /* Status of the chunk: used or unused */
+ unsigned obj_id; /* If 0 then this is not part of an object (unused) */
+ unsigned chunk_id; /* If 0 then this is a header, else a data chunk */
+ unsigned n_bytes; /* Only valid for data chunks */
/* The following stuff only has meaning when we read */
- yaffs_ECCResult eccResult;
- unsigned blockBad;
+ yaffs_ecc_result ecc_result;
+ unsigned block_bad;
/* YAFFS 1 stuff */
- unsigned chunkDeleted; /* The chunk is marked deleted */
- unsigned serialNumber; /* Yaffs1 2-bit serial number */
+ unsigned is_deleted; /* The chunk is marked deleted */
+ unsigned serial_number; /* Yaffs1 2-bit serial number */
/* YAFFS2 stuff */
- unsigned sequenceNumber; /* The sequence number of this block */
+ unsigned seq_number; /* The sequence number of this block */
/* Extra info if this is an object header (YAFFS2 only) */
- unsigned extraHeaderInfoAvailable; /* There is extra info available if this is not zero */
- unsigned extraParentObjectId; /* The parent object */
- unsigned extraIsShrinkHeader; /* Is it a shrink header? */
- unsigned extraShadows; /* Does this shadow another object? */
+ unsigned extra_available; /* There is extra info available if this is not zero */
+ unsigned extra_parent_id; /* The parent object */
+ unsigned extra_is_shrink; /* Is it a shrink header? */
+ unsigned extra_shadows; /* Does this shadow another object? */
- yaffs_ObjectType extraObjectType; /* What object type? */
+ yaffs_obj_type extra_obj_type; /* What object type? */
- unsigned extraFileLength; /* Length if it is a file */
- unsigned extraEquivalentObjectId; /* Equivalent object Id if it is a hard link */
+ unsigned extra_length; /* Length if it is a file */
+ unsigned extra_equiv_id; /* Equivalent object Id if it is a hard link */
- unsigned validMarker1;
+ unsigned validty1;
-} yaffs_ExtendedTags;
+} yaffs_ext_tags;
/* Spare structure for YAFFS1 */
typedef struct {
- __u8 tagByte0;
- __u8 tagByte1;
- __u8 tagByte2;
- __u8 tagByte3;
- __u8 pageStatus; /* set to 0 to delete the chunk */
- __u8 blockStatus;
- __u8 tagByte4;
- __u8 tagByte5;
+ __u8 tb0;
+ __u8 tb1;
+ __u8 tb2;
+ __u8 tb3;
+ __u8 page_status; /* set to 0 to delete the chunk */
+ __u8 block_status;
+ __u8 tb4;
+ __u8 tb5;
__u8 ecc1[3];
- __u8 tagByte6;
- __u8 tagByte7;
+ __u8 tb6;
+ __u8 tb7;
__u8 ecc2[3];
-} yaffs_Spare;
+} yaffs_spare;
/*Special structure for passing through to mtd */
-struct yaffs_NANDSpare {
- yaffs_Spare spare;
+struct yaffs_nand_spare {
+ yaffs_spare spare;
int eccres1;
int eccres2;
};
YAFFS_BLOCK_STATE_DEAD
/* This block has failed and is not in use */
-} yaffs_BlockState;
+} yaffs_block_state_t;
#define YAFFS_NUMBER_OF_BLOCK_STATES (YAFFS_BLOCK_STATE_DEAD + 1)
typedef struct {
- int softDeletions:10; /* number of soft deleted pages */
- int pagesInUse:10; /* number of pages in use */
- unsigned blockState:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
- __u32 needsRetiring:1; /* Data has failed on this block, need to get valid data off */
+ int soft_del_pages:10; /* number of soft deleted pages */
+ int pages_in_use:10; /* number of pages in use */
+ unsigned block_state:4; /* One of the above block states. NB use unsigned because enum is sometimes an int */
+ __u32 needs_retiring:1; /* Data has failed on this block, need to get valid data off */
/* and retire the block. */
- __u32 skipErasedCheck:1; /* If this is set we can skip the erased check on this block */
- __u32 gcPrioritise:1; /* An ECC check or blank check has failed on this block.
+ __u32 skip_erased_check:1; /* If this is set we can skip the erased check on this block */
+ __u32 gc_prioritise:1; /* An ECC check or blank check has failed on this block.
It should be prioritised for GC */
- __u32 chunkErrorStrikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
+ __u32 chunk_error_strikes:3; /* How many times we've had ecc etc failures on this block and tried to reuse it */
#ifdef CONFIG_YAFFS_YAFFS2
- __u32 hasShrinkHeader:1; /* This block has at least one shrink object header */
- __u32 sequenceNumber; /* block sequence number for yaffs2 */
+ __u32 has_shrink_hdr:1; /* This block has at least one shrink object header */
+ __u32 seq_number; /* block sequence number for yaffs2 */
#endif
-} yaffs_BlockInfo;
+} yaffs_block_info_t;
/* -------------------------- Object structure -------------------------------*/
/* This is the object structure as stored on NAND */
typedef struct {
- yaffs_ObjectType type;
+ yaffs_obj_type type;
/* Apply to everything */
- int parentObjectId;
- __u16 sum__NoLongerUsed; /* checksum of name. No longer used */
+ int parent_obj_id;
+ __u16 sum_no_longer_used; /* checksum of name. No longer used */
YCHAR name[YAFFS_MAX_NAME_LENGTH + 1];
/* The following apply to directories, files, symlinks - not hard links */
__u32 yst_mode; /* protection */
#ifdef CONFIG_YAFFS_WINCE
- __u32 notForWinCE[5];
+ __u32 not_for_wince[5];
#else
__u32 yst_uid;
__u32 yst_gid;
#endif
/* File size applies to files only */
- int fileSize;
+ int file_size;
/* Equivalent object id applies to hard links only. */
- int equivalentObjectId;
+ int equiv_id;
/* Alias is for symlinks only. */
YCHAR alias[YAFFS_MAX_ALIAS_LENGTH + 1];
__u32 win_atime[2];
__u32 win_mtime[2];
#else
- __u32 roomToGrow[6];
+ __u32 room_to_grow[6];
#endif
- __u32 inbandShadowsObject;
- __u32 inbandIsShrink;
+ __u32 inband_shadowed_obj_id;
+ __u32 inband_is_shrink;
- __u32 reservedSpace[2];
- int shadowsObject; /* This object header shadows the specified object if > 0 */
+ __u32 reserved[2];
+ int shadows_obj; /* This object header shadows the specified object if > 0 */
- /* isShrink applies to object headers written when we shrink the file (ie resize) */
- __u32 isShrink;
+ /* is_shrink applies to object headers written when we shrink the file (ie resize) */
+ __u32 is_shrink;
-} yaffs_ObjectHeader;
+} yaffs_obj_header;
/*--------------------------- Tnode -------------------------- */
-union yaffs_Tnode_union {
-#ifdef CONFIG_YAFFS_TNODE_LIST_DEBUG
- union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL + 1];
-#else
- union yaffs_Tnode_union *internal[YAFFS_NTNODES_INTERNAL];
-#endif
-/* __u16 level0[YAFFS_NTNODES_LEVEL0]; */
+union yaffs_tnode_union {
+ union yaffs_tnode_union *internal[YAFFS_NTNODES_INTERNAL];
};
-typedef union yaffs_Tnode_union yaffs_Tnode;
+typedef union yaffs_tnode_union yaffs_tnode_t;
-struct yaffs_TnodeList_struct {
- struct yaffs_TnodeList_struct *next;
- yaffs_Tnode *tnodes;
-};
-
-typedef struct yaffs_TnodeList_struct yaffs_TnodeList;
/*------------------------ Object -----------------------------*/
/* An object can be one of:
*/
typedef struct {
- __u32 fileSize;
- __u32 scannedFileSize;
- __u32 shrinkSize;
- int topLevel;
- yaffs_Tnode *top;
-} yaffs_FileStructure;
+ __u32 file_size;
+ __u32 scanned_size;
+ __u32 shrink_size;
+ int top_level;
+ yaffs_tnode_t *top;
+} yaffs_file_s;
typedef struct {
struct ylist_head children; /* list of child links */
struct ylist_head dirty; /* Entry for list of dirty directories */
-} yaffs_DirectoryStructure;
+} yaffs_dir_s;
typedef struct {
YCHAR *alias;
-} yaffs_SymLinkStructure;
+} yaffs_symlink_t;
typedef struct {
- struct yaffs_ObjectStruct *equivalentObject;
- __u32 equivalentObjectId;
-} yaffs_HardLinkStructure;
+ struct yaffs_obj_s *equiv_obj;
+ __u32 equiv_id;
+} yaffs_hard_link_s;
typedef union {
- yaffs_FileStructure fileVariant;
- yaffs_DirectoryStructure directoryVariant;
- yaffs_SymLinkStructure symLinkVariant;
- yaffs_HardLinkStructure hardLinkVariant;
-} yaffs_ObjectVariant;
+ yaffs_file_s file_variant;
+ yaffs_dir_s dir_variant;
+ yaffs_symlink_t symlink_variant;
+ yaffs_hard_link_s hardlink_variant;
+} yaffs_obj_variant;
-struct yaffs_ObjectStruct {
+struct yaffs_obj_s {
__u8 deleted:1; /* This should only apply to unlinked files. */
- __u8 softDeleted:1; /* it has also been soft deleted */
+ __u8 soft_del:1; /* it has also been soft deleted */
__u8 unlinked:1; /* An unlinked file. The file should be in the unlinked directory.*/
__u8 fake:1; /* A fake object has no presence on NAND. */
- __u8 renameAllowed:1; /* Some objects are not allowed to be renamed. */
- __u8 unlinkAllowed:1;
+ __u8 rename_allowed:1; /* Some objects are not allowed to be renamed. */
+ __u8 unlink_allowed:1;
__u8 dirty:1; /* the object needs to be written to flash */
__u8 valid:1; /* When the file system is being loaded up, this
* object might be created before the data
* is available (ie. file data records appear before the header).
*/
- __u8 lazyLoaded:1; /* This object has been lazy loaded and is missing some detail */
+ __u8 lazy_loaded:1; /* This object has been lazy loaded and is missing some detail */
- __u8 deferedFree:1; /* For Linux kernel. Object is removed from NAND, but is
+ __u8 defered_free:1; /* For Linux kernel. Object is removed from NAND, but is
* still in the inode cache. Free of object is defered.
* until the inode is released.
*/
- __u8 beingCreated:1; /* This object is still being created so skip some checks. */
- __u8 isShadowed:1; /* This object is shadowed on the way to being renamed. */
+ __u8 being_created:1; /* This object is still being created so skip some checks. */
+ __u8 is_shadowed:1; /* This object is shadowed on the way to being renamed. */
+
+ __u8 xattr_known:1; /* We know if this has object has xattribs or not. */
+ __u8 has_xattr:1; /* This object has xattribs. Valid if xattr_known. */
__u8 serial; /* serial number of chunk in NAND. Cached here */
__u16 sum; /* sum of the name to speed searching */
- struct yaffs_DeviceStruct *myDev; /* The device I'm on */
+ struct yaffs_dev_s *my_dev; /* The device I'm on */
- struct ylist_head hashLink; /* list of objects in this hash bucket */
+ struct ylist_head hash_link; /* list of objects in this hash bucket */
- struct ylist_head hardLinks; /* all the equivalent hard linked objects */
+ struct ylist_head hard_links; /* all the equivalent hard linked objects */
/* directory structure stuff */
/* also used for linking up the free list */
- struct yaffs_ObjectStruct *parent;
+ struct yaffs_obj_s *parent;
struct ylist_head siblings;
/* Where's my object header in NAND? */
- int hdrChunk;
+ int hdr_chunk;
- int nDataChunks; /* Number of data chunks attached to the file. */
+ int n_data_chunks; /* Number of data chunks attached to the file. */
- __u32 objectId; /* the object id value */
+ __u32 obj_id; /* the object id value */
__u32 yst_mode;
#ifdef CONFIG_YAFFS_SHORT_NAMES_IN_RAM
- YCHAR shortName[YAFFS_SHORT_NAME_LENGTH + 1];
+ YCHAR short_name[YAFFS_SHORT_NAME_LENGTH + 1];
#endif
#ifdef CONFIG_YAFFS_WINCE
__u32 yst_rdev;
- void *myInode;
-
- yaffs_ObjectType variantType;
+ void *my_inode;
- yaffs_ObjectVariant variant;
+ yaffs_obj_type variant_type;
-};
-
-typedef struct yaffs_ObjectStruct yaffs_Object;
+ yaffs_obj_variant variant;
-struct yaffs_ObjectList_struct {
- yaffs_Object *objects;
- struct yaffs_ObjectList_struct *next;
};
-typedef struct yaffs_ObjectList_struct yaffs_ObjectList;
+typedef struct yaffs_obj_s yaffs_obj_t;
typedef struct {
struct ylist_head list;
int count;
-} yaffs_ObjectBucket;
+} yaffs_obj_bucket;
-/* yaffs_CheckpointObject holds the definition of an object as dumped
+/* yaffs_checkpt_obj_t holds the definition of an object as dumped
* by checkpointing.
*/
typedef struct {
- int structType;
- __u32 objectId;
- __u32 parentId;
- int hdrChunk;
- yaffs_ObjectType variantType:3;
+ int struct_type;
+ __u32 obj_id;
+ __u32 parent_id;
+ int hdr_chunk;
+ yaffs_obj_type variant_type:3;
__u8 deleted:1;
- __u8 softDeleted:1;
+ __u8 soft_del:1;
__u8 unlinked:1;
__u8 fake:1;
- __u8 renameAllowed:1;
- __u8 unlinkAllowed:1;
+ __u8 rename_allowed:1;
+ __u8 unlink_allowed:1;
__u8 serial;
- int nDataChunks;
- __u32 fileSizeOrEquivalentObjectId;
-} yaffs_CheckpointObject;
+ int n_data_chunks;
+ __u32 size_or_equiv_obj;
+} yaffs_checkpt_obj_t;
/*--------------------- Temporary buffers ----------------
*
typedef struct {
__u8 *buffer;
int line; /* track from whence this buffer was allocated */
- int maxLine;
-} yaffs_TempBuffer;
+ int max_line;
+} yaffs_buffer_t;
/*----------------- Device ---------------------------------*/
-struct yaffs_DeviceParamStruct {
- const char *name;
+struct yaffs_param_s {
+ const YCHAR *name;
/*
* Entry parameters set up way early. Yaffs sets up the rest.
* and defualt values are zero.
*/
- int inbandTags; /* Use unband tags */
- __u32 totalBytesPerChunk; /* Should be >= 512, does not need to be a power of 2 */
- int nChunksPerBlock; /* does not need to be a power of 2 */
- int spareBytesPerChunk; /* spare area size */
- int startBlock; /* Start block we're allowed to use */
- int endBlock; /* End block we're allowed to use */
- int nReservedBlocks; /* We want this tuneable so that we can reduce */
+ int inband_tags; /* Use unband tags */
+ __u32 total_bytes_per_chunk; /* Should be >= 512, does not need to be a power of 2 */
+ int chunks_per_block; /* does not need to be a power of 2 */
+ int spare_bytes_per_chunk; /* spare area size */
+ int start_block; /* Start block we're allowed to use */
+ int end_block; /* End block we're allowed to use */
+ int n_reserved_blocks; /* We want this tuneable so that we can reduce */
/* reserved blocks on NOR and RAM. */
- int nShortOpCaches; /* If <= 0, then short op caching is disabled, else
+ int n_caches; /* If <= 0, then short op caching is disabled, else
* the number of short op caches (don't use too many).
* 10 to 20 is a good bet.
*/
- int useNANDECC; /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
- int noTagsECC; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
+ int use_nand_ecc; /* Flag to decide whether or not to use NANDECC on data (yaffs1) */
+ int no_tags_ecc; /* Flag to decide whether or not to do ECC on packed tags (yaffs2) */
- int isYaffs2; /* Use yaffs2 mode on this device */
+ int is_yaffs2; /* Use yaffs2 mode on this device */
- int emptyLostAndFound; /* Auto-empty lost+found directory on mount */
+ int empty_lost_n_found; /* Auto-empty lost+found directory on mount */
- int refreshPeriod; /* How often we should check to do a block refresh */
+ int refresh_period; /* How often we should check to do a block refresh */
/* Checkpoint control. Can be set before or after initialisation */
- __u8 skipCheckpointRead;
- __u8 skipCheckpointWrite;
+ __u8 skip_checkpt_rd;
+ __u8 skip_checkpt_wr;
+
+ int enable_xattr; /* Enable xattribs */
/* NAND access functions (Must be set before calling YAFFS)*/
- int (*writeChunkToNAND) (struct yaffs_DeviceStruct *dev,
- int chunkInNAND, const __u8 *data,
- const yaffs_Spare *spare);
- int (*readChunkFromNAND) (struct yaffs_DeviceStruct *dev,
- int chunkInNAND, __u8 *data,
- yaffs_Spare *spare);
- int (*eraseBlockInNAND) (struct yaffs_DeviceStruct *dev,
- int blockInNAND);
- int (*initialiseNAND) (struct yaffs_DeviceStruct *dev);
- int (*deinitialiseNAND) (struct yaffs_DeviceStruct *dev);
+ int (*write_chunk_fn) (struct yaffs_dev_s *dev,
+ int nand_chunk, const __u8 *data,
+ const yaffs_spare *spare);
+ int (*read_chunk_fn) (struct yaffs_dev_s *dev,
+ int nand_chunk, __u8 *data,
+ yaffs_spare *spare);
+ int (*erase_fn) (struct yaffs_dev_s *dev,
+ int flash_block);
+ int (*initialise_flash_fn) (struct yaffs_dev_s *dev);
+ int (*deinitialise_flash_fn) (struct yaffs_dev_s *dev);
#ifdef CONFIG_YAFFS_YAFFS2
- int (*writeChunkWithTagsToNAND) (struct yaffs_DeviceStruct *dev,
- int chunkInNAND, const __u8 *data,
- const yaffs_ExtendedTags *tags);
- int (*readChunkWithTagsFromNAND) (struct yaffs_DeviceStruct *dev,
- int chunkInNAND, __u8 *data,
- yaffs_ExtendedTags *tags);
- int (*markNANDBlockBad) (struct yaffs_DeviceStruct *dev, int blockNo);
- int (*queryNANDBlock) (struct yaffs_DeviceStruct *dev, int blockNo,
- yaffs_BlockState *state, __u32 *sequenceNumber);
+ int (*write_chunk_tags_fn) (struct yaffs_dev_s *dev,
+ int nand_chunk, const __u8 *data,
+ const yaffs_ext_tags *tags);
+ int (*read_chunk_tags_fn) (struct yaffs_dev_s *dev,
+ int nand_chunk, __u8 *data,
+ yaffs_ext_tags *tags);
+ int (*bad_block_fn) (struct yaffs_dev_s *dev, int block_no);
+ int (*query_block_fn) (struct yaffs_dev_s *dev, int block_no,
+ yaffs_block_state_t *state, __u32 *seq_number);
#endif
- /* The removeObjectCallback function must be supplied by OS flavours that
+ /* The remove_obj_fn function must be supplied by OS flavours that
* need it.
* yaffs direct uses it to implement the faster readdir.
* Linux uses it to protect the directory during unlocking.
*/
- void (*removeObjectCallback)(struct yaffs_ObjectStruct *obj);
+ void (*remove_obj_fn)(struct yaffs_obj_s *obj);
/* Callback to mark the superblock dirty */
- void (*markSuperBlockDirty)(struct yaffs_DeviceStruct *dev);
+ void (*sb_dirty_fn)(struct yaffs_dev_s *dev);
/* Callback to control garbage collection. */
- unsigned (*gcControl)(struct yaffs_DeviceStruct *dev);
+ unsigned (*gc_control)(struct yaffs_dev_s *dev);
/* Debug control flags. Don't use unless you know what you're doing */
- int useHeaderFileSize; /* Flag to determine if we should use file sizes from the header */
- int disableLazyLoad; /* Disable lazy loading on this device */
- int wideTnodesDisabled; /* Set to disable wide tnodes */
-
- int deferDirectoryUpdate; /* Set to defer directory updates */
+ int use_header_file_size; /* Flag to determine if we should use file sizes from the header */
+ int disable_lazy_load; /* Disable lazy loading on this device */
+ int wide_tnodes_disabled; /* Set to disable wide tnodes */
+ int disable_soft_del; /* yaffs 1 only: Set to disable the use of softdeletion. */
+ int defered_dir_update; /* Set to defer directory updates */
+
+#ifdef CONFIG_YAFFS_AUTO_UNICODE
+ int auto_unicode;
+#endif
+ int always_check_erased; /* Force chunk erased check always on */
};
-typedef struct yaffs_DeviceParamStruct yaffs_DeviceParam;
+typedef struct yaffs_param_s yaffs_param_t;
-struct yaffs_DeviceStruct {
- struct yaffs_DeviceParamStruct param;
+struct yaffs_dev_s {
+ struct yaffs_param_s param;
/* Context storage. Holds extra OS specific data for this device */
- void *context;
+ void *os_context;
+ void *driver_context;
+
+ struct ylist_head dev_list;
/* Runtime parameters. Set up by YAFFS. */
- int nDataBytesPerChunk;
+ int data_bytes_per_chunk;
/* Non-wide tnode stuff */
- __u16 chunkGroupBits; /* Number of bits that need to be resolved if
+ __u16 chunk_grp_bits; /* Number of bits that need to be resolved if
* the tnodes are not wide enough.
*/
- __u16 chunkGroupSize; /* == 2^^chunkGroupBits */
+ __u16 chunk_grp_size; /* == 2^^chunk_grp_bits */
/* Stuff to support wide tnodes */
- __u32 tnodeWidth;
- __u32 tnodeMask;
+ __u32 tnode_width;
+ __u32 tnode_mask;
+ __u32 tnode_size;
/* Stuff for figuring out file offset to chunk conversions */
- __u32 chunkShift; /* Shift value */
- __u32 chunkDiv; /* Divisor after shifting: 1 for power-of-2 sizes */
- __u32 chunkMask; /* Mask to use for power-of-2 case */
+ __u32 chunk_shift; /* Shift value */
+ __u32 chunk_div; /* Divisor after shifting: 1 for power-of-2 sizes */
+ __u32 chunk_mask; /* Mask to use for power-of-2 case */
- int isMounted;
- int readOnly;
- int isCheckpointed;
+ int is_mounted;
+ int read_only;
+ int is_checkpointed;
/* Stuff to support block offsetting to support start block zero */
- int internalStartBlock;
- int internalEndBlock;
- int blockOffset;
- int chunkOffset;
+ int internal_start_block;
+ int internal_end_block;
+ int block_offset;
+ int chunk_offset;
/* Runtime checkpointing stuff */
- int checkpointPageSequence; /* running sequence number of checkpoint pages */
- int checkpointByteCount;
- int checkpointByteOffset;
- __u8 *checkpointBuffer;
- int checkpointOpenForWrite;
- int blocksInCheckpoint;
- int checkpointCurrentChunk;
- int checkpointCurrentBlock;
- int checkpointNextBlock;
- int *checkpointBlockList;
- int checkpointMaxBlocks;
- __u32 checkpointSum;
- __u32 checkpointXor;
-
- int nCheckpointBlocksRequired; /* Number of blocks needed to store current checkpoint set */
+ int checkpt_page_seq; /* running sequence number of checkpoint pages */
+ int checkpt_byte_count;
+ int checkpt_byte_offs;
+ __u8 *checkpt_buffer;
+ int checkpt_open_write;
+ int blocks_in_checkpt;
+ int checkpt_cur_chunk;
+ int checkpt_cur_block;
+ int checkpt_next_block;
+ int *checkpt_block_list;
+ int checkpt_max_blocks;
+ __u32 checkpt_sum;
+ __u32 checkpt_xor;
+
+ int checkpoint_blocks_required; /* Number of blocks needed to store current checkpoint set */
/* Block Info */
- yaffs_BlockInfo *blockInfo;
- __u8 *chunkBits; /* bitmap of chunks in use */
- unsigned blockInfoAlt:1; /* was allocated using alternative strategy */
- unsigned chunkBitsAlt:1; /* was allocated using alternative strategy */
- int chunkBitmapStride; /* Number of bytes of chunkBits per block.
- * Must be consistent with nChunksPerBlock.
+ yaffs_block_info_t *block_info;
+ __u8 *chunk_bits; /* bitmap of chunks in use */
+ unsigned block_info_alt:1; /* was allocated using alternative strategy */
+ unsigned chunk_bits_alt:1; /* was allocated using alternative strategy */
+ int chunk_bit_stride; /* Number of bytes of chunk_bits per block.
+ * Must be consistent with chunks_per_block.
*/
- int nErasedBlocks;
- int allocationBlock; /* Current block being allocated off */
- __u32 allocationPage;
- int allocationBlockFinder; /* Used to search for next allocation block */
-
- int nTnodesCreated;
- yaffs_Tnode *freeTnodes;
- int nFreeTnodes;
- yaffs_TnodeList *allocatedTnodeList;
+ int n_erased_blocks;
+ int alloc_block; /* Current block being allocated off */
+ __u32 alloc_page;
+ int alloc_block_finder; /* Used to search for next allocation block */
- int isDoingGC;
- int gcBlock;
- int gcChunk;
+ /* Object and Tnode memory management */
+ void *allocator;
+ int n_obj;
+ int n_tnodes;
- int nObjectsCreated;
- yaffs_Object *freeObjects;
- int nFreeObjects;
+ int n_hardlinks;
- int nHardLinks;
+ yaffs_obj_bucket obj_bucket[YAFFS_NOBJECT_BUCKETS];
+ __u32 bucket_finder;
- yaffs_ObjectList *allocatedObjectList;
+ int n_free_chunks;
- yaffs_ObjectBucket objectBucket[YAFFS_NOBJECT_BUCKETS];
- __u32 bucketFinder;
+ /* Garbage collection control */
+ __u32 *gc_cleanup_list; /* objects to delete at the end of a GC. */
+ __u32 n_clean_ups;
- int nFreeChunks;
-
- int currentDirtyChecker; /* Used to find current dirtiest block */
-
- __u32 *gcCleanupList; /* objects to delete at the end of a GC. */
- int nonAggressiveSkip; /* GC state/mode */
-
- int hasPendingPrioritisedGCs; /* We think this device might have pending prioritised gcs */
+ unsigned has_pending_prioritised_gc; /* We think this device might have pending prioritised gcs */
+ unsigned gc_disable;
+ unsigned gc_block_finder;
+ unsigned gc_dirtiest;
+ unsigned gc_pages_in_use;
+ unsigned gc_not_done;
+ unsigned gc_block;
+ unsigned gc_chunk;
+ unsigned gc_skip;
/* Special directories */
- yaffs_Object *rootDir;
- yaffs_Object *lostNFoundDir;
+ yaffs_obj_t *root_dir;
+ yaffs_obj_t *lost_n_found;
/* Buffer areas for storing data to recover from write failures TODO
- * __u8 bufferedData[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
- * yaffs_Spare bufferedSpare[YAFFS_CHUNKS_PER_BLOCK];
+ * __u8 buffered_data[YAFFS_CHUNKS_PER_BLOCK][YAFFS_BYTES_PER_CHUNK];
+ * yaffs_spare buffered_spare[YAFFS_CHUNKS_PER_BLOCK];
*/
- int bufferedBlock; /* Which block is buffered here? */
- int doingBufferedBlockRewrite;
+ int buffered_block; /* Which block is buffered here? */
+ int doing_buffered_block_rewrite;
- yaffs_ChunkCache *srCache;
- int srLastUse;
+ yaffs_cache_t *cache;
+ int cache_last_use;
/* Stuff for background deletion and unlinked files.*/
- yaffs_Object *unlinkedDir; /* Directory where unlinked and deleted files live. */
- yaffs_Object *deletedDir; /* Directory where deleted objects are sent to disappear. */
- yaffs_Object *unlinkedDeletion; /* Current file being background deleted.*/
- int nDeletedFiles; /* Count of files awaiting deletion;*/
- int nUnlinkedFiles; /* Count of unlinked files. */
- int nBackgroundDeletions; /* Count of background deletions. */
+ yaffs_obj_t *unlinked_dir; /* Directory where unlinked and deleted files live. */
+ yaffs_obj_t *del_dir; /* Directory where deleted objects are sent to disappear. */
+ yaffs_obj_t *unlinked_deletion; /* Current file being background deleted.*/
+ int n_deleted_files; /* Count of files awaiting deletion;*/
+ int n_unlinked_files; /* Count of unlinked files. */
+ int n_bg_deletions; /* Count of background deletions. */
/* Temporary buffer management */
- yaffs_TempBuffer tempBuffer[YAFFS_N_TEMP_BUFFERS];
- int maxTemp;
- int tempInUse;
- int unmanagedTempAllocations;
- int unmanagedTempDeallocations;
+ yaffs_buffer_t temp_buffer[YAFFS_N_TEMP_BUFFERS];
+ int max_temp;
+ int temp_in_use;
+ int unmanaged_buffer_allocs;
+ int unmanaged_buffer_deallocs;
/* yaffs2 runtime stuff */
- unsigned sequenceNumber; /* Sequence number of currently allocating block */
- unsigned oldestDirtySequence;
+ unsigned seq_number; /* Sequence number of currently allocating block */
+ unsigned oldest_dirty_seq;
+ unsigned oldest_dirty_block;
/* Block refreshing */
- int refreshSkip; /* A skip down counter. Refresh happens when this gets to zero. */
+ int refresh_skip; /* A skip down counter. Refresh happens when this gets to zero. */
/* Dirty directory handling */
- struct ylist_head dirtyDirectories; /* List of dirty directories */
+ struct ylist_head dirty_dirs; /* List of dirty directories */
/* Statistcs */
- __u32 nPageWrites;
- __u32 nPageReads;
- __u32 nBlockErasures;
- __u32 nErasureFailures;
- __u32 nGCCopies;
- __u32 garbageCollections;
- __u32 passiveGarbageCollections;
- __u32 nRetriedWrites;
- __u32 nRetiredBlocks;
- __u32 eccFixed;
- __u32 eccUnfixed;
- __u32 tagsEccFixed;
- __u32 tagsEccUnfixed;
- __u32 nDeletions;
- __u32 nUnmarkedDeletions;
- __u32 refreshCount;
- __u32 cacheHits;
+ __u32 n_page_writes;
+ __u32 n_page_reads;
+ __u32 n_erasures;
+ __u32 n_erase_failures;
+ __u32 n_gc_copies;
+ __u32 all_gcs;
+ __u32 passive_gc_count;
+ __u32 oldest_dirty_gc_count;
+ __u32 n_gc_blocks;
+ __u32 bg_gcs;
+ __u32 n_retired_writes;
+ __u32 n_retired_blocks;
+ __u32 n_ecc_fixed;
+ __u32 n_ecc_unfixed;
+ __u32 n_tags_ecc_fixed;
+ __u32 n_tags_ecc_unfixed;
+ __u32 n_deletions;
+ __u32 n_unmarked_deletions;
+ __u32 refresh_count;
+ __u32 cache_hits;
};
-typedef struct yaffs_DeviceStruct yaffs_Device;
+typedef struct yaffs_dev_s yaffs_dev_t;
/* The static layout of block usage etc is stored in the super block header */
typedef struct {
int StructType;
int version;
- int checkpointStartBlock;
- int checkpointEndBlock;
- int startBlock;
- int endBlock;
+ int checkpt_start_block;
+ int checkpt_end_block;
+ int start_block;
+ int end_block;
int rfu[100];
-} yaffs_SuperBlockHeader;
+} yaffs_sb_header;
/* The CheckpointDevice structure holds the device information that changes at runtime and
* must be preserved over unmount/mount cycles.
*/
typedef struct {
- int structType;
- int nErasedBlocks;
- int allocationBlock; /* Current block being allocated off */
- __u32 allocationPage;
- int nFreeChunks;
+ int struct_type;
+ int n_erased_blocks;
+ int alloc_block; /* Current block being allocated off */
+ __u32 alloc_page;
+ int n_free_chunks;
- int nDeletedFiles; /* Count of files awaiting deletion;*/
- int nUnlinkedFiles; /* Count of unlinked files. */
- int nBackgroundDeletions; /* Count of background deletions. */
+ int n_deleted_files; /* Count of files awaiting deletion;*/
+ int n_unlinked_files; /* Count of unlinked files. */
+ int n_bg_deletions; /* Count of background deletions. */
/* yaffs2 runtime stuff */
- unsigned sequenceNumber; /* Sequence number of currently allocating block */
+ unsigned seq_number; /* Sequence number of currently allocating block */
-} yaffs_CheckpointDevice;
+} yaffs_checkpt_dev_t;
typedef struct {
- int structType;
+ int struct_type;
__u32 magic;
__u32 version;
__u32 head;
-} yaffs_CheckpointValidity;
+} yaffs_checkpt_validty_t;
+
+
+struct yaffs_shadow_fixer_s {
+ int obj_id;
+ int shadowed_id;
+ struct yaffs_shadow_fixer_s *next;
+};
+
+/* Structure for doing xattr modifications */
+typedef struct {
+ int set; /* If 0 then this is a deletion */
+ const YCHAR *name;
+ const void *data;
+ int size;
+ int flags;
+ int result;
+}yaffs_xattr_mod;
/*----------------------- YAFFS Functions -----------------------*/
-int yaffs_GutsInitialise(yaffs_Device *dev);
-void yaffs_Deinitialise(yaffs_Device *dev);
+int yaffs_guts_initialise(yaffs_dev_t *dev);
+void yaffs_deinitialise(yaffs_dev_t *dev);
-int yaffs_GetNumberOfFreeChunks(yaffs_Device *dev);
+int yaffs_get_n_free_chunks(yaffs_dev_t *dev);
-int yaffs_RenameObject(yaffs_Object *oldDir, const YCHAR *oldName,
- yaffs_Object *newDir, const YCHAR *newName);
+int yaffs_rename_obj(yaffs_obj_t *old_dir, const YCHAR *old_name,
+ yaffs_obj_t *new_dir, const YCHAR *new_name);
-int yaffs_Unlink(yaffs_Object *dir, const YCHAR *name);
-int yaffs_DeleteObject(yaffs_Object *obj);
+int yaffs_unlinker(yaffs_obj_t *dir, const YCHAR *name);
+int yaffs_del_obj(yaffs_obj_t *obj);
-int yaffs_GetObjectName(yaffs_Object *obj, YCHAR *name, int buffSize);
-int yaffs_GetObjectFileLength(yaffs_Object *obj);
-int yaffs_GetObjectInode(yaffs_Object *obj);
-unsigned yaffs_GetObjectType(yaffs_Object *obj);
-int yaffs_GetObjectLinkCount(yaffs_Object *obj);
+int yaffs_get_obj_name(yaffs_obj_t *obj, YCHAR *name, int buffer_size);
+int yaffs_get_obj_length(yaffs_obj_t *obj);
+int yaffs_get_obj_inode(yaffs_obj_t *obj);
+unsigned yaffs_get_obj_type(yaffs_obj_t *obj);
+int yaffs_get_obj_link_count(yaffs_obj_t *obj);
-int yaffs_SetAttributes(yaffs_Object *obj, struct iattr *attr);
-int yaffs_GetAttributes(yaffs_Object *obj, struct iattr *attr);
+int yaffs_set_attribs(yaffs_obj_t *obj, struct iattr *attr);
+int yaffs_get_attribs(yaffs_obj_t *obj, struct iattr *attr);
/* File operations */
-int yaffs_ReadDataFromFile(yaffs_Object *obj, __u8 *buffer, loff_t offset,
- int nBytes);
-int yaffs_WriteDataToFile(yaffs_Object *obj, const __u8 *buffer, loff_t offset,
- int nBytes, int writeThrough);
-int yaffs_ResizeFile(yaffs_Object *obj, loff_t newSize);
+int yaffs_file_rd(yaffs_obj_t *obj, __u8 *buffer, loff_t offset,
+ int n_bytes);
+int yaffs_wr_file(yaffs_obj_t *obj, const __u8 *buffer, loff_t offset,
+ int n_bytes, int write_trhrough);
+int yaffs_resize_file(yaffs_obj_t *obj, loff_t new_size);
-yaffs_Object *yaffs_MknodFile(yaffs_Object *parent, const YCHAR *name,
+yaffs_obj_t *yaffs_create_file(yaffs_obj_t *parent, const YCHAR *name,
__u32 mode, __u32 uid, __u32 gid);
-int yaffs_FlushFile(yaffs_Object *obj, int updateTime, int dataSync);
+int yaffs_flush_file(yaffs_obj_t *obj, int update_time, int data_sync);
/* Flushing and checkpointing */
-void yaffs_FlushEntireDeviceCache(yaffs_Device *dev);
+void yaffs_flush_whole_cache(yaffs_dev_t *dev);
-int yaffs_CheckpointSave(yaffs_Device *dev);
-int yaffs_CheckpointRestore(yaffs_Device *dev);
+int yaffs_checkpoint_save(yaffs_dev_t *dev);
+int yaffs_checkpoint_restore(yaffs_dev_t *dev);
/* Directory operations */
-yaffs_Object *yaffs_MknodDirectory(yaffs_Object *parent, const YCHAR *name,
+yaffs_obj_t *yaffs_create_dir(yaffs_obj_t *parent, const YCHAR *name,
__u32 mode, __u32 uid, __u32 gid);
-yaffs_Object *yaffs_FindObjectByName(yaffs_Object *theDir, const YCHAR *name);
-int yaffs_ApplyToDirectoryChildren(yaffs_Object *theDir,
- int (*fn) (yaffs_Object *));
+yaffs_obj_t *yaffs_find_by_name(yaffs_obj_t *the_dir, const YCHAR *name);
+int yaffs_ApplyToDirectoryChildren(yaffs_obj_t *the_dir,
+ int (*fn) (yaffs_obj_t *));
-yaffs_Object *yaffs_FindObjectByNumber(yaffs_Device *dev, __u32 number);
+yaffs_obj_t *yaffs_find_by_number(yaffs_dev_t *dev, __u32 number);
/* Link operations */
-yaffs_Object *yaffs_Link(yaffs_Object *parent, const YCHAR *name,
- yaffs_Object *equivalentObject);
+yaffs_obj_t *yaffs_link_obj(yaffs_obj_t *parent, const YCHAR *name,
+ yaffs_obj_t *equiv_obj);
-yaffs_Object *yaffs_GetEquivalentObject(yaffs_Object *obj);
+yaffs_obj_t *yaffs_get_equivalent_obj(yaffs_obj_t *obj);
/* Symlink operations */
-yaffs_Object *yaffs_MknodSymLink(yaffs_Object *parent, const YCHAR *name,
+yaffs_obj_t *yaffs_create_symlink(yaffs_obj_t *parent, const YCHAR *name,
__u32 mode, __u32 uid, __u32 gid,
const YCHAR *alias);
-YCHAR *yaffs_GetSymlinkAlias(yaffs_Object *obj);
+YCHAR *yaffs_get_symlink_alias(yaffs_obj_t *obj);
/* Special inodes (fifos, sockets and devices) */
-yaffs_Object *yaffs_MknodSpecial(yaffs_Object *parent, const YCHAR *name,
+yaffs_obj_t *yaffs_create_special(yaffs_obj_t *parent, const YCHAR *name,
__u32 mode, __u32 uid, __u32 gid, __u32 rdev);
+
+int yaffs_set_xattrib(yaffs_obj_t *obj, const YCHAR *name, const void * value, int size, int flags);
+int yaffs_get_xattrib(yaffs_obj_t *obj, const YCHAR *name, void *value, int size);
+int yaffs_list_xattrib(yaffs_obj_t *obj, char *buffer, int size);
+int yaffs_remove_xattrib(yaffs_obj_t *obj, const YCHAR *name);
+
/* Special directories */
-yaffs_Object *yaffs_Root(yaffs_Device *dev);
-yaffs_Object *yaffs_LostNFound(yaffs_Device *dev);
+yaffs_obj_t *yaffs_root(yaffs_dev_t *dev);
+yaffs_obj_t *yaffs_lost_n_found(yaffs_dev_t *dev);
#ifdef CONFIG_YAFFS_WINCE
/* CONFIG_YAFFS_WINCE special stuff */
-void yfsd_WinFileTimeNow(__u32 target[2]);
+void yfsd_win_file_time_now(__u32 target[2]);
#endif
-void yaffs_HandleDeferedFree(yaffs_Object *obj);
+void yaffs_handle_defered_free(yaffs_obj_t *obj);
+void yaffs_update_dirty_dirs(yaffs_dev_t *dev);
-void yaffs_UpdateDirtyDirectories(yaffs_Device *dev);
-
+int yaffs_bg_gc(yaffs_dev_t *dev, unsigned urgency);
/* Debug dump */
-int yaffs_DumpObject(yaffs_Object *obj);
-
-void yaffs_GutsTest(yaffs_Device *dev);
-
-/* A few useful functions */
-void yaffs_InitialiseTags(yaffs_ExtendedTags *tags);
-void yaffs_DeleteChunk(yaffs_Device *dev, int chunkId, int markNAND, int lyn);
-int yaffs_CheckFF(__u8 *buffer, int nBytes);
-void yaffs_HandleChunkError(yaffs_Device *dev, yaffs_BlockInfo *bi);
-
-__u8 *yaffs_GetTempBuffer(yaffs_Device *dev, int lineNo);
-void yaffs_ReleaseTempBuffer(yaffs_Device *dev, __u8 *buffer, int lineNo);
-
+int yaffs_dump_obj(yaffs_obj_t *obj);
+
+void yaffs_guts_test(yaffs_dev_t *dev);
+
+/* A few useful functions to be used within the core files*/
+void yaffs_chunk_del(yaffs_dev_t *dev, int chunk_id, int mark_flash, int lyn);
+int yaffs_check_ff(__u8 *buffer, int n_bytes);
+void yaffs_handle_chunk_error(yaffs_dev_t *dev, yaffs_block_info_t *bi);
+
+__u8 *yaffs_get_temp_buffer(yaffs_dev_t *dev, int line_no);
+void yaffs_release_temp_buffer(yaffs_dev_t *dev, __u8 *buffer, int line_no);
+
+yaffs_obj_t *yaffs_find_or_create_by_number(yaffs_dev_t *dev,
+ int number,
+ yaffs_obj_type type);
+int yaffs_put_chunk_in_file(yaffs_obj_t *in, int inode_chunk,
+ int nand_chunk, int in_scan);
+void yaffs_set_obj_name(yaffs_obj_t *obj, const YCHAR *name);
+void yaffs_set_obj_name_from_oh(yaffs_obj_t *obj, const yaffs_obj_header *oh);
+void yaffs_add_obj_to_dir(yaffs_obj_t *directory,
+ yaffs_obj_t *obj);
+YCHAR *yaffs_clone_str(const YCHAR *str);
+void yaffs_link_fixup(yaffs_dev_t *dev, yaffs_obj_t *hard_list);
+void yaffs_block_became_dirty(yaffs_dev_t *dev, int block_no);
+int yaffs_update_oh(yaffs_obj_t *in, const YCHAR *name,
+ int force, int is_shrink, int shadows,
+ yaffs_xattr_mod *xop);
+void yaffs_handle_shadowed_obj(yaffs_dev_t *dev, int obj_id,
+ int backward_scanning);
+int yaffs_check_alloc_available(yaffs_dev_t *dev, int n_chunks);
+yaffs_tnode_t *yaffs_get_tnode(yaffs_dev_t *dev);
+yaffs_tnode_t *yaffs_add_find_tnode_0(yaffs_dev_t *dev,
+ yaffs_file_s *file_struct,
+ __u32 chunk_id,
+ yaffs_tnode_t *passed_tn);
+
+int yaffs_do_file_wr(yaffs_obj_t *in, const __u8 *buffer, loff_t offset,
+ int n_bytes, int write_trhrough);
+void yaffs_resize_file_down( yaffs_obj_t *obj, loff_t new_size);
+void yaffs_skip_rest_of_block(yaffs_dev_t *dev);
+
+int yaffs_count_free_chunks(yaffs_dev_t *dev);
+
+yaffs_tnode_t *yaffs_find_tnode_0(yaffs_dev_t *dev,
+ yaffs_file_s *file_struct,
+ __u32 chunk_id);
+
+__u32 yaffs_get_group_base(yaffs_dev_t *dev, yaffs_tnode_t *tn, unsigned pos);
#endif
projects / yaffs2.git / blobdiff