filename | src/pvr2/pvr2.h |
changeset | 677:3ee62740ff8f |
prev | 669:ab344e42bca9 |
next | 736:a02d1475ccfd |
author | nkeynes |
date | Sat Jun 14 11:54:15 2008 +0000 (15 years ago) |
permissions | -rw-r--r-- |
last change | Change colour params to float Convert background processing over to scene structure (fixes some depth issues as well) Add color unclamp when supported |
view | annotate | diff | log | raw |
1 /**
2 * $Id$
3 *
4 * PVR2 (video chip) functions and macros.
5 *
6 * Copyright (c) 2005 Nathan Keynes.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 */
19 #ifndef lxdream_pvr2_H
20 #define lxdream_pvr2_H 1
22 #include <stdio.h>
23 #include "lxdream.h"
24 #include "mem.h"
25 #include "display.h"
27 typedef unsigned int pvraddr_t;
28 typedef unsigned int pvr64addr_t;
30 #define DISPMODE_ENABLE 0x00000001 /* Display enable */
31 #define DISPMODE_LINEDOUBLE 0x00000002 /* scanline double */
32 #define DISPMODE_COLFMT 0x0000000C /* Colour mode */
33 #define DISPMODE_CLOCKDIV 0x08000000 /* Clock divide-by-2 */
35 #define DISPSIZE_MODULO 0x3FF00000 /* line skip +1 (32-bit words)*/
36 #define DISPSIZE_LPF 0x000FFC00 /* lines per field */
37 #define DISPSIZE_PPL 0x000003FF /* pixel words (32 bit) per line */
39 #define DISPCFG_VP 0x00000001 /* V-sync polarity */
40 #define DISPCFG_HP 0x00000002 /* H-sync polarity */
41 #define DISPCFG_I 0x00000010 /* Interlace enable */
42 #define DISPCFG_BS 0x000000C0 /* Broadcast standard */
43 #define DISPCFG_VO 0x00000100 /* Video output enable */
45 #define DISPSYNC_LINE_MASK 0x000003FF
46 #define DISPSYNC_EVEN_FIELD 0x00000000
47 #define DISPSYNC_ODD_FIELD 0x00000400
48 #define DISPSYNC_ACTIVE 0x00000800
49 #define DISPSYNC_HSYNC 0x00001000
50 #define DISPSYNC_VSYNC 0x00002000
52 #define BS_NTSC 0x00000000
53 #define BS_PAL 0x00000040
54 #define BS_PALM 0x00000080 /* ? */
55 #define BS_PALN 0x000000C0 /* ? */
57 #define PVR2_RAM_BASE 0x05000000
58 #define PVR2_RAM_BASE_INT 0x04000000
59 #define PVR2_RAM_SIZE (8 * 1024 * 1024)
60 #define PVR2_RAM_PAGES (PVR2_RAM_SIZE>>12)
61 #define PVR2_RAM_MASK 0x7FFFFF
63 #define RENDER_ZONLY 0
64 #define RENDER_NORMAL 1 /* Render non-modified polygons */
65 #define RENDER_CHEAPMOD 2 /* Render cheap-modified polygons */
66 #define RENDER_FULLMOD 3 /* Render the fully-modified version of the polygons */
68 void pvr2_next_frame( void );
69 void pvr2_set_base_address( uint32_t );
70 int pvr2_get_frame_count( void );
71 void pvr2_redraw_display();
72 gboolean pvr2_save_next_scene( const gchar *filename );
74 #define PVR2_CMD_END_OF_LIST 0x00
75 #define PVR2_CMD_USER_CLIP 0x20
76 #define PVR2_CMD_POLY_OPAQUE 0x80
77 #define PVR2_CMD_MOD_OPAQUE 0x81
78 #define PVR2_CMD_POLY_TRANS 0x82
79 #define PVR2_CMD_MOD_TRANS 0x83
80 #define PVR2_CMD_POLY_PUNCHOUT 0x84
81 #define PVR2_CMD_VERTEX 0xE0
82 #define PVR2_CMD_VERTEX_LAST 0xF0
84 #define PVR2_POLY_TEXTURED 0x00000008
85 #define PVR2_POLY_SPECULAR 0x00000004
86 #define PVR2_POLY_SHADED 0x00000002
87 #define PVR2_POLY_UV_16BIT 0x00000001
89 #define PVR2_POLY_MODE_CLAMP_RGB 0x00200000
90 #define PVR2_POLY_MODE_ALPHA 0x00100000
91 #define PVR2_POLY_MODE_TEXALPHA 0x00080000
92 #define PVR2_POLY_MODE_FLIP_S 0x00040000
93 #define PVR2_POLY_MODE_FLIP_T 0x00020000
94 #define PVR2_POLY_MODE_CLAMP_S 0x00010000
95 #define PVR2_POLY_MODE_CLAMP_T 0x00008000
97 #define PVR2_POLY_FOG_LOOKUP 0x00000000
98 #define PVR2_POLY_FOG_VERTEX 0x00400000
99 #define PVR2_POLY_FOG_DISABLED 0x00800000
100 #define PVR2_POLY_FOG_LOOKUP2 0x00C00000
103 #define PVR2_TEX_FORMAT_ARGB1555 0x00000000
104 #define PVR2_TEX_FORMAT_RGB565 0x08000000
105 #define PVR2_TEX_FORMAT_ARGB4444 0x10000000
106 #define PVR2_TEX_FORMAT_YUV422 0x18000000
107 #define PVR2_TEX_FORMAT_BUMPMAP 0x20000000
108 #define PVR2_TEX_FORMAT_IDX4 0x28000000
109 #define PVR2_TEX_FORMAT_IDX8 0x30000000
111 #define PVR2_TEX_MIPMAP 0x80000000
112 #define PVR2_TEX_COMPRESSED 0x40000000
113 #define PVR2_TEX_FORMAT_MASK 0x38000000
114 #define PVR2_TEX_UNTWIDDLED 0x04000000
115 #define PVR2_TEX_STRIDE 0x02000000
116 #define PVR2_TEX_IS_PALETTE(mode) ( (mode & PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX4 || (mode&PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX8 )
119 #define PVR2_TEX_ADDR(x) ( ((x)&0x01FFFFF)<<3 );
120 #define PVR2_TEX_IS_MIPMAPPED(x) ( ((x) & 0x84000000) == 0x80000000 )
121 #define PVR2_TEX_IS_COMPRESSED(x) ( (x) & PVR2_TEX_COMPRESSED )
122 #define PVR2_TEX_IS_TWIDDLED(x) (((x) & PVR2_TEX_UNTWIDDLED) == 0)
123 #define PVR2_TEX_IS_STRIDE(x) (((x) & 0x06000000) == 0x06000000)
125 /****************************** Frame Buffer *****************************/
127 /**
128 * Write a block of data to an address in the DMA range (0x10000000 -
129 * 0x13FFFFFF), ie TA, YUV, or texture ram.
130 */
131 void pvr2_dma_write( sh4addr_t dest, unsigned char *src, uint32_t length );
133 /**
134 * Write to the interleaved memory address space (aka 64-bit address space).
135 */
136 void pvr2_vram64_write( sh4addr_t dest, unsigned char *src, uint32_t length );
138 /**
139 * Write to the interleaved memory address space (aka 64-bit address space),
140 * using a line length and stride.
141 */
142 void pvr2_vram64_write_stride( sh4addr_t dest, unsigned char *src, uint32_t line_bytes,
143 uint32_t line_stride_bytes, uint32_t line_count );
145 /**
146 * Read from the interleaved memory address space (aka 64-bit address space)
147 */
148 void pvr2_vram64_read( unsigned char *dest, sh4addr_t src, uint32_t length );
150 /**
151 * Read a twiddled image from interleaved memory address space (aka 64-bit address
152 * space), writing the image to the destination buffer in detwiddled format.
153 * Width and height must be powers of 2
154 * This version reads 4-bit pixels.
155 */
156 void pvr2_vram64_read_twiddled_4( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
159 /**
160 * Read a twiddled image from interleaved memory address space (aka 64-bit address
161 * space), writing the image to the destination buffer in detwiddled format.
162 * Width and height must be powers of 2
163 * This version reads 8-bit pixels.
164 */
165 void pvr2_vram64_read_twiddled_8( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
167 /**
168 * Read a twiddled image from interleaved memory address space (aka 64-bit address
169 * space), writing the image to the destination buffer in detwiddled format.
170 * Width and height must be powers of 2, and src must be 16-bit aligned.
171 * This version reads 16-bit pixels.
172 */
173 void pvr2_vram64_read_twiddled_16( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
175 /**
176 * Read an image from the interleaved memory address space (aka 64-bit address space)
177 * where the source and destination line sizes may differ. Note that both byte
178 * counts must be a multiple of 4, and the src address must be 32-bit aligned.
179 */
180 void pvr2_vram64_read_stride( unsigned char *dest, uint32_t dest_line_bytes, sh4addr_t srcaddr,
181 uint32_t src_line_bytes, uint32_t line_count );
182 /**
183 * Dump a portion of vram to a stream from the interleaved memory address
184 * space.
185 */
186 void pvr2_vram64_dump( sh4addr_t addr, uint32_t length, FILE *f );
188 /**
189 * Flush the indicated render buffer back to PVR. Caller is responsible for
190 * tracking whether there is actually anything in the buffer.
191 *
192 * @param buffer A render buffer indicating the address to store to, and the
193 * format the data needs to be in.
194 * @param backBuffer TRUE to flush the back buffer, FALSE for
195 * the front buffer.
196 */
197 void pvr2_render_buffer_copy_to_sh4( render_buffer_t buffer );
199 /**
200 * Invalidate any caching on the supplied SH4 address
201 */
202 gboolean pvr2_render_buffer_invalidate( sh4addr_t addr, gboolean isWrite );
205 /**************************** Tile Accelerator ***************************/
206 /**
207 * Process the data in the supplied buffer as an array of TA command lists.
208 * Any excess bytes are held pending until a complete list is sent
209 */
210 void pvr2_ta_write( unsigned char *buf, uint32_t length );
213 /**
214 * (Re)initialize the tile accelerator in preparation for the next scene.
215 * Normally called immediately before commencing polygon transmission.
216 */
217 void pvr2_ta_init( void );
219 void pvr2_ta_reset( void );
221 void pvr2_ta_save_state( FILE *f );
223 int pvr2_ta_load_state( FILE *f );
225 /****************************** YUV Converter ****************************/
227 /**
228 * Process a block of YUV data.
229 */
230 void pvr2_yuv_write( unsigned char *buf, uint32_t length );
232 /**
233 * Initialize the YUV converter.
234 */
235 void pvr2_yuv_init( uint32_t target_addr );
237 void pvr2_yuv_set_config( uint32_t config );
239 void pvr2_yuv_save_state( FILE *f );
241 int pvr2_yuv_load_state( FILE *f );
243 /********************************* Renderer ******************************/
245 /**
246 * Render the current scene stored in PVR ram to the GL back buffer.
247 */
248 void pvr2_scene_render( render_buffer_t buffer );
250 /**
251 * Perform the initial once-off GL setup, usually immediately after the GL
252 * context is first bound.
253 */
254 void pvr2_setup_gl_context();
256 void render_backplane( uint32_t *polygon, uint32_t width, uint32_t height, uint32_t mode );
258 void render_autosort_tile( pvraddr_t tile_entry, int render_mode );
260 void render_set_context( uint32_t *context, int render_mode );
262 void gl_render_tilelist( pvraddr_t tile_entry );
264 /**
265 * Structure to hold a complete unpacked vertex (excluding modifier
266 * volume parameters - generate separate vertexes in that case).
267 */
268 struct vertex_unpacked {
269 float x,y,z;
270 float u,v; /* Texture coordinates */
271 float rgba[4]; /* Fragment colour (RGBA order) */
272 float offset_rgba[4]; /* Offset color (RGBA order) */
273 };
275 /****************************** Texture Cache ****************************/
277 /**
278 * Initialize the texture cache.
279 */
280 void texcache_init( void );
282 /**
283 * Initialize the GL side of the texture cache (texture ids and such).
284 */
285 void texcache_gl_init( void );
287 /**
288 * Flush all textures and delete. The cache will be non-functional until
289 * the next call to texcache_init(). This would typically be done if
290 * switching GL targets.
291 */
292 void texcache_shutdown( void );
294 /**
295 * Flush (ie free) all textures.
296 */
297 void texcache_flush( void );
299 /**
300 * Flush all palette-based textures (if any)
301 */
302 void texcache_invalidate_palette(void);
304 /**
305 * Evict all textures contained in the page identified by a texture address.
306 */
307 void texcache_invalidate_page( uint32_t texture_addr );
309 /**
310 * Return a texture ID for the texture specified at the supplied address
311 * and given parameters (the same sequence of bytes could in theory have
312 * multiple interpretations). We use the texture address as the primary
313 * index, but allow for multiple instances at each address. The texture
314 * will be bound to the GL_TEXTURE_2D target before being returned.
315 *
316 * If the texture has already been bound, return the ID to which it was
317 * bound. Otherwise obtain an unused texture ID and set it up appropriately.
318 */
319 GLuint texcache_get_texture( uint32_t texture_word, int width, int height );
321 void pvr2_check_palette_changed(void);
323 int pvr2_render_save_scene( const gchar *filename );
326 /************************* Rendering support macros **************************/
327 #define POLY1_DEPTH_MODE(poly1) ( pvr2_poly_depthmode[(poly1)>>29] )
328 #define POLY1_DEPTH_WRITE(poly1) (((poly1)&0x04000000) == 0 )
329 #define POLY1_CULL_MODE(poly1) (((poly1)>>27)&0x03)
330 #define POLY1_CULL_ENABLE(poly1) (((poly1)>>28)&0x01)
331 #define POLY1_TEXTURED(poly1) (((poly1)&0x02000000))
332 #define POLY1_SPECULAR(poly1) (((poly1)&0x01000000))
333 #define POLY1_GOURAUD_SHADED(poly1) ((poly1)&0x00800000)
334 #define POLY1_SHADE_MODEL(poly1) (((poly1)&0x00800000) ? GL_SMOOTH : GL_FLAT)
335 #define POLY1_UV16(poly1) (((poly1)&0x00400000))
336 #define POLY1_SINGLE_TILE(poly1) (((poly1)&0x00200000))
338 #define POLY2_SRC_BLEND(poly2) ( pvr2_poly_srcblend[(poly2) >> 29] )
339 #define POLY2_DEST_BLEND(poly2) ( pvr2_poly_dstblend[((poly2)>>26)&0x07] )
340 #define POLY2_SRC_BLEND_TARGET(poly2) ((poly2)&0x02000000)
341 #define POLY2_DEST_BLEND_TARGET(poly2) ((poly2)&0x01000000)
342 #define POLY2_FOG_MODE(poly2) ((poly2)&0x00C00000)
343 #define POLY2_COLOUR_CLAMP_ENABLE(poly2) ((poly2)&0x00200000)
344 #define POLY2_ALPHA_ENABLE(poly2) ((poly2)&0x00100000)
345 #define POLY2_TEX_ALPHA_ENABLE(poly2) (((poly2)&0x00080000) == 0 )
346 #define POLY2_TEX_MIRROR_U(poly2) ((poly2)&0x00040000)
347 #define POLY2_TEX_MIRROR_V(poly2) ((poly2)&0x00020000)
348 #define POLY2_TEX_CLAMP_U(poly2) ((poly2)&0x00010000)
349 #define POLY2_TEX_CLAMP_V(poly2) ((poly2)&0x00008000)
350 #define POLY2_TEX_WIDTH(poly2) ( 1<< ((((poly2) >> 3) & 0x07 ) + 3) )
351 #define POLY2_TEX_HEIGHT(poly2) ( 1<< (((poly2) & 0x07 ) + 3) )
352 #define POLY2_TEX_BLEND(poly2) (((poly2) >> 6)&0x03)
353 extern int pvr2_poly_depthmode[8];
354 extern int pvr2_poly_srcblend[8];
355 extern int pvr2_poly_dstblend[8];
356 extern int pvr2_poly_texblend[4];
357 extern int pvr2_render_colour_format[8];
359 #define CULL_NONE 0
360 #define CULL_SMALL 1
361 #define CULL_CCW 2
362 #define CULL_CW 3
364 #define SEGMENT_END 0x80000000
365 #define SEGMENT_ZCLEAR 0x40000000
366 #define SEGMENT_SORT_TRANS 0x20000000
367 #define SEGMENT_START 0x10000000
368 #define SEGMENT_X(c) (((c) >> 2) & 0x3F)
369 #define SEGMENT_Y(c) (((c) >> 8) & 0x3F)
370 #define NO_POINTER 0x80000000
371 #define IS_TILE_PTR(p) ( ((p)&NO_POINTER) == 0 )
372 #define IS_LAST_SEGMENT(s) (((s)->control) & SEGMENT_END)
374 struct tile_segment {
375 uint32_t control;
376 pvraddr_t opaque_ptr;
377 pvraddr_t opaquemod_ptr;
378 pvraddr_t trans_ptr;
379 pvraddr_t transmod_ptr;
380 pvraddr_t punchout_ptr;
381 };
383 #endif /* !lxdream_pvr2_H */
.