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