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
19struct kstatfs;
20struct 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
50static 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#ifdef CONFIG_JFFS2_FS_POSIX_ACL
60	f->i_acl_access = JFFS2_ACL_NOT_CACHED;
61	f->i_acl_default = JFFS2_ACL_NOT_CACHED;
62#endif
63}
64
65
66#define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
67
68#define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
69#ifndef CONFIG_JFFS2_FS_WRITEBUFFER
70
71
72#ifdef CONFIG_JFFS2_SUMMARY
73#define jffs2_can_mark_obsolete(c) (0)
74#else
75#define jffs2_can_mark_obsolete(c) (1)
76#endif
77
78#define jffs2_is_writebuffered(c) (0)
79#define jffs2_cleanmarker_oob(c) (0)
80#define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
81
82#define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
83#define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
84#define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
85#define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
86#define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
87#define jffs2_nand_flash_setup(c) (0)
88#define jffs2_nand_flash_cleanup(c) do {} while(0)
89#define jffs2_wbuf_dirty(c) (0)
90#define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
91#define jffs2_wbuf_timeout NULL
92#define jffs2_wbuf_process NULL
93#define jffs2_dataflash(c) (0)
94#define jffs2_dataflash_setup(c) (0)
95#define jffs2_dataflash_cleanup(c) do {} while (0)
96#define jffs2_nor_wbuf_flash(c) (0)
97#define jffs2_nor_wbuf_flash_setup(c) (0)
98#define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
99#define jffs2_ubivol(c) (0)
100#define jffs2_ubivol_setup(c) (0)
101#define jffs2_ubivol_cleanup(c) do {} while (0)
102
103#else /* NAND and/or ECC'd NOR support present */
104
105#define jffs2_is_writebuffered(c) (c->wbuf != NULL)
106
107#ifdef CONFIG_JFFS2_SUMMARY
108#define jffs2_can_mark_obsolete(c) (0)
109#else
110#define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
111#endif
112
113#define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)
114
115#define jffs2_flash_write_oob(c, ofs, len, retlen, buf) ((c)->mtd->write_oob((c)->mtd, ofs, len, retlen, buf))
116#define jffs2_flash_read_oob(c, ofs, len, retlen, buf) ((c)->mtd->read_oob((c)->mtd, ofs, len, retlen, buf))
117#define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)
118
119/* wbuf.c */
120int jffs2_flash_writev(struct jffs2_sb_info *c, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen, uint32_t ino);
121int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
122int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
123int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
124int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
125int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
126int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
127void jffs2_wbuf_timeout(unsigned long data);
128void jffs2_wbuf_process(void *data);
129int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
130int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
131int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
132void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
133
134#define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
135int jffs2_dataflash_setup(struct jffs2_sb_info *c);
136void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
137#define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
138int jffs2_ubivol_setup(struct jffs2_sb_info *c);
139void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);
140
141#define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
142int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
143void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
144
145#endif /* WRITEBUFFER */
146
147/* erase.c */
148static inline void jffs2_erase_pending_trigger(struct jffs2_sb_info *c)
149{
150	OFNI_BS_2SFFJ(c)->s_dirt = 1;
151}
152
153/* background.c */
154int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
155void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
156void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
157
158/* dir.c */
159extern const struct file_operations jffs2_dir_operations;
160extern const struct inode_operations jffs2_dir_inode_operations;
161
162/* file.c */
163extern const struct file_operations jffs2_file_operations;
164extern const struct inode_operations jffs2_file_inode_operations;
165extern const struct address_space_operations jffs2_file_address_operations;
166int jffs2_fsync(struct file *, struct dentry *, int);
167int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);
168
169/* ioctl.c */
170int jffs2_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
171
172/* symlink.c */
173extern const struct inode_operations jffs2_symlink_inode_operations;
174
175/* fs.c */
176int jffs2_setattr (struct dentry *, struct iattr *);
177void jffs2_read_inode (struct inode *);
178void jffs2_clear_inode (struct inode *);
179void jffs2_dirty_inode(struct inode *inode);
180struct inode *jffs2_new_inode (struct inode *dir_i, int mode,
181			       struct jffs2_raw_inode *ri);
182int jffs2_statfs (struct dentry *, struct kstatfs *);
183void jffs2_write_super (struct super_block *);
184int jffs2_remount_fs (struct super_block *, int *, char *);
185int jffs2_do_fill_super(struct super_block *sb, void *data, int silent);
186void jffs2_gc_release_inode(struct jffs2_sb_info *c,
187			    struct jffs2_inode_info *f);
188struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
189					      int inum, int nlink);
190
191unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
192				   struct jffs2_inode_info *f,
193				   unsigned long offset,
194				   unsigned long *priv);
195void jffs2_gc_release_page(struct jffs2_sb_info *c,
196			   unsigned char *pg,
197			   unsigned long *priv);
198void jffs2_flash_cleanup(struct jffs2_sb_info *c);
199
200
201/* writev.c */
202int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
203		       unsigned long count, loff_t to, size_t *retlen);
204int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
205			size_t *retlen, const u_char *buf);
206
207#endif /* __JFFS2_OS_LINUX_H__ */
208