Search
lxdream.org :: lxdream/src/pvr2/pvr2.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/pvr2/pvr2.h
changeset 561:533f6b478071
prev545:fdcdcd8b9fd1
next635:76c63aac3590
next653:3202ff01d48e
author nkeynes
date Tue Jan 01 05:08:38 2008 +0000 (12 years ago)
branchlxdream-mmu
permissions -rw-r--r--
last change Enable Id keyword on all source files
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 #include "dream.h"
    20 #include "mem.h"
    21 #include "display.h"
    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 uint32_t pvr2_get_border_colour();
    70 gboolean pvr2_save_next_scene( const gchar *filename );
    72 #define PVR2_CMD_END_OF_LIST 0x00
    73 #define PVR2_CMD_USER_CLIP   0x20
    74 #define PVR2_CMD_POLY_OPAQUE 0x80
    75 #define PVR2_CMD_MOD_OPAQUE  0x81
    76 #define PVR2_CMD_POLY_TRANS  0x82
    77 #define PVR2_CMD_MOD_TRANS   0x83
    78 #define PVR2_CMD_POLY_PUNCHOUT 0x84
    79 #define PVR2_CMD_VERTEX      0xE0
    80 #define PVR2_CMD_VERTEX_LAST 0xF0
    82 #define PVR2_POLY_TEXTURED 0x00000008
    83 #define PVR2_POLY_SPECULAR 0x00000004
    84 #define PVR2_POLY_SHADED   0x00000002
    85 #define PVR2_POLY_UV_16BIT 0x00000001
    87 #define PVR2_POLY_MODE_CLAMP_RGB 0x00200000
    88 #define PVR2_POLY_MODE_ALPHA    0x00100000
    89 #define PVR2_POLY_MODE_TEXALPHA 0x00080000
    90 #define PVR2_POLY_MODE_FLIP_S   0x00040000
    91 #define PVR2_POLY_MODE_FLIP_T   0x00020000
    92 #define PVR2_POLY_MODE_CLAMP_S  0x00010000
    93 #define PVR2_POLY_MODE_CLAMP_T  0x00008000
    95 #define PVR2_POLY_FOG_LOOKUP    0x00000000
    96 #define PVR2_POLY_FOG_VERTEX    0x00400000
    97 #define PVR2_POLY_FOG_DISABLED  0x00800000
    98 #define PVR2_POLY_FOG_LOOKUP2   0x00C00000
   101 #define PVR2_TEX_FORMAT_ARGB1555 0x00000000
   102 #define PVR2_TEX_FORMAT_RGB565   0x08000000
   103 #define PVR2_TEX_FORMAT_ARGB4444 0x10000000
   104 #define PVR2_TEX_FORMAT_YUV422   0x18000000
   105 #define PVR2_TEX_FORMAT_BUMPMAP  0x20000000
   106 #define PVR2_TEX_FORMAT_IDX4     0x28000000
   107 #define PVR2_TEX_FORMAT_IDX8     0x30000000
   109 #define PVR2_TEX_MIPMAP      0x80000000
   110 #define PVR2_TEX_COMPRESSED  0x40000000
   111 #define PVR2_TEX_FORMAT_MASK 0x38000000
   112 #define PVR2_TEX_UNTWIDDLED  0x04000000
   113 #define PVR2_TEX_STRIDE      0x02000000
   114 #define PVR2_TEX_IS_PALETTE(mode) ( (mode & PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX4 || (mode&PVR2_TEX_FORMAT_MASK) == PVR2_TEX_FORMAT_IDX8 )
   117 #define PVR2_TEX_ADDR(x) ( ((x)&0x01FFFFF)<<3 );
   118 #define PVR2_TEX_IS_MIPMAPPED(x) ( ((x) & 0x84000000) == 0x80000000 )
   119 #define PVR2_TEX_IS_COMPRESSED(x) ( (x) & PVR2_TEX_COMPRESSED )
   120 #define PVR2_TEX_IS_TWIDDLED(x) (((x) & PVR2_TEX_UNTWIDDLED) == 0)
   121 #define PVR2_TEX_IS_STRIDE(x) (((x) & 0x06000000) == 0x06000000)
   123 /****************************** Frame Buffer *****************************/
   125 /**
   126  * Write a block of data to an address in the DMA range (0x10000000 - 
   127  * 0x13FFFFFF), ie TA, YUV, or texture ram.
   128  */
   129 void pvr2_dma_write( sh4addr_t dest, unsigned char *src, uint32_t length );
   131 /**
   132  * Write to the interleaved memory address space (aka 64-bit address space).
   133  */
   134 void pvr2_vram64_write( sh4addr_t dest, unsigned char *src, uint32_t length );
   136 /**
   137  * Write to the interleaved memory address space (aka 64-bit address space),
   138  * using a line length and stride.
   139  */
   140 void pvr2_vram64_write_stride( sh4addr_t dest, unsigned char *src, uint32_t line_bytes,
   141 			       uint32_t line_stride_bytes, uint32_t line_count );
   143 /**
   144  * Read from the interleaved memory address space (aka 64-bit address space)
   145  */
   146 void pvr2_vram64_read( unsigned char *dest, sh4addr_t src, uint32_t length );
   148 /**
   149  * Read a twiddled image from interleaved memory address space (aka 64-bit address
   150  * space), writing the image to the destination buffer in detwiddled format. 
   151  * Width and height must be powers of 2
   152  * This version reads 4-bit pixels.
   153  */
   154 void pvr2_vram64_read_twiddled_4( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
   157 /**
   158  * Read a twiddled image from interleaved memory address space (aka 64-bit address
   159  * space), writing the image to the destination buffer in detwiddled format. 
   160  * Width and height must be powers of 2
   161  * This version reads 8-bit pixels.
   162  */
   163 void pvr2_vram64_read_twiddled_8( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
   165 /**
   166  * Read a twiddled image from interleaved memory address space (aka 64-bit address
   167  * space), writing the image to the destination buffer in detwiddled format. 
   168  * Width and height must be powers of 2, and src must be 16-bit aligned.
   169  * This version reads 16-bit pixels.
   170  */
   171 void pvr2_vram64_read_twiddled_16( unsigned char *dest, sh4addr_t src, uint32_t width, uint32_t height );
   173 /**
   174  * Read an image from the interleaved memory address space (aka 64-bit address space) 
   175  * where the source and destination line sizes may differ. Note that both byte
   176  * counts must be a multiple of 4, and the src address must be 32-bit aligned.
   177  */
   178 void pvr2_vram64_read_stride( unsigned char *dest, uint32_t dest_line_bytes, sh4addr_t srcaddr,
   179 			       uint32_t src_line_bytes, uint32_t line_count );
   180 /**
   181  * Dump a portion of vram to a stream from the interleaved memory address 
   182  * space.
   183  */
   184 void pvr2_vram64_dump( sh4addr_t addr, uint32_t length, FILE *f );
   186 /**
   187  * Flush the indicated render buffer back to PVR. Caller is responsible for
   188  * tracking whether there is actually anything in the buffer.
   189  *
   190  * @param buffer A render buffer indicating the address to store to, and the
   191  * format the data needs to be in.
   192  * @param backBuffer TRUE to flush the back buffer, FALSE for 
   193  * the front buffer.
   194  */
   195 void pvr2_render_buffer_copy_to_sh4( render_buffer_t buffer );
   197 /**
   198  * Invalidate any caching on the supplied SH4 address
   199  */
   200 gboolean pvr2_render_buffer_invalidate( sh4addr_t addr, gboolean isWrite );
   203 /**************************** Tile Accelerator ***************************/
   204 /**
   205  * Process the data in the supplied buffer as an array of TA command lists.
   206  * Any excess bytes are held pending until a complete list is sent
   207  */
   208 void pvr2_ta_write( unsigned char *buf, uint32_t length );
   211 /**
   212  * (Re)initialize the tile accelerator in preparation for the next scene.
   213  * Normally called immediately before commencing polygon transmission.
   214  */
   215 void pvr2_ta_init( void );
   217 void pvr2_ta_reset( void );
   219 void pvr2_ta_save_state( FILE *f );
   221 int pvr2_ta_load_state( FILE *f );
   223 /****************************** YUV Converter ****************************/
   225 /**
   226  * Process a block of YUV data.
   227  */
   228 void pvr2_yuv_write( unsigned char *buf, uint32_t length );
   230 /**
   231  * Initialize the YUV converter.
   232  */
   233 void pvr2_yuv_init( uint32_t target_addr );
   235 void pvr2_yuv_set_config( uint32_t config );
   237 void pvr2_yuv_save_state( FILE *f );
   239 int pvr2_yuv_load_state( FILE *f );
   241 /********************************* Renderer ******************************/
   243 /**
   244  * Render the current scene stored in PVR ram to the GL back buffer.
   245  */
   246 void pvr2_render_scene( render_buffer_t buffer );
   248 /**
   249  * Display the scene rendered to the supplied address.
   250  * @return TRUE if there was an available render that was displayed,
   251  * otherwise FALSE (and no action was taken)
   252  */
   253 gboolean pvr2_render_display_frame( uint32_t address );
   256 void render_backplane( uint32_t *polygon, uint32_t width, uint32_t height, uint32_t mode );
   258 void render_set_context( uint32_t *context, int render_mode );
   260 void pvr2_render_tilebuffer( int width, int height, int clipx1, int clipy1, 
   261 			     int clipx2, int clipy2 );
   263 float pvr2_render_find_maximum_z();
   265 void pvr2_render_getsize( int *x, int *y );
   267 /**
   268  * Structure to hold a complete unpacked vertex (excluding modifier
   269  * volume parameters - generate separate vertexes in that case).
   270  */
   271 struct vertex_unpacked {
   272     float x,y,z;
   273     float u,v;            /* Texture coordinates */
   274     float rgba[4];        /* Fragment colour (RGBA order) */
   275     float offset_rgba[4]; /* Offset color (RGBA order) */
   276 };
   278 void render_unpack_quad( struct vertex_unpacked *unpacked, uint32_t poly1,
   279                          uint32_t *vertexes, int vertex_size,
   280                          int render_mode );
   282 void render_unpack_vertexes( struct vertex_unpacked *out, uint32_t poly1,
   283                              uint32_t *vertexes, int num_vertexes,
   284                              int vertex_size, int render_mode );
   286 void render_unpacked_vertex_array( uint32_t poly1, struct vertex_unpacked *vertexes[], 
   287 				   int num_vertexes );
   289 void render_vertex_array( uint32_t poly1, uint32_t *vertexes[], int num_vertexes, 
   290 			  int vertex_size, int render_mode );
   292 void render_tile( pvraddr_t tile_entry, int render_mode, gboolean cheap_modifier_mode );
   294 void render_autosort_tile( pvraddr_t tile_entry, int render_mode, gboolean cheap_modifier_mode );
   297 /****************************** Texture Cache ****************************/
   299 /**
   300  * Initialize the texture cache.
   301  */
   302 void texcache_init( void );
   304 /**
   305  * Initialize the GL side of the texture cache (texture ids and such).
   306  */
   307 void texcache_gl_init( void );
   309 /**
   310  * Flush all textures and delete. The cache will be non-functional until
   311  * the next call to texcache_init(). This would typically be done if
   312  * switching GL targets.
   313  */    
   314 void texcache_shutdown( void );
   316 /**
   317  * Flush (ie free) all textures.
   318  */
   319 void texcache_flush( void );
   321 /**
   322  * Flush all palette-based textures (if any)
   323  */
   324 void texcache_invalidate_palette(void);
   326 /**
   327  * Evict all textures contained in the page identified by a texture address.
   328  */
   329 void texcache_invalidate_page( uint32_t texture_addr );
   331 /**
   332  * Return a texture ID for the texture specified at the supplied address
   333  * and given parameters (the same sequence of bytes could in theory have
   334  * multiple interpretations). We use the texture address as the primary
   335  * index, but allow for multiple instances at each address. The texture
   336  * will be bound to the GL_TEXTURE_2D target before being returned.
   337  * 
   338  * If the texture has already been bound, return the ID to which it was
   339  * bound. Otherwise obtain an unused texture ID and set it up appropriately.
   340  */
   341 GLuint texcache_get_texture( uint32_t texture_addr, int width, int height,
   342 			     int mode );
   344 void pvr2_check_palette_changed(void);
   346 int pvr2_render_save_scene( const gchar *filename );
   349 /************************* Rendering support macros **************************/
   350 #define POLY1_DEPTH_MODE(poly1) ( pvr2_poly_depthmode[(poly1)>>29] )
   351 #define POLY1_DEPTH_ENABLE(poly1) (((poly1)&0x04000000) == 0 )
   352 #define POLY1_CULL_MODE(poly1) (((poly1)>>27)&0x03)
   353 #define POLY1_TEXTURED(poly1) (((poly1)&0x02000000))
   354 #define POLY1_SPECULAR(poly1) (((poly1)&0x01000000))
   355 #define POLY1_GOURAUD_SHADED(poly1) ((poly1)&0x00800000)
   356 #define POLY1_SHADE_MODEL(poly1) (((poly1)&0x00800000) ? GL_SMOOTH : GL_FLAT)
   357 #define POLY1_UV16(poly1)   (((poly1)&0x00400000))
   358 #define POLY1_SINGLE_TILE(poly1) (((poly1)&0x00200000))
   360 #define POLY2_SRC_BLEND(poly2) ( pvr2_poly_srcblend[(poly2) >> 29] )
   361 #define POLY2_DEST_BLEND(poly2) ( pvr2_poly_dstblend[((poly2)>>26)&0x07] )
   362 #define POLY2_SRC_BLEND_TARGET(poly2)    ((poly2)&0x02000000)
   363 #define POLY2_DEST_BLEND_TARGET(poly2)   ((poly2)&0x01000000)
   364 #define POLY2_FOG_MODE(poly2)            ((poly2)&0x00C00000)
   365 #define POLY2_COLOUR_CLAMP_ENABLE(poly2) ((poly2)&0x00200000)
   366 #define POLY2_ALPHA_ENABLE(poly2)        ((poly2)&0x00100000)
   367 #define POLY2_TEX_ALPHA_ENABLE(poly2)   (((poly2)&0x00080000) == 0 )
   368 #define POLY2_TEX_CLAMP_U(poly2)         ((poly2)&0x00010000)
   369 #define POLY2_TEX_CLAMP_V(poly2)         ((poly2)&0x00008000)
   370 #define POLY2_TEX_WIDTH(poly2) ( 1<< ((((poly2) >> 3) & 0x07 ) + 3) )
   371 #define POLY2_TEX_HEIGHT(poly2) ( 1<< (((poly2) & 0x07 ) + 3) )
   372 #define POLY2_TEX_BLEND(poly2) (((poly2) >> 6)&0x03)
   373 extern int pvr2_poly_depthmode[8];
   374 extern int pvr2_poly_srcblend[8];
   375 extern int pvr2_poly_dstblend[8];
   376 extern int pvr2_poly_texblend[4];
   377 extern int pvr2_render_colour_format[8];
   379 float halftofloat(uint16_t half);
.