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 33 struct pci_dev; 34 35 #define KFD_INTERFACE_VERSION 1 36 37 struct kfd_dev; 38 struct kgd_dev; 39 40 struct kgd_mem; 41 42 enum kgd_memory_pool { 43 KGD_POOL_SYSTEM_CACHEABLE = 1, 44 KGD_POOL_SYSTEM_WRITECOMBINE = 2, 45 KGD_POOL_FRAMEBUFFER = 3, 46 }; 47 48 enum kgd_engine_type { 49 KGD_ENGINE_PFP = 1, 50 KGD_ENGINE_ME, 51 KGD_ENGINE_CE, 52 KGD_ENGINE_MEC1, 53 KGD_ENGINE_MEC2, 54 KGD_ENGINE_RLC, 55 KGD_ENGINE_SDMA, 56 KGD_ENGINE_MAX 57 }; 58 59 struct kgd2kfd_shared_resources { 60 /* Bit n == 1 means VMID n is available for KFD. */ 61 unsigned int compute_vmid_bitmap; 62 63 /* Compute pipes are counted starting from MEC0/pipe0 as 0. */ 64 unsigned int first_compute_pipe; 65 66 /* Number of MEC pipes available for KFD. */ 67 unsigned int compute_pipe_count; 68 69 /* Base address of doorbell aperture. */ 70 phys_addr_t doorbell_physical_address; 71 72 /* Size in bytes of doorbell aperture. */ 73 size_t doorbell_aperture_size; 74 75 /* Number of bytes at start of aperture reserved for KGD. */ 76 size_t doorbell_start_offset; 77 }; 78 79 /** 80 * struct kgd2kfd_calls 81 * 82 * @exit: Notifies amdkfd that kgd module is unloaded 83 * 84 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver. 85 * 86 * @device_init: Initialize the newly probed device (if it is a device that 87 * amdkfd supports) 88 * 89 * @device_exit: Notifies amdkfd about a removal of a kgd device 90 * 91 * @suspend: Notifies amdkfd about a suspend action done to a kgd device 92 * 93 * @resume: Notifies amdkfd about a resume action done to a kgd device 94 * 95 * This structure contains function callback pointers so the kgd driver 96 * will notify to the amdkfd about certain status changes. 97 * 98 */ 99 struct kgd2kfd_calls { 100 void (*exit)(void); 101 struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev); 102 bool (*device_init)(struct kfd_dev *kfd, 103 const struct kgd2kfd_shared_resources *gpu_resources); 104 void (*device_exit)(struct kfd_dev *kfd); 105 void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry); 106 void (*suspend)(struct kfd_dev *kfd); 107 int (*resume)(struct kfd_dev *kfd); 108 }; 109 110 /** 111 * struct kfd2kgd_calls 112 * 113 * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture. 114 * The buffer can be used for mqds, hpds, kernel queue, fence and runlists 115 * 116 * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture 117 * 118 * @get_vmem_size: Retrieves (physical) size of VRAM 119 * 120 * @get_gpu_clock_counter: Retrieves GPU clock counter 121 * 122 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz 123 * 124 * @program_sh_mem_settings: A function that should initiate the memory 125 * properties such as main aperture memory type (cache / non cached) and 126 * secondary aperture base address, size and memory type. 127 * This function is used only for no cp scheduling mode. 128 * 129 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp 130 * scheduling mode. Only used for no cp scheduling mode. 131 * 132 * @init_pipeline: Initialized the compute pipelines. 133 * 134 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp 135 * sceduling mode. 136 * 137 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot. 138 * used only for no HWS mode. 139 * 140 * @hqd_is_occupies: Checks if a hqd slot is occupied. 141 * 142 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot. 143 * 144 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied. 145 * 146 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that 147 * SDMA hqd slot. 148 * 149 * @get_fw_version: Returns FW versions from the header 150 * 151 * This structure contains function pointers to services that the kgd driver 152 * provides to amdkfd driver. 153 * 154 */ 155 struct kfd2kgd_calls { 156 int (*init_gtt_mem_allocation)(struct kgd_dev *kgd, size_t size, 157 void **mem_obj, uint64_t *gpu_addr, 158 void **cpu_ptr); 159 160 void (*free_gtt_mem)(struct kgd_dev *kgd, void *mem_obj); 161 162 uint64_t (*get_vmem_size)(struct kgd_dev *kgd); 163 uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd); 164 165 uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd); 166 167 /* Register access functions */ 168 void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid, 169 uint32_t sh_mem_config, uint32_t sh_mem_ape1_base, 170 uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases); 171 172 int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid, 173 unsigned int vmid); 174 175 int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id, 176 uint32_t hpd_size, uint64_t hpd_gpu_addr); 177 178 int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id, 179 uint32_t queue_id, uint32_t __user *wptr); 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, 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 uint16_t (*get_fw_version)(struct kgd_dev *kgd, 196 enum kgd_engine_type type); 197 }; 198 199 bool kgd2kfd_init(unsigned interface_version, 200 const struct kfd2kgd_calls *f2g, 201 const struct kgd2kfd_calls **g2f); 202 203 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */ 204