src/gba/gba.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/gba.h>
7
8#include <mgba/internal/arm/isa-inlines.h>
9#include <mgba/internal/arm/debugger/debugger.h>
10#include <mgba/internal/arm/decoder.h>
11
12#include <mgba/internal/gba/bios.h>
13#include <mgba/internal/gba/cheats.h>
14#include <mgba/internal/gba/io.h>
15#include <mgba/internal/gba/overrides.h>
16#include <mgba/internal/gba/rr/rr.h>
17
18#include <mgba-util/patch.h>
19#include <mgba-util/crc32.h>
20#include <mgba-util/math.h>
21#include <mgba-util/memory.h>
22#include <mgba-util/vfs.h>
23
24#ifdef USE_ELF
25#include <mgba-util/elf-read.h>
26#endif
27
28mLOG_DEFINE_CATEGORY(GBA, "GBA", "gba");
29mLOG_DEFINE_CATEGORY(GBA_DEBUG, "GBA Debug", "gba.debug");
30
31const uint32_t GBA_COMPONENT_MAGIC = 0x1000000;
32
33static const size_t GBA_ROM_MAGIC_OFFSET = 3;
34static const uint8_t GBA_ROM_MAGIC[] = { 0xEA };
35
36static const size_t GBA_ROM_MAGIC_OFFSET2 = 0xB2;
37static const uint8_t GBA_ROM_MAGIC2[] = { 0x96 };
38
39static const size_t GBA_MB_MAGIC_OFFSET = 0xC0;
40
41static void GBAInit(void* cpu, struct mCPUComponent* component);
42static void GBAInterruptHandlerInit(struct ARMInterruptHandler* irqh);
43static void GBAProcessEvents(struct ARMCore* cpu);
44static void GBAHitStub(struct ARMCore* cpu, uint32_t opcode);
45static void GBAIllegal(struct ARMCore* cpu, uint32_t opcode);
46static void GBABreakpoint(struct ARMCore* cpu, int immediate);
47
48static bool _setSoftwareBreakpoint(struct ARMDebugger*, uint32_t address, enum ExecutionMode mode, uint32_t* opcode);
49static bool _clearSoftwareBreakpoint(struct ARMDebugger*, uint32_t address, enum ExecutionMode mode, uint32_t opcode);
50
51
52#ifdef FIXED_ROM_BUFFER
53extern uint32_t* romBuffer;
54extern size_t romBufferSize;
55#endif
56
57void GBACreate(struct GBA* gba) {
58 gba->d.id = GBA_COMPONENT_MAGIC;
59 gba->d.init = GBAInit;
60 gba->d.deinit = 0;
61}
62
63static void GBAInit(void* cpu, struct mCPUComponent* component) {
64 struct GBA* gba = (struct GBA*) component;
65 gba->cpu = cpu;
66 gba->debugger = 0;
67 gba->sync = 0;
68
69 GBAInterruptHandlerInit(&gba->cpu->irqh);
70 GBAMemoryInit(gba);
71
72 gba->memory.savedata.timing = &gba->timing;
73 GBASavedataInit(&gba->memory.savedata, NULL);
74
75 gba->video.p = gba;
76 GBAVideoInit(&gba->video);
77
78 gba->audio.p = gba;
79 GBAAudioInit(&gba->audio, GBA_AUDIO_SAMPLES);
80
81 GBAIOInit(gba);
82
83 gba->sio.p = gba;
84 GBASIOInit(&gba->sio);
85
86 GBAHardwareInit(&gba->memory.hw, NULL);
87
88 gba->springIRQ = 0;
89 gba->keySource = 0;
90 gba->rotationSource = 0;
91 gba->luminanceSource = 0;
92 gba->rtcSource = 0;
93 gba->rumble = 0;
94 gba->rr = 0;
95
96 gba->romVf = 0;
97 gba->biosVf = 0;
98
99 gba->stream = NULL;
100 gba->keyCallback = NULL;
101 mCoreCallbacksListInit(&gba->coreCallbacks, 0);
102
103 gba->biosChecksum = GBAChecksum(gba->memory.bios, SIZE_BIOS);
104
105 gba->idleOptimization = IDLE_LOOP_REMOVE;
106 gba->idleLoop = IDLE_LOOP_NONE;
107
108 gba->hardCrash = true;
109 gba->allowOpposingDirections = true;
110
111 gba->performingDMA = false;
112
113 gba->isPristine = false;
114 gba->pristineRomSize = 0;
115 gba->yankedRomSize = 0;
116
117 mTimingInit(&gba->timing, &gba->cpu->cycles, &gba->cpu->nextEvent);
118}
119
120void GBAUnloadROM(struct GBA* gba) {
121 if (gba->memory.rom && !gba->isPristine) {
122 if (gba->yankedRomSize) {
123 gba->yankedRomSize = 0;
124 }
125 mappedMemoryFree(gba->memory.rom, SIZE_CART0);
126 }
127
128 if (gba->romVf) {
129#ifndef FIXED_ROM_BUFFER
130 if (gba->isPristine) {
131 gba->romVf->unmap(gba->romVf, gba->memory.rom, gba->pristineRomSize);
132 }
133#endif
134 gba->romVf->close(gba->romVf);
135 gba->romVf = NULL;
136 }
137 gba->memory.rom = NULL;
138 gba->isPristine = false;
139
140 GBASavedataDeinit(&gba->memory.savedata);
141 if (gba->memory.savedata.realVf) {
142 gba->memory.savedata.realVf->close(gba->memory.savedata.realVf);
143 gba->memory.savedata.realVf = 0;
144 }
145 gba->idleLoop = IDLE_LOOP_NONE;
146}
147
148void GBADestroy(struct GBA* gba) {
149 GBAUnloadROM(gba);
150
151 if (gba->biosVf) {
152 gba->biosVf->unmap(gba->biosVf, gba->memory.bios, SIZE_BIOS);
153 gba->biosVf->close(gba->biosVf);
154 gba->biosVf = 0;
155 }
156
157 GBAMemoryDeinit(gba);
158 GBAVideoDeinit(&gba->video);
159 GBAAudioDeinit(&gba->audio);
160 GBASIODeinit(&gba->sio);
161 gba->rr = 0;
162 mTimingDeinit(&gba->timing);
163 mCoreCallbacksListDeinit(&gba->coreCallbacks);
164}
165
166void GBAInterruptHandlerInit(struct ARMInterruptHandler* irqh) {
167 irqh->reset = GBAReset;
168 irqh->processEvents = GBAProcessEvents;
169 irqh->swi16 = GBASwi16;
170 irqh->swi32 = GBASwi32;
171 irqh->hitIllegal = GBAIllegal;
172 irqh->readCPSR = GBATestIRQ;
173 irqh->hitStub = GBAHitStub;
174 irqh->bkpt16 = GBABreakpoint;
175 irqh->bkpt32 = GBABreakpoint;
176}
177
178void GBAReset(struct ARMCore* cpu) {
179 ARMSetPrivilegeMode(cpu, MODE_IRQ);
180 cpu->gprs[ARM_SP] = SP_BASE_IRQ;
181 ARMSetPrivilegeMode(cpu, MODE_SUPERVISOR);
182 cpu->gprs[ARM_SP] = SP_BASE_SUPERVISOR;
183 ARMSetPrivilegeMode(cpu, MODE_SYSTEM);
184 cpu->gprs[ARM_SP] = SP_BASE_SYSTEM;
185
186 struct GBA* gba = (struct GBA*) cpu->master;
187 if (!gba->rr || (!gba->rr->isPlaying(gba->rr) && !gba->rr->isRecording(gba->rr))) {
188 gba->memory.savedata.maskWriteback = false;
189 GBASavedataUnmask(&gba->memory.savedata);
190 }
191
192 gba->cpuBlocked = false;
193 gba->earlyExit = false;
194 if (gba->yankedRomSize) {
195 gba->memory.romSize = gba->yankedRomSize;
196 gba->memory.romMask = toPow2(gba->memory.romSize) - 1;
197 gba->yankedRomSize = 0;
198 }
199 mTimingClear(&gba->timing);
200 GBAMemoryReset(gba);
201 GBAVideoReset(&gba->video);
202 GBAAudioReset(&gba->audio);
203 GBAIOInit(gba);
204 GBATimerInit(gba);
205
206 GBASIOReset(&gba->sio);
207
208 gba->lastJump = 0;
209 gba->haltPending = false;
210 gba->idleDetectionStep = 0;
211 gba->idleDetectionFailures = 0;
212
213 gba->debug = false;
214 memset(gba->debugString, 0, sizeof(gba->debugString));
215 if (gba->pristineRomSize > SIZE_CART0) {
216 GBAMatrixReset(gba);
217 }
218
219 if (!gba->romVf && gba->memory.rom) {
220 GBASkipBIOS(gba);
221 }
222}
223
224void GBASkipBIOS(struct GBA* gba) {
225 struct ARMCore* cpu = gba->cpu;
226 if (cpu->gprs[ARM_PC] == BASE_RESET + WORD_SIZE_ARM) {
227 if (gba->memory.rom) {
228 cpu->gprs[ARM_PC] = BASE_CART0;
229 } else {
230 cpu->gprs[ARM_PC] = BASE_WORKING_RAM;
231 }
232 gba->memory.io[REG_VCOUNT >> 1] = 0x7E;
233 gba->memory.io[REG_POSTFLG >> 1] = 1;
234 int currentCycles = 0;
235 ARM_WRITE_PC;
236 }
237}
238
239static void GBAProcessEvents(struct ARMCore* cpu) {
240 struct GBA* gba = (struct GBA*) cpu->master;
241
242 gba->bus = cpu->prefetch[1];
243 if (cpu->executionMode == MODE_THUMB) {
244 gba->bus |= cpu->prefetch[1] << 16;
245 }
246
247 if (gba->springIRQ && !cpu->cpsr.i) {
248 ARMRaiseIRQ(cpu);
249 gba->springIRQ = 0;
250 }
251
252 int32_t nextEvent = cpu->nextEvent;
253 while (cpu->cycles >= nextEvent) {
254 cpu->nextEvent = INT_MAX;
255 nextEvent = 0;
256 do {
257 int32_t cycles = cpu->cycles;
258 cpu->cycles = 0;
259#ifndef NDEBUG
260 if (cycles < 0) {
261 mLOG(GBA, FATAL, "Negative cycles passed: %i", cycles);
262 }
263#endif
264 nextEvent = mTimingTick(&gba->timing, nextEvent + cycles);
265 } while (gba->cpuBlocked);
266
267 cpu->nextEvent = nextEvent;
268 if (cpu->halted) {
269 cpu->cycles = nextEvent;
270 if (!gba->memory.io[REG_IME >> 1] || !gba->memory.io[REG_IE >> 1]) {
271 break;
272 }
273 }
274#ifndef NDEBUG
275 else if (nextEvent < 0) {
276 mLOG(GBA, FATAL, "Negative cycles will pass: %i", nextEvent);
277 }
278#endif
279 if (gba->earlyExit) {
280 break;
281 }
282 }
283 gba->earlyExit = false;
284#ifndef NDEBUG
285 if (gba->cpuBlocked) {
286 mLOG(GBA, FATAL, "CPU is blocked!");
287 }
288#endif
289}
290
291#ifdef USE_DEBUGGERS
292void GBAAttachDebugger(struct GBA* gba, struct mDebugger* debugger) {
293 gba->debugger = (struct ARMDebugger*) debugger->platform;
294 gba->debugger->setSoftwareBreakpoint = _setSoftwareBreakpoint;
295 gba->debugger->clearSoftwareBreakpoint = _clearSoftwareBreakpoint;
296 gba->cpu->components[CPU_COMPONENT_DEBUGGER] = &debugger->d;
297 ARMHotplugAttach(gba->cpu, CPU_COMPONENT_DEBUGGER);
298}
299
300void GBADetachDebugger(struct GBA* gba) {
301 if (gba->debugger) {
302 ARMHotplugDetach(gba->cpu, CPU_COMPONENT_DEBUGGER);
303 }
304 gba->cpu->components[CPU_COMPONENT_DEBUGGER] = NULL;
305 gba->debugger = NULL;
306}
307#endif
308
309bool GBALoadNull(struct GBA* gba) {
310 GBAUnloadROM(gba);
311 gba->romVf = NULL;
312 gba->pristineRomSize = 0;
313#ifndef FIXED_ROM_BUFFER
314 gba->memory.rom = anonymousMemoryMap(SIZE_CART0);
315#else
316 gba->memory.rom = romBuffer;
317#endif
318 gba->isPristine = false;
319 gba->yankedRomSize = 0;
320 gba->memory.romSize = SIZE_CART0;
321 gba->memory.romMask = SIZE_CART0 - 1;
322 gba->memory.mirroring = false;
323 gba->romCrc32 = 0;
324
325 if (gba->cpu) {
326 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
327 }
328 return true;
329}
330
331bool GBALoadMB(struct GBA* gba, struct VFile* vf) {
332 GBAUnloadROM(gba);
333 gba->romVf = vf;
334 gba->pristineRomSize = vf->size(vf);
335 vf->seek(vf, 0, SEEK_SET);
336 if (gba->pristineRomSize > SIZE_WORKING_RAM) {
337 gba->pristineRomSize = SIZE_WORKING_RAM;
338 }
339 gba->isPristine = true;
340 memset(gba->memory.wram, 0, SIZE_WORKING_RAM);
341 vf->read(vf, gba->memory.wram, gba->pristineRomSize);
342 if (!gba->memory.wram) {
343 mLOG(GBA, WARN, "Couldn't map ROM");
344 return false;
345 }
346 gba->yankedRomSize = 0;
347 gba->memory.romSize = 0;
348 gba->memory.romMask = 0;
349 gba->romCrc32 = doCrc32(gba->memory.wram, gba->pristineRomSize);
350 if (gba->cpu && gba->memory.activeRegion == REGION_WORKING_RAM) {
351 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
352 }
353 return true;
354}
355
356bool GBALoadROM(struct GBA* gba, struct VFile* vf) {
357 if (!vf) {
358 return false;
359 }
360 GBAUnloadROM(gba);
361 gba->romVf = vf;
362 gba->pristineRomSize = vf->size(vf);
363 vf->seek(vf, 0, SEEK_SET);
364 if (gba->pristineRomSize > SIZE_CART0) {
365 gba->isPristine = false;
366 gba->memory.romSize = 0x01000000;
367#ifdef FIXED_ROM_BUFFER
368 gba->memory.rom = romBuffer;
369#else
370 gba->memory.rom = anonymousMemoryMap(SIZE_CART0);
371#endif
372 } else {
373 gba->isPristine = true;
374#ifdef FIXED_ROM_BUFFER
375 if (gba->pristineRomSize <= romBufferSize) {
376 gba->memory.rom = romBuffer;
377 vf->read(vf, romBuffer, gba->pristineRomSize);
378 }
379#else
380 gba->memory.rom = vf->map(vf, gba->pristineRomSize, MAP_READ);
381#endif
382 gba->memory.romSize = gba->pristineRomSize;
383 }
384 if (!gba->memory.rom) {
385 mLOG(GBA, WARN, "Couldn't map ROM");
386 return false;
387 }
388 gba->yankedRomSize = 0;
389 gba->memory.romMask = toPow2(gba->memory.romSize) - 1;
390 gba->memory.mirroring = false;
391 gba->romCrc32 = doCrc32(gba->memory.rom, gba->memory.romSize);
392 GBAHardwareInit(&gba->memory.hw, &((uint16_t*) gba->memory.rom)[GPIO_REG_DATA >> 1]);
393 GBAVFameDetect(&gba->memory.vfame, gba->memory.rom, gba->memory.romSize);
394 if (popcount32(gba->memory.romSize) != 1) {
395 // This ROM is either a bad dump or homebrew. Emulate flash cart behavior.
396#ifndef FIXED_ROM_BUFFER
397 void* newRom = anonymousMemoryMap(SIZE_CART0);
398 memcpy(newRom, gba->memory.rom, gba->pristineRomSize);
399 gba->memory.rom = newRom;
400#endif
401 gba->memory.romSize = SIZE_CART0;
402 gba->memory.romMask = SIZE_CART0 - 1;
403 gba->isPristine = false;
404 }
405 if (gba->cpu && gba->memory.activeRegion >= REGION_CART0) {
406 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
407 }
408 // TODO: error check
409 return true;
410}
411
412bool GBALoadSave(struct GBA* gba, struct VFile* sav) {
413 GBASavedataInit(&gba->memory.savedata, sav);
414 return true;
415}
416
417void GBAYankROM(struct GBA* gba) {
418 gba->yankedRomSize = gba->memory.romSize;
419 gba->memory.romSize = 0;
420 gba->memory.romMask = 0;
421 GBARaiseIRQ(gba, IRQ_GAMEPAK);
422}
423
424void GBALoadBIOS(struct GBA* gba, struct VFile* vf) {
425 gba->biosVf = vf;
426 uint32_t* bios = vf->map(vf, SIZE_BIOS, MAP_READ);
427 if (!bios) {
428 mLOG(GBA, WARN, "Couldn't map BIOS");
429 return;
430 }
431 gba->memory.bios = bios;
432 gba->memory.fullBios = 1;
433 uint32_t checksum = GBAChecksum(gba->memory.bios, SIZE_BIOS);
434 mLOG(GBA, DEBUG, "BIOS Checksum: 0x%X", checksum);
435 if (checksum == GBA_BIOS_CHECKSUM) {
436 mLOG(GBA, INFO, "Official GBA BIOS detected");
437 } else if (checksum == GBA_DS_BIOS_CHECKSUM) {
438 mLOG(GBA, INFO, "Official GBA (DS) BIOS detected");
439 } else {
440 mLOG(GBA, WARN, "BIOS checksum incorrect");
441 }
442 gba->biosChecksum = checksum;
443 if (gba->memory.activeRegion == REGION_BIOS) {
444 gba->cpu->memory.activeRegion = gba->memory.bios;
445 }
446 // TODO: error check
447}
448
449void GBAApplyPatch(struct GBA* gba, struct Patch* patch) {
450 size_t patchedSize = patch->outputSize(patch, gba->memory.romSize);
451 if (!patchedSize || patchedSize > SIZE_CART0) {
452 return;
453 }
454 void* newRom = anonymousMemoryMap(SIZE_CART0);
455 if (!patch->applyPatch(patch, gba->memory.rom, gba->pristineRomSize, newRom, patchedSize)) {
456 mappedMemoryFree(newRom, SIZE_CART0);
457 return;
458 }
459 if (gba->romVf) {
460#ifndef FIXED_ROM_BUFFER
461 gba->romVf->unmap(gba->romVf, gba->memory.rom, gba->pristineRomSize);
462#endif
463 gba->romVf->close(gba->romVf);
464 gba->romVf = NULL;
465 }
466 gba->isPristine = false;
467 gba->memory.rom = newRom;
468 gba->memory.hw.gpioBase = &((uint16_t*) gba->memory.rom)[GPIO_REG_DATA >> 1];
469 gba->memory.romSize = patchedSize;
470 gba->memory.romMask = SIZE_CART0 - 1;
471 gba->romCrc32 = doCrc32(gba->memory.rom, gba->memory.romSize);
472}
473
474void GBAWriteIE(struct GBA* gba, uint16_t value) {
475 if (gba->memory.io[REG_IME >> 1] && value & gba->memory.io[REG_IF >> 1]) {
476 ARMRaiseIRQ(gba->cpu);
477 }
478}
479
480void GBAWriteIME(struct GBA* gba, uint16_t value) {
481 if (value && gba->memory.io[REG_IE >> 1] & gba->memory.io[REG_IF >> 1]) {
482 ARMRaiseIRQ(gba->cpu);
483 }
484}
485
486void GBARaiseIRQ(struct GBA* gba, enum GBAIRQ irq) {
487 gba->memory.io[REG_IF >> 1] |= 1 << irq;
488
489 if (gba->memory.io[REG_IE >> 1] & 1 << irq) {
490 gba->cpu->halted = 0;
491 if (gba->memory.io[REG_IME >> 1]) {
492 ARMRaiseIRQ(gba->cpu);
493 }
494 }
495}
496
497void GBATestIRQ(struct ARMCore* cpu) {
498 struct GBA* gba = (struct GBA*) cpu->master;
499 if (gba->memory.io[REG_IME >> 1] && gba->memory.io[REG_IE >> 1] & gba->memory.io[REG_IF >> 1]) {
500 gba->springIRQ = gba->memory.io[REG_IE >> 1] & gba->memory.io[REG_IF >> 1];
501 gba->cpu->nextEvent = gba->cpu->cycles;
502 }
503}
504
505void GBAHalt(struct GBA* gba) {
506 gba->cpu->nextEvent = gba->cpu->cycles;
507 gba->cpu->halted = 1;
508}
509
510void GBAStop(struct GBA* gba) {
511 size_t c;
512 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
513 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
514 if (callbacks->sleep) {
515 callbacks->sleep(callbacks->context);
516 }
517 }
518 gba->cpu->nextEvent = gba->cpu->cycles;
519}
520
521void GBADebug(struct GBA* gba, uint16_t flags) {
522 gba->debugFlags = flags;
523 if (GBADebugFlagsIsSend(gba->debugFlags)) {
524 int level = 1 << GBADebugFlagsGetLevel(gba->debugFlags);
525 level &= 0x1F;
526 char oolBuf[0x101];
527 strncpy(oolBuf, gba->debugString, sizeof(gba->debugString));
528 memset(gba->debugString, 0, sizeof(gba->debugString));
529 oolBuf[0x100] = '\0';
530 mLog(_mLOG_CAT_GBA_DEBUG(), level, "%s", oolBuf);
531 }
532 gba->debugFlags = GBADebugFlagsClearSend(gba->debugFlags);
533}
534
535bool GBAIsROM(struct VFile* vf) {
536#ifdef USE_ELF
537 struct ELF* elf = ELFOpen(vf);
538 if (elf) {
539 uint32_t entry = ELFEntry(elf);
540 bool isGBA = true;
541 isGBA = isGBA && ELFMachine(elf) == EM_ARM;
542 isGBA = isGBA && (entry == BASE_CART0 || entry == BASE_WORKING_RAM);
543 ELFClose(elf);
544 return isGBA;
545 }
546#endif
547 if (!vf) {
548 return false;
549 }
550
551 uint8_t signature[sizeof(GBA_ROM_MAGIC) + sizeof(GBA_ROM_MAGIC2)];
552 if (vf->seek(vf, GBA_ROM_MAGIC_OFFSET, SEEK_SET) < 0) {
553 return false;
554 }
555 if (vf->read(vf, &signature, sizeof(GBA_ROM_MAGIC)) != sizeof(GBA_ROM_MAGIC)) {
556 return false;
557 }
558 if (memcmp(signature, GBA_ROM_MAGIC, sizeof(GBA_ROM_MAGIC)) != 0) {
559 return false;
560 }
561
562 if (vf->seek(vf, GBA_ROM_MAGIC_OFFSET2, SEEK_SET) < 0) {
563 return false;
564 }
565 if (vf->read(vf, &signature, sizeof(GBA_ROM_MAGIC2)) != sizeof(GBA_ROM_MAGIC2)) {
566 return false;
567 }
568 if (memcmp(signature, GBA_ROM_MAGIC2, sizeof(GBA_ROM_MAGIC2)) != 0) {
569 // If the signature byte is missing then we must be using an unfixed ROM
570 uint32_t buffer[0x9C / sizeof(uint32_t)];
571 if (vf->seek(vf, 0x4, SEEK_SET) < 0) {
572 return false;
573 }
574 if (vf->read(vf, &buffer, sizeof(buffer)) != sizeof(buffer)) {
575 return false;
576 }
577 uint32_t bits = 0;
578 size_t i;
579 for (i = 0; i < sizeof(buffer) / sizeof(*buffer); ++i) {
580 bits |= buffer[i];
581 }
582 if (bits) {
583 return false;
584 }
585 }
586
587
588 if (GBAIsBIOS(vf)) {
589 return false;
590 }
591 return true;
592}
593
594bool GBAIsMB(struct VFile* vf) {
595 if (!GBAIsROM(vf)) {
596 return false;
597 }
598#ifdef USE_ELF
599 struct ELF* elf = ELFOpen(vf);
600 if (elf) {
601 bool isMB = ELFEntry(elf) == BASE_WORKING_RAM;
602 ELFClose(elf);
603 return isMB;
604 }
605#endif
606 if (vf->size(vf) > SIZE_WORKING_RAM) {
607 return false;
608 }
609 if (vf->seek(vf, GBA_MB_MAGIC_OFFSET, SEEK_SET) < 0) {
610 return false;
611 }
612 uint32_t signature;
613 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
614 return false;
615 }
616 uint32_t opcode;
617 LOAD_32(opcode, 0, &signature);
618 struct ARMInstructionInfo info;
619 ARMDecodeARM(opcode, &info);
620 if (info.branchType == ARM_BRANCH) {
621 if (info.op1.immediate <= 0) {
622 return false;
623 } else if (info.op1.immediate == 28) {
624 // Ancient toolchain that is known to throw MB detection for a loop
625 return false;
626 } else if (info.op1.immediate != 24) {
627 return true;
628 }
629 }
630
631 uint32_t pc = GBA_MB_MAGIC_OFFSET;
632 int i;
633 for (i = 0; i < 80; ++i) {
634 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
635 break;
636 }
637 pc += 4;
638 LOAD_32(opcode, 0, &signature);
639 ARMDecodeARM(opcode, &info);
640 if (info.mnemonic != ARM_MN_LDR) {
641 continue;
642 }
643 if ((info.operandFormat & ARM_OPERAND_MEMORY) && info.memory.baseReg == ARM_PC && info.memory.format & ARM_MEMORY_IMMEDIATE_OFFSET) {
644 uint32_t immediate = info.memory.offset.immediate;
645 if (info.memory.format & ARM_MEMORY_OFFSET_SUBTRACT) {
646 immediate = -immediate;
647 }
648 immediate += pc + 8;
649 if (vf->seek(vf, immediate, SEEK_SET) < 0) {
650 break;
651 }
652 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
653 break;
654 }
655 LOAD_32(immediate, 0, &signature);
656 if (vf->seek(vf, pc, SEEK_SET) < 0) {
657 break;
658 }
659 if ((immediate & ~0x7FF) == BASE_WORKING_RAM) {
660 return true;
661 }
662 }
663 }
664 // Found a libgba-linked cart...these are a bit harder to detect.
665 return false;
666}
667
668bool GBAIsBIOS(struct VFile* vf) {
669 if (vf->seek(vf, 0, SEEK_SET) < 0) {
670 return false;
671 }
672 uint8_t interruptTable[7 * 4];
673 if (vf->read(vf, &interruptTable, sizeof(interruptTable)) != sizeof(interruptTable)) {
674 return false;
675 }
676 int i;
677 for (i = 0; i < 7; ++i) {
678 if (interruptTable[4 * i + 3] != 0xEA || interruptTable[4 * i + 2]) {
679 return false;
680 }
681 }
682 return true;
683}
684
685void GBAGetGameCode(const struct GBA* gba, char* out) {
686 memset(out, 0, 8);
687 if (!gba->memory.rom) {
688 return;
689 }
690
691 memcpy(out, "AGB-", 4);
692 memcpy(&out[4], &((struct GBACartridge*) gba->memory.rom)->id, 4);
693}
694
695void GBAGetGameTitle(const struct GBA* gba, char* out) {
696 if (gba->memory.rom) {
697 memcpy(out, &((struct GBACartridge*) gba->memory.rom)->title, 12);
698 return;
699 }
700 if (gba->isPristine && gba->memory.wram) {
701 memcpy(out, &((struct GBACartridge*) gba->memory.wram)->title, 12);
702 return;
703 }
704 strncpy(out, "(BIOS)", 12);
705}
706
707void GBAHitStub(struct ARMCore* cpu, uint32_t opcode) {
708 struct GBA* gba = (struct GBA*) cpu->master;
709#ifdef USE_DEBUGGERS
710 if (gba->debugger) {
711 struct mDebuggerEntryInfo info = {
712 .address = _ARMPCAddress(cpu),
713 .type.bp.opcode = opcode
714 };
715 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_ILLEGAL_OP, &info);
716 }
717#endif
718 // TODO: More sensible category?
719 mLOG(GBA, ERROR, "Stub opcode: %08x", opcode);
720}
721
722void GBAIllegal(struct ARMCore* cpu, uint32_t opcode) {
723 struct GBA* gba = (struct GBA*) cpu->master;
724 if (!gba->yankedRomSize) {
725 // TODO: More sensible category?
726 mLOG(GBA, WARN, "Illegal opcode: %08x", opcode);
727 }
728 if (cpu->executionMode == MODE_THUMB && (opcode & 0xFFC0) == 0xE800) {
729 mLOG(GBA, DEBUG, "Hit Wii U VC opcode: %08x", opcode);
730 return;
731 }
732#ifdef USE_DEBUGGERS
733 if (gba->debugger) {
734 struct mDebuggerEntryInfo info = {
735 .address = _ARMPCAddress(cpu),
736 .type.bp.opcode = opcode
737 };
738 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_ILLEGAL_OP, &info);
739 } else
740#endif
741 {
742 ARMRaiseUndefined(cpu);
743 }
744}
745
746void GBABreakpoint(struct ARMCore* cpu, int immediate) {
747 struct GBA* gba = (struct GBA*) cpu->master;
748 if (immediate >= CPU_COMPONENT_MAX) {
749 return;
750 }
751 switch (immediate) {
752#ifdef USE_DEBUGGERS
753 case CPU_COMPONENT_DEBUGGER:
754 if (gba->debugger) {
755 struct mDebuggerEntryInfo info = {
756 .address = _ARMPCAddress(cpu),
757 .type.bp.breakType = BREAKPOINT_SOFTWARE
758 };
759 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_BREAKPOINT, &info);
760 }
761 break;
762#endif
763 case CPU_COMPONENT_CHEAT_DEVICE:
764 if (gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE]) {
765 struct mCheatDevice* device = (struct mCheatDevice*) gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE];
766 struct GBACheatHook* hook = 0;
767 size_t i;
768 for (i = 0; i < mCheatSetsSize(&device->cheats); ++i) {
769 struct GBACheatSet* cheats = (struct GBACheatSet*) *mCheatSetsGetPointer(&device->cheats, i);
770 if (cheats->hook && cheats->hook->address == _ARMPCAddress(cpu)) {
771 mCheatRefresh(device, &cheats->d);
772 hook = cheats->hook;
773 }
774 }
775 if (hook) {
776 ARMRunFake(cpu, hook->patchedOpcode);
777 }
778 }
779 break;
780 default:
781 break;
782 }
783}
784
785void GBAFrameStarted(struct GBA* gba) {
786 GBATestKeypadIRQ(gba);
787
788 size_t c;
789 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
790 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
791 if (callbacks->videoFrameStarted) {
792 callbacks->videoFrameStarted(callbacks->context);
793 }
794 }
795}
796
797void GBAFrameEnded(struct GBA* gba) {
798 GBASavedataClean(&gba->memory.savedata, gba->video.frameCounter);
799
800 if (gba->rr) {
801 gba->rr->nextFrame(gba->rr);
802 }
803
804 if (gba->cpu->components && gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE]) {
805 struct mCheatDevice* device = (struct mCheatDevice*) gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE];
806 size_t i;
807 for (i = 0; i < mCheatSetsSize(&device->cheats); ++i) {
808 struct GBACheatSet* cheats = (struct GBACheatSet*) *mCheatSetsGetPointer(&device->cheats, i);
809 if (!cheats->hook) {
810 mCheatRefresh(device, &cheats->d);
811 }
812 }
813 }
814
815 if (gba->stream && gba->stream->postVideoFrame) {
816 const color_t* pixels;
817 size_t stride;
818 gba->video.renderer->getPixels(gba->video.renderer, &stride, (const void**) &pixels);
819 gba->stream->postVideoFrame(gba->stream, pixels, stride);
820 }
821
822 if (gba->memory.hw.devices & (HW_GB_PLAYER | HW_GB_PLAYER_DETECTION)) {
823 GBAHardwarePlayerUpdate(gba);
824 }
825
826 size_t c;
827 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
828 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
829 if (callbacks->videoFrameEnded) {
830 callbacks->videoFrameEnded(callbacks->context);
831 }
832 }
833}
834
835void GBATestKeypadIRQ(struct GBA* gba) {
836 uint16_t keycnt = gba->memory.io[REG_KEYCNT >> 1];
837 if (!(keycnt & 0x4000)) {
838 return;
839 }
840 int isAnd = keycnt & 0x8000;
841 if (!gba->keySource) {
842 // TODO?
843 return;
844 }
845
846 keycnt &= 0x3FF;
847 uint16_t keyInput = *gba->keySource & keycnt;
848
849 if (isAnd && keycnt == keyInput) {
850 GBARaiseIRQ(gba, IRQ_KEYPAD);
851 } else if (!isAnd && keyInput) {
852 GBARaiseIRQ(gba, IRQ_KEYPAD);
853 }
854}
855
856void GBASetBreakpoint(struct GBA* gba, struct mCPUComponent* component, uint32_t address, enum ExecutionMode mode, uint32_t* opcode) {
857 size_t immediate;
858 for (immediate = 0; immediate < gba->cpu->numComponents; ++immediate) {
859 if (gba->cpu->components[immediate] == component) {
860 break;
861 }
862 }
863 if (immediate == gba->cpu->numComponents) {
864 return;
865 }
866 if (mode == MODE_ARM) {
867 int32_t value;
868 int32_t old;
869 value = 0xE1200070;
870 value |= immediate & 0xF;
871 value |= (immediate & 0xFFF0) << 4;
872 GBAPatch32(gba->cpu, address, value, &old);
873 *opcode = old;
874 } else {
875 int16_t value;
876 int16_t old;
877 value = 0xBE00;
878 value |= immediate & 0xFF;
879 GBAPatch16(gba->cpu, address, value, &old);
880 *opcode = (uint16_t) old;
881 }
882}
883
884void GBAClearBreakpoint(struct GBA* gba, uint32_t address, enum ExecutionMode mode, uint32_t opcode) {
885 if (mode == MODE_ARM) {
886 GBAPatch32(gba->cpu, address, opcode, 0);
887 } else {
888 GBAPatch16(gba->cpu, address, opcode, 0);
889 }
890}
891
892static bool _setSoftwareBreakpoint(struct ARMDebugger* debugger, uint32_t address, enum ExecutionMode mode, uint32_t* opcode) {
893 GBASetBreakpoint((struct GBA*) debugger->cpu->master, &debugger->d.p->d, address, mode, opcode);
894 return true;
895}
896
897static bool _clearSoftwareBreakpoint(struct ARMDebugger* debugger, uint32_t address, enum ExecutionMode mode, uint32_t opcode) {
898 GBAClearBreakpoint((struct GBA*) debugger->cpu->master, address, mode, opcode);
899 return true;
900}