crypto: ccp - Replace BUG_ON with WARN_ON and a return code
[deliverable/linux.git] / drivers / crypto / ccp / ccp-crypto-main.c
CommitLineData
d3123599
TL
1/*
2 * AMD Cryptographic Coprocessor (CCP) crypto API support
3 *
4 * Copyright (C) 2013 Advanced Micro Devices, Inc.
5 *
6 * Author: Tom Lendacky <thomas.lendacky@amd.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/module.h>
d81ed653 14#include <linux/moduleparam.h>
d3123599
TL
15#include <linux/kernel.h>
16#include <linux/list.h>
17#include <linux/ccp.h>
18#include <linux/scatterlist.h>
19#include <crypto/internal/hash.h>
20
21#include "ccp-crypto.h"
22
23MODULE_AUTHOR("Tom Lendacky <thomas.lendacky@amd.com>");
24MODULE_LICENSE("GPL");
25MODULE_VERSION("1.0.0");
26MODULE_DESCRIPTION("AMD Cryptographic Coprocessor crypto API support");
27
d81ed653
TL
28static unsigned int aes_disable;
29module_param(aes_disable, uint, 0444);
30MODULE_PARM_DESC(aes_disable, "Disable use of AES - any non-zero value");
31
32static unsigned int sha_disable;
33module_param(sha_disable, uint, 0444);
34MODULE_PARM_DESC(sha_disable, "Disable use of SHA - any non-zero value");
35
d3123599
TL
36/* List heads for the supported algorithms */
37static LIST_HEAD(hash_algs);
38static LIST_HEAD(cipher_algs);
39
bc385447
TL
40/* For any tfm, requests for that tfm must be returned on the order
41 * received. With multiple queues available, the CCP can process more
42 * than one cmd at a time. Therefore we must maintain a cmd list to insure
43 * the proper ordering of requests on a given tfm.
d3123599 44 */
bc385447 45struct ccp_crypto_queue {
d3123599
TL
46 struct list_head cmds;
47 struct list_head *backlog;
48 unsigned int cmd_count;
49};
8db88467 50
bc385447 51#define CCP_CRYPTO_MAX_QLEN 100
d3123599 52
bc385447
TL
53static struct ccp_crypto_queue req_queue;
54static spinlock_t req_queue_lock;
d3123599
TL
55
56struct ccp_crypto_cmd {
57 struct list_head entry;
58
59 struct ccp_cmd *cmd;
60
61 /* Save the crypto_tfm and crypto_async_request addresses
62 * separately to avoid any reference to a possibly invalid
63 * crypto_async_request structure after invoking the request
64 * callback
65 */
66 struct crypto_async_request *req;
67 struct crypto_tfm *tfm;
68
69 /* Used for held command processing to determine state */
70 int ret;
d3123599
TL
71};
72
73struct ccp_crypto_cpu {
74 struct work_struct work;
75 struct completion completion;
76 struct ccp_crypto_cmd *crypto_cmd;
77 int err;
78};
79
d3123599
TL
80static inline bool ccp_crypto_success(int err)
81{
82 if (err && (err != -EINPROGRESS) && (err != -EBUSY))
83 return false;
84
85 return true;
86}
87
d3123599
TL
88static struct ccp_crypto_cmd *ccp_crypto_cmd_complete(
89 struct ccp_crypto_cmd *crypto_cmd, struct ccp_crypto_cmd **backlog)
90{
d3123599 91 struct ccp_crypto_cmd *held = NULL, *tmp;
bc385447 92 unsigned long flags;
d3123599
TL
93
94 *backlog = NULL;
95
bc385447 96 spin_lock_irqsave(&req_queue_lock, flags);
d3123599
TL
97
98 /* Held cmds will be after the current cmd in the queue so start
99 * searching for a cmd with a matching tfm for submission.
100 */
101 tmp = crypto_cmd;
bc385447 102 list_for_each_entry_continue(tmp, &req_queue.cmds, entry) {
d3123599
TL
103 if (crypto_cmd->tfm != tmp->tfm)
104 continue;
105 held = tmp;
106 break;
107 }
108
109 /* Process the backlog:
110 * Because cmds can be executed from any point in the cmd list
111 * special precautions have to be taken when handling the backlog.
112 */
bc385447 113 if (req_queue.backlog != &req_queue.cmds) {
d3123599 114 /* Skip over this cmd if it is the next backlog cmd */
bc385447
TL
115 if (req_queue.backlog == &crypto_cmd->entry)
116 req_queue.backlog = crypto_cmd->entry.next;
d3123599 117
bc385447 118 *backlog = container_of(req_queue.backlog,
d3123599 119 struct ccp_crypto_cmd, entry);
bc385447 120 req_queue.backlog = req_queue.backlog->next;
d3123599
TL
121
122 /* Skip over this cmd if it is now the next backlog cmd */
bc385447
TL
123 if (req_queue.backlog == &crypto_cmd->entry)
124 req_queue.backlog = crypto_cmd->entry.next;
d3123599
TL
125 }
126
127 /* Remove the cmd entry from the list of cmds */
bc385447 128 req_queue.cmd_count--;
d3123599
TL
129 list_del(&crypto_cmd->entry);
130
bc385447
TL
131 spin_unlock_irqrestore(&req_queue_lock, flags);
132
d3123599
TL
133 return held;
134}
135
bc385447 136static void ccp_crypto_complete(void *data, int err)
d3123599 137{
bc385447 138 struct ccp_crypto_cmd *crypto_cmd = data;
d3123599
TL
139 struct ccp_crypto_cmd *held, *next, *backlog;
140 struct crypto_async_request *req = crypto_cmd->req;
141 struct ccp_ctx *ctx = crypto_tfm_ctx(req->tfm);
bc385447 142 int ret;
d3123599 143
bc385447 144 if (err == -EINPROGRESS) {
8db88467 145 /* Only propagate the -EINPROGRESS if necessary */
d3123599
TL
146 if (crypto_cmd->ret == -EBUSY) {
147 crypto_cmd->ret = -EINPROGRESS;
148 req->complete(req, -EINPROGRESS);
149 }
150
bc385447 151 return;
d3123599
TL
152 }
153
154 /* Operation has completed - update the queue before invoking
155 * the completion callbacks and retrieve the next cmd (cmd with
156 * a matching tfm) that can be submitted to the CCP.
157 */
158 held = ccp_crypto_cmd_complete(crypto_cmd, &backlog);
159 if (backlog) {
160 backlog->ret = -EINPROGRESS;
161 backlog->req->complete(backlog->req, -EINPROGRESS);
162 }
163
164 /* Transition the state from -EBUSY to -EINPROGRESS first */
165 if (crypto_cmd->ret == -EBUSY)
166 req->complete(req, -EINPROGRESS);
167
168 /* Completion callbacks */
bc385447 169 ret = err;
d3123599
TL
170 if (ctx->complete)
171 ret = ctx->complete(req, ret);
172 req->complete(req, ret);
173
174 /* Submit the next cmd */
175 while (held) {
0611451b
TL
176 /* Since we have already queued the cmd, we must indicate that
177 * we can backlog so as not to "lose" this request.
178 */
179 held->cmd->flags |= CCP_CMD_MAY_BACKLOG;
d3123599
TL
180 ret = ccp_enqueue_cmd(held->cmd);
181 if (ccp_crypto_success(ret))
182 break;
183
184 /* Error occurred, report it and get the next entry */
950b10ba
TL
185 ctx = crypto_tfm_ctx(held->req->tfm);
186 if (ctx->complete)
187 ret = ctx->complete(held->req, ret);
d3123599
TL
188 held->req->complete(held->req, ret);
189
190 next = ccp_crypto_cmd_complete(held, &backlog);
191 if (backlog) {
192 backlog->ret = -EINPROGRESS;
193 backlog->req->complete(backlog->req, -EINPROGRESS);
194 }
195
196 kfree(held);
197 held = next;
198 }
199
200 kfree(crypto_cmd);
d3123599
TL
201}
202
203static int ccp_crypto_enqueue_cmd(struct ccp_crypto_cmd *crypto_cmd)
204{
d3123599 205 struct ccp_crypto_cmd *active = NULL, *tmp;
bc385447 206 unsigned long flags;
c65a52f8 207 bool free_cmd = true;
bc385447 208 int ret;
d3123599 209
bc385447 210 spin_lock_irqsave(&req_queue_lock, flags);
d3123599
TL
211
212 /* Check if the cmd can/should be queued */
bc385447 213 if (req_queue.cmd_count >= CCP_CRYPTO_MAX_QLEN) {
d3123599
TL
214 ret = -EBUSY;
215 if (!(crypto_cmd->cmd->flags & CCP_CMD_MAY_BACKLOG))
bc385447 216 goto e_lock;
d3123599
TL
217 }
218
219 /* Look for an entry with the same tfm. If there is a cmd
bc385447
TL
220 * with the same tfm in the list then the current cmd cannot
221 * be submitted to the CCP yet.
d3123599 222 */
bc385447 223 list_for_each_entry(tmp, &req_queue.cmds, entry) {
d3123599
TL
224 if (crypto_cmd->tfm != tmp->tfm)
225 continue;
226 active = tmp;
227 break;
228 }
229
230 ret = -EINPROGRESS;
231 if (!active) {
232 ret = ccp_enqueue_cmd(crypto_cmd->cmd);
233 if (!ccp_crypto_success(ret))
c65a52f8
TL
234 goto e_lock; /* Error, don't queue it */
235 if ((ret == -EBUSY) &&
236 !(crypto_cmd->cmd->flags & CCP_CMD_MAY_BACKLOG))
237 goto e_lock; /* Not backlogging, don't queue it */
d3123599
TL
238 }
239
bc385447 240 if (req_queue.cmd_count >= CCP_CRYPTO_MAX_QLEN) {
d3123599 241 ret = -EBUSY;
bc385447
TL
242 if (req_queue.backlog == &req_queue.cmds)
243 req_queue.backlog = &crypto_cmd->entry;
d3123599
TL
244 }
245 crypto_cmd->ret = ret;
246
bc385447
TL
247 req_queue.cmd_count++;
248 list_add_tail(&crypto_cmd->entry, &req_queue.cmds);
d3123599 249
c65a52f8
TL
250 free_cmd = false;
251
bc385447
TL
252e_lock:
253 spin_unlock_irqrestore(&req_queue_lock, flags);
d3123599 254
c65a52f8
TL
255 if (free_cmd)
256 kfree(crypto_cmd);
257
d3123599
TL
258 return ret;
259}
260
261/**
262 * ccp_crypto_enqueue_request - queue an crypto async request for processing
263 * by the CCP
264 *
265 * @req: crypto_async_request struct to be processed
266 * @cmd: ccp_cmd struct to be sent to the CCP
267 */
268int ccp_crypto_enqueue_request(struct crypto_async_request *req,
269 struct ccp_cmd *cmd)
270{
271 struct ccp_crypto_cmd *crypto_cmd;
272 gfp_t gfp;
d3123599
TL
273
274 gfp = req->flags & CRYPTO_TFM_REQ_MAY_SLEEP ? GFP_KERNEL : GFP_ATOMIC;
275
276 crypto_cmd = kzalloc(sizeof(*crypto_cmd), gfp);
277 if (!crypto_cmd)
278 return -ENOMEM;
279
280 /* The tfm pointer must be saved and not referenced from the
281 * crypto_async_request (req) pointer because it is used after
282 * completion callback for the request and the req pointer
283 * might not be valid anymore.
284 */
285 crypto_cmd->cmd = cmd;
286 crypto_cmd->req = req;
287 crypto_cmd->tfm = req->tfm;
288
289 cmd->callback = ccp_crypto_complete;
290 cmd->data = crypto_cmd;
291
292 if (req->flags & CRYPTO_TFM_REQ_MAY_BACKLOG)
293 cmd->flags |= CCP_CMD_MAY_BACKLOG;
294 else
295 cmd->flags &= ~CCP_CMD_MAY_BACKLOG;
296
c65a52f8 297 return ccp_crypto_enqueue_cmd(crypto_cmd);
d3123599
TL
298}
299
300struct scatterlist *ccp_crypto_sg_table_add(struct sg_table *table,
301 struct scatterlist *sg_add)
302{
303 struct scatterlist *sg, *sg_last = NULL;
304
305 for (sg = table->sgl; sg; sg = sg_next(sg))
306 if (!sg_page(sg))
307 break;
355eba5d
TL
308 if (WARN_ON(!sg))
309 return NULL;
d3123599
TL
310
311 for (; sg && sg_add; sg = sg_next(sg), sg_add = sg_next(sg_add)) {
312 sg_set_page(sg, sg_page(sg_add), sg_add->length,
313 sg_add->offset);
314 sg_last = sg;
315 }
355eba5d
TL
316 if (WARN_ON(sg_add))
317 return NULL;
d3123599
TL
318
319 return sg_last;
320}
321
322static int ccp_register_algs(void)
323{
324 int ret;
325
d81ed653
TL
326 if (!aes_disable) {
327 ret = ccp_register_aes_algs(&cipher_algs);
328 if (ret)
329 return ret;
d3123599 330
d81ed653
TL
331 ret = ccp_register_aes_cmac_algs(&hash_algs);
332 if (ret)
333 return ret;
d3123599 334
d81ed653
TL
335 ret = ccp_register_aes_xts_algs(&cipher_algs);
336 if (ret)
337 return ret;
338 }
d3123599 339
d81ed653
TL
340 if (!sha_disable) {
341 ret = ccp_register_sha_algs(&hash_algs);
342 if (ret)
343 return ret;
344 }
d3123599
TL
345
346 return 0;
347}
348
349static void ccp_unregister_algs(void)
350{
351 struct ccp_crypto_ahash_alg *ahash_alg, *ahash_tmp;
352 struct ccp_crypto_ablkcipher_alg *ablk_alg, *ablk_tmp;
353
354 list_for_each_entry_safe(ahash_alg, ahash_tmp, &hash_algs, entry) {
355 crypto_unregister_ahash(&ahash_alg->alg);
356 list_del(&ahash_alg->entry);
357 kfree(ahash_alg);
358 }
359
360 list_for_each_entry_safe(ablk_alg, ablk_tmp, &cipher_algs, entry) {
361 crypto_unregister_alg(&ablk_alg->alg);
362 list_del(&ablk_alg->entry);
363 kfree(ablk_alg);
364 }
365}
366
d3123599
TL
367static int ccp_crypto_init(void)
368{
369 int ret;
370
c9f21cb6
TL
371 ret = ccp_present();
372 if (ret)
373 return ret;
374
bc385447
TL
375 spin_lock_init(&req_queue_lock);
376 INIT_LIST_HEAD(&req_queue.cmds);
377 req_queue.backlog = &req_queue.cmds;
378 req_queue.cmd_count = 0;
d3123599
TL
379
380 ret = ccp_register_algs();
bc385447 381 if (ret)
d3123599 382 ccp_unregister_algs();
d3123599
TL
383
384 return ret;
385}
386
387static void ccp_crypto_exit(void)
388{
389 ccp_unregister_algs();
d3123599
TL
390}
391
392module_init(ccp_crypto_init);
393module_exit(ccp_crypto_exit);
This page took 0.1095 seconds and 5 git commands to generate.