drivers/s390/crypto/z90crypt.h

   1 /*
   2  *  linux/drivers/s390/crypto/z90crypt.h
   3  *
   4  *  z90crypt 1.3.2
   5  *
   6  *  Copyright (C)  2001, 2004 IBM Corporation
   7  *  Author(s): Robert Burroughs (burrough@us.ibm.com)
   8  *             Eric Rossman (edrossma@us.ibm.com)
   9  *
  10  *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2, or (at your option)
  15  * any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  */
  26
  27 #ifndef _Z90CRYPT_H_
  28 #define _Z90CRYPT_H_
  29
  30 #include <linux/ioctl.h>
  31
  32 #define VERSION_Z90CRYPT_H "$Revision: 1.11 $"
  33
  34 #define z90crypt_VERSION 1
  35 #define z90crypt_RELEASE 3      // 2 = PCIXCC, 3 = rewrite for coding standards
  36 #define z90crypt_VARIANT 2      // 2 = added PCIXCC MCL3 and CEX2C support
  37
  38 /**
  39  * struct ica_rsa_modexpo
  40  *
  41  * Requirements:
  42  * - outputdatalength is at least as large as inputdatalength.
  43  * - All key parts are right justified in their fields, padded on
  44  *   the left with zeroes.
  45  * - length(b_key) = inputdatalength
  46  * - length(n_modulus) = inputdatalength
  47  */
  48 struct ica_rsa_modexpo {
  49         char __user *   inputdata;
  50         unsigned int    inputdatalength;
  51         char __user *   outputdata;
  52         unsigned int    outputdatalength;
  53         char __user *   b_key;
  54         char __user *   n_modulus;
  55 };
  56
  57 /**
  58  * struct ica_rsa_modexpo_crt
  59  *
  60  * Requirements:
  61  * - inputdatalength is even.
  62  * - outputdatalength is at least as large as inputdatalength.
  63  * - All key parts are right justified in their fields, padded on
  64  *   the left with zeroes.
  65  * - length(bp_key)     = inputdatalength/2 + 8
  66  * - length(bq_key)     = inputdatalength/2
  67  * - length(np_key)     = inputdatalength/2 + 8
  68  * - length(nq_key)     = inputdatalength/2
  69  * - length(u_mult_inv) = inputdatalength/2 + 8
  70  */
  71 struct ica_rsa_modexpo_crt {
  72         char __user *   inputdata;
  73         unsigned int    inputdatalength;
  74         char __user *   outputdata;
  75         unsigned int    outputdatalength;
  76         char __user *   bp_key;
  77         char __user *   bq_key;
  78         char __user *   np_prime;
  79         char __user *   nq_prime;
  80         char __user *   u_mult_inv;
  81 };
  82
  83 #define Z90_IOCTL_MAGIC 'z'  // NOTE:  Need to allocate from linux folks
  84
  85 /**
  86  * Interface notes:
  87  *
  88  * The ioctl()s which are implemented (along with relevant details)
  89  * are:
  90  *
  91  *   ICARSAMODEXPO
  92  *     Perform an RSA operation using a Modulus-Exponent pair
  93  *     This takes an ica_rsa_modexpo struct as its arg.
  94  *
  95  *     NOTE: please refer to the comments preceding this structure
  96  *           for the implementation details for the contents of the
  97  *           block
  98  *
  99  *   ICARSACRT
 100  *     Perform an RSA operation using a Chinese-Remainder Theorem key
 101  *     This takes an ica_rsa_modexpo_crt struct as its arg.
 102  *
 103  *     NOTE: please refer to the comments preceding this structure
 104  *           for the implementation details for the contents of the
 105  *           block
 106  *
 107  *   Z90STAT_TOTALCOUNT
 108  *     Return an integer count of all device types together.
 109  *
 110  *   Z90STAT_PCICACOUNT
 111  *     Return an integer count of all PCICAs.
 112  *
 113  *   Z90STAT_PCICCCOUNT
 114  *     Return an integer count of all PCICCs.
 115  *
 116  *   Z90STAT_PCIXCCMCL2COUNT
 117  *     Return an integer count of all MCL2 PCIXCCs.
 118  *
 119  *   Z90STAT_PCIXCCMCL3COUNT
 120  *     Return an integer count of all MCL3 PCIXCCs.
 121  *
 122  *   Z90STAT_CEX2CCOUNT
 123  *     Return an integer count of all CEX2Cs.
 124  *
 125  *   Z90STAT_REQUESTQ_COUNT
 126  *     Return an integer count of the number of entries waiting to be
 127  *     sent to a device.
 128  *
 129  *   Z90STAT_PENDINGQ_COUNT
 130  *     Return an integer count of the number of entries sent to a
 131  *     device awaiting the reply.
 132  *
 133  *   Z90STAT_TOTALOPEN_COUNT
 134  *     Return an integer count of the number of open file handles.
 135  *
 136  *   Z90STAT_DOMAIN_INDEX
 137  *     Return the integer value of the Cryptographic Domain.
 138  *
 139  *   Z90STAT_STATUS_MASK
 140  *     Return an 64 element array of unsigned chars for the status of
 141  *     all devices.
 142  *       0x01: PCICA
 143  *       0x02: PCICC
 144  *       0x03: PCIXCC_MCL2
 145  *       0x04: PCIXCC_MCL3
 146  *       0x05: CEX2C
 147  *       0x0d: device is disabled via the proc filesystem
 148  *
 149  *   Z90STAT_QDEPTH_MASK
 150  *     Return an 64 element array of unsigned chars for the queue
 151  *     depth of all devices.
 152  *
 153  *   Z90STAT_PERDEV_REQCNT
 154  *     Return an 64 element array of unsigned integers for the number
 155  *     of successfully completed requests per device since the device
 156  *     was detected and made available.
 157  *
 158  *   ICAZ90STATUS (deprecated)
 159  *     Return some device driver status in a ica_z90_status struct
 160  *     This takes an ica_z90_status struct as its arg.
 161  *
 162  *     NOTE: this ioctl() is deprecated, and has been replaced with
 163  *           single ioctl()s for each type of status being requested
 164  *
 165  *   Z90STAT_PCIXCCCOUNT (deprecated)
 166  *     Return an integer count of all PCIXCCs (MCL2 + MCL3).
 167  *     This is DEPRECATED now that MCL3 PCIXCCs are treated differently from
 168  *     MCL2 PCIXCCs.
 169  *
 170  *   Z90QUIESCE (not recommended)
 171  *     Quiesce the driver.  This is intended to stop all new
 172  *     requests from being processed.  Its use is NOT recommended,
 173  *     except in circumstances where there is no other way to stop
 174  *     callers from accessing the driver.  Its original use was to
 175  *     allow the driver to be "drained" of work in preparation for
 176  *     a system shutdown.
 177  *
 178  *     NOTE: once issued, this ban on new work cannot be undone
 179  *           except by unloading and reloading the driver.
 180  */
 181
 182 /**
 183  * Supported ioctl calls
 184  */
 185 #define ICARSAMODEXPO   _IOC(_IOC_READ|_IOC_WRITE, Z90_IOCTL_MAGIC, 0x05, 0)
 186 #define ICARSACRT       _IOC(_IOC_READ|_IOC_WRITE, Z90_IOCTL_MAGIC, 0x06, 0)
 187
 188 /* DEPRECATED status calls (bound for removal at some point) */
 189 #define ICAZ90STATUS    _IOR(Z90_IOCTL_MAGIC, 0x10, struct ica_z90_status)
 190 #define Z90STAT_PCIXCCCOUNT     _IOR(Z90_IOCTL_MAGIC, 0x43, int)
 191
 192 /* unrelated to ICA callers */
 193 #define Z90QUIESCE      _IO(Z90_IOCTL_MAGIC, 0x11)
 194
 195 /* New status calls */
 196 #define Z90STAT_TOTALCOUNT      _IOR(Z90_IOCTL_MAGIC, 0x40, int)
 197 #define Z90STAT_PCICACOUNT      _IOR(Z90_IOCTL_MAGIC, 0x41, int)
 198 #define Z90STAT_PCICCCOUNT      _IOR(Z90_IOCTL_MAGIC, 0x42, int)
 199 #define Z90STAT_PCIXCCMCL2COUNT _IOR(Z90_IOCTL_MAGIC, 0x4b, int)
 200 #define Z90STAT_PCIXCCMCL3COUNT _IOR(Z90_IOCTL_MAGIC, 0x4c, int)
 201 #define Z90STAT_CEX2CCOUNT      _IOR(Z90_IOCTL_MAGIC, 0x4d, int)
 202 #define Z90STAT_REQUESTQ_COUNT  _IOR(Z90_IOCTL_MAGIC, 0x44, int)
 203 #define Z90STAT_PENDINGQ_COUNT  _IOR(Z90_IOCTL_MAGIC, 0x45, int)
 204 #define Z90STAT_TOTALOPEN_COUNT _IOR(Z90_IOCTL_MAGIC, 0x46, int)
 205 #define Z90STAT_DOMAIN_INDEX    _IOR(Z90_IOCTL_MAGIC, 0x47, int)
 206 #define Z90STAT_STATUS_MASK     _IOR(Z90_IOCTL_MAGIC, 0x48, char[64])
 207 #define Z90STAT_QDEPTH_MASK     _IOR(Z90_IOCTL_MAGIC, 0x49, char[64])
 208 #define Z90STAT_PERDEV_REQCNT   _IOR(Z90_IOCTL_MAGIC, 0x4a, int[64])
 209
 210 /**
 211  * local errno definitions
 212  */
 213 #define ENOBUFF   129   // filp->private_data->...>work_elem_p->buffer is NULL
 214 #define EWORKPEND 130   // user issues ioctl while another pending
 215 #define ERELEASED 131   // user released while ioctl pending
 216 #define EQUIESCE  132   // z90crypt quiescing (no more work allowed)
 217 #define ETIMEOUT  133   // request timed out
 218 #define EUNKNOWN  134   // some unrecognized error occured (retry may succeed)
 219 #define EGETBUFF  135   // Error getting buffer or hardware lacks capability
 220                         // (retry in software)
 221
 222 /**
 223  * DEPRECATED STRUCTURES
 224  */
 225
 226 /**
 227  * This structure is DEPRECATED and the corresponding ioctl() has been
 228  * replaced with individual ioctl()s for each piece of data!
 229  * This structure will NOT survive past version 1.3.1, so switch to the
 230  * new ioctl()s.
 231  */
 232 #define MASK_LENGTH 64 // mask length
 233 struct ica_z90_status {
 234         int totalcount;
 235         int leedslitecount; // PCICA
 236         int leeds2count;    // PCICC
 237         // int PCIXCCCount; is not in struct for backward compatibility
 238         int requestqWaitCount;
 239         int pendingqWaitCount;
 240         int totalOpenCount;
 241         int cryptoDomain;
 242         // status: 0=not there, 1=PCICA, 2=PCICC, 3=PCIXCC_MCL2, 4=PCIXCC_MCL3,
 243         //         5=CEX2C
 244         unsigned char status[MASK_LENGTH];
 245         // qdepth: # work elements waiting for each device
 246         unsigned char qdepth[MASK_LENGTH];
 247 };
 248
 249 #endif /* _Z90CRYPT_H_ */