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