1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
//! Mapper 1 - MMC1 (SxROM)
//!
//! Known Limitations:
//! - No mapper-specific gameplay-blocking functional limitations are currently documented.
//! - Edge-case behavior may still differ from hardware in untested timing and board-variant scenarios.
//! - See CARTRIDGE_REVIEW.md sections 5 and 6 for remaining mapper test/documentation follow-up.
use crate::cartridge::BaseMapper;
use crate::cartridge::Mapper;
use crate::cartridge::MapperCapabilities;
use crate::cartridge::NametableLayout;
use crate::trace_mapper;
// Memory size constants
const PRG_BANK_SIZE: usize = 0x4000; // 16KB
const CHR_BANK_SIZE: usize = 0x1000; // 4KB
const MMC1_SUBMAPPER_FIXED_32KB_PRG: u8 = 5;
const MMC1_SUBMAPPER_HARDWIRED_MIRRORING: u8 = 7;
const MMC1_SHIFT_REGISTER_RESET: u8 = 0x80; // Bit 7 set triggers reset
const MMC1_SHIFT_REGISTER_POWER_ON: u8 = 0x10;
const MMC1_WRITE_COUNT_MAX: u8 = 5; // Number of writes to load a register
const MMC1_DEFAULT_CONTROL: u8 = 0x0C; // PRG mode 3, CHR mode 0
#[cfg(test)]
const MMC1B_WRAM_DISABLED_POWER_ON_PRG_BANK: u8 = 0x10;
const MMC1_MIN_CYCLES_BETWEEN_SERIAL_WRITES: u64 = 2;
const MMC1_CHR_BANK_0_REGISTER_ADDR: u16 = 0xA000;
const MMC1_CHR_BANK_1_REGISTER_ADDR: u16 = 0xC000;
/// MMC1 ASIC revision variants
///
/// Different MMC1 hardware revisions have different PRG-RAM enable behavior:
/// - MMC1A: PRG-RAM always enabled (bit 4 of PRG bank register ignored)
/// - MMC1B: PRG-RAM can be disabled via bit 4 (starts enabled by default)
///
/// See: https://www.nesdev.org/wiki/MMC1#ASIC_Revisions
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Mmc1Revision {
/// MMC1A: PRG-RAM always enabled, bit 4 ignored
Mmc1A,
/// MMC1B/C: PRG-RAM enable controlled by bit 4 of PRG bank register
Mmc1B,
}
/// Mapper 1 - MMC1 (SxROM boards)
///
/// Hardware: Nintendo's most common mapper with serial shift register interface
///
/// Specifications:
/// - Main: <https://www.nesdev.org/wiki/MMC1>
/// - Revisions: <https://www.nesdev.org/wiki/MMC1#ASIC_Revisions>
/// - Board variants: <https://www.nesdev.org/wiki/SxROM>
/// - PRG-ROM: Up to 512KB (32 16KB banks)
/// - PRG-RAM: 8KB or 32KB (depends on board)
/// - CHR: Up to 128KB (32 4KB banks or 16 8KB banks, ROM or RAM)
/// - Mirroring: Programmable (horizontal, vertical, one-screen A/B)
///
/// Common boards: NES-SLROM, NES-SNROM, NES-SGROM, NES-SKROM, NES-SUROM
///
/// Notes:
/// - Shift register interface (5-bit serial loading)
/// - Bit 7 write triggers reset, sets control to mode 3 (PRG fixed at $C000)
/// - MMC1A revision: PRG-RAM always enabled
/// - MMC1B/C revisions: PRG-RAM controllable via register bit
/// - Used in The Legend of Zelda, Metroid, Mega Man 2, Final Fantasy
///
/// PRG-RAM Enable (Revision-Specific):
/// - MMC1A: PRG-RAM is always enabled, bit 4 of PRG bank register is ignored
/// - MMC1B/C: Bit 4 controls PRG-RAM (0 = enabled, 1 = disabled)
///
/// SxROM Board Variant Support:
/// - SUROM (512KB PRG-ROM): CHR bank 0 bit 4 selects 256KB outer PRG-ROM bank
/// - SOROM/SXROM (>8KB PRG-RAM): CHR bank 0 bit 3 selects active 8KB PRG-RAM bank
///
/// See: https://www.nesdev.org/wiki/MMC1#ASIC_Revisions
/// https://www.nesdev.org/wiki/SxROM
///
/// Used in games like The Legend of Zelda, Metroid, Mega Man 2, Final Fantasy.
pub struct MMC1Mapper {
base: BaseMapper,
prg_ram: Vec<u8>, // Separate: WRAM gating + SOROM banking not supported by PrgRam
// Shift register state
shift_register: u8, // 5-bit shift register
write_count: u8, // Number of writes (0-4)
// Internal registers (5 bits each)
control: u8, // Mirroring and banking mode control
chr_bank_0: u8, // CHR bank 0 select
chr_bank_1: u8, // CHR bank 1 select
prg_bank: u8, // PRG bank select
// Hardware revision
revision: Mmc1Revision, // MMC1A vs MMC1B behavior
// SxROM board variant flags (detected from ROM metadata at construction)
surom: bool, // SUROM: 512KB PRG-ROM; chr_bank_0[4] selects 256KB outer bank
sorom: bool, // SOROM/SXROM: >8KB PRG-RAM; chr_bank_0[3] selects 8KB PRG-RAM bank
submapper: u8,
hardwired_mirroring: Option<NametableLayout>,
last_chr_reg_addr: u16,
// Cycle tracking for consecutive-write ignore behavior
cpu_cycle_count: u64, // Current CPU cycle count
last_write_cycle: u64, // CPU cycle of last write to shift register
has_last_write: bool, // Whether any serial-port write has occurred
}
impl MMC1Mapper {
fn revision_from_mapper(mapper_id: u16) -> Mmc1Revision {
match mapper_id {
155 => Mmc1Revision::Mmc1A,
_ => Mmc1Revision::Mmc1B,
}
}
#[cfg(test)]
fn power_on_prg_bank_for_revision(revision: Mmc1Revision) -> u8 {
match revision {
Mmc1Revision::Mmc1A => 0,
Mmc1Revision::Mmc1B => MMC1B_WRAM_DISABLED_POWER_ON_PRG_BANK,
}
}
fn hardwired_mirroring_from_header(
submapper: u8,
header_mirroring: NametableLayout,
) -> Option<NametableLayout> {
(submapper == MMC1_SUBMAPPER_HARDWIRED_MIRRORING).then_some(header_mirroring)
}
pub fn new(ctx: super::mapper::MapperContext) -> Self {
let prg_ram_size = (ctx.prg_ram_banks_8k as usize) * 8192;
let surom = ctx.prg_rom.len() > 256 * 1024;
let sorom = ctx.prg_ram_banks_8k >= 2;
let revision = Self::revision_from_mapper(ctx.mapper);
let capabilities = MapperCapabilities {
has_chr_banking: true,
has_dynamic_mirroring: true,
max_prg_ram_kb: 0, // PRG-RAM managed separately (gating + banking)
prg_bank_size_kb: 16,
chr_bank_size_kb: 4,
..Default::default()
};
let mut base = BaseMapper::new(&ctx, capabilities);
base.configure_prg_banking(PRG_BANK_SIZE);
base.configure_chr_banking(CHR_BANK_SIZE);
let mut mapper = Self {
base,
prg_ram: vec![0; prg_ram_size],
shift_register: MMC1_SHIFT_REGISTER_POWER_ON,
write_count: 0,
control: MMC1_DEFAULT_CONTROL,
chr_bank_0: 0,
chr_bank_1: 0,
prg_bank: 0,
revision,
surom,
sorom,
submapper: ctx.submapper,
hardwired_mirroring: Self::hardwired_mirroring_from_header(
ctx.submapper,
ctx.mirroring,
),
last_chr_reg_addr: 0xA000,
cpu_cycle_count: 0,
last_write_cycle: 0,
has_last_write: false,
};
mapper.update_banks();
mapper
}
#[cfg(test)]
pub fn new_with_revision(
prg_rom: Vec<u8>,
chr_rom: Vec<u8>,
mirroring: NametableLayout,
revision: Mmc1Revision,
) -> Self {
use crate::cartridge::mapper::MapperContext;
let surom = prg_rom.len() > 256 * 1024;
let prg_bank = Self::power_on_prg_bank_for_revision(revision);
let ctx = MapperContext::new_for_test(1, prg_rom, chr_rom, mirroring);
let capabilities = MapperCapabilities {
has_chr_banking: true,
has_dynamic_mirroring: true,
max_prg_ram_kb: 0,
prg_bank_size_kb: 16,
chr_bank_size_kb: 4,
..Default::default()
};
let mut base = BaseMapper::new(&ctx, capabilities);
base.configure_prg_banking(PRG_BANK_SIZE);
base.configure_chr_banking(CHR_BANK_SIZE);
let mut mapper = Self {
base,
prg_ram: vec![0; 8192],
shift_register: MMC1_SHIFT_REGISTER_POWER_ON,
write_count: 0,
control: MMC1_DEFAULT_CONTROL,
chr_bank_0: 0,
chr_bank_1: 0,
prg_bank,
revision,
surom,
sorom: false,
submapper: 0,
hardwired_mirroring: None,
last_chr_reg_addr: 0xA000,
cpu_cycle_count: 0,
last_write_cycle: 0,
has_last_write: false,
};
mapper.update_banks();
mapper
}
fn reset_shift_register(&mut self) {
self.shift_register = MMC1_SHIFT_REGISTER_POWER_ON; // Reset to power-on state: bit 4 set
self.write_count = 0;
self.control |= MMC1_DEFAULT_CONTROL; // Set PRG mode to 3 (fix last bank)
}
fn mark_serial_write_attempt(&mut self) {
self.last_write_cycle = self.cpu_cycle_count;
self.has_last_write = true;
}
fn should_ignore_serial_write(&self) -> bool {
self.has_last_write
&& self.cpu_cycle_count.saturating_sub(self.last_write_cycle)
< MMC1_MIN_CYCLES_BETWEEN_SERIAL_WRITES
}
fn update_chr_bank_0_register(&mut self, register_value: u8) {
self.last_chr_reg_addr = MMC1_CHR_BANK_0_REGISTER_ADDR;
self.chr_bank_0 = register_value & 0x1F;
}
fn update_chr_bank_1_register(&mut self, register_value: u8) {
self.last_chr_reg_addr = MMC1_CHR_BANK_1_REGISTER_ADDR;
self.chr_bank_1 = register_value & 0x1F;
}
fn select_extra_chr_reg_source(&self) -> u8 {
let is_4kb_chr_mode = self.get_chr_mode() == 1;
let used_chr_bank_1_register = self.last_chr_reg_addr == MMC1_CHR_BANK_1_REGISTER_ADDR;
if is_4kb_chr_mode && used_chr_bank_1_register {
self.chr_bank_1
} else {
self.chr_bank_0
}
}
fn write_register(&mut self, addr: u16, value: u8) {
// Check for reset (bit 7 set) - reset writes are NEVER ignored
if value & MMC1_SHIFT_REGISTER_RESET != 0 {
self.reset_shift_register();
self.mark_serial_write_attempt();
self.update_banks();
return;
}
let should_ignore = self.should_ignore_serial_write();
// Update last write cycle for any non-reset serial port write attempt
self.mark_serial_write_attempt();
// MMC1 ignores consecutive-cycle writes (except reset writes above)
// This prevents RMW instructions from shifting two bits
if should_ignore {
return;
}
// Shift in bit 0
self.shift_register >>= 1;
self.shift_register |= (value & 0x01) << 4;
self.write_count += 1;
// After 5 writes, load the register
if self.write_count == MMC1_WRITE_COUNT_MAX {
let register_value = self.shift_register;
// Determine which register to load based on address
match addr {
0x8000..=0x9FFF => {
trace_mapper!(1; "MMC1 control=${:02X} (mirroring={}, PRG_mode={}, CHR_mode={})",
register_value & 0x1F,
register_value & 0x03,
(register_value >> 2) & 0x03,
(register_value >> 4) & 0x01
);
self.control = register_value & 0x1F;
}
0xA000..=0xBFFF => {
trace_mapper!(1; "MMC1 CHR_bank_0=${:02X}", register_value & 0x1F);
self.update_chr_bank_0_register(register_value);
}
0xC000..=0xDFFF => {
trace_mapper!(1; "MMC1 CHR_bank_1=${:02X}", register_value & 0x1F);
self.update_chr_bank_1_register(register_value);
}
0xE000..=0xFFFF => {
trace_mapper!(1; "MMC1 PRG_bank=${:02X}", register_value & 0x1F);
self.prg_bank = register_value & 0x1F;
}
_ => {}
}
// Reset shift register for next write sequence
self.shift_register = MMC1_SHIFT_REGISTER_POWER_ON; // Reset to power-on state
self.write_count = 0;
self.update_banks();
}
}
fn get_prg_mode(&self) -> u8 {
(self.control >> 2) & 0x03
}
fn get_chr_mode(&self) -> u8 {
(self.control >> 4) & 0x01
}
fn is_mmc1a_a17_bypass_active(&self) -> bool {
match self.revision {
Mmc1Revision::Mmc1A => (self.prg_bank & 0x10) != 0,
Mmc1Revision::Mmc1B => false,
}
}
fn mmc1a_a17_bit(&self) -> usize {
((self.prg_bank >> 3) & 0x01) as usize
}
fn is_wram_enabled(&self) -> bool {
match self.revision {
Mmc1Revision::Mmc1A => {
// MMC1A always has PRG-RAM enabled, bit 4 is ignored
true
}
Mmc1Revision::Mmc1B => {
// MMC1B/C: Bit 4 of prg_bank register controls WRAM
// 0 = enabled, 1 = disabled
(self.prg_bank & 0x10) == 0
}
}
}
fn mirroring_from_control_register(&self) -> NametableLayout {
match self.control & 0x03 {
0 => NametableLayout::SingleScreenLower, // One-screen, lower bank
1 => NametableLayout::SingleScreenUpper, // One-screen, upper bank
2 => NametableLayout::Vertical,
3 => NametableLayout::Horizontal,
_ => unreachable!(),
}
}
fn get_mirroring_mode(&self) -> NametableLayout {
self.hardwired_mirroring
.unwrap_or_else(|| self.mirroring_from_control_register())
}
fn prg_ram_bank_offset(&self, addr: u16) -> usize {
let base = (addr - 0x6000) as usize;
if self.sorom {
let bank = ((self.get_extra_chr_reg() >> 3) & 1) as usize;
bank * 8192 + base
} else {
base
}
}
fn get_extra_chr_reg(&self) -> u8 {
self.select_extra_chr_reg_source()
}
fn update_banks(&mut self) {
self.update_prg_banks();
self.update_chr_banks();
self.base.set_mirroring(self.get_mirroring_mode());
}
fn update_prg_banks(&mut self) {
if self.uses_fixed_32kb_prg_mapping() {
self.base.select_prg_page(0, 0);
self.base.select_prg_page(1, 1);
return;
}
let prg_mode = self.get_prg_mode();
let extra_chr_reg = self.get_extra_chr_reg();
let mmc1a_a17_bypass = self.is_mmc1a_a17_bypass_active();
// SUROM: chr register bit 4 selects which 256KB outer half of 512KB PRG-ROM
let outer_bank = if self.surom {
((extra_chr_reg >> 4) & 1) as i16
} else {
0i16
};
match prg_mode {
0 | 1 => {
// 32KB mode: switch entire $8000-$FFFF, ignore low bit of bank number
let inner = ((self.prg_bank & 0x0E) >> 1) as i16;
let bank_32k = (outer_bank << 3) | inner;
self.base.select_prg_page(0, bank_32k * 2);
self.base.select_prg_page(1, bank_32k * 2 + 1);
}
2 => {
// Fix first bank at $8000, switch 16KB bank at $C000
let fixed_bank = if mmc1a_a17_bypass {
(self.mmc1a_a17_bit() << 3) as i16
} else {
outer_bank << 4 // first bank of current outer half
};
let switch_bank = (outer_bank << 4) | (self.prg_bank & 0x0F) as i16;
self.base.select_prg_page(0, fixed_bank);
self.base.select_prg_page(1, switch_bank);
}
3 => {
// Switch 16KB bank at $8000, fix last bank at $C000
let switch_bank = (outer_bank << 4) | (self.prg_bank & 0x0F) as i16;
let fixed_bank = if mmc1a_a17_bypass {
((self.mmc1a_a17_bit() << 3) | 0x07) as i16
} else {
(outer_bank << 4) | 0x0F // last bank of current outer half
};
self.base.select_prg_page(0, switch_bank);
self.base.select_prg_page(1, fixed_bank);
}
_ => unreachable!(),
}
}
fn update_chr_banks(&mut self) {
if self.get_chr_mode() == 0 {
// 8KB mode: switch entire $0000-$1FFF, ignore low bit
let bank_8k = ((self.chr_bank_0 & 0x1E) >> 1) as i16;
self.base.select_chr_page(0, bank_8k * 2);
self.base.select_chr_page(1, bank_8k * 2 + 1);
} else {
// 4KB mode: two separate 4KB banks
self.base
.select_chr_page(0, (self.chr_bank_0 & 0x1F) as i16);
self.base
.select_chr_page(1, (self.chr_bank_1 & 0x1F) as i16);
}
}
fn uses_fixed_32kb_prg_mapping(&self) -> bool {
self.submapper == MMC1_SUBMAPPER_FIXED_32KB_PRG
}
}
impl Mapper for MMC1Mapper {
fn base(&self) -> &BaseMapper {
&self.base
}
fn base_mut(&mut self) -> &mut BaseMapper {
&mut self.base
}
fn read_prg(&self, addr: u16) -> u8 {
match addr {
0x6000..=0x7FFF => {
if !self.is_wram_enabled() {
return 0; // Return 0 when WRAM is disabled (open bus behavior)
}
let offset = self.prg_ram_bank_offset(addr);
self.prg_ram.get(offset).copied().unwrap_or(0)
}
0x8000..=0xFFFF => self.base.read_prg_banked(addr),
_ => 0,
}
}
fn read_prg_open_bus(&self, addr: u16, open_bus: u8) -> u8 {
match addr {
0x6000..=0x7FFF => {
if !self.is_wram_enabled() {
return open_bus;
}
self.read_prg(addr)
}
_ => {
if addr < 0x6000 {
open_bus
} else {
self.read_prg(addr)
}
}
}
}
fn write_prg(&mut self, addr: u16, value: u8) {
match addr {
0x6000..=0x7FFF => {
if !self.is_wram_enabled() {
return; // Ignore writes when WRAM is disabled
}
let offset = self.prg_ram_bank_offset(addr);
if offset < self.prg_ram.len() {
self.prg_ram[offset] = value;
}
}
0x8000..=0xFFFF => {
self.write_register(addr, value);
}
_ => {}
}
}
fn wram_size(&self) -> usize {
self.prg_ram.len()
}
fn wram_snapshot(&self) -> Vec<u8> {
self.prg_ram.clone()
}
fn load_wram_snapshot(&mut self, data: &[u8]) {
let to_copy = data.len().min(self.prg_ram.len());
self.prg_ram[..to_copy].copy_from_slice(&data[..to_copy]);
}
fn initialize_ram(&mut self, mode: crate::console::RamInitMode) {
crate::console::initialize_ram(&mut self.prg_ram, mode);
self.base.initialize_ram(mode); // Only initializes CHR-RAM (no PRG-RAM in base)
}
fn registers_snapshot(&self) -> Vec<u8> {
// Serialize MMC1 internal registers:
// [0]: shift_register
// [1]: write_count
// [2]: control
// [3]: chr_bank_0
// [4]: chr_bank_1
// [5]: prg_bank
// [6..=13]: cpu_cycle_count (u64 LE)
// [14..=21]: last_write_cycle (u64 LE)
// [22]: has_last_write (0 or 1)
// [23..=24]: last_chr_reg_addr (u16 LE)
vec![
self.shift_register,
self.write_count,
self.control,
self.chr_bank_0,
self.chr_bank_1,
self.prg_bank,
(self.cpu_cycle_count & 0xFF) as u8,
((self.cpu_cycle_count >> 8) & 0xFF) as u8,
((self.cpu_cycle_count >> 16) & 0xFF) as u8,
((self.cpu_cycle_count >> 24) & 0xFF) as u8,
((self.cpu_cycle_count >> 32) & 0xFF) as u8,
((self.cpu_cycle_count >> 40) & 0xFF) as u8,
((self.cpu_cycle_count >> 48) & 0xFF) as u8,
((self.cpu_cycle_count >> 56) & 0xFF) as u8,
(self.last_write_cycle & 0xFF) as u8,
((self.last_write_cycle >> 8) & 0xFF) as u8,
((self.last_write_cycle >> 16) & 0xFF) as u8,
((self.last_write_cycle >> 24) & 0xFF) as u8,
((self.last_write_cycle >> 32) & 0xFF) as u8,
((self.last_write_cycle >> 40) & 0xFF) as u8,
((self.last_write_cycle >> 48) & 0xFF) as u8,
((self.last_write_cycle >> 56) & 0xFF) as u8,
self.has_last_write as u8,
(self.last_chr_reg_addr & 0xFF) as u8,
((self.last_chr_reg_addr >> 8) & 0xFF) as u8,
]
}
fn restore_registers(&mut self, data: &[u8]) {
if data.len() >= 6 {
self.shift_register = data[0];
self.write_count = data[1];
self.control = data[2];
self.chr_bank_0 = data[3];
self.chr_bank_1 = data[4];
self.prg_bank = data[5];
}
if data.len() >= 22 {
self.cpu_cycle_count = u64::from_le_bytes([
data[6], data[7], data[8], data[9], data[10], data[11], data[12], data[13],
]);
self.last_write_cycle = u64::from_le_bytes([
data[14], data[15], data[16], data[17], data[18], data[19], data[20], data[21],
]);
self.has_last_write = true;
}
if data.len() >= 23 {
self.has_last_write = data[22] != 0;
}
if data.len() >= 25 {
self.last_chr_reg_addr = u16::from_le_bytes([data[23], data[24]]);
}
self.update_banks();
}
fn cpu_cycle(&mut self) {
// Increment CPU cycle counter for consecutive-write detection
self.cpu_cycle_count += 1;
}
fn capabilities(&self) -> MapperCapabilities {
MapperCapabilities {
has_irq: false,
has_chr_banking: true,
has_dynamic_mirroring: true,
has_expansion_audio: false,
max_prg_ram_kb: (self.prg_ram.len() / 1024).max(8),
prg_bank_size_kb: 16,
chr_bank_size_kb: 4,
trainer_jsr: false,
..Default::default()
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::cartridge::mapper::{MapperContext, create_mapper};
const TEST_PRG_ROM_SIZE: usize = 128 * 1024;
const TEST_CHR_ROM_SIZE: usize = 8 * 1024;
/// Helper function to write a 5-bit value to a register using the MMC1 shift mechanism
fn write_register<M: Mapper + ?Sized>(mapper: &mut M, addr: u16, value: u8) {
for i in 0..5 {
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(addr, (value >> i) & 0x01);
}
}
fn create_mmc1_mapper(
prg_rom: Vec<u8>,
chr_rom: Vec<u8>,
mirroring: NametableLayout,
) -> Box<dyn Mapper> {
create_mapper(MapperContext::new_for_test(1, prg_rom, chr_rom, mirroring))
.expect("MMC1 (mapper 1) should be implemented")
}
fn create_mmc1_timing_test_mapper() -> MMC1Mapper {
MMC1Mapper::new(MapperContext::new_for_test(
1,
vec![0; PRG_BANK_SIZE * 2],
vec![],
NametableLayout::Horizontal,
))
}
fn create_revision_test_mapper(revision: Mmc1Revision) -> MMC1Mapper {
MMC1Mapper::new_with_revision(
vec![0; TEST_PRG_ROM_SIZE],
vec![0; TEST_CHR_ROM_SIZE],
NametableLayout::Horizontal,
revision,
)
}
#[test]
fn test_mmc1_shift_register_load() {
// MMC1 requires 5 sequential writes to load a register
// Each write shifts bit 0 into the shift register
// Writing with bit 7 set resets the shift register and control register
let prg_rom = vec![0; 128 * 1024]; // 128KB = 8 banks of 16KB
let chr_rom = vec![0; 32 * 1024]; // 32KB = 8 banks of 4KB
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Load value 0b00011 (3) into control register at $8000-$9FFF
// This requires 5 writes, each with bit 0 containing the next bit of the value
write_register(&mut *mapper, 0x8000, 0b00011);
// After loading 0b00011 into control register:
// Bits 0-1: Mirroring = 0b11 = Horizontal
// Bits 2-3: PRG ROM bank mode = 0b00
// Bit 4: CHR ROM bank mode = 0
assert_eq!(mapper.get_mirroring(), NametableLayout::Horizontal);
}
#[test]
fn test_mmc1_registers_snapshot_preserves_write_ignore_timing() {
let mut mapper = create_mmc1_timing_test_mapper();
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01);
let saved = mapper.registers_snapshot();
let mut restored = create_mmc1_timing_test_mapper();
restored.restore_registers(&saved);
let before = restored.registers_snapshot();
restored.write_prg(0x8000, 0x00);
let after = restored.registers_snapshot();
assert_eq!(
after, before,
"consecutive write should be ignored when cpu_cycle_count matches last_write_cycle"
);
}
#[test]
fn test_mmc1_ignores_write_on_immediately_following_cycle() {
let mut mapper = create_mmc1_timing_test_mapper();
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01);
let shift_register_after_first = mapper.shift_register;
let write_count_after_first = mapper.write_count;
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x00);
assert_eq!(
mapper.shift_register, shift_register_after_first,
"write on immediately following cycle should be ignored"
);
assert_eq!(
mapper.write_count, write_count_after_first,
"write counter should not advance for ignored consecutive-cycle writes"
);
}
#[test]
fn test_mmc1_ignores_consecutive_write_without_cpu_cycle_ticks() {
let mut mapper = create_mmc1_timing_test_mapper();
mapper.write_prg(0x8000, 0x01);
assert_eq!(mapper.write_count, 1);
mapper.write_prg(0x8000, 0x00);
assert_eq!(
mapper.write_count, 1,
"consecutive write should be ignored even when cpu_cycle() was not called"
);
}
#[test]
fn test_mmc1_shift_register_reset() {
// Writing with bit 7 set should reset the shift register
let prg_rom = vec![0; 256 * 1024];
let chr_rom = vec![0; 128 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Start loading a value
mapper.write_prg(0x8000, 0b00000001);
mapper.write_prg(0x8000, 0b00000001);
mapper.write_prg(0x8000, 0b00000001);
// Reset the shift register (bit 7 set)
mapper.write_prg(0x8000, 0b10000000);
// Control register should be reset to default: PRG mode 3 (fix last bank)
// Start a new load with value 0b00000 (mirroring mode 0 = one screen lower)
for _ in 0..5 {
mapper.write_prg(0x8000, 0b00000000);
}
assert_eq!(mapper.get_mirroring(), NametableLayout::SingleScreenLower);
}
#[test]
fn test_mmc1_control_register_mirroring() {
// Control register bits 0-1 control mirroring:
// 0: one-screen, lower bank
// 1: one-screen, upper bank
// 2: vertical
// 3: horizontal
let prg_rom = vec![0; 256 * 1024];
let chr_rom = vec![0; 128 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Load 0b00000 (mirroring = 0 = SingleScreenLower)
write_register(&mut *mapper, 0x8000, 0b00000);
assert_eq!(mapper.get_mirroring(), NametableLayout::SingleScreenLower);
// Load 0b00001 (mirroring = 1 = SingleScreenUpper)
write_register(&mut *mapper, 0x8000, 0b00001);
assert_eq!(mapper.get_mirroring(), NametableLayout::SingleScreenUpper);
// Load 0b00010 (mirroring = 2 = Vertical)
write_register(&mut *mapper, 0x8000, 0b00010);
assert_eq!(mapper.get_mirroring(), NametableLayout::Vertical);
// Load 0b00011 (mirroring = 3 = Horizontal)
write_register(&mut *mapper, 0x8000, 0b00011);
assert_eq!(mapper.get_mirroring(), NametableLayout::Horizontal);
}
#[test]
fn test_mmc1_prg_bank_mode_0_32kb() {
// PRG ROM bank mode 0 or 1: switch 32 KB at $8000, ignoring low bit of bank number
let mut prg_rom = vec![0; 256 * 1024]; // 256KB = 16 banks of 16KB = 8 banks of 32KB
// Fill each 32KB bank with a unique value
for bank in 0..8 {
let start = bank * 32 * 1024;
let end = start + 32 * 1024;
for byte in &mut prg_rom[start..end] {
*byte = (bank + 10) as u8;
}
}
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Set control register to PRG mode 0 (bits 2-3 = 0b00) and mirroring
// Value: 0b00000 (mirroring=0, prg_mode=0, chr_mode=0)
write_register(&mut *mapper, 0x8000, 0b00000);
// Select 32KB bank 0 via PRG bank register (address $E000-$FFFF)
// Load value 0b00000 (bank 0)
write_register(&mut *mapper, 0xE000, 0b00000);
assert_eq!(mapper.read_prg(0x8000), 10);
assert_eq!(mapper.read_prg(0xC000), 10);
// Select 32KB bank 1 (write 0b00010 = 2, but low bit ignored, so bank 1)
write_register(&mut *mapper, 0xE000, 0b00010);
assert_eq!(mapper.read_prg(0x8000), 11);
assert_eq!(mapper.read_prg(0xC000), 11);
}
#[test]
fn test_mmc1_prg_bank_mode_2_fix_first() {
// PRG ROM bank mode 2: fix first bank at $8000 and switch 16 KB bank at $C000
let mut prg_rom = vec![0; 256 * 1024]; // 256KB = 16 banks of 16KB
// Fill each 16KB bank with a unique value
for bank in 0..16 {
let start = bank * 16 * 1024;
let end = start + 16 * 1024;
for byte in &mut prg_rom[start..end] {
*byte = (bank + 20) as u8;
}
}
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Set control register to PRG mode 2 (bits 2-3 = 0b10)
// Value: 0b01000 (mirroring=0, prg_mode=2, chr_mode=0)
write_register(&mut *mapper, 0x8000, 0b01000);
// First bank at $8000 should be fixed to bank 0
assert_eq!(mapper.read_prg(0x8000), 20);
// Select bank 3 at $C000
write_register(&mut *mapper, 0xE000, 0b00011);
assert_eq!(mapper.read_prg(0x8000), 20); // First bank still fixed
assert_eq!(mapper.read_prg(0xC000), 23); // Bank 3 at $C000
}
#[test]
fn test_mmc1_prg_bank_mode_3_fix_last() {
// PRG ROM bank mode 3: fix last bank at $C000 and switch 16 KB bank at $8000
let mut prg_rom = vec![0; 256 * 1024]; // 256KB = 16 banks of 16KB
// Fill each 16KB bank with a unique value
for bank in 0..16 {
let start = bank * 16 * 1024;
let end = start + 16 * 1024;
for byte in &mut prg_rom[start..end] {
*byte = (bank + 30) as u8;
}
}
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Set control register to PRG mode 3 (bits 2-3 = 0b11) - this is the default
// Value: 0b01100 (mirroring=0, prg_mode=3, chr_mode=0)
write_register(&mut *mapper, 0x8000, 0b01100);
// Last bank at $C000 should be fixed to bank 15 (last bank)
assert_eq!(mapper.read_prg(0xC000), 45); // Bank 15 = 30 + 15
// Select bank 2 at $8000
write_register(&mut *mapper, 0xE000, 0b00010);
assert_eq!(mapper.read_prg(0x8000), 32); // Bank 2 at $8000
assert_eq!(mapper.read_prg(0xC000), 45); // Last bank still fixed
}
#[test]
fn test_mmc1_chr_bank_mode_0_8kb() {
// CHR ROM bank mode 0: switch 8 KB at a time
let mut chr_rom = vec![0; 128 * 1024]; // 128KB = 16 banks of 8KB
// Fill each 8KB bank with a unique value
for bank in 0..16 {
let start = bank * 8 * 1024;
let end = start + 8 * 1024;
for byte in &mut chr_rom[start..end] {
*byte = (bank + 40) as u8;
}
}
let prg_rom = vec![0; 32 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Set control register to CHR mode 0 (bit 4 = 0)
// Value: 0b00000 (mirroring=0, prg_mode=0, chr_mode=0)
write_register(&mut *mapper, 0x8000, 0b00000);
// Select 8KB bank 2 via CHR bank 0 register (address $A000-$BFFF)
// In 8KB mode, only CHR bank 0 matters, and low bit is ignored
// Load value 0b00100 (4, but low bit ignored = bank 2)
write_register(&mut *mapper, 0xA000, 0b00100);
assert_eq!(mapper.read_chr(0x0000), 42); // Bank 2
assert_eq!(mapper.read_chr(0x1000), 42); // Still bank 2
}
#[test]
fn test_mmc1_chr_bank_mode_1_4kb() {
// CHR ROM bank mode 1: switch two separate 4 KB banks
let mut chr_rom = vec![0; 128 * 1024]; // 128KB = 32 banks of 4KB
// Fill each 4KB bank with a unique value
for bank in 0..32 {
let start = bank * 4 * 1024;
let end = start + 4 * 1024;
for byte in &mut chr_rom[start..end] {
*byte = (bank + 50) as u8;
}
}
let prg_rom = vec![0; 32 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Set control register to CHR mode 1 (bit 4 = 1)
// Value: 0b10000 (mirroring=0, prg_mode=0, chr_mode=1)
write_register(&mut *mapper, 0x8000, 0b10000);
// Select 4KB bank 3 at $0000 via CHR bank 0 register
write_register(&mut *mapper, 0xA000, 0b00011);
assert_eq!(mapper.read_chr(0x0000), 53); // Bank 3 at $0000
// Select 4KB bank 5 at $1000 via CHR bank 1 register
write_register(&mut *mapper, 0xC000, 0b00101);
assert_eq!(mapper.read_chr(0x0000), 53); // Bank 3 still at $0000
assert_eq!(mapper.read_chr(0x1000), 55); // Bank 5 at $1000
}
#[test]
fn test_mmc1_prg_ram_support() {
// MMC1 should support 8KB PRG-RAM at $6000-$7FFF
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Write to PRG-RAM
mapper.write_prg(0x6000, 0xAA);
mapper.write_prg(0x7000, 0xBB);
mapper.write_prg(0x7FFF, 0xCC);
// Read back
assert_eq!(mapper.read_prg(0x6000), 0xAA);
assert_eq!(mapper.read_prg(0x7000), 0xBB);
assert_eq!(mapper.read_prg(0x7FFF), 0xCC);
}
#[test]
fn test_mmc1_chr_ram_when_no_chr_rom() {
// If CHR ROM is empty, MMC1 should use CHR-RAM
let prg_rom = vec![0; 128 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, vec![], NametableLayout::Horizontal);
// Initially should read 0
assert_eq!(mapper.read_chr(0x0000), 0x00);
// Write to CHR-RAM
mapper.write_chr(0x0000, 0xAA);
mapper.write_chr(0x1000, 0xBB);
mapper.write_chr(0x1FFF, 0xCC);
// Read back the values
assert_eq!(mapper.read_chr(0x0000), 0xAA);
assert_eq!(mapper.read_chr(0x1000), 0xBB);
assert_eq!(mapper.read_chr(0x1FFF), 0xCC);
}
#[test]
fn test_mmc1_shift_register_power_on_state() {
// MMC1 hardware shift register should start at 0x10 (bit 4 set)
// This means the first write will shift bit 4 right and OR in bit 0
// After 5 writes, the shift register should contain the 5-bit value
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Write sequence: 1, 0, 1, 0, 1 should result in value 0b10101
// With proper power-on state (0x10), after 5 writes we should see the bit pattern
write_register(&mut *mapper, 0x8000, 0b10101);
// The control register should now contain 0b10101 (mirroring = 0b01 = SingleScreenUpper)
assert_eq!(mapper.get_mirroring(), NametableLayout::SingleScreenUpper);
}
#[test]
fn test_mmc1_shift_register_reset_clears_to_power_on_state() {
// After reset, the shift register should go back to 0x10
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Do some writes
mapper.write_prg(0x8000, 0b00000001);
mapper.write_prg(0x8000, 0b00000001);
// Reset with bit 7 set
mapper.write_prg(0x8000, 0b10000000);
// Now write a sequence and verify it works correctly
// Write 5 ones: should result in 0b11111 after loading
write_register(&mut *mapper, 0x8000, 0b11111);
// Control register should be 0b11111 (mirroring = 0b11 = Horizontal)
assert_eq!(mapper.get_mirroring(), NametableLayout::Horizontal);
}
#[test]
fn test_mmc1_wram_enable_disable() {
// PRG bank register bit 4 controls WRAM enable/disable
// When bit 4 is set (1), WRAM is disabled
// When bit 4 is clear (0), WRAM is enabled
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Initially WRAM should be enabled (prg_bank defaults to 0)
mapper.write_prg(0x6000, 0xAA);
assert_eq!(mapper.read_prg(0x6000), 0xAA);
// Disable WRAM by setting bit 4 of prg_bank register ($E000-$FFFF)
// To load 0b10000 into the shift register, write the bit sequence: 0,0,0,0,1
// The shift register starts at 0x10, shifts right, and ORs each bit at position 4
// After 5 writes, this produces: 0b10000 (bit 4 set = WRAM disabled)
write_register(&mut *mapper, 0xE000, 0b10000);
// With WRAM disabled, reads should return 0 (open bus behavior)
assert_eq!(mapper.read_prg(0x6000), 0x00);
// Writes should be ignored
mapper.write_prg(0x6000, 0xBB);
assert_eq!(mapper.read_prg(0x6000), 0x00); // Still reads 0, not 0xBB
// Re-enable WRAM by clearing bit 4
// Write 0b00000 to prg_bank register
write_register(&mut *mapper, 0xE000, 0b00000);
// With WRAM enabled again, writes should work
mapper.write_prg(0x6000, 0xCC);
assert_eq!(mapper.read_prg(0x6000), 0xCC);
// Previous write while disabled should not have affected memory
// (we wrote 0xBB at 0x6000 while disabled, but it was ignored)
mapper.write_prg(0x6001, 0xDD);
assert_eq!(mapper.read_prg(0x6001), 0xDD);
}
#[test]
fn test_mmc1_wram_disable_multiple_addresses() {
// Verify WRAM disable affects the entire WRAM range ($6000-$7FFF)
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_mmc1_mapper(prg_rom, chr_rom, NametableLayout::Horizontal);
// Write to various WRAM addresses while enabled
mapper.write_prg(0x6000, 0x11);
mapper.write_prg(0x7000, 0x22);
mapper.write_prg(0x7FFF, 0x33);
// Verify writes worked
assert_eq!(mapper.read_prg(0x6000), 0x11);
assert_eq!(mapper.read_prg(0x7000), 0x22);
assert_eq!(mapper.read_prg(0x7FFF), 0x33);
// Disable WRAM (set bit 4 of prg_bank)
// Write sequence: 0,0,0,0,1 to load 0b10000
write_register(&mut *mapper, 0xE000, 0b10000); // Loads 0b10000 (bit 4 set)
// All WRAM reads should return 0
assert_eq!(mapper.read_prg(0x6000), 0x00);
assert_eq!(mapper.read_prg(0x7000), 0x00);
assert_eq!(mapper.read_prg(0x7FFF), 0x00);
// All WRAM writes should be ignored
mapper.write_prg(0x6000, 0x44);
mapper.write_prg(0x7000, 0x55);
mapper.write_prg(0x7FFF, 0x66);
assert_eq!(mapper.read_prg(0x6000), 0x00);
assert_eq!(mapper.read_prg(0x7000), 0x00);
assert_eq!(mapper.read_prg(0x7FFF), 0x00);
}
#[test]
fn test_mmc1a_wram_always_enabled() {
// MMC1A revision: PRG-RAM is always enabled, bit 4 is ignored
let mut mapper = create_revision_test_mapper(Mmc1Revision::Mmc1A);
// Write to WRAM while enabled
mapper.write_prg(0x6000, 0xAA);
mapper.write_prg(0x7000, 0xBB);
mapper.write_prg(0x7FFF, 0xCC);
// Verify writes worked
assert_eq!(mapper.read_prg(0x6000), 0xAA);
assert_eq!(mapper.read_prg(0x7000), 0xBB);
assert_eq!(mapper.read_prg(0x7FFF), 0xCC);
// Try to disable WRAM by setting bit 4 of prg_bank register ($E000-$FFFF)
// Load 0b10000 (bit 4 set)
write_register(&mut mapper, 0xE000, 0b10000);
// On MMC1A, WRAM should still be enabled (bit 4 is ignored)
// Reads should return the previously written values
assert_eq!(mapper.read_prg(0x6000), 0xAA);
assert_eq!(mapper.read_prg(0x7000), 0xBB);
assert_eq!(mapper.read_prg(0x7FFF), 0xCC);
// Writes should still work
mapper.write_prg(0x6000, 0xDD);
mapper.write_prg(0x7000, 0xEE);
mapper.write_prg(0x7FFF, 0xFF);
assert_eq!(mapper.read_prg(0x6000), 0xDD);
assert_eq!(mapper.read_prg(0x7000), 0xEE);
assert_eq!(mapper.read_prg(0x7FFF), 0xFF);
}
#[test]
fn test_mmc1b_wram_enable_disable() {
// MMC1B revision: PRG-RAM can be disabled via bit 4
let mut mapper = create_revision_test_mapper(Mmc1Revision::Mmc1B);
// Initially WRAM should be disabled on MMC1B power-on
assert_eq!(mapper.read_prg(0x6000), 0x00);
// Enable WRAM by clearing bit 4 of PRG bank register
write_register(&mut mapper, 0xE000, 0b00000);
// With WRAM enabled, writes should work
mapper.write_prg(0x6000, 0xAA);
assert_eq!(mapper.read_prg(0x6000), 0xAA);
// Disable WRAM by setting bit 4 of prg_bank register
write_register(&mut mapper, 0xE000, 0b10000);
// With WRAM disabled, reads should return 0
assert_eq!(mapper.read_prg(0x6000), 0x00);
// Writes should be ignored
mapper.write_prg(0x6000, 0xBB);
assert_eq!(mapper.read_prg(0x6000), 0x00); // Still reads 0, not 0xBB
// Re-enable WRAM by clearing bit 4
write_register(&mut mapper, 0xE000, 0b00000);
// With WRAM enabled again, writes should work
mapper.write_prg(0x6000, 0xCC);
assert_eq!(mapper.read_prg(0x6000), 0xCC);
// Previous write while disabled should not have affected memory
mapper.write_prg(0x6001, 0xDD);
assert_eq!(mapper.read_prg(0x6001), 0xDD);
}
#[test]
fn test_mmc1b_power_on_defaults_wram_to_disabled() {
let mapper = create_revision_test_mapper(Mmc1Revision::Mmc1B);
assert!(
!mapper.is_wram_enabled(),
"MMC1B should power on with WRAM disabled by default"
);
}
#[test]
fn test_mmc1_default_revision_is_mmc1b() {
// Default constructor should use MMC1B for backward compatibility
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom,
chr_rom,
NametableLayout::Horizontal,
));
// Write to WRAM
mapper.write_prg(0x6000, 0xAA);
assert_eq!(mapper.read_prg(0x6000), 0xAA);
// Disable WRAM (should work on MMC1B)
write_register(&mut mapper, 0xE000, 0b10000);
// Should be disabled (reads 0)
assert_eq!(mapper.read_prg(0x6000), 0x00);
}
#[test]
fn test_mmc1a_prg_bit4_enables_a17_bypass_for_fixed_last_bank() {
let mut prg_rom = vec![0; 16 * PRG_BANK_SIZE];
let chr_rom = vec![0; 8 * 1024];
for bank in 0..16 {
let start = bank * PRG_BANK_SIZE;
let end = start + PRG_BANK_SIZE;
for byte in &mut prg_rom[start..end] {
*byte = bank as u8;
}
}
let mut mapper = MMC1Mapper::new_with_revision(
prg_rom,
chr_rom,
NametableLayout::Horizontal,
Mmc1Revision::Mmc1A,
);
// PRG mode 3 (switch $8000, fixed $C000)
write_register(&mut mapper, 0x8000, 0b01100);
// bit4=1 enables MMC1A bypass, bit3=0 drives A17 low
write_register(&mut mapper, 0xE000, 0b10000);
// MMC1A bypass applies A17 from bit3 to fixed-bank path, selecting bank 7
assert_eq!(mapper.read_prg(0xC000), 7);
}
#[test]
fn test_mmc1b_prg_bit4_does_not_change_fixed_last_bank() {
let mut prg_rom = vec![0; 16 * PRG_BANK_SIZE];
let chr_rom = vec![0; 8 * 1024];
for bank in 0..16 {
let start = bank * PRG_BANK_SIZE;
let end = start + PRG_BANK_SIZE;
for byte in &mut prg_rom[start..end] {
*byte = bank as u8;
}
}
let mut mapper = MMC1Mapper::new_with_revision(
prg_rom,
chr_rom,
NametableLayout::Horizontal,
Mmc1Revision::Mmc1B,
);
// PRG mode 3 (switch $8000, fixed $C000)
write_register(&mut mapper, 0x8000, 0b01100);
// On MMC1B, bit4 is WRAM control only; fixed bank remains last bank
write_register(&mut mapper, 0xE000, 0b10000);
assert_eq!(mapper.read_prg(0xC000), 15);
}
#[test]
fn test_mmc1_consecutive_write_ignore() {
// MMC1 should ignore consecutive-cycle writes to prevent RMW instructions
// from shifting two bits. Reset writes (bit 7 set) are never ignored.
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom,
chr_rom,
NametableLayout::Horizontal,
));
// Advance to cycle 1 for first write
mapper.cpu_cycle(); // cycle = 1
// First write on cycle 1: shift in bit 1 (write_count = 1)
mapper.write_prg(0x8000, 0x01);
assert_eq!(mapper.write_count, 1);
// Immediately write again on same cycle (simulates RMW) - should be IGNORED
mapper.write_prg(0x8000, 0x01);
assert_eq!(mapper.write_count, 1);
// Advance to cycle 2 - should still be ignored (immediately following cycle)
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x00);
assert_eq!(mapper.write_count, 1);
// Advance to cycle 3 without writing
mapper.cpu_cycle();
// Advance to cycle 4 - now accepted (2 cycles since last write attempt)
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x00);
assert_eq!(mapper.write_count, 2);
}
#[test]
fn test_mmc1_consecutive_reset_not_ignored() {
// Reset writes (bit 7 set) should never be ignored, even if consecutive
let prg_rom = vec![0; 128 * 1024];
let chr_rom = vec![0; 8 * 1024];
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom,
chr_rom,
NametableLayout::Horizontal,
));
// Start loading a value
mapper.write_prg(0x8000, 0x01);
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01);
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01);
// Consecutive reset write - should NOT be ignored
mapper.write_prg(0x8000, 0x80); // Reset
// The shift register should be reset
// Load a new value: 0b00000 (all zeros)
for _ in 0..5 {
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x00);
}
// Should have mirroring mode 0 = SingleScreenLower
assert_eq!(mapper.get_mirroring(), NametableLayout::SingleScreenLower);
}
#[test]
fn test_mmc1_comprehensive_state_roundtrip() {
// Test round-trip of complete MMC1 state including all registers and banking modes
let mut prg_rom = vec![0; 256 * 1024]; // 256KB = 16 banks
let mut chr_rom = vec![0; 128 * 1024]; // 128KB = 32 4KB banks
// Fill PRG ROM with bank-specific data
for bank in 0..16 {
let start = bank * 16 * 1024;
let end = start + 16 * 1024;
for byte in &mut prg_rom[start..end] {
*byte = bank as u8;
}
}
// Fill CHR ROM with bank-specific data
for bank in 0..32 {
let start = bank * 4 * 1024;
let end = start + 4 * 1024;
for byte in &mut chr_rom[start..end] {
*byte = (bank + 100) as u8;
}
}
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom.clone(),
chr_rom.clone(),
NametableLayout::Horizontal,
));
// Configure complex state with all registers
// Control register: CHR mode 1 (two 4KB banks), PRG mode 3 (switch at $8000, fixed last at $C000), horizontal mirroring
// Control value: bits 0-1 = 11 (horizontal), bits 2-3 = 11 (PRG mode 3), bit 4 = 1 (CHR mode 1)
// = 0b11111 = 31
for i in 0..5 {
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0x8000, (31 >> i) & 0x01); // Control = 31
}
// CHR bank 0: Select bank 5
for i in 0..5 {
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0xA000, (5 >> i) & 0x01);
}
// CHR bank 1: Select bank 10
for i in 0..5 {
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0xC000, (10 >> i) & 0x01);
}
// PRG bank: Select bank 7
for i in 0..5 {
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0xE000, (7 >> i) & 0x01);
}
// Write to PRG-RAM
for i in 0..256 {
mapper.write_prg(0x6000 + i, (i & 0xFF) as u8);
}
// Verify state before snapshot
assert_eq!(mapper.get_mirroring(), NametableLayout::Horizontal);
assert_eq!(mapper.read_chr(0x0000), 105); // CHR bank 5
assert_eq!(mapper.read_chr(0x1000), 110); // CHR bank 10
assert_eq!(mapper.read_prg(0x8000), 7); // Switchable bank 7 (PRG mode 3)
assert_eq!(mapper.read_prg(0xC000), 15); // Fixed last bank (bank 15 = last of 16)
assert_eq!(mapper.read_prg(0x6000), 0); // PRG-RAM
// Take snapshot
let registers = mapper.registers_snapshot();
let prg_ram = mapper.wram_snapshot();
let chr_ram = mapper.chr_ram_snapshot();
// Create fresh mapper and restore
let mut restored = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom,
chr_rom,
NametableLayout::Vertical,
));
restored.restore_registers(®isters);
restored.load_wram_snapshot(&prg_ram);
restored.restore_chr_ram(&chr_ram);
// Verify all state is restored correctly
assert_eq!(restored.get_mirroring(), NametableLayout::Horizontal);
assert_eq!(restored.read_chr(0x0000), 105); // CHR bank 5
assert_eq!(restored.read_chr(0x1000), 110); // CHR bank 10
assert_eq!(restored.read_prg(0x8000), 7); // Switchable bank 7
assert_eq!(restored.read_prg(0xC000), 15); // Fixed last bank
assert_eq!(restored.read_prg(0x6000), 0); // PRG-RAM restored
assert_eq!(restored.read_prg(0x60FF), 0xFF); // PRG-RAM restored
}
#[test]
fn test_mmc1_shift_register_mid_write_roundtrip() {
// Test that a partially-loaded shift register is preserved across save/load
let prg_rom = vec![0; 256 * 1024];
let chr_rom = vec![0; 128 * 1024];
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom.clone(),
chr_rom.clone(),
NametableLayout::Horizontal,
));
// Start writing to control register but don't finish
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01); // 1st bit
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x01); // 2nd bit
mapper.cpu_cycle();
mapper.cpu_cycle();
mapper.write_prg(0x8000, 0x00); // 3rd bit (now shift_register has 0b00000101, write_count=3)
// Take snapshot mid-write
let registers = mapper.registers_snapshot();
// Restore to new mapper
let mut restored = MMC1Mapper::new(MapperContext::new_for_test(
1,
prg_rom,
chr_rom,
NametableLayout::Horizontal,
));
restored.restore_registers(®isters);
// Complete the write sequence
restored.cpu_cycle();
restored.cpu_cycle();
restored.write_prg(0x8000, 0x01); // 4th bit
restored.cpu_cycle();
restored.cpu_cycle();
restored.write_prg(0x8000, 0x01); // 5th bit (completes write sequence)
// The control register should now be set to 0b11011 = 27
// Bits are loaded LSB first: 1, 1, 0, 1, 1
// Mirroring mode (bits 0-1): 11 = Horizontal
// PRG mode (bits 2-3): 01 = mode 1
// CHR mode (bit 4): 1 = two 4KB banks
assert_eq!(restored.get_mirroring(), NametableLayout::Horizontal);
}
/// Test MMC1 disabled WRAM returns open-bus
///
/// MMC1B/C can disable WRAM via bit 4 of the PRG bank register ($E000-$FFFF).
/// When disabled, reads from $6000-$7FFF should return open-bus.
#[test]
fn test_mmc1_disabled_wram_returns_open_bus() {
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
vec![0; 256 * 1024],
vec![],
NametableLayout::Horizontal,
));
// First, enable WRAM and write some data
// Write to $E000-$FFFF controls PRG banking and WRAM enable
// We need to do 5 consecutive writes to load the shift register
// Reset shift register
mapper.write_prg(0x8000, 0x80);
// Write pattern to enable WRAM: bit 4 = 0
write_register(&mut mapper, 0xE000, 0x00);
// Write to WRAM
mapper.write_prg(0x6000, 0xAA);
mapper.write_prg(0x7000, 0xBB);
// Verify WRAM reads work when enabled
assert_eq!(mapper.read_prg(0x6000), 0xAA);
assert_eq!(mapper.read_prg(0x7000), 0xBB);
// Now disable WRAM by setting bit 4 = 1 in PRG bank register
// Reset shift register
mapper.write_prg(0x8000, 0x80);
// Write pattern to disable WRAM: bit 4 = 1
write_register(&mut mapper, 0xE000, 0x10);
// read_prg should return 0 for backward compatibility
assert_eq!(mapper.read_prg(0x6000), 0x00);
assert_eq!(mapper.read_prg(0x7000), 0x00);
// read_prg_open_bus should return the open-bus value
let open_bus = 0x42;
assert_eq!(
mapper.read_prg_open_bus(0x6000, open_bus),
open_bus,
"Disabled WRAM should return open-bus at $6000"
);
assert_eq!(
mapper.read_prg_open_bus(0x7000, open_bus),
open_bus,
"Disabled WRAM should return open-bus at $7000"
);
assert_eq!(
mapper.read_prg_open_bus(0x7FFF, open_bus),
open_bus,
"Disabled WRAM should return open-bus at $7FFF"
);
}
// ===== SxROM Variant Tests (Issue #327) =====
/// SUROM: 512KB PRG-ROM — CHR bank 0 bit 4 selects 256KB outer PRG-ROM bank.
///
/// The 5-bit CHR bank register has bit 4 repurposed as PRG-ROM A18 on SUROM boards.
/// This allows addressing 512KB of PRG-ROM even though the PRG bank register only holds
/// the low 4 bits (0-15 within the active 256KB half).
#[test]
fn test_mmc1_surom_outer_prg_bank_selection() {
// 512KB PRG-ROM = 32 × 16KB banks; fill each bank with its bank number
let mut prg_rom = vec![0u8; 512 * 1024];
for bank in 0..32usize {
let offset = bank * PRG_BANK_SIZE;
prg_rom[offset..offset + PRG_BANK_SIZE].fill(bank as u8);
}
let mut mapper = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom, vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(1),
);
// PRG mode 3 (default): $8000 switches 16KB, last bank fixed at $C000
// Select PRG bank 0 in lower half (outer bank bit = 0)
write_register(&mut mapper, 0xA000, 0x00); // chr_bank_0 = 0 (outer=0, bank 0)
write_register(&mut mapper, 0xE000, 0x00); // prg_bank = 0
assert_eq!(
mapper.read_prg(0x8000),
0,
"With outer bank 0, bank 0 fills $8000"
);
// Now set chr_bank_0 bit 4 = 1 → switch to upper 256KB outer bank
write_register(&mut mapper, 0xA000, 0x10); // chr_bank_0 = 0x10 (outer=1, bank 16)
write_register(&mut mapper, 0xE000, 0x00); // prg_bank = 0 (within outer half)
assert_eq!(
mapper.read_prg(0x8000),
16,
"With outer bank 1, prg_bank 0 maps to ROM bank 16"
);
// Verify outer bank bit also works for non-zero inner bank
write_register(&mut mapper, 0xA000, 0x10); // outer=1
write_register(&mut mapper, 0xE000, 0x02); // inner prg_bank = 2 → bank 18
assert_eq!(
mapper.read_prg(0x8000),
18,
"Outer bank 1 + inner bank 2 maps to ROM bank 18"
);
}
#[test]
fn test_mmc1_surom_uses_last_chr_register_for_outer_bank_in_4kb_mode() {
let mut prg_rom = vec![0u8; 512 * 1024];
for bank in 0..32usize {
let offset = bank * PRG_BANK_SIZE;
prg_rom[offset..offset + PRG_BANK_SIZE].fill(bank as u8);
}
let mut mapper = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom, vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(1),
);
// Enable 4KB CHR mode and PRG mode 3
write_register(&mut mapper, 0x8000, 0b11100);
// Set CHR bank 0 outer bit low, then CHR bank 1 outer bit high.
// In 4KB CHR mode, last CHR register written should drive SUROM outer PRG bit.
write_register(&mut mapper, 0xA000, 0x00);
write_register(&mut mapper, 0xC000, 0x10);
write_register(&mut mapper, 0xE000, 0x00);
assert_eq!(
mapper.read_prg(0x8000),
16,
"with 4KB CHR mode and last write to $C000, outer PRG bank should come from CHR bank 1"
);
}
/// SOROM: 16KB PRG-RAM (2×8KB) — CHR bank 0 bit 3 selects the active PRG-RAM bank.
///
/// SOROM boards connect CHR A13 to the /CE of a second 8KB PRG-RAM chip, effectively
/// doubling the accessible PRG-RAM to 16KB via software bank selection.
#[test]
fn test_mmc1_sorom_prg_ram_banking() {
let prg_rom = vec![0u8; 256 * 1024];
let mut mapper = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom, vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(2), // 2 × 8KB = 16KB PRG-RAM → SOROM
);
// Ensure WRAM is enabled: set prg_bank bit 4 = 0
write_register(&mut mapper, 0xE000, 0x00);
// Write to PRG-RAM bank 0 (chr_bank_0 bit 3 = 0)
write_register(&mut mapper, 0xA000, 0x00); // chr_bank_0 bit 3 = 0 → bank 0
mapper.write_prg(0x6000, 0xAA);
// Switch to PRG-RAM bank 1 (chr_bank_0 bit 3 = 1)
write_register(&mut mapper, 0xA000, 0x08); // chr_bank_0 bit 3 = 1 → bank 1
mapper.write_prg(0x6000, 0xBB);
// Read back bank 0 — should still have 0xAA
write_register(&mut mapper, 0xA000, 0x00); // back to bank 0
assert_eq!(
mapper.read_prg(0x6000),
0xAA,
"PRG-RAM bank 0 should hold 0xAA independently of bank 1"
);
// Read back bank 1 — should still have 0xBB
write_register(&mut mapper, 0xA000, 0x08); // bank 1
assert_eq!(
mapper.read_prg(0x6000),
0xBB,
"PRG-RAM bank 1 should hold 0xBB independently of bank 0"
);
}
#[test]
fn test_mmc1_submapper_5_uses_fixed_32kb_prg_mapping() {
let mut prg_rom = vec![0u8; 2 * PRG_BANK_SIZE];
prg_rom[..PRG_BANK_SIZE].fill(0x11);
prg_rom[PRG_BANK_SIZE..].fill(0x22);
let mut mapper = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom, vec![], NametableLayout::Horizontal)
.with_submapper(5),
);
assert_eq!(mapper.read_prg(0x8000), 0x11);
assert_eq!(mapper.read_prg(0xC000), 0x22);
write_register(&mut mapper, 0xE000, 0b00001);
assert_eq!(
mapper.read_prg(0x8000),
0x11,
"submapper 5 should ignore PRG bank switching at $8000"
);
assert_eq!(
mapper.read_prg(0xC000),
0x22,
"submapper 5 should keep fixed upper 16KB bank at $C000"
);
}
#[test]
fn test_mmc1_submapper_7_uses_hardwired_mirroring() {
let mut mapper = MMC1Mapper::new(
MapperContext::new_for_test(
1,
vec![0u8; 2 * PRG_BANK_SIZE],
vec![],
NametableLayout::Vertical,
)
.with_submapper(7),
);
assert_eq!(mapper.get_mirroring(), NametableLayout::Vertical);
// Attempt to switch mirroring to horizontal via control register.
write_register(&mut mapper, 0x8000, 0b00011);
assert_eq!(
mapper.get_mirroring(),
NametableLayout::Vertical,
"submapper 7 should ignore dynamic mirroring writes and keep header-configured layout"
);
}
/// PRG-RAM size respected from metadata: mapper should allocate the correct amount.
#[test]
fn test_mmc1_prg_ram_size_from_metadata() {
let prg_rom = vec![0u8; 256 * 1024];
let mapper_1kb = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom.clone(), vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(1),
);
assert_eq!(
mapper_1kb.wram_size(),
8 * 1024,
"1 bank should allocate 8KB"
);
let mapper_2kb = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom.clone(), vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(2),
);
assert_eq!(
mapper_2kb.wram_size(),
16 * 1024,
"2 banks should allocate 16KB"
);
let mapper_4kb = MMC1Mapper::new(
MapperContext::new_for_test(1, prg_rom, vec![], NametableLayout::Horizontal)
.with_prg_ram_banks(4),
);
assert_eq!(
mapper_4kb.wram_size(),
32 * 1024,
"4 banks should allocate 32KB (SXROM)"
);
}
/// Test MMC1 enabled WRAM doesn't return open-bus
#[test]
fn test_mmc1_enabled_wram_returns_data() {
let mut mapper = MMC1Mapper::new(MapperContext::new_for_test(
1,
vec![0; 256 * 1024],
vec![],
NametableLayout::Horizontal,
));
// Reset and ensure WRAM is enabled (bit 4 = 0)
mapper.write_prg(0x8000, 0x80);
for _ in 0..5 {
mapper.write_prg(0xE000, 0x00);
}
// Write to WRAM
mapper.write_prg(0x6000, 0x55);
let open_bus = 0xFF;
let result = mapper.read_prg_open_bus(0x6000, open_bus);
// Should return the written value, not open-bus
assert_eq!(
result, 0x55,
"Enabled WRAM should return written data, not open-bus"
);
}
}