1 /* 2 * zcrypt 2.1.0 3 * 4 * Copyright IBM Corp. 2001, 2012 5 * Author(s): Robert Burroughs 6 * Eric Rossman (edrossma@us.ibm.com) 7 * Cornelia Huck <cornelia.huck@de.ibm.com> 8 * 9 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com) 10 * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com> 11 * Ralph Wuerthner <rwuerthn@de.ibm.com> 12 * MSGTYPE restruct: Holger Dengler <hd@linux.vnet.ibm.com> 13 * 14 * This program is free software; you can redistribute it and/or modify 15 * it under the terms of the GNU General Public License as published by 16 * the Free Software Foundation; either version 2, or (at your option) 17 * any later version. 18 * 19 * This program is distributed in the hope that it will be useful, 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 * GNU General Public License for more details. 23 * 24 * You should have received a copy of the GNU General Public License 25 * along with this program; if not, write to the Free Software 26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 27 */ 28 29 #ifndef _ZCRYPT_API_H_ 30 #define _ZCRYPT_API_H_ 31 32 #include <linux/atomic.h> 33 #include <asm/debug.h> 34 #include <asm/zcrypt.h> 35 #include "ap_bus.h" 36 37 /* deprecated status calls */ 38 #define ICAZ90STATUS _IOR(ZCRYPT_IOCTL_MAGIC, 0x10, struct ica_z90_status) 39 #define Z90STAT_PCIXCCCOUNT _IOR(ZCRYPT_IOCTL_MAGIC, 0x43, int) 40 41 /** 42 * This structure is deprecated and the corresponding ioctl() has been 43 * replaced with individual ioctl()s for each piece of data! 44 */ 45 struct ica_z90_status { 46 int totalcount; 47 int leedslitecount; // PCICA 48 int leeds2count; // PCICC 49 // int PCIXCCCount; is not in struct for backward compatibility 50 int requestqWaitCount; 51 int pendingqWaitCount; 52 int totalOpenCount; 53 int cryptoDomain; 54 // status: 0=not there, 1=PCICA, 2=PCICC, 3=PCIXCC_MCL2, 4=PCIXCC_MCL3, 55 // 5=CEX2C 56 unsigned char status[64]; 57 // qdepth: # work elements waiting for each device 58 unsigned char qdepth[64]; 59 }; 60 61 /** 62 * device type for an actual device is either PCICA, PCICC, PCIXCC_MCL2, 63 * PCIXCC_MCL3, CEX2C, or CEX2A 64 * 65 * NOTE: PCIXCC_MCL3 refers to a PCIXCC with May 2004 version of Licensed 66 * Internal Code (LIC) (EC J12220 level 29). 67 * PCIXCC_MCL2 refers to any LIC before this level. 68 */ 69 #define ZCRYPT_PCICA 1 70 #define ZCRYPT_PCICC 2 71 #define ZCRYPT_PCIXCC_MCL2 3 72 #define ZCRYPT_PCIXCC_MCL3 4 73 #define ZCRYPT_CEX2C 5 74 #define ZCRYPT_CEX2A 6 75 #define ZCRYPT_CEX3C 7 76 #define ZCRYPT_CEX3A 8 77 #define ZCRYPT_CEX4 10 78 #define ZCRYPT_CEX5 11 79 80 /** 81 * Large random numbers are pulled in 4096 byte chunks from the crypto cards 82 * and stored in a page. Be careful when increasing this buffer due to size 83 * limitations for AP requests. 84 */ 85 #define ZCRYPT_RNG_BUFFER_SIZE 4096 86 87 /* 88 * Identifier for Crypto Request Performance Index 89 */ 90 enum crypto_ops { 91 MEX_1K, 92 MEX_2K, 93 MEX_4K, 94 CRT_1K, 95 CRT_2K, 96 CRT_4K, 97 HWRNG, 98 SECKEY, 99 NUM_OPS 100 }; 101 102 struct zcrypt_queue; 103 104 struct zcrypt_ops { 105 long (*rsa_modexpo)(struct zcrypt_queue *, struct ica_rsa_modexpo *); 106 long (*rsa_modexpo_crt)(struct zcrypt_queue *, 107 struct ica_rsa_modexpo_crt *); 108 long (*send_cprb)(struct zcrypt_queue *, struct ica_xcRB *, 109 struct ap_message *); 110 long (*send_ep11_cprb)(struct zcrypt_queue *, struct ep11_urb *, 111 struct ap_message *); 112 long (*rng)(struct zcrypt_queue *, char *, struct ap_message *); 113 struct list_head list; /* zcrypt ops list. */ 114 struct module *owner; 115 int variant; 116 char name[128]; 117 }; 118 119 struct zcrypt_card { 120 struct list_head list; /* Device list. */ 121 struct list_head zqueues; /* List of zcrypt queues */ 122 struct kref refcount; /* device refcounting */ 123 struct ap_card *card; /* The "real" ap card device. */ 124 int online; /* User online/offline */ 125 126 int user_space_type; /* User space device id. */ 127 char *type_string; /* User space device name. */ 128 int min_mod_size; /* Min number of bits. */ 129 int max_mod_size; /* Max number of bits. */ 130 int max_exp_bit_length; 131 int speed_rating[NUM_OPS]; /* Speed idx of crypto ops. */ 132 atomic_t load; /* Utilization of the crypto device */ 133 134 int request_count; /* # current requests. */ 135 }; 136 137 struct zcrypt_queue { 138 struct list_head list; /* Device list. */ 139 struct kref refcount; /* device refcounting */ 140 struct zcrypt_card *zcard; 141 struct zcrypt_ops *ops; /* Crypto operations. */ 142 struct ap_queue *queue; /* The "real" ap queue device. */ 143 int online; /* User online/offline */ 144 145 atomic_t load; /* Utilization of the crypto device */ 146 147 int request_count; /* # current requests. */ 148 149 struct ap_message reply; /* Per-device reply structure. */ 150 }; 151 152 /* transport layer rescanning */ 153 extern atomic_t zcrypt_rescan_req; 154 155 extern spinlock_t zcrypt_list_lock; 156 extern int zcrypt_device_count; 157 extern struct list_head zcrypt_card_list; 158 159 #define for_each_zcrypt_card(_zc) \ 160 list_for_each_entry(_zc, &zcrypt_card_list, list) 161 162 #define for_each_zcrypt_queue(_zq, _zc) \ 163 list_for_each_entry(_zq, &(_zc)->zqueues, list) 164 165 struct zcrypt_card *zcrypt_card_alloc(void); 166 void zcrypt_card_free(struct zcrypt_card *); 167 void zcrypt_card_get(struct zcrypt_card *); 168 int zcrypt_card_put(struct zcrypt_card *); 169 int zcrypt_card_register(struct zcrypt_card *); 170 void zcrypt_card_unregister(struct zcrypt_card *); 171 struct zcrypt_card *zcrypt_card_get_best(unsigned int *, 172 unsigned int, unsigned int); 173 void zcrypt_card_put_best(struct zcrypt_card *, unsigned int); 174 175 struct zcrypt_queue *zcrypt_queue_alloc(size_t); 176 void zcrypt_queue_free(struct zcrypt_queue *); 177 void zcrypt_queue_get(struct zcrypt_queue *); 178 int zcrypt_queue_put(struct zcrypt_queue *); 179 int zcrypt_queue_register(struct zcrypt_queue *); 180 void zcrypt_queue_unregister(struct zcrypt_queue *); 181 void zcrypt_queue_force_online(struct zcrypt_queue *, int); 182 struct zcrypt_queue *zcrypt_queue_get_best(unsigned int, unsigned int); 183 void zcrypt_queue_put_best(struct zcrypt_queue *, unsigned int); 184 185 int zcrypt_rng_device_add(void); 186 void zcrypt_rng_device_remove(void); 187 188 void zcrypt_msgtype_register(struct zcrypt_ops *); 189 void zcrypt_msgtype_unregister(struct zcrypt_ops *); 190 struct zcrypt_ops *zcrypt_msgtype(unsigned char *, int); 191 int zcrypt_api_init(void); 192 void zcrypt_api_exit(void); 193 long zcrypt_send_cprb(struct ica_xcRB *xcRB); 194 void zcrypt_device_status_mask(struct zcrypt_device_matrix *devstatus); 195 196 #endif /* _ZCRYPT_API_H_ */ 197