1 /* 2 * Created: Fri Jan 8 09:01:26 1999 by faith@valinux.com 3 * 4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 6 * All Rights Reserved. 7 * 8 * Author Rickard E. (Rik) Faith <faith@valinux.com> 9 * Author Gareth Hughes <gareth@valinux.com> 10 * 11 * Permission is hereby granted, free of charge, to any person obtaining a 12 * copy of this software and associated documentation files (the "Software"), 13 * to deal in the Software without restriction, including without limitation 14 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 15 * and/or sell copies of the Software, and to permit persons to whom the 16 * Software is furnished to do so, subject to the following conditions: 17 * 18 * The above copyright notice and this permission notice (including the next 19 * paragraph) shall be included in all copies or substantial portions of the 20 * Software. 21 * 22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 25 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 26 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 27 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 28 * OTHER DEALINGS IN THE SOFTWARE. 29 */ 30 31 #include <drm/drm_ioctl.h> 32 #include <drm/drmP.h> 33 #include <drm/drm_auth.h> 34 #include "drm_legacy.h" 35 #include "drm_internal.h" 36 #include "drm_crtc_internal.h" 37 38 #include <linux/pci.h> 39 #include <linux/export.h> 40 41 /** 42 * DOC: getunique and setversion story 43 * 44 * BEWARE THE DRAGONS! MIND THE TRAPDOORS! 45 * 46 * In an attempt to warn anyone else who's trying to figure out what's going 47 * on here, I'll try to summarize the story. First things first, let's clear up 48 * the names, because the kernel internals, libdrm and the ioctls are all named 49 * differently: 50 * 51 * - GET_UNIQUE ioctl, implemented by drm_getunique is wrapped up in libdrm 52 * through the drmGetBusid function. 53 * - The libdrm drmSetBusid function is backed by the SET_UNIQUE ioctl. All 54 * that code is nerved in the kernel with drm_invalid_op(). 55 * - The internal set_busid kernel functions and driver callbacks are 56 * exclusively use by the SET_VERSION ioctl, because only drm 1.0 (which is 57 * nerved) allowed userspace to set the busid through the above ioctl. 58 * - Other ioctls and functions involved are named consistently. 59 * 60 * For anyone wondering what's the difference between drm 1.1 and 1.4: Correctly 61 * handling pci domains in the busid on ppc. Doing this correctly was only 62 * implemented in libdrm in 2010, hence can't be nerved yet. No one knows what's 63 * special with drm 1.2 and 1.3. 64 * 65 * Now the actual horror story of how device lookup in drm works. At large, 66 * there's 2 different ways, either by busid, or by device driver name. 67 * 68 * Opening by busid is fairly simple: 69 * 70 * 1. First call SET_VERSION to make sure pci domains are handled properly. As a 71 * side-effect this fills out the unique name in the master structure. 72 * 2. Call GET_UNIQUE to read out the unique name from the master structure, 73 * which matches the busid thanks to step 1. If it doesn't, proceed to try 74 * the next device node. 75 * 76 * Opening by name is slightly different: 77 * 78 * 1. Directly call VERSION to get the version and to match against the driver 79 * name returned by that ioctl. Note that SET_VERSION is not called, which 80 * means the the unique name for the master node just opening is _not_ filled 81 * out. This despite that with current drm device nodes are always bound to 82 * one device, and can't be runtime assigned like with drm 1.0. 83 * 2. Match driver name. If it mismatches, proceed to the next device node. 84 * 3. Call GET_UNIQUE, and check whether the unique name has length zero (by 85 * checking that the first byte in the string is 0). If that's not the case 86 * libdrm skips and proceeds to the next device node. Probably this is just 87 * copypasta from drm 1.0 times where a set unique name meant that the driver 88 * was in use already, but that's just conjecture. 89 * 90 * Long story short: To keep the open by name logic working, GET_UNIQUE must 91 * _not_ return a unique string when SET_VERSION hasn't been called yet, 92 * otherwise libdrm breaks. Even when that unique string can't ever change, and 93 * is totally irrelevant for actually opening the device because runtime 94 * assignable device instances were only support in drm 1.0, which is long dead. 95 * But the libdrm code in drmOpenByName somehow survived, hence this can't be 96 * broken. 97 */ 98 99 /* 100 * Get the bus id. 101 * 102 * \param inode device inode. 103 * \param file_priv DRM file private. 104 * \param cmd command. 105 * \param arg user argument, pointing to a drm_unique structure. 106 * \return zero on success or a negative number on failure. 107 * 108 * Copies the bus id from drm_device::unique into user space. 109 */ 110 int drm_getunique(struct drm_device *dev, void *data, 111 struct drm_file *file_priv) 112 { 113 struct drm_unique *u = data; 114 struct drm_master *master = file_priv->master; 115 116 mutex_lock(&master->dev->master_mutex); 117 if (u->unique_len >= master->unique_len) { 118 if (copy_to_user(u->unique, master->unique, master->unique_len)) { 119 mutex_unlock(&master->dev->master_mutex); 120 return -EFAULT; 121 } 122 } 123 u->unique_len = master->unique_len; 124 mutex_unlock(&master->dev->master_mutex); 125 126 return 0; 127 } 128 129 static void 130 drm_unset_busid(struct drm_device *dev, 131 struct drm_master *master) 132 { 133 kfree(master->unique); 134 master->unique = NULL; 135 master->unique_len = 0; 136 } 137 138 static int drm_set_busid(struct drm_device *dev, struct drm_file *file_priv) 139 { 140 struct drm_master *master = file_priv->master; 141 int ret; 142 143 if (master->unique != NULL) 144 drm_unset_busid(dev, master); 145 146 if (dev->dev) { 147 ret = drm_pci_set_busid(dev, master); 148 if (ret) { 149 drm_unset_busid(dev, master); 150 return ret; 151 } 152 } else { 153 WARN_ON(!dev->unique); 154 master->unique = kstrdup(dev->unique, M_DRM); 155 if (master->unique) 156 master->unique_len = strlen(dev->unique); 157 } 158 159 return 0; 160 } 161 162 /* 163 * Get client information. 164 * 165 * \param inode device inode. 166 * \param file_priv DRM file private. 167 * \param cmd command. 168 * \param arg user argument, pointing to a drm_client structure. 169 * 170 * \return zero on success or a negative number on failure. 171 * 172 * Searches for the client with the specified index and copies its information 173 * into userspace 174 */ 175 int drm_getclient(struct drm_device *dev, void *data, 176 struct drm_file *file_priv) 177 { 178 struct drm_client *client = data; 179 180 /* 181 * Hollowed-out getclient ioctl to keep some dead old drm tests/tools 182 * not breaking completely. Userspace tools stop enumerating one they 183 * get -EINVAL, hence this is the return value we need to hand back for 184 * no clients tracked. 185 * 186 * Unfortunately some clients (*cough* libva *cough*) use this in a fun 187 * attempt to figure out whether they're authenticated or not. Since 188 * that's the only thing they care about, give it to the directly 189 * instead of walking one giant list. 190 */ 191 if (client->idx == 0) { 192 client->auth = file_priv->authenticated; 193 client->pid = curproc->p_pid; 194 client->uid = -1; 195 client->magic = 0; 196 client->iocs = 0; 197 198 return 0; 199 } else { 200 return -EINVAL; 201 } 202 } 203 204 /* 205 * Get statistics information. 206 * 207 * \param inode device inode. 208 * \param file_priv DRM file private. 209 * \param cmd command. 210 * \param arg user argument, pointing to a drm_stats structure. 211 * 212 * \return zero on success or a negative number on failure. 213 */ 214 static int drm_getstats(struct drm_device *dev, void *data, 215 struct drm_file *file_priv) 216 { 217 struct drm_stats *stats = data; 218 219 /* Clear stats to prevent userspace from eating its stack garbage. */ 220 memset(stats, 0, sizeof(*stats)); 221 222 return 0; 223 } 224 225 /* 226 * Get device/driver capabilities 227 */ 228 static int drm_getcap(struct drm_device *dev, void *data, struct drm_file *file_priv) 229 { 230 struct drm_get_cap *req = data; 231 struct drm_crtc *crtc; 232 233 req->value = 0; 234 235 /* Only some caps make sense with UMS/render-only drivers. */ 236 switch (req->capability) { 237 case DRM_CAP_TIMESTAMP_MONOTONIC: 238 req->value = 1; 239 return 0; 240 case DRM_CAP_PRIME: 241 #ifdef __DragonFly__ 242 return -EINVAL; 243 #else 244 req->value |= dev->driver->prime_fd_to_handle ? DRM_PRIME_CAP_IMPORT : 0; 245 req->value |= dev->driver->prime_handle_to_fd ? DRM_PRIME_CAP_EXPORT : 0; 246 return 0; 247 #endif 248 } 249 250 /* Other caps only work with KMS drivers */ 251 if (!drm_core_check_feature(dev, DRIVER_MODESET)) 252 return -ENOTSUPP; 253 254 switch (req->capability) { 255 case DRM_CAP_DUMB_BUFFER: 256 if (dev->driver->dumb_create) 257 req->value = 1; 258 break; 259 case DRM_CAP_VBLANK_HIGH_CRTC: 260 req->value = 1; 261 break; 262 case DRM_CAP_DUMB_PREFERRED_DEPTH: 263 req->value = dev->mode_config.preferred_depth; 264 break; 265 case DRM_CAP_DUMB_PREFER_SHADOW: 266 req->value = dev->mode_config.prefer_shadow; 267 break; 268 case DRM_CAP_ASYNC_PAGE_FLIP: 269 req->value = dev->mode_config.async_page_flip; 270 break; 271 case DRM_CAP_PAGE_FLIP_TARGET: 272 req->value = 1; 273 drm_for_each_crtc(crtc, dev) { 274 if (!crtc->funcs->page_flip_target) 275 req->value = 0; 276 } 277 break; 278 case DRM_CAP_CURSOR_WIDTH: 279 if (dev->mode_config.cursor_width) 280 req->value = dev->mode_config.cursor_width; 281 else 282 req->value = 64; 283 break; 284 case DRM_CAP_CURSOR_HEIGHT: 285 if (dev->mode_config.cursor_height) 286 req->value = dev->mode_config.cursor_height; 287 else 288 req->value = 64; 289 break; 290 case DRM_CAP_ADDFB2_MODIFIERS: 291 req->value = dev->mode_config.allow_fb_modifiers; 292 break; 293 case DRM_CAP_CRTC_IN_VBLANK_EVENT: 294 req->value = 1; 295 break; 296 default: 297 return -EINVAL; 298 } 299 return 0; 300 } 301 302 /* 303 * Set device/driver capabilities 304 */ 305 static int 306 drm_setclientcap(struct drm_device *dev, void *data, struct drm_file *file_priv) 307 { 308 struct drm_set_client_cap *req = data; 309 310 switch (req->capability) { 311 case DRM_CLIENT_CAP_STEREO_3D: 312 if (req->value > 1) 313 return -EINVAL; 314 file_priv->stereo_allowed = req->value; 315 break; 316 case DRM_CLIENT_CAP_UNIVERSAL_PLANES: 317 if (req->value > 1) 318 return -EINVAL; 319 file_priv->universal_planes = req->value; 320 break; 321 case DRM_CLIENT_CAP_ATOMIC: 322 if (!drm_core_check_feature(dev, DRIVER_ATOMIC)) 323 return -EINVAL; 324 if (req->value > 1) 325 return -EINVAL; 326 file_priv->atomic = req->value; 327 file_priv->universal_planes = req->value; 328 break; 329 default: 330 return -EINVAL; 331 } 332 333 return 0; 334 } 335 336 /* 337 * Setversion ioctl. 338 * 339 * \param inode device inode. 340 * \param file_priv DRM file private. 341 * \param cmd command. 342 * \param arg user argument, pointing to a drm_lock structure. 343 * \return zero on success or negative number on failure. 344 * 345 * Sets the requested interface version 346 */ 347 static int drm_setversion(struct drm_device *dev, void *data, struct drm_file *file_priv) 348 { 349 struct drm_set_version *sv = data; 350 int if_version, retcode = 0; 351 352 mutex_lock(&dev->master_mutex); 353 if (sv->drm_di_major != -1) { 354 if (sv->drm_di_major != DRM_IF_MAJOR || 355 sv->drm_di_minor < 0 || sv->drm_di_minor > DRM_IF_MINOR) { 356 retcode = -EINVAL; 357 goto done; 358 } 359 if_version = DRM_IF_VERSION(sv->drm_di_major, 360 sv->drm_di_minor); 361 dev->if_version = max(if_version, dev->if_version); 362 if (sv->drm_di_minor >= 1) { 363 /* 364 * Version 1.1 includes tying of DRM to specific device 365 * Version 1.4 has proper PCI domain support 366 */ 367 retcode = drm_set_busid(dev, file_priv); 368 if (retcode) 369 goto done; 370 } 371 } 372 373 if (sv->drm_dd_major != -1) { 374 if (sv->drm_dd_major != dev->driver->major || 375 sv->drm_dd_minor < 0 || sv->drm_dd_minor > 376 dev->driver->minor) { 377 retcode = -EINVAL; 378 goto done; 379 } 380 } 381 382 done: 383 sv->drm_di_major = DRM_IF_MAJOR; 384 sv->drm_di_minor = DRM_IF_MINOR; 385 sv->drm_dd_major = dev->driver->major; 386 sv->drm_dd_minor = dev->driver->minor; 387 mutex_unlock(&dev->master_mutex); 388 389 return retcode; 390 } 391 392 /** 393 * drm_noop - DRM no-op ioctl implemntation 394 * @dev: DRM device for the ioctl 395 * @data: data pointer for the ioctl 396 * @file_priv: DRM file for the ioctl call 397 * 398 * This no-op implementation for drm ioctls is useful for deprecated 399 * functionality where we can't return a failure code because existing userspace 400 * checks the result of the ioctl, but doesn't care about the action. 401 * 402 * Always returns successfully with 0. 403 */ 404 int drm_noop(struct drm_device *dev, void *data, 405 struct drm_file *file_priv) 406 { 407 DRM_DEBUG("\n"); 408 return 0; 409 } 410 EXPORT_SYMBOL(drm_noop); 411 412 /** 413 * drm_invalid_op - DRM invalid ioctl implemntation 414 * @dev: DRM device for the ioctl 415 * @data: data pointer for the ioctl 416 * @file_priv: DRM file for the ioctl call 417 * 418 * This no-op implementation for drm ioctls is useful for deprecated 419 * functionality where we really don't want to allow userspace to call the ioctl 420 * any more. This is the case for old ums interfaces for drivers that 421 * transitioned to kms gradually and so kept the old legacy tables around. This 422 * only applies to radeon and i915 kms drivers, other drivers shouldn't need to 423 * use this function. 424 * 425 * Always fails with a return value of -EINVAL. 426 */ 427 int drm_invalid_op(struct drm_device *dev, void *data, 428 struct drm_file *file_priv) 429 { 430 return -EINVAL; 431 } 432 EXPORT_SYMBOL(drm_invalid_op); 433 434 /* 435 * Copy and IOCTL return string to user space 436 */ 437 static int drm_copy_field(char __user *buf, size_t *buf_len, const char *value) 438 { 439 int len; 440 441 /* don't overflow userbuf */ 442 len = strlen(value); 443 if (len > *buf_len) 444 len = *buf_len; 445 446 /* let userspace know exact length of driver value (which could be 447 * larger than the userspace-supplied buffer) */ 448 *buf_len = strlen(value); 449 450 /* finally, try filling in the userbuf */ 451 if (len && buf) 452 if (copy_to_user(buf, value, len)) 453 return -EFAULT; 454 return 0; 455 } 456 457 /* 458 * Get version information 459 * 460 * \param inode device inode. 461 * \param filp file pointer. 462 * \param cmd command. 463 * \param arg user argument, pointing to a drm_version structure. 464 * \return zero on success or negative number on failure. 465 * 466 * Fills in the version information in \p arg. 467 */ 468 int drm_version(struct drm_device *dev, void *data, 469 struct drm_file *file_priv) 470 { 471 #if 0 472 static int drm_version_initial; 473 #endif 474 struct drm_version *version = data; 475 int err; 476 477 #if 0 478 if (drm_version_initial == 0) { 479 int dummy; 480 481 ++drm_version_initial; 482 tsleep(&dummy, 0, "SDELAY", hz*2); 483 } 484 #endif 485 486 version->version_major = dev->driver->major; 487 version->version_minor = dev->driver->minor; 488 version->version_patchlevel = dev->driver->patchlevel; 489 err = drm_copy_field(version->name, &version->name_len, 490 dev->driver->name); 491 if (!err) 492 err = drm_copy_field(version->date, &version->date_len, 493 dev->driver->date); 494 if (!err) 495 err = drm_copy_field(version->desc, &version->desc_len, 496 dev->driver->desc); 497 498 return err; 499 } 500 501 /** 502 * drm_ioctl_permit - Check ioctl permissions against caller 503 * 504 * @flags: ioctl permission flags. 505 * @file_priv: Pointer to struct drm_file identifying the caller. 506 * 507 * Checks whether the caller is allowed to run an ioctl with the 508 * indicated permissions. 509 * 510 * Returns: 511 * Zero if allowed, -EACCES otherwise. 512 */ 513 int drm_ioctl_permit(u32 flags, struct drm_file *file_priv) 514 { 515 /* ROOT_ONLY is only for CAP_SYS_ADMIN */ 516 if (unlikely((flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN))) 517 return -EACCES; 518 519 /* AUTH is only for authenticated or render client */ 520 if (unlikely((flags & DRM_AUTH) && !drm_is_render_client(file_priv) && 521 !file_priv->authenticated)) 522 return -EACCES; 523 524 /* MASTER is only for master or control clients */ 525 if (unlikely((flags & DRM_MASTER) && 526 !drm_is_current_master(file_priv) && 527 !drm_is_control_client(file_priv))) 528 return -EACCES; 529 530 /* Control clients must be explicitly allowed */ 531 if (unlikely(!(flags & DRM_CONTROL_ALLOW) && 532 drm_is_control_client(file_priv))) 533 return -EACCES; 534 535 /* Render clients must be explicitly allowed */ 536 if (unlikely(!(flags & DRM_RENDER_ALLOW) && 537 drm_is_render_client(file_priv))) 538 return -EACCES; 539 540 return 0; 541 } 542 EXPORT_SYMBOL(drm_ioctl_permit); 543 544 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \ 545 [DRM_IOCTL_NR(ioctl)] = { \ 546 .cmd = ioctl, \ 547 .func = _func, \ 548 .flags = _flags, \ 549 .name = #ioctl \ 550 } 551 552 /* Ioctl table */ 553 static const struct drm_ioctl_desc drm_ioctls[] = { 554 DRM_IOCTL_DEF(DRM_IOCTL_VERSION, drm_version, 555 DRM_UNLOCKED|DRM_RENDER_ALLOW|DRM_CONTROL_ALLOW), 556 DRM_IOCTL_DEF(DRM_IOCTL_GET_UNIQUE, drm_getunique, DRM_UNLOCKED), 557 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAGIC, drm_getmagic, DRM_UNLOCKED), 558 DRM_IOCTL_DEF(DRM_IOCTL_IRQ_BUSID, drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY), 559 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAP, drm_legacy_getmap_ioctl, DRM_UNLOCKED), 560 DRM_IOCTL_DEF(DRM_IOCTL_GET_CLIENT, drm_getclient, DRM_UNLOCKED), 561 DRM_IOCTL_DEF(DRM_IOCTL_GET_STATS, drm_getstats, DRM_UNLOCKED), 562 DRM_IOCTL_DEF(DRM_IOCTL_GET_CAP, drm_getcap, DRM_UNLOCKED|DRM_RENDER_ALLOW), 563 DRM_IOCTL_DEF(DRM_IOCTL_SET_CLIENT_CAP, drm_setclientcap, DRM_UNLOCKED), 564 DRM_IOCTL_DEF(DRM_IOCTL_SET_VERSION, drm_setversion, DRM_UNLOCKED | DRM_MASTER), 565 566 DRM_IOCTL_DEF(DRM_IOCTL_SET_UNIQUE, drm_invalid_op, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 567 DRM_IOCTL_DEF(DRM_IOCTL_BLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 568 DRM_IOCTL_DEF(DRM_IOCTL_UNBLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 569 DRM_IOCTL_DEF(DRM_IOCTL_AUTH_MAGIC, drm_authmagic, DRM_AUTH|DRM_UNLOCKED|DRM_MASTER), 570 571 #ifdef __DragonFly__ 572 DRM_IOCTL_DEF(DRM_IOCTL_GET_PCIINFO, drm_getpciinfo, DRM_UNLOCKED|DRM_RENDER_ALLOW), 573 #else 574 DRM_IOCTL_DEF(DRM_IOCTL_ADD_MAP, drm_legacy_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 575 #endif 576 DRM_IOCTL_DEF(DRM_IOCTL_RM_MAP, drm_legacy_rmmap_ioctl, DRM_AUTH), 577 578 DRM_IOCTL_DEF(DRM_IOCTL_SET_SAREA_CTX, drm_legacy_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 579 DRM_IOCTL_DEF(DRM_IOCTL_GET_SAREA_CTX, drm_legacy_getsareactx, DRM_AUTH), 580 581 DRM_IOCTL_DEF(DRM_IOCTL_SET_MASTER, drm_setmaster_ioctl, DRM_UNLOCKED|DRM_ROOT_ONLY), 582 DRM_IOCTL_DEF(DRM_IOCTL_DROP_MASTER, drm_dropmaster_ioctl, DRM_UNLOCKED|DRM_ROOT_ONLY), 583 584 DRM_IOCTL_DEF(DRM_IOCTL_ADD_CTX, drm_legacy_addctx, DRM_AUTH|DRM_ROOT_ONLY), 585 DRM_IOCTL_DEF(DRM_IOCTL_RM_CTX, drm_legacy_rmctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 586 DRM_IOCTL_DEF(DRM_IOCTL_MOD_CTX, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 587 DRM_IOCTL_DEF(DRM_IOCTL_GET_CTX, drm_legacy_getctx, DRM_AUTH), 588 DRM_IOCTL_DEF(DRM_IOCTL_SWITCH_CTX, drm_legacy_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 589 DRM_IOCTL_DEF(DRM_IOCTL_NEW_CTX, drm_legacy_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 590 DRM_IOCTL_DEF(DRM_IOCTL_RES_CTX, drm_legacy_resctx, DRM_AUTH), 591 592 DRM_IOCTL_DEF(DRM_IOCTL_ADD_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 593 DRM_IOCTL_DEF(DRM_IOCTL_RM_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 594 595 DRM_IOCTL_DEF(DRM_IOCTL_LOCK, drm_legacy_lock, DRM_AUTH), 596 DRM_IOCTL_DEF(DRM_IOCTL_UNLOCK, drm_legacy_unlock, DRM_AUTH), 597 598 DRM_IOCTL_DEF(DRM_IOCTL_FINISH, drm_noop, DRM_AUTH), 599 600 DRM_IOCTL_DEF(DRM_IOCTL_ADD_BUFS, drm_legacy_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 601 DRM_IOCTL_DEF(DRM_IOCTL_MARK_BUFS, drm_legacy_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 602 DRM_IOCTL_DEF(DRM_IOCTL_INFO_BUFS, drm_legacy_infobufs, DRM_AUTH), 603 DRM_IOCTL_DEF(DRM_IOCTL_MAP_BUFS, drm_legacy_mapbufs, DRM_AUTH), 604 DRM_IOCTL_DEF(DRM_IOCTL_FREE_BUFS, drm_legacy_freebufs, DRM_AUTH), 605 DRM_IOCTL_DEF(DRM_IOCTL_DMA, drm_legacy_dma_ioctl, DRM_AUTH), 606 607 DRM_IOCTL_DEF(DRM_IOCTL_CONTROL, drm_legacy_irq_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 608 609 #if IS_ENABLED(CONFIG_AGP) 610 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ACQUIRE, drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 611 DRM_IOCTL_DEF(DRM_IOCTL_AGP_RELEASE, drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 612 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ENABLE, drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 613 DRM_IOCTL_DEF(DRM_IOCTL_AGP_INFO, drm_agp_info_ioctl, DRM_AUTH), 614 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ALLOC, drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 615 DRM_IOCTL_DEF(DRM_IOCTL_AGP_FREE, drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 616 DRM_IOCTL_DEF(DRM_IOCTL_AGP_BIND, drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 617 DRM_IOCTL_DEF(DRM_IOCTL_AGP_UNBIND, drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 618 #endif 619 620 DRM_IOCTL_DEF(DRM_IOCTL_SG_ALLOC, drm_legacy_sg_alloc, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 621 DRM_IOCTL_DEF(DRM_IOCTL_SG_FREE, drm_legacy_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 622 623 DRM_IOCTL_DEF(DRM_IOCTL_WAIT_VBLANK, drm_wait_vblank_ioctl, DRM_UNLOCKED), 624 625 DRM_IOCTL_DEF(DRM_IOCTL_MODESET_CTL, drm_legacy_modeset_ctl_ioctl, 0), 626 627 DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY), 628 629 DRM_IOCTL_DEF(DRM_IOCTL_GEM_CLOSE, drm_gem_close_ioctl, DRM_UNLOCKED|DRM_RENDER_ALLOW), 630 DRM_IOCTL_DEF(DRM_IOCTL_GEM_FLINK, drm_gem_flink_ioctl, DRM_AUTH|DRM_UNLOCKED), 631 DRM_IOCTL_DEF(DRM_IOCTL_GEM_OPEN, drm_gem_open_ioctl, DRM_AUTH|DRM_UNLOCKED), 632 633 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETRESOURCES, drm_mode_getresources, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 634 635 DRM_IOCTL_DEF(DRM_IOCTL_PRIME_HANDLE_TO_FD, drm_prime_handle_to_fd_ioctl, DRM_AUTH|DRM_UNLOCKED|DRM_RENDER_ALLOW), 636 DRM_IOCTL_DEF(DRM_IOCTL_PRIME_FD_TO_HANDLE, drm_prime_fd_to_handle_ioctl, DRM_AUTH|DRM_UNLOCKED|DRM_RENDER_ALLOW), 637 638 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANERESOURCES, drm_mode_getplane_res, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 639 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCRTC, drm_mode_getcrtc, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 640 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETCRTC, drm_mode_setcrtc, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 641 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANE, drm_mode_getplane, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 642 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPLANE, drm_mode_setplane, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 643 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR, drm_mode_cursor_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 644 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETGAMMA, drm_mode_gamma_get_ioctl, DRM_UNLOCKED), 645 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETGAMMA, drm_mode_gamma_set_ioctl, DRM_MASTER|DRM_UNLOCKED), 646 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETENCODER, drm_mode_getencoder, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 647 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCONNECTOR, drm_mode_getconnector, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 648 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATTACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 649 DRM_IOCTL_DEF(DRM_IOCTL_MODE_DETACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 650 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPERTY, drm_mode_getproperty_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 651 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPROPERTY, drm_mode_connector_property_set_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 652 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPBLOB, drm_mode_getblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 653 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETFB, drm_mode_getfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 654 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB, drm_mode_addfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 655 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB2, drm_mode_addfb2, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 656 DRM_IOCTL_DEF(DRM_IOCTL_MODE_RMFB, drm_mode_rmfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 657 DRM_IOCTL_DEF(DRM_IOCTL_MODE_PAGE_FLIP, drm_mode_page_flip_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 658 DRM_IOCTL_DEF(DRM_IOCTL_MODE_DIRTYFB, drm_mode_dirtyfb_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 659 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATE_DUMB, drm_mode_create_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 660 DRM_IOCTL_DEF(DRM_IOCTL_MODE_MAP_DUMB, drm_mode_mmap_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 661 DRM_IOCTL_DEF(DRM_IOCTL_MODE_DESTROY_DUMB, drm_mode_destroy_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 662 DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_GETPROPERTIES, drm_mode_obj_get_properties_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 663 DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_SETPROPERTY, drm_mode_obj_set_property_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 664 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR2, drm_mode_cursor2_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 665 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATOMIC, drm_mode_atomic_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 666 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATEPROPBLOB, drm_mode_createblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 667 DRM_IOCTL_DEF(DRM_IOCTL_MODE_DESTROYPROPBLOB, drm_mode_destroyblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED), 668 669 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_CREATE, drm_syncobj_create_ioctl, 670 DRM_UNLOCKED|DRM_RENDER_ALLOW), 671 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_DESTROY, drm_syncobj_destroy_ioctl, 672 DRM_UNLOCKED|DRM_RENDER_ALLOW), 673 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD, drm_syncobj_handle_to_fd_ioctl, 674 DRM_UNLOCKED|DRM_RENDER_ALLOW), 675 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE, drm_syncobj_fd_to_handle_ioctl, 676 DRM_UNLOCKED|DRM_RENDER_ALLOW), 677 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_WAIT, drm_syncobj_wait_ioctl, 678 DRM_UNLOCKED|DRM_RENDER_ALLOW), 679 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_RESET, drm_syncobj_reset_ioctl, 680 DRM_UNLOCKED|DRM_RENDER_ALLOW), 681 DRM_IOCTL_DEF(DRM_IOCTL_SYNCOBJ_SIGNAL, drm_syncobj_signal_ioctl, 682 DRM_UNLOCKED|DRM_RENDER_ALLOW), 683 DRM_IOCTL_DEF(DRM_IOCTL_CRTC_GET_SEQUENCE, drm_crtc_get_sequence_ioctl, DRM_UNLOCKED), 684 DRM_IOCTL_DEF(DRM_IOCTL_CRTC_QUEUE_SEQUENCE, drm_crtc_queue_sequence_ioctl, DRM_UNLOCKED), 685 #if 0 686 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATE_LEASE, drm_mode_create_lease_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 687 DRM_IOCTL_DEF(DRM_IOCTL_MODE_LIST_LESSEES, drm_mode_list_lessees_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 688 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GET_LEASE, drm_mode_get_lease_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 689 DRM_IOCTL_DEF(DRM_IOCTL_MODE_REVOKE_LEASE, drm_mode_revoke_lease_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED), 690 #endif 691 }; 692 693 #define DRM_CORE_IOCTL_COUNT ARRAY_SIZE( drm_ioctls ) 694 695 /** 696 * DOC: driver specific ioctls 697 * 698 * First things first, driver private IOCTLs should only be needed for drivers 699 * supporting rendering. Kernel modesetting is all standardized, and extended 700 * through properties. There are a few exceptions in some existing drivers, 701 * which define IOCTL for use by the display DRM master, but they all predate 702 * properties. 703 * 704 * Now if you do have a render driver you always have to support it through 705 * driver private properties. There's a few steps needed to wire all the things 706 * up. 707 * 708 * First you need to define the structure for your IOCTL in your driver private 709 * UAPI header in ``include/uapi/drm/my_driver_drm.h``:: 710 * 711 * struct my_driver_operation { 712 * u32 some_thing; 713 * u32 another_thing; 714 * }; 715 * 716 * Please make sure that you follow all the best practices from 717 * ``Documentation/ioctl/botching-up-ioctls.txt``. Note that drm_ioctl() 718 * automatically zero-extends structures, hence make sure you can add more stuff 719 * at the end, i.e. don't put a variable sized array there. 720 * 721 * Then you need to define your IOCTL number, using one of DRM_IO(), DRM_IOR(), 722 * DRM_IOW() or DRM_IOWR(). It must start with the DRM_IOCTL\_ prefix:: 723 * 724 * ##define DRM_IOCTL_MY_DRIVER_OPERATION \ 725 * DRM_IOW(DRM_COMMAND_BASE, struct my_driver_operation) 726 * 727 * DRM driver private IOCTL must be in the range from DRM_COMMAND_BASE to 728 * DRM_COMMAND_END. Finally you need an array of &struct drm_ioctl_desc to wire 729 * up the handlers and set the access rights:: 730 * 731 * static const struct drm_ioctl_desc my_driver_ioctls[] = { 732 * DRM_IOCTL_DEF_DRV(MY_DRIVER_OPERATION, my_driver_operation, 733 * DRM_AUTH|DRM_RENDER_ALLOW), 734 * }; 735 * 736 * And then assign this to the &drm_driver.ioctls field in your driver 737 * structure. 738 * 739 * See the separate chapter on :ref:`file operations<drm_driver_fops>` for how 740 * the driver-specific IOCTLs are wired up. 741 */ 742 743 #if 0 744 long drm_ioctl_kernel(struct file *file, drm_ioctl_t *func, void *kdata, 745 u32 flags) 746 { 747 struct drm_file *file_priv = file->private_data; 748 struct drm_device *dev = file_priv->minor->dev; 749 int retcode; 750 751 if (drm_dev_is_unplugged(dev)) 752 return -ENODEV; 753 754 retcode = drm_ioctl_permit(flags, file_priv); 755 if (unlikely(retcode)) 756 return retcode; 757 758 /* Enforce sane locking for modern driver ioctls. */ 759 if (!drm_core_check_feature(dev, DRIVER_LEGACY) || 760 (flags & DRM_UNLOCKED)) 761 retcode = func(dev, kdata, file_priv); 762 else { 763 mutex_lock(&drm_global_mutex); 764 retcode = func(dev, kdata, file_priv); 765 mutex_unlock(&drm_global_mutex); 766 } 767 return retcode; 768 } 769 EXPORT_SYMBOL(drm_ioctl_kernel); 770 #endif 771 772 /** 773 * drm_ioctl - ioctl callback implementation for DRM drivers 774 * @filp: file this ioctl is called on 775 * @cmd: ioctl cmd number 776 * @arg: user argument 777 * 778 * Looks up the ioctl function in the DRM core and the driver dispatch table, 779 * stored in &drm_driver.ioctls. It checks for necessary permission by calling 780 * drm_ioctl_permit(), and dispatches to the respective function. 781 * 782 * Returns: 783 * Zero on success, negative error code on failure. 784 */ 785 int drm_ioctl(struct dev_ioctl_args *ap) 786 { 787 struct file *filp = ap->a_fp; 788 u_long cmd = ap->a_cmd; 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 caddr_t data = ap->a_data; 796 bool is_driver_ioctl; 797 798 dev = file_priv->minor->dev; 799 800 if (drm_dev_is_unplugged(dev)) 801 return -ENODEV; 802 803 is_driver_ioctl = nr >= DRM_COMMAND_BASE && nr < DRM_COMMAND_END; 804 805 if (is_driver_ioctl) { 806 /* driver ioctl */ 807 if (nr - DRM_COMMAND_BASE >= dev->driver->num_ioctls) 808 goto err_i1; 809 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE]; 810 } else { 811 /* core ioctl */ 812 if (nr >= DRM_CORE_IOCTL_COUNT) 813 goto err_i1; 814 ioctl = &drm_ioctls[nr]; 815 } 816 817 DRM_DEBUG_IOCTL("pid=%d, dev=0x%lx, auth=%d, %s\n", 818 DRM_CURRENTPID, 819 (long)dev->dev, 820 file_priv->authenticated, ioctl->name); 821 822 /* Do not trust userspace, use our own definition */ 823 func = ioctl->func; 824 825 if (unlikely(!func)) { 826 DRM_DEBUG("no function\n"); 827 retcode = -EINVAL; 828 goto err_i1; 829 } 830 831 retcode = drm_ioctl_permit(ioctl->flags, file_priv); 832 if (unlikely(retcode)) 833 goto err_i1; 834 835 /* Enforce sane locking for modern driver ioctls. */ 836 if (!drm_core_check_feature(dev, DRIVER_LEGACY) || 837 (ioctl->flags & DRM_UNLOCKED)) 838 retcode = -func(dev, data, file_priv); 839 else { 840 mutex_lock(&drm_global_mutex); 841 retcode = -func(dev, data, file_priv); 842 mutex_unlock(&drm_global_mutex); 843 } 844 845 if (retcode == ERESTARTSYS) 846 retcode = EINTR; 847 848 err_i1: 849 if (!ioctl) 850 DRM_DEBUG_FIOCTL("invalid ioctl: pid=%d, dev=0x%lx, auth=%d, cmd=0x%02lx, nr=0x%02x\n", 851 DRM_CURRENTPID, 852 (long)dev->dev, 853 file_priv->authenticated, cmd, nr); 854 855 if (retcode) 856 DRM_DEBUG_FIOCTL("ret = %d\n", retcode); 857 return retcode; 858 } 859 EXPORT_SYMBOL(drm_ioctl); 860 861 /** 862 * drm_ioctl_flags - Check for core ioctl and return ioctl permission flags 863 * @nr: ioctl number 864 * @flags: where to return the ioctl permission flags 865 * 866 * This ioctl is only used by the vmwgfx driver to augment the access checks 867 * done by the drm core and insofar a pretty decent layering violation. This 868 * shouldn't be used by any drivers. 869 * 870 * Returns: 871 * True if the @nr corresponds to a DRM core ioctl number, false otherwise. 872 */ 873 bool drm_ioctl_flags(unsigned int nr, unsigned int *flags) 874 { 875 if (nr >= DRM_COMMAND_BASE && nr < DRM_COMMAND_END) 876 return false; 877 878 if (nr >= DRM_CORE_IOCTL_COUNT) 879 return false; 880 881 *flags = drm_ioctls[nr].flags; 882 return true; 883 } 884 EXPORT_SYMBOL(drm_ioctl_flags); 885