1 // SPDX-License-Identifier: GPL-2.0-only
3 * AMD Cryptographic Coprocessor (CCP) driver
5 * Copyright (C) 2016,2017 Advanced Micro Devices, Inc.
7 * Author: Gary R Hook <gary.hook@amd.com>
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/dmaengine.h>
13 #include <linux/spinlock.h>
14 #include <linux/mutex.h>
15 #include <linux/ccp.h>
18 #include "../../dma/dmaengine.h"
20 #define CCP_DMA_WIDTH(_mask) \
22 u64 mask = _mask + 1; \
23 (mask == 0) ? 64 : fls64(mask); \
26 /* The CCP as a DMA provider can be configured for public or private
27 * channels. Default is specified in the vdata for the device (PCI ID).
28 * This module parameter will override for all channels on all devices:
29 * dma_chan_attr = 0x2 to force all channels public
30 * = 0x1 to force all channels private
31 * = 0x0 to defer to the vdata setting
32 * = any other value: warning, revert to 0x0
34 static unsigned int dma_chan_attr
= CCP_DMA_DFLT
;
35 module_param(dma_chan_attr
, uint
, 0444);
36 MODULE_PARM_DESC(dma_chan_attr
, "Set DMA channel visibility: 0 (default) = device defaults, 1 = make private, 2 = make public");
38 static unsigned int ccp_get_dma_chan_attr(struct ccp_device
*ccp
)
40 switch (dma_chan_attr
) {
42 return ccp
->vdata
->dma_chan_attr
;
51 dev_info_once(ccp
->dev
, "Invalid value for dma_chan_attr: %d\n",
53 return ccp
->vdata
->dma_chan_attr
;
57 static void ccp_free_cmd_resources(struct ccp_device
*ccp
,
58 struct list_head
*list
)
60 struct ccp_dma_cmd
*cmd
, *ctmp
;
62 list_for_each_entry_safe(cmd
, ctmp
, list
, entry
) {
63 list_del(&cmd
->entry
);
64 kmem_cache_free(ccp
->dma_cmd_cache
, cmd
);
68 static void ccp_free_desc_resources(struct ccp_device
*ccp
,
69 struct list_head
*list
)
71 struct ccp_dma_desc
*desc
, *dtmp
;
73 list_for_each_entry_safe(desc
, dtmp
, list
, entry
) {
74 ccp_free_cmd_resources(ccp
, &desc
->active
);
75 ccp_free_cmd_resources(ccp
, &desc
->pending
);
77 list_del(&desc
->entry
);
78 kmem_cache_free(ccp
->dma_desc_cache
, desc
);
82 static void ccp_free_chan_resources(struct dma_chan
*dma_chan
)
84 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
88 dev_dbg(chan
->ccp
->dev
, "%s - chan=%p\n", __func__
, chan
);
90 spin_lock_irqsave(&chan
->lock
, flags
);
92 ccp_free_desc_resources(chan
->ccp
, &chan
->complete
);
93 ccp_free_desc_resources(chan
->ccp
, &chan
->active
);
94 ccp_free_desc_resources(chan
->ccp
, &chan
->pending
);
95 ccp_free_desc_resources(chan
->ccp
, &chan
->created
);
97 spin_unlock_irqrestore(&chan
->lock
, flags
);
100 static void ccp_cleanup_desc_resources(struct ccp_device
*ccp
,
101 struct list_head
*list
)
103 struct ccp_dma_desc
*desc
, *dtmp
;
105 list_for_each_entry_safe_reverse(desc
, dtmp
, list
, entry
) {
106 if (!async_tx_test_ack(&desc
->tx_desc
))
109 dev_dbg(ccp
->dev
, "%s - desc=%p\n", __func__
, desc
);
111 ccp_free_cmd_resources(ccp
, &desc
->active
);
112 ccp_free_cmd_resources(ccp
, &desc
->pending
);
114 list_del(&desc
->entry
);
115 kmem_cache_free(ccp
->dma_desc_cache
, desc
);
119 static void ccp_do_cleanup(unsigned long data
)
121 struct ccp_dma_chan
*chan
= (struct ccp_dma_chan
*)data
;
124 dev_dbg(chan
->ccp
->dev
, "%s - chan=%s\n", __func__
,
125 dma_chan_name(&chan
->dma_chan
));
127 spin_lock_irqsave(&chan
->lock
, flags
);
129 ccp_cleanup_desc_resources(chan
->ccp
, &chan
->complete
);
131 spin_unlock_irqrestore(&chan
->lock
, flags
);
134 static int ccp_issue_next_cmd(struct ccp_dma_desc
*desc
)
136 struct ccp_dma_cmd
*cmd
;
139 cmd
= list_first_entry(&desc
->pending
, struct ccp_dma_cmd
, entry
);
140 list_move(&cmd
->entry
, &desc
->active
);
142 dev_dbg(desc
->ccp
->dev
, "%s - tx %d, cmd=%p\n", __func__
,
143 desc
->tx_desc
.cookie
, cmd
);
145 ret
= ccp_enqueue_cmd(&cmd
->ccp_cmd
);
146 if (!ret
|| (ret
== -EINPROGRESS
) || (ret
== -EBUSY
))
149 dev_dbg(desc
->ccp
->dev
, "%s - error: ret=%d, tx %d, cmd=%p\n", __func__
,
150 ret
, desc
->tx_desc
.cookie
, cmd
);
155 static void ccp_free_active_cmd(struct ccp_dma_desc
*desc
)
157 struct ccp_dma_cmd
*cmd
;
159 cmd
= list_first_entry_or_null(&desc
->active
, struct ccp_dma_cmd
,
164 dev_dbg(desc
->ccp
->dev
, "%s - freeing tx %d cmd=%p\n",
165 __func__
, desc
->tx_desc
.cookie
, cmd
);
167 list_del(&cmd
->entry
);
168 kmem_cache_free(desc
->ccp
->dma_cmd_cache
, cmd
);
171 static struct ccp_dma_desc
*__ccp_next_dma_desc(struct ccp_dma_chan
*chan
,
172 struct ccp_dma_desc
*desc
)
174 /* Move current DMA descriptor to the complete list */
176 list_move(&desc
->entry
, &chan
->complete
);
178 /* Get the next DMA descriptor on the active list */
179 desc
= list_first_entry_or_null(&chan
->active
, struct ccp_dma_desc
,
185 static struct ccp_dma_desc
*ccp_handle_active_desc(struct ccp_dma_chan
*chan
,
186 struct ccp_dma_desc
*desc
)
188 struct dma_async_tx_descriptor
*tx_desc
;
191 /* Loop over descriptors until one is found with commands */
194 /* Remove the DMA command from the list and free it */
195 ccp_free_active_cmd(desc
);
197 if (!list_empty(&desc
->pending
)) {
198 /* No errors, keep going */
199 if (desc
->status
!= DMA_ERROR
)
202 /* Error, free remaining commands and move on */
203 ccp_free_cmd_resources(desc
->ccp
,
207 tx_desc
= &desc
->tx_desc
;
212 spin_lock_irqsave(&chan
->lock
, flags
);
215 if (desc
->status
!= DMA_ERROR
)
216 desc
->status
= DMA_COMPLETE
;
218 dev_dbg(desc
->ccp
->dev
,
219 "%s - tx %d complete, status=%u\n", __func__
,
220 desc
->tx_desc
.cookie
, desc
->status
);
222 dma_cookie_complete(tx_desc
);
223 dma_descriptor_unmap(tx_desc
);
226 desc
= __ccp_next_dma_desc(chan
, desc
);
228 spin_unlock_irqrestore(&chan
->lock
, flags
);
231 dmaengine_desc_get_callback_invoke(tx_desc
, NULL
);
233 dma_run_dependencies(tx_desc
);
240 static struct ccp_dma_desc
*__ccp_pending_to_active(struct ccp_dma_chan
*chan
)
242 struct ccp_dma_desc
*desc
;
244 if (list_empty(&chan
->pending
))
247 desc
= list_empty(&chan
->active
)
248 ? list_first_entry(&chan
->pending
, struct ccp_dma_desc
, entry
)
251 list_splice_tail_init(&chan
->pending
, &chan
->active
);
256 static void ccp_cmd_callback(void *data
, int err
)
258 struct ccp_dma_desc
*desc
= data
;
259 struct ccp_dma_chan
*chan
;
262 if (err
== -EINPROGRESS
)
265 chan
= container_of(desc
->tx_desc
.chan
, struct ccp_dma_chan
,
268 dev_dbg(chan
->ccp
->dev
, "%s - tx %d callback, err=%d\n",
269 __func__
, desc
->tx_desc
.cookie
, err
);
272 desc
->status
= DMA_ERROR
;
275 /* Check for DMA descriptor completion */
276 desc
= ccp_handle_active_desc(chan
, desc
);
278 /* Don't submit cmd if no descriptor or DMA is paused */
279 if (!desc
|| (chan
->status
== DMA_PAUSED
))
282 ret
= ccp_issue_next_cmd(desc
);
286 desc
->status
= DMA_ERROR
;
289 tasklet_schedule(&chan
->cleanup_tasklet
);
292 static dma_cookie_t
ccp_tx_submit(struct dma_async_tx_descriptor
*tx_desc
)
294 struct ccp_dma_desc
*desc
= container_of(tx_desc
, struct ccp_dma_desc
,
296 struct ccp_dma_chan
*chan
;
300 chan
= container_of(tx_desc
->chan
, struct ccp_dma_chan
, dma_chan
);
302 spin_lock_irqsave(&chan
->lock
, flags
);
304 cookie
= dma_cookie_assign(tx_desc
);
305 list_del(&desc
->entry
);
306 list_add_tail(&desc
->entry
, &chan
->pending
);
308 spin_unlock_irqrestore(&chan
->lock
, flags
);
310 dev_dbg(chan
->ccp
->dev
, "%s - added tx descriptor %d to pending list\n",
316 static struct ccp_dma_cmd
*ccp_alloc_dma_cmd(struct ccp_dma_chan
*chan
)
318 struct ccp_dma_cmd
*cmd
;
320 cmd
= kmem_cache_alloc(chan
->ccp
->dma_cmd_cache
, GFP_NOWAIT
);
322 memset(cmd
, 0, sizeof(*cmd
));
327 static struct ccp_dma_desc
*ccp_alloc_dma_desc(struct ccp_dma_chan
*chan
,
330 struct ccp_dma_desc
*desc
;
332 desc
= kmem_cache_zalloc(chan
->ccp
->dma_desc_cache
, GFP_NOWAIT
);
336 dma_async_tx_descriptor_init(&desc
->tx_desc
, &chan
->dma_chan
);
337 desc
->tx_desc
.flags
= flags
;
338 desc
->tx_desc
.tx_submit
= ccp_tx_submit
;
339 desc
->ccp
= chan
->ccp
;
340 INIT_LIST_HEAD(&desc
->pending
);
341 INIT_LIST_HEAD(&desc
->active
);
342 desc
->status
= DMA_IN_PROGRESS
;
347 static struct ccp_dma_desc
*ccp_create_desc(struct dma_chan
*dma_chan
,
348 struct scatterlist
*dst_sg
,
349 unsigned int dst_nents
,
350 struct scatterlist
*src_sg
,
351 unsigned int src_nents
,
354 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
356 struct ccp_device
*ccp
= chan
->ccp
;
357 struct ccp_dma_desc
*desc
;
358 struct ccp_dma_cmd
*cmd
;
359 struct ccp_cmd
*ccp_cmd
;
360 struct ccp_passthru_nomap_engine
*ccp_pt
;
361 unsigned int src_offset
, src_len
;
362 unsigned int dst_offset
, dst_len
;
364 unsigned long sflags
;
367 if (!dst_sg
|| !src_sg
)
370 if (!dst_nents
|| !src_nents
)
373 desc
= ccp_alloc_dma_desc(chan
, flags
);
379 src_len
= sg_dma_len(src_sg
);
382 dst_len
= sg_dma_len(dst_sg
);
391 src_sg
= sg_next(src_sg
);
395 src_len
= sg_dma_len(src_sg
);
405 dst_sg
= sg_next(dst_sg
);
409 dst_len
= sg_dma_len(dst_sg
);
414 len
= min(dst_len
, src_len
);
416 cmd
= ccp_alloc_dma_cmd(chan
);
420 ccp_cmd
= &cmd
->ccp_cmd
;
421 ccp_cmd
->ccp
= chan
->ccp
;
422 ccp_pt
= &ccp_cmd
->u
.passthru_nomap
;
423 ccp_cmd
->flags
= CCP_CMD_MAY_BACKLOG
;
424 ccp_cmd
->flags
|= CCP_CMD_PASSTHRU_NO_DMA_MAP
;
425 ccp_cmd
->engine
= CCP_ENGINE_PASSTHRU
;
426 ccp_pt
->bit_mod
= CCP_PASSTHRU_BITWISE_NOOP
;
427 ccp_pt
->byte_swap
= CCP_PASSTHRU_BYTESWAP_NOOP
;
428 ccp_pt
->src_dma
= sg_dma_address(src_sg
) + src_offset
;
429 ccp_pt
->dst_dma
= sg_dma_address(dst_sg
) + dst_offset
;
430 ccp_pt
->src_len
= len
;
432 ccp_cmd
->callback
= ccp_cmd_callback
;
433 ccp_cmd
->data
= desc
;
435 list_add_tail(&cmd
->entry
, &desc
->pending
);
438 "%s - cmd=%p, src=%pad, dst=%pad, len=%llu\n", __func__
,
439 cmd
, &ccp_pt
->src_dma
,
440 &ccp_pt
->dst_dma
, ccp_pt
->src_len
);
451 desc
->len
= total_len
;
453 if (list_empty(&desc
->pending
))
456 dev_dbg(ccp
->dev
, "%s - desc=%p\n", __func__
, desc
);
458 spin_lock_irqsave(&chan
->lock
, sflags
);
460 list_add_tail(&desc
->entry
, &chan
->created
);
462 spin_unlock_irqrestore(&chan
->lock
, sflags
);
467 ccp_free_cmd_resources(ccp
, &desc
->pending
);
468 kmem_cache_free(ccp
->dma_desc_cache
, desc
);
473 static struct dma_async_tx_descriptor
*ccp_prep_dma_memcpy(
474 struct dma_chan
*dma_chan
, dma_addr_t dst
, dma_addr_t src
, size_t len
,
477 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
479 struct ccp_dma_desc
*desc
;
480 struct scatterlist dst_sg
, src_sg
;
482 dev_dbg(chan
->ccp
->dev
,
483 "%s - src=%pad, dst=%pad, len=%zu, flags=%#lx\n",
484 __func__
, &src
, &dst
, len
, flags
);
486 sg_init_table(&dst_sg
, 1);
487 sg_dma_address(&dst_sg
) = dst
;
488 sg_dma_len(&dst_sg
) = len
;
490 sg_init_table(&src_sg
, 1);
491 sg_dma_address(&src_sg
) = src
;
492 sg_dma_len(&src_sg
) = len
;
494 desc
= ccp_create_desc(dma_chan
, &dst_sg
, 1, &src_sg
, 1, flags
);
498 return &desc
->tx_desc
;
501 static struct dma_async_tx_descriptor
*ccp_prep_dma_interrupt(
502 struct dma_chan
*dma_chan
, unsigned long flags
)
504 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
506 struct ccp_dma_desc
*desc
;
508 desc
= ccp_alloc_dma_desc(chan
, flags
);
512 return &desc
->tx_desc
;
515 static void ccp_issue_pending(struct dma_chan
*dma_chan
)
517 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
519 struct ccp_dma_desc
*desc
;
522 dev_dbg(chan
->ccp
->dev
, "%s\n", __func__
);
524 spin_lock_irqsave(&chan
->lock
, flags
);
526 desc
= __ccp_pending_to_active(chan
);
528 spin_unlock_irqrestore(&chan
->lock
, flags
);
530 /* If there was nothing active, start processing */
532 ccp_cmd_callback(desc
, 0);
535 static enum dma_status
ccp_tx_status(struct dma_chan
*dma_chan
,
537 struct dma_tx_state
*state
)
539 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
541 struct ccp_dma_desc
*desc
;
545 if (chan
->status
== DMA_PAUSED
) {
550 ret
= dma_cookie_status(dma_chan
, cookie
, state
);
551 if (ret
== DMA_COMPLETE
) {
552 spin_lock_irqsave(&chan
->lock
, flags
);
554 /* Get status from complete chain, if still there */
555 list_for_each_entry(desc
, &chan
->complete
, entry
) {
556 if (desc
->tx_desc
.cookie
!= cookie
)
563 spin_unlock_irqrestore(&chan
->lock
, flags
);
567 dev_dbg(chan
->ccp
->dev
, "%s - %u\n", __func__
, ret
);
572 static int ccp_pause(struct dma_chan
*dma_chan
)
574 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
577 chan
->status
= DMA_PAUSED
;
579 /*TODO: Wait for active DMA to complete before returning? */
584 static int ccp_resume(struct dma_chan
*dma_chan
)
586 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
588 struct ccp_dma_desc
*desc
;
591 spin_lock_irqsave(&chan
->lock
, flags
);
593 desc
= list_first_entry_or_null(&chan
->active
, struct ccp_dma_desc
,
596 spin_unlock_irqrestore(&chan
->lock
, flags
);
598 /* Indicate the channel is running again */
599 chan
->status
= DMA_IN_PROGRESS
;
601 /* If there was something active, re-start */
603 ccp_cmd_callback(desc
, 0);
608 static int ccp_terminate_all(struct dma_chan
*dma_chan
)
610 struct ccp_dma_chan
*chan
= container_of(dma_chan
, struct ccp_dma_chan
,
614 dev_dbg(chan
->ccp
->dev
, "%s\n", __func__
);
616 /*TODO: Wait for active DMA to complete before continuing */
618 spin_lock_irqsave(&chan
->lock
, flags
);
620 /*TODO: Purge the complete list? */
621 ccp_free_desc_resources(chan
->ccp
, &chan
->active
);
622 ccp_free_desc_resources(chan
->ccp
, &chan
->pending
);
623 ccp_free_desc_resources(chan
->ccp
, &chan
->created
);
625 spin_unlock_irqrestore(&chan
->lock
, flags
);
630 int ccp_dmaengine_register(struct ccp_device
*ccp
)
632 struct ccp_dma_chan
*chan
;
633 struct dma_device
*dma_dev
= &ccp
->dma_dev
;
634 struct dma_chan
*dma_chan
;
635 char *dma_cmd_cache_name
;
636 char *dma_desc_cache_name
;
640 ccp
->ccp_dma_chan
= devm_kcalloc(ccp
->dev
, ccp
->cmd_q_count
,
641 sizeof(*(ccp
->ccp_dma_chan
)),
643 if (!ccp
->ccp_dma_chan
)
646 dma_cmd_cache_name
= devm_kasprintf(ccp
->dev
, GFP_KERNEL
,
647 "%s-dmaengine-cmd-cache",
649 if (!dma_cmd_cache_name
)
652 ccp
->dma_cmd_cache
= kmem_cache_create(dma_cmd_cache_name
,
653 sizeof(struct ccp_dma_cmd
),
655 SLAB_HWCACHE_ALIGN
, NULL
);
656 if (!ccp
->dma_cmd_cache
)
659 dma_desc_cache_name
= devm_kasprintf(ccp
->dev
, GFP_KERNEL
,
660 "%s-dmaengine-desc-cache",
662 if (!dma_desc_cache_name
) {
667 ccp
->dma_desc_cache
= kmem_cache_create(dma_desc_cache_name
,
668 sizeof(struct ccp_dma_desc
),
670 SLAB_HWCACHE_ALIGN
, NULL
);
671 if (!ccp
->dma_desc_cache
) {
676 dma_dev
->dev
= ccp
->dev
;
677 dma_dev
->src_addr_widths
= CCP_DMA_WIDTH(dma_get_mask(ccp
->dev
));
678 dma_dev
->dst_addr_widths
= CCP_DMA_WIDTH(dma_get_mask(ccp
->dev
));
679 dma_dev
->directions
= DMA_MEM_TO_MEM
;
680 dma_dev
->residue_granularity
= DMA_RESIDUE_GRANULARITY_DESCRIPTOR
;
681 dma_cap_set(DMA_MEMCPY
, dma_dev
->cap_mask
);
682 dma_cap_set(DMA_INTERRUPT
, dma_dev
->cap_mask
);
684 /* The DMA channels for this device can be set to public or private,
685 * and overridden by the module parameter dma_chan_attr.
686 * Default: according to the value in vdata (dma_chan_attr=0)
687 * dma_chan_attr=0x1: all channels private (override vdata)
688 * dma_chan_attr=0x2: all channels public (override vdata)
690 if (ccp_get_dma_chan_attr(ccp
) == DMA_PRIVATE
)
691 dma_cap_set(DMA_PRIVATE
, dma_dev
->cap_mask
);
693 INIT_LIST_HEAD(&dma_dev
->channels
);
694 for (i
= 0; i
< ccp
->cmd_q_count
; i
++) {
695 chan
= ccp
->ccp_dma_chan
+ i
;
696 dma_chan
= &chan
->dma_chan
;
700 spin_lock_init(&chan
->lock
);
701 INIT_LIST_HEAD(&chan
->created
);
702 INIT_LIST_HEAD(&chan
->pending
);
703 INIT_LIST_HEAD(&chan
->active
);
704 INIT_LIST_HEAD(&chan
->complete
);
706 tasklet_init(&chan
->cleanup_tasklet
, ccp_do_cleanup
,
707 (unsigned long)chan
);
709 dma_chan
->device
= dma_dev
;
710 dma_cookie_init(dma_chan
);
712 list_add_tail(&dma_chan
->device_node
, &dma_dev
->channels
);
715 dma_dev
->device_free_chan_resources
= ccp_free_chan_resources
;
716 dma_dev
->device_prep_dma_memcpy
= ccp_prep_dma_memcpy
;
717 dma_dev
->device_prep_dma_interrupt
= ccp_prep_dma_interrupt
;
718 dma_dev
->device_issue_pending
= ccp_issue_pending
;
719 dma_dev
->device_tx_status
= ccp_tx_status
;
720 dma_dev
->device_pause
= ccp_pause
;
721 dma_dev
->device_resume
= ccp_resume
;
722 dma_dev
->device_terminate_all
= ccp_terminate_all
;
724 ret
= dma_async_device_register(dma_dev
);
731 kmem_cache_destroy(ccp
->dma_desc_cache
);
734 kmem_cache_destroy(ccp
->dma_cmd_cache
);
739 void ccp_dmaengine_unregister(struct ccp_device
*ccp
)
741 struct dma_device
*dma_dev
= &ccp
->dma_dev
;
743 dma_async_device_unregister(dma_dev
);
745 kmem_cache_destroy(ccp
->dma_desc_cache
);
746 kmem_cache_destroy(ccp
->dma_cmd_cache
);