2 * linux/drivers/s390/crypto/zcrypt_pcica.c
6 * Copyright (C) 2001, 2006 IBM Corporation
7 * Author(s): Robert Burroughs
8 * Eric Rossman (edrossma@us.ibm.com)
10 * Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
11 * Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
12 * Ralph Wuerthner <rwuerthn@de.ibm.com>
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)
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.
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.
29 #include <linux/module.h>
30 #include <linux/slab.h>
31 #include <linux/init.h>
32 #include <linux/err.h>
33 #include <asm/atomic.h>
34 #include <asm/uaccess.h>
37 #include "zcrypt_api.h"
38 #include "zcrypt_error.h"
39 #include "zcrypt_pcica.h"
41 #define PCICA_MIN_MOD_SIZE 1 /* 8 bits */
42 #define PCICA_MAX_MOD_SIZE 256 /* 2048 bits */
44 #define PCICA_SPEED_RATING 2800
46 #define PCICA_MAX_MESSAGE_SIZE 0x3a0 /* sizeof(struct type4_lcr) */
47 #define PCICA_MAX_RESPONSE_SIZE 0x110 /* max outputdatalength + type80_hdr */
49 #define PCICA_CLEANUP_TIME (15*HZ)
51 static struct ap_device_id zcrypt_pcica_ids
[] = {
52 { AP_DEVICE(AP_DEVICE_TYPE_PCICA
) },
53 { /* end of list */ },
56 #ifndef CONFIG_ZCRYPT_MONOLITHIC
57 MODULE_DEVICE_TABLE(ap
, zcrypt_pcica_ids
);
58 MODULE_AUTHOR("IBM Corporation");
59 MODULE_DESCRIPTION("PCICA Cryptographic Coprocessor device driver, "
60 "Copyright 2001, 2006 IBM Corporation");
61 MODULE_LICENSE("GPL");
64 static int zcrypt_pcica_probe(struct ap_device
*ap_dev
);
65 static void zcrypt_pcica_remove(struct ap_device
*ap_dev
);
66 static void zcrypt_pcica_receive(struct ap_device
*, struct ap_message
*,
69 static struct ap_driver zcrypt_pcica_driver
= {
70 .probe
= zcrypt_pcica_probe
,
71 .remove
= zcrypt_pcica_remove
,
72 .receive
= zcrypt_pcica_receive
,
73 .ids
= zcrypt_pcica_ids
,
74 .request_timeout
= PCICA_CLEANUP_TIME
,
78 * Convert a ICAMEX message to a type4 MEX message.
80 * @zdev: crypto device pointer
81 * @zreq: crypto request pointer
82 * @mex: pointer to user input data
84 * Returns 0 on success or -EFAULT.
86 static int ICAMEX_msg_to_type4MEX_msg(struct zcrypt_device
*zdev
,
87 struct ap_message
*ap_msg
,
88 struct ica_rsa_modexpo
*mex
)
90 unsigned char *modulus
, *exponent
, *message
;
93 mod_len
= mex
->inputdatalength
;
96 struct type4_sme
*sme
= ap_msg
->message
;
97 memset(sme
, 0, sizeof(*sme
));
98 ap_msg
->length
= sizeof(*sme
);
99 sme
->header
.msg_fmt
= TYPE4_SME_FMT
;
100 sme
->header
.msg_len
= sizeof(*sme
);
101 sme
->header
.msg_type_code
= TYPE4_TYPE_CODE
;
102 sme
->header
.request_code
= TYPE4_REQU_CODE
;
103 modulus
= sme
->modulus
+ sizeof(sme
->modulus
) - mod_len
;
104 exponent
= sme
->exponent
+ sizeof(sme
->exponent
) - mod_len
;
105 message
= sme
->message
+ sizeof(sme
->message
) - mod_len
;
107 struct type4_lme
*lme
= ap_msg
->message
;
108 memset(lme
, 0, sizeof(*lme
));
109 ap_msg
->length
= sizeof(*lme
);
110 lme
->header
.msg_fmt
= TYPE4_LME_FMT
;
111 lme
->header
.msg_len
= sizeof(*lme
);
112 lme
->header
.msg_type_code
= TYPE4_TYPE_CODE
;
113 lme
->header
.request_code
= TYPE4_REQU_CODE
;
114 modulus
= lme
->modulus
+ sizeof(lme
->modulus
) - mod_len
;
115 exponent
= lme
->exponent
+ sizeof(lme
->exponent
) - mod_len
;
116 message
= lme
->message
+ sizeof(lme
->message
) - mod_len
;
119 if (copy_from_user(modulus
, mex
->n_modulus
, mod_len
) ||
120 copy_from_user(exponent
, mex
->b_key
, mod_len
) ||
121 copy_from_user(message
, mex
->inputdata
, mod_len
))
127 * Convert a ICACRT message to a type4 CRT message.
129 * @zdev: crypto device pointer
130 * @zreq: crypto request pointer
131 * @crt: pointer to user input data
133 * Returns 0 on success or -EFAULT.
135 static int ICACRT_msg_to_type4CRT_msg(struct zcrypt_device
*zdev
,
136 struct ap_message
*ap_msg
,
137 struct ica_rsa_modexpo_crt
*crt
)
139 unsigned char *p
, *q
, *dp
, *dq
, *u
, *inp
;
140 int mod_len
, short_len
, long_len
;
142 mod_len
= crt
->inputdatalength
;
143 short_len
= mod_len
/ 2;
144 long_len
= mod_len
/ 2 + 8;
146 if (mod_len
<= 128) {
147 struct type4_scr
*scr
= ap_msg
->message
;
148 memset(scr
, 0, sizeof(*scr
));
149 ap_msg
->length
= sizeof(*scr
);
150 scr
->header
.msg_type_code
= TYPE4_TYPE_CODE
;
151 scr
->header
.request_code
= TYPE4_REQU_CODE
;
152 scr
->header
.msg_fmt
= TYPE4_SCR_FMT
;
153 scr
->header
.msg_len
= sizeof(*scr
);
154 p
= scr
->p
+ sizeof(scr
->p
) - long_len
;
155 q
= scr
->q
+ sizeof(scr
->q
) - short_len
;
156 dp
= scr
->dp
+ sizeof(scr
->dp
) - long_len
;
157 dq
= scr
->dq
+ sizeof(scr
->dq
) - short_len
;
158 u
= scr
->u
+ sizeof(scr
->u
) - long_len
;
159 inp
= scr
->message
+ sizeof(scr
->message
) - mod_len
;
161 struct type4_lcr
*lcr
= ap_msg
->message
;
162 memset(lcr
, 0, sizeof(*lcr
));
163 ap_msg
->length
= sizeof(*lcr
);
164 lcr
->header
.msg_type_code
= TYPE4_TYPE_CODE
;
165 lcr
->header
.request_code
= TYPE4_REQU_CODE
;
166 lcr
->header
.msg_fmt
= TYPE4_LCR_FMT
;
167 lcr
->header
.msg_len
= sizeof(*lcr
);
168 p
= lcr
->p
+ sizeof(lcr
->p
) - long_len
;
169 q
= lcr
->q
+ sizeof(lcr
->q
) - short_len
;
170 dp
= lcr
->dp
+ sizeof(lcr
->dp
) - long_len
;
171 dq
= lcr
->dq
+ sizeof(lcr
->dq
) - short_len
;
172 u
= lcr
->u
+ sizeof(lcr
->u
) - long_len
;
173 inp
= lcr
->message
+ sizeof(lcr
->message
) - mod_len
;
176 if (copy_from_user(p
, crt
->np_prime
, long_len
) ||
177 copy_from_user(q
, crt
->nq_prime
, short_len
) ||
178 copy_from_user(dp
, crt
->bp_key
, long_len
) ||
179 copy_from_user(dq
, crt
->bq_key
, short_len
) ||
180 copy_from_user(u
, crt
->u_mult_inv
, long_len
) ||
181 copy_from_user(inp
, crt
->inputdata
, mod_len
))
187 * Copy results from a type 84 reply message back to user space.
189 * @zdev: crypto device pointer
190 * @reply: reply AP message.
191 * @data: pointer to user output data
192 * @length: size of user output data
194 * Returns 0 on success or -EFAULT.
196 static int convert_type84(struct zcrypt_device
*zdev
,
197 struct ap_message
*reply
,
198 char __user
*outputdata
,
199 unsigned int outputdatalength
)
201 struct type84_hdr
*t84h
= reply
->message
;
204 if (t84h
->len
< sizeof(*t84h
) + outputdatalength
) {
205 /* The result is too short, the PCICA card may not do that.. */
207 return -EAGAIN
; /* repeat the request on a different device. */
209 BUG_ON(t84h
->len
> PCICA_MAX_RESPONSE_SIZE
);
210 data
= reply
->message
+ t84h
->len
- outputdatalength
;
211 if (copy_to_user(outputdata
, data
, outputdatalength
))
216 static int convert_response(struct zcrypt_device
*zdev
,
217 struct ap_message
*reply
,
218 char __user
*outputdata
,
219 unsigned int outputdatalength
)
221 /* Response type byte is the second byte in the response. */
222 switch (((unsigned char *) reply
->message
)[1]) {
223 case TYPE82_RSP_CODE
:
224 case TYPE88_RSP_CODE
:
225 return convert_error(zdev
, reply
);
226 case TYPE84_RSP_CODE
:
227 return convert_type84(zdev
, reply
,
228 outputdata
, outputdatalength
);
229 default: /* Unknown response type, this should NEVER EVER happen */
231 return -EAGAIN
; /* repeat the request on a different device. */
236 * This function is called from the AP bus code after a crypto request
237 * "msg" has finished with the reply message "reply".
238 * It is called from tasklet context.
239 * @ap_dev: pointer to the AP device
240 * @msg: pointer to the AP message
241 * @reply: pointer to the AP reply message
243 static void zcrypt_pcica_receive(struct ap_device
*ap_dev
,
244 struct ap_message
*msg
,
245 struct ap_message
*reply
)
247 static struct error_hdr error_reply
= {
248 .type
= TYPE82_RSP_CODE
,
249 .reply_code
= REP82_ERROR_MACHINE_FAILURE
,
251 struct type84_hdr
*t84h
;
254 /* Copy the reply message to the request message buffer. */
256 memcpy(msg
->message
, &error_reply
, sizeof(error_reply
));
259 t84h
= reply
->message
;
260 if (t84h
->code
== TYPE84_RSP_CODE
) {
261 length
= min(PCICA_MAX_RESPONSE_SIZE
, (int) t84h
->len
);
262 memcpy(msg
->message
, reply
->message
, length
);
264 memcpy(msg
->message
, reply
->message
, sizeof error_reply
);
266 complete((struct completion
*) msg
->private);
269 static atomic_t zcrypt_step
= ATOMIC_INIT(0);
272 * The request distributor calls this function if it picked the PCICA
273 * device to handle a modexpo request.
274 * @zdev: pointer to zcrypt_device structure that identifies the
275 * PCICA device to the request distributor
276 * @mex: pointer to the modexpo request buffer
278 static long zcrypt_pcica_modexpo(struct zcrypt_device
*zdev
,
279 struct ica_rsa_modexpo
*mex
)
281 struct ap_message ap_msg
;
282 struct completion work
;
285 ap_init_message(&ap_msg
);
286 ap_msg
.message
= kmalloc(PCICA_MAX_MESSAGE_SIZE
, GFP_KERNEL
);
289 ap_msg
.psmid
= (((unsigned long long) current
->pid
) << 32) +
290 atomic_inc_return(&zcrypt_step
);
291 ap_msg
.private = &work
;
292 rc
= ICAMEX_msg_to_type4MEX_msg(zdev
, &ap_msg
, mex
);
295 init_completion(&work
);
296 ap_queue_message(zdev
->ap_dev
, &ap_msg
);
297 rc
= wait_for_completion_interruptible(&work
);
299 rc
= convert_response(zdev
, &ap_msg
, mex
->outputdata
,
300 mex
->outputdatalength
);
302 /* Signal pending. */
303 ap_cancel_message(zdev
->ap_dev
, &ap_msg
);
305 kfree(ap_msg
.message
);
310 * The request distributor calls this function if it picked the PCICA
311 * device to handle a modexpo_crt request.
312 * @zdev: pointer to zcrypt_device structure that identifies the
313 * PCICA device to the request distributor
314 * @crt: pointer to the modexpoc_crt request buffer
316 static long zcrypt_pcica_modexpo_crt(struct zcrypt_device
*zdev
,
317 struct ica_rsa_modexpo_crt
*crt
)
319 struct ap_message ap_msg
;
320 struct completion work
;
323 ap_init_message(&ap_msg
);
324 ap_msg
.message
= kmalloc(PCICA_MAX_MESSAGE_SIZE
, GFP_KERNEL
);
327 ap_msg
.psmid
= (((unsigned long long) current
->pid
) << 32) +
328 atomic_inc_return(&zcrypt_step
);
329 ap_msg
.private = &work
;
330 rc
= ICACRT_msg_to_type4CRT_msg(zdev
, &ap_msg
, crt
);
333 init_completion(&work
);
334 ap_queue_message(zdev
->ap_dev
, &ap_msg
);
335 rc
= wait_for_completion_interruptible(&work
);
337 rc
= convert_response(zdev
, &ap_msg
, crt
->outputdata
,
338 crt
->outputdatalength
);
340 /* Signal pending. */
341 ap_cancel_message(zdev
->ap_dev
, &ap_msg
);
343 kfree(ap_msg
.message
);
348 * The crypto operations for a PCICA card.
350 static struct zcrypt_ops zcrypt_pcica_ops
= {
351 .rsa_modexpo
= zcrypt_pcica_modexpo
,
352 .rsa_modexpo_crt
= zcrypt_pcica_modexpo_crt
,
356 * Probe function for PCICA cards. It always accepts the AP device
357 * since the bus_match already checked the hardware type.
358 * @ap_dev: pointer to the AP device.
360 static int zcrypt_pcica_probe(struct ap_device
*ap_dev
)
362 struct zcrypt_device
*zdev
;
365 zdev
= zcrypt_device_alloc(PCICA_MAX_RESPONSE_SIZE
);
368 zdev
->ap_dev
= ap_dev
;
369 zdev
->ops
= &zcrypt_pcica_ops
;
371 zdev
->user_space_type
= ZCRYPT_PCICA
;
372 zdev
->type_string
= "PCICA";
373 zdev
->min_mod_size
= PCICA_MIN_MOD_SIZE
;
374 zdev
->max_mod_size
= PCICA_MAX_MOD_SIZE
;
375 zdev
->speed_rating
= PCICA_SPEED_RATING
;
376 ap_dev
->reply
= &zdev
->reply
;
377 ap_dev
->private = zdev
;
378 rc
= zcrypt_device_register(zdev
);
384 ap_dev
->private = NULL
;
385 zcrypt_device_free(zdev
);
390 * This is called to remove the extended PCICA driver information
391 * if an AP device is removed.
393 static void zcrypt_pcica_remove(struct ap_device
*ap_dev
)
395 struct zcrypt_device
*zdev
= ap_dev
->private;
397 zcrypt_device_unregister(zdev
);
400 int __init
zcrypt_pcica_init(void)
402 return ap_driver_register(&zcrypt_pcica_driver
, THIS_MODULE
, "pcica");
405 void zcrypt_pcica_exit(void)
407 ap_driver_unregister(&zcrypt_pcica_driver
);
410 #ifndef CONFIG_ZCRYPT_MONOLITHIC
411 module_init(zcrypt_pcica_init
);
412 module_exit(zcrypt_pcica_exit
);