1 /* 2 * linux/drivers/s390/crypto/zcrypt_api.h 3 * 4 * zcrypt 2.1.0 5 * 6 * Copyright (C) 2001, 2006 IBM Corporation 7 * Author(s): Robert Burroughs 8 * Eric Rossman (edrossma@us.ibm.com) 9 * Cornelia Huck <cornelia.huck@de.ibm.com> 10 * 11 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com) 12 * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com> 13 * Ralph Wuerthner <rwuerthn@de.ibm.com> 14 * 15 * This program is free software; you can redistribute it and/or modify 16 * it under the terms of the GNU General Public License as published by 17 * the Free Software Foundation; either version 2, or (at your option) 18 * any later version. 19 * 20 * This program is distributed in the hope that it will be useful, 21 * but WITHOUT ANY WARRANTY; without even the implied warranty of 22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 * GNU General Public License for more details. 24 * 25 * You should have received a copy of the GNU General Public License 26 * along with this program; if not, write to the Free Software 27 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 28 */ 29 30 #ifndef _ZCRYPT_API_H_ 31 #define _ZCRYPT_API_H_ 32 33 /** 34 * Macro definitions 35 * 36 * PDEBUG debugs in the form "zcrypt: function_name -> message" 37 * 38 * PRINTK is like PDEBUG, except that it is always enabled 39 * PRINTKN is like PRINTK, except that it does not include the function name 40 * PRINTKW is like PRINTK, except that it uses KERN_WARNING 41 * PRINTKC is like PRINTK, except that it uses KERN_CRIT 42 */ 43 #define DEV_NAME "zcrypt" 44 45 #define PRINTK(fmt, args...) \ 46 printk(KERN_DEBUG DEV_NAME ": %s -> " fmt, __FUNCTION__ , ## args) 47 #define PRINTKN(fmt, args...) \ 48 printk(KERN_DEBUG DEV_NAME ": " fmt, ## args) 49 #define PRINTKW(fmt, args...) \ 50 printk(KERN_WARNING DEV_NAME ": %s -> " fmt, __FUNCTION__ , ## args) 51 #define PRINTKC(fmt, args...) \ 52 printk(KERN_CRIT DEV_NAME ": %s -> " fmt, __FUNCTION__ , ## args) 53 54 #ifdef ZCRYPT_DEBUG 55 #define PDEBUG(fmt, args...) \ 56 printk(KERN_DEBUG DEV_NAME ": %s -> " fmt, __FUNCTION__ , ## args) 57 #else 58 #define PDEBUG(fmt, args...) do {} while (0) 59 #endif 60 61 #include "ap_bus.h" 62 #include <asm/zcrypt.h> 63 64 /* deprecated status calls */ 65 #define ICAZ90STATUS _IOR(ZCRYPT_IOCTL_MAGIC, 0x10, struct ica_z90_status) 66 #define Z90STAT_PCIXCCCOUNT _IOR(ZCRYPT_IOCTL_MAGIC, 0x43, int) 67 68 /** 69 * This structure is deprecated and the corresponding ioctl() has been 70 * replaced with individual ioctl()s for each piece of data! 71 */ 72 struct ica_z90_status { 73 int totalcount; 74 int leedslitecount; // PCICA 75 int leeds2count; // PCICC 76 // int PCIXCCCount; is not in struct for backward compatibility 77 int requestqWaitCount; 78 int pendingqWaitCount; 79 int totalOpenCount; 80 int cryptoDomain; 81 // status: 0=not there, 1=PCICA, 2=PCICC, 3=PCIXCC_MCL2, 4=PCIXCC_MCL3, 82 // 5=CEX2C 83 unsigned char status[64]; 84 // qdepth: # work elements waiting for each device 85 unsigned char qdepth[64]; 86 }; 87 88 /** 89 * device type for an actual device is either PCICA, PCICC, PCIXCC_MCL2, 90 * PCIXCC_MCL3, CEX2C, or CEX2A 91 * 92 * NOTE: PCIXCC_MCL3 refers to a PCIXCC with May 2004 version of Licensed 93 * Internal Code (LIC) (EC J12220 level 29). 94 * PCIXCC_MCL2 refers to any LIC before this level. 95 */ 96 #define ZCRYPT_PCICA 1 97 #define ZCRYPT_PCICC 2 98 #define ZCRYPT_PCIXCC_MCL2 3 99 #define ZCRYPT_PCIXCC_MCL3 4 100 #define ZCRYPT_CEX2C 5 101 #define ZCRYPT_CEX2A 6 102 103 struct zcrypt_device; 104 105 struct zcrypt_ops { 106 long (*rsa_modexpo)(struct zcrypt_device *, struct ica_rsa_modexpo *); 107 long (*rsa_modexpo_crt)(struct zcrypt_device *, 108 struct ica_rsa_modexpo_crt *); 109 long (*send_cprb)(struct zcrypt_device *, struct ica_xcRB *); 110 }; 111 112 struct zcrypt_device { 113 struct list_head list; /* Device list. */ 114 spinlock_t lock; /* Per device lock. */ 115 struct kref refcount; /* device refcounting */ 116 struct ap_device *ap_dev; /* The "real" ap device. */ 117 struct zcrypt_ops *ops; /* Crypto operations. */ 118 int online; /* User online/offline */ 119 120 int user_space_type; /* User space device id. */ 121 char *type_string; /* User space device name. */ 122 int min_mod_size; /* Min number of bits. */ 123 int max_mod_size; /* Max number of bits. */ 124 int short_crt; /* Card has crt length restriction. */ 125 int speed_rating; /* Speed of the crypto device. */ 126 127 int request_count; /* # current requests. */ 128 129 struct ap_message reply; /* Per-device reply structure. */ 130 }; 131 132 struct zcrypt_device *zcrypt_device_alloc(size_t); 133 void zcrypt_device_free(struct zcrypt_device *); 134 void zcrypt_device_get(struct zcrypt_device *); 135 int zcrypt_device_put(struct zcrypt_device *); 136 int zcrypt_device_register(struct zcrypt_device *); 137 void zcrypt_device_unregister(struct zcrypt_device *); 138 int zcrypt_api_init(void); 139 void zcrypt_api_exit(void); 140 141 #endif /* _ZCRYPT_API_H_ */ 142