2 * \author Rickard E. (Rik) Faith <faith@valinux.com>
3 * \author Daryll Strauss <daryll@valinux.com>
4 * \author Gareth Hughes <gareth@valinux.com>
8 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
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_client.h>
39 #include <drm/drm_file.h>
42 #include "drm_legacy.h"
43 #include "drm_internal.h"
44 #include "drm_crtc_internal.h"
46 /* from BKL pushdown */
47 DEFINE_MUTEX(drm_global_mutex
);
50 * DOC: file operations
52 * Drivers must define the file operations structure that forms the DRM
53 * userspace API entry point, even though most of those operations are
54 * implemented in the DRM core. The resulting &struct file_operations must be
55 * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
56 * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
57 * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
58 * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
59 * that require 32/64 bit compatibility support must provide their own
60 * &file_operations.compat_ioctl handler that processes private ioctls and calls
61 * drm_compat_ioctl() for core ioctls.
63 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
64 * events are a generic and extensible means to send asynchronous events to
65 * userspace through the file descriptor. They are used to send vblank event and
66 * page flip completions by the KMS API. But drivers can also use it for their
67 * own needs, e.g. to signal completion of rendering.
69 * For the driver-side event interface see drm_event_reserve_init() and
70 * drm_send_event() as the main starting points.
72 * The memory mapping implementation will vary depending on how the driver
73 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
74 * function, modern drivers should use one of the provided memory-manager
75 * specific implementations. For GEM-based drivers this is drm_gem_mmap(), and
76 * for drivers which use the CMA GEM helpers it's drm_gem_cma_mmap().
78 * No other file operations are supported by the DRM userspace API. Overall the
79 * following is an example &file_operations structure::
81 * static const example_drm_fops = {
82 * .owner = THIS_MODULE,
84 * .release = drm_release,
85 * .unlocked_ioctl = drm_ioctl,
86 * .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
89 * .llseek = no_llseek,
90 * .mmap = drm_gem_mmap,
93 * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
94 * CMA based drivers there is the DEFINE_DRM_GEM_CMA_FOPS() macro to make this
97 * The driver's &file_operations must be stored in &drm_driver.fops.
99 * For driver-private IOCTL handling see the more detailed discussion in
100 * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
103 static int drm_open_helper(struct file
*filp
, struct drm_minor
*minor
);
106 * drm_file_alloc - allocate file context
107 * @minor: minor to allocate on
109 * This allocates a new DRM file context. It is not linked into any context and
110 * can be used by the caller freely. Note that the context keeps a pointer to
111 * @minor, so it must be freed before @minor is.
114 * Pointer to newly allocated context, ERR_PTR on failure.
116 struct drm_file
*drm_file_alloc(struct drm_minor
*minor
)
118 struct drm_device
*dev
= minor
->dev
;
119 struct drm_file
*file
;
122 file
= kzalloc(sizeof(*file
), GFP_KERNEL
);
124 return ERR_PTR(-ENOMEM
);
126 file
->pid
= get_pid(task_pid(current
));
129 /* for compatibility root is always authenticated */
130 file
->authenticated
= capable(CAP_SYS_ADMIN
);
131 file
->lock_count
= 0;
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 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
151 drm_prime_init_file_private(&file
->prime
);
153 if (dev
->driver
->open
) {
154 ret
= dev
->driver
->open(dev
, file
);
156 goto out_prime_destroy
;
162 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
163 drm_prime_destroy_file_private(&file
->prime
);
164 if (drm_core_check_feature(dev
, DRIVER_SYNCOBJ
))
165 drm_syncobj_release(file
);
166 if (drm_core_check_feature(dev
, DRIVER_GEM
))
167 drm_gem_release(dev
, file
);
174 static void drm_events_release(struct drm_file
*file_priv
)
176 struct drm_device
*dev
= file_priv
->minor
->dev
;
177 struct drm_pending_event
*e
, *et
;
180 spin_lock_irqsave(&dev
->event_lock
, flags
);
182 /* Unlink pending events */
183 list_for_each_entry_safe(e
, et
, &file_priv
->pending_event_list
,
185 list_del(&e
->pending_link
);
189 /* Remove unconsumed events */
190 list_for_each_entry_safe(e
, et
, &file_priv
->event_list
, link
) {
195 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
199 * drm_file_free - free file context
200 * @file: context to free, or NULL
202 * This destroys and deallocates a DRM file context previously allocated via
203 * drm_file_alloc(). The caller must make sure to unlink it from any contexts
204 * before calling this.
206 * If NULL is passed, this is a no-op.
209 * 0 on success, or error code on failure.
211 void drm_file_free(struct drm_file
*file
)
213 struct drm_device
*dev
;
218 dev
= file
->minor
->dev
;
220 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
221 task_pid_nr(current
),
222 (long)old_encode_dev(file
->minor
->kdev
->devt
),
225 if (drm_core_check_feature(dev
, DRIVER_LEGACY
) &&
226 dev
->driver
->preclose
)
227 dev
->driver
->preclose(dev
, file
);
229 if (drm_core_check_feature(dev
, DRIVER_LEGACY
))
230 drm_legacy_lock_release(dev
, file
->filp
);
232 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
233 drm_legacy_reclaim_buffers(dev
, file
);
235 drm_events_release(file
);
237 if (drm_core_check_feature(dev
, DRIVER_MODESET
)) {
238 drm_fb_release(file
);
239 drm_property_destroy_user_blobs(dev
, file
);
242 if (drm_core_check_feature(dev
, DRIVER_SYNCOBJ
))
243 drm_syncobj_release(file
);
245 if (drm_core_check_feature(dev
, DRIVER_GEM
))
246 drm_gem_release(dev
, file
);
248 drm_legacy_ctxbitmap_flush(dev
, file
);
250 if (drm_is_primary_client(file
))
251 drm_master_release(file
);
253 if (dev
->driver
->postclose
)
254 dev
->driver
->postclose(dev
, file
);
256 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
257 drm_prime_destroy_file_private(&file
->prime
);
259 WARN_ON(!list_empty(&file
->event_list
));
265 static void drm_close_helper(struct file
*filp
)
267 struct drm_file
*file_priv
= filp
->private_data
;
268 struct drm_device
*dev
= file_priv
->minor
->dev
;
270 mutex_lock(&dev
->filelist_mutex
);
271 list_del(&file_priv
->lhead
);
272 mutex_unlock(&dev
->filelist_mutex
);
274 drm_file_free(file_priv
);
277 static int drm_setup(struct drm_device
* dev
)
281 if (dev
->driver
->firstopen
&&
282 drm_core_check_feature(dev
, DRIVER_LEGACY
)) {
283 ret
= dev
->driver
->firstopen(dev
);
288 ret
= drm_legacy_dma_setup(dev
);
298 * drm_open - open method for DRM file
299 * @inode: device inode
300 * @filp: file pointer.
302 * This function must be used by drivers as their &file_operations.open method.
303 * It looks up the correct DRM device and instantiates all the per-file
304 * resources for it. It also calls the &drm_driver.open driver callback.
308 * 0 on success or negative errno value on falure.
310 int drm_open(struct inode
*inode
, struct file
*filp
)
312 struct drm_device
*dev
;
313 struct drm_minor
*minor
;
317 minor
= drm_minor_acquire(iminor(inode
));
319 return PTR_ERR(minor
);
322 if (!dev
->open_count
++)
325 /* share address_space across all char-devs of a single device */
326 filp
->f_mapping
= dev
->anon_inode
->i_mapping
;
328 retcode
= drm_open_helper(filp
, minor
);
332 retcode
= drm_setup(dev
);
334 drm_close_helper(filp
);
342 drm_minor_release(minor
);
345 EXPORT_SYMBOL(drm_open
);
348 * Check whether DRI will run on this CPU.
350 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
352 static int drm_cpu_valid(void)
354 #if defined(__sparc__) && !defined(__sparc_v9__)
355 return 0; /* No cmpxchg before v9 sparc. */
361 * Called whenever a process opens /dev/drm.
363 * \param filp file pointer.
364 * \param minor acquired minor-object.
365 * \return zero on success or a negative number on failure.
367 * Creates and initializes a drm_file structure for the file private data in \p
368 * filp and add it into the double linked list in \p dev.
370 static int drm_open_helper(struct file
*filp
, struct drm_minor
*minor
)
372 struct drm_device
*dev
= minor
->dev
;
373 struct drm_file
*priv
;
376 if (filp
->f_flags
& O_EXCL
)
377 return -EBUSY
; /* No exclusive opens */
378 if (!drm_cpu_valid())
380 if (dev
->switch_power_state
!= DRM_SWITCH_POWER_ON
&& dev
->switch_power_state
!= DRM_SWITCH_POWER_DYNAMIC_OFF
)
383 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current
), minor
->index
);
385 priv
= drm_file_alloc(minor
);
387 return PTR_ERR(priv
);
389 if (drm_is_primary_client(priv
)) {
390 ret
= drm_master_open(priv
);
397 filp
->private_data
= priv
;
398 filp
->f_mode
|= FMODE_UNSIGNED_OFFSET
;
401 mutex_lock(&dev
->filelist_mutex
);
402 list_add(&priv
->lhead
, &dev
->filelist
);
403 mutex_unlock(&dev
->filelist_mutex
);
410 struct pci_dev
*pci_dev
;
411 pci_dev
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, NULL
);
413 dev
->hose
= pci_dev
->sysdata
;
414 pci_dev_put(pci_dev
);
417 struct pci_bus
*b
= list_entry(pci_root_buses
.next
,
418 struct pci_bus
, node
);
420 dev
->hose
= b
->sysdata
;
428 static void drm_legacy_dev_reinit(struct drm_device
*dev
)
430 if (dev
->irq_enabled
)
431 drm_irq_uninstall(dev
);
433 mutex_lock(&dev
->struct_mutex
);
435 drm_legacy_agp_clear(dev
);
437 drm_legacy_sg_cleanup(dev
);
438 drm_legacy_vma_flush(dev
);
439 drm_legacy_dma_takedown(dev
);
441 mutex_unlock(&dev
->struct_mutex
);
443 dev
->sigdata
.lock
= NULL
;
445 dev
->context_flag
= 0;
446 dev
->last_context
= 0;
449 DRM_DEBUG("lastclose completed\n");
452 void drm_lastclose(struct drm_device
* dev
)
456 if (dev
->driver
->lastclose
)
457 dev
->driver
->lastclose(dev
);
458 DRM_DEBUG("driver lastclose completed\n");
460 if (drm_core_check_feature(dev
, DRIVER_LEGACY
))
461 drm_legacy_dev_reinit(dev
);
463 drm_client_dev_restore(dev
);
467 * drm_release - release method for DRM file
468 * @inode: device inode
469 * @filp: file pointer.
471 * This function must be used by drivers as their &file_operations.release
472 * method. It frees any resources associated with the open file, and calls the
473 * &drm_driver.postclose driver callback. If this is the last open file for the
474 * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
478 * Always succeeds and returns 0.
480 int drm_release(struct inode
*inode
, struct file
*filp
)
482 struct drm_file
*file_priv
= filp
->private_data
;
483 struct drm_minor
*minor
= file_priv
->minor
;
484 struct drm_device
*dev
= minor
->dev
;
486 mutex_lock(&drm_global_mutex
);
488 DRM_DEBUG("open_count = %d\n", dev
->open_count
);
490 drm_close_helper(filp
);
492 if (!--dev
->open_count
) {
494 if (drm_dev_is_unplugged(dev
))
497 mutex_unlock(&drm_global_mutex
);
499 drm_minor_release(minor
);
503 EXPORT_SYMBOL(drm_release
);
506 * drm_read - read method for DRM file
507 * @filp: file pointer
508 * @buffer: userspace destination pointer for the read
509 * @count: count in bytes to read
510 * @offset: offset to read
512 * This function must be used by drivers as their &file_operations.read
513 * method iff they use DRM events for asynchronous signalling to userspace.
514 * Since events are used by the KMS API for vblank and page flip completion this
515 * means all modern display drivers must use it.
517 * @offset is ignored, DRM events are read like a pipe. Therefore drivers also
518 * must set the &file_operation.llseek to no_llseek(). Polling support is
519 * provided by drm_poll().
521 * This function will only ever read a full event. Therefore userspace must
522 * supply a big enough buffer to fit any event to ensure forward progress. Since
523 * the maximum event space is currently 4K it's recommended to just use that for
528 * Number of bytes read (always aligned to full events, and can be 0) or a
529 * negative error code on failure.
531 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
532 size_t count
, loff_t
*offset
)
534 struct drm_file
*file_priv
= filp
->private_data
;
535 struct drm_device
*dev
= file_priv
->minor
->dev
;
538 if (!access_ok(buffer
, count
))
541 ret
= mutex_lock_interruptible(&file_priv
->event_read_lock
);
546 struct drm_pending_event
*e
= NULL
;
548 spin_lock_irq(&dev
->event_lock
);
549 if (!list_empty(&file_priv
->event_list
)) {
550 e
= list_first_entry(&file_priv
->event_list
,
551 struct drm_pending_event
, link
);
552 file_priv
->event_space
+= e
->event
->length
;
555 spin_unlock_irq(&dev
->event_lock
);
561 if (filp
->f_flags
& O_NONBLOCK
) {
566 mutex_unlock(&file_priv
->event_read_lock
);
567 ret
= wait_event_interruptible(file_priv
->event_wait
,
568 !list_empty(&file_priv
->event_list
));
570 ret
= mutex_lock_interruptible(&file_priv
->event_read_lock
);
574 unsigned length
= e
->event
->length
;
576 if (length
> count
- ret
) {
578 spin_lock_irq(&dev
->event_lock
);
579 file_priv
->event_space
-= length
;
580 list_add(&e
->link
, &file_priv
->event_list
);
581 spin_unlock_irq(&dev
->event_lock
);
585 if (copy_to_user(buffer
+ ret
, e
->event
, length
)) {
595 mutex_unlock(&file_priv
->event_read_lock
);
599 EXPORT_SYMBOL(drm_read
);
602 * drm_poll - poll method for DRM file
603 * @filp: file pointer
604 * @wait: poll waiter table
606 * This function must be used by drivers as their &file_operations.read method
607 * iff they use DRM events for asynchronous signalling to userspace. Since
608 * events are used by the KMS API for vblank and page flip completion this means
609 * all modern display drivers must use it.
611 * See also drm_read().
615 * Mask of POLL flags indicating the current status of the file.
617 __poll_t
drm_poll(struct file
*filp
, struct poll_table_struct
*wait
)
619 struct drm_file
*file_priv
= filp
->private_data
;
622 poll_wait(filp
, &file_priv
->event_wait
, wait
);
624 if (!list_empty(&file_priv
->event_list
))
625 mask
|= EPOLLIN
| EPOLLRDNORM
;
629 EXPORT_SYMBOL(drm_poll
);
632 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
634 * @file_priv: DRM file private data
635 * @p: tracking structure for the pending event
636 * @e: actual event data to deliver to userspace
638 * This function prepares the passed in event for eventual delivery. If the event
639 * doesn't get delivered (because the IOCTL fails later on, before queuing up
640 * anything) then the even must be cancelled and freed using
641 * drm_event_cancel_free(). Successfully initialized events should be sent out
642 * using drm_send_event() or drm_send_event_locked() to signal completion of the
643 * asynchronous event to userspace.
645 * If callers embedded @p into a larger structure it must be allocated with
646 * kmalloc and @p must be the first member element.
648 * This is the locked version of drm_event_reserve_init() for callers which
649 * already hold &drm_device.event_lock.
653 * 0 on success or a negative error code on failure.
655 int drm_event_reserve_init_locked(struct drm_device
*dev
,
656 struct drm_file
*file_priv
,
657 struct drm_pending_event
*p
,
660 if (file_priv
->event_space
< e
->length
)
663 file_priv
->event_space
-= e
->length
;
666 list_add(&p
->pending_link
, &file_priv
->pending_event_list
);
667 p
->file_priv
= file_priv
;
671 EXPORT_SYMBOL(drm_event_reserve_init_locked
);
674 * drm_event_reserve_init - init a DRM event and reserve space for it
676 * @file_priv: DRM file private data
677 * @p: tracking structure for the pending event
678 * @e: actual event data to deliver to userspace
680 * This function prepares the passed in event for eventual delivery. If the event
681 * doesn't get delivered (because the IOCTL fails later on, before queuing up
682 * anything) then the even must be cancelled and freed using
683 * drm_event_cancel_free(). Successfully initialized events should be sent out
684 * using drm_send_event() or drm_send_event_locked() to signal completion of the
685 * asynchronous event to userspace.
687 * If callers embedded @p into a larger structure it must be allocated with
688 * kmalloc and @p must be the first member element.
690 * Callers which already hold &drm_device.event_lock should use
691 * drm_event_reserve_init_locked() instead.
695 * 0 on success or a negative error code on failure.
697 int drm_event_reserve_init(struct drm_device
*dev
,
698 struct drm_file
*file_priv
,
699 struct drm_pending_event
*p
,
705 spin_lock_irqsave(&dev
->event_lock
, flags
);
706 ret
= drm_event_reserve_init_locked(dev
, file_priv
, p
, e
);
707 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
711 EXPORT_SYMBOL(drm_event_reserve_init
);
714 * drm_event_cancel_free - free a DRM event and release its space
716 * @p: tracking structure for the pending event
718 * This function frees the event @p initialized with drm_event_reserve_init()
719 * and releases any allocated space. It is used to cancel an event when the
720 * nonblocking operation could not be submitted and needed to be aborted.
722 void drm_event_cancel_free(struct drm_device
*dev
,
723 struct drm_pending_event
*p
)
726 spin_lock_irqsave(&dev
->event_lock
, flags
);
728 p
->file_priv
->event_space
+= p
->event
->length
;
729 list_del(&p
->pending_link
);
731 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
734 dma_fence_put(p
->fence
);
738 EXPORT_SYMBOL(drm_event_cancel_free
);
741 * drm_send_event_locked - send DRM event to file descriptor
743 * @e: DRM event to deliver
745 * This function sends the event @e, initialized with drm_event_reserve_init(),
746 * to its associated userspace DRM file. Callers must already hold
747 * &drm_device.event_lock, see drm_send_event() for the unlocked version.
749 * Note that the core will take care of unlinking and disarming events when the
750 * corresponding DRM file is closed. Drivers need not worry about whether the
751 * DRM file for this event still exists and can call this function upon
752 * completion of the asynchronous work unconditionally.
754 void drm_send_event_locked(struct drm_device
*dev
, struct drm_pending_event
*e
)
756 assert_spin_locked(&dev
->event_lock
);
759 complete_all(e
->completion
);
760 e
->completion_release(e
->completion
);
761 e
->completion
= NULL
;
765 dma_fence_signal(e
->fence
);
766 dma_fence_put(e
->fence
);
774 list_del(&e
->pending_link
);
775 list_add_tail(&e
->link
,
776 &e
->file_priv
->event_list
);
777 wake_up_interruptible(&e
->file_priv
->event_wait
);
779 EXPORT_SYMBOL(drm_send_event_locked
);
782 * drm_send_event - send DRM event to file descriptor
784 * @e: DRM event to deliver
786 * This function sends the event @e, initialized with drm_event_reserve_init(),
787 * to its associated userspace DRM file. This function acquires
788 * &drm_device.event_lock, see drm_send_event_locked() for callers which already
791 * Note that the core will take care of unlinking and disarming events when the
792 * corresponding DRM file is closed. Drivers need not worry about whether the
793 * DRM file for this event still exists and can call this function upon
794 * completion of the asynchronous work unconditionally.
796 void drm_send_event(struct drm_device
*dev
, struct drm_pending_event
*e
)
798 unsigned long irqflags
;
800 spin_lock_irqsave(&dev
->event_lock
, irqflags
);
801 drm_send_event_locked(dev
, e
);
802 spin_unlock_irqrestore(&dev
->event_lock
, irqflags
);
804 EXPORT_SYMBOL(drm_send_event
);