zcrypt_error.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright IBM Corp. 2001, 2006
  4. * Author(s): Robert Burroughs
  5. * Eric Rossman (edrossma@us.ibm.com)
  6. *
  7. * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
  8. * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
  9. */
  10. #ifndef _ZCRYPT_ERROR_H_
  11. #define _ZCRYPT_ERROR_H_
  12. #include <linux/atomic.h>
  13. #include "zcrypt_debug.h"
  14. #include "zcrypt_api.h"
  15. #include "zcrypt_msgtype6.h"
  16. /**
  17. * Reply Messages
  18. *
  19. * Error reply messages are of two types:
  20. * 82: Error (see below)
  21. * 88: Error (see below)
  22. * Both type 82 and type 88 have the same structure in the header.
  23. *
  24. * Request reply messages are of three known types:
  25. * 80: Reply from a Type 50 Request (see CEX2A-RELATED STRUCTS)
  26. * 84: Reply from a Type 4 Request (see PCICA-RELATED STRUCTS)
  27. * 86: Reply from a Type 6 Request (see PCICC/PCIXCC/CEX2C-RELATED STRUCTS)
  28. *
  29. */
  30. struct error_hdr {
  31. unsigned char reserved1; /* 0x00 */
  32. unsigned char type; /* 0x82 or 0x88 */
  33. unsigned char reserved2[2]; /* 0x0000 */
  34. unsigned char reply_code; /* reply code */
  35. unsigned char reserved3[3]; /* 0x000000 */
  36. };
  37. #define TYPE82_RSP_CODE 0x82
  38. #define TYPE88_RSP_CODE 0x88
  39. #define REP82_ERROR_MACHINE_FAILURE 0x10
  40. #define REP82_ERROR_PREEMPT_FAILURE 0x12
  41. #define REP82_ERROR_CHECKPT_FAILURE 0x14
  42. #define REP82_ERROR_MESSAGE_TYPE 0x20
  43. #define REP82_ERROR_INVALID_COMM_CD 0x21 /* Type 84 */
  44. #define REP82_ERROR_INVALID_MSG_LEN 0x23
  45. #define REP82_ERROR_RESERVD_FIELD 0x24 /* was 0x50 */
  46. #define REP82_ERROR_FORMAT_FIELD 0x29
  47. #define REP82_ERROR_INVALID_COMMAND 0x30
  48. #define REP82_ERROR_MALFORMED_MSG 0x40
  49. #define REP82_ERROR_INVALID_SPECIAL_CMD 0x41
  50. #define REP82_ERROR_RESERVED_FIELDO 0x50 /* old value */
  51. #define REP82_ERROR_WORD_ALIGNMENT 0x60
  52. #define REP82_ERROR_MESSAGE_LENGTH 0x80
  53. #define REP82_ERROR_OPERAND_INVALID 0x82
  54. #define REP82_ERROR_OPERAND_SIZE 0x84
  55. #define REP82_ERROR_EVEN_MOD_IN_OPND 0x85
  56. #define REP82_ERROR_RESERVED_FIELD 0x88
  57. #define REP82_ERROR_INVALID_DOMAIN_PENDING 0x8A
  58. #define REP82_ERROR_FILTERED_BY_HYPERVISOR 0x8B
  59. #define REP82_ERROR_TRANSPORT_FAIL 0x90
  60. #define REP82_ERROR_PACKET_TRUNCATED 0xA0
  61. #define REP82_ERROR_ZERO_BUFFER_LEN 0xB0
  62. #define REP88_ERROR_MODULE_FAILURE 0x10
  63. #define REP88_ERROR_MESSAGE_TYPE 0x20
  64. #define REP88_ERROR_MESSAGE_MALFORMD 0x22
  65. #define REP88_ERROR_MESSAGE_LENGTH 0x23
  66. #define REP88_ERROR_RESERVED_FIELD 0x24
  67. #define REP88_ERROR_KEY_TYPE 0x34
  68. #define REP88_ERROR_INVALID_KEY 0x82 /* CEX2A */
  69. #define REP88_ERROR_OPERAND 0x84 /* CEX2A */
  70. #define REP88_ERROR_OPERAND_EVEN_MOD 0x85 /* CEX2A */
  71. static inline int convert_error(struct zcrypt_queue *zq,
  72. struct ap_message *reply)
  73. {
  74. struct error_hdr *ehdr = reply->msg;
  75. int card = AP_QID_CARD(zq->queue->qid);
  76. int queue = AP_QID_QUEUE(zq->queue->qid);
  77. switch (ehdr->reply_code) {
  78. case REP82_ERROR_INVALID_MSG_LEN: /* 0x23 */
  79. case REP82_ERROR_RESERVD_FIELD: /* 0x24 */
  80. case REP82_ERROR_FORMAT_FIELD: /* 0x29 */
  81. case REP82_ERROR_MALFORMED_MSG: /* 0x40 */
  82. case REP82_ERROR_INVALID_SPECIAL_CMD: /* 0x41 */
  83. case REP82_ERROR_MESSAGE_LENGTH: /* 0x80 */
  84. case REP82_ERROR_OPERAND_INVALID: /* 0x82 */
  85. case REP82_ERROR_OPERAND_SIZE: /* 0x84 */
  86. case REP82_ERROR_EVEN_MOD_IN_OPND: /* 0x85 */
  87. case REP82_ERROR_INVALID_DOMAIN_PENDING: /* 0x8A */
  88. case REP82_ERROR_FILTERED_BY_HYPERVISOR: /* 0x8B */
  89. case REP82_ERROR_PACKET_TRUNCATED: /* 0xA0 */
  90. case REP88_ERROR_MESSAGE_MALFORMD: /* 0x22 */
  91. case REP88_ERROR_KEY_TYPE: /* 0x34 */
  92. /* RY indicates malformed request */
  93. ZCRYPT_DBF(DBF_WARN,
  94. "dev=%02x.%04x RY=0x%02x => rc=EINVAL\n",
  95. card, queue, ehdr->reply_code);
  96. return -EINVAL;
  97. case REP82_ERROR_MACHINE_FAILURE: /* 0x10 */
  98. case REP82_ERROR_MESSAGE_TYPE: /* 0x20 */
  99. case REP82_ERROR_TRANSPORT_FAIL: /* 0x90 */
  100. /*
  101. * Msg to wrong type or card/infrastructure failure.
  102. * Trigger rescan of the ap bus, trigger retry request.
  103. */
  104. atomic_set(&zcrypt_rescan_req, 1);
  105. /* For type 86 response show the apfs value (failure reason) */
  106. if (ehdr->reply_code == REP82_ERROR_TRANSPORT_FAIL &&
  107. ehdr->type == TYPE86_RSP_CODE) {
  108. struct {
  109. struct type86_hdr hdr;
  110. struct type86_fmt2_ext fmt2;
  111. } __packed * head = reply->msg;
  112. unsigned int apfs = *((u32 *)head->fmt2.apfs);
  113. ZCRYPT_DBF(DBF_WARN,
  114. "dev=%02x.%04x RY=0x%02x apfs=0x%x => bus rescan, rc=EAGAIN\n",
  115. card, queue, ehdr->reply_code, apfs);
  116. } else
  117. ZCRYPT_DBF(DBF_WARN,
  118. "dev=%02x.%04x RY=0x%02x => bus rescan, rc=EAGAIN\n",
  119. card, queue, ehdr->reply_code);
  120. return -EAGAIN;
  121. default:
  122. /* Assume request is valid and a retry will be worth it */
  123. ZCRYPT_DBF(DBF_WARN,
  124. "dev=%02x.%04x RY=0x%02x => rc=EAGAIN\n",
  125. card, queue, ehdr->reply_code);
  126. return -EAGAIN;
  127. }
  128. }
  129. #endif /* _ZCRYPT_ERROR_H_ */