1 /* Common header for Virtio crypto device.
2  *
3  * Copyright 2016 HUAWEI TECHNOLOGIES CO., LTD.
4  *
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.
9  *
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.
14  *
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/>.
17  */
18 
19 #ifndef _VIRTIO_CRYPTO_COMMON_H
20 #define _VIRTIO_CRYPTO_COMMON_H
21 
22 #include <linux/virtio.h>
23 #include <linux/crypto.h>
24 #include <linux/spinlock.h>
25 #include <crypto/aead.h>
26 #include <crypto/aes.h>
27 #include <crypto/authenc.h>
28 #include <crypto/engine.h>
29 
30 
31 /* Internal representation of a data virtqueue */
32 struct data_queue {
33 	/* Virtqueue associated with this send _queue */
34 	struct virtqueue *vq;
35 
36 	/* To protect the vq operations for the dataq */
37 	spinlock_t lock;
38 
39 	/* Name of the tx queue: dataq.$index */
40 	char name[32];
41 
42 	struct crypto_engine *engine;
43 };
44 
45 struct virtio_crypto {
46 	struct virtio_device *vdev;
47 	struct virtqueue *ctrl_vq;
48 	struct data_queue *data_vq;
49 
50 	/* To protect the vq operations for the controlq */
51 	spinlock_t ctrl_lock;
52 
53 	/* Maximum of data queues supported by the device */
54 	u32 max_data_queues;
55 
56 	/* Number of queue currently used by the driver */
57 	u32 curr_queue;
58 
59 	/* Maximum length of cipher key */
60 	u32 max_cipher_key_len;
61 	/* Maximum length of authenticated key */
62 	u32 max_auth_key_len;
63 	/* Maximum size of per request */
64 	u64 max_size;
65 
66 	/* Control VQ buffers: protected by the ctrl_lock */
67 	struct virtio_crypto_op_ctrl_req ctrl;
68 	struct virtio_crypto_session_input input;
69 	struct virtio_crypto_inhdr ctrl_status;
70 
71 	unsigned long status;
72 	atomic_t ref_count;
73 	struct list_head list;
74 	struct module *owner;
75 	uint8_t dev_id;
76 
77 	/* Does the affinity hint is set for virtqueues? */
78 	bool affinity_hint_set;
79 };
80 
81 struct virtio_crypto_sym_session_info {
82 	/* Backend session id, which come from the host side */
83 	__u64 session_id;
84 };
85 
86 struct virtio_crypto_ablkcipher_ctx {
87 	struct virtio_crypto *vcrypto;
88 	struct crypto_tfm *tfm;
89 
90 	struct virtio_crypto_sym_session_info enc_sess_info;
91 	struct virtio_crypto_sym_session_info dec_sess_info;
92 };
93 
94 struct virtio_crypto_request {
95 	/* Cipher or aead */
96 	uint32_t type;
97 	uint8_t status;
98 	struct virtio_crypto_ablkcipher_ctx *ablkcipher_ctx;
99 	struct ablkcipher_request *ablkcipher_req;
100 	struct virtio_crypto_op_data_req *req_data;
101 	struct scatterlist **sgs;
102 	uint8_t *iv;
103 	/* Encryption? */
104 	bool encrypt;
105 	struct data_queue *dataq;
106 };
107 
108 int virtcrypto_devmgr_add_dev(struct virtio_crypto *vcrypto_dev);
109 struct list_head *virtcrypto_devmgr_get_head(void);
110 void virtcrypto_devmgr_rm_dev(struct virtio_crypto *vcrypto_dev);
111 struct virtio_crypto *virtcrypto_devmgr_get_first(void);
112 int virtcrypto_dev_in_use(struct virtio_crypto *vcrypto_dev);
113 int virtcrypto_dev_get(struct virtio_crypto *vcrypto_dev);
114 void virtcrypto_dev_put(struct virtio_crypto *vcrypto_dev);
115 int virtcrypto_dev_started(struct virtio_crypto *vcrypto_dev);
116 struct virtio_crypto *virtcrypto_get_dev_node(int node);
117 int virtcrypto_dev_start(struct virtio_crypto *vcrypto);
118 void virtcrypto_dev_stop(struct virtio_crypto *vcrypto);
119 int virtio_crypto_ablkcipher_crypt_req(
120 	struct crypto_engine *engine,
121 	struct ablkcipher_request *req);
122 void virtio_crypto_ablkcipher_finalize_req(
123 	struct virtio_crypto_request *vc_req,
124 	struct ablkcipher_request *req,
125 	int err);
126 
127 void
128 virtcrypto_clear_request(struct virtio_crypto_request *vc_req);
129 
130 static inline int virtio_crypto_get_current_node(void)
131 {
132 	int cpu, node;
133 
134 	cpu = get_cpu();
135 	node = topology_physical_package_id(cpu);
136 	put_cpu();
137 
138 	return node;
139 }
140 
141 int virtio_crypto_algs_register(void);
142 void virtio_crypto_algs_unregister(void);
143 
144 #endif /* _VIRTIO_CRYPTO_COMMON_H */
145