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 enum kgd_engine_type {
49 	KGD_ENGINE_PFP = 1,
50 	KGD_ENGINE_ME,
51 	KGD_ENGINE_CE,
52 	KGD_ENGINE_MEC1,
53 	KGD_ENGINE_MEC2,
54 	KGD_ENGINE_RLC,
55 	KGD_ENGINE_SDMA,
56 	KGD_ENGINE_MAX
57 };
58 
59 struct kgd2kfd_shared_resources {
60 	/* Bit n == 1 means VMID n is available for KFD. */
61 	unsigned int compute_vmid_bitmap;
62 
63 	/* Compute pipes are counted starting from MEC0/pipe0 as 0. */
64 	unsigned int first_compute_pipe;
65 
66 	/* Number of MEC pipes available for KFD. */
67 	unsigned int compute_pipe_count;
68 
69 	/* Base address of doorbell aperture. */
70 	phys_addr_t doorbell_physical_address;
71 
72 	/* Size in bytes of doorbell aperture. */
73 	size_t doorbell_aperture_size;
74 
75 	/* Number of bytes at start of aperture reserved for KGD. */
76 	size_t doorbell_start_offset;
77 };
78 
79 /**
80  * struct kfd2kgd_calls
81  *
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
84  *
85  * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture
86  *
87  * @get_vmem_size: Retrieves (physical) size of VRAM
88  *
89  * @get_gpu_clock_counter: Retrieves GPU clock counter
90  *
91  * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
92  *
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.
97  *
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.
100  *
101  * @init_pipeline: Initialized the compute pipelines.
102  *
103  * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
104  * sceduling mode.
105  *
106  * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
107  * used only for no HWS mode.
108  *
109  * @hqd_is_occupies: Checks if a hqd slot is occupied.
110  *
111  * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
112  *
113  * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
114  *
115  * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
116  * SDMA hqd slot.
117  *
118  * @get_fw_version: Returns FW versions from the header
119  *
120  * This structure contains function pointers to services that the kgd driver
121  * provides to amdkfd driver.
122  *
123  */
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,
127 					void **cpu_ptr);
128 
129 	void (*free_gtt_mem)(struct kgd_dev *kgd, void *mem_obj);
130 
131 	uint64_t (*get_vmem_size)(struct kgd_dev *kgd);
132 	uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd);
133 
134 	uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd);
135 
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);
140 
141 	int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid,
142 					unsigned int vmid);
143 
144 	int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id,
145 				uint32_t hpd_size, uint64_t hpd_gpu_addr);
146 
147 	int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id,
148 			uint32_t queue_id, uint32_t __user *wptr);
149 
150 	int (*hqd_sdma_load)(struct kgd_dev *kgd, void *mqd);
151 
152 	bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address,
153 				uint32_t pipe_id, uint32_t queue_id);
154 
155 	int (*hqd_destroy)(struct kgd_dev *kgd, uint32_t reset_type,
156 				unsigned int timeout, uint32_t pipe_id,
157 				uint32_t queue_id);
158 
159 	bool (*hqd_sdma_is_occupied)(struct kgd_dev *kgd, void *mqd);
160 
161 	int (*hqd_sdma_destroy)(struct kgd_dev *kgd, void *mqd,
162 				unsigned int timeout);
163 
164 	uint16_t (*get_fw_version)(struct kgd_dev *kgd,
165 				enum kgd_engine_type type);
166 };
167 
168 /**
169  * struct kgd2kfd_calls
170  *
171  * @exit: Notifies amdkfd that kgd module is unloaded
172  *
173  * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
174  *
175  * @device_init: Initialize the newly probed device (if it is a device that
176  * amdkfd supports)
177  *
178  * @device_exit: Notifies amdkfd about a removal of a kgd device
179  *
180  * @suspend: Notifies amdkfd about a suspend action done to a kgd device
181  *
182  * @resume: Notifies amdkfd about a resume action done to a kgd device
183  *
184  * This structure contains function callback pointers so the kgd driver
185  * will notify to the amdkfd about certain status changes.
186  *
187  */
188 struct kgd2kfd_calls {
189 	void (*exit)(void);
190 	struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev,
191 		const struct kfd2kgd_calls *f2g);
192 	bool (*device_init)(struct kfd_dev *kfd,
193 			const struct kgd2kfd_shared_resources *gpu_resources);
194 	void (*device_exit)(struct kfd_dev *kfd);
195 	void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry);
196 	void (*suspend)(struct kfd_dev *kfd);
197 	int (*resume)(struct kfd_dev *kfd);
198 };
199 
200 bool kgd2kfd_init(unsigned interface_version,
201 		const struct kgd2kfd_calls **g2f);
202 
203 #endif	/* KGD_KFD_INTERFACE_H_INCLUDED */
204