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_memory.h>
12 * This file defines macros and structures according to microcode spec
16 #define CPT_MAJOR_OP_FC 0x33
17 #define CPT_MAJOR_OP_HASH 0x34
18 #define CPT_MAJOR_OP_HMAC 0x35
19 #define CPT_MAJOR_OP_ZUC_SNOW3G 0x37
20 #define CPT_MAJOR_OP_KASUMI 0x38
21 #define CPT_MAJOR_OP_MISC 0x01
23 #define CPT_BYTE_16 16
24 #define CPT_BYTE_24 24
25 #define CPT_BYTE_32 32
26 #define CPT_MAX_SG_IN_OUT_CNT 32
27 #define CPT_MAX_SG_CNT (CPT_MAX_SG_IN_OUT_CNT/2)
29 #define COMPLETION_CODE_SIZE 8
30 #define COMPLETION_CODE_INIT 0
32 #define SG_LIST_HDR_SIZE (8u)
33 #define SG_ENTRY_SIZE sizeof(sg_comp_t)
35 #define CPT_DMA_MODE (1 << 7)
37 #define CPT_FROM_CTX 0
38 #define CPT_FROM_DPTR 1
41 #define ZUC_SNOW3G 0x2
50 #define CPT_OP_CIPHER_ENCRYPT 0x1
51 #define CPT_OP_CIPHER_DECRYPT 0x2
52 #define CPT_OP_CIPHER_MASK 0x3
54 #define CPT_OP_AUTH_VERIFY 0x4
55 #define CPT_OP_AUTH_GENERATE 0x8
56 #define CPT_OP_AUTH_MASK 0xC
58 #define CPT_OP_ENCODE (CPT_OP_CIPHER_ENCRYPT | CPT_OP_AUTH_GENERATE)
59 #define CPT_OP_DECODE (CPT_OP_CIPHER_DECRYPT | CPT_OP_AUTH_VERIFY)
61 /* #define CPT_ALWAYS_USE_SG_MODE */
62 #define CPT_ALWAYS_USE_SEPARATE_BUF
65 * Parameters for Flexi Crypto
68 #define VALID_AAD_BUF 0x01
69 #define VALID_MAC_BUF 0x02
70 #define VALID_IV_BUF 0x04
71 #define SINGLE_BUF_INPLACE 0x08
72 #define SINGLE_BUF_HEADTAILROOM 0x10
74 #define ENCR_IV_OFFSET(__d_offs) ((__d_offs >> 32) & 0xffff)
75 #define ENCR_OFFSET(__d_offs) ((__d_offs >> 16) & 0xffff)
76 #define AUTH_OFFSET(__d_offs) (__d_offs & 0xffff)
77 #define ENCR_DLEN(__d_lens) (__d_lens >> 32)
78 #define AUTH_DLEN(__d_lens) (__d_lens & 0xffffffff)
80 /* FC offset_control at start of DPTR in bytes */
81 #define OFF_CTRL_LEN 8 /**< bytes */
99 /* These are only for software use */
102 KASUMI_F9_CBC = 0x92,
103 KASUMI_F9_ECB = 0x93,
107 /* To support passthrough */
110 * These are defined by MC for Flexi crypto
111 * for field of 4 bits
122 /* These are only for software use */
125 KASUMI_F8_CBC = 0x92,
126 KASUMI_F8_ECB = 0x93,
136 /* Microcode errors */
138 ERR_OPCODE_UNSUPPORTED = 0x01,
141 ERR_SCATTER_GATHER_WRITE_LENGTH = 0x02,
142 ERR_SCATTER_GATHER_LIST = 0x03,
143 ERR_SCATTER_GATHER_NOT_SUPPORTED = 0x04,
146 ERR_GC_LENGTH_INVALID = 0x41,
147 ERR_GC_RANDOM_LEN_INVALID = 0x42,
148 ERR_GC_DATA_LEN_INVALID = 0x43,
149 ERR_GC_DRBG_TYPE_INVALID = 0x44,
150 ERR_GC_CTX_LEN_INVALID = 0x45,
151 ERR_GC_CIPHER_UNSUPPORTED = 0x46,
152 ERR_GC_AUTH_UNSUPPORTED = 0x47,
153 ERR_GC_OFFSET_INVALID = 0x48,
154 ERR_GC_HASH_MODE_UNSUPPORTED = 0x49,
155 ERR_GC_DRBG_ENTROPY_LEN_INVALID = 0x4a,
156 ERR_GC_DRBG_ADDNL_LEN_INVALID = 0x4b,
157 ERR_GC_ICV_MISCOMPARE = 0x4c,
158 ERR_GC_DATA_UNALIGNED = 0x4d,
161 ERR_BAD_ALT_CCODE = 0xfd,
162 ERR_REQ_PENDING = 0xfe,
163 ERR_REQ_TIMEOUT = 0xff,
165 ERR_BAD_INPUT_LENGTH = (0x40000000 | 384), /* 0x40000180 */
168 ERR_BAD_CONTEXT_HANDLE,
169 ERR_BAD_SCALAR_LENGTH,
170 ERR_BAD_DIGEST_LENGTH,
172 ERR_BAD_RECORD_PADDING,
173 ERR_NB_REQUEST_PENDING,
179 * Enumeration cpt_comp_e
181 * CPT Completion Enumeration
182 * Enumerates the values of CPT_RES_S[COMPCODE].
185 CPT_8X_COMP_E_NOTDONE = (0x00),
186 CPT_8X_COMP_E_GOOD = (0x01),
187 CPT_8X_COMP_E_FAULT = (0x02),
188 CPT_8X_COMP_E_SWERR = (0x03),
189 CPT_8X_COMP_E_HWERR = (0x04),
190 CPT_8X_COMP_E_LAST_ENTRY = (0xFF)
193 typedef struct sglist_comp {
203 struct cpt_sess_misc {
206 /** ZUC, SNOW3G & KASUMI flags */
208 /** Flag for AES GCM */
210 /** Flag for AES CTR */
212 /** Flag for NULL cipher/auth */
218 /** MAC len in bytes */
220 /** IV length in bytes */
222 /** Auth IV length in bytes */
223 uint8_t auth_iv_length;
224 /** Reserved field */
226 /** IV offset in bytes */
228 /** Auth IV offset in bytes */
229 uint16_t auth_iv_offset;
232 /** Context DMA address */
233 phys_addr_t ctx_dma_addr;
239 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
240 uint64_t enc_cipher : 4;
241 uint64_t reserved1 : 1;
242 uint64_t aes_key : 2;
243 uint64_t iv_source : 1;
244 uint64_t hash_type : 4;
245 uint64_t reserved2 : 3;
246 uint64_t auth_input_type : 1;
247 uint64_t mac_len : 8;
248 uint64_t reserved3 : 8;
249 uint64_t encr_offset : 16;
250 uint64_t iv_offset : 8;
251 uint64_t auth_offset : 8;
253 uint64_t auth_offset : 8;
254 uint64_t iv_offset : 8;
255 uint64_t encr_offset : 16;
256 uint64_t reserved3 : 8;
257 uint64_t mac_len : 8;
258 uint64_t auth_input_type : 1;
259 uint64_t reserved2 : 3;
260 uint64_t hash_type : 4;
261 uint64_t iv_source : 1;
262 uint64_t aes_key : 2;
263 uint64_t reserved1 : 1;
264 uint64_t enc_cipher : 4;
270 encr_ctrl_t enc_ctrl;
271 uint8_t encr_key[32];
278 } mc_fc_hmac_context_t;
281 mc_enc_context_t enc;
282 mc_fc_hmac_context_t hmac;
286 uint8_t encr_auth_iv[16];
288 uint8_t zuc_const[32];
289 } mc_zuc_snow3g_ctx_t;
297 /* Below fields are accessed by sw */
298 uint64_t enc_cipher :8;
299 uint64_t hash_type :8;
301 uint64_t auth_key_len :8;
304 uint64_t zsk_flags :3;
308 /* Below fields are accessed by hardware */
310 mc_fc_context_t fctx;
311 mc_zuc_snow3g_ctx_t zs_ctx;
312 mc_kasumi_ctx_t k_ctx;
314 uint8_t auth_key[64];
318 typedef struct buf_ptr {
320 phys_addr_t dma_addr;
331 typedef union opcode_info {
339 typedef struct fc_params {
361 * Parameters for digest
363 * Only src_iov, op, ctx_buf, mac_buf, prep_req
364 * meta_buf, auth_data_len are used for digest gen.
366 typedef struct fc_params digest_params_t;
368 /* Cipher Algorithms */
369 typedef mc_cipher_type_t cipher_type_t;
371 /* Auth Algorithms */
372 typedef mc_hash_type_t auth_type_t;
376 #define CPT_P_ENC_CTRL(fctx) fctx->enc.enc_ctrl.e
378 #define SRC_IOV_SIZE \
379 (sizeof(iov_ptr_t) + (sizeof(buf_ptr_t) * CPT_MAX_SG_CNT))
380 #define DST_IOV_SIZE \
381 (sizeof(iov_ptr_t) + (sizeof(buf_ptr_t) * CPT_MAX_SG_CNT))
383 #define SESS_PRIV(__sess) \
384 (void *)((uint8_t *)__sess + sizeof(struct cpt_sess_misc))
387 * Get the session size
392 static __rte_always_inline unsigned int
393 cpt_get_session_size(void)
395 unsigned int ctx_len = sizeof(struct cpt_ctx);
396 return (sizeof(struct cpt_sess_misc) + RTE_ALIGN_CEIL(ctx_len, 8));
398 #endif /* _CPT_MCODE_DEFINES_H_ */