src/gba/overrides.c (view raw)
1/* Copyright (c) 2013-2015 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include <mgba/internal/gba/overrides.h>
7
8#include <mgba/internal/gba/gba.h>
9#include <mgba/internal/gba/hardware.h>
10
11#include <mgba-util/configuration.h>
12
13static const struct GBACartridgeOverride _overrides[] = {
14 // Advance Wars
15 { "AWRE", SAVEDATA_FLASH512, HW_NONE, 0x8038810, false },
16 { "AWRP", SAVEDATA_FLASH512, HW_NONE, 0x8038810, false },
17
18 // Advance Wars 2: Black Hole Rising
19 { "AW2E", SAVEDATA_FLASH512, HW_NONE, 0x8036E08, false },
20 { "AW2P", SAVEDATA_FLASH512, HW_NONE, 0x803719C, false },
21
22 // Boktai: The Sun is in Your Hand
23 { "U3IJ", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
24 { "U3IE", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
25 { "U3IP", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
26
27 // Boktai 2: Solar Boy Django
28 { "U32J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
29 { "U32E", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
30 { "U32P", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
31
32 // Crash Bandicoot 2 - N-Tranced
33 { "AC8J", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
34 { "AC8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
35 { "AC8P", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
36
37 // Dragon Ball Z - The Legacy of Goku
38 { "ALGP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
39
40 // Dragon Ball Z - The Legacy of Goku II
41 { "ALFJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
42 { "ALFE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
43 { "ALFP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
44
45 // Dragon Ball Z - Taiketsu
46 { "BDBE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
47 { "BDBP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
48
49 // Drill Dozer
50 { "V49J", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE, false },
51 { "V49E", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE, false },
52
53 // Final Fantasy Tactics Advance
54 { "AFXE", SAVEDATA_FLASH512, HW_NONE, 0x8000428, false },
55
56 // F-Zero - Climax
57 { "BFTJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
58
59 // Iridion II
60 { "AI2E", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
61 { "AI2P", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
62
63 // Golden Sun: The Lost Age
64 { "AGFE", SAVEDATA_FLASH512, HW_NONE, 0x801353A, false },
65
66 // Koro Koro Puzzle - Happy Panechu!
67 { "KHPJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
68
69 // Legendz - Yomigaeru Shiren no Shima
70 { "BLJJ", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
71 { "BLJK", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
72
73 // Legendz - Sign of Nekuromu
74 { "BLVJ", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
75
76 // Mega Man Battle Network
77 { "AREE", SAVEDATA_SRAM, HW_NONE, 0x800032E, false },
78
79 // Mega Man Zero
80 { "AZCE", SAVEDATA_SRAM, HW_NONE, 0x80004E8, false },
81
82 // Metal Slug Advance
83 { "BSME", SAVEDATA_EEPROM, HW_NONE, 0x8000290, false },
84
85 // Pokemon Pinball: Ruby & Sapphire
86 { "BPPJ", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
87 { "BPPE", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
88 { "BPPP", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
89 { "BPPU", SAVEDATA_SRAM, HW_GB_PLAYER_DETECTION, IDLE_LOOP_NONE, false },
90
91 // Pokemon Ruby
92 { "AXVJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
93 { "AXVE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
94 { "AXVP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
95 { "AXVI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
96 { "AXVS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
97 { "AXVD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
98 { "AXVF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
99
100 // Pokemon Sapphire
101 { "AXPJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
102 { "AXPE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
103 { "AXPP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
104 { "AXPI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
105 { "AXPS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
106 { "AXPD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
107 { "AXPF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
108
109 // Pokemon Emerald
110 { "BPEJ", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
111 { "BPEE", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
112 { "BPEP", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
113 { "BPEI", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
114 { "BPES", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
115 { "BPED", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
116 { "BPEF", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6, false },
117
118 // Pokemon Mystery Dungeon
119 { "B24J", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
120 { "B24E", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
121 { "B24P", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
122 { "B24U", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
123
124 // Pokemon FireRed
125 { "BPRJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
126 { "BPRE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
127 { "BPRP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
128 { "BPRI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
129 { "BPRS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
130 { "BPRD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
131 { "BPRF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
132
133 // Pokemon LeafGreen
134 { "BPGJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
135 { "BPGE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
136 { "BPGP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
137 { "BPGI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
138 { "BPGS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
139 { "BPGD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
140 { "BPGF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE, false },
141
142 // RockMan EXE 4.5 - Real Operation
143 { "BR4J", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE, false },
144
145 // Rocky
146 { "AR8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
147 { "AROP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
148
149 // Sennen Kazoku
150 { "BKAJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE, false },
151
152 // Shin Bokura no Taiyou: Gyakushuu no Sabata
153 { "U33J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE, false },
154
155 // Super Mario Advance 2
156 { "AA2J", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
157 { "AA2E", SAVEDATA_EEPROM, HW_NONE, 0x800052E, false },
158 { "AA2P", SAVEDATA_AUTODETECT, HW_NONE, 0x800052E, false },
159
160 // Super Mario Advance 3
161 { "A3AJ", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
162 { "A3AE", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
163 { "A3AP", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C, false },
164
165 // Super Mario Advance 4
166 { "AX4J", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
167 { "AX4E", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
168 { "AX4P", SAVEDATA_FLASH1M, HW_NONE, 0x800072A, false },
169
170 // Super Monkey Ball Jr.
171 { "ALUE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
172 { "ALUP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
173
174 // Top Gun - Combat Zones
175 { "A2YE", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE, false },
176
177 // Ueki no Housoku - Jingi Sakuretsu! Nouryokusha Battle
178 { "BUHJ", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
179
180 // Wario Ware Twisted
181 { "RZWJ", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
182 { "RZWE", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
183 { "RZWP", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE, false },
184
185 // Yoshi's Universal Gravitation
186 { "KYGJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
187 { "KYGE", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
188 { "KYGP", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE, false },
189
190 // Aging cartridge
191 { "TCHK", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE, false },
192
193 { { 0, 0, 0, 0 }, 0, 0, IDLE_LOOP_NONE, false }
194};
195
196bool GBAOverrideFind(const struct Configuration* config, struct GBACartridgeOverride* override) {
197 override->savetype = SAVEDATA_AUTODETECT;
198 override->hardware = HW_NONE;
199 override->idleLoop = IDLE_LOOP_NONE;
200 override->mirroring = false;
201 bool found = false;
202
203 if (override->id[0] == 'F') {
204 // Classic NES Series
205 override->savetype = SAVEDATA_EEPROM;
206 override->mirroring = true;
207 found = true;
208 } else {
209 int i;
210 for (i = 0; _overrides[i].id[0]; ++i) {
211 if (memcmp(override->id, _overrides[i].id, sizeof(override->id)) == 0) {
212 *override = _overrides[i];
213 found = true;
214 break;
215 }
216 }
217 }
218
219 if (config) {
220 char sectionName[16];
221 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
222 const char* savetype = ConfigurationGetValue(config, sectionName, "savetype");
223 const char* hardware = ConfigurationGetValue(config, sectionName, "hardware");
224 const char* idleLoop = ConfigurationGetValue(config, sectionName, "idleLoop");
225
226 if (savetype) {
227 if (strcasecmp(savetype, "SRAM") == 0) {
228 found = true;
229 override->savetype = SAVEDATA_SRAM;
230 } else if (strcasecmp(savetype, "EEPROM") == 0) {
231 found = true;
232 override->savetype = SAVEDATA_EEPROM;
233 } else if (strcasecmp(savetype, "EEPROM512") == 0) {
234 found = true;
235 override->savetype = SAVEDATA_EEPROM512;
236 } else if (strcasecmp(savetype, "FLASH512") == 0) {
237 found = true;
238 override->savetype = SAVEDATA_FLASH512;
239 } else if (strcasecmp(savetype, "FLASH1M") == 0) {
240 found = true;
241 override->savetype = SAVEDATA_FLASH1M;
242 } else if (strcasecmp(savetype, "NONE") == 0) {
243 found = true;
244 override->savetype = SAVEDATA_FORCE_NONE;
245 }
246 }
247
248 if (hardware) {
249 char* end;
250 long type = strtoul(hardware, &end, 0);
251 if (end && !*end) {
252 override->hardware = type;
253 found = true;
254 }
255 }
256
257 if (idleLoop) {
258 char* end;
259 uint32_t address = strtoul(idleLoop, &end, 16);
260 if (end && !*end) {
261 override->idleLoop = address;
262 found = true;
263 }
264 }
265 }
266 return found;
267}
268
269void GBAOverrideSave(struct Configuration* config, const struct GBACartridgeOverride* override) {
270 char sectionName[16];
271 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
272 const char* savetype = 0;
273 switch (override->savetype) {
274 case SAVEDATA_SRAM:
275 savetype = "SRAM";
276 break;
277 case SAVEDATA_EEPROM:
278 savetype = "EEPROM";
279 break;
280 case SAVEDATA_EEPROM512:
281 savetype = "EEPROM512";
282 break;
283 case SAVEDATA_FLASH512:
284 savetype = "FLASH512";
285 break;
286 case SAVEDATA_FLASH1M:
287 savetype = "FLASH1M";
288 break;
289 case SAVEDATA_FORCE_NONE:
290 savetype = "NONE";
291 break;
292 case SAVEDATA_AUTODETECT:
293 break;
294 }
295 ConfigurationSetValue(config, sectionName, "savetype", savetype);
296
297 if (override->hardware != HW_NO_OVERRIDE) {
298 ConfigurationSetIntValue(config, sectionName, "hardware", override->hardware);
299 } else {
300 ConfigurationClearValue(config, sectionName, "hardware");
301 }
302
303 if (override->idleLoop != IDLE_LOOP_NONE) {
304 ConfigurationSetUIntValue(config, sectionName, "idleLoop", override->idleLoop);
305 } else {
306 ConfigurationClearValue(config, sectionName, "idleLoop");
307 }
308}
309
310void GBAOverrideApply(struct GBA* gba, const struct GBACartridgeOverride* override) {
311 if (override->savetype != SAVEDATA_AUTODETECT) {
312 GBASavedataForceType(&gba->memory.savedata, override->savetype);
313 }
314
315 if (override->hardware != HW_NO_OVERRIDE) {
316 GBAHardwareClear(&gba->memory.hw);
317
318 if (override->hardware & HW_RTC) {
319 GBAHardwareInitRTC(&gba->memory.hw);
320 }
321
322 if (override->hardware & HW_GYRO) {
323 GBAHardwareInitGyro(&gba->memory.hw);
324 }
325
326 if (override->hardware & HW_RUMBLE) {
327 GBAHardwareInitRumble(&gba->memory.hw);
328 }
329
330 if (override->hardware & HW_LIGHT_SENSOR) {
331 GBAHardwareInitLight(&gba->memory.hw);
332 }
333
334 if (override->hardware & HW_TILT) {
335 GBAHardwareInitTilt(&gba->memory.hw);
336 }
337
338 if (override->hardware & HW_GB_PLAYER_DETECTION) {
339 gba->memory.hw.devices |= HW_GB_PLAYER_DETECTION;
340 } else {
341 gba->memory.hw.devices &= ~HW_GB_PLAYER_DETECTION;
342 }
343 }
344
345 if (override->idleLoop != IDLE_LOOP_NONE) {
346 gba->idleLoop = override->idleLoop;
347 if (gba->idleOptimization == IDLE_LOOP_DETECT) {
348 gba->idleOptimization = IDLE_LOOP_REMOVE;
349 }
350 }
351
352 if (override->mirroring) {
353 gba->memory.mirroring = true;
354 }
355}
356
357void GBAOverrideApplyDefaults(struct GBA* gba, const struct Configuration* overrides) {
358 struct GBACartridgeOverride override = { .idleLoop = IDLE_LOOP_NONE };
359 const struct GBACartridge* cart = (const struct GBACartridge*) gba->memory.rom;
360 if (cart) {
361 memcpy(override.id, &cart->id, sizeof(override.id));
362
363 if (!strncmp("pokemon red version", &((const char*) gba->memory.rom)[0x108], 20) && gba->romCrc32 != 0xDD88761C) {
364 // Enable FLASH1M and RTC on Pokémon FireRed ROM hacks
365 override.savetype = SAVEDATA_FLASH1M;
366 override.hardware = HW_RTC;
367 GBAOverrideApply(gba, &override);
368 } else if (GBAOverrideFind(overrides, &override)) {
369 GBAOverrideApply(gba, &override);
370 }
371 }
372}