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 kgd_memory_pool
{
45 KGD_POOL_SYSTEM_CACHEABLE
= 1,
46 KGD_POOL_SYSTEM_WRITECOMBINE
= 2,
47 KGD_POOL_FRAMEBUFFER
= 3,
50 enum kgd_engine_type
{
62 struct kgd2kfd_shared_resources
{
63 /* Bit n == 1 means VMID n is available for KFD. */
64 unsigned int compute_vmid_bitmap
;
66 /* number of pipes per mec */
67 uint32_t num_pipe_per_mec
;
69 /* number of queues per pipe */
70 uint32_t num_queue_per_pipe
;
72 /* Bit n == 1 means Queue n is available for KFD */
73 DECLARE_BITMAP(queue_bitmap
, KGD_MAX_QUEUES
);
75 /* Base address of doorbell aperture. */
76 phys_addr_t doorbell_physical_address
;
78 /* Size in bytes of doorbell aperture. */
79 size_t doorbell_aperture_size
;
81 /* Number of bytes at start of aperture reserved for KGD. */
82 size_t doorbell_start_offset
;
86 * struct kfd2kgd_calls
88 * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture.
89 * The buffer can be used for mqds, hpds, kernel queue, fence and runlists
91 * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture
93 * @get_vmem_size: Retrieves (physical) size of VRAM
95 * @get_gpu_clock_counter: Retrieves GPU clock counter
97 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
99 * @program_sh_mem_settings: A function that should initiate the memory
100 * properties such as main aperture memory type (cache / non cached) and
101 * secondary aperture base address, size and memory type.
102 * This function is used only for no cp scheduling mode.
104 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
105 * scheduling mode. Only used for no cp scheduling mode.
107 * @init_pipeline: Initialized the compute pipelines.
109 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
112 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
113 * used only for no HWS mode.
115 * @hqd_is_occupies: Checks if a hqd slot is occupied.
117 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
119 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
121 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
124 * @get_fw_version: Returns FW versions from the header
126 * This structure contains function pointers to services that the kgd driver
127 * provides to amdkfd driver.
130 struct kfd2kgd_calls
{
131 int (*init_gtt_mem_allocation
)(struct kgd_dev
*kgd
, size_t size
,
132 void **mem_obj
, uint64_t *gpu_addr
,
135 void (*free_gtt_mem
)(struct kgd_dev
*kgd
, void *mem_obj
);
137 uint64_t (*get_vmem_size
)(struct kgd_dev
*kgd
);
138 uint64_t (*get_gpu_clock_counter
)(struct kgd_dev
*kgd
);
140 uint32_t (*get_max_engine_clock_in_mhz
)(struct kgd_dev
*kgd
);
142 /* Register access functions */
143 void (*program_sh_mem_settings
)(struct kgd_dev
*kgd
, uint32_t vmid
,
144 uint32_t sh_mem_config
, uint32_t sh_mem_ape1_base
,
145 uint32_t sh_mem_ape1_limit
, uint32_t sh_mem_bases
);
147 int (*set_pasid_vmid_mapping
)(struct kgd_dev
*kgd
, unsigned int pasid
,
150 int (*init_pipeline
)(struct kgd_dev
*kgd
, uint32_t pipe_id
,
151 uint32_t hpd_size
, uint64_t hpd_gpu_addr
);
153 int (*init_interrupts
)(struct kgd_dev
*kgd
, uint32_t pipe_id
);
155 int (*hqd_load
)(struct kgd_dev
*kgd
, void *mqd
, uint32_t pipe_id
,
156 uint32_t queue_id
, uint32_t __user
*wptr
);
158 int (*hqd_sdma_load
)(struct kgd_dev
*kgd
, void *mqd
);
160 bool (*hqd_is_occupied
)(struct kgd_dev
*kgd
, uint64_t queue_address
,
161 uint32_t pipe_id
, uint32_t queue_id
);
163 int (*hqd_destroy
)(struct kgd_dev
*kgd
, uint32_t reset_type
,
164 unsigned int timeout
, uint32_t pipe_id
,
167 bool (*hqd_sdma_is_occupied
)(struct kgd_dev
*kgd
, void *mqd
);
169 int (*hqd_sdma_destroy
)(struct kgd_dev
*kgd
, void *mqd
,
170 unsigned int timeout
);
172 int (*address_watch_disable
)(struct kgd_dev
*kgd
);
173 int (*address_watch_execute
)(struct kgd_dev
*kgd
,
174 unsigned int watch_point_id
,
178 int (*wave_control_execute
)(struct kgd_dev
*kgd
,
179 uint32_t gfx_index_val
,
181 uint32_t (*address_watch_get_offset
)(struct kgd_dev
*kgd
,
182 unsigned int watch_point_id
,
183 unsigned int reg_offset
);
184 bool (*get_atc_vmid_pasid_mapping_valid
)(
187 uint16_t (*get_atc_vmid_pasid_mapping_pasid
)(
190 void (*write_vmid_invalidate_request
)(struct kgd_dev
*kgd
,
193 uint16_t (*get_fw_version
)(struct kgd_dev
*kgd
,
194 enum kgd_engine_type type
);
198 * struct kgd2kfd_calls
200 * @exit: Notifies amdkfd that kgd module is unloaded
202 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
204 * @device_init: Initialize the newly probed device (if it is a device that
207 * @device_exit: Notifies amdkfd about a removal of a kgd device
209 * @suspend: Notifies amdkfd about a suspend action done to a kgd device
211 * @resume: Notifies amdkfd about a resume action done to a kgd device
213 * This structure contains function callback pointers so the kgd driver
214 * will notify to the amdkfd about certain status changes.
217 struct kgd2kfd_calls
{
219 struct kfd_dev
* (*probe
)(struct kgd_dev
*kgd
, struct pci_dev
*pdev
,
220 const struct kfd2kgd_calls
*f2g
);
221 bool (*device_init
)(struct kfd_dev
*kfd
,
222 const struct kgd2kfd_shared_resources
*gpu_resources
);
223 void (*device_exit
)(struct kfd_dev
*kfd
);
224 void (*interrupt
)(struct kfd_dev
*kfd
, const void *ih_ring_entry
);
225 void (*suspend
)(struct kfd_dev
*kfd
);
226 int (*resume
)(struct kfd_dev
*kfd
);
229 int kgd2kfd_init(unsigned interface_version
,
230 const struct kgd2kfd_calls
**g2f
);
232 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */