1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Cavium, Inc
5 #ifndef _CPT_MCODE_DEFINES_H_
6 #define _CPT_MCODE_DEFINES_H_
8 #include <rte_byteorder.h>
9 #include <rte_crypto_asym.h>
10 #include <rte_memory.h>
13 * This file defines macros and structures according to microcode spec
17 #define CPT_MAJOR_OP_FC 0x33
18 #define CPT_MAJOR_OP_HASH 0x34
19 #define CPT_MAJOR_OP_HMAC 0x35
20 #define CPT_MAJOR_OP_ZUC_SNOW3G 0x37
21 #define CPT_MAJOR_OP_KASUMI 0x38
22 #define CPT_MAJOR_OP_MISC 0x01
25 #define CPT_MAJOR_OP_MODEX 0x03
26 #define CPT_MAJOR_OP_ECDSA 0x04
27 #define CPT_MAJOR_OP_ECC 0x05
28 #define CPT_MINOR_OP_MODEX 0x01
29 #define CPT_MINOR_OP_PKCS_ENC 0x02
30 #define CPT_MINOR_OP_PKCS_ENC_CRT 0x03
31 #define CPT_MINOR_OP_PKCS_DEC 0x04
32 #define CPT_MINOR_OP_PKCS_DEC_CRT 0x05
33 #define CPT_MINOR_OP_MODEX_CRT 0x06
34 #define CPT_MINOR_OP_ECDSA_SIGN 0x01
35 #define CPT_MINOR_OP_ECDSA_VERIFY 0x02
36 #define CPT_MINOR_OP_ECC_UMP 0x03
38 #define CPT_BLOCK_TYPE1 0
39 #define CPT_BLOCK_TYPE2 1
41 #define CPT_BYTE_16 16
42 #define CPT_BYTE_24 24
43 #define CPT_BYTE_32 32
44 #define CPT_MAX_SG_IN_OUT_CNT 32
45 #define CPT_MAX_SG_CNT (CPT_MAX_SG_IN_OUT_CNT/2)
47 #define COMPLETION_CODE_SIZE 8
48 #define COMPLETION_CODE_INIT 0
50 #define SG_LIST_HDR_SIZE (8u)
51 #define SG_ENTRY_SIZE sizeof(sg_comp_t)
53 #define CPT_DMA_MODE (1 << 7)
55 #define CPT_FROM_CTX 0
56 #define CPT_FROM_DPTR 1
59 #define ZUC_SNOW3G 0x2
68 #define CPT_OP_CIPHER_ENCRYPT 0x1
69 #define CPT_OP_CIPHER_DECRYPT 0x2
70 #define CPT_OP_CIPHER_MASK 0x3
72 #define CPT_OP_AUTH_VERIFY 0x4
73 #define CPT_OP_AUTH_GENERATE 0x8
74 #define CPT_OP_AUTH_MASK 0xC
76 #define CPT_OP_ENCODE (CPT_OP_CIPHER_ENCRYPT | CPT_OP_AUTH_GENERATE)
77 #define CPT_OP_DECODE (CPT_OP_CIPHER_DECRYPT | CPT_OP_AUTH_VERIFY)
79 /* #define CPT_ALWAYS_USE_SG_MODE */
80 #define CPT_ALWAYS_USE_SEPARATE_BUF
83 * Parameters for Flexi Crypto
86 #define VALID_AAD_BUF 0x01
87 #define VALID_MAC_BUF 0x02
88 #define VALID_IV_BUF 0x04
89 #define SINGLE_BUF_INPLACE 0x08
90 #define SINGLE_BUF_HEADTAILROOM 0x10
92 #define ENCR_IV_OFFSET(__d_offs) ((__d_offs >> 32) & 0xffff)
93 #define ENCR_OFFSET(__d_offs) ((__d_offs >> 16) & 0xffff)
94 #define AUTH_OFFSET(__d_offs) (__d_offs & 0xffff)
95 #define ENCR_DLEN(__d_lens) (__d_lens >> 32)
96 #define AUTH_DLEN(__d_lens) (__d_lens & 0xffffffff)
98 /* FC offset_control at start of DPTR in bytes */
99 #define OFF_CTRL_LEN 8 /**< bytes */
117 /* These are only for software use */
120 KASUMI_F9_CBC = 0x92,
121 KASUMI_F9_ECB = 0x93,
125 /* To support passthrough */
128 * These are defined by MC for Flexi crypto
129 * for field of 4 bits
140 /* These are only for software use */
143 KASUMI_F8_CBC = 0x92,
144 KASUMI_F8_ECB = 0x93,
154 /* Microcode errors */
156 ERR_OPCODE_UNSUPPORTED = 0x01,
159 ERR_SCATTER_GATHER_WRITE_LENGTH = 0x02,
160 ERR_SCATTER_GATHER_LIST = 0x03,
161 ERR_SCATTER_GATHER_NOT_SUPPORTED = 0x04,
164 ERR_GC_LENGTH_INVALID = 0x41,
165 ERR_GC_RANDOM_LEN_INVALID = 0x42,
166 ERR_GC_DATA_LEN_INVALID = 0x43,
167 ERR_GC_DRBG_TYPE_INVALID = 0x44,
168 ERR_GC_CTX_LEN_INVALID = 0x45,
169 ERR_GC_CIPHER_UNSUPPORTED = 0x46,
170 ERR_GC_AUTH_UNSUPPORTED = 0x47,
171 ERR_GC_OFFSET_INVALID = 0x48,
172 ERR_GC_HASH_MODE_UNSUPPORTED = 0x49,
173 ERR_GC_DRBG_ENTROPY_LEN_INVALID = 0x4a,
174 ERR_GC_DRBG_ADDNL_LEN_INVALID = 0x4b,
175 ERR_GC_ICV_MISCOMPARE = 0x4c,
176 ERR_GC_DATA_UNALIGNED = 0x4d,
179 ERR_BAD_ALT_CCODE = 0xfd,
180 ERR_REQ_PENDING = 0xfe,
181 ERR_REQ_TIMEOUT = 0xff,
183 ERR_BAD_INPUT_LENGTH = (0x40000000 | 384), /* 0x40000180 */
186 ERR_BAD_CONTEXT_HANDLE,
187 ERR_BAD_SCALAR_LENGTH,
188 ERR_BAD_DIGEST_LENGTH,
190 ERR_BAD_RECORD_PADDING,
191 ERR_NB_REQUEST_PENDING,
197 * Enumeration cpt_comp_e
199 * CPT Completion Enumeration
200 * Enumerates the values of CPT_RES_S[COMPCODE].
203 CPT_8X_COMP_E_NOTDONE = (0x00),
204 CPT_8X_COMP_E_GOOD = (0x01),
205 CPT_8X_COMP_E_FAULT = (0x02),
206 CPT_8X_COMP_E_SWERR = (0x03),
207 CPT_8X_COMP_E_HWERR = (0x04),
208 CPT_8X_COMP_E_LAST_ENTRY = (0xFF)
212 * Enumeration cpt_ec_id
214 * Enumerates supported elliptic curves
225 typedef struct sglist_comp {
235 struct cpt_sess_misc {
238 /** ZUC, SNOW3G & KASUMI flags */
240 /** Flag for AES GCM */
242 /** Flag for AES CTR */
244 /** Flag for NULL cipher/auth */
252 /** MAC len in bytes */
254 /** IV length in bytes */
256 /** Auth IV length in bytes */
257 uint8_t auth_iv_length;
258 /** Reserved field */
260 /** IV offset in bytes */
262 /** Auth IV offset in bytes */
263 uint16_t auth_iv_offset;
266 /** Context DMA address */
267 phys_addr_t ctx_dma_addr;
273 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
274 uint64_t enc_cipher : 4;
275 uint64_t reserved1 : 1;
276 uint64_t aes_key : 2;
277 uint64_t iv_source : 1;
278 uint64_t hash_type : 4;
279 uint64_t reserved2 : 3;
280 uint64_t auth_input_type : 1;
281 uint64_t mac_len : 8;
282 uint64_t reserved3 : 8;
283 uint64_t encr_offset : 16;
284 uint64_t iv_offset : 8;
285 uint64_t auth_offset : 8;
287 uint64_t auth_offset : 8;
288 uint64_t iv_offset : 8;
289 uint64_t encr_offset : 16;
290 uint64_t reserved3 : 8;
291 uint64_t mac_len : 8;
292 uint64_t auth_input_type : 1;
293 uint64_t reserved2 : 3;
294 uint64_t hash_type : 4;
295 uint64_t iv_source : 1;
296 uint64_t aes_key : 2;
297 uint64_t reserved1 : 1;
298 uint64_t enc_cipher : 4;
304 encr_ctrl_t enc_ctrl;
305 uint8_t encr_key[32];
312 } mc_fc_hmac_context_t;
315 mc_enc_context_t enc;
316 mc_fc_hmac_context_t hmac;
320 uint8_t encr_auth_iv[16];
322 uint8_t zuc_const[32];
323 } mc_zuc_snow3g_ctx_t;
331 /* Below fields are accessed by sw */
332 uint64_t enc_cipher :8;
333 uint64_t hash_type :8;
335 uint64_t auth_key_len :8;
338 uint64_t zsk_flags :3;
342 /* Below fields are accessed by hardware */
344 mc_fc_context_t fctx;
345 mc_zuc_snow3g_ctx_t zs_ctx;
346 mc_kasumi_ctx_t k_ctx;
348 uint8_t auth_key[64];
351 /* Prime and order fields of built-in elliptic curves */
352 struct cpt_ec_group {
354 /* P521 maximum length */
360 /* P521 maximum length */
366 struct cpt_asym_ec_ctx {
367 /* Prime length defined by microcode for EC operations */
371 struct cpt_asym_sess_misc {
372 enum rte_crypto_asym_xform_type xfrm_type;
374 struct rte_crypto_rsa_xform rsa_ctx;
375 struct rte_crypto_modex_xform mod_ctx;
376 struct cpt_asym_ec_ctx ec_ctx;
381 typedef struct buf_ptr {
383 phys_addr_t dma_addr;
394 typedef union opcode_info {
402 typedef struct fc_params {
424 * Parameters for asymmetric operations
426 struct asym_op_params {
427 struct cpt_request_info *req;
428 phys_addr_t meta_buf;
432 * Parameters for digest
434 * Only src_iov, op, ctx_buf, mac_buf, prep_req
435 * meta_buf, auth_data_len are used for digest gen.
437 typedef struct fc_params digest_params_t;
439 /* Cipher Algorithms */
440 typedef mc_cipher_type_t cipher_type_t;
442 /* Auth Algorithms */
443 typedef mc_hash_type_t auth_type_t;
447 #define CPT_P_ENC_CTRL(fctx) fctx->enc.enc_ctrl.e
449 #define SRC_IOV_SIZE \
450 (sizeof(iov_ptr_t) + (sizeof(buf_ptr_t) * CPT_MAX_SG_CNT))
451 #define DST_IOV_SIZE \
452 (sizeof(iov_ptr_t) + (sizeof(buf_ptr_t) * CPT_MAX_SG_CNT))
454 #define SESS_PRIV(__sess) \
455 (void *)((uint8_t *)__sess + sizeof(struct cpt_sess_misc))
458 * Get the session size
463 static __rte_always_inline unsigned int
464 cpt_get_session_size(void)
466 unsigned int ctx_len = sizeof(struct cpt_ctx);
467 return (sizeof(struct cpt_sess_misc) + RTE_ALIGN_CEIL(ctx_len, 8));
469 #endif /* _CPT_MCODE_DEFINES_H_ */