xref: /linux/drivers/s390/crypto/zcrypt_error.h (revision 95e9fd10f06cb5642028b6b851e32b8c8afb4571)
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 "zcrypt_api.h"
30 
31 /**
32  * Reply Messages
33  *
34  * Error reply messages are of two types:
35  *    82:  Error (see below)
36  *    88:  Error (see below)
37  * Both type 82 and type 88 have the same structure in the header.
38  *
39  * Request reply messages are of three known types:
40  *    80:  Reply from a Type 50 Request (see CEX2A-RELATED STRUCTS)
41  *    84:  Reply from a Type 4 Request (see PCICA-RELATED STRUCTS)
42  *    86:  Reply from a Type 6 Request (see PCICC/PCIXCC/CEX2C-RELATED STRUCTS)
43  *
44  */
45 struct error_hdr {
46 	unsigned char reserved1;	/* 0x00			*/
47 	unsigned char type;		/* 0x82 or 0x88		*/
48 	unsigned char reserved2[2];	/* 0x0000		*/
49 	unsigned char reply_code;	/* reply code		*/
50 	unsigned char reserved3[3];	/* 0x000000		*/
51 };
52 
53 #define TYPE82_RSP_CODE 0x82
54 #define TYPE88_RSP_CODE 0x88
55 
56 #define REP82_ERROR_MACHINE_FAILURE  0x10
57 #define REP82_ERROR_PREEMPT_FAILURE  0x12
58 #define REP82_ERROR_CHECKPT_FAILURE  0x14
59 #define REP82_ERROR_MESSAGE_TYPE     0x20
60 #define REP82_ERROR_INVALID_COMM_CD  0x21	/* Type 84	*/
61 #define REP82_ERROR_INVALID_MSG_LEN  0x23
62 #define REP82_ERROR_RESERVD_FIELD    0x24	/* was 0x50	*/
63 #define REP82_ERROR_FORMAT_FIELD     0x29
64 #define REP82_ERROR_INVALID_COMMAND  0x30
65 #define REP82_ERROR_MALFORMED_MSG    0x40
66 #define REP82_ERROR_RESERVED_FIELDO  0x50	/* old value	*/
67 #define REP82_ERROR_WORD_ALIGNMENT   0x60
68 #define REP82_ERROR_MESSAGE_LENGTH   0x80
69 #define REP82_ERROR_OPERAND_INVALID  0x82
70 #define REP82_ERROR_OPERAND_SIZE     0x84
71 #define REP82_ERROR_EVEN_MOD_IN_OPND 0x85
72 #define REP82_ERROR_RESERVED_FIELD   0x88
73 #define REP82_ERROR_TRANSPORT_FAIL   0x90
74 #define REP82_ERROR_PACKET_TRUNCATED 0xA0
75 #define REP82_ERROR_ZERO_BUFFER_LEN  0xB0
76 
77 #define REP88_ERROR_MODULE_FAILURE   0x10
78 
79 #define REP88_ERROR_MESSAGE_TYPE     0x20
80 #define REP88_ERROR_MESSAGE_MALFORMD 0x22
81 #define REP88_ERROR_MESSAGE_LENGTH   0x23
82 #define REP88_ERROR_RESERVED_FIELD   0x24
83 #define REP88_ERROR_KEY_TYPE	     0x34
84 #define REP88_ERROR_INVALID_KEY      0x82	/* CEX2A	*/
85 #define REP88_ERROR_OPERAND	     0x84	/* CEX2A	*/
86 #define REP88_ERROR_OPERAND_EVEN_MOD 0x85	/* CEX2A	*/
87 
88 static inline int convert_error(struct zcrypt_device *zdev,
89 				struct ap_message *reply)
90 {
91 	struct error_hdr *ehdr = reply->message;
92 
93 	switch (ehdr->reply_code) {
94 	case REP82_ERROR_OPERAND_INVALID:
95 	case REP82_ERROR_OPERAND_SIZE:
96 	case REP82_ERROR_EVEN_MOD_IN_OPND:
97 	case REP88_ERROR_MESSAGE_MALFORMD:
98 	//   REP88_ERROR_INVALID_KEY		// '82' CEX2A
99 	//   REP88_ERROR_OPERAND		// '84' CEX2A
100 	//   REP88_ERROR_OPERAND_EVEN_MOD	// '85' CEX2A
101 		/* Invalid input data. */
102 		return -EINVAL;
103 	case REP82_ERROR_MESSAGE_TYPE:
104 	//   REP88_ERROR_MESSAGE_TYPE		// '20' CEX2A
105 		/*
106 		 * To sent a message of the wrong type is a bug in the
107 		 * device driver. Warn about it, disable the device
108 		 * and then repeat the request.
109 		 */
110 		WARN_ON(1);
111 		zdev->online = 0;
112 		return -EAGAIN;
113 	case REP82_ERROR_TRANSPORT_FAIL:
114 	case REP82_ERROR_MACHINE_FAILURE:
115 	//   REP88_ERROR_MODULE_FAILURE		// '10' CEX2A
116 		/* If a card fails disable it and repeat the request. */
117 		zdev->online = 0;
118 		return -EAGAIN;
119 	default:
120 		zdev->online = 0;
121 		return -EAGAIN;	/* repeat the request on a different device. */
122 	}
123 }
124 
125 #endif /* _ZCRYPT_ERROR_H_ */
126