blob: e84faecf52251e49efdb8c53b2ccca345299dd8d [file] [log] [blame]
Daniel Vetterbcb877e2016-01-11 22:40:55 +01001/*
Dave Airlieb5e89ed2005-09-25 14:28:13 +10002 * \file drm_fops.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * File operations for DRM
Dave Airlieb5e89ed2005-09-25 14:28:13 +10004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Daryll Strauss <daryll@valinux.com>
7 * \author Gareth Hughes <gareth@valinux.com>
8 */
9
10/*
11 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
12 *
13 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
14 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
15 * All Rights Reserved.
16 *
17 * Permission is hereby granted, free of charge, to any person obtaining a
18 * copy of this software and associated documentation files (the "Software"),
19 * to deal in the Software without restriction, including without limitation
20 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21 * and/or sell copies of the Software, and to permit persons to whom the
22 * Software is furnished to do so, subject to the following conditions:
23 *
24 * The above copyright notice and this permission notice (including the next
25 * paragraph) shall be included in all copies or substantial portions of the
26 * Software.
27 *
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
31 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
32 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
33 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34 * OTHER DEALINGS IN THE SOFTWARE.
35 */
36
David Howells760285e2012-10-02 18:01:07 +010037#include <drm/drmP.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/poll.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
Paul Gortmakere0cd3602011-08-30 11:04:30 -040040#include <linux/module.h>
David Herrmanne7b960702014-07-24 12:10:04 +020041#include "drm_legacy.h"
Daniel Vetter67d0ec42014-09-10 12:43:53 +020042#include "drm_internal.h"
Daniel Vetter81065542016-06-21 10:54:13 +020043#include "drm_crtc_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
David Herrmann0d639882014-02-24 15:53:25 +010045/* from BKL pushdown */
Arnd Bergmann58374712010-07-10 23:51:39 +020046DEFINE_MUTEX(drm_global_mutex);
47
Daniel Vetterbcb877e2016-01-11 22:40:55 +010048/**
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 mandatory functions are drm_open(),
54 * drm_read(), drm_ioctl() and drm_compat_ioctl if CONFIG_COMPAT is enabled.
55 * Drivers which implement private ioctls that require 32/64 bit compatibility
56 * support must provided their onw .compat_ioctl() handler that processes
57 * private ioctls and calls drm_compat_ioctl() for core ioctls.
58 *
59 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
60 * events are a generic and extensible means to send asynchronous events to
61 * userspace through the file descriptor. They are used to send vblank event and
62 * page flip completions by the KMS API. But drivers can also use it for their
63 * own needs, e.g. to signal completion of rendering.
64 *
65 * The memory mapping implementation will vary depending on how the driver
66 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
67 * function, modern drivers should use one of the provided memory-manager
68 * specific implementations. For GEM-based drivers this is drm_gem_mmap().
69 *
70 * No other file operations are supported by the DRM userspace API. Overall the
Daniel Vetterda5335b2016-05-31 22:55:13 +020071 * following is an example #file_operations structure::
Daniel Vetterbcb877e2016-01-11 22:40:55 +010072 *
73 * static const example_drm_fops = {
74 * .owner = THIS_MODULE,
75 * .open = drm_open,
76 * .release = drm_release,
77 * .unlocked_ioctl = drm_ioctl,
78 * #ifdef CONFIG_COMPAT
79 * .compat_ioctl = drm_compat_ioctl,
80 * #endif
81 * .poll = drm_poll,
82 * .read = drm_read,
83 * .llseek = no_llseek,
84 * .mmap = drm_gem_mmap,
85 * };
86 */
87
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -040088static int drm_open_helper(struct file *filp, struct drm_minor *minor);
Dave Airliec94f7022005-07-07 21:03:38 +100089
Dave Airlie84b1fd12007-07-11 15:53:27 +100090static int drm_setup(struct drm_device * dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 int ret;
93
Daniel Vetter7d14bb6b2013-08-08 15:41:15 +020094 if (dev->driver->firstopen &&
Daniel Vetterfa538642016-08-03 21:11:10 +020095 drm_core_check_feature(dev, DRIVER_LEGACY)) {
Dave Airlie22eae942005-11-10 22:16:34 +110096 ret = dev->driver->firstopen(dev);
Dave Airlieb5e89ed2005-09-25 14:28:13 +100097 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 return ret;
99 }
100
Daniel Vetterf336ab72013-08-08 15:41:35 +0200101 ret = drm_legacy_dma_setup(dev);
102 if (ret < 0)
103 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000106 DRM_DEBUG("\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 return 0;
108}
109
110/**
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100111 * drm_open - open method for DRM file
112 * @inode: device inode
113 * @filp: file pointer.
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000114 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100115 * This function must be used by drivers as their .open() #file_operations
116 * method. It looks up the correct DRM device and instantiates all the per-file
117 * resources for it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100119 * RETURNS:
120 *
121 * 0 on success or negative errno value on falure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000123int drm_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
David Herrmann1616c522014-01-29 10:49:19 +0100125 struct drm_device *dev;
Dave Airlie2c14f282008-04-21 16:47:32 +1000126 struct drm_minor *minor;
David Herrmann1616c522014-01-29 10:49:19 +0100127 int retcode;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000128 int need_setup = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
David Herrmann1616c522014-01-29 10:49:19 +0100130 minor = drm_minor_acquire(iminor(inode));
131 if (IS_ERR(minor))
132 return PTR_ERR(minor);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000133
David Herrmann1616c522014-01-29 10:49:19 +0100134 dev = minor->dev;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000135 if (!dev->open_count++)
136 need_setup = 1;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800137
David Herrmann6796cb12014-01-03 14:24:19 +0100138 /* share address_space across all char-devs of a single device */
139 filp->f_mapping = dev->anon_inode->i_mapping;
Dave Airlied985c102006-01-02 21:32:48 +1100140
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -0400141 retcode = drm_open_helper(filp, minor);
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000142 if (retcode)
143 goto err_undo;
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000144 if (need_setup) {
145 retcode = drm_setup(dev);
146 if (retcode)
147 goto err_undo;
148 }
149 return 0;
150
151err_undo:
Ilija Hadzicfdb40a02012-10-29 17:35:01 +0000152 dev->open_count--;
David Herrmann1616c522014-01-29 10:49:19 +0100153 drm_minor_release(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 return retcode;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000155}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156EXPORT_SYMBOL(drm_open);
157
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100158/*
Dave Airlied985c102006-01-02 21:32:48 +1100159 * Check whether DRI will run on this CPU.
160 *
161 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
162 */
163static int drm_cpu_valid(void)
164{
Dave Airlied985c102006-01-02 21:32:48 +1100165#if defined(__sparc__) && !defined(__sparc_v9__)
166 return 0; /* No cmpxchg before v9 sparc. */
167#endif
168 return 1;
169}
170
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100171/*
Dave Airlied985c102006-01-02 21:32:48 +1100172 * Called whenever a process opens /dev/drm.
173 *
Dave Airlied985c102006-01-02 21:32:48 +1100174 * \param filp file pointer.
David Herrmannf4aede22014-01-29 10:18:02 +0100175 * \param minor acquired minor-object.
Dave Airlied985c102006-01-02 21:32:48 +1100176 * \return zero on success or a negative number on failure.
177 *
178 * Creates and initializes a drm_file structure for the file private data in \p
179 * filp and add it into the double linked list in \p dev.
180 */
Ilija Hadzic1dcc0ce2014-04-28 10:23:57 -0400181static int drm_open_helper(struct file *filp, struct drm_minor *minor)
Dave Airlied985c102006-01-02 21:32:48 +1100182{
David Herrmannf4aede22014-01-29 10:18:02 +0100183 struct drm_device *dev = minor->dev;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000184 struct drm_file *priv;
Dave Airlied985c102006-01-02 21:32:48 +1100185 int ret;
186
187 if (filp->f_flags & O_EXCL)
188 return -EBUSY; /* No exclusive opens */
189 if (!drm_cpu_valid())
190 return -EINVAL;
Dave Airlie13bb9cc2012-09-12 15:55:05 +1000191 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
Dave Airlie5bcf7192010-12-07 09:20:40 +1000192 return -EINVAL;
Dave Airlied985c102006-01-02 21:32:48 +1100193
David Herrmannf4aede22014-01-29 10:18:02 +0100194 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
Dave Airlied985c102006-01-02 21:32:48 +1100195
Julia Lawall6ebc22e2010-05-13 21:58:56 +0200196 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
Dave Airlied985c102006-01-02 21:32:48 +1100197 if (!priv)
198 return -ENOMEM;
199
Dave Airlied985c102006-01-02 21:32:48 +1100200 filp->private_data = priv;
Eric Anholt6c340ea2007-08-25 20:23:09 +1000201 priv->filp = filp;
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800202 priv->pid = get_pid(task_pid(current));
David Herrmannf4aede22014-01-29 10:18:02 +0100203 priv->minor = minor;
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900204
Dave Airlied985c102006-01-02 21:32:48 +1100205 /* for compatibility root is always authenticated */
David Herrmann3cb01a92014-07-22 17:12:26 +0200206 priv->authenticated = capable(CAP_SYS_ADMIN);
Dave Airlied985c102006-01-02 21:32:48 +1100207 priv->lock_count = 0;
208
Dave Airliebd1b3312007-05-26 05:01:51 +1000209 INIT_LIST_HEAD(&priv->lhead);
Dave Airlief453ba02008-11-07 14:05:41 -0800210 INIT_LIST_HEAD(&priv->fbs);
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100211 mutex_init(&priv->fbs_lock);
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100212 INIT_LIST_HEAD(&priv->blobs);
Daniel Vetter681047b2016-01-25 22:16:43 +0100213 INIT_LIST_HEAD(&priv->pending_event_list);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000214 INIT_LIST_HEAD(&priv->event_list);
215 init_waitqueue_head(&priv->event_wait);
216 priv->event_space = 4096; /* set aside 4k for event buffer */
Dave Airliebd1b3312007-05-26 05:01:51 +1000217
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000218 mutex_init(&priv->event_read_lock);
219
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200220 if (drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700221 drm_gem_open(dev, priv);
222
Dave Airlie32488772011-11-25 15:21:02 +0000223 if (drm_core_check_feature(dev, DRIVER_PRIME))
224 drm_prime_init_file_private(&priv->prime);
225
Dave Airlied985c102006-01-02 21:32:48 +1100226 if (dev->driver->open) {
227 ret = dev->driver->open(dev, priv);
228 if (ret < 0)
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900229 goto out_prime_destroy;
Dave Airlied985c102006-01-02 21:32:48 +1100230 }
231
Daniel Vetter2cbae7e2016-06-14 20:51:00 +0200232 if (drm_is_primary_client(priv)) {
233 ret = drm_master_open(priv);
Thomas Hellstroma0af2e52015-12-02 09:24:46 -0800234 if (ret)
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900235 goto out_close;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000236 }
237
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200238 mutex_lock(&dev->filelist_mutex);
Dave Airliebd1b3312007-05-26 05:01:51 +1000239 list_add(&priv->lhead, &dev->filelist);
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200240 mutex_unlock(&dev->filelist_mutex);
Dave Airlied985c102006-01-02 21:32:48 +1100241
242#ifdef __alpha__
243 /*
244 * Default the hose
245 */
246 if (!dev->hose) {
247 struct pci_dev *pci_dev;
248 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
249 if (pci_dev) {
250 dev->hose = pci_dev->sysdata;
251 pci_dev_put(pci_dev);
252 }
253 if (!dev->hose) {
Yijing Wang59c1ad3b2014-02-13 21:14:00 +0800254 struct pci_bus *b = list_entry(pci_root_buses.next,
255 struct pci_bus, node);
Dave Airlied985c102006-01-02 21:32:48 +1100256 if (b)
257 dev->hose = b->sysdata;
258 }
259 }
260#endif
261
262 return 0;
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900263
264out_close:
265 if (dev->driver->postclose)
266 dev->driver->postclose(dev, priv);
267out_prime_destroy:
268 if (drm_core_check_feature(dev, DRIVER_PRIME))
269 drm_prime_destroy_file_private(&priv->prime);
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200270 if (drm_core_check_feature(dev, DRIVER_GEM))
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900271 drm_gem_release(dev, priv);
Seung-Woo Kimdf9b6a92013-07-02 09:53:28 +0900272 put_pid(priv->pid);
Eric Anholt9a298b22009-03-24 12:23:04 -0700273 kfree(priv);
Dave Airlied985c102006-01-02 21:32:48 +1100274 filp->private_data = NULL;
275 return ret;
276}
277
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000278static void drm_events_release(struct drm_file *file_priv)
279{
280 struct drm_device *dev = file_priv->minor->dev;
281 struct drm_pending_event *e, *et;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000282 unsigned long flags;
283
284 spin_lock_irqsave(&dev->event_lock, flags);
285
Daniel Vetter681047b2016-01-25 22:16:43 +0100286 /* Unlink pending events */
287 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
288 pending_link) {
289 list_del(&e->pending_link);
290 e->file_priv = NULL;
291 }
292
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000293 /* Remove unconsumed events */
YoungJun Cho1dda6802013-10-29 20:30:26 +0900294 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
295 list_del(&e->link);
Gustavo Padovan1b47aaf2016-06-02 00:06:35 +0200296 kfree(e);
YoungJun Cho1dda6802013-10-29 20:30:26 +0900297 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000298
299 spin_unlock_irqrestore(&dev->event_lock, flags);
300}
301
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100302/*
David Herrmann1c8887d2013-10-02 11:23:36 +0200303 * drm_legacy_dev_reinit
304 *
305 * Reinitializes a legacy/ums drm device in it's lastclose function.
306 */
307static void drm_legacy_dev_reinit(struct drm_device *dev)
308{
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200309 if (dev->irq_enabled)
David Herrmann1c8887d2013-10-02 11:23:36 +0200310 drm_irq_uninstall(dev);
311
312 mutex_lock(&dev->struct_mutex);
313
Daniel Vetter366884b2016-04-26 19:29:34 +0200314 drm_legacy_agp_clear(dev);
David Herrmann1c8887d2013-10-02 11:23:36 +0200315
316 drm_legacy_sg_cleanup(dev);
David Herrmann03decbe2014-08-29 12:12:29 +0200317 drm_legacy_vma_flush(dev);
David Herrmann1c8887d2013-10-02 11:23:36 +0200318 drm_legacy_dma_takedown(dev);
319
David Herrmann1c8887d2013-10-02 11:23:36 +0200320 mutex_unlock(&dev->struct_mutex);
321
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200322 dev->sigdata.lock = NULL;
323
324 dev->context_flag = 0;
325 dev->last_context = 0;
326 dev->if_version = 0;
David Herrmann1c8887d2013-10-02 11:23:36 +0200327
328 DRM_DEBUG("lastclose completed\n");
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200329}
330
331/*
332 * Take down the DRM device.
333 *
334 * \param dev DRM device structure.
335 *
336 * Frees every resource in \p dev.
337 *
338 * \sa drm_device
339 */
340void drm_lastclose(struct drm_device * dev)
341{
342 DRM_DEBUG("\n");
343
344 if (dev->driver->lastclose)
345 dev->driver->lastclose(dev);
346 DRM_DEBUG("driver lastclose completed\n");
347
Daniel Vetterfa538642016-08-03 21:11:10 +0200348 if (drm_core_check_feature(dev, DRIVER_LEGACY))
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200349 drm_legacy_dev_reinit(dev);
David Herrmann1c8887d2013-10-02 11:23:36 +0200350}
351
352/**
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100353 * drm_release - release method for DRM file
354 * @inode: device inode
355 * @filp: file pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100357 * This function must be used by drivers as their .release() #file_operations
358 * method. It frees any resources associated with the open file, and if this is
359 * the last open file for the DRM device also proceeds to call drm_lastclose().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 *
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100361 * RETURNS:
362 *
363 * Always succeeds and returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000365int drm_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
Eric Anholt6c340ea2007-08-25 20:23:09 +1000367 struct drm_file *file_priv = filp->private_data;
David Herrmann1616c522014-01-29 10:49:19 +0100368 struct drm_minor *minor = file_priv->minor;
369 struct drm_device *dev = minor->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Arnd Bergmann58374712010-07-10 23:51:39 +0200371 mutex_lock(&drm_global_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000373 DRM_DEBUG("open_count = %d\n", dev->open_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200375 mutex_lock(&dev->filelist_mutex);
Chris Wilsondff01de2014-07-24 14:23:10 +0100376 list_del(&file_priv->lhead);
Daniel Vetter1d2ac402016-04-26 19:29:41 +0200377 mutex_unlock(&dev->filelist_mutex);
378
Dave Airlie22eae942005-11-10 22:16:34 +1100379 if (dev->driver->preclose)
Eric Anholt6c340ea2007-08-25 20:23:09 +1000380 dev->driver->preclose(dev, file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382 /* ========================================================
383 * Begin inline drm_release
384 */
385
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000386 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700387 task_pid_nr(current),
David Herrmann58178782014-01-29 13:12:31 +0100388 (long)old_encode_dev(file_priv->minor->kdev->devt),
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000389 dev->open_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Daniel Vetterfa538642016-08-03 21:11:10 +0200391 if (drm_core_check_feature(dev, DRIVER_LEGACY))
Daniel Vetter1a75a222016-06-14 20:50:57 +0200392 drm_legacy_lock_release(dev, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Daniel Vetter67cb4b42011-10-26 00:31:26 +0200394 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
Daniel Vettera2661622014-09-11 07:41:51 +0200395 drm_legacy_reclaim_buffers(dev, file_priv);
Daniel Vetter67cb4b42011-10-26 00:31:26 +0200396
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000397 drm_events_release(file_priv);
398
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100399 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500400 drm_fb_release(file_priv);
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100401 drm_property_destroy_user_blobs(dev, file_priv);
402 }
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500403
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200404 if (drm_core_check_feature(dev, DRIVER_GEM))
Prathyush4e47e022012-04-14 17:22:13 +0530405 drm_gem_release(dev, file_priv);
406
David Herrmanne7b960702014-07-24 12:10:04 +0200407 drm_legacy_ctxbitmap_flush(dev, file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Daniel Vetter14d71eb2016-06-14 20:51:01 +0200409 if (drm_is_primary_client(file_priv))
410 drm_master_release(file_priv);
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100411
Dave Airlie22eae942005-11-10 22:16:34 +1100412 if (dev->driver->postclose)
Eric Anholt6c340ea2007-08-25 20:23:09 +1000413 dev->driver->postclose(dev, file_priv);
Dave Airlie32488772011-11-25 15:21:02 +0000414
415 if (drm_core_check_feature(dev, DRIVER_PRIME))
416 drm_prime_destroy_file_private(&file_priv->prime);
417
Ville Syrjäläddde4372014-08-06 14:02:50 +0300418 WARN_ON(!list_empty(&file_priv->event_list));
419
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800420 put_pid(file_priv->pid);
Eric Anholt9a298b22009-03-24 12:23:04 -0700421 kfree(file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 /* ========================================================
424 * End inline drm_release
425 */
426
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000427 if (!--dev->open_count) {
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200428 drm_lastclose(dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000429 if (drm_device_is_unplugged(dev))
430 drm_put_dev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 }
Arnd Bergmann58374712010-07-10 23:51:39 +0200432 mutex_unlock(&drm_global_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
David Herrmann1616c522014-01-29 10:49:19 +0100434 drm_minor_release(minor);
435
Daniel Vetter68dfbeb2016-04-26 19:29:35 +0200436 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437}
438EXPORT_SYMBOL(drm_release);
439
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100440/**
441 * drm_read - read method for DRM file
442 * @filp: file pointer
443 * @buffer: userspace destination pointer for the read
444 * @count: count in bytes to read
445 * @offset: offset to read
446 *
447 * This function must be used by drivers as their .read() #file_operations
448 * method iff they use DRM events for asynchronous signalling to userspace.
449 * Since events are used by the KMS API for vblank and page flip completion this
450 * means all modern display drivers must use it.
451 *
452 * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
453 * must set the .llseek() #file_operation to no_llseek(). Polling support is
454 * provided by drm_poll().
455 *
456 * This function will only ever read a full event. Therefore userspace must
457 * supply a big enough buffer to fit any event to ensure forward progress. Since
458 * the maximum event space is currently 4K it's recommended to just use that for
459 * safety.
460 *
461 * RETURNS:
462 *
463 * Number of bytes read (always aligned to full events, and can be 0) or a
464 * negative error code on failure.
465 */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000466ssize_t drm_read(struct file *filp, char __user *buffer,
467 size_t count, loff_t *offset)
468{
469 struct drm_file *file_priv = filp->private_data;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000470 struct drm_device *dev = file_priv->minor->dev;
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000471 ssize_t ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000472
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000473 if (!access_ok(VERIFY_WRITE, buffer, count))
474 return -EFAULT;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000475
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000476 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
477 if (ret)
478 return ret;
479
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000480 for (;;) {
Chris Wilson83eb64c2015-11-25 14:39:02 +0000481 struct drm_pending_event *e = NULL;
482
483 spin_lock_irq(&dev->event_lock);
484 if (!list_empty(&file_priv->event_list)) {
485 e = list_first_entry(&file_priv->event_list,
486 struct drm_pending_event, link);
487 file_priv->event_space += e->event->length;
488 list_del(&e->link);
489 }
490 spin_unlock_irq(&dev->event_lock);
491
492 if (e == NULL) {
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000493 if (ret)
494 break;
495
496 if (filp->f_flags & O_NONBLOCK) {
497 ret = -EAGAIN;
498 break;
499 }
500
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000501 mutex_unlock(&file_priv->event_read_lock);
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000502 ret = wait_event_interruptible(file_priv->event_wait,
503 !list_empty(&file_priv->event_list));
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000504 if (ret >= 0)
505 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
506 if (ret)
507 return ret;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000508 } else {
Chris Wilson83eb64c2015-11-25 14:39:02 +0000509 unsigned length = e->event->length;
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000510
Chris Wilson83eb64c2015-11-25 14:39:02 +0000511 if (length > count - ret) {
512put_back_event:
513 spin_lock_irq(&dev->event_lock);
514 file_priv->event_space -= length;
515 list_add(&e->link, &file_priv->event_list);
516 spin_unlock_irq(&dev->event_lock);
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000517 break;
518 }
519
Chris Wilson83eb64c2015-11-25 14:39:02 +0000520 if (copy_to_user(buffer + ret, e->event, length)) {
521 if (ret == 0)
522 ret = -EFAULT;
523 goto put_back_event;
524 }
525
526 ret += length;
Gustavo Padovan1b47aaf2016-06-02 00:06:35 +0200527 kfree(e);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000528 }
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000529 }
Chris Wilson9b2c0b72015-11-25 14:39:03 +0000530 mutex_unlock(&file_priv->event_read_lock);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000531
Chris Wilsoncdd1cf72014-12-04 21:03:25 +0000532 return ret;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000533}
534EXPORT_SYMBOL(drm_read);
535
Daniel Vetterbcb877e2016-01-11 22:40:55 +0100536/**
537 * drm_poll - poll method for DRM file
538 * @filp: file pointer
539 * @wait: poll waiter table
540 *
541 * This function must be used by drivers as their .read() #file_operations
542 * method iff they use DRM events for asynchronous signalling to userspace.
543 * Since events are used by the KMS API for vblank and page flip completion this
544 * means all modern display drivers must use it.
545 *
546 * See also drm_read().
547 *
548 * RETURNS:
549 *
550 * Mask of POLL flags indicating the current status of the file.
551 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
553{
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000554 struct drm_file *file_priv = filp->private_data;
555 unsigned int mask = 0;
556
557 poll_wait(filp, &file_priv->event_wait, wait);
558
559 if (!list_empty(&file_priv->event_list))
560 mask |= POLLIN | POLLRDNORM;
561
562 return mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563}
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000564EXPORT_SYMBOL(drm_poll);
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100565
566/**
Daniel Vetter4020b222016-01-28 12:01:04 +0100567 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
568 * @dev: DRM device
569 * @file_priv: DRM file private data
570 * @p: tracking structure for the pending event
571 * @e: actual event data to deliver to userspace
572 *
573 * This function prepares the passed in event for eventual delivery. If the event
574 * doesn't get delivered (because the IOCTL fails later on, before queuing up
575 * anything) then the even must be cancelled and freed using
576 * drm_event_cancel_free(). Successfully initialized events should be sent out
577 * using drm_send_event() or drm_send_event_locked() to signal completion of the
578 * asynchronous event to userspace.
579 *
580 * If callers embedded @p into a larger structure it must be allocated with
581 * kmalloc and @p must be the first member element.
582 *
583 * This is the locked version of drm_event_reserve_init() for callers which
584 * already hold dev->event_lock.
585 *
586 * RETURNS:
587 *
588 * 0 on success or a negative error code on failure.
589 */
590int drm_event_reserve_init_locked(struct drm_device *dev,
591 struct drm_file *file_priv,
592 struct drm_pending_event *p,
593 struct drm_event *e)
594{
595 if (file_priv->event_space < e->length)
596 return -ENOMEM;
597
598 file_priv->event_space -= e->length;
599
600 p->event = e;
Daniel Vetter681047b2016-01-25 22:16:43 +0100601 list_add(&p->pending_link, &file_priv->pending_event_list);
Daniel Vetter4020b222016-01-28 12:01:04 +0100602 p->file_priv = file_priv;
603
Daniel Vetter4020b222016-01-28 12:01:04 +0100604 return 0;
605}
606EXPORT_SYMBOL(drm_event_reserve_init_locked);
607
608/**
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100609 * drm_event_reserve_init - init a DRM event and reserve space for it
610 * @dev: DRM device
611 * @file_priv: DRM file private data
612 * @p: tracking structure for the pending event
613 * @e: actual event data to deliver to userspace
614 *
615 * This function prepares the passed in event for eventual delivery. If the event
616 * doesn't get delivered (because the IOCTL fails later on, before queuing up
617 * anything) then the even must be cancelled and freed using
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100618 * drm_event_cancel_free(). Successfully initialized events should be sent out
619 * using drm_send_event() or drm_send_event_locked() to signal completion of the
620 * asynchronous event to userspace.
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100621 *
622 * If callers embedded @p into a larger structure it must be allocated with
623 * kmalloc and @p must be the first member element.
624 *
Daniel Vetter4020b222016-01-28 12:01:04 +0100625 * Callers which already hold dev->event_lock should use
626 * drm_event_reserve_init() instead.
627 *
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100628 * RETURNS:
629 *
630 * 0 on success or a negative error code on failure.
631 */
632int drm_event_reserve_init(struct drm_device *dev,
633 struct drm_file *file_priv,
634 struct drm_pending_event *p,
635 struct drm_event *e)
636{
637 unsigned long flags;
Daniel Vetter4020b222016-01-28 12:01:04 +0100638 int ret;
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100639
640 spin_lock_irqsave(&dev->event_lock, flags);
Daniel Vetter4020b222016-01-28 12:01:04 +0100641 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100642 spin_unlock_irqrestore(&dev->event_lock, flags);
Daniel Vetter4020b222016-01-28 12:01:04 +0100643
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100644 return ret;
645}
646EXPORT_SYMBOL(drm_event_reserve_init);
647
648/**
649 * drm_event_cancel_free - free a DRM event and release it's space
650 * @dev: DRM device
651 * @p: tracking structure for the pending event
652 *
653 * This function frees the event @p initialized with drm_event_reserve_init()
654 * and releases any allocated space.
655 */
656void drm_event_cancel_free(struct drm_device *dev,
657 struct drm_pending_event *p)
658{
659 unsigned long flags;
660 spin_lock_irqsave(&dev->event_lock, flags);
Daniel Vetter681047b2016-01-25 22:16:43 +0100661 if (p->file_priv) {
662 p->file_priv->event_space += p->event->length;
663 list_del(&p->pending_link);
664 }
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100665 spin_unlock_irqrestore(&dev->event_lock, flags);
Gustavo Padovan1b47aaf2016-06-02 00:06:35 +0200666 kfree(p);
Daniel Vetter2dd500f2016-01-11 22:40:56 +0100667}
668EXPORT_SYMBOL(drm_event_cancel_free);
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100669
670/**
671 * drm_send_event_locked - send DRM event to file descriptor
672 * @dev: DRM device
673 * @e: DRM event to deliver
674 *
675 * This function sends the event @e, initialized with drm_event_reserve_init(),
676 * to its associated userspace DRM file. Callers must already hold
677 * dev->event_lock, see drm_send_event() for the unlocked version.
Daniel Vetter681047b2016-01-25 22:16:43 +0100678 *
679 * Note that the core will take care of unlinking and disarming events when the
680 * corresponding DRM file is closed. Drivers need not worry about whether the
681 * DRM file for this event still exists and can call this function upon
682 * completion of the asynchronous work unconditionally.
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100683 */
684void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
685{
686 assert_spin_locked(&dev->event_lock);
687
Daniel Vetter3b24f7d2016-06-08 14:19:00 +0200688 if (e->completion) {
689 /* ->completion might disappear as soon as it signalled. */
690 complete_all(e->completion);
691 e->completion = NULL;
692 }
693
Gustavo Padovan1b47aaf2016-06-02 00:06:35 +0200694 if (e->fence) {
695 fence_signal(e->fence);
696 fence_put(e->fence);
697 }
698
Daniel Vetter681047b2016-01-25 22:16:43 +0100699 if (!e->file_priv) {
Gustavo Padovan1b47aaf2016-06-02 00:06:35 +0200700 kfree(e);
Daniel Vetter681047b2016-01-25 22:16:43 +0100701 return;
702 }
703
704 list_del(&e->pending_link);
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100705 list_add_tail(&e->link,
706 &e->file_priv->event_list);
707 wake_up_interruptible(&e->file_priv->event_wait);
708}
709EXPORT_SYMBOL(drm_send_event_locked);
710
711/**
712 * drm_send_event - send DRM event to file descriptor
713 * @dev: DRM device
714 * @e: DRM event to deliver
715 *
716 * This function sends the event @e, initialized with drm_event_reserve_init(),
717 * to its associated userspace DRM file. This function acquires dev->event_lock,
718 * see drm_send_event_locked() for callers which already hold this lock.
Daniel Vetter681047b2016-01-25 22:16:43 +0100719 *
720 * Note that the core will take care of unlinking and disarming events when the
721 * corresponding DRM file is closed. Drivers need not worry about whether the
722 * DRM file for this event still exists and can call this function upon
723 * completion of the asynchronous work unconditionally.
Daniel Vetterfb740cf2016-01-11 22:40:59 +0100724 */
725void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
726{
727 unsigned long irqflags;
728
729 spin_lock_irqsave(&dev->event_lock, irqflags);
730 drm_send_event_locked(dev, e);
731 spin_unlock_irqrestore(&dev->event_lock, irqflags);
732}
733EXPORT_SYMBOL(drm_send_event);