2 * AMD Cryptographic Coprocessor (CCP) driver
4 * Copyright (C) 2013,2017 Advanced Micro Devices, Inc.
6 * Author: Tom Lendacky <thomas.lendacky@amd.com>
7 * Author: Gary R Hook <gary.hook@amd.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
17 #include <linux/scatterlist.h>
18 #include <linux/workqueue.h>
19 #include <linux/list.h>
20 #include <crypto/aes.h>
21 #include <crypto/sha.h>
27 #if defined(CONFIG_CRYPTO_DEV_CCP_DD) || \
28 defined(CONFIG_CRYPTO_DEV_CCP_DD_MODULE)
31 * ccp_present - check if a CCP device is present
33 * Returns zero if a CCP device is present, -ENODEV otherwise.
35 int ccp_present(void);
38 #define CCP_VMASK ((unsigned int)((1 << CCP_VSIZE) - 1))
39 #define CCP_VERSION(v, r) ((unsigned int)((v << CCP_VSIZE) \
43 * ccp_version - get the version of the CCP
45 * Returns a positive version number, or zero if no CCP
47 unsigned int ccp_version(void);
50 * ccp_enqueue_cmd - queue an operation for processing by the CCP
52 * @cmd: ccp_cmd struct to be processed
54 * Refer to the ccp_cmd struct below for required fields.
56 * Queue a cmd to be processed by the CCP. If queueing the cmd
57 * would exceed the defined length of the cmd queue the cmd will
58 * only be queued if the CCP_CMD_MAY_BACKLOG flag is set and will
59 * result in a return code of -EBUSY.
61 * The callback routine specified in the ccp_cmd struct will be
62 * called to notify the caller of completion (if the cmd was not
63 * backlogged) or advancement out of the backlog. If the cmd has
64 * advanced out of the backlog the "err" value of the callback
65 * will be -EINPROGRESS. Any other "err" value during callback is
66 * the result of the operation.
68 * The cmd has been successfully queued if:
69 * the return code is -EINPROGRESS or
70 * the return code is -EBUSY and CCP_CMD_MAY_BACKLOG flag is set
72 int ccp_enqueue_cmd(struct ccp_cmd *cmd);
74 #else /* CONFIG_CRYPTO_DEV_CCP_DD is not enabled */
76 static inline int ccp_present(void)
81 static inline unsigned int ccp_version(void)
86 static inline int ccp_enqueue_cmd(struct ccp_cmd *cmd)
91 #endif /* CONFIG_CRYPTO_DEV_CCP_DD */
94 /***** AES engine *****/
96 * ccp_aes_type - AES key size
98 * @CCP_AES_TYPE_128: 128-bit key
99 * @CCP_AES_TYPE_192: 192-bit key
100 * @CCP_AES_TYPE_256: 256-bit key
103 CCP_AES_TYPE_128 = 0,
110 * ccp_aes_mode - AES operation mode
112 * @CCP_AES_MODE_ECB: ECB mode
113 * @CCP_AES_MODE_CBC: CBC mode
114 * @CCP_AES_MODE_OFB: OFB mode
115 * @CCP_AES_MODE_CFB: CFB mode
116 * @CCP_AES_MODE_CTR: CTR mode
117 * @CCP_AES_MODE_CMAC: CMAC mode
120 CCP_AES_MODE_ECB = 0,
130 * ccp_aes_mode - AES operation mode
132 * @CCP_AES_ACTION_DECRYPT: AES decrypt operation
133 * @CCP_AES_ACTION_ENCRYPT: AES encrypt operation
135 enum ccp_aes_action {
136 CCP_AES_ACTION_DECRYPT = 0,
137 CCP_AES_ACTION_ENCRYPT,
138 CCP_AES_ACTION__LAST,
142 * struct ccp_aes_engine - CCP AES operation
143 * @type: AES operation key size
144 * @mode: AES operation mode
145 * @action: AES operation (decrypt/encrypt)
146 * @key: key to be used for this AES operation
147 * @key_len: length in bytes of key
148 * @iv: IV to be used for this AES operation
149 * @iv_len: length in bytes of iv
150 * @src: data to be used for this operation
151 * @dst: data produced by this operation
152 * @src_len: length in bytes of data used for this operation
153 * @cmac_final: indicates final operation when running in CMAC mode
154 * @cmac_key: K1/K2 key used in final CMAC operation
155 * @cmac_key_len: length in bytes of cmac_key
157 * Variables required to be set when calling ccp_enqueue_cmd():
158 * - type, mode, action, key, key_len, src, dst, src_len
159 * - iv, iv_len for any mode other than ECB
160 * - cmac_final for CMAC mode
161 * - cmac_key, cmac_key_len for CMAC mode if cmac_final is non-zero
163 * The iv variable is used as both input and output. On completion of the
164 * AES operation the new IV overwrites the old IV.
166 struct ccp_aes_engine {
167 enum ccp_aes_type type;
168 enum ccp_aes_mode mode;
169 enum ccp_aes_action action;
171 struct scatterlist *key;
172 u32 key_len; /* In bytes */
174 struct scatterlist *iv;
175 u32 iv_len; /* In bytes */
177 struct scatterlist *src, *dst;
178 u64 src_len; /* In bytes */
180 u32 cmac_final; /* Indicates final cmac cmd */
181 struct scatterlist *cmac_key; /* K1/K2 cmac key required for
183 u32 cmac_key_len; /* In bytes */
186 /***** XTS-AES engine *****/
188 * ccp_xts_aes_unit_size - XTS unit size
190 * @CCP_XTS_AES_UNIT_SIZE_16: Unit size of 16 bytes
191 * @CCP_XTS_AES_UNIT_SIZE_512: Unit size of 512 bytes
192 * @CCP_XTS_AES_UNIT_SIZE_1024: Unit size of 1024 bytes
193 * @CCP_XTS_AES_UNIT_SIZE_2048: Unit size of 2048 bytes
194 * @CCP_XTS_AES_UNIT_SIZE_4096: Unit size of 4096 bytes
196 enum ccp_xts_aes_unit_size {
197 CCP_XTS_AES_UNIT_SIZE_16 = 0,
198 CCP_XTS_AES_UNIT_SIZE_512,
199 CCP_XTS_AES_UNIT_SIZE_1024,
200 CCP_XTS_AES_UNIT_SIZE_2048,
201 CCP_XTS_AES_UNIT_SIZE_4096,
202 CCP_XTS_AES_UNIT_SIZE__LAST,
206 * struct ccp_xts_aes_engine - CCP XTS AES operation
207 * @action: AES operation (decrypt/encrypt)
208 * @unit_size: unit size of the XTS operation
209 * @key: key to be used for this XTS AES operation
210 * @key_len: length in bytes of key
211 * @iv: IV to be used for this XTS AES operation
212 * @iv_len: length in bytes of iv
213 * @src: data to be used for this operation
214 * @dst: data produced by this operation
215 * @src_len: length in bytes of data used for this operation
216 * @final: indicates final XTS operation
218 * Variables required to be set when calling ccp_enqueue_cmd():
219 * - action, unit_size, key, key_len, iv, iv_len, src, dst, src_len, final
221 * The iv variable is used as both input and output. On completion of the
222 * AES operation the new IV overwrites the old IV.
224 struct ccp_xts_aes_engine {
225 enum ccp_aes_type type;
226 enum ccp_aes_action action;
227 enum ccp_xts_aes_unit_size unit_size;
229 struct scatterlist *key;
230 u32 key_len; /* In bytes */
232 struct scatterlist *iv;
233 u32 iv_len; /* In bytes */
235 struct scatterlist *src, *dst;
236 u64 src_len; /* In bytes */
241 /***** SHA engine *****/
243 * ccp_sha_type - type of SHA operation
245 * @CCP_SHA_TYPE_1: SHA-1 operation
246 * @CCP_SHA_TYPE_224: SHA-224 operation
247 * @CCP_SHA_TYPE_256: SHA-256 operation
257 * struct ccp_sha_engine - CCP SHA operation
258 * @type: Type of SHA operation
259 * @ctx: current hash value
260 * @ctx_len: length in bytes of hash value
261 * @src: data to be used for this operation
262 * @src_len: length in bytes of data used for this operation
263 * @opad: data to be used for final HMAC operation
264 * @opad_len: length in bytes of data used for final HMAC operation
265 * @first: indicates first SHA operation
266 * @final: indicates final SHA operation
267 * @msg_bits: total length of the message in bits used in final SHA operation
269 * Variables required to be set when calling ccp_enqueue_cmd():
270 * - type, ctx, ctx_len, src, src_len, final
271 * - msg_bits if final is non-zero
273 * The ctx variable is used as both input and output. On completion of the
274 * SHA operation the new hash value overwrites the old hash value.
276 struct ccp_sha_engine {
277 enum ccp_sha_type type;
279 struct scatterlist *ctx;
280 u32 ctx_len; /* In bytes */
282 struct scatterlist *src;
283 u64 src_len; /* In bytes */
285 struct scatterlist *opad;
286 u32 opad_len; /* In bytes */
288 u32 first; /* Indicates first sha cmd */
289 u32 final; /* Indicates final sha cmd */
290 u64 msg_bits; /* Message length in bits required for
294 /***** RSA engine *****/
296 * struct ccp_rsa_engine - CCP RSA operation
297 * @key_size: length in bits of RSA key
299 * @exp_len: length in bytes of exponent
301 * @mod_len: length in bytes of modulus
302 * @src: data to be used for this operation
303 * @dst: data produced by this operation
304 * @src_len: length in bytes of data used for this operation
306 * Variables required to be set when calling ccp_enqueue_cmd():
307 * - key_size, exp, exp_len, mod, mod_len, src, dst, src_len
309 struct ccp_rsa_engine {
310 u32 key_size; /* In bits */
312 struct scatterlist *exp;
313 u32 exp_len; /* In bytes */
315 struct scatterlist *mod;
316 u32 mod_len; /* In bytes */
318 struct scatterlist *src, *dst;
319 u32 src_len; /* In bytes */
322 /***** Passthru engine *****/
324 * ccp_passthru_bitwise - type of bitwise passthru operation
326 * @CCP_PASSTHRU_BITWISE_NOOP: no bitwise operation performed
327 * @CCP_PASSTHRU_BITWISE_AND: perform bitwise AND of src with mask
328 * @CCP_PASSTHRU_BITWISE_OR: perform bitwise OR of src with mask
329 * @CCP_PASSTHRU_BITWISE_XOR: perform bitwise XOR of src with mask
330 * @CCP_PASSTHRU_BITWISE_MASK: overwrite with mask
332 enum ccp_passthru_bitwise {
333 CCP_PASSTHRU_BITWISE_NOOP = 0,
334 CCP_PASSTHRU_BITWISE_AND,
335 CCP_PASSTHRU_BITWISE_OR,
336 CCP_PASSTHRU_BITWISE_XOR,
337 CCP_PASSTHRU_BITWISE_MASK,
338 CCP_PASSTHRU_BITWISE__LAST,
342 * ccp_passthru_byteswap - type of byteswap passthru operation
344 * @CCP_PASSTHRU_BYTESWAP_NOOP: no byte swapping performed
345 * @CCP_PASSTHRU_BYTESWAP_32BIT: swap bytes within 32-bit words
346 * @CCP_PASSTHRU_BYTESWAP_256BIT: swap bytes within 256-bit words
348 enum ccp_passthru_byteswap {
349 CCP_PASSTHRU_BYTESWAP_NOOP = 0,
350 CCP_PASSTHRU_BYTESWAP_32BIT,
351 CCP_PASSTHRU_BYTESWAP_256BIT,
352 CCP_PASSTHRU_BYTESWAP__LAST,
356 * struct ccp_passthru_engine - CCP pass-through operation
357 * @bit_mod: bitwise operation to perform
358 * @byte_swap: byteswap operation to perform
359 * @mask: mask to be applied to data
360 * @mask_len: length in bytes of mask
361 * @src: data to be used for this operation
362 * @dst: data produced by this operation
363 * @src_len: length in bytes of data used for this operation
364 * @final: indicate final pass-through operation
366 * Variables required to be set when calling ccp_enqueue_cmd():
367 * - bit_mod, byte_swap, src, dst, src_len
368 * - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
370 struct ccp_passthru_engine {
371 enum ccp_passthru_bitwise bit_mod;
372 enum ccp_passthru_byteswap byte_swap;
374 struct scatterlist *mask;
375 u32 mask_len; /* In bytes */
377 struct scatterlist *src, *dst;
378 u64 src_len; /* In bytes */
384 * struct ccp_passthru_nomap_engine - CCP pass-through operation
385 * without performing DMA mapping
386 * @bit_mod: bitwise operation to perform
387 * @byte_swap: byteswap operation to perform
388 * @mask: mask to be applied to data
389 * @mask_len: length in bytes of mask
390 * @src: data to be used for this operation
391 * @dst: data produced by this operation
392 * @src_len: length in bytes of data used for this operation
393 * @final: indicate final pass-through operation
395 * Variables required to be set when calling ccp_enqueue_cmd():
396 * - bit_mod, byte_swap, src, dst, src_len
397 * - mask, mask_len if bit_mod is not CCP_PASSTHRU_BITWISE_NOOP
399 struct ccp_passthru_nomap_engine {
400 enum ccp_passthru_bitwise bit_mod;
401 enum ccp_passthru_byteswap byte_swap;
404 u32 mask_len; /* In bytes */
406 dma_addr_t src_dma, dst_dma;
407 u64 src_len; /* In bytes */
412 /***** ECC engine *****/
413 #define CCP_ECC_MODULUS_BYTES 48 /* 384-bits */
414 #define CCP_ECC_MAX_OPERANDS 6
415 #define CCP_ECC_MAX_OUTPUTS 3
418 * ccp_ecc_function - type of ECC function
420 * @CCP_ECC_FUNCTION_MMUL_384BIT: 384-bit modular multiplication
421 * @CCP_ECC_FUNCTION_MADD_384BIT: 384-bit modular addition
422 * @CCP_ECC_FUNCTION_MINV_384BIT: 384-bit multiplicative inverse
423 * @CCP_ECC_FUNCTION_PADD_384BIT: 384-bit point addition
424 * @CCP_ECC_FUNCTION_PMUL_384BIT: 384-bit point multiplication
425 * @CCP_ECC_FUNCTION_PDBL_384BIT: 384-bit point doubling
427 enum ccp_ecc_function {
428 CCP_ECC_FUNCTION_MMUL_384BIT = 0,
429 CCP_ECC_FUNCTION_MADD_384BIT,
430 CCP_ECC_FUNCTION_MINV_384BIT,
431 CCP_ECC_FUNCTION_PADD_384BIT,
432 CCP_ECC_FUNCTION_PMUL_384BIT,
433 CCP_ECC_FUNCTION_PDBL_384BIT,
437 * struct ccp_ecc_modular_math - CCP ECC modular math parameters
438 * @operand_1: first operand for the modular math operation
439 * @operand_1_len: length of the first operand
440 * @operand_2: second operand for the modular math operation
441 * (not used for CCP_ECC_FUNCTION_MINV_384BIT)
442 * @operand_2_len: length of the second operand
443 * (not used for CCP_ECC_FUNCTION_MINV_384BIT)
444 * @result: result of the modular math operation
445 * @result_len: length of the supplied result buffer
447 struct ccp_ecc_modular_math {
448 struct scatterlist *operand_1;
449 unsigned int operand_1_len; /* In bytes */
451 struct scatterlist *operand_2;
452 unsigned int operand_2_len; /* In bytes */
454 struct scatterlist *result;
455 unsigned int result_len; /* In bytes */
459 * struct ccp_ecc_point - CCP ECC point definition
460 * @x: the x coordinate of the ECC point
461 * @x_len: the length of the x coordinate
462 * @y: the y coordinate of the ECC point
463 * @y_len: the length of the y coordinate
465 struct ccp_ecc_point {
466 struct scatterlist *x;
467 unsigned int x_len; /* In bytes */
469 struct scatterlist *y;
470 unsigned int y_len; /* In bytes */
474 * struct ccp_ecc_point_math - CCP ECC point math parameters
475 * @point_1: the first point of the ECC point math operation
476 * @point_2: the second point of the ECC point math operation
477 * (only used for CCP_ECC_FUNCTION_PADD_384BIT)
478 * @domain_a: the a parameter of the ECC curve
479 * @domain_a_len: the length of the a parameter
480 * @scalar: the scalar parameter for the point match operation
481 * (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
482 * @scalar_len: the length of the scalar parameter
483 * (only used for CCP_ECC_FUNCTION_PMUL_384BIT)
484 * @result: the point resulting from the point math operation
486 struct ccp_ecc_point_math {
487 struct ccp_ecc_point point_1;
488 struct ccp_ecc_point point_2;
490 struct scatterlist *domain_a;
491 unsigned int domain_a_len; /* In bytes */
493 struct scatterlist *scalar;
494 unsigned int scalar_len; /* In bytes */
496 struct ccp_ecc_point result;
500 * struct ccp_ecc_engine - CCP ECC operation
501 * @function: ECC function to perform
503 * @mod_len: length in bytes of modulus
504 * @mm: module math parameters
505 * @pm: point math parameters
506 * @ecc_result: result of the ECC operation
508 * Variables required to be set when calling ccp_enqueue_cmd():
509 * - function, mod, mod_len
510 * - operand, operand_len, operand_count, output, output_len, output_count
513 struct ccp_ecc_engine {
514 enum ccp_ecc_function function;
516 struct scatterlist *mod;
517 u32 mod_len; /* In bytes */
520 struct ccp_ecc_modular_math mm;
521 struct ccp_ecc_point_math pm;
529 * ccp_engine - CCP operation identifiers
531 * @CCP_ENGINE_AES: AES operation
532 * @CCP_ENGINE_XTS_AES: 128-bit XTS AES operation
533 * @CCP_ENGINE_RSVD1: unused
534 * @CCP_ENGINE_SHA: SHA operation
535 * @CCP_ENGINE_RSA: RSA operation
536 * @CCP_ENGINE_PASSTHRU: pass-through operation
537 * @CCP_ENGINE_ZLIB_DECOMPRESS: unused
538 * @CCP_ENGINE_ECC: ECC operation
542 CCP_ENGINE_XTS_AES_128,
547 CCP_ENGINE_ZLIB_DECOMPRESS,
552 /* Flag values for flags member of ccp_cmd */
553 #define CCP_CMD_MAY_BACKLOG 0x00000001
554 #define CCP_CMD_PASSTHRU_NO_DMA_MAP 0x00000002
557 * struct ccp_cmd - CPP operation request
558 * @entry: list element (ccp driver use only)
559 * @work: work element used for callbacks (ccp driver use only)
560 * @ccp: CCP device to be run on
561 * @ret: operation return code (ccp driver use only)
562 * @flags: cmd processing flags
563 * @engine: CCP operation to perform
564 * @engine_error: CCP engine return code
565 * @u: engine specific structures, refer to specific engine struct below
566 * @callback: operation completion callback function
567 * @data: parameter value to be supplied to the callback function
569 * Variables required to be set when calling ccp_enqueue_cmd():
571 * - See the operation structures below for what is required for each
575 /* The list_head, work_struct, ccp and ret variables are for use
576 * by the CCP driver only.
578 struct list_head entry;
579 struct work_struct work;
580 struct ccp_device *ccp;
585 enum ccp_engine engine;
589 struct ccp_aes_engine aes;
590 struct ccp_xts_aes_engine xts;
591 struct ccp_sha_engine sha;
592 struct ccp_rsa_engine rsa;
593 struct ccp_passthru_engine passthru;
594 struct ccp_passthru_nomap_engine passthru_nomap;
595 struct ccp_ecc_engine ecc;
598 /* Completion callback support */
599 void (*callback)(void *data, int err);