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 kgd2kfd_calls
82 * @exit: Notifies amdkfd that kgd module is unloaded
84 * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
86 * @device_init: Initialize the newly probed device (if it is a device that
89 * @device_exit: Notifies amdkfd about a removal of a kgd device
91 * @suspend: Notifies amdkfd about a suspend action done to a kgd device
93 * @resume: Notifies amdkfd about a resume action done to a kgd device
95 * This structure contains function callback pointers so the kgd driver
96 * will notify to the amdkfd about certain status changes.
99 struct kgd2kfd_calls {
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);
111 * struct kfd2kgd_calls
113 * @init_sa_manager: Initialize an instance of the sa manager, used by
114 * amdkfd for all system memory allocations that are mapped to the GART
117 * @fini_sa_manager: Releases all memory allocations for amdkfd that are
118 * handled by kgd sa manager
120 * @allocate_mem: Allocate a buffer from amdkfd's sa manager. The buffer can
121 * be used for mqds, hpds, kernel queue, fence and runlists
123 * @free_mem: Frees a buffer that was allocated by amdkfd's sa manager
125 * @get_vmem_size: Retrieves (physical) size of VRAM
127 * @get_gpu_clock_counter: Retrieves GPU clock counter
129 * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
131 * @program_sh_mem_settings: A function that should initiate the memory
132 * properties such as main aperture memory type (cache / non cached) and
133 * secondary aperture base address, size and memory type.
134 * This function is used only for no cp scheduling mode.
136 * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
137 * scheduling mode. Only used for no cp scheduling mode.
139 * @init_memory: Initializes memory apertures to fixed base/limit address
140 * and non cached memory types.
142 * @init_pipeline: Initialized the compute pipelines.
144 * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
147 * @hqd_is_occupies: Checks if a hqd slot is occupied.
149 * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
151 * @get_fw_version: Returns FW versions from the header
153 * This structure contains function pointers to services that the kgd driver
154 * provides to amdkfd driver.
157 struct kfd2kgd_calls {
158 /* Memory management. */
159 int (*init_sa_manager)(struct kgd_dev *kgd, unsigned int size);
160 void (*fini_sa_manager)(struct kgd_dev *kgd);
161 int (*allocate_mem)(struct kgd_dev *kgd, size_t size, size_t alignment,
162 enum kgd_memory_pool pool, struct kgd_mem **mem);
164 void (*free_mem)(struct kgd_dev *kgd, struct kgd_mem *mem);
166 uint64_t (*get_vmem_size)(struct kgd_dev *kgd);
167 uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd);
169 uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd);
171 /* Register access functions */
172 void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid,
173 uint32_t sh_mem_config, uint32_t sh_mem_ape1_base,
174 uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases);
176 int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid,
179 int (*init_memory)(struct kgd_dev *kgd);
180 int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id,
181 uint32_t hpd_size, uint64_t hpd_gpu_addr);
183 int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id,
184 uint32_t queue_id, uint32_t __user *wptr);
186 bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address,
187 uint32_t pipe_id, uint32_t queue_id);
189 int (*hqd_destroy)(struct kgd_dev *kgd, uint32_t reset_type,
190 unsigned int timeout, uint32_t pipe_id,
192 uint16_t (*get_fw_version)(struct kgd_dev *kgd,
193 enum kgd_engine_type type);
196 bool kgd2kfd_init(unsigned interface_version,
197 const struct kfd2kgd_calls *f2g,
198 const struct kgd2kfd_calls **g2f);
200 #endif /* KGD_KFD_INTERFACE_H_INCLUDED */