xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/drm_ioctl.c (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /*	$NetBSD: drm_ioctl.c,v 1.12 2020/02/14 04:36:56 riastradh Exp $	*/
2 
3 /*
4  * Created: Fri Jan  8 09:01:26 1999 by faith@valinux.com
5  *
6  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
7  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
8  * All Rights Reserved.
9  *
10  * Author Rickard E. (Rik) Faith <faith@valinux.com>
11  * Author Gareth Hughes <gareth@valinux.com>
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice (including the next
21  * paragraph) shall be included in all copies or substantial portions of the
22  * Software.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
27  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30  * OTHER DEALINGS IN THE SOFTWARE.
31  */
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: drm_ioctl.c,v 1.12 2020/02/14 04:36:56 riastradh Exp $");
35 
36 #include <drm/drmP.h>
37 #include <drm/drm_core.h>
38 #include "drm_legacy.h"
39 #include "drm_internal.h"
40 #include "drm_crtc_internal.h"
41 
42 #include <linux/pci.h>
43 #include <linux/export.h>
44 
45 static int drm_version(struct drm_device *dev, void *data,
46 		       struct drm_file *file_priv);
47 
48 /*
49  * Get the bus id.
50  *
51  * \param inode device inode.
52  * \param file_priv DRM file private.
53  * \param cmd command.
54  * \param arg user argument, pointing to a drm_unique structure.
55  * \return zero on success or a negative number on failure.
56  *
57  * Copies the bus id from drm_device::unique into user space.
58  */
59 static int drm_getunique(struct drm_device *dev, void *data,
60 		  struct drm_file *file_priv)
61 {
62 	struct drm_unique *u = data;
63 	struct drm_master *master = file_priv->master;
64 
65 	if (u->unique_len >= master->unique_len) {
66 		if (copy_to_user(u->unique, master->unique, master->unique_len))
67 			return -EFAULT;
68 	}
69 	u->unique_len = master->unique_len;
70 
71 	return 0;
72 }
73 
74 static void
75 drm_unset_busid(struct drm_device *dev,
76 		struct drm_master *master)
77 {
78 	kfree(master->unique);
79 	master->unique = NULL;
80 	master->unique_len = 0;
81 }
82 
83 /*
84  * Set the bus id.
85  *
86  * \param inode device inode.
87  * \param file_priv DRM file private.
88  * \param cmd command.
89  * \param arg user argument, pointing to a drm_unique structure.
90  * \return zero on success or a negative number on failure.
91  *
92  * Copies the bus id from userspace into drm_device::unique, and verifies that
93  * it matches the device this DRM is attached to (EINVAL otherwise).  Deprecated
94  * in interface version 1.1 and will return EBUSY when setversion has requested
95  * version 1.1 or greater. Also note that KMS is all version 1.1 and later and
96  * UMS was only ever supported on pci devices.
97  */
98 static int drm_setunique(struct drm_device *dev, void *data,
99 		  struct drm_file *file_priv)
100 {
101 	struct drm_unique *u = data;
102 	struct drm_master *master = file_priv->master;
103 	int ret;
104 
105 	if (master->unique_len || master->unique)
106 		return -EBUSY;
107 
108 	if (!u->unique_len || u->unique_len > 1024)
109 		return -EINVAL;
110 
111 	if (drm_core_check_feature(dev, DRIVER_MODESET))
112 		return 0;
113 
114 	if (WARN_ON(!dev->pdev))
115 		return -EINVAL;
116 
117 	if (!dev->driver->set_unique)
118 		return -ENODEV;
119 
120 	ret = dev->driver->set_unique(dev, master, u);
121 	if (ret)
122 		goto err;
123 
124 	return 0;
125 
126 err:
127 	drm_unset_busid(dev, master);
128 	return ret;
129 }
130 
131 static int drm_set_busid(struct drm_device *dev, struct drm_file *file_priv)
132 {
133 	struct drm_master *master = file_priv->master;
134 	int ret;
135 
136 	if (master->unique != NULL)
137 		drm_unset_busid(dev, master);
138 
139 	if (dev->driver->set_busid) {
140 		ret = dev->driver->set_busid(dev, master);
141 		if (ret) {
142 			drm_unset_busid(dev, master);
143 			return ret;
144 		}
145 	} else {
146 		if (WARN(dev->unique == NULL,
147 			 "No drm_driver.set_busid() implementation provided by "
148 			 "%ps. Use drm_dev_set_unique() to set the unique "
149 			 "name explicitly.", dev->driver))
150 			return -EINVAL;
151 
152 		master->unique = kstrdup(dev->unique, GFP_KERNEL);
153 		if (master->unique)
154 			master->unique_len = strlen(dev->unique);
155 	}
156 
157 	return 0;
158 }
159 
160 /*
161  * Get a mapping information.
162  *
163  * \param inode device inode.
164  * \param file_priv DRM file private.
165  * \param cmd command.
166  * \param arg user argument, pointing to a drm_map structure.
167  *
168  * \return zero on success or a negative number on failure.
169  *
170  * Searches for the mapping with the specified offset and copies its information
171  * into userspace
172  */
173 static int drm_getmap(struct drm_device *dev, void *data,
174 	       struct drm_file *file_priv)
175 {
176 	struct drm_map *map = data;
177 	struct drm_map_list *r_list = NULL;
178 	struct list_head *list;
179 	int idx;
180 	int i;
181 
182 	idx = map->offset;
183 	if (idx < 0)
184 		return -EINVAL;
185 
186 	i = 0;
187 	mutex_lock(&dev->struct_mutex);
188 	list_for_each(list, &dev->maplist) {
189 		if (i == idx) {
190 			r_list = list_entry(list, struct drm_map_list, head);
191 			break;
192 		}
193 		i++;
194 	}
195 	if (!r_list || !r_list->map) {
196 		mutex_unlock(&dev->struct_mutex);
197 		return -EINVAL;
198 	}
199 
200 	map->offset = r_list->map->offset;
201 	map->size = r_list->map->size;
202 	map->type = r_list->map->type;
203 	map->flags = r_list->map->flags;
204 	map->handle = (void *)(unsigned long) r_list->user_token;
205 	map->mtrr = arch_phys_wc_index(r_list->map->mtrr);
206 
207 	mutex_unlock(&dev->struct_mutex);
208 
209 	return 0;
210 }
211 
212 /*
213  * Get client information.
214  *
215  * \param inode device inode.
216  * \param file_priv DRM file private.
217  * \param cmd command.
218  * \param arg user argument, pointing to a drm_client structure.
219  *
220  * \return zero on success or a negative number on failure.
221  *
222  * Searches for the client with the specified index and copies its information
223  * into userspace
224  */
225 static int drm_getclient(struct drm_device *dev, void *data,
226 		  struct drm_file *file_priv)
227 {
228 	struct drm_client *client = data;
229 
230 	/*
231 	 * Hollowed-out getclient ioctl to keep some dead old drm tests/tools
232 	 * not breaking completely. Userspace tools stop enumerating one they
233 	 * get -EINVAL, hence this is the return value we need to hand back for
234 	 * no clients tracked.
235 	 *
236 	 * Unfortunately some clients (*cough* libva *cough*) use this in a fun
237 	 * attempt to figure out whether they're authenticated or not. Since
238 	 * that's the only thing they care about, give it to the directly
239 	 * instead of walking one giant list.
240 	 */
241 	if (client->idx == 0) {
242 		client->auth = file_priv->authenticated;
243 #ifdef __NetBSD__		/* XXX Too scary to contemplate.  */
244 		client->pid = curproc->p_pid;
245 		client->uid = kauth_cred_geteuid(curproc->p_cred);
246 #else
247 		client->pid = pid_vnr(file_priv->pid);
248 		client->uid = from_kuid_munged(current_user_ns(),
249 					       file_priv->uid);
250 #endif
251 		client->magic = 0;
252 		client->iocs = 0;
253 
254 		return 0;
255 	} else {
256 		return -EINVAL;
257 	}
258 }
259 
260 /*
261  * Get statistics information.
262  *
263  * \param inode device inode.
264  * \param file_priv DRM file private.
265  * \param cmd command.
266  * \param arg user argument, pointing to a drm_stats structure.
267  *
268  * \return zero on success or a negative number on failure.
269  */
270 static int drm_getstats(struct drm_device *dev, void *data,
271 		 struct drm_file *file_priv)
272 {
273 	struct drm_stats *stats = data;
274 
275 	/* Clear stats to prevent userspace from eating its stack garbage. */
276 	memset(stats, 0, sizeof(*stats));
277 
278 	return 0;
279 }
280 
281 /*
282  * Get device/driver capabilities
283  */
284 static int drm_getcap(struct drm_device *dev, void *data, struct drm_file *file_priv)
285 {
286 	struct drm_get_cap *req = data;
287 
288 	req->value = 0;
289 	switch (req->capability) {
290 	case DRM_CAP_DUMB_BUFFER:
291 		if (dev->driver->dumb_create)
292 			req->value = 1;
293 		break;
294 	case DRM_CAP_VBLANK_HIGH_CRTC:
295 		req->value = 1;
296 		break;
297 	case DRM_CAP_DUMB_PREFERRED_DEPTH:
298 		req->value = dev->mode_config.preferred_depth;
299 		break;
300 	case DRM_CAP_DUMB_PREFER_SHADOW:
301 		req->value = dev->mode_config.prefer_shadow;
302 		break;
303 	case DRM_CAP_PRIME:
304 		req->value |= dev->driver->prime_fd_to_handle ? DRM_PRIME_CAP_IMPORT : 0;
305 		req->value |= dev->driver->prime_handle_to_fd ? DRM_PRIME_CAP_EXPORT : 0;
306 		break;
307 	case DRM_CAP_TIMESTAMP_MONOTONIC:
308 		req->value = drm_timestamp_monotonic;
309 		break;
310 	case DRM_CAP_ASYNC_PAGE_FLIP:
311 		req->value = dev->mode_config.async_page_flip;
312 		break;
313 	case DRM_CAP_CURSOR_WIDTH:
314 		if (dev->mode_config.cursor_width)
315 			req->value = dev->mode_config.cursor_width;
316 		else
317 			req->value = 64;
318 		break;
319 	case DRM_CAP_CURSOR_HEIGHT:
320 		if (dev->mode_config.cursor_height)
321 			req->value = dev->mode_config.cursor_height;
322 		else
323 			req->value = 64;
324 		break;
325 	case DRM_CAP_ADDFB2_MODIFIERS:
326 		req->value = dev->mode_config.allow_fb_modifiers;
327 		break;
328 	default:
329 		return -EINVAL;
330 	}
331 	return 0;
332 }
333 
334 /*
335  * Set device/driver capabilities
336  */
337 static int
338 drm_setclientcap(struct drm_device *dev, void *data, struct drm_file *file_priv)
339 {
340 	struct drm_set_client_cap *req = data;
341 
342 	switch (req->capability) {
343 	case DRM_CLIENT_CAP_STEREO_3D:
344 		if (req->value > 1)
345 			return -EINVAL;
346 		file_priv->stereo_allowed = req->value;
347 		break;
348 	case DRM_CLIENT_CAP_UNIVERSAL_PLANES:
349 		if (req->value > 1)
350 			return -EINVAL;
351 		file_priv->universal_planes = req->value;
352 		break;
353 	case DRM_CLIENT_CAP_ATOMIC:
354 		if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
355 			return -EINVAL;
356 		if (req->value > 1)
357 			return -EINVAL;
358 		file_priv->atomic = req->value;
359 		file_priv->universal_planes = req->value;
360 		break;
361 	default:
362 		return -EINVAL;
363 	}
364 
365 	return 0;
366 }
367 
368 /*
369  * Setversion ioctl.
370  *
371  * \param inode device inode.
372  * \param file_priv DRM file private.
373  * \param cmd command.
374  * \param arg user argument, pointing to a drm_lock structure.
375  * \return zero on success or negative number on failure.
376  *
377  * Sets the requested interface version
378  */
379 static int drm_setversion(struct drm_device *dev, void *data, struct drm_file *file_priv)
380 {
381 	struct drm_set_version *sv = data;
382 	int if_version, retcode = 0;
383 
384 	if (sv->drm_di_major != -1) {
385 		if (sv->drm_di_major != DRM_IF_MAJOR ||
386 		    sv->drm_di_minor < 0 || sv->drm_di_minor > DRM_IF_MINOR) {
387 			retcode = -EINVAL;
388 			goto done;
389 		}
390 		if_version = DRM_IF_VERSION(sv->drm_di_major,
391 					    sv->drm_di_minor);
392 		dev->if_version = max(if_version, dev->if_version);
393 		if (sv->drm_di_minor >= 1) {
394 			/*
395 			 * Version 1.1 includes tying of DRM to specific device
396 			 * Version 1.4 has proper PCI domain support
397 			 */
398 			retcode = drm_set_busid(dev, file_priv);
399 			if (retcode)
400 				goto done;
401 		}
402 	}
403 
404 	if (sv->drm_dd_major != -1) {
405 		if (sv->drm_dd_major != dev->driver->major ||
406 		    sv->drm_dd_minor < 0 || sv->drm_dd_minor >
407 		    dev->driver->minor) {
408 			retcode = -EINVAL;
409 			goto done;
410 		}
411 	}
412 
413 done:
414 	sv->drm_di_major = DRM_IF_MAJOR;
415 	sv->drm_di_minor = DRM_IF_MINOR;
416 	sv->drm_dd_major = dev->driver->major;
417 	sv->drm_dd_minor = dev->driver->minor;
418 
419 	return retcode;
420 }
421 
422 /**
423  * drm_noop - DRM no-op ioctl implemntation
424  * @dev: DRM device for the ioctl
425  * @data: data pointer for the ioctl
426  * @file_priv: DRM file for the ioctl call
427  *
428  * This no-op implementation for drm ioctls is useful for deprecated
429  * functionality where we can't return a failure code because existing userspace
430  * checks the result of the ioctl, but doesn't care about the action.
431  *
432  * Always returns successfully with 0.
433  */
434 int drm_noop(struct drm_device *dev, void *data,
435 	     struct drm_file *file_priv)
436 {
437 	DRM_DEBUG("\n");
438 	return 0;
439 }
440 EXPORT_SYMBOL(drm_noop);
441 
442 /**
443  * drm_invalid_op - DRM invalid ioctl implemntation
444  * @dev: DRM device for the ioctl
445  * @data: data pointer for the ioctl
446  * @file_priv: DRM file for the ioctl call
447  *
448  * This no-op implementation for drm ioctls is useful for deprecated
449  * functionality where we really don't want to allow userspace to call the ioctl
450  * any more. This is the case for old ums interfaces for drivers that
451  * transitioned to kms gradually and so kept the old legacy tables around. This
452  * only applies to radeon and i915 kms drivers, other drivers shouldn't need to
453  * use this function.
454  *
455  * Always fails with a return value of -EINVAL.
456  */
457 int drm_invalid_op(struct drm_device *dev, void *data,
458 		   struct drm_file *file_priv)
459 {
460 	return -EINVAL;
461 }
462 EXPORT_SYMBOL(drm_invalid_op);
463 
464 /*
465  * Copy and IOCTL return string to user space
466  */
467 static int drm_copy_field(char __user *buf, size_t *buf_len, const char *value)
468 {
469 	int len;
470 
471 	/* don't overflow userbuf */
472 	len = strlen(value);
473 	if (len > *buf_len)
474 		len = *buf_len;
475 
476 	/* let userspace know exact length of driver value (which could be
477 	 * larger than the userspace-supplied buffer) */
478 	*buf_len = strlen(value);
479 
480 	/* finally, try filling in the userbuf */
481 	if (len && buf)
482 		if (copy_to_user(buf, value, len))
483 			return -EFAULT;
484 	return 0;
485 }
486 
487 /*
488  * Get version information
489  *
490  * \param inode device inode.
491  * \param filp file pointer.
492  * \param cmd command.
493  * \param arg user argument, pointing to a drm_version structure.
494  * \return zero on success or negative number on failure.
495  *
496  * Fills in the version information in \p arg.
497  */
498 static int drm_version(struct drm_device *dev, void *data,
499 		       struct drm_file *file_priv)
500 {
501 	struct drm_version *version = data;
502 	int err;
503 
504 	version->version_major = dev->driver->major;
505 	version->version_minor = dev->driver->minor;
506 	version->version_patchlevel = dev->driver->patchlevel;
507 	err = drm_copy_field(version->name, &version->name_len,
508 			dev->driver->name);
509 	if (!err)
510 		err = drm_copy_field(version->date, &version->date_len,
511 				dev->driver->date);
512 	if (!err)
513 		err = drm_copy_field(version->desc, &version->desc_len,
514 				dev->driver->desc);
515 
516 	return err;
517 }
518 
519 /*
520  * drm_ioctl_permit - Check ioctl permissions against caller
521  *
522  * @flags: ioctl permission flags.
523  * @file_priv: Pointer to struct drm_file identifying the caller.
524  *
525  * Checks whether the caller is allowed to run an ioctl with the
526  * indicated permissions. If so, returns zero. Otherwise returns an
527  * error code suitable for ioctl return.
528  */
529 int drm_ioctl_permit(u32 flags, struct drm_file *file_priv)
530 {
531 	/* ROOT_ONLY is only for CAP_SYS_ADMIN */
532 	if (unlikely((flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN)))
533 		return -EACCES;
534 
535 	/* AUTH is only for authenticated or render client */
536 	if (unlikely((flags & DRM_AUTH) && !drm_is_render_client(file_priv) &&
537 		     !file_priv->authenticated))
538 		return -EACCES;
539 
540 	/* MASTER is only for master or control clients */
541 	if (unlikely((flags & DRM_MASTER) && !file_priv->is_master &&
542 		     !drm_is_control_client(file_priv)))
543 		return -EACCES;
544 
545 	/* Control clients must be explicitly allowed */
546 	if (unlikely(!(flags & DRM_CONTROL_ALLOW) &&
547 		     drm_is_control_client(file_priv)))
548 		return -EACCES;
549 
550 	/* Render clients must be explicitly allowed */
551 	if (unlikely(!(flags & DRM_RENDER_ALLOW) &&
552 		     drm_is_render_client(file_priv)))
553 		return -EACCES;
554 
555 	return 0;
556 }
557 EXPORT_SYMBOL(drm_ioctl_permit);
558 
559 #define DRM_IOCTL_DEF(ioctl, _func, _flags)	\
560 	[DRM_IOCTL_NR(ioctl)] = {		\
561 		.cmd = ioctl,			\
562 		.func = _func,			\
563 		.flags = _flags,		\
564 		.name = #ioctl			\
565 	}
566 
567 /* Ioctl table */
568 static const struct drm_ioctl_desc drm_ioctls[] = {
569 	DRM_IOCTL_DEF(DRM_IOCTL_VERSION, drm_version,
570 		      DRM_UNLOCKED|DRM_RENDER_ALLOW|DRM_CONTROL_ALLOW),
571 	DRM_IOCTL_DEF(DRM_IOCTL_GET_UNIQUE, drm_getunique, 0),
572 	DRM_IOCTL_DEF(DRM_IOCTL_GET_MAGIC, drm_getmagic, 0),
573 	DRM_IOCTL_DEF(DRM_IOCTL_IRQ_BUSID, drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY),
574 	DRM_IOCTL_DEF(DRM_IOCTL_GET_MAP, drm_getmap, DRM_UNLOCKED),
575 	DRM_IOCTL_DEF(DRM_IOCTL_GET_CLIENT, drm_getclient, DRM_UNLOCKED),
576 	DRM_IOCTL_DEF(DRM_IOCTL_GET_STATS, drm_getstats, DRM_UNLOCKED),
577 	DRM_IOCTL_DEF(DRM_IOCTL_GET_CAP, drm_getcap, DRM_UNLOCKED|DRM_RENDER_ALLOW),
578 	DRM_IOCTL_DEF(DRM_IOCTL_SET_CLIENT_CAP, drm_setclientcap, 0),
579 	DRM_IOCTL_DEF(DRM_IOCTL_SET_VERSION, drm_setversion, DRM_MASTER),
580 
581 	DRM_IOCTL_DEF(DRM_IOCTL_SET_UNIQUE, drm_setunique, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
582 	DRM_IOCTL_DEF(DRM_IOCTL_BLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
583 	DRM_IOCTL_DEF(DRM_IOCTL_UNBLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
584 	DRM_IOCTL_DEF(DRM_IOCTL_AUTH_MAGIC, drm_authmagic, DRM_AUTH|DRM_MASTER),
585 
586 	DRM_IOCTL_DEF(DRM_IOCTL_ADD_MAP, drm_legacy_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
587 	DRM_IOCTL_DEF(DRM_IOCTL_RM_MAP, drm_legacy_rmmap_ioctl, DRM_AUTH),
588 
589 	DRM_IOCTL_DEF(DRM_IOCTL_SET_SAREA_CTX, drm_legacy_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
590 	DRM_IOCTL_DEF(DRM_IOCTL_GET_SAREA_CTX, drm_legacy_getsareactx, DRM_AUTH),
591 
592 	DRM_IOCTL_DEF(DRM_IOCTL_SET_MASTER, drm_setmaster_ioctl, DRM_ROOT_ONLY),
593 	DRM_IOCTL_DEF(DRM_IOCTL_DROP_MASTER, drm_dropmaster_ioctl, DRM_ROOT_ONLY),
594 
595 	DRM_IOCTL_DEF(DRM_IOCTL_ADD_CTX, drm_legacy_addctx, DRM_AUTH|DRM_ROOT_ONLY),
596 	DRM_IOCTL_DEF(DRM_IOCTL_RM_CTX, drm_legacy_rmctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
597 	DRM_IOCTL_DEF(DRM_IOCTL_MOD_CTX, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
598 	DRM_IOCTL_DEF(DRM_IOCTL_GET_CTX, drm_legacy_getctx, DRM_AUTH),
599 	DRM_IOCTL_DEF(DRM_IOCTL_SWITCH_CTX, drm_legacy_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
600 	DRM_IOCTL_DEF(DRM_IOCTL_NEW_CTX, drm_legacy_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
601 	DRM_IOCTL_DEF(DRM_IOCTL_RES_CTX, drm_legacy_resctx, DRM_AUTH),
602 
603 	DRM_IOCTL_DEF(DRM_IOCTL_ADD_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
604 	DRM_IOCTL_DEF(DRM_IOCTL_RM_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
605 
606 	DRM_IOCTL_DEF(DRM_IOCTL_LOCK, drm_legacy_lock, DRM_AUTH),
607 	DRM_IOCTL_DEF(DRM_IOCTL_UNLOCK, drm_legacy_unlock, DRM_AUTH),
608 
609 	DRM_IOCTL_DEF(DRM_IOCTL_FINISH, drm_noop, DRM_AUTH),
610 
611 	DRM_IOCTL_DEF(DRM_IOCTL_ADD_BUFS, drm_legacy_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
612 	DRM_IOCTL_DEF(DRM_IOCTL_MARK_BUFS, drm_legacy_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
613 	DRM_IOCTL_DEF(DRM_IOCTL_INFO_BUFS, drm_legacy_infobufs, DRM_AUTH),
614 	DRM_IOCTL_DEF(DRM_IOCTL_MAP_BUFS, drm_legacy_mapbufs, DRM_AUTH),
615 	DRM_IOCTL_DEF(DRM_IOCTL_FREE_BUFS, drm_legacy_freebufs, DRM_AUTH),
616 	DRM_IOCTL_DEF(DRM_IOCTL_DMA, drm_legacy_dma_ioctl, DRM_AUTH),
617 
618 	DRM_IOCTL_DEF(DRM_IOCTL_CONTROL, drm_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
619 
620 #if IS_ENABLED(CONFIG_AGP)
621 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_ACQUIRE, drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
622 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_RELEASE, drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
623 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_ENABLE, drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
624 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_INFO, drm_agp_info_ioctl, DRM_AUTH),
625 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_ALLOC, drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
626 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_FREE, drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
627 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_BIND, drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
628 	DRM_IOCTL_DEF(DRM_IOCTL_AGP_UNBIND, drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
629 #endif
630 
631 	DRM_IOCTL_DEF(DRM_IOCTL_SG_ALLOC, drm_legacy_sg_alloc, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
632 	DRM_IOCTL_DEF(DRM_IOCTL_SG_FREE, drm_legacy_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
633 
634 	DRM_IOCTL_DEF(DRM_IOCTL_WAIT_VBLANK, drm_wait_vblank, DRM_UNLOCKED),
635 
636 	DRM_IOCTL_DEF(DRM_IOCTL_MODESET_CTL, drm_modeset_ctl, 0),
637 
638 	DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
639 
640 	DRM_IOCTL_DEF(DRM_IOCTL_GEM_CLOSE, drm_gem_close_ioctl, DRM_UNLOCKED|DRM_RENDER_ALLOW),
641 	DRM_IOCTL_DEF(DRM_IOCTL_GEM_FLINK, drm_gem_flink_ioctl, DRM_AUTH|DRM_UNLOCKED),
642 	DRM_IOCTL_DEF(DRM_IOCTL_GEM_OPEN, drm_gem_open_ioctl, DRM_AUTH|DRM_UNLOCKED),
643 
644 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETRESOURCES, drm_mode_getresources, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
645 
646 	DRM_IOCTL_DEF(DRM_IOCTL_PRIME_HANDLE_TO_FD, drm_prime_handle_to_fd_ioctl, DRM_AUTH|DRM_UNLOCKED|DRM_RENDER_ALLOW),
647 	DRM_IOCTL_DEF(DRM_IOCTL_PRIME_FD_TO_HANDLE, drm_prime_fd_to_handle_ioctl, DRM_AUTH|DRM_UNLOCKED|DRM_RENDER_ALLOW),
648 
649 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANERESOURCES, drm_mode_getplane_res, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
650 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCRTC, drm_mode_getcrtc, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
651 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETCRTC, drm_mode_setcrtc, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
652 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANE, drm_mode_getplane, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
653 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPLANE, drm_mode_setplane, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
654 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR, drm_mode_cursor_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
655 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETGAMMA, drm_mode_gamma_get_ioctl, DRM_UNLOCKED),
656 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETGAMMA, drm_mode_gamma_set_ioctl, DRM_MASTER|DRM_UNLOCKED),
657 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETENCODER, drm_mode_getencoder, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
658 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCONNECTOR, drm_mode_getconnector, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
659 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATTACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
660 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_DETACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
661 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPERTY, drm_mode_getproperty_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
662 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPROPERTY, drm_mode_connector_property_set_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
663 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPBLOB, drm_mode_getblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
664 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETFB, drm_mode_getfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
665 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB, drm_mode_addfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
666 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB2, drm_mode_addfb2, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
667 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_RMFB, drm_mode_rmfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
668 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_PAGE_FLIP, drm_mode_page_flip_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
669 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_DIRTYFB, drm_mode_dirtyfb_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
670 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATE_DUMB, drm_mode_create_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
671 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_MAP_DUMB, drm_mode_mmap_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
672 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_DESTROY_DUMB, drm_mode_destroy_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
673 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_GETPROPERTIES, drm_mode_obj_get_properties_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
674 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_SETPROPERTY, drm_mode_obj_set_property_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
675 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR2, drm_mode_cursor2_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
676 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATOMIC, drm_mode_atomic_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
677 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATEPROPBLOB, drm_mode_createblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
678 	DRM_IOCTL_DEF(DRM_IOCTL_MODE_DESTROYPROPBLOB, drm_mode_destroyblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
679 };
680 
681 #define DRM_CORE_IOCTL_COUNT	ARRAY_SIZE( drm_ioctls )
682 
683 /**
684  * drm_ioctl - ioctl callback implementation for DRM drivers
685  * @filp: file this ioctl is called on
686  * @cmd: ioctl cmd number
687  * @arg: user argument
688  *
689  * Looks up the ioctl function in the ::ioctls table, checking for root
690  * previleges if so required, and dispatches to the respective function.
691  *
692  * Returns:
693  * Zero on success, negative error code on failure.
694  */
695 #ifdef __NetBSD__
696 #include <sys/file.h>
697 int
698 drm_ioctl(struct file *fp, unsigned long cmd, void *data)
699 {
700 	char stackbuf[128];
701 	char *buf = stackbuf;
702 	void *data0 = data;
703 	struct drm_file *const file = fp->f_data;
704 	const unsigned int nr = DRM_IOCTL_NR(cmd);
705 	int error;
706 
707 	switch (cmd) {
708 	case FIONBIO:
709 	case FIOASYNC:
710 		return 0;
711 	default:
712 		break;
713 	}
714 
715 	if (IOCGROUP(cmd) != DRM_IOCTL_BASE)
716 		return EINVAL;
717 
718 	KASSERT(file != NULL);
719 	KASSERT(file->minor != NULL);
720 	KASSERT(file->minor->dev != NULL);
721 	struct drm_device *const dev = file->minor->dev;
722 	const struct drm_ioctl_desc *ioctl;
723 
724 	if (drm_device_is_unplugged(dev))
725 		return ENXIO;
726 
727 	const bool is_driver_ioctl =
728 	    (DRM_COMMAND_BASE <= nr) && (nr < DRM_COMMAND_END);
729 
730 	if (is_driver_ioctl) {
731 		const unsigned int driver_nr = nr - DRM_COMMAND_BASE;
732 		if (driver_nr >= dev->driver->num_ioctls)
733 			return EINVAL;
734 		ioctl = &dev->driver->ioctls[driver_nr];
735 	} else if (nr < __arraycount(drm_ioctls)) {
736 		ioctl = &drm_ioctls[nr];
737 	} else {
738 		ioctl = NULL;
739 	}
740 
741 	if ((ioctl == NULL) || (ioctl->func == NULL))
742 		return EINVAL;
743 
744 	/* XXX errno Linux->NetBSD */
745 	error = -drm_ioctl_permit(ioctl->flags, file);
746 	if (error)
747 		return error;
748 
749 	/* If userland passed in too few bytes, zero-pad them.  */
750 	if (IOCPARM_LEN(cmd) < IOCPARM_LEN(ioctl->cmd)) {
751 		/* 12-bit quantity, according to <sys/ioccom.h> */
752 		KASSERT(IOCPARM_LEN(ioctl->cmd) <= 4096);
753 		if (IOCPARM_LEN(ioctl->cmd) > sizeof stackbuf) {
754 			buf = kmem_alloc(IOCPARM_LEN(ioctl->cmd), KM_NOSLEEP);
755 			if (buf == NULL)
756 				return ENOMEM;
757 		}
758 		memcpy(buf, data, IOCPARM_LEN(cmd));
759 		memset(buf + IOCPARM_LEN(cmd), 0,
760 		    IOCPARM_LEN(ioctl->cmd) - IOCPARM_LEN(cmd));
761 		data0 = buf;
762 	}
763 
764 	if ((drm_core_check_feature(dev, DRIVER_MODESET) && is_driver_ioctl) ||
765 	    ISSET(ioctl->flags, DRM_UNLOCKED)) {
766 		/* XXX errno Linux->NetBSD */
767 		error = -(*ioctl->func)(dev, data0, file);
768 	} else {
769 		mutex_lock(&drm_global_mutex);
770 		/* XXX errno Linux->NetBSD */
771 		error = -(*ioctl->func)(dev, data0, file);
772 		mutex_unlock(&drm_global_mutex);
773 	}
774 
775 	/* If we used a temporary buffer, copy it back out.  */
776 	if (data != data0)
777 		memcpy(data, data0, IOCPARM_LEN(cmd));
778 
779 	/* If we had to allocate a heap buffer, free it.  */
780 	if (buf != stackbuf)
781 		kmem_free(buf, IOCPARM_LEN(ioctl->cmd));
782 
783 	return error;
784 }
785 #else
786 long drm_ioctl(struct file *filp,
787 	      unsigned int cmd, unsigned long arg)
788 {
789 	struct drm_file *file_priv = filp->private_data;
790 	struct drm_device *dev;
791 	const struct drm_ioctl_desc *ioctl = NULL;
792 	drm_ioctl_t *func;
793 	unsigned int nr = DRM_IOCTL_NR(cmd);
794 	int retcode = -EINVAL;
795 	char stack_kdata[128];
796 	char *kdata = NULL;
797 	unsigned int usize, asize, drv_size;
798 	bool is_driver_ioctl;
799 
800 	dev = file_priv->minor->dev;
801 
802 	if (drm_device_is_unplugged(dev))
803 		return -ENODEV;
804 
805 	is_driver_ioctl = nr >= DRM_COMMAND_BASE && nr < DRM_COMMAND_END;
806 
807 	if (is_driver_ioctl) {
808 		/* driver ioctl */
809 		if (nr - DRM_COMMAND_BASE >= dev->driver->num_ioctls)
810 			goto err_i1;
811 		ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
812 	} else {
813 		/* core ioctl */
814 		if (nr >= DRM_CORE_IOCTL_COUNT)
815 			goto err_i1;
816 		ioctl = &drm_ioctls[nr];
817 	}
818 
819 	drv_size = _IOC_SIZE(ioctl->cmd);
820 	usize = _IOC_SIZE(cmd);
821 	asize = max(usize, drv_size);
822 	cmd = ioctl->cmd;
823 
824 	DRM_DEBUG("pid=%d, dev=0x%lx, auth=%d, %s\n",
825 		  task_pid_nr(current),
826 		  (long)old_encode_dev(file_priv->minor->kdev->devt),
827 		  file_priv->authenticated, ioctl->name);
828 
829 	/* Do not trust userspace, use our own definition */
830 	func = ioctl->func;
831 
832 	if (unlikely(!func)) {
833 		DRM_DEBUG("no function\n");
834 		retcode = -EINVAL;
835 		goto err_i1;
836 	}
837 
838 	retcode = drm_ioctl_permit(ioctl->flags, file_priv);
839 	if (unlikely(retcode))
840 		goto err_i1;
841 
842 	if (cmd & (IOC_IN | IOC_OUT)) {
843 		if (asize <= sizeof(stack_kdata)) {
844 			kdata = stack_kdata;
845 		} else {
846 			kdata = kmalloc(asize, GFP_KERNEL);
847 			if (!kdata) {
848 				retcode = -ENOMEM;
849 				goto err_i1;
850 			}
851 		}
852 		if (asize > usize)
853 			memset(kdata + usize, 0, asize - usize);
854 	}
855 
856 	if (cmd & IOC_IN) {
857 		if (copy_from_user(kdata, (void __user *)arg,
858 				   usize) != 0) {
859 			retcode = -EFAULT;
860 			goto err_i1;
861 		}
862 	} else if (cmd & IOC_OUT) {
863 		memset(kdata, 0, usize);
864 	}
865 
866 	/* Enforce sane locking for kms driver ioctls. Core ioctls are
867 	 * too messy still. */
868 	if ((drm_core_check_feature(dev, DRIVER_MODESET) && is_driver_ioctl) ||
869 	    (ioctl->flags & DRM_UNLOCKED))
870 		retcode = func(dev, kdata, file_priv);
871 	else {
872 		mutex_lock(&drm_global_mutex);
873 		retcode = func(dev, kdata, file_priv);
874 		mutex_unlock(&drm_global_mutex);
875 	}
876 
877 	if (cmd & IOC_OUT) {
878 		if (copy_to_user((void __user *)arg, kdata,
879 				 usize) != 0)
880 			retcode = -EFAULT;
881 	}
882 
883       err_i1:
884 	if (!ioctl)
885 		DRM_DEBUG("invalid ioctl: pid=%d, dev=0x%lx, auth=%d, cmd=0x%02x, nr=0x%02x\n",
886 			  task_pid_nr(current),
887 			  (long)old_encode_dev(file_priv->minor->kdev->devt),
888 			  file_priv->authenticated, cmd, nr);
889 
890 	if (kdata != stack_kdata)
891 		kfree(kdata);
892 	if (retcode)
893 		DRM_DEBUG("ret = %d\n", retcode);
894 	return retcode;
895 }
896 #endif
897 EXPORT_SYMBOL(drm_ioctl);
898 
899 /**
900  * drm_ioctl_flags - Check for core ioctl and return ioctl permission flags
901  * @nr: ioctl number
902  * @flags: where to return the ioctl permission flags
903  *
904  * This ioctl is only used by the vmwgfx driver to augment the access checks
905  * done by the drm core and insofar a pretty decent layering violation. This
906  * shouldn't be used by any drivers.
907  *
908  * Returns:
909  * True if the @nr corresponds to a DRM core ioctl numer, false otherwise.
910  */
911 bool drm_ioctl_flags(unsigned int nr, unsigned int *flags)
912 {
913 	if (nr >= DRM_COMMAND_BASE && nr < DRM_COMMAND_END)
914 		return false;
915 
916 	if (nr >= DRM_CORE_IOCTL_COUNT)
917 		return false;
918 
919 	*flags = drm_ioctls[nr].flags;
920 	return true;
921 }
922 EXPORT_SYMBOL(drm_ioctl_flags);
923