src/gba/supervisor/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 "overrides.h"
7
8#include "gba/gba.h"
9#include "gba/hardware.h"
10
11#include "util/configuration.h"
12
13static const struct GBACartridgeOverride _overrides[] = {
14 // Advance Wars
15 { "AWRE", SAVEDATA_FLASH512, HW_NONE, 0x8038810 },
16 { "AWRP", SAVEDATA_FLASH512, HW_NONE, 0x8038810 },
17
18 // Boktai: The Sun is in Your Hand
19 { "U3IJ", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
20 { "U3IE", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
21 { "U3IP", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
22
23 // Boktai 2: Solar Boy Django
24 { "U32J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
25 { "U32E", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
26 { "U32P", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
27
28 // Dragon Ball Z - The Legacy of Goku
29 { "ALGP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
30
31 // Dragon Ball Z - Taiketsu
32 { "BDBE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
33 { "BDBP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
34
35 // Drill Dozer
36 { "V49J", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE },
37 { "V49E", SAVEDATA_SRAM, HW_RUMBLE, IDLE_LOOP_NONE },
38
39 // Final Fantasy Tactics Advance
40 { "AFXE", SAVEDATA_FLASH512, HW_NONE, 0x8000428 },
41
42 // F-Zero - Climax
43 { "BFTJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
44
45 // Golden Sun: The Lost Age
46 { "AGFE", SAVEDATA_FLASH512, HW_NONE, 0x801353A },
47
48 // Koro Koro Puzzle - Happy Panechu!
49 { "KHPJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE },
50
51 // Mega Man Battle Network
52 { "AREE", SAVEDATA_SRAM, HW_NONE, 0x800032E },
53
54 // Mega Man Zero
55 { "AZCE", SAVEDATA_SRAM, HW_NONE, 0x80004E8 },
56
57 // Metal Slug Advance
58 { "BSME", SAVEDATA_EEPROM, HW_NONE, 0x8000290 },
59
60 // Pokemon Ruby
61 { "AXVJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
62 { "AXVE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
63 { "AXVP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
64 { "AXVI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
65 { "AXVS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
66 { "AXVD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
67 { "AXVF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
68
69 // Pokemon Sapphire
70 { "AXPJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
71 { "AXPE", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
72 { "AXPP", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
73 { "AXPI", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
74 { "AXPS", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
75 { "AXPD", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
76 { "AXPF", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
77
78 // Pokemon Emerald
79 { "BPEJ", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
80 { "BPEE", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
81 { "BPEP", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
82 { "BPEI", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
83 { "BPES", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
84 { "BPED", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
85 { "BPEF", SAVEDATA_FLASH1M, HW_RTC, 0x80008C6 },
86
87 // Pokemon Mystery Dungeon
88 { "B24J", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
89 { "B24E", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
90 { "B24P", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
91 { "B24U", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
92
93 // Pokemon FireRed
94 { "BPRJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
95 { "BPRE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
96 { "BPRP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
97 { "BPRI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
98 { "BPRS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
99 { "BPRD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
100 { "BPRF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
101
102 // Pokemon LeafGreen
103 { "BPGJ", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
104 { "BPGE", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
105 { "BPGP", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
106 { "BPGI", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
107 { "BPGS", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
108 { "BPGD", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
109 { "BPGF", SAVEDATA_FLASH1M, HW_NONE, IDLE_LOOP_NONE },
110
111 // RockMan EXE 4.5 - Real Operation
112 { "BR4J", SAVEDATA_FLASH512, HW_RTC, IDLE_LOOP_NONE },
113
114 // Rocky
115 { "AR8E", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
116 { "AROP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
117
118 // Sennen Kazoku
119 { "BKAJ", SAVEDATA_FLASH1M, HW_RTC, IDLE_LOOP_NONE },
120
121 // Shin Bokura no Taiyou: Gyakushuu no Sabata
122 { "U33J", SAVEDATA_EEPROM, HW_RTC | HW_LIGHT_SENSOR, IDLE_LOOP_NONE },
123
124 // Super Mario Advance 2
125 { "AA2J", SAVEDATA_EEPROM, HW_NONE, 0x800052E },
126 { "AA2E", SAVEDATA_EEPROM, HW_NONE, 0x800052E },
127 { "AA2P", SAVEDATA_AUTODETECT, HW_NONE, 0x800052E },
128
129 // Super Mario Advance 3
130 { "A3AJ", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C },
131 { "A3AE", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C },
132 { "A3AP", SAVEDATA_EEPROM, HW_NONE, 0x8002B9C },
133
134 // Super Mario Advance 4
135 { "AX4J", SAVEDATA_FLASH1M, HW_NONE, 0x800072A },
136 { "AX4E", SAVEDATA_FLASH1M, HW_NONE, 0x800072A },
137 { "AX4P", SAVEDATA_FLASH1M, HW_NONE, 0x800072A },
138
139 // Super Monkey Ball Jr.
140 { "ALUE", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
141 { "ALUP", SAVEDATA_EEPROM, HW_NONE, IDLE_LOOP_NONE },
142
143 // Top Gun - Combat Zones
144 { "A2YE", SAVEDATA_FORCE_NONE, HW_NONE, IDLE_LOOP_NONE },
145
146 // Wario Ware Twisted
147 { "RZWJ", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE },
148 { "RZWE", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE },
149 { "RZWP", SAVEDATA_SRAM, HW_RUMBLE | HW_GYRO, IDLE_LOOP_NONE },
150
151 // Yoshi's Universal Gravitation
152 { "KYGJ", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE },
153 { "KYGE", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE },
154 { "KYGP", SAVEDATA_EEPROM, HW_TILT, IDLE_LOOP_NONE },
155
156 { { 0, 0, 0, 0 }, 0, 0, IDLE_LOOP_NONE }
157};
158
159bool GBAOverrideFind(const struct Configuration* config, struct GBACartridgeOverride* override) {
160 override->savetype = SAVEDATA_AUTODETECT;
161 override->hardware = HW_NONE;
162 override->idleLoop = IDLE_LOOP_NONE;
163 bool found = false;
164
165 if (override->id[0] == 'F') {
166 // Classic NES Series
167 override->savetype = SAVEDATA_EEPROM;
168 found = true;
169 } else {
170 int i;
171 for (i = 0; _overrides[i].id[0]; ++i) {
172 if (memcmp(override->id, _overrides[i].id, sizeof(override->id)) == 0) {
173 *override = _overrides[i];
174 found = true;
175 break;
176 }
177 }
178 }
179
180 if (config) {
181 char sectionName[16];
182 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
183 const char* savetype = ConfigurationGetValue(config, sectionName, "savetype");
184 const char* hardware = ConfigurationGetValue(config, sectionName, "hardware");
185 const char* idleLoop = ConfigurationGetValue(config, sectionName, "idleLoop");
186
187 if (savetype) {
188 if (strcasecmp(savetype, "SRAM") == 0) {
189 found = true;
190 override->savetype = SAVEDATA_SRAM;
191 } else if (strcasecmp(savetype, "EEPROM") == 0) {
192 found = true;
193 override->savetype = SAVEDATA_EEPROM;
194 } else if (strcasecmp(savetype, "FLASH512") == 0) {
195 found = true;
196 override->savetype = SAVEDATA_FLASH512;
197 } else if (strcasecmp(savetype, "FLASH1M") == 0) {
198 found = true;
199 override->savetype = SAVEDATA_FLASH1M;
200 } else if (strcasecmp(savetype, "NONE") == 0) {
201 found = true;
202 override->savetype = SAVEDATA_FORCE_NONE;
203 }
204 }
205
206 if (hardware) {
207 char* end;
208 long type = strtoul(hardware, &end, 0);
209 if (end && !*end) {
210 override->hardware = type;
211 found = true;
212 }
213 }
214
215 if (idleLoop) {
216 char* end;
217 uint32_t address = strtoul(idleLoop, &end, 16);
218 if (end && !*end) {
219 override->idleLoop = address;
220 found = true;
221 }
222 }
223 }
224 return found;
225}
226
227void GBAOverrideSave(struct Configuration* config, const struct GBACartridgeOverride* override) {
228 char sectionName[16];
229 snprintf(sectionName, sizeof(sectionName), "override.%c%c%c%c", override->id[0], override->id[1], override->id[2], override->id[3]);
230 const char* savetype = 0;
231 switch (override->savetype) {
232 case SAVEDATA_SRAM:
233 savetype = "SRAM";
234 break;
235 case SAVEDATA_EEPROM:
236 savetype = "EEPROM";
237 break;
238 case SAVEDATA_FLASH512:
239 savetype = "FLASH512";
240 break;
241 case SAVEDATA_FLASH1M:
242 savetype = "FLASH1M";
243 break;
244 case SAVEDATA_FORCE_NONE:
245 savetype = "NONE";
246 break;
247 case SAVEDATA_AUTODETECT:
248 break;
249 }
250 ConfigurationSetValue(config, sectionName, "savetype", savetype);
251
252 if (override->hardware != HW_NO_OVERRIDE) {
253 ConfigurationSetIntValue(config, sectionName, "hardware", override->hardware);
254 } else {
255 ConfigurationClearValue(config, sectionName, "hardware");
256 }
257
258 if (override->idleLoop != IDLE_LOOP_NONE) {
259 ConfigurationSetUIntValue(config, sectionName, "idleLoop", override->idleLoop);
260 } else {
261 ConfigurationClearValue(config, sectionName, "idleLoop");
262 }
263}
264
265void GBAOverrideApply(struct GBA* gba, const struct GBACartridgeOverride* override) {
266 if (override->savetype != SAVEDATA_AUTODETECT) {
267 GBASavedataForceType(&gba->memory.savedata, override->savetype, gba->realisticTiming);
268 }
269
270 if (override->hardware != HW_NO_OVERRIDE) {
271 GBAHardwareClear(&gba->memory.hw);
272
273 if (override->hardware & HW_RTC) {
274 GBAHardwareInitRTC(&gba->memory.hw);
275 }
276
277 if (override->hardware & HW_GYRO) {
278 GBAHardwareInitGyro(&gba->memory.hw);
279 }
280
281 if (override->hardware & HW_RUMBLE) {
282 GBAHardwareInitRumble(&gba->memory.hw);
283 }
284
285 if (override->hardware & HW_LIGHT_SENSOR) {
286 GBAHardwareInitLight(&gba->memory.hw);
287 }
288
289 if (override->hardware & HW_TILT) {
290 GBAHardwareInitTilt(&gba->memory.hw);
291 }
292
293 if (override->hardware & HW_GB_PLAYER_DETECTION) {
294 gba->memory.hw.devices |= HW_GB_PLAYER_DETECTION;
295 } else {
296 gba->memory.hw.devices &= ~HW_GB_PLAYER_DETECTION;
297 }
298 }
299
300 if (override->idleLoop != IDLE_LOOP_NONE) {
301 gba->idleLoop = override->idleLoop;
302 if (gba->idleOptimization == IDLE_LOOP_DETECT) {
303 gba->idleOptimization = IDLE_LOOP_REMOVE;
304 }
305 }
306}
307
308void GBAOverrideApplyDefaults(struct GBA* gba) {
309 struct GBACartridgeOverride override;
310 const struct GBACartridge* cart = (const struct GBACartridge*) gba->memory.rom;
311 memcpy(override.id, &cart->id, sizeof(override.id));
312 if (GBAOverrideFind(0, &override)) {
313 GBAOverrideApply(gba, &override);
314 }
315}