drm_fops.c 23.1 KB
Newer Older
D
Daniel Vetter 已提交
1
/*
D
Dave Airlie 已提交
2
 * \file drm_fops.c
L
Linus Torvalds 已提交
3
 * File operations for DRM
D
Dave Airlie 已提交
4
 *
L
Linus Torvalds 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 * \author Rickard E. (Rik) Faith <faith@valinux.com>
 * \author Daryll Strauss <daryll@valinux.com>
 * \author Gareth Hughes <gareth@valinux.com>
 */

/*
 * Created: Mon Jan  4 08:58:31 1999 by faith@valinux.com
 *
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

37
#include <drm/drmP.h>
L
Linus Torvalds 已提交
38
#include <linux/poll.h>
39
#include <linux/slab.h>
40
#include <linux/module.h>
41
#include "drm_legacy.h"
42
#include "drm_internal.h"
L
Linus Torvalds 已提交
43

44
/* from BKL pushdown */
A
Arnd Bergmann 已提交
45 46
DEFINE_MUTEX(drm_global_mutex);

D
Daniel Vetter 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
/**
 * DOC: file operations
 *
 * Drivers must define the file operations structure that forms the DRM
 * userspace API entry point, even though most of those operations are
 * implemented in the DRM core. The mandatory functions are drm_open(),
 * drm_read(), drm_ioctl() and drm_compat_ioctl if CONFIG_COMPAT is enabled.
 * Drivers which implement private ioctls that require 32/64 bit compatibility
 * support must provided their onw .compat_ioctl() handler that processes
 * private ioctls and calls drm_compat_ioctl() for core ioctls.
 *
 * In addition drm_read() and drm_poll() provide support for DRM events. DRM
 * events are a generic and extensible means to send asynchronous events to
 * userspace through the file descriptor. They are used to send vblank event and
 * page flip completions by the KMS API. But drivers can also use it for their
 * own needs, e.g. to signal completion of rendering.
 *
 * The memory mapping implementation will vary depending on how the driver
 * manages memory. Legacy drivers will use the deprecated drm_legacy_mmap()
 * function, modern drivers should use one of the provided memory-manager
 * specific implementations. For GEM-based drivers this is drm_gem_mmap().
 *
 * No other file operations are supported by the DRM userspace API. Overall the
 * following is an example #file_operations structure:
 *
 *     static const example_drm_fops = {
 *             .owner = THIS_MODULE,
 *             .open = drm_open,
 *             .release = drm_release,
 *             .unlocked_ioctl = drm_ioctl,
 *     #ifdef CONFIG_COMPAT
 *             .compat_ioctl = drm_compat_ioctl,
 *     #endif
 *             .poll = drm_poll,
 *             .read = drm_read,
 *             .llseek = no_llseek,
 *             .mmap = drm_gem_mmap,
 *     };
 */

87
static int drm_open_helper(struct file *filp, struct drm_minor *minor);
D
Dave Airlie 已提交
88

89
static int drm_setup(struct drm_device * dev)
L
Linus Torvalds 已提交
90 91 92
{
	int ret;

93 94
	if (dev->driver->firstopen &&
	    !drm_core_check_feature(dev, DRIVER_MODESET)) {
95
		ret = dev->driver->firstopen(dev);
D
Dave Airlie 已提交
96
		if (ret != 0)
L
Linus Torvalds 已提交
97 98 99
			return ret;
	}

100 101 102
	ret = drm_legacy_dma_setup(dev);
	if (ret < 0)
		return ret;
L
Linus Torvalds 已提交
103 104


D
Dave Airlie 已提交
105
	DRM_DEBUG("\n");
L
Linus Torvalds 已提交
106 107 108 109
	return 0;
}

/**
D
Daniel Vetter 已提交
110 111 112
 * drm_open - open method for DRM file
 * @inode: device inode
 * @filp: file pointer.
D
Dave Airlie 已提交
113
 *
D
Daniel Vetter 已提交
114 115 116 117 118
 * This function must be used by drivers as their .open() #file_operations
 * method. It looks up the correct DRM device and instantiates all the per-file
 * resources for it.
 *
 * RETURNS:
L
Linus Torvalds 已提交
119
 *
D
Daniel Vetter 已提交
120
 * 0 on success or negative errno value on falure.
L
Linus Torvalds 已提交
121
 */
D
Dave Airlie 已提交
122
int drm_open(struct inode *inode, struct file *filp)
L
Linus Torvalds 已提交
123
{
124
	struct drm_device *dev;
125
	struct drm_minor *minor;
126
	int retcode;
127
	int need_setup = 0;
D
Dave Airlie 已提交
128

129 130 131
	minor = drm_minor_acquire(iminor(inode));
	if (IS_ERR(minor))
		return PTR_ERR(minor);
132

133
	dev = minor->dev;
134 135 136
	if (!dev->open_count++)
		need_setup = 1;

137 138
	/* share address_space across all char-devs of a single device */
	filp->f_mapping = dev->anon_inode->i_mapping;
139

140
	retcode = drm_open_helper(filp, minor);
141 142 143 144 145 146
	if (retcode)
		goto err_undo;
	if (need_setup) {
		retcode = drm_setup(dev);
		if (retcode)
			goto err_undo;
D
Dave Airlie 已提交
147
	}
148
	return 0;
J
Jesse Barnes 已提交
149

150 151
err_undo:
	dev->open_count--;
152
	drm_minor_release(minor);
L
Linus Torvalds 已提交
153 154 155 156
	return retcode;
}
EXPORT_SYMBOL(drm_open);

D
Daniel Vetter 已提交
157
/*
158 159 160 161 162 163 164 165 166 167 168 169
 * Check whether DRI will run on this CPU.
 *
 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
 */
static int drm_cpu_valid(void)
{
#if defined(__sparc__) && !defined(__sparc_v9__)
	return 0;		/* No cmpxchg before v9 sparc. */
#endif
	return 1;
}

D
Daniel Vetter 已提交
170
/*
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
 * drm_new_set_master - Allocate a new master object and become master for the
 * associated master realm.
 *
 * @dev: The associated device.
 * @fpriv: File private identifying the client.
 *
 * This function must be called with dev::struct_mutex held.
 * Returns negative error code on failure. Zero on success.
 */
int drm_new_set_master(struct drm_device *dev, struct drm_file *fpriv)
{
	struct drm_master *old_master;
	int ret;

	lockdep_assert_held_once(&dev->master_mutex);

	/* create a new master */
	fpriv->minor->master = drm_master_create(fpriv->minor);
	if (!fpriv->minor->master)
		return -ENOMEM;

	/* take another reference for the copy in the local file priv */
	old_master = fpriv->master;
	fpriv->master = drm_master_get(fpriv->minor->master);

	if (dev->driver->master_create) {
		ret = dev->driver->master_create(dev, fpriv->master);
		if (ret)
			goto out_err;
	}
	if (dev->driver->master_set) {
		ret = dev->driver->master_set(dev, fpriv, true);
		if (ret)
			goto out_err;
	}

	fpriv->is_master = 1;
	fpriv->allowed_master = 1;
	fpriv->authenticated = 1;
	if (old_master)
		drm_master_put(&old_master);

	return 0;

out_err:
	/* drop both references and restore old master on failure */
	drm_master_put(&fpriv->minor->master);
	drm_master_put(&fpriv->master);
	fpriv->master = old_master;

	return ret;
}

D
Daniel Vetter 已提交
224
/*
225 226 227
 * Called whenever a process opens /dev/drm.
 *
 * \param filp file pointer.
228
 * \param minor acquired minor-object.
229 230 231 232 233
 * \return zero on success or a negative number on failure.
 *
 * Creates and initializes a drm_file structure for the file private data in \p
 * filp and add it into the double linked list in \p dev.
 */
234
static int drm_open_helper(struct file *filp, struct drm_minor *minor)
235
{
236
	struct drm_device *dev = minor->dev;
237
	struct drm_file *priv;
238 239 240 241 242 243
	int ret;

	if (filp->f_flags & O_EXCL)
		return -EBUSY;	/* No exclusive opens */
	if (!drm_cpu_valid())
		return -EINVAL;
244
	if (dev->switch_power_state != DRM_SWITCH_POWER_ON && dev->switch_power_state != DRM_SWITCH_POWER_DYNAMIC_OFF)
245
		return -EINVAL;
246

247
	DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current), minor->index);
248

J
Julia Lawall 已提交
249
	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
250 251 252 253
	if (!priv)
		return -ENOMEM;

	filp->private_data = priv;
254
	priv->filp = filp;
255
	priv->uid = current_euid();
256
	priv->pid = get_pid(task_pid(current));
257
	priv->minor = minor;
258

259
	/* for compatibility root is always authenticated */
260
	priv->authenticated = capable(CAP_SYS_ADMIN);
261 262
	priv->lock_count = 0;

263
	INIT_LIST_HEAD(&priv->lhead);
D
Dave Airlie 已提交
264
	INIT_LIST_HEAD(&priv->fbs);
265
	mutex_init(&priv->fbs_lock);
266
	INIT_LIST_HEAD(&priv->blobs);
267
	INIT_LIST_HEAD(&priv->pending_event_list);
268 269 270
	INIT_LIST_HEAD(&priv->event_list);
	init_waitqueue_head(&priv->event_wait);
	priv->event_space = 4096; /* set aside 4k for event buffer */
271

272 273
	mutex_init(&priv->event_read_lock);

274
	if (drm_core_check_feature(dev, DRIVER_GEM))
275 276
		drm_gem_open(dev, priv);

277 278 279
	if (drm_core_check_feature(dev, DRIVER_PRIME))
		drm_prime_init_file_private(&priv->prime);

280 281 282
	if (dev->driver->open) {
		ret = dev->driver->open(dev, priv);
		if (ret < 0)
283
			goto out_prime_destroy;
284 285
	}

286 287
	/* if there is no current master make this fd it, but do not create
	 * any master object for render clients */
288
	mutex_lock(&dev->master_mutex);
289
	if (drm_is_primary_client(priv) && !priv->minor->master) {
290
		/* create a new master */
291 292
		ret = drm_new_set_master(dev, priv);
		if (ret)
293
			goto out_close;
294
	} else if (drm_is_primary_client(priv)) {
295 296 297
		/* get a reference to the master */
		priv->master = drm_master_get(priv->minor->master);
	}
298
	mutex_unlock(&dev->master_mutex);
299

300
	mutex_lock(&dev->filelist_mutex);
301
	list_add(&priv->lhead, &dev->filelist);
302
	mutex_unlock(&dev->filelist_mutex);
303 304 305 306 307 308 309 310 311 312 313 314 315

#ifdef __alpha__
	/*
	 * Default the hose
	 */
	if (!dev->hose) {
		struct pci_dev *pci_dev;
		pci_dev = pci_get_class(PCI_CLASS_DISPLAY_VGA << 8, NULL);
		if (pci_dev) {
			dev->hose = pci_dev->sysdata;
			pci_dev_put(pci_dev);
		}
		if (!dev->hose) {
316 317
			struct pci_bus *b = list_entry(pci_root_buses.next,
				struct pci_bus, node);
318 319 320 321 322 323 324
			if (b)
				dev->hose = b->sysdata;
		}
	}
#endif

	return 0;
325 326

out_close:
327
	mutex_unlock(&dev->master_mutex);
328 329 330 331 332
	if (dev->driver->postclose)
		dev->driver->postclose(dev, priv);
out_prime_destroy:
	if (drm_core_check_feature(dev, DRIVER_PRIME))
		drm_prime_destroy_file_private(&priv->prime);
333
	if (drm_core_check_feature(dev, DRIVER_GEM))
334 335
		drm_gem_release(dev, priv);
	put_pid(priv->pid);
336
	kfree(priv);
337 338 339 340
	filp->private_data = NULL;
	return ret;
}

341 342 343 344
static void drm_master_release(struct drm_device *dev, struct file *filp)
{
	struct drm_file *file_priv = filp->private_data;

345
	if (drm_legacy_i_have_hw_lock(dev, file_priv)) {
346 347
		DRM_DEBUG("File %p released, freeing lock for context %d\n",
			  filp, _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
348 349
		drm_legacy_lock_free(&file_priv->master->lock,
				     _DRM_LOCKING_CONTEXT(file_priv->master->lock.hw_lock->lock));
350 351 352
	}
}

353 354 355 356 357 358 359 360
static void drm_events_release(struct drm_file *file_priv)
{
	struct drm_device *dev = file_priv->minor->dev;
	struct drm_pending_event *e, *et;
	unsigned long flags;

	spin_lock_irqsave(&dev->event_lock, flags);

361 362 363 364 365 366 367
	/* Unlink pending events */
	list_for_each_entry_safe(e, et, &file_priv->pending_event_list,
				 pending_link) {
		list_del(&e->pending_link);
		e->file_priv = NULL;
	}

368
	/* Remove unconsumed events */
369 370
	list_for_each_entry_safe(e, et, &file_priv->event_list, link) {
		list_del(&e->link);
371
		kfree(e);
372
	}
373 374 375 376

	spin_unlock_irqrestore(&dev->event_lock, flags);
}

D
Daniel Vetter 已提交
377
/*
378 379 380 381 382 383
 * drm_legacy_dev_reinit
 *
 * Reinitializes a legacy/ums drm device in it's lastclose function.
 */
static void drm_legacy_dev_reinit(struct drm_device *dev)
{
384 385 386 387 388 389 390 391 392 393 394 395
	if (dev->irq_enabled)
		drm_irq_uninstall(dev);

	mutex_lock(&dev->struct_mutex);

	drm_legacy_agp_clear(dev);

	drm_legacy_sg_cleanup(dev);
	drm_legacy_vma_flush(dev);
	drm_legacy_dma_takedown(dev);

	mutex_unlock(&dev->struct_mutex);
396 397 398 399 400 401

	dev->sigdata.lock = NULL;

	dev->context_flag = 0;
	dev->last_context = 0;
	dev->if_version = 0;
402 403

	DRM_DEBUG("lastclose completed\n");
404 405
}

D
Daniel Vetter 已提交
406
/*
407 408 409 410 411 412 413 414
 * Take down the DRM device.
 *
 * \param dev DRM device structure.
 *
 * Frees every resource in \p dev.
 *
 * \sa drm_device
 */
415
void drm_lastclose(struct drm_device * dev)
416 417 418 419 420 421 422
{
	DRM_DEBUG("\n");

	if (dev->driver->lastclose)
		dev->driver->lastclose(dev);
	DRM_DEBUG("driver lastclose completed\n");

423 424
	if (!drm_core_check_feature(dev, DRIVER_MODESET))
		drm_legacy_dev_reinit(dev);
425 426
}

L
Linus Torvalds 已提交
427
/**
D
Daniel Vetter 已提交
428 429 430
 * drm_release - release method for DRM file
 * @inode: device inode
 * @filp: file pointer.
L
Linus Torvalds 已提交
431
 *
D
Daniel Vetter 已提交
432 433 434
 * This function must be used by drivers as their .release() #file_operations
 * method. It frees any resources associated with the open file, and if this is
 * the last open file for the DRM device also proceeds to call drm_lastclose().
L
Linus Torvalds 已提交
435
 *
D
Daniel Vetter 已提交
436 437 438
 * RETURNS:
 *
 * Always succeeds and returns 0.
L
Linus Torvalds 已提交
439
 */
D
Dave Airlie 已提交
440
int drm_release(struct inode *inode, struct file *filp)
L
Linus Torvalds 已提交
441
{
442
	struct drm_file *file_priv = filp->private_data;
443 444
	struct drm_minor *minor = file_priv->minor;
	struct drm_device *dev = minor->dev;
L
Linus Torvalds 已提交
445

A
Arnd Bergmann 已提交
446
	mutex_lock(&drm_global_mutex);
L
Linus Torvalds 已提交
447

D
Dave Airlie 已提交
448
	DRM_DEBUG("open_count = %d\n", dev->open_count);
L
Linus Torvalds 已提交
449

450
	mutex_lock(&dev->filelist_mutex);
451
	list_del(&file_priv->lhead);
452 453 454
	mutex_unlock(&dev->filelist_mutex);

	mutex_lock(&dev->struct_mutex);
455 456
	if (file_priv->magic)
		idr_remove(&file_priv->master->magic_map, file_priv->magic);
457 458
	mutex_unlock(&dev->struct_mutex);

459
	if (dev->driver->preclose)
460
		dev->driver->preclose(dev, file_priv);
L
Linus Torvalds 已提交
461 462 463 464 465

	/* ========================================================
	 * Begin inline drm_release
	 */

D
Dave Airlie 已提交
466
	DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
467
		  task_pid_nr(current),
468
		  (long)old_encode_dev(file_priv->minor->kdev->devt),
D
Dave Airlie 已提交
469 470
		  dev->open_count);

471 472 473
	/* if the master has gone away we can't do anything with the lock */
	if (file_priv->minor->master)
		drm_master_release(dev, filp);
L
Linus Torvalds 已提交
474

475
	if (drm_core_check_feature(dev, DRIVER_HAVE_DMA))
476
		drm_legacy_reclaim_buffers(dev, file_priv);
477

478 479
	drm_events_release(file_priv);

480
	if (drm_core_check_feature(dev, DRIVER_MODESET)) {
481
		drm_fb_release(file_priv);
482 483
		drm_property_destroy_user_blobs(dev, file_priv);
	}
484

485
	if (drm_core_check_feature(dev, DRIVER_GEM))
486 487
		drm_gem_release(dev, file_priv);

488
	drm_legacy_ctxbitmap_flush(dev, file_priv);
L
Linus Torvalds 已提交
489

490
	mutex_lock(&dev->master_mutex);
491

492
	if (file_priv->is_master) {
493
		struct drm_master *master = file_priv->master;
494

D
Daniel Vetter 已提交
495
		/*
496 497 498
		 * Since the master is disappearing, so is the
		 * possibility to lock.
		 */
499
		mutex_lock(&dev->struct_mutex);
500 501 502 503 504 505 506
		if (master->lock.hw_lock) {
			if (dev->sigdata.lock == master->lock.hw_lock)
				dev->sigdata.lock = NULL;
			master->lock.hw_lock = NULL;
			master->lock.file_priv = NULL;
			wake_up_interruptible_all(&master->lock.lock_queue);
		}
507
		mutex_unlock(&dev->struct_mutex);
508

509 510
		if (file_priv->minor->master == file_priv->master) {
			/* drop the reference held my the minor */
511 512
			if (dev->driver->master_drop)
				dev->driver->master_drop(dev, file_priv, true);
513 514
			drm_master_put(&file_priv->minor->master);
		}
L
Linus Torvalds 已提交
515
	}
516

517
	/* drop the master reference held by the file priv */
518 519
	if (file_priv->master)
		drm_master_put(&file_priv->master);
520
	file_priv->is_master = 0;
521 522
	mutex_unlock(&dev->master_mutex);

523
	if (dev->driver->postclose)
524
		dev->driver->postclose(dev, file_priv);
525

526

527 528 529
	if (drm_core_check_feature(dev, DRIVER_PRIME))
		drm_prime_destroy_file_private(&file_priv->prime);

530 531
	WARN_ON(!list_empty(&file_priv->event_list));

532
	put_pid(file_priv->pid);
533
	kfree(file_priv);
L
Linus Torvalds 已提交
534 535 536 537 538

	/* ========================================================
	 * End inline drm_release
	 */

D
Dave Airlie 已提交
539
	if (!--dev->open_count) {
540
		drm_lastclose(dev);
541 542
		if (drm_device_is_unplugged(dev))
			drm_put_dev(dev);
L
Linus Torvalds 已提交
543
	}
A
Arnd Bergmann 已提交
544
	mutex_unlock(&drm_global_mutex);
L
Linus Torvalds 已提交
545

546 547
	drm_minor_release(minor);

548
	return 0;
L
Linus Torvalds 已提交
549 550 551
}
EXPORT_SYMBOL(drm_release);

D
Daniel Vetter 已提交
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
/**
 * drm_read - read method for DRM file
 * @filp: file pointer
 * @buffer: userspace destination pointer for the read
 * @count: count in bytes to read
 * @offset: offset to read
 *
 * This function must be used by drivers as their .read() #file_operations
 * method iff they use DRM events for asynchronous signalling to userspace.
 * Since events are used by the KMS API for vblank and page flip completion this
 * means all modern display drivers must use it.
 *
 * @offset is ignore, DRM events are read like a pipe. Therefore drivers also
 * must set the .llseek() #file_operation to no_llseek(). Polling support is
 * provided by drm_poll().
 *
 * This function will only ever read a full event. Therefore userspace must
 * supply a big enough buffer to fit any event to ensure forward progress. Since
 * the maximum event space is currently 4K it's recommended to just use that for
 * safety.
 *
 * RETURNS:
 *
 * Number of bytes read (always aligned to full events, and can be 0) or a
 * negative error code on failure.
 */
578 579
ssize_t drm_read(struct file *filp, char __user *buffer,
		 size_t count, loff_t *offset)
580
{
581
	struct drm_file *file_priv = filp->private_data;
582
	struct drm_device *dev = file_priv->minor->dev;
583
	ssize_t ret;
584

585 586
	if (!access_ok(VERIFY_WRITE, buffer, count))
		return -EFAULT;
587

588 589 590 591
	ret = mutex_lock_interruptible(&file_priv->event_read_lock);
	if (ret)
		return ret;

592
	for (;;) {
593 594 595 596 597 598 599 600 601 602 603 604
		struct drm_pending_event *e = NULL;

		spin_lock_irq(&dev->event_lock);
		if (!list_empty(&file_priv->event_list)) {
			e = list_first_entry(&file_priv->event_list,
					struct drm_pending_event, link);
			file_priv->event_space += e->event->length;
			list_del(&e->link);
		}
		spin_unlock_irq(&dev->event_lock);

		if (e == NULL) {
605 606
			if (ret)
				break;
607

608 609 610 611
			if (filp->f_flags & O_NONBLOCK) {
				ret = -EAGAIN;
				break;
			}
612

613
			mutex_unlock(&file_priv->event_read_lock);
614 615
			ret = wait_event_interruptible(file_priv->event_wait,
						       !list_empty(&file_priv->event_list));
616 617 618 619
			if (ret >= 0)
				ret = mutex_lock_interruptible(&file_priv->event_read_lock);
			if (ret)
				return ret;
620
		} else {
621 622 623 624 625 626 627 628
			unsigned length = e->event->length;

			if (length > count - ret) {
put_back_event:
				spin_lock_irq(&dev->event_lock);
				file_priv->event_space -= length;
				list_add(&e->link, &file_priv->event_list);
				spin_unlock_irq(&dev->event_lock);
629
				break;
630
			}
631

632
			if (copy_to_user(buffer + ret, e->event, length)) {
633 634
				if (ret == 0)
					ret = -EFAULT;
635
				goto put_back_event;
636
			}
637

638
			ret += length;
639
			kfree(e);
640 641
		}
	}
642
	mutex_unlock(&file_priv->event_read_lock);
643

644
	return ret;
645 646 647
}
EXPORT_SYMBOL(drm_read);

D
Daniel Vetter 已提交
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/**
 * drm_poll - poll method for DRM file
 * @filp: file pointer
 * @wait: poll waiter table
 *
 * This function must be used by drivers as their .read() #file_operations
 * method iff they use DRM events for asynchronous signalling to userspace.
 * Since events are used by the KMS API for vblank and page flip completion this
 * means all modern display drivers must use it.
 *
 * See also drm_read().
 *
 * RETURNS:
 *
 * Mask of POLL flags indicating the current status of the file.
 */
L
Linus Torvalds 已提交
664 665
unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait)
{
666 667 668 669 670 671 672 673 674
	struct drm_file *file_priv = filp->private_data;
	unsigned int mask = 0;

	poll_wait(filp, &file_priv->event_wait, wait);

	if (!list_empty(&file_priv->event_list))
		mask |= POLLIN | POLLRDNORM;

	return mask;
L
Linus Torvalds 已提交
675
}
D
Dave Airlie 已提交
676
EXPORT_SYMBOL(drm_poll);
677 678

/**
679
 * drm_event_reserve_init_locked - init a DRM event and reserve space for it
680 681 682 683 684 685 686 687
 * @dev: DRM device
 * @file_priv: DRM file private data
 * @p: tracking structure for the pending event
 * @e: actual event data to deliver to userspace
 *
 * This function prepares the passed in event for eventual delivery. If the event
 * doesn't get delivered (because the IOCTL fails later on, before queuing up
 * anything) then the even must be cancelled and freed using
688 689 690
 * drm_event_cancel_free(). Successfully initialized events should be sent out
 * using drm_send_event() or drm_send_event_locked() to signal completion of the
 * asynchronous event to userspace.
691 692 693 694
 *
 * If callers embedded @p into a larger structure it must be allocated with
 * kmalloc and @p must be the first member element.
 *
695 696 697
 * This is the locked version of drm_event_reserve_init() for callers which
 * already hold dev->event_lock.
 *
698 699 700 701
 * RETURNS:
 *
 * 0 on success or a negative error code on failure.
 */
702 703 704 705
int drm_event_reserve_init_locked(struct drm_device *dev,
				  struct drm_file *file_priv,
				  struct drm_pending_event *p,
				  struct drm_event *e)
706
{
707 708
	if (file_priv->event_space < e->length)
		return -ENOMEM;
709 710 711 712

	file_priv->event_space -= e->length;

	p->event = e;
713
	list_add(&p->pending_link, &file_priv->pending_event_list);
714 715
	p->file_priv = file_priv;

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
	return 0;
}
EXPORT_SYMBOL(drm_event_reserve_init_locked);

/**
 * drm_event_reserve_init - init a DRM event and reserve space for it
 * @dev: DRM device
 * @file_priv: DRM file private data
 * @p: tracking structure for the pending event
 * @e: actual event data to deliver to userspace
 *
 * This function prepares the passed in event for eventual delivery. If the event
 * doesn't get delivered (because the IOCTL fails later on, before queuing up
 * anything) then the even must be cancelled and freed using
 * drm_event_cancel_free(). Successfully initialized events should be sent out
 * using drm_send_event() or drm_send_event_locked() to signal completion of the
 * asynchronous event to userspace.
 *
 * If callers embedded @p into a larger structure it must be allocated with
 * kmalloc and @p must be the first member element.
 *
 * Callers which already hold dev->event_lock should use
 * drm_event_reserve_init() instead.
 *
 * RETURNS:
 *
 * 0 on success or a negative error code on failure.
 */
int drm_event_reserve_init(struct drm_device *dev,
			   struct drm_file *file_priv,
			   struct drm_pending_event *p,
			   struct drm_event *e)
{
	unsigned long flags;
	int ret;

	spin_lock_irqsave(&dev->event_lock, flags);
	ret = drm_event_reserve_init_locked(dev, file_priv, p, e);
754
	spin_unlock_irqrestore(&dev->event_lock, flags);
755

756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
	return ret;
}
EXPORT_SYMBOL(drm_event_reserve_init);

/**
 * drm_event_cancel_free - free a DRM event and release it's space
 * @dev: DRM device
 * @p: tracking structure for the pending event
 *
 * This function frees the event @p initialized with drm_event_reserve_init()
 * and releases any allocated space.
 */
void drm_event_cancel_free(struct drm_device *dev,
			   struct drm_pending_event *p)
{
	unsigned long flags;
	spin_lock_irqsave(&dev->event_lock, flags);
773 774 775 776
	if (p->file_priv) {
		p->file_priv->event_space += p->event->length;
		list_del(&p->pending_link);
	}
777
	spin_unlock_irqrestore(&dev->event_lock, flags);
778
	kfree(p);
779 780
}
EXPORT_SYMBOL(drm_event_cancel_free);
781 782 783 784 785 786 787 788 789

/**
 * drm_send_event_locked - send DRM event to file descriptor
 * @dev: DRM device
 * @e: DRM event to deliver
 *
 * This function sends the event @e, initialized with drm_event_reserve_init(),
 * to its associated userspace DRM file. Callers must already hold
 * dev->event_lock, see drm_send_event() for the unlocked version.
790 791 792 793 794
 *
 * Note that the core will take care of unlinking and disarming events when the
 * corresponding DRM file is closed. Drivers need not worry about whether the
 * DRM file for this event still exists and can call this function upon
 * completion of the asynchronous work unconditionally.
795 796 797 798 799
 */
void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e)
{
	assert_spin_locked(&dev->event_lock);

800 801 802 803 804
	if (e->fence) {
		fence_signal(e->fence);
		fence_put(e->fence);
	}

805
	if (!e->file_priv) {
806
		kfree(e);
807 808 809 810
		return;
	}

	list_del(&e->pending_link);
811 812 813 814 815 816 817 818 819 820 821 822 823 824
	list_add_tail(&e->link,
		      &e->file_priv->event_list);
	wake_up_interruptible(&e->file_priv->event_wait);
}
EXPORT_SYMBOL(drm_send_event_locked);

/**
 * drm_send_event - send DRM event to file descriptor
 * @dev: DRM device
 * @e: DRM event to deliver
 *
 * This function sends the event @e, initialized with drm_event_reserve_init(),
 * to its associated userspace DRM file. This function acquires dev->event_lock,
 * see drm_send_event_locked() for callers which already hold this lock.
825 826 827 828 829
 *
 * Note that the core will take care of unlinking and disarming events when the
 * corresponding DRM file is closed. Drivers need not worry about whether the
 * DRM file for this event still exists and can call this function upon
 * completion of the asynchronous work unconditionally.
830 831 832 833 834 835 836 837 838 839
 */
void drm_send_event(struct drm_device *dev, struct drm_pending_event *e)
{
	unsigned long irqflags;

	spin_lock_irqsave(&dev->event_lock, irqflags);
	drm_send_event_locked(dev, e);
	spin_unlock_irqrestore(&dev->event_lock, irqflags);
}
EXPORT_SYMBOL(drm_send_event);