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  * struct kernel_queue_ops
33  *
34  * @initialize: Initialize a kernel queue, including allocations of GART memory
35  * needed for the queue.
36  *
37  * @uninitialize: Uninitialize a kernel queue and free all its memory usages.
38  *
39  * @acquire_packet_buffer: Returns a pointer to the location in the kernel
40  * queue ring buffer where the calling function can write its packet. It is
41  * Guaranteed that there is enough space for that packet. It also updates the
42  * pending write pointer to that location so subsequent calls to
43  * acquire_packet_buffer will get a correct write pointer
44  *
45  * @submit_packet: Update the write pointer and doorbell of a kernel queue.
46  *
47  * @sync_with_hw: Wait until the write pointer and the read pointer of a kernel
48  * queue are equal, which means the CP has read all the submitted packets.
49  *
50  * @rollback_packet: This routine is called if we failed to build an acquired
51  * packet for some reason. It just overwrites the pending wptr with the current
52  * one
53  *
54  */
55 struct kernel_queue_ops {
56 	bool	(*initialize)(struct kernel_queue *kq, struct kfd_dev *dev,
57 			enum kfd_queue_type type, unsigned int queue_size);
58 	void	(*uninitialize)(struct kernel_queue *kq);
59 	int	(*acquire_packet_buffer)(struct kernel_queue *kq,
60 					size_t packet_size_in_dwords,
61 					unsigned int **buffer_ptr);
62 
63 	void	(*submit_packet)(struct kernel_queue *kq);
64 	void	(*rollback_packet)(struct kernel_queue *kq);
65 };
66 
67 struct kernel_queue {
68 	struct kernel_queue_ops ops;
69 	struct kernel_queue_ops ops_asic_specific;
70 
71 	/* data */
72 	struct kfd_dev		*dev;
73 	struct mqd_manager	*mqd;
74 	struct queue		*queue;
75 	uint32_t		pending_wptr;
76 	unsigned int		nop_packet;
77 
78 	struct kfd_mem_obj	*rptr_mem;
79 	uint32_t		*rptr_kernel;
80 	uint64_t		rptr_gpu_addr;
81 	struct kfd_mem_obj	*wptr_mem;
82 	uint32_t		*wptr_kernel;
83 	uint64_t		wptr_gpu_addr;
84 	struct kfd_mem_obj	*pq;
85 	uint64_t		pq_gpu_addr;
86 	uint32_t		*pq_kernel_addr;
87 	struct kfd_mem_obj	*eop_mem;
88 	uint64_t		eop_gpu_addr;
89 	uint32_t		*eop_kernel_addr;
90 
91 	struct kfd_mem_obj	*fence_mem_obj;
92 	uint64_t		fence_gpu_addr;
93 	void			*fence_kernel_address;
94 
95 	struct list_head	list;
96 };
97 
98 void kernel_queue_init_cik(struct kernel_queue_ops *ops);
99 void kernel_queue_init_vi(struct kernel_queue_ops *ops);
100 
101 #endif /* KFD_KERNEL_QUEUE_H_ */
102