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>
36 #define KFD_INTERFACE_VERSION 2
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 enum kgd_memory_pool
{
50 KGD_POOL_SYSTEM_CACHEABLE
= 1,
51 KGD_POOL_SYSTEM_WRITECOMBINE
= 2,
52 KGD_POOL_FRAMEBUFFER
= 3,
55 enum kgd_engine_type
{
67 struct kgd2kfd_shared_resources
{
68 /* Bit n == 1 means VMID n is available for KFD. */
69 unsigned int compute_vmid_bitmap
;
71 /* number of pipes per mec */
72 uint32_t num_pipe_per_mec
;
74 /* number of queues per pipe */
75 uint32_t num_queue_per_pipe
;
77 /* Bit n == 1 means Queue n is available for KFD */
78 DECLARE_BITMAP(queue_bitmap
, KGD_MAX_QUEUES
);
80 /* Base address of doorbell aperture. */
81 phys_addr_t doorbell_physical_address
;
83 /* Size in bytes of doorbell aperture. */
84 size_t doorbell_aperture_size
;
86 /* Number of bytes at start of aperture reserved for KGD. */
87 size_t doorbell_start_offset
;
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
;
96 uint32_t gb_addr_config
;
102 * struct kfd2kgd_calls
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
107 * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture
109 * @get_vmem_size: Retrieves (physical) size of VRAM
111 * @get_gpu_clock_counter: Retrieves GPU clock counter
113 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
115 * @alloc_pasid: Allocate a PASID
116 * @free_pasid: Free a PASID
118 * @program_sh_mem_settings: A function that should initiate the memory
119 * properties such as main aperture memory type (cache / non cached) and
120 * secondary aperture base address, size and memory type.
121 * This function is used only for no cp scheduling mode.
123 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
124 * scheduling mode. Only used for no cp scheduling mode.
126 * @init_pipeline: Initialized the compute pipelines.
128 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
131 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
132 * used only for no HWS mode.
134 * @hqd_is_occupies: Checks if a hqd slot is occupied.
136 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
138 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
140 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
143 * @get_fw_version: Returns FW versions from the header
145 * @set_scratch_backing_va: Sets VA for scratch backing memory of a VMID.
146 * Only used for no cp scheduling mode
148 * @get_tile_config: Returns GPU-specific tiling mode information
150 * This structure contains function pointers to services that the kgd driver
151 * provides to amdkfd driver.
154 struct kfd2kgd_calls
{
155 int (*init_gtt_mem_allocation
)(struct kgd_dev
*kgd
, size_t size
,
156 void **mem_obj
, uint64_t *gpu_addr
,
159 void (*free_gtt_mem
)(struct kgd_dev
*kgd
, void *mem_obj
);
161 uint64_t (*get_vmem_size
)(struct kgd_dev
*kgd
);
162 uint64_t (*get_gpu_clock_counter
)(struct kgd_dev
*kgd
);
164 uint32_t (*get_max_engine_clock_in_mhz
)(struct kgd_dev
*kgd
);
166 int (*alloc_pasid
)(unsigned int bits
);
167 void (*free_pasid
)(unsigned int pasid
);
169 /* Register access functions */
170 void (*program_sh_mem_settings
)(struct kgd_dev
*kgd
, uint32_t vmid
,
171 uint32_t sh_mem_config
, uint32_t sh_mem_ape1_base
,
172 uint32_t sh_mem_ape1_limit
, uint32_t sh_mem_bases
);
174 int (*set_pasid_vmid_mapping
)(struct kgd_dev
*kgd
, unsigned int pasid
,
177 int (*init_pipeline
)(struct kgd_dev
*kgd
, uint32_t pipe_id
,
178 uint32_t hpd_size
, uint64_t hpd_gpu_addr
);
180 int (*init_interrupts
)(struct kgd_dev
*kgd
, uint32_t pipe_id
);
182 int (*hqd_load
)(struct kgd_dev
*kgd
, void *mqd
, uint32_t pipe_id
,
183 uint32_t queue_id
, uint32_t __user
*wptr
,
184 uint32_t wptr_shift
, uint32_t wptr_mask
,
185 struct mm_struct
*mm
);
187 int (*hqd_sdma_load
)(struct kgd_dev
*kgd
, void *mqd
);
189 bool (*hqd_is_occupied
)(struct kgd_dev
*kgd
, uint64_t queue_address
,
190 uint32_t pipe_id
, uint32_t queue_id
);
192 int (*hqd_destroy
)(struct kgd_dev
*kgd
, void *mqd
, uint32_t reset_type
,
193 unsigned int timeout
, uint32_t pipe_id
,
196 bool (*hqd_sdma_is_occupied
)(struct kgd_dev
*kgd
, void *mqd
);
198 int (*hqd_sdma_destroy
)(struct kgd_dev
*kgd
, void *mqd
,
199 unsigned int timeout
);
201 int (*address_watch_disable
)(struct kgd_dev
*kgd
);
202 int (*address_watch_execute
)(struct kgd_dev
*kgd
,
203 unsigned int watch_point_id
,
207 int (*wave_control_execute
)(struct kgd_dev
*kgd
,
208 uint32_t gfx_index_val
,
210 uint32_t (*address_watch_get_offset
)(struct kgd_dev
*kgd
,
211 unsigned int watch_point_id
,
212 unsigned int reg_offset
);
213 bool (*get_atc_vmid_pasid_mapping_valid
)(
216 uint16_t (*get_atc_vmid_pasid_mapping_pasid
)(
219 void (*write_vmid_invalidate_request
)(struct kgd_dev
*kgd
,
222 uint16_t (*get_fw_version
)(struct kgd_dev
*kgd
,
223 enum kgd_engine_type type
);
224 void (*set_scratch_backing_va
)(struct kgd_dev
*kgd
,
225 uint64_t va
, uint32_t vmid
);
226 int (*get_tile_config
)(struct kgd_dev
*kgd
, struct tile_config
*config
);
230 * struct kgd2kfd_calls
232 * @exit: Notifies amdkfd that kgd module is unloaded
234 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
236 * @device_init: Initialize the newly probed device (if it is a device that
239 * @device_exit: Notifies amdkfd about a removal of a kgd device
241 * @suspend: Notifies amdkfd about a suspend action done to a kgd device
243 * @resume: Notifies amdkfd about a resume action done to a kgd device
245 * This structure contains function callback pointers so the kgd driver
246 * will notify to the amdkfd about certain status changes.
249 struct kgd2kfd_calls
{
251 struct kfd_dev
* (*probe
)(struct kgd_dev
*kgd
, struct pci_dev
*pdev
,
252 const struct kfd2kgd_calls
*f2g
);
253 bool (*device_init
)(struct kfd_dev
*kfd
,
254 const struct kgd2kfd_shared_resources
*gpu_resources
);
255 void (*device_exit
)(struct kfd_dev
*kfd
);
256 void (*interrupt
)(struct kfd_dev
*kfd
, const void *ih_ring_entry
);
257 void (*suspend
)(struct kfd_dev
*kfd
);
258 int (*resume
)(struct kfd_dev
*kfd
);
261 int kgd2kfd_init(unsigned interface_version
,
262 const struct kgd2kfd_calls
**g2f
);
264 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */