1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
3 * Copyright 2014-2022 Advanced Micro Devices, Inc.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
25 #ifndef KFD_MQD_MANAGER_H_
26 #define KFD_MQD_MANAGER_H_
30 #define KFD_MAX_NUM_SE 8
31 #define KFD_MAX_NUM_SH_PER_SE 2
36 * @init_mqd: Allocates the mqd buffer on local gpu memory and initialize it.
38 * @load_mqd: Loads the mqd to a concrete hqd slot. Used only for no cp
41 * @update_mqd: Handles a update call for the MQD
43 * @destroy_mqd: Destroys the HQD slot and by that preempt the relevant queue.
44 * Used only for no cp scheduling.
46 * @free_mqd: Releases the mqd buffer from local gpu memory.
48 * @is_occupied: Checks if the relevant HQD slot is occupied.
50 * @get_wave_state: Retrieves context save state and optionally copies the
51 * control stack, if kept in the MQD, to the given userspace address.
53 * @mqd_mutex: Mqd manager mutex.
55 * @dev: The kfd device structure coupled with this module.
57 * MQD stands for Memory Queue Descriptor which represents the current queue
58 * state in the memory and initiate the HQD (Hardware Queue Descriptor) state.
59 * This structure is actually a base class for the different types of MQDs
60 * structures for the variant ASICs that should be supported in the future.
61 * This base class is also contains all the MQD specific operations.
62 * Another important thing to mention is that each queue has a MQD that keeps
63 * his state (or context) after each preemption or reassignment.
64 * Basically there are a instances of the mqd manager class per MQD type per
65 * ASIC. Currently the kfd driver supports only Kaveri so there are instances
66 * per KFD_MQD_TYPE for each device.
69 extern int pipe_priority_map[];
71 struct kfd_mem_obj* (*allocate_mqd)(struct kfd_node *kfd,
72 struct queue_properties *q);
74 void (*init_mqd)(struct mqd_manager *mm, void **mqd,
75 struct kfd_mem_obj *mqd_mem_obj, uint64_t *gart_addr,
76 struct queue_properties *q);
78 int (*load_mqd)(struct mqd_manager *mm, void *mqd,
79 uint32_t pipe_id, uint32_t queue_id,
80 struct queue_properties *p,
81 struct mm_struct *mms);
83 void (*update_mqd)(struct mqd_manager *mm, void *mqd,
84 struct queue_properties *q,
85 struct mqd_update_info *minfo);
87 int (*destroy_mqd)(struct mqd_manager *mm, void *mqd,
88 enum kfd_preempt_type type,
89 unsigned int timeout, uint32_t pipe_id,
92 void (*free_mqd)(struct mqd_manager *mm, void *mqd,
93 struct kfd_mem_obj *mqd_mem_obj);
95 bool (*is_occupied)(struct mqd_manager *mm, void *mqd,
96 uint64_t queue_address, uint32_t pipe_id,
99 int (*get_wave_state)(struct mqd_manager *mm, void *mqd,
100 struct queue_properties *q,
101 void __user *ctl_stack,
102 u32 *ctl_stack_used_size,
103 u32 *save_area_used_size);
105 void (*get_checkpoint_info)(struct mqd_manager *mm, void *mqd, uint32_t *ctl_stack_size);
107 void (*checkpoint_mqd)(struct mqd_manager *mm,
110 void *ctl_stack_dst);
112 void (*restore_mqd)(struct mqd_manager *mm, void **mqd,
113 struct kfd_mem_obj *mqd_mem_obj, uint64_t *gart_addr,
114 struct queue_properties *p,
116 const void *ctl_stack_src,
117 const u32 ctl_stack_size);
119 #if defined(CONFIG_DEBUG_FS)
120 int (*debugfs_show_mqd)(struct seq_file *m, void *data);
122 uint32_t (*read_doorbell_id)(void *mqd);
123 uint64_t (*mqd_stride)(struct mqd_manager *mm,
124 struct queue_properties *p);
126 struct mutex mqd_mutex;
127 struct kfd_node *dev;
131 struct kfd_mem_obj *allocate_hiq_mqd(struct kfd_node *dev,
132 struct queue_properties *q);
134 struct kfd_mem_obj *allocate_sdma_mqd(struct kfd_node *dev,
135 struct queue_properties *q);
136 void free_mqd_hiq_sdma(struct mqd_manager *mm, void *mqd,
137 struct kfd_mem_obj *mqd_mem_obj);
139 void mqd_symmetrically_map_cu_mask(struct mqd_manager *mm,
140 const uint32_t *cu_mask, uint32_t cu_mask_count,
141 uint32_t *se_mask, uint32_t inst);
143 int kfd_hiq_load_mqd_kiq(struct mqd_manager *mm, void *mqd,
144 uint32_t pipe_id, uint32_t queue_id,
145 struct queue_properties *p, struct mm_struct *mms);
147 int kfd_destroy_mqd_cp(struct mqd_manager *mm, void *mqd,
148 enum kfd_preempt_type type, unsigned int timeout,
149 uint32_t pipe_id, uint32_t queue_id);
151 void kfd_free_mqd_cp(struct mqd_manager *mm, void *mqd,
152 struct kfd_mem_obj *mqd_mem_obj);
154 bool kfd_is_occupied_cp(struct mqd_manager *mm, void *mqd,
155 uint64_t queue_address, uint32_t pipe_id,
158 int kfd_load_mqd_sdma(struct mqd_manager *mm, void *mqd,
159 uint32_t pipe_id, uint32_t queue_id,
160 struct queue_properties *p, struct mm_struct *mms);
162 int kfd_destroy_mqd_sdma(struct mqd_manager *mm, void *mqd,
163 enum kfd_preempt_type type, unsigned int timeout,
164 uint32_t pipe_id, uint32_t queue_id);
166 bool kfd_is_occupied_sdma(struct mqd_manager *mm, void *mqd,
167 uint64_t queue_address, uint32_t pipe_id,
170 void kfd_get_hiq_xcc_mqd(struct kfd_node *dev,
171 struct kfd_mem_obj *mqd_mem_obj, uint32_t virtual_xcc_id);
173 uint64_t kfd_hiq_mqd_stride(struct kfd_node *dev);
174 uint64_t kfd_mqd_stride(struct mqd_manager *mm,
175 struct queue_properties *q);
176 #endif /* KFD_MQD_MANAGER_H_ */