2 * linux/drivers/s390/misc/z90crypt.h
6 * Copyright (C) 2001, 2004 IBM Corporation
7 * Author(s): Robert Burroughs (burrough@us.ibm.com)
8 * Eric Rossman (edrossma@us.ibm.com)
10 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
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)
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.
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.
27 #ifndef _LINUX_Z90CRYPT_H_
28 #define _LINUX_Z90CRYPT_H_
30 #include <linux/ioctl.h>
32 #define VERSION_Z90CRYPT_H "$Revision: 1.2 $"
34 #define z90crypt_VERSION 1
35 #define z90crypt_RELEASE 3 // 2 = PCIXCC, 3 = rewrite for coding standards
36 #define z90crypt_VARIANT 1
39 * struct ica_rsa_modexpo
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
48 struct ica_rsa_modexpo {
50 unsigned int inputdatalength;
52 unsigned int outputdatalength;
58 * struct ica_rsa_modexpo_crt
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
71 struct ica_rsa_modexpo_crt {
73 unsigned int inputdatalength;
75 unsigned int outputdatalength;
83 #define Z90_IOCTL_MAGIC 'z' // NOTE: Need to allocate from linux folks
88 * The ioctl()s which are implemented (along with relevant details)
92 * Perform an RSA operation using a Modulus-Exponent pair
93 * This takes an ica_rsa_modexpo struct as its arg.
95 * NOTE: please refer to the comments preceding this structure
96 * for the implementation details for the contents of the
100 * Perform an RSA operation using a Chinese-Remainder Theorem key
101 * This takes an ica_rsa_modexpo_crt struct as its arg.
103 * NOTE: please refer to the comments preceding this structure
104 * for the implementation details for the contents of the
108 * Return an integer count of all device types together.
111 * Return an integer count of all PCICAs.
114 * Return an integer count of all PCICCs.
116 * Z90STAT_PCIXCCCOUNT
117 * Return an integer count of all PCIXCCs.
119 * Z90STAT_REQUESTQ_COUNT
120 * Return an integer count of the number of entries waiting to be
123 * Z90STAT_PENDINGQ_COUNT
124 * Return an integer count of the number of entries sent to a
125 * device awaiting the reply.
127 * Z90STAT_TOTALOPEN_COUNT
128 * Return an integer count of the number of open file handles.
130 * Z90STAT_DOMAIN_INDEX
131 * Return the integer value of the Cryptographic Domain.
133 * Z90STAT_STATUS_MASK
134 * Return an 64 element array of unsigned chars for the status of
139 * 0x0d: device is disabled via the proc filesystem
141 * Z90STAT_QDEPTH_MASK
142 * Return an 64 element array of unsigned chars for the queue
143 * depth of all devices.
145 * Z90STAT_PERDEV_REQCNT
146 * Return an 64 element array of unsigned integers for the number
147 * of successfully completed requests per device since the device
148 * was detected and made available.
150 * ICAZ90STATUS (deprecated)
151 * Return some device driver status in a ica_z90_status struct
152 * This takes an ica_z90_status struct as its arg.
154 * NOTE: this ioctl() is deprecated, and has been replaced with
155 * single ioctl()s for each type of status being requested
157 * Z90QUIESCE (not recommended)
158 * Quiesce the driver. This is intended to stop all new
159 * requests from being processed. Its use is not recommended,
160 * except in circumstances where there is no other way to stop
161 * callers from accessing the driver. Its original use was to
162 * allow the driver to be "drained" of work in preparation for
165 * NOTE: once issued, this ban on new work cannot be undone
166 * except by unloading and reloading the driver.
170 * Supported ioctl calls
172 #define ICARSAMODEXPO _IOC(_IOC_READ|_IOC_WRITE, Z90_IOCTL_MAGIC, 0x05, 0)
173 #define ICARSACRT _IOC(_IOC_READ|_IOC_WRITE, Z90_IOCTL_MAGIC, 0x06, 0)
175 /* DEPRECATED status call (bound for removal SOON) */
176 #define ICAZ90STATUS _IOR(Z90_IOCTL_MAGIC, 0x10, struct ica_z90_status)
178 /* unrelated to ICA callers */
179 #define Z90QUIESCE _IO(Z90_IOCTL_MAGIC, 0x11)
181 /* New status calls */
182 #define Z90STAT_TOTALCOUNT _IOR(Z90_IOCTL_MAGIC, 0x40, int)
183 #define Z90STAT_PCICACOUNT _IOR(Z90_IOCTL_MAGIC, 0x41, int)
184 #define Z90STAT_PCICCCOUNT _IOR(Z90_IOCTL_MAGIC, 0x42, int)
185 #define Z90STAT_PCIXCCCOUNT _IOR(Z90_IOCTL_MAGIC, 0x43, int)
186 #define Z90STAT_REQUESTQ_COUNT _IOR(Z90_IOCTL_MAGIC, 0x44, int)
187 #define Z90STAT_PENDINGQ_COUNT _IOR(Z90_IOCTL_MAGIC, 0x45, int)
188 #define Z90STAT_TOTALOPEN_COUNT _IOR(Z90_IOCTL_MAGIC, 0x46, int)
189 #define Z90STAT_DOMAIN_INDEX _IOR(Z90_IOCTL_MAGIC, 0x47, int)
190 #define Z90STAT_STATUS_MASK _IOR(Z90_IOCTL_MAGIC, 0x48, char[64])
191 #define Z90STAT_QDEPTH_MASK _IOR(Z90_IOCTL_MAGIC, 0x49, char[64])
192 #define Z90STAT_PERDEV_REQCNT _IOR(Z90_IOCTL_MAGIC, 0x4a, int[64])
195 * local errno definitions
197 #define ENOBUFF 129 // filp->private_data->...>work_elem_p->buffer is NULL
198 #define EWORKPEND 130 // user issues ioctl while another pending
199 #define ERELEASED 131 // user released while ioctl pending
200 #define EQUIESCE 132 // z90crypt quiescing (no more work allowed)
201 #define ETIMEOUT 133 // request timed out
202 #define EUNKNOWN 134 // some unrecognized error occured
203 #define EGETBUFF 135 // Error getting buffer
206 * DEPRECATED STRUCTURES
210 * This structure is DEPRECATED and the corresponding ioctl() has been
211 * replaced with individual ioctl()s for each piece of data!
212 * This structure will NOT survive past version 1.3.1, so switch to the
215 #define MASK_LENGTH 64 // mask length
216 struct ica_z90_status {
218 int leedslitecount; // PCICA
219 int leeds2count; // PCICC
220 // int PCIXCCCount; is not in struct for backward compatibility
221 int requestqWaitCount;
222 int pendingqWaitCount;
225 // status: 0=not there. 1=PCICA. 2=PCICC. 3=PCIXCC
226 unsigned char status[MASK_LENGTH];
227 // qdepth: # work elements waiting for each device
228 unsigned char qdepth[MASK_LENGTH];
231 #endif /* _LINUX_Z90CRYPT_H_ */