patch-2_6_7-vs1_9_1_12
[linux-2.6.git] / drivers / char / drm / radeon.h
1 /* radeon.h -- ATI Radeon DRM template customization -*- linux-c -*-
2  * Created: Wed Feb 14 17:07:34 2001 by gareth@valinux.com
3  *
4  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
5  * All Rights Reserved.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation
10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11  * and/or sell copies of the Software, and to permit persons to whom the
12  * Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the next
15  * paragraph) shall be included in all copies or substantial portions of the
16  * Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
21  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24  * OTHER DEALINGS IN THE SOFTWARE.
25  *
26  * Authors:
27  *    Gareth Hughes <gareth@valinux.com>
28  *    Keith Whitwell <keith@tungstengraphics.com>
29  */
30
31 #ifndef __RADEON_H__
32 #define __RADEON_H__
33
34 /* This remains constant for all DRM template files.
35  */
36 #define DRM(x) radeon_##x
37
38 /* General customization:
39  */
40 #define __HAVE_AGP              1
41 #define __MUST_HAVE_AGP         0
42 #define __HAVE_MTRR             1
43 #define __HAVE_CTX_BITMAP       1
44 #define __HAVE_SG               1
45 #define __HAVE_PCI_DMA          1
46
47 #define DRIVER_AUTHOR           "Gareth Hughes, Keith Whitwell, others."
48
49 #define DRIVER_NAME             "radeon"
50 #define DRIVER_DESC             "ATI Radeon"
51 #define DRIVER_DATE             "20020828"
52
53 #define DRIVER_MAJOR            1
54 #define DRIVER_MINOR            11
55 #define DRIVER_PATCHLEVEL       0
56
57 /* Interface history:
58  *
59  * 1.1 - ??
60  * 1.2 - Add vertex2 ioctl (keith)
61  *     - Add stencil capability to clear ioctl (gareth, keith)
62  *     - Increase MAX_TEXTURE_LEVELS (brian)
63  * 1.3 - Add cmdbuf ioctl (keith)
64  *     - Add support for new radeon packets (keith)
65  *     - Add getparam ioctl (keith)
66  *     - Add flip-buffers ioctl, deprecate fullscreen foo (keith).
67  * 1.4 - Add scratch registers to get_param ioctl.
68  * 1.5 - Add r200 packets to cmdbuf ioctl
69  *     - Add r200 function to init ioctl
70  *     - Add 'scalar2' instruction to cmdbuf
71  * 1.6 - Add static GART memory manager
72  *       Add irq handler (won't be turned on unless X server knows to)
73  *       Add irq ioctls and irq_active getparam.
74  *       Add wait command for cmdbuf ioctl
75  *       Add GART offset query for getparam
76  * 1.7 - Add support for cube map registers: R200_PP_CUBIC_FACES_[0..5]
77  *       and R200_PP_CUBIC_OFFSET_F1_[0..5].
78  *       Added packets R200_EMIT_PP_CUBIC_FACES_[0..5] and
79  *       R200_EMIT_PP_CUBIC_OFFSETS_[0..5].  (brian)
80  * 1.8 - Remove need to call cleanup ioctls on last client exit (keith)
81  *       Add 'GET' queries for starting additional clients on different VT's.
82  * 1.9 - Add DRM_IOCTL_RADEON_CP_RESUME ioctl.
83  *       Add texture rectangle support for r100.
84  * 1.10- Add SETPARAM ioctl; first parameter to set is FB_LOCATION, which
85  *       clients use to tell the DRM where they think the framebuffer is 
86  *       located in the card's address space
87  * 1.11- Add packet R200_EMIT_RB3D_BLENDCOLOR to support GL_EXT_blend_color
88  *       and GL_EXT_blend_[func|equation]_separate on r200
89  */
90 #define DRIVER_IOCTLS                                                        \
91  [DRM_IOCTL_NR(DRM_IOCTL_DMA)]               = { radeon_cp_buffers,  1, 0 }, \
92  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_INIT)]    = { radeon_cp_init,     1, 1 }, \
93  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_START)]   = { radeon_cp_start,    1, 1 }, \
94  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_STOP)]    = { radeon_cp_stop,     1, 1 }, \
95  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_RESET)]   = { radeon_cp_reset,    1, 1 }, \
96  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_IDLE)]    = { radeon_cp_idle,     1, 0 }, \
97  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CP_RESUME)]  = { radeon_cp_resume,   1, 0 }, \
98  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_RESET)]    = { radeon_engine_reset,  1, 0 }, \
99  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_FULLSCREEN)] = { radeon_fullscreen,  1, 0 }, \
100  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_SWAP)]       = { radeon_cp_swap,     1, 0 }, \
101  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CLEAR)]      = { radeon_cp_clear,    1, 0 }, \
102  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_VERTEX)]     = { radeon_cp_vertex,   1, 0 }, \
103  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_INDICES)]    = { radeon_cp_indices,  1, 0 }, \
104  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_TEXTURE)]    = { radeon_cp_texture,  1, 0 }, \
105  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_STIPPLE)]    = { radeon_cp_stipple,  1, 0 }, \
106  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_INDIRECT)]   = { radeon_cp_indirect, 1, 1 }, \
107  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_VERTEX2)]    = { radeon_cp_vertex2,  1, 0 }, \
108  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_CMDBUF)]     = { radeon_cp_cmdbuf,   1, 0 }, \
109  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_GETPARAM)]   = { radeon_cp_getparam, 1, 0 }, \
110  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_FLIP)]       = { radeon_cp_flip,     1, 0 }, \
111  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_ALLOC)]      = { radeon_mem_alloc,   1, 0 }, \
112  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_FREE)]       = { radeon_mem_free,    1, 0 }, \
113  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_INIT_HEAP)]  = { radeon_mem_init_heap, 1, 1 }, \
114  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_IRQ_EMIT)]   = { radeon_irq_emit,    1, 0 }, \
115  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_IRQ_WAIT)]   = { radeon_irq_wait,    1, 0 }, \
116  [DRM_IOCTL_NR(DRM_IOCTL_RADEON_SETPARAM)]   = { radeon_cp_setparam, 1, 0 }, \
117
118 #define DRIVER_FILE_FIELDS                                              \
119         int64_t radeon_fb_delta;                                        \
120
121 #define DRIVER_OPEN_HELPER( filp_priv, dev )                            \
122 do {                                                                    \
123         drm_radeon_private_t *dev_priv = dev->dev_private;              \
124         if ( dev_priv )                                                 \
125                 filp_priv->radeon_fb_delta = dev_priv->fb_location;     \
126         else                                                            \
127                 filp_priv->radeon_fb_delta = 0;                         \
128 } while( 0 )
129
130 /* When a client dies:
131  *    - Check for and clean up flipped page state
132  *    - Free any alloced GART memory.
133  *
134  * DRM infrastructure takes care of reclaiming dma buffers.
135  */
136 #define DRIVER_PRERELEASE()                                             \
137 do {                                                                    \
138         if ( dev->dev_private ) {                                       \
139                 drm_radeon_private_t *dev_priv = dev->dev_private;      \
140                 if ( dev_priv->page_flipping ) {                        \
141                         radeon_do_cleanup_pageflip( dev );              \
142                 }                                                       \
143                 radeon_mem_release( filp, dev_priv->gart_heap );        \
144                 radeon_mem_release( filp, dev_priv->fb_heap );          \
145         }                                                               \
146 } while (0)
147
148 /* When the last client dies, shut down the CP and free dev->dev_priv.
149  */
150 /* #define __HAVE_RELEASE 1 */
151 #define DRIVER_PRETAKEDOWN()                    \
152 do {                                            \
153     radeon_do_release( dev );                   \
154 } while (0)
155
156
157
158 /* DMA customization:
159  */
160 #define __HAVE_DMA              1
161 #define __HAVE_IRQ              1
162 #define __HAVE_VBL_IRQ          1
163 #define __HAVE_SHARED_IRQ       1
164
165
166 /* Buffer customization:
167  */
168 #define DRIVER_BUF_PRIV_T       drm_radeon_buf_priv_t
169
170 #define DRIVER_AGP_BUFFERS_MAP( dev )                           \
171         ((drm_radeon_private_t *)((dev)->dev_private))->buffers
172
173 #endif