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