1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright IBM Corp. 2001, 2023
4 * Author(s): Robert Burroughs
13 #define KMSG_COMPONENT "zcrypt"
14 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/err.h>
19 #include <linux/delay.h>
20 #include <linux/slab.h>
21 #include <linux/atomic.h>
22 #include <linux/uaccess.h>
25 #include "zcrypt_api.h"
26 #include "zcrypt_error.h"
27 #include "zcrypt_msgtype6.h"
28 #include "zcrypt_cca_key.h"
30 #define CEXXC_MAX_ICA_RESPONSE_SIZE 0x77c /* max size type86 v2 reply */
32 #define CEIL4(x) ((((x) + 3) / 4) * 4)
34 struct response_type {
35 struct completion work;
39 #define CEXXC_RESPONSE_TYPE_ICA 0
40 #define CEXXC_RESPONSE_TYPE_XCRB 1
41 #define CEXXC_RESPONSE_TYPE_EP11 2
43 MODULE_AUTHOR("IBM Corporation");
44 MODULE_DESCRIPTION("Cryptographic Coprocessor (message type 6), " \
45 "Copyright IBM Corp. 2001, 2023");
46 MODULE_LICENSE("GPL");
48 struct function_and_rules_block {
49 unsigned char function_code[2];
51 unsigned char only_rule[8];
55 * The following is used to initialize the CPRBX passed to the CEXxC/CEXxP
56 * card in a type6 message. The 3 fields that must be filled in at execution
57 * time are req_parml, rpl_parml and usage_domain.
58 * Everything about this interface is ascii/big-endian, since the
59 * device does *not* have 'Intel inside'.
61 * The CPRBX is followed immediately by the parm block.
62 * The parm block contains:
63 * - function code ('PD' 0x5044 or 'PK' 0x504B)
64 * - rule block (one of:)
65 * + 0x000A 'PKCS-1.2' (MCL2 'PD')
66 * + 0x000A 'ZERO-PAD' (MCL2 'PK')
67 * + 0x000A 'ZERO-PAD' (MCL3 'PD' or CEX2C 'PD')
68 * + 0x000A 'MRP ' (MCL3 'PK' or CEX2C 'PK')
71 static const struct CPRBX static_cprbx = {
74 .func_id = {0x54, 0x32},
77 int speed_idx_cca(int req_type)
152 int speed_idx_ep11(int req_type)
183 * Convert a ICAMEX message to a type6 MEX message.
185 * @zq: crypto device pointer
186 * @ap_msg: pointer to AP message
187 * @mex: pointer to user input data
189 * Returns 0 on success or negative errno value.
191 static int icamex_msg_to_type6mex_msgx(struct zcrypt_queue *zq,
192 struct ap_message *ap_msg,
193 struct ica_rsa_modexpo *mex)
195 static struct type6_hdr static_type6_hdrX = {
197 .offset1 = 0x00000058,
198 .agent_id = {'C', 'A',},
199 .function_code = {'P', 'K'},
201 static struct function_and_rules_block static_pke_fnr = {
202 .function_code = {'P', 'K'},
204 .only_rule = {'M', 'R', 'P', ' ', ' ', ' ', ' ', ' '}
207 struct type6_hdr hdr;
209 struct function_and_rules_block fr;
210 unsigned short length;
212 } __packed * msg = ap_msg->msg;
216 * The inputdatalength was a selection criteria in the dispatching
217 * function zcrypt_rsa_modexpo(). However, make sure the following
218 * copy_from_user() never exceeds the allocated buffer space.
220 if (WARN_ON_ONCE(mex->inputdatalength > PAGE_SIZE))
224 msg->length = mex->inputdatalength + 2;
225 if (copy_from_user(msg->text, mex->inputdata, mex->inputdatalength))
228 /* Set up key which is located after the variable length text. */
229 size = zcrypt_type6_mex_key_en(mex, msg->text + mex->inputdatalength);
232 size += sizeof(*msg) + mex->inputdatalength;
234 /* message header, cprbx and f&r */
235 msg->hdr = static_type6_hdrX;
236 msg->hdr.tocardlen1 = size - sizeof(msg->hdr);
237 msg->hdr.fromcardlen1 = CEXXC_MAX_ICA_RESPONSE_SIZE - sizeof(msg->hdr);
239 msg->cprbx = static_cprbx;
240 msg->cprbx.domain = AP_QID_QUEUE(zq->queue->qid);
241 msg->cprbx.rpl_msgbl = msg->hdr.fromcardlen1;
243 msg->fr = static_pke_fnr;
245 msg->cprbx.req_parml = size - sizeof(msg->hdr) - sizeof(msg->cprbx);
252 * Convert a ICACRT message to a type6 CRT message.
254 * @zq: crypto device pointer
255 * @ap_msg: pointer to AP message
256 * @crt: pointer to user input data
258 * Returns 0 on success or negative errno value.
260 static int icacrt_msg_to_type6crt_msgx(struct zcrypt_queue *zq,
261 struct ap_message *ap_msg,
262 struct ica_rsa_modexpo_crt *crt)
264 static struct type6_hdr static_type6_hdrX = {
266 .offset1 = 0x00000058,
267 .agent_id = {'C', 'A',},
268 .function_code = {'P', 'D'},
270 static struct function_and_rules_block static_pkd_fnr = {
271 .function_code = {'P', 'D'},
273 .only_rule = {'Z', 'E', 'R', 'O', '-', 'P', 'A', 'D'}
277 struct type6_hdr hdr;
279 struct function_and_rules_block fr;
280 unsigned short length;
282 } __packed * msg = ap_msg->msg;
286 * The inputdatalength was a selection criteria in the dispatching
287 * function zcrypt_rsa_crt(). However, make sure the following
288 * copy_from_user() never exceeds the allocated buffer space.
290 if (WARN_ON_ONCE(crt->inputdatalength > PAGE_SIZE))
294 msg->length = crt->inputdatalength + 2;
295 if (copy_from_user(msg->text, crt->inputdata, crt->inputdatalength))
298 /* Set up key which is located after the variable length text. */
299 size = zcrypt_type6_crt_key(crt, msg->text + crt->inputdatalength);
302 size += sizeof(*msg) + crt->inputdatalength; /* total size of msg */
304 /* message header, cprbx and f&r */
305 msg->hdr = static_type6_hdrX;
306 msg->hdr.tocardlen1 = size - sizeof(msg->hdr);
307 msg->hdr.fromcardlen1 = CEXXC_MAX_ICA_RESPONSE_SIZE - sizeof(msg->hdr);
309 msg->cprbx = static_cprbx;
310 msg->cprbx.domain = AP_QID_QUEUE(zq->queue->qid);
311 msg->cprbx.req_parml = msg->cprbx.rpl_msgbl =
312 size - sizeof(msg->hdr) - sizeof(msg->cprbx);
314 msg->fr = static_pkd_fnr;
321 * Convert a XCRB message to a type6 CPRB message.
323 * @zq: crypto device pointer
324 * @ap_msg: pointer to AP message
325 * @xcRB: pointer to user input data
327 * Returns 0 on success or -EFAULT, -EINVAL.
329 struct type86_fmt2_msg {
330 struct type86_hdr hdr;
331 struct type86_fmt2_ext fmt2;
334 static int xcrb_msg_to_type6cprb_msgx(bool userspace, struct ap_message *ap_msg,
335 struct ica_xcRB *xcrb,
337 unsigned short **dom)
339 static struct type6_hdr static_type6_hdrX = {
341 .offset1 = 0x00000058,
344 struct type6_hdr hdr;
347 DECLARE_FLEX_ARRAY(u8, userdata);
349 } __packed * msg = ap_msg->msg;
351 int rcblen = CEIL4(xcrb->request_control_blk_length);
352 int req_sumlen, resp_sumlen;
353 char *req_data = ap_msg->msg + sizeof(struct type6_hdr) + rcblen;
356 if (CEIL4(xcrb->request_control_blk_length) <
357 xcrb->request_control_blk_length)
358 return -EINVAL; /* overflow after alignment*/
361 ap_msg->len = sizeof(struct type6_hdr) +
362 CEIL4(xcrb->request_control_blk_length) +
363 xcrb->request_data_length;
364 if (ap_msg->len > ap_msg->bufsize)
369 * sum must be greater (or equal) than the largest operand
371 req_sumlen = CEIL4(xcrb->request_control_blk_length) +
372 xcrb->request_data_length;
373 if ((CEIL4(xcrb->request_control_blk_length) <=
374 xcrb->request_data_length) ?
375 req_sumlen < xcrb->request_data_length :
376 req_sumlen < CEIL4(xcrb->request_control_blk_length)) {
380 if (CEIL4(xcrb->reply_control_blk_length) <
381 xcrb->reply_control_blk_length)
382 return -EINVAL; /* overflow after alignment*/
386 * sum must be greater (or equal) than the largest operand
388 resp_sumlen = CEIL4(xcrb->reply_control_blk_length) +
389 xcrb->reply_data_length;
390 if ((CEIL4(xcrb->reply_control_blk_length) <=
391 xcrb->reply_data_length) ?
392 resp_sumlen < xcrb->reply_data_length :
393 resp_sumlen < CEIL4(xcrb->reply_control_blk_length)) {
397 /* prepare type6 header */
398 msg->hdr = static_type6_hdrX;
399 memcpy(msg->hdr.agent_id, &xcrb->agent_ID, sizeof(xcrb->agent_ID));
400 msg->hdr.tocardlen1 = xcrb->request_control_blk_length;
401 if (xcrb->request_data_length) {
402 msg->hdr.offset2 = msg->hdr.offset1 + rcblen;
403 msg->hdr.tocardlen2 = xcrb->request_data_length;
405 msg->hdr.fromcardlen1 = xcrb->reply_control_blk_length;
406 msg->hdr.fromcardlen2 = xcrb->reply_data_length;
409 if (z_copy_from_user(userspace, msg->userdata,
410 xcrb->request_control_blk_addr,
411 xcrb->request_control_blk_length))
413 if (msg->cprbx.cprb_len + sizeof(msg->hdr.function_code) >
414 xcrb->request_control_blk_length)
416 function_code = ((unsigned char *)&msg->cprbx) + msg->cprbx.cprb_len;
417 memcpy(msg->hdr.function_code, function_code,
418 sizeof(msg->hdr.function_code));
420 *fcode = (msg->hdr.function_code[0] << 8) | msg->hdr.function_code[1];
421 *dom = (unsigned short *)&msg->cprbx.domain;
423 /* check subfunction, US and AU need special flag with NQAP */
424 if (memcmp(function_code, "US", 2) == 0 ||
425 memcmp(function_code, "AU", 2) == 0)
426 ap_msg->flags |= AP_MSG_FLAG_SPECIAL;
428 /* check CPRB minor version, set info bits in ap_message flag field */
429 switch (*(unsigned short *)(&msg->cprbx.func_id[0])) {
430 case 0x5432: /* "T2" */
431 ap_msg->flags |= AP_MSG_FLAG_USAGE;
433 case 0x5433: /* "T3" */
434 case 0x5435: /* "T5" */
435 case 0x5436: /* "T6" */
436 case 0x5437: /* "T7" */
437 ap_msg->flags |= AP_MSG_FLAG_ADMIN;
440 pr_debug("unknown CPRB minor version '%c%c'\n",
441 msg->cprbx.func_id[0], msg->cprbx.func_id[1]);
444 /* copy data block */
445 if (xcrb->request_data_length &&
446 z_copy_from_user(userspace, req_data, xcrb->request_data_address,
447 xcrb->request_data_length))
453 static int xcrb_msg_to_type6_ep11cprb_msgx(bool userspace, struct ap_message *ap_msg,
454 struct ep11_urb *xcrb,
456 unsigned int *domain)
459 static struct type6_hdr static_type6_ep11_hdr = {
461 .rqid = {0x00, 0x01},
462 .function_code = {0x00, 0x00},
463 .agent_id[0] = 0x58, /* {'X'} */
464 .agent_id[1] = 0x43, /* {'C'} */
465 .offset1 = 0x00000058,
469 struct type6_hdr hdr;
472 struct ep11_cprb cprbx;
473 unsigned char pld_tag; /* fixed value 0x30 */
474 unsigned char pld_lenfmt; /* length format */
476 DECLARE_FLEX_ARRAY(u8, userdata);
478 } __packed * msg = ap_msg->msg;
481 unsigned char func_tag; /* fixed value 0x4 */
482 unsigned char func_len; /* fixed value 0x4 */
483 unsigned int func_val; /* function ID */
484 unsigned char dom_tag; /* fixed value 0x4 */
485 unsigned char dom_len; /* fixed value 0x4 */
486 unsigned int dom_val; /* domain id */
487 } __packed * payload_hdr = NULL;
489 if (CEIL4(xcrb->req_len) < xcrb->req_len)
490 return -EINVAL; /* overflow after alignment*/
493 ap_msg->len = sizeof(struct type6_hdr) + CEIL4(xcrb->req_len);
494 if (ap_msg->len > ap_msg->bufsize)
497 if (CEIL4(xcrb->resp_len) < xcrb->resp_len)
498 return -EINVAL; /* overflow after alignment*/
500 /* prepare type6 header */
501 msg->hdr = static_type6_ep11_hdr;
502 msg->hdr.tocardlen1 = xcrb->req_len;
503 msg->hdr.fromcardlen1 = xcrb->resp_len;
505 /* Import CPRB data from the ioctl input parameter */
506 if (z_copy_from_user(userspace, msg->userdata,
507 (char __force __user *)xcrb->req, xcrb->req_len)) {
511 if ((msg->pld_lenfmt & 0x80) == 0x80) { /*ext.len.fmt 2 or 3*/
512 switch (msg->pld_lenfmt & 0x03) {
523 lfmt = 1; /* length format #1 */
525 payload_hdr = (struct pld_hdr *)((&msg->pld_lenfmt) + lfmt);
526 *fcode = payload_hdr->func_val & 0xFFFF;
528 /* enable special processing based on the cprbs flags special bit */
529 if (msg->cprbx.flags & 0x20)
530 ap_msg->flags |= AP_MSG_FLAG_SPECIAL;
532 /* set info bits in ap_message flag field */
533 if (msg->cprbx.flags & 0x80)
534 ap_msg->flags |= AP_MSG_FLAG_ADMIN;
536 ap_msg->flags |= AP_MSG_FLAG_USAGE;
538 *domain = msg->cprbx.target_id;
544 * Copy results from a type 86 ICA reply message back to user space.
546 * @zq: crypto device pointer
547 * @reply: reply AP message.
548 * @data: pointer to user output data
549 * @length: size of user output data
551 * Returns 0 on success or -EINVAL, -EFAULT, -EAGAIN in case of an error.
553 struct type86x_reply {
554 struct type86_hdr hdr;
555 struct type86_fmt2_ext fmt2;
557 unsigned char pad[4]; /* 4 byte function code/rules block ? */
558 unsigned short length; /* length of data including length field size */
562 struct type86_ep11_reply {
563 struct type86_hdr hdr;
564 struct type86_fmt2_ext fmt2;
565 struct ep11_cprb cprbx;
568 static int convert_type86_ica(struct zcrypt_queue *zq,
569 struct ap_message *reply,
570 char __user *outputdata,
571 unsigned int outputdatalength)
573 struct type86x_reply *msg = reply->msg;
574 unsigned short service_rc, service_rs;
575 unsigned int data_len;
577 service_rc = msg->cprbx.ccp_rtcode;
578 if (unlikely(service_rc != 0)) {
579 service_rs = msg->cprbx.ccp_rscode;
580 if ((service_rc == 8 && service_rs == 66) ||
581 (service_rc == 8 && service_rs == 65) ||
582 (service_rc == 8 && service_rs == 72) ||
583 (service_rc == 8 && service_rs == 770) ||
584 (service_rc == 12 && service_rs == 769)) {
585 ZCRYPT_DBF_WARN("%s dev=%02x.%04x rc/rs=%d/%d => rc=EINVAL\n",
586 __func__, AP_QID_CARD(zq->queue->qid),
587 AP_QID_QUEUE(zq->queue->qid),
588 (int)service_rc, (int)service_rs);
592 pr_err("Crypto dev=%02x.%04x rc/rs=%d/%d online=0 rc=EAGAIN\n",
593 AP_QID_CARD(zq->queue->qid),
594 AP_QID_QUEUE(zq->queue->qid),
595 (int)service_rc, (int)service_rs);
596 ZCRYPT_DBF_ERR("%s dev=%02x.%04x rc/rs=%d/%d => online=0 rc=EAGAIN\n",
597 __func__, AP_QID_CARD(zq->queue->qid),
598 AP_QID_QUEUE(zq->queue->qid),
599 (int)service_rc, (int)service_rs);
600 ap_send_online_uevent(&zq->queue->ap_dev, zq->online);
603 data_len = msg->length - sizeof(msg->length);
604 if (data_len > outputdatalength)
607 /* Copy the crypto response to user space. */
608 if (copy_to_user(outputdata, msg->data, data_len))
614 * Copy results from a type 86 XCRB reply message back to user space.
616 * @zq: crypto device pointer
617 * @reply: reply AP message.
618 * @xcrb: pointer to XCRB
620 * Returns 0 on success or -EINVAL, -EFAULT, -EAGAIN in case of an error.
622 static int convert_type86_xcrb(bool userspace, struct zcrypt_queue *zq,
623 struct ap_message *reply,
624 struct ica_xcRB *xcrb)
626 struct type86_fmt2_msg *msg = reply->msg;
627 char *data = reply->msg;
629 /* Copy CPRB to user */
630 if (xcrb->reply_control_blk_length < msg->fmt2.count1) {
631 pr_debug("reply_control_blk_length %u < required %u => EMSGSIZE\n",
632 xcrb->reply_control_blk_length, msg->fmt2.count1);
635 if (z_copy_to_user(userspace, xcrb->reply_control_blk_addr,
636 data + msg->fmt2.offset1, msg->fmt2.count1))
638 xcrb->reply_control_blk_length = msg->fmt2.count1;
640 /* Copy data buffer to user */
641 if (msg->fmt2.count2) {
642 if (xcrb->reply_data_length < msg->fmt2.count2) {
643 pr_debug("reply_data_length %u < required %u => EMSGSIZE\n",
644 xcrb->reply_data_length, msg->fmt2.count2);
647 if (z_copy_to_user(userspace, xcrb->reply_data_addr,
648 data + msg->fmt2.offset2, msg->fmt2.count2))
651 xcrb->reply_data_length = msg->fmt2.count2;
657 * Copy results from a type 86 EP11 XCRB reply message back to user space.
659 * @zq: crypto device pointer
660 * @reply: reply AP message.
661 * @xcrb: pointer to EP11 user request block
663 * Returns 0 on success or -EINVAL, -EFAULT, -EAGAIN in case of an error.
665 static int convert_type86_ep11_xcrb(bool userspace, struct zcrypt_queue *zq,
666 struct ap_message *reply,
667 struct ep11_urb *xcrb)
669 struct type86_fmt2_msg *msg = reply->msg;
670 char *data = reply->msg;
672 if (xcrb->resp_len < msg->fmt2.count1) {
673 pr_debug("resp_len %u < required %u => EMSGSIZE\n",
674 (unsigned int)xcrb->resp_len, msg->fmt2.count1);
678 /* Copy response CPRB to user */
679 if (z_copy_to_user(userspace, (char __force __user *)xcrb->resp,
680 data + msg->fmt2.offset1, msg->fmt2.count1))
682 xcrb->resp_len = msg->fmt2.count1;
686 static int convert_type86_rng(struct zcrypt_queue *zq,
687 struct ap_message *reply,
691 struct type86_hdr hdr;
692 struct type86_fmt2_ext fmt2;
694 } __packed * msg = reply->msg;
695 char *data = reply->msg;
697 if (msg->cprbx.ccp_rtcode != 0 || msg->cprbx.ccp_rscode != 0)
699 memcpy(buffer, data + msg->fmt2.offset2, msg->fmt2.count2);
700 return msg->fmt2.count2;
703 static int convert_response_ica(struct zcrypt_queue *zq,
704 struct ap_message *reply,
705 char __user *outputdata,
706 unsigned int outputdatalength)
708 struct type86x_reply *msg = reply->msg;
710 switch (msg->hdr.type) {
711 case TYPE82_RSP_CODE:
712 case TYPE88_RSP_CODE:
713 return convert_error(zq, reply);
714 case TYPE86_RSP_CODE:
715 if (msg->cprbx.ccp_rtcode &&
716 msg->cprbx.ccp_rscode == 0x14f &&
717 outputdatalength > 256) {
718 if (zq->zcard->max_exp_bit_length <= 17) {
719 zq->zcard->max_exp_bit_length = 17;
725 if (msg->hdr.reply_code)
726 return convert_error(zq, reply);
727 if (msg->cprbx.cprb_ver_id == 0x02)
728 return convert_type86_ica(zq, reply,
729 outputdata, outputdatalength);
730 fallthrough; /* wrong cprb version is an unknown response */
732 /* Unknown response type, this should NEVER EVER happen */
734 pr_err("Crypto dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
735 AP_QID_CARD(zq->queue->qid),
736 AP_QID_QUEUE(zq->queue->qid),
739 "%s dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
740 __func__, AP_QID_CARD(zq->queue->qid),
741 AP_QID_QUEUE(zq->queue->qid), (int)msg->hdr.type);
742 ap_send_online_uevent(&zq->queue->ap_dev, zq->online);
747 static int convert_response_xcrb(bool userspace, struct zcrypt_queue *zq,
748 struct ap_message *reply,
749 struct ica_xcRB *xcrb)
751 struct type86x_reply *msg = reply->msg;
753 switch (msg->hdr.type) {
754 case TYPE82_RSP_CODE:
755 case TYPE88_RSP_CODE:
756 xcrb->status = 0x0008044DL; /* HDD_InvalidParm */
757 return convert_error(zq, reply);
758 case TYPE86_RSP_CODE:
759 if (msg->hdr.reply_code) {
760 memcpy(&xcrb->status, msg->fmt2.apfs, sizeof(u32));
761 return convert_error(zq, reply);
763 if (msg->cprbx.cprb_ver_id == 0x02)
764 return convert_type86_xcrb(userspace, zq, reply, xcrb);
765 fallthrough; /* wrong cprb version is an unknown response */
766 default: /* Unknown response type, this should NEVER EVER happen */
767 xcrb->status = 0x0008044DL; /* HDD_InvalidParm */
769 pr_err("Crypto dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
770 AP_QID_CARD(zq->queue->qid),
771 AP_QID_QUEUE(zq->queue->qid),
774 "%s dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
775 __func__, AP_QID_CARD(zq->queue->qid),
776 AP_QID_QUEUE(zq->queue->qid), (int)msg->hdr.type);
777 ap_send_online_uevent(&zq->queue->ap_dev, zq->online);
782 static int convert_response_ep11_xcrb(bool userspace, struct zcrypt_queue *zq,
783 struct ap_message *reply, struct ep11_urb *xcrb)
785 struct type86_ep11_reply *msg = reply->msg;
787 switch (msg->hdr.type) {
788 case TYPE82_RSP_CODE:
789 case TYPE87_RSP_CODE:
790 return convert_error(zq, reply);
791 case TYPE86_RSP_CODE:
792 if (msg->hdr.reply_code)
793 return convert_error(zq, reply);
794 if (msg->cprbx.cprb_ver_id == 0x04)
795 return convert_type86_ep11_xcrb(userspace, zq, reply, xcrb);
796 fallthrough; /* wrong cprb version is an unknown resp */
797 default: /* Unknown response type, this should NEVER EVER happen */
799 pr_err("Crypto dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
800 AP_QID_CARD(zq->queue->qid),
801 AP_QID_QUEUE(zq->queue->qid),
804 "%s dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
805 __func__, AP_QID_CARD(zq->queue->qid),
806 AP_QID_QUEUE(zq->queue->qid), (int)msg->hdr.type);
807 ap_send_online_uevent(&zq->queue->ap_dev, zq->online);
812 static int convert_response_rng(struct zcrypt_queue *zq,
813 struct ap_message *reply,
816 struct type86x_reply *msg = reply->msg;
818 switch (msg->hdr.type) {
819 case TYPE82_RSP_CODE:
820 case TYPE88_RSP_CODE:
822 case TYPE86_RSP_CODE:
823 if (msg->hdr.reply_code)
825 if (msg->cprbx.cprb_ver_id == 0x02)
826 return convert_type86_rng(zq, reply, data);
827 fallthrough; /* wrong cprb version is an unknown response */
828 default: /* Unknown response type, this should NEVER EVER happen */
830 pr_err("Crypto dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
831 AP_QID_CARD(zq->queue->qid),
832 AP_QID_QUEUE(zq->queue->qid),
835 "%s dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
836 __func__, AP_QID_CARD(zq->queue->qid),
837 AP_QID_QUEUE(zq->queue->qid), (int)msg->hdr.type);
838 ap_send_online_uevent(&zq->queue->ap_dev, zq->online);
844 * This function is called from the AP bus code after a crypto request
845 * "msg" has finished with the reply message "reply".
846 * It is called from tasklet context.
847 * @aq: pointer to the AP queue
848 * @msg: pointer to the AP message
849 * @reply: pointer to the AP reply message
851 static void zcrypt_msgtype6_receive(struct ap_queue *aq,
852 struct ap_message *msg,
853 struct ap_message *reply)
855 static struct error_hdr error_reply = {
856 .type = TYPE82_RSP_CODE,
857 .reply_code = REP82_ERROR_MACHINE_FAILURE,
859 struct response_type *resp_type = msg->private;
860 struct type86x_reply *t86r;
863 /* Copy the reply message to the request message buffer. */
865 goto out; /* ap_msg->rc indicates the error */
867 if (t86r->hdr.type == TYPE86_RSP_CODE &&
868 t86r->cprbx.cprb_ver_id == 0x02) {
869 switch (resp_type->type) {
870 case CEXXC_RESPONSE_TYPE_ICA:
871 len = sizeof(struct type86x_reply) + t86r->length;
872 if (len > reply->bufsize || len > msg->bufsize ||
874 pr_debug("len mismatch => EMSGSIZE\n");
878 memcpy(msg->msg, reply->msg, len);
881 case CEXXC_RESPONSE_TYPE_XCRB:
882 if (t86r->fmt2.count2)
883 len = t86r->fmt2.offset2 + t86r->fmt2.count2;
885 len = t86r->fmt2.offset1 + t86r->fmt2.count1;
886 if (len > reply->bufsize || len > msg->bufsize ||
888 pr_debug("len mismatch => EMSGSIZE\n");
892 memcpy(msg->msg, reply->msg, len);
896 memcpy(msg->msg, &error_reply, sizeof(error_reply));
897 msg->len = sizeof(error_reply);
900 memcpy(msg->msg, reply->msg, sizeof(error_reply));
901 msg->len = sizeof(error_reply);
904 complete(&resp_type->work);
908 * This function is called from the AP bus code after a crypto request
909 * "msg" has finished with the reply message "reply".
910 * It is called from tasklet context.
911 * @aq: pointer to the AP queue
912 * @msg: pointer to the AP message
913 * @reply: pointer to the AP reply message
915 static void zcrypt_msgtype6_receive_ep11(struct ap_queue *aq,
916 struct ap_message *msg,
917 struct ap_message *reply)
919 static struct error_hdr error_reply = {
920 .type = TYPE82_RSP_CODE,
921 .reply_code = REP82_ERROR_MACHINE_FAILURE,
923 struct response_type *resp_type = msg->private;
924 struct type86_ep11_reply *t86r;
927 /* Copy the reply message to the request message buffer. */
929 goto out; /* ap_msg->rc indicates the error */
931 if (t86r->hdr.type == TYPE86_RSP_CODE &&
932 t86r->cprbx.cprb_ver_id == 0x04) {
933 switch (resp_type->type) {
934 case CEXXC_RESPONSE_TYPE_EP11:
935 len = t86r->fmt2.offset1 + t86r->fmt2.count1;
936 if (len > reply->bufsize || len > msg->bufsize ||
938 pr_debug("len mismatch => EMSGSIZE\n");
942 memcpy(msg->msg, reply->msg, len);
946 memcpy(msg->msg, &error_reply, sizeof(error_reply));
947 msg->len = sizeof(error_reply);
950 memcpy(msg->msg, reply->msg, sizeof(error_reply));
951 msg->len = sizeof(error_reply);
954 complete(&resp_type->work);
957 static atomic_t zcrypt_step = ATOMIC_INIT(0);
960 * The request distributor calls this function if it picked the CEXxC
961 * device to handle a modexpo request.
962 * @zq: pointer to zcrypt_queue structure that identifies the
963 * CEXxC device to the request distributor
964 * @mex: pointer to the modexpo request buffer
966 static long zcrypt_msgtype6_modexpo(struct zcrypt_queue *zq,
967 struct ica_rsa_modexpo *mex,
968 struct ap_message *ap_msg)
970 struct response_type resp_type = {
971 .type = CEXXC_RESPONSE_TYPE_ICA,
975 ap_msg->msg = (void *)get_zeroed_page(GFP_KERNEL);
978 ap_msg->bufsize = PAGE_SIZE;
979 ap_msg->receive = zcrypt_msgtype6_receive;
980 ap_msg->psmid = (((unsigned long)current->pid) << 32) +
981 atomic_inc_return(&zcrypt_step);
982 ap_msg->private = &resp_type;
983 rc = icamex_msg_to_type6mex_msgx(zq, ap_msg, mex);
986 init_completion(&resp_type.work);
987 rc = ap_queue_message(zq->queue, ap_msg);
990 rc = wait_for_completion_interruptible(&resp_type.work);
994 rc = convert_response_ica(zq, ap_msg,
996 mex->outputdatalength);
998 /* Signal pending. */
999 ap_cancel_message(zq->queue, ap_msg);
1003 free_page((unsigned long)ap_msg->msg);
1004 ap_msg->private = NULL;
1010 * The request distributor calls this function if it picked the CEXxC
1011 * device to handle a modexpo_crt request.
1012 * @zq: pointer to zcrypt_queue structure that identifies the
1013 * CEXxC device to the request distributor
1014 * @crt: pointer to the modexpoc_crt request buffer
1016 static long zcrypt_msgtype6_modexpo_crt(struct zcrypt_queue *zq,
1017 struct ica_rsa_modexpo_crt *crt,
1018 struct ap_message *ap_msg)
1020 struct response_type resp_type = {
1021 .type = CEXXC_RESPONSE_TYPE_ICA,
1025 ap_msg->msg = (void *)get_zeroed_page(GFP_KERNEL);
1028 ap_msg->bufsize = PAGE_SIZE;
1029 ap_msg->receive = zcrypt_msgtype6_receive;
1030 ap_msg->psmid = (((unsigned long)current->pid) << 32) +
1031 atomic_inc_return(&zcrypt_step);
1032 ap_msg->private = &resp_type;
1033 rc = icacrt_msg_to_type6crt_msgx(zq, ap_msg, crt);
1036 init_completion(&resp_type.work);
1037 rc = ap_queue_message(zq->queue, ap_msg);
1040 rc = wait_for_completion_interruptible(&resp_type.work);
1044 rc = convert_response_ica(zq, ap_msg,
1046 crt->outputdatalength);
1048 /* Signal pending. */
1049 ap_cancel_message(zq->queue, ap_msg);
1053 free_page((unsigned long)ap_msg->msg);
1054 ap_msg->private = NULL;
1060 * Prepare a CCA AP msg request.
1061 * Prepare a CCA AP msg: fetch the required data from userspace,
1062 * prepare the AP msg, fill some info into the ap_message struct,
1063 * extract some data from the CPRB and give back to the caller.
1064 * This function allocates memory and needs an ap_msg prepared
1065 * by the caller with ap_init_message(). Also the caller has to
1066 * make sure ap_release_message() is always called even on failure.
1068 int prep_cca_ap_msg(bool userspace, struct ica_xcRB *xcrb,
1069 struct ap_message *ap_msg,
1070 unsigned int *func_code, unsigned short **dom)
1072 struct response_type resp_type = {
1073 .type = CEXXC_RESPONSE_TYPE_XCRB,
1076 ap_msg->bufsize = atomic_read(&ap_max_msg_size);
1077 ap_msg->msg = kmalloc(ap_msg->bufsize, GFP_KERNEL);
1080 ap_msg->receive = zcrypt_msgtype6_receive;
1081 ap_msg->psmid = (((unsigned long)current->pid) << 32) +
1082 atomic_inc_return(&zcrypt_step);
1083 ap_msg->private = kmemdup(&resp_type, sizeof(resp_type), GFP_KERNEL);
1084 if (!ap_msg->private)
1086 return xcrb_msg_to_type6cprb_msgx(userspace, ap_msg, xcrb, func_code, dom);
1090 * The request distributor calls this function if it picked the CEXxC
1091 * device to handle a send_cprb request.
1092 * @zq: pointer to zcrypt_queue structure that identifies the
1093 * CEXxC device to the request distributor
1094 * @xcrb: pointer to the send_cprb request buffer
1096 static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq,
1097 struct ica_xcRB *xcrb,
1098 struct ap_message *ap_msg)
1100 struct response_type *rtype = ap_msg->private;
1102 struct type6_hdr hdr;
1104 /* ... more data blocks ... */
1105 } __packed * msg = ap_msg->msg;
1106 unsigned int max_payload_size;
1109 /* calculate maximum payload for this card and msg type */
1110 max_payload_size = zq->reply.bufsize - sizeof(struct type86_fmt2_msg);
1112 /* limit each of the two from fields to the maximum payload size */
1113 msg->hdr.fromcardlen1 = min(msg->hdr.fromcardlen1, max_payload_size);
1114 msg->hdr.fromcardlen2 = min(msg->hdr.fromcardlen2, max_payload_size);
1116 /* calculate delta if the sum of both exceeds max payload size */
1117 delta = msg->hdr.fromcardlen1 + msg->hdr.fromcardlen2
1121 * Sum exceeds maximum payload size, prune fromcardlen1
1122 * (always trust fromcardlen2)
1124 if (delta > msg->hdr.fromcardlen1) {
1128 msg->hdr.fromcardlen1 -= delta;
1131 init_completion(&rtype->work);
1132 rc = ap_queue_message(zq->queue, ap_msg);
1135 rc = wait_for_completion_interruptible(&rtype->work);
1139 rc = convert_response_xcrb(userspace, zq, ap_msg, xcrb);
1141 /* Signal pending. */
1142 ap_cancel_message(zq->queue, ap_msg);
1145 if (rc == -EAGAIN && ap_msg->flags & AP_MSG_FLAG_ADMIN)
1146 rc = -EIO; /* do not retry administrative requests */
1150 pr_debug("send cprb at dev=%02x.%04x rc=%d\n",
1151 AP_QID_CARD(zq->queue->qid),
1152 AP_QID_QUEUE(zq->queue->qid), rc);
1157 * Prepare an EP11 AP msg request.
1158 * Prepare an EP11 AP msg: fetch the required data from userspace,
1159 * prepare the AP msg, fill some info into the ap_message struct,
1160 * extract some data from the CPRB and give back to the caller.
1161 * This function allocates memory and needs an ap_msg prepared
1162 * by the caller with ap_init_message(). Also the caller has to
1163 * make sure ap_release_message() is always called even on failure.
1165 int prep_ep11_ap_msg(bool userspace, struct ep11_urb *xcrb,
1166 struct ap_message *ap_msg,
1167 unsigned int *func_code, unsigned int *domain)
1169 struct response_type resp_type = {
1170 .type = CEXXC_RESPONSE_TYPE_EP11,
1173 ap_msg->bufsize = atomic_read(&ap_max_msg_size);
1174 ap_msg->msg = kmalloc(ap_msg->bufsize, GFP_KERNEL);
1177 ap_msg->receive = zcrypt_msgtype6_receive_ep11;
1178 ap_msg->psmid = (((unsigned long)current->pid) << 32) +
1179 atomic_inc_return(&zcrypt_step);
1180 ap_msg->private = kmemdup(&resp_type, sizeof(resp_type), GFP_KERNEL);
1181 if (!ap_msg->private)
1183 return xcrb_msg_to_type6_ep11cprb_msgx(userspace, ap_msg, xcrb,
1188 * The request distributor calls this function if it picked the CEX4P
1189 * device to handle a send_ep11_cprb request.
1190 * @zq: pointer to zcrypt_queue structure that identifies the
1191 * CEX4P device to the request distributor
1192 * @xcrb: pointer to the ep11 user request block
1194 static long zcrypt_msgtype6_send_ep11_cprb(bool userspace, struct zcrypt_queue *zq,
1195 struct ep11_urb *xcrb,
1196 struct ap_message *ap_msg)
1200 struct response_type *rtype = ap_msg->private;
1202 struct type6_hdr hdr;
1203 struct ep11_cprb cprbx;
1204 unsigned char pld_tag; /* fixed value 0x30 */
1205 unsigned char pld_lenfmt; /* payload length format */
1206 } __packed * msg = ap_msg->msg;
1208 unsigned char func_tag; /* fixed value 0x4 */
1209 unsigned char func_len; /* fixed value 0x4 */
1210 unsigned int func_val; /* function ID */
1211 unsigned char dom_tag; /* fixed value 0x4 */
1212 unsigned char dom_len; /* fixed value 0x4 */
1213 unsigned int dom_val; /* domain id */
1214 } __packed * payload_hdr = NULL;
1217 * The target domain field within the cprb body/payload block will be
1218 * replaced by the usage domain for non-management commands only.
1219 * Therefore we check the first bit of the 'flags' parameter for
1220 * management command indication.
1221 * 0 - non management command
1222 * 1 - management command
1224 if (!((msg->cprbx.flags & 0x80) == 0x80)) {
1225 msg->cprbx.target_id = (unsigned int)
1226 AP_QID_QUEUE(zq->queue->qid);
1228 if ((msg->pld_lenfmt & 0x80) == 0x80) { /*ext.len.fmt 2 or 3*/
1229 switch (msg->pld_lenfmt & 0x03) {
1240 lfmt = 1; /* length format #1 */
1242 payload_hdr = (struct pld_hdr *)((&msg->pld_lenfmt) + lfmt);
1243 payload_hdr->dom_val = (unsigned int)
1244 AP_QID_QUEUE(zq->queue->qid);
1248 * Set the queue's reply buffer length minus the two prepend headers
1249 * as reply limit for the card firmware.
1251 msg->hdr.fromcardlen1 = zq->reply.bufsize -
1252 sizeof(struct type86_hdr) - sizeof(struct type86_fmt2_ext);
1254 init_completion(&rtype->work);
1255 rc = ap_queue_message(zq->queue, ap_msg);
1258 rc = wait_for_completion_interruptible(&rtype->work);
1262 rc = convert_response_ep11_xcrb(userspace, zq, ap_msg, xcrb);
1264 /* Signal pending. */
1265 ap_cancel_message(zq->queue, ap_msg);
1268 if (rc == -EAGAIN && ap_msg->flags & AP_MSG_FLAG_ADMIN)
1269 rc = -EIO; /* do not retry administrative requests */
1273 pr_debug("send cprb at dev=%02x.%04x rc=%d\n",
1274 AP_QID_CARD(zq->queue->qid),
1275 AP_QID_QUEUE(zq->queue->qid), rc);
1279 int prep_rng_ap_msg(struct ap_message *ap_msg, int *func_code,
1280 unsigned int *domain)
1282 struct response_type resp_type = {
1283 .type = CEXXC_RESPONSE_TYPE_XCRB,
1286 ap_msg->bufsize = AP_DEFAULT_MAX_MSG_SIZE;
1287 ap_msg->msg = kmalloc(ap_msg->bufsize, GFP_KERNEL);
1290 ap_msg->receive = zcrypt_msgtype6_receive;
1291 ap_msg->psmid = (((unsigned long)current->pid) << 32) +
1292 atomic_inc_return(&zcrypt_step);
1293 ap_msg->private = kmemdup(&resp_type, sizeof(resp_type), GFP_KERNEL);
1294 if (!ap_msg->private)
1297 rng_type6cprb_msgx(ap_msg, ZCRYPT_RNG_BUFFER_SIZE, domain);
1304 * The request distributor calls this function if it picked the CEXxC
1305 * device to generate random data.
1306 * @zq: pointer to zcrypt_queue structure that identifies the
1307 * CEXxC device to the request distributor
1308 * @buffer: pointer to a memory page to return random data
1310 static long zcrypt_msgtype6_rng(struct zcrypt_queue *zq,
1311 char *buffer, struct ap_message *ap_msg)
1314 struct type6_hdr hdr;
1316 char function_code[2];
1317 short int rule_length;
1319 short int verb_length;
1320 short int key_length;
1321 } __packed * msg = ap_msg->msg;
1322 struct response_type *rtype = ap_msg->private;
1325 msg->cprbx.domain = AP_QID_QUEUE(zq->queue->qid);
1327 init_completion(&rtype->work);
1328 rc = ap_queue_message(zq->queue, ap_msg);
1331 rc = wait_for_completion_interruptible(&rtype->work);
1335 rc = convert_response_rng(zq, ap_msg, buffer);
1337 /* Signal pending. */
1338 ap_cancel_message(zq->queue, ap_msg);
1345 * The crypto operations for a CEXxC card.
1348 static struct zcrypt_ops zcrypt_msgtype6_ops = {
1349 .owner = THIS_MODULE,
1350 .name = MSGTYPE06_NAME,
1351 .variant = MSGTYPE06_VARIANT_DEFAULT,
1352 .rsa_modexpo = zcrypt_msgtype6_modexpo,
1353 .rsa_modexpo_crt = zcrypt_msgtype6_modexpo_crt,
1354 .send_cprb = zcrypt_msgtype6_send_cprb,
1355 .rng = zcrypt_msgtype6_rng,
1358 static struct zcrypt_ops zcrypt_msgtype6_ep11_ops = {
1359 .owner = THIS_MODULE,
1360 .name = MSGTYPE06_NAME,
1361 .variant = MSGTYPE06_VARIANT_EP11,
1362 .rsa_modexpo = NULL,
1363 .rsa_modexpo_crt = NULL,
1364 .send_ep11_cprb = zcrypt_msgtype6_send_ep11_cprb,
1367 void __init zcrypt_msgtype6_init(void)
1369 zcrypt_msgtype_register(&zcrypt_msgtype6_ops);
1370 zcrypt_msgtype_register(&zcrypt_msgtype6_ep11_ops);
1373 void __exit zcrypt_msgtype6_exit(void)
1375 zcrypt_msgtype_unregister(&zcrypt_msgtype6_ops);
1376 zcrypt_msgtype_unregister(&zcrypt_msgtype6_ep11_ops);