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/dma-fence.h>
35 #include <linux/module.h>
36 #include <linux/pci.h>
37 #include <linux/poll.h>
38 #include <linux/slab.h>
40 #include <drm/drm_client.h>
41 #include <drm/drm_drv.h>
42 #include <drm/drm_file.h>
43 #include <drm/drm_print.h>
45 #include "drm_crtc_internal.h"
46 #include "drm_internal.h"
47 #include "drm_legacy.h"
49 /* from BKL pushdown */
50 DEFINE_MUTEX(drm_global_mutex);
53 * DOC: file operations
55 * Drivers must define the file operations structure that forms the DRM
56 * userspace API entry point, even though most of those operations are
57 * implemented in the DRM core. The resulting &struct file_operations must be
58 * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
59 * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
60 * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
61 * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
62 * that require 32/64 bit compatibility support must provide their own
63 * &file_operations.compat_ioctl handler that processes private ioctls and calls
64 * drm_compat_ioctl() for core ioctls.
66 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
67 * events are a generic and extensible means to send asynchronous events to
68 * userspace through the file descriptor. They are used to send vblank event and
69 * page flip completions by the KMS API. But drivers can also use it for their
70 * own needs, e.g. to signal completion of rendering.
72 * For the driver-side event interface see drm_event_reserve_init() and
73 * drm_send_event() as the main starting points.
75 * The memory mapping implementation will vary depending on how the driver
76 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
77 * function, modern drivers should use one of the provided memory-manager
78 * specific implementations. For GEM-based drivers this is drm_gem_mmap(), and
79 * for drivers which use the CMA GEM helpers it's drm_gem_cma_mmap().
81 * No other file operations are supported by the DRM userspace API. Overall the
82 * following is an example &file_operations structure::
84 * static const example_drm_fops = {
85 * .owner = THIS_MODULE,
87 * .release = drm_release,
88 * .unlocked_ioctl = drm_ioctl,
89 * .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
92 * .llseek = no_llseek,
93 * .mmap = drm_gem_mmap,
96 * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
97 * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
100 * The driver's &file_operations must be stored in &drm_driver.fops.
102 * For driver-private IOCTL handling see the more detailed discussion in
103 * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
107 * drm_file_alloc - allocate file context
108 * @minor: minor to allocate on
110 * This allocates a new DRM file context. It is not linked into any context and
111 * can be used by the caller freely. Note that the context keeps a pointer to
112 * @minor, so it must be freed before @minor is.
115 * Pointer to newly allocated context, ERR_PTR on failure.
117 struct drm_file *drm_file_alloc(struct drm_minor *minor)
119 struct drm_device *dev = minor->dev;
120 struct drm_file *file;
123 file = kzalloc(sizeof(*file), GFP_KERNEL);
125 return ERR_PTR(-ENOMEM);
127 file->pid = get_pid(task_pid(current));
130 /* for compatibility root is always authenticated */
131 file->authenticated = capable(CAP_SYS_ADMIN);
133 INIT_LIST_HEAD(&file->lhead);
134 INIT_LIST_HEAD(&file->fbs);
135 mutex_init(&file->fbs_lock);
136 INIT_LIST_HEAD(&file->blobs);
137 INIT_LIST_HEAD(&file->pending_event_list);
138 INIT_LIST_HEAD(&file->event_list);
139 init_waitqueue_head(&file->event_wait);
140 file->event_space = 4096; /* set aside 4k for event buffer */
142 mutex_init(&file->event_read_lock);
144 if (drm_core_check_feature(dev, DRIVER_GEM))
145 drm_gem_open(dev, file);
147 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
148 drm_syncobj_open(file);
150 drm_prime_init_file_private(&file->prime);
152 if (dev->driver->open) {
153 ret = dev->driver->open(dev, file);
155 goto out_prime_destroy;
161 drm_prime_destroy_file_private(&file->prime);
162 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
163 drm_syncobj_release(file);
164 if (drm_core_check_feature(dev, DRIVER_GEM))
165 drm_gem_release(dev, file);
172 static void drm_events_release(struct drm_file *file_priv)
174 struct drm_device *dev = file_priv->minor->dev;
175 struct drm_pending_event *e, *et;
178 spin_lock_irqsave(&dev->event_lock, flags);
180 /* Unlink pending events */
181 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
183 list_del(&e->pending_link);
187 /* Remove unconsumed events */
188 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
193 spin_unlock_irqrestore(&dev->event_lock, flags);
197 * drm_file_free - free file context
198 * @file: context to free, or NULL
200 * This destroys and deallocates a DRM file context previously allocated via
201 * drm_file_alloc(). The caller must make sure to unlink it from any contexts
202 * before calling this.
204 * If NULL is passed, this is a no-op.
207 * 0 on success, or error code on failure.
209 void drm_file_free(struct drm_file *file)
211 struct drm_device *dev;
216 dev = file->minor->dev;
218 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
219 task_pid_nr(current),
220 (long)old_encode_dev(file->minor->kdev->devt),
223 if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
224 dev->driver->preclose)
225 dev->driver->preclose(dev, file);
227 if (drm_core_check_feature(dev, DRIVER_LEGACY))
228 drm_legacy_lock_release(dev, file->filp);
230 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
231 drm_legacy_reclaim_buffers(dev, file);
233 drm_events_release(file);
235 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
236 drm_fb_release(file);
237 drm_property_destroy_user_blobs(dev, file);
240 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
241 drm_syncobj_release(file);
243 if (drm_core_check_feature(dev, DRIVER_GEM))
244 drm_gem_release(dev, file);
246 drm_legacy_ctxbitmap_flush(dev, file);
248 if (drm_is_primary_client(file))
249 drm_master_release(file);
251 if (dev->driver->postclose)
252 dev->driver->postclose(dev, file);
254 drm_prime_destroy_file_private(&file->prime);
256 WARN_ON(!list_empty(&file->event_list));
262 static void drm_close_helper(struct file *filp)
264 struct drm_file *file_priv = filp->private_data;
265 struct drm_device *dev = file_priv->minor->dev;
267 mutex_lock(&dev->filelist_mutex);
268 list_del(&file_priv->lhead);
269 mutex_unlock(&dev->filelist_mutex);
271 drm_file_free(file_priv);
275 * Check whether DRI will run on this CPU.
277 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
279 static int drm_cpu_valid(void)
281 #if defined(__sparc__) && !defined(__sparc_v9__)
282 return 0; /* No cmpxchg before v9 sparc. */
288 * Called whenever a process opens /dev/drm.
290 * \param filp file pointer.
291 * \param minor acquired minor-object.
292 * \return zero on success or a negative number on failure.
294 * Creates and initializes a drm_file structure for the file private data in \p
295 * filp and add it into the double linked list in \p dev.
297 static int drm_open_helper(struct file *filp, struct drm_minor *minor)
299 struct drm_device *dev = minor->dev;
300 struct drm_file *priv;
303 if (filp->f_flags & O_EXCL)
304 return -EBUSY; /* No exclusive opens */
305 if (!drm_cpu_valid())
307 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
310 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
312 priv = drm_file_alloc(minor);
314 return PTR_ERR(priv);
316 if (drm_is_primary_client(priv)) {
317 ret = drm_master_open(priv);
324 filp->private_data = priv;
325 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
328 mutex_lock(&dev->filelist_mutex);
329 list_add(&priv->lhead, &dev->filelist);
330 mutex_unlock(&dev->filelist_mutex);
337 struct pci_dev *pci_dev;
338 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
340 dev->hose = pci_dev->sysdata;
341 pci_dev_put(pci_dev);
344 struct pci_bus *b = list_entry(pci_root_buses.next,
345 struct pci_bus, node);
347 dev->hose = b->sysdata;
356 * drm_open - open method for DRM file
357 * @inode: device inode
358 * @filp: file pointer.
360 * This function must be used by drivers as their &file_operations.open method.
361 * It looks up the correct DRM device and instantiates all the per-file
362 * resources for it. It also calls the &drm_driver.open driver callback.
366 * 0 on success or negative errno value on falure.
368 int drm_open(struct inode *inode, struct file *filp)
370 struct drm_device *dev;
371 struct drm_minor *minor;
375 minor = drm_minor_acquire(iminor(inode));
377 return PTR_ERR(minor);
380 if (!dev->open_count++)
383 /* share address_space across all char-devs of a single device */
384 filp->f_mapping = dev->anon_inode->i_mapping;
386 retcode = drm_open_helper(filp, minor);
390 retcode = drm_legacy_setup(dev);
392 drm_close_helper(filp);
400 drm_minor_release(minor);
403 EXPORT_SYMBOL(drm_open);
405 void drm_lastclose(struct drm_device * dev)
409 if (dev->driver->lastclose)
410 dev->driver->lastclose(dev);
411 DRM_DEBUG("driver lastclose completed\n");
413 if (drm_core_check_feature(dev, DRIVER_LEGACY))
414 drm_legacy_dev_reinit(dev);
416 drm_client_dev_restore(dev);
420 * drm_release - release method for DRM file
421 * @inode: device inode
422 * @filp: file pointer.
424 * This function must be used by drivers as their &file_operations.release
425 * method. It frees any resources associated with the open file, and calls the
426 * &drm_driver.postclose driver callback. If this is the last open file for the
427 * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
431 * Always succeeds and returns 0.
433 int drm_release(struct inode *inode, struct file *filp)
435 struct drm_file *file_priv = filp->private_data;
436 struct drm_minor *minor = file_priv->minor;
437 struct drm_device *dev = minor->dev;
439 mutex_lock(&drm_global_mutex);
441 DRM_DEBUG("open_count = %d\n", dev->open_count);
443 drm_close_helper(filp);
445 if (!--dev->open_count)
448 mutex_unlock(&drm_global_mutex);
450 drm_minor_release(minor);
454 EXPORT_SYMBOL(drm_release);
457 * drm_read - read method for DRM file
458 * @filp: file pointer
459 * @buffer: userspace destination pointer for the read
460 * @count: count in bytes to read
461 * @offset: offset to read
463 * This function must be used by drivers as their &file_operations.read
464 * method iff they use DRM events for asynchronous signalling to userspace.
465 * Since events are used by the KMS API for vblank and page flip completion this
466 * means all modern display drivers must use it.
468 * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
469 * must set the &file_operation.llseek to no_llseek(). Polling support is
470 * provided by drm_poll().
472 * This function will only ever read a full event. Therefore userspace must
473 * supply a big enough buffer to fit any event to ensure forward progress. Since
474 * the maximum event space is currently 4K it's recommended to just use that for
479 * Number of bytes read (always aligned to full events, and can be 0) or a
480 * negative error code on failure.
482 ssize_t drm_read(struct file *filp, char __user *buffer,
483 size_t count, loff_t *offset)
485 struct drm_file *file_priv = filp->private_data;
486 struct drm_device *dev = file_priv->minor->dev;
489 if (!access_ok(buffer, count))
492 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
497 struct drm_pending_event *e = NULL;
499 spin_lock_irq(&dev->event_lock);
500 if (!list_empty(&file_priv->event_list)) {
501 e = list_first_entry(&file_priv->event_list,
502 struct drm_pending_event, link);
503 file_priv->event_space += e->event->length;
506 spin_unlock_irq(&dev->event_lock);
512 if (filp->f_flags & O_NONBLOCK) {
517 mutex_unlock(&file_priv->event_read_lock);
518 ret = wait_event_interruptible(file_priv->event_wait,
519 !list_empty(&file_priv->event_list));
521 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
525 unsigned length = e->event->length;
527 if (length > count - ret) {
529 spin_lock_irq(&dev->event_lock);
530 file_priv->event_space -= length;
531 list_add(&e->link, &file_priv->event_list);
532 spin_unlock_irq(&dev->event_lock);
533 wake_up_interruptible(&file_priv->event_wait);
537 if (copy_to_user(buffer + ret, e->event, length)) {
547 mutex_unlock(&file_priv->event_read_lock);
551 EXPORT_SYMBOL(drm_read);
554 * drm_poll - poll method for DRM file
555 * @filp: file pointer
556 * @wait: poll waiter table
558 * This function must be used by drivers as their &file_operations.read method
559 * iff they use DRM events for asynchronous signalling to userspace. Since
560 * events are used by the KMS API for vblank and page flip completion this means
561 * all modern display drivers must use it.
563 * See also drm_read().
567 * Mask of POLL flags indicating the current status of the file.
569 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
571 struct drm_file *file_priv = filp->private_data;
574 poll_wait(filp, &file_priv->event_wait, wait);
576 if (!list_empty(&file_priv->event_list))
577 mask |= EPOLLIN | EPOLLRDNORM;
581 EXPORT_SYMBOL(drm_poll);
584 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
586 * @file_priv: DRM file private data
587 * @p: tracking structure for the pending event
588 * @e: actual event data to deliver to userspace
590 * This function prepares the passed in event for eventual delivery. If the event
591 * doesn't get delivered (because the IOCTL fails later on, before queuing up
592 * anything) then the even must be cancelled and freed using
593 * drm_event_cancel_free(). Successfully initialized events should be sent out
594 * using drm_send_event() or drm_send_event_locked() to signal completion of the
595 * asynchronous event to userspace.
597 * If callers embedded @p into a larger structure it must be allocated with
598 * kmalloc and @p must be the first member element.
600 * This is the locked version of drm_event_reserve_init() for callers which
601 * already hold &drm_device.event_lock.
605 * 0 on success or a negative error code on failure.
607 int drm_event_reserve_init_locked(struct drm_device *dev,
608 struct drm_file *file_priv,
609 struct drm_pending_event *p,
612 if (file_priv->event_space < e->length)
615 file_priv->event_space -= e->length;
618 list_add(&p->pending_link, &file_priv->pending_event_list);
619 p->file_priv = file_priv;
623 EXPORT_SYMBOL(drm_event_reserve_init_locked);
626 * drm_event_reserve_init - init a DRM event and reserve space for it
628 * @file_priv: DRM file private data
629 * @p: tracking structure for the pending event
630 * @e: actual event data to deliver to userspace
632 * This function prepares the passed in event for eventual delivery. If the event
633 * doesn't get delivered (because the IOCTL fails later on, before queuing up
634 * anything) then the even must be cancelled and freed using
635 * drm_event_cancel_free(). Successfully initialized events should be sent out
636 * using drm_send_event() or drm_send_event_locked() to signal completion of the
637 * asynchronous event to userspace.
639 * If callers embedded @p into a larger structure it must be allocated with
640 * kmalloc and @p must be the first member element.
642 * Callers which already hold &drm_device.event_lock should use
643 * drm_event_reserve_init_locked() instead.
647 * 0 on success or a negative error code on failure.
649 int drm_event_reserve_init(struct drm_device *dev,
650 struct drm_file *file_priv,
651 struct drm_pending_event *p,
657 spin_lock_irqsave(&dev->event_lock, flags);
658 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
659 spin_unlock_irqrestore(&dev->event_lock, flags);
663 EXPORT_SYMBOL(drm_event_reserve_init);
666 * drm_event_cancel_free - free a DRM event and release its space
668 * @p: tracking structure for the pending event
670 * This function frees the event @p initialized with drm_event_reserve_init()
671 * and releases any allocated space. It is used to cancel an event when the
672 * nonblocking operation could not be submitted and needed to be aborted.
674 void drm_event_cancel_free(struct drm_device *dev,
675 struct drm_pending_event *p)
678 spin_lock_irqsave(&dev->event_lock, flags);
680 p->file_priv->event_space += p->event->length;
681 list_del(&p->pending_link);
683 spin_unlock_irqrestore(&dev->event_lock, flags);
686 dma_fence_put(p->fence);
690 EXPORT_SYMBOL(drm_event_cancel_free);
693 * drm_send_event_locked - send DRM event to file descriptor
695 * @e: DRM event to deliver
697 * This function sends the event @e, initialized with drm_event_reserve_init(),
698 * to its associated userspace DRM file. Callers must already hold
699 * &drm_device.event_lock, see drm_send_event() for the unlocked version.
701 * Note that the core will take care of unlinking and disarming events when the
702 * corresponding DRM file is closed. Drivers need not worry about whether the
703 * DRM file for this event still exists and can call this function upon
704 * completion of the asynchronous work unconditionally.
706 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
708 assert_spin_locked(&dev->event_lock);
711 complete_all(e->completion);
712 e->completion_release(e->completion);
713 e->completion = NULL;
717 dma_fence_signal(e->fence);
718 dma_fence_put(e->fence);
726 list_del(&e->pending_link);
727 list_add_tail(&e->link,
728 &e->file_priv->event_list);
729 wake_up_interruptible(&e->file_priv->event_wait);
731 EXPORT_SYMBOL(drm_send_event_locked);
734 * drm_send_event - send DRM event to file descriptor
736 * @e: DRM event to deliver
738 * This function sends the event @e, initialized with drm_event_reserve_init(),
739 * to its associated userspace DRM file. This function acquires
740 * &drm_device.event_lock, see drm_send_event_locked() for callers which already
743 * Note that the core will take care of unlinking and disarming events when the
744 * corresponding DRM file is closed. Drivers need not worry about whether the
745 * DRM file for this event still exists and can call this function upon
746 * completion of the asynchronous work unconditionally.
748 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
750 unsigned long irqflags;
752 spin_lock_irqsave(&dev->event_lock, irqflags);
753 drm_send_event_locked(dev, e);
754 spin_unlock_irqrestore(&dev->event_lock, irqflags);
756 EXPORT_SYMBOL(drm_send_event);