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 "qxl_drv.h"
 27#include "qxl_object.h"
 28
 29#include <linux/io-mapping.h>
 30static void qxl_ttm_bo_destroy(struct ttm_buffer_object *tbo)
 31{
 32	struct qxl_bo *bo;
 33	struct qxl_device *qdev;
 34
 35	bo = to_qxl_bo(tbo);
 36	qdev = (struct qxl_device *)bo->gem_base.dev->dev_private;
 37
 38	qxl_surface_evict(qdev, bo, false);
 39	mutex_lock(&qdev->gem.mutex);
 40	list_del_init(&bo->list);
 41	mutex_unlock(&qdev->gem.mutex);
 42	drm_gem_object_release(&bo->gem_base);
 43	kfree(bo);
 44}
 45
 46bool qxl_ttm_bo_is_qxl_bo(struct ttm_buffer_object *bo)
 47{
 48	if (bo->destroy == &qxl_ttm_bo_destroy)
 49		return true;
 50	return false;
 51}
 52
 53void qxl_ttm_placement_from_domain(struct qxl_bo *qbo, u32 domain, bool pinned)
 54{
 55	u32 c = 0;
 56	u32 pflag = pinned ? TTM_PL_FLAG_NO_EVICT : 0;
 57	unsigned i;
 58
 59	qbo->placement.placement = qbo->placements;
 60	qbo->placement.busy_placement = qbo->placements;
 61	if (domain == QXL_GEM_DOMAIN_VRAM)
 62		qbo->placements[c++].flags = TTM_PL_FLAG_CACHED | TTM_PL_FLAG_VRAM | pflag;
 63	if (domain == QXL_GEM_DOMAIN_SURFACE)
 64		qbo->placements[c++].flags = TTM_PL_FLAG_CACHED | TTM_PL_FLAG_PRIV | pflag;
 65	if (domain == QXL_GEM_DOMAIN_CPU)
 66		qbo->placements[c++].flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM | pflag;
 67	if (!c)
 68		qbo->placements[c++].flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM;
 69	qbo->placement.num_placement = c;
 70	qbo->placement.num_busy_placement = c;
 71	for (i = 0; i < c; ++i) {
 72		qbo->placements[i].fpfn = 0;
 73		qbo->placements[i].lpfn = 0;
 74	}
 75}
 76
 77
 78int qxl_bo_create(struct qxl_device *qdev,
 79		  unsigned long size, bool kernel, bool pinned, u32 domain,
 80		  struct qxl_surface *surf,
 81		  struct qxl_bo **bo_ptr)
 82{
 83	struct qxl_bo *bo;
 84	enum ttm_bo_type type;
 85	int r;
 86
 87	if (kernel)
 88		type = ttm_bo_type_kernel;
 89	else
 90		type = ttm_bo_type_device;
 91	*bo_ptr = NULL;
 92	bo = kzalloc(sizeof(struct qxl_bo), GFP_KERNEL);
 93	if (bo == NULL)
 94		return -ENOMEM;
 95	size = roundup(size, PAGE_SIZE);
 96	r = drm_gem_object_init(&qdev->ddev, &bo->gem_base, size);
 97	if (unlikely(r)) {
 98		kfree(bo);
 99		return r;
100	}
101	bo->type = domain;
102	bo->pin_count = pinned ? 1 : 0;
103	bo->surface_id = 0;
104	INIT_LIST_HEAD(&bo->list);
105
106	if (surf)
107		bo->surf = *surf;
108
109	qxl_ttm_placement_from_domain(bo, domain, pinned);
110
111	r = ttm_bo_init(&qdev->mman.bdev, &bo->tbo, size, type,
112			&bo->placement, 0, !kernel, size,
113			NULL, NULL, &qxl_ttm_bo_destroy);
114	if (unlikely(r != 0)) {
115		if (r != -ERESTARTSYS)
116			dev_err(qdev->ddev.dev,
117				"object_init failed for (%lu, 0x%08X)\n",
118				size, domain);
119		return r;
120	}
121	*bo_ptr = bo;
122	return 0;
123}
124
125int qxl_bo_kmap(struct qxl_bo *bo, void **ptr)
126{
127	bool is_iomem;
128	int r;
129
130	if (bo->kptr) {
131		if (ptr)
132			*ptr = bo->kptr;
133		return 0;
134	}
135	r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.num_pages, &bo->kmap);
136	if (r)
137		return r;
138	bo->kptr = ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
139	if (ptr)
140		*ptr = bo->kptr;
141	return 0;
142}
143
144void *qxl_bo_kmap_atomic_page(struct qxl_device *qdev,
145			      struct qxl_bo *bo, int page_offset)
146{
147	struct ttm_mem_type_manager *man = &bo->tbo.bdev->man[bo->tbo.mem.mem_type];
148	void *rptr;
149	int ret;
150	struct io_mapping *map;
151
152	if (bo->tbo.mem.mem_type == TTM_PL_VRAM)
153		map = qdev->vram_mapping;
154	else if (bo->tbo.mem.mem_type == TTM_PL_PRIV)
155		map = qdev->surface_mapping;
156	else
157		goto fallback;
158
159	(void) ttm_mem_io_lock(man, false);
160	ret = ttm_mem_io_reserve(bo->tbo.bdev, &bo->tbo.mem);
161	ttm_mem_io_unlock(man);
162
163	return io_mapping_map_atomic_wc(map, bo->tbo.mem.bus.offset + page_offset);
164fallback:
165	if (bo->kptr) {
166		rptr = bo->kptr + (page_offset * PAGE_SIZE);
167		return rptr;
168	}
169
170	ret = qxl_bo_kmap(bo, &rptr);
171	if (ret)
172		return NULL;
173
174	rptr += page_offset * PAGE_SIZE;
175	return rptr;
176}
177
178void qxl_bo_kunmap(struct qxl_bo *bo)
179{
180	if (bo->kptr == NULL)
181		return;
182	bo->kptr = NULL;
183	ttm_bo_kunmap(&bo->kmap);
184}
185
186void qxl_bo_kunmap_atomic_page(struct qxl_device *qdev,
187			       struct qxl_bo *bo, void *pmap)
188{
189	struct ttm_mem_type_manager *man = &bo->tbo.bdev->man[bo->tbo.mem.mem_type];
190	struct io_mapping *map;
191
192	if (bo->tbo.mem.mem_type == TTM_PL_VRAM)
193		map = qdev->vram_mapping;
194	else if (bo->tbo.mem.mem_type == TTM_PL_PRIV)
195		map = qdev->surface_mapping;
196	else
197		goto fallback;
198
199	io_mapping_unmap_atomic(pmap);
200
201	(void) ttm_mem_io_lock(man, false);
202	ttm_mem_io_free(bo->tbo.bdev, &bo->tbo.mem);
203	ttm_mem_io_unlock(man);
204	return ;
205 fallback:
206	qxl_bo_kunmap(bo);
207}
208
209void qxl_bo_unref(struct qxl_bo **bo)
210{
211	if ((*bo) == NULL)
212		return;
213
214	drm_gem_object_put_unlocked(&(*bo)->gem_base);
215	*bo = NULL;
216}
217
218struct qxl_bo *qxl_bo_ref(struct qxl_bo *bo)
219{
220	drm_gem_object_get(&bo->gem_base);
221	return bo;
222}
223
224static int __qxl_bo_pin(struct qxl_bo *bo, u32 domain, u64 *gpu_addr)
225{
226	struct ttm_operation_ctx ctx = { false, false };
227	struct drm_device *ddev = bo->gem_base.dev;
228	int r;
229
230	if (bo->pin_count) {
231		bo->pin_count++;
232		if (gpu_addr)
233			*gpu_addr = qxl_bo_gpu_offset(bo);
234		return 0;
235	}
236	qxl_ttm_placement_from_domain(bo, domain, true);
237	r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
238	if (likely(r == 0)) {
239		bo->pin_count = 1;
240		if (gpu_addr != NULL)
241			*gpu_addr = qxl_bo_gpu_offset(bo);
242	}
243	if (unlikely(r != 0))
244		dev_err(ddev->dev, "%p pin failed\n", bo);
245	return r;
246}
247
248static int __qxl_bo_unpin(struct qxl_bo *bo)
249{
250	struct ttm_operation_ctx ctx = { false, false };
251	struct drm_device *ddev = bo->gem_base.dev;
252	int r, i;
253
254	if (!bo->pin_count) {
255		dev_warn(ddev->dev, "%p unpin not necessary\n", bo);
256		return 0;
257	}
258	bo->pin_count--;
259	if (bo->pin_count)
260		return 0;
261	for (i = 0; i < bo->placement.num_placement; i++)
262		bo->placements[i].flags &= ~TTM_PL_FLAG_NO_EVICT;
263	r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
264	if (unlikely(r != 0))
265		dev_err(ddev->dev, "%p validate failed for unpin\n", bo);
266	return r;
267}
268
269
270/*
271 * Reserve the BO before pinning the object.  If the BO was reserved
272 * beforehand, use the internal version directly __qxl_bo_pin.
273 *
274 */
275int qxl_bo_pin(struct qxl_bo *bo, u32 domain, u64 *gpu_addr)
276{
277	int r;
278
279	r = qxl_bo_reserve(bo, false);
280	if (r)
281		return r;
282
283	r = __qxl_bo_pin(bo, bo->type, NULL);
284	qxl_bo_unreserve(bo);
285	return r;
286}
287
288/*
289 * Reserve the BO before pinning the object.  If the BO was reserved
290 * beforehand, use the internal version directly __qxl_bo_unpin.
291 *
292 */
293int qxl_bo_unpin(struct qxl_bo *bo)
294{
295	int r;
296
297	r = qxl_bo_reserve(bo, false);
298	if (r)
299		return r;
300
301	r = __qxl_bo_unpin(bo);
302	qxl_bo_unreserve(bo);
303	return r;
304}
305
306void qxl_bo_force_delete(struct qxl_device *qdev)
307{
308	struct qxl_bo *bo, *n;
309
310	if (list_empty(&qdev->gem.objects))
311		return;
312	dev_err(qdev->ddev.dev, "Userspace still has active objects !\n");
313	list_for_each_entry_safe(bo, n, &qdev->gem.objects, list) {
314		dev_err(qdev->ddev.dev, "%p %p %lu %lu force free\n",
315			&bo->gem_base, bo, (unsigned long)bo->gem_base.size,
316			*((unsigned long *)&bo->gem_base.refcount));
317		mutex_lock(&qdev->gem.mutex);
318		list_del_init(&bo->list);
319		mutex_unlock(&qdev->gem.mutex);
320		/* this should unref the ttm bo */
321		drm_gem_object_put_unlocked(&bo->gem_base);
322	}
323}
324
325int qxl_bo_init(struct qxl_device *qdev)
326{
327	return qxl_ttm_init(qdev);
328}
329
330void qxl_bo_fini(struct qxl_device *qdev)
331{
332	qxl_ttm_fini(qdev);
333}
334
335int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo)
336{
337	int ret;
338	if (bo->type == QXL_GEM_DOMAIN_SURFACE && bo->surface_id == 0) {
339		/* allocate a surface id for this surface now */
340		ret = qxl_surface_id_alloc(qdev, bo);
341		if (ret)
342			return ret;
343
344		ret = qxl_hw_surface_alloc(qdev, bo, NULL);
345		if (ret)
346			return ret;
347	}
348	return 0;
349}
350
351int qxl_surf_evict(struct qxl_device *qdev)
352{
353	return ttm_bo_evict_mm(&qdev->mman.bdev, TTM_PL_PRIV);
354}
355
356int qxl_vram_evict(struct qxl_device *qdev)
357{
358	return ttm_bo_evict_mm(&qdev->mman.bdev, TTM_PL_VRAM);
359}