1963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky/* 2963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * linux/drivers/s390/crypto/zcrypt_error.h 3963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 45432114baf0300286a6ca1b0aea549492a379432Ralph Wuerthner * zcrypt 2.1.0 5963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 6963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Copyright (C) 2001, 2006 IBM Corporation 7963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Author(s): Robert Burroughs 8963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Eric Rossman (edrossma@us.ibm.com) 9963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 10963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com) 11963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com> 12963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 13963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * This program is free software; you can redistribute it and/or modify 14963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * it under the terms of the GNU General Public License as published by 15963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * the Free Software Foundation; either version 2, or (at your option) 16963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * any later version. 17963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 18963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * This program is distributed in the hope that it will be useful, 19963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * but WITHOUT ANY WARRANTY; without even the implied warranty of 20963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * GNU General Public License for more details. 22963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 23963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * You should have received a copy of the GNU General Public License 24963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * along with this program; if not, write to the Free Software 25963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 26963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky */ 27963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 28963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#ifndef _ZCRYPT_ERROR_H_ 29963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define _ZCRYPT_ERROR_H_ 30963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 31963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#include "zcrypt_api.h" 32963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 33963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky/** 34963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Reply Messages 35963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 36963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Error reply messages are of two types: 37963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 82: Error (see below) 38963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 88: Error (see below) 39963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Both type 82 and type 88 have the same structure in the header. 40963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 41963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * Request reply messages are of three known types: 42963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 80: Reply from a Type 50 Request (see CEX2A-RELATED STRUCTS) 43963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 84: Reply from a Type 4 Request (see PCICA-RELATED STRUCTS) 44963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 86: Reply from a Type 6 Request (see PCICC/PCIXCC/CEX2C-RELATED STRUCTS) 45963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * 46963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky */ 47963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefskystruct error_hdr { 48963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky unsigned char reserved1; /* 0x00 */ 49963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky unsigned char type; /* 0x82 or 0x88 */ 50963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky unsigned char reserved2[2]; /* 0x0000 */ 51963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky unsigned char reply_code; /* reply code */ 52963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky unsigned char reserved3[3]; /* 0x000000 */ 53963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky}; 54963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 55963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define TYPE82_RSP_CODE 0x82 56963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define TYPE88_RSP_CODE 0x88 57963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 58963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_MACHINE_FAILURE 0x10 59963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_PREEMPT_FAILURE 0x12 60963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_CHECKPT_FAILURE 0x14 61963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_MESSAGE_TYPE 0x20 62963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_INVALID_COMM_CD 0x21 /* Type 84 */ 63963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_INVALID_MSG_LEN 0x23 64963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_RESERVD_FIELD 0x24 /* was 0x50 */ 65963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_FORMAT_FIELD 0x29 66963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_INVALID_COMMAND 0x30 67963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_MALFORMED_MSG 0x40 68963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_RESERVED_FIELDO 0x50 /* old value */ 69963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_WORD_ALIGNMENT 0x60 70963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_MESSAGE_LENGTH 0x80 71963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_OPERAND_INVALID 0x82 72963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_OPERAND_SIZE 0x84 73963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_EVEN_MOD_IN_OPND 0x85 74963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_RESERVED_FIELD 0x88 75963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_TRANSPORT_FAIL 0x90 76963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_PACKET_TRUNCATED 0xA0 77963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP82_ERROR_ZERO_BUFFER_LEN 0xB0 78963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 79963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_MODULE_FAILURE 0x10 80963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 81963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_MESSAGE_TYPE 0x20 82963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_MESSAGE_MALFORMD 0x22 83963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_MESSAGE_LENGTH 0x23 84963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_RESERVED_FIELD 0x24 85963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_KEY_TYPE 0x34 86963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_INVALID_KEY 0x82 /* CEX2A */ 87963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_OPERAND 0x84 /* CEX2A */ 88963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#define REP88_ERROR_OPERAND_EVEN_MOD 0x85 /* CEX2A */ 89963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 90963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefskystatic inline int convert_error(struct zcrypt_device *zdev, 91963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky struct ap_message *reply) 92963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky{ 93963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky struct error_hdr *ehdr = reply->message; 94963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 95963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky switch (ehdr->reply_code) { 96963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_OPERAND_INVALID: 97963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_OPERAND_SIZE: 98963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_EVEN_MOD_IN_OPND: 99963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP88_ERROR_MESSAGE_MALFORMD: 100963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky // REP88_ERROR_INVALID_KEY // '82' CEX2A 101963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky // REP88_ERROR_OPERAND // '84' CEX2A 102963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky // REP88_ERROR_OPERAND_EVEN_MOD // '85' CEX2A 103963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky /* Invalid input data. */ 104963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky return -EINVAL; 105963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_MESSAGE_TYPE: 106963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky // REP88_ERROR_MESSAGE_TYPE // '20' CEX2A 1071749a81d629b1295b38071914728cc2e72066f4dFelix Beck /* 108963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * To sent a message of the wrong type is a bug in the 109963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * device driver. Warn about it, disable the device 110963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky * and then repeat the request. 111963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky */ 112963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky WARN_ON(1); 113963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky zdev->online = 0; 114963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky return -EAGAIN; 115963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_TRANSPORT_FAIL: 116963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky case REP82_ERROR_MACHINE_FAILURE: 117963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky // REP88_ERROR_MODULE_FAILURE // '10' CEX2A 118963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky /* If a card fails disable it and repeat the request. */ 119963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky zdev->online = 0; 120963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky return -EAGAIN; 121963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky default: 122963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky zdev->online = 0; 123963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky return -EAGAIN; /* repeat the request on a different device. */ 124963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky } 125963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky} 126963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky 127963ed931c3fd18082bfde0e8704a28955663abf4Martin Schwidefsky#endif /* _ZCRYPT_ERROR_H_ */ 128