vdp.h

Go to the documentation of this file.

#ifndef _VDP_H_
#define _VDP_H_


#define VDP_DATA_PORT           0xC00000

#define VDP_CTRL_PORT           0xC00004

#define VDP_HVCOUNTER_PORT      0xC00008

#define GFX_DATA_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_DATA_PORT instead.\"")

#define GFX_CTRL_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_CTRL_PORT instead.\"")

#define GFX_HVCOUNTER_PORT      _Pragma("GCC error \"This definition is deprecated, use VDP_HVCOUNTER_PORT instead.\"")


#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              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_A instead.\"")

#define VDP_PLAN_B              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_B instead.\"")

#define VDP_PLAN_WINDOW         _Pragma("GCC error \"This definition is deprecated, use VDP_WINDOW instead.\"")

#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           _Pragma("GCC error \"This definition is deprecated, use VSCROLL_COLUMN instead.\"")

#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_MAX_NUM            (TILE_SPACE / TILE_SIZE)

#define TILE_MAX_INDEX          (TILE_MAXNUM - 1)

#define TILE_SYSTEM_INDEX       0x0000

#define TILE_SYSTEM_LENGTH      16

#define TILE_USER_INDEX         (TILE_SYSTEM_INDEX + TILE_SYSTEM_LENGTH)

#define TILE_FONT_INDEX         (TILE_MAX_NUM - FONT_LEN)

#define TILE_SPRITE_INDEX       (TILE_FONT_INDEX - spriteVramSize)

#define TILE_USER_LENGTH        ((userTileMaxIndex - TILE_USER_INDEX) + 1)

#define TILE_USER_MAX_INDEX     userTileMaxIndex

#define TILE_MAXNUM             _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_NUM instead.\"")

#define TILE_MAXINDEX           _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_INDEX instead.\"")

#define TILE_SYSTEM_LENGHT      _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")

#define TILE_SYSTEMLENGTH       _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")

#define TILE_SYSTEMINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_INDEX instead.\"")

#define TILE_USERINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_USER_INDEX instead.\"")

#define TILE_FONTINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_FONT_INDEX instead.\"")

#define TILE_SPRITEINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SPRITE_INDEX instead.\"")

#define TILE_USERLENGTH         _Pragma("GCC error \"This definition is deprecated, use TILE_USER_LENGTH instead.\"")

#define TILE_USERMAXINDEX       _Pragma("GCC error \"This definition is deprecated, use TILE_USER_MAX_INDEX instead.\"")

#define TILE_SYSTEM             (TILE_SYSTEM_INDEX * TILE_SIZE)

#define TILE_USER               (TILE_USER_INDEX * TILE_SIZE)

#define TILE_FONT               (TILE_FONT_INDEX * TILE_SIZE)

#define PAL0                    0

#define PAL1                    1

#define PAL2                    2

#define PAL3                    3

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

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

#define VDP_READ_VSRAM_ADDR(adr)    (((0x0000 + ((adr) & 0x7F)) << 16) + 0x10)

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

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

#define VDP_WRITE_VSRAM_ADDR(adr)   (((0x4000 + ((adr) & 0x7F)) << 16) + 0x10)

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

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

#define VDP_DMA_VSRAM_ADDR(adr)     (((0x4000 + ((adr) & 0x7F)) << 16) + 0x90)

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

#define VDP_VERT_SCROLL(adr)        VDP_WRITE_VSRAM_ADDR(adr)

#define VDP_HORZ_SCROLL(adr)        VDP_WRITE_VRAM_ADDR(VDP_SCROLL_H + (adr))

#define GFX_READ_VRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VRAM_ADDR instead.\""))

#define GFX_READ_CRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_CRAM_ADDR instead.\"")

#define GFX_READ_VSRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VSRAM_ADDR instead.\"")

#define GFX_WRITE_VRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VRAM_ADDR instead.\"")

#define GFX_WRITE_CRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_CRAM_ADDR instead.\"")

#define GFX_WRITE_VSRAM_ADDR(adr)   _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VSRAM_ADDR instead.\"")

#define GFX_DMA_VRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAM_ADDR instead.\"")

#define GFX_DMA_CRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_CRAM_ADDR instead.\"")

#define GFX_DMA_VSRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VSRAM_ADDR instead.\"")

#define GFX_DMA_VRAMCOPY_ADDR(adr)  _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAMCOPY_ADDR instead.\"")

#define GFX_VERT_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_VERT_SCROLL instead.\"")

#define GFX_HORZ_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_HORZ_SCROLL instead.\"")


#define GET_VDP_STATUS(flag)         ((*(vu16*)(VDP_CTRL_PORT)) & (flag))

#define IS_PAL_SYSTEM                GET_VDP_STATUS(VDP_PALMODE_FLAG)

#define GET_HVCOUNTER               (*(vu16*)(VDP_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);

void VDP_resetScreen(void);

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

bool VDP_getEnable(void);
bool VDP_isEnable(void);
void VDP_setEnable(bool value);

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

u16  VDP_getPlaneWidth(void);
u16  VDP_getPlaneHeight(void);
void VDP_setPlaneSize(u16 w, u16 h, bool setupVram);
#define VDP_setPlanSize(w, h)      _Pragma("GCC error \"This definition is deprecated, use VDP_setPlaneSize(..) instead.\"")

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

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

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

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

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

u16 VDP_getBGAAddress(void);
u16 VDP_getBGBAddress(void);
#define VDP_getAPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGAAddress() instead.\"")

#define VDP_getBPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGBAddress() instead.\"")

u16 VDP_getWindowAddress(void);
#define VDP_getWindowPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getWindowAddress() instead.\"")

u16 VDP_getSpriteListAddress(void);
u16 VDP_getHScrollTableAddress(void);

void VDP_setBGAAddress(u16 value);
void VDP_setBGBAddress(u16 value);
#define VDP_setAPlanAddress(value)      \
_Pragma("GCC error \"This definition is deprecated, use VDP_setBGAAddress(..) instead.\"")

#define VDP_setBPlanAddress(value)      \
_Pragma("GCC error \"This definition is deprecated, use VDP_setBGBAddress(..) instead.\"")

void VDP_setWindowAddress(u16 value);
#define VDP_setWindowPlanAddress(value)     _Pragma("GCC error \"This definition is deprecated, use VDP_setWindowAddress(..) instead.\"")

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);
void VDP_waitFIFOEmpty(void);

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

u16 VDP_getAdjustedVCounter(void);

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


#endif // _VDP_H_