1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * AMD Cryptographic Coprocessor (CCP) driver
5 * Copyright (C) 2013,2017 Advanced Micro Devices, Inc.
14 #include <linux/scatterlist.h>
15 #include <linux/workqueue.h>
16 #include <linux/list.h>
17 #include <crypto/aes.h>
18 #include <crypto/sha.h>
23 #if defined(CONFIG_CRYPTO_DEV_SP_CCP)
26 * ccp_present - check if a CCP device is present
28 * Returns zero if a CCP device is present, -ENODEV otherwise.
30 int ccp_present(void);
33 #define CCP_VMASK ((unsigned int)((1 << CCP_VSIZE) - 1))
34 #define CCP_VERSION(v, r) ((unsigned int)((v << CCP_VSIZE) \
38 * ccp_version - get the version of the CCP
40 * Returns a positive version number, or zero if no CCP
42 unsigned int ccp_version(void);
45 * ccp_enqueue_cmd - queue an operation for processing by the CCP
47 * @cmd: ccp_cmd struct to be processed
49 * Refer to the ccp_cmd struct below for required fields.
51 * Queue a cmd to be processed by the CCP. If queueing the cmd
52 * would exceed the defined length of the cmd queue the cmd will
53 * only be queued if the CCP_CMD_MAY_BACKLOG flag is set and will
54 * result in a return code of -EBUSY.
56 * The callback routine specified in the ccp_cmd struct will be
57 * called to notify the caller of completion (if the cmd was not
58 * backlogged) or advancement out of the backlog. If the cmd has
59 * advanced out of the backlog the "err" value of the callback
60 * will be -EINPROGRESS. Any other "err" value during callback is
61 * the result of the operation.
63 * The cmd has been successfully queued if:
64 * the return code is -EINPROGRESS or
65 * the return code is -EBUSY and CCP_CMD_MAY_BACKLOG flag is set
67 int ccp_enqueue_cmd(struct ccp_cmd *cmd);
69 #else /* CONFIG_CRYPTO_DEV_CCP_SP_DEV is not enabled */
71 static inline int ccp_present(void)
76 static inline unsigned int ccp_version(void)
81 static inline int ccp_enqueue_cmd(struct ccp_cmd *cmd)
86 #endif /* CONFIG_CRYPTO_DEV_SP_CCP */
89 /***** AES engine *****/
91 * ccp_aes_type - AES key size
93 * @CCP_AES_TYPE_128: 128-bit key
94 * @CCP_AES_TYPE_192: 192-bit key
95 * @CCP_AES_TYPE_256: 256-bit key
105 * ccp_aes_mode - AES operation mode
107 * @CCP_AES_MODE_ECB: ECB mode
108 * @CCP_AES_MODE_CBC: CBC mode
109 * @CCP_AES_MODE_OFB: OFB mode
110 * @CCP_AES_MODE_CFB: CFB mode
111 * @CCP_AES_MODE_CTR: CTR mode
112 * @CCP_AES_MODE_CMAC: CMAC mode
115 CCP_AES_MODE_ECB = 0,
129 * ccp_aes_mode - AES operation mode
131 * @CCP_AES_ACTION_DECRYPT: AES decrypt operation
132 * @CCP_AES_ACTION_ENCRYPT: AES encrypt operation
134 enum ccp_aes_action {
135 CCP_AES_ACTION_DECRYPT = 0,
136 CCP_AES_ACTION_ENCRYPT,
137 CCP_AES_ACTION__LAST,
139 /* Overloaded field */
140 #define CCP_AES_GHASHAAD CCP_AES_ACTION_DECRYPT
141 #define CCP_AES_GHASHFINAL CCP_AES_ACTION_ENCRYPT
144 * struct ccp_aes_engine - CCP AES operation
145 * @type: AES operation key size
146 * @mode: AES operation mode
147 * @action: AES operation (decrypt/encrypt)
148 * @key: key to be used for this AES operation
149 * @key_len: length in bytes of key
150 * @iv: IV to be used for this AES operation
151 * @iv_len: length in bytes of iv
152 * @src: data to be used for this operation
153 * @dst: data produced by this operation
154 * @src_len: length in bytes of data used for this operation
155 * @cmac_final: indicates final operation when running in CMAC mode
156 * @cmac_key: K1/K2 key used in final CMAC operation
157 * @cmac_key_len: length in bytes of cmac_key
159 * Variables required to be set when calling ccp_enqueue_cmd():
160 * - type, mode, action, key, key_len, src, dst, src_len
161 * - iv, iv_len for any mode other than ECB
162 * - cmac_final for CMAC mode
163 * - cmac_key, cmac_key_len for CMAC mode if cmac_final is non-zero
165 * The iv variable is used as both input and output. On completion of the
166 * AES operation the new IV overwrites the old IV.
168 struct ccp_aes_engine {
169 enum ccp_aes_type type;
170 enum ccp_aes_mode mode;
171 enum ccp_aes_action action;
175 struct scatterlist *key;
176 u32 key_len; /* In bytes */
178 struct scatterlist *iv;
179 u32 iv_len; /* In bytes */
181 struct scatterlist *src, *dst;
182 u64 src_len; /* In bytes */
184 u32 cmac_final; /* Indicates final cmac cmd */
185 struct scatterlist *cmac_key; /* K1/K2 cmac key required for
187 u32 cmac_key_len; /* In bytes */
189 u32 aad_len; /* In bytes */
192 /***** XTS-AES engine *****/
194 * ccp_xts_aes_unit_size - XTS unit size
196 * @CCP_XTS_AES_UNIT_SIZE_16: Unit size of 16 bytes
197 * @CCP_XTS_AES_UNIT_SIZE_512: Unit size of 512 bytes
198 * @CCP_XTS_AES_UNIT_SIZE_1024: Unit size of 1024 bytes
199 * @CCP_XTS_AES_UNIT_SIZE_2048: Unit size of 2048 bytes
200 * @CCP_XTS_AES_UNIT_SIZE_4096: Unit size of 4096 bytes
202 enum ccp_xts_aes_unit_size {
203 CCP_XTS_AES_UNIT_SIZE_16 = 0,
204 CCP_XTS_AES_UNIT_SIZE_512,
205 CCP_XTS_AES_UNIT_SIZE_1024,
206 CCP_XTS_AES_UNIT_SIZE_2048,
207 CCP_XTS_AES_UNIT_SIZE_4096,
208 CCP_XTS_AES_UNIT_SIZE__LAST,
212 * struct ccp_xts_aes_engine - CCP XTS AES operation
213 * @action: AES operation (decrypt/encrypt)
214 * @unit_size: unit size of the XTS operation
215 * @key: key to be used for this XTS AES operation
216 * @key_len: length in bytes of key
217 * @iv: IV to be used for this XTS AES operation
218 * @iv_len: length in bytes of iv
219 * @src: data to be used for this operation
220 * @dst: data produced by this operation
221 * @src_len: length in bytes of data used for this operation
222 * @final: indicates final XTS operation
224 * Variables required to be set when calling ccp_enqueue_cmd():
225 * - action, unit_size, key, key_len, iv, iv_len, src, dst, src_len, final
227 * The iv variable is used as both input and output. On completion of the
228 * AES operation the new IV overwrites the old IV.
230 struct ccp_xts_aes_engine {
231 enum ccp_aes_type type;
232 enum ccp_aes_action action;
233 enum ccp_xts_aes_unit_size unit_size;
235 struct scatterlist *key;
236 u32 key_len; /* In bytes */
238 struct scatterlist *iv;
239 u32 iv_len; /* In bytes */
241 struct scatterlist *src, *dst;
242 u64 src_len; /* In bytes */
247 /***** SHA engine *****/
249 * ccp_sha_type - type of SHA operation
251 * @CCP_SHA_TYPE_1: SHA-1 operation
252 * @CCP_SHA_TYPE_224: SHA-224 operation
253 * @CCP_SHA_TYPE_256: SHA-256 operation
265 * struct ccp_sha_engine - CCP SHA operation
266 * @type: Type of SHA operation
267 * @ctx: current hash value
268 * @ctx_len: length in bytes of hash value
269 * @src: data to be used for this operation
270 * @src_len: length in bytes of data used for this operation
271 * @opad: data to be used for final HMAC operation
272 * @opad_len: length in bytes of data used for final HMAC operation
273 * @first: indicates first SHA operation
274 * @final: indicates final SHA operation
275 * @msg_bits: total length of the message in bits used in final SHA operation
277 * Variables required to be set when calling ccp_enqueue_cmd():
278 * - type, ctx, ctx_len, src, src_len, final
279 * - msg_bits if final is non-zero
281 * The ctx variable is used as both input and output. On completion of the
282 * SHA operation the new hash value overwrites the old hash value.
284 struct ccp_sha_engine {
285 enum ccp_sha_type type;
287 struct scatterlist *ctx;
288 u32 ctx_len; /* In bytes */
290 struct scatterlist *src;
291 u64 src_len; /* In bytes */
293 struct scatterlist *opad;
294 u32 opad_len; /* In bytes */
296 u32 first; /* Indicates first sha cmd */
297 u32 final; /* Indicates final sha cmd */
298 u64 msg_bits; /* Message length in bits required for
302 /***** 3DES engine *****/
304 CCP_DES3_MODE_ECB = 0,
311 CCP_DES3_TYPE_168 = 1,
315 enum ccp_des3_action {
316 CCP_DES3_ACTION_DECRYPT = 0,
317 CCP_DES3_ACTION_ENCRYPT,
318 CCP_DES3_ACTION__LAST,
322 * struct ccp_des3_engine - CCP SHA operation
323 * @type: Type of 3DES operation
325 * @action: 3DES operation (decrypt/encrypt)
326 * @key: key to be used for this 3DES operation
327 * @key_len: length of key (in bytes)
328 * @iv: IV to be used for this AES operation
329 * @iv_len: length in bytes of iv
330 * @src: input data to be used for this operation
331 * @src_len: length of input data used for this operation (in bytes)
332 * @dst: output data produced by this operation
334 * Variables required to be set when calling ccp_enqueue_cmd():
335 * - type, mode, action, key, key_len, src, dst, src_len
336 * - iv, iv_len for any mode other than ECB
338 * The iv variable is used as both input and output. On completion of the
339 * 3DES operation the new IV overwrites the old IV.
341 struct ccp_des3_engine {
342 enum ccp_des3_type type;
343 enum ccp_des3_mode mode;
344 enum ccp_des3_action action;
346 struct scatterlist *key;
347 u32 key_len; /* In bytes */
349 struct scatterlist *iv;
350 u32 iv_len; /* In bytes */
352 struct scatterlist *src, *dst;
353 u64 src_len; /* In bytes */
356 /***** RSA engine *****/
358 * struct ccp_rsa_engine - CCP RSA operation
359 * @key_size: length in bits of RSA key
361 * @exp_len: length in bytes of exponent
363 * @mod_len: length in bytes of modulus
364 * @src: data to be used for this operation
365 * @dst: data produced by this operation
366 * @src_len: length in bytes of data used for this operation
368 * Variables required to be set when calling ccp_enqueue_cmd():
369 * - key_size, exp, exp_len, mod, mod_len, src, dst, src_len
371 struct ccp_rsa_engine {
372 u32 key_size; /* In bits */
374 struct scatterlist *exp;
375 u32 exp_len; /* In bytes */
377 struct scatterlist *mod;
378 u32 mod_len; /* In bytes */
380 struct scatterlist *src, *dst;
381 u32 src_len; /* In bytes */
384 /***** Passthru engine *****/
386 * ccp_passthru_bitwise - type of bitwise passthru operation
388 * @CCP_PASSTHRU_BITWISE_NOOP: no bitwise operation performed
389 * @CCP_PASSTHRU_BITWISE_AND: perform bitwise AND of src with mask
390 * @CCP_PASSTHRU_BITWISE_OR: perform bitwise OR of src with mask
391 * @CCP_PASSTHRU_BITWISE_XOR: perform bitwise XOR of src with mask
392 * @CCP_PASSTHRU_BITWISE_MASK: overwrite with mask
394 enum ccp_passthru_bitwise {
395 CCP_PASSTHRU_BITWISE_NOOP = 0,
396 CCP_PASSTHRU_BITWISE_AND,
397 CCP_PASSTHRU_BITWISE_OR,
398 CCP_PASSTHRU_BITWISE_XOR,
399 CCP_PASSTHRU_BITWISE_MASK,
400 CCP_PASSTHRU_BITWISE__LAST,
404 * ccp_passthru_byteswap - type of byteswap passthru operation
406 * @CCP_PASSTHRU_BYTESWAP_NOOP: no byte swapping performed
407 * @CCP_PASSTHRU_BYTESWAP_32BIT: swap bytes within 32-bit words
408 * @CCP_PASSTHRU_BYTESWAP_256BIT: swap bytes within 256-bit words
410 enum ccp_passthru_byteswap {
411 CCP_PASSTHRU_BYTESWAP_NOOP = 0,
412 CCP_PASSTHRU_BYTESWAP_32BIT,
413 CCP_PASSTHRU_BYTESWAP_256BIT,
414 CCP_PASSTHRU_BYTESWAP__LAST,
418 * struct ccp_passthru_engine - CCP pass-through operation
419 * @bit_mod: bitwise operation to perform
420 * @byte_swap: byteswap operation to perform
421 * @mask: mask to be applied to data
422 * @mask_len: length in bytes of mask
423 * @src: data to be used for this operation
424 * @dst: data produced by this operation
425 * @src_len: length in bytes of data used for this operation
426 * @final: indicate final pass-through operation
428 * Variables required to be set when calling ccp_enqueue_cmd():
429 * - bit_mod, byte_swap, src, dst, src_len
430 * - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
432 struct ccp_passthru_engine {
433 enum ccp_passthru_bitwise bit_mod;
434 enum ccp_passthru_byteswap byte_swap;
436 struct scatterlist *mask;
437 u32 mask_len; /* In bytes */
439 struct scatterlist *src, *dst;
440 u64 src_len; /* In bytes */
446 * struct ccp_passthru_nomap_engine - CCP pass-through operation
447 * without performing DMA mapping
448 * @bit_mod: bitwise operation to perform
449 * @byte_swap: byteswap operation to perform
450 * @mask: mask to be applied to data
451 * @mask_len: length in bytes of mask
452 * @src: data to be used for this operation
453 * @dst: data produced by this operation
454 * @src_len: length in bytes of data used for this operation
455 * @final: indicate final pass-through operation
457 * Variables required to be set when calling ccp_enqueue_cmd():
458 * - bit_mod, byte_swap, src, dst, src_len
459 * - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
461 struct ccp_passthru_nomap_engine {
462 enum ccp_passthru_bitwise bit_mod;
463 enum ccp_passthru_byteswap byte_swap;
466 u32 mask_len; /* In bytes */
468 dma_addr_t src_dma, dst_dma;
469 u64 src_len; /* In bytes */
474 /***** ECC engine *****/
475 #define CCP_ECC_MODULUS_BYTES 48 /* 384-bits */
476 #define CCP_ECC_MAX_OPERANDS 6
477 #define CCP_ECC_MAX_OUTPUTS 3
480 * ccp_ecc_function - type of ECC function
482 * @CCP_ECC_FUNCTION_MMUL_384BIT: 384-bit modular multiplication
483 * @CCP_ECC_FUNCTION_MADD_384BIT: 384-bit modular addition
484 * @CCP_ECC_FUNCTION_MINV_384BIT: 384-bit multiplicative inverse
485 * @CCP_ECC_FUNCTION_PADD_384BIT: 384-bit point addition
486 * @CCP_ECC_FUNCTION_PMUL_384BIT: 384-bit point multiplication
487 * @CCP_ECC_FUNCTION_PDBL_384BIT: 384-bit point doubling
489 enum ccp_ecc_function {
490 CCP_ECC_FUNCTION_MMUL_384BIT = 0,
491 CCP_ECC_FUNCTION_MADD_384BIT,
492 CCP_ECC_FUNCTION_MINV_384BIT,
493 CCP_ECC_FUNCTION_PADD_384BIT,
494 CCP_ECC_FUNCTION_PMUL_384BIT,
495 CCP_ECC_FUNCTION_PDBL_384BIT,
499 * struct ccp_ecc_modular_math - CCP ECC modular math parameters
500 * @operand_1: first operand for the modular math operation
501 * @operand_1_len: length of the first operand
502 * @operand_2: second operand for the modular math operation
503 * (not used for CCP_ECC_FUNCTION_MINV_384BIT)
504 * @operand_2_len: length of the second operand
505 * (not used for CCP_ECC_FUNCTION_MINV_384BIT)
506 * @result: result of the modular math operation
507 * @result_len: length of the supplied result buffer
509 struct ccp_ecc_modular_math {
510 struct scatterlist *operand_1;
511 unsigned int operand_1_len; /* In bytes */
513 struct scatterlist *operand_2;
514 unsigned int operand_2_len; /* In bytes */
516 struct scatterlist *result;
517 unsigned int result_len; /* In bytes */
521 * struct ccp_ecc_point - CCP ECC point definition
522 * @x: the x coordinate of the ECC point
523 * @x_len: the length of the x coordinate
524 * @y: the y coordinate of the ECC point
525 * @y_len: the length of the y coordinate
527 struct ccp_ecc_point {
528 struct scatterlist *x;
529 unsigned int x_len; /* In bytes */
531 struct scatterlist *y;
532 unsigned int y_len; /* In bytes */
536 * struct ccp_ecc_point_math - CCP ECC point math parameters
537 * @point_1: the first point of the ECC point math operation
538 * @point_2: the second point of the ECC point math operation
539 * (only used for CCP_ECC_FUNCTION_PADD_384BIT)
540 * @domain_a: the a parameter of the ECC curve
541 * @domain_a_len: the length of the a parameter
542 * @scalar: the scalar parameter for the point match operation
543 * (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
544 * @scalar_len: the length of the scalar parameter
545 * (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
546 * @result: the point resulting from the point math operation
548 struct ccp_ecc_point_math {
549 struct ccp_ecc_point point_1;
550 struct ccp_ecc_point point_2;
552 struct scatterlist *domain_a;
553 unsigned int domain_a_len; /* In bytes */
555 struct scatterlist *scalar;
556 unsigned int scalar_len; /* In bytes */
558 struct ccp_ecc_point result;
562 * struct ccp_ecc_engine - CCP ECC operation
563 * @function: ECC function to perform
565 * @mod_len: length in bytes of modulus
566 * @mm: module math parameters
567 * @pm: point math parameters
568 * @ecc_result: result of the ECC operation
570 * Variables required to be set when calling ccp_enqueue_cmd():
571 * - function, mod, mod_len
572 * - operand, operand_len, operand_count, output, output_len, output_count
575 struct ccp_ecc_engine {
576 enum ccp_ecc_function function;
578 struct scatterlist *mod;
579 u32 mod_len; /* In bytes */
582 struct ccp_ecc_modular_math mm;
583 struct ccp_ecc_point_math pm;
591 * ccp_engine - CCP operation identifiers
593 * @CCP_ENGINE_AES: AES operation
594 * @CCP_ENGINE_XTS_AES: 128-bit XTS AES operation
595 * @CCP_ENGINE_RSVD1: unused
596 * @CCP_ENGINE_SHA: SHA operation
597 * @CCP_ENGINE_RSA: RSA operation
598 * @CCP_ENGINE_PASSTHRU: pass-through operation
599 * @CCP_ENGINE_ZLIB_DECOMPRESS: unused
600 * @CCP_ENGINE_ECC: ECC operation
604 CCP_ENGINE_XTS_AES_128,
609 CCP_ENGINE_ZLIB_DECOMPRESS,
614 /* Flag values for flags member of ccp_cmd */
615 #define CCP_CMD_MAY_BACKLOG 0x00000001
616 #define CCP_CMD_PASSTHRU_NO_DMA_MAP 0x00000002
619 * struct ccp_cmd - CCP operation request
620 * @entry: list element (ccp driver use only)
621 * @work: work element used for callbacks (ccp driver use only)
622 * @ccp: CCP device to be run on
623 * @ret: operation return code (ccp driver use only)
624 * @flags: cmd processing flags
625 * @engine: CCP operation to perform
626 * @engine_error: CCP engine return code
627 * @u: engine specific structures, refer to specific engine struct below
628 * @callback: operation completion callback function
629 * @data: parameter value to be supplied to the callback function
631 * Variables required to be set when calling ccp_enqueue_cmd():
633 * - See the operation structures below for what is required for each
637 /* The list_head, work_struct, ccp and ret variables are for use
638 * by the CCP driver only.
640 struct list_head entry;
641 struct work_struct work;
642 struct ccp_device *ccp;
647 enum ccp_engine engine;
651 struct ccp_aes_engine aes;
652 struct ccp_xts_aes_engine xts;
653 struct ccp_des3_engine des3;
654 struct ccp_sha_engine sha;
655 struct ccp_rsa_engine rsa;
656 struct ccp_passthru_engine passthru;
657 struct ccp_passthru_nomap_engine passthru_nomap;
658 struct ccp_ecc_engine ecc;
661 /* Completion callback support */
662 void (*callback)(void *data, int err);