Merge with Linux 2.5.48.
[linux-2.6/linux-mips.git] / drivers / char / drm / r128_drv.h
blob763fcb3a5d776c724e248a61408e1db08a1a219f
1 /* r128_drv.h -- Private header for r128 driver -*- linux-c -*-
2 * Created: Mon Dec 13 09:51:11 1999 by faith@precisioninsight.com
4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6 * All rights reserved.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice (including the next
16 * paragraph) shall be included in all copies or substantial portions of the
17 * Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 * DEALINGS IN THE SOFTWARE.
27 * Authors:
28 * Rickard E. (Rik) Faith <faith@valinux.com>
29 * Kevin E. Martin <martin@valinux.com>
30 * Gareth Hughes <gareth@valinux.com>
31 * Michel Dänzer <daenzerm@student.ethz.ch>
34 #ifndef __R128_DRV_H__
35 #define __R128_DRV_H__
37 #define GET_RING_HEAD(ring) DRM_READ32( (volatile u32 *) (ring)->head )
38 #define SET_RING_HEAD(ring,val) DRM_WRITE32( (volatile u32 *) (ring)->head, (val) )
40 typedef struct drm_r128_freelist {
41 unsigned int age;
42 drm_buf_t *buf;
43 struct drm_r128_freelist *next;
44 struct drm_r128_freelist *prev;
45 } drm_r128_freelist_t;
47 typedef struct drm_r128_ring_buffer {
48 u32 *start;
49 u32 *end;
50 int size;
51 int size_l2qw;
53 volatile u32 *head;
54 u32 tail;
55 u32 tail_mask;
56 int space;
58 int high_mark;
59 } drm_r128_ring_buffer_t;
61 typedef struct drm_r128_private {
62 drm_r128_ring_buffer_t ring;
63 drm_r128_sarea_t *sarea_priv;
65 int cce_mode;
66 int cce_fifo_size;
67 int cce_running;
69 drm_r128_freelist_t *head;
70 drm_r128_freelist_t *tail;
72 int usec_timeout;
73 int is_pci;
74 unsigned long phys_pci_gart;
75 dma_addr_t bus_pci_gart;
76 unsigned long cce_buffers_offset;
78 atomic_t idle_count;
80 int page_flipping;
81 int current_page;
82 u32 crtc_offset;
83 u32 crtc_offset_cntl;
85 u32 color_fmt;
86 unsigned int front_offset;
87 unsigned int front_pitch;
88 unsigned int back_offset;
89 unsigned int back_pitch;
91 u32 depth_fmt;
92 unsigned int depth_offset;
93 unsigned int depth_pitch;
94 unsigned int span_offset;
96 u32 front_pitch_offset_c;
97 u32 back_pitch_offset_c;
98 u32 depth_pitch_offset_c;
99 u32 span_pitch_offset_c;
101 drm_map_t *sarea;
102 drm_map_t *fb;
103 drm_map_t *mmio;
104 drm_map_t *cce_ring;
105 drm_map_t *ring_rptr;
106 drm_map_t *buffers;
107 drm_map_t *agp_textures;
108 } drm_r128_private_t;
110 typedef struct drm_r128_buf_priv {
111 u32 age;
112 int prim;
113 int discard;
114 int dispatched;
115 drm_r128_freelist_t *list_entry;
116 } drm_r128_buf_priv_t;
118 /* r128_cce.c */
119 extern int r128_cce_init( DRM_IOCTL_ARGS );
120 extern int r128_cce_start( DRM_IOCTL_ARGS );
121 extern int r128_cce_stop( DRM_IOCTL_ARGS );
122 extern int r128_cce_reset( DRM_IOCTL_ARGS );
123 extern int r128_cce_idle( DRM_IOCTL_ARGS );
124 extern int r128_engine_reset( DRM_IOCTL_ARGS );
125 extern int r128_fullscreen( DRM_IOCTL_ARGS );
126 extern int r128_cce_buffers( DRM_IOCTL_ARGS );
127 extern int r128_getparam( DRM_IOCTL_ARGS );
129 extern void r128_freelist_reset( drm_device_t *dev );
130 extern drm_buf_t *r128_freelist_get( drm_device_t *dev );
132 extern int r128_wait_ring( drm_r128_private_t *dev_priv, int n );
134 static __inline__ void
135 r128_update_ring_snapshot( drm_r128_ring_buffer_t *ring )
137 ring->space = (GET_RING_HEAD( ring ) - ring->tail) * sizeof(u32);
138 if ( ring->space <= 0 )
139 ring->space += ring->size;
142 extern int r128_do_cce_idle( drm_r128_private_t *dev_priv );
143 extern int r128_do_cleanup_cce( drm_device_t *dev );
144 extern int r128_do_cleanup_pageflip( drm_device_t *dev );
146 /* r128_state.c */
147 extern int r128_cce_clear( DRM_IOCTL_ARGS );
148 extern int r128_cce_swap( DRM_IOCTL_ARGS );
149 extern int r128_cce_vertex( DRM_IOCTL_ARGS );
150 extern int r128_cce_indices( DRM_IOCTL_ARGS );
151 extern int r128_cce_blit( DRM_IOCTL_ARGS );
152 extern int r128_cce_depth( DRM_IOCTL_ARGS );
153 extern int r128_cce_stipple( DRM_IOCTL_ARGS );
154 extern int r128_cce_indirect( DRM_IOCTL_ARGS );
157 /* Register definitions, register access macros and drmAddMap constants
158 * for Rage 128 kernel driver.
161 #define R128_AUX_SC_CNTL 0x1660
162 # define R128_AUX1_SC_EN (1 << 0)
163 # define R128_AUX1_SC_MODE_OR (0 << 1)
164 # define R128_AUX1_SC_MODE_NAND (1 << 1)
165 # define R128_AUX2_SC_EN (1 << 2)
166 # define R128_AUX2_SC_MODE_OR (0 << 3)
167 # define R128_AUX2_SC_MODE_NAND (1 << 3)
168 # define R128_AUX3_SC_EN (1 << 4)
169 # define R128_AUX3_SC_MODE_OR (0 << 5)
170 # define R128_AUX3_SC_MODE_NAND (1 << 5)
171 #define R128_AUX1_SC_LEFT 0x1664
172 #define R128_AUX1_SC_RIGHT 0x1668
173 #define R128_AUX1_SC_TOP 0x166c
174 #define R128_AUX1_SC_BOTTOM 0x1670
175 #define R128_AUX2_SC_LEFT 0x1674
176 #define R128_AUX2_SC_RIGHT 0x1678
177 #define R128_AUX2_SC_TOP 0x167c
178 #define R128_AUX2_SC_BOTTOM 0x1680
179 #define R128_AUX3_SC_LEFT 0x1684
180 #define R128_AUX3_SC_RIGHT 0x1688
181 #define R128_AUX3_SC_TOP 0x168c
182 #define R128_AUX3_SC_BOTTOM 0x1690
184 #define R128_BRUSH_DATA0 0x1480
185 #define R128_BUS_CNTL 0x0030
186 # define R128_BUS_MASTER_DIS (1 << 6)
188 #define R128_CLOCK_CNTL_INDEX 0x0008
189 #define R128_CLOCK_CNTL_DATA 0x000c
190 # define R128_PLL_WR_EN (1 << 7)
191 #define R128_CONSTANT_COLOR_C 0x1d34
192 #define R128_CRTC_OFFSET 0x0224
193 #define R128_CRTC_OFFSET_CNTL 0x0228
194 # define R128_CRTC_OFFSET_FLIP_CNTL (1 << 16)
196 #define R128_DP_GUI_MASTER_CNTL 0x146c
197 # define R128_GMC_SRC_PITCH_OFFSET_CNTL (1 << 0)
198 # define R128_GMC_DST_PITCH_OFFSET_CNTL (1 << 1)
199 # define R128_GMC_BRUSH_SOLID_COLOR (13 << 4)
200 # define R128_GMC_BRUSH_NONE (15 << 4)
201 # define R128_GMC_DST_16BPP (4 << 8)
202 # define R128_GMC_DST_24BPP (5 << 8)
203 # define R128_GMC_DST_32BPP (6 << 8)
204 # define R128_GMC_DST_DATATYPE_SHIFT 8
205 # define R128_GMC_SRC_DATATYPE_COLOR (3 << 12)
206 # define R128_DP_SRC_SOURCE_MEMORY (2 << 24)
207 # define R128_DP_SRC_SOURCE_HOST_DATA (3 << 24)
208 # define R128_GMC_CLR_CMP_CNTL_DIS (1 << 28)
209 # define R128_GMC_AUX_CLIP_DIS (1 << 29)
210 # define R128_GMC_WR_MSK_DIS (1 << 30)
211 # define R128_ROP3_S 0x00cc0000
212 # define R128_ROP3_P 0x00f00000
213 #define R128_DP_WRITE_MASK 0x16cc
214 #define R128_DST_PITCH_OFFSET_C 0x1c80
215 # define R128_DST_TILE (1 << 31)
217 #define R128_GEN_INT_CNTL 0x0040
218 # define R128_CRTC_VBLANK_INT_EN (1 << 0)
219 #define R128_GEN_INT_STATUS 0x0044
220 # define R128_CRTC_VBLANK_INT (1 << 0)
221 # define R128_CRTC_VBLANK_INT_AK (1 << 0)
222 #define R128_GEN_RESET_CNTL 0x00f0
223 # define R128_SOFT_RESET_GUI (1 << 0)
225 #define R128_GUI_SCRATCH_REG0 0x15e0
226 #define R128_GUI_SCRATCH_REG1 0x15e4
227 #define R128_GUI_SCRATCH_REG2 0x15e8
228 #define R128_GUI_SCRATCH_REG3 0x15ec
229 #define R128_GUI_SCRATCH_REG4 0x15f0
230 #define R128_GUI_SCRATCH_REG5 0x15f4
232 #define R128_GUI_STAT 0x1740
233 # define R128_GUI_FIFOCNT_MASK 0x0fff
234 # define R128_GUI_ACTIVE (1 << 31)
236 #define R128_MCLK_CNTL 0x000f
237 # define R128_FORCE_GCP (1 << 16)
238 # define R128_FORCE_PIPE3D_CP (1 << 17)
239 # define R128_FORCE_RCP (1 << 18)
241 #define R128_PC_GUI_CTLSTAT 0x1748
242 #define R128_PC_NGUI_CTLSTAT 0x0184
243 # define R128_PC_FLUSH_GUI (3 << 0)
244 # define R128_PC_RI_GUI (1 << 2)
245 # define R128_PC_FLUSH_ALL 0x00ff
246 # define R128_PC_BUSY (1 << 31)
248 #define R128_PCI_GART_PAGE 0x017c
249 #define R128_PRIM_TEX_CNTL_C 0x1cb0
251 #define R128_SCALE_3D_CNTL 0x1a00
252 #define R128_SEC_TEX_CNTL_C 0x1d00
253 #define R128_SEC_TEXTURE_BORDER_COLOR_C 0x1d3c
254 #define R128_SETUP_CNTL 0x1bc4
255 #define R128_STEN_REF_MASK_C 0x1d40
257 #define R128_TEX_CNTL_C 0x1c9c
258 # define R128_TEX_CACHE_FLUSH (1 << 23)
260 #define R128_WAIT_UNTIL 0x1720
261 # define R128_EVENT_CRTC_OFFSET (1 << 0)
262 #define R128_WINDOW_XY_OFFSET 0x1bcc
265 /* CCE registers
267 #define R128_PM4_BUFFER_OFFSET 0x0700
268 #define R128_PM4_BUFFER_CNTL 0x0704
269 # define R128_PM4_MASK (15 << 28)
270 # define R128_PM4_NONPM4 (0 << 28)
271 # define R128_PM4_192PIO (1 << 28)
272 # define R128_PM4_192BM (2 << 28)
273 # define R128_PM4_128PIO_64INDBM (3 << 28)
274 # define R128_PM4_128BM_64INDBM (4 << 28)
275 # define R128_PM4_64PIO_128INDBM (5 << 28)
276 # define R128_PM4_64BM_128INDBM (6 << 28)
277 # define R128_PM4_64PIO_64VCBM_64INDBM (7 << 28)
278 # define R128_PM4_64BM_64VCBM_64INDBM (8 << 28)
279 # define R128_PM4_64PIO_64VCPIO_64INDPIO (15 << 28)
281 #define R128_PM4_BUFFER_WM_CNTL 0x0708
282 # define R128_WMA_SHIFT 0
283 # define R128_WMB_SHIFT 8
284 # define R128_WMC_SHIFT 16
285 # define R128_WB_WM_SHIFT 24
287 #define R128_PM4_BUFFER_DL_RPTR_ADDR 0x070c
288 #define R128_PM4_BUFFER_DL_RPTR 0x0710
289 #define R128_PM4_BUFFER_DL_WPTR 0x0714
290 # define R128_PM4_BUFFER_DL_DONE (1 << 31)
292 #define R128_PM4_VC_FPU_SETUP 0x071c
294 #define R128_PM4_IW_INDOFF 0x0738
295 #define R128_PM4_IW_INDSIZE 0x073c
297 #define R128_PM4_STAT 0x07b8
298 # define R128_PM4_FIFOCNT_MASK 0x0fff
299 # define R128_PM4_BUSY (1 << 16)
300 # define R128_PM4_GUI_ACTIVE (1 << 31)
302 #define R128_PM4_MICROCODE_ADDR 0x07d4
303 #define R128_PM4_MICROCODE_RADDR 0x07d8
304 #define R128_PM4_MICROCODE_DATAH 0x07dc
305 #define R128_PM4_MICROCODE_DATAL 0x07e0
307 #define R128_PM4_BUFFER_ADDR 0x07f0
308 #define R128_PM4_MICRO_CNTL 0x07fc
309 # define R128_PM4_MICRO_FREERUN (1 << 30)
311 #define R128_PM4_FIFO_DATA_EVEN 0x1000
312 #define R128_PM4_FIFO_DATA_ODD 0x1004
315 /* CCE command packets
317 #define R128_CCE_PACKET0 0x00000000
318 #define R128_CCE_PACKET1 0x40000000
319 #define R128_CCE_PACKET2 0x80000000
320 #define R128_CCE_PACKET3 0xC0000000
321 # define R128_CNTL_HOSTDATA_BLT 0x00009400
322 # define R128_CNTL_PAINT_MULTI 0x00009A00
323 # define R128_CNTL_BITBLT_MULTI 0x00009B00
324 # define R128_3D_RNDR_GEN_INDX_PRIM 0x00002300
326 #define R128_CCE_PACKET_MASK 0xC0000000
327 #define R128_CCE_PACKET_COUNT_MASK 0x3fff0000
328 #define R128_CCE_PACKET0_REG_MASK 0x000007ff
329 #define R128_CCE_PACKET1_REG0_MASK 0x000007ff
330 #define R128_CCE_PACKET1_REG1_MASK 0x003ff800
332 #define R128_CCE_VC_CNTL_PRIM_TYPE_NONE 0x00000000
333 #define R128_CCE_VC_CNTL_PRIM_TYPE_POINT 0x00000001
334 #define R128_CCE_VC_CNTL_PRIM_TYPE_LINE 0x00000002
335 #define R128_CCE_VC_CNTL_PRIM_TYPE_POLY_LINE 0x00000003
336 #define R128_CCE_VC_CNTL_PRIM_TYPE_TRI_LIST 0x00000004
337 #define R128_CCE_VC_CNTL_PRIM_TYPE_TRI_FAN 0x00000005
338 #define R128_CCE_VC_CNTL_PRIM_TYPE_TRI_STRIP 0x00000006
339 #define R128_CCE_VC_CNTL_PRIM_TYPE_TRI_TYPE2 0x00000007
340 #define R128_CCE_VC_CNTL_PRIM_WALK_IND 0x00000010
341 #define R128_CCE_VC_CNTL_PRIM_WALK_LIST 0x00000020
342 #define R128_CCE_VC_CNTL_PRIM_WALK_RING 0x00000030
343 #define R128_CCE_VC_CNTL_NUM_SHIFT 16
345 #define R128_DATATYPE_CI8 2
346 #define R128_DATATYPE_ARGB1555 3
347 #define R128_DATATYPE_RGB565 4
348 #define R128_DATATYPE_RGB888 5
349 #define R128_DATATYPE_ARGB8888 6
350 #define R128_DATATYPE_RGB332 7
351 #define R128_DATATYPE_RGB8 9
352 #define R128_DATATYPE_ARGB4444 15
354 /* Constants */
355 #define R128_AGP_OFFSET 0x02000000
357 #define R128_WATERMARK_L 16
358 #define R128_WATERMARK_M 8
359 #define R128_WATERMARK_N 8
360 #define R128_WATERMARK_K 128
362 #define R128_MAX_USEC_TIMEOUT 100000 /* 100 ms */
364 #define R128_LAST_FRAME_REG R128_GUI_SCRATCH_REG0
365 #define R128_LAST_DISPATCH_REG R128_GUI_SCRATCH_REG1
366 #define R128_MAX_VB_AGE 0x7fffffff
367 #define R128_MAX_VB_VERTS (0xffff)
369 #define R128_RING_HIGH_MARK 128
371 #define R128_PERFORMANCE_BOXES 0
374 #define R128_BASE(reg) ((unsigned long)(dev_priv->mmio->handle))
375 #define R128_ADDR(reg) (R128_BASE( reg ) + reg)
377 #define R128_READ(reg) DRM_READ32( (volatile u32 *) R128_ADDR(reg) )
378 #define R128_WRITE(reg,val) DRM_WRITE32( (volatile u32 *) R128_ADDR(reg), (val) )
380 #define R128_READ8(reg) DRM_READ8( (volatile u8 *) R128_ADDR(reg) )
381 #define R128_WRITE8(reg,val) DRM_WRITE8( (volatile u8 *) R128_ADDR(reg), (val) )
383 #define R128_WRITE_PLL(addr,val) \
384 do { \
385 R128_WRITE8(R128_CLOCK_CNTL_INDEX, \
386 ((addr) & 0x1f) | R128_PLL_WR_EN); \
387 R128_WRITE(R128_CLOCK_CNTL_DATA, (val)); \
388 } while (0)
390 extern int R128_READ_PLL(drm_device_t *dev, int addr);
393 #define CCE_PACKET0( reg, n ) (R128_CCE_PACKET0 | \
394 ((n) << 16) | ((reg) >> 2))
395 #define CCE_PACKET1( reg0, reg1 ) (R128_CCE_PACKET1 | \
396 (((reg1) >> 2) << 11) | ((reg0) >> 2))
397 #define CCE_PACKET2() (R128_CCE_PACKET2)
398 #define CCE_PACKET3( pkt, n ) (R128_CCE_PACKET3 | \
399 (pkt) | ((n) << 16))
402 /* ================================================================
403 * Misc helper macros
406 #define LOCK_TEST_WITH_RETURN( dev ) \
407 do { \
408 if ( !_DRM_LOCK_IS_HELD( dev->lock.hw_lock->lock ) || \
409 dev->lock.pid != DRM_CURRENTPID ) { \
410 DRM_ERROR( "%s called without lock held\n", __FUNCTION__ ); \
411 return DRM_ERR(EINVAL); \
413 } while (0)
415 #define RING_SPACE_TEST_WITH_RETURN( dev_priv ) \
416 do { \
417 drm_r128_ring_buffer_t *ring = &dev_priv->ring; int i; \
418 if ( ring->space < ring->high_mark ) { \
419 for ( i = 0 ; i < dev_priv->usec_timeout ; i++ ) { \
420 r128_update_ring_snapshot( ring ); \
421 if ( ring->space >= ring->high_mark ) \
422 goto __ring_space_done; \
423 DRM_UDELAY(1); \
425 DRM_ERROR( "ring space check failed!\n" ); \
426 return DRM_ERR(EBUSY); \
428 __ring_space_done: \
430 } while (0)
432 #define VB_AGE_TEST_WITH_RETURN( dev_priv ) \
433 do { \
434 drm_r128_sarea_t *sarea_priv = dev_priv->sarea_priv; \
435 if ( sarea_priv->last_dispatch >= R128_MAX_VB_AGE ) { \
436 int __ret = r128_do_cce_idle( dev_priv ); \
437 if ( __ret ) return __ret; \
438 sarea_priv->last_dispatch = 0; \
439 r128_freelist_reset( dev ); \
441 } while (0)
443 #define R128_WAIT_UNTIL_PAGE_FLIPPED() do { \
444 OUT_RING( CCE_PACKET0( R128_WAIT_UNTIL, 0 ) ); \
445 OUT_RING( R128_EVENT_CRTC_OFFSET ); \
446 } while (0)
449 /* ================================================================
450 * Ring control
453 #if defined(__powerpc__)
454 #define r128_flush_write_combine() (void) GET_RING_HEAD( &dev_priv->ring )
455 #else
456 #define r128_flush_write_combine() DRM_WRITEMEMORYBARRIER()
457 #endif
460 #define R128_VERBOSE 0
462 #define RING_LOCALS \
463 int write; unsigned int tail_mask; volatile u32 *ring;
465 #define BEGIN_RING( n ) do { \
466 if ( R128_VERBOSE ) { \
467 DRM_INFO( "BEGIN_RING( %d ) in %s\n", \
468 (n), __FUNCTION__ ); \
470 if ( dev_priv->ring.space <= (n) * sizeof(u32) ) { \
471 r128_wait_ring( dev_priv, (n) * sizeof(u32) ); \
473 dev_priv->ring.space -= (n) * sizeof(u32); \
474 ring = dev_priv->ring.start; \
475 write = dev_priv->ring.tail; \
476 tail_mask = dev_priv->ring.tail_mask; \
477 } while (0)
479 /* You can set this to zero if you want. If the card locks up, you'll
480 * need to keep this set. It works around a bug in early revs of the
481 * Rage 128 chipset, where the CCE would read 32 dwords past the end of
482 * the ring buffer before wrapping around.
484 #define R128_BROKEN_CCE 1
486 #define ADVANCE_RING() do { \
487 if ( R128_VERBOSE ) { \
488 DRM_INFO( "ADVANCE_RING() wr=0x%06x tail=0x%06x\n", \
489 write, dev_priv->ring.tail ); \
491 if ( R128_BROKEN_CCE && write < 32 ) { \
492 memcpy( dev_priv->ring.end, \
493 dev_priv->ring.start, \
494 write * sizeof(u32) ); \
496 r128_flush_write_combine(); \
497 dev_priv->ring.tail = write; \
498 R128_WRITE( R128_PM4_BUFFER_DL_WPTR, write ); \
499 } while (0)
501 #define OUT_RING( x ) do { \
502 if ( R128_VERBOSE ) { \
503 DRM_INFO( " OUT_RING( 0x%08x ) at 0x%x\n", \
504 (unsigned int)(x), write ); \
506 ring[write++] = cpu_to_le32( x ); \
507 write &= tail_mask; \
508 } while (0)
510 #endif /* __R128_DRV_H__ */