Adding support for dumping MMC5 roms, wram reading/writting probably
works, but is untested. (I don't own a MMC5 cart with PRG-RAM) Tested with Laser Invasion for NES (128KB PRG & CHR ROMs)
This commit is contained in:
Paul XPS
parent
9b9d4aaa2b
commit
64ebb49617
Binary file not shown.
|
|
@ -0,0 +1,325 @@
|
|||
|
||||
-- create the module's table
|
||||
local mmc5 = {}
|
||||
|
||||
-- import required modules
|
||||
local dict = require "scripts.app.dict"
|
||||
local nes = require "scripts.app.nes"
|
||||
local dump = require "scripts.app.dump"
|
||||
local flash = require "scripts.app.flash"
|
||||
|
||||
-- file constants
|
||||
local mapname = "MMC5"
|
||||
|
||||
-- local functions
|
||||
|
||||
--disables WRAM, selects Vertical mirroring
|
||||
local function init_mapper( debug )
|
||||
|
||||
|
||||
--for save data safety start by disabling WRAM writes
|
||||
dict.nes("NES_CPU_WR", 0x5102, 0x01) --bits 1&0 must be '01' (ie 0x02) to allow writes to WRAM
|
||||
dict.nes("NES_CPU_WR", 0x5103, 0x02) --bits 1&0 must be '10' (ie 0x01) to allow writes to WRAM
|
||||
|
||||
--set mirroring
|
||||
dict.nes("NES_CPU_WR", 0x5105, 0x44) --vertical mirroring
|
||||
|
||||
--PRG MODE
|
||||
-- dict.nes("NES_CPU_WR", 0x5100, 0x00) --single 32KByte bank (couldn't get this to work..)
|
||||
dict.nes("NES_CPU_WR", 0x5100, 0x03) --4x 8KB banks
|
||||
|
||||
--CHR MODE
|
||||
dict.nes("NES_CPU_WR", 0x5101, 0x00) --single 8KByte bank
|
||||
|
||||
--PRG-RAM bank
|
||||
dict.nes("NES_CPU_WR", 0x5113, 0x00) --PRG-RAM bank @ $6000-7FFF (mode0)
|
||||
|
||||
--PRG-ROM bank
|
||||
-- dict.nes("NES_CPU_WR", 0x5117, 0x00) --PRG-ROM bank @ $8000-FFFF (mode0) bits 1&0 don't matter (CPU A14/13)
|
||||
dict.nes("NES_CPU_WR", 0x5114, 0x80) --PRG-ROM bank @ $8000-9FFF (mode3) bit7 must be set to see ROM
|
||||
dict.nes("NES_CPU_WR", 0x5115, 0x81) --PRG-ROM bank @ $A000-BFFF (mode3) bit7 must be set to see ROM
|
||||
dict.nes("NES_CPU_WR", 0x5116, 0x82) --PRG-ROM bank @ $C000-DFFF (mode3) bit7 must be set to see ROM
|
||||
dict.nes("NES_CPU_WR", 0x5117, 0x83) --PRG-ROM bank @ $E000-FFFF (mode3) bit7 must be set to see ROM
|
||||
|
||||
--CHR-ROM bank
|
||||
dict.nes("NES_CPU_WR", 0x5127, 0x00) --CHR-ROM bank @ $0000-1FFF (mode0)
|
||||
dict.nes("NES_CPU_WR", 0x512B, 0x00) --CHR-ROM bank @ $0000-1FFF (mode0 8x16 sprites)
|
||||
|
||||
--CHR-ROM upper bank
|
||||
--TODO
|
||||
--dict.nes("NES_CPU_WR", 0x5130, 0x00)
|
||||
|
||||
end
|
||||
|
||||
|
||||
--test the mapper's mirroring modes to verify working properly
|
||||
--can be used to help identify board: returns true if pass, false if failed
|
||||
local function mirror_test( debug )
|
||||
|
||||
--put mapper in known state (mirror bits cleared)
|
||||
init_mapper()
|
||||
|
||||
--$5015 = 0x44: Vertical
|
||||
dict.nes("NES_CPU_WR", 0x5105, 0x44)
|
||||
if (nes.detect_mapper_mirroring(true) ~= "VERT") then
|
||||
print(mapname, " vert mirror test fail")
|
||||
return false
|
||||
end
|
||||
|
||||
--$5015 = 0x50: Horizontal
|
||||
dict.nes("NES_CPU_WR", 0x5105, 0x50)
|
||||
if (nes.detect_mapper_mirroring(true) ~= "HORZ") then
|
||||
print(mapname, " horz mirror test fail")
|
||||
return false
|
||||
end
|
||||
|
||||
--$5015 = 0x00: single screen 0
|
||||
dict.nes("NES_CPU_WR", 0x5105, 0x00)
|
||||
if (nes.detect_mapper_mirroring() ~= "1SCNA") then
|
||||
print("MMC1 mirror test fail (1 screen A)")
|
||||
return false
|
||||
end
|
||||
|
||||
--$5015 = 0x55: single screen 1
|
||||
dict.nes("NES_CPU_WR", 0x5105, 0x55)
|
||||
if (nes.detect_mapper_mirroring() ~= "1SCNB") then
|
||||
print("MMC1 mirror test fail (1 screen B)")
|
||||
return false
|
||||
end
|
||||
|
||||
--TODO fancy MMC5 other mirroring options (EXRAM etc)
|
||||
|
||||
--passed all tests
|
||||
if(debug) then print(mapname, " mirror test passed") end
|
||||
return true
|
||||
end
|
||||
|
||||
|
||||
--dump the PRG ROM
|
||||
local function dump_prgrom( file, rom_size_KB, debug )
|
||||
|
||||
--PRG-ROM dump 32KB at a time through $5117 in mode 0
|
||||
--local KB_per_read = 32
|
||||
--above didn't work, dump 8KB at at time through $5114 in mode 3
|
||||
local KB_per_read = 8
|
||||
local num_reads = rom_size_KB / KB_per_read
|
||||
local read_count = 0
|
||||
local addr_base = 0x80 -- $8000 PAGE
|
||||
|
||||
while ( read_count < num_reads ) do
|
||||
|
||||
if debug then print( "dump PRG part ", read_count, " of ", num_reads) end
|
||||
|
||||
--select desired bank(s) to dump
|
||||
--dict.nes("NES_CPU_WR", 0x5117, ((read_count<<2)|0x80)) --32KB & CPU $8000 (bits0&1 don't matter)
|
||||
--above didn't work, only saw the last 8KB repeated...
|
||||
dict.nes("NES_CPU_WR", 0x5114, (read_count|0x80)) --8KB & CPU $8000 (bit7 must be set to see ROM)
|
||||
|
||||
--dump bank's worth of data
|
||||
dump.dumptofile( file, KB_per_read, addr_base, "NESCPU_PAGE", false )
|
||||
|
||||
read_count = read_count + 1
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
--dump the CHR ROM
|
||||
local function dump_chrrom( file, rom_size_KB, debug )
|
||||
|
||||
local KB_per_read = 8 --dump 8KB at a time
|
||||
local num_reads = rom_size_KB / KB_per_read
|
||||
local read_count = 0
|
||||
local addr_base = 0x00 -- $0000
|
||||
|
||||
while ( read_count < num_reads ) do
|
||||
|
||||
if debug then print( "dump CHR part ", read_count, " of ", num_reads) end
|
||||
|
||||
--CHR-ROM bank
|
||||
dict.nes("NES_CPU_WR", 0x5127, read_count) --CHR-ROM bank @ $0000-1FFF (mode0)
|
||||
dict.nes("NES_CPU_WR", 0x512B, read_count) --CHR-ROM bank @ $0000-1FFF (mode0 8x16 sprites)
|
||||
|
||||
dump.dumptofile( file, KB_per_read, addr_base, "NESPPU_PAGE", false )
|
||||
|
||||
read_count = read_count + 1
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
--dump the WRAM, assumes the WRAM was enabled/disabled as desired prior to calling
|
||||
local function dump_wram( file, rom_size_KB, debug )
|
||||
|
||||
local KB_per_read = 8
|
||||
local num_reads = rom_size_KB / KB_per_read
|
||||
local read_count = 0
|
||||
local addr_base = 0x60 -- $6000
|
||||
|
||||
while ( read_count < num_reads ) do
|
||||
|
||||
if debug then print( "dump WRAM part ", read_count, " of ", num_reads) end
|
||||
|
||||
dump.dumptofile( file, KB_per_read, addr_base, "NESCPU_PAGE", false )
|
||||
|
||||
read_count = read_count + 1
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
--Cart should be in reset state upon calling this function
|
||||
--this function processes all user requests for this specific board/mapper
|
||||
local function process(process_opts, console_opts)
|
||||
local test = process_opts["test"]
|
||||
local read = process_opts["read"]
|
||||
local erase = process_opts["erase"]
|
||||
local program = process_opts["program"]
|
||||
local verify = process_opts["verify"]
|
||||
local dumpfile = process_opts["dump_filename"]
|
||||
local flashfile = process_opts["flash_filename"]
|
||||
local verifyfile = process_opts["verify_filename"]
|
||||
local dumpram = process_opts["dumpram"]
|
||||
local ramdumpfile = process_opts["dumpram_filename"]
|
||||
local writeram = process_opts["writeram"]
|
||||
local ramwritefile = process_opts["writeram_filename"]
|
||||
|
||||
local rv = nil
|
||||
local file
|
||||
local prg_size = console_opts["prg_rom_size_kb"]
|
||||
local chr_size = console_opts["chr_rom_size_kb"]
|
||||
local wram_size = console_opts["wram_size_kb"]
|
||||
|
||||
--initialize device i/o for NES
|
||||
dict.io("IO_RESET")
|
||||
dict.io("NES_INIT")
|
||||
|
||||
--test cart by reading manf/prod ID
|
||||
if test then
|
||||
print("Testing ", mapname)
|
||||
|
||||
--verify mirroring is behaving as expected
|
||||
mirror_test(true)
|
||||
|
||||
nes.ppu_ram_sense(0x1000, true)
|
||||
print("EXP0 pull-up test:", dict.io("EXP0_PULLUP_TEST"))
|
||||
|
||||
--attempt to read PRG-ROM flash ID
|
||||
-- prgrom_manf_id(true)
|
||||
-- --attempt to read CHR-ROM flash ID
|
||||
-- chrrom_manf_id(true)
|
||||
end
|
||||
|
||||
--dump the ram to file
|
||||
if dumpram then
|
||||
print("\nDumping WRAM...")
|
||||
|
||||
init_mapper()
|
||||
|
||||
file = assert(io.open(ramdumpfile, "wb"))
|
||||
|
||||
--dump cart into file
|
||||
dump_wram(file, wram_size, false)
|
||||
|
||||
--close file
|
||||
assert(file:close())
|
||||
|
||||
print("DONE Dumping WRAM")
|
||||
end
|
||||
|
||||
|
||||
|
||||
--dump the cart to dumpfile
|
||||
if read then
|
||||
print("\nDumping PRG & CHR ROMs...")
|
||||
|
||||
init_mapper()
|
||||
|
||||
file = assert(io.open(dumpfile, "wb"))
|
||||
|
||||
--dump cart into file
|
||||
dump_prgrom(file, prg_size, false)
|
||||
dump_chrrom(file, chr_size, false)
|
||||
|
||||
--close file
|
||||
assert(file:close())
|
||||
|
||||
print("DONE Dumping PRG & CHR ROMs")
|
||||
end
|
||||
|
||||
|
||||
--erase the cart
|
||||
if erase then
|
||||
|
||||
print("\nerasing ", mapname, "not supported")
|
||||
|
||||
|
||||
end
|
||||
|
||||
--write to wram on the cart
|
||||
if writeram then
|
||||
|
||||
print("\nWritting to WRAM...")
|
||||
|
||||
init_mapper()
|
||||
|
||||
--disable write protection, and enable WRAM
|
||||
--for save data safety start by disabling WRAM writes
|
||||
dict.nes("NES_CPU_WR", 0x5102, 0x02) --bits 1&0 must be '01' (ie 0x02) to allow writes to WRAM
|
||||
dict.nes("NES_CPU_WR", 0x5103, 0x01) --bits 1&0 must be '10' (ie 0x01) to allow writes to WRAM
|
||||
|
||||
file = assert(io.open(ramwritefile, "rb"))
|
||||
|
||||
flash.write_file( file, wram_size, "NOVAR", "PRGRAM", false )
|
||||
|
||||
--for save data safety disable WRAM writes
|
||||
dict.nes("NES_CPU_WR", 0x5102, 0x01) --bits 1&0 must be '01' (ie 0x02) to allow writes to WRAM
|
||||
dict.nes("NES_CPU_WR", 0x5103, 0x02) --bits 1&0 must be '10' (ie 0x01) to allow writes to WRAM
|
||||
|
||||
--close file
|
||||
assert(file:close())
|
||||
|
||||
print("DONE Writting WRAM")
|
||||
end
|
||||
|
||||
--program flashfile to the cart
|
||||
if program then
|
||||
|
||||
print("\nflashing ", mapname, "not supported")
|
||||
|
||||
end
|
||||
|
||||
--verify flashfile is on the cart
|
||||
if verify then
|
||||
--for now let's just dump the file and verify manually
|
||||
print("\nPost dumping PRG & CHR ROMs...")
|
||||
|
||||
init_mapper()
|
||||
|
||||
file = assert(io.open(verifyfile, "wb"))
|
||||
|
||||
--dump cart into file
|
||||
dump_prgrom(file, prg_size, false)
|
||||
dump_chrrom(file, chr_size, false)
|
||||
|
||||
--close file
|
||||
assert(file:close())
|
||||
|
||||
print("DONE post dumping PRG & CHR ROMs")
|
||||
end
|
||||
|
||||
dict.io("IO_RESET")
|
||||
end
|
||||
|
||||
|
||||
-- global variables so other modules can use them
|
||||
|
||||
|
||||
-- call functions desired to run when script is called/imported
|
||||
|
||||
|
||||
-- functions other modules are able to call
|
||||
mmc5.process = process
|
||||
|
||||
-- return the module's table
|
||||
return mmc5
|
||||
Loading…
Reference in New Issue