namespace Heuristics { struct SuperFamicom { SuperFamicom(vector& data, string location); explicit operator bool() const; auto manifest() const -> string; auto region() const -> string; auto revision() const -> string; auto board() const -> string; auto label() const -> string; auto serial() const -> string; auto romSize() const -> uint; auto programRomSize() const -> uint; auto dataRomSize() const -> uint; auto expansionRomSize() const -> uint; auto firmwareRomSize() const -> uint; auto ramSize() const -> uint; auto expansionRamSize() const -> uint; auto nonVolatile() const -> bool; private: auto size() const -> uint { return data.size(); } auto scoreHeader(uint address) -> uint; auto firmwareARM() const -> string; auto firmwareEXNEC() const -> string; auto firmwareGB() const -> string; auto firmwareHITACHI() const -> string; auto firmwareNEC() const -> string; vector& data; string location; uint headerAddress = 0; }; SuperFamicom::SuperFamicom(vector& data, string location) : data(data), location(location) { if((size() & 0x7fff) == 512) { //remove header if present memory::move(&data[0], &data[512], size() - 512); data.resize(size() - 512); } if(size() < 0x8000) return; //ignore images too small to be valid uint LoROM = scoreHeader( 0x7fb0); uint HiROM = scoreHeader( 0xffb0); uint ExLoROM = scoreHeader(0x407fb0); uint ExHiROM = scoreHeader(0x40ffb0); if(ExLoROM) ExLoROM += 4; if(ExHiROM) ExHiROM += 4; if(LoROM >= HiROM && LoROM >= ExLoROM && LoROM >= ExHiROM) headerAddress = 0x7fb0; else if(HiROM >= ExLoROM && HiROM >= ExHiROM) headerAddress = 0xffb0; else if(ExLoROM >= ExHiROM) headerAddress = 0x407fb0; else headerAddress = 0x40ffb0; } SuperFamicom::operator bool() const { return headerAddress; } auto SuperFamicom::manifest() const -> string { if(!operator bool()) return {}; string output; output.append("game\n"); output.append(" sha256: ", Hash::SHA256(data).digest(), "\n"); output.append(" label: ", Location::prefix(location), "\n"); output.append(" name: ", Location::prefix(location), "\n"); output.append(" region: ", region(), "\n"); output.append(" revision: ", revision(), "\n"); output.append(" board: ", board(), "\n"); auto board = this->board().trimRight("#A", 1L).trimRight("#B", 1L).split("-"); if(auto size = romSize()) { if(board(0) == "SPC7110") size = 0x100000; output.append(Memory{}.type("ROM").size(size).content("Program").text()); } if(auto size = ramSize()) { output.append(Memory{}.type("RAM").size(size).content("Save").text()); } if(auto size = expansionRamSize()) { output.append(Memory{}.type("RAM").size(size).content("Save").text()); } if(0) { } else if(board(0) == "ARM") { output.append(Memory{}.type("ROM").size(0x20000).content("Program").manufacturer("SETA").architecture("ARM6").identifier(firmwareARM()).text()); output.append(Memory{}.type("ROM").size( 0x8000).content("Data" ).manufacturer("SETA").architecture("ARM6").identifier(firmwareARM()).text()); output.append(Memory{}.type("RAM").size( 0x4000).content("Data" ).manufacturer("SETA").architecture("ARM6").identifier(firmwareARM()).isVolatile().text()); output.append(Oscillator{}.frequency(21'440'000).text()); } else if(board(0) == "BS" && board(1) == "MCC") { output.append(Memory{}.type("RAM").size(0x80000).content("Download").text()); } else if(board(0) == "EXNEC") { output.append(Memory{}.type("ROM").size(0xc000).content("Program").manufacturer("NEC").architecture("uPD96050").identifier(firmwareEXNEC()).text()); output.append(Memory{}.type("ROM").size(0x1000).content("Data" ).manufacturer("NEC").architecture("uPD96050").identifier(firmwareEXNEC()).text()); output.append(Memory{}.type("RAM").size(0x1000).content("Data" ).manufacturer("NEC").architecture("uPD96050").identifier(firmwareEXNEC()).text()); output.append(Oscillator{}.frequency(firmwareEXNEC() == "ST010" ? 11'000'000 : 15'000'000).text()); } else if(board(0) == "GB") { output.append(Memory{}.type("ROM").size(0x100).content("Boot").manufacturer("Nintendo").architecture("LR35902").identifier(firmwareGB()).text()); if(firmwareGB() == "SGB2") output.append(Oscillator{}.frequency(20'971'520).text()); } else if(board(0) == "GSU") { //todo: MARIO CHIP 1 uses CPU oscillator output.append(Oscillator{}.frequency(21'440'000).text()); } else if(board(0) == "HITACHI") { output.append(Memory{}.type("ROM").size(0xc00).content("Data").manufacturer("Hitachi").architecture("HG51BS169").identifier(firmwareHITACHI()).text()); output.append(Memory{}.type("RAM").size(0xc00).content("Data").manufacturer("Hitachi").architecture("HG51BS169").identifier(firmwareHITACHI()).isVolatile().text()); output.append(Oscillator{}.frequency(20'000'000).text()); } else if(board(0) == "NEC") { output.append(Memory{}.type("ROM").size(0x1800).content("Program").manufacturer("NEC").architecture("uPD7725").identifier(firmwareNEC()).text()); output.append(Memory{}.type("ROM").size( 0x800).content("Data" ).manufacturer("NEC").architecture("uPD7725").identifier(firmwareNEC()).text()); output.append(Memory{}.type("RAM").size( 0x200).content("Data" ).manufacturer("NEC").architecture("uPD7725").identifier(firmwareNEC()).isVolatile().text()); output.append(Oscillator{}.frequency(7'600'000).text()); } else if(board(0) == "SA1") { output.append(Memory{}.type("RAM").size(0x800).content("Internal").isVolatile().text()); } else if(board(0) == "SPC7110") { output.append(Memory{}.type("ROM").size(romSize() - 0x100000).content("Data").text()); } if(board.right() == "EPSONRTC" || board.right() == "SHARPRTC") { output.append(Memory{}.type("RTC").size(0x10).content("Time").text()); } return output; } auto SuperFamicom::region() const -> string { string region; char A = data[headerAddress + 0x02]; //game type char B = data[headerAddress + 0x03]; //game code char C = data[headerAddress + 0x04]; //game code char D = data[headerAddress + 0x05]; //region code (new; sometimes ambiguous) auto E = data[headerAddress + 0x29]; //region code (old) auto valid = [](char n) { return (n >= '0' && n <= '9') || (n >= 'A' && n <= 'Z'); }; if(data[headerAddress + 0x2a] == 0x33 && valid(A) && valid(B) & valid(C) & valid(D)) { string code{A, B, C, D}; if(D == 'B') region = {"SNS-", code, "-BRA"}; if(D == 'C') region = {"SNSN-", code, "-ROC"}; if(D == 'D') region = {"SNSP-", code, "-NOE"}; if(D == 'E') region = {"SNS-", code, "-USA"}; if(D == 'F') region = {"SNSP-", code, "-FRA"}; if(D == 'H') region = {"SNSP-", code, "-HOL"}; if(D == 'I') region = {"SNSP-", code, "-ITA"}; if(D == 'J') region = {"SHVC-", code, "-JPN"}; if(D == 'K') region = {"SNSN-", code, "-KOR"}; if(D == 'N') region = {"SNS-", code, "-CAN"}; if(D == 'P') region = {"SNSP-", code, "-EUR"}; if(D == 'S') region = {"SNSP-", code, "-ESP"}; if(D == 'U') region = {"SNSP-", code, "-AUS"}; if(D == 'W') region = {"SNSP-", code, "-SCN"}; } if(!region) { if(E == 0x00) region = {"JPN"}; if(E == 0x01) region = {"USA"}; if(E == 0x02) region = {"EUR"}; if(E == 0x03) region = {"SCN"}; if(E == 0x06) region = {"FRA"}; if(E == 0x07) region = {"HOL"}; if(E == 0x08) region = {"ESP"}; if(E == 0x09) region = {"NOE"}; if(E == 0x0a) region = {"ITA"}; if(E == 0x0b) region = {"ROC"}; if(E == 0x0d) region = {"KOR"}; if(E == 0x0f) region = {"CAN"}; if(E == 0x10) region = {"BRA"}; if(E == 0x11) region = {"AUS"}; } return region ? region : "NTSC"; } auto SuperFamicom::revision() const -> string { string revision; char A = data[headerAddress + 0x02]; //game type char B = data[headerAddress + 0x03]; //game code char C = data[headerAddress + 0x04]; //game code char D = data[headerAddress + 0x05]; //region code (new; sometimes ambiguous) auto E = data[headerAddress + 0x29]; //region code (old) uint F = data[headerAddress + 0x2b]; //revision code auto valid = [](char n) { return (n >= '0' && n <= '9') || (n >= 'A' && n <= 'Z'); }; if(data[headerAddress + 0x2a] == 0x33 && valid(A) && valid(B) & valid(C) & valid(D)) { string code{A, B, C, D}; if(D == 'B') revision = {"SNS-", code, "-", F}; if(D == 'C') revision = {"SNSN-", code, "-", F}; if(D == 'D') revision = {"SNSP-", code, "-", F}; if(D == 'E') revision = {"SNS-", code, "-", F}; if(D == 'F') revision = {"SNSP-", code, "-", F}; if(D == 'H') revision = {"SNSP-", code, "-", F}; if(D == 'I') revision = {"SNSP-", code, "-", F}; if(D == 'J') revision = {"SHVC-", code, "-", F}; if(D == 'K') revision = {"SNSN-", code, "-", F}; if(D == 'N') revision = {"SNS-", code, "-", F}; if(D == 'P') revision = {"SNSP-", code, "-", F}; if(D == 'S') revision = {"SNSP-", code, "-", F}; if(D == 'U') revision = {"SNSP-", code, "-", F}; if(D == 'W') revision = {"SNSP-", code, "-", F}; } if(!revision) { revision = {"1.", F}; } return revision ? revision : string{"1.", F}; } //format: [slot]-[coprocessor]-[mapper]-[ram]-[rtc] auto SuperFamicom::board() const -> string { string board; auto mapMode = data[headerAddress + 0x25]; auto cartridgeTypeLo = data[headerAddress + 0x26] & 15; auto cartridgeTypeHi = data[headerAddress + 0x26] >> 4; auto cartridgeSubType = data[headerAddress + 0x0f]; string mode; if(mapMode == 0x20 || mapMode == 0x30) mode = "LOROM-"; if(mapMode == 0x21 || mapMode == 0x31) mode = "HIROM-"; if(mapMode == 0x22 || mapMode == 0x32) mode = "SDD1-"; if(mapMode == 0x23 || mapMode == 0x33) mode = "SA1-"; if(mapMode == 0x25 || mapMode == 0x35) mode = "EXHIROM-"; if(mapMode == 0x2a || mapMode == 0x3a) mode = "SPC7110-"; //many games will store an extra title character, overwriting the map mode //further, ExLoROM mode is unofficial, and lacks a mapping mode value if(!mode) { if(headerAddress == 0x7fb0) mode = "LOROM-"; if(headerAddress == 0xffb0) mode = "HIROM-"; if(headerAddress == 0x407fb0) mode = "EXLOROM-"; if(headerAddress == 0x40ffb0) mode = "EXHIROM-"; } bool epsonRTC = false; bool sharpRTC = false; if(serial() == "A9PJ") { //Sufami Turbo (JPN) board.append("ST-", mode); } else if(serial() == "ZSBJ") { //BS-X: Sore wa Namae o Nusumareta Machi no Monogatari (JPN) board.append("BS-MCC-"); } else if(serial() == "042J") { //Super Game Boy 2 board.append("GB-", mode); } else if(serial().match("Z??J")) { board.append("BS-", mode); } else if(cartridgeTypeLo >= 0x3) { if(cartridgeTypeHi == 0x0) board.append("NEC-", mode); if(cartridgeTypeHi == 0x1) board.append("GSU-"); if(cartridgeTypeHi == 0x2) board.append("OBC1-", mode); if(cartridgeTypeHi == 0x3) board.append("SA1-"); if(cartridgeTypeHi == 0x4) board.append("SDD1-"); if(cartridgeTypeHi == 0x5) board.append(mode), sharpRTC = true; if(cartridgeTypeHi == 0xe && cartridgeTypeLo == 0x3) board.append("GB-", mode); if(cartridgeTypeHi == 0xf && cartridgeTypeLo == 0x5 && cartridgeSubType == 0x00) board.append("SPC7110-"); if(cartridgeTypeHi == 0xf && cartridgeTypeLo == 0x9 && cartridgeSubType == 0x00) board.append("SPC7110-"), epsonRTC = true; if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x01) board.append("EXNEC-", mode); if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x02) board.append("ARM-", mode); if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x10) board.append("HITACHI-", mode); } if(!board) board.append(mode); if(cartridgeTypeLo == 0x1 || cartridgeTypeLo == 0x4) board.append("RAM-"); //RAM without battery if(cartridgeTypeLo == 0x2 || cartridgeTypeLo == 0x5) board.append("RAM-"); //RAM with battery if(cartridgeTypeLo == 0x6); //battery without RAM if(epsonRTC) board.append("EPSONRTC-"); if(sharpRTC) board.append("SHARPRTC-"); board.trimRight("-", 1L); if(board.beginsWith( "LOROM-RAM")) board.append(romSize() <= 0x200000 ? "#A" : "#B"); if(board.beginsWith("NEC-LOROM-RAM")) board.append(romSize() <= 0x100000 ? "#A" : "#B"); return board; } auto SuperFamicom::label() const -> string { string label; for(uint n = 0; n < 0x15; n++) { auto x = data[headerAddress + 0x10 + n]; auto y = n == 0x14 ? 0 : data[headerAddress + 0x11 + n]; //null terminator (padding) if(x == 0x00 || x == 0xff); //ASCII else if(x >= 0x20 && x <= 0x7e) label.append((char)x); //Shift-JIS (half-width katakana) else if(x == 0xa1) label.append("。"); else if(x == 0xa2) label.append("「"); else if(x == 0xa3) label.append("」"); else if(x == 0xa4) label.append("、"); else if(x == 0xa5) label.append("・"); else if(x == 0xa6) label.append("ヲ"); else if(x == 0xa7) label.append("ァ"); else if(x == 0xa8) label.append("ィ"); else if(x == 0xa9) label.append("ゥ"); else if(x == 0xaa) label.append("ェ"); else if(x == 0xab) label.append("ォ"); else if(x == 0xac) label.append("ャ"); else if(x == 0xad) label.append("ュ"); else if(x == 0xae) label.append("ョ"); else if(x == 0xaf) label.append("ッ"); else if(x == 0xb0) label.append("ー"); else if(x == 0xb1) label.append( "ア"); else if(x == 0xb2) label.append( "イ"); else if(x == 0xb3) label.append(y == 0xde ? "ヴ" : "ウ"); else if(x == 0xb4) label.append( "エ"); else if(x == 0xb5) label.append( "オ"); else if(x == 0xb6) label.append(y == 0xde ? "ガ" : "カ"); else if(x == 0xb7) label.append(y == 0xde ? "ギ" : "キ"); else if(x == 0xb8) label.append(y == 0xde ? "グ" : "ク"); else if(x == 0xb9) label.append(y == 0xde ? "ゲ" : "ケ"); else if(x == 0xba) label.append(y == 0xde ? "ゴ" : "コ"); else if(x == 0xbb) label.append(y == 0xde ? "ザ" : "サ"); else if(x == 0xbc) label.append(y == 0xde ? "ジ" : "シ"); else if(x == 0xbd) label.append(y == 0xde ? "ズ" : "ス"); else if(x == 0xbe) label.append(y == 0xde ? "ゼ" : "セ"); else if(x == 0xbf) label.append(y == 0xde ? "ゾ" : "ソ"); else if(x == 0xc0) label.append(y == 0xde ? "ダ" : "タ"); else if(x == 0xc1) label.append(y == 0xde ? "ヂ" : "チ"); else if(x == 0xc2) label.append(y == 0xde ? "ヅ" : "ツ"); else if(x == 0xc3) label.append(y == 0xde ? "デ" : "テ"); else if(x == 0xc4) label.append(y == 0xde ? "ド" : "ト"); else if(x == 0xc5) label.append("ナ"); else if(x == 0xc6) label.append("ニ"); else if(x == 0xc7) label.append("ヌ"); else if(x == 0xc8) label.append("ネ"); else if(x == 0xc9) label.append("ノ"); else if(x == 0xca) label.append(y == 0xdf ? "パ" : y == 0xde ? "バ" : "ハ"); else if(x == 0xcb) label.append(y == 0xdf ? "ピ" : y == 0xde ? "ビ" : "ヒ"); else if(x == 0xcc) label.append(y == 0xdf ? "プ" : y == 0xde ? "ブ" : "フ"); else if(x == 0xcd) label.append(y == 0xdf ? "ペ" : y == 0xde ? "ベ" : "ヘ"); else if(x == 0xce) label.append(y == 0xdf ? "ポ" : y == 0xde ? "ボ" : "ホ"); else if(x == 0xcf) label.append("マ"); else if(x == 0xd0) label.append("ミ"); else if(x == 0xd1) label.append("ム"); else if(x == 0xd2) label.append("メ"); else if(x == 0xd3) label.append("モ"); else if(x == 0xd4) label.append("ヤ"); else if(x == 0xd5) label.append("ユ"); else if(x == 0xd6) label.append("ヨ"); else if(x == 0xd7) label.append("ラ"); else if(x == 0xd8) label.append("リ"); else if(x == 0xd9) label.append("ル"); else if(x == 0xda) label.append("レ"); else if(x == 0xdb) label.append("ロ"); else if(x == 0xdc) label.append("ワ"); else if(x == 0xdd) label.append("ン"); else if(x == 0xde) label.append("\xef\xbe\x9e"); //dakuten else if(x == 0xdf) label.append("\xef\xbe\x9f"); //handakuten //unknown else label.append("?"); //(han)dakuten skip if(y == 0xde && x == 0xb3) n++; if(y == 0xde && x >= 0xb6 && x <= 0xc4) n++; if(y == 0xde && x >= 0xca && x <= 0xce) n++; if(y == 0xdf && x >= 0xca && y <= 0xce) n++; } return label.strip(); } auto SuperFamicom::serial() const -> string { char A = data[headerAddress + 0x02]; //game type char B = data[headerAddress + 0x03]; //game code char C = data[headerAddress + 0x04]; //game code char D = data[headerAddress + 0x05]; //region code (new; sometimes ambiguous) auto valid = [](char n) { return (n >= '0' && n <= '9') || (n >= 'A' && n <= 'Z'); }; if(data[headerAddress + 0x2a] == 0x33 && valid(A) && valid(B) & valid(C) & valid(D)) { return {A, B, C, D}; } return ""; } auto SuperFamicom::romSize() const -> uint { //subtract appended firmware size, if firmware is present if((size() & 0x7fff) == 0x100) return size() - 0x100; if((size() & 0x7fff) == 0xc00) return size() - 0xc00; if((size() & 0x7fff) == 0x2000) return size() - 0x2000; if((size() & 0xffff) == 0xd000) return size() - 0xd000; if((size() & 0x3ffff) == 0x28000) return size() - 0x28000; return size(); } auto SuperFamicom::programRomSize() const -> uint { if(board().beginsWith("SPC7110-")) return 0x100000; return romSize(); } auto SuperFamicom::dataRomSize() const -> uint { if(board().beginsWith("SPC7110-")) return romSize() - 0x100000; return 0; } auto SuperFamicom::expansionRomSize() const -> uint { return 0; } auto SuperFamicom::firmwareRomSize() const -> uint { return size() - romSize(); } auto SuperFamicom::ramSize() const -> uint { auto ramSize = data[headerAddress + 0x28] & 7; if(ramSize) return 1024 << ramSize; return 0; } auto SuperFamicom::expansionRamSize() const -> uint { if(data[headerAddress + 0x2a] != 0x33) return 0; auto ramSize = data[headerAddress + 0x0d] & 7; if(ramSize) return 1024 << ramSize; return 0; } auto SuperFamicom::nonVolatile() const -> bool { auto cartridgeTypeLo = data[headerAddress + 0x26] & 15; return cartridgeTypeLo == 0x2 || cartridgeTypeLo == 0x5 || cartridgeTypeLo == 0x6; } auto SuperFamicom::scoreHeader(uint address) -> uint { int score = 0; if(size() < address + 0x50) return score; uint8_t mapMode = data[address + 0x25] & ~0x10; //ignore FastROM bit uint16_t complement = data[address + 0x2c] << 0 | data[address + 0x2d] << 8; uint16_t checksum = data[address + 0x2e] << 0 | data[address + 0x2f] << 8; uint16_t resetVector = data[address + 0x4c] << 0 | data[address + 0x4d] << 8; if(resetVector < 0x8000) return score; //$00:0000-7fff is never ROM data uint8_t opcode = data[(address & ~0x7fff) | (resetVector & 0x7fff)]; //first instruction executed //most likely opcodes if(opcode == 0x78 //sei || opcode == 0x18 //clc (clc; xce) || opcode == 0x38 //sec (sec; xce) || opcode == 0x9c //stz $nnnn (stz $4200) || opcode == 0x4c //jmp $nnnn || opcode == 0x5c //jml $nnnnnn ) score += 8; //plausible opcodes if(opcode == 0xc2 //rep #$nn || opcode == 0xe2 //sep #$nn || opcode == 0xad //lda $nnnn || opcode == 0xae //ldx $nnnn || opcode == 0xac //ldy $nnnn || opcode == 0xaf //lda $nnnnnn || opcode == 0xa9 //lda #$nn || opcode == 0xa2 //ldx #$nn || opcode == 0xa0 //ldy #$nn || opcode == 0x20 //jsr $nnnn || opcode == 0x22 //jsl $nnnnnn ) score += 4; //implausible opcodes if(opcode == 0x40 //rti || opcode == 0x60 //rts || opcode == 0x6b //rtl || opcode == 0xcd //cmp $nnnn || opcode == 0xec //cpx $nnnn || opcode == 0xcc //cpy $nnnn ) score -= 4; //least likely opcodes if(opcode == 0x00 //brk #$nn || opcode == 0x02 //cop #$nn || opcode == 0xdb //stp || opcode == 0x42 //wdm || opcode == 0xff //sbc $nnnnnn,x ) score -= 8; if(checksum + complement == 0xffff) score += 4; if(address == 0x7fb0 && mapMode == 0x20) score += 2; if(address == 0xffb0 && mapMode == 0x21) score += 2; return max(0, score); } auto SuperFamicom::firmwareARM() const -> string { return "ST018"; } auto SuperFamicom::firmwareEXNEC() const -> string { if(label() == "EXHAUST HEAT2") return "ST010"; if(label() == "F1 ROC II") return "ST010"; if(label() == "2DAN MORITA SHOUGI") return "ST011"; return "ST010"; } auto SuperFamicom::firmwareGB() const -> string { if(label() == "Super GAMEBOY") return "SGB1"; if(label() == "Super GAMEBOY2") return "SGB2"; return "SGB1"; } auto SuperFamicom::firmwareHITACHI() const -> string { return "Cx4"; } auto SuperFamicom::firmwareNEC() const -> string { if(label() == "PILOTWINGS") return "DSP1"; if(label() == "DUNGEON MASTER") return "DSP2"; if(label() == "SDガンダムGX") return "DSP3"; if(label() == "PLANETS CHAMP TG3000") return "DSP4"; if(label() == "TOP GEAR 3000") return "DSP4"; return "DSP1B"; } }