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