patterns: Fix quirks of nes.hexpat with famiclones and miscellaneous fixes (#467)

* Add credit to ne.hexpat

* Add many changes to nes.hexpat

* Fixing dependance on variables declared in if statement

* Added mappers and inline to NES 2.0 header, removed needless parenthesises

* Add files via upload

* Add files via upload

* Create nsf.hexpat

* Used full name of the SNES on description

* Add SNES, NSF & NSFe, new description for NES

* Removing erroneous condition in ips.hexpat's truncatedSize

* Removing unnecessary std.string import in ips.hexpat

* Added both locations for sections in PE, clearer variable names, reorganized DOS stub

* Delete patterns/nsfe.hexpat

* Delete patterns/nsfmetadata.hexpat

* Added chunks from NSFe to NSF

* Added NSFe

* Fix size of truncatedSize in ips.hexpat

* More mappers, deprecated tag, and constants to nes

* Fixed official header's constants

* Various corrections

* Fix on declaration of sections, reserved words made into padding

* Added hacked algorithm for longer PRG ROM size, fixed iNES check

* For nes.hexpat, fixed mapper 51 still having its submapper's name

* Fix bug that makes size negative on standard roms

---------

Co-authored-by: Nik <werwolv98@gmail.com>
This commit is contained in:
gmestanley
2026-01-03 16:25:48 -03:00
committed by GitHub
parent 190f9d891b
commit 8a9bd577ad
2 changed files with 361 additions and 287 deletions

View File

@@ -4,8 +4,18 @@
import std.string;
enum MirroringType : u8 {
Vertical,
Horizontal
};
fn mirroring(u8 value) {
MirroringType enumValue = value;
return enumValue;
};
bitfield Flags {
mirroringIsHorizontal : 1;
mirroring : 1 [[format("mirroring")]];
ignoreMirroring : 1;
batterybackedPRGRAM : 1;
trainerOf512Bytes : 1;
@@ -34,8 +44,18 @@ bitfield iNESFlags7 {
higherMapperNybble : 4;
};
enum OldTVSystemByte : u8 {
NTSC,
PAL
};
fn formatOldTVSystemByte(u8 value) {
OldTVSystemByte enumValue = value;
return value;
};
bitfield iNESFlags9 {
tvSystem : 1 [[comment("0 = NTSC, 1 = PAL")]];
tvSystem : 1 [[format("formatOldTVSystemByte")]];
padding : 7;
};
@@ -66,7 +86,7 @@ bitfield ROMSize {
bitfield PRGRAMSize {
prgRAMShiftCount : 4;
eepromShiftCount : 4 [[comment("EEPROM = Non-volatile PRG RAM")]];
eepromShiftCount : 4 [[comment("EEPROM = Non-volatile PRG RAM, or NVPRGRAM")]];
};
bitfield CHRRAMSize {
@@ -82,8 +102,8 @@ enum TimingList : u8 {
};
fn Timing(u8 value) {
TimingList type = value;
return type;
TimingList enumValue = value;
return enumValue;
};
bitfield Timing {
@@ -119,7 +139,7 @@ bitfield ExtendedConsoleTypeByte {
padding : 4;
};
bitfield MiscellaneousROMs {
bitfield MiscellaneousROMsHeaderByte {
numberOfMiscellaneousROMs : 2;
padding : 6;
};
@@ -143,7 +163,7 @@ struct NES2Attributes {
else {
padding[1];
}
MiscellaneousROMs miscellaneousROMs;
MiscellaneousROMsHeaderByte miscellaneousROMs;
DefaultExpansionDevice defaultExpansionDevice;
} [[inline]];
@@ -160,7 +180,7 @@ struct Header {
iNESFlags7 inesFlags7;
if (inesFlags7.nes2Format)
NES2Attributes nes2Attributes;
else if ($[0x07] & 12 == 0 && !std::mem::read_unsigned($, 4)) {
else if ($[0x07] & 12 == 0 && !std::mem::read_unsigned(0x0C, 4)) {
u8 prgRAMSizeBy8KiBs;
iNESFlags9 inesFlags9;
iNESFlags10 inesFlags10;
@@ -170,6 +190,177 @@ struct Header {
Header header @ 0x00;
u8 FILLED_HIGHER_NYBBLE = 0b1111;
u8 FILLED_NES2_FLAGS = 0b1100;
u8 SET_NES2_FLAGS = 0b1000;
u16 mapperValue = (0x0100 * ($[0x08] & FILLED_HIGHER_NYBBLE)) * ($[7] & FILLED_NES2_FLAGS == SET_NES2_FLAGS)
+ (0x10 * ($[0x07] >> 4)) * ($[7] & FILLED_NES2_FLAGS != 0b100)
+ header.flags.lowerMapperNybble;
fn identifyMapper(u16 mapperValue, u8 submapperValue) {
str mapper;
str submapper;
str designation;
match (mapperValue) {
(0): mapper = "No mapper";
(1): mapper = "MMC1B";
(2): mapper = "UxROM";
(3): mapper = "CNROM-32";
(4): mapper = "MMC3";
(5): mapper = "MMC5";
(6): mapper = "Front Fareast Magic Card 1/2M RAM Cartridge";
(7): mapper = "AxROM";
(8): mapper = "Front Fareast Magic Card 1/2M RAM Cartridge [Initial latch-based banking mode 4]";
(9): mapper = "MMC2";
(10): mapper = "MMC4";
(11): mapper = "Color Dreams";
(12): mapper = "[See submapper]";
(13): mapper = "CPROM";
(14): mapper = "SL-1632";
(15): mapper = "K-102xx";
(16): mapper = "Bandai FCG boards";
(17): mapper = "Front Fareast Super Magic Card RAM cartridge";
(18): mapper = "Jaleco SS88006";
(19): mapper = "Namco 129/163";
(20): mapper = "Famicom Disk System";
(21): mapper = "Konami VRC4a/VRC4c";
(22): mapper = "Konami VRC2a";
(23): mapper = "Konami VRC4e or VRC2b + VRC4f";
(24): mapper = "Konami VRC6a";
(25): mapper = "Konami VRC4d or VRC2c + VRC4b";
(26): mapper = "Konami VRC6b";
(27): mapper = "World Hero";
(28): mapper = "Action 53, homebrew";
(29): mapper = "RET-CUFROM";
(30): mapper = "UNROM 512";
(31): mapper = "NSF";
(32): mapper = "G-101";
(33): mapper = "Taito TC0190";
(34): mapper = "[See submapper]";
(35): mapper = "J.Y. Company ASIC [8KiB WRAM]";
(36): mapper = "Micro Genius 01-22000-400";
(37): mapper = "SMB+Tetris+NWC";
(38): mapper = "Bit Corp. Crime Busters";
(39): mapper = "Study & Game 32-in-1 [DEPRECATED]";
(40): mapper = "NTDEC 27xx";
(41): mapper = "Caltron 6-in-1";
(42): mapper = "FDS -> NES Hacks";
(43): mapper = "TONY-I/YS-612";
(44): mapper = "Super Big 7-in-1";
(45): mapper = "GA23C";
(46): mapper = "Lite Star Rumble Station";
(47): mapper = "Nintendo Super Spike V'Ball + NWC";
(48): mapper = "Taito TC0690";
(49): mapper = "Super HIK 4-in-1";
(50): mapper = "N-32 [Super Mario Bros. 2 (J)]";
(51): mapper = "[See submapper]";
(52): mapper = "Realtec 8213";
(53): mapper = "Supervision 16-in-1";
(54): mapper = "Novel Diamond 9999999-in-1 [DEPRECATED]";
(55): mapper = "QFJxxxx";
(56): mapper = "KS202";
(57): mapper = "GK";
(58): mapper = "WQ";
(59): mapper = "T3H53";
(60): mapper = "Reset-based NROM-128 4-in-1";
(61): mapper = "[See submapper]";
(62): mapper = "Super 700-in-1";
(63): mapper = "[See submapper]";
(64): mapper = "Tengen RAMBO-1";
(65): mapper = "Irem H3001";
(66): mapper = "xxROM";
(67): mapper = "Sunsoft-3";
(68): mapper = "Sunsoft-4";
(69): mapper = "Sunsoft FME-7/Sunsoft 5A/Sunsoft 5B";
(70): mapper = "Family Trainer Mat";
(71): mapper = "Camerica";
(72): mapper = "Jaleco JF-17 [16 KiB PRG ROM]";
(73): mapper = "Konami VRC3";
(74): mapper = "860908C";
(75): mapper = "Konami VRC1";
(76): mapper = "NAMCOT-3446";
(77): mapper = "Napoleon Senki";
(78): mapper = "74HC161/32";
(79): mapper = "Tengen NINA-003/NINA-006";
(80): mapper = "X1-005";
(81): mapper = "N715021";
(82): mapper = "X1-017";
(83): mapper = "Cony & Yoko chip";
(84): mapper = "PC-SMB2J [DEPRECATED]";
(85): mapper = "Konami VRC7";
(86): mapper = "Jaleco JF-13";
(87): mapper = "JF87";
(88): mapper = "Namco chip";
(89): mapper = "Sunsoft 2.5";
(90): mapper = "J.Y. Company ASIC [ROM nametables & extended mirroring]";
(91): mapper = "J.Y. Company clone boards";
(92): mapper = "Jaleco JF-17 [16 KiB PRG ROM]";
(187): mapper = "Kǎ Shèng A98402";
(256): mapper = "V.R. Technology OneBus";
(355): mapper = "Jùjīng 3D-BLOCK";
(424): mapper = "Lexibook Retro TV Game Console";
(426): mapper = "V.R. Technology OneBus [Serial ROM in GPIO]";
(594): mapper = "Rinco FSG2";
(595): mapper = "NES-4MROM-512";
}
match (mapperValue) {
(0): designation = "NROM";
(1): designation = "SxROM";
(4): designation = "TxROM";
}
if (mapperValue == 3) {
match (submapperValue) {
(0): submapper = "Bus conflict";
(1): submapper = "No bus conflicts";
(2): submapper = "AND-type bus conflicts";
}
}
else if (mapperValue == 12) {
match (submapperValue) {
(0): submapper = "Supertone SL-5020B";
(1): submapper = "Front Fareast Magic Card 4M RAM Cartridge";
}
}
else if (mapperValue == 16) {
match (submapperValue) {
(0): submapper = "Both Bandai FCG-1/2 and Bandai LZ93D50";
(4): submapper = "Bandai FCG-1/2";
(5): submapper = "Bandai LZ93D50";
}
}
else if (mapperValue == 34) {
match (submapperValue) {
(0): submapper = "Tengen NINA-001/NINA-002";
(1): submapper = "BNROM";
}
}
else if (mapperValue == 40) {
match (submapperValue) {
(0): submapper = "NTDEC 2722";
(1): submapper = "NTDEC 2752";
}
}
else if (mapperValue == 51) {
if (submapperValue == 1) submapper = "11-in-1 Ball Games";
}
else if (mapperValue == 61) {
match (submapperValue) {
(0): submapper = "NTDEC 0324";
(1): submapper = "NTDEC BS-N032";
(_): submapper = "GS-2017";
}
}
else if (mapperValue == 63) {
match (submapperValue) {
(0): submapper = "NTDEC TH2xxx-x";
(1): submapper = "82-in-1";
}
}
std::print("Mapper: " + mapper + " (" + std::string::to_string(mapperValue) + ")");
if (submapper) std::print("Submapper: " + submapper + " (" + std::string::to_string(submapperValue) + ")");
if (designation) std::print("Designation: " + designation);
};
identifyMapper(mapperValue, $[0x08] >> 4);
u8 trainer[512*header.flags.trainerOf512Bytes] @ 0x10;
enum CHRType : u8 {
@@ -243,7 +434,10 @@ struct OfficialHeader {
u8 complementaryChecksum [[hex::spec_name("Checksum for characterChecksum~makerID")]];
};
u24 calculatedPRGROMSize = 16384 * ((0x0100 * ($[9] & 0x0F)) * ($[7] & 12 == 8) + header.prgROMSizeBy16KiBs);
u16 PRGROM_MINIMUM_SIZE = 16384;
u8 LOWER_TWO_DIGITS = 0b11;
u32 calculatedPRGROMSize = (std::mem::size()-16-(4096*($[0x0E]&LOWER_TWO_DIGITS))) * ($[0x09]&FILLED_HIGHER_NYBBLE==0x0F)
+ (PRGROM_MINIMUM_SIZE * ((0x0100 * ($[0x09] & FILLED_HIGHER_NYBBLE)) * ($[0x07] & FILLED_NES2_FLAGS == SET_NES2_FLAGS) + header.prgROMSizeBy16KiBs)) * ($[0x09]&FILLED_HIGHER_NYBBLE!=0x0F);
fn hasOfficialHeader() {
u8 sum;
@@ -253,155 +447,35 @@ fn hasOfficialHeader() {
return !sum;
};
u8 OFFICIAL_HEADER_SIZE = 26;
u8 VECTORS_SIZE = 6;
struct PRGROM {
u8 data[calculatedPRGROMSize - 26 * hasOfficialHeader() - 6];
u8 data[calculatedPRGROMSize - OFFICIAL_HEADER_SIZE * hasOfficialHeader() - VECTORS_SIZE];
if (hasOfficialHeader())
OfficialHeader officialHeader;
u16 nmi;
u16 resetVector [[comment("Entry Point")]];
u16 externalIRQ;
};
PRGROM prgROM @ 0x10 + sizeof(trainer);
u8 chrROM[8192 * ((0x0100 * ($[9] >> 4)) * ($[7] & 12 == 8) + header.chrROMSizeBy8KiBs)] @ addressof(prgROM) + 16384 * header.prgROMSizeBy16KiBs;
fn identifyMapper(u16 mapperValue, u8 submapperValue) {
str mapper;
str submapper;
str designation;
match (mapperValue) {
(0): mapper = "NROM";
(1): mapper = "MMC1B";
(2): mapper = "UxROM";
(3): mapper = "CNROM-32";
(4): mapper = "MMC3";
(5): mapper = "MMC5";
(6): mapper = "Front Fareast Magic Card 1/2M RAM Cartridge";
(7): mapper = "AxROM";
(8): mapper = "Front Fareast Magic Card 1/2M RAM Cartridge (Initial latch-based banking mode 4)";
(9): mapper = "MMC2";
(10): mapper = "MMC4";
(11): mapper = "Color Dreams";
(12): mapper = "(See submapper)";
(13): mapper = "CPROM";
(14): mapper = "SL-1632";
(15): mapper = "K-102xx";
(16): mapper = "Bandai FCG boards";
(17): mapper = "Front Fareast Super Magic Card RAM cartridge";
(18): mapper = "SS88006 (Jaleco)";
(19): mapper = "Namco 129/163";
(20): mapper = "Famicom Disk System";
(21): mapper = "VRC4a/VRC4c";
(22): mapper = "VRC2a";
(23): mapper = "VRC4e or VRC2b + VRC4f";
(24): mapper = "VRC6a";
(25): mapper = "VRC4d or VRC2c + VRC4b";
(26): mapper = "VRC6b";
(27): mapper = "World Hero";
(28): mapper = "Action 53";
(29): mapper = "RET-CUFROM";
(30): mapper = "UNROM 512";
(31): mapper = "NSF";
(32): mapper = "G-101";
(33): mapper = "TC0190";
(34): mapper = "(See submapper)";
(35): mapper = "J.Y. Company (8KiB WRAM)";
(36): mapper = "01-22000-400";
(37): mapper = "SMB+Tetris+NWC";
(38): mapper = "Crime Busters";
(39): mapper = "Study & Game 32-in-1";
(40): mapper = "NTDEC 27xx";
(41): mapper = "Caltron 6-in-1";
(42): mapper = "FDS -> NES Hacks";
(43): mapper = "TONY-I/YS-612";
(44): mapper = "Super Big 7-in-1";
(45): mapper = "GA23C";
(46): mapper = "Rumble Station";
(47): mapper = "Super Spike V'Ball + NWC";
(48): mapper = "TC0690";
(49): mapper = "Super HIK 4-in-1";
(50): mapper = "761214";
(51): mapper = "11-in-1 Ball Games";
(52): mapper = "Realtec 8213";
(53): mapper = "Supervision 16-in-1";
(54): mapper = "Novel Diamond 9999999-in-1";
(55): mapper = "QFJ";
(56): mapper = "KS202";
(57): mapper = "GK";
(58): mapper = "WQ";
(59): mapper = "T3H53";
(60): mapper = "Reset-based NROM-128 4-in-1";
(61): mapper = "(See submapper)";
(62): mapper = "Super 700-in-1";
(63): mapper = "(See submapper)";
(64): mapper = "RAMBO-1";
(65): mapper = "H3001";
(66): mapper = "GxROM";
(67): mapper = "Sunsoft-3";
(68): mapper = "Sunsoft-4";
(69): mapper = "Sunsoft FME-7/Sunsoft 5A/Sunsoft 5B";
(70): mapper = "Family Trainer Mat";
(71): mapper = "Camerica";
(72): mapper = "JF-17";
(73): mapper = "VRC3";
(74): mapper = "860908C";
(75): mapper = "VRC1";
(76): mapper = "NAMCOT-3446";
(77): mapper = "Napoleon Senki";
(78): mapper = "74HC161/32";
(79): mapper = "NINA-003/NINA-006";
(80): mapper = "X1-005";
(81): mapper = "N715021";
(82): mapper = "X1-017";
u16 CHRROM_MINIMUM_SIZE = 8192;
u24 calculatedCHRROMSize = CHRROM_MINIMUM_SIZE * ((0x0100 * ($[0x09] >> 4)) * ($[0x07] & FILLED_NES2_FLAGS == SET_NES2_FLAGS) + header.chrROMSizeBy8KiBs);
u8 chrROM[calculatedCHRROMSize] @ addressof(prgROM) + calculatedPRGROMSize;
struct MiscellaneousROMs {
if ($[0x07] & LOWER_TWO_DIGITS == ConsoleType::PlayChoice10) {
u8 instructionsROM[8192] [[hex::spec_name("INST-ROM")]];
u8 decryptionDataPROM[16];
u8 decryptionCounterOutPROM[16];
}
if (mapperValue == 3) {
match (submapperValue) {
(0): submapper = "Bus conflict";
(1): submapper = "No bus conflicts";
(2): submapper = "AND-type bus conflicts";
else if ($[0x0D] == ExtendedConsoleType::VT3xx) {
u8 embeddedROM[4096];
}
else if (mapperValue == 355) {
u8 antiCloningROM[1024];
}
else if (mapperValue == 4) designation = "TxROM";
else if (mapperValue == 12) {
match (submapperValue) {
(0): submapper = "SL-5020B (Gouder)";
(1): submapper = "Front Fareast Magic Card 4M RAM Cartridge";
}
}
else if (mapperValue == 16) {
match (submapperValue) {
(0): submapper = "FCG-1/2 or LZ93D50";
(4): submapper = "FCG-1/2";
(5): submapper = "LZ93D50";
}
}
else if (mapperValue == 34) {
match (submapperValue) {
(0): submapper = "NINA-001/NINA-002";
(1): submapper = "BNROM";
}
}
else if (mapperValue == 40) {
match (submapperValue) {
(0): submapper = "NTDEC 2722";
(1): submapper = "NTDEC 2752";
}
}
else if (mapperValue == 61) {
match (submapperValue) {
(0): submapper = "NTDEC 0324";
(1): submapper = "NTDEC BS-N032";
(_): submapper = "GS-2017";
}
}
else if (mapperValue == 63) {
match (submapperValue) {
(0): submapper = "TH2291-3";
(1): submapper = "82AB";
}
}
std::print("Mapper: " + mapper + "(" + std::string::to_string(mapperValue) + ")");
if (submapper) std::print("Submapper: " + submapper + "(" + std::string::to_string(submapperValue) + ")");
if (designation) std::print("Designation: " + designation);
};
identifyMapper(0x0100 * ($[8] & 0x0F) + 0x10 * ($[7] & 0x0F) + header.flags.lowerMapperNybble, $[8] >> 4);
MiscellaneousROMs miscellaneousROMs[$[0x0E] & LOWER_TWO_DIGITS > 0] @ addressof(prgROM) + calculatedPRGROMSize + calculatedCHRROMSize;

View File

@@ -47,10 +47,10 @@ struct DOSHeader {
u16 initialCSValue [[hex::spec_name("e_cs")]];
u16 relocationsTablePointer [[hex::spec_name("e_lfarlc")]];
u16 overlayNumber [[hex::spec_name("e_ovno")]];
u16 reservedWords[4] [[hex::spec_name("e_res")]];
padding[8];
u16 oemIdentifier [[hex::spec_name("e_oemid")]];
u16 oemInformation [[hex::spec_name("e_oeminfo")]];
u16 otherReservedWords[10] [[hex::spec_name("e_res2")]];
padding[20];
u32 coffHeaderPointer [[hex::spec_name("e_lfanew")]];
};
@@ -1115,7 +1115,7 @@ struct Section {
} [[name(sectionsTable[currentSectionIndex-1].name)]];
Section sections[coffHeader.numberOfSections] @ coffHeader.optionalHeader.sizeOfHeaders * !sectionsTable[0].sizeOfRawData
+ sectionsTable[0].ptrRawData * sectionsTable[0].sizeOfRawData>0;
+ sectionsTable[0].ptrRawData * (sectionsTable[0].sizeOfRawData>0);
// Symbol & String Tables
enum SectionNumberType : s16 {