drm/amdgpu: revert "use more than 64KB fragment size if possible"
[cascardo/linux.git] / include / drm / drmP.h
1 /*
2  * Internal Header for the Direct Rendering Manager
3  *
4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6  * Copyright (c) 2009-2010, Code Aurora Forum.
7  * All rights reserved.
8  *
9  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10  * Author: Gareth Hughes <gareth@valinux.com>
11  *
12  * 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
35 #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>
45 #include <linux/kernel.h>
46 #include <linux/kref.h>
47 #include <linux/miscdevice.h>
48 #include <linux/mm.h>
49 #include <linux/mutex.h>
50 #include <linux/pci.h>
51 #include <linux/platform_device.h>
52 #include <linux/poll.h>
53 #include <linux/ratelimit.h>
54 #include <linux/sched.h>
55 #include <linux/slab.h>
56 #include <linux/types.h>
57 #include <linux/vmalloc.h>
58 #include <linux/workqueue.h>
59 #include <linux/fence.h>
60
61 #include <asm/mman.h>
62 #include <asm/pgalloc.h>
63 #include <asm/uaccess.h>
64
65 #include <uapi/drm/drm.h>
66 #include <uapi/drm/drm_mode.h>
67
68 #include <drm/drm_agpsupport.h>
69 #include <drm/drm_crtc.h>
70 #include <drm/drm_fourcc.h>
71 #include <drm/drm_global.h>
72 #include <drm/drm_hashtab.h>
73 #include <drm/drm_mem_util.h>
74 #include <drm/drm_mm.h>
75 #include <drm/drm_os_linux.h>
76 #include <drm/drm_sarea.h>
77 #include <drm/drm_vma_manager.h>
78
79 struct module;
80
81 struct drm_file;
82 struct drm_device;
83 struct drm_agp_head;
84 struct drm_local_map;
85 struct drm_device_dma;
86 struct drm_dma_handle;
87 struct drm_gem_object;
88 struct drm_master;
89 struct drm_vblank_crtc;
90
91 struct device_node;
92 struct videomode;
93 struct reservation_object;
94 struct dma_buf_attachment;
95
96 /*
97  * The following categories are defined:
98  *
99  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
100  *       This is the category used by the DRM_DEBUG() macro.
101  *
102  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
103  *         This is the category used by the DRM_DEBUG_DRIVER() macro.
104  *
105  * KMS: used in the modesetting code.
106  *      This is the category used by the DRM_DEBUG_KMS() macro.
107  *
108  * PRIME: used in the prime code.
109  *        This is the category used by the DRM_DEBUG_PRIME() macro.
110  *
111  * ATOMIC: used in the atomic code.
112  *        This is the category used by the DRM_DEBUG_ATOMIC() macro.
113  *
114  * VBL: used for verbose debug message in the vblank code
115  *        This is the category used by the DRM_DEBUG_VBL() macro.
116  *
117  * Enabling verbose debug messages is done through the drm.debug parameter,
118  * each category being enabled by a bit.
119  *
120  * drm.debug=0x1 will enable CORE messages
121  * drm.debug=0x2 will enable DRIVER messages
122  * drm.debug=0x3 will enable CORE and DRIVER messages
123  * ...
124  * drm.debug=0x3f will enable all messages
125  *
126  * An interesting feature is that it's possible to enable verbose logging at
127  * run-time by echoing the debug value in its sysfs node:
128  *   # echo 0xf > /sys/module/drm/parameters/debug
129  */
130 #define DRM_UT_NONE             0x00
131 #define DRM_UT_CORE             0x01
132 #define DRM_UT_DRIVER           0x02
133 #define DRM_UT_KMS              0x04
134 #define DRM_UT_PRIME            0x08
135 #define DRM_UT_ATOMIC           0x10
136 #define DRM_UT_VBL              0x20
137
138 extern __printf(6, 7)
139 void drm_dev_printk(const struct device *dev, const char *level,
140                     unsigned int category, const char *function_name,
141                     const char *prefix, const char *format, ...);
142
143 extern __printf(5, 6)
144 void drm_printk(const char *level, unsigned int category,
145                 const char *function_name, const char *prefix,
146                 const char *format, ...);
147
148 /***********************************************************************/
149 /** \name DRM template customization defaults */
150 /*@{*/
151
152 /* driver capabilities and requirements mask */
153 #define DRIVER_USE_AGP                  0x1
154 #define DRIVER_LEGACY                   0x2
155 #define DRIVER_PCI_DMA                  0x8
156 #define DRIVER_SG                       0x10
157 #define DRIVER_HAVE_DMA                 0x20
158 #define DRIVER_HAVE_IRQ                 0x40
159 #define DRIVER_IRQ_SHARED               0x80
160 #define DRIVER_GEM                      0x1000
161 #define DRIVER_MODESET                  0x2000
162 #define DRIVER_PRIME                    0x4000
163 #define DRIVER_RENDER                   0x8000
164 #define DRIVER_ATOMIC                   0x10000
165 #define DRIVER_KMS_LEGACY_CONTEXT       0x20000
166
167 /***********************************************************************/
168 /** \name Macros to make printk easier */
169 /*@{*/
170
171 #define _DRM_PRINTK(once, level, fmt, ...)                              \
172         do {                                                            \
173                 printk##once(KERN_##level "[" DRM_NAME "] " fmt,        \
174                              ##__VA_ARGS__);                            \
175         } while (0)
176
177 #define DRM_INFO(fmt, ...)                                              \
178         _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
179 #define DRM_NOTE(fmt, ...)                                              \
180         _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
181 #define DRM_WARN(fmt, ...)                                              \
182         _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
183
184 #define DRM_INFO_ONCE(fmt, ...)                                         \
185         _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
186 #define DRM_NOTE_ONCE(fmt, ...)                                         \
187         _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
188 #define DRM_WARN_ONCE(fmt, ...)                                         \
189         _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
190
191 /**
192  * Error output.
193  *
194  * \param fmt printf() like format string.
195  * \param arg arguments
196  */
197 #define DRM_DEV_ERROR(dev, fmt, ...)                                    \
198         drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
199                        fmt, ##__VA_ARGS__)
200 #define DRM_ERROR(fmt, ...)                                             \
201         drm_printk(KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*", fmt,    \
202                    ##__VA_ARGS__)
203
204 /**
205  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
206  *
207  * \param fmt printf() like format string.
208  * \param arg arguments
209  */
210 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)                        \
211 ({                                                                      \
212         static DEFINE_RATELIMIT_STATE(_rs,                              \
213                                       DEFAULT_RATELIMIT_INTERVAL,       \
214                                       DEFAULT_RATELIMIT_BURST);         \
215                                                                         \
216         if (__ratelimit(&_rs))                                          \
217                 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);                 \
218 })
219 #define DRM_ERROR_RATELIMITED(fmt, ...)                                 \
220         DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
221
222 #define DRM_DEV_INFO(dev, fmt, ...)                                     \
223         drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt,  \
224                        ##__VA_ARGS__)
225
226 #define DRM_DEV_INFO_ONCE(dev, fmt, ...)                                \
227 ({                                                                      \
228         static bool __print_once __read_mostly;                         \
229         if (!__print_once) {                                            \
230                 __print_once = true;                                    \
231                 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);                  \
232         }                                                               \
233 })
234
235 /**
236  * Debug output.
237  *
238  * \param fmt printf() like format string.
239  * \param arg arguments
240  */
241 #define DRM_DEV_DEBUG(dev, fmt, args...)                                \
242         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, \
243                        ##args)
244 #define DRM_DEBUG(fmt, args...)                                         \
245         drm_printk(KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, ##args)
246
247 #define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...)                         \
248         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "",    \
249                        fmt, ##args)
250 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
251         drm_printk(KERN_DEBUG, DRM_UT_DRIVER, __func__, "", fmt, ##args)
252
253 #define DRM_DEV_DEBUG_KMS(dev, fmt, args...)                            \
254         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt,  \
255                        ##args)
256 #define DRM_DEBUG_KMS(fmt, args...)                                     \
257         drm_printk(KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, ##args)
258
259 #define DRM_DEV_DEBUG_PRIME(dev, fmt, args...)                          \
260         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "",     \
261                        fmt, ##args)
262 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
263         drm_printk(KERN_DEBUG, DRM_UT_PRIME, __func__, "", fmt, ##args)
264
265 #define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...)                         \
266         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "",    \
267                        fmt, ##args)
268 #define DRM_DEBUG_ATOMIC(fmt, args...)                                  \
269         drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", fmt, ##args)
270
271 #define DRM_DEV_DEBUG_VBL(dev, fmt, args...)                            \
272         drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt,  \
273                        ##args)
274 #define DRM_DEBUG_VBL(fmt, args...)                                     \
275         drm_printk(KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, ##args)
276
277 #define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...)     \
278 ({                                                                      \
279         static DEFINE_RATELIMIT_STATE(_rs,                              \
280                                       DEFAULT_RATELIMIT_INTERVAL,       \
281                                       DEFAULT_RATELIMIT_BURST);         \
282         if (__ratelimit(&_rs))                                          \
283                 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level,       \
284                                __func__, "", fmt, ##args);              \
285 })
286
287 /**
288  * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
289  *
290  * \param fmt printf() like format string.
291  * \param arg arguments
292  */
293 #define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...)                    \
294         DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
295 #define DRM_DEBUG_RATELIMITED(fmt, args...)                             \
296         DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
297 #define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...)             \
298         _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
299 #define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...)                      \
300         DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
301 #define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...)                \
302         _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
303 #define DRM_DEBUG_KMS_RATELIMITED(fmt, args...)                         \
304         DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
305 #define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...)              \
306         _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
307 #define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...)                       \
308         DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
309
310 /*@}*/
311
312 /***********************************************************************/
313 /** \name Internal types and structures */
314 /*@{*/
315
316 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
317
318 /**
319  * Ioctl function type.
320  *
321  * \param inode device inode.
322  * \param file_priv DRM file private pointer.
323  * \param cmd command.
324  * \param arg argument.
325  */
326 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
327                         struct drm_file *file_priv);
328
329 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
330                                unsigned long arg);
331
332 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
333 #define DRM_MAJOR       226
334
335 #define DRM_AUTH        0x1
336 #define DRM_MASTER      0x2
337 #define DRM_ROOT_ONLY   0x4
338 #define DRM_CONTROL_ALLOW 0x8
339 #define DRM_UNLOCKED    0x10
340 #define DRM_RENDER_ALLOW 0x20
341
342 struct drm_ioctl_desc {
343         unsigned int cmd;
344         int flags;
345         drm_ioctl_t *func;
346         const char *name;
347 };
348
349 /**
350  * Creates a driver or general drm_ioctl_desc array entry for the given
351  * ioctl, for use by drm_ioctl().
352  */
353
354 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                         \
355         [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = {        \
356                 .cmd = DRM_IOCTL_##ioctl,                               \
357                 .func = _func,                                          \
358                 .flags = _flags,                                        \
359                 .name = #ioctl                                          \
360          }
361
362 /* Event queued up for userspace to read */
363 struct drm_pending_event {
364         struct completion *completion;
365         struct drm_event *event;
366         struct fence *fence;
367         struct list_head link;
368         struct list_head pending_link;
369         struct drm_file *file_priv;
370         pid_t pid; /* pid of requester, no guarantee it's valid by the time
371                       we deliver the event, for tracing only */
372 };
373
374 /* initial implementaton using a linked list - todo hashtab */
375 struct drm_prime_file_private {
376         struct list_head head;
377         struct mutex lock;
378 };
379
380 /** File private data */
381 struct drm_file {
382         unsigned authenticated :1;
383         /* true when the client has asked us to expose stereo 3D mode flags */
384         unsigned stereo_allowed :1;
385         /*
386          * true if client understands CRTC primary planes and cursor planes
387          * in the plane list
388          */
389         unsigned universal_planes:1;
390         /* true if client understands atomic properties */
391         unsigned atomic:1;
392         /*
393          * This client is the creator of @master.
394          * Protected by struct drm_device::master_mutex.
395          */
396         unsigned is_master:1;
397
398         struct pid *pid;
399         drm_magic_t magic;
400         struct list_head lhead;
401         struct drm_minor *minor;
402         unsigned long lock_count;
403
404         /** Mapping of mm object handles to object pointers. */
405         struct idr object_idr;
406         /** Lock for synchronization of access to object_idr. */
407         spinlock_t table_lock;
408
409         struct file *filp;
410         void *driver_priv;
411
412         struct drm_master *master; /* master this node is currently associated with
413                                       N.B. not always dev->master */
414         /**
415          * fbs - List of framebuffers associated with this file.
416          *
417          * Protected by fbs_lock. Note that the fbs list holds a reference on
418          * the fb object to prevent it from untimely disappearing.
419          */
420         struct list_head fbs;
421         struct mutex fbs_lock;
422
423         /** User-created blob properties; this retains a reference on the
424          *  property. */
425         struct list_head blobs;
426
427         wait_queue_head_t event_wait;
428         struct list_head pending_event_list;
429         struct list_head event_list;
430         int event_space;
431
432         struct mutex event_read_lock;
433
434         struct drm_prime_file_private prime;
435 };
436
437 /**
438  * Lock data.
439  */
440 struct drm_lock_data {
441         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
442         /** Private of lock holder's file (NULL=kernel) */
443         struct drm_file *file_priv;
444         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
445         unsigned long lock_time;        /**< Time of last lock in jiffies */
446         spinlock_t spinlock;
447         uint32_t kernel_waiters;
448         uint32_t user_waiters;
449         int idle_has_lock;
450 };
451
452 /* Flags and return codes for get_vblank_timestamp() driver function. */
453 #define DRM_CALLED_FROM_VBLIRQ 1
454 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
455 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
456
457 /* get_scanout_position() return flags */
458 #define DRM_SCANOUTPOS_VALID        (1 << 0)
459 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
460 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
461
462 /**
463  * DRM driver structure. This structure represent the common code for
464  * a family of cards. There will one drm_device for each card present
465  * in this family
466  */
467 struct drm_driver {
468         int (*load) (struct drm_device *, unsigned long flags);
469         int (*firstopen) (struct drm_device *);
470         int (*open) (struct drm_device *, struct drm_file *);
471         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
472         void (*postclose) (struct drm_device *, struct drm_file *);
473         void (*lastclose) (struct drm_device *);
474         int (*unload) (struct drm_device *);
475         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
476         int (*dma_quiescent) (struct drm_device *);
477         int (*context_dtor) (struct drm_device *dev, int context);
478         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
479
480         /**
481          * get_vblank_counter - get raw hardware vblank counter
482          * @dev: DRM device
483          * @pipe: counter to fetch
484          *
485          * Driver callback for fetching a raw hardware vblank counter for @crtc.
486          * If a device doesn't have a hardware counter, the driver can simply
487          * use drm_vblank_no_hw_counter() function. The DRM core will account for
488          * missed vblank events while interrupts where disabled based on system
489          * timestamps.
490          *
491          * Wraparound handling and loss of events due to modesetting is dealt
492          * with in the DRM core code.
493          *
494          * RETURNS
495          * Raw vblank counter value.
496          */
497         u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
498
499         /**
500          * enable_vblank - enable vblank interrupt events
501          * @dev: DRM device
502          * @pipe: which irq to enable
503          *
504          * Enable vblank interrupts for @crtc.  If the device doesn't have
505          * a hardware vblank counter, the driver should use the
506          * drm_vblank_no_hw_counter() function that keeps a virtual counter.
507          *
508          * RETURNS
509          * Zero on success, appropriate errno if the given @crtc's vblank
510          * interrupt cannot be enabled.
511          */
512         int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
513
514         /**
515          * disable_vblank - disable vblank interrupt events
516          * @dev: DRM device
517          * @pipe: which irq to enable
518          *
519          * Disable vblank interrupts for @crtc.  If the device doesn't have
520          * a hardware vblank counter, the driver should use the
521          * drm_vblank_no_hw_counter() function that keeps a virtual counter.
522          */
523         void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
524
525         /**
526          * Called by \c drm_device_is_agp.  Typically used to determine if a
527          * card is really attached to AGP or not.
528          *
529          * \param dev  DRM device handle
530          *
531          * \returns
532          * One of three values is returned depending on whether or not the
533          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
534          * (return of 1), or may or may not be AGP (return of 2).
535          */
536         int (*device_is_agp) (struct drm_device *dev);
537
538         /**
539          * Called by vblank timestamping code.
540          *
541          * Return the current display scanout position from a crtc, and an
542          * optional accurate ktime_get timestamp of when position was measured.
543          *
544          * \param dev  DRM device.
545          * \param pipe Id of the crtc to query.
546          * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
547          * \param *vpos Target location for current vertical scanout position.
548          * \param *hpos Target location for current horizontal scanout position.
549          * \param *stime Target location for timestamp taken immediately before
550          *               scanout position query. Can be NULL to skip timestamp.
551          * \param *etime Target location for timestamp taken immediately after
552          *               scanout position query. Can be NULL to skip timestamp.
553          * \param mode Current display timings.
554          *
555          * Returns vpos as a positive number while in active scanout area.
556          * Returns vpos as a negative number inside vblank, counting the number
557          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
558          * until start of active scanout / end of vblank."
559          *
560          * \return Flags, or'ed together as follows:
561          *
562          * DRM_SCANOUTPOS_VALID = Query successful.
563          * DRM_SCANOUTPOS_INVBL = Inside vblank.
564          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
565          * this flag means that returned position may be offset by a constant
566          * but unknown small number of scanlines wrt. real scanout position.
567          *
568          */
569         int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
570                                      unsigned int flags, int *vpos, int *hpos,
571                                      ktime_t *stime, ktime_t *etime,
572                                      const struct drm_display_mode *mode);
573
574         /**
575          * Called by \c drm_get_last_vbltimestamp. Should return a precise
576          * timestamp when the most recent VBLANK interval ended or will end.
577          *
578          * Specifically, the timestamp in @vblank_time should correspond as
579          * closely as possible to the time when the first video scanline of
580          * the video frame after the end of VBLANK will start scanning out,
581          * the time immediately after end of the VBLANK interval. If the
582          * @crtc is currently inside VBLANK, this will be a time in the future.
583          * If the @crtc is currently scanning out a frame, this will be the
584          * past start time of the current scanout. This is meant to adhere
585          * to the OpenML OML_sync_control extension specification.
586          *
587          * \param dev dev DRM device handle.
588          * \param pipe crtc for which timestamp should be returned.
589          * \param *max_error Maximum allowable timestamp error in nanoseconds.
590          *                   Implementation should strive to provide timestamp
591          *                   with an error of at most *max_error nanoseconds.
592          *                   Returns true upper bound on error for timestamp.
593          * \param *vblank_time Target location for returned vblank timestamp.
594          * \param flags 0 = Defaults, no special treatment needed.
595          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
596          *              irq handler. Some drivers need to apply some workarounds
597          *              for gpu-specific vblank irq quirks if flag is set.
598          *
599          * \returns
600          * Zero if timestamping isn't supported in current display mode or a
601          * negative number on failure. A positive status code on success,
602          * which describes how the vblank_time timestamp was computed.
603          */
604         int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
605                                      int *max_error,
606                                      struct timeval *vblank_time,
607                                      unsigned flags);
608
609         /* these have to be filled in */
610
611         irqreturn_t(*irq_handler) (int irq, void *arg);
612         void (*irq_preinstall) (struct drm_device *dev);
613         int (*irq_postinstall) (struct drm_device *dev);
614         void (*irq_uninstall) (struct drm_device *dev);
615
616         /* Master routines */
617         int (*master_create)(struct drm_device *dev, struct drm_master *master);
618         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
619         /**
620          * master_set is called whenever the minor master is set.
621          * master_drop is called whenever the minor master is dropped.
622          */
623
624         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
625                           bool from_open);
626         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
627
628         int (*debugfs_init)(struct drm_minor *minor);
629         void (*debugfs_cleanup)(struct drm_minor *minor);
630
631         /**
632          * @gem_free_object: deconstructor for drm_gem_objects
633          *
634          * This is deprecated and should not be used by new drivers. Use
635          * @gem_free_object_unlocked instead.
636          */
637         void (*gem_free_object) (struct drm_gem_object *obj);
638
639         /**
640          * @gem_free_object_unlocked: deconstructor for drm_gem_objects
641          *
642          * This is for drivers which are not encumbered with dev->struct_mutex
643          * legacy locking schemes. Use this hook instead of @gem_free_object.
644          */
645         void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
646
647         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
648         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
649
650         /**
651          * Hook for allocating the GEM object struct, for use by core
652          * helpers.
653          */
654         struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
655                                                     size_t size);
656
657         /* prime: */
658         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
659         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
660                                 uint32_t handle, uint32_t flags, int *prime_fd);
661         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
662         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
663                                 int prime_fd, uint32_t *handle);
664         /* export GEM -> dmabuf */
665         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
666                                 struct drm_gem_object *obj, int flags);
667         /* import dmabuf -> GEM */
668         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
669                                 struct dma_buf *dma_buf);
670         /* low-level interface used by drm_gem_prime_{import,export} */
671         int (*gem_prime_pin)(struct drm_gem_object *obj);
672         void (*gem_prime_unpin)(struct drm_gem_object *obj);
673         struct reservation_object * (*gem_prime_res_obj)(
674                                 struct drm_gem_object *obj);
675         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
676         struct drm_gem_object *(*gem_prime_import_sg_table)(
677                                 struct drm_device *dev,
678                                 struct dma_buf_attachment *attach,
679                                 struct sg_table *sgt);
680         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
681         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
682         int (*gem_prime_mmap)(struct drm_gem_object *obj,
683                                 struct vm_area_struct *vma);
684
685         /* vga arb irq handler */
686         void (*vgaarb_irq)(struct drm_device *dev, bool state);
687
688         /* dumb alloc support */
689         int (*dumb_create)(struct drm_file *file_priv,
690                            struct drm_device *dev,
691                            struct drm_mode_create_dumb *args);
692         int (*dumb_map_offset)(struct drm_file *file_priv,
693                                struct drm_device *dev, uint32_t handle,
694                                uint64_t *offset);
695         int (*dumb_destroy)(struct drm_file *file_priv,
696                             struct drm_device *dev,
697                             uint32_t handle);
698
699         /* Driver private ops for this object */
700         const struct vm_operations_struct *gem_vm_ops;
701
702         int major;
703         int minor;
704         int patchlevel;
705         char *name;
706         char *desc;
707         char *date;
708
709         u32 driver_features;
710         int dev_priv_size;
711         const struct drm_ioctl_desc *ioctls;
712         int num_ioctls;
713         const struct file_operations *fops;
714
715         /* List of devices hanging off this driver with stealth attach. */
716         struct list_head legacy_dev_list;
717 };
718
719 enum drm_minor_type {
720         DRM_MINOR_PRIMARY,
721         DRM_MINOR_CONTROL,
722         DRM_MINOR_RENDER,
723         DRM_MINOR_CNT,
724 };
725
726 /**
727  * Info file list entry. This structure represents a debugfs or proc file to
728  * be created by the drm core
729  */
730 struct drm_info_list {
731         const char *name; /** file name */
732         int (*show)(struct seq_file*, void*); /** show callback */
733         u32 driver_features; /**< Required driver features for this entry */
734         void *data;
735 };
736
737 /**
738  * debugfs node structure. This structure represents a debugfs file.
739  */
740 struct drm_info_node {
741         struct list_head list;
742         struct drm_minor *minor;
743         const struct drm_info_list *info_ent;
744         struct dentry *dent;
745 };
746
747 /**
748  * DRM minor structure. This structure represents a drm minor number.
749  */
750 struct drm_minor {
751         int index;                      /**< Minor device number */
752         int type;                       /**< Control or render */
753         struct device *kdev;            /**< Linux device */
754         struct drm_device *dev;
755
756         struct dentry *debugfs_root;
757
758         struct list_head debugfs_list;
759         struct mutex debugfs_lock; /* Protects debugfs_list. */
760 };
761
762 /**
763  * DRM device structure. This structure represent a complete card that
764  * may contain multiple heads.
765  */
766 struct drm_device {
767         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
768         int if_version;                 /**< Highest interface version set */
769
770         /** \name Lifetime Management */
771         /*@{ */
772         struct kref ref;                /**< Object ref-count */
773         struct device *dev;             /**< Device structure of bus-device */
774         struct drm_driver *driver;      /**< DRM driver managing the device */
775         void *dev_private;              /**< DRM driver private data */
776         struct drm_minor *control;              /**< Control node */
777         struct drm_minor *primary;              /**< Primary node */
778         struct drm_minor *render;               /**< Render node */
779
780         /* currently active master for this device. Protected by master_mutex */
781         struct drm_master *master;
782
783         atomic_t unplugged;                     /**< Flag whether dev is dead */
784         struct inode *anon_inode;               /**< inode for private address-space */
785         char *unique;                           /**< unique name of the device */
786         /*@} */
787
788         /** \name Locks */
789         /*@{ */
790         struct mutex struct_mutex;      /**< For others */
791         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
792         /*@} */
793
794         /** \name Usage Counters */
795         /*@{ */
796         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
797         spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
798         int buf_use;                    /**< Buffers in use -- cannot alloc */
799         atomic_t buf_alloc;             /**< Buffer allocation in progress */
800         /*@} */
801
802         struct mutex filelist_mutex;
803         struct list_head filelist;
804
805         /** \name Memory management */
806         /*@{ */
807         struct list_head maplist;       /**< Linked list of regions */
808         struct drm_open_hash map_hash;  /**< User token hash table for maps */
809
810         /** \name Context handle management */
811         /*@{ */
812         struct list_head ctxlist;       /**< Linked list of context handles */
813         struct mutex ctxlist_mutex;     /**< For ctxlist */
814
815         struct idr ctx_idr;
816
817         struct list_head vmalist;       /**< List of vmas (for debugging) */
818
819         /*@} */
820
821         /** \name DMA support */
822         /*@{ */
823         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
824         /*@} */
825
826         /** \name Context support */
827         /*@{ */
828
829         __volatile__ long context_flag; /**< Context swapping flag */
830         int last_context;               /**< Last current context */
831         /*@} */
832
833         /** \name VBLANK IRQ support */
834         /*@{ */
835         bool irq_enabled;
836         int irq;
837
838         /*
839          * If true, vblank interrupt will be disabled immediately when the
840          * refcount drops to zero, as opposed to via the vblank disable
841          * timer.
842          * This can be set to true it the hardware has a working vblank
843          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
844          * appropriately.
845          */
846         bool vblank_disable_immediate;
847
848         /* array of size num_crtcs */
849         struct drm_vblank_crtc *vblank;
850
851         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
852         spinlock_t vbl_lock;
853
854         u32 max_vblank_count;           /**< size of vblank counter register */
855
856         /**
857          * List of events
858          */
859         struct list_head vblank_event_list;
860         spinlock_t event_lock;
861
862         /*@} */
863
864         struct drm_agp_head *agp;       /**< AGP data */
865
866         struct pci_dev *pdev;           /**< PCI device structure */
867 #ifdef __alpha__
868         struct pci_controller *hose;
869 #endif
870
871         struct platform_device *platformdev; /**< Platform device struture */
872         struct virtio_device *virtdev;
873
874         struct drm_sg_mem *sg;  /**< Scatter gather memory */
875         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
876
877         struct {
878                 int context;
879                 struct drm_hw_lock *lock;
880         } sigdata;
881
882         struct drm_local_map *agp_buffer_map;
883         unsigned int agp_buffer_token;
884
885         struct drm_mode_config mode_config;     /**< Current mode config */
886
887         /** \name GEM information */
888         /*@{ */
889         struct mutex object_name_lock;
890         struct idr object_name_idr;
891         struct drm_vma_offset_manager *vma_offset_manager;
892         /*@} */
893         int switch_power_state;
894 };
895
896 #include <drm/drm_irq.h>
897
898 #define DRM_SWITCH_POWER_ON 0
899 #define DRM_SWITCH_POWER_OFF 1
900 #define DRM_SWITCH_POWER_CHANGING 2
901 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
902
903 static __inline__ int drm_core_check_feature(struct drm_device *dev,
904                                              int feature)
905 {
906         return ((dev->driver->driver_features & feature) ? 1 : 0);
907 }
908
909 static inline void drm_device_set_unplugged(struct drm_device *dev)
910 {
911         smp_wmb();
912         atomic_set(&dev->unplugged, 1);
913 }
914
915 static inline int drm_device_is_unplugged(struct drm_device *dev)
916 {
917         int ret = atomic_read(&dev->unplugged);
918         smp_rmb();
919         return ret;
920 }
921
922 static inline bool drm_is_render_client(const struct drm_file *file_priv)
923 {
924         return file_priv->minor->type == DRM_MINOR_RENDER;
925 }
926
927 static inline bool drm_is_control_client(const struct drm_file *file_priv)
928 {
929         return file_priv->minor->type == DRM_MINOR_CONTROL;
930 }
931
932 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
933 {
934         return file_priv->minor->type == DRM_MINOR_PRIMARY;
935 }
936
937 /******************************************************************/
938 /** \name Internal function definitions */
939 /*@{*/
940
941                                 /* Driver support (drm_drv.h) */
942 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
943 extern long drm_ioctl(struct file *filp,
944                       unsigned int cmd, unsigned long arg);
945 extern long drm_compat_ioctl(struct file *filp,
946                              unsigned int cmd, unsigned long arg);
947 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
948
949 /* File Operations (drm_fops.c) */
950 int drm_open(struct inode *inode, struct file *filp);
951 ssize_t drm_read(struct file *filp, char __user *buffer,
952                  size_t count, loff_t *offset);
953 int drm_release(struct inode *inode, struct file *filp);
954 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
955 int drm_event_reserve_init_locked(struct drm_device *dev,
956                                   struct drm_file *file_priv,
957                                   struct drm_pending_event *p,
958                                   struct drm_event *e);
959 int drm_event_reserve_init(struct drm_device *dev,
960                            struct drm_file *file_priv,
961                            struct drm_pending_event *p,
962                            struct drm_event *e);
963 void drm_event_cancel_free(struct drm_device *dev,
964                            struct drm_pending_event *p);
965 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
966 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
967
968 /* Misc. IOCTL support (drm_ioctl.c) */
969 int drm_noop(struct drm_device *dev, void *data,
970              struct drm_file *file_priv);
971 int drm_invalid_op(struct drm_device *dev, void *data,
972                    struct drm_file *file_priv);
973
974 /* Cache management (drm_cache.c) */
975 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
976 void drm_clflush_sg(struct sg_table *st);
977 void drm_clflush_virt_range(void *addr, unsigned long length);
978
979 /*
980  * These are exported to drivers so that they can implement fencing using
981  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
982  */
983
984 /* Modesetting support */
985 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
986 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
987
988 /* drm_drv.c */
989 void drm_put_dev(struct drm_device *dev);
990 void drm_unplug_dev(struct drm_device *dev);
991 extern unsigned int drm_debug;
992
993                                 /* Debugfs support */
994 #if defined(CONFIG_DEBUG_FS)
995 extern int drm_debugfs_create_files(const struct drm_info_list *files,
996                                     int count, struct dentry *root,
997                                     struct drm_minor *minor);
998 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
999                                     int count, struct drm_minor *minor);
1000 #else
1001 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
1002                                            int count, struct dentry *root,
1003                                            struct drm_minor *minor)
1004 {
1005         return 0;
1006 }
1007
1008 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
1009                                            int count, struct drm_minor *minor)
1010 {
1011         return 0;
1012 }
1013 #endif
1014
1015 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1016                 struct drm_gem_object *obj, int flags);
1017 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1018                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1019                 int *prime_fd);
1020 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1021                 struct dma_buf *dma_buf);
1022 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1023                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1024 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1025
1026 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1027                                             dma_addr_t *addrs, int max_pages);
1028 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
1029 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1030
1031
1032 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1033                                             size_t align);
1034 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1035
1036                                /* sysfs support (drm_sysfs.c) */
1037 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1038
1039
1040 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1041                                  struct device *parent);
1042 int drm_dev_init(struct drm_device *dev,
1043                  struct drm_driver *driver,
1044                  struct device *parent);
1045 void drm_dev_ref(struct drm_device *dev);
1046 void drm_dev_unref(struct drm_device *dev);
1047 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1048 void drm_dev_unregister(struct drm_device *dev);
1049
1050 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1051 void drm_minor_release(struct drm_minor *minor);
1052
1053 /*@}*/
1054
1055 /* PCI section */
1056 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1057 {
1058         if (dev->driver->device_is_agp != NULL) {
1059                 int err = (*dev->driver->device_is_agp) (dev);
1060
1061                 if (err != 2) {
1062                         return err;
1063                 }
1064         }
1065
1066         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1067 }
1068 void drm_pci_agp_destroy(struct drm_device *dev);
1069
1070 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1071 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1072 #ifdef CONFIG_PCI
1073 extern int drm_get_pci_dev(struct pci_dev *pdev,
1074                            const struct pci_device_id *ent,
1075                            struct drm_driver *driver);
1076 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1077 #else
1078 static inline int drm_get_pci_dev(struct pci_dev *pdev,
1079                                   const struct pci_device_id *ent,
1080                                   struct drm_driver *driver)
1081 {
1082         return -ENOSYS;
1083 }
1084
1085 static inline int drm_pci_set_busid(struct drm_device *dev,
1086                                     struct drm_master *master)
1087 {
1088         return -ENOSYS;
1089 }
1090 #endif
1091
1092 #define DRM_PCIE_SPEED_25 1
1093 #define DRM_PCIE_SPEED_50 2
1094 #define DRM_PCIE_SPEED_80 4
1095
1096 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1097 extern int drm_pcie_get_max_link_width(struct drm_device *dev, u32 *mlw);
1098
1099 /* platform section */
1100 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1101
1102 /* returns true if currently okay to sleep */
1103 static __inline__ bool drm_can_sleep(void)
1104 {
1105         if (in_atomic() || in_dbg_master() || irqs_disabled())
1106                 return false;
1107         return true;
1108 }
1109
1110 /* helper for handling conditionals in various for_each macros */
1111 #define for_each_if(condition) if (!(condition)) {} else
1112
1113 #endif