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#ifndef KFD_KERNEL_QUEUE_H_
25#define KFD_KERNEL_QUEUE_H_
26
27#include <linux/list.h>
28#include <linux/types.h>
29#include "kfd_priv.h"
30
31/**
32 * kq_acquire_packet_buffer: Returns a pointer to the location in the kernel
33 * queue ring buffer where the calling function can write its packet. It is
34 * Guaranteed that there is enough space for that packet. It also updates the
35 * pending write pointer to that location so subsequent calls to
36 * acquire_packet_buffer will get a correct write pointer
37 *
38 * kq_submit_packet: Update the write pointer and doorbell of a kernel queue.
39 *
40 * kq_rollback_packet: This routine is called if we failed to build an acquired
41 * packet for some reason. It just overwrites the pending wptr with the current
42 * one
43 *
44 */
45
46int kq_acquire_packet_buffer(struct kernel_queue *kq,
47				size_t packet_size_in_dwords,
48				unsigned int **buffer_ptr);
49void kq_submit_packet(struct kernel_queue *kq);
50void kq_rollback_packet(struct kernel_queue *kq);
51
52
53struct kernel_queue {
54	/* data */
55	struct kfd_dev		*dev;
56	struct mqd_manager	*mqd_mgr;
57	struct queue		*queue;
58	uint64_t		pending_wptr64;
59	uint32_t		pending_wptr;
60	unsigned int		nop_packet;
61
62	struct kfd_mem_obj	*rptr_mem;
63	uint32_t		*rptr_kernel;
64	uint64_t		rptr_gpu_addr;
65	struct kfd_mem_obj	*wptr_mem;
66	union {
67		uint64_t	*wptr64_kernel;
68		uint32_t	*wptr_kernel;
69	};
70	uint64_t		wptr_gpu_addr;
71	struct kfd_mem_obj	*pq;
72	uint64_t		pq_gpu_addr;
73	uint32_t		*pq_kernel_addr;
74	struct kfd_mem_obj	*eop_mem;
75	uint64_t		eop_gpu_addr;
76	uint32_t		*eop_kernel_addr;
77
78	struct kfd_mem_obj	*fence_mem_obj;
79	uint64_t		fence_gpu_addr;
80	void			*fence_kernel_address;
81
82	struct list_head	list;
83};
84
85#endif /* KFD_KERNEL_QUEUE_H_ */