3 * Generic driver template
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
8 * To use this template, you must at least define the following (samples
9 * given for the MGA driver):
12 * #define DRIVER_AUTHOR "VA Linux Systems, Inc."
14 * #define DRIVER_NAME "mga"
15 * #define DRIVER_DESC "Matrox G200/G400"
16 * #define DRIVER_DATE "20001127"
18 * #define DRIVER_IOCTL_COUNT DRM_ARRAY_SIZE( mga_ioctls )
20 * #define drm_x mga_##x
25 * Created: Thu Nov 23 03:10:50 2000 by gareth@valinux.com
27 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
28 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
29 * All Rights Reserved.
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:
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
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.
54 static int drm_version(struct inode
*inode
, struct file
*filp
,
55 unsigned int cmd
, unsigned long arg
);
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 },
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 },
73 [DRM_IOCTL_NR(DRM_IOCTL_ADD_MAP
)] = { drm_addmap
, 1, 1 },
74 [DRM_IOCTL_NR(DRM_IOCTL_RM_MAP
)] = { drm_rmmap
, 1, 0 },
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 },
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 },
87 [DRM_IOCTL_NR(DRM_IOCTL_ADD_DRAW
)] = { drm_adddraw
, 1, 1 },
88 [DRM_IOCTL_NR(DRM_IOCTL_RM_DRAW
)] = { drm_rmdraw
, 1, 1 },
90 [DRM_IOCTL_NR(DRM_IOCTL_LOCK
)] = { drm_lock
, 1, 0 },
91 [DRM_IOCTL_NR(DRM_IOCTL_UNLOCK
)] = { drm_unlock
, 1, 0 },
93 [DRM_IOCTL_NR(DRM_IOCTL_FINISH
)] = { drm_noop
, 1, 0 },
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. */
102 [DRM_IOCTL_NR(DRM_IOCTL_CONTROL
)] = { drm_control
, 1, 1 },
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 },
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 },
118 [DRM_IOCTL_NR(DRM_IOCTL_WAIT_VBLANK
)] = { drm_wait_vblank
, 0, 0 },
121 #define DRIVER_IOCTL_COUNT DRM_ARRAY_SIZE( drm_ioctls )
124 * Take down the DRM device.
126 * \param dev DRM device structure.
128 * Frees every resource in \p dev.
130 * \sa drm_device and setup().
132 int drm_takedown( drm_device_t
*dev
)
134 drm_magic_entry_t
*pt
, *next
;
136 drm_map_list_t
*r_list
;
137 struct list_head
*list
, *list_next
;
138 drm_vma_entry_t
*vma
, *vma_next
;
143 if (dev
->driver
->pretakedown
)
144 dev
->driver
->pretakedown(dev
);
147 drm_free(dev
->unique
, strlen(dev
->unique
) + 1, DRM_MEM_DRIVER
);
152 if ( dev
->irq_enabled
) drm_irq_uninstall( dev
);
154 down( &dev
->struct_sem
);
155 del_timer( &dev
->timer
);
158 for ( i
= 0 ; i
< DRM_HASH_SIZE
; i
++ ) {
159 for ( pt
= dev
->magiclist
[i
].head
; pt
; pt
= next
) {
161 drm_free( pt
, sizeof(*pt
), DRM_MEM_MAGIC
);
163 dev
->magiclist
[i
].head
= dev
->magiclist
[i
].tail
= NULL
;
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
;
171 /* Remove AGP resources, but leave dev->agp
172 intact until drv_cleanup is called. */
173 for ( entry
= dev
->agp
->memory
; entry
; entry
= nexte
) {
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
);
179 dev
->agp
->memory
= NULL
;
181 if ( dev
->agp
->acquired
) drm_agp_do_release(dev
);
183 dev
->agp
->acquired
= 0;
184 dev
->agp
->enabled
= 0;
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
);
197 list_for_each_safe( list
, list_next
, &dev
->maplist
->head
) {
198 r_list
= (drm_map_list_t
*)list
;
200 if ( ( map
= r_list
->map
) ) {
201 switch ( map
->type
) {
203 case _DRM_FRAME_BUFFER
:
204 if (drm_core_has_MTRR(dev
)) {
205 if ( map
->mtrr
>= 0 ) {
207 retcode
= mtrr_del( map
->mtrr
,
210 DRM_DEBUG( "mtrr_del=%d\n", retcode
);
213 drm_ioremapfree( map
->handle
, map
->size
, dev
);
220 /* Do nothing here, because this is all
221 * handled in the AGP/GART driver.
224 case _DRM_SCATTER_GATHER
:
226 if (drm_core_check_feature(dev
, DRIVER_SG
) && dev
->sg
) {
227 drm_sg_cleanup(dev
->sg
);
231 case _DRM_CONSISTENT
:
232 drm_pci_free(dev
, map
->size
,
233 map
->handle
, map
->offset
);
236 drm_free(map
, sizeof(*map
), DRM_MEM_MAPS
);
239 drm_free(r_list
, sizeof(*r_list
), DRM_MEM_MAPS
);
241 drm_free(dev
->maplist
, sizeof(*dev
->maplist
), DRM_MEM_MAPS
);
245 if (drm_core_check_feature(dev
, DRIVER_DMA_QUEUE
) && dev
->queuelist
) {
246 for ( i
= 0 ; i
< dev
->queue_count
; i
++ ) {
247 if ( dev
->queuelist
[i
] ) {
248 drm_free( dev
->queuelist
[i
],
249 sizeof(*dev
->queuelist
[0]),
251 dev
->queuelist
[i
] = NULL
;
254 drm_free( dev
->queuelist
,
255 dev
->queue_slots
* sizeof(*dev
->queuelist
),
257 dev
->queuelist
= NULL
;
259 dev
->queue_count
= 0;
261 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
262 drm_dma_takedown( dev
);
264 if ( dev
->lock
.hw_lock
) {
265 dev
->sigdata
.lock
= dev
->lock
.hw_lock
= NULL
; /* SHM removed */
266 dev
->lock
.filp
= NULL
;
267 wake_up_interruptible( &dev
->lock
.lock_queue
);
269 up( &dev
->struct_sem
);
277 * Module initialization. Called via init_module at module load time, or via
278 * linux/init/main.c (this is not currently supported).
280 * \return zero on success or a negative number on failure.
282 * Initializes an array of drm_device structures, and attempts to
283 * initialize all available devices, using consecutive minors, registering the
284 * stubs and initializing the AGP device.
286 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
287 * after the initialization for driver customization.
289 int drm_init( struct drm_driver
*driver
)
291 struct pci_dev
*pdev
= NULL
;
292 struct pci_device_id
*pid
;
299 for (i
=0; driver
->pci_driver
.id_table
[i
].vendor
!= 0; i
++) {
300 pid
= (struct pci_device_id
*)&driver
->pci_driver
.id_table
[i
];
303 /* pass back in pdev to account for multiple identical cards */
304 while ((pdev
= pci_get_subsys(pid
->vendor
, pid
->device
, pid
->subvendor
, pid
->subdevice
, pdev
)) != NULL
) {
305 /* stealth mode requires a manual probe */
307 drm_get_dev(pdev
, pid
, driver
);
312 EXPORT_SYMBOL(drm_init
);
315 * Called via cleanup_module() at module unload time.
317 * Cleans up all DRM device, calling takedown().
321 static void drm_cleanup( drm_device_t
*dev
)
326 DRM_ERROR("cleanup called no dev\n");
332 drm_ctxbitmap_cleanup( dev
);
334 if (drm_core_has_MTRR(dev
) && drm_core_has_AGP(dev
) &&
335 dev
->agp
&& dev
->agp
->agp_mtrr
>= 0) {
337 retval
= mtrr_del( dev
->agp
->agp_mtrr
,
338 dev
->agp
->agp_info
.aper_base
,
339 dev
->agp
->agp_info
.aper_size
*1024*1024 );
340 DRM_DEBUG( "mtrr_del=%d\n", retval
);
343 if (drm_core_has_AGP(dev
) && dev
->agp
) {
344 drm_free( dev
->agp
, sizeof(*dev
->agp
), DRM_MEM_AGPLISTS
);
348 if (dev
->driver
->postcleanup
)
349 dev
->driver
->postcleanup(dev
);
351 drm_put_head(&dev
->primary
);
352 if ( drm_put_dev(dev
) )
353 DRM_ERROR( "Cannot unload module\n" );
356 void drm_exit (struct drm_driver
*driver
)
359 drm_device_t
*dev
= NULL
;
364 for (i
= 0; i
< drm_cards_limit
; i
++) {
370 if (head
->dev
->driver
!=driver
)
375 /* release the pci driver */
377 pci_dev_put(dev
->pdev
);
380 DRM_INFO( "Module unloaded\n" );
382 EXPORT_SYMBOL(drm_exit
);
384 /** File operations structure */
385 static struct file_operations drm_stub_fops
= {
386 .owner
= THIS_MODULE
,
387 .open
= drm_stub_open
390 static int __init
drm_core_init(void)
394 drm_cards_limit
= (drm_cards_limit
< DRM_MAX_MINOR
+ 1 ? drm_cards_limit
: DRM_MAX_MINOR
+ 1);
395 drm_heads
= drm_calloc(drm_cards_limit
,
396 sizeof(*drm_heads
), DRM_MEM_STUB
);
400 if (register_chrdev(DRM_MAJOR
, "drm", &drm_stub_fops
))
403 drm_class
= drm_sysfs_create(THIS_MODULE
, "drm");
404 if (IS_ERR(drm_class
)) {
405 printk (KERN_ERR
"DRM: Error creating drm class.\n");
406 ret
= PTR_ERR(drm_class
);
410 drm_proc_root
= create_proc_entry("dri", S_IFDIR
, NULL
);
411 if (!drm_proc_root
) {
412 DRM_ERROR("Cannot create /proc/dri\n");
417 DRM_INFO( "Initialized %s %d.%d.%d %s\n",
418 CORE_NAME
, CORE_MAJOR
, CORE_MINOR
, CORE_PATCHLEVEL
,
422 drm_sysfs_destroy(drm_class
);
424 unregister_chrdev(DRM_MAJOR
, "drm");
425 drm_free(drm_heads
, sizeof(*drm_heads
) * drm_cards_limit
, DRM_MEM_STUB
);
430 static void __exit
drm_core_exit (void)
432 remove_proc_entry("dri", NULL
);
433 drm_sysfs_destroy(drm_class
);
435 unregister_chrdev(DRM_MAJOR
, "drm");
437 drm_free(drm_heads
, sizeof(*drm_heads
) *
438 drm_cards_limit
, DRM_MEM_STUB
);
442 module_init( drm_core_init
);
443 module_exit( drm_core_exit
);
447 * Get version information
449 * \param inode device inode.
450 * \param filp file pointer.
451 * \param cmd command.
452 * \param arg user argument, pointing to a drm_version structure.
453 * \return zero on success or negative number on failure.
455 * Fills in the version information in \p arg.
457 static int drm_version( struct inode
*inode
, struct file
*filp
,
458 unsigned int cmd
, unsigned long arg
)
460 drm_file_t
*priv
= filp
->private_data
;
461 drm_device_t
*dev
= priv
->head
->dev
;
462 drm_version_t __user
*argp
= (void __user
*)arg
;
463 drm_version_t version
;
466 if ( copy_from_user( &version
, argp
, sizeof(version
) ) )
469 /* version is a required function to return the personality module version */
470 if ((ret
= dev
->driver
->version(&version
)))
473 if ( copy_to_user( argp
, &version
, sizeof(version
) ) )
481 * Called whenever a process performs an ioctl on /dev/drm.
483 * \param inode device inode.
484 * \param filp file pointer.
485 * \param cmd command.
486 * \param arg user argument.
487 * \return zero on success or negative number on failure.
489 * Looks up the ioctl function in the ::ioctls table, checking for root
490 * previleges if so required, and dispatches to the respective function.
492 int drm_ioctl( struct inode
*inode
, struct file
*filp
,
493 unsigned int cmd
, unsigned long arg
)
495 drm_file_t
*priv
= filp
->private_data
;
496 drm_device_t
*dev
= priv
->head
->dev
;
497 drm_ioctl_desc_t
*ioctl
;
499 unsigned int nr
= DRM_IOCTL_NR(cmd
);
500 int retcode
= -EINVAL
;
502 atomic_inc( &dev
->ioctl_count
);
503 atomic_inc( &dev
->counts
[_DRM_STAT_IOCTLS
] );
506 DRM_DEBUG( "pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
507 current
->pid
, cmd
, nr
, (long)old_encode_dev(priv
->head
->device
),
508 priv
->authenticated
);
510 if (nr
< DRIVER_IOCTL_COUNT
)
511 ioctl
= &drm_ioctls
[nr
];
512 else if ((nr
>= DRM_COMMAND_BASE
) && (nr
< DRM_COMMAND_BASE
+ dev
->driver
->num_ioctls
))
513 ioctl
= &dev
->driver
->ioctls
[nr
- DRM_COMMAND_BASE
];
518 /* is there a local override? */
519 if ((nr
== DRM_IOCTL_NR(DRM_IOCTL_DMA
)) && dev
->driver
->dma_ioctl
)
520 func
= dev
->driver
->dma_ioctl
;
523 DRM_DEBUG( "no function\n" );
525 } else if ( ( ioctl
->root_only
&& !capable( CAP_SYS_ADMIN
) )||
526 ( ioctl
->auth_needed
&& !priv
->authenticated
) ) {
529 retcode
= func( inode
, filp
, cmd
, arg
);
533 atomic_dec( &dev
->ioctl_count
);
534 if (retcode
) DRM_DEBUG( "ret = %x\n", retcode
);
537 EXPORT_SYMBOL(drm_ioctl
);