[linux-2.6-block.git] / drivers / crypto / caam / caampkc.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * caam - Freescale FSL CAAM support for Public Key Cryptography descriptors
 *
 * Copyright 2016 Freescale Semiconductor, Inc.
 *
 * There is no Shared Descriptor for PKC so that the Job Descriptor must carry
 * all the desired key parameters, input and output pointers.
 */

#ifndef _PKC_DESC_H_
#define _PKC_DESC_H_
#include "compat.h"
#include "pdb.h"

/**
 * caam_priv_key_form - CAAM RSA private key representation
 * CAAM RSA private key may have either of three forms.
 *
 * 1. The first representation consists of the pair (n, d), where the
 *    components have the following meanings:
 *        n      the RSA modulus
 *        d      the RSA private exponent
 *
 * 2. The second representation consists of the triplet (p, q, d), where the
 *    components have the following meanings:
 *        p      the first prime factor of the RSA modulus n
 *        q      the second prime factor of the RSA modulus n
 *        d      the RSA private exponent
 *
 * 3. The third representation consists of the quintuple (p, q, dP, dQ, qInv),
 *    where the components have the following meanings:
 *        p      the first prime factor of the RSA modulus n
 *        q      the second prime factor of the RSA modulus n
 *        dP     the first factors's CRT exponent
 *        dQ     the second factors's CRT exponent
 *        qInv   the (first) CRT coefficient
 *
 * The benefit of using the third or the second key form is lower computational
 * cost for the decryption and signature operations.
 */
enum caam_priv_key_form {
	FORM1,
	FORM2,
	FORM3
};

/**
 * caam_rsa_key - CAAM RSA key structure. Keys are allocated in DMA zone.
 * @n           : RSA modulus raw byte stream
 * @e           : RSA public exponent raw byte stream
 * @d           : RSA private exponent raw byte stream
 * @p           : RSA prime factor p of RSA modulus n
 * @q           : RSA prime factor q of RSA modulus n
 * @dp          : RSA CRT exponent of p
 * @dp          : RSA CRT exponent of q
 * @qinv        : RSA CRT coefficient
 * @tmp1        : CAAM uses this temporary buffer as internal state buffer.
 *                It is assumed to be as long as p.
 * @tmp2        : CAAM uses this temporary buffer as internal state buffer.
 *                It is assumed to be as long as q.
 * @n_sz        : length in bytes of RSA modulus n
 * @e_sz        : length in bytes of RSA public exponent
 * @d_sz        : length in bytes of RSA private exponent
 * @p_sz        : length in bytes of RSA prime factor p of RSA modulus n
 * @q_sz        : length in bytes of RSA prime factor q of RSA modulus n
 * @priv_form   : CAAM RSA private key representation
 */
struct caam_rsa_key {
	u8 *n;
	u8 *e;
	u8 *d;
	u8 *p;
	u8 *q;
	u8 *dp;
	u8 *dq;
	u8 *qinv;
	u8 *tmp1;
	u8 *tmp2;
	size_t n_sz;
	size_t e_sz;
	size_t d_sz;
	size_t p_sz;
	size_t q_sz;
	enum caam_priv_key_form priv_form;
};

/**
 * caam_rsa_ctx - per session context.
 * @key         : RSA key in DMA zone
 * @dev         : device structure
 * @padding_dma : dma address of padding, for adding it to the input
 */
struct caam_rsa_ctx {
	struct caam_rsa_key key;
	struct device *dev;
	dma_addr_t padding_dma;

};

/**
 * caam_rsa_req_ctx - per request context.
 * @src           : input scatterlist (stripped of leading zeros)
 * @fixup_src     : input scatterlist (that might be stripped of leading zeros)
 * @fixup_src_len : length of the fixup_src input scatterlist
 */
struct caam_rsa_req_ctx {
	struct scatterlist src[2];
	struct scatterlist *fixup_src;
	unsigned int fixup_src_len;
};

/**
 * rsa_edesc - s/w-extended rsa descriptor
 * @src_nents     : number of segments in input s/w scatterlist
 * @dst_nents     : number of segments in output s/w scatterlist
 * @mapped_src_nents: number of segments in input h/w link table
 * @mapped_dst_nents: number of segments in output h/w link table
 * @sec4_sg_bytes : length of h/w link table
 * @sec4_sg_dma   : dma address of h/w link table
 * @sec4_sg       : pointer to h/w link table
 * @pdb           : specific RSA Protocol Data Block (PDB)
 * @hw_desc       : descriptor followed by link tables if any
 */
struct rsa_edesc {
	int src_nents;
	int dst_nents;
	int mapped_src_nents;
	int mapped_dst_nents;
	int sec4_sg_bytes;
	dma_addr_t sec4_sg_dma;
	struct sec4_sg_entry *sec4_sg;
	union {
		struct rsa_pub_pdb pub;
		struct rsa_priv_f1_pdb priv_f1;
		struct rsa_priv_f2_pdb priv_f2;
		struct rsa_priv_f3_pdb priv_f3;
	} pdb;
	u32 hw_desc[];
};

/* Descriptor construction primitives. */
void init_rsa_pub_desc(u32 *desc, struct rsa_pub_pdb *pdb);
void init_rsa_priv_f1_desc(u32 *desc, struct rsa_priv_f1_pdb *pdb);
void init_rsa_priv_f2_desc(u32 *desc, struct rsa_priv_f2_pdb *pdb);
void init_rsa_priv_f3_desc(u32 *desc, struct rsa_priv_f3_pdb *pdb);

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
8c419778 TA	2	/*
	3	* caam - Freescale FSL CAAM support for Public Key Cryptography descriptors
	4	*
	5	* Copyright 2016 Freescale Semiconductor, Inc.
	6	*
	7	* There is no Shared Descriptor for PKC so that the Job Descriptor must carry
	8	* all the desired key parameters, input and output pointers.
	9	*/
	10
	11	#ifndef _PKC_DESC_H_
	12	#define _PKC_DESC_H_
	13	#include "compat.h"
	14	#include "pdb.h"
	15
52e26d77 RA	16	/**
52e26d77 RA	17	* caam_priv_key_form - CAAM RSA private key representation
4a651b12	18	* CAAM RSA private key may have either of three forms.
52e26d77 RA	19	*
	20	* 1. The first representation consists of the pair (n, d), where the
	21	* components have the following meanings:
	22	* n the RSA modulus
	23	* d the RSA private exponent
	24	*
	25	* 2. The second representation consists of the triplet (p, q, d), where the
	26	* components have the following meanings:
	27	* p the first prime factor of the RSA modulus n
	28	* q the second prime factor of the RSA modulus n
	29	* d the RSA private exponent
4a651b12 RA	30	*
	31	* 3. The third representation consists of the quintuple (p, q, dP, dQ, qInv),
	32	* where the components have the following meanings:
	33	* p the first prime factor of the RSA modulus n
	34	* q the second prime factor of the RSA modulus n
	35	* dP the first factors's CRT exponent
	36	* dQ the second factors's CRT exponent
	37	* qInv the (first) CRT coefficient
	38	*
	39	* The benefit of using the third or the second key form is lower computational
	40	* cost for the decryption and signature operations.
52e26d77 RA	41	*/
	42	enum caam_priv_key_form {
	43	FORM1,
	44	FORM2,
4a651b12	45	FORM3
52e26d77 RA	46	};
52e26d77 RA	47
8c419778 TA	48	/**
	49	* caam_rsa_key - CAAM RSA key structure. Keys are allocated in DMA zone.
	50	* @n : RSA modulus raw byte stream
	51	* @e : RSA public exponent raw byte stream
	52	* @d : RSA private exponent raw byte stream
52e26d77 RA	53	* @p : RSA prime factor p of RSA modulus n
52e26d77 RA	54	* @q : RSA prime factor q of RSA modulus n
4a651b12 RA	55	* @dp : RSA CRT exponent of p
	56	* @dp : RSA CRT exponent of q
	57	* @qinv : RSA CRT coefficient
52e26d77 RA	58	* @tmp1 : CAAM uses this temporary buffer as internal state buffer.
	59	* It is assumed to be as long as p.
	60	* @tmp2 : CAAM uses this temporary buffer as internal state buffer.
	61	* It is assumed to be as long as q.
8c419778 TA	62	* @n_sz : length in bytes of RSA modulus n
	63	* @e_sz : length in bytes of RSA public exponent
	64	* @d_sz : length in bytes of RSA private exponent
52e26d77 RA	65	* @p_sz : length in bytes of RSA prime factor p of RSA modulus n
	66	* @q_sz : length in bytes of RSA prime factor q of RSA modulus n
	67	* @priv_form : CAAM RSA private key representation
8c419778 TA	68	*/
	69	struct caam_rsa_key {
	70	u8 *n;
	71	u8 *e;
	72	u8 *d;
52e26d77 RA	73	u8 *p;
52e26d77 RA	74	u8 *q;
4a651b12 RA	75	u8 *dp;
	76	u8 *dq;
	77	u8 *qinv;
52e26d77 RA	78	u8 *tmp1;
52e26d77 RA	79	u8 *tmp2;
8c419778 TA	80	size_t n_sz;
	81	size_t e_sz;
	82	size_t d_sz;
52e26d77 RA	83	size_t p_sz;
	84	size_t q_sz;
	85	enum caam_priv_key_form priv_form;
8c419778 TA	86	};
	87
	88	/**
	89	* caam_rsa_ctx - per session context.
	90	* @key : RSA key in DMA zone
	91	* @dev : device structure
c3725f7c	92	* @padding_dma : dma address of padding, for adding it to the input
8c419778 TA	93	*/
	94	struct caam_rsa_ctx {
	95	struct caam_rsa_key key;
	96	struct device *dev;
c3725f7c	97	dma_addr_t padding_dma;
3b2614cb	98
8c419778 TA	99	};
8c419778 TA	100
8a2a0dd3 HG	101	/**
8a2a0dd3 HG	102	* caam_rsa_req_ctx - per request context.
3b2614cb IP	103	* @src : input scatterlist (stripped of leading zeros)
	104	* @fixup_src : input scatterlist (that might be stripped of leading zeros)
	105	* @fixup_src_len : length of the fixup_src input scatterlist
8a2a0dd3 HG	106	*/
	107	struct caam_rsa_req_ctx {
	108	struct scatterlist src[2];
3b2614cb IP	109	struct scatterlist *fixup_src;
3b2614cb IP	110	unsigned int fixup_src_len;
8a2a0dd3 HG	111	};
8a2a0dd3 HG	112
8c419778 TA	113	/**
8c419778 TA	114	* rsa_edesc - s/w-extended rsa descriptor
eff9771d IP	115	* @src_nents : number of segments in input s/w scatterlist
	116	* @dst_nents : number of segments in output s/w scatterlist
	117	* @mapped_src_nents: number of segments in input h/w link table
	118	* @mapped_dst_nents: number of segments in output h/w link table
8c419778 TA	119	* @sec4_sg_bytes : length of h/w link table
	120	* @sec4_sg_dma : dma address of h/w link table
	121	* @sec4_sg : pointer to h/w link table
	122	* @pdb : specific RSA Protocol Data Block (PDB)
	123	* @hw_desc : descriptor followed by link tables if any
	124	*/
	125	struct rsa_edesc {
	126	int src_nents;
	127	int dst_nents;
eff9771d IP	128	int mapped_src_nents;
eff9771d IP	129	int mapped_dst_nents;
8c419778 TA	130	int sec4_sg_bytes;
	131	dma_addr_t sec4_sg_dma;
	132	struct sec4_sg_entry *sec4_sg;
	133	union {
	134	struct rsa_pub_pdb pub;
	135	struct rsa_priv_f1_pdb priv_f1;
52e26d77	136	struct rsa_priv_f2_pdb priv_f2;
4a651b12	137	struct rsa_priv_f3_pdb priv_f3;
8c419778 TA	138	} pdb;
	139	u32 hw_desc[];
	140	};
	141
	142	/* Descriptor construction primitives. */
	143	void init_rsa_pub_desc(u32 desc, struct rsa_pub_pdb pdb);
	144	void init_rsa_priv_f1_desc(u32 desc, struct rsa_priv_f1_pdb pdb);
52e26d77	145	void init_rsa_priv_f2_desc(u32 desc, struct rsa_priv_f2_pdb pdb);
4a651b12	146	void init_rsa_priv_f3_desc(u32 desc, struct rsa_priv_f3_pdb pdb);
8c419778 TA	147
8c419778 TA	148	#endif