2 * linux/drivers/s390/crypto/zcrypt_error.h
6 * Copyright (C) 2001, 2006 IBM Corporation
7 * Author(s): Robert Burroughs
8 * Eric Rossman (edrossma@us.ibm.com)
10 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
11 * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2, or (at your option)
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #ifndef _ZCRYPT_ERROR_H_
29 #define _ZCRYPT_ERROR_H_
31 #include "zcrypt_api.h"
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.
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)
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 */
55 #define TYPE82_RSP_CODE 0x82
56 #define TYPE88_RSP_CODE 0x88
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_RESERVED_FIELDO 0x50 /* old value */
69 #define REP82_ERROR_WORD_ALIGNMENT 0x60
70 #define REP82_ERROR_MESSAGE_LENGTH 0x80
71 #define REP82_ERROR_OPERAND_INVALID 0x82
72 #define REP82_ERROR_OPERAND_SIZE 0x84
73 #define REP82_ERROR_EVEN_MOD_IN_OPND 0x85
74 #define REP82_ERROR_RESERVED_FIELD 0x88
75 #define REP82_ERROR_TRANSPORT_FAIL 0x90
76 #define REP82_ERROR_PACKET_TRUNCATED 0xA0
77 #define REP82_ERROR_ZERO_BUFFER_LEN 0xB0
79 #define REP88_ERROR_MODULE_FAILURE 0x10
81 #define REP88_ERROR_MESSAGE_TYPE 0x20
82 #define REP88_ERROR_MESSAGE_MALFORMD 0x22
83 #define REP88_ERROR_MESSAGE_LENGTH 0x23
84 #define REP88_ERROR_RESERVED_FIELD 0x24
85 #define REP88_ERROR_KEY_TYPE 0x34
86 #define REP88_ERROR_INVALID_KEY 0x82 /* CEX2A */
87 #define REP88_ERROR_OPERAND 0x84 /* CEX2A */
88 #define REP88_ERROR_OPERAND_EVEN_MOD 0x85 /* CEX2A */
90 static inline int convert_error(struct zcrypt_device *zdev,
91 struct ap_message *reply)
93 struct error_hdr *ehdr = reply->message;
95 PRINTK("Hardware error : Type %02x Message Header: %08x%08x\n",
96 ehdr->type, *(unsigned int *) reply->message,
97 *(unsigned int *) (reply->message + 4));
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 // REP88_ERROR_INVALID_KEY // '82' CEX2A
105 // REP88_ERROR_OPERAND // '84' CEX2A
106 // REP88_ERROR_OPERAND_EVEN_MOD // '85' CEX2A
107 /* Invalid input data. */
109 case REP82_ERROR_MESSAGE_TYPE:
110 // REP88_ERROR_MESSAGE_TYPE // '20' CEX2A
112 * To sent a message of the wrong type is a bug in the
113 * device driver. Warn about it, disable the device
114 * and then repeat the request.
119 case REP82_ERROR_TRANSPORT_FAIL:
120 case REP82_ERROR_MACHINE_FAILURE:
121 // REP88_ERROR_MODULE_FAILURE // '10' CEX2A
122 /* If a card fails disable it and repeat the request. */
126 PRINTKW("unknown type %02x reply code = %d\n",
127 ehdr->type, ehdr->reply_code);
129 return -EAGAIN; /* repeat the request on a different device. */
133 #endif /* _ZCRYPT_ERROR_H_ */