1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Driver for Virtio crypto device.
4 * Copyright 2016 HUAWEI TECHNOLOGIES CO., LTD.
8 #include <linux/module.h>
9 #include <linux/virtio_config.h>
10 #include <linux/cpu.h>
12 #include <uapi/linux/virtio_crypto.h>
13 #include "virtio_crypto_common.h"
17 virtcrypto_clear_request(struct virtio_crypto_request *vc_req)
20 kfree_sensitive(vc_req->req_data);
25 static void virtcrypto_dataq_callback(struct virtqueue *vq)
27 struct virtio_crypto *vcrypto = vq->vdev->priv;
28 struct virtio_crypto_request *vc_req;
31 unsigned int qid = vq->index;
33 spin_lock_irqsave(&vcrypto->data_vq[qid].lock, flags);
35 virtqueue_disable_cb(vq);
36 while ((vc_req = virtqueue_get_buf(vq, &len)) != NULL) {
37 spin_unlock_irqrestore(
38 &vcrypto->data_vq[qid].lock, flags);
40 vc_req->alg_cb(vc_req, len);
42 &vcrypto->data_vq[qid].lock, flags);
44 } while (!virtqueue_enable_cb(vq));
45 spin_unlock_irqrestore(&vcrypto->data_vq[qid].lock, flags);
48 static int virtcrypto_find_vqs(struct virtio_crypto *vi)
50 vq_callback_t **callbacks;
51 struct virtqueue **vqs;
55 struct device *dev = &vi->vdev->dev;
58 * We expect 1 data virtqueue, followed by
59 * possible N-1 data queues used in multiqueue mode,
60 * followed by control vq.
62 total_vqs = vi->max_data_queues + 1;
64 /* Allocate space for find_vqs parameters */
65 vqs = kcalloc(total_vqs, sizeof(*vqs), GFP_KERNEL);
68 callbacks = kcalloc(total_vqs, sizeof(*callbacks), GFP_KERNEL);
71 names = kcalloc(total_vqs, sizeof(*names), GFP_KERNEL);
75 /* Parameters for control virtqueue */
76 callbacks[total_vqs - 1] = NULL;
77 names[total_vqs - 1] = "controlq";
79 /* Allocate/initialize parameters for data virtqueues */
80 for (i = 0; i < vi->max_data_queues; i++) {
81 callbacks[i] = virtcrypto_dataq_callback;
82 snprintf(vi->data_vq[i].name, sizeof(vi->data_vq[i].name),
84 names[i] = vi->data_vq[i].name;
87 ret = virtio_find_vqs(vi->vdev, total_vqs, vqs, callbacks, names, NULL);
91 vi->ctrl_vq = vqs[total_vqs - 1];
93 for (i = 0; i < vi->max_data_queues; i++) {
94 spin_lock_init(&vi->data_vq[i].lock);
95 vi->data_vq[i].vq = vqs[i];
96 /* Initialize crypto engine */
97 vi->data_vq[i].engine = crypto_engine_alloc_init(dev, 1);
98 if (!vi->data_vq[i].engine) {
121 static int virtcrypto_alloc_queues(struct virtio_crypto *vi)
123 vi->data_vq = kcalloc(vi->max_data_queues, sizeof(*vi->data_vq),
131 static void virtcrypto_clean_affinity(struct virtio_crypto *vi, long hcpu)
135 if (vi->affinity_hint_set) {
136 for (i = 0; i < vi->max_data_queues; i++)
137 virtqueue_set_affinity(vi->data_vq[i].vq, NULL);
139 vi->affinity_hint_set = false;
143 static void virtcrypto_set_affinity(struct virtio_crypto *vcrypto)
149 * In single queue mode, we don't set the cpu affinity.
151 if (vcrypto->curr_queue == 1 || vcrypto->max_data_queues == 1) {
152 virtcrypto_clean_affinity(vcrypto, -1);
157 * In multiqueue mode, we let the queue to be private to one cpu
158 * by setting the affinity hint to eliminate the contention.
160 * TODO: adds cpu hotplug support by register cpu notifier.
163 for_each_online_cpu(cpu) {
164 virtqueue_set_affinity(vcrypto->data_vq[i].vq, cpumask_of(cpu));
165 if (++i >= vcrypto->max_data_queues)
169 vcrypto->affinity_hint_set = true;
172 static void virtcrypto_free_queues(struct virtio_crypto *vi)
177 static int virtcrypto_init_vqs(struct virtio_crypto *vi)
181 /* Allocate send & receive queues */
182 ret = virtcrypto_alloc_queues(vi);
186 ret = virtcrypto_find_vqs(vi);
191 virtcrypto_set_affinity(vi);
197 virtcrypto_free_queues(vi);
202 static int virtcrypto_update_status(struct virtio_crypto *vcrypto)
207 virtio_cread_le(vcrypto->vdev,
208 struct virtio_crypto_config, status, &status);
211 * Unknown status bits would be a host error and the driver
212 * should consider the device to be broken.
214 if (status & (~VIRTIO_CRYPTO_S_HW_READY)) {
215 dev_warn(&vcrypto->vdev->dev,
216 "Unknown status bits: 0x%x\n", status);
218 virtio_break_device(vcrypto->vdev);
222 if (vcrypto->status == status)
225 vcrypto->status = status;
227 if (vcrypto->status & VIRTIO_CRYPTO_S_HW_READY) {
228 err = virtcrypto_dev_start(vcrypto);
230 dev_err(&vcrypto->vdev->dev,
231 "Failed to start virtio crypto device.\n");
235 dev_info(&vcrypto->vdev->dev, "Accelerator device is ready\n");
237 virtcrypto_dev_stop(vcrypto);
238 dev_info(&vcrypto->vdev->dev, "Accelerator is not ready\n");
244 static int virtcrypto_start_crypto_engines(struct virtio_crypto *vcrypto)
249 for (i = 0; i < vcrypto->max_data_queues; i++) {
250 if (vcrypto->data_vq[i].engine) {
251 ret = crypto_engine_start(vcrypto->data_vq[i].engine);
261 if (vcrypto->data_vq[i].engine)
262 crypto_engine_exit(vcrypto->data_vq[i].engine);
267 static void virtcrypto_clear_crypto_engines(struct virtio_crypto *vcrypto)
271 for (i = 0; i < vcrypto->max_data_queues; i++)
272 if (vcrypto->data_vq[i].engine)
273 crypto_engine_exit(vcrypto->data_vq[i].engine);
276 static void virtcrypto_del_vqs(struct virtio_crypto *vcrypto)
278 struct virtio_device *vdev = vcrypto->vdev;
280 virtcrypto_clean_affinity(vcrypto, -1);
282 vdev->config->del_vqs(vdev);
284 virtcrypto_free_queues(vcrypto);
287 static int virtcrypto_probe(struct virtio_device *vdev)
290 struct virtio_crypto *vcrypto;
291 u32 max_data_queues = 0, max_cipher_key_len = 0;
292 u32 max_auth_key_len = 0;
294 u32 cipher_algo_l = 0;
295 u32 cipher_algo_h = 0;
300 u32 akcipher_algo = 0;
301 u32 crypto_services = 0;
303 if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1))
306 if (!vdev->config->get) {
307 dev_err(&vdev->dev, "%s failure: config access disabled\n",
312 if (num_possible_nodes() > 1 && dev_to_node(&vdev->dev) < 0) {
314 * If the accelerator is connected to a node with no memory
315 * there is no point in using the accelerator since the remote
316 * memory transaction will be very slow.
318 dev_err(&vdev->dev, "Invalid NUMA configuration.\n");
322 vcrypto = kzalloc_node(sizeof(*vcrypto), GFP_KERNEL,
323 dev_to_node(&vdev->dev));
327 virtio_cread_le(vdev, struct virtio_crypto_config,
328 max_dataqueues, &max_data_queues);
329 if (max_data_queues < 1)
332 virtio_cread_le(vdev, struct virtio_crypto_config,
333 max_cipher_key_len, &max_cipher_key_len);
334 virtio_cread_le(vdev, struct virtio_crypto_config,
335 max_auth_key_len, &max_auth_key_len);
336 virtio_cread_le(vdev, struct virtio_crypto_config,
337 max_size, &max_size);
338 virtio_cread_le(vdev, struct virtio_crypto_config,
339 crypto_services, &crypto_services);
340 virtio_cread_le(vdev, struct virtio_crypto_config,
341 cipher_algo_l, &cipher_algo_l);
342 virtio_cread_le(vdev, struct virtio_crypto_config,
343 cipher_algo_h, &cipher_algo_h);
344 virtio_cread_le(vdev, struct virtio_crypto_config,
345 hash_algo, &hash_algo);
346 virtio_cread_le(vdev, struct virtio_crypto_config,
347 mac_algo_l, &mac_algo_l);
348 virtio_cread_le(vdev, struct virtio_crypto_config,
349 mac_algo_h, &mac_algo_h);
350 virtio_cread_le(vdev, struct virtio_crypto_config,
351 aead_algo, &aead_algo);
352 if (crypto_services & (1 << VIRTIO_CRYPTO_SERVICE_AKCIPHER))
353 virtio_cread_le(vdev, struct virtio_crypto_config,
354 akcipher_algo, &akcipher_algo);
356 /* Add virtio crypto device to global table */
357 err = virtcrypto_devmgr_add_dev(vcrypto);
359 dev_err(&vdev->dev, "Failed to add new virtio crypto device.\n");
362 vcrypto->owner = THIS_MODULE;
363 vcrypto = vdev->priv = vcrypto;
364 vcrypto->vdev = vdev;
366 spin_lock_init(&vcrypto->ctrl_lock);
368 /* Use single data queue as default */
369 vcrypto->curr_queue = 1;
370 vcrypto->max_data_queues = max_data_queues;
371 vcrypto->max_cipher_key_len = max_cipher_key_len;
372 vcrypto->max_auth_key_len = max_auth_key_len;
373 vcrypto->max_size = max_size;
374 vcrypto->crypto_services = crypto_services;
375 vcrypto->cipher_algo_l = cipher_algo_l;
376 vcrypto->cipher_algo_h = cipher_algo_h;
377 vcrypto->mac_algo_l = mac_algo_l;
378 vcrypto->mac_algo_h = mac_algo_h;
379 vcrypto->hash_algo = hash_algo;
380 vcrypto->aead_algo = aead_algo;
381 vcrypto->akcipher_algo = akcipher_algo;
384 "max_queues: %u, max_cipher_key_len: %u, max_auth_key_len: %u, max_size 0x%llx\n",
385 vcrypto->max_data_queues,
386 vcrypto->max_cipher_key_len,
387 vcrypto->max_auth_key_len,
390 err = virtcrypto_init_vqs(vcrypto);
392 dev_err(&vdev->dev, "Failed to initialize vqs.\n");
396 err = virtcrypto_start_crypto_engines(vcrypto);
400 virtio_device_ready(vdev);
402 err = virtcrypto_update_status(vcrypto);
409 virtcrypto_clear_crypto_engines(vcrypto);
411 virtio_reset_device(vdev);
412 virtcrypto_del_vqs(vcrypto);
414 virtcrypto_devmgr_rm_dev(vcrypto);
420 static void virtcrypto_free_unused_reqs(struct virtio_crypto *vcrypto)
422 struct virtio_crypto_request *vc_req;
424 struct virtqueue *vq;
426 for (i = 0; i < vcrypto->max_data_queues; i++) {
427 vq = vcrypto->data_vq[i].vq;
428 while ((vc_req = virtqueue_detach_unused_buf(vq)) != NULL) {
429 kfree(vc_req->req_data);
435 static void virtcrypto_remove(struct virtio_device *vdev)
437 struct virtio_crypto *vcrypto = vdev->priv;
439 dev_info(&vdev->dev, "Start virtcrypto_remove.\n");
441 if (virtcrypto_dev_started(vcrypto))
442 virtcrypto_dev_stop(vcrypto);
443 virtio_reset_device(vdev);
444 virtcrypto_free_unused_reqs(vcrypto);
445 virtcrypto_clear_crypto_engines(vcrypto);
446 virtcrypto_del_vqs(vcrypto);
447 virtcrypto_devmgr_rm_dev(vcrypto);
451 static void virtcrypto_config_changed(struct virtio_device *vdev)
453 struct virtio_crypto *vcrypto = vdev->priv;
455 virtcrypto_update_status(vcrypto);
458 #ifdef CONFIG_PM_SLEEP
459 static int virtcrypto_freeze(struct virtio_device *vdev)
461 struct virtio_crypto *vcrypto = vdev->priv;
463 virtio_reset_device(vdev);
464 virtcrypto_free_unused_reqs(vcrypto);
465 if (virtcrypto_dev_started(vcrypto))
466 virtcrypto_dev_stop(vcrypto);
468 virtcrypto_clear_crypto_engines(vcrypto);
469 virtcrypto_del_vqs(vcrypto);
473 static int virtcrypto_restore(struct virtio_device *vdev)
475 struct virtio_crypto *vcrypto = vdev->priv;
478 err = virtcrypto_init_vqs(vcrypto);
482 err = virtcrypto_start_crypto_engines(vcrypto);
486 virtio_device_ready(vdev);
488 err = virtcrypto_dev_start(vcrypto);
490 dev_err(&vdev->dev, "Failed to start virtio crypto device.\n");
497 virtcrypto_clear_crypto_engines(vcrypto);
499 virtio_reset_device(vdev);
500 virtcrypto_del_vqs(vcrypto);
505 static const unsigned int features[] = {
509 static const struct virtio_device_id id_table[] = {
510 { VIRTIO_ID_CRYPTO, VIRTIO_DEV_ANY_ID },
514 static struct virtio_driver virtio_crypto_driver = {
515 .driver.name = KBUILD_MODNAME,
516 .driver.owner = THIS_MODULE,
517 .feature_table = features,
518 .feature_table_size = ARRAY_SIZE(features),
519 .id_table = id_table,
520 .probe = virtcrypto_probe,
521 .remove = virtcrypto_remove,
522 .config_changed = virtcrypto_config_changed,
523 #ifdef CONFIG_PM_SLEEP
524 .freeze = virtcrypto_freeze,
525 .restore = virtcrypto_restore,
529 module_virtio_driver(virtio_crypto_driver);
531 MODULE_DEVICE_TABLE(virtio, id_table);
532 MODULE_DESCRIPTION("virtio crypto device driver");
533 MODULE_LICENSE("GPL");
534 MODULE_AUTHOR("Gonglei <arei.gonglei@huawei.com>");