xref: /openbmc/linux/drivers/gpu/drm/amd/amdkfd/kfd_priv.h (revision 2fa49589)
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 #ifndef KFD_PRIV_H_INCLUDED
24 #define KFD_PRIV_H_INCLUDED
25 
26 #include <linux/hashtable.h>
27 #include <linux/mmu_notifier.h>
28 #include <linux/mutex.h>
29 #include <linux/types.h>
30 #include <linux/atomic.h>
31 #include <linux/workqueue.h>
32 #include <linux/spinlock.h>
33 #include <linux/kfd_ioctl.h>
34 #include <linux/idr.h>
35 #include <linux/kfifo.h>
36 #include <linux/seq_file.h>
37 #include <linux/kref.h>
38 #include <kgd_kfd_interface.h>
39 
40 #include "amd_shared.h"
41 
42 #define KFD_MAX_RING_ENTRY_SIZE	8
43 
44 #define KFD_SYSFS_FILE_MODE 0444
45 
46 /* GPU ID hash width in bits */
47 #define KFD_GPU_ID_HASH_WIDTH 16
48 
49 /* Use upper bits of mmap offset to store KFD driver specific information.
50  * BITS[63:62] - Encode MMAP type
51  * BITS[61:46] - Encode gpu_id. To identify to which GPU the offset belongs to
52  * BITS[45:0]  - MMAP offset value
53  *
54  * NOTE: struct vm_area_struct.vm_pgoff uses offset in pages. Hence, these
55  *  defines are w.r.t to PAGE_SIZE
56  */
57 #define KFD_MMAP_TYPE_SHIFT	(62 - PAGE_SHIFT)
58 #define KFD_MMAP_TYPE_MASK	(0x3ULL << KFD_MMAP_TYPE_SHIFT)
59 #define KFD_MMAP_TYPE_DOORBELL	(0x3ULL << KFD_MMAP_TYPE_SHIFT)
60 #define KFD_MMAP_TYPE_EVENTS	(0x2ULL << KFD_MMAP_TYPE_SHIFT)
61 #define KFD_MMAP_TYPE_RESERVED_MEM	(0x1ULL << KFD_MMAP_TYPE_SHIFT)
62 
63 #define KFD_MMAP_GPU_ID_SHIFT (46 - PAGE_SHIFT)
64 #define KFD_MMAP_GPU_ID_MASK (((1ULL << KFD_GPU_ID_HASH_WIDTH) - 1) \
65 				<< KFD_MMAP_GPU_ID_SHIFT)
66 #define KFD_MMAP_GPU_ID(gpu_id) ((((uint64_t)gpu_id) << KFD_MMAP_GPU_ID_SHIFT)\
67 				& KFD_MMAP_GPU_ID_MASK)
68 #define KFD_MMAP_GPU_ID_GET(offset)    ((offset & KFD_MMAP_GPU_ID_MASK) \
69 				>> KFD_MMAP_GPU_ID_SHIFT)
70 
71 #define KFD_MMAP_OFFSET_VALUE_MASK	(0x3FFFFFFFFFFFULL >> PAGE_SHIFT)
72 #define KFD_MMAP_OFFSET_VALUE_GET(offset) (offset & KFD_MMAP_OFFSET_VALUE_MASK)
73 
74 /*
75  * When working with cp scheduler we should assign the HIQ manually or via
76  * the amdgpu driver to a fixed hqd slot, here are the fixed HIQ hqd slot
77  * definitions for Kaveri. In Kaveri only the first ME queues participates
78  * in the cp scheduling taking that in mind we set the HIQ slot in the
79  * second ME.
80  */
81 #define KFD_CIK_HIQ_PIPE 4
82 #define KFD_CIK_HIQ_QUEUE 0
83 
84 /* Macro for allocating structures */
85 #define kfd_alloc_struct(ptr_to_struct)	\
86 	((typeof(ptr_to_struct)) kzalloc(sizeof(*ptr_to_struct), GFP_KERNEL))
87 
88 #define KFD_MAX_NUM_OF_PROCESSES 512
89 #define KFD_MAX_NUM_OF_QUEUES_PER_PROCESS 1024
90 
91 /*
92  * Size of the per-process TBA+TMA buffer: 2 pages
93  *
94  * The first page is the TBA used for the CWSR ISA code. The second
95  * page is used as TMA for daisy changing a user-mode trap handler.
96  */
97 #define KFD_CWSR_TBA_TMA_SIZE (PAGE_SIZE * 2)
98 #define KFD_CWSR_TMA_OFFSET PAGE_SIZE
99 
100 /*
101  * Kernel module parameter to specify maximum number of supported queues per
102  * device
103  */
104 extern int max_num_of_queues_per_device;
105 
106 #define KFD_MAX_NUM_OF_QUEUES_PER_DEVICE		\
107 	(KFD_MAX_NUM_OF_PROCESSES *			\
108 			KFD_MAX_NUM_OF_QUEUES_PER_PROCESS)
109 
110 #define KFD_KERNEL_QUEUE_SIZE 2048
111 
112 /* Kernel module parameter to specify the scheduling policy */
113 extern int sched_policy;
114 
115 /*
116  * Kernel module parameter to specify the maximum process
117  * number per HW scheduler
118  */
119 extern int hws_max_conc_proc;
120 
121 extern int cwsr_enable;
122 
123 /*
124  * Kernel module parameter to specify whether to send sigterm to HSA process on
125  * unhandled exception
126  */
127 extern int send_sigterm;
128 
129 /*
130  * This kernel module is used to simulate large bar machine on non-large bar
131  * enabled machines.
132  */
133 extern int debug_largebar;
134 
135 /*
136  * Ignore CRAT table during KFD initialization, can be used to work around
137  * broken CRAT tables on some AMD systems
138  */
139 extern int ignore_crat;
140 
141 /*
142  * Set sh_mem_config.retry_disable on Vega10
143  */
144 extern int noretry;
145 
146 /*
147  * Halt if HWS hang is detected
148  */
149 extern int halt_if_hws_hang;
150 
151 enum cache_policy {
152 	cache_policy_coherent,
153 	cache_policy_noncoherent
154 };
155 
156 #define KFD_IS_SOC15(chip) ((chip) >= CHIP_VEGA10)
157 
158 struct kfd_event_interrupt_class {
159 	bool (*interrupt_isr)(struct kfd_dev *dev,
160 			const uint32_t *ih_ring_entry, uint32_t *patched_ihre,
161 			bool *patched_flag);
162 	void (*interrupt_wq)(struct kfd_dev *dev,
163 			const uint32_t *ih_ring_entry);
164 };
165 
166 struct kfd_device_info {
167 	enum amd_asic_type asic_family;
168 	const struct kfd_event_interrupt_class *event_interrupt_class;
169 	unsigned int max_pasid_bits;
170 	unsigned int max_no_of_hqd;
171 	unsigned int doorbell_size;
172 	size_t ih_ring_entry_size;
173 	uint8_t num_of_watch_points;
174 	uint16_t mqd_size_aligned;
175 	bool supports_cwsr;
176 	bool needs_iommu_device;
177 	bool needs_pci_atomics;
178 	unsigned int num_sdma_engines;
179 	unsigned int num_sdma_queues_per_engine;
180 };
181 
182 struct kfd_mem_obj {
183 	uint32_t range_start;
184 	uint32_t range_end;
185 	uint64_t gpu_addr;
186 	uint32_t *cpu_ptr;
187 	void *gtt_mem;
188 };
189 
190 struct kfd_vmid_info {
191 	uint32_t first_vmid_kfd;
192 	uint32_t last_vmid_kfd;
193 	uint32_t vmid_num_kfd;
194 };
195 
196 struct kfd_dev {
197 	struct kgd_dev *kgd;
198 
199 	const struct kfd_device_info *device_info;
200 	struct pci_dev *pdev;
201 
202 	unsigned int id;		/* topology stub index */
203 
204 	phys_addr_t doorbell_base;	/* Start of actual doorbells used by
205 					 * KFD. It is aligned for mapping
206 					 * into user mode
207 					 */
208 	size_t doorbell_id_offset;	/* Doorbell offset (from KFD doorbell
209 					 * to HW doorbell, GFX reserved some
210 					 * at the start)
211 					 */
212 	u32 __iomem *doorbell_kernel_ptr; /* This is a pointer for a doorbells
213 					   * page used by kernel queue
214 					   */
215 
216 	struct kgd2kfd_shared_resources shared_resources;
217 	struct kfd_vmid_info vm_info;
218 
219 	const struct kfd2kgd_calls *kfd2kgd;
220 	struct mutex doorbell_mutex;
221 	DECLARE_BITMAP(doorbell_available_index,
222 			KFD_MAX_NUM_OF_QUEUES_PER_PROCESS);
223 
224 	void *gtt_mem;
225 	uint64_t gtt_start_gpu_addr;
226 	void *gtt_start_cpu_ptr;
227 	void *gtt_sa_bitmap;
228 	struct mutex gtt_sa_lock;
229 	unsigned int gtt_sa_chunk_size;
230 	unsigned int gtt_sa_num_of_chunks;
231 
232 	/* Interrupts */
233 	struct kfifo ih_fifo;
234 	struct workqueue_struct *ih_wq;
235 	struct work_struct interrupt_work;
236 	spinlock_t interrupt_lock;
237 
238 	/* QCM Device instance */
239 	struct device_queue_manager *dqm;
240 
241 	bool init_complete;
242 	/*
243 	 * Interrupts of interest to KFD are copied
244 	 * from the HW ring into a SW ring.
245 	 */
246 	bool interrupts_active;
247 
248 	/* Debug manager */
249 	struct kfd_dbgmgr           *dbgmgr;
250 
251 	/* Firmware versions */
252 	uint16_t mec_fw_version;
253 	uint16_t sdma_fw_version;
254 
255 	/* Maximum process number mapped to HW scheduler */
256 	unsigned int max_proc_per_quantum;
257 
258 	/* CWSR */
259 	bool cwsr_enabled;
260 	const void *cwsr_isa;
261 	unsigned int cwsr_isa_size;
262 
263 	/* xGMI */
264 	uint64_t hive_id;
265 
266 	bool pci_atomic_requested;
267 };
268 
269 /* KGD2KFD callbacks */
270 void kgd2kfd_exit(void);
271 struct kfd_dev *kgd2kfd_probe(struct kgd_dev *kgd,
272 			struct pci_dev *pdev, const struct kfd2kgd_calls *f2g);
273 bool kgd2kfd_device_init(struct kfd_dev *kfd,
274 			const struct kgd2kfd_shared_resources *gpu_resources);
275 void kgd2kfd_device_exit(struct kfd_dev *kfd);
276 
277 enum kfd_mempool {
278 	KFD_MEMPOOL_SYSTEM_CACHEABLE = 1,
279 	KFD_MEMPOOL_SYSTEM_WRITECOMBINE = 2,
280 	KFD_MEMPOOL_FRAMEBUFFER = 3,
281 };
282 
283 /* Character device interface */
284 int kfd_chardev_init(void);
285 void kfd_chardev_exit(void);
286 struct device *kfd_chardev(void);
287 
288 /**
289  * enum kfd_unmap_queues_filter
290  *
291  * @KFD_UNMAP_QUEUES_FILTER_SINGLE_QUEUE: Preempts single queue.
292  *
293  * @KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES: Preempts all queues in the
294  *						running queues list.
295  *
296  * @KFD_UNMAP_QUEUES_FILTER_BY_PASID: Preempts queues that belongs to
297  *						specific process.
298  *
299  */
300 enum kfd_unmap_queues_filter {
301 	KFD_UNMAP_QUEUES_FILTER_SINGLE_QUEUE,
302 	KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES,
303 	KFD_UNMAP_QUEUES_FILTER_DYNAMIC_QUEUES,
304 	KFD_UNMAP_QUEUES_FILTER_BY_PASID
305 };
306 
307 /**
308  * enum kfd_queue_type
309  *
310  * @KFD_QUEUE_TYPE_COMPUTE: Regular user mode queue type.
311  *
312  * @KFD_QUEUE_TYPE_SDMA: Sdma user mode queue type.
313  *
314  * @KFD_QUEUE_TYPE_HIQ: HIQ queue type.
315  *
316  * @KFD_QUEUE_TYPE_DIQ: DIQ queue type.
317  */
318 enum kfd_queue_type  {
319 	KFD_QUEUE_TYPE_COMPUTE,
320 	KFD_QUEUE_TYPE_SDMA,
321 	KFD_QUEUE_TYPE_HIQ,
322 	KFD_QUEUE_TYPE_DIQ
323 };
324 
325 enum kfd_queue_format {
326 	KFD_QUEUE_FORMAT_PM4,
327 	KFD_QUEUE_FORMAT_AQL
328 };
329 
330 /**
331  * struct queue_properties
332  *
333  * @type: The queue type.
334  *
335  * @queue_id: Queue identifier.
336  *
337  * @queue_address: Queue ring buffer address.
338  *
339  * @queue_size: Queue ring buffer size.
340  *
341  * @priority: Defines the queue priority relative to other queues in the
342  * process.
343  * This is just an indication and HW scheduling may override the priority as
344  * necessary while keeping the relative prioritization.
345  * the priority granularity is from 0 to f which f is the highest priority.
346  * currently all queues are initialized with the highest priority.
347  *
348  * @queue_percent: This field is partially implemented and currently a zero in
349  * this field defines that the queue is non active.
350  *
351  * @read_ptr: User space address which points to the number of dwords the
352  * cp read from the ring buffer. This field updates automatically by the H/W.
353  *
354  * @write_ptr: Defines the number of dwords written to the ring buffer.
355  *
356  * @doorbell_ptr: This field aim is to notify the H/W of new packet written to
357  * the queue ring buffer. This field should be similar to write_ptr and the
358  * user should update this field after he updated the write_ptr.
359  *
360  * @doorbell_off: The doorbell offset in the doorbell pci-bar.
361  *
362  * @is_interop: Defines if this is a interop queue. Interop queue means that
363  * the queue can access both graphics and compute resources.
364  *
365  * @is_evicted: Defines if the queue is evicted. Only active queues
366  * are evicted, rendering them inactive.
367  *
368  * @is_active: Defines if the queue is active or not. @is_active and
369  * @is_evicted are protected by the DQM lock.
370  *
371  * @vmid: If the scheduling mode is no cp scheduling the field defines the vmid
372  * of the queue.
373  *
374  * This structure represents the queue properties for each queue no matter if
375  * it's user mode or kernel mode queue.
376  *
377  */
378 struct queue_properties {
379 	enum kfd_queue_type type;
380 	enum kfd_queue_format format;
381 	unsigned int queue_id;
382 	uint64_t queue_address;
383 	uint64_t  queue_size;
384 	uint32_t priority;
385 	uint32_t queue_percent;
386 	uint32_t *read_ptr;
387 	uint32_t *write_ptr;
388 	void __iomem *doorbell_ptr;
389 	uint32_t doorbell_off;
390 	bool is_interop;
391 	bool is_evicted;
392 	bool is_active;
393 	/* Not relevant for user mode queues in cp scheduling */
394 	unsigned int vmid;
395 	/* Relevant only for sdma queues*/
396 	uint32_t sdma_engine_id;
397 	uint32_t sdma_queue_id;
398 	uint32_t sdma_vm_addr;
399 	/* Relevant only for VI */
400 	uint64_t eop_ring_buffer_address;
401 	uint32_t eop_ring_buffer_size;
402 	uint64_t ctx_save_restore_area_address;
403 	uint32_t ctx_save_restore_area_size;
404 	uint32_t ctl_stack_size;
405 	uint64_t tba_addr;
406 	uint64_t tma_addr;
407 	/* Relevant for CU */
408 	uint32_t cu_mask_count; /* Must be a multiple of 32 */
409 	uint32_t *cu_mask;
410 };
411 
412 /**
413  * struct queue
414  *
415  * @list: Queue linked list.
416  *
417  * @mqd: The queue MQD.
418  *
419  * @mqd_mem_obj: The MQD local gpu memory object.
420  *
421  * @gart_mqd_addr: The MQD gart mc address.
422  *
423  * @properties: The queue properties.
424  *
425  * @mec: Used only in no cp scheduling mode and identifies to micro engine id
426  *	 that the queue should be execute on.
427  *
428  * @pipe: Used only in no cp scheduling mode and identifies the queue's pipe
429  *	  id.
430  *
431  * @queue: Used only in no cp scheduliong mode and identifies the queue's slot.
432  *
433  * @process: The kfd process that created this queue.
434  *
435  * @device: The kfd device that created this queue.
436  *
437  * This structure represents user mode compute queues.
438  * It contains all the necessary data to handle such queues.
439  *
440  */
441 
442 struct queue {
443 	struct list_head list;
444 	void *mqd;
445 	struct kfd_mem_obj *mqd_mem_obj;
446 	uint64_t gart_mqd_addr;
447 	struct queue_properties properties;
448 
449 	uint32_t mec;
450 	uint32_t pipe;
451 	uint32_t queue;
452 
453 	unsigned int sdma_id;
454 	unsigned int doorbell_id;
455 
456 	struct kfd_process	*process;
457 	struct kfd_dev		*device;
458 };
459 
460 /*
461  * Please read the kfd_mqd_manager.h description.
462  */
463 enum KFD_MQD_TYPE {
464 	KFD_MQD_TYPE_COMPUTE = 0,	/* for no cp scheduling */
465 	KFD_MQD_TYPE_HIQ,		/* for hiq */
466 	KFD_MQD_TYPE_CP,		/* for cp queues and diq */
467 	KFD_MQD_TYPE_SDMA,		/* for sdma queues */
468 	KFD_MQD_TYPE_MAX
469 };
470 
471 struct scheduling_resources {
472 	unsigned int vmid_mask;
473 	enum kfd_queue_type type;
474 	uint64_t queue_mask;
475 	uint64_t gws_mask;
476 	uint32_t oac_mask;
477 	uint32_t gds_heap_base;
478 	uint32_t gds_heap_size;
479 };
480 
481 struct process_queue_manager {
482 	/* data */
483 	struct kfd_process	*process;
484 	struct list_head	queues;
485 	unsigned long		*queue_slot_bitmap;
486 };
487 
488 struct qcm_process_device {
489 	/* The Device Queue Manager that owns this data */
490 	struct device_queue_manager *dqm;
491 	struct process_queue_manager *pqm;
492 	/* Queues list */
493 	struct list_head queues_list;
494 	struct list_head priv_queue_list;
495 
496 	unsigned int queue_count;
497 	unsigned int vmid;
498 	bool is_debug;
499 	unsigned int evicted; /* eviction counter, 0=active */
500 
501 	/* This flag tells if we should reset all wavefronts on
502 	 * process termination
503 	 */
504 	bool reset_wavefronts;
505 
506 	/*
507 	 * All the memory management data should be here too
508 	 */
509 	uint64_t gds_context_area;
510 	/* Contains page table flags such as AMDGPU_PTE_VALID since gfx9 */
511 	uint64_t page_table_base;
512 	uint32_t sh_mem_config;
513 	uint32_t sh_mem_bases;
514 	uint32_t sh_mem_ape1_base;
515 	uint32_t sh_mem_ape1_limit;
516 	uint32_t gds_size;
517 	uint32_t num_gws;
518 	uint32_t num_oac;
519 	uint32_t sh_hidden_private_base;
520 
521 	/* CWSR memory */
522 	void *cwsr_kaddr;
523 	uint64_t cwsr_base;
524 	uint64_t tba_addr;
525 	uint64_t tma_addr;
526 
527 	/* IB memory */
528 	uint64_t ib_base;
529 	void *ib_kaddr;
530 
531 	/* doorbell resources per process per device */
532 	unsigned long *doorbell_bitmap;
533 };
534 
535 /* KFD Memory Eviction */
536 
537 /* Approx. wait time before attempting to restore evicted BOs */
538 #define PROCESS_RESTORE_TIME_MS 100
539 /* Approx. back off time if restore fails due to lack of memory */
540 #define PROCESS_BACK_OFF_TIME_MS 100
541 /* Approx. time before evicting the process again */
542 #define PROCESS_ACTIVE_TIME_MS 10
543 
544 int kgd2kfd_quiesce_mm(struct mm_struct *mm);
545 int kgd2kfd_resume_mm(struct mm_struct *mm);
546 int kgd2kfd_schedule_evict_and_restore_process(struct mm_struct *mm,
547 					       struct dma_fence *fence);
548 
549 /* 8 byte handle containing GPU ID in the most significant 4 bytes and
550  * idr_handle in the least significant 4 bytes
551  */
552 #define MAKE_HANDLE(gpu_id, idr_handle) \
553 	(((uint64_t)(gpu_id) << 32) + idr_handle)
554 #define GET_GPU_ID(handle) (handle >> 32)
555 #define GET_IDR_HANDLE(handle) (handle & 0xFFFFFFFF)
556 
557 enum kfd_pdd_bound {
558 	PDD_UNBOUND = 0,
559 	PDD_BOUND,
560 	PDD_BOUND_SUSPENDED,
561 };
562 
563 /* Data that is per-process-per device. */
564 struct kfd_process_device {
565 	/*
566 	 * List of all per-device data for a process.
567 	 * Starts from kfd_process.per_device_data.
568 	 */
569 	struct list_head per_device_list;
570 
571 	/* The device that owns this data. */
572 	struct kfd_dev *dev;
573 
574 	/* The process that owns this kfd_process_device. */
575 	struct kfd_process *process;
576 
577 	/* per-process-per device QCM data structure */
578 	struct qcm_process_device qpd;
579 
580 	/*Apertures*/
581 	uint64_t lds_base;
582 	uint64_t lds_limit;
583 	uint64_t gpuvm_base;
584 	uint64_t gpuvm_limit;
585 	uint64_t scratch_base;
586 	uint64_t scratch_limit;
587 
588 	/* VM context for GPUVM allocations */
589 	struct file *drm_file;
590 	void *vm;
591 
592 	/* GPUVM allocations storage */
593 	struct idr alloc_idr;
594 
595 	/* Flag used to tell the pdd has dequeued from the dqm.
596 	 * This is used to prevent dev->dqm->ops.process_termination() from
597 	 * being called twice when it is already called in IOMMU callback
598 	 * function.
599 	 */
600 	bool already_dequeued;
601 
602 	/* Is this process/pasid bound to this device? (amd_iommu_bind_pasid) */
603 	enum kfd_pdd_bound bound;
604 };
605 
606 #define qpd_to_pdd(x) container_of(x, struct kfd_process_device, qpd)
607 
608 /* Process data */
609 struct kfd_process {
610 	/*
611 	 * kfd_process are stored in an mm_struct*->kfd_process*
612 	 * hash table (kfd_processes in kfd_process.c)
613 	 */
614 	struct hlist_node kfd_processes;
615 
616 	/*
617 	 * Opaque pointer to mm_struct. We don't hold a reference to
618 	 * it so it should never be dereferenced from here. This is
619 	 * only used for looking up processes by their mm.
620 	 */
621 	void *mm;
622 
623 	struct kref ref;
624 	struct work_struct release_work;
625 
626 	struct mutex mutex;
627 
628 	/*
629 	 * In any process, the thread that started main() is the lead
630 	 * thread and outlives the rest.
631 	 * It is here because amd_iommu_bind_pasid wants a task_struct.
632 	 * It can also be used for safely getting a reference to the
633 	 * mm_struct of the process.
634 	 */
635 	struct task_struct *lead_thread;
636 
637 	/* We want to receive a notification when the mm_struct is destroyed */
638 	struct mmu_notifier mmu_notifier;
639 
640 	/* Use for delayed freeing of kfd_process structure */
641 	struct rcu_head	rcu;
642 
643 	unsigned int pasid;
644 	unsigned int doorbell_index;
645 
646 	/*
647 	 * List of kfd_process_device structures,
648 	 * one for each device the process is using.
649 	 */
650 	struct list_head per_device_data;
651 
652 	struct process_queue_manager pqm;
653 
654 	/*Is the user space process 32 bit?*/
655 	bool is_32bit_user_mode;
656 
657 	/* Event-related data */
658 	struct mutex event_mutex;
659 	/* Event ID allocator and lookup */
660 	struct idr event_idr;
661 	/* Event page */
662 	struct kfd_signal_page *signal_page;
663 	size_t signal_mapped_size;
664 	size_t signal_event_count;
665 	bool signal_event_limit_reached;
666 
667 	/* Information used for memory eviction */
668 	void *kgd_process_info;
669 	/* Eviction fence that is attached to all the BOs of this process. The
670 	 * fence will be triggered during eviction and new one will be created
671 	 * during restore
672 	 */
673 	struct dma_fence *ef;
674 
675 	/* Work items for evicting and restoring BOs */
676 	struct delayed_work eviction_work;
677 	struct delayed_work restore_work;
678 	/* seqno of the last scheduled eviction */
679 	unsigned int last_eviction_seqno;
680 	/* Approx. the last timestamp (in jiffies) when the process was
681 	 * restored after an eviction
682 	 */
683 	unsigned long last_restore_timestamp;
684 };
685 
686 #define KFD_PROCESS_TABLE_SIZE 5 /* bits: 32 entries */
687 extern DECLARE_HASHTABLE(kfd_processes_table, KFD_PROCESS_TABLE_SIZE);
688 extern struct srcu_struct kfd_processes_srcu;
689 
690 /**
691  * Ioctl function type.
692  *
693  * \param filep pointer to file structure.
694  * \param p amdkfd process pointer.
695  * \param data pointer to arg that was copied from user.
696  */
697 typedef int amdkfd_ioctl_t(struct file *filep, struct kfd_process *p,
698 				void *data);
699 
700 struct amdkfd_ioctl_desc {
701 	unsigned int cmd;
702 	int flags;
703 	amdkfd_ioctl_t *func;
704 	unsigned int cmd_drv;
705 	const char *name;
706 };
707 bool kfd_dev_is_large_bar(struct kfd_dev *dev);
708 
709 int kfd_process_create_wq(void);
710 void kfd_process_destroy_wq(void);
711 struct kfd_process *kfd_create_process(struct file *filep);
712 struct kfd_process *kfd_get_process(const struct task_struct *);
713 struct kfd_process *kfd_lookup_process_by_pasid(unsigned int pasid);
714 struct kfd_process *kfd_lookup_process_by_mm(const struct mm_struct *mm);
715 void kfd_unref_process(struct kfd_process *p);
716 int kfd_process_evict_queues(struct kfd_process *p);
717 int kfd_process_restore_queues(struct kfd_process *p);
718 void kfd_suspend_all_processes(void);
719 int kfd_resume_all_processes(void);
720 
721 int kfd_process_device_init_vm(struct kfd_process_device *pdd,
722 			       struct file *drm_file);
723 struct kfd_process_device *kfd_bind_process_to_device(struct kfd_dev *dev,
724 						struct kfd_process *p);
725 struct kfd_process_device *kfd_get_process_device_data(struct kfd_dev *dev,
726 							struct kfd_process *p);
727 struct kfd_process_device *kfd_create_process_device_data(struct kfd_dev *dev,
728 							struct kfd_process *p);
729 
730 int kfd_reserved_mem_mmap(struct kfd_dev *dev, struct kfd_process *process,
731 			  struct vm_area_struct *vma);
732 
733 /* KFD process API for creating and translating handles */
734 int kfd_process_device_create_obj_handle(struct kfd_process_device *pdd,
735 					void *mem);
736 void *kfd_process_device_translate_handle(struct kfd_process_device *p,
737 					int handle);
738 void kfd_process_device_remove_obj_handle(struct kfd_process_device *pdd,
739 					int handle);
740 
741 /* Process device data iterator */
742 struct kfd_process_device *kfd_get_first_process_device_data(
743 							struct kfd_process *p);
744 struct kfd_process_device *kfd_get_next_process_device_data(
745 						struct kfd_process *p,
746 						struct kfd_process_device *pdd);
747 bool kfd_has_process_device_data(struct kfd_process *p);
748 
749 /* PASIDs */
750 int kfd_pasid_init(void);
751 void kfd_pasid_exit(void);
752 bool kfd_set_pasid_limit(unsigned int new_limit);
753 unsigned int kfd_get_pasid_limit(void);
754 unsigned int kfd_pasid_alloc(void);
755 void kfd_pasid_free(unsigned int pasid);
756 
757 /* Doorbells */
758 size_t kfd_doorbell_process_slice(struct kfd_dev *kfd);
759 int kfd_doorbell_init(struct kfd_dev *kfd);
760 void kfd_doorbell_fini(struct kfd_dev *kfd);
761 int kfd_doorbell_mmap(struct kfd_dev *dev, struct kfd_process *process,
762 		      struct vm_area_struct *vma);
763 void __iomem *kfd_get_kernel_doorbell(struct kfd_dev *kfd,
764 					unsigned int *doorbell_off);
765 void kfd_release_kernel_doorbell(struct kfd_dev *kfd, u32 __iomem *db_addr);
766 u32 read_kernel_doorbell(u32 __iomem *db);
767 void write_kernel_doorbell(void __iomem *db, u32 value);
768 void write_kernel_doorbell64(void __iomem *db, u64 value);
769 unsigned int kfd_doorbell_id_to_offset(struct kfd_dev *kfd,
770 					struct kfd_process *process,
771 					unsigned int doorbell_id);
772 phys_addr_t kfd_get_process_doorbells(struct kfd_dev *dev,
773 					struct kfd_process *process);
774 int kfd_alloc_process_doorbells(struct kfd_process *process);
775 void kfd_free_process_doorbells(struct kfd_process *process);
776 
777 /* GTT Sub-Allocator */
778 
779 int kfd_gtt_sa_allocate(struct kfd_dev *kfd, unsigned int size,
780 			struct kfd_mem_obj **mem_obj);
781 
782 int kfd_gtt_sa_free(struct kfd_dev *kfd, struct kfd_mem_obj *mem_obj);
783 
784 extern struct device *kfd_device;
785 
786 /* Topology */
787 int kfd_topology_init(void);
788 void kfd_topology_shutdown(void);
789 int kfd_topology_add_device(struct kfd_dev *gpu);
790 int kfd_topology_remove_device(struct kfd_dev *gpu);
791 struct kfd_topology_device *kfd_topology_device_by_proximity_domain(
792 						uint32_t proximity_domain);
793 struct kfd_topology_device *kfd_topology_device_by_id(uint32_t gpu_id);
794 struct kfd_dev *kfd_device_by_id(uint32_t gpu_id);
795 struct kfd_dev *kfd_device_by_pci_dev(const struct pci_dev *pdev);
796 struct kfd_dev *kfd_device_by_kgd(const struct kgd_dev *kgd);
797 int kfd_topology_enum_kfd_devices(uint8_t idx, struct kfd_dev **kdev);
798 int kfd_numa_node_to_apic_id(int numa_node_id);
799 
800 /* Interrupts */
801 int kfd_interrupt_init(struct kfd_dev *dev);
802 void kfd_interrupt_exit(struct kfd_dev *dev);
803 void kgd2kfd_interrupt(struct kfd_dev *kfd, const void *ih_ring_entry);
804 bool enqueue_ih_ring_entry(struct kfd_dev *kfd,	const void *ih_ring_entry);
805 bool interrupt_is_wanted(struct kfd_dev *dev,
806 				const uint32_t *ih_ring_entry,
807 				uint32_t *patched_ihre, bool *flag);
808 
809 /* Power Management */
810 void kgd2kfd_suspend(struct kfd_dev *kfd);
811 int kgd2kfd_resume(struct kfd_dev *kfd);
812 
813 /* GPU reset */
814 int kgd2kfd_pre_reset(struct kfd_dev *kfd);
815 int kgd2kfd_post_reset(struct kfd_dev *kfd);
816 
817 /* amdkfd Apertures */
818 int kfd_init_apertures(struct kfd_process *process);
819 
820 /* Queue Context Management */
821 int init_queue(struct queue **q, const struct queue_properties *properties);
822 void uninit_queue(struct queue *q);
823 void print_queue_properties(struct queue_properties *q);
824 void print_queue(struct queue *q);
825 
826 struct mqd_manager *mqd_manager_init(enum KFD_MQD_TYPE type,
827 					struct kfd_dev *dev);
828 struct mqd_manager *mqd_manager_init_cik(enum KFD_MQD_TYPE type,
829 		struct kfd_dev *dev);
830 struct mqd_manager *mqd_manager_init_cik_hawaii(enum KFD_MQD_TYPE type,
831 		struct kfd_dev *dev);
832 struct mqd_manager *mqd_manager_init_vi(enum KFD_MQD_TYPE type,
833 		struct kfd_dev *dev);
834 struct mqd_manager *mqd_manager_init_vi_tonga(enum KFD_MQD_TYPE type,
835 		struct kfd_dev *dev);
836 struct mqd_manager *mqd_manager_init_v9(enum KFD_MQD_TYPE type,
837 		struct kfd_dev *dev);
838 struct device_queue_manager *device_queue_manager_init(struct kfd_dev *dev);
839 void device_queue_manager_uninit(struct device_queue_manager *dqm);
840 struct kernel_queue *kernel_queue_init(struct kfd_dev *dev,
841 					enum kfd_queue_type type);
842 void kernel_queue_uninit(struct kernel_queue *kq);
843 int kfd_process_vm_fault(struct device_queue_manager *dqm, unsigned int pasid);
844 
845 /* Process Queue Manager */
846 struct process_queue_node {
847 	struct queue *q;
848 	struct kernel_queue *kq;
849 	struct list_head process_queue_list;
850 };
851 
852 void kfd_process_dequeue_from_device(struct kfd_process_device *pdd);
853 void kfd_process_dequeue_from_all_devices(struct kfd_process *p);
854 int pqm_init(struct process_queue_manager *pqm, struct kfd_process *p);
855 void pqm_uninit(struct process_queue_manager *pqm);
856 int pqm_create_queue(struct process_queue_manager *pqm,
857 			    struct kfd_dev *dev,
858 			    struct file *f,
859 			    struct queue_properties *properties,
860 			    unsigned int *qid);
861 int pqm_destroy_queue(struct process_queue_manager *pqm, unsigned int qid);
862 int pqm_update_queue(struct process_queue_manager *pqm, unsigned int qid,
863 			struct queue_properties *p);
864 int pqm_set_cu_mask(struct process_queue_manager *pqm, unsigned int qid,
865 			struct queue_properties *p);
866 struct kernel_queue *pqm_get_kernel_queue(struct process_queue_manager *pqm,
867 						unsigned int qid);
868 int pqm_get_wave_state(struct process_queue_manager *pqm,
869 		       unsigned int qid,
870 		       void __user *ctl_stack,
871 		       u32 *ctl_stack_used_size,
872 		       u32 *save_area_used_size);
873 
874 int amdkfd_fence_wait_timeout(unsigned int *fence_addr,
875 				unsigned int fence_value,
876 				unsigned int timeout_ms);
877 
878 /* Packet Manager */
879 
880 #define KFD_FENCE_COMPLETED (100)
881 #define KFD_FENCE_INIT   (10)
882 
883 struct packet_manager {
884 	struct device_queue_manager *dqm;
885 	struct kernel_queue *priv_queue;
886 	struct mutex lock;
887 	bool allocated;
888 	struct kfd_mem_obj *ib_buffer_obj;
889 	unsigned int ib_size_bytes;
890 
891 	const struct packet_manager_funcs *pmf;
892 };
893 
894 struct packet_manager_funcs {
895 	/* Support ASIC-specific packet formats for PM4 packets */
896 	int (*map_process)(struct packet_manager *pm, uint32_t *buffer,
897 			struct qcm_process_device *qpd);
898 	int (*runlist)(struct packet_manager *pm, uint32_t *buffer,
899 			uint64_t ib, size_t ib_size_in_dwords, bool chain);
900 	int (*set_resources)(struct packet_manager *pm, uint32_t *buffer,
901 			struct scheduling_resources *res);
902 	int (*map_queues)(struct packet_manager *pm, uint32_t *buffer,
903 			struct queue *q, bool is_static);
904 	int (*unmap_queues)(struct packet_manager *pm, uint32_t *buffer,
905 			enum kfd_queue_type type,
906 			enum kfd_unmap_queues_filter mode,
907 			uint32_t filter_param, bool reset,
908 			unsigned int sdma_engine);
909 	int (*query_status)(struct packet_manager *pm, uint32_t *buffer,
910 			uint64_t fence_address,	uint32_t fence_value);
911 	int (*release_mem)(uint64_t gpu_addr, uint32_t *buffer);
912 
913 	/* Packet sizes */
914 	int map_process_size;
915 	int runlist_size;
916 	int set_resources_size;
917 	int map_queues_size;
918 	int unmap_queues_size;
919 	int query_status_size;
920 	int release_mem_size;
921 };
922 
923 extern const struct packet_manager_funcs kfd_vi_pm_funcs;
924 extern const struct packet_manager_funcs kfd_v9_pm_funcs;
925 
926 int pm_init(struct packet_manager *pm, struct device_queue_manager *dqm);
927 void pm_uninit(struct packet_manager *pm);
928 int pm_send_set_resources(struct packet_manager *pm,
929 				struct scheduling_resources *res);
930 int pm_send_runlist(struct packet_manager *pm, struct list_head *dqm_queues);
931 int pm_send_query_status(struct packet_manager *pm, uint64_t fence_address,
932 				uint32_t fence_value);
933 
934 int pm_send_unmap_queue(struct packet_manager *pm, enum kfd_queue_type type,
935 			enum kfd_unmap_queues_filter mode,
936 			uint32_t filter_param, bool reset,
937 			unsigned int sdma_engine);
938 
939 void pm_release_ib(struct packet_manager *pm);
940 
941 /* Following PM funcs can be shared among VI and AI */
942 unsigned int pm_build_pm4_header(unsigned int opcode, size_t packet_size);
943 int pm_set_resources_vi(struct packet_manager *pm, uint32_t *buffer,
944 				struct scheduling_resources *res);
945 
946 uint64_t kfd_get_number_elems(struct kfd_dev *kfd);
947 
948 /* Events */
949 extern const struct kfd_event_interrupt_class event_interrupt_class_cik;
950 extern const struct kfd_event_interrupt_class event_interrupt_class_v9;
951 
952 extern const struct kfd_device_global_init_class device_global_init_class_cik;
953 
954 void kfd_event_init_process(struct kfd_process *p);
955 void kfd_event_free_process(struct kfd_process *p);
956 int kfd_event_mmap(struct kfd_process *process, struct vm_area_struct *vma);
957 int kfd_wait_on_events(struct kfd_process *p,
958 		       uint32_t num_events, void __user *data,
959 		       bool all, uint32_t user_timeout_ms,
960 		       uint32_t *wait_result);
961 void kfd_signal_event_interrupt(unsigned int pasid, uint32_t partial_id,
962 				uint32_t valid_id_bits);
963 void kfd_signal_iommu_event(struct kfd_dev *dev,
964 		unsigned int pasid, unsigned long address,
965 		bool is_write_requested, bool is_execute_requested);
966 void kfd_signal_hw_exception_event(unsigned int pasid);
967 int kfd_set_event(struct kfd_process *p, uint32_t event_id);
968 int kfd_reset_event(struct kfd_process *p, uint32_t event_id);
969 int kfd_event_page_set(struct kfd_process *p, void *kernel_address,
970 		       uint64_t size);
971 int kfd_event_create(struct file *devkfd, struct kfd_process *p,
972 		     uint32_t event_type, bool auto_reset, uint32_t node_id,
973 		     uint32_t *event_id, uint32_t *event_trigger_data,
974 		     uint64_t *event_page_offset, uint32_t *event_slot_index);
975 int kfd_event_destroy(struct kfd_process *p, uint32_t event_id);
976 
977 void kfd_signal_vm_fault_event(struct kfd_dev *dev, unsigned int pasid,
978 				struct kfd_vm_fault_info *info);
979 
980 void kfd_signal_reset_event(struct kfd_dev *dev);
981 
982 void kfd_flush_tlb(struct kfd_process_device *pdd);
983 
984 int dbgdev_wave_reset_wavefronts(struct kfd_dev *dev, struct kfd_process *p);
985 
986 bool kfd_is_locked(void);
987 
988 /* Debugfs */
989 #if defined(CONFIG_DEBUG_FS)
990 
991 void kfd_debugfs_init(void);
992 void kfd_debugfs_fini(void);
993 int kfd_debugfs_mqds_by_process(struct seq_file *m, void *data);
994 int pqm_debugfs_mqds(struct seq_file *m, void *data);
995 int kfd_debugfs_hqds_by_device(struct seq_file *m, void *data);
996 int dqm_debugfs_hqds(struct seq_file *m, void *data);
997 int kfd_debugfs_rls_by_device(struct seq_file *m, void *data);
998 int pm_debugfs_runlist(struct seq_file *m, void *data);
999 
1000 int kfd_debugfs_hang_hws(struct kfd_dev *dev);
1001 int pm_debugfs_hang_hws(struct packet_manager *pm);
1002 int dqm_debugfs_execute_queues(struct device_queue_manager *dqm);
1003 
1004 #else
1005 
1006 static inline void kfd_debugfs_init(void) {}
1007 static inline void kfd_debugfs_fini(void) {}
1008 
1009 #endif
1010 
1011 #endif
1012