blob: 48db6a56975f5ebc874d19054828b70a5f4aaa15 [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 *
Daniel Vetter17a38d92015-02-22 12:24:16 +0100107 * ATOMIC: used in the atomic code.
108 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
109 *
Lespiau, Damien1414b762014-03-24 15:53:08 +0000110 * Enabling verbose debug messages is done through the drm.debug parameter,
111 * each category being enabled by a bit.
112 *
113 * drm.debug=0x1 will enable CORE messages
114 * drm.debug=0x2 will enable DRIVER messages
115 * drm.debug=0x3 will enable CORE and DRIVER messages
116 * ...
117 * drm.debug=0xf will enable all messages
118 *
119 * An interesting feature is that it's possible to enable verbose logging at
120 * run-time by echoing the debug value in its sysfs node:
121 * # echo 0xf > /sys/module/drm/parameters/debug
122 */
yakui_zhao4fefcb22009-06-02 14:09:47 +0800123#define DRM_UT_CORE 0x01
124#define DRM_UT_DRIVER 0x02
125#define DRM_UT_KMS 0x04
Dave Airlie32488772011-11-25 15:21:02 +0000126#define DRM_UT_PRIME 0x08
Daniel Vetter17a38d92015-02-22 12:24:16 +0100127#define DRM_UT_ATOMIC 0x10
yakui_zhao4fefcb22009-06-02 14:09:47 +0800128
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000129extern __printf(2, 3)
130void drm_ut_debug_printk(const char *function_name,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700131 const char *format, ...);
Joe Perchesa1f1a792014-10-11 22:08:57 -0700132extern __printf(1, 2)
133void drm_err(const char *format, ...);
Joe Perches5ad3d882011-04-17 20:35:51 -0700134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/***********************************************************************/
136/** \name DRM template customization defaults */
137/*@{*/
138
139/* driver capabilities and requirements mask */
140#define DRIVER_USE_AGP 0x1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#define DRIVER_PCI_DMA 0x8
142#define DRIVER_SG 0x10
143#define DRIVER_HAVE_DMA 0x20
144#define DRIVER_HAVE_IRQ 0x40
145#define DRIVER_IRQ_SHARED 0x80
Eric Anholt673a3942008-07-30 12:06:12 -0700146#define DRIVER_GEM 0x1000
Dave Airlief453ba02008-11-07 14:05:41 -0800147#define DRIVER_MODESET 0x2000
Dave Airlie32488772011-11-25 15:21:02 +0000148#define DRIVER_PRIME 0x4000
David Herrmann17931262013-08-25 18:29:00 +0200149#define DRIVER_RENDER 0x8000
Rob Clark88a48e22014-12-18 16:01:50 -0500150#define DRIVER_ATOMIC 0x10000
Dave Airlie8410ea32010-12-15 03:16:38 +1000151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152/***********************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153/** \name Macros to make printk easier */
154/*@{*/
155
156/**
157 * Error output.
158 *
159 * \param fmt printf() like format string.
160 * \param arg arguments
161 */
Joe Perches5ad3d882011-04-17 20:35:51 -0700162#define DRM_ERROR(fmt, ...) \
Joe Perchesa1f1a792014-10-11 22:08:57 -0700163 drm_err(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Rob Clark5d13d422013-11-21 14:29:51 -0500165/**
166 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
167 *
168 * \param fmt printf() like format string.
169 * \param arg arguments
170 */
171#define DRM_ERROR_RATELIMITED(fmt, ...) \
172({ \
173 static DEFINE_RATELIMIT_STATE(_rs, \
174 DEFAULT_RATELIMIT_INTERVAL, \
175 DEFAULT_RATELIMIT_BURST); \
176 \
177 if (__ratelimit(&_rs)) \
Joe Perchesa1f1a792014-10-11 22:08:57 -0700178 drm_err(fmt, ##__VA_ARGS__); \
Rob Clark5d13d422013-11-21 14:29:51 -0500179})
180
Joe Perches5ad3d882011-04-17 20:35:51 -0700181#define DRM_INFO(fmt, ...) \
182 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Jani Nikula48b8f632014-01-31 15:49:07 +0200184#define DRM_INFO_ONCE(fmt, ...) \
185 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187/**
188 * Debug output.
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000189 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 * \param fmt printf() like format string.
191 * \param arg arguments
192 */
yakui_zhao4fefcb22009-06-02 14:09:47 +0800193#define DRM_DEBUG(fmt, args...) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000195 if (unlikely(drm_debug & DRM_UT_CORE)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000196 drm_ut_debug_printk(__func__, fmt, ##args); \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800197 } while (0)
198
Zhao Yakui8a4c47f2009-07-20 13:48:04 +0800199#define DRM_DEBUG_DRIVER(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_DRIVER)) \
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)
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000204#define DRM_DEBUG_KMS(fmt, args...) \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800205 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000206 if (unlikely(drm_debug & DRM_UT_KMS)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000207 drm_ut_debug_printk(__func__, fmt, ##args); \
yakui_zhao4fefcb22009-06-02 14:09:47 +0800208 } while (0)
Dave Airlie32488772011-11-25 15:21:02 +0000209#define DRM_DEBUG_PRIME(fmt, args...) \
210 do { \
Lespiau, Damiena73d4e92014-03-24 15:53:15 +0000211 if (unlikely(drm_debug & DRM_UT_PRIME)) \
Lespiau, Damien1287aa92014-03-24 15:53:17 +0000212 drm_ut_debug_printk(__func__, fmt, ##args); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 } while (0)
Daniel Vetter17a38d92015-02-22 12:24:16 +0100214#define DRM_DEBUG_ATOMIC(fmt, args...) \
215 do { \
216 if (unlikely(drm_debug & DRM_UT_ATOMIC)) \
217 drm_ut_debug_printk(__func__, fmt, ##args); \
218 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220/*@}*/
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/***********************************************************************/
223/** \name Internal types and structures */
224/*@{*/
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226#define DRM_IF_VERSION(maj, min) (maj << 16 | min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
228/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 * Ioctl function type.
230 *
231 * \param inode device inode.
Eric Anholt6c340ea2007-08-25 20:23:09 +1000232 * \param file_priv DRM file private pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 * \param cmd command.
234 * \param arg argument.
235 */
Eric Anholtc153f452007-09-03 12:06:45 +1000236typedef int drm_ioctl_t(struct drm_device *dev, void *data,
237 struct drm_file *file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Dave Airlie9a186642005-06-23 21:29:18 +1000239typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
240 unsigned long arg);
241
Kristian Høgsberg1a959162009-12-02 12:13:48 -0500242#define DRM_IOCTL_NR(n) _IOC_NR(n)
243#define DRM_MAJOR 226
244
Dave Airliea7a2cc32006-01-02 13:54:04 +1100245#define DRM_AUTH 0x1
246#define DRM_MASTER 0x2
247#define DRM_ROOT_ONLY 0x4
Dave Airlief453ba02008-11-07 14:05:41 -0800248#define DRM_CONTROL_ALLOW 0x8
Arnd Bergmanned8b6702009-12-16 22:17:09 +0000249#define DRM_UNLOCKED 0x10
David Herrmann17931262013-08-25 18:29:00 +0200250#define DRM_RENDER_ALLOW 0x20
Dave Airliea7a2cc32006-01-02 13:54:04 +1100251
Eric Anholtc153f452007-09-03 12:06:45 +1000252struct drm_ioctl_desc {
253 unsigned int cmd;
Dave Airliea7a2cc32006-01-02 13:54:04 +1100254 int flags;
Richard Kennedyc972d752009-03-18 17:26:44 +0000255 drm_ioctl_t *func;
Chris Cumminsb9434d02013-05-09 14:20:40 +0100256 const char *name;
Eric Anholtc153f452007-09-03 12:06:45 +1000257};
258
259/**
260 * Creates a driver or general drm_ioctl_desc array entry for the given
261 * ioctl, for use by drm_ioctl().
262 */
Dave Airlie1b2f1482010-08-14 20:20:34 +1000263
Emil Velikov066626d2015-03-30 17:10:36 +0000264#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \
265 [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = { \
266 .cmd = DRM_IOCTL_##ioctl, \
267 .func = _func, \
268 .flags = _flags, \
269 .name = #ioctl \
270 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000272/* Event queued up for userspace to read */
273struct drm_pending_event {
274 struct drm_event *event;
275 struct list_head link;
276 struct drm_file *file_priv;
Jesse Barnesb9c2c9a2010-07-01 16:48:09 -0700277 pid_t pid; /* pid of requester, no guarantee it's valid by the time
278 we deliver the event, for tracing only */
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000279 void (*destroy)(struct drm_pending_event *event);
280};
281
Dave Airlie32488772011-11-25 15:21:02 +0000282/* initial implementaton using a linked list - todo hashtab */
283struct drm_prime_file_private {
284 struct list_head head;
285 struct mutex lock;
286};
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288/** File private data */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000289struct drm_file {
Chris Wilson39868bd2013-10-29 08:55:58 +0000290 unsigned authenticated :1;
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100291 /* Whether we're master for a minor. Protected by master_mutex */
292 unsigned is_master :1;
Chris Wilson39868bd2013-10-29 08:55:58 +0000293 /* true when the client has asked us to expose stereo 3D mode flags */
294 unsigned stereo_allowed :1;
Matt Roper681e7ec2014-04-01 15:22:42 -0700295 /*
296 * true if client understands CRTC primary planes and cursor planes
297 * in the plane list
298 */
299 unsigned universal_planes:1;
Rob Clark88a48e22014-12-18 16:01:50 -0500300 /* true if client understands atomic properties */
301 unsigned atomic:1;
Chris Wilson39868bd2013-10-29 08:55:58 +0000302
Eric W. Biederman5fce5e02012-02-07 16:47:26 -0800303 struct pid *pid;
304 kuid_t uid;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000305 drm_magic_t magic;
Dave Airliebd1b3312007-05-26 05:01:51 +1000306 struct list_head lhead;
Dave Airlie2c14f282008-04-21 16:47:32 +1000307 struct drm_minor *minor;
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000308 unsigned long lock_count;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000309
Eric Anholt673a3942008-07-30 12:06:12 -0700310 /** Mapping of mm object handles to object pointers. */
311 struct idr object_idr;
312 /** Lock for synchronization of access to object_idr. */
313 spinlock_t table_lock;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000314
Eric Anholt6c340ea2007-08-25 20:23:09 +1000315 struct file *filp;
Dave Airlie8562b3f2007-11-05 12:37:41 +1000316 void *driver_priv;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000317
Dave Airlie7c1c2872008-11-28 14:22:24 +1000318 struct drm_master *master; /* master this node is currently associated with
319 N.B. not always minor->master */
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100320 /**
321 * fbs - List of framebuffers associated with this file.
322 *
323 * Protected by fbs_lock. Note that the fbs list holds a reference on
324 * the fb object to prevent it from untimely disappearing.
325 */
Dave Airlief453ba02008-11-07 14:05:41 -0800326 struct list_head fbs;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100327 struct mutex fbs_lock;
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000328
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100329 /** User-created blob properties; this retains a reference on the
330 * property. */
331 struct list_head blobs;
332
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000333 wait_queue_head_t event_wait;
334 struct list_head event_list;
335 int event_space;
Dave Airlie32488772011-11-25 15:21:02 +0000336
337 struct drm_prime_file_private prime;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000338};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340/**
341 * Lock data.
342 */
Dave Airlie55910512007-07-11 16:53:40 +1000343struct drm_lock_data {
Dave Airliec60ce622007-07-11 15:27:12 +1000344 struct drm_hw_lock *hw_lock; /**< Hardware lock */
Dave Airlie8562b3f2007-11-05 12:37:41 +1000345 /** Private of lock holder's file (NULL=kernel) */
346 struct drm_file *file_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000348 unsigned long lock_time; /**< Time of last lock in jiffies */
Thomas Hellstrom040ac322007-03-23 13:28:33 +1100349 spinlock_t spinlock;
350 uint32_t kernel_waiters;
351 uint32_t user_waiters;
352 int idle_has_lock;
Dave Airlie55910512007-07-11 16:53:40 +1000353};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355/**
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100356 * struct drm_master - drm master structure
357 *
358 * @refcount: Refcount for this master object.
359 * @minor: Link back to minor char device we are master for. Immutable.
360 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
361 * @unique_len: Length of unique field. Protected by drm_global_mutex.
David Herrmann32e7b942015-05-04 21:01:30 +0200362 * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100363 * @lock: DRI lock information.
364 * @driver_priv: Pointer to driver-private information.
365 */
Dave Airlie7c1c2872008-11-28 14:22:24 +1000366struct drm_master {
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100367 struct kref refcount;
368 struct drm_minor *minor;
369 char *unique;
370 int unique_len;
David Herrmann32e7b942015-05-04 21:01:30 +0200371 struct idr magic_map;
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100372 struct drm_lock_data lock;
373 void *driver_priv;
Dave Airlie7c1c2872008-11-28 14:22:24 +1000374};
375
Mario Kleiner27641c32010-10-23 04:20:23 +0200376/* Size of ringbuffer for vblank timestamps. Just double-buffer
377 * in initial implementation.
378 */
379#define DRM_VBLANKTIME_RBSIZE 2
380
381/* Flags and return codes for get_vblank_timestamp() driver function. */
382#define DRM_CALLED_FROM_VBLIRQ 1
383#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
Daniel Vetter3d3cbd82014-09-10 17:36:11 +0200384#define DRM_VBLANKTIME_IN_VBLANK (1 << 1)
Mario Kleiner27641c32010-10-23 04:20:23 +0200385
386/* get_scanout_position() return flags */
387#define DRM_SCANOUTPOS_VALID (1 << 0)
Daniel Vetter3d3cbd82014-09-10 17:36:11 +0200388#define DRM_SCANOUTPOS_IN_VBLANK (1 << 1)
Mario Kleiner27641c32010-10-23 04:20:23 +0200389#define DRM_SCANOUTPOS_ACCURATE (1 << 2)
390
Eric Anholt673a3942008-07-30 12:06:12 -0700391/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 * DRM driver structure. This structure represent the common code for
393 * a family of cards. There will one drm_device for each card present
394 * in this family
395 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396struct drm_driver {
Dave Airlie22eae942005-11-10 22:16:34 +1100397 int (*load) (struct drm_device *, unsigned long flags);
398 int (*firstopen) (struct drm_device *);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000399 int (*open) (struct drm_device *, struct drm_file *);
Eric Anholt6c340ea2007-08-25 20:23:09 +1000400 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000401 void (*postclose) (struct drm_device *, struct drm_file *);
Dave Airlie22eae942005-11-10 22:16:34 +1100402 void (*lastclose) (struct drm_device *);
403 int (*unload) (struct drm_device *);
Dave Airlieb932ccb2008-02-20 10:02:20 +1000404 int (*suspend) (struct drm_device *, pm_message_t state);
Jesse Barnese8b962b2007-11-22 14:02:38 +1000405 int (*resume) (struct drm_device *);
Eric Anholtc153f452007-09-03 12:06:45 +1000406 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000407 int (*dma_quiescent) (struct drm_device *);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000408 int (*context_dtor) (struct drm_device *dev, int context);
David Herrmann915b4d12014-08-29 12:12:43 +0200409 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000410
Dave Airliecda17382005-07-10 17:31:26 +1000411 /**
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700412 * get_vblank_counter - get raw hardware vblank counter
413 * @dev: DRM device
414 * @crtc: counter to fetch
415 *
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200416 * Driver callback for fetching a raw hardware vblank counter for @crtc.
417 * If a device doesn't have a hardware counter, the driver can simply
418 * return the value of drm_vblank_count. The DRM core will account for
419 * missed vblank events while interrupts where disabled based on system
420 * timestamps.
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700421 *
422 * Wraparound handling and loss of events due to modesetting is dealt
423 * with in the DRM core code.
424 *
425 * RETURNS
426 * Raw vblank counter value.
427 */
428 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
429
430 /**
431 * enable_vblank - enable vblank interrupt events
432 * @dev: DRM device
433 * @crtc: which irq to enable
434 *
435 * Enable vblank interrupts for @crtc. If the device doesn't have
436 * a hardware vblank counter, this routine should be a no-op, since
437 * interrupts will have to stay on to keep the count accurate.
438 *
439 * RETURNS
440 * Zero on success, appropriate errno if the given @crtc's vblank
441 * interrupt cannot be enabled.
442 */
443 int (*enable_vblank) (struct drm_device *dev, int crtc);
444
445 /**
446 * disable_vblank - disable vblank interrupt events
447 * @dev: DRM device
448 * @crtc: which irq to enable
449 *
450 * Disable vblank interrupts for @crtc. If the device doesn't have
451 * a hardware vblank counter, this routine should be a no-op, since
452 * interrupts will have to stay on to keep the count accurate.
453 */
454 void (*disable_vblank) (struct drm_device *dev, int crtc);
455
456 /**
Dave Airliecda17382005-07-10 17:31:26 +1000457 * Called by \c drm_device_is_agp. Typically used to determine if a
458 * card is really attached to AGP or not.
459 *
460 * \param dev DRM device handle
461 *
462 * \returns
463 * One of three values is returned depending on whether or not the
464 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
465 * (return of 1), or may or may not be AGP (return of 2).
466 */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000467 int (*device_is_agp) (struct drm_device *dev);
Dave Airliecda17382005-07-10 17:31:26 +1000468
Mario Kleiner27641c32010-10-23 04:20:23 +0200469 /**
470 * Called by vblank timestamping code.
471 *
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100472 * Return the current display scanout position from a crtc, and an
473 * optional accurate ktime_get timestamp of when position was measured.
Mario Kleiner27641c32010-10-23 04:20:23 +0200474 *
475 * \param dev DRM device.
476 * \param crtc Id of the crtc to query.
Ville Syrjäläabca9e42013-10-28 20:50:48 +0200477 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
Mario Kleiner27641c32010-10-23 04:20:23 +0200478 * \param *vpos Target location for current vertical scanout position.
479 * \param *hpos Target location for current horizontal scanout position.
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100480 * \param *stime Target location for timestamp taken immediately before
481 * scanout position query. Can be NULL to skip timestamp.
482 * \param *etime Target location for timestamp taken immediately after
483 * scanout position query. Can be NULL to skip timestamp.
Mario Kleiner27641c32010-10-23 04:20:23 +0200484 *
485 * Returns vpos as a positive number while in active scanout area.
486 * Returns vpos as a negative number inside vblank, counting the number
487 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
488 * until start of active scanout / end of vblank."
489 *
490 * \return Flags, or'ed together as follows:
491 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300492 * DRM_SCANOUTPOS_VALID = Query successful.
Mario Kleiner27641c32010-10-23 04:20:23 +0200493 * DRM_SCANOUTPOS_INVBL = Inside vblank.
494 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
495 * this flag means that returned position may be offset by a constant
496 * but unknown small number of scanlines wrt. real scanout position.
497 *
498 */
499 int (*get_scanout_position) (struct drm_device *dev, int crtc,
Ville Syrjäläabca9e42013-10-28 20:50:48 +0200500 unsigned int flags,
Mario Kleiner8f6fce02013-10-30 05:13:06 +0100501 int *vpos, int *hpos, ktime_t *stime,
502 ktime_t *etime);
Mario Kleiner27641c32010-10-23 04:20:23 +0200503
504 /**
505 * Called by \c drm_get_last_vbltimestamp. Should return a precise
506 * timestamp when the most recent VBLANK interval ended or will end.
507 *
508 * Specifically, the timestamp in @vblank_time should correspond as
509 * closely as possible to the time when the first video scanline of
510 * the video frame after the end of VBLANK will start scanning out,
Justin P. Mattock42b2aa82011-11-28 20:31:00 -0800511 * the time immediately after end of the VBLANK interval. If the
Mario Kleiner27641c32010-10-23 04:20:23 +0200512 * @crtc is currently inside VBLANK, this will be a time in the future.
513 * If the @crtc is currently scanning out a frame, this will be the
514 * past start time of the current scanout. This is meant to adhere
515 * to the OpenML OML_sync_control extension specification.
516 *
517 * \param dev dev DRM device handle.
518 * \param crtc crtc for which timestamp should be returned.
519 * \param *max_error Maximum allowable timestamp error in nanoseconds.
520 * Implementation should strive to provide timestamp
521 * with an error of at most *max_error nanoseconds.
522 * Returns true upper bound on error for timestamp.
523 * \param *vblank_time Target location for returned vblank timestamp.
524 * \param flags 0 = Defaults, no special treatment needed.
525 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
526 * irq handler. Some drivers need to apply some workarounds
527 * for gpu-specific vblank irq quirks if flag is set.
528 *
529 * \returns
530 * Zero if timestamping isn't supported in current display mode or a
531 * negative number on failure. A positive status code on success,
532 * which describes how the vblank_time timestamp was computed.
533 */
534 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
535 int *max_error,
536 struct timeval *vblank_time,
537 unsigned flags);
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 /* these have to be filled in */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000540
Daniel Vettere9f0d762013-12-11 11:34:42 +0100541 irqreturn_t(*irq_handler) (int irq, void *arg);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000542 void (*irq_preinstall) (struct drm_device *dev);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700543 int (*irq_postinstall) (struct drm_device *dev);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000544 void (*irq_uninstall) (struct drm_device *dev);
Dave Airlie22eae942005-11-10 22:16:34 +1100545
Dave Airlie7c1c2872008-11-28 14:22:24 +1000546 /* Master routines */
547 int (*master_create)(struct drm_device *dev, struct drm_master *master);
548 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
Thomas Hellstrom862302f2009-12-02 18:15:25 +0000549 /**
550 * master_set is called whenever the minor master is set.
551 * master_drop is called whenever the minor master is dropped.
552 */
553
554 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
555 bool from_open);
556 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
557 bool from_release);
Dave Airlie7c1c2872008-11-28 14:22:24 +1000558
Ben Gamari955b12d2009-02-17 20:08:49 -0500559 int (*debugfs_init)(struct drm_minor *minor);
560 void (*debugfs_cleanup)(struct drm_minor *minor);
Eric Anholt673a3942008-07-30 12:06:12 -0700561
562 /**
563 * Driver-specific constructor for drm_gem_objects, to set up
564 * obj->driver_private.
565 *
566 * Returns 0 on success.
567 */
Eric Anholt673a3942008-07-30 12:06:12 -0700568 void (*gem_free_object) (struct drm_gem_object *obj);
Ben Skeggs304eda32011-06-09 00:24:59 +0000569 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
570 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
Eric Anholt673a3942008-07-30 12:06:12 -0700571
Dave Airlie32488772011-11-25 15:21:02 +0000572 /* prime: */
573 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
574 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
575 uint32_t handle, uint32_t flags, int *prime_fd);
576 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
577 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
578 int prime_fd, uint32_t *handle);
579 /* export GEM -> dmabuf */
580 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
581 struct drm_gem_object *obj, int flags);
582 /* import dmabuf -> GEM */
583 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
584 struct dma_buf *dma_buf);
Aaron Plattner89177642013-01-15 20:47:42 +0000585 /* low-level interface used by drm_gem_prime_{import,export} */
586 int (*gem_prime_pin)(struct drm_gem_object *obj);
Maarten Lankhorst102d6db2013-04-09 09:18:44 +0200587 void (*gem_prime_unpin)(struct drm_gem_object *obj);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200588 struct reservation_object * (*gem_prime_res_obj)(
589 struct drm_gem_object *obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000590 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
591 struct drm_gem_object *(*gem_prime_import_sg_table)(
Maarten Lankhorstb5e9c1a2014-01-09 11:03:14 +0100592 struct drm_device *dev,
593 struct dma_buf_attachment *attach,
Aaron Plattner89177642013-01-15 20:47:42 +0000594 struct sg_table *sgt);
595 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
596 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
Joonyoung Shim7c397cd2013-06-28 14:24:53 +0900597 int (*gem_prime_mmap)(struct drm_gem_object *obj,
598 struct vm_area_struct *vma);
Dave Airlie32488772011-11-25 15:21:02 +0000599
Dave Airlie28d52042009-09-21 14:33:58 +1000600 /* vga arb irq handler */
601 void (*vgaarb_irq)(struct drm_device *dev, bool state);
602
Dave Airlieff72145b2011-02-07 12:16:14 +1000603 /* dumb alloc support */
604 int (*dumb_create)(struct drm_file *file_priv,
605 struct drm_device *dev,
606 struct drm_mode_create_dumb *args);
607 int (*dumb_map_offset)(struct drm_file *file_priv,
608 struct drm_device *dev, uint32_t handle,
609 uint64_t *offset);
610 int (*dumb_destroy)(struct drm_file *file_priv,
611 struct drm_device *dev,
612 uint32_t handle);
613
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800614 /* Driver private ops for this object */
Laurent Pinchart78b68552012-05-17 13:27:22 +0200615 const struct vm_operations_struct *gem_vm_ops;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800616
Dave Airlie22eae942005-11-10 22:16:34 +1100617 int major;
618 int minor;
619 int patchlevel;
620 char *name;
621 char *desc;
622 char *date;
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 u32 driver_features;
625 int dev_priv_size;
Rob Clarkbaa70942013-08-02 13:27:49 -0400626 const struct drm_ioctl_desc *ioctls;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 int num_ioctls;
Arjan van de Vene08e96d2011-10-31 07:28:57 -0700628 const struct file_operations *fops;
Dave Airlie8410ea32010-12-15 03:16:38 +1000629
Daniel Vetterb3f23332013-12-11 11:34:31 +0100630 /* List of devices hanging off this driver with stealth attach. */
631 struct list_head legacy_dev_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632};
633
David Herrmanncb8a2392014-01-29 12:31:40 +0100634enum drm_minor_type {
635 DRM_MINOR_LEGACY,
636 DRM_MINOR_CONTROL,
637 DRM_MINOR_RENDER,
638 DRM_MINOR_CNT,
639};
Dave Airlie2c14f282008-04-21 16:47:32 +1000640
Ben Gamari955b12d2009-02-17 20:08:49 -0500641/**
642 * Info file list entry. This structure represents a debugfs or proc file to
643 * be created by the drm core
644 */
645struct drm_info_list {
646 const char *name; /** file name */
647 int (*show)(struct seq_file*, void*); /** show callback */
648 u32 driver_features; /**< Required driver features for this entry */
649 void *data;
650};
651
652/**
653 * debugfs node structure. This structure represents a debugfs file.
654 */
655struct drm_info_node {
656 struct list_head list;
657 struct drm_minor *minor;
David Howellsce089b52013-04-12 15:23:25 +0100658 const struct drm_info_list *info_ent;
Ben Gamari955b12d2009-02-17 20:08:49 -0500659 struct dentry *dent;
660};
661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662/**
Dave Airlie2c14f282008-04-21 16:47:32 +1000663 * DRM minor structure. This structure represents a drm minor number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 */
Dave Airlie2c14f282008-04-21 16:47:32 +1000665struct drm_minor {
666 int index; /**< Minor device number */
667 int type; /**< Control or render */
Dave Airlie5bdebb12013-10-11 14:07:25 +1000668 struct device *kdev; /**< Linux device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 struct drm_device *dev;
Ben Gamari955b12d2009-02-17 20:08:49 -0500670
Ben Gamari955b12d2009-02-17 20:08:49 -0500671 struct dentry *debugfs_root;
Marcin Slusarzb3e067c2011-11-09 22:20:35 +0100672
673 struct list_head debugfs_list;
674 struct mutex debugfs_lock; /* Protects debugfs_list. */
Ben Gamari955b12d2009-02-17 20:08:49 -0500675
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100676 /* currently active master for this node. Protected by master_mutex */
677 struct drm_master *master;
Dave Airlief453ba02008-11-07 14:05:41 -0800678 struct drm_mode_group mode_group;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000679};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Chris Wilson1794d252011-04-17 07:43:32 +0100681
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000682struct drm_pending_vblank_event {
683 struct drm_pending_event base;
684 int pipe;
685 struct drm_event_vblank event;
686};
687
Ville Syrjälä5380e922013-10-04 14:53:36 +0300688struct drm_vblank_crtc {
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200689 struct drm_device *dev; /* pointer to the drm_device */
Ville Syrjälä5380e922013-10-04 14:53:36 +0300690 wait_queue_head_t queue; /**< VBLANK wait queue */
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200691 struct timer_list disable_timer; /* delayed disable timer */
Daniel Vetter99264a62015-04-15 19:34:43 +0200692
693 /* vblank counter, protected by dev->vblank_time_lock for writes */
694 unsigned long count;
695 /* vblank timestamps, protected by dev->vblank_time_lock for writes */
696 struct timeval time[DRM_VBLANKTIME_RBSIZE];
697
Ville Syrjälä5380e922013-10-04 14:53:36 +0300698 atomic_t refcount; /* number of users of vblank interruptsper crtc */
699 u32 last; /* protected by dev->vbl_lock, used */
700 /* for wraparound handling */
701 u32 last_wait; /* Last vblank seqno waited per CRTC */
702 unsigned int inmodeset; /* Display driver is setting mode */
Ville Syrjäläe69595c2014-02-19 19:36:08 +0200703 int crtc; /* crtc index */
Ville Syrjälä5380e922013-10-04 14:53:36 +0300704 bool enabled; /* so we don't call enable more than
705 once per disable */
706};
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708/**
709 * DRM device structure. This structure represent a complete card that
710 * may contain multiple heads.
711 */
Dave Airlie84b1fd12007-07-11 15:53:27 +1000712struct drm_device {
Daniel Vetterb3f23332013-12-11 11:34:31 +0100713 struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000714 int if_version; /**< Highest interface version set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
David Herrmann45e212d2014-01-28 16:00:35 +0100716 /** \name Lifetime Management */
717 /*@{ */
David Herrmann099d1c22014-01-29 10:21:36 +0100718 struct kref ref; /**< Object ref-count */
David Herrmann45e212d2014-01-28 16:00:35 +0100719 struct device *dev; /**< Device structure of bus-device */
720 struct drm_driver *driver; /**< DRM driver managing the device */
721 void *dev_private; /**< DRM driver private data */
David Herrmann45e212d2014-01-28 16:00:35 +0100722 struct drm_minor *control; /**< Control node */
723 struct drm_minor *primary; /**< Primary node */
724 struct drm_minor *render; /**< Render node */
725 atomic_t unplugged; /**< Flag whether dev is dead */
David Herrmann07b48c32014-03-16 13:13:51 +0100726 struct inode *anon_inode; /**< inode for private address-space */
Thierry Redingca8e2ad2014-04-11 15:23:00 +0200727 char *unique; /**< unique name of the device */
David Herrmann45e212d2014-01-28 16:00:35 +0100728 /*@} */
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 /** \name Locks */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000731 /*@{ */
Dave Airlie30e2fb12006-02-02 19:37:46 +1100732 struct mutex struct_mutex; /**< For others */
Thomas Hellstromc996fd02014-02-25 19:57:44 +0100733 struct mutex master_mutex; /**< For drm_minor::master and drm_file::is_master */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000734 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736 /** \name Usage Counters */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000737 /*@{ */
Daniel Vetterfc8fd402013-11-03 20:46:34 +0100738 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */
Daniel Vetter2177a212013-12-16 11:21:06 +0100739 spinlock_t buf_lock; /**< For drm_device::buf_use and a few other things. */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000740 int buf_use; /**< Buffers in use -- cannot alloc */
741 atomic_t buf_alloc; /**< Buffer allocation in progress */
742 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Dave Airliebd1b3312007-05-26 05:01:51 +1000744 struct list_head filelist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746 /** \name Memory management */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000747 /*@{ */
Dave Airliebd1b3312007-05-26 05:01:51 +1000748 struct list_head maplist; /**< Linked list of regions */
Dave Airliee0be4282007-07-12 10:26:44 +1000749 struct drm_open_hash map_hash; /**< User token hash table for maps */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751 /** \name Context handle management */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000752 /*@{ */
Dave Airliebd1b3312007-05-26 05:01:51 +1000753 struct list_head ctxlist; /**< Linked list of context handles */
Dave Airlie30e2fb12006-02-02 19:37:46 +1100754 struct mutex ctxlist_mutex; /**< For ctxlist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Dave Airlie62968142007-07-17 10:46:52 +1000756 struct idr ctx_idr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Dave Airliebd1b3312007-05-26 05:01:51 +1000758 struct list_head vmalist; /**< List of vmas (for debugging) */
Dave Airlief453ba02008-11-07 14:05:41 -0800759
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000760 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Daniel Vettera344a7e2011-10-26 00:54:41 +0200762 /** \name DMA support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000763 /*@{ */
Dave Airliecdd55a22007-07-11 16:32:08 +1000764 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000765 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767 /** \name Context support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000768 /*@{ */
Daniel Vetter7c1a38e2013-12-16 11:21:15 +0100769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 __volatile__ long context_flag; /**< Context swapping flag */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000771 int last_context; /**< Last current context */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000772 /*@} */
773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 /** \name VBLANK IRQ support */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000775 /*@{ */
Thierry Redingb46004b2014-12-17 16:41:41 +0100776 bool irq_enabled;
777 int irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700779 /*
780 * At load time, disabling the vblank interrupt won't be allowed since
781 * old clients may not call the modeset ioctl and therefore misbehave.
782 * Once the modeset ioctl *has* been called though, we can safely
783 * disable them when unused.
784 */
Ville Syrjäläba0bf122013-10-04 14:53:33 +0300785 bool vblank_disable_allowed;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700786
Ville Syrjälä00185e62014-08-06 14:49:54 +0300787 /*
788 * If true, vblank interrupt will be disabled immediately when the
789 * refcount drops to zero, as opposed to via the vblank disable
790 * timer.
791 * This can be set to true it the hardware has a working vblank
792 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
793 * appropriately.
794 */
795 bool vblank_disable_immediate;
796
Ville Syrjälä5380e922013-10-04 14:53:36 +0300797 /* array of size num_crtcs */
798 struct drm_vblank_crtc *vblank;
799
Mario Kleiner27641c32010-10-23 04:20:23 +0200800 spinlock_t vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000801 spinlock_t vbl_lock;
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700802
803 u32 max_vblank_count; /**< size of vblank counter register */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000805 /**
806 * List of events
807 */
808 struct list_head vblank_event_list;
809 spinlock_t event_lock;
810
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000811 /*@} */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Dave Airlie55910512007-07-11 16:53:40 +1000813 struct drm_agp_head *agp; /**< AGP data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000815 struct pci_dev *pdev; /**< PCI device structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816#ifdef __alpha__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 struct pci_controller *hose;
818#endif
Jordan Crousedcdb1672010-05-27 13:40:25 -0600819
820 struct platform_device *platformdev; /**< Platform device struture */
Dave Airliedc5698e2013-09-09 10:02:56 +1000821 struct virtio_device *virtdev;
Jordan Crousedcdb1672010-05-27 13:40:25 -0600822
Dave Airlie55910512007-07-11 16:53:40 +1000823 struct drm_sg_mem *sg; /**< Scatter gather memory */
Dave Airlie19227562011-02-24 08:35:06 +1000824 unsigned int num_crtcs; /**< Number of CRTCs on this device */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000825 sigset_t sigmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
David Herrmann69d516c2014-08-29 12:12:39 +0200827 struct {
828 int context;
829 struct drm_hw_lock *lock;
830 } sigdata;
831
Benjamin Herrenschmidtf77d3902009-02-02 16:55:46 +1100832 struct drm_local_map *agp_buffer_map;
Dave Airlied1f2b552005-08-05 22:11:22 +1000833 unsigned int agp_buffer_token;
=?utf-8?q?Michel_D=C3=A4nzer?=bea56792006-10-24 23:04:19 +1000834
Rob Clark417009fb2014-11-25 20:33:10 -0500835 struct drm_mode_config mode_config; /**< Current mode config */
Dave Airlief453ba02008-11-07 14:05:41 -0800836
Eric Anholt673a3942008-07-30 12:06:12 -0700837 /** \name GEM information */
838 /*@{ */
Daniel Vettercd4f0132013-08-15 00:02:44 +0200839 struct mutex object_name_lock;
Eric Anholt673a3942008-07-30 12:06:12 -0700840 struct idr object_name_idr;
Daniel Vetterb04a5902013-12-11 14:24:46 +0100841 struct drm_vma_offset_manager *vma_offset_manager;
Eric Anholt673a3942008-07-30 12:06:12 -0700842 /*@} */
Dave Airlie5bcf7192010-12-07 09:20:40 +1000843 int switch_power_state;
Dave Airlie84b1fd12007-07-11 15:53:27 +1000844};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Dave Airlie5bcf7192010-12-07 09:20:40 +1000846#define DRM_SWITCH_POWER_ON 0
847#define DRM_SWITCH_POWER_OFF 1
848#define DRM_SWITCH_POWER_CHANGING 2
Dave Airlie13bb9cc2012-09-12 15:55:05 +1000849#define DRM_SWITCH_POWER_DYNAMIC_OFF 3
Dave Airlie5bcf7192010-12-07 09:20:40 +1000850
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000851static __inline__ int drm_core_check_feature(struct drm_device *dev,
852 int feature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
854 return ((dev->driver->driver_features & feature) ? 1 : 0);
855}
856
Dave Airlie2c07a212012-02-20 14:18:07 +0000857static inline void drm_device_set_unplugged(struct drm_device *dev)
858{
859 smp_wmb();
860 atomic_set(&dev->unplugged, 1);
861}
862
863static inline int drm_device_is_unplugged(struct drm_device *dev)
864{
865 int ret = atomic_read(&dev->unplugged);
866 smp_rmb();
867 return ret;
868}
869
Thomas Hellstrom43683052014-03-13 11:07:44 +0100870static inline bool drm_is_render_client(const struct drm_file *file_priv)
David Herrmann17931262013-08-25 18:29:00 +0200871{
872 return file_priv->minor->type == DRM_MINOR_RENDER;
873}
874
Thomas Hellstromac05dbc2014-02-19 14:21:48 +0100875static inline bool drm_is_control_client(const struct drm_file *file_priv)
876{
877 return file_priv->minor->type == DRM_MINOR_CONTROL;
878}
879
Thomas Hellstrom43683052014-03-13 11:07:44 +0100880static inline bool drm_is_primary_client(const struct drm_file *file_priv)
881{
882 return file_priv->minor->type == DRM_MINOR_LEGACY;
883}
884
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885/******************************************************************/
886/** \name Internal function definitions */
887/*@{*/
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 /* Driver support (drm_drv.h) */
Arnd Bergmanned8b6702009-12-16 22:17:09 +0000890extern long drm_ioctl(struct file *filp,
891 unsigned int cmd, unsigned long arg);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000892extern long drm_compat_ioctl(struct file *filp,
893 unsigned int cmd, unsigned long arg);
Thomas Hellstrom4beb6d92014-02-26 15:51:57 +0100894extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
896 /* Device support (drm_fops.h) */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000897extern int drm_open(struct inode *inode, struct file *filp);
Kristian Høgsbergc9a9c5e2009-09-12 04:33:34 +1000898extern ssize_t drm_read(struct file *filp, char __user *buffer,
899 size_t count, loff_t *offset);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000900extern int drm_release(struct inode *inode, struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
902 /* Mapping support (drm_vm.h) */
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000903extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Daniel Vetter78238752014-09-10 12:43:55 +0200905/* Misc. IOCTL support (drm_ioctl.c) */
906int drm_noop(struct drm_device *dev, void *data,
907 struct drm_file *file_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
Eric Anholt673a3942008-07-30 12:06:12 -0700909/* Cache management (drm_cache.c) */
910void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
Chris Wilson9da3da62012-06-01 15:20:22 +0100911void drm_clflush_sg(struct sg_table *st);
Ville Syrjäläc2d15352014-04-01 12:59:08 +0300912void drm_clflush_virt_range(void *addr, unsigned long length);
Eric Anholt673a3942008-07-30 12:06:12 -0700913
Thomas Hellstrom040ac322007-03-23 13:28:33 +1100914/*
915 * These are exported to drivers so that they can implement fencing using
916 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
917 */
918
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 /* IRQ support (drm_irq.h) */
Daniel Vetterbb0f1b52013-11-03 21:09:27 +0100920extern int drm_irq_install(struct drm_device *dev, int irq);
Dave Airlie84b1fd12007-07-11 15:53:27 +1000921extern int drm_irq_uninstall(struct drm_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700923extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
Dave Airlieaf6061a2008-05-07 12:15:39 +1000924extern int drm_wait_vblank(struct drm_device *dev, void *data,
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700925 struct drm_file *filp);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700926extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
Thierry Reding96d3f912014-12-16 13:08:47 +0100927extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
Mario Kleiner27641c32010-10-23 04:20:23 +0200928extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
929 struct timeval *vblanktime);
Rob Clarkc6eefa12012-10-16 22:48:40 +0000930extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
931 struct drm_pending_vblank_event *e);
Thierry Redinga4d7b302014-12-15 14:47:18 +0100932extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
933 struct drm_pending_vblank_event *e);
Chris Wilson78c6e172011-01-31 10:48:04 +0000934extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
Thierry Reding115ebcd2014-12-15 14:47:18 +0100935extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700936extern int drm_vblank_get(struct drm_device *dev, int crtc);
937extern void drm_vblank_put(struct drm_device *dev, int crtc);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200938extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
939extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
Daniel Vettere8450f52014-07-25 23:34:03 +0200940extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
941extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
Li Peng778c9022009-11-09 12:51:22 +0800942extern void drm_vblank_off(struct drm_device *dev, int crtc);
Ville Syrjäläf2752282014-02-19 21:29:49 +0200943extern void drm_vblank_on(struct drm_device *dev, int crtc);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200944extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
Daniel Vetter96256042015-02-13 21:03:42 +0100945extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200946extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
Keith Packard52440212008-11-18 09:30:25 -0800947extern void drm_vblank_cleanup(struct drm_device *dev);
Daniel Vetter89dd6a42014-05-15 15:32:12 +0200948
Mario Kleiner27641c32010-10-23 04:20:23 +0200949extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
950 int crtc, int *max_error,
951 struct timeval *vblank_time,
952 unsigned flags,
Ville Syrjälä7da903e2013-10-26 17:57:31 +0300953 const struct drm_crtc *refcrtc,
954 const struct drm_display_mode *mode);
Ville Syrjälä545cdd52013-10-26 17:16:30 +0300955extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
956 const struct drm_display_mode *mode);
Mario Kleiner27641c32010-10-23 04:20:23 +0200957
Ville Syrjälä020178a2014-05-22 19:36:03 +0300958/**
959 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
960 * @crtc: which CRTC's vblank waitqueue to retrieve
961 *
962 * This function returns a pointer to the vblank waitqueue for the CRTC.
963 * Drivers can use this to implement vblank waits using wait_event() & co.
964 */
965static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
966{
967 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
968}
Steffen Trumtrarebc64e42012-11-14 11:22:52 +0100969
Jesse Barnes0a3e67a2008-09-30 12:14:26 -0700970/* Modesetting support */
Dave Airlief453ba02008-11-07 14:05:41 -0800971extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
972extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 /* Stub support (drm_stub.h) */
Dave Airlie7c1c2872008-11-28 14:22:24 +1000975extern struct drm_master *drm_master_get(struct drm_master *master);
976extern void drm_master_put(struct drm_master **master);
Dave Airlie8410ea32010-12-15 03:16:38 +1000977
Kristian Høgsberg112b7152009-01-04 16:55:33 -0500978extern void drm_put_dev(struct drm_device *dev);
Dave Airlie2c07a212012-02-20 14:18:07 +0000979extern void drm_unplug_dev(struct drm_device *dev);
Dave Airlieb5e89ed2005-09-25 14:28:13 +1000980extern unsigned int drm_debug;
Rob Clark88a48e22014-12-18 16:01:50 -0500981extern bool drm_atomic;
Dave Airlie2c14f282008-04-21 16:47:32 +1000982
Ben Gamari955b12d2009-02-17 20:08:49 -0500983 /* Debugfs support */
984#if defined(CONFIG_DEBUG_FS)
Lespiau, Damien7d747952013-10-17 19:09:53 +0100985extern int drm_debugfs_create_files(const struct drm_info_list *files,
986 int count, struct dentry *root,
987 struct drm_minor *minor);
988extern int drm_debugfs_remove_files(const struct drm_info_list *files,
989 int count, struct drm_minor *minor);
Thierry Reding66ee52e2013-12-12 15:44:04 +0100990#else
Thierry Reding66ee52e2013-12-12 15:44:04 +0100991static inline int drm_debugfs_create_files(const struct drm_info_list *files,
992 int count, struct dentry *root,
993 struct drm_minor *minor)
994{
995 return 0;
996}
997
998static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
999 int count, struct drm_minor *minor)
1000{
1001 return 0;
1002}
Ben Gamari955b12d2009-02-17 20:08:49 -05001003#endif
1004
Aaron Plattner89177642013-01-15 20:47:42 +00001005extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1006 struct drm_gem_object *obj, int flags);
Dave Airlie32488772011-11-25 15:21:02 +00001007extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1008 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1009 int *prime_fd);
Aaron Plattner89177642013-01-15 20:47:42 +00001010extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1011 struct dma_buf *dma_buf);
Dave Airlie32488772011-11-25 15:21:02 +00001012extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1013 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
Daniel Vetterc1d67982013-08-15 00:02:30 +02001014extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
Dave Airlie32488772011-11-25 15:21:02 +00001015
Dave Airlie51ab7ba2012-05-18 15:40:33 +01001016extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1017 dma_addr_t *addrs, int max_pages);
Thierry Reding34eab432014-06-04 09:18:29 +02001018extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
Dave Airlie32488772011-11-25 15:21:02 +00001019extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Daniel Vetterba8286f2014-09-11 07:43:25 +02001022extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1023 size_t align);
1024extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
1026 /* sysfs support (drm_sysfs.c) */
Dave Airlief453ba02008-11-07 14:05:41 -08001027extern void drm_sysfs_hotplug_event(struct drm_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
Eric Anholt673a3942008-07-30 12:06:12 -07001029
David Herrmann1bb72532013-10-02 11:23:34 +02001030struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1031 struct device *parent);
David Herrmann099d1c22014-01-29 10:21:36 +01001032void drm_dev_ref(struct drm_device *dev);
1033void drm_dev_unref(struct drm_device *dev);
David Herrmannc22f0ac2013-10-02 11:23:35 +02001034int drm_dev_register(struct drm_device *dev, unsigned long flags);
David Herrmannc3a49732013-10-02 11:23:38 +02001035void drm_dev_unregister(struct drm_device *dev);
Thierry Redingca8e2ad2014-04-11 15:23:00 +02001036int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
David Herrmann1616c522014-01-29 10:49:19 +01001037
1038struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1039void drm_minor_release(struct drm_minor *minor);
1040
Dave Airlie8410ea32010-12-15 03:16:38 +10001041/*@}*/
1042
1043/* PCI section */
1044static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1045{
Dave Airlieb5e89ed2005-09-25 14:28:13 +10001046 if (dev->driver->device_is_agp != NULL) {
1047 int err = (*dev->driver->device_is_agp) (dev);
1048
Dave Airliecda17382005-07-10 17:31:26 +10001049 if (err != 2) {
1050 return err;
1051 }
1052 }
1053
1054 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1055}
Daniel Vetter4efafeb2013-12-11 11:34:38 +01001056void drm_pci_agp_destroy(struct drm_device *dev);
Dave Airliecda17382005-07-10 17:31:26 +10001057
Dave Airlie8410ea32010-12-15 03:16:38 +10001058extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1059extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
Thierry Redinga9e3c902014-08-05 13:37:47 +02001060#ifdef CONFIG_PCI
Dave Airlie8410ea32010-12-15 03:16:38 +10001061extern int drm_get_pci_dev(struct pci_dev *pdev,
Jordan Crousedcdb1672010-05-27 13:40:25 -06001062 const struct pci_device_id *ent,
1063 struct drm_driver *driver);
David Herrmann915b4d12014-08-29 12:12:43 +02001064extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
Thierry Redinga9e3c902014-08-05 13:37:47 +02001065#else
1066static inline int drm_get_pci_dev(struct pci_dev *pdev,
1067 const struct pci_device_id *ent,
1068 struct drm_driver *driver)
1069{
1070 return -ENOSYS;
1071}
1072
1073static inline int drm_pci_set_busid(struct drm_device *dev,
1074 struct drm_master *master)
1075{
1076 return -ENOSYS;
1077}
1078#endif
Dave Airlie8410ea32010-12-15 03:16:38 +10001079
Dave Airlief4297782012-06-27 08:35:53 +01001080#define DRM_PCIE_SPEED_25 1
1081#define DRM_PCIE_SPEED_50 2
1082#define DRM_PCIE_SPEED_80 4
1083
1084extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
Dave Airlie8410ea32010-12-15 03:16:38 +10001085
1086/* platform section */
1087extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
David Herrmann915b4d12014-08-29 12:12:43 +02001088extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
Dave Airlie8410ea32010-12-15 03:16:38 +10001089
Dave Airliecc1f7192012-01-05 09:55:22 +00001090/* returns true if currently okay to sleep */
1091static __inline__ bool drm_can_sleep(void)
1092{
1093 if (in_atomic() || in_dbg_master() || irqs_disabled())
1094 return false;
1095 return true;
1096}
1097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098#endif