vdp.h

Go to the documentation of this file.

#ifndef _VDP_H_
#define _VDP_H_


#define GFX_DATA_PORT           0xC00000

#define GFX_CTRL_PORT           0xC00004

#define GFX_HVCOUNTER_PORT      0xC00008

#define VDP_FIFOEMPTY_FLAG      (1 << 9)

#define VDP_FIFOFULL_FLAG       (1 << 8)

#define VDP_VINTPENDING_FLAG    (1 << 7)

#define VDP_SPROVERFLOW_FLAG    (1 << 6)

#define VDP_SPRCOLLISION_FLAG   (1 << 5)

#define VDP_ODDFRAME_FLAG       (1 << 4)

#define VDP_VBLANK_FLAG         (1 << 3)

#define VDP_HBLANK_FLAG         (1 << 2)

#define VDP_DMABUSY_FLAG        (1 << 1)

#define VDP_PALMODE_FLAG        (1 << 0)

#define VDP_PLAN_A              VDP_BG_A

#define VDP_PLAN_B              VDP_BG_B

#define VDP_PLAN_WINDOW         VDP_WINDOW

#define VDP_BG_A                bga_addr

#define VDP_BG_B                bgb_addr

#define VDP_WINDOW              window_addr

#define VDP_HSCROLL_TABLE       hscrl_addr

#define VDP_SPRITE_TABLE        slist_addr

#define VDP_MAPS_START          maps_addr

#define HSCROLL_PLANE           0

#define HSCROLL_TILE            2

#define HSCROLL_LINE            3

#define VSCROLL_PLANE           0

#define VSCROLL_COLUMN          1

#define VSCROLL_2TILE           VSCROLL_COLUMN

#define INTERLACED_NONE         0

#define INTERLACED_MODE1        1

#define INTERLACED_MODE2        2

#define FONT_LEN    96

#define TILE_SIZE               32
#define TILE_INDEX_MASK         (0xFFFF / TILE_SIZE)

#define TILE_SPACE              VDP_MAPS_START

#define TILE_MAXNUM             (TILE_SPACE / TILE_SIZE)

#define TILE_MAXINDEX           (TILE_MAXNUM - 1)

#define TILE_SYSTEMINDEX        0x0000

#define TILE_SYSTEMLENGTH       16

#define TILE_SYSTEMLENGHT       TILE_SYSTEMLENGTH

#define TILE_USERINDEX          (TILE_SYSTEMINDEX + TILE_SYSTEMLENGTH)

#define TILE_FONTINDEX          (TILE_MAXNUM - FONT_LEN)

#define TILE_SPRITEINDEX        (TILE_FONTINDEX - spriteVramSize)

#define TILE_USERLENGTH         ((userTileMaxIndex - TILE_USERINDEX) + 1)

#define TILE_USERLENGHT         TILE_USERLENGTH

#define TILE_USERMAXINDEX       userTileMaxIndex

#define TILE_SYSTEM             (TILE_SYSTEMINDEX * TILE_SIZE)

#define TILE_USER               (TILE_USERINDEX * TILE_SIZE)

#define TILE_FONT               (TILE_FONTINDEX * TILE_SIZE)

#define PAL0                    0

#define PAL1                    1

#define PAL2                    2

#define PAL3                    3

#define GFX_READ_VRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))

#define GFX_READ_CRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x7F)) << 16) + 0x20)

#define GFX_READ_VSRAM_ADDR(adr)    (((0x0000 + ((adr) & 0x3F)) << 16) + 0x10)

#define GFX_WRITE_VRAM_ADDR(adr)    (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))

#define GFX_WRITE_CRAM_ADDR(adr)    (((0xC000 + ((adr) & 0x7F)) << 16) + 0x00)

#define GFX_WRITE_VSRAM_ADDR(adr)   (((0x4000 + ((adr) & 0x3F)) << 16) + 0x10)

#define GFX_DMA_VRAM_ADDR(adr)      (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x80))

#define GFX_DMA_CRAM_ADDR(adr)      (((0xC000 + ((adr) & 0x7F)) << 16) + 0x80)

#define GFX_DMA_VSRAM_ADDR(adr)     (((0x4000 + ((adr) & 0x3F)) << 16) + 0x90)

#define GFX_DMA_VRAMCOPY_ADDR(adr)  (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0xC0))

#define GFX_VERT_SCROLL(adr)        GFX_WRITE_VSRAM_ADDR(adr)

#define GFX_HORZ_SCROLL(adr)        GFX_WRITE_VRAM_ADDR(VDP_SCROLL_H + (adr))

#define GET_VDPSTATUS(flag)         ((*(vu16*)(GFX_CTRL_PORT)) & (flag))

#define IS_PALSYSTEM                GET_VDPSTATUS(VDP_PALMODE_FLAG)

#define GET_HVCOUNTER               (*(vu16*)(GFX_HVCOUNTER_PORT))

#define GET_HCOUNTER                (GET_HVCOUNTER & 0xFF)

#define GET_VCOUNTER                (GET_HVCOUNTER >> 8)


typedef enum
{
    BG_A = 0, BG_B = 1, WINDOW = 2
} VDPPlane;


// used by define
extern u16 window_addr;
extern u16 bga_addr;
extern u16 bgb_addr;
extern u16 hscrl_addr;
extern u16 slist_addr;
extern u16 maps_addr;
extern u16 userTileMaxIndex;

extern u16 screenWidth;
extern u16 screenHeight;
extern u16 planeWidth;
extern u16 planeHeight;
extern u16 windowWidth;
extern u16 planeWidthSft;
extern u16 planeHeightSft;
extern u16 windowWidthSft;


void VDP_init();

void VDP_resetScreen();

u8   VDP_getReg(u16 reg);
void VDP_setReg(u16 reg, u8 value);

u8   VDP_getEnable();
void VDP_setEnable(u8 value);

u16  VDP_getScanlineNumber();
u16  VDP_getScreenHeight();
void VDP_setScreenHeight224();
void VDP_setScreenHeight240();
u16  VDP_getScreenWidth();
void VDP_setScreenWidth256();
void VDP_setScreenWidth320();

u16  VDP_getPlaneWidth();
u16  VDP_getPlaneHeight();
void VDP_setPlaneSize(u16 w, u16 h, bool setupVram);
void VDP_setPlanSize(u16 w, u16 h);

u8 VDP_getHorizontalScrollingMode();
u8 VDP_getVerticalScrollingMode();
void VDP_setScrollingMode(u16 hscroll, u16 vscroll);

u8 VDP_getBackgroundColor();
void VDP_setBackgroundColor(u8 value);

u8   VDP_getAutoInc();
void VDP_setAutoInc(u8 value);

u8 VDP_getDMAEnabled();
void VDP_setDMAEnabled(u8 value);
u8 VDP_getHVLatching();
void VDP_setHVLatching(u8 value);
void VDP_setHInterrupt(u8 value);
void VDP_setExtInterrupt(u8 value);
void VDP_setHilightShadow(u8 value);

u8   VDP_getHIntCounter();
void VDP_setHIntCounter(u8 value);

u16 VDP_getBGAAddress();
u16 VDP_getBGBAddress();
u16 VDP_getAPlanAddress();
u16 VDP_getBPlanAddress();
u16 VDP_getWindowAddress();
u16 VDP_getWindowPlanAddress();
u16 VDP_getSpriteListAddress();
u16 VDP_getHScrollTableAddress();

void VDP_setBGAAddress(u16 value);
void VDP_setBGBAddress(u16 value);
void VDP_setAPlanAddress(u16 value);
void VDP_setBPlanAddress(u16 value);
void VDP_setWindowAddress(u16 value);
void VDP_setWindowPlanAddress(u16 value);
void VDP_setSpriteListAddress(u16 value);
void VDP_setHScrollTableAddress(u16 value);

void VDP_setScanMode(u16 mode);

void VDP_setWindowHPos(u16 right, u16 pos);
void VDP_setWindowVPos(u16 down, u16 pos);

void VDP_waitDMACompletion();
void VDP_waitFIFOEmpty();

bool VDP_waitVInt();
bool VDP_waitVBlank(bool forceNext);
bool VDP_waitVSync();
void VDP_waitVActive(bool forceNext);

u16 VDP_getAdjustedVCounter();

void VDP_showFPS(u16 asFloat);
void VDP_showCPULoad();


#endif // _VDP_H_