1 /* Driver for Virtio crypto device.
3 * Copyright 2016 HUAWEI TECHNOLOGIES CO., LTD.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include <linux/err.h>
20 #include <linux/module.h>
21 #include <linux/virtio_config.h>
22 #include <linux/cpu.h>
24 #include <uapi/linux/virtio_crypto.h>
25 #include "virtio_crypto_common.h"
29 virtcrypto_clear_request(struct virtio_crypto_request *vc_req)
33 kzfree(vc_req->req_data);
38 static void virtcrypto_dataq_callback(struct virtqueue *vq)
40 struct virtio_crypto *vcrypto = vq->vdev->priv;
41 struct virtio_crypto_request *vc_req;
44 struct ablkcipher_request *ablk_req;
46 unsigned int qid = vq->index;
48 spin_lock_irqsave(&vcrypto->data_vq[qid].lock, flags);
50 virtqueue_disable_cb(vq);
51 while ((vc_req = virtqueue_get_buf(vq, &len)) != NULL) {
52 if (vc_req->type == VIRTIO_CRYPTO_SYM_OP_CIPHER) {
53 switch (vc_req->status) {
54 case VIRTIO_CRYPTO_OK:
57 case VIRTIO_CRYPTO_INVSESS:
58 case VIRTIO_CRYPTO_ERR:
61 case VIRTIO_CRYPTO_BADMSG:
68 ablk_req = vc_req->ablkcipher_req;
70 spin_unlock_irqrestore(
71 &vcrypto->data_vq[qid].lock, flags);
72 /* Finish the encrypt or decrypt process */
73 virtio_crypto_ablkcipher_finalize_req(vc_req,
76 &vcrypto->data_vq[qid].lock, flags);
79 } while (!virtqueue_enable_cb(vq));
80 spin_unlock_irqrestore(&vcrypto->data_vq[qid].lock, flags);
83 static int virtcrypto_find_vqs(struct virtio_crypto *vi)
85 vq_callback_t **callbacks;
86 struct virtqueue **vqs;
90 struct device *dev = &vi->vdev->dev;
93 * We expect 1 data virtqueue, followed by
94 * possible N-1 data queues used in multiqueue mode,
95 * followed by control vq.
97 total_vqs = vi->max_data_queues + 1;
99 /* Allocate space for find_vqs parameters */
100 vqs = kcalloc(total_vqs, sizeof(*vqs), GFP_KERNEL);
103 callbacks = kcalloc(total_vqs, sizeof(*callbacks), GFP_KERNEL);
106 names = kcalloc(total_vqs, sizeof(*names), GFP_KERNEL);
110 /* Parameters for control virtqueue */
111 callbacks[total_vqs - 1] = NULL;
112 names[total_vqs - 1] = "controlq";
114 /* Allocate/initialize parameters for data virtqueues */
115 for (i = 0; i < vi->max_data_queues; i++) {
116 callbacks[i] = virtcrypto_dataq_callback;
117 snprintf(vi->data_vq[i].name, sizeof(vi->data_vq[i].name),
119 names[i] = vi->data_vq[i].name;
122 ret = virtio_find_vqs(vi->vdev, total_vqs, vqs, callbacks, names, NULL);
126 vi->ctrl_vq = vqs[total_vqs - 1];
128 for (i = 0; i < vi->max_data_queues; i++) {
129 spin_lock_init(&vi->data_vq[i].lock);
130 vi->data_vq[i].vq = vqs[i];
131 /* Initialize crypto engine */
132 vi->data_vq[i].engine = crypto_engine_alloc_init(dev, 1);
133 if (!vi->data_vq[i].engine) {
138 vi->data_vq[i].engine->cipher_one_request =
139 virtio_crypto_ablkcipher_crypt_req;
159 static int virtcrypto_alloc_queues(struct virtio_crypto *vi)
161 vi->data_vq = kcalloc(vi->max_data_queues, sizeof(*vi->data_vq),
169 static void virtcrypto_clean_affinity(struct virtio_crypto *vi, long hcpu)
173 if (vi->affinity_hint_set) {
174 for (i = 0; i < vi->max_data_queues; i++)
175 virtqueue_set_affinity(vi->data_vq[i].vq, -1);
177 vi->affinity_hint_set = false;
181 static void virtcrypto_set_affinity(struct virtio_crypto *vcrypto)
187 * In single queue mode, we don't set the cpu affinity.
189 if (vcrypto->curr_queue == 1 || vcrypto->max_data_queues == 1) {
190 virtcrypto_clean_affinity(vcrypto, -1);
195 * In multiqueue mode, we let the queue to be private to one cpu
196 * by setting the affinity hint to eliminate the contention.
198 * TODO: adds cpu hotplug support by register cpu notifier.
201 for_each_online_cpu(cpu) {
202 virtqueue_set_affinity(vcrypto->data_vq[i].vq, cpu);
203 if (++i >= vcrypto->max_data_queues)
207 vcrypto->affinity_hint_set = true;
210 static void virtcrypto_free_queues(struct virtio_crypto *vi)
215 static int virtcrypto_init_vqs(struct virtio_crypto *vi)
219 /* Allocate send & receive queues */
220 ret = virtcrypto_alloc_queues(vi);
224 ret = virtcrypto_find_vqs(vi);
229 virtcrypto_set_affinity(vi);
235 virtcrypto_free_queues(vi);
240 static int virtcrypto_update_status(struct virtio_crypto *vcrypto)
245 virtio_cread(vcrypto->vdev,
246 struct virtio_crypto_config, status, &status);
249 * Unknown status bits would be a host error and the driver
250 * should consider the device to be broken.
252 if (status & (~VIRTIO_CRYPTO_S_HW_READY)) {
253 dev_warn(&vcrypto->vdev->dev,
254 "Unknown status bits: 0x%x\n", status);
256 virtio_break_device(vcrypto->vdev);
260 if (vcrypto->status == status)
263 vcrypto->status = status;
265 if (vcrypto->status & VIRTIO_CRYPTO_S_HW_READY) {
266 err = virtcrypto_dev_start(vcrypto);
268 dev_err(&vcrypto->vdev->dev,
269 "Failed to start virtio crypto device.\n");
273 dev_info(&vcrypto->vdev->dev, "Accelerator is ready\n");
275 virtcrypto_dev_stop(vcrypto);
276 dev_info(&vcrypto->vdev->dev, "Accelerator is not ready\n");
282 static int virtcrypto_start_crypto_engines(struct virtio_crypto *vcrypto)
287 for (i = 0; i < vcrypto->max_data_queues; i++) {
288 if (vcrypto->data_vq[i].engine) {
289 ret = crypto_engine_start(vcrypto->data_vq[i].engine);
299 if (vcrypto->data_vq[i].engine)
300 crypto_engine_exit(vcrypto->data_vq[i].engine);
305 static void virtcrypto_clear_crypto_engines(struct virtio_crypto *vcrypto)
309 for (i = 0; i < vcrypto->max_data_queues; i++)
310 if (vcrypto->data_vq[i].engine)
311 crypto_engine_exit(vcrypto->data_vq[i].engine);
314 static void virtcrypto_del_vqs(struct virtio_crypto *vcrypto)
316 struct virtio_device *vdev = vcrypto->vdev;
318 virtcrypto_clean_affinity(vcrypto, -1);
320 vdev->config->del_vqs(vdev);
322 virtcrypto_free_queues(vcrypto);
325 static int virtcrypto_probe(struct virtio_device *vdev)
328 struct virtio_crypto *vcrypto;
329 u32 max_data_queues = 0, max_cipher_key_len = 0;
330 u32 max_auth_key_len = 0;
333 if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1))
336 if (!vdev->config->get) {
337 dev_err(&vdev->dev, "%s failure: config access disabled\n",
342 if (num_possible_nodes() > 1 && dev_to_node(&vdev->dev) < 0) {
344 * If the accelerator is connected to a node with no memory
345 * there is no point in using the accelerator since the remote
346 * memory transaction will be very slow.
348 dev_err(&vdev->dev, "Invalid NUMA configuration.\n");
352 vcrypto = kzalloc_node(sizeof(*vcrypto), GFP_KERNEL,
353 dev_to_node(&vdev->dev));
357 virtio_cread(vdev, struct virtio_crypto_config,
358 max_dataqueues, &max_data_queues);
359 if (max_data_queues < 1)
362 virtio_cread(vdev, struct virtio_crypto_config,
363 max_cipher_key_len, &max_cipher_key_len);
364 virtio_cread(vdev, struct virtio_crypto_config,
365 max_auth_key_len, &max_auth_key_len);
366 virtio_cread(vdev, struct virtio_crypto_config,
367 max_size, &max_size);
369 /* Add virtio crypto device to global table */
370 err = virtcrypto_devmgr_add_dev(vcrypto);
372 dev_err(&vdev->dev, "Failed to add new virtio crypto device.\n");
375 vcrypto->owner = THIS_MODULE;
376 vcrypto = vdev->priv = vcrypto;
377 vcrypto->vdev = vdev;
379 spin_lock_init(&vcrypto->ctrl_lock);
381 /* Use single data queue as default */
382 vcrypto->curr_queue = 1;
383 vcrypto->max_data_queues = max_data_queues;
384 vcrypto->max_cipher_key_len = max_cipher_key_len;
385 vcrypto->max_auth_key_len = max_auth_key_len;
386 vcrypto->max_size = max_size;
389 "max_queues: %u, max_cipher_key_len: %u, max_auth_key_len: %u, max_size 0x%llx\n",
390 vcrypto->max_data_queues,
391 vcrypto->max_cipher_key_len,
392 vcrypto->max_auth_key_len,
395 err = virtcrypto_init_vqs(vcrypto);
397 dev_err(&vdev->dev, "Failed to initialize vqs.\n");
401 err = virtcrypto_start_crypto_engines(vcrypto);
405 virtio_device_ready(vdev);
407 err = virtcrypto_update_status(vcrypto);
414 virtcrypto_clear_crypto_engines(vcrypto);
416 vcrypto->vdev->config->reset(vdev);
417 virtcrypto_del_vqs(vcrypto);
419 virtcrypto_devmgr_rm_dev(vcrypto);
425 static void virtcrypto_free_unused_reqs(struct virtio_crypto *vcrypto)
427 struct virtio_crypto_request *vc_req;
429 struct virtqueue *vq;
431 for (i = 0; i < vcrypto->max_data_queues; i++) {
432 vq = vcrypto->data_vq[i].vq;
433 while ((vc_req = virtqueue_detach_unused_buf(vq)) != NULL) {
434 kfree(vc_req->req_data);
440 static void virtcrypto_remove(struct virtio_device *vdev)
442 struct virtio_crypto *vcrypto = vdev->priv;
444 dev_info(&vdev->dev, "Start virtcrypto_remove.\n");
446 if (virtcrypto_dev_started(vcrypto))
447 virtcrypto_dev_stop(vcrypto);
448 vdev->config->reset(vdev);
449 virtcrypto_free_unused_reqs(vcrypto);
450 virtcrypto_clear_crypto_engines(vcrypto);
451 virtcrypto_del_vqs(vcrypto);
452 virtcrypto_devmgr_rm_dev(vcrypto);
456 static void virtcrypto_config_changed(struct virtio_device *vdev)
458 struct virtio_crypto *vcrypto = vdev->priv;
460 virtcrypto_update_status(vcrypto);
463 #ifdef CONFIG_PM_SLEEP
464 static int virtcrypto_freeze(struct virtio_device *vdev)
466 struct virtio_crypto *vcrypto = vdev->priv;
468 vdev->config->reset(vdev);
469 virtcrypto_free_unused_reqs(vcrypto);
470 if (virtcrypto_dev_started(vcrypto))
471 virtcrypto_dev_stop(vcrypto);
473 virtcrypto_clear_crypto_engines(vcrypto);
474 virtcrypto_del_vqs(vcrypto);
478 static int virtcrypto_restore(struct virtio_device *vdev)
480 struct virtio_crypto *vcrypto = vdev->priv;
483 err = virtcrypto_init_vqs(vcrypto);
487 err = virtcrypto_start_crypto_engines(vcrypto);
491 virtio_device_ready(vdev);
493 err = virtcrypto_dev_start(vcrypto);
495 dev_err(&vdev->dev, "Failed to start virtio crypto device.\n");
502 virtcrypto_clear_crypto_engines(vcrypto);
504 vcrypto->vdev->config->reset(vdev);
505 virtcrypto_del_vqs(vcrypto);
510 static unsigned int features[] = {
514 static struct virtio_device_id id_table[] = {
515 { VIRTIO_ID_CRYPTO, VIRTIO_DEV_ANY_ID },
519 static struct virtio_driver virtio_crypto_driver = {
520 .driver.name = KBUILD_MODNAME,
521 .driver.owner = THIS_MODULE,
522 .feature_table = features,
523 .feature_table_size = ARRAY_SIZE(features),
524 .id_table = id_table,
525 .probe = virtcrypto_probe,
526 .remove = virtcrypto_remove,
527 .config_changed = virtcrypto_config_changed,
528 #ifdef CONFIG_PM_SLEEP
529 .freeze = virtcrypto_freeze,
530 .restore = virtcrypto_restore,
534 module_virtio_driver(virtio_crypto_driver);
536 MODULE_DEVICE_TABLE(virtio, id_table);
537 MODULE_DESCRIPTION("virtio crypto device driver");
538 MODULE_LICENSE("GPL");
539 MODULE_AUTHOR("Gonglei <arei.gonglei@huawei.com>");