drivers/char/drm/drm_drv.c

   1 /**
   2  * \file drm_drv.h
   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 DRIVER_IOCTL_COUNT   DRM_ARRAY_SIZE( mga_ioctls )
  19  *
  20  * #define drm_x                mga_##x
  21  * \endcode
  22  */
  23
  24 /*
  25  * Created: Thu Nov 23 03:10:50 2000 by gareth@valinux.com
  26  *
  27  * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
  28  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  29  * All Rights Reserved.
  30  *
  31  * Permission is hereby granted, free of charge, to any person obtaining a
  32  * copy of this software and associated documentation files (the "Software"),
  33  * to deal in the Software without restriction, including without limitation
  34  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  35  * and/or sell copies of the Software, and to permit persons to whom the
  36  * Software is furnished to do so, subject to the following conditions:
  37  *
  38  * The above copyright notice and this permission notice (including the next
  39  * paragraph) shall be included in all copies or substantial portions of the
  40  * Software.
  41  *
  42  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  43  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  44  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  45  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  46  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  47  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  48  * OTHER DEALINGS IN THE SOFTWARE.
  49  */
  50
  51 #include "drmP.h"
  52 #include "drm_core.h"
  53
  54 static int drm_version(struct inode *inode, struct file *filp,
  55                        unsigned int cmd, unsigned long arg);
  56
  57 /** Ioctl table */
  58 static drm_ioctl_desc_t           drm_ioctls[] = {
  59         [DRM_IOCTL_NR(DRM_IOCTL_VERSION)]       = { drm_version,     0, 0 },
  60         [DRM_IOCTL_NR(DRM_IOCTL_GET_UNIQUE)]    = { drm_getunique,   0, 0 },
  61         [DRM_IOCTL_NR(DRM_IOCTL_GET_MAGIC)]     = { drm_getmagic,    0, 0 },
  62         [DRM_IOCTL_NR(DRM_IOCTL_IRQ_BUSID)]     = { drm_irq_by_busid, 0, 1 },
  63         [DRM_IOCTL_NR(DRM_IOCTL_GET_MAP)]       = { drm_getmap,      0, 0 },
  64         [DRM_IOCTL_NR(DRM_IOCTL_GET_CLIENT)]    = { drm_getclient,   0, 0 },
  65         [DRM_IOCTL_NR(DRM_IOCTL_GET_STATS)]     = { drm_getstats,    0, 0 },
  66         [DRM_IOCTL_NR(DRM_IOCTL_SET_VERSION)]   = { drm_setversion,  0, 1 },
  67
  68         [DRM_IOCTL_NR(DRM_IOCTL_SET_UNIQUE)]    = { drm_setunique,   1, 1 },
  69         [DRM_IOCTL_NR(DRM_IOCTL_BLOCK)]         = { drm_noop,        1, 1 },
  70         [DRM_IOCTL_NR(DRM_IOCTL_UNBLOCK)]       = { drm_noop,        1, 1 },
  71         [DRM_IOCTL_NR(DRM_IOCTL_AUTH_MAGIC)]    = { drm_authmagic,   1, 1 },
  72
  73         [DRM_IOCTL_NR(DRM_IOCTL_ADD_MAP)]       = { drm_addmap_ioctl,1, 1 },
  74         [DRM_IOCTL_NR(DRM_IOCTL_RM_MAP)]        = { drm_rmmap_ioctl, 1, 0 },
  75
  76         [DRM_IOCTL_NR(DRM_IOCTL_SET_SAREA_CTX)] = { drm_setsareactx, 1, 1 },
  77         [DRM_IOCTL_NR(DRM_IOCTL_GET_SAREA_CTX)] = { drm_getsareactx, 1, 0 },
  78
  79         [DRM_IOCTL_NR(DRM_IOCTL_ADD_CTX)]       = { drm_addctx,      1, 1 },
  80         [DRM_IOCTL_NR(DRM_IOCTL_RM_CTX)]        = { drm_rmctx,       1, 1 },
  81         [DRM_IOCTL_NR(DRM_IOCTL_MOD_CTX)]       = { drm_modctx,      1, 1 },
  82         [DRM_IOCTL_NR(DRM_IOCTL_GET_CTX)]       = { drm_getctx,      1, 0 },
  83         [DRM_IOCTL_NR(DRM_IOCTL_SWITCH_CTX)]    = { drm_switchctx,   1, 1 },
  84         [DRM_IOCTL_NR(DRM_IOCTL_NEW_CTX)]       = { drm_newctx,      1, 1 },
  85         [DRM_IOCTL_NR(DRM_IOCTL_RES_CTX)]       = { drm_resctx,      1, 0 },
  86
  87         [DRM_IOCTL_NR(DRM_IOCTL_ADD_DRAW)]      = { drm_adddraw,     1, 1 },
  88         [DRM_IOCTL_NR(DRM_IOCTL_RM_DRAW)]       = { drm_rmdraw,      1, 1 },
  89
  90         [DRM_IOCTL_NR(DRM_IOCTL_LOCK)]          = { drm_lock,        1, 0 },
  91         [DRM_IOCTL_NR(DRM_IOCTL_UNLOCK)]        = { drm_unlock,      1, 0 },
  92
  93         [DRM_IOCTL_NR(DRM_IOCTL_FINISH)]        = { drm_noop,      1, 0 },
  94
  95         [DRM_IOCTL_NR(DRM_IOCTL_ADD_BUFS)]      = { drm_addbufs,     1, 1 },
  96         [DRM_IOCTL_NR(DRM_IOCTL_MARK_BUFS)]     = { drm_markbufs,    1, 1 },
  97         [DRM_IOCTL_NR(DRM_IOCTL_INFO_BUFS)]     = { drm_infobufs,    1, 0 },
  98         [DRM_IOCTL_NR(DRM_IOCTL_MAP_BUFS)]      = { drm_mapbufs,     1, 0 },
  99         [DRM_IOCTL_NR(DRM_IOCTL_FREE_BUFS)]     = { drm_freebufs,    1, 0 },
 100         /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
 101
 102         [DRM_IOCTL_NR(DRM_IOCTL_CONTROL)]       = { drm_control,     1, 1 },
 103
 104 #if __OS_HAS_AGP
 105         [DRM_IOCTL_NR(DRM_IOCTL_AGP_ACQUIRE)]   = { drm_agp_acquire_ioctl, 1, 1 },
 106         [DRM_IOCTL_NR(DRM_IOCTL_AGP_RELEASE)]   = { drm_agp_release_ioctl, 1, 1 },
 107         [DRM_IOCTL_NR(DRM_IOCTL_AGP_ENABLE)]    = { drm_agp_enable_ioctl, 1, 1 },
 108         [DRM_IOCTL_NR(DRM_IOCTL_AGP_INFO)]      = { drm_agp_info_ioctl, 1, 0 },
 109         [DRM_IOCTL_NR(DRM_IOCTL_AGP_ALLOC)]     = { drm_agp_alloc,   1, 1 },
 110         [DRM_IOCTL_NR(DRM_IOCTL_AGP_FREE)]      = { drm_agp_free,    1, 1 },
 111         [DRM_IOCTL_NR(DRM_IOCTL_AGP_BIND)]      = { drm_agp_bind,    1, 1 },
 112         [DRM_IOCTL_NR(DRM_IOCTL_AGP_UNBIND)]    = { drm_agp_unbind,  1, 1 },
 113 #endif
 114
 115         [DRM_IOCTL_NR(DRM_IOCTL_SG_ALLOC)]      = { drm_sg_alloc,    1, 1 },
 116         [DRM_IOCTL_NR(DRM_IOCTL_SG_FREE)]       = { drm_sg_free,     1, 1 },
 117
 118         [DRM_IOCTL_NR(DRM_IOCTL_WAIT_VBLANK)]   = { drm_wait_vblank, 0, 0 },
 119 };
 120
 121 #define DRIVER_IOCTL_COUNT      DRM_ARRAY_SIZE( drm_ioctls )
 122
 123 /**
 124  * Take down the DRM device.
 125  *
 126  * \param dev DRM device structure.
 127  *
 128  * Frees every resource in \p dev.
 129  *
 130  * \sa drm_device
 131  */
 132 int drm_takedown( drm_device_t *dev )
 133 {
 134         drm_magic_entry_t *pt, *next;
 135         drm_map_list_t *r_list;
 136         drm_vma_entry_t *vma, *vma_next;
 137         int i;
 138
 139         DRM_DEBUG( "\n" );
 140
 141         if (dev->driver->pretakedown)
 142           dev->driver->pretakedown(dev);
 143         DRM_DEBUG("driver pretakedown completed\n");
 144
 145         if (dev->unique) {
 146                 drm_free(dev->unique, strlen(dev->unique) + 1, DRM_MEM_DRIVER);
 147                 dev->unique = NULL;
 148                 dev->unique_len = 0;
 149         }
 150
 151         if ( dev->irq_enabled ) drm_irq_uninstall( dev );
 152
 153         down( &dev->struct_sem );
 154         del_timer( &dev->timer );
 155
 156                                 /* Clear pid list */
 157         for ( i = 0 ; i < DRM_HASH_SIZE ; i++ ) {
 158                 for ( pt = dev->magiclist[i].head ; pt ; pt = next ) {
 159                         next = pt->next;
 160                         drm_free( pt, sizeof(*pt), DRM_MEM_MAGIC );
 161                 }
 162                 dev->magiclist[i].head = dev->magiclist[i].tail = NULL;
 163         }
 164
 165                                 /* Clear AGP information */
 166         if (drm_core_has_AGP(dev) && dev->agp) {
 167                 drm_agp_mem_t *entry;
 168                 drm_agp_mem_t *nexte;
 169
 170                                 /* Remove AGP resources, but leave dev->agp
 171                                    intact until drv_cleanup is called. */
 172                 for ( entry = dev->agp->memory ; entry ; entry = nexte ) {
 173                         nexte = entry->next;
 174                         if ( entry->bound ) drm_unbind_agp( entry->memory );
 175                         drm_free_agp( entry->memory, entry->pages );
 176                         drm_free( entry, sizeof(*entry), DRM_MEM_AGPLISTS );
 177                 }
 178                 dev->agp->memory = NULL;
 179
 180                 if (dev->agp->acquired)
 181                   drm_agp_release(dev);
 182
 183                 dev->agp->acquired = 0;
 184                 dev->agp->enabled  = 0;
 185         }
 186         if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg) {
 187                 drm_sg_cleanup(dev->sg);
 188                 dev->sg = NULL;
 189         }
 190
 191                                 /* Clear vma list (only built for debugging) */
 192         if ( dev->vmalist ) {
 193                 for ( vma = dev->vmalist ; vma ; vma = vma_next ) {
 194                         vma_next = vma->next;
 195                         drm_free( vma, sizeof(*vma), DRM_MEM_VMAS );
 196                 }
 197                 dev->vmalist = NULL;
 198         }
 199
 200         if( dev->maplist ) {
 201                 while (!list_empty(&dev->maplist->head)) {
 202                         struct list_head *list = dev->maplist->head.next;
 203                         r_list = list_entry(list, drm_map_list_t, head);
 204                         drm_rmmap_locked(dev, r_list->map);
 205                 }
 206         }
 207
 208         if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE) && dev->queuelist ) {
 209                 for ( i = 0 ; i < dev->queue_count ; i++ ) {
 210                         if ( dev->queuelist[i] ) {
 211                                 drm_free( dev->queuelist[i],
 212                                           sizeof(*dev->queuelist[0]),
 213                                           DRM_MEM_QUEUES );
 214                                 dev->queuelist[i] = NULL;
 215                         }
 216                 }
 217                 drm_free( dev->queuelist,
 218                           dev->queue_slots * sizeof(*dev->queuelist),
 219                           DRM_MEM_QUEUES );
 220                 dev->queuelist = NULL;
 221         }
 222         dev->queue_count = 0;
 223
 224         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
 225                 drm_dma_takedown( dev );
 226
 227         if ( dev->lock.hw_lock ) {
 228                 dev->sigdata.lock = dev->lock.hw_lock = NULL; /* SHM removed */
 229                 dev->lock.filp = NULL;
 230                 wake_up_interruptible( &dev->lock.lock_queue );
 231         }
 232         up( &dev->struct_sem );
 233
 234         DRM_DEBUG("takedown completed\n");
 235         return 0;
 236 }
 237
 238
 239
 240 /**
 241  * Module initialization. Called via init_module at module load time, or via
 242  * linux/init/main.c (this is not currently supported).
 243  *
 244  * \return zero on success or a negative number on failure.
 245  *
 246  * Initializes an array of drm_device structures, and attempts to
 247  * initialize all available devices, using consecutive minors, registering the
 248  * stubs and initializing the AGP device.
 249  *
 250  * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
 251  * after the initialization for driver customization.
 252  */
 253 int drm_init( struct drm_driver *driver )
 254 {
 255         struct pci_dev *pdev = NULL;
 256         struct pci_device_id *pid;
 257         int i;
 258
 259         DRM_DEBUG( "\n" );
 260
 261         drm_mem_init();
 262
 263         for (i=0; driver->pci_driver.id_table[i].vendor != 0; i++) {
 264                 pid = (struct pci_device_id *)&driver->pci_driver.id_table[i];
 265
 266                 pdev=NULL;
 267                 /* pass back in pdev to account for multiple identical cards */
 268                 while ((pdev = pci_get_subsys(pid->vendor, pid->device, pid->subvendor, pid->subdevice, pdev)) != NULL) {
 269                         /* stealth mode requires a manual probe */
 270                         pci_dev_get(pdev);
 271                         drm_get_dev(pdev, pid, driver);
 272                 }
 273         }
 274         return 0;
 275 }
 276 EXPORT_SYMBOL(drm_init);
 277
 278 /**
 279  * Called via cleanup_module() at module unload time.
 280  *
 281  * Cleans up all DRM device, calling takedown().
 282  *
 283  * \sa drm_init
 284  */
 285 static void drm_cleanup( drm_device_t *dev )
 286 {
 287         DRM_DEBUG( "\n" );
 288
 289         if (!dev) {
 290                 DRM_ERROR("cleanup called no dev\n");
 291                 return;
 292         }
 293
 294         drm_takedown( dev );
 295
 296         if (dev->maplist) {
 297                 drm_free(dev->maplist, sizeof(*dev->maplist), DRM_MEM_MAPS);
 298                 dev->maplist = NULL;
 299         }
 300
 301         drm_ctxbitmap_cleanup( dev );
 302
 303         if (drm_core_has_MTRR(dev) && drm_core_has_AGP(dev) &&
 304             dev->agp && dev->agp->agp_mtrr >= 0) {
 305                 int retval;
 306                 retval = mtrr_del( dev->agp->agp_mtrr,
 307                                    dev->agp->agp_info.aper_base,
 308                                    dev->agp->agp_info.aper_size*1024*1024 );
 309                 DRM_DEBUG( "mtrr_del=%d\n", retval );
 310         }
 311
 312         if (drm_core_has_AGP(dev) && dev->agp ) {
 313                 drm_free( dev->agp, sizeof(*dev->agp), DRM_MEM_AGPLISTS );
 314                 dev->agp = NULL;
 315         }
 316
 317         if (dev->driver->postcleanup)
 318                 dev->driver->postcleanup(dev);
 319
 320         drm_put_head(&dev->primary);
 321         if ( drm_put_dev(dev) )
 322                 DRM_ERROR( "Cannot unload module\n" );
 323 }
 324
 325 void drm_exit (struct drm_driver *driver)
 326 {
 327         int i;
 328         drm_device_t *dev = NULL;
 329         drm_head_t *head;
 330
 331         DRM_DEBUG( "\n" );
 332
 333         for (i = 0; i < drm_cards_limit; i++) {
 334                 head = drm_heads[i];
 335                 if (!head)
 336                         continue;
 337                 if (!head->dev)
 338                         continue;
 339                 if (head->dev->driver!=driver)
 340                         continue;
 341                 dev=head->dev;
 342         }
 343         if (dev) {
 344                 /* release the pci driver */
 345                 if (dev->pdev)
 346                         pci_dev_put(dev->pdev);
 347                 drm_cleanup(dev);
 348         }
 349         DRM_INFO( "Module unloaded\n" );
 350 }
 351 EXPORT_SYMBOL(drm_exit);
 352
 353 /** File operations structure */
 354 static struct file_operations drm_stub_fops = {
 355         .owner = THIS_MODULE,
 356         .open  = drm_stub_open
 357 };
 358
 359 static int __init drm_core_init(void)
 360 {
 361         int ret = -ENOMEM;
 362
 363         drm_cards_limit = (drm_cards_limit < DRM_MAX_MINOR + 1 ? drm_cards_limit : DRM_MAX_MINOR + 1);
 364         drm_heads = drm_calloc(drm_cards_limit,
 365                                 sizeof(*drm_heads), DRM_MEM_STUB);
 366         if(!drm_heads)
 367                 goto err_p1;
 368
 369         if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
 370                 goto err_p1;
 371
 372         drm_class = drm_sysfs_create(THIS_MODULE, "drm");
 373         if (IS_ERR(drm_class)) {
 374                 printk (KERN_ERR "DRM: Error creating drm class.\n");
 375                 ret = PTR_ERR(drm_class);
 376                 goto err_p2;
 377         }
 378
 379         drm_proc_root = create_proc_entry("dri", S_IFDIR, NULL);
 380         if (!drm_proc_root) {
 381                 DRM_ERROR("Cannot create /proc/dri\n");
 382                 ret = -1;
 383                 goto err_p3;
 384         }
 385
 386         DRM_INFO( "Initialized %s %d.%d.%d %s\n",
 387                 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL,
 388                 CORE_DATE);
 389         return 0;
 390 err_p3:
 391         drm_sysfs_destroy(drm_class);
 392 err_p2:
 393         unregister_chrdev(DRM_MAJOR, "drm");
 394         drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
 395 err_p1:
 396         return ret;
 397 }
 398
 399 static void __exit drm_core_exit (void)
 400 {
 401         remove_proc_entry("dri", NULL);
 402         drm_sysfs_destroy(drm_class);
 403
 404         unregister_chrdev(DRM_MAJOR, "drm");
 405
 406         drm_free(drm_heads, sizeof(*drm_heads) *
 407                                 drm_cards_limit, DRM_MEM_STUB);
 408 }
 409
 410
 411 module_init( drm_core_init );
 412 module_exit( drm_core_exit );
 413
 414
 415 /**
 416  * Get version information
 417  *
 418  * \param inode device inode.
 419  * \param filp file pointer.
 420  * \param cmd command.
 421  * \param arg user argument, pointing to a drm_version structure.
 422  * \return zero on success or negative number on failure.
 423  *
 424  * Fills in the version information in \p arg.
 425  */
 426 static int drm_version( struct inode *inode, struct file *filp,
 427                         unsigned int cmd, unsigned long arg )
 428 {
 429         drm_file_t *priv = filp->private_data;
 430         drm_device_t *dev = priv->head->dev;
 431         drm_version_t __user *argp = (void __user *)arg;
 432         drm_version_t version;
 433         int ret;
 434
 435         if ( copy_from_user( &version, argp, sizeof(version) ) )
 436                 return -EFAULT;
 437
 438         /* version is a required function to return the personality module version */
 439         if ((ret = dev->driver->version(&version)))
 440                 return ret;
 441
 442         if ( copy_to_user( argp, &version, sizeof(version) ) )
 443                 return -EFAULT;
 444         return 0;
 445 }
 446
 447
 448
 449 /**
 450  * Called whenever a process performs an ioctl on /dev/drm.
 451  *
 452  * \param inode device inode.
 453  * \param filp file pointer.
 454  * \param cmd command.
 455  * \param arg user argument.
 456  * \return zero on success or negative number on failure.
 457  *
 458  * Looks up the ioctl function in the ::ioctls table, checking for root
 459  * previleges if so required, and dispatches to the respective function.
 460  */
 461 int drm_ioctl( struct inode *inode, struct file *filp,
 462                 unsigned int cmd, unsigned long arg )
 463 {
 464         drm_file_t *priv = filp->private_data;
 465         drm_device_t *dev = priv->head->dev;
 466         drm_ioctl_desc_t *ioctl;
 467         drm_ioctl_t *func;
 468         unsigned int nr = DRM_IOCTL_NR(cmd);
 469         int retcode = -EINVAL;
 470
 471         atomic_inc( &dev->ioctl_count );
 472         atomic_inc( &dev->counts[_DRM_STAT_IOCTLS] );
 473         ++priv->ioctl_count;
 474
 475         DRM_DEBUG( "pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
 476                    current->pid, cmd, nr, (long)old_encode_dev(priv->head->device),
 477                    priv->authenticated );
 478
 479         if (nr < DRIVER_IOCTL_COUNT)
 480                 ioctl = &drm_ioctls[nr];
 481         else if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls))
 482                 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
 483         else
 484                 goto err_i1;
 485
 486         func = ioctl->func;
 487         /* is there a local override? */
 488         if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
 489                 func = dev->driver->dma_ioctl;
 490
 491         if ( !func ) {
 492                 DRM_DEBUG( "no function\n" );
 493                 retcode = -EINVAL;
 494         } else if ( ( ioctl->root_only && !capable( CAP_SYS_ADMIN ) )||
 495                     ( ioctl->auth_needed && !priv->authenticated ) ) {
 496                 retcode = -EACCES;
 497         } else {
 498                 retcode = func( inode, filp, cmd, arg );
 499         }
 500
 501 err_i1:
 502         atomic_dec( &dev->ioctl_count );
 503         if (retcode) DRM_DEBUG( "ret = %x\n", retcode);
 504         return retcode;
 505 }
 506 EXPORT_SYMBOL(drm_ioctl);
 507