xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/qxl/qxl_ttm.c (revision eceb233b9bd0dfebb902ed73b531ae6964fa3f9b)
1 /*	$NetBSD: qxl_ttm.c,v 1.2 2018/08/27 04:58:35 riastradh Exp $	*/
2 
3 /*
4  * Copyright 2013 Red Hat Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: Dave Airlie
25  *          Alon Levy
26  */
27 
28 #include <sys/cdefs.h>
29 __KERNEL_RCSID(0, "$NetBSD: qxl_ttm.c,v 1.2 2018/08/27 04:58:35 riastradh Exp $");
30 
31 #include <ttm/ttm_bo_api.h>
32 #include <ttm/ttm_bo_driver.h>
33 #include <ttm/ttm_placement.h>
34 #include <ttm/ttm_page_alloc.h>
35 #include <ttm/ttm_module.h>
36 #include <drm/drmP.h>
37 #include <drm/drm.h>
38 #include <drm/qxl_drm.h>
39 #include "qxl_drv.h"
40 #include "qxl_object.h"
41 
42 #include <linux/delay.h>
43 static int qxl_ttm_debugfs_init(struct qxl_device *qdev);
44 
45 static struct qxl_device *qxl_get_qdev(struct ttm_bo_device *bdev)
46 {
47 	struct qxl_mman *mman;
48 	struct qxl_device *qdev;
49 
50 	mman = container_of(bdev, struct qxl_mman, bdev);
51 	qdev = container_of(mman, struct qxl_device, mman);
52 	return qdev;
53 }
54 
55 static int qxl_ttm_mem_global_init(struct drm_global_reference *ref)
56 {
57 	return ttm_mem_global_init(ref->object);
58 }
59 
60 static void qxl_ttm_mem_global_release(struct drm_global_reference *ref)
61 {
62 	ttm_mem_global_release(ref->object);
63 }
64 
65 static int qxl_ttm_global_init(struct qxl_device *qdev)
66 {
67 	struct drm_global_reference *global_ref;
68 	int r;
69 
70 	qdev->mman.mem_global_referenced = false;
71 	global_ref = &qdev->mman.mem_global_ref;
72 	global_ref->global_type = DRM_GLOBAL_TTM_MEM;
73 	global_ref->size = sizeof(struct ttm_mem_global);
74 	global_ref->init = &qxl_ttm_mem_global_init;
75 	global_ref->release = &qxl_ttm_mem_global_release;
76 
77 	r = drm_global_item_ref(global_ref);
78 	if (r != 0) {
79 		DRM_ERROR("Failed setting up TTM memory accounting "
80 			  "subsystem.\n");
81 		return r;
82 	}
83 
84 	qdev->mman.bo_global_ref.mem_glob =
85 		qdev->mman.mem_global_ref.object;
86 	global_ref = &qdev->mman.bo_global_ref.ref;
87 	global_ref->global_type = DRM_GLOBAL_TTM_BO;
88 	global_ref->size = sizeof(struct ttm_bo_global);
89 	global_ref->init = &ttm_bo_global_init;
90 	global_ref->release = &ttm_bo_global_release;
91 	r = drm_global_item_ref(global_ref);
92 	if (r != 0) {
93 		DRM_ERROR("Failed setting up TTM BO subsystem.\n");
94 		drm_global_item_unref(&qdev->mman.mem_global_ref);
95 		return r;
96 	}
97 
98 	qdev->mman.mem_global_referenced = true;
99 	return 0;
100 }
101 
102 static void qxl_ttm_global_fini(struct qxl_device *qdev)
103 {
104 	if (qdev->mman.mem_global_referenced) {
105 		drm_global_item_unref(&qdev->mman.bo_global_ref.ref);
106 		drm_global_item_unref(&qdev->mman.mem_global_ref);
107 		qdev->mman.mem_global_referenced = false;
108 	}
109 }
110 
111 static struct vm_operations_struct qxl_ttm_vm_ops;
112 static const struct vm_operations_struct *ttm_vm_ops;
113 
114 static int qxl_ttm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
115 {
116 	struct ttm_buffer_object *bo;
117 	int r;
118 
119 	bo = (struct ttm_buffer_object *)vma->vm_private_data;
120 	if (bo == NULL)
121 		return VM_FAULT_NOPAGE;
122 	r = ttm_vm_ops->fault(vma, vmf);
123 	return r;
124 }
125 
126 int qxl_mmap(struct file *filp, struct vm_area_struct *vma)
127 {
128 	struct drm_file *file_priv;
129 	struct qxl_device *qdev;
130 	int r;
131 
132 	if (unlikely(vma->vm_pgoff < DRM_FILE_PAGE_OFFSET)) {
133 		pr_info("%s: vma->vm_pgoff (%ld) < DRM_FILE_PAGE_OFFSET\n",
134 			__func__, vma->vm_pgoff);
135 		return -EINVAL;
136 	}
137 
138 	file_priv = filp->private_data;
139 	qdev = file_priv->minor->dev->dev_private;
140 	if (qdev == NULL) {
141 		DRM_ERROR(
142 		 "filp->private_data->minor->dev->dev_private == NULL\n");
143 		return -EINVAL;
144 	}
145 	QXL_INFO(qdev, "%s: filp->private_data = 0x%p, vma->vm_pgoff = %lx\n",
146 		 __func__, filp->private_data, vma->vm_pgoff);
147 
148 	r = ttm_bo_mmap(filp, vma, &qdev->mman.bdev);
149 	if (unlikely(r != 0))
150 		return r;
151 	if (unlikely(ttm_vm_ops == NULL)) {
152 		ttm_vm_ops = vma->vm_ops;
153 		qxl_ttm_vm_ops = *ttm_vm_ops;
154 		qxl_ttm_vm_ops.fault = &qxl_ttm_fault;
155 	}
156 	vma->vm_ops = &qxl_ttm_vm_ops;
157 	return 0;
158 }
159 
160 static int qxl_invalidate_caches(struct ttm_bo_device *bdev, uint32_t flags)
161 {
162 	return 0;
163 }
164 
165 static int qxl_init_mem_type(struct ttm_bo_device *bdev, uint32_t type,
166 			     struct ttm_mem_type_manager *man)
167 {
168 	switch (type) {
169 	case TTM_PL_SYSTEM:
170 		/* System memory */
171 		man->flags = TTM_MEMTYPE_FLAG_MAPPABLE;
172 		man->available_caching = TTM_PL_MASK_CACHING;
173 		man->default_caching = TTM_PL_FLAG_CACHED;
174 		break;
175 	case TTM_PL_VRAM:
176 	case TTM_PL_PRIV0:
177 		/* "On-card" video ram */
178 		man->func = &ttm_bo_manager_func;
179 		man->gpu_offset = 0;
180 		man->flags = TTM_MEMTYPE_FLAG_FIXED |
181 			     TTM_MEMTYPE_FLAG_MAPPABLE;
182 		man->available_caching = TTM_PL_MASK_CACHING;
183 		man->default_caching = TTM_PL_FLAG_CACHED;
184 		break;
185 	default:
186 		DRM_ERROR("Unsupported memory type %u\n", (unsigned)type);
187 		return -EINVAL;
188 	}
189 	return 0;
190 }
191 
192 static void qxl_evict_flags(struct ttm_buffer_object *bo,
193 				struct ttm_placement *placement)
194 {
195 	struct qxl_bo *qbo;
196 	static struct ttm_place placements = {
197 		.fpfn = 0,
198 		.lpfn = 0,
199 		.flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM
200 	};
201 
202 	if (!qxl_ttm_bo_is_qxl_bo(bo)) {
203 		placement->placement = &placements;
204 		placement->busy_placement = &placements;
205 		placement->num_placement = 1;
206 		placement->num_busy_placement = 1;
207 		return;
208 	}
209 	qbo = container_of(bo, struct qxl_bo, tbo);
210 	qxl_ttm_placement_from_domain(qbo, QXL_GEM_DOMAIN_CPU, false);
211 	*placement = qbo->placement;
212 }
213 
214 static int qxl_verify_access(struct ttm_buffer_object *bo, struct file *filp)
215 {
216 	struct qxl_bo *qbo = to_qxl_bo(bo);
217 
218 	return drm_vma_node_verify_access(&qbo->gem_base.vma_node, filp);
219 }
220 
221 static int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
222 				  struct ttm_mem_reg *mem)
223 {
224 	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
225 	struct qxl_device *qdev = qxl_get_qdev(bdev);
226 
227 	mem->bus.addr = NULL;
228 	mem->bus.offset = 0;
229 	mem->bus.size = mem->num_pages << PAGE_SHIFT;
230 	mem->bus.base = 0;
231 	mem->bus.is_iomem = false;
232 	if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
233 		return -EINVAL;
234 	switch (mem->mem_type) {
235 	case TTM_PL_SYSTEM:
236 		/* system memory */
237 		return 0;
238 	case TTM_PL_VRAM:
239 		mem->bus.is_iomem = true;
240 		mem->bus.base = qdev->vram_base;
241 		mem->bus.offset = mem->start << PAGE_SHIFT;
242 		break;
243 	case TTM_PL_PRIV0:
244 		mem->bus.is_iomem = true;
245 		mem->bus.base = qdev->surfaceram_base;
246 		mem->bus.offset = mem->start << PAGE_SHIFT;
247 		break;
248 	default:
249 		return -EINVAL;
250 	}
251 	return 0;
252 }
253 
254 static void qxl_ttm_io_mem_free(struct ttm_bo_device *bdev,
255 				struct ttm_mem_reg *mem)
256 {
257 }
258 
259 /*
260  * TTM backend functions.
261  */
262 struct qxl_ttm_tt {
263 	struct ttm_dma_tt		ttm;
264 	struct qxl_device		*qdev;
265 	u64				offset;
266 };
267 
268 static int qxl_ttm_backend_bind(struct ttm_tt *ttm,
269 				struct ttm_mem_reg *bo_mem)
270 {
271 	struct qxl_ttm_tt *gtt = (void *)ttm;
272 
273 	gtt->offset = (unsigned long)(bo_mem->start << PAGE_SHIFT);
274 	if (!ttm->num_pages) {
275 		WARN(1, "nothing to bind %lu pages for mreg %p back %p!\n",
276 		     ttm->num_pages, bo_mem, ttm);
277 	}
278 	/* Not implemented */
279 	return -1;
280 }
281 
282 static int qxl_ttm_backend_unbind(struct ttm_tt *ttm)
283 {
284 	/* Not implemented */
285 	return -1;
286 }
287 
288 static void qxl_ttm_backend_destroy(struct ttm_tt *ttm)
289 {
290 	struct qxl_ttm_tt *gtt = (void *)ttm;
291 
292 	ttm_dma_tt_fini(&gtt->ttm);
293 	kfree(gtt);
294 }
295 
296 static struct ttm_backend_func qxl_backend_func = {
297 	.bind = &qxl_ttm_backend_bind,
298 	.unbind = &qxl_ttm_backend_unbind,
299 	.destroy = &qxl_ttm_backend_destroy,
300 };
301 
302 static int qxl_ttm_tt_populate(struct ttm_tt *ttm)
303 {
304 	int r;
305 
306 	if (ttm->state != tt_unpopulated)
307 		return 0;
308 
309 	r = ttm_pool_populate(ttm);
310 	if (r)
311 		return r;
312 
313 	return 0;
314 }
315 
316 static void qxl_ttm_tt_unpopulate(struct ttm_tt *ttm)
317 {
318 	ttm_pool_unpopulate(ttm);
319 }
320 
321 static struct ttm_tt *qxl_ttm_tt_create(struct ttm_bo_device *bdev,
322 					unsigned long size, uint32_t page_flags,
323 					struct page *dummy_read_page)
324 {
325 	struct qxl_device *qdev;
326 	struct qxl_ttm_tt *gtt;
327 
328 	qdev = qxl_get_qdev(bdev);
329 	gtt = kzalloc(sizeof(struct qxl_ttm_tt), GFP_KERNEL);
330 	if (gtt == NULL)
331 		return NULL;
332 	gtt->ttm.ttm.func = &qxl_backend_func;
333 	gtt->qdev = qdev;
334 	if (ttm_dma_tt_init(&gtt->ttm, bdev, size, page_flags,
335 			    dummy_read_page)) {
336 		kfree(gtt);
337 		return NULL;
338 	}
339 	return &gtt->ttm.ttm;
340 }
341 
342 static void qxl_move_null(struct ttm_buffer_object *bo,
343 			     struct ttm_mem_reg *new_mem)
344 {
345 	struct ttm_mem_reg *old_mem = &bo->mem;
346 
347 	BUG_ON(old_mem->mm_node != NULL);
348 	*old_mem = *new_mem;
349 	new_mem->mm_node = NULL;
350 }
351 
352 static int qxl_bo_move(struct ttm_buffer_object *bo,
353 		       bool evict, bool interruptible,
354 		       bool no_wait_gpu,
355 		       struct ttm_mem_reg *new_mem)
356 {
357 	struct ttm_mem_reg *old_mem = &bo->mem;
358 	if (old_mem->mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
359 		qxl_move_null(bo, new_mem);
360 		return 0;
361 	}
362 	return ttm_bo_move_memcpy(bo, evict, no_wait_gpu, new_mem);
363 }
364 
365 static void qxl_bo_move_notify(struct ttm_buffer_object *bo,
366 			       struct ttm_mem_reg *new_mem)
367 {
368 	struct qxl_bo *qbo;
369 	struct qxl_device *qdev;
370 
371 	if (!qxl_ttm_bo_is_qxl_bo(bo))
372 		return;
373 	qbo = container_of(bo, struct qxl_bo, tbo);
374 	qdev = qbo->gem_base.dev->dev_private;
375 
376 	if (bo->mem.mem_type == TTM_PL_PRIV0 && qbo->surface_id)
377 		qxl_surface_evict(qdev, qbo, new_mem ? true : false);
378 }
379 
380 static struct ttm_bo_driver qxl_bo_driver = {
381 	.ttm_tt_create = &qxl_ttm_tt_create,
382 	.ttm_tt_populate = &qxl_ttm_tt_populate,
383 	.ttm_tt_unpopulate = &qxl_ttm_tt_unpopulate,
384 	.invalidate_caches = &qxl_invalidate_caches,
385 	.init_mem_type = &qxl_init_mem_type,
386 	.evict_flags = &qxl_evict_flags,
387 	.move = &qxl_bo_move,
388 	.verify_access = &qxl_verify_access,
389 	.io_mem_reserve = &qxl_ttm_io_mem_reserve,
390 	.io_mem_free = &qxl_ttm_io_mem_free,
391 	.move_notify = &qxl_bo_move_notify,
392 };
393 
394 int qxl_ttm_init(struct qxl_device *qdev)
395 {
396 	int r;
397 	int num_io_pages; /* != rom->num_io_pages, we include surface0 */
398 
399 	r = qxl_ttm_global_init(qdev);
400 	if (r)
401 		return r;
402 	/* No others user of address space so set it to 0 */
403 	r = ttm_bo_device_init(&qdev->mman.bdev,
404 			       qdev->mman.bo_global_ref.ref.object,
405 			       &qxl_bo_driver,
406 			       qdev->ddev->anon_inode->i_mapping,
407 			       DRM_FILE_PAGE_OFFSET, 0);
408 	if (r) {
409 		DRM_ERROR("failed initializing buffer object driver(%d).\n", r);
410 		return r;
411 	}
412 	/* NOTE: this includes the framebuffer (aka surface 0) */
413 	num_io_pages = qdev->rom->ram_header_offset / PAGE_SIZE;
414 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_VRAM,
415 			   num_io_pages);
416 	if (r) {
417 		DRM_ERROR("Failed initializing VRAM heap.\n");
418 		return r;
419 	}
420 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_PRIV0,
421 			   qdev->surfaceram_size / PAGE_SIZE);
422 	if (r) {
423 		DRM_ERROR("Failed initializing Surfaces heap.\n");
424 		return r;
425 	}
426 	DRM_INFO("qxl: %uM of VRAM memory size\n",
427 		 (unsigned)qdev->vram_size / (1024 * 1024));
428 	DRM_INFO("qxl: %luM of IO pages memory ready (VRAM domain)\n",
429 		 ((unsigned)num_io_pages * PAGE_SIZE) / (1024 * 1024));
430 	DRM_INFO("qxl: %uM of Surface memory size\n",
431 		 (unsigned)qdev->surfaceram_size / (1024 * 1024));
432 	r = qxl_ttm_debugfs_init(qdev);
433 	if (r) {
434 		DRM_ERROR("Failed to init debugfs\n");
435 		return r;
436 	}
437 	return 0;
438 }
439 
440 void qxl_ttm_fini(struct qxl_device *qdev)
441 {
442 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_VRAM);
443 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_PRIV0);
444 	ttm_bo_device_release(&qdev->mman.bdev);
445 	qxl_ttm_global_fini(qdev);
446 	DRM_INFO("qxl: ttm finalized\n");
447 }
448 
449 
450 #define QXL_DEBUGFS_MEM_TYPES 2
451 
452 #if defined(CONFIG_DEBUG_FS)
453 static int qxl_mm_dump_table(struct seq_file *m, void *data)
454 {
455 	struct drm_info_node *node = (struct drm_info_node *)m->private;
456 	struct drm_mm *mm = (struct drm_mm *)node->info_ent->data;
457 	struct drm_device *dev = node->minor->dev;
458 	struct qxl_device *rdev = dev->dev_private;
459 	int ret;
460 	struct ttm_bo_global *glob = rdev->mman.bdev.glob;
461 
462 	spin_lock(&glob->lru_lock);
463 	ret = drm_mm_dump_table(m, mm);
464 	spin_unlock(&glob->lru_lock);
465 	return ret;
466 }
467 #endif
468 
469 static int qxl_ttm_debugfs_init(struct qxl_device *qdev)
470 {
471 #if defined(CONFIG_DEBUG_FS)
472 	static struct drm_info_list qxl_mem_types_list[QXL_DEBUGFS_MEM_TYPES];
473 	static char qxl_mem_types_names[QXL_DEBUGFS_MEM_TYPES][32];
474 	unsigned i;
475 
476 	for (i = 0; i < QXL_DEBUGFS_MEM_TYPES; i++) {
477 		if (i == 0)
478 			sprintf(qxl_mem_types_names[i], "qxl_mem_mm");
479 		else
480 			sprintf(qxl_mem_types_names[i], "qxl_surf_mm");
481 		qxl_mem_types_list[i].name = qxl_mem_types_names[i];
482 		qxl_mem_types_list[i].show = &qxl_mm_dump_table;
483 		qxl_mem_types_list[i].driver_features = 0;
484 		if (i == 0)
485 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_VRAM].priv;
486 		else
487 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_PRIV0].priv;
488 
489 	}
490 	return qxl_debugfs_add_files(qdev, qxl_mem_types_list, i);
491 #else
492 	return 0;
493 #endif
494 }
495