xref: /wlan-dirver/qca-wifi-host-cmn/hif/src/ce/ce_reg.h (revision 8cfe6b10058a04cafb17eed051f2ddf11bee8931)
1 /*
2  * Copyright (c) 2015-2020 The Linux Foundation. All rights reserved.
3  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #ifndef __CE_REG_H__
21 #define __CE_REG_H__
22 
23 #define COPY_ENGINE_ID(COPY_ENGINE_BASE_ADDRESS) ((COPY_ENGINE_BASE_ADDRESS \
24 		- CE0_BASE_ADDRESS)/(CE1_BASE_ADDRESS - CE0_BASE_ADDRESS))
25 
26 #define DST_WR_INDEX_ADDRESS    (scn->target_ce_def->d_DST_WR_INDEX_ADDRESS)
27 #define SRC_WATERMARK_ADDRESS   (scn->target_ce_def->d_SRC_WATERMARK_ADDRESS)
28 #define SRC_WATERMARK_LOW_MASK  (scn->target_ce_def->d_SRC_WATERMARK_LOW_MASK)
29 #define SRC_WATERMARK_HIGH_MASK (scn->target_ce_def->d_SRC_WATERMARK_HIGH_MASK)
30 #define DST_WATERMARK_LOW_MASK  (scn->target_ce_def->d_DST_WATERMARK_LOW_MASK)
31 #define DST_WATERMARK_HIGH_MASK (scn->target_ce_def->d_DST_WATERMARK_HIGH_MASK)
32 #define CURRENT_SRRI_ADDRESS    (scn->target_ce_def->d_CURRENT_SRRI_ADDRESS)
33 #define CURRENT_DRRI_ADDRESS    (scn->target_ce_def->d_CURRENT_DRRI_ADDRESS)
34 
35 #define SHADOW_VALUE0    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_0)
36 #define SHADOW_VALUE1    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_1)
37 #define SHADOW_VALUE2    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_2)
38 #define SHADOW_VALUE3    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_3)
39 #define SHADOW_VALUE4    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_4)
40 #define SHADOW_VALUE5    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_5)
41 #define SHADOW_VALUE6    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_6)
42 #define SHADOW_VALUE7    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_7)
43 #define SHADOW_VALUE8    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_8)
44 #define SHADOW_VALUE9    (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_9)
45 #define SHADOW_VALUE10   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_10)
46 #define SHADOW_VALUE11   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_11)
47 #define SHADOW_VALUE12   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_12)
48 #define SHADOW_VALUE13   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_13)
49 #define SHADOW_VALUE14   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_14)
50 #define SHADOW_VALUE15   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_15)
51 #define SHADOW_VALUE16   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_16)
52 #define SHADOW_VALUE17   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_17)
53 #define SHADOW_VALUE18   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_18)
54 #define SHADOW_VALUE19   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_19)
55 #define SHADOW_VALUE20   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_20)
56 #define SHADOW_VALUE21   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_21)
57 #define SHADOW_VALUE22   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_22)
58 #define SHADOW_VALUE23   (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_VALUE_23)
59 #define SHADOW_ADDRESS0  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_0)
60 #define SHADOW_ADDRESS1  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_1)
61 #define SHADOW_ADDRESS2  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_2)
62 #define SHADOW_ADDRESS3  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_3)
63 #define SHADOW_ADDRESS4  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_4)
64 #define SHADOW_ADDRESS5  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_5)
65 #define SHADOW_ADDRESS6  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_6)
66 #define SHADOW_ADDRESS7  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_7)
67 #define SHADOW_ADDRESS8  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_8)
68 #define SHADOW_ADDRESS9  (scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_9)
69 #define SHADOW_ADDRESS10 \
70 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_10)
71 #define SHADOW_ADDRESS11 \
72 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_11)
73 #define SHADOW_ADDRESS12 \
74 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_12)
75 #define SHADOW_ADDRESS13 \
76 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_13)
77 #define SHADOW_ADDRESS14 \
78 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_14)
79 #define SHADOW_ADDRESS15 \
80 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_15)
81 #define SHADOW_ADDRESS16 \
82 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_16)
83 #define SHADOW_ADDRESS17 \
84 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_17)
85 #define SHADOW_ADDRESS18 \
86 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_18)
87 #define SHADOW_ADDRESS19 \
88 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_19)
89 #define SHADOW_ADDRESS20 \
90 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_20)
91 #define SHADOW_ADDRESS21 \
92 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_21)
93 #define SHADOW_ADDRESS22 \
94 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_22)
95 #define SHADOW_ADDRESS23 \
96 			(scn->host_shadow_regs->d_A_LOCAL_SHADOW_REG_ADDRESS_23)
97 
98 #define SHADOW_ADDRESS(i) \
99 			(SHADOW_ADDRESS0 + i*(SHADOW_ADDRESS1-SHADOW_ADDRESS0))
100 
101 #define HOST_IS_SRC_RING_HIGH_WATERMARK_MASK \
102 	(scn->target_ce_def->d_HOST_IS_SRC_RING_HIGH_WATERMARK_MASK)
103 #define HOST_IS_SRC_RING_LOW_WATERMARK_MASK \
104 	(scn->target_ce_def->d_HOST_IS_SRC_RING_LOW_WATERMARK_MASK)
105 #define HOST_IS_DST_RING_HIGH_WATERMARK_MASK \
106 	(scn->target_ce_def->d_HOST_IS_DST_RING_HIGH_WATERMARK_MASK)
107 #define HOST_IS_DST_RING_LOW_WATERMARK_MASK \
108 	(scn->target_ce_def->d_HOST_IS_DST_RING_LOW_WATERMARK_MASK)
109 #define MISC_IS_ADDRESS         (scn->target_ce_def->d_MISC_IS_ADDRESS)
110 #define HOST_IS_COPY_COMPLETE_MASK \
111 	(scn->target_ce_def->d_HOST_IS_COPY_COMPLETE_MASK)
112 #define CE_WRAPPER_BASE_ADDRESS (scn->target_ce_def->d_CE_WRAPPER_BASE_ADDRESS)
113 #define CE_WRAPPER_INTERRUPT_SUMMARY_ADDRESS \
114 	(scn->target_ce_def->d_CE_WRAPPER_INTERRUPT_SUMMARY_ADDRESS)
115 #define CE_DDR_ADDRESS_FOR_RRI_LOW \
116 	(scn->target_ce_def->d_CE_DDR_ADDRESS_FOR_RRI_LOW)
117 #define CE_DDR_ADDRESS_FOR_RRI_HIGH \
118 	(scn->target_ce_def->d_CE_DDR_ADDRESS_FOR_RRI_HIGH)
119 #define HOST_IE_COPY_COMPLETE_MASK \
120 	(scn->target_ce_def->d_HOST_IE_COPY_COMPLETE_MASK)
121 #define SR_BA_ADDRESS             (scn->target_ce_def->d_SR_BA_ADDRESS)
122 #define SR_BA_ADDRESS_HIGH        (scn->target_ce_def->d_SR_BA_ADDRESS_HIGH)
123 #define SR_SIZE_ADDRESS           (scn->target_ce_def->d_SR_SIZE_ADDRESS)
124 #define CE_CTRL1_ADDRESS          (scn->target_ce_def->d_CE_CTRL1_ADDRESS)
125 #define CE_CTRL1_DMAX_LENGTH_MASK \
126 	(scn->target_ce_def->d_CE_CTRL1_DMAX_LENGTH_MASK)
127 #define DR_BA_ADDRESS             (scn->target_ce_def->d_DR_BA_ADDRESS)
128 #define DR_BA_ADDRESS_HIGH        (scn->target_ce_def->d_DR_BA_ADDRESS_HIGH)
129 #define DR_SIZE_ADDRESS           (scn->target_ce_def->d_DR_SIZE_ADDRESS)
130 #define CE_CMD_REGISTER           (scn->target_ce_def->d_CE_CMD_REGISTER)
131 #define CE_MSI_ADDRESS            (scn->target_ce_def->d_CE_MSI_ADDRESS)
132 #define CE_MSI_ADDRESS_HIGH       (scn->target_ce_def->d_CE_MSI_ADDRESS_HIGH)
133 #define CE_MSI_DATA               (scn->target_ce_def->d_CE_MSI_DATA)
134 #define CE_MSI_ENABLE_BIT         (scn->target_ce_def->d_CE_MSI_ENABLE_BIT)
135 #define MISC_IE_ADDRESS           (scn->target_ce_def->d_MISC_IE_ADDRESS)
136 #define MISC_IS_AXI_ERR_MASK      (scn->target_ce_def->d_MISC_IS_AXI_ERR_MASK)
137 #define MISC_IS_DST_ADDR_ERR_MASK \
138 	(scn->target_ce_def->d_MISC_IS_DST_ADDR_ERR_MASK)
139 #define MISC_IS_SRC_LEN_ERR_MASK \
140 	(scn->target_ce_def->d_MISC_IS_SRC_LEN_ERR_MASK)
141 #define MISC_IS_DST_MAX_LEN_VIO_MASK \
142 	(scn->target_ce_def->d_MISC_IS_DST_MAX_LEN_VIO_MASK)
143 #define MISC_IS_DST_RING_OVERFLOW_MASK \
144 	(scn->target_ce_def->d_MISC_IS_DST_RING_OVERFLOW_MASK)
145 #define MISC_IS_SRC_RING_OVERFLOW_MASK \
146 	(scn->target_ce_def->d_MISC_IS_SRC_RING_OVERFLOW_MASK)
147 #define SRC_WATERMARK_LOW_LSB     (scn->target_ce_def->d_SRC_WATERMARK_LOW_LSB)
148 #define SRC_WATERMARK_HIGH_LSB    (scn->target_ce_def->d_SRC_WATERMARK_HIGH_LSB)
149 #define DST_WATERMARK_LOW_LSB     (scn->target_ce_def->d_DST_WATERMARK_LOW_LSB)
150 #define DST_WATERMARK_HIGH_LSB    (scn->target_ce_def->d_DST_WATERMARK_HIGH_LSB)
151 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_MASK \
152 	(scn->target_ce_def->d_CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_MASK)
153 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_LSB  \
154 	(scn->target_ce_def->d_CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_LSB)
155 #define CE_CTRL1_DMAX_LENGTH_LSB \
156 				(scn->target_ce_def->d_CE_CTRL1_DMAX_LENGTH_LSB)
157 #define CE_CTRL1_IDX_UPD_EN  (scn->target_ce_def->d_CE_CTRL1_IDX_UPD_EN_MASK)
158 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK \
159 	(scn->target_ce_def->d_CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK)
160 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK \
161 	(scn->target_ce_def->d_CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK)
162 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB \
163 	(scn->target_ce_def->d_CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB)
164 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_LSB \
165 	(scn->target_ce_def->d_CE_CTRL1_DST_RING_BYTE_SWAP_EN_LSB)
166 #define WLAN_DEBUG_INPUT_SEL_OFFSET \
167 	(scn->targetdef->d_WLAN_DEBUG_INPUT_SEL_OFFSET)
168 #define WLAN_DEBUG_INPUT_SEL_SRC_MSB \
169 	(scn->targetdef->d_WLAN_DEBUG_INPUT_SEL_SRC_MSB)
170 #define WLAN_DEBUG_INPUT_SEL_SRC_LSB \
171 	(scn->targetdef->d_WLAN_DEBUG_INPUT_SEL_SRC_LSB)
172 #define WLAN_DEBUG_INPUT_SEL_SRC_MASK \
173 	(scn->targetdef->d_WLAN_DEBUG_INPUT_SEL_SRC_MASK)
174 #define WLAN_DEBUG_CONTROL_OFFSET  (scn->targetdef->d_WLAN_DEBUG_CONTROL_OFFSET)
175 #define WLAN_DEBUG_CONTROL_ENABLE_MSB \
176 	(scn->targetdef->d_WLAN_DEBUG_CONTROL_ENABLE_MSB)
177 #define WLAN_DEBUG_CONTROL_ENABLE_LSB \
178 	(scn->targetdef->d_WLAN_DEBUG_CONTROL_ENABLE_LSB)
179 #define WLAN_DEBUG_CONTROL_ENABLE_MASK \
180 	(scn->targetdef->d_WLAN_DEBUG_CONTROL_ENABLE_MASK)
181 #define WLAN_DEBUG_OUT_OFFSET    (scn->targetdef->d_WLAN_DEBUG_OUT_OFFSET)
182 #define WLAN_DEBUG_OUT_DATA_MSB  (scn->targetdef->d_WLAN_DEBUG_OUT_DATA_MSB)
183 #define WLAN_DEBUG_OUT_DATA_LSB  (scn->targetdef->d_WLAN_DEBUG_OUT_DATA_LSB)
184 #define WLAN_DEBUG_OUT_DATA_MASK (scn->targetdef->d_WLAN_DEBUG_OUT_DATA_MASK)
185 #define AMBA_DEBUG_BUS_OFFSET    (scn->targetdef->d_AMBA_DEBUG_BUS_OFFSET)
186 #define AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MSB \
187 	(scn->targetdef->d_AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MSB)
188 #define AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_LSB \
189 	(scn->targetdef->d_AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_LSB)
190 #define AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MASK \
191 	(scn->targetdef->d_AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MASK)
192 #define AMBA_DEBUG_BUS_SEL_MSB    (scn->targetdef->d_AMBA_DEBUG_BUS_SEL_MSB)
193 #define AMBA_DEBUG_BUS_SEL_LSB    (scn->targetdef->d_AMBA_DEBUG_BUS_SEL_LSB)
194 #define AMBA_DEBUG_BUS_SEL_MASK   (scn->targetdef->d_AMBA_DEBUG_BUS_SEL_MASK)
195 #define CE_WRAPPER_DEBUG_OFFSET   \
196 				(scn->target_ce_def->d_CE_WRAPPER_DEBUG_OFFSET)
197 #define CE_WRAPPER_DEBUG_SEL_MSB  \
198 				(scn->target_ce_def->d_CE_WRAPPER_DEBUG_SEL_MSB)
199 #define CE_WRAPPER_DEBUG_SEL_LSB  \
200 				(scn->target_ce_def->d_CE_WRAPPER_DEBUG_SEL_LSB)
201 #define CE_WRAPPER_DEBUG_SEL_MASK \
202 			(scn->target_ce_def->d_CE_WRAPPER_DEBUG_SEL_MASK)
203 #define CE_DEBUG_OFFSET           (scn->target_ce_def->d_CE_DEBUG_OFFSET)
204 #define CE_DEBUG_SEL_MSB          (scn->target_ce_def->d_CE_DEBUG_SEL_MSB)
205 #define CE_DEBUG_SEL_LSB          (scn->target_ce_def->d_CE_DEBUG_SEL_LSB)
206 #define CE_DEBUG_SEL_MASK         (scn->target_ce_def->d_CE_DEBUG_SEL_MASK)
207 #define HOST_IE_ADDRESS           (scn->target_ce_def->d_HOST_IE_ADDRESS)
208 #define HOST_IE_REG1_CE_LSB       (scn->target_ce_def->d_HOST_IE_REG1_CE_LSB)
209 #define HOST_IE_ADDRESS_2         (scn->target_ce_def->d_HOST_IE_ADDRESS_2)
210 #define HOST_IE_REG2_CE_LSB       (scn->target_ce_def->d_HOST_IE_REG2_CE_LSB)
211 #define HOST_IE_ADDRESS_3         (scn->target_ce_def->d_HOST_IE_ADDRESS_3)
212 #define HOST_IE_REG3_CE_LSB       (scn->target_ce_def->d_HOST_IE_REG3_CE_LSB)
213 #define HOST_IS_ADDRESS           (scn->target_ce_def->d_HOST_IS_ADDRESS)
214 #define HOST_CE_ADDRESS           (scn->target_ce_def->d_HOST_CE_ADDRESS)
215 #define HOST_CMEM_ADDRESS         (scn->target_ce_def->d_HOST_CMEM_ADDRESS)
216 #define PMM_SCRATCH_BASE	  (scn->target_ce_def->d_PMM_SCRATCH_BASE)
217 
218 #define SRC_WATERMARK_LOW_SET(x) \
219 	(((x) << SRC_WATERMARK_LOW_LSB) & SRC_WATERMARK_LOW_MASK)
220 #define SRC_WATERMARK_HIGH_SET(x) \
221 	(((x) << SRC_WATERMARK_HIGH_LSB) & SRC_WATERMARK_HIGH_MASK)
222 #define DST_WATERMARK_LOW_SET(x) \
223 	(((x) << DST_WATERMARK_LOW_LSB) & DST_WATERMARK_LOW_MASK)
224 #define DST_WATERMARK_HIGH_SET(x) \
225 	(((x) << DST_WATERMARK_HIGH_LSB) & DST_WATERMARK_HIGH_MASK)
226 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_GET(x) \
227 	(((x) & CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_MASK) >> \
228 		CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_LSB)
229 #define CE_CTRL1_DMAX_LENGTH_SET(x) \
230 	(((x) << CE_CTRL1_DMAX_LENGTH_LSB) & CE_CTRL1_DMAX_LENGTH_MASK)
231 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_SET(x) \
232 	(((x) << CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB) & \
233 		CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK)
234 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_SET(x) \
235 	(((x) << CE_CTRL1_DST_RING_BYTE_SWAP_EN_LSB) & \
236 		CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK)
237 #define WLAN_DEBUG_INPUT_SEL_SRC_GET(x) \
238 	(((x) & WLAN_DEBUG_INPUT_SEL_SRC_MASK) >> \
239 		WLAN_DEBUG_INPUT_SEL_SRC_LSB)
240 #define WLAN_DEBUG_INPUT_SEL_SRC_SET(x) \
241 	(((x) << WLAN_DEBUG_INPUT_SEL_SRC_LSB) & \
242 		WLAN_DEBUG_INPUT_SEL_SRC_MASK)
243 #define WLAN_DEBUG_CONTROL_ENABLE_GET(x) \
244 	(((x) & WLAN_DEBUG_CONTROL_ENABLE_MASK) >> \
245 		WLAN_DEBUG_CONTROL_ENABLE_LSB)
246 #define WLAN_DEBUG_CONTROL_ENABLE_SET(x) \
247 	(((x) << WLAN_DEBUG_CONTROL_ENABLE_LSB) & \
248 		WLAN_DEBUG_CONTROL_ENABLE_MASK)
249 #define WLAN_DEBUG_OUT_DATA_GET(x) \
250 	(((x) & WLAN_DEBUG_OUT_DATA_MASK) >> WLAN_DEBUG_OUT_DATA_LSB)
251 #define WLAN_DEBUG_OUT_DATA_SET(x) \
252 	(((x) << WLAN_DEBUG_OUT_DATA_LSB) & WLAN_DEBUG_OUT_DATA_MASK)
253 #define AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_GET(x) \
254 	(((x) & AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MASK) >> \
255 		AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_LSB)
256 #define AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_SET(x) \
257 	(((x) << AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_LSB) & \
258 		AMBA_DEBUG_BUS_PCIE_DEBUG_SEL_MASK)
259 #define AMBA_DEBUG_BUS_SEL_GET(x) \
260 	(((x) & AMBA_DEBUG_BUS_SEL_MASK) >> AMBA_DEBUG_BUS_SEL_LSB)
261 #define AMBA_DEBUG_BUS_SEL_SET(x) \
262 	(((x) << AMBA_DEBUG_BUS_SEL_LSB) & AMBA_DEBUG_BUS_SEL_MASK)
263 #define CE_WRAPPER_DEBUG_SEL_GET(x) \
264 	(((x) & CE_WRAPPER_DEBUG_SEL_MASK) >> CE_WRAPPER_DEBUG_SEL_LSB)
265 #define CE_WRAPPER_DEBUG_SEL_SET(x) \
266 	(((x) << CE_WRAPPER_DEBUG_SEL_LSB) & CE_WRAPPER_DEBUG_SEL_MASK)
267 #define CE_DEBUG_SEL_GET(x) (((x) & CE_DEBUG_SEL_MASK) >> CE_DEBUG_SEL_LSB)
268 #define CE_DEBUG_SEL_SET(x) (((x) << CE_DEBUG_SEL_LSB) & CE_DEBUG_SEL_MASK)
269 #define HOST_IE_REG1_CE_BIT(_ce_id) (1 << (_ce_id + HOST_IE_REG1_CE_LSB))
270 #define HOST_IE_REG2_CE_BIT(_ce_id) (1 << (_ce_id + HOST_IE_REG2_CE_LSB))
271 #define HOST_IE_REG3_CE_BIT(_ce_id) (1 << (_ce_id + HOST_IE_REG3_CE_LSB))
272 
273 uint32_t DEBUG_CE_SRC_RING_READ_IDX_GET(struct hif_softc *scn,
274 		uint32_t CE_ctrl_addr);
275 uint32_t DEBUG_CE_DEST_RING_READ_IDX_GET(struct hif_softc *scn,
276 		uint32_t CE_ctrl_addr);
277 
278 #define BITS0_TO_31(val) ((uint32_t)((uint64_t)(val)\
279 				     & (uint64_t)(0xFFFFFFFF)))
280 #define BITS32_TO_35(val) ((uint32_t)(((uint64_t)(val)\
281 				     & (uint64_t)(0xF00000000))>>32))
282 
283 #define VADDR_FOR_CE(scn, CE_ctrl_addr)\
284 	((scn->vaddr_rri_on_ddr) + COPY_ENGINE_ID(CE_ctrl_addr))
285 
286 #define SRRI_FROM_DDR_ADDR(addr) ((*(addr)) & 0xFFFF)
287 #define DRRI_FROM_DDR_ADDR(addr) (((*(addr))>>16) & 0xFFFF)
288 
289 #define CE_SRC_RING_READ_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr) \
290 	A_TARGET_READ(scn, (CE_ctrl_addr) + CURRENT_SRRI_ADDRESS)
291 #define CE_DEST_RING_READ_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr) \
292 	A_TARGET_READ(scn, (CE_ctrl_addr) + CURRENT_DRRI_ADDRESS)
293 
294 #ifdef ADRASTEA_RRI_ON_DDR
295 #ifdef SHADOW_REG_DEBUG
296 #define CE_SRC_RING_READ_IDX_GET_FROM_DDR(scn, CE_ctrl_addr)\
297 	DEBUG_CE_SRC_RING_READ_IDX_GET(scn, CE_ctrl_addr)
298 #define CE_DEST_RING_READ_IDX_GET_FROM_DDR(scn, CE_ctrl_addr)\
299 	DEBUG_CE_DEST_RING_READ_IDX_GET(scn, CE_ctrl_addr)
300 #else
301 #define CE_SRC_RING_READ_IDX_GET_FROM_DDR(scn, CE_ctrl_addr)\
302 	SRRI_FROM_DDR_ADDR(VADDR_FOR_CE(scn, CE_ctrl_addr))
303 #define CE_DEST_RING_READ_IDX_GET_FROM_DDR(scn, CE_ctrl_addr)\
304 	DRRI_FROM_DDR_ADDR(VADDR_FOR_CE(scn, CE_ctrl_addr))
305 #endif
306 
307 unsigned int hif_get_src_ring_read_index(struct hif_softc *scn,
308 		uint32_t CE_ctrl_addr);
309 unsigned int hif_get_dst_ring_read_index(struct hif_softc *scn,
310 		uint32_t CE_ctrl_addr);
311 
312 #define CE_SRC_RING_READ_IDX_GET(scn, CE_ctrl_addr)\
313 	hif_get_src_ring_read_index(scn, CE_ctrl_addr)
314 #define CE_DEST_RING_READ_IDX_GET(scn, CE_ctrl_addr)\
315 	hif_get_dst_ring_read_index(scn, CE_ctrl_addr)
316 #else
317 #define CE_SRC_RING_READ_IDX_GET(scn, CE_ctrl_addr) \
318 	CE_SRC_RING_READ_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr)
319 #define CE_DEST_RING_READ_IDX_GET(scn, CE_ctrl_addr)\
320 	CE_DEST_RING_READ_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr)
321 
322 /*
323  * if RRI on DDR is not enabled, get idx from ddr defaults to
324  * using the register value & force wake must be used for
325  * non interrupt processing.
326  */
327 #define CE_SRC_RING_READ_IDX_GET_FROM_DDR(scn, CE_ctrl_addr)\
328 	A_TARGET_READ(scn, (CE_ctrl_addr) + CURRENT_SRRI_ADDRESS)
329 #endif
330 
331 #define CE_SRC_RING_BASE_ADDR_SET(scn, CE_ctrl_addr, addr) \
332 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SR_BA_ADDRESS, (addr))
333 
334 #define CE_SRC_RING_BASE_ADDR_HIGH_SET(scn, CE_ctrl_addr, addr) \
335 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SR_BA_ADDRESS_HIGH, (addr))
336 
337 #define CE_SRC_RING_BASE_ADDR_HIGH_GET(scn, CE_ctrl_addr) \
338 	A_TARGET_READ(scn, (CE_ctrl_addr) + SR_BA_ADDRESS_HIGH)
339 
340 #define CE_SRC_RING_SZ_SET(scn, CE_ctrl_addr, n) \
341 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SR_SIZE_ADDRESS, (n))
342 
343 #define CE_SRC_RING_DMAX_SET(scn, CE_ctrl_addr, n) \
344 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS, \
345 	   (A_TARGET_READ(scn, (CE_ctrl_addr) + \
346 	   CE_CTRL1_ADDRESS) & ~CE_CTRL1_DMAX_LENGTH_MASK) | \
347 	   CE_CTRL1_DMAX_LENGTH_SET(n))
348 
349 #define CE_IDX_UPD_EN_SET(scn, CE_ctrl_addr)  \
350 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS, \
351 	(A_TARGET_READ(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS) \
352 	| CE_CTRL1_IDX_UPD_EN))
353 
354 #define CE_CMD_REGISTER_GET(scn, CE_ctrl_addr) \
355 	A_TARGET_READ(scn, (CE_ctrl_addr) + CE_CMD_REGISTER)
356 
357 #define CE_CMD_REGISTER_SET(scn, CE_ctrl_addr, n) \
358 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_CMD_REGISTER, n)
359 
360 #define CE_MSI_ADDR_LOW_SET(scn, CE_ctrl_addr, addr) \
361 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_MSI_ADDRESS, (addr))
362 
363 #define CE_MSI_ADDR_HIGH_SET(scn, CE_ctrl_addr, addr) \
364 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_MSI_ADDRESS_HIGH, (addr))
365 
366 #define CE_MSI_DATA_SET(scn, CE_ctrl_addr, data) \
367 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_MSI_DATA, (data))
368 
369 #define CE_CTRL_REGISTER1_SET(scn, CE_ctrl_addr, val) \
370 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS, val)
371 
372 #define CE_CTRL_REGISTER1_GET(scn, CE_ctrl_addr) \
373 	A_TARGET_READ(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS)
374 
375 #define CE_SRC_RING_BYTE_SWAP_SET(scn, CE_ctrl_addr, n) \
376 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + CE_CTRL1_ADDRESS, \
377 		       (A_TARGET_READ(scn, \
378 		       (CE_ctrl_addr) + CE_CTRL1_ADDRESS) \
379 		       & ~CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK) | \
380 		       CE_CTRL1_SRC_RING_BYTE_SWAP_EN_SET(n))
381 
382 #define CE_DEST_RING_BYTE_SWAP_SET(scn, CE_ctrl_addr, n) \
383 	A_TARGET_WRITE(scn, (CE_ctrl_addr)+CE_CTRL1_ADDRESS, \
384 		       (A_TARGET_READ(scn, \
385 		       (CE_ctrl_addr) + CE_CTRL1_ADDRESS) \
386 		       & ~CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK) | \
387 		       CE_CTRL1_DST_RING_BYTE_SWAP_EN_SET(n))
388 
389 
390 #define CE_DEST_RING_BASE_ADDR_SET(scn, CE_ctrl_addr, addr) \
391 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DR_BA_ADDRESS, (addr))
392 
393 #define CE_DEST_RING_BASE_ADDR_HIGH_SET(scn, CE_ctrl_addr, addr) \
394 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DR_BA_ADDRESS_HIGH, (addr))
395 
396 #define CE_DEST_RING_BASE_ADDR_HIGH_GET(scn, CE_ctrl_addr) \
397 	A_TARGET_READ(scn, (CE_ctrl_addr) + DR_BA_ADDRESS_HIGH)
398 
399 #define CE_DEST_RING_SZ_SET(scn, CE_ctrl_addr, n) \
400 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DR_SIZE_ADDRESS, (n))
401 
402 #define CE_SRC_RING_HIGHMARK_SET(scn, CE_ctrl_addr, n) \
403 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SRC_WATERMARK_ADDRESS, \
404 		       (A_TARGET_READ(scn, \
405 		       (CE_ctrl_addr) + SRC_WATERMARK_ADDRESS) \
406 		       & ~SRC_WATERMARK_HIGH_MASK) | \
407 		       SRC_WATERMARK_HIGH_SET(n))
408 
409 #define CE_SRC_RING_LOWMARK_SET(scn, CE_ctrl_addr, n) \
410 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SRC_WATERMARK_ADDRESS, \
411 		       (A_TARGET_READ(scn, \
412 		       (CE_ctrl_addr) + SRC_WATERMARK_ADDRESS) \
413 		       & ~SRC_WATERMARK_LOW_MASK) | \
414 		       SRC_WATERMARK_LOW_SET(n))
415 
416 #define CE_DEST_RING_HIGHMARK_SET(scn, CE_ctrl_addr, n) \
417 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DST_WATERMARK_ADDRESS, \
418 		       (A_TARGET_READ(scn, \
419 		       (CE_ctrl_addr) + DST_WATERMARK_ADDRESS) \
420 		       & ~DST_WATERMARK_HIGH_MASK) | \
421 		       DST_WATERMARK_HIGH_SET(n))
422 
423 #define CE_DEST_RING_LOWMARK_SET(scn, CE_ctrl_addr, n) \
424 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DST_WATERMARK_ADDRESS, \
425 		       (A_TARGET_READ(scn, \
426 		       (CE_ctrl_addr) + DST_WATERMARK_ADDRESS) \
427 		       & ~DST_WATERMARK_LOW_MASK) | \
428 		       DST_WATERMARK_LOW_SET(n))
429 
430 #define CE_COPY_COMPLETE_INTR_ENABLE(scn, CE_ctrl_addr) \
431 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + HOST_IE_ADDRESS, \
432 		       A_TARGET_READ(scn, \
433 		       (CE_ctrl_addr) + HOST_IE_ADDRESS) | \
434 		       HOST_IE_COPY_COMPLETE_MASK)
435 
436 #define CE_COPY_COMPLETE_INTR_DISABLE(scn, CE_ctrl_addr) \
437 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + HOST_IE_ADDRESS, \
438 		       A_TARGET_READ(scn, \
439 		       (CE_ctrl_addr) + HOST_IE_ADDRESS) \
440 		       & ~HOST_IE_COPY_COMPLETE_MASK)
441 
442 #define CE_BASE_ADDRESS(CE_id) \
443 	CE0_BASE_ADDRESS + ((CE1_BASE_ADDRESS - \
444 	CE0_BASE_ADDRESS)*(CE_id))
445 
446 #define CE_WATERMARK_INTR_ENABLE(scn, CE_ctrl_addr) \
447 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + HOST_IE_ADDRESS, \
448 		       A_TARGET_READ(scn, \
449 		       (CE_ctrl_addr) + HOST_IE_ADDRESS) | \
450 		       CE_WATERMARK_MASK)
451 
452 #define CE_WATERMARK_INTR_DISABLE(scn, CE_ctrl_addr)	\
453 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + HOST_IE_ADDRESS, \
454 		       A_TARGET_READ(scn, \
455 		       (CE_ctrl_addr) + HOST_IE_ADDRESS) \
456 		       & ~CE_WATERMARK_MASK)
457 
458 #define CE_ERROR_INTR_ENABLE(scn, CE_ctrl_addr) \
459 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + MISC_IE_ADDRESS, \
460 		       A_TARGET_READ(scn, \
461 		       (CE_ctrl_addr) + MISC_IE_ADDRESS) | CE_ERROR_MASK)
462 
463 #define CE_MISC_INT_STATUS_GET(scn, CE_ctrl_addr) \
464 	A_TARGET_READ(scn, (CE_ctrl_addr) + MISC_IS_ADDRESS)
465 
466 #define CE_ENGINE_INT_STATUS_GET(scn, CE_ctrl_addr) \
467 	A_TARGET_READ(scn, (CE_ctrl_addr) + HOST_IS_ADDRESS)
468 
469 #define CE_ENGINE_INT_STATUS_CLEAR(scn, CE_ctrl_addr, mask) \
470 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + HOST_IS_ADDRESS, (mask))
471 
472 #define CE_WATERMARK_MASK (HOST_IS_SRC_RING_LOW_WATERMARK_MASK  | \
473 			   HOST_IS_SRC_RING_HIGH_WATERMARK_MASK | \
474 			   HOST_IS_DST_RING_LOW_WATERMARK_MASK  | \
475 			   HOST_IS_DST_RING_HIGH_WATERMARK_MASK)
476 
477 #define CE_ERROR_MASK     (MISC_IS_AXI_ERR_MASK           | \
478 			   MISC_IS_DST_ADDR_ERR_MASK      | \
479 			   MISC_IS_SRC_LEN_ERR_MASK       | \
480 			   MISC_IS_DST_MAX_LEN_VIO_MASK   | \
481 			   MISC_IS_DST_RING_OVERFLOW_MASK | \
482 			   MISC_IS_SRC_RING_OVERFLOW_MASK)
483 
484 #define CE_SRC_RING_TO_DESC(baddr, idx) \
485 	(&(((struct CE_src_desc *)baddr)[idx]))
486 #define CE_DEST_RING_TO_DESC(baddr, idx) \
487 	(&(((struct CE_dest_desc *)baddr)[idx]))
488 
489 /* Ring arithmetic (modulus number of entries in ring, which is a pwr of 2). */
490 #define CE_RING_DELTA(nentries_mask, fromidx, toidx) \
491 	(((int)(toidx)-(int)(fromidx)) & (nentries_mask))
492 
493 #define CE_RING_IDX_INCR(nentries_mask, idx) \
494 	(((idx) + 1) & (nentries_mask))
495 
496 #define CE_RING_IDX_ADD(nentries_mask, idx, num) \
497 	(((idx) + (num)) & (nentries_mask))
498 
499 #define CE_INTERRUPT_SUMMARY(scn) \
500 	CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_GET( \
501 		A_TARGET_READ(scn, CE_WRAPPER_BASE_ADDRESS + \
502 		CE_WRAPPER_INTERRUPT_SUMMARY_ADDRESS))
503 
504 #define READ_CE_DDR_ADDRESS_FOR_RRI_LOW(scn) \
505 	(A_TARGET_READ(scn, \
506 		       CE_WRAPPER_BASE_ADDRESS + CE_DDR_ADDRESS_FOR_RRI_LOW))
507 
508 #define READ_CE_DDR_ADDRESS_FOR_RRI_HIGH(scn) \
509 	(A_TARGET_READ(scn, \
510 		       CE_WRAPPER_BASE_ADDRESS + CE_DDR_ADDRESS_FOR_RRI_HIGH))
511 
512 #define WRITE_CE_DDR_ADDRESS_FOR_RRI_LOW(scn, val) \
513 	(A_TARGET_WRITE(scn, \
514 			CE_WRAPPER_BASE_ADDRESS + CE_DDR_ADDRESS_FOR_RRI_LOW, \
515 			val))
516 
517 #define WRITE_CE_DDR_ADDRESS_FOR_RRI_HIGH(scn, val) \
518 	(A_TARGET_WRITE(scn, \
519 			CE_WRAPPER_BASE_ADDRESS + CE_DDR_ADDRESS_FOR_RRI_HIGH, \
520 			val))
521 
522 /*Macro to increment CE packet errors*/
523 #define OL_ATH_CE_PKT_ERROR_COUNT_INCR(_scn, _ce_ecode) \
524 	do { if (_ce_ecode == CE_RING_DELTA_FAIL) \
525 			(_scn->pkt_stats.ce_ring_delta_fail_count) \
526 			+= 1; } while (0)
527 
528 /* Given a Copy Engine's ID, determine the interrupt number for that
529  * copy engine's interrupts.
530  */
531 #define CE_ID_TO_INUM(id) (A_INUM_CE0_COPY_COMP_BASE + (id))
532 #define CE_INUM_TO_ID(inum) ((inum) - A_INUM_CE0_COPY_COMP_BASE)
533 #define CE0_BASE_ADDRESS         (scn->target_ce_def->d_CE0_BASE_ADDRESS)
534 #define CE1_BASE_ADDRESS         (scn->target_ce_def->d_CE1_BASE_ADDRESS)
535 
536 
537 #ifdef ADRASTEA_SHADOW_REGISTERS
538 #define NUM_SHADOW_REGISTERS 24
539 u32 shadow_sr_wr_ind_addr(struct hif_softc *scn, u32 ctrl_addr);
540 u32 shadow_dst_wr_ind_addr(struct hif_softc *scn, u32 ctrl_addr);
541 #endif
542 
543 
544 #ifdef ADRASTEA_SHADOW_REGISTERS
545 #define CE_SRC_RING_WRITE_IDX_SET(scn, CE_ctrl_addr, n) \
546 	A_TARGET_WRITE(scn, shadow_sr_wr_ind_addr(scn, CE_ctrl_addr), n)
547 #define CE_DEST_RING_WRITE_IDX_SET(scn, CE_ctrl_addr, n) \
548 	A_TARGET_WRITE(scn, shadow_dst_wr_ind_addr(scn, CE_ctrl_addr), n)
549 
550 #else
551 
552 #define CE_SRC_RING_WRITE_IDX_SET(scn, CE_ctrl_addr, n) \
553 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + SR_WR_INDEX_ADDRESS, (n))
554 #define CE_DEST_RING_WRITE_IDX_SET(scn, CE_ctrl_addr, n) \
555 	A_TARGET_WRITE(scn, (CE_ctrl_addr) + DST_WR_INDEX_ADDRESS, (n))
556 #endif
557 
558 /* The write index read is only needed during initialization because
559  * we keep track of the index that was last written.  Thus the register
560  * is the only hardware supported location to read the initial value from.
561  */
562 #define CE_SRC_RING_WRITE_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr) \
563 	A_TARGET_READ(scn, (CE_ctrl_addr) + SR_WR_INDEX_ADDRESS)
564 #define CE_DEST_RING_WRITE_IDX_GET_FROM_REGISTER(scn, CE_ctrl_addr) \
565 	A_TARGET_READ(scn, (CE_ctrl_addr) + DST_WR_INDEX_ADDRESS)
566 
567 #endif /* __CE_REG_H__ */
568