2 * $Id: pvr2.h,v 1.38 2007-10-31 12:05:23 nkeynes Exp $
4 * PVR2 (video chip) functions and macros.
6 * Copyright (c) 2005 Nathan Keynes.
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.
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.
22 #include "pvr2/pvr2mmio.h"
24 typedef unsigned int pvraddr_t;
25 typedef unsigned int pvr64addr_t;
27 #define DISPMODE_ENABLE 0x00000001 /* Display enable */
28 #define DISPMODE_LINEDOUBLE 0x00000002 /* scanline double */
29 #define DISPMODE_COLFMT 0x0000000C /* Colour mode */
30 #define DISPMODE_CLOCKDIV 0x08000000 /* Clock divide-by-2 */
32 #define DISPSIZE_MODULO 0x3FF00000 /* line skip +1 (32-bit words)*/
33 #define DISPSIZE_LPF 0x000FFC00 /* lines per field */
34 #define DISPSIZE_PPL 0x000003FF /* pixel words (32 bit) per line */
36 #define DISPCFG_VP 0x00000001 /* V-sync polarity */
37 #define DISPCFG_HP 0x00000002 /* H-sync polarity */
38 #define DISPCFG_I 0x00000010 /* Interlace enable */
39 #define DISPCFG_BS 0x000000C0 /* Broadcast standard */
40 #define DISPCFG_VO 0x00000100 /* Video output enable */
42 #define DISPSYNC_LINE_MASK 0x000003FF
43 #define DISPSYNC_EVEN_FIELD 0x00000000
44 #define DISPSYNC_ODD_FIELD 0x00000400
45 #define DISPSYNC_ACTIVE 0x00000800
46 #define DISPSYNC_HSYNC 0x00001000
47 #define DISPSYNC_VSYNC 0x00002000
49 #define BS_NTSC 0x00000000
50 #define BS_PAL 0x00000040
51 #define BS_PALM 0x00000080 /* ? */
52 #define BS_PALN 0x000000C0 /* ? */
54 #define PVR2_RAM_BASE 0x05000000
55 #define PVR2_RAM_BASE_INT 0x04000000
56 #define PVR2_RAM_SIZE (8 * 1024 * 1024)
57 #define PVR2_RAM_PAGES (PVR2_RAM_SIZE>>12)
58 #define PVR2_RAM_MASK 0x7FFFFF
60 #define RENDER_ZONLY 0
61 #define RENDER_NORMAL 1 /* Render non-modified polygons */
62 #define RENDER_CHEAPMOD 2 /* Render cheap-modified polygons */
63 #define RENDER_FULLMOD 3 /* Render the fully-modified version of the polygons */
65 void pvr2_next_frame( void );
66 void pvr2_set_base_address( uint32_t );
67 int pvr2_get_frame_count( void );
68 render_buffer_t pvr2_get_front_buffer();
69 gboolean pvr2_save_next_scene( const gchar *filename );
71 #define PVR2_CMD_END_OF_LIST 0x00
72 #define PVR2_CMD_USER_CLIP 0x20
73 #define PVR2_CMD_POLY_OPAQUE 0x80
74 #define PVR2_CMD_MOD_OPAQUE 0x81
75 #define PVR2_CMD_POLY_TRANS 0x82
76 #define PVR2_CMD_MOD_TRANS 0x83
77 #define PVR2_CMD_POLY_PUNCHOUT 0x84
78 #define PVR2_CMD_VERTEX 0xE0
79 #define PVR2_CMD_VERTEX_LAST 0xF0
81 #define PVR2_POLY_TEXTURED 0x00000008
82 #define PVR2_POLY_SPECULAR 0x00000004
83 #define PVR2_POLY_SHADED 0x00000002
84 #define PVR2_POLY_UV_16BIT 0x00000001
86 #define PVR2_POLY_MODE_CLAMP_RGB 0x00200000
87 #define PVR2_POLY_MODE_ALPHA 0x00100000
88 #define PVR2_POLY_MODE_TEXALPHA 0x00080000
89 #define PVR2_POLY_MODE_FLIP_S 0x00040000
90 #define PVR2_POLY_MODE_FLIP_T 0x00020000
91 #define PVR2_POLY_MODE_CLAMP_S 0x00010000
92 #define PVR2_POLY_MODE_CLAMP_T 0x00008000
94 #define PVR2_POLY_FOG_LOOKUP 0x00000000
95 #define PVR2_POLY_FOG_VERTEX 0x00400000
96 #define PVR2_POLY_FOG_DISABLED 0x00800000
97 #define PVR2_POLY_FOG_LOOKUP2 0x00C00000
100 #define PVR2_TEX_FORMAT_ARGB1555 0x00000000
101 #define PVR2_TEX_FORMAT_RGB565 0x08000000
102 #define PVR2_TEX_FORMAT_ARGB4444 0x10000000
103 #define PVR2_TEX_FORMAT_YUV422 0x18000000
104 #define PVR2_TEX_FORMAT_BUMPMAP 0x20000000
105 #define PVR2_TEX_FORMAT_IDX4 0x28000000
106 #define PVR2_TEX_FORMAT_IDX8 0x30000000
108 #define PVR2_TEX_MIPMAP 0x80000000
109 #define PVR2_TEX_COMPRESSED 0x40000000
110 #define PVR2_TEX_FORMAT_MASK 0x38000000
111 #define PVR2_TEX_UNTWIDDLED 0x04000000
112 #define PVR2_TEX_STRIDE 0x02000000
113 #define PVR2_TEX_IS_PALETTE(mode) ( (mode & PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX4 || (mode&PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX8 )
116 #define PVR2_TEX_ADDR(x) ( ((x)&0x01FFFFF)<<3 );
117 #define PVR2_TEX_IS_MIPMAPPED(x) ( ((x) & 0x84000000) == 0x80000000 )
118 #define PVR2_TEX_IS_COMPRESSED(x) ( (x) & PVR2_TEX_COMPRESSED )
119 #define PVR2_TEX_IS_TWIDDLED(x) (((x) & PVR2_TEX_UNTWIDDLED) == 0)
120 #define PVR2_TEX_IS_STRIDE(x) (((x) & 0x06000000) == 0x06000000)
122 /****************************** Frame Buffer *****************************/
125 * Write a block of data to an address in the DMA range (0x10000000 -
126 * 0x13FFFFFF), ie TA, YUV, or texture ram.
128 void pvr2_dma_write( sh4addr_t dest, unsigned char *src, uint32_t length );
131 * Write to the interleaved memory address space (aka 64-bit address space).
133 void pvr2_vram64_write( sh4addr_t dest, unsigned char *src, uint32_t length );
136 * Write to the interleaved memory address space (aka 64-bit address space),
137 * using a line length and stride.
139 void pvr2_vram64_write_stride( sh4addr_t dest, unsigned char *src, uint32_t line_bytes,
140 uint32_t line_stride_bytes, uint32_t line_count );
143 * Read from the interleaved memory address space (aka 64-bit address space)
145 void pvr2_vram64_read( unsigned char *dest, sh4addr_t src, uint32_t length );
148 * Read a twiddled image from interleaved memory address space (aka 64-bit address
149 * space), writing the image to the destination buffer in detwiddled format.
150 * Width and height must be powers of 2
151 * This version reads 4-bit pixels.
153 void pvr2_vram64_read_twiddled_4( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
157 * Read a twiddled image from interleaved memory address space (aka 64-bit address
158 * space), writing the image to the destination buffer in detwiddled format.
159 * Width and height must be powers of 2
160 * This version reads 8-bit pixels.
162 void pvr2_vram64_read_twiddled_8( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
165 * Read a twiddled image from interleaved memory address space (aka 64-bit address
166 * space), writing the image to the destination buffer in detwiddled format.
167 * Width and height must be powers of 2, and src must be 16-bit aligned.
168 * This version reads 16-bit pixels.
170 void pvr2_vram64_read_twiddled_16( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
173 * Read an image from the interleaved memory address space (aka 64-bit address space)
174 * where the source and destination line sizes may differ. Note that both byte
175 * counts must be a multiple of 4, and the src address must be 32-bit aligned.
177 void pvr2_vram64_read_stride( unsigned char *dest, uint32_t dest_line_bytes, sh4addr_t srcaddr,
178 uint32_t src_line_bytes, uint32_t line_count );
180 * Dump a portion of vram to a stream from the interleaved memory address
183 void pvr2_vram64_dump( sh4addr_t addr, uint32_t length, FILE *f );
186 * Flush the indicated render buffer back to PVR. Caller is responsible for
187 * tracking whether there is actually anything in the buffer.
189 * @param buffer A render buffer indicating the address to store to, and the
190 * format the data needs to be in.
191 * @param backBuffer TRUE to flush the back buffer, FALSE for
194 void pvr2_render_buffer_copy_to_sh4( render_buffer_t buffer );
197 * Invalidate any caching on the supplied SH4 address
199 gboolean pvr2_render_buffer_invalidate( sh4addr_t addr, gboolean isWrite );
202 /**************************** Tile Accelerator ***************************/
204 * Process the data in the supplied buffer as an array of TA command lists.
205 * Any excess bytes are held pending until a complete list is sent
207 void pvr2_ta_write( unsigned char *buf, uint32_t length );
211 * (Re)initialize the tile accelerator in preparation for the next scene.
212 * Normally called immediately before commencing polygon transmission.
214 void pvr2_ta_init( void );
216 void pvr2_ta_reset( void );
218 void pvr2_ta_save_state( FILE *f );
220 int pvr2_ta_load_state( FILE *f );
222 /****************************** YUV Converter ****************************/
225 * Process a block of YUV data.
227 void pvr2_yuv_write( unsigned char *buf, uint32_t length );
230 * Initialize the YUV converter.
232 void pvr2_yuv_init( uint32_t target_addr );
234 void pvr2_yuv_set_config( uint32_t config );
236 void pvr2_yuv_save_state( FILE *f );
238 int pvr2_yuv_load_state( FILE *f );
240 /********************************* Renderer ******************************/
243 * Render the current scene stored in PVR ram to the GL back buffer.
245 void pvr2_render_scene( render_buffer_t buffer );
248 * Display the scene rendered to the supplied address.
249 * @return TRUE if there was an available render that was displayed,
250 * otherwise FALSE (and no action was taken)
252 gboolean pvr2_render_display_frame( uint32_t address );
255 void render_backplane( uint32_t *polygon, uint32_t width, uint32_t height, uint32_t mode );
257 void render_set_context( uint32_t *context, int render_mode );
259 void pvr2_render_tilebuffer( int width, int height, int clipx1, int clipy1,
260 int clipx2, int clipy2 );
262 float pvr2_render_find_maximum_z();
264 void pvr2_render_getsize( int *x, int *y );
267 * Structure to hold a complete unpacked vertex (excluding modifier
268 * volume parameters - generate separate vertexes in that case).
270 struct vertex_unpacked {
272 float u,v; /* Texture coordinates */
273 float rgba[4]; /* Fragment colour (RGBA order) */
274 float offset_rgba[4]; /* Offset color (RGBA order) */
277 void render_unpack_quad( struct vertex_unpacked *unpacked, uint32_t poly1,
278 uint32_t *vertexes, int vertex_size,
281 void render_unpack_vertexes( struct vertex_unpacked *out, uint32_t poly1,
282 uint32_t *vertexes, int num_vertexes,
283 int vertex_size, int render_mode );
285 void render_unpacked_vertex_array( uint32_t poly1, struct vertex_unpacked *vertexes[],
288 void render_vertex_array( uint32_t poly1, uint32_t *vertexes[], int num_vertexes,
289 int vertex_size, int render_mode );
291 void render_tile( pvraddr_t tile_entry, int render_mode, gboolean cheap_modifier_mode );
293 void render_autosort_tile( pvraddr_t tile_entry, int render_mode, gboolean cheap_modifier_mode );
296 /****************************** Texture Cache ****************************/
299 * Initialize the texture cache.
301 void texcache_init( void );
304 * Initialize the GL side of the texture cache (texture ids and such).
306 void texcache_gl_init( void );
309 * Flush all textures and delete. The cache will be non-functional until
310 * the next call to texcache_init(). This would typically be done if
311 * switching GL targets.
313 void texcache_shutdown( void );
316 * Flush (ie free) all textures.
318 void texcache_flush( void );
321 * Flush all palette-based textures (if any)
323 void texcache_invalidate_palette(void);
326 * Evict all textures contained in the page identified by a texture address.
328 void texcache_invalidate_page( uint32_t texture_addr );
331 * Return a texture ID for the texture specified at the supplied address
332 * and given parameters (the same sequence of bytes could in theory have
333 * multiple interpretations). We use the texture address as the primary
334 * index, but allow for multiple instances at each address. The texture
335 * will be bound to the GL_TEXTURE_2D target before being returned.
337 * If the texture has already been bound, return the ID to which it was
338 * bound. Otherwise obtain an unused texture ID and set it up appropriately.
340 GLuint texcache_get_texture( uint32_t texture_addr, int width, int height,
343 void pvr2_check_palette_changed(void);
345 int pvr2_render_save_scene( const gchar *filename );
348 /************************* Rendering support macros **************************/
349 #define POLY1_DEPTH_MODE(poly1) ( pvr2_poly_depthmode[(poly1)>>29] )
350 #define POLY1_DEPTH_ENABLE(poly1) (((poly1)&0x04000000) == 0 )
351 #define POLY1_CULL_MODE(poly1) (((poly1)>>27)&0x03)
352 #define POLY1_TEXTURED(poly1) (((poly1)&0x02000000))
353 #define POLY1_SPECULAR(poly1) (((poly1)&0x01000000))
354 #define POLY1_GOURAUD_SHADED(poly1) ((poly1)&0x00800000)
355 #define POLY1_SHADE_MODEL(poly1) (((poly1)&0x00800000) ? GL_SMOOTH : GL_FLAT)
356 #define POLY1_UV16(poly1) (((poly1)&0x00400000))
357 #define POLY1_SINGLE_TILE(poly1) (((poly1)&0x00200000))
359 #define POLY2_SRC_BLEND(poly2) ( pvr2_poly_srcblend[(poly2) >> 29] )
360 #define POLY2_DEST_BLEND(poly2) ( pvr2_poly_dstblend[((poly2)>>26)&0x07] )
361 #define POLY2_SRC_BLEND_TARGET(poly2) ((poly2)&0x02000000)
362 #define POLY2_DEST_BLEND_TARGET(poly2) ((poly2)&0x01000000)
363 #define POLY2_FOG_MODE(poly2) ((poly2)&0x00C00000)
364 #define POLY2_COLOUR_CLAMP_ENABLE(poly2) ((poly2)&0x00200000)
365 #define POLY2_ALPHA_ENABLE(poly2) ((poly2)&0x00100000)
366 #define POLY2_TEX_ALPHA_ENABLE(poly2) (((poly2)&0x00080000) == 0 )
367 #define POLY2_TEX_CLAMP_U(poly2) ((poly2)&0x00010000)
368 #define POLY2_TEX_CLAMP_V(poly2) ((poly2)&0x00008000)
369 #define POLY2_TEX_WIDTH(poly2) ( 1<< ((((poly2) >> 3) & 0x07 ) + 3) )
370 #define POLY2_TEX_HEIGHT(poly2) ( 1<< (((poly2) & 0x07 ) + 3) )
371 #define POLY2_TEX_BLEND(poly2) (((poly2) >> 6)&0x03)
372 extern int pvr2_poly_depthmode[8];
373 extern int pvr2_poly_srcblend[8];
374 extern int pvr2_poly_dstblend[8];
375 extern int pvr2_poly_texblend[4];
376 extern int pvr2_render_colour_format[8];
378 float halftofloat(uint16_t half);
.