-- create the module's table
local snes = {}

-- import required modules
local dict = require "scripts.app.dict"
local swim = require "scripts.app.swim"

-- file constants
local RESET_VECT_HI = 0xFFFD
local RESET_VECT_LO = 0xFFFC

-- global variables so other modules can use them
snes_swimcart = nil

-- local functions

local function prgm_mode(debug)
	if debug then print("going to program mode, swim:", snes_swimcart) end
	if snes_swimcart then
		print("ERROR cart got set to swim mode somehow!!!")
--		swim.snes_v3_prgm(debug)
	else
		dict.pinport("CTL_SET_LO", "SNES_RST")
	end
end

local function play_mode(debug)
	if debug then print("going to play mode, swim:", snes_swimcart) end
	if snes_swimcart then
--		swim.snes_v3_play(debug)
		print("ERROR cart got set to swim mode somehow!!!")
	else
		dict.pinport("CTL_SET_HI", "SNES_RST")
	end
end


-- Desc:read reset vector from passed in bank
-- Pre: snes_init() been called to setup i/o
-- Post:Address left on bus memories disabled
-- Rtn: reset vector that was found
local function read_reset_vector( bank, debug )

	--ensure cart is in play mode
	play_mode()

	--first set SNES bank A16-23
	dict.snes("SNES_SET_BANK", bank)

	--read reset vector high byte
	vector = dict.snes("SNES_ROM_RD", RESET_VECT_HI)
	--shift high byte of vector to where it belongs
	vector = vector << 8
	--read low byte of vector
	vector = vector | dict.snes("SNES_ROM_RD", RESET_VECT_LO)

	if debug then print("SNES bank:", bank, "reset vector", string.format("$%x", vector) ) end

	return vector
end

-- Desc: attempt to read flash rom ID 
-- Pre: snes_init() been called to setup i/o
-- Post:Address left on bus memories disabled
-- Rtn: true if flash ID found
local function read_flashID( debug )

	local rv
	--enter software mode A11 is highest address bit that needs to be valid
	--datasheet not exactly explicit, A11 might not need to be valid
	--part has A-1 (negative 1) since it's in byte mode, meaning the part's A11 is actually A12
	--WR $AAA:AA $555:55 $AAA:AA
	dict.snes("SNES_SET_BANK", 0x00)

	--put cart in program mode
	--v3.0 boards don't use EXP0 for program mode, must use SWIM via CIC
	prgm_mode()

	dict.snes("SNES_ROM_WR", 0x0AAA, 0xAA)
	dict.snes("SNES_ROM_WR", 0x0555, 0x55)
	dict.snes("SNES_ROM_WR", 0x0AAA, 0x90)

	--exit program mode
	play_mode()

	--read manf ID
	local manf_id = dict.snes("SNES_ROM_RD", 0x0000)
	if debug then print("attempted read SNES ROM manf ID:", string.format("%X", manf_id)) end

	--read prod ID
	local prod_id = dict.snes("SNES_ROM_RD", 0x0002)
	if debug then print("attempted read SNES ROM prod ID:", string.format("%X", prod_id)) end
	local density_id = dict.snes("SNES_ROM_RD", 0x001C)
	if debug then print("attempted read SNES density ID: ", string.format("%X", density_id)) end
	local boot_sect = dict.snes("SNES_ROM_RD", 0x001E)
	if debug then print("attempted read SNES boot sect ID:", string.format("%X", boot_sect)) end

	--put cart in program mode
	prgm_mode()

	--exit software
	dict.snes("SNES_ROM_WR", 0x0000, 0xF0)

	--exit program mode
	play_mode()

	--return true if detected flash chip
	if (manf_id == 0x01 and prod_id == 0x49) then
		return true
	else 
		return false
	end

end


-- call functions desired to run when script is called/imported


-- functions other modules are able to call
snes.read_reset_vector = read_reset_vector
snes.read_flashID = read_flashID
snes.prgm_mode = prgm_mode
snes.play_mode = play_mode

-- return the module's table
return snes