superfx.h

Go to the documentation of this file.

 
#ifndef SNES_SUPERFX_H
#define SNES_SUPERFX_H
 
#include <snes/types.h>
 
/*============================================================================
 * GSU Register Definitions ($3000-$303F)
 *============================================================================*/
 
#define REG_GSU_R0     (*(volatile u16*)0x3000)
#define REG_GSU_R1     (*(volatile u16*)0x3002)
#define REG_GSU_R2     (*(volatile u16*)0x3004)
#define REG_GSU_R3     (*(volatile u16*)0x3006)
#define REG_GSU_R4     (*(volatile u16*)0x3008)
#define REG_GSU_R5     (*(volatile u16*)0x300A)
#define REG_GSU_R6     (*(volatile u16*)0x300C)
#define REG_GSU_R7     (*(volatile u16*)0x300E)
#define REG_GSU_R8     (*(volatile u16*)0x3010)
#define REG_GSU_R9     (*(volatile u16*)0x3012)
#define REG_GSU_R10    (*(volatile u16*)0x3014)
#define REG_GSU_R11    (*(volatile u16*)0x3016)
#define REG_GSU_R12    (*(volatile u16*)0x3018)
#define REG_GSU_R13    (*(volatile u16*)0x301A)
#define REG_GSU_R14    (*(volatile u16*)0x301C)
#define REG_GSU_R15    (*(volatile u16*)0x301E)
 
#define REG_SFR        (*(volatile u16*)0x3030)
#define REG_SFR_L      (*(volatile u8*)0x3030)
#define SFR_GO         0x20
 
#define REG_BRAMR      (*(volatile u8*)0x3033)
#define REG_PBR        (*(volatile u8*)0x3034)
#define REG_CFGR       (*(volatile u8*)0x3037)
#define REG_ROMBR      (*(volatile u8*)0x3036)
#define REG_SCBR       (*(volatile u8*)0x3038)
#define REG_CLSR       (*(volatile u8*)0x3039)
#define REG_SCMR       (*(volatile u8*)0x303A)
#define REG_VCR        (*(volatile u8*)0x303B)
#define REG_RAMBR      (*(volatile u8*)0x303C)
#define REG_CBR        (*(volatile u16*)0x303E)
 
#define CLSR_10MHZ     0x00
#define CLSR_21MHZ     0x01
 
#define SCMR_2BPP      0x00
#define SCMR_4BPP      0x01
#define SCMR_8BPP      0x03
#define SCMR_RAN       0x08
#define SCMR_RON       0x10
#define SCMR_H128      0x00
#define SCMR_H160      0x04
#define SCMR_H192      0x20
 
#define CFGR_IRQ_MASK  0x80   
#define CFGR_FAST_MUL  0x20   
 
#define GSU_SRAM_BASE  0x700000
 
/*============================================================================
 * Library Configuration Variables (defined in lib/source/superfx.asm)
 * Set these BEFORE calling gsuLaunch().
 *============================================================================*/

extern u8 gsu_prog_bank;

extern u16 gsu_prog_addr;

extern u8 gsu_cfgr;

extern u8 gsu_scmr;

extern u8 gsu_scbr;

extern u8 gsu_dma_src_hi;

extern u8 superfx_status;

extern volatile u8 gsu_stop_irqs;

extern u8 gsu_owns_cart;

extern u8 gsu_scmr_live;
 
 
/*============================================================================
 * API Functions
 *============================================================================*/

inline u8 gsuIsPresent(void) {
    return superfx_status != 0;
}

inline u8 gsuInit(void) {
    gsu_cfgr = 0x80;        /* IRQ mask, no fast multiply */
    gsu_scmr = 0x19;        /* 4bpp + RAN + RON (most common for PLOT) */
    gsu_scbr = 0x00;        /* Buffer A */
    gsu_dma_src_hi = 0x00;  /* DMA from buffer A */
    return superfx_status != 0;
}

void gsuSetProgram(const void *program);

extern void gsuLaunch(void);

void gsuCall(u16 entry);


void gsuCacheLoad(const void *code, u16 size);

void gsuStartCached(u16 pc);

u8 gsuBusy(void);

void gsuWait(void);



u16 gsuFrameBytes(void);

#define GSU_PRESENT_ON_LAG_FRAMES 0x01

u8 gsuPresentInit(u16 vram_a, u16 vram_b, u8 flags);

void gsuPresent(void);

u8 gsuPresentBusy(void);

void gsuPresentWait(void);


extern void gsuSetupBitmapTilemap(u16 vramAddr);

extern void gsuDmaFullFrame(void);

extern void gsuSetupHdmaBlanking(u16 topBlank, u16 bottomBlank);
 
#endif /* SNES_SUPERFX_H */