1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2012-2019 ARM Limited (or its affiliates). */
4 #ifndef __CC_HW_QUEUE_DEFS_H__
5 #define __CC_HW_QUEUE_DEFS_H__
7 #include <linux/types.h>
9 #include "cc_kernel_regs.h"
10 #include <linux/bitfield.h>
12 /******************************************************************************
14 ******************************************************************************/
16 #define HW_DESC_SIZE_WORDS 6
17 /* Define max. available slots in HW queue */
18 #define HW_QUEUE_SLOTS_MAX 15
20 #define CC_REG_LOW(name) (name ## _BIT_SHIFT)
21 #define CC_REG_HIGH(name) (CC_REG_LOW(name) + name ## _BIT_SIZE - 1)
22 #define CC_GENMASK(name) GENMASK(CC_REG_HIGH(name), CC_REG_LOW(name))
24 #define CC_HWQ_GENMASK(word, field) \
25 CC_GENMASK(CC_DSCRPTR_QUEUE_WORD ## word ## _ ## field)
27 #define WORD0_VALUE CC_HWQ_GENMASK(0, VALUE)
28 #define WORD0_CPP_CIPHER_MODE CC_HWQ_GENMASK(0, CPP_CIPHER_MODE)
29 #define WORD1_DIN_CONST_VALUE CC_HWQ_GENMASK(1, DIN_CONST_VALUE)
30 #define WORD1_DIN_DMA_MODE CC_HWQ_GENMASK(1, DIN_DMA_MODE)
31 #define WORD1_DIN_SIZE CC_HWQ_GENMASK(1, DIN_SIZE)
32 #define WORD1_NOT_LAST CC_HWQ_GENMASK(1, NOT_LAST)
33 #define WORD1_NS_BIT CC_HWQ_GENMASK(1, NS_BIT)
34 #define WORD1_LOCK_QUEUE CC_HWQ_GENMASK(1, LOCK_QUEUE)
35 #define WORD2_VALUE CC_HWQ_GENMASK(2, VALUE)
36 #define WORD3_DOUT_DMA_MODE CC_HWQ_GENMASK(3, DOUT_DMA_MODE)
37 #define WORD3_DOUT_LAST_IND CC_HWQ_GENMASK(3, DOUT_LAST_IND)
38 #define WORD3_DOUT_SIZE CC_HWQ_GENMASK(3, DOUT_SIZE)
39 #define WORD3_HASH_XOR_BIT CC_HWQ_GENMASK(3, HASH_XOR_BIT)
40 #define WORD3_NS_BIT CC_HWQ_GENMASK(3, NS_BIT)
41 #define WORD3_QUEUE_LAST_IND CC_HWQ_GENMASK(3, QUEUE_LAST_IND)
42 #define WORD4_ACK_NEEDED CC_HWQ_GENMASK(4, ACK_NEEDED)
43 #define WORD4_AES_SEL_N_HASH CC_HWQ_GENMASK(4, AES_SEL_N_HASH)
44 #define WORD4_AES_XOR_CRYPTO_KEY CC_HWQ_GENMASK(4, AES_XOR_CRYPTO_KEY)
45 #define WORD4_BYTES_SWAP CC_HWQ_GENMASK(4, BYTES_SWAP)
46 #define WORD4_CIPHER_CONF0 CC_HWQ_GENMASK(4, CIPHER_CONF0)
47 #define WORD4_CIPHER_CONF1 CC_HWQ_GENMASK(4, CIPHER_CONF1)
48 #define WORD4_CIPHER_CONF2 CC_HWQ_GENMASK(4, CIPHER_CONF2)
49 #define WORD4_CIPHER_DO CC_HWQ_GENMASK(4, CIPHER_DO)
50 #define WORD4_CIPHER_MODE CC_HWQ_GENMASK(4, CIPHER_MODE)
51 #define WORD4_CMAC_SIZE0 CC_HWQ_GENMASK(4, CMAC_SIZE0)
52 #define WORD4_DATA_FLOW_MODE CC_HWQ_GENMASK(4, DATA_FLOW_MODE)
53 #define WORD4_KEY_SIZE CC_HWQ_GENMASK(4, KEY_SIZE)
54 #define WORD4_SETUP_OPERATION CC_HWQ_GENMASK(4, SETUP_OPERATION)
55 #define WORD5_DIN_ADDR_HIGH CC_HWQ_GENMASK(5, DIN_ADDR_HIGH)
56 #define WORD5_DOUT_ADDR_HIGH CC_HWQ_GENMASK(5, DOUT_ADDR_HIGH)
58 /******************************************************************************
60 ******************************************************************************/
64 u32 word
[HW_DESC_SIZE_WORDS
];
65 u16 hword
[HW_DESC_SIZE_WORDS
* 2];
74 enum cc_desc_direction
{
75 DESC_DIRECTION_ILLEGAL
= -1,
76 DESC_DIRECTION_ENCRYPT_ENCRYPT
= 0,
77 DESC_DIRECTION_DECRYPT_DECRYPT
= 1,
78 DESC_DIRECTION_DECRYPT_ENCRYPT
= 3,
79 DESC_DIRECTION_END
= S32_MAX
,
88 DMA_MODE_END
= S32_MAX
,
102 DIN_HASH_and_BYPASS
= 8,
103 AESMAC_and_BYPASS
= 9,
104 AES_to_HASH_and_DOUT
= 10,
106 DES_to_HASH_and_DOUT
= 12,
107 AES_to_AES_to_HASH_and_DOUT
= 13,
108 AES_to_AES_to_HASH
= 14,
109 AES_to_HASH_and_AES
= 15,
127 FLOW_MODE_END
= S32_MAX
,
132 SETUP_LOAD_STATE0
= 1,
133 SETUP_LOAD_STATE1
= 2,
134 SETUP_LOAD_STATE2
= 3,
136 SETUP_LOAD_XEX_KEY
= 5,
137 SETUP_WRITE_STATE0
= 8,
138 SETUP_WRITE_STATE1
= 9,
139 SETUP_WRITE_STATE2
= 10,
140 SETUP_WRITE_STATE3
= 11,
141 SETUP_OP_END
= S32_MAX
,
144 enum cc_hash_conf_pad
{
145 HASH_PADDING_DISABLED
= 0,
146 HASH_PADDING_ENABLED
= 1,
147 HASH_DIGEST_RESULT_LITTLE_ENDIAN
= 2,
148 HASH_CONFIG1_PADDING_RESERVE32
= S32_MAX
,
151 enum cc_aes_mac_selector
{
155 AES_MAC_END
= S32_MAX
,
158 #define HW_KEY_MASK_CIPHER_DO 0x3
159 #define HW_KEY_SHIFT_CIPHER_CFG2 2
161 /* HwCryptoKey[1:0] is mapped to cipher_do[1:0] */
162 /* HwCryptoKey[2:3] is mapped to cipher_config2[1:0] */
163 enum cc_hw_crypto_key
{
164 USER_KEY
= 0, /* 0x0000 */
165 ROOT_KEY
= 1, /* 0x0001 */
166 PROVISIONING_KEY
= 2, /* 0x0010 */ /* ==KCP */
167 SESSION_KEY
= 3, /* 0x0011 */
168 RESERVED_KEY
= 4, /* NA */
169 PLATFORM_KEY
= 5, /* 0x0101 */
170 CUSTOMER_KEY
= 6, /* 0x0110 */
171 KFDE0_KEY
= 7, /* 0x0111 */
172 KFDE1_KEY
= 9, /* 0x1001 */
173 KFDE2_KEY
= 10, /* 0x1010 */
174 KFDE3_KEY
= 11, /* 0x1011 */
175 END_OF_KEYS
= S32_MAX
,
178 #define CC_NUM_HW_KEY_SLOTS 4
179 #define CC_FIRST_HW_KEY_SLOT 0
180 #define CC_LAST_HW_KEY_SLOT (CC_FIRST_HW_KEY_SLOT + CC_NUM_HW_KEY_SLOTS - 1)
182 #define CC_NUM_CPP_KEY_SLOTS 8
183 #define CC_FIRST_CPP_KEY_SLOT 16
184 #define CC_LAST_CPP_KEY_SLOT (CC_FIRST_CPP_KEY_SLOT + \
185 CC_NUM_CPP_KEY_SLOTS - 1)
187 enum cc_hw_aes_key_size
{
191 END_OF_AES_KEYS
= S32_MAX
,
194 enum cc_hash_cipher_pad
{
197 HASH_CIPHER_DO_PADDING_RESERVE32
= S32_MAX
,
200 #define CC_CPP_DIN_ADDR 0xFF00FF00UL
201 #define CC_CPP_DIN_SIZE 0xFF00FFUL
203 /*****************************/
204 /* Descriptor packing macros */
205 /*****************************/
208 * hw_desc_init() - Init a HW descriptor struct
209 * @pdesc: pointer to HW descriptor struct
211 static inline void hw_desc_init(struct cc_hw_desc
*pdesc
)
213 memset(pdesc
, 0, sizeof(struct cc_hw_desc
));
217 * set_queue_last_ind_bit() - Indicate the end of current HW descriptors flow
218 * and release the HW engines.
220 * @pdesc: Pointer to HW descriptor struct
222 static inline void set_queue_last_ind_bit(struct cc_hw_desc
*pdesc
)
224 pdesc
->word
[3] |= FIELD_PREP(WORD3_QUEUE_LAST_IND
, 1);
228 * set_din_type() - Set the DIN field of a HW descriptor
230 * @pdesc: Pointer to HW descriptor struct
231 * @dma_mode: The DMA mode: NO_DMA, SRAM, DLLI, MLLI, CONSTANT
233 * @size: Data size in bytes
234 * @axi_sec: AXI secure bit
236 static inline void set_din_type(struct cc_hw_desc
*pdesc
,
237 enum cc_dma_mode dma_mode
, dma_addr_t addr
,
238 u32 size
, enum cc_axi_sec axi_sec
)
240 pdesc
->word
[0] = lower_32_bits(addr
);
241 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
242 pdesc
->word
[5] |= FIELD_PREP(WORD5_DIN_ADDR_HIGH
, upper_32_bits(addr
));
244 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_DMA_MODE
, dma_mode
) |
245 FIELD_PREP(WORD1_DIN_SIZE
, size
) |
246 FIELD_PREP(WORD1_NS_BIT
, axi_sec
);
250 * set_din_no_dma() - Set the DIN field of a HW descriptor to NO DMA mode.
251 * Used for NOP descriptor, register patches and other special modes.
253 * @pdesc: Pointer to HW descriptor struct
255 * @size: Data size in bytes
257 static inline void set_din_no_dma(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
)
259 pdesc
->word
[0] = addr
;
260 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_SIZE
, size
);
264 * set_cpp_crypto_key() - Setup the special CPP descriptor
266 * @pdesc: Pointer to HW descriptor struct
269 static inline void set_cpp_crypto_key(struct cc_hw_desc
*pdesc
, u8 slot
)
271 pdesc
->word
[0] |= CC_CPP_DIN_ADDR
;
273 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_SIZE
, CC_CPP_DIN_SIZE
);
274 pdesc
->word
[1] |= FIELD_PREP(WORD1_LOCK_QUEUE
, 1);
276 pdesc
->word
[4] |= FIELD_PREP(WORD4_SETUP_OPERATION
, slot
);
280 * set_din_sram() - Set the DIN field of a HW descriptor to SRAM mode.
281 * Note: No need to check SRAM alignment since host requests do not use SRAM and
282 * the adaptor will enforce alignment checks.
284 * @pdesc: Pointer to HW descriptor struct
286 * @size: Data size in bytes
288 static inline void set_din_sram(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
)
290 pdesc
->word
[0] = addr
;
291 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_SIZE
, size
) |
292 FIELD_PREP(WORD1_DIN_DMA_MODE
, DMA_SRAM
);
296 * set_din_const() - Set the DIN field of a HW descriptor to CONST mode
298 * @pdesc: Pointer to HW descriptor struct
299 * @val: DIN const value
300 * @size: Data size in bytes
302 static inline void set_din_const(struct cc_hw_desc
*pdesc
, u32 val
, u32 size
)
304 pdesc
->word
[0] = val
;
305 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_CONST_VALUE
, 1) |
306 FIELD_PREP(WORD1_DIN_DMA_MODE
, DMA_SRAM
) |
307 FIELD_PREP(WORD1_DIN_SIZE
, size
);
311 * set_din_not_last_indication() - Set the DIN not last input data indicator
313 * @pdesc: Pointer to HW descriptor struct
315 static inline void set_din_not_last_indication(struct cc_hw_desc
*pdesc
)
317 pdesc
->word
[1] |= FIELD_PREP(WORD1_NOT_LAST
, 1);
321 * set_dout_type() - Set the DOUT field of a HW descriptor
323 * @pdesc: Pointer to HW descriptor struct
324 * @dma_mode: The DMA mode: NO_DMA, SRAM, DLLI, MLLI, CONSTANT
325 * @addr: DOUT address
326 * @size: Data size in bytes
327 * @axi_sec: AXI secure bit
329 static inline void set_dout_type(struct cc_hw_desc
*pdesc
,
330 enum cc_dma_mode dma_mode
, dma_addr_t addr
,
331 u32 size
, enum cc_axi_sec axi_sec
)
333 pdesc
->word
[2] = lower_32_bits(addr
);
334 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
335 pdesc
->word
[5] |= FIELD_PREP(WORD5_DOUT_ADDR_HIGH
, upper_32_bits(addr
));
337 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_DMA_MODE
, dma_mode
) |
338 FIELD_PREP(WORD3_DOUT_SIZE
, size
) |
339 FIELD_PREP(WORD3_NS_BIT
, axi_sec
);
343 * set_dout_dlli() - Set the DOUT field of a HW descriptor to DLLI type
344 * The LAST INDICATION is provided by the user
346 * @pdesc: Pointer to HW descriptor struct
347 * @addr: DOUT address
348 * @size: Data size in bytes
349 * @axi_sec: AXI secure bit
350 * @last_ind: The last indication bit
352 static inline void set_dout_dlli(struct cc_hw_desc
*pdesc
, dma_addr_t addr
,
353 u32 size
, enum cc_axi_sec axi_sec
,
356 set_dout_type(pdesc
, DMA_DLLI
, addr
, size
, axi_sec
);
357 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_LAST_IND
, last_ind
);
361 * set_dout_mlli() - Set the DOUT field of a HW descriptor to MLLI type
362 * The LAST INDICATION is provided by the user
364 * @pdesc: Pointer to HW descriptor struct
365 * @addr: DOUT address
366 * @size: Data size in bytes
367 * @axi_sec: AXI secure bit
368 * @last_ind: The last indication bit
370 static inline void set_dout_mlli(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
,
371 enum cc_axi_sec axi_sec
, bool last_ind
)
373 set_dout_type(pdesc
, DMA_MLLI
, addr
, size
, axi_sec
);
374 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_LAST_IND
, last_ind
);
378 * set_dout_no_dma() - Set the DOUT field of a HW descriptor to NO DMA mode.
379 * Used for NOP descriptor, register patches and other special modes.
381 * @pdesc: pointer to HW descriptor struct
382 * @addr: DOUT address
383 * @size: Data size in bytes
384 * @write_enable: Enables a write operation to a register
386 static inline void set_dout_no_dma(struct cc_hw_desc
*pdesc
, u32 addr
,
387 u32 size
, bool write_enable
)
389 pdesc
->word
[2] = addr
;
390 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_SIZE
, size
) |
391 FIELD_PREP(WORD3_DOUT_LAST_IND
, write_enable
);
395 * set_xor_val() - Set the word for the XOR operation.
397 * @pdesc: Pointer to HW descriptor struct
398 * @val: XOR data value
400 static inline void set_xor_val(struct cc_hw_desc
*pdesc
, u32 val
)
402 pdesc
->word
[2] = val
;
406 * set_xor_active() - Set the XOR indicator bit in the descriptor
408 * @pdesc: Pointer to HW descriptor struct
410 static inline void set_xor_active(struct cc_hw_desc
*pdesc
)
412 pdesc
->word
[3] |= FIELD_PREP(WORD3_HASH_XOR_BIT
, 1);
416 * set_aes_not_hash_mode() - Select the AES engine instead of HASH engine when
417 * setting up combined mode with AES XCBC MAC
419 * @pdesc: Pointer to HW descriptor struct
421 static inline void set_aes_not_hash_mode(struct cc_hw_desc
*pdesc
)
423 pdesc
->word
[4] |= FIELD_PREP(WORD4_AES_SEL_N_HASH
, 1);
427 * set_aes_xor_crypto_key() - Set aes xor crypto key, which in some scenarios
428 * selects the SM3 engine
430 * @pdesc: Pointer to HW descriptor struct
432 static inline void set_aes_xor_crypto_key(struct cc_hw_desc
*pdesc
)
434 pdesc
->word
[4] |= FIELD_PREP(WORD4_AES_XOR_CRYPTO_KEY
, 1);
438 * set_dout_sram() - Set the DOUT field of a HW descriptor to SRAM mode
439 * Note: No need to check SRAM alignment since host requests do not use SRAM and
440 * the adaptor will enforce alignment checks.
442 * @pdesc: Pointer to HW descriptor struct
443 * @addr: DOUT address
444 * @size: Data size in bytes
446 static inline void set_dout_sram(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
)
448 pdesc
->word
[2] = addr
;
449 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_DMA_MODE
, DMA_SRAM
) |
450 FIELD_PREP(WORD3_DOUT_SIZE
, size
);
454 * set_xex_data_unit_size() - Set the data unit size for XEX mode in
455 * data_out_addr[15:0]
457 * @pdesc: Pointer to HW descriptor struct
458 * @size: Data unit size for XEX mode
460 static inline void set_xex_data_unit_size(struct cc_hw_desc
*pdesc
, u32 size
)
462 pdesc
->word
[2] = size
;
466 * set_multi2_num_rounds() - Set the number of rounds for Multi2 in
467 * data_out_addr[15:0]
469 * @pdesc: Pointer to HW descriptor struct
470 * @num: Number of rounds for Multi2
472 static inline void set_multi2_num_rounds(struct cc_hw_desc
*pdesc
, u32 num
)
474 pdesc
->word
[2] = num
;
478 * set_flow_mode() - Set the flow mode.
480 * @pdesc: Pointer to HW descriptor struct
481 * @mode: Any one of the modes defined in [CC7x-DESC]
483 static inline void set_flow_mode(struct cc_hw_desc
*pdesc
,
484 enum cc_flow_mode mode
)
486 pdesc
->word
[4] |= FIELD_PREP(WORD4_DATA_FLOW_MODE
, mode
);
490 * set_cipher_mode() - Set the cipher mode.
492 * @pdesc: Pointer to HW descriptor struct
493 * @mode: Any one of the modes defined in [CC7x-DESC]
495 static inline void set_cipher_mode(struct cc_hw_desc
*pdesc
, int mode
)
497 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_MODE
, mode
);
501 * set_hash_cipher_mode() - Set the cipher mode for hash algorithms.
503 * @pdesc: Pointer to HW descriptor struct
504 * @cipher_mode: Any one of the modes defined in [CC7x-DESC]
505 * @hash_mode: specifies which hash is being handled
507 static inline void set_hash_cipher_mode(struct cc_hw_desc
*pdesc
,
508 enum drv_cipher_mode cipher_mode
,
509 enum drv_hash_mode hash_mode
)
511 set_cipher_mode(pdesc
, cipher_mode
);
512 if (hash_mode
== DRV_HASH_SM3
)
513 set_aes_xor_crypto_key(pdesc
);
517 * set_cipher_config0() - Set the cipher configuration fields.
519 * @pdesc: Pointer to HW descriptor struct
520 * @mode: Any one of the modes defined in [CC7x-DESC]
522 static inline void set_cipher_config0(struct cc_hw_desc
*pdesc
, int mode
)
524 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_CONF0
, mode
);
528 * set_cipher_config1() - Set the cipher configuration fields.
530 * @pdesc: Pointer to HW descriptor struct
531 * @config: Padding mode
533 static inline void set_cipher_config1(struct cc_hw_desc
*pdesc
,
534 enum cc_hash_conf_pad config
)
536 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_CONF1
, config
);
540 * set_hw_crypto_key() - Set HW key configuration fields.
542 * @pdesc: Pointer to HW descriptor struct
543 * @hw_key: The HW key slot asdefined in enum cc_hw_crypto_key
545 static inline void set_hw_crypto_key(struct cc_hw_desc
*pdesc
,
546 enum cc_hw_crypto_key hw_key
)
548 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_DO
,
549 (hw_key
& HW_KEY_MASK_CIPHER_DO
)) |
550 FIELD_PREP(WORD4_CIPHER_CONF2
,
551 (hw_key
>> HW_KEY_SHIFT_CIPHER_CFG2
));
555 * set_bytes_swap() - Set byte order of all setup-finalize descriptors.
557 * @pdesc: Pointer to HW descriptor struct
558 * @config: True to enable byte swapping
560 static inline void set_bytes_swap(struct cc_hw_desc
*pdesc
, bool config
)
562 pdesc
->word
[4] |= FIELD_PREP(WORD4_BYTES_SWAP
, config
);
566 * set_cmac_size0_mode() - Set CMAC_SIZE0 mode.
568 * @pdesc: Pointer to HW descriptor struct
570 static inline void set_cmac_size0_mode(struct cc_hw_desc
*pdesc
)
572 pdesc
->word
[4] |= FIELD_PREP(WORD4_CMAC_SIZE0
, 1);
576 * set_key_size() - Set key size descriptor field.
578 * @pdesc: Pointer to HW descriptor struct
579 * @size: Key size in bytes (NOT size code)
581 static inline void set_key_size(struct cc_hw_desc
*pdesc
, u32 size
)
583 pdesc
->word
[4] |= FIELD_PREP(WORD4_KEY_SIZE
, size
);
587 * set_key_size_aes() - Set AES key size.
589 * @pdesc: Pointer to HW descriptor struct
590 * @size: Key size in bytes (NOT size code)
592 static inline void set_key_size_aes(struct cc_hw_desc
*pdesc
, u32 size
)
594 set_key_size(pdesc
, ((size
>> 3) - 2));
598 * set_key_size_des() - Set DES key size.
600 * @pdesc: Pointer to HW descriptor struct
601 * @size: Key size in bytes (NOT size code)
603 static inline void set_key_size_des(struct cc_hw_desc
*pdesc
, u32 size
)
605 set_key_size(pdesc
, ((size
>> 3) - 1));
609 * set_setup_mode() - Set the descriptor setup mode
611 * @pdesc: Pointer to HW descriptor struct
612 * @mode: Any one of the setup modes defined in [CC7x-DESC]
614 static inline void set_setup_mode(struct cc_hw_desc
*pdesc
,
615 enum cc_setup_op mode
)
617 pdesc
->word
[4] |= FIELD_PREP(WORD4_SETUP_OPERATION
, mode
);
621 * set_cipher_do() - Set the descriptor cipher DO
623 * @pdesc: Pointer to HW descriptor struct
624 * @config: Any one of the cipher do defined in [CC7x-DESC]
626 static inline void set_cipher_do(struct cc_hw_desc
*pdesc
,
627 enum cc_hash_cipher_pad config
)
629 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_DO
,
630 (config
& HW_KEY_MASK_CIPHER_DO
));
633 #endif /*__CC_HW_QUEUE_DEFS_H__*/