From 88a3896ad8541c833ef4b26b371d3e27a4334bd5 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Sat, 20 Apr 2019 15:33:28 -0700 Subject: [PATCH 01/10] Added offsets for the registers, register ordering, cleanup --- hardware.inc | 710 ++++++++++++++++++++++++++++----------------------- 1 file changed, 392 insertions(+), 318 deletions(-) diff --git a/hardware.inc b/hardware.inc index 8f16289..e6c5388 100644 --- a/hardware.inc +++ b/hardware.inc @@ -23,6 +23,7 @@ ;* Rev 2.6 - 09-Apr-16 : Added GBC OAM and cart defines (AntonioND) ;* Rev 2.7 - 19-Jan-19 : Added rPCMXX (ISSOtm) ;* Rev 2.8 - 03-Feb-19 : Added audio registers flags (Álvaro Cuesta) +;* Rev 2.9 - 20-Apr-19 : Added offsets for the registers, register ordering, cleanup (Blitter Object) ; If all of these are already defined, don't do it again. @@ -32,12 +33,12 @@ HARDWARE_INC SET 1 rev_Check_hardware_inc : MACRO ;NOTE: REVISION NUMBER CHANGES MUST BE ADDED ;TO SECOND PARAMETER IN FOLLOWING LINE. - IF \1 > 2.8 ;PUT REVISION NUMBER HERE + IF \1 > 2.9 ;PUT REVISION NUMBER HERE WARN "Version \1 or later of 'hardware.inc' is required." ENDC ENDM -_HW EQU $FF00 +_HW EQU $FF00 ; $FF00->$FF7F,$FFFF _VRAM EQU $8000 ; $8000->$9FFF _SCRN0 EQU $9800 ; $9800->$9BFF @@ -87,7 +88,8 @@ OAMB_BANK1 EQU 3 ; Bank number; 0,1 (GBC) ; -- P1 ($FF00) ; -- Register for reading joy pad info. (R/W) ; -- -rP1 EQU $FF00 +oP1 EQU $00 +rP1 EQU (_HW + oP1) P1F_5 EQU %00100000 ; P15 out port P1F_4 EQU %00010000 ; P14 out port @@ -96,44 +98,53 @@ P1F_2 EQU %00000100 ; P12 in port P1F_1 EQU %00000010 ; P11 in port P1F_0 EQU %00000001 ; P10 in port + ; -- ; -- SB ($FF01) ; -- Serial Transfer Data (R/W) ; -- -rSB EQU $FF01 +oSB EQU $01 +rSB EQU (_HW + oSB) + ; -- ; -- SC ($FF02) ; -- Serial I/O Control (R/W) ; -- -rSC EQU $FF02 +oSC EQU $02 +rSC EQU (_HW + oSC) + ; -- ; -- DIV ($FF04) ; -- Divider register (R/W) ; -- -rDIV EQU $FF04 +oDIV EQU $04 +rDIV EQU (_HW + oDIV) ; -- ; -- TIMA ($FF05) ; -- Timer counter (R/W) ; -- -rTIMA EQU $FF05 +oTIMA EQU $05 +rTIMA EQU (_HW + oTIMA) ; -- ; -- TMA ($FF06) ; -- Timer modulo (R/W) ; -- -rTMA EQU $FF06 +oTMA EQU $06 +rTMA EQU (_HW + oTMA) ; -- ; -- TAC ($FF07) ; -- Timer control (R/W) ; -- -rTAC EQU $FF07 +oTAC EQU $07 +rTAC EQU (_HW + oTAC) TACF_START EQU %00000100 TACF_STOP EQU %00000000 @@ -142,254 +153,236 @@ TACF_16KHZ EQU %00000011 TACF_65KHZ EQU %00000010 TACF_262KHZ EQU %00000001 + ; -- ; -- IF ($FF0F) ; -- Interrupt Flag (R/W) ; -- -rIF EQU $FF0F - -; -- -; -- LCDC ($FF40) -; -- LCD Control (R/W) -; -- -rLCDC EQU $FF40 - -LCDCF_OFF EQU %00000000 ; LCD Control Operation -LCDCF_ON EQU %10000000 ; LCD Control Operation -LCDCF_WIN9800 EQU %00000000 ; Window Tile Map Display Select -LCDCF_WIN9C00 EQU %01000000 ; Window Tile Map Display Select -LCDCF_WINOFF EQU %00000000 ; Window Display -LCDCF_WINON EQU %00100000 ; Window Display -LCDCF_BG8800 EQU %00000000 ; BG & Window Tile Data Select -LCDCF_BG8000 EQU %00010000 ; BG & Window Tile Data Select -LCDCF_BG9800 EQU %00000000 ; BG Tile Map Display Select -LCDCF_BG9C00 EQU %00001000 ; BG Tile Map Display Select -LCDCF_OBJ8 EQU %00000000 ; OBJ Construction -LCDCF_OBJ16 EQU %00000100 ; OBJ Construction -LCDCF_OBJOFF EQU %00000000 ; OBJ Display -LCDCF_OBJON EQU %00000010 ; OBJ Display -LCDCF_BGOFF EQU %00000000 ; BG Display -LCDCF_BGON EQU %00000001 ; BG Display -; "Window Character Data Select" follows BG +oIF EQU $0F +rIF EQU (_HW + oIF) ; -- -; -- STAT ($FF41) -; -- LCDC Status (R/W) -; -- -rSTAT EQU $FF41 - -STATF_LYC EQU %01000000 ; LYCEQULY Coincidence (Selectable) -STATF_MODE10 EQU %00100000 ; Mode 10 -STATF_MODE01 EQU %00010000 ; Mode 01 (V-Blank) -STATF_MODE00 EQU %00001000 ; Mode 00 (H-Blank) -STATF_LYCF EQU %00000100 ; Coincidence Flag -STATF_HB EQU %00000000 ; H-Blank -STATF_VB EQU %00000001 ; V-Blank -STATF_OAM EQU %00000010 ; OAM-RAM is used by system -STATF_LCD EQU %00000011 ; Both OAM and VRAM used by system -STATF_BUSY EQU %00000010 ; When set, VRAM access is unsafe - - +; -- AUD1SWEEP/NR10 ($FF10) +; -- Sweep register (R/W) ; -- -; -- SCY ($FF42) -; -- Scroll Y (R/W) +; -- Bit 6-4 - Sweep Time +; -- Bit 3 - Sweep Increase/Decrease +; -- 0: Addition (frequency increases???) +; -- 1: Subtraction (frequency increases???) +; -- Bit 2-0 - Number of sweep shift (# 0-7) +; -- Sweep Time: (n*7.8ms) ; -- -rSCY EQU $FF42 - +oNR10 EQU $10 +rNR10 EQU (_HW + oNR10) +rAUD1SWEEP EQU rNR10 -; -- -; -- SCY ($FF43) -; -- Scroll X (R/W) -; -- -rSCX EQU $FF43 +AUD1SWEEP_UP EQU %00000000 +AUD1SWEEP_DOWN EQU %00001000 ; -- -; -- LY ($FF44) -; -- LCDC Y-Coordinate (R) +; -- AUD1LEN/NR11 ($FF11) +; -- Sound length/Wave pattern duty (R/W) ; -- -; -- Values range from 0->153. 144->153 is the VBlank period. +; -- Bit 7-6 - Wave Pattern Duty (00:12.5% 01:25% 10:50% 11:75%) +; -- Bit 5-0 - Sound length data (# 0-63) ; -- -rLY EQU $FF44 +oNR11 EQU $11 +rNR11 EQU (_HW + oNR11) +rAUD1LEN EQU rNR11 ; -- -; -- LYC ($FF45) -; -- LY Compare (R/W) +; -- AUD1ENV/NR12 ($FF12) +; -- Envelope (R/W) ; -- -; -- When LYEQUEQULYC, STATF_LYCF will be set in STAT +; -- Bit 7-4 - Initial value of envelope +; -- Bit 3 - Envelope UP/DOWN +; -- 0: Decrease +; -- 1: Range of increase +; -- Bit 2-0 - Number of envelope sweep (# 0-7) ; -- -rLYC EQU $FF45 +oNR12 EQU $12 +rNR12 EQU (_HW + oNR12) +rAUD1ENV EQU rNR12 ; -- -; -- DMA ($FF46) -; -- DMA Transfer and Start Address (W) +; -- AUD1LOW/NR13 ($FF13) +; -- Frequency lo (W) ; -- -rDMA EQU $FF46 +oNR13 EQU $13 +rNR13 EQU (_HW + oNR13) +rAUD1LOW EQU rNR13 ; -- -; -- BGP ($FF47) -; -- BG Palette Data (W) +; -- AUD1HIGH/NR14 ($FF14) +; -- Frequency hi (W) ; -- -; -- Bit 7-6 - Intensity for %11 -; -- Bit 5-4 - Intensity for %10 -; -- Bit 3-2 - Intensity for %01 -; -- Bit 1-0 - Intensity for %00 +; -- Bit 7 - Initial (when set, sound restarts) +; -- Bit 6 - Counter/consecutive selection +; -- Bit 2-0 - Frequency's higher 3 bits ; -- -rBGP EQU $FF47 +oNR14 EQU $14 +rNR14 EQU (_HW + oNR14) +rAUD1HIGH EQU rNR14 ; -- -; -- OBP0 ($FF48) -; -- Object Palette 0 Data (W) +; -- AUD2LEN/NR21 ($FF16) +; -- Sound Length; Wave Pattern Duty (R/W) ; -- -; -- See BGP for info +; -- see AUD1LEN for info ; -- -rOBP0 EQU $FF48 +oNR21 EQU $16 +rNR21 EQU (_HW + oNR21) +rAUD2LEN EQU rNR21 ; -- -; -- OBP1 ($FF49) -; -- Object Palette 1 Data (W) +; -- AUD2ENV/NR22 ($FF17) +; -- Envelope (R/W) ; -- -; -- See BGP for info +; -- see AUD1ENV for info ; -- -rOBP1 EQU $FF49 +oNR22 EQU $17 +rNR22 EQU (_HW + oNR22) +rAUD2ENV EQU rNR22 ; -- -; -- WY ($FF4A) -; -- Window Y Position (R/W) -; -- -; -- 0 SO1 ON/OFF (Vin??) ; -- Bit 2-0 - SO1 output level (volume) (# 0-7) ; -- -rNR50 EQU $FF24 +oNR50 EQU $24 +rNR50 EQU (_HW + oNR50) rAUDVOL EQU rNR50 AUDVOL_VIN_LEFT EQU %10000000 ; SO2 @@ -420,7 +414,8 @@ AUDVOL_VIN_RIGHT EQU %00001000 ; SO1 ; -- Bit 1 - Output sound 2 to SO1 terminal ; -- Bit 0 - Output sound 0 to SO1 terminal ; -- -rNR51 EQU $FF25 +oNR51 EQU $25 +rNR51 EQU (_HW + oNR51) rAUDTERM EQU rNR51 ; SO2 @@ -445,233 +440,262 @@ AUDTERM_1_RIGHT EQU %00000001 ; -- Bit 1 - Sound 2 ON flag (doesn't work!) ; -- Bit 0 - Sound 1 ON flag (doesn't work!) ; -- -rNR52 EQU $FF26 +oNR52 EQU $26 +rNR52 EQU (_HW + oNR52) rAUDENA EQU rNR52 AUDENA_ON EQU %10000000 AUDENA_OFF EQU %00000000 ; sets all audio regs to 0! -;*************************************************************************** -;* -;* SoundChannel #1 registers -;* -;*************************************************************************** - -; -- -; -- AUD1SWEEP/NR10 ($FF10) -; -- Sweep register (R/W) ; -- -; -- Bit 6-4 - Sweep Time -; -- Bit 3 - Sweep Increase/Decrease -; -- 0: Addition (frequency increases???) -; -- 1: Subtraction (frequency increases???) -; -- Bit 2-0 - Number of sweep shift (# 0-7) -; -- Sweep Time: (n*7.8ms) +; -- LCDC ($FF40) +; -- LCD Control (R/W) ; -- -rNR10 EQU $FF10 -rAUD1SWEEP EQU rNR10 +oLCDC EQU $40 +rLCDC EQU (_HW + oLCDC) -AUD1SWEEP_UP EQU %00000000 -AUD1SWEEP_DOWN EQU %00001000 +LCDCF_OFF EQU %00000000 ; LCD Control Operation +LCDCF_ON EQU %10000000 ; LCD Control Operation +LCDCF_WIN9800 EQU %00000000 ; Window Tile Map Display Select +LCDCF_WIN9C00 EQU %01000000 ; Window Tile Map Display Select +LCDCF_WINOFF EQU %00000000 ; Window Display +LCDCF_WINON EQU %00100000 ; Window Display +LCDCF_BG8800 EQU %00000000 ; BG & Window Tile Data Select +LCDCF_BG8000 EQU %00010000 ; BG & Window Tile Data Select +LCDCF_BG9800 EQU %00000000 ; BG Tile Map Display Select +LCDCF_BG9C00 EQU %00001000 ; BG Tile Map Display Select +LCDCF_OBJ8 EQU %00000000 ; OBJ Construction +LCDCF_OBJ16 EQU %00000100 ; OBJ Construction +LCDCF_OBJOFF EQU %00000000 ; OBJ Display +LCDCF_OBJON EQU %00000010 ; OBJ Display +LCDCF_BGOFF EQU %00000000 ; BG Display +LCDCF_BGON EQU %00000001 ; BG Display +; "Window Character Data Select" follows BG ; -- -; -- AUD1LEN/NR11 ($FF11) -; -- Sound length/Wave pattern duty (R/W) -; -- -; -- Bit 7-6 - Wave Pattern Duty (00:12.5% 01:25% 10:50% 11:75%) -; -- Bit 5-0 - Sound length data (# 0-63) +; -- STAT ($FF41) +; -- LCDC Status (R/W) ; -- -rNR11 EQU $FF11 -rAUD1LEN EQU rNR11 +oSTAT EQU $41 +rSTAT EQU (_HW + oSTAT) + +STATF_LYC EQU %01000000 ; LYC=LY Coincidence (Selectable) +STATF_MODE10 EQU %00100000 ; Mode 10 +STATF_MODE01 EQU %00010000 ; Mode 01 (V-Blank) +STATF_MODE00 EQU %00001000 ; Mode 00 (H-Blank) +STATF_LYCF EQU %00000100 ; Coincidence Flag +STATF_HB EQU %00000000 ; H-Blank +STATF_VB EQU %00000001 ; V-Blank +STATF_OAM EQU %00000010 ; OAM-RAM is used by system +STATF_LCD EQU %00000011 ; Both OAM and VRAM used by system +STATF_BUSY EQU %00000010 ; When set, VRAM access is unsafe ; -- -; -- AUD1ENV/NR12 ($FF12) -; -- Envelope (R/W) +; -- SCY ($FF42) +; -- Scroll Y (R/W) ; -- -; -- Bit 7-4 - Initial value of envelope -; -- Bit 3 - Envelope UP/DOWN -; -- 0: Decrease -; -- 1: Range of increase -; -- Bit 2-0 - Number of envelope sweep (# 0-7) +oSCY EQU $42 +rSCY EQU (_HW + oSCY) + + ; -- -rNR12 EQU $FF12 -rAUD1ENV EQU rNR12 +; -- SCY ($FF43) +; -- Scroll X (R/W) +; -- +oSCX EQU $43 +rSCX EQU (_HW + oSCX) ; -- -; -- AUD1LOW/NR13 ($FF13) -; -- Frequency lo (W) +; -- LY ($FF44) +; -- LCDC Y-Coordinate (R) ; -- -rNR13 EQU $FF13 -rAUD1LOW EQU rNR13 +; -- Values range from 0->153. 144->153 is the VBlank period. +; -- +oLY EQU $44 +rLY EQU (_HW + oLY) ; -- -; -- AUD1HIGH/NR14 ($FF14) -; -- Frequency hi (W) +; -- LYC ($FF45) +; -- LY Compare (R/W) ; -- -; -- Bit 7 - Initial (when set, sound restarts) -; -- Bit 6 - Counter/consecutive selection -; -- Bit 2-0 - Frequency's higher 3 bits +; -- When LY==LYC, STATF_LYCF will be set in STAT ; -- -rNR14 EQU $FF14 -rAUD1HIGH EQU rNR14 +oLYC EQU $45 +rLYC EQU (_HW + oLYC) -;*************************************************************************** -;* -;* SoundChannel #2 registers -;* -;*************************************************************************** +; -- +; -- DMA ($FF46) +; -- DMA Transfer and Start Address (W) +; -- +oDMA EQU $46 +rDMA EQU (_HW + oDMA) + ; -- -; -- AUD2LEN/NR21 ($FF16) -; -- Sound Length; Wave Pattern Duty (R/W) +; -- BGP ($FF47) +; -- BG Palette Data (W) ; -- -; -- see AUD1LEN for info +; -- Bit 7-6 - Intensity for %11 +; -- Bit 5-4 - Intensity for %10 +; -- Bit 3-2 - Intensity for %01 +; -- Bit 1-0 - Intensity for %00 ; -- -rNR21 EQU $FF16 -rAUD2LEN EQU rNR21 +oBGP EQU $47 +rBGP EQU (_HW + oBGP) ; -- -; -- AUD2ENV/NR22 ($FF17) -; -- Envelope (R/W) +; -- OBP0 ($FF48) +; -- Object Palette 0 Data (W) ; -- -; -- see AUD1ENV for info +; -- See BGP for info ; -- -rNR22 EQU $FF17 -rAUD2ENV EQU rNR22 +oOBP0 EQU $48 +rOBP0 EQU (_HW + oOBP0) ; -- -; -- AUD2LOW/NR23 ($FF18) -; -- Frequency lo (W) +; -- OBP1 ($FF49) +; -- Object Palette 1 Data (W) ; -- -rNR23 EQU $FF18 -rAUD2LOW EQU rNR23 +; -- See BGP for info +; -- +oOBP1 EQU $49 +rOBP1 EQU (_HW + oOBP1) ; -- -; -- AUD2HIGH/NR24 ($FF19) -; -- Frequency hi (W) +; -- WY ($FF4A) +; -- Window Y Position (R/W) ; -- -; -- see AUD1HIGH for info +; -- 0 <= WY <= 143 ; -- -rNR24 EQU $FF19 -rAUD2HIGH EQU rNR24 - +oWY EQU $4A +rWY EQU (_HW + oWY) -;*************************************************************************** -;* -;* SoundChannel #3 registers -;* -;*************************************************************************** ; -- -; -- AUD3ENA/NR30 ($FF1A) -; -- Sound on/off (R/W) +; -- WX ($FF4B) +; -- Window X Position (R/W) ; -- -; -- Bit 7 - Sound ON/OFF (1EQUON,0EQUOFF) +; -- 7 <= WX <= 166 ; -- -rNR30 EQU $FF1A -rAUD3ENA EQU rNR30 +oWX EQU $4B +rWX EQU (_HW + oWX) ; -- -; -- AUD3LEN/NR31 ($FF1B) -; -- Sound length (R/W) -; -- -; -- Bit 7-0 - Sound length +; -- KEY 1 ($FF4D) +; -- Select CPU Speed (R/W) ; -- -rNR31 EQU $FF1B -rAUD3LEN EQU rNR31 +oKEY1 EQU $4D +rKEY1 EQU (_HW + oKEY1) ; -- -; -- AUD3LEVEL/NR32 ($FF1C) -; -- Select output level +; -- VBK ($FF4F) +; -- Select Video RAM Bank (R/W) ; -- -; -- Bit 6-5 - Select output level -; -- 00: 0/1 (mute) -; -- 01: 1/1 -; -- 10: 1/2 -; -- 11: 1/4 +; -- Bit 0 - Bank Specification (0: Specify Bank 0; 1: Specify Bank 1) ; -- -rNR32 EQU $FF1C -rAUD3LEVEL EQU rNR32 +oVBK EQU $4F +rVBK EQU (_HW + oVBK) ; -- -; -- AUD3LOW/NR33 ($FF1D) -; -- Frequency lo (W) +; -- HDMA1 ($FF51) +; -- Horizontal Blanking, General Purpose DMA (W) ; -- -; -- see AUD1LOW for info +oHDMA1 EQU $51 +rHDMA1 EQU (_HW + oHDMA1) + + ; -- -rNR33 EQU $FF1D -rAUD3LOW EQU rNR33 +; -- HDMA2 ($FF52) +; -- Horizontal Blanking, General Purpose DMA (W) +; -- +oHDMA2 EQU $52 +rHDMA2 EQU (_HW + oHDMA2) ; -- -; -- AUD3HIGH/NR34 ($FF1E) -; -- Frequency hi (W) +; -- HDMA3 ($FF53) +; -- Horizontal Blanking, General Purpose DMA (W) ; -- -; -- see AUD1HIGH for info +oHDMA3 EQU $53 +rHDMA3 EQU (_HW + oHDMA3) + + ; -- -rNR34 EQU $FF1E -rAUD3HIGH EQU rNR34 +; -- HDMA4 ($FF54) +; -- Horizontal Blanking, General Purpose DMA (W) +; -- +oHDMA4 EQU $54 +rHDMA4 EQU (_HW + oHDMA4) ; -- -; -- AUD4LEN/NR41 ($FF20) -; -- Sound length (R/W) +; -- HDMA5 ($FF55) +; -- Horizontal Blanking, General Purpose DMA (R/W) ; -- -; -- Bit 5-0 - Sound length data (# 0-63) +oHDMA5 EQU $55 +rHDMA5 EQU (_HW + oHDMA5) + + ; -- -rNR41 EQU $FF20 -rAUD4LEN EQU rNR41 +; -- RP ($FF56) +; -- Infrared Communications Port (R/W) +; -- +oRP EQU $56 +rRP EQU (_HW + oRP) ; -- -; -- AUD4ENV/NR42 ($FF21) -; -- Envelope (R/W) +; -- BCPS ($FF68) +; -- Background Color Palette Specification (R/W) ; -- -; -- see AUD1ENV for info +oBCPS EQU $68 +rBCPS EQU (_HW + oBCPS) + + ; -- -rNR42 EQU $FF21 -rAUD4ENV EQU rNR42 +; -- BCPD ($FF69) +; -- Background Color Palette Data (R/W) +; -- +oBCPD EQU $69 +rBCPD EQU (_HW + oBCPD) ; -- -; -- AUD4POLY/NR43 ($FF22) -; -- Polynomial counter (R/W) +; -- BCPS ($FF6A) +; -- Object Color Palette Specification (R/W) ; -- -; -- Bit 7-4 - Selection of the shift clock frequency of the (scf) -; -- polynomial counter (0000-1101) -; -- freqEQUdrf*1/2^scf (not sure) -; -- Bit 3 - Selection of the polynomial counter's step -; -- 0: 15 steps -; -- 1: 7 steps -; -- Bit 2-0 - Selection of the dividing ratio of frequencies (drf) -; -- 000: f/4 001: f/8 010: f/16 011: f/24 -; -- 100: f/32 101: f/40 110: f/48 111: f/56 (fEQU4.194304 Mhz) +oOCPS EQU $6A +rOCPS EQU (_HW + oOCPS) + + ; -- -rNR43 EQU $FF22 -rAUD4POLY EQU rNR43 +; -- BCPD ($FF6B) +; -- Object Color Palette Data (R/W) +; -- +oOCPD EQU $6B +rOCPD EQU (_HW + oOCPD) ; -- -; -- AUD4GO/NR44 ($FF23) -; -- (has wrong name and value (ff30) in Dr.Pan's doc!) +; -- SVBK ($FF70) +; -- Select Main RAM Bank (R/W) ; -- -; -- Bit 7 - Inital -; -- Bit 6 - Counter/consecutive selection +; -- Bit 2-0 - Bank Specification (0,1: Specify Bank 1; 2-7: Specify Banks 2-7) ; -- -rNR44 EQU $FF23 -rAUD4GO EQU rNR44 ; silly name! +oSVBK EQU $70 +rSVBK EQU (_HW + oSVBK) ; -- @@ -681,7 +705,8 @@ rAUD4GO EQU rNR44 ; silly name! ; -- Bit 7-4 - Copy of sound channel 2's PCM amplitude ; -- Bit 3-0 - Copy of sound channel 1's PCM amplitude ; -- -rPCM12 EQU $FF76 +oPCM12 EQU $76 +rPCM12 EQU (_HW + oPCM12) ; -- @@ -691,7 +716,22 @@ rPCM12 EQU $FF76 ; -- Bit 7-4 - Copy of sound channel 4's PCM amplitude ; -- Bit 3-0 - Copy of sound channel 3's PCM amplitude ; -- -rPCM34 EQU $FF77 +oPCM34 EQU $77 +rPCM34 EQU (_HW + oPCM34) + + +; -- +; -- IE ($FFFF) +; -- Interrupt Enable (R/W) +; -- +oIE EQU $FF +rIE EQU (_HW + oIE) + +IEF_HILO EQU %00010000 ; Transition from High to Low of Pin number P10-P13 +IEF_SERIAL EQU %00001000 ; Serial I/O transfer end +IEF_TIMER EQU %00000100 ; Timer Overflow +IEF_LCDC EQU %00000010 ; LCDC (see STAT) +IEF_VBLANK EQU %00000001 ; V-Blank ;*************************************************************************** @@ -734,16 +774,33 @@ AUDHIGH_LENGTH_ON EQU %01000000 AUDHIGH_LENGTH_OFF EQU %00000000 +;*************************************************************************** +;* +;* CPU value on bootup (a=type) +;* +;*************************************************************************** + +CPU_DMG EQU $01 ; Dot Matrix Game +CPU_CGB EQU $11 ; Color GameBoy +CPU_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) + + ;*************************************************************************** ;* ;* Cart related ;* ;*************************************************************************** +; $0143 Color GameBoy compatibility code CART_COMPATIBLE_DMG EQU $00 CART_COMPATIBLE_DMG_GBC EQU $80 CART_COMPATIBLE_GBC EQU $C0 +; $0146 GameBoy/Super GameBoy indicator +CART_INDICATOR_GB EQU $00 +CART_INDICATOR_SGB EQU $03 + +; $0147 Cartridge type CART_ROM EQU $00 CART_ROM_MBC1 EQU $01 CART_ROM_MBC1_RAM EQU $02 @@ -752,6 +809,9 @@ CART_ROM_MBC2 EQU $05 CART_ROM_MBC2_BAT EQU $06 CART_ROM_RAM EQU $08 CART_ROM_RAM_BAT EQU $09 +CART_ROM_MMM01 EQU $0B +CART_ROM_MMM01_RAM EQU $0C +CART_ROM_MMM01_RAM_BAT EQU $0D CART_ROM_MBC3_BAT_RTC EQU $0F CART_ROM_MBC3_RAM_BAT_RTC EQU $10 CART_ROM_MBC3 EQU $11 @@ -765,17 +825,25 @@ CART_ROM_MBC5_RAM_RUMBLE EQU $1D CART_ROM_MBC5_RAM_BAT_RUMBLE EQU $1E CART_ROM_MBC7_RAM_BAT_GYRO EQU $22 CART_ROM_POCKET_CAMERA EQU $FC - -CART_ROM_256K EQU 0 ; 2 banks -CART_ROM_512K EQU 1 ; 4 banks -CART_ROM_1M EQU 2 ; 8 banks -CART_ROM_2M EQU 3 ; 16 banks -CART_ROM_4M EQU 4 ; 32 banks -CART_ROM_8M EQU 5 ; 64 banks -CART_ROM_16M EQU 6 ; 128 banks -CART_ROM_32M EQU 7 ; 256 banks -CART_ROM_64M EQU 8 ; 512 banks - +CART_ROM_BANDAI_TAMA5 EQU $FD +CART_ROM_HUDSON_HUC3 EQU $FE +CART_ROM_HUDSON_HUC1 EQU $FF + +; $0148 ROM size +CART_ROM_256K EQU $00 ; 2 banks +CART_ROM_512K EQU $01 ; 4 banks +CART_ROM_1M EQU $02 ; 8 banks +CART_ROM_2M EQU $03 ; 16 banks +CART_ROM_4M EQU $04 ; 32 banks +CART_ROM_8M EQU $05 ; 64 banks +CART_ROM_16M EQU $06 ; 128 banks +CART_ROM_32M EQU $07 ; 256 banks +CART_ROM_64M EQU $08 ; 512 banks +CART_ROM_9M EQU $52 ; 72 banks +CART_ROM_10M EQU $53 ; 80 banks +CART_ROM_12M EQU $54 ; 96 banks + +; $0149 RAM size CART_RAM_NONE EQU 0 CART_RAM_16K EQU 1 ; 1 incomplete bank CART_RAM_64K EQU 2 ; 1 bank @@ -785,6 +853,11 @@ CART_RAM_1M EQU 4 ; 16 banks CART_RAM_ENABLE EQU $0A CART_RAM_DISABLE EQU $00 +; $014A Destination code +CART_DEST_JAPANESE EQU $00 +CART_DEST_NON_JAPANESE EQU $01 + + ;*************************************************************************** ;* ;* Keypad related @@ -809,6 +882,7 @@ PADB_SELECT EQU $2 PADB_B EQU $1 PADB_A EQU $0 + ;*************************************************************************** ;* ;* Screen related From 14f50b1053ed8b34b1dfd749b276302c27fd0051 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Sat, 4 Jul 2020 12:00:53 -0700 Subject: [PATCH 02/10] Update based on PR comments - Add more memory map convenience equ's - Add rSMBK which makes more sense (to me) than rSVBK - Revert the 'o' equ's - Rename the bootup CPU values - Changed to kilobyte-based size equ's --- hardware.inc | 238 ++++++++++++++++++++------------------------------- 1 file changed, 94 insertions(+), 144 deletions(-) diff --git a/hardware.inc b/hardware.inc index 83bf81a..5910c03 100644 --- a/hardware.inc +++ b/hardware.inc @@ -24,6 +24,7 @@ ;* Rev 2.7 - 19-Jan-19 : Added rPCMXX (ISSOtm) ;* Rev 2.8 - 03-Feb-19 : Added audio registers flags (Álvaro Cuesta) ;* Rev 2.9 - 28-Feb-20 : Added utility rP1 constants +;* Rev 3.0 - 04-Jul-20 : Register ordering, byte-based sizes, general cleanup (Blitter Object) ; If all of these are already defined, don't do it again. @@ -33,19 +34,21 @@ HARDWARE_INC SET 1 rev_Check_hardware_inc : MACRO ;NOTE: REVISION NUMBER CHANGES MUST BE ADDED ;TO SECOND PARAMETER IN FOLLOWING LINE. - IF \1 > 2.9 ;PUT REVISION NUMBER HERE + IF \1 > 3.0 ;PUT REVISION NUMBER HERE WARN "Version \1 or later of 'hardware.inc' is required." ENDC ENDM -_HW EQU $FF00 ; $FF00->$FF7F,$FFFF - _VRAM EQU $8000 ; $8000->$9FFF +_VRAM8800 EQU $8800 +_VRAM9000 EQU $9000 _SCRN0 EQU $9800 ; $9800->$9BFF _SCRN1 EQU $9C00 ; $9C00->$9FFF _SRAM EQU $A000 ; $A000->$BFFF -_RAM EQU $C000 ; $C000->$DFFF +_RAM EQU $C000 ; $C000->$CFFF / $C000->$DFFF +_RAMBANK EQU $D000 ; $D000->$DFFF _OAMRAM EQU $FE00 ; $FE00->$FE9F +_IO EQU $FF00 ; $FF00->$FF7F,$FFFF _AUD3WAVERAM EQU $FF30 ; $FF30->$FF3F _HRAM EQU $FF80 ; $FF80->$FFFE @@ -88,8 +91,7 @@ OAMB_BANK1 EQU 3 ; Bank number; 0,1 (GBC) ; -- P1 ($FF00) ; -- Register for reading joy pad info. (R/W) ; -- -oP1 EQU $00 -rP1 EQU (_HW + oP1) +rP1 EQU $FF00 P1F_5 EQU %00100000 ; P15 out port, set to 0 to get buttons P1F_4 EQU %00010000 ; P14 out port, set to 0 to get dpad @@ -102,52 +104,47 @@ P1F_GET_DPAD EQU P1F_5 P1F_GET_BTN EQU P1F_4 P1F_GET_NONE EQU P1F_4 | P1F_5 + ; -- ; -- SB ($FF01) ; -- Serial Transfer Data (R/W) ; -- -oSB EQU $01 -rSB EQU (_HW + oSB) +rSB EQU $FF01 ; -- ; -- SC ($FF02) ; -- Serial I/O Control (R/W) ; -- -oSC EQU $02 -rSC EQU (_HW + oSC) +rSC EQU $FF02 ; -- ; -- DIV ($FF04) ; -- Divider register (R/W) ; -- -oDIV EQU $04 -rDIV EQU (_HW + oDIV) +rDIV EQU $FF04 ; -- ; -- TIMA ($FF05) ; -- Timer counter (R/W) ; -- -oTIMA EQU $05 -rTIMA EQU (_HW + oTIMA) +rTIMA EQU $FF05 ; -- ; -- TMA ($FF06) ; -- Timer modulo (R/W) ; -- -oTMA EQU $06 -rTMA EQU (_HW + oTMA) +rTMA EQU $FF06 ; -- ; -- TAC ($FF07) ; -- Timer control (R/W) ; -- -oTAC EQU $07 -rTAC EQU (_HW + oTAC) +rTAC EQU $FF07 TACF_START EQU %00000100 TACF_STOP EQU %00000000 @@ -161,8 +158,7 @@ TACF_262KHZ EQU %00000001 ; -- IF ($FF0F) ; -- Interrupt Flag (R/W) ; -- -oIF EQU $0F -rIF EQU (_HW + oIF) +rIF EQU $FF0F ; -- @@ -176,8 +172,7 @@ rIF EQU (_HW + oIF) ; -- Bit 2-0 - Number of sweep shift (# 0-7) ; -- Sweep Time: (n*7.8ms) ; -- -oNR10 EQU $10 -rNR10 EQU (_HW + oNR10) +rNR10 EQU $FF10 rAUD1SWEEP EQU rNR10 AUD1SWEEP_UP EQU %00000000 @@ -191,8 +186,7 @@ AUD1SWEEP_DOWN EQU %00001000 ; -- Bit 7-6 - Wave Pattern Duty (00:12.5% 01:25% 10:50% 11:75%) ; -- Bit 5-0 - Sound length data (# 0-63) ; -- -oNR11 EQU $11 -rNR11 EQU (_HW + oNR11) +rNR11 EQU $FF11 rAUD1LEN EQU rNR11 @@ -206,8 +200,7 @@ rAUD1LEN EQU rNR11 ; -- 1: Range of increase ; -- Bit 2-0 - Number of envelope sweep (# 0-7) ; -- -oNR12 EQU $12 -rNR12 EQU (_HW + oNR12) +rNR12 EQU $FF12 rAUD1ENV EQU rNR12 @@ -215,8 +208,7 @@ rAUD1ENV EQU rNR12 ; -- AUD1LOW/NR13 ($FF13) ; -- Frequency lo (W) ; -- -oNR13 EQU $13 -rNR13 EQU (_HW + oNR13) +rNR13 EQU $FF13 rAUD1LOW EQU rNR13 @@ -228,8 +220,7 @@ rAUD1LOW EQU rNR13 ; -- Bit 6 - Counter/consecutive selection ; -- Bit 2-0 - Frequency's higher 3 bits ; -- -oNR14 EQU $14 -rNR14 EQU (_HW + oNR14) +rNR14 EQU $FF14 rAUD1HIGH EQU rNR14 @@ -239,8 +230,7 @@ rAUD1HIGH EQU rNR14 ; -- ; -- see AUD1LEN for info ; -- -oNR21 EQU $16 -rNR21 EQU (_HW + oNR21) +rNR21 EQU $FF16 rAUD2LEN EQU rNR21 @@ -250,8 +240,7 @@ rAUD2LEN EQU rNR21 ; -- ; -- see AUD1ENV for info ; -- -oNR22 EQU $17 -rNR22 EQU (_HW + oNR22) +rNR22 EQU $FF17 rAUD2ENV EQU rNR22 @@ -259,8 +248,7 @@ rAUD2ENV EQU rNR22 ; -- AUD2LOW/NR23 ($FF18) ; -- Frequency lo (W) ; -- -oNR23 EQU $18 -rNR23 EQU (_HW + oNR23) +rNR23 EQU $FF18 rAUD2LOW EQU rNR23 @@ -270,8 +258,7 @@ rAUD2LOW EQU rNR23 ; -- ; -- see AUD1HIGH for info ; -- -oNR24 EQU $19 -rNR24 EQU (_HW + oNR24) +rNR24 EQU $FF19 rAUD2HIGH EQU rNR24 @@ -281,8 +268,7 @@ rAUD2HIGH EQU rNR24 ; -- ; -- Bit 7 - Sound ON/OFF (1=ON,0=OFF) ; -- -oNR30 EQU $1A -rNR30 EQU (_HW + oNR30) +rNR30 EQU $FF1A rAUD3ENA EQU rNR30 @@ -292,8 +278,7 @@ rAUD3ENA EQU rNR30 ; -- ; -- Bit 7-0 - Sound length ; -- -oNR31 EQU $1B -rNR31 EQU (_HW + oNR31) +rNR31 EQU $FF1B rAUD3LEN EQU rNR31 @@ -307,8 +292,7 @@ rAUD3LEN EQU rNR31 ; -- 10: 1/2 ; -- 11: 1/4 ; -- -oNR32 EQU $1C -rNR32 EQU (_HW + oNR32) +rNR32 EQU $FF1C rAUD3LEVEL EQU rNR32 @@ -318,8 +302,7 @@ rAUD3LEVEL EQU rNR32 ; -- ; -- see AUD1LOW for info ; -- -oNR33 EQU $1D -rNR33 EQU (_HW + oNR33) +rNR33 EQU $FF1D rAUD3LOW EQU rNR33 @@ -329,8 +312,7 @@ rAUD3LOW EQU rNR33 ; -- ; -- see AUD1HIGH for info ; -- -oNR34 EQU $1E -rNR34 EQU (_HW + oNR34) +rNR34 EQU $FF1E rAUD3HIGH EQU rNR34 @@ -340,8 +322,7 @@ rAUD3HIGH EQU rNR34 ; -- ; -- Bit 5-0 - Sound length data (# 0-63) ; -- -oNR41 EQU $20 -rNR41 EQU (_HW + oNR41) +rNR41 EQU $FF20 rAUD4LEN EQU rNR41 @@ -351,8 +332,7 @@ rAUD4LEN EQU rNR41 ; -- ; -- see AUD1ENV for info ; -- -oNR42 EQU $21 -rNR42 EQU (_HW + oNR42) +rNR42 EQU $FF21 rAUD4ENV EQU rNR42 @@ -370,8 +350,7 @@ rAUD4ENV EQU rNR42 ; -- 000: f/4 001: f/8 010: f/16 011: f/24 ; -- 100: f/32 101: f/40 110: f/48 111: f/56 (f=4.194304 Mhz) ; -- -oNR43 EQU $22 -rNR43 EQU (_HW + oNR43) +rNR43 EQU $FF22 rAUD4POLY EQU rNR43 @@ -382,8 +361,7 @@ rAUD4POLY EQU rNR43 ; -- Bit 7 - Inital ; -- Bit 6 - Counter/consecutive selection ; -- -oNR44 EQU $23 -rNR44 EQU (_HW + oNR44) +rNR44 EQU $FF23 rAUD4GO EQU rNR44 ; silly name! @@ -396,8 +374,7 @@ rAUD4GO EQU rNR44 ; silly name! ; -- Bit 3 - Vin->SO1 ON/OFF (Vin??) ; -- Bit 2-0 - SO1 output level (volume) (# 0-7) ; -- -oNR50 EQU $24 -rNR50 EQU (_HW + oNR50) +rNR50 EQU $FF24 rAUDVOL EQU rNR50 AUDVOL_VIN_LEFT EQU %10000000 ; SO2 @@ -417,8 +394,7 @@ AUDVOL_VIN_RIGHT EQU %00001000 ; SO1 ; -- Bit 1 - Output sound 2 to SO1 terminal ; -- Bit 0 - Output sound 0 to SO1 terminal ; -- -oNR51 EQU $25 -rNR51 EQU (_HW + oNR51) +rNR51 EQU $FF25 rAUDTERM EQU rNR51 ; SO2 @@ -443,8 +419,7 @@ AUDTERM_1_RIGHT EQU %00000001 ; -- Bit 1 - Sound 2 ON flag (doesn't work!) ; -- Bit 0 - Sound 1 ON flag (doesn't work!) ; -- -oNR52 EQU $26 -rNR52 EQU (_HW + oNR52) +rNR52 EQU $FF26 rAUDENA EQU rNR52 AUDENA_ON EQU %10000000 @@ -455,8 +430,7 @@ AUDENA_OFF EQU %00000000 ; sets all audio regs to 0! ; -- LCDC ($FF40) ; -- LCD Control (R/W) ; -- -oLCDC EQU $40 -rLCDC EQU (_HW + oLCDC) +rLCDC EQU $FF40 LCDCF_OFF EQU %00000000 ; LCD Control Operation LCDCF_ON EQU %10000000 ; LCD Control Operation @@ -481,8 +455,7 @@ LCDCF_BGON EQU %00000001 ; BG Display ; -- STAT ($FF41) ; -- LCDC Status (R/W) ; -- -oSTAT EQU $41 -rSTAT EQU (_HW + oSTAT) +rSTAT EQU $FF41 STATF_LYC EQU %01000000 ; LYC=LY Coincidence (Selectable) STATF_MODE10 EQU %00100000 ; Mode 10 @@ -500,16 +473,14 @@ STATF_BUSY EQU %00000010 ; When set, VRAM access is unsafe ; -- SCY ($FF42) ; -- Scroll Y (R/W) ; -- -oSCY EQU $42 -rSCY EQU (_HW + oSCY) +rSCY EQU $FF42 ; -- ; -- SCY ($FF43) ; -- Scroll X (R/W) ; -- -oSCX EQU $43 -rSCX EQU (_HW + oSCX) +rSCX EQU $FF43 ; -- @@ -518,8 +489,7 @@ rSCX EQU (_HW + oSCX) ; -- ; -- Values range from 0->153. 144->153 is the VBlank period. ; -- -oLY EQU $44 -rLY EQU (_HW + oLY) +rLY EQU $FF44 ; -- @@ -528,16 +498,14 @@ rLY EQU (_HW + oLY) ; -- ; -- When LY==LYC, STATF_LYCF will be set in STAT ; -- -oLYC EQU $45 -rLYC EQU (_HW + oLYC) +rLYC EQU $FF45 ; -- ; -- DMA ($FF46) ; -- DMA Transfer and Start Address (W) ; -- -oDMA EQU $46 -rDMA EQU (_HW + oDMA) +rDMA EQU $FF46 ; -- @@ -549,8 +517,7 @@ rDMA EQU (_HW + oDMA) ; -- Bit 3-2 - Intensity for %01 ; -- Bit 1-0 - Intensity for %00 ; -- -oBGP EQU $47 -rBGP EQU (_HW + oBGP) +rBGP EQU $FF47 ; -- @@ -559,8 +526,7 @@ rBGP EQU (_HW + oBGP) ; -- ; -- See BGP for info ; -- -oOBP0 EQU $48 -rOBP0 EQU (_HW + oOBP0) +rOBP0 EQU $FF48 ; -- @@ -569,8 +535,7 @@ rOBP0 EQU (_HW + oOBP0) ; -- ; -- See BGP for info ; -- -oOBP1 EQU $49 -rOBP1 EQU (_HW + oOBP1) +rOBP1 EQU $FF49 ; -- @@ -579,8 +544,7 @@ rOBP1 EQU (_HW + oOBP1) ; -- ; -- 0 <= WY <= 143 ; -- -oWY EQU $4A -rWY EQU (_HW + oWY) +rWY EQU $FF4A ; -- @@ -589,16 +553,14 @@ rWY EQU (_HW + oWY) ; -- ; -- 7 <= WX <= 166 ; -- -oWX EQU $4B -rWX EQU (_HW + oWX) +rWX EQU $FF4B ; -- ; -- KEY 1 ($FF4D) ; -- Select CPU Speed (R/W) ; -- -oKEY1 EQU $4D -rKEY1 EQU (_HW + oKEY1) +rKEY1 EQU $FF4D ; -- @@ -607,98 +569,87 @@ rKEY1 EQU (_HW + oKEY1) ; -- ; -- Bit 0 - Bank Specification (0: Specify Bank 0; 1: Specify Bank 1) ; -- -oVBK EQU $4F -rVBK EQU (_HW + oVBK) +rVBK EQU $FF4F ; -- ; -- HDMA1 ($FF51) ; -- Horizontal Blanking, General Purpose DMA (W) ; -- -oHDMA1 EQU $51 -rHDMA1 EQU (_HW + oHDMA1) +rHDMA1 EQU $FF51 ; -- ; -- HDMA2 ($FF52) ; -- Horizontal Blanking, General Purpose DMA (W) ; -- -oHDMA2 EQU $52 -rHDMA2 EQU (_HW + oHDMA2) +rHDMA2 EQU $FF52 ; -- ; -- HDMA3 ($FF53) ; -- Horizontal Blanking, General Purpose DMA (W) ; -- -oHDMA3 EQU $53 -rHDMA3 EQU (_HW + oHDMA3) +rHDMA3 EQU $FF53 ; -- ; -- HDMA4 ($FF54) ; -- Horizontal Blanking, General Purpose DMA (W) ; -- -oHDMA4 EQU $54 -rHDMA4 EQU (_HW + oHDMA4) +rHDMA4 EQU $FF54 ; -- ; -- HDMA5 ($FF55) ; -- Horizontal Blanking, General Purpose DMA (R/W) ; -- -oHDMA5 EQU $55 -rHDMA5 EQU (_HW + oHDMA5) +rHDMA5 EQU $FF55 ; -- ; -- RP ($FF56) ; -- Infrared Communications Port (R/W) ; -- -oRP EQU $56 -rRP EQU (_HW + oRP) +rRP EQU $FF56 ; -- ; -- BCPS ($FF68) ; -- Background Color Palette Specification (R/W) ; -- -oBCPS EQU $68 -rBCPS EQU (_HW + oBCPS) +rBCPS EQU $FF68 ; -- ; -- BCPD ($FF69) ; -- Background Color Palette Data (R/W) ; -- -oBCPD EQU $69 -rBCPD EQU (_HW + oBCPD) +rBCPD EQU $FF69 ; -- ; -- BCPS ($FF6A) ; -- Object Color Palette Specification (R/W) ; -- -oOCPS EQU $6A -rOCPS EQU (_HW + oOCPS) +rOCPS EQU $FF6A ; -- ; -- BCPD ($FF6B) ; -- Object Color Palette Data (R/W) ; -- -oOCPD EQU $6B -rOCPD EQU (_HW + oOCPD) +rOCPD EQU $FF6B ; -- -; -- SVBK ($FF70) +; -- SMBK/SVBK ($FF70) ; -- Select Main RAM Bank (R/W) ; -- ; -- Bit 2-0 - Bank Specification (0,1: Specify Bank 1; 2-7: Specify Banks 2-7) ; -- -oSVBK EQU $70 -rSVBK EQU (_HW + oSVBK) +rSVBK EQU $FF70 +rSMBK EQU rSVBK ; -- @@ -708,8 +659,7 @@ rSVBK EQU (_HW + oSVBK) ; -- Bit 7-4 - Copy of sound channel 2's PCM amplitude ; -- Bit 3-0 - Copy of sound channel 1's PCM amplitude ; -- -oPCM12 EQU $76 -rPCM12 EQU (_HW + oPCM12) +rPCM12 EQU $FF76 ; -- @@ -719,16 +669,14 @@ rPCM12 EQU (_HW + oPCM12) ; -- Bit 7-4 - Copy of sound channel 4's PCM amplitude ; -- Bit 3-0 - Copy of sound channel 3's PCM amplitude ; -- -oPCM34 EQU $77 -rPCM34 EQU (_HW + oPCM34) +rPCM34 EQU $FF77 ; -- ; -- IE ($FFFF) ; -- Interrupt Enable (R/W) ; -- -oIE EQU $FF -rIE EQU (_HW + oIE) +rIE EQU $FFFF IEF_HILO EQU %00010000 ; Transition from High to Low of Pin number P10-P13 IEF_SERIAL EQU %00001000 ; Serial I/O transfer end @@ -783,9 +731,9 @@ AUDHIGH_LENGTH_OFF EQU %00000000 ;* ;*************************************************************************** -CPU_DMG EQU $01 ; Dot Matrix Game -CPU_CGB EQU $11 ; Color GameBoy -CPU_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) +BOOTUP_DMG EQU $01 ; Dot Matrix Game +BOOTUP_CGB EQU $11 ; Color GameBoy +BOOTUP_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) ;*************************************************************************** @@ -833,28 +781,30 @@ CART_ROM_HUDSON_HUC3 EQU $FE CART_ROM_HUDSON_HUC1 EQU $FF ; $0148 ROM size -CART_ROM_256K EQU $00 ; 2 banks -CART_ROM_512K EQU $01 ; 4 banks -CART_ROM_1M EQU $02 ; 8 banks -CART_ROM_2M EQU $03 ; 16 banks -CART_ROM_4M EQU $04 ; 32 banks -CART_ROM_8M EQU $05 ; 64 banks -CART_ROM_16M EQU $06 ; 128 banks -CART_ROM_32M EQU $07 ; 256 banks -CART_ROM_64M EQU $08 ; 512 banks -CART_ROM_9M EQU $52 ; 72 banks -CART_ROM_10M EQU $53 ; 80 banks -CART_ROM_12M EQU $54 ; 96 banks - -; $0149 RAM size -CART_RAM_NONE EQU 0 -CART_RAM_16K EQU 1 ; 1 incomplete bank -CART_RAM_64K EQU 2 ; 1 bank -CART_RAM_256K EQU 3 ; 4 banks -CART_RAM_1M EQU 4 ; 16 banks - -CART_RAM_ENABLE EQU $0A -CART_RAM_DISABLE EQU $00 +; these are kilobytes +CART_ROM_32K EQU $00 ; 2 banks +CART_ROM_64K EQU $01 ; 4 banks +CART_ROM_128K EQU $02 ; 8 banks +CART_ROM_256K EQU $03 ; 16 banks +CART_ROM_512K EQU $04 ; 32 banks +CART_ROM_1024K EQU $05 ; 64 banks +CART_ROM_2048K EQU $06 ; 128 banks +CART_ROM_4096K EQU $07 ; 256 banks +CART_ROM_8192K EQU $08 ; 512 banks +CART_ROM_1152K EQU $52 ; 72 banks +CART_ROM_1280K EQU $53 ; 80 banks +CART_ROM_1536K EQU $54 ; 96 banks + +; $0149 SRAM size +; these are kilobytes +CART_SRAM_NONE EQU 0 +CART_SRAM_2K EQU 1 ; 1 incomplete bank +CART_SRAM_8K EQU 2 ; 1 bank +CART_SRAM_32K EQU 3 ; 4 banks +CART_SRAM_128K EQU 4 ; 16 banks + +CART_SRAM_ENABLE EQU $0A +CART_SRAM_DISABLE EQU $00 ; $014A Destination code CART_DEST_JAPANESE EQU $00 From 31b48d5d517634b469611cf788025ff66341ae53 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Sat, 4 Jul 2020 14:48:01 -0700 Subject: [PATCH 03/10] Extend the BOOTUP- and OAM sections --- hardware.inc | 72 +++++++++++++++++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 26 deletions(-) diff --git a/hardware.inc b/hardware.inc index 5910c03..94cfd86 100644 --- a/hardware.inc +++ b/hardware.inc @@ -24,7 +24,7 @@ ;* Rev 2.7 - 19-Jan-19 : Added rPCMXX (ISSOtm) ;* Rev 2.8 - 03-Feb-19 : Added audio registers flags (Álvaro Cuesta) ;* Rev 2.9 - 28-Feb-20 : Added utility rP1 constants -;* Rev 3.0 - 04-Jul-20 : Register ordering, byte-based sizes, general cleanup (Blitter Object) +;* Rev 3.0 - 04-Jul-20 : Register ordering, byte-based sizes, OAM additions, general cleanup (Blitter Object) ; If all of these are already defined, don't do it again. @@ -60,27 +60,6 @@ rROMB1 EQU $3000 ; $3000->$3fff - If more than 256 ROM banks are present. rRAMB EQU $4000 ; $4000->$5fff - Bit 3 enables rumble (if present) -; -- -; -- OAM flags -; -- - -OAMF_PRI EQU %10000000 ; Priority -OAMF_YFLIP EQU %01000000 ; Y flip -OAMF_XFLIP EQU %00100000 ; X flip -OAMF_PAL0 EQU %00000000 ; Palette number; 0,1 (DMG) -OAMF_PAL1 EQU %00010000 ; Palette number; 0,1 (DMG) -OAMF_BANK0 EQU %00000000 ; Bank number; 0,1 (GBC) -OAMF_BANK1 EQU %00001000 ; Bank number; 0,1 (GBC) - -OAMF_PALMASK EQU %00000111 ; Palette (GBC) - -OAMB_PRI EQU 7 ; Priority -OAMB_YFLIP EQU 6 ; Y flip -OAMB_XFLIP EQU 5 ; X flip -OAMB_PAL1 EQU 4 ; Palette number; 0,1 (DMG) -OAMB_BANK1 EQU 3 ; Bank number; 0,1 (GBC) - - ;*************************************************************************** ;* ;* Custom registers @@ -727,13 +706,18 @@ AUDHIGH_LENGTH_OFF EQU %00000000 ;*************************************************************************** ;* -;* CPU value on bootup (a=type) +;* CPU values on bootup (a=type, b=qualifier) ;* ;*************************************************************************** -BOOTUP_DMG EQU $01 ; Dot Matrix Game -BOOTUP_CGB EQU $11 ; Color GameBoy -BOOTUP_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) +BOOTUP_A_DMG EQU $01 ; Dot Matrix Game +BOOTUP_A_CGB EQU $11 ; Color GameBoy +BOOTUP_A_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) + +; if a=BOOTUP_A_CGB, bit 0 in b can be checked to determine if real CGB or +; other system running in GBC mode +BOOTUP_B_CGB EQU %00000000 +BOOTUP_B_OTHER EQU %00000001 ; GBA, GBA SP, Game Boy Player, or New GBA SP ;*************************************************************************** @@ -852,6 +836,42 @@ SCRN_VY EQU 256 ; Virtual height of screen in pixels SCRN_VX_B EQU 32 ; Virtual width of screen in bytes SCRN_VY_B EQU 32 ; Virtual height of screen in bytes + +;*************************************************************************** +;* +;* OAM related +;* +;*************************************************************************** + +; OAM attributes +; each entry in OAM RAM is 4 bytes (sizeof_OAM_ATTRS) +RSRESET +OAMA_Y RB 1 ; y pos +OAMA_X RB 1 ; x pos +OAMA_TILEID RB 1 ; tile id +OAMA_FLAGS RB 1 ; flags (see below) +sizeof_OAM_ATTRS RB 0 + +OAM_COUNT EQU 40 ; number of OAM entries in OAM RAM + +; flags +OAMF_PRI EQU %10000000 ; Priority +OAMF_YFLIP EQU %01000000 ; Y flip +OAMF_XFLIP EQU %00100000 ; X flip +OAMF_PAL0 EQU %00000000 ; Palette number; 0,1 (DMG) +OAMF_PAL1 EQU %00010000 ; Palette number; 0,1 (DMG) +OAMF_BANK0 EQU %00000000 ; Bank number; 0,1 (GBC) +OAMF_BANK1 EQU %00001000 ; Bank number; 0,1 (GBC) + +OAMF_PALMASK EQU %00000111 ; Palette (GBC) + +OAMB_PRI EQU 7 ; Priority +OAMB_YFLIP EQU 6 ; Y flip +OAMB_XFLIP EQU 5 ; X flip +OAMB_PAL1 EQU 4 ; Palette number; 0,1 (DMG) +OAMB_BANK1 EQU 3 ; Bank number; 0,1 (GBC) + + ;* ;* Nintendo scrolling logo ;* (Code won't work on a real GameBoy) From 88a2c1fb833e3ddcb2dcddde1b284f3d14ad98ac Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Wed, 5 Aug 2020 15:47:45 -0700 Subject: [PATCH 04/10] Update to latest version --- hardware.inc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/hardware.inc b/hardware.inc index 94cfd86..49241dc 100644 --- a/hardware.inc +++ b/hardware.inc @@ -393,10 +393,10 @@ AUDTERM_1_RIGHT EQU %00000001 ; -- Sound on/off (R/W) ; -- ; -- Bit 7 - All sound on/off (sets all audio regs to 0!) -; -- Bit 3 - Sound 4 ON flag (doesn't work!) -; -- Bit 2 - Sound 3 ON flag (doesn't work!) -; -- Bit 1 - Sound 2 ON flag (doesn't work!) -; -- Bit 0 - Sound 1 ON flag (doesn't work!) +; -- Bit 3 - Sound 4 ON flag (read only) +; -- Bit 2 - Sound 3 ON flag (read only) +; -- Bit 1 - Sound 2 ON flag (read only) +; -- Bit 0 - Sound 1 ON flag (read only) ; -- rNR52 EQU $FF26 rAUDENA EQU rNR52 From 7ef59b45840ea4d69eae2da35bcf3ce21b533e80 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Thu, 6 Aug 2020 10:09:27 -0700 Subject: [PATCH 05/10] Added flags where applicable; review comments --- hardware.inc | 61 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 20 deletions(-) diff --git a/hardware.inc b/hardware.inc index 49241dc..842a5ca 100644 --- a/hardware.inc +++ b/hardware.inc @@ -40,6 +40,7 @@ rev_Check_hardware_inc : MACRO ENDM _VRAM EQU $8000 ; $8000->$9FFF +_VRAM8000 EQU _VRAM _VRAM8800 EQU $8800 _VRAM9000 EQU $9000 _SCRN0 EQU $9800 ; $9800->$9BFF @@ -68,7 +69,7 @@ rRAMB EQU $4000 ; $4000->$5fff - Bit 3 enables rumble (if present) ; -- ; -- P1 ($FF00) -; -- Register for reading joy pad info. (R/W) +; -- Register for reading joy pad info. (R/W) ; -- rP1 EQU $FF00 @@ -185,7 +186,7 @@ rAUD1ENV EQU rNR12 ; -- ; -- AUD1LOW/NR13 ($FF13) -; -- Frequency lo (W) +; -- Frequency low byte (W) ; -- rNR13 EQU $FF13 rAUD1LOW EQU rNR13 @@ -193,7 +194,7 @@ rAUD1LOW EQU rNR13 ; -- ; -- AUD1HIGH/NR14 ($FF14) -; -- Frequency hi (W) +; -- Frequency high byte (W) ; -- ; -- Bit 7 - Initial (when set, sound restarts) ; -- Bit 6 - Counter/consecutive selection @@ -225,7 +226,7 @@ rAUD2ENV EQU rNR22 ; -- ; -- AUD2LOW/NR23 ($FF18) -; -- Frequency lo (W) +; -- Frequency low byte (W) ; -- rNR23 EQU $FF18 rAUD2LOW EQU rNR23 @@ -233,7 +234,7 @@ rAUD2LOW EQU rNR23 ; -- ; -- AUD2HIGH/NR24 ($FF19) -; -- Frequency hi (W) +; -- Frequency high byte (W) ; -- ; -- see AUD1HIGH for info ; -- @@ -277,7 +278,7 @@ rAUD3LEVEL EQU rNR32 ; -- ; -- AUD3LOW/NR33 ($FF1D) -; -- Frequency lo (W) +; -- Frequency low byte (W) ; -- ; -- see AUD1LOW for info ; -- @@ -287,7 +288,7 @@ rAUD3LOW EQU rNR33 ; -- ; -- AUD3HIGH/NR34 ($FF1E) -; -- Frequency hi (W) +; -- Frequency high byte (W) ; -- ; -- see AUD1HIGH for info ; -- @@ -335,13 +336,12 @@ rAUD4POLY EQU rNR43 ; -- ; -- AUD4GO/NR44 ($FF23) -; -- (has wrong name and value (ff30) in Dr.Pan's doc!) ; -- ; -- Bit 7 - Inital ; -- Bit 6 - Counter/consecutive selection ; -- rNR44 EQU $FF23 -rAUD4GO EQU rNR44 ; silly name! +rAUD4GO EQU rNR44 ; -- @@ -441,8 +441,8 @@ STATF_MODE10 EQU %00100000 ; Mode 10 STATF_MODE01 EQU %00010000 ; Mode 01 (V-Blank) STATF_MODE00 EQU %00001000 ; Mode 00 (H-Blank) STATF_LYCF EQU %00000100 ; Coincidence Flag -STATF_HB EQU %00000000 ; H-Blank -STATF_VB EQU %00000001 ; V-Blank +STATF_HBL EQU %00000000 ; H-Blank +STATF_VBL EQU %00000001 ; V-Blank STATF_OAM EQU %00000010 ; OAM-RAM is used by system STATF_LCD EQU %00000011 ; Both OAM and VRAM used by system STATF_BUSY EQU %00000010 ; When set, VRAM access is unsafe @@ -522,6 +522,7 @@ rOBP1 EQU $FF49 ; -- Window Y Position (R/W) ; -- ; -- 0 <= WY <= 143 +; -- When WY = 0, the window is displayed from the top edge of the LCD screen. ; -- rWY EQU $FF4A @@ -531,15 +532,20 @@ rWY EQU $FF4A ; -- Window X Position (R/W) ; -- ; -- 7 <= WX <= 166 +; -- When WX = 7, the window is displayed from the left edge of the LCD screen. +; -- Values of 0-6 and 166 are unreliable due to hardware bugs. ; -- rWX EQU $FF4B ; -- -; -- KEY 1 ($FF4D) +; -- SPEED ($FF4D) ; -- Select CPU Speed (R/W) ; -- -rKEY1 EQU $FF4D +rSPD EQU $FF4D + +SPDF_DBLSPEED EQU %10000000 ; 0=Normal Speed, 1=Double Speed (R) +SPDF_PREPARE EQU %00000001 ; 0=No, 1=Prepare (R/W) ; -- @@ -553,38 +559,49 @@ rVBK EQU $FF4F ; -- ; -- HDMA1 ($FF51) -; -- Horizontal Blanking, General Purpose DMA (W) +; -- High byte for Horizontal Blanking/General Purpose DMA source address (W) +; -- CGB Mode Only ; -- rHDMA1 EQU $FF51 ; -- ; -- HDMA2 ($FF52) -; -- Horizontal Blanking, General Purpose DMA (W) +; -- Low byte for Horizontal Blanking/General Purpose DMA source address (W) +; -- CGB Mode Only ; -- rHDMA2 EQU $FF52 ; -- ; -- HDMA3 ($FF53) -; -- Horizontal Blanking, General Purpose DMA (W) +; -- High byte for Horizontal Blanking/General Purpose DMA destination address (W) +; -- CGB Mode Only ; -- rHDMA3 EQU $FF53 ; -- ; -- HDMA4 ($FF54) -; -- Horizontal Blanking, General Purpose DMA (W) +; -- Low byte for Horizontal Blanking/General Purpose DMA destination address (W) +; -- CGB Mode Only ; -- rHDMA4 EQU $FF54 ; -- ; -- HDMA5 ($FF55) -; -- Horizontal Blanking, General Purpose DMA (R/W) +; -- Transfer length (in bytes)/mode/start for Horizontal Blanking, General Purpose DMA (R/W) +; -- CGB Mode Only ; -- rHDMA5 EQU $FF55 +HDMA5F_MODE_GP EQU %00000000 ; General Purpose DMA (W) +HDMA5F_MODE_HBL EQU %10000000 ; HBlank DMA (W) + +; -- Once DMA has started, use HDMA5F_BUSY to check when the transfer is complete +HDMA5F_BUSY EQU %10000000 ; 0=DMA complete, 1=Busy (DMA still in progress) (R) + ; -- ; -- RP ($FF56) @@ -599,6 +616,8 @@ rRP EQU $FF56 ; -- rBCPS EQU $FF68 +BCPSF_AUTOINC EQU %10000000 ; Auto Increment (0=Disabled, 1=Increment after Writing) + ; -- ; -- BCPD ($FF69) @@ -608,14 +627,16 @@ rBCPD EQU $FF69 ; -- -; -- BCPS ($FF6A) +; -- OCPS ($FF6A) ; -- Object Color Palette Specification (R/W) ; -- rOCPS EQU $FF6A +OCPSF_AUTOINC EQU %10000000 ; Auto Increment (0=Disabled, 1=Increment after Writing) + ; -- -; -- BCPD ($FF6B) +; -- OCPD ($FF6B) ; -- Object Color Palette Data (R/W) ; -- rOCPD EQU $FF6B From 9cba6d075fddc2439b4fef4bdcdfb9f47a511af9 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Thu, 6 Aug 2020 11:18:59 -0700 Subject: [PATCH 06/10] Reinstate KEY1 and fix the comment to HDMA5 --- hardware.inc | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/hardware.inc b/hardware.inc index 842a5ca..9c03229 100644 --- a/hardware.inc +++ b/hardware.inc @@ -542,10 +542,11 @@ rWX EQU $FF4B ; -- SPEED ($FF4D) ; -- Select CPU Speed (R/W) ; -- -rSPD EQU $FF4D +rKEY1 EQU $FF4D +rSPD EQU rKEY1 -SPDF_DBLSPEED EQU %10000000 ; 0=Normal Speed, 1=Double Speed (R) -SPDF_PREPARE EQU %00000001 ; 0=No, 1=Prepare (R/W) +KEY1F_DBLSPEED EQU %10000000 ; 0=Normal Speed, 1=Double Speed (R) +KEY1F_PREPARE EQU %00000001 ; 0=No, 1=Prepare (R/W) ; -- @@ -591,7 +592,7 @@ rHDMA4 EQU $FF54 ; -- ; -- HDMA5 ($FF55) -; -- Transfer length (in bytes)/mode/start for Horizontal Blanking, General Purpose DMA (R/W) +; -- Transfer length (in tiles minus 1)/mode/start for Horizontal Blanking, General Purpose DMA (R/W) ; -- CGB Mode Only ; -- rHDMA5 EQU $FF55 From a5fc3b979bbfc7db08d320e3970b0d3a78cbe73e Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Fri, 7 Aug 2020 18:17:25 -0700 Subject: [PATCH 07/10] Make the _VRAM equ's consistent with the new base --- hardware.inc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hardware.inc b/hardware.inc index 9c03229..0f11290 100644 --- a/hardware.inc +++ b/hardware.inc @@ -41,8 +41,8 @@ ENDM _VRAM EQU $8000 ; $8000->$9FFF _VRAM8000 EQU _VRAM -_VRAM8800 EQU $8800 -_VRAM9000 EQU $9000 +_VRAM8800 EQU _VRAM+$800 +_VRAM9000 EQU _VRAM+$1000 _SCRN0 EQU $9800 ; $9800->$9BFF _SCRN1 EQU $9C00 ; $9C00->$9FFF _SRAM EQU $A000 ; $A000->$BFFF From 73fbc728f4548e25e969d5ae8d1ec27540aa5aae Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Thu, 27 Aug 2020 16:59:59 -0700 Subject: [PATCH 08/10] Change BOOTUP_B_OTHER to BOOTUP_B_AGB --- hardware.inc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hardware.inc b/hardware.inc index 0f11290..6b4770b 100644 --- a/hardware.inc +++ b/hardware.inc @@ -24,7 +24,7 @@ ;* Rev 2.7 - 19-Jan-19 : Added rPCMXX (ISSOtm) ;* Rev 2.8 - 03-Feb-19 : Added audio registers flags (Álvaro Cuesta) ;* Rev 2.9 - 28-Feb-20 : Added utility rP1 constants -;* Rev 3.0 - 04-Jul-20 : Register ordering, byte-based sizes, OAM additions, general cleanup (Blitter Object) +;* Rev 3.0 - 27-Aug-20 : Register ordering, byte-based sizes, OAM additions, general cleanup (Blitter Object) ; If all of these are already defined, don't do it again. @@ -739,7 +739,7 @@ BOOTUP_A_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) ; if a=BOOTUP_A_CGB, bit 0 in b can be checked to determine if real CGB or ; other system running in GBC mode BOOTUP_B_CGB EQU %00000000 -BOOTUP_B_OTHER EQU %00000001 ; GBA, GBA SP, Game Boy Player, or New GBA SP +BOOTUP_B_AGB EQU %00000001 ; AGB, AGB SP, Game Boy Player, or New AGB SP ;*************************************************************************** From d8386494937f14968fd5e47c7b29ec85cddd7e62 Mon Sep 17 00:00:00 2001 From: ISSOtm Date: Fri, 28 Aug 2020 13:14:11 +0200 Subject: [PATCH 09/10] Fix incorrect documentation of HDMA5 busy bit https://gbdev.io/pandocs/#confirming-if-the-dma-transfer-is-active --- hardware.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hardware.inc b/hardware.inc index 6b4770b..e32db47 100644 --- a/hardware.inc +++ b/hardware.inc @@ -601,7 +601,7 @@ HDMA5F_MODE_GP EQU %00000000 ; General Purpose DMA (W) HDMA5F_MODE_HBL EQU %10000000 ; HBlank DMA (W) ; -- Once DMA has started, use HDMA5F_BUSY to check when the transfer is complete -HDMA5F_BUSY EQU %10000000 ; 0=DMA complete, 1=Busy (DMA still in progress) (R) +HDMA5F_BUSY EQU %10000000 ; 0=Busy (DMA still in progress), 1=Transfer complete (R) ; -- From e86f4e4d88e8ddfa468180e2041477e8b2679d51 Mon Sep 17 00:00:00 2001 From: Bob Koon Date: Fri, 28 Aug 2020 06:11:31 -0700 Subject: [PATCH 10/10] Change AGB to GBA in the comment to BOOTUP_B_AGB --- hardware.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hardware.inc b/hardware.inc index e32db47..efadc7e 100644 --- a/hardware.inc +++ b/hardware.inc @@ -739,7 +739,7 @@ BOOTUP_A_MGB EQU $FF ; Mini GameBoy (Pocket GameBoy) ; if a=BOOTUP_A_CGB, bit 0 in b can be checked to determine if real CGB or ; other system running in GBC mode BOOTUP_B_CGB EQU %00000000 -BOOTUP_B_AGB EQU %00000001 ; AGB, AGB SP, Game Boy Player, or New AGB SP +BOOTUP_B_AGB EQU %00000001 ; GBA, GBA SP, Game Boy Player, or New GBA SP ;***************************************************************************