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 inode *inode, struct file *filp,
53 unsigned int cmd, unsigned long arg);
56 static drm_ioctl_desc_t drm_ioctls[] = {
57 [DRM_IOCTL_NR(DRM_IOCTL_VERSION)] = {drm_version, 0},
58 [DRM_IOCTL_NR(DRM_IOCTL_GET_UNIQUE)] = {drm_getunique, 0},
59 [DRM_IOCTL_NR(DRM_IOCTL_GET_MAGIC)] = {drm_getmagic, 0},
60 [DRM_IOCTL_NR(DRM_IOCTL_IRQ_BUSID)] = {drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY},
61 [DRM_IOCTL_NR(DRM_IOCTL_GET_MAP)] = {drm_getmap, 0},
62 [DRM_IOCTL_NR(DRM_IOCTL_GET_CLIENT)] = {drm_getclient, 0},
63 [DRM_IOCTL_NR(DRM_IOCTL_GET_STATS)] = {drm_getstats, 0},
64 [DRM_IOCTL_NR(DRM_IOCTL_SET_VERSION)] = {drm_setversion, DRM_MASTER|DRM_ROOT_ONLY},
65 [DRM_IOCTL_NR(DRM_IOCTL_SET_UNIQUE)] = {drm_setunique, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
66 [DRM_IOCTL_NR(DRM_IOCTL_BLOCK)] = {drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
67 [DRM_IOCTL_NR(DRM_IOCTL_UNBLOCK)] = {drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
68 [DRM_IOCTL_NR(DRM_IOCTL_AUTH_MAGIC)] = {drm_authmagic, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
70 [DRM_IOCTL_NR(DRM_IOCTL_ADD_MAP)] = {drm_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
71 [DRM_IOCTL_NR(DRM_IOCTL_RM_MAP)] = {drm_rmmap_ioctl, DRM_AUTH},
73 [DRM_IOCTL_NR(DRM_IOCTL_SET_SAREA_CTX)] = {drm_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
74 [DRM_IOCTL_NR(DRM_IOCTL_GET_SAREA_CTX)] = {drm_getsareactx, DRM_AUTH},
76 [DRM_IOCTL_NR(DRM_IOCTL_ADD_CTX)] = {drm_addctx, DRM_AUTH|DRM_ROOT_ONLY},
77 [DRM_IOCTL_NR(DRM_IOCTL_RM_CTX)] = {drm_rmctx, DRM_AUTH|DRM_ROOT_ONLY},
78 [DRM_IOCTL_NR(DRM_IOCTL_MOD_CTX)] = {drm_modctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
79 [DRM_IOCTL_NR(DRM_IOCTL_GET_CTX)] = {drm_getctx, DRM_AUTH},
80 [DRM_IOCTL_NR(DRM_IOCTL_SWITCH_CTX)] = {drm_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
81 [DRM_IOCTL_NR(DRM_IOCTL_NEW_CTX)] = {drm_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
82 [DRM_IOCTL_NR(DRM_IOCTL_RES_CTX)] = {drm_resctx, DRM_AUTH},
84 [DRM_IOCTL_NR(DRM_IOCTL_ADD_DRAW)] = {drm_adddraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
85 [DRM_IOCTL_NR(DRM_IOCTL_RM_DRAW)] = {drm_rmdraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
87 [DRM_IOCTL_NR(DRM_IOCTL_LOCK)] = {drm_lock, DRM_AUTH},
88 [DRM_IOCTL_NR(DRM_IOCTL_UNLOCK)] = {drm_unlock, DRM_AUTH},
90 [DRM_IOCTL_NR(DRM_IOCTL_FINISH)] = {drm_noop, DRM_AUTH},
92 [DRM_IOCTL_NR(DRM_IOCTL_ADD_BUFS)] = {drm_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
93 [DRM_IOCTL_NR(DRM_IOCTL_MARK_BUFS)] = {drm_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
94 [DRM_IOCTL_NR(DRM_IOCTL_INFO_BUFS)] = {drm_infobufs, DRM_AUTH},
95 [DRM_IOCTL_NR(DRM_IOCTL_MAP_BUFS)] = {drm_mapbufs, DRM_AUTH},
96 [DRM_IOCTL_NR(DRM_IOCTL_FREE_BUFS)] = {drm_freebufs, DRM_AUTH},
97 /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
98 [DRM_IOCTL_NR(DRM_IOCTL_DMA)] = {NULL, DRM_AUTH},
100 [DRM_IOCTL_NR(DRM_IOCTL_CONTROL)] = {drm_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
103 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ACQUIRE)] = {drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
104 [DRM_IOCTL_NR(DRM_IOCTL_AGP_RELEASE)] = {drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
105 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ENABLE)] = {drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
106 [DRM_IOCTL_NR(DRM_IOCTL_AGP_INFO)] = {drm_agp_info_ioctl, DRM_AUTH},
107 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ALLOC)] = {drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
108 [DRM_IOCTL_NR(DRM_IOCTL_AGP_FREE)] = {drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
109 [DRM_IOCTL_NR(DRM_IOCTL_AGP_BIND)] = {drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
110 [DRM_IOCTL_NR(DRM_IOCTL_AGP_UNBIND)] = {drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
113 [DRM_IOCTL_NR(DRM_IOCTL_SG_ALLOC)] = {drm_sg_alloc, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
114 [DRM_IOCTL_NR(DRM_IOCTL_SG_FREE)] = {drm_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
116 [DRM_IOCTL_NR(DRM_IOCTL_WAIT_VBLANK)] = {drm_wait_vblank, 0},
118 [DRM_IOCTL_NR(DRM_IOCTL_UPDATE_DRAW)] = {drm_update_drawable_info, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
121 #define DRM_CORE_IOCTL_COUNT ARRAY_SIZE( drm_ioctls )
124 * Take down the DRM device.
126 * \param dev DRM device structure.
128 * Frees every resource in \p dev.
132 int drm_lastclose(struct drm_device * dev)
134 struct drm_magic_entry *pt, *next;
135 struct drm_map_list *r_list, *list_t;
136 struct drm_vma_entry *vma, *vma_temp;
141 if (dev->driver->lastclose)
142 dev->driver->lastclose(dev);
143 DRM_DEBUG("driver lastclose completed\n");
146 drm_free(dev->unique, strlen(dev->unique) + 1, DRM_MEM_DRIVER);
151 if (dev->irq_enabled)
152 drm_irq_uninstall(dev);
154 mutex_lock(&dev->struct_mutex);
156 /* Free drawable information memory */
157 drm_drawable_free_all(dev);
158 del_timer(&dev->timer);
161 if (dev->magicfree.next) {
162 list_for_each_entry_safe(pt, next, &dev->magicfree, head) {
164 drm_ht_remove_item(&dev->magiclist, &pt->hash_item);
165 drm_free(pt, sizeof(*pt), DRM_MEM_MAGIC);
167 drm_ht_remove(&dev->magiclist);
170 /* Clear AGP information */
171 if (drm_core_has_AGP(dev) && dev->agp) {
172 struct drm_agp_mem *entry, *tempe;
174 /* Remove AGP resources, but leave dev->agp
175 intact until drv_cleanup is called. */
176 list_for_each_entry_safe(entry, tempe, &dev->agp->memory, head) {
178 drm_unbind_agp(entry->memory);
179 drm_free_agp(entry->memory, entry->pages);
180 drm_free(entry, sizeof(*entry), DRM_MEM_AGPLISTS);
182 INIT_LIST_HEAD(&dev->agp->memory);
184 if (dev->agp->acquired)
185 drm_agp_release(dev);
187 dev->agp->acquired = 0;
188 dev->agp->enabled = 0;
190 if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg) {
191 drm_sg_cleanup(dev->sg);
195 /* Clear vma list (only built for debugging) */
196 list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
197 list_del(&vma->head);
198 drm_free(vma, sizeof(*vma), DRM_MEM_VMAS);
201 list_for_each_entry_safe(r_list, list_t, &dev->maplist, head) {
202 drm_rmmap_locked(dev, r_list->map);
206 if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE) && dev->queuelist) {
207 for (i = 0; i < dev->queue_count; i++) {
208 if (dev->queuelist[i]) {
209 drm_free(dev->queuelist[i],
210 sizeof(*dev->queuelist[0]),
212 dev->queuelist[i] = NULL;
215 drm_free(dev->queuelist,
216 dev->queue_slots * sizeof(*dev->queuelist),
218 dev->queuelist = NULL;
220 dev->queue_count = 0;
222 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
223 drm_dma_takedown(dev);
225 if (dev->lock.hw_lock) {
226 dev->sigdata.lock = dev->lock.hw_lock = NULL; /* SHM removed */
227 dev->lock.filp = NULL;
228 wake_up_interruptible(&dev->lock.lock_queue);
230 mutex_unlock(&dev->struct_mutex);
232 DRM_DEBUG("lastclose completed\n");
237 * Module initialization. Called via init_module at module load time, or via
238 * linux/init/main.c (this is not currently supported).
240 * \return zero on success or a negative number on failure.
242 * Initializes an array of drm_device structures, and attempts to
243 * initialize all available devices, using consecutive minors, registering the
244 * stubs and initializing the AGP device.
246 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
247 * after the initialization for driver customization.
249 int drm_init(struct drm_driver *driver)
251 struct pci_dev *pdev = NULL;
252 struct pci_device_id *pid;
259 for (i = 0; driver->pci_driver.id_table[i].vendor != 0; i++) {
260 pid = (struct pci_device_id *)&driver->pci_driver.id_table[i];
263 /* pass back in pdev to account for multiple identical cards */
265 pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
266 pid->subdevice, pdev)) != NULL) {
267 /* stealth mode requires a manual probe */
269 drm_get_dev(pdev, pid, driver);
275 EXPORT_SYMBOL(drm_init);
278 * Called via cleanup_module() at module unload time.
280 * Cleans up all DRM device, calling drm_lastclose().
284 static void drm_cleanup(struct drm_device * dev)
289 DRM_ERROR("cleanup called no dev\n");
295 drm_ht_remove(&dev->map_hash);
297 drm_ctxbitmap_cleanup(dev);
299 if (drm_core_has_MTRR(dev) && drm_core_has_AGP(dev) &&
300 dev->agp && dev->agp->agp_mtrr >= 0) {
302 retval = mtrr_del(dev->agp->agp_mtrr,
303 dev->agp->agp_info.aper_base,
304 dev->agp->agp_info.aper_size * 1024 * 1024);
305 DRM_DEBUG("mtrr_del=%d\n", retval);
308 if (drm_core_has_AGP(dev) && dev->agp) {
309 drm_free(dev->agp, sizeof(*dev->agp), DRM_MEM_AGPLISTS);
313 if (dev->driver->unload)
314 dev->driver->unload(dev);
316 drm_put_head(&dev->primary);
317 if (drm_put_dev(dev))
318 DRM_ERROR("Cannot unload module\n");
321 void drm_exit(struct drm_driver *driver)
324 struct drm_device *dev = NULL;
325 struct drm_head *head;
329 for (i = 0; i < drm_cards_limit; i++) {
335 if (head->dev->driver != driver)
339 /* release the pci driver */
341 pci_dev_put(dev->pdev);
345 DRM_INFO("Module unloaded\n");
348 EXPORT_SYMBOL(drm_exit);
350 /** File operations structure */
351 static const struct file_operations drm_stub_fops = {
352 .owner = THIS_MODULE,
353 .open = drm_stub_open
356 static int __init drm_core_init(void)
362 DRM_MAX_MINOR + 1 ? drm_cards_limit : DRM_MAX_MINOR + 1);
364 drm_calloc(drm_cards_limit, sizeof(*drm_heads), DRM_MEM_STUB);
368 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
371 drm_class = drm_sysfs_create(THIS_MODULE, "drm");
372 if (IS_ERR(drm_class)) {
373 printk(KERN_ERR "DRM: Error creating drm class.\n");
374 ret = PTR_ERR(drm_class);
378 drm_proc_root = proc_mkdir("dri", NULL);
379 if (!drm_proc_root) {
380 DRM_ERROR("Cannot create /proc/dri\n");
385 DRM_INFO("Initialized %s %d.%d.%d %s\n",
386 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
389 drm_sysfs_destroy(drm_class);
391 unregister_chrdev(DRM_MAJOR, "drm");
392 drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
397 static void __exit drm_core_exit(void)
399 remove_proc_entry("dri", NULL);
400 drm_sysfs_destroy(drm_class);
402 unregister_chrdev(DRM_MAJOR, "drm");
404 drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
407 module_init(drm_core_init);
408 module_exit(drm_core_exit);
411 * Get version information
413 * \param inode device inode.
414 * \param filp file pointer.
415 * \param cmd command.
416 * \param arg user argument, pointing to a drm_version structure.
417 * \return zero on success or negative number on failure.
419 * Fills in the version information in \p arg.
421 static int drm_version(struct inode *inode, struct file *filp,
422 unsigned int cmd, unsigned long arg)
424 struct drm_file *priv = filp->private_data;
425 struct drm_device *dev = priv->head->dev;
426 struct drm_version __user *argp = (void __user *)arg;
427 struct drm_version version;
430 if (copy_from_user(&version, argp, sizeof(version)))
433 version.version_major = dev->driver->major;
434 version.version_minor = dev->driver->minor;
435 version.version_patchlevel = dev->driver->patchlevel;
436 DRM_COPY(version.name, dev->driver->name);
437 DRM_COPY(version.date, dev->driver->date);
438 DRM_COPY(version.desc, dev->driver->desc);
440 if (copy_to_user(argp, &version, sizeof(version)))
446 * Called whenever a process performs an ioctl on /dev/drm.
448 * \param inode device inode.
449 * \param filp file pointer.
450 * \param cmd command.
451 * \param arg user argument.
452 * \return zero on success or negative number on failure.
454 * Looks up the ioctl function in the ::ioctls table, checking for root
455 * previleges if so required, and dispatches to the respective function.
457 int drm_ioctl(struct inode *inode, struct file *filp,
458 unsigned int cmd, unsigned long arg)
460 struct drm_file *priv = filp->private_data;
461 struct drm_device *dev = priv->head->dev;
462 drm_ioctl_desc_t *ioctl;
464 unsigned int nr = DRM_IOCTL_NR(cmd);
465 int retcode = -EINVAL;
467 atomic_inc(&dev->ioctl_count);
468 atomic_inc(&dev->counts[_DRM_STAT_IOCTLS]);
471 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
472 current->pid, cmd, nr,
473 (long)old_encode_dev(priv->head->device),
474 priv->authenticated);
476 if ((nr >= DRM_CORE_IOCTL_COUNT) &&
477 ((nr < DRM_COMMAND_BASE) || (nr >= DRM_COMMAND_END)))
479 if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_END) &&
480 (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls))
481 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
482 else if ((nr >= DRM_COMMAND_END) || (nr < DRM_COMMAND_BASE))
483 ioctl = &drm_ioctls[nr];
488 /* is there a local override? */
489 if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
490 func = dev->driver->dma_ioctl;
493 DRM_DEBUG("no function\n");
495 } else if (((ioctl->flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN)) ||
496 ((ioctl->flags & DRM_AUTH) && !priv->authenticated) ||
497 ((ioctl->flags & DRM_MASTER) && !priv->master)) {
500 retcode = func(inode, filp, cmd, arg);
504 atomic_dec(&dev->ioctl_count);
506 DRM_DEBUG("ret = %x\n", retcode);
510 EXPORT_SYMBOL(drm_ioctl);
512 drm_local_map_t *drm_getsarea(struct drm_device *dev)
514 struct drm_map_list *entry;
516 list_for_each_entry(entry, &dev->maplist, head) {
517 if (entry->map && entry->map->type == _DRM_SHM &&
518 (entry->map->flags & _DRM_CONTAINS_LOCK)) {
524 EXPORT_SYMBOL(drm_getsarea);