1 /*
2  * Copyright 2018 Advanced Micro Devices, Inc.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sub license, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
20  *
21  * The above copyright notice and this permission notice (including the
22  * next paragraph) shall be included in all copies or substantial portions
23  * of the Software.
24  *
25  */
26 #ifndef __AMDGPU_GMC_H__
27 #define __AMDGPU_GMC_H__
28 
29 #include <linux/types.h>
30 
31 #include "amdgpu_irq.h"
32 #include "amdgpu_ras.h"
33 
34 /* VA hole for 48bit addresses on Vega10 */
35 #define AMDGPU_GMC_HOLE_START	0x0000800000000000ULL
36 #define AMDGPU_GMC_HOLE_END	0xffff800000000000ULL
37 
38 /*
39  * Hardware is programmed as if the hole doesn't exists with start and end
40  * address values.
41  *
42  * This mask is used to remove the upper 16bits of the VA and so come up with
43  * the linear addr value.
44  */
45 #define AMDGPU_GMC_HOLE_MASK	0x0000ffffffffffffULL
46 
47 /*
48  * Ring size as power of two for the log of recent faults.
49  */
50 #define AMDGPU_GMC_FAULT_RING_ORDER	8
51 #define AMDGPU_GMC_FAULT_RING_SIZE	(1 << AMDGPU_GMC_FAULT_RING_ORDER)
52 
53 /*
54  * Hash size as power of two for the log of recent faults
55  */
56 #define AMDGPU_GMC_FAULT_HASH_ORDER	8
57 #define AMDGPU_GMC_FAULT_HASH_SIZE	(1 << AMDGPU_GMC_FAULT_HASH_ORDER)
58 
59 /*
60  * Number of IH timestamp ticks until a fault is considered handled
61  */
62 #define AMDGPU_GMC_FAULT_TIMEOUT	5000ULL
63 
64 struct firmware;
65 
66 /*
67  * GMC page fault information
68  */
69 struct amdgpu_gmc_fault {
70 	uint64_t	timestamp:48;
71 	uint64_t	next:AMDGPU_GMC_FAULT_RING_ORDER;
72 	atomic64_t	key;
73 	uint64_t	timestamp_expiry:48;
74 };
75 
76 /*
77  * VMHUB structures, functions & helpers
78  */
79 struct amdgpu_vmhub_funcs {
80 	void (*print_l2_protection_fault_status)(struct amdgpu_device *adev,
81 						 uint32_t status);
82 	uint32_t (*get_invalidate_req)(unsigned int vmid, uint32_t flush_type);
83 };
84 
85 struct amdgpu_vmhub {
86 	uint32_t	ctx0_ptb_addr_lo32;
87 	uint32_t	ctx0_ptb_addr_hi32;
88 	uint32_t	vm_inv_eng0_sem;
89 	uint32_t	vm_inv_eng0_req;
90 	uint32_t	vm_inv_eng0_ack;
91 	uint32_t	vm_context0_cntl;
92 	uint32_t	vm_l2_pro_fault_status;
93 	uint32_t	vm_l2_pro_fault_cntl;
94 
95 	/*
96 	 * store the register distances between two continuous context domain
97 	 * and invalidation engine.
98 	 */
99 	uint32_t	ctx_distance;
100 	uint32_t	ctx_addr_distance; /* include LO32/HI32 */
101 	uint32_t	eng_distance;
102 	uint32_t	eng_addr_distance; /* include LO32/HI32 */
103 
104 	uint32_t        vm_cntx_cntl;
105 	uint32_t	vm_cntx_cntl_vm_fault;
106 	uint32_t	vm_l2_bank_select_reserved_cid2;
107 
108 	uint32_t	vm_contexts_disable;
109 
110 	const struct amdgpu_vmhub_funcs *vmhub_funcs;
111 };
112 
113 /*
114  * GPU MC structures, functions & helpers
115  */
116 struct amdgpu_gmc_funcs {
117 	/* flush the vm tlb via mmio */
118 	void (*flush_gpu_tlb)(struct amdgpu_device *adev, uint32_t vmid,
119 				uint32_t vmhub, uint32_t flush_type);
120 	/* flush the vm tlb via pasid */
121 	int (*flush_gpu_tlb_pasid)(struct amdgpu_device *adev, uint16_t pasid,
122 					uint32_t flush_type, bool all_hub,
123 					uint32_t inst);
124 	/* flush the vm tlb via ring */
125 	uint64_t (*emit_flush_gpu_tlb)(struct amdgpu_ring *ring, unsigned vmid,
126 				       uint64_t pd_addr);
127 	/* Change the VMID -> PASID mapping */
128 	void (*emit_pasid_mapping)(struct amdgpu_ring *ring, unsigned vmid,
129 				   unsigned pasid);
130 	/* enable/disable PRT support */
131 	void (*set_prt)(struct amdgpu_device *adev, bool enable);
132 	/* map mtype to hardware flags */
133 	uint64_t (*map_mtype)(struct amdgpu_device *adev, uint32_t flags);
134 	/* get the pde for a given mc addr */
135 	void (*get_vm_pde)(struct amdgpu_device *adev, int level,
136 			   u64 *dst, u64 *flags);
137 	/* get the pte flags to use for a BO VA mapping */
138 	void (*get_vm_pte)(struct amdgpu_device *adev,
139 			   struct amdgpu_bo_va_mapping *mapping,
140 			   uint64_t *flags);
141 	/* get the amount of memory used by the vbios for pre-OS console */
142 	unsigned int (*get_vbios_fb_size)(struct amdgpu_device *adev);
143 };
144 
145 struct amdgpu_xgmi_ras {
146 	struct amdgpu_ras_block_object ras_block;
147 };
148 
149 struct amdgpu_xgmi {
150 	/* from psp */
151 	u64 node_id;
152 	u64 hive_id;
153 	/* fixed per family */
154 	u64 node_segment_size;
155 	/* physical node (0-3) */
156 	unsigned physical_node_id;
157 	/* number of nodes (0-4) */
158 	unsigned num_physical_nodes;
159 	/* gpu list in the same hive */
160 	struct list_head head;
161 	bool supported;
162 	struct ras_common_if *ras_if;
163 	bool connected_to_cpu;
164 	bool pending_reset;
165 	struct amdgpu_xgmi_ras *ras;
166 };
167 
168 struct amdgpu_gmc {
169 	/* FB's physical address in MMIO space (for CPU to
170 	 * map FB). This is different compared to the agp/
171 	 * gart/vram_start/end field as the later is from
172 	 * GPU's view and aper_base is from CPU's view.
173 	 */
174 	resource_size_t		aper_size;
175 	resource_size_t		aper_base;
176 	/* for some chips with <= 32MB we need to lie
177 	 * about vram size near mc fb location */
178 	u64			mc_vram_size;
179 	u64			visible_vram_size;
180 	/* AGP aperture start and end in MC address space
181 	 * Driver find a hole in the MC address space
182 	 * to place AGP by setting MC_VM_AGP_BOT/TOP registers
183 	 * Under VMID0, logical address == MC address. AGP
184 	 * aperture maps to physical bus or IOVA addressed.
185 	 * AGP aperture is used to simulate FB in ZFB case.
186 	 * AGP aperture is also used for page table in system
187 	 * memory (mainly for APU).
188 	 *
189 	 */
190 	u64			agp_size;
191 	u64			agp_start;
192 	u64			agp_end;
193 	/* GART aperture start and end in MC address space
194 	 * Driver find a hole in the MC address space
195 	 * to place GART by setting VM_CONTEXT0_PAGE_TABLE_START/END_ADDR
196 	 * registers
197 	 * Under VMID0, logical address inside GART aperture will
198 	 * be translated through gpuvm gart page table to access
199 	 * paged system memory
200 	 */
201 	u64			gart_size;
202 	u64			gart_start;
203 	u64			gart_end;
204 	/* Frame buffer aperture of this GPU device. Different from
205 	 * fb_start (see below), this only covers the local GPU device.
206 	 * If driver uses FB aperture to access FB, driver get fb_start from
207 	 * MC_VM_FB_LOCATION_BASE (set by vbios) and calculate vram_start
208 	 * of this local device by adding an offset inside the XGMI hive.
209 	 * If driver uses GART table for VMID0 FB access, driver finds a hole in
210 	 * VMID0's virtual address space to place the SYSVM aperture inside
211 	 * which the first part is vram and the second part is gart (covering
212 	 * system ram).
213 	 */
214 	u64			vram_start;
215 	u64			vram_end;
216 	/* FB region , it's same as local vram region in single GPU, in XGMI
217 	 * configuration, this region covers all GPUs in the same hive ,
218 	 * each GPU in the hive has the same view of this FB region .
219 	 * GPU0's vram starts at offset (0 * segment size) ,
220 	 * GPU1 starts at offset (1 * segment size), etc.
221 	 */
222 	u64			fb_start;
223 	u64			fb_end;
224 	unsigned		vram_width;
225 	u64			real_vram_size;
226 	int			vram_mtrr;
227 	u64                     mc_mask;
228 	const struct firmware   *fw;	/* MC firmware */
229 	uint32_t                fw_version;
230 	struct amdgpu_irq_src	vm_fault;
231 	uint32_t		vram_type;
232 	uint8_t			vram_vendor;
233 	uint32_t                srbm_soft_reset;
234 	bool			prt_warning;
235 	uint32_t		sdpif_register;
236 	/* apertures */
237 	u64			shared_aperture_start;
238 	u64			shared_aperture_end;
239 	u64			private_aperture_start;
240 	u64			private_aperture_end;
241 	/* protects concurrent invalidation */
242 	spinlock_t		invalidate_lock;
243 	bool			translate_further;
244 	struct kfd_vm_fault_info *vm_fault_info;
245 	atomic_t		vm_fault_info_updated;
246 
247 	struct amdgpu_gmc_fault	fault_ring[AMDGPU_GMC_FAULT_RING_SIZE];
248 	struct {
249 		uint64_t	idx:AMDGPU_GMC_FAULT_RING_ORDER;
250 	} fault_hash[AMDGPU_GMC_FAULT_HASH_SIZE];
251 	uint64_t		last_fault:AMDGPU_GMC_FAULT_RING_ORDER;
252 
253 	bool tmz_enabled;
254 	bool is_app_apu;
255 
256 	const struct amdgpu_gmc_funcs	*gmc_funcs;
257 
258 	struct amdgpu_xgmi xgmi;
259 	struct amdgpu_irq_src	ecc_irq;
260 	int noretry;
261 
262 	uint32_t	vmid0_page_table_block_size;
263 	uint32_t	vmid0_page_table_depth;
264 	struct amdgpu_bo		*pdb0_bo;
265 	/* CPU kmapped address of pdb0*/
266 	void				*ptr_pdb0;
267 
268 	/* MALL size */
269 	u64 mall_size;
270 	/* number of UMC instances */
271 	int num_umc;
272 	/* mode2 save restore */
273 	u64 VM_L2_CNTL;
274 	u64 VM_L2_CNTL2;
275 	u64 VM_DUMMY_PAGE_FAULT_CNTL;
276 	u64 VM_DUMMY_PAGE_FAULT_ADDR_LO32;
277 	u64 VM_DUMMY_PAGE_FAULT_ADDR_HI32;
278 	u64 VM_L2_PROTECTION_FAULT_CNTL;
279 	u64 VM_L2_PROTECTION_FAULT_CNTL2;
280 	u64 VM_L2_PROTECTION_FAULT_MM_CNTL3;
281 	u64 VM_L2_PROTECTION_FAULT_MM_CNTL4;
282 	u64 VM_L2_PROTECTION_FAULT_ADDR_LO32;
283 	u64 VM_L2_PROTECTION_FAULT_ADDR_HI32;
284 	u64 VM_DEBUG;
285 	u64 VM_L2_MM_GROUP_RT_CLASSES;
286 	u64 VM_L2_BANK_SELECT_RESERVED_CID;
287 	u64 VM_L2_BANK_SELECT_RESERVED_CID2;
288 	u64 VM_L2_CACHE_PARITY_CNTL;
289 	u64 VM_L2_IH_LOG_CNTL;
290 	u64 VM_CONTEXT_CNTL[16];
291 	u64 VM_CONTEXT_PAGE_TABLE_BASE_ADDR_LO32[16];
292 	u64 VM_CONTEXT_PAGE_TABLE_BASE_ADDR_HI32[16];
293 	u64 VM_CONTEXT_PAGE_TABLE_START_ADDR_LO32[16];
294 	u64 VM_CONTEXT_PAGE_TABLE_START_ADDR_HI32[16];
295 	u64 VM_CONTEXT_PAGE_TABLE_END_ADDR_LO32[16];
296 	u64 VM_CONTEXT_PAGE_TABLE_END_ADDR_HI32[16];
297 	u64 MC_VM_MX_L1_TLB_CNTL;
298 };
299 
300 #define amdgpu_gmc_flush_gpu_tlb(adev, vmid, vmhub, type) ((adev)->gmc.gmc_funcs->flush_gpu_tlb((adev), (vmid), (vmhub), (type)))
301 #define amdgpu_gmc_flush_gpu_tlb_pasid(adev, pasid, type, allhub, inst) \
302 	((adev)->gmc.gmc_funcs->flush_gpu_tlb_pasid \
303 	((adev), (pasid), (type), (allhub), (inst)))
304 #define amdgpu_gmc_emit_flush_gpu_tlb(r, vmid, addr) (r)->adev->gmc.gmc_funcs->emit_flush_gpu_tlb((r), (vmid), (addr))
305 #define amdgpu_gmc_emit_pasid_mapping(r, vmid, pasid) (r)->adev->gmc.gmc_funcs->emit_pasid_mapping((r), (vmid), (pasid))
306 #define amdgpu_gmc_map_mtype(adev, flags) (adev)->gmc.gmc_funcs->map_mtype((adev),(flags))
307 #define amdgpu_gmc_get_vm_pde(adev, level, dst, flags) (adev)->gmc.gmc_funcs->get_vm_pde((adev), (level), (dst), (flags))
308 #define amdgpu_gmc_get_vm_pte(adev, mapping, flags) (adev)->gmc.gmc_funcs->get_vm_pte((adev), (mapping), (flags))
309 #define amdgpu_gmc_get_vbios_fb_size(adev) (adev)->gmc.gmc_funcs->get_vbios_fb_size((adev))
310 
311 /**
312  * amdgpu_gmc_vram_full_visible - Check if full VRAM is visible through the BAR
313  *
314  * @adev: amdgpu_device pointer
315  *
316  * Returns:
317  * True if full VRAM is visible through the BAR
318  */
319 static inline bool amdgpu_gmc_vram_full_visible(struct amdgpu_gmc *gmc)
320 {
321 	WARN_ON(gmc->real_vram_size < gmc->visible_vram_size);
322 
323 	return (gmc->real_vram_size == gmc->visible_vram_size);
324 }
325 
326 /**
327  * amdgpu_gmc_sign_extend - sign extend the given gmc address
328  *
329  * @addr: address to extend
330  */
331 static inline uint64_t amdgpu_gmc_sign_extend(uint64_t addr)
332 {
333 	if (addr >= AMDGPU_GMC_HOLE_START)
334 		addr |= AMDGPU_GMC_HOLE_END;
335 
336 	return addr;
337 }
338 
339 int amdgpu_gmc_pdb0_alloc(struct amdgpu_device *adev);
340 void amdgpu_gmc_get_pde_for_bo(struct amdgpu_bo *bo, int level,
341 			       uint64_t *addr, uint64_t *flags);
342 int amdgpu_gmc_set_pte_pde(struct amdgpu_device *adev, void *cpu_pt_addr,
343 				uint32_t gpu_page_idx, uint64_t addr,
344 				uint64_t flags);
345 uint64_t amdgpu_gmc_pd_addr(struct amdgpu_bo *bo);
346 uint64_t amdgpu_gmc_agp_addr(struct ttm_buffer_object *bo);
347 void amdgpu_gmc_sysvm_location(struct amdgpu_device *adev, struct amdgpu_gmc *mc);
348 void amdgpu_gmc_vram_location(struct amdgpu_device *adev, struct amdgpu_gmc *mc,
349 			      u64 base);
350 void amdgpu_gmc_gart_location(struct amdgpu_device *adev,
351 			      struct amdgpu_gmc *mc);
352 void amdgpu_gmc_agp_location(struct amdgpu_device *adev,
353 			     struct amdgpu_gmc *mc);
354 bool amdgpu_gmc_filter_faults(struct amdgpu_device *adev,
355 			      struct amdgpu_ih_ring *ih, uint64_t addr,
356 			      uint16_t pasid, uint64_t timestamp);
357 void amdgpu_gmc_filter_faults_remove(struct amdgpu_device *adev, uint64_t addr,
358 				     uint16_t pasid);
359 int amdgpu_gmc_ras_sw_init(struct amdgpu_device *adev);
360 int amdgpu_gmc_ras_late_init(struct amdgpu_device *adev);
361 void amdgpu_gmc_ras_fini(struct amdgpu_device *adev);
362 int amdgpu_gmc_allocate_vm_inv_eng(struct amdgpu_device *adev);
363 
364 extern void amdgpu_gmc_tmz_set(struct amdgpu_device *adev);
365 extern void amdgpu_gmc_noretry_set(struct amdgpu_device *adev);
366 
367 extern void
368 amdgpu_gmc_set_vm_fault_masks(struct amdgpu_device *adev, int hub_type,
369 			      bool enable);
370 
371 void amdgpu_gmc_get_vbios_allocations(struct amdgpu_device *adev);
372 
373 void amdgpu_gmc_init_pdb0(struct amdgpu_device *adev);
374 uint64_t amdgpu_gmc_vram_mc2pa(struct amdgpu_device *adev, uint64_t mc_addr);
375 uint64_t amdgpu_gmc_vram_pa(struct amdgpu_device *adev, struct amdgpu_bo *bo);
376 uint64_t amdgpu_gmc_vram_cpu_pa(struct amdgpu_device *adev, struct amdgpu_bo *bo);
377 int amdgpu_gmc_vram_checking(struct amdgpu_device *adev);
378 #endif
379