xref: /openbmc/linux/fs/jffs2/compr.h (revision 3b23c1f5)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * JFFS2 -- Journalling Flash File System, Version 2.
31da177e4SLinus Torvalds  *
4c00c310eSDavid Woodhouse  * Copyright © 2004   Ferenc Havasi <havasi@inf.u-szeged.hu>,
51da177e4SLinus Torvalds  *		      University of Szeged, Hungary
61da177e4SLinus Torvalds  *
7c00c310eSDavid Woodhouse  * For licensing information, see the file 'LICENCE' in this directory.
81da177e4SLinus Torvalds  *
91da177e4SLinus Torvalds  */
101da177e4SLinus Torvalds 
111da177e4SLinus Torvalds #ifndef __JFFS2_COMPR_H__
121da177e4SLinus Torvalds #define __JFFS2_COMPR_H__
131da177e4SLinus Torvalds 
141da177e4SLinus Torvalds #include <linux/kernel.h>
151da177e4SLinus Torvalds #include <linux/vmalloc.h>
161da177e4SLinus Torvalds #include <linux/list.h>
171da177e4SLinus Torvalds #include <linux/types.h>
181da177e4SLinus Torvalds #include <linux/string.h>
191da177e4SLinus Torvalds #include <linux/slab.h>
201da177e4SLinus Torvalds #include <linux/errno.h>
211da177e4SLinus Torvalds #include <linux/fs.h>
221da177e4SLinus Torvalds #include <linux/jffs2.h>
23cbb9a561SDavid Woodhouse #include "jffs2_fs_i.h"
24cbb9a561SDavid Woodhouse #include "jffs2_fs_sb.h"
251da177e4SLinus Torvalds #include "nodelist.h"
261da177e4SLinus Torvalds 
271da177e4SLinus Torvalds #define JFFS2_RUBINMIPS_PRIORITY 10
281da177e4SLinus Torvalds #define JFFS2_DYNRUBIN_PRIORITY  20
291da177e4SLinus Torvalds #define JFFS2_LZARI_PRIORITY     30
301da177e4SLinus Torvalds #define JFFS2_RTIME_PRIORITY     50
311da177e4SLinus Torvalds #define JFFS2_ZLIB_PRIORITY      60
32c799aca3SRichard Purdie #define JFFS2_LZO_PRIORITY       80
33c799aca3SRichard Purdie 
341da177e4SLinus Torvalds 
351da177e4SLinus Torvalds #define JFFS2_RUBINMIPS_DISABLED /* RUBINs will be used only */
361da177e4SLinus Torvalds #define JFFS2_DYNRUBIN_DISABLED  /*	   for decompression */
371da177e4SLinus Torvalds 
381da177e4SLinus Torvalds #define JFFS2_COMPR_MODE_NONE       0
391da177e4SLinus Torvalds #define JFFS2_COMPR_MODE_PRIORITY   1
401da177e4SLinus Torvalds #define JFFS2_COMPR_MODE_SIZE       2
413b23c1f5SRichard Purdie #define JFFS2_COMPR_MODE_FAVOURLZO  3
423b23c1f5SRichard Purdie 
433b23c1f5SRichard Purdie #define FAVOUR_LZO_PERCENT 80
441da177e4SLinus Torvalds 
451da177e4SLinus Torvalds struct jffs2_compressor {
461da177e4SLinus Torvalds 	struct list_head list;
471da177e4SLinus Torvalds 	int priority;			/* used by prirority comr. mode */
481da177e4SLinus Torvalds 	char *name;
491da177e4SLinus Torvalds 	char compr;			/* JFFS2_COMPR_XXX */
501da177e4SLinus Torvalds 	int (*compress)(unsigned char *data_in, unsigned char *cpage_out,
511da177e4SLinus Torvalds 			uint32_t *srclen, uint32_t *destlen, void *model);
521da177e4SLinus Torvalds 	int (*decompress)(unsigned char *cdata_in, unsigned char *data_out,
531da177e4SLinus Torvalds 			  uint32_t cdatalen, uint32_t datalen, void *model);
541da177e4SLinus Torvalds 	int usecount;
55ef53cb02SDavid Woodhouse 	int disabled;		/* if set the compressor won't compress */
561da177e4SLinus Torvalds 	unsigned char *compr_buf;	/* used by size compr. mode */
571da177e4SLinus Torvalds 	uint32_t compr_buf_size;	/* used by size compr. mode */
581da177e4SLinus Torvalds 	uint32_t stat_compr_orig_size;
591da177e4SLinus Torvalds 	uint32_t stat_compr_new_size;
601da177e4SLinus Torvalds 	uint32_t stat_compr_blocks;
611da177e4SLinus Torvalds 	uint32_t stat_decompr_blocks;
621da177e4SLinus Torvalds };
631da177e4SLinus Torvalds 
641da177e4SLinus Torvalds int jffs2_register_compressor(struct jffs2_compressor *comp);
651da177e4SLinus Torvalds int jffs2_unregister_compressor(struct jffs2_compressor *comp);
661da177e4SLinus Torvalds 
671da177e4SLinus Torvalds int jffs2_compressors_init(void);
681da177e4SLinus Torvalds int jffs2_compressors_exit(void);
691da177e4SLinus Torvalds 
701da177e4SLinus Torvalds uint16_t jffs2_compress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
711da177e4SLinus Torvalds 			unsigned char *data_in, unsigned char **cpage_out,
721da177e4SLinus Torvalds 			uint32_t *datalen, uint32_t *cdatalen);
731da177e4SLinus Torvalds 
741da177e4SLinus Torvalds int jffs2_decompress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
751da177e4SLinus Torvalds 		     uint16_t comprtype, unsigned char *cdata_in,
761da177e4SLinus Torvalds 		     unsigned char *data_out, uint32_t cdatalen, uint32_t datalen);
771da177e4SLinus Torvalds 
781da177e4SLinus Torvalds void jffs2_free_comprbuf(unsigned char *comprbuf, unsigned char *orig);
791da177e4SLinus Torvalds 
801da177e4SLinus Torvalds /* Compressor modules */
811da177e4SLinus Torvalds /* These functions will be called by jffs2_compressors_init/exit */
821da177e4SLinus Torvalds 
831da177e4SLinus Torvalds #ifdef CONFIG_JFFS2_RUBIN
841da177e4SLinus Torvalds int jffs2_rubinmips_init(void);
851da177e4SLinus Torvalds void jffs2_rubinmips_exit(void);
861da177e4SLinus Torvalds int jffs2_dynrubin_init(void);
871da177e4SLinus Torvalds void jffs2_dynrubin_exit(void);
881da177e4SLinus Torvalds #endif
891da177e4SLinus Torvalds #ifdef CONFIG_JFFS2_RTIME
901da177e4SLinus Torvalds int jffs2_rtime_init(void);
911da177e4SLinus Torvalds void jffs2_rtime_exit(void);
921da177e4SLinus Torvalds #endif
931da177e4SLinus Torvalds #ifdef CONFIG_JFFS2_ZLIB
941da177e4SLinus Torvalds int jffs2_zlib_init(void);
951da177e4SLinus Torvalds void jffs2_zlib_exit(void);
961da177e4SLinus Torvalds #endif
971da177e4SLinus Torvalds 
981da177e4SLinus Torvalds #endif /* __JFFS2_COMPR_H__ */
99