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 * This file defines the private interface between the 25 * AMD kernel graphics drivers and the AMD KFD. 26 */ 27 28 #ifndef KGD_KFD_INTERFACE_H_INCLUDED 29 #define KGD_KFD_INTERFACE_H_INCLUDED 30 31 #include <linux/types.h> 32 #include <linux/bitmap.h> 33 34 struct pci_dev; 35 36 #define KFD_INTERFACE_VERSION 2 37 #define KGD_MAX_QUEUES 128 38 39 struct kfd_dev; 40 struct kgd_dev; 41 42 struct kgd_mem; 43 44 enum kfd_preempt_type { 45 KFD_PREEMPT_TYPE_WAVEFRONT_DRAIN = 0, 46 KFD_PREEMPT_TYPE_WAVEFRONT_RESET, 47 }; 48 49 enum kgd_memory_pool { 50 KGD_POOL_SYSTEM_CACHEABLE = 1, 51 KGD_POOL_SYSTEM_WRITECOMBINE = 2, 52 KGD_POOL_FRAMEBUFFER = 3, 53 }; 54 55 enum kgd_engine_type { 56 KGD_ENGINE_PFP = 1, 57 KGD_ENGINE_ME, 58 KGD_ENGINE_CE, 59 KGD_ENGINE_MEC1, 60 KGD_ENGINE_MEC2, 61 KGD_ENGINE_RLC, 62 KGD_ENGINE_SDMA1, 63 KGD_ENGINE_SDMA2, 64 KGD_ENGINE_MAX 65 }; 66 67 struct kgd2kfd_shared_resources { 68 /* Bit n == 1 means VMID n is available for KFD. */ 69 unsigned int compute_vmid_bitmap; 70 71 /* number of pipes per mec */ 72 uint32_t num_pipe_per_mec; 73 74 /* number of queues per pipe */ 75 uint32_t num_queue_per_pipe; 76 77 /* Bit n == 1 means Queue n is available for KFD */ 78 DECLARE_BITMAP(queue_bitmap, KGD_MAX_QUEUES); 79 80 /* Base address of doorbell aperture. */ 81 phys_addr_t doorbell_physical_address; 82 83 /* Size in bytes of doorbell aperture. */ 84 size_t doorbell_aperture_size; 85 86 /* Number of bytes at start of aperture reserved for KGD. */ 87 size_t doorbell_start_offset; 88 }; 89 90 struct tile_config { 91 uint32_t *tile_config_ptr; 92 uint32_t *macro_tile_config_ptr; 93 uint32_t num_tile_configs; 94 uint32_t num_macro_tile_configs; 95 96 uint32_t gb_addr_config; 97 uint32_t num_banks; 98 uint32_t num_ranks; 99 }; 100 101 /** 102 * struct kfd2kgd_calls 103 * 104 * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture. 105 * The buffer can be used for mqds, hpds, kernel queue, fence and runlists 106 * 107 * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture 108 * 109 * @get_vmem_size: Retrieves (physical) size of VRAM 110 * 111 * @get_gpu_clock_counter: Retrieves GPU clock counter 112 * 113 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz 114 * 115 * @program_sh_mem_settings: A function that should initiate the memory 116 * properties such as main aperture memory type (cache / non cached) and 117 * secondary aperture base address, size and memory type. 118 * This function is used only for no cp scheduling mode. 119 * 120 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp 121 * scheduling mode. Only used for no cp scheduling mode. 122 * 123 * @init_pipeline: Initialized the compute pipelines. 124 * 125 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp 126 * sceduling mode. 127 * 128 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot. 129 * used only for no HWS mode. 130 * 131 * @hqd_is_occupies: Checks if a hqd slot is occupied. 132 * 133 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot. 134 * 135 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied. 136 * 137 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that 138 * SDMA hqd slot. 139 * 140 * @get_fw_version: Returns FW versions from the header 141 * 142 * @set_scratch_backing_va: Sets VA for scratch backing memory of a VMID. 143 * Only used for no cp scheduling mode 144 * 145 * @get_tile_config: Returns GPU-specific tiling mode information 146 * 147 * This structure contains function pointers to services that the kgd driver 148 * provides to amdkfd driver. 149 * 150 */ 151 struct kfd2kgd_calls { 152 int (*init_gtt_mem_allocation)(struct kgd_dev *kgd, size_t size, 153 void **mem_obj, uint64_t *gpu_addr, 154 void **cpu_ptr); 155 156 void (*free_gtt_mem)(struct kgd_dev *kgd, void *mem_obj); 157 158 uint64_t (*get_vmem_size)(struct kgd_dev *kgd); 159 uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd); 160 161 uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd); 162 163 /* Register access functions */ 164 void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid, 165 uint32_t sh_mem_config, uint32_t sh_mem_ape1_base, 166 uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases); 167 168 int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid, 169 unsigned int vmid); 170 171 int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id, 172 uint32_t hpd_size, uint64_t hpd_gpu_addr); 173 174 int (*init_interrupts)(struct kgd_dev *kgd, uint32_t pipe_id); 175 176 int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id, 177 uint32_t queue_id, uint32_t __user *wptr, 178 uint32_t wptr_shift, uint32_t wptr_mask, 179 struct mm_struct *mm); 180 181 int (*hqd_sdma_load)(struct kgd_dev *kgd, void *mqd); 182 183 bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address, 184 uint32_t pipe_id, uint32_t queue_id); 185 186 int (*hqd_destroy)(struct kgd_dev *kgd, void *mqd, uint32_t reset_type, 187 unsigned int timeout, uint32_t pipe_id, 188 uint32_t queue_id); 189 190 bool (*hqd_sdma_is_occupied)(struct kgd_dev *kgd, void *mqd); 191 192 int (*hqd_sdma_destroy)(struct kgd_dev *kgd, void *mqd, 193 unsigned int timeout); 194 195 int (*address_watch_disable)(struct kgd_dev *kgd); 196 int (*address_watch_execute)(struct kgd_dev *kgd, 197 unsigned int watch_point_id, 198 uint32_t cntl_val, 199 uint32_t addr_hi, 200 uint32_t addr_lo); 201 int (*wave_control_execute)(struct kgd_dev *kgd, 202 uint32_t gfx_index_val, 203 uint32_t sq_cmd); 204 uint32_t (*address_watch_get_offset)(struct kgd_dev *kgd, 205 unsigned int watch_point_id, 206 unsigned int reg_offset); 207 bool (*get_atc_vmid_pasid_mapping_valid)( 208 struct kgd_dev *kgd, 209 uint8_t vmid); 210 uint16_t (*get_atc_vmid_pasid_mapping_pasid)( 211 struct kgd_dev *kgd, 212 uint8_t vmid); 213 void (*write_vmid_invalidate_request)(struct kgd_dev *kgd, 214 uint8_t vmid); 215 216 uint16_t (*get_fw_version)(struct kgd_dev *kgd, 217 enum kgd_engine_type type); 218 void (*set_scratch_backing_va)(struct kgd_dev *kgd, 219 uint64_t va, uint32_t vmid); 220 int (*get_tile_config)(struct kgd_dev *kgd, struct tile_config *config); 221 }; 222 223 /** 224 * struct kgd2kfd_calls 225 * 226 * @exit: Notifies amdkfd that kgd module is unloaded 227 * 228 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver. 229 * 230 * @device_init: Initialize the newly probed device (if it is a device that 231 * amdkfd supports) 232 * 233 * @device_exit: Notifies amdkfd about a removal of a kgd device 234 * 235 * @suspend: Notifies amdkfd about a suspend action done to a kgd device 236 * 237 * @resume: Notifies amdkfd about a resume action done to a kgd device 238 * 239 * This structure contains function callback pointers so the kgd driver 240 * will notify to the amdkfd about certain status changes. 241 * 242 */ 243 struct kgd2kfd_calls { 244 void (*exit)(void); 245 struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev, 246 const struct kfd2kgd_calls *f2g); 247 bool (*device_init)(struct kfd_dev *kfd, 248 const struct kgd2kfd_shared_resources *gpu_resources); 249 void (*device_exit)(struct kfd_dev *kfd); 250 void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry); 251 void (*suspend)(struct kfd_dev *kfd); 252 int (*resume)(struct kfd_dev *kfd); 253 }; 254 255 int kgd2kfd_init(unsigned interface_version, 256 const struct kgd2kfd_calls **g2f); 257 258 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */ 259