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