ppu.h

Go to the documentation of this file.

 
#pragma once
 
// ppu / Picture Processing Unit
#ifdef  __cplusplus
extern  "C" {
#endif
 
#include <b8/type.h>
#include <b8/register.h>
 
// ppu
#define B8_PPU_ADDR         (0xffff8000)
#define B8_PPU_EXEC         _B8_REG(B8_PPU_ADDR + 0x00)
#define B8_PPU_STAT         _B8_REG(B8_PPU_ADDR + 0x04)
#define B8_PPU_INTCTRL      _B8_REG(B8_PPU_ADDR + 0x08)
#define B8_PPU_RESOLUTION   _B8_REG(B8_PPU_ADDR + 0x0c)
 
#define B8_PPU_CMD_NOP         (0x00)
#define B8_PPU_CMD_FLUSH       (0x01)
#define B8_PPU_CMD_ENABLE      (0x02)
#define B8_PPU_CMD_RECT        (0x10)
#define B8_PPU_CMD_POLY        (0x11)
#define B8_PPU_CMD_SPRITE      (0x12)
#define B8_PPU_CMD_SETPAL      (0x13)
#define B8_PPU_CMD_SETPHYPAL   (0x14)
#define B8_PPU_CMD_BG          (0x15)
#define B8_PPU_CMD_SCISSOR     (0x16)
#define B8_PPU_CMD_VIEWOFFSET  (0x17)
#define B8_PPU_CMD_LOADIMG     (0x20)
#define B8_PPU_CMD_LINE        (0x21)
#define B8_PPU_CMD_JMP         (0xf0)
#define B8_PPU_CMD_HALT        (0xff)
 
#define B8_PPU_COLOR_BLACK       (0)
#define B8_PPU_COLOR_DARK_BLUE   (1)
#define B8_PPU_COLOR_DARK_PURPLE (2)
#define B8_PPU_COLOR_DARK_GREEN  (3)
#define B8_PPU_COLOR_BROWN       (4)
#define B8_PPU_COLOR_DARK_GREY   (5)
#define B8_PPU_COLOR_LIGHT_GREY  (6)
#define B8_PPU_COLOR_WHITE       (7)
#define B8_PPU_COLOR_RED         (8)
#define B8_PPU_COLOR_ORANGE      (9)
#define B8_PPU_COLOR_YELLOW      (10)
#define B8_PPU_COLOR_GREEN       (11)
#define B8_PPU_COLOR_BLUE        (12)
#define B8_PPU_COLOR_LAVENDER    (13)
#define B8_PPU_COLOR_PINK        (14)
#define B8_PPU_COLOR_LIGHT_PEACH (15)
 
enum b8PpuColor {
    B8_BLACK       = B8_PPU_COLOR_BLACK,        // 0: Black
    B8_DARK_BLUE   = B8_PPU_COLOR_DARK_BLUE,    // 1: Dark Blue
    B8_DARK_PURPLE = B8_PPU_COLOR_DARK_PURPLE,  // 2: Dark Purple
    B8_DARK_GREEN  = B8_PPU_COLOR_DARK_GREEN,   // 3: Dark Green
    B8_BROWN       = B8_PPU_COLOR_BROWN,        // 4: Brown
    B8_DARK_GREY   = B8_PPU_COLOR_DARK_GREY,    // 5: Dark Grey
    B8_LIGHT_GREY  = B8_PPU_COLOR_LIGHT_GREY,   // 6: Light Grey
    B8_WHITE       = B8_PPU_COLOR_WHITE,        // 7: White
    B8_RED         = B8_PPU_COLOR_RED,          // 8: Red
    B8_ORANGE      = B8_PPU_COLOR_ORANGE,       // 9: Orange
    B8_YELLOW      = B8_PPU_COLOR_YELLOW,       // 10: Yellow
    B8_GREEN       = B8_PPU_COLOR_GREEN,        // 11: Green
    B8_BLUE        = B8_PPU_COLOR_BLUE,         // 12: Blue
    B8_LAVENDER    = B8_PPU_COLOR_LAVENDER,     // 13: Lavender
    B8_PINK        = B8_PPU_COLOR_PINK,         // 14: Pink
    B8_LIGHT_PEACH = B8_PPU_COLOR_LIGHT_PEACH,  // 15: Light Peach
    /* --- */
    B8_TRANSPARENT
};
 
#define B8_PPU_EXEC_START  (0x1)
 
#define B8_PPU_BG_WRAP_CLAMP         (0x00)
 
#define B8_PPU_BG_WRAP_CLAMP_TO_EDGE (0x01)
 
#define B8_PPU_BG_WRAP_REPEAT        (0x02)
 
 
 
#define PACKED_ALIGNED1 __attribute__((__packed__,aligned(1)))
#define PACKED_ALIGNED4 __attribute__((__packed__,aligned(4)))
 
typedef struct _b8PpuCmd {
  u32*  buff;     
  u32   bytesize; 
  u32*  sp;       
  u32*  tail;     
  u32*  ot;       
  u32*  ot_prev;
  u32   otnum;    
  u32*  addr_halt;
} b8PpuCmd;
 
extern void b8PpuCmdSetBuff(b8PpuCmd* cmd_, u32* buff_, u32 bytesize_);
 
extern void b8PpuCmdPush(b8PpuCmd* cmd_, u32 word_);
 
typedef struct PACKED_ALIGNED4 _b8PpuRect {
  unsigned pal  : 4;  
  unsigned na   : 20; 
  unsigned code : 8;  
  signed y      : 16; 
  signed x      : 16; 
  unsigned h    : 16; 
  unsigned w    : 16; 
} b8PpuRect;
 
extern b8PpuRect* b8PpuRectAlloc(b8PpuCmd* cmd_);
 
extern b8PpuRect* b8PpuRectAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuRect* b8PpuRectAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuSprite {
  unsigned pal      : 4;  
  unsigned na0      : 20; 
  unsigned code     : 8;  
  unsigned srchtile : 5;  
  unsigned vfp      : 1;  
  unsigned na1      : 2;  
  unsigned srcwtile : 5;  
  unsigned hfp      : 1;  
  unsigned na2      : 2;  
  unsigned srcytile : 6;  
  unsigned na3      : 2;  
  unsigned srcxtile : 6;  
  unsigned na4      : 2;  
  signed y          : 16; 
  signed x          : 16; 
} b8PpuSprite;
 
extern b8PpuSprite* b8PpuSpriteAlloc(b8PpuCmd* cmd_);
 
extern b8PpuSprite* b8PpuSpriteAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuSprite* b8PpuSpriteAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuSetpal {
  unsigned palsel     : 4;  
  unsigned wmask      : 16; 
  unsigned reserved   : 4; 
  unsigned code   : 8;  
  unsigned pidx0  : 4;  
  unsigned pidx1  : 4;  
  unsigned pidx2  : 4;  
  unsigned pidx3  : 4;  
  unsigned pidx4  : 4;  
  unsigned pidx5  : 4;  
  unsigned pidx6  : 4;  
  unsigned pidx7  : 4;  
  unsigned pidx8  : 4;  
  unsigned pidx9  : 4;  
  unsigned pidx10 : 4;  
  unsigned pidx11 : 4;  
  unsigned pidx12 : 4;  
  unsigned pidx13 : 4;  
  unsigned pidx14 : 4;  
  unsigned pidx15 : 4;  
} b8PpuSetpal;
 
extern b8PpuSetpal* b8PpuSetpalAlloc(b8PpuCmd* cmd_);
 
extern b8PpuSetpal* b8PpuSetpalAllocZ(b8PpuCmd* cmd_, u32 otz, u8 flush);
 
extern b8PpuSetpal* b8PpuSetpalAllocZPB(b8PpuCmd* cmd_, u32 otz, u8 flush);
 
 
typedef struct PACKED_ALIGNED1 _b8PpuBgTile {
  unsigned YTILE : 6; 
  unsigned XTILE : 6; 
  unsigned VFP   : 1; 
  unsigned HFP   : 1; 
  unsigned PAL   : 2; 
} b8PpuBgTile;
 
#define B8_PPU_MAX_WTILE  (64)
 
#define B8_PPU_MAX_HTILE  (64)
 
typedef struct PACKED_ALIGNED4 _b8PpuBg {
  unsigned htile  : 4; 
  unsigned na0    : 8; 
  unsigned wtile  : 4; 
  unsigned na1    : 8; 
  unsigned code   : 8; 
  b8PpuBgTile* cpuaddr; 
  signed vpix     : 16; 
  signed upix     : 16; 
  unsigned vwrap :  2;  
  unsigned uwrap :  2;  
  unsigned na2   : 28;  
} b8PpuBg;
 
extern b8PpuBg* b8PpuBgAlloc(b8PpuCmd* cmd_);
 
extern b8PpuBg* b8PpuBgAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuBg* b8PpuBgAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuPoly {
  unsigned pal   : 4;  
  unsigned na0   : 20; 
  unsigned code  : 8;  
  signed y0      : 16; 
  signed x0      : 16; 
  signed y1      : 16; 
  signed x1      : 16; 
  signed y2      : 16; 
  signed x2      : 16; 
} b8PpuPoly;
extern b8PpuPoly* b8PpuPolyAlloc(b8PpuCmd* cmd_);
 
extern b8PpuPoly* b8PpuPolyAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuPoly* b8PpuPolyAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuLine {
  unsigned pal   : 4;  
  unsigned width : 4;  
  unsigned na0   : 16; 
  unsigned code  : 8;  
  signed y0      : 16; 
  signed x0      : 16; 
  signed y1      : 16; 
  signed x1      : 16; 
} b8PpuLine;
 
extern b8PpuLine* b8PpuLineAlloc(b8PpuCmd* cmd_);
 
extern b8PpuLine* b8PpuLineAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuLine* b8PpuLineAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuScissor {
  unsigned na0   : 24; 
  unsigned code  :  8; 
  signed y       : 16; 
  signed x       : 16; 
  signed h       : 16; 
  signed w       : 16; 
} b8PpuScissor;
 
extern b8PpuScissor* b8PpuScissorAlloc(b8PpuCmd* cmd_);
 
extern b8PpuScissor* b8PpuScissorAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuScissor* b8PpuScissorAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuViewoffset {
  unsigned na0   : 24; 
  unsigned code  :  8; 
  signed y       : 16; 
  signed x       : 16; 
} b8PpuViewoffset;
 
extern b8PpuViewoffset* b8PpuViewoffsetAlloc(b8PpuCmd* cmd_);
 
extern b8PpuViewoffset* b8PpuViewoffsetAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuViewoffset* b8PpuViewoffsetAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuNop {
  unsigned  na0       : 24;       // N/A
  unsigned  code      :  8;
} b8PpuNop;
 
extern b8PpuNop* b8PpuNopAlloc(b8PpuCmd* cmd_);
 
extern b8PpuNop* b8PpuNopAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuNop* b8PpuNopAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuFlush {
  unsigned pal  :  1; 
  unsigned img  :  1; 
  unsigned na0  : 22; 
  unsigned code :  8; 
} b8PpuFlush;
 
extern b8PpuFlush* b8PpuFlushAlloc(b8PpuCmd* cmd_);
 
extern b8PpuFlush* b8PpuFlushAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuHalt {
  unsigned na0   : 24; 
  unsigned code  :  8; 
} b8PpuHalt;
 
extern b8PpuHalt* b8PpuHaltAlloc(b8PpuCmd* cmd_);
 
extern b8PpuHalt* b8PpuHaltAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuHalt* b8PpuHaltAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuEnable {
  unsigned cul  :  1; 
  unsigned na0  : 23; 
  unsigned code :  8; 
} b8PpuEnable;
 
#define B8_PPU_CMD_ENABLE_CULLING_OF_POLYGONS  (1<<0)
 
extern b8PpuEnable* b8PpuEnableAlloc(b8PpuCmd* cmd_);
 
extern b8PpuEnable* b8PpuEnableAllocZ(b8PpuCmd* cmd_, u32 otz_);
 
extern b8PpuEnable* b8PpuEnableAllocZPB(b8PpuCmd* cmd_, u32 otz_);
 
typedef struct PACKED_ALIGNED4 _b8PpuLoadimg {
  unsigned na0      : 24; 
  unsigned code     :  8; 
  const u8* cpuaddr;      
  unsigned na1      :  8; 
  unsigned srcwtile :  6; 
  unsigned na2      :  2; 
  unsigned srcytile :  6; 
  unsigned na3      :  2; 
  unsigned srcxtile :  6; 
  unsigned na4      :  2; 
  unsigned trnhtile :  6; 
  unsigned na5      :  2; 
  unsigned trnwtile :  6; 
  unsigned na6      :  2; 
  unsigned dstytile :  6; 
  unsigned na7      :  2; 
  unsigned dstxtile :  6; 
  unsigned na8      :  2; 
} b8PpuLoadimg;
 
extern b8PpuLoadimg* b8PpuLoadimgAlloc(b8PpuCmd* cmd_);
 
extern b8PpuLoadimg* b8PpuLoadimgAllocZ(b8PpuCmd* cmd_, u32 otz);
 
extern b8PpuLoadimg* b8PpuLoadimgAllocZPB(b8PpuCmd* cmd_, u32 otz);
 
typedef struct PACKED_ALIGNED4 _b8PpuJmp {
  unsigned cpuaddr4 : 24; 
  unsigned code     :  8; 
} b8PpuJmp;
 
extern b8PpuJmp* b8PpuJmpAlloc(b8PpuCmd* cmd_, u32* cpuaddr_);
 
extern void b8PpuClearOT(b8PpuCmd* cmd_, u32* ot_, u32* ot_prev_, u32 num_);
 
extern void b8PpuPushFrontOT(b8PpuCmd* cmd_, u32 otz_, void* prim_);
 
extern void b8PpuPushBackOT(b8PpuCmd* cmd_, u32 otz_, void* prim_);
 
extern  void  b8PpuExec( b8PpuCmd* cmd_ );
 
extern  void  b8PpuEnableVblankInterrupt( void );
 
extern  void  b8PpuVsyncWait( void );
 
extern  void  b8PpuGetResolution( u32* ww, u32* hh );
 
extern  void  b8PpuReset( void );
 
#ifdef  __cplusplus
}
#endif