035a767f958b078baa407c84e90050b20f77eca2
[safe/jmp/linux-2.6] / fs / jffs2 / os-linux.h
1 /*
2  * JFFS2 -- Journalling Flash File System, Version 2.
3  *
4  * Copyright © 2001-2007 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  */
11
12 #ifndef __JFFS2_OS_LINUX_H__
13 #define __JFFS2_OS_LINUX_H__
14
15 /* JFFS2 uses Linux mode bits natively -- no need for conversion */
16 #define os_to_jffs2_mode(x) (x)
17 #define jffs2_to_os_mode(x) (x)
18
19 struct kstatfs;
20 struct kvec;
21
22 #define JFFS2_INODE_INFO(i) (list_entry(i, struct jffs2_inode_info, vfs_inode))
23 #define OFNI_EDONI_2SFFJ(f)  (&(f)->vfs_inode)
24 #define JFFS2_SB_INFO(sb) (sb->s_fs_info)
25 #define OFNI_BS_2SFFJ(c)  ((struct super_block *)c->os_priv)
26
27
28 #define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size)
29 #define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode)
30 #define JFFS2_F_I_UID(f) (OFNI_EDONI_2SFFJ(f)->i_uid)
31 #define JFFS2_F_I_GID(f) (OFNI_EDONI_2SFFJ(f)->i_gid)
32 #define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)
33
34 #define ITIME(sec) ((struct timespec){sec, 0})
35 #define I_SEC(tv) ((tv).tv_sec)
36 #define JFFS2_F_I_CTIME(f) (OFNI_EDONI_2SFFJ(f)->i_ctime.tv_sec)
37 #define JFFS2_F_I_MTIME(f) (OFNI_EDONI_2SFFJ(f)->i_mtime.tv_sec)
38 #define JFFS2_F_I_ATIME(f) (OFNI_EDONI_2SFFJ(f)->i_atime.tv_sec)
39
40 #define sleep_on_spinunlock(wq, s)                              \
41         do {                                                    \
42                 DECLARE_WAITQUEUE(__wait, current);             \
43                 add_wait_queue((wq), &__wait);                  \
44                 set_current_state(TASK_UNINTERRUPTIBLE);        \
45                 spin_unlock(s);                                 \
46                 schedule();                                     \
47                 remove_wait_queue((wq), &__wait);               \
48         } while(0)
49
50 static inline void jffs2_init_inode_info(struct jffs2_inode_info *f)
51 {
52         f->highest_version = 0;
53         f->fragtree = RB_ROOT;
54         f->metadata = NULL;
55         f->dents = NULL;
56         f->target = NULL;
57         f->flags = 0;
58         f->usercompr = 0;
59 }
60
61
62 #define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
63
64 #define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
65 #ifndef CONFIG_JFFS2_FS_WRITEBUFFER
66
67
68 #ifdef CONFIG_JFFS2_SUMMARY
69 #define jffs2_can_mark_obsolete(c) (0)
70 #else
71 #define jffs2_can_mark_obsolete(c) (1)
72 #endif
73
74 #define jffs2_is_writebuffered(c) (0)
75 #define jffs2_cleanmarker_oob(c) (0)
76 #define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
77
78 #define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
79 #define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
80 #define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
81 #define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
82 #define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
83 #define jffs2_nand_flash_setup(c) (0)
84 #define jffs2_nand_flash_cleanup(c) do {} while(0)
85 #define jffs2_wbuf_dirty(c) (0)
86 #define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
87 #define jffs2_wbuf_timeout NULL
88 #define jffs2_wbuf_process NULL
89 #define jffs2_dataflash(c) (0)
90 #define jffs2_dataflash_setup(c) (0)
91 #define jffs2_dataflash_cleanup(c) do {} while (0)
92 #define jffs2_nor_wbuf_flash(c) (0)
93 #define jffs2_nor_wbuf_flash_setup(c) (0)
94 #define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
95 #define jffs2_ubivol(c) (0)
96 #define jffs2_ubivol_setup(c) (0)
97 #define jffs2_ubivol_cleanup(c) do {} while (0)
98
99 #else /* NAND and/or ECC'd NOR support present */
100
101 #define jffs2_is_writebuffered(c) (c->wbuf != NULL)
102
103 #ifdef CONFIG_JFFS2_SUMMARY
104 #define jffs2_can_mark_obsolete(c) (0)
105 #else
106 #define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
107 #endif
108
109 #define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)
110
111 #define jffs2_flash_write_oob(c, ofs, len, retlen, buf) ((c)->mtd->write_oob((c)->mtd, ofs, len, retlen, buf))
112 #define jffs2_flash_read_oob(c, ofs, len, retlen, buf) ((c)->mtd->read_oob((c)->mtd, ofs, len, retlen, buf))
113 #define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)
114
115 /* wbuf.c */
116 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);
117 int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
118 int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
119 int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
120 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
121 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
122 int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
123 void jffs2_wbuf_timeout(unsigned long data);
124 void jffs2_wbuf_process(void *data);
125 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
126 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
127 int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
128 void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
129
130 #define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
131 int jffs2_dataflash_setup(struct jffs2_sb_info *c);
132 void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
133 #define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
134 int jffs2_ubivol_setup(struct jffs2_sb_info *c);
135 void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);
136
137 #define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
138 int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
139 void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
140
141 #endif /* WRITEBUFFER */
142
143 static inline void jffs2_dirty_trigger(struct jffs2_sb_info *c)
144 {
145         OFNI_BS_2SFFJ(c)->s_dirt = 1;
146 }
147
148 /* background.c */
149 int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
150 void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
151 void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
152
153 /* dir.c */
154 extern const struct file_operations jffs2_dir_operations;
155 extern const struct inode_operations jffs2_dir_inode_operations;
156
157 /* file.c */
158 extern const struct file_operations jffs2_file_operations;
159 extern const struct inode_operations jffs2_file_inode_operations;
160 extern const struct address_space_operations jffs2_file_address_operations;
161 int jffs2_fsync(struct file *, struct dentry *, int);
162 int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);
163
164 /* ioctl.c */
165 long jffs2_ioctl(struct file *, unsigned int, unsigned long);
166
167 /* symlink.c */
168 extern const struct inode_operations jffs2_symlink_inode_operations;
169
170 /* fs.c */
171 int jffs2_setattr (struct dentry *, struct iattr *);
172 int jffs2_do_setattr (struct inode *, struct iattr *);
173 struct inode *jffs2_iget(struct super_block *, unsigned long);
174 void jffs2_clear_inode (struct inode *);
175 void jffs2_dirty_inode(struct inode *inode);
176 struct inode *jffs2_new_inode (struct inode *dir_i, int mode,
177                                struct jffs2_raw_inode *ri);
178 int jffs2_statfs (struct dentry *, struct kstatfs *);
179 int jffs2_remount_fs (struct super_block *, int *, char *);
180 int jffs2_do_fill_super(struct super_block *sb, void *data, int silent);
181 void jffs2_gc_release_inode(struct jffs2_sb_info *c,
182                             struct jffs2_inode_info *f);
183 struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
184                                               int inum, int unlinked);
185
186 unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
187                                    struct jffs2_inode_info *f,
188                                    unsigned long offset,
189                                    unsigned long *priv);
190 void jffs2_gc_release_page(struct jffs2_sb_info *c,
191                            unsigned char *pg,
192                            unsigned long *priv);
193 void jffs2_flash_cleanup(struct jffs2_sb_info *c);
194
195
196 /* writev.c */
197 int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
198                        unsigned long count, loff_t to, size_t *retlen);
199 int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
200                         size_t *retlen, const u_char *buf);
201
202 #endif /* __JFFS2_OS_LINUX_H__ */
203
204