src/gba/cheats/parv3.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 "parv3.h"
7
8#include "gba/cheats/gameshark.h"
9#include "gba/gba.h"
10#include "util/string.h"
11
12const uint32_t GBACheatProActionReplaySeeds[4] = { 0x7AA9648F, 0x7FAE6994, 0xC0EFAAD5, 0x42712C57 };
13
14static const uint8_t _par3T1[256] = {
15 0xD0, 0xFF, 0xBA, 0xE5, 0xC1, 0xC7, 0xDB, 0x5B, 0x16, 0xE3, 0x6E, 0x26, 0x62, 0x31, 0x2E, 0x2A,
16 0xD1, 0xBB, 0x4A, 0xE6, 0xAE, 0x2F, 0x0A, 0x90, 0x29, 0x90, 0xB6, 0x67, 0x58, 0x2A, 0xB4, 0x45,
17 0x7B, 0xCB, 0xF0, 0x73, 0x84, 0x30, 0x81, 0xC2, 0xD7, 0xBE, 0x89, 0xD7, 0x4E, 0x73, 0x5C, 0xC7,
18 0x80, 0x1B, 0xE5, 0xE4, 0x43, 0xC7, 0x46, 0xD6, 0x6F, 0x7B, 0xBF, 0xED, 0xE5, 0x27, 0xD1, 0xB5,
19 0xD0, 0xD8, 0xA3, 0xCB, 0x2B, 0x30, 0xA4, 0xF0, 0x84, 0x14, 0x72, 0x5C, 0xFF, 0xA4, 0xFB, 0x54,
20 0x9D, 0x70, 0xE2, 0xFF, 0xBE, 0xE8, 0x24, 0x76, 0xE5, 0x15, 0xFB, 0x1A, 0xBC, 0x87, 0x02, 0x2A,
21 0x58, 0x8F, 0x9A, 0x95, 0xBD, 0xAE, 0x8D, 0x0C, 0xA5, 0x4C, 0xF2, 0x5C, 0x7D, 0xAD, 0x51, 0xFB,
22 0xB1, 0x22, 0x07, 0xE0, 0x29, 0x7C, 0xEB, 0x98, 0x14, 0xC6, 0x31, 0x97, 0xE4, 0x34, 0x8F, 0xCC,
23 0x99, 0x56, 0x9F, 0x78, 0x43, 0x91, 0x85, 0x3F, 0xC2, 0xD0, 0xD1, 0x80, 0xD1, 0x77, 0xA7, 0xE2,
24 0x43, 0x99, 0x1D, 0x2F, 0x8B, 0x6A, 0xE4, 0x66, 0x82, 0xF7, 0x2B, 0x0B, 0x65, 0x14, 0xC0, 0xC2,
25 0x1D, 0x96, 0x78, 0x1C, 0xC4, 0xC3, 0xD2, 0xB1, 0x64, 0x07, 0xD7, 0x6F, 0x02, 0xE9, 0x44, 0x31,
26 0xDB, 0x3C, 0xEB, 0x93, 0xED, 0x9A, 0x57, 0x05, 0xB9, 0x0E, 0xAF, 0x1F, 0x48, 0x11, 0xDC, 0x35,
27 0x6C, 0xB8, 0xEE, 0x2A, 0x48, 0x2B, 0xBC, 0x89, 0x12, 0x59, 0xCB, 0xD1, 0x18, 0xEA, 0x72, 0x11,
28 0x01, 0x75, 0x3B, 0xB5, 0x56, 0xF4, 0x8B, 0xA0, 0x41, 0x75, 0x86, 0x7B, 0x94, 0x12, 0x2D, 0x4C,
29 0x0C, 0x22, 0xC9, 0x4A, 0xD8, 0xB1, 0x8D, 0xF0, 0x55, 0x2E, 0x77, 0x50, 0x1C, 0x64, 0x77, 0xAA,
30 0x3E, 0xAC, 0xD3, 0x3D, 0xCE, 0x60, 0xCA, 0x5D, 0xA0, 0x92, 0x78, 0xC6, 0x51, 0xFE, 0xF9, 0x30
31};
32
33static const uint8_t _par3T2[256] = {
34 0xAA, 0xAF, 0xF0, 0x72, 0x90, 0xF7, 0x71, 0x27, 0x06, 0x11, 0xEB, 0x9C, 0x37, 0x12, 0x72, 0xAA,
35 0x65, 0xBC, 0x0D, 0x4A, 0x76, 0xF6, 0x5C, 0xAA, 0xB0, 0x7A, 0x7D, 0x81, 0xC1, 0xCE, 0x2F, 0x9F,
36 0x02, 0x75, 0x38, 0xC8, 0xFC, 0x66, 0x05, 0xC2, 0x2C, 0xBD, 0x91, 0xAD, 0x03, 0xB1, 0x88, 0x93,
37 0x31, 0xC6, 0xAB, 0x40, 0x23, 0x43, 0x76, 0x54, 0xCA, 0xE7, 0x00, 0x96, 0x9F, 0xD8, 0x24, 0x8B,
38 0xE4, 0xDC, 0xDE, 0x48, 0x2C, 0xCB, 0xF7, 0x84, 0x1D, 0x45, 0xE5, 0xF1, 0x75, 0xA0, 0xED, 0xCD,
39 0x4B, 0x24, 0x8A, 0xB3, 0x98, 0x7B, 0x12, 0xB8, 0xF5, 0x63, 0x97, 0xB3, 0xA6, 0xA6, 0x0B, 0xDC,
40 0xD8, 0x4C, 0xA8, 0x99, 0x27, 0x0F, 0x8F, 0x94, 0x63, 0x0F, 0xB0, 0x11, 0x94, 0xC7, 0xE9, 0x7F,
41 0x3B, 0x40, 0x72, 0x4C, 0xDB, 0x84, 0x78, 0xFE, 0xB8, 0x56, 0x08, 0x80, 0xDF, 0x20, 0x2F, 0xB9,
42 0x66, 0x2D, 0x60, 0x63, 0xF5, 0x18, 0x15, 0x1B, 0x86, 0x85, 0xB9, 0xB4, 0x68, 0x0E, 0xC6, 0xD1,
43 0x8A, 0x81, 0x2B, 0xB3, 0xF6, 0x48, 0xF0, 0x4F, 0x9C, 0x28, 0x1C, 0xA4, 0x51, 0x2F, 0xD7, 0x4B,
44 0x17, 0xE7, 0xCC, 0x50, 0x9F, 0xD0, 0xD1, 0x40, 0x0C, 0x0D, 0xCA, 0x83, 0xFA, 0x5E, 0xCA, 0xEC,
45 0xBF, 0x4E, 0x7C, 0x8F, 0xF0, 0xAE, 0xC2, 0xD3, 0x28, 0x41, 0x9B, 0xC8, 0x04, 0xB9, 0x4A, 0xBA,
46 0x72, 0xE2, 0xB5, 0x06, 0x2C, 0x1E, 0x0B, 0x2C, 0x7F, 0x11, 0xA9, 0x26, 0x51, 0x9D, 0x3F, 0xF8,
47 0x62, 0x11, 0x2E, 0x89, 0xD2, 0x9D, 0x35, 0xB1, 0xE4, 0x0A, 0x4D, 0x93, 0x01, 0xA7, 0xD1, 0x2D,
48 0x00, 0x87, 0xE2, 0x2D, 0xA4, 0xE9, 0x0A, 0x06, 0x66, 0xF8, 0x1F, 0x44, 0x75, 0xB5, 0x6B, 0x1C,
49 0xFC, 0x31, 0x09, 0x48, 0xA3, 0xFF, 0x92, 0x12, 0x58, 0xE9, 0xFA, 0xAE, 0x4F, 0xE2, 0xB4, 0xCC
50};
51static uint32_t _parAddr(uint32_t x) {
52 return (x & 0xFFFFF) | ((x << 4) & 0x0F000000);
53}
54
55static void _parEndBlock(struct GBACheatSet* cheats) {
56 size_t size = mCheatListSize(&cheats->d.list) - mCheatListIndex(&cheats->d.list, cheats->currentBlock);
57 if (cheats->currentBlock->repeat) {
58 cheats->currentBlock->negativeRepeat = size - cheats->currentBlock->repeat;
59 } else {
60 cheats->currentBlock->repeat = size;
61 }
62 cheats->currentBlock = 0;
63}
64
65static void _parElseBlock(struct GBACheatSet* cheats) {
66 size_t size = mCheatListSize(&cheats->d.list) - mCheatListIndex(&cheats->d.list, cheats->currentBlock);
67 cheats->currentBlock->repeat = size;
68}
69
70static bool _addPAR3Cond(struct GBACheatSet* cheats, uint32_t op1, uint32_t op2) {
71 enum GBAActionReplay3Condition condition = op1 & PAR3_COND;
72 int width = 1 << ((op1 & PAR3_WIDTH) >> PAR3_WIDTH_BASE);
73 if (width > 4) {
74 // TODO: Always false conditions
75 return false;
76 }
77 if ((op1 & PAR3_ACTION) == PAR3_ACTION_DISABLE) {
78 // TODO: Codes that disable
79 return false;
80 }
81
82 struct mCheat* cheat = mCheatListAppend(&cheats->d.list);
83 cheat->address = _parAddr(op1);
84 cheat->width = width;
85 cheat->operand = op2 & (0xFFFFFFFFU >> ((4 - width) * 8));
86 cheat->addressOffset = 0;
87 cheat->operandOffset = 0;
88
89 switch (op1 & PAR3_ACTION) {
90 case PAR3_ACTION_NEXT:
91 cheat->repeat = 1;
92 cheat->negativeRepeat = 0;
93 break;
94 case PAR3_ACTION_NEXT_TWO:
95 cheat->repeat = 2;
96 cheat->negativeRepeat = 0;
97 break;
98 case PAR3_ACTION_BLOCK:
99 cheat->repeat = 0;
100 cheat->negativeRepeat = 0;
101 if (cheats->currentBlock) {
102 _parEndBlock(cheats);
103 }
104 cheats->currentBlock = cheat;
105 break;
106 }
107
108 switch (condition) {
109 case PAR3_COND_OTHER:
110 // We shouldn't be able to get here
111 mLOG(CHEATS, ERROR, "Unexpectedly created 'other' PARv3 code");
112 cheat->type = CHEAT_IF_LAND;
113 cheat->operand = 0;
114 break;
115 case PAR3_COND_EQ:
116 cheat->type = CHEAT_IF_EQ;
117 break;
118 case PAR3_COND_NE:
119 cheat->type = CHEAT_IF_NE;
120 break;
121 case PAR3_COND_LT:
122 cheat->type = CHEAT_IF_LT;
123 break;
124 case PAR3_COND_GT:
125 cheat->type = CHEAT_IF_GT;
126 break;
127 case PAR3_COND_ULT:
128 cheat->type = CHEAT_IF_ULT;
129 break;
130 case PAR3_COND_UGT:
131 cheat->type = CHEAT_IF_UGT;
132 break;
133 case PAR3_COND_LAND:
134 cheat->type = CHEAT_IF_LAND;
135 break;
136 }
137 return true;
138}
139
140static bool _addPAR3Special(struct GBACheatSet* cheats, uint32_t op2) {
141 struct mCheat* cheat;
142 switch (op2 & 0xFF000000) {
143 case PAR3_OTHER_SLOWDOWN:
144 // TODO: Slowdown
145 return false;
146 case PAR3_OTHER_BUTTON_1:
147 case PAR3_OTHER_BUTTON_2:
148 case PAR3_OTHER_BUTTON_4:
149 // TODO: Button
150 mLOG(CHEATS, STUB, "GameShark button unimplemented");
151 return false;
152 // TODO: Fix overriding existing patches
153 case PAR3_OTHER_PATCH_1:
154 cheats->romPatches[0].address = BASE_CART0 | ((op2 & 0xFFFFFF) << 1);
155 cheats->romPatches[0].applied = false;
156 cheats->romPatches[0].exists = true;
157 cheats->incompletePatch = &cheats->romPatches[0];
158 break;
159 case PAR3_OTHER_PATCH_2:
160 cheats->romPatches[1].address = BASE_CART0 | ((op2 & 0xFFFFFF) << 1);
161 cheats->romPatches[1].applied = false;
162 cheats->romPatches[1].exists = true;
163 cheats->incompletePatch = &cheats->romPatches[1];
164 break;
165 case PAR3_OTHER_PATCH_3:
166 cheats->romPatches[2].address = BASE_CART0 | ((op2 & 0xFFFFFF) << 1);
167 cheats->romPatches[2].applied = false;
168 cheats->romPatches[2].exists = true;
169 cheats->incompletePatch = &cheats->romPatches[2];
170 break;
171 case PAR3_OTHER_PATCH_4:
172 cheats->romPatches[3].address = BASE_CART0 | ((op2 & 0xFFFFFF) << 1);
173 cheats->romPatches[3].applied = false;
174 cheats->romPatches[3].exists = true;
175 cheats->incompletePatch = &cheats->romPatches[3];
176 break;
177 case PAR3_OTHER_ENDIF:
178 if (cheats->currentBlock) {
179 _parEndBlock(cheats);
180 return true;
181 }
182 return false;
183 case PAR3_OTHER_ELSE:
184 if (cheats->currentBlock) {
185 _parElseBlock(cheats);
186 return true;
187 }
188 return false;
189 case PAR3_OTHER_FILL_1:
190 cheat = mCheatListAppend(&cheats->d.list);
191 cheat->address = _parAddr(op2);
192 cheat->width = 1;
193 cheats->incompleteCheat = cheat;
194 break;
195 case PAR3_OTHER_FILL_2:
196 cheat = mCheatListAppend(&cheats->d.list);
197 cheat->address = _parAddr(op2);
198 cheat->width = 2;
199 cheats->incompleteCheat = cheat;
200 break;
201 case PAR3_OTHER_FILL_4:
202 cheat = mCheatListAppend(&cheats->d.list);
203 cheat->address = _parAddr(op2);
204 cheat->width = 3;
205 cheats->incompleteCheat = cheat;
206 break;
207 }
208 return true;
209}
210
211bool GBACheatAddProActionReplayRaw(struct GBACheatSet* cheats, uint32_t op1, uint32_t op2) {
212 if (cheats->incompletePatch) {
213 cheats->incompletePatch->newValue = op1;
214 cheats->incompletePatch = 0;
215 return true;
216 }
217 if (cheats->incompleteCheat) {
218 cheats->incompleteCheat->operand = op1 & (0xFFFFFFFFU >> ((4 - cheats->incompleteCheat->width) * 8));
219 cheats->incompleteCheat->addressOffset = op2 >> 24;
220 cheats->incompleteCheat->repeat = (op2 >> 16) & 0xFF;
221 cheats->incompleteCheat->addressOffset = (op2 & 0xFFFF) * cheats->incompleteCheat->width;
222 cheats->incompleteCheat = 0;
223 return true;
224 }
225
226 if (op2 == 0x001DC0DE) {
227 return true;
228 }
229
230 switch (op1) {
231 case 0x00000000:
232 return _addPAR3Special(cheats, op2);
233 case 0xDEADFACE:
234 GBACheatReseedGameShark(cheats->gsaSeeds, op2, _par3T1, _par3T2);
235 return true;
236 }
237
238 if (op1 >> 24 == 0xC4) {
239 if (cheats->hook) {
240 return false;
241 }
242 cheats->hook = malloc(sizeof(*cheats->hook));
243 cheats->hook->address = BASE_CART0 | (op1 & (SIZE_CART0 - 1));
244 cheats->hook->mode = MODE_THUMB;
245 cheats->hook->refs = 1;
246 cheats->hook->reentries = 0;
247 return true;
248 }
249
250 if (op1 & PAR3_COND) {
251 return _addPAR3Cond(cheats, op1, op2);
252 }
253
254 int width = 1 << ((op1 & PAR3_WIDTH) >> PAR3_WIDTH_BASE);
255 struct mCheat* cheat = mCheatListAppend(&cheats->d.list);
256 cheat->address = _parAddr(op1);
257 cheat->operandOffset = 0;
258 cheat->addressOffset = 0;
259 cheat->repeat = 1;
260
261 switch (op1 & PAR3_BASE) {
262 case PAR3_BASE_ASSIGN:
263 cheat->type = CHEAT_ASSIGN;
264 cheat->addressOffset = width;
265 if (width < 4) {
266 cheat->repeat = (op2 >> (width * 8)) + 1;
267 }
268 break;
269 case PAR3_BASE_INDIRECT:
270 cheat->type = CHEAT_ASSIGN_INDIRECT;
271 if (width < 4) {
272 cheat->addressOffset = (op2 >> (width * 8)) * width;
273 }
274 break;
275 case PAR3_BASE_ADD:
276 cheat->type = CHEAT_ADD;
277 break;
278 case PAR3_BASE_OTHER:
279 width = ((op1 >> 24) & 1) + 1;
280 cheat->type = CHEAT_ASSIGN;
281 cheat->address = BASE_IO | (op1 & OFFSET_MASK);
282 break;
283 }
284
285 cheat->width = width;
286 cheat->operand = op2 & (0xFFFFFFFFU >> ((4 - width) * 8));
287 return true;
288}
289
290bool GBACheatAddProActionReplay(struct GBACheatSet* set, uint32_t op1, uint32_t op2) {
291 uint32_t o1 = op1;
292 uint32_t o2 = op2;
293 char line[18] = "XXXXXXXX XXXXXXXX";
294 snprintf(line, sizeof(line), "%08X %08X", op1, op2);
295
296 switch (set->gsaVersion) {
297 case 0:
298 case 1:
299 case 2:
300 GBACheatSetGameSharkVersion(set, 3);
301 // Fall through
302 case 3:
303 case 4:
304 GBACheatDecryptGameShark(&o1, &o2, set->gsaSeeds);
305 return GBACheatAddProActionReplayRaw(set, o1, o2);
306 }
307 return false;
308}
309
310bool GBACheatAddProActionReplayLine(struct GBACheatSet* cheats, const char* line) {
311 uint32_t op1;
312 uint32_t op2;
313 line = hex32(line, &op1);
314 if (!line) {
315 return false;
316 }
317 while (*line == ' ') {
318 ++line;
319 }
320 line = hex32(line, &op2);
321 if (!line) {
322 return false;
323 }
324 return GBACheatAddProActionReplay(cheats, op1, op2);
325}