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 struct kgd2kfd_shared_resources { 49 /* Bit n == 1 means VMID n is available for KFD. */ 50 unsigned int compute_vmid_bitmap; 51 52 /* Compute pipes are counted starting from MEC0/pipe0 as 0. */ 53 unsigned int first_compute_pipe; 54 55 /* Number of MEC pipes available for KFD. */ 56 unsigned int compute_pipe_count; 57 58 /* Base address of doorbell aperture. */ 59 phys_addr_t doorbell_physical_address; 60 61 /* Size in bytes of doorbell aperture. */ 62 size_t doorbell_aperture_size; 63 64 /* Number of bytes at start of aperture reserved for KGD. */ 65 size_t doorbell_start_offset; 66 }; 67 68 /** 69 * struct kgd2kfd_calls 70 * 71 * @exit: Notifies amdkfd that kgd module is unloaded 72 * 73 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver. 74 * 75 * @device_init: Initialize the newly probed device (if it is a device that 76 * amdkfd supports) 77 * 78 * @device_exit: Notifies amdkfd about a removal of a kgd device 79 * 80 * @suspend: Notifies amdkfd about a suspend action done to a kgd device 81 * 82 * @resume: Notifies amdkfd about a resume action done to a kgd device 83 * 84 * This structure contains function callback pointers so the kgd driver 85 * will notify to the amdkfd about certain status changes. 86 * 87 */ 88 struct kgd2kfd_calls { 89 void (*exit)(void); 90 struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev); 91 bool (*device_init)(struct kfd_dev *kfd, 92 const struct kgd2kfd_shared_resources *gpu_resources); 93 void (*device_exit)(struct kfd_dev *kfd); 94 void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry); 95 void (*suspend)(struct kfd_dev *kfd); 96 int (*resume)(struct kfd_dev *kfd); 97 }; 98 99 /** 100 * struct kfd2kgd_calls 101 * 102 * @init_sa_manager: Initialize an instance of the sa manager, used by 103 * amdkfd for all system memory allocations that are mapped to the GART 104 * address space 105 * 106 * @fini_sa_manager: Releases all memory allocations for amdkfd that are 107 * handled by kgd sa manager 108 * 109 * @allocate_mem: Allocate a buffer from amdkfd's sa manager. The buffer can 110 * be used for mqds, hpds, kernel queue, fence and runlists 111 * 112 * @free_mem: Frees a buffer that was allocated by amdkfd's sa manager 113 * 114 * @get_vmem_size: Retrieves (physical) size of VRAM 115 * 116 * @get_gpu_clock_counter: Retrieves GPU clock counter 117 * 118 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz 119 * 120 * @program_sh_mem_settings: A function that should initiate the memory 121 * properties such as main aperture memory type (cache / non cached) and 122 * secondary aperture base address, size and memory type. 123 * This function is used only for no cp scheduling mode. 124 * 125 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp 126 * scheduling mode. Only used for no cp scheduling mode. 127 * 128 * @init_memory: Initializes memory apertures to fixed base/limit address 129 * and non cached memory types. 130 * 131 * @init_pipeline: Initialized the compute pipelines. 132 * 133 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp 134 * sceduling mode. 135 * 136 * @hqd_is_occupies: Checks if a hqd slot is occupied. 137 * 138 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot. 139 * 140 * This structure contains function pointers to services that the kgd driver 141 * provides to amdkfd driver. 142 * 143 */ 144 struct kfd2kgd_calls { 145 /* Memory management. */ 146 int (*init_sa_manager)(struct kgd_dev *kgd, unsigned int size); 147 void (*fini_sa_manager)(struct kgd_dev *kgd); 148 int (*allocate_mem)(struct kgd_dev *kgd, size_t size, size_t alignment, 149 enum kgd_memory_pool pool, struct kgd_mem **mem); 150 151 void (*free_mem)(struct kgd_dev *kgd, struct kgd_mem *mem); 152 153 uint64_t (*get_vmem_size)(struct kgd_dev *kgd); 154 uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd); 155 156 uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd); 157 158 /* Register access functions */ 159 void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid, 160 uint32_t sh_mem_config, uint32_t sh_mem_ape1_base, 161 uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases); 162 163 int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid, 164 unsigned int vmid); 165 166 int (*init_memory)(struct kgd_dev *kgd); 167 int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id, 168 uint32_t hpd_size, uint64_t hpd_gpu_addr); 169 170 int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id, 171 uint32_t queue_id, uint32_t __user *wptr); 172 173 bool (*hqd_is_occupies)(struct kgd_dev *kgd, uint64_t queue_address, 174 uint32_t pipe_id, uint32_t queue_id); 175 176 int (*hqd_destroy)(struct kgd_dev *kgd, uint32_t reset_type, 177 unsigned int timeout, uint32_t pipe_id, 178 uint32_t queue_id); 179 }; 180 181 bool kgd2kfd_init(unsigned interface_version, 182 const struct kfd2kgd_calls *f2g, 183 const struct kgd2kfd_calls **g2f); 184 185 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */ 186