drivers/gpu/drm/drm_stub.c

   1 /**
   2  * \file drm_stub.h
   3  * Stub support
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  */
   7
   8 /*
   9  * Created: Fri Jan 19 10:48:35 2001 by faith@acm.org
  10  *
  11  * Copyright 2001 VA Linux Systems, Inc., Sunnyvale, California.
  12  * All Rights Reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice (including the next
  22  * paragraph) shall be included in all copies or substantial portions of the
  23  * Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  28  * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  31  * DEALINGS IN THE SOFTWARE.
  32  */
  33
  34 #include <linux/module.h>
  35 #include <linux/moduleparam.h>
  36 #include <linux/slab.h>
  37 #include <drm/drmP.h>
  38 #include <drm/drm_core.h>
  39
  40 unsigned int drm_debug = 0;     /* 1 to enable debug output */
  41 EXPORT_SYMBOL(drm_debug);
  42
  43 unsigned int drm_rnodes = 0;    /* 1 to enable experimental render nodes API */
  44 EXPORT_SYMBOL(drm_rnodes);
  45
  46 unsigned int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */
  47 EXPORT_SYMBOL(drm_vblank_offdelay);
  48
  49 unsigned int drm_timestamp_precision = 20;  /* Default to 20 usecs. */
  50 EXPORT_SYMBOL(drm_timestamp_precision);
  51
  52 /*
  53  * Default to use monotonic timestamps for wait-for-vblank and page-flip
  54  * complete events.
  55  */
  56 unsigned int drm_timestamp_monotonic = 1;
  57
  58 MODULE_AUTHOR(CORE_AUTHOR);
  59 MODULE_DESCRIPTION(CORE_DESC);
  60 MODULE_LICENSE("GPL and additional rights");
  61 MODULE_PARM_DESC(debug, "Enable debug output");
  62 MODULE_PARM_DESC(rnodes, "Enable experimental render nodes API");
  63 MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs]");
  64 MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");
  65 MODULE_PARM_DESC(timestamp_monotonic, "Use monotonic timestamps");
  66
  67 module_param_named(debug, drm_debug, int, 0600);
  68 module_param_named(rnodes, drm_rnodes, int, 0600);
  69 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
  70 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
  71 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
  72
  73 struct idr drm_minors_idr;
  74
  75 struct class *drm_class;
  76 struct dentry *drm_debugfs_root;
  77
  78 int drm_err(const char *func, const char *format, ...)
  79 {
  80         struct va_format vaf;
  81         va_list args;
  82         int r;
  83
  84         va_start(args, format);
  85
  86         vaf.fmt = format;
  87         vaf.va = &args;
  88
  89         r = printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* %pV", func, &vaf);
  90
  91         va_end(args);
  92
  93         return r;
  94 }
  95 EXPORT_SYMBOL(drm_err);
  96
  97 void drm_ut_debug_printk(unsigned int request_level,
  98                          const char *prefix,
  99                          const char *function_name,
 100                          const char *format, ...)
 101 {
 102         va_list args;
 103
 104         if (drm_debug & request_level) {
 105                 if (function_name)
 106                         printk(KERN_DEBUG "[%s:%s], ", prefix, function_name);
 107                 va_start(args, format);
 108                 vprintk(format, args);
 109                 va_end(args);
 110         }
 111 }
 112 EXPORT_SYMBOL(drm_ut_debug_printk);
 113
 114 static int drm_minor_get_id(struct drm_device *dev, int type)
 115 {
 116         int ret;
 117         int base = 0, limit = 63;
 118
 119         if (type == DRM_MINOR_CONTROL) {
 120                 base += 64;
 121                 limit = base + 63;
 122         } else if (type == DRM_MINOR_RENDER) {
 123                 base += 128;
 124                 limit = base + 63;
 125         }
 126
 127         mutex_lock(&dev->struct_mutex);
 128         ret = idr_alloc(&drm_minors_idr, NULL, base, limit, GFP_KERNEL);
 129         mutex_unlock(&dev->struct_mutex);
 130
 131         return ret == -ENOSPC ? -EINVAL : ret;
 132 }
 133
 134 struct drm_master *drm_master_create(struct drm_minor *minor)
 135 {
 136         struct drm_master *master;
 137
 138         master = kzalloc(sizeof(*master), GFP_KERNEL);
 139         if (!master)
 140                 return NULL;
 141
 142         kref_init(&master->refcount);
 143         spin_lock_init(&master->lock.spinlock);
 144         init_waitqueue_head(&master->lock.lock_queue);
 145         drm_ht_create(&master->magiclist, DRM_MAGIC_HASH_ORDER);
 146         INIT_LIST_HEAD(&master->magicfree);
 147         master->minor = minor;
 148
 149         list_add_tail(&master->head, &minor->master_list);
 150
 151         return master;
 152 }
 153
 154 struct drm_master *drm_master_get(struct drm_master *master)
 155 {
 156         kref_get(&master->refcount);
 157         return master;
 158 }
 159 EXPORT_SYMBOL(drm_master_get);
 160
 161 static void drm_master_destroy(struct kref *kref)
 162 {
 163         struct drm_master *master = container_of(kref, struct drm_master, refcount);
 164         struct drm_magic_entry *pt, *next;
 165         struct drm_device *dev = master->minor->dev;
 166         struct drm_map_list *r_list, *list_temp;
 167
 168         list_del(&master->head);
 169
 170         if (dev->driver->master_destroy)
 171                 dev->driver->master_destroy(dev, master);
 172
 173         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
 174                 if (r_list->master == master) {
 175                         drm_rmmap_locked(dev, r_list->map);
 176                         r_list = NULL;
 177                 }
 178         }
 179
 180         if (master->unique) {
 181                 kfree(master->unique);
 182                 master->unique = NULL;
 183                 master->unique_len = 0;
 184         }
 185
 186         kfree(dev->devname);
 187         dev->devname = NULL;
 188
 189         list_for_each_entry_safe(pt, next, &master->magicfree, head) {
 190                 list_del(&pt->head);
 191                 drm_ht_remove_item(&master->magiclist, &pt->hash_item);
 192                 kfree(pt);
 193         }
 194
 195         drm_ht_remove(&master->magiclist);
 196
 197         kfree(master);
 198 }
 199
 200 void drm_master_put(struct drm_master **master)
 201 {
 202         kref_put(&(*master)->refcount, drm_master_destroy);
 203         *master = NULL;
 204 }
 205 EXPORT_SYMBOL(drm_master_put);
 206
 207 int drm_setmaster_ioctl(struct drm_device *dev, void *data,
 208                         struct drm_file *file_priv)
 209 {
 210         int ret = 0;
 211
 212         if (file_priv->is_master)
 213                 return 0;
 214
 215         if (file_priv->minor->master && file_priv->minor->master != file_priv->master)
 216                 return -EINVAL;
 217
 218         if (!file_priv->master)
 219                 return -EINVAL;
 220
 221         if (file_priv->minor->master)
 222                 return -EINVAL;
 223
 224         mutex_lock(&dev->struct_mutex);
 225         file_priv->minor->master = drm_master_get(file_priv->master);
 226         file_priv->is_master = 1;
 227         if (dev->driver->master_set) {
 228                 ret = dev->driver->master_set(dev, file_priv, false);
 229                 if (unlikely(ret != 0)) {
 230                         file_priv->is_master = 0;
 231                         drm_master_put(&file_priv->minor->master);
 232                 }
 233         }
 234         mutex_unlock(&dev->struct_mutex);
 235
 236         return ret;
 237 }
 238
 239 int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
 240                          struct drm_file *file_priv)
 241 {
 242         if (!file_priv->is_master)
 243                 return -EINVAL;
 244
 245         if (!file_priv->minor->master)
 246                 return -EINVAL;
 247
 248         mutex_lock(&dev->struct_mutex);
 249         if (dev->driver->master_drop)
 250                 dev->driver->master_drop(dev, file_priv, false);
 251         drm_master_put(&file_priv->minor->master);
 252         file_priv->is_master = 0;
 253         mutex_unlock(&dev->struct_mutex);
 254         return 0;
 255 }
 256
 257 /**
 258  * drm_get_minor - Allocate and register new DRM minor
 259  * @dev: DRM device
 260  * @minor: Pointer to where new minor is stored
 261  * @type: Type of minor
 262  *
 263  * Allocate a new minor of the given type and register it. A pointer to the new
 264  * minor is returned in @minor.
 265  * Caller must hold the global DRM mutex.
 266  *
 267  * RETURNS:
 268  * 0 on success, negative error code on failure.
 269  */
 270 static int drm_get_minor(struct drm_device *dev, struct drm_minor **minor,
 271                          int type)
 272 {
 273         struct drm_minor *new_minor;
 274         int ret;
 275         int minor_id;
 276
 277         DRM_DEBUG("\n");
 278
 279         minor_id = drm_minor_get_id(dev, type);
 280         if (minor_id < 0)
 281                 return minor_id;
 282
 283         new_minor = kzalloc(sizeof(struct drm_minor), GFP_KERNEL);
 284         if (!new_minor) {
 285                 ret = -ENOMEM;
 286                 goto err_idr;
 287         }
 288
 289         new_minor->type = type;
 290         new_minor->device = MKDEV(DRM_MAJOR, minor_id);
 291         new_minor->dev = dev;
 292         new_minor->index = minor_id;
 293         INIT_LIST_HEAD(&new_minor->master_list);
 294
 295         idr_replace(&drm_minors_idr, new_minor, minor_id);
 296
 297 #if defined(CONFIG_DEBUG_FS)
 298         ret = drm_debugfs_init(new_minor, minor_id, drm_debugfs_root);
 299         if (ret) {
 300                 DRM_ERROR("DRM: Failed to initialize /sys/kernel/debug/dri.\n");
 301                 goto err_mem;
 302         }
 303 #endif
 304
 305         ret = drm_sysfs_device_add(new_minor);
 306         if (ret) {
 307                 printk(KERN_ERR
 308                        "DRM: Error sysfs_device_add.\n");
 309                 goto err_debugfs;
 310         }
 311         *minor = new_minor;
 312
 313         DRM_DEBUG("new minor assigned %d\n", minor_id);
 314         return 0;
 315
 316
 317 err_debugfs:
 318 #if defined(CONFIG_DEBUG_FS)
 319         drm_debugfs_cleanup(new_minor);
 320 err_mem:
 321 #endif
 322         kfree(new_minor);
 323 err_idr:
 324         idr_remove(&drm_minors_idr, minor_id);
 325         *minor = NULL;
 326         return ret;
 327 }
 328
 329 /**
 330  * drm_unplug_minor - Unplug DRM minor
 331  * @minor: Minor to unplug
 332  *
 333  * Unplugs the given DRM minor but keeps the object. So after this returns,
 334  * minor->dev is still valid so existing open-files can still access it to get
 335  * device information from their drm_file ojects.
 336  * If the minor is already unplugged or if @minor is NULL, nothing is done.
 337  * The global DRM mutex must be held by the caller.
 338  */
 339 static void drm_unplug_minor(struct drm_minor *minor)
 340 {
 341         if (!minor || !minor->kdev)
 342                 return;
 343
 344 #if defined(CONFIG_DEBUG_FS)
 345         drm_debugfs_cleanup(minor);
 346 #endif
 347
 348         drm_sysfs_device_remove(minor);
 349         idr_remove(&drm_minors_idr, minor->index);
 350 }
 351
 352 /**
 353  * drm_put_minor - Destroy DRM minor
 354  * @minor: Minor to destroy
 355  *
 356  * This calls drm_unplug_minor() on the given minor and then frees it. Nothing
 357  * is done if @minor is NULL. It is fine to call this on already unplugged
 358  * minors.
 359  * The global DRM mutex must be held by the caller.
 360  */
 361 static void drm_put_minor(struct drm_minor *minor)
 362 {
 363         if (!minor)
 364                 return;
 365
 366         DRM_DEBUG("release secondary minor %d\n", minor->index);
 367
 368         drm_unplug_minor(minor);
 369         kfree(minor);
 370 }
 371
 372 /**
 373  * Called via drm_exit() at module unload time or when pci device is
 374  * unplugged.
 375  *
 376  * Cleans up all DRM device, calling drm_lastclose().
 377  *
 378  */
 379 void drm_put_dev(struct drm_device *dev)
 380 {
 381         DRM_DEBUG("\n");
 382
 383         if (!dev) {
 384                 DRM_ERROR("cleanup called no dev\n");
 385                 return;
 386         }
 387
 388         drm_dev_unregister(dev);
 389         drm_dev_free(dev);
 390 }
 391 EXPORT_SYMBOL(drm_put_dev);
 392
 393 void drm_unplug_dev(struct drm_device *dev)
 394 {
 395         /* for a USB device */
 396         if (drm_core_check_feature(dev, DRIVER_MODESET))
 397                 drm_unplug_minor(dev->control);
 398         if (dev->render)
 399                 drm_unplug_minor(dev->render);
 400         drm_unplug_minor(dev->primary);
 401
 402         mutex_lock(&drm_global_mutex);
 403
 404         drm_device_set_unplugged(dev);
 405
 406         if (dev->open_count == 0) {
 407                 drm_put_dev(dev);
 408         }
 409         mutex_unlock(&drm_global_mutex);
 410 }
 411 EXPORT_SYMBOL(drm_unplug_dev);
 412
 413 /**
 414  * drm_dev_alloc - Allocate new drm device
 415  * @driver: DRM driver to allocate device for
 416  * @parent: Parent device object
 417  *
 418  * Allocate and initialize a new DRM device. No device registration is done.
 419  * Call drm_dev_register() to advertice the device to user space and register it
 420  * with other core subsystems.
 421  *
 422  * RETURNS:
 423  * Pointer to new DRM device, or NULL if out of memory.
 424  */
 425 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
 426                                  struct device *parent)
 427 {
 428         struct drm_device *dev;
 429         int ret;
 430
 431         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 432         if (!dev)
 433                 return NULL;
 434
 435         dev->dev = parent;
 436         dev->driver = driver;
 437
 438         INIT_LIST_HEAD(&dev->filelist);
 439         INIT_LIST_HEAD(&dev->ctxlist);
 440         INIT_LIST_HEAD(&dev->vmalist);
 441         INIT_LIST_HEAD(&dev->maplist);
 442         INIT_LIST_HEAD(&dev->vblank_event_list);
 443
 444         spin_lock_init(&dev->count_lock);
 445         spin_lock_init(&dev->event_lock);
 446         mutex_init(&dev->struct_mutex);
 447         mutex_init(&dev->ctxlist_mutex);
 448
 449         if (drm_ht_create(&dev->map_hash, 12))
 450                 goto err_free;
 451
 452         ret = drm_ctxbitmap_init(dev);
 453         if (ret) {
 454                 DRM_ERROR("Cannot allocate memory for context bitmap.\n");
 455                 goto err_ht;
 456         }
 457
 458         if (driver->driver_features & DRIVER_GEM) {
 459                 ret = drm_gem_init(dev);
 460                 if (ret) {
 461                         DRM_ERROR("Cannot initialize graphics execution manager (GEM)\n");
 462                         goto err_ctxbitmap;
 463                 }
 464         }
 465
 466         return dev;
 467
 468 err_ctxbitmap:
 469         drm_ctxbitmap_cleanup(dev);
 470 err_ht:
 471         drm_ht_remove(&dev->map_hash);
 472 err_free:
 473         kfree(dev);
 474         return NULL;
 475 }
 476 EXPORT_SYMBOL(drm_dev_alloc);
 477
 478 /**
 479  * drm_dev_free - Free DRM device
 480  * @dev: DRM device to free
 481  *
 482  * Free a DRM device that has previously been allocated via drm_dev_alloc().
 483  * You must not use kfree() instead or you will leak memory.
 484  *
 485  * This must not be called once the device got registered. Use drm_put_dev()
 486  * instead, which then calls drm_dev_free().
 487  */
 488 void drm_dev_free(struct drm_device *dev)
 489 {
 490         drm_put_minor(dev->control);
 491         drm_put_minor(dev->render);
 492         drm_put_minor(dev->primary);
 493
 494         if (dev->driver->driver_features & DRIVER_GEM)
 495                 drm_gem_destroy(dev);
 496
 497         drm_ctxbitmap_cleanup(dev);
 498         drm_ht_remove(&dev->map_hash);
 499
 500         kfree(dev->devname);
 501         kfree(dev);
 502 }
 503 EXPORT_SYMBOL(drm_dev_free);
 504
 505 /**
 506  * drm_dev_register - Register DRM device
 507  * @dev: Device to register
 508  *
 509  * Register the DRM device @dev with the system, advertise device to user-space
 510  * and start normal device operation. @dev must be allocated via drm_dev_alloc()
 511  * previously.
 512  *
 513  * Never call this twice on any device!
 514  *
 515  * RETURNS:
 516  * 0 on success, negative error code on failure.
 517  */
 518 int drm_dev_register(struct drm_device *dev, unsigned long flags)
 519 {
 520         int ret;
 521
 522         mutex_lock(&drm_global_mutex);
 523
 524         if (dev->driver->bus->agp_init) {
 525                 ret = dev->driver->bus->agp_init(dev);
 526                 if (ret)
 527                         goto out_unlock;
 528         }
 529
 530         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 531                 ret = drm_get_minor(dev, &dev->control, DRM_MINOR_CONTROL);
 532                 if (ret)
 533                         goto err_agp;
 534         }
 535
 536         if (drm_core_check_feature(dev, DRIVER_RENDER) && drm_rnodes) {
 537                 ret = drm_get_minor(dev, &dev->render, DRM_MINOR_RENDER);
 538                 if (ret)
 539                         goto err_control_node;
 540         }
 541
 542         ret = drm_get_minor(dev, &dev->primary, DRM_MINOR_LEGACY);
 543         if (ret)
 544                 goto err_render_node;
 545
 546         if (dev->driver->load) {
 547                 ret = dev->driver->load(dev, flags);
 548                 if (ret)
 549                         goto err_primary_node;
 550         }
 551
 552         /* setup grouping for legacy outputs */
 553         if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 554                 ret = drm_mode_group_init_legacy_group(dev,
 555                                 &dev->primary->mode_group);
 556                 if (ret)
 557                         goto err_unload;
 558         }
 559
 560         list_add_tail(&dev->driver_item, &dev->driver->device_list);
 561
 562         ret = 0;
 563         goto out_unlock;
 564
 565 err_unload:
 566         if (dev->driver->unload)
 567                 dev->driver->unload(dev);
 568 err_primary_node:
 569         drm_unplug_minor(dev->primary);
 570 err_render_node:
 571         drm_unplug_minor(dev->render);
 572 err_control_node:
 573         drm_unplug_minor(dev->control);
 574 err_agp:
 575         if (dev->driver->bus->agp_destroy)
 576                 dev->driver->bus->agp_destroy(dev);
 577 out_unlock:
 578         mutex_unlock(&drm_global_mutex);
 579         return ret;
 580 }
 581 EXPORT_SYMBOL(drm_dev_register);
 582
 583 /**
 584  * drm_dev_unregister - Unregister DRM device
 585  * @dev: Device to unregister
 586  *
 587  * Unregister the DRM device from the system. This does the reverse of
 588  * drm_dev_register() but does not deallocate the device. The caller must call
 589  * drm_dev_free() to free all resources.
 590  */
 591 void drm_dev_unregister(struct drm_device *dev)
 592 {
 593         struct drm_map_list *r_list, *list_temp;
 594
 595         drm_lastclose(dev);
 596
 597         if (dev->driver->unload)
 598                 dev->driver->unload(dev);
 599
 600         if (dev->driver->bus->agp_destroy)
 601                 dev->driver->bus->agp_destroy(dev);
 602
 603         drm_vblank_cleanup(dev);
 604
 605         list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
 606                 drm_rmmap(dev, r_list->map);
 607
 608         drm_unplug_minor(dev->control);
 609         drm_unplug_minor(dev->render);
 610         drm_unplug_minor(dev->primary);
 611
 612         list_del(&dev->driver_item);
 613 }
 614 EXPORT_SYMBOL(drm_dev_unregister);