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 <linux/mutex.h>
 30#include <linux/sched/mm.h>
 31#include "kfd_priv.h"
 32#include "kfd_mqd_manager.h"
 33
 34
 35struct device_process_node {
 36	struct qcm_process_device *qpd;
 37	struct list_head list;
 38};
 39
 40/**
 41 * struct device_queue_manager_ops
 42 *
 43 * @create_queue: Queue creation routine.
 44 *
 45 * @destroy_queue: Queue destruction routine.
 46 *
 47 * @update_queue: Queue update routine.
 48 *
 49 * @exeute_queues: Dispatches the queues list to the H/W.
 50 *
 51 * @register_process: This routine associates a specific process with device.
 52 *
 53 * @unregister_process: destroys the associations between process to device.
 54 *
 55 * @initialize: Initializes the pipelines and memory module for that device.
 56 *
 57 * @start: Initializes the resources/modules the the device needs for queues
 58 * execution. This function is called on device initialization and after the
 59 * system woke up after suspension.
 60 *
 61 * @stop: This routine stops execution of all the active queue running on the
 62 * H/W and basically this function called on system suspend.
 63 *
 64 * @uninitialize: Destroys all the device queue manager resources allocated in
 65 * initialize routine.
 66 *
 67 * @create_kernel_queue: Creates kernel queue. Used for debug queue.
 68 *
 69 * @destroy_kernel_queue: Destroys kernel queue. Used for debug queue.
 70 *
 71 * @set_cache_memory_policy: Sets memory policy (cached/ non cached) for the
 72 * memory apertures.
 73 *
 74 * @process_termination: Clears all process queues belongs to that device.
 75 *
 76 * @evict_process_queues: Evict all active queues of a process
 77 *
 78 * @restore_process_queues: Restore all evicted queues queues of a process
 79 *
 80 * @get_wave_state: Retrieves context save state and optionally copies the
 81 * control stack, if kept in the MQD, to the given userspace address.
 82 */
 83
 84struct device_queue_manager_ops {
 85	int	(*create_queue)(struct device_queue_manager *dqm,
 86				struct queue *q,
 87				struct qcm_process_device *qpd);
 88
 89	int	(*destroy_queue)(struct device_queue_manager *dqm,
 90				struct qcm_process_device *qpd,
 91				struct queue *q);
 92
 93	int	(*update_queue)(struct device_queue_manager *dqm,
 94				struct queue *q);
 95
 96	int	(*register_process)(struct device_queue_manager *dqm,
 97					struct qcm_process_device *qpd);
 98
 99	int	(*unregister_process)(struct device_queue_manager *dqm,
100					struct qcm_process_device *qpd);
101
102	int	(*initialize)(struct device_queue_manager *dqm);
103	int	(*start)(struct device_queue_manager *dqm);
104	int	(*stop)(struct device_queue_manager *dqm);
105	void	(*uninitialize)(struct device_queue_manager *dqm);
106	int	(*create_kernel_queue)(struct device_queue_manager *dqm,
107					struct kernel_queue *kq,
108					struct qcm_process_device *qpd);
109
110	void	(*destroy_kernel_queue)(struct device_queue_manager *dqm,
111					struct kernel_queue *kq,
112					struct qcm_process_device *qpd);
113
114	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
115					   struct qcm_process_device *qpd,
116					   enum cache_policy default_policy,
117					   enum cache_policy alternate_policy,
118					   void __user *alternate_aperture_base,
119					   uint64_t alternate_aperture_size);
120
121	int	(*set_trap_handler)(struct device_queue_manager *dqm,
122				    struct qcm_process_device *qpd,
123				    uint64_t tba_addr,
124				    uint64_t tma_addr);
125
126	int (*process_termination)(struct device_queue_manager *dqm,
127			struct qcm_process_device *qpd);
128
129	int (*evict_process_queues)(struct device_queue_manager *dqm,
130				    struct qcm_process_device *qpd);
131	int (*restore_process_queues)(struct device_queue_manager *dqm,
132				      struct qcm_process_device *qpd);
133
134	int	(*get_wave_state)(struct device_queue_manager *dqm,
135				  struct queue *q,
136				  void __user *ctl_stack,
137				  u32 *ctl_stack_used_size,
138				  u32 *save_area_used_size);
139};
140
141struct device_queue_manager_asic_ops {
142	int	(*update_qpd)(struct device_queue_manager *dqm,
143					struct qcm_process_device *qpd);
144	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
145					   struct qcm_process_device *qpd,
146					   enum cache_policy default_policy,
147					   enum cache_policy alternate_policy,
148					   void __user *alternate_aperture_base,
149					   uint64_t alternate_aperture_size);
150	void	(*init_sdma_vm)(struct device_queue_manager *dqm,
151				struct queue *q,
152				struct qcm_process_device *qpd);
153	struct mqd_manager *	(*mqd_manager_init)(enum KFD_MQD_TYPE type,
154				 struct kfd_dev *dev);
155};
156
157/**
158 * struct device_queue_manager
159 *
160 * This struct is a base class for the kfd queues scheduler in the
161 * device level. The device base class should expose the basic operations
162 * for queue creation and queue destruction. This base class hides the
163 * scheduling mode of the driver and the specific implementation of the
164 * concrete device. This class is the only class in the queues scheduler
165 * that configures the H/W.
166 *
167 */
168
169struct device_queue_manager {
170	struct device_queue_manager_ops ops;
171	struct device_queue_manager_asic_ops asic_ops;
172
173	struct mqd_manager	*mqd_mgrs[KFD_MQD_TYPE_MAX];
174	struct packet_manager	packets;
175	struct kfd_dev		*dev;
176	struct mutex		lock_hidden; /* use dqm_lock/unlock(dqm) */
177	struct list_head	queues;
178	unsigned int		saved_flags;
179	unsigned int		processes_count;
180	unsigned int		queue_count;
181	unsigned int		sdma_queue_count;
182	unsigned int		xgmi_sdma_queue_count;
183	unsigned int		total_queue_count;
184	unsigned int		next_pipe_to_allocate;
185	unsigned int		*allocated_queues;
186	uint64_t		sdma_bitmap;
187	uint64_t		xgmi_sdma_bitmap;
188	unsigned int		vmid_bitmap;
189	uint64_t		pipelines_addr;
190	struct kfd_mem_obj	*pipeline_mem;
191	uint64_t		fence_gpu_addr;
192	unsigned int		*fence_addr;
193	struct kfd_mem_obj	*fence_mem;
194	bool			active_runlist;
195	int			sched_policy;
196
197	/* hw exception  */
198	bool			is_hws_hang;
199	struct work_struct	hw_exception_work;
200	struct kfd_mem_obj	hiq_sdma_mqd;
201};
202
203void device_queue_manager_init_cik(
204		struct device_queue_manager_asic_ops *asic_ops);
205void device_queue_manager_init_cik_hawaii(
206		struct device_queue_manager_asic_ops *asic_ops);
207void device_queue_manager_init_vi(
208		struct device_queue_manager_asic_ops *asic_ops);
209void device_queue_manager_init_vi_tonga(
210		struct device_queue_manager_asic_ops *asic_ops);
211void device_queue_manager_init_v9(
212		struct device_queue_manager_asic_ops *asic_ops);
213void device_queue_manager_init_v10_navi10(
214		struct device_queue_manager_asic_ops *asic_ops);
215void program_sh_mem_settings(struct device_queue_manager *dqm,
216					struct qcm_process_device *qpd);
217unsigned int get_queues_num(struct device_queue_manager *dqm);
218unsigned int get_queues_per_pipe(struct device_queue_manager *dqm);
219unsigned int get_pipes_per_mec(struct device_queue_manager *dqm);
220unsigned int get_num_sdma_queues(struct device_queue_manager *dqm);
221unsigned int get_num_xgmi_sdma_queues(struct device_queue_manager *dqm);
222
223static inline unsigned int get_sh_mem_bases_32(struct kfd_process_device *pdd)
224{
225	return (pdd->lds_base >> 16) & 0xFF;
226}
227
228static inline unsigned int
229get_sh_mem_bases_nybble_64(struct kfd_process_device *pdd)
230{
231	return (pdd->lds_base >> 60) & 0x0E;
232}
233
234/* The DQM lock can be taken in MMU notifiers. Make sure no reclaim-FS
235 * happens while holding this lock anywhere to prevent deadlocks when
236 * an MMU notifier runs in reclaim-FS context.
237 */
238static inline void dqm_lock(struct device_queue_manager *dqm)
239{
240	mutex_lock(&dqm->lock_hidden);
241	dqm->saved_flags = memalloc_nofs_save();
242}
243static inline void dqm_unlock(struct device_queue_manager *dqm)
244{
245	memalloc_nofs_restore(dqm->saved_flags);
246	mutex_unlock(&dqm->lock_hidden);
247}
248
249#endif /* KFD_DEVICE_QUEUE_MANAGER_H_ */