11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * JFFS2 -- Journalling Flash File System, Version 2. 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (C) 2002-2003 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 * 10733802d9SArtem B. Bityutskiy * $Id: os-linux.h,v 1.63 2005/09/21 11:55:21 dedekind Exp $ 111da177e4SLinus Torvalds * 121da177e4SLinus Torvalds */ 131da177e4SLinus Torvalds 141da177e4SLinus Torvalds #ifndef __JFFS2_OS_LINUX_H__ 151da177e4SLinus Torvalds #define __JFFS2_OS_LINUX_H__ 161da177e4SLinus Torvalds 171da177e4SLinus Torvalds /* JFFS2 uses Linux mode bits natively -- no need for conversion */ 181da177e4SLinus Torvalds #define os_to_jffs2_mode(x) (x) 191da177e4SLinus Torvalds #define jffs2_to_os_mode(x) (x) 201da177e4SLinus Torvalds 211da177e4SLinus Torvalds struct kstatfs; 221da177e4SLinus Torvalds struct kvec; 231da177e4SLinus Torvalds 241da177e4SLinus Torvalds #define JFFS2_INODE_INFO(i) (list_entry(i, struct jffs2_inode_info, vfs_inode)) 251da177e4SLinus Torvalds #define OFNI_EDONI_2SFFJ(f) (&(f)->vfs_inode) 261da177e4SLinus Torvalds #define JFFS2_SB_INFO(sb) (sb->s_fs_info) 271da177e4SLinus Torvalds #define OFNI_BS_2SFFJ(c) ((struct super_block *)c->os_priv) 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds 301da177e4SLinus Torvalds #define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size) 311da177e4SLinus Torvalds #define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode) 321da177e4SLinus Torvalds #define JFFS2_F_I_UID(f) (OFNI_EDONI_2SFFJ(f)->i_uid) 331da177e4SLinus Torvalds #define JFFS2_F_I_GID(f) (OFNI_EDONI_2SFFJ(f)->i_gid) 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds #define JFFS2_F_I_RDEV_MIN(f) (iminor(OFNI_EDONI_2SFFJ(f))) 361da177e4SLinus Torvalds #define JFFS2_F_I_RDEV_MAJ(f) (imajor(OFNI_EDONI_2SFFJ(f))) 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds #define ITIME(sec) ((struct timespec){sec, 0}) 391da177e4SLinus Torvalds #define I_SEC(tv) ((tv).tv_sec) 401da177e4SLinus Torvalds #define JFFS2_F_I_CTIME(f) (OFNI_EDONI_2SFFJ(f)->i_ctime.tv_sec) 411da177e4SLinus Torvalds #define JFFS2_F_I_MTIME(f) (OFNI_EDONI_2SFFJ(f)->i_mtime.tv_sec) 421da177e4SLinus Torvalds #define JFFS2_F_I_ATIME(f) (OFNI_EDONI_2SFFJ(f)->i_atime.tv_sec) 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds #define sleep_on_spinunlock(wq, s) \ 451da177e4SLinus Torvalds do { \ 461da177e4SLinus Torvalds DECLARE_WAITQUEUE(__wait, current); \ 471da177e4SLinus Torvalds add_wait_queue((wq), &__wait); \ 481da177e4SLinus Torvalds set_current_state(TASK_UNINTERRUPTIBLE); \ 491da177e4SLinus Torvalds spin_unlock(s); \ 501da177e4SLinus Torvalds schedule(); \ 511da177e4SLinus Torvalds remove_wait_queue((wq), &__wait); \ 521da177e4SLinus Torvalds } while(0) 531da177e4SLinus Torvalds 541da177e4SLinus Torvalds static inline void jffs2_init_inode_info(struct jffs2_inode_info *f) 551da177e4SLinus Torvalds { 561da177e4SLinus Torvalds f->highest_version = 0; 571da177e4SLinus Torvalds f->fragtree = RB_ROOT; 581da177e4SLinus Torvalds f->metadata = NULL; 591da177e4SLinus Torvalds f->dents = NULL; 602b79adccSArtem B. Bityutskiy f->target = NULL; 611da177e4SLinus Torvalds f->flags = 0; 621da177e4SLinus Torvalds f->usercompr = 0; 631da177e4SLinus Torvalds } 641da177e4SLinus Torvalds 653be36675SAndrew Victor 661da177e4SLinus Torvalds #define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & MS_RDONLY) 671da177e4SLinus Torvalds 682f82ce1eSAndrew Victor #ifndef CONFIG_JFFS2_FS_WRITEBUFFER 692f82ce1eSAndrew Victor #define SECTOR_ADDR(x) ( ((unsigned long)(x) & ~(c->sector_size-1)) ) 70e631ddbaSFerenc Havasi 71e631ddbaSFerenc Havasi #ifdef CONFIG_JFFS2_SUMMARY 72e631ddbaSFerenc Havasi #define jffs2_can_mark_obsolete(c) (0) 73e631ddbaSFerenc Havasi #else 741da177e4SLinus Torvalds #define jffs2_can_mark_obsolete(c) (1) 75e631ddbaSFerenc Havasi #endif 76e631ddbaSFerenc Havasi 778cd79216SArtem B. Bityuckiy #define jffs2_is_writebuffered(c) (0) 781da177e4SLinus Torvalds #define jffs2_cleanmarker_oob(c) (0) 791da177e4SLinus Torvalds #define jffs2_write_nand_cleanmarker(c,jeb) (-EIO) 801da177e4SLinus Torvalds 81e631ddbaSFerenc Havasi #define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf) 821da177e4SLinus Torvalds #define jffs2_flash_read(c, ofs, len, retlen, buf) ((c)->mtd->read((c)->mtd, ofs, len, retlen, buf)) 83733802d9SArtem B. Bityutskiy #define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; }) 84733802d9SArtem B. Bityutskiy #define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; }) 851da177e4SLinus Torvalds #define jffs2_write_nand_badblock(c,jeb,bad_offset) (1) 861da177e4SLinus Torvalds #define jffs2_nand_flash_setup(c) (0) 871da177e4SLinus Torvalds #define jffs2_nand_flash_cleanup(c) do {} while(0) 881da177e4SLinus Torvalds #define jffs2_wbuf_dirty(c) (0) 891da177e4SLinus Torvalds #define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e) 901da177e4SLinus Torvalds #define jffs2_wbuf_timeout NULL 911da177e4SLinus Torvalds #define jffs2_wbuf_process NULL 921da177e4SLinus Torvalds #define jffs2_nor_ecc(c) (0) 938f15fd55SAndrew Victor #define jffs2_dataflash(c) (0) 9459da721aSNicolas Pitre #define jffs2_nor_wbuf_flash(c) (0) 951da177e4SLinus Torvalds #define jffs2_nor_ecc_flash_setup(c) (0) 961da177e4SLinus Torvalds #define jffs2_nor_ecc_flash_cleanup(c) do {} while (0) 97751382ddSTodd Poynor #define jffs2_dataflash_setup(c) (0) 98751382ddSTodd Poynor #define jffs2_dataflash_cleanup(c) do {} while (0) 9959da721aSNicolas Pitre #define jffs2_nor_wbuf_flash_setup(c) (0) 10059da721aSNicolas Pitre #define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0) 1011da177e4SLinus Torvalds 1021da177e4SLinus Torvalds #else /* NAND and/or ECC'd NOR support present */ 1031da177e4SLinus Torvalds 1048cd79216SArtem B. Bityuckiy #define jffs2_is_writebuffered(c) (c->wbuf != NULL) 1052f82ce1eSAndrew Victor #define SECTOR_ADDR(x) ( ((unsigned long)(x) / (unsigned long)(c->sector_size)) * c->sector_size ) 106e631ddbaSFerenc Havasi 107e631ddbaSFerenc Havasi #ifdef CONFIG_JFFS2_SUMMARY 108e631ddbaSFerenc Havasi #define jffs2_can_mark_obsolete(c) (0) 109e631ddbaSFerenc Havasi #else 11059da721aSNicolas Pitre #define jffs2_can_mark_obsolete(c) \ 11159da721aSNicolas Pitre ((c->mtd->type == MTD_NORFLASH && !(c->mtd->flags & (MTD_ECC|MTD_PROGRAM_REGIONS))) || \ 11259da721aSNicolas Pitre c->mtd->type == MTD_RAM) 113e631ddbaSFerenc Havasi #endif 114e631ddbaSFerenc Havasi 1151da177e4SLinus Torvalds #define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH) 1161da177e4SLinus Torvalds 1171da177e4SLinus Torvalds #define jffs2_flash_write_oob(c, ofs, len, retlen, buf) ((c)->mtd->write_oob((c)->mtd, ofs, len, retlen, buf)) 1181da177e4SLinus Torvalds #define jffs2_flash_read_oob(c, ofs, len, retlen, buf) ((c)->mtd->read_oob((c)->mtd, ofs, len, retlen, buf)) 1191da177e4SLinus Torvalds #define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len) 1201da177e4SLinus Torvalds 1211da177e4SLinus Torvalds /* wbuf.c */ 1221da177e4SLinus 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); 1231da177e4SLinus Torvalds int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf); 1241da177e4SLinus Torvalds int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf); 1251da177e4SLinus Torvalds int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode); 1261da177e4SLinus Torvalds int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 1271da177e4SLinus Torvalds int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb); 1281da177e4SLinus Torvalds int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset); 1291da177e4SLinus Torvalds void jffs2_wbuf_timeout(unsigned long data); 1301da177e4SLinus Torvalds void jffs2_wbuf_process(void *data); 1311da177e4SLinus Torvalds int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino); 1321da177e4SLinus Torvalds int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c); 1331da177e4SLinus Torvalds int jffs2_nand_flash_setup(struct jffs2_sb_info *c); 1341da177e4SLinus Torvalds void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c); 1352f82ce1eSAndrew Victor 1361da177e4SLinus Torvalds #define jffs2_nor_ecc(c) (c->mtd->type == MTD_NORFLASH && (c->mtd->flags & MTD_ECC)) 1371da177e4SLinus Torvalds int jffs2_nor_ecc_flash_setup(struct jffs2_sb_info *c); 1381da177e4SLinus Torvalds void jffs2_nor_ecc_flash_cleanup(struct jffs2_sb_info *c); 1392f82ce1eSAndrew Victor 1408f15fd55SAndrew Victor #define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH) 1418f15fd55SAndrew Victor int jffs2_dataflash_setup(struct jffs2_sb_info *c); 1428f15fd55SAndrew Victor void jffs2_dataflash_cleanup(struct jffs2_sb_info *c); 1432f82ce1eSAndrew Victor 14459da721aSNicolas Pitre #define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && (c->mtd->flags & MTD_PROGRAM_REGIONS)) 14559da721aSNicolas Pitre int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c); 14659da721aSNicolas Pitre void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c); 14759da721aSNicolas Pitre 1482f82ce1eSAndrew Victor #endif /* WRITEBUFFER */ 1491da177e4SLinus Torvalds 1501da177e4SLinus Torvalds /* erase.c */ 1511da177e4SLinus Torvalds static inline void jffs2_erase_pending_trigger(struct jffs2_sb_info *c) 1521da177e4SLinus Torvalds { 1531da177e4SLinus Torvalds OFNI_BS_2SFFJ(c)->s_dirt = 1; 1541da177e4SLinus Torvalds } 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds /* background.c */ 1571da177e4SLinus Torvalds int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c); 1581da177e4SLinus Torvalds void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c); 1591da177e4SLinus Torvalds void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c); 1601da177e4SLinus Torvalds 1611da177e4SLinus Torvalds /* dir.c */ 1621da177e4SLinus Torvalds extern struct file_operations jffs2_dir_operations; 1631da177e4SLinus Torvalds extern struct inode_operations jffs2_dir_inode_operations; 1641da177e4SLinus Torvalds 1651da177e4SLinus Torvalds /* file.c */ 1661da177e4SLinus Torvalds extern struct file_operations jffs2_file_operations; 1671da177e4SLinus Torvalds extern struct inode_operations jffs2_file_inode_operations; 1681da177e4SLinus Torvalds extern struct address_space_operations jffs2_file_address_operations; 1691da177e4SLinus Torvalds int jffs2_fsync(struct file *, struct dentry *, int); 1701da177e4SLinus Torvalds int jffs2_do_readpage_unlock (struct inode *inode, struct page *pg); 1711da177e4SLinus Torvalds 1721da177e4SLinus Torvalds /* ioctl.c */ 1731da177e4SLinus Torvalds int jffs2_ioctl(struct inode *, struct file *, unsigned int, unsigned long); 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds /* symlink.c */ 1761da177e4SLinus Torvalds extern struct inode_operations jffs2_symlink_inode_operations; 1771da177e4SLinus Torvalds 1781da177e4SLinus Torvalds /* fs.c */ 1791da177e4SLinus Torvalds int jffs2_setattr (struct dentry *, struct iattr *); 1801da177e4SLinus Torvalds void jffs2_read_inode (struct inode *); 1811da177e4SLinus Torvalds void jffs2_clear_inode (struct inode *); 1821da177e4SLinus Torvalds void jffs2_dirty_inode(struct inode *inode); 1831da177e4SLinus Torvalds struct inode *jffs2_new_inode (struct inode *dir_i, int mode, 1841da177e4SLinus Torvalds struct jffs2_raw_inode *ri); 1851da177e4SLinus Torvalds int jffs2_statfs (struct super_block *, struct kstatfs *); 1861da177e4SLinus Torvalds void jffs2_write_super (struct super_block *); 1871da177e4SLinus Torvalds int jffs2_remount_fs (struct super_block *, int *, char *); 1881da177e4SLinus Torvalds int jffs2_do_fill_super(struct super_block *sb, void *data, int silent); 1891da177e4SLinus Torvalds void jffs2_gc_release_inode(struct jffs2_sb_info *c, 1901da177e4SLinus Torvalds struct jffs2_inode_info *f); 1911da177e4SLinus Torvalds struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c, 1921da177e4SLinus Torvalds int inum, int nlink); 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c, 1951da177e4SLinus Torvalds struct jffs2_inode_info *f, 1961da177e4SLinus Torvalds unsigned long offset, 1971da177e4SLinus Torvalds unsigned long *priv); 1981da177e4SLinus Torvalds void jffs2_gc_release_page(struct jffs2_sb_info *c, 1991da177e4SLinus Torvalds unsigned char *pg, 2001da177e4SLinus Torvalds unsigned long *priv); 2011da177e4SLinus Torvalds void jffs2_flash_cleanup(struct jffs2_sb_info *c); 2021da177e4SLinus Torvalds 2031da177e4SLinus Torvalds 2041da177e4SLinus Torvalds /* writev.c */ 2051da177e4SLinus Torvalds int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs, 2061da177e4SLinus Torvalds unsigned long count, loff_t to, size_t *retlen); 207e631ddbaSFerenc Havasi int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, 208e631ddbaSFerenc Havasi size_t *retlen, const u_char *buf); 2091da177e4SLinus Torvalds 2101da177e4SLinus Torvalds #endif /* __JFFS2_OS_LINUX_H__ */ 2111da177e4SLinus Torvalds 2121da177e4SLinus Torvalds 213