xref: /openbmc/linux/drivers/gpu/drm/qxl/qxl_ioctl.c (revision 7b6d864b)
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 /*
30  * TODO: allocating a new gem(in qxl_bo) for each request.
31  * This is wasteful since bo's are page aligned.
32  */
33 static int qxl_alloc_ioctl(struct drm_device *dev, void *data,
34 			   struct drm_file *file_priv)
35 {
36 	struct qxl_device *qdev = dev->dev_private;
37 	struct drm_qxl_alloc *qxl_alloc = data;
38 	int ret;
39 	struct qxl_bo *qobj;
40 	uint32_t handle;
41 	u32 domain = QXL_GEM_DOMAIN_VRAM;
42 
43 	if (qxl_alloc->size == 0) {
44 		DRM_ERROR("invalid size %d\n", qxl_alloc->size);
45 		return -EINVAL;
46 	}
47 	ret = qxl_gem_object_create_with_handle(qdev, file_priv,
48 						domain,
49 						qxl_alloc->size,
50 						NULL,
51 						&qobj, &handle);
52 	if (ret) {
53 		DRM_ERROR("%s: failed to create gem ret=%d\n",
54 			  __func__, ret);
55 		return -ENOMEM;
56 	}
57 	qxl_alloc->handle = handle;
58 	return 0;
59 }
60 
61 static int qxl_map_ioctl(struct drm_device *dev, void *data,
62 			 struct drm_file *file_priv)
63 {
64 	struct qxl_device *qdev = dev->dev_private;
65 	struct drm_qxl_map *qxl_map = data;
66 
67 	return qxl_mode_dumb_mmap(file_priv, qdev->ddev, qxl_map->handle,
68 				  &qxl_map->offset);
69 }
70 
71 /*
72  * dst must be validated, i.e. whole bo on vram/surfacesram (right now all bo's
73  * are on vram).
74  * *(dst + dst_off) = qxl_bo_physical_address(src, src_off)
75  */
76 static void
77 apply_reloc(struct qxl_device *qdev, struct qxl_bo *dst, uint64_t dst_off,
78 	    struct qxl_bo *src, uint64_t src_off)
79 {
80 	void *reloc_page;
81 
82 	reloc_page = qxl_bo_kmap_atomic_page(qdev, dst, dst_off & PAGE_MASK);
83 	*(uint64_t *)(reloc_page + (dst_off & ~PAGE_MASK)) = qxl_bo_physical_address(qdev,
84 								     src, src_off);
85 	qxl_bo_kunmap_atomic_page(qdev, dst, reloc_page);
86 }
87 
88 static void
89 apply_surf_reloc(struct qxl_device *qdev, struct qxl_bo *dst, uint64_t dst_off,
90 		 struct qxl_bo *src)
91 {
92 	uint32_t id = 0;
93 	void *reloc_page;
94 
95 	if (src && !src->is_primary)
96 		id = src->surface_id;
97 
98 	reloc_page = qxl_bo_kmap_atomic_page(qdev, dst, dst_off & PAGE_MASK);
99 	*(uint32_t *)(reloc_page + (dst_off & ~PAGE_MASK)) = id;
100 	qxl_bo_kunmap_atomic_page(qdev, dst, reloc_page);
101 }
102 
103 /* return holding the reference to this object */
104 static struct qxl_bo *qxlhw_handle_to_bo(struct qxl_device *qdev,
105 					 struct drm_file *file_priv, uint64_t handle,
106 					 struct qxl_reloc_list *reloc_list)
107 {
108 	struct drm_gem_object *gobj;
109 	struct qxl_bo *qobj;
110 	int ret;
111 
112 	gobj = drm_gem_object_lookup(qdev->ddev, file_priv, handle);
113 	if (!gobj) {
114 		DRM_ERROR("bad bo handle %lld\n", handle);
115 		return NULL;
116 	}
117 	qobj = gem_to_qxl_bo(gobj);
118 
119 	ret = qxl_bo_list_add(reloc_list, qobj);
120 	if (ret)
121 		return NULL;
122 
123 	return qobj;
124 }
125 
126 /*
127  * Usage of execbuffer:
128  * Relocations need to take into account the full QXLDrawable size.
129  * However, the command as passed from user space must *not* contain the initial
130  * QXLReleaseInfo struct (first XXX bytes)
131  */
132 static int qxl_execbuffer_ioctl(struct drm_device *dev, void *data,
133 				struct drm_file *file_priv)
134 {
135 	struct qxl_device *qdev = dev->dev_private;
136 	struct drm_qxl_execbuffer *execbuffer = data;
137 	struct drm_qxl_command user_cmd;
138 	int cmd_num;
139 	struct qxl_bo *reloc_src_bo;
140 	struct qxl_bo *reloc_dst_bo;
141 	struct drm_qxl_reloc reloc;
142 	void *fb_cmd;
143 	int i, ret;
144 	struct qxl_reloc_list reloc_list;
145 	int unwritten;
146 	uint32_t reloc_dst_offset;
147 	INIT_LIST_HEAD(&reloc_list.bos);
148 
149 	for (cmd_num = 0; cmd_num < execbuffer->commands_num; ++cmd_num) {
150 		struct qxl_release *release;
151 		struct qxl_bo *cmd_bo;
152 		int release_type;
153 		struct drm_qxl_command *commands =
154 			(struct drm_qxl_command *)(uintptr_t)execbuffer->commands;
155 
156 		if (DRM_COPY_FROM_USER(&user_cmd, &commands[cmd_num],
157 				       sizeof(user_cmd)))
158 			return -EFAULT;
159 		switch (user_cmd.type) {
160 		case QXL_CMD_DRAW:
161 			release_type = QXL_RELEASE_DRAWABLE;
162 			break;
163 		case QXL_CMD_SURFACE:
164 		case QXL_CMD_CURSOR:
165 		default:
166 			DRM_DEBUG("Only draw commands in execbuffers\n");
167 			return -EINVAL;
168 			break;
169 		}
170 
171 		if (user_cmd.command_size > PAGE_SIZE - sizeof(union qxl_release_info))
172 			return -EINVAL;
173 
174 		if (!access_ok(VERIFY_READ,
175 			       (void *)(unsigned long)user_cmd.command,
176 			       user_cmd.command_size))
177 			return -EFAULT;
178 
179 		ret = qxl_alloc_release_reserved(qdev,
180 						 sizeof(union qxl_release_info) +
181 						 user_cmd.command_size,
182 						 release_type,
183 						 &release,
184 						 &cmd_bo);
185 		if (ret)
186 			return ret;
187 
188 		/* TODO copy slow path code from i915 */
189 		fb_cmd = qxl_bo_kmap_atomic_page(qdev, cmd_bo, (release->release_offset & PAGE_SIZE));
190 		unwritten = __copy_from_user_inatomic_nocache(fb_cmd + sizeof(union qxl_release_info) + (release->release_offset & ~PAGE_SIZE), (void *)(unsigned long)user_cmd.command, user_cmd.command_size);
191 		qxl_bo_kunmap_atomic_page(qdev, cmd_bo, fb_cmd);
192 		if (unwritten) {
193 			DRM_ERROR("got unwritten %d\n", unwritten);
194 			qxl_release_unreserve(qdev, release);
195 			qxl_release_free(qdev, release);
196 			return -EFAULT;
197 		}
198 
199 		for (i = 0 ; i < user_cmd.relocs_num; ++i) {
200 			if (DRM_COPY_FROM_USER(&reloc,
201 					       &((struct drm_qxl_reloc *)(uintptr_t)user_cmd.relocs)[i],
202 					       sizeof(reloc))) {
203 				qxl_bo_list_unreserve(&reloc_list, true);
204 				qxl_release_unreserve(qdev, release);
205 				qxl_release_free(qdev, release);
206 				return -EFAULT;
207 			}
208 
209 			/* add the bos to the list of bos to validate -
210 			   need to validate first then process relocs? */
211 			if (reloc.dst_handle) {
212 				reloc_dst_bo = qxlhw_handle_to_bo(qdev, file_priv,
213 								  reloc.dst_handle, &reloc_list);
214 				if (!reloc_dst_bo) {
215 					qxl_bo_list_unreserve(&reloc_list, true);
216 					qxl_release_unreserve(qdev, release);
217 					qxl_release_free(qdev, release);
218 					return -EINVAL;
219 				}
220 				reloc_dst_offset = 0;
221 			} else {
222 				reloc_dst_bo = cmd_bo;
223 				reloc_dst_offset = release->release_offset;
224 			}
225 
226 			/* reserve and validate the reloc dst bo */
227 			if (reloc.reloc_type == QXL_RELOC_TYPE_BO || reloc.src_handle > 0) {
228 				reloc_src_bo =
229 					qxlhw_handle_to_bo(qdev, file_priv,
230 							   reloc.src_handle, &reloc_list);
231 				if (!reloc_src_bo) {
232 					if (reloc_dst_bo != cmd_bo)
233 						drm_gem_object_unreference_unlocked(&reloc_dst_bo->gem_base);
234 					qxl_bo_list_unreserve(&reloc_list, true);
235 					qxl_release_unreserve(qdev, release);
236 					qxl_release_free(qdev, release);
237 					return -EINVAL;
238 				}
239 			} else
240 				reloc_src_bo = NULL;
241 			if (reloc.reloc_type == QXL_RELOC_TYPE_BO) {
242 				apply_reloc(qdev, reloc_dst_bo, reloc_dst_offset + reloc.dst_offset,
243 					    reloc_src_bo, reloc.src_offset);
244 			} else if (reloc.reloc_type == QXL_RELOC_TYPE_SURF) {
245 				apply_surf_reloc(qdev, reloc_dst_bo, reloc_dst_offset + reloc.dst_offset, reloc_src_bo);
246 			} else {
247 				DRM_ERROR("unknown reloc type %d\n", reloc.reloc_type);
248 				return -EINVAL;
249 			}
250 
251 			if (reloc_src_bo && reloc_src_bo != cmd_bo) {
252 				qxl_release_add_res(qdev, release, reloc_src_bo);
253 				drm_gem_object_unreference_unlocked(&reloc_src_bo->gem_base);
254 			}
255 
256 			if (reloc_dst_bo != cmd_bo)
257 				drm_gem_object_unreference_unlocked(&reloc_dst_bo->gem_base);
258 		}
259 		qxl_fence_releaseable(qdev, release);
260 
261 		ret = qxl_push_command_ring_release(qdev, release, user_cmd.type, true);
262 		if (ret == -ERESTARTSYS) {
263 			qxl_release_unreserve(qdev, release);
264 			qxl_release_free(qdev, release);
265 			qxl_bo_list_unreserve(&reloc_list, true);
266 			return ret;
267 		}
268 		qxl_release_unreserve(qdev, release);
269 	}
270 	qxl_bo_list_unreserve(&reloc_list, 0);
271 	return 0;
272 }
273 
274 static int qxl_update_area_ioctl(struct drm_device *dev, void *data,
275 				 struct drm_file *file)
276 {
277 	struct qxl_device *qdev = dev->dev_private;
278 	struct drm_qxl_update_area *update_area = data;
279 	struct qxl_rect area = {.left = update_area->left,
280 				.top = update_area->top,
281 				.right = update_area->right,
282 				.bottom = update_area->bottom};
283 	int ret;
284 	struct drm_gem_object *gobj = NULL;
285 	struct qxl_bo *qobj = NULL;
286 
287 	if (update_area->left >= update_area->right ||
288 	    update_area->top >= update_area->bottom)
289 		return -EINVAL;
290 
291 	gobj = drm_gem_object_lookup(dev, file, update_area->handle);
292 	if (gobj == NULL)
293 		return -ENOENT;
294 
295 	qobj = gem_to_qxl_bo(gobj);
296 
297 	ret = qxl_bo_reserve(qobj, false);
298 	if (ret)
299 		goto out;
300 
301 	if (!qobj->pin_count) {
302 		qxl_ttm_placement_from_domain(qobj, qobj->type);
303 		ret = ttm_bo_validate(&qobj->tbo, &qobj->placement,
304 				      true, false);
305 		if (unlikely(ret))
306 			goto out;
307 	}
308 
309 	ret = qxl_bo_check_id(qdev, qobj);
310 	if (ret)
311 		goto out2;
312 	if (!qobj->surface_id)
313 		DRM_ERROR("got update area for surface with no id %d\n", update_area->handle);
314 	ret = qxl_io_update_area(qdev, qobj, &area);
315 
316 out2:
317 	qxl_bo_unreserve(qobj);
318 
319 out:
320 	drm_gem_object_unreference_unlocked(gobj);
321 	return ret;
322 }
323 
324 static int qxl_getparam_ioctl(struct drm_device *dev, void *data,
325 		       struct drm_file *file_priv)
326 {
327 	struct qxl_device *qdev = dev->dev_private;
328 	struct drm_qxl_getparam *param = data;
329 
330 	switch (param->param) {
331 	case QXL_PARAM_NUM_SURFACES:
332 		param->value = qdev->rom->n_surfaces;
333 		break;
334 	case QXL_PARAM_MAX_RELOCS:
335 		param->value = QXL_MAX_RES;
336 		break;
337 	default:
338 		return -EINVAL;
339 	}
340 	return 0;
341 }
342 
343 static int qxl_clientcap_ioctl(struct drm_device *dev, void *data,
344 				  struct drm_file *file_priv)
345 {
346 	struct qxl_device *qdev = dev->dev_private;
347 	struct drm_qxl_clientcap *param = data;
348 	int byte, idx;
349 
350 	byte = param->index / 8;
351 	idx = param->index % 8;
352 
353 	if (qdev->pdev->revision < 4)
354 		return -ENOSYS;
355 
356 	if (byte >= 58)
357 		return -ENOSYS;
358 
359 	if (qdev->rom->client_capabilities[byte] & (1 << idx))
360 		return 0;
361 	return -ENOSYS;
362 }
363 
364 static int qxl_alloc_surf_ioctl(struct drm_device *dev, void *data,
365 				struct drm_file *file)
366 {
367 	struct qxl_device *qdev = dev->dev_private;
368 	struct drm_qxl_alloc_surf *param = data;
369 	struct qxl_bo *qobj;
370 	int handle;
371 	int ret;
372 	int size, actual_stride;
373 	struct qxl_surface surf;
374 
375 	/* work out size allocate bo with handle */
376 	actual_stride = param->stride < 0 ? -param->stride : param->stride;
377 	size = actual_stride * param->height + actual_stride;
378 
379 	surf.format = param->format;
380 	surf.width = param->width;
381 	surf.height = param->height;
382 	surf.stride = param->stride;
383 	surf.data = 0;
384 
385 	ret = qxl_gem_object_create_with_handle(qdev, file,
386 						QXL_GEM_DOMAIN_SURFACE,
387 						size,
388 						&surf,
389 						&qobj, &handle);
390 	if (ret) {
391 		DRM_ERROR("%s: failed to create gem ret=%d\n",
392 			  __func__, ret);
393 		return -ENOMEM;
394 	} else
395 		param->handle = handle;
396 	return ret;
397 }
398 
399 struct drm_ioctl_desc qxl_ioctls[] = {
400 	DRM_IOCTL_DEF_DRV(QXL_ALLOC, qxl_alloc_ioctl, DRM_AUTH|DRM_UNLOCKED),
401 
402 	DRM_IOCTL_DEF_DRV(QXL_MAP, qxl_map_ioctl, DRM_AUTH|DRM_UNLOCKED),
403 
404 	DRM_IOCTL_DEF_DRV(QXL_EXECBUFFER, qxl_execbuffer_ioctl,
405 							DRM_AUTH|DRM_UNLOCKED),
406 	DRM_IOCTL_DEF_DRV(QXL_UPDATE_AREA, qxl_update_area_ioctl,
407 							DRM_AUTH|DRM_UNLOCKED),
408 	DRM_IOCTL_DEF_DRV(QXL_GETPARAM, qxl_getparam_ioctl,
409 							DRM_AUTH|DRM_UNLOCKED),
410 	DRM_IOCTL_DEF_DRV(QXL_CLIENTCAP, qxl_clientcap_ioctl,
411 							DRM_AUTH|DRM_UNLOCKED),
412 
413 	DRM_IOCTL_DEF_DRV(QXL_ALLOC_SURF, qxl_alloc_surf_ioctl,
414 			  DRM_AUTH|DRM_UNLOCKED),
415 };
416 
417 int qxl_max_ioctls = DRM_ARRAY_SIZE(qxl_ioctls);
418