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