Merge pull request #43 from zohassadar/mmc5

Add MMC5 support

Author: kirjavascript

CHANGELOG.md

@@ -7,6 +7,10 @@
 * Famicom Keyboard support
 * Fixed Floor-0 disabled burns
 * MMC3 Support
+* MMC5 Support
+* Fixed CNROM legal screen CHR bank
+* Fixed CNROM legal to title flicker
+* Block Tool pieces wrap around
 * Added hidden score option
 
 ## [v5 tournament]

build.sh

@@ -16,8 +16,8 @@ while getopts "vm:askh" flag; do
   case "${flag}" in
     v) set -x ;;
     m)
-        if ! [[ "${OPTARG}" =~ ^[134]$ ]]; then
-            echo "Valid INES_MAPPER (-m) options are 1, 3 or 4"
+        if ! [[ "${OPTARG}" =~ ^[1345]$ ]]; then
+            echo "Valid INES_MAPPER (-m) options are 1, 3, 4 or 5"
             exit 1
         fi
         compile_flags+=("-D INES_MAPPER=${OPTARG}")

src/constants.asm

@@ -2,7 +2,7 @@
 INES_MAPPER := 1 ; supports 1, 3 and 4 (MMC1 / CNROM / MMC3)
 .endif
 
-HAS_MMC = INES_MAPPER = 1 || INES_MAPPER = 4
+HAS_MMC = INES_MAPPER = 1 || INES_MAPPER = 4 || INES_MAPPER = 5
 
 .ifndef SAVE_HIGHSCORES
 SAVE_HIGHSCORES := 1

src/gamemode/gametypemenu/menu.asm

@@ -21,6 +21,10 @@ gameMode_gameTypeMenu:
         ; Horizontal mirroring
         lda #$1
         sta MMC3_MIRRORING
+.elseif INES_MAPPER = 5
+        ; Horizontal mirroring
+        lda #$50
+        sta MMC5_NT_MAPPING
 .endif
         lda #%10011 ; used to be $10 (enable horizontal mirroring)
         jsr setMMC1Control

src/gamemodestate/initbackground.asm

@@ -51,6 +51,10 @@ gameModeState_initGameBackground:
         ; Vertical mirroring (Prevents screen glitching)
         lda #$0
         sta MMC3_MIRRORING
+.elseif INES_MAPPER = 5
+        ; Single screen (Prevents screen glitching)
+        lda #$0
+        sta MMC5_NT_MAPPING
 .endif
         jsr resetScroll
         jsr waitForVBlankAndEnableNmi

src/io.asm

@@ -51,6 +51,15 @@ MMC3_BANK_DATA := $8001
 MMC3_MIRRORING := $A000
 MMC3_PRG_RAM := $A001
 
+; https://www.nesdev.org/wiki/MMC5#Configuration
+MMC5_PRG_MODE := $5100
+MMC5_CHR_MODE := $5101
+MMC5_RAM_PROTECT1 := $5102
+MMC5_RAM_PROTECT2 := $5103
+MMC5_NT_MAPPING := $5105 ; $50 horizontal, $44 vertical, $00 single
+MMC5_CHR_BANK0 := $5123 ; 4kb page index
+MMC5_CHR_BANK1 := $5127
+
 .macro RESET_MMC1
 .if INES_MAPPER = 1
         inc $8000 ; initRam

src/reset.asm

@@ -16,6 +16,8 @@ reset:  cld
         inc reset
 .elseif INES_MAPPER = 4 
         jsr mmc3Init
+.elseif INES_MAPPER = 5
+        jsr mmc5Init
 .endif
         lda #$10
         jsr setMMC1Control
@@ -44,6 +46,17 @@ mmc3Init:
         lda     #$80 ; enable PRG RAM
         sta     MMC3_PRG_RAM
         rts
+.elseif INES_MAPPER = 5
+; https://www.nesdev.org/wiki/MMC5
+mmc5Init:
+        ldx #$00
+        stx MMC5_PRG_MODE ; 0: 1 32Kb bank
+        inx
+        stx MMC5_CHR_MODE ; 1: 4kb CHR pages
+        stx MMC5_RAM_PROTECT2 ; 1: enable PRG RAM
+        inx
+        stx MMC5_RAM_PROTECT1 ; 2: enable PRG RAM
+        rts
 .endif
 
 

src/util/core.asm

@@ -322,6 +322,8 @@ changeCHRBank0:
         adc #$02
         stx MMC3_BANK_SELECT
         sta MMC3_BANK_DATA
+.elseif INES_MAPPER = 5
+        sta MMC5_CHR_BANK0
 .endif
         rts
 
@@ -357,6 +359,8 @@ changeCHRBank1:
         adc #$01
         stx MMC3_BANK_SELECT
         sta MMC3_BANK_DATA
+.elseif INES_MAPPER = 5
+        sta MMC5_CHR_BANK1
 .endif
         rts