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_DEVICE_QUEUE_MANAGER_H_
25 #define KFD_DEVICE_QUEUE_MANAGER_H_
26 
27 #include <linux/rwsem.h>
28 #include <linux/list.h>
29 #include "kfd_priv.h"
30 #include "kfd_mqd_manager.h"
31 
32 #define KFD_UNMAP_LATENCY_MS			(4000)
33 #define QUEUE_PREEMPT_DEFAULT_TIMEOUT_MS (2 * KFD_UNMAP_LATENCY_MS + 1000)
34 
35 #define CIK_SDMA_QUEUES				(4)
36 #define CIK_SDMA_QUEUES_PER_ENGINE		(2)
37 #define CIK_SDMA_ENGINE_NUM			(2)
38 
39 struct device_process_node {
40 	struct qcm_process_device *qpd;
41 	struct list_head list;
42 };
43 
44 /**
45  * struct device_queue_manager_ops
46  *
47  * @create_queue: Queue creation routine.
48  *
49  * @destroy_queue: Queue destruction routine.
50  *
51  * @update_queue: Queue update routine.
52  *
53  * @get_mqd_manager: Returns the mqd manager according to the mqd type.
54  *
55  * @exeute_queues: Dispatches the queues list to the H/W.
56  *
57  * @register_process: This routine associates a specific process with device.
58  *
59  * @unregister_process: destroys the associations between process to device.
60  *
61  * @initialize: Initializes the pipelines and memory module for that device.
62  *
63  * @start: Initializes the resources/modules the the device needs for queues
64  * execution. This function is called on device initialization and after the
65  * system woke up after suspension.
66  *
67  * @stop: This routine stops execution of all the active queue running on the
68  * H/W and basically this function called on system suspend.
69  *
70  * @uninitialize: Destroys all the device queue manager resources allocated in
71  * initialize routine.
72  *
73  * @create_kernel_queue: Creates kernel queue. Used for debug queue.
74  *
75  * @destroy_kernel_queue: Destroys kernel queue. Used for debug queue.
76  *
77  * @set_cache_memory_policy: Sets memory policy (cached/ non cached) for the
78  * memory apertures.
79  *
80  * @process_termination: Clears all process queues belongs to that device.
81  *
82  */
83 
84 struct device_queue_manager_ops {
85 	int	(*create_queue)(struct device_queue_manager *dqm,
86 				struct queue *q,
87 				struct qcm_process_device *qpd,
88 				int *allocate_vmid);
89 
90 	int	(*destroy_queue)(struct device_queue_manager *dqm,
91 				struct qcm_process_device *qpd,
92 				struct queue *q);
93 
94 	int	(*update_queue)(struct device_queue_manager *dqm,
95 				struct queue *q);
96 
97 	struct mqd_manager * (*get_mqd_manager)
98 					(struct device_queue_manager *dqm,
99 					enum KFD_MQD_TYPE type);
100 
101 	int	(*register_process)(struct device_queue_manager *dqm,
102 					struct qcm_process_device *qpd);
103 
104 	int	(*unregister_process)(struct device_queue_manager *dqm,
105 					struct qcm_process_device *qpd);
106 
107 	int	(*initialize)(struct device_queue_manager *dqm);
108 	int	(*start)(struct device_queue_manager *dqm);
109 	int	(*stop)(struct device_queue_manager *dqm);
110 	void	(*uninitialize)(struct device_queue_manager *dqm);
111 	int	(*create_kernel_queue)(struct device_queue_manager *dqm,
112 					struct kernel_queue *kq,
113 					struct qcm_process_device *qpd);
114 
115 	void	(*destroy_kernel_queue)(struct device_queue_manager *dqm,
116 					struct kernel_queue *kq,
117 					struct qcm_process_device *qpd);
118 
119 	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
120 					   struct qcm_process_device *qpd,
121 					   enum cache_policy default_policy,
122 					   enum cache_policy alternate_policy,
123 					   void __user *alternate_aperture_base,
124 					   uint64_t alternate_aperture_size);
125 
126 	int (*process_termination)(struct device_queue_manager *dqm,
127 			struct qcm_process_device *qpd);
128 };
129 
130 struct device_queue_manager_asic_ops {
131 	int	(*update_qpd)(struct device_queue_manager *dqm,
132 					struct qcm_process_device *qpd);
133 	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
134 					   struct qcm_process_device *qpd,
135 					   enum cache_policy default_policy,
136 					   enum cache_policy alternate_policy,
137 					   void __user *alternate_aperture_base,
138 					   uint64_t alternate_aperture_size);
139 	void	(*init_sdma_vm)(struct device_queue_manager *dqm,
140 				struct queue *q,
141 				struct qcm_process_device *qpd);
142 };
143 
144 /**
145  * struct device_queue_manager
146  *
147  * This struct is a base class for the kfd queues scheduler in the
148  * device level. The device base class should expose the basic operations
149  * for queue creation and queue destruction. This base class hides the
150  * scheduling mode of the driver and the specific implementation of the
151  * concrete device. This class is the only class in the queues scheduler
152  * that configures the H/W.
153  *
154  */
155 
156 struct device_queue_manager {
157 	struct device_queue_manager_ops ops;
158 	struct device_queue_manager_asic_ops asic_ops;
159 
160 	struct mqd_manager	*mqds[KFD_MQD_TYPE_MAX];
161 	struct packet_manager	packets;
162 	struct kfd_dev		*dev;
163 	struct mutex		lock;
164 	struct list_head	queues;
165 	unsigned int		processes_count;
166 	unsigned int		queue_count;
167 	unsigned int		sdma_queue_count;
168 	unsigned int		total_queue_count;
169 	unsigned int		next_pipe_to_allocate;
170 	unsigned int		*allocated_queues;
171 	unsigned int		sdma_bitmap;
172 	unsigned int		vmid_bitmap;
173 	uint64_t		pipelines_addr;
174 	struct kfd_mem_obj	*pipeline_mem;
175 	uint64_t		fence_gpu_addr;
176 	unsigned int		*fence_addr;
177 	struct kfd_mem_obj	*fence_mem;
178 	bool			active_runlist;
179 };
180 
181 void device_queue_manager_init_cik(
182 		struct device_queue_manager_asic_ops *asic_ops);
183 void device_queue_manager_init_vi(
184 		struct device_queue_manager_asic_ops *asic_ops);
185 void program_sh_mem_settings(struct device_queue_manager *dqm,
186 					struct qcm_process_device *qpd);
187 unsigned int get_queues_num(struct device_queue_manager *dqm);
188 unsigned int get_queues_per_pipe(struct device_queue_manager *dqm);
189 unsigned int get_pipes_per_mec(struct device_queue_manager *dqm);
190 
191 static inline unsigned int get_sh_mem_bases_32(struct kfd_process_device *pdd)
192 {
193 	return (pdd->lds_base >> 16) & 0xFF;
194 }
195 
196 static inline unsigned int
197 get_sh_mem_bases_nybble_64(struct kfd_process_device *pdd)
198 {
199 	return (pdd->lds_base >> 60) & 0x0E;
200 }
201 
202 #endif /* KFD_DEVICE_QUEUE_MANAGER_H_ */
203