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