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;
69 virtcrypto_clear_request(vc_req);
71 spin_unlock_irqrestore(
72 &vcrypto->data_vq[qid].lock, flags);
73 /* Finish the encrypt or decrypt process */
74 ablk_req->base.complete(&ablk_req->base, error);
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;
92 * We expect 1 data virtqueue, followed by
93 * possible N-1 data queues used in multiqueue mode,
94 * followed by control vq.
96 total_vqs = vi->max_data_queues + 1;
98 /* Allocate space for find_vqs parameters */
99 vqs = kcalloc(total_vqs, sizeof(*vqs), GFP_KERNEL);
102 callbacks = kcalloc(total_vqs, sizeof(*callbacks), GFP_KERNEL);
105 names = kcalloc(total_vqs, sizeof(*names), GFP_KERNEL);
109 /* Parameters for control virtqueue */
110 callbacks[total_vqs - 1] = NULL;
111 names[total_vqs - 1] = "controlq";
113 /* Allocate/initialize parameters for data virtqueues */
114 for (i = 0; i < vi->max_data_queues; i++) {
115 callbacks[i] = virtcrypto_dataq_callback;
116 snprintf(vi->data_vq[i].name, sizeof(vi->data_vq[i].name),
118 names[i] = vi->data_vq[i].name;
121 ret = vi->vdev->config->find_vqs(vi->vdev, total_vqs, vqs, callbacks,
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];
149 static int virtcrypto_alloc_queues(struct virtio_crypto *vi)
151 vi->data_vq = kcalloc(vi->max_data_queues, sizeof(*vi->data_vq),
159 static void virtcrypto_clean_affinity(struct virtio_crypto *vi, long hcpu)
163 if (vi->affinity_hint_set) {
164 for (i = 0; i < vi->max_data_queues; i++)
165 virtqueue_set_affinity(vi->data_vq[i].vq, -1);
167 vi->affinity_hint_set = false;
171 static void virtcrypto_set_affinity(struct virtio_crypto *vcrypto)
177 * In single queue mode, we don't set the cpu affinity.
179 if (vcrypto->curr_queue == 1 || vcrypto->max_data_queues == 1) {
180 virtcrypto_clean_affinity(vcrypto, -1);
185 * In multiqueue mode, we let the queue to be private to one cpu
186 * by setting the affinity hint to eliminate the contention.
188 * TODO: adds cpu hotplug support by register cpu notifier.
191 for_each_online_cpu(cpu) {
192 virtqueue_set_affinity(vcrypto->data_vq[i].vq, cpu);
193 if (++i >= vcrypto->max_data_queues)
197 vcrypto->affinity_hint_set = true;
200 static void virtcrypto_free_queues(struct virtio_crypto *vi)
205 static int virtcrypto_init_vqs(struct virtio_crypto *vi)
209 /* Allocate send & receive queues */
210 ret = virtcrypto_alloc_queues(vi);
214 ret = virtcrypto_find_vqs(vi);
219 virtcrypto_set_affinity(vi);
225 virtcrypto_free_queues(vi);
230 static int virtcrypto_update_status(struct virtio_crypto *vcrypto)
235 virtio_cread(vcrypto->vdev,
236 struct virtio_crypto_config, status, &status);
239 * Unknown status bits would be a host error and the driver
240 * should consider the device to be broken.
242 if (status & (~VIRTIO_CRYPTO_S_HW_READY)) {
243 dev_warn(&vcrypto->vdev->dev,
244 "Unknown status bits: 0x%x\n", status);
246 virtio_break_device(vcrypto->vdev);
250 if (vcrypto->status == status)
253 vcrypto->status = status;
255 if (vcrypto->status & VIRTIO_CRYPTO_S_HW_READY) {
256 err = virtcrypto_dev_start(vcrypto);
258 dev_err(&vcrypto->vdev->dev,
259 "Failed to start virtio crypto device.\n");
263 dev_info(&vcrypto->vdev->dev, "Accelerator is ready\n");
265 virtcrypto_dev_stop(vcrypto);
266 dev_info(&vcrypto->vdev->dev, "Accelerator is not ready\n");
272 static void virtcrypto_del_vqs(struct virtio_crypto *vcrypto)
274 struct virtio_device *vdev = vcrypto->vdev;
276 virtcrypto_clean_affinity(vcrypto, -1);
278 vdev->config->del_vqs(vdev);
280 virtcrypto_free_queues(vcrypto);
283 static int virtcrypto_probe(struct virtio_device *vdev)
286 struct virtio_crypto *vcrypto;
287 u32 max_data_queues = 0, max_cipher_key_len = 0;
288 u32 max_auth_key_len = 0;
291 if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1))
294 if (!vdev->config->get) {
295 dev_err(&vdev->dev, "%s failure: config access disabled\n",
300 if (num_possible_nodes() > 1 && dev_to_node(&vdev->dev) < 0) {
302 * If the accelerator is connected to a node with no memory
303 * there is no point in using the accelerator since the remote
304 * memory transaction will be very slow.
306 dev_err(&vdev->dev, "Invalid NUMA configuration.\n");
310 vcrypto = kzalloc_node(sizeof(*vcrypto), GFP_KERNEL,
311 dev_to_node(&vdev->dev));
315 virtio_cread(vdev, struct virtio_crypto_config,
316 max_dataqueues, &max_data_queues);
317 if (max_data_queues < 1)
320 virtio_cread(vdev, struct virtio_crypto_config,
321 max_cipher_key_len, &max_cipher_key_len);
322 virtio_cread(vdev, struct virtio_crypto_config,
323 max_auth_key_len, &max_auth_key_len);
324 virtio_cread(vdev, struct virtio_crypto_config,
325 max_size, &max_size);
327 /* Add virtio crypto device to global table */
328 err = virtcrypto_devmgr_add_dev(vcrypto);
330 dev_err(&vdev->dev, "Failed to add new virtio crypto device.\n");
333 vcrypto->owner = THIS_MODULE;
334 vcrypto = vdev->priv = vcrypto;
335 vcrypto->vdev = vdev;
337 spin_lock_init(&vcrypto->ctrl_lock);
339 /* Use single data queue as default */
340 vcrypto->curr_queue = 1;
341 vcrypto->max_data_queues = max_data_queues;
342 vcrypto->max_cipher_key_len = max_cipher_key_len;
343 vcrypto->max_auth_key_len = max_auth_key_len;
344 vcrypto->max_size = max_size;
347 "max_queues: %u, max_cipher_key_len: %u, max_auth_key_len: %u, max_size 0x%llx\n",
348 vcrypto->max_data_queues,
349 vcrypto->max_cipher_key_len,
350 vcrypto->max_auth_key_len,
353 err = virtcrypto_init_vqs(vcrypto);
355 dev_err(&vdev->dev, "Failed to initialize vqs.\n");
358 virtio_device_ready(vdev);
360 err = virtcrypto_update_status(vcrypto);
367 vcrypto->vdev->config->reset(vdev);
368 virtcrypto_del_vqs(vcrypto);
370 virtcrypto_devmgr_rm_dev(vcrypto);
376 static void virtcrypto_free_unused_reqs(struct virtio_crypto *vcrypto)
378 struct virtio_crypto_request *vc_req;
380 struct virtqueue *vq;
382 for (i = 0; i < vcrypto->max_data_queues; i++) {
383 vq = vcrypto->data_vq[i].vq;
384 while ((vc_req = virtqueue_detach_unused_buf(vq)) != NULL) {
385 kfree(vc_req->req_data);
391 static void virtcrypto_remove(struct virtio_device *vdev)
393 struct virtio_crypto *vcrypto = vdev->priv;
395 dev_info(&vdev->dev, "Start virtcrypto_remove.\n");
397 if (virtcrypto_dev_started(vcrypto))
398 virtcrypto_dev_stop(vcrypto);
399 vdev->config->reset(vdev);
400 virtcrypto_free_unused_reqs(vcrypto);
401 virtcrypto_del_vqs(vcrypto);
402 virtcrypto_devmgr_rm_dev(vcrypto);
406 static void virtcrypto_config_changed(struct virtio_device *vdev)
408 struct virtio_crypto *vcrypto = vdev->priv;
410 virtcrypto_update_status(vcrypto);
413 #ifdef CONFIG_PM_SLEEP
414 static int virtcrypto_freeze(struct virtio_device *vdev)
416 struct virtio_crypto *vcrypto = vdev->priv;
418 vdev->config->reset(vdev);
419 virtcrypto_free_unused_reqs(vcrypto);
420 if (virtcrypto_dev_started(vcrypto))
421 virtcrypto_dev_stop(vcrypto);
423 virtcrypto_del_vqs(vcrypto);
427 static int virtcrypto_restore(struct virtio_device *vdev)
429 struct virtio_crypto *vcrypto = vdev->priv;
432 err = virtcrypto_init_vqs(vcrypto);
436 virtio_device_ready(vdev);
437 err = virtcrypto_dev_start(vcrypto);
439 dev_err(&vdev->dev, "Failed to start virtio crypto device.\n");
447 static unsigned int features[] = {
451 static struct virtio_device_id id_table[] = {
452 { VIRTIO_ID_CRYPTO, VIRTIO_DEV_ANY_ID },
456 static struct virtio_driver virtio_crypto_driver = {
457 .driver.name = KBUILD_MODNAME,
458 .driver.owner = THIS_MODULE,
459 .feature_table = features,
460 .feature_table_size = ARRAY_SIZE(features),
461 .id_table = id_table,
462 .probe = virtcrypto_probe,
463 .remove = virtcrypto_remove,
464 .config_changed = virtcrypto_config_changed,
465 #ifdef CONFIG_PM_SLEEP
466 .freeze = virtcrypto_freeze,
467 .restore = virtcrypto_restore,
471 module_virtio_driver(virtio_crypto_driver);
473 MODULE_DEVICE_TABLE(virtio, id_table);
474 MODULE_DESCRIPTION("virtio crypto device driver");
475 MODULE_LICENSE("GPL");
476 MODULE_AUTHOR("Gonglei <arei.gonglei@huawei.com>");