[JFFS2] Add support for JFFS2-on-Dataflash devices.
[safe/jmp/linux-2.6] / include / linux / jffs2_fs_sb.h
1 /* $Id: jffs2_fs_sb.h,v 1.49 2005/02/09 09:17:41 pavlov Exp $ */
2
3 #ifndef _JFFS2_FS_SB
4 #define _JFFS2_FS_SB
5
6 #include <linux/types.h>
7 #include <linux/spinlock.h>
8 #include <linux/workqueue.h>
9 #include <linux/completion.h>
10 #include <asm/semaphore.h>
11 #include <linux/timer.h>
12 #include <linux/wait.h>
13 #include <linux/list.h>
14 #include <linux/rwsem.h>
15
16 #define JFFS2_SB_FLAG_RO 1
17 #define JFFS2_SB_FLAG_MOUNTING 2
18
19 struct jffs2_inodirty;
20
21 /* A struct for the overall file system control.  Pointers to
22    jffs2_sb_info structs are named `c' in the source code.  
23    Nee jffs_control
24 */
25 struct jffs2_sb_info {
26         struct mtd_info *mtd;
27
28         uint32_t highest_ino;
29         uint32_t checked_ino;
30
31         unsigned int flags;
32
33         struct task_struct *gc_task;    /* GC task struct */
34         struct semaphore gc_thread_start; /* GC thread start mutex */
35         struct completion gc_thread_exit; /* GC thread exit completion port */
36
37         struct semaphore alloc_sem;     /* Used to protect all the following 
38                                            fields, and also to protect against
39                                            out-of-order writing of nodes. And GC. */
40         uint32_t cleanmarker_size;      /* Size of an _inline_ CLEANMARKER
41                                          (i.e. zero for OOB CLEANMARKER */
42
43         uint32_t flash_size;
44         uint32_t used_size;
45         uint32_t dirty_size;
46         uint32_t wasted_size;
47         uint32_t free_size;
48         uint32_t erasing_size;
49         uint32_t bad_size;
50         uint32_t sector_size;
51         uint32_t unchecked_size;
52
53         uint32_t nr_free_blocks;
54         uint32_t nr_erasing_blocks;
55
56         /* Number of free blocks there must be before we... */
57         uint8_t resv_blocks_write;      /* ... allow a normal filesystem write */
58         uint8_t resv_blocks_deletion;   /* ... allow a normal filesystem deletion */
59         uint8_t resv_blocks_gctrigger;  /* ... wake up the GC thread */
60         uint8_t resv_blocks_gcbad;      /* ... pick a block from the bad_list to GC */
61         uint8_t resv_blocks_gcmerge;    /* ... merge pages when garbage collecting */
62
63         uint32_t nospc_dirty_size;
64
65         uint32_t nr_blocks;
66         struct jffs2_eraseblock *blocks;        /* The whole array of blocks. Used for getting blocks 
67                                                  * from the offset (blocks[ofs / sector_size]) */
68         struct jffs2_eraseblock *nextblock;     /* The block we're currently filling */
69
70         struct jffs2_eraseblock *gcblock;       /* The block we're currently garbage-collecting */
71
72         struct list_head clean_list;            /* Blocks 100% full of clean data */
73         struct list_head very_dirty_list;       /* Blocks with lots of dirty space */
74         struct list_head dirty_list;            /* Blocks with some dirty space */
75         struct list_head erasable_list;         /* Blocks which are completely dirty, and need erasing */
76         struct list_head erasable_pending_wbuf_list;    /* Blocks which need erasing but only after the current wbuf is flushed */
77         struct list_head erasing_list;          /* Blocks which are currently erasing */
78         struct list_head erase_pending_list;    /* Blocks which need erasing now */
79         struct list_head erase_complete_list;   /* Blocks which are erased and need the clean marker written to them */
80         struct list_head free_list;             /* Blocks which are free and ready to be used */
81         struct list_head bad_list;              /* Bad blocks. */
82         struct list_head bad_used_list;         /* Bad blocks with valid data in. */
83
84         spinlock_t erase_completion_lock;       /* Protect free_list and erasing_list 
85                                                    against erase completion handler */
86         wait_queue_head_t erase_wait;           /* For waiting for erases to complete */
87
88         wait_queue_head_t inocache_wq;
89         struct jffs2_inode_cache **inocache_list;
90         spinlock_t inocache_lock;
91         
92         /* Sem to allow jffs2_garbage_collect_deletion_dirent to
93            drop the erase_completion_lock while it's holding a pointer 
94            to an obsoleted node. I don't like this. Alternatives welcomed. */
95         struct semaphore erase_free_sem;
96
97 #if defined CONFIG_JFFS2_FS_NAND || defined CONFIG_JFFS2_FS_NOR_ECC || defined CONFIG_JFFS2_FS_DATAFLASH
98         /* Write-behind buffer for NAND flash */
99         unsigned char *wbuf;
100         uint32_t wbuf_ofs;
101         uint32_t wbuf_len;
102         uint32_t wbuf_pagesize;
103         struct jffs2_inodirty *wbuf_inodes;
104
105         struct rw_semaphore wbuf_sem;   /* Protects the write buffer */
106
107         /* Information about out-of-band area usage... */
108         struct nand_oobinfo *oobinfo;
109         uint32_t badblock_pos;
110         uint32_t fsdata_pos;
111         uint32_t fsdata_len;
112 #endif
113
114         /* OS-private pointer for getting back to master superblock info */
115         void *os_priv;
116 };
117
118 #endif /* _JFFS2_FB_SB */