1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  *  Copyright IBM Corp. 2001, 2012
4  *  Author(s): Robert Burroughs
5  *	       Eric Rossman (edrossma@us.ibm.com)
6  *
7  *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
8  *  Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
9  *				  Ralph Wuerthner <rwuerthn@de.ibm.com>
10  *  MSGTYPE restruct:		  Holger Dengler <hd@linux.vnet.ibm.com>
11  */
12 
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/init.h>
16 #include <linux/err.h>
17 #include <linux/atomic.h>
18 #include <linux/uaccess.h>
19 #include <linux/mod_devicetable.h>
20 
21 #include "ap_bus.h"
22 #include "zcrypt_api.h"
23 #include "zcrypt_error.h"
24 #include "zcrypt_cex2a.h"
25 #include "zcrypt_msgtype50.h"
26 
27 #define CEX2A_MIN_MOD_SIZE	  1	/*    8 bits	*/
28 #define CEX2A_MAX_MOD_SIZE	256	/* 2048 bits	*/
29 #define CEX3A_MIN_MOD_SIZE	CEX2A_MIN_MOD_SIZE
30 #define CEX3A_MAX_MOD_SIZE	512	/* 4096 bits	*/
31 
32 #define CEX2A_MAX_MESSAGE_SIZE	0x390	/* sizeof(struct type50_crb2_msg)    */
33 #define CEX2A_MAX_RESPONSE_SIZE 0x110	/* max outputdatalength + type80_hdr */
34 
35 #define CEX3A_MAX_RESPONSE_SIZE	0x210	/* 512 bit modulus
36 					 * (max outputdatalength) +
37 					 * type80_hdr*/
38 #define CEX3A_MAX_MESSAGE_SIZE	sizeof(struct type50_crb3_msg)
39 
40 #define CEX2A_CLEANUP_TIME	(15*HZ)
41 #define CEX3A_CLEANUP_TIME	CEX2A_CLEANUP_TIME
42 
43 MODULE_AUTHOR("IBM Corporation");
44 MODULE_DESCRIPTION("CEX2A/CEX3A Cryptographic Coprocessor device driver, " \
45 		   "Copyright IBM Corp. 2001, 2018");
46 MODULE_LICENSE("GPL");
47 
48 static struct ap_device_id zcrypt_cex2a_card_ids[] = {
49 	{ .dev_type = AP_DEVICE_TYPE_CEX2A,
50 	  .match_flags = AP_DEVICE_ID_MATCH_CARD_TYPE },
51 	{ .dev_type = AP_DEVICE_TYPE_CEX3A,
52 	  .match_flags = AP_DEVICE_ID_MATCH_CARD_TYPE },
53 	{ /* end of list */ },
54 };
55 
56 MODULE_DEVICE_TABLE(ap, zcrypt_cex2a_card_ids);
57 
58 static struct ap_device_id zcrypt_cex2a_queue_ids[] = {
59 	{ .dev_type = AP_DEVICE_TYPE_CEX2A,
60 	  .match_flags = AP_DEVICE_ID_MATCH_QUEUE_TYPE },
61 	{ .dev_type = AP_DEVICE_TYPE_CEX3A,
62 	  .match_flags = AP_DEVICE_ID_MATCH_QUEUE_TYPE },
63 	{ /* end of list */ },
64 };
65 
66 MODULE_DEVICE_TABLE(ap, zcrypt_cex2a_queue_ids);
67 
68 /**
69  * Probe function for CEX2A card devices. It always accepts the AP device
70  * since the bus_match already checked the card type.
71  * @ap_dev: pointer to the AP device.
72  */
73 static int zcrypt_cex2a_card_probe(struct ap_device *ap_dev)
74 {
75 	/*
76 	 * Normalized speed ratings per crypto adapter
77 	 * MEX_1k, MEX_2k, MEX_4k, CRT_1k, CRT_2k, CRT_4k, RNG, SECKEY
78 	 */
79 	static const int CEX2A_SPEED_IDX[] = {
80 		800, 1000, 2000,  900, 1200, 2400, 0, 0};
81 	static const int CEX3A_SPEED_IDX[] = {
82 		400,  500, 1000,  450,	550, 1200, 0, 0};
83 
84 	struct ap_card *ac = to_ap_card(&ap_dev->device);
85 	struct zcrypt_card *zc;
86 	int rc = 0;
87 
88 	zc = zcrypt_card_alloc();
89 	if (!zc)
90 		return -ENOMEM;
91 	zc->card = ac;
92 	ac->private = zc;
93 
94 	if (ac->ap_dev.device_type == AP_DEVICE_TYPE_CEX2A) {
95 		zc->min_mod_size = CEX2A_MIN_MOD_SIZE;
96 		zc->max_mod_size = CEX2A_MAX_MOD_SIZE;
97 		zc->speed_rating = CEX2A_SPEED_IDX;
98 		zc->max_exp_bit_length = CEX2A_MAX_MOD_SIZE;
99 		zc->type_string = "CEX2A";
100 		zc->user_space_type = ZCRYPT_CEX2A;
101 	} else if (ac->ap_dev.device_type == AP_DEVICE_TYPE_CEX3A) {
102 		zc->min_mod_size = CEX2A_MIN_MOD_SIZE;
103 		zc->max_mod_size = CEX2A_MAX_MOD_SIZE;
104 		zc->max_exp_bit_length = CEX2A_MAX_MOD_SIZE;
105 		if (ap_test_bit(&ac->functions, AP_FUNC_MEX4K) &&
106 		    ap_test_bit(&ac->functions, AP_FUNC_CRT4K)) {
107 			zc->max_mod_size = CEX3A_MAX_MOD_SIZE;
108 			zc->max_exp_bit_length = CEX3A_MAX_MOD_SIZE;
109 		}
110 		zc->speed_rating = CEX3A_SPEED_IDX;
111 		zc->type_string = "CEX3A";
112 		zc->user_space_type = ZCRYPT_CEX3A;
113 	} else {
114 		zcrypt_card_free(zc);
115 		return -ENODEV;
116 	}
117 	zc->online = 1;
118 
119 	rc = zcrypt_card_register(zc);
120 	if (rc) {
121 		ac->private = NULL;
122 		zcrypt_card_free(zc);
123 	}
124 
125 	return rc;
126 }
127 
128 /**
129  * This is called to remove the CEX2A card driver information
130  * if an AP card device is removed.
131  */
132 static void zcrypt_cex2a_card_remove(struct ap_device *ap_dev)
133 {
134 	struct zcrypt_card *zc = to_ap_card(&ap_dev->device)->private;
135 
136 	if (zc)
137 		zcrypt_card_unregister(zc);
138 }
139 
140 static struct ap_driver zcrypt_cex2a_card_driver = {
141 	.probe = zcrypt_cex2a_card_probe,
142 	.remove = zcrypt_cex2a_card_remove,
143 	.ids = zcrypt_cex2a_card_ids,
144 	.flags = AP_DRIVER_FLAG_DEFAULT,
145 };
146 
147 /**
148  * Probe function for CEX2A queue devices. It always accepts the AP device
149  * since the bus_match already checked the queue type.
150  * @ap_dev: pointer to the AP device.
151  */
152 static int zcrypt_cex2a_queue_probe(struct ap_device *ap_dev)
153 {
154 	struct ap_queue *aq = to_ap_queue(&ap_dev->device);
155 	struct zcrypt_queue *zq = NULL;
156 	int rc;
157 
158 	switch (ap_dev->device_type) {
159 	case AP_DEVICE_TYPE_CEX2A:
160 		zq = zcrypt_queue_alloc(CEX2A_MAX_RESPONSE_SIZE);
161 		if (!zq)
162 			return -ENOMEM;
163 		break;
164 	case AP_DEVICE_TYPE_CEX3A:
165 		zq = zcrypt_queue_alloc(CEX3A_MAX_RESPONSE_SIZE);
166 		if (!zq)
167 			return -ENOMEM;
168 		break;
169 	}
170 	if (!zq)
171 		return -ENODEV;
172 	zq->ops = zcrypt_msgtype(MSGTYPE50_NAME, MSGTYPE50_VARIANT_DEFAULT);
173 	zq->queue = aq;
174 	zq->online = 1;
175 	atomic_set(&zq->load, 0);
176 	ap_queue_init_state(aq);
177 	ap_queue_init_reply(aq, &zq->reply);
178 	aq->request_timeout = CEX2A_CLEANUP_TIME;
179 	aq->private = zq;
180 	rc = zcrypt_queue_register(zq);
181 	if (rc) {
182 		aq->private = NULL;
183 		zcrypt_queue_free(zq);
184 	}
185 
186 	return rc;
187 }
188 
189 /**
190  * This is called to remove the CEX2A queue driver information
191  * if an AP queue device is removed.
192  */
193 static void zcrypt_cex2a_queue_remove(struct ap_device *ap_dev)
194 {
195 	struct ap_queue *aq = to_ap_queue(&ap_dev->device);
196 	struct zcrypt_queue *zq = aq->private;
197 
198 	if (zq)
199 		zcrypt_queue_unregister(zq);
200 }
201 
202 static struct ap_driver zcrypt_cex2a_queue_driver = {
203 	.probe = zcrypt_cex2a_queue_probe,
204 	.remove = zcrypt_cex2a_queue_remove,
205 	.ids = zcrypt_cex2a_queue_ids,
206 	.flags = AP_DRIVER_FLAG_DEFAULT,
207 };
208 
209 int __init zcrypt_cex2a_init(void)
210 {
211 	int rc;
212 
213 	rc = ap_driver_register(&zcrypt_cex2a_card_driver,
214 				THIS_MODULE, "cex2acard");
215 	if (rc)
216 		return rc;
217 
218 	rc = ap_driver_register(&zcrypt_cex2a_queue_driver,
219 				THIS_MODULE, "cex2aqueue");
220 	if (rc)
221 		ap_driver_unregister(&zcrypt_cex2a_card_driver);
222 
223 	return rc;
224 }
225 
226 void __exit zcrypt_cex2a_exit(void)
227 {
228 	ap_driver_unregister(&zcrypt_cex2a_queue_driver);
229 	ap_driver_unregister(&zcrypt_cex2a_card_driver);
230 }
231 
232 module_init(zcrypt_cex2a_init);
233 module_exit(zcrypt_cex2a_exit);
234