drivers/s390/crypto/z90crypt.h

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