1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Copyright (C) 2017-2020 Xilinx, Inc. All rights reserved. 4 * Copyright (C) 2022, Advanced Micro Devices, Inc. 5 */ 6 7 #ifndef __DMA_XDMA_REGS_H 8 #define __DMA_XDMA_REGS_H 9 10 /* The length of register space exposed to host */ 11 #define XDMA_REG_SPACE_LEN 65536 12 13 /* 14 * maximum number of DMA channels for each direction: 15 * Host to Card (H2C) or Card to Host (C2H) 16 */ 17 #define XDMA_MAX_CHANNELS 4 18 19 /* 20 * macros to define the number of descriptor blocks can be used in one 21 * DMA transfer request. 22 * the DMA engine uses a linked list of descriptor blocks that specify the 23 * source, destination, and length of the DMA transfers. 24 */ 25 #define XDMA_DESC_BLOCK_NUM BIT(7) 26 #define XDMA_DESC_BLOCK_MASK (XDMA_DESC_BLOCK_NUM - 1) 27 28 /* descriptor definitions */ 29 #define XDMA_DESC_ADJACENT 32 30 #define XDMA_DESC_ADJACENT_MASK (XDMA_DESC_ADJACENT - 1) 31 #define XDMA_DESC_ADJACENT_BITS GENMASK(13, 8) 32 #define XDMA_DESC_MAGIC 0xad4bUL 33 #define XDMA_DESC_MAGIC_BITS GENMASK(31, 16) 34 #define XDMA_DESC_FLAGS_BITS GENMASK(7, 0) 35 #define XDMA_DESC_STOPPED BIT(0) 36 #define XDMA_DESC_COMPLETED BIT(1) 37 #define XDMA_DESC_BLEN_BITS 28 38 #define XDMA_DESC_BLEN_MAX (BIT(XDMA_DESC_BLEN_BITS) - PAGE_SIZE) 39 40 /* macros to construct the descriptor control word */ 41 #define XDMA_DESC_CONTROL(adjacent, flag) \ 42 (FIELD_PREP(XDMA_DESC_MAGIC_BITS, XDMA_DESC_MAGIC) | \ 43 FIELD_PREP(XDMA_DESC_ADJACENT_BITS, (adjacent) - 1) | \ 44 FIELD_PREP(XDMA_DESC_FLAGS_BITS, (flag))) 45 #define XDMA_DESC_CONTROL_LAST \ 46 XDMA_DESC_CONTROL(1, XDMA_DESC_STOPPED | XDMA_DESC_COMPLETED) 47 #define XDMA_DESC_CONTROL_CYCLIC \ 48 XDMA_DESC_CONTROL(1, XDMA_DESC_COMPLETED) 49 50 /* 51 * Descriptor for a single contiguous memory block transfer. 52 * 53 * Multiple descriptors are linked by means of the next pointer. An additional 54 * extra adjacent number gives the amount of extra contiguous descriptors. 55 * 56 * The descriptors are in root complex memory, and the bytes in the 32-bit 57 * words must be in little-endian byte ordering. 58 */ 59 struct xdma_hw_desc { 60 __le32 control; 61 __le32 bytes; 62 __le64 src_addr; 63 __le64 dst_addr; 64 __le64 next_desc; 65 }; 66 67 #define XDMA_DESC_SIZE sizeof(struct xdma_hw_desc) 68 #define XDMA_DESC_BLOCK_SIZE (XDMA_DESC_SIZE * XDMA_DESC_ADJACENT) 69 #define XDMA_DESC_BLOCK_ALIGN 32 70 #define XDMA_DESC_BLOCK_BOUNDARY 4096 71 72 /* 73 * Channel registers 74 */ 75 #define XDMA_CHAN_IDENTIFIER 0x0 76 #define XDMA_CHAN_CONTROL 0x4 77 #define XDMA_CHAN_CONTROL_W1S 0x8 78 #define XDMA_CHAN_CONTROL_W1C 0xc 79 #define XDMA_CHAN_STATUS 0x40 80 #define XDMA_CHAN_STATUS_RC 0x44 81 #define XDMA_CHAN_COMPLETED_DESC 0x48 82 #define XDMA_CHAN_ALIGNMENTS 0x4c 83 #define XDMA_CHAN_INTR_ENABLE 0x90 84 #define XDMA_CHAN_INTR_ENABLE_W1S 0x94 85 #define XDMA_CHAN_INTR_ENABLE_W1C 0x9c 86 87 #define XDMA_CHAN_STRIDE 0x100 88 #define XDMA_CHAN_H2C_OFFSET 0x0 89 #define XDMA_CHAN_C2H_OFFSET 0x1000 90 #define XDMA_CHAN_H2C_TARGET 0x0 91 #define XDMA_CHAN_C2H_TARGET 0x1 92 93 /* macro to check if channel is available */ 94 #define XDMA_CHAN_MAGIC 0x1fc0 95 #define XDMA_CHAN_CHECK_TARGET(id, target) \ 96 (((u32)(id) >> 16) == XDMA_CHAN_MAGIC + (target)) 97 98 /* bits of the channel control register */ 99 #define CHAN_CTRL_RUN_STOP BIT(0) 100 #define CHAN_CTRL_IE_DESC_STOPPED BIT(1) 101 #define CHAN_CTRL_IE_DESC_COMPLETED BIT(2) 102 #define CHAN_CTRL_IE_DESC_ALIGN_MISMATCH BIT(3) 103 #define CHAN_CTRL_IE_MAGIC_STOPPED BIT(4) 104 #define CHAN_CTRL_IE_IDLE_STOPPED BIT(6) 105 #define CHAN_CTRL_IE_READ_ERROR GENMASK(13, 9) 106 #define CHAN_CTRL_IE_WRITE_ERROR GENMASK(18, 14) 107 #define CHAN_CTRL_IE_DESC_ERROR GENMASK(23, 19) 108 #define CHAN_CTRL_NON_INCR_ADDR BIT(25) 109 #define CHAN_CTRL_POLL_MODE_WB BIT(26) 110 111 #define CHAN_CTRL_START (CHAN_CTRL_RUN_STOP | \ 112 CHAN_CTRL_IE_DESC_STOPPED | \ 113 CHAN_CTRL_IE_DESC_COMPLETED | \ 114 CHAN_CTRL_IE_DESC_ALIGN_MISMATCH | \ 115 CHAN_CTRL_IE_MAGIC_STOPPED | \ 116 CHAN_CTRL_IE_READ_ERROR | \ 117 CHAN_CTRL_IE_WRITE_ERROR | \ 118 CHAN_CTRL_IE_DESC_ERROR) 119 120 /* bits of the channel status register */ 121 #define XDMA_CHAN_STATUS_BUSY BIT(0) 122 123 #define XDMA_CHAN_STATUS_MASK CHAN_CTRL_START 124 125 #define XDMA_CHAN_ERROR_MASK (CHAN_CTRL_IE_DESC_ALIGN_MISMATCH | \ 126 CHAN_CTRL_IE_MAGIC_STOPPED | \ 127 CHAN_CTRL_IE_READ_ERROR | \ 128 CHAN_CTRL_IE_WRITE_ERROR | \ 129 CHAN_CTRL_IE_DESC_ERROR) 130 131 /* bits of the channel interrupt enable mask */ 132 #define CHAN_IM_DESC_ERROR BIT(19) 133 #define CHAN_IM_READ_ERROR BIT(9) 134 #define CHAN_IM_IDLE_STOPPED BIT(6) 135 #define CHAN_IM_MAGIC_STOPPED BIT(4) 136 #define CHAN_IM_DESC_COMPLETED BIT(2) 137 #define CHAN_IM_DESC_STOPPED BIT(1) 138 139 #define CHAN_IM_ALL (CHAN_IM_DESC_ERROR | CHAN_IM_READ_ERROR | \ 140 CHAN_IM_IDLE_STOPPED | CHAN_IM_MAGIC_STOPPED | \ 141 CHAN_IM_DESC_COMPLETED | CHAN_IM_DESC_STOPPED) 142 143 /* 144 * Channel SGDMA registers 145 */ 146 #define XDMA_SGDMA_IDENTIFIER 0x4000 147 #define XDMA_SGDMA_DESC_LO 0x4080 148 #define XDMA_SGDMA_DESC_HI 0x4084 149 #define XDMA_SGDMA_DESC_ADJ 0x4088 150 #define XDMA_SGDMA_DESC_CREDIT 0x408c 151 152 /* 153 * interrupt registers 154 */ 155 #define XDMA_IRQ_IDENTIFIER 0x2000 156 #define XDMA_IRQ_USER_INT_EN 0x2004 157 #define XDMA_IRQ_USER_INT_EN_W1S 0x2008 158 #define XDMA_IRQ_USER_INT_EN_W1C 0x200c 159 #define XDMA_IRQ_CHAN_INT_EN 0x2010 160 #define XDMA_IRQ_CHAN_INT_EN_W1S 0x2014 161 #define XDMA_IRQ_CHAN_INT_EN_W1C 0x2018 162 #define XDMA_IRQ_USER_INT_REQ 0x2040 163 #define XDMA_IRQ_CHAN_INT_REQ 0x2044 164 #define XDMA_IRQ_USER_INT_PEND 0x2048 165 #define XDMA_IRQ_CHAN_INT_PEND 0x204c 166 #define XDMA_IRQ_USER_VEC_NUM 0x2080 167 #define XDMA_IRQ_CHAN_VEC_NUM 0x20a0 168 169 #define XDMA_IRQ_VEC_SHIFT 8 170 171 #endif /* __DMA_XDMA_REGS_H */ 172