drivers/gpu/drm/drm_drv.c

   1 /**
   2  * \file drm_drv.c
   3  * Generic driver template
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  *
   8  * To use this template, you must at least define the following (samples
   9  * given for the MGA driver):
  10  *
  11  * \code
  12  * #define DRIVER_AUTHOR        "VA Linux Systems, Inc."
  13  *
  14  * #define DRIVER_NAME          "mga"
  15  * #define DRIVER_DESC          "Matrox G200/G400"
  16  * #define DRIVER_DATE          "20001127"
  17  *
  18  * #define drm_x                mga_##x
  19  * \endcode
  20  */
  21
  22 /*
  23  * Created: Thu Nov 23 03:10:50 2000 by gareth@valinux.com
  24  *
  25  * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
  26  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  27  * All Rights Reserved.
  28  *
  29  * Permission is hereby granted, free of charge, to any person obtaining a
  30  * copy of this software and associated documentation files (the "Software"),
  31  * to deal in the Software without restriction, including without limitation
  32  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  33  * and/or sell copies of the Software, and to permit persons to whom the
  34  * Software is furnished to do so, subject to the following conditions:
  35  *
  36  * The above copyright notice and this permission notice (including the next
  37  * paragraph) shall be included in all copies or substantial portions of the
  38  * Software.
  39  *
  40  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  41  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  42  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  43  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  44  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  45  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  46  * OTHER DEALINGS IN THE SOFTWARE.
  47  */
  48
  49 #include <linux/debugfs.h>
  50 #include <linux/slab.h>
  51 #include <linux/export.h>
  52 #include <drm/drmP.h>
  53 #include <drm/drm_core.h>
  54
  55
  56 static int drm_version(struct drm_device *dev, void *data,
  57                        struct drm_file *file_priv);
  58
  59 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
  60         [DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0, .name = #ioctl}
  61
  62 /** Ioctl table */
  63 static const struct drm_ioctl_desc drm_ioctls[] = {
  64         DRM_IOCTL_DEF(DRM_IOCTL_VERSION, drm_version, DRM_UNLOCKED),
  65         DRM_IOCTL_DEF(DRM_IOCTL_GET_UNIQUE, drm_getunique, 0),
  66         DRM_IOCTL_DEF(DRM_IOCTL_GET_MAGIC, drm_getmagic, 0),
  67         DRM_IOCTL_DEF(DRM_IOCTL_IRQ_BUSID, drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY),
  68         DRM_IOCTL_DEF(DRM_IOCTL_GET_MAP, drm_getmap, DRM_UNLOCKED),
  69         DRM_IOCTL_DEF(DRM_IOCTL_GET_CLIENT, drm_getclient, DRM_UNLOCKED),
  70         DRM_IOCTL_DEF(DRM_IOCTL_GET_STATS, drm_getstats, DRM_UNLOCKED),
  71         DRM_IOCTL_DEF(DRM_IOCTL_GET_CAP, drm_getcap, DRM_UNLOCKED),
  72         DRM_IOCTL_DEF(DRM_IOCTL_SET_VERSION, drm_setversion, DRM_MASTER),
  73
  74         DRM_IOCTL_DEF(DRM_IOCTL_SET_UNIQUE, drm_setunique, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  75         DRM_IOCTL_DEF(DRM_IOCTL_BLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  76         DRM_IOCTL_DEF(DRM_IOCTL_UNBLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  77         DRM_IOCTL_DEF(DRM_IOCTL_AUTH_MAGIC, drm_authmagic, DRM_AUTH|DRM_MASTER),
  78
  79         DRM_IOCTL_DEF(DRM_IOCTL_ADD_MAP, drm_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  80         DRM_IOCTL_DEF(DRM_IOCTL_RM_MAP, drm_rmmap_ioctl, DRM_AUTH),
  81
  82         DRM_IOCTL_DEF(DRM_IOCTL_SET_SAREA_CTX, drm_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  83         DRM_IOCTL_DEF(DRM_IOCTL_GET_SAREA_CTX, drm_getsareactx, DRM_AUTH),
  84
  85         DRM_IOCTL_DEF(DRM_IOCTL_SET_MASTER, drm_setmaster_ioctl, DRM_ROOT_ONLY),
  86         DRM_IOCTL_DEF(DRM_IOCTL_DROP_MASTER, drm_dropmaster_ioctl, DRM_ROOT_ONLY),
  87
  88         DRM_IOCTL_DEF(DRM_IOCTL_ADD_CTX, drm_addctx, DRM_AUTH|DRM_ROOT_ONLY),
  89         DRM_IOCTL_DEF(DRM_IOCTL_RM_CTX, drm_rmctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  90         DRM_IOCTL_DEF(DRM_IOCTL_MOD_CTX, drm_modctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  91         DRM_IOCTL_DEF(DRM_IOCTL_GET_CTX, drm_getctx, DRM_AUTH),
  92         DRM_IOCTL_DEF(DRM_IOCTL_SWITCH_CTX, drm_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  93         DRM_IOCTL_DEF(DRM_IOCTL_NEW_CTX, drm_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  94         DRM_IOCTL_DEF(DRM_IOCTL_RES_CTX, drm_resctx, DRM_AUTH),
  95
  96         DRM_IOCTL_DEF(DRM_IOCTL_ADD_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  97         DRM_IOCTL_DEF(DRM_IOCTL_RM_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
  98
  99         DRM_IOCTL_DEF(DRM_IOCTL_LOCK, drm_lock, DRM_AUTH),
 100         DRM_IOCTL_DEF(DRM_IOCTL_UNLOCK, drm_unlock, DRM_AUTH),
 101
 102         DRM_IOCTL_DEF(DRM_IOCTL_FINISH, drm_noop, DRM_AUTH),
 103
 104         DRM_IOCTL_DEF(DRM_IOCTL_ADD_BUFS, drm_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 105         DRM_IOCTL_DEF(DRM_IOCTL_MARK_BUFS, drm_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 106         DRM_IOCTL_DEF(DRM_IOCTL_INFO_BUFS, drm_infobufs, DRM_AUTH),
 107         DRM_IOCTL_DEF(DRM_IOCTL_MAP_BUFS, drm_mapbufs, DRM_AUTH),
 108         DRM_IOCTL_DEF(DRM_IOCTL_FREE_BUFS, drm_freebufs, DRM_AUTH),
 109         /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
 110         DRM_IOCTL_DEF(DRM_IOCTL_DMA, NULL, DRM_AUTH),
 111
 112         DRM_IOCTL_DEF(DRM_IOCTL_CONTROL, drm_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 113
 114 #if __OS_HAS_AGP
 115         DRM_IOCTL_DEF(DRM_IOCTL_AGP_ACQUIRE, drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 116         DRM_IOCTL_DEF(DRM_IOCTL_AGP_RELEASE, drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 117         DRM_IOCTL_DEF(DRM_IOCTL_AGP_ENABLE, drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 118         DRM_IOCTL_DEF(DRM_IOCTL_AGP_INFO, drm_agp_info_ioctl, DRM_AUTH),
 119         DRM_IOCTL_DEF(DRM_IOCTL_AGP_ALLOC, drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 120         DRM_IOCTL_DEF(DRM_IOCTL_AGP_FREE, drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 121         DRM_IOCTL_DEF(DRM_IOCTL_AGP_BIND, drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 122         DRM_IOCTL_DEF(DRM_IOCTL_AGP_UNBIND, drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 123 #endif
 124
 125         DRM_IOCTL_DEF(DRM_IOCTL_SG_ALLOC, drm_sg_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 126         DRM_IOCTL_DEF(DRM_IOCTL_SG_FREE, drm_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 127
 128         DRM_IOCTL_DEF(DRM_IOCTL_WAIT_VBLANK, drm_wait_vblank, DRM_UNLOCKED),
 129
 130         DRM_IOCTL_DEF(DRM_IOCTL_MODESET_CTL, drm_modeset_ctl, 0),
 131
 132         DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
 133
 134         DRM_IOCTL_DEF(DRM_IOCTL_GEM_CLOSE, drm_gem_close_ioctl, DRM_UNLOCKED),
 135         DRM_IOCTL_DEF(DRM_IOCTL_GEM_FLINK, drm_gem_flink_ioctl, DRM_AUTH|DRM_UNLOCKED),
 136         DRM_IOCTL_DEF(DRM_IOCTL_GEM_OPEN, drm_gem_open_ioctl, DRM_AUTH|DRM_UNLOCKED),
 137
 138         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETRESOURCES, drm_mode_getresources, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 139
 140         DRM_IOCTL_DEF(DRM_IOCTL_PRIME_HANDLE_TO_FD, drm_prime_handle_to_fd_ioctl, DRM_AUTH|DRM_UNLOCKED),
 141         DRM_IOCTL_DEF(DRM_IOCTL_PRIME_FD_TO_HANDLE, drm_prime_fd_to_handle_ioctl, DRM_AUTH|DRM_UNLOCKED),
 142
 143         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANERESOURCES, drm_mode_getplane_res, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 144         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCRTC, drm_mode_getcrtc, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 145         DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETCRTC, drm_mode_setcrtc, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 146         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPLANE, drm_mode_getplane, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 147         DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPLANE, drm_mode_setplane, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 148         DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR, drm_mode_cursor_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 149         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETGAMMA, drm_mode_gamma_get_ioctl, DRM_UNLOCKED),
 150         DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETGAMMA, drm_mode_gamma_set_ioctl, DRM_MASTER|DRM_UNLOCKED),
 151         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETENCODER, drm_mode_getencoder, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 152         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCONNECTOR, drm_mode_getconnector, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 153         DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATTACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 154         DRM_IOCTL_DEF(DRM_IOCTL_MODE_DETACHMODE, drm_noop, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 155         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPERTY, drm_mode_getproperty_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 156         DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPROPERTY, drm_mode_connector_property_set_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 157         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPBLOB, drm_mode_getblob_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 158         DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETFB, drm_mode_getfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 159         DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB, drm_mode_addfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 160         DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB2, drm_mode_addfb2, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 161         DRM_IOCTL_DEF(DRM_IOCTL_MODE_RMFB, drm_mode_rmfb, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 162         DRM_IOCTL_DEF(DRM_IOCTL_MODE_PAGE_FLIP, drm_mode_page_flip_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 163         DRM_IOCTL_DEF(DRM_IOCTL_MODE_DIRTYFB, drm_mode_dirtyfb_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 164         DRM_IOCTL_DEF(DRM_IOCTL_MODE_CREATE_DUMB, drm_mode_create_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 165         DRM_IOCTL_DEF(DRM_IOCTL_MODE_MAP_DUMB, drm_mode_mmap_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 166         DRM_IOCTL_DEF(DRM_IOCTL_MODE_DESTROY_DUMB, drm_mode_destroy_dumb_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 167         DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_GETPROPERTIES, drm_mode_obj_get_properties_ioctl, DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 168         DRM_IOCTL_DEF(DRM_IOCTL_MODE_OBJ_SETPROPERTY, drm_mode_obj_set_property_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW|DRM_UNLOCKED),
 169 };
 170
 171 #define DRM_CORE_IOCTL_COUNT    ARRAY_SIZE( drm_ioctls )
 172
 173 /**
 174  * Take down the DRM device.
 175  *
 176  * \param dev DRM device structure.
 177  *
 178  * Frees every resource in \p dev.
 179  *
 180  * \sa drm_device
 181  */
 182 int drm_lastclose(struct drm_device * dev)
 183 {
 184         struct drm_vma_entry *vma, *vma_temp;
 185
 186         DRM_DEBUG("\n");
 187
 188         if (dev->driver->lastclose)
 189                 dev->driver->lastclose(dev);
 190         DRM_DEBUG("driver lastclose completed\n");
 191
 192         if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
 193                 drm_irq_uninstall(dev);
 194
 195         mutex_lock(&dev->struct_mutex);
 196
 197         /* Clear AGP information */
 198         if (drm_core_has_AGP(dev) && dev->agp &&
 199                         !drm_core_check_feature(dev, DRIVER_MODESET)) {
 200                 struct drm_agp_mem *entry, *tempe;
 201
 202                 /* Remove AGP resources, but leave dev->agp
 203                    intact until drv_cleanup is called. */
 204                 list_for_each_entry_safe(entry, tempe, &dev->agp->memory, head) {
 205                         if (entry->bound)
 206                                 drm_unbind_agp(entry->memory);
 207                         drm_free_agp(entry->memory, entry->pages);
 208                         kfree(entry);
 209                 }
 210                 INIT_LIST_HEAD(&dev->agp->memory);
 211
 212                 if (dev->agp->acquired)
 213                         drm_agp_release(dev);
 214
 215                 dev->agp->acquired = 0;
 216                 dev->agp->enabled = 0;
 217         }
 218         if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg &&
 219             !drm_core_check_feature(dev, DRIVER_MODESET)) {
 220                 drm_sg_cleanup(dev->sg);
 221                 dev->sg = NULL;
 222         }
 223
 224         /* Clear vma list (only built for debugging) */
 225         list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
 226                 list_del(&vma->head);
 227                 kfree(vma);
 228         }
 229
 230         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
 231             !drm_core_check_feature(dev, DRIVER_MODESET))
 232                 drm_dma_takedown(dev);
 233
 234         dev->dev_mapping = NULL;
 235         mutex_unlock(&dev->struct_mutex);
 236
 237         DRM_DEBUG("lastclose completed\n");
 238         return 0;
 239 }
 240
 241 /** File operations structure */
 242 static const struct file_operations drm_stub_fops = {
 243         .owner = THIS_MODULE,
 244         .open = drm_stub_open,
 245         .llseek = noop_llseek,
 246 };
 247
 248 static int __init drm_core_init(void)
 249 {
 250         int ret = -ENOMEM;
 251
 252         drm_global_init();
 253         idr_init(&drm_minors_idr);
 254
 255         if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
 256                 goto err_p1;
 257
 258         drm_class = drm_sysfs_create(THIS_MODULE, "drm");
 259         if (IS_ERR(drm_class)) {
 260                 printk(KERN_ERR "DRM: Error creating drm class.\n");
 261                 ret = PTR_ERR(drm_class);
 262                 goto err_p2;
 263         }
 264
 265         drm_proc_root = proc_mkdir("dri", NULL);
 266         if (!drm_proc_root) {
 267                 DRM_ERROR("Cannot create /proc/dri\n");
 268                 ret = -1;
 269                 goto err_p3;
 270         }
 271
 272         drm_debugfs_root = debugfs_create_dir("dri", NULL);
 273         if (!drm_debugfs_root) {
 274                 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
 275                 ret = -1;
 276                 goto err_p3;
 277         }
 278
 279         DRM_INFO("Initialized %s %d.%d.%d %s\n",
 280                  CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
 281         return 0;
 282 err_p3:
 283         drm_sysfs_destroy();
 284 err_p2:
 285         unregister_chrdev(DRM_MAJOR, "drm");
 286
 287         idr_destroy(&drm_minors_idr);
 288 err_p1:
 289         return ret;
 290 }
 291
 292 static void __exit drm_core_exit(void)
 293 {
 294         remove_proc_entry("dri", NULL);
 295         debugfs_remove(drm_debugfs_root);
 296         drm_sysfs_destroy();
 297
 298         unregister_chrdev(DRM_MAJOR, "drm");
 299
 300         idr_destroy(&drm_minors_idr);
 301 }
 302
 303 module_init(drm_core_init);
 304 module_exit(drm_core_exit);
 305
 306 /**
 307  * Copy and IOCTL return string to user space
 308  */
 309 static int drm_copy_field(char *buf, size_t *buf_len, const char *value)
 310 {
 311         int len;
 312
 313         /* don't overflow userbuf */
 314         len = strlen(value);
 315         if (len > *buf_len)
 316                 len = *buf_len;
 317
 318         /* let userspace know exact length of driver value (which could be
 319          * larger than the userspace-supplied buffer) */
 320         *buf_len = strlen(value);
 321
 322         /* finally, try filling in the userbuf */
 323         if (len && buf)
 324                 if (copy_to_user(buf, value, len))
 325                         return -EFAULT;
 326         return 0;
 327 }
 328
 329 /**
 330  * Get version information
 331  *
 332  * \param inode device inode.
 333  * \param filp file pointer.
 334  * \param cmd command.
 335  * \param arg user argument, pointing to a drm_version structure.
 336  * \return zero on success or negative number on failure.
 337  *
 338  * Fills in the version information in \p arg.
 339  */
 340 static int drm_version(struct drm_device *dev, void *data,
 341                        struct drm_file *file_priv)
 342 {
 343         struct drm_version *version = data;
 344         int err;
 345
 346         version->version_major = dev->driver->major;
 347         version->version_minor = dev->driver->minor;
 348         version->version_patchlevel = dev->driver->patchlevel;
 349         err = drm_copy_field(version->name, &version->name_len,
 350                         dev->driver->name);
 351         if (!err)
 352                 err = drm_copy_field(version->date, &version->date_len,
 353                                 dev->driver->date);
 354         if (!err)
 355                 err = drm_copy_field(version->desc, &version->desc_len,
 356                                 dev->driver->desc);
 357
 358         return err;
 359 }
 360
 361 /**
 362  * Called whenever a process performs an ioctl on /dev/drm.
 363  *
 364  * \param inode device inode.
 365  * \param file_priv DRM file private.
 366  * \param cmd command.
 367  * \param arg user argument.
 368  * \return zero on success or negative number on failure.
 369  *
 370  * Looks up the ioctl function in the ::ioctls table, checking for root
 371  * previleges if so required, and dispatches to the respective function.
 372  */
 373 long drm_ioctl(struct file *filp,
 374               unsigned int cmd, unsigned long arg)
 375 {
 376         struct drm_file *file_priv = filp->private_data;
 377         struct drm_device *dev;
 378         const struct drm_ioctl_desc *ioctl = NULL;
 379         drm_ioctl_t *func;
 380         unsigned int nr = DRM_IOCTL_NR(cmd);
 381         int retcode = -EINVAL;
 382         char stack_kdata[128];
 383         char *kdata = NULL;
 384         unsigned int usize, asize;
 385
 386         dev = file_priv->minor->dev;
 387
 388         if (drm_device_is_unplugged(dev))
 389                 return -ENODEV;
 390
 391         atomic_inc(&dev->ioctl_count);
 392         atomic_inc(&dev->counts[_DRM_STAT_IOCTLS]);
 393         ++file_priv->ioctl_count;
 394
 395         if ((nr >= DRM_CORE_IOCTL_COUNT) &&
 396             ((nr < DRM_COMMAND_BASE) || (nr >= DRM_COMMAND_END)))
 397                 goto err_i1;
 398         if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_END) &&
 399             (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls)) {
 400                 u32 drv_size;
 401                 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
 402                 drv_size = _IOC_SIZE(ioctl->cmd_drv);
 403                 usize = asize = _IOC_SIZE(cmd);
 404                 if (drv_size > asize)
 405                         asize = drv_size;
 406                 cmd = ioctl->cmd_drv;
 407         }
 408         else if ((nr >= DRM_COMMAND_END) || (nr < DRM_COMMAND_BASE)) {
 409                 ioctl = &drm_ioctls[nr];
 410                 cmd = ioctl->cmd;
 411                 usize = asize = _IOC_SIZE(cmd);
 412         } else
 413                 goto err_i1;
 414
 415         DRM_DEBUG("pid=%d, dev=0x%lx, auth=%d, %s\n",
 416                   task_pid_nr(current),
 417                   (long)old_encode_dev(file_priv->minor->device),
 418                   file_priv->authenticated, ioctl->name);
 419
 420         /* Do not trust userspace, use our own definition */
 421         func = ioctl->func;
 422         /* is there a local override? */
 423         if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
 424                 func = dev->driver->dma_ioctl;
 425
 426         if (!func) {
 427                 DRM_DEBUG("no function\n");
 428                 retcode = -EINVAL;
 429         } else if (((ioctl->flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN)) ||
 430                    ((ioctl->flags & DRM_AUTH) && !file_priv->authenticated) ||
 431                    ((ioctl->flags & DRM_MASTER) && !file_priv->is_master) ||
 432                    (!(ioctl->flags & DRM_CONTROL_ALLOW) && (file_priv->minor->type == DRM_MINOR_CONTROL))) {
 433                 retcode = -EACCES;
 434         } else {
 435                 if (cmd & (IOC_IN | IOC_OUT)) {
 436                         if (asize <= sizeof(stack_kdata)) {
 437                                 kdata = stack_kdata;
 438                         } else {
 439                                 kdata = kmalloc(asize, GFP_KERNEL);
 440                                 if (!kdata) {
 441                                         retcode = -ENOMEM;
 442                                         goto err_i1;
 443                                 }
 444                         }
 445                         if (asize > usize)
 446                                 memset(kdata + usize, 0, asize - usize);
 447                 }
 448
 449                 if (cmd & IOC_IN) {
 450                         if (copy_from_user(kdata, (void __user *)arg,
 451                                            usize) != 0) {
 452                                 retcode = -EFAULT;
 453                                 goto err_i1;
 454                         }
 455                 } else
 456                         memset(kdata, 0, usize);
 457
 458                 if (ioctl->flags & DRM_UNLOCKED)
 459                         retcode = func(dev, kdata, file_priv);
 460                 else {
 461                         mutex_lock(&drm_global_mutex);
 462                         retcode = func(dev, kdata, file_priv);
 463                         mutex_unlock(&drm_global_mutex);
 464                 }
 465
 466                 if (cmd & IOC_OUT) {
 467                         if (copy_to_user((void __user *)arg, kdata,
 468                                          usize) != 0)
 469                                 retcode = -EFAULT;
 470                 }
 471         }
 472
 473       err_i1:
 474         if (!ioctl)
 475                 DRM_DEBUG("invalid iotcl: pid=%d, dev=0x%lx, auth=%d, cmd=0x%02x, nr=0x%02x\n",
 476                           task_pid_nr(current),
 477                           (long)old_encode_dev(file_priv->minor->device),
 478                           file_priv->authenticated, cmd, nr);
 479
 480         if (kdata != stack_kdata)
 481                 kfree(kdata);
 482         atomic_dec(&dev->ioctl_count);
 483         if (retcode)
 484                 DRM_DEBUG("ret = %d\n", retcode);
 485         return retcode;
 486 }
 487
 488 EXPORT_SYMBOL(drm_ioctl);
 489
 490 struct drm_local_map *drm_getsarea(struct drm_device *dev)
 491 {
 492         struct drm_map_list *entry;
 493
 494         list_for_each_entry(entry, &dev->maplist, head) {
 495                 if (entry->map && entry->map->type == _DRM_SHM &&
 496                     (entry->map->flags & _DRM_CONTAINS_LOCK)) {
 497                         return entry->map;
 498                 }
 499         }
 500         return NULL;
 501 }
 502 EXPORT_SYMBOL(drm_getsarea);