Loading...
1/*
2 * \author Rickard E. (Rik) Faith <faith@valinux.com>
3 * \author Daryll Strauss <daryll@valinux.com>
4 * \author Gareth Hughes <gareth@valinux.com>
5 */
6
7/*
8 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
9 *
10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * All Rights Reserved.
13 *
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:
20 *
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
23 * Software.
24 *
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.
32 */
33
34#include <linux/poll.h>
35#include <linux/slab.h>
36#include <linux/module.h>
37
38#include <drm/drm_file.h>
39#include <drm/drmP.h>
40
41#include "drm_legacy.h"
42#include "drm_internal.h"
43#include "drm_crtc_internal.h"
44
45/* from BKL pushdown */
46DEFINE_MUTEX(drm_global_mutex);
47
48/**
49 * DOC: file operations
50 *
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.
61 *
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.
67 *
68 * For the driver-side event interface see drm_event_reserve_init() and
69 * drm_send_event() as the main starting points.
70 *
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().
76 *
77 * No other file operations are supported by the DRM userspace API. Overall the
78 * following is an example &file_operations structure::
79 *
80 * static const example_drm_fops = {
81 * .owner = THIS_MODULE,
82 * .open = drm_open,
83 * .release = drm_release,
84 * .unlocked_ioctl = drm_ioctl,
85 * .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
86 * .poll = drm_poll,
87 * .read = drm_read,
88 * .llseek = no_llseek,
89 * .mmap = drm_gem_mmap,
90 * };
91 *
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
94 * simpler.
95 *
96 * The driver's &file_operations must be stored in &drm_driver.fops.
97 *
98 * For driver-private IOCTL handling see the more detailed discussion in
99 * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
100 */
101
102static int drm_open_helper(struct file *filp, struct drm_minor *minor);
103
104static int drm_setup(struct drm_device * dev)
105{
106 int ret;
107
108 if (dev->driver->firstopen &&
109 drm_core_check_feature(dev, DRIVER_LEGACY)) {
110 ret = dev->driver->firstopen(dev);
111 if (ret != 0)
112 return ret;
113 }
114
115 ret = drm_legacy_dma_setup(dev);
116 if (ret < 0)
117 return ret;
118
119
120 DRM_DEBUG("\n");
121 return 0;
122}
123
124/**
125 * drm_open - open method for DRM file
126 * @inode: device inode
127 * @filp: file pointer.
128 *
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.
132 *
133 * RETURNS:
134 *
135 * 0 on success or negative errno value on falure.
136 */
137int drm_open(struct inode *inode, struct file *filp)
138{
139 struct drm_device *dev;
140 struct drm_minor *minor;
141 int retcode;
142 int need_setup = 0;
143
144 minor = drm_minor_acquire(iminor(inode));
145 if (IS_ERR(minor))
146 return PTR_ERR(minor);
147
148 dev = minor->dev;
149 if (!dev->open_count++)
150 need_setup = 1;
151
152 /* share address_space across all char-devs of a single device */
153 filp->f_mapping = dev->anon_inode->i_mapping;
154
155 retcode = drm_open_helper(filp, minor);
156 if (retcode)
157 goto err_undo;
158 if (need_setup) {
159 retcode = drm_setup(dev);
160 if (retcode)
161 goto err_undo;
162 }
163 return 0;
164
165err_undo:
166 dev->open_count--;
167 drm_minor_release(minor);
168 return retcode;
169}
170EXPORT_SYMBOL(drm_open);
171
172/*
173 * Check whether DRI will run on this CPU.
174 *
175 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
176 */
177static int drm_cpu_valid(void)
178{
179#if defined(__sparc__) && !defined(__sparc_v9__)
180 return 0; /* No cmpxchg before v9 sparc. */
181#endif
182 return 1;
183}
184
185/*
186 * Called whenever a process opens /dev/drm.
187 *
188 * \param filp file pointer.
189 * \param minor acquired minor-object.
190 * \return zero on success or a negative number on failure.
191 *
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.
194 */
195static int drm_open_helper(struct file *filp, struct drm_minor *minor)
196{
197 struct drm_device *dev = minor->dev;
198 struct drm_file *priv;
199 int ret;
200
201 if (filp->f_flags & O_EXCL)
202 return -EBUSY; /* No exclusive opens */
203 if (!drm_cpu_valid())
204 return -EINVAL;
205 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
206 return -EINVAL;
207
208 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
209
210 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
211 if (!priv)
212 return -ENOMEM;
213
214 filp->private_data = priv;
215 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
216 priv->filp = filp;
217 priv->pid = get_pid(task_pid(current));
218 priv->minor = minor;
219
220 /* for compatibility root is always authenticated */
221 priv->authenticated = capable(CAP_SYS_ADMIN);
222 priv->lock_count = 0;
223
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 */
232
233 mutex_init(&priv->event_read_lock);
234
235 if (drm_core_check_feature(dev, DRIVER_GEM))
236 drm_gem_open(dev, priv);
237
238 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
239 drm_syncobj_open(priv);
240
241 if (drm_core_check_feature(dev, DRIVER_PRIME))
242 drm_prime_init_file_private(&priv->prime);
243
244 if (dev->driver->open) {
245 ret = dev->driver->open(dev, priv);
246 if (ret < 0)
247 goto out_prime_destroy;
248 }
249
250 if (drm_is_primary_client(priv)) {
251 ret = drm_master_open(priv);
252 if (ret)
253 goto out_close;
254 }
255
256 mutex_lock(&dev->filelist_mutex);
257 list_add(&priv->lhead, &dev->filelist);
258 mutex_unlock(&dev->filelist_mutex);
259
260#ifdef __alpha__
261 /*
262 * Default the hose
263 */
264 if (!dev->hose) {
265 struct pci_dev *pci_dev;
266 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
267 if (pci_dev) {
268 dev->hose = pci_dev->sysdata;
269 pci_dev_put(pci_dev);
270 }
271 if (!dev->hose) {
272 struct pci_bus *b = list_entry(pci_root_buses.next,
273 struct pci_bus, node);
274 if (b)
275 dev->hose = b->sysdata;
276 }
277 }
278#endif
279
280 return 0;
281
282out_close:
283 if (dev->driver->postclose)
284 dev->driver->postclose(dev, priv);
285out_prime_destroy:
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);
292 put_pid(priv->pid);
293 kfree(priv);
294 filp->private_data = NULL;
295 return ret;
296}
297
298static void drm_events_release(struct drm_file *file_priv)
299{
300 struct drm_device *dev = file_priv->minor->dev;
301 struct drm_pending_event *e, *et;
302 unsigned long flags;
303
304 spin_lock_irqsave(&dev->event_lock, flags);
305
306 /* Unlink pending events */
307 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
308 pending_link) {
309 list_del(&e->pending_link);
310 e->file_priv = NULL;
311 }
312
313 /* Remove unconsumed events */
314 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
315 list_del(&e->link);
316 kfree(e);
317 }
318
319 spin_unlock_irqrestore(&dev->event_lock, flags);
320}
321
322static void drm_legacy_dev_reinit(struct drm_device *dev)
323{
324 if (dev->irq_enabled)
325 drm_irq_uninstall(dev);
326
327 mutex_lock(&dev->struct_mutex);
328
329 drm_legacy_agp_clear(dev);
330
331 drm_legacy_sg_cleanup(dev);
332 drm_legacy_vma_flush(dev);
333 drm_legacy_dma_takedown(dev);
334
335 mutex_unlock(&dev->struct_mutex);
336
337 dev->sigdata.lock = NULL;
338
339 dev->context_flag = 0;
340 dev->last_context = 0;
341 dev->if_version = 0;
342
343 DRM_DEBUG("lastclose completed\n");
344}
345
346void drm_lastclose(struct drm_device * dev)
347{
348 DRM_DEBUG("\n");
349
350 if (dev->driver->lastclose)
351 dev->driver->lastclose(dev);
352 DRM_DEBUG("driver lastclose completed\n");
353
354 if (drm_core_check_feature(dev, DRIVER_LEGACY))
355 drm_legacy_dev_reinit(dev);
356}
357
358/**
359 * drm_release - release method for DRM file
360 * @inode: device inode
361 * @filp: file pointer.
362 *
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.
367 *
368 * RETURNS:
369 *
370 * Always succeeds and returns 0.
371 */
372int drm_release(struct inode *inode, struct file *filp)
373{
374 struct drm_file *file_priv = filp->private_data;
375 struct drm_minor *minor = file_priv->minor;
376 struct drm_device *dev = minor->dev;
377
378 mutex_lock(&drm_global_mutex);
379
380 DRM_DEBUG("open_count = %d\n", dev->open_count);
381
382 mutex_lock(&dev->filelist_mutex);
383 list_del(&file_priv->lhead);
384 mutex_unlock(&dev->filelist_mutex);
385
386 if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
387 dev->driver->preclose)
388 dev->driver->preclose(dev, file_priv);
389
390 /* ========================================================
391 * Begin inline drm_release
392 */
393
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),
397 dev->open_count);
398
399 if (drm_core_check_feature(dev, DRIVER_LEGACY))
400 drm_legacy_lock_release(dev, filp);
401
402 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
403 drm_legacy_reclaim_buffers(dev, file_priv);
404
405 drm_events_release(file_priv);
406
407 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
408 drm_fb_release(file_priv);
409 drm_property_destroy_user_blobs(dev, file_priv);
410 }
411
412 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
413 drm_syncobj_release(file_priv);
414
415 if (drm_core_check_feature(dev, DRIVER_GEM))
416 drm_gem_release(dev, file_priv);
417
418 drm_legacy_ctxbitmap_flush(dev, file_priv);
419
420 if (drm_is_primary_client(file_priv))
421 drm_master_release(file_priv);
422
423 if (dev->driver->postclose)
424 dev->driver->postclose(dev, file_priv);
425
426 if (drm_core_check_feature(dev, DRIVER_PRIME))
427 drm_prime_destroy_file_private(&file_priv->prime);
428
429 WARN_ON(!list_empty(&file_priv->event_list));
430
431 put_pid(file_priv->pid);
432 kfree(file_priv);
433
434 /* ========================================================
435 * End inline drm_release
436 */
437
438 if (!--dev->open_count) {
439 drm_lastclose(dev);
440 if (drm_dev_is_unplugged(dev))
441 drm_put_dev(dev);
442 }
443 mutex_unlock(&drm_global_mutex);
444
445 drm_minor_release(minor);
446
447 return 0;
448}
449EXPORT_SYMBOL(drm_release);
450
451/**
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
457 *
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.
462 *
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().
466 *
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
470 * safety.
471 *
472 * RETURNS:
473 *
474 * Number of bytes read (always aligned to full events, and can be 0) or a
475 * negative error code on failure.
476 */
477ssize_t drm_read(struct file *filp, char __user *buffer,
478 size_t count, loff_t *offset)
479{
480 struct drm_file *file_priv = filp->private_data;
481 struct drm_device *dev = file_priv->minor->dev;
482 ssize_t ret;
483
484 if (!access_ok(VERIFY_WRITE, buffer, count))
485 return -EFAULT;
486
487 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
488 if (ret)
489 return ret;
490
491 for (;;) {
492 struct drm_pending_event *e = NULL;
493
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;
499 list_del(&e->link);
500 }
501 spin_unlock_irq(&dev->event_lock);
502
503 if (e == NULL) {
504 if (ret)
505 break;
506
507 if (filp->f_flags & O_NONBLOCK) {
508 ret = -EAGAIN;
509 break;
510 }
511
512 mutex_unlock(&file_priv->event_read_lock);
513 ret = wait_event_interruptible(file_priv->event_wait,
514 !list_empty(&file_priv->event_list));
515 if (ret >= 0)
516 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
517 if (ret)
518 return ret;
519 } else {
520 unsigned length = e->event->length;
521
522 if (length > count - ret) {
523put_back_event:
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);
528 break;
529 }
530
531 if (copy_to_user(buffer + ret, e->event, length)) {
532 if (ret == 0)
533 ret = -EFAULT;
534 goto put_back_event;
535 }
536
537 ret += length;
538 kfree(e);
539 }
540 }
541 mutex_unlock(&file_priv->event_read_lock);
542
543 return ret;
544}
545EXPORT_SYMBOL(drm_read);
546
547/**
548 * drm_poll - poll method for DRM file
549 * @filp: file pointer
550 * @wait: poll waiter table
551 *
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.
556 *
557 * See also drm_read().
558 *
559 * RETURNS:
560 *
561 * Mask of POLL flags indicating the current status of the file.
562 */
563__poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
564{
565 struct drm_file *file_priv = filp->private_data;
566 __poll_t mask = 0;
567
568 poll_wait(filp, &file_priv->event_wait, wait);
569
570 if (!list_empty(&file_priv->event_list))
571 mask |= EPOLLIN | EPOLLRDNORM;
572
573 return mask;
574}
575EXPORT_SYMBOL(drm_poll);
576
577/**
578 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
579 * @dev: DRM device
580 * @file_priv: DRM file private data
581 * @p: tracking structure for the pending event
582 * @e: actual event data to deliver to userspace
583 *
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.
590 *
591 * If callers embedded @p into a larger structure it must be allocated with
592 * kmalloc and @p must be the first member element.
593 *
594 * This is the locked version of drm_event_reserve_init() for callers which
595 * already hold &drm_device.event_lock.
596 *
597 * RETURNS:
598 *
599 * 0 on success or a negative error code on failure.
600 */
601int drm_event_reserve_init_locked(struct drm_device *dev,
602 struct drm_file *file_priv,
603 struct drm_pending_event *p,
604 struct drm_event *e)
605{
606 if (file_priv->event_space < e->length)
607 return -ENOMEM;
608
609 file_priv->event_space -= e->length;
610
611 p->event = e;
612 list_add(&p->pending_link, &file_priv->pending_event_list);
613 p->file_priv = file_priv;
614
615 return 0;
616}
617EXPORT_SYMBOL(drm_event_reserve_init_locked);
618
619/**
620 * drm_event_reserve_init - init a DRM event and reserve space for it
621 * @dev: DRM device
622 * @file_priv: DRM file private data
623 * @p: tracking structure for the pending event
624 * @e: actual event data to deliver to userspace
625 *
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.
632 *
633 * If callers embedded @p into a larger structure it must be allocated with
634 * kmalloc and @p must be the first member element.
635 *
636 * Callers which already hold &drm_device.event_lock should use
637 * drm_event_reserve_init_locked() instead.
638 *
639 * RETURNS:
640 *
641 * 0 on success or a negative error code on failure.
642 */
643int drm_event_reserve_init(struct drm_device *dev,
644 struct drm_file *file_priv,
645 struct drm_pending_event *p,
646 struct drm_event *e)
647{
648 unsigned long flags;
649 int ret;
650
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);
654
655 return ret;
656}
657EXPORT_SYMBOL(drm_event_reserve_init);
658
659/**
660 * drm_event_cancel_free - free a DRM event and release it's space
661 * @dev: DRM device
662 * @p: tracking structure for the pending event
663 *
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.
667 */
668void drm_event_cancel_free(struct drm_device *dev,
669 struct drm_pending_event *p)
670{
671 unsigned long flags;
672 spin_lock_irqsave(&dev->event_lock, flags);
673 if (p->file_priv) {
674 p->file_priv->event_space += p->event->length;
675 list_del(&p->pending_link);
676 }
677 spin_unlock_irqrestore(&dev->event_lock, flags);
678
679 if (p->fence)
680 dma_fence_put(p->fence);
681
682 kfree(p);
683}
684EXPORT_SYMBOL(drm_event_cancel_free);
685
686/**
687 * drm_send_event_locked - send DRM event to file descriptor
688 * @dev: DRM device
689 * @e: DRM event to deliver
690 *
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.
694 *
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.
699 */
700void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
701{
702 assert_spin_locked(&dev->event_lock);
703
704 if (e->completion) {
705 complete_all(e->completion);
706 e->completion_release(e->completion);
707 e->completion = NULL;
708 }
709
710 if (e->fence) {
711 dma_fence_signal(e->fence);
712 dma_fence_put(e->fence);
713 }
714
715 if (!e->file_priv) {
716 kfree(e);
717 return;
718 }
719
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);
724}
725EXPORT_SYMBOL(drm_send_event_locked);
726
727/**
728 * drm_send_event - send DRM event to file descriptor
729 * @dev: DRM device
730 * @e: DRM event to deliver
731 *
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
735 * hold this lock.
736 *
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.
741 */
742void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
743{
744 unsigned long irqflags;
745
746 spin_lock_irqsave(&dev->event_lock, irqflags);
747 drm_send_event_locked(dev, e);
748 spin_unlock_irqrestore(&dev->event_lock, irqflags);
749}
750EXPORT_SYMBOL(drm_send_event);
1/*
2 * \author Rickard E. (Rik) Faith <faith@valinux.com>
3 * \author Daryll Strauss <daryll@valinux.com>
4 * \author Gareth Hughes <gareth@valinux.com>
5 */
6
7/*
8 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
9 *
10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * All Rights Reserved.
13 *
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:
20 *
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
23 * Software.
24 *
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.
32 */
33
34#include <linux/anon_inodes.h>
35#include <linux/dma-fence.h>
36#include <linux/file.h>
37#include <linux/module.h>
38#include <linux/pci.h>
39#include <linux/poll.h>
40#include <linux/slab.h>
41
42#include <drm/drm_client.h>
43#include <drm/drm_drv.h>
44#include <drm/drm_file.h>
45#include <drm/drm_print.h>
46
47#include "drm_crtc_internal.h"
48#include "drm_internal.h"
49#include "drm_legacy.h"
50
51/* from BKL pushdown */
52DEFINE_MUTEX(drm_global_mutex);
53
54bool drm_dev_needs_global_mutex(struct drm_device *dev)
55{
56 /*
57 * Legacy drivers rely on all kinds of BKL locking semantics, don't
58 * bother. They also still need BKL locking for their ioctls, so better
59 * safe than sorry.
60 */
61 if (drm_core_check_feature(dev, DRIVER_LEGACY))
62 return true;
63
64 /*
65 * The deprecated ->load callback must be called after the driver is
66 * already registered. This means such drivers rely on the BKL to make
67 * sure an open can't proceed until the driver is actually fully set up.
68 * Similar hilarity holds for the unload callback.
69 */
70 if (dev->driver->load || dev->driver->unload)
71 return true;
72
73 /*
74 * Drivers with the lastclose callback assume that it's synchronized
75 * against concurrent opens, which again needs the BKL. The proper fix
76 * is to use the drm_client infrastructure with proper locking for each
77 * client.
78 */
79 if (dev->driver->lastclose)
80 return true;
81
82 return false;
83}
84
85/**
86 * DOC: file operations
87 *
88 * Drivers must define the file operations structure that forms the DRM
89 * userspace API entry point, even though most of those operations are
90 * implemented in the DRM core. The resulting &struct file_operations must be
91 * stored in the &drm_driver.fops field. The mandatory functions are drm_open(),
92 * drm_read(), drm_ioctl() and drm_compat_ioctl() if CONFIG_COMPAT is enabled
93 * Note that drm_compat_ioctl will be NULL if CONFIG_COMPAT=n, so there's no
94 * need to sprinkle #ifdef into the code. Drivers which implement private ioctls
95 * that require 32/64 bit compatibility support must provide their own
96 * &file_operations.compat_ioctl handler that processes private ioctls and calls
97 * drm_compat_ioctl() for core ioctls.
98 *
99 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
100 * events are a generic and extensible means to send asynchronous events to
101 * userspace through the file descriptor. They are used to send vblank event and
102 * page flip completions by the KMS API. But drivers can also use it for their
103 * own needs, e.g. to signal completion of rendering.
104 *
105 * For the driver-side event interface see drm_event_reserve_init() and
106 * drm_send_event() as the main starting points.
107 *
108 * The memory mapping implementation will vary depending on how the driver
109 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
110 * function, modern drivers should use one of the provided memory-manager
111 * specific implementations. For GEM-based drivers this is drm_gem_mmap().
112 *
113 * No other file operations are supported by the DRM userspace API. Overall the
114 * following is an example &file_operations structure::
115 *
116 * static const example_drm_fops = {
117 * .owner = THIS_MODULE,
118 * .open = drm_open,
119 * .release = drm_release,
120 * .unlocked_ioctl = drm_ioctl,
121 * .compat_ioctl = drm_compat_ioctl, // NULL if CONFIG_COMPAT=n
122 * .poll = drm_poll,
123 * .read = drm_read,
124 * .llseek = no_llseek,
125 * .mmap = drm_gem_mmap,
126 * };
127 *
128 * For plain GEM based drivers there is the DEFINE_DRM_GEM_FOPS() macro, and for
129 * DMA based drivers there is the DEFINE_DRM_GEM_DMA_FOPS() macro to make this
130 * simpler.
131 *
132 * The driver's &file_operations must be stored in &drm_driver.fops.
133 *
134 * For driver-private IOCTL handling see the more detailed discussion in
135 * :ref:`IOCTL support in the userland interfaces chapter<drm_driver_ioctl>`.
136 */
137
138/**
139 * drm_file_alloc - allocate file context
140 * @minor: minor to allocate on
141 *
142 * This allocates a new DRM file context. It is not linked into any context and
143 * can be used by the caller freely. Note that the context keeps a pointer to
144 * @minor, so it must be freed before @minor is.
145 *
146 * RETURNS:
147 * Pointer to newly allocated context, ERR_PTR on failure.
148 */
149struct drm_file *drm_file_alloc(struct drm_minor *minor)
150{
151 struct drm_device *dev = minor->dev;
152 struct drm_file *file;
153 int ret;
154
155 file = kzalloc(sizeof(*file), GFP_KERNEL);
156 if (!file)
157 return ERR_PTR(-ENOMEM);
158
159 file->pid = get_pid(task_pid(current));
160 file->minor = minor;
161
162 /* for compatibility root is always authenticated */
163 file->authenticated = capable(CAP_SYS_ADMIN);
164
165 INIT_LIST_HEAD(&file->lhead);
166 INIT_LIST_HEAD(&file->fbs);
167 mutex_init(&file->fbs_lock);
168 INIT_LIST_HEAD(&file->blobs);
169 INIT_LIST_HEAD(&file->pending_event_list);
170 INIT_LIST_HEAD(&file->event_list);
171 init_waitqueue_head(&file->event_wait);
172 file->event_space = 4096; /* set aside 4k for event buffer */
173
174 spin_lock_init(&file->master_lookup_lock);
175 mutex_init(&file->event_read_lock);
176
177 if (drm_core_check_feature(dev, DRIVER_GEM))
178 drm_gem_open(dev, file);
179
180 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
181 drm_syncobj_open(file);
182
183 drm_prime_init_file_private(&file->prime);
184
185 if (dev->driver->open) {
186 ret = dev->driver->open(dev, file);
187 if (ret < 0)
188 goto out_prime_destroy;
189 }
190
191 return file;
192
193out_prime_destroy:
194 drm_prime_destroy_file_private(&file->prime);
195 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
196 drm_syncobj_release(file);
197 if (drm_core_check_feature(dev, DRIVER_GEM))
198 drm_gem_release(dev, file);
199 put_pid(file->pid);
200 kfree(file);
201
202 return ERR_PTR(ret);
203}
204
205static void drm_events_release(struct drm_file *file_priv)
206{
207 struct drm_device *dev = file_priv->minor->dev;
208 struct drm_pending_event *e, *et;
209 unsigned long flags;
210
211 spin_lock_irqsave(&dev->event_lock, flags);
212
213 /* Unlink pending events */
214 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
215 pending_link) {
216 list_del(&e->pending_link);
217 e->file_priv = NULL;
218 }
219
220 /* Remove unconsumed events */
221 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
222 list_del(&e->link);
223 kfree(e);
224 }
225
226 spin_unlock_irqrestore(&dev->event_lock, flags);
227}
228
229/**
230 * drm_file_free - free file context
231 * @file: context to free, or NULL
232 *
233 * This destroys and deallocates a DRM file context previously allocated via
234 * drm_file_alloc(). The caller must make sure to unlink it from any contexts
235 * before calling this.
236 *
237 * If NULL is passed, this is a no-op.
238 */
239void drm_file_free(struct drm_file *file)
240{
241 struct drm_device *dev;
242
243 if (!file)
244 return;
245
246 dev = file->minor->dev;
247
248 DRM_DEBUG("comm=\"%s\", pid=%d, dev=0x%lx, open_count=%d\n",
249 current->comm, task_pid_nr(current),
250 (long)old_encode_dev(file->minor->kdev->devt),
251 atomic_read(&dev->open_count));
252
253#ifdef CONFIG_DRM_LEGACY
254 if (drm_core_check_feature(dev, DRIVER_LEGACY) &&
255 dev->driver->preclose)
256 dev->driver->preclose(dev, file);
257#endif
258
259 if (drm_core_check_feature(dev, DRIVER_LEGACY))
260 drm_legacy_lock_release(dev, file->filp);
261
262 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
263 drm_legacy_reclaim_buffers(dev, file);
264
265 drm_events_release(file);
266
267 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
268 drm_fb_release(file);
269 drm_property_destroy_user_blobs(dev, file);
270 }
271
272 if (drm_core_check_feature(dev, DRIVER_SYNCOBJ))
273 drm_syncobj_release(file);
274
275 if (drm_core_check_feature(dev, DRIVER_GEM))
276 drm_gem_release(dev, file);
277
278 drm_legacy_ctxbitmap_flush(dev, file);
279
280 if (drm_is_primary_client(file))
281 drm_master_release(file);
282
283 if (dev->driver->postclose)
284 dev->driver->postclose(dev, file);
285
286 drm_prime_destroy_file_private(&file->prime);
287
288 WARN_ON(!list_empty(&file->event_list));
289
290 put_pid(file->pid);
291 kfree(file);
292}
293
294static void drm_close_helper(struct file *filp)
295{
296 struct drm_file *file_priv = filp->private_data;
297 struct drm_device *dev = file_priv->minor->dev;
298
299 mutex_lock(&dev->filelist_mutex);
300 list_del(&file_priv->lhead);
301 mutex_unlock(&dev->filelist_mutex);
302
303 drm_file_free(file_priv);
304}
305
306/*
307 * Check whether DRI will run on this CPU.
308 *
309 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
310 */
311static int drm_cpu_valid(void)
312{
313#if defined(__sparc__) && !defined(__sparc_v9__)
314 return 0; /* No cmpxchg before v9 sparc. */
315#endif
316 return 1;
317}
318
319/*
320 * Called whenever a process opens a drm node
321 *
322 * \param filp file pointer.
323 * \param minor acquired minor-object.
324 * \return zero on success or a negative number on failure.
325 *
326 * Creates and initializes a drm_file structure for the file private data in \p
327 * filp and add it into the double linked list in \p dev.
328 */
329int drm_open_helper(struct file *filp, struct drm_minor *minor)
330{
331 struct drm_device *dev = minor->dev;
332 struct drm_file *priv;
333 int ret;
334
335 if (filp->f_flags & O_EXCL)
336 return -EBUSY; /* No exclusive opens */
337 if (!drm_cpu_valid())
338 return -EINVAL;
339 if (dev->switch_power_state != DRM_SWITCH_POWER_ON &&
340 dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
341 return -EINVAL;
342
343 DRM_DEBUG("comm=\"%s\", pid=%d, minor=%d\n", current->comm,
344 task_pid_nr(current), minor->index);
345
346 priv = drm_file_alloc(minor);
347 if (IS_ERR(priv))
348 return PTR_ERR(priv);
349
350 if (drm_is_primary_client(priv)) {
351 ret = drm_master_open(priv);
352 if (ret) {
353 drm_file_free(priv);
354 return ret;
355 }
356 }
357
358 filp->private_data = priv;
359 filp->f_mode |= FMODE_UNSIGNED_OFFSET;
360 priv->filp = filp;
361
362 mutex_lock(&dev->filelist_mutex);
363 list_add(&priv->lhead, &dev->filelist);
364 mutex_unlock(&dev->filelist_mutex);
365
366#ifdef CONFIG_DRM_LEGACY
367#ifdef __alpha__
368 /*
369 * Default the hose
370 */
371 if (!dev->hose) {
372 struct pci_dev *pci_dev;
373
374 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
375 if (pci_dev) {
376 dev->hose = pci_dev->sysdata;
377 pci_dev_put(pci_dev);
378 }
379 if (!dev->hose) {
380 struct pci_bus *b = list_entry(pci_root_buses.next,
381 struct pci_bus, node);
382 if (b)
383 dev->hose = b->sysdata;
384 }
385 }
386#endif
387#endif
388
389 return 0;
390}
391
392/**
393 * drm_open - open method for DRM file
394 * @inode: device inode
395 * @filp: file pointer.
396 *
397 * This function must be used by drivers as their &file_operations.open method.
398 * It looks up the correct DRM device and instantiates all the per-file
399 * resources for it. It also calls the &drm_driver.open driver callback.
400 *
401 * RETURNS:
402 *
403 * 0 on success or negative errno value on failure.
404 */
405int drm_open(struct inode *inode, struct file *filp)
406{
407 struct drm_device *dev;
408 struct drm_minor *minor;
409 int retcode;
410 int need_setup = 0;
411
412 minor = drm_minor_acquire(iminor(inode));
413 if (IS_ERR(minor))
414 return PTR_ERR(minor);
415
416 dev = minor->dev;
417 if (drm_dev_needs_global_mutex(dev))
418 mutex_lock(&drm_global_mutex);
419
420 if (!atomic_fetch_inc(&dev->open_count))
421 need_setup = 1;
422
423 /* share address_space across all char-devs of a single device */
424 filp->f_mapping = dev->anon_inode->i_mapping;
425
426 retcode = drm_open_helper(filp, minor);
427 if (retcode)
428 goto err_undo;
429 if (need_setup) {
430 retcode = drm_legacy_setup(dev);
431 if (retcode) {
432 drm_close_helper(filp);
433 goto err_undo;
434 }
435 }
436
437 if (drm_dev_needs_global_mutex(dev))
438 mutex_unlock(&drm_global_mutex);
439
440 return 0;
441
442err_undo:
443 atomic_dec(&dev->open_count);
444 if (drm_dev_needs_global_mutex(dev))
445 mutex_unlock(&drm_global_mutex);
446 drm_minor_release(minor);
447 return retcode;
448}
449EXPORT_SYMBOL(drm_open);
450
451void drm_lastclose(struct drm_device * dev)
452{
453 DRM_DEBUG("\n");
454
455 if (dev->driver->lastclose)
456 dev->driver->lastclose(dev);
457 DRM_DEBUG("driver lastclose completed\n");
458
459 if (drm_core_check_feature(dev, DRIVER_LEGACY))
460 drm_legacy_dev_reinit(dev);
461
462 drm_client_dev_restore(dev);
463}
464
465/**
466 * drm_release - release method for DRM file
467 * @inode: device inode
468 * @filp: file pointer.
469 *
470 * This function must be used by drivers as their &file_operations.release
471 * method. It frees any resources associated with the open file, and calls the
472 * &drm_driver.postclose driver callback. If this is the last open file for the
473 * DRM device also proceeds to call the &drm_driver.lastclose driver callback.
474 *
475 * RETURNS:
476 *
477 * Always succeeds and returns 0.
478 */
479int drm_release(struct inode *inode, struct file *filp)
480{
481 struct drm_file *file_priv = filp->private_data;
482 struct drm_minor *minor = file_priv->minor;
483 struct drm_device *dev = minor->dev;
484
485 if (drm_dev_needs_global_mutex(dev))
486 mutex_lock(&drm_global_mutex);
487
488 DRM_DEBUG("open_count = %d\n", atomic_read(&dev->open_count));
489
490 drm_close_helper(filp);
491
492 if (atomic_dec_and_test(&dev->open_count))
493 drm_lastclose(dev);
494
495 if (drm_dev_needs_global_mutex(dev))
496 mutex_unlock(&drm_global_mutex);
497
498 drm_minor_release(minor);
499
500 return 0;
501}
502EXPORT_SYMBOL(drm_release);
503
504/**
505 * drm_release_noglobal - release method for DRM file
506 * @inode: device inode
507 * @filp: file pointer.
508 *
509 * This function may be used by drivers as their &file_operations.release
510 * method. It frees any resources associated with the open file prior to taking
511 * the drm_global_mutex, which then calls the &drm_driver.postclose driver
512 * callback. If this is the last open file for the DRM device also proceeds to
513 * call the &drm_driver.lastclose driver callback.
514 *
515 * RETURNS:
516 *
517 * Always succeeds and returns 0.
518 */
519int drm_release_noglobal(struct inode *inode, struct file *filp)
520{
521 struct drm_file *file_priv = filp->private_data;
522 struct drm_minor *minor = file_priv->minor;
523 struct drm_device *dev = minor->dev;
524
525 drm_close_helper(filp);
526
527 if (atomic_dec_and_mutex_lock(&dev->open_count, &drm_global_mutex)) {
528 drm_lastclose(dev);
529 mutex_unlock(&drm_global_mutex);
530 }
531
532 drm_minor_release(minor);
533
534 return 0;
535}
536EXPORT_SYMBOL(drm_release_noglobal);
537
538/**
539 * drm_read - read method for DRM file
540 * @filp: file pointer
541 * @buffer: userspace destination pointer for the read
542 * @count: count in bytes to read
543 * @offset: offset to read
544 *
545 * This function must be used by drivers as their &file_operations.read
546 * method if they use DRM events for asynchronous signalling to userspace.
547 * Since events are used by the KMS API for vblank and page flip completion this
548 * means all modern display drivers must use it.
549 *
550 * @offset is ignored, DRM events are read like a pipe. Polling support is
551 * provided by drm_poll().
552 *
553 * This function will only ever read a full event. Therefore userspace must
554 * supply a big enough buffer to fit any event to ensure forward progress. Since
555 * the maximum event space is currently 4K it's recommended to just use that for
556 * safety.
557 *
558 * RETURNS:
559 *
560 * Number of bytes read (always aligned to full events, and can be 0) or a
561 * negative error code on failure.
562 */
563ssize_t drm_read(struct file *filp, char __user *buffer,
564 size_t count, loff_t *offset)
565{
566 struct drm_file *file_priv = filp->private_data;
567 struct drm_device *dev = file_priv->minor->dev;
568 ssize_t ret;
569
570 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
571 if (ret)
572 return ret;
573
574 for (;;) {
575 struct drm_pending_event *e = NULL;
576
577 spin_lock_irq(&dev->event_lock);
578 if (!list_empty(&file_priv->event_list)) {
579 e = list_first_entry(&file_priv->event_list,
580 struct drm_pending_event, link);
581 file_priv->event_space += e->event->length;
582 list_del(&e->link);
583 }
584 spin_unlock_irq(&dev->event_lock);
585
586 if (e == NULL) {
587 if (ret)
588 break;
589
590 if (filp->f_flags & O_NONBLOCK) {
591 ret = -EAGAIN;
592 break;
593 }
594
595 mutex_unlock(&file_priv->event_read_lock);
596 ret = wait_event_interruptible(file_priv->event_wait,
597 !list_empty(&file_priv->event_list));
598 if (ret >= 0)
599 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
600 if (ret)
601 return ret;
602 } else {
603 unsigned length = e->event->length;
604
605 if (length > count - ret) {
606put_back_event:
607 spin_lock_irq(&dev->event_lock);
608 file_priv->event_space -= length;
609 list_add(&e->link, &file_priv->event_list);
610 spin_unlock_irq(&dev->event_lock);
611 wake_up_interruptible_poll(&file_priv->event_wait,
612 EPOLLIN | EPOLLRDNORM);
613 break;
614 }
615
616 if (copy_to_user(buffer + ret, e->event, length)) {
617 if (ret == 0)
618 ret = -EFAULT;
619 goto put_back_event;
620 }
621
622 ret += length;
623 kfree(e);
624 }
625 }
626 mutex_unlock(&file_priv->event_read_lock);
627
628 return ret;
629}
630EXPORT_SYMBOL(drm_read);
631
632/**
633 * drm_poll - poll method for DRM file
634 * @filp: file pointer
635 * @wait: poll waiter table
636 *
637 * This function must be used by drivers as their &file_operations.read method
638 * if they use DRM events for asynchronous signalling to userspace. Since
639 * events are used by the KMS API for vblank and page flip completion this means
640 * all modern display drivers must use it.
641 *
642 * See also drm_read().
643 *
644 * RETURNS:
645 *
646 * Mask of POLL flags indicating the current status of the file.
647 */
648__poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
649{
650 struct drm_file *file_priv = filp->private_data;
651 __poll_t mask = 0;
652
653 poll_wait(filp, &file_priv->event_wait, wait);
654
655 if (!list_empty(&file_priv->event_list))
656 mask |= EPOLLIN | EPOLLRDNORM;
657
658 return mask;
659}
660EXPORT_SYMBOL(drm_poll);
661
662/**
663 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
664 * @dev: DRM device
665 * @file_priv: DRM file private data
666 * @p: tracking structure for the pending event
667 * @e: actual event data to deliver to userspace
668 *
669 * This function prepares the passed in event for eventual delivery. If the event
670 * doesn't get delivered (because the IOCTL fails later on, before queuing up
671 * anything) then the even must be cancelled and freed using
672 * drm_event_cancel_free(). Successfully initialized events should be sent out
673 * using drm_send_event() or drm_send_event_locked() to signal completion of the
674 * asynchronous event to userspace.
675 *
676 * If callers embedded @p into a larger structure it must be allocated with
677 * kmalloc and @p must be the first member element.
678 *
679 * This is the locked version of drm_event_reserve_init() for callers which
680 * already hold &drm_device.event_lock.
681 *
682 * RETURNS:
683 *
684 * 0 on success or a negative error code on failure.
685 */
686int drm_event_reserve_init_locked(struct drm_device *dev,
687 struct drm_file *file_priv,
688 struct drm_pending_event *p,
689 struct drm_event *e)
690{
691 if (file_priv->event_space < e->length)
692 return -ENOMEM;
693
694 file_priv->event_space -= e->length;
695
696 p->event = e;
697 list_add(&p->pending_link, &file_priv->pending_event_list);
698 p->file_priv = file_priv;
699
700 return 0;
701}
702EXPORT_SYMBOL(drm_event_reserve_init_locked);
703
704/**
705 * drm_event_reserve_init - init a DRM event and reserve space for it
706 * @dev: DRM device
707 * @file_priv: DRM file private data
708 * @p: tracking structure for the pending event
709 * @e: actual event data to deliver to userspace
710 *
711 * This function prepares the passed in event for eventual delivery. If the event
712 * doesn't get delivered (because the IOCTL fails later on, before queuing up
713 * anything) then the even must be cancelled and freed using
714 * drm_event_cancel_free(). Successfully initialized events should be sent out
715 * using drm_send_event() or drm_send_event_locked() to signal completion of the
716 * asynchronous event to userspace.
717 *
718 * If callers embedded @p into a larger structure it must be allocated with
719 * kmalloc and @p must be the first member element.
720 *
721 * Callers which already hold &drm_device.event_lock should use
722 * drm_event_reserve_init_locked() instead.
723 *
724 * RETURNS:
725 *
726 * 0 on success or a negative error code on failure.
727 */
728int drm_event_reserve_init(struct drm_device *dev,
729 struct drm_file *file_priv,
730 struct drm_pending_event *p,
731 struct drm_event *e)
732{
733 unsigned long flags;
734 int ret;
735
736 spin_lock_irqsave(&dev->event_lock, flags);
737 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
738 spin_unlock_irqrestore(&dev->event_lock, flags);
739
740 return ret;
741}
742EXPORT_SYMBOL(drm_event_reserve_init);
743
744/**
745 * drm_event_cancel_free - free a DRM event and release its space
746 * @dev: DRM device
747 * @p: tracking structure for the pending event
748 *
749 * This function frees the event @p initialized with drm_event_reserve_init()
750 * and releases any allocated space. It is used to cancel an event when the
751 * nonblocking operation could not be submitted and needed to be aborted.
752 */
753void drm_event_cancel_free(struct drm_device *dev,
754 struct drm_pending_event *p)
755{
756 unsigned long flags;
757
758 spin_lock_irqsave(&dev->event_lock, flags);
759 if (p->file_priv) {
760 p->file_priv->event_space += p->event->length;
761 list_del(&p->pending_link);
762 }
763 spin_unlock_irqrestore(&dev->event_lock, flags);
764
765 if (p->fence)
766 dma_fence_put(p->fence);
767
768 kfree(p);
769}
770EXPORT_SYMBOL(drm_event_cancel_free);
771
772static void drm_send_event_helper(struct drm_device *dev,
773 struct drm_pending_event *e, ktime_t timestamp)
774{
775 assert_spin_locked(&dev->event_lock);
776
777 if (e->completion) {
778 complete_all(e->completion);
779 e->completion_release(e->completion);
780 e->completion = NULL;
781 }
782
783 if (e->fence) {
784 if (timestamp)
785 dma_fence_signal_timestamp(e->fence, timestamp);
786 else
787 dma_fence_signal(e->fence);
788 dma_fence_put(e->fence);
789 }
790
791 if (!e->file_priv) {
792 kfree(e);
793 return;
794 }
795
796 list_del(&e->pending_link);
797 list_add_tail(&e->link,
798 &e->file_priv->event_list);
799 wake_up_interruptible_poll(&e->file_priv->event_wait,
800 EPOLLIN | EPOLLRDNORM);
801}
802
803/**
804 * drm_send_event_timestamp_locked - send DRM event to file descriptor
805 * @dev: DRM device
806 * @e: DRM event to deliver
807 * @timestamp: timestamp to set for the fence event in kernel's CLOCK_MONOTONIC
808 * time domain
809 *
810 * This function sends the event @e, initialized with drm_event_reserve_init(),
811 * to its associated userspace DRM file. Callers must already hold
812 * &drm_device.event_lock.
813 *
814 * Note that the core will take care of unlinking and disarming events when the
815 * corresponding DRM file is closed. Drivers need not worry about whether the
816 * DRM file for this event still exists and can call this function upon
817 * completion of the asynchronous work unconditionally.
818 */
819void drm_send_event_timestamp_locked(struct drm_device *dev,
820 struct drm_pending_event *e, ktime_t timestamp)
821{
822 drm_send_event_helper(dev, e, timestamp);
823}
824EXPORT_SYMBOL(drm_send_event_timestamp_locked);
825
826/**
827 * drm_send_event_locked - send DRM event to file descriptor
828 * @dev: DRM device
829 * @e: DRM event to deliver
830 *
831 * This function sends the event @e, initialized with drm_event_reserve_init(),
832 * to its associated userspace DRM file. Callers must already hold
833 * &drm_device.event_lock, see drm_send_event() for the unlocked version.
834 *
835 * Note that the core will take care of unlinking and disarming events when the
836 * corresponding DRM file is closed. Drivers need not worry about whether the
837 * DRM file for this event still exists and can call this function upon
838 * completion of the asynchronous work unconditionally.
839 */
840void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
841{
842 drm_send_event_helper(dev, e, 0);
843}
844EXPORT_SYMBOL(drm_send_event_locked);
845
846/**
847 * drm_send_event - send DRM event to file descriptor
848 * @dev: DRM device
849 * @e: DRM event to deliver
850 *
851 * This function sends the event @e, initialized with drm_event_reserve_init(),
852 * to its associated userspace DRM file. This function acquires
853 * &drm_device.event_lock, see drm_send_event_locked() for callers which already
854 * hold this lock.
855 *
856 * Note that the core will take care of unlinking and disarming events when the
857 * corresponding DRM file is closed. Drivers need not worry about whether the
858 * DRM file for this event still exists and can call this function upon
859 * completion of the asynchronous work unconditionally.
860 */
861void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
862{
863 unsigned long irqflags;
864
865 spin_lock_irqsave(&dev->event_lock, irqflags);
866 drm_send_event_helper(dev, e, 0);
867 spin_unlock_irqrestore(&dev->event_lock, irqflags);
868}
869EXPORT_SYMBOL(drm_send_event);
870
871/**
872 * mock_drm_getfile - Create a new struct file for the drm device
873 * @minor: drm minor to wrap (e.g. #drm_device.primary)
874 * @flags: file creation mode (O_RDWR etc)
875 *
876 * This create a new struct file that wraps a DRM file context around a
877 * DRM minor. This mimicks userspace opening e.g. /dev/dri/card0, but without
878 * invoking userspace. The struct file may be operated on using its f_op
879 * (the drm_device.driver.fops) to mimick userspace operations, or be supplied
880 * to userspace facing functions as an internal/anonymous client.
881 *
882 * RETURNS:
883 * Pointer to newly created struct file, ERR_PTR on failure.
884 */
885struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags)
886{
887 struct drm_device *dev = minor->dev;
888 struct drm_file *priv;
889 struct file *file;
890
891 priv = drm_file_alloc(minor);
892 if (IS_ERR(priv))
893 return ERR_CAST(priv);
894
895 file = anon_inode_getfile("drm", dev->driver->fops, priv, flags);
896 if (IS_ERR(file)) {
897 drm_file_free(priv);
898 return file;
899 }
900
901 /* Everyone shares a single global address space */
902 file->f_mapping = dev->anon_inode->i_mapping;
903
904 drm_dev_get(dev);
905 priv->filp = file;
906
907 return file;
908}
909EXPORT_SYMBOL_FOR_TESTS_ONLY(mock_drm_getfile);