1 /*
2  * Copyright 2014 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 #include <linux/types.h>
25 #include <linux/mutex.h>
26 #include <linux/slab.h>
27 #include <linux/printk.h>
28 #include <linux/sched.h>
29 #include "kfd_kernel_queue.h"
30 #include "kfd_priv.h"
31 #include "kfd_device_queue_manager.h"
32 #include "kfd_pm4_headers.h"
33 #include "kfd_pm4_opcodes.h"
34 
35 #define PM4_COUNT_ZERO (((1 << 15) - 1) << 16)
36 
37 static bool initialize(struct kernel_queue *kq, struct kfd_dev *dev,
38 		enum kfd_queue_type type, unsigned int queue_size)
39 {
40 	struct queue_properties prop;
41 	int retval;
42 	union PM4_MES_TYPE_3_HEADER nop;
43 
44 	if (WARN_ON(type != KFD_QUEUE_TYPE_DIQ && type != KFD_QUEUE_TYPE_HIQ))
45 		return false;
46 
47 	pr_debug("Initializing queue type %d size %d\n", KFD_QUEUE_TYPE_HIQ,
48 			queue_size);
49 
50 	memset(&prop, 0, sizeof(prop));
51 	memset(&nop, 0, sizeof(nop));
52 
53 	nop.opcode = IT_NOP;
54 	nop.type = PM4_TYPE_3;
55 	nop.u32all |= PM4_COUNT_ZERO;
56 
57 	kq->dev = dev;
58 	kq->nop_packet = nop.u32all;
59 	switch (type) {
60 	case KFD_QUEUE_TYPE_DIQ:
61 		kq->mqd_mgr = dev->dqm->mqd_mgrs[KFD_MQD_TYPE_DIQ];
62 		break;
63 	case KFD_QUEUE_TYPE_HIQ:
64 		kq->mqd_mgr = dev->dqm->mqd_mgrs[KFD_MQD_TYPE_HIQ];
65 		break;
66 	default:
67 		pr_err("Invalid queue type %d\n", type);
68 		return false;
69 	}
70 
71 	if (!kq->mqd_mgr)
72 		return false;
73 
74 	prop.doorbell_ptr = kfd_get_kernel_doorbell(dev, &prop.doorbell_off);
75 
76 	if (!prop.doorbell_ptr) {
77 		pr_err("Failed to initialize doorbell");
78 		goto err_get_kernel_doorbell;
79 	}
80 
81 	retval = kfd_gtt_sa_allocate(dev, queue_size, &kq->pq);
82 	if (retval != 0) {
83 		pr_err("Failed to init pq queues size %d\n", queue_size);
84 		goto err_pq_allocate_vidmem;
85 	}
86 
87 	kq->pq_kernel_addr = kq->pq->cpu_ptr;
88 	kq->pq_gpu_addr = kq->pq->gpu_addr;
89 
90 	/* For CIK family asics, kq->eop_mem is not needed */
91 	if (dev->device_info->asic_family > CHIP_HAWAII) {
92 		retval = kfd_gtt_sa_allocate(dev, PAGE_SIZE, &kq->eop_mem);
93 		if (retval != 0)
94 			goto err_eop_allocate_vidmem;
95 
96 		kq->eop_gpu_addr = kq->eop_mem->gpu_addr;
97 		kq->eop_kernel_addr = kq->eop_mem->cpu_ptr;
98 
99 		memset(kq->eop_kernel_addr, 0, PAGE_SIZE);
100 	}
101 
102 	retval = kfd_gtt_sa_allocate(dev, sizeof(*kq->rptr_kernel),
103 					&kq->rptr_mem);
104 
105 	if (retval != 0)
106 		goto err_rptr_allocate_vidmem;
107 
108 	kq->rptr_kernel = kq->rptr_mem->cpu_ptr;
109 	kq->rptr_gpu_addr = kq->rptr_mem->gpu_addr;
110 
111 	retval = kfd_gtt_sa_allocate(dev, dev->device_info->doorbell_size,
112 					&kq->wptr_mem);
113 
114 	if (retval != 0)
115 		goto err_wptr_allocate_vidmem;
116 
117 	kq->wptr_kernel = kq->wptr_mem->cpu_ptr;
118 	kq->wptr_gpu_addr = kq->wptr_mem->gpu_addr;
119 
120 	memset(kq->pq_kernel_addr, 0, queue_size);
121 	memset(kq->rptr_kernel, 0, sizeof(*kq->rptr_kernel));
122 	memset(kq->wptr_kernel, 0, sizeof(*kq->wptr_kernel));
123 
124 	prop.queue_size = queue_size;
125 	prop.is_interop = false;
126 	prop.priority = 1;
127 	prop.queue_percent = 100;
128 	prop.type = type;
129 	prop.vmid = 0;
130 	prop.queue_address = kq->pq_gpu_addr;
131 	prop.read_ptr = (uint32_t *) kq->rptr_gpu_addr;
132 	prop.write_ptr = (uint32_t *) kq->wptr_gpu_addr;
133 	prop.eop_ring_buffer_address = kq->eop_gpu_addr;
134 	prop.eop_ring_buffer_size = PAGE_SIZE;
135 	prop.cu_mask = NULL;
136 
137 	if (init_queue(&kq->queue, &prop) != 0)
138 		goto err_init_queue;
139 
140 	kq->queue->device = dev;
141 	kq->queue->process = kfd_get_process(current);
142 
143 	kq->queue->mqd_mem_obj = kq->mqd_mgr->allocate_mqd(kq->mqd_mgr->dev,
144 					&kq->queue->properties);
145 	if (!kq->queue->mqd_mem_obj)
146 		goto err_allocate_mqd;
147 	kq->mqd_mgr->init_mqd(kq->mqd_mgr, &kq->queue->mqd,
148 					kq->queue->mqd_mem_obj,
149 					&kq->queue->gart_mqd_addr,
150 					&kq->queue->properties);
151 	/* assign HIQ to HQD */
152 	if (type == KFD_QUEUE_TYPE_HIQ) {
153 		pr_debug("Assigning hiq to hqd\n");
154 		kq->queue->pipe = KFD_CIK_HIQ_PIPE;
155 		kq->queue->queue = KFD_CIK_HIQ_QUEUE;
156 		kq->mqd_mgr->load_mqd(kq->mqd_mgr, kq->queue->mqd,
157 				kq->queue->pipe, kq->queue->queue,
158 				&kq->queue->properties, NULL);
159 	} else {
160 		/* allocate fence for DIQ */
161 
162 		retval = kfd_gtt_sa_allocate(dev, sizeof(uint32_t),
163 						&kq->fence_mem_obj);
164 
165 		if (retval != 0)
166 			goto err_alloc_fence;
167 
168 		kq->fence_kernel_address = kq->fence_mem_obj->cpu_ptr;
169 		kq->fence_gpu_addr = kq->fence_mem_obj->gpu_addr;
170 	}
171 
172 	print_queue(kq->queue);
173 
174 	return true;
175 err_alloc_fence:
176 	kq->mqd_mgr->free_mqd(kq->mqd_mgr, kq->queue->mqd, kq->queue->mqd_mem_obj);
177 err_allocate_mqd:
178 	uninit_queue(kq->queue);
179 err_init_queue:
180 	kfd_gtt_sa_free(dev, kq->wptr_mem);
181 err_wptr_allocate_vidmem:
182 	kfd_gtt_sa_free(dev, kq->rptr_mem);
183 err_rptr_allocate_vidmem:
184 	kfd_gtt_sa_free(dev, kq->eop_mem);
185 err_eop_allocate_vidmem:
186 	kfd_gtt_sa_free(dev, kq->pq);
187 err_pq_allocate_vidmem:
188 	kfd_release_kernel_doorbell(dev, prop.doorbell_ptr);
189 err_get_kernel_doorbell:
190 	return false;
191 
192 }
193 
194 static void uninitialize(struct kernel_queue *kq)
195 {
196 	if (kq->queue->properties.type == KFD_QUEUE_TYPE_HIQ)
197 		kq->mqd_mgr->destroy_mqd(kq->mqd_mgr,
198 					kq->queue->mqd,
199 					KFD_PREEMPT_TYPE_WAVEFRONT_RESET,
200 					KFD_UNMAP_LATENCY_MS,
201 					kq->queue->pipe,
202 					kq->queue->queue);
203 	else if (kq->queue->properties.type == KFD_QUEUE_TYPE_DIQ)
204 		kfd_gtt_sa_free(kq->dev, kq->fence_mem_obj);
205 
206 	kq->mqd_mgr->free_mqd(kq->mqd_mgr, kq->queue->mqd,
207 				kq->queue->mqd_mem_obj);
208 
209 	kfd_gtt_sa_free(kq->dev, kq->rptr_mem);
210 	kfd_gtt_sa_free(kq->dev, kq->wptr_mem);
211 
212 	/* For CIK family asics, kq->eop_mem is Null, kfd_gtt_sa_free()
213 	 * is able to handle NULL properly.
214 	 */
215 	kfd_gtt_sa_free(kq->dev, kq->eop_mem);
216 
217 	kfd_gtt_sa_free(kq->dev, kq->pq);
218 	kfd_release_kernel_doorbell(kq->dev,
219 					kq->queue->properties.doorbell_ptr);
220 	uninit_queue(kq->queue);
221 }
222 
223 static int acquire_packet_buffer(struct kernel_queue *kq,
224 		size_t packet_size_in_dwords, unsigned int **buffer_ptr)
225 {
226 	size_t available_size;
227 	size_t queue_size_dwords;
228 	uint32_t wptr, rptr;
229 	uint64_t wptr64;
230 	unsigned int *queue_address;
231 
232 	/* When rptr == wptr, the buffer is empty.
233 	 * When rptr == wptr + 1, the buffer is full.
234 	 * It is always rptr that advances to the position of wptr, rather than
235 	 * the opposite. So we can only use up to queue_size_dwords - 1 dwords.
236 	 */
237 	rptr = *kq->rptr_kernel;
238 	wptr = kq->pending_wptr;
239 	wptr64 = kq->pending_wptr64;
240 	queue_address = (unsigned int *)kq->pq_kernel_addr;
241 	queue_size_dwords = kq->queue->properties.queue_size / 4;
242 
243 	pr_debug("rptr: %d\n", rptr);
244 	pr_debug("wptr: %d\n", wptr);
245 	pr_debug("queue_address 0x%p\n", queue_address);
246 
247 	available_size = (rptr + queue_size_dwords - 1 - wptr) %
248 							queue_size_dwords;
249 
250 	if (packet_size_in_dwords > available_size) {
251 		/*
252 		 * make sure calling functions know
253 		 * acquire_packet_buffer() failed
254 		 */
255 		goto err_no_space;
256 	}
257 
258 	if (wptr + packet_size_in_dwords >= queue_size_dwords) {
259 		/* make sure after rolling back to position 0, there is
260 		 * still enough space.
261 		 */
262 		if (packet_size_in_dwords >= rptr)
263 			goto err_no_space;
264 
265 		/* fill nops, roll back and start at position 0 */
266 		while (wptr > 0) {
267 			queue_address[wptr] = kq->nop_packet;
268 			wptr = (wptr + 1) % queue_size_dwords;
269 			wptr64++;
270 		}
271 	}
272 
273 	*buffer_ptr = &queue_address[wptr];
274 	kq->pending_wptr = wptr + packet_size_in_dwords;
275 	kq->pending_wptr64 = wptr64 + packet_size_in_dwords;
276 
277 	return 0;
278 
279 err_no_space:
280 	*buffer_ptr = NULL;
281 	return -ENOMEM;
282 }
283 
284 static void submit_packet(struct kernel_queue *kq)
285 {
286 #ifdef DEBUG
287 	int i;
288 
289 	for (i = *kq->wptr_kernel; i < kq->pending_wptr; i++) {
290 		pr_debug("0x%2X ", kq->pq_kernel_addr[i]);
291 		if (i % 15 == 0)
292 			pr_debug("\n");
293 	}
294 	pr_debug("\n");
295 #endif
296 	if (kq->dev->device_info->doorbell_size == 8) {
297 		*kq->wptr64_kernel = kq->pending_wptr64;
298 		write_kernel_doorbell64(kq->queue->properties.doorbell_ptr,
299 					kq->pending_wptr64);
300 	} else {
301 		*kq->wptr_kernel = kq->pending_wptr;
302 		write_kernel_doorbell(kq->queue->properties.doorbell_ptr,
303 					kq->pending_wptr);
304 	}
305 }
306 
307 static void rollback_packet(struct kernel_queue *kq)
308 {
309 	if (kq->dev->device_info->doorbell_size == 8) {
310 		kq->pending_wptr64 = *kq->wptr64_kernel;
311 		kq->pending_wptr = *kq->wptr_kernel %
312 			(kq->queue->properties.queue_size / 4);
313 	} else {
314 		kq->pending_wptr = *kq->wptr_kernel;
315 	}
316 }
317 
318 struct kernel_queue *kernel_queue_init(struct kfd_dev *dev,
319 					enum kfd_queue_type type)
320 {
321 	struct kernel_queue *kq;
322 
323 	kq = kzalloc(sizeof(*kq), GFP_KERNEL);
324 	if (!kq)
325 		return NULL;
326 
327 	kq->ops.initialize = initialize;
328 	kq->ops.uninitialize = uninitialize;
329 	kq->ops.acquire_packet_buffer = acquire_packet_buffer;
330 	kq->ops.submit_packet = submit_packet;
331 	kq->ops.rollback_packet = rollback_packet;
332 
333 	if (kq->ops.initialize(kq, dev, type, KFD_KERNEL_QUEUE_SIZE))
334 		return kq;
335 
336 	pr_err("Failed to init kernel queue\n");
337 
338 	kfree(kq);
339 	return NULL;
340 }
341 
342 void kernel_queue_uninit(struct kernel_queue *kq)
343 {
344 	kq->ops.uninitialize(kq);
345 	kfree(kq);
346 }
347 
348 /* FIXME: Can this test be removed? */
349 static __attribute__((unused)) void test_kq(struct kfd_dev *dev)
350 {
351 	struct kernel_queue *kq;
352 	uint32_t *buffer, i;
353 	int retval;
354 
355 	pr_err("Starting kernel queue test\n");
356 
357 	kq = kernel_queue_init(dev, KFD_QUEUE_TYPE_HIQ);
358 	if (unlikely(!kq)) {
359 		pr_err("  Failed to initialize HIQ\n");
360 		pr_err("Kernel queue test failed\n");
361 		return;
362 	}
363 
364 	retval = kq->ops.acquire_packet_buffer(kq, 5, &buffer);
365 	if (unlikely(retval != 0)) {
366 		pr_err("  Failed to acquire packet buffer\n");
367 		pr_err("Kernel queue test failed\n");
368 		return;
369 	}
370 	for (i = 0; i < 5; i++)
371 		buffer[i] = kq->nop_packet;
372 	kq->ops.submit_packet(kq);
373 
374 	pr_err("Ending kernel queue test\n");
375 }
376 
377 
378