1/* Copyright (c) 2013-2016 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#ifndef GBA_H
  7#define GBA_H
  8
  9#include "util/common.h"
 10
 11#include "arm/arm.h"
 12#include "core/log.h"
 13#include "core/timing.h"
 14
 15#include "gba/interface.h"
 16#include "gba/memory.h"
 17#include "gba/video.h"
 18#include "gba/audio.h"
 19#include "gba/sio.h"
 20#include "gba/timer.h"
 21
 22#define GBA_ARM7TDMI_FREQUENCY 0x1000000U
 23
 24enum GBAIRQ {
 25	IRQ_VBLANK = 0x0,
 26	IRQ_HBLANK = 0x1,
 27	IRQ_VCOUNTER = 0x2,
 28	IRQ_TIMER0 = 0x3,
 29	IRQ_TIMER1 = 0x4,
 30	IRQ_TIMER2 = 0x5,
 31	IRQ_TIMER3 = 0x6,
 32	IRQ_SIO = 0x7,
 33	IRQ_DMA0 = 0x8,
 34	IRQ_DMA1 = 0x9,
 35	IRQ_DMA2 = 0xA,
 36	IRQ_DMA3 = 0xB,
 37	IRQ_KEYPAD = 0xC,
 38	IRQ_GAMEPAK = 0xD
 39};
 40
 41enum GBAIdleLoopOptimization {
 42	IDLE_LOOP_IGNORE = -1,
 43	IDLE_LOOP_REMOVE = 0,
 44	IDLE_LOOP_DETECT
 45};
 46
 47enum {
 48	SP_BASE_SYSTEM = 0x03007F00,
 49	SP_BASE_IRQ = 0x03007FA0,
 50	SP_BASE_SUPERVISOR = 0x03007FE0
 51};
 52
 53struct GBA;
 54struct Patch;
 55struct VFile;
 56
 57mLOG_DECLARE_CATEGORY(GBA);
 58mLOG_DECLARE_CATEGORY(GBA_DEBUG);
 59
 60DECL_BITFIELD(GBADebugFlags, uint16_t);
 61DECL_BITS(GBADebugFlags, Level, 0, 3);
 62DECL_BIT(GBADebugFlags, Send, 8);
 63
 64struct GBA {
 65	struct mCPUComponent d;
 66
 67	struct ARMCore* cpu;
 68	struct GBAMemory memory;
 69	struct GBAVideo video;
 70	struct GBAAudio audio;
 71	struct GBASIO sio;
 72
 73	struct mCoreSync* sync;
 74	struct mTiming timing;
 75
 76	struct ARMDebugger* debugger;
 77
 78	uint32_t bus;
 79	int performingDMA;
 80
 81	struct GBATimer timers[4];
 82
 83	int springIRQ;
 84	uint32_t biosChecksum;
 85	int* keySource;
 86	struct mRotationSource* rotationSource;
 87	struct GBALuminanceSource* luminanceSource;
 88	struct mRTCSource* rtcSource;
 89	struct mRumble* rumble;
 90
 91	struct GBARRContext* rr;
 92	void* pristineRom;
 93	size_t pristineRomSize;
 94	size_t yankedRomSize;
 95	uint32_t romCrc32;
 96	struct VFile* romVf;
 97	struct VFile* biosVf;
 98
 99	struct mAVStream* stream;
100	struct mKeyCallback* keyCallback;
101	struct mStopCallback* stopCallback;
102	struct mCoreCallbacks* coreCallbacks;
103
104	enum GBAIdleLoopOptimization idleOptimization;
105	uint32_t idleLoop;
106	uint32_t lastJump;
107	bool haltPending;
108	bool cpuBlocked;
109	bool earlyExit;
110	int idleDetectionStep;
111	int idleDetectionFailures;
112	int32_t cachedRegisters[16];
113	bool taintedRegisters[16];
114
115	bool realisticTiming;
116	bool hardCrash;
117	bool allowOpposingDirections;
118
119	bool debug;
120	char debugString[0x100];
121	GBADebugFlags debugFlags;
122};
123
124struct GBACartridge {
125	uint32_t entry;
126	uint8_t logo[156];
127	char title[12];
128	uint32_t id;
129	uint16_t maker;
130	uint8_t type;
131	uint8_t unit;
132	uint8_t device;
133	uint8_t reserved[7];
134	uint8_t version;
135	uint8_t checksum;
136	// And ROM data...
137};
138
139void GBACreate(struct GBA* gba);
140void GBADestroy(struct GBA* gba);
141
142void GBAReset(struct ARMCore* cpu);
143void GBASkipBIOS(struct GBA* gba);
144
145void GBAWriteIE(struct GBA* gba, uint16_t value);
146void GBAWriteIME(struct GBA* gba, uint16_t value);
147void GBARaiseIRQ(struct GBA* gba, enum GBAIRQ irq);
148void GBATestIRQ(struct ARMCore* cpu);
149void GBAHalt(struct GBA* gba);
150void GBAStop(struct GBA* gba);
151void GBADebug(struct GBA* gba, uint16_t value);
152
153void GBAAttachDebugger(struct GBA* gba, struct mDebugger* debugger);
154void GBADetachDebugger(struct GBA* gba);
155
156void GBASetBreakpoint(struct GBA* gba, struct mCPUComponent* component, uint32_t address, enum ExecutionMode mode,
157                      uint32_t* opcode);
158void GBAClearBreakpoint(struct GBA* gba, uint32_t address, enum ExecutionMode mode, uint32_t opcode);
159
160bool GBALoadROM(struct GBA* gba, struct VFile* vf);
161bool GBALoadSave(struct GBA* gba, struct VFile* sav);
162void GBAYankROM(struct GBA* gba);
163void GBAUnloadROM(struct GBA* gba);
164void GBALoadBIOS(struct GBA* gba, struct VFile* vf);
165void GBAApplyPatch(struct GBA* gba, struct Patch* patch);
166
167bool GBALoadMB(struct GBA* gba, struct VFile* vf);
168
169bool GBAIsROM(struct VFile* vf);
170bool GBAIsMB(struct VFile* vf);
171bool GBAIsBIOS(struct VFile* vf);
172void GBAGetGameCode(const struct GBA* gba, char* out);
173void GBAGetGameTitle(const struct GBA* gba, char* out);
174
175void GBAFrameStarted(struct GBA* gba);
176void GBAFrameEnded(struct GBA* gba);
177
178#endif