[JFFS2] Add support for JFFS2-on-Dataflash devices.
[safe/jmp/linux-2.6] / fs / jffs2 / os-linux.h
1 /*
2  * JFFS2 -- Journalling Flash File System, Version 2.
3  *
4  * Copyright (C) 2002-2003 Red Hat, Inc.
5  *
6  * Created by David Woodhouse <dwmw2@infradead.org>
7  *
8  * For licensing information, see the file 'LICENCE' in this directory.
9  *
10  * $Id: os-linux.h,v 1.53 2005/02/09 09:17:41 pavlov Exp $
11  *
12  */
13
14 #ifndef __JFFS2_OS_LINUX_H__
15 #define __JFFS2_OS_LINUX_H__
16 #include <linux/version.h>
17
18 /* JFFS2 uses Linux mode bits natively -- no need for conversion */
19 #define os_to_jffs2_mode(x) (x)
20 #define jffs2_to_os_mode(x) (x)
21
22 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,73)
23 #define kstatfs statfs
24 #endif
25
26 struct kstatfs;
27 struct kvec;
28
29 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,5,2)
30 #define JFFS2_INODE_INFO(i) (list_entry(i, struct jffs2_inode_info, vfs_inode))
31 #define OFNI_EDONI_2SFFJ(f)  (&(f)->vfs_inode)
32 #define JFFS2_SB_INFO(sb) (sb->s_fs_info)
33 #define OFNI_BS_2SFFJ(c)  ((struct super_block *)c->os_priv)
34 #elif defined(JFFS2_OUT_OF_KERNEL)
35 #define JFFS2_INODE_INFO(i) ((struct jffs2_inode_info *) &(i)->u)
36 #define OFNI_EDONI_2SFFJ(f)  ((struct inode *) ( ((char *)f) - ((char *)(&((struct inode *)NULL)->u)) ) )
37 #define JFFS2_SB_INFO(sb) ((struct jffs2_sb_info *) &(sb)->u)
38 #define OFNI_BS_2SFFJ(c)  ((struct super_block *) ( ((char *)c) - ((char *)(&((struct super_block *)NULL)->u)) ) )
39 #else
40 #define JFFS2_INODE_INFO(i) (&i->u.jffs2_i)
41 #define OFNI_EDONI_2SFFJ(f)  ((struct inode *) ( ((char *)f) - ((char *)(&((struct inode *)NULL)->u)) ) )
42 #define JFFS2_SB_INFO(sb) (&sb->u.jffs2_sb)
43 #define OFNI_BS_2SFFJ(c)  ((struct super_block *) ( ((char *)c) - ((char *)(&((struct super_block *)NULL)->u)) ) )
44 #endif
45
46
47 #define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size)
48 #define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode)
49 #define JFFS2_F_I_UID(f) (OFNI_EDONI_2SFFJ(f)->i_uid)
50 #define JFFS2_F_I_GID(f) (OFNI_EDONI_2SFFJ(f)->i_gid)
51
52 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,5,1)
53 #define JFFS2_F_I_RDEV_MIN(f) (iminor(OFNI_EDONI_2SFFJ(f)))
54 #define JFFS2_F_I_RDEV_MAJ(f) (imajor(OFNI_EDONI_2SFFJ(f)))
55 #else
56 #define JFFS2_F_I_RDEV_MIN(f) (MINOR(to_kdev_t(OFNI_EDONI_2SFFJ(f)->i_rdev)))
57 #define JFFS2_F_I_RDEV_MAJ(f) (MAJOR(to_kdev_t(OFNI_EDONI_2SFFJ(f)->i_rdev)))
58 #endif
59
60 /* Urgh. The things we do to keep the 2.4 build working */
61 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,5,47)
62 #define ITIME(sec) ((struct timespec){sec, 0})
63 #define I_SEC(tv) ((tv).tv_sec)
64 #define JFFS2_F_I_CTIME(f) (OFNI_EDONI_2SFFJ(f)->i_ctime.tv_sec)
65 #define JFFS2_F_I_MTIME(f) (OFNI_EDONI_2SFFJ(f)->i_mtime.tv_sec)
66 #define JFFS2_F_I_ATIME(f) (OFNI_EDONI_2SFFJ(f)->i_atime.tv_sec)
67 #else
68 #define ITIME(x) (x)
69 #define I_SEC(x) (x)
70 #define JFFS2_F_I_CTIME(f) (OFNI_EDONI_2SFFJ(f)->i_ctime)
71 #define JFFS2_F_I_MTIME(f) (OFNI_EDONI_2SFFJ(f)->i_mtime)
72 #define JFFS2_F_I_ATIME(f) (OFNI_EDONI_2SFFJ(f)->i_atime)
73 #endif
74
75 #define sleep_on_spinunlock(wq, s)                              \
76         do {                                                    \
77                 DECLARE_WAITQUEUE(__wait, current);             \
78                 add_wait_queue((wq), &__wait);                  \
79                 set_current_state(TASK_UNINTERRUPTIBLE);        \
80                 spin_unlock(s);                                 \
81                 schedule();                                     \
82                 remove_wait_queue((wq), &__wait);               \
83         } while(0)
84
85 static inline void jffs2_init_inode_info(struct jffs2_inode_info *f)
86 {
87 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,5,2)
88         f->highest_version = 0;
89         f->fragtree = RB_ROOT;
90         f->metadata = NULL;
91         f->dents = NULL;
92         f->flags = 0;
93         f->usercompr = 0;
94 #else
95         memset(f, 0, sizeof(*f));
96         init_MUTEX_LOCKED(&f->sem);
97 #endif
98 }
99
100 #ifdef CONFIG_JFFS2_FS_DATAFLASH
101 #define SECTOR_ADDR(x) ( ((unsigned long)(x) / (unsigned long)(c->sector_size)) * c->sector_size )
102 #else
103 #define SECTOR_ADDR(x) ( ((unsigned long)(x) & ~(c->sector_size-1)) )
104 #endif
105
106 #define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
107 #define jffs2_is_writebuffered(c) (c->wbuf != NULL)
108
109 #if (!defined CONFIG_JFFS2_FS_NAND && !defined CONFIG_JFFS2_FS_NOR_ECC && !defined CONFIG_JFFS2_FS_DATAFLASH)
110 #define jffs2_can_mark_obsolete(c) (1)
111 #define jffs2_cleanmarker_oob(c) (0)
112 #define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
113
114 #define jffs2_flash_write(c, ofs, len, retlen, buf) ((c)->mtd->write((c)->mtd, ofs, len, retlen, buf))
115 #define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
116 #define jffs2_flush_wbuf_pad(c) ({ (void)(c), 0; })
117 #define jffs2_flush_wbuf_gc(c, i) ({ (void)(c), (void) i, 0; })
118 #define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
119 #define jffs2_nand_flash_setup(c) (0)
120 #define jffs2_nand_flash_cleanup(c) do {} while(0)
121 #define jffs2_wbuf_dirty(c) (0)
122 #define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
123 #define jffs2_wbuf_timeout NULL
124 #define jffs2_wbuf_process NULL
125 #define jffs2_nor_ecc(c) (0)
126 #define jffs2_dataflash(c) (0)
127 #define jffs2_nor_ecc_flash_setup(c) (0)
128 #define jffs2_nor_ecc_flash_cleanup(c) do {} while (0)
129
130 #else /* NAND and/or ECC'd NOR support present */
131
132 #define jffs2_can_mark_obsolete(c) ((c->mtd->type == MTD_NORFLASH && !(c->mtd->flags & MTD_ECC)) || c->mtd->type == MTD_RAM)
133 #define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)
134
135 #define jffs2_flash_write_oob(c, ofs, len, retlen, buf) ((c)->mtd->write_oob((c)->mtd, ofs, len, retlen, buf))
136 #define jffs2_flash_read_oob(c, ofs, len, retlen, buf) ((c)->mtd->read_oob((c)->mtd, ofs, len, retlen, buf))
137 #define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)
138
139 /* wbuf.c */
140 int jffs2_flash_writev(struct jffs2_sb_info *c, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen, uint32_t ino);
141 int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
142 int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
143 int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
144 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
145 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
146 int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
147 void jffs2_wbuf_timeout(unsigned long data);
148 void jffs2_wbuf_process(void *data);
149 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
150 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
151 int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
152 void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
153 #ifdef CONFIG_JFFS2_FS_NOR_ECC
154 #define jffs2_nor_ecc(c) (c->mtd->type == MTD_NORFLASH && (c->mtd->flags & MTD_ECC))
155 int jffs2_nor_ecc_flash_setup(struct jffs2_sb_info *c);
156 void jffs2_nor_ecc_flash_cleanup(struct jffs2_sb_info *c);
157 #else
158 #define jffs2_nor_ecc(c) (0)
159 #define jffs2_nor_ecc_flash_setup(c) (0)
160 #define jffs2_nor_ecc_flash_cleanup(c) do {} while (0)
161 #endif /* NOR ECC */
162 #ifdef CONFIG_JFFS2_FS_DATAFLASH
163 #define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
164 int jffs2_dataflash_setup(struct jffs2_sb_info *c);
165 void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
166 #else
167 #define jffs2_dataflash(c) (0)
168 #define jffs2_dataflash_setup(c) (0)
169 #define jffs2_dataflash_cleanup(c) do {} while (0)
170 #endif /* DATAFLASH */
171 #endif /* NAND */
172
173 /* erase.c */
174 static inline void jffs2_erase_pending_trigger(struct jffs2_sb_info *c)
175 {
176         OFNI_BS_2SFFJ(c)->s_dirt = 1;
177 }
178
179 /* background.c */
180 int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
181 void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
182 void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
183
184 /* dir.c */
185 extern struct file_operations jffs2_dir_operations;
186 extern struct inode_operations jffs2_dir_inode_operations;
187
188 /* file.c */
189 extern struct file_operations jffs2_file_operations;
190 extern struct inode_operations jffs2_file_inode_operations;
191 extern struct address_space_operations jffs2_file_address_operations;
192 int jffs2_fsync(struct file *, struct dentry *, int);
193 int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);
194
195 /* ioctl.c */
196 int jffs2_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
197
198 /* symlink.c */
199 extern struct inode_operations jffs2_symlink_inode_operations;
200
201 /* fs.c */
202 int jffs2_setattr (struct dentry *, struct iattr *);
203 void jffs2_read_inode (struct inode *);
204 void jffs2_clear_inode (struct inode *);
205 void jffs2_dirty_inode(struct inode *inode);
206 struct inode *jffs2_new_inode (struct inode *dir_i, int mode,
207                                struct jffs2_raw_inode *ri);
208 int jffs2_statfs (struct super_block *, struct kstatfs *);
209 void jffs2_write_super (struct super_block *);
210 int jffs2_remount_fs (struct super_block *, int *, char *);
211 int jffs2_do_fill_super(struct super_block *sb, void *data, int silent);
212 void jffs2_gc_release_inode(struct jffs2_sb_info *c,
213                             struct jffs2_inode_info *f);
214 struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
215                                               int inum, int nlink);
216
217 unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c, 
218                                    struct jffs2_inode_info *f, 
219                                    unsigned long offset,
220                                    unsigned long *priv);
221 void jffs2_gc_release_page(struct jffs2_sb_info *c,
222                            unsigned char *pg,
223                            unsigned long *priv);
224 void jffs2_flash_cleanup(struct jffs2_sb_info *c);
225      
226
227 /* writev.c */
228 int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs, 
229                        unsigned long count, loff_t to, size_t *retlen);
230
231
232 #endif /* __JFFS2_OS_LINUX_H__ */
233
234