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},
60 [DRM_IOCTL_NR(DRM_IOCTL_GET_UNIQUE)] = {drm_getunique, 0},
61 [DRM_IOCTL_NR(DRM_IOCTL_GET_MAGIC)] = {drm_getmagic, 0},
62 [DRM_IOCTL_NR(DRM_IOCTL_IRQ_BUSID)] = {drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY},
63 [DRM_IOCTL_NR(DRM_IOCTL_GET_MAP)] = {drm_getmap, 0},
64 [DRM_IOCTL_NR(DRM_IOCTL_GET_CLIENT)] = {drm_getclient, 0},
65 [DRM_IOCTL_NR(DRM_IOCTL_GET_STATS)] = {drm_getstats, 0},
66 [DRM_IOCTL_NR(DRM_IOCTL_SET_VERSION)] = {drm_setversion, DRM_MASTER|DRM_ROOT_ONLY},
67 [DRM_IOCTL_NR(DRM_IOCTL_SET_UNIQUE)] = {drm_setunique, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
68 [DRM_IOCTL_NR(DRM_IOCTL_BLOCK)] = {drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
69 [DRM_IOCTL_NR(DRM_IOCTL_UNBLOCK)] = {drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
70 [DRM_IOCTL_NR(DRM_IOCTL_AUTH_MAGIC)] = {drm_authmagic, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
72 [DRM_IOCTL_NR(DRM_IOCTL_ADD_MAP)] = {drm_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
73 [DRM_IOCTL_NR(DRM_IOCTL_RM_MAP)] = {drm_rmmap_ioctl, DRM_AUTH},
75 [DRM_IOCTL_NR(DRM_IOCTL_SET_SAREA_CTX)] = {drm_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
76 [DRM_IOCTL_NR(DRM_IOCTL_GET_SAREA_CTX)] = {drm_getsareactx, DRM_AUTH},
78 [DRM_IOCTL_NR(DRM_IOCTL_ADD_CTX)] = {drm_addctx, DRM_AUTH|DRM_ROOT_ONLY},
79 [DRM_IOCTL_NR(DRM_IOCTL_RM_CTX)] = {drm_rmctx, DRM_AUTH|DRM_ROOT_ONLY},
80 [DRM_IOCTL_NR(DRM_IOCTL_MOD_CTX)] = {drm_modctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
81 [DRM_IOCTL_NR(DRM_IOCTL_GET_CTX)] = {drm_getctx, DRM_AUTH},
82 [DRM_IOCTL_NR(DRM_IOCTL_SWITCH_CTX)] = {drm_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
83 [DRM_IOCTL_NR(DRM_IOCTL_NEW_CTX)] = {drm_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
84 [DRM_IOCTL_NR(DRM_IOCTL_RES_CTX)] = {drm_resctx, DRM_AUTH},
86 [DRM_IOCTL_NR(DRM_IOCTL_ADD_DRAW)] = {drm_adddraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
87 [DRM_IOCTL_NR(DRM_IOCTL_RM_DRAW)] = {drm_rmdraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
89 [DRM_IOCTL_NR(DRM_IOCTL_LOCK)] = {drm_lock, DRM_AUTH},
90 [DRM_IOCTL_NR(DRM_IOCTL_UNLOCK)] = {drm_unlock, DRM_AUTH},
92 [DRM_IOCTL_NR(DRM_IOCTL_FINISH)] = {drm_noop, DRM_AUTH},
94 [DRM_IOCTL_NR(DRM_IOCTL_ADD_BUFS)] = {drm_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
95 [DRM_IOCTL_NR(DRM_IOCTL_MARK_BUFS)] = {drm_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
96 [DRM_IOCTL_NR(DRM_IOCTL_INFO_BUFS)] = {drm_infobufs, DRM_AUTH},
97 [DRM_IOCTL_NR(DRM_IOCTL_MAP_BUFS)] = {drm_mapbufs, DRM_AUTH},
98 [DRM_IOCTL_NR(DRM_IOCTL_FREE_BUFS)] = {drm_freebufs, DRM_AUTH},
99 /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
100 [DRM_IOCTL_NR(DRM_IOCTL_DMA)] = {NULL, DRM_AUTH},
102 [DRM_IOCTL_NR(DRM_IOCTL_CONTROL)] = {drm_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
105 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ACQUIRE)] = {drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
106 [DRM_IOCTL_NR(DRM_IOCTL_AGP_RELEASE)] = {drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
107 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ENABLE)] = {drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
108 [DRM_IOCTL_NR(DRM_IOCTL_AGP_INFO)] = {drm_agp_info_ioctl, DRM_AUTH},
109 [DRM_IOCTL_NR(DRM_IOCTL_AGP_ALLOC)] = {drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
110 [DRM_IOCTL_NR(DRM_IOCTL_AGP_FREE)] = {drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
111 [DRM_IOCTL_NR(DRM_IOCTL_AGP_BIND)] = {drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
112 [DRM_IOCTL_NR(DRM_IOCTL_AGP_UNBIND)] = {drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
115 [DRM_IOCTL_NR(DRM_IOCTL_SG_ALLOC)] = {drm_sg_alloc, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
116 [DRM_IOCTL_NR(DRM_IOCTL_SG_FREE)] = {drm_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY},
118 [DRM_IOCTL_NR(DRM_IOCTL_WAIT_VBLANK)] = {drm_wait_vblank, 0},
121 #define DRIVER_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(drm_device_t * dev)
134 drm_magic_entry_t *pt, *next;
135 drm_map_list_t *r_list;
136 drm_vma_entry_t *vma, *vma_next;
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);
155 del_timer(&dev->timer);
158 if (dev->magicfree.next) {
159 list_for_each_entry_safe(pt, next, &dev->magicfree, head) {
161 drm_ht_remove_item(&dev->magiclist, &pt->hash_item);
162 drm_free(pt, sizeof(*pt), DRM_MEM_MAGIC);
164 drm_ht_remove(&dev->magiclist);
167 /* Clear AGP information */
168 if (drm_core_has_AGP(dev) && dev->agp) {
169 drm_agp_mem_t *entry;
170 drm_agp_mem_t *nexte;
172 /* Remove AGP resources, but leave dev->agp
173 intact until drv_cleanup is called. */
174 for (entry = dev->agp->memory; entry; entry = nexte) {
177 drm_unbind_agp(entry->memory);
178 drm_free_agp(entry->memory, entry->pages);
179 drm_free(entry, sizeof(*entry), DRM_MEM_AGPLISTS);
181 dev->agp->memory = NULL;
183 if (dev->agp->acquired)
184 drm_agp_release(dev);
186 dev->agp->acquired = 0;
187 dev->agp->enabled = 0;
189 if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg) {
190 drm_sg_cleanup(dev->sg);
194 /* Clear vma list (only built for debugging) */
196 for (vma = dev->vmalist; vma; vma = vma_next) {
197 vma_next = vma->next;
198 drm_free(vma, sizeof(*vma), DRM_MEM_VMAS);
204 while (!list_empty(&dev->maplist->head)) {
205 struct list_head *list = dev->maplist->head.next;
206 r_list = list_entry(list, drm_map_list_t, head);
207 drm_rmmap_locked(dev, r_list->map);
211 if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE) && dev->queuelist) {
212 for (i = 0; i < dev->queue_count; i++) {
213 if (dev->queuelist[i]) {
214 drm_free(dev->queuelist[i],
215 sizeof(*dev->queuelist[0]),
217 dev->queuelist[i] = NULL;
220 drm_free(dev->queuelist,
221 dev->queue_slots * sizeof(*dev->queuelist),
223 dev->queuelist = NULL;
225 dev->queue_count = 0;
227 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
228 drm_dma_takedown(dev);
230 if (dev->lock.hw_lock) {
231 dev->sigdata.lock = dev->lock.hw_lock = NULL; /* SHM removed */
232 dev->lock.filp = NULL;
233 wake_up_interruptible(&dev->lock.lock_queue);
235 mutex_unlock(&dev->struct_mutex);
237 DRM_DEBUG("lastclose completed\n");
242 * Module initialization. Called via init_module at module load time, or via
243 * linux/init/main.c (this is not currently supported).
245 * \return zero on success or a negative number on failure.
247 * Initializes an array of drm_device structures, and attempts to
248 * initialize all available devices, using consecutive minors, registering the
249 * stubs and initializing the AGP device.
251 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
252 * after the initialization for driver customization.
254 int drm_init(struct drm_driver *driver)
256 struct pci_dev *pdev = NULL;
257 struct pci_device_id *pid;
264 for (i = 0; driver->pci_driver.id_table[i].vendor != 0; i++) {
265 pid = (struct pci_device_id *)&driver->pci_driver.id_table[i];
268 /* pass back in pdev to account for multiple identical cards */
270 pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
271 pid->subdevice, pdev)) != NULL) {
272 /* stealth mode requires a manual probe */
274 drm_get_dev(pdev, pid, driver);
280 EXPORT_SYMBOL(drm_init);
283 * Called via cleanup_module() at module unload time.
285 * Cleans up all DRM device, calling drm_lastclose().
289 static void drm_cleanup(drm_device_t * dev)
294 DRM_ERROR("cleanup called no dev\n");
301 drm_free(dev->maplist, sizeof(*dev->maplist), DRM_MEM_MAPS);
303 drm_ht_remove(&dev->map_hash);
306 drm_ctxbitmap_cleanup(dev);
308 if (drm_core_has_MTRR(dev) && drm_core_has_AGP(dev) &&
309 dev->agp && dev->agp->agp_mtrr >= 0) {
311 retval = mtrr_del(dev->agp->agp_mtrr,
312 dev->agp->agp_info.aper_base,
313 dev->agp->agp_info.aper_size * 1024 * 1024);
314 DRM_DEBUG("mtrr_del=%d\n", retval);
317 if (drm_core_has_AGP(dev) && dev->agp) {
318 drm_free(dev->agp, sizeof(*dev->agp), DRM_MEM_AGPLISTS);
322 if (dev->driver->unload)
323 dev->driver->unload(dev);
325 drm_put_head(&dev->primary);
326 if (drm_put_dev(dev))
327 DRM_ERROR("Cannot unload module\n");
330 void drm_exit(struct drm_driver *driver)
333 drm_device_t *dev = NULL;
338 for (i = 0; i < drm_cards_limit; i++) {
344 if (head->dev->driver != driver)
348 /* release the pci driver */
350 pci_dev_put(dev->pdev);
354 DRM_INFO("Module unloaded\n");
357 EXPORT_SYMBOL(drm_exit);
359 /** File operations structure */
360 static struct file_operations drm_stub_fops = {
361 .owner = THIS_MODULE,
362 .open = drm_stub_open
365 static int __init drm_core_init(void)
371 DRM_MAX_MINOR + 1 ? drm_cards_limit : DRM_MAX_MINOR + 1);
373 drm_calloc(drm_cards_limit, sizeof(*drm_heads), DRM_MEM_STUB);
377 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
380 drm_class = drm_sysfs_create(THIS_MODULE, "drm");
381 if (IS_ERR(drm_class)) {
382 printk(KERN_ERR "DRM: Error creating drm class.\n");
383 ret = PTR_ERR(drm_class);
387 drm_proc_root = proc_mkdir("dri", NULL);
388 if (!drm_proc_root) {
389 DRM_ERROR("Cannot create /proc/dri\n");
394 DRM_INFO("Initialized %s %d.%d.%d %s\n",
395 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
398 drm_sysfs_destroy(drm_class);
400 unregister_chrdev(DRM_MAJOR, "drm");
401 drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
406 static void __exit drm_core_exit(void)
408 remove_proc_entry("dri", NULL);
409 drm_sysfs_destroy(drm_class);
411 unregister_chrdev(DRM_MAJOR, "drm");
413 drm_free(drm_heads, sizeof(*drm_heads) * drm_cards_limit, DRM_MEM_STUB);
416 module_init(drm_core_init);
417 module_exit(drm_core_exit);
420 * Get version information
422 * \param inode device inode.
423 * \param filp file pointer.
424 * \param cmd command.
425 * \param arg user argument, pointing to a drm_version structure.
426 * \return zero on success or negative number on failure.
428 * Fills in the version information in \p arg.
430 static int drm_version(struct inode *inode, struct file *filp,
431 unsigned int cmd, unsigned long arg)
433 drm_file_t *priv = filp->private_data;
434 drm_device_t *dev = priv->head->dev;
435 drm_version_t __user *argp = (void __user *)arg;
436 drm_version_t version;
439 if (copy_from_user(&version, argp, sizeof(version)))
442 version.version_major = dev->driver->major;
443 version.version_minor = dev->driver->minor;
444 version.version_patchlevel = dev->driver->patchlevel;
445 DRM_COPY(version.name, dev->driver->name);
446 DRM_COPY(version.date, dev->driver->date);
447 DRM_COPY(version.desc, dev->driver->desc);
449 if (copy_to_user(argp, &version, sizeof(version)))
455 * Called whenever a process performs an ioctl on /dev/drm.
457 * \param inode device inode.
458 * \param filp file pointer.
459 * \param cmd command.
460 * \param arg user argument.
461 * \return zero on success or negative number on failure.
463 * Looks up the ioctl function in the ::ioctls table, checking for root
464 * previleges if so required, and dispatches to the respective function.
466 int drm_ioctl(struct inode *inode, struct file *filp,
467 unsigned int cmd, unsigned long arg)
469 drm_file_t *priv = filp->private_data;
470 drm_device_t *dev = priv->head->dev;
471 drm_ioctl_desc_t *ioctl;
473 unsigned int nr = DRM_IOCTL_NR(cmd);
474 int retcode = -EINVAL;
476 atomic_inc(&dev->ioctl_count);
477 atomic_inc(&dev->counts[_DRM_STAT_IOCTLS]);
480 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
481 current->pid, cmd, nr,
482 (long)old_encode_dev(priv->head->device),
483 priv->authenticated);
485 if (nr < DRIVER_IOCTL_COUNT)
486 ioctl = &drm_ioctls[nr];
487 else if ((nr >= DRM_COMMAND_BASE)
488 && (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls))
489 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
494 /* is there a local override? */
495 if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
496 func = dev->driver->dma_ioctl;
499 DRM_DEBUG("no function\n");
501 } else if (((ioctl->flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN)) ||
502 ((ioctl->flags & DRM_AUTH) && !priv->authenticated) ||
503 ((ioctl->flags & DRM_MASTER) && !priv->master)) {
506 retcode = func(inode, filp, cmd, arg);
510 atomic_dec(&dev->ioctl_count);
512 DRM_DEBUG("ret = %x\n", retcode);
516 EXPORT_SYMBOL(drm_ioctl);