mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git
synced 2026-04-18 03:23:53 -04:00
f9bbd547cf
Document the anonymous SKCIPHER_ALG_COMMON and COMP_ALG_COMMON struct members in skcipher_alg, scomp_alg, and acomp_alg, following the existing pattern used by HASH_ALG_COMMON in shash_alg. This fixes the following kernel-doc warnings: include/crypto/skcipher.h:166: struct member 'SKCIPHER_ALG_COMMON' not described in 'skcipher_alg' include/crypto/internal/scompress.h:39: struct member 'COMP_ALG_COMMON' not described in 'scomp_alg' include/crypto/internal/acompress.h:55: struct member 'COMP_ALG_COMMON' not described in 'acomp_alg' Signed-off-by: Kit Dallege <xaum.io@gmail.com> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
110 lines
2.8 KiB
C
110 lines
2.8 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* Synchronous Compression operations
|
|
*
|
|
* Copyright 2015 LG Electronics Inc.
|
|
* Copyright (c) 2016, Intel Corporation
|
|
* Author: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
|
|
*/
|
|
#ifndef _CRYPTO_SCOMP_INT_H
|
|
#define _CRYPTO_SCOMP_INT_H
|
|
|
|
#include <crypto/internal/acompress.h>
|
|
|
|
struct crypto_scomp {
|
|
struct crypto_tfm base;
|
|
};
|
|
|
|
/**
|
|
* struct scomp_alg - synchronous compression algorithm
|
|
*
|
|
* @compress: Function performs a compress operation
|
|
* @decompress: Function performs a de-compress operation
|
|
* @streams: Per-cpu memory for algorithm
|
|
* @calg: Cmonn algorithm data structure shared with acomp
|
|
* @COMP_ALG_COMMON: see struct comp_alg_common
|
|
*/
|
|
struct scomp_alg {
|
|
int (*compress)(struct crypto_scomp *tfm, const u8 *src,
|
|
unsigned int slen, u8 *dst, unsigned int *dlen,
|
|
void *ctx);
|
|
int (*decompress)(struct crypto_scomp *tfm, const u8 *src,
|
|
unsigned int slen, u8 *dst, unsigned int *dlen,
|
|
void *ctx);
|
|
|
|
struct crypto_acomp_streams streams;
|
|
|
|
union {
|
|
struct COMP_ALG_COMMON;
|
|
struct comp_alg_common calg;
|
|
};
|
|
};
|
|
|
|
static inline struct scomp_alg *__crypto_scomp_alg(struct crypto_alg *alg)
|
|
{
|
|
return container_of(alg, struct scomp_alg, base);
|
|
}
|
|
|
|
static inline struct crypto_scomp *__crypto_scomp_tfm(struct crypto_tfm *tfm)
|
|
{
|
|
return container_of(tfm, struct crypto_scomp, base);
|
|
}
|
|
|
|
static inline struct crypto_tfm *crypto_scomp_tfm(struct crypto_scomp *tfm)
|
|
{
|
|
return &tfm->base;
|
|
}
|
|
|
|
static inline void crypto_free_scomp(struct crypto_scomp *tfm)
|
|
{
|
|
crypto_destroy_tfm(tfm, crypto_scomp_tfm(tfm));
|
|
}
|
|
|
|
static inline struct scomp_alg *crypto_scomp_alg(struct crypto_scomp *tfm)
|
|
{
|
|
return __crypto_scomp_alg(crypto_scomp_tfm(tfm)->__crt_alg);
|
|
}
|
|
|
|
static inline int crypto_scomp_compress(struct crypto_scomp *tfm,
|
|
const u8 *src, unsigned int slen,
|
|
u8 *dst, unsigned int *dlen, void *ctx)
|
|
{
|
|
return crypto_scomp_alg(tfm)->compress(tfm, src, slen, dst, dlen, ctx);
|
|
}
|
|
|
|
static inline int crypto_scomp_decompress(struct crypto_scomp *tfm,
|
|
const u8 *src, unsigned int slen,
|
|
u8 *dst, unsigned int *dlen,
|
|
void *ctx)
|
|
{
|
|
return crypto_scomp_alg(tfm)->decompress(tfm, src, slen, dst, dlen,
|
|
ctx);
|
|
}
|
|
|
|
/**
|
|
* crypto_register_scomp() -- Register synchronous compression algorithm
|
|
*
|
|
* Function registers an implementation of a synchronous
|
|
* compression algorithm
|
|
*
|
|
* @alg: algorithm definition
|
|
*
|
|
* Return: zero on success; error code in case of error
|
|
*/
|
|
int crypto_register_scomp(struct scomp_alg *alg);
|
|
|
|
/**
|
|
* crypto_unregister_scomp() -- Unregister synchronous compression algorithm
|
|
*
|
|
* Function unregisters an implementation of a synchronous
|
|
* compression algorithm
|
|
*
|
|
* @alg: algorithm definition
|
|
*/
|
|
void crypto_unregister_scomp(struct scomp_alg *alg);
|
|
|
|
int crypto_register_scomps(struct scomp_alg *algs, int count);
|
|
void crypto_unregister_scomps(struct scomp_alg *algs, int count);
|
|
|
|
#endif
|