1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright IBM Corp. 2001, 2006
4 * Author(s): Robert Burroughs
5 * Eric Rossman (edrossma@us.ibm.com)
7 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
8 * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
11 #ifndef _ZCRYPT_ERROR_H_
12 #define _ZCRYPT_ERROR_H_
14 #include <linux/atomic.h>
15 #include "zcrypt_debug.h"
16 #include "zcrypt_api.h"
17 #include "zcrypt_msgtype6.h"
22 * Error reply messages are of two types:
23 * 82: Error (see below)
24 * 88: Error (see below)
25 * Both type 82 and type 88 have the same structure in the header.
27 * Request reply messages are of three known types:
28 * 80: Reply from a Type 50 Request (see CEX2A-RELATED STRUCTS)
29 * 84: Reply from a Type 4 Request (see PCICA-RELATED STRUCTS)
30 * 86: Reply from a Type 6 Request (see PCICC/PCIXCC/CEX2C-RELATED STRUCTS)
34 unsigned char reserved1; /* 0x00 */
35 unsigned char type; /* 0x82 or 0x88 */
36 unsigned char reserved2[2]; /* 0x0000 */
37 unsigned char reply_code; /* reply code */
38 unsigned char reserved3[3]; /* 0x000000 */
41 #define TYPE82_RSP_CODE 0x82
42 #define TYPE88_RSP_CODE 0x88
44 #define REP82_ERROR_MACHINE_FAILURE 0x10
45 #define REP82_ERROR_PREEMPT_FAILURE 0x12
46 #define REP82_ERROR_CHECKPT_FAILURE 0x14
47 #define REP82_ERROR_MESSAGE_TYPE 0x20
48 #define REP82_ERROR_INVALID_COMM_CD 0x21 /* Type 84 */
49 #define REP82_ERROR_INVALID_MSG_LEN 0x23
50 #define REP82_ERROR_RESERVD_FIELD 0x24 /* was 0x50 */
51 #define REP82_ERROR_FORMAT_FIELD 0x29
52 #define REP82_ERROR_INVALID_COMMAND 0x30
53 #define REP82_ERROR_MALFORMED_MSG 0x40
54 #define REP82_ERROR_INVALID_SPECIAL_CMD 0x41
55 #define REP82_ERROR_INVALID_DOMAIN_PRECHECK 0x42
56 #define REP82_ERROR_RESERVED_FIELDO 0x50 /* old value */
57 #define REP82_ERROR_WORD_ALIGNMENT 0x60
58 #define REP82_ERROR_MESSAGE_LENGTH 0x80
59 #define REP82_ERROR_OPERAND_INVALID 0x82
60 #define REP82_ERROR_OPERAND_SIZE 0x84
61 #define REP82_ERROR_EVEN_MOD_IN_OPND 0x85
62 #define REP82_ERROR_RESERVED_FIELD 0x88
63 #define REP82_ERROR_INVALID_DOMAIN_PENDING 0x8A
64 #define REP82_ERROR_FILTERED_BY_HYPERVISOR 0x8B
65 #define REP82_ERROR_TRANSPORT_FAIL 0x90
66 #define REP82_ERROR_PACKET_TRUNCATED 0xA0
67 #define REP82_ERROR_ZERO_BUFFER_LEN 0xB0
69 #define REP88_ERROR_MODULE_FAILURE 0x10
71 #define REP88_ERROR_MESSAGE_TYPE 0x20
72 #define REP88_ERROR_MESSAGE_MALFORMD 0x22
73 #define REP88_ERROR_MESSAGE_LENGTH 0x23
74 #define REP88_ERROR_RESERVED_FIELD 0x24
75 #define REP88_ERROR_KEY_TYPE 0x34
76 #define REP88_ERROR_INVALID_KEY 0x82 /* CEX2A */
77 #define REP88_ERROR_OPERAND 0x84 /* CEX2A */
78 #define REP88_ERROR_OPERAND_EVEN_MOD 0x85 /* CEX2A */
80 static inline int convert_error(struct zcrypt_queue *zq,
81 struct ap_message *reply)
83 struct error_hdr *ehdr = reply->message;
84 int card = AP_QID_CARD(zq->queue->qid);
85 int queue = AP_QID_QUEUE(zq->queue->qid);
87 switch (ehdr->reply_code) {
88 case REP82_ERROR_OPERAND_INVALID:
89 case REP82_ERROR_OPERAND_SIZE:
90 case REP82_ERROR_EVEN_MOD_IN_OPND:
91 case REP88_ERROR_MESSAGE_MALFORMD:
92 case REP82_ERROR_INVALID_DOMAIN_PRECHECK:
93 case REP82_ERROR_INVALID_DOMAIN_PENDING:
94 case REP82_ERROR_INVALID_SPECIAL_CMD:
95 case REP82_ERROR_FILTERED_BY_HYPERVISOR:
96 // REP88_ERROR_INVALID_KEY // '82' CEX2A
97 // REP88_ERROR_OPERAND // '84' CEX2A
98 // REP88_ERROR_OPERAND_EVEN_MOD // '85' CEX2A
99 /* Invalid input data. */
101 "device=%02x.%04x reply=0x%02x => rc=EINVAL\n",
102 card, queue, ehdr->reply_code);
104 case REP82_ERROR_MESSAGE_TYPE:
105 // REP88_ERROR_MESSAGE_TYPE // '20' CEX2A
107 * To sent a message of the wrong type is a bug in the
108 * device driver. Send error msg, disable the device
109 * and then repeat the request.
111 atomic_set(&zcrypt_rescan_req, 1);
113 pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
116 "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
117 card, queue, ehdr->reply_code);
119 case REP82_ERROR_TRANSPORT_FAIL:
120 /* Card or infrastructure failure, disable card */
121 atomic_set(&zcrypt_rescan_req, 1);
123 pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
125 /* For type 86 response show the apfs value (failure reason) */
126 if (ehdr->type == TYPE86_RSP_CODE) {
128 struct type86_hdr hdr;
129 struct type86_fmt2_ext fmt2;
130 } __packed * head = reply->message;
131 unsigned int apfs = *((u32 *)head->fmt2.apfs);
134 "device=%02x.%04x reply=0x%02x apfs=0x%x => online=0 rc=EAGAIN\n",
135 card, queue, apfs, ehdr->reply_code);
138 "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
139 card, queue, ehdr->reply_code);
141 case REP82_ERROR_MACHINE_FAILURE:
142 // REP88_ERROR_MODULE_FAILURE // '10' CEX2A
143 /* If a card fails disable it and repeat the request. */
144 atomic_set(&zcrypt_rescan_req, 1);
146 pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
149 "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
150 card, queue, ehdr->reply_code);
154 pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
157 "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
158 card, queue, ehdr->reply_code);
159 return -EAGAIN; /* repeat the request on a different device. */
163 #endif /* _ZCRYPT_ERROR_H_ */