src/gba/cheats/gameshark.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 "gameshark.h"
7
8#include "gba/cheats/parv3.h"
9#include "gba/gba.h"
10#include "util/string.h"
11
12const uint32_t GBACheatGameSharkSeeds[4] = { 0x09F4FBBD, 0x9681884A, 0x352027E9, 0xF3DEE5A7 };
13
14static const uint8_t _gsa1T1[256] = {
15 0x31, 0x1C, 0x23, 0xE5, 0x89, 0x8E, 0xA1, 0x37, 0x74, 0x6D, 0x67, 0xFC, 0x1F, 0xC0, 0xB1, 0x94,
16 0x3B, 0x05, 0x56, 0x86, 0x00, 0x24, 0xF0, 0x17, 0x72, 0xA2, 0x3D, 0x1B, 0xE3, 0x17, 0xC5, 0x0B,
17 0xB9, 0xE2, 0xBD, 0x58, 0x71, 0x1B, 0x2C, 0xFF, 0xE4, 0xC9, 0x4C, 0x5E, 0xC9, 0x55, 0x33, 0x45,
18 0x7C, 0x3F, 0xB2, 0x51, 0xFE, 0x10, 0x7E, 0x75, 0x3C, 0x90, 0x8D, 0xDA, 0x94, 0x38, 0xC3, 0xE9,
19 0x95, 0xEA, 0xCE, 0xA6, 0x06, 0xE0, 0x4F, 0x3F, 0x2A, 0xE3, 0x3A, 0xE4, 0x43, 0xBD, 0x7F, 0xDA,
20 0x55, 0xF0, 0xEA, 0xCB, 0x2C, 0xA8, 0x47, 0x61, 0xA0, 0xEF, 0xCB, 0x13, 0x18, 0x20, 0xAF, 0x3E,
21 0x4D, 0x9E, 0x1E, 0x77, 0x51, 0xC5, 0x51, 0x20, 0xCF, 0x21, 0xF9, 0x39, 0x94, 0xDE, 0xDD, 0x79,
22 0x4E, 0x80, 0xC4, 0x9D, 0x94, 0xD5, 0x95, 0x01, 0x27, 0x27, 0xBD, 0x6D, 0x78, 0xB5, 0xD1, 0x31,
23 0x6A, 0x65, 0x74, 0x74, 0x58, 0xB3, 0x7C, 0xC9, 0x5A, 0xED, 0x50, 0x03, 0xC4, 0xA2, 0x94, 0x4B,
24 0xF0, 0x58, 0x09, 0x6F, 0x3E, 0x7D, 0xAE, 0x7D, 0x58, 0xA0, 0x2C, 0x91, 0xBB, 0xE1, 0x70, 0xEB,
25 0x73, 0xA6, 0x9A, 0x44, 0x25, 0x90, 0x16, 0x62, 0x53, 0xAE, 0x08, 0xEB, 0xDC, 0xF0, 0xEE, 0x77,
26 0xC2, 0xDE, 0x81, 0xE8, 0x30, 0x89, 0xDB, 0xFE, 0xBC, 0xC2, 0xDF, 0x26, 0xE9, 0x8B, 0xD6, 0x93,
27 0xF0, 0xCB, 0x56, 0x90, 0xC0, 0x46, 0x68, 0x15, 0x43, 0xCB, 0xE9, 0x98, 0xE3, 0xAF, 0x31, 0x25,
28 0x4D, 0x7B, 0xF3, 0xB1, 0x74, 0xE2, 0x64, 0xAC, 0xD9, 0xF6, 0xA0, 0xD5, 0x0B, 0x9B, 0x49, 0x52,
29 0x69, 0x3B, 0x71, 0x00, 0x2F, 0xBB, 0xBA, 0x08, 0xB1, 0xAE, 0xBB, 0xB3, 0xE1, 0xC9, 0xA6, 0x7F,
30 0x17, 0x97, 0x28, 0x72, 0x12, 0x6E, 0x91, 0xAE, 0x3A, 0xA2, 0x35, 0x46, 0x27, 0xF8, 0x12, 0x50
31};
32
33static const uint8_t _gsa1T2[256] = {
34 0xD8, 0x65, 0x04, 0xC2, 0x65, 0xD5, 0xB0, 0x0C, 0xDF, 0x9D, 0xF0, 0xC3, 0x9A, 0x17, 0xC9, 0xA6,
35 0xE1, 0xAC, 0x0D, 0x14, 0x2F, 0x3C, 0x2C, 0x87, 0xA2, 0xBF, 0x4D, 0x5F, 0xAC, 0x2D, 0x9D, 0xE1,
36 0x0C, 0x9C, 0xE7, 0x7F, 0xFC, 0xA8, 0x66, 0x59, 0xAC, 0x18, 0xD7, 0x05, 0xF0, 0xBF, 0xD1, 0x8B,
37 0x35, 0x9F, 0x59, 0xB4, 0xBA, 0x55, 0xB2, 0x85, 0xFD, 0xB1, 0x72, 0x06, 0x73, 0xA4, 0xDB, 0x48,
38 0x7B, 0x5F, 0x67, 0xA5, 0x95, 0xB9, 0xA5, 0x4A, 0xCF, 0xD1, 0x44, 0xF3, 0x81, 0xF5, 0x6D, 0xF6,
39 0x3A, 0xC3, 0x57, 0x83, 0xFA, 0x8E, 0x15, 0x2A, 0xA2, 0x04, 0xB2, 0x9D, 0xA8, 0x0D, 0x7F, 0xB8,
40 0x0F, 0xF6, 0xAC, 0xBE, 0x97, 0xCE, 0x16, 0xE6, 0x31, 0x10, 0x60, 0x16, 0xB5, 0x83, 0x45, 0xEE,
41 0xD7, 0x5F, 0x2C, 0x08, 0x58, 0xB1, 0xFD, 0x7E, 0x79, 0x00, 0x34, 0xAD, 0xB5, 0x31, 0x34, 0x39,
42 0xAF, 0xA8, 0xDD, 0x52, 0x6A, 0xB0, 0x60, 0x35, 0xB8, 0x1D, 0x52, 0xF5, 0xF5, 0x30, 0x00, 0x7B,
43 0xF4, 0xBA, 0x03, 0xCB, 0x3A, 0x84, 0x14, 0x8A, 0x6A, 0xEF, 0x21, 0xBD, 0x01, 0xD8, 0xA0, 0xD4,
44 0x43, 0xBE, 0x23, 0xE7, 0x76, 0x27, 0x2C, 0x3F, 0x4D, 0x3F, 0x43, 0x18, 0xA7, 0xC3, 0x47, 0xA5,
45 0x7A, 0x1D, 0x02, 0x55, 0x09, 0xD1, 0xFF, 0x55, 0x5E, 0x17, 0xA0, 0x56, 0xF4, 0xC9, 0x6B, 0x90,
46 0xB4, 0x80, 0xA5, 0x07, 0x22, 0xFB, 0x22, 0x0D, 0xD9, 0xC0, 0x5B, 0x08, 0x35, 0x05, 0xC1, 0x75,
47 0x4F, 0xD0, 0x51, 0x2D, 0x2E, 0x5E, 0x69, 0xE7, 0x3B, 0xC2, 0xDA, 0xFF, 0xF6, 0xCE, 0x3E, 0x76,
48 0xE8, 0x36, 0x8C, 0x39, 0xD8, 0xF3, 0xE9, 0xA6, 0x42, 0xE6, 0xC1, 0x4C, 0x05, 0xBE, 0x17, 0xF2,
49 0x5C, 0x1B, 0x19, 0xDB, 0x0F, 0xF3, 0xF8, 0x49, 0xEB, 0x36, 0xF6, 0x40, 0x6F, 0xAD, 0xC1, 0x8C
50};
51
52// http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm
53void GBACheatDecryptGameShark(uint32_t* op1, uint32_t* op2, const uint32_t* seeds) {
54 uint32_t sum = 0xC6EF3720;
55 int i;
56 for (i = 0; i < 32; ++i) {
57 *op2 -= ((*op1 << 4) + seeds[2]) ^ (*op1 + sum) ^ ((*op1 >> 5) + seeds[3]);
58 *op1 -= ((*op2 << 4) + seeds[0]) ^ (*op2 + sum) ^ ((*op2 >> 5) + seeds[1]);
59 sum -= 0x9E3779B9;
60 }
61}
62
63void GBACheatReseedGameShark(uint32_t* seeds, uint16_t params, const uint8_t* t1, const uint8_t* t2) {
64 int x, y;
65 int s0 = params >> 8;
66 int s1 = params & 0xFF;
67 for (y = 0; y < 4; ++y) {
68 for (x = 0; x < 4; ++x) {
69 uint8_t z = t1[(s0 + x) & 0xFF] + t2[(s1 + y) & 0xFF];
70 seeds[y] <<= 8;
71 seeds[y] |= z;
72 }
73 }
74}
75
76void GBACheatSetGameSharkVersion(struct GBACheatSet* cheats, int version) {
77 cheats->gsaVersion = version;
78 switch (version) {
79 case 1:
80 case 2:
81 memcpy(cheats->gsaSeeds, GBACheatGameSharkSeeds, 4 * sizeof(uint32_t));
82 break;
83 case 3:
84 case 4:
85 memcpy(cheats->gsaSeeds, GBACheatProActionReplaySeeds, 4 * sizeof(uint32_t));
86 break;
87 }
88}
89
90bool GBACheatAddGameSharkRaw(struct GBACheatSet* cheats, uint32_t op1, uint32_t op2) {
91 enum GBAGameSharkType type = op1 >> 28;
92 struct mCheat* cheat = 0;
93
94 if (cheats->incompleteCheat != COMPLETE) {
95 struct mCheat* incompleteCheat = mCheatListGetPointer(&cheats->d.list, cheats->incompleteCheat);
96 if (cheats->remainingAddresses > 0) {
97 cheat = mCheatListAppend(&cheats->d.list);
98 cheat->type = CHEAT_ASSIGN;
99 cheat->width = 4;
100 cheat->address = op1;
101 cheat->operand = incompleteCheat->operand;
102 cheat->repeat = 1;
103 --cheats->remainingAddresses;
104 }
105 if (cheats->remainingAddresses > 0) {
106 cheat = mCheatListAppend(&cheats->d.list);
107 cheat->type = CHEAT_ASSIGN;
108 cheat->width = 4;
109 cheat->address = op2;
110 cheat->operand = incompleteCheat->operand;
111 cheat->repeat = 1;
112 --cheats->remainingAddresses;
113 }
114 if (cheats->remainingAddresses == 0) {
115 cheats->incompleteCheat = COMPLETE;
116 }
117 return true;
118 }
119
120 switch (type) {
121 case GSA_ASSIGN_1:
122 cheat = mCheatListAppend(&cheats->d.list);
123 cheat->type = CHEAT_ASSIGN;
124 cheat->width = 1;
125 cheat->address = op1 & 0x0FFFFFFF;
126 break;
127 case GSA_ASSIGN_2:
128 cheat = mCheatListAppend(&cheats->d.list);
129 cheat->type = CHEAT_ASSIGN;
130 cheat->width = 2;
131 cheat->address = op1 & 0x0FFFFFFF;
132 break;
133 case GSA_ASSIGN_4:
134 cheat = mCheatListAppend(&cheats->d.list);
135 cheat->type = CHEAT_ASSIGN;
136 cheat->width = 4;
137 cheat->address = op1 & 0x0FFFFFFF;
138 break;
139 case GSA_ASSIGN_LIST:
140 cheats->remainingAddresses = (op1 & 0xFFFF) - 1;
141 cheat = mCheatListAppend(&cheats->d.list);
142 cheat->type = CHEAT_ASSIGN;
143 cheat->width = 4;
144 cheat->address = op2;
145 cheats->incompleteCheat = mCheatListIndex(&cheats->d.list, cheat);
146 break;
147 case GSA_PATCH:
148 cheats->romPatches[0].address = (op1 & 0xFFFFFF) << 1;
149 cheats->romPatches[0].newValue = op2;
150 cheats->romPatches[0].applied = false;
151 cheats->romPatches[0].exists = true;
152 return true;
153 case GSA_BUTTON:
154 // TODO: Implement button
155 mLOG(CHEATS, STUB, "GameShark button unimplemented");
156 return false;
157 case GSA_IF_EQ:
158 if (op1 == 0xDEADFACE) {
159 GBACheatReseedGameShark(cheats->gsaSeeds, op2, _gsa1T1, _gsa1T2);
160 return true;
161 }
162 cheat = mCheatListAppend(&cheats->d.list);
163 cheat->type = CHEAT_IF_EQ;
164 cheat->width = 2;
165 cheat->address = op1 & 0x0FFFFFFF;
166 break;
167 case GSA_IF_EQ_RANGE:
168 cheat = mCheatListAppend(&cheats->d.list);
169 cheat->type = CHEAT_IF_EQ;
170 cheat->width = 2;
171 cheat->address = op2 & 0x0FFFFFFF;
172 cheat->operand = op1 & 0xFFFF;
173 cheat->repeat = (op1 >> 16) & 0xFF;
174 return true;
175 case GSA_HOOK:
176 if (cheats->hook) {
177 return false;
178 }
179 cheats->hook = malloc(sizeof(*cheats->hook));
180 cheats->hook->address = BASE_CART0 | (op1 & (SIZE_CART0 - 1));
181 cheats->hook->mode = MODE_THUMB;
182 cheats->hook->refs = 1;
183 cheats->hook->reentries = 0;
184 return true;
185 default:
186 return false;
187 }
188 cheat->operand = op2;
189 cheat->repeat = 1;
190 return true;
191}
192
193bool GBACheatAddGameShark(struct GBACheatSet* set, uint32_t op1, uint32_t op2) {
194 uint32_t o1 = op1;
195 uint32_t o2 = op2;
196 char line[18] = "XXXXXXXX XXXXXXXX";
197 snprintf(line, sizeof(line), "%08X %08X", op1, op2);
198
199 switch (set->gsaVersion) {
200 case 0:
201 case 3:
202 case 4:
203 GBACheatSetGameSharkVersion(set, 1);
204 // Fall through
205 case 1:
206 case 2:
207 GBACheatDecryptGameShark(&o1, &o2, set->gsaSeeds);
208 return GBACheatAddGameSharkRaw(set, o1, o2);
209 }
210 return false;
211}
212
213bool GBACheatAddGameSharkLine(struct GBACheatSet* cheats, const char* line) {
214 uint32_t op1;
215 uint32_t op2;
216 line = hex32(line, &op1);
217 if (!line) {
218 return false;
219 }
220 while (*line == ' ') {
221 ++line;
222 }
223 line = hex32(line, &op2);
224 if (!line) {
225 return false;
226 }
227 return GBACheatAddGameShark(cheats, op1, op2);
228}