[mirror_ubuntu-zesty-kernel.git] / include / linux / ccp.h

/*
 * AMD Cryptographic Coprocessor (CCP) driver
 *
 * Copyright (C) 2013 Advanced Micro Devices, Inc.
 *
 * Author: Tom Lendacky <thomas.lendacky@amd.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __CPP_H__
#define __CPP_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_CCP_DD) || \
	defined(CONFIG_CRYPTO_DEV_CCP_DD_MODULE)

/**
 * 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_DD is not enabled */

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

#endif /* CONFIG_CRYPTO_DEV_CCP_DD */


/***** 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__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,
};

/**
 * 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;

	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 */
};

/***** 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_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 *****/
#define CCP_SHA_BLOCKSIZE               SHA256_BLOCK_SIZE
#define CCP_SHA_CTXSIZE                 SHA256_DIGEST_SIZE

/**
 * 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__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 */
};

/***** 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;
};

/***** 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_RSVD1,
	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

/**
 * struct ccp_cmd - CPP 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 (ccp driver use only)
 * @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_sha_engine sha;
		struct ccp_rsa_engine rsa;
		struct ccp_passthru_engine passthru;
		struct ccp_ecc_engine ecc;
	} u;

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

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