drm: Make drm_vm_open/close_locked private to drm_vm.c
[deliverable/linux.git] / drivers / gpu / drm / drm_fops.c
CommitLineData
bcb877e4 1/*
b5e89ed5 2 * \file drm_fops.c
1da177e4 3 * File operations for DRM
b5e89ed5 4 *
1da177e4
LT
5 * \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
760285e7 37#include <drm/drmP.h>
1da177e4 38#include <linux/poll.h>
5a0e3ad6 39#include <linux/slab.h>
e0cd3608 40#include <linux/module.h>
e7b96070 41#include "drm_legacy.h"
67d0ec4e 42#include "drm_internal.h"
1da177e4 43
0d639883 44/* from BKL pushdown */
58374713
AB
45DEFINE_MUTEX(drm_global_mutex);
46
bcb877e4
DV
47/**
48 * DOC: file operations
49 *
50 * Drivers must define the file operations structure that forms the DRM
51 * userspace API entry point, even though most of those operations are
52 * implemented in the DRM core. The mandatory functions are drm_open(),
53 * drm_read(), drm_ioctl() and drm_compat_ioctl if CONFIG_COMPAT is enabled.
54 * Drivers which implement private ioctls that require 32/64 bit compatibility
55 * support must provided their onw .compat_ioctl() handler that processes
56 * private ioctls and calls drm_compat_ioctl() for core ioctls.
57 *
58 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
59 * events are a generic and extensible means to send asynchronous events to
60 * userspace through the file descriptor. They are used to send vblank event and
61 * page flip completions by the KMS API. But drivers can also use it for their
62 * own needs, e.g. to signal completion of rendering.
63 *
64 * The memory mapping implementation will vary depending on how the driver
65 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
66 * function, modern drivers should use one of the provided memory-manager
67 * specific implementations. For GEM-based drivers this is drm_gem_mmap().
68 *
69 * No other file operations are supported by the DRM userspace API. Overall the
70 * following is an example #file_operations structure:
71 *
72 * static const example_drm_fops = {
73 * .owner = THIS_MODULE,
74 * .open = drm_open,
75 * .release = drm_release,
76 * .unlocked_ioctl = drm_ioctl,
77 * #ifdef CONFIG_COMPAT
78 * .compat_ioctl = drm_compat_ioctl,
79 * #endif
80 * .poll = drm_poll,
81 * .read = drm_read,
82 * .llseek = no_llseek,
83 * .mmap = drm_gem_mmap,
84 * };
85 */
86
1dcc0ceb 87static int drm_open_helper(struct file *filp, struct drm_minor *minor);
c94f7029 88
84b1fd10 89static int drm_setup(struct drm_device * dev)
1da177e4 90{
1da177e4
LT
91 int ret;
92
7d14bb6b
DV
93 if (dev->driver->firstopen &&
94 !drm_core_check_feature(dev, DRIVER_MODESET)) {
22eae947 95 ret = dev->driver->firstopen(dev);
b5e89ed5 96 if (ret != 0)
1da177e4
LT
97 return ret;
98 }
99
f336ab76
DV
100 ret = drm_legacy_dma_setup(dev);
101 if (ret < 0)
102 return ret;
1da177e4 103
1da177e4 104
b5e89ed5 105 DRM_DEBUG("\n");
1da177e4
LT
106 return 0;
107}
108
109/**
bcb877e4
DV
110 * drm_open - open method for DRM file
111 * @inode: device inode
112 * @filp: file pointer.
b5e89ed5 113 *
bcb877e4
DV
114 * This function must be used by drivers as their .open() #file_operations
115 * method. It looks up the correct DRM device and instantiates all the per-file
116 * resources for it.
117 *
118 * RETURNS:
1da177e4 119 *
bcb877e4 120 * 0 on success or negative errno value on falure.
1da177e4 121 */
b5e89ed5 122int drm_open(struct inode *inode, struct file *filp)
1da177e4 123{
1616c525 124 struct drm_device *dev;
2c14f28b 125 struct drm_minor *minor;
1616c525 126 int retcode;
fdb40a08 127 int need_setup = 0;
b5e89ed5 128
1616c525
DH
129 minor = drm_minor_acquire(iminor(inode));
130 if (IS_ERR(minor))
131 return PTR_ERR(minor);
2c07a21d 132
1616c525 133 dev = minor->dev;
fdb40a08
IH
134 if (!dev->open_count++)
135 need_setup = 1;
fdb40a08 136
6796cb16
DH
137 /* share address_space across all char-devs of a single device */
138 filp->f_mapping = dev->anon_inode->i_mapping;
fdb40a08 139
1dcc0ceb 140 retcode = drm_open_helper(filp, minor);
fdb40a08
IH
141 if (retcode)
142 goto err_undo;
fdb40a08
IH
143 if (need_setup) {
144 retcode = drm_setup(dev);
145 if (retcode)
146 goto err_undo;
f453ba04 147 }
fdb40a08 148 return 0;
a2c0a97b 149
fdb40a08 150err_undo:
fdb40a08 151 dev->open_count--;
1616c525 152 drm_minor_release(minor);
1da177e4
LT
153 return retcode;
154}
155EXPORT_SYMBOL(drm_open);
156
bcb877e4 157/*
d985c108
DA
158 * Check whether DRI will run on this CPU.
159 *
160 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
161 */
162static int drm_cpu_valid(void)
163{
d985c108
DA
164#if defined(__sparc__) && !defined(__sparc_v9__)
165 return 0; /* No cmpxchg before v9 sparc. */
166#endif
167 return 1;
168}
169
bcb877e4 170/*
a0af2e53
TH
171 * drm_new_set_master - Allocate a new master object and become master for the
172 * associated master realm.
173 *
174 * @dev: The associated device.
175 * @fpriv: File private identifying the client.
176 *
177 * This function must be called with dev::struct_mutex held.
178 * Returns negative error code on failure. Zero on success.
179 */
180int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv)
181{
182 struct drm_master *old_master;
183 int ret;
184
185 lockdep_assert_held_once(&dev->master_mutex);
186
187 /* create a new master */
188 fpriv->minor->master = drm_master_create(fpriv->minor);
189 if (!fpriv->minor->master)
190 return -ENOMEM;
191
192 /* take another reference for the copy in the local file priv */
193 old_master = fpriv->master;
194 fpriv->master = drm_master_get(fpriv->minor->master);
195
196 if (dev->driver->master_create) {
197 ret = dev->driver->master_create(dev, fpriv->master);
198 if (ret)
199 goto out_err;
200 }
201 if (dev->driver->master_set) {
202 ret = dev->driver->master_set(dev, fpriv, true);
203 if (ret)
204 goto out_err;
205 }
206
207 fpriv->is_master = 1;
208 fpriv->allowed_master = 1;
209 fpriv->authenticated = 1;
210 if (old_master)
211 drm_master_put(&old_master);
212
213 return 0;
214
215out_err:
216 /* drop both references and restore old master on failure */
217 drm_master_put(&fpriv->minor->master);
218 drm_master_put(&fpriv->master);
219 fpriv->master = old_master;
220
221 return ret;
222}
223
bcb877e4 224/*
d985c108
DA
225 * Called whenever a process opens /dev/drm.
226 *
d985c108 227 * \param filp file pointer.
f4aede2e 228 * \param minor acquired minor-object.
d985c108
DA
229 * \return zero on success or a negative number on failure.
230 *
231 * Creates and initializes a drm_file structure for the file private data in \p
232 * filp and add it into the double linked list in \p dev.
233 */
1dcc0ceb 234static int drm_open_helper(struct file *filp, struct drm_minor *minor)
d985c108 235{
f4aede2e 236 struct drm_device *dev = minor->dev;
84b1fd10 237 struct drm_file *priv;
d985c108
DA
238 int ret;
239
240 if (filp->f_flags & O_EXCL)
241 return -EBUSY; /* No exclusive opens */
242 if (!drm_cpu_valid())
243 return -EINVAL;
13bb9cc8 244 if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
5bcf719b 245 return -EINVAL;
d985c108 246
f4aede2e 247 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
d985c108 248
6ebc22e6 249 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
d985c108
DA
250 if (!priv)
251 return -ENOMEM;
252
d985c108 253 filp->private_data = priv;
6c340eac 254 priv->filp = filp;
2df68b43 255 priv->uid = current_euid();
5fce5e0b 256 priv->pid = get_pid(task_pid(current));
f4aede2e 257 priv->minor = minor;
df9b6a9c 258
d985c108 259 /* for compatibility root is always authenticated */
3cb01a98 260 priv->authenticated = capable(CAP_SYS_ADMIN);
d985c108
DA
261 priv->lock_count = 0;
262
bd1b331f 263 INIT_LIST_HEAD(&priv->lhead);
f453ba04 264 INIT_LIST_HEAD(&priv->fbs);
4b096ac1 265 mutex_init(&priv->fbs_lock);
e2f5d2ea 266 INIT_LIST_HEAD(&priv->blobs);
681047b4 267 INIT_LIST_HEAD(&priv->pending_event_list);
c9a9c5e0
KH
268 INIT_LIST_HEAD(&priv->event_list);
269 init_waitqueue_head(&priv->event_wait);
270 priv->event_space = 4096; /* set aside 4k for event buffer */
bd1b331f 271
9b2c0b7f
CW
272 mutex_init(&priv->event_read_lock);
273
1bcecfac 274 if (drm_core_check_feature(dev, DRIVER_GEM))
673a394b
EA
275 drm_gem_open(dev, priv);
276
3248877e
DA
277 if (drm_core_check_feature(dev, DRIVER_PRIME))
278 drm_prime_init_file_private(&priv->prime);
279
d985c108
DA
280 if (dev->driver->open) {
281 ret = dev->driver->open(dev, priv);
282 if (ret < 0)
df9b6a9c 283 goto out_prime_destroy;
d985c108
DA
284 }
285
1793126f
DH
286 /* if there is no current master make this fd it, but do not create
287 * any master object for render clients */
c996fd0b 288 mutex_lock(&dev->master_mutex);
43683057 289 if (drm_is_primary_client(priv) && !priv->minor->master) {
7c1c2871 290 /* create a new master */
a0af2e53
TH
291 ret = drm_new_set_master(dev, priv);
292 if (ret)
df9b6a9c 293 goto out_close;
43683057 294 } else if (drm_is_primary_client(priv)) {
7c1c2871
DA
295 /* get a reference to the master */
296 priv->master = drm_master_get(priv->minor->master);
7c1c2871 297 }
c996fd0b 298 mutex_unlock(&dev->master_mutex);
bd1b331f 299
7c1c2871 300 mutex_lock(&dev->struct_mutex);
bd1b331f 301 list_add(&priv->lhead, &dev->filelist);
30e2fb18 302 mutex_unlock(&dev->struct_mutex);
d985c108
DA
303
304#ifdef __alpha__
305 /*
306 * Default the hose
307 */
308 if (!dev->hose) {
309 struct pci_dev *pci_dev;
310 pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
311 if (pci_dev) {
312 dev->hose = pci_dev->sysdata;
313 pci_dev_put(pci_dev);
314 }
315 if (!dev->hose) {
59c1ad3b
YW
316 struct pci_bus *b = list_entry(pci_root_buses.next,
317 struct pci_bus, node);
d985c108
DA
318 if (b)
319 dev->hose = b->sysdata;
320 }
321 }
322#endif
323
324 return 0;
df9b6a9c
SWK
325
326out_close:
c996fd0b 327 mutex_unlock(&dev->master_mutex);
df9b6a9c
SWK
328 if (dev->driver->postclose)
329 dev->driver->postclose(dev, priv);
330out_prime_destroy:
331 if (drm_core_check_feature(dev, DRIVER_PRIME))
332 drm_prime_destroy_file_private(&priv->prime);
1bcecfac 333 if (drm_core_check_feature(dev, DRIVER_GEM))
df9b6a9c 334 drm_gem_release(dev, priv);
df9b6a9c 335 put_pid(priv->pid);
9a298b2a 336 kfree(priv);
d985c108
DA
337 filp->private_data = NULL;
338 return ret;
339}
340
7c1c2871
DA
341static void drm_master_release(struct drm_device *dev, struct file *filp)
342{
343 struct drm_file *file_priv = filp->private_data;
344
bb6d822e 345 if (drm_legacy_i_have_hw_lock(dev, file_priv)) {
7c1c2871
DA
346 DRM_DEBUG("File %p released, freeing lock for context %d\n",
347 filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
bb6d822e
DH
348 drm_legacy_lock_free(&file_priv->master->lock,
349 _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
7c1c2871 350 }
7c1c2871
DA
351}
352
c9a9c5e0
KH
353static void drm_events_release(struct drm_file *file_priv)
354{
355 struct drm_device *dev = file_priv->minor->dev;
356 struct drm_pending_event *e, *et;
c9a9c5e0
KH
357 unsigned long flags;
358
359 spin_lock_irqsave(&dev->event_lock, flags);
360
681047b4
DV
361 /* Unlink pending events */
362 list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
363 pending_link) {
364 list_del(&e->pending_link);
365 e->file_priv = NULL;
366 }
367
c9a9c5e0 368 /* Remove unconsumed events */
1dda6805
YC
369 list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
370 list_del(&e->link);
c9a9c5e0 371 e->destroy(e);
1dda6805 372 }
c9a9c5e0
KH
373
374 spin_unlock_irqrestore(&dev->event_lock, flags);
375}
376
bcb877e4 377/*
1c8887dd
DH
378 * drm_legacy_dev_reinit
379 *
380 * Reinitializes a legacy/ums drm device in it's lastclose function.
381 */
382static void drm_legacy_dev_reinit(struct drm_device *dev)
383{
68dfbeba
DV
384 if (dev->irq_enabled)
385 drm_irq_uninstall(dev);
386
387 mutex_lock(&dev->struct_mutex);
388
389 drm_legacy_agp_clear(dev);
390
391 drm_legacy_sg_cleanup(dev);
392 drm_legacy_vma_flush(dev);
393 drm_legacy_dma_takedown(dev);
394
395 mutex_unlock(&dev->struct_mutex);
1c8887dd 396
1c8887dd
DH
397 dev->sigdata.lock = NULL;
398
399 dev->context_flag = 0;
400 dev->last_context = 0;
401 dev->if_version = 0;
68dfbeba
DV
402
403 DRM_DEBUG("lastclose completed\n");
1c8887dd
DH
404}
405
bcb877e4 406/*
1c8887dd
DH
407 * Take down the DRM device.
408 *
409 * \param dev DRM device structure.
410 *
411 * Frees every resource in \p dev.
412 *
413 * \sa drm_device
414 */
68dfbeba 415void drm_lastclose(struct drm_device * dev)
1c8887dd 416{
1c8887dd
DH
417 DRM_DEBUG("\n");
418
419 if (dev->driver->lastclose)
420 dev->driver->lastclose(dev);
421 DRM_DEBUG("driver lastclose completed\n");
422
68dfbeba
DV
423 if (!drm_core_check_feature(dev, DRIVER_MODESET))
424 drm_legacy_dev_reinit(dev);
1c8887dd
DH
425}
426
1da177e4 427/**
bcb877e4
DV
428 * drm_release - release method for DRM file
429 * @inode: device inode
430 * @filp: file pointer.
1da177e4 431 *
bcb877e4
DV
432 * This function must be used by drivers as their .release() #file_operations
433 * method. It frees any resources associated with the open file, and if this is
434 * the last open file for the DRM device also proceeds to call drm_lastclose().
1da177e4 435 *
bcb877e4
DV
436 * RETURNS:
437 *
438 * Always succeeds and returns 0.
1da177e4 439 */
b5e89ed5 440int drm_release(struct inode *inode, struct file *filp)
1da177e4 441{
6c340eac 442 struct drm_file *file_priv = filp->private_data;
1616c525
DH
443 struct drm_minor *minor = file_priv->minor;
444 struct drm_device *dev = minor->dev;
1da177e4 445
58374713 446 mutex_lock(&drm_global_mutex);
1da177e4 447
b5e89ed5 448 DRM_DEBUG("open_count = %d\n", dev->open_count);
1da177e4 449
dff01de1
CW
450 mutex_lock(&dev->struct_mutex);
451 list_del(&file_priv->lhead);
32e7b94a
DH
452 if (file_priv->magic)
453 idr_remove(&file_priv->master->magic_map, file_priv->magic);
dff01de1
CW
454 mutex_unlock(&dev->struct_mutex);
455
22eae947 456 if (dev->driver->preclose)
6c340eac 457 dev->driver->preclose(dev, file_priv);
1da177e4
LT
458
459 /* ========================================================
460 * Begin inline drm_release
461 */
462
b5e89ed5 463 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
ba25f9dc 464 task_pid_nr(current),
5817878c 465 (long)old_encode_dev(file_priv->minor->kdev->devt),
b5e89ed5
DA
466 dev->open_count);
467
7c1c2871
DA
468 /* if the master has gone away we can't do anything with the lock */
469 if (file_priv->minor->master)
470 drm_master_release(dev, filp);
1da177e4 471
67cb4b4d 472 if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
a266162a 473 drm_legacy_reclaim_buffers(dev, file_priv);
67cb4b4d 474
c9a9c5e0
KH
475 drm_events_release(file_priv);
476
e2f5d2ea 477 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
ea39f835 478 drm_fb_release(file_priv);
e2f5d2ea
DS
479 drm_property_destroy_user_blobs(dev, file_priv);
480 }
ea39f835 481
1bcecfac 482 if (drm_core_check_feature(dev, DRIVER_GEM))
4e47e02d
P
483 drm_gem_release(dev, file_priv);
484
e7b96070 485 drm_legacy_ctxbitmap_flush(dev, file_priv);
1da177e4 486
c996fd0b 487 mutex_lock(&dev->master_mutex);
7c1c2871 488
7963e9db 489 if (file_priv->is_master) {
fda714c2 490 struct drm_master *master = file_priv->master;
bd1b331f 491
bcb877e4 492 /*
fda714c2
TH
493 * Since the master is disappearing, so is the
494 * possibility to lock.
495 */
3cb01a98 496 mutex_lock(&dev->struct_mutex);
fda714c2
TH
497 if (master->lock.hw_lock) {
498 if (dev->sigdata.lock == master->lock.hw_lock)
499 dev->sigdata.lock = NULL;
500 master->lock.hw_lock = NULL;
501 master->lock.file_priv = NULL;
502 wake_up_interruptible_all(&master->lock.lock_queue);
503 }
c996fd0b 504 mutex_unlock(&dev->struct_mutex);
fda714c2 505
7c1c2871
DA
506 if (file_priv->minor->master == file_priv->master) {
507 /* drop the reference held my the minor */
862302ff
TH
508 if (dev->driver->master_drop)
509 dev->driver->master_drop(dev, file_priv, true);
7c1c2871
DA
510 drm_master_put(&file_priv->minor->master);
511 }
1da177e4 512 }
7c1c2871 513
c996fd0b 514 /* drop the master reference held by the file priv */
1793126f
DH
515 if (file_priv->master)
516 drm_master_put(&file_priv->master);
7963e9db 517 file_priv->is_master = 0;
c996fd0b
TH
518 mutex_unlock(&dev->master_mutex);
519
22eae947 520 if (dev->driver->postclose)
6c340eac 521 dev->driver->postclose(dev, file_priv);
3248877e 522
319c933c 523
3248877e
DA
524 if (drm_core_check_feature(dev, DRIVER_PRIME))
525 drm_prime_destroy_file_private(&file_priv->prime);
526
ddde4371
VS
527 WARN_ON(!list_empty(&file_priv->event_list));
528
5fce5e0b 529 put_pid(file_priv->pid);
9a298b2a 530 kfree(file_priv);
1da177e4
LT
531
532 /* ========================================================
533 * End inline drm_release
534 */
535
b5e89ed5 536 if (!--dev->open_count) {
68dfbeba 537 drm_lastclose(dev);
2c07a21d
DA
538 if (drm_device_is_unplugged(dev))
539 drm_put_dev(dev);
1da177e4 540 }
58374713 541 mutex_unlock(&drm_global_mutex);
1da177e4 542
1616c525
DH
543 drm_minor_release(minor);
544
68dfbeba 545 return 0;
1da177e4
LT
546}
547EXPORT_SYMBOL(drm_release);
548
bcb877e4
DV
549/**
550 * drm_read - read method for DRM file
551 * @filp: file pointer
552 * @buffer: userspace destination pointer for the read
553 * @count: count in bytes to read
554 * @offset: offset to read
555 *
556 * This function must be used by drivers as their .read() #file_operations
557 * method iff they use DRM events for asynchronous signalling to userspace.
558 * Since events are used by the KMS API for vblank and page flip completion this
559 * means all modern display drivers must use it.
560 *
561 * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
562 * must set the .llseek() #file_operation to no_llseek(). Polling support is
563 * provided by drm_poll().
564 *
565 * This function will only ever read a full event. Therefore userspace must
566 * supply a big enough buffer to fit any event to ensure forward progress. Since
567 * the maximum event space is currently 4K it's recommended to just use that for
568 * safety.
569 *
570 * RETURNS:
571 *
572 * Number of bytes read (always aligned to full events, and can be 0) or a
573 * negative error code on failure.
574 */
cdd1cf79
CW
575ssize_t drm_read(struct file *filp, char __user *buffer,
576 size_t count, loff_t *offset)
c9a9c5e0 577{
cdd1cf79 578 struct drm_file *file_priv = filp->private_data;
c9a9c5e0 579 struct drm_device *dev = file_priv->minor->dev;
9b2c0b7f 580 ssize_t ret;
c9a9c5e0 581
cdd1cf79
CW
582 if (!access_ok(VERIFY_WRITE, buffer, count))
583 return -EFAULT;
c9a9c5e0 584
9b2c0b7f
CW
585 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
586 if (ret)
587 return ret;
588
cdd1cf79 589 for (;;) {
83eb64c8
CW
590 struct drm_pending_event *e = NULL;
591
592 spin_lock_irq(&dev->event_lock);
593 if (!list_empty(&file_priv->event_list)) {
594 e = list_first_entry(&file_priv->event_list,
595 struct drm_pending_event, link);
596 file_priv->event_space += e->event->length;
597 list_del(&e->link);
598 }
599 spin_unlock_irq(&dev->event_lock);
600
601 if (e == NULL) {
cdd1cf79
CW
602 if (ret)
603 break;
c9a9c5e0 604
cdd1cf79
CW
605 if (filp->f_flags & O_NONBLOCK) {
606 ret = -EAGAIN;
607 break;
608 }
c9a9c5e0 609
9b2c0b7f 610 mutex_unlock(&file_priv->event_read_lock);
cdd1cf79
CW
611 ret = wait_event_interruptible(file_priv->event_wait,
612 !list_empty(&file_priv->event_list));
9b2c0b7f
CW
613 if (ret >= 0)
614 ret = mutex_lock_interruptible(&file_priv->event_read_lock);
615 if (ret)
616 return ret;
cdd1cf79 617 } else {
83eb64c8
CW
618 unsigned length = e->event->length;
619
620 if (length > count - ret) {
621put_back_event:
622 spin_lock_irq(&dev->event_lock);
623 file_priv->event_space -= length;
624 list_add(&e->link, &file_priv->event_list);
625 spin_unlock_irq(&dev->event_lock);
cdd1cf79 626 break;
83eb64c8 627 }
cdd1cf79 628
83eb64c8 629 if (copy_to_user(buffer + ret, e->event, length)) {
cdd1cf79
CW
630 if (ret == 0)
631 ret = -EFAULT;
83eb64c8 632 goto put_back_event;
cdd1cf79 633 }
c9a9c5e0 634
83eb64c8 635 ret += length;
a0a0bde3 636 e->destroy(e);
c9a9c5e0 637 }
c9a9c5e0 638 }
9b2c0b7f 639 mutex_unlock(&file_priv->event_read_lock);
c9a9c5e0 640
cdd1cf79 641 return ret;
c9a9c5e0
KH
642}
643EXPORT_SYMBOL(drm_read);
644
bcb877e4
DV
645/**
646 * drm_poll - poll method for DRM file
647 * @filp: file pointer
648 * @wait: poll waiter table
649 *
650 * This function must be used by drivers as their .read() #file_operations
651 * method iff they use DRM events for asynchronous signalling to userspace.
652 * Since events are used by the KMS API for vblank and page flip completion this
653 * means all modern display drivers must use it.
654 *
655 * See also drm_read().
656 *
657 * RETURNS:
658 *
659 * Mask of POLL flags indicating the current status of the file.
660 */
1da177e4
LT
661unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
662{
c9a9c5e0
KH
663 struct drm_file *file_priv = filp->private_data;
664 unsigned int mask = 0;
665
666 poll_wait(filp, &file_priv->event_wait, wait);
667
668 if (!list_empty(&file_priv->event_list))
669 mask |= POLLIN | POLLRDNORM;
670
671 return mask;
1da177e4 672}
b5e89ed5 673EXPORT_SYMBOL(drm_poll);
2dd500f1
DV
674
675/**
4020b220 676 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
2dd500f1
DV
677 * @dev: DRM device
678 * @file_priv: DRM file private data
679 * @p: tracking structure for the pending event
680 * @e: actual event data to deliver to userspace
681 *
682 * This function prepares the passed in event for eventual delivery. If the event
683 * doesn't get delivered (because the IOCTL fails later on, before queuing up
684 * anything) then the even must be cancelled and freed using
fb740cf2
DV
685 * drm_event_cancel_free(). Successfully initialized events should be sent out
686 * using drm_send_event() or drm_send_event_locked() to signal completion of the
687 * asynchronous event to userspace.
2dd500f1
DV
688 *
689 * If callers embedded @p into a larger structure it must be allocated with
690 * kmalloc and @p must be the first member element.
691 *
4020b220
DV
692 * This is the locked version of drm_event_reserve_init() for callers which
693 * already hold dev->event_lock.
694 *
2dd500f1
DV
695 * RETURNS:
696 *
697 * 0 on success or a negative error code on failure.
698 */
4020b220
DV
699int drm_event_reserve_init_locked(struct drm_device *dev,
700 struct drm_file *file_priv,
701 struct drm_pending_event *p,
702 struct drm_event *e)
2dd500f1 703{
4020b220
DV
704 if (file_priv->event_space < e->length)
705 return -ENOMEM;
2dd500f1
DV
706
707 file_priv->event_space -= e->length;
708
709 p->event = e;
681047b4 710 list_add(&p->pending_link, &file_priv->pending_event_list);
2dd500f1
DV
711 p->file_priv = file_priv;
712
713 /* we *could* pass this in as arg, but everyone uses kfree: */
714 p->destroy = (void (*) (struct drm_pending_event *)) kfree;
715
4020b220
DV
716 return 0;
717}
718EXPORT_SYMBOL(drm_event_reserve_init_locked);
719
720/**
721 * drm_event_reserve_init - init a DRM event and reserve space for it
722 * @dev: DRM device
723 * @file_priv: DRM file private data
724 * @p: tracking structure for the pending event
725 * @e: actual event data to deliver to userspace
726 *
727 * This function prepares the passed in event for eventual delivery. If the event
728 * doesn't get delivered (because the IOCTL fails later on, before queuing up
729 * anything) then the even must be cancelled and freed using
730 * drm_event_cancel_free(). Successfully initialized events should be sent out
731 * using drm_send_event() or drm_send_event_locked() to signal completion of the
732 * asynchronous event to userspace.
733 *
734 * If callers embedded @p into a larger structure it must be allocated with
735 * kmalloc and @p must be the first member element.
736 *
737 * Callers which already hold dev->event_lock should use
738 * drm_event_reserve_init() instead.
739 *
740 * RETURNS:
741 *
742 * 0 on success or a negative error code on failure.
743 */
744int drm_event_reserve_init(struct drm_device *dev,
745 struct drm_file *file_priv,
746 struct drm_pending_event *p,
747 struct drm_event *e)
748{
749 unsigned long flags;
750 int ret;
751
752 spin_lock_irqsave(&dev->event_lock, flags);
753 ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
2dd500f1 754 spin_unlock_irqrestore(&dev->event_lock, flags);
4020b220 755
2dd500f1
DV
756 return ret;
757}
758EXPORT_SYMBOL(drm_event_reserve_init);
759
760/**
761 * drm_event_cancel_free - free a DRM event and release it's space
762 * @dev: DRM device
763 * @p: tracking structure for the pending event
764 *
765 * This function frees the event @p initialized with drm_event_reserve_init()
766 * and releases any allocated space.
767 */
768void drm_event_cancel_free(struct drm_device *dev,
769 struct drm_pending_event *p)
770{
771 unsigned long flags;
772 spin_lock_irqsave(&dev->event_lock, flags);
681047b4
DV
773 if (p->file_priv) {
774 p->file_priv->event_space += p->event->length;
775 list_del(&p->pending_link);
776 }
2dd500f1
DV
777 spin_unlock_irqrestore(&dev->event_lock, flags);
778 p->destroy(p);
779}
780EXPORT_SYMBOL(drm_event_cancel_free);
fb740cf2
DV
781
782/**
783 * drm_send_event_locked - send DRM event to file descriptor
784 * @dev: DRM device
785 * @e: DRM event to deliver
786 *
787 * This function sends the event @e, initialized with drm_event_reserve_init(),
788 * to its associated userspace DRM file. Callers must already hold
789 * dev->event_lock, see drm_send_event() for the unlocked version.
681047b4
DV
790 *
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.
fb740cf2
DV
795 */
796void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
797{
798 assert_spin_locked(&dev->event_lock);
799
681047b4
DV
800 if (!e->file_priv) {
801 e->destroy(e);
802 return;
803 }
804
805 list_del(&e->pending_link);
fb740cf2
DV
806 list_add_tail(&e->link,
807 &e->file_priv->event_list);
808 wake_up_interruptible(&e->file_priv->event_wait);
809}
810EXPORT_SYMBOL(drm_send_event_locked);
811
812/**
813 * drm_send_event - send DRM event to file descriptor
814 * @dev: DRM device
815 * @e: DRM event to deliver
816 *
817 * This function sends the event @e, initialized with drm_event_reserve_init(),
818 * to its associated userspace DRM file. This function acquires dev->event_lock,
819 * see drm_send_event_locked() for callers which already hold this lock.
681047b4
DV
820 *
821 * Note that the core will take care of unlinking and disarming events when the
822 * corresponding DRM file is closed. Drivers need not worry about whether the
823 * DRM file for this event still exists and can call this function upon
824 * completion of the asynchronous work unconditionally.
fb740cf2
DV
825 */
826void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
827{
828 unsigned long irqflags;
829
830 spin_lock_irqsave(&dev->event_lock, irqflags);
831 drm_send_event_locked(dev, e);
832 spin_unlock_irqrestore(&dev->event_lock, irqflags);
833}
834EXPORT_SYMBOL(drm_send_event);
This page took 1.289003 seconds and 5 git commands to generate.