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