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 drm_x mga_##x
23 * Created: Thu Nov 23 03:10:50 2000 by gareth@valinux.com
25 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
26 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
27 * All Rights Reserved.
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:
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
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.
52 static int drm_version(struct drm_device
*dev
, void *data
,
53 struct drm_file
*file_priv
);
56 static struct drm_ioctl_desc drm_ioctls
[] = {
57 DRM_IOCTL_DEF(DRM_IOCTL_VERSION
, drm_version
, 0),
58 DRM_IOCTL_DEF(DRM_IOCTL_GET_UNIQUE
, drm_getunique
, 0),
59 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAGIC
, drm_getmagic
, 0),
60 DRM_IOCTL_DEF(DRM_IOCTL_IRQ_BUSID
, drm_irq_by_busid
, DRM_MASTER
|DRM_ROOT_ONLY
),
61 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAP
, drm_getmap
, 0),
62 DRM_IOCTL_DEF(DRM_IOCTL_GET_CLIENT
, drm_getclient
, 0),
63 DRM_IOCTL_DEF(DRM_IOCTL_GET_STATS
, drm_getstats
, 0),
64 DRM_IOCTL_DEF(DRM_IOCTL_SET_VERSION
, drm_setversion
, DRM_MASTER
|DRM_ROOT_ONLY
),
66 DRM_IOCTL_DEF(DRM_IOCTL_SET_UNIQUE
, drm_setunique
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
67 DRM_IOCTL_DEF(DRM_IOCTL_BLOCK
, drm_noop
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
68 DRM_IOCTL_DEF(DRM_IOCTL_UNBLOCK
, drm_noop
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
69 DRM_IOCTL_DEF(DRM_IOCTL_AUTH_MAGIC
, drm_authmagic
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
71 DRM_IOCTL_DEF(DRM_IOCTL_ADD_MAP
, drm_addmap_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
72 DRM_IOCTL_DEF(DRM_IOCTL_RM_MAP
, drm_rmmap_ioctl
, DRM_AUTH
),
74 DRM_IOCTL_DEF(DRM_IOCTL_SET_SAREA_CTX
, drm_setsareactx
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
75 DRM_IOCTL_DEF(DRM_IOCTL_GET_SAREA_CTX
, drm_getsareactx
, DRM_AUTH
),
77 DRM_IOCTL_DEF(DRM_IOCTL_ADD_CTX
, drm_addctx
, DRM_AUTH
|DRM_ROOT_ONLY
),
78 DRM_IOCTL_DEF(DRM_IOCTL_RM_CTX
, drm_rmctx
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
79 DRM_IOCTL_DEF(DRM_IOCTL_MOD_CTX
, drm_modctx
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
80 DRM_IOCTL_DEF(DRM_IOCTL_GET_CTX
, drm_getctx
, DRM_AUTH
),
81 DRM_IOCTL_DEF(DRM_IOCTL_SWITCH_CTX
, drm_switchctx
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
82 DRM_IOCTL_DEF(DRM_IOCTL_NEW_CTX
, drm_newctx
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
83 DRM_IOCTL_DEF(DRM_IOCTL_RES_CTX
, drm_resctx
, DRM_AUTH
),
85 DRM_IOCTL_DEF(DRM_IOCTL_ADD_DRAW
, drm_adddraw
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
86 DRM_IOCTL_DEF(DRM_IOCTL_RM_DRAW
, drm_rmdraw
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
88 DRM_IOCTL_DEF(DRM_IOCTL_LOCK
, drm_lock
, DRM_AUTH
),
89 DRM_IOCTL_DEF(DRM_IOCTL_UNLOCK
, drm_unlock
, DRM_AUTH
),
91 DRM_IOCTL_DEF(DRM_IOCTL_FINISH
, drm_noop
, DRM_AUTH
),
93 DRM_IOCTL_DEF(DRM_IOCTL_ADD_BUFS
, drm_addbufs
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
94 DRM_IOCTL_DEF(DRM_IOCTL_MARK_BUFS
, drm_markbufs
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
95 DRM_IOCTL_DEF(DRM_IOCTL_INFO_BUFS
, drm_infobufs
, DRM_AUTH
),
96 DRM_IOCTL_DEF(DRM_IOCTL_MAP_BUFS
, drm_mapbufs
, DRM_AUTH
),
97 DRM_IOCTL_DEF(DRM_IOCTL_FREE_BUFS
, drm_freebufs
, DRM_AUTH
),
98 /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
99 DRM_IOCTL_DEF(DRM_IOCTL_DMA
, NULL
, DRM_AUTH
),
101 DRM_IOCTL_DEF(DRM_IOCTL_CONTROL
, drm_control
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
104 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ACQUIRE
, drm_agp_acquire_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
105 DRM_IOCTL_DEF(DRM_IOCTL_AGP_RELEASE
, drm_agp_release_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
106 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ENABLE
, drm_agp_enable_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
107 DRM_IOCTL_DEF(DRM_IOCTL_AGP_INFO
, drm_agp_info_ioctl
, DRM_AUTH
),
108 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ALLOC
, drm_agp_alloc_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
109 DRM_IOCTL_DEF(DRM_IOCTL_AGP_FREE
, drm_agp_free_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
110 DRM_IOCTL_DEF(DRM_IOCTL_AGP_BIND
, drm_agp_bind_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
111 DRM_IOCTL_DEF(DRM_IOCTL_AGP_UNBIND
, drm_agp_unbind_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
114 DRM_IOCTL_DEF(DRM_IOCTL_SG_ALLOC
, drm_sg_alloc_ioctl
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
115 DRM_IOCTL_DEF(DRM_IOCTL_SG_FREE
, drm_sg_free
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
117 DRM_IOCTL_DEF(DRM_IOCTL_WAIT_VBLANK
, drm_wait_vblank
, 0),
119 DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW
, drm_update_drawable_info
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
122 #define DRM_CORE_IOCTL_COUNT ARRAY_SIZE( drm_ioctls )
125 * Take down the DRM device.
127 * \param dev DRM device structure.
129 * Frees every resource in \p dev.
133 int drm_lastclose(struct drm_device
* dev
)
135 struct drm_magic_entry
*pt
, *next
;
136 struct drm_map_list
*r_list
, *list_t
;
137 struct drm_vma_entry
*vma
, *vma_temp
;
142 if (dev
->driver
->lastclose
)
143 dev
->driver
->lastclose(dev
);
144 DRM_DEBUG("driver lastclose completed\n");
147 drm_free(dev
->unique
, strlen(dev
->unique
) + 1, DRM_MEM_DRIVER
);
152 if (dev
->irq_enabled
)
153 drm_irq_uninstall(dev
);
155 mutex_lock(&dev
->struct_mutex
);
157 /* Free drawable information memory */
158 drm_drawable_free_all(dev
);
159 del_timer(&dev
->timer
);
162 if (dev
->magicfree
.next
) {
163 list_for_each_entry_safe(pt
, next
, &dev
->magicfree
, head
) {
165 drm_ht_remove_item(&dev
->magiclist
, &pt
->hash_item
);
166 drm_free(pt
, sizeof(*pt
), DRM_MEM_MAGIC
);
168 drm_ht_remove(&dev
->magiclist
);
171 /* Clear AGP information */
172 if (drm_core_has_AGP(dev
) && dev
->agp
) {
173 struct drm_agp_mem
*entry
, *tempe
;
175 /* Remove AGP resources, but leave dev->agp
176 intact until drv_cleanup is called. */
177 list_for_each_entry_safe(entry
, tempe
, &dev
->agp
->memory
, head
) {
179 drm_unbind_agp(entry
->memory
);
180 drm_free_agp(entry
->memory
, entry
->pages
);
181 drm_free(entry
, sizeof(*entry
), DRM_MEM_AGPLISTS
);
183 INIT_LIST_HEAD(&dev
->agp
->memory
);
185 if (dev
->agp
->acquired
)
186 drm_agp_release(dev
);
188 dev
->agp
->acquired
= 0;
189 dev
->agp
->enabled
= 0;
191 if (drm_core_check_feature(dev
, DRIVER_SG
) && dev
->sg
) {
192 drm_sg_cleanup(dev
->sg
);
196 /* Clear vma list (only built for debugging) */
197 list_for_each_entry_safe(vma
, vma_temp
, &dev
->vmalist
, head
) {
198 list_del(&vma
->head
);
199 drm_free(vma
, sizeof(*vma
), DRM_MEM_VMAS
);
202 list_for_each_entry_safe(r_list
, list_t
, &dev
->maplist
, head
) {
203 drm_rmmap_locked(dev
, r_list
->map
);
207 if (drm_core_check_feature(dev
, DRIVER_DMA_QUEUE
) && dev
->queuelist
) {
208 for (i
= 0; i
< dev
->queue_count
; i
++) {
209 if (dev
->queuelist
[i
]) {
210 drm_free(dev
->queuelist
[i
],
211 sizeof(*dev
->queuelist
[0]),
213 dev
->queuelist
[i
] = NULL
;
216 drm_free(dev
->queuelist
,
217 dev
->queue_slots
* sizeof(*dev
->queuelist
),
219 dev
->queuelist
= NULL
;
221 dev
->queue_count
= 0;
223 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
224 drm_dma_takedown(dev
);
226 if (dev
->lock
.hw_lock
) {
227 dev
->sigdata
.lock
= dev
->lock
.hw_lock
= NULL
; /* SHM removed */
228 dev
->lock
.file_priv
= NULL
;
229 wake_up_interruptible(&dev
->lock
.lock_queue
);
231 mutex_unlock(&dev
->struct_mutex
);
233 DRM_DEBUG("lastclose completed\n");
238 * Module initialization. Called via init_module at module load time, or via
239 * linux/init/main.c (this is not currently supported).
241 * \return zero on success or a negative number on failure.
243 * Initializes an array of drm_device structures, and attempts to
244 * initialize all available devices, using consecutive minors, registering the
245 * stubs and initializing the AGP device.
247 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
248 * after the initialization for driver customization.
250 int drm_init(struct drm_driver
*driver
)
252 struct pci_dev
*pdev
= NULL
;
253 struct pci_device_id
*pid
;
260 for (i
= 0; driver
->pci_driver
.id_table
[i
].vendor
!= 0; i
++) {
261 pid
= (struct pci_device_id
*)&driver
->pci_driver
.id_table
[i
];
264 /* pass back in pdev to account for multiple identical cards */
266 pci_get_subsys(pid
->vendor
, pid
->device
, pid
->subvendor
,
267 pid
->subdevice
, pdev
)) != NULL
) {
268 /* stealth mode requires a manual probe */
270 drm_get_dev(pdev
, pid
, driver
);
276 EXPORT_SYMBOL(drm_init
);
279 * Called via cleanup_module() at module unload time.
281 * Cleans up all DRM device, calling drm_lastclose().
285 static void drm_cleanup(struct drm_device
* dev
)
290 DRM_ERROR("cleanup called no dev\n");
296 drm_ht_remove(&dev
->map_hash
);
298 drm_ctxbitmap_cleanup(dev
);
300 if (drm_core_has_MTRR(dev
) && drm_core_has_AGP(dev
) &&
301 dev
->agp
&& dev
->agp
->agp_mtrr
>= 0) {
303 retval
= mtrr_del(dev
->agp
->agp_mtrr
,
304 dev
->agp
->agp_info
.aper_base
,
305 dev
->agp
->agp_info
.aper_size
* 1024 * 1024);
306 DRM_DEBUG("mtrr_del=%d\n", retval
);
309 if (drm_core_has_AGP(dev
) && dev
->agp
) {
310 drm_free(dev
->agp
, sizeof(*dev
->agp
), DRM_MEM_AGPLISTS
);
314 if (dev
->driver
->unload
)
315 dev
->driver
->unload(dev
);
317 drm_put_head(&dev
->primary
);
318 if (drm_put_dev(dev
))
319 DRM_ERROR("Cannot unload module\n");
322 void drm_exit(struct drm_driver
*driver
)
325 struct drm_device
*dev
= NULL
;
326 struct drm_head
*head
;
330 for (i
= 0; i
< drm_cards_limit
; i
++) {
336 if (head
->dev
->driver
!= driver
)
340 /* release the pci driver */
342 pci_dev_put(dev
->pdev
);
346 DRM_INFO("Module unloaded\n");
349 EXPORT_SYMBOL(drm_exit
);
351 /** File operations structure */
352 static const struct file_operations drm_stub_fops
= {
353 .owner
= THIS_MODULE
,
354 .open
= drm_stub_open
357 static int __init
drm_core_init(void)
363 DRM_MAX_MINOR
+ 1 ? drm_cards_limit
: DRM_MAX_MINOR
+ 1);
365 drm_calloc(drm_cards_limit
, sizeof(*drm_heads
), DRM_MEM_STUB
);
369 if (register_chrdev(DRM_MAJOR
, "drm", &drm_stub_fops
))
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
);
379 drm_proc_root
= proc_mkdir("dri", NULL
);
380 if (!drm_proc_root
) {
381 DRM_ERROR("Cannot create /proc/dri\n");
386 DRM_INFO("Initialized %s %d.%d.%d %s\n",
387 CORE_NAME
, CORE_MAJOR
, CORE_MINOR
, CORE_PATCHLEVEL
, CORE_DATE
);
390 drm_sysfs_destroy(drm_class
);
392 unregister_chrdev(DRM_MAJOR
, "drm");
393 drm_free(drm_heads
, sizeof(*drm_heads
) * drm_cards_limit
, DRM_MEM_STUB
);
398 static void __exit
drm_core_exit(void)
400 remove_proc_entry("dri", NULL
);
401 drm_sysfs_destroy(drm_class
);
403 unregister_chrdev(DRM_MAJOR
, "drm");
405 drm_free(drm_heads
, sizeof(*drm_heads
) * drm_cards_limit
, DRM_MEM_STUB
);
408 module_init(drm_core_init
);
409 module_exit(drm_core_exit
);
412 * Get version information
414 * \param inode device inode.
415 * \param filp file pointer.
416 * \param cmd command.
417 * \param arg user argument, pointing to a drm_version structure.
418 * \return zero on success or negative number on failure.
420 * Fills in the version information in \p arg.
422 static int drm_version(struct drm_device
*dev
, void *data
,
423 struct drm_file
*file_priv
)
425 struct drm_version
*version
= data
;
428 version
->version_major
= dev
->driver
->major
;
429 version
->version_minor
= dev
->driver
->minor
;
430 version
->version_patchlevel
= dev
->driver
->patchlevel
;
431 DRM_COPY(version
->name
, dev
->driver
->name
);
432 DRM_COPY(version
->date
, dev
->driver
->date
);
433 DRM_COPY(version
->desc
, dev
->driver
->desc
);
439 * Called whenever a process performs an ioctl on /dev/drm.
441 * \param inode device inode.
442 * \param file_priv DRM file private.
443 * \param cmd command.
444 * \param arg user argument.
445 * \return zero on success or negative number on failure.
447 * Looks up the ioctl function in the ::ioctls table, checking for root
448 * previleges if so required, and dispatches to the respective function.
450 int drm_ioctl(struct inode
*inode
, struct file
*filp
,
451 unsigned int cmd
, unsigned long arg
)
453 struct drm_file
*file_priv
= filp
->private_data
;
454 struct drm_device
*dev
= file_priv
->head
->dev
;
455 struct drm_ioctl_desc
*ioctl
;
457 unsigned int nr
= DRM_IOCTL_NR(cmd
);
458 int retcode
= -EINVAL
;
461 atomic_inc(&dev
->ioctl_count
);
462 atomic_inc(&dev
->counts
[_DRM_STAT_IOCTLS
]);
463 ++file_priv
->ioctl_count
;
465 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
466 task_pid_nr(current
), cmd
, nr
,
467 (long)old_encode_dev(file_priv
->head
->device
),
468 file_priv
->authenticated
);
470 if ((nr
>= DRM_CORE_IOCTL_COUNT
) &&
471 ((nr
< DRM_COMMAND_BASE
) || (nr
>= DRM_COMMAND_END
)))
473 if ((nr
>= DRM_COMMAND_BASE
) && (nr
< DRM_COMMAND_END
) &&
474 (nr
< DRM_COMMAND_BASE
+ dev
->driver
->num_ioctls
))
475 ioctl
= &dev
->driver
->ioctls
[nr
- DRM_COMMAND_BASE
];
476 else if ((nr
>= DRM_COMMAND_END
) || (nr
< DRM_COMMAND_BASE
))
477 ioctl
= &drm_ioctls
[nr
];
482 /* is there a local override? */
483 if ((nr
== DRM_IOCTL_NR(DRM_IOCTL_DMA
)) && dev
->driver
->dma_ioctl
)
484 func
= dev
->driver
->dma_ioctl
;
488 DRM_DEBUG("no function\n");
490 } else if (((ioctl
->flags
& DRM_ROOT_ONLY
) && !capable(CAP_SYS_ADMIN
)) ||
491 ((ioctl
->flags
& DRM_AUTH
) && !file_priv
->authenticated
) ||
492 ((ioctl
->flags
& DRM_MASTER
) && !file_priv
->master
)) {
495 if (cmd
& (IOC_IN
| IOC_OUT
)) {
496 kdata
= kmalloc(_IOC_SIZE(cmd
), GFP_KERNEL
);
502 if (copy_from_user(kdata
, (void __user
*)arg
,
503 _IOC_SIZE(cmd
)) != 0) {
508 retcode
= func(dev
, kdata
, file_priv
);
511 if (copy_to_user((void __user
*)arg
, kdata
,
512 _IOC_SIZE(cmd
)) != 0)
520 atomic_dec(&dev
->ioctl_count
);
522 DRM_DEBUG("ret = %x\n", retcode
);
526 EXPORT_SYMBOL(drm_ioctl
);
528 drm_local_map_t
*drm_getsarea(struct drm_device
*dev
)
530 struct drm_map_list
*entry
;
532 list_for_each_entry(entry
, &dev
->maplist
, head
) {
533 if (entry
->map
&& entry
->map
->type
== _DRM_SHM
&&
534 (entry
->map
->flags
& _DRM_CONTAINS_LOCK
)) {
540 EXPORT_SYMBOL(drm_getsarea
);