Merge pull request #180 from fhoedemakers/dvi2

Mapper 5 support

Author: fhoedemakers

.gitignore

@@ -74,7 +74,7 @@ bld/
 [Oo]bj/
 [Ll]og/
 [Ll]ogs/
-
+*.nes
 # Visual Studio 2015/2017 cache/options directory
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot

CHANGELOG.md

@@ -1,5 +1,7 @@
 # CHANGELOG
 
+New and improved mappers. Castlevania III is now fully playable — US version only on RP2350, Japanese version (Akumajou Densetsu) on both RP2040 and RP2350.
+
 # General Info
 
 [Binaries for each configuration and PCB design are at the end of this page](#downloads___).
@@ -8,6 +10,38 @@
 
 [See setup section in readme how to install and wire up](https://github.com/fhoedemakers/pico-infonesPlus#pico-setup)
 
+# v0.38
+
+## New and improved Mapper support
+
+- **RP2350 only:** Added support for Mapper 5 (MMC5 – *Castlevania III* US). Graphical glitches may still occur. These MMC 5 games are tested:
+  - Castlevania III US
+  - Gemfire (USA version)
+  - Romance of the Three Kingdoms II (Japanese version)
+  - Nobunaga’s Ambition II (Japanese/USA version)
+- **All platforms (RP2040/RP2350):** Added support for Mapper 24 (VRC6A – *Castlevania III/Akumajou Densetsu* JP).
+- Mapper 30 (NesMaker) now working.
+- Fix HUD not displaying in Parodius DA! (Jap) - mapper 23
+- Fix HUD not displaying in Fudou Myouou Den (Japan) - mapper 80
+- ~~Fixed missing hit sound effects in Battletoads and Battletoads & Double Dragon. [#111](https://github.com/fhoedemakers/pico-infonesPlus/issues/111)~~
+- Fix corrupt graphics in Punch Out! and Fire Emblem Gaiden (JP)
+
+Many thanks to [@szuping](https://github.com/szuping) for testing the mapper changes.
+
+Mapper fixes were developed with the help of [Anthropic Claude](https://www.anthropic.com/claude/opus).
+
+## Display & audio
+
+- Added a new **"Display Mode"** option on HSTX boards, allowing selection between HDMI and DVI. When DVI is selected, external audio (when available) is enabled by default. DVI does not have audio over HDMI.
+- Enabling **External audio** no longer forces DVI mode.
+- **Adafruit Fruit Jam:**
+  - Headphone detection now works correctly. Plugging in headphones automatically mutes the internal speaker; unplugging them re-enables it.
+  - Removed the setting and pushbutton1 functionality for muting the internal speaker. Headphone detection now automatically mutes the internal speaker.
+
+## Fixes
+
+- Updated the metadata and cover art pack with missing entries, including artwork for several Japanese titles. See the [Downloads section](#downloads___) below for the download link and instructions. Thanks again to [@DynaMight1124](https://github.com/DynaMight1124)
+
 # v0.37
 
 - Added support for DVI (Video only) mode on HSTX boards (GPIO 12–19) as an alternative to HDMI (Video + Audio). This allows the emulator to work on displays that do not support HDMI but do support DVI. [#171](https://github.com/fhoedemakers/pico-infonesPlus/issues/171). 
@@ -44,16 +78,6 @@ To use HDMI audio, disable External Audio in the Settings menu.
 
 - Various fixes and improvements
 
-# v0.35 release notes
-
-## Fixes
-
-- The -s option (PSRAM cs pin) is removed from pico_shared/bld.sh script as it caused issues with the PSRAM settings in pico_shared/BoardConfigs.cmake. The PSRAM CS pin must be set correctly in pico_shared/BoardConfigs.cmake. (default is 47)
-- Murmulator M1 and M2 fixes [#165](https://github.com/fhoedemakers/pico-infonesPlus/issues/165):
-  - Second NES controller now works.
-  - PS_RAM setting fixed for M2 board.
-  - PS_RAM setting added for M1 board.
-
 
 # previous changes
 

CMakeLists.txt

@@ -46,7 +46,7 @@ IF(NOT CMAKE_BUILD_TYPE)
 ENDIF(NOT CMAKE_BUILD_TYPE)
 message("* Current build type is : ${CMAKE_BUILD_TYPE}")
 if (NOT HW_CONFIG)
-    set(HW_CONFIG 2 CACHE STRING "Select the hardware configuration for your board")      
+    set(HW_CONFIG 7 CACHE STRING "Select the hardware configuration for your board")      
 endif()
 if (NOT USE_HSTX)
     set(USE_HSTX 1 CACHE STRING "Use HSTX for display output when possible")
@@ -57,19 +57,8 @@ if (NOT PICO_BOARD )
     set(PICO_BOARD pico2 CACHE STRING "Board type")
     message("PICO_BOARD not set, using default: ${PICO_BOARD}")
 endif()
-# Although Pico 2 has enough memory, mapper 5 games do not work properly. (sound and screen glitches)
-# if (PICO_BOARD STREQUAL "pico2" OR PICO_BOARD STREQUAL "pico2_w")
-#     set(INFONES_PICO_BOARD "1" CACHE STRING "Select the hardware configuration for your board")
-#     set(INFONES_MAPPER_5_ENABLED "1" CACHE STRING "Enable NES Mapper 5")
-# else()
-#     set(INFONES_PICO_BOARD "0" CACHE STRING "Select the hardware configuration for your board")
-#     set(INFONES_MAPPER_5_ENABLED "0" CACHE STRING "Enable NES Mapper 5")
-# endif()
-set(INFONES_MAPPER_5_ENABLED "0" CACHE STRING "Enable NES Mapper 5")
-message("Mapper 5 enabled      : ${INFONES_MAPPER_5_ENABLED}")
-add_definitions( -DNDEBUG )
-
 
+add_definitions( -DNDEBUG )
 
 include(${PICO_SDK_PATH}/lib/tinyusb/hw/bsp/family_support.cmake)
 project(${projectname} C CXX ASM)
@@ -85,6 +74,13 @@ add_executable(${projectname}
     state.cpp
 )
 
+if (PICO_PLATFORM STREQUAL "rp2350-arm-s" OR PICO_PLATFORM STREQUAL "rp2350-riscv")
+    set(INFONES_MAPPER_5_ENABLED "1" CACHE STRING "Enable NES Mapper 5")
+else()
+    set(INFONES_MAPPER_5_ENABLED "0" CACHE STRING "Enable NES Mapper 5")
+endif()
+message("Mapper 5 enabled      : ${INFONES_MAPPER_5_ENABLED}")
+
 # Optional: embed a NES ROM directly into the firmware.
 # Usage: cmake -DEMBED_NES_ROM=/path/to/rom.nes ..
 if (EMBED_NES_ROM)

HISTORY.md

@@ -1,5 +1,15 @@
 # History of changes
 
+# v0.35 release notes
+
+## Fixes
+
+- The -s option (PSRAM cs pin) is removed from pico_shared/bld.sh script as it caused issues with the PSRAM settings in pico_shared/BoardConfigs.cmake. The PSRAM CS pin must be set correctly in pico_shared/BoardConfigs.cmake. (default is 47)
+- Murmulator M1 and M2 fixes [#165](https://github.com/fhoedemakers/pico-infonesPlus/issues/165):
+  - Second NES controller now works.
+  - PS_RAM setting fixed for M2 board.
+  - PS_RAM setting added for M1 board.
+
 # v0.34 release notes
 
 - Implemented savestates [#140](https://github.com/fhoedemakers/pico-infonesPlus/issues/140)

README.md

@@ -37,14 +37,6 @@ Click on image below to see a demo video.
 ## Possible configurations
 
 You can use it with these RP2040/RP2350 boards and configurations:
-
-- Raspberry Pi Pico, Pico 2, [Pimoroni Pico Plus 2](https://shop.pimoroni.com/products/pimoroni-pico-plus-2?variant=42092668289107). Requires one of these addons:
-  - [Pimoroni Pico DV Demo Base](https://shop.pimoroni.com/products/pimoroni-pico-dv-demo-base?variant=39494203998291) hdmi add-on board. For use with a USB gamecontroller or up to two a legacy NES controllers. (NES controller ports require soldering)
-  - Breadboard and
-    - [Adafruit DVI Breakout For HDMI Source Devices](https://www.adafruit.com/product/4984)
-    - [Adafruit Micro-SD breakout board+](https://www.adafruit.com/product/254).
-      
-    For use with a USB gamecontroller or up to two legacy NES controllers. (No soldering requirerd)
 
   - A custom printed circuit board (PCB) designed by [@johnedgarpark](https://twitter.com/johnedgarpark). (requires soldering) Up to two NES controller ports can be added to this PCB. Can also be used with a USB gamecontroller. You can 3d print your own NES-like case for the PCB. The Pimoroni Pico Plus 2 is not suitable for this PCB because of the SP/CE connector on back of the board
 
@@ -82,6 +74,14 @@ See downloads in the releases page for the correct binary to use with this board
 - [Murmulator M1 and M2 boards](https://murmulator.ru).
 See downloads in the releases page for the correct binary to use with these boards.
 
+- (Discontinued)  [Pimoroni Pico Plus 2](https://shop.pimoroni.com/products/pimoroni-pico-plus-2?variant=42092668289107) and a Raspberry Pi Pico, Pico 2. Requires one of these addons:
+  - [Pimoroni Pico DV Demo Base](https://shop.pimoroni.com/products/pimoroni-pico-dv-demo-base?variant=39494203998291) hdmi add-on board. For use with a USB gamecontroller or up to two a legacy NES controllers. (NES controller ports require soldering)
+  - Breadboard and
+    - [Adafruit DVI Breakout For HDMI Source Devices](https://www.adafruit.com/product/4984)
+    - [Adafruit Micro-SD breakout board+](https://www.adafruit.com/product/254).
+      
+    For use with a USB gamecontroller or up to two legacy NES controllers. (No soldering requirerd)
+
 [See below to see how to setup your specific configuration.](#Setup)
 
 > [!NOTE]
@@ -179,7 +179,7 @@ I also do not take responsability in any way when damage is caused to the Pico o
 
 Click on the link below for your specific board configuration:
 
-- [Raspberry Pi Pico or Pico 2, setup for Pimoroni Pico DV Demo Base](#raspberry-pi-pico-or-pico-2-setup-for-pimoroni-pico-dv-demo-base)
+
 - [Raspberry Pi Pico or Pico 2, setup with Adafruit hardware and breadboard](#raspberry-pi-pico-or-pico-2-setup-with-adafruit-hardware-and-breadboard)
 - [Pimoroni Pico Plus 2](#raspberry-pi-pico-or-pico-2-setup-with-adafruit-hardware-and-breadboard)
 - [Adafruit Feather RP2040 with DVI (HDMI) Output Port setup](#adafruit-feather-rp2040-with-dvi-hdmi-output-port-setup)
@@ -195,11 +195,15 @@ Click on the link below for your specific board configuration:
   * [3D printed case for this PCB](#3d-printed-case)
 - [PCB with WaveShare RP2350 USB A](#pcb-with-waveshare-rp2350-usb-a)
   * [Build Guide](#build-guide)
+- (Discontinued) [Raspberry Pi Pico or Pico 2, setup for Pimoroni Pico DV Demo Base](#raspberry-pi-pico-or-pico-2-setup-for-pimoroni-pico-dv-demo-base)
 
 ***
 
 ##  Raspberry Pi Pico or Pico 2, setup for Pimoroni Pico DV Demo Base.
 
+> [!NOTE]
+> This board is discontinued and no longer sold by Pimoroni
+
 ### materials needed
 - Raspberry Pi Pico or Pico 2 with soldered male headers.
 - [Pimoroni Pico DV Demo Base](https://shop.pimoroni.com/products/pimoroni-pico-dv-demo-base?variant=39494203998291).
@@ -784,7 +788,7 @@ When ordering, simply upload the zip file containing the gerber design.  This fi
 > If you are looking for the previous design (v0.2). You can find it [here](PCB/v0.2)
 
 > [!NOTE]
-> It seems that sellers on AliExpress have copied the PCB design and are selling pre-populated PCB's. I do not condone this in any way. For questions about those boards, please contact the seller on AliExpress.
+> It seems that sellers on AliExpress have copied the PCB design and are selling pre-populated PCB's. For questions about those boards, please contact the seller on AliExpress.
 
 Other materials needed:
 
@@ -944,7 +948,6 @@ Gamepad buttons:
 - **Pimoroni Pico DV Demo Base only**: SELECT + LEFT: Switch audio output to the connected speakers on the line-out jack of the Pimoroni Pico DV Demo Base. The speaker setting will be remembered when the emulator is restarted.
 - **Fruit Jam Only** 
   - SELECT + UP: Toggle scanlines.   
-  - pushbutton 1 (on board): Mute audio of built-in speaker. Audio is still outputted to the audio jack.
   - pushbutton 2 (on board) or SELECT + RIGHT: Toggles the VU meter on or off. (NeoPixel LEDs light up in sync with the music rhythm)
   - START + LEFT/RIGHT: Adjust volume of built-in speaker and external audio jack.
 - **RP2350 with PSRAM only**: Record about 30 seconds of audio by pressing START to pause the game and then START + BUTTON1. Audio is recorded to **/soundrecorder.wav** on the SD-card.
@@ -1061,7 +1064,7 @@ Some displays need 5V connected to the HDMI breakout in order to work:
 
 # Known Issues and limitations
 
-- Due to the Pico's memory limitations, not all games will work. Games not working will show a "Mapper n is unsupported." (n is a number). For example starting Castlevania III will show the "Mapper 5 is unsupported." message.
+- Not all games will run, as some mappers are either not fully implemented or exceed memory limitations. If a game uses an unsupported mapper, the system will display a message such as: "Mapper n is unsupported." (where n is the mapper number). For example, attempting to start Castlevania III (US) on the RP2040 will result in the message: "Mapper 5 is unsupported." On the RP2350, however, this game runs without issues.
 - tar file support is removed.
 
 ***
@@ -1184,6 +1187,8 @@ PSRAM: https://github.com/AndrewCapon/PicoPlusPsram
 
 lwmem: https://github.com/MaJerle/lwmem
 
+[Anthropic Claude Opus 4.6](https://www.anthropic.com/claude/opus): Assisted with NES mapper 5 (MMC5), mapper 24 (VRC6a), mapper 30, fixes in other mappers, and with general code optimizations and bug fixes.
+
 ***
 
 # Other versions

infones/InfoNES.cpp

@@ -365,6 +365,13 @@ void InfoNES_Fin()
   Frens::f_free(PPURAM);
   Frens::f_free(SPRRAM);
   Frens::f_free(ChrBuf);
+#if NES_MAPPER_5_ENABLED == 1
+  if (Map5_Wram) { Frens::f_free(Map5_Wram); Map5_Wram = nullptr; }
+  if (Map5_Ex_Ram) { Frens::f_free(Map5_Ex_Ram); Map5_Ex_Ram = nullptr; }
+  if (Map5_Ex_Vram) { Frens::f_free(Map5_Ex_Vram); Map5_Ex_Vram = nullptr; }
+  if (Map5_Ex_Nam) { Frens::f_free(Map5_Ex_Nam); Map5_Ex_Nam = nullptr; }
+  Map5_Gfx_Mode = 0;
+#endif
 }
 
 /*===================================================================*/
@@ -431,17 +438,20 @@ int InfoNES_Reset()
   /*-------------------------------------------------------------------*/
 
   // Get Mapper Number
-  MapperNo = NesHeader.byInfo1 >> 4;
+  // MapperNo = (NesHeader.byInfo1 >> 4) ;
 
-  // Check bit counts of Mapper No.
-  for (nIdx = 4; nIdx < 8 && NesHeader.byReserve[nIdx] == 0; ++nIdx)
-    ;
+  // // Check bit counts of Mapper No.
+  // for (nIdx = 4; nIdx < 8 && NesHeader.byReserve[nIdx] == 0; ++nIdx)
+  //   ;
 
-  if (nIdx == 8)
-  {
-    // Mapper Number is 8bits
-    MapperNo |= (NesHeader.byInfo2 & 0xf0);
-  }
+  // if (nIdx == 8)
+  // {
+  //   // Mapper Number is 8bits
+  //   MapperNo |= (NesHeader.byInfo2 & 0xf0);
+  // }
+
+  // Mapper Number is 8bits. Always use lower 4bits of byInfo2 for compatibility with old ROMs.
+  MapperNo = (NesHeader.byInfo1 >> 4) | (NesHeader.byInfo2 & 0xf0);
 
   // Get information on the ROM
   ROM_Mirroring = NesHeader.byInfo1 & 1;
@@ -1017,11 +1027,24 @@ void __not_in_flash_func(InfoNES_DrawLine)()
     {
       pPoint += 8 - PPU_Scr_H_Bit;
 
-      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
       const int ch = *pbyNameTable;
-      const int bank = (ch >> 6) + bankOfsBG;
-      const int addrOfs = ((ch & 63) << 4) + yOfsModBG;
-      const auto data = PPUBANK[bank] + addrOfs;
+#if NES_MAPPER_5_ENABLED == 1
+      const WORD *pal;
+      const BYTE *data;
+      if (Map5_Gfx_Mode == 1) {
+        const BYTE exram = Map5_Ex_Vram[nY * 32 + nX];
+        pal = &PalTable[((exram >> 6) & 3) << 2];
+        const int chrBank4K = ((int)Map5_Chr_Upper << 6) | (exram & 0x3F);
+        const int vromPage = (chrBank4K * 4 + (ch >> 6)) % (NesHeader.byVRomSize << 3);
+        data = VROMPAGE(vromPage) + ((ch & 63) << 4) + yOfsModBG;
+      } else {
+        pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
+        data = PPUBANK[(ch >> 6) + bankOfsBG] + ((ch & 63) << 4) + yOfsModBG;
+      }
+#else
+      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
+      const auto data = PPUBANK[(ch >> 6) + bankOfsBG] + ((ch & 63) << 4) + yOfsModBG;
+#endif
       const auto pl0 = data[0];
       const auto pl1 = data[8];
       const auto pat0 = (pl0 & 0x55) | ((pl1 << 1) & 0xaa);
@@ -1062,12 +1085,27 @@ void __not_in_flash_func(InfoNES_DrawLine)()
 
     auto putBG = [&](int nX) __attribute__((always_inline))
     {
-      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
-      const auto palAddr = reinterpret_cast<uintptr_t>(pal);
       const int ch = *pbyNameTable;
+#if NES_MAPPER_5_ENABLED == 1
+      const WORD *pal;
+      const BYTE *data;
+      if (Map5_Gfx_Mode == 1) {
+        const BYTE exram = Map5_Ex_Vram[nY * 32 + nX];
+        pal = &PalTable[((exram >> 6) & 3) << 2];
+        const int chrBank4K = ((int)Map5_Chr_Upper << 6) | (exram & 0x3F);
+        const int vromPage = (chrBank4K * 4 + (ch >> 6)) % (NesHeader.byVRomSize << 3);
+        data = VROMPAGE(vromPage) + ((ch & 63) << 4) + yOfsModBG;
+      } else {
+        pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
+        data = PPUBANK[(ch >> 6) + bankOfsBG] + ((ch & 63) << 4) + yOfsModBG;
+      }
+#else
+      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
       const int bank = (ch >> 6) + bankOfsBG;
       const int addrOfs = ((ch & 63) << 4) + yOfsModBG;
       const auto data = PPUBANK[bank] + addrOfs;
+#endif
+      const auto palAddr = reinterpret_cast<uintptr_t>(pal);
       const auto pl0 = data[0];
       const auto pl1 = data[8];
       // const auto pat0 = (pl0 & 0x55) | ((pl1 << 1) & 0xaa);
@@ -1110,6 +1148,7 @@ void __not_in_flash_func(InfoNES_DrawLine)()
 #endif
 
       // Callback at PPU read/write
+      pbyChrData = PPU_BG_Base + (*pbyNameTable << 6) + nYBit;
       MapperPPU(PATTBL(pbyChrData));
 
       ++pbyNameTable;
@@ -1145,6 +1184,7 @@ void __not_in_flash_func(InfoNES_DrawLine)()
 #endif
 
       // Callback at PPU read/write
+      pbyChrData = PPU_BG_Base + (*pbyNameTable << 6) + nYBit;
       MapperPPU(PATTBL(pbyChrData));
 
       ++pbyNameTable;
@@ -1163,11 +1203,24 @@ void __not_in_flash_func(InfoNES_DrawLine)()
     }
 #else
     {
-      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
       const int ch = *pbyNameTable;
-      const int bank = (ch >> 6) + bankOfsBG;
-      const int addrOfs = ((ch & 63) << 4) + yOfsModBG;
-      const auto data = PPUBANK[bank] + addrOfs;
+#if NES_MAPPER_5_ENABLED == 1
+      const WORD *pal;
+      const BYTE *data;
+      if (Map5_Gfx_Mode == 1) {
+        const BYTE exram = Map5_Ex_Vram[nY * 32 + nX];
+        pal = &PalTable[((exram >> 6) & 3) << 2];
+        const int chrBank4K = ((int)Map5_Chr_Upper << 6) | (exram & 0x3F);
+        const int vromPage = (chrBank4K * 4 + (ch >> 6)) % (NesHeader.byVRomSize << 3);
+        data = VROMPAGE(vromPage) + ((ch & 63) << 4) + yOfsModBG;
+      } else {
+        pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
+        data = PPUBANK[(ch >> 6) + bankOfsBG] + ((ch & 63) << 4) + yOfsModBG;
+      }
+#else
+      const auto pal = &PalTable[(((pAttrBase[nX >> 2] >> ((nX & 2) + nY4)) & 3) << 2)];
+      const auto data = PPUBANK[(ch >> 6) + bankOfsBG] + ((ch & 63) << 4) + yOfsModBG;
+#endif
       const auto pl0 = data[0];
       const auto pl1 = data[8];
       const auto pat0 = (pl0 & 0x55) | ((pl1 << 1) & 0xaa);
@@ -1200,6 +1253,7 @@ void __not_in_flash_func(InfoNES_DrawLine)()
 #endif
 
     // Callback at PPU read/write
+    pbyChrData = PPU_BG_Base + (*pbyNameTable << 6) + nYBit;
     MapperPPU(PATTBL(pbyChrData));
 
     /*-------------------------------------------------------------------*/