1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* Common header for Virtio crypto device.
3  *
4  * Copyright 2016 HUAWEI TECHNOLOGIES CO., LTD.
5  */
6 
7 #ifndef _VIRTIO_CRYPTO_COMMON_H
8 #define _VIRTIO_CRYPTO_COMMON_H
9 
10 #include <linux/virtio.h>
11 #include <linux/crypto.h>
12 #include <linux/spinlock.h>
13 #include <crypto/aead.h>
14 #include <crypto/aes.h>
15 #include <crypto/engine.h>
16 #include <uapi/linux/virtio_crypto.h>
17 
18 
19 /* Internal representation of a data virtqueue */
20 struct data_queue {
21 	/* Virtqueue associated with this send _queue */
22 	struct virtqueue *vq;
23 
24 	/* To protect the vq operations for the dataq */
25 	spinlock_t lock;
26 
27 	/* Name of the tx queue: dataq.$index */
28 	char name[32];
29 
30 	struct crypto_engine *engine;
31 };
32 
33 struct virtio_crypto {
34 	struct virtio_device *vdev;
35 	struct virtqueue *ctrl_vq;
36 	struct data_queue *data_vq;
37 
38 	/* To protect the vq operations for the controlq */
39 	spinlock_t ctrl_lock;
40 
41 	/* Maximum of data queues supported by the device */
42 	u32 max_data_queues;
43 
44 	/* Number of queue currently used by the driver */
45 	u32 curr_queue;
46 
47 	/*
48 	 * Specifies the services mask which the device support,
49 	 * see VIRTIO_CRYPTO_SERVICE_*
50 	 */
51 	u32 crypto_services;
52 
53 	/* Detailed algorithms mask */
54 	u32 cipher_algo_l;
55 	u32 cipher_algo_h;
56 	u32 hash_algo;
57 	u32 mac_algo_l;
58 	u32 mac_algo_h;
59 	u32 aead_algo;
60 	u32 akcipher_algo;
61 
62 	/* Maximum length of cipher key */
63 	u32 max_cipher_key_len;
64 	/* Maximum length of authenticated key */
65 	u32 max_auth_key_len;
66 	/* Maximum size of per request */
67 	u64 max_size;
68 
69 	unsigned long status;
70 	atomic_t ref_count;
71 	struct list_head list;
72 	struct module *owner;
73 	uint8_t dev_id;
74 
75 	/* Does the affinity hint is set for virtqueues? */
76 	bool affinity_hint_set;
77 };
78 
79 struct virtio_crypto_sym_session_info {
80 	/* Backend session id, which come from the host side */
81 	__u64 session_id;
82 };
83 
84 /*
85  * Note: there are padding fields in request, clear them to zero before
86  *       sending to host to avoid to divulge any information.
87  * Ex, virtio_crypto_ctrl_request::ctrl::u::destroy_session::padding[48]
88  */
89 struct virtio_crypto_ctrl_request {
90 	struct virtio_crypto_op_ctrl_req ctrl;
91 	struct virtio_crypto_session_input input;
92 	struct virtio_crypto_inhdr ctrl_status;
93 	struct completion compl;
94 };
95 
96 struct virtio_crypto_request;
97 typedef void (*virtio_crypto_data_callback)
98 		(struct virtio_crypto_request *vc_req, int len);
99 
100 struct virtio_crypto_request {
101 	uint8_t status;
102 	struct virtio_crypto_op_data_req *req_data;
103 	struct scatterlist **sgs;
104 	struct data_queue *dataq;
105 	virtio_crypto_data_callback alg_cb;
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 bool virtcrypto_algo_is_supported(struct virtio_crypto *vcrypto_dev,
117 				  uint32_t service,
118 				  uint32_t algo);
119 struct virtio_crypto *virtcrypto_get_dev_node(int node,
120 					      uint32_t service,
121 					      uint32_t algo);
122 int virtcrypto_dev_start(struct virtio_crypto *vcrypto);
123 void virtcrypto_dev_stop(struct virtio_crypto *vcrypto);
124 int virtio_crypto_skcipher_crypt_req(
125 	struct crypto_engine *engine, void *vreq);
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_skcipher_algs_register(struct virtio_crypto *vcrypto);
142 void virtio_crypto_skcipher_algs_unregister(struct virtio_crypto *vcrypto);
143 int virtio_crypto_akcipher_algs_register(struct virtio_crypto *vcrypto);
144 void virtio_crypto_akcipher_algs_unregister(struct virtio_crypto *vcrypto);
145 int virtio_crypto_ctrl_vq_request(struct virtio_crypto *vcrypto, struct scatterlist *sgs[],
146 				  unsigned int out_sgs, unsigned int in_sgs,
147 				  struct virtio_crypto_ctrl_request *vc_ctrl_req);
148 
149 #endif /* _VIRTIO_CRYPTO_COMMON_H */
150