xref: /linux/include/crypto/internal/scompress.h (revision 29ce50e0)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Synchronous Compression operations
4  *
5  * Copyright 2015 LG Electronics Inc.
6  * Copyright (c) 2016, Intel Corporation
7  * Author: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
8  */
9 #ifndef _CRYPTO_SCOMP_INT_H
10 #define _CRYPTO_SCOMP_INT_H
11 
12 #include <crypto/acompress.h>
13 #include <crypto/algapi.h>
14 
15 #define SCOMP_SCRATCH_SIZE	131072
16 
17 struct acomp_req;
18 
19 struct crypto_scomp {
20 	struct crypto_tfm base;
21 };
22 
23 /**
24  * struct scomp_alg - synchronous compression algorithm
25  *
26  * @alloc_ctx:	Function allocates algorithm specific context
27  * @free_ctx:	Function frees context allocated with alloc_ctx
28  * @compress:	Function performs a compress operation
29  * @decompress:	Function performs a de-compress operation
30  * @base:	Common crypto API algorithm data structure
31  * @calg:	Cmonn algorithm data structure shared with acomp
32  */
33 struct scomp_alg {
34 	void *(*alloc_ctx)(struct crypto_scomp *tfm);
35 	void (*free_ctx)(struct crypto_scomp *tfm, void *ctx);
36 	int (*compress)(struct crypto_scomp *tfm, const u8 *src,
37 			unsigned int slen, u8 *dst, unsigned int *dlen,
38 			void *ctx);
39 	int (*decompress)(struct crypto_scomp *tfm, const u8 *src,
40 			  unsigned int slen, u8 *dst, unsigned int *dlen,
41 			  void *ctx);
42 
43 	union {
44 		struct COMP_ALG_COMMON;
45 		struct comp_alg_common calg;
46 	};
47 };
48 
__crypto_scomp_alg(struct crypto_alg * alg)49 static inline struct scomp_alg *__crypto_scomp_alg(struct crypto_alg *alg)
50 {
51 	return container_of(alg, struct scomp_alg, base);
52 }
53 
__crypto_scomp_tfm(struct crypto_tfm * tfm)54 static inline struct crypto_scomp *__crypto_scomp_tfm(struct crypto_tfm *tfm)
55 {
56 	return container_of(tfm, struct crypto_scomp, base);
57 }
58 
crypto_scomp_tfm(struct crypto_scomp * tfm)59 static inline struct crypto_tfm *crypto_scomp_tfm(struct crypto_scomp *tfm)
60 {
61 	return &tfm->base;
62 }
63 
crypto_free_scomp(struct crypto_scomp * tfm)64 static inline void crypto_free_scomp(struct crypto_scomp *tfm)
65 {
66 	crypto_destroy_tfm(tfm, crypto_scomp_tfm(tfm));
67 }
68 
crypto_scomp_alg(struct crypto_scomp * tfm)69 static inline struct scomp_alg *crypto_scomp_alg(struct crypto_scomp *tfm)
70 {
71 	return __crypto_scomp_alg(crypto_scomp_tfm(tfm)->__crt_alg);
72 }
73 
crypto_scomp_alloc_ctx(struct crypto_scomp * tfm)74 static inline void *crypto_scomp_alloc_ctx(struct crypto_scomp *tfm)
75 {
76 	return crypto_scomp_alg(tfm)->alloc_ctx(tfm);
77 }
78 
crypto_scomp_free_ctx(struct crypto_scomp * tfm,void * ctx)79 static inline void crypto_scomp_free_ctx(struct crypto_scomp *tfm,
80 					 void *ctx)
81 {
82 	return crypto_scomp_alg(tfm)->free_ctx(tfm, ctx);
83 }
84 
crypto_scomp_compress(struct crypto_scomp * tfm,const u8 * src,unsigned int slen,u8 * dst,unsigned int * dlen,void * ctx)85 static inline int crypto_scomp_compress(struct crypto_scomp *tfm,
86 					const u8 *src, unsigned int slen,
87 					u8 *dst, unsigned int *dlen, void *ctx)
88 {
89 	return crypto_scomp_alg(tfm)->compress(tfm, src, slen, dst, dlen, ctx);
90 }
91 
crypto_scomp_decompress(struct crypto_scomp * tfm,const u8 * src,unsigned int slen,u8 * dst,unsigned int * dlen,void * ctx)92 static inline int crypto_scomp_decompress(struct crypto_scomp *tfm,
93 					  const u8 *src, unsigned int slen,
94 					  u8 *dst, unsigned int *dlen,
95 					  void *ctx)
96 {
97 	return crypto_scomp_alg(tfm)->decompress(tfm, src, slen, dst, dlen,
98 						 ctx);
99 }
100 
101 /**
102  * crypto_register_scomp() -- Register synchronous compression algorithm
103  *
104  * Function registers an implementation of a synchronous
105  * compression algorithm
106  *
107  * @alg:	algorithm definition
108  *
109  * Return: zero on success; error code in case of error
110  */
111 int crypto_register_scomp(struct scomp_alg *alg);
112 
113 /**
114  * crypto_unregister_scomp() -- Unregister synchronous compression algorithm
115  *
116  * Function unregisters an implementation of a synchronous
117  * compression algorithm
118  *
119  * @alg:	algorithm definition
120  */
121 void crypto_unregister_scomp(struct scomp_alg *alg);
122 
123 int crypto_register_scomps(struct scomp_alg *algs, int count);
124 void crypto_unregister_scomps(struct scomp_alg *algs, int count);
125 
126 #endif
127