[mirror_ubuntu-bionic-kernel.git] / fs / jffs2 / compr.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright © 2004   Ferenc Havasi <havasi@inf.u-szeged.hu>,
 *		      University of Szeged, Hungary
 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
 *
 * For licensing information, see the file 'LICENCE' in this directory.
 *
 */

#ifndef __JFFS2_COMPR_H__
#define __JFFS2_COMPR_H__

#include <linux/kernel.h>
#include <linux/vmalloc.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/errno.h>
#include <linux/fs.h>
#include <linux/jffs2.h>
#include "jffs2_fs_i.h"
#include "jffs2_fs_sb.h"
#include "nodelist.h"

#define JFFS2_RUBINMIPS_PRIORITY 10
#define JFFS2_DYNRUBIN_PRIORITY  20
#define JFFS2_LZARI_PRIORITY     30
#define JFFS2_RTIME_PRIORITY     50
#define JFFS2_ZLIB_PRIORITY      60
#define JFFS2_LZO_PRIORITY       80


#define JFFS2_RUBINMIPS_DISABLED /* RUBINs will be used only */
#define JFFS2_DYNRUBIN_DISABLED  /*	   for decompression */

#define JFFS2_COMPR_MODE_NONE       0
#define JFFS2_COMPR_MODE_PRIORITY   1
#define JFFS2_COMPR_MODE_SIZE       2
#define JFFS2_COMPR_MODE_FAVOURLZO  3
#define JFFS2_COMPR_MODE_FORCELZO   4
#define JFFS2_COMPR_MODE_FORCEZLIB  5

#define FAVOUR_LZO_PERCENT 80

struct jffs2_compressor {
	struct list_head list;
	int priority;			/* used by prirority comr. mode */
	char *name;
	char compr;			/* JFFS2_COMPR_XXX */
	int (*compress)(unsigned char *data_in, unsigned char *cpage_out,
			uint32_t *srclen, uint32_t *destlen);
	int (*decompress)(unsigned char *cdata_in, unsigned char *data_out,
			  uint32_t cdatalen, uint32_t datalen);
	int usecount;
	int disabled;		/* if set the compressor won't compress */
	unsigned char *compr_buf;	/* used by size compr. mode */
	uint32_t compr_buf_size;	/* used by size compr. mode */
	uint32_t stat_compr_orig_size;
	uint32_t stat_compr_new_size;
	uint32_t stat_compr_blocks;
	uint32_t stat_decompr_blocks;
};

int jffs2_register_compressor(struct jffs2_compressor *comp);
int jffs2_unregister_compressor(struct jffs2_compressor *comp);

int jffs2_compressors_init(void);
int jffs2_compressors_exit(void);

uint16_t jffs2_compress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
			unsigned char *data_in, unsigned char **cpage_out,
			uint32_t *datalen, uint32_t *cdatalen);

int jffs2_decompress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
		     uint16_t comprtype, unsigned char *cdata_in,
		     unsigned char *data_out, uint32_t cdatalen, uint32_t datalen);

void jffs2_free_comprbuf(unsigned char *comprbuf, unsigned char *orig);

/* Compressor modules */
/* These functions will be called by jffs2_compressors_init/exit */

#ifdef CONFIG_JFFS2_RUBIN
int jffs2_rubinmips_init(void);
void jffs2_rubinmips_exit(void);
int jffs2_dynrubin_init(void);
void jffs2_dynrubin_exit(void);
#endif
#ifdef CONFIG_JFFS2_RTIME
int jffs2_rtime_init(void);
void jffs2_rtime_exit(void);
#endif
#ifdef CONFIG_JFFS2_ZLIB
int jffs2_zlib_init(void);
void jffs2_zlib_exit(void);
#endif
#ifdef CONFIG_JFFS2_LZO
int jffs2_lzo_init(void);
void jffs2_lzo_exit(void);
#endif

#endif /* __JFFS2_COMPR_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* JFFS2 -- Journalling Flash File System, Version 2.
	3	*
c00c310e	4	* Copyright © 2004 Ferenc Havasi <havasi@inf.u-szeged.hu>,
ef53cb02	5	* University of Szeged, Hungary
6088c058	6	* Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
1da177e4	7	*
c00c310e	8	* For licensing information, see the file 'LICENCE' in this directory.
1da177e4 LT	9	*
	10	*/
	11
	12	#ifndef __JFFS2_COMPR_H__
	13	#define __JFFS2_COMPR_H__
	14
	15	#include <linux/kernel.h>
	16	#include <linux/vmalloc.h>
	17	#include <linux/list.h>
	18	#include <linux/types.h>
	19	#include <linux/string.h>
	20	#include <linux/slab.h>
	21	#include <linux/errno.h>
	22	#include <linux/fs.h>
	23	#include <linux/jffs2.h>
cbb9a561 DW	24	#include "jffs2_fs_i.h"
cbb9a561 DW	25	#include "jffs2_fs_sb.h"
1da177e4 LT	26	#include "nodelist.h"
	27
	28	#define JFFS2_RUBINMIPS_PRIORITY 10
	29	#define JFFS2_DYNRUBIN_PRIORITY 20
	30	#define JFFS2_LZARI_PRIORITY 30
1da177e4 LT	31	#define JFFS2_RTIME_PRIORITY 50
1da177e4 LT	32	#define JFFS2_ZLIB_PRIORITY 60
c799aca3 RP	33	#define JFFS2_LZO_PRIORITY 80
c799aca3 RP	34
1da177e4 LT	35
1da177e4 LT	36	#define JFFS2_RUBINMIPS_DISABLED /* RUBINs will be used only */
ef53cb02	37	#define JFFS2_DYNRUBIN_DISABLED /* for decompression */
1da177e4 LT	38
	39	#define JFFS2_COMPR_MODE_NONE 0
	40	#define JFFS2_COMPR_MODE_PRIORITY 1
	41	#define JFFS2_COMPR_MODE_SIZE 2
3b23c1f5	42	#define JFFS2_COMPR_MODE_FAVOURLZO 3
123005f3 AS	43	#define JFFS2_COMPR_MODE_FORCELZO 4
123005f3 AS	44	#define JFFS2_COMPR_MODE_FORCEZLIB 5
3b23c1f5 RP	45
3b23c1f5 RP	46	#define FAVOUR_LZO_PERCENT 80
1da177e4 LT	47
1da177e4 LT	48	struct jffs2_compressor {
ef53cb02 DW	49	struct list_head list;
	50	int priority; /* used by prirority comr. mode */
	51	char *name;
	52	char compr; /* JFFS2_COMPR_XXX */
	53	int (compress)(unsigned char data_in, unsigned char *cpage_out,
088bd455	54	uint32_t srclen, uint32_t destlen);
ef53cb02	55	int (decompress)(unsigned char cdata_in, unsigned char *data_out,
088bd455	56	uint32_t cdatalen, uint32_t datalen);
ef53cb02 DW	57	int usecount;
	58	int disabled; /* if set the compressor won't compress */
	59	unsigned char compr_buf; / used by size compr. mode */
	60	uint32_t compr_buf_size; /* used by size compr. mode */
	61	uint32_t stat_compr_orig_size;
	62	uint32_t stat_compr_new_size;
	63	uint32_t stat_compr_blocks;
	64	uint32_t stat_decompr_blocks;
1da177e4 LT	65	};
	66
	67	int jffs2_register_compressor(struct jffs2_compressor *comp);
	68	int jffs2_unregister_compressor(struct jffs2_compressor *comp);
	69
	70	int jffs2_compressors_init(void);
	71	int jffs2_compressors_exit(void);
	72
	73	uint16_t jffs2_compress(struct jffs2_sb_info c, struct jffs2_inode_info f,
ef53cb02 DW	74	unsigned char data_in, unsigned char *cpage_out,
ef53cb02 DW	75	uint32_t datalen, uint32_t cdatalen);
1da177e4 LT	76
1da177e4 LT	77	int jffs2_decompress(struct jffs2_sb_info c, struct jffs2_inode_info f,
ef53cb02 DW	78	uint16_t comprtype, unsigned char *cdata_in,
ef53cb02 DW	79	unsigned char *data_out, uint32_t cdatalen, uint32_t datalen);
1da177e4 LT	80
	81	void jffs2_free_comprbuf(unsigned char comprbuf, unsigned char orig);
	82
1da177e4 LT	83	/* Compressor modules */
	84	/* These functions will be called by jffs2_compressors_init/exit */
	85
	86	#ifdef CONFIG_JFFS2_RUBIN
	87	int jffs2_rubinmips_init(void);
	88	void jffs2_rubinmips_exit(void);
	89	int jffs2_dynrubin_init(void);
	90	void jffs2_dynrubin_exit(void);
	91	#endif
	92	#ifdef CONFIG_JFFS2_RTIME
	93	int jffs2_rtime_init(void);
	94	void jffs2_rtime_exit(void);
	95	#endif
	96	#ifdef CONFIG_JFFS2_ZLIB
	97	int jffs2_zlib_init(void);
	98	void jffs2_zlib_exit(void);
	99	#endif
0fc72b81 DW	100	#ifdef CONFIG_JFFS2_LZO
	101	int jffs2_lzo_init(void);
	102	void jffs2_lzo_exit(void);
	103	#endif
1da177e4 LT	104
1da177e4 LT	105	#endif /* __JFFS2_COMPR_H__ */