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_MODESET_CTL
, drm_modeset_ctl
, 0),
121 DRM_IOCTL_DEF(DRM_IOCTL_UPDATE_DRAW
, drm_update_drawable_info
, DRM_AUTH
|DRM_MASTER
|DRM_ROOT_ONLY
),
123 DRM_IOCTL_DEF(DRM_IOCTL_GEM_CLOSE
, drm_gem_close_ioctl
, 0),
124 DRM_IOCTL_DEF(DRM_IOCTL_GEM_FLINK
, drm_gem_flink_ioctl
, DRM_AUTH
),
125 DRM_IOCTL_DEF(DRM_IOCTL_GEM_OPEN
, drm_gem_open_ioctl
, DRM_AUTH
),
128 #define DRM_CORE_IOCTL_COUNT ARRAY_SIZE( drm_ioctls )
131 * Take down the DRM device.
133 * \param dev DRM device structure.
135 * Frees every resource in \p dev.
139 int drm_lastclose(struct drm_device
* dev
)
141 struct drm_magic_entry
*pt
, *next
;
142 struct drm_map_list
*r_list
, *list_t
;
143 struct drm_vma_entry
*vma
, *vma_temp
;
148 if (dev
->driver
->lastclose
)
149 dev
->driver
->lastclose(dev
);
150 DRM_DEBUG("driver lastclose completed\n");
153 drm_free(dev
->unique
, strlen(dev
->unique
) + 1, DRM_MEM_DRIVER
);
158 if (dev
->irq_enabled
)
159 drm_irq_uninstall(dev
);
161 mutex_lock(&dev
->struct_mutex
);
163 /* Free drawable information memory */
164 drm_drawable_free_all(dev
);
165 del_timer(&dev
->timer
);
168 if (dev
->magicfree
.next
) {
169 list_for_each_entry_safe(pt
, next
, &dev
->magicfree
, head
) {
171 drm_ht_remove_item(&dev
->magiclist
, &pt
->hash_item
);
172 drm_free(pt
, sizeof(*pt
), DRM_MEM_MAGIC
);
174 drm_ht_remove(&dev
->magiclist
);
177 /* Clear AGP information */
178 if (drm_core_has_AGP(dev
) && dev
->agp
) {
179 struct drm_agp_mem
*entry
, *tempe
;
181 /* Remove AGP resources, but leave dev->agp
182 intact until drv_cleanup is called. */
183 list_for_each_entry_safe(entry
, tempe
, &dev
->agp
->memory
, head
) {
185 drm_unbind_agp(entry
->memory
);
186 drm_free_agp(entry
->memory
, entry
->pages
);
187 drm_free(entry
, sizeof(*entry
), DRM_MEM_AGPLISTS
);
189 INIT_LIST_HEAD(&dev
->agp
->memory
);
191 if (dev
->agp
->acquired
)
192 drm_agp_release(dev
);
194 dev
->agp
->acquired
= 0;
195 dev
->agp
->enabled
= 0;
197 if (drm_core_check_feature(dev
, DRIVER_SG
) && dev
->sg
) {
198 drm_sg_cleanup(dev
->sg
);
202 /* Clear vma list (only built for debugging) */
203 list_for_each_entry_safe(vma
, vma_temp
, &dev
->vmalist
, head
) {
204 list_del(&vma
->head
);
205 drm_free(vma
, sizeof(*vma
), DRM_MEM_VMAS
);
208 list_for_each_entry_safe(r_list
, list_t
, &dev
->maplist
, head
) {
209 if (!(r_list
->map
->flags
& _DRM_DRIVER
)) {
210 drm_rmmap_locked(dev
, r_list
->map
);
215 if (drm_core_check_feature(dev
, DRIVER_DMA_QUEUE
) && dev
->queuelist
) {
216 for (i
= 0; i
< dev
->queue_count
; i
++) {
217 if (dev
->queuelist
[i
]) {
218 drm_free(dev
->queuelist
[i
],
219 sizeof(*dev
->queuelist
[0]),
221 dev
->queuelist
[i
] = NULL
;
224 drm_free(dev
->queuelist
,
225 dev
->queue_slots
* sizeof(*dev
->queuelist
),
227 dev
->queuelist
= NULL
;
229 dev
->queue_count
= 0;
231 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
232 drm_dma_takedown(dev
);
234 if (dev
->lock
.hw_lock
) {
235 dev
->sigdata
.lock
= dev
->lock
.hw_lock
= NULL
; /* SHM removed */
236 dev
->lock
.file_priv
= NULL
;
237 wake_up_interruptible(&dev
->lock
.lock_queue
);
239 mutex_unlock(&dev
->struct_mutex
);
241 DRM_DEBUG("lastclose completed\n");
246 * Module initialization. Called via init_module at module load time, or via
247 * linux/init/main.c (this is not currently supported).
249 * \return zero on success or a negative number on failure.
251 * Initializes an array of drm_device structures, and attempts to
252 * initialize all available devices, using consecutive minors, registering the
253 * stubs and initializing the AGP device.
255 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
256 * after the initialization for driver customization.
258 int drm_init(struct drm_driver
*driver
)
260 struct pci_dev
*pdev
= NULL
;
261 struct pci_device_id
*pid
;
266 for (i
= 0; driver
->pci_driver
.id_table
[i
].vendor
!= 0; i
++) {
267 pid
= (struct pci_device_id
*)&driver
->pci_driver
.id_table
[i
];
269 /* Loop around setting up a DRM device for each PCI device
270 * matching our ID and device class. If we had the internal
271 * function that pci_get_subsys and pci_get_class used, we'd
272 * be able to just pass pid in instead of doing a two-stage
277 pci_get_subsys(pid
->vendor
, pid
->device
, pid
->subvendor
,
278 pid
->subdevice
, pdev
)) != NULL
) {
279 if ((pdev
->class & pid
->class_mask
) != pid
->class)
282 /* stealth mode requires a manual probe */
284 drm_get_dev(pdev
, pid
, driver
);
290 EXPORT_SYMBOL(drm_init
);
293 * Called via cleanup_module() at module unload time.
295 * Cleans up all DRM device, calling drm_lastclose().
299 static void drm_cleanup(struct drm_device
* dev
)
304 DRM_ERROR("cleanup called no dev\n");
310 if (drm_core_has_MTRR(dev
) && drm_core_has_AGP(dev
) &&
311 dev
->agp
&& dev
->agp
->agp_mtrr
>= 0) {
313 retval
= mtrr_del(dev
->agp
->agp_mtrr
,
314 dev
->agp
->agp_info
.aper_base
,
315 dev
->agp
->agp_info
.aper_size
* 1024 * 1024);
316 DRM_DEBUG("mtrr_del=%d\n", retval
);
319 if (drm_core_has_AGP(dev
) && dev
->agp
) {
320 drm_free(dev
->agp
, sizeof(*dev
->agp
), DRM_MEM_AGPLISTS
);
324 if (dev
->driver
->unload
)
325 dev
->driver
->unload(dev
);
327 drm_ht_remove(&dev
->map_hash
);
328 drm_ctxbitmap_cleanup(dev
);
330 drm_put_minor(&dev
->primary
);
331 if (drm_put_dev(dev
))
332 DRM_ERROR("Cannot unload module\n");
335 static int drm_minors_cleanup(int id
, void *ptr
, void *data
)
337 struct drm_minor
*minor
= ptr
;
338 struct drm_device
*dev
;
339 struct drm_driver
*driver
= data
;
342 if (minor
->dev
->driver
!= driver
)
345 if (minor
->type
!= DRM_MINOR_LEGACY
)
349 pci_dev_put(dev
->pdev
);
354 void drm_exit(struct drm_driver
*driver
)
358 idr_for_each(&drm_minors_idr
, &drm_minors_cleanup
, driver
);
360 DRM_INFO("Module unloaded\n");
363 EXPORT_SYMBOL(drm_exit
);
365 /** File operations structure */
366 static const struct file_operations drm_stub_fops
= {
367 .owner
= THIS_MODULE
,
368 .open
= drm_stub_open
371 static int __init
drm_core_init(void)
375 idr_init(&drm_minors_idr
);
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");
396 DRM_INFO("Initialized %s %d.%d.%d %s\n",
397 CORE_NAME
, CORE_MAJOR
, CORE_MINOR
, CORE_PATCHLEVEL
, CORE_DATE
);
402 unregister_chrdev(DRM_MAJOR
, "drm");
404 idr_destroy(&drm_minors_idr
);
409 static void __exit
drm_core_exit(void)
411 remove_proc_entry("dri", NULL
);
414 unregister_chrdev(DRM_MAJOR
, "drm");
416 idr_destroy(&drm_minors_idr
);
419 module_init(drm_core_init
);
420 module_exit(drm_core_exit
);
423 * Get version information
425 * \param inode device inode.
426 * \param filp file pointer.
427 * \param cmd command.
428 * \param arg user argument, pointing to a drm_version structure.
429 * \return zero on success or negative number on failure.
431 * Fills in the version information in \p arg.
433 static int drm_version(struct drm_device
*dev
, void *data
,
434 struct drm_file
*file_priv
)
436 struct drm_version
*version
= data
;
439 version
->version_major
= dev
->driver
->major
;
440 version
->version_minor
= dev
->driver
->minor
;
441 version
->version_patchlevel
= dev
->driver
->patchlevel
;
442 DRM_COPY(version
->name
, dev
->driver
->name
);
443 DRM_COPY(version
->date
, dev
->driver
->date
);
444 DRM_COPY(version
->desc
, dev
->driver
->desc
);
450 * Called whenever a process performs an ioctl on /dev/drm.
452 * \param inode device inode.
453 * \param file_priv DRM file private.
454 * \param cmd command.
455 * \param arg user argument.
456 * \return zero on success or negative number on failure.
458 * Looks up the ioctl function in the ::ioctls table, checking for root
459 * previleges if so required, and dispatches to the respective function.
461 int drm_ioctl(struct inode
*inode
, struct file
*filp
,
462 unsigned int cmd
, unsigned long arg
)
464 struct drm_file
*file_priv
= filp
->private_data
;
465 struct drm_device
*dev
= file_priv
->minor
->dev
;
466 struct drm_ioctl_desc
*ioctl
;
468 unsigned int nr
= DRM_IOCTL_NR(cmd
);
469 int retcode
= -EINVAL
;
472 atomic_inc(&dev
->ioctl_count
);
473 atomic_inc(&dev
->counts
[_DRM_STAT_IOCTLS
]);
474 ++file_priv
->ioctl_count
;
476 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
477 task_pid_nr(current
), cmd
, nr
,
478 (long)old_encode_dev(file_priv
->minor
->device
),
479 file_priv
->authenticated
);
481 if ((nr
>= DRM_CORE_IOCTL_COUNT
) &&
482 ((nr
< DRM_COMMAND_BASE
) || (nr
>= DRM_COMMAND_END
)))
484 if ((nr
>= DRM_COMMAND_BASE
) && (nr
< DRM_COMMAND_END
) &&
485 (nr
< DRM_COMMAND_BASE
+ dev
->driver
->num_ioctls
))
486 ioctl
= &dev
->driver
->ioctls
[nr
- DRM_COMMAND_BASE
];
487 else if ((nr
>= DRM_COMMAND_END
) || (nr
< DRM_COMMAND_BASE
)) {
488 ioctl
= &drm_ioctls
[nr
];
493 /* Do not trust userspace, use our own definition */
495 /* is there a local override? */
496 if ((nr
== DRM_IOCTL_NR(DRM_IOCTL_DMA
)) && dev
->driver
->dma_ioctl
)
497 func
= dev
->driver
->dma_ioctl
;
500 DRM_DEBUG("no function\n");
502 } else if (((ioctl
->flags
& DRM_ROOT_ONLY
) && !capable(CAP_SYS_ADMIN
)) ||
503 ((ioctl
->flags
& DRM_AUTH
) && !file_priv
->authenticated
) ||
504 ((ioctl
->flags
& DRM_MASTER
) && !file_priv
->master
)) {
507 if (cmd
& (IOC_IN
| IOC_OUT
)) {
508 kdata
= kmalloc(_IOC_SIZE(cmd
), GFP_KERNEL
);
516 if (copy_from_user(kdata
, (void __user
*)arg
,
517 _IOC_SIZE(cmd
)) != 0) {
522 retcode
= func(dev
, kdata
, file_priv
);
524 if ((retcode
== 0) && (cmd
& IOC_OUT
)) {
525 if (copy_to_user((void __user
*)arg
, kdata
,
526 _IOC_SIZE(cmd
)) != 0)
534 atomic_dec(&dev
->ioctl_count
);
536 DRM_DEBUG("ret = %x\n", retcode
);
540 EXPORT_SYMBOL(drm_ioctl
);
542 drm_local_map_t
*drm_getsarea(struct drm_device
*dev
)
544 struct drm_map_list
*entry
;
546 list_for_each_entry(entry
, &dev
->maplist
, head
) {
547 if (entry
->map
&& entry
->map
->type
== _DRM_SHM
&&
548 (entry
->map
->flags
& _DRM_CONTAINS_LOCK
)) {
554 EXPORT_SYMBOL(drm_getsarea
);