1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2012-2018 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(word, name) \
21 (CC_DSCRPTR_QUEUE_WORD ## word ## _ ## name ## _BIT_SHIFT)
23 #define CC_REG_HIGH(word, name) \
24 (CC_REG_LOW(word, name) + \
25 CC_DSCRPTR_QUEUE_WORD ## word ## _ ## name ## _BIT_SIZE - 1)
27 #define CC_GENMASK(word, name) \
28 GENMASK(CC_REG_HIGH(word, name), CC_REG_LOW(word, name))
30 #define WORD0_VALUE CC_GENMASK(0, VALUE)
31 #define WORD1_DIN_CONST_VALUE CC_GENMASK(1, DIN_CONST_VALUE)
32 #define WORD1_DIN_DMA_MODE CC_GENMASK(1, DIN_DMA_MODE)
33 #define WORD1_DIN_SIZE CC_GENMASK(1, DIN_SIZE)
34 #define WORD1_NOT_LAST CC_GENMASK(1, NOT_LAST)
35 #define WORD1_NS_BIT CC_GENMASK(1, NS_BIT)
36 #define WORD2_VALUE CC_GENMASK(2, VALUE)
37 #define WORD3_DOUT_DMA_MODE CC_GENMASK(3, DOUT_DMA_MODE)
38 #define WORD3_DOUT_LAST_IND CC_GENMASK(3, DOUT_LAST_IND)
39 #define WORD3_DOUT_SIZE CC_GENMASK(3, DOUT_SIZE)
40 #define WORD3_HASH_XOR_BIT CC_GENMASK(3, HASH_XOR_BIT)
41 #define WORD3_NS_BIT CC_GENMASK(3, NS_BIT)
42 #define WORD3_QUEUE_LAST_IND CC_GENMASK(3, QUEUE_LAST_IND)
43 #define WORD4_ACK_NEEDED CC_GENMASK(4, ACK_NEEDED)
44 #define WORD4_AES_SEL_N_HASH CC_GENMASK(4, AES_SEL_N_HASH)
45 #define WORD4_BYTES_SWAP CC_GENMASK(4, BYTES_SWAP)
46 #define WORD4_CIPHER_CONF0 CC_GENMASK(4, CIPHER_CONF0)
47 #define WORD4_CIPHER_CONF1 CC_GENMASK(4, CIPHER_CONF1)
48 #define WORD4_CIPHER_CONF2 CC_GENMASK(4, CIPHER_CONF2)
49 #define WORD4_CIPHER_DO CC_GENMASK(4, CIPHER_DO)
50 #define WORD4_CIPHER_MODE CC_GENMASK(4, CIPHER_MODE)
51 #define WORD4_CMAC_SIZE0 CC_GENMASK(4, CMAC_SIZE0)
52 #define WORD4_DATA_FLOW_MODE CC_GENMASK(4, DATA_FLOW_MODE)
53 #define WORD4_KEY_SIZE CC_GENMASK(4, KEY_SIZE)
54 #define WORD4_SETUP_OPERATION CC_GENMASK(4, SETUP_OPERATION)
55 #define WORD5_DIN_ADDR_HIGH CC_GENMASK(5, DIN_ADDR_HIGH)
56 #define WORD5_DOUT_ADDR_HIGH CC_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,
124 FLOW_MODE_END
= S32_MAX
,
129 SETUP_LOAD_STATE0
= 1,
130 SETUP_LOAD_STATE1
= 2,
131 SETUP_LOAD_STATE2
= 3,
133 SETUP_LOAD_XEX_KEY
= 5,
134 SETUP_WRITE_STATE0
= 8,
135 SETUP_WRITE_STATE1
= 9,
136 SETUP_WRITE_STATE2
= 10,
137 SETUP_WRITE_STATE3
= 11,
138 SETUP_OP_END
= S32_MAX
,
141 enum cc_hash_conf_pad
{
142 HASH_PADDING_DISABLED
= 0,
143 HASH_PADDING_ENABLED
= 1,
144 HASH_DIGEST_RESULT_LITTLE_ENDIAN
= 2,
145 HASH_CONFIG1_PADDING_RESERVE32
= S32_MAX
,
148 enum cc_aes_mac_selector
{
152 AES_MAC_END
= S32_MAX
,
155 #define HW_KEY_MASK_CIPHER_DO 0x3
156 #define HW_KEY_SHIFT_CIPHER_CFG2 2
158 /* HwCryptoKey[1:0] is mapped to cipher_do[1:0] */
159 /* HwCryptoKey[2:3] is mapped to cipher_config2[1:0] */
160 enum cc_hw_crypto_key
{
161 USER_KEY
= 0, /* 0x0000 */
162 ROOT_KEY
= 1, /* 0x0001 */
163 PROVISIONING_KEY
= 2, /* 0x0010 */ /* ==KCP */
164 SESSION_KEY
= 3, /* 0x0011 */
165 RESERVED_KEY
= 4, /* NA */
166 PLATFORM_KEY
= 5, /* 0x0101 */
167 CUSTOMER_KEY
= 6, /* 0x0110 */
168 KFDE0_KEY
= 7, /* 0x0111 */
169 KFDE1_KEY
= 9, /* 0x1001 */
170 KFDE2_KEY
= 10, /* 0x1010 */
171 KFDE3_KEY
= 11, /* 0x1011 */
172 END_OF_KEYS
= S32_MAX
,
175 enum cc_hw_aes_key_size
{
179 END_OF_AES_KEYS
= S32_MAX
,
182 enum cc_hash_cipher_pad
{
185 HASH_CIPHER_DO_PADDING_RESERVE32
= S32_MAX
,
188 /*****************************/
189 /* Descriptor packing macros */
190 /*****************************/
193 * Init a HW descriptor struct
194 * @pdesc: pointer HW descriptor struct
196 static inline void hw_desc_init(struct cc_hw_desc
*pdesc
)
198 memset(pdesc
, 0, sizeof(struct cc_hw_desc
));
202 * Indicates the end of current HW descriptors flow and release the HW engines.
204 * @pdesc: pointer HW descriptor struct
206 static inline void set_queue_last_ind_bit(struct cc_hw_desc
*pdesc
)
208 pdesc
->word
[3] |= FIELD_PREP(WORD3_QUEUE_LAST_IND
, 1);
212 * Set the DIN field of a HW descriptors
214 * @pdesc: pointer HW descriptor struct
215 * @dma_mode: dmaMode The DMA mode: NO_DMA, SRAM, DLLI, MLLI, CONSTANT
216 * @addr: dinAdr DIN address
217 * @size: Data size in bytes
218 * @axi_sec: AXI secure bit
220 static inline void set_din_type(struct cc_hw_desc
*pdesc
,
221 enum cc_dma_mode dma_mode
, dma_addr_t addr
,
222 u32 size
, enum cc_axi_sec axi_sec
)
224 pdesc
->word
[0] = (u32
)addr
;
225 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
226 pdesc
->word
[5] |= FIELD_PREP(WORD5_DIN_ADDR_HIGH
, ((u16
)(addr
>> 32)));
228 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_DMA_MODE
, dma_mode
) |
229 FIELD_PREP(WORD1_DIN_SIZE
, size
) |
230 FIELD_PREP(WORD1_NS_BIT
, axi_sec
);
234 * Set the DIN field of a HW descriptors to NO DMA mode.
235 * Used for NOP descriptor, register patches and other special modes.
237 * @pdesc: pointer HW descriptor struct
239 * @size: Data size in bytes
241 static inline void set_din_no_dma(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
)
243 pdesc
->word
[0] = addr
;
244 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_SIZE
, size
);
248 * Set the DIN field of a HW descriptors to SRAM mode.
249 * Note: No need to check SRAM alignment since host requests do not use SRAM and
250 * adaptor will enforce alignment check.
252 * @pdesc: pointer HW descriptor struct
254 * @size Data size in bytes
256 static inline void set_din_sram(struct cc_hw_desc
*pdesc
, dma_addr_t addr
,
259 pdesc
->word
[0] = (u32
)addr
;
260 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_SIZE
, size
) |
261 FIELD_PREP(WORD1_DIN_DMA_MODE
, DMA_SRAM
);
265 * Set the DIN field of a HW descriptors to CONST mode
267 * @pdesc: pointer HW descriptor struct
268 * @val: DIN const value
269 * @size: Data size in bytes
271 static inline void set_din_const(struct cc_hw_desc
*pdesc
, u32 val
, u32 size
)
273 pdesc
->word
[0] = val
;
274 pdesc
->word
[1] |= FIELD_PREP(WORD1_DIN_CONST_VALUE
, 1) |
275 FIELD_PREP(WORD1_DIN_DMA_MODE
, DMA_SRAM
) |
276 FIELD_PREP(WORD1_DIN_SIZE
, size
);
280 * Set the DIN not last input data indicator
282 * @pdesc: pointer HW descriptor struct
284 static inline void set_din_not_last_indication(struct cc_hw_desc
*pdesc
)
286 pdesc
->word
[1] |= FIELD_PREP(WORD1_NOT_LAST
, 1);
290 * Set the DOUT field of a HW descriptors
292 * @pdesc: pointer HW descriptor struct
293 * @dma_mode: The DMA mode: NO_DMA, SRAM, DLLI, MLLI, CONSTANT
294 * @addr: DOUT address
295 * @size: Data size in bytes
296 * @axi_sec: AXI secure bit
298 static inline void set_dout_type(struct cc_hw_desc
*pdesc
,
299 enum cc_dma_mode dma_mode
, dma_addr_t addr
,
300 u32 size
, enum cc_axi_sec axi_sec
)
302 pdesc
->word
[2] = (u32
)addr
;
303 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
304 pdesc
->word
[5] |= FIELD_PREP(WORD5_DOUT_ADDR_HIGH
, ((u16
)(addr
>> 32)));
306 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_DMA_MODE
, dma_mode
) |
307 FIELD_PREP(WORD3_DOUT_SIZE
, size
) |
308 FIELD_PREP(WORD3_NS_BIT
, axi_sec
);
312 * Set the DOUT field of a HW descriptors to DLLI type
313 * The LAST INDICATION is provided by the user
315 * @pdesc pointer HW descriptor struct
316 * @addr: DOUT address
317 * @size: Data size in bytes
318 * @last_ind: The last indication bit
319 * @axi_sec: AXI secure bit
321 static inline void set_dout_dlli(struct cc_hw_desc
*pdesc
, dma_addr_t addr
,
322 u32 size
, enum cc_axi_sec axi_sec
,
325 set_dout_type(pdesc
, DMA_DLLI
, addr
, size
, axi_sec
);
326 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_LAST_IND
, last_ind
);
330 * Set the DOUT field of a HW descriptors to DLLI type
331 * The LAST INDICATION is provided by the user
333 * @pdesc: pointer HW descriptor struct
334 * @addr: DOUT address
335 * @size: Data size in bytes
336 * @last_ind: The last indication bit
337 * @axi_sec: AXI secure bit
339 static inline void set_dout_mlli(struct cc_hw_desc
*pdesc
, dma_addr_t addr
,
340 u32 size
, enum cc_axi_sec axi_sec
,
343 set_dout_type(pdesc
, DMA_MLLI
, addr
, size
, axi_sec
);
344 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_LAST_IND
, last_ind
);
348 * Set the DOUT field of a HW descriptors to NO DMA mode.
349 * Used for NOP descriptor, register patches and other special modes.
351 * @pdesc: pointer HW descriptor struct
352 * @addr: DOUT address
353 * @size: Data size in bytes
354 * @write_enable: Enables a write operation to a register
356 static inline void set_dout_no_dma(struct cc_hw_desc
*pdesc
, u32 addr
,
357 u32 size
, bool write_enable
)
359 pdesc
->word
[2] = addr
;
360 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_SIZE
, size
) |
361 FIELD_PREP(WORD3_DOUT_LAST_IND
, write_enable
);
365 * Set the word for the XOR operation.
367 * @pdesc: pointer HW descriptor struct
368 * @val: xor data value
370 static inline void set_xor_val(struct cc_hw_desc
*pdesc
, u32 val
)
372 pdesc
->word
[2] = val
;
376 * Sets the XOR indicator bit in the descriptor
378 * @pdesc: pointer HW descriptor struct
380 static inline void set_xor_active(struct cc_hw_desc
*pdesc
)
382 pdesc
->word
[3] |= FIELD_PREP(WORD3_HASH_XOR_BIT
, 1);
386 * Select the AES engine instead of HASH engine when setting up combined mode
389 * @pdesc: pointer HW descriptor struct
391 static inline void set_aes_not_hash_mode(struct cc_hw_desc
*pdesc
)
393 pdesc
->word
[4] |= FIELD_PREP(WORD4_AES_SEL_N_HASH
, 1);
397 * Set the DOUT field of a HW descriptors to SRAM mode
398 * Note: No need to check SRAM alignment since host requests do not use SRAM and
399 * adaptor will enforce alignment check.
401 * @pdesc: pointer HW descriptor struct
402 * @addr: DOUT address
403 * @size: Data size in bytes
405 static inline void set_dout_sram(struct cc_hw_desc
*pdesc
, u32 addr
, u32 size
)
407 pdesc
->word
[2] = addr
;
408 pdesc
->word
[3] |= FIELD_PREP(WORD3_DOUT_DMA_MODE
, DMA_SRAM
) |
409 FIELD_PREP(WORD3_DOUT_SIZE
, size
);
413 * Sets the data unit size for XEX mode in data_out_addr[15:0]
415 * @pdesc: pDesc pointer HW descriptor struct
416 * @size: data unit size for XEX mode
418 static inline void set_xex_data_unit_size(struct cc_hw_desc
*pdesc
, u32 size
)
420 pdesc
->word
[2] = size
;
424 * Set the number of rounds for Multi2 in data_out_addr[15:0]
426 * @pdesc: pointer HW descriptor struct
427 * @num: number of rounds for Multi2
429 static inline void set_multi2_num_rounds(struct cc_hw_desc
*pdesc
, u32 num
)
431 pdesc
->word
[2] = num
;
437 * @pdesc: pointer HW descriptor struct
438 * @mode: Any one of the modes defined in [CC7x-DESC]
440 static inline void set_flow_mode(struct cc_hw_desc
*pdesc
,
441 enum cc_flow_mode mode
)
443 pdesc
->word
[4] |= FIELD_PREP(WORD4_DATA_FLOW_MODE
, mode
);
447 * Set the cipher mode.
449 * @pdesc: pointer HW descriptor struct
450 * @mode: Any one of the modes defined in [CC7x-DESC]
452 static inline void set_cipher_mode(struct cc_hw_desc
*pdesc
, int mode
)
454 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_MODE
, mode
);
458 * Set the cipher configuration fields.
460 * @pdesc: pointer HW descriptor struct
461 * @mode: Any one of the modes defined in [CC7x-DESC]
463 static inline void set_cipher_config0(struct cc_hw_desc
*pdesc
, int mode
)
465 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_CONF0
, mode
);
469 * Set the cipher configuration fields.
471 * @pdesc: pointer HW descriptor struct
472 * @config: Any one of the modes defined in [CC7x-DESC]
474 static inline void set_cipher_config1(struct cc_hw_desc
*pdesc
,
475 enum cc_hash_conf_pad config
)
477 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_CONF1
, config
);
481 * Set HW key configuration fields.
483 * @pdesc: pointer HW descriptor struct
484 * @hw_key: The HW key slot asdefined in enum cc_hw_crypto_key
486 static inline void set_hw_crypto_key(struct cc_hw_desc
*pdesc
,
487 enum cc_hw_crypto_key hw_key
)
489 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_DO
,
490 (hw_key
& HW_KEY_MASK_CIPHER_DO
)) |
491 FIELD_PREP(WORD4_CIPHER_CONF2
,
492 (hw_key
>> HW_KEY_SHIFT_CIPHER_CFG2
));
496 * Set byte order of all setup-finalize descriptors.
498 * @pdesc: pointer HW descriptor struct
499 * @config: Any one of the modes defined in [CC7x-DESC]
501 static inline void set_bytes_swap(struct cc_hw_desc
*pdesc
, bool config
)
503 pdesc
->word
[4] |= FIELD_PREP(WORD4_BYTES_SWAP
, config
);
507 * Set CMAC_SIZE0 mode.
509 * @pdesc: pointer HW descriptor struct
511 static inline void set_cmac_size0_mode(struct cc_hw_desc
*pdesc
)
513 pdesc
->word
[4] |= FIELD_PREP(WORD4_CMAC_SIZE0
, 1);
517 * Set key size descriptor field.
519 * @pdesc: pointer HW descriptor struct
520 * @size: key size in bytes (NOT size code)
522 static inline void set_key_size(struct cc_hw_desc
*pdesc
, u32 size
)
524 pdesc
->word
[4] |= FIELD_PREP(WORD4_KEY_SIZE
, size
);
530 * @pdesc: pointer HW descriptor struct
531 * @size: key size in bytes (NOT size code)
533 static inline void set_key_size_aes(struct cc_hw_desc
*pdesc
, u32 size
)
535 set_key_size(pdesc
, ((size
>> 3) - 2));
541 * @pdesc: pointer HW descriptor struct
542 * @size: key size in bytes (NOT size code)
544 static inline void set_key_size_des(struct cc_hw_desc
*pdesc
, u32 size
)
546 set_key_size(pdesc
, ((size
>> 3) - 1));
550 * Set the descriptor setup mode
552 * @pdesc: pointer HW descriptor struct
553 * @mode: Any one of the setup modes defined in [CC7x-DESC]
555 static inline void set_setup_mode(struct cc_hw_desc
*pdesc
,
556 enum cc_setup_op mode
)
558 pdesc
->word
[4] |= FIELD_PREP(WORD4_SETUP_OPERATION
, mode
);
562 * Set the descriptor cipher DO
564 * @pdesc: pointer HW descriptor struct
565 * @config: Any one of the cipher do defined in [CC7x-DESC]
567 static inline void set_cipher_do(struct cc_hw_desc
*pdesc
,
568 enum cc_hash_cipher_pad config
)
570 pdesc
->word
[4] |= FIELD_PREP(WORD4_CIPHER_DO
,
571 (config
& HW_KEY_MASK_CIPHER_DO
));
574 #endif /*__CC_HW_QUEUE_DEFS_H__*/