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