Simplify the AGP backend interface somewhat.
[profile/ivi/libdrm.git] / shared-core / i915_drv.h
1 /* i915_drv.h -- Private header for the I915 driver -*- linux-c -*-
2  */
3 /*
4  * 
5  * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
6  * All Rights Reserved.
7  * 
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sub license, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  * 
16  * The above copyright notice and this permission notice (including the
17  * next paragraph) shall be included in all copies or substantial portions
18  * of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
23  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
24  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27  * 
28  */
29
30 #ifndef _I915_DRV_H_
31 #define _I915_DRV_H_
32
33 /* General customization:
34  */
35
36 #define DRIVER_AUTHOR           "Tungsten Graphics, Inc."
37
38 #define DRIVER_NAME             "i915-mm"
39 #define DRIVER_DESC             "Intel Graphics"
40 #define DRIVER_DATE             "20060929"
41
42 /* Interface history:
43  *
44  * 1.1: Original.
45  * 1.2: Add Power Management
46  * 1.3: Add vblank support
47  * 1.4: Fix cmdbuffer path, add heap destroy
48  * 1.5: Add vblank pipe configuration
49  * 1.6: - New ioctl for scheduling buffer swaps on vertical blank
50  *      - Support vertical blank on secondary display pipe
51  */
52 #define DRIVER_MAJOR            1
53 #define DRIVER_MINOR            7
54 #define DRIVER_PATCHLEVEL       0
55
56 #if defined(__linux__)
57 #define I915_HAVE_FENCE
58 #define I915_HAVE_BUFFER
59 #endif
60
61 typedef struct _drm_i915_ring_buffer {
62         int tail_mask;
63         unsigned long Start;
64         unsigned long End;
65         unsigned long Size;
66         u8 *virtual_start;
67         int head;
68         int tail;
69         int space;
70         drm_local_map_t map;
71 } drm_i915_ring_buffer_t;
72
73 struct mem_block {
74         struct mem_block *next;
75         struct mem_block *prev;
76         int start;
77         int size;
78         DRMFILE filp;           /* 0: free, -1: heap, other: real files */
79 };
80
81 typedef struct _drm_i915_vbl_swap {
82         struct list_head head;
83         drm_drawable_t drw_id;
84         unsigned int pipe;
85         unsigned int sequence;
86 } drm_i915_vbl_swap_t;
87
88 typedef struct drm_i915_private {
89         drm_local_map_t *sarea;
90         drm_local_map_t *mmio_map;
91
92         drm_i915_sarea_t *sarea_priv;
93         drm_i915_ring_buffer_t ring;
94
95         drm_dma_handle_t *status_page_dmah;
96         void *hw_status_page;
97         dma_addr_t dma_status_page;
98         uint32_t counter;
99
100         unsigned int cpp;
101         int back_offset;
102         int front_offset;
103         int current_page;
104         int page_flipping;
105         int use_mi_batchbuffer_start;
106
107         wait_queue_head_t irq_queue;
108         atomic_t irq_received;
109         atomic_t irq_emitted;
110
111         int tex_lru_log_granularity;
112         int allow_batchbuffer;
113         struct mem_block *agp_heap;
114         unsigned int sr01, adpa, ppcr, dvob, dvoc, lvds;
115         int vblank_pipe;
116         spinlock_t user_irq_lock;
117         int user_irq_refcount;
118         int fence_irq_on;
119         uint32_t irq_enable_reg;
120         int irq_enabled;
121
122 #ifdef I915_HAVE_FENCE
123         uint32_t flush_sequence;
124         uint32_t flush_flags;
125         uint32_t flush_pending;
126         uint32_t saved_flush_status;
127 #endif
128
129         spinlock_t swaps_lock;
130         drm_i915_vbl_swap_t vbl_swaps;
131         unsigned int swaps_pending;
132 } drm_i915_private_t;
133
134 extern drm_ioctl_desc_t i915_ioctls[];
135 extern int i915_max_ioctl;
136
137                                 /* i915_dma.c */
138 extern void i915_kernel_lost_context(drm_device_t * dev);
139 extern int i915_driver_load(struct drm_device *, unsigned long flags);
140 extern void i915_driver_lastclose(drm_device_t * dev);
141 extern void i915_driver_preclose(drm_device_t * dev, DRMFILE filp);
142 extern int i915_driver_device_is_agp(drm_device_t * dev);
143 extern long i915_compat_ioctl(struct file *filp, unsigned int cmd,
144                               unsigned long arg);
145 extern int i915_emit_mi_flush(drm_device_t *dev, uint32_t flush);
146
147
148 /* i915_irq.c */
149 extern int i915_irq_emit(DRM_IOCTL_ARGS);
150 extern int i915_irq_wait(DRM_IOCTL_ARGS);
151
152 extern int i915_driver_vblank_wait(drm_device_t *dev, unsigned int *sequence);
153 extern int i915_driver_vblank_wait2(drm_device_t *dev, unsigned int *sequence);
154 extern irqreturn_t i915_driver_irq_handler(DRM_IRQ_ARGS);
155 extern void i915_driver_irq_preinstall(drm_device_t * dev);
156 extern void i915_driver_irq_postinstall(drm_device_t * dev);
157 extern void i915_driver_irq_uninstall(drm_device_t * dev);
158 extern int i915_vblank_pipe_set(DRM_IOCTL_ARGS);
159 extern int i915_vblank_pipe_get(DRM_IOCTL_ARGS);
160 extern int i915_emit_irq(drm_device_t * dev);
161 extern void i915_user_irq_on(drm_i915_private_t *dev_priv);
162 extern void i915_user_irq_off(drm_i915_private_t *dev_priv);
163 extern int i915_vblank_swap(DRM_IOCTL_ARGS);
164
165 /* i915_mem.c */
166 extern int i915_mem_alloc(DRM_IOCTL_ARGS);
167 extern int i915_mem_free(DRM_IOCTL_ARGS);
168 extern int i915_mem_init_heap(DRM_IOCTL_ARGS);
169 extern int i915_mem_destroy_heap(DRM_IOCTL_ARGS);
170 extern void i915_mem_takedown(struct mem_block **heap);
171 extern void i915_mem_release(drm_device_t * dev,
172                              DRMFILE filp, struct mem_block *heap);
173 #ifdef I915_HAVE_FENCE
174 /* i915_fence.c */
175
176
177 extern void i915_fence_handler(drm_device_t *dev);
178 extern int i915_fence_emit_sequence(drm_device_t *dev, uint32_t flags,
179                                     uint32_t *sequence, 
180                                     uint32_t *native_type);
181 extern void i915_poke_flush(drm_device_t *dev);
182 #endif
183
184 #ifdef I915_HAVE_BUFFER
185 /* i915_buffer.c */
186 extern drm_ttm_backend_t *i915_create_ttm_backend_entry(drm_device_t *dev);
187 extern int i915_fence_types(uint32_t buffer_flags, uint32_t *class, uint32_t *type);
188 extern int i915_invalidate_caches(drm_device_t *dev, uint32_t buffer_flags);
189 #endif
190
191 #define I915_READ(reg)          DRM_READ32(dev_priv->mmio_map, (reg))
192 #define I915_WRITE(reg,val)     DRM_WRITE32(dev_priv->mmio_map, (reg), (val))
193 #define I915_READ16(reg)        DRM_READ16(dev_priv->mmio_map, (reg))
194 #define I915_WRITE16(reg,val)   DRM_WRITE16(dev_priv->mmio_map, (reg), (val))
195
196 #define I915_VERBOSE 0
197
198 #define RING_LOCALS     unsigned int outring, ringmask, outcount; \
199                         volatile char *virt;
200
201 #define BEGIN_LP_RING(n) do {                           \
202         if (I915_VERBOSE)                               \
203                 DRM_DEBUG("BEGIN_LP_RING(%d) in %s\n",  \
204                                  (n), __FUNCTION__);           \
205         if (dev_priv->ring.space < (n)*4)                      \
206                 i915_wait_ring(dev, (n)*4, __FUNCTION__);      \
207         outcount = 0;                                   \
208         outring = dev_priv->ring.tail;                  \
209         ringmask = dev_priv->ring.tail_mask;            \
210         virt = dev_priv->ring.virtual_start;            \
211 } while (0)
212
213 #define OUT_RING(n) do {                                        \
214         if (I915_VERBOSE) DRM_DEBUG("   OUT_RING %x\n", (int)(n));      \
215         *(volatile unsigned int *)(virt + outring) = (n);               \
216         outcount++;                                             \
217         outring += 4;                                           \
218         outring &= ringmask;                                    \
219 } while (0)
220
221 #define ADVANCE_LP_RING() do {                                          \
222         if (I915_VERBOSE) DRM_DEBUG("ADVANCE_LP_RING %x\n", outring);   \
223         dev_priv->ring.tail = outring;                                  \
224         dev_priv->ring.space -= outcount * 4;                           \
225         I915_WRITE(LP_RING + RING_TAIL, outring);                       \
226 } while(0)
227
228 extern int i915_wait_ring(drm_device_t * dev, int n, const char *caller);
229
230 #define GFX_OP_USER_INTERRUPT           ((0<<29)|(2<<23))
231 #define GFX_OP_BREAKPOINT_INTERRUPT     ((0<<29)|(1<<23))
232 #define CMD_REPORT_HEAD                 (7<<23)
233 #define CMD_STORE_DWORD_IDX             ((0x21<<23) | 0x1)
234 #define CMD_OP_BATCH_BUFFER  ((0x0<<29)|(0x30<<23)|0x1)
235
236 #define INST_PARSER_CLIENT   0x00000000
237 #define INST_OP_FLUSH        0x02000000
238 #define INST_FLUSH_MAP_CACHE 0x00000001
239
240 #define CMD_MI_FLUSH         (0x04 << 23)
241 #define MI_NO_WRITE_FLUSH    (1 << 2)
242 #define MI_READ_FLUSH        (1 << 0)
243 #define MI_EXE_FLUSH         (1 << 1)
244
245 #define BB1_START_ADDR_MASK   (~0x7)
246 #define BB1_PROTECTED         (1<<0)
247 #define BB1_UNPROTECTED       (0<<0)
248 #define BB2_END_ADDR_MASK     (~0x7)
249
250 #define I915REG_HWSTAM          0x02098
251 #define I915REG_INT_IDENTITY_R  0x020a4
252 #define I915REG_INT_MASK_R      0x020a8
253 #define I915REG_INT_ENABLE_R    0x020a0
254 #define I915REG_INSTPM          0x020c0
255
256 #define SRX_INDEX               0x3c4
257 #define SRX_DATA                0x3c5
258 #define SR01                    1
259 #define SR01_SCREEN_OFF         (1<<5)
260
261 #define PPCR                    0x61204
262 #define PPCR_ON                 (1<<0)
263
264 #define DVOB                    0x61140
265 #define DVOB_ON                 (1<<31)
266 #define DVOC                    0x61160
267 #define DVOC_ON                 (1<<31)
268 #define LVDS                    0x61180
269 #define LVDS_ON                 (1<<31)
270
271 #define ADPA                    0x61100
272 #define ADPA_DPMS_MASK          (~(3<<10))
273 #define ADPA_DPMS_ON            (0<<10)
274 #define ADPA_DPMS_SUSPEND       (1<<10)
275 #define ADPA_DPMS_STANDBY       (2<<10)
276 #define ADPA_DPMS_OFF           (3<<10)
277
278 #define NOPID                   0x2094
279 #define LP_RING                 0x2030
280 #define HP_RING                 0x2040
281 #define RING_TAIL               0x00
282 #define TAIL_ADDR               0x001FFFF8
283 #define RING_HEAD               0x04
284 #define HEAD_WRAP_COUNT         0xFFE00000
285 #define HEAD_WRAP_ONE           0x00200000
286 #define HEAD_ADDR               0x001FFFFC
287 #define RING_START              0x08
288 #define START_ADDR              0x0xFFFFF000
289 #define RING_LEN                0x0C
290 #define RING_NR_PAGES           0x001FF000
291 #define RING_REPORT_MASK        0x00000006
292 #define RING_REPORT_64K         0x00000002
293 #define RING_REPORT_128K        0x00000004
294 #define RING_NO_REPORT          0x00000000
295 #define RING_VALID_MASK         0x00000001
296 #define RING_VALID              0x00000001
297 #define RING_INVALID            0x00000000
298
299 #define GFX_OP_SCISSOR         ((0x3<<29)|(0x1c<<24)|(0x10<<19))
300 #define SC_UPDATE_SCISSOR       (0x1<<1)
301 #define SC_ENABLE_MASK          (0x1<<0)
302 #define SC_ENABLE               (0x1<<0)
303
304 #define GFX_OP_SCISSOR_INFO    ((0x3<<29)|(0x1d<<24)|(0x81<<16)|(0x1))
305 #define SCI_YMIN_MASK      (0xffff<<16)
306 #define SCI_XMIN_MASK      (0xffff<<0)
307 #define SCI_YMAX_MASK      (0xffff<<16)
308 #define SCI_XMAX_MASK      (0xffff<<0)
309
310 #define GFX_OP_SCISSOR_ENABLE    ((0x3<<29)|(0x1c<<24)|(0x10<<19))
311 #define GFX_OP_SCISSOR_RECT      ((0x3<<29)|(0x1d<<24)|(0x81<<16)|1)
312 #define GFX_OP_COLOR_FACTOR      ((0x3<<29)|(0x1d<<24)|(0x1<<16)|0x0)
313 #define GFX_OP_STIPPLE           ((0x3<<29)|(0x1d<<24)|(0x83<<16))
314 #define GFX_OP_MAP_INFO          ((0x3<<29)|(0x1d<<24)|0x4)
315 #define GFX_OP_DESTBUFFER_VARS   ((0x3<<29)|(0x1d<<24)|(0x85<<16)|0x0)
316 #define GFX_OP_DRAWRECT_INFO     ((0x3<<29)|(0x1d<<24)|(0x80<<16)|(0x3))
317
318 #define GFX_OP_DRAWRECT_INFO_I965  ((0x7900<<16)|0x2)
319
320 #define XY_SRC_COPY_BLT_CMD             ((2<<29)|(0x53<<22)|6)
321 #define XY_SRC_COPY_BLT_WRITE_ALPHA     (1<<21)
322 #define XY_SRC_COPY_BLT_WRITE_RGB       (1<<20)
323
324 #define MI_BATCH_BUFFER         ((0x30<<23)|1)
325 #define MI_BATCH_BUFFER_START   (0x31<<23)
326 #define MI_BATCH_BUFFER_END     (0xA<<23)
327 #define MI_BATCH_NON_SECURE     (1)
328
329 #define MI_WAIT_FOR_EVENT       ((0x3<<23))
330 #define MI_WAIT_FOR_PLANE_A_FLIP      (1<<2)
331 #define MI_WAIT_FOR_PLANE_A_SCANLINES (1<<1)
332
333 #define MI_LOAD_SCAN_LINES_INCL  ((0x12<<23))
334
335 #define CMD_OP_DISPLAYBUFFER_INFO ((0x0<<29)|(0x14<<23)|2)
336 #define ASYNC_FLIP                (1<<22)
337
338 #define CMD_OP_DESTBUFFER_INFO   ((0x3<<29)|(0x1d<<24)|(0x8e<<16)|1)
339
340 #define READ_BREADCRUMB(dev_priv)  (((volatile u32*)(dev_priv->hw_status_page))[5])
341 #define READ_HWSP(dev_priv, reg)  (((volatile u32*)(dev_priv->hw_status_page))[reg])
342 #endif