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