RomFactory.cc

Go to the documentation of this file.

#include "RomFactory.hh"
 
#include "RomTypes.hh"
#include "RomInfo.hh"
#include "RomPageNN.hh"
#include "RomPlain.hh"
#include "RomDRAM.hh"
#include "RomGeneric8kB.hh"
#include "RomGeneric16kB.hh"
#include "RomKonami.hh"
#include "RomKonamiSCC.hh"
#include "RomKonamiKeyboardMaster.hh"
#include "RomAscii8kB.hh"
#include "RomAscii8_8.hh"
#include "RomAscii16kB.hh"
#include "RomMSXWrite.hh"
#include "RomPadial8kB.hh"
#include "RomPadial16kB.hh"
#include "RomSuperLodeRunner.hh"
#include "RomSuperSwangi.hh"
#include "RomMitsubishiMLTS2.hh"
#include "RomMSXDOS2.hh"
#include "RomAscii16_2.hh"
#include "RomRType.hh"
#include "RomCrossBlaim.hh"
#include "RomHarryFox.hh"
#include "RomPanasonic.hh"
#include "RomNational.hh"
#include "RomNeo8.hh"
#include "RomNeo16.hh"
#include "RomMajutsushi.hh"
#include "RomSynthesizer.hh"
#include "RomPlayBall.hh"
#include "RomNettouYakyuu.hh"
#include "RomGameMaster2.hh"
#include "RomHalnote.hh"
#include "RomZemina25in1.hh"
#include "RomZemina80in1.hh"
#include "RomZemina90in1.hh"
#include "RomZemina126in1.hh"
#include "RomHolyQuran.hh"
#include "RomHolyQuran2.hh"
#include "RomFSA1FM.hh"
#include "RomManbow2.hh"
#include "RomMatraInk.hh"
#include "RomMatraCompilation.hh"
#include "RomArc.hh"
#include "RomAlAlamiah30in1.hh"
#include "RomRetroHard31in1.hh"
#include "ROMHunterMk2.hh"
#include "MegaFlashRomSCCPlus.hh"
#include "ReproCartridgeV1.hh"
#include "ReproCartridgeV2.hh"
#include "KonamiUltimateCollection.hh"
#include "RomDooly.hh"
#include "RomMSXtra.hh"
#include "RomRamFile.hh"
#include "RomColecoMegaCart.hh"
#include "RomMultiRom.hh"
#include "Rom.hh"
#include "Reactor.hh"
#include "MSXMotherBoard.hh"
#include "RomDatabase.hh"
#include "DeviceConfig.hh"
#include "XMLElement.hh"
#include "MSXException.hh"
 
#include "enumerate.hh"
#include "one_of.hh"
#include "xrange.hh"
 
#include <bit>
#include <memory>
 
using std::make_unique;
 
namespace openmsx::RomFactory {
 
[[nodiscard]] static RomType guessRomType(const Rom& rom)
{
        auto size = rom.size();
        if (size == 0) {
                return ROM_NORMAL;
        }
        //std::span data = rom; // TODO error with clang-13/libc++
        std::span data{std::to_address(rom.begin()), size};
 
        if (const size_t signatureOffset = 16, signatureSize = 8; size >= (signatureOffset + signatureSize)) {
                auto signature = std::string_view(std::bit_cast<const char*>(data.data()) + signatureOffset, signatureSize);
                if (signature == std::string_view("ROM_NEO8")) return ROM_NEO8;
                if (signature == std::string_view("ROM_NE16")) return ROM_NEO16;
        }
        if (size < 0x10000) {
                if ((size <= 0x4000) &&
                           (data[0] == 'A') && (data[1] == 'B')) {
                        auto initAddr = word(data[2] + 256 * data[3]);
                        auto textAddr = word(data[8] + 256 * data[9]);
                        if ((textAddr & 0xC000) == 0x8000) {
                                if ((initAddr == 0) ||
                                    (((initAddr & 0xC000) == 0x8000) &&
                                     (data[initAddr & (size - 1)] == 0xC9))) {
                                        return ROM_PAGE2;
                                }
                        }
                }
                // not correct for Konami-DAC, but does this really need
                // to be correct for _every_ rom?
                return ROM_MIRRORED;
        } else if (size == 0x10000 && !((data[0] == 'A') && (data[1] == 'B'))) {
                // 64 kB ROMs can be plain or memory mapped...
                // check here for plain, if not, try the auto detection
                // (thanks for the hint, hap)
                return ROM_MIRRORED;
        } else {
                //  GameCartridges do their bank switching by using the Z80
                //  instruction ld(nn),a in the middle of program code. The
                //  address nn depends upon the GameCartridge mapper type used.
                //  To guess which mapper it is, we will look how much writes
                //  with this instruction to the mapper-registers-addresses
                //  occur.
 
                std::array<unsigned, ROM_LAST> typeGuess = {}; // 0-initialized
                for (auto i : xrange(size - 3)) {
                        if (data[i] == 0x32) {
                                auto value = word(data[i + 1] + (data[i + 2] << 8));
                                switch (value) {
                                case 0x5000:
                                case 0x9000:
                                case 0xb000:
                                        typeGuess[ROM_KONAMI_SCC]++;
                                        break;
                                case 0x4000:
                                case 0x8000:
                                case 0xa000:
                                        typeGuess[ROM_KONAMI]++;
                                        break;
                                case 0x6800:
                                case 0x7800:
                                        typeGuess[ROM_ASCII8]++;
                                        break;
                                case 0x6000:
                                        typeGuess[ROM_KONAMI]++;
                                        typeGuess[ROM_ASCII8]++;
                                        typeGuess[ROM_ASCII16]++;
                                        break;
                                case 0x7000:
                                        typeGuess[ROM_KONAMI_SCC]++;
                                        typeGuess[ROM_ASCII8]++;
                                        typeGuess[ROM_ASCII16]++;
                                        break;
                                case 0x77ff:
                                        typeGuess[ROM_ASCII16]++;
                                        break;
                                }
                        }
                }
                if (typeGuess[ROM_ASCII8]) typeGuess[ROM_ASCII8]--; // -1 -> max_int
                RomType type = ROM_GENERIC_8KB;
                for (auto [i, tg] : enumerate(typeGuess)) {
                        if (tg && (tg >= typeGuess[type])) {
                                type = static_cast<RomType>(i);
                        }
                }
                return type;
        }
}
 
std::unique_ptr<MSXDevice> create(const DeviceConfig& config)
{
        Rom rom(std::string(config.getAttributeValue("id")), "rom", config);
 
        // Get specified mapper type from the config.
        RomType type = [&] {
                // if no type is mentioned, we assume 'mirrored' which works for most
                // plain ROMs...
                std::string_view typeStr = config.getChildData("mappertype", "Mirrored");
                if (typeStr == "auto") {
                        // First check whether the (possibly patched) SHA1 is in the DB
                        const RomInfo* romInfo = config.getReactor().getSoftwareDatabase().fetchRomInfo(rom.getSHA1());
                        // If not found, try the original SHA1 in the DB
                        if (!romInfo) {
                                romInfo = config.getReactor().getSoftwareDatabase().fetchRomInfo(rom.getOriginalSHA1());
                        }
                        // If still not found, guess the mapper type
                        if (!romInfo) {
                                auto machineType = config.getMotherBoard().getMachineType();
                                if (machineType == "Coleco") {
                                        if (rom.size() == one_of(128*1024u, 256*1024u, 512*1024u, 1024*1024u)) {
                                                return ROM_COLECOMEGACART;
                                        } else {
                                                return ROM_PAGE23;
                                        }
                                } else {
                                        return guessRomType(rom);
                                }
                        } else {
                                return romInfo->getRomType();
                        }
                } else {
                        // Use mapper type from config, even if this overrides DB.
                        auto t = RomInfo::nameToRomType(typeStr);
                        if (t == ROM_UNKNOWN) {
                                throw MSXException("Unknown mappertype: ", typeStr);
                        }
                        return t;
                }
        }();
 
        // Store actual detected mapper type in config (override the possible
        // 'auto' value). This way we're sure that on savestate/loadstate we're
        // using the same mapper type (for example when the user's rom-database
        // was updated).
        // We do it at this point so that constructors used below can use this
        // information for warning messages etc.
        auto& doc = const_cast<DeviceConfig&>(config).getXMLDocument();
        doc.setChildData(const_cast<XMLElement&>(*config.getXML()),
                         "mappertype", RomInfo::romTypeToName(type).data());
 
        std::unique_ptr<MSXRom> result;
        switch (type) {
        case ROM_MIRRORED:
        case ROM_MIRRORED0000:
        case ROM_MIRRORED4000:
        case ROM_MIRRORED8000:
        case ROM_MIRROREDC000:
        case ROM_NORMAL:
        case ROM_NORMAL0000:
        case ROM_NORMAL4000:
        case ROM_NORMAL8000:
        case ROM_NORMALC000:
                result = make_unique<RomPlain>(config, std::move(rom), type);
                break;
        case ROM_PAGE0:
        case ROM_PAGE1:
        case ROM_PAGE01:
        case ROM_PAGE2:
        case ROM_PAGE12:
        case ROM_PAGE012:
        case ROM_PAGE3:
        case ROM_PAGE23:
        case ROM_PAGE123:
        case ROM_PAGE0123:
                result = make_unique<RomPageNN>(config, std::move(rom), type);
                break;
        case ROM_DRAM:
                result = make_unique<RomDRAM>(config, std::move(rom));
                break;
        case ROM_GENERIC_8KB:
                result = make_unique<RomGeneric8kB>(config, std::move(rom));
                break;
        case ROM_GENERIC_16KB:
                result = make_unique<RomGeneric16kB>(config, std::move(rom));
                break;
        case ROM_KONAMI_SCC:
                result = make_unique<RomKonamiSCC>(config, std::move(rom));
                break;
        case ROM_KONAMI:
                result = make_unique<RomKonami>(config, std::move(rom));
                break;
        case ROM_KBDMASTER:
                result = make_unique<RomKonamiKeyboardMaster>(config, std::move(rom));
                break;
        case ROM_ASCII8:
                result = make_unique<RomAscii8kB>(config, std::move(rom));
                break;
        case ROM_ASCII16:
                result = make_unique<RomAscii16kB>(config, std::move(rom));
                break;
        case ROM_MSXWRITE:
                result = make_unique<RomMSXWrite>(config, std::move(rom));
                break;
        case ROM_PADIAL8:
                result = make_unique<RomPadial8kB>(config, std::move(rom));
                break;
        case ROM_PADIAL16:
                result = make_unique<RomPadial16kB>(config, std::move(rom));
                break;
        case ROM_SUPERLODERUNNER:
                result = make_unique<RomSuperLodeRunner>(config, std::move(rom));
                break;
        case ROM_SUPERSWANGI:
                result = make_unique<RomSuperSwangi>(config, std::move(rom));
                break;
        case ROM_MITSUBISHIMLTS2:
                result = make_unique<RomMitsubishiMLTS2>(config, std::move(rom));
                break;
        case ROM_MSXDOS2:
                result = make_unique<RomMSXDOS2>(config, std::move(rom));
                break;
        case ROM_R_TYPE:
                result = make_unique<RomRType>(config, std::move(rom));
                break;
        case ROM_CROSS_BLAIM:
                result = make_unique<RomCrossBlaim>(config, std::move(rom));
                break;
        case ROM_HARRY_FOX:
                result = make_unique<RomHarryFox>(config, std::move(rom));
                break;
        case ROM_ASCII8_8:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::ASCII8_8);
                break;
        case ROM_ASCII8_32:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::ASCII8_32);
                break;
        case ROM_ASCII8_2:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::ASCII8_2);
                break;
        case ROM_KOEI_8:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::KOEI_8);
                break;
        case ROM_KOEI_32:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::KOEI_32);
                break;
        case ROM_WIZARDRY:
                result = make_unique<RomAscii8_8>(
                        config, std::move(rom), RomAscii8_8::SubType::WIZARDRY);
                break;
        case ROM_ASCII16_2:
                result = make_unique<RomAscii16_2>(config, std::move(rom), RomAscii16_2::SubType::ASCII16_2);
                break;
        case ROM_ASCII16_8:
                result = make_unique<RomAscii16_2>(config, std::move(rom), RomAscii16_2::SubType::ASCII16_8);
                break;
        case ROM_GAME_MASTER2:
                result = make_unique<RomGameMaster2>(config, std::move(rom));
                break;
        case ROM_PANASONIC:
                result = make_unique<RomPanasonic>(config, std::move(rom));
                break;
        case ROM_NATIONAL:
                result = make_unique<RomNational>(config, std::move(rom));
                break;
        case ROM_NEO8:
                result = make_unique<RomNeo8>(config, std::move(rom));
                break;
        case ROM_NEO16:
                result = make_unique<RomNeo16>(config, std::move(rom));
                break;
        case ROM_MAJUTSUSHI:
                result = make_unique<RomMajutsushi>(config, std::move(rom));
                break;
        case ROM_SYNTHESIZER:
                result = make_unique<RomSynthesizer>(config, std::move(rom));
                break;
        case ROM_PLAYBALL:
                result = make_unique<RomPlayBall>(config, std::move(rom));
                break;
        case ROM_NETTOU_YAKYUU:
                result = make_unique<RomNettouYakyuu>(config, std::move(rom));
                break;
        case ROM_HALNOTE:
                result = make_unique<RomHalnote>(config, std::move(rom));
                break;
        case ROM_ZEMINA25IN1:
                result = make_unique<RomZemina25in1>(config, std::move(rom));
                break;
        case ROM_ZEMINA80IN1:
                result = make_unique<RomZemina80in1>(config, std::move(rom));
                break;
        case ROM_ZEMINA90IN1:
                result = make_unique<RomZemina90in1>(config, std::move(rom));
                break;
        case ROM_ZEMINA126IN1:
                result = make_unique<RomZemina126in1>(config, std::move(rom));
                break;
        case ROM_HOLY_QURAN:
                result = make_unique<RomHolyQuran>(config, std::move(rom));
                break;
        case ROM_HOLY_QURAN2:
                result = make_unique<RomHolyQuran2>(config, std::move(rom));
                break;
        case ROM_FSA1FM1:
                result = make_unique<RomFSA1FM1>(config, std::move(rom));
                break;
        case ROM_FSA1FM2:
                result = make_unique<RomFSA1FM2>(config, std::move(rom));
                break;
        case ROM_MANBOW2:
        case ROM_MANBOW2_2:
        case ROM_HAMARAJANIGHT:
        case ROM_MEGAFLASHROMSCC:
        case ROM_RBSC_FLASH_KONAMI_SCC:
                result = make_unique<RomManbow2>(config, std::move(rom), type);
                break;
        case ROM_MATRAINK:
                result = make_unique<RomMatraInk>(config, std::move(rom));
                break;
        case ROM_MATRACOMPILATION:
                result = make_unique<RomMatraCompilation>(config, std::move(rom));
                break;
        case ROM_ARC:
                result = make_unique<RomArc>(config, std::move(rom));
                break;
        case ROM_ALALAMIAH30IN1:
                result = make_unique<RomAlAlamiah30in1>(config, std::move(rom));
                break;
        case ROM_RETROHARD31IN1:
                result = make_unique<RomRetroHard31in1>(config, std::move(rom));
                break;
        case ROM_ROMHUNTERMK2:
                result = make_unique<ROMHunterMk2>(config, std::move(rom));
                break;
        case ROM_MEGAFLASHROMSCCPLUS:
                result = make_unique<MegaFlashRomSCCPlus>(config, std::move(rom));
                break;
        case ROM_REPRO_CARTRIDGE1:
                result = make_unique<ReproCartridgeV1>(config, std::move(rom));
                break;
        case ROM_REPRO_CARTRIDGE2:
                result = make_unique<ReproCartridgeV2>(config, std::move(rom));
                break;
        case ROM_KONAMI_ULTIMATE_COLLECTION:
                result = make_unique<KonamiUltimateCollection>(config, std::move(rom));
                break;
        case ROM_DOOLY:
                result = make_unique<RomDooly>(config, std::move(rom));
                break;
        case ROM_MSXTRA:
                result = make_unique<RomMSXtra>(config, std::move(rom));
                break;
        case ROM_MULTIROM:
                result = make_unique<RomMultiRom>(config, std::move(rom));
                break;
        case ROM_RAMFILE:
                result = make_unique<RomRamFile>(config, std::move(rom));
                break;
        case ROM_COLECOMEGACART:
                result = make_unique<RomColecoMegaCart>(config, std::move(rom));
                break;
        default:
                throw MSXException("Unknown ROM type");
        }
 
        return result;
}
 
} // namespace openmsx::RomFactory