2 * AMD Cryptographic Coprocessor (CCP) driver
4 * Copyright (C) 2016,2017 Advanced Micro Devices, Inc.
6 * Author: Gary R Hook <gary.hook@amd.com>
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.
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/dmaengine.h>
16 #include <linux/spinlock.h>
17 #include <linux/mutex.h>
18 #include <linux/ccp.h>
21 #include "../../dma/dmaengine.h"
23 #define CCP_DMA_WIDTH(_mask) \
25 u64 mask = _mask + 1; \
26 (mask == 0) ? 64 : fls64(mask); \
29 /* The CCP as a DMA provider can be configured for public or private
30 * channels. Default is specified in the vdata for the device (PCI ID).
31 * This module parameter will override for all channels on all devices:
32 * dma_chan_attr = 0x2 to force all channels public
33 * = 0x1 to force all channels private
34 * = 0x0 to defer to the vdata setting
35 * = any other value: warning, revert to 0x0
37 static unsigned int dma_chan_attr = CCP_DMA_DFLT;
38 module_param(dma_chan_attr, uint, 0444);
39 MODULE_PARM_DESC(dma_chan_attr, "Set DMA channel visibility: 0 (default) = device defaults, 1 = make private, 2 = make public");
41 static unsigned int ccp_get_dma_chan_attr(struct ccp_device *ccp)
43 switch (dma_chan_attr) {
45 return ccp->vdata->dma_chan_attr;
54 dev_info_once(ccp->dev, "Invalid value for dma_chan_attr: %d\n",
56 return ccp->vdata->dma_chan_attr;
60 static void ccp_free_cmd_resources(struct ccp_device *ccp,
61 struct list_head *list)
63 struct ccp_dma_cmd *cmd, *ctmp;
65 list_for_each_entry_safe(cmd, ctmp, list, entry) {
66 list_del(&cmd->entry);
67 kmem_cache_free(ccp->dma_cmd_cache, cmd);
71 static void ccp_free_desc_resources(struct ccp_device *ccp,
72 struct list_head *list)
74 struct ccp_dma_desc *desc, *dtmp;
76 list_for_each_entry_safe(desc, dtmp, list, entry) {
77 ccp_free_cmd_resources(ccp, &desc->active);
78 ccp_free_cmd_resources(ccp, &desc->pending);
80 list_del(&desc->entry);
81 kmem_cache_free(ccp->dma_desc_cache, desc);
85 static void ccp_free_chan_resources(struct dma_chan *dma_chan)
87 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
91 dev_dbg(chan->ccp->dev, "%s - chan=%p\n", __func__, chan);
93 spin_lock_irqsave(&chan->lock, flags);
95 ccp_free_desc_resources(chan->ccp, &chan->complete);
96 ccp_free_desc_resources(chan->ccp, &chan->active);
97 ccp_free_desc_resources(chan->ccp, &chan->pending);
98 ccp_free_desc_resources(chan->ccp, &chan->created);
100 spin_unlock_irqrestore(&chan->lock, flags);
103 static void ccp_cleanup_desc_resources(struct ccp_device *ccp,
104 struct list_head *list)
106 struct ccp_dma_desc *desc, *dtmp;
108 list_for_each_entry_safe_reverse(desc, dtmp, list, entry) {
109 if (!async_tx_test_ack(&desc->tx_desc))
112 dev_dbg(ccp->dev, "%s - desc=%p\n", __func__, desc);
114 ccp_free_cmd_resources(ccp, &desc->active);
115 ccp_free_cmd_resources(ccp, &desc->pending);
117 list_del(&desc->entry);
118 kmem_cache_free(ccp->dma_desc_cache, desc);
122 static void ccp_do_cleanup(unsigned long data)
124 struct ccp_dma_chan *chan = (struct ccp_dma_chan *)data;
127 dev_dbg(chan->ccp->dev, "%s - chan=%s\n", __func__,
128 dma_chan_name(&chan->dma_chan));
130 spin_lock_irqsave(&chan->lock, flags);
132 ccp_cleanup_desc_resources(chan->ccp, &chan->complete);
134 spin_unlock_irqrestore(&chan->lock, flags);
137 static int ccp_issue_next_cmd(struct ccp_dma_desc *desc)
139 struct ccp_dma_cmd *cmd;
142 cmd = list_first_entry(&desc->pending, struct ccp_dma_cmd, entry);
143 list_move(&cmd->entry, &desc->active);
145 dev_dbg(desc->ccp->dev, "%s - tx %d, cmd=%p\n", __func__,
146 desc->tx_desc.cookie, cmd);
148 ret = ccp_enqueue_cmd(&cmd->ccp_cmd);
149 if (!ret || (ret == -EINPROGRESS) || (ret == -EBUSY))
152 dev_dbg(desc->ccp->dev, "%s - error: ret=%d, tx %d, cmd=%p\n", __func__,
153 ret, desc->tx_desc.cookie, cmd);
158 static void ccp_free_active_cmd(struct ccp_dma_desc *desc)
160 struct ccp_dma_cmd *cmd;
162 cmd = list_first_entry_or_null(&desc->active, struct ccp_dma_cmd,
167 dev_dbg(desc->ccp->dev, "%s - freeing tx %d cmd=%p\n",
168 __func__, desc->tx_desc.cookie, cmd);
170 list_del(&cmd->entry);
171 kmem_cache_free(desc->ccp->dma_cmd_cache, cmd);
174 static struct ccp_dma_desc *__ccp_next_dma_desc(struct ccp_dma_chan *chan,
175 struct ccp_dma_desc *desc)
177 /* Move current DMA descriptor to the complete list */
179 list_move(&desc->entry, &chan->complete);
181 /* Get the next DMA descriptor on the active list */
182 desc = list_first_entry_or_null(&chan->active, struct ccp_dma_desc,
188 static struct ccp_dma_desc *ccp_handle_active_desc(struct ccp_dma_chan *chan,
189 struct ccp_dma_desc *desc)
191 struct dma_async_tx_descriptor *tx_desc;
194 /* Loop over descriptors until one is found with commands */
197 /* Remove the DMA command from the list and free it */
198 ccp_free_active_cmd(desc);
200 if (!list_empty(&desc->pending)) {
201 /* No errors, keep going */
202 if (desc->status != DMA_ERROR)
205 /* Error, free remaining commands and move on */
206 ccp_free_cmd_resources(desc->ccp,
210 tx_desc = &desc->tx_desc;
215 spin_lock_irqsave(&chan->lock, flags);
218 if (desc->status != DMA_ERROR)
219 desc->status = DMA_COMPLETE;
221 dev_dbg(desc->ccp->dev,
222 "%s - tx %d complete, status=%u\n", __func__,
223 desc->tx_desc.cookie, desc->status);
225 dma_cookie_complete(tx_desc);
226 dma_descriptor_unmap(tx_desc);
229 desc = __ccp_next_dma_desc(chan, desc);
231 spin_unlock_irqrestore(&chan->lock, flags);
234 dmaengine_desc_get_callback_invoke(tx_desc, NULL);
236 dma_run_dependencies(tx_desc);
243 static struct ccp_dma_desc *__ccp_pending_to_active(struct ccp_dma_chan *chan)
245 struct ccp_dma_desc *desc;
247 if (list_empty(&chan->pending))
250 desc = list_empty(&chan->active)
251 ? list_first_entry(&chan->pending, struct ccp_dma_desc, entry)
254 list_splice_tail_init(&chan->pending, &chan->active);
259 static void ccp_cmd_callback(void *data, int err)
261 struct ccp_dma_desc *desc = data;
262 struct ccp_dma_chan *chan;
265 if (err == -EINPROGRESS)
268 chan = container_of(desc->tx_desc.chan, struct ccp_dma_chan,
271 dev_dbg(chan->ccp->dev, "%s - tx %d callback, err=%d\n",
272 __func__, desc->tx_desc.cookie, err);
275 desc->status = DMA_ERROR;
278 /* Check for DMA descriptor completion */
279 desc = ccp_handle_active_desc(chan, desc);
281 /* Don't submit cmd if no descriptor or DMA is paused */
282 if (!desc || (chan->status == DMA_PAUSED))
285 ret = ccp_issue_next_cmd(desc);
289 desc->status = DMA_ERROR;
292 tasklet_schedule(&chan->cleanup_tasklet);
295 static dma_cookie_t ccp_tx_submit(struct dma_async_tx_descriptor *tx_desc)
297 struct ccp_dma_desc *desc = container_of(tx_desc, struct ccp_dma_desc,
299 struct ccp_dma_chan *chan;
303 chan = container_of(tx_desc->chan, struct ccp_dma_chan, dma_chan);
305 spin_lock_irqsave(&chan->lock, flags);
307 cookie = dma_cookie_assign(tx_desc);
308 list_del(&desc->entry);
309 list_add_tail(&desc->entry, &chan->pending);
311 spin_unlock_irqrestore(&chan->lock, flags);
313 dev_dbg(chan->ccp->dev, "%s - added tx descriptor %d to pending list\n",
319 static struct ccp_dma_cmd *ccp_alloc_dma_cmd(struct ccp_dma_chan *chan)
321 struct ccp_dma_cmd *cmd;
323 cmd = kmem_cache_alloc(chan->ccp->dma_cmd_cache, GFP_NOWAIT);
325 memset(cmd, 0, sizeof(*cmd));
330 static struct ccp_dma_desc *ccp_alloc_dma_desc(struct ccp_dma_chan *chan,
333 struct ccp_dma_desc *desc;
335 desc = kmem_cache_zalloc(chan->ccp->dma_desc_cache, GFP_NOWAIT);
339 dma_async_tx_descriptor_init(&desc->tx_desc, &chan->dma_chan);
340 desc->tx_desc.flags = flags;
341 desc->tx_desc.tx_submit = ccp_tx_submit;
342 desc->ccp = chan->ccp;
343 INIT_LIST_HEAD(&desc->entry);
344 INIT_LIST_HEAD(&desc->pending);
345 INIT_LIST_HEAD(&desc->active);
346 desc->status = DMA_IN_PROGRESS;
351 static struct ccp_dma_desc *ccp_create_desc(struct dma_chan *dma_chan,
352 struct scatterlist *dst_sg,
353 unsigned int dst_nents,
354 struct scatterlist *src_sg,
355 unsigned int src_nents,
358 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
360 struct ccp_device *ccp = chan->ccp;
361 struct ccp_dma_desc *desc;
362 struct ccp_dma_cmd *cmd;
363 struct ccp_cmd *ccp_cmd;
364 struct ccp_passthru_nomap_engine *ccp_pt;
365 unsigned int src_offset, src_len;
366 unsigned int dst_offset, dst_len;
368 unsigned long sflags;
371 if (!dst_sg || !src_sg)
374 if (!dst_nents || !src_nents)
377 desc = ccp_alloc_dma_desc(chan, flags);
383 src_len = sg_dma_len(src_sg);
386 dst_len = sg_dma_len(dst_sg);
395 src_sg = sg_next(src_sg);
399 src_len = sg_dma_len(src_sg);
409 dst_sg = sg_next(dst_sg);
413 dst_len = sg_dma_len(dst_sg);
418 len = min(dst_len, src_len);
420 cmd = ccp_alloc_dma_cmd(chan);
424 ccp_cmd = &cmd->ccp_cmd;
425 ccp_cmd->ccp = chan->ccp;
426 ccp_pt = &ccp_cmd->u.passthru_nomap;
427 ccp_cmd->flags = CCP_CMD_MAY_BACKLOG;
428 ccp_cmd->flags |= CCP_CMD_PASSTHRU_NO_DMA_MAP;
429 ccp_cmd->engine = CCP_ENGINE_PASSTHRU;
430 ccp_pt->bit_mod = CCP_PASSTHRU_BITWISE_NOOP;
431 ccp_pt->byte_swap = CCP_PASSTHRU_BYTESWAP_NOOP;
432 ccp_pt->src_dma = sg_dma_address(src_sg) + src_offset;
433 ccp_pt->dst_dma = sg_dma_address(dst_sg) + dst_offset;
434 ccp_pt->src_len = len;
436 ccp_cmd->callback = ccp_cmd_callback;
437 ccp_cmd->data = desc;
439 list_add_tail(&cmd->entry, &desc->pending);
442 "%s - cmd=%p, src=%pad, dst=%pad, len=%llu\n", __func__,
443 cmd, &ccp_pt->src_dma,
444 &ccp_pt->dst_dma, ccp_pt->src_len);
455 desc->len = total_len;
457 if (list_empty(&desc->pending))
460 dev_dbg(ccp->dev, "%s - desc=%p\n", __func__, desc);
462 spin_lock_irqsave(&chan->lock, sflags);
464 list_add_tail(&desc->entry, &chan->created);
466 spin_unlock_irqrestore(&chan->lock, sflags);
471 ccp_free_cmd_resources(ccp, &desc->pending);
472 kmem_cache_free(ccp->dma_desc_cache, desc);
477 static struct dma_async_tx_descriptor *ccp_prep_dma_memcpy(
478 struct dma_chan *dma_chan, dma_addr_t dst, dma_addr_t src, size_t len,
481 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
483 struct ccp_dma_desc *desc;
484 struct scatterlist dst_sg, src_sg;
486 dev_dbg(chan->ccp->dev,
487 "%s - src=%pad, dst=%pad, len=%zu, flags=%#lx\n",
488 __func__, &src, &dst, len, flags);
490 sg_init_table(&dst_sg, 1);
491 sg_dma_address(&dst_sg) = dst;
492 sg_dma_len(&dst_sg) = len;
494 sg_init_table(&src_sg, 1);
495 sg_dma_address(&src_sg) = src;
496 sg_dma_len(&src_sg) = len;
498 desc = ccp_create_desc(dma_chan, &dst_sg, 1, &src_sg, 1, flags);
502 return &desc->tx_desc;
505 static struct dma_async_tx_descriptor *ccp_prep_dma_interrupt(
506 struct dma_chan *dma_chan, unsigned long flags)
508 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
510 struct ccp_dma_desc *desc;
512 desc = ccp_alloc_dma_desc(chan, flags);
516 return &desc->tx_desc;
519 static void ccp_issue_pending(struct dma_chan *dma_chan)
521 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
523 struct ccp_dma_desc *desc;
526 dev_dbg(chan->ccp->dev, "%s\n", __func__);
528 spin_lock_irqsave(&chan->lock, flags);
530 desc = __ccp_pending_to_active(chan);
532 spin_unlock_irqrestore(&chan->lock, flags);
534 /* If there was nothing active, start processing */
536 ccp_cmd_callback(desc, 0);
539 static enum dma_status ccp_tx_status(struct dma_chan *dma_chan,
541 struct dma_tx_state *state)
543 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
545 struct ccp_dma_desc *desc;
549 if (chan->status == DMA_PAUSED) {
554 ret = dma_cookie_status(dma_chan, cookie, state);
555 if (ret == DMA_COMPLETE) {
556 spin_lock_irqsave(&chan->lock, flags);
558 /* Get status from complete chain, if still there */
559 list_for_each_entry(desc, &chan->complete, entry) {
560 if (desc->tx_desc.cookie != cookie)
567 spin_unlock_irqrestore(&chan->lock, flags);
571 dev_dbg(chan->ccp->dev, "%s - %u\n", __func__, ret);
576 static int ccp_pause(struct dma_chan *dma_chan)
578 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
581 chan->status = DMA_PAUSED;
583 /*TODO: Wait for active DMA to complete before returning? */
588 static int ccp_resume(struct dma_chan *dma_chan)
590 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
592 struct ccp_dma_desc *desc;
595 spin_lock_irqsave(&chan->lock, flags);
597 desc = list_first_entry_or_null(&chan->active, struct ccp_dma_desc,
600 spin_unlock_irqrestore(&chan->lock, flags);
602 /* Indicate the channel is running again */
603 chan->status = DMA_IN_PROGRESS;
605 /* If there was something active, re-start */
607 ccp_cmd_callback(desc, 0);
612 static int ccp_terminate_all(struct dma_chan *dma_chan)
614 struct ccp_dma_chan *chan = container_of(dma_chan, struct ccp_dma_chan,
618 dev_dbg(chan->ccp->dev, "%s\n", __func__);
620 /*TODO: Wait for active DMA to complete before continuing */
622 spin_lock_irqsave(&chan->lock, flags);
624 /*TODO: Purge the complete list? */
625 ccp_free_desc_resources(chan->ccp, &chan->active);
626 ccp_free_desc_resources(chan->ccp, &chan->pending);
627 ccp_free_desc_resources(chan->ccp, &chan->created);
629 spin_unlock_irqrestore(&chan->lock, flags);
634 static void ccp_dma_release(struct ccp_device *ccp)
636 struct ccp_dma_chan *chan;
637 struct dma_chan *dma_chan;
640 for (i = 0; i < ccp->cmd_q_count; i++) {
641 chan = ccp->ccp_dma_chan + i;
642 dma_chan = &chan->dma_chan;
643 tasklet_kill(&chan->cleanup_tasklet);
644 list_del_rcu(&dma_chan->device_node);
648 int ccp_dmaengine_register(struct ccp_device *ccp)
650 struct ccp_dma_chan *chan;
651 struct dma_device *dma_dev = &ccp->dma_dev;
652 struct dma_chan *dma_chan;
653 char *dma_cmd_cache_name;
654 char *dma_desc_cache_name;
658 ccp->ccp_dma_chan = devm_kcalloc(ccp->dev, ccp->cmd_q_count,
659 sizeof(*(ccp->ccp_dma_chan)),
661 if (!ccp->ccp_dma_chan)
664 dma_cmd_cache_name = devm_kasprintf(ccp->dev, GFP_KERNEL,
665 "%s-dmaengine-cmd-cache",
667 if (!dma_cmd_cache_name)
670 ccp->dma_cmd_cache = kmem_cache_create(dma_cmd_cache_name,
671 sizeof(struct ccp_dma_cmd),
673 SLAB_HWCACHE_ALIGN, NULL);
674 if (!ccp->dma_cmd_cache)
677 dma_desc_cache_name = devm_kasprintf(ccp->dev, GFP_KERNEL,
678 "%s-dmaengine-desc-cache",
680 if (!dma_desc_cache_name) {
685 ccp->dma_desc_cache = kmem_cache_create(dma_desc_cache_name,
686 sizeof(struct ccp_dma_desc),
688 SLAB_HWCACHE_ALIGN, NULL);
689 if (!ccp->dma_desc_cache) {
694 dma_dev->dev = ccp->dev;
695 dma_dev->src_addr_widths = CCP_DMA_WIDTH(dma_get_mask(ccp->dev));
696 dma_dev->dst_addr_widths = CCP_DMA_WIDTH(dma_get_mask(ccp->dev));
697 dma_dev->directions = DMA_MEM_TO_MEM;
698 dma_dev->residue_granularity = DMA_RESIDUE_GRANULARITY_DESCRIPTOR;
699 dma_cap_set(DMA_MEMCPY, dma_dev->cap_mask);
700 dma_cap_set(DMA_INTERRUPT, dma_dev->cap_mask);
702 /* The DMA channels for this device can be set to public or private,
703 * and overridden by the module parameter dma_chan_attr.
704 * Default: according to the value in vdata (dma_chan_attr=0)
705 * dma_chan_attr=0x1: all channels private (override vdata)
706 * dma_chan_attr=0x2: all channels public (override vdata)
708 if (ccp_get_dma_chan_attr(ccp) == DMA_PRIVATE)
709 dma_cap_set(DMA_PRIVATE, dma_dev->cap_mask);
711 INIT_LIST_HEAD(&dma_dev->channels);
712 for (i = 0; i < ccp->cmd_q_count; i++) {
713 chan = ccp->ccp_dma_chan + i;
714 dma_chan = &chan->dma_chan;
718 spin_lock_init(&chan->lock);
719 INIT_LIST_HEAD(&chan->created);
720 INIT_LIST_HEAD(&chan->pending);
721 INIT_LIST_HEAD(&chan->active);
722 INIT_LIST_HEAD(&chan->complete);
724 tasklet_init(&chan->cleanup_tasklet, ccp_do_cleanup,
725 (unsigned long)chan);
727 dma_chan->device = dma_dev;
728 dma_cookie_init(dma_chan);
730 list_add_tail(&dma_chan->device_node, &dma_dev->channels);
733 dma_dev->device_free_chan_resources = ccp_free_chan_resources;
734 dma_dev->device_prep_dma_memcpy = ccp_prep_dma_memcpy;
735 dma_dev->device_prep_dma_interrupt = ccp_prep_dma_interrupt;
736 dma_dev->device_issue_pending = ccp_issue_pending;
737 dma_dev->device_tx_status = ccp_tx_status;
738 dma_dev->device_pause = ccp_pause;
739 dma_dev->device_resume = ccp_resume;
740 dma_dev->device_terminate_all = ccp_terminate_all;
742 ret = dma_async_device_register(dma_dev);
749 ccp_dma_release(ccp);
750 kmem_cache_destroy(ccp->dma_desc_cache);
753 kmem_cache_destroy(ccp->dma_cmd_cache);
758 void ccp_dmaengine_unregister(struct ccp_device *ccp)
760 struct dma_device *dma_dev = &ccp->dma_dev;
762 dma_async_device_unregister(dma_dev);
763 ccp_dma_release(ccp);
765 kmem_cache_destroy(ccp->dma_desc_cache);
766 kmem_cache_destroy(ccp->dma_cmd_cache);