1 /*
2  *  zcrypt 2.1.0
3  *
4  *  Copyright IBM Corp. 2001, 2006
5  *  Author(s): Robert Burroughs
6  *	       Eric Rossman (edrossma@us.ibm.com)
7  *
8  *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
9  *  Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2, or (at your option)
14  * any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25 
26 #ifndef _ZCRYPT_ERROR_H_
27 #define _ZCRYPT_ERROR_H_
28 
29 #include <linux/atomic.h>
30 #include "zcrypt_debug.h"
31 #include "zcrypt_api.h"
32 
33 /**
34  * Reply Messages
35  *
36  * Error reply messages are of two types:
37  *    82:  Error (see below)
38  *    88:  Error (see below)
39  * Both type 82 and type 88 have the same structure in the header.
40  *
41  * Request reply messages are of three known types:
42  *    80:  Reply from a Type 50 Request (see CEX2A-RELATED STRUCTS)
43  *    84:  Reply from a Type 4 Request (see PCICA-RELATED STRUCTS)
44  *    86:  Reply from a Type 6 Request (see PCICC/PCIXCC/CEX2C-RELATED STRUCTS)
45  *
46  */
47 struct error_hdr {
48 	unsigned char reserved1;	/* 0x00			*/
49 	unsigned char type;		/* 0x82 or 0x88		*/
50 	unsigned char reserved2[2];	/* 0x0000		*/
51 	unsigned char reply_code;	/* reply code		*/
52 	unsigned char reserved3[3];	/* 0x000000		*/
53 };
54 
55 #define TYPE82_RSP_CODE 0x82
56 #define TYPE88_RSP_CODE 0x88
57 
58 #define REP82_ERROR_MACHINE_FAILURE	    0x10
59 #define REP82_ERROR_PREEMPT_FAILURE	    0x12
60 #define REP82_ERROR_CHECKPT_FAILURE	    0x14
61 #define REP82_ERROR_MESSAGE_TYPE	    0x20
62 #define REP82_ERROR_INVALID_COMM_CD	    0x21 /* Type 84	*/
63 #define REP82_ERROR_INVALID_MSG_LEN	    0x23
64 #define REP82_ERROR_RESERVD_FIELD	    0x24 /* was 0x50	*/
65 #define REP82_ERROR_FORMAT_FIELD	    0x29
66 #define REP82_ERROR_INVALID_COMMAND	    0x30
67 #define REP82_ERROR_MALFORMED_MSG	    0x40
68 #define REP82_ERROR_INVALID_DOMAIN_PRECHECK 0x42
69 #define REP82_ERROR_RESERVED_FIELDO	    0x50 /* old value	*/
70 #define REP82_ERROR_WORD_ALIGNMENT	    0x60
71 #define REP82_ERROR_MESSAGE_LENGTH	    0x80
72 #define REP82_ERROR_OPERAND_INVALID	    0x82
73 #define REP82_ERROR_OPERAND_SIZE	    0x84
74 #define REP82_ERROR_EVEN_MOD_IN_OPND	    0x85
75 #define REP82_ERROR_RESERVED_FIELD	    0x88
76 #define REP82_ERROR_INVALID_DOMAIN_PENDING  0x8A
77 #define REP82_ERROR_TRANSPORT_FAIL	    0x90
78 #define REP82_ERROR_PACKET_TRUNCATED	    0xA0
79 #define REP82_ERROR_ZERO_BUFFER_LEN	    0xB0
80 
81 #define REP88_ERROR_MODULE_FAILURE	    0x10
82 
83 #define REP88_ERROR_MESSAGE_TYPE	    0x20
84 #define REP88_ERROR_MESSAGE_MALFORMD	    0x22
85 #define REP88_ERROR_MESSAGE_LENGTH	    0x23
86 #define REP88_ERROR_RESERVED_FIELD	    0x24
87 #define REP88_ERROR_KEY_TYPE		    0x34
88 #define REP88_ERROR_INVALID_KEY	    0x82 /* CEX2A	*/
89 #define REP88_ERROR_OPERAND		    0x84 /* CEX2A	*/
90 #define REP88_ERROR_OPERAND_EVEN_MOD	    0x85 /* CEX2A	*/
91 
92 static inline int convert_error(struct zcrypt_queue *zq,
93 				struct ap_message *reply)
94 {
95 	struct error_hdr *ehdr = reply->message;
96 	int card = AP_QID_CARD(zq->queue->qid);
97 	int queue = AP_QID_QUEUE(zq->queue->qid);
98 
99 	switch (ehdr->reply_code) {
100 	case REP82_ERROR_OPERAND_INVALID:
101 	case REP82_ERROR_OPERAND_SIZE:
102 	case REP82_ERROR_EVEN_MOD_IN_OPND:
103 	case REP88_ERROR_MESSAGE_MALFORMD:
104 	case REP82_ERROR_INVALID_DOMAIN_PRECHECK:
105 	case REP82_ERROR_INVALID_DOMAIN_PENDING:
106 	//   REP88_ERROR_INVALID_KEY		// '82' CEX2A
107 	//   REP88_ERROR_OPERAND		// '84' CEX2A
108 	//   REP88_ERROR_OPERAND_EVEN_MOD	// '85' CEX2A
109 		/* Invalid input data. */
110 		ZCRYPT_DBF(DBF_WARN,
111 			   "device=%02x.%04x reply=0x%02x => rc=EINVAL\n",
112 			   card, queue, ehdr->reply_code);
113 		return -EINVAL;
114 	case REP82_ERROR_MESSAGE_TYPE:
115 	//   REP88_ERROR_MESSAGE_TYPE		// '20' CEX2A
116 		/*
117 		 * To sent a message of the wrong type is a bug in the
118 		 * device driver. Send error msg, disable the device
119 		 * and then repeat the request.
120 		 */
121 		atomic_set(&zcrypt_rescan_req, 1);
122 		zq->online = 0;
123 		pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
124 		       card, queue);
125 		ZCRYPT_DBF(DBF_ERR,
126 			   "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
127 			   card, queue, ehdr->reply_code);
128 		return -EAGAIN;
129 	case REP82_ERROR_TRANSPORT_FAIL:
130 	case REP82_ERROR_MACHINE_FAILURE:
131 	//   REP88_ERROR_MODULE_FAILURE		// '10' CEX2A
132 		/* If a card fails disable it and repeat the request. */
133 		atomic_set(&zcrypt_rescan_req, 1);
134 		zq->online = 0;
135 		pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
136 		       card, queue);
137 		ZCRYPT_DBF(DBF_ERR,
138 			   "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
139 			   card, queue, ehdr->reply_code);
140 		return -EAGAIN;
141 	default:
142 		zq->online = 0;
143 		pr_err("Cryptographic device %02x.%04x failed and was set offline\n",
144 		       card, queue);
145 		ZCRYPT_DBF(DBF_ERR,
146 			   "device=%02x.%04x reply=0x%02x => online=0 rc=EAGAIN\n",
147 			   card, queue, ehdr->reply_code);
148 		return -EAGAIN;	/* repeat the request on a different device. */
149 	}
150 }
151 
152 #endif /* _ZCRYPT_ERROR_H_ */
153