10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * All Rights Reserved.
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the "Software"),
16 * to deal in the Software without restriction, including without limitation
17 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 * and/or sell copies of the Software, and to permit persons to whom the
19 * Software is furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice (including the next
22 * paragraph) shall be included in all copies or substantial portions of the
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
28 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
31 * OTHER DEALINGS IN THE SOFTWARE.
34 #include <linux/poll.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
38 #include <drm/drm_file.h>
41 #include "drm_legacy.h"
42 #include "drm_internal.h"
43 #include "drm_crtc_internal.h"
45 /* from BKL pushdown */
46 DEFINE_MUTEX(drm_global_mutex);
49 * DOC: file operations
51 * Drivers must define the file operations structure that forms the DRM
52 * userspace API entry point, even though most of those operations are
53 * implemented in the DRM core. The resulting &struct file_operations must be
54 * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
55 * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
56 * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
57 * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
58 * that require 32/64 bit compatibility support must provide their own
59 * &file_operations.compat_ioctl handler that processes private ioctls and calls
60 * drm_compat_ioctl() for core ioctls.
62 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
63 * events are a generic and extensible means to send asynchronous events to
64 * userspace through the file descriptor. They are used to send vblank event and
65 * page flip completions by the KMS API. But drivers can also use it for their
66 * own needs, e.g. to signal completion of rendering.
68 * For the driver-side event interface see drm_event_reserve_init() and
69 * drm_send_event() as the main starting points.
71 * The memory mapping implementation will vary depending on how the driver
72 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
73 * function, modern drivers should use one of the provided memory-manager
74 * specific implementations. For GEM-based drivers this is drm_gem_mmap(), and
75 * for drivers which use the CMA GEM helpers it's drm_gem_cma_mmap().
77 * No other file operations are supported by the DRM userspace API. Overall the
78 * following is an example &file_operations structure::
80 * static const example_drm_fops = {
81 * .owner = THIS_MODULE,
83 * .release = drm_release,
84 * .unlocked_ioctl = drm_ioctl,
85 * .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
88 * .llseek = no_llseek,
89 * .mmap = drm_gem_mmap,
92 * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
93 * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
96 * The driver's &file_operations must be stored in &drm_driver.fops.
98 * For driver-private IOCTL handling see the more detailed discussion in
99 * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
102 static int drm_open_helper(struct file *filp, struct drm_minor *minor);
104 static int drm_setup(struct drm_device * dev)
108 if (dev->driver->firstopen &&
109 drm_core_check_feature(dev, DRIVER_LEGACY)) {
110 ret = dev->driver->firstopen(dev);
115 ret = drm_legacy_dma_setup(dev);
125 * drm_open - open method for DRM file
126 * @inode: device inode
127 * @filp: file pointer.
129 * This function must be used by drivers as their &file_operations.open method.
130 * It looks up the correct DRM device and instantiates all the per-file
131 * resources for it. It also calls the &drm_driver.open driver callback.
135 * 0 on success or negative errno value on falure.
137 int drm_open(struct inode *inode, struct file *filp)
139 struct drm_device *dev;
140 struct drm_minor *minor;
144 minor = drm_minor_acquire(iminor(inode));
146 return PTR_ERR(minor);
149 if (!dev->open_count++)
152 /* share address_space across all char-devs of a single device */
153 filp->f_mapping = dev->anon_inode->i_mapping;
155 retcode = drm_open_helper(filp, minor);
159 retcode = drm_setup(dev);
167 drm_minor_release(minor);
170 EXPORT_SYMBOL(drm_open);
173 * Check whether DRI will run on this CPU.
175 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
177 static int drm_cpu_valid(void)
179 #if defined(__sparc__) && !defined(__sparc_v9__)
180 return 0; /* No cmpxchg before v9 sparc. */
186 * Called whenever a process opens /dev/drm.
188 * \param filp file pointer.
189 * \param minor acquired minor-object.
190 * \return zero on success or a negative number on failure.
192 * Creates and initializes a drm_file structure for the file private data in \p
193 * filp and add it into the double linked list in \p dev.
195 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
197 struct drm_device *dev = minor->dev;
198 struct drm_file *priv;
201 if (filp->f_flags & O_EXCL)
202 return -EBUSY; /* No exclusive opens */
203 if (!drm_cpu_valid())
205 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
208 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
210 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
214 filp->private_data = priv;
215 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
217 priv->pid = get_pid(task_pid(current));
220 /* for compatibility root is always authenticated */
221 priv->authenticated = capable(CAP_SYS_ADMIN);
222 priv->lock_count = 0;
224 INIT_LIST_HEAD(&priv->lhead);
225 INIT_LIST_HEAD(&priv->fbs);
226 mutex_init(&priv->fbs_lock);
227 INIT_LIST_HEAD(&priv->blobs);
228 INIT_LIST_HEAD(&priv->pending_event_list);
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 mutex_init(&priv->event_read_lock);
235 if (drm_core_check_feature(dev, DRIVER_GEM))
236 drm_gem_open(dev, priv);
238 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
239 drm_syncobj_open(priv);
241 if (drm_core_check_feature(dev, DRIVER_PRIME))
242 drm_prime_init_file_private(&priv->prime);
244 if (dev->driver->open) {
245 ret = dev->driver->open(dev, priv);
247 goto out_prime_destroy;
250 if (drm_is_primary_client(priv)) {
251 ret = drm_master_open(priv);
256 mutex_lock(&dev->filelist_mutex);
257 list_add(&priv->lhead, &dev->filelist);
258 mutex_unlock(&dev->filelist_mutex);
265 struct pci_dev *pci_dev;
266 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
268 dev->hose = pci_dev->sysdata;
269 pci_dev_put(pci_dev);
272 struct pci_bus *b = list_entry(pci_root_buses.next,
273 struct pci_bus, node);
275 dev->hose = b->sysdata;
283 if (dev->driver->postclose)
284 dev->driver->postclose(dev, priv);
286 if (drm_core_check_feature(dev, DRIVER_PRIME))
287 drm_prime_destroy_file_private(&priv->prime);
288 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
289 drm_syncobj_release(priv);
290 if (drm_core_check_feature(dev, DRIVER_GEM))
291 drm_gem_release(dev, priv);
294 filp->private_data = NULL;
298 static void drm_events_release(struct drm_file *file_priv)
300 struct drm_device *dev = file_priv->minor->dev;
301 struct drm_pending_event *e, *et;
304 spin_lock_irqsave(&dev->event_lock, flags);
306 /* Unlink pending events */
307 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
309 list_del(&e->pending_link);
313 /* Remove unconsumed events */
314 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
319 spin_unlock_irqrestore(&dev->event_lock, flags);
322 static void drm_legacy_dev_reinit(struct drm_device *dev)
324 if (dev->irq_enabled)
325 drm_irq_uninstall(dev);
327 mutex_lock(&dev->struct_mutex);
329 drm_legacy_agp_clear(dev);
331 drm_legacy_sg_cleanup(dev);
332 drm_legacy_vma_flush(dev);
333 drm_legacy_dma_takedown(dev);
335 mutex_unlock(&dev->struct_mutex);
337 dev->sigdata.lock = NULL;
339 dev->context_flag = 0;
340 dev->last_context = 0;
343 DRM_DEBUG("lastclose completed\n");
346 void drm_lastclose(struct drm_device * dev)
350 if (dev->driver->lastclose)
351 dev->driver->lastclose(dev);
352 DRM_DEBUG("driver lastclose completed\n");
354 if (drm_core_check_feature(dev, DRIVER_LEGACY))
355 drm_legacy_dev_reinit(dev);
359 * drm_release - release method for DRM file
360 * @inode: device inode
361 * @filp: file pointer.
363 * This function must be used by drivers as their &file_operations.release
364 * method. It frees any resources associated with the open file, and calls the
365 * &drm_driver.postclose driver callback. If this is the last open file for the
366 * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
370 * Always succeeds and returns 0.
372 int drm_release(struct inode *inode, struct file *filp)
374 struct drm_file *file_priv = filp->private_data;
375 struct drm_minor *minor = file_priv->minor;
376 struct drm_device *dev = minor->dev;
378 mutex_lock(&drm_global_mutex);
380 DRM_DEBUG("open_count = %d\n", dev->open_count);
382 mutex_lock(&dev->filelist_mutex);
383 list_del(&file_priv->lhead);
384 mutex_unlock(&dev->filelist_mutex);
386 if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
387 dev->driver->preclose)
388 dev->driver->preclose(dev, file_priv);
390 /* ========================================================
391 * Begin inline drm_release
394 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
395 task_pid_nr(current),
396 (long)old_encode_dev(file_priv->minor->kdev->devt),
399 if (drm_core_check_feature(dev, DRIVER_LEGACY))
400 drm_legacy_lock_release(dev, filp);
402 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
403 drm_legacy_reclaim_buffers(dev, file_priv);
405 drm_events_release(file_priv);
407 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
408 drm_fb_release(file_priv);
409 drm_property_destroy_user_blobs(dev, file_priv);
412 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
413 drm_syncobj_release(file_priv);
415 if (drm_core_check_feature(dev, DRIVER_GEM))
416 drm_gem_release(dev, file_priv);
418 drm_legacy_ctxbitmap_flush(dev, file_priv);
420 if (drm_is_primary_client(file_priv))
421 drm_master_release(file_priv);
423 if (dev->driver->postclose)
424 dev->driver->postclose(dev, file_priv);
426 if (drm_core_check_feature(dev, DRIVER_PRIME))
427 drm_prime_destroy_file_private(&file_priv->prime);
429 WARN_ON(!list_empty(&file_priv->event_list));
431 put_pid(file_priv->pid);
434 /* ========================================================
435 * End inline drm_release
438 if (!--dev->open_count) {
440 if (drm_dev_is_unplugged(dev))
443 mutex_unlock(&drm_global_mutex);
445 drm_minor_release(minor);
449 EXPORT_SYMBOL(drm_release);
452 * drm_read - read method for DRM file
453 * @filp: file pointer
454 * @buffer: userspace destination pointer for the read
455 * @count: count in bytes to read
456 * @offset: offset to read
458 * This function must be used by drivers as their &file_operations.read
459 * method iff they use DRM events for asynchronous signalling to userspace.
460 * Since events are used by the KMS API for vblank and page flip completion this
461 * means all modern display drivers must use it.
463 * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
464 * must set the &file_operation.llseek to no_llseek(). Polling support is
465 * provided by drm_poll().
467 * This function will only ever read a full event. Therefore userspace must
468 * supply a big enough buffer to fit any event to ensure forward progress. Since
469 * the maximum event space is currently 4K it's recommended to just use that for
474 * Number of bytes read (always aligned to full events, and can be 0) or a
475 * negative error code on failure.
477 ssize_t drm_read(struct file *filp, char __user *buffer,
478 size_t count, loff_t *offset)
480 struct drm_file *file_priv = filp->private_data;
481 struct drm_device *dev = file_priv->minor->dev;
484 if (!access_ok(VERIFY_WRITE, buffer, count))
487 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
492 struct drm_pending_event *e = NULL;
494 spin_lock_irq(&dev->event_lock);
495 if (!list_empty(&file_priv->event_list)) {
496 e = list_first_entry(&file_priv->event_list,
497 struct drm_pending_event, link);
498 file_priv->event_space += e->event->length;
501 spin_unlock_irq(&dev->event_lock);
507 if (filp->f_flags & O_NONBLOCK) {
512 mutex_unlock(&file_priv->event_read_lock);
513 ret = wait_event_interruptible(file_priv->event_wait,
514 !list_empty(&file_priv->event_list));
516 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
520 unsigned length = e->event->length;
522 if (length > count - ret) {
524 spin_lock_irq(&dev->event_lock);
525 file_priv->event_space -= length;
526 list_add(&e->link, &file_priv->event_list);
527 spin_unlock_irq(&dev->event_lock);
531 if (copy_to_user(buffer + ret, e->event, length)) {
541 mutex_unlock(&file_priv->event_read_lock);
545 EXPORT_SYMBOL(drm_read);
548 * drm_poll - poll method for DRM file
549 * @filp: file pointer
550 * @wait: poll waiter table
552 * This function must be used by drivers as their &file_operations.read method
553 * iff they use DRM events for asynchronous signalling to userspace. Since
554 * events are used by the KMS API for vblank and page flip completion this means
555 * all modern display drivers must use it.
557 * See also drm_read().
561 * Mask of POLL flags indicating the current status of the file.
563 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
565 struct drm_file *file_priv = filp->private_data;
568 poll_wait(filp, &file_priv->event_wait, wait);
570 if (!list_empty(&file_priv->event_list))
571 mask |= EPOLLIN | EPOLLRDNORM;
575 EXPORT_SYMBOL(drm_poll);
578 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
580 * @file_priv: DRM file private data
581 * @p: tracking structure for the pending event
582 * @e: actual event data to deliver to userspace
584 * This function prepares the passed in event for eventual delivery. If the event
585 * doesn't get delivered (because the IOCTL fails later on, before queuing up
586 * anything) then the even must be cancelled and freed using
587 * drm_event_cancel_free(). Successfully initialized events should be sent out
588 * using drm_send_event() or drm_send_event_locked() to signal completion of the
589 * asynchronous event to userspace.
591 * If callers embedded @p into a larger structure it must be allocated with
592 * kmalloc and @p must be the first member element.
594 * This is the locked version of drm_event_reserve_init() for callers which
595 * already hold &drm_device.event_lock.
599 * 0 on success or a negative error code on failure.
601 int drm_event_reserve_init_locked(struct drm_device *dev,
602 struct drm_file *file_priv,
603 struct drm_pending_event *p,
606 if (file_priv->event_space < e->length)
609 file_priv->event_space -= e->length;
612 list_add(&p->pending_link, &file_priv->pending_event_list);
613 p->file_priv = file_priv;
617 EXPORT_SYMBOL(drm_event_reserve_init_locked);
620 * drm_event_reserve_init - init a DRM event and reserve space for it
622 * @file_priv: DRM file private data
623 * @p: tracking structure for the pending event
624 * @e: actual event data to deliver to userspace
626 * This function prepares the passed in event for eventual delivery. If the event
627 * doesn't get delivered (because the IOCTL fails later on, before queuing up
628 * anything) then the even must be cancelled and freed using
629 * drm_event_cancel_free(). Successfully initialized events should be sent out
630 * using drm_send_event() or drm_send_event_locked() to signal completion of the
631 * asynchronous event to userspace.
633 * If callers embedded @p into a larger structure it must be allocated with
634 * kmalloc and @p must be the first member element.
636 * Callers which already hold &drm_device.event_lock should use
637 * drm_event_reserve_init_locked() instead.
641 * 0 on success or a negative error code on failure.
643 int drm_event_reserve_init(struct drm_device *dev,
644 struct drm_file *file_priv,
645 struct drm_pending_event *p,
651 spin_lock_irqsave(&dev->event_lock, flags);
652 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
653 spin_unlock_irqrestore(&dev->event_lock, flags);
657 EXPORT_SYMBOL(drm_event_reserve_init);
660 * drm_event_cancel_free - free a DRM event and release it's space
662 * @p: tracking structure for the pending event
664 * This function frees the event @p initialized with drm_event_reserve_init()
665 * and releases any allocated space. It is used to cancel an event when the
666 * nonblocking operation could not be submitted and needed to be aborted.
668 void drm_event_cancel_free(struct drm_device *dev,
669 struct drm_pending_event *p)
672 spin_lock_irqsave(&dev->event_lock, flags);
674 p->file_priv->event_space += p->event->length;
675 list_del(&p->pending_link);
677 spin_unlock_irqrestore(&dev->event_lock, flags);
680 dma_fence_put(p->fence);
684 EXPORT_SYMBOL(drm_event_cancel_free);
687 * drm_send_event_locked - send DRM event to file descriptor
689 * @e: DRM event to deliver
691 * This function sends the event @e, initialized with drm_event_reserve_init(),
692 * to its associated userspace DRM file. Callers must already hold
693 * &drm_device.event_lock, see drm_send_event() for the unlocked version.
695 * Note that the core will take care of unlinking and disarming events when the
696 * corresponding DRM file is closed. Drivers need not worry about whether the
697 * DRM file for this event still exists and can call this function upon
698 * completion of the asynchronous work unconditionally.
700 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
702 assert_spin_locked(&dev->event_lock);
705 complete_all(e->completion);
706 e->completion_release(e->completion);
707 e->completion = NULL;
711 dma_fence_signal(e->fence);
712 dma_fence_put(e->fence);
720 list_del(&e->pending_link);
721 list_add_tail(&e->link,
722 &e->file_priv->event_list);
723 wake_up_interruptible(&e->file_priv->event_wait);
725 EXPORT_SYMBOL(drm_send_event_locked);
728 * drm_send_event - send DRM event to file descriptor
730 * @e: DRM event to deliver
732 * This function sends the event @e, initialized with drm_event_reserve_init(),
733 * to its associated userspace DRM file. This function acquires
734 * &drm_device.event_lock, see drm_send_event_locked() for callers which already
737 * Note that the core will take care of unlinking and disarming events when the
738 * corresponding DRM file is closed. Drivers need not worry about whether the
739 * DRM file for this event still exists and can call this function upon
740 * completion of the asynchronous work unconditionally.
742 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
744 unsigned long irqflags;
746 spin_lock_irqsave(&dev->event_lock, irqflags);
747 drm_send_event_locked(dev, e);
748 spin_unlock_irqrestore(&dev->event_lock, irqflags);
750 EXPORT_SYMBOL(drm_send_event);