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>
38static int qxl_ttm_debugfs_init(struct qxl_device *qdev);
39
40static 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
50static int qxl_ttm_mem_global_init(struct drm_global_reference *ref)
51{
52	return ttm_mem_global_init(ref->object);
53}
54
55static void qxl_ttm_mem_global_release(struct drm_global_reference *ref)
56{
57	ttm_mem_global_release(ref->object);
58}
59
60static 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
97static 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
106static struct vm_operations_struct qxl_ttm_vm_ops;
107static const struct vm_operations_struct *ttm_vm_ops;
108
109static 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
121int 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 -EINVAL;
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
155static int qxl_invalidate_caches(struct ttm_bo_device *bdev, uint32_t flags)
156{
157	return 0;
158}
159
160static 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
187static void qxl_evict_flags(struct ttm_buffer_object *bo,
188				struct ttm_placement *placement)
189{
190	struct qxl_bo *qbo;
191	static struct ttm_place placements = {
192		.fpfn = 0,
193		.lpfn = 0,
194		.flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM
195	};
196
197	if (!qxl_ttm_bo_is_qxl_bo(bo)) {
198		placement->placement = &placements;
199		placement->busy_placement = &placements;
200		placement->num_placement = 1;
201		placement->num_busy_placement = 1;
202		return;
203	}
204	qbo = container_of(bo, struct qxl_bo, tbo);
205	qxl_ttm_placement_from_domain(qbo, QXL_GEM_DOMAIN_CPU, false);
206	*placement = qbo->placement;
207}
208
209static int qxl_verify_access(struct ttm_buffer_object *bo, struct file *filp)
210{
211	struct qxl_bo *qbo = to_qxl_bo(bo);
212
213	return drm_vma_node_verify_access(&qbo->gem_base.vma_node, filp);
214}
215
216static int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
217				  struct ttm_mem_reg *mem)
218{
219	struct ttm_mem_type_manager *man = &bdev->man[mem->mem_type];
220	struct qxl_device *qdev = qxl_get_qdev(bdev);
221
222	mem->bus.addr = NULL;
223	mem->bus.offset = 0;
224	mem->bus.size = mem->num_pages << PAGE_SHIFT;
225	mem->bus.base = 0;
226	mem->bus.is_iomem = false;
227	if (!(man->flags & TTM_MEMTYPE_FLAG_MAPPABLE))
228		return -EINVAL;
229	switch (mem->mem_type) {
230	case TTM_PL_SYSTEM:
231		/* system memory */
232		return 0;
233	case TTM_PL_VRAM:
234		mem->bus.is_iomem = true;
235		mem->bus.base = qdev->vram_base;
236		mem->bus.offset = mem->start << PAGE_SHIFT;
237		break;
238	case TTM_PL_PRIV0:
239		mem->bus.is_iomem = true;
240		mem->bus.base = qdev->surfaceram_base;
241		mem->bus.offset = mem->start << PAGE_SHIFT;
242		break;
243	default:
244		return -EINVAL;
245	}
246	return 0;
247}
248
249static void qxl_ttm_io_mem_free(struct ttm_bo_device *bdev,
250				struct ttm_mem_reg *mem)
251{
252}
253
254/*
255 * TTM backend functions.
256 */
257struct qxl_ttm_tt {
258	struct ttm_dma_tt		ttm;
259	struct qxl_device		*qdev;
260	u64				offset;
261};
262
263static int qxl_ttm_backend_bind(struct ttm_tt *ttm,
264				struct ttm_mem_reg *bo_mem)
265{
266	struct qxl_ttm_tt *gtt = (void *)ttm;
267
268	gtt->offset = (unsigned long)(bo_mem->start << PAGE_SHIFT);
269	if (!ttm->num_pages) {
270		WARN(1, "nothing to bind %lu pages for mreg %p back %p!\n",
271		     ttm->num_pages, bo_mem, ttm);
272	}
273	/* Not implemented */
274	return -1;
275}
276
277static int qxl_ttm_backend_unbind(struct ttm_tt *ttm)
278{
279	/* Not implemented */
280	return -1;
281}
282
283static void qxl_ttm_backend_destroy(struct ttm_tt *ttm)
284{
285	struct qxl_ttm_tt *gtt = (void *)ttm;
286
287	ttm_dma_tt_fini(&gtt->ttm);
288	kfree(gtt);
289}
290
291static struct ttm_backend_func qxl_backend_func = {
292	.bind = &qxl_ttm_backend_bind,
293	.unbind = &qxl_ttm_backend_unbind,
294	.destroy = &qxl_ttm_backend_destroy,
295};
296
297static int qxl_ttm_tt_populate(struct ttm_tt *ttm)
298{
299	int r;
300
301	if (ttm->state != tt_unpopulated)
302		return 0;
303
304	r = ttm_pool_populate(ttm);
305	if (r)
306		return r;
307
308	return 0;
309}
310
311static void qxl_ttm_tt_unpopulate(struct ttm_tt *ttm)
312{
313	ttm_pool_unpopulate(ttm);
314}
315
316static struct ttm_tt *qxl_ttm_tt_create(struct ttm_bo_device *bdev,
317					unsigned long size, uint32_t page_flags,
318					struct page *dummy_read_page)
319{
320	struct qxl_device *qdev;
321	struct qxl_ttm_tt *gtt;
322
323	qdev = qxl_get_qdev(bdev);
324	gtt = kzalloc(sizeof(struct qxl_ttm_tt), GFP_KERNEL);
325	if (gtt == NULL)
326		return NULL;
327	gtt->ttm.ttm.func = &qxl_backend_func;
328	gtt->qdev = qdev;
329	if (ttm_dma_tt_init(&gtt->ttm, bdev, size, page_flags,
330			    dummy_read_page)) {
331		kfree(gtt);
332		return NULL;
333	}
334	return &gtt->ttm.ttm;
335}
336
337static void qxl_move_null(struct ttm_buffer_object *bo,
338			     struct ttm_mem_reg *new_mem)
339{
340	struct ttm_mem_reg *old_mem = &bo->mem;
341
342	BUG_ON(old_mem->mm_node != NULL);
343	*old_mem = *new_mem;
344	new_mem->mm_node = NULL;
345}
346
347static int qxl_bo_move(struct ttm_buffer_object *bo,
348		       bool evict, bool interruptible,
349		       bool no_wait_gpu,
350		       struct ttm_mem_reg *new_mem)
351{
352	struct ttm_mem_reg *old_mem = &bo->mem;
353	if (old_mem->mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
354		qxl_move_null(bo, new_mem);
355		return 0;
356	}
357	return ttm_bo_move_memcpy(bo, evict, no_wait_gpu, new_mem);
358}
359
360static void qxl_bo_move_notify(struct ttm_buffer_object *bo,
361			       struct ttm_mem_reg *new_mem)
362{
363	struct qxl_bo *qbo;
364	struct qxl_device *qdev;
365
366	if (!qxl_ttm_bo_is_qxl_bo(bo))
367		return;
368	qbo = container_of(bo, struct qxl_bo, tbo);
369	qdev = qbo->gem_base.dev->dev_private;
370
371	if (bo->mem.mem_type == TTM_PL_PRIV0 && qbo->surface_id)
372		qxl_surface_evict(qdev, qbo, new_mem ? true : false);
373}
374
375static struct ttm_bo_driver qxl_bo_driver = {
376	.ttm_tt_create = &qxl_ttm_tt_create,
377	.ttm_tt_populate = &qxl_ttm_tt_populate,
378	.ttm_tt_unpopulate = &qxl_ttm_tt_unpopulate,
379	.invalidate_caches = &qxl_invalidate_caches,
380	.init_mem_type = &qxl_init_mem_type,
381	.evict_flags = &qxl_evict_flags,
382	.move = &qxl_bo_move,
383	.verify_access = &qxl_verify_access,
384	.io_mem_reserve = &qxl_ttm_io_mem_reserve,
385	.io_mem_free = &qxl_ttm_io_mem_free,
386	.move_notify = &qxl_bo_move_notify,
387};
388
389int qxl_ttm_init(struct qxl_device *qdev)
390{
391	int r;
392	int num_io_pages; /* != rom->num_io_pages, we include surface0 */
393
394	r = qxl_ttm_global_init(qdev);
395	if (r)
396		return r;
397	/* No others user of address space so set it to 0 */
398	r = ttm_bo_device_init(&qdev->mman.bdev,
399			       qdev->mman.bo_global_ref.ref.object,
400			       &qxl_bo_driver,
401			       qdev->ddev->anon_inode->i_mapping,
402			       DRM_FILE_PAGE_OFFSET, 0);
403	if (r) {
404		DRM_ERROR("failed initializing buffer object driver(%d).\n", r);
405		return r;
406	}
407	/* NOTE: this includes the framebuffer (aka surface 0) */
408	num_io_pages = qdev->rom->ram_header_offset / PAGE_SIZE;
409	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_VRAM,
410			   num_io_pages);
411	if (r) {
412		DRM_ERROR("Failed initializing VRAM heap.\n");
413		return r;
414	}
415	r = ttm_bo_init_mm(&qdev->mman.bdev, TTM_PL_PRIV0,
416			   qdev->surfaceram_size / PAGE_SIZE);
417	if (r) {
418		DRM_ERROR("Failed initializing Surfaces heap.\n");
419		return r;
420	}
421	DRM_INFO("qxl: %uM of VRAM memory size\n",
422		 (unsigned)qdev->vram_size / (1024 * 1024));
423	DRM_INFO("qxl: %luM of IO pages memory ready (VRAM domain)\n",
424		 ((unsigned)num_io_pages * PAGE_SIZE) / (1024 * 1024));
425	DRM_INFO("qxl: %uM of Surface memory size\n",
426		 (unsigned)qdev->surfaceram_size / (1024 * 1024));
427	r = qxl_ttm_debugfs_init(qdev);
428	if (r) {
429		DRM_ERROR("Failed to init debugfs\n");
430		return r;
431	}
432	return 0;
433}
434
435void qxl_ttm_fini(struct qxl_device *qdev)
436{
437	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_VRAM);
438	ttm_bo_clean_mm(&qdev->mman.bdev, TTM_PL_PRIV0);
439	ttm_bo_device_release(&qdev->mman.bdev);
440	qxl_ttm_global_fini(qdev);
441	DRM_INFO("qxl: ttm finalized\n");
442}
443
444
445#define QXL_DEBUGFS_MEM_TYPES 2
446
447#if defined(CONFIG_DEBUG_FS)
448static int qxl_mm_dump_table(struct seq_file *m, void *data)
449{
450	struct drm_info_node *node = (struct drm_info_node *)m->private;
451	struct drm_mm *mm = (struct drm_mm *)node->info_ent->data;
452	struct drm_device *dev = node->minor->dev;
453	struct qxl_device *rdev = dev->dev_private;
454	int ret;
455	struct ttm_bo_global *glob = rdev->mman.bdev.glob;
456
457	spin_lock(&glob->lru_lock);
458	ret = drm_mm_dump_table(m, mm);
459	spin_unlock(&glob->lru_lock);
460	return ret;
461}
462#endif
463
464static int qxl_ttm_debugfs_init(struct qxl_device *qdev)
465{
466#if defined(CONFIG_DEBUG_FS)
467	static struct drm_info_list qxl_mem_types_list[QXL_DEBUGFS_MEM_TYPES];
468	static char qxl_mem_types_names[QXL_DEBUGFS_MEM_TYPES][32];
469	unsigned i;
470
471	for (i = 0; i < QXL_DEBUGFS_MEM_TYPES; i++) {
472		if (i == 0)
473			sprintf(qxl_mem_types_names[i], "qxl_mem_mm");
474		else
475			sprintf(qxl_mem_types_names[i], "qxl_surf_mm");
476		qxl_mem_types_list[i].name = qxl_mem_types_names[i];
477		qxl_mem_types_list[i].show = &qxl_mm_dump_table;
478		qxl_mem_types_list[i].driver_features = 0;
479		if (i == 0)
480			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_VRAM].priv;
481		else
482			qxl_mem_types_list[i].data = qdev->mman.bdev.man[TTM_PL_PRIV0].priv;
483
484	}
485	return qxl_debugfs_add_files(qdev, qxl_mem_types_list, i);
486#else
487	return 0;
488#endif
489}
490