1 /*
2  * Copyright 2018 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23 
24 /*
25  * GPU doorbell structures, functions & helpers
26  */
27 struct amdgpu_doorbell {
28 	/* doorbell mmio */
29 	resource_size_t		base;
30 	resource_size_t		size;
31 	u32 __iomem		*ptr;
32 	u32			num_doorbells;	/* Number of doorbells actually reserved for amdgpu. */
33 };
34 
35 /* Reserved doorbells for amdgpu (including multimedia).
36  * KFD can use all the rest in the 2M doorbell bar.
37  * For asic before vega10, doorbell is 32-bit, so the
38  * index/offset is in dword. For vega10 and after, doorbell
39  * can be 64-bit, so the index defined is in qword.
40  */
41 struct amdgpu_doorbell_index {
42 	uint32_t kiq;
43 	uint32_t mec_ring0;
44 	uint32_t mec_ring1;
45 	uint32_t mec_ring2;
46 	uint32_t mec_ring3;
47 	uint32_t mec_ring4;
48 	uint32_t mec_ring5;
49 	uint32_t mec_ring6;
50 	uint32_t mec_ring7;
51 	uint32_t userqueue_start;
52 	uint32_t userqueue_end;
53 	uint32_t gfx_ring0;
54 	uint32_t gfx_ring1;
55 	uint32_t sdma_engine[8];
56 	uint32_t ih;
57 	union {
58 		struct {
59 			uint32_t vcn_ring0_1;
60 			uint32_t vcn_ring2_3;
61 			uint32_t vcn_ring4_5;
62 			uint32_t vcn_ring6_7;
63 		} vcn;
64 		struct {
65 			uint32_t uvd_ring0_1;
66 			uint32_t uvd_ring2_3;
67 			uint32_t uvd_ring4_5;
68 			uint32_t uvd_ring6_7;
69 			uint32_t vce_ring0_1;
70 			uint32_t vce_ring2_3;
71 			uint32_t vce_ring4_5;
72 			uint32_t vce_ring6_7;
73 		} uvd_vce;
74 	};
75 	uint32_t first_non_cp;
76 	uint32_t last_non_cp;
77 	uint32_t max_assignment;
78 	/* Per engine SDMA doorbell size in dword */
79 	uint32_t sdma_doorbell_range;
80 };
81 
82 typedef enum _AMDGPU_DOORBELL_ASSIGNMENT
83 {
84 	AMDGPU_DOORBELL_KIQ                     = 0x000,
85 	AMDGPU_DOORBELL_HIQ                     = 0x001,
86 	AMDGPU_DOORBELL_DIQ                     = 0x002,
87 	AMDGPU_DOORBELL_MEC_RING0               = 0x010,
88 	AMDGPU_DOORBELL_MEC_RING1               = 0x011,
89 	AMDGPU_DOORBELL_MEC_RING2               = 0x012,
90 	AMDGPU_DOORBELL_MEC_RING3               = 0x013,
91 	AMDGPU_DOORBELL_MEC_RING4               = 0x014,
92 	AMDGPU_DOORBELL_MEC_RING5               = 0x015,
93 	AMDGPU_DOORBELL_MEC_RING6               = 0x016,
94 	AMDGPU_DOORBELL_MEC_RING7               = 0x017,
95 	AMDGPU_DOORBELL_GFX_RING0               = 0x020,
96 	AMDGPU_DOORBELL_sDMA_ENGINE0            = 0x1E0,
97 	AMDGPU_DOORBELL_sDMA_ENGINE1            = 0x1E1,
98 	AMDGPU_DOORBELL_IH                      = 0x1E8,
99 	AMDGPU_DOORBELL_MAX_ASSIGNMENT          = 0x3FF,
100 	AMDGPU_DOORBELL_INVALID                 = 0xFFFF
101 } AMDGPU_DOORBELL_ASSIGNMENT;
102 
103 typedef enum _AMDGPU_VEGA20_DOORBELL_ASSIGNMENT
104 {
105 	/* Compute + GFX: 0~255 */
106 	AMDGPU_VEGA20_DOORBELL_KIQ                     = 0x000,
107 	AMDGPU_VEGA20_DOORBELL_HIQ                     = 0x001,
108 	AMDGPU_VEGA20_DOORBELL_DIQ                     = 0x002,
109 	AMDGPU_VEGA20_DOORBELL_MEC_RING0               = 0x003,
110 	AMDGPU_VEGA20_DOORBELL_MEC_RING1               = 0x004,
111 	AMDGPU_VEGA20_DOORBELL_MEC_RING2               = 0x005,
112 	AMDGPU_VEGA20_DOORBELL_MEC_RING3               = 0x006,
113 	AMDGPU_VEGA20_DOORBELL_MEC_RING4               = 0x007,
114 	AMDGPU_VEGA20_DOORBELL_MEC_RING5               = 0x008,
115 	AMDGPU_VEGA20_DOORBELL_MEC_RING6               = 0x009,
116 	AMDGPU_VEGA20_DOORBELL_MEC_RING7               = 0x00A,
117 	AMDGPU_VEGA20_DOORBELL_USERQUEUE_START	       = 0x00B,
118 	AMDGPU_VEGA20_DOORBELL_USERQUEUE_END	       = 0x08A,
119 	AMDGPU_VEGA20_DOORBELL_GFX_RING0               = 0x08B,
120 	/* SDMA:256~335*/
121 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE0            = 0x100,
122 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE1            = 0x10A,
123 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE2            = 0x114,
124 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE3            = 0x11E,
125 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE4            = 0x128,
126 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE5            = 0x132,
127 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE6            = 0x13C,
128 	AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE7            = 0x146,
129 	/* IH: 376~391 */
130 	AMDGPU_VEGA20_DOORBELL_IH                      = 0x178,
131 	/* MMSCH: 392~407
132 	 * overlap the doorbell assignment with VCN as they are  mutually exclusive
133 	 * VCE engine's doorbell is 32 bit and two VCE ring share one QWORD
134 	 */
135 	AMDGPU_VEGA20_DOORBELL64_VCN0_1                  = 0x188, /* lower 32 bits for VNC0 and upper 32 bits for VNC1 */
136 	AMDGPU_VEGA20_DOORBELL64_VCN2_3                  = 0x189,
137 	AMDGPU_VEGA20_DOORBELL64_VCN4_5                  = 0x18A,
138 	AMDGPU_VEGA20_DOORBELL64_VCN6_7                  = 0x18B,
139 
140 	AMDGPU_VEGA20_DOORBELL64_UVD_RING0_1             = 0x188,
141 	AMDGPU_VEGA20_DOORBELL64_UVD_RING2_3             = 0x189,
142 	AMDGPU_VEGA20_DOORBELL64_UVD_RING4_5             = 0x18A,
143 	AMDGPU_VEGA20_DOORBELL64_UVD_RING6_7             = 0x18B,
144 
145 	AMDGPU_VEGA20_DOORBELL64_VCE_RING0_1             = 0x18C,
146 	AMDGPU_VEGA20_DOORBELL64_VCE_RING2_3             = 0x18D,
147 	AMDGPU_VEGA20_DOORBELL64_VCE_RING4_5             = 0x18E,
148 	AMDGPU_VEGA20_DOORBELL64_VCE_RING6_7             = 0x18F,
149 
150 	AMDGPU_VEGA20_DOORBELL64_FIRST_NON_CP            = AMDGPU_VEGA20_DOORBELL_sDMA_ENGINE0,
151 	AMDGPU_VEGA20_DOORBELL64_LAST_NON_CP             = AMDGPU_VEGA20_DOORBELL64_VCE_RING6_7,
152 
153 	AMDGPU_VEGA20_DOORBELL_MAX_ASSIGNMENT            = 0x18F,
154 	AMDGPU_VEGA20_DOORBELL_INVALID                   = 0xFFFF
155 } AMDGPU_VEGA20_DOORBELL_ASSIGNMENT;
156 
157 typedef enum _AMDGPU_NAVI10_DOORBELL_ASSIGNMENT
158 {
159 	/* Compute + GFX: 0~255 */
160 	AMDGPU_NAVI10_DOORBELL_KIQ			= 0x000,
161 	AMDGPU_NAVI10_DOORBELL_HIQ			= 0x001,
162 	AMDGPU_NAVI10_DOORBELL_DIQ			= 0x002,
163 	AMDGPU_NAVI10_DOORBELL_MEC_RING0		= 0x003,
164 	AMDGPU_NAVI10_DOORBELL_MEC_RING1		= 0x004,
165 	AMDGPU_NAVI10_DOORBELL_MEC_RING2		= 0x005,
166 	AMDGPU_NAVI10_DOORBELL_MEC_RING3		= 0x006,
167 	AMDGPU_NAVI10_DOORBELL_MEC_RING4		= 0x007,
168 	AMDGPU_NAVI10_DOORBELL_MEC_RING5		= 0x008,
169 	AMDGPU_NAVI10_DOORBELL_MEC_RING6		= 0x009,
170 	AMDGPU_NAVI10_DOORBELL_MEC_RING7		= 0x00A,
171 	AMDGPU_NAVI10_DOORBELL_USERQUEUE_START		= 0x00B,
172 	AMDGPU_NAVI10_DOORBELL_USERQUEUE_END		= 0x08A,
173 	AMDGPU_NAVI10_DOORBELL_GFX_RING0		= 0x08B,
174 	AMDGPU_NAVI10_DOORBELL_GFX_RING1		= 0x08C,
175 	/* SDMA:256~335*/
176 	AMDGPU_NAVI10_DOORBELL_sDMA_ENGINE0		= 0x100,
177 	AMDGPU_NAVI10_DOORBELL_sDMA_ENGINE1		= 0x10A,
178 	/* IH: 376~391 */
179 	AMDGPU_NAVI10_DOORBELL_IH			= 0x178,
180 	/* MMSCH: 392~407
181 	 * overlap the doorbell assignment with VCN as they are  mutually exclusive
182 	 * VCE engine's doorbell is 32 bit and two VCE ring share one QWORD
183 	 */
184 	AMDGPU_NAVI10_DOORBELL64_VCN0_1			= 0x188, /* lower 32 bits for VNC0 and upper 32 bits for VNC1 */
185 	AMDGPU_NAVI10_DOORBELL64_VCN2_3			= 0x189,
186 	AMDGPU_NAVI10_DOORBELL64_VCN4_5			= 0x18A,
187 	AMDGPU_NAVI10_DOORBELL64_VCN6_7			= 0x18B,
188 
189 	AMDGPU_NAVI10_DOORBELL64_FIRST_NON_CP		= AMDGPU_NAVI10_DOORBELL_sDMA_ENGINE0,
190 	AMDGPU_NAVI10_DOORBELL64_LAST_NON_CP		= AMDGPU_NAVI10_DOORBELL64_VCN6_7,
191 
192 	AMDGPU_NAVI10_DOORBELL_MAX_ASSIGNMENT		= 0x18F,
193 	AMDGPU_NAVI10_DOORBELL_INVALID			= 0xFFFF
194 } AMDGPU_NAVI10_DOORBELL_ASSIGNMENT;
195 
196 /*
197  * 64bit doorbell, offset are in QWORD, occupy 2KB doorbell space
198  */
199 typedef enum _AMDGPU_DOORBELL64_ASSIGNMENT
200 {
201 	/*
202 	 * All compute related doorbells: kiq, hiq, diq, traditional compute queue, user queue, should locate in
203 	 * a continues range so that programming CP_MEC_DOORBELL_RANGE_LOWER/UPPER can cover this range.
204 	 *  Compute related doorbells are allocated from 0x00 to 0x8a
205 	 */
206 
207 
208 	/* kernel scheduling */
209 	AMDGPU_DOORBELL64_KIQ                     = 0x00,
210 
211 	/* HSA interface queue and debug queue */
212 	AMDGPU_DOORBELL64_HIQ                     = 0x01,
213 	AMDGPU_DOORBELL64_DIQ                     = 0x02,
214 
215 	/* Compute engines */
216 	AMDGPU_DOORBELL64_MEC_RING0               = 0x03,
217 	AMDGPU_DOORBELL64_MEC_RING1               = 0x04,
218 	AMDGPU_DOORBELL64_MEC_RING2               = 0x05,
219 	AMDGPU_DOORBELL64_MEC_RING3               = 0x06,
220 	AMDGPU_DOORBELL64_MEC_RING4               = 0x07,
221 	AMDGPU_DOORBELL64_MEC_RING5               = 0x08,
222 	AMDGPU_DOORBELL64_MEC_RING6               = 0x09,
223 	AMDGPU_DOORBELL64_MEC_RING7               = 0x0a,
224 
225 	/* User queue doorbell range (128 doorbells) */
226 	AMDGPU_DOORBELL64_USERQUEUE_START         = 0x0b,
227 	AMDGPU_DOORBELL64_USERQUEUE_END           = 0x8a,
228 
229 	/* Graphics engine */
230 	AMDGPU_DOORBELL64_GFX_RING0               = 0x8b,
231 
232 	/*
233 	 * Other graphics doorbells can be allocated here: from 0x8c to 0xdf
234 	 * Graphics voltage island aperture 1
235 	 * default non-graphics QWORD index is 0xe0 - 0xFF inclusive
236 	 */
237 
238 	/* For vega10 sriov, the sdma doorbell must be fixed as follow
239 	 * to keep the same setting with host driver, or it will
240 	 * happen conflicts
241 	 */
242 	AMDGPU_DOORBELL64_sDMA_ENGINE0            = 0xF0,
243 	AMDGPU_DOORBELL64_sDMA_HI_PRI_ENGINE0     = 0xF1,
244 	AMDGPU_DOORBELL64_sDMA_ENGINE1            = 0xF2,
245 	AMDGPU_DOORBELL64_sDMA_HI_PRI_ENGINE1     = 0xF3,
246 
247 	/* Interrupt handler */
248 	AMDGPU_DOORBELL64_IH                      = 0xF4,  /* For legacy interrupt ring buffer */
249 	AMDGPU_DOORBELL64_IH_RING1                = 0xF5,  /* For page migration request log */
250 	AMDGPU_DOORBELL64_IH_RING2                = 0xF6,  /* For page migration translation/invalidation log */
251 
252 	/* VCN engine use 32 bits doorbell  */
253 	AMDGPU_DOORBELL64_VCN0_1                  = 0xF8, /* lower 32 bits for VNC0 and upper 32 bits for VNC1 */
254 	AMDGPU_DOORBELL64_VCN2_3                  = 0xF9,
255 	AMDGPU_DOORBELL64_VCN4_5                  = 0xFA,
256 	AMDGPU_DOORBELL64_VCN6_7                  = 0xFB,
257 
258 	/* overlap the doorbell assignment with VCN as they are  mutually exclusive
259 	 * VCE engine's doorbell is 32 bit and two VCE ring share one QWORD
260 	 */
261 	AMDGPU_DOORBELL64_UVD_RING0_1             = 0xF8,
262 	AMDGPU_DOORBELL64_UVD_RING2_3             = 0xF9,
263 	AMDGPU_DOORBELL64_UVD_RING4_5             = 0xFA,
264 	AMDGPU_DOORBELL64_UVD_RING6_7             = 0xFB,
265 
266 	AMDGPU_DOORBELL64_VCE_RING0_1             = 0xFC,
267 	AMDGPU_DOORBELL64_VCE_RING2_3             = 0xFD,
268 	AMDGPU_DOORBELL64_VCE_RING4_5             = 0xFE,
269 	AMDGPU_DOORBELL64_VCE_RING6_7             = 0xFF,
270 
271 	AMDGPU_DOORBELL64_FIRST_NON_CP            = AMDGPU_DOORBELL64_sDMA_ENGINE0,
272 	AMDGPU_DOORBELL64_LAST_NON_CP             = AMDGPU_DOORBELL64_VCE_RING6_7,
273 
274 	AMDGPU_DOORBELL64_MAX_ASSIGNMENT          = 0xFF,
275 	AMDGPU_DOORBELL64_INVALID                 = 0xFFFF
276 } AMDGPU_DOORBELL64_ASSIGNMENT;
277 
278 u32 amdgpu_mm_rdoorbell(struct amdgpu_device *adev, u32 index);
279 void amdgpu_mm_wdoorbell(struct amdgpu_device *adev, u32 index, u32 v);
280 u64 amdgpu_mm_rdoorbell64(struct amdgpu_device *adev, u32 index);
281 void amdgpu_mm_wdoorbell64(struct amdgpu_device *adev, u32 index, u64 v);
282 
283 #define RDOORBELL32(index) amdgpu_mm_rdoorbell(adev, (index))
284 #define WDOORBELL32(index, v) amdgpu_mm_wdoorbell(adev, (index), (v))
285 #define RDOORBELL64(index) amdgpu_mm_rdoorbell64(adev, (index))
286 #define WDOORBELL64(index, v) amdgpu_mm_wdoorbell64(adev, (index), (v))
287 
288