3 * File operations for DRM
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Daryll Strauss <daryll@valinux.com>
7 * \author Gareth Hughes <gareth@valinux.com>
11 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
13 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
14 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
15 * All Rights Reserved.
17 * Permission is hereby granted, free of charge, to any person obtaining a
18 * copy of this software and associated documentation files (the "Software"),
19 * to deal in the Software without restriction, including without limitation
20 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21 * and/or sell copies of the Software, and to permit persons to whom the
22 * Software is furnished to do so, subject to the following conditions:
24 * The above copyright notice and this permission notice (including the next
25 * paragraph) shall be included in all copies or substantial portions of the
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
31 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
32 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
33 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34 * OTHER DEALINGS IN THE SOFTWARE.
38 #include <linux/poll.h>
39 #include <linux/slab.h>
40 #include <linux/module.h>
42 /* from BKL pushdown: note that nothing else serializes idr_find() */
43 DEFINE_MUTEX(drm_global_mutex);
44 EXPORT_SYMBOL(drm_global_mutex);
46 static int drm_open_helper(struct inode *inode, struct file *filp,
47 struct drm_device * dev);
49 static int drm_setup(struct drm_device * dev)
53 if (dev->driver->firstopen &&
54 !drm_core_check_feature(dev, DRIVER_MODESET)) {
55 ret = dev->driver->firstopen(dev);
60 ret = drm_legacy_dma_setup(dev);
72 * \param inode device inode
73 * \param filp file pointer.
74 * \return zero on success or a negative number on failure.
76 * Searches the DRM device with the same minor number, calls open_helper(), and
77 * increments the device open count. If the open count was previous at zero,
78 * i.e., it's the first that the device is open, then calls setup().
80 int drm_open(struct inode *inode, struct file *filp)
82 struct drm_device *dev;
83 struct drm_minor *minor;
87 minor = drm_minor_acquire(iminor(inode));
89 return PTR_ERR(minor);
92 if (drm_device_is_unplugged(dev)) {
97 if (!dev->open_count++)
100 /* share address_space across all char-devs of a single device */
101 filp->f_mapping = dev->anon_inode->i_mapping;
103 retcode = drm_open_helper(inode, filp, dev);
107 retcode = drm_setup(dev);
116 drm_minor_release(minor);
119 EXPORT_SYMBOL(drm_open);
122 * File \c open operation.
124 * \param inode device inode.
125 * \param filp file pointer.
127 * Puts the dev->fops corresponding to the device minor number into
128 * \p filp, call the \c open method, and restore the file operations.
130 int drm_stub_open(struct inode *inode, struct file *filp)
132 struct drm_device *dev;
133 struct drm_minor *minor;
135 const struct file_operations *new_fops;
139 mutex_lock(&drm_global_mutex);
140 minor = drm_minor_acquire(iminor(inode));
145 if (drm_device_is_unplugged(dev))
148 new_fops = fops_get(dev->driver->fops);
152 replace_fops(filp, new_fops);
153 if (filp->f_op->open)
154 err = filp->f_op->open(inode, filp);
157 drm_minor_release(minor);
159 mutex_unlock(&drm_global_mutex);
164 * Check whether DRI will run on this CPU.
166 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
168 static int drm_cpu_valid(void)
170 #if defined(__i386__)
171 if (boot_cpu_data.x86 == 3)
172 return 0; /* No cmpxchg on a 386 */
174 #if defined(__sparc__) && !defined(__sparc_v9__)
175 return 0; /* No cmpxchg before v9 sparc. */
181 * Called whenever a process opens /dev/drm.
183 * \param inode device inode.
184 * \param filp file pointer.
186 * \return zero on success or a negative number on failure.
188 * Creates and initializes a drm_file structure for the file private data in \p
189 * filp and add it into the double linked list in \p dev.
191 static int drm_open_helper(struct inode *inode, struct file *filp,
192 struct drm_device * dev)
194 int minor_id = iminor(inode);
195 struct drm_file *priv;
198 if (filp->f_flags & O_EXCL)
199 return -EBUSY; /* No exclusive opens */
200 if (!drm_cpu_valid())
202 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
205 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor_id);
207 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
211 filp->private_data = priv;
213 priv->uid = current_euid();
214 priv->pid = get_pid(task_pid(current));
215 priv->minor = idr_find(&drm_minors_idr, minor_id);
221 /* for compatibility root is always authenticated */
222 priv->always_authenticated = capable(CAP_SYS_ADMIN);
223 priv->authenticated = priv->always_authenticated;
224 priv->lock_count = 0;
226 INIT_LIST_HEAD(&priv->lhead);
227 INIT_LIST_HEAD(&priv->fbs);
228 mutex_init(&priv->fbs_lock);
229 INIT_LIST_HEAD(&priv->event_list);
230 init_waitqueue_head(&priv->event_wait);
231 priv->event_space = 4096; /* set aside 4k for event buffer */
233 if (dev->driver->driver_features & DRIVER_GEM)
234 drm_gem_open(dev, priv);
236 if (drm_core_check_feature(dev, DRIVER_PRIME))
237 drm_prime_init_file_private(&priv->prime);
239 if (dev->driver->open) {
240 ret = dev->driver->open(dev, priv);
242 goto out_prime_destroy;
245 /* if there is no current master make this fd it, but do not create
246 * any master object for render clients */
247 mutex_lock(&dev->struct_mutex);
248 if (!priv->minor->master && !drm_is_render_client(priv)) {
249 /* create a new master */
250 priv->minor->master = drm_master_create(priv->minor);
251 if (!priv->minor->master) {
252 mutex_unlock(&dev->struct_mutex);
258 /* take another reference for the copy in the local file priv */
259 priv->master = drm_master_get(priv->minor->master);
261 priv->authenticated = 1;
263 mutex_unlock(&dev->struct_mutex);
264 if (dev->driver->master_create) {
265 ret = dev->driver->master_create(dev, priv->master);
267 mutex_lock(&dev->struct_mutex);
268 /* drop both references if this fails */
269 drm_master_put(&priv->minor->master);
270 drm_master_put(&priv->master);
271 mutex_unlock(&dev->struct_mutex);
275 mutex_lock(&dev->struct_mutex);
276 if (dev->driver->master_set) {
277 ret = dev->driver->master_set(dev, priv, true);
279 /* drop both references if this fails */
280 drm_master_put(&priv->minor->master);
281 drm_master_put(&priv->master);
282 mutex_unlock(&dev->struct_mutex);
286 } else if (!drm_is_render_client(priv)) {
287 /* get a reference to the master */
288 priv->master = drm_master_get(priv->minor->master);
290 mutex_unlock(&dev->struct_mutex);
292 mutex_lock(&dev->struct_mutex);
293 list_add(&priv->lhead, &dev->filelist);
294 mutex_unlock(&dev->struct_mutex);
301 struct pci_dev *pci_dev;
302 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
304 dev->hose = pci_dev->sysdata;
305 pci_dev_put(pci_dev);
308 struct pci_bus *b = pci_bus_b(pci_root_buses.next);
310 dev->hose = b->sysdata;
318 if (dev->driver->postclose)
319 dev->driver->postclose(dev, priv);
321 if (drm_core_check_feature(dev, DRIVER_PRIME))
322 drm_prime_destroy_file_private(&priv->prime);
323 if (dev->driver->driver_features & DRIVER_GEM)
324 drm_gem_release(dev, priv);
328 filp->private_data = NULL;
332 static void drm_master_release(struct drm_device *dev, struct file *filp)
334 struct drm_file *file_priv = filp->private_data;
336 if (drm_i_have_hw_lock(dev, file_priv)) {
337 DRM_DEBUG("File %p released, freeing lock for context %d\n",
338 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
339 drm_lock_free(&file_priv->master->lock,
340 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
344 static void drm_events_release(struct drm_file *file_priv)
346 struct drm_device *dev = file_priv->minor->dev;
347 struct drm_pending_event *e, *et;
348 struct drm_pending_vblank_event *v, *vt;
351 spin_lock_irqsave(&dev->event_lock, flags);
353 /* Remove pending flips */
354 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
355 if (v->base.file_priv == file_priv) {
356 list_del(&v->base.link);
357 drm_vblank_put(dev, v->pipe);
358 v->base.destroy(&v->base);
361 /* Remove unconsumed events */
362 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
367 spin_unlock_irqrestore(&dev->event_lock, flags);
371 * drm_legacy_dev_reinit
373 * Reinitializes a legacy/ums drm device in it's lastclose function.
375 static void drm_legacy_dev_reinit(struct drm_device *dev)
377 if (drm_core_check_feature(dev, DRIVER_MODESET))
380 dev->sigdata.lock = NULL;
382 dev->context_flag = 0;
383 dev->last_context = 0;
388 * Take down the DRM device.
390 * \param dev DRM device structure.
392 * Frees every resource in \p dev.
396 int drm_lastclose(struct drm_device * dev)
398 struct drm_vma_entry *vma, *vma_temp;
402 if (dev->driver->lastclose)
403 dev->driver->lastclose(dev);
404 DRM_DEBUG("driver lastclose completed\n");
406 if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
407 drm_irq_uninstall(dev);
409 mutex_lock(&dev->struct_mutex);
413 drm_legacy_sg_cleanup(dev);
415 /* Clear vma list (only built for debugging) */
416 list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
417 list_del(&vma->head);
421 drm_legacy_dma_takedown(dev);
423 mutex_unlock(&dev->struct_mutex);
425 drm_legacy_dev_reinit(dev);
427 DRM_DEBUG("lastclose completed\n");
434 * \param inode device inode
435 * \param file_priv DRM file private.
436 * \return zero on success or a negative number on failure.
438 * If the hardware lock is held then free it, and take it again for the kernel
439 * context since it's necessary to reclaim buffers. Unlink the file private
440 * data from its list and free it. Decreases the open count and if it reaches
441 * zero calls drm_lastclose().
443 int drm_release(struct inode *inode, struct file *filp)
445 struct drm_file *file_priv = filp->private_data;
446 struct drm_minor *minor = file_priv->minor;
447 struct drm_device *dev = minor->dev;
450 mutex_lock(&drm_global_mutex);
452 DRM_DEBUG("open_count = %d\n", dev->open_count);
454 if (dev->driver->preclose)
455 dev->driver->preclose(dev, file_priv);
457 /* ========================================================
458 * Begin inline drm_release
461 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
462 task_pid_nr(current),
463 (long)old_encode_dev(file_priv->minor->device),
466 /* Release any auth tokens that might point to this file_priv,
467 (do that under the drm_global_mutex) */
468 if (file_priv->magic)
469 (void) drm_remove_magic(file_priv->master, file_priv->magic);
471 /* if the master has gone away we can't do anything with the lock */
472 if (file_priv->minor->master)
473 drm_master_release(dev, filp);
475 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
476 drm_core_reclaim_buffers(dev, file_priv);
478 drm_events_release(file_priv);
480 if (dev->driver->driver_features & DRIVER_MODESET)
481 drm_fb_release(file_priv);
483 if (dev->driver->driver_features & DRIVER_GEM)
484 drm_gem_release(dev, file_priv);
486 mutex_lock(&dev->ctxlist_mutex);
487 if (!list_empty(&dev->ctxlist)) {
488 struct drm_ctx_list *pos, *n;
490 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
491 if (pos->tag == file_priv &&
492 pos->handle != DRM_KERNEL_CONTEXT) {
493 if (dev->driver->context_dtor)
494 dev->driver->context_dtor(dev,
497 drm_ctxbitmap_free(dev, pos->handle);
499 list_del(&pos->head);
504 mutex_unlock(&dev->ctxlist_mutex);
506 mutex_lock(&dev->struct_mutex);
508 if (file_priv->is_master) {
509 struct drm_master *master = file_priv->master;
510 struct drm_file *temp;
511 list_for_each_entry(temp, &dev->filelist, lhead) {
512 if ((temp->master == file_priv->master) &&
514 temp->authenticated = temp->always_authenticated;
518 * Since the master is disappearing, so is the
519 * possibility to lock.
522 if (master->lock.hw_lock) {
523 if (dev->sigdata.lock == master->lock.hw_lock)
524 dev->sigdata.lock = NULL;
525 master->lock.hw_lock = NULL;
526 master->lock.file_priv = NULL;
527 wake_up_interruptible_all(&master->lock.lock_queue);
530 if (file_priv->minor->master == file_priv->master) {
531 /* drop the reference held my the minor */
532 if (dev->driver->master_drop)
533 dev->driver->master_drop(dev, file_priv, true);
534 drm_master_put(&file_priv->minor->master);
538 /* drop the reference held my the file priv */
539 if (file_priv->master)
540 drm_master_put(&file_priv->master);
541 file_priv->is_master = 0;
542 list_del(&file_priv->lhead);
543 mutex_unlock(&dev->struct_mutex);
545 if (dev->driver->postclose)
546 dev->driver->postclose(dev, file_priv);
549 if (drm_core_check_feature(dev, DRIVER_PRIME))
550 drm_prime_destroy_file_private(&file_priv->prime);
552 put_pid(file_priv->pid);
555 /* ========================================================
556 * End inline drm_release
559 if (!--dev->open_count) {
560 retcode = drm_lastclose(dev);
561 if (drm_device_is_unplugged(dev))
564 mutex_unlock(&drm_global_mutex);
566 drm_minor_release(minor);
570 EXPORT_SYMBOL(drm_release);
573 drm_dequeue_event(struct drm_file *file_priv,
574 size_t total, size_t max, struct drm_pending_event **out)
576 struct drm_device *dev = file_priv->minor->dev;
577 struct drm_pending_event *e;
581 spin_lock_irqsave(&dev->event_lock, flags);
584 if (list_empty(&file_priv->event_list))
586 e = list_first_entry(&file_priv->event_list,
587 struct drm_pending_event, link);
588 if (e->event->length + total > max)
591 file_priv->event_space += e->event->length;
597 spin_unlock_irqrestore(&dev->event_lock, flags);
601 ssize_t drm_read(struct file *filp, char __user *buffer,
602 size_t count, loff_t *offset)
604 struct drm_file *file_priv = filp->private_data;
605 struct drm_pending_event *e;
609 ret = wait_event_interruptible(file_priv->event_wait,
610 !list_empty(&file_priv->event_list));
615 while (drm_dequeue_event(file_priv, total, count, &e)) {
616 if (copy_to_user(buffer + total,
617 e->event, e->event->length)) {
622 total += e->event->length;
628 EXPORT_SYMBOL(drm_read);
630 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
632 struct drm_file *file_priv = filp->private_data;
633 unsigned int mask = 0;
635 poll_wait(filp, &file_priv->event_wait, wait);
637 if (!list_empty(&file_priv->event_list))
638 mask |= POLLIN | POLLRDNORM;
642 EXPORT_SYMBOL(drm_poll);