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