2 * Copyright 2014 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
24 #ifndef KFD_DEVICE_QUEUE_MANAGER_H_
25 #define KFD_DEVICE_QUEUE_MANAGER_H_
27 #include <linux/rwsem.h>
28 #include <linux/list.h>
29 #include <linux/mutex.h>
30 #include <linux/sched/mm.h>
32 #include "kfd_mqd_manager.h"
37 struct device_process_node
{
38 struct qcm_process_device
*qpd
;
39 struct list_head list
;
43 * struct device_queue_manager_ops
45 * @create_queue: Queue creation routine.
47 * @destroy_queue: Queue destruction routine.
49 * @update_queue: Queue update routine.
51 * @exeute_queues: Dispatches the queues list to the H/W.
53 * @register_process: This routine associates a specific process with device.
55 * @unregister_process: destroys the associations between process to device.
57 * @initialize: Initializes the pipelines and memory module for that device.
59 * @start: Initializes the resources/modules the the device needs for queues
60 * execution. This function is called on device initialization and after the
61 * system woke up after suspension.
63 * @stop: This routine stops execution of all the active queue running on the
64 * H/W and basically this function called on system suspend.
66 * @uninitialize: Destroys all the device queue manager resources allocated in
69 * @create_kernel_queue: Creates kernel queue. Used for debug queue.
71 * @destroy_kernel_queue: Destroys kernel queue. Used for debug queue.
73 * @set_cache_memory_policy: Sets memory policy (cached/ non cached) for the
76 * @process_termination: Clears all process queues belongs to that device.
78 * @evict_process_queues: Evict all active queues of a process
80 * @restore_process_queues: Restore all evicted queues queues of a process
82 * @get_wave_state: Retrieves context save state and optionally copies the
83 * control stack, if kept in the MQD, to the given userspace address.
86 struct device_queue_manager_ops
{
87 int (*create_queue
)(struct device_queue_manager
*dqm
,
89 struct qcm_process_device
*qpd
);
91 int (*destroy_queue
)(struct device_queue_manager
*dqm
,
92 struct qcm_process_device
*qpd
,
95 int (*update_queue
)(struct device_queue_manager
*dqm
,
98 int (*register_process
)(struct device_queue_manager
*dqm
,
99 struct qcm_process_device
*qpd
);
101 int (*unregister_process
)(struct device_queue_manager
*dqm
,
102 struct qcm_process_device
*qpd
);
104 int (*initialize
)(struct device_queue_manager
*dqm
);
105 int (*start
)(struct device_queue_manager
*dqm
);
106 int (*stop
)(struct device_queue_manager
*dqm
);
107 void (*pre_reset
)(struct device_queue_manager
*dqm
);
108 void (*uninitialize
)(struct device_queue_manager
*dqm
);
109 int (*create_kernel_queue
)(struct device_queue_manager
*dqm
,
110 struct kernel_queue
*kq
,
111 struct qcm_process_device
*qpd
);
113 void (*destroy_kernel_queue
)(struct device_queue_manager
*dqm
,
114 struct kernel_queue
*kq
,
115 struct qcm_process_device
*qpd
);
117 bool (*set_cache_memory_policy
)(struct device_queue_manager
*dqm
,
118 struct qcm_process_device
*qpd
,
119 enum cache_policy default_policy
,
120 enum cache_policy alternate_policy
,
121 void __user
*alternate_aperture_base
,
122 uint64_t alternate_aperture_size
);
124 int (*set_trap_handler
)(struct device_queue_manager
*dqm
,
125 struct qcm_process_device
*qpd
,
129 int (*process_termination
)(struct device_queue_manager
*dqm
,
130 struct qcm_process_device
*qpd
);
132 int (*evict_process_queues
)(struct device_queue_manager
*dqm
,
133 struct qcm_process_device
*qpd
);
134 int (*restore_process_queues
)(struct device_queue_manager
*dqm
,
135 struct qcm_process_device
*qpd
);
137 int (*get_wave_state
)(struct device_queue_manager
*dqm
,
139 void __user
*ctl_stack
,
140 u32
*ctl_stack_used_size
,
141 u32
*save_area_used_size
);
144 struct device_queue_manager_asic_ops
{
145 int (*update_qpd
)(struct device_queue_manager
*dqm
,
146 struct qcm_process_device
*qpd
);
147 bool (*set_cache_memory_policy
)(struct device_queue_manager
*dqm
,
148 struct qcm_process_device
*qpd
,
149 enum cache_policy default_policy
,
150 enum cache_policy alternate_policy
,
151 void __user
*alternate_aperture_base
,
152 uint64_t alternate_aperture_size
);
153 void (*init_sdma_vm
)(struct device_queue_manager
*dqm
,
155 struct qcm_process_device
*qpd
);
156 struct mqd_manager
* (*mqd_manager_init
)(enum KFD_MQD_TYPE type
,
157 struct kfd_dev
*dev
);
161 * struct device_queue_manager
163 * This struct is a base class for the kfd queues scheduler in the
164 * device level. The device base class should expose the basic operations
165 * for queue creation and queue destruction. This base class hides the
166 * scheduling mode of the driver and the specific implementation of the
167 * concrete device. This class is the only class in the queues scheduler
168 * that configures the H/W.
172 struct device_queue_manager
{
173 struct device_queue_manager_ops ops
;
174 struct device_queue_manager_asic_ops asic_ops
;
176 struct mqd_manager
*mqd_mgrs
[KFD_MQD_TYPE_MAX
];
177 struct packet_manager packets
;
179 struct mutex lock_hidden
; /* use dqm_lock/unlock(dqm) */
180 struct list_head queues
;
181 unsigned int saved_flags
;
182 unsigned int processes_count
;
183 unsigned int active_queue_count
;
184 unsigned int active_cp_queue_count
;
185 unsigned int gws_queue_count
;
186 unsigned int total_queue_count
;
187 unsigned int next_pipe_to_allocate
;
188 unsigned int *allocated_queues
;
189 uint64_t sdma_bitmap
;
190 uint64_t xgmi_sdma_bitmap
;
191 /* the pasid mapping for each kfd vmid */
192 uint16_t vmid_pasid
[VMID_NUM
];
193 uint64_t pipelines_addr
;
194 uint64_t fence_gpu_addr
;
195 unsigned int *fence_addr
;
196 struct kfd_mem_obj
*fence_mem
;
203 struct work_struct hw_exception_work
;
204 struct kfd_mem_obj hiq_sdma_mqd
;
208 void device_queue_manager_init_cik(
209 struct device_queue_manager_asic_ops
*asic_ops
);
210 void device_queue_manager_init_cik_hawaii(
211 struct device_queue_manager_asic_ops
*asic_ops
);
212 void device_queue_manager_init_vi(
213 struct device_queue_manager_asic_ops
*asic_ops
);
214 void device_queue_manager_init_vi_tonga(
215 struct device_queue_manager_asic_ops
*asic_ops
);
216 void device_queue_manager_init_v9(
217 struct device_queue_manager_asic_ops
*asic_ops
);
218 void device_queue_manager_init_v10_navi10(
219 struct device_queue_manager_asic_ops
*asic_ops
);
220 void program_sh_mem_settings(struct device_queue_manager
*dqm
,
221 struct qcm_process_device
*qpd
);
222 unsigned int get_cp_queues_num(struct device_queue_manager
*dqm
);
223 unsigned int get_queues_per_pipe(struct device_queue_manager
*dqm
);
224 unsigned int get_pipes_per_mec(struct device_queue_manager
*dqm
);
225 unsigned int get_num_sdma_queues(struct device_queue_manager
*dqm
);
226 unsigned int get_num_xgmi_sdma_queues(struct device_queue_manager
*dqm
);
228 static inline unsigned int get_sh_mem_bases_32(struct kfd_process_device
*pdd
)
230 return (pdd
->lds_base
>> 16) & 0xFF;
233 static inline unsigned int
234 get_sh_mem_bases_nybble_64(struct kfd_process_device
*pdd
)
236 return (pdd
->lds_base
>> 60) & 0x0E;
239 /* The DQM lock can be taken in MMU notifiers. Make sure no reclaim-FS
240 * happens while holding this lock anywhere to prevent deadlocks when
241 * an MMU notifier runs in reclaim-FS context.
243 static inline void dqm_lock(struct device_queue_manager
*dqm
)
245 mutex_lock(&dqm
->lock_hidden
);
246 dqm
->saved_flags
= memalloc_nofs_save();
248 static inline void dqm_unlock(struct device_queue_manager
*dqm
)
250 memalloc_nofs_restore(dqm
->saved_flags
);
251 mutex_unlock(&dqm
->lock_hidden
);
254 static inline int read_sdma_queue_counter(uint64_t __user
*q_rptr
, uint64_t *val
)
257 * SDMA activity counter is stored at queue's RPTR + 0x8 location.
259 return get_user(*val
, q_rptr
+ 1);
261 #endif /* KFD_DEVICE_QUEUE_MANAGER_H_ */