[linux.git] / fs / jffs2 / os-linux.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright © 2001-2007 Red Hat, Inc.
 *
 * Created by David Woodhouse <[email protected]>
 *
 * For licensing information, see the file 'LICENCE' in this directory.
 *
 */

#ifndef __JFFS2_OS_LINUX_H__
#define __JFFS2_OS_LINUX_H__

/* JFFS2 uses Linux mode bits natively -- no need for conversion */
#define os_to_jffs2_mode(x) (x)
#define jffs2_to_os_mode(x) (x)

struct kstatfs;
struct kvec;

#define JFFS2_INODE_INFO(i) (list_entry(i, struct jffs2_inode_info, vfs_inode))
#define OFNI_EDONI_2SFFJ(f)  (&(f)->vfs_inode)
#define JFFS2_SB_INFO(sb) (sb->s_fs_info)
#define OFNI_BS_2SFFJ(c)  ((struct super_block *)c->os_priv)


#define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size)
#define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode)
#define JFFS2_F_I_UID(f) (OFNI_EDONI_2SFFJ(f)->i_uid)
#define JFFS2_F_I_GID(f) (OFNI_EDONI_2SFFJ(f)->i_gid)
#define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)

#define ITIME(sec) ((struct timespec){sec, 0})
#define I_SEC(tv) ((tv).tv_sec)
#define JFFS2_F_I_CTIME(f) (OFNI_EDONI_2SFFJ(f)->i_ctime.tv_sec)
#define JFFS2_F_I_MTIME(f) (OFNI_EDONI_2SFFJ(f)->i_mtime.tv_sec)
#define JFFS2_F_I_ATIME(f) (OFNI_EDONI_2SFFJ(f)->i_atime.tv_sec)

#define sleep_on_spinunlock(wq, s)				\
	do {							\
		DECLARE_WAITQUEUE(__wait, current);		\
		add_wait_queue((wq), &__wait);			\
		set_current_state(TASK_UNINTERRUPTIBLE);	\
		spin_unlock(s);					\
		schedule();					\
		remove_wait_queue((wq), &__wait);		\
	} while(0)

static inline void jffs2_init_inode_info(struct jffs2_inode_info *f)
{
	f->highest_version = 0;
	f->fragtree = RB_ROOT;
	f->metadata = NULL;
	f->dents = NULL;
	f->target = NULL;
	f->flags = 0;
	f->usercompr = 0;
}


#define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)

#define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
#ifndef CONFIG_JFFS2_FS_WRITEBUFFER


#ifdef CONFIG_JFFS2_SUMMARY
#define jffs2_can_mark_obsolete(c) (0)
#else
#define jffs2_can_mark_obsolete(c) (1)
#endif

#define jffs2_is_writebuffered(c) (0)
#define jffs2_cleanmarker_oob(c) (0)
#define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)

#define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
#define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
#define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
#define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
#define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
#define jffs2_nand_flash_setup(c) (0)
#define jffs2_nand_flash_cleanup(c) do {} while(0)
#define jffs2_wbuf_dirty(c) (0)
#define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
#define jffs2_wbuf_timeout NULL
#define jffs2_wbuf_process NULL
#define jffs2_dataflash(c) (0)
#define jffs2_dataflash_setup(c) (0)
#define jffs2_dataflash_cleanup(c) do {} while (0)
#define jffs2_nor_wbuf_flash(c) (0)
#define jffs2_nor_wbuf_flash_setup(c) (0)
#define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
#define jffs2_ubivol(c) (0)
#define jffs2_ubivol_setup(c) (0)
#define jffs2_ubivol_cleanup(c) do {} while (0)

#else /* NAND and/or ECC'd NOR support present */

#define jffs2_is_writebuffered(c) (c->wbuf != NULL)

#ifdef CONFIG_JFFS2_SUMMARY
#define jffs2_can_mark_obsolete(c) (0)
#else
#define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
#endif

#define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)

#define jffs2_flash_write_oob(c, ofs, len, retlen, buf) ((c)->mtd->write_oob((c)->mtd, ofs, len, retlen, buf))
#define jffs2_flash_read_oob(c, ofs, len, retlen, buf) ((c)->mtd->read_oob((c)->mtd, ofs, len, retlen, buf))
#define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)

/* wbuf.c */
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);
int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
void jffs2_wbuf_timeout(unsigned long data);
void jffs2_wbuf_process(void *data);
int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);

#define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
int jffs2_dataflash_setup(struct jffs2_sb_info *c);
void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
#define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
int jffs2_ubivol_setup(struct jffs2_sb_info *c);
void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);

#define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);

#endif /* WRITEBUFFER */

/* erase.c */
static inline void jffs2_erase_pending_trigger(struct jffs2_sb_info *c)
{
	OFNI_BS_2SFFJ(c)->s_dirt = 1;
}

/* background.c */
int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);

/* dir.c */
extern const struct file_operations jffs2_dir_operations;
extern const struct inode_operations jffs2_dir_inode_operations;

/* file.c */
extern const struct file_operations jffs2_file_operations;
extern const struct inode_operations jffs2_file_inode_operations;
extern const struct address_space_operations jffs2_file_address_operations;
int jffs2_fsync(struct file *, struct dentry *, int);
int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg);

/* ioctl.c */
long jffs2_ioctl(struct file *, unsigned int, unsigned long);

/* symlink.c */
extern const struct inode_operations jffs2_symlink_inode_operations;

/* fs.c */
int jffs2_setattr (struct dentry *, struct iattr *);
int jffs2_do_setattr (struct inode *, struct iattr *);
struct inode *jffs2_iget(struct super_block *, unsigned long);
void jffs2_clear_inode (struct inode *);
void jffs2_dirty_inode(struct inode *inode);
struct inode *jffs2_new_inode (struct inode *dir_i, int mode,
			       struct jffs2_raw_inode *ri);
int jffs2_statfs (struct dentry *, struct kstatfs *);
int jffs2_remount_fs (struct super_block *, int *, char *);
int jffs2_do_fill_super(struct super_block *sb, void *data, int silent);
void jffs2_gc_release_inode(struct jffs2_sb_info *c,
			    struct jffs2_inode_info *f);
struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
					      int inum, int unlinked);

unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
				   struct jffs2_inode_info *f,
				   unsigned long offset,
				   unsigned long *priv);
void jffs2_gc_release_page(struct jffs2_sb_info *c,
			   unsigned char *pg,
			   unsigned long *priv);
void jffs2_flash_cleanup(struct jffs2_sb_info *c);


/* writev.c */
int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
		       unsigned long count, loff_t to, size_t *retlen);
int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
			size_t *retlen, const u_char *buf);

#endif /* __JFFS2_OS_LINUX_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* JFFS2 -- Journalling Flash File System, Version 2.
	3	*
c00c310e	4	* Copyright © 2001-2007 Red Hat, Inc.
1da177e4 LT	5	*
	6	* Created by David Woodhouse <[email protected]>
	7	*
	8	* For licensing information, see the file 'LICENCE' in this directory.
	9	*
1da177e4 LT	10	*/
	11
	12	#ifndef __JFFS2_OS_LINUX_H__
	13	#define __JFFS2_OS_LINUX_H__
1da177e4 LT	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
1da177e4 LT	19	struct kstatfs;
	20	struct kvec;
	21
1da177e4 LT	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)
1da177e4 LT	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)
aef9ab47	32	#define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)
1da177e4	33
1da177e4 LT	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)
1da177e4 LT	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	{
1da177e4 LT	52	f->highest_version = 0;
	53	f->fragtree = RB_ROOT;
	54	f->metadata = NULL;
	55	f->dents = NULL;
2b79adcc	56	f->target = NULL;
1da177e4 LT	57	f->flags = 0;
1da177e4 LT	58	f->usercompr = 0;
1da177e4 LT	59	}
1da177e4 LT	60
3be36675	61
1da177e4 LT	62	#define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY)
1da177e4 LT	63
daba5cc4	64	#define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
2f82ce1e	65	#ifndef CONFIG_JFFS2_FS_WRITEBUFFER
daba5cc4	66
e631ddba FH	67
	68	#ifdef CONFIG_JFFS2_SUMMARY
	69	#define jffs2_can_mark_obsolete(c) (0)
	70	#else
1da177e4	71	#define jffs2_can_mark_obsolete(c) (1)
e631ddba FH	72	#endif
e631ddba FH	73
8cd79216	74	#define jffs2_is_writebuffered(c) (0)
1da177e4 LT	75	#define jffs2_cleanmarker_oob(c) (0)
	76	#define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
	77
e631ddba	78	#define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
1da177e4	79	#define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf))
733802d9 AB	80	#define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
733802d9 AB	81	#define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
1da177e4 LT	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
8f15fd55	89	#define jffs2_dataflash(c) (0)
751382dd TP	90	#define jffs2_dataflash_setup(c) (0)
751382dd TP	91	#define jffs2_dataflash_cleanup(c) do {} while (0)
9bfeb691	92	#define jffs2_nor_wbuf_flash(c) (0)
59da721a NP	93	#define jffs2_nor_wbuf_flash_setup(c) (0)
59da721a NP	94	#define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
0029da3b AB	95	#define jffs2_ubivol(c) (0)
	96	#define jffs2_ubivol_setup(c) (0)
	97	#define jffs2_ubivol_cleanup(c) do {} while (0)
1da177e4 LT	98
	99	#else /* NAND and/or ECC'd NOR support present */
	100
8cd79216	101	#define jffs2_is_writebuffered(c) (c->wbuf != NULL)
e631ddba FH	102
	103	#ifdef CONFIG_JFFS2_SUMMARY
	104	#define jffs2_can_mark_obsolete(c) (0)
	105	#else
5fa43394	106	#define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
e631ddba FH	107	#endif
e631ddba FH	108
1da177e4 LT	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);
2f82ce1e	129
8f15fd55 AV	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);
0029da3b AB	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);
2f82ce1e	136
5fa43394	137	#define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
59da721a NP	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
2f82ce1e	141	#endif /* WRITEBUFFER */
1da177e4 LT	142
	143	/* erase.c */
	144	static inline void jffs2_erase_pending_trigger(struct jffs2_sb_info *c)
	145	{
	146	OFNI_BS_2SFFJ(c)->s_dirt = 1;
	147	}
	148
	149	/* background.c */
	150	int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
	151	void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
	152	void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
	153
	154	/* dir.c */
4b6f5d20	155	extern const struct file_operations jffs2_dir_operations;
92e1d5be	156	extern const struct inode_operations jffs2_dir_inode_operations;
1da177e4 LT	157
1da177e4 LT	158	/* file.c */
4b6f5d20	159	extern const struct file_operations jffs2_file_operations;
92e1d5be	160	extern const struct inode_operations jffs2_file_inode_operations;
f5e54d6e	161	extern const struct address_space_operations jffs2_file_address_operations;
1da177e4 LT	162	int jffs2_fsync(struct file , struct dentry , int);
	163	int jffs2_do_readpage_unlock (struct inode inode, struct page pg);
	164
	165	/* ioctl.c */
0533400b	166	long jffs2_ioctl(struct file *, unsigned int, unsigned long);
1da177e4 LT	167
1da177e4 LT	168	/* symlink.c */
92e1d5be	169	extern const struct inode_operations jffs2_symlink_inode_operations;
1da177e4 LT	170
	171	/* fs.c */
	172	int jffs2_setattr (struct dentry , struct iattr );
9ed437c5	173	int jffs2_do_setattr (struct inode , struct iattr );
5451f79f	174	struct inode jffs2_iget(struct super_block , unsigned long);
1da177e4 LT	175	void jffs2_clear_inode (struct inode *);
	176	void jffs2_dirty_inode(struct inode *inode);
	177	struct inode jffs2_new_inode (struct inode dir_i, int mode,
cfc8dc6f	178	struct jffs2_raw_inode *ri);
726c3342	179	int jffs2_statfs (struct dentry , struct kstatfs );
1da177e4 LT	180	int jffs2_remount_fs (struct super_block , int , char *);
	181	int jffs2_do_fill_super(struct super_block sb, void data, int silent);
	182	void jffs2_gc_release_inode(struct jffs2_sb_info *c,
	183	struct jffs2_inode_info *f);
	184	struct jffs2_inode_info jffs2_gc_fetch_inode(struct jffs2_sb_info c,
1b690b48	185	int inum, int unlinked);
1da177e4	186
182ec4ee TG	187	unsigned char jffs2_gc_fetch_page(struct jffs2_sb_info c,
182ec4ee TG	188	struct jffs2_inode_info *f,
1da177e4 LT	189	unsigned long offset,
	190	unsigned long *priv);
	191	void jffs2_gc_release_page(struct jffs2_sb_info *c,
	192	unsigned char *pg,
	193	unsigned long *priv);
	194	void jffs2_flash_cleanup(struct jffs2_sb_info *c);
182ec4ee	195
1da177e4 LT	196
1da177e4 LT	197	/* writev.c */
182ec4ee	198	int jffs2_flash_direct_writev(struct jffs2_sb_info c, const struct kvec vecs,
1da177e4	199	unsigned long count, loff_t to, size_t *retlen);
e631ddba FH	200	int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
e631ddba FH	201	size_t retlen, const u_char buf);
1da177e4 LT	202
	203	#endif /* __JFFS2_OS_LINUX_H__ */
	204
	205