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.
49 #include <linux/debugfs.h>
54 static int drm_version(struct drm_device *dev, void *data,
55 struct drm_file *file_priv);
58 static struct drm_ioctl_desc drm_ioctls[] = {
59 DRM_IOCTL_DEF(DRM_IOCTL_VERSION, drm_version, 0),
60 DRM_IOCTL_DEF(DRM_IOCTL_GET_UNIQUE, drm_getunique, 0),
61 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAGIC, drm_getmagic, 0),
62 DRM_IOCTL_DEF(DRM_IOCTL_IRQ_BUSID, drm_irq_by_busid, DRM_MASTER|DRM_ROOT_ONLY),
63 DRM_IOCTL_DEF(DRM_IOCTL_GET_MAP, drm_getmap, 0),
64 DRM_IOCTL_DEF(DRM_IOCTL_GET_CLIENT, drm_getclient, 0),
65 DRM_IOCTL_DEF(DRM_IOCTL_GET_STATS, drm_getstats, 0),
66 DRM_IOCTL_DEF(DRM_IOCTL_SET_VERSION, drm_setversion, DRM_MASTER|DRM_ROOT_ONLY),
68 DRM_IOCTL_DEF(DRM_IOCTL_SET_UNIQUE, drm_setunique, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
69 DRM_IOCTL_DEF(DRM_IOCTL_BLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
70 DRM_IOCTL_DEF(DRM_IOCTL_UNBLOCK, drm_noop, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
71 DRM_IOCTL_DEF(DRM_IOCTL_AUTH_MAGIC, drm_authmagic, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
73 DRM_IOCTL_DEF(DRM_IOCTL_ADD_MAP, drm_addmap_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
74 DRM_IOCTL_DEF(DRM_IOCTL_RM_MAP, drm_rmmap_ioctl, DRM_AUTH),
76 DRM_IOCTL_DEF(DRM_IOCTL_SET_SAREA_CTX, drm_setsareactx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
77 DRM_IOCTL_DEF(DRM_IOCTL_GET_SAREA_CTX, drm_getsareactx, DRM_AUTH),
79 DRM_IOCTL_DEF(DRM_IOCTL_SET_MASTER, drm_setmaster_ioctl, DRM_ROOT_ONLY),
80 DRM_IOCTL_DEF(DRM_IOCTL_DROP_MASTER, drm_dropmaster_ioctl, DRM_ROOT_ONLY),
82 DRM_IOCTL_DEF(DRM_IOCTL_ADD_CTX, drm_addctx, DRM_AUTH|DRM_ROOT_ONLY),
83 DRM_IOCTL_DEF(DRM_IOCTL_RM_CTX, drm_rmctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
84 DRM_IOCTL_DEF(DRM_IOCTL_MOD_CTX, drm_modctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
85 DRM_IOCTL_DEF(DRM_IOCTL_GET_CTX, drm_getctx, DRM_AUTH),
86 DRM_IOCTL_DEF(DRM_IOCTL_SWITCH_CTX, drm_switchctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
87 DRM_IOCTL_DEF(DRM_IOCTL_NEW_CTX, drm_newctx, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
88 DRM_IOCTL_DEF(DRM_IOCTL_RES_CTX, drm_resctx, DRM_AUTH),
90 DRM_IOCTL_DEF(DRM_IOCTL_ADD_DRAW, drm_adddraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
91 DRM_IOCTL_DEF(DRM_IOCTL_RM_DRAW, drm_rmdraw, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
93 DRM_IOCTL_DEF(DRM_IOCTL_LOCK, drm_lock, DRM_AUTH),
94 DRM_IOCTL_DEF(DRM_IOCTL_UNLOCK, drm_unlock, DRM_AUTH),
96 DRM_IOCTL_DEF(DRM_IOCTL_FINISH, drm_noop, DRM_AUTH),
98 DRM_IOCTL_DEF(DRM_IOCTL_ADD_BUFS, drm_addbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
99 DRM_IOCTL_DEF(DRM_IOCTL_MARK_BUFS, drm_markbufs, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
100 DRM_IOCTL_DEF(DRM_IOCTL_INFO_BUFS, drm_infobufs, DRM_AUTH),
101 DRM_IOCTL_DEF(DRM_IOCTL_MAP_BUFS, drm_mapbufs, DRM_AUTH),
102 DRM_IOCTL_DEF(DRM_IOCTL_FREE_BUFS, drm_freebufs, DRM_AUTH),
103 /* The DRM_IOCTL_DMA ioctl should be defined by the driver. */
104 DRM_IOCTL_DEF(DRM_IOCTL_DMA, NULL, DRM_AUTH),
106 DRM_IOCTL_DEF(DRM_IOCTL_CONTROL, drm_control, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
109 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ACQUIRE, drm_agp_acquire_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
110 DRM_IOCTL_DEF(DRM_IOCTL_AGP_RELEASE, drm_agp_release_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
111 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ENABLE, drm_agp_enable_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
112 DRM_IOCTL_DEF(DRM_IOCTL_AGP_INFO, drm_agp_info_ioctl, DRM_AUTH),
113 DRM_IOCTL_DEF(DRM_IOCTL_AGP_ALLOC, drm_agp_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
114 DRM_IOCTL_DEF(DRM_IOCTL_AGP_FREE, drm_agp_free_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
115 DRM_IOCTL_DEF(DRM_IOCTL_AGP_BIND, drm_agp_bind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
116 DRM_IOCTL_DEF(DRM_IOCTL_AGP_UNBIND, drm_agp_unbind_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
119 DRM_IOCTL_DEF(DRM_IOCTL_SG_ALLOC, drm_sg_alloc_ioctl, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
120 DRM_IOCTL_DEF(DRM_IOCTL_SG_FREE, drm_sg_free, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
122 DRM_IOCTL_DEF(DRM_IOCTL_WAIT_VBLANK, drm_wait_vblank, 0),
124 DRM_IOCTL_DEF(DRM_IOCTL_MODESET_CTL, drm_modeset_ctl, 0),
126 DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW, drm_update_drawable_info, DRM_AUTH|DRM_MASTER|DRM_ROOT_ONLY),
128 DRM_IOCTL_DEF(DRM_IOCTL_GEM_CLOSE, drm_gem_close_ioctl, 0),
129 DRM_IOCTL_DEF(DRM_IOCTL_GEM_FLINK, drm_gem_flink_ioctl, DRM_AUTH),
130 DRM_IOCTL_DEF(DRM_IOCTL_GEM_OPEN, drm_gem_open_ioctl, DRM_AUTH),
132 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETRESOURCES, drm_mode_getresources, DRM_MASTER|DRM_CONTROL_ALLOW),
133 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCRTC, drm_mode_getcrtc, DRM_MASTER|DRM_CONTROL_ALLOW),
134 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETCRTC, drm_mode_setcrtc, DRM_MASTER|DRM_CONTROL_ALLOW),
135 DRM_IOCTL_DEF(DRM_IOCTL_MODE_CURSOR, drm_mode_cursor_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW),
136 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETGAMMA, drm_mode_gamma_get_ioctl, DRM_MASTER),
137 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETGAMMA, drm_mode_gamma_set_ioctl, DRM_MASTER),
138 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETENCODER, drm_mode_getencoder, DRM_MASTER|DRM_CONTROL_ALLOW),
139 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETCONNECTOR, drm_mode_getconnector, DRM_MASTER|DRM_CONTROL_ALLOW),
140 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ATTACHMODE, drm_mode_attachmode_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW),
141 DRM_IOCTL_DEF(DRM_IOCTL_MODE_DETACHMODE, drm_mode_detachmode_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW),
142 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPERTY, drm_mode_getproperty_ioctl, DRM_MASTER | DRM_CONTROL_ALLOW),
143 DRM_IOCTL_DEF(DRM_IOCTL_MODE_SETPROPERTY, drm_mode_connector_property_set_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW),
144 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETPROPBLOB, drm_mode_getblob_ioctl, DRM_MASTER|DRM_CONTROL_ALLOW),
145 DRM_IOCTL_DEF(DRM_IOCTL_MODE_GETFB, drm_mode_getfb, DRM_MASTER|DRM_CONTROL_ALLOW),
146 DRM_IOCTL_DEF(DRM_IOCTL_MODE_ADDFB, drm_mode_addfb, DRM_MASTER|DRM_CONTROL_ALLOW),
147 DRM_IOCTL_DEF(DRM_IOCTL_MODE_RMFB, drm_mode_rmfb, DRM_MASTER|DRM_CONTROL_ALLOW),
150 #define DRM_CORE_IOCTL_COUNT ARRAY_SIZE( drm_ioctls )
153 * Take down the DRM device.
155 * \param dev DRM device structure.
157 * Frees every resource in \p dev.
161 int drm_lastclose(struct drm_device * dev)
163 struct drm_vma_entry *vma, *vma_temp;
168 if (dev->driver->lastclose)
169 dev->driver->lastclose(dev);
170 DRM_DEBUG("driver lastclose completed\n");
172 if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
173 drm_irq_uninstall(dev);
175 mutex_lock(&dev->struct_mutex);
177 /* Free drawable information memory */
178 drm_drawable_free_all(dev);
179 del_timer(&dev->timer);
181 /* Clear AGP information */
182 if (drm_core_has_AGP(dev) && dev->agp &&
183 !drm_core_check_feature(dev, DRIVER_MODESET)) {
184 struct drm_agp_mem *entry, *tempe;
186 /* Remove AGP resources, but leave dev->agp
187 intact until drv_cleanup is called. */
188 list_for_each_entry_safe(entry, tempe, &dev->agp->memory, head) {
190 drm_unbind_agp(entry->memory);
191 drm_free_agp(entry->memory, entry->pages);
194 INIT_LIST_HEAD(&dev->agp->memory);
196 if (dev->agp->acquired)
197 drm_agp_release(dev);
199 dev->agp->acquired = 0;
200 dev->agp->enabled = 0;
202 if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg &&
203 !drm_core_check_feature(dev, DRIVER_MODESET)) {
204 drm_sg_cleanup(dev->sg);
208 /* Clear vma list (only built for debugging) */
209 list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
210 list_del(&vma->head);
214 if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE) && dev->queuelist) {
215 for (i = 0; i < dev->queue_count; i++) {
216 kfree(dev->queuelist[i]);
217 dev->queuelist[i] = NULL;
219 kfree(dev->queuelist);
220 dev->queuelist = NULL;
222 dev->queue_count = 0;
224 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA) &&
225 !drm_core_check_feature(dev, DRIVER_MODESET))
226 drm_dma_takedown(dev);
228 dev->dev_mapping = NULL;
229 mutex_unlock(&dev->struct_mutex);
231 DRM_DEBUG("lastclose completed\n");
236 * Module initialization. Called via init_module at module load time, or via
237 * linux/init/main.c (this is not currently supported).
239 * \return zero on success or a negative number on failure.
241 * Initializes an array of drm_device structures, and attempts to
242 * initialize all available devices, using consecutive minors, registering the
243 * stubs and initializing the AGP device.
245 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
246 * after the initialization for driver customization.
248 int drm_init(struct drm_driver *driver)
250 struct pci_dev *pdev = NULL;
251 const struct pci_device_id *pid;
256 INIT_LIST_HEAD(&driver->device_list);
258 if (driver->driver_features & DRIVER_MODESET)
259 return pci_register_driver(&driver->pci_driver);
261 /* If not using KMS, fall back to stealth mode manual scanning. */
262 for (i = 0; driver->pci_driver.id_table[i].vendor != 0; i++) {
263 pid = &driver->pci_driver.id_table[i];
265 /* Loop around setting up a DRM device for each PCI device
266 * matching our ID and device class. If we had the internal
267 * function that pci_get_subsys and pci_get_class used, we'd
268 * be able to just pass pid in instead of doing a two-stage
273 pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
274 pid->subdevice, pdev)) != NULL) {
275 if ((pdev->class & pid->class_mask) != pid->class)
278 /* stealth mode requires a manual probe */
280 drm_get_dev(pdev, pid, driver);
286 EXPORT_SYMBOL(drm_init);
288 void drm_exit(struct drm_driver *driver)
290 struct drm_device *dev, *tmp;
293 if (driver->driver_features & DRIVER_MODESET) {
294 pci_unregister_driver(&driver->pci_driver);
296 list_for_each_entry_safe(dev, tmp, &driver->device_list, driver_item)
300 DRM_INFO("Module unloaded\n");
303 EXPORT_SYMBOL(drm_exit);
305 /** File operations structure */
306 static const struct file_operations drm_stub_fops = {
307 .owner = THIS_MODULE,
308 .open = drm_stub_open
311 static int __init drm_core_init(void)
315 idr_init(&drm_minors_idr);
317 if (register_chrdev(DRM_MAJOR, "drm", &drm_stub_fops))
320 drm_class = drm_sysfs_create(THIS_MODULE, "drm");
321 if (IS_ERR(drm_class)) {
322 printk(KERN_ERR "DRM: Error creating drm class.\n");
323 ret = PTR_ERR(drm_class);
327 drm_proc_root = proc_mkdir("dri", NULL);
328 if (!drm_proc_root) {
329 DRM_ERROR("Cannot create /proc/dri\n");
334 drm_debugfs_root = debugfs_create_dir("dri", NULL);
335 if (!drm_debugfs_root) {
336 DRM_ERROR("Cannot create /sys/kernel/debug/dri\n");
341 DRM_INFO("Initialized %s %d.%d.%d %s\n",
342 CORE_NAME, CORE_MAJOR, CORE_MINOR, CORE_PATCHLEVEL, CORE_DATE);
347 unregister_chrdev(DRM_MAJOR, "drm");
349 idr_destroy(&drm_minors_idr);
354 static void __exit drm_core_exit(void)
356 remove_proc_entry("dri", NULL);
357 debugfs_remove(drm_debugfs_root);
360 unregister_chrdev(DRM_MAJOR, "drm");
362 idr_destroy(&drm_minors_idr);
365 module_init(drm_core_init);
366 module_exit(drm_core_exit);
369 * Get version information
371 * \param inode device inode.
372 * \param filp file pointer.
373 * \param cmd command.
374 * \param arg user argument, pointing to a drm_version structure.
375 * \return zero on success or negative number on failure.
377 * Fills in the version information in \p arg.
379 static int drm_version(struct drm_device *dev, void *data,
380 struct drm_file *file_priv)
382 struct drm_version *version = data;
385 version->version_major = dev->driver->major;
386 version->version_minor = dev->driver->minor;
387 version->version_patchlevel = dev->driver->patchlevel;
388 DRM_COPY(version->name, dev->driver->name);
389 DRM_COPY(version->date, dev->driver->date);
390 DRM_COPY(version->desc, dev->driver->desc);
396 * Called whenever a process performs an ioctl on /dev/drm.
398 * \param inode device inode.
399 * \param file_priv DRM file private.
400 * \param cmd command.
401 * \param arg user argument.
402 * \return zero on success or negative number on failure.
404 * Looks up the ioctl function in the ::ioctls table, checking for root
405 * previleges if so required, and dispatches to the respective function.
407 int drm_ioctl(struct inode *inode, struct file *filp,
408 unsigned int cmd, unsigned long arg)
410 struct drm_file *file_priv = filp->private_data;
411 struct drm_device *dev = file_priv->minor->dev;
412 struct drm_ioctl_desc *ioctl;
414 unsigned int nr = DRM_IOCTL_NR(cmd);
415 int retcode = -EINVAL;
416 char stack_kdata[128];
419 atomic_inc(&dev->ioctl_count);
420 atomic_inc(&dev->counts[_DRM_STAT_IOCTLS]);
421 ++file_priv->ioctl_count;
423 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
424 task_pid_nr(current), cmd, nr,
425 (long)old_encode_dev(file_priv->minor->device),
426 file_priv->authenticated);
428 if ((nr >= DRM_CORE_IOCTL_COUNT) &&
429 ((nr < DRM_COMMAND_BASE) || (nr >= DRM_COMMAND_END)))
431 if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_END) &&
432 (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls))
433 ioctl = &dev->driver->ioctls[nr - DRM_COMMAND_BASE];
434 else if ((nr >= DRM_COMMAND_END) || (nr < DRM_COMMAND_BASE)) {
435 ioctl = &drm_ioctls[nr];
440 /* Do not trust userspace, use our own definition */
442 /* is there a local override? */
443 if ((nr == DRM_IOCTL_NR(DRM_IOCTL_DMA)) && dev->driver->dma_ioctl)
444 func = dev->driver->dma_ioctl;
447 DRM_DEBUG("no function\n");
449 } else if (((ioctl->flags & DRM_ROOT_ONLY) && !capable(CAP_SYS_ADMIN)) ||
450 ((ioctl->flags & DRM_AUTH) && !file_priv->authenticated) ||
451 ((ioctl->flags & DRM_MASTER) && !file_priv->is_master) ||
452 (!(ioctl->flags & DRM_CONTROL_ALLOW) && (file_priv->minor->type == DRM_MINOR_CONTROL))) {
455 if (cmd & (IOC_IN | IOC_OUT)) {
456 if (_IOC_SIZE(cmd) <= sizeof(stack_kdata)) {
459 kdata = kmalloc(_IOC_SIZE(cmd), GFP_KERNEL);
468 if (copy_from_user(kdata, (void __user *)arg,
469 _IOC_SIZE(cmd)) != 0) {
474 retcode = func(dev, kdata, file_priv);
477 if (copy_to_user((void __user *)arg, kdata,
478 _IOC_SIZE(cmd)) != 0)
484 if (kdata != stack_kdata)
486 atomic_dec(&dev->ioctl_count);
488 DRM_DEBUG("ret = %x\n", retcode);
492 EXPORT_SYMBOL(drm_ioctl);
494 struct drm_local_map *drm_getsarea(struct drm_device *dev)
496 struct drm_map_list *entry;
498 list_for_each_entry(entry, &dev->maplist, head) {
499 if (entry->map && entry->map->type == _DRM_SHM &&
500 (entry->map->flags & _DRM_CONTAINS_LOCK)) {
506 EXPORT_SYMBOL(drm_getsarea);