drmP.h 48.1 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2 3
 * Internal Header for the Direct Rendering Manager
 *
L
Linus Torvalds 已提交
4 5
 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6
 * Copyright (c) 2009-2010, Code Aurora Forum.
L
Linus Torvalds 已提交
7 8
 * All rights reserved.
 *
9 10 11
 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
 * Author: Gareth Hughes <gareth@valinux.com>
 *
L
Linus Torvalds 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 * 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.
 */

#ifndef _DRM_P_H_
#define _DRM_P_H_

35 36 37 38
#include <linux/agp_backend.h>
#include <linux/cdev.h>
#include <linux/dma-mapping.h>
#include <linux/file.h>
L
Linus Torvalds 已提交
39
#include <linux/fs.h>
40 41
#include <linux/highmem.h>
#include <linux/idr.h>
L
Linus Torvalds 已提交
42
#include <linux/init.h>
43
#include <linux/io.h>
L
Linus Torvalds 已提交
44
#include <linux/jiffies.h>
45 46 47
#include <linux/kernel.h>
#include <linux/kref.h>
#include <linux/miscdevice.h>
L
Linus Torvalds 已提交
48
#include <linux/mm.h>
D
Dave Airlie 已提交
49
#include <linux/mutex.h>
50 51 52
#include <linux/pci.h>
#include <linux/platform_device.h>
#include <linux/poll.h>
R
Rob Clark 已提交
53
#include <linux/ratelimit.h>
54 55
#include <linux/sched.h>
#include <linux/slab.h>
L
Linus Torvalds 已提交
56
#include <linux/types.h>
57
#include <linux/vmalloc.h>
58 59 60
#include <linux/workqueue.h>

#include <asm/mman.h>
L
Linus Torvalds 已提交
61
#include <asm/pgalloc.h>
62 63
#include <asm/uaccess.h>

64 65 66 67 68 69
#include <uapi/drm/drm.h>
#include <uapi/drm/drm_mode.h>

#include <drm/drm_agpsupport.h>
#include <drm/drm_crtc.h>
#include <drm/drm_global.h>
70
#include <drm/drm_hashtab.h>
71
#include <drm/drm_mem_util.h>
72 73
#include <drm/drm_mm.h>
#include <drm/drm_os_linux.h>
74
#include <drm/drm_sarea.h>
75
#include <drm/drm_vma_manager.h>
L
Linus Torvalds 已提交
76

77 78
struct module;

79 80
struct drm_file;
struct drm_device;
81
struct drm_agp_head;
82

83
struct device_node;
84
struct videomode;
85
struct reservation_object;
86

87
/*
88 89 90 91 92 93 94
 * 4 debug categories are defined:
 *
 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
 *	 This is the category used by the DRM_DEBUG() macro.
 *
 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
 *	   This is the category used by the DRM_DEBUG_DRIVER() macro.
95
 *
96 97
 * KMS: used in the modesetting code.
 *	This is the category used by the DRM_DEBUG_KMS() macro.
98
 *
99 100
 * PRIME: used in the prime code.
 *	  This is the category used by the DRM_DEBUG_PRIME() macro.
101
 *
102 103 104 105 106 107 108 109 110 111 112 113
 * Enabling verbose debug messages is done through the drm.debug parameter,
 * each category being enabled by a bit.
 *
 * drm.debug=0x1 will enable CORE messages
 * drm.debug=0x2 will enable DRIVER messages
 * drm.debug=0x3 will enable CORE and DRIVER messages
 * ...
 * drm.debug=0xf will enable all messages
 *
 * An interesting feature is that it's possible to enable verbose logging at
 * run-time by echoing the debug value in its sysfs node:
 *   # echo 0xf > /sys/module/drm/parameters/debug
114
 */
115 116 117 118
#define DRM_UT_CORE 		0x01
#define DRM_UT_DRIVER		0x02
#define DRM_UT_KMS		0x04
#define DRM_UT_PRIME		0x08
119

120 121
extern __printf(2, 3)
void drm_ut_debug_printk(const char *function_name,
122 123
			 const char *format, ...);
extern __printf(2, 3)
J
Joe Perches 已提交
124 125
int drm_err(const char *func, const char *format, ...);

L
Linus Torvalds 已提交
126 127 128 129 130 131 132 133 134 135 136
/***********************************************************************/
/** \name DRM template customization defaults */
/*@{*/

/* driver capabilities and requirements mask */
#define DRIVER_USE_AGP     0x1
#define DRIVER_PCI_DMA     0x8
#define DRIVER_SG          0x10
#define DRIVER_HAVE_DMA    0x20
#define DRIVER_HAVE_IRQ    0x40
#define DRIVER_IRQ_SHARED  0x80
137
#define DRIVER_GEM         0x1000
D
Dave Airlie 已提交
138
#define DRIVER_MODESET     0x2000
139
#define DRIVER_PRIME       0x4000
140
#define DRIVER_RENDER      0x8000
141

L
Linus Torvalds 已提交
142 143 144 145
/***********************************************************************/
/** \name Begin the DRM... */
/*@{*/

146
#define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
L
Linus Torvalds 已提交
147

D
Dave Airlie 已提交
148
/*@}*/
L
Linus Torvalds 已提交
149 150 151 152 153 154 155 156 157 158 159

/***********************************************************************/
/** \name Macros to make printk easier */
/*@{*/

/**
 * Error output.
 *
 * \param fmt printf() like format string.
 * \param arg arguments
 */
J
Joe Perches 已提交
160 161
#define DRM_ERROR(fmt, ...)				\
	drm_err(__func__, fmt, ##__VA_ARGS__)
L
Linus Torvalds 已提交
162

R
Rob Clark 已提交
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/**
 * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 *
 * \param fmt printf() like format string.
 * \param arg arguments
 */
#define DRM_ERROR_RATELIMITED(fmt, ...)				\
({									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
									\
	if (__ratelimit(&_rs))						\
		drm_err(__func__, fmt, ##__VA_ARGS__);			\
})

J
Joe Perches 已提交
179 180
#define DRM_INFO(fmt, ...)				\
	printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
L
Linus Torvalds 已提交
181

182 183 184
#define DRM_INFO_ONCE(fmt, ...)				\
	printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)

L
Linus Torvalds 已提交
185 186
/**
 * Debug output.
D
Dave Airlie 已提交
187
 *
L
Linus Torvalds 已提交
188 189 190
 * \param fmt printf() like format string.
 * \param arg arguments
 */
191
#define DRM_DEBUG(fmt, args...)						\
L
Linus Torvalds 已提交
192
	do {								\
193
		if (unlikely(drm_debug & DRM_UT_CORE))			\
194
			drm_ut_debug_printk(__func__, fmt, ##args);	\
195 196
	} while (0)

197
#define DRM_DEBUG_DRIVER(fmt, args...)					\
198
	do {								\
199
		if (unlikely(drm_debug & DRM_UT_DRIVER))		\
200
			drm_ut_debug_printk(__func__, fmt, ##args);	\
201
	} while (0)
202
#define DRM_DEBUG_KMS(fmt, args...)					\
203
	do {								\
204
		if (unlikely(drm_debug & DRM_UT_KMS))			\
205
			drm_ut_debug_printk(__func__, fmt, ##args);	\
206
	} while (0)
207 208
#define DRM_DEBUG_PRIME(fmt, args...)					\
	do {								\
209
		if (unlikely(drm_debug & DRM_UT_PRIME))			\
210
			drm_ut_debug_printk(__func__, fmt, ##args);	\
L
Linus Torvalds 已提交
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
	} while (0)

/*@}*/

/***********************************************************************/
/** \name Internal types and structures */
/*@{*/

#define DRM_IF_VERSION(maj, min) (maj << 16 | min)

/**
 * Test that the hardware lock is held by the caller, returning otherwise.
 *
 * \param dev DRM device.
 * \param filp file pointer of the caller.
 */
227 228 229 230
#define LOCK_TEST_WITH_RETURN( dev, _file_priv )				\
do {										\
	if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||	\
	    _file_priv->master->lock.file_priv != _file_priv)	{		\
231
		DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
232 233 234 235
			   __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
			   _file_priv->master->lock.file_priv, _file_priv);	\
		return -EINVAL;							\
	}									\
L
Linus Torvalds 已提交
236 237 238 239 240 241
} while (0)

/**
 * Ioctl function type.
 *
 * \param inode device inode.
242
 * \param file_priv DRM file private pointer.
L
Linus Torvalds 已提交
243 244 245
 * \param cmd command.
 * \param arg argument.
 */
246 247
typedef int drm_ioctl_t(struct drm_device *dev, void *data,
			struct drm_file *file_priv);
L
Linus Torvalds 已提交
248

249 250 251
typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
			       unsigned long arg);

252 253 254
#define DRM_IOCTL_NR(n)                _IOC_NR(n)
#define DRM_MAJOR       226

255 256 257
#define DRM_AUTH	0x1
#define	DRM_MASTER	0x2
#define DRM_ROOT_ONLY	0x4
D
Dave Airlie 已提交
258
#define DRM_CONTROL_ALLOW 0x8
259
#define DRM_UNLOCKED	0x10
260
#define DRM_RENDER_ALLOW 0x20
261

262 263
struct drm_ioctl_desc {
	unsigned int cmd;
264
	int flags;
265
	drm_ioctl_t *func;
266
	unsigned int cmd_drv;
267
	const char *name;
268 269 270 271 272 273
};

/**
 * Creates a driver or general drm_ioctl_desc array entry for the given
 * ioctl, for use by drm_ioctl().
 */
274 275

#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
276
	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
L
Linus Torvalds 已提交
277 278 279 280

/**
 * DMA buffer.
 */
D
Dave Airlie 已提交
281
struct drm_buf {
D
Dave Airlie 已提交
282 283 284 285 286 287 288 289 290 291
	int idx;		       /**< Index into master buflist */
	int total;		       /**< Buffer size */
	int order;		       /**< log-base-2(total) */
	int used;		       /**< Amount of buffer in use (for DMA) */
	unsigned long offset;	       /**< Byte offset (used internally) */
	void *address;		       /**< Address of buffer */
	unsigned long bus_address;     /**< Bus address of buffer */
	struct drm_buf *next;	       /**< Kernel-only: used for free list */
	__volatile__ int waiting;      /**< On kernel DMA queue */
	__volatile__ int pending;      /**< On hardware DMA queue */
292
	struct drm_file *file_priv;    /**< Private of holding file descr */
D
Dave Airlie 已提交
293 294
	int context;		       /**< Kernel queue for this buffer */
	int while_locked;	       /**< Dispatch this buffer while locked */
L
Linus Torvalds 已提交
295
	enum {
D
Dave Airlie 已提交
296 297 298 299 300
		DRM_LIST_NONE = 0,
		DRM_LIST_FREE = 1,
		DRM_LIST_WAIT = 2,
		DRM_LIST_PEND = 3,
		DRM_LIST_PRIO = 4,
L
Linus Torvalds 已提交
301
		DRM_LIST_RECLAIM = 5
D
Dave Airlie 已提交
302
	} list;			       /**< Which list we're on */
L
Linus Torvalds 已提交
303

D
Dave Airlie 已提交
304 305
	int dev_priv_size;		 /**< Size of buffer private storage */
	void *dev_private;		 /**< Per-buffer private storage */
D
Dave Airlie 已提交
306
};
L
Linus Torvalds 已提交
307

D
Dave Airlie 已提交
308 309 310 311 312 313
typedef struct drm_dma_handle {
	dma_addr_t busaddr;
	void *vaddr;
	size_t size;
} drm_dma_handle_t;

L
Linus Torvalds 已提交
314 315 316
/**
 * Buffer entry.  There is one of this for each buffer size order.
 */
317
struct drm_buf_entry {
D
Dave Airlie 已提交
318 319
	int buf_size;			/**< size */
	int buf_count;			/**< number of buffers */
D
Dave Airlie 已提交
320
	struct drm_buf *buflist;		/**< buffer list */
D
Dave Airlie 已提交
321 322
	int seg_count;
	int page_order;
323
	struct drm_dma_handle **seglist;
D
Dave Airlie 已提交
324

325 326
	int low_mark;			/**< Low water mark */
	int high_mark;			/**< High water mark */
327
};
L
Linus Torvalds 已提交
328

329 330 331 332 333
/* Event queued up for userspace to read */
struct drm_pending_event {
	struct drm_event *event;
	struct list_head link;
	struct drm_file *file_priv;
334 335
	pid_t pid; /* pid of requester, no guarantee it's valid by the time
		      we deliver the event, for tracing only */
336 337 338
	void (*destroy)(struct drm_pending_event *event);
};

339 340 341 342 343 344
/* initial implementaton using a linked list - todo hashtab */
struct drm_prime_file_private {
	struct list_head head;
	struct mutex lock;
};

L
Linus Torvalds 已提交
345
/** File private data */
346
struct drm_file {
347
	unsigned authenticated :1;
348 349
	/* Whether we're master for a minor. Protected by master_mutex */
	unsigned is_master :1;
350 351
	/* true when the client has asked us to expose stereo 3D mode flags */
	unsigned stereo_allowed :1;
352 353 354 355 356
	/*
	 * true if client understands CRTC primary planes and cursor planes
	 * in the plane list
	 */
	unsigned universal_planes:1;
357

358 359
	struct pid *pid;
	kuid_t uid;
D
Dave Airlie 已提交
360
	drm_magic_t magic;
361
	struct list_head lhead;
362
	struct drm_minor *minor;
D
Dave Airlie 已提交
363
	unsigned long lock_count;
364

365 366 367 368
	/** Mapping of mm object handles to object pointers. */
	struct idr object_idr;
	/** Lock for synchronization of access to object_idr. */
	spinlock_t table_lock;
369

370
	struct file *filp;
371
	void *driver_priv;
372 373 374

	struct drm_master *master; /* master this node is currently associated with
				      N.B. not always minor->master */
375 376 377 378 379 380
	/**
	 * fbs - List of framebuffers associated with this file.
	 *
	 * Protected by fbs_lock. Note that the fbs list holds a reference on
	 * the fb object to prevent it from untimely disappearing.
	 */
D
Dave Airlie 已提交
381
	struct list_head fbs;
382
	struct mutex fbs_lock;
383 384 385 386

	wait_queue_head_t event_wait;
	struct list_head event_list;
	int event_space;
387 388

	struct drm_prime_file_private prime;
389
};
L
Linus Torvalds 已提交
390 391 392 393

/**
 * Lock data.
 */
D
Dave Airlie 已提交
394
struct drm_lock_data {
395
	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
396 397
	/** Private of lock holder's file (NULL=kernel) */
	struct drm_file *file_priv;
L
Linus Torvalds 已提交
398
	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
D
Dave Airlie 已提交
399
	unsigned long lock_time;	/**< Time of last lock in jiffies */
400 401 402 403
	spinlock_t spinlock;
	uint32_t kernel_waiters;
	uint32_t user_waiters;
	int idle_has_lock;
D
Dave Airlie 已提交
404
};
L
Linus Torvalds 已提交
405 406 407 408

/**
 * DMA data.
 */
409
struct drm_device_dma {
L
Linus Torvalds 已提交
410

411
	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
D
Dave Airlie 已提交
412
	int buf_count;			/**< total number of buffers */
D
Dave Airlie 已提交
413
	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
D
Dave Airlie 已提交
414 415 416 417
	int seg_count;
	int page_count;			/**< number of pages */
	unsigned long *pagelist;	/**< page list */
	unsigned long byte_count;
L
Linus Torvalds 已提交
418 419
	enum {
		_DRM_DMA_USE_AGP = 0x01,
D
Dave Airlie 已提交
420
		_DRM_DMA_USE_SG = 0x02,
421 422
		_DRM_DMA_USE_FB = 0x04,
		_DRM_DMA_USE_PCI_RO = 0x08
L
Linus Torvalds 已提交
423 424
	} flags;

425
};
L
Linus Torvalds 已提交
426 427 428 429

/**
 * Scatter-gather memory.
 */
D
Dave Airlie 已提交
430
struct drm_sg_mem {
D
Dave Airlie 已提交
431 432 433 434 435
	unsigned long handle;
	void *virtual;
	int pages;
	struct page **pagelist;
	dma_addr_t *busaddr;
D
Dave Airlie 已提交
436
};
L
Linus Torvalds 已提交
437

438 439 440 441
/**
 * Kernel side of a mapping
 */
struct drm_local_map {
442
	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
443 444 445 446 447 448 449 450 451 452
	unsigned long size;	 /**< Requested physical size (bytes) */
	enum drm_map_type type;	 /**< Type of memory to map */
	enum drm_map_flags flags;	 /**< Flags */
	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
				 /**< Kernel-space: kernel-virtual address */
	int mtrr;		 /**< MTRR slot used */
};

typedef struct drm_local_map drm_local_map_t;

L
Linus Torvalds 已提交
453 454 455
/**
 * Mappings list
 */
D
Dave Airlie 已提交
456
struct drm_map_list {
D
Dave Airlie 已提交
457
	struct list_head head;		/**< list head */
458
	struct drm_hash_item hash;
459
	struct drm_local_map *map;	/**< mapping */
460
	uint64_t user_token;
461
	struct drm_master *master;
D
Dave Airlie 已提交
462
};
L
Linus Torvalds 已提交
463

464

465 466 467 468 469 470 471 472
/**
 * This structure defines the drm_mm memory object, which will be used by the
 * DRM for its buffer objects.
 */
struct drm_gem_object {
	/** Reference count of this object */
	struct kref refcount;

473 474 475 476 477 478 479 480 481 482
	/**
	 * handle_count - gem file_priv handle count of this object
	 *
	 * Each handle also holds a reference. Note that when the handle_count
	 * drops to 0 any global names (e.g. the id in the flink namespace) will
	 * be cleared.
	 *
	 * Protected by dev->object_name_lock.
	 * */
	unsigned handle_count;
483 484 485 486 487 488 489

	/** Related drm device */
	struct drm_device *dev;

	/** File representing the shmem storage */
	struct file *filp;

J
Jesse Barnes 已提交
490
	/* Mapping info for this object */
491
	struct drm_vma_offset_node vma_node;
J
Jesse Barnes 已提交
492

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
	/**
	 * Size of the object, in bytes.  Immutable over the object's
	 * lifetime.
	 */
	size_t size;

	/**
	 * Global name for this object, starts at 1. 0 means unnamed.
	 * Access is covered by the object_name_lock in the related drm_device
	 */
	int name;

	/**
	 * Memory domains. These monitor which caches contain read/write data
	 * related to the object. When transitioning from one set of domains
	 * to another, the driver is called to ensure that caches are suitably
	 * flushed and invalidated
	 */
	uint32_t read_domains;
	uint32_t write_domain;

	/**
	 * While validating an exec operation, the
	 * new read/write domain values are computed here.
	 * They will be transferred to the above values
	 * at the point that any cache flushing occurs
	 */
	uint32_t pending_read_domains;
	uint32_t pending_write_domain;

523 524 525 526 527 528 529 530 531 532
	/**
	 * dma_buf - dma buf associated with this GEM object
	 *
	 * Pointer to the dma-buf associated with this gem object (either
	 * through importing or exporting). We break the resulting reference
	 * loop when the last gem handle for this object is released.
	 *
	 * Protected by obj->object_name_lock
	 */
	struct dma_buf *dma_buf;
533

534 535 536 537 538 539 540 541 542
	/**
	 * import_attach - dma buf attachment backing this object
	 *
	 * Any foreign dma_buf imported as a gem object has this set to the
	 * attachment point for the device. This is invariant over the lifetime
	 * of a gem object.
	 *
	 * The driver's ->gem_free_object callback is responsible for cleaning
	 * up the dma_buf attachment and references acquired at import time.
543 544 545 546 547
	 *
	 * Note that the drm gem/prime core does not depend upon drivers setting
	 * this field any more. So for drivers where this doesn't make sense
	 * (e.g. virtual devices or a displaylink behind an usb bus) they can
	 * simply leave it as NULL.
548
	 */
549
	struct dma_buf_attachment *import_attach;
550 551
};

552 553 554 555 556 557 558 559 560 561 562 563
/**
 * struct drm_master - drm master structure
 *
 * @refcount: Refcount for this master object.
 * @minor: Link back to minor char device we are master for. Immutable.
 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
 * @unique_len: Length of unique field. Protected by drm_global_mutex.
 * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
 * @magicfree: List of used authentication tokens. Protected by struct_mutex.
 * @lock: DRI lock information.
 * @driver_priv: Pointer to driver-private information.
 */
564
struct drm_master {
565 566 567 568
	struct kref refcount;
	struct drm_minor *minor;
	char *unique;
	int unique_len;
569 570
	struct drm_open_hash magiclist;
	struct list_head magicfree;
571 572
	struct drm_lock_data lock;
	void *driver_priv;
573 574
};

575 576 577 578 579 580 581 582
/* Size of ringbuffer for vblank timestamps. Just double-buffer
 * in initial implementation.
 */
#define DRM_VBLANKTIME_RBSIZE 2

/* Flags and return codes for get_vblank_timestamp() driver function. */
#define DRM_CALLED_FROM_VBLIRQ 1
#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
583
#define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
584 585 586

/* get_scanout_position() return flags */
#define DRM_SCANOUTPOS_VALID        (1 << 0)
587
#define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
588 589
#define DRM_SCANOUTPOS_ACCURATE     (1 << 2)

L
Linus Torvalds 已提交
590 591 592 593 594 595
/**
 * DRM driver structure. This structure represent the common code for
 * a family of cards. There will one drm_device for each card present
 * in this family
 */
struct drm_driver {
596 597
	int (*load) (struct drm_device *, unsigned long flags);
	int (*firstopen) (struct drm_device *);
598
	int (*open) (struct drm_device *, struct drm_file *);
599
	void (*preclose) (struct drm_device *, struct drm_file *file_priv);
600
	void (*postclose) (struct drm_device *, struct drm_file *);
601 602
	void (*lastclose) (struct drm_device *);
	int (*unload) (struct drm_device *);
603
	int (*suspend) (struct drm_device *, pm_message_t state);
J
Jesse Barnes 已提交
604
	int (*resume) (struct drm_device *);
605
	int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
D
Dave Airlie 已提交
606
	int (*dma_quiescent) (struct drm_device *);
607
	int (*context_dtor) (struct drm_device *dev, int context);
608
	int (*set_busid)(struct drm_device *dev, struct drm_master *master);
D
Dave Airlie 已提交
609

610 611 612 613 614
	/**
	 * get_vblank_counter - get raw hardware vblank counter
	 * @dev: DRM device
	 * @crtc: counter to fetch
	 *
615 616 617 618 619
	 * Driver callback for fetching a raw hardware vblank counter for @crtc.
	 * If a device doesn't have a hardware counter, the driver can simply
	 * return the value of drm_vblank_count. The DRM core will account for
	 * missed vblank events while interrupts where disabled based on system
	 * timestamps.
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
	 *
	 * Wraparound handling and loss of events due to modesetting is dealt
	 * with in the DRM core code.
	 *
	 * RETURNS
	 * Raw vblank counter value.
	 */
	u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);

	/**
	 * enable_vblank - enable vblank interrupt events
	 * @dev: DRM device
	 * @crtc: which irq to enable
	 *
	 * Enable vblank interrupts for @crtc.  If the device doesn't have
	 * a hardware vblank counter, this routine should be a no-op, since
	 * interrupts will have to stay on to keep the count accurate.
	 *
	 * RETURNS
	 * Zero on success, appropriate errno if the given @crtc's vblank
	 * interrupt cannot be enabled.
	 */
	int (*enable_vblank) (struct drm_device *dev, int crtc);

	/**
	 * disable_vblank - disable vblank interrupt events
	 * @dev: DRM device
	 * @crtc: which irq to enable
	 *
	 * Disable vblank interrupts for @crtc.  If the device doesn't have
	 * a hardware vblank counter, this routine should be a no-op, since
	 * interrupts will have to stay on to keep the count accurate.
	 */
	void (*disable_vblank) (struct drm_device *dev, int crtc);

655 656 657 658 659 660 661 662 663 664 665
	/**
	 * Called by \c drm_device_is_agp.  Typically used to determine if a
	 * card is really attached to AGP or not.
	 *
	 * \param dev  DRM device handle
	 *
	 * \returns
	 * One of three values is returned depending on whether or not the
	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
	 * (return of 1), or may or may not be AGP (return of 2).
	 */
666
	int (*device_is_agp) (struct drm_device *dev);
667

668 669 670
	/**
	 * Called by vblank timestamping code.
	 *
671 672
	 * Return the current display scanout position from a crtc, and an
	 * optional accurate ktime_get timestamp of when position was measured.
673 674 675
	 *
	 * \param dev  DRM device.
	 * \param crtc Id of the crtc to query.
676
	 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
677 678
	 * \param *vpos Target location for current vertical scanout position.
	 * \param *hpos Target location for current horizontal scanout position.
679 680 681 682
	 * \param *stime Target location for timestamp taken immediately before
	 *               scanout position query. Can be NULL to skip timestamp.
	 * \param *etime Target location for timestamp taken immediately after
	 *               scanout position query. Can be NULL to skip timestamp.
683 684 685 686 687 688 689 690
	 *
	 * Returns vpos as a positive number while in active scanout area.
	 * Returns vpos as a negative number inside vblank, counting the number
	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
	 * until start of active scanout / end of vblank."
	 *
	 * \return Flags, or'ed together as follows:
	 *
L
Lucas De Marchi 已提交
691
	 * DRM_SCANOUTPOS_VALID = Query successful.
692 693 694 695 696 697 698
	 * DRM_SCANOUTPOS_INVBL = Inside vblank.
	 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
	 * this flag means that returned position may be offset by a constant
	 * but unknown small number of scanlines wrt. real scanout position.
	 *
	 */
	int (*get_scanout_position) (struct drm_device *dev, int crtc,
699
				     unsigned int flags,
700 701
				     int *vpos, int *hpos, ktime_t *stime,
				     ktime_t *etime);
702 703 704 705 706 707 708 709

	/**
	 * Called by \c drm_get_last_vbltimestamp. Should return a precise
	 * timestamp when the most recent VBLANK interval ended or will end.
	 *
	 * Specifically, the timestamp in @vblank_time should correspond as
	 * closely as possible to the time when the first video scanline of
	 * the video frame after the end of VBLANK will start scanning out,
710
	 * the time immediately after end of the VBLANK interval. If the
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
	 * @crtc is currently inside VBLANK, this will be a time in the future.
	 * If the @crtc is currently scanning out a frame, this will be the
	 * past start time of the current scanout. This is meant to adhere
	 * to the OpenML OML_sync_control extension specification.
	 *
	 * \param dev dev DRM device handle.
	 * \param crtc crtc for which timestamp should be returned.
	 * \param *max_error Maximum allowable timestamp error in nanoseconds.
	 *                   Implementation should strive to provide timestamp
	 *                   with an error of at most *max_error nanoseconds.
	 *                   Returns true upper bound on error for timestamp.
	 * \param *vblank_time Target location for returned vblank timestamp.
	 * \param flags 0 = Defaults, no special treatment needed.
	 * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
	 *	        irq handler. Some drivers need to apply some workarounds
	 *              for gpu-specific vblank irq quirks if flag is set.
	 *
	 * \returns
	 * Zero if timestamping isn't supported in current display mode or a
	 * negative number on failure. A positive status code on success,
	 * which describes how the vblank_time timestamp was computed.
	 */
	int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
				     int *max_error,
				     struct timeval *vblank_time,
				     unsigned flags);

L
Linus Torvalds 已提交
738
	/* these have to be filled in */
D
Dave Airlie 已提交
739

D
Daniel Vetter 已提交
740
	irqreturn_t(*irq_handler) (int irq, void *arg);
741
	void (*irq_preinstall) (struct drm_device *dev);
742
	int (*irq_postinstall) (struct drm_device *dev);
743
	void (*irq_uninstall) (struct drm_device *dev);
744

745 746 747
	/* Master routines */
	int (*master_create)(struct drm_device *dev, struct drm_master *master);
	void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
748 749 750 751 752 753 754 755 756
	/**
	 * master_set is called whenever the minor master is set.
	 * master_drop is called whenever the minor master is dropped.
	 */

	int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
			  bool from_open);
	void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
			    bool from_release);
757

758 759
	int (*debugfs_init)(struct drm_minor *minor);
	void (*debugfs_cleanup)(struct drm_minor *minor);
760 761 762 763 764 765 766 767

	/**
	 * Driver-specific constructor for drm_gem_objects, to set up
	 * obj->driver_private.
	 *
	 * Returns 0 on success.
	 */
	void (*gem_free_object) (struct drm_gem_object *obj);
768 769
	int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
	void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
770

771 772 773 774 775 776 777 778 779 780 781 782 783
	/* prime: */
	/* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
	int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
				uint32_t handle, uint32_t flags, int *prime_fd);
	/* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
	int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
				int prime_fd, uint32_t *handle);
	/* export GEM -> dmabuf */
	struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
				struct drm_gem_object *obj, int flags);
	/* import dmabuf -> GEM */
	struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
				struct dma_buf *dma_buf);
A
Aaron Plattner 已提交
784 785
	/* low-level interface used by drm_gem_prime_{import,export} */
	int (*gem_prime_pin)(struct drm_gem_object *obj);
786
	void (*gem_prime_unpin)(struct drm_gem_object *obj);
787 788
	struct reservation_object * (*gem_prime_res_obj)(
				struct drm_gem_object *obj);
A
Aaron Plattner 已提交
789 790 791 792 793 794
	struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
	struct drm_gem_object *(*gem_prime_import_sg_table)(
				struct drm_device *dev, size_t size,
				struct sg_table *sgt);
	void *(*gem_prime_vmap)(struct drm_gem_object *obj);
	void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
795 796
	int (*gem_prime_mmap)(struct drm_gem_object *obj,
				struct vm_area_struct *vma);
797

798 799 800
	/* vga arb irq handler */
	void (*vgaarb_irq)(struct drm_device *dev, bool state);

801 802 803 804 805 806 807 808 809 810 811
	/* dumb alloc support */
	int (*dumb_create)(struct drm_file *file_priv,
			   struct drm_device *dev,
			   struct drm_mode_create_dumb *args);
	int (*dumb_map_offset)(struct drm_file *file_priv,
			       struct drm_device *dev, uint32_t handle,
			       uint64_t *offset);
	int (*dumb_destroy)(struct drm_file *file_priv,
			    struct drm_device *dev,
			    uint32_t handle);

J
Jesse Barnes 已提交
812
	/* Driver private ops for this object */
813
	const struct vm_operations_struct *gem_vm_ops;
J
Jesse Barnes 已提交
814

815 816 817 818 819 820 821
	int major;
	int minor;
	int patchlevel;
	char *name;
	char *desc;
	char *date;

L
Linus Torvalds 已提交
822 823
	u32 driver_features;
	int dev_priv_size;
R
Rob Clark 已提交
824
	const struct drm_ioctl_desc *ioctls;
L
Linus Torvalds 已提交
825
	int num_ioctls;
826
	const struct file_operations *fops;
827

828 829
	/* List of devices hanging off this driver with stealth attach. */
	struct list_head legacy_dev_list;
L
Linus Torvalds 已提交
830 831
};

D
David Herrmann 已提交
832 833 834 835 836 837
enum drm_minor_type {
	DRM_MINOR_LEGACY,
	DRM_MINOR_CONTROL,
	DRM_MINOR_RENDER,
	DRM_MINOR_CNT,
};
838

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
/**
 * Info file list entry. This structure represents a debugfs or proc file to
 * be created by the drm core
 */
struct drm_info_list {
	const char *name; /** file name */
	int (*show)(struct seq_file*, void*); /** show callback */
	u32 driver_features; /**< Required driver features for this entry */
	void *data;
};

/**
 * debugfs node structure. This structure represents a debugfs file.
 */
struct drm_info_node {
	struct list_head list;
	struct drm_minor *minor;
D
David Howells 已提交
856
	const struct drm_info_list *info_ent;
857 858 859
	struct dentry *dent;
};

L
Linus Torvalds 已提交
860
/**
861
 * DRM minor structure. This structure represents a drm minor number.
L
Linus Torvalds 已提交
862
 */
863 864 865
struct drm_minor {
	int index;			/**< Minor device number */
	int type;                       /**< Control or render */
866
	struct device *kdev;		/**< Linux device */
L
Linus Torvalds 已提交
867
	struct drm_device *dev;
868 869

	struct dentry *debugfs_root;
870 871 872

	struct list_head debugfs_list;
	struct mutex debugfs_lock; /* Protects debugfs_list. */
873

874 875
	/* currently active master for this node. Protected by master_mutex */
	struct drm_master *master;
D
Dave Airlie 已提交
876
	struct drm_mode_group mode_group;
877
};
L
Linus Torvalds 已提交
878

879

880 881 882 883 884 885
struct drm_pending_vblank_event {
	struct drm_pending_event base;
	int pipe;
	struct drm_event_vblank event;
};

886
struct drm_vblank_crtc {
887
	struct drm_device *dev;		/* pointer to the drm_device */
888 889
	wait_queue_head_t queue;	/**< VBLANK wait queue */
	struct timeval time[DRM_VBLANKTIME_RBSIZE];	/**< timestamp of current count */
890
	struct timer_list disable_timer;		/* delayed disable timer */
891 892 893 894 895 896
	atomic_t count;			/**< number of VBLANK interrupts */
	atomic_t refcount;		/* number of users of vblank interruptsper crtc */
	u32 last;			/* protected by dev->vbl_lock, used */
					/* for wraparound handling */
	u32 last_wait;			/* Last vblank seqno waited per CRTC */
	unsigned int inmodeset;		/* Display driver is setting mode */
897
	int crtc;			/* crtc index */
898 899 900 901
	bool enabled;			/* so we don't call enable more than
					   once per disable */
};

L
Linus Torvalds 已提交
902 903 904 905
/**
 * DRM device structure. This structure represent a complete card that
 * may contain multiple heads.
 */
906
struct drm_device {
907
	struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
D
Dave Airlie 已提交
908
	int if_version;			/**< Highest interface version set */
L
Linus Torvalds 已提交
909

910 911
	/** \name Lifetime Management */
	/*@{ */
D
David Herrmann 已提交
912
	struct kref ref;		/**< Object ref-count */
913 914 915 916 917 918 919
	struct device *dev;		/**< Device structure of bus-device */
	struct drm_driver *driver;	/**< DRM driver managing the device */
	void *dev_private;		/**< DRM driver private data */
	struct drm_minor *control;		/**< Control node */
	struct drm_minor *primary;		/**< Primary node */
	struct drm_minor *render;		/**< Render node */
	atomic_t unplugged;			/**< Flag whether dev is dead */
920
	struct inode *anon_inode;		/**< inode for private address-space */
921
	char *unique;				/**< unique name of the device */
922 923
	/*@} */

L
Linus Torvalds 已提交
924
	/** \name Locks */
D
Dave Airlie 已提交
925
	/*@{ */
D
Dave Airlie 已提交
926
	struct mutex struct_mutex;	/**< For others */
927
	struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
D
Dave Airlie 已提交
928
	/*@} */
L
Linus Torvalds 已提交
929 930

	/** \name Usage Counters */
D
Dave Airlie 已提交
931
	/*@{ */
932
	int open_count;			/**< Outstanding files open, protected by drm_global_mutex. */
933
	spinlock_t buf_lock;		/**< For drm_device::buf_use and a few other things. */
D
Dave Airlie 已提交
934 935 936
	int buf_use;			/**< Buffers in use -- cannot alloc */
	atomic_t buf_alloc;		/**< Buffer allocation in progress */
	/*@} */
L
Linus Torvalds 已提交
937

938
	struct list_head filelist;
L
Linus Torvalds 已提交
939 940

	/** \name Memory management */
D
Dave Airlie 已提交
941
	/*@{ */
942
	struct list_head maplist;	/**< Linked list of regions */
943
	struct drm_open_hash map_hash;	/**< User token hash table for maps */
L
Linus Torvalds 已提交
944 945

	/** \name Context handle management */
D
Dave Airlie 已提交
946
	/*@{ */
947
	struct list_head ctxlist;	/**< Linked list of context handles */
D
Dave Airlie 已提交
948
	struct mutex ctxlist_mutex;	/**< For ctxlist */
L
Linus Torvalds 已提交
949

950
	struct idr ctx_idr;
L
Linus Torvalds 已提交
951

952
	struct list_head vmalist;	/**< List of vmas (for debugging) */
D
Dave Airlie 已提交
953

D
Dave Airlie 已提交
954
	/*@} */
L
Linus Torvalds 已提交
955

D
Daniel Vetter 已提交
956
	/** \name DMA support */
D
Dave Airlie 已提交
957
	/*@{ */
958
	struct drm_device_dma *dma;		/**< Optional pointer for DMA support */
D
Dave Airlie 已提交
959
	/*@} */
L
Linus Torvalds 已提交
960 961

	/** \name Context support */
D
Dave Airlie 已提交
962
	/*@{ */
V
Ville Syrjälä 已提交
963
	bool irq_enabled;		/**< True if irq handler is enabled */
964 965
	int irq;

L
Linus Torvalds 已提交
966
	__volatile__ long context_flag;	/**< Context swapping flag */
D
Dave Airlie 已提交
967 968 969
	int last_context;		/**< Last current context */
	/*@} */

L
Linus Torvalds 已提交
970
	/** \name VBLANK IRQ support */
D
Dave Airlie 已提交
971 972
	/*@{ */

973 974 975 976 977 978
	/*
	 * At load time, disabling the vblank interrupt won't be allowed since
	 * old clients may not call the modeset ioctl and therefore misbehave.
	 * Once the modeset ioctl *has* been called though, we can safely
	 * disable them when unused.
	 */
979
	bool vblank_disable_allowed;
980

981 982 983 984 985 986 987 988 989 990
	/*
	 * If true, vblank interrupt will be disabled immediately when the
	 * refcount drops to zero, as opposed to via the vblank disable
	 * timer.
	 * This can be set to true it the hardware has a working vblank
	 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
	 * appropriately.
	 */
	bool vblank_disable_immediate;

991 992
	/* array of size num_crtcs */
	struct drm_vblank_crtc *vblank;
993

994
	spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
D
Dave Airlie 已提交
995
	spinlock_t vbl_lock;
996 997

	u32 max_vblank_count;           /**< size of vblank counter register */
D
Dave Airlie 已提交
998

999 1000 1001 1002 1003 1004
	/**
	 * List of events
	 */
	struct list_head vblank_event_list;
	spinlock_t event_lock;

D
Dave Airlie 已提交
1005 1006
	/*@} */

D
Dave Airlie 已提交
1007
	struct drm_agp_head *agp;	/**< AGP data */
L
Linus Torvalds 已提交
1008

D
Dave Airlie 已提交
1009
	struct pci_dev *pdev;		/**< PCI device structure */
L
Linus Torvalds 已提交
1010 1011 1012
#ifdef __alpha__
	struct pci_controller *hose;
#endif
1013 1014 1015

	struct platform_device *platformdev; /**< Platform device struture */

D
Dave Airlie 已提交
1016
	struct drm_sg_mem *sg;	/**< Scatter gather memory */
1017
	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
D
Dave Airlie 已提交
1018 1019
	sigset_t sigmask;

1020 1021 1022 1023 1024
	struct {
		int context;
		struct drm_hw_lock *lock;
	} sigdata;

1025
	struct drm_local_map *agp_buffer_map;
1026
	unsigned int agp_buffer_token;
1027

D
Dave Airlie 已提交
1028 1029
        struct drm_mode_config mode_config;	/**< Current mode config */

1030 1031
	/** \name GEM information */
	/*@{ */
1032
	struct mutex object_name_lock;
1033
	struct idr object_name_idr;
1034
	struct drm_vma_offset_manager *vma_offset_manager;
1035
	/*@} */
1036
	int switch_power_state;
1037
};
L
Linus Torvalds 已提交
1038

1039 1040 1041
#define DRM_SWITCH_POWER_ON 0
#define DRM_SWITCH_POWER_OFF 1
#define DRM_SWITCH_POWER_CHANGING 2
1042
#define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1043

D
Dave Airlie 已提交
1044 1045
static __inline__ int drm_core_check_feature(struct drm_device *dev,
					     int feature)
L
Linus Torvalds 已提交
1046 1047 1048 1049
{
	return ((dev->driver->driver_features & feature) ? 1 : 0);
}

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
static inline void drm_device_set_unplugged(struct drm_device *dev)
{
	smp_wmb();
	atomic_set(&dev->unplugged, 1);
}

static inline int drm_device_is_unplugged(struct drm_device *dev)
{
	int ret = atomic_read(&dev->unplugged);
	smp_rmb();
	return ret;
}

1063
static inline bool drm_is_render_client(const struct drm_file *file_priv)
1064 1065 1066 1067
{
	return file_priv->minor->type == DRM_MINOR_RENDER;
}

1068 1069 1070 1071 1072
static inline bool drm_is_control_client(const struct drm_file *file_priv)
{
	return file_priv->minor->type == DRM_MINOR_CONTROL;
}

1073 1074 1075 1076 1077
static inline bool drm_is_primary_client(const struct drm_file *file_priv)
{
	return file_priv->minor->type == DRM_MINOR_LEGACY;
}

L
Linus Torvalds 已提交
1078 1079 1080 1081 1082
/******************************************************************/
/** \name Internal function definitions */
/*@{*/

				/* Driver support (drm_drv.h) */
1083 1084
extern long drm_ioctl(struct file *filp,
		      unsigned int cmd, unsigned long arg);
D
Dave Airlie 已提交
1085 1086
extern long drm_compat_ioctl(struct file *filp,
			     unsigned int cmd, unsigned long arg);
1087
extern int drm_lastclose(struct drm_device *dev);
1088
extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
L
Linus Torvalds 已提交
1089 1090

				/* Device support (drm_fops.h) */
A
Arnd Bergmann 已提交
1091
extern struct mutex drm_global_mutex;
D
Dave Airlie 已提交
1092
extern int drm_open(struct inode *inode, struct file *filp);
1093 1094
extern ssize_t drm_read(struct file *filp, char __user *buffer,
			size_t count, loff_t *offset);
D
Dave Airlie 已提交
1095
extern int drm_release(struct inode *inode, struct file *filp);
L
Linus Torvalds 已提交
1096 1097

				/* Mapping support (drm_vm.h) */
D
Dave Airlie 已提交
1098
extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
J
Jesse Barnes 已提交
1099
extern int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma);
1100 1101
extern void drm_vm_open_locked(struct drm_device *dev, struct vm_area_struct *vma);
extern void drm_vm_close_locked(struct drm_device *dev, struct vm_area_struct *vma);
D
Dave Airlie 已提交
1102
extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
L
Linus Torvalds 已提交
1103 1104

				/* Misc. IOCTL support (drm_ioctl.h) */
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
extern int drm_irq_by_busid(struct drm_device *dev, void *data,
			    struct drm_file *file_priv);
extern int drm_getunique(struct drm_device *dev, void *data,
			 struct drm_file *file_priv);
extern int drm_setunique(struct drm_device *dev, void *data,
			 struct drm_file *file_priv);
extern int drm_getmap(struct drm_device *dev, void *data,
		      struct drm_file *file_priv);
extern int drm_getclient(struct drm_device *dev, void *data,
			 struct drm_file *file_priv);
extern int drm_getstats(struct drm_device *dev, void *data,
			struct drm_file *file_priv);
1117 1118
extern int drm_getcap(struct drm_device *dev, void *data,
		      struct drm_file *file_priv);
D
Damien Lespiau 已提交
1119 1120
extern int drm_setclientcap(struct drm_device *dev, void *data,
			    struct drm_file *file_priv);
1121 1122 1123 1124
extern int drm_setversion(struct drm_device *dev, void *data,
			  struct drm_file *file_priv);
extern int drm_noop(struct drm_device *dev, void *data,
		    struct drm_file *file_priv);
L
Linus Torvalds 已提交
1125 1126

				/* Authentication IOCTL support (drm_auth.h) */
1127 1128 1129 1130
extern int drm_getmagic(struct drm_device *dev, void *data,
			struct drm_file *file_priv);
extern int drm_authmagic(struct drm_device *dev, void *data,
			 struct drm_file *file_priv);
1131
extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
L
Linus Torvalds 已提交
1132

1133 1134
/* Cache management (drm_cache.c) */
void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1135
void drm_clflush_sg(struct sg_table *st);
1136
void drm_clflush_virt_range(void *addr, unsigned long length);
1137

1138 1139 1140 1141 1142
/*
 * These are exported to drivers so that they can implement fencing using
 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
 */

L
Linus Torvalds 已提交
1143
				/* IRQ support (drm_irq.h) */
1144 1145
extern int drm_control(struct drm_device *dev, void *data,
		       struct drm_file *file_priv);
1146
extern int drm_irq_install(struct drm_device *dev, int irq);
1147
extern int drm_irq_uninstall(struct drm_device *dev);
D
Dave Airlie 已提交
1148

1149
extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1150
extern int drm_wait_vblank(struct drm_device *dev, void *data,
1151 1152
			   struct drm_file *filp);
extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1153 1154
extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
				     struct timeval *vblanktime);
1155 1156
extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
				     struct drm_pending_vblank_event *e);
1157
extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1158 1159
extern int drm_vblank_get(struct drm_device *dev, int crtc);
extern void drm_vblank_put(struct drm_device *dev, int crtc);
1160 1161
extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1162 1163
extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1164
extern void drm_vblank_off(struct drm_device *dev, int crtc);
V
Ville Syrjälä 已提交
1165
extern void drm_vblank_on(struct drm_device *dev, int crtc);
1166 1167
extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1168
extern void drm_vblank_cleanup(struct drm_device *dev);
1169

1170 1171 1172 1173
extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
						 int crtc, int *max_error,
						 struct timeval *vblank_time,
						 unsigned flags,
1174 1175
						 const struct drm_crtc *refcrtc,
						 const struct drm_display_mode *mode);
1176 1177
extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
					    const struct drm_display_mode *mode);
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
/**
 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
 * @crtc: which CRTC's vblank waitqueue to retrieve
 *
 * This function returns a pointer to the vblank waitqueue for the CRTC.
 * Drivers can use this to implement vblank waits using wait_event() & co.
 */
static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
{
	return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
}
1190

1191
/* Modesetting support */
D
Dave Airlie 已提交
1192 1193
extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1194 1195
extern int drm_modeset_ctl(struct drm_device *dev, void *data,
			   struct drm_file *file_priv);
L
Linus Torvalds 已提交
1196 1197

				/* Stub support (drm_stub.h) */
1198 1199 1200 1201 1202 1203 1204
extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
			       struct drm_file *file_priv);
extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
				struct drm_file *file_priv);
struct drm_master *drm_master_create(struct drm_minor *minor);
extern struct drm_master *drm_master_get(struct drm_master *master);
extern void drm_master_put(struct drm_master **master);
1205

1206
extern void drm_put_dev(struct drm_device *dev);
1207
extern void drm_unplug_dev(struct drm_device *dev);
D
Dave Airlie 已提交
1208
extern unsigned int drm_debug;
1209

1210
extern int drm_vblank_offdelay;
1211
extern unsigned int drm_timestamp_precision;
1212
extern unsigned int drm_timestamp_monotonic;
1213

1214
extern struct class *drm_class;
1215

1216 1217 1218 1219
				/* Debugfs support */
#if defined(CONFIG_DEBUG_FS)
extern int drm_debugfs_init(struct drm_minor *minor, int minor_id,
			    struct dentry *root);
1220 1221 1222 1223 1224
extern int drm_debugfs_create_files(const struct drm_info_list *files,
				    int count, struct dentry *root,
				    struct drm_minor *minor);
extern int drm_debugfs_remove_files(const struct drm_info_list *files,
				    int count, struct drm_minor *minor);
1225
extern int drm_debugfs_cleanup(struct drm_minor *minor);
1226 1227
extern int drm_debugfs_connector_add(struct drm_connector *connector);
extern void drm_debugfs_connector_remove(struct drm_connector *connector);
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
#else
static inline int drm_debugfs_init(struct drm_minor *minor, int minor_id,
				   struct dentry *root)
{
	return 0;
}

static inline int drm_debugfs_create_files(const struct drm_info_list *files,
					   int count, struct dentry *root,
					   struct drm_minor *minor)
{
	return 0;
}

static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
					   int count, struct drm_minor *minor)
{
	return 0;
}

static inline int drm_debugfs_cleanup(struct drm_minor *minor)
{
	return 0;
}
1252 1253 1254 1255 1256 1257 1258 1259 1260

static inline int drm_debugfs_connector_add(struct drm_connector *connector)
{
	return 0;
}
static inline void drm_debugfs_connector_remove(struct drm_connector *connector)
{
}

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
#endif

				/* Info file support */
extern int drm_name_info(struct seq_file *m, void *data);
extern int drm_vm_info(struct seq_file *m, void *data);
extern int drm_bufs_info(struct seq_file *m, void *data);
extern int drm_vblank_info(struct seq_file *m, void *data);
extern int drm_clients_info(struct seq_file *m, void* data);
extern int drm_gem_name_info(struct seq_file *m, void *data);

1271

A
Aaron Plattner 已提交
1272 1273
extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
		struct drm_gem_object *obj, int flags);
1274 1275 1276
extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
		int *prime_fd);
A
Aaron Plattner 已提交
1277 1278
extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
		struct dma_buf *dma_buf);
1279 1280
extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1281
extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1282 1283 1284 1285 1286 1287

extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
					struct drm_file *file_priv);
extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
					struct drm_file *file_priv);

1288 1289
extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
					    dma_addr_t *addrs, int max_pages);
1290 1291 1292
extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages);
extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);

1293 1294 1295
int drm_gem_dumb_destroy(struct drm_file *file,
			 struct drm_device *dev,
			 uint32_t handle);
1296 1297 1298

void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1299
void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1300

1301 1302
extern int drm_vma_info(struct seq_file *m, void *data);

L
Linus Torvalds 已提交
1303

1304
extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1305
				       size_t align);
1306 1307
extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
D
Daniel Vetter 已提交
1308 1309 1310
extern int drm_pci_set_unique(struct drm_device *dev,
			      struct drm_master *master,
			      struct drm_unique *u);
L
Linus Torvalds 已提交
1311

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
				/* Legacy Support */

int drm_legacy_addmap(struct drm_device *d, resource_size_t offset,
		      unsigned int size, enum drm_map_type type,
		      enum drm_map_flags flags, struct drm_local_map **map_p);
int drm_legacy_rmmap(struct drm_device *d, struct drm_local_map *map);
int drm_legacy_rmmap_locked(struct drm_device *d, struct drm_local_map *map);
struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev);

int drm_legacy_addbufs_agp(struct drm_device *d, struct drm_buf_desc *req);
int drm_legacy_addbufs_pci(struct drm_device *d, struct drm_buf_desc *req);

1324 1325 1326
void drm_legacy_idlelock_take(struct drm_lock_data *lock);
void drm_legacy_idlelock_release(struct drm_lock_data *lock);

L
Linus Torvalds 已提交
1327
			       /* sysfs support (drm_sysfs.c) */
J
Jesse Barnes 已提交
1328
struct drm_sysfs_class;
1329
extern struct class *drm_sysfs_create(struct module *owner, char *name);
J
Jesse Barnes 已提交
1330
extern void drm_sysfs_destroy(void);
1331
extern struct device *drm_sysfs_minor_alloc(struct drm_minor *minor);
D
Dave Airlie 已提交
1332 1333 1334
extern void drm_sysfs_hotplug_event(struct drm_device *dev);
extern int drm_sysfs_connector_add(struct drm_connector *connector);
extern void drm_sysfs_connector_remove(struct drm_connector *connector);
L
Linus Torvalds 已提交
1335

1336 1337
/* Graphics Execution Manager library functions (drm_gem.c) */
int drm_gem_init(struct drm_device *dev);
J
Jesse Barnes 已提交
1338
void drm_gem_destroy(struct drm_device *dev);
1339
void drm_gem_object_release(struct drm_gem_object *obj);
1340
void drm_gem_object_free(struct kref *kref);
D
Daniel Vetter 已提交
1341 1342
int drm_gem_object_init(struct drm_device *dev,
			struct drm_gem_object *obj, size_t size);
1343 1344
void drm_gem_private_object_init(struct drm_device *dev,
				 struct drm_gem_object *obj, size_t size);
1345 1346
void drm_gem_vm_open(struct vm_area_struct *vma);
void drm_gem_vm_close(struct vm_area_struct *vma);
1347 1348
int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
		     struct vm_area_struct *vma);
J
Jesse Barnes 已提交
1349
int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

static inline void
drm_gem_object_reference(struct drm_gem_object *obj)
{
	kref_get(&obj->refcount);
}

static inline void
drm_gem_object_unreference(struct drm_gem_object *obj)
{
1360 1361 1362
	if (obj != NULL)
		kref_put(&obj->refcount, drm_gem_object_free);
}
1363

1364 1365 1366
static inline void
drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
{
1367
	if (obj && !atomic_add_unless(&obj->refcount.refcount, -1, 1)) {
1368
		struct drm_device *dev = obj->dev;
1369

1370
		mutex_lock(&dev->struct_mutex);
1371 1372
		if (likely(atomic_dec_and_test(&obj->refcount.refcount)))
			drm_gem_object_free(&obj->refcount);
1373 1374
		mutex_unlock(&dev->struct_mutex);
	}
1375 1376
}

1377 1378 1379
int drm_gem_handle_create_tail(struct drm_file *file_priv,
			       struct drm_gem_object *obj,
			       u32 *handlep);
1380 1381
int drm_gem_handle_create(struct drm_file *file_priv,
			  struct drm_gem_object *obj,
1382
			  u32 *handlep);
1383
int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1384

1385

1386 1387
void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1388
int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
1389

1390
struct page **drm_gem_get_pages(struct drm_gem_object *obj);
1391 1392 1393
void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
		bool dirty, bool accessed);

1394 1395
struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
					     struct drm_file *filp,
1396
					     u32 handle);
1397 1398 1399 1400 1401 1402 1403 1404 1405
int drm_gem_close_ioctl(struct drm_device *dev, void *data,
			struct drm_file *file_priv);
int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
			struct drm_file *file_priv);
int drm_gem_open_ioctl(struct drm_device *dev, void *data,
		       struct drm_file *file_priv);
void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);

1406 1407 1408
extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
L
Linus Torvalds 已提交
1409

1410 1411
static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
							 unsigned int token)
L
Linus Torvalds 已提交
1412
{
D
Dave Airlie 已提交
1413
	struct drm_map_list *_entry;
1414
	list_for_each_entry(_entry, &dev->maplist, head)
D
Dave Airlie 已提交
1415 1416
	    if (_entry->user_token == token)
		return _entry->map;
L
Linus Torvalds 已提交
1417 1418 1419
	return NULL;
}

1420
static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1421
{
1422 1423
}

D
David Herrmann 已提交
1424 1425
struct drm_device *drm_dev_alloc(struct drm_driver *driver,
				 struct device *parent);
D
David Herrmann 已提交
1426 1427
void drm_dev_ref(struct drm_device *dev);
void drm_dev_unref(struct drm_device *dev);
1428
int drm_dev_register(struct drm_device *dev, unsigned long flags);
1429
void drm_dev_unregister(struct drm_device *dev);
1430
int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1431 1432 1433 1434

struct drm_minor *drm_minor_acquire(unsigned int minor_id);
void drm_minor_release(struct drm_minor *minor);

1435 1436 1437 1438 1439
/*@}*/

/* PCI section */
static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
{
D
Dave Airlie 已提交
1440 1441 1442
	if (dev->driver->device_is_agp != NULL) {
		int err = (*dev->driver->device_is_agp) (dev);

1443 1444 1445 1446 1447 1448 1449
		if (err != 2) {
			return err;
		}
	}

	return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
}
1450
void drm_pci_agp_destroy(struct drm_device *dev);
1451

1452 1453 1454
extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
extern int drm_get_pci_dev(struct pci_dev *pdev,
1455 1456
			   const struct pci_device_id *ent,
			   struct drm_driver *driver);
1457
extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1458

1459 1460 1461 1462 1463
#define DRM_PCIE_SPEED_25 1
#define DRM_PCIE_SPEED_50 2
#define DRM_PCIE_SPEED_80 4

extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1464 1465 1466

/* platform section */
extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1467
extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
1468

1469 1470 1471 1472 1473 1474 1475 1476
/* returns true if currently okay to sleep */
static __inline__ bool drm_can_sleep(void)
{
	if (in_atomic() || in_dbg_master() || irqs_disabled())
		return false;
	return true;
}

L
Linus Torvalds 已提交
1477
#endif