xref: /linux/drivers/crypto/chelsio/chcr_crypto.h (revision bb1c928df78ee6e3665a0d013e74108cc9abf34b)
1 /*
2  * This file is part of the Chelsio T6 Crypto driver for Linux.
3  *
4  * Copyright (c) 2003-2016 Chelsio Communications, Inc. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  *
34  */
35 
36 #ifndef __CHCR_CRYPTO_H__
37 #define __CHCR_CRYPTO_H__
38 
39 #define GHASH_BLOCK_SIZE    16
40 #define GHASH_DIGEST_SIZE   16
41 
42 #define CCM_B0_SIZE             16
43 #define CCM_AAD_FIELD_SIZE      2
44 #define T6_MAX_AAD_SIZE 511
45 
46 
47 /* Define following if h/w is not dropping the AAD and IV data before
48  * giving the processed data
49  */
50 
51 #define CHCR_CRA_PRIORITY 500
52 #define CHCR_AEAD_PRIORITY 6000
53 #define CHCR_AES_MAX_KEY_LEN  (2 * (AES_MAX_KEY_SIZE)) /* consider xts */
54 #define CHCR_MAX_CRYPTO_IV_LEN 16 /* AES IV len */
55 
56 #define CHCR_MAX_AUTHENC_AES_KEY_LEN 32 /* max aes key length*/
57 #define CHCR_MAX_AUTHENC_SHA_KEY_LEN 128 /* max sha key length*/
58 
59 #define CHCR_GIVENCRYPT_OP 2
60 /* CPL/SCMD parameters */
61 
62 #define CHCR_ENCRYPT_OP 0
63 #define CHCR_DECRYPT_OP 1
64 
65 #define CHCR_SCMD_SEQ_NO_CTRL_32BIT     1
66 #define CHCR_SCMD_SEQ_NO_CTRL_48BIT     2
67 #define CHCR_SCMD_SEQ_NO_CTRL_64BIT     3
68 
69 #define CHCR_SCMD_PROTO_VERSION_GENERIC 4
70 
71 #define CHCR_SCMD_AUTH_CTRL_AUTH_CIPHER 0
72 #define CHCR_SCMD_AUTH_CTRL_CIPHER_AUTH 1
73 
74 #define CHCR_SCMD_CIPHER_MODE_NOP               0
75 #define CHCR_SCMD_CIPHER_MODE_AES_CBC           1
76 #define CHCR_SCMD_CIPHER_MODE_AES_GCM           2
77 #define CHCR_SCMD_CIPHER_MODE_AES_CTR           3
78 #define CHCR_SCMD_CIPHER_MODE_GENERIC_AES       4
79 #define CHCR_SCMD_CIPHER_MODE_AES_XTS           6
80 #define CHCR_SCMD_CIPHER_MODE_AES_CCM           7
81 
82 #define CHCR_SCMD_AUTH_MODE_NOP             0
83 #define CHCR_SCMD_AUTH_MODE_SHA1            1
84 #define CHCR_SCMD_AUTH_MODE_SHA224          2
85 #define CHCR_SCMD_AUTH_MODE_SHA256          3
86 #define CHCR_SCMD_AUTH_MODE_GHASH           4
87 #define CHCR_SCMD_AUTH_MODE_SHA512_224      5
88 #define CHCR_SCMD_AUTH_MODE_SHA512_256      6
89 #define CHCR_SCMD_AUTH_MODE_SHA512_384      7
90 #define CHCR_SCMD_AUTH_MODE_SHA512_512      8
91 #define CHCR_SCMD_AUTH_MODE_CBCMAC          9
92 #define CHCR_SCMD_AUTH_MODE_CMAC            10
93 
94 #define CHCR_SCMD_HMAC_CTRL_NOP             0
95 #define CHCR_SCMD_HMAC_CTRL_NO_TRUNC        1
96 #define CHCR_SCMD_HMAC_CTRL_TRUNC_RFC4366   2
97 #define CHCR_SCMD_HMAC_CTRL_IPSEC_96BIT     3
98 #define CHCR_SCMD_HMAC_CTRL_PL1		    4
99 #define CHCR_SCMD_HMAC_CTRL_PL2		    5
100 #define CHCR_SCMD_HMAC_CTRL_PL3		    6
101 #define CHCR_SCMD_HMAC_CTRL_DIV2	    7
102 #define VERIFY_HW 0
103 #define VERIFY_SW 1
104 
105 #define CHCR_SCMD_IVGEN_CTRL_HW             0
106 #define CHCR_SCMD_IVGEN_CTRL_SW             1
107 /* This are not really mac key size. They are intermediate values
108  * of sha engine and its size
109  */
110 #define CHCR_KEYCTX_MAC_KEY_SIZE_128        0
111 #define CHCR_KEYCTX_MAC_KEY_SIZE_160        1
112 #define CHCR_KEYCTX_MAC_KEY_SIZE_192        2
113 #define CHCR_KEYCTX_MAC_KEY_SIZE_256        3
114 #define CHCR_KEYCTX_MAC_KEY_SIZE_512        4
115 #define CHCR_KEYCTX_CIPHER_KEY_SIZE_128     0
116 #define CHCR_KEYCTX_CIPHER_KEY_SIZE_192     1
117 #define CHCR_KEYCTX_CIPHER_KEY_SIZE_256     2
118 #define CHCR_KEYCTX_NO_KEY                  15
119 
120 #define CHCR_CPL_FW4_PLD_IV_OFFSET          (5 * 64) /* bytes. flt #5 and #6 */
121 #define CHCR_CPL_FW4_PLD_HASH_RESULT_OFFSET (7 * 64) /* bytes. flt #7 */
122 #define CHCR_CPL_FW4_PLD_DATA_SIZE          (4 * 64) /* bytes. flt #4 to #7 */
123 
124 #define KEY_CONTEXT_HDR_SALT_AND_PAD	    16
125 #define flits_to_bytes(x)  (x * 8)
126 
127 #define IV_NOP                  0
128 #define IV_IMMEDIATE            1
129 #define IV_DSGL			2
130 
131 #define AEAD_H_SIZE             16
132 
133 #define CRYPTO_ALG_SUB_TYPE_MASK            0x0f000000
134 #define CRYPTO_ALG_SUB_TYPE_HASH_HMAC       0x01000000
135 #define CRYPTO_ALG_SUB_TYPE_AEAD_RFC4106    0x02000000
136 #define CRYPTO_ALG_SUB_TYPE_AEAD_GCM	    0x03000000
137 #define CRYPTO_ALG_SUB_TYPE_AEAD_AUTHENC    0x04000000
138 #define CRYPTO_ALG_SUB_TYPE_AEAD_CCM        0x05000000
139 #define CRYPTO_ALG_SUB_TYPE_AEAD_RFC4309    0x06000000
140 #define CRYPTO_ALG_SUB_TYPE_AEAD_NULL       0x07000000
141 #define CRYPTO_ALG_SUB_TYPE_CTR             0x08000000
142 #define CRYPTO_ALG_SUB_TYPE_CTR_RFC3686     0x09000000
143 #define CRYPTO_ALG_SUB_TYPE_XTS		    0x0a000000
144 #define CRYPTO_ALG_SUB_TYPE_CBC		    0x0b000000
145 #define CRYPTO_ALG_TYPE_HMAC (CRYPTO_ALG_TYPE_AHASH |\
146 			      CRYPTO_ALG_SUB_TYPE_HASH_HMAC)
147 
148 #define MAX_SCRATCH_PAD_SIZE    32
149 
150 #define CHCR_HASH_MAX_BLOCK_SIZE_64  64
151 #define CHCR_HASH_MAX_BLOCK_SIZE_128 128
152 #define CHCR_SG_SIZE 2048
153 
154 /* Aligned to 128 bit boundary */
155 
156 struct ablk_ctx {
157 	struct crypto_skcipher *sw_cipher;
158 	struct crypto_cipher *aes_generic;
159 	__be32 key_ctx_hdr;
160 	unsigned int enckey_len;
161 	unsigned char ciph_mode;
162 	u8 key[CHCR_AES_MAX_KEY_LEN];
163 	u8 nonce[4];
164 	u8 rrkey[AES_MAX_KEY_SIZE];
165 };
166 struct chcr_aead_reqctx {
167 	struct	sk_buff	*skb;
168 	struct scatterlist *dst;
169 	struct scatterlist *newdstsg;
170 	struct scatterlist srcffwd[2];
171 	struct scatterlist dstffwd[2];
172 	short int dst_nents;
173 	u16 verify;
174 	u8 iv[CHCR_MAX_CRYPTO_IV_LEN];
175 	unsigned char scratch_pad[MAX_SCRATCH_PAD_SIZE];
176 };
177 
178 struct chcr_gcm_ctx {
179 	u8 ghash_h[AEAD_H_SIZE];
180 };
181 
182 struct chcr_authenc_ctx {
183 	u8 dec_rrkey[AES_MAX_KEY_SIZE];
184 	u8 h_iopad[2 * CHCR_HASH_MAX_DIGEST_SIZE];
185 	unsigned char auth_mode;
186 };
187 
188 struct __aead_ctx {
189 	struct chcr_gcm_ctx gcm[0];
190 	struct chcr_authenc_ctx authenc[0];
191 };
192 
193 
194 
195 struct chcr_aead_ctx {
196 	__be32 key_ctx_hdr;
197 	unsigned int enckey_len;
198 	struct crypto_skcipher *null;
199 	struct crypto_aead *sw_cipher;
200 	u8 salt[MAX_SALT];
201 	u8 key[CHCR_AES_MAX_KEY_LEN];
202 	u16 hmac_ctrl;
203 	u16 mayverify;
204 	struct	__aead_ctx ctx[0];
205 };
206 
207 
208 
209 struct hmac_ctx {
210 	struct crypto_shash *base_hash;
211 	u8 ipad[CHCR_HASH_MAX_BLOCK_SIZE_128];
212 	u8 opad[CHCR_HASH_MAX_BLOCK_SIZE_128];
213 };
214 
215 struct __crypto_ctx {
216 	struct hmac_ctx hmacctx[0];
217 	struct ablk_ctx ablkctx[0];
218 	struct chcr_aead_ctx aeadctx[0];
219 };
220 
221 struct chcr_context {
222 	struct chcr_dev *dev;
223 	unsigned char tx_qidx;
224 	unsigned char rx_qidx;
225 	struct __crypto_ctx crypto_ctx[0];
226 };
227 
228 struct chcr_ahash_req_ctx {
229 	u32 result;
230 	u8 bfr1[CHCR_HASH_MAX_BLOCK_SIZE_128];
231 	u8 bfr2[CHCR_HASH_MAX_BLOCK_SIZE_128];
232 	u8 *reqbfr;
233 	u8 *skbfr;
234 	u8 reqlen;
235 	/* DMA the partial hash in it */
236 	u8 partial_hash[CHCR_HASH_MAX_DIGEST_SIZE];
237 	u64 data_len;  /* Data len till time */
238 	/* SKB which is being sent to the hardware for processing */
239 	struct sk_buff *skb;
240 };
241 
242 struct chcr_blkcipher_req_ctx {
243 	struct sk_buff *skb;
244 	struct scatterlist srcffwd[2];
245 	struct scatterlist dstffwd[2];
246 	struct scatterlist *dstsg;
247 	struct scatterlist *dst;
248 	struct scatterlist *newdstsg;
249 	unsigned int processed;
250 	unsigned int op;
251 	short int dst_nents;
252 	u8 iv[CHCR_MAX_CRYPTO_IV_LEN];
253 };
254 
255 struct chcr_alg_template {
256 	u32 type;
257 	u32 is_registered;
258 	union {
259 		struct crypto_alg crypto;
260 		struct ahash_alg hash;
261 		struct aead_alg aead;
262 	} alg;
263 };
264 
265 struct chcr_req_ctx {
266 	union {
267 		struct ahash_request *ahash_req;
268 		struct aead_request *aead_req;
269 		struct ablkcipher_request *ablk_req;
270 	} req;
271 	union {
272 		struct chcr_ahash_req_ctx *ahash_ctx;
273 		struct chcr_aead_reqctx *reqctx;
274 		struct chcr_blkcipher_req_ctx *ablk_ctx;
275 	} ctx;
276 };
277 
278 struct sge_opaque_hdr {
279 	void *dev;
280 	dma_addr_t addr[MAX_SKB_FRAGS + 1];
281 };
282 
283 typedef struct sk_buff *(*create_wr_t)(struct aead_request *req,
284 				       unsigned short qid,
285 				       int size,
286 				       unsigned short op_type);
287 
288 static int chcr_aead_op(struct aead_request *req_base,
289 			  unsigned short op_type,
290 			  int size,
291 			  create_wr_t create_wr_fn);
292 static inline int get_aead_subtype(struct crypto_aead *aead);
293 static int is_newsg(struct scatterlist *sgl, unsigned int *newents);
294 static struct scatterlist *alloc_new_sg(struct scatterlist *sgl,
295 					unsigned int nents);
296 static inline void free_new_sg(struct scatterlist *sgl);
297 static int chcr_handle_cipher_resp(struct ablkcipher_request *req,
298 				   unsigned char *input, int err);
299 #endif /* __CHCR_CRYPTO_H__ */
300