11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds * JFFS2 -- Journalling Flash File System, Version 2.
31da177e4SLinus Torvalds *
4c00c310eSDavid Woodhouse * Copyright © 2001-2007 Red Hat, Inc.
51da177e4SLinus Torvalds *
61da177e4SLinus Torvalds * Created by David Woodhouse <dwmw2@infradead.org>
71da177e4SLinus Torvalds *
81da177e4SLinus Torvalds * For licensing information, see the file 'LICENCE' in this directory.
91da177e4SLinus Torvalds *
101da177e4SLinus Torvalds */
111da177e4SLinus Torvalds
121da177e4SLinus Torvalds #ifndef __JFFS2_OS_LINUX_H__
131da177e4SLinus Torvalds #define __JFFS2_OS_LINUX_H__
141da177e4SLinus Torvalds
151da177e4SLinus Torvalds /* JFFS2 uses Linux mode bits natively -- no need for conversion */
161da177e4SLinus Torvalds #define os_to_jffs2_mode(x) (x)
171da177e4SLinus Torvalds #define jffs2_to_os_mode(x) (x)
181da177e4SLinus Torvalds
191da177e4SLinus Torvalds struct kstatfs;
201da177e4SLinus Torvalds struct kvec;
211da177e4SLinus Torvalds
22db6172c4SRasmus Villemoes #define JFFS2_INODE_INFO(i) (container_of(i, struct jffs2_inode_info, vfs_inode))
231da177e4SLinus Torvalds #define OFNI_EDONI_2SFFJ(f) (&(f)->vfs_inode)
241da177e4SLinus Torvalds #define JFFS2_SB_INFO(sb) (sb->s_fs_info)
251da177e4SLinus Torvalds #define OFNI_BS_2SFFJ(c) ((struct super_block *)c->os_priv)
261da177e4SLinus Torvalds
271da177e4SLinus Torvalds
281da177e4SLinus Torvalds #define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size)
291da177e4SLinus Torvalds #define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode)
300cfe53d3SEric W. Biederman #define JFFS2_F_I_UID(f) (i_uid_read(OFNI_EDONI_2SFFJ(f)))
310cfe53d3SEric W. Biederman #define JFFS2_F_I_GID(f) (i_gid_read(OFNI_EDONI_2SFFJ(f)))
32aef9ab47SDavid Woodhouse #define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)
331da177e4SLinus Torvalds
345f7a01e2SArnd Bergmann #define JFFS2_CLAMP_TIME(t) ((uint32_t)clamp_t(time64_t, (t), 0, U32_MAX))
355f7a01e2SArnd Bergmann #define ITIME(sec) ((struct timespec64){sec, 0})
365f7a01e2SArnd Bergmann #define JFFS2_NOW() JFFS2_CLAMP_TIME(ktime_get_real_seconds())
375f7a01e2SArnd Bergmann #define I_SEC(tv) JFFS2_CLAMP_TIME((tv).tv_sec)
38*d8b23c61SJeff Layton #define JFFS2_F_I_CTIME(f) I_SEC(inode_get_ctime(OFNI_EDONI_2SFFJ(f)))
395f7a01e2SArnd Bergmann #define JFFS2_F_I_MTIME(f) I_SEC(OFNI_EDONI_2SFFJ(f)->i_mtime)
405f7a01e2SArnd Bergmann #define JFFS2_F_I_ATIME(f) I_SEC(OFNI_EDONI_2SFFJ(f)->i_atime)
411da177e4SLinus Torvalds #define sleep_on_spinunlock(wq, s) \
421da177e4SLinus Torvalds do { \
431da177e4SLinus Torvalds DECLARE_WAITQUEUE(__wait, current); \
441da177e4SLinus Torvalds add_wait_queue((wq), &__wait); \
451da177e4SLinus Torvalds set_current_state(TASK_UNINTERRUPTIBLE); \
461da177e4SLinus Torvalds spin_unlock(s); \
471da177e4SLinus Torvalds schedule(); \
481da177e4SLinus Torvalds remove_wait_queue((wq), &__wait); \
491da177e4SLinus Torvalds } while(0)
501da177e4SLinus Torvalds
jffs2_init_inode_info(struct jffs2_inode_info * f)511da177e4SLinus Torvalds static inline void jffs2_init_inode_info(struct jffs2_inode_info *f)
521da177e4SLinus Torvalds {
531da177e4SLinus Torvalds f->highest_version = 0;
541da177e4SLinus Torvalds f->fragtree = RB_ROOT;
551da177e4SLinus Torvalds f->metadata = NULL;
561da177e4SLinus Torvalds f->dents = NULL;
572b79adccSArtem B. Bityutskiy f->target = NULL;
581da177e4SLinus Torvalds f->flags = 0;
591da177e4SLinus Torvalds f->usercompr = 0;
601da177e4SLinus Torvalds }
611da177e4SLinus Torvalds
623be36675SAndrew Victor
631751e8a6SLinus Torvalds #define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & SB_RDONLY)
641da177e4SLinus Torvalds
65daba5cc4SArtem B. Bityutskiy #define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
662f82ce1eSAndrew Victor #ifndef CONFIG_JFFS2_FS_WRITEBUFFER
67daba5cc4SArtem B. Bityutskiy
68e631ddbaSFerenc Havasi
69e631ddbaSFerenc Havasi #ifdef CONFIG_JFFS2_SUMMARY
70e631ddbaSFerenc Havasi #define jffs2_can_mark_obsolete(c) (0)
71e631ddbaSFerenc Havasi #else
721da177e4SLinus Torvalds #define jffs2_can_mark_obsolete(c) (1)
73e631ddbaSFerenc Havasi #endif
74e631ddbaSFerenc Havasi
758cd79216SArtem B. Bityuckiy #define jffs2_is_writebuffered(c) (0)
761da177e4SLinus Torvalds #define jffs2_cleanmarker_oob(c) (0)
771da177e4SLinus Torvalds #define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
781da177e4SLinus Torvalds
79e631ddbaSFerenc Havasi #define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
80a6c22850SBrian Norris #define jffs2_flash_read(c, ofs, len, retlen, buf) (mtd_read((c)->mtd, ofs, len, retlen, buf))
81733802d9SArtem B. Bityutskiy #define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
82733802d9SArtem B. Bityutskiy #define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
831da177e4SLinus Torvalds #define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
841da177e4SLinus Torvalds #define jffs2_nand_flash_setup(c) (0)
851da177e4SLinus Torvalds #define jffs2_nand_flash_cleanup(c) do {} while(0)
861da177e4SLinus Torvalds #define jffs2_wbuf_dirty(c) (0)
871da177e4SLinus Torvalds #define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
881da177e4SLinus Torvalds #define jffs2_wbuf_timeout NULL
891da177e4SLinus Torvalds #define jffs2_wbuf_process NULL
908f15fd55SAndrew Victor #define jffs2_dataflash(c) (0)
91751382ddSTodd Poynor #define jffs2_dataflash_setup(c) (0)
92751382ddSTodd Poynor #define jffs2_dataflash_cleanup(c) do {} while (0)
939bfeb691SDavid Woodhouse #define jffs2_nor_wbuf_flash(c) (0)
9459da721aSNicolas Pitre #define jffs2_nor_wbuf_flash_setup(c) (0)
9559da721aSNicolas Pitre #define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
960029da3bSArtem Bityutskiy #define jffs2_ubivol(c) (0)
970029da3bSArtem Bityutskiy #define jffs2_ubivol_setup(c) (0)
980029da3bSArtem Bityutskiy #define jffs2_ubivol_cleanup(c) do {} while (0)
998bdc81c5SArtem Bityutskiy #define jffs2_dirty_trigger(c) do {} while (0)
1001da177e4SLinus Torvalds
1011da177e4SLinus Torvalds #else /* NAND and/or ECC'd NOR support present */
1021da177e4SLinus Torvalds
1038cd79216SArtem B. Bityuckiy #define jffs2_is_writebuffered(c) (c->wbuf != NULL)
104e631ddbaSFerenc Havasi
105e631ddbaSFerenc Havasi #ifdef CONFIG_JFFS2_SUMMARY
106e631ddbaSFerenc Havasi #define jffs2_can_mark_obsolete(c) (0)
107e631ddbaSFerenc Havasi #else
1085fa43394SJoern Engel #define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
109e631ddbaSFerenc Havasi #endif
110e631ddbaSFerenc Havasi
1111da177e4SLinus Torvalds #define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)
1121da177e4SLinus Torvalds
1131da177e4SLinus Torvalds #define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)
1141da177e4SLinus Torvalds
1151da177e4SLinus Torvalds /* wbuf.c */
1161da177e4SLinus Torvalds 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);
1171da177e4SLinus Torvalds int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
1181da177e4SLinus Torvalds int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
1191da177e4SLinus Torvalds int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
1201da177e4SLinus Torvalds int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
1211da177e4SLinus Torvalds int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
1221da177e4SLinus Torvalds int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
1231da177e4SLinus Torvalds void jffs2_wbuf_timeout(unsigned long data);
1241da177e4SLinus Torvalds void jffs2_wbuf_process(void *data);
1251da177e4SLinus Torvalds int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
1261da177e4SLinus Torvalds int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
1271da177e4SLinus Torvalds int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
1281da177e4SLinus Torvalds void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
1292f82ce1eSAndrew Victor
1308f15fd55SAndrew Victor #define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
1318f15fd55SAndrew Victor int jffs2_dataflash_setup(struct jffs2_sb_info *c);
1328f15fd55SAndrew Victor void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
1330029da3bSArtem Bityutskiy #define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
1340029da3bSArtem Bityutskiy int jffs2_ubivol_setup(struct jffs2_sb_info *c);
1350029da3bSArtem Bityutskiy void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);
1362f82ce1eSAndrew Victor
1375fa43394SJoern Engel #define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
13859da721aSNicolas Pitre int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
13959da721aSNicolas Pitre void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
1408bdc81c5SArtem Bityutskiy void jffs2_dirty_trigger(struct jffs2_sb_info *c);
14159da721aSNicolas Pitre
1422f82ce1eSAndrew Victor #endif /* WRITEBUFFER */
1431da177e4SLinus Torvalds
1441da177e4SLinus Torvalds /* background.c */
1451da177e4SLinus Torvalds int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
1461da177e4SLinus Torvalds void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
1471da177e4SLinus Torvalds void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
1481da177e4SLinus Torvalds
1491da177e4SLinus Torvalds /* dir.c */
1504b6f5d20SArjan van de Ven extern const struct file_operations jffs2_dir_operations;
15192e1d5beSArjan van de Ven extern const struct inode_operations jffs2_dir_inode_operations;
1521da177e4SLinus Torvalds
1531da177e4SLinus Torvalds /* file.c */
1544b6f5d20SArjan van de Ven extern const struct file_operations jffs2_file_operations;
15592e1d5beSArjan van de Ven extern const struct inode_operations jffs2_file_inode_operations;
156f5e54d6eSChristoph Hellwig extern const struct address_space_operations jffs2_file_address_operations;
15702c24a82SJosef Bacik int jffs2_fsync(struct file *, loff_t, loff_t, int);
158e9b5b23eSMatthew Wilcox (Oracle) int __jffs2_read_folio(struct file *file, struct folio *folio);
1591da177e4SLinus Torvalds
1601da177e4SLinus Torvalds /* ioctl.c */
1610533400bSStoyan Gaydarov long jffs2_ioctl(struct file *, unsigned int, unsigned long);
1621da177e4SLinus Torvalds
1631da177e4SLinus Torvalds /* symlink.c */
16492e1d5beSArjan van de Ven extern const struct inode_operations jffs2_symlink_inode_operations;
1651da177e4SLinus Torvalds
1661da177e4SLinus Torvalds /* fs.c */
167c1632a0fSChristian Brauner int jffs2_setattr (struct mnt_idmap *, struct dentry *, struct iattr *);
1689ed437c5SDavid Woodhouse int jffs2_do_setattr (struct inode *, struct iattr *);
1695451f79fSDavid Howells struct inode *jffs2_iget(struct super_block *, unsigned long);
170b57922d9SAl Viro void jffs2_evict_inode (struct inode *);
171aa385729SChristoph Hellwig void jffs2_dirty_inode(struct inode *inode, int flags);
172d3fb6120SAl Viro struct inode *jffs2_new_inode (struct inode *dir_i, umode_t mode,
173cfc8dc6fSKaiGai Kohei struct jffs2_raw_inode *ri);
174726c3342SDavid Howells int jffs2_statfs (struct dentry *, struct kstatfs *);
175ec10a24fSDavid Howells int jffs2_do_remount_fs(struct super_block *sb, struct fs_context *fc);
176ec10a24fSDavid Howells int jffs2_do_fill_super(struct super_block *sb, struct fs_context *fc);
1771da177e4SLinus Torvalds void jffs2_gc_release_inode(struct jffs2_sb_info *c,
1781da177e4SLinus Torvalds struct jffs2_inode_info *f);
1791da177e4SLinus Torvalds struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
1801b690b48SDavid Woodhouse int inum, int unlinked);
1811da177e4SLinus Torvalds
1821da177e4SLinus Torvalds unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
1831da177e4SLinus Torvalds struct jffs2_inode_info *f,
1841da177e4SLinus Torvalds unsigned long offset,
1851da177e4SLinus Torvalds unsigned long *priv);
1861da177e4SLinus Torvalds void jffs2_flash_cleanup(struct jffs2_sb_info *c);
1871da177e4SLinus Torvalds
1881da177e4SLinus Torvalds
1891da177e4SLinus Torvalds /* writev.c */
1901da177e4SLinus Torvalds int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
1911da177e4SLinus Torvalds unsigned long count, loff_t to, size_t *retlen);
192e631ddbaSFerenc Havasi int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
193e631ddbaSFerenc Havasi size_t *retlen, const u_char *buf);
1941da177e4SLinus Torvalds
1951da177e4SLinus Torvalds #endif /* __JFFS2_OS_LINUX_H__ */
1961da177e4SLinus Torvalds
1971da177e4SLinus Torvalds
198