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