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 * This file defines the private interface between the
25 * AMD kernel graphics drivers and the AMD KFD.
28 #ifndef KGD_KFD_INTERFACE_H_INCLUDED
29 #define KGD_KFD_INTERFACE_H_INCLUDED
31 #include <linux/types.h>
32 #include <linux/bitmap.h>
33 #include <linux/dma-fence.h>
37 #define KGD_MAX_QUEUES 128
44 enum kfd_preempt_type {
45 KFD_PREEMPT_TYPE_WAVEFRONT_DRAIN = 0,
46 KFD_PREEMPT_TYPE_WAVEFRONT_RESET,
49 struct kfd_vm_fault_info {
61 uint32_t num_shader_engines;
62 uint32_t num_shader_arrays_per_engine;
63 uint32_t num_cu_per_sh;
64 uint32_t cu_active_number;
67 uint32_t max_waves_per_simd;
68 uint32_t wave_front_size;
69 uint32_t max_scratch_slots_per_cu;
71 uint32_t cu_bitmap[4][4];
74 /* For getting GPU local memory information from KGD */
75 struct kfd_local_mem_info {
76 uint64_t local_mem_size_private;
77 uint64_t local_mem_size_public;
82 enum kgd_memory_pool {
83 KGD_POOL_SYSTEM_CACHEABLE = 1,
84 KGD_POOL_SYSTEM_WRITECOMBINE = 2,
85 KGD_POOL_FRAMEBUFFER = 3,
89 * enum kfd_sched_policy
91 * @KFD_SCHED_POLICY_HWS: H/W scheduling policy known as command processor (cp)
92 * scheduling. In this scheduling mode we're using the firmware code to
93 * schedule the user mode queues and kernel queues such as HIQ and DIQ.
94 * the HIQ queue is used as a special queue that dispatches the configuration
95 * to the cp and the user mode queues list that are currently running.
96 * the DIQ queue is a debugging queue that dispatches debugging commands to the
98 * in this scheduling mode user mode queues over subscription feature is
101 * @KFD_SCHED_POLICY_HWS_NO_OVERSUBSCRIPTION: The same as above but the over
102 * subscription feature disabled.
104 * @KFD_SCHED_POLICY_NO_HWS: no H/W scheduling policy is a mode which directly
105 * set the command processor registers and sets the queues "manually". This
106 * mode is used *ONLY* for debugging proposes.
109 enum kfd_sched_policy {
110 KFD_SCHED_POLICY_HWS = 0,
111 KFD_SCHED_POLICY_HWS_NO_OVERSUBSCRIPTION,
112 KFD_SCHED_POLICY_NO_HWS
115 struct kgd2kfd_shared_resources {
116 /* Bit n == 1 means VMID n is available for KFD. */
117 unsigned int compute_vmid_bitmap;
119 /* number of pipes per mec */
120 uint32_t num_pipe_per_mec;
122 /* number of queues per pipe */
123 uint32_t num_queue_per_pipe;
125 /* Bit n == 1 means Queue n is available for KFD */
126 DECLARE_BITMAP(cp_queue_bitmap, KGD_MAX_QUEUES);
128 /* SDMA doorbell assignments (SOC15 and later chips only). Only
129 * specific doorbells are routed to each SDMA engine. Others
130 * are routed to IH and VCN. They are not usable by the CP.
132 uint32_t *sdma_doorbell_idx;
134 /* From SOC15 onward, the doorbell index range not usable for CP
137 uint32_t non_cp_doorbells_start;
138 uint32_t non_cp_doorbells_end;
140 /* Base address of doorbell aperture. */
141 phys_addr_t doorbell_physical_address;
143 /* Size in bytes of doorbell aperture. */
144 size_t doorbell_aperture_size;
146 /* Number of bytes at start of aperture reserved for KGD. */
147 size_t doorbell_start_offset;
149 /* GPUVM address space size in bytes */
152 /* Minor device number of the render node */
153 int drm_render_minor;
158 uint32_t *tile_config_ptr;
159 uint32_t *macro_tile_config_ptr;
160 uint32_t num_tile_configs;
161 uint32_t num_macro_tile_configs;
163 uint32_t gb_addr_config;
168 #define KFD_MAX_NUM_OF_QUEUES_PER_DEVICE_DEFAULT 4096
171 * struct kfd2kgd_calls
173 * @program_sh_mem_settings: A function that should initiate the memory
174 * properties such as main aperture memory type (cache / non cached) and
175 * secondary aperture base address, size and memory type.
176 * This function is used only for no cp scheduling mode.
178 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
179 * scheduling mode. Only used for no cp scheduling mode.
181 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
184 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
185 * used only for no HWS mode.
187 * @hqd_dump: Dumps CPC HQD registers to an array of address-value pairs.
188 * Array is allocated with kmalloc, needs to be freed with kfree by caller.
190 * @hqd_sdma_dump: Dumps SDMA HQD registers to an array of address-value pairs.
191 * Array is allocated with kmalloc, needs to be freed with kfree by caller.
193 * @hqd_is_occupies: Checks if a hqd slot is occupied.
195 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
197 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
199 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
202 * @set_scratch_backing_va: Sets VA for scratch backing memory of a VMID.
203 * Only used for no cp scheduling mode
205 * @set_vm_context_page_table_base: Program page table base for a VMID
207 * @invalidate_tlbs: Invalidate TLBs for a specific PASID
209 * @invalidate_tlbs_vmid: Invalidate TLBs for a specific VMID
211 * @read_vmid_from_vmfault_reg: On Hawaii the VMID is not set in the
212 * IH ring entry. This function allows the KFD ISR to get the VMID
213 * from the fault status register as early as possible.
215 * @get_hive_id: Returns hive id of current device, 0 if xgmi is not enabled
217 * This structure contains function pointers to services that the kgd driver
218 * provides to amdkfd driver.
221 struct kfd2kgd_calls {
222 /* Register access functions */
223 void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid,
224 uint32_t sh_mem_config, uint32_t sh_mem_ape1_base,
225 uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases);
227 int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid,
230 int (*init_interrupts)(struct kgd_dev *kgd, uint32_t pipe_id);
232 int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id,
233 uint32_t queue_id, uint32_t __user *wptr,
234 uint32_t wptr_shift, uint32_t wptr_mask,
235 struct mm_struct *mm);
237 int (*hiq_mqd_load)(struct kgd_dev *kgd, void *mqd,
238 uint32_t pipe_id, uint32_t queue_id,
239 uint32_t doorbell_off);
241 int (*hqd_sdma_load)(struct kgd_dev *kgd, void *mqd,
242 uint32_t __user *wptr, struct mm_struct *mm);
244 int (*hqd_dump)(struct kgd_dev *kgd,
245 uint32_t pipe_id, uint32_t queue_id,
246 uint32_t (**dump)[2], uint32_t *n_regs);
248 int (*hqd_sdma_dump)(struct kgd_dev *kgd,
249 uint32_t engine_id, uint32_t queue_id,
250 uint32_t (**dump)[2], uint32_t *n_regs);
252 bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address,
253 uint32_t pipe_id, uint32_t queue_id);
255 int (*hqd_destroy)(struct kgd_dev *kgd, void *mqd, uint32_t reset_type,
256 unsigned int timeout, uint32_t pipe_id,
259 bool (*hqd_sdma_is_occupied)(struct kgd_dev *kgd, void *mqd);
261 int (*hqd_sdma_destroy)(struct kgd_dev *kgd, void *mqd,
262 unsigned int timeout);
264 int (*address_watch_disable)(struct kgd_dev *kgd);
265 int (*address_watch_execute)(struct kgd_dev *kgd,
266 unsigned int watch_point_id,
270 int (*wave_control_execute)(struct kgd_dev *kgd,
271 uint32_t gfx_index_val,
273 uint32_t (*address_watch_get_offset)(struct kgd_dev *kgd,
274 unsigned int watch_point_id,
275 unsigned int reg_offset);
276 bool (*get_atc_vmid_pasid_mapping_info)(
281 /* No longer needed from GFXv9 onward. The scratch base address is
282 * passed to the shader by the CP. It's the user mode driver's
285 void (*set_scratch_backing_va)(struct kgd_dev *kgd,
286 uint64_t va, uint32_t vmid);
288 void (*set_vm_context_page_table_base)(struct kgd_dev *kgd,
289 uint32_t vmid, uint64_t page_table_base);
290 uint32_t (*read_vmid_from_vmfault_reg)(struct kgd_dev *kgd);
291 uint64_t (*get_hive_id)(struct kgd_dev *kgd);
294 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */