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