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