blob: 80daea96bbc29207ceae517787b1c670c47b6034 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
David Woodhousec00c3102007-04-25 14:16:47 +01004 * Copyright © 2001-2007 Red Hat, Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Created by David Woodhouse <dwmw2@infradead.org>
7 *
8 * For licensing information, see the file 'LICENCE' in this directory.
9 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
12#ifndef __JFFS2_OS_LINUX_H__
13#define __JFFS2_OS_LINUX_H__
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070019struct kstatfs;
20struct kvec;
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
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)
David Woodhouseaef9ab42006-05-19 00:28:49 +010032#define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
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{
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 f->highest_version = 0;
53 f->fragtree = RB_ROOT;
54 f->metadata = NULL;
55 f->dents = NULL;
Artem B. Bityutskiy2b79adc2005-07-17 12:13:51 +010056 f->target = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 f->flags = 0;
58 f->usercompr = 0;
KaiGai Koheiaa98d7c2006-05-13 15:09:47 +090059#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070063}
64
Andrew Victor3be36672005-02-09 09:09:05 +000065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Artem B. Bityutskiydaba5cc2005-09-30 14:59:17 +010068#define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
Andrew Victor2f82ce12005-02-09 09:24:26 +000069#ifndef CONFIG_JFFS2_FS_WRITEBUFFER
Artem B. Bityutskiydaba5cc2005-09-30 14:59:17 +010070
Ferenc Havasie631ddb2005-09-07 09:35:26 +010071
72#ifdef CONFIG_JFFS2_SUMMARY
73#define jffs2_can_mark_obsolete(c) (0)
74#else
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#define jffs2_can_mark_obsolete(c) (1)
Ferenc Havasie631ddb2005-09-07 09:35:26 +010076#endif
77
Artem B. Bityuckiy8cd79212005-05-03 16:19:02 +010078#define jffs2_is_writebuffered(c) (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#define jffs2_cleanmarker_oob(c) (0)
80#define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
81
Ferenc Havasie631ddb2005-09-07 09:35:26 +010082#define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
Artem B. Bityutskiy733802d2005-09-22 12:25:00 +010084#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; })
Linus Torvalds1da177e2005-04-16 15:20:36 -070086#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
Andrew Victor8f15fd52005-02-09 09:17:45 +000093#define jffs2_dataflash(c) (0)
Todd Poynor751382d2005-07-12 03:34:39 +010094#define jffs2_dataflash_setup(c) (0)
95#define jffs2_dataflash_cleanup(c) do {} while (0)
David Woodhouse9bfeb692006-05-26 21:19:05 +010096#define jffs2_nor_wbuf_flash(c) (0)
Nicolas Pitre59da7212005-08-06 05:51:33 +010097#define jffs2_nor_wbuf_flash_setup(c) (0)
98#define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
Artem Bityutskiy0029da32006-10-04 19:15:21 +030099#define jffs2_ubivol(c) (0)
100#define jffs2_ubivol_setup(c) (0)
101#define jffs2_ubivol_cleanup(c) do {} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103#else /* NAND and/or ECC'd NOR support present */
104
Artem B. Bityuckiy8cd79212005-05-03 16:19:02 +0100105#define jffs2_is_writebuffered(c) (c->wbuf != NULL)
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100106
107#ifdef CONFIG_JFFS2_SUMMARY
108#define jffs2_can_mark_obsolete(c) (0)
109#else
Joern Engel5fa43392006-05-22 23:18:29 +0200110#define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100111#endif
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#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);
Andrew Victor2f82ce12005-02-09 09:24:26 +0000133
Andrew Victor8f15fd52005-02-09 09:17:45 +0000134#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);
Artem Bityutskiy0029da32006-10-04 19:15:21 +0300137#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);
Andrew Victor2f82ce12005-02-09 09:24:26 +0000140
Joern Engel5fa43392006-05-22 23:18:29 +0200141#define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
Nicolas Pitre59da7212005-08-06 05:51:33 +0100142int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
143void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
144
Andrew Victor2f82ce12005-02-09 09:24:26 +0000145#endif /* WRITEBUFFER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
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 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800159extern const struct file_operations jffs2_dir_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800160extern const struct inode_operations jffs2_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162/* file.c */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800163extern const struct file_operations jffs2_file_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800164extern const struct inode_operations jffs2_file_inode_operations;
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700165extern const struct address_space_operations jffs2_file_address_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166int 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 */
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800173extern const struct inode_operations jffs2_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
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);
David Howells726c3342006-06-23 02:02:58 -0700182int jffs2_statfs (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183void 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
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000191unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
192 struct jffs2_inode_info *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 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);
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201/* writev.c */
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000202int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 unsigned long count, loff_t to, size_t *retlen);
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100204int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
205 size_t *retlen, const u_char *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207#endif /* __JFFS2_OS_LINUX_H__ */
208
209