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