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>
35 #define KFD_INTERFACE_VERSION 1
42 enum kgd_memory_pool
{
43 KGD_POOL_SYSTEM_CACHEABLE
= 1,
44 KGD_POOL_SYSTEM_WRITECOMBINE
= 2,
45 KGD_POOL_FRAMEBUFFER
= 3,
48 enum kgd_engine_type
{
59 struct kgd2kfd_shared_resources
{
60 /* Bit n == 1 means VMID n is available for KFD. */
61 unsigned int compute_vmid_bitmap
;
63 /* Compute pipes are counted starting from MEC0/pipe0 as 0. */
64 unsigned int first_compute_pipe
;
66 /* Number of MEC pipes available for KFD. */
67 unsigned int compute_pipe_count
;
69 /* Base address of doorbell aperture. */
70 phys_addr_t doorbell_physical_address
;
72 /* Size in bytes of doorbell aperture. */
73 size_t doorbell_aperture_size
;
75 /* Number of bytes at start of aperture reserved for KGD. */
76 size_t doorbell_start_offset
;
80 * struct kfd2kgd_calls
82 * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture.
83 * The buffer can be used for mqds, hpds, kernel queue, fence and runlists
85 * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture
87 * @get_vmem_size: Retrieves (physical) size of VRAM
89 * @get_gpu_clock_counter: Retrieves GPU clock counter
91 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
93 * @program_sh_mem_settings: A function that should initiate the memory
94 * properties such as main aperture memory type (cache / non cached) and
95 * secondary aperture base address, size and memory type.
96 * This function is used only for no cp scheduling mode.
98 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
99 * scheduling mode. Only used for no cp scheduling mode.
101 * @init_pipeline: Initialized the compute pipelines.
103 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
106 * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
107 * used only for no HWS mode.
109 * @hqd_is_occupies: Checks if a hqd slot is occupied.
111 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
113 * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
115 * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
118 * @get_fw_version: Returns FW versions from the header
120 * This structure contains function pointers to services that the kgd driver
121 * provides to amdkfd driver.
124 struct kfd2kgd_calls
{
125 int (*init_gtt_mem_allocation
)(struct kgd_dev
*kgd
, size_t size
,
126 void **mem_obj
, uint64_t *gpu_addr
,
129 void (*free_gtt_mem
)(struct kgd_dev
*kgd
, void *mem_obj
);
131 uint64_t (*get_vmem_size
)(struct kgd_dev
*kgd
);
132 uint64_t (*get_gpu_clock_counter
)(struct kgd_dev
*kgd
);
134 uint32_t (*get_max_engine_clock_in_mhz
)(struct kgd_dev
*kgd
);
136 /* Register access functions */
137 void (*program_sh_mem_settings
)(struct kgd_dev
*kgd
, uint32_t vmid
,
138 uint32_t sh_mem_config
, uint32_t sh_mem_ape1_base
,
139 uint32_t sh_mem_ape1_limit
, uint32_t sh_mem_bases
);
141 int (*set_pasid_vmid_mapping
)(struct kgd_dev
*kgd
, unsigned int pasid
,
144 int (*init_pipeline
)(struct kgd_dev
*kgd
, uint32_t pipe_id
,
145 uint32_t hpd_size
, uint64_t hpd_gpu_addr
);
147 int (*init_interrupts
)(struct kgd_dev
*kgd
, uint32_t pipe_id
);
149 int (*hqd_load
)(struct kgd_dev
*kgd
, void *mqd
, uint32_t pipe_id
,
150 uint32_t queue_id
, uint32_t __user
*wptr
);
152 int (*hqd_sdma_load
)(struct kgd_dev
*kgd
, void *mqd
);
154 bool (*hqd_is_occupied
)(struct kgd_dev
*kgd
, uint64_t queue_address
,
155 uint32_t pipe_id
, uint32_t queue_id
);
157 int (*hqd_destroy
)(struct kgd_dev
*kgd
, uint32_t reset_type
,
158 unsigned int timeout
, uint32_t pipe_id
,
161 bool (*hqd_sdma_is_occupied
)(struct kgd_dev
*kgd
, void *mqd
);
163 int (*hqd_sdma_destroy
)(struct kgd_dev
*kgd
, void *mqd
,
164 unsigned int timeout
);
166 int (*address_watch_disable
)(struct kgd_dev
*kgd
);
167 int (*address_watch_execute
)(struct kgd_dev
*kgd
,
168 unsigned int watch_point_id
,
172 int (*wave_control_execute
)(struct kgd_dev
*kgd
,
173 uint32_t gfx_index_val
,
175 uint32_t (*address_watch_get_offset
)(struct kgd_dev
*kgd
,
176 unsigned int watch_point_id
,
177 unsigned int reg_offset
);
178 bool (*get_atc_vmid_pasid_mapping_valid
)(
181 uint16_t (*get_atc_vmid_pasid_mapping_pasid
)(
184 void (*write_vmid_invalidate_request
)(struct kgd_dev
*kgd
,
187 uint16_t (*get_fw_version
)(struct kgd_dev
*kgd
,
188 enum kgd_engine_type type
);
192 * struct kgd2kfd_calls
194 * @exit: Notifies amdkfd that kgd module is unloaded
196 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
198 * @device_init: Initialize the newly probed device (if it is a device that
201 * @device_exit: Notifies amdkfd about a removal of a kgd device
203 * @suspend: Notifies amdkfd about a suspend action done to a kgd device
205 * @resume: Notifies amdkfd about a resume action done to a kgd device
207 * This structure contains function callback pointers so the kgd driver
208 * will notify to the amdkfd about certain status changes.
211 struct kgd2kfd_calls
{
213 struct kfd_dev
* (*probe
)(struct kgd_dev
*kgd
, struct pci_dev
*pdev
,
214 const struct kfd2kgd_calls
*f2g
);
215 bool (*device_init
)(struct kfd_dev
*kfd
,
216 const struct kgd2kfd_shared_resources
*gpu_resources
);
217 void (*device_exit
)(struct kfd_dev
*kfd
);
218 void (*interrupt
)(struct kfd_dev
*kfd
, const void *ih_ring_entry
);
219 void (*suspend
)(struct kfd_dev
*kfd
);
220 int (*resume
)(struct kfd_dev
*kfd
);
223 bool kgd2kfd_init(unsigned interface_version
,
224 const struct kgd2kfd_calls
**g2f
);
226 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */