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 if (!gba->romVf && gba->memory.rom) {
246 GBASkipBIOS(gba);
247 }
248}
249
250void GBASkipBIOS(struct GBA* gba) {
251 struct ARMCore* cpu = gba->cpu;
252 if (cpu->gprs[ARM_PC] == BASE_RESET + WORD_SIZE_ARM) {
253 if (gba->memory.rom) {
254 cpu->gprs[ARM_PC] = BASE_CART0;
255 } else {
256 cpu->gprs[ARM_PC] = BASE_WORKING_RAM;
257 }
258 gba->video.vcount = 0x7D;
259 gba->memory.io[REG_VCOUNT >> 1] = 0x7D;
260 gba->memory.io[REG_POSTFLG >> 1] = 1;
261 ARMWritePC(cpu);
262 }
263}
264
265static void GBAProcessEvents(struct ARMCore* cpu) {
266 struct GBA* gba = (struct GBA*) cpu->master;
267
268 gba->bus = cpu->prefetch[1];
269 if (cpu->executionMode == MODE_THUMB) {
270 gba->bus |= cpu->prefetch[1] << 16;
271 }
272
273 int32_t nextEvent = cpu->nextEvent;
274 while (cpu->cycles >= nextEvent) {
275 cpu->nextEvent = INT_MAX;
276 nextEvent = 0;
277 do {
278 int32_t cycles = cpu->cycles;
279 cpu->cycles = 0;
280#ifndef NDEBUG
281 if (cycles < 0) {
282 mLOG(GBA, FATAL, "Negative cycles passed: %i", cycles);
283 }
284#endif
285 nextEvent = mTimingTick(&gba->timing, nextEvent + cycles);
286 } while (gba->cpuBlocked);
287
288 cpu->nextEvent = nextEvent;
289 if (cpu->halted) {
290 cpu->cycles = nextEvent;
291 if (!gba->memory.io[REG_IME >> 1] || !gba->memory.io[REG_IE >> 1]) {
292 break;
293 }
294 }
295#ifndef NDEBUG
296 else if (nextEvent < 0) {
297 mLOG(GBA, FATAL, "Negative cycles will pass: %i", nextEvent);
298 }
299#endif
300 if (gba->earlyExit) {
301 break;
302 }
303 }
304 gba->earlyExit = false;
305#ifndef NDEBUG
306 if (gba->cpuBlocked) {
307 mLOG(GBA, FATAL, "CPU is blocked!");
308 }
309#endif
310}
311
312#ifdef USE_DEBUGGERS
313void GBAAttachDebugger(struct GBA* gba, struct mDebugger* debugger) {
314 gba->debugger = (struct ARMDebugger*) debugger->platform;
315 gba->debugger->setSoftwareBreakpoint = _setSoftwareBreakpoint;
316 gba->debugger->clearSoftwareBreakpoint = _clearSoftwareBreakpoint;
317 gba->cpu->components[CPU_COMPONENT_DEBUGGER] = &debugger->d;
318 ARMHotplugAttach(gba->cpu, CPU_COMPONENT_DEBUGGER);
319}
320
321void GBADetachDebugger(struct GBA* gba) {
322 if (gba->debugger) {
323 ARMHotplugDetach(gba->cpu, CPU_COMPONENT_DEBUGGER);
324 }
325 gba->cpu->components[CPU_COMPONENT_DEBUGGER] = NULL;
326 gba->debugger = NULL;
327}
328#endif
329
330bool GBALoadNull(struct GBA* gba) {
331 GBAUnloadROM(gba);
332 gba->romVf = NULL;
333 gba->pristineRomSize = 0;
334#ifndef FIXED_ROM_BUFFER
335 gba->memory.rom = anonymousMemoryMap(SIZE_CART0);
336#else
337 gba->memory.rom = romBuffer;
338#endif
339 gba->isPristine = false;
340 gba->yankedRomSize = 0;
341 gba->memory.romSize = SIZE_CART0;
342 gba->memory.romMask = SIZE_CART0 - 1;
343 gba->memory.mirroring = false;
344 gba->romCrc32 = 0;
345
346 if (gba->cpu) {
347 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
348 }
349 return true;
350}
351
352bool GBALoadMB(struct GBA* gba, struct VFile* vf) {
353 GBAUnloadROM(gba);
354 gba->romVf = vf;
355 gba->pristineRomSize = vf->size(vf);
356 vf->seek(vf, 0, SEEK_SET);
357 if (gba->pristineRomSize > SIZE_WORKING_RAM) {
358 gba->pristineRomSize = SIZE_WORKING_RAM;
359 }
360 gba->isPristine = true;
361 memset(gba->memory.wram, 0, SIZE_WORKING_RAM);
362 gba->yankedRomSize = 0;
363 gba->memory.romSize = 0;
364 gba->memory.romMask = 0;
365 gba->romCrc32 = doCrc32(gba->memory.wram, gba->pristineRomSize);
366 if (gba->cpu && gba->memory.activeRegion == REGION_WORKING_RAM) {
367 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
368 }
369 return true;
370}
371
372bool GBALoadROM(struct GBA* gba, struct VFile* vf) {
373 if (!vf) {
374 return false;
375 }
376 GBAUnloadROM(gba);
377 gba->romVf = vf;
378 gba->pristineRomSize = vf->size(vf);
379 vf->seek(vf, 0, SEEK_SET);
380 if (gba->pristineRomSize > SIZE_CART0) {
381 gba->isPristine = false;
382 gba->memory.romSize = 0x01000000;
383#ifdef FIXED_ROM_BUFFER
384 gba->memory.rom = romBuffer;
385#else
386 gba->memory.rom = anonymousMemoryMap(SIZE_CART0);
387#endif
388 } else {
389 gba->isPristine = true;
390#ifdef FIXED_ROM_BUFFER
391 if (gba->pristineRomSize <= romBufferSize) {
392 gba->memory.rom = romBuffer;
393 vf->read(vf, romBuffer, gba->pristineRomSize);
394 }
395#else
396 gba->memory.rom = vf->map(vf, gba->pristineRomSize, MAP_READ);
397#endif
398 gba->memory.romSize = gba->pristineRomSize;
399 }
400 if (!gba->memory.rom) {
401 mLOG(GBA, WARN, "Couldn't map ROM");
402 return false;
403 }
404 gba->yankedRomSize = 0;
405 gba->memory.romMask = toPow2(gba->memory.romSize) - 1;
406 gba->memory.mirroring = false;
407 gba->romCrc32 = doCrc32(gba->memory.rom, gba->memory.romSize);
408 if (popcount32(gba->memory.romSize) != 1) {
409 // This ROM is either a bad dump or homebrew. Emulate flash cart behavior.
410#ifndef FIXED_ROM_BUFFER
411 void* newRom = anonymousMemoryMap(SIZE_CART0);
412 memcpy(newRom, gba->memory.rom, gba->pristineRomSize);
413 gba->memory.rom = newRom;
414#endif
415 gba->memory.romSize = SIZE_CART0;
416 gba->memory.romMask = SIZE_CART0 - 1;
417 gba->isPristine = false;
418 }
419 if (gba->cpu && gba->memory.activeRegion >= REGION_CART0) {
420 gba->cpu->memory.setActiveRegion(gba->cpu, gba->cpu->gprs[ARM_PC]);
421 }
422 GBAHardwareInit(&gba->memory.hw, &((uint16_t*) gba->memory.rom)[GPIO_REG_DATA >> 1]);
423 GBAVFameDetect(&gba->memory.vfame, gba->memory.rom, gba->memory.romSize);
424 // TODO: error check
425 return true;
426}
427
428bool GBALoadSave(struct GBA* gba, struct VFile* sav) {
429 GBASavedataInit(&gba->memory.savedata, sav);
430 return true;
431}
432
433void GBAYankROM(struct GBA* gba) {
434 gba->yankedRomSize = gba->memory.romSize;
435 gba->memory.romSize = 0;
436 gba->memory.romMask = 0;
437 GBARaiseIRQ(gba, IRQ_GAMEPAK, 0);
438}
439
440void GBALoadBIOS(struct GBA* gba, struct VFile* vf) {
441 gba->biosVf = vf;
442 uint32_t* bios = vf->map(vf, SIZE_BIOS, MAP_READ);
443 if (!bios) {
444 mLOG(GBA, WARN, "Couldn't map BIOS");
445 return;
446 }
447 gba->memory.bios = bios;
448 gba->memory.fullBios = 1;
449 uint32_t checksum = GBAChecksum(gba->memory.bios, SIZE_BIOS);
450 mLOG(GBA, DEBUG, "BIOS Checksum: 0x%X", checksum);
451 if (checksum == GBA_BIOS_CHECKSUM) {
452 mLOG(GBA, INFO, "Official GBA BIOS detected");
453 } else if (checksum == GBA_DS_BIOS_CHECKSUM) {
454 mLOG(GBA, INFO, "Official GBA (DS) BIOS detected");
455 } else {
456 mLOG(GBA, WARN, "BIOS checksum incorrect");
457 }
458 gba->biosChecksum = checksum;
459 if (gba->memory.activeRegion == REGION_BIOS) {
460 gba->cpu->memory.activeRegion = gba->memory.bios;
461 }
462 // TODO: error check
463}
464
465void GBAApplyPatch(struct GBA* gba, struct Patch* patch) {
466 size_t patchedSize = patch->outputSize(patch, gba->memory.romSize);
467 if (!patchedSize || patchedSize > SIZE_CART0) {
468 return;
469 }
470 void* newRom = anonymousMemoryMap(SIZE_CART0);
471 if (!patch->applyPatch(patch, gba->memory.rom, gba->pristineRomSize, newRom, patchedSize)) {
472 mappedMemoryFree(newRom, SIZE_CART0);
473 return;
474 }
475 if (gba->romVf) {
476#ifndef FIXED_ROM_BUFFER
477 gba->romVf->unmap(gba->romVf, gba->memory.rom, gba->pristineRomSize);
478#endif
479 gba->romVf->close(gba->romVf);
480 gba->romVf = NULL;
481 }
482 gba->isPristine = false;
483 gba->memory.rom = newRom;
484 gba->memory.hw.gpioBase = &((uint16_t*) gba->memory.rom)[GPIO_REG_DATA >> 1];
485 gba->memory.romSize = patchedSize;
486 gba->memory.romMask = SIZE_CART0 - 1;
487 gba->romCrc32 = doCrc32(gba->memory.rom, gba->memory.romSize);
488}
489
490void GBARaiseIRQ(struct GBA* gba, enum GBAIRQ irq, uint32_t cyclesLate) {
491 gba->memory.io[REG_IF >> 1] |= 1 << irq;
492 GBATestIRQ(gba, cyclesLate);
493}
494
495void GBATestIRQNoDelay(struct ARMCore* cpu) {
496 struct GBA* gba = (struct GBA*) cpu->master;
497 GBATestIRQ(gba, 0);
498}
499
500void GBATestIRQ(struct GBA* gba, uint32_t cyclesLate) {
501 if (gba->memory.io[REG_IE >> 1] & gba->memory.io[REG_IF >> 1]) {
502 if (!mTimingIsScheduled(&gba->timing, &gba->irqEvent)) {
503 mTimingSchedule(&gba->timing, &gba->irqEvent, GBA_IRQ_DELAY - cyclesLate);
504 }
505 }
506}
507
508void GBAHalt(struct GBA* gba) {
509 gba->cpu->nextEvent = gba->cpu->cycles;
510 gba->cpu->halted = 1;
511}
512
513void GBAStop(struct GBA* gba) {
514 size_t c;
515 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
516 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
517 if (callbacks->sleep) {
518 callbacks->sleep(callbacks->context);
519 }
520 }
521 gba->cpu->nextEvent = gba->cpu->cycles;
522}
523
524void GBADebug(struct GBA* gba, uint16_t flags) {
525 gba->debugFlags = flags;
526 if (GBADebugFlagsIsSend(gba->debugFlags)) {
527 int level = 1 << GBADebugFlagsGetLevel(gba->debugFlags);
528 level &= 0x1F;
529 char oolBuf[0x101];
530 strncpy(oolBuf, gba->debugString, sizeof(oolBuf) - 1);
531 memset(gba->debugString, 0, sizeof(gba->debugString));
532 oolBuf[0x100] = '\0';
533 mLog(_mLOG_CAT_GBA_DEBUG, level, "%s", oolBuf);
534 }
535 gba->debugFlags = GBADebugFlagsClearSend(gba->debugFlags);
536}
537
538bool GBAIsROM(struct VFile* vf) {
539#ifdef USE_ELF
540 struct ELF* elf = ELFOpen(vf);
541 if (elf) {
542 uint32_t entry = ELFEntry(elf);
543 bool isGBA = true;
544 isGBA = isGBA && ELFMachine(elf) == EM_ARM;
545 isGBA = isGBA && (entry == BASE_CART0 || entry == BASE_WORKING_RAM);
546 ELFClose(elf);
547 return isGBA;
548 }
549#endif
550 if (!vf) {
551 return false;
552 }
553
554 uint8_t signature[sizeof(GBA_ROM_MAGIC) + sizeof(GBA_ROM_MAGIC2)];
555 if (vf->seek(vf, GBA_ROM_MAGIC_OFFSET, SEEK_SET) < 0) {
556 return false;
557 }
558 if (vf->read(vf, &signature, sizeof(GBA_ROM_MAGIC)) != sizeof(GBA_ROM_MAGIC)) {
559 return false;
560 }
561 if (memcmp(signature, GBA_ROM_MAGIC, sizeof(GBA_ROM_MAGIC)) != 0) {
562 return false;
563 }
564
565 if (vf->seek(vf, GBA_ROM_MAGIC_OFFSET2, SEEK_SET) < 0) {
566 return false;
567 }
568 if (vf->read(vf, &signature, sizeof(GBA_ROM_MAGIC2)) != sizeof(GBA_ROM_MAGIC2)) {
569 return false;
570 }
571 if (memcmp(signature, GBA_ROM_MAGIC2, sizeof(GBA_ROM_MAGIC2)) != 0) {
572 // If the signature byte is missing then we must be using an unfixed ROM
573 uint32_t buffer[0x9C / sizeof(uint32_t)];
574 if (vf->seek(vf, 0x4, SEEK_SET) < 0) {
575 return false;
576 }
577 if (vf->read(vf, &buffer, sizeof(buffer)) != sizeof(buffer)) {
578 return false;
579 }
580 uint32_t bits = 0;
581 size_t i;
582 for (i = 0; i < sizeof(buffer) / sizeof(*buffer); ++i) {
583 bits |= buffer[i];
584 }
585 if (bits) {
586 return false;
587 }
588 }
589
590
591 if (GBAIsBIOS(vf)) {
592 return false;
593 }
594 return true;
595}
596
597bool GBAIsMB(struct VFile* vf) {
598 if (!GBAIsROM(vf)) {
599 return false;
600 }
601#ifdef USE_ELF
602 struct ELF* elf = ELFOpen(vf);
603 if (elf) {
604 bool isMB = ELFEntry(elf) == BASE_WORKING_RAM;
605 ELFClose(elf);
606 return isMB;
607 }
608#endif
609 if (vf->size(vf) > SIZE_WORKING_RAM) {
610 return false;
611 }
612 if (vf->seek(vf, GBA_MB_MAGIC_OFFSET, SEEK_SET) < 0) {
613 return false;
614 }
615 uint32_t signature;
616 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
617 return false;
618 }
619 uint32_t opcode;
620 LOAD_32(opcode, 0, &signature);
621 struct ARMInstructionInfo info;
622 ARMDecodeARM(opcode, &info);
623 if (info.branchType == ARM_BRANCH) {
624 if (info.op1.immediate <= 0) {
625 return false;
626 } else if (info.op1.immediate == 28) {
627 // Ancient toolchain that is known to throw MB detection for a loop
628 return false;
629 } else if (info.op1.immediate != 24) {
630 return true;
631 }
632 }
633
634 uint32_t pc = GBA_MB_MAGIC_OFFSET;
635 int i;
636 for (i = 0; i < 80; ++i) {
637 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
638 break;
639 }
640 pc += 4;
641 LOAD_32(opcode, 0, &signature);
642 ARMDecodeARM(opcode, &info);
643 if (info.mnemonic != ARM_MN_LDR) {
644 continue;
645 }
646 if ((info.operandFormat & ARM_OPERAND_MEMORY) && info.memory.baseReg == ARM_PC && info.memory.format & ARM_MEMORY_IMMEDIATE_OFFSET) {
647 uint32_t immediate = info.memory.offset.immediate;
648 if (info.memory.format & ARM_MEMORY_OFFSET_SUBTRACT) {
649 immediate = -immediate;
650 }
651 immediate += pc + 8;
652 if (vf->seek(vf, immediate, SEEK_SET) < 0) {
653 break;
654 }
655 if (vf->read(vf, &signature, sizeof(signature)) != sizeof(signature)) {
656 break;
657 }
658 LOAD_32(immediate, 0, &signature);
659 if (vf->seek(vf, pc, SEEK_SET) < 0) {
660 break;
661 }
662 if ((immediate & ~0x7FF) == BASE_WORKING_RAM) {
663 return true;
664 }
665 }
666 }
667 // Found a libgba-linked cart...these are a bit harder to detect.
668 return false;
669}
670
671bool GBAIsBIOS(struct VFile* vf) {
672 if (vf->seek(vf, 0, SEEK_SET) < 0) {
673 return false;
674 }
675 uint8_t interruptTable[7 * 4];
676 if (vf->read(vf, &interruptTable, sizeof(interruptTable)) != sizeof(interruptTable)) {
677 return false;
678 }
679 int i;
680 for (i = 0; i < 7; ++i) {
681 if (interruptTable[4 * i + 3] != 0xEA || interruptTable[4 * i + 2]) {
682 return false;
683 }
684 }
685 return true;
686}
687
688void GBAGetGameCode(const struct GBA* gba, char* out) {
689 memset(out, 0, 8);
690 if (!gba->memory.rom) {
691 return;
692 }
693
694 memcpy(out, "AGB-", 4);
695 memcpy(&out[4], &((struct GBACartridge*) gba->memory.rom)->id, 4);
696}
697
698void GBAGetGameTitle(const struct GBA* gba, char* out) {
699 if (gba->memory.rom) {
700 memcpy(out, &((struct GBACartridge*) gba->memory.rom)->title, 12);
701 return;
702 }
703 if (gba->isPristine && gba->memory.wram) {
704 memcpy(out, &((struct GBACartridge*) gba->memory.wram)->title, 12);
705 return;
706 }
707 strncpy(out, "(BIOS)", 12);
708}
709
710void GBAHitStub(struct ARMCore* cpu, uint32_t opcode) {
711 struct GBA* gba = (struct GBA*) cpu->master;
712 UNUSED(gba);
713#ifdef USE_DEBUGGERS
714 if (gba->debugger) {
715 struct mDebuggerEntryInfo info = {
716 .address = _ARMPCAddress(cpu),
717 .type.bp.opcode = opcode
718 };
719 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_ILLEGAL_OP, &info);
720 }
721#endif
722 // TODO: More sensible category?
723 mLOG(GBA, ERROR, "Stub opcode: %08x", opcode);
724}
725
726void GBAIllegal(struct ARMCore* cpu, uint32_t opcode) {
727 struct GBA* gba = (struct GBA*) cpu->master;
728 if (!gba->yankedRomSize) {
729 // TODO: More sensible category?
730 mLOG(GBA, WARN, "Illegal opcode: %08x", opcode);
731 }
732 if (cpu->executionMode == MODE_THUMB && (opcode & 0xFFC0) == 0xE800) {
733 mLOG(GBA, DEBUG, "Hit Wii U VC opcode: %08x", opcode);
734 return;
735 }
736#ifdef USE_DEBUGGERS
737 if (gba->debugger) {
738 struct mDebuggerEntryInfo info = {
739 .address = _ARMPCAddress(cpu),
740 .type.bp.opcode = opcode
741 };
742 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_ILLEGAL_OP, &info);
743 } else
744#endif
745 {
746 ARMRaiseUndefined(cpu);
747 }
748}
749
750void GBABreakpoint(struct ARMCore* cpu, int immediate) {
751 struct GBA* gba = (struct GBA*) cpu->master;
752 if (immediate >= CPU_COMPONENT_MAX) {
753 return;
754 }
755 switch (immediate) {
756#ifdef USE_DEBUGGERS
757 case CPU_COMPONENT_DEBUGGER:
758 if (gba->debugger) {
759 struct mDebuggerEntryInfo info = {
760 .address = _ARMPCAddress(cpu),
761 .type.bp.breakType = BREAKPOINT_SOFTWARE
762 };
763 mDebuggerEnter(gba->debugger->d.p, DEBUGGER_ENTER_BREAKPOINT, &info);
764 }
765 break;
766#endif
767 case CPU_COMPONENT_CHEAT_DEVICE:
768 if (gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE]) {
769 struct mCheatDevice* device = (struct mCheatDevice*) gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE];
770 struct GBACheatHook* hook = 0;
771 size_t i;
772 for (i = 0; i < mCheatSetsSize(&device->cheats); ++i) {
773 struct GBACheatSet* cheats = (struct GBACheatSet*) *mCheatSetsGetPointer(&device->cheats, i);
774 if (cheats->hook && cheats->hook->address == _ARMPCAddress(cpu)) {
775 mCheatRefresh(device, &cheats->d);
776 hook = cheats->hook;
777 }
778 }
779 if (hook) {
780 ARMRunFake(cpu, hook->patchedOpcode);
781 }
782 }
783 break;
784 default:
785 break;
786 }
787}
788
789void GBAFrameStarted(struct GBA* gba) {
790 GBATestKeypadIRQ(gba);
791
792 size_t c;
793 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
794 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
795 if (callbacks->videoFrameStarted) {
796 callbacks->videoFrameStarted(callbacks->context);
797 }
798 }
799}
800
801void GBAFrameEnded(struct GBA* gba) {
802 GBASavedataClean(&gba->memory.savedata, gba->video.frameCounter);
803
804 if (gba->rr) {
805 gba->rr->nextFrame(gba->rr);
806 }
807
808 if (gba->cpu->components && gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE]) {
809 struct mCheatDevice* device = (struct mCheatDevice*) gba->cpu->components[CPU_COMPONENT_CHEAT_DEVICE];
810 size_t i;
811 for (i = 0; i < mCheatSetsSize(&device->cheats); ++i) {
812 struct GBACheatSet* cheats = (struct GBACheatSet*) *mCheatSetsGetPointer(&device->cheats, i);
813 if (!cheats->hook) {
814 mCheatRefresh(device, &cheats->d);
815 }
816 }
817 }
818
819 if (gba->stream && gba->stream->postVideoFrame) {
820 const color_t* pixels;
821 size_t stride;
822 gba->video.renderer->getPixels(gba->video.renderer, &stride, (const void**) &pixels);
823 gba->stream->postVideoFrame(gba->stream, pixels, stride);
824 }
825
826 if (gba->memory.hw.devices & (HW_GB_PLAYER | HW_GB_PLAYER_DETECTION)) {
827 GBAHardwarePlayerUpdate(gba);
828 }
829
830 size_t c;
831 for (c = 0; c < mCoreCallbacksListSize(&gba->coreCallbacks); ++c) {
832 struct mCoreCallbacks* callbacks = mCoreCallbacksListGetPointer(&gba->coreCallbacks, c);
833 if (callbacks->videoFrameEnded) {
834 callbacks->videoFrameEnded(callbacks->context);
835 }
836 }
837}
838
839void GBATestKeypadIRQ(struct GBA* gba) {
840 uint16_t keycnt = gba->memory.io[REG_KEYCNT >> 1];
841 if (!(keycnt & 0x4000)) {
842 return;
843 }
844 int isAnd = keycnt & 0x8000;
845 if (!gba->keySource) {
846 // TODO?
847 return;
848 }
849
850 keycnt &= 0x3FF;
851 uint16_t keyInput = *gba->keySource & keycnt;
852
853 if (isAnd && keycnt == keyInput) {
854 GBARaiseIRQ(gba, IRQ_KEYPAD, 0);
855 } else if (!isAnd && keyInput) {
856 GBARaiseIRQ(gba, IRQ_KEYPAD, 0);
857 }
858}
859
860static void _triggerIRQ(struct mTiming* timing, void* user, uint32_t cyclesLate) {
861 UNUSED(timing);
862 UNUSED(cyclesLate);
863 struct GBA* gba = user;
864 gba->cpu->halted = 0;
865 if (!(gba->memory.io[REG_IE >> 1] & gba->memory.io[REG_IF >> 1])) {
866 return;
867 }
868
869 if (gba->memory.io[REG_IME >> 1] && !gba->cpu->cpsr.i) {
870 ARMRaiseIRQ(gba->cpu);
871 }
872}
873
874void GBASetBreakpoint(struct GBA* gba, struct mCPUComponent* component, uint32_t address, enum ExecutionMode mode, uint32_t* opcode) {
875 size_t immediate;
876 for (immediate = 0; immediate < gba->cpu->numComponents; ++immediate) {
877 if (gba->cpu->components[immediate] == component) {
878 break;
879 }
880 }
881 if (immediate == gba->cpu->numComponents) {
882 return;
883 }
884 if (mode == MODE_ARM) {
885 int32_t value;
886 int32_t old;
887 value = 0xE1200070;
888 value |= immediate & 0xF;
889 value |= (immediate & 0xFFF0) << 4;
890 GBAPatch32(gba->cpu, address, value, &old);
891 *opcode = old;
892 } else {
893 int16_t value;
894 int16_t old;
895 value = 0xBE00;
896 value |= immediate & 0xFF;
897 GBAPatch16(gba->cpu, address, value, &old);
898 *opcode = (uint16_t) old;
899 }
900}
901
902void GBAClearBreakpoint(struct GBA* gba, uint32_t address, enum ExecutionMode mode, uint32_t opcode) {
903 if (mode == MODE_ARM) {
904 GBAPatch32(gba->cpu, address, opcode, 0);
905 } else {
906 GBAPatch16(gba->cpu, address, opcode, 0);
907 }
908}
909
910#ifdef USE_DEBUGGERS
911static bool _setSoftwareBreakpoint(struct ARMDebugger* debugger, uint32_t address, enum ExecutionMode mode, uint32_t* opcode) {
912 GBASetBreakpoint((struct GBA*) debugger->cpu->master, &debugger->d.p->d, address, mode, opcode);
913 return true;
914}
915
916static bool _clearSoftwareBreakpoint(struct ARMDebugger* debugger, uint32_t address, enum ExecutionMode mode, uint32_t opcode) {
917 GBAClearBreakpoint((struct GBA*) debugger->cpu->master, address, mode, opcode);
918 return true;
919}
920#endif