xref: /openbmc/linux/drivers/gpu/drm/qxl/qxl_ttm.c (revision bc05aa6e)
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 <drm/ttm/ttm_bo_api.h>
27 #include <drm/ttm/ttm_bo_driver.h>
28 #include <drm/ttm/ttm_placement.h>
29 #include <drm/ttm/ttm_page_alloc.h>
30 #include <drm/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 
39 static struct qxl_device *qxl_get_qdev(struct ttm_bo_device *bdev)
40 {
41 	struct qxl_mman *mman;
42 	struct qxl_device *qdev;
43 
44 	mman = container_of(bdev, struct qxl_mman, bdev);
45 	qdev = container_of(mman, struct qxl_device, mman);
46 	return qdev;
47 }
48 
49 static int qxl_ttm_mem_global_init(struct drm_global_reference *ref)
50 {
51 	return ttm_mem_global_init(ref->object);
52 }
53 
54 static void qxl_ttm_mem_global_release(struct drm_global_reference *ref)
55 {
56 	ttm_mem_global_release(ref->object);
57 }
58 
59 static int qxl_ttm_global_init(struct qxl_device *qdev)
60 {
61 	struct drm_global_reference *global_ref;
62 	int r;
63 
64 	qdev->mman.mem_global_referenced = false;
65 	global_ref = &qdev->mman.mem_global_ref;
66 	global_ref->global_type = DRM_GLOBAL_TTM_MEM;
67 	global_ref->size = sizeof(struct ttm_mem_global);
68 	global_ref->init = &qxl_ttm_mem_global_init;
69 	global_ref->release = &qxl_ttm_mem_global_release;
70 
71 	r = drm_global_item_ref(global_ref);
72 	if (r != 0) {
73 		DRM_ERROR("Failed setting up TTM memory accounting "
74 			  "subsystem.\n");
75 		return r;
76 	}
77 
78 	qdev->mman.bo_global_ref.mem_glob =
79 		qdev->mman.mem_global_ref.object;
80 	global_ref = &qdev->mman.bo_global_ref.ref;
81 	global_ref->global_type = DRM_GLOBAL_TTM_BO;
82 	global_ref->size = sizeof(struct ttm_bo_global);
83 	global_ref->init = &ttm_bo_global_init;
84 	global_ref->release = &ttm_bo_global_release;
85 	r = drm_global_item_ref(global_ref);
86 	if (r != 0) {
87 		DRM_ERROR("Failed setting up TTM BO subsystem.\n");
88 		drm_global_item_unref(&qdev->mman.mem_global_ref);
89 		return r;
90 	}
91 
92 	qdev->mman.mem_global_referenced = true;
93 	return 0;
94 }
95 
96 static void qxl_ttm_global_fini(struct qxl_device *qdev)
97 {
98 	if (qdev->mman.mem_global_referenced) {
99 		drm_global_item_unref(&qdev->mman.bo_global_ref.ref);
100 		drm_global_item_unref(&qdev->mman.mem_global_ref);
101 		qdev->mman.mem_global_referenced = false;
102 	}
103 }
104 
105 static struct vm_operations_struct qxl_ttm_vm_ops;
106 static const struct vm_operations_struct *ttm_vm_ops;
107 
108 static int qxl_ttm_fault(struct vm_fault *vmf)
109 {
110 	struct ttm_buffer_object *bo;
111 	int r;
112 
113 	bo = (struct ttm_buffer_object *)vmf->vma->vm_private_data;
114 	if (bo == NULL)
115 		return VM_FAULT_NOPAGE;
116 	r = ttm_vm_ops->fault(vmf);
117 	return r;
118 }
119 
120 int qxl_mmap(struct file *filp, struct vm_area_struct *vma)
121 {
122 	struct drm_file *file_priv;
123 	struct qxl_device *qdev;
124 	int r;
125 
126 	if (unlikely(vma->vm_pgoff < DRM_FILE_PAGE_OFFSET))
127 		return -EINVAL;
128 
129 	file_priv = filp->private_data;
130 	qdev = file_priv->minor->dev->dev_private;
131 	if (qdev == NULL) {
132 		DRM_ERROR(
133 		 "filp->private_data->minor->dev->dev_private == NULL\n");
134 		return -EINVAL;
135 	}
136 	DRM_DEBUG_DRIVER("filp->private_data = 0x%p, vma->vm_pgoff = %lx\n",
137 		  filp->private_data, vma->vm_pgoff);
138 
139 	r = ttm_bo_mmap(filp, vma, &qdev->mman.bdev);
140 	if (unlikely(r != 0))
141 		return r;
142 	if (unlikely(ttm_vm_ops == NULL)) {
143 		ttm_vm_ops = vma->vm_ops;
144 		qxl_ttm_vm_ops = *ttm_vm_ops;
145 		qxl_ttm_vm_ops.fault = &qxl_ttm_fault;
146 	}
147 	vma->vm_ops = &qxl_ttm_vm_ops;
148 	return 0;
149 }
150 
151 static int qxl_invalidate_caches(struct ttm_bo_device *bdev, uint32_t flags)
152 {
153 	return 0;
154 }
155 
156 static int qxl_init_mem_type(struct ttm_bo_device *bdev, uint32_t type,
157 			     struct ttm_mem_type_manager *man)
158 {
159 	switch (type) {
160 	case TTM_PL_SYSTEM:
161 		/* System memory */
162 		man->flags = TTM_MEMTYPE_FLAG_MAPPABLE;
163 		man->available_caching = TTM_PL_MASK_CACHING;
164 		man->default_caching = TTM_PL_FLAG_CACHED;
165 		break;
166 	case TTM_PL_VRAM:
167 	case TTM_PL_PRIV:
168 		/* "On-card" video ram */
169 		man->func = &ttm_bo_manager_func;
170 		man->gpu_offset = 0;
171 		man->flags = TTM_MEMTYPE_FLAG_FIXED |
172 			     TTM_MEMTYPE_FLAG_MAPPABLE;
173 		man->available_caching = TTM_PL_MASK_CACHING;
174 		man->default_caching = TTM_PL_FLAG_CACHED;
175 		break;
176 	default:
177 		DRM_ERROR("Unsupported memory type %u\n", (unsigned)type);
178 		return -EINVAL;
179 	}
180 	return 0;
181 }
182 
183 static void qxl_evict_flags(struct ttm_buffer_object *bo,
184 				struct ttm_placement *placement)
185 {
186 	struct qxl_bo *qbo;
187 	static const struct ttm_place placements = {
188 		.fpfn = 0,
189 		.lpfn = 0,
190 		.flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM
191 	};
192 
193 	if (!qxl_ttm_bo_is_qxl_bo(bo)) {
194 		placement->placement = &placements;
195 		placement->busy_placement = &placements;
196 		placement->num_placement = 1;
197 		placement->num_busy_placement = 1;
198 		return;
199 	}
200 	qbo = to_qxl_bo(bo);
201 	qxl_ttm_placement_from_domain(qbo, QXL_GEM_DOMAIN_CPU, false);
202 	*placement = qbo->placement;
203 }
204 
205 static int qxl_verify_access(struct ttm_buffer_object *bo, struct file *filp)
206 {
207 	struct qxl_bo *qbo = to_qxl_bo(bo);
208 
209 	return drm_vma_node_verify_access(&qbo->gem_base.vma_node,
210 					  filp->private_data);
211 }
212 
213 static int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
214 				  struct ttm_mem_reg *mem)
215 {
216 	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
217 	struct qxl_device *qdev = qxl_get_qdev(bdev);
218 
219 	mem->bus.addr = NULL;
220 	mem->bus.offset = 0;
221 	mem->bus.size = mem->num_pages << PAGE_SHIFT;
222 	mem->bus.base = 0;
223 	mem->bus.is_iomem = false;
224 	if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
225 		return -EINVAL;
226 	switch (mem->mem_type) {
227 	case TTM_PL_SYSTEM:
228 		/* system memory */
229 		return 0;
230 	case TTM_PL_VRAM:
231 		mem->bus.is_iomem = true;
232 		mem->bus.base = qdev->vram_base;
233 		mem->bus.offset = mem->start << PAGE_SHIFT;
234 		break;
235 	case TTM_PL_PRIV:
236 		mem->bus.is_iomem = true;
237 		mem->bus.base = qdev->surfaceram_base;
238 		mem->bus.offset = mem->start << PAGE_SHIFT;
239 		break;
240 	default:
241 		return -EINVAL;
242 	}
243 	return 0;
244 }
245 
246 static void qxl_ttm_io_mem_free(struct ttm_bo_device *bdev,
247 				struct ttm_mem_reg *mem)
248 {
249 }
250 
251 /*
252  * TTM backend functions.
253  */
254 struct qxl_ttm_tt {
255 	struct ttm_dma_tt		ttm;
256 	struct qxl_device		*qdev;
257 	u64				offset;
258 };
259 
260 static int qxl_ttm_backend_bind(struct ttm_tt *ttm,
261 				struct ttm_mem_reg *bo_mem)
262 {
263 	struct qxl_ttm_tt *gtt = (void *)ttm;
264 
265 	gtt->offset = (unsigned long)(bo_mem->start << PAGE_SHIFT);
266 	if (!ttm->num_pages) {
267 		WARN(1, "nothing to bind %lu pages for mreg %p back %p!\n",
268 		     ttm->num_pages, bo_mem, ttm);
269 	}
270 	/* Not implemented */
271 	return -1;
272 }
273 
274 static int qxl_ttm_backend_unbind(struct ttm_tt *ttm)
275 {
276 	/* Not implemented */
277 	return -1;
278 }
279 
280 static void qxl_ttm_backend_destroy(struct ttm_tt *ttm)
281 {
282 	struct qxl_ttm_tt *gtt = (void *)ttm;
283 
284 	ttm_dma_tt_fini(&gtt->ttm);
285 	kfree(gtt);
286 }
287 
288 static struct ttm_backend_func qxl_backend_func = {
289 	.bind = &qxl_ttm_backend_bind,
290 	.unbind = &qxl_ttm_backend_unbind,
291 	.destroy = &qxl_ttm_backend_destroy,
292 };
293 
294 static int qxl_ttm_tt_populate(struct ttm_tt *ttm,
295 			struct ttm_operation_ctx *ctx)
296 {
297 	int r;
298 
299 	if (ttm->state != tt_unpopulated)
300 		return 0;
301 
302 	r = ttm_pool_populate(ttm, ctx);
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, bool evict,
346 		       struct ttm_operation_ctx *ctx,
347 		       struct ttm_mem_reg *new_mem)
348 {
349 	struct ttm_mem_reg *old_mem = &bo->mem;
350 	int ret;
351 
352 	ret = ttm_bo_wait(bo, ctx->interruptible, ctx->no_wait_gpu);
353 	if (ret)
354 		return ret;
355 
356 
357 	if (old_mem->mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
358 		qxl_move_null(bo, new_mem);
359 		return 0;
360 	}
361 	return ttm_bo_move_memcpy(bo, ctx, new_mem);
362 }
363 
364 static void qxl_bo_move_notify(struct ttm_buffer_object *bo,
365 			       bool evict,
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 = to_qxl_bo(bo);
374 	qdev = qbo->gem_base.dev->dev_private;
375 
376 	if (bo->mem.mem_type == TTM_PL_PRIV && 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 	.eviction_valuable = ttm_bo_eviction_valuable,
387 	.evict_flags = &qxl_evict_flags,
388 	.move = &qxl_bo_move,
389 	.verify_access = &qxl_verify_access,
390 	.io_mem_reserve = &qxl_ttm_io_mem_reserve,
391 	.io_mem_free = &qxl_ttm_io_mem_free,
392 	.move_notify = &qxl_bo_move_notify,
393 };
394 
395 int qxl_ttm_init(struct qxl_device *qdev)
396 {
397 	int r;
398 	int num_io_pages; /* != rom->num_io_pages, we include surface0 */
399 
400 	r = qxl_ttm_global_init(qdev);
401 	if (r)
402 		return r;
403 	/* No others user of address space so set it to 0 */
404 	r = ttm_bo_device_init(&qdev->mman.bdev,
405 			       qdev->mman.bo_global_ref.ref.object,
406 			       &qxl_bo_driver,
407 			       qdev->ddev.anon_inode->i_mapping,
408 			       DRM_FILE_PAGE_OFFSET, 0);
409 	if (r) {
410 		DRM_ERROR("failed initializing buffer object driver(%d).\n", r);
411 		return r;
412 	}
413 	/* NOTE: this includes the framebuffer (aka surface 0) */
414 	num_io_pages = qdev->rom->ram_header_offset / PAGE_SIZE;
415 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_VRAM,
416 			   num_io_pages);
417 	if (r) {
418 		DRM_ERROR("Failed initializing VRAM heap.\n");
419 		return r;
420 	}
421 	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_PRIV,
422 			   qdev->surfaceram_size / PAGE_SIZE);
423 	if (r) {
424 		DRM_ERROR("Failed initializing Surfaces heap.\n");
425 		return r;
426 	}
427 	DRM_INFO("qxl: %uM of VRAM memory size\n",
428 		 (unsigned)qdev->vram_size / (1024 * 1024));
429 	DRM_INFO("qxl: %luM of IO pages memory ready (VRAM domain)\n",
430 		 ((unsigned)num_io_pages * PAGE_SIZE) / (1024 * 1024));
431 	DRM_INFO("qxl: %uM of Surface memory size\n",
432 		 (unsigned)qdev->surfaceram_size / (1024 * 1024));
433 	return 0;
434 }
435 
436 void qxl_ttm_fini(struct qxl_device *qdev)
437 {
438 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_VRAM);
439 	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_PRIV);
440 	ttm_bo_device_release(&qdev->mman.bdev);
441 	qxl_ttm_global_fini(qdev);
442 	DRM_INFO("qxl: ttm finalized\n");
443 }
444 
445 
446 #define QXL_DEBUGFS_MEM_TYPES 2
447 
448 #if defined(CONFIG_DEBUG_FS)
449 static int qxl_mm_dump_table(struct seq_file *m, void *data)
450 {
451 	struct drm_info_node *node = (struct drm_info_node *)m->private;
452 	struct drm_mm *mm = (struct drm_mm *)node->info_ent->data;
453 	struct drm_device *dev = node->minor->dev;
454 	struct qxl_device *rdev = dev->dev_private;
455 	struct ttm_bo_global *glob = rdev->mman.bdev.glob;
456 	struct drm_printer p = drm_seq_file_printer(m);
457 
458 	spin_lock(&glob->lru_lock);
459 	drm_mm_print(mm, &p);
460 	spin_unlock(&glob->lru_lock);
461 	return 0;
462 }
463 #endif
464 
465 int qxl_ttm_debugfs_init(struct qxl_device *qdev)
466 {
467 #if defined(CONFIG_DEBUG_FS)
468 	static struct drm_info_list qxl_mem_types_list[QXL_DEBUGFS_MEM_TYPES];
469 	static char qxl_mem_types_names[QXL_DEBUGFS_MEM_TYPES][32];
470 	unsigned i;
471 
472 	for (i = 0; i < QXL_DEBUGFS_MEM_TYPES; i++) {
473 		if (i == 0)
474 			sprintf(qxl_mem_types_names[i], "qxl_mem_mm");
475 		else
476 			sprintf(qxl_mem_types_names[i], "qxl_surf_mm");
477 		qxl_mem_types_list[i].name = qxl_mem_types_names[i];
478 		qxl_mem_types_list[i].show = &qxl_mm_dump_table;
479 		qxl_mem_types_list[i].driver_features = 0;
480 		if (i == 0)
481 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_VRAM].priv;
482 		else
483 			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_PRIV].priv;
484 
485 	}
486 	return qxl_debugfs_add_files(qdev, qxl_mem_types_list, i);
487 #else
488 	return 0;
489 #endif
490 }
491