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