3333c250c4d9995848053d4f8a3ecf1286b1ed6b
[linux-2.6.git] / 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,      1, 1 },
74         [DRM_IOCTL_NR(DRM_IOCTL_RM_MAP)]        = { drm_rmmap,       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, 1, 1 },
106         [DRM_IOCTL_NR(DRM_IOCTL_AGP_RELEASE)]   = { drm_agp_release, 1, 1 },
107         [DRM_IOCTL_NR(DRM_IOCTL_AGP_ENABLE)]    = { drm_agp_enable,  1, 1 },
108         [DRM_IOCTL_NR(DRM_IOCTL_AGP_INFO)]      = { drm_agp_info,    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 and setup().
131  */
132 int drm_takedown( drm_device_t *dev )
133 {
134         drm_magic_entry_t *pt, *next;
135         drm_map_t *map;
136         drm_map_list_t *r_list;
137         struct list_head *list, *list_next;
138         drm_vma_entry_t *vma, *vma_next;
139         int i;
140
141         DRM_DEBUG( "\n" );
142
143         if (dev->driver->pretakedown)
144           dev->driver->pretakedown(dev);
145
146         if (dev->unique) {
147                 drm_free(dev->unique, strlen(dev->unique) + 1, DRM_MEM_DRIVER);
148                 dev->unique = NULL;
149                 dev->unique_len = 0;
150         }
151
152         if ( dev->irq_enabled ) drm_irq_uninstall( dev );
153
154         down( &dev->struct_sem );
155         del_timer( &dev->timer );
156
157                                 /* Clear pid list */
158         for ( i = 0 ; i < DRM_HASH_SIZE ; i++ ) {
159                 for ( pt = dev->magiclist[i].head ; pt ; pt = next ) {
160                         next = pt->next;
161                         drm_free( pt, sizeof(*pt), DRM_MEM_MAGIC );
162                 }
163                 dev->magiclist[i].head = dev->magiclist[i].tail = NULL;
164         }
165
166                                 /* Clear AGP information */
167         if (drm_core_has_AGP(dev) && dev->agp) {
168                 drm_agp_mem_t *entry;
169                 drm_agp_mem_t *nexte;
170
171                                 /* Remove AGP resources, but leave dev->agp
172                                    intact until drv_cleanup is called. */
173                 for ( entry = dev->agp->memory ; entry ; entry = nexte ) {
174                         nexte = entry->next;
175                         if ( entry->bound ) drm_unbind_agp( entry->memory );
176                         drm_free_agp( entry->memory, entry->pages );
177                         drm_free( entry, sizeof(*entry), DRM_MEM_AGPLISTS );
178                 }
179                 dev->agp->memory = NULL;
180
181                 if ( dev->agp->acquired ) drm_agp_do_release(dev);
182
183                 dev->agp->acquired = 0;
184                 dev->agp->enabled  = 0;
185         }
186
187                                 /* Clear vma list (only built for debugging) */
188         if ( dev->vmalist ) {
189                 for ( vma = dev->vmalist ; vma ; vma = vma_next ) {
190                         vma_next = vma->next;
191                         drm_free( vma, sizeof(*vma), DRM_MEM_VMAS );
192                 }
193                 dev->vmalist = NULL;
194         }
195
196         if( dev->maplist ) {
197                 list_for_each_safe( list, list_next, &dev->maplist->head ) {
198                         r_list = (drm_map_list_t *)list;
199
200                         if ( ( map = r_list->map ) ) {
201                                 switch ( map->type ) {
202                                 case _DRM_REGISTERS:
203                                 case _DRM_FRAME_BUFFER:
204                                         if (drm_core_has_MTRR(dev)) {
205                                                 if ( map->mtrr >= 0 ) {
206                                                         int retcode;
207                                                         retcode = mtrr_del( map->mtrr,
208                                                                             map->offset,
209                                                                             map->size );
210                                                         DRM_DEBUG( "mtrr_del=%d\n", retcode );
211                                                 }
212                                         }
213                                         drm_ioremapfree( map->handle, map->size, dev );
214                                         break;
215                                 case _DRM_SHM:
216                                         vfree(map->handle);
217                                         break;
218
219                                 case _DRM_AGP:
220                                         /* Do nothing here, because this is all
221                                          * handled in the AGP/GART driver.
222                                          */
223                                         break;
224                                 case _DRM_SCATTER_GATHER:
225                                         /* Handle it */
226                                         if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg) {
227                                                 drm_sg_cleanup(dev->sg);
228                                                 dev->sg = NULL;
229                                         }
230                                         break;
231                                 }
232                                 drm_free(map, sizeof(*map), DRM_MEM_MAPS);
233                         }
234                         list_del( list );
235                         drm_free(r_list, sizeof(*r_list), DRM_MEM_MAPS);
236                 }
237                 drm_free(dev->maplist, sizeof(*dev->maplist), DRM_MEM_MAPS);
238                 dev->maplist = NULL;
239         }
240
241         if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE) && dev->queuelist ) {
242                 for ( i = 0 ; i < dev->queue_count ; i++ ) {
243                         if ( dev->queuelist[i] ) {
244                                 drm_free( dev->queuelist[i],
245                                           sizeof(*dev->queuelist[0]),
246                                           DRM_MEM_QUEUES );
247                                 dev->queuelist[i] = NULL;
248                         }
249                 }
250                 drm_free( dev->queuelist,
251                           dev->queue_slots * sizeof(*dev->queuelist),
252                           DRM_MEM_QUEUES );
253                 dev->queuelist = NULL;
254         }
255         dev->queue_count = 0;
256
257         if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
258                 drm_dma_takedown( dev );
259
260         if ( dev->lock.hw_lock ) {
261                 dev->sigdata.lock = dev->lock.hw_lock = NULL; /* SHM removed */
262                 dev->lock.filp = NULL;
263                 wake_up_interruptible( &dev->lock.lock_queue );
264         }
265         up( &dev->struct_sem );
266
267         return 0;
268 }
269
270
271
272 /**
273  * Module initialization. Called via init_module at module load time, or via
274  * linux/init/main.c (this is not currently supported).
275  *
276  * \return zero on success or a negative number on failure.
277  *
278  * Initializes an array of drm_device structures, and attempts to
279  * initialize all available devices, using consecutive minors, registering the
280  * stubs and initializing the AGP device.
281  * 
282  * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
283  * after the initialization for driver customization.
284  */
285 int drm_init( struct drm_driver *driver )
286 {
287         struct pci_dev *pdev = NULL;
288         struct pci_device_id *pid;
289         int i;
290
291         DRM_DEBUG( "\n" );
292
293         drm_mem_init();
294
295         for (i=0; driver->pci_driver.id_table[i].vendor != 0; i++) {
296                 pid = (struct pci_device_id *)&driver->pci_driver.id_table[i];
297                 
298                 pdev=NULL;
299                 /* pass back in pdev to account for multiple identical cards */         
300                 while ((pdev = pci_get_subsys(pid->vendor, pid->device, pid->subvendor, pid->subdevice, pdev)) != NULL) {
301                         /* stealth mode requires a manual probe */
302                         pci_dev_get(pdev);
303                         drm_get_dev(pdev, pid, driver);
304                 }
305         }
306         return 0;
307 }
308 EXPORT_SYMBOL(drm_init);
309
310 /**
311  * Called via cleanup_module() at module unload time.
312  *
313  * Cleans up all DRM device, calling takedown().
314  * 
315  * \sa drm_init().
316  */
317 static void drm_cleanup( drm_device_t *dev )
318 {
319         DRM_DEBUG( "\n" );
320
321         if (!dev) {
322                 DRM_ERROR("cleanup called no dev\n");
323                 return;
324         }
325
326         drm_takedown( dev );    
327
328         drm_ctxbitmap_cleanup( dev );
329         
330         if (drm_core_has_MTRR(dev) && drm_core_has_AGP(dev) &&
331             dev->agp && dev->agp->agp_mtrr >= 0) {
332                 int retval;
333                 retval = mtrr_del( dev->agp->agp_mtrr,
334                                    dev->agp->agp_info.aper_base,
335                                    dev->agp->agp_info.aper_size*1024*1024 );
336                 DRM_DEBUG( "mtrr_del=%d\n", retval );
337         }
338         
339         if (drm_core_has_AGP(dev) && dev->agp ) {
340                 drm_free( dev->agp, sizeof(*dev->agp), DRM_MEM_AGPLISTS );
341                 dev->agp = NULL;
342         }
343
344         if (dev->driver->postcleanup)
345                 dev->driver->postcleanup(dev);
346         
347         drm_put_head(&dev->primary);
348         if ( drm_put_dev(dev) )
349                 DRM_ERROR( "Cannot unload module\n" );
350 }
351
352 void drm_exit (struct drm_driver *driver)
353 {
354         int i;
355         drm_device_t *dev = NULL;
356         drm_head_t *head;
357         
358         DRM_DEBUG( "\n" );
359
360         for (i = 0; i < drm_cards_limit; i++) {
361                 head = drm_heads[i];
362                 if (!head)
363                         continue;
364                 if (!head->dev)
365                         continue;
366                 if (head->dev->driver!=driver)
367                         continue;
368                 dev=head->dev;
369         }
370         if (dev) {
371                 /* release the pci driver */
372                 if (dev->pdev)
373                         pci_dev_put(dev->pdev);
374                 drm_cleanup(dev);
375         }
376         DRM_INFO( "Module unloaded\n" );
377 }
378 EXPORT_SYMBOL(drm_exit);
379
380 /** File operations structure */
381 static struct file_operations drm_stub_fops = {
382         .owner = THIS_MODULE,
383         .open  = drm_stub_open
384 };
385
386 static int __init drm_core_init(void)
387 {
388         int ret = -ENOMEM;
389         
390         drm_cards_limit = (drm_cards_limit < DRM_MAX_MINOR + 1 ? drm_cards_limit : DRM_MAX_MINOR + 1);
391         drm_heads = drm_calloc(drm_cards_limit,
392                                 sizeof(*drm_heads), DRM_MEM_STUB);
393         if(!drm_heads) 
394                 goto err_p1;
395         
396         if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
397                 goto err_p1;
398         
399         drm_class = drm_sysfs_create(THIS_MODULE, "drm");
400         if (IS_ERR(drm_class)) {
401                 printk (KERN_ERR "DRM: Error creating drm class.\n");
402                 ret = PTR_ERR(drm_class);
403                 goto err_p2;
404         }
405
406         drm_proc_root = create_proc_entry("dri", S_IFDIR, NULL);
407         if (!drm_proc_root) {
408                 DRM_ERROR("Cannot create /proc/dri\n");
409                 ret = -1;
410                 goto err_p3;
411         }
412                 
413         DRM_INFO( "Initialized %s %d.%d.%d %s\n",
414                 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL,
415                 CORE_DATE);
416         return 0;
417 err_p3:
418         drm_sysfs_destroy(drm_class);
419 err_p2:
420         unregister_chrdev(DRM_MAJOR, "drm");
421         drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
422 err_p1: 
423         return ret;
424 }
425
426 static void __exit drm_core_exit (void)
427 {
428         remove_proc_entry("dri", NULL);
429         drm_sysfs_destroy(drm_class);
430
431         unregister_chrdev(DRM_MAJOR, "drm");
432
433         drm_free(drm_heads, sizeof(*drm_heads) *
434                                 drm_cards_limit, DRM_MEM_STUB);
435 }
436
437
438 module_init( drm_core_init );
439 module_exit( drm_core_exit );
440
441
442 /**
443  * Get version information
444  *
445  * \param inode device inode.
446  * \param filp file pointer.
447  * \param cmd command.
448  * \param arg user argument, pointing to a drm_version structure.
449  * \return zero on success or negative number on failure.
450  *
451  * Fills in the version information in \p arg.
452  */
453 static int drm_version( struct inode *inode, struct file *filp,
454                         unsigned int cmd, unsigned long arg )
455 {
456         drm_file_t *priv = filp->private_data;
457         drm_device_t *dev = priv->head->dev;
458         drm_version_t __user *argp = (void __user *)arg;
459         drm_version_t version;
460         int ret;
461
462         if ( copy_from_user( &version, argp, sizeof(version) ) )
463                 return -EFAULT;
464
465         /* version is a required function to return the personality module version */
466         if ((ret = dev->driver->version(&version)))
467                 return ret;
468                 
469         if ( copy_to_user( argp, &version, sizeof(version) ) )
470                 return -EFAULT;
471         return 0;
472 }
473
474
475
476 /** 
477  * Called whenever a process performs an ioctl on /dev/drm.
478  *
479  * \param inode device inode.
480  * \param filp file pointer.
481  * \param cmd command.
482  * \param arg user argument.
483  * \return zero on success or negative number on failure.
484  *
485  * Looks up the ioctl function in the ::ioctls table, checking for root
486  * previleges if so required, and dispatches to the respective function.
487  */
488 int drm_ioctl( struct inode *inode, struct file *filp,
489                 unsigned int cmd, unsigned long arg )
490 {
491         drm_file_t *priv = filp->private_data;
492         drm_device_t *dev = priv->head->dev;
493         drm_ioctl_desc_t *ioctl;
494         drm_ioctl_t *func;
495         unsigned int nr = DRM_IOCTL_NR(cmd);
496         int retcode = -EINVAL;
497
498         atomic_inc( &dev->ioctl_count );
499         atomic_inc( &dev->counts[_DRM_STAT_IOCTLS] );
500         ++priv->ioctl_count;
501
502         DRM_DEBUG( "pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
503                    current->pid, cmd, nr, (long)old_encode_dev(priv->head->device), 
504                    priv->authenticated );
505         
506         if (nr < DRIVER_IOCTL_COUNT)
507                 ioctl = &drm_ioctls[nr];
508         else if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls))
509                 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
510         else
511                 goto err_i1;
512         
513         func = ioctl->func;
514         /* is there a local override? */
515         if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
516                 func = dev->driver->dma_ioctl;
517         
518         if ( !func ) {
519                 DRM_DEBUG( "no function\n" );
520                 retcode = -EINVAL;
521         } else if ( ( ioctl->root_only && !capable( CAP_SYS_ADMIN ) )||
522                     ( ioctl->auth_needed && !priv->authenticated ) ) {
523                 retcode = -EACCES;
524         } else {
525                 retcode = func( inode, filp, cmd, arg );
526         }
527         
528 err_i1:
529         atomic_dec( &dev->ioctl_count );
530         if (retcode) DRM_DEBUG( "ret = %x\n", retcode);
531         return retcode;
532 }
533 EXPORT_SYMBOL(drm_ioctl);
534