drm: mark context support as a legacy subsystem
[firefly-linux-kernel-4.4.55.git] / include / drm / drmP.h
1 /**
2  * \file drmP.h
3  * Private header for Direct Rendering Manager
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8
9 /*
10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12  * Copyright (c) 2009-2010, Code Aurora Forum.
13  * All rights reserved.
14  *
15  * Permission is hereby granted, free of charge, to any person obtaining a
16  * copy of this software and associated documentation files (the "Software"),
17  * to deal in the Software without restriction, including without limitation
18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19  * and/or sell copies of the Software, and to permit persons to whom the
20  * Software is furnished to do so, subject to the following conditions:
21  *
22  * The above copyright notice and this permission notice (including the next
23  * paragraph) shall be included in all copies or substantial portions of the
24  * Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32  * OTHER DEALINGS IN THE SOFTWARE.
33  */
34
35 #ifndef _DRM_P_H_
36 #define _DRM_P_H_
37
38 #ifdef __KERNEL__
39 #ifdef __alpha__
40 /* add include of current.h so that "current" is defined
41  * before static inline funcs in wait.h. Doing this so we
42  * can build the DRM (part of PI DRI). 4/21/2000 S + B */
43 #include <asm/current.h>
44 #endif                          /* __alpha__ */
45 #include <linux/kernel.h>
46 #include <linux/miscdevice.h>
47 #include <linux/fs.h>
48 #include <linux/proc_fs.h>
49 #include <linux/init.h>
50 #include <linux/file.h>
51 #include <linux/platform_device.h>
52 #include <linux/pci.h>
53 #include <linux/jiffies.h>
54 #include <linux/dma-mapping.h>
55 #include <linux/mm.h>
56 #include <linux/cdev.h>
57 #include <linux/mutex.h>
58 #include <linux/io.h>
59 #include <linux/slab.h>
60 #if defined(__alpha__) || defined(__powerpc__)
61 #include <asm/pgtable.h>        /* For pte_wrprotect */
62 #endif
63 #include <asm/mman.h>
64 #include <asm/uaccess.h>
65 #include <linux/types.h>
66 #include <linux/agp_backend.h>
67 #include <linux/workqueue.h>
68 #include <linux/poll.h>
69 #include <asm/pgalloc.h>
70 #include <drm/drm.h>
71 #include <drm/drm_sarea.h>
72 #include <drm/drm_vma_manager.h>
73
74 #include <linux/idr.h>
75
76 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
77 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
78
79 struct module;
80
81 struct drm_file;
82 struct drm_device;
83
84 struct device_node;
85 struct videomode;
86
87 #include <drm/drm_os_linux.h>
88 #include <drm/drm_hashtab.h>
89 #include <drm/drm_mm.h>
90
91 #define DRM_UT_CORE             0x01
92 #define DRM_UT_DRIVER           0x02
93 #define DRM_UT_KMS              0x04
94 #define DRM_UT_PRIME            0x08
95 /*
96  * Three debug levels are defined.
97  * drm_core, drm_driver, drm_kms
98  * drm_core level can be used in the generic drm code. For example:
99  *      drm_ioctl, drm_mm, drm_memory
100  * The macro definition of DRM_DEBUG is used.
101  *      DRM_DEBUG(fmt, args...)
102  *      The debug info by using the DRM_DEBUG can be obtained by adding
103  *      the boot option of "drm.debug=1".
104  *
105  * drm_driver level can be used in the specific drm driver. It is used
106  * to add the debug info related with the drm driver. For example:
107  * i915_drv, i915_dma, i915_gem, radeon_drv,
108  *      The macro definition of DRM_DEBUG_DRIVER can be used.
109  *      DRM_DEBUG_DRIVER(fmt, args...)
110  *      The debug info by using the DRM_DEBUG_DRIVER can be obtained by
111  *      adding the boot option of "drm.debug=0x02"
112  *
113  * drm_kms level can be used in the KMS code related with specific drm driver.
114  * It is used to add the debug info related with KMS mode. For example:
115  * the connector/crtc ,
116  *      The macro definition of DRM_DEBUG_KMS can be used.
117  *      DRM_DEBUG_KMS(fmt, args...)
118  *      The debug info by using the DRM_DEBUG_KMS can be obtained by
119  *      adding the boot option of "drm.debug=0x04"
120  *
121  * If we add the boot option of "drm.debug=0x06", we can get the debug info by
122  * using the DRM_DEBUG_KMS and DRM_DEBUG_DRIVER.
123  * If we add the boot option of "drm.debug=0x05", we can get the debug info by
124  * using the DRM_DEBUG_KMS and DRM_DEBUG.
125  */
126
127 extern __printf(4, 5)
128 void drm_ut_debug_printk(unsigned int request_level,
129                          const char *prefix,
130                          const char *function_name,
131                          const char *format, ...);
132 extern __printf(2, 3)
133 int drm_err(const char *func, const char *format, ...);
134
135 /***********************************************************************/
136 /** \name DRM template customization defaults */
137 /*@{*/
138
139 /* driver capabilities and requirements mask */
140 #define DRIVER_USE_AGP     0x1
141 #define DRIVER_REQUIRE_AGP 0x2
142 #define DRIVER_USE_MTRR    0x4
143 #define DRIVER_PCI_DMA     0x8
144 #define DRIVER_SG          0x10
145 #define DRIVER_HAVE_DMA    0x20
146 #define DRIVER_HAVE_IRQ    0x40
147 #define DRIVER_IRQ_SHARED  0x80
148 #define DRIVER_IRQ_VBL     0x100
149 #define DRIVER_DMA_QUEUE   0x200
150 #define DRIVER_FB_DMA      0x400
151 #define DRIVER_IRQ_VBL2    0x800
152 #define DRIVER_GEM         0x1000
153 #define DRIVER_MODESET     0x2000
154 #define DRIVER_PRIME       0x4000
155
156 #define DRIVER_BUS_PCI 0x1
157 #define DRIVER_BUS_PLATFORM 0x2
158 #define DRIVER_BUS_USB 0x3
159
160 /***********************************************************************/
161 /** \name Begin the DRM... */
162 /*@{*/
163
164 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
165                                      also include looping detection. */
166
167 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
168 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
169 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
170 #define DRM_LOOPING_LIMIT     5000000
171 #define DRM_TIME_SLICE        (HZ/20)  /**< Time slice for GLXContexts */
172 #define DRM_LOCK_SLICE        1 /**< Time slice for lock, in jiffies */
173
174 #define DRM_FLAG_DEBUG    0x01
175
176 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
177 #define DRM_MAP_HASH_OFFSET 0x10000000
178
179 /*@}*/
180
181 /***********************************************************************/
182 /** \name Macros to make printk easier */
183 /*@{*/
184
185 /**
186  * Error output.
187  *
188  * \param fmt printf() like format string.
189  * \param arg arguments
190  */
191 #define DRM_ERROR(fmt, ...)                             \
192         drm_err(__func__, fmt, ##__VA_ARGS__)
193
194 #define DRM_INFO(fmt, ...)                              \
195         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
196
197 /**
198  * Debug output.
199  *
200  * \param fmt printf() like format string.
201  * \param arg arguments
202  */
203 #if DRM_DEBUG_CODE
204 #define DRM_DEBUG(fmt, args...)                                         \
205         do {                                                            \
206                 drm_ut_debug_printk(DRM_UT_CORE, DRM_NAME,              \
207                                         __func__, fmt, ##args);         \
208         } while (0)
209
210 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
211         do {                                                            \
212                 drm_ut_debug_printk(DRM_UT_DRIVER, DRM_NAME,            \
213                                         __func__, fmt, ##args);         \
214         } while (0)
215 #define DRM_DEBUG_KMS(fmt, args...)                             \
216         do {                                                            \
217                 drm_ut_debug_printk(DRM_UT_KMS, DRM_NAME,               \
218                                          __func__, fmt, ##args);        \
219         } while (0)
220 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
221         do {                                                            \
222                 drm_ut_debug_printk(DRM_UT_PRIME, DRM_NAME,             \
223                                         __func__, fmt, ##args);         \
224         } while (0)
225 #define DRM_LOG(fmt, args...)                                           \
226         do {                                                            \
227                 drm_ut_debug_printk(DRM_UT_CORE, NULL,                  \
228                                         NULL, fmt, ##args);             \
229         } while (0)
230 #define DRM_LOG_KMS(fmt, args...)                                       \
231         do {                                                            \
232                 drm_ut_debug_printk(DRM_UT_KMS, NULL,                   \
233                                         NULL, fmt, ##args);             \
234         } while (0)
235 #define DRM_LOG_MODE(fmt, args...)                                      \
236         do {                                                            \
237                 drm_ut_debug_printk(DRM_UT_MODE, NULL,                  \
238                                         NULL, fmt, ##args);             \
239         } while (0)
240 #define DRM_LOG_DRIVER(fmt, args...)                                    \
241         do {                                                            \
242                 drm_ut_debug_printk(DRM_UT_DRIVER, NULL,                \
243                                         NULL, fmt, ##args);             \
244         } while (0)
245 #else
246 #define DRM_DEBUG_DRIVER(fmt, args...) do { } while (0)
247 #define DRM_DEBUG_KMS(fmt, args...)     do { } while (0)
248 #define DRM_DEBUG_PRIME(fmt, args...)   do { } while (0)
249 #define DRM_DEBUG(fmt, arg...)           do { } while (0)
250 #define DRM_LOG(fmt, arg...)            do { } while (0)
251 #define DRM_LOG_KMS(fmt, args...) do { } while (0)
252 #define DRM_LOG_MODE(fmt, arg...) do { } while (0)
253 #define DRM_LOG_DRIVER(fmt, arg...) do { } while (0)
254
255 #endif
256
257 /*@}*/
258
259 /***********************************************************************/
260 /** \name Internal types and structures */
261 /*@{*/
262
263 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
264
265 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
266 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
267
268 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
269
270 /**
271  * Test that the hardware lock is held by the caller, returning otherwise.
272  *
273  * \param dev DRM device.
274  * \param filp file pointer of the caller.
275  */
276 #define LOCK_TEST_WITH_RETURN( dev, _file_priv )                                \
277 do {                                                                            \
278         if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||       \
279             _file_priv->master->lock.file_priv != _file_priv)   {               \
280                 DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
281                            __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
282                            _file_priv->master->lock.file_priv, _file_priv);     \
283                 return -EINVAL;                                                 \
284         }                                                                       \
285 } while (0)
286
287 /**
288  * Ioctl function type.
289  *
290  * \param inode device inode.
291  * \param file_priv DRM file private pointer.
292  * \param cmd command.
293  * \param arg argument.
294  */
295 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
296                         struct drm_file *file_priv);
297
298 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
299                                unsigned long arg);
300
301 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
302 #define DRM_MAJOR       226
303
304 #define DRM_AUTH        0x1
305 #define DRM_MASTER      0x2
306 #define DRM_ROOT_ONLY   0x4
307 #define DRM_CONTROL_ALLOW 0x8
308 #define DRM_UNLOCKED    0x10
309
310 struct drm_ioctl_desc {
311         unsigned int cmd;
312         int flags;
313         drm_ioctl_t *func;
314         unsigned int cmd_drv;
315         const char *name;
316 };
317
318 /**
319  * Creates a driver or general drm_ioctl_desc array entry for the given
320  * ioctl, for use by drm_ioctl().
321  */
322
323 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
324         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
325
326 struct drm_magic_entry {
327         struct list_head head;
328         struct drm_hash_item hash_item;
329         struct drm_file *priv;
330 };
331
332 struct drm_vma_entry {
333         struct list_head head;
334         struct vm_area_struct *vma;
335         pid_t pid;
336 };
337
338 /**
339  * DMA buffer.
340  */
341 struct drm_buf {
342         int idx;                       /**< Index into master buflist */
343         int total;                     /**< Buffer size */
344         int order;                     /**< log-base-2(total) */
345         int used;                      /**< Amount of buffer in use (for DMA) */
346         unsigned long offset;          /**< Byte offset (used internally) */
347         void *address;                 /**< Address of buffer */
348         unsigned long bus_address;     /**< Bus address of buffer */
349         struct drm_buf *next;          /**< Kernel-only: used for free list */
350         __volatile__ int waiting;      /**< On kernel DMA queue */
351         __volatile__ int pending;      /**< On hardware DMA queue */
352         struct drm_file *file_priv;    /**< Private of holding file descr */
353         int context;                   /**< Kernel queue for this buffer */
354         int while_locked;              /**< Dispatch this buffer while locked */
355         enum {
356                 DRM_LIST_NONE = 0,
357                 DRM_LIST_FREE = 1,
358                 DRM_LIST_WAIT = 2,
359                 DRM_LIST_PEND = 3,
360                 DRM_LIST_PRIO = 4,
361                 DRM_LIST_RECLAIM = 5
362         } list;                        /**< Which list we're on */
363
364         int dev_priv_size;               /**< Size of buffer private storage */
365         void *dev_private;               /**< Per-buffer private storage */
366 };
367
368 /** bufs is one longer than it has to be */
369 struct drm_waitlist {
370         int count;                      /**< Number of possible buffers */
371         struct drm_buf **bufs;          /**< List of pointers to buffers */
372         struct drm_buf **rp;                    /**< Read pointer */
373         struct drm_buf **wp;                    /**< Write pointer */
374         struct drm_buf **end;           /**< End pointer */
375         spinlock_t read_lock;
376         spinlock_t write_lock;
377 };
378
379 struct drm_freelist {
380         int initialized;               /**< Freelist in use */
381         atomic_t count;                /**< Number of free buffers */
382         struct drm_buf *next;          /**< End pointer */
383
384         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
385         int low_mark;                  /**< Low water mark */
386         int high_mark;                 /**< High water mark */
387         atomic_t wfh;                  /**< If waiting for high mark */
388         spinlock_t lock;
389 };
390
391 typedef struct drm_dma_handle {
392         dma_addr_t busaddr;
393         void *vaddr;
394         size_t size;
395 } drm_dma_handle_t;
396
397 /**
398  * Buffer entry.  There is one of this for each buffer size order.
399  */
400 struct drm_buf_entry {
401         int buf_size;                   /**< size */
402         int buf_count;                  /**< number of buffers */
403         struct drm_buf *buflist;                /**< buffer list */
404         int seg_count;
405         int page_order;
406         struct drm_dma_handle **seglist;
407
408         struct drm_freelist freelist;
409 };
410
411 /* Event queued up for userspace to read */
412 struct drm_pending_event {
413         struct drm_event *event;
414         struct list_head link;
415         struct drm_file *file_priv;
416         pid_t pid; /* pid of requester, no guarantee it's valid by the time
417                       we deliver the event, for tracing only */
418         void (*destroy)(struct drm_pending_event *event);
419 };
420
421 /* initial implementaton using a linked list - todo hashtab */
422 struct drm_prime_file_private {
423         struct list_head head;
424         struct mutex lock;
425 };
426
427 /** File private data */
428 struct drm_file {
429         int authenticated;
430         struct pid *pid;
431         kuid_t uid;
432         drm_magic_t magic;
433         unsigned long ioctl_count;
434         struct list_head lhead;
435         struct drm_minor *minor;
436         unsigned long lock_count;
437
438         /** Mapping of mm object handles to object pointers. */
439         struct idr object_idr;
440         /** Lock for synchronization of access to object_idr. */
441         spinlock_t table_lock;
442
443         struct file *filp;
444         void *driver_priv;
445
446         int is_master; /* this file private is a master for a minor */
447         struct drm_master *master; /* master this node is currently associated with
448                                       N.B. not always minor->master */
449
450         /**
451          * fbs - List of framebuffers associated with this file.
452          *
453          * Protected by fbs_lock. Note that the fbs list holds a reference on
454          * the fb object to prevent it from untimely disappearing.
455          */
456         struct list_head fbs;
457         struct mutex fbs_lock;
458
459         wait_queue_head_t event_wait;
460         struct list_head event_list;
461         int event_space;
462
463         struct drm_prime_file_private prime;
464 };
465
466 /** Wait queue */
467 struct drm_queue {
468         atomic_t use_count;             /**< Outstanding uses (+1) */
469         atomic_t finalization;          /**< Finalization in progress */
470         atomic_t block_count;           /**< Count of processes waiting */
471         atomic_t block_read;            /**< Queue blocked for reads */
472         wait_queue_head_t read_queue;   /**< Processes waiting on block_read */
473         atomic_t block_write;           /**< Queue blocked for writes */
474         wait_queue_head_t write_queue;  /**< Processes waiting on block_write */
475         atomic_t total_queued;          /**< Total queued statistic */
476         atomic_t total_flushed;         /**< Total flushes statistic */
477         atomic_t total_locks;           /**< Total locks statistics */
478         enum drm_ctx_flags flags;       /**< Context preserving and 2D-only */
479         struct drm_waitlist waitlist;   /**< Pending buffers */
480         wait_queue_head_t flush_queue;  /**< Processes waiting until flush */
481 };
482
483 /**
484  * Lock data.
485  */
486 struct drm_lock_data {
487         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
488         /** Private of lock holder's file (NULL=kernel) */
489         struct drm_file *file_priv;
490         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
491         unsigned long lock_time;        /**< Time of last lock in jiffies */
492         spinlock_t spinlock;
493         uint32_t kernel_waiters;
494         uint32_t user_waiters;
495         int idle_has_lock;
496 };
497
498 /**
499  * DMA data.
500  */
501 struct drm_device_dma {
502
503         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
504         int buf_count;                  /**< total number of buffers */
505         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
506         int seg_count;
507         int page_count;                 /**< number of pages */
508         unsigned long *pagelist;        /**< page list */
509         unsigned long byte_count;
510         enum {
511                 _DRM_DMA_USE_AGP = 0x01,
512                 _DRM_DMA_USE_SG = 0x02,
513                 _DRM_DMA_USE_FB = 0x04,
514                 _DRM_DMA_USE_PCI_RO = 0x08
515         } flags;
516
517 };
518
519 /**
520  * AGP memory entry.  Stored as a doubly linked list.
521  */
522 struct drm_agp_mem {
523         unsigned long handle;           /**< handle */
524         DRM_AGP_MEM *memory;
525         unsigned long bound;            /**< address */
526         int pages;
527         struct list_head head;
528 };
529
530 /**
531  * AGP data.
532  *
533  * \sa drm_agp_init() and drm_device::agp.
534  */
535 struct drm_agp_head {
536         DRM_AGP_KERN agp_info;          /**< AGP device information */
537         struct list_head memory;
538         unsigned long mode;             /**< AGP mode */
539         struct agp_bridge_data *bridge;
540         int enabled;                    /**< whether the AGP bus as been enabled */
541         int acquired;                   /**< whether the AGP device has been acquired */
542         unsigned long base;
543         int agp_mtrr;
544         int cant_use_aperture;
545         unsigned long page_mask;
546 };
547
548 /**
549  * Scatter-gather memory.
550  */
551 struct drm_sg_mem {
552         unsigned long handle;
553         void *virtual;
554         int pages;
555         struct page **pagelist;
556         dma_addr_t *busaddr;
557 };
558
559 struct drm_sigdata {
560         int context;
561         struct drm_hw_lock *lock;
562 };
563
564
565 /**
566  * Kernel side of a mapping
567  */
568 struct drm_local_map {
569         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
570         unsigned long size;      /**< Requested physical size (bytes) */
571         enum drm_map_type type;  /**< Type of memory to map */
572         enum drm_map_flags flags;        /**< Flags */
573         void *handle;            /**< User-space: "Handle" to pass to mmap() */
574                                  /**< Kernel-space: kernel-virtual address */
575         int mtrr;                /**< MTRR slot used */
576 };
577
578 typedef struct drm_local_map drm_local_map_t;
579
580 /**
581  * Mappings list
582  */
583 struct drm_map_list {
584         struct list_head head;          /**< list head */
585         struct drm_hash_item hash;
586         struct drm_local_map *map;      /**< mapping */
587         uint64_t user_token;
588         struct drm_master *master;
589 };
590
591 /**
592  * Context handle list
593  */
594 struct drm_ctx_list {
595         struct list_head head;          /**< list head */
596         drm_context_t handle;           /**< context handle */
597         struct drm_file *tag;           /**< associated fd private data */
598 };
599
600 /* location of GART table */
601 #define DRM_ATI_GART_MAIN 1
602 #define DRM_ATI_GART_FB   2
603
604 #define DRM_ATI_GART_PCI 1
605 #define DRM_ATI_GART_PCIE 2
606 #define DRM_ATI_GART_IGP 3
607
608 struct drm_ati_pcigart_info {
609         int gart_table_location;
610         int gart_reg_if;
611         void *addr;
612         dma_addr_t bus_addr;
613         dma_addr_t table_mask;
614         struct drm_dma_handle *table_handle;
615         struct drm_local_map mapping;
616         int table_size;
617 };
618
619 /**
620  * GEM specific mm private for tracking GEM objects
621  */
622 struct drm_gem_mm {
623         struct drm_vma_offset_manager vma_manager;
624 };
625
626 /**
627  * This structure defines the drm_mm memory object, which will be used by the
628  * DRM for its buffer objects.
629  */
630 struct drm_gem_object {
631         /** Reference count of this object */
632         struct kref refcount;
633
634         /** Handle count of this object. Each handle also holds a reference */
635         atomic_t handle_count; /* number of handles on this object */
636
637         /** Related drm device */
638         struct drm_device *dev;
639
640         /** File representing the shmem storage */
641         struct file *filp;
642
643         /* Mapping info for this object */
644         struct drm_vma_offset_node vma_node;
645
646         /**
647          * Size of the object, in bytes.  Immutable over the object's
648          * lifetime.
649          */
650         size_t size;
651
652         /**
653          * Global name for this object, starts at 1. 0 means unnamed.
654          * Access is covered by the object_name_lock in the related drm_device
655          */
656         int name;
657
658         /**
659          * Memory domains. These monitor which caches contain read/write data
660          * related to the object. When transitioning from one set of domains
661          * to another, the driver is called to ensure that caches are suitably
662          * flushed and invalidated
663          */
664         uint32_t read_domains;
665         uint32_t write_domain;
666
667         /**
668          * While validating an exec operation, the
669          * new read/write domain values are computed here.
670          * They will be transferred to the above values
671          * at the point that any cache flushing occurs
672          */
673         uint32_t pending_read_domains;
674         uint32_t pending_write_domain;
675
676         void *driver_private;
677
678         /* dma buf exported from this GEM object */
679         struct dma_buf *export_dma_buf;
680
681         /* dma buf attachment backing this object */
682         struct dma_buf_attachment *import_attach;
683 };
684
685 #include <drm/drm_crtc.h>
686
687 /* per-master structure */
688 struct drm_master {
689
690         struct kref refcount; /* refcount for this master */
691
692         struct list_head head; /**< each minor contains a list of masters */
693         struct drm_minor *minor; /**< link back to minor we are a master for */
694
695         char *unique;                   /**< Unique identifier: e.g., busid */
696         int unique_len;                 /**< Length of unique field */
697         int unique_size;                /**< amount allocated */
698
699         int blocked;                    /**< Blocked due to VC switch? */
700
701         /** \name Authentication */
702         /*@{ */
703         struct drm_open_hash magiclist;
704         struct list_head magicfree;
705         /*@} */
706
707         struct drm_lock_data lock;      /**< Information on hardware lock */
708
709         void *driver_priv; /**< Private structure for driver to use */
710 };
711
712 /* Size of ringbuffer for vblank timestamps. Just double-buffer
713  * in initial implementation.
714  */
715 #define DRM_VBLANKTIME_RBSIZE 2
716
717 /* Flags and return codes for get_vblank_timestamp() driver function. */
718 #define DRM_CALLED_FROM_VBLIRQ 1
719 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
720 #define DRM_VBLANKTIME_INVBL             (1 << 1)
721
722 /* get_scanout_position() return flags */
723 #define DRM_SCANOUTPOS_VALID        (1 << 0)
724 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
725 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
726
727 struct drm_bus {
728         int bus_type;
729         int (*get_irq)(struct drm_device *dev);
730         const char *(*get_name)(struct drm_device *dev);
731         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
732         int (*set_unique)(struct drm_device *dev, struct drm_master *master,
733                           struct drm_unique *unique);
734         int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
735         /* hooks that are for PCI */
736         int (*agp_init)(struct drm_device *dev);
737         void (*agp_destroy)(struct drm_device *dev);
738
739 };
740
741 /**
742  * DRM driver structure. This structure represent the common code for
743  * a family of cards. There will one drm_device for each card present
744  * in this family
745  */
746 struct drm_driver {
747         int (*load) (struct drm_device *, unsigned long flags);
748         int (*firstopen) (struct drm_device *);
749         int (*open) (struct drm_device *, struct drm_file *);
750         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
751         void (*postclose) (struct drm_device *, struct drm_file *);
752         void (*lastclose) (struct drm_device *);
753         int (*unload) (struct drm_device *);
754         int (*suspend) (struct drm_device *, pm_message_t state);
755         int (*resume) (struct drm_device *);
756         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
757         int (*dma_quiescent) (struct drm_device *);
758         int (*context_dtor) (struct drm_device *dev, int context);
759
760         /**
761          * get_vblank_counter - get raw hardware vblank counter
762          * @dev: DRM device
763          * @crtc: counter to fetch
764          *
765          * Driver callback for fetching a raw hardware vblank counter for @crtc.
766          * If a device doesn't have a hardware counter, the driver can simply
767          * return the value of drm_vblank_count. The DRM core will account for
768          * missed vblank events while interrupts where disabled based on system
769          * timestamps.
770          *
771          * Wraparound handling and loss of events due to modesetting is dealt
772          * with in the DRM core code.
773          *
774          * RETURNS
775          * Raw vblank counter value.
776          */
777         u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
778
779         /**
780          * enable_vblank - enable vblank interrupt events
781          * @dev: DRM device
782          * @crtc: which irq to enable
783          *
784          * Enable vblank interrupts for @crtc.  If the device doesn't have
785          * a hardware vblank counter, this routine should be a no-op, since
786          * interrupts will have to stay on to keep the count accurate.
787          *
788          * RETURNS
789          * Zero on success, appropriate errno if the given @crtc's vblank
790          * interrupt cannot be enabled.
791          */
792         int (*enable_vblank) (struct drm_device *dev, int crtc);
793
794         /**
795          * disable_vblank - disable vblank interrupt events
796          * @dev: DRM device
797          * @crtc: which irq to enable
798          *
799          * Disable vblank interrupts for @crtc.  If the device doesn't have
800          * a hardware vblank counter, this routine should be a no-op, since
801          * interrupts will have to stay on to keep the count accurate.
802          */
803         void (*disable_vblank) (struct drm_device *dev, int crtc);
804
805         /**
806          * Called by \c drm_device_is_agp.  Typically used to determine if a
807          * card is really attached to AGP or not.
808          *
809          * \param dev  DRM device handle
810          *
811          * \returns
812          * One of three values is returned depending on whether or not the
813          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
814          * (return of 1), or may or may not be AGP (return of 2).
815          */
816         int (*device_is_agp) (struct drm_device *dev);
817
818         /**
819          * Called by vblank timestamping code.
820          *
821          * Return the current display scanout position from a crtc.
822          *
823          * \param dev  DRM device.
824          * \param crtc Id of the crtc to query.
825          * \param *vpos Target location for current vertical scanout position.
826          * \param *hpos Target location for current horizontal scanout position.
827          *
828          * Returns vpos as a positive number while in active scanout area.
829          * Returns vpos as a negative number inside vblank, counting the number
830          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
831          * until start of active scanout / end of vblank."
832          *
833          * \return Flags, or'ed together as follows:
834          *
835          * DRM_SCANOUTPOS_VALID = Query successful.
836          * DRM_SCANOUTPOS_INVBL = Inside vblank.
837          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
838          * this flag means that returned position may be offset by a constant
839          * but unknown small number of scanlines wrt. real scanout position.
840          *
841          */
842         int (*get_scanout_position) (struct drm_device *dev, int crtc,
843                                      int *vpos, int *hpos);
844
845         /**
846          * Called by \c drm_get_last_vbltimestamp. Should return a precise
847          * timestamp when the most recent VBLANK interval ended or will end.
848          *
849          * Specifically, the timestamp in @vblank_time should correspond as
850          * closely as possible to the time when the first video scanline of
851          * the video frame after the end of VBLANK will start scanning out,
852          * the time immediately after end of the VBLANK interval. If the
853          * @crtc is currently inside VBLANK, this will be a time in the future.
854          * If the @crtc is currently scanning out a frame, this will be the
855          * past start time of the current scanout. This is meant to adhere
856          * to the OpenML OML_sync_control extension specification.
857          *
858          * \param dev dev DRM device handle.
859          * \param crtc crtc for which timestamp should be returned.
860          * \param *max_error Maximum allowable timestamp error in nanoseconds.
861          *                   Implementation should strive to provide timestamp
862          *                   with an error of at most *max_error nanoseconds.
863          *                   Returns true upper bound on error for timestamp.
864          * \param *vblank_time Target location for returned vblank timestamp.
865          * \param flags 0 = Defaults, no special treatment needed.
866          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
867          *              irq handler. Some drivers need to apply some workarounds
868          *              for gpu-specific vblank irq quirks if flag is set.
869          *
870          * \returns
871          * Zero if timestamping isn't supported in current display mode or a
872          * negative number on failure. A positive status code on success,
873          * which describes how the vblank_time timestamp was computed.
874          */
875         int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
876                                      int *max_error,
877                                      struct timeval *vblank_time,
878                                      unsigned flags);
879
880         /* these have to be filled in */
881
882         irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
883         void (*irq_preinstall) (struct drm_device *dev);
884         int (*irq_postinstall) (struct drm_device *dev);
885         void (*irq_uninstall) (struct drm_device *dev);
886
887         /* Master routines */
888         int (*master_create)(struct drm_device *dev, struct drm_master *master);
889         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
890         /**
891          * master_set is called whenever the minor master is set.
892          * master_drop is called whenever the minor master is dropped.
893          */
894
895         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
896                           bool from_open);
897         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
898                             bool from_release);
899
900         int (*debugfs_init)(struct drm_minor *minor);
901         void (*debugfs_cleanup)(struct drm_minor *minor);
902
903         /**
904          * Driver-specific constructor for drm_gem_objects, to set up
905          * obj->driver_private.
906          *
907          * Returns 0 on success.
908          */
909         int (*gem_init_object) (struct drm_gem_object *obj);
910         void (*gem_free_object) (struct drm_gem_object *obj);
911         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
912         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
913
914         /* prime: */
915         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
916         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
917                                 uint32_t handle, uint32_t flags, int *prime_fd);
918         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
919         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
920                                 int prime_fd, uint32_t *handle);
921         /* export GEM -> dmabuf */
922         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
923                                 struct drm_gem_object *obj, int flags);
924         /* import dmabuf -> GEM */
925         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
926                                 struct dma_buf *dma_buf);
927         /* low-level interface used by drm_gem_prime_{import,export} */
928         int (*gem_prime_pin)(struct drm_gem_object *obj);
929         void (*gem_prime_unpin)(struct drm_gem_object *obj);
930         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
931         struct drm_gem_object *(*gem_prime_import_sg_table)(
932                                 struct drm_device *dev, size_t size,
933                                 struct sg_table *sgt);
934         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
935         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
936         int (*gem_prime_mmap)(struct drm_gem_object *obj,
937                                 struct vm_area_struct *vma);
938
939         /* vga arb irq handler */
940         void (*vgaarb_irq)(struct drm_device *dev, bool state);
941
942         /* dumb alloc support */
943         int (*dumb_create)(struct drm_file *file_priv,
944                            struct drm_device *dev,
945                            struct drm_mode_create_dumb *args);
946         int (*dumb_map_offset)(struct drm_file *file_priv,
947                                struct drm_device *dev, uint32_t handle,
948                                uint64_t *offset);
949         int (*dumb_destroy)(struct drm_file *file_priv,
950                             struct drm_device *dev,
951                             uint32_t handle);
952
953         /* Driver private ops for this object */
954         const struct vm_operations_struct *gem_vm_ops;
955
956         int major;
957         int minor;
958         int patchlevel;
959         char *name;
960         char *desc;
961         char *date;
962
963         u32 driver_features;
964         int dev_priv_size;
965         const struct drm_ioctl_desc *ioctls;
966         int num_ioctls;
967         const struct file_operations *fops;
968         union {
969                 struct pci_driver *pci;
970                 struct platform_device *platform_device;
971                 struct usb_driver *usb;
972         } kdriver;
973         struct drm_bus *bus;
974
975         /* List of devices hanging off this driver */
976         struct list_head device_list;
977 };
978
979 #define DRM_MINOR_UNASSIGNED 0
980 #define DRM_MINOR_LEGACY 1
981 #define DRM_MINOR_CONTROL 2
982 #define DRM_MINOR_RENDER 3
983
984
985 /**
986  * debugfs node list. This structure represents a debugfs file to
987  * be created by the drm core
988  */
989 struct drm_debugfs_list {
990         const char *name; /** file name */
991         int (*show)(struct seq_file*, void*); /** show callback */
992         u32 driver_features; /**< Required driver features for this entry */
993 };
994
995 /**
996  * debugfs node structure. This structure represents a debugfs file.
997  */
998 struct drm_debugfs_node {
999         struct list_head list;
1000         struct drm_minor *minor;
1001         struct drm_debugfs_list *debugfs_ent;
1002         struct dentry *dent;
1003 };
1004
1005 /**
1006  * Info file list entry. This structure represents a debugfs or proc file to
1007  * be created by the drm core
1008  */
1009 struct drm_info_list {
1010         const char *name; /** file name */
1011         int (*show)(struct seq_file*, void*); /** show callback */
1012         u32 driver_features; /**< Required driver features for this entry */
1013         void *data;
1014 };
1015
1016 /**
1017  * debugfs node structure. This structure represents a debugfs file.
1018  */
1019 struct drm_info_node {
1020         struct list_head list;
1021         struct drm_minor *minor;
1022         const struct drm_info_list *info_ent;
1023         struct dentry *dent;
1024 };
1025
1026 /**
1027  * DRM minor structure. This structure represents a drm minor number.
1028  */
1029 struct drm_minor {
1030         int index;                      /**< Minor device number */
1031         int type;                       /**< Control or render */
1032         dev_t device;                   /**< Device number for mknod */
1033         struct device kdev;             /**< Linux device */
1034         struct drm_device *dev;
1035
1036         struct proc_dir_entry *proc_root;  /**< proc directory entry */
1037         struct drm_info_node proc_nodes;
1038         struct dentry *debugfs_root;
1039
1040         struct list_head debugfs_list;
1041         struct mutex debugfs_lock; /* Protects debugfs_list. */
1042
1043         struct drm_master *master; /* currently active master for this node */
1044         struct list_head master_list;
1045         struct drm_mode_group mode_group;
1046 };
1047
1048 /* mode specified on the command line */
1049 struct drm_cmdline_mode {
1050         bool specified;
1051         bool refresh_specified;
1052         bool bpp_specified;
1053         int xres, yres;
1054         int bpp;
1055         int refresh;
1056         bool rb;
1057         bool interlace;
1058         bool cvt;
1059         bool margins;
1060         enum drm_connector_force force;
1061 };
1062
1063
1064 struct drm_pending_vblank_event {
1065         struct drm_pending_event base;
1066         int pipe;
1067         struct drm_event_vblank event;
1068 };
1069
1070 /**
1071  * DRM device structure. This structure represent a complete card that
1072  * may contain multiple heads.
1073  */
1074 struct drm_device {
1075         struct list_head driver_item;   /**< list of devices per driver */
1076         char *devname;                  /**< For /proc/interrupts */
1077         int if_version;                 /**< Highest interface version set */
1078
1079         /** \name Locks */
1080         /*@{ */
1081         spinlock_t count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
1082         struct mutex struct_mutex;      /**< For others */
1083         /*@} */
1084
1085         /** \name Usage Counters */
1086         /*@{ */
1087         int open_count;                 /**< Outstanding files open */
1088         atomic_t ioctl_count;           /**< Outstanding IOCTLs pending */
1089         atomic_t vma_count;             /**< Outstanding vma areas open */
1090         int buf_use;                    /**< Buffers in use -- cannot alloc */
1091         atomic_t buf_alloc;             /**< Buffer allocation in progress */
1092         /*@} */
1093
1094         /** \name Performance counters */
1095         /*@{ */
1096         unsigned long counters;
1097         enum drm_stat_type types[15];
1098         atomic_t counts[15];
1099         /*@} */
1100
1101         struct list_head filelist;
1102
1103         /** \name Memory management */
1104         /*@{ */
1105         struct list_head maplist;       /**< Linked list of regions */
1106         int map_count;                  /**< Number of mappable regions */
1107         struct drm_open_hash map_hash;  /**< User token hash table for maps */
1108
1109         /** \name Context handle management */
1110         /*@{ */
1111         struct list_head ctxlist;       /**< Linked list of context handles */
1112         int ctx_count;                  /**< Number of context handles */
1113         struct mutex ctxlist_mutex;     /**< For ctxlist */
1114
1115         struct idr ctx_idr;
1116
1117         struct list_head vmalist;       /**< List of vmas (for debugging) */
1118
1119         /*@} */
1120
1121         /** \name DMA support */
1122         /*@{ */
1123         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
1124         /*@} */
1125
1126         /** \name Context support */
1127         /*@{ */
1128         int irq_enabled;                /**< True if irq handler is enabled */
1129         __volatile__ long context_flag; /**< Context swapping flag */
1130         int last_context;               /**< Last current context */
1131         /*@} */
1132
1133         struct work_struct work;
1134         /** \name VBLANK IRQ support */
1135         /*@{ */
1136
1137         /*
1138          * At load time, disabling the vblank interrupt won't be allowed since
1139          * old clients may not call the modeset ioctl and therefore misbehave.
1140          * Once the modeset ioctl *has* been called though, we can safely
1141          * disable them when unused.
1142          */
1143         int vblank_disable_allowed;
1144
1145         wait_queue_head_t *vbl_queue;   /**< VBLANK wait queue */
1146         atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1147         struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1148         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1149         spinlock_t vbl_lock;
1150         atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1151         u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1152                                         /* for wraparound handling */
1153         int *vblank_enabled;            /* so we don't call enable more than
1154                                            once per disable */
1155         int *vblank_inmodeset;          /* Display driver is setting mode */
1156         u32 *last_vblank_wait;          /* Last vblank seqno waited per CRTC */
1157         struct timer_list vblank_disable_timer;
1158
1159         u32 max_vblank_count;           /**< size of vblank counter register */
1160
1161         /**
1162          * List of events
1163          */
1164         struct list_head vblank_event_list;
1165         spinlock_t event_lock;
1166
1167         /*@} */
1168
1169         struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
1170
1171         struct drm_agp_head *agp;       /**< AGP data */
1172
1173         struct device *dev;             /**< Device structure */
1174         struct pci_dev *pdev;           /**< PCI device structure */
1175         int pci_vendor;                 /**< PCI vendor id */
1176         int pci_device;                 /**< PCI device id */
1177 #ifdef __alpha__
1178         struct pci_controller *hose;
1179 #endif
1180
1181         struct platform_device *platformdev; /**< Platform device struture */
1182         struct usb_device *usbdev;
1183
1184         struct drm_sg_mem *sg;  /**< Scatter gather memory */
1185         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1186         void *dev_private;              /**< device private data */
1187         void *mm_private;
1188         struct address_space *dev_mapping;
1189         struct drm_sigdata sigdata;        /**< For block_all_signals */
1190         sigset_t sigmask;
1191
1192         struct drm_driver *driver;
1193         struct drm_local_map *agp_buffer_map;
1194         unsigned int agp_buffer_token;
1195         struct drm_minor *control;              /**< Control node for card */
1196         struct drm_minor *primary;              /**< render type primary screen head */
1197
1198         struct drm_mode_config mode_config;     /**< Current mode config */
1199
1200         /** \name GEM information */
1201         /*@{ */
1202         spinlock_t object_name_lock;
1203         struct idr object_name_idr;
1204         /*@} */
1205         int switch_power_state;
1206
1207         atomic_t unplugged; /* device has been unplugged or gone away */
1208 };
1209
1210 #define DRM_SWITCH_POWER_ON 0
1211 #define DRM_SWITCH_POWER_OFF 1
1212 #define DRM_SWITCH_POWER_CHANGING 2
1213
1214 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1215                                              int feature)
1216 {
1217         return ((dev->driver->driver_features & feature) ? 1 : 0);
1218 }
1219
1220 static inline int drm_dev_to_irq(struct drm_device *dev)
1221 {
1222         return dev->driver->bus->get_irq(dev);
1223 }
1224
1225 #if __OS_HAS_MTRR
1226 static inline int drm_core_has_MTRR(struct drm_device *dev)
1227 {
1228         return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1229 }
1230 #else
1231 #define drm_core_has_MTRR(dev) (0)
1232 #endif
1233
1234 static inline void drm_device_set_unplugged(struct drm_device *dev)
1235 {
1236         smp_wmb();
1237         atomic_set(&dev->unplugged, 1);
1238 }
1239
1240 static inline int drm_device_is_unplugged(struct drm_device *dev)
1241 {
1242         int ret = atomic_read(&dev->unplugged);
1243         smp_rmb();
1244         return ret;
1245 }
1246
1247 static inline bool drm_modeset_is_locked(struct drm_device *dev)
1248 {
1249         return mutex_is_locked(&dev->mode_config.mutex);
1250 }
1251
1252 /******************************************************************/
1253 /** \name Internal function definitions */
1254 /*@{*/
1255
1256                                 /* Driver support (drm_drv.h) */
1257 extern long drm_ioctl(struct file *filp,
1258                       unsigned int cmd, unsigned long arg);
1259 extern long drm_compat_ioctl(struct file *filp,
1260                              unsigned int cmd, unsigned long arg);
1261 extern int drm_lastclose(struct drm_device *dev);
1262
1263                                 /* Device support (drm_fops.h) */
1264 extern struct mutex drm_global_mutex;
1265 extern int drm_open(struct inode *inode, struct file *filp);
1266 extern int drm_stub_open(struct inode *inode, struct file *filp);
1267 extern int drm_fasync(int fd, struct file *filp, int on);
1268 extern ssize_t drm_read(struct file *filp, char __user *buffer,
1269                         size_t count, loff_t *offset);
1270 extern int drm_release(struct inode *inode, struct file *filp);
1271
1272                                 /* Mapping support (drm_vm.h) */
1273 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
1274 extern int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma);
1275 extern void drm_vm_open_locked(struct drm_device *dev, struct vm_area_struct *vma);
1276 extern void drm_vm_close_locked(struct drm_device *dev, struct vm_area_struct *vma);
1277 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
1278
1279                                 /* Memory management support (drm_memory.h) */
1280 #include <drm/drm_memory.h>
1281
1282                                 /* Misc. IOCTL support (drm_ioctl.h) */
1283 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1284                             struct drm_file *file_priv);
1285 extern int drm_getunique(struct drm_device *dev, void *data,
1286                          struct drm_file *file_priv);
1287 extern int drm_setunique(struct drm_device *dev, void *data,
1288                          struct drm_file *file_priv);
1289 extern int drm_getmap(struct drm_device *dev, void *data,
1290                       struct drm_file *file_priv);
1291 extern int drm_getclient(struct drm_device *dev, void *data,
1292                          struct drm_file *file_priv);
1293 extern int drm_getstats(struct drm_device *dev, void *data,
1294                         struct drm_file *file_priv);
1295 extern int drm_getcap(struct drm_device *dev, void *data,
1296                       struct drm_file *file_priv);
1297 extern int drm_setversion(struct drm_device *dev, void *data,
1298                           struct drm_file *file_priv);
1299 extern int drm_noop(struct drm_device *dev, void *data,
1300                     struct drm_file *file_priv);
1301
1302                                 /* Context IOCTL support (drm_context.h) */
1303 extern int drm_resctx(struct drm_device *dev, void *data,
1304                       struct drm_file *file_priv);
1305 extern int drm_addctx(struct drm_device *dev, void *data,
1306                       struct drm_file *file_priv);
1307 extern int drm_getctx(struct drm_device *dev, void *data,
1308                       struct drm_file *file_priv);
1309 extern int drm_switchctx(struct drm_device *dev, void *data,
1310                          struct drm_file *file_priv);
1311 extern int drm_newctx(struct drm_device *dev, void *data,
1312                       struct drm_file *file_priv);
1313 extern int drm_rmctx(struct drm_device *dev, void *data,
1314                      struct drm_file *file_priv);
1315
1316 extern void drm_legacy_ctxbitmap_init(struct drm_device *dev);
1317 extern void drm_legacy_ctxbitmap_cleanup(struct drm_device *dev);
1318 extern void drm_legacy_ctxbitmap_release(struct drm_device *dev,
1319                                          struct drm_file *file_priv);
1320
1321 extern int drm_setsareactx(struct drm_device *dev, void *data,
1322                            struct drm_file *file_priv);
1323 extern int drm_getsareactx(struct drm_device *dev, void *data,
1324                            struct drm_file *file_priv);
1325
1326                                 /* Authentication IOCTL support (drm_auth.h) */
1327 extern int drm_getmagic(struct drm_device *dev, void *data,
1328                         struct drm_file *file_priv);
1329 extern int drm_authmagic(struct drm_device *dev, void *data,
1330                          struct drm_file *file_priv);
1331 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1332
1333 /* Cache management (drm_cache.c) */
1334 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1335 void drm_clflush_sg(struct sg_table *st);
1336 void drm_clflush_virt_range(char *addr, unsigned long length);
1337
1338                                 /* Locking IOCTL support (drm_lock.h) */
1339 extern int drm_lock(struct drm_device *dev, void *data,
1340                     struct drm_file *file_priv);
1341 extern int drm_unlock(struct drm_device *dev, void *data,
1342                       struct drm_file *file_priv);
1343 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1344 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1345 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1346
1347 /*
1348  * These are exported to drivers so that they can implement fencing using
1349  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1350  */
1351
1352 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1353
1354                                 /* Buffer management support (drm_bufs.h) */
1355 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1356 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1357 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1358                       unsigned int size, enum drm_map_type type,
1359                       enum drm_map_flags flags, struct drm_local_map **map_ptr);
1360 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1361                             struct drm_file *file_priv);
1362 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1363 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1364 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1365                            struct drm_file *file_priv);
1366 extern int drm_addbufs(struct drm_device *dev, void *data,
1367                        struct drm_file *file_priv);
1368 extern int drm_infobufs(struct drm_device *dev, void *data,
1369                         struct drm_file *file_priv);
1370 extern int drm_markbufs(struct drm_device *dev, void *data,
1371                         struct drm_file *file_priv);
1372 extern int drm_freebufs(struct drm_device *dev, void *data,
1373                         struct drm_file *file_priv);
1374 extern int drm_mapbufs(struct drm_device *dev, void *data,
1375                        struct drm_file *file_priv);
1376
1377                                 /* DMA support (drm_dma.h) */
1378 extern int drm_legacy_dma_setup(struct drm_device *dev);
1379 extern void drm_legacy_dma_takedown(struct drm_device *dev);
1380 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1381 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1382                                      struct drm_file *filp);
1383
1384                                 /* IRQ support (drm_irq.h) */
1385 extern int drm_control(struct drm_device *dev, void *data,
1386                        struct drm_file *file_priv);
1387 extern int drm_irq_install(struct drm_device *dev);
1388 extern int drm_irq_uninstall(struct drm_device *dev);
1389
1390 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1391 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1392                            struct drm_file *filp);
1393 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1394 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1395 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1396                                      struct timeval *vblanktime);
1397 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1398                                      struct drm_pending_vblank_event *e);
1399 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1400 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1401 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1402 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1403 extern void drm_vblank_cleanup(struct drm_device *dev);
1404 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1405                                      struct timeval *tvblank, unsigned flags);
1406 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1407                                                  int crtc, int *max_error,
1408                                                  struct timeval *vblank_time,
1409                                                  unsigned flags,
1410                                                  struct drm_crtc *refcrtc);
1411 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1412
1413 extern bool
1414 drm_mode_parse_command_line_for_connector(const char *mode_option,
1415                                           struct drm_connector *connector,
1416                                           struct drm_cmdline_mode *mode);
1417
1418 extern struct drm_display_mode *
1419 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1420                                   struct drm_cmdline_mode *cmd);
1421
1422 extern int drm_display_mode_from_videomode(const struct videomode *vm,
1423                                            struct drm_display_mode *dmode);
1424 extern int of_get_drm_display_mode(struct device_node *np,
1425                                    struct drm_display_mode *dmode,
1426                                    int index);
1427
1428 /* Modesetting support */
1429 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1430 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1431 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1432                            struct drm_file *file_priv);
1433
1434                                 /* AGP/GART support (drm_agpsupport.h) */
1435
1436 #include <drm/drm_agpsupport.h>
1437
1438                                 /* Stub support (drm_stub.h) */
1439 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1440                                struct drm_file *file_priv);
1441 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1442                                 struct drm_file *file_priv);
1443 struct drm_master *drm_master_create(struct drm_minor *minor);
1444 extern struct drm_master *drm_master_get(struct drm_master *master);
1445 extern void drm_master_put(struct drm_master **master);
1446
1447 extern void drm_put_dev(struct drm_device *dev);
1448 extern int drm_put_minor(struct drm_minor **minor);
1449 extern void drm_unplug_dev(struct drm_device *dev);
1450 extern unsigned int drm_debug;
1451
1452 extern unsigned int drm_vblank_offdelay;
1453 extern unsigned int drm_timestamp_precision;
1454 extern unsigned int drm_timestamp_monotonic;
1455
1456 extern struct class *drm_class;
1457 extern struct proc_dir_entry *drm_proc_root;
1458 extern struct dentry *drm_debugfs_root;
1459
1460 extern struct idr drm_minors_idr;
1461
1462 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1463
1464                                 /* Proc support (drm_proc.h) */
1465 extern int drm_proc_init(struct drm_minor *minor, struct proc_dir_entry *root);
1466 extern int drm_proc_cleanup(struct drm_minor *minor, struct proc_dir_entry *root);
1467
1468                                 /* Debugfs support */
1469 #if defined(CONFIG_DEBUG_FS)
1470 extern int drm_debugfs_init(struct drm_minor *minor, int minor_id,
1471                             struct dentry *root);
1472 extern int drm_debugfs_create_files(struct drm_info_list *files, int count,
1473                                     struct dentry *root, struct drm_minor *minor);
1474 extern int drm_debugfs_remove_files(struct drm_info_list *files, int count,
1475                                     struct drm_minor *minor);
1476 extern int drm_debugfs_cleanup(struct drm_minor *minor);
1477 #endif
1478
1479                                 /* Info file support */
1480 extern int drm_name_info(struct seq_file *m, void *data);
1481 extern int drm_vm_info(struct seq_file *m, void *data);
1482 extern int drm_bufs_info(struct seq_file *m, void *data);
1483 extern int drm_vblank_info(struct seq_file *m, void *data);
1484 extern int drm_clients_info(struct seq_file *m, void* data);
1485 extern int drm_gem_name_info(struct seq_file *m, void *data);
1486
1487
1488 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1489                 struct drm_gem_object *obj, int flags);
1490 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1491                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1492                 int *prime_fd);
1493 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1494                 struct dma_buf *dma_buf);
1495 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1496                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1497
1498 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1499                                         struct drm_file *file_priv);
1500 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1501                                         struct drm_file *file_priv);
1502
1503 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1504                                             dma_addr_t *addrs, int max_pages);
1505 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages);
1506 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1507
1508 int drm_gem_dumb_destroy(struct drm_file *file,
1509                          struct drm_device *dev,
1510                          uint32_t handle);
1511
1512 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1513 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1514 int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1515 void drm_prime_remove_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1516
1517 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1518 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1519                          struct drm_gem_object **obj);
1520
1521 #if DRM_DEBUG_CODE
1522 extern int drm_vma_info(struct seq_file *m, void *data);
1523 #endif
1524
1525                                 /* Scatter Gather Support (drm_scatter.h) */
1526 extern void drm_legacy_sg_cleanup(struct drm_device *dev);
1527 extern int drm_sg_alloc(struct drm_device *dev, void *data,
1528                         struct drm_file *file_priv);
1529 extern int drm_sg_free(struct drm_device *dev, void *data,
1530                        struct drm_file *file_priv);
1531
1532                                /* ATI PCIGART support (ati_pcigart.h) */
1533 extern int drm_ati_pcigart_init(struct drm_device *dev,
1534                                 struct drm_ati_pcigart_info * gart_info);
1535 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1536                                    struct drm_ati_pcigart_info * gart_info);
1537
1538 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1539                                        size_t align);
1540 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1541 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1542
1543                                /* sysfs support (drm_sysfs.c) */
1544 struct drm_sysfs_class;
1545 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1546 extern void drm_sysfs_destroy(void);
1547 extern int drm_sysfs_device_add(struct drm_minor *minor);
1548 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1549 extern void drm_sysfs_device_remove(struct drm_minor *minor);
1550 extern int drm_sysfs_connector_add(struct drm_connector *connector);
1551 extern void drm_sysfs_connector_remove(struct drm_connector *connector);
1552
1553 /* Graphics Execution Manager library functions (drm_gem.c) */
1554 int drm_gem_init(struct drm_device *dev);
1555 void drm_gem_destroy(struct drm_device *dev);
1556 void drm_gem_object_release(struct drm_gem_object *obj);
1557 void drm_gem_object_free(struct kref *kref);
1558 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1559                                             size_t size);
1560 int drm_gem_object_init(struct drm_device *dev,
1561                         struct drm_gem_object *obj, size_t size);
1562 void drm_gem_private_object_init(struct drm_device *dev,
1563                                  struct drm_gem_object *obj, size_t size);
1564 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1565 void drm_gem_vm_open(struct vm_area_struct *vma);
1566 void drm_gem_vm_close(struct vm_area_struct *vma);
1567 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
1568                      struct vm_area_struct *vma);
1569 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
1570
1571 #include <drm/drm_global.h>
1572
1573 static inline void
1574 drm_gem_object_reference(struct drm_gem_object *obj)
1575 {
1576         kref_get(&obj->refcount);
1577 }
1578
1579 static inline void
1580 drm_gem_object_unreference(struct drm_gem_object *obj)
1581 {
1582         if (obj != NULL)
1583                 kref_put(&obj->refcount, drm_gem_object_free);
1584 }
1585
1586 static inline void
1587 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1588 {
1589         if (obj && !atomic_add_unless(&obj->refcount.refcount, -1, 1)) {
1590                 struct drm_device *dev = obj->dev;
1591
1592                 mutex_lock(&dev->struct_mutex);
1593                 if (likely(atomic_dec_and_test(&obj->refcount.refcount)))
1594                         drm_gem_object_free(&obj->refcount);
1595                 mutex_unlock(&dev->struct_mutex);
1596         }
1597 }
1598
1599 int drm_gem_handle_create(struct drm_file *file_priv,
1600                           struct drm_gem_object *obj,
1601                           u32 *handlep);
1602 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1603
1604 static inline void
1605 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1606 {
1607         drm_gem_object_reference(obj);
1608         atomic_inc(&obj->handle_count);
1609 }
1610
1611 static inline void
1612 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1613 {
1614         if (obj == NULL)
1615                 return;
1616
1617         if (atomic_read(&obj->handle_count) == 0)
1618                 return;
1619
1620         /*
1621         * Must bump handle count first as this may be the last
1622         * ref, in which case the object would disappear before we
1623         * checked for a name
1624         */
1625
1626         if (atomic_dec_and_test(&obj->handle_count))
1627                 drm_gem_object_handle_free(obj);
1628         drm_gem_object_unreference_unlocked(obj);
1629 }
1630
1631 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1632 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1633
1634 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1635                                              struct drm_file *filp,
1636                                              u32 handle);
1637 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1638                         struct drm_file *file_priv);
1639 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1640                         struct drm_file *file_priv);
1641 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1642                        struct drm_file *file_priv);
1643 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1644 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1645
1646 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1647 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1648 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1649
1650 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1651                                                          unsigned int token)
1652 {
1653         struct drm_map_list *_entry;
1654         list_for_each_entry(_entry, &dev->maplist, head)
1655             if (_entry->user_token == token)
1656                 return _entry->map;
1657         return NULL;
1658 }
1659
1660 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1661 {
1662 }
1663
1664 #include <drm/drm_mem_util.h>
1665
1666 extern int drm_fill_in_dev(struct drm_device *dev,
1667                            const struct pci_device_id *ent,
1668                            struct drm_driver *driver);
1669 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1670 /*@}*/
1671
1672 /* PCI section */
1673 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1674 {
1675         if (dev->driver->device_is_agp != NULL) {
1676                 int err = (*dev->driver->device_is_agp) (dev);
1677
1678                 if (err != 2) {
1679                         return err;
1680                 }
1681         }
1682
1683         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1684 }
1685
1686 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1687 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1688 extern int drm_get_pci_dev(struct pci_dev *pdev,
1689                            const struct pci_device_id *ent,
1690                            struct drm_driver *driver);
1691
1692 #define DRM_PCIE_SPEED_25 1
1693 #define DRM_PCIE_SPEED_50 2
1694 #define DRM_PCIE_SPEED_80 4
1695
1696 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1697
1698 /* platform section */
1699 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1700 extern void drm_platform_exit(struct drm_driver *driver, struct platform_device *platform_device);
1701
1702 extern int drm_get_platform_dev(struct platform_device *pdev,
1703                                 struct drm_driver *driver);
1704
1705 /* returns true if currently okay to sleep */
1706 static __inline__ bool drm_can_sleep(void)
1707 {
1708         if (in_atomic() || in_dbg_master() || irqs_disabled())
1709                 return false;
1710         return true;
1711 }
1712
1713 #endif                          /* __KERNEL__ */
1714 #endif