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 */
43 DEFINE_MUTEX(drm_global_mutex);
44 EXPORT_SYMBOL(drm_global_mutex);
46 static int drm_open_helper(struct file *filp, struct drm_minor *minor);
48 static int drm_setup(struct drm_device * dev)
52 if (dev->driver->firstopen &&
53 !drm_core_check_feature(dev, DRIVER_MODESET)) {
54 ret = dev->driver->firstopen(dev);
59 ret = drm_legacy_dma_setup(dev);
71 * \param inode device inode
72 * \param filp file pointer.
73 * \return zero on success or a negative number on failure.
75 * Searches the DRM device with the same minor number, calls open_helper(), and
76 * increments the device open count. If the open count was previous at zero,
77 * i.e., it's the first that the device is open, then calls setup().
79 int drm_open(struct inode *inode, struct file *filp)
81 struct drm_device *dev;
82 struct drm_minor *minor;
86 minor = drm_minor_acquire(iminor(inode));
88 return PTR_ERR(minor);
91 if (!dev->open_count++)
94 /* share address_space across all char-devs of a single device */
95 filp->f_mapping = dev->anon_inode->i_mapping;
97 retcode = drm_open_helper(filp, minor);
101 retcode = drm_setup(dev);
109 drm_minor_release(minor);
112 EXPORT_SYMBOL(drm_open);
115 * File \c open operation.
117 * \param inode device inode.
118 * \param filp file pointer.
120 * Puts the dev->fops corresponding to the device minor number into
121 * \p filp, call the \c open method, and restore the file operations.
123 int drm_stub_open(struct inode *inode, struct file *filp)
125 struct drm_device *dev;
126 struct drm_minor *minor;
128 const struct file_operations *new_fops;
132 mutex_lock(&drm_global_mutex);
133 minor = drm_minor_acquire(iminor(inode));
138 new_fops = fops_get(dev->driver->fops);
142 replace_fops(filp, new_fops);
143 if (filp->f_op->open)
144 err = filp->f_op->open(inode, filp);
147 drm_minor_release(minor);
149 mutex_unlock(&drm_global_mutex);
154 * Check whether DRI will run on this CPU.
156 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
158 static int drm_cpu_valid(void)
160 #if defined(__sparc__) && !defined(__sparc_v9__)
161 return 0; /* No cmpxchg before v9 sparc. */
167 * Called whenever a process opens /dev/drm.
169 * \param filp file pointer.
170 * \param minor acquired minor-object.
171 * \return zero on success or a negative number on failure.
173 * Creates and initializes a drm_file structure for the file private data in \p
174 * filp and add it into the double linked list in \p dev.
176 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
178 struct drm_device *dev = minor->dev;
179 struct drm_file *priv;
182 if (filp->f_flags & O_EXCL)
183 return -EBUSY; /* No exclusive opens */
184 if (!drm_cpu_valid())
186 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
189 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
191 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
195 filp->private_data = priv;
197 priv->uid = current_euid();
198 priv->pid = get_pid(task_pid(current));
201 /* for compatibility root is always authenticated */
202 priv->always_authenticated = capable(CAP_SYS_ADMIN);
203 priv->authenticated = priv->always_authenticated;
204 priv->lock_count = 0;
206 INIT_LIST_HEAD(&priv->lhead);
207 INIT_LIST_HEAD(&priv->fbs);
208 mutex_init(&priv->fbs_lock);
209 INIT_LIST_HEAD(&priv->event_list);
210 init_waitqueue_head(&priv->event_wait);
211 priv->event_space = 4096; /* set aside 4k for event buffer */
213 if (dev->driver->driver_features & DRIVER_GEM)
214 drm_gem_open(dev, priv);
216 if (drm_core_check_feature(dev, DRIVER_PRIME))
217 drm_prime_init_file_private(&priv->prime);
219 if (dev->driver->open) {
220 ret = dev->driver->open(dev, priv);
222 goto out_prime_destroy;
225 /* if there is no current master make this fd it, but do not create
226 * any master object for render clients */
227 mutex_lock(&dev->master_mutex);
228 if (drm_is_primary_client(priv) && !priv->minor->master) {
229 /* create a new master */
230 priv->minor->master = drm_master_create(priv->minor);
231 if (!priv->minor->master) {
237 /* take another reference for the copy in the local file priv */
238 priv->master = drm_master_get(priv->minor->master);
239 priv->authenticated = 1;
241 if (dev->driver->master_create) {
242 ret = dev->driver->master_create(dev, priv->master);
244 /* drop both references if this fails */
245 drm_master_put(&priv->minor->master);
246 drm_master_put(&priv->master);
250 if (dev->driver->master_set) {
251 ret = dev->driver->master_set(dev, priv, true);
253 /* drop both references if this fails */
254 drm_master_put(&priv->minor->master);
255 drm_master_put(&priv->master);
259 } else if (drm_is_primary_client(priv)) {
260 /* get a reference to the master */
261 priv->master = drm_master_get(priv->minor->master);
263 mutex_unlock(&dev->master_mutex);
265 mutex_lock(&dev->struct_mutex);
266 list_add(&priv->lhead, &dev->filelist);
267 mutex_unlock(&dev->struct_mutex);
274 struct pci_dev *pci_dev;
275 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
277 dev->hose = pci_dev->sysdata;
278 pci_dev_put(pci_dev);
281 struct pci_bus *b = list_entry(pci_root_buses.next,
282 struct pci_bus, node);
284 dev->hose = b->sysdata;
292 mutex_unlock(&dev->master_mutex);
293 if (dev->driver->postclose)
294 dev->driver->postclose(dev, priv);
296 if (drm_core_check_feature(dev, DRIVER_PRIME))
297 drm_prime_destroy_file_private(&priv->prime);
298 if (dev->driver->driver_features & DRIVER_GEM)
299 drm_gem_release(dev, priv);
302 filp->private_data = NULL;
306 static void drm_master_release(struct drm_device *dev, struct file *filp)
308 struct drm_file *file_priv = filp->private_data;
310 if (drm_i_have_hw_lock(dev, file_priv)) {
311 DRM_DEBUG("File %p released, freeing lock for context %d\n",
312 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
313 drm_lock_free(&file_priv->master->lock,
314 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
318 static void drm_events_release(struct drm_file *file_priv)
320 struct drm_device *dev = file_priv->minor->dev;
321 struct drm_pending_event *e, *et;
322 struct drm_pending_vblank_event *v, *vt;
325 spin_lock_irqsave(&dev->event_lock, flags);
327 /* Remove pending flips */
328 list_for_each_entry_safe(v, vt, &dev->vblank_event_list, base.link)
329 if (v->base.file_priv == file_priv) {
330 list_del(&v->base.link);
331 drm_vblank_put(dev, v->pipe);
332 v->base.destroy(&v->base);
335 /* Remove unconsumed events */
336 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
341 spin_unlock_irqrestore(&dev->event_lock, flags);
345 * drm_legacy_dev_reinit
347 * Reinitializes a legacy/ums drm device in it's lastclose function.
349 static void drm_legacy_dev_reinit(struct drm_device *dev)
351 if (drm_core_check_feature(dev, DRIVER_MODESET))
354 dev->sigdata.lock = NULL;
356 dev->context_flag = 0;
357 dev->last_context = 0;
362 * Take down the DRM device.
364 * \param dev DRM device structure.
366 * Frees every resource in \p dev.
370 int drm_lastclose(struct drm_device * dev)
372 struct drm_vma_entry *vma, *vma_temp;
376 if (dev->driver->lastclose)
377 dev->driver->lastclose(dev);
378 DRM_DEBUG("driver lastclose completed\n");
380 if (dev->irq_enabled && !drm_core_check_feature(dev, DRIVER_MODESET))
381 drm_irq_uninstall(dev);
383 mutex_lock(&dev->struct_mutex);
387 drm_legacy_sg_cleanup(dev);
389 /* Clear vma list (only built for debugging) */
390 list_for_each_entry_safe(vma, vma_temp, &dev->vmalist, head) {
391 list_del(&vma->head);
395 drm_legacy_dma_takedown(dev);
397 mutex_unlock(&dev->struct_mutex);
399 drm_legacy_dev_reinit(dev);
401 DRM_DEBUG("lastclose completed\n");
408 * \param inode device inode
409 * \param file_priv DRM file private.
410 * \return zero on success or a negative number on failure.
412 * If the hardware lock is held then free it, and take it again for the kernel
413 * context since it's necessary to reclaim buffers. Unlink the file private
414 * data from its list and free it. Decreases the open count and if it reaches
415 * zero calls drm_lastclose().
417 int drm_release(struct inode *inode, struct file *filp)
419 struct drm_file *file_priv = filp->private_data;
420 struct drm_minor *minor = file_priv->minor;
421 struct drm_device *dev = minor->dev;
424 mutex_lock(&drm_global_mutex);
426 DRM_DEBUG("open_count = %d\n", dev->open_count);
428 mutex_lock(&dev->struct_mutex);
429 list_del(&file_priv->lhead);
430 mutex_unlock(&dev->struct_mutex);
432 if (dev->driver->preclose)
433 dev->driver->preclose(dev, file_priv);
435 /* ========================================================
436 * Begin inline drm_release
439 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
440 task_pid_nr(current),
441 (long)old_encode_dev(file_priv->minor->kdev->devt),
444 /* Release any auth tokens that might point to this file_priv,
445 (do that under the drm_global_mutex) */
446 if (file_priv->magic)
447 (void) drm_remove_magic(file_priv->master, file_priv->magic);
449 /* if the master has gone away we can't do anything with the lock */
450 if (file_priv->minor->master)
451 drm_master_release(dev, filp);
453 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
454 drm_core_reclaim_buffers(dev, file_priv);
456 drm_events_release(file_priv);
458 if (dev->driver->driver_features & DRIVER_MODESET)
459 drm_fb_release(file_priv);
461 if (dev->driver->driver_features & DRIVER_GEM)
462 drm_gem_release(dev, file_priv);
464 mutex_lock(&dev->ctxlist_mutex);
465 if (!list_empty(&dev->ctxlist)) {
466 struct drm_ctx_list *pos, *n;
468 list_for_each_entry_safe(pos, n, &dev->ctxlist, head) {
469 if (pos->tag == file_priv &&
470 pos->handle != DRM_KERNEL_CONTEXT) {
471 if (dev->driver->context_dtor)
472 dev->driver->context_dtor(dev,
475 drm_ctxbitmap_free(dev, pos->handle);
477 list_del(&pos->head);
482 mutex_unlock(&dev->ctxlist_mutex);
484 mutex_lock(&dev->master_mutex);
486 if (file_priv->is_master) {
487 struct drm_master *master = file_priv->master;
488 struct drm_file *temp;
490 mutex_lock(&dev->struct_mutex);
491 list_for_each_entry(temp, &dev->filelist, lhead) {
492 if ((temp->master == file_priv->master) &&
494 temp->authenticated = temp->always_authenticated;
498 * Since the master is disappearing, so is the
499 * possibility to lock.
502 if (master->lock.hw_lock) {
503 if (dev->sigdata.lock == master->lock.hw_lock)
504 dev->sigdata.lock = NULL;
505 master->lock.hw_lock = NULL;
506 master->lock.file_priv = NULL;
507 wake_up_interruptible_all(&master->lock.lock_queue);
509 mutex_unlock(&dev->struct_mutex);
511 if (file_priv->minor->master == file_priv->master) {
512 /* drop the reference held my the minor */
513 if (dev->driver->master_drop)
514 dev->driver->master_drop(dev, file_priv, true);
515 drm_master_put(&file_priv->minor->master);
519 /* drop the master reference held by the file priv */
520 if (file_priv->master)
521 drm_master_put(&file_priv->master);
522 file_priv->is_master = 0;
523 mutex_unlock(&dev->master_mutex);
525 if (dev->driver->postclose)
526 dev->driver->postclose(dev, file_priv);
529 if (drm_core_check_feature(dev, DRIVER_PRIME))
530 drm_prime_destroy_file_private(&file_priv->prime);
532 put_pid(file_priv->pid);
535 /* ========================================================
536 * End inline drm_release
539 if (!--dev->open_count) {
540 retcode = drm_lastclose(dev);
541 if (drm_device_is_unplugged(dev))
544 mutex_unlock(&drm_global_mutex);
546 drm_minor_release(minor);
550 EXPORT_SYMBOL(drm_release);
553 drm_dequeue_event(struct drm_file *file_priv,
554 size_t total, size_t max, struct drm_pending_event **out)
556 struct drm_device *dev = file_priv->minor->dev;
557 struct drm_pending_event *e;
561 spin_lock_irqsave(&dev->event_lock, flags);
564 if (list_empty(&file_priv->event_list))
566 e = list_first_entry(&file_priv->event_list,
567 struct drm_pending_event, link);
568 if (e->event->length + total > max)
571 file_priv->event_space += e->event->length;
577 spin_unlock_irqrestore(&dev->event_lock, flags);
581 ssize_t drm_read(struct file *filp, char __user *buffer,
582 size_t count, loff_t *offset)
584 struct drm_file *file_priv = filp->private_data;
585 struct drm_pending_event *e;
589 ret = wait_event_interruptible(file_priv->event_wait,
590 !list_empty(&file_priv->event_list));
595 while (drm_dequeue_event(file_priv, total, count, &e)) {
596 if (copy_to_user(buffer + total,
597 e->event, e->event->length)) {
602 total += e->event->length;
608 EXPORT_SYMBOL(drm_read);
610 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
612 struct drm_file *file_priv = filp->private_data;
613 unsigned int mask = 0;
615 poll_wait(filp, &file_priv->event_wait, wait);
617 if (!list_empty(&file_priv->event_list))
618 mask |= POLLIN | POLLRDNORM;
622 EXPORT_SYMBOL(drm_poll);