xref: /openbmc/linux/drivers/gpu/drm/qxl/qxl_ttm.c (revision 3932b9ca)
1 /*
2  * Copyright 2013 Red Hat 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  * Authors: Dave Airlie
23  *          Alon Levy
24  */
25 
26 #include <ttm/ttm_bo_api.h>
27 #include <ttm/ttm_bo_driver.h>
28 #include <ttm/ttm_placement.h>
29 #include <ttm/ttm_page_alloc.h>
30 #include <ttm/ttm_module.h>
31 #include <drm/drmP.h>
32 #include <drm/drm.h>
33 #include <drm/qxl_drm.h>
34 #include "qxl_drv.h"
35 #include "qxl_object.h"
36 
37 #include <linux/delay.h>
38 static int qxl_ttm_debugfs_init(struct qxl_device *qdev);
39 
40 static struct qxl_device *qxl_get_qdev(struct ttm_bo_device *bdev)
41 {
42 	struct qxl_mman *mman;
43 	struct qxl_device *qdev;
44 
45 	mman = container_of(bdev, struct qxl_mman, bdev);
46 	qdev = container_of(mman, struct qxl_device, mman);
47 	return qdev;
48 }
49 
50 static int qxl_ttm_mem_global_init(struct drm_global_reference *ref)
51 {
52 	return ttm_mem_global_init(ref->object);
53 }
54 
55 static void qxl_ttm_mem_global_release(struct drm_global_reference *ref)
56 {
57 	ttm_mem_global_release(ref->object);
58 }
59 
60 static int qxl_ttm_global_init(struct qxl_device *qdev)
61 {
62 	struct drm_global_reference *global_ref;
63 	int r;
64 
65 	qdev->mman.mem_global_referenced = false;
66 	global_ref = &qdev->mman.mem_global_ref;
67 	global_ref->global_type = DRM_GLOBAL_TTM_MEM;
68 	global_ref->size = sizeof(struct ttm_mem_global);
69 	global_ref->init = &qxl_ttm_mem_global_init;
70 	global_ref->release = &qxl_ttm_mem_global_release;
71 
72 	r = drm_global_item_ref(global_ref);
73 	if (r != 0) {
74 		DRM_ERROR("Failed setting up TTM memory accounting "
75 			  "subsystem.\n");
76 		return r;
77 	}
78 
79 	qdev->mman.bo_global_ref.mem_glob =
80 		qdev->mman.mem_global_ref.object;
81 	global_ref = &qdev->mman.bo_global_ref.ref;
82 	global_ref->global_type = DRM_GLOBAL_TTM_BO;
83 	global_ref->size = sizeof(struct ttm_bo_global);
84 	global_ref->init = &ttm_bo_global_init;
85 	global_ref->release = &ttm_bo_global_release;
86 	r = drm_global_item_ref(global_ref);
87 	if (r != 0) {
88 		DRM_ERROR("Failed setting up TTM BO subsystem.\n");
89 		drm_global_item_unref(&qdev->mman.mem_global_ref);
90 		return r;
91 	}
92 
93 	qdev->mman.mem_global_referenced = true;
94 	return 0;
95 }
96 
97 static void qxl_ttm_global_fini(struct qxl_device *qdev)
98 {
99 	if (qdev->mman.mem_global_referenced) {
100 		drm_global_item_unref(&qdev->mman.bo_global_ref.ref);
101 		drm_global_item_unref(&qdev->mman.mem_global_ref);
102 		qdev->mman.mem_global_referenced = false;
103 	}
104 }
105 
106 static struct vm_operations_struct qxl_ttm_vm_ops;
107 static const struct vm_operations_struct *ttm_vm_ops;
108 
109 static int qxl_ttm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
110 {
111 	struct ttm_buffer_object *bo;
112 	int r;
113 
114 	bo = (struct ttm_buffer_object *)vma->vm_private_data;
115 	if (bo == NULL)
116 		return VM_FAULT_NOPAGE;
117 	r = ttm_vm_ops->fault(vma, vmf);
118 	return r;
119 }
120 
121 int qxl_mmap(struct file *filp, struct vm_area_struct *vma)
122 {
123 	struct drm_file *file_priv;
124 	struct qxl_device *qdev;
125 	int r;
126 
127 	if (unlikely(vma->vm_pgoff < DRM_FILE_PAGE_OFFSET)) {
128 		pr_info("%s: vma->vm_pgoff (%ld) < DRM_FILE_PAGE_OFFSET\n",
129 			__func__, vma->vm_pgoff);
130 		return drm_mmap(filp, vma);
131 	}
132 
133 	file_priv = filp->private_data;
134 	qdev = file_priv->minor->dev->dev_private;
135 	if (qdev == NULL) {
136 		DRM_ERROR(
137 		 "filp->private_data->minor->dev->dev_private == NULL\n");
138 		return -EINVAL;
139 	}
140 	QXL_INFO(qdev, "%s: filp->private_data = 0x%p, vma->vm_pgoff = %lx\n",
141 		 __func__, filp->private_data, vma->vm_pgoff);
142 
143 	r = ttm_bo_mmap(filp, vma, &qdev->mman.bdev);
144 	if (unlikely(r != 0))
145 		return r;
146 	if (unlikely(ttm_vm_ops == NULL)) {
147 		ttm_vm_ops = vma->vm_ops;
148 		qxl_ttm_vm_ops = *ttm_vm_ops;
149 		qxl_ttm_vm_ops.fault = &qxl_ttm_fault;
150 	}
151 	vma->vm_ops = &qxl_ttm_vm_ops;
152 	return 0;
153 }
154 
155 static int qxl_invalidate_caches(struct ttm_bo_device *bdev, uint32_t flags)
156 {
157 	return 0;
158 }
159 
160 static int qxl_init_mem_type(struct ttm_bo_device *bdev, uint32_t type,
161 			     struct ttm_mem_type_manager *man)
162 {
163 	switch (type) {
164 	case TTM_PL_SYSTEM:
165 		/* System memory */
166 		man->flags = TTM_MEMTYPE_FLAG_MAPPABLE;
167 		man->available_caching = TTM_PL_MASK_CACHING;
168 		man->default_caching = TTM_PL_FLAG_CACHED;
169 		break;
170 	case TTM_PL_VRAM:
171 	case TTM_PL_PRIV0:
172 		/* "On-card" video ram */
173 		man->func = &ttm_bo_manager_func;
174 		man->gpu_offset = 0;
175 		man->flags = TTM_MEMTYPE_FLAG_FIXED |
176 			     TTM_MEMTYPE_FLAG_MAPPABLE;
177 		man->available_caching = TTM_PL_MASK_CACHING;
178 		man->default_caching = TTM_PL_FLAG_CACHED;
179 		break;
180 	default:
181 		DRM_ERROR("Unsupported memory type %u\n", (unsigned)type);
182 		return -EINVAL;
183 	}
184 	return 0;
185 }
186 
187 static void qxl_evict_flags(struct ttm_buffer_object *bo,
188 				struct ttm_placement *placement)
189 {
190 	struct qxl_bo *qbo;
191 	static u32 placements = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM;
192 
193 	if (!qxl_ttm_bo_is_qxl_bo(bo)) {
194 		placement->fpfn = 0;
195 		placement->lpfn = 0;
196 		placement->placement = &placements;
197 		placement->busy_placement = &placements;
198 		placement->num_placement = 1;
199 		placement->num_busy_placement = 1;
200 		return;
201 	}
202 	qbo = container_of(bo, struct qxl_bo, tbo);
203 	qxl_ttm_placement_from_domain(qbo, QXL_GEM_DOMAIN_CPU, false);
204 	*placement = qbo->placement;
205 }
206 
207 static int qxl_verify_access(struct ttm_buffer_object *bo, struct file *filp)
208 {
209 	struct qxl_bo *qbo = to_qxl_bo(bo);
210 
211 	return drm_vma_node_verify_access(&qbo->gem_base.vma_node, filp);
212 }
213 
214 static int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
215 				  struct ttm_mem_reg *mem)
216 {
217 	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
218 	struct qxl_device *qdev = qxl_get_qdev(bdev);
219 
220 	mem->bus.addr = NULL;
221 	mem->bus.offset = 0;
222 	mem->bus.size = mem->num_pages << PAGE_SHIFT;
223 	mem->bus.base = 0;
224 	mem->bus.is_iomem = false;
225 	if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
226 		return -EINVAL;
227 	switch (mem->mem_type) {
228 	case TTM_PL_SYSTEM:
229 		/* system memory */
230 		return 0;
231 	case TTM_PL_VRAM:
232 		mem->bus.is_iomem = true;
233 		mem->bus.base = qdev->vram_base;
234 		mem->bus.offset = mem->start << PAGE_SHIFT;
235 		break;
236 	case TTM_PL_PRIV0:
237 		mem->bus.is_iomem = true;
238 		mem->bus.base = qdev->surfaceram_base;
239 		mem->bus.offset = mem->start << PAGE_SHIFT;
240 		break;
241 	default:
242 		return -EINVAL;
243 	}
244 	return 0;
245 }
246 
247 static void qxl_ttm_io_mem_free(struct ttm_bo_device *bdev,
248 				struct ttm_mem_reg *mem)
249 {
250 }
251 
252 /*
253  * TTM backend functions.
254  */
255 struct qxl_ttm_tt {
256 	struct ttm_dma_tt		ttm;
257 	struct qxl_device		*qdev;
258 	u64				offset;
259 };
260 
261 static int qxl_ttm_backend_bind(struct ttm_tt *ttm,
262 				struct ttm_mem_reg *bo_mem)
263 {
264 	struct qxl_ttm_tt *gtt = (void *)ttm;
265 
266 	gtt->offset = (unsigned long)(bo_mem->start << PAGE_SHIFT);
267 	if (!ttm->num_pages) {
268 		WARN(1, "nothing to bind %lu pages for mreg %p back %p!\n",
269 		     ttm->num_pages, bo_mem, ttm);
270 	}
271 	/* Not implemented */
272 	return -1;
273 }
274 
275 static int qxl_ttm_backend_unbind(struct ttm_tt *ttm)
276 {
277 	/* Not implemented */
278 	return -1;
279 }
280 
281 static void qxl_ttm_backend_destroy(struct ttm_tt *ttm)
282 {
283 	struct qxl_ttm_tt *gtt = (void *)ttm;
284 
285 	ttm_dma_tt_fini(&gtt->ttm);
286 	kfree(gtt);
287 }
288 
289 static struct ttm_backend_func qxl_backend_func = {
290 	.bind = &qxl_ttm_backend_bind,
291 	.unbind = &qxl_ttm_backend_unbind,
292 	.destroy = &qxl_ttm_backend_destroy,
293 };
294 
295 static int qxl_ttm_tt_populate(struct ttm_tt *ttm)
296 {
297 	int r;
298 
299 	if (ttm->state != tt_unpopulated)
300 		return 0;
301 
302 	r = ttm_pool_populate(ttm);
303 	if (r)
304 		return r;
305 
306 	return 0;
307 }
308 
309 static void qxl_ttm_tt_unpopulate(struct ttm_tt *ttm)
310 {
311 	ttm_pool_unpopulate(ttm);
312 }
313 
314 static struct ttm_tt *qxl_ttm_tt_create(struct ttm_bo_device *bdev,
315 					unsigned long size, uint32_t page_flags,
316 					struct page *dummy_read_page)
317 {
318 	struct qxl_device *qdev;
319 	struct qxl_ttm_tt *gtt;
320 
321 	qdev = qxl_get_qdev(bdev);
322 	gtt = kzalloc(sizeof(struct qxl_ttm_tt), GFP_KERNEL);
323 	if (gtt == NULL)
324 		return NULL;
325 	gtt->ttm.ttm.func = &qxl_backend_func;
326 	gtt->qdev = qdev;
327 	if (ttm_dma_tt_init(&gtt->ttm, bdev, size, page_flags,
328 			    dummy_read_page)) {
329 		kfree(gtt);
330 		return NULL;
331 	}
332 	return &gtt->ttm.ttm;
333 }
334 
335 static void qxl_move_null(struct ttm_buffer_object *bo,
336 			     struct ttm_mem_reg *new_mem)
337 {
338 	struct ttm_mem_reg *old_mem = &bo->mem;
339 
340 	BUG_ON(old_mem->mm_node != NULL);
341 	*old_mem = *new_mem;
342 	new_mem->mm_node = NULL;
343 }
344 
345 static int qxl_bo_move(struct ttm_buffer_object *bo,
346 		       bool evict, bool interruptible,
347 		       bool no_wait_gpu,
348 		       struct ttm_mem_reg *new_mem)
349 {
350 	struct ttm_mem_reg *old_mem = &bo->mem;
351 	if (old_mem->mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
352 		qxl_move_null(bo, new_mem);
353 		return 0;
354 	}
355 	return ttm_bo_move_memcpy(bo, evict, no_wait_gpu, new_mem);
356 }
357 
358 
359 static int qxl_sync_obj_wait(void *sync_obj,
360 			     bool lazy, bool interruptible)
361 {
362 	struct qxl_fence *qfence = (struct qxl_fence *)sync_obj;
363 	int count = 0, sc = 0;
364 	struct qxl_bo *bo = container_of(qfence, struct qxl_bo, fence);
365 
366 	if (qfence->num_active_releases == 0)
367 		return 0;
368 
369 retry:
370 	if (sc == 0) {
371 		if (bo->type == QXL_GEM_DOMAIN_SURFACE)
372 			qxl_update_surface(qfence->qdev, bo);
373 	} else if (sc >= 1) {
374 		qxl_io_notify_oom(qfence->qdev);
375 	}
376 
377 	sc++;
378 
379 	for (count = 0; count < 10; count++) {
380 		bool ret;
381 		ret = qxl_queue_garbage_collect(qfence->qdev, true);
382 		if (ret == false)
383 			break;
384 
385 		if (qfence->num_active_releases == 0)
386 			return 0;
387 	}
388 
389 	if (qfence->num_active_releases) {
390 		bool have_drawable_releases = false;
391 		void **slot;
392 		struct radix_tree_iter iter;
393 		int release_id;
394 
395 		radix_tree_for_each_slot(slot, &qfence->tree, &iter, 0) {
396 			struct qxl_release *release;
397 
398 			release_id = iter.index;
399 			release = qxl_release_from_id_locked(qfence->qdev, release_id);
400 			if (release == NULL)
401 				continue;
402 
403 			if (release->type == QXL_RELEASE_DRAWABLE)
404 				have_drawable_releases = true;
405 		}
406 
407 		qxl_queue_garbage_collect(qfence->qdev, true);
408 
409 		if (have_drawable_releases || sc < 4) {
410 			if (sc > 2)
411 				/* back off */
412 				usleep_range(500, 1000);
413 			if (have_drawable_releases && sc > 300) {
414 				WARN(1, "sync obj %d still has outstanding releases %d %d %d %ld %d\n", sc, bo->surface_id, bo->is_primary, bo->pin_count, (unsigned long)bo->gem_base.size, qfence->num_active_releases);
415 				return -EBUSY;
416 			}
417 			goto retry;
418 		}
419 	}
420 	return 0;
421 }
422 
423 static int qxl_sync_obj_flush(void *sync_obj)
424 {
425 	return 0;
426 }
427 
428 static void qxl_sync_obj_unref(void **sync_obj)
429 {
430 	*sync_obj = NULL;
431 }
432 
433 static void *qxl_sync_obj_ref(void *sync_obj)
434 {
435 	return sync_obj;
436 }
437 
438 static bool qxl_sync_obj_signaled(void *sync_obj)
439 {
440 	struct qxl_fence *qfence = (struct qxl_fence *)sync_obj;
441 	return (qfence->num_active_releases == 0);
442 }
443 
444 static void qxl_bo_move_notify(struct ttm_buffer_object *bo,
445 			       struct ttm_mem_reg *new_mem)
446 {
447 	struct qxl_bo *qbo;
448 	struct qxl_device *qdev;
449 
450 	if (!qxl_ttm_bo_is_qxl_bo(bo))
451 		return;
452 	qbo = container_of(bo, struct qxl_bo, tbo);
453 	qdev = qbo->gem_base.dev->dev_private;
454 
455 	if (bo->mem.mem_type == TTM_PL_PRIV0 && qbo->surface_id)
456 		qxl_surface_evict(qdev, qbo, new_mem ? true : false);
457 }
458 
459 static struct ttm_bo_driver qxl_bo_driver = {
460 	.ttm_tt_create = &qxl_ttm_tt_create,
461 	.ttm_tt_populate = &qxl_ttm_tt_populate,
462 	.ttm_tt_unpopulate = &qxl_ttm_tt_unpopulate,
463 	.invalidate_caches = &qxl_invalidate_caches,
464 	.init_mem_type = &qxl_init_mem_type,
465 	.evict_flags = &qxl_evict_flags,
466 	.move = &qxl_bo_move,
467 	.verify_access = &qxl_verify_access,
468 	.io_mem_reserve = &qxl_ttm_io_mem_reserve,
469 	.io_mem_free = &qxl_ttm_io_mem_free,
470 	.sync_obj_signaled = &qxl_sync_obj_signaled,
471 	.sync_obj_wait = &qxl_sync_obj_wait,
472 	.sync_obj_flush = &qxl_sync_obj_flush,
473 	.sync_obj_unref = &qxl_sync_obj_unref,
474 	.sync_obj_ref = &qxl_sync_obj_ref,
475 	.move_notify = &qxl_bo_move_notify,
476 };
477 
478 
479 
480 int qxl_ttm_init(struct qxl_device *qdev)
481 {
482 	int r;
483 	int num_io_pages; /* != rom->num_io_pages, we include surface0 */
484 
485 	r = qxl_ttm_global_init(qdev);
486 	if (r)
487 		return r;
488 	/* No others user of address space so set it to 0 */
489 	r = ttm_bo_device_init(&qdev->mman.bdev,
490 			       qdev->mman.bo_global_ref.ref.object,
491 			       &qxl_bo_driver,
492 			       qdev->ddev->anon_inode->i_mapping,
493 			       DRM_FILE_PAGE_OFFSET, 0);
494 	if (r) {
495 		DRM_ERROR("failed initializing buffer object driver(%d).\n", r);
496 		return r;
497 	}
498 	/* NOTE: this includes the framebuffer (aka surface 0) */
499 	num_io_pages = qdev->rom->ram_header_offset / PAGE_SIZE;
500 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_VRAM,
501 			   num_io_pages);
502 	if (r) {
503 		DRM_ERROR("Failed initializing VRAM heap.\n");
504 		return r;
505 	}
506 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_PRIV0,
507 			   qdev->surfaceram_size / PAGE_SIZE);
508 	if (r) {
509 		DRM_ERROR("Failed initializing Surfaces heap.\n");
510 		return r;
511 	}
512 	DRM_INFO("qxl: %uM of VRAM memory size\n",
513 		 (unsigned)qdev->vram_size / (1024 * 1024));
514 	DRM_INFO("qxl: %luM of IO pages memory ready (VRAM domain)\n",
515 		 ((unsigned)num_io_pages * PAGE_SIZE) / (1024 * 1024));
516 	DRM_INFO("qxl: %uM of Surface memory size\n",
517 		 (unsigned)qdev->surfaceram_size / (1024 * 1024));
518 	r = qxl_ttm_debugfs_init(qdev);
519 	if (r) {
520 		DRM_ERROR("Failed to init debugfs\n");
521 		return r;
522 	}
523 	return 0;
524 }
525 
526 void qxl_ttm_fini(struct qxl_device *qdev)
527 {
528 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_VRAM);
529 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_PRIV0);
530 	ttm_bo_device_release(&qdev->mman.bdev);
531 	qxl_ttm_global_fini(qdev);
532 	DRM_INFO("qxl: ttm finalized\n");
533 }
534 
535 
536 #define QXL_DEBUGFS_MEM_TYPES 2
537 
538 #if defined(CONFIG_DEBUG_FS)
539 static int qxl_mm_dump_table(struct seq_file *m, void *data)
540 {
541 	struct drm_info_node *node = (struct drm_info_node *)m->private;
542 	struct drm_mm *mm = (struct drm_mm *)node->info_ent->data;
543 	struct drm_device *dev = node->minor->dev;
544 	struct qxl_device *rdev = dev->dev_private;
545 	int ret;
546 	struct ttm_bo_global *glob = rdev->mman.bdev.glob;
547 
548 	spin_lock(&glob->lru_lock);
549 	ret = drm_mm_dump_table(m, mm);
550 	spin_unlock(&glob->lru_lock);
551 	return ret;
552 }
553 #endif
554 
555 static int qxl_ttm_debugfs_init(struct qxl_device *qdev)
556 {
557 #if defined(CONFIG_DEBUG_FS)
558 	static struct drm_info_list qxl_mem_types_list[QXL_DEBUGFS_MEM_TYPES];
559 	static char qxl_mem_types_names[QXL_DEBUGFS_MEM_TYPES][32];
560 	unsigned i;
561 
562 	for (i = 0; i < QXL_DEBUGFS_MEM_TYPES; i++) {
563 		if (i == 0)
564 			sprintf(qxl_mem_types_names[i], "qxl_mem_mm");
565 		else
566 			sprintf(qxl_mem_types_names[i], "qxl_surf_mm");
567 		qxl_mem_types_list[i].name = qxl_mem_types_names[i];
568 		qxl_mem_types_list[i].show = &qxl_mm_dump_table;
569 		qxl_mem_types_list[i].driver_features = 0;
570 		if (i == 0)
571 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_VRAM].priv;
572 		else
573 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_PRIV0].priv;
574 
575 	}
576 	return qxl_debugfs_add_files(qdev, qxl_mem_types_list, i);
577 #else
578 	return 0;
579 #endif
580 }
581