blob: 8ba35c622e2202a889a3a06706bdc93e035fb841 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Herrmannd7d2c482014-08-29 12:12:40 +02002 * Internal Header for the Direct Rendering Manager
3 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
Jordan Crousedcdb1672010-05-27 13:40:25 -06006 * Copyright (c) 2009-2010, Code Aurora Forum.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * All rights reserved.
8 *
David Herrmannd7d2c482014-08-29 12:12:40 +02009 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10 * Author: Gareth Hughes <gareth@valinux.com>
11 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice (including the next
20 * paragraph) shall be included in all copies or substantial portions of the
21 * Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
27 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
28 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29 * OTHER DEALINGS IN THE SOFTWARE.
30 */
31
32#ifndef _DRM_P_H_
33#define _DRM_P_H_
34
David Herrmann96993902014-08-29 12:12:37 +020035#include <linux/agp_backend.h>
36#include <linux/cdev.h>
37#include <linux/dma-mapping.h>
38#include <linux/file.h>
39#include <linux/fs.h>
40#include <linux/highmem.h>
41#include <linux/idr.h>
42#include <linux/init.h>
43#include <linux/io.h>
44#include <linux/jiffies.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/kernel.h>
David Herrmann099d1c22014-01-29 10:21:36 +010046#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/miscdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/mm.h>
Dave Airlie30e2fb12006-02-02 19:37:46 +110049#include <linux/mutex.h>
David Herrmann96993902014-08-29 12:12:37 +020050#include <linux/pci.h>
51#include <linux/platform_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/poll.h>
David Herrmann96993902014-08-29 12:12:37 +020053#include <linux/ratelimit.h>
54#include <linux/sched.h>
55#include <linux/slab.h>
56#include <linux/types.h>
David Herrmannd6db6562014-08-29 12:12:35 +020057#include <linux/vmalloc.h>
David Herrmann96993902014-08-29 12:12:37 +020058#include <linux/workqueue.h>
59
60#include <asm/mman.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#include <asm/pgalloc.h>
David Herrmann96993902014-08-29 12:12:37 +020062#include <asm/uaccess.h>
63
David Herrmannd7d2c482014-08-29 12:12:40 +020064#include <uapi/drm/drm.h>
65#include <uapi/drm/drm_mode.h>
66
67#include <drm/drm_agpsupport.h>
68#include <drm/drm_crtc.h>
69#include <drm/drm_global.h>
David Herrmann96993902014-08-29 12:12:37 +020070#include <drm/drm_hashtab.h>
David Herrmannd7d2c482014-08-29 12:12:40 +020071#include <drm/drm_mem_util.h>
David Herrmann96993902014-08-29 12:12:37 +020072#include <drm/drm_mm.h>
73#include <drm/drm_os_linux.h>
David Howells19218e42012-10-02 18:01:03 +010074#include <drm/drm_sarea.h>
David Herrmann0de23972013-07-24 21:07:52 +020075#include <drm/drm_vma_manager.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Paul Gortmakerde477252011-05-26 13:46:22 -040077struct module;
78
Eric Anholtc153f452007-09-03 12:06:45 +100079struct drm_file;
80struct drm_device;
David Herrmanncc5ea592014-08-29 12:12:32 +020081struct drm_agp_head;
Daniel Vetterba8286f2014-09-11 07:43:25 +020082struct drm_local_map;
83struct drm_device_dma;
84struct drm_dma_handle;
Daniel Vetterd9fc9412014-09-23 15:46:53 +020085struct drm_gem_object;
Eric Anholtc153f452007-09-03 12:06:45 +100086
Steffen Trumtraredb37a92012-10-28 18:28:06 +010087struct device_node;
Steffen Trumtrarebc64e42012-11-14 11:22:52 +010088struct videomode;
Maarten Lankhorst3aac4502014-07-01 12:57:26 +020089struct reservation_object;
Maarten Lankhorstb5e9c1a2014-01-09 11:03:14 +010090struct dma_buf_attachment;
Steffen Trumtrarebc64e42012-11-14 11:22:52 +010091
Lespiau, Damien1414b762014-03-24 15:53:08 +000092/*
93 * 4 debug categories are defined:
94 *
95 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
96 * This is the category used by the DRM_DEBUG() macro.
97 *
98 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
99 * This is the category used by the DRM_DEBUG_DRIVER() macro.
100 *
101 * KMS: used in the modesetting code.
102 * This is the category used by the DRM_DEBUG_KMS() macro.
103 *
104 * PRIME: used in the prime code.
105 * This is the category used by the DRM_DEBUG_PRIME() macro.
106 *
107 * Enabling verbose debug messages is done through the drm.debug parameter,
108 * each category being enabled by a bit.
109 *
110 * drm.debug=0x1 will enable CORE messages
111 * drm.debug=0x2 will enable DRIVER messages
112 * drm.debug=0x3 will enable CORE and DRIVER messages
113 * ...
114 * drm.debug=0xf will enable all messages
115 *
116 * An interesting feature is that it's possible to enable verbose logging at
117 * run-time by echoing the debug value in its sysfs node:
118 * # echo 0xf > /sys/module/drm/parameters/debug
119 */
yakui_zhao4fefcb22009-06-02 14:09:47 +0800120#define DRM_UT_CORE 0x01
121#define DRM_UT_DRIVER 0x02
122#define DRM_UT_KMS 0x04
Dave Airlie32488772011-11-25 15:21:02 +0000123#define DRM_UT_PRIME 0x08
yakui_zhao4fefcb22009-06-02 14:09:47 +0800124
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000125extern __printf(2, 3)
126void drm_ut_debug_printk(const char *function_name,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700127 const char *format, ...);
Joe Perchesa1f1a792014-10-11 22:08:57 -0700128extern __printf(1, 2)
129void drm_err(const char *format, ...);
Joe Perches5ad3d882011-04-17 20:35:51 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131/***********************************************************************/
132/** \name DRM template customization defaults */
133/*@{*/
134
135/* driver capabilities and requirements mask */
136#define DRIVER_USE_AGP 0x1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137#define DRIVER_PCI_DMA 0x8
138#define DRIVER_SG 0x10
139#define DRIVER_HAVE_DMA 0x20
140#define DRIVER_HAVE_IRQ 0x40
141#define DRIVER_IRQ_SHARED 0x80
Eric Anholt673a3942008-07-30 12:06:12 -0700142#define DRIVER_GEM 0x1000
Dave Airlief453ba02008-11-07 14:05:41 -0800143#define DRIVER_MODESET 0x2000
Dave Airlie32488772011-11-25 15:21:02 +0000144#define DRIVER_PRIME 0x4000
David Herrmann17931262013-08-25 18:29:00 +0200145#define DRIVER_RENDER 0x8000
Dave Airlie8410ea32010-12-15 03:16:38 +1000146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/***********************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/** \name Macros to make printk easier */
149/*@{*/
150
151/**
152 * Error output.
153 *
154 * \param fmt printf() like format string.
155 * \param arg arguments
156 */
Joe Perches5ad3d882011-04-17 20:35:51 -0700157#define DRM_ERROR(fmt, ...) \
Joe Perchesa1f1a792014-10-11 22:08:57 -0700158 drm_err(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Rob Clark5d13d422013-11-21 14:29:51 -0500160/**
161 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
162 *
163 * \param fmt printf() like format string.
164 * \param arg arguments
165 */
166#define DRM_ERROR_RATELIMITED(fmt, ...) \
167({ \
168 static DEFINE_RATELIMIT_STATE(_rs, \
169 DEFAULT_RATELIMIT_INTERVAL, \
170 DEFAULT_RATELIMIT_BURST); \
171 \
172 if (__ratelimit(&_rs)) \
Joe Perchesa1f1a792014-10-11 22:08:57 -0700173 drm_err(fmt, ##__VA_ARGS__); \
Rob Clark5d13d422013-11-21 14:29:51 -0500174})
175
Joe Perches5ad3d882011-04-17 20:35:51 -0700176#define DRM_INFO(fmt, ...) \
177 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Jani Nikula48b8f632014-01-31 15:49:07 +0200179#define DRM_INFO_ONCE(fmt, ...) \
180 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182/**
183 * Debug output.
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000184 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 * \param fmt printf() like format string.
186 * \param arg arguments
187 */
yakui_zhao4fefcb22009-06-02 14:09:47 +0800188#define DRM_DEBUG(fmt, args...) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000190 if (unlikely(drm_debug & DRM_UT_CORE)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000191 drm_ut_debug_printk(__func__, fmt, ##args); \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800192 } while (0)
193
Zhao Yakui8a4c47f2009-07-20 13:48:04 +0800194#define DRM_DEBUG_DRIVER(fmt, args...) \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800195 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000196 if (unlikely(drm_debug & DRM_UT_DRIVER)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000197 drm_ut_debug_printk(__func__, fmt, ##args); \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800198 } while (0)
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000199#define DRM_DEBUG_KMS(fmt, args...) \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800200 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000201 if (unlikely(drm_debug & DRM_UT_KMS)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000202 drm_ut_debug_printk(__func__, fmt, ##args); \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800203 } while (0)
Dave Airlie32488772011-11-25 15:21:02 +0000204#define DRM_DEBUG_PRIME(fmt, args...) \
205 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000206 if (unlikely(drm_debug & DRM_UT_PRIME)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000207 drm_ut_debug_printk(__func__, fmt, ##args); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210/*@}*/
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/***********************************************************************/
213/** \name Internal types and structures */
214/*@{*/
215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#define DRM_IF_VERSION(maj, min) (maj << 16 | min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 * Ioctl function type.
220 *
221 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +1000222 * \param file_priv DRM file private pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 * \param cmd command.
224 * \param arg argument.
225 */
Eric Anholtc153f452007-09-03 12:06:45 +1000226typedef int drm_ioctl_t(struct drm_device *dev, void *data,
227 struct drm_file *file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Dave Airlie9a186642005-06-23 21:29:18 +1000229typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
230 unsigned long arg);
231
Kristian Høgsberg1a959162009-12-02 12:13:48 -0500232#define DRM_IOCTL_NR(n) _IOC_NR(n)
233#define DRM_MAJOR 226
234
Dave Airliea7a2cc32006-01-02 13:54:04 +1100235#define DRM_AUTH 0x1
236#define DRM_MASTER 0x2
237#define DRM_ROOT_ONLY 0x4
Dave Airlief453ba02008-11-07 14:05:41 -0800238#define DRM_CONTROL_ALLOW 0x8
Arnd Bergmanned8b6702009-12-16 22:17:09 +0000239#define DRM_UNLOCKED 0x10
David Herrmann17931262013-08-25 18:29:00 +0200240#define DRM_RENDER_ALLOW 0x20
Dave Airliea7a2cc32006-01-02 13:54:04 +1100241
Eric Anholtc153f452007-09-03 12:06:45 +1000242struct drm_ioctl_desc {
243 unsigned int cmd;
Dave Airliea7a2cc32006-01-02 13:54:04 +1100244 int flags;
Richard Kennedyc972d752009-03-18 17:26:44 +0000245 drm_ioctl_t *func;
Dave Airlie1b2f1482010-08-14 20:20:34 +1000246 unsigned int cmd_drv;
Chris Cumminsb9434d02013-05-09 14:20:40 +0100247 const char *name;
Eric Anholtc153f452007-09-03 12:06:45 +1000248};
249
250/**
251 * Creates a driver or general drm_ioctl_desc array entry for the given
252 * ioctl, for use by drm_ioctl().
253 */
Dave Airlie1b2f1482010-08-14 20:20:34 +1000254
255#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
Chris Cumminsb9434d02013-05-09 14:20:40 +0100256 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000258/* Event queued up for userspace to read */
259struct drm_pending_event {
260 struct drm_event *event;
261 struct list_head link;
262 struct drm_file *file_priv;
Jesse Barnesb9c2c9a2010-07-01 16:48:09 -0700263 pid_t pid; /* pid of requester, no guarantee it's valid by the time
264 we deliver the event, for tracing only */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000265 void (*destroy)(struct drm_pending_event *event);
266};
267
Dave Airlie32488772011-11-25 15:21:02 +0000268/* initial implementaton using a linked list - todo hashtab */
269struct drm_prime_file_private {
270 struct list_head head;
271 struct mutex lock;
272};
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274/** File private data */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000275struct drm_file {
Chris Wilson39868bd2013-10-29 08:55:58 +0000276 unsigned authenticated :1;
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100277 /* Whether we're master for a minor. Protected by master_mutex */
278 unsigned is_master :1;
Chris Wilson39868bd2013-10-29 08:55:58 +0000279 /* true when the client has asked us to expose stereo 3D mode flags */
280 unsigned stereo_allowed :1;
Matt Roper681e7ec2014-04-01 15:22:42 -0700281 /*
282 * true if client understands CRTC primary planes and cursor planes
283 * in the plane list
284 */
285 unsigned universal_planes:1;
Chris Wilson39868bd2013-10-29 08:55:58 +0000286
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800287 struct pid *pid;
288 kuid_t uid;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000289 drm_magic_t magic;
Dave Airliebd1b3312007-05-26 05:01:51 +1000290 struct list_head lhead;
Dave Airlie2c14f282008-04-21 16:47:32 +1000291 struct drm_minor *minor;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000292 unsigned long lock_count;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000293
Eric Anholt673a3942008-07-30 12:06:12 -0700294 /** Mapping of mm object handles to object pointers. */
295 struct idr object_idr;
296 /** Lock for synchronization of access to object_idr. */
297 spinlock_t table_lock;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000298
Eric Anholt6c340ea2007-08-25 20:23:09 +1000299 struct file *filp;
Dave Airlie8562b3f2007-11-05 12:37:41 +1000300 void *driver_priv;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000301
Dave Airlie7c1c2872008-11-28 14:22:24 +1000302 struct drm_master *master; /* master this node is currently associated with
303 N.B. not always minor->master */
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100304 /**
305 * fbs - List of framebuffers associated with this file.
306 *
307 * Protected by fbs_lock. Note that the fbs list holds a reference on
308 * the fb object to prevent it from untimely disappearing.
309 */
Dave Airlief453ba02008-11-07 14:05:41 -0800310 struct list_head fbs;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100311 struct mutex fbs_lock;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000312
313 wait_queue_head_t event_wait;
314 struct list_head event_list;
315 int event_space;
Dave Airlie32488772011-11-25 15:21:02 +0000316
317 struct drm_prime_file_private prime;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000318};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/**
321 * Lock data.
322 */
Dave Airlie55910512007-07-11 16:53:40 +1000323struct drm_lock_data {
Dave Airliec60ce622007-07-11 15:27:12 +1000324 struct drm_hw_lock *hw_lock; /**< Hardware lock */
Dave Airlie8562b3f2007-11-05 12:37:41 +1000325 /** Private of lock holder's file (NULL=kernel) */
326 struct drm_file *file_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000328 unsigned long lock_time; /**< Time of last lock in jiffies */
Thomas Hellstrom040ac322007-03-23 13:28:33 +1100329 spinlock_t spinlock;
330 uint32_t kernel_waiters;
331 uint32_t user_waiters;
332 int idle_has_lock;
Dave Airlie55910512007-07-11 16:53:40 +1000333};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335/**
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100336 * struct drm_master - drm master structure
337 *
338 * @refcount: Refcount for this master object.
339 * @minor: Link back to minor char device we are master for. Immutable.
340 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
341 * @unique_len: Length of unique field. Protected by drm_global_mutex.
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100342 * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
343 * @magicfree: List of used authentication tokens. Protected by struct_mutex.
344 * @lock: DRI lock information.
345 * @driver_priv: Pointer to driver-private information.
346 */
Dave Airlie7c1c2872008-11-28 14:22:24 +1000347struct drm_master {
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100348 struct kref refcount;
349 struct drm_minor *minor;
350 char *unique;
351 int unique_len;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000352 struct drm_open_hash magiclist;
353 struct list_head magicfree;
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100354 struct drm_lock_data lock;
355 void *driver_priv;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000356};
357
Mario Kleiner27641c32010-10-23 04:20:23 +0200358/* Size of ringbuffer for vblank timestamps. Just double-buffer
359 * in initial implementation.
360 */
361#define DRM_VBLANKTIME_RBSIZE 2
362
363/* Flags and return codes for get_vblank_timestamp() driver function. */
364#define DRM_CALLED_FROM_VBLIRQ 1
365#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
Daniel Vetter3d3cbd82014-09-10 17:36:11 +0200366#define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
Mario Kleiner27641c32010-10-23 04:20:23 +0200367
368/* get_scanout_position() return flags */
369#define DRM_SCANOUTPOS_VALID (1 << 0)
Daniel Vetter3d3cbd82014-09-10 17:36:11 +0200370#define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
Mario Kleiner27641c32010-10-23 04:20:23 +0200371#define DRM_SCANOUTPOS_ACCURATE (1 << 2)
372
Eric Anholt673a3942008-07-30 12:06:12 -0700373/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * DRM driver structure. This structure represent the common code for
375 * a family of cards. There will one drm_device for each card present
376 * in this family
377 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378struct drm_driver {
Dave Airlie22eae942005-11-10 22:16:34 +1100379 int (*load) (struct drm_device *, unsigned long flags);
380 int (*firstopen) (struct drm_device *);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000381 int (*open) (struct drm_device *, struct drm_file *);
Eric Anholt6c340ea2007-08-25 20:23:09 +1000382 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000383 void (*postclose) (struct drm_device *, struct drm_file *);
Dave Airlie22eae942005-11-10 22:16:34 +1100384 void (*lastclose) (struct drm_device *);
385 int (*unload) (struct drm_device *);
Dave Airlieb932ccb2008-02-20 10:02:20 +1000386 int (*suspend) (struct drm_device *, pm_message_t state);
Jesse Barnese8b962b2007-11-22 14:02:38 +1000387 int (*resume) (struct drm_device *);
Eric Anholtc153f452007-09-03 12:06:45 +1000388 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000389 int (*dma_quiescent) (struct drm_device *);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000390 int (*context_dtor) (struct drm_device *dev, int context);
David Herrmann915b4d12014-08-29 12:12:43 +0200391 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000392
Dave Airliecda17382005-07-10 17:31:26 +1000393 /**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700394 * get_vblank_counter - get raw hardware vblank counter
395 * @dev: DRM device
396 * @crtc: counter to fetch
397 *
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200398 * Driver callback for fetching a raw hardware vblank counter for @crtc.
399 * If a device doesn't have a hardware counter, the driver can simply
400 * return the value of drm_vblank_count. The DRM core will account for
401 * missed vblank events while interrupts where disabled based on system
402 * timestamps.
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700403 *
404 * Wraparound handling and loss of events due to modesetting is dealt
405 * with in the DRM core code.
406 *
407 * RETURNS
408 * Raw vblank counter value.
409 */
410 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
411
412 /**
413 * enable_vblank - enable vblank interrupt events
414 * @dev: DRM device
415 * @crtc: which irq to enable
416 *
417 * Enable vblank interrupts for @crtc. If the device doesn't have
418 * a hardware vblank counter, this routine should be a no-op, since
419 * interrupts will have to stay on to keep the count accurate.
420 *
421 * RETURNS
422 * Zero on success, appropriate errno if the given @crtc's vblank
423 * interrupt cannot be enabled.
424 */
425 int (*enable_vblank) (struct drm_device *dev, int crtc);
426
427 /**
428 * disable_vblank - disable vblank interrupt events
429 * @dev: DRM device
430 * @crtc: which irq to enable
431 *
432 * Disable vblank interrupts for @crtc. If the device doesn't have
433 * a hardware vblank counter, this routine should be a no-op, since
434 * interrupts will have to stay on to keep the count accurate.
435 */
436 void (*disable_vblank) (struct drm_device *dev, int crtc);
437
438 /**
Dave Airliecda17382005-07-10 17:31:26 +1000439 * Called by \c drm_device_is_agp. Typically used to determine if a
440 * card is really attached to AGP or not.
441 *
442 * \param dev DRM device handle
443 *
444 * \returns
445 * One of three values is returned depending on whether or not the
446 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
447 * (return of 1), or may or may not be AGP (return of 2).
448 */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000449 int (*device_is_agp) (struct drm_device *dev);
Dave Airliecda17382005-07-10 17:31:26 +1000450
Mario Kleiner27641c32010-10-23 04:20:23 +0200451 /**
452 * Called by vblank timestamping code.
453 *
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100454 * Return the current display scanout position from a crtc, and an
455 * optional accurate ktime_get timestamp of when position was measured.
Mario Kleiner27641c32010-10-23 04:20:23 +0200456 *
457 * \param dev DRM device.
458 * \param crtc Id of the crtc to query.
Ville Syrjäläabca9e42013-10-28 20:50:48 +0200459 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
Mario Kleiner27641c32010-10-23 04:20:23 +0200460 * \param *vpos Target location for current vertical scanout position.
461 * \param *hpos Target location for current horizontal scanout position.
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100462 * \param *stime Target location for timestamp taken immediately before
463 * scanout position query. Can be NULL to skip timestamp.
464 * \param *etime Target location for timestamp taken immediately after
465 * scanout position query. Can be NULL to skip timestamp.
Mario Kleiner27641c32010-10-23 04:20:23 +0200466 *
467 * Returns vpos as a positive number while in active scanout area.
468 * Returns vpos as a negative number inside vblank, counting the number
469 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
470 * until start of active scanout / end of vblank."
471 *
472 * \return Flags, or'ed together as follows:
473 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300474 * DRM_SCANOUTPOS_VALID = Query successful.
Mario Kleiner27641c32010-10-23 04:20:23 +0200475 * DRM_SCANOUTPOS_INVBL = Inside vblank.
476 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
477 * this flag means that returned position may be offset by a constant
478 * but unknown small number of scanlines wrt. real scanout position.
479 *
480 */
481 int (*get_scanout_position) (struct drm_device *dev, int crtc,
Ville Syrjäläabca9e42013-10-28 20:50:48 +0200482 unsigned int flags,
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100483 int *vpos, int *hpos, ktime_t *stime,
484 ktime_t *etime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200485
486 /**
487 * Called by \c drm_get_last_vbltimestamp. Should return a precise
488 * timestamp when the most recent VBLANK interval ended or will end.
489 *
490 * Specifically, the timestamp in @vblank_time should correspond as
491 * closely as possible to the time when the first video scanline of
492 * the video frame after the end of VBLANK will start scanning out,
Justin P. Mattock42b2aa82011-11-28 20:31:00 -0800493 * the time immediately after end of the VBLANK interval. If the
Mario Kleiner27641c32010-10-23 04:20:23 +0200494 * @crtc is currently inside VBLANK, this will be a time in the future.
495 * If the @crtc is currently scanning out a frame, this will be the
496 * past start time of the current scanout. This is meant to adhere
497 * to the OpenML OML_sync_control extension specification.
498 *
499 * \param dev dev DRM device handle.
500 * \param crtc crtc for which timestamp should be returned.
501 * \param *max_error Maximum allowable timestamp error in nanoseconds.
502 * Implementation should strive to provide timestamp
503 * with an error of at most *max_error nanoseconds.
504 * Returns true upper bound on error for timestamp.
505 * \param *vblank_time Target location for returned vblank timestamp.
506 * \param flags 0 = Defaults, no special treatment needed.
507 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
508 * irq handler. Some drivers need to apply some workarounds
509 * for gpu-specific vblank irq quirks if flag is set.
510 *
511 * \returns
512 * Zero if timestamping isn't supported in current display mode or a
513 * negative number on failure. A positive status code on success,
514 * which describes how the vblank_time timestamp was computed.
515 */
516 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
517 int *max_error,
518 struct timeval *vblank_time,
519 unsigned flags);
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 /* these have to be filled in */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000522
Daniel Vettere9f0d762013-12-11 11:34:42 +0100523 irqreturn_t(*irq_handler) (int irq, void *arg);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000524 void (*irq_preinstall) (struct drm_device *dev);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700525 int (*irq_postinstall) (struct drm_device *dev);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000526 void (*irq_uninstall) (struct drm_device *dev);
Dave Airlie22eae942005-11-10 22:16:34 +1100527
Dave Airlie7c1c2872008-11-28 14:22:24 +1000528 /* Master routines */
529 int (*master_create)(struct drm_device *dev, struct drm_master *master);
530 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
Thomas Hellstrom862302f2009-12-02 18:15:25 +0000531 /**
532 * master_set is called whenever the minor master is set.
533 * master_drop is called whenever the minor master is dropped.
534 */
535
536 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
537 bool from_open);
538 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
539 bool from_release);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000540
Ben Gamari955b12d2009-02-17 20:08:49 -0500541 int (*debugfs_init)(struct drm_minor *minor);
542 void (*debugfs_cleanup)(struct drm_minor *minor);
Eric Anholt673a3942008-07-30 12:06:12 -0700543
544 /**
545 * Driver-specific constructor for drm_gem_objects, to set up
546 * obj->driver_private.
547 *
548 * Returns 0 on success.
549 */
Eric Anholt673a3942008-07-30 12:06:12 -0700550 void (*gem_free_object) (struct drm_gem_object *obj);
Ben Skeggs304eda32011-06-09 00:24:59 +0000551 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
552 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
Eric Anholt673a3942008-07-30 12:06:12 -0700553
Dave Airlie32488772011-11-25 15:21:02 +0000554 /* prime: */
555 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
556 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
557 uint32_t handle, uint32_t flags, int *prime_fd);
558 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
559 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
560 int prime_fd, uint32_t *handle);
561 /* export GEM -> dmabuf */
562 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
563 struct drm_gem_object *obj, int flags);
564 /* import dmabuf -> GEM */
565 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
566 struct dma_buf *dma_buf);
Aaron Plattner89177642013-01-15 20:47:42 +0000567 /* low-level interface used by drm_gem_prime_{import,export} */
568 int (*gem_prime_pin)(struct drm_gem_object *obj);
Maarten Lankhorst102d6db2013-04-09 09:18:44 +0200569 void (*gem_prime_unpin)(struct drm_gem_object *obj);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200570 struct reservation_object * (*gem_prime_res_obj)(
571 struct drm_gem_object *obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000572 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
573 struct drm_gem_object *(*gem_prime_import_sg_table)(
Maarten Lankhorstb5e9c1a2014-01-09 11:03:14 +0100574 struct drm_device *dev,
575 struct dma_buf_attachment *attach,
Aaron Plattner89177642013-01-15 20:47:42 +0000576 struct sg_table *sgt);
577 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
578 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
Joonyoung Shim7c397cd2013-06-28 14:24:53 +0900579 int (*gem_prime_mmap)(struct drm_gem_object *obj,
580 struct vm_area_struct *vma);
Dave Airlie32488772011-11-25 15:21:02 +0000581
Dave Airlie28d52042009-09-21 14:33:58 +1000582 /* vga arb irq handler */
583 void (*vgaarb_irq)(struct drm_device *dev, bool state);
584
Dave Airlieff72145b2011-02-07 12:16:14 +1000585 /* dumb alloc support */
586 int (*dumb_create)(struct drm_file *file_priv,
587 struct drm_device *dev,
588 struct drm_mode_create_dumb *args);
589 int (*dumb_map_offset)(struct drm_file *file_priv,
590 struct drm_device *dev, uint32_t handle,
591 uint64_t *offset);
592 int (*dumb_destroy)(struct drm_file *file_priv,
593 struct drm_device *dev,
594 uint32_t handle);
595
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800596 /* Driver private ops for this object */
Laurent Pinchart78b68552012-05-17 13:27:22 +0200597 const struct vm_operations_struct *gem_vm_ops;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800598
Dave Airlie22eae942005-11-10 22:16:34 +1100599 int major;
600 int minor;
601 int patchlevel;
602 char *name;
603 char *desc;
604 char *date;
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 u32 driver_features;
607 int dev_priv_size;
Rob Clarkbaa70942013-08-02 13:27:49 -0400608 const struct drm_ioctl_desc *ioctls;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 int num_ioctls;
Arjan van de Vene08e96d2011-10-31 07:28:57 -0700610 const struct file_operations *fops;
Dave Airlie8410ea32010-12-15 03:16:38 +1000611
Daniel Vetterb3f23332013-12-11 11:34:31 +0100612 /* List of devices hanging off this driver with stealth attach. */
613 struct list_head legacy_dev_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614};
615
David Herrmanncb8a2392014-01-29 12:31:40 +0100616enum drm_minor_type {
617 DRM_MINOR_LEGACY,
618 DRM_MINOR_CONTROL,
619 DRM_MINOR_RENDER,
620 DRM_MINOR_CNT,
621};
Dave Airlie2c14f282008-04-21 16:47:32 +1000622
Ben Gamari955b12d2009-02-17 20:08:49 -0500623/**
624 * Info file list entry. This structure represents a debugfs or proc file to
625 * be created by the drm core
626 */
627struct drm_info_list {
628 const char *name; /** file name */
629 int (*show)(struct seq_file*, void*); /** show callback */
630 u32 driver_features; /**< Required driver features for this entry */
631 void *data;
632};
633
634/**
635 * debugfs node structure. This structure represents a debugfs file.
636 */
637struct drm_info_node {
638 struct list_head list;
639 struct drm_minor *minor;
David Howellsce089b52013-04-12 15:23:25 +0100640 const struct drm_info_list *info_ent;
Ben Gamari955b12d2009-02-17 20:08:49 -0500641 struct dentry *dent;
642};
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644/**
Dave Airlie2c14f282008-04-21 16:47:32 +1000645 * DRM minor structure. This structure represents a drm minor number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 */
Dave Airlie2c14f282008-04-21 16:47:32 +1000647struct drm_minor {
648 int index; /**< Minor device number */
649 int type; /**< Control or render */
Dave Airlie5bdebb12013-10-11 14:07:25 +1000650 struct device *kdev; /**< Linux device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 struct drm_device *dev;
Ben Gamari955b12d2009-02-17 20:08:49 -0500652
Ben Gamari955b12d2009-02-17 20:08:49 -0500653 struct dentry *debugfs_root;
Marcin Slusarzb3e067c2011-11-09 22:20:35 +0100654
655 struct list_head debugfs_list;
656 struct mutex debugfs_lock; /* Protects debugfs_list. */
Ben Gamari955b12d2009-02-17 20:08:49 -0500657
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100658 /* currently active master for this node. Protected by master_mutex */
659 struct drm_master *master;
Dave Airlief453ba02008-11-07 14:05:41 -0800660 struct drm_mode_group mode_group;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000661};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Chris Wilson1794d252011-04-17 07:43:32 +0100663
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000664struct drm_pending_vblank_event {
665 struct drm_pending_event base;
666 int pipe;
667 struct drm_event_vblank event;
668};
669
Ville Syrjälä5380e922013-10-04 14:53:36 +0300670struct drm_vblank_crtc {
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200671 struct drm_device *dev; /* pointer to the drm_device */
Ville Syrjälä5380e922013-10-04 14:53:36 +0300672 wait_queue_head_t queue; /**< VBLANK wait queue */
673 struct timeval time[DRM_VBLANKTIME_RBSIZE]; /**< timestamp of current count */
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200674 struct timer_list disable_timer; /* delayed disable timer */
Ville Syrjälä5380e922013-10-04 14:53:36 +0300675 atomic_t count; /**< number of VBLANK interrupts */
676 atomic_t refcount; /* number of users of vblank interruptsper crtc */
677 u32 last; /* protected by dev->vbl_lock, used */
678 /* for wraparound handling */
679 u32 last_wait; /* Last vblank seqno waited per CRTC */
680 unsigned int inmodeset; /* Display driver is setting mode */
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200681 int crtc; /* crtc index */
Ville Syrjälä5380e922013-10-04 14:53:36 +0300682 bool enabled; /* so we don't call enable more than
683 once per disable */
684};
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686/**
687 * DRM device structure. This structure represent a complete card that
688 * may contain multiple heads.
689 */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000690struct drm_device {
Daniel Vetterb3f23332013-12-11 11:34:31 +0100691 struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000692 int if_version; /**< Highest interface version set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
David Herrmann45e212d2014-01-28 16:00:35 +0100694 /** \name Lifetime Management */
695 /*@{ */
David Herrmann099d1c22014-01-29 10:21:36 +0100696 struct kref ref; /**< Object ref-count */
David Herrmann45e212d2014-01-28 16:00:35 +0100697 struct device *dev; /**< Device structure of bus-device */
698 struct drm_driver *driver; /**< DRM driver managing the device */
699 void *dev_private; /**< DRM driver private data */
David Herrmann45e212d2014-01-28 16:00:35 +0100700 struct drm_minor *control; /**< Control node */
701 struct drm_minor *primary; /**< Primary node */
702 struct drm_minor *render; /**< Render node */
703 atomic_t unplugged; /**< Flag whether dev is dead */
David Herrmann07b48c32014-03-16 13:13:51 +0100704 struct inode *anon_inode; /**< inode for private address-space */
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200705 char *unique; /**< unique name of the device */
David Herrmann45e212d2014-01-28 16:00:35 +0100706 /*@} */
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 /** \name Locks */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000709 /*@{ */
Dave Airlie30e2fb12006-02-02 19:37:46 +1100710 struct mutex struct_mutex; /**< For others */
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100711 struct mutex master_mutex; /**< For drm_minor::master and drm_file::is_master */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000712 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 /** \name Usage Counters */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000715 /*@{ */
Daniel Vetterfc8fd402013-11-03 20:46:34 +0100716 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */
Daniel Vetter2177a212013-12-16 11:21:06 +0100717 spinlock_t buf_lock; /**< For drm_device::buf_use and a few other things. */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000718 int buf_use; /**< Buffers in use -- cannot alloc */
719 atomic_t buf_alloc; /**< Buffer allocation in progress */
720 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Dave Airliebd1b3312007-05-26 05:01:51 +1000722 struct list_head filelist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 /** \name Memory management */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000725 /*@{ */
Dave Airliebd1b3312007-05-26 05:01:51 +1000726 struct list_head maplist; /**< Linked list of regions */
Dave Airliee0be4282007-07-12 10:26:44 +1000727 struct drm_open_hash map_hash; /**< User token hash table for maps */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 /** \name Context handle management */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000730 /*@{ */
Dave Airliebd1b3312007-05-26 05:01:51 +1000731 struct list_head ctxlist; /**< Linked list of context handles */
Dave Airlie30e2fb12006-02-02 19:37:46 +1100732 struct mutex ctxlist_mutex; /**< For ctxlist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Dave Airlie62968142007-07-17 10:46:52 +1000734 struct idr ctx_idr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Dave Airliebd1b3312007-05-26 05:01:51 +1000736 struct list_head vmalist; /**< List of vmas (for debugging) */
Dave Airlief453ba02008-11-07 14:05:41 -0800737
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000738 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Daniel Vettera344a7e2011-10-26 00:54:41 +0200740 /** \name DMA support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000741 /*@{ */
Dave Airliecdd55a22007-07-11 16:32:08 +1000742 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000743 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
745 /** \name Context support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000746 /*@{ */
Ville Syrjälä44238432013-10-04 14:53:37 +0300747 bool irq_enabled; /**< True if irq handler is enabled */
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100748 int irq;
749
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 __volatile__ long context_flag; /**< Context swapping flag */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000751 int last_context; /**< Last current context */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000752 /*@} */
753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 /** \name VBLANK IRQ support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000755 /*@{ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700757 /*
758 * At load time, disabling the vblank interrupt won't be allowed since
759 * old clients may not call the modeset ioctl and therefore misbehave.
760 * Once the modeset ioctl *has* been called though, we can safely
761 * disable them when unused.
762 */
Ville Syrjäläba0bf122013-10-04 14:53:33 +0300763 bool vblank_disable_allowed;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700764
Ville Syrjälä00185e62014-08-06 14:49:54 +0300765 /*
766 * If true, vblank interrupt will be disabled immediately when the
767 * refcount drops to zero, as opposed to via the vblank disable
768 * timer.
769 * This can be set to true it the hardware has a working vblank
770 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
771 * appropriately.
772 */
773 bool vblank_disable_immediate;
774
Ville Syrjälä5380e922013-10-04 14:53:36 +0300775 /* array of size num_crtcs */
776 struct drm_vblank_crtc *vblank;
777
Mario Kleiner27641c32010-10-23 04:20:23 +0200778 spinlock_t vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000779 spinlock_t vbl_lock;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700780
781 u32 max_vblank_count; /**< size of vblank counter register */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000783 /**
784 * List of events
785 */
786 struct list_head vblank_event_list;
787 spinlock_t event_lock;
788
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000789 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Dave Airlie55910512007-07-11 16:53:40 +1000791 struct drm_agp_head *agp; /**< AGP data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000793 struct pci_dev *pdev; /**< PCI device structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794#ifdef __alpha__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 struct pci_controller *hose;
796#endif
Jordan Crousedcdb1672010-05-27 13:40:25 -0600797
798 struct platform_device *platformdev; /**< Platform device struture */
799
Dave Airlie55910512007-07-11 16:53:40 +1000800 struct drm_sg_mem *sg; /**< Scatter gather memory */
Dave Airlie19227562011-02-24 08:35:06 +1000801 unsigned int num_crtcs; /**< Number of CRTCs on this device */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000802 sigset_t sigmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
David Herrmann69d516c2014-08-29 12:12:39 +0200804 struct {
805 int context;
806 struct drm_hw_lock *lock;
807 } sigdata;
808
Benjamin Herrenschmidtf77d3902009-02-02 16:55:46 +1100809 struct drm_local_map *agp_buffer_map;
Dave Airlied1f2b552005-08-05 22:11:22 +1000810 unsigned int agp_buffer_token;
=?utf-8?q?Michel_D=C3=A4nzer?=bea56792006-10-24 23:04:19 +1000811
Rob Clark417009fb2014-11-25 20:33:10 -0500812 struct drm_mode_config mode_config; /**< Current mode config */
Dave Airlief453ba02008-11-07 14:05:41 -0800813
Eric Anholt673a3942008-07-30 12:06:12 -0700814 /** \name GEM information */
815 /*@{ */
Daniel Vettercd4f0132013-08-15 00:02:44 +0200816 struct mutex object_name_lock;
Eric Anholt673a3942008-07-30 12:06:12 -0700817 struct idr object_name_idr;
Daniel Vetterb04a5902013-12-11 14:24:46 +0100818 struct drm_vma_offset_manager *vma_offset_manager;
Eric Anholt673a3942008-07-30 12:06:12 -0700819 /*@} */
Dave Airlie5bcf7192010-12-07 09:20:40 +1000820 int switch_power_state;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000821};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Dave Airlie5bcf7192010-12-07 09:20:40 +1000823#define DRM_SWITCH_POWER_ON 0
824#define DRM_SWITCH_POWER_OFF 1
825#define DRM_SWITCH_POWER_CHANGING 2
Dave Airlie13bb9cc2012-09-12 15:55:05 +1000826#define DRM_SWITCH_POWER_DYNAMIC_OFF 3
Dave Airlie5bcf7192010-12-07 09:20:40 +1000827
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000828static __inline__ int drm_core_check_feature(struct drm_device *dev,
829 int feature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
831 return ((dev->driver->driver_features & feature) ? 1 : 0);
832}
833
Dave Airlie2c07a212012-02-20 14:18:07 +0000834static inline void drm_device_set_unplugged(struct drm_device *dev)
835{
836 smp_wmb();
837 atomic_set(&dev->unplugged, 1);
838}
839
840static inline int drm_device_is_unplugged(struct drm_device *dev)
841{
842 int ret = atomic_read(&dev->unplugged);
843 smp_rmb();
844 return ret;
845}
846
Thomas Hellstrom43683052014-03-13 11:07:44 +0100847static inline bool drm_is_render_client(const struct drm_file *file_priv)
David Herrmann17931262013-08-25 18:29:00 +0200848{
849 return file_priv->minor->type == DRM_MINOR_RENDER;
850}
851
Thomas Hellstromac05dbc2014-02-19 14:21:48 +0100852static inline bool drm_is_control_client(const struct drm_file *file_priv)
853{
854 return file_priv->minor->type == DRM_MINOR_CONTROL;
855}
856
Thomas Hellstrom43683052014-03-13 11:07:44 +0100857static inline bool drm_is_primary_client(const struct drm_file *file_priv)
858{
859 return file_priv->minor->type == DRM_MINOR_LEGACY;
860}
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862/******************************************************************/
863/** \name Internal function definitions */
864/*@{*/
865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 /* Driver support (drm_drv.h) */
Arnd Bergmanned8b6702009-12-16 22:17:09 +0000867extern long drm_ioctl(struct file *filp,
868 unsigned int cmd, unsigned long arg);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000869extern long drm_compat_ioctl(struct file *filp,
870 unsigned int cmd, unsigned long arg);
Thomas Hellstrom4beb6d92014-02-26 15:51:57 +0100871extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
873 /* Device support (drm_fops.h) */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000874extern int drm_open(struct inode *inode, struct file *filp);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000875extern ssize_t drm_read(struct file *filp, char __user *buffer,
876 size_t count, loff_t *offset);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000877extern int drm_release(struct inode *inode, struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
879 /* Mapping support (drm_vm.h) */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000880extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Daniel Vetter78238752014-09-10 12:43:55 +0200882/* Misc. IOCTL support (drm_ioctl.c) */
883int drm_noop(struct drm_device *dev, void *data,
884 struct drm_file *file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Eric Anholt673a3942008-07-30 12:06:12 -0700886/* Cache management (drm_cache.c) */
887void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
Chris Wilson9da3da62012-06-01 15:20:22 +0100888void drm_clflush_sg(struct sg_table *st);
Ville Syrjäläc2d15352014-04-01 12:59:08 +0300889void drm_clflush_virt_range(void *addr, unsigned long length);
Eric Anholt673a3942008-07-30 12:06:12 -0700890
Thomas Hellstrom040ac322007-03-23 13:28:33 +1100891/*
892 * These are exported to drivers so that they can implement fencing using
893 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
894 */
895
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 /* IRQ support (drm_irq.h) */
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100897extern int drm_irq_install(struct drm_device *dev, int irq);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000898extern int drm_irq_uninstall(struct drm_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700900extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
Dave Airlieaf6061a2008-05-07 12:15:39 +1000901extern int drm_wait_vblank(struct drm_device *dev, void *data,
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700902 struct drm_file *filp);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700903extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
Mario Kleiner27641c32010-10-23 04:20:23 +0200904extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
905 struct timeval *vblanktime);
Rob Clarkc6eefa12012-10-16 22:48:40 +0000906extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
907 struct drm_pending_vblank_event *e);
Chris Wilson78c6e172011-01-31 10:48:04 +0000908extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700909extern int drm_vblank_get(struct drm_device *dev, int crtc);
910extern void drm_vblank_put(struct drm_device *dev, int crtc);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200911extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
912extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
Daniel Vettere8450f52014-07-25 23:34:03 +0200913extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
914extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
Li Peng778c9022009-11-09 12:51:22 +0800915extern void drm_vblank_off(struct drm_device *dev, int crtc);
Ville Syrjäläf2752282014-02-19 21:29:49 +0200916extern void drm_vblank_on(struct drm_device *dev, int crtc);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200917extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
918extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
Keith Packard52440212008-11-18 09:30:25 -0800919extern void drm_vblank_cleanup(struct drm_device *dev);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200920
Mario Kleiner27641c32010-10-23 04:20:23 +0200921extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
922 int crtc, int *max_error,
923 struct timeval *vblank_time,
924 unsigned flags,
Ville Syrjälä7da903e2013-10-26 17:57:31 +0300925 const struct drm_crtc *refcrtc,
926 const struct drm_display_mode *mode);
Ville Syrjälä545cdd52013-10-26 17:16:30 +0300927extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
928 const struct drm_display_mode *mode);
Mario Kleiner27641c32010-10-23 04:20:23 +0200929
Ville Syrjälä020178a2014-05-22 19:36:03 +0300930/**
931 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
932 * @crtc: which CRTC's vblank waitqueue to retrieve
933 *
934 * This function returns a pointer to the vblank waitqueue for the CRTC.
935 * Drivers can use this to implement vblank waits using wait_event() & co.
936 */
937static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
938{
939 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
940}
Steffen Trumtrarebc64e42012-11-14 11:22:52 +0100941
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700942/* Modesetting support */
Dave Airlief453ba02008-11-07 14:05:41 -0800943extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
944extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 /* Stub support (drm_stub.h) */
Dave Airlie7c1c2872008-11-28 14:22:24 +1000947extern struct drm_master *drm_master_get(struct drm_master *master);
948extern void drm_master_put(struct drm_master **master);
Dave Airlie8410ea32010-12-15 03:16:38 +1000949
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500950extern void drm_put_dev(struct drm_device *dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000951extern void drm_unplug_dev(struct drm_device *dev);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000952extern unsigned int drm_debug;
Dave Airlie2c14f282008-04-21 16:47:32 +1000953
Ben Gamari955b12d2009-02-17 20:08:49 -0500954 /* Debugfs support */
955#if defined(CONFIG_DEBUG_FS)
Lespiau, Damien7d747952013-10-17 19:09:53 +0100956extern int drm_debugfs_create_files(const struct drm_info_list *files,
957 int count, struct dentry *root,
958 struct drm_minor *minor);
959extern int drm_debugfs_remove_files(const struct drm_info_list *files,
960 int count, struct drm_minor *minor);
Thierry Reding66ee52e2013-12-12 15:44:04 +0100961#else
Thierry Reding66ee52e2013-12-12 15:44:04 +0100962static inline int drm_debugfs_create_files(const struct drm_info_list *files,
963 int count, struct dentry *root,
964 struct drm_minor *minor)
965{
966 return 0;
967}
968
969static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
970 int count, struct drm_minor *minor)
971{
972 return 0;
973}
Ben Gamari955b12d2009-02-17 20:08:49 -0500974#endif
975
Aaron Plattner89177642013-01-15 20:47:42 +0000976extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
977 struct drm_gem_object *obj, int flags);
Dave Airlie32488772011-11-25 15:21:02 +0000978extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
979 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
980 int *prime_fd);
Aaron Plattner89177642013-01-15 20:47:42 +0000981extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
982 struct dma_buf *dma_buf);
Dave Airlie32488772011-11-25 15:21:02 +0000983extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
984 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
Daniel Vetterc1d67982013-08-15 00:02:30 +0200985extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
Dave Airlie32488772011-11-25 15:21:02 +0000986
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100987extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
988 dma_addr_t *addrs, int max_pages);
Thierry Reding34eab432014-06-04 09:18:29 +0200989extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
Dave Airlie32488772011-11-25 15:21:02 +0000990extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Daniel Vetterba8286f2014-09-11 07:43:25 +0200993extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
994 size_t align);
995extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997 /* sysfs support (drm_sysfs.c) */
Dave Airlief453ba02008-11-07 14:05:41 -0800998extern void drm_sysfs_hotplug_event(struct drm_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Eric Anholt673a3942008-07-30 12:06:12 -07001000
David Herrmann1bb72532013-10-02 11:23:34 +02001001struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1002 struct device *parent);
David Herrmann099d1c22014-01-29 10:21:36 +01001003void drm_dev_ref(struct drm_device *dev);
1004void drm_dev_unref(struct drm_device *dev);
David Herrmannc22f0ac2013-10-02 11:23:35 +02001005int drm_dev_register(struct drm_device *dev, unsigned long flags);
David Herrmannc3a49732013-10-02 11:23:38 +02001006void drm_dev_unregister(struct drm_device *dev);
Thierry Redingca8e2ad2014-04-11 15:23:00 +02001007int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
David Herrmann1616c522014-01-29 10:49:19 +01001008
1009struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1010void drm_minor_release(struct drm_minor *minor);
1011
Dave Airlie8410ea32010-12-15 03:16:38 +10001012/*@}*/
1013
1014/* PCI section */
1015static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1016{
Dave Airlieb5e89ed2005-09-25 14:28:13 +10001017 if (dev->driver->device_is_agp != NULL) {
1018 int err = (*dev->driver->device_is_agp) (dev);
1019
Dave Airliecda17382005-07-10 17:31:26 +10001020 if (err != 2) {
1021 return err;
1022 }
1023 }
1024
1025 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1026}
Daniel Vetter4efafeb2013-12-11 11:34:38 +01001027void drm_pci_agp_destroy(struct drm_device *dev);
Dave Airliecda17382005-07-10 17:31:26 +10001028
Dave Airlie8410ea32010-12-15 03:16:38 +10001029extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1030extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
Thierry Redinga9e3c902014-08-05 13:37:47 +02001031#ifdef CONFIG_PCI
Dave Airlie8410ea32010-12-15 03:16:38 +10001032extern int drm_get_pci_dev(struct pci_dev *pdev,
Jordan Crousedcdb1672010-05-27 13:40:25 -06001033 const struct pci_device_id *ent,
1034 struct drm_driver *driver);
David Herrmann915b4d12014-08-29 12:12:43 +02001035extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
Thierry Redinga9e3c902014-08-05 13:37:47 +02001036#else
1037static inline int drm_get_pci_dev(struct pci_dev *pdev,
1038 const struct pci_device_id *ent,
1039 struct drm_driver *driver)
1040{
1041 return -ENOSYS;
1042}
1043
1044static inline int drm_pci_set_busid(struct drm_device *dev,
1045 struct drm_master *master)
1046{
1047 return -ENOSYS;
1048}
1049#endif
Dave Airlie8410ea32010-12-15 03:16:38 +10001050
Dave Airlief4297782012-06-27 08:35:53 +01001051#define DRM_PCIE_SPEED_25 1
1052#define DRM_PCIE_SPEED_50 2
1053#define DRM_PCIE_SPEED_80 4
1054
1055extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
Dave Airlie8410ea32010-12-15 03:16:38 +10001056
1057/* platform section */
1058extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
David Herrmann915b4d12014-08-29 12:12:43 +02001059extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
Dave Airlie8410ea32010-12-15 03:16:38 +10001060
Dave Airliecc1f7192012-01-05 09:55:22 +00001061/* returns true if currently okay to sleep */
1062static __inline__ bool drm_can_sleep(void)
1063{
1064 if (in_atomic() || in_dbg_master() || irqs_disabled())
1065 return false;
1066 return true;
1067}
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069#endif