// $Id: RomPlain.cc 5076 2006-01-25 19:26:32Z m9710797 $

#include "RomPlain.hh"
#include "Rom.hh"
#include "XMLElement.hh"
#include "MSXException.hh"
#include "StringOp.hh"

namespace openmsx {

// return x inside [start, start+len)
static inline bool isInside(unsigned x, unsigned start, unsigned len)
{
	unsigned tmp = x - start;
	return tmp < len;
}

static std::string toString(unsigned start, unsigned len)
{
	return "[0x" + StringOp::toHexString(start, 4) + ", " +
	        "0x" + StringOp::toHexString(start + len, 4) + ']';
}

RomPlain::RomPlain(MSXMotherBoard& motherBoard, const XMLElement& config,
                   const EmuTime& time, std::auto_ptr<Rom> rom_,
                   MirrorType mirrored, int start)
	: Rom8kBBlocks(motherBoard, config, time, rom_)
{
	unsigned windowBase =  0x0000;
	unsigned windowSize = 0x10000;
	if (const XMLElement* mem = config.findChild("mem")) {
		windowBase = mem->getAttributeAsInt("base");
		windowSize = mem->getAttributeAsInt("size");
	}

	unsigned romSize = rom->getSize();
	if ((romSize > 0x10000) || (romSize & 0x1FFF)) {
		throw MSXException(rom->getName() +
		    ": invalid rom size: must be smaller than or equal to 64kB "
		    "and must be a multiple of 8kB.");
	}

	unsigned romBase = (start == -1)
	                 ? guessLocation(windowBase, windowSize)
	                 : start;
	if (!isInside(romBase,               windowBase, windowSize) ||
	    !isInside(romBase + romSize - 1, windowBase, windowSize)) {
		throw MSXException(rom->getName() +
		    ": invalid rom position: interval " +
		    toString(romBase, romSize) + " must fit in " +
		    toString(windowBase, windowSize) + '.');
	}
	if ((romBase & 0x1FFF)) {
		throw MSXException(rom->getName() +
		    ": invalid rom position: must start at a 8kB boundary.");
	}

	unsigned firstPage = romBase / 0x2000;
	unsigned numPages = romSize / 0x2000;
	for (unsigned page = 0; page < 8; ++page) {
		unsigned romPage = page - firstPage;
		if (romPage < numPages) {
			setRom(page, romPage);
		} else {
			if (mirrored == MIRRORED) {
				setRom(page, romPage & (numPages - 1));
			} else {
				setBank(page, unmappedRead);
			}
		}

	}
}

void RomPlain::guessHelper(unsigned offset, int* pages)
{
	if (((*rom)[offset++] == 'A') && ((*rom)[offset++] =='B')) {
		for (int i = 0; i < 4; i++) {
			word addr = (*rom)[offset + 0] +
			            (*rom)[offset + 1] * 256;
			offset += 2;
			if (addr) {
				int page = (addr >> 14) - (offset >> 14);
				if ((0 <= page) && (page <= 2)) {
					pages[page]++;
				}
			}
		}
	}
}

unsigned RomPlain::guessLocation(unsigned windowBase, unsigned windowSize)
{
	int pages[3] = { 0, 0, 0 };

	// count number of possible routine pointers
	if (rom->getSize() >= 0x0010) {
		guessHelper(0x0000, pages);
	}
	if (rom->getSize() >= 0x4010) {
		guessHelper(0x4000, pages);
	}

	// start address must be inside memory window
	if (!isInside(0x0000, windowBase, windowSize)) pages[0] = 0;
	if (!isInside(0x4000, windowBase, windowSize)) pages[1] = 0;
	if (!isInside(0x8000, windowBase, windowSize)) pages[2] = 0;

	// we prefer 0x4000, then 0x000 and then 0x8000
	if (pages[1] && (pages[1] >= pages[0]) && (pages[1] >= pages[2])) {
		return 0x4000;
	} else if (pages[0] && pages[0] >= pages[2]) {
		return 0x0000;
	} else if (pages[2]) {
		return 0x8000;
	}

	// heuristics didn't work, return start of window
	return windowBase;
}

} // namespace openmsx