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