Tweaks to YaffsTuning doc.
[yaffs2.git] / moduleconfig.h
1 /*
2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2007 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Martin Fouts <Martin.Fouts@palmsource.com>
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_CONFIG_H__
17 #define __YAFFS_CONFIG_H__
18
19 #ifdef YAFFS_OUT_OF_TREE
20
21 /* DO NOT UNSET THESE THREE. YAFFS2 will not compile if you do. */
22 #define CONFIG_YAFFS_FS
23 #define CONFIG_YAFFS_YAFFS1
24 #define CONFIG_YAFFS_YAFFS2
25
26 /* These options are independent of each other.  Select those that matter. */
27
28 /* Default: Not selected */
29 /* Meaning: Yaffs does its own ECC, rather than using MTD ECC */
30 /* #define CONFIG_YAFFS_DOES_ECC */
31
32 /* Default: Selected */
33 /* Meaning: Yaffs does its own ECC on tags for packed tags rather than use mtd */
34 #define CONFIG_YAFFS_DOES_TAGS_ECC
35
36 /* Default: Not selected */
37 /* Meaning: ECC byte order is 'wrong'.  Only meaningful if */
38 /*          CONFIG_YAFFS_DOES_ECC is set */
39 /* #define CONFIG_YAFFS_ECC_WRONG_ORDER */
40
41 /* Default: Selected */
42 /* Meaning: Disables testing whether chunks are erased before writing to them*/
43 #define CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
44
45 /* Default: Not Selected */
46 /* Meaning: At mount automatically empty all files from lost and found. */
47 /* This is done to fix an old problem where rmdir was not checking for an */
48 /* empty directory. This can also be achieved with a mount option. */
49 #define CONFIG_YAFFS_EMPTY_LOST_AND_FOUND
50
51 /* Default: Selected */
52 /* Meaning: Cache short names, taking more RAM, but faster look-ups */
53 #define CONFIG_YAFFS_SHORT_NAMES_IN_RAM
54
55 /* Default: Unselected */
56 /* Meaning: Select to disable block refreshing. */
57 /* Block Refreshing periodically rewrites the oldest block. */
58 /* #define CONFIG_DISABLE_BLOCK_REFRESHING */
59
60 /* Default: Unselected */
61 /* Meaning: Select to disable background processing */
62 /* #define CONFIG_DISABLE_BACKGROUND */
63
64
65 /*
66 Older-style on-NAND data format has a "pageStatus" byte to record
67 chunk/page state.  This byte is zeroed when the page is discarded.
68 Choose this option if you have existing on-NAND data in this format
69 that you need to continue to support.  New data written also uses the
70 older-style format.
71 Note: Use of this option generally requires that MTD's oob layout be
72 adjusted to use the older-style format.  See notes on tags formats and
73 MTD versions in yaffs_mtdif1.c.
74 */
75 /* Default: Not selected */
76 /* Meaning: Use older-style on-NAND data format with pageStatus byte */
77 /* #define CONFIG_YAFFS_9BYTE_TAGS */
78
79 #endif /* YAFFS_OUT_OF_TREE */
80
81 #endif /* __YAFFS_CONFIG_H__ */