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