[linux-block.git] / include / linux / ccp.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * AMD Cryptographic Coprocessor (CCP) driver
 *
 * Copyright (C) 2013,2017 Advanced Micro Devices, Inc.
 *
 * Author: Tom Lendacky <thomas.lendacky@amd.com>
 * Author: Gary R Hook <gary.hook@amd.com>
 */

#ifndef __CCP_H__
#define __CCP_H__

#include <linux/scatterlist.h>
#include <linux/workqueue.h>
#include <linux/list.h>
#include <crypto/aes.h>
#include <crypto/sha.h>

struct ccp_device;
struct ccp_cmd;

#if defined(CONFIG_CRYPTO_DEV_SP_CCP)

/**
 * ccp_present - check if a CCP device is present
 *
 * Returns zero if a CCP device is present, -ENODEV otherwise.
 */
int ccp_present(void);

#define	CCP_VSIZE 16
#define	CCP_VMASK		((unsigned int)((1 << CCP_VSIZE) - 1))
#define	CCP_VERSION(v, r)	((unsigned int)((v << CCP_VSIZE) \
					       | (r & CCP_VMASK)))

/**
 * ccp_version - get the version of the CCP
 *
 * Returns a positive version number, or zero if no CCP
 */
unsigned int ccp_version(void);

/**
 * ccp_enqueue_cmd - queue an operation for processing by the CCP
 *
 * @cmd: ccp_cmd struct to be processed
 *
 * Refer to the ccp_cmd struct below for required fields.
 *
 * Queue a cmd to be processed by the CCP. If queueing the cmd
 * would exceed the defined length of the cmd queue the cmd will
 * only be queued if the CCP_CMD_MAY_BACKLOG flag is set and will
 * result in a return code of -EBUSY.
 *
 * The callback routine specified in the ccp_cmd struct will be
 * called to notify the caller of completion (if the cmd was not
 * backlogged) or advancement out of the backlog. If the cmd has
 * advanced out of the backlog the "err" value of the callback
 * will be -EINPROGRESS. Any other "err" value during callback is
 * the result of the operation.
 *
 * The cmd has been successfully queued if:
 *   the return code is -EINPROGRESS or
 *   the return code is -EBUSY and CCP_CMD_MAY_BACKLOG flag is set
 */
int ccp_enqueue_cmd(struct ccp_cmd *cmd);

#else /* CONFIG_CRYPTO_DEV_CCP_SP_DEV is not enabled */

static inline int ccp_present(void)
{
	return -ENODEV;
}

static inline unsigned int ccp_version(void)
{
	return 0;
}

static inline int ccp_enqueue_cmd(struct ccp_cmd *cmd)
{
	return -ENODEV;
}

#endif /* CONFIG_CRYPTO_DEV_SP_CCP */


/***** AES engine *****/
/**
 * ccp_aes_type - AES key size
 *
 * @CCP_AES_TYPE_128: 128-bit key
 * @CCP_AES_TYPE_192: 192-bit key
 * @CCP_AES_TYPE_256: 256-bit key
 */
enum ccp_aes_type {
	CCP_AES_TYPE_128 = 0,
	CCP_AES_TYPE_192,
	CCP_AES_TYPE_256,
	CCP_AES_TYPE__LAST,
};

/**
 * ccp_aes_mode - AES operation mode
 *
 * @CCP_AES_MODE_ECB: ECB mode
 * @CCP_AES_MODE_CBC: CBC mode
 * @CCP_AES_MODE_OFB: OFB mode
 * @CCP_AES_MODE_CFB: CFB mode
 * @CCP_AES_MODE_CTR: CTR mode
 * @CCP_AES_MODE_CMAC: CMAC mode
 */
enum ccp_aes_mode {
	CCP_AES_MODE_ECB = 0,
	CCP_AES_MODE_CBC,
	CCP_AES_MODE_OFB,
	CCP_AES_MODE_CFB,
	CCP_AES_MODE_CTR,
	CCP_AES_MODE_CMAC,
	CCP_AES_MODE_GHASH,
	CCP_AES_MODE_GCTR,
	CCP_AES_MODE_GCM,
	CCP_AES_MODE_GMAC,
	CCP_AES_MODE__LAST,
};

/**
 * ccp_aes_mode - AES operation mode
 *
 * @CCP_AES_ACTION_DECRYPT: AES decrypt operation
 * @CCP_AES_ACTION_ENCRYPT: AES encrypt operation
 */
enum ccp_aes_action {
	CCP_AES_ACTION_DECRYPT = 0,
	CCP_AES_ACTION_ENCRYPT,
	CCP_AES_ACTION__LAST,
};
/* Overloaded field */
#define	CCP_AES_GHASHAAD	CCP_AES_ACTION_DECRYPT
#define	CCP_AES_GHASHFINAL	CCP_AES_ACTION_ENCRYPT

/**
 * struct ccp_aes_engine - CCP AES operation
 * @type: AES operation key size
 * @mode: AES operation mode
 * @action: AES operation (decrypt/encrypt)
 * @key: key to be used for this AES operation
 * @key_len: length in bytes of key
 * @iv: IV to be used for this AES operation
 * @iv_len: length in bytes of iv
 * @src: data to be used for this operation
 * @dst: data produced by this operation
 * @src_len: length in bytes of data used for this operation
 * @cmac_final: indicates final operation when running in CMAC mode
 * @cmac_key: K1/K2 key used in final CMAC operation
 * @cmac_key_len: length in bytes of cmac_key
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - type, mode, action, key, key_len, src, dst, src_len
 *   - iv, iv_len for any mode other than ECB
 *   - cmac_final for CMAC mode
 *   - cmac_key, cmac_key_len for CMAC mode if cmac_final is non-zero
 *
 * The iv variable is used as both input and output. On completion of the
 * AES operation the new IV overwrites the old IV.
 */
struct ccp_aes_engine {
	enum ccp_aes_type type;
	enum ccp_aes_mode mode;
	enum ccp_aes_action action;

	u32 authsize;

	struct scatterlist *key;
	u32 key_len;		/* In bytes */

	struct scatterlist *iv;
	u32 iv_len;		/* In bytes */

	struct scatterlist *src, *dst;
	u64 src_len;		/* In bytes */

	u32 cmac_final;		/* Indicates final cmac cmd */
	struct scatterlist *cmac_key;	/* K1/K2 cmac key required for
					 * final cmac cmd */
	u32 cmac_key_len;	/* In bytes */

	u32 aad_len;		/* In bytes */
};

/***** XTS-AES engine *****/
/**
 * ccp_xts_aes_unit_size - XTS unit size
 *
 * @CCP_XTS_AES_UNIT_SIZE_16: Unit size of 16 bytes
 * @CCP_XTS_AES_UNIT_SIZE_512: Unit size of 512 bytes
 * @CCP_XTS_AES_UNIT_SIZE_1024: Unit size of 1024 bytes
 * @CCP_XTS_AES_UNIT_SIZE_2048: Unit size of 2048 bytes
 * @CCP_XTS_AES_UNIT_SIZE_4096: Unit size of 4096 bytes
 */
enum ccp_xts_aes_unit_size {
	CCP_XTS_AES_UNIT_SIZE_16 = 0,
	CCP_XTS_AES_UNIT_SIZE_512,
	CCP_XTS_AES_UNIT_SIZE_1024,
	CCP_XTS_AES_UNIT_SIZE_2048,
	CCP_XTS_AES_UNIT_SIZE_4096,
	CCP_XTS_AES_UNIT_SIZE__LAST,
};

/**
 * struct ccp_xts_aes_engine - CCP XTS AES operation
 * @action: AES operation (decrypt/encrypt)
 * @unit_size: unit size of the XTS operation
 * @key: key to be used for this XTS AES operation
 * @key_len: length in bytes of key
 * @iv: IV to be used for this XTS AES operation
 * @iv_len: length in bytes of iv
 * @src: data to be used for this operation
 * @dst: data produced by this operation
 * @src_len: length in bytes of data used for this operation
 * @final: indicates final XTS operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - action, unit_size, key, key_len, iv, iv_len, src, dst, src_len, final
 *
 * The iv variable is used as both input and output. On completion of the
 * AES operation the new IV overwrites the old IV.
 */
struct ccp_xts_aes_engine {
	enum ccp_aes_type type;
	enum ccp_aes_action action;
	enum ccp_xts_aes_unit_size unit_size;

	struct scatterlist *key;
	u32 key_len;		/* In bytes */

	struct scatterlist *iv;
	u32 iv_len;		/* In bytes */

	struct scatterlist *src, *dst;
	u64 src_len;		/* In bytes */

	u32 final;
};

/***** SHA engine *****/
/**
 * ccp_sha_type - type of SHA operation
 *
 * @CCP_SHA_TYPE_1: SHA-1 operation
 * @CCP_SHA_TYPE_224: SHA-224 operation
 * @CCP_SHA_TYPE_256: SHA-256 operation
 */
enum ccp_sha_type {
	CCP_SHA_TYPE_1 = 1,
	CCP_SHA_TYPE_224,
	CCP_SHA_TYPE_256,
	CCP_SHA_TYPE_384,
	CCP_SHA_TYPE_512,
	CCP_SHA_TYPE__LAST,
};

/**
 * struct ccp_sha_engine - CCP SHA operation
 * @type: Type of SHA operation
 * @ctx: current hash value
 * @ctx_len: length in bytes of hash value
 * @src: data to be used for this operation
 * @src_len: length in bytes of data used for this operation
 * @opad: data to be used for final HMAC operation
 * @opad_len: length in bytes of data used for final HMAC operation
 * @first: indicates first SHA operation
 * @final: indicates final SHA operation
 * @msg_bits: total length of the message in bits used in final SHA operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - type, ctx, ctx_len, src, src_len, final
 *   - msg_bits if final is non-zero
 *
 * The ctx variable is used as both input and output. On completion of the
 * SHA operation the new hash value overwrites the old hash value.
 */
struct ccp_sha_engine {
	enum ccp_sha_type type;

	struct scatterlist *ctx;
	u32 ctx_len;		/* In bytes */

	struct scatterlist *src;
	u64 src_len;		/* In bytes */

	struct scatterlist *opad;
	u32 opad_len;		/* In bytes */

	u32 first;		/* Indicates first sha cmd */
	u32 final;		/* Indicates final sha cmd */
	u64 msg_bits;		/* Message length in bits required for
				 * final sha cmd */
};

/***** 3DES engine *****/
enum ccp_des3_mode {
	CCP_DES3_MODE_ECB = 0,
	CCP_DES3_MODE_CBC,
	CCP_DES3_MODE_CFB,
	CCP_DES3_MODE__LAST,
};

enum ccp_des3_type {
	CCP_DES3_TYPE_168 = 1,
	CCP_DES3_TYPE__LAST,
	};

enum ccp_des3_action {
	CCP_DES3_ACTION_DECRYPT = 0,
	CCP_DES3_ACTION_ENCRYPT,
	CCP_DES3_ACTION__LAST,
};

/**
 * struct ccp_des3_engine - CCP SHA operation
 * @type: Type of 3DES operation
 * @mode: cipher mode
 * @action: 3DES operation (decrypt/encrypt)
 * @key: key to be used for this 3DES operation
 * @key_len: length of key (in bytes)
 * @iv: IV to be used for this AES operation
 * @iv_len: length in bytes of iv
 * @src: input data to be used for this operation
 * @src_len: length of input data used for this operation (in bytes)
 * @dst: output data produced by this operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - type, mode, action, key, key_len, src, dst, src_len
 *   - iv, iv_len for any mode other than ECB
 *
 * The iv variable is used as both input and output. On completion of the
 * 3DES operation the new IV overwrites the old IV.
 */
struct ccp_des3_engine {
	enum ccp_des3_type type;
	enum ccp_des3_mode mode;
	enum ccp_des3_action action;

	struct scatterlist *key;
	u32 key_len;	    /* In bytes */

	struct scatterlist *iv;
	u32 iv_len;	     /* In bytes */

	struct scatterlist *src, *dst;
	u64 src_len;	    /* In bytes */
};

/***** RSA engine *****/
/**
 * struct ccp_rsa_engine - CCP RSA operation
 * @key_size: length in bits of RSA key
 * @exp: RSA exponent
 * @exp_len: length in bytes of exponent
 * @mod: RSA modulus
 * @mod_len: length in bytes of modulus
 * @src: data to be used for this operation
 * @dst: data produced by this operation
 * @src_len: length in bytes of data used for this operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - key_size, exp, exp_len, mod, mod_len, src, dst, src_len
 */
struct ccp_rsa_engine {
	u32 key_size;		/* In bits */

	struct scatterlist *exp;
	u32 exp_len;		/* In bytes */

	struct scatterlist *mod;
	u32 mod_len;		/* In bytes */

	struct scatterlist *src, *dst;
	u32 src_len;		/* In bytes */
};

/***** Passthru engine *****/
/**
 * ccp_passthru_bitwise - type of bitwise passthru operation
 *
 * @CCP_PASSTHRU_BITWISE_NOOP: no bitwise operation performed
 * @CCP_PASSTHRU_BITWISE_AND: perform bitwise AND of src with mask
 * @CCP_PASSTHRU_BITWISE_OR: perform bitwise OR of src with mask
 * @CCP_PASSTHRU_BITWISE_XOR: perform bitwise XOR of src with mask
 * @CCP_PASSTHRU_BITWISE_MASK: overwrite with mask
 */
enum ccp_passthru_bitwise {
	CCP_PASSTHRU_BITWISE_NOOP = 0,
	CCP_PASSTHRU_BITWISE_AND,
	CCP_PASSTHRU_BITWISE_OR,
	CCP_PASSTHRU_BITWISE_XOR,
	CCP_PASSTHRU_BITWISE_MASK,
	CCP_PASSTHRU_BITWISE__LAST,
};

/**
 * ccp_passthru_byteswap - type of byteswap passthru operation
 *
 * @CCP_PASSTHRU_BYTESWAP_NOOP: no byte swapping performed
 * @CCP_PASSTHRU_BYTESWAP_32BIT: swap bytes within 32-bit words
 * @CCP_PASSTHRU_BYTESWAP_256BIT: swap bytes within 256-bit words
 */
enum ccp_passthru_byteswap {
	CCP_PASSTHRU_BYTESWAP_NOOP = 0,
	CCP_PASSTHRU_BYTESWAP_32BIT,
	CCP_PASSTHRU_BYTESWAP_256BIT,
	CCP_PASSTHRU_BYTESWAP__LAST,
};

/**
 * struct ccp_passthru_engine - CCP pass-through operation
 * @bit_mod: bitwise operation to perform
 * @byte_swap: byteswap operation to perform
 * @mask: mask to be applied to data
 * @mask_len: length in bytes of mask
 * @src: data to be used for this operation
 * @dst: data produced by this operation
 * @src_len: length in bytes of data used for this operation
 * @final: indicate final pass-through operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - bit_mod, byte_swap, src, dst, src_len
 *   - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
 */
struct ccp_passthru_engine {
	enum ccp_passthru_bitwise bit_mod;
	enum ccp_passthru_byteswap byte_swap;

	struct scatterlist *mask;
	u32 mask_len;		/* In bytes */

	struct scatterlist *src, *dst;
	u64 src_len;		/* In bytes */

	u32 final;
};

/**
 * struct ccp_passthru_nomap_engine - CCP pass-through operation
 *   without performing DMA mapping
 * @bit_mod: bitwise operation to perform
 * @byte_swap: byteswap operation to perform
 * @mask: mask to be applied to data
 * @mask_len: length in bytes of mask
 * @src: data to be used for this operation
 * @dst: data produced by this operation
 * @src_len: length in bytes of data used for this operation
 * @final: indicate final pass-through operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - bit_mod, byte_swap, src, dst, src_len
 *   - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
 */
struct ccp_passthru_nomap_engine {
	enum ccp_passthru_bitwise bit_mod;
	enum ccp_passthru_byteswap byte_swap;

	dma_addr_t mask;
	u32 mask_len;		/* In bytes */

	dma_addr_t src_dma, dst_dma;
	u64 src_len;		/* In bytes */

	u32 final;
};

/***** ECC engine *****/
#define CCP_ECC_MODULUS_BYTES	48	/* 384-bits */
#define CCP_ECC_MAX_OPERANDS	6
#define CCP_ECC_MAX_OUTPUTS	3

/**
 * ccp_ecc_function - type of ECC function
 *
 * @CCP_ECC_FUNCTION_MMUL_384BIT: 384-bit modular multiplication
 * @CCP_ECC_FUNCTION_MADD_384BIT: 384-bit modular addition
 * @CCP_ECC_FUNCTION_MINV_384BIT: 384-bit multiplicative inverse
 * @CCP_ECC_FUNCTION_PADD_384BIT: 384-bit point addition
 * @CCP_ECC_FUNCTION_PMUL_384BIT: 384-bit point multiplication
 * @CCP_ECC_FUNCTION_PDBL_384BIT: 384-bit point doubling
 */
enum ccp_ecc_function {
	CCP_ECC_FUNCTION_MMUL_384BIT = 0,
	CCP_ECC_FUNCTION_MADD_384BIT,
	CCP_ECC_FUNCTION_MINV_384BIT,
	CCP_ECC_FUNCTION_PADD_384BIT,
	CCP_ECC_FUNCTION_PMUL_384BIT,
	CCP_ECC_FUNCTION_PDBL_384BIT,
};

/**
 * struct ccp_ecc_modular_math - CCP ECC modular math parameters
 * @operand_1: first operand for the modular math operation
 * @operand_1_len: length of the first operand
 * @operand_2: second operand for the modular math operation
 *	       (not used for CCP_ECC_FUNCTION_MINV_384BIT)
 * @operand_2_len: length of the second operand
 *	       (not used for CCP_ECC_FUNCTION_MINV_384BIT)
 * @result: result of the modular math operation
 * @result_len: length of the supplied result buffer
 */
struct ccp_ecc_modular_math {
	struct scatterlist *operand_1;
	unsigned int operand_1_len;	/* In bytes */

	struct scatterlist *operand_2;
	unsigned int operand_2_len;	/* In bytes */

	struct scatterlist *result;
	unsigned int result_len;	/* In bytes */
};

/**
 * struct ccp_ecc_point - CCP ECC point definition
 * @x: the x coordinate of the ECC point
 * @x_len: the length of the x coordinate
 * @y: the y coordinate of the ECC point
 * @y_len: the length of the y coordinate
 */
struct ccp_ecc_point {
	struct scatterlist *x;
	unsigned int x_len;	/* In bytes */

	struct scatterlist *y;
	unsigned int y_len;	/* In bytes */
};

/**
 * struct ccp_ecc_point_math - CCP ECC point math parameters
 * @point_1: the first point of the ECC point math operation
 * @point_2: the second point of the ECC point math operation
 *	     (only used for CCP_ECC_FUNCTION_PADD_384BIT)
 * @domain_a: the a parameter of the ECC curve
 * @domain_a_len: the length of the a parameter
 * @scalar: the scalar parameter for the point match operation
 *	    (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
 * @scalar_len: the length of the scalar parameter
 *		(only used for CCP_ECC_FUNCTION_PMUL_384BIT)
 * @result: the point resulting from the point math operation
 */
struct ccp_ecc_point_math {
	struct ccp_ecc_point point_1;
	struct ccp_ecc_point point_2;

	struct scatterlist *domain_a;
	unsigned int domain_a_len;	/* In bytes */

	struct scatterlist *scalar;
	unsigned int scalar_len;	/* In bytes */

	struct ccp_ecc_point result;
};

/**
 * struct ccp_ecc_engine - CCP ECC operation
 * @function: ECC function to perform
 * @mod: ECC modulus
 * @mod_len: length in bytes of modulus
 * @mm: module math parameters
 * @pm: point math parameters
 * @ecc_result: result of the ECC operation
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - function, mod, mod_len
 *   - operand, operand_len, operand_count, output, output_len, output_count
 *   - ecc_result
 */
struct ccp_ecc_engine {
	enum ccp_ecc_function function;

	struct scatterlist *mod;
	u32 mod_len;		/* In bytes */

	union {
		struct ccp_ecc_modular_math mm;
		struct ccp_ecc_point_math pm;
	} u;

	u16 ecc_result;
};


/**
 * ccp_engine - CCP operation identifiers
 *
 * @CCP_ENGINE_AES: AES operation
 * @CCP_ENGINE_XTS_AES: 128-bit XTS AES operation
 * @CCP_ENGINE_RSVD1: unused
 * @CCP_ENGINE_SHA: SHA operation
 * @CCP_ENGINE_RSA: RSA operation
 * @CCP_ENGINE_PASSTHRU: pass-through operation
 * @CCP_ENGINE_ZLIB_DECOMPRESS: unused
 * @CCP_ENGINE_ECC: ECC operation
 */
enum ccp_engine {
	CCP_ENGINE_AES = 0,
	CCP_ENGINE_XTS_AES_128,
	CCP_ENGINE_DES3,
	CCP_ENGINE_SHA,
	CCP_ENGINE_RSA,
	CCP_ENGINE_PASSTHRU,
	CCP_ENGINE_ZLIB_DECOMPRESS,
	CCP_ENGINE_ECC,
	CCP_ENGINE__LAST,
};

/* Flag values for flags member of ccp_cmd */
#define CCP_CMD_MAY_BACKLOG		0x00000001
#define CCP_CMD_PASSTHRU_NO_DMA_MAP	0x00000002

/**
 * struct ccp_cmd - CCP operation request
 * @entry: list element (ccp driver use only)
 * @work: work element used for callbacks (ccp driver use only)
 * @ccp: CCP device to be run on
 * @ret: operation return code (ccp driver use only)
 * @flags: cmd processing flags
 * @engine: CCP operation to perform
 * @engine_error: CCP engine return code
 * @u: engine specific structures, refer to specific engine struct below
 * @callback: operation completion callback function
 * @data: parameter value to be supplied to the callback function
 *
 * Variables required to be set when calling ccp_enqueue_cmd():
 *   - engine, callback
 *   - See the operation structures below for what is required for each
 *     operation.
 */
struct ccp_cmd {
	/* The list_head, work_struct, ccp and ret variables are for use
	 * by the CCP driver only.
	 */
	struct list_head entry;
	struct work_struct work;
	struct ccp_device *ccp;
	int ret;

	u32 flags;

	enum ccp_engine engine;
	u32 engine_error;

	union {
		struct ccp_aes_engine aes;
		struct ccp_xts_aes_engine xts;
		struct ccp_des3_engine des3;
		struct ccp_sha_engine sha;
		struct ccp_rsa_engine rsa;
		struct ccp_passthru_engine passthru;
		struct ccp_passthru_nomap_engine passthru_nomap;
		struct ccp_ecc_engine ecc;
	} u;

	/* Completion callback support */
	void (*callback)(void *data, int err);
	void *data;
};

#endif
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
63b94509 TL	2	/*
	3	* AMD Cryptographic Coprocessor (CCP) driver
	4	*
e652399e	5	* Copyright (C) 2013,2017 Advanced Micro Devices, Inc.
63b94509 TL	6	*
63b94509 TL	7	* Author: Tom Lendacky <thomas.lendacky@amd.com>
58ea8abf	8	* Author: Gary R Hook <gary.hook@amd.com>
63b94509 TL	9	*/
63b94509 TL	10
c8d283ff PB	11	#ifndef __CCP_H__
c8d283ff PB	12	#define __CCP_H__
63b94509 TL	13
	14	#include <linux/scatterlist.h>
	15	#include <linux/workqueue.h>
	16	#include <linux/list.h>
	17	#include <crypto/aes.h>
	18	#include <crypto/sha.h>
	19
63b94509 TL	20	struct ccp_device;
	21	struct ccp_cmd;
	22
720419f0	23	#if defined(CONFIG_CRYPTO_DEV_SP_CCP)
db34cf91	24
c9f21cb6 TL	25	/**
	26	* ccp_present - check if a CCP device is present
	27	*
	28	* Returns zero if a CCP device is present, -ENODEV otherwise.
	29	*/
	30	int ccp_present(void);
	31
c7019c4d GH	32	#define CCP_VSIZE 16
	33	#define CCP_VMASK ((unsigned int)((1 << CCP_VSIZE) - 1))
	34	#define CCP_VERSION(v, r) ((unsigned int)((v << CCP_VSIZE) \
	35	\| (r & CCP_VMASK)))
	36
	37	/**
	38	* ccp_version - get the version of the CCP
	39	*
	40	* Returns a positive version number, or zero if no CCP
	41	*/
	42	unsigned int ccp_version(void);
	43
63b94509 TL	44	/**
	45	* ccp_enqueue_cmd - queue an operation for processing by the CCP
	46	*
	47	* @cmd: ccp_cmd struct to be processed
	48	*
	49	* Refer to the ccp_cmd struct below for required fields.
	50	*
	51	* Queue a cmd to be processed by the CCP. If queueing the cmd
	52	* would exceed the defined length of the cmd queue the cmd will
	53	* only be queued if the CCP_CMD_MAY_BACKLOG flag is set and will
	54	* result in a return code of -EBUSY.
	55	*
	56	* The callback routine specified in the ccp_cmd struct will be
	57	* called to notify the caller of completion (if the cmd was not
	58	* backlogged) or advancement out of the backlog. If the cmd has
	59	* advanced out of the backlog the "err" value of the callback
	60	* will be -EINPROGRESS. Any other "err" value during callback is
	61	* the result of the operation.
	62	*
	63	* The cmd has been successfully queued if:
	64	* the return code is -EINPROGRESS or
	65	* the return code is -EBUSY and CCP_CMD_MAY_BACKLOG flag is set
	66	*/
	67	int ccp_enqueue_cmd(struct ccp_cmd *cmd);
	68
720419f0	69	#else /* CONFIG_CRYPTO_DEV_CCP_SP_DEV is not enabled */
db34cf91	70
c9f21cb6 TL	71	static inline int ccp_present(void)
	72	{
	73	return -ENODEV;
	74	}
	75
c7019c4d GH	76	static inline unsigned int ccp_version(void)
	77	{
	78	return 0;
	79	}
	80
db34cf91 TL	81	static inline int ccp_enqueue_cmd(struct ccp_cmd *cmd)
	82	{
	83	return -ENODEV;
	84	}
	85
720419f0	86	#endif /* CONFIG_CRYPTO_DEV_SP_CCP */
db34cf91	87
63b94509 TL	88
	89	/*** AES engine ***/
	90	/**
	91	* ccp_aes_type - AES key size
	92	*
	93	* @CCP_AES_TYPE_128: 128-bit key
	94	* @CCP_AES_TYPE_192: 192-bit key
	95	* @CCP_AES_TYPE_256: 256-bit key
	96	*/
	97	enum ccp_aes_type {
	98	CCP_AES_TYPE_128 = 0,
	99	CCP_AES_TYPE_192,
	100	CCP_AES_TYPE_256,
	101	CCP_AES_TYPE__LAST,
	102	};
	103
	104	/**
	105	* ccp_aes_mode - AES operation mode
	106	*
	107	* @CCP_AES_MODE_ECB: ECB mode
	108	* @CCP_AES_MODE_CBC: CBC mode
	109	* @CCP_AES_MODE_OFB: OFB mode
	110	* @CCP_AES_MODE_CFB: CFB mode
	111	* @CCP_AES_MODE_CTR: CTR mode
	112	* @CCP_AES_MODE_CMAC: CMAC mode
	113	*/
	114	enum ccp_aes_mode {
	115	CCP_AES_MODE_ECB = 0,
	116	CCP_AES_MODE_CBC,
	117	CCP_AES_MODE_OFB,
	118	CCP_AES_MODE_CFB,
	119	CCP_AES_MODE_CTR,
	120	CCP_AES_MODE_CMAC,
36cf515b GH	121	CCP_AES_MODE_GHASH,
	122	CCP_AES_MODE_GCTR,
	123	CCP_AES_MODE_GCM,
	124	CCP_AES_MODE_GMAC,
63b94509 TL	125	CCP_AES_MODE__LAST,
	126	};
	127
	128	/**
	129	* ccp_aes_mode - AES operation mode
	130	*
	131	* @CCP_AES_ACTION_DECRYPT: AES decrypt operation
	132	* @CCP_AES_ACTION_ENCRYPT: AES encrypt operation
	133	*/
	134	enum ccp_aes_action {
	135	CCP_AES_ACTION_DECRYPT = 0,
	136	CCP_AES_ACTION_ENCRYPT,
	137	CCP_AES_ACTION__LAST,
	138	};
36cf515b GH	139	/* Overloaded field */
	140	#define CCP_AES_GHASHAAD CCP_AES_ACTION_DECRYPT
	141	#define CCP_AES_GHASHFINAL CCP_AES_ACTION_ENCRYPT
63b94509 TL	142
	143	/**
	144	* struct ccp_aes_engine - CCP AES operation
	145	* @type: AES operation key size
	146	* @mode: AES operation mode
	147	* @action: AES operation (decrypt/encrypt)
	148	* @key: key to be used for this AES operation
	149	* @key_len: length in bytes of key
	150	* @iv: IV to be used for this AES operation
	151	* @iv_len: length in bytes of iv
	152	* @src: data to be used for this operation
	153	* @dst: data produced by this operation
	154	* @src_len: length in bytes of data used for this operation
	155	* @cmac_final: indicates final operation when running in CMAC mode
	156	* @cmac_key: K1/K2 key used in final CMAC operation
	157	* @cmac_key_len: length in bytes of cmac_key
	158	*
	159	* Variables required to be set when calling ccp_enqueue_cmd():
	160	* - type, mode, action, key, key_len, src, dst, src_len
	161	* - iv, iv_len for any mode other than ECB
	162	* - cmac_final for CMAC mode
	163	* - cmac_key, cmac_key_len for CMAC mode if cmac_final is non-zero
	164	*
	165	* The iv variable is used as both input and output. On completion of the
	166	* AES operation the new IV overwrites the old IV.
	167	*/
	168	struct ccp_aes_engine {
	169	enum ccp_aes_type type;
	170	enum ccp_aes_mode mode;
	171	enum ccp_aes_action action;
	172
9f00baf7 GH	173	u32 authsize;
9f00baf7 GH	174
63b94509 TL	175	struct scatterlist *key;
	176	u32 key_len; /* In bytes */
	177
	178	struct scatterlist *iv;
	179	u32 iv_len; /* In bytes */
	180
	181	struct scatterlist src, dst;
81a59f00	182	u64 src_len; /* In bytes */
63b94509 TL	183
	184	u32 cmac_final; /* Indicates final cmac cmd */
	185	struct scatterlist cmac_key; / K1/K2 cmac key required for
	186	* final cmac cmd */
	187	u32 cmac_key_len; /* In bytes */
36cf515b GH	188
36cf515b GH	189	u32 aad_len; /* In bytes */
63b94509 TL	190	};
	191
	192	/*** XTS-AES engine ***/
	193	/**
	194	* ccp_xts_aes_unit_size - XTS unit size
	195	*
	196	* @CCP_XTS_AES_UNIT_SIZE_16: Unit size of 16 bytes
	197	* @CCP_XTS_AES_UNIT_SIZE_512: Unit size of 512 bytes
	198	* @CCP_XTS_AES_UNIT_SIZE_1024: Unit size of 1024 bytes
	199	* @CCP_XTS_AES_UNIT_SIZE_2048: Unit size of 2048 bytes
	200	* @CCP_XTS_AES_UNIT_SIZE_4096: Unit size of 4096 bytes
	201	*/
	202	enum ccp_xts_aes_unit_size {
	203	CCP_XTS_AES_UNIT_SIZE_16 = 0,
	204	CCP_XTS_AES_UNIT_SIZE_512,
	205	CCP_XTS_AES_UNIT_SIZE_1024,
	206	CCP_XTS_AES_UNIT_SIZE_2048,
	207	CCP_XTS_AES_UNIT_SIZE_4096,
	208	CCP_XTS_AES_UNIT_SIZE__LAST,
	209	};
	210
	211	/**
	212	* struct ccp_xts_aes_engine - CCP XTS AES operation
	213	* @action: AES operation (decrypt/encrypt)
	214	* @unit_size: unit size of the XTS operation
	215	* @key: key to be used for this XTS AES operation
	216	* @key_len: length in bytes of key
	217	* @iv: IV to be used for this XTS AES operation
	218	* @iv_len: length in bytes of iv
	219	* @src: data to be used for this operation
	220	* @dst: data produced by this operation
	221	* @src_len: length in bytes of data used for this operation
	222	* @final: indicates final XTS operation
	223	*
	224	* Variables required to be set when calling ccp_enqueue_cmd():
	225	* - action, unit_size, key, key_len, iv, iv_len, src, dst, src_len, final
	226	*
	227	* The iv variable is used as both input and output. On completion of the
	228	* AES operation the new IV overwrites the old IV.
	229	*/
	230	struct ccp_xts_aes_engine {
e652399e	231	enum ccp_aes_type type;
63b94509 TL	232	enum ccp_aes_action action;
	233	enum ccp_xts_aes_unit_size unit_size;
	234
	235	struct scatterlist *key;
	236	u32 key_len; /* In bytes */
	237
	238	struct scatterlist *iv;
	239	u32 iv_len; /* In bytes */
	240
	241	struct scatterlist src, dst;
81a59f00	242	u64 src_len; /* In bytes */
63b94509 TL	243
	244	u32 final;
	245	};
	246
	247	/*** SHA engine ***/
63b94509 TL	248	/**
	249	* ccp_sha_type - type of SHA operation
	250	*
	251	* @CCP_SHA_TYPE_1: SHA-1 operation
	252	* @CCP_SHA_TYPE_224: SHA-224 operation
	253	* @CCP_SHA_TYPE_256: SHA-256 operation
	254	*/
	255	enum ccp_sha_type {
	256	CCP_SHA_TYPE_1 = 1,
	257	CCP_SHA_TYPE_224,
	258	CCP_SHA_TYPE_256,
ccebcf3f GH	259	CCP_SHA_TYPE_384,
ccebcf3f GH	260	CCP_SHA_TYPE_512,
63b94509 TL	261	CCP_SHA_TYPE__LAST,
	262	};
	263
	264	/**
	265	* struct ccp_sha_engine - CCP SHA operation
	266	* @type: Type of SHA operation
	267	* @ctx: current hash value
	268	* @ctx_len: length in bytes of hash value
	269	* @src: data to be used for this operation
	270	* @src_len: length in bytes of data used for this operation
c11baa02 TL	271	* @opad: data to be used for final HMAC operation
	272	* @opad_len: length in bytes of data used for final HMAC operation
	273	* @first: indicates first SHA operation
63b94509 TL	274	* @final: indicates final SHA operation
	275	* @msg_bits: total length of the message in bits used in final SHA operation
	276	*
	277	* Variables required to be set when calling ccp_enqueue_cmd():
	278	* - type, ctx, ctx_len, src, src_len, final
	279	* - msg_bits if final is non-zero
	280	*
	281	* The ctx variable is used as both input and output. On completion of the
	282	* SHA operation the new hash value overwrites the old hash value.
	283	*/
	284	struct ccp_sha_engine {
	285	enum ccp_sha_type type;
	286
	287	struct scatterlist *ctx;
	288	u32 ctx_len; /* In bytes */
	289
	290	struct scatterlist *src;
81a59f00	291	u64 src_len; /* In bytes */
63b94509	292
c11baa02 TL	293	struct scatterlist *opad;
	294	u32 opad_len; /* In bytes */
	295
	296	u32 first; /* Indicates first sha cmd */
63b94509 TL	297	u32 final; /* Indicates final sha cmd */
	298	u64 msg_bits; /* Message length in bits required for
	299	* final sha cmd */
	300	};
	301
990672d4 GH	302	/*** 3DES engine ***/
	303	enum ccp_des3_mode {
	304	CCP_DES3_MODE_ECB = 0,
	305	CCP_DES3_MODE_CBC,
	306	CCP_DES3_MODE_CFB,
	307	CCP_DES3_MODE__LAST,
	308	};
	309
	310	enum ccp_des3_type {
	311	CCP_DES3_TYPE_168 = 1,
	312	CCP_DES3_TYPE__LAST,
	313	};
	314
	315	enum ccp_des3_action {
	316	CCP_DES3_ACTION_DECRYPT = 0,
	317	CCP_DES3_ACTION_ENCRYPT,
	318	CCP_DES3_ACTION__LAST,
	319	};
	320
	321	/**
	322	* struct ccp_des3_engine - CCP SHA operation
	323	* @type: Type of 3DES operation
	324	* @mode: cipher mode
	325	* @action: 3DES operation (decrypt/encrypt)
	326	* @key: key to be used for this 3DES operation
	327	* @key_len: length of key (in bytes)
	328	* @iv: IV to be used for this AES operation
	329	* @iv_len: length in bytes of iv
	330	* @src: input data to be used for this operation
	331	* @src_len: length of input data used for this operation (in bytes)
	332	* @dst: output data produced by this operation
	333	*
	334	* Variables required to be set when calling ccp_enqueue_cmd():
	335	* - type, mode, action, key, key_len, src, dst, src_len
	336	* - iv, iv_len for any mode other than ECB
	337	*
	338	* The iv variable is used as both input and output. On completion of the
	339	* 3DES operation the new IV overwrites the old IV.
	340	*/
	341	struct ccp_des3_engine {
	342	enum ccp_des3_type type;
	343	enum ccp_des3_mode mode;
	344	enum ccp_des3_action action;
	345
	346	struct scatterlist *key;
	347	u32 key_len; /* In bytes */
	348
	349	struct scatterlist *iv;
	350	u32 iv_len; /* In bytes */
	351
	352	struct scatterlist src, dst;
	353	u64 src_len; /* In bytes */
	354	};
	355
63b94509 TL	356	/*** RSA engine ***/
	357	/**
	358	* struct ccp_rsa_engine - CCP RSA operation
	359	* @key_size: length in bits of RSA key
	360	* @exp: RSA exponent
	361	* @exp_len: length in bytes of exponent
	362	* @mod: RSA modulus
	363	* @mod_len: length in bytes of modulus
	364	* @src: data to be used for this operation
	365	* @dst: data produced by this operation
	366	* @src_len: length in bytes of data used for this operation
	367	*
	368	* Variables required to be set when calling ccp_enqueue_cmd():
	369	* - key_size, exp, exp_len, mod, mod_len, src, dst, src_len
	370	*/
	371	struct ccp_rsa_engine {
	372	u32 key_size; /* In bits */
	373
	374	struct scatterlist *exp;
	375	u32 exp_len; /* In bytes */
	376
	377	struct scatterlist *mod;
	378	u32 mod_len; /* In bytes */
	379
	380	struct scatterlist src, dst;
	381	u32 src_len; /* In bytes */
	382	};
	383
	384	/*** Passthru engine ***/
	385	/**
	386	* ccp_passthru_bitwise - type of bitwise passthru operation
	387	*
	388	* @CCP_PASSTHRU_BITWISE_NOOP: no bitwise operation performed
	389	* @CCP_PASSTHRU_BITWISE_AND: perform bitwise AND of src with mask
	390	* @CCP_PASSTHRU_BITWISE_OR: perform bitwise OR of src with mask
	391	* @CCP_PASSTHRU_BITWISE_XOR: perform bitwise XOR of src with mask
	392	* @CCP_PASSTHRU_BITWISE_MASK: overwrite with mask
	393	*/
	394	enum ccp_passthru_bitwise {
	395	CCP_PASSTHRU_BITWISE_NOOP = 0,
	396	CCP_PASSTHRU_BITWISE_AND,
	397	CCP_PASSTHRU_BITWISE_OR,
	398	CCP_PASSTHRU_BITWISE_XOR,
	399	CCP_PASSTHRU_BITWISE_MASK,
	400	CCP_PASSTHRU_BITWISE__LAST,
	401	};
	402
	403	/**
	404	* ccp_passthru_byteswap - type of byteswap passthru operation
	405	*
	406	* @CCP_PASSTHRU_BYTESWAP_NOOP: no byte swapping performed
	407	* @CCP_PASSTHRU_BYTESWAP_32BIT: swap bytes within 32-bit words
	408	* @CCP_PASSTHRU_BYTESWAP_256BIT: swap bytes within 256-bit words
	409	*/
	410	enum ccp_passthru_byteswap {
	411	CCP_PASSTHRU_BYTESWAP_NOOP = 0,
	412	CCP_PASSTHRU_BYTESWAP_32BIT,
	413	CCP_PASSTHRU_BYTESWAP_256BIT,
	414	CCP_PASSTHRU_BYTESWAP__LAST,
	415	};
	416
	417	/**
	418	* struct ccp_passthru_engine - CCP pass-through operation
	419	* @bit_mod: bitwise operation to perform
420	* @byte_swap: byteswap operation to perform
421	* @mask: mask to be applied to data
422	* @mask_len: length in bytes of mask
423	* @src: data to be used for this operation
424	* @dst: data produced by this operation
425	* @src_len: length in bytes of data used for this operation
426	* @final: indicate final pass-through operation
427	*
428	* Variables required to be set when calling ccp_enqueue_cmd():
429	* - bit_mod, byte_swap, src, dst, src_len
430	* - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
431	*/
432	struct ccp_passthru_engine {
433	enum ccp_passthru_bitwise bit_mod;
434	enum ccp_passthru_byteswap byte_swap;
435
436	struct scatterlist *mask;
437	u32 mask_len; /* In bytes */
438
439	struct scatterlist src, dst;
81a59f00	440	u64 src_len; /* In bytes */
63b94509 TL	441
	442	u32 final;
	443	};
	444
58ea8abf GH	445	/**
	446	* struct ccp_passthru_nomap_engine - CCP pass-through operation
	447	* without performing DMA mapping
	448	* @bit_mod: bitwise operation to perform
	449	* @byte_swap: byteswap operation to perform
	450	* @mask: mask to be applied to data
	451	* @mask_len: length in bytes of mask
	452	* @src: data to be used for this operation
	453	* @dst: data produced by this operation
	454	* @src_len: length in bytes of data used for this operation
	455	* @final: indicate final pass-through operation
	456	*
	457	* Variables required to be set when calling ccp_enqueue_cmd():
	458	* - bit_mod, byte_swap, src, dst, src_len
	459	* - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
	460	*/
	461	struct ccp_passthru_nomap_engine {
	462	enum ccp_passthru_bitwise bit_mod;
	463	enum ccp_passthru_byteswap byte_swap;
	464
	465	dma_addr_t mask;
	466	u32 mask_len; /* In bytes */
	467
	468	dma_addr_t src_dma, dst_dma;
	469	u64 src_len; /* In bytes */
	470
	471	u32 final;
	472	};
	473
63b94509 TL	474	/*** ECC engine ***/
	475	#define CCP_ECC_MODULUS_BYTES 48 /* 384-bits */
	476	#define CCP_ECC_MAX_OPERANDS 6
	477	#define CCP_ECC_MAX_OUTPUTS 3
	478
	479	/**
	480	* ccp_ecc_function - type of ECC function
	481	*
	482	* @CCP_ECC_FUNCTION_MMUL_384BIT: 384-bit modular multiplication
	483	* @CCP_ECC_FUNCTION_MADD_384BIT: 384-bit modular addition
	484	* @CCP_ECC_FUNCTION_MINV_384BIT: 384-bit multiplicative inverse
	485	* @CCP_ECC_FUNCTION_PADD_384BIT: 384-bit point addition
	486	* @CCP_ECC_FUNCTION_PMUL_384BIT: 384-bit point multiplication
	487	* @CCP_ECC_FUNCTION_PDBL_384BIT: 384-bit point doubling
	488	*/
	489	enum ccp_ecc_function {
	490	CCP_ECC_FUNCTION_MMUL_384BIT = 0,
	491	CCP_ECC_FUNCTION_MADD_384BIT,
	492	CCP_ECC_FUNCTION_MINV_384BIT,
	493	CCP_ECC_FUNCTION_PADD_384BIT,
	494	CCP_ECC_FUNCTION_PMUL_384BIT,
	495	CCP_ECC_FUNCTION_PDBL_384BIT,
	496	};
	497
	498	/**
	499	* struct ccp_ecc_modular_math - CCP ECC modular math parameters
	500	* @operand_1: first operand for the modular math operation
	501	* @operand_1_len: length of the first operand
	502	* @operand_2: second operand for the modular math operation
	503	* (not used for CCP_ECC_FUNCTION_MINV_384BIT)
	504	* @operand_2_len: length of the second operand
	505	* (not used for CCP_ECC_FUNCTION_MINV_384BIT)
	506	* @result: result of the modular math operation
	507	* @result_len: length of the supplied result buffer
	508	*/
	509	struct ccp_ecc_modular_math {
	510	struct scatterlist *operand_1;
	511	unsigned int operand_1_len; /* In bytes */
	512
	513	struct scatterlist *operand_2;
	514	unsigned int operand_2_len; /* In bytes */
	515
	516	struct scatterlist *result;
	517	unsigned int result_len; /* In bytes */
	518	};
	519
	520	/**
	521	* struct ccp_ecc_point - CCP ECC point definition
	522	* @x: the x coordinate of the ECC point
	523	* @x_len: the length of the x coordinate
	524	* @y: the y coordinate of the ECC point
	525	* @y_len: the length of the y coordinate
	526	*/
	527	struct ccp_ecc_point {
	528	struct scatterlist *x;
	529	unsigned int x_len; /* In bytes */
	530
	531	struct scatterlist *y;
	532	unsigned int y_len; /* In bytes */
	533	};
	534
	535	/**
	536	* struct ccp_ecc_point_math - CCP ECC point math parameters
	537	* @point_1: the first point of the ECC point math operation
538	* @point_2: the second point of the ECC point math operation
539	* (only used for CCP_ECC_FUNCTION_PADD_384BIT)
540	* @domain_a: the a parameter of the ECC curve
541	* @domain_a_len: the length of the a parameter
542	* @scalar: the scalar parameter for the point match operation
543	* (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
544	* @scalar_len: the length of the scalar parameter
545	* (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
546	* @result: the point resulting from the point math operation
547	*/
548	struct ccp_ecc_point_math {
549	struct ccp_ecc_point point_1;
550	struct ccp_ecc_point point_2;
551
552	struct scatterlist *domain_a;
553	unsigned int domain_a_len; /* In bytes */
554
555	struct scatterlist *scalar;
556	unsigned int scalar_len; /* In bytes */
557
558	struct ccp_ecc_point result;
559	};
560
561	/**
562	* struct ccp_ecc_engine - CCP ECC operation
563	* @function: ECC function to perform
564	* @mod: ECC modulus
565	* @mod_len: length in bytes of modulus
566	* @mm: module math parameters
567	* @pm: point math parameters
568	* @ecc_result: result of the ECC operation
569	*
570	* Variables required to be set when calling ccp_enqueue_cmd():
571	* - function, mod, mod_len
572	* - operand, operand_len, operand_count, output, output_len, output_count
573	* - ecc_result
574	*/
575	struct ccp_ecc_engine {
576	enum ccp_ecc_function function;
577
578	struct scatterlist *mod;
579	u32 mod_len; /* In bytes */
580
581	union {
582	struct ccp_ecc_modular_math mm;
583	struct ccp_ecc_point_math pm;
584	} u;
585
586	u16 ecc_result;
587	};
588
589
590	/**
591	* ccp_engine - CCP operation identifiers
592	*
593	* @CCP_ENGINE_AES: AES operation
594	* @CCP_ENGINE_XTS_AES: 128-bit XTS AES operation
595	* @CCP_ENGINE_RSVD1: unused
596	* @CCP_ENGINE_SHA: SHA operation
597	* @CCP_ENGINE_RSA: RSA operation
598	* @CCP_ENGINE_PASSTHRU: pass-through operation
599	* @CCP_ENGINE_ZLIB_DECOMPRESS: unused
600	* @CCP_ENGINE_ECC: ECC operation
601	*/
602	enum ccp_engine {
603	CCP_ENGINE_AES = 0,
604	CCP_ENGINE_XTS_AES_128,
990672d4	605	CCP_ENGINE_DES3,
63b94509 TL	606	CCP_ENGINE_SHA,
	607	CCP_ENGINE_RSA,
	608	CCP_ENGINE_PASSTHRU,
	609	CCP_ENGINE_ZLIB_DECOMPRESS,
	610	CCP_ENGINE_ECC,
	611	CCP_ENGINE__LAST,
	612	};
	613
	614	/* Flag values for flags member of ccp_cmd */
58ea8abf GH	615	#define CCP_CMD_MAY_BACKLOG 0x00000001
58ea8abf GH	616	#define CCP_CMD_PASSTHRU_NO_DMA_MAP 0x00000002
63b94509 TL	617
63b94509 TL	618	/**
c8d283ff	619	* struct ccp_cmd - CCP operation request
63b94509 TL	620	* @entry: list element (ccp driver use only)
63b94509 TL	621	* @work: work element used for callbacks (ccp driver use only)
7c468447	622	* @ccp: CCP device to be run on
63b94509 TL	623	* @ret: operation return code (ccp driver use only)
	624	* @flags: cmd processing flags
	625	* @engine: CCP operation to perform
	626	* @engine_error: CCP engine return code
	627	* @u: engine specific structures, refer to specific engine struct below
	628	* @callback: operation completion callback function
	629	* @data: parameter value to be supplied to the callback function
	630	*
	631	* Variables required to be set when calling ccp_enqueue_cmd():
	632	* - engine, callback
	633	* - See the operation structures below for what is required for each
	634	* operation.
	635	*/
	636	struct ccp_cmd {
	637	/* The list_head, work_struct, ccp and ret variables are for use
	638	* by the CCP driver only.
	639	*/
	640	struct list_head entry;
	641	struct work_struct work;
	642	struct ccp_device *ccp;
	643	int ret;
	644
	645	u32 flags;
	646
	647	enum ccp_engine engine;
	648	u32 engine_error;
	649
	650	union {
	651	struct ccp_aes_engine aes;
	652	struct ccp_xts_aes_engine xts;
990672d4	653	struct ccp_des3_engine des3;
63b94509 TL	654	struct ccp_sha_engine sha;
	655	struct ccp_rsa_engine rsa;
	656	struct ccp_passthru_engine passthru;
58ea8abf	657	struct ccp_passthru_nomap_engine passthru_nomap;
63b94509 TL	658	struct ccp_ecc_engine ecc;
	659	} u;
	660
	661	/* Completion callback support */
	662	void (callback)(void data, int err);
	663	void *data;
	664	};
	665
	666	#endif