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(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 /* Free drawable information memory */
155 for (i
= 0; i
< dev
->drw_bitfield_length
/ sizeof(*dev
->drw_bitfield
);
157 drm_drawable_info_t
*info
= drm_get_drawable_info(dev
, i
);
160 drm_free(info
->rects
, info
->num_rects
*
161 sizeof(drm_clip_rect_t
), DRM_MEM_BUFS
);
162 drm_free(info
, sizeof(*info
), DRM_MEM_BUFS
);
166 mutex_lock(&dev
->struct_mutex
);
167 del_timer(&dev
->timer
);
170 if (dev
->magicfree
.next
) {
171 list_for_each_entry_safe(pt
, next
, &dev
->magicfree
, head
) {
173 drm_ht_remove_item(&dev
->magiclist
, &pt
->hash_item
);
174 drm_free(pt
, sizeof(*pt
), DRM_MEM_MAGIC
);
176 drm_ht_remove(&dev
->magiclist
);
179 /* Clear AGP information */
180 if (drm_core_has_AGP(dev
) && dev
->agp
) {
181 drm_agp_mem_t
*entry
;
182 drm_agp_mem_t
*nexte
;
184 /* Remove AGP resources, but leave dev->agp
185 intact until drv_cleanup is called. */
186 for (entry
= dev
->agp
->memory
; entry
; entry
= nexte
) {
189 drm_unbind_agp(entry
->memory
);
190 drm_free_agp(entry
->memory
, entry
->pages
);
191 drm_free(entry
, sizeof(*entry
), DRM_MEM_AGPLISTS
);
193 dev
->agp
->memory
= NULL
;
195 if (dev
->agp
->acquired
)
196 drm_agp_release(dev
);
198 dev
->agp
->acquired
= 0;
199 dev
->agp
->enabled
= 0;
201 if (drm_core_check_feature(dev
, DRIVER_SG
) && dev
->sg
) {
202 drm_sg_cleanup(dev
->sg
);
206 /* Clear vma list (only built for debugging) */
208 for (vma
= dev
->vmalist
; vma
; vma
= vma_next
) {
209 vma_next
= vma
->next
;
210 drm_free(vma
, sizeof(*vma
), DRM_MEM_VMAS
);
216 while (!list_empty(&dev
->maplist
->head
)) {
217 struct list_head
*list
= dev
->maplist
->head
.next
;
218 r_list
= list_entry(list
, drm_map_list_t
, head
);
219 drm_rmmap_locked(dev
, r_list
->map
);
223 if (drm_core_check_feature(dev
, DRIVER_DMA_QUEUE
) && dev
->queuelist
) {
224 for (i
= 0; i
< dev
->queue_count
; i
++) {
225 if (dev
->queuelist
[i
]) {
226 drm_free(dev
->queuelist
[i
],
227 sizeof(*dev
->queuelist
[0]),
229 dev
->queuelist
[i
] = NULL
;
232 drm_free(dev
->queuelist
,
233 dev
->queue_slots
* sizeof(*dev
->queuelist
),
235 dev
->queuelist
= NULL
;
237 dev
->queue_count
= 0;
239 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
240 drm_dma_takedown(dev
);
242 if (dev
->lock
.hw_lock
) {
243 dev
->sigdata
.lock
= dev
->lock
.hw_lock
= NULL
; /* SHM removed */
244 dev
->lock
.filp
= NULL
;
245 wake_up_interruptible(&dev
->lock
.lock_queue
);
247 mutex_unlock(&dev
->struct_mutex
);
249 DRM_DEBUG("lastclose completed\n");
254 * Module initialization. Called via init_module at module load time, or via
255 * linux/init/main.c (this is not currently supported).
257 * \return zero on success or a negative number on failure.
259 * Initializes an array of drm_device structures, and attempts to
260 * initialize all available devices, using consecutive minors, registering the
261 * stubs and initializing the AGP device.
263 * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
264 * after the initialization for driver customization.
266 int drm_init(struct drm_driver
*driver
)
268 struct pci_dev
*pdev
= NULL
;
269 struct pci_device_id
*pid
;
276 for (i
= 0; driver
->pci_driver
.id_table
[i
].vendor
!= 0; i
++) {
277 pid
= (struct pci_device_id
*)&driver
->pci_driver
.id_table
[i
];
280 /* pass back in pdev to account for multiple identical cards */
282 pci_get_subsys(pid
->vendor
, pid
->device
, pid
->subvendor
,
283 pid
->subdevice
, pdev
)) != NULL
) {
284 /* stealth mode requires a manual probe */
286 drm_get_dev(pdev
, pid
, driver
);
292 EXPORT_SYMBOL(drm_init
);
295 * Called via cleanup_module() at module unload time.
297 * Cleans up all DRM device, calling drm_lastclose().
301 static void drm_cleanup(drm_device_t
* dev
)
306 DRM_ERROR("cleanup called no dev\n");
313 drm_free(dev
->maplist
, sizeof(*dev
->maplist
), DRM_MEM_MAPS
);
315 drm_ht_remove(&dev
->map_hash
);
318 drm_ctxbitmap_cleanup(dev
);
320 if (drm_core_has_MTRR(dev
) && drm_core_has_AGP(dev
) &&
321 dev
->agp
&& dev
->agp
->agp_mtrr
>= 0) {
323 retval
= mtrr_del(dev
->agp
->agp_mtrr
,
324 dev
->agp
->agp_info
.aper_base
,
325 dev
->agp
->agp_info
.aper_size
* 1024 * 1024);
326 DRM_DEBUG("mtrr_del=%d\n", retval
);
329 if (drm_core_has_AGP(dev
) && dev
->agp
) {
330 drm_free(dev
->agp
, sizeof(*dev
->agp
), DRM_MEM_AGPLISTS
);
334 if (dev
->driver
->unload
)
335 dev
->driver
->unload(dev
);
337 drm_put_head(&dev
->primary
);
338 if (drm_put_dev(dev
))
339 DRM_ERROR("Cannot unload module\n");
342 void drm_exit(struct drm_driver
*driver
)
345 drm_device_t
*dev
= NULL
;
350 for (i
= 0; i
< drm_cards_limit
; i
++) {
356 if (head
->dev
->driver
!= driver
)
360 /* release the pci driver */
362 pci_dev_put(dev
->pdev
);
366 DRM_INFO("Module unloaded\n");
369 EXPORT_SYMBOL(drm_exit
);
371 /** File operations structure */
372 static const struct file_operations drm_stub_fops
= {
373 .owner
= THIS_MODULE
,
374 .open
= drm_stub_open
377 static int __init
drm_core_init(void)
383 DRM_MAX_MINOR
+ 1 ? drm_cards_limit
: DRM_MAX_MINOR
+ 1);
385 drm_calloc(drm_cards_limit
, sizeof(*drm_heads
), DRM_MEM_STUB
);
389 if (register_chrdev(DRM_MAJOR
, "drm", &drm_stub_fops
))
392 drm_class
= drm_sysfs_create(THIS_MODULE
, "drm");
393 if (IS_ERR(drm_class
)) {
394 printk(KERN_ERR
"DRM: Error creating drm class.\n");
395 ret
= PTR_ERR(drm_class
);
399 drm_proc_root
= proc_mkdir("dri", NULL
);
400 if (!drm_proc_root
) {
401 DRM_ERROR("Cannot create /proc/dri\n");
406 DRM_INFO("Initialized %s %d.%d.%d %s\n",
407 CORE_NAME
, CORE_MAJOR
, CORE_MINOR
, CORE_PATCHLEVEL
, CORE_DATE
);
410 drm_sysfs_destroy(drm_class
);
412 unregister_chrdev(DRM_MAJOR
, "drm");
413 drm_free(drm_heads
, sizeof(*drm_heads
) * drm_cards_limit
, DRM_MEM_STUB
);
418 static void __exit
drm_core_exit(void)
420 remove_proc_entry("dri", NULL
);
421 drm_sysfs_destroy(drm_class
);
423 unregister_chrdev(DRM_MAJOR
, "drm");
425 drm_free(drm_heads
, sizeof(*drm_heads
) * drm_cards_limit
, DRM_MEM_STUB
);
428 module_init(drm_core_init
);
429 module_exit(drm_core_exit
);
432 * Get version information
434 * \param inode device inode.
435 * \param filp file pointer.
436 * \param cmd command.
437 * \param arg user argument, pointing to a drm_version structure.
438 * \return zero on success or negative number on failure.
440 * Fills in the version information in \p arg.
442 static int drm_version(struct inode
*inode
, struct file
*filp
,
443 unsigned int cmd
, unsigned long arg
)
445 drm_file_t
*priv
= filp
->private_data
;
446 drm_device_t
*dev
= priv
->head
->dev
;
447 drm_version_t __user
*argp
= (void __user
*)arg
;
448 drm_version_t version
;
451 if (copy_from_user(&version
, argp
, sizeof(version
)))
454 version
.version_major
= dev
->driver
->major
;
455 version
.version_minor
= dev
->driver
->minor
;
456 version
.version_patchlevel
= dev
->driver
->patchlevel
;
457 DRM_COPY(version
.name
, dev
->driver
->name
);
458 DRM_COPY(version
.date
, dev
->driver
->date
);
459 DRM_COPY(version
.desc
, dev
->driver
->desc
);
461 if (copy_to_user(argp
, &version
, sizeof(version
)))
467 * Called whenever a process performs an ioctl on /dev/drm.
469 * \param inode device inode.
470 * \param filp file pointer.
471 * \param cmd command.
472 * \param arg user argument.
473 * \return zero on success or negative number on failure.
475 * Looks up the ioctl function in the ::ioctls table, checking for root
476 * previleges if so required, and dispatches to the respective function.
478 int drm_ioctl(struct inode
*inode
, struct file
*filp
,
479 unsigned int cmd
, unsigned long arg
)
481 drm_file_t
*priv
= filp
->private_data
;
482 drm_device_t
*dev
= priv
->head
->dev
;
483 drm_ioctl_desc_t
*ioctl
;
485 unsigned int nr
= DRM_IOCTL_NR(cmd
);
486 int retcode
= -EINVAL
;
488 atomic_inc(&dev
->ioctl_count
);
489 atomic_inc(&dev
->counts
[_DRM_STAT_IOCTLS
]);
492 DRM_DEBUG("pid=%d, cmd=0x%02x, nr=0x%02x, dev 0x%lx, auth=%d\n",
493 current
->pid
, cmd
, nr
,
494 (long)old_encode_dev(priv
->head
->device
),
495 priv
->authenticated
);
497 if ((nr
>= DRM_CORE_IOCTL_COUNT
) &&
498 ((nr
< DRM_COMMAND_BASE
) || (nr
>= DRM_COMMAND_END
)))
500 if ((nr
>= DRM_COMMAND_BASE
) && (nr
< DRM_COMMAND_END
) &&
501 (nr
< DRM_COMMAND_BASE
+ dev
->driver
->num_ioctls
))
502 ioctl
= &dev
->driver
->ioctls
[nr
- DRM_COMMAND_BASE
];
503 else if ((nr
>= DRM_COMMAND_END
) || (nr
< DRM_COMMAND_BASE
))
504 ioctl
= &drm_ioctls
[nr
];
509 /* is there a local override? */
510 if ((nr
== DRM_IOCTL_NR(DRM_IOCTL_DMA
)) && dev
->driver
->dma_ioctl
)
511 func
= dev
->driver
->dma_ioctl
;
514 DRM_DEBUG("no function\n");
516 } else if (((ioctl
->flags
& DRM_ROOT_ONLY
) && !capable(CAP_SYS_ADMIN
)) ||
517 ((ioctl
->flags
& DRM_AUTH
) && !priv
->authenticated
) ||
518 ((ioctl
->flags
& DRM_MASTER
) && !priv
->master
)) {
521 retcode
= func(inode
, filp
, cmd
, arg
);
525 atomic_dec(&dev
->ioctl_count
);
527 DRM_DEBUG("ret = %x\n", retcode
);
531 EXPORT_SYMBOL(drm_ioctl
);