PPURegisters.hpp

Go to the documentation of this file.

//
// Created by cbihan on 13/07/2021.
//
 
#pragma once
 
 
namespace ComSquare::PPU
{
    enum PpuRegisters {
        inidisp = 0x00,
        obsel = 0x01,
        oamaddl = 0x02,
        oamaddh = 0x03,
        oamdata = 0x04,
        bgmode = 0x05,
        mosaic = 0x06,
        bg1sc = 0x07,
        bg2sc = 0x08,
        bg3sc = 0x09,
        bg4sc = 0x0A,
        bg12nba = 0x0B,
        bg34nba = 0x0C,
        bg1hofs = 0x0D,
        bg1vofs = 0x0E,
        bg2hofs = 0x0F,
        bg2vofs = 0x10,
        bg3hofs = 0x11,
        bg3vofs = 0x12,
        bg4hofs = 0x13,
        bg4vofs = 0x14,
        vmain = 0x15,
        vmaddl = 0x16,
        vmaddh = 0x17,
        vmdatal = 0x18,
        vmdatah = 0x19,
        m7sel = 0x1A,
        m7a = 0x1B,
        m7b = 0x1C,
        m7c = 0x1D,
        m7d = 0x1E,
        m7x = 0x1F,
        m7y = 0x20,
        cgadd = 0x21,
        cgdata = 0x22,
        w12sel = 0x23,
        w34sel = 0x24,
        wobjsel = 0x25,
        wh0 = 0x26,
        wh1 = 0x27,
        wh2 = 0x28,
        wh3 = 0x29,
        wbjlog = 0x2A,
        wobjlog = 0x2B,
        tm = 0x2C,
        ts = 0x2D,
        tmw = 0x2E,
        tsw = 0x2F,
        cgwsel = 0x30,
        cgadsub = 0x31,
        coldata = 0x32,
        setini = 0x33,
        mpyl = 0x34,
        mpym = 0x35,
        mpyh = 0x36,
        slhv = 0x37,
        oamdataread = 0x38,
        vmdatalread = 0x39,
        vmdatahread = 0x3A,
        cgdataread = 0x3B,
        ophct = 0x3C,
        opvct = 0x3D,
        stat77 = 0x3E,
        stat78 = 0x3F
    };
 
    struct Registers {
        union {
            struct {
                uint8_t brightness: 4;
                uint8_t _: 3;
                uint8_t fblank: 1;
            };
            uint8_t raw = 0;
        } _inidisp;
        union {
            struct {
                uint8_t nameBaseSelect: 3;
                uint8_t nameSelect: 2;
                uint8_t objectSize: 3;
            };
            uint8_t raw = 0;
        } _obsel;
        union {
            struct {
                uint16_t oamAddress: 9;
                uint16_t _: 6;
                uint16_t objPriorityActivationBit: 1;
            };
            struct {
                uint16_t oamaddl: 8;
                uint16_t oamaddh: 8;
            };
            uint16_t raw = 0;
        } _oamadd;
        uint8_t _oamdata = 0;
        union {
            struct {
                uint8_t bgMode: 3;
                uint8_t mode1Bg3PriorityBit: 1;
                uint8_t characterSizeBg1: 1;
                uint8_t characterSizeBg2: 1;
                uint8_t characterSizeBg3: 1;
                uint8_t characterSizeBg4: 1;
            };
            uint8_t raw = 0;
        } _bgmode;
        union {
            struct {
                uint8_t affectBg1: 1;
                uint8_t affectBg2: 1;
                uint8_t affectBg3: 1;
                uint8_t affectBg4: 1;
                uint8_t pixelSize: 4;
            };
            uint8_t raw = 0;
        } _mosaic;
        union {
            struct {
                uint8_t tilemapHorizontalMirroring: 1;
                uint8_t tilemapVerticalMirroring: 1;
                uint8_t tilemapAddress: 6;
            };
            uint8_t raw = 0;
        } _bgsc[4];
        union {
            struct {
                uint8_t baseAddressBg1a3: 4;
                uint8_t baseAddressBg2a4: 4;
            };
            uint8_t raw = 0;
        } _bgnba[2];
        union {
            struct {
                uint16_t offsetBg: 10;
                uint16_t _ : 6;
            };
            uint16_t raw = 0;
        } _bgofs[8];
        union {
            struct {
                uint16_t offsetBg : 13;
                uint16_t _ : 3;
            };
            uint16_t raw = 0;
        } _m7ofs[2];
        union {
            struct {
                uint8_t incrementAmount: 2;
                uint8_t addressRemapping: 2;
                uint8_t _ : 3;
                uint8_t incrementMode: 1;
            };
            uint8_t raw = 0;
        } _vmain;
        uint8_t _incrementAmount = 1;
        union {
            struct {
                uint16_t vmaddl: 8;
                uint16_t vmaddh: 8;
            };
            uint16_t vmadd = 0;
        } _vmadd;
        union {
            struct {
                uint16_t vmdatal: 8;
                uint16_t vmdatah: 8;
            };
            uint16_t vmdata = 0;
        } _vmdata;
        union {
            struct {
                uint8_t horizontalMirroring: 1;
                uint8_t verticalMirroring: 1;
                uint8_t _: 4;
                uint8_t emptySpaceFill: 1;
                uint8_t playingFieldSize: 1;
            };
            uint8_t raw = 0;
        } _m7sel;
        union {
            struct {
                uint16_t m7l: 8;
                uint16_t m7h: 8;
            };
            uint16_t m7 = 0;
        } _m7[4];
        // <to work>
 
        union { // Not sure if it is done correctly
            struct {
                uint16_t _: 3;
                uint16_t value: 13;
            };
            uint16_t raw = 0;
        } _m7x;
        union { // Not sure if it is done correctly
            struct {
                uint16_t _: 3;
                uint16_t value: 13;
            };
            uint16_t raw = 0;
        } _m7y;
        uint8_t _cgadd = 0;
        union {
            struct {
                uint16_t red: 5;
                uint16_t green: 5;
                uint16_t blue: 5;
                uint16_t _: 1;
            };
            struct {
                uint16_t cgdatal: 8;
                uint16_t cgdatah: 8;
            };
            uint16_t raw = 0;
        } _cgdata;
        bool _isLowByte = false;
        union {
            struct {
                uint8_t enableWindow2ForBg2Bg4Color: 1;
                uint8_t window2InversionForBg2Bg4Color: 1;
                uint8_t enableWindow1ForBg2Bg4Color: 1;
                uint8_t window1InversionForBg2Bg4Color: 1;
                uint8_t enableWindow2ForBg1Bg3Obj: 1;
                uint8_t window2InversionForBg1Bg3Obj: 1;
                uint8_t enableWindow1ForBg1Bg3Obj: 1;
                uint8_t window1InversionForBg1Bg3Obj: 1;
            };
            uint8_t raw = 0;
        } _wsel[3];
        uint8_t _wh[4] = {0};
        union {
            struct {
                uint8_t maskLogicBg4: 2;
                uint8_t maskLogicBg3: 2;
                uint8_t maskLogicBg2: 2;
                uint8_t maskLogicBg1: 2;
            };
            uint8_t raw = 0;
        } _wbglog;
        union {
            struct {
                uint8_t maskLogicObj: 2;
                uint8_t maskLogicColor: 2;
                uint8_t _: 4;
            };
            uint8_t raw = 0;
        } _wobjlog;
        union {
            struct {
                uint8_t enableWindowDisplayBg1: 1;
                uint8_t enableWindowDisplayBg2: 1;
                uint8_t enableWindowDisplayBg3: 1;
                uint8_t enableWindowDisplayBg4: 1;
                uint8_t enableWindowDisplayObj: 1;
                uint8_t _: 3;
            };
            uint8_t raw = 0;
        } _t[2];
        union {
            struct {
                uint8_t enableWindowMaskingBg1: 1;
                uint8_t enableWindowMaskingBg2: 1;
                uint8_t enableWindowMaskingBg3: 1;
                uint8_t enableWindowMaskingBg4: 1;
                uint8_t enableWindowMaskingObj: 1;
                uint8_t _: 3;
            };
            uint8_t raw = 0;
        } _tw[2];
        union {
            struct {
                uint8_t directColorMode: 1;
                uint8_t addSubscreen: 1;
                uint8_t _: 2;
                uint8_t preventColorMath: 2;
                uint8_t clipColorToBlackBeforeMath: 2;
            };
            uint8_t raw = 0;
        } _cgwsel;
        union {
            struct {
                uint8_t enableColorMathBg1: 1;
                uint8_t enableColorMathBg2: 1;
                uint8_t enableColorMathBg3: 1;
                uint8_t enableColorMathBg4: 1;
                uint8_t enableColorMathObj: 1;
                uint8_t enableColorMathBackdrop: 1;
                uint8_t halfColorMath: 1;
                uint8_t addSubtractSelect: 1;
            };
            uint8_t raw = 0;
        } _cgadsub;
        union {
            struct {
                uint8_t colorIntensity: 5;
                uint8_t red: 1;
                uint8_t green: 1;
                uint8_t blue: 1;
            };
            uint8_t raw = 0;
        } _coldata;
        union {
            struct {
                uint8_t screenInterlace: 1;
                uint8_t objInterlace: 1;
                uint8_t overscanMode: 1;
                uint8_t enablePseudoHiresMode: 1;
                uint8_t _: 2;
                uint8_t mode7ExtBg: 1;
                uint8_t externalSync: 1;
            };
            uint8_t raw = 0;
        } _setini;
 
        // <READ registers>
 
        union {
            struct {
                uint32_t mpyl: 8;
                uint32_t mpym: 8;
                uint32_t mpyh: 8;
                uint32_t _: 8;
            };
            uint32_t mpy = 0;
        } _mpy;
        uint8_t _slhv = 0;
        uint8_t _oamdataread = 0;
        union {
            struct {
                uint16_t vmDataLRead: 8;
                uint16_t vmDataHRead: 8;
            };
            uint16_t raw = 0;
        } _vmdataread;
        union {
            struct {
                uint16_t cgDataLRead: 8;
                uint16_t cgDataHRead: 8;
            };
            uint16_t raw = 0;
        } _cgdataread;
        union {
            struct {
                uint16_t opct: 9;
                uint16_t _: 7;
            };
            uint16_t raw = 0;
        } _opct;
        union {
            struct {
                uint8_t chipVersionNumber: 4;
                uint8_t _: 1;
                uint8_t modeSelect: 1;
                uint8_t rangeOverFlag: 1;
                uint8_t timeOverFlag: 1;
            };
            uint8_t raw = 0;
        } _stat77;
        union {
            struct {
                uint8_t chipVersionNumber: 4;
                uint8_t mode: 1;
                uint8_t _: 1;
                uint8_t externalLatchFlag: 1;
                uint8_t interlaceField: 1;
            };
            uint8_t raw = 0;
        } _stat78;
    };
}