bsnes/icarus/heuristics/super-famicom.cpp

374 lines
14 KiB
C++
Raw Normal View History

namespace Heuristics {
struct SuperFamicom {
SuperFamicom(const uint8_t* data, uint size, bool hasMSU1 = false);
explicit operator bool() const;
auto manifest() const -> string;
auto memory(string type, uint size, string name) const -> string;
auto sha256() const -> string;
auto region() const -> string;
auto revision() const -> string;
auto board() const -> string;
auto label() const -> string;
auto serial() const -> string;
auto ramSize() const -> uint;
auto expansionRamSize() const -> uint;
private:
auto scoreHeader(uint address) -> uint;
const uint8_t* data = nullptr;
uint size = 0;
uint headerAddress = 0;
bool hasMSU1 = false;
2015-08-21 11:29:53 +00:00
};
SuperFamicom::SuperFamicom(const uint8_t* data, uint size, bool hasMSU1) : data(data), size(size), hasMSU1(hasMSU1) {
if((size & 0x7fff) == 512) data += 512, size -= 512; //skip copier header (if present)
if(size < 0x8000) return; //ignore images too small to be valid
2015-08-21 11:29:53 +00:00
uint scoreLo = scoreHeader( 0x7fb0);
uint scoreHi = scoreHeader( 0xffb0);
uint scoreEx = scoreHeader(0x40ffb0);
if(scoreEx) scoreEx += 4;
if(scoreLo >= scoreHi && scoreLo >= scoreEx) headerAddress = 0x7fb0;
else if(scoreHi >= scoreEx) headerAddress = 0xffb0;
else headerAddress = 0x40ffb0;
2015-08-21 11:29:53 +00:00
}
SuperFamicom::operator bool() const {
return headerAddress;
}
2015-08-21 11:29:53 +00:00
auto SuperFamicom::manifest() const -> string {
if(!operator bool()) return "error\n";
string output;
output.append("game\n");
output.append(" sha256: ", sha256(), "\n");
output.append(" region: ", region(), "\n");
output.append(" revision: ", revision(), "\n");
output.append(" board: ", board(), "\n");
output.append(" label: ", label(), "\n");
auto board = this->board();
if(board.beginsWith("CX4-")) {
output.append(memory("ROM", size - 0xc00, "program.rom"));
output.append(memory("ROM", 0xc00, "cx4.data.rom"));
} else if(board.beginsWith("DSP-")) {
output.append(memory("ROM", size - 0x2000, "program.rom"));
output.append(memory("ROM", 0x1800, "dsp.program.rom"));
output.append(memory("ROM", 0x800, "dsp.data.rom"));
} else if(board.beginsWith("SETA-")) {
output.append(memory("ROM", size - 0x28000, "program.rom"));
output.append(memory("ROM", 0x20000, "seta.program.rom"));
output.append(memory("ROM", 0x8000, "seta.data.rom"));
} else if(board.beginsWith("SGB-")) {
output.append(memory("ROM", size - 0x100, "program.rom"));
output.append(memory("ROM", 0x100, "sgb.boot.rom"));
} else if(board.beginsWith("SPC7110-")) {
output.append(memory("ROM", 0x100000, "program.rom"));
output.append(memory("ROM", size - 0x100000, "data.rom"));
} else if(board.beginsWith("ST-")) {
output.append(memory("ROM", size - 0xd000, "program.rom"));
output.append(memory("ROM", 0xc000, "st.program.rom"));
output.append(memory("ROM", 0x1000, "st.data.rom"));
2015-08-21 11:29:53 +00:00
} else {
output.append(memory("ROM", size, "program.rom"));
2015-08-21 11:29:53 +00:00
}
if(auto size = ramSize()) {
auto type = board.endsWith("-NVRAM") ? "NVRAM" : "RAM";
output.append(memory(type, size, "save.ram"));
2015-08-21 11:29:53 +00:00
}
if(auto size = expansionRamSize()) {
auto type = board.endsWith("-NVRAM") ? "NVRAM" : "RAM";
output.append(memory(type, size, "expansion.ram"));
2015-08-21 11:29:53 +00:00
}
if(board.beginsWith("BSX-")) {
output.append(memory("NVRAM", 0x80000, "download.ram"));
} else if(board.beginsWith("CX4-")) {
output.append(memory("RAM", 0, "save.ram"));
output.append(memory("RAM", 0xc00, "cx4.data.ram"));
} else if(board.beginsWith("DSP-")) {
output.append(memory("RAM", 0x200, "dsp.data.ram"));
} else if(board.beginsWith("RTC-")) {
output.append(memory("NVRAM", 0x10, "rtc.ram"));
} else if(board.beginsWith("SA1-")) {
output.append(memory("RAM", 0x800, "internal.ram"));
} else if(board.beginsWith("SETA-")) {
output.append(memory("NVRAM", 0x4000, "seta.save.ram"));
} else if(board.beginsWith("SPC7110-RTC-")) {
output.append(memory("NVRAM", 0x10, "rtc.ram"));
} else if(board.beginsWith("ST-")) {
output.append(memory("NVRAM", 0x1000, "st.save.ram"));
2015-08-21 11:29:53 +00:00
}
if(hasMSU1) {
output.append(" msu1\n");
2015-08-21 11:29:53 +00:00
}
return output;
}
2015-08-21 11:29:53 +00:00
auto SuperFamicom::memory(string type, uint size, string name) const -> string {
string output;
output.append(" memory\n");
output.append(" type: ", type, "\n");
output.append(" size: 0x", hex(size), "\n");
output.append(" name: ", name, "\n");
return output;
}
2015-08-21 11:29:53 +00:00
auto SuperFamicom::sha256() const -> string {
return Hash::SHA256(data, size).digest();
}
2015-08-21 11:29:53 +00:00
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 = {"SHVC-\?\?-JPN"}; //trigraphs: why is this still a thing?
if(E == 0x01) region = { "SNS-\?\?-USA"};
if(E == 0x02) region = {"SNSP-\?\?-EUR"};
if(E == 0x03) region = {"SNSP-\?\?-SCN"};
if(E == 0x06) region = {"SNSP-\?\?-FRA"};
if(E == 0x07) region = {"SNSP-\?\?-HOL"};
if(E == 0x08) region = {"SNSP-\?\?-ESP"};
if(E == 0x09) region = {"SNSP-\?\?-NOE"};
if(E == 0x0a) region = {"SNSP-\?\?-ITA"};
if(E == 0x0b) region = {"SNSP-\?\?-ROC"};
if(E == 0x0d) region = {"SNSP-\?\?-KOR"};
if(E == 0x0f) region = { "SNS-\?\?-CAN"};
if(E == 0x10) region = { "SNS-\?\?-BRA"};
if(E == 0x11) region = {"SNSP-\?\?-AUS"};
}
return region ? region : "NTSC";
}
2015-08-21 11:29:53 +00:00
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) {
if(E == 0x00) revision = {"SHVC-\?\?-", F};
if(E == 0x01) revision = { "SNS-\?\?-", F};
if(E == 0x02) revision = {"SNSP-\?\?-", F};
if(E == 0x03) revision = {"SSWE-\?\?-", F};
if(E == 0x06) revision = {"SFRA-\?\?-", F};
if(E == 0x07) revision = {"SHOL-\?\?-", F};
if(E == 0x08) revision = {"SESP-\?\?-", F};
if(E == 0x09) revision = {"SFRG-\?\?-", F};
if(E == 0x0a) revision = {"SITA-\?\?-", F};
if(E == 0x0b) revision = {"SSCN-\?\?-", F};
if(E == 0x0d) revision = {"SKOR-\?\?-", F};
if(E == 0x0f) revision = { "SNS-\?\?-", F};
if(E == 0x10) revision = {"SBRA-\?\?-", F};
if(E == 0x11) revision = {"SNSP-\?\?-", F};
}
return revision ? revision : string{"1.", F};
}
2015-08-21 11:29:53 +00:00
auto SuperFamicom::board() const -> string {
auto mapModeLo = data[headerAddress + 0x25] & 15;
auto cartridgeType = data[headerAddress + 0x26];
auto cartridgeTypeLo = cartridgeType & 15;
auto cartridgeTypeHi = cartridgeType >> 4;
auto cartridgeSubType = data[headerAddress + 0x2f];
string board;
string mode;
if(mapModeLo == 0x0) mode = "LOROM-";
if(mapModeLo == 0x1) mode = "HIROM-";
if(mapModeLo == 0x2) mode = "SDD1-";
if(mapModeLo == 0x3) mode = "SA1-";
if(mapModeLo == 0x5) mode = "EXHIROM-";
if(mapModeLo == 0xa) mode = "SPC7110-";
if(serial() == "A9PJ") {
board.append("ST-");
} else if(serial().match("Z\?\?J")) {
board.append("BS-", mode);
} else if(cartridgeTypeLo >= 0x3) {
if(cartridgeTypeHi == 0x0) board.append("DSP-", mode);
if(cartridgeTypeHi == 0x1) board.append("SUPERFX-");
if(cartridgeTypeHi == 0x2) board.append("OBC1-", mode);
if(cartridgeTypeHi == 0x3) board.append("SA1-");
if(cartridgeTypeHi == 0x4) board.append("SDD1-");
if(cartridgeTypeHi == 0x5) board.append("RTC-", mode);
if(cartridgeTypeHi == 0xe && cartridgeTypeLo == 0x3) board.append("SGB-");
if(cartridgeTypeHi == 0xe && cartridgeTypeLo == 0x5) board.append("BSX-");
if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x00 && cartridgeTypeLo == 0x5) board.append("SPC7110-");
if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x00 && cartridgeTypeLo == 0x9) board.append("SPC7110-RTC-");
if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x01) board.append("ST-");
if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x02) board.append("SETA-");
if(cartridgeTypeHi == 0xf && cartridgeSubType == 0x10) board.append("CX4-");
} else {
board.append(mode);
2015-08-21 11:29:53 +00:00
}
if(cartridgeTypeLo == 0x1 || cartridgeTypeLo == 0x4) board.append("RAM-");
if(cartridgeTypeLo == 0x2 || cartridgeTypeLo == 0x5) board.append("NVRAM-");
if(cartridgeTypeLo == 0x6) board.append("BATTERY-");
2015-08-21 11:29:53 +00:00
return board.trimRight("-", 1L);
}
2015-08-21 11:29:53 +00:00
auto SuperFamicom::label() const -> string {
string label;
auto append = [&](char c) -> void {
if(c >= 0x20 && c <= 0x7e) label.append(c); //ASCII
//todo: convert Shift-JIS half-width katakana to UTF-8 here
else label.append("?");
};
for(uint n : range(0x15)) append(data[headerAddress + 0x10 + n]);
return label.strip();
}
2015-08-21 11:29:53 +00:00
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)
2015-08-21 11:29:53 +00:00
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};
2015-08-21 11:29:53 +00:00
}
return "";
2015-08-21 11:29:53 +00:00
}
auto SuperFamicom::ramSize() const -> uint {
auto ramSize = data[headerAddress + 0x28] & 7;
if(ramSize) return 1024 << ramSize;
return 0;
}
2015-08-21 11:29:53 +00:00
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;
2015-08-21 11:29:53 +00:00
}
auto SuperFamicom::scoreHeader(uint address) -> uint {
2015-08-21 11:29:53 +00:00
int score = 0;
if(size < address + 0x50) return score;
2015-08-21 11:29:53 +00:00
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
2015-08-21 11:29:53 +00:00
uint8_t opcode = data[(address & ~0x7fff) | (resetVector & 0x7fff)]; //first instruction executed
2015-08-21 11:29:53 +00:00
//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
2015-08-21 11:29:53 +00:00
) 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
2015-08-21 11:29:53 +00:00
) 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
2015-08-21 11:29:53 +00:00
) 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
2015-08-21 11:29:53 +00:00
) score -= 8;
if(checksum + complement == 0xffff) score += 4;
2015-08-21 11:29:53 +00:00
if(address == 0x7fb0 && mapMode == 0x20) score += 2;
if(address == 0xffb0 && mapMode == 0x21) score += 2;
2015-08-21 11:29:53 +00:00
return max(0, score);
}
2015-08-21 11:29:53 +00:00
}