MMC5: Difference between revisions

From NESdev Wiki
Jump to navigationJump to search
(Updated, confirmed in thread that split screen mode is used in the ending of Bandit Kings of Ancient China.)
(→‎Scanline IRQ Status ($5204, read/write): Clarified that the scanline does not reset from a scanline interrupt.)
 
(79 intermediate revisions by 8 users not shown)
Line 7: Line 7:
|complexity=ASIC
|complexity=ASIC
|boards=EKROM, ELROM,<br/>ETROM, EWROM
|boards=EKROM, ELROM,<br/>ETROM, EWROM
|pinout=MMC5 pinout
|prgmax=1024K
|prgmax=1024K
|prgpage=8K, 16K, or 32K
|prgpage=8K, 16K, or 32K
Line 41: Line 42:


The first game to use this chip (''Nobunaga's Ambition II'') was released in February 1990. The [http://bootgod.dyndns.org:7777/profile.php?id=3169 date codes on components on early released cartridges] show that manufacturing had started at the end of 1989.
The first game to use this chip (''Nobunaga's Ambition II'') was released in February 1990. The [http://bootgod.dyndns.org:7777/profile.php?id=3169 date codes on components on early released cartridges] show that manufacturing had started at the end of 1989.
A later '''[[#MMC5A|MMC5A]]''' revision was introduced with a few extra features, but all released games do not rely on these features and are compatible with the original MMC5.


== Overview ==
== Overview ==
Line 51: Line 54:
** Supports either one chip (up to 128KB) or two chips (up to 32KB each)
** Supports either one chip (up to 128KB) or two chips (up to 32KB each)
* An 8 bit by 8 bit multiplier with a 16 bit result for performing quick calculations
* An 8 bit by 8 bit multiplier with a 16 bit result for performing quick calculations
* A scanline based IRQ counter
* Scanline detection with counter and configurable IRQ
* Frame detection with status bit
* The ability to use different CHR banks for background and 8x16 sprites (allowing 256 unique 8x16 sprite tiles, independent of the background).
* The ability to use different CHR banks for background and 8x16 sprites (allowing 256 unique 8x16 sprite tiles, independent of the background).
* 1024 bytes of on-chip memory, which can be used for 4 different purposes:
* 1024 bytes of on-chip memory, which can be used for 4 different purposes:
Line 119: Line 123:
== Registers ==
== Registers ==


=== Sound ===
=== Sound ($5000-$5015) ===


For details on sound operation, see [[MMC5 audio]]
For details on sound operation, see [[MMC5 audio]]
Line 125: Line 129:
=== NES internal state monitoring ===
=== NES internal state monitoring ===
All of these registers overlay various registers that are already used inside the NES, and are fully decoded. A game could write to a mirror of a PPU register to get the MMC5 out of sync, but it's not clear how that could be useful.
All of these registers overlay various registers that are already used inside the NES, and are fully decoded. A game could write to a mirror of a PPU register to get the MMC5 out of sync, but it's not clear how that could be useful.
==== 8x16 mode enable 1 ($2000 = [[PPUCTRL]]) ====
==== 8x16 mode enable ($2000 = [[PPUCTRL]]) ====
  7  bit  0
  7  bit  0
  ---- ----
  ---- ----
Line 132: Line 136:
   +------- Sprite size (0: 8x8 pixels; 1: 8x16 pixels)
   +------- Sprite size (0: 8x8 pixels; 1: 8x16 pixels)


==== 8x16 mode enable 2 ($2001 = [[PPUMASK]]) ====
Only when Z is set and at least one E bit is set does the MMC5 [[#CHR_Bankswitching_.28.245120-.245130.29|draw 8x16 sprites from eight independent banks]].<ref>[https://forums.nesdev.org/viewtopic.php?p=229375#p229375 krzysiobal's RE notes]</ref>
 
==== PPU Data Substitution Enable ($2001 = [[PPUMASK]]) ====
  7  bit  0
  7  bit  0
  ---------
  ---------
  xxxE Exxx
  xxxE Exxx
     | |
     | |
     +-+--- 1,2,3: Rendering enabled; 0: rendering disabled
     +-+--- 1,2,3: Substitutions enabled; 0: substitutions disabled
 
The MMC5 listens to writes to PPUMASK ($2001). When it sees that both E bits are cleared, it disables its ability to make substitutions on the PPU data bus.  This includes disabling:
* Independent bank 8x16 sprite mode
* Extended attribute mode
* Vertical split mode
 
The MMC5 only listens to the fully decoded address $2001, so this can be tested by using the PPU’s mirrors of this register.  For example, writing to register $2009 will be heard by the PPU but not the MMC5.  It is not clear if that could have a practical use beyond test purposes.
 
When the MMC5 sees $00 written to $2001, and then the PPU’s rendering gets enabled via a mirror of $2001, the MMC5 still counts scanlines and can generate scanline interrupts even though it thinks $2001 is still disabled.  The transition from disabled to enabled resets the scanline counter.


Only when Z is set and at least one E bit is set does the MMC5 [[#CHR_Bankswitching_.28.245120-.245130.29|draw 8x16 sprites from eight independent banks]].<ref>[https://forums.nesdev.org/viewtopic.php?p=229375#p229375 krzysiobal's RE notes]</ref>
Driving pin 92 low similarly disables substitutions.  Because no scanline interrupts occur with pin 92 held low, it seems to hold the scanline counter in reset.


==== Unknown ($2002 = [[PPUSTATUS]], read only) ====
==== Unknown ($2002 = [[PPUSTATUS]], read only) ====
Line 199: Line 214:
In order to enable writing to PRG RAM, this must be set to binary '01' (e.g. $01).
In order to enable writing to PRG RAM, this must be set to binary '01' (e.g. $01).


==== Extended RAM mode ($5104) ====
==== Internal extended RAM mode ($5104) ====
  7  bit  0
  7  bit  0
  ---- ----
  ---- ----
Line 205: Line 220:
         ||
         ||
         ++- Specify extended RAM usage
         ++- Specify extended RAM usage
* 0 - Use as extra nametable (possibly for split mode)
{| class=wikitable
* 1 - Use as extended attribute data (can also be used as extended nametable)
! $5104 !! CPU Access ($5C00-$5FFF) <br/> during blanking !! CPU Access ($5C00-$5FFF) <br/> during rendering !! PPUDATA Access ($2000-$2FFF){{sup|(1)}} <br/> during blanking !! Available as <br/> Nametable !! Enable Extended <br/> Attribute Mode
* 2 - Use as ordinary RAM
|-
* 3 - Use as ordinary RAM, write protected
! %00
| {{no}}{{sup|(3)}} || <center>{{yes|Write Only}}{{sup|(4)}}</center> || {{yes|Read/Write}} || {{yes}} || {{no}}
|-
! %01
| {{no}}{{sup|(3)}} || <center>{{yes|Write Only}}{{sup|(4)}}</center> || {{yes|Read/Write}} || {{yes}}{{sup|2}} || {{yes}}
|-
! %10
| {{yes|Read/Write}} || {{yes|Read/Write}} || {{no}} || {{no}} || {{no}}
|-
! %11
| <center>Read Only</center> || <center>Read Only</center> || {{no}} || {{no}} || {{no}}
|-
|}
 
{{sup|(1)}}When configured as a nametable in register $5105, read and write access is possible through the PPU via registers $2006/$2007 when the PPU is not rendering.  Based on register $5105, any nametables mapped to extended RAM will support the corresponding PPU address ranges for reads and writes.  For example, if NT4 is mapped to extended RAM, reads/writes to PPU $2C00 will correspond with extended RAM $5C00.
 
{{sup|(2)}}Though it is possible to still assign the extended RAM as a nametable in the mode %01, you are going to have the same data used twice, once as extended attribute data, and once as nametable data, this does not seem to be a useful combination. In the other modes, the nametable will read as if it contains all $00s.
 
{{sup|(3)}}Counterintuitively, writes in these modes are only allowed when the PPU is rendering. If writes are attempted during V-blank, they may be ignored or cause a corruption at that memory address. In practice, temporarily switch to mode %10 if you wish to write during V-blank.
 
{{sup|(4)}}Attempting to read extended RAM in those modes returns open bus.
 
===== Extended attributes =====
 
In mode %01, "Extended Attribute Mode", each byte of the MMC5's internal extended RAM is used to enhance the background tile at the corresponding nametable address. The extended attributes are 1-screen mirrored; in other words, they apply the same for all nametables.
 
Format of each extended attribute byte:
 
7  bit  0
---- ----
AACC CCCC
|||| ||||
||++-++++- Select 4 KB CHR bank to use with specified tile
++-------- Select palette to use with specified tile
 
In extended attribute mode, CHR banking behaves differently than normal when fetching background tiles from pattern tables:
* CHR mode (register $5101) is ignored.  CHR banks are always 4KB in this mode.
* The values of the CHR banking registers $5120-$512B are also ignored.
* Bits 0-5 specified here are used for selecting a 4KB CHR bank on a per-tile basis.
* The two bits in $5130 are used globally as CHR bank bits 6 and 7.
* Driving pin 92 low disables extended attribute mode. Extended attribute mode is also automatically disabled based on PPUMASK monitoring. (See section on $2001 monitoring.) In these cases, the non-extended attribute table is used instead.
 
In other words, this works as if the nametable was extended from 8-bit to 14-bit tile offsets, with the ExRAM holding the upper 6-bits and the 2-bit palette value, while the nametable selected through $5105 contains the lower 8 bits.
 
''Just Breed'', ''Yakuman Tengoku'', and the Koei games use extended attributes continuously.


==== Nametable mapping ($5105) ====
==== Nametable mapping ($5105) ====
Line 220: Line 279:
  ++-------- Select nametable at PPU $2C00-$2FFF
  ++-------- Select nametable at PPU $2C00-$2FFF
Nametable values:
Nametable values:
* 0 - On-board VRAM page 0
* 0 - CIRAM page 0
* 1 - On-board VRAM page 1
* 1 - CIRAM page 1
* 2 - Internal Expansion RAM, only if the Extended RAM mode allows it ($5104 is 00/01); otherwise, the nametable will read as all zeros,
* 2 - Internal extended RAM
**When $5104 is set to mode %10 or %11, the nametable will read as all zeros.  This does not share functionality with fill mode.
* 3 - Fill-mode data
* 3 - Fill-mode data
**See registers $5106 and $5017


[[Mirroring]] examples:
[[Mirroring]] examples:
Line 247: Line 308:


==== Fill-mode tile ($5106) ====
==== Fill-mode tile ($5106) ====
  All eight bits specify the tile number to use for fill-mode nametable
When a nametable is mapped to fill-mode in register $5105, all nametable fetches get replaced by the value of this register. Only the nametable is affected by fill mode.  When the PPU later uses this information to fetch the corresponding tile from the pattern table, CHR banking is unaffected and continues to work normally.
 
§
==== Fill-mode color ($5107) ====
==== Fill-mode color ($5107) ====
  7  bit  0
  7  bit  0
Line 254: Line 315:
  xxxx xxAA
  xxxx xxAA
         ||
         ||
         ++- Specify attribute bits to use for fill-mode nametable
         ++- Specify background palette index to use for fill-mode nametable
When a nametable is mapped to fill-mode in register $5105, and $5104 is not in mode %01, all attribute table fetches get replaced by the value of this register.  Each byte of the attribute table normally contains four 2-bit palette indexes.  The two bits in this register are copied for all four indexes.
 
When $5104 is in mode %01, extended attribute mode does apply for fill mode, and this register is ignored. However, if pin 92 is driven low in this mode, extended attribute mode becomes disabled and this register comes back into effect.


=== PRG Bankswitching ($5113-$5117)===
=== PRG Bankswitching ($5113-$5117)===
Line 272: Line 336:
  +--------- RAM/ROM toggle (0: RAM; 1: ROM) (registers $5114-$5116 only)
  +--------- RAM/ROM toggle (0: RAM; 1: ROM) (registers $5114-$5116 only)


Conceptual bank register effective areas versus PRG mode:
Bank register effective areas versus PRG mode:
{| class="wikitable"
{| class="wikitable"
! !! colspan=4|CPU memory affected for each mode (see [[#PRG mode ($5100)]])
! !! colspan=4|CPU memory affected for each mode (see [[#PRG mode ($5100)]])
|-
|-
!Register
!CPU Address
!scope="col" style="width: 125px;"|Mode 3 Range
!scope="col" style="width: 125px;"|Mode 3 Registers
!scope="col" style="width: 125px;"|Mode 2 Range
!scope="col" style="width: 125px;"|Mode 2 Registers
!scope="col" style="width: 125px;"|Mode 1 Range
!scope="col" style="width: 125px;"|Mode 1 Registers
!scope="col" style="width: 125px;"|Mode 0 Range
!scope="col" style="width: 125px;"|Mode 0 Registers
|-
|-
||'''$5113'''|||$6000-$7FFF (RAM)||$6000-$7FFF (RAM)||$6000-$7FFF (RAM)||$6000-$7FFF (RAM)
||'''$6000-7FFF'''|| $5113 (RAM only) || $5113 (RAM only)     || $5113 (RAM only)     || $5113 (RAM only)
|-
|-
||'''$5114'''|||$8000-$9FFF||style="background: #cccccc;"|v (none) v||style="background: #cccccc;"|v (none) v||style="background: #cccccc;"|v (none) v
||'''$8000-9FFF'''|| $5114            || rowspan=2|$5115      || rowspan=2|$5115      || rowspan=4|$5117 (ROM only)  
|-
|-
||'''$5115'''|||$A000-$BFFF||$8000-$BFFF||$8000-$BFFF||style="background: #cccccc;"|v (none) v
||'''$A000-BFFF'''|| $5115
|-
|-
||'''$5116'''|||$C000-$DFFF||$C000$-DFFF||style="background: #cccccc;"|v (none) v||style="background: #cccccc;"|v (none) v
||'''$C000-DFFF'''|| $5116            || $5116                || rowspan=2|$5117 (ROM only)  
|-
|-
||'''$5117'''|||$E000-$FFFF (ROM)||$E000-$FFFF (ROM)||$C000-$FFFF (ROM)||$8000-$FFFF (ROM)
||'''$E000-FFFF'''|| $5117 (ROM only) || $5117 (ROM only)  
|-
|-
|}
|}


RAM is always mapped at $6000-$7FFF, and the bit $5113.7 is ignored.
Register bits $5113.7 and $5117.7 are always ignored. $5113 always maps RAM, and $5117 always maps ROM.  Because of this, it is not possible to map the interrupt vectors to RAM in any mode. All known games have their reset vector in the last bank of PRG ROM, and the vector points to an address greater than or equal to $E000. This tells us that $5117 must have a reliable power-on value of $FF.
ROM is always mapped at the bank controlled by register $5117, and the bit $5117.7 is ignored. This makes it impossible to map RAM at interrupt vectors in any mode.
 
When a bankswitch register controls an 8kByte CPU address range, register bits 6..0 correspond to PRG A19..A13.
 
In PRG modes where a register controls a 16kByte CPU address range, register bits 6..1 correspond to PRG A19..A14. Register bit 0 is ignored and instead CPU A13 directly controls PRG A13.  For example, comparing mode 3 to mode 2 for CPU address range $8000-BFFF.  These are equivalent:
*In mode 3, write value $90 to $5114 and value $91 to $5115.
*In mode 2, write value $90 to $5115.
 
However, these are not equivalent:
*In mode 3, write value $91 to $5114 and value $92 to $5115.
*In mode 2, write value $91 to $5115.
 
The MMC5 ignores register bit 0 in the 16kByte bank.


Modes 0-2 : The bankswitching registers always hold a value of 8kb bank index numbers. When selecting banks of a "larger" size (16 kb or 32kb), the low bits in the bankswitching register are ignored. In other words, the address lines from the CPU are passed through the mapper directly to the PRG-ROM chip.
Similarly, when register $5117 controls a 32kByte CPU address range in mode 0, register bits 6..2 correspond to PRG A19..A15, register bits 1..0 are ignored, and CPU A14..A13 directly control PRG A14..A13


Games seem to expect $5117 to be $FF at power on. All games have their reset vector in the last bank of PRG ROM, and the vector points to an address greater than or equal to $E000.
====Separate PRG-ROM and PRG-RAM Address Busses====


==== PRG-RAM bankswitching quirks ====
The MMC5 has separate sets of address pins for PRG-ROM and PRG-RAM.  This is a concept that has proven difficult to understand and explain.  It all stems from the fact that CPU A15 is not directly routed to the cartridge; the signal /ROMSEL is supplied instead.  Though it is possible to figure out CPU A15 from /ROMSEL, it is not possible to use it to select the correct PRG address.  The PRG address needs to be set sooner than this in order to have an adequate setup time for the RAM or ROM chips. So basically, the starting point is that the MMC5 has to ''ignore'' /ROMSEL (and therefore CPU A15) when it comes to the PRG address, for the purpose of timings.  This effectively creates a mirror on the PRG address bus for CPU address range $0000-7FFF and $8000-FFFF.  Specifically, this makes range $6000-7FFF indistinguishable from $E000-FFFF.  Because the MMC5 wanted to have separately controllable mapping for those ranges, its solution was to make two separate PRG address busses.


Until November 2018, it was thought that the MMC5 supported up to 2 PRG RAM chips, each up to 32KB in length. However, recent research found that bits 2-3 control state of two unknown pins which acts like A15-A16, allowing up to 128KB RAM support. Either or both chips may be battery-backed; [http://bootgod.dyndns.org:7777/search.php?ines=5&battery=Yes&group=groupid 11 of the 15 MMC5 games] include a battery. The following configurations of PRG-RAM are known to exist in ExROM games:
The MMC5's PRG-ROM address pins follow this logic. Though the PRG-ROM address bus is decoded at ''all'' CPU addresses, the gray areas always have PRG ROM /CE disabled:
* 0KB: No PRG-RAM
* 8KB: 1x 8KB chip
* 16KB: 2x 8KB chips
* 32KB: 1x 32KB chip


In [[iNES|the original .NES format]], byte 8 of the file's header should indicate how many pages are present, but ROM images in the wild that use this mapper may not have byte 8 set correctly, nor do emulators necessarily honor this number.
{| class="wikitable"
Byte 10 of the [[NES 2.0]] header should be reliable.
!CPU Address
!scope="col" style="width: 125px;"|Mode 3 PRG-ROM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 2 PRG-ROM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 1 PRG-ROM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 0 PRG-ROM<br/>Address Source
|-
||'''$0000-1FFF'''|| style="background: #cccccc;"|$5114 || style="background: #cccccc;" rowspan=2|$5115 || style="background: #cccccc;" rowspan=2|$5115 || style="background: #cccccc;" rowspan=4|$5117
|-
||'''$2000-3FFF'''|| style="background: #cccccc;"|$5115
|-
||'''$4000-5FFF'''|| style="background: #cccccc;"|$5116 || style="background: #cccccc;"|$5116          || style="background: #cccccc;" rowspan=2|$5117
|-
||'''$6000-7FFF'''|| style="background: #cccccc;"|$5117 || style="background: #cccccc;"|$5117
|-
||'''$8000-9FFF'''|| style="background: #80C0FF;"|$5114 || style="background: #80C0FF;"rowspan=2|$5115  || style="background: #80C0FF;"rowspan=2|$5115 || style="background: #80C0FF;"rowspan=4|$5117
|-
||'''$A000-BFFF'''|| style="background: #80C0FF;"|$5115
|-
||'''$C000-DFFF'''|| style="background: #80C0FF;"|$5116 || style="background: #80C0FF;"|$5116          || style="background: #80C0FF;"rowspan=2|$5117
|-
||'''$E000-FFFF'''|| style="background: #80C0FF;"|$5117 || style="background: #80C0FF;"|$5117
|-
|}


==== Emulation quirks with commercial games ====
The MMC5's PRG-RAM address pins follow this logic, again with PRG-RAM /CE always disabled in the gray areas:
{| class="wikitable"
!CPU Address
!scope="col" style="width: 125px;"|Mode 3 PRG-RAM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 2 PRG-RAM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 1 PRG-RAM<br/>Address Source
!scope="col" style="width: 125px;"|Mode 0 PRG-RAM<br/>Address Source
|-
||'''$0000-1FFF'''|| style="background: #cccccc;"|$5114 || style="background: #cccccc;" rowspan=2|$5115 || style="background: #cccccc;" rowspan=2|$5115 || style="background: #cccccc;" rowspan=3|$5113
|-
||'''$2000-3FFF'''|| style="background: #cccccc;"|$5115
|-
||'''$4000-5FFF'''|| style="background: #cccccc;"|$5116 || style="background: #cccccc;"|$5116          || style="background: #cccccc;"|$5113
|-
||'''$6000-7FFF'''|| style="background: #FFC0C0;"|$5113 || style="background: #FFC0C0;"|$5113          || style="background: #FFC0C0;"|$5113          || style="background: #FFC0C0;"|$5113
|-
||'''$8000-9FFF'''|| style="background: #FFC0C0;"|$5114 || style="background: #FFC0C0;"rowspan=2|$5115  || style="background: #FFC0C0;"rowspan=2|$5115  || style="background: #cccccc;" rowspan=4|$5113
|-
||'''$A000-BFFF'''|| style="background: #FFC0C0;"|$5115
|-
||'''$C000-DFFF'''|| style="background: #FFC0C0;"|$5116 || style="background: #FFC0C0;"|$5116          || style="background: #cccccc;" rowspan=2|$5113
|-
||'''$E000-FFFF'''|| style="background: #cccccc;"|$5113 || style="background: #cccccc;"|$5113
|-
|}
 
If we overlap these two tables, the original table reemerges.  Pink always has /CE enabled for RAM (using $5113), Blue always has /CE enabled for ROM (using $5117), and Purple chooses which /CE using the register bit 7.  Gray always has RAM /CE and ROM /CE disabled at all times.
{| class="wikitable"
!CPU Address
!scope="col" style="width: 125px;"|Mode 3 PRG<br/>Address Source
!scope="col" style="width: 125px;"|Mode 2 PRG<br/>Address Source
!scope="col" style="width: 125px;"|Mode 1 PRG<br/>Address Source
!scope="col" style="width: 125px;"|Mode 0 PRG<br/>Address Source
|-
||'''$0000-1FFF'''|| style="background: #cccccc;"|$5114 || style="background: #cccccc;" rowspan=2|$5115  || style="background: #cccccc;" rowspan=2|$5115 || style="background: #cccccc;" rowspan=3|$5113/$5117
|-
||'''$2000-3FFF'''|| style="background: #cccccc;"|$5115
|-
||'''$4000-5FFF'''|| style="background: #cccccc;"|$5116 || style="background: #cccccc;"|$5116            || style="background: #cccccc;"|$5113/$5117
|-
||'''$6000-7FFF'''|| style="background: #FFC0C0;"|$5113/$5117 || style="background: #FFC0C0;"|$5113/$5117 || style="background: #FFC0C0;"|$5113/$5117    || style="background: #FFC0C0;"|$5113/$5117
|-
||'''$8000-9FFF'''|| style="background: #D0C0E0;"|$5114 || style="background: #D0C0E0;"rowspan=2|$5115    || style="background: #D0C0E0;"rowspan=2|$5115  || style="background: #80C0FF;" rowspan=4|$5113/$5117
|-
||'''$A000-BFFF'''|| style="background: #D0C0E0;"|$5115
|-
||'''$C000-DFFF'''|| style="background: #D0C0E0;"|$5116 || style="background: #D0C0E0;"|$5116            || style="background: #80C0FF;" rowspan=2|$5113/$5117
|-
||'''$E000-FFFF'''|| style="background: #80C0FF;"|$5113/$5117 || style="background: #80C0FF;"|$5113/$5117
|-
|}
 
 
==== PRG-RAM configurations ====
 
In [[ExROM|commercial configurations]], bits 0 and 1 select pages ''within'' an SRAM chip, and bit 2 selects between two separate SRAMs. 8K and 32K games have a single SRAM chip that will only be active when bit 2 is clear. 16K games instead have two chips, but only the first is battery backed.
{| class="wikitable"
! rowspan=2 | Configuration
! colspan=8 | bank value & 7
|-
! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! 6 !! 7
|-
! ELROM 0K
| [[open bus]] || open bus || open bus || open bus || open bus || open bus || open bus || open bus
|-
! EKROM 8K (1 x 8K)
| 0:$0000 || 0:$0000 || 0:$0000 || 0:$0000 || open bus || open bus || open bus || open bus
|-
! ETROM 16K (2 x 8K)
| '''0''':$0000 || '''0''':$0000 || '''0''':$0000 || '''0''':$0000 || '''1''':$0000 || '''1''':$0000 || '''1''':$0000 || '''1''':$0000
|-
! EWROM 32K (1 x 32K)
| 0:$'''0000''' || 0:$'''2000''' || 0:$'''4000''' || 0:$'''6000''' || open bus || open bus || open bus || open bus
|-
! Superset 64K (2 x 32K)
| '''0''':$'''0000''' || '''0''':$'''2000''' || '''0''':$'''4000''' || '''0''':$'''6000''' || '''1''':$'''0000''' || '''1''':$'''2000''' || '''1''':$'''4000''' || '''1''':$'''6000'''
|}
 
Since [[iNES]] headers were lacking reliable PRG-RAM size information before [[NES 2.0]], some emulators may have selected these behaviours through ROM CRC checks.
 
Because no ExROM game is known to write PRG-RAM with one bank value and then attempt to read back the same data with a different bank value, emulating the PRG-RAM as 64K at all times can be used as a compatible superset for all games.
 
Investigation of the [[MMC5 pinout]] in 2018 revealed that bits 2 and 3 also control additional PRG-RAM address pins, which could theoretically have been used to select 32 banks of a single 128K SRAM, with bit 2 controlling PRG A15 directly rather than using the two chip select /CE outputs.
 
==== Other PRG-RAM notes ====


* ''Bandit Kings of Ancient China'' maps PRG-RAM to the CPU $8000+ area and expects to be able to write to it through there.  Failure to emulate this causes corruption when the background is restored on the world map.
* ''Bandit Kings of Ancient China'' maps PRG-RAM to the CPU $8000+ area and expects to be able to write to it through there.  Failure to emulate this causes corruption when the background is restored on the world map.
* ''Uncharted Waters'' requires emulating bankswitching of PRG RAM: it writes to PRG RAM at one CPU address and expects to be able to read the same data back via a different CPU address.
* ''Uncharted Waters'' requires emulating bankswitching of PRG-RAM: it writes to PRG-RAM at one CPU address and expects to be able to read the same data back via a different CPU address.
* No ExROM game is known to write PRG RAM with one bank value and then attempt to read back the same data with a mirror of different bank value. So lacking better information, mirroring can be ignored, 64KB of WRAM could be emulated at all times, and $5113 can be treated as a simple page offset into that 64KB.  Emulating 32KB won't work, even if no games used more than that; because 16KB games will expect to see their two distinct pages by toggling bit 2, not bit 0. However, it's not advisable to rely on this fallback behavior for newly produced homebrew because people making a physical reproduction will not know from the header how much RAM to include on the cartridge board.<ref>[https://forums.nesdev.org/viewtopic.php?p=230927#p230927 lidnariq's comment about puNES]</ref>
* Games with 16K PRG-RAM only battery-save the first 8K.
* [http://bootgod.dyndns.org:7777/search.php?ines=5&battery=Yes&group=groupid List of MMC5 games which include a battery].


=== CHR Bankswitching ($5120-$5130) ===
=== CHR Bankswitching ($5120-$5130) ===
When using 8x8 sprites, only registers $5120-$5127 are used. Registers $5128-$512B are completely ignored.
When using 8x8 sprites, only registers $5120-$5127 are used. Registers $5128-$512B are completely ignored.


When using 8x16 sprites, registers $5120-$5127 specify banks for sprites, registers $5128-$512B apply to background tiles, and the last set of registers written to (either $5120-$5127 or $5128-$512B) will be used for I/O via [[PPUDATA]] ($2007). [https://forums.nesdev.org/viewtopic.php?p=193069#p193069] [http://forums.nesdev.org/viewtopic.php?p=194120#p194120]
When using 8x16 sprites, the PPU ignores the [[PPUCTRL|sprite pattern table address]] and can select tiles from the entire 8 KiB of pattern tables, which on other mappers overlaps with the background pattern table. The MMC5 keeps track of whether the PPU is fetching background tiles or sprite tiles, and has new registers to specify independent banks for the background tiles even if they appear to be the same address from the PPU. This effectively creates a CHR window of 12 KiB, with up to eight 1 KiB banks of sprites available simultaneously. Registers $5120-$5127 specify banks for sprites, registers $5128-$512B apply to background tiles, and the last set of registers written to (either $5120-$5127 or $5128-$512B) will be used for I/O via [[PPUDATA]] ($2007). [https://forums.nesdev.org/viewtopic.php?p=193069#p193069] [http://forums.nesdev.org/viewtopic.php?p=194120#p194120] The MMC5 knows that sprite data is being fetched by counting the number of fetches since the last detected scanline start, similar to how it detects the position for the vertical split.


''Bandit Kings of Ancient China'' and ''Uchuu Keibitai SDF'' have non-pattern data stored in CHR ROM, read out via $2007.
''Bandit Kings of Ancient China'' and ''Uchuu Keibitai SDF'' have non-pattern data stored in CHR ROM, read out via $2007.


The MMC5 is known to listen to the same address as the PPU to find out when to enable the 8x16 sprite mode; see [[#8x16_mode_enable_1_.28.242000.29|above]].
The MMC5 is known to listen to the same address as the PPU to find out when to enable the 8x16 sprite mode; see [[#8x16_mode_enable_1_.28.242000_.3D_PPUCTRL.29|above]].


==== CHR select $5120-$512B ====
==== CHR select $5120-$512B ====
Line 368: Line 546:


When the MMC5 is using 2KB/1KB CHR banks, only 512KB/256KB of CHR ROM can be selected using the previous registers. To access all 1024KB in those modes, first write the upper bit(s) to register $5130 and then write the lower bits to $5120-$512B.
When the MMC5 is using 2KB/1KB CHR banks, only 512KB/256KB of CHR ROM can be selected using the previous registers. To access all 1024KB in those modes, first write the upper bit(s) to register $5130 and then write the lower bits to $5120-$512B.
When the Extended RAM mode is set to 1, this selects which 256KB of CHR ROM is to be used for all background tiles on the screen.


The only ExROM game with CHR ROM larger than 256KB is ''Metal Slader Glory'', which uses 4KB CHR banks and does not use extended attributes. In other words, no official game relies on this register, and most don't even initialize it.
The only ExROM game with CHR ROM larger than 256KB is ''Metal Slader Glory'', which uses 4KB CHR banks and does not use extended attributes. In other words, no official game relies on this register, and most don't even initialize it.
In extended attribute mode ($5104 = 1), this register likely acts as a global, instantaneous bank selection that gets appended as the most significant 2 bits of ''all'' of the tile-specific CHR banks, selecting which 256KB of CHR ROM is to be used for all background tiles on the screen.  It is unlikely that the extended RAM stores all 10 bits per write, like registers $5120-$512B.


=== Other Registers ===
=== Other Registers ===
Line 379: Line 558:
  ESxW WWWW
  ESxW WWWW
  || | ||||
  || | ||||
  || +-++++- Specify vertical split start/stop tile
  || +-++++- Specify vertical split threshold tile count
  |+-------- Specify vertical split screen side (0:left; 1:right)
  |+-------- Specify vertical split region screen side (0:left; 1:right)
  +--------- Enable vertical split mode
  +--------- Enable vertical split mode


When vertical split mode is enabled, all VRAM fetches corresponding to the appropriate screen region will be redirected to Extended RAM (as long as its mode is set to 0 or 1).
''Uchuu Keibitai SDF'' uses split screen mode during the intro, where it shows ship stats.  ''Bandit Kings of Ancient China'' uses split screen mode during the ending sequence<ref>https://forums.nesdev.org/viewtopic.php?f=2&t=12764</ref>.
 
MMC5 internal extended RAM is always used as the nametable in split screen mode. Extended RAM mode ($5104) should be set to %00 or %01. RAM modes %10 or %11 disable split mode. Driving pin 92 low also disables split mode.  Split mode is automatically disabled based on PPUMASK monitoring. (See section on $2001 monitoring)
 
When using mode %01 with vertical split mode, the non-split region gains extended attributes, and the split region does not use extended attributes. As long as the non-split region remains horizontally scrolled to align with the left edge of a nametable, it is possible to share the extended RAM for both purposes.  For example, a split region on the right side of the screen will read its nametable data and non-extended attribute data from the “right side” of the extended RAM, and the left side of the screen will read its nametable data from wherever it is assigned in $5105, and get its extended attributes from the “left side” of the extended RAM.  The two separate functions of extended RAM data would not overlap this way.
 
===== Method of Operation =====


''Uchuu Keibitai SDF'' uses split screen mode during the intro, where it shows ship stats.  ''Bandit Kings of Ancient China'' uses split screen mode during the ending sequence<ref>https://forums.nesdev.org/viewtopic.php?f=2&t=12764</ref>.
Based on nametable fetch count (horizontally) and scanline count (vertically), the MMC5 makes substitutions to the nametable data, attribute table data, and the lowest 3 address bits of the pattern data.


===== Operation Notes =====
===== Horizontal Behavior =====


34 BG tiles are fetched per scanline.  MMC5 performs the split by watching which BG tile is being fetched,
For each visible scanline, the PPU fetches nametable data for 34 background tiles.  The MMC5 locates the split threshold by counting these fetches and comparing the count to the count value stored in register $5200. When the PPU is rendering in the split region, the MMC5 replaces the normal nametable data with the split region nametable data.  Because the split threshold is located based on nametable fetch count and not based on the actual nametable address requested by the PPU, the location of the split is more of an absolute position on the screen, always positioned the same number of tiles from the left side of the screen.  The PPU’s fine horizontal scrolling can cause the first tile rendered to be of fractional width, however the vertical split threshold will always occur at a full tile boundary, so the exact location of the split threshold is affected by fine horizontal scrolling, potentially deviating by up to 7 pixels this way.
and if it is within the split region, replacing the normal NT data with the split screen data according to
the absolute screen position of the tile (i.e., ignoring the coarse horizontal and vertical scroll output
as part of the VRAM address for the fetch).  Since it operates on a per-tile basis... fine horizontal
scrolling "carries into" the split region.  Setting the horizontal scroll to 1-7 will result in the split
being moved to the left 1-7 pixels, however when you scroll to 8, the split will "snap" back to its normal
position.
   
   
Left Split:
Left Split:
* Tiles 0 to T-1 are the split.
* Tiles 0 to T-1 are the split region.
* Tiles T and on are rendered normally.
* Tiles T and on are rendered normally.
   
   
Right Split:
Right Split:
* Tiles 0 to T-1 are rendered normally.
* Tiles 0 to T-1 are rendered normally.
* Tiles T and on are the split.
* Tiles T and on are the split region.
 
There is no intended horizontal scrolling of any kind for the split region.  Right-side split regions will always remain right-aligned with the right-hand side of the nametable, and left-side split regions will always remain left-aligned with the left-hand side of the nametable. Coarse horizontal scrolling can still be used for the non-split region.
 
===== Vertical Behavior =====
   
   
There is no coarse horizontal scrolling of any kind for the split.  Right-side splits will always show the
The MMC5 is able to have its own vertical origin in the split region because the nametable data that it substitutes is based on scanline count, which is always aligned to the top of the screen.
right-hand side of the nametable, and left-hand splits will always show the left-hand side of the nametable.
 
Coarse horizontal scrolling can still be used for the non-split region.
The MMC5 keeps track of the scanline count and adds this to the vertical scrolling value in $5201 in order to know what nametable data to substitute in the split region on each scanline.  Though the PPU continues requesting nametable data corresponding to its normal vertical scrolling in the split region, the MMC5 is ignoring the nametable address requested in this case and directly substituting its own nametable data.
   
 
ExRAM is always used as the nametable in split screen mode.
One additional caveat is fine vertical scrolling of the split region.  For each tile on each scanline, the PPU reads from a nametable, and uses that information to fetch the pattern data for 1 row of pixels for that tile.  The PPU normally keeps track of which row to fetch using PPU A0..3.  However, if the MMC5’s fine vertical scrolling doesn’t match the PPU’s fine vertical scrolling, it won’t be fetching the correct row of pixels from the tile.  This is why the MMC5 provides CHR A0..3.  By default, Nintendo PCBs are wired in “CL Mode”, which prevents the correct fine vertical scrolling of the split region.  (See [[MMC5 pinout]]).
 
Vertical scrolling for the split operates like normal vertical scrolling.  0-239 are valid scroll values,
Vertical scrolling for the split region operates like normal vertical scrolling.  0-239 are valid scroll values, whereas 240-255 will display attribute table data as nametable data for the first few scanlines.  The MMC5 does proper vertical mirroring of the split region nametable so that scrolling down properly rolls over to the top of the nametable, skipping the attribute table data that would naturally be located there.
whereas 240-255 will display Attribute table data as NT data for the first few scanlines.  The split nametable
will wrap so that the top of the nametable will appear below as you scroll (just as if vertical mirroring
were employed).
$5202 selects (yet another) CHR page to use for the BG.  This page is used for the split region only.


==== Vertical Split Scroll ($5201) ====
==== Vertical Split Scroll ($5201) ====
   All eight bits specify the vertical scroll value to use in split region
   All eight bits specify the vertical scroll value to use in split region


MMC5 boards wired in "CL" mode may only use vertical scroll values whose bottom 3 bits match the [[PPU|Nes PPU]]'s fine vertical scroll value. In "SL" mode, any values can be used.
MMC5 boards wired in "CL" mode should only use vertical scroll values whose bottom 3 bits match the [[PPU]]'s fine vertical scroll value. Using a mismatched value will cause tiles to seem to "roll" within themselves. In "SL" mode, any values can be used. (No existing games used the SL board configuration.)


Horizontal scrolling is not allowed within the split region.
Horizontal scrolling is not allowed within the split region.
Line 428: Line 606:
   All eight bits select a 4 KB CHR bank at $0000-$0FFF and $1000-$1FFF while rendering the split region.
   All eight bits select a 4 KB CHR bank at $0000-$0FFF and $1000-$1FFF while rendering the split region.


==== IRQ Counter ($5203) ====
==== IRQ Scanline Compare Value ($5203) ====
  All eight bits specify the scanline number to generate IRQ at
All eight bits specify the target scanline number at which to generate a scanline IRQ.  Value $00 is a special case that will not produce IRQ pending conditions, though it is possible to get an IRQ while this is set to $00 (due to the pending flag being set already.) You will need to take additional measures to fully suppress the IRQ. See the detailed discussion.


==== IRQ Status ($5204, read/write) ====
==== Scanline IRQ Status ($5204, read/write) ====
===== Write =====
===== Write =====
  7  bit  0
  7  bit  0
Line 437: Line 615:
  Exxx xxxx
  Exxx xxxx
  |
  |
  +--------- IRQ Enable flag (1=IRQs enabled)
  +--------- Scanline IRQ Enable flag (1=enabled)


===== Read =====
===== Read =====
Line 444: Line 622:
  SVxx xxxx  MMC5A default power-on value = $00
  SVxx xxxx  MMC5A default power-on value = $00
  ||
  ||
  |+-------- "In Frame" signal
  |+-------- "In Frame" flag
  +--------- IRQ Pending flag
  +--------- Scanline IRQ Pending flag


When set, the "In Frame" signal specifies that the PPU is currently rendering a scanline.  It also plays a role in how IRQs are generated.
The Scanline IRQ Pending flag becomes set at any time that the internal scanline counter matches the value written to register $5203.  If the scanline IRQ is enabled, it will also generate /IRQ to the system.


The IRQ Pending flag may be raised even if IRQs are disabled.
The "In Frame" flag is set when the PPU is actively rendering visible scanlines and cleared when not rendering; for example, vertical blank scanlines.  This flag does not clear for the short H-Blank period between visible scanlines.  When pin 92 is driven low, this flag remains low at all times. Additionally, scanline IRQs no longer occur when pin 92 is driven low.


Any time this register is read, the IRQ Pending flag is cleared (acknowledging the IRQ).
Any time this register is read, the Scanline IRQ Pending flag is automatically cleared (acknowledging the IRQ).  Acknowledging the IRQ does not clear the scanline counter, and you may write a larger value to $5203 within a scanline ISR in order to generate another IRQ on an additional scanline within the same frame.


For details, see [[MMC5#IRQ_Counter_Operation|IRQ counter operation]].
For details, see [[MMC5#IRQ_Counter_Operation|IRQ counter operation]].
Line 467: Line 645:
*MMC5A default power-on read value = $FE01, i.e. $FF * $FF.
*MMC5A default power-on read value = $FE01, i.e. $FF * $FF.


=== MMC5A Only ===
=== Internal extended RAM ($5C00-$5FFF, read/write) ===
Refer to register $5104 for special behaviors of the MMC5's 1KB internal extended RAM.
 
 
== MMC5A ==
 
The MMC5A was a later revision of MMC5 that included some extra features. Other than Just Breed mysteriously writing to $5800, no game is known that uses these features. Therefore, these will probably tend to have poor support from emulators.
 
=== MMC5A Registers ===
Registers $5207, $5208, $5209, $520A, and range $5800-$5BFF are present only in MMC5A.
Registers $5207, $5208, $5209, $520A, and range $5800-$5BFF are present only in MMC5A.
==== CL3 / SL3 Data Direction and Output Data Source (MMC5A: $5207 write only) ====
==== CL3 / SL3 Data Direction and Output Data Source (MMC5A: $5207 write only) ====
  7  bit  0
  7  bit  0
  ---- ----
  ---- ----
  ABxx xxCD  MMC5A default power-on write value = 11xx xxxx
  ABxx xxCD  MMC5A default power-on write value = 11xx xx00
  ||    ||
  ||    ||
  ||    |+- MMC5.97 (CL3) Output Data Source (0 = $5208.6 value written, 1 = !(M2) when CPU is reading in range $5800-$5BFF)
  ||    |+- MMC5.97 (CL3) Function (0 = I/O Control, 1 = $5800 read control
  ||    +-- MMC5.98 (SL3) Output Data Source (0 = $5208.7 value written, 1 = !(M2) when CPU is writing in range $5800-$5BFF)
  ||    +-- MMC5.98 (SL3) Function (0 = I/O Control, 1 = $5800 write control
  |+-------- MMC5.97 (CL3) Data Direction (0 = output, 1 = input)
  |+-------- MMC5.97 (CL3) I/O Data Direction (0 = output, 1 = input)
  +--------- MMC5.98 (SL3) Data Direction (0 = output, 1 = input)
  +--------- MMC5.98 (SL3) I/O Data Direction (0 = output, 1 = input)
 
When a function bit is set to 1, the pin becomes controlled by the applicable CPU writes or reads in the range $5800-$5BFF. The pin is normally driven high, and when the read or write occurs, it has a low pulse corresponding to !(M2). The intended purpose is unknown. It is theorized that it may attach a peripheral or additional RAM. When in this mode, none of the I/O configuration bits have any effect.


==== CL3 / SL3 Status (MMC5A: $5208 read/write) ====
==== CL3 / SL3 Status (MMC5A: $5208 read/write) ====
Line 485: Line 673:
  ABxx xxxx  MMC5A default power-on write value = 00xx xxxx
  ABxx xxxx  MMC5A default power-on write value = 00xx xxxx
  ||
  ||
  |+-------- Value to be output on MMC5.97 pin (CL3) if/when $5207.0 = 0 and $5207.6 = 0
  |+-------- Value to be output on MMC5.97 pin (CL3) if it is set as an I/O output in $5207.
  +--------- Value to be output on MMC5.98 pin (SL3) if/when $5207.1 = 0 and $5207.7 = 0
  +--------- Value to be output on MMC5.98 pin (SL3) if it is set as an I/O output in $5207.
 
Warning: The PCB may connect pins 97 and 98 directly to GND.  Though not totally confirmed, setting them as output high while connected like this has appeared to break the output drivers of these pins. Also note that enabling the $5800 function will have these pins driving high most of the time as well.


===== Read =====
===== Read =====
Line 523: Line 713:
The timer automatically starts when writing any value to register $5209, if the 16-bit timer value does not equal $0000.  For example, to write value $0100, you would first write $01 (MSB) to register $520A, which does not start the timer.  Then write $00 (LSB) to register $5209, which at that point will start the timer from value $0100.
The timer automatically starts when writing any value to register $5209, if the 16-bit timer value does not equal $0000.  For example, to write value $0100, you would first write $01 (MSB) to register $520A, which does not start the timer.  Then write $00 (LSB) to register $5209, which at that point will start the timer from value $0100.


Each 8-bit value is written directly to an internal 16-bit counter that decrements on each rising edge of M2.  Additional writes while the timer is running will directly overwrite that portion of the counter.  Reading register $5209 while the timer is running reports $00.  The transition from counter value $0001 to $0000 generates an IRQ and sets the hardware timer IRQ flag.  The timer stops at this point.  Reading this register reports the IRQ flag, then automatically clears the IRQ and IRQ flag.
Each 8-bit value is written directly to an internal 16-bit counter that decrements each CPU cycle, specifically on the rising edge of M2.  Additional writes while the timer is running will directly overwrite that portion of the counter.  Reading register $5209 while the timer is running reports $00.  The transition from counter value $0001 to $0000 generates an IRQ and sets the hardware timer IRQ flag.  The timer stops at this point.  Reading this register reports the IRQ flag, then automatically clears the IRQ and IRQ flag.


If the MMC5 detects a reset, it clears the timer if active, and it clears the IRQ and IRQ flag if set.  Reset detection works by looking for a gap larger than about 11 usec on M2.
If the MMC5 detects a reset, it clears the timer if active, and it clears the IRQ and IRQ flag if set.  Reset detection works by looking for a gap larger than about 11 usec on M2.


This register's IRQ operation is completely independent from register $5204.  Disabling interrupts through $5204 does not make any effect, also reading $5204 does not report IRQ pending when IRQ is asserted by $5209.
This register's IRQ operation is completely independent from register $5204.  Disabling interrupts through $5204 has no effect on, and reading $5204 does not report on, IRQs generated these registers.


==== Unknown Address Range (MMC5A: $5800-$5BFF, write only) ====
==== Unknown Address Range (MMC5A: $5800-$5BFF, write only) ====
Reads and writes in this address range are reflected on the CL3 and SL3 pins when register $5207 = $03.  The purpose of this function is unknown.  Minute VCC current spikes shortly after rising edge of M2 during writes in this range exhibit the same characteristics as writes in expansion RAM range $5C00-$5FFF, suggesting possible existence of RAM in this range, though experimentally reading from this range is always met with open CPU bus.
Reads and writes in this address range are reflected on the CL3 and SL3 pins when register $5207 = $03.  The purpose of this function is unknown.  Minute VCC current spikes shortly after rising edge of M2 during writes in this range exhibit the same characteristics as writes in internal extended RAM range $5C00-$5FFF, suggesting possible existence of RAM in this range, though experimentally reading from this range is always met with open CPU bus.
 
Address $5800 is written to by Just Breed.  During each V-Blank, it writes value $03, then $01 to this address, reads and writes to PPU registers, then writes value $00 to this address once complete.
 
=== Expansion RAM ($5C00-$5FFF, read/write) ===
* Mode 0/1 - Not readable (returns [[open bus]]), can only be written while the PPU is rendering (otherwise, 0 is written)
* Mode 2 - Readable and writable
* Mode 3 - Read-only
 
In Mode 1, nametable fetches are processed normally, and can come from CIRAM nametables, fill mode, or even Expansion RAM, but attribute fetches are replaced by data from Expansion RAM.


Each byte of Expansion RAM is used to enhance the tile at the corresponding address in every nametable (so the extended attributes are 1-screen mirrored):
Address $5800 is written to by Just Breed.  During each V-Blank, it writes value $03, then $01 to this address, reads and writes to PPU registers, then writes value $00 to this address once complete.  It is theorized that this was used as a debug signal to measure CPU usage / idle time during development.


7  bit  0
== Scanline Detection and Scanline IRQ ==
---- ----
AACC CCCC
|||| ||||
||++-++++- Select 4 KB CHR bank to use with specified tile
++-------- Select palette to use with specified tile
 
The pattern fetches ignore the standard CHR banking bits, and instead use the top two bits of $5130 and the bottom 6 bits from Expansion RAM to choose a 4KB bank to select the tile from.
 
''Just Breed'', ''Yakuman Tengoku'', and the Koei games use extended attributes continuously.
 
== Scanline Detection ==
[[File:mmc5_in_frame_status_bit.png|thumb|right|MMC5 'in frame' status bit state diagram]]
[[File:mmc5_in_frame_status_bit.png|thumb|right|MMC5 'in frame' status bit state diagram]]
Scanline detection involves monitoring the addresses read by the PPU.  In the state diagram to the right, PPU /RD going low indicates a read by the PPU.  M2 rising indicates a clock cycle of the CPU.  A PPU address is considered "in range" if the address is in the range $2000 - $2FFF.
The MMC5 detects scanlines by first looking for three consecutive PPU reads from the same nametable address in the range $2xxx. Once this has been seen, the next PPU read, regardless of address, is the point at which the scanline is detected.  This works because the PPU does two matching dummy nametable byte reads at the end of each scanline, followed by a third matching nametable byte read at the beginning of the next scanline, followed by an attribute table byte read.  So, the scanline gets detected when the PPU does the attribute table byte read, which is at PPU cycle 4.


When the MMC5 has detected that a scanline is rendering, the 'in frame' status bit gets set in register $5204 and the internal 8-bit scanline counter is incremented. Software can use this status bit as an indication of whether or not the PPU is currently rendering.
Once that occurs, if the "in-frame" flag (register $5204) was clear, it becomes set, and the internal 8-bit scanline counter is reset to zero; but if it was already set, the scanline counter is incremented, then compared against the value written to $5203. If they match, the "irq pending" flag is set.


It appears that all 240 rendered scanlines as well as the pre-render scanline are all detected by the MMC5.  It also appears that scanlines are detected near their end (or near the start of the next scanline). See also [http://forums.nesdev.org/viewtopic.php?t=7653].
The IRQ pending flag is raised when the desired scanline is reached ''regardless'' of whether or not the scanline IRQ is enabled, i.e. even after a 0 was written to the scanline IRQ enable flag. However, an actual IRQ is only sent to the CPU if both the scanline IRQ enable flag and IRQ pending flag are set. A $5203 value of $00 is a special case where the comparison is never true. The MMC5's scanline IRQ occurs at PPU cycle 4, unlike the simpler scanline counter of the MMC3, which usually generates an IRQ around PPU cycle 260. See also [http://forums.nesdev.org/viewtopic.php?t=7653].


The 'in frame' status bit is cleared as soon as the MMC5 no longer detects PPU rendering.  This happens at the end of the last rendered scanline, and whenever the PPU is switched off (Sprite and BG rendering disabled).
The "in-frame" flag is cleared when the PPU is no longer rendering.  This is detected when 3 CPU cycles pass without a PPU read having occurred (PPU /RD has not been low during the last 3 M2 rises).  The PPU does this in these conditions:
* the PPU begins the post-render scanline 240
* the PPU stops rendering because the user program wrote to CPU address $2001 with bits 3 and 4 clear.
* note: the MMC5 may not listen directly to writes to $2001 for this behavior, or it may be monitoring for particular transitions of $2001 that have not yet been fully tested.


Note that there are side-effects to switching off the PPU mid frame.  Clearing the In Frame signal effectively resets the IRQ counter as can be seen in the logic given above.  Therefore, if the PPU is switched back on in the frame, the IRQ counter will begin counting from $00 again.
The "in frame" flag is cleared, scanline IRQ is automatically acknowledged, and the internal scanline counter is reset in any of these conditions:
* the V-blank NMI occurs, i.e. CPU reads the interrupt vector from addresses $FFFA and $FFFB
* the user program intentionally reads from CPU addresses $FFFA or $FFFB
* the 241st scanline is detected.
* when the MMC5 believes that $2001 bits 3 and 4 are both clear and then either one of them gets set.


The system reset detection observed in the 16-bit software timer does not appear to have any effect on the 'in frame' status bit or the state diagram on the right.  It is unknown if reset detection clears the scanline counter or a pending scanline IRQ.
The scanline IRQ is acknowledged, but the "in frame" flag is not cleared and the scanline counter is not reset in any of these conditions:
* the user program reads register $5204
* scanline 0 is detected


== Scanline-Counting IRQ Operation ==
When system reset detection occurs, the only thing that happens is scanline IRQ becomes disabled.  All other operation continues unaffected.  These things happen any time that scanline IRQ becomes disabled:
* if /IRQ was low due to scanline IRQ pending flag, /IRQ returns high
* the scanline IRQ pending flag remains unaffected
* register $5203 value remains unaffected
* scanline counter remains unaffected
* enabling the scanline IRQ will cause immediate /IRQ low if IRQ pending flag is set, but will not affect anything else


The MMC5 has an internal 8-bit incrementing scanline counter that watches the PPU as it renders, and counts each passing scanline.  When the counter reaches the scanline specified by register $5203, it generates an IRQ. For example, when register $5203 is set to $04, the IRQ will occur near the start of the 5th rendered scanline.
This means in pseudo-code:
 
(On every PPU read -- PPU /RD falling edge)
When the MMC5 detects a scanline, the following events occur:
if address >= $2000 and address <= $2FFF and address == lastAddress
* If the 'in frame' status bit is clear, set it, reset the IRQ counter to 0, and clear the IRQ Pending flag
    matchCount := matchCount +1
* Otherwise, increment the IRQ counter. If it now equals the IRQ scanline specified by register $5203, raise IRQ Pending flag and generate an IRQ if enabled
    if matchCount == 2
 
      if inFrame == false
Note the above logic makes it impossible for an IRQ to occur when $5203 is set to $00
        inFrame := true
 
        scanline := 0
The IRQ Pending flag is raised when the desired scanline is reached ''regardless'' of whether or not IRQs are enabled.  $5204.7 can still be read as set even when IRQ Enable flag is clear. However, an actual IRQ is only sent to the CPU if both the IRQ Enable flag and IRQ Pending flag are raised.
      else
        scanline := scanline +1
        if scanline == [$5203]
            irqPending := true
  else
    matchCount := 0
lastAddress := address
ppuIsReading := true
(On every CPU cycle -- M2 rising edge)
if ppuIsReading
    idleCount := 0
  else
    idleCount := idleCount +1     
    if idleCount == 3
      inFrame := false
      lastAddress := undefined
ppuIsReading := false
(On every CPU write)
if address == $2001 and (value & $18) == 0
    inFrame := false
    lastAddress := undefined
(On every CPU read)
if address == $FFFA or address == $FFFB
    inFrame := false
    lastAddress := undefined
   
Please refer to the state diagrams on the right for a more formal description of the scanline and in-frame detection counters.


== Hardware ==
== Hardware ==


The MMC5 exists in a 100-pin TQFP package, see [[MMC5 pinout]] for details.
The MMC5 exists in a 100-pin rectangular QFP package, see [[MMC5 pinout]] for details.


MMC5 cartridge PCBs can be configured to different modes, see [[ExROM]] for details.
MMC5 cartridge PCBs can be configured to different modes, see [[ExROM]] for details.
Line 588: Line 801:
At least two different versions of the MMC5 are known to exist: MMC5, and MMC5A. MMC5A has the addition of registers $5207, $5208, $5209, and $520A: SL3/CL3 control and hardware timer.
At least two different versions of the MMC5 are known to exist: MMC5, and MMC5A. MMC5A has the addition of registers $5207, $5208, $5209, and $520A: SL3/CL3 control and hardware timer.


== See also ==
== References ==
<references />
 
== External links ==
* NES Mapper list by Disch [http://www.romhacking.net/documents/362/]
* NES Mapper list by Disch [http://www.romhacking.net/documents/362/]
* Nintendo MMC5 by goroh, translated by Sgt. Bowhack [http://nesdev.org/mmc5-e.txt]
* Nintendo MMC5 by goroh, translated by Sgt. Bowhack [//nesdev.org/mmc5-e.txt]
* Nintendo MMC5 Bankswitching by Kevin Horton [http://nesdev.org/mmc5_bank_switch.txt]
* Nintendo MMC5 Bankswitching by Kevin Horton [//nesdev.org/mmc5_bank_switch.txt]

Latest revision as of 14:48, 2 April 2024


MMC5
ExROM
Company Nintendo, Koei, others
Games 15 in NesCartDB
Complexity ASIC
Boards EKROM, ELROM,
ETROM, EWROM
Pinout MMC5 pinout
PRG ROM capacity 1024K
PRG ROM window 8K, 16K, or 32K
PRG RAM capacity 128K
PRG RAM window 8K ($6000-$DFFF),
16K (only $8000-$BFFF
at PRG mode 1/2)
CHR capacity 1024K
CHR window 1K, 2K, 4K, or 8K
Nametable mirroring arbitrary, up to 3 source
nametables (plus fill mode)
Bus conflicts No
IRQ Yes
Audio Yes
iNES mappers 005
NESCartDB
iNES 005
ExROM
EKROM
ELROM
ETROM
EWROM

The Nintendo MMC5 is a mapper ASIC used in Nintendo's ExROM Game Pak boards. All MMC5 boards are assigned to mapper 5.

Example games:

  • Castlevania 3
  • Just Breed
  • Uncharted Waters
  • Romance of the Three Kingdoms II
  • Laser Invasion
  • Metal Slader Glory
  • Uchuu Keibitai SDF
  • Shin 4 Nin Uchi Mahjong - Yakuman Tengoku
  • Bandit Kings of Ancient China

The first game to use this chip (Nobunaga's Ambition II) was released in February 1990. The date codes on components on early released cartridges show that manufacturing had started at the end of 1989.

A later MMC5A revision was introduced with a few extra features, but all released games do not rely on these features and are compatible with the original MMC5.

Overview

The MMC5 is the most powerful mapper ASIC Nintendo made for the NES and Famicom.

It supports many advanced features, including:

  • 4 PRG ROM switching modes
  • 4 CHR ROM switching modes
  • Up to 128KB of WRAM, mappable not only at $6000-$7FFF but also within $8000-$DFFF
    • Supports either one chip (up to 128KB) or two chips (up to 32KB each)
  • An 8 bit by 8 bit multiplier with a 16 bit result for performing quick calculations
  • Scanline detection with counter and configurable IRQ
  • Frame detection with status bit
  • The ability to use different CHR banks for background and 8x16 sprites (allowing 256 unique 8x16 sprite tiles, independent of the background).
  • 1024 bytes of on-chip memory, which can be used for 4 different purposes:
    • An extra general-use nametable
    • Attribute and tile index expansion - address 16384 background tiles at once, and allow each individual 8x8 tile to have its own palette setting
    • Vertical split-screen
    • Extra RAM for storing program variables
  • Three extra sound channels
    • Two pulse channels, identical to those in the NES APU (except lacking pitch sweeps).
    • An 8-bit RAW PCM channel
  • A 'fill mode' nametable, which can be instantly set to contain a specific tile in a specific color (useful for screen transitions)
  • System reset detection
    • Triggered by a positive or negative gap in M2 of at least 11.2 usec.
    • Also triggered and latched by absence of AVcc.
    • After reapplying AVcc, another gap in M2 is sometimes necessary to clear the latch.
    • This feature resets some, but not all, states of the MMC5.
    • The PRG RAM +CE pin is a direct reflection of system reset detection state.

Banks

The MMC5 provides 4 distinct banking modes for both PRG ROM and CHR ROM.

PRG mode 0

  • CPU $6000-$7FFF: 8 KB switchable PRG RAM bank
  • CPU $8000-$FFFF: 32 KB switchable PRG ROM bank

PRG mode 1

  • CPU $6000-$7FFF: 8 KB switchable PRG RAM bank
  • CPU $8000-$BFFF: 16 KB switchable PRG ROM/RAM bank
  • CPU $C000-$FFFF: 16 KB switchable PRG ROM bank

PRG mode 2

  • CPU $6000-$7FFF: 8 KB switchable PRG RAM bank
  • CPU $8000-$BFFF: 16 KB switchable PRG ROM/RAM bank
  • CPU $C000-$DFFF: 8 KB switchable PRG ROM/RAM bank
  • CPU $E000-$FFFF: 8 KB switchable PRG ROM bank

PRG mode 3

  • CPU $6000-$7FFF: 8 KB switchable PRG RAM bank
  • CPU $8000-$9FFF: 8 KB switchable PRG ROM/RAM bank
  • CPU $A000-$BFFF: 8 KB switchable PRG ROM/RAM bank
  • CPU $C000-$DFFF: 8 KB switchable PRG ROM/RAM bank
  • CPU $E000-$FFFF: 8 KB switchable PRG ROM bank

CHR mode 0

  • PPU $0000-$1FFF: 8 KB switchable CHR bank

CHR mode 1

  • PPU $0000-$0FFF: 4 KB switchable CHR bank
  • PPU $1000-$1FFF: 4 KB switchable CHR bank

CHR mode 2

  • PPU $0000-$07FF: 2 KB switchable CHR bank
  • PPU $0800-$0FFF: 2 KB switchable CHR bank
  • PPU $1000-$17FF: 2 KB switchable CHR bank
  • PPU $1800-$1FFF: 2 KB switchable CHR bank

CHR mode 3

  • PPU $0000-$03FF: 1 KB switchable CHR bank
  • PPU $0400-$07FF: 1 KB switchable CHR bank
  • PPU $0800-$0BFF: 1 KB switchable CHR bank
  • PPU $0C00-$0FFF: 1 KB switchable CHR bank
  • PPU $1000-$13FF: 1 KB switchable CHR bank
  • PPU $1400-$17FF: 1 KB switchable CHR bank
  • PPU $1800-$1BFF: 1 KB switchable CHR bank
  • PPU $1C00-$1FFF: 1 KB switchable CHR bank

Registers

Sound ($5000-$5015)

For details on sound operation, see MMC5 audio

NES internal state monitoring

All of these registers overlay various registers that are already used inside the NES, and are fully decoded. A game could write to a mirror of a PPU register to get the MMC5 out of sync, but it's not clear how that could be useful.

8x16 mode enable ($2000 = PPUCTRL)

7  bit  0
---- ----
xxZx xxxx
  |
  +------- Sprite size (0: 8x8 pixels; 1: 8x16 pixels)

Only when Z is set and at least one E bit is set does the MMC5 draw 8x16 sprites from eight independent banks.[1]

PPU Data Substitution Enable ($2001 = PPUMASK)

7  bit  0
---------
xxxE Exxx
   | |
   +-+--- 1,2,3: Substitutions enabled; 0: substitutions disabled

The MMC5 listens to writes to PPUMASK ($2001). When it sees that both E bits are cleared, it disables its ability to make substitutions on the PPU data bus. This includes disabling:

  • Independent bank 8x16 sprite mode
  • Extended attribute mode
  • Vertical split mode

The MMC5 only listens to the fully decoded address $2001, so this can be tested by using the PPU’s mirrors of this register. For example, writing to register $2009 will be heard by the PPU but not the MMC5. It is not clear if that could have a practical use beyond test purposes.

When the MMC5 sees $00 written to $2001, and then the PPU’s rendering gets enabled via a mirror of $2001, the MMC5 still counts scanlines and can generate scanline interrupts even though it thinks $2001 is still disabled. The transition from disabled to enabled resets the scanline counter.

Driving pin 92 low similarly disables substitutions. Because no scanline interrupts occur with pin 92 held low, it seems to hold the scanline counter in reset.

Unknown ($2002 = PPUSTATUS, read only)

Power analysis has detected that both revisions of the MMC5 monitor reads here, purpose unknown.

Unknown ($2005 = PPUSCROLL)

Power analysis has detected that both revisions of the MMC5 monitor writes here, purpose unknown.

Unknown ($2006 = PPUADDR, MMC5A only)

Power analysis has detected that the MMC5A monitors writes here, purpose unknown.

Unknown ($4014 = OAMDMA)

Power analysis has detected that both revisions of the MMC5 monitor writes here, purpose unknown.

Configuration

PRG mode ($5100)

7  bit  0
---- ----
xxxx xxPP
       ||
       ++- Select PRG banking mode
  • 0 - One 32KB bank
  • 1 - Two 16KB banks
  • 2 - One 16KB bank ($8000-$BFFF) and two 8KB banks ($C000-$DFFF and $E000-$FFFF)
  • 3 - Four 8KB banks

Castlevania III uses mode 2, which is similar to VRC6 PRG banking. All other games use mode 3. The Koei games never write to this register, apparently relying on the MMC5 defaulting to mode 3 at power on.

CHR mode ($5101)

7  bit  0
---- ----
xxxx xxCC
       ||
       ++- Select CHR banking mode
  • 0 - 8KB CHR pages
  • 1 - 4KB CHR pages
  • 2 - 2KB CHR pages
  • 3 - 1KB CHR pages

Metal Slader Glory uses 4KB CHR pages. All other games use 1KB pages.

PRG RAM Protect 1 ($5102)

7  bit  0
---- ----
xxxx xxWW
       ||
       ++- RAM protect 1

In order to enable writing to PRG RAM, this must be set to binary '10' (e.g. $02).

PRG RAM Protect 2 ($5103)

7  bit  0
---- ----
xxxx xxWW
       ||
       ++- RAM protect 2

In order to enable writing to PRG RAM, this must be set to binary '01' (e.g. $01).

Internal extended RAM mode ($5104)

7  bit  0
---- ----
xxxx xxXX
       ||
       ++- Specify extended RAM usage
$5104 CPU Access ($5C00-$5FFF)
during blanking		 CPU Access ($5C00-$5FFF)
during rendering		 PPUDATA Access ($2000-$2FFF)(1)
during blanking		 Available as
Nametable		 Enable Extended
Attribute Mode
%00 No(3) Write Only(4) Read/Write Yes No
%01 No(3) Write Only(4) Read/Write Yes2 Yes
%10 Read/Write Read/Write No No No
%11
Read Only
Read Only
 No No No

(1)When configured as a nametable in register $5105, read and write access is possible through the PPU via registers $2006/$2007 when the PPU is not rendering. Based on register $5105, any nametables mapped to extended RAM will support the corresponding PPU address ranges for reads and writes. For example, if NT4 is mapped to extended RAM, reads/writes to PPU $2C00 will correspond with extended RAM $5C00.

(2)Though it is possible to still assign the extended RAM as a nametable in the mode %01, you are going to have the same data used twice, once as extended attribute data, and once as nametable data, this does not seem to be a useful combination. In the other modes, the nametable will read as if it contains all $00s.

(3)Counterintuitively, writes in these modes are only allowed when the PPU is rendering. If writes are attempted during V-blank, they may be ignored or cause a corruption at that memory address. In practice, temporarily switch to mode %10 if you wish to write during V-blank.

(4)Attempting to read extended RAM in those modes returns open bus.

Extended attributes

In mode %01, "Extended Attribute Mode", each byte of the MMC5's internal extended RAM is used to enhance the background tile at the corresponding nametable address. The extended attributes are 1-screen mirrored; in other words, they apply the same for all nametables.

Format of each extended attribute byte: 

7  bit  0
---- ----
AACC CCCC
|||| ||||
||++-++++- Select 4 KB CHR bank to use with specified tile
++-------- Select palette to use with specified tile

In extended attribute mode, CHR banking behaves differently than normal when fetching background tiles from pattern tables:

  • CHR mode (register $5101) is ignored. CHR banks are always 4KB in this mode.
  • The values of the CHR banking registers $5120-$512B are also ignored.
  • Bits 0-5 specified here are used for selecting a 4KB CHR bank on a per-tile basis.
  • The two bits in $5130 are used globally as CHR bank bits 6 and 7.
  • Driving pin 92 low disables extended attribute mode. Extended attribute mode is also automatically disabled based on PPUMASK monitoring. (See section on $2001 monitoring.) In these cases, the non-extended attribute table is used instead.

In other words, this works as if the nametable was extended from 8-bit to 14-bit tile offsets, with the ExRAM holding the upper 6-bits and the 2-bit palette value, while the nametable selected through $5105 contains the lower 8 bits.

Just Breed, Yakuman Tengoku, and the Koei games use extended attributes continuously.

Nametable mapping ($5105)

7  bit  0
---- ----
DDCC BBAA
|||| ||||
|||| ||++- Select nametable at PPU $2000-$23FF
|||| ++--- Select nametable at PPU $2400-$27FF
||++------ Select nametable at PPU $2800-$2BFF
++-------- Select nametable at PPU $2C00-$2FFF

Nametable values:

  • 0 - CIRAM page 0
  • 1 - CIRAM page 1
  • 2 - Internal extended RAM
    • When $5104 is set to mode %10 or %11, the nametable will read as all zeros. This does not share functionality with fill mode.
  • 3 - Fill-mode data
    • See registers $5106 and $5017

Mirroring examples:

Mode Value NTD NTC NTB NTA
Horizontal $50 %01 %01 %00 %00
Vertical $44 %01 %00 %01 %00
Single-screen CIRAM 0 $00 %00 %00 %00 %00
Single-screen CIRAM 1 $55 %01 %01 %01 %01
Single-screen ExRAM $AA %10 %10 %10 %10
Single-Screen Fill-mode $FF %11 %11 %11 %11
Diagonal $14 %00 %01 %01 %00

Fill-mode tile ($5106)

When a nametable is mapped to fill-mode in register $5105, all nametable fetches get replaced by the value of this register. Only the nametable is affected by fill mode. When the PPU later uses this information to fetch the corresponding tile from the pattern table, CHR banking is unaffected and continues to work normally. §

Fill-mode color ($5107)

7  bit  0
---- ----
xxxx xxAA
       ||
       ++- Specify background palette index to use for fill-mode nametable

When a nametable is mapped to fill-mode in register $5105, and $5104 is not in mode %01, all attribute table fetches get replaced by the value of this register. Each byte of the attribute table normally contains four 2-bit palette indexes. The two bits in this register are copied for all four indexes.

When $5104 is in mode %01, extended attribute mode does apply for fill mode, and this register is ignored. However, if pin 92 is driven low in this mode, extended attribute mode becomes disabled and this register comes back into effect.

PRG Bankswitching ($5113-$5117)

In general, when the CPU accesses an address that corresponds to the range of a PRG bank designated by the present PRG mode, the bits of that PRG bank register are applied to the appropriate PRG address buses as follows: 

7  bit  0
---- ----
RAAA AaAA
|||| ||||
|||| |||+- PRG ROM/RAM A13
|||| ||+-- PRG ROM/RAM A14
|||| |+--- PRG ROM/RAM A15, also selecting between PRG RAM /CE 0 and 1
|||| +---- PRG ROM/RAM A16
|||+------ PRG ROM A17
||+------- PRG ROM A18
|+-------- PRG ROM A19
+--------- RAM/ROM toggle (0: RAM; 1: ROM) (registers $5114-$5116 only)

Bank register effective areas versus PRG mode:

CPU memory affected for each mode (see #PRG mode ($5100))
CPU Address Mode 3 Registers Mode 2 Registers Mode 1 Registers Mode 0 Registers
$6000-7FFF $5113 (RAM only) $5113 (RAM only) $5113 (RAM only) $5113 (RAM only)
$8000-9FFF $5114 $5115 $5115 $5117 (ROM only)
$A000-BFFF $5115
$C000-DFFF $5116 $5116 $5117 (ROM only)
$E000-FFFF $5117 (ROM only) $5117 (ROM only)

Register bits $5113.7 and $5117.7 are always ignored. $5113 always maps RAM, and $5117 always maps ROM. Because of this, it is not possible to map the interrupt vectors to RAM in any mode. All known games have their reset vector in the last bank of PRG ROM, and the vector points to an address greater than or equal to $E000. This tells us that $5117 must have a reliable power-on value of $FF.

When a bankswitch register controls an 8kByte CPU address range, register bits 6..0 correspond to PRG A19..A13.

In PRG modes where a register controls a 16kByte CPU address range, register bits 6..1 correspond to PRG A19..A14. Register bit 0 is ignored and instead CPU A13 directly controls PRG A13. For example, comparing mode 3 to mode 2 for CPU address range $8000-BFFF. These are equivalent:

  • In mode 3, write value $90 to $5114 and value $91 to $5115.
  • In mode 2, write value $90 to $5115.

However, these are not equivalent:

  • In mode 3, write value $91 to $5114 and value $92 to $5115.
  • In mode 2, write value $91 to $5115.

The MMC5 ignores register bit 0 in the 16kByte bank.

Similarly, when register $5117 controls a 32kByte CPU address range in mode 0, register bits 6..2 correspond to PRG A19..A15, register bits 1..0 are ignored, and CPU A14..A13 directly control PRG A14..A13

Separate PRG-ROM and PRG-RAM Address Busses

The MMC5 has separate sets of address pins for PRG-ROM and PRG-RAM. This is a concept that has proven difficult to understand and explain. It all stems from the fact that CPU A15 is not directly routed to the cartridge; the signal /ROMSEL is supplied instead. Though it is possible to figure out CPU A15 from /ROMSEL, it is not possible to use it to select the correct PRG address. The PRG address needs to be set sooner than this in order to have an adequate setup time for the RAM or ROM chips. So basically, the starting point is that the MMC5 has to ignore /ROMSEL (and therefore CPU A15) when it comes to the PRG address, for the purpose of timings. This effectively creates a mirror on the PRG address bus for CPU address range $0000-7FFF and $8000-FFFF. Specifically, this makes range $6000-7FFF indistinguishable from $E000-FFFF. Because the MMC5 wanted to have separately controllable mapping for those ranges, its solution was to make two separate PRG address busses.

The MMC5's PRG-ROM address pins follow this logic. Though the PRG-ROM address bus is decoded at all CPU addresses, the gray areas always have PRG ROM /CE disabled:

CPU Address Mode 3 PRG-ROM
Address Source 		Mode 2 PRG-ROM
Address Source 		Mode 1 PRG-ROM
Address Source 		Mode 0 PRG-ROM
Address Source
$0000-1FFF $5114 $5115 $5115 $5117
$2000-3FFF $5115
$4000-5FFF $5116 $5116 $5117
$6000-7FFF $5117 $5117
$8000-9FFF $5114 $5115 $5115 $5117
$A000-BFFF $5115
$C000-DFFF $5116 $5116 $5117
$E000-FFFF $5117 $5117

The MMC5's PRG-RAM address pins follow this logic, again with PRG-RAM /CE always disabled in the gray areas:

CPU Address Mode 3 PRG-RAM
Address Source 		Mode 2 PRG-RAM
Address Source 		Mode 1 PRG-RAM
Address Source 		Mode 0 PRG-RAM
Address Source
$0000-1FFF $5114 $5115 $5115 $5113
$2000-3FFF $5115
$4000-5FFF $5116 $5116 $5113
$6000-7FFF $5113 $5113 $5113 $5113
$8000-9FFF $5114 $5115 $5115 $5113
$A000-BFFF $5115
$C000-DFFF $5116 $5116 $5113
$E000-FFFF $5113 $5113

If we overlap these two tables, the original table reemerges. Pink always has /CE enabled for RAM (using $5113), Blue always has /CE enabled for ROM (using $5117), and Purple chooses which /CE using the register bit 7. Gray always has RAM /CE and ROM /CE disabled at all times.

CPU Address Mode 3 PRG
Address Source 		Mode 2 PRG
Address Source 		Mode 1 PRG
Address Source 		Mode 0 PRG
Address Source
$0000-1FFF $5114 $5115 $5115 $5113/$5117
$2000-3FFF $5115
$4000-5FFF $5116 $5116 $5113/$5117
$6000-7FFF $5113/$5117 $5113/$5117 $5113/$5117 $5113/$5117
$8000-9FFF $5114 $5115 $5115 $5113/$5117
$A000-BFFF $5115
$C000-DFFF $5116 $5116 $5113/$5117
$E000-FFFF $5113/$5117 $5113/$5117


PRG-RAM configurations

In commercial configurations, bits 0 and 1 select pages within an SRAM chip, and bit 2 selects between two separate SRAMs. 8K and 32K games have a single SRAM chip that will only be active when bit 2 is clear. 16K games instead have two chips, but only the first is battery backed.

Configuration bank value & 7
0 1 2 3 4 5 6 7
ELROM 0K open bus open bus open bus open bus open bus open bus open bus open bus
EKROM 8K (1 x 8K) 0:$0000 0:$0000 0:$0000 0:$0000 open bus open bus open bus open bus
ETROM 16K (2 x 8K) 0:$0000 0:$0000 0:$0000 0:$0000 1:$0000 1:$0000 1:$0000 1:$0000
EWROM 32K (1 x 32K) 0:$0000 0:$2000 0:$4000 0:$6000 open bus open bus open bus open bus
Superset 64K (2 x 32K) 0:$0000 0:$2000 0:$4000 0:$6000 1:$0000 1:$2000 1:$4000 1:$6000

Since iNES headers were lacking reliable PRG-RAM size information before NES 2.0, some emulators may have selected these behaviours through ROM CRC checks.

Because no ExROM game is known to write PRG-RAM with one bank value and then attempt to read back the same data with a different bank value, emulating the PRG-RAM as 64K at all times can be used as a compatible superset for all games.

Investigation of the MMC5 pinout in 2018 revealed that bits 2 and 3 also control additional PRG-RAM address pins, which could theoretically have been used to select 32 banks of a single 128K SRAM, with bit 2 controlling PRG A15 directly rather than using the two chip select /CE outputs.

Other PRG-RAM notes

  • Bandit Kings of Ancient China maps PRG-RAM to the CPU $8000+ area and expects to be able to write to it through there. Failure to emulate this causes corruption when the background is restored on the world map.
  • Uncharted Waters requires emulating bankswitching of PRG-RAM: it writes to PRG-RAM at one CPU address and expects to be able to read the same data back via a different CPU address.
  • Games with 16K PRG-RAM only battery-save the first 8K.
  • List of MMC5 games which include a battery.

CHR Bankswitching ($5120-$5130)

When using 8x8 sprites, only registers $5120-$5127 are used. Registers $5128-$512B are completely ignored.

When using 8x16 sprites, the PPU ignores the sprite pattern table address and can select tiles from the entire 8 KiB of pattern tables, which on other mappers overlaps with the background pattern table. The MMC5 keeps track of whether the PPU is fetching background tiles or sprite tiles, and has new registers to specify independent banks for the background tiles even if they appear to be the same address from the PPU. This effectively creates a CHR window of 12 KiB, with up to eight 1 KiB banks of sprites available simultaneously. Registers $5120-$5127 specify banks for sprites, registers $5128-$512B apply to background tiles, and the last set of registers written to (either $5120-$5127 or $5128-$512B) will be used for I/O via PPUDATA ($2007). [1] [2] The MMC5 knows that sprite data is being fetched by counting the number of fetches since the last detected scanline start, similar to how it detects the position for the vertical split.

Bandit Kings of Ancient China and Uchuu Keibitai SDF have non-pattern data stored in CHR ROM, read out via $2007.

The MMC5 is known to listen to the same address as the PPU to find out when to enable the 8x16 sprite mode; see above.

CHR select $5120-$512B

PPU memory affected for each mode (see #CHR mode ($5101))
Register 1 KiB 2 KiB 4 KiB 8 KiB
$5120 $0000-$03FF none none none
$5121 $0400-$07FF $0000-$07FF none none
$5122 $0800-$0BFF none none none
$5123 $0C00-$0FFF $0800-$0FFF $0000-$0FFF none
$5124 $1000-$13FF none none none
$5125 $1400-$17FF $1000-$17FF none none
$5126 $1800-$1BFF none none none
$5127 $1C00-$1FFF $1800-$1FFF $1000-$1FFF $0000-$1FFF
$5128 $0000-$03FF and $1000-$13FF none none none
$5129 $0400-$07FF and $1400-$17FF $0000-$07FF and $1000-$17FF none none
$512A $0800-$0BFF and $1800-$1BFF none none none
$512B $0C00-$0FFF and $1C00-$1FFF $0800-$0FFF and $1800-$1FFF $0000-$0FFF and $1000-$1FFF $0000-$1FFF

Caution: Unlike the MMC1 and unlike PRG banking on the MMC5, the banks are always indexed by the currently selected size. When using 2kb, 4kb or 8kb bank sizes, the registers hold bank index of that larger size, and lower bits are *not* ignored.

Upper CHR Bank bits ($5130)

7  bit  0
---- ----
xxxx xxBB
       ||
       ++- Upper bits for subsequent CHR bank writes

When the MMC5 is using 2KB/1KB CHR banks, only 512KB/256KB of CHR ROM can be selected using the previous registers. To access all 1024KB in those modes, first write the upper bit(s) to register $5130 and then write the lower bits to $5120-$512B.

The only ExROM game with CHR ROM larger than 256KB is Metal Slader Glory, which uses 4KB CHR banks and does not use extended attributes. In other words, no official game relies on this register, and most don't even initialize it.

In extended attribute mode ($5104 = 1), this register likely acts as a global, instantaneous bank selection that gets appended as the most significant 2 bits of all of the tile-specific CHR banks, selecting which 256KB of CHR ROM is to be used for all background tiles on the screen. It is unlikely that the extended RAM stores all 10 bits per write, like registers $5120-$512B.

Other Registers

Vertical Split Mode ($5200)

7  bit  0
---- ----
ESxW WWWW
|| | ||||
|| +-++++- Specify vertical split threshold tile count
|+-------- Specify vertical split region screen side (0:left; 1:right)
+--------- Enable vertical split mode

Uchuu Keibitai SDF uses split screen mode during the intro, where it shows ship stats. Bandit Kings of Ancient China uses split screen mode during the ending sequence[2].

MMC5 internal extended RAM is always used as the nametable in split screen mode. Extended RAM mode ($5104) should be set to %00 or %01. RAM modes %10 or %11 disable split mode. Driving pin 92 low also disables split mode. Split mode is automatically disabled based on PPUMASK monitoring. (See section on $2001 monitoring)

When using mode %01 with vertical split mode, the non-split region gains extended attributes, and the split region does not use extended attributes. As long as the non-split region remains horizontally scrolled to align with the left edge of a nametable, it is possible to share the extended RAM for both purposes. For example, a split region on the right side of the screen will read its nametable data and non-extended attribute data from the “right side” of the extended RAM, and the left side of the screen will read its nametable data from wherever it is assigned in $5105, and get its extended attributes from the “left side” of the extended RAM. The two separate functions of extended RAM data would not overlap this way.

Method of Operation

Based on nametable fetch count (horizontally) and scanline count (vertically), the MMC5 makes substitutions to the nametable data, attribute table data, and the lowest 3 address bits of the pattern data.

Horizontal Behavior

For each visible scanline, the PPU fetches nametable data for 34 background tiles. The MMC5 locates the split threshold by counting these fetches and comparing the count to the count value stored in register $5200. When the PPU is rendering in the split region, the MMC5 replaces the normal nametable data with the split region nametable data. Because the split threshold is located based on nametable fetch count and not based on the actual nametable address requested by the PPU, the location of the split is more of an absolute position on the screen, always positioned the same number of tiles from the left side of the screen. The PPU’s fine horizontal scrolling can cause the first tile rendered to be of fractional width, however the vertical split threshold will always occur at a full tile boundary, so the exact location of the split threshold is affected by fine horizontal scrolling, potentially deviating by up to 7 pixels this way.

Left Split:

  • Tiles 0 to T-1 are the split region.
  • Tiles T and on are rendered normally.

Right Split:

  • Tiles 0 to T-1 are rendered normally.
  • Tiles T and on are the split region.

There is no intended horizontal scrolling of any kind for the split region. Right-side split regions will always remain right-aligned with the right-hand side of the nametable, and left-side split regions will always remain left-aligned with the left-hand side of the nametable. Coarse horizontal scrolling can still be used for the non-split region.

Vertical Behavior

The MMC5 is able to have its own vertical origin in the split region because the nametable data that it substitutes is based on scanline count, which is always aligned to the top of the screen.

The MMC5 keeps track of the scanline count and adds this to the vertical scrolling value in $5201 in order to know what nametable data to substitute in the split region on each scanline. Though the PPU continues requesting nametable data corresponding to its normal vertical scrolling in the split region, the MMC5 is ignoring the nametable address requested in this case and directly substituting its own nametable data.

One additional caveat is fine vertical scrolling of the split region. For each tile on each scanline, the PPU reads from a nametable, and uses that information to fetch the pattern data for 1 row of pixels for that tile. The PPU normally keeps track of which row to fetch using PPU A0..3. However, if the MMC5’s fine vertical scrolling doesn’t match the PPU’s fine vertical scrolling, it won’t be fetching the correct row of pixels from the tile. This is why the MMC5 provides CHR A0..3. By default, Nintendo PCBs are wired in “CL Mode”, which prevents the correct fine vertical scrolling of the split region. (See MMC5 pinout).

Vertical scrolling for the split region operates like normal vertical scrolling. 0-239 are valid scroll values, whereas 240-255 will display attribute table data as nametable data for the first few scanlines. The MMC5 does proper vertical mirroring of the split region nametable so that scrolling down properly rolls over to the top of the nametable, skipping the attribute table data that would naturally be located there.

Vertical Split Scroll ($5201)

 All eight bits specify the vertical scroll value to use in split region

MMC5 boards wired in "CL" mode should only use vertical scroll values whose bottom 3 bits match the PPU's fine vertical scroll value. Using a mismatched value will cause tiles to seem to "roll" within themselves. In "SL" mode, any values can be used. (No existing games used the SL board configuration.)

Horizontal scrolling is not allowed within the split region.

Vertical Split Bank ($5202)

 All eight bits select a 4 KB CHR bank at $0000-$0FFF and $1000-$1FFF while rendering the split region.

IRQ Scanline Compare Value ($5203)

All eight bits specify the target scanline number at which to generate a scanline IRQ. Value $00 is a special case that will not produce IRQ pending conditions, though it is possible to get an IRQ while this is set to $00 (due to the pending flag being set already.) You will need to take additional measures to fully suppress the IRQ. See the detailed discussion.

Scanline IRQ Status ($5204, read/write)

Write
7  bit  0
---- ----
Exxx xxxx
|
+--------- Scanline IRQ Enable flag (1=enabled)
Read
7  bit  0
---- ----
SVxx xxxx  MMC5A default power-on value = $00
||
|+-------- "In Frame" flag
+--------- Scanline IRQ Pending flag

The Scanline IRQ Pending flag becomes set at any time that the internal scanline counter matches the value written to register $5203. If the scanline IRQ is enabled, it will also generate /IRQ to the system.

The "In Frame" flag is set when the PPU is actively rendering visible scanlines and cleared when not rendering; for example, vertical blank scanlines. This flag does not clear for the short H-Blank period between visible scanlines. When pin 92 is driven low, this flag remains low at all times. Additionally, scanline IRQs no longer occur when pin 92 is driven low.

Any time this register is read, the Scanline IRQ Pending flag is automatically cleared (acknowledging the IRQ). Acknowledging the IRQ does not clear the scanline counter, and you may write a larger value to $5203 within a scanline ISR in order to generate another IRQ on an additional scanline within the same frame.

For details, see IRQ counter operation.

Unsigned 8x8 to 16 Multiplier ($5205, $5206 read/write)

The unsigned 16-bit product is available to be read from these registers immediately after writing. All 65536 combinations of multiplicand and multiplier were tested and verified correct on MMC5A here[3].

Write
  • $5205 8-bit Unsigned Multiplicand
  • $5206 8-bit Unsigned Multiplier
  • MMC5A default power-on write value = $FF for both of these registers.
Read
  • $5205 Unsigned 16-bit Product (low byte)
  • $5206 Unsigned 16-bit Product (high byte)
  • MMC5A default power-on read value = $FE01, i.e. $FF * $FF.

Internal extended RAM ($5C00-$5FFF, read/write)

Refer to register $5104 for special behaviors of the MMC5's 1KB internal extended RAM.


MMC5A

The MMC5A was a later revision of MMC5 that included some extra features. Other than Just Breed mysteriously writing to $5800, no game is known that uses these features. Therefore, these will probably tend to have poor support from emulators.

MMC5A Registers

Registers $5207, $5208, $5209, $520A, and range $5800-$5BFF are present only in MMC5A.

CL3 / SL3 Data Direction and Output Data Source (MMC5A: $5207 write only)

7  bit  0
---- ----
ABxx xxCD  MMC5A default power-on write value = 11xx xx00
||     ||
||     |+- MMC5.97 (CL3) Function (0 = I/O Control, 1 = $5800 read control
||     +-- MMC5.98 (SL3) Function (0 = I/O Control, 1 = $5800 write control
|+-------- MMC5.97 (CL3) I/O Data Direction (0 = output, 1 = input)
+--------- MMC5.98 (SL3) I/O Data Direction (0 = output, 1 = input)

When a function bit is set to 1, the pin becomes controlled by the applicable CPU writes or reads in the range $5800-$5BFF. The pin is normally driven high, and when the read or write occurs, it has a low pulse corresponding to !(M2). The intended purpose is unknown. It is theorized that it may attach a peripheral or additional RAM. When in this mode, none of the I/O configuration bits have any effect.

CL3 / SL3 Status (MMC5A: $5208 read/write)

Write
7  bit  0
---- ----
ABxx xxxx  MMC5A default power-on write value = 00xx xxxx
||
|+-------- Value to be output on MMC5.97 pin (CL3) if it is set as an I/O output in $5207.
+--------- Value to be output on MMC5.98 pin (SL3) if it is set as an I/O output in $5207.

Warning: The PCB may connect pins 97 and 98 directly to GND. Though not totally confirmed, setting them as output high while connected like this has appeared to break the output drivers of these pins. Also note that enabling the $5800 function will have these pins driving high most of the time as well.

Read
7  bit  0
---- ----
ABxx xxxx
||
|+-------- Input value of MMC5.97 pin (CL3)
+--------- Input value of MMC5.98 pin (SL3)

16-bit Hardware Timer with IRQ (MMC5A: $5209 read/write, $520A write)

Read
  • $5209
7  bit  0
---- ----
Vxxx xxxx  MMC5A default power-on read value = $00
|
+--------- Hardware Timer IRQ Flag
Write
  • $5209
7  bit  0
---- ----
TTTT TTTT  MMC5A default power-on write value = $00
|||| ||||
++++-++++- Timer count LSB
  • $520A
7  bit  0
---- ----
TTTT TTTT  MMC5A default power-on write value = $00
|||| ||||
++++-++++- Timer count MSB

Based on findings from krzysiobal: The timer automatically starts when writing any value to register $5209, if the 16-bit timer value does not equal $0000. For example, to write value $0100, you would first write $01 (MSB) to register $520A, which does not start the timer. Then write $00 (LSB) to register $5209, which at that point will start the timer from value $0100.

Each 8-bit value is written directly to an internal 16-bit counter that decrements each CPU cycle, specifically on the rising edge of M2. Additional writes while the timer is running will directly overwrite that portion of the counter. Reading register $5209 while the timer is running reports $00. The transition from counter value $0001 to $0000 generates an IRQ and sets the hardware timer IRQ flag. The timer stops at this point. Reading this register reports the IRQ flag, then automatically clears the IRQ and IRQ flag.

If the MMC5 detects a reset, it clears the timer if active, and it clears the IRQ and IRQ flag if set. Reset detection works by looking for a gap larger than about 11 usec on M2.

This register's IRQ operation is completely independent from register $5204. Disabling interrupts through $5204 has no effect on, and reading $5204 does not report on, IRQs generated these registers.

Unknown Address Range (MMC5A: $5800-$5BFF, write only)

Reads and writes in this address range are reflected on the CL3 and SL3 pins when register $5207 = $03. The purpose of this function is unknown. Minute VCC current spikes shortly after rising edge of M2 during writes in this range exhibit the same characteristics as writes in internal extended RAM range $5C00-$5FFF, suggesting possible existence of RAM in this range, though experimentally reading from this range is always met with open CPU bus.

Address $5800 is written to by Just Breed. During each V-Blank, it writes value $03, then $01 to this address, reads and writes to PPU registers, then writes value $00 to this address once complete. It is theorized that this was used as a debug signal to measure CPU usage / idle time during development.

Scanline Detection and Scanline IRQ

MMC5 'in frame' status bit state diagram

The MMC5 detects scanlines by first looking for three consecutive PPU reads from the same nametable address in the range $2xxx. Once this has been seen, the next PPU read, regardless of address, is the point at which the scanline is detected. This works because the PPU does two matching dummy nametable byte reads at the end of each scanline, followed by a third matching nametable byte read at the beginning of the next scanline, followed by an attribute table byte read. So, the scanline gets detected when the PPU does the attribute table byte read, which is at PPU cycle 4.

Once that occurs, if the "in-frame" flag (register $5204) was clear, it becomes set, and the internal 8-bit scanline counter is reset to zero; but if it was already set, the scanline counter is incremented, then compared against the value written to $5203. If they match, the "irq pending" flag is set.

The IRQ pending flag is raised when the desired scanline is reached regardless of whether or not the scanline IRQ is enabled, i.e. even after a 0 was written to the scanline IRQ enable flag. However, an actual IRQ is only sent to the CPU if both the scanline IRQ enable flag and IRQ pending flag are set. A $5203 value of $00 is a special case where the comparison is never true. The MMC5's scanline IRQ occurs at PPU cycle 4, unlike the simpler scanline counter of the MMC3, which usually generates an IRQ around PPU cycle 260. See also [4].

The "in-frame" flag is cleared when the PPU is no longer rendering. This is detected when 3 CPU cycles pass without a PPU read having occurred (PPU /RD has not been low during the last 3 M2 rises). The PPU does this in these conditions:

  • the PPU begins the post-render scanline 240
  • the PPU stops rendering because the user program wrote to CPU address $2001 with bits 3 and 4 clear.
  • note: the MMC5 may not listen directly to writes to $2001 for this behavior, or it may be monitoring for particular transitions of $2001 that have not yet been fully tested.

The "in frame" flag is cleared, scanline IRQ is automatically acknowledged, and the internal scanline counter is reset in any of these conditions:

  • the V-blank NMI occurs, i.e. CPU reads the interrupt vector from addresses $FFFA and $FFFB
  • the user program intentionally reads from CPU addresses $FFFA or $FFFB
  • the 241st scanline is detected.
  • when the MMC5 believes that $2001 bits 3 and 4 are both clear and then either one of them gets set.

The scanline IRQ is acknowledged, but the "in frame" flag is not cleared and the scanline counter is not reset in any of these conditions:

  • the user program reads register $5204
  • scanline 0 is detected

When system reset detection occurs, the only thing that happens is scanline IRQ becomes disabled. All other operation continues unaffected. These things happen any time that scanline IRQ becomes disabled:

  • if /IRQ was low due to scanline IRQ pending flag, /IRQ returns high
  • the scanline IRQ pending flag remains unaffected
  • register $5203 value remains unaffected
  • scanline counter remains unaffected
  • enabling the scanline IRQ will cause immediate /IRQ low if IRQ pending flag is set, but will not affect anything else

This means in pseudo-code: 

(On every PPU read -- PPU /RD falling edge)
if address >= $2000 and address <= $2FFF and address == lastAddress
   matchCount := matchCount +1
   if matchCount == 2
     if inFrame == false
        inFrame := true
        scanline := 0
     else
        scanline := scanline +1
        if scanline == [$5203]
           irqPending := true
else
   matchCount := 0
lastAddress := address
ppuIsReading := true

(On every CPU cycle -- M2 rising edge)
if ppuIsReading
   idleCount := 0
else
   idleCount := idleCount +1      
   if idleCount == 3
      inFrame := false
      lastAddress := undefined
ppuIsReading := false

(On every CPU write)
if address == $2001 and (value & $18) == 0
   inFrame := false
   lastAddress := undefined

(On every CPU read)
if address == $FFFA or address == $FFFB
   inFrame := false
   lastAddress := undefined

Please refer to the state diagrams on the right for a more formal description of the scanline and in-frame detection counters.

Hardware

The MMC5 exists in a 100-pin rectangular QFP package, see MMC5 pinout for details.

MMC5 cartridge PCBs can be configured to different modes, see ExROM for details.

At least two different versions of the MMC5 are known to exist: MMC5, and MMC5A. MMC5A has the addition of registers $5207, $5208, $5209, and $520A: SL3/CL3 control and hardware timer.

References

  1. ↑ krzysiobal's RE notes
  2. ↑ https://forums.nesdev.org/viewtopic.php?f=2&t=12764

External links

  • NES Mapper list by Disch [5]
  • Nintendo MMC5 by goroh, translated by Sgt. Bowhack [6]
  • Nintendo MMC5 Bankswitching by Kevin Horton [7]
Retrieved from "https://www.nesdev.org/w/index.php?title=MMC5&oldid=21737"