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)
32 kzfree(vc_req->req_data);
37 static void virtcrypto_done_task(unsigned long data)
39 struct data_queue *data_vq = (struct data_queue *)data;
40 struct virtqueue *vq = data_vq->vq;
41 struct virtio_crypto_request *vc_req;
45 virtqueue_disable_cb(vq);
46 while ((vc_req = virtqueue_get_buf(vq, &len)) != NULL) {
48 vc_req->alg_cb(vc_req, len);
50 } while (!virtqueue_enable_cb(vq));
53 static void virtcrypto_dataq_callback(struct virtqueue *vq)
55 struct virtio_crypto *vcrypto = vq->vdev->priv;
56 struct data_queue *dq = &vcrypto->data_vq[vq->index];
58 tasklet_schedule(&dq->done_task);
61 static int virtcrypto_find_vqs(struct virtio_crypto *vi)
63 vq_callback_t **callbacks;
64 struct virtqueue **vqs;
68 struct device *dev = &vi->vdev->dev;
71 * We expect 1 data virtqueue, followed by
72 * possible N-1 data queues used in multiqueue mode,
73 * followed by control vq.
75 total_vqs = vi->max_data_queues + 1;
77 /* Allocate space for find_vqs parameters */
78 vqs = kcalloc(total_vqs, sizeof(*vqs), GFP_KERNEL);
81 callbacks = kcalloc(total_vqs, sizeof(*callbacks), GFP_KERNEL);
84 names = kcalloc(total_vqs, sizeof(*names), GFP_KERNEL);
88 /* Parameters for control virtqueue */
89 callbacks[total_vqs - 1] = NULL;
90 names[total_vqs - 1] = "controlq";
92 /* Allocate/initialize parameters for data virtqueues */
93 for (i = 0; i < vi->max_data_queues; i++) {
94 callbacks[i] = virtcrypto_dataq_callback;
95 snprintf(vi->data_vq[i].name, sizeof(vi->data_vq[i].name),
97 names[i] = vi->data_vq[i].name;
100 ret = virtio_find_vqs(vi->vdev, total_vqs, vqs, callbacks, names, NULL);
104 vi->ctrl_vq = vqs[total_vqs - 1];
106 for (i = 0; i < vi->max_data_queues; i++) {
107 spin_lock_init(&vi->data_vq[i].lock);
108 vi->data_vq[i].vq = vqs[i];
109 /* Initialize crypto engine */
110 vi->data_vq[i].engine = crypto_engine_alloc_init(dev, 1);
111 if (!vi->data_vq[i].engine) {
115 tasklet_init(&vi->data_vq[i].done_task, virtcrypto_done_task,
116 (unsigned long)&vi->data_vq[i]);
136 static int virtcrypto_alloc_queues(struct virtio_crypto *vi)
138 vi->data_vq = kcalloc(vi->max_data_queues, sizeof(*vi->data_vq),
146 static void virtcrypto_clean_affinity(struct virtio_crypto *vi, long hcpu)
150 if (vi->affinity_hint_set) {
151 for (i = 0; i < vi->max_data_queues; i++)
152 virtqueue_set_affinity(vi->data_vq[i].vq, NULL);
154 vi->affinity_hint_set = false;
158 static void virtcrypto_set_affinity(struct virtio_crypto *vcrypto)
164 * In single queue mode, we don't set the cpu affinity.
166 if (vcrypto->curr_queue == 1 || vcrypto->max_data_queues == 1) {
167 virtcrypto_clean_affinity(vcrypto, -1);
172 * In multiqueue mode, we let the queue to be private to one cpu
173 * by setting the affinity hint to eliminate the contention.
175 * TODO: adds cpu hotplug support by register cpu notifier.
178 for_each_online_cpu(cpu) {
179 virtqueue_set_affinity(vcrypto->data_vq[i].vq, cpumask_of(cpu));
180 if (++i >= vcrypto->max_data_queues)
184 vcrypto->affinity_hint_set = true;
187 static void virtcrypto_free_queues(struct virtio_crypto *vi)
192 static int virtcrypto_init_vqs(struct virtio_crypto *vi)
196 /* Allocate send & receive queues */
197 ret = virtcrypto_alloc_queues(vi);
201 ret = virtcrypto_find_vqs(vi);
206 virtcrypto_set_affinity(vi);
212 virtcrypto_free_queues(vi);
217 static int virtcrypto_update_status(struct virtio_crypto *vcrypto)
222 virtio_cread(vcrypto->vdev,
223 struct virtio_crypto_config, status, &status);
226 * Unknown status bits would be a host error and the driver
227 * should consider the device to be broken.
229 if (status & (~VIRTIO_CRYPTO_S_HW_READY)) {
230 dev_warn(&vcrypto->vdev->dev,
231 "Unknown status bits: 0x%x\n", status);
233 virtio_break_device(vcrypto->vdev);
237 if (vcrypto->status == status)
240 vcrypto->status = status;
242 if (vcrypto->status & VIRTIO_CRYPTO_S_HW_READY) {
243 err = virtcrypto_dev_start(vcrypto);
245 dev_err(&vcrypto->vdev->dev,
246 "Failed to start virtio crypto device.\n");
250 dev_info(&vcrypto->vdev->dev, "Accelerator device is ready\n");
252 virtcrypto_dev_stop(vcrypto);
253 dev_info(&vcrypto->vdev->dev, "Accelerator is not ready\n");
259 static int virtcrypto_start_crypto_engines(struct virtio_crypto *vcrypto)
264 for (i = 0; i < vcrypto->max_data_queues; i++) {
265 if (vcrypto->data_vq[i].engine) {
266 ret = crypto_engine_start(vcrypto->data_vq[i].engine);
276 if (vcrypto->data_vq[i].engine)
277 crypto_engine_exit(vcrypto->data_vq[i].engine);
282 static void virtcrypto_clear_crypto_engines(struct virtio_crypto *vcrypto)
286 for (i = 0; i < vcrypto->max_data_queues; i++)
287 if (vcrypto->data_vq[i].engine)
288 crypto_engine_exit(vcrypto->data_vq[i].engine);
291 static void virtcrypto_del_vqs(struct virtio_crypto *vcrypto)
293 struct virtio_device *vdev = vcrypto->vdev;
295 virtcrypto_clean_affinity(vcrypto, -1);
297 vdev->config->del_vqs(vdev);
299 virtcrypto_free_queues(vcrypto);
302 static int virtcrypto_probe(struct virtio_device *vdev)
305 struct virtio_crypto *vcrypto;
306 u32 max_data_queues = 0, max_cipher_key_len = 0;
307 u32 max_auth_key_len = 0;
309 u32 cipher_algo_l = 0;
310 u32 cipher_algo_h = 0;
315 u32 crypto_services = 0;
317 if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1))
320 if (!vdev->config->get) {
321 dev_err(&vdev->dev, "%s failure: config access disabled\n",
326 if (num_possible_nodes() > 1 && dev_to_node(&vdev->dev) < 0) {
328 * If the accelerator is connected to a node with no memory
329 * there is no point in using the accelerator since the remote
330 * memory transaction will be very slow.
332 dev_err(&vdev->dev, "Invalid NUMA configuration.\n");
336 vcrypto = kzalloc_node(sizeof(*vcrypto), GFP_KERNEL,
337 dev_to_node(&vdev->dev));
341 virtio_cread(vdev, struct virtio_crypto_config,
342 max_dataqueues, &max_data_queues);
343 if (max_data_queues < 1)
346 virtio_cread(vdev, struct virtio_crypto_config,
347 max_cipher_key_len, &max_cipher_key_len);
348 virtio_cread(vdev, struct virtio_crypto_config,
349 max_auth_key_len, &max_auth_key_len);
350 virtio_cread(vdev, struct virtio_crypto_config,
351 max_size, &max_size);
352 virtio_cread(vdev, struct virtio_crypto_config,
353 crypto_services, &crypto_services);
354 virtio_cread(vdev, struct virtio_crypto_config,
355 cipher_algo_l, &cipher_algo_l);
356 virtio_cread(vdev, struct virtio_crypto_config,
357 cipher_algo_h, &cipher_algo_h);
358 virtio_cread(vdev, struct virtio_crypto_config,
359 hash_algo, &hash_algo);
360 virtio_cread(vdev, struct virtio_crypto_config,
361 mac_algo_l, &mac_algo_l);
362 virtio_cread(vdev, struct virtio_crypto_config,
363 mac_algo_h, &mac_algo_h);
364 virtio_cread(vdev, struct virtio_crypto_config,
365 aead_algo, &aead_algo);
367 /* Add virtio crypto device to global table */
368 err = virtcrypto_devmgr_add_dev(vcrypto);
370 dev_err(&vdev->dev, "Failed to add new virtio crypto device.\n");
373 vcrypto->owner = THIS_MODULE;
374 vcrypto = vdev->priv = vcrypto;
375 vcrypto->vdev = vdev;
377 spin_lock_init(&vcrypto->ctrl_lock);
379 /* Use single data queue as default */
380 vcrypto->curr_queue = 1;
381 vcrypto->max_data_queues = max_data_queues;
382 vcrypto->max_cipher_key_len = max_cipher_key_len;
383 vcrypto->max_auth_key_len = max_auth_key_len;
384 vcrypto->max_size = max_size;
385 vcrypto->crypto_services = crypto_services;
386 vcrypto->cipher_algo_l = cipher_algo_l;
387 vcrypto->cipher_algo_h = cipher_algo_h;
388 vcrypto->mac_algo_l = mac_algo_l;
389 vcrypto->mac_algo_h = mac_algo_h;
390 vcrypto->hash_algo = hash_algo;
391 vcrypto->aead_algo = aead_algo;
395 "max_queues: %u, max_cipher_key_len: %u, max_auth_key_len: %u, max_size 0x%llx\n",
396 vcrypto->max_data_queues,
397 vcrypto->max_cipher_key_len,
398 vcrypto->max_auth_key_len,
401 err = virtcrypto_init_vqs(vcrypto);
403 dev_err(&vdev->dev, "Failed to initialize vqs.\n");
407 err = virtcrypto_start_crypto_engines(vcrypto);
411 virtio_device_ready(vdev);
413 err = virtcrypto_update_status(vcrypto);
420 virtcrypto_clear_crypto_engines(vcrypto);
422 vcrypto->vdev->config->reset(vdev);
423 virtcrypto_del_vqs(vcrypto);
425 virtcrypto_devmgr_rm_dev(vcrypto);
431 static void virtcrypto_free_unused_reqs(struct virtio_crypto *vcrypto)
433 struct virtio_crypto_request *vc_req;
435 struct virtqueue *vq;
437 for (i = 0; i < vcrypto->max_data_queues; i++) {
438 vq = vcrypto->data_vq[i].vq;
439 while ((vc_req = virtqueue_detach_unused_buf(vq)) != NULL) {
440 kfree(vc_req->req_data);
446 static void virtcrypto_remove(struct virtio_device *vdev)
448 struct virtio_crypto *vcrypto = vdev->priv;
451 dev_info(&vdev->dev, "Start virtcrypto_remove.\n");
453 if (virtcrypto_dev_started(vcrypto))
454 virtcrypto_dev_stop(vcrypto);
455 for (i = 0; i < vcrypto->max_data_queues; i++)
456 tasklet_kill(&vcrypto->data_vq[i].done_task);
457 vdev->config->reset(vdev);
458 virtcrypto_free_unused_reqs(vcrypto);
459 virtcrypto_clear_crypto_engines(vcrypto);
460 virtcrypto_del_vqs(vcrypto);
461 virtcrypto_devmgr_rm_dev(vcrypto);
465 static void virtcrypto_config_changed(struct virtio_device *vdev)
467 struct virtio_crypto *vcrypto = vdev->priv;
469 virtcrypto_update_status(vcrypto);
472 #ifdef CONFIG_PM_SLEEP
473 static int virtcrypto_freeze(struct virtio_device *vdev)
475 struct virtio_crypto *vcrypto = vdev->priv;
477 vdev->config->reset(vdev);
478 virtcrypto_free_unused_reqs(vcrypto);
479 if (virtcrypto_dev_started(vcrypto))
480 virtcrypto_dev_stop(vcrypto);
482 virtcrypto_clear_crypto_engines(vcrypto);
483 virtcrypto_del_vqs(vcrypto);
487 static int virtcrypto_restore(struct virtio_device *vdev)
489 struct virtio_crypto *vcrypto = vdev->priv;
492 err = virtcrypto_init_vqs(vcrypto);
496 err = virtcrypto_start_crypto_engines(vcrypto);
500 virtio_device_ready(vdev);
502 err = virtcrypto_dev_start(vcrypto);
504 dev_err(&vdev->dev, "Failed to start virtio crypto device.\n");
511 virtcrypto_clear_crypto_engines(vcrypto);
513 vcrypto->vdev->config->reset(vdev);
514 virtcrypto_del_vqs(vcrypto);
519 static unsigned int features[] = {
523 static struct virtio_device_id id_table[] = {
524 { VIRTIO_ID_CRYPTO, VIRTIO_DEV_ANY_ID },
528 static struct virtio_driver virtio_crypto_driver = {
529 .driver.name = KBUILD_MODNAME,
530 .driver.owner = THIS_MODULE,
531 .feature_table = features,
532 .feature_table_size = ARRAY_SIZE(features),
533 .id_table = id_table,
534 .probe = virtcrypto_probe,
535 .remove = virtcrypto_remove,
536 .config_changed = virtcrypto_config_changed,
537 #ifdef CONFIG_PM_SLEEP
538 .freeze = virtcrypto_freeze,
539 .restore = virtcrypto_restore,
543 module_virtio_driver(virtio_crypto_driver);
545 MODULE_DEVICE_TABLE(virtio, id_table);
546 MODULE_DESCRIPTION("virtio crypto device driver");
547 MODULE_LICENSE("GPL");
548 MODULE_AUTHOR("Gonglei <arei.gonglei@huawei.com>");