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/engine.h>
28 
29 
30 /* Internal representation of a data virtqueue */
31 struct data_queue {
32 	/* Virtqueue associated with this send _queue */
33 	struct virtqueue *vq;
34 
35 	/* To protect the vq operations for the dataq */
36 	spinlock_t lock;
37 
38 	/* Name of the tx queue: dataq.$index */
39 	char name[32];
40 
41 	struct crypto_engine *engine;
42 };
43 
44 struct virtio_crypto {
45 	struct virtio_device *vdev;
46 	struct virtqueue *ctrl_vq;
47 	struct data_queue *data_vq;
48 
49 	/* To protect the vq operations for the controlq */
50 	spinlock_t ctrl_lock;
51 
52 	/* Maximum of data queues supported by the device */
53 	u32 max_data_queues;
54 
55 	/* Number of queue currently used by the driver */
56 	u32 curr_queue;
57 
58 	/*
59 	 * Specifies the services mask which the device support,
60 	 * see VIRTIO_CRYPTO_SERVICE_*
61 	 */
62 	u32 crypto_services;
63 
64 	/* Detailed algorithms mask */
65 	u32 cipher_algo_l;
66 	u32 cipher_algo_h;
67 	u32 hash_algo;
68 	u32 mac_algo_l;
69 	u32 mac_algo_h;
70 	u32 aead_algo;
71 
72 	/* Maximum length of cipher key */
73 	u32 max_cipher_key_len;
74 	/* Maximum length of authenticated key */
75 	u32 max_auth_key_len;
76 	/* Maximum size of per request */
77 	u64 max_size;
78 
79 	/* Control VQ buffers: protected by the ctrl_lock */
80 	struct virtio_crypto_op_ctrl_req ctrl;
81 	struct virtio_crypto_session_input input;
82 	struct virtio_crypto_inhdr ctrl_status;
83 
84 	unsigned long status;
85 	atomic_t ref_count;
86 	struct list_head list;
87 	struct module *owner;
88 	uint8_t dev_id;
89 
90 	/* Does the affinity hint is set for virtqueues? */
91 	bool affinity_hint_set;
92 };
93 
94 struct virtio_crypto_sym_session_info {
95 	/* Backend session id, which come from the host side */
96 	__u64 session_id;
97 };
98 
99 struct virtio_crypto_request;
100 typedef void (*virtio_crypto_data_callback)
101 		(struct virtio_crypto_request *vc_req, int len);
102 
103 struct virtio_crypto_request {
104 	uint8_t status;
105 	struct virtio_crypto_op_data_req *req_data;
106 	struct scatterlist **sgs;
107 	struct data_queue *dataq;
108 	virtio_crypto_data_callback alg_cb;
109 };
110 
111 int virtcrypto_devmgr_add_dev(struct virtio_crypto *vcrypto_dev);
112 struct list_head *virtcrypto_devmgr_get_head(void);
113 void virtcrypto_devmgr_rm_dev(struct virtio_crypto *vcrypto_dev);
114 struct virtio_crypto *virtcrypto_devmgr_get_first(void);
115 int virtcrypto_dev_in_use(struct virtio_crypto *vcrypto_dev);
116 int virtcrypto_dev_get(struct virtio_crypto *vcrypto_dev);
117 void virtcrypto_dev_put(struct virtio_crypto *vcrypto_dev);
118 int virtcrypto_dev_started(struct virtio_crypto *vcrypto_dev);
119 bool virtcrypto_algo_is_supported(struct virtio_crypto *vcrypto_dev,
120 				  uint32_t service,
121 				  uint32_t algo);
122 struct virtio_crypto *virtcrypto_get_dev_node(int node,
123 					      uint32_t service,
124 					      uint32_t algo);
125 int virtcrypto_dev_start(struct virtio_crypto *vcrypto);
126 void virtcrypto_dev_stop(struct virtio_crypto *vcrypto);
127 int virtio_crypto_ablkcipher_crypt_req(
128 	struct crypto_engine *engine, void *vreq);
129 
130 void
131 virtcrypto_clear_request(struct virtio_crypto_request *vc_req);
132 
133 static inline int virtio_crypto_get_current_node(void)
134 {
135 	int cpu, node;
136 
137 	cpu = get_cpu();
138 	node = topology_physical_package_id(cpu);
139 	put_cpu();
140 
141 	return node;
142 }
143 
144 int virtio_crypto_algs_register(struct virtio_crypto *vcrypto);
145 void virtio_crypto_algs_unregister(struct virtio_crypto *vcrypto);
146 
147 #endif /* _VIRTIO_CRYPTO_COMMON_H */
148