blob: 4791aacf30849d93ef8ff6875b0c41c651d3c204 [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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059}
60
Andrew Victor3be36672005-02-09 09:09:05 +000061
Linus Torvalds1da177e2005-04-16 15:20:36 -070062#define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Artem B. Bityutskiydaba5cc2005-09-30 14:59:17 +010064#define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
Andrew Victor2f82ce12005-02-09 09:24:26 +000065#ifndef CONFIG_JFFS2_FS_WRITEBUFFER
Artem B. Bityutskiydaba5cc2005-09-30 14:59:17 +010066
Ferenc Havasie631ddb2005-09-07 09:35:26 +010067
68#ifdef CONFIG_JFFS2_SUMMARY
69#define jffs2_can_mark_obsolete(c) (0)
70#else
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#define jffs2_can_mark_obsolete(c) (1)
Ferenc Havasie631ddb2005-09-07 09:35:26 +010072#endif
73
Artem B. Bityuckiy8cd79212005-05-03 16:19:02 +010074#define jffs2_is_writebuffered(c) (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#define jffs2_cleanmarker_oob(c) (0)
76#define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
77
Ferenc Havasie631ddb2005-09-07 09:35:26 +010078#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 -070079#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 +010080#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; })
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#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
Andrew Victor8f15fd52005-02-09 09:17:45 +000089#define jffs2_dataflash(c) (0)
Todd Poynor751382d2005-07-12 03:34:39 +010090#define jffs2_dataflash_setup(c) (0)
91#define jffs2_dataflash_cleanup(c) do {} while (0)
David Woodhouse9bfeb692006-05-26 21:19:05 +010092#define jffs2_nor_wbuf_flash(c) (0)
Nicolas Pitre59da7212005-08-06 05:51:33 +010093#define jffs2_nor_wbuf_flash_setup(c) (0)
94#define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
Artem Bityutskiy0029da32006-10-04 19:15:21 +030095#define jffs2_ubivol(c) (0)
96#define jffs2_ubivol_setup(c) (0)
97#define jffs2_ubivol_cleanup(c) do {} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99#else /* NAND and/or ECC'd NOR support present */
100
Artem B. Bityuckiy8cd79212005-05-03 16:19:02 +0100101#define jffs2_is_writebuffered(c) (c->wbuf != NULL)
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100102
103#ifdef CONFIG_JFFS2_SUMMARY
104#define jffs2_can_mark_obsolete(c) (0)
105#else
Joern Engel5fa43392006-05-22 23:18:29 +0200106#define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100107#endif
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#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 */
116int jffs2_flash_writev(struct jffs2_sb_info *c, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen, uint32_t ino);
117int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
118int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
119int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
120int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
121int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
122int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
123void jffs2_wbuf_timeout(unsigned long data);
124void jffs2_wbuf_process(void *data);
125int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
126int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
127int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
128void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
Andrew Victor2f82ce12005-02-09 09:24:26 +0000129
Andrew Victor8f15fd52005-02-09 09:17:45 +0000130#define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
131int jffs2_dataflash_setup(struct jffs2_sb_info *c);
132void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
Artem Bityutskiy0029da32006-10-04 19:15:21 +0300133#define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
134int jffs2_ubivol_setup(struct jffs2_sb_info *c);
135void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);
Andrew Victor2f82ce12005-02-09 09:24:26 +0000136
Joern Engel5fa43392006-05-22 23:18:29 +0200137#define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
Nicolas Pitre59da7212005-08-06 05:51:33 +0100138int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
139void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
140
Andrew Victor2f82ce12005-02-09 09:24:26 +0000141#endif /* WRITEBUFFER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Joakim Tjernlund64a5c2e2010-05-19 17:13:19 +0100143static inline void jffs2_dirty_trigger(struct jffs2_sb_info *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
145 OFNI_BS_2SFFJ(c)->s_dirt = 1;
146}
147
148/* background.c */
149int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
150void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
151void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
152
153/* dir.c */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800154extern const struct file_operations jffs2_dir_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800155extern const struct inode_operations jffs2_dir_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157/* file.c */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800158extern const struct file_operations jffs2_file_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800159extern const struct inode_operations jffs2_file_inode_operations;
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700160extern const struct address_space_operations jffs2_file_address_operations;
Christoph Hellwig7ea80852010-05-26 17:53:25 +0200161int jffs2_fsync(struct file *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);
163
164/* ioctl.c */
Stoyan Gaydarov05334002008-07-07 07:45:59 -0500165long jffs2_ioctl(struct file *, unsigned int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167/* symlink.c */
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800168extern const struct inode_operations jffs2_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170/* fs.c */
171int jffs2_setattr (struct dentry *, struct iattr *);
David Woodhouse9ed437c2007-08-22 12:39:19 +0100172int jffs2_do_setattr (struct inode *, struct iattr *);
David Howells5451f792008-02-07 00:15:42 -0800173struct inode *jffs2_iget(struct super_block *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174void jffs2_clear_inode (struct inode *);
175void jffs2_dirty_inode(struct inode *inode);
176struct inode *jffs2_new_inode (struct inode *dir_i, int mode,
KaiGai Koheicfc8dc62007-09-14 15:16:35 +0900177 struct jffs2_raw_inode *ri);
David Howells726c3342006-06-23 02:02:58 -0700178int jffs2_statfs (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179int jffs2_remount_fs (struct super_block *, int *, char *);
180int jffs2_do_fill_super(struct super_block *sb, void *data, int silent);
181void jffs2_gc_release_inode(struct jffs2_sb_info *c,
182 struct jffs2_inode_info *f);
183struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
David Woodhouse1b690b42008-05-01 16:59:24 +0100184 int inum, int unlinked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000186unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
187 struct jffs2_inode_info *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 unsigned long offset,
189 unsigned long *priv);
190void jffs2_gc_release_page(struct jffs2_sb_info *c,
191 unsigned char *pg,
192 unsigned long *priv);
193void jffs2_flash_cleanup(struct jffs2_sb_info *c);
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196/* writev.c */
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000197int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 unsigned long count, loff_t to, size_t *retlen);
Ferenc Havasie631ddb2005-09-07 09:35:26 +0100199int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
200 size_t *retlen, const u_char *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202#endif /* __JFFS2_OS_LINUX_H__ */
203
204